Skip to content
Logic.Monitor PowerShell Module

New-LMWebsite

Syntax

Section titled “Syntax”

Website

Section titled “Website”
Terminal window
New-LMWebsite -WebCheck -Name <string> -WebsiteDomain <string> [-IsInternal <bool>]
 [-Description <string>] [-DisableAlerting <bool>] [-StopMonitoring <bool>]
 [-UseDefaultAlertSetting <bool>] [-UseDefaultLocationSetting <bool>]
 [-TriggerSSLStatusAlert <bool>] [-TriggerSSLExpirationAlert <bool>] [-GroupId <string>]
 [-HttpType <string>] [-SSLAlertThresholds <string[]>] [-PageLoadAlertTimeInMS <int>]
 [-IgnoreSSL <bool>] [-FailedCount <int>] [-OverallAlertLevel <string>]
 [-IndividualAlertLevel <string>] [-Properties <hashtable>] [-PropertiesMethod <string>]
 [-PollingInterval <int>] [-WebsiteSteps <Object[]>] [-CheckPoints <Object[]>]
 [-TestLocationAll <bool>] [-TestLocationCollectorIds <int[]>] [-TestLocationSmgIds <int[]>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

Ping

Section titled “Ping”
Terminal window
New-LMWebsite -PingCheck -Name <string> -PingAddress <string> [-IsInternal <bool>]
 [-Description <string>] [-DisableAlerting <bool>] [-StopMonitoring <bool>]
 [-UseDefaultAlertSetting <bool>] [-UseDefaultLocationSetting <bool>] [-GroupId <string>]
 [-PingCount <int>] [-PingTimeout <int>] [-PingPercentNotReceived <int>] [-FailedCount <int>]
 [-OverallAlertLevel <string>] [-IndividualAlertLevel <string>] [-Properties <hashtable>]
 [-PropertiesMethod <string>] [-PollingInterval <int>] [-TestLocationAll <bool>]
 [-TestLocationCollectorIds <int[]>] [-TestLocationSmgIds <int[]>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Description

Section titled “Description”

The New-LMWebsite function is used to create a new LogicMonitor website or ping check. It allows you to specify various parameters such as the type of check (website or ping), the name of the check, the description, and other settings related to monitoring and alerting.

Examples

Section titled “Examples”

EXAMPLE 1

Section titled “EXAMPLE 1”
Terminal window
New-LMWebsite -WebCheck -Name "Example Website" -WebsiteDomain "example.com" -HttpType "https" -GroupId "12345" -OverallAlertLevel "error" -IndividualAlertLevel "warn"

This example creates a new LogicMonitor website check for the website “example.com” with HTTPS protocol. It assigns the check to the group with ID “12345” and sets the overall alert level to “error” and the individual alert level to “warn”.

EXAMPLE 2

Section titled “EXAMPLE 2”
Terminal window
New-LMWebsite -PingCheck -Name "Example Ping" -PingAddress "192.168.1.1" -PingCount 5 -PingTimeout 1000 -GroupId "12345" -OverallAlertLevel "warn" -IndividualAlertLevel "warn"

This example creates a new LogicMonitor ping check for the IP address “192.168.1.1”. It sends 5 pings with a timeout of 1000 milliseconds. It assigns the check to the group with ID “12345” and sets the overall alert level and individual alert level to “warn”.

Parameters

Section titled “Parameters”

-CheckPoints

Section titled “-CheckPoints”

Specifies the check points for the check. This is a legacy parameter and will be deprecated in a future release.

Type: System.Object[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Website
  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: ''

-Description

Section titled “-Description”

Specifies the description of the check.

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

-DisableAlerting

Section titled “-DisableAlerting”

Specifies whether alerting is disabled for the check.

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

-FailedCount

Section titled “-FailedCount”

Specifies the number of consecutive failed checks required to trigger an alert. The valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 30, and 60.

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

-GroupId

Section titled “-GroupId”

Specifies the ID of the group to which the check belongs.

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

-HttpType

Section titled “-HttpType”

Specifies the HTTP type to use for the website check. The valid values are “http” and “https”. The default value is “https”.

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

-IgnoreSSL

Section titled “-IgnoreSSL”

Specifies whether to ignore SSL errors for the website check.

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

-IndividualAlertLevel

Section titled “-IndividualAlertLevel”

Specifies the individual alert level for the check. The valid values are “warn”, “error”, and “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: ''

-IsInternal

Section titled “-IsInternal”

Specifies whether the check is internal or external. By default, it is set to $false.

Type: System.Nullable`1[System.Boolean]
DefaultValue: False
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 name of the check.

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

-OverallAlertLevel

Section titled “-OverallAlertLevel”

Specifies the overall alert level for the check. The valid values are “warn”, “error”, and “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”

Specifies the page load alert time in milliseconds for the website check.

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

-PingAddress

Section titled “-PingAddress”

Specifies the address to ping for the ping check.

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

-PingCheck

Section titled “-PingCheck”

Specifies that the check type is a ping check. This parameter is mutually exclusive with the WebCheck parameter.

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

-PingCount

Section titled “-PingCount”

Specifies the number of pings to send for the ping check. The valid values are 5, 10, 15, 20, 30, and 50.

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

-PingPercentNotReceived

Section titled “-PingPercentNotReceived”

Specifies the percentage of packets not received in time for the ping check. The valid values are 10, 20, 30, 40, 50, 60, 70, 80, 90, and 100.

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

-PingTimeout

Section titled “-PingTimeout”

Specifies the timeout for the ping check.

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

-PollingInterval

Section titled “-PollingInterval”

Specifies the polling interval for the check.

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”

Specifies additional custom properties for the check.

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”

Specifies the method to use for handling custom properties. The valid values are “Add”, “Replace”, and “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: ''

-SSLAlertThresholds

Section titled “-SSLAlertThresholds”

Specifies the SSL alert thresholds for the website check. This is an alias for the alertExpr parameter.

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

-StopMonitoring

Section titled “-StopMonitoring”

Specifies whether monitoring is stopped for the check.

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

-TestLocationAll

Section titled “-TestLocationAll”

Specifies whether to test all locations. This parameter is only valid for external checks.

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

-TestLocationCollectorIds

Section titled “-TestLocationCollectorIds”

Specifies the collector IDs for the test locations.

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 the SMG IDs for the test locations.

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

-TriggerSSLExpirationAlert

Section titled “-TriggerSSLExpirationAlert”

Specifies whether to trigger an alert when the SSL certificate of the website check is about to expire.

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

-TriggerSSLStatusAlert

Section titled “-TriggerSSLStatusAlert”

Specifies whether to trigger an alert when the SSL status of the website check changes.

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

-UseDefaultAlertSetting

Section titled “-UseDefaultAlertSetting”

Specifies whether to use the default alert settings for the check.

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

-UseDefaultLocationSetting

Section titled “-UseDefaultLocationSetting”

Specifies whether to use the default location settings for the check.

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

-WebCheck

Section titled “-WebCheck”

Specifies that the check type is a website check. This parameter is mutually exclusive with the PingCheck parameter.

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

-WebsiteDomain

Section titled “-WebsiteDomain”

Specifies the domain of the website to check.

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

-WebsiteSteps

Section titled “-WebsiteSteps”

Specifies the steps to perform for the website check.

Type: System.Object[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Website
  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.