Skip to content

Commit d9ac229

Browse files
committed
update docs
1 parent ef4d9e2 commit d9ac229

17 files changed

+586
-290
lines changed

Documentation/Disconnect-LMAccount.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Disconnect from a previously connected LM portal
1313
## SYNTAX
1414

1515
```
16-
Disconnect-LMAccount
16+
Disconnect-LMAccount [<CommonParameters>]
1717
```
1818

1919
## DESCRIPTION
@@ -29,6 +29,9 @@ Disconnect-LMAccount
2929

3030
## PARAMETERS
3131

32+
### CommonParameters
33+
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).
34+
3235
## INPUTS
3336

3437
### None. You cannot pipe objects to this command.

Documentation/Get-LMAccessGroup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Retrieves the access group with the specified name.
5555

5656
### EXAMPLE 3
5757
```
58-
Get-LMAccessGroup -Filter @{ Property = "Value" }
58+
Get-LMAccessGroup -Filter "tenantId -eq 'Value'"
5959
Retrieves access groups based on the specified filter criteria.
6060
```
6161

Documentation/Get-LMAccountStatus.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Retrieves the status of the LogicMonitor account.
1313
## SYNTAX
1414

1515
```
16-
Get-LMAccountStatus
16+
Get-LMAccountStatus [<CommonParameters>]
1717
```
1818

1919
## DESCRIPTION
@@ -31,6 +31,9 @@ This example demonstrates how to use the Get-LMAccountStatus function to retriev
3131

3232
## PARAMETERS
3333

34+
### CommonParameters
35+
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).
36+
3437
## INPUTS
3538

3639
## OUTPUTS

Documentation/Get-LMDeviceDatasourceInstance.md

Lines changed: 57 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -8,65 +8,73 @@ schema: 2.0.0
88
# Get-LMDeviceDatasourceInstance
99

1010
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
11+
Retrieves instances of a LogicMonitor device datasource.
1212

1313
## SYNTAX
1414

1515
### Name-dsName
1616
```
17-
Get-LMDeviceDatasourceInstance -DatasourceName <String> -DeviceName <String> [-Filter <Object>]
18-
[-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
17+
Get-LMDeviceDatasourceInstance -DatasourceName <String> -Name <String> [-Filter <Object>] [-BatchSize <Int32>]
18+
[-ProgressAction <ActionPreference>] [<CommonParameters>]
1919
```
2020

2121
### Id-dsName
2222
```
23-
Get-LMDeviceDatasourceInstance -DatasourceName <String> -DeviceId <Int32> [-Filter <Object>]
24-
[-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
23+
Get-LMDeviceDatasourceInstance -DatasourceName <String> -Id <Int32> [-Filter <Object>] [-BatchSize <Int32>]
24+
[-ProgressAction <ActionPreference>] [<CommonParameters>]
2525
```
2626

2727
### Name-dsId
2828
```
29-
Get-LMDeviceDatasourceInstance -DatasourceId <Int32> -DeviceName <String> [-Filter <Object>]
30-
[-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
29+
Get-LMDeviceDatasourceInstance -DatasourceId <Int32> -Name <String> [-Filter <Object>] [-BatchSize <Int32>]
30+
[-ProgressAction <ActionPreference>] [<CommonParameters>]
3131
```
3232

3333
### Id-dsId
3434
```
35-
Get-LMDeviceDatasourceInstance -DatasourceId <Int32> -DeviceId <Int32> [-Filter <Object>] [-BatchSize <Int32>]
35+
Get-LMDeviceDatasourceInstance -DatasourceId <Int32> -Id <Int32> [-Filter <Object>] [-BatchSize <Int32>]
3636
[-ProgressAction <ActionPreference>] [<CommonParameters>]
3737
```
3838

3939
## DESCRIPTION
40-
{{ Fill in the Description }}
40+
The Get-LMDeviceDatasourceInstance function retrieves instances of a LogicMonitor device datasource based on the specified parameters.
41+
It requires a valid API authentication and authorization.
4142

4243
## EXAMPLES
4344

