Resource Type: dsc_xuser

Defined in:

lib/puppet/type/dsc_xuser.rb

Providers:

powershell

Overview

The DSC xUser resource type. Automatically generated from ‘xPSDesiredStateConfiguration/DSCResources/MSFT_xUserResource/MSFT_xUserResource.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_description

  Description - A description for the user

• dsc_disabled

  Disabled - Value used to disable/enable a user account

  Supported values:

  • true
  • false
• dsc_ensure

  Ensure - An enumerated value that describes if the user is expected to exist on the machine Valid values are Present, Absent.

• dsc_fullname

  FullName - The display name of the user

• dsc_password

  Password - The password for the user

• dsc_passwordchangenotallowed

  PasswordChangeNotAllowed - Value used to set whether a user can/cannot change their password

  Supported values:

  • true
  • false
• dsc_passwordchangerequired

  PasswordChangeRequired - Value used to require a user to change their password

  Supported values:

  • true
  • false
• dsc_passwordneverexpires

  PasswordNeverExpires - Value used to set whether a user’s password expires or not

  Supported values:

  • true
  • false
• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_username

  UserName - The name of the User to Create/Modify/Delete

• name (namevar)
• provider

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