Skip to main content

Retrieve the NFS connected-client cache settings for a cluster

Contributors
PDFs

GET /protocols/nfs/connected-client-settings

Introduced In: 9.12

Retrieves the NFS connected-client cache settings of the cluster.

Parameters

Name Type In Required Description

client_retention_interval

string

query

False

Filter by client_retention_interval

update_interval

string

query

False

Filter by update_interval

enable_nfs_clients_deletion

boolean

query

False

Filter by enable_nfs_clients_deletion

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

client_retention_interval

string

The lifetime range of the connected-clients cache. Only intervals in multiples of 12 hours or its equivalent in days, minutes or seconds are supported. The minimum is 12 hours and the maximum is 168 hours or 7 days.

enable_nfs_clients_deletion

boolean

Specifies whether or not NFS Clients deletion is enabled for the connected-clients cache. When set to "true", connected-clients entries are deleted when a connection is closed.

update_interval

string

The time interval between refreshing the connected-clients cache. The minimum is 1 hour and the maximum is 8 hours.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "client_retention_interval": "string",
  "update_interval": "string"
}

Error

Status: Default, Error
Name Type Description

error

returned_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

href

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.