Skip to content

Commit a6fe038

Browse files
authored
Merge pull request #1328 from velkovb/get-addcreplpolicy
Add parameter description in 2012 version
2 parents 934a867 + 73eaabf commit a6fe038

File tree

3 files changed

+109
-53
lines changed

3 files changed

+109
-53
lines changed

docset/windows/addsadministration/get-addomaincontrollerpasswordreplicationpolicy.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,9 @@ This command gets from an RODC domain controller password replication policy the
6262

6363
### Example 2: Get the password replication policy allowed list from all RODCs in the domain
6464
```
65-
PS C:\> Get-ADDomainController -Filter {IsReadOnly -eq $True} | Get-ADDomainControllerPasswordReplicationPolicy -Allowed
66-
DistinguishedName : CN=Allowed RODC Password Replication Group,CN=Users,DC=User01,DC=com
65+
C:\PS>Get-ADDomainController -Filter {IsReadOnly -eq $true} | Get-ADDomainControllerPasswordReplicationPolicy -Allowed
66+
67+
DistinguishedName : CN=Allowed RODC Password Replication Group,CN=Users,DC=Fabrikam,DC=com
6768
Name : Allowed RODC Password Replication Group
6869
ObjectClass : group
6970
ObjectGUID : 239b0470-7f49-472d-8fcb-4911e90b2c5e

docset/winserver2012-ps/activedirectory/Get-ADDomainControllerPasswordReplicationPolicy.md

Lines changed: 89 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -29,33 +29,29 @@ Get-ADDomainControllerPasswordReplicationPolicy [-AuthType <ADAuthType>] [-Crede
2929
```
3030

3131
## DESCRIPTION
32-
The Get-ADDomainControllerPasswordReplicationPolicy gets the users, computers, service accounts and groups that are members of the applied list or denied list for a read-only domain controller's (RODC) password replication policy.
33-
To get the members of the applied list, specify the AppliedList parameter.
34-
To get the members of the denied list, specify the DeniedList parameter.
32+
The **Get-ADDomainControllerPasswordReplicationPolicy** cmdlet gets the users, computers, service accounts and groups that are members of the applied list or denied list for a read-only domain controller's (RODC) password replication policy.
33+
To get the members of the applied list, specify the *AppliedList* parameter.
34+
To get the members of the denied list, specify the *DeniedList* parameter.
3535

36-
The Identity parameter specifies the RODC that uses the allowed and denied lists to apply the password replication policy.
36+
The *Identity* parameter specifies the RODC that uses the allowed and denied lists to apply the password replication policy.
3737
You can identify a domain controller by its GUID, IPV4Address, IPV6Address, or DNS host name.
38-
You can also identify a domain controller by the name of the server object that represents the domain controller, the Distinguished Name (DN) of the NTDS settings object or the server object, the GUID of the NTDS settings object or the server object under the configuration partition, or the DN of the computer object that represents the domain controller.
38+
You can also identify a domain controller by the name of the server object that represents the domain controller, the distinguished name of the NTDS settings object or the server object, the GUID of the NTDS settings object or the server object under the configuration partition, or the distinguished name of the computer object that represents the domain controller.
3939

40-
You can also set the Identity parameter to a domain controller object variable, such as $\<localDomainControllerObject\>, or pass a domain controller object through the pipeline to the Identity parameter.
41-
For example, you can use the Get-ADDomainController cmdlet to retrieve a domain controller object and then pass the object through the pipeline to the Get-ADDomainControllerPasswordReplicationPolicy cmdlet.
40+
You can also set the *Identity* parameter to a domain controller object variable, such as `$<localDomainControllerObject>`, or pass a domain controller object through the pipeline operator to the *Identity* parameter.
41+
For example, you can use the **Get-ADDomainController** cmdlet to retrieve a domain controller object and then pass the object through the pipeline operator to the **Get-ADDomainControllerPasswordReplicationPolicy** cmdlet.
4242

4343
If you specify a writeable domain controller for this cmdlet, the cmdlet returns a non-terminating error.
4444

4545
## EXAMPLES
4646

