New-LMNetScan
Syntax
New-LMNetScan [-CollectorId] <String> [-Name] <String> [[-Description] <String>] [[-ExcludeDuplicateType] <String>] [[-IgnoreSystemIpDuplicates] <Boolean>] [[-Method] <String>] [[-NextStart] <String>] [[-NextStartEpoch] <String>] [[-NetScanGroupId] <String>] [[-Schedule] <PSObject>] [-SubnetRange] <String> [[-CredentialGroupId] <String>] [[-CredentialGroupName] <String>] [[-ChangeNameToken] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Description
The New-LMNetScan function is used to create a new network scan in LogicMonitor. It sends a POST request to the LogicMonitor API to create the network scan with the specified parameters.
Examples
Example 1
New-LMNetScan -CollectorId "12345" -Name "MyNetScan" -SubnetRange "192.168.0.0/24"Creates a new network scan with the specified collector ID, name, and subnet range.
Parameters
-CollectorId
The ID of the collector to use for the network scan. This parameter is mandatory.
Type: StringParameter Sets: (All)Aliases:
Required: TruePosition: 1Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False
-Name
The name of the network scan. This parameter is mandatory.
Type: StringParameter Sets: (All)Aliases:
Required: TruePosition: 2Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False
-Description
The description of the network scan.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: 3Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False
-ExcludeDuplicateType
The type of duplicate exclusion to apply. The default value is “1”.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: 4Default value: 1Accept pipeline input: FalseAccept wildcard characters: False
-IgnoreSystemIpDuplicates
Specifies whether to ignore duplicate system IPs. The default value is $false.
Type: BooleanParameter Sets: (All)Aliases:
Required: FalsePosition: 5Default value: FalseAccept pipeline input: FalseAccept wildcard characters: False
-Method
The method to use for the network scan. Only “nmap” is supported. The default value is “nmap”.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: 6Default value: NmapAccept pipeline input: FalseAccept wildcard characters: False
-NextStart
The next start time for the network scan. The default value is “manual”.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: 7Default value: ManualAccept pipeline input: FalseAccept wildcard characters: False
-NextStartEpoch
The next start time epoch for the network scan. The default value is “0”.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: 8Default value: 0Accept pipeline input: FalseAccept wildcard characters: False
-NetScanGroupId
The ID of the network scan group to assign the network scan to. The default value is “1”.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: 9Default value: 1Accept pipeline input: FalseAccept wildcard characters: False
-Schedule
Fill Schedule Description
Type: PSObjectParameter Sets: (All)Aliases:
Required: FalsePosition: 10Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False
-SubnetRange
The subnet range to scan. This parameter is mandatory.
Type: StringParameter Sets: (All)Aliases:
Required: TruePosition: 11Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False
-CredentialGroupId
The ID of the credential group to use for the network scan.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: 12Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False
-CredentialGroupName
The name of the credential group to use for the network scan.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: 13Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False
-ChangeNameToken
The token to use for changing the name of discovered devices. The default value is “##REVERSEDNS##”.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: 14Default value: ##REVERSEDNS##Accept pipeline input: FalseAccept wildcard characters: False
-ProgressAction
Fill ProgressAction Description
Type: ActionPreferenceParameter Sets: (All)Aliases: proga
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False
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.