Skip to content
Logic.Monitor PowerShell Module

New-LMCachedAccount

Syntax

Section titled “Syntax”

LMv1 (Default)

Section titled “LMv1 (Default)”
Terminal window
New-LMCachedAccount -AccessId <string> -AccessKey <string> -AccountName <string>
 [-CachedAccountName <string>] [-OverwriteExisting <bool>] [-GovCloud] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Bearer

Section titled “Bearer”
Terminal window
New-LMCachedAccount -AccountName <string> -BearerToken <string> [-CachedAccountName <string>]
 [-OverwriteExisting <bool>] [-GovCloud] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Section titled “Description”

The New-LMCachedAccount function stores LogicMonitor portal credentials securely for use with Connect-LMAccount.

Examples

Section titled “Examples”

EXAMPLE 1

Section titled “EXAMPLE 1”
Terminal window
#Cache LMv1 credentials
New-LMCachedAccount -AccessId "id123" -AccessKey "key456" -AccountName "company"

EXAMPLE 2

Section titled “EXAMPLE 2”
Terminal window
#Cache Bearer token
New-LMCachedAccount -BearerToken "token123" -AccountName "company" -CachedAccountName "prod"

EXAMPLE 3

Section titled “EXAMPLE 3”
Terminal window
#Cache FedRAMP GovCloud credentials
New-LMCachedAccount -AccessId "id123" -AccessKey "key456" -AccountName "agency" -GovCloud

Parameters

Section titled “Parameters”

-AccessId

Section titled “-AccessId”

The Access ID from your LogicMonitor API credentials.

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

-AccessKey

Section titled “-AccessKey”

The Access Key from your LogicMonitor API credentials.

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

-AccountName

Section titled “-AccountName”

The portal subdomain (e.g., “company” for company.logicmonitor.com).

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

-BearerToken

Section titled “-BearerToken”

The Bearer token for authentication (alternative to AccessId/AccessKey).

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

-CachedAccountName

Section titled “-CachedAccountName”

The name to use for the cached account. Defaults to AccountName.

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

-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: ''

-GovCloud

Section titled “-GovCloud”

Connect using the LM GovCloud (FedRAMP) portal when this cached account is used.

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

-OverwriteExisting

Section titled “-OverwriteExisting”

Whether to overwrite an existing cached account. Defaults to false.

Type: System.Boolean
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  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.