Get-NetIntent
Gets the current set of intents configured on the node or cluster.
Syntax
ComputerName (Default)
Get-NetIntent
[[-ComputerName] <String>]
[-Name <String>]
[-GlobalOverrides]
[<CommonParameters>]
Cluster
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Cluster
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ComputerName
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-GlobalOverrides
Retrieves the global override settings of the network intent.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| 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 |
-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.
Parameter properties
| Type: | String |
| Default value: | None |
| 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.