Skip to main content
A newer release of this product is available.

Retrieve NFS configuration for SVMs

Contributors
PDFs

GET /protocols/nfs/services

Introduced In: 9.6

Retrieves the NFS configuration of SVMs.

Expensive properties

There is an added cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the fields query parameter. See Requesting specific fields to learn more.

  • statistics.*

  • metric.*

  • vserver nfs show

  • vserver nfs status

Learn more

Parameters

Name Type In Required Description

protocol_access_rules.volume

string

query

False

Volume on which access needs to be checked.

  • Introduced in: 9.10

protocol_access_rules.client_ip

string

query

False

IP address for the client for which access needs to be checked.

  • Introduced in: 9.10

protocol_access_rules.auth_type

string

query

False

Authentication method used to check the client's access to the volume.

  • Introduced in: 9.10

  • Default value: 1

metric.v3.duration

string

query

False

Filter by metric.v3.duration

  • Introduced in: 9.7

metric.v3.timestamp

string

query

False

Filter by metric.v3.timestamp

  • Introduced in: 9.7

metric.v3.latency.total

integer

query

False

Filter by metric.v3.latency.total

  • Introduced in: 9.7

metric.v3.latency.write

integer

query

False

Filter by metric.v3.latency.write

  • Introduced in: 9.7

metric.v3.latency.other

integer

query

False

Filter by metric.v3.latency.other

  • Introduced in: 9.7

metric.v3.latency.read

integer

query

False

Filter by metric.v3.latency.read

  • Introduced in: 9.7

metric.v3.iops.total

integer

query

False

Filter by metric.v3.iops.total

  • Introduced in: 9.7

metric.v3.iops.write

integer

query

False

Filter by metric.v3.iops.write

  • Introduced in: 9.7

metric.v3.iops.other

integer

query

False

Filter by metric.v3.iops.other

  • Introduced in: 9.7

metric.v3.iops.read

integer

query

False

Filter by metric.v3.iops.read

  • Introduced in: 9.7

metric.v3.status

string

query

False

Filter by metric.v3.status

  • Introduced in: 9.7

metric.v3.throughput.read

integer

query

False

Filter by metric.v3.throughput.read

  • Introduced in: 9.7

metric.v3.throughput.total

integer

query

False

Filter by metric.v3.throughput.total

  • Introduced in: 9.7

metric.v3.throughput.write

integer

query

False

Filter by metric.v3.throughput.write

  • Introduced in: 9.7

metric.v4.duration

string

query

False

Filter by metric.v4.duration

  • Introduced in: 9.8

metric.v4.timestamp

string

query

False

Filter by metric.v4.timestamp

  • Introduced in: 9.8

metric.v4.latency.total

integer

query

False

Filter by metric.v4.latency.total

  • Introduced in: 9.8

metric.v4.latency.write

integer

query

False

Filter by metric.v4.latency.write

  • Introduced in: 9.8

metric.v4.latency.other

integer

query

False

Filter by metric.v4.latency.other

  • Introduced in: 9.8

metric.v4.latency.read

integer

query

False

Filter by metric.v4.latency.read

  • Introduced in: 9.8

metric.v4.iops.total

integer

query

False

Filter by metric.v4.iops.total

  • Introduced in: 9.8

metric.v4.iops.write

integer

query

False

Filter by metric.v4.iops.write

  • Introduced in: 9.8

metric.v4.iops.other

integer

query

False

Filter by metric.v4.iops.other

  • Introduced in: 9.8

metric.v4.iops.read

integer

query

False

Filter by metric.v4.iops.read

  • Introduced in: 9.8

metric.v4.status

string

query

False

Filter by metric.v4.status

  • Introduced in: 9.8

metric.v4.throughput.read

integer

query

False

Filter by metric.v4.throughput.read

  • Introduced in: 9.8

metric.v4.throughput.total

integer

query

False

Filter by metric.v4.throughput.total

  • Introduced in: 9.8

metric.v4.throughput.write

integer

query

False

Filter by metric.v4.throughput.write

  • Introduced in: 9.8

metric.v41.duration

string

query

False

Filter by metric.v41.duration

  • Introduced in: 9.8

metric.v41.timestamp

string

query

False

Filter by metric.v41.timestamp

  • Introduced in: 9.8

metric.v41.latency.total

integer

query

False

Filter by metric.v41.latency.total

  • Introduced in: 9.8

