Skip to main content

Report Commands

Report commands are used for managing the reports generated by Key Manager. For more information about reports, see Generating and Obtaining Reports.

note

Updating report data is performed using the system command calculate-reporting-data. For more information about the command, see calculate-reporting-data.

list-reporting-data

Syntax:

ssh-mgr-client [global_options] list-reporting-data [-F <filter>] \
[-X <exclude-filter>] [-o <format>] [-C <columns>] [-H] [-O <sort-order>] \
[-S <start-from>] [-M <max-results>] [-E <delim>] [-B]

List reporting data.

The following columns can be used for filtering (-F) and output formatting (-C):

id

Internal PrivX Key Manager id for the report

timestamp

Creation timestamp of the reporting data

Example:

$ ssh-mgr-client list-reporting-data

list-reports

Syntax:

ssh-mgr-client [global_options] list-reports [-F <filter>] \
[-X <exclude-filter>] [-o <format>] [-C <columns>] [-H] [-O <sort-order>] \
[-S <start-from>] [-M <max-results>] [-E <delim>] [-B]

List the reports configured in Key Manager. The default command returns all the reports.

Example for listing the name, type, and the email recipient(s) of all the reports:

The following columns can be used for filtering (-F) and output formatting (-C):

delivery_emails

Delivery emails

delivery_owner_roles

Delivery owner roles

delivery_type

Delivery type

description

Description of the report

id

Internal PrivX Key Manager id for the report

last_delivered

Last delivered

name

Name of the report

report_type

Report type

$ ssh-mgr-client list-reports -C name,report_type,delivery_emails