Skip to main content

Command line tool that utilizes Python-Jamf

Project description

jctl

Introduction

jctl is a command line tool that performs CRUD (Create/Read/Update/Delete) operations on a Jamf Pro or Jamf Cloud server. It can automate repetitive tasks and provide options not available in the web GUI. It uses and is the primary driver of python-jamf, which is a Python 3 module for the Jamf Pro Classic API.

There are a few other tools that are part of this project. pkgctl is automates various operations with packages, such as promotion and creating patch definitions. patch.py is a deprecated script designed to automate the patching process. It is still part of the project because it can do a few things that jctl can't. However, it is not being tested. update_asset_tags.py was demoed at the 2021 JNUC presentation Turn 1000 clicks into 1 with python-jamf and jctl. We decided to include it here. It is not being tested either.

jctl only supports 56 Jamf Pro record types. python-jamf can access all record types. python-jamf stores the Jamf Pro credentials in the keychain using keyring (instead of cleartext, like all other Jamf API projects that we know of).

Quick Start

If you don't have Python installed, you need to read about Installing Python on the wiki.

Installing

  • Install Module & Requirements: sudo pip3 install jctl
  • On your Jamf Pro server create a Jamf Pro API User
  • Config: conf-python-jamf
  • Enter hostname, username, and password
  • Test: conf-python-jamf -t

Uninstalling

Uninstalling jctl is easy if you installed it via pip. pip is the Package Installer for Python.

To uninstall jctl run the following command:

sudo pip3 uninstall jctl

Upgrading

Upgrading jctl is easy if you installed it via pip. pip is the Package Installer for Python.

To upgrade jctl run the following command:

sudo pip3 install --upgrade jctl

Getting Help

Wiki

More Documentation

For further in-depth details please check out the wiki.

Searching the wiki

To search this wiki use the "Search" field in the GitHub navigation bar above. Then on the search results page select the "Wiki" option or click here and search.

MacAdmin Slack Channel

If you have additional questions, or need more help getting started, post a question on the MacAdmin's Slack jctl channel.

MacAdmin's Slack Logo

Latest Status

See the releases page for details.

See jctl upgrade documentation to upgrade to latest release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jctl-1.1.23.tar.gz (17.6 kB view details)

Uploaded Source

Built Distribution

jctl-1.1.23-py3-none-any.whl (18.0 kB view details)

Uploaded Python 3

File details

Details for the file jctl-1.1.23.tar.gz.

File metadata

  • Download URL: jctl-1.1.23.tar.gz
  • Upload date:
  • Size: 17.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for jctl-1.1.23.tar.gz
Algorithm Hash digest
SHA256 4a9b42ddf26e4b7876f6c1fb1d5b11d6ce08b84e34a5d7319c597e2a6678c662
MD5 cfed3cfbada029852dfd02ab0d0206a4
BLAKE2b-256 91a6d7b180d2553015aebf2d76259da823fd0e3eea1c9ea1be86c5cc5370b991

See more details on using hashes here.

File details

Details for the file jctl-1.1.23-py3-none-any.whl.

File metadata

  • Download URL: jctl-1.1.23-py3-none-any.whl
  • Upload date:
  • Size: 18.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for jctl-1.1.23-py3-none-any.whl
Algorithm Hash digest
SHA256 7d58d8b5c9d742586ad6cf7bcb5f935cd6b1f404d536db45db8858b3a0956747
MD5 8533078543a33abd2fdb47f83f5444de
BLAKE2b-256 284d56420c3756dedef8a7bd8e308b48b5a6dfacdddabceede1dedcd070d2759

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page