domain_membership

Manage Active Directory domain membership with this module.

Parameters

• domain - AD domain which the node should be a member of.
• username - User with ability to join machines to a Domain.
• password - Password for domain joining user.
• machine_ou - [Optional] OU in the directory for the machine account to be created in.
• resetpw - [Optional] Whether or not to force machine password reset if it becomes out of sync with the domain.
• reboot - [Optional] Whether or not to reboot when the machine joins the domain. (reboot by default)
• reboot_apply - [Optional] If reboot is true, this controls the apply parameter. (defaults to 'finished')
• join_options - [Optional] A bit field for options to use when joining the domain. See http://msdn.microsoft.com/en-us/library/aa392154(v=vs.85).aspx Defaults to '1' (default domain join).
• user_domain - [Optional] Domain of user account used to join machine, if different from domain machine will be joined to. If not specified, the value passed to the domain parameter will be used.

Usage

At the core, this module is invoking powershell to grab a Win32_ComputerSystem WMI object to call JoinDomainOrWorkgroup for the domain joining action. This method of domain joining is fully documented here.

To use the domain_membership class, you will need to pass three required parameters. The required parameters are domain, username, and password. See the parameter descriptions above for more information.

The method of domain joining is dictated by the join_option parameter. This parameter is expecting a bit mask to indicate the various options that will be used. The available options are described as part of the documentation linked above. The value is passed as an integer. By default, this module is using an integer value of '1' for the option. This translets simply to only using the "JOIN_DOMAIN" option which does not imply the creation of the machine account. To have at least a machine account created as part of the join, option '3' should be used. Overall, one should consult the MSDN document and determine the best combination of settings for their objective.

Example

class { 'domain_membership':
  domain       => 'puppet.example',
  username     => 'joinmember',
  password     => 'sUp3r_s3cR3t!',
  join_options => '3',
}

Contact

If you have questions or concerns about this module, email me at [email protected]

Changelog

• Thomas Linkin [email protected] -- Update puppetlabs/reboot dependency
• Thomas Linkin [email protected] -- Extend README documentation
• Thomas Linkin [email protected] -- Cleanup documentation formatting
• Thomas Linkin [email protected] -- Bump release to 1.1.1
• Thomas Linkin [email protected] -- Remove pkg directory, dammit
• Thomas Linkin [email protected] -- Bump to 1.1.0 release
• Thomas Linkin [email protected] -- Fix variable usage in interpolated string
• Thomas Linkin [email protected] -- Fix issues with metadata.json
• Alex Harden [email protected] -- Added a user_domain option.
• Wout van Heeswijk [email protected] -- Added a reboot option
• Ben Ford [email protected] -- Use the join return value for success
• Thomas Linkin [email protected] -- Update module dependancy
• Thomas Linkin [email protected] -- Move license to LICENSE file to conform with Forge rules.
• Thomas Linkin [email protected] -- Correct some rubbish typos in the docs
• Thomas Linkin [email protected] -- Bunp version to 1.0.0 for release
• Thomas Linkin [email protected] -- Converting to metadata.json
• Thomas Linkin [email protected] -- Clean up fjoinoptions parameter
• Thomas Linkin [email protected] -- Remove false parameter in favor of fjoinoption
• Thomas Linkin [email protected] -- Merge remote-tracking branch 'beard/fjoinoption'
• Thomas Linkin [email protected] -- Merge pull request #2 from ghoneycutt/patch-1
• Josh Beard [email protected] -- Fix alignment of parameter list in README
• Josh Beard [email protected] -- Add 'fjoinoption' as a parameter
• Garrett Honeycutt [email protected] -- Update README.md
• Thomas Linkin [email protected] -- Fill out docs further
• Thomas Linkin [email protected] -- Add $resetpw parameter
• Thomas Linkin [email protected] -- Readme content added
• Thomas Linkin [email protected] -- Ensure resource relationships
• Thomas Linkin [email protected] -- Reset Computer Account Password
• Thomas Linkin [email protected] -- Initial Commit

Support

Please log tickets and issues at our Projects site