Set-LMNetscan

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>] [<CommonParameters>]

Description

The Set-LMNetscan function modifies an existing NetScan configuration in LogicMonitor.

Examples

Example 1

Set-LMNetscan -Id 123 -Name "UpdatedScan" -Description "New description"
Updates the NetScan with ID 123 with a new name and description.

Parameters

-CollectorId

Specifies the ID of the collector to use for the NetScan.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Specifies the name of the NetScan.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id

Specifies the ID of the NetScan to modify.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Description

Specifies the description for the NetScan.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ExcludeDuplicateType

Specifies the type of duplicates to exclude.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IgnoreSystemIpDuplpicates

Specifies whether to ignore system IP duplicates.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Method

Specifies the scanning method to use.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NextStart

Specifies when the next scan should start.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NextStartEpoch

Specifies when the next scan should start in epoch time.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NetScanGroupId

Specifies the ID of the NetScan group.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SubnetRange

Specifies the subnet range to scan.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CredentialGroupId

Specifies the ID of the credential group.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CredentialGroupName

Specifies the name of the credential group.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Schedule

Specifies the scanning schedule configuration.

Type: PSObject
Parameter Sets: (All)
Aliases:

Required: False
Position: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ChangeNameToken

Specifies the token for changing names.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 15
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PortList

Specifies the list of ports to scan.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 16
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

Fill ProgressAction Description

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept 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.

Inputs

You can pipe objects containing Id properties to this function.

Outputs

Returns a LogicMonitor.NetScan object containing the updated scan configuration.

Notes

This function requires a valid LogicMonitor API authentication.

Related LINKS