Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
stevevillardi committed Jul 5, 2024
1 parent ef4d9e2 commit d9ac229
Show file tree
Hide file tree
Showing 17 changed files with 586 additions and 290 deletions.
5 changes: 4 additions & 1 deletion Documentation/Disconnect-LMAccount.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Disconnect from a previously connected LM portal
## SYNTAX

```
Disconnect-LMAccount
Disconnect-LMAccount [<CommonParameters>]
```

## DESCRIPTION
Expand All @@ -29,6 +29,9 @@ Disconnect-LMAccount

## PARAMETERS

### CommonParameters
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).

## INPUTS

### None. You cannot pipe objects to this command.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/Get-LMAccessGroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Retrieves the access group with the specified name.

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

Expand Down
5 changes: 4 additions & 1 deletion Documentation/Get-LMAccountStatus.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Retrieves the status of the LogicMonitor account.
## SYNTAX

```
Get-LMAccountStatus
Get-LMAccountStatus [<CommonParameters>]
```

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

## PARAMETERS

### CommonParameters
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).

## INPUTS

## OUTPUTS
Expand Down
100 changes: 57 additions & 43 deletions Documentation/Get-LMDeviceDatasourceInstance.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,65 +8,73 @@ schema: 2.0.0
# Get-LMDeviceDatasourceInstance

## SYNOPSIS
{{ Fill in the Synopsis }}
Retrieves instances of a LogicMonitor device datasource.

## SYNTAX

### Name-dsName
```
Get-LMDeviceDatasourceInstance -DatasourceName <String> -DeviceName <String> [-Filter <Object>]
[-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-LMDeviceDatasourceInstance -DatasourceName <String> -Name <String> [-Filter <Object>] [-BatchSize <Int32>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### Id-dsName
```
Get-LMDeviceDatasourceInstance -DatasourceName <String> -DeviceId <Int32> [-Filter <Object>]
[-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-LMDeviceDatasourceInstance -DatasourceName <String> -Id <Int32> [-Filter <Object>] [-BatchSize <Int32>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### Name-dsId
```
Get-LMDeviceDatasourceInstance -DatasourceId <Int32> -DeviceName <String> [-Filter <Object>]
[-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-LMDeviceDatasourceInstance -DatasourceId <Int32> -Name <String> [-Filter <Object>] [-BatchSize <Int32>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### Id-dsId
```
Get-LMDeviceDatasourceInstance -DatasourceId <Int32> -DeviceId <Int32> [-Filter <Object>] [-BatchSize <Int32>]
Get-LMDeviceDatasourceInstance -DatasourceId <Int32> -Id <Int32> [-Filter <Object>] [-BatchSize <Int32>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

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

## EXAMPLES

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

{{ Add example description here }}
### EXAMPLE 2
```
Get-LMDeviceDatasourceInstance -DatasourceId 1234 -Id 5678
Retrieves instances of the datasource with ID 1234 for the device with ID 5678.
```

## PARAMETERS

### -BatchSize
{{ Fill BatchSize Description }}
### -DatasourceName
Specifies the name of the datasource.
This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets.

```yaml
Type: Int32
Parameter Sets: (All)
Type: String
Parameter Sets: Name-dsName, Id-dsName
Aliases:

Required: False
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -DatasourceId
{{ Fill DatasourceId Description }}
Specifies the ID of the datasource.
This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets.
```yaml
Type: Int32
Expand All @@ -75,33 +83,37 @@ Aliases:

Required: True
Position: Named
Default value: None
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -DatasourceName
{{ Fill DatasourceName Description }}
### -Id
Specifies the ID of the device.
This parameter is mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets.
It can also be specified using the 'DeviceId' alias.
```yaml
Type: String
Parameter Sets: Name-dsName, Id-dsName
Aliases:
Type: Int32
Parameter Sets: Id-dsName, Id-dsId
Aliases: DeviceId

Required: True
Position: Named
Default value: None
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -DeviceId
{{ Fill DeviceId Description }}
### -Name
Specifies the name of the device.
This parameter is mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets.
It can also be specified using the 'DeviceName' alias.
```yaml
Type: Int32
Parameter Sets: Id-dsName, Id-dsId
Aliases: Id
Type: String
Parameter Sets: Name-dsName, Name-dsId
Aliases: DeviceName

Required: True
Position: Named
Expand All @@ -110,32 +122,34 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -DeviceName
{{ Fill DeviceName Description }}
### -Filter
Specifies additional filters to apply to the instances.
This parameter accepts an object representing the filter criteria.
```yaml
Type: String
Parameter Sets: Name-dsName, Name-dsId
Aliases: Name
Type: Object
Parameter Sets: (All)
Aliases:

Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Filter
{{ Fill Filter Description }}
### -BatchSize
Specifies the number of instances to retrieve per batch.
The default value is 1000.
```yaml
Type: Object
Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Default value: 1000
Accept pipeline input: False
Accept wildcard characters: False
```
Expand All @@ -160,10 +174,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS
### None
## OUTPUTS
### System.Object
## NOTES
This function requires a valid API authentication and authorization.
Use Connect-LMAccount to log in before running any commands.
## RELATED LINKS
70 changes: 42 additions & 28 deletions Documentation/Get-LMDeviceDatasourceInstanceAlertRecipients.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# Get-LMDeviceDatasourceInstanceAlertRecipients

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

## SYNTAX

Expand Down Expand Up @@ -37,25 +37,34 @@ Get-LMDeviceDatasourceInstanceAlertRecipients -DatasourceId <Int32> -Id <Int32>
```

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

## EXAMPLES

### Example 1
```powershell
PS C:\> {{ Add example code here }}
### EXAMPLE 1
```
Get-LMDeviceDatasourceInstanceAlertRecipients -DatasourceName "Ping-" -Name "Server01" -InstanceName "Instance01" -DataPointName "PingLossPercent"
```

Retrieves the alert recipients for the "PingLossPercent" data point in the "CPU" datasource instance of the "Server01" device.

### EXAMPLE 2
```
Get-LMDeviceDatasourceInstanceAlertRecipients -DatasourceId 123 -Id 456 -InstanceName "Instance01" -DataPointName "PingLossPercent"
```

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

## PARAMETERS

### -DataPointName
{{ Fill DataPointName Description }}
### -DatasourceName
Specifies the name of the datasource.
This parameter is mandatory when using the 'Id-dsName' or 'Name-dsName' parameter sets.

```yaml
Type: String
Parameter Sets: (All)
Parameter Sets: Name-dsName, Id-dsName
Aliases:

Required: True
Expand All @@ -66,7 +75,8 @@ Accept wildcard characters: False
```
### -DatasourceId
{{ Fill DatasourceId Description }}
Specifies the ID of the datasource.
This parameter is mandatory when using the 'Id-dsId' or 'Name-dsId' parameter sets.
```yaml
Type: Int32
Expand All @@ -75,33 +85,37 @@ Aliases:

Required: True
Position: Named
Default value: None
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -DatasourceName
{{ Fill DatasourceName Description }}
### -Id
Specifies the ID of the device.
This parameter is mandatory when using the 'Id-dsId' or 'Id-dsName' parameter sets.
It can also be specified using the 'DeviceId' alias.
```yaml
Type: String
Parameter Sets: Name-dsName, Id-dsName
Aliases:
Type: Int32
Parameter Sets: Id-dsName, Id-dsId
Aliases: DeviceId

Required: True
Position: Named
Default value: None
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
### -Id
{{ Fill Id Description }}
### -Name
Specifies the name of the device.
This parameter is mandatory when using the 'Name-dsName' or 'Name-dsId' parameter sets.
It can also be specified using the 'DeviceName' alias.
```yaml
Type: Int32
Parameter Sets: Id-dsName, Id-dsId
Aliases:
Type: String
Parameter Sets: Name-dsName, Name-dsId
Aliases: DeviceName

Required: True
Position: Named
Expand All @@ -111,7 +125,8 @@ Accept wildcard characters: False
```
### -InstanceName
{{ Fill InstanceName Description }}
Specifies the name of the datasource instance.
This parameter is mandatory.
```yaml
Type: String
Expand All @@ -125,12 +140,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
{{ Fill Name Description }}
### -DataPointName
Specifies the name of the data point.
This parameter is mandatory.
```yaml
Type: String
Parameter Sets: Name-dsName, Name-dsId
Parameter Sets: (All)
Aliases:

Required: True
Expand Down Expand Up @@ -160,10 +176,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS
### None
## OUTPUTS
### System.Object
## NOTES
## RELATED LINKS
Loading

0 comments on commit d9ac229

Please sign in to comment.