Jamfrs

Purpose

Jamfrs is a CLI tool for interacting with the Jamf Pro Server. It's purpose is to act as an automation tool to streamline workflows. Currently only supports Read and Deletion operations but ideally will have full CRUD support in the future (time permitting). When performing Read operations, Jamfrs can return data as either XML or JSON.

Currently Jamfrs supports the following queries:

Entity	Capabilities
Computer	- Delete (ID) - Show (ID) - Search* (ID, Name, UUID, Serial, MAC Address) - List
Mobile Devices	- Delete (ID) - Show (ID) - Search* (ID, Name, UUID, Serial, MAC Address) - List
Users	- Delete - Show - Search* (ID, Name, UUID, Serial, MAC Address) - List
Policy	- Delete - Show - List
Package	- Delete - Show - List
Category	- Delete - Show - List
Department	- Delete - Show - List
Ebook	- Delete - Show - List
Building	- Delete - Show - List
Mac App	- Delete - Show - List
Mobile Device App	- Delete - Show - List
Script	- Delete - Show - List
Groups (Smart & Static)	- Delete - Show - List
Advanced Search	- Delete - Show - List
Restricted Software	- Delete - Show - List
Printer	- Delete - Show - List
Patch Policy	- Delete - Show - List
Patch Report	- List Software - List Computer
Patch Software Titles	- Delete - Show - List
Patch Available Titles	- List
Patch External Source	- Delete - Show - List
Patch Internal Source	- Show - List

*Supports wildcards

Usage

Usage: jamfrs [OPTIONS] --server <SERVER_ADDRESS> --user <USERNAME> --password <PASSWORD> <COMMAND>

Commands:
  adv-search           Work with advanced searches
  building             Work with buildings
  category             Work with categories
  computer             Work with computer records
  department           Work with departments
  ebook                Work with ebooks
  group                Work with smart & static groups
  mac-app              Work with mac applications
  mobile               Work with mobile device records
  mobile-app           Work with mobile device applications
  package              Work with packages
  patch                Work with patch
  policy               Work with policies
  printer              Work with printers
  restricted-software  Work with restricted software
  script               Work with scripts
  user                 Work with users records
  help                 Print this message or the help of the given subcommand(s)

Options:
  -s, --server <SERVER_ADDRESS>  Hostname or IP address for Jamf Pro server
      --port <PORT>              Port that the Jamf Pro server is listening to; Defaults to 443 for Jamf cloud instances, 8443 for others. If 'insecure' is passed then the default is 8080
  -u, --user <USERNAME>          Username used for API calls
  -p, --password <PASSWORD>      Password used by API user
      --pretty                   Pretty print output
      --json                     Request JSON data instead of the default XML; Note that delete queries always respond with XML
      --insecure                 Allow insecure traffic; Defaults to False. Useful with HTTP or untrusted SSL certificates
  -c, --confirm                  Confirm DELETE calls automatically; Defaults to False
  -h, --help                     Print help information
  -V, --version                  Print version information

Extended Help

Command: computer

Work with computer records

Usage: jamfrs --server <SERVER_ADDRESS> --user <USERNAME> --password <PASSWORD> computer <COMMAND>

Commands:
  delete  Delete an existing computer record
  show    Show an existing computer record
  search  Search for existing computer records by name, MAC address, username, etc; Accepts * wildcard Note: Wildcard searches must be wrapped in quotes or escaped to prevent shell expansion
  list    List all computers

Command: mobile

Work with mobile device records

Usage: jamfrs --server <SERVER_ADDRESS> --user <USERNAME> --password <PASSWORD> mobile <COMMAND>

Commands:
  delete  Delete an existing mobile device record
  show    Show an existing mobile device record
  search  Search for existing mobile device records by name, MAC address, username, etc. Accepts * wildcard
  list    List all mobile device records

Command: user

Work with users records

Usage: jamfrs --server <SERVER_ADDRESS> --user <USERNAME> --password <PASSWORD> user <COMMAND>

Commands:
  delete  Delete an existing user record
  show    Show an existing user record
  list    List all user records

Command: policy

Work with policies

Usage: jamfrs --server <SERVER_ADDRESS> --user <USERNAME> --password <PASSWORD> policy <COMMAND>

Commands:
  delete  Delete an existing policy record
  show    Show an existing policy record
  list    List all policy records

Command: package

Work with policies

Usage: jamfrs --server <SERVER_ADDRESS> --user <USERNAME> --password <PASSWORD> policy <COMMAND>

Commands:
  delete  Delete an existing policy record
  show    Show an existing policy record
  list    List all policy records

Command: category

Work with categories

Usage: jamfrs --server <SERVER_ADDRESS> --user <USERNAME> --password <PASSWORD> category <COMMAND>

Commands:
  delete  Delete an existing category record
  show    Show an existing category record
  list    List all category records

Command: department

Work with departments

Usage: jamfrs --server <SERVER_ADDRESS> --user <USERNAME> --password <PASSWORD> department <COMMAND>

Commands:
  delete  Delete an existing department record
  show    Show an existing department record
  list    List all department records

Command: ebook

Work with ebooks

Usage: jamfrs --server <SERVER_ADDRESS> --user <USERNAME> --password <PASSWORD> ebook <COMMAND>

Commands:
  delete  Delete an existing ebook record
  show    Show an existing ebook record
  list    List all ebook records

Command: building

Work with buildings

Usage: jamfrs --server <SERVER_ADDRESS> --user <USERNAME> --password <PASSWORD> building <COMMAND>

