|
|
| Line 1: |
Line 1: |
| − | {{bluebanner|[[Main_Page|Home]] > [[Administration]] > [[IT_Operations_Management|IT Operations Management]] > [[ITOM_Package_Library|ITOM Package Library]] > Linux User Management |[[:Category:ITOM|Index]]}}
| + | This document can now be found at its new location in the [https://docs.hornbill.com/itom-packages/welcome Hornbill Document Library]. |
| − | [[File:Tux.svg.png|300px]]
| |
| − | {{IntroAndLinks|A collection of operations to manage Linux User accounts
| |
| − | |
| |
| − | <!-- Related Links go here -->
| |
| − | :* [[IT_Operations_Management|IT Operations Management]]
| |
| − | :* [[Business_Process_Designer|Business Process Designer]]
| |
| − | :* [[Hornbill_KeySafe|KeySafe]]
| |
| − | }}
| |
| | | | |
| − | ==Target Environment Requirements==
| + | [[file:hornbill-document-library.png|ITOM Package Reference|link=https://docs.hornbill.com/itom-packages/welcome]] |
| − | | |
| − | === Credentials ===
| |
| − | | |
| − | Except for the Is Package Installed operation, Accounts used when executing jobs against operations contained within this package must adhere to the following requirements:
| |
| − | | |
| − | * The target machine must have a local admin user that will be used for running the operations;
| |
| − | * SSH Remote Login must be enabled for the user above user
| |
| − | * Configuration for the user must be added to the sudoers file on the target machine, to allow the above user to sudo without a password (example: __someadminuser ALL = (ALL) NOPASSWD:ALL__).
| |
| − | | |
| − | ==KeySafe Configuration==
| |
| − | [[File:itomtarget_keysafe.png|300px|right]] | |
| − | | |
| − | When creating SIS jobs for operations contained within this package, they need to be run on the target machine as a user who has the correct privileges on the target.
| |
| − | | |
| − | To configure your '''Target Machine''' account authentication in '''[[Hornbill_KeySafe|KeySafe]]''':
| |
| − | | |
| − | * In the Admin console, navigate to: System > Security > KeySafe;
| |
| − | * Click on + then select <code>Username + Password</code>;
| |
| − | * Give the KeySafe Key a Title (this is the name/identifier for the target machine account as you will see it when creating an IT Automation Job, or adding an IT Automation node to a Business Process or Runbook);
| |
| − | * Optionally add a description;
| |
| − | * Populate the Username field with the domain/local account username for the account being used on the target machine;
| |
| − | * Populate the Password field with the password for the above account;
| |
| − | * Select Create Key to save.
| |
| − | | |
| − | Once you have created your KeySafe Key, you can then use it when creating IT Automation Jobs from this package. See screenshots to the right for examples.
| |
| − | | |
| − | ==Package Operations==
| |
| − | | |
| − | The Linux User Management package contains the following operations, than can be used to create ITOM Jobs directly, or included in your [[Business_Process_Designer|Business Processes]] and/or IT Operations Management Runbooks.
| |
| − | | |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Create User===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Creates a Linux user account using the adduser command
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>username</code> '''MANDATORY''' -
| |
| − | * <code>createHomeDirectory</code> '''MANDATORY''' -
| |
| − | * <code>password</code> -
| |
| − | * <code>comment</code> -
| |
| − | * <code>loginShell</code> -
| |
| − | * <code>expiryDate</code> -
| |
| − | * <code>primaryGroup</code> -
| |
| − | * <code>SupplementaryGroups</code> -
| |
| − | * <code>homeDirectoryLocation</code> -
| |
| − | * <code>Cipher</code> -
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>Username</code>
| |
| − | * <code>UserId</code>
| |
| − | * <code>Comment</code>
| |
| − | * <code>HomeDirectory</code>
| |
| − | * <code>Groups</code>
| |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Delete User===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Delate a Linux user account and optionally the user home folder and files. This operation uses the userdel command
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>username</code> '''MANDATORY''' - Username
| |
| − | * <code>RemoveFiles</code> '''MANDATORY''' - Force the removal of files
| |
| − | * <code>RemoveHome</code> '''MANDATORY''' - Remove home directory and mail spool
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===User Details===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Retrieve a user details from the passwd file
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>username</code> '''MANDATORY''' -
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>UserName</code>
| |
| − | * <code>UserId</code>
| |
| − | * <code>GroupId</code>
| |
| − | * <code>Comment</code>
| |
| − | * <code>HomeDirectory</code>
| |
| − | * <code>Shell</code>
| |
| − | * <code>SupplementaryGroups</code>
| |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Lock User===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Lock a users account using the usermod command
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>username</code> '''MANDATORY''' -
| |
| − | | |
| − | ====Output Parameters====
| |
| − | No output parameters
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Unlock User===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Unlock a users account using the usermod command
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>username</code> '''MANDATORY''' -
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Modify User===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Modify user account details using the usermod command
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>username</code> '''MANDATORY''' - User login name
| |
| − | * <code>MoveDir</code> '''MANDATORY''' - Move the contents of the home directory to the new location: HomeDirectory
| |
| − | * <code>HomeDirectory</code> - Absolute Path to new Home Directory
| |
| − | * <code>Password</code> - Users new password
| |
| − | * <code>Comment</code> - GCEOS field
| |
| − | * <code>LoginShell</code> - Specifies the users login shell
| |
| − | * <code>GroupName</code> - New Primary Group name
| |
| − | * <code>SuppGroupNames</code> - Comma Separated list of group names
| |
| − | * <code>AccountExpiry</code> - Expiry date format = yyyy-mm-dd
| |
| − | * <code>ExpiryDays</code> - Number of days after password expiry until the account is disabled.
| |
| − | * <code>NewLoginName</code> - Sets a new user name for the account
| |
| − | * <code>UserId</code> - Sets new User ID for the user account
| |
| − | * <code>Cipher</code> -
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>Username</code>
| |
| − | * <code>UserId</code>
| |
| − | * <code>Comment</code>
| |
| − | * <code>HomeDirectory</code>
| |
| − | * <code>Groups</code>
| |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | | |
| − | [[Category:ITOM]]
| |