47-
### -------------------------- EXAMPLE 1 --------------------------
47+
### Example 1: Gets from an RODC domain controller password replication policy the allowed accounts showing the name and object class of each
4848
```
4949
C:\PS>Get-ADDomainControllerPasswordReplicationPolicy -Identity "FABRIKAM-RODC1" -Allowed | ft Name,ObjectClass
5050
```
5151

52-
Description
52+
This command gets from an RODC domain controller password replication policy the allowed accounts showing the name and object class of each.
5353

54-
-----------
55-
56-
Get from an RODC domain controller password replication policy the allowed accounts showing the name and object class of each
57-
58-
### -------------------------- EXAMPLE 2 --------------------------
54+
### Example 2: Get the password replication policy allowed list from all RODCs in the domain
5955
```
6056
C:\PS>Get-ADDomainController -Filter {IsReadOnly -eq $true} | Get-ADDomainControllerPasswordReplicationPolicy -Allowed
6157
@@ -67,16 +63,12 @@ SamAccountName : Allowed RODC Password Replication Group
6763
SID : S-1-5-21-41432690-3719764436-1984117282-571
6864
```
6965

70-
Description
71-
72-
-----------
73-
74-
Get the password replication policy allowed lists from all RODCs in the domain.
66+
This command gets the password replication policy allowed lists from all RODCs in the domain.
7567

7668
## PARAMETERS
7769

7870
### -Allowed
79-
{{Fill Allowed Description}}
71+
Specifies a search for accounts that have been authenticated by a read-only domain controller.
8072

