Retrieve UNIX user cache settings
Accesses the UNIX user cache settings to view the current configuration details for user caching within the system. This helps you manage and troubleshoot user cache-related operations effectively.
HTTP method and endpoint
GET /name-services/cache/unix-user/settings
Introduced in
ONTAP 9.11
Usage notes
Retrieves unix-user cache settings.
Related ONTAP commands
-
vserver services name-service cache unix-user settings show
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
enabled |
boolean |
query |
False |
Filter by enabled |
negative_ttl |
string |
query |
False |
Filter by negative_ttl |
ttl |
string |
query |
False |
Filter by ttl |
svm.uuid |
string |
query |
False |
Filter by svm.uuid |
svm.name |
string |
query |
False |
Filter by svm.name |
propagation_enabled |
boolean |
query |
False |
Filter by propagation_enabled |
negative_cache_enabled |
boolean |
query |
False |
Filter by negative_cache_enabled |
fields |
array[string] |
query |
False |
Specify the fields to return. |
max_records |
integer |
query |
False |
Limit the number of records returned. |
return_records |
boolean |
query |
False |
The default is true for GET calls. When set to false, only the number of records is returned.
|
return_timeout |
integer |
query |
False |
The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
_links |
||
num_records |
integer |
Number of records. |
records |
array[unix_user_settings] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"negative_ttl": "PT5M",
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"ttl": "PT2H"
}
]
}
Error
Status: Default, 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 |
_links
| Name | Type | Description |
|---|---|---|
next |
||
self |
_links
| Name | Type | Description |
|---|---|---|
self |
svm
SVM, applies only to SVM-scoped objects.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the SVM. This field cannot be specified in a PATCH method. |
uuid |
string |
The unique identifier of the SVM. This field cannot be specified in a PATCH method. |
unix_user_settings
UNIX users cache setting.
| Name | Type | Description |
|---|---|---|
_links |
||
enabled |
boolean |
Indicates whether or not the cache is enabled. |
negative_cache_enabled |
boolean |
Indicates whether or not the negative cache is enabled. |
negative_ttl |
string |
Specifies negative Time to Live, in ISO 8601 format. |
propagation_enabled |
boolean |
Specifies whether the propagation setting is enabled or not. |
svm |
SVM, applies only to SVM-scoped objects. |
|
ttl |
string |
Specifies Time to Live (TTL), in ISO 8601 format. |
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. |