The Copy-NetIntent cmdlet copies or moves a network intent from one host or cluster to another.
The source intent is removed if the RemoveSource parameter is provided.
This example copies a network intent from the standalone device Server01 to the standalone
destination device Server02.
Parameters
-DestinationClusterName
Specifies the name of the destination cluster to which the network intent is to be copied.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
ClusterToCluster
Position:
3
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
LocalToCluster
Position:
3
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
GlobalClusterToCluster
Position:
3
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
GlobalLocalToCluster
Position:
3
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-DestinationComputerName
Specifies the name of the destination computer where the network intent is to be copied.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
LocalToLocal
Position:
3
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
ClusterToLocal
Position:
3
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
GlobalClusterToLocal
Position:
3
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
GlobalLocalToLocal
Position:
3
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-GlobalOverrides
Specifies that global override settings during the copy operation for any local
settings.
Parameter properties
Type:
SwitchParameter
Default value:
False
Supports wildcards:
False
DontShow:
False
Parameter sets
GlobalClusterToLocal
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
True
Value from remaining arguments:
False
GlobalClusterToCluster
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
True
Value from remaining arguments:
False
GlobalLocalToCluster
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
True
Value from remaining arguments:
False
GlobalLocalToLocal
Position:
Named
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
True
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
LocalToLocal
Position:
1
Mandatory:
False
Value from pipeline:
True
Value from pipeline by property name:
True
Value from remaining arguments:
False
ClusterToCluster
Position:
1
Mandatory:
False
Value from pipeline:
True
Value from pipeline by property name:
True
Value from remaining arguments:
False
ClusterToLocal
Position:
1
Mandatory:
False
Value from pipeline:
True
Value from pipeline by property name:
True
Value from remaining arguments:
False
LocalToCluster
Position:
1
Mandatory:
False
Value from pipeline:
True
Value from pipeline by property name:
True
Value from remaining arguments:
False
-RemoveSource
Indicates whether the original network intent should be removed from the source after the copy
operation is completed.
Parameter properties
Type:
Boolean
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
-SourceClusterName
Specifies the name of the source cluster that contains the network intent to be copied.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
ClusterToCluster
Position:
2
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
ClusterToLocal
Position:
2
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
GlobalClusterToLocal
Position:
2
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
GlobalClusterToCluster
Position:
2
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-SourceComputerName
Specifies the name of the source computer that holds the network intent to be copied.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
LocalToLocal
Position:
2
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
LocalToCluster
Position:
2
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
GlobalLocalToCluster
Position:
2
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
GlobalLocalToLocal
Position:
2
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Wait
When specified, the command will wait for the network configuration commands to complete or for
status confirmation before returning control.
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
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.
Notes
The copy and removal operation of the intent isn't a transacted operation.