Skip to content

Commit 44c9a4e

Browse files
sdwheelersdwheeler
authored
Add about topics for ActiveDirectory (#3837)
* Add about topics for ActiveDirectory * fix link
1 parent 5c8b808 commit 44c9a4e

24 files changed

+5292
-6
lines changed

‎docset/winserver2012-ps/activedirectory/About/About.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
description: About articles for the ActiveDirectory module.
33
Help Version: 3.1.0.0
44
Locale: en-US
5-
ms.date: 04/22/2013
5+
ms.date: 07/03/2024
66
title: About articles
77
---
88
# About topics
@@ -13,5 +13,14 @@ About topics cover a range of concepts about PowerShell.
1313

1414
## About Topics
1515

16+
### [about_ActiveDirectory](about_ActiveDirectory.md)
17+
The Active Directory module is a command line interface for managing Active Directory.
18+
1619
### [about_ActiveDirectory_Filter](about_ActiveDirectory_Filter.md)
1720
Describes the syntax and behavior of the search filter supported by the Active Directory module for Windows PowerShell.
21+
22+
### [about_ActiveDirectory_Identity](about_ActiveDirectory_Identity.md)
23+
The Active Directory module for Windows PowerShell objects have a range of identifying attributes that are used for search and retrieval.
24+
25+
### [about_ActiveDirectory_ObjectModel](about_ActiveDirectory_ObjectModel.md)
26+
Describes the object model of the Active Directory module for Windows PowerShell.

‎docset/winserver2012-ps/activedirectory/About/about_ActiveDirectory.md

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
title: about_ActiveDirectory
3+
ms.date: 04/22/2013
4+
description: The Active Directory module is a command line interface for managing Active Directory.
5+
Locale: en-US
6+
schema: 2.0.0
7+
---
8+
9+
# about_ActiveDirectory
10+
11+
## SHORT DESCRIPTION
12+
13+
The Active Directory module is a command line interface for managing Active
14+
Directory.
15+
16+
## LONG DESCRIPTION
17+
18+
The Active Directory module for Windows PowerShell is for IT Professionals who
19+
are administering and interfacing with Active Directory. The Active Directory
20+
module provides an efficient way to complete many administrative,
21+
configuration, and diagnostic tasks across Active Directory Domain Services (AD
22+
DS) and Active Directory Lightweight Directory Services (AD LDS) instances in
23+
their environments. The Active Directory module includes a set of Windows
24+
PowerShell cmdlets and a provider. The provider exposes the Active Directory
25+
database through a hierarchical navigation system, which is very similar to the
26+
file system. As with drives in a file system, such as C:, you can connect
27+
Windows PowerShell drives to Active Directory domains and AD LDS, as well as
28+
Active Directory snapshots.
29+
30+
### Coverage of Active Directory Module Cmdlets
31+
32+
Create, Read, Update, and Delete actions are supported for Active Directory
33+
objects by cmdlets such as `New-ADUser`, `Get-ADOrganizationalUnit`,
34+
`Set-ADComputer`, and `Remove-ADUser`.
35+
36+
Account and Password Policy Management are supported by cmdlets such as
37+
`Enable-ADAccount`, `Unlock-ADAccount`, `New-ADServiceAccount`,
38+
`Set-ADAccountControl`, and `Remove-ADFineGrainedPasswordPolicy`.
39+
40+
Domain and Forest Management is supported by cmdlets such as `Get-ADForest`,
41+
`Set-ADForest`, `Set-ADForestMode`, `Enable-ADOptionalFeature`,
42+
`Get-ADDomainController`, and `Get-ADDomain`.
43+
44+
### Listing the Active Directory Module Cmdlets
45+
46+
To get a list of all of the Active Directory module cmdlets, run
47+
48+
```powershell
49+
Get-Command -Module ActiveDirectory
50+
```
51+
52+
### Getting Started
53+
54+
Getting started with the Active Directory module for Windows PowerShell is as
55+
easy as clicking the following shortcut:
56+
57+
Run the following command in any Windows PowerShell prompt to import the Active
58+
Directory module:
59+
60+
```powershell
61+
Import-Module ActiveDirectory
62+
```
63+
64+
### Overview and Conceptual Topics
65+
66+
The first two of these topics offer a high level overview of the Active
67+
Directory module and the Active Directory Provider.
68+
69+
- For a brief introduction to the Active Directory provider for Windows
70+
PowerShell, see [ActiveDirectory](/powershell/module/activedirectory).
71+
- The following topics are conceptual support topics for the Active Directory
72+
module cmdlets.
73+
- For an introduction to the **Identity** parameter, which is used by the
74+
Active Directory module cmdlets to identify objects in the directory, see
75+
[about_ActiveDirectory_Identity](about_ActiveDirectory_Identity.md).
76+
- For an introduction to the **Filter** parameter which is used by Active
77+
Directory module cmdlets to search for objects in the directory, see
78+
[about_ActiveDirectory_Filter](about_ActiveDirectory_Filter.md).
79+
- For an introduction to the .NET Framework-based object model implemented by
80+
the Active Directory module, see
81+
[about_ActiveDirectory_ObjectModel](about_ActiveDirectory_ObjectModel.md).

‎docset/winserver2012-ps/activedirectory/About/about_ActiveDirectory_Identity.md

+196
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,196 @@
1+
---
2+
title: about_ActiveDirectory_Identity
3+
ms.date: 04/22/2013
4+
description: This article lists the identifying attributes that are used for search and retrieval supported by the Active Directory module for Windows PowerShell.
5+
Locale: en-US
6+
schema: 2.0.0
7+
---
8+
9+
# about_ActiveDirectory_Identity
10+
11+
## SHORT DESCRIPTION
12+
13+
The Active Directory module for Windows PowerShell objects have a range of
14+
identifying attributes that are used for search and retrieval.
15+
16+
## LONG DESCRIPTION
17+
18+
In order to identify the objects in Active Directory, each object has
19+
attributes that can be used as identifiers. In the Active Directory module, the
20+
value of the identity of an object can be passed using the Identity parameter.
21+
Each object type has its own set of possible types and values for use by the
22+
Identity parameter. See the detailed description of the Identity parameter of
23+
the given cmdlet for more information about its usage.
24+
25+
When searching with the Active Directory module cmdlets, the value of the
26+
Identity parameter, along with the values of the Server and Partition
27+
parameters, is used to uniquely identify a single object. The Server parameter
28+
is used to locate which server to connect with. The Partition parameter further
29+
narrows the search to a specific partition. The Identity parameter then
30+
resolves to a single unique object in the partition.
31+
32+
Note that using the Security Accounts Manager (SAM) Account Name
33+
(**sAMAccountName**) when targeting a global catalog port, you will not find a
34+
user in a different domain if you are using the Identity parameter
35+
36+
If more than one object is found using identity resolution, the Active
37+
Directory module throws an error.
38+
39+
For more information about the Server and Partition parameters, see the help
40+
topics for the individual cmdlets where they are used, such as `Get-ADUser`, by
41+
typing:
42+
43+
```powershell
44+
Get-Help Get-ADUser
45+
```
46+
47+
### Objects and Identities
48+
49+
Each object has a list of attributes that can be used as an identity for that
50+
object. Additionally, if the object inherits from another object, then the
51+
parent object's identities can also be used as the child object's identities.
52+
For more information on the Active Directory object hierarchy, see
53+
[about_ActiveDirectory_ObjectModel](about_ActiveDirectory_ObjectModel.md).
54+
55+
> [!NOTE]
56+
> For Active Directory Provider cmdlets, only an object's 'Distinguished Name'
57+
> or 'Relative Distinguished Name' can be used as the identity. For a list of
58+
> Active Directory Provider cmdlets, see ActiveDirectory.
59+
60+
### Identity Attributes
61+
62+
The following is a list of identity attributes by object type.
63+
64+
- ADAccount
65+
- Distinguished Name
66+
- GUID (objectGUID)
67+
- Security Identifier (objectSid)
68+
- SAM Account Name (sAMAccountName)
69+
70+
- ADComputer
71+
- Distinguished Name
72+
- GUID (objectGUID)
73+
- Security Identifier (objectSid)
74+
- Security Accounts Manager Account Name (sAMAccountName)
75+
76+
- ADDirectoryServer
77+
- Name of the server object (name)
78+
- For AD LDS instances the syntax of a name is `<computer-name>$<instance-name>`
79+
- For other Active Directory instances, use the value of the name property.
80+
- Distinguished Name of the NTDS Settings object
81+
- Distinguished Name of the server object that represents the directory
82+
server.
83+
- GUID (objectGUID) of server object under the configuration partition.
84+
- GUID (objectGUID) of NTDS settings object under the configuration partition
85+
86+
- ADDomain
87+
- Distinguished Name
88+
- GUID
89+
- Security Identifier
90+
- DNS domain name
91+
- NetBIOS domain name
92+
93+
- ADDomainController
94+
- GUID (objectGUID)
95+
- IPV4Address
96+
- Global IPV6Address
97+
- DNS Host Name (dNSHostName)
98+
- Name of the server object
99+
- Distinguished Name of the NTDS Settings object
100+
- Distinguished Name of the server object that represents the domain controller
101+
- GUID of NTDS settings object under the configuration partition
102+
- GUID of server object under the configuration partition
103+
- Distinguished Name of the computer object that represents the domain controller.
104+
105+
- ADFineGrainedPasswordPolicy
106+
- Distinguished Name
107+
- GUID (objectGUID)
108+
- Name (name)
109+
110+
- ADForest
111+
- Fully qualified domain name
112+
- DNS host name
113+
- NetBIOS name
114+
115+
- ADGroup
116+
- Distinguished Name
117+
- GUID (objectGUID)
118+
- Security Identifier (objectSid)
119+
- Security Accounts Manager (SAM) Account Name (sAMAccountName)
120+
121+
- ADObject
122+
- Distinguished Name
123+
- GUID (objectGUID)
124+
125+
- ADOptionalFeature
126+
- Distinguished Name
127+
- Name (name)
128+
- Feature GUID (featureGUID)
129+
- GUID (objectGUID)
130+
131+
- ADOrganizationalUnit
132+
- Distinguished Name
133+
- GUID (objectGUID)
134+
135+
- ADPrincipal
136+
- Distinguished Name
137+
- GUID (objectGUID)
138+
- Security Identifier (objectSid)
139+
- SAM Account Name (sAMAccountName)
140+
141+
- ADServiceAccount
142+
- Distinguished Name
143+
- GUID (objectGUID)
144+
- Security Identifier (objectSid)
145+
- SAM Account Name (sAMAccountName)
146+
147+
- ADUser
148+
- Distinguished Name
149+
- GUID (objectGUID)
150+
- Security Identifier (objectSid)
151+
- SAM User Name (sAMUserName)
152+
153+
154+
### Identities Formats
155+
156+
Active Directory module objects have a range of identity attributes. Below is a
157+
list of these, their types and formats.
158+
159+
- Distinguished Name
160+
- Example: CN=SaraDavis,CN=Europe,CN=Users, DC=corp,DC=contoso,DC=com
161+
162+
- DNS domain name
163+
- Example: redmond.corp.contoso.com
164+
165+
- DNS Host Name (dNSHostName)
166+
- Example: corp-DC01.corp.contoso.com
167+
168+
- Feature GUID (featureGUID)
169+
- Example: 599c3d2e-f72d-4d20-8a88-030d99495f20
170+
171+
- Fully qualified domain name
172+
- Example: corp.contoso.com
173+
174+
- Global IPV6Address
175+
- Example: 2001:4898:0:fff:200:5efe:157.59.132.61
176+
177+
- GUID (objectGUID)
178+
- Example: 599c3d2e-f72d-4d20-8a88-030d99495f20
179+
180+
- IPV4Address
181+
- Example:157.59.132.61
182+
183+
- NetBIOS domain name
184+
- Example: redmond
185+
186+
- Name of the server object
187+
- Example: corp-DC01$
188+
189+
- SAM Account Name (sAMAccountName)
190+
- Example: saradavisreports
191+
192+
- Security Identifier (objectSid)
193+
- Example: S-1-5-21-3165297888-301567370-576410423-1103
194+
195+
- Name
196+
- Example: Recycle Bin Feature

0 commit comments

Comments
 (0)