Set-LMPortalInfo
Syntax
Section titled “Syntax”Set-LMPortalInfo [[-Whitelist] <String>] [-ClearWhitelist] [[-RequireTwoFA] <Boolean>] [[-IncludeACKinAlertTotals] <Boolean>] [[-IncludeSDTinAlertTotals] <Boolean>] [[-EnableRemoteSession] <Boolean>] [[-CompanyDisplayName] <String>] [[-UserSessionTimeoutInMin] <Int32>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]Description
Section titled “Description”The Set-LMPortalInfo function modifies various portal-wide settings in LogicMonitor, including whitelisting, two-factor authentication, alert totals, and session timeouts.
Examples
Section titled “Examples”Example 1
Section titled “Example 1”Set-LMPortalInfo -RequireTwoFA $true -UserSessionTimeoutInMin 60 -CompanyDisplayName "My Company"Updates the portal settings to require 2FA, set session timeout to 60 minutes, and update company display name.Parameters
Section titled “Parameters”-Whitelist
Section titled “-Whitelist”Specifies IP addresses/ranges to whitelist for portal access.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: 1Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False-ClearWhitelist
Section titled “-ClearWhitelist”Indicates whether to clear the existing whitelist.
Type: SwitchParameterParameter Sets: (All)Aliases:
Required: FalsePosition: NamedDefault value: FalseAccept pipeline input: FalseAccept wildcard characters: False-RequireTwoFA
Section titled “-RequireTwoFA”Specifies whether to require two-factor authentication for all users.
Type: BooleanParameter Sets: (All)Aliases:
Required: FalsePosition: 2Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False-IncludeACKinAlertTotals
Section titled “-IncludeACKinAlertTotals”Specifies whether to include acknowledged alerts in alert totals.
Type: BooleanParameter Sets: (All)Aliases:
Required: FalsePosition: 3Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False-IncludeSDTinAlertTotals
Section titled “-IncludeSDTinAlertTotals”Specifies whether to include alerts in SDT in alert totals.
Type: BooleanParameter Sets: (All)Aliases:
Required: FalsePosition: 4Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False-EnableRemoteSession
Section titled “-EnableRemoteSession”Specifies whether to enable remote session functionality.
Type: BooleanParameter Sets: (All)Aliases:
Required: FalsePosition: 5Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False-CompanyDisplayName
Section titled “-CompanyDisplayName”Specifies the company name to display in the portal.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: 6Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False-UserSessionTimeoutInMin
Section titled “-UserSessionTimeoutInMin”Specifies the session timeout in minutes. Valid values: 30, 60, 120, 240, 480, 1440, 10080, 43200.
Type: Int32Parameter Sets: (All)Aliases:
Required: FalsePosition: 7Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False-WhatIf
Section titled “-WhatIf”Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameterParameter Sets: (All)Aliases: wi
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-Confirm
Section titled “-Confirm”Prompts you for confirmation before running the cmdlet.
Type: SwitchParameterParameter Sets: (All)Aliases: cf
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-ProgressAction
Section titled “-ProgressAction”Fill ProgressAction Description
Type: ActionPreferenceParameter Sets: (All)Aliases: proga
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: FalseCommonParameters
Section titled “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.
Inputs
Section titled “Inputs”Outputs
Section titled “Outputs”Returns the response from the API containing the updated portal settings.
Section titled “Returns the response from the API containing the updated portal settings.”This function requires a valid LogicMonitor API authentication.