|
|
| (One intermediate revision by one other user not shown) |
| Line 1: |
Line 1: |
| − | {{bluebanner|[[Main_Page|Home]] > [[Administration]] > [[IT_Operations_Management|IT Operations Management]] > [[ITOM_Package_Library|ITOM Package Library]] > macOS 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:macos_logo.png|300px]]
| |
| − | {{IntroAndLinks|A collection of operations to manage macOS devices.
| |
| − | |
| |
| − | <!-- 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]] |
| − | | + | [[Category:HDOC]] |
| − | === Credentials ===
| |
| − | | |
| − | 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;
| |
| − | * Remote Login must be enabled for the user above user (System Preferences > Sharing > Remote Login);
| |
| − | * 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 macOS 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 Rubooks.
| |
| − | | |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===User - Create===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will create a new local user account on a macOS device.
| |
| − | | |
| − | ==== Extra Credentials ====
| |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>UserName</code> '''MANDATORY''' - The login username for the new user
| |
| − | * <code>UserRealName</code> '''MANDATORY''' - The display name of the new user
| |
| − | * <code>Password</code> '''MANDATORY''' - The password for the new account
| |
| − | * <code>Administrator</code> - Whether the new user should be a local admin
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | * <code>newUserId</code>
| |
| − | * <code>nfsHomeDir</code>
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===User - Delete===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will delete a local user account from a macOS device.
| |
| − | | |
| − | ==== Extra Credentials ====
| |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>UserName</code> '''MANDATORY''' - The login username for the user being deleted
| |
| − | | |
| − | ====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 - Add to Group===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will add a local user to a local group on a macOS device.
| |
| − | | |
| − | ==== Extra Credentials ====
| |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>UserName</code> '''MANDATORY''' - The login username for the user
| |
| − | * <code>GroupName</code> - The name 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>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===User - Remove from Group===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will remove a local user from a local group on a macOS device.
| |
| − | | |
| − | ==== Extra Credentials ====
| |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>UserName</code> '''MANDATORY''' - The login username for the user
| |
| − | * <code>GroupName</code> - The name 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>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===User - Disable===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will disable a local user account on a macOS device.
| |
| − | | |
| − | ==== Extra Credentials ====
| |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>UserName</code> '''MANDATORY''' - The login username for the user
| |
| − | | |
| − | ====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 - Enable===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will enable a local user account on a macOS device.
| |
| − | | |
| − | ==== Extra Credentials ====
| |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>UserName</code> '''MANDATORY''' - The login username for the user
| |
| − | | |
| − | ====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 - Log Out===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will log out a local user session on a macOS device.
| |
| − | | |
| − | ==== Extra Credentials ====
| |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>UserName</code> '''MANDATORY''' - The login username for the user
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Firewall - Block App===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will block incoming connections for an application in the firewall on a macOS device.
| |
| − | | |
| − | ==== Extra Credentials ====
| |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>AppPath</code> '''MANDATORY''' - The full path of the application
| |
| − | | |
| − | ====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">
| |
| − | ===Firewall - Unblock App===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will unblock/allow incoming connections for an application in the firewall on a macOS device.
| |
| − | | |
| − | ==== Extra Credentials ====
| |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>AppPath</code> '''MANDATORY''' - The full path of the application
| |
| − | | |
| − | ====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">
| |
| − | ===Firewall - Enable Stealth Mode===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will enable stealth mode on the firewall on a macOS device.
| |
| − | | |
| − | ==== Extra Credentials ====
| |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | No input parameters
| |
| − | | |
| − | ====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">
| |
| − | ===Firewall - Disable Stealth Mode===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will disable stealth mode on the firewall on a macOS device.
| |
| − | | |
| − | ==== Extra Credentials ====
| |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | No input parameters
| |
| − | | |
| − | ====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">
| |
| − | ===Shutdown===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will shutdown or reboot a macOS device.
| |
| − | | |
| − | ==== Extra Credentials ====
| |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>Reboot</code> - Perform a reboot instead of shutdown
| |
| − | | |
| − | ====Output Parameters====
| |
| − | No output parameters
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | | |
| − | [[Category:ITOM]] | |
