Resource Type: dsc_xaduser

Defined in:

lib/puppet/type/dsc_xaduser.rb

Providers:

powershell

Overview

The DSC xADUser resource type. Automatically generated from ‘xActiveDirectory/DSCResources/MSFT_xADUser/MSFT_xADUser.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

• ensure

  The basic property that the resource should be in.

  Supported values:

  • exists?
  • present
  • absent

Parameters

• dsc_cannotchangepassword

  CannotChangePassword - Specifies whether the account password can be changed

  Supported values:

  • true
  • false
• dsc_city

  City - Specifies the user’s town or city (ldapDisplayName ‘l’)

• dsc_commonname

  CommonName - Specifies the common nane assigned to the user account (ldapDisplayName ‘cn’)

• dsc_company

  Company - Specifies the user’s company (ldapDisplayName ‘company’)

• dsc_country

  Country - Specifies the country or region code for the user’s language of choice (ldapDisplayName ‘c’)

• dsc_department

  Department - Specifies the user’s department (ldapDisplayName ‘department’)

• dsc_description

  Description - Specifies a description of the object (ldapDisplayName ‘description’)

• dsc_displayname

  DisplayName - Specifies the display name of the object (ldapDisplayName ‘displayName’)

• dsc_distinguishedname

  DistinguishedName - Returns the X.500 path of the object

• dsc_division

  Division - Specifies the user’s division (ldapDisplayName ‘division’)

• dsc_domainadministratorcredential

  DomainAdministratorCredential - Specifies the user account credentials to use to perform this task

• dsc_domaincontroller

  DomainController - Specifies the Active Directory Domain Services instance to use to perform the task.

• dsc_domainname

  DomainName - Name of the domain where the user account is located (only used if password is managed)

• dsc_emailaddress

  EmailAddress - Specifies the user’s e-mail address (ldapDisplayName ‘mail’)

• dsc_employeeid

  EmployeeID - Specifies the user’s employee ID (ldapDisplayName ‘employeeID’)

• dsc_employeenumber

  EmployeeNumber - Specifies the user’s employee number (ldapDisplayName ‘employeeNumber’)

• dsc_enabled

  Enabled - Specifies if the account is enabled (default True)

  Supported values:

  • true
  • false
• dsc_ensure

  Ensure - Specifies whether the user account is created or deleted Valid values are Present, Absent.

• dsc_fax

  Fax - Specifies the user’s fax phone number (ldapDisplayName ‘facsimileTelephoneNumber’)

• dsc_givenname

  GivenName - Specifies the user’s given name (ldapDisplayName ‘givenName’)

• dsc_homedirectory

  HomeDirectory - Specifies a user’s home directory path (ldapDisplayName ‘homeDirectory’)

• dsc_homedrive

  HomeDrive - Specifies a drive that is associated with the UNC path defined by the HomeDirectory property (ldapDisplayName ‘homeDrive’)

• dsc_homepage

  HomePage - Specifies the URL of the home page of the object (ldapDisplayName ‘wWWHomePage’)

• dsc_homephone

  HomePhone - Specifies the user’s home telephone number (ldapDisplayName ‘homePhone’)

• dsc_initials

  Initials - Specifies the initials that represent part of a user’s name (ldapDisplayName ‘initials’)

• dsc_ipphone

  IPPhone - Specifies the user’s IP telephony phone number (ldapDisplayName ‘ipPhone’)

• dsc_jobtitle

  JobTitle - Specifies the user’s title (ldapDisplayName ‘title’)

• dsc_logonscript

  LogonScript - Specifies a path to the user’s log on script (ldapDisplayName ‘scriptPath’)

• dsc_manager

  Manager - Specifies the user’s manager specified as a Distinguished Name (ldapDisplayName ‘manager’)

• dsc_mobilephone

  MobilePhone - Specifies the user’s mobile phone number (ldapDisplayName ‘mobile’)

• dsc_notes

  Notes - Specifies the notes attached to the user’s accoutn (ldapDisplayName ‘info’)

• dsc_office

  Office - Specifies the location of the user’s office or place of business (ldapDisplayName ‘physicalDeliveryOfficeName’)

• dsc_officephone

  OfficePhone - Specifies the user’s office telephone number (ldapDisplayName ‘telephoneNumber’)

• dsc_pager

  Pager - Specifies the user’s pager number (ldapDisplayName ‘pager’)

• dsc_password

  Password - Specifies a new password value for the account

• dsc_passwordauthentication

  PasswordAuthentication - Specifies the authentication context type used when testing passwords Valid values are Default, Negotiate.

• dsc_passwordneverexpires

  PasswordNeverExpires - Specifies whether the password of an account can expire

  Supported values:

  • true
  • false
• dsc_path

  Path - Specifies the X.500 path of the Organizational Unit (OU) or container where the new object is created

• dsc_pobox

  POBox - Specifies the user’s post office box number (ldapDisplayName ‘postOfficeBox’)

• dsc_postalcode

  PostalCode - Specifies the user’s postal code or zip code (ldapDisplayName ‘postalCode’)

• dsc_profilepath

  ProfilePath - Specifies a path to the user’s profile (ldapDisplayName ‘profilePath’)

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_state

  State - Specifies the user’s or Organizational Unit’s state or province (ldapDisplayName ‘st’)

• dsc_streetaddress

  StreetAddress - Specifies the user’s street address (ldapDisplayName ‘streetAddress’)

• dsc_surname

  Surname - Specifies the user’s last name or surname (ldapDisplayName ‘sn’)

• dsc_username

  UserName - Specifies the Security Account Manager (SAM) account name of the user (ldapDisplayName ‘sAMAccountName’)

• dsc_userprincipalname

  UserPrincipalName - Specifies the UPN assigned to the user account (ldapDisplayName ‘userPrincipalName’)

• name (namevar)
• provider

  The specific backend to use for this ‘dsc_xaduser` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.