Patch

/clusters/{id}/auditing/

This endpoint updates cluster audit settings

Security

HTTP

Type basic

Basic authentication using VMS user name and password

API Key: ApiToken

Header parameter nameApiToken

Send current valid API token in an Authorization header with format Api-Token .

Path parameters

id

integerRequired

Minimum1

Body parameters

Expand All

object

audit_dir_name

string

Name of the audit directory, which is located under the root directory.

read_access_users

Array of string

Enter users here to grant them read access to all files in the audit directory. To make the audit directory accessible to clients, create a view on the directory.

string

read_access_users_groups

Array of string

Enter groups here to grant them read access to all files in the audit directory. To make the audit directory accessible to clients, create a view on the directory.

string

max_file_size

integer

Maximum audit file size for each CNode core

max_retention_period

integer

Max retention period for audit files

max_retention_timeunit

string

Max retention period timeunit for audit files

protocols_audit

object

Map of protocols audit configurations

protocols

Array of string

Protocols to audit

string

max_audit_dir_size

string

Maximum audit directory size

enable_json_audit

boolean

If enabled, audit logs are saved in JSON format into a file in the directory specified as audit_dir_name. Can be enabled in addition to enable_vast_db_audit.

enable_vast_db_audit

boolean

If enabled, audit logs are saved in a VAST DataBase table. Can be enabled in addition to enable_json_audit.

Responses

200

OK

Expand All

object

audit_dir_name

string

Name of the audit directory, which is located under the root directory.

read_access_users

Array of string

Enter users here to grant them read access to all files in the audit directory. To make the audit directory accessible to clients, create a view on the directory.

string

read_access_users_groups

Array of string

Enter groups here to grant them read access to all files in the audit directory. To make the audit directory accessible to clients, create a view on the directory.

string

max_file_size

integer

Maximum audit file size for each CNode core

max_retention_period

integer

Max retention period for audit files

max_retention_timeunit

string

Max retention period timeunit for audit files

protocols_audit

object

Map of protocols audit configurations

protocols

Array of string

Protocols to audit

string

max_audit_dir_size

string

Maximum audit directory size

enable_json_audit

boolean

If enabled, audit logs are saved in JSON format into a file in the directory specified as audit_dir_name. Can be enabled in addition to enable_vast_db_audit.

enable_vast_db_audit

boolean

If enabled, audit logs are saved in a VAST DataBase table. Can be enabled in addition to enable_json_audit.

vast_audit_log_state

string

State of the VAST DataBase table to which audit logs are saved, if enabled

Valid values[ "NONE", "IN_CREATION", "CREATED", "FAILED" ]

async_task

object

Creation Async task properties

Modify Cluster Audit Settings