44-
### Example 1
45-
```powershell
46-
PS C:\> {{ Add example code here }}
45+
### EXAMPLE 1
46+
```
47+
Get-LMDeviceDatasourceInstance -DatasourceName "CPU" -Name "Server01" -BatchSize 500
48+
Retrieves instances of the "CPU" datasource for the device named "Server01" with a batch size of 500.
4749
```
4850

49-
{{ Add example description here }}
51+
### EXAMPLE 2
52+
```
53+
Get-LMDeviceDatasourceInstance -DatasourceId 1234 -Id 5678
54+
Retrieves instances of the datasource with ID 1234 for the device with ID 5678.
55+
```
5056

5157
## PARAMETERS
5258

53-
### -BatchSize
54-
{{ Fill BatchSize Description }}
59+
### -DatasourceName
60+
Specifies the name of the datasource.
61+
This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets.
5562

5663
```yaml
57-
Type: Int32
58-
Parameter Sets: (All)
64+
Type: String
65+
Parameter Sets: Name-dsName, Id-dsName
5966
Aliases:
6067

61-
Required: False
68+
Required: True
6269
Position: Named
6370
Default value: None
6471
Accept pipeline input: False
6572
Accept wildcard characters: False
6673
```
6774
6875
### -DatasourceId
69-
{{ Fill DatasourceId Description }}
76+
Specifies the ID of the datasource.
77+
This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets.
7078
7179
```yaml
7280
Type: Int32
@@ -75,33 +83,37 @@ Aliases:
7583

7684
Required: True
7785
Position: Named
78-
Default value: None
86+
Default value: 0
7987
Accept pipeline input: False
8088
Accept wildcard characters: False
8189
```
8290
83-
### -DatasourceName
84-
{{ Fill DatasourceName Description }}
91+
### -Id
92+
Specifies the ID of the device.
93+
This parameter is mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets.
94+
It can also be specified using the 'DeviceId' alias.
8595
8696
```yaml
87-
Type: String
88-
Parameter Sets: Name-dsName, Id-dsName
89-
Aliases:
97+
Type: Int32
98+
Parameter Sets: Id-dsName, Id-dsId
99+
Aliases: DeviceId
90100

91101
Required: True
92102
Position: Named
93-
Default value: None
103+
Default value: 0
94104
Accept pipeline input: False
95105
Accept wildcard characters: False
96106
```
97107
98-
### -DeviceId
99-
{{ Fill DeviceId Description }}
108+
### -Name
109+
Specifies the name of the device.
110+
This parameter is mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets.
111+
It can also be specified using the 'DeviceName' alias.
100112
101113
```yaml
102-
Type: Int32
103-
Parameter Sets: Id-dsName, Id-dsId
104-
Aliases: Id
114+
Type: String
115+
Parameter Sets: Name-dsName, Name-dsId
116+
Aliases: DeviceName
105117

106118
Required: True
107119
Position: Named
@@ -110,32 +122,34 @@ Accept pipeline input: False
110122
Accept wildcard characters: False
111123
```
112124
113-
### -DeviceName
114-
{{ Fill DeviceName Description }}
125+
### -Filter
126+
Specifies additional filters to apply to the instances.
127+
This parameter accepts an object representing the filter criteria.
115128
116129
```yaml
117-
Type: String
118-
Parameter Sets: Name-dsName, Name-dsId
119-
Aliases: Name
130+
Type: Object
131+
Parameter Sets: (All)
132+
Aliases:
120133

121-
Required: True
134+
Required: False
122135
Position: Named
123136
Default value: None
124137
Accept pipeline input: False
125138
Accept wildcard characters: False
126139
```
127140
128-
### -Filter
129-
{{ Fill Filter Description }}
141+
### -BatchSize
142+
Specifies the number of instances to retrieve per batch.
143+
The default value is 1000.
130144
131145
```yaml
132-
Type: Object
146+
Type: Int32
133147
Parameter Sets: (All)
134148
Aliases:
135149

136150
Required: False
137151
Position: Named
138-
Default value: None
152+
Default value: 1000
139153
Accept pipeline input: False
140154
Accept wildcard characters: False
141155
```
@@ -160,10 +174,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
160174
161175
## INPUTS
162176
163-
### None
164177
## OUTPUTS
165178
166-
### System.Object
167179
## NOTES
180+
This function requires a valid API authentication and authorization.
181+
Use Connect-LMAccount to log in before running any commands.
168182
169183
## RELATED LINKS

Documentation/Get-LMDeviceDatasourceInstanceAlertRecipients.md

Lines changed: 42 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Get-LMDeviceDatasourceInstanceAlertRecipients
99

1010
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
11+
Retrieves the alert recipients for a specific data point in a LogicMonitor device datasource instance.
1212

1313
## SYNTAX
1414

@@ -37,25 +37,34 @@ Get-LMDeviceDatasourceInstanceAlertRecipients -DatasourceId <Int32> -Id <Int32>
3737
```
3838