metric.v41.latency.write

integer

query

False

Filter by metric.v41.latency.write

  • Introduced in: 9.8

metric.v41.latency.other

integer

query

False

Filter by metric.v41.latency.other

  • Introduced in: 9.8

metric.v41.latency.read

integer

query

False

Filter by metric.v41.latency.read

  • Introduced in: 9.8

metric.v41.iops.total

integer

query

False

Filter by metric.v41.iops.total

  • Introduced in: 9.8

metric.v41.iops.write

integer

query

False

Filter by metric.v41.iops.write

  • Introduced in: 9.8

metric.v41.iops.other

integer

query

False

Filter by metric.v41.iops.other

  • Introduced in: 9.8

metric.v41.iops.read

integer

query

False

Filter by metric.v41.iops.read

  • Introduced in: 9.8

metric.v41.status

string

query

False

Filter by metric.v41.status

  • Introduced in: 9.8

metric.v41.throughput.read

integer

query

False

Filter by metric.v41.throughput.read

  • Introduced in: 9.8

metric.v41.throughput.total

integer

query

False

Filter by metric.v41.throughput.total

  • Introduced in: 9.8

metric.v41.throughput.write

integer

query

False

Filter by metric.v41.throughput.write

  • Introduced in: 9.8

extended_groups_limit

integer

query

False

Filter by extended_groups_limit

  • Introduced in: 9.8

statistics.v3.latency_raw.total

integer

query

False

Filter by statistics.v3.latency_raw.total

  • Introduced in: 9.7

statistics.v3.latency_raw.write

integer

query

False

Filter by statistics.v3.latency_raw.write

  • Introduced in: 9.7

statistics.v3.latency_raw.other

integer

query

False

Filter by statistics.v3.latency_raw.other

  • Introduced in: 9.7

statistics.v3.latency_raw.read

integer

query

False

Filter by statistics.v3.latency_raw.read

  • Introduced in: 9.7

statistics.v3.status

string

query

False

Filter by statistics.v3.status

  • Introduced in: 9.7

statistics.v3.iops_raw.total

integer

query

False

Filter by statistics.v3.iops_raw.total

  • Introduced in: 9.7

statistics.v3.iops_raw.write

integer

query

False

Filter by statistics.v3.iops_raw.write

  • Introduced in: 9.7

statistics.v3.iops_raw.other

integer

query

False

Filter by statistics.v3.iops_raw.other

  • Introduced in: 9.7

statistics.v3.iops_raw.read

integer

query

False

Filter by statistics.v3.iops_raw.read

  • Introduced in: 9.7

statistics.v3.timestamp

string

query

False

Filter by statistics.v3.timestamp

  • Introduced in: 9.7

statistics.v3.throughput_raw.read

integer

query

False

Filter by statistics.v3.throughput_raw.read

  • Introduced in: 9.7

statistics.v3.throughput_raw.total

integer

query

False

Filter by statistics.v3.throughput_raw.total

  • Introduced in: 9.7

statistics.v3.throughput_raw.write

integer

query

False

Filter by statistics.v3.throughput_raw.write

  • Introduced in: 9.7

statistics.v4.latency_raw.total

integer

query

False

Filter by statistics.v4.latency_raw.total

  • Introduced in: 9.8

statistics.v4.latency_raw.write

integer

query

False

Filter by statistics.v4.latency_raw.write

  • Introduced in: 9.8

statistics.v4.latency_raw.other

integer

query

False

Filter by statistics.v4.latency_raw.other

  • Introduced in: 9.8

statistics.v4.latency_raw.read

integer

query

False

Filter by statistics.v4.latency_raw.read

  • Introduced in: 9.8

statistics.v4.status

string

query

False

Filter by statistics.v4.status

  • Introduced in: 9.8

statistics.v4.iops_raw.total

integer

query

False

Filter by statistics.v4.iops_raw.total

  • Introduced in: 9.8

statistics.v4.iops_raw.write

integer

query

False

Filter by statistics.v4.iops_raw.write

  • Introduced in: 9.8

statistics.v4.iops_raw.other

integer

query

False

Filter by statistics.v4.iops_raw.other

  • Introduced in: 9.8

statistics.v4.iops_raw.read

integer

query

False

Filter by statistics.v4.iops_raw.read

  • Introduced in: 9.8

statistics.v4.timestamp

string

query

False

