Skip to content
Logic.Monitor PowerShell Module

Set-LMUptimeDevice

Syntax

Section titled “Syntax”

IdGeneral (Default)

Section titled “IdGeneral (Default)”
Terminal window
Set-LMUptimeDevice -Id <int> -Type <string> [-PropertiesMethod <string>] [-Description <string>]
 [-HostGroupIds <string[]>] [-PollingInterval <int>] [-AlertTriggerInterval <int>]
 [-GlobalSmAlertCond <string>] [-OverallAlertLevel <string>] [-IndividualAlertLevel <string>]
 [-IndividualSmAlertEnable <bool>] [-UseDefaultLocationSetting <bool>]
 [-UseDefaultAlertSetting <bool>] [-Properties <hashtable>] [-Template <string>]
 [-TestLocationCollectorIds <int[]>] [-TestLocationSmgIds <int[]>] [-TestLocationAll] [-WhatIf]
 [-Confirm] [<CommonParameters>]

IdPing

Section titled “IdPing”
Terminal window
Set-LMUptimeDevice -Id <int> -Type <string> [-PropertiesMethod <string>] [-Description <string>]
 [-HostGroupIds <string[]>] [-PollingInterval <int>] [-AlertTriggerInterval <int>]
 [-GlobalSmAlertCond <string>] [-OverallAlertLevel <string>] [-IndividualAlertLevel <string>]
 [-IndividualSmAlertEnable <bool>] [-UseDefaultLocationSetting <bool>]
 [-UseDefaultAlertSetting <bool>] [-Properties <hashtable>] [-Template <string>]
 [-Hostname <string>] [-Count <int>] [-PercentPktsNotReceiveInTime <int>]
 [-TimeoutInMSPktsNotReceive <int>] [-TestLocationCollectorIds <int[]>]
 [-TestLocationSmgIds <int[]>] [-TestLocationAll] [-WhatIf] [-Confirm] [<CommonParameters>]

IdWeb

Section titled “IdWeb”
Terminal window
Set-LMUptimeDevice -Id <int> -Type <string> [-PropertiesMethod <string>] [-Description <string>]
 [-HostGroupIds <string[]>] [-PollingInterval <int>] [-AlertTriggerInterval <int>]
 [-GlobalSmAlertCond <string>] [-OverallAlertLevel <string>] [-IndividualAlertLevel <string>]
 [-IndividualSmAlertEnable <bool>] [-UseDefaultLocationSetting <bool>]
 [-UseDefaultAlertSetting <bool>] [-Properties <hashtable>] [-Template <string>] [-Domain <string>]
 [-Schema <string>] [-IgnoreSSL <bool>] [-PageLoadAlertTimeInMS <int>] [-AlertExpr <string>]
 [-TriggerSSLStatusAlert <bool>] [-TriggerSSLExpirationAlert <bool>] [-Steps <hashtable[]>]
 [-TestLocationCollectorIds <int[]>] [-TestLocationSmgIds <int[]>] [-TestLocationAll] [-WhatIf]
 [-Confirm] [<CommonParameters>]

NamePing

Section titled “NamePing”
Terminal window
Set-LMUptimeDevice -Name <string> -Type <string> [-PropertiesMethod <string>]
 [-Description <string>] [-HostGroupIds <string[]>] [-PollingInterval <int>]
 [-AlertTriggerInterval <int>] [-GlobalSmAlertCond <string>] [-OverallAlertLevel <string>]
 [-IndividualAlertLevel <string>] [-IndividualSmAlertEnable <bool>]
 [-UseDefaultLocationSetting <bool>] [-UseDefaultAlertSetting <bool>] [-Properties <hashtable>]
 [-Template <string>] [-Hostname <string>] [-Count <int>] [-PercentPktsNotReceiveInTime <int>]
 [-TimeoutInMSPktsNotReceive <int>] [-TestLocationCollectorIds <int[]>]
 [-TestLocationSmgIds <int[]>] [-TestLocationAll] [-WhatIf] [-Confirm] [<CommonParameters>]