8173
```yaml
8274
Type: SwitchParameter
@@ -91,7 +83,15 @@ Accept wildcard characters: False
9183
```
9284
9385
### -AuthType
94-
{{Fill AuthType Description}}
86+
Specifies the authentication method to use.
87+
The acceptable values for this parameter are:
88+
89+
- Negotiate or 0
90+
- Basic or 1
91+
92+
The default authentication method is Negotiate.
93+
94+
A Secure Sockets Layer (SSL) connection is required for the Basic authentication method.
9595
9696
```yaml
9797
Type: ADAuthType
@@ -107,7 +107,21 @@ Accept wildcard characters: False
107107
```
108108
109109
### -Credential
110-
{{Fill Credential Description}}
110+
Specifies the user account credentials to use to perform this task.
111+
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.
112+
If the cmdlet is run from such a provider drive, the account associated with the drive is the default.
113+
114+
To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object.
115+
If you specify a user name for this parameter, the cmdlet prompts for a password.
116+
117+
You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet.
118+
You can then set the *Credential* parameter to the **PSCredential** object.
119+
120+
If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error.
121+
122+
Specifies the credentials for the security context under which the task is performed.
123+
If this security context doesn't have directory level permissions to perform the task, then an error is returned by the directory.
124+
If running under the context of an Active Directory module for Windows PowerShell provider drive, the credentials information associated with the drive is used as the default value; otherwise, the currently logged on user security context is used.
111125
112126
```yaml
113127
Type: PSCredential
@@ -122,7 +136,14 @@ Accept wildcard characters: False
122136
```
123137
124138
### -Denied
125-
{{Fill Denied Description}}
139+
Specifies the users, computers, groups, or other accounts to add to the list of accounts that are denied the right to replicate their passwords to this read-only domain controller (RODC).
140+
You can specify more than one value by using a comma-separated list.
141+
The acceptable values for this parameter are:
142+
143+
- A distinguished name
144+
- A GUID (objectGUID)
145+
- A security identifier (objectSid)
146+
- A SAM account name (sAMAccountName)
126147
127148
```yaml
128149
Type: SwitchParameter
@@ -137,7 +158,25 @@ Accept wildcard characters: False
137158
```
138159
139160
### -Identity
140-
{{Fill Identity Description}}
161+
Specifies an Active Directory domain controller object by providing one of the following values.
162+
The identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the attribute.
163+
The acceptable values for this parameter are:
164+
165+
- A GUID (objectGUID)
166+
- An IPV4Address
167+
- A Global IPV6Address
168+
- A DNS Host Name (dNSHostName)
169+
- A name of the server object
170+
- A Distinguished Name of the NTDS Settings object
171+
- A distinguished name of the server object that represents the domain controller
172+
- A GUID of NTDS settings object under the configuration partition
173+
- A GUID of server object under the configuration partition
174+
- A distinguished name of the computer object that represents the domain controller.
175+
176+
The cmdlet searches the default naming context or partition to find the object.
177+
If two or more objects are found, the cmdlet returns a non-terminating error.
178+
179+
This parameter can also get this object through the pipeline or you can set this parameter to an object instance.
141180
142181
```yaml
143182
Type: ADDomainController
@@ -152,7 +191,27 @@ Accept wildcard characters: False
152191
```
153192
154193
### -Server
155-
{{Fill Server Description}}
194+
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.
195+
The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services, or Active Directory snapshot instance.
196+
197+
Specify the Active Directory Domain Services instance in one of the following ways:
198+
199+
Domain name values:
200+
201+
- Fully qualified domain name
202+
- NetBIOS name
203+
204+
Directory server values:
205+
206+
- Fully qualified directory server name
207+
- NetBIOS name
208+
- Fully qualified directory server name and port
209+
210+
The default value for this parameter is determined by one of the following methods in the order that they are listed:
211+
212+
- By using the *Server* value from objects passed through the pipeline
213+
- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive
214+
- By using the domain of the computer running Windows PowerShell
156215
157216
```yaml
158217
Type: String
@@ -167,12 +226,12 @@ Accept wildcard characters: False
167226
```
168227
169228
### CommonParameters
170-
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).
229+
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).
171230
172231
## INPUTS
173232
174233
### Microsoft.ActiveDirectory.Management.ADDomainController
175-
A domain controller object is received by the Identity parameter.
234+
A domain controller object is received by the *Identity* parameter.
176235
177236
## OUTPUTS
178237
@@ -181,13 +240,13 @@ Returns one or more objects that represent the users, computers, service account
181240
The list returned depends on the parameters specified.
182241
183242
## NOTES
184-
* This cmdlet does not work with AD LDS.
185-
186-
This cmdlet does not work when targeting a snapshot using the Server parameter.
243+
* This cmdlet does not work with Active Directory Lightweight Directory Services.
244+
* This cmdlet does not work when targeting a snapshot using the Server parameter.
187245
188246
## RELATED LINKS
189247
190248
[Add-ADDomainControllerPasswordReplicationPolicy](./Add-ADDomainControllerPasswordReplicationPolicy.md)
191249
192250
[Remove-ADDomainControllerPasswordReplicationPolicy](./Remove-ADDomainControllerPasswordReplicationPolicy.md)
193251
252+
[AD DS Administration Cmdlets in Windows PowerShell](./ActiveDirectory.md)

