Class AutomateIt::AccountManager
In: lib/automateit/account_manager.rb
Parent: AutomateIt::Plugin::Manager

AccountManager

The AccountManager provides a way of managing system accounts, such as Unix users and groups.

Methods

add_group   add_groups_to_user   add_user   add_users_to_group   groups   groups_for_user   has_group?   has_user?   invalidate   passwd   remove_group   remove_groups_from_user   remove_user   remove_users_from_group   users   users_for_group   users_to_groups  

Classes and Modules

Class AutomateIt::AccountManager::BaseDriver
Class AutomateIt::AccountManager::Etc
Class AutomateIt::AccountManager::NSCD
Class AutomateIt::AccountManager::POSIX
Class AutomateIt::AccountManager::PasswdExpect
Class AutomateIt::AccountManager::PasswdPTY

Public Instance methods

add_group(groupname, opts={})

Add groupname if it doesn‘t exist. Options:

  • :members — Array of usernames to add as members.
  • :gid — Group ID to use. Default is to find an unused id.
add_groups_to_user(groups, user)

Add groups (array of groupnames) to user.

add_user(username, opts={})

Add the username if not already created.

Options:

  • :description — User‘s full name. Defaults to username.
  • :home — Path to user‘s home directory. If not specified, uses system default like "/home/username".
  • :create_home — Create homedir. Defaults to true.
  • :groups — Array of group names to add this user to.
  • :shell — Path to login shell. If not specified, uses system default like "/bin/bash".
  • :uid — Fixnum user ID for user. Default chooses an unused id.
  • :gid — Fixnum group ID for user. Default chooses same gid as uid.

Example: 

  add_user("bob", :description => "Bob Smith")
add_users_to_group(users, group)

Add users (array of usernames) to group.

groups()

Find a group. Method returns a query helper which takes a groupname as an index argument and returns a Struct::Group entry as described in Etc::getgrent if the group exists or a nil if not.

Example: 

  groups["root"] # => #<struct Struct::Group name="root"...

  groups["does_not_exist"] # => nil
groups_for_user(query)

Array of groupnames this user is a member of.

has_group?(group)

Does group exist?

has_user?(user)

Is user present?

invalidate(database)

Invalidate system cache for database. The database can be either :users or :groups. This is necessary on operating systems that lack logic to notify their caching system that an entry changed. If the OS doesn‘t need invalidation, will do nothing and return false.

This method is primarily for the sake of driver authors, recipe authors will probably never need to use this.

passwd(user, password, opts={})

Change the password for the user.

remove_group(groupname, opts={})

Remove groupname if it exists.

remove_groups_from_user(groups, user)

Remove groups (array of groupnames) from user.

remove_user(username, opts={})

Remove the username if present.

Options:

  • :remove_home — Delete user‘s home directory and mail spool. Default is true.
remove_users_from_group(users, group)

Remove users (array of usernames) from group.

users()

Find a user account. Method returns a query helper which takes a username as an index argument and returns a Struct::Passwd entry as described in Etc::getpwent if the user exists or a nil if not.

Example: 

  users["root"] # => #<struct Struct::Passwd name="root"...

  users["does_not_exist"] # => nil
users_for_group(query)

Array of usernames in group.

users_to_groups()

Hash of usernames and the groupnames they‘re members of.

[Validate]