Initialize a SnapLock ComplianceClock
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
POST /storage/snaplock/compliance-clocks
Introduced In: 9.10
Initializes the SnapLock ComplianceClock.
Required properties
-
node.name
ornode.uuid
- Name or UUID of the node.
Related ONTAP commands
-
snaplock compliance-clock initialize
Learn more
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
return_records |
boolean |
query |
False |
The default is false. If set to true, the records are returned.
|
Request Body
Name | Type | Description |
---|---|---|
_links |
||
node |
||
time |
string |
Compliance clock time |
Example request
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"time": "2018-06-04 15:00:00 -0400"
}
Response
Status: 201, Created
Headers
Name | Description | Type |
---|---|---|
Location |
Useful for tracking the resource location |
string |
Error
Status: Default
ONTAP Error Response codes
Error code | Description |
---|---|
13763062 |
Compliance Clock already initialized |
13763084 |
ComplianceClock re-initialization failed as it requires that all nodes in the cluster are healthy, all volumes are in online state, no volumes are present in the volume recovery queue and there are no SnapLock volumes or volumes with "snapshot-locking-enabled" set to true or S3 buckets with object locking enabled. |
13763085 |
ComplianceClock re-initialization supported on effective cluster version of ONTAP 9.14.1 or later. |
14090240 |
Node with the specified UUID does not exist |
14090241 |
The specified node name and node UUID refer to different nodes |
14090343 |
Invalid field |
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 |
_links
Name | Type | Description |
---|---|---|
self |
node
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
|
uuid |
string |
snaplock_compliance_clock
Name | Type | Description |
---|---|---|
_links |
||
node |
||
time |
string |
Compliance clock time |
error_arguments
Name | Type | Description |
---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
returned_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. |