Retrieve netgroup cache settings
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
GET /name-services/cache/netgroup/settings
Introduced In: 9.11
Retrieves netgroups cache settings.
Related ONTAP commands
-
vserver services name-service cache netgroups settings show
Learn more
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
negative_ttl_byhost |
string |
query |
False |
Filter by negative_ttl_byhost |
svm.uuid |
string |
query |
False |
Filter by svm.uuid |
svm.name |
string |
query |
False |
Filter by svm.name |
ttl_for_members |
string |
query |
False |
Filter by ttl_for_members |
negative_cache_enabled_byhost |
boolean |
query |
False |
Filter by negative_cache_enabled_byhost |
enabled |
boolean |
query |
False |
Filter by enabled |
ttl_byhost |
string |
query |
False |
Filter by ttl_byhost |
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[netgroups_settings] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"negative_ttl_byhost": "PT2M5S",
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"ttl_byhost": "PT24H",
"ttl_for_members": "PT2M"
}
]
}
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. |
netgroups_settings
Netgroups cache setting.
Name | Type | Description |
---|---|---|
_links |
||
enabled |
boolean |
Indicates whether or not the cache is enabled. |
negative_cache_enabled_byhost |
boolean |
Indicates whether or not the negative cache is enabled. |
negative_ttl_byhost |
string |
Specifies negative Time to Live by host, in ISO 8601 format. |
svm |
SVM, applies only to SVM-scoped objects. |
|
ttl_byhost |
string |
Specifies Time to Live by host, in ISO 8601 format. |
ttl_for_members |
string |
Specifies Time to Live for netgroup members, in ISO 8601 format. |
error_arguments
Name | Type | Description |
---|---|---|
code |
string |
Argument code |