Filter by statistics.v4.timestamp

  • Introduced in: 9.8

statistics.v4.throughput_raw.read

integer

query

False

Filter by statistics.v4.throughput_raw.read

  • Introduced in: 9.8

statistics.v4.throughput_raw.total

integer

query

False

Filter by statistics.v4.throughput_raw.total

  • Introduced in: 9.8

statistics.v4.throughput_raw.write

integer

query

False

Filter by statistics.v4.throughput_raw.write

  • Introduced in: 9.8

statistics.v41.latency_raw.total

integer

query

False

Filter by statistics.v41.latency_raw.total

  • Introduced in: 9.8

statistics.v41.latency_raw.write

integer

query

False

Filter by statistics.v41.latency_raw.write

  • Introduced in: 9.8

statistics.v41.latency_raw.other

integer

query

False

Filter by statistics.v41.latency_raw.other

  • Introduced in: 9.8

statistics.v41.latency_raw.read

integer

query

False

Filter by statistics.v41.latency_raw.read

  • Introduced in: 9.8

statistics.v41.status

string

query

False

Filter by statistics.v41.status

  • Introduced in: 9.8

statistics.v41.iops_raw.total

integer

query

False

Filter by statistics.v41.iops_raw.total

  • Introduced in: 9.8

statistics.v41.iops_raw.write

integer

query

False

Filter by statistics.v41.iops_raw.write

  • Introduced in: 9.8

statistics.v41.iops_raw.other

integer

query

False

Filter by statistics.v41.iops_raw.other

  • Introduced in: 9.8

statistics.v41.iops_raw.read

integer

query

False

Filter by statistics.v41.iops_raw.read

  • Introduced in: 9.8

statistics.v41.timestamp

string

query

False

Filter by statistics.v41.timestamp

  • Introduced in: 9.8

statistics.v41.throughput_raw.read

integer

query

False

Filter by statistics.v41.throughput_raw.read

  • Introduced in: 9.8

statistics.v41.throughput_raw.total

integer

query

False

Filter by statistics.v41.throughput_raw.total

  • Introduced in: 9.8

statistics.v41.throughput_raw.write

integer

query

False

Filter by statistics.v41.throughput_raw.write

  • Introduced in: 9.8

enabled

boolean

query

False

Filter by enabled

qtree.validate_export

boolean

query

False

Filter by qtree.validate_export

  • Introduced in: 9.10

qtree.export_enabled

boolean

query

False

Filter by qtree.export_enabled

  • Introduced in: 9.10

protocol.v41_features.pnfs_enabled

boolean

query

False

Filter by protocol.v41_features.pnfs_enabled

protocol.v41_features.write_delegation_enabled

boolean

query

False

Filter by protocol.v41_features.write_delegation_enabled

protocol.v41_features.read_delegation_enabled

boolean

query

False

Filter by protocol.v41_features.read_delegation_enabled

protocol.v41_features.acl_enabled

boolean

query

False

Filter by protocol.v41_features.acl_enabled

protocol.v3_enabled

boolean

query

False

Filter by protocol.v3_enabled

protocol.v40_features.write_delegation_enabled

boolean

query

False

Filter by protocol.v40_features.write_delegation_enabled

protocol.v40_features.acl_enabled

boolean

query

False

Filter by protocol.v40_features.acl_enabled

protocol.v40_features.read_delegation_enabled

boolean

query

False

Filter by protocol.v40_features.read_delegation_enabled

protocol.v3_64bit_identifiers_enabled

boolean

query

False

Filter by protocol.v3_64bit_identifiers_enabled

  • Introduced in: 9.8

protocol.v40_enabled

boolean

query

False

Filter by protocol.v40_enabled

protocol.v4_64bit_identifiers_enabled

boolean

query

False

Filter by protocol.v4_64bit_identifiers_enabled

  • Introduced in: 9.8

protocol.v4_id_domain

string

query

False

Filter by protocol.v4_id_domain

protocol.v41_enabled

boolean

query

False

Filter by protocol.v41_enabled

rquota_enabled

boolean

query

False

Filter by rquota_enabled

  • Introduced in: 9.8

transport.udp_enabled

boolean

query

False

Filter by transport.udp_enabled

transport.tcp_enabled

boolean

query

False

Filter by transport.tcp_enabled

protocol_access_rules.nfs4_access_type

string

query

False

Filter by protocol_access_rules.nfs4_access_type

  • Introduced in: 9.10