3939
## DESCRIPTION
40-
{{ Fill in the Description }}
40+
The Get-LMDeviceDatasourceInstanceAlertRecipients function retrieves the alert recipients for a specific data point in a LogicMonitor device datasource instance.
41+
It requires valid API credentials and a logged-in session.
4142

4243
## EXAMPLES
4344

44-
### Example 1
45-
```powershell
46-
PS C:\> {{ Add example code here }}
45+
### EXAMPLE 1
46+
```
47+
Get-LMDeviceDatasourceInstanceAlertRecipients -DatasourceName "Ping-" -Name "Server01" -InstanceName "Instance01" -DataPointName "PingLossPercent"
48+
```
49+
50+
Retrieves the alert recipients for the "PingLossPercent" data point in the "CPU" datasource instance of the "Server01" device.
51+
52+
### EXAMPLE 2
53+
```
54+
Get-LMDeviceDatasourceInstanceAlertRecipients -DatasourceId 123 -Id 456 -InstanceName "Instance01" -DataPointName "PingLossPercent"
4755
```
4856

49-
{{ Add example description here }}
57+
Retrieves the alert recipients for the "PingLossPercent" data point in the datasource instance with ID 123 of the device with ID 456.
5058

5159
## PARAMETERS
5260

53-
### -DataPointName
54-
{{ Fill DataPointName Description }}
61+
### -DatasourceName
62+
Specifies the name of the datasource.
63+
This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets.
5564

5665
```yaml
5766
Type: String
58-
Parameter Sets: (All)
67+
Parameter Sets: Name-dsName, Id-dsName
5968
Aliases:
6069

6170
Required: True
@@ -66,7 +75,8 @@ Accept wildcard characters: False
6675
```
6776
6877
### -DatasourceId
69-
{{ Fill DatasourceId Description }}
78+
Specifies the ID of the datasource.
79+
This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets.
7080
7181
```yaml
7282
Type: Int32
@@ -75,33 +85,37 @@ Aliases:
7585

7686
Required: True
7787
Position: Named
78-
Default value: None
88+
Default value: 0
7989
Accept pipeline input: False
8090
Accept wildcard characters: False
8191
```
8292
83-
### -DatasourceName
84-
{{ Fill DatasourceName Description }}
93+
### -Id
94+
Specifies the ID of the device.
95+
This parameter is mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets.
96+
It can also be specified using the 'DeviceId' alias.
8597
8698
```yaml
87-
Type: String
88-
Parameter Sets: Name-dsName, Id-dsName
89-
Aliases:
99+
Type: Int32
100+
Parameter Sets: Id-dsName, Id-dsId
101+
Aliases: DeviceId
90102

91103
Required: True
92104
Position: Named
93-
Default value: None
105+
Default value: 0
94106
Accept pipeline input: False
95107
Accept wildcard characters: False
96108
```
97109
98-
### -Id
99-
{{ Fill Id Description }}
110+
### -Name
111+
Specifies the name of the device.
112+
This parameter is mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets.
113+
It can also be specified using the 'DeviceName' alias.
100114
101115
```yaml
102-
Type: Int32
103-
Parameter Sets: Id-dsName, Id-dsId
104-
Aliases:
116+
Type: String
117+
Parameter Sets: Name-dsName, Name-dsId
118+
Aliases: DeviceName
105119

106120
Required: True
107121
Position: Named
@@ -111,7 +125,8 @@ Accept wildcard characters: False
111125
```
112126
113127
### -InstanceName
114-
{{ Fill InstanceName Description }}
128+
Specifies the name of the datasource instance.
129+
This parameter is mandatory.
115130
116131
```yaml
117132
Type: String
@@ -125,12 +140,13 @@ Accept pipeline input: False
125140
Accept wildcard characters: False
126141
```
127142
128-
### -Name
129-
{{ Fill Name Description }}
143+
### -DataPointName
144+
Specifies the name of the data point.
145+
This parameter is mandatory.
130146
131147
```yaml
132148
Type: String
133-
Parameter Sets: Name-dsName, Name-dsId
149+
Parameter Sets: (All)
134150
Aliases:
135151

136152
Required: True
@@ -160,10 +176,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
160176
161177
## INPUTS
162178
163-
### None
164179
## OUTPUTS
165180
166-
### System.Object
167181
## NOTES
168182
169183
## RELATED LINKS

0 commit comments

Comments
 (0)