Create a SnapLock log configuration for an SVM

08/29/2024 Contributors

POST /storage/snaplock/audit-logs

Introduced In: 9.7

Creates a SnapLock log configuration for an SVM. A SnapLock log configuration consists of a volume to store the log, the maximum size of the log file, and the default period of time for which the log file should be retained. The input parameter retention_period expects the duration in ISO 8601 format.

Required properties

svm.uuid or svm.name - Name or UUID of the SVM.
log_volume.volume.name or log_volume.volume.uuid - Name or UUID of audit log volume.

Recommended optional properties

log_volume.max_log_size - Max log file size.
log_volume.volume.retention_period - Retention period of log file.

Default property values

If not specified in POST, the following default property values are assigned:

log_volume.retention_period - P6M
log_volume.max_log_size - 10MB

snaplock log create

Learn more

DOC /storage/snaplock/audit-logs

Parameters

Name	Type	In	Required	Description
return_timeout	integer	query	False	The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202. Default value: 1 Max value: 120 Min value: 0
return_records	boolean	query	False	The default is false. If set to true, the records are returned. Default value:

Name

Type

Required

Description

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

Default value: 1
Max value: 120
Min value: 0

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

Default value:

Request Body

Name	Type	Description
_links	_links
log_archive	log_archive
log_files	array[snaplock_log_file]
log_volume	snaplock_log_volume
svm	svm

Name

Type

Description

_links

log_archive

log_files

array[snaplock_log_file]

log_volume

snaplock_log_volume

svm

Example request

{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "log_archive": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "base_name": "string",
    "expiry_time": "2058-06-04 15:00:00 -0400",
    "path": "/snaplock_log/system_logs/20180822_005947_GMT-present",
    "size": 20000
  },
  "log_files": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "base_name": "string",
      "expiry_time": "2058-06-04 15:00:00 -0400",
      "path": "/snaplock_log/system_logs/20180822_005947_GMT-present",
      "size": 20000
    }
  ],
  "log_volume": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "max_log_size": 20971520,
    "retention_period": "P30M",
    "volume": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "volume1",
      "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
    }
  },
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Response

Status: 202, Accepted

Name	Type	Description
job	job_link

Name

Type

Description

job

job_link

Example response

{
  "job": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "string"
  }
}

Headers

Name	Description	Type
Location	Useful for tracking the resource location	string

Name

Description

Type

Location

Useful for tracking the resource location

string

Error

Status: Default

ONTAP Error Response codes

Error code	Description
14090340	{field} is a required field
14090343	Invalid Field
14090346	Internal Error. Wait a few minutes, then try the command again

Name	Type	Description
error	error

Name

Type

Description

error

Example error

{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name	Type	Description
href	string

Name

Type

Description

href

string

_links

Name	Type	Description
self	href

Name

Type

Description

self

href

log_archive

Name	Type	Description
_links	_links
archive	boolean	Archive the specified SnapLock log file for the given base_name, and create a new log file. If base_name is not mentioned, archive all log files.
base_name	string	Base name of log file
expiry_time	string	Expiry time of the log file in date-time format. Value '9999-12-31T00:00:00Z' indicates infinite expiry time.
path	string	Absolute path of the log file in the volume
size	integer	Size of the log file in bytes

Name

Type

Description

_links

Name	Type	Description
_links	_links
archive	boolean	Archive the specified SnapLock log file for the given base_name, and create a new log file. If base_name is not mentioned, archive all log files.
base_name	string	Base name of log file
expiry_time	string	Expiry time of the log file in date-time format. Value '9999-12-31T00:00:00Z' indicates infinite expiry time.
path	string	Absolute path of the log file in the volume
size	integer	Size of the log file in bytes

archive

boolean

Archive the specified SnapLock log file for the given base_name, and create a new log file. If base_name is not mentioned, archive all log files.

base_name

string

Base name of log file

expiry_time

string

Expiry time of the log file in date-time format. Value '9999-12-31T00:00:00Z' indicates infinite expiry time.

path

string

Absolute path of the log file in the volume

size

integer

Size of the log file in bytes

volume

Name	Type	Description
_links	_links
name	string	The name of the volume.
uuid	string	Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move. example: 028baa66-41bd-11e9-81d5-00a0986138f7 Introduced in: 9.6 x-nullable: true

Name

Type

Description

_links

name

string

The name of the volume.

uuid

string

Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.

example: 028baa66-41bd-11e9-81d5-00a0986138f7
Introduced in: 9.6
x-nullable: true

snaplock_log_volume

Name	Type	Description
_links	_links
max_log_size	integer	Maximum size of log file in bytes
retention_period	string	Specifies the default log record retention period. The retention period value represents a duration and must be specified in the ISO-8601 duration format. The retention period can be in years, months, days, hours, minutes and seconds. A period specified for years, months and days is represented in the ISO-8601 format as "PY", "PM", "PD" respectively. For example "P10Y" represents a duration of 10 years. A duration in hours, minutes and seconds is represented by "PTH", "PTM", and "PTS" respectively. The period string must contain only a single time element i.e. either years, months, days, hours, minutes or seconds. A duration which combines different periods is not supported, example "P1Y10M" is not supported. Apart from the duration specified in the ISO-8601 format, the retention period field also accepts the string "infinite".
volume	volume

Name

Type

Description

_links

max_log_size

integer

Maximum size of log file in bytes

retention_period

string

Specifies the default log record retention period. The retention period value represents a duration and must be specified in the ISO-8601 duration format. The retention period can be in years, months, days, hours, minutes and seconds. A period specified for years, months and days is represented in the ISO-8601 format as "PY", "PM", "PD" respectively. For example "P10Y" represents a duration of 10 years. A duration in hours, minutes and seconds is represented by "PTH", "PTM", and "PTS" respectively. The period string must contain only a single time element i.e. either years, months, days, hours, minutes or seconds. A duration which combines different periods is not supported, example "P1Y10M" is not supported. Apart from the duration specified in the ISO-8601 format, the retention period field also accepts the string "infinite".

volume

svm

Name	Type	Description
_links	_links
name	string	The name of the SVM.
uuid	string	The unique identifier of the SVM.

Name

Type

Description

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

snaplock_log

Name	Type	Description
_links	_links
log_archive	log_archive
log_files	array[snaplock_log_file]
log_volume	snaplock_log_volume
svm	svm

Name

Type

Description

_links

log_archive

log_files

array[snaplock_log_file]

log_volume

snaplock_log_volume

svm

job_link

Name	Type	Description
_links	_links
uuid	string	The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

Name

Type

Description

_links

uuid

string

The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

error_arguments

Name	Type	Description
code	string	Argument code
message	string	Message argument

Name

Type

Description

code

string

Argument code

message

string

Message argument

error

Name	Type	Description
arguments	array[error_arguments]	Message arguments
code	string	Error code
message	string	Error message
target	string	The target parameter that caused the error.

Name

Type

Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.

Create a SnapLock log configuration for an SVM

Creating your file...

Required properties

Recommended optional properties

Default property values

Related ONTAP commands

Learn more

Parameters

Request Body

Response

Headers

Error

Definitions