Resource Type: dsc_adcomputer

Defined in:
lib/puppet/type/dsc_adcomputer.rb

Overview

The DSC ADComputer resource type. Automatically generated from version 6.4.0

Properties

  • dsc_description

    Specifies a description of the computer account.

  • dsc_displayname

    Specifies the display name of the computer account.

  • dsc_distinguishedname

    Returns the X.500 path of the computer object.

  • dsc_dnshostname

    Specifies the fully qualified domain name (FQDN) of the computer account.

  • dsc_domaincontroller

    Specifies the Active Directory Domain Services instance to connect to perform the task.

  • dsc_enabled

    Returns $true if the computer object is enabled, otherwise it returns $false.

  • dsc_enabledoncreation

    Specifies if the computer account is created enabled or disabled. By default the Enabled property of the computer account will be set to the default value of the cmdlet New-ADComputer. This property is ignored if the parameter RequestFile is specified in the same configuration. This parameter does not enforce the property Enabled. To enforce the property Enabled see the resource ADObjectEnabledState.

  • dsc_ensure

    Specifies whether the computer account is present or absent. Default value is ‘Present’.

  • dsc_location

    Specifies the location of the computer, such as an office number.

  • dsc_manager

    Specifies the user or group Distinguished Name that manages the computer account. Valid values are the user’s or group’s DistinguishedName, ObjectGUID, SID or SamAccountName.

  • dsc_path

    Specifies the X.500 path of the Organizational Unit (OU) or container where the computer is located.

  • dsc_requestfile

    Specifies the full path to the Offline Domain Join Request file to create.

  • dsc_restorefromrecyclebin

    Try to restore the computer account from the recycle bin before creating a new one.

  • dsc_samaccountname

    Returns the SAM account name of the computer object.

  • dsc_serviceprincipalnames

    Specifies the service principal names for the computer account.

  • dsc_sid

    Returns the security identifier of the computer object.

  • dsc_userprincipalname

    Specifies the User Principal Name (UPN) assigned to the computer account.

Parameters

  • dsc_computername (namevar)

    Specifies the name of the Active Directory computer account to manage. You can identify a computer by its distinguished name, GUID, security identifier (SID) or Security Accounts Manager (SAM) account name.

  • dsc_credential

    Specifies the user account credentials to use to perform the task.

  • dsc_psdscrunascredential
  • name (namevar)

    Description of the purpose for this resource declaration.

  • validation_mode (defaults to: property)

    Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).