Skip to content

Latest commit

 

History

History
154 lines (123 loc) · 3.38 KB

AddsSitesSubnets.adoc

File metadata and controls

154 lines (123 loc) · 3.38 KB

DSC Resource 'AddsSitesSubnets'

AddsSitesSubnets manages Replication Sites and Replication Subnets within Active Directory

Source

DSC Resource

Documentation

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

Sites

Hashtable[]

List of Replication Sites within Active Directory

Subnets

Hashtable[]

List of Replication Subnets within Active Directory

Table 2. Attributes of category 'AddsSitesSubnets/Sites'
Parameter Attribute DataType Description Allowed Values

Name

Mandatory

String

Specifies the name of the Active Directory replication site.

Ensure

String

Specifies if the Active Directory replication site should be present or absent.

  • Present (default)

  • Absent

RenameDefaultFirstSiteName

Boolean

Specifies if the Default-First-Site-Name should be renamed if it exists.

  • True

  • False (default)

Description

String

Specifies a description of the object.

This parameter sets the value of the Description property for the object. The LDAP Display Name (ldapDisplayName) for this property is 'description'.

Table 3. Attributes of category 'AddsSitesSubnets/Subnets'
Parameter Attribute DataType Description Allowed Values

Name

Mandatory

String

The name of the Active Directory replication subnet, e.g. 10.0.0.0/24.

Site

Mandatory

String

The name of the assigned Active Directory replication site, e.g. Default-First-Site-Name.

Ensure

String

Specifies if the Active Directory replication subnet should be present or absent.

  • Present (default)

  • Absent

Location

String

The location for the Active Directory replication site.

Default value is empty ('') location.

Description

String

Specifies a description of the object.

This parameter sets the value of the Description property for the object.

Example
AddsSitesSubnets:
  Sites:
    - Name: Sparta
      RenameDefaultFirstSiteName: true
    - Name: Athens
  Subnets:
    - Name: 10.0.1.0/24
      Site: Sparta
      Location: Sparta
    - Name: 10.0.2.0/24
      Site: Athens
      Location: Sparta