Изменить

Поделиться через

Remove-NetIntent

Module:
NetworkATC Module

Removes the requested network intent.

Syntax

ComputerName (Default) 

Remove-NetIntent
    [-Name] <String>
    [[-ComputerName] <String>]
    [-SkipServiceStop <Boolean>]
    [<CommonParameters>]

Cluster 

Remove-NetIntent
    [-Name] <String>
    [-ClusterName] <String>
    [-SkipServiceStop <Boolean>]
    [<CommonParameters>]

Global 

Remove-NetIntent
    [-GlobalOverrides]
    [-SkipServiceStop <Boolean>]
    [<CommonParameters>]

Description

The Remove-NetIntent cmdlet removes the specified network intent.

  • For clusters, if -ClusterName is specified, the removal affects all nodes within the given cluster.
  • For standalone nodes, only the network intents for the specified node will be removed.

Note that Remove-NetIntent does not remove the provisioning on the target hosts. The device administrator must manually remove any old intent configurations from the node.

Examples

Example 1

Remove-NetIntent -Name "MyIntent" -ComputerName "Server01"

This example removes the network intent named MyIntent from the standalone computer Server01.

Parameters

-ClusterName

Specifies the name of the cluster from which the network intent should be removed. The removal will affect all nodes in the specified cluster.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Cluster
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ComputerName

Specifies the name of the computer from which the network intent should be removed.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ComputerName
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-GlobalOverrides

Indicates that global overrides should be removed. This affects all configurations using these global overrides.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

Global
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the name of the network intent to be removed.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ComputerName
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Cluster
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SkipServiceStop

Specifies whether to skip stopping the service during the removal process. If set to $true, the service will not be stopped.

Parameter properties

Type:Boolean
Default value:True
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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.