|
|
| Line 1: |
Line 1: |
| − | {{bluebanner|[[Main_Page|Home]] > [[Administration]] > [[IT_Operations_Management|IT Operations Management]] > [[ITOM_Package_Library|ITOM Package Library]] >Ansible |[[: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:Ansible-logo.png|x170px]]
| |
| − | {{IntroAndLinks|A collection of operations to enable the automation of management of Ansible playbooks, inventories and hosts from Hornbill workflows.
| |
| − | |
| |
| − | <!-- 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 ===
| |
| − | | |
| − | Accounts used when executing jobs against operations contained within this package must adhere to the following requirements:
| |
| − | | |
| − | * No additional credentials are required. All authentication is provided though KeySafe on job creation.
| |
| − | | |
| − | ==KeySafe Configuration==
| |
| − | [[File:checkmk_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 Ansible 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">
| |
| − | ===Run Playbook===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will execute a playbook within Ansible.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>inventoryPath</code> '''MANDATORY''' - Format /file-path/file-path
| |
| − | * <code>playbookPath</code> '''MANDATORY''' - Format /file-path/file-path
| |
| − | | |
| − | ====Output Parameters====
| |
| − | * <code>playbookResponse</code> The response from executing the specific playbook action.
| |
| − | * <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">
| |
| − | ===List Playbooks===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation lists the contents of a playbook.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>NewUser</code> '''MANDATORY''' - Format /file-path/file-path
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>playbookList</code> The contents of the playbook selected
| |
| − | * <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 Inventory===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Create an Inventory or Host group Text file.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>fileName</code> '''MANDATORY''' - Format /file-path/file-path
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>fileName</code> The Created File Name
| |
| − | * <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">
| |
| − | ===List Inventory===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This function will list the contents of an Playbook, Inventory or collection of host servers.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>inventoryPath</code> '''MANDATORY''' - Format: /file-name/file-name
| |
| − | | |
| − | ====Output Parameters====
| |
| − | * <code>inventoryList</code> The returned response from the list
| |
| − | * <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">
| |
| − | ===Remove Inventory===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Removes an Playbook, Inventory or Host file from Ansible.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>inventoryPath</code> '''MANDATORY''' - Format /file-path/file-path
| |
| − | | |
| − | ====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">
| |
| − | ===Create A Host Group===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Creates a host group within the designated file.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>hostFileName</code> '''MANDATORY''' - The path to the file that holds the specified Host Group. - Format /file-path/file-path
| |
| − | * <code>hostGroupName</code> '''MANDATORY''' - The desired Host Group name that you would like to create.
| |
| − | * <code>hostName</code> '''MANDATORY''' - The IP address or name of the server you would like to add.
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>fileName</code> The Successfully created Host Group Name
| |
| − | * <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">
| |
| − | ===List Host Groups===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Displays all the Hosts Group titles within an inventory or host file.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>hostGroupPath</code> '''MANDATORY''' - The folder path to the Inventory / Host file that you would like to search for Host Groups within.
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>HostGroup</code>
| |
| − | * <code>outcome</code> 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">
| |
| − | ===Remove A Host Group===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Removes a host group and all hosts stored within it from an inventory or host file.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>fileName</code> '''MANDATORY''' - Please do not use any blank spaces - Format /file-path/file-path
| |
| − | * <code>hostGroupName</code> '''MANDATORY''' - Please do not use any blank spaces, provide the Host Group you would like to remove.
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | *<code>filePath</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 A Host===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Creates an instance of a host within the designated host group and inventory / host file.
| |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>fileName</code> '''MANDATORY''' - The Path to the Inventory or Host file that holds the Host Group you would like to place the Host within. Format: /file-name/file-name
| |
| − | * <code>hostGroupName</code> '''MANDATORY''' - The Name of the Host Group you would like to place the Host within.
| |
| − | * <code>hostName</code> '''MANDATORY''' - The name or IP address of the Host
| |
| − | | |
| − | ====Output Parameters====
| |
| − |
| |
| − | * <code>fileName</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">
| |
| − | ===Remove A Host From A Host Group===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Removes the specified host from a host group.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>fileName</code> '''MANDATORY''' - Please do not use any blank spaces - Format /file-path/file-path
| |
| − | * <code>hostGroupName</code> '''MANDATORY''' - Please do not use any blank spaces, provide the Host Group you would like to remove the Host from
| |
| − | * <code>hostName</code> '''MANDATORY''' - Please do not use any blank spaces, The name or IP address of the Host you would like removed.
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | *<code>fileName</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]]
| |
