command:audit

auditGetList

auditGetList [--limit=] [--offset=] [--order=] [--direction=] [--filter=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Get a list of audit entries.

  • --limit
    The number of rows to retrieve. Default lists all audit entries up to an arbitrary limit set by the system
  • --offset
    A paging offset to begin the list from. Default: 0
  • --order
    Column identifier for sorting the result set (audit_id, node_id, time). Default: audit_id
  • --direction
    Sorting direction: ASC or DESC. Default: DESC
  • --filter
    Add filter parameters in an ad-hoc manner. These filters will be added to the predefined filter that was passed. This parameter is an array with a predefined set of parameters that accept strings or arrays to hold multiple values:
    • from: string, a timestamp to use for retrieving audit rows
    • to: string, a timestamp to use for retrieving audit rows
    • freeText: string
    • auditGroups: array, a list of auditGroups:
      • AUDIT_GROUP_DEPLOYMENT
      • AUDIT_GROUP_CONFIGURATION
      • AUDIT_GROUP_RESTART
      • AUDIT_GROUP_SETTINGS_CHANGES
      • AUDIT_GROUP_AUTHENTICATION
      • AUDIT_GROUP_AUTHORIZATION
      • AUDIT_GROUP_BOOTSTRAP
      • AUDIT_GROUP_CLUSTER_MANAGEMENT
      • AUDIT_GROUP_CODETRACING
      • AUDIT_GROUP_MONITOR
      • AUDIT_GROUP_STUDIO
      • AUDIT_GROUP_CLEAR_CACHE
      • AUDIT_GROUP_PAGE_CACHE_RULES
      • AUDIT_GROUP_JOBQUEUE_RULES
      • AUDIT_GROUP_PHPINFO
      • AUDIT_GROUP_WEBAPI
      • AUDIT_GROUP_LICENSE
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

auditGetDetails

auditGetDetails --auditId= [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Get all details available on a particular audit item.

  • --auditId
    Audit ID to get all details for
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

auditSetSettings

auditSetSettings --history= [--email=] [--callbackUrl=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Save settings of audit history and triggers.

  • --history
    Number of saved days in history
  • --email
    Array of email value and array of audit types
  • --callbackUrl
    Array of URL value and array of audit types
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

auditExport

auditExport [--filters=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Export the audit log to zipped log file.

  • --filters
    Array of filters: ‘from’ and ‘to’ timestamps, ‘auditGroups’ for groups types, ‘freeText’ for string search and ‘outcome’ for status of result.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.