Difference between revisions of "Linux Group Management"

From Hornbill
Jump to navigation Jump to search
(Replaced content with "This document can now be found at its new location in the [https://docs.hornbill.com/itom-packages/welcome Hornbill Document Library]. file:hornbill-document-librar...")
Tag: Replaced
Line 1: Line 1:
{{bluebanner|[[Main_Page|Home]] > [[Administration]] > [[IT_Operations_Management|IT Operations Management]] > [[ITOM_Package_Library|ITOM Package Library]] > Linux Group 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|Provides operations that allow for the management of Linux groups
 
|
 
<!-- 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 Group 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">
 
===Group Details===
 
<div class="mw-collapsible-content">
 
Retrieves the name, id and number of members for the specified group. The group can be entered by either using its name or GID. This operation does not require root access
 
 
 
====Input Parameters====
 
 
 
* <code>GroupName</code> - Group name or ID
 
 
 
====Output Parameters====
 
 
 
* <code>GroupName</code> 
 
* <code>GroupId</code> 
 
* <code>NoOfMembers</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">
 
===Create Group===
 
<div class="mw-collapsible-content">
 
Add a new group using the groupadd command
 
 
 
====Input Parameters====
 
 
 
* <code>GroupName</code> '''MANDATORY''' - Name of the group to create
 
* <code>GroupID</code> - Specify the group ID
 
* <code>SuppressErrors</code> '''MANDATORY''' - Suppress the error message if group already exists
 
* <code>NonUniqueID</code> '''MANDATORY''' - Allows the creation of a group with a non-unique GID
 
* <code>SystemGroup</code> '''MANDATORY''' - Create a system group
 
 
 
====Output Parameters====
 
 
 
* <code>GroupName</code> 
 
* <code>GroupId</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 Group===
 
<div class="mw-collapsible-content">
 
Delete a group  using the groupdel command
 
 
 
====Input Parameters====
 
 
 
* <code>GroupName</code> '''MANDATORY''' - Group name
 
* <code>Force</code> - Force the removal of the group
 
 
 
====Output Parameters====
 
 
 
* <code>outcome</code> '''MANDATORY'''  The outcome of the operation (OK/FAIL) 
 
* <code>errors</code>  Any errors returned by the operation 
 
 
 
</div></div>
 
 
 
[[Category:ITOM]]
 

Revision as of 14:50, 12 February 2024

This document can now be found at its new location in the Hornbill Document Library.

   ITOM Package Reference