User Guides
Get started with the CrashPlan command-line interface (CLI)
Configure a profile
Manage legal hold users
Clean up your environment by deactivating devices
Manage users
Perform bulk actions
Send audit logs to a SIEM
Write custom extension scripts using the CrashPlan CLI and Pycpg
Commands
Audit Logs
Devices
Legal Hold
Profile
Users
crashplancli
Index
Index
Symbols
|
A
|
C
|
D
|
H
|
L
|
M
|
O
|
P
|
U
Symbols
--active
devices-list command line option
devices-list-backup-sets command line option
users-list command line option
--actor-ip
audit-logs-search command line option
audit-logs-send-to command line option
--actor-user-id
audit-logs-search command line option
audit-logs-send-to command line option
--actor-username
audit-logs-search command line option
audit-logs-send-to command line option
--affected-user-id
audit-logs-search command line option
audit-logs-send-to command line option
--affected-username
audit-logs-search command line option
audit-logs-send-to command line option
--api-client-id
profile-create-api-client command line option
profile-update command line option
--archive-size-quota
users-update command line option
--assume-yes
profile-delete command line option
profile-delete-all command line option
--begin
audit-logs-search command line option
audit-logs-send-to command line option
legal-hold-search-events command line option
--certs
audit-logs-send-to command line option
--change-device-name
devices-bulk-deactivate command line option
devices-deactivate command line option
--created-after
devices-list command line option
--created-before
devices-list command line option
--debug
audit-logs-clear-checkpoint command line option
audit-logs-search command line option
audit-logs-send-to command line option
devices-bulk-deactivate command line option
devices-bulk-reactivate command line option
devices-bulk-rename command line option
devices-deactivate command line option
devices-list command line option
devices-list-backup-sets command line option
devices-reactivate command line option
devices-rename command line option
devices-show command line option
legal-hold-add-user command line option
legal-hold-bulk-add command line option
legal-hold-bulk-remove command line option
legal-hold-list command line option
legal-hold-remove-user command line option
legal-hold-search-events command line option
legal-hold-show command line option
profile-create command line option
profile-create-api-client command line option
profile-reset-pw command line option
profile-update command line option
users-add-role command line option
users-bulk-add-roles command line option
users-bulk-deactivate command line option
users-bulk-move command line option
users-bulk-reactivate command line option
users-bulk-remove-roles command line option
users-bulk-update command line option
users-deactivate command line option
users-list command line option
users-move command line option
users-orgs-list command line option
users-orgs-show command line option
users-reactivate command line option
users-remove-role command line option
users-show command line option
users-update command line option
--disable-ssl-errors
profile-create command line option
profile-create-api-client command line option
profile-update command line option
--email
users-update command line option
--end
audit-logs-search command line option
audit-logs-send-to command line option
legal-hold-search-events command line option
--event-type
audit-logs-search command line option
audit-logs-send-to command line option
legal-hold-search-events command line option
--exclude-most-recently-connected
devices-list command line option
--first-name
users-update command line option
--format
audit-logs-search command line option
devices-bulk-deactivate command line option
devices-bulk-reactivate command line option
devices-bulk-rename command line option
devices-list command line option
devices-list-backup-sets command line option
legal-hold-list command line option
legal-hold-search-events command line option
users-bulk-add-roles command line option
users-bulk-deactivate command line option
users-bulk-move command line option
users-bulk-reactivate command line option
users-bulk-remove-roles command line option
users-bulk-update command line option
users-list command line option
users-orgs-list command line option
users-orgs-show command line option
users-show command line option
--ignore-cert-validation
audit-logs-send-to command line option
--inactive
devices-list command line option
devices-list-backup-sets command line option
users-list command line option
--include-backup-usage
devices-list command line option
--include-inactive
legal-hold-show command line option
--include-legal-hold-membership
devices-list command line option
users-list command line option
users-show command line option
--include-policy
legal-hold-show command line option
--include-roles
users-list command line option
--include-settings
devices-list command line option
--include-total-storage
devices-list command line option
--include-usernames
devices-list command line option
devices-list-backup-sets command line option
--last-connected-after
devices-list command line option
--last-connected-before
devices-list command line option
--last-name
users-update command line option
--matter-id
legal-hold-add-user command line option
legal-hold-remove-user command line option
legal-hold-search-events command line option
--name
profile-create command line option
profile-create-api-client command line option
profile-update command line option
--new-device-name
devices-rename command line option
--notes
users-update command line option
--org-id
users-move command line option
--org-uid
devices-list command line option
devices-list-backup-sets command line option
users-list command line option
--page-size
devices-list command line option
devices-list-backup-sets command line option
--password
profile-create command line option
profile-update command line option
users-update command line option
--path
devices-bulk-generate-template command line option
legal-hold-bulk-generate-template command line option
users-bulk-generate-template command line option
--profile
audit-logs-clear-checkpoint command line option
audit-logs-search command line option
audit-logs-send-to command line option
devices-bulk-deactivate command line option
devices-bulk-reactivate command line option
devices-bulk-rename command line option
devices-deactivate command line option
devices-list command line option
devices-list-backup-sets command line option
devices-reactivate command line option
devices-rename command line option
devices-show command line option
legal-hold-add-user command line option
legal-hold-bulk-add command line option
legal-hold-bulk-remove command line option
legal-hold-list command line option
legal-hold-remove-user command line option
legal-hold-search-events command line option
legal-hold-show command line option
users-add-role command line option
users-bulk-add-roles command line option
users-bulk-deactivate command line option
users-bulk-move command line option
users-bulk-reactivate command line option
users-bulk-remove-roles command line option
users-bulk-update command line option
users-deactivate command line option
users-list command line option
users-move command line option
users-orgs-list command line option
users-orgs-show command line option
users-reactivate command line option
users-remove-role command line option
users-show command line option
users-update command line option
--protocol
audit-logs-send-to command line option
--purge-date
devices-bulk-deactivate command line option
devices-deactivate command line option
users-bulk-deactivate command line option
users-deactivate command line option
--role-name
users-add-role command line option
users-list command line option
users-remove-role command line option
--secret
profile-create-api-client command line option
profile-update command line option
--server
profile-create command line option
profile-create-api-client command line option
profile-update command line option
--totp
audit-logs-clear-checkpoint command line option
audit-logs-search command line option
audit-logs-send-to command line option
devices-bulk-deactivate command line option
devices-bulk-reactivate command line option
devices-bulk-rename command line option
devices-deactivate command line option
devices-list command line option
devices-list-backup-sets command line option
devices-reactivate command line option
devices-rename command line option
devices-show command line option
legal-hold-add-user command line option
legal-hold-bulk-add command line option
legal-hold-bulk-remove command line option
legal-hold-list command line option
legal-hold-remove-user command line option
legal-hold-search-events command line option
legal-hold-show command line option
profile-create command line option
profile-update command line option
users-add-role command line option
users-bulk-add-roles command line option
users-bulk-deactivate command line option
users-bulk-move command line option
users-bulk-reactivate command line option
users-bulk-remove-roles command line option
users-bulk-update command line option
users-deactivate command line option
users-list command line option
users-move command line option
users-orgs-list command line option
users-orgs-show command line option
users-reactivate command line option
users-remove-role command line option
users-show command line option
users-update command line option
--use-checkpoint
audit-logs-search command line option
audit-logs-send-to command line option
--user-uid
users-update command line option
--username
legal-hold-add-user command line option
legal-hold-remove-user command line option
profile-create command line option
profile-update command line option
users-add-role command line option
users-move command line option
users-remove-role command line option
users-update command line option
-b
audit-logs-search command line option
audit-logs-send-to command line option
-c
audit-logs-search command line option
audit-logs-send-to command line option
-d
audit-logs-clear-checkpoint command line option
audit-logs-search command line option
audit-logs-send-to command line option
devices-bulk-deactivate command line option
devices-bulk-reactivate command line option
devices-bulk-rename command line option
devices-deactivate command line option
devices-list command line option
devices-list-backup-sets command line option
devices-reactivate command line option
devices-rename command line option
devices-show command line option
legal-hold-add-user command line option
legal-hold-bulk-add command line option
legal-hold-bulk-remove command line option
legal-hold-list command line option
legal-hold-remove-user command line option
legal-hold-search-events command line option
legal-hold-show command line option
profile-create command line option
profile-create-api-client command line option
profile-reset-pw command line option
profile-update command line option
users-add-role command line option
users-bulk-add-roles command line option
users-bulk-deactivate command line option
users-bulk-move command line option
users-bulk-reactivate command line option
users-bulk-remove-roles command line option
users-bulk-update command line option
users-deactivate command line option
users-list command line option
users-move command line option
users-orgs-list command line option
users-orgs-show command line option
users-reactivate command line option
users-remove-role command line option
users-show command line option
users-update command line option
-e
audit-logs-search command line option
audit-logs-send-to command line option
-f
audit-logs-search command line option
devices-bulk-deactivate command line option
devices-bulk-reactivate command line option
devices-bulk-rename command line option
devices-list command line option
devices-list-backup-sets command line option
legal-hold-list command line option
legal-hold-search-events command line option
users-bulk-add-roles command line option
users-bulk-deactivate command line option
users-bulk-move command line option
users-bulk-reactivate command line option
users-bulk-remove-roles command line option
users-bulk-update command line option
users-list command line option
users-orgs-list command line option
users-orgs-show command line option
users-show command line option
-m
legal-hold-add-user command line option
legal-hold-remove-user command line option
legal-hold-search-events command line option
-n
devices-rename command line option
profile-create command line option
profile-create-api-client command line option
profile-update command line option
-p
audit-logs-send-to command line option
devices-bulk-generate-template command line option
legal-hold-bulk-generate-template command line option
users-bulk-generate-template command line option
-s
profile-create command line option
profile-create-api-client command line option
profile-update command line option
-u
legal-hold-add-user command line option
legal-hold-remove-user command line option
profile-create command line option
profile-update command line option
-y
profile-delete command line option
profile-delete-all command line option
A
audit-logs-clear-checkpoint command line option
--debug
--profile
--totp
-d
CHECKPOINT_NAME
audit-logs-search command line option
--actor-ip
--actor-user-id
--actor-username
--affected-user-id
--affected-username
--begin
--debug
--end
--event-type
--format
--profile
--totp
--use-checkpoint
-b
-c
-d
-e
-f
audit-logs-send-to command line option
--actor-ip
--actor-user-id
--actor-username
--affected-user-id
--affected-username
--begin
--certs
--debug
--end
--event-type
--ignore-cert-validation
--profile
--protocol
--totp
--use-checkpoint
-b
-c
-d
-e
-p
HOSTNAME
C
CHECKPOINT_NAME
audit-logs-clear-checkpoint command line option
CMD
devices-bulk-generate-template command line option
legal-hold-bulk-generate-template command line option
users-bulk-generate-template command line option
CSV_FILE
devices-bulk-deactivate command line option
devices-bulk-reactivate command line option
devices-bulk-rename command line option
legal-hold-bulk-add command line option
legal-hold-bulk-remove command line option
users-bulk-add-roles command line option
users-bulk-deactivate command line option
users-bulk-move command line option
users-bulk-reactivate command line option
users-bulk-remove-roles command line option
users-bulk-update command line option
D
DEVICE_GUID
devices-deactivate command line option
devices-reactivate command line option
devices-rename command line option
devices-show command line option
devices-bulk-deactivate command line option
--change-device-name
--debug
--format
--profile
--purge-date
--totp
-d
-f
CSV_FILE
devices-bulk-generate-template command line option
--path
-p
CMD
devices-bulk-reactivate command line option
--debug
--format
--profile
--totp
-d
-f
CSV_FILE
devices-bulk-rename command line option
--debug
--format
--profile
--totp
-d
-f
CSV_FILE
devices-deactivate command line option
--change-device-name
--debug
--profile
--purge-date
--totp
-d
DEVICE_GUID
devices-list command line option
--active
--created-after
--created-before
--debug
--exclude-most-recently-connected
--format
--inactive
--include-backup-usage
--include-legal-hold-membership
--include-settings
--include-total-storage
--include-usernames
--last-connected-after
--last-connected-before
--org-uid
--page-size
--profile
--totp
-d
-f
devices-list-backup-sets command line option
--active
--debug
--format
--inactive
--include-usernames
--org-uid
--page-size
--profile
--totp
-d
-f
devices-reactivate command line option
--debug
--profile
--totp
-d
DEVICE_GUID
devices-rename command line option
--debug
--new-device-name
--profile
--totp
-d
-n
DEVICE_GUID
devices-show command line option
--debug
--profile
--totp
-d
DEVICE_GUID
H
HOSTNAME
audit-logs-send-to command line option
L
legal-hold-add-user command line option
--debug
--matter-id
--profile
--totp
--username
-d
-m
-u
legal-hold-bulk-add command line option
--debug
--profile
--totp
-d
CSV_FILE
legal-hold-bulk-generate-template command line option
--path
-p
CMD
legal-hold-bulk-remove command line option
--debug
--profile
--totp
-d
CSV_FILE
legal-hold-list command line option
--debug
--format
--profile
--totp
-d
-f
legal-hold-remove-user command line option
--debug
--matter-id
--profile
--totp
--username
-d
-m
-u
legal-hold-search-events command line option
--begin
--debug
--end
--event-type
--format
--matter-id
--profile
--totp
-d
-f
-m
legal-hold-show command line option
--debug
--include-inactive
--include-policy
--profile
--totp
-d
MATTER_ID
M
MATTER_ID
legal-hold-show command line option
O
ORG_UID
users-orgs-show command line option
P
profile-create command line option
--debug
--disable-ssl-errors
--name
--password
--server
--totp
--username
-d
-n
-s
-u
profile-create-api-client command line option
--api-client-id
--debug
--disable-ssl-errors
--name
--secret
--server
-d
-n
-s
profile-delete command line option
--assume-yes
-y
PROFILE_NAME
profile-delete-all command line option
--assume-yes
-y
profile-reset-pw command line option
--debug
-d
PROFILE_NAME
profile-show command line option
PROFILE_NAME
profile-update command line option
--api-client-id
--debug
--disable-ssl-errors
--name
--password
--secret
--server
--totp
--username
-d
-n
-s
-u
profile-use command line option
PROFILE_NAME
PROFILE_NAME
profile-delete command line option
profile-reset-pw command line option
profile-show command line option
profile-use command line option
U
USERNAME
users-deactivate command line option
users-reactivate command line option
users-show command line option
users-add-role command line option
--debug
--profile
--role-name
--totp
--username
-d
users-bulk-add-roles command line option
--debug
--format
--profile
--totp
-d
-f
CSV_FILE
users-bulk-deactivate command line option
--debug
--format
--profile
--purge-date
--totp
-d
-f
CSV_FILE
users-bulk-generate-template command line option
--path
-p
CMD
users-bulk-move command line option
--debug
--format
--profile
--totp
-d
-f
CSV_FILE
users-bulk-reactivate command line option
--debug
--format
--profile
--totp
-d
-f
CSV_FILE
users-bulk-remove-roles command line option
--debug
--format
--profile
--totp
-d
-f
CSV_FILE
users-bulk-update command line option
--debug
--format
--profile
--totp
-d
-f
CSV_FILE
users-deactivate command line option
--debug
--profile
--purge-date
--totp
-d
USERNAME
users-list command line option
--active
--debug
--format
--inactive
--include-legal-hold-membership
--include-roles
--org-uid
--profile
--role-name
--totp
-d
-f
users-move command line option
--debug
--org-id
--profile
--totp
--username
-d
users-orgs-list command line option
--debug
--format
--profile
--totp
-d
-f
users-orgs-show command line option
--debug
--format
--profile
--totp
-d
-f
ORG_UID
users-reactivate command line option
--debug
--profile
--totp
-d
USERNAME
users-remove-role command line option
--debug
--profile
--role-name
--totp
--username
-d
users-show command line option
--debug
--format
--include-legal-hold-membership
--profile
--totp
-d
-f
USERNAME
users-update command line option
--archive-size-quota
--debug
--email
--first-name
--last-name
--notes
--password
--profile
--totp
--user-uid
--username
-d