Get-NetIntent

Gets the current set of intents configured on the node or cluster.

Syntax

Get-NetIntent
   [[-ComputerName] <String>]
   [-Name <String>]
   [-GlobalOverrides]
   [<CommonParameters>]
Get-NetIntent
   [-ClusterName] <String>
   [-Name <String>]
   [-GlobalOverrides]
   [<CommonParameters>]

Description

The Get-NetIntent cmdlet retrieves the current network intents that have been configured either on a standalone host or a cluster.

Examples

Example 1

Get-NetIntent -ComputerName "Server01" -Name "MyIntent"

This example retrieves the network intent MyIntent on the standalone host Server01.

Parameters

-ClusterName

Specifies the name of the cluster for which the network intent is being defined. When used, the intent "floats" across the cluster. Any node with matching physical adapter names will automatically apply the intended configuration.

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

-ComputerName

Specifies the computer name of the target host on which the network intent configuration will be applied. For standalone hosts, use the local computer name; for scenarios where the script is executed remotely, ensure the current user has administrative privileges on the target machine.

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

-GlobalOverrides

Retrieves the global override settings of the network intent.

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

-Name

Defines a unique name that identifies the network intent. Since intents are uniquely determined by their list of physical adapters, the name is used as an identifier to ensure that each intent is distinct.

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