NameWeb

Section titled “NameWeb”
Terminal window
Set-LMUptimeDevice -Name <string> -Type <string> [-PropertiesMethod <string>]
 [-Description <string>] [-HostGroupIds <string[]>] [-PollingInterval <int>]
 [-AlertTriggerInterval <int>] [-GlobalSmAlertCond <string>] [-OverallAlertLevel <string>]
 [-IndividualAlertLevel <string>] [-IndividualSmAlertEnable <bool>]
 [-UseDefaultLocationSetting <bool>] [-UseDefaultAlertSetting <bool>] [-Properties <hashtable>]
 [-Template <string>] [-Domain <string>] [-Schema <string>] [-IgnoreSSL <bool>]
 [-PageLoadAlertTimeInMS <int>] [-AlertExpr <string>] [-TriggerSSLStatusAlert <bool>]
 [-TriggerSSLExpirationAlert <bool>] [-Steps <hashtable[]>] [-TestLocationCollectorIds <int[]>]
 [-TestLocationSmgIds <int[]>] [-TestLocationAll] [-WhatIf] [-Confirm] [<CommonParameters>]

NameGeneral

Section titled “NameGeneral”
Terminal window
Set-LMUptimeDevice -Name <string> -Type <string> [-PropertiesMethod <string>]
 [-Description <string>] [-HostGroupIds <string[]>] [-PollingInterval <int>]
 [-AlertTriggerInterval <int>] [-GlobalSmAlertCond <string>] [-OverallAlertLevel <string>]
 [-IndividualAlertLevel <string>] [-IndividualSmAlertEnable <bool>]
 [-UseDefaultLocationSetting <bool>] [-UseDefaultAlertSetting <bool>] [-Properties <hashtable>]
 [-Template <string>] [-TestLocationCollectorIds <int[]>] [-TestLocationSmgIds <int[]>]
 [-TestLocationAll] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Section titled “Description”

The Set-LMUptimeDevice cmdlet updates internal or external Uptime monitors (web or ping) by submitting a PATCH request to the LogicMonitor v3 device endpoint. It resolves the device ID from name when necessary, validates location combinations, and constructs the appropriate payload structure before issuing the request. The Type parameter is mandatory and determines the response structure returned by the API.

Examples

Section titled “Examples”

EXAMPLE 1

Section titled “EXAMPLE 1”
Terminal window
Set-LMUptimeDevice -Id 123 -Type uptimewebcheck -PollingInterval 10 -AlertTriggerInterval 2

Updates the polling interval and alert trigger threshold for the web uptime device with ID 123.

EXAMPLE 2

Section titled “EXAMPLE 2”
Terminal window
Set-LMUptimeDevice -Name "web-ext-01" -Type uptimewebcheck -TestLocationSmgIds 2,4,6 -TriggerSSLStatusAlert $true


Resolves the ID from the device name and updates external web check locations and SSL alerts.

EXAMPLE 3

Section titled “EXAMPLE 3”
Terminal window
Set-LMUptimeDevice -Id 456 -Type uptimepingcheck -Description "Updated ping check"

Updates the description for the ping uptime device with ID 456.

Parameters

Section titled “Parameters”

-AlertExpr

Section titled “-AlertExpr”

Configures the SSL alert expression for web checks.

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

-AlertTriggerInterval

Section titled “-AlertTriggerInterval”

Specifies the number of consecutive failures before alerting.

Type: System.Nullable`1[System.Int32]
DefaultValue: ''
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: ''

-Count

Section titled “-Count”

Sets the number of ping attempts per polling cycle.

Type: System.Nullable`1[System.Int32]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: NamePing
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: IdPing
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Description

Section titled “-Description”

Updates the description of the Uptime device.

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

-Domain

Section titled “-Domain”

Updates the domain for web checks.

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

-GlobalSmAlertCond

