Skip to content

Latest commit

 

History

History
122 lines (96 loc) · 2.71 KB

AddsWaitForDomains.adoc

File metadata and controls

122 lines (96 loc) · 2.71 KB

DSC Resource 'AddsWaitForDomains'

AddsWaitForDomains waits for a domain to be available.

Source

DSC Resource

Documentation

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

Domains

Hashtable[]

List of domains to wait for.

Table 2. Selected Attributes of category 'AddsWaitForDomains/Domains'
Parameter Attribute DataType Description Allowed Values

DomainName

Key

String

Specifies the fully qualified domain name to wait for.

SiteName

String

Specifies the site in the domain where to look for a domain controller.

Credential

PSCredential

Specifies the credentials that are used when accessing the domain, unless the built-in PsDscRunAsCredential is used.

WaitTimeout

UInt64

SpecifSpecifies the timeout in seconds that the resource will wait for the domain to be accessible.

Default: 300

RestartCount

UInt32

Specifies the number of times the node will be reboot in an effort to connect to the domain.

WaitForValidCredentials

Boolean

Specifies that the resource will not throw an error if authentication fails using the provided credentials and continue wait for the timeout. This can be used if the credentials are known to eventually exist but there are a potential timing issue before they are accessible.

Example
AddsWaitForDomains:
  Domains:
  - DomainName: contoso.com
    SiteName: Default-First-Site-Name
    WaitTimeout: 300
    RestartCount: 0
  - DomainName: tailspintoys.com
    SiteName: Default-First-Site-Name
    WaitTimeout: 300
    RestartCount: 0
Recommended Lookup Options in Datum.yml (Excerpt)
lookup_options:

  AddsWaitForDomains:
    merge_hash: deep
  AddsWaitForDomains\Domains:
    merge_hash_array: UniqueKeyValTuples
    merge_options:
      tuple_keys:
        - DomainName