Remove-NetIntent

Removes the requested network intent.

Syntax

Remove-NetIntent
      [-Name] <String>
      [[-ComputerName] <String>]
      [-SkipServiceStop <Boolean>]
      [<CommonParameters>]
Remove-NetIntent
      [-Name] <String>
      [-ClusterName] <String>
      [-SkipServiceStop <Boolean>]
      [<CommonParameters>]
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.

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

-ComputerName

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

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

-GlobalOverrides

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

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

-Name

Specifies the name of the network intent to be removed.

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

-SkipServiceStop

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

Type:Boolean
Position:Named
Default value:True
Required:False
Accept pipeline input:False
Accept wildcard characters:False