Section titled “-GlobalSmAlertCond”

Sets the synthetic monitoring global alert condition (all, half, moreThanOne, any).

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

-HostGroupIds

Section titled “-HostGroupIds”

Sets the group identifiers assigned to the Uptime device.

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

-Hostname

Section titled “-Hostname”

Updates the hostname/IP for ping checks.

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

-Id

Section titled “-Id”

Specifies the device identifier to update. Accepts pipeline input by property name.

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

-IgnoreSSL

Section titled “-IgnoreSSL”

Enables or disables SSL certificate validation warnings.

Type: System.Nullable`1[System.Boolean]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: NameWeb
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: IdWeb
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-IndividualAlertLevel

Section titled “-IndividualAlertLevel”

Configures the individual alert level (warn, error, critical).

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

-IndividualSmAlertEnable

Section titled “-IndividualSmAlertEnable”

Enables or disables individual synthetic alerts.

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

-Name

Section titled “-Name”

Specifies the device name to update. The cmdlet resolves the corresponding ID prior to issuing the request.

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

-OverallAlertLevel

Section titled “-OverallAlertLevel”

Configures the overall alert level (warn, error, critical).

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

-PageLoadAlertTimeInMS

Section titled “-PageLoadAlertTimeInMS”

Sets the page load alert threshold for web checks.

Type: System.Nullable`1[System.Int32]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: NameWeb
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: IdWeb
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-PercentPktsNotReceiveInTime

Section titled “-PercentPktsNotReceiveInTime”

Defines the allowed packet loss percentage before alerting.

Type: System.Nullable`1[System.Int32]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: NamePing
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: IdPing
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-PollingInterval

Section titled “-PollingInterval”

Configures the polling interval in minutes.

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

-Properties

Section titled “-Properties”

Hashtable of custom properties to apply to the Uptime device.

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

-PropertiesMethod

Section titled “-PropertiesMethod”

Determines how custom properties are applied when supplied. Valid values are Add, Replace, or Refresh.

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

-Schema

Section titled “-Schema”

Defines the HTTP schema (http or https) for web checks.

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

-Steps

Section titled “-Steps”

Provides an array of step definitions for web checks.

Type: System.Collections.Hashtable[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: NameWeb
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: IdWeb
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Template

Section titled “-Template”

Specifies an optional template identifier.

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

-TestLocationAll

Section titled “-TestLocationAll”

Indicates that all public locations should be used for external checks.

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

-TestLocationCollectorIds

Section titled “-TestLocationCollectorIds”

Specifies collector identifiers for internal checks.

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

-TestLocationSmgIds

Section titled “-TestLocationSmgIds”

Specifies synthetic monitoring group identifiers for external checks.

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

-TimeoutInMSPktsNotReceive

Section titled “-TimeoutInMSPktsNotReceive”

Defines the timeout threshold in milliseconds for ping checks.

Type: System.Nullable`1[System.Int32]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: NamePing
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: IdPing
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-TriggerSSLExpirationAlert

Section titled “-TriggerSSLExpirationAlert”

Enables or disables SSL expiration alerts.

Type: System.Nullable`1[System.Boolean]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: NameWeb
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: IdWeb
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-TriggerSSLStatusAlert

Section titled “-TriggerSSLStatusAlert”

Enables or disables SSL status alerts.

Type: System.Nullable`1[System.Boolean]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: NameWeb
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: IdWeb
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Type

Section titled “-Type”

Specifies the Uptime monitor type. This parameter is mandatory and determines the response structure. Valid values are uptimewebcheck and uptimepingcheck.

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

-UseDefaultAlertSetting

Section titled “-UseDefaultAlertSetting”

Controls whether default alert settings are used for the Uptime device.

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

-UseDefaultLocationSetting

Section titled “-UseDefaultLocationSetting”

Controls whether default location settings are used for the Uptime device.

Type: System.Nullable`1[System.Boolean]
DefaultValue: ''
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.