Set-LMNetScan
Syntax
Section titled “Syntax”Set-LMNetScan [[-CollectorId] <String>] [[-Name] <String>] [-Id] <String> [[-Description] <String>] [[-ExcludeDuplicateType] <String>] [[-IgnoreSystemIpDuplpicates] <Boolean>] [[-Method] <String>] [[-NextStart] <String>] [[-NextStartEpoch] <String>] [[-NetScanGroupId] <String>] [[-SubnetRange] <String>] [[-CredentialGroupId] <String>] [[-CredentialGroupName] <String>] [[-Schedule] <PSObject>] [[-ChangeNameToken] <String>] [[-PortList] <String>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]Description
Section titled “Description”The Set-LMNetscan function modifies an existing NetScan configuration in LogicMonitor.
Examples
Section titled “Examples”Example 1
Section titled “Example 1”Set-LMNetscan -Id 123 -Name "UpdatedScan" -Description "New description"Updates the NetScan with ID 123 with a new name and description.Parameters
Section titled “Parameters”-CollectorId
Section titled “-CollectorId”Specifies the ID of the collector to use for the NetScan.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: 1Default value: NoneAccept pipeline input: FalseAccept wildcard characters: FalseSpecifies the name of the NetScan.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: 2Default value: NoneAccept pipeline input: FalseAccept wildcard characters: FalseSpecifies the ID of the NetScan to modify.
Type: StringParameter Sets: (All)Aliases:
Required: TruePosition: 3Default value: NoneAccept pipeline input: True (ByPropertyName)Accept wildcard characters: False-Description
Section titled “-Description”Specifies the description for the NetScan.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: 4Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False-ExcludeDuplicateType
Section titled “-ExcludeDuplicateType”Specifies the type of duplicates to exclude.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: 5Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False-IgnoreSystemIpDuplpicates
Section titled “-IgnoreSystemIpDuplpicates”Specifies whether to ignore system IP duplicates.
Type: BooleanParameter Sets: (All)Aliases:
Required: FalsePosition: 6Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False-Method
Section titled “-Method”Specifies the scanning method to use.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: 7Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False-NextStart
Section titled “-NextStart”Specifies when the next scan should start.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: 8Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False-NextStartEpoch
Section titled “-NextStartEpoch”Specifies when the next scan should start in epoch time.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: 9Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False-NetScanGroupId
Section titled “-NetScanGroupId”Specifies the ID of the NetScan group.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: 10Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False-SubnetRange
Section titled “-SubnetRange”Specifies the subnet range to scan.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: 11Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False-CredentialGroupId
Section titled “-CredentialGroupId”Specifies the ID of the credential group.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: 12Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False-CredentialGroupName
Section titled “-CredentialGroupName”Specifies the name of the credential group.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: 13Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False-Schedule
Section titled “-Schedule”Specifies the scanning schedule configuration.
Type: PSObjectParameter Sets: (All)Aliases:
Required: FalsePosition: 14Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False-ChangeNameToken
Section titled “-ChangeNameToken”Specifies the token for changing names.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: 15Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False-PortList
Section titled “-PortList”Specifies the list of ports to scan.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: 16Default 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”You can pipe objects containing Id properties to this function.
Section titled “You can pipe objects containing Id properties to this function.”Outputs
Section titled “Outputs”Returns a LogicMonitor.NetScan object containing the updated scan configuration.
Section titled “Returns a LogicMonitor.NetScan object containing the updated scan configuration.”This function requires a valid LogicMonitor API authentication.