Skip to content

Commit 0d54c33

Browse files
Merge pull request #31 from logicmonitor/v7-doc-refresh
V7 doc refresh
2 parents f2c4d1b + 498c945 commit 0d54c33

File tree

434 files changed

+24042
-17419
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

434 files changed

+24042
-17419
lines changed

Build.ps1

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ If (!(Get-Module Microsoft.PowerShell.SecretManagement -ListAvailable)) {
2828
If (!(Get-Module Microsoft.PowerShell.SecretStore -ListAvailable)) {
2929
Install-Module Microsoft.PowerShell.SecretStore -Force -Confirm:$false
3030
}
31+
If (!(Get-Module PwshSpectreConsole -ListAvailable)) {
32+
Install-Module PwshSpectreConsole -Force -Confirm:$false
33+
}
3134

3235
$manifestContent = (Get-Content -Path $manifestPath -Raw) -replace '<ModuleVersion>', $buildVersion
3336

Documentation/Build-LMFilter.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
external help file: Logic.Monitor-help.xml
3+
Module Name: Dev.Logic.Monitor
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Build-LMFilter
9+
10+
## SYNOPSIS
11+
Builds a filter expression for Logic Monitor API queries.
12+
13+
## SYNTAX
14+
15+
```
16+
Build-LMFilter [-PassThru] [-ProgressAction <ActionPreference>] [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
The Build-LMFilter function creates a filter expression by interactively prompting for conditions and operators.
21+
It supports basic filtering for single fields and advanced filtering for property-based queries.
22+
Multiple conditions can be combined using AND/OR operators.
23+
24+
## EXAMPLES
25+
26+
### EXAMPLE 1
27+
```
28+
#Build a basic filter expression
29+
Build-LMFilter
30+
This example launches the interactive filter builder wizard.
31+
```
32+
33+
### EXAMPLE 2
34+
```
35+
#Build a filter and return the expression
36+
Build-LMFilter -PassThru
37+
This example builds a filter and returns the expression as a string.
38+
```
39+
40+
## PARAMETERS
41+
42+
### -PassThru
43+
When specified, returns the filter expression as a string instead of displaying it in a panel.
44+
45+
```yaml
46+
Type: SwitchParameter
47+
Parameter Sets: (All)
48+
Aliases:
49+
50+
Required: False
51+
Position: Named
52+
Default value: False
53+
Accept pipeline input: False
54+
Accept wildcard characters: False
55+
```
56+
57+
### -ProgressAction
58+
{{ Fill ProgressAction Description }}
59+
60+
```yaml
61+
Type: ActionPreference
62+
Parameter Sets: (All)
63+
Aliases: proga
64+
65+
Required: False
66+
Position: Named
67+
Default value: None
68+
Accept pipeline input: False
69+
Accept wildcard characters: False
70+
```
71+
72+
### CommonParameters
73+
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).
74+
75+
## INPUTS
76+
77+
### None. You cannot pipe objects to this command.
78+
## OUTPUTS
79+
80+
### [String] Returns a PowerShell filter expression when using -PassThru.
81+
## NOTES
82+
The filter expression is saved to the global $LMFilter variable.
83+
84+
## RELATED LINKS

Documentation/Connect-LMAccount.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
external help file: Logic.Monitor-help.xml
3-
Module Name: Logic.Monitor
3+
Module Name: Dev.Logic.Monitor
44
online version:
55
schema: 2.0.0
66
---
@@ -47,17 +47,20 @@ Used in conjunction with Disconnect-LMAccount to close a session previously conn
4747

4848
### EXAMPLE 1
4949
```
50+
#Connecting to an Account using an Access ID and Access Key
5051
Connect-LMAccount -AccessId xxxxxx -AccessKey xxxxxx -AccountName subdomain
5152
```
5253

5354
### EXAMPLE 2
5455
```
56+
#Connecting to an Account using a Bearer Token
5557
Connect-LMAccount -BearerToken xxxxxx -AccountName subdomain
5658
```
5759

5860
### EXAMPLE 3
5961
```
60-
Connect-LMAccount -UseCachedCredential
62+
#Connecting to an Account using a Cached Credential
63+
Connect-LMAccount -UseCachedCredential -CachedAccountName "CachedAccountName"
6164
```
6265

6366
## PARAMETERS
@@ -255,12 +258,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
255258
### None. You cannot pipe objects to this command.
256259
## OUTPUTS
257260
261+
### None. This command does not return any output.
258262
## NOTES
259263
You must run this command before you will be able to execute other commands included with the Logic.Monitor module.
260264
261265
## RELATED LINKS
262-
263-
[Module repo: https://github.com/logicmonitor/lm-powershell-module]()
264-
265-
[PSGallery: https://www.powershellgallery.com/packages/Logic.Monitor]()
266-

Documentation/Copy-LMDashboard.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
external help file: Logic.Monitor-help.xml
3-
Module Name: Logic.Monitor
3+
Module Name: Dev.Logic.Monitor
44
online version:
55
schema: 2.0.0
66
---

Documentation/Copy-LMDevice.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
external help file: Logic.Monitor-help.xml
3-
Module Name: Logic.Monitor
3+
Module Name: Dev.Logic.Monitor
44
online version:
55
schema: 2.0.0
66
---
77

88
# Copy-LMDevice
99

1010
## SYNOPSIS
11-
Copies a LogicMonitor device.
11+
Creates a copy of a LogicMonitor device.
1212

1313
## SYNTAX
1414

@@ -18,21 +18,28 @@ Copy-LMDevice [-Name] <String> [[-DisplayName] <String>] [[-Description] <String
1818
```
1919

2020
## DESCRIPTION
21-
The Copy-LMDevice function is used to create a copy of a LogicMonitor device.
22-
It takes the name, display name, description, and device object as parameters and creates a new device with the specified properties.
21+
The Copy-LMDevice function creates a new device based on an existing device's configuration.
22+
It allows you to specify a new name, display name, and description while maintaining other settings from the source device.
2323

2424
## EXAMPLES
2525

2626
### EXAMPLE 1
2727
```
28+
#Copy a device with basic settings
2829
Copy-LMDevice -Name "NewDevice" -DeviceObject $deviceObject
29-
Creates a copy of the device specified by the $deviceObject variable with the name "NewDevice".
30+
```
31+
32+
### EXAMPLE 2
33+
```
34+
#Copy a device with custom display name and description
35+
Copy-LMDevice -Name "NewDevice" -DisplayName "New Display Name" -Description "New device description" -DeviceObject $deviceObject
3036
```
3137

3238
## PARAMETERS
3339

3440
### -Name
35-
The name of the new device.
41+
The name for the new device.
42+
This parameter is mandatory.
3643

3744
```yaml
3845
Type: String
@@ -47,8 +54,8 @@ Accept wildcard characters: False
4754
```
4855
4956
### -DisplayName
50-
The display name of the new device.
51-
If not provided, the name parameter will be used as the display name.
57+
The display name for the new device.
58+
If not specified, defaults to the Name parameter value.
5259
5360
```yaml
5461
Type: String
@@ -63,7 +70,7 @@ Accept wildcard characters: False
6370
```
6471
6572
### -Description
66-
The description of the new device.
73+
An optional description for the new device.
6774
6875
```yaml
6976
Type: String
@@ -78,7 +85,8 @@ Accept wildcard characters: False
7885
```
7986
8087
### -DeviceObject
81-
The device object of the reference device that will be copied.
88+
The source device object to copy settings from.
89+
This parameter is mandatory.
8290
8391
```yaml
8492
Type: Object
@@ -112,9 +120,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
112120
113121
## INPUTS
114122
123+
### None. You cannot pipe objects to this command.
115124
## OUTPUTS
116125
126+
### Returns the newly created device object.
117127
## NOTES
118-
Any custom properties from the reference device that are masked will need to be updated on the cloned resource, as those values are not available to the LogicMonitor API.
128+
Masked custom properties from the source device will need to be manually updated on the new device as they are not available via the API.
119129
120130
## RELATED LINKS

Documentation/Copy-LMReport.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
external help file: Logic.Monitor-help.xml
3-
Module Name: Logic.Monitor
3+
Module Name: Dev.Logic.Monitor
44
online version:
55
schema: 2.0.0
66
---
77

88
# Copy-LMReport
99

1010
## SYNOPSIS
11-
Copies a LogicMonitor report.
11+
Creates a copy of a LogicMonitor report.
1212

1313
## SYNTAX
1414

@@ -18,25 +18,28 @@ Copy-LMReport [-Name] <String> [[-Description] <String>] [[-ParentGroupId] <Stri
1818
```
1919

2020
## DESCRIPTION
21-
The Copy-LMReport function is used to copy a LogicMonitor report.
22-
It takes the following parameters:
23-
- Name: The name of the report.
24-
- Description: The description of the report.
25-
- ParentGroupId: The ID of the parent group.
26-
- ReportObject: The report object to be copied.
21+
The Copy-LMReport function creates a new report based on an existing report's configuration.
22+
It allows you to specify a new name, description, and parent group while maintaining other settings from the source report.
2723

2824
## EXAMPLES
2925

3026
### EXAMPLE 1
3127
```
32-
Copy-LMReport -Name "Report1" -Description "This is a sample report" -ParentGroupId "12345" -ReportObject $reportObject
33-
This example copies the report specified by the ReportObject parameter and sets the name, description, and parent group ID.
28+
#Copy a report with basic settings
29+
Copy-LMReport -Name "New Report" -ReportObject $reportObject
30+
```
31+
32+
### EXAMPLE 2
33+
```
34+
#Copy a report with all optional parameters
35+
Copy-LMReport -Name "New Report" -Description "New report description" -ParentGroupId 12345 -ReportObject $reportObject
3436
```
3537

3638
## PARAMETERS
3739

3840
### -Name
39-
The name of the report.
41+
The name for the new report.
42+
This parameter is mandatory.
4043

4144
```yaml
4245
Type: String
@@ -51,7 +54,7 @@ Accept wildcard characters: False
5154
```
5255
5356
### -Description
54-
The description of the report.
57+
An optional description for the new report.
5558
5659
```yaml
5760
Type: String
@@ -66,7 +69,7 @@ Accept wildcard characters: False
6669
```
6770
6871
### -ParentGroupId
69-
The ID of the parent group.
72+
The ID of the parent group for the new report.
7073
7174
```yaml
7275
Type: String
@@ -81,9 +84,8 @@ Accept wildcard characters: False
8184
```
8285
8386
### -ReportObject
84-
The report object to be copied.
85-
This can be retrieved using Get-LMReport.
86-
Any changes to the report object will be reflected in the new report.
87+
The source report object to copy settings from.
88+
This parameter is mandatory.
8789
8890
```yaml
8991
Type: Object
@@ -117,10 +119,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
117119
118120
## INPUTS
119121
122+
### None. You cannot pipe objects to this command.
120123
## OUTPUTS
121124
125+
### Returns the newly created report object.
122126
## NOTES
123-
Please ensure you are logged in before running any commands.
124-
Use Connect-LMAccount to login and try again.
127+
You must run Connect-LMAccount before running this command.
125128
126129
## RELATED LINKS
Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,42 @@
11
---
22
external help file: Logic.Monitor-help.xml
3-
Module Name: Logic.Monitor
3+
Module Name: Dev.Logic.Monitor
44
online version:
55
schema: 2.0.0
66
---
77

88
# Disconnect-LMAccount
99

1010
## SYNOPSIS
11-
Disconnect from a previously connected LM portal
11+
Disconnects from a previously connected LM portal.
1212

1313
## SYNTAX
1414

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

1919
## DESCRIPTION
20-
Clears stored API credentials for a previously connected LM portal.
21-
Useful for switching between LM portals or clearing credentials after a script runs
20+
The Disconnect-LMAccount function clears stored API credentials for a previously connected LM portal.
21+
It's useful for switching between LM portals or clearing credentials after a script runs.
2222

2323
## EXAMPLES
2424

2525
### EXAMPLE 1
2626
```
27+
#Disconnect from the current LM portal
2728
Disconnect-LMAccount
2829
```
2930

3031
## PARAMETERS
3132

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-
3533
## INPUTS
3634

3735
### None. You cannot pipe objects to this command.
3836
## OUTPUTS
3937

38+
### None. This command does not generate any output.
4039
## NOTES
41-
Once disconnect you will need to reconnect to a portal before you will be allowed to run commands again.
40+
Once disconnected you will need to reconnect to a portal before you will be allowed to run commands again.
4241

4342
## RELATED LINKS
44-
45-
[Module repo: https://github.com/logicmonitor/lm-powershell-module]()
46-
47-
[PSGallery: https://www.powershellgallery.com/packages/Logic.Monitor]()
48-

0 commit comments

Comments
 (0)