|
|
| (3 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| − | {{bluebanner|[[Main_Page|Home]] > [[Administration]] > [[IT_Operations_Management|IT Operations Management]] > [[ITOM_Package_Library|ITOM Package Library]] > Debian Service Management (systemd) |[[: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 to control and manage the state of services using the "systemd" tool; systemctl.
| |
| | | | |
| − | |
| + | [[file:hornbill-document-library.png|ITOM Package Reference|link=https://docs.hornbill.com/itom-packages/welcome]] |
| − | <!-- Related Links go here -->
| + | [[Category:HDOC]] |
| − | :* [[IT_Operations_Management|IT Operations Management]]
| |
| − | :* [[Business_Process_Designer|Business Process Designer]]
| |
| − | :* [[Hornbill_KeySafe|KeySafe]]
| |
| − | }}
| |
| − | | |
| − | ==Target Environment Requirements==
| |
| − | | |
| − | === 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 Debian Service Management (systemd) 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">
| |
| − | ===Start===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will start a service using systemctl on a Linux device.
| |
| − | | |
| − | ==== Extra Credentials ====
| |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>service</code> '''MANDATORY''' - Name of service to start
| |
| − | | |
| − | ====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">
| |
| − | ===Stop===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will stop service using systemctl on a Linux device.
| |
| − | | |
| − | ==== Extra Credentials ====
| |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>service</code> '''MANDATORY''' - Name of service to stop
| |
| − | | |
| − | ====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">
| |
| − | ===Restart===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will restart a service using systemctl on a Linux device.
| |
| − | | |
| − | ==== Extra Credentials ====
| |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>service</code> '''MANDATORY''' - Name of service to restart
| |
| − | | |
| − | ====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">
| |
| − | ===Reload===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will reload a services config using systemctl on a Linux device, if the service has the .
| |
| − | | |
| − | ==== Extra Credentials ====
| |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>service</code> '''MANDATORY''' - Name of service to reload config
| |
| − | | |
| − | ====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">
| |
| − | ===Enable===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will enable a service using systemctl on a Linux device.
| |
| − | | |
| − | ==== Extra Credentials ====
| |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>service</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">
| |
| − | ===disable===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will disable a service using systemctl on a Linux device.
| |
| − | | |
| − | ==== Extra Credentials ====
| |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>service</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">
| |
| − | ===Is Active===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will verify if a service is active using systemctl on a Linux device. Returns outcome of OK if the service is active, and FAIL for all other states
| |
| − | | |
| − | ==== Extra Credentials ====
| |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>service</code> '''MANDATORY''' - Name of service to verify as active
| |
| − | | |
| − | ====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">
| |
| − | ===Is Enabled===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will verify if a service is enabled using systemctl on a Linux device. Returns outcome of OK if the service is active, and FAIL for all other states
| |
| − | | |
| − | ==== Extra Credentials ====
| |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>service</code> '''MANDATORY''' - Name of service to verify as enabled
| |
| − | | |
| − | ====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">
| |
| − | ===Is Failed===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will verify if a service has failed using systemctl on a Linux device. Returns outcome of OK if the service has failed, and FAIL for all other states
| |
| − | | |
| − | ==== Extra Credentials ====
| |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>service</code> '''MANDATORY''' - Name of service to verify as failed
| |
| − | | |
| − | ====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]] | |
