1- ---
1+ ---
22external help file : NetworkAtc-help.xml
33Module Name : NetworkATC
4- ms.date : 02/21/2024
4+ ms.date : 03/14/2025
55online version : https://learn.microsoft.com/powershell/module/networkatc/copy-netintent?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
66schema : 2.0.0
77title : Copy-NetIntent
@@ -10,7 +10,7 @@ title: Copy-NetIntent
1010# Copy-NetIntent
1111
1212## SYNOPSIS
13- Moves ( or copies) net intent across different hosts or clusters
13+ Moves or copies network intents across different hosts or clusters.
1414
1515## SYNTAX
1616
@@ -72,136 +72,146 @@ Copy-NetIntent [-GlobalOverrides] [-SourceComputerName] <String> [-DestinationCo
7272
7373## DESCRIPTION
7474
75- {{ Fill in the Description }}
75+ The ` Copy-NetIntent ` cmdlet copies or moves a network intent from one host or
76+ cluster to another. The source intent is removed if the ** RemoveSource**
77+ parameter is provided.
7678
7779## EXAMPLES
7880
7981### EXAMPLE 1
8082
83+ ``` powershell
84+ Copy-NetIntent -Name "MyIntent" -SourceComputerName "Server01" -DestinationComputerName "Server02"
8185```
82- Copy-NetIntent
83- ```
86+
87+ This example copies a network intent from the standalone device ` Server01 ` to
88+ the standalone destination device ` Server02 ` .
8489
8590## PARAMETERS
8691
87- ### -DestinationClusterName
92+ ### -Name
8893
89- The name of the cluster that the intent is copied to.
94+ Defines a unique name that identifies the network intent. Since intents are
95+ uniquely determined by their list of physical adapters, the name is used as an
96+ identifier to ensure that each intent is distinct.
9097
9198``` yaml
92- Type : System. String
93- Parameter Sets : ClusterToCluster, LocalToCluster, GlobalClusterToCluster, GlobalLocalToCluster
99+ Type : String
100+ Parameter Sets : LocalToLocal, ClusterToCluster, ClusterToLocal, LocalToCluster
94101Aliases :
95102
96- Required : True
97- Position : 3
103+ Required : False
104+ Position : 1
98105Default value : None
99- Accept pipeline input : False
106+ Accept pipeline input : True (ByPropertyName, ByValue)
100107Accept wildcard characters : False
101108` ` `
102109
103- ### -DestinationComputerName
110+ ### -GlobalOverrides
104111
105- The name of the computer that the intent is copied to.
112+ Specifies that global override settings during the copy operation for any local
113+ settings.
106114
107115` ` ` yaml
108- Type : System.String
109- Parameter Sets : LocalToLocal, ClusterToLocal, GlobalClusterToLocal , GlobalLocalToLocal
116+ Type : SwitchParameter
117+ Parameter Sets : GlobalClusterToLocal, GlobalClusterToCluster, GlobalLocalToCluster , GlobalLocalToLocal
110118Aliases :
111119
112120Required : True
113- Position : 3
114- Default value : None
115- Accept pipeline input : False
121+ Position : Named
122+ Default value : False
123+ Accept pipeline input : True (ByPropertyName, ByValue)
116124Accept wildcard characters : False
117125` ` `
118126
119- ### -GlobalOverrides
127+ ### -SourceComputerName
120128
121- {{ Fill GlobalOverrides Description }}
129+ Specifies the name of the source computer that holds the network intent to be copied.
122130
123131` ` ` yaml
124- Type : System.Management.Automation.SwitchParameter
125- Parameter Sets : GlobalClusterToLocal, GlobalClusterToCluster , GlobalLocalToCluster, GlobalLocalToLocal
132+ Type : String
133+ Parameter Sets : LocalToLocal, LocalToCluster , GlobalLocalToCluster, GlobalLocalToLocal
126134Aliases :
127135
128136Required : True
129- Position : Named
130- Default value : False
131- Accept pipeline input : True (ByPropertyName, ByValue)
137+ Position : 2
138+ Default value : None
139+ Accept pipeline input : False
132140Accept wildcard characters : False
133141` ` `
134142
135- ### -Name
143+ ### -SourceClusterName
136144
137- The name of the intent to be copied.
145+ Specifies the name of the source cluster that contains the network intent to be copied.
138146
139147` ` ` yaml
140- Type : System. String
141- Parameter Sets : LocalToLocal, ClusterToCluster, ClusterToLocal, LocalToCluster
148+ Type : String
149+ Parameter Sets : ClusterToCluster, ClusterToLocal, GlobalClusterToLocal, GlobalClusterToCluster
142150Aliases :
143151
144- Required : False
145- Position : 1
152+ Required : True
153+ Position : 2
146154Default value : None
147- Accept pipeline input : True (ByPropertyName, ByValue)
155+ Accept pipeline input : False
148156Accept wildcard characters : False
149157` ` `
150158
151- ### -RemoveSource
159+ ### -DestinationComputerName
152160
153- Indicates that the source needs to be removed after the copy .
161+ Specifies the name of the destination computer where the network intent is to be copied .
154162
155163` ` ` yaml
156- Type : System.Boolean
157- Parameter Sets : (All)
164+ Type : String
165+ Parameter Sets : LocalToLocal, ClusterToLocal, GlobalClusterToLocal, GlobalLocalToLocal
158166Aliases :
159167
160- Required : False
161- Position : Named
162- Default value : False
168+ Required : True
169+ Position : 3
170+ Default value : None
163171Accept pipeline input : False
164172Accept wildcard characters : False
165173` ` `
166174
167- ### -SourceClusterName
175+ ### -DestinationClusterName
168176
169- The name of the cluster that the intent is copied from .
177+ Specifies the name of the destination cluster to which the network intent is to be copied .
170178
171179` ` ` yaml
172- Type : System. String
173- Parameter Sets : ClusterToCluster, ClusterToLocal, GlobalClusterToLocal, GlobalClusterToCluster
180+ Type : String
181+ Parameter Sets : ClusterToCluster, LocalToCluster, GlobalClusterToCluster, GlobalLocalToCluster
174182Aliases :
175183
176184Required : True
177- Position : 2
185+ Position : 3
178186Default value : None
179187Accept pipeline input : False
180188Accept wildcard characters : False
181189` ` `
182190
183- ### -SourceComputerName
191+ ### -RemoveSource
184192
185- The name of the computer that the intent is copied from.
193+ Indicates whether the original network intent should be removed from the source
194+ after the copy operation is completed.
186195
187196` ` ` yaml
188- Type : System.String
189- Parameter Sets : LocalToLocal, LocalToCluster, GlobalLocalToCluster, GlobalLocalToLocal
197+ Type : Boolean
198+ Parameter Sets : (All)
190199Aliases :
191200
192- Required : True
193- Position : 2
194- Default value : None
201+ Required : False
202+ Position : Named
203+ Default value : False
195204Accept pipeline input : False
196205Accept wildcard characters : False
197206` ` `
198207
199208### -Wait
200209
201- {{ Fill Wait Description }}
210+ When specified, the command will wait for the network configuration commands to
211+ complete or for status confirmation before returning control.
202212
203213` ` ` yaml
204- Type : System.Management.Automation. SwitchParameter
214+ Type : SwitchParameter
205215Parameter Sets : (All)
206216Aliases :
207217
@@ -214,14 +224,28 @@ Accept wildcard characters: False
214224
215225### CommonParameters
216226
217- This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
227+ This cmdlet supports the common parameters: -Debug, -ErrorAction,
228+ -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable,
229+ -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
230+ For more information, see
231+ [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
218232
219233## INPUTS
220234
221235## OUTPUTS
222236
223237## NOTES
224238
225- The copy & removal operation of the intent is not a transacted operation\` .
239+ The copy and removal operation of the intent isn't a transacted operation.
226240
227241## RELATED LINKS
242+
243+ - [Add-NetIntent](Add-NetIntent.md)
244+
245+ - [Get-NetIntent](Get-NetIntent.md)
246+
247+ - [Get-NetIntentStatus](Get-NetIntentStatus.md)
248+
249+ - [Remove-NetIntent](Remove-NetIntent.md)
250+
251+ - [Set-NetIntent](Set-NetIntent.md)
0 commit comments