protocol_access_rules.nfs3_access_type

string

query

False

Filter by protocol_access_rules.nfs3_access_type

  • Introduced in: 9.10

protocol_access_rules.cifs_access_type

string

query

False

Filter by protocol_access_rules.cifs_access_type

  • Introduced in: 9.10

vstorage_enabled

boolean

query

False

Filter by vstorage_enabled

positive_cached_credential_ttl

integer

query

False

Filter by positive_cached_credential_ttl

  • Introduced in: 9.8

access_cache_config.ttl_positive

integer

query

False

Filter by access_cache_config.ttl_positive

  • Introduced in: 9.10

access_cache_config.harvest_timeout

integer

query

False

Filter by access_cache_config.harvest_timeout

  • Introduced in: 9.10

access_cache_config.isDnsTTLEnabled

boolean

query

False

Filter by access_cache_config.isDnsTTLEnabled

  • Introduced in: 9.10

access_cache_config.ttl_failure

integer

query

False

Filter by access_cache_config.ttl_failure

  • Introduced in: 9.10

access_cache_config.ttl_negative

integer

query

False

Filter by access_cache_config.ttl_negative

  • Introduced in: 9.10

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

showmount_enabled

boolean

query

False

Filter by showmount_enabled

  • Introduced in: 9.8

state

string

query

False

Filter by state

auth_sys_extended_groups_enabled

boolean

query

False

Filter by auth_sys_extended_groups_enabled

  • Introduced in: 9.8

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 NFS Server Records

records

array[nfs_service]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "extended_groups_limit": 32,
      "metric": {
        "v3": {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "duration": "PT15S",
          "iops": {
            "read": 200,
            "total": 1000,
            "write": 100
          },
          "latency": {
            "read": 200,
            "total": 1000,
            "write": 100
          },
          "status": "ok",
          "throughput": {
            "read": 200,
            "total": 1000,
            "write": 100
          },
          "timestamp": "2017-01-25T11:20:13Z"
        },
        "v4": {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "duration": "PT15S",
          "iops": {
            "read": 200,
            "total": 1000,
            "write": 100
          },
          "latency": {
            "read": 200,
            "total": 1000,
            "write": 100
          },
          "status": "ok",
          "throughput": {
            "read": 200,
            "total": 1000,
            "write": 100
          },
          "timestamp": "2017-01-25T11:20:13Z"
        },
        "v41": {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "duration": "PT15S",
          "iops": {
            "read": 200,
            "total": 1000,
            "write": 100
          },
          "latency": {
            "read": 200,
            "total": 1000,
            "write": 100
          },
          "status": "ok",
          "throughput": {
            "read": 200,
            "total": 1000,
            "write": 100
          },
          "timestamp": "2017-01-25T11:20:13Z"
        }
      },
      "positive_cached_credential_ttl": 7200000,
      "protocol": {
        "v4_id_domain": "string"
      },
      "protocol_access_rules": {
        "cifs_access_type": "string",
        "nfs3_access_type": "string",
        "nfs4_access_type": "string"
      },
      "state": "string",
      "statistics": {
        "v3": {
          "iops_raw": {
            "read": 200,
            "total": 1000,
            "write": 100
          },
          "latency_raw": {
            "read": 200,
            "total": 1000,
            "write": 100
          },
          "status": "ok",
          "throughput_raw": {
            "read": 200,
            "total": 1000,
            "write": 100
          },
          "timestamp": "2017-01-25T11:20:13Z"
        },
        "v4": {
          "iops_raw": {
            "read": 200,
            "total": 1000,
            "write": 100
          },
          "latency_raw": {
            "read": 200,
            "total": 1000,
            "write": 100
          },
          "status": "ok",
          "throughput_raw": {
            "read": 200,
            "total": 1000,
            "write": 100
          },
          "timestamp": "2017-01-25T11:20:13Z"
        },
        "v41": {
          "iops_raw": {
            "read": 200,
            "total": 1000,
            "write": 100
          },
          "latency_raw": {
            "read": 200,
            "total": 1000,
            "write": 100
          },
          "status": "ok",
          "throughput_raw": {
            "read": 200,
            "total": 1000,
            "write": 100
          },
          "timestamp": "2017-01-25T11:20:13Z"
        }
      },
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      }
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

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

access_cache_config

Name Type Description

harvest_timeout

integer