Commands:
  delete  Delete an existing buildings record
  show    Show an existing buildings record
  list    List all buildings records

Command: mac-app

Work with mac applications

Usage: jamfrs --server <SERVER_ADDRESS> --user <USERNAME> --password <PASSWORD> mac-app <COMMAND>

Commands:
  delete  Delete an existing mac application record
  show    Show an existing mac application record
  list    List all mac application records

Command: mobile-app

Work with mobile device applications

Usage: jamfrs --server <SERVER_ADDRESS> --user <USERNAME> --password <PASSWORD> mobile-app <COMMAND>

Commands:
  delete  Delete an existing mobile device application record
  show    Show an existing mobile device application record
  list    List all mobile device application records

Command: script

Work with scripts

Usage: jamfrs --server <SERVER_ADDRESS> --user <USERNAME> --password <PASSWORD> script <COMMAND>

Commands:
  delete  Delete an existing script
  show    Show an existing script
  list    List all script

Command: group

Work with smart & static groups

Usage: jamfrs --server <SERVER_ADDRESS> --user <USERNAME> --password <PASSWORD> group <COMMAND>

Commands:
  computer  Work with computer groups
  mobile    Work with mobile device groups
  user      Work with user groups

Group Subcommand: computer

Work with computer groups

Usage: jamfrs group computer <COMMAND>

Commands:
  delete  Delete an existing computer group
  show    Show an existing computer group
  list    List all computer groups

Group Subcommand: mobile

Work with mobile device groups

Usage: jamfrs group mobile <COMMAND>

Commands:
  delete  Delete an existing mobile device group
  show    Show an existing mobile device group
  list    List all mobile device groups

Group Subcommand: user

Work with user groups

Usage: jamfrs group user <COMMAND>

Commands:
  delete  Delete an existing user group
  show    Show an existing user group
  list    List all user groups

Command: adv-search

Work with advanced searches

Usage: jamfrs --server <SERVER_ADDRESS> --user <USERNAME> --password <PASSWORD> adv-search <COMMAND>

Commands:
  computer  Work with computer advanced searches
  mobile    Work with mobile device advanced searches
  user      Work with user advanced searches

Advanced Search Subcommand: computer

Work with computer advanced searches

Usage: jamfrs adv-search computer <COMMAND>

Commands:
  delete  Delete an existing computer advanced search
  show    Show an existing computer advanced search
  list    List all computer advanced searches

Advanced Search Subcommand: mobile

Work with mobile device advanced searches

Usage: jamfrs adv-search mobile <COMMAND>

Commands:
  delete  Delete an existing mobile device advanced search
  show    Show an existing mobile device advanced search
  list    List all mobile device advanced searches

Advanced Search Subcommand: user

Work with user advanced searches

Usage: jamfrs adv-search user <COMMAND>

Commands:
  delete  Delete an existing user advanced search
  show    Show an existing user advanced search
  list    List all user advanced searches

Command: restricted-software

Work with restricted software

Usage: jamfrs restricted-software <COMMAND>

Commands:
  delete  Delete an existing restricted software
  show    Show an existing restricted software
  list    List all restricted software

Command: printer

Work with printers

Usage: jamfrs printer <COMMAND>

Commands:
  delete  Delete an existing printer
  show    Show an existing printer
  list    List all printers

Command: patch

Work with patch

Usage: jamfrs patch <COMMAND>

Commands:
  policy            Work with patch policies
  report            Work with patch reports
  software-titles   Work with patch software titles
  available-titles  Work with patch available titles
  external-sources  Work with patch external sources
  internal-sources  Work with patch internal sources

Patch Subcommand: policy

Work with patch policies

Usage: jamfrs patch policy <COMMAND>

Commands:
  delete  Delete an existing patch policy
  show    Show an existing patch policy
  list    List all patch policies

Patch Subcommand: report

Work with patch reports

Usage: jamfrs patch report <COMMAND>

Commands:
  list-software  Display patch reports by software title id
  list-computer  Display computers for specific version

Patch Subcommand: software-titles

Work with patch software titles

Usage: jamfrs patch software-titles <COMMAND>

Commands:
  delete  Delete an existing patch software title
  show    Show an existing patch software title
  list    List all patch software titles

Patch Subcommand: available-titles

Work with patch available titles

Usage: jamfrs patch available-titles <COMMAND>

Commands:
  list  List all available titles from a given source (internal/external). NOTE: Due to a Jamf Pro bug, JSON requests will only get the first title -- Recommend requesting XML

Patch Subcommand: external-sources

Work with patch external sources

Usage: jamfrs patch external-sources <COMMAND>

Commands:
  delete  Delete an existing external patch source
  show    Show an existing external patch source
  list    List all external patch sources

Patch Subcommand: internal-sources

Work with patch internal sources

Usage: jamfrs patch internal-sources <COMMAND>

Commands:
  show  Show an existing internal patch source
  list  List all internal patch sources

Build

Being a Rust application, Jamfrs is built using cargo (get cargo). To build, simply clone the repo, navigate to the jamfrs directory containing the Cargo.toml file, and run cargo build --release. You'll find the newly created executable in jamfrs/target/release.

Known Issues

Jamf Pro doesn't respect Accept: application/json for DELETE calls, resulting in all delete calls returning XML instead
When using the json flag, Jamf Pro doesn't return the entire list of titles when requesting all available patch titles - Just the first and the number of titles. For the entire list, don't use the json flag

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

manicmachine / Jamfrs