Export

The export command collects patch management data from Jamf API calls, subsequently exporting the data to Excel, PDF, and HTML formats. This command works hand-in-hand with the process_reports() and export() methods.

Parameters

path(str)REQUIRED

The path to save the generated report(s).

formats(list[str])

If provided, only the specified formats will be exported. The option must be specified multiple times for multiple formats.

Example Usage

• --format excel → exports Excel spreadsheet format only

• --format html --format pdf → exports both HTML and PDF formats

Available Options: excel, pdf, html.

sort(str)

Sort the patch reports by specifying a column.

Note

Patcher automatically handles column name conversion to match column titles in the data frame.

omit(bool)

Omit software titles with patches released in last 48 hours.

date_format(str)

Specify the date format for the PDF header. Default is "%B %d %Y" (Month Day Year):

Option	Description	Example
Month-Year	Displays the date as the full month name followed by the year	January 2024
Month-Day-Year (default)	Displays the date with the full month name, day and year	January 31 2024
Year-Month-Day	Displays the date with the year followed by the full month name and day	2024 April 21
Day-Month-Year	Displays the date with the day followed by the full month name and year	16 April 2024
Full	Displays the full weekday name, followed by the full month name, day and year	Thursday September 26 2013

ios(bool)

If passed, includes iOS device data in exported reports.

concurrency(int)

The maximum number of API requests that can be sent at once. Defaults to 5.

Warning

Changing the max_concurrency value could lead to your Jamf server being unable to perform other basic tasks. It is strongly recommended to limit API call concurrency to no more than 5 connections. See Jamf Developer Guide for more information.

Added in version 2.3

Export per-title patch report data. Visit the feature request for more information.

device_details(bool)

If passed, will include per-title patch report data in exported Excel document, with each application having its own sheet in the workbook. Please note, depending on your environment (number of enrolled devices, number of configured Patch Titles, etc) this could take an extended period of time.

Usage

Export with default behavior (exports all formats)

$ patcherctl export --path '/path/to/save'

Export only specific formats (--format, -f)

$ patcherctl export --path '/path/to/save' --format excel
$ patcherctl export --path '/path/to/save' --format html --format pdf

Sort (--sort, -s)

$ patcherctl export --path '/path/to/save' --sort "Column Name"

Omit (--omit, -o)

$ patcherctl export --path '/path/to/save' --omit

Date Format (--date-format, -d)

$ patcherctl export --path '/path/to/save' --date-format "Month-Year"

iOS (--ios, -m)

$ patcherctl export --path '/path/to/save' --ios

Concurrency (--concurrency)

$ patcherctl export --path '/path/to/save' --concurrency 10

Device Details (--device-details, -D)

$ patcherctl export --path '/path/to/save' --device-details