Specifies the time after which an entry is deleted from the access cache, if unused.

isDnsTTLEnabled

boolean

Specifies whether Dns TTL is enabled.

ttl_failure

integer

Specifies the time to live value for entries for which a failure was encountered, in seconds.

ttl_negative

integer

Specifies the time to live value of a negative access cache, in seconds.

ttl_positive

integer

Specifies the time to live value of a positive access cache, in seconds.

iops

The rate of I/O operations observed at the storage object.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

latency

The round trip latency in microseconds observed at the storage object.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

throughput

The rate of throughput bytes per second observed at the storage object.

Name Type Description

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

v3

The NFSv3 operations

Name Type Description

_links

_links

duration

string

The duration over which this sample is calculated. The time durations are represented in the ISO-8601 standard format. Samples can be calculated over the following durations:

iops

iops

The rate of I/O operations observed at the storage object.

latency

latency

The round trip latency in microseconds observed at the storage object.

status

string

Any errors associated with the sample. For example, if the aggregation of data over multiple nodes fails then any of the partial errors might be returned, "ok" on success, or "error" on any internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_ delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput

throughput

The rate of throughput bytes per second observed at the storage object.

timestamp

string

The timestamp of the performance data.

v4

The NFSv4 operations

Name Type Description

_links

_links

duration

string

The duration over which this sample is calculated. The time durations are represented in the ISO-8601 standard format. Samples can be calculated over the following durations:

iops

iops

The rate of I/O operations observed at the storage object.

latency

latency

The round trip latency in microseconds observed at the storage object.

status

string

Any errors associated with the sample. For example, if the aggregation of data over multiple nodes fails then any of the partial errors might be returned, "ok" on success, or "error" on any internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_ delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput

throughput

The rate of throughput bytes per second observed at the storage object.

timestamp

string

The timestamp of the performance data.

v41

The NFSv4.1 operations

Name Type Description

_links

_links

duration

string

The duration over which this sample is calculated. The time durations are represented in the ISO-8601 standard format. Samples can be calculated over the following durations:

iops

iops

The rate of I/O operations observed at the storage object.

latency

latency

The round trip latency in microseconds observed at the storage object.

status

string

Any errors associated with the sample. For example, if the aggregation of data over multiple nodes fails then any of the partial errors might be returned, "ok" on success, or "error" on any internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_ delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput

throughput

The rate of throughput bytes per second observed at the storage object.

timestamp

string

The timestamp of the performance data.

metric

Historical performance numbers, such as IOPS latency and throughput, for SVM-NFS protocol.

Name Type Description

v3

v3

The NFSv3 operations

v4

v4

The NFSv4 operations

v41

v41

The NFSv4.1 operations

v40_features

Name Type Description

acl_enabled

boolean

Specifies whether NFSv4.0 ACLs is enabled.

read_delegation_enabled

boolean

Specifies whether NFSv4.0 Read Delegation is enabled.

write_delegation_enabled

boolean

Specifies whether NFSv4.0 Write Delegation is enabled.

v41_features

Name Type Description

acl_enabled

boolean

Specifies whether NFSv4.1 or later ACLs is enabled.

pnfs_enabled

boolean

Specifies whether NFSv4.1 or later Parallel NFS is enabled.

read_delegation_enabled

boolean

Specifies whether NFSv4.1 or later Read Delegation is enabled.

write_delegation_enabled

boolean

Specifies whether NFSv4.1 or later Write Delegation is enabled.

protocol

Name Type Description

v3_64bit_identifiers_enabled

boolean

Specifies whether 64-bit support for NFSv3 FSIDs and file IDs is enabled.

v3_enabled

boolean

Specifies whether NFSv3 protocol is enabled.

v40_enabled

boolean

Specifies whether NFSv4.0 protocol is enabled.

v40_features

v40_features

v41_enabled

boolean

Specifies whether NFSv4.1 or later protocol is enabled.

v41_features

v41_features

v4_64bit_identifiers_enabled

boolean

Specifies whether 64-bit support for NFSv4.x FSIDs and file IDs is enabled.

v4_id_domain

string

Specifies the domain portion of the string form of user and group names as defined by the NFSv4 protocol.

protocol_access_rules

Name Type Description

cifs_access_type

string

Access available for the CIFS protocol.

nfs3_access_type

string

Access available for the NFSv3 protocol.

nfs4_access_type

string

Access available for the NFSv4 protocol.

