Skip to content

Latest commit

 

History

History
170 lines (139 loc) · 3.63 KB

AddsOrgUnitsAndGroups.adoc

File metadata and controls

170 lines (139 loc) · 3.63 KB

DSC Resource 'AddsOrgUnitsAndGroups'

AddsOrgUnitsAndGroups adds Groups and Organizational Units to an existing Domain.

Requires [dscyml_addsdomain_domainname]

Source

DSC Resource

Documentation

Table 1. Attributes of category 'AddsOrgUnitsAndGroups'
Parameter Attribute DataType Description Allowed Values

OrgUnits

Object[]

List of Organizational Units (OUs) within Active Directory

Groups

Object[]

List of groups within Active Directory.
Requires [dscyml_addsdomain_domaindn]

Table 2. Selected Attributes of category 'AddsOrgUnitsAndGroups/OrgUnits'
Parameter Attribute DataType Description Allowed Values

Name

Key

String

The name of the Organizational Unit (OU).

Path

Key

String

The name of the Organizational Unit (OU).

ChildOu

Object[]

List of Child Organizational Units.
For each Child OU the parameter Name must be specified.

Table 3. Selected Attributes of category 'AddsOrgUnitsAndGroups/Groups' - see ADGroup for more
Parameter Attribute DataType Description Allowed Values

GroupName

Key

String

Name of the Active Directory group.

GroupScope

String

Active Directory group scope.

  • DomainLocal

  • Global (default)

  • Universal (ignored)

Category

String

Active Directory group category.

  • Distribution

  • Security (default)

Path

String

Location of the group within Active Directory expressed as a Distinguished Name (DN).

Ensure

String

Specifies if this Active Directory group should be present or absent.

  • Absent

  • Present (default)

Example
AddsOrgUnitsAndGroups:
  OrgUnits:
    - Name: Admin
      Path: DC=contoso,DC=com
      ChildOu:
        - Name: Groups
        - Name: Computers
  Groups:
    - GroupName: App_123_Read
      Path: OU=Groups,OU=Admin
      GroupScope: DomainLocal
    - GroupName: App_123_Write
      Path: OU=Groups,OU=Admin
      GroupScope: Global
Recommended Lookup Options in Datum.yml (Excerpt)
lookup_options:

  AddsOrgUnitsAndGroups:
    merge_hash: deep
  AddsOrgUnitsAndGroups\OrgUnits:
    merge_baseType_array: Unique
    merge_hash_array: DeepTuple
    merge_options:
      tuple_keys:
        - Name
        - Path
  AddsOrgUnitsAndGroups\Groups:
    merge_baseType_array: Unique
    merge_hash_array: DeepTuple
    merge_options:
      tuple_keys:
        - GroupName