docset/winserver2012r2-ps/addsadministration/Get-ADDomainControllerPasswordReplicationPolicy.md

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,15 @@ Get-ADDomainControllerPasswordReplicationPolicy [-AuthType <ADAuthType>] [-Crede
3838

3939
## DESCRIPTION
4040
The **Get-ADDomainControllerPasswordReplicationPolicy** cmdlet gets the users, computers, service accounts and groups that are members of the applied list or denied list for a read-only domain controller's (RODC) password replication policy.
41-
To get the members of the applied list, specify the **AppliedList** parameter.
42-
To get the members of the denied list, specify the **DeniedList** parameter.
41+
To get the members of the applied list, specify the *AppliedList* parameter.
42+
To get the members of the denied list, specify the *DeniedList* parameter.
4343

44-
The **Identity** parameter specifies the RODC that uses the allowed and denied lists to apply the password replication policy.
44+
The *Identity* parameter specifies the RODC that uses the allowed and denied lists to apply the password replication policy.
4545
You can identify a domain controller by its GUID, IPV4Address, IPV6Address, or DNS host name.
4646
You can also identify a domain controller by the name of the server object that represents the domain controller, the distinguished name of the NTDS settings object or the server object, the GUID of the NTDS settings object or the server object under the configuration partition, or the distinguished name of the computer object that represents the domain controller.
4747

48-
You can also set the **Identity** parameter to a domain controller object variable, such as **$\<localDomainControllerObject\>**, or pass a domain controller object through the pipeline operator to the **Identity** parameter.
49-
For example, you can use the Get-ADDomainController cmdlet to retrieve a domain controller object and then pass the object through the pipeline operator to the **Get-ADDomainControllerPasswordReplicationPolicy** cmdlet.
48+
You can also set the *Identity* parameter to a domain controller object variable, such as `$<localDomainControllerObject>`, or pass a domain controller object through the pipeline operator to the *Identity* parameter.
49+
For example, you can use the **Get-ADDomainController** cmdlet to retrieve a domain controller object and then pass the object through the pipeline operator to the **Get-ADDomainControllerPasswordReplicationPolicy** cmdlet.
5050

5151
If you specify a writeable domain controller for this cmdlet, the cmdlet returns a non-terminating error.
5252

@@ -61,17 +61,13 @@ This command gets from an RODC domain controller password replication policy the
6161

6262
### Example 2: Get the password replication policy allowed list from all RODCs in the domain
6363
```
64-
PS C:\> Get-ADDomainController -Filter {IsReadOnly -eq $true} | Get-ADDomainControllerPasswordReplicationPolicy -Allowed
65-
DistinguishedName : CN=Allowed RODC Password Replication Group,CN=Users,DC=User01,DC=com
64+
C:\PS>Get-ADDomainController -Filter {IsReadOnly -eq $true} | Get-ADDomainControllerPasswordReplicationPolicy -Allowed
6665
66+
DistinguishedName : CN=Allowed RODC Password Replication Group,CN=Users,DC=Fabrikam,DC=com
6767
Name : Allowed RODC Password Replication Group
68-
6968
ObjectClass : group
70-
7169
ObjectGUID : 239b0470-7f49-472d-8fcb-4911e90b2c5e
72-
7370
SamAccountName : Allowed RODC Password Replication Group
74-
7571
SID : S-1-5-21-41432690-3719764436-1984117282-571
7672
```
7773

@@ -126,8 +122,8 @@ If the cmdlet is run from such a provider drive, the account associated with the
126122
To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object.
127123
If you specify a user name for this parameter, the cmdlet prompts for a password.
128124
129-
You can also create a **PSCredential** object by using a script or by using the Get-Credentialhttp://go.microsoft.com/fwlink/?LinkID=293936 cmdlet.
130-
You can then set the **Credential** parameter to the **PSCredential** object.
125+
You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet.
126+
You can then set the *Credential* parameter to the **PSCredential** object.
131127
132128
If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error.
133129
@@ -204,25 +200,25 @@ Accept wildcard characters: False
204200
205201
### -Server
206202
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.
207-
The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory snapshot instance.
203+
The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory snapshot instance.
208204
209-
Specify the Active Directory Domain Services instance in one of the following ways:
205+
Specify the Active Directory Domain Services instance in one of the following ways:
210206
211-
Domain name values:
207+
Domain name values:
212208
213209
- Fully qualified domain name
214210
- NetBIOS name
215211
216-
Directory server values:
212+
Directory server values:
217213
218214
- Fully qualified directory server name
219215
- NetBIOS name
220216
- Fully qualified directory server name and port
221217
222218
The default value for this parameter is determined by one of the following methods in the order that they are listed:
223219
224-
- By using the **Server** value from objects passed through the pipeline
225-
- By using the server information associated with the Active Directory Domain ServicesWindows PowerShell provider drive, when the cmdlet runs in that drive
220+
- By using the *Server* value from objects passed through the pipeline
221+
- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive
226222
- By using the domain of the computer running Windows PowerShell
227223
228224
```yaml
@@ -238,12 +234,12 @@ Accept wildcard characters: False
238234
```
239235
240236
### CommonParameters
241-
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).
237+
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).
242238
243239
## INPUTS
244240
245241
### Microsoft.ActiveDirectory.Management.ADDomainController
246-
A domain controller object is received by the **Identity** parameter.
242+
A domain controller object is received by the *Identity* parameter.
247243
248244
## OUTPUTS
249245

0 commit comments

Comments
 (0)