qtree

Name Type Description

export_enabled

boolean

Specifies whether qtree export is enabled.

validate_export

boolean

Specifies whether qtree export validation is enabled.

iops_raw

The number of I/O operations observed at the storage object. This should be used along with delta time to calculate the rate of I/O operations per unit of time.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

latency_raw

The raw latency in microseconds observed at the storage object. This should be divided by the raw IOPS value to calculate the average latency per I/O operation.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

throughput_raw

Throughput bytes observed at the storage object. This should be used along with delta time to calculate the rate of throughput bytes per unit of time.

Name Type Description

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

v3

The NFSv3 operations

Name Type Description

iops_raw

iops_raw

The number of I/O operations observed at the storage object. This should be used along with delta time to calculate the rate of I/O operations per unit of time.

latency_raw

latency_raw

The raw latency in microseconds observed at the storage object. This should be divided by the raw IOPS value to calculate the average latency per I/O operation.

status

string

Any errors associated with the sample. For example, if the aggregation of data over multiple nodes fails then any of the partial errors might be returned, "ok" on success, or "error" on any internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput_raw

throughput_raw

Throughput bytes observed at the storage object. This should be used along with delta time to calculate the rate of throughput bytes per unit of time.

timestamp

string

The timestamp of the performance data.

v4

The NFSv4 operations

Name Type Description

iops_raw

iops_raw

The number of I/O operations observed at the storage object. This should be used along with delta time to calculate the rate of I/O operations per unit of time.

latency_raw

latency_raw

The raw latency in microseconds observed at the storage object. This should be divided by the raw IOPS value to calculate the average latency per I/O operation.

status

string

Any errors associated with the sample. For example, if the aggregation of data over multiple nodes fails then any of the partial errors might be returned, "ok" on success, or "error" on any internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput_raw

throughput_raw

Throughput bytes observed at the storage object. This should be used along with delta time to calculate the rate of throughput bytes per unit of time.

timestamp

string

The timestamp of the performance data.

v41

The NFSv4.1 operations

Name Type Description

iops_raw

iops_raw

The number of I/O operations observed at the storage object. This should be used along with delta time to calculate the rate of I/O operations per unit of time.

latency_raw

latency_raw

The raw latency in microseconds observed at the storage object. This should be divided by the raw IOPS value to calculate the average latency per I/O operation.

status

string

Any errors associated with the sample. For example, if the aggregation of data over multiple nodes fails then any of the partial errors might be returned, "ok" on success, or "error" on any internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput_raw

throughput_raw

Throughput bytes observed at the storage object. This should be used along with delta time to calculate the rate of throughput bytes per unit of time.

timestamp

string

The timestamp of the performance data.

statistics

Realtime performance numbers, such as IOPS latency and throughput, for SVM-NFS protocol.

Name Type Description

v3

v3

The NFSv3 operations

v4

v4

The NFSv4 operations

v41

v41

The NFSv4.1 operations

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

transport

Name Type Description

tcp_enabled

boolean

Specifies whether TCP transports are enabled on the server.

udp_enabled

boolean

Specifies whether UDP transports are enabled on the server.

nfs_service

Name Type Description

_links

_links

access_cache_config

access_cache_config

auth_sys_extended_groups_enabled

boolean

Specifies whether or not extended groups support over AUTH_SYS is enabled.

enabled

boolean

Specifies if the NFS service is administratively enabled.

extended_groups_limit

integer

Specifies the maximum auxillary groups supported over AUTH_SYS and RPCSEC_GSS.

metric

metric

Historical performance numbers, such as IOPS latency and throughput, for SVM-NFS protocol.

positive_cached_credential_ttl

integer

Specifies the time to live value (in msecs) of a positive cached credential

protocol

protocol

protocol_access_rules

protocol_access_rules

qtree

qtree

rquota_enabled

boolean

Specifies whether or not the remote quota feature is enabled.

showmount_enabled

boolean

Specifies whether or not the showmount feature is enabled.

state

string

Specifies the state of the NFS service on the SVM. The following values are supported: * online - NFS server is ready to accept client requests. * offline - NFS server is not ready to accept client requests.

statistics

statistics

Realtime performance numbers, such as IOPS latency and throughput, for SVM-NFS protocol.

svm

svm

transport

transport

vstorage_enabled

boolean

Specifies whether or not the VMware vstorage feature is enabled.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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.