Skip to content

Commit 9733fd3

Browse files
Refine Move-ADDirectoryServer cmdlet documentation
Updated Move-ADDirectoryServer documentation for clarity and consistency.
1 parent f11b7f7 commit 9733fd3

1 file changed

Lines changed: 24 additions & 12 deletions

File tree

docset/winserver2022-ps/ActiveDirectory/Move-ADDirectoryServer.md

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ title: Move-ADDirectoryServer
1111
# Move-ADDirectoryServer
1212

1313
## SYNOPSIS
14+
1415
Moves a directory server in Active Directory to a new site.
1516

1617
## SYNTAX
@@ -21,13 +22,14 @@ Move-ADDirectoryServer [-WhatIf] [-Confirm] [-AuthType <ADAuthType>] [-Credentia
2122
```
2223

2324
## DESCRIPTION
25+
2426
The **Move-ADDirectoryServer** cmdlet moves a directory server in Active Directory to a new site within the same domain.
2527

2628
The *Identity* parameter specifies the directory server to move.
2729
You can specify a directory server object by one of the following values:
2830

2931
- Name of the server object (name)
30-
- A distinguished name of the NTDS Settings object
32+
- A distinguished name of the NTDS Settings object
3133
- A distinguished name of the server object that represents the directory server
3234
- GUID (objectGUID) of server object under the configuration partition
3335
- GUID (objectGUID) of NTDS settings object under the configuration partition
@@ -41,14 +43,16 @@ You can identify a site by its distinguished name or GUID.
4143
## EXAMPLES
4244

4345
### Example 1: Move a domain controller to an existing site
44-
```
46+
47+
```powershell
4548
PS C:\> Move-ADDirectoryServer -Identity "USER01-DC2" -Site "Branch-Office-Site"
4649
```
4750

4851
This command moves the domain controller USER01-DC2 to the site Branch-Office-Site.
4952

5053
### Example 2: Move read-only domain controllers to an existing site
51-
```
54+
55+
```powershell
5256
PS C:\> Get-ADDomainController -Filter "IsReadOnly -eq `$True" | Move-ADDirectoryServer -Site "RODC-Site-Name"
5357
```
5458

@@ -57,6 +61,7 @@ This command moves all Read-Only domain controllers to the site RODC-Site-Name.
5761
## PARAMETERS
5862

5963
### -AuthType
64+
6065
Specifies the authentication method to use.
6166
The acceptable values for this parameter are:
6267

@@ -81,6 +86,7 @@ Accept wildcard characters: False
8186
```
8287
8388
### -Confirm
89+
8490
Prompts you for confirmation before running the cmdlet.
8591
8692
```yaml
@@ -96,11 +102,12 @@ Accept wildcard characters: False
96102
```
97103
98104
### -Credential
105+
99106
Specifies the user account credentials to use to perform this task.
100107
The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive.
101108
If the cmdlet is run from such a provider drive, the account associated with the drive is the default.
102109
103-
To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object.
110+
To specify this parameter, you can type a user name, such as User1 or Domain01\User01.
104111
If you specify a user name for this parameter, the cmdlet prompts for a password.
105112
106113
You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet.
@@ -121,14 +128,15 @@ Accept wildcard characters: False
121128
```
122129
123130
### -Identity
131+
124132
Specifies an Active Directory server object by providing one of the following values.
125133
The identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the attribute.
126134
127135
- Name of the server object (name)
128136
129-
For Active Directory Lightweight Directory Services (AD LDS) instances the syntax is of a name is `<computer-name>$<instance-name>`
137+
For Active Directory Lightweight Directory Services (AD LDS) instances the syntax of a name is `<computer-name>$<instance-name>`
130138

131-
Note: When you type this value in Windows PowerShell, you must use the backtick (\`) as an escape character for the dollar sign ($), for example, *asia-w7-vm4`$instance1*.
139+
Note: When you type this value in Windows PowerShell, you must use the backtick (\`) as an escape character for the dollar sign ($), for example, *asia-w7-vm4\`$instance1*.
132140

133141
For other Active Directory instances, use the value of the name property.
134142

@@ -155,17 +163,18 @@ Accept wildcard characters: False
155163
```
156164

157165
### -Server
166+
158167
Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server.
159168
The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory snapshot instance.
160169

161-
Specify the Active Directory Domain Services instance in one of the following ways:
170+
Specify the Active Directory Domain Services instance in one of the following ways:
162171

163172
Domain name values:
164173

165174
- Fully qualified domain name
166175
- NetBIOS name
167176

168-
Directory server values:
177+
Directory server values:
169178

170179
- Fully qualified directory server name
171180
- NetBIOS name
@@ -190,13 +199,14 @@ Accept wildcard characters: False
190199
```
191200

192201
### -Site
202+
193203
Specifies the new site for the directory server.
194204
You can identify the site by one of the following property values.
195205
Note: The identifier in parentheses is the LDAP display name for the attribute.
196206
The acceptable values for this parameter are:
197207

198-
- A distinguished name
199-
- A GUID (objectGUID)
208+
- A distinguished name (distinguishedName)
209+
- A GUID (objectGUID)
200210
- A name (name)
201211

202212
```yaml
@@ -212,6 +222,7 @@ Accept wildcard characters: False
212222
```
213223

214224
### -WhatIf
225+
215226
Shows what would happen if the cmdlet runs.
216227
The cmdlet is not run.
217228

@@ -228,25 +239,26 @@ Accept wildcard characters: False
228239
```
229240

230241
### CommonParameters
242+
231243
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
232244

233245
## INPUTS
234246

235247
### None or Microsoft.ActiveDirectory.Management.ADDirectoryServer
248+
236249
A directory server object is received by the *Identity* parameter.
237250

238251
## OUTPUTS
239252

240253
### None
241254

242255
## NOTES
256+
243257
* This cmdlet does not work with an Active Directory snapshot.
244258
* This cmdlet does not work with a read-only domain controller.
245259

246-
247260
## RELATED LINKS
248261

249262
[Move-ADDirectoryServerOperationMasterRole](./Move-ADDirectoryServerOperationMasterRole.md)
250263

251264
[AD DS Administration Cmdlets in Windows PowerShell](./activedirectory.md)
252-

0 commit comments

Comments
 (0)