Skip to main content

Retrieve the NFS configuration for an SVM

Contributors
PDFs

GET /protocols/nfs/connected-clients

Introduced In: 9.7

Retrieves the NFS configuration of SVMs.

Expensive properties

export_policy.id is expensive field. It is not included by default in GET results and must be explicitly requested using the fields query parameter. See Requesting specific fields to learn more.

  • export_policy.id

Parameters

Name Type In Required Description

server_ip

string

query

False

Filter by server_ip

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

remote_request_count

integer

query

False

Filter by remote_request_count

protocol

string

query

False

Filter by protocol

volume.uuid

string

query

False

Filter by volume.uuid

volume.name

string

query

False

Filter by volume.name

client_ip

string

query

False

Filter by client_ip

local_request_count

integer

query

False

Filter by local_request_count

node.uuid

string

query

False

Filter by node.uuid

node.name

string

query

False

Filter by node.name

idle_duration

string

query

False

Filter by idle_duration

trunking_enabled

boolean

query

False

Filter by trunking_enabled

  • Introduced in: 9.12

export_policy.name

string

query

False

Filter by export_policy.name

  • Introduced in: 9.9

export_policy.id

integer

query

False

Filter by export_policy.id

  • Introduced in: 9.9

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records 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.

  • Default value: 1

  • Max value: 120

  • Min value: 0

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[nfs_clients]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "client_ip": "string",
      "export_policy": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "id": 100,
        "name": "default"
      },
      "idle_duration": "P4DT84H30M5S",
      "node": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "protocol": "nfs3",
      "server_ip": "string",
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "volume": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "volume1",
        "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
      }
    }
  ]
}

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

next

href

self

href

_links

Name Type Description

self

href

export_policy

Export Policy

Name Type Description

_links

_links

id

integer

name

string

node

Name Type Description

_links

_links

name

string

uuid

string

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_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.

volume

Name Type Description

_links

_links

name

string

The name of the volume. This field cannot be specified in a POST or PATCH method.

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

nfs_clients

Name Type Description

_links

_links

client_ip

string

Specifies IP address of the client.

export_policy

export_policy

Export Policy

idle_duration

string

Specifies an ISO-8601 format of date and time to retrieve the idle time duration in hours, minutes, and seconds format.

local_request_count

integer

A counter that tracks requests that are sent to the volume with fast-path to local node.

node

node

protocol

string

The NFS protocol version over which client is accessing the volume. The following values are supported:

  • nfs - All NFS versions are considered

  • nfs3 - NFS version 3 protocol

  • nfs4 - NFS version 4 protocol

  • nfs4.1 - NFS version 4 minor version 1 protocol

  • nfs4.2 - NFS version 4 minor version 2 protocol

remote_request_count

integer

A counter that tracks requests that are sent to the volume with slow-path to remote node.

server_ip

string

Specifies the IP address of the server.

svm

svm

SVM, applies only to SVM-scoped objects.

trunking_enabled

boolean

Flag that indicates the trunking status for the specified SVM connection. True indicates that the trunking feature is enabled while false indicates that the trunking feature is disabled.

volume

volume

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.