MacOS Management

From Hornbill
Jump to navigation Jump to search
Home > Administration > IT Operations Management > ITOM Package Library > macOS Management Index

Macos logo.png

Introduction

A collection of operations to manage macOS devices.

Related Articles

Target Environment Requirements

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

Itomtarget keysafe.png

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 KeySafe:

  • In the Admin console, navigate to: System > Security > KeySafe;
  • Click on + then select Username + Password;
  • 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 Processes and/or IT Operations Management Rubooks.


User - Create

This operation will create a new local user account on a macOS device.

Extra Credentials

None required.

Input Parameters

  • UserName MANDATORY - The login username for the new user
  • UserRealName MANDATORY - The display name of the new user
  • Password MANDATORY - The password for the new account
  • Administrator - Whether the new user should be a local admin

Output Parameters

  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation
  • newUserId
  • nfsHomeDir

User - Delete

This operation will delete a local user account from a macOS device.

Extra Credentials

None required.

Input Parameters

  • UserName MANDATORY - The login username for the user being deleted

Output Parameters

  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation

User - Add to Group

This operation will add a local user to a local group on a macOS device.

Extra Credentials

None required.

Input Parameters

  • UserName MANDATORY - The login username for the user
  • GroupName - The name of the group

Output Parameters

  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation

User - Remove from Group

This operation will remove a local user from a local group on a macOS device.

Extra Credentials

None required.

Input Parameters

  • UserName MANDATORY - The login username for the user
  • GroupName - The name of the group

Output Parameters

  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation

User - Disable

This operation will disable a local user account on a macOS device.

Extra Credentials

None required.

Input Parameters

  • UserName MANDATORY - The login username for the user

Output Parameters

  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation

User - Enable

This operation will enable a local user account on a macOS device.

Extra Credentials

None required.

Input Parameters

  • UserName MANDATORY - The login username for the user

Output Parameters

  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation

User - Log Out

This operation will log out a local user session on a macOS device.

Extra Credentials

None required.

Input Parameters

  • UserName MANDATORY - The login username for the user

Output Parameters

  • outcome MANDATORY The outcome of the operation (OK/FAIL)

Firewall - Block App

This operation will block incoming connections for an application in the firewall on a macOS device.

Extra Credentials

None required.

Input Parameters

  • AppPath MANDATORY - The full path of the application

Output Parameters

  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation

Firewall - Unblock App

This operation will unblock/allow incoming connections for an application in the firewall on a macOS device.

Extra Credentials

None required.

Input Parameters

  • AppPath MANDATORY - The full path of the application

Output Parameters

  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation

Firewall - Enable Stealth Mode

This operation will enable stealth mode on the firewall on a macOS device.

Extra Credentials

None required.

Input Parameters

No input parameters

Output Parameters

  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation

Firewall - Disable Stealth Mode

This operation will disable stealth mode on the firewall on a macOS device.

Extra Credentials

None required.

Input Parameters

No input parameters

Output Parameters

  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation

Shutdown

This operation will shutdown or reboot a macOS device.

Extra Credentials

None required.

Input Parameters

  • Reboot - Perform a reboot instead of shutdown

Output Parameters

No output parameters