1
- ---
1
+ ---
2
2
external help file : NetworkAtc-help.xml
3
3
Module Name : NetworkATC
4
- ms.date : 02/21/2024
4
+ ms.date : 03/14/2025
5
5
online version : https://learn.microsoft.com/powershell/module/networkatc/copy-netintent?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
6
6
schema : 2.0.0
7
7
title : Copy-NetIntent
@@ -10,7 +10,7 @@ title: Copy-NetIntent
10
10
# Copy-NetIntent
11
11
12
12
## SYNOPSIS
13
- Moves ( or copies) net intent across different hosts or clusters
13
+ Moves or copies network intents across different hosts or clusters.
14
14
15
15
## SYNTAX
16
16
@@ -72,136 +72,146 @@ Copy-NetIntent [-GlobalOverrides] [-SourceComputerName] <String> [-DestinationCo
72
72
73
73
## DESCRIPTION
74
74
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.
76
78
77
79
## EXAMPLES
78
80
79
81
### EXAMPLE 1
80
82
83
+ ``` powershell
84
+ Copy-NetIntent -Name "MyIntent" -SourceComputerName "Server01" -DestinationComputerName "Server02"
81
85
```
82
- Copy-NetIntent
83
- ```
86
+
87
+ This example copies a network intent from the standalone device ` Server01 ` to
88
+ the standalone destination device ` Server02 ` .
84
89
85
90
## PARAMETERS
86
91
87
- ### -DestinationClusterName
92
+ ### -Name
88
93
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.
90
97
91
98
``` yaml
92
- Type : System. String
93
- Parameter Sets : ClusterToCluster, LocalToCluster, GlobalClusterToCluster, GlobalLocalToCluster
99
+ Type : String
100
+ Parameter Sets : LocalToLocal, ClusterToCluster, ClusterToLocal, LocalToCluster
94
101
Aliases :
95
102
96
- Required : True
97
- Position : 3
103
+ Required : False
104
+ Position : 1
98
105
Default value : None
99
- Accept pipeline input : False
106
+ Accept pipeline input : True (ByPropertyName, ByValue)
100
107
Accept wildcard characters : False
101
108
` ` `
102
109
103
- ### -DestinationComputerName
110
+ ### -GlobalOverrides
104
111
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.
106
114
107
115
` ` ` yaml
108
- Type : System.String
109
- Parameter Sets : LocalToLocal, ClusterToLocal, GlobalClusterToLocal , GlobalLocalToLocal
116
+ Type : SwitchParameter
117
+ Parameter Sets : GlobalClusterToLocal, GlobalClusterToCluster, GlobalLocalToCluster , GlobalLocalToLocal
110
118
Aliases :
111
119
112
120
Required : 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)
116
124
Accept wildcard characters : False
117
125
` ` `
118
126
119
- ### -GlobalOverrides
127
+ ### -SourceComputerName
120
128
121
- {{ Fill GlobalOverrides Description }}
129
+ Specifies the name of the source computer that holds the network intent to be copied.
122
130
123
131
` ` ` yaml
124
- Type : System.Management.Automation.SwitchParameter
125
- Parameter Sets : GlobalClusterToLocal, GlobalClusterToCluster , GlobalLocalToCluster, GlobalLocalToLocal
132
+ Type : String
133
+ Parameter Sets : LocalToLocal, LocalToCluster , GlobalLocalToCluster, GlobalLocalToLocal
126
134
Aliases :
127
135
128
136
Required : 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
132
140
Accept wildcard characters : False
133
141
` ` `
134
142
135
- ### -Name
143
+ ### -SourceClusterName
136
144
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.
138
146
139
147
` ` ` yaml
140
- Type : System. String
141
- Parameter Sets : LocalToLocal, ClusterToCluster, ClusterToLocal, LocalToCluster
148
+ Type : String
149
+ Parameter Sets : ClusterToCluster, ClusterToLocal, GlobalClusterToLocal, GlobalClusterToCluster
142
150
Aliases :
143
151
144
- Required : False
145
- Position : 1
152
+ Required : True
153
+ Position : 2
146
154
Default value : None
147
- Accept pipeline input : True (ByPropertyName, ByValue)
155
+ Accept pipeline input : False
148
156
Accept wildcard characters : False
149
157
` ` `
150
158
151
- ### -RemoveSource
159
+ ### -DestinationComputerName
152
160
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 .
154
162
155
163
` ` ` yaml
156
- Type : System.Boolean
157
- Parameter Sets : (All)
164
+ Type : String
165
+ Parameter Sets : LocalToLocal, ClusterToLocal, GlobalClusterToLocal, GlobalLocalToLocal
158
166
Aliases :
159
167
160
- Required : False
161
- Position : Named
162
- Default value : False
168
+ Required : True
169
+ Position : 3
170
+ Default value : None
163
171
Accept pipeline input : False
164
172
Accept wildcard characters : False
165
173
` ` `
166
174
167
- ### -SourceClusterName
175
+ ### -DestinationClusterName
168
176
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 .
170
178
171
179
` ` ` yaml
172
- Type : System. String
173
- Parameter Sets : ClusterToCluster, ClusterToLocal, GlobalClusterToLocal, GlobalClusterToCluster
180
+ Type : String
181
+ Parameter Sets : ClusterToCluster, LocalToCluster, GlobalClusterToCluster, GlobalLocalToCluster
174
182
Aliases :
175
183
176
184
Required : True
177
- Position : 2
185
+ Position : 3
178
186
Default value : None
179
187
Accept pipeline input : False
180
188
Accept wildcard characters : False
181
189
` ` `
182
190
183
- ### -SourceComputerName
191
+ ### -RemoveSource
184
192
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.
186
195
187
196
` ` ` yaml
188
- Type : System.String
189
- Parameter Sets : LocalToLocal, LocalToCluster, GlobalLocalToCluster, GlobalLocalToLocal
197
+ Type : Boolean
198
+ Parameter Sets : (All)
190
199
Aliases :
191
200
192
- Required : True
193
- Position : 2
194
- Default value : None
201
+ Required : False
202
+ Position : Named
203
+ Default value : False
195
204
Accept pipeline input : False
196
205
Accept wildcard characters : False
197
206
` ` `
198
207
199
208
### -Wait
200
209
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.
202
212
203
213
` ` ` yaml
204
- Type : System.Management.Automation. SwitchParameter
214
+ Type : SwitchParameter
205
215
Parameter Sets : (All)
206
216
Aliases :
207
217
@@ -214,14 +224,28 @@ Accept wildcard characters: False
214
224
215
225
### CommonParameters
216
226
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).
218
232
219
233
## INPUTS
220
234
221
235
## OUTPUTS
222
236
223
237
## NOTES
224
238
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.
226
240
227
241
## 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