Skip to content

Commit 5ac876e

Browse files
committed
update docs 7.6.1
1 parent daf9cf9 commit 5ac876e

File tree

6 files changed

+258
-21
lines changed

6 files changed

+258
-21
lines changed
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
external help file: Logic.Monitor-help.xml
3+
Module Name: Logic.Monitor
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Get-LMAWSExternalId
9+
10+
## SYNOPSIS
11+
Retrieves the AWS External ID associated with the LogicMonitor account.
12+
13+
## SYNTAX
14+
15+
```
16+
Get-LMAWSExternalId [-ProgressAction <ActionPreference>] [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
The Get-LMAWSExternalId function retrieves the AWS External ID that is associated with the current LogicMonitor account.
21+
This ID is used for AWS integration purposes and helps identify the AWS account linked to your LogicMonitor instance.
22+
23+
## EXAMPLES
24+
25+
### EXAMPLE 1
26+
```
27+
#Retrieve the AWS External ID
28+
Get-LMAWSExternalId
29+
```
30+
31+
## PARAMETERS
32+
33+
### -ProgressAction
34+
{{ Fill ProgressAction Description }}
35+
36+
```yaml
37+
Type: ActionPreference
38+
Parameter Sets: (All)
39+
Aliases: proga
40+
41+
Required: False
42+
Position: Named
43+
Default value: None
44+
Accept pipeline input: False
45+
Accept wildcard characters: False
46+
```
47+
48+
### CommonParameters
49+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
50+
51+
## INPUTS
52+
53+
### None. You cannot pipe objects to this command.
54+
## OUTPUTS
55+
56+
### Returns a string containing the AWS External ID.
57+
## NOTES
58+
You must run Connect-LMAccount before running this command.
59+
60+
## RELATED LINKS

Documentation/New-LMDeviceGroup.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Creates a new LogicMonitor device group.
1414

1515
### GroupId
1616
```
17-
New-LMDeviceGroup -Name <String> [-Description <String>] [-Properties <Hashtable>]
17+
New-LMDeviceGroup -Name <String> [-Description <String>] [-Properties <Hashtable>] [-Extra <Object>]
1818
[-DefaultCollectorId <Int32>] [-DefaultAutoBalancedCollectorGroupId <Int32>]
1919
[-DefaultCollectorGroupId <Int32>] [-DisableAlerting <Boolean>] [-EnableNetFlow <Boolean>]
2020
-ParentGroupId <Int32> [-AppliesTo <String>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
@@ -23,7 +23,7 @@ New-LMDeviceGroup -Name <String> [-Description <String>] [-Properties <Hashtable
2323

2424
### GroupName
2525
```
26-
New-LMDeviceGroup -Name <String> [-Description <String>] [-Properties <Hashtable>]
26+
New-LMDeviceGroup -Name <String> [-Description <String>] [-Properties <Hashtable>] [-Extra <Object>]
2727
[-DefaultCollectorId <Int32>] [-DefaultAutoBalancedCollectorGroupId <Int32>]
2828
[-DefaultCollectorGroupId <Int32>] [-DisableAlerting <Boolean>] [-EnableNetFlow <Boolean>]
2929
-ParentGroupName <String> [-AppliesTo <String>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
@@ -98,6 +98,21 @@ Accept pipeline input: False
9898
Accept wildcard characters: False
9999
```
100100
101+
### -Extra
102+
Specifies a object of extra properties for the device group. Used for LM Cloud resource groups
103+
104+
```yaml
105+
Type: Object
106+
Parameter Sets: (All)
107+
Aliases:
108+
109+
Required: False
110+
Position: Named
111+
Default value: None
112+
Accept pipeline input: False
113+
Accept wildcard characters: False
114+
```
115+
101116
### -DefaultCollectorId
102117
{{ Fill DefaultCollectorId Description }}
103118
Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
---
2+
external help file: Logic.Monitor-help.xml
3+
Module Name: Logic.Monitor
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Send-LMWebhookMessage
9+
10+
## SYNOPSIS
11+
Sends webhook events to LogicMonitor.
12+
13+
## SYNTAX
14+
15+
```
16+
Send-LMWebhookMessage [-SourceName] <String> [-Messages] <Object[]> [[-Properties] <Hashtable>] [-PassThru]
17+
[-ProgressAction <ActionPreference>] [<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
The Send-LMWebhookMessage function submits webhook messages to LogicMonitor for ingestion via the Webhook LogSource endpoint.
22+
Provide an array of events to transmit; each entry is converted into a JSON payload.
23+
Optional common properties can be merged into every event to support downstream parsing in LogicMonitor.
24+
25+
## EXAMPLES
26+
27+
### EXAMPLE 1
28+
```
29+
Send-LMWebhookMessage -SourceName "Meraki_CustomerA" -Events $Messages -Properties @{ accountId = '12345' }
30+
Sends each event in `$Messages` to the Meraki webhook LogSource, appending the `accountId` property to every payload.
31+
```
32+
33+
## PARAMETERS
34+
35+
### -SourceName
36+
Specifies the LogicMonitor LogSource identifier used in the ingest URL.
37+
This typically matches the sourceName configured in LogicMonitor.
38+
39+
```yaml
40+
Type: String
41+
Parameter Sets: (All)
42+
Aliases:
43+
44+
Required: True
45+
Position: 1
46+
Default value: None
47+
Accept pipeline input: False
48+
Accept wildcard characters: False
49+
```
50+
51+
### -Messages
52+
{{ Fill Messages Description }}
53+
54+
```yaml
55+
Type: Object[]
56+
Parameter Sets: (All)
57+
Aliases:
58+
59+
Required: True
60+
Position: 2
61+
Default value: None
62+
Accept pipeline input: False
63+
Accept wildcard characters: False
64+
```
65+
66+
### -Properties
67+
Specifies additional key/value pairs that are merged into every event payload before sending.
68+
69+
```yaml
70+
Type: Hashtable
71+
Parameter Sets: (All)
72+
Aliases:
73+
74+
Required: False
75+
Position: 3
76+
Default value: None
77+
Accept pipeline input: False
78+
Accept wildcard characters: False
79+
```
80+
81+
### -PassThru
82+
{{ Fill PassThru Description }}
83+
84+
```yaml
85+
Type: SwitchParameter
86+
Parameter Sets: (All)
87+
Aliases:
88+
89+
Required: False
90+
Position: Named
91+
Default value: False
92+
Accept pipeline input: False
93+
Accept wildcard characters: False
94+
```
95+
96+
### -ProgressAction
97+
{{ Fill ProgressAction Description }}
98+
99+
```yaml
100+
Type: ActionPreference
101+
Parameter Sets: (All)
102+
Aliases: proga
103+
104+
Required: False
105+
Position: Named
106+
Default value: None
107+
Accept pipeline input: False
108+
Accept wildcard characters: False
109+
```
110+
111+
### CommonParameters
112+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
113+
114+
## INPUTS
115+
116+
## OUTPUTS
117+
118+
### Outputs a confirmation message for each accepted webhook event, or an error message if the request fails. When -PassThru is specified, returns PSCustomObject entries containing status, payload, and optional error details for each attempted message.
119+
## NOTES
120+
121+
## RELATED LINKS

Documentation/Set-LMDeviceGroup.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Updates a LogicMonitor device group configuration.
1515
### Id-ParentGroupId (Default)
1616
```
1717
Set-LMDeviceGroup -Id <String> [-NewName <String>] [-Description <String>] [-Properties <Hashtable>]
18-
[-DefaultCollectorId <Int32>] [-DefaultAutoBalancedCollectorGroupId <Int32>]
18+
[-Extra <Object>] [-DefaultCollectorId <Int32>] [-DefaultAutoBalancedCollectorGroupId <Int32>]
1919
[-DefaultCollectorGroupId <Int32>] [-PropertiesMethod <String>] [-DisableAlerting <Boolean>]
2020
[-EnableNetFlow <Boolean>] [-AppliesTo <String>] [-ParentGroupId <Int32>] [-ProgressAction <ActionPreference>]
2121
[-WhatIf] [-Confirm] [<CommonParameters>]
@@ -24,7 +24,7 @@ Set-LMDeviceGroup -Id <String> [-NewName <String>] [-Description <String>] [-Pro
2424
### Id-ParentGroupName
2525
```
2626
Set-LMDeviceGroup -Id <String> [-NewName <String>] [-Description <String>] [-Properties <Hashtable>]
27-
[-DefaultCollectorId <Int32>] [-DefaultAutoBalancedCollectorGroupId <Int32>]
27+
[-Extra <Object>] [-DefaultCollectorId <Int32>] [-DefaultAutoBalancedCollectorGroupId <Int32>]
2828
[-DefaultCollectorGroupId <Int32>] [-PropertiesMethod <String>] [-DisableAlerting <Boolean>]
2929
[-EnableNetFlow <Boolean>] [-AppliesTo <String>] [-ParentGroupName <String>]
3030
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
@@ -33,7 +33,7 @@ Set-LMDeviceGroup -Id <String> [-NewName <String>] [-Description <String>] [-Pro
3333
### Name-ParentGroupName
3434
```
3535
Set-LMDeviceGroup -Name <String> [-NewName <String>] [-Description <String>] [-Properties <Hashtable>]
36-
[-DefaultCollectorId <Int32>] [-DefaultAutoBalancedCollectorGroupId <Int32>]
36+
[-Extra <Object>] [-DefaultCollectorId <Int32>] [-DefaultAutoBalancedCollectorGroupId <Int32>]
3737
[-DefaultCollectorGroupId <Int32>] [-PropertiesMethod <String>] [-DisableAlerting <Boolean>]
3838
[-EnableNetFlow <Boolean>] [-AppliesTo <String>] [-ParentGroupName <String>]
3939
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
@@ -42,7 +42,7 @@ Set-LMDeviceGroup -Name <String> [-NewName <String>] [-Description <String>] [-P
4242
### Name-ParentGroupId
4343
```
4444
Set-LMDeviceGroup -Name <String> [-NewName <String>] [-Description <String>] [-Properties <Hashtable>]
45-
[-DefaultCollectorId <Int32>] [-DefaultAutoBalancedCollectorGroupId <Int32>]
45+
[-Extra <Object>] [-DefaultCollectorId <Int32>] [-DefaultAutoBalancedCollectorGroupId <Int32>]
4646
[-DefaultCollectorGroupId <Int32>] [-PropertiesMethod <String>] [-DisableAlerting <Boolean>]
4747
[-EnableNetFlow <Boolean>] [-AppliesTo <String>] [-ParentGroupId <Int32>] [-ProgressAction <ActionPreference>]
4848
[-WhatIf] [-Confirm] [<CommonParameters>]
@@ -148,6 +148,21 @@ Accept pipeline input: False
148148
Accept wildcard characters: False
149149
```
150150
151+
### -Extra
152+
Specifies a object of extra properties for the device group. Used for LM Cloud resource groups
153+
154+
```yaml
155+
Type: Object
156+
Parameter Sets: (All)
157+
Aliases:
158+
159+
Required: False
160+
Position: Named
161+
Default value: None
162+
Accept pipeline input: False
163+
Accept wildcard characters: False
164+
```
165+
151166
### -DefaultCollectorId
152167
{{ Fill DefaultCollectorId Description }}
153168

README.md

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -73,24 +73,15 @@ Connect-LMAccount -UseCachedCredential
7373

7474
# Change List
7575

76-
## 7.6
76+
## 7.6.1
7777

7878
### New Cmdlets
79-
- **New-LMUptimeDevice**: Create LogicMonitor Uptime monitors (web or ping) using the v3 device endpoint.
80-
- **New-LMUptimeWebStep**: Helper cmdlet to create a properly formated step for use with *New-LMUptimedevice*
81-
- **Get-LMUptimeDevice**: Retrieve existing Uptime devices with support for filtering by type or internal/external status.
82-
- **Set-LMUptimeDevice**: Update Uptime device configuration, including alert thresholds, locations, and scripted steps.
83-
- **Remove-LMUptimeDevice**: Delete Uptime devices individually.
79+
- **Send-LMWebhookMessage**: Send a webhook message to LM Logs.
80+
- **Get-LMAWSExternalId**: Generate an ExternalID for AWS onboarding.
8481

85-
### New Helper Cmdlets
86-
- **ConvertTo-LMUptimeDevice** Migration cmdlet relies will take a provided set of WebChecks/PingChecks and convert them to LMUptime Resources.
87-
88-
### Bug Fixes/Changes
89-
- Added reusable helper functions to normalise global alert condition inputs and location validation for Uptime cmdlets.
90-
91-
### Notes
92-
- API calls for LM Uptime will only work on LM portals running v228 or later.
93-
- LMUptime resources with show under normal **\*-LMDevice** cmdlets but modification to them should be handled by the new **\*-LMUptimeDevice** cmdlets.
82+
### Updated Cmdlets
83+
- **Set-LMDeviceGroup**: Added *-Extra* field which takes a PSCustomObject for specifying extra cloud settings for LM Cloud resource groups.
84+
- **New-LMDeviceGroup**: Added *-Extra* field which takes a PSCustomObject for specifying extra cloud settings for LM Cloud resource groups.
9485

9586
### Examples
9687
```powershell

RELEASENOTES.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,39 @@
11
# Previous module release notes
2+
3+
## 7.6
4+
5+
### New Cmdlets
6+
- **New-LMUptimeDevice**: Create LogicMonitor Uptime monitors (web or ping) using the v3 device endpoint.
7+
- **New-LMUptimeWebStep**: Helper cmdlet to create a properly formated step for use with *New-LMUptimedevice*
8+
- **Get-LMUptimeDevice**: Retrieve existing Uptime devices with support for filtering by type or internal/external status.
9+
- **Set-LMUptimeDevice**: Update Uptime device configuration, including alert thresholds, locations, and scripted steps.
10+
- **Remove-LMUptimeDevice**: Delete Uptime devices individually.
11+
12+
### New Helper Cmdlets
13+
- **ConvertTo-LMUptimeDevice** Migration cmdlet relies will take a provided set of WebChecks/PingChecks and convert them to LMUptime Resources.
14+
15+
### Bug Fixes/Changes
16+
- Added reusable helper functions to normalise global alert condition inputs and location validation for Uptime cmdlets.
17+
18+
### Notes
19+
- API calls for LM Uptime will only work on LM portals running v228 or later.
20+
- LMUptime resources with show under normal **\*-LMDevice** cmdlets but modification to them should be handled by the new **\*-LMUptimeDevice** cmdlets.
21+
22+
### Examples
23+
```powershell
24+
# Create a new external web uptime check
25+
New-LMUptimeDevice -Name "shop.example.com" -HostGroupIds '123' -Domain 'shop.example.com' -TestLocationAll
26+
27+
# Update an existing uptime device by name
28+
Set-LMUptimeDevice -Name "shop.example.com" -Description "Updated uptime monitor" -GlobalSmAlertCond half
29+
30+
# Remove an uptime device
31+
Remove-LMUptimeDevice -Name "shop.example.com"
32+
33+
# Migrate legacy websites to uptime and disable their alerting
34+
Get-LMWebsite -Type Webcheck | ConvertTo-LMUptimeDevice -TargetHostGroupIds '123' -DisableSourceAlerting
35+
```
36+
237
## 7.5
338

439
### New Cmdlets

0 commit comments

Comments
 (0)