Documentation

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

Computers / Get

Operation Information

Retrieve Device Information from jamf.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type Jamf.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose Jamf in the Type pick list;
  • Give the Jamf KeySafe key a Title (this is the name / identifier for the Jamf account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
Username string Jamf username
Jamf Server string The server name for your jamf instance this can be found in your url before '.jamfcloud.com'
Password string Your Jamf Password

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked Jamf account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Computer ID computerId string The Unique ID of the Computer No None provided
Computer Name computerSearch string If you do not know the ID of the Computer this search bar will look for exact name matches within jamf No None provided

Output Parameters

Display Name ID Type Description
Error Message error string Any error message returned by jamf
Status Code status string The status of the operation, ok/failed
Computer ID id integer The unique identifier number for the retirived computer
Computer Name name string The Name of the Computer
Mac Address macAddress string A 12-digit hexadecimal number assigned to each device connected to the network.
Platform platform string A 12-digit hexadecimal number assigned to each device connected to the network.
Computer Serial Number serialNumber string The Serial Number of the Computer
Computer UDID udid string The UDID of the Computer
Remotely Managed remoteManagement string Confirms if the device is being remotely managed
Remote Management Username remoteUsername string The UDID of the Computer
Site ID siteId string The Site ID of the Computer
Site Name siteName string The Site Name the Computer is located at
Username username string The Username of the Computer user
Real Name realName string The Name of the Computer user
Email Address emailAddress string The Email of the Computer user
Position position string The Position of the Computer user
Phone phone string The Phone of the Computer user
Phone Number phoneNumber string The Phone Number of the Computer user
Department department string The Department the Computer is in
Building building string The Building the Computer is in
Room room string The Room the Computer is in
Purchased purchasing string Has the device been purchased
PO Number poNumber string The Building the Computer is in
Vendor vendor string The Vendor of the Computer
Computer Make make string The Make of the Computer
Computer Model model string The Model of the Computer
Operating System Name osName string The Operating System Name the Computer is running
Operating System Version osVersion string The Building the Computer is in
Operating System Build osBuild string The Operating System Build
Activation Lock activationLock string Activation Lock is a feature on Apple devices that prevents others from using a device if it’s lost or stolen
Recover Lock recoverLock string Recovery lock allows you to prevent users from accessing the recovery partition on macOS devices
Firewall firewall string The Firewall located on the device
In This Document