Skip to content
Logic.Monitor PowerShell Module

Set-LMUserdata

Syntax

Section titled “Syntax”

Id (Default)

Section titled “Id (Default)”
Terminal window
Set-LMUserdata -Id <string> -DashboardId <string> [-WhatIf] [-Confirm] [<CommonParameters>]

Name

Section titled “Name”
Terminal window
Set-LMUserdata -Name <string> -DashboardId <string> [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Section titled “Description”

The Set-LMUserdata function is used to set the user data for a LogicMonitor user. It allows you to specify the user by either their Id or Name, and the dashboard Id for which the user data should be set.

Examples

Section titled “Examples”

EXAMPLE 1

Section titled “EXAMPLE 1”
Terminal window
Set-LMUserdata -Id "12345" -DashboardId "67890"

Sets the user data for the user with Id “12345” for the dashboard with Id “67890”.

EXAMPLE 2

Section titled “EXAMPLE 2”
Terminal window
Set-LMUserdata -Name "JohnDoe" -DashboardId "67890"

Sets the user data for the user with Name “JohnDoe” for the dashboard with Id “67890”.

Parameters

Section titled “Parameters”

-Confirm

Section titled “-Confirm”

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- cf
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-DashboardId

Section titled “-DashboardId”

Specifies the Id of the dashboard for which the user data should be set. This parameter is mandatory.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Id

Section titled “-Id”

Specifies the Id of the user. This parameter is mandatory when using the ‘Id’ parameter set.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Id
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Name

Section titled “-Name”

Specifies the Name of the user. This parameter is mandatory when using the ‘Name’ parameter set.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Name
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-WhatIf

Section titled “-WhatIf”

Runs the command in a mode that only reports what would happen without performing the actions.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- wi
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

Section titled “CommonParameters”

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.