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 computational 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.*

Advanced properties

  • security.rpcsec_context_idle

  • security.ntfs_unix_security

  • security.chown_mode

  • security.nt_acl_display_permission

  • protocol.v3_features.ejukebox_enabled

  • protocol.v3_features.connection_drop

  • protocol.v3_features.fsid_change

  • protocol.v3_features.mount_daemon_port

  • protocol.v3_features.network_lock_manager_port

  • protocol.v3_features.network_status_monitor_port

  • protocol.v3_features.rquota_daemon_port

  • protocol.v3_features.hide_snapshot_enabled

  • protocol.v41_features.implementation_domain

  • protocol.v41_features.implementation_name

  • protocol.v40_features.acl_max_aces

  • windows.map_unknown_uid_to_default_user

  • exports.netgroup_trust_any_nsswitch_no_match

  • credential_cache.negative_ttl

  • transport.tcp_max_transfer_size

  • root.*

  • protocol.v41_features.trunking_enabled

  • protocol.v42_features.seclabel_enabled

  • protocol.v42_features.sparsefile_ops_enabled

  • protocol.v42_features.xattrs_enabled

  • protocol.v40_features.referrals_enabled

  • protocol.v41_features.referrals_enabled

  • protocol.v4_lease_seconds

  • protocol.v4_session_slots

  • protocol.v4_session_slot_reply_cache_size

  • protocol.v4_fsid_change

Diagnostic properties

  • credential_cache.transient_error_ttl

  • access_cache_config.ttl_failure

  • 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

access_cache_config.ttl_negative

integer

query

False

Filter by access_cache_config.ttl_negative

  • 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.ttl_positive

integer

query

False

Filter by access_cache_config.ttl_positive

  • 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.isDnsTTLEnabled

boolean

query

False

Filter by access_cache_config.isDnsTTLEnabled

  • Introduced in: 9.10

file_session_io_grouping_duration

integer

query

False

Filter by file_session_io_grouping_duration

  • Introduced in: 9.11

  • Max value: 600

  • Min value: 60

windows.default_user

string

query

False

Filter by windows.default_user

  • Introduced in: 9.11

windows.v3_ms_dos_client_enabled

boolean

query

False

Filter by windows.v3_ms_dos_client_enabled

  • Introduced in: 9.11

windows.map_unknown_uid_to_default_user

boolean

query

False

Filter by windows.map_unknown_uid_to_default_user

  • Introduced in: 9.11

auth_sys_extended_groups_enabled

boolean

query

False

Filter by auth_sys_extended_groups_enabled

  • Introduced in: 9.8

exports.name_service_lookup_protocol

string

query

False

Filter by exports.name_service_lookup_protocol

  • Introduced in: 9.11

exports.netgroup_trust_any_nsswitch_no_match

boolean

query

False

Filter by exports.netgroup_trust_any_nsswitch_no_match

  • Introduced in: 9.11

statistics.v4.latency_raw.read

integer

query

False

Filter by statistics.v4.latency_raw.read

  • 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.write

integer

query

False

Filter by statistics.v4.latency_raw.write

  • Introduced in: 9.8

statistics.v4.latency_raw.total

integer

query

False

Filter by statistics.v4.latency_raw.total

  • 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.iops_raw.other

integer

query

False

Filter by statistics.v4.iops_raw.other

  • 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.total

integer

query

False

Filter by statistics.v4.iops_raw.total

  • Introduced in: 9.8

statistics.v4.status

string

query

False

Filter by statistics.v4.status

  • Introduced in: 9.8

statistics.v4.timestamp

string

query

False

Filter by statistics.v4.timestamp

  • 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.v4.throughput_raw.read

integer

query

False

Filter by statistics.v4.throughput_raw.read

  • 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.latency_raw.other

integer

query

False

Filter by statistics.v41.latency_raw.other

  • 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.total

integer

query

False

Filter by statistics.v41.latency_raw.total

  • 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.iops_raw.other

integer

query

False

Filter by statistics.v41.iops_raw.other

  • 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.total

integer

query

False

Filter by statistics.v41.iops_raw.total

  • Introduced in: 9.8

statistics.v41.status

string

query

False

Filter by statistics.v41.status

  • Introduced in: 9.8

statistics.v41.timestamp

string

query

False

Filter by statistics.v41.timestamp

  • 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

statistics.v41.throughput_raw.read

integer

query

False

Filter by statistics.v41.throughput_raw.read

  • Introduced in: 9.8

statistics.v3.latency_raw.read

integer

query

False

Filter by statistics.v3.latency_raw.read

  • 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.write

integer

query

False

Filter by statistics.v3.latency_raw.write

  • Introduced in: 9.7

statistics.v3.latency_raw.total

integer

query

False

Filter by statistics.v3.latency_raw.total

  • 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.iops_raw.other

integer

query

False

Filter by statistics.v3.iops_raw.other

  • 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.total

integer

query

False

Filter by statistics.v3.iops_raw.total

  • Introduced in: 9.7

statistics.v3.status

string

query

False

Filter by statistics.v3.status

  • Introduced in: 9.7

statistics.v3.timestamp

string

query

False

Filter by statistics.v3.timestamp

  • 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.v3.throughput_raw.read

integer

query

False

Filter by statistics.v3.throughput_raw.read

  • Introduced in: 9.7

showmount_enabled

boolean

query

False

Filter by showmount_enabled

  • Introduced in: 9.8

file_session_io_grouping_count

integer

query

False

Filter by file_session_io_grouping_count

  • Introduced in: 9.11

  • Max value: 20000

  • Min value: 1000

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

root.ignore_nt_acl

boolean

query

False

Filter by root.ignore_nt_acl

  • Introduced in: 9.11

root.skip_write_permission_check

boolean

query

False

Filter by root.skip_write_permission_check

  • Introduced in: 9.11

transport.tcp_max_transfer_size

integer

query

False

Filter by transport.tcp_max_transfer_size

  • Introduced in: 9.11

  • Max value: 1048576

  • Min value: 8192

transport.rdma_enabled

boolean

query

False

Filter by transport.rdma_enabled

  • Introduced in: 9.12

transport.tcp_enabled

boolean

query

False

Filter by transport.tcp_enabled

transport.udp_enabled

boolean

query

False

Filter by transport.udp_enabled

protocol_access_rules.nfs3_access_type

string

query

False

Filter by protocol_access_rules.nfs3_access_type

  • Introduced in: 9.10

protocol_access_rules.nfs4_access_type

string

query

False

Filter by protocol_access_rules.nfs4_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

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

metric.v4.duration

string

query

False

Filter by metric.v4.duration

  • 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.v4.throughput.read

integer

query

False

Filter by metric.v4.throughput.read

  • Introduced in: 9.8

metric.v4.status

string

query

False

Filter by metric.v4.status

  • Introduced in: 9.8

metric.v4.timestamp

string

query

False

Filter by metric.v4.timestamp

  • Introduced in: 9.8

metric.v4.iops.read

integer

query

False

Filter by metric.v4.iops.read

  • Introduced in: 9.8

metric.v4.iops.other

integer

query

False

Filter by metric.v4.iops.other

  • Introduced in: 9.8

metric.v4.iops.write

integer

query

False

Filter by metric.v4.iops.write

  • Introduced in: 9.8

metric.v4.iops.total

integer

query

False

Filter by metric.v4.iops.total

  • Introduced in: 9.8

metric.v4.latency.read

integer

query

False

Filter by metric.v4.latency.read

  • Introduced in: 9.8

metric.v4.latency.other

integer

query

False

Filter by metric.v4.latency.other

  • Introduced in: 9.8

metric.v4.latency.write

integer

query

False

Filter by metric.v4.latency.write

  • Introduced in: 9.8

metric.v4.latency.total

integer

query

False

Filter by metric.v4.latency.total

  • Introduced in: 9.8

metric.v41.duration

string

query

False

Filter by metric.v41.duration

  • 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

metric.v41.throughput.read

integer

query

False

Filter by metric.v41.throughput.read

  • Introduced in: 9.8

metric.v41.status

string

query

False

Filter by metric.v41.status

  • Introduced in: 9.8

metric.v41.timestamp

string

query

False

Filter by metric.v41.timestamp

  • Introduced in: 9.8

metric.v41.iops.read

integer

query

False

Filter by metric.v41.iops.read

  • Introduced in: 9.8

metric.v41.iops.other

integer

query

False

Filter by metric.v41.iops.other

  • Introduced in: 9.8

metric.v41.iops.write

integer

query

False

Filter by metric.v41.iops.write

  • Introduced in: 9.8

metric.v41.iops.total

integer

query

False

Filter by metric.v41.iops.total

  • Introduced in: 9.8

metric.v41.latency.read

integer

query

False

Filter by metric.v41.latency.read

  • Introduced in: 9.8

metric.v41.latency.other

integer

query

False

Filter by metric.v41.latency.other

  • Introduced in: 9.8

metric.v41.latency.write

integer

query

False

Filter by metric.v41.latency.write

  • Introduced in: 9.8

metric.v41.latency.total

integer

query

False

Filter by metric.v41.latency.total

  • Introduced in: 9.8

metric.v3.duration

string

query

False

Filter by metric.v3.duration

  • 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.v3.throughput.read

integer

query

False

Filter by metric.v3.throughput.read

  • Introduced in: 9.7

metric.v3.status

string

query

False

Filter by metric.v3.status

  • Introduced in: 9.7

metric.v3.timestamp

string

query

False

Filter by metric.v3.timestamp

  • Introduced in: 9.7

metric.v3.iops.read

integer

query

False

Filter by metric.v3.iops.read

  • Introduced in: 9.7

metric.v3.iops.other

integer

query

False

Filter by metric.v3.iops.other

  • Introduced in: 9.7

metric.v3.iops.write

integer

query

False

Filter by metric.v3.iops.write

  • Introduced in: 9.7

metric.v3.iops.total

integer

query

False

Filter by metric.v3.iops.total

  • Introduced in: 9.7

metric.v3.latency.read

integer

query

False

Filter by metric.v3.latency.read

  • Introduced in: 9.7

metric.v3.latency.other

integer

query

False

Filter by metric.v3.latency.other

  • Introduced in: 9.7

metric.v3.latency.write

integer

query

False

Filter by metric.v3.latency.write

  • Introduced in: 9.7

metric.v3.latency.total

integer

query

False

Filter by metric.v3.latency.total

  • Introduced in: 9.7

protocol.v4_session_slot_reply_cache_size

integer

query

False

Filter by protocol.v4_session_slot_reply_cache_size

  • Introduced in: 9.13

  • Max value: 4096

  • Min value: 512

protocol.v4_64bit_identifiers_enabled

boolean

query

False

Filter by protocol.v4_64bit_identifiers_enabled

  • Introduced in: 9.8

protocol.v3_features.connection_drop

boolean

query

False

Filter by protocol.v3_features.connection_drop

  • Introduced in: 9.11

protocol.v3_features.ejukebox_enabled

boolean

query

False

Filter by protocol.v3_features.ejukebox_enabled

  • Introduced in: 9.11

protocol.v3_features.network_status_monitor_port

integer

query

False

Filter by protocol.v3_features.network_status_monitor_port

  • Introduced in: 9.11

protocol.v3_features.mount_daemon_port

integer

query

False

Filter by protocol.v3_features.mount_daemon_port

  • Introduced in: 9.11

protocol.v3_features.hide_snapshot_enabled

boolean

query

False

Filter by protocol.v3_features.hide_snapshot_enabled

  • Introduced in: 9.13

protocol.v3_features.rquota_daemon_port

integer

query

False

Filter by protocol.v3_features.rquota_daemon_port

  • Introduced in: 9.11

protocol.v3_features.mount_root_only

boolean

query

False

Filter by protocol.v3_features.mount_root_only

  • Introduced in: 9.11

protocol.v3_features.network_lock_manager_port

integer

query

False

Filter by protocol.v3_features.network_lock_manager_port

  • Introduced in: 9.11

protocol.v3_features.fsid_change

boolean

query

False

Filter by protocol.v3_features.fsid_change

  • Introduced in: 9.11

protocol.v3_enabled

boolean

query

False

Filter by protocol.v3_enabled

protocol.v41_enabled

boolean

query

False

Filter by protocol.v41_enabled

protocol.v4_lease_seconds

integer

query

False

Filter by protocol.v4_lease_seconds

  • Introduced in: 9.13

protocol.v4_id_domain

string

query

False

Filter by protocol.v4_id_domain

protocol.v41_features.acl_enabled

boolean

query

False

Filter by protocol.v41_features.acl_enabled

protocol.v41_features.pnfs_enabled

boolean

query

False

Filter by protocol.v41_features.pnfs_enabled

protocol.v41_features.read_delegation_enabled

boolean

query

False

Filter by protocol.v41_features.read_delegation_enabled

protocol.v41_features.trunking_enabled

boolean

query

False

Filter by protocol.v41_features.trunking_enabled

  • Introduced in: 9.12

protocol.v41_features.implementation_domain

string

query

False

Filter by protocol.v41_features.implementation_domain

  • Introduced in: 9.11

protocol.v41_features.referrals_enabled

boolean

query

False

Filter by protocol.v41_features.referrals_enabled

  • Introduced in: 9.13

protocol.v41_features.write_delegation_enabled

boolean

query

False

Filter by protocol.v41_features.write_delegation_enabled

protocol.v41_features.implementation_name

string

query

False

Filter by protocol.v41_features.implementation_name

  • Introduced in: 9.11

protocol.v4_session_slots

integer

query

False

Filter by protocol.v4_session_slots

  • Introduced in: 9.13

  • Max value: 2000

  • Min value: 1

protocol.v42_features.sparsefile_ops_enabled

boolean

query

False

Filter by protocol.v42_features.sparsefile_ops_enabled

  • Introduced in: 9.12

protocol.v42_features.seclabel_enabled

boolean

query

False

Filter by protocol.v42_features.seclabel_enabled

  • Introduced in: 9.12

protocol.v42_features.xattrs_enabled

boolean

query

False

Filter by protocol.v42_features.xattrs_enabled

  • Introduced in: 9.12

protocol.v40_features.write_delegation_enabled

boolean

query

False

Filter by protocol.v40_features.write_delegation_enabled

protocol.v40_features.acl_max_aces

integer

query

False

Filter by protocol.v40_features.acl_max_aces

  • Introduced in: 9.11

  • Max value: 1024

  • Min value: 192

protocol.v40_features.referrals_enabled

boolean

query

False

Filter by protocol.v40_features.referrals_enabled

  • Introduced in: 9.13

protocol.v40_features.acl_enabled

boolean

query

False

Filter by protocol.v40_features.acl_enabled

protocol.v40_features.acl_preserve

boolean

query

False

Filter by protocol.v40_features.acl_preserve

  • Introduced in: 9.11

protocol.v40_features.read_delegation_enabled

boolean

query

False

Filter by protocol.v40_features.read_delegation_enabled

protocol.v4_fsid_change

boolean

query

False

Filter by protocol.v4_fsid_change

  • Introduced in: 9.13

protocol.v40_enabled

boolean

query

False

Filter by protocol.v40_enabled

protocol.v3_64bit_identifiers_enabled

boolean

query

False

Filter by protocol.v3_64bit_identifiers_enabled

  • Introduced in: 9.8

protocol.v4_grace_seconds

integer

query

False

Filter by protocol.v4_grace_seconds

  • Introduced in: 9.13

rquota_enabled

boolean

query

False

Filter by rquota_enabled

  • Introduced in: 9.8

state

string

query

False

Filter by state

vstorage_enabled

boolean

query

False

Filter by vstorage_enabled

security.permitted_encryption_types

string

query

False

Filter by security.permitted_encryption_types

  • Introduced in: 9.11

security.chown_mode

string

query

False

Filter by security.chown_mode

  • Introduced in: 9.11

security.ntfs_unix_security

string

query

False

Filter by security.ntfs_unix_security

  • Introduced in: 9.11

security.nt_acl_display_permission

boolean

query

False

Filter by security.nt_acl_display_permission

  • Introduced in: 9.11

security.rpcsec_context_idle

integer

query

False

Filter by security.rpcsec_context_idle

  • Introduced in: 9.11

extended_groups_limit

integer

query

False

Filter by extended_groups_limit

  • Introduced in: 9.8

  • Max value: 1024

  • Min value: 32

enabled

boolean

query

False

Filter by enabled

credential_cache.positive_ttl

integer

query

False

Filter by credential_cache.positive_ttl

  • Introduced in: 9.11

  • Max value: 604800000

  • Min value: 60000

credential_cache.transient_error_ttl

integer

query

False

Filter by credential_cache.transient_error_ttl

  • Introduced in: 9.11

  • Max value: 300000

  • Min value: 30000

credential_cache.negative_ttl

integer

query

False

Filter by credential_cache.negative_ttl

  • Introduced in: 9.11

  • Max value: 604800000

  • Min value: 60000

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"
    }
  },
  "num_records": 1,
  "records": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "credential_cache": {
      "negative_ttl": 7200000,
      "positive_ttl": 7200000,
      "transient_error_ttl": 72000
    },
    "exports": {
      "name_service_lookup_protocol": "tcp"
    },
    "extended_groups_limit": 32,
    "file_session_io_grouping_count": 5000,
    "file_session_io_grouping_duration": 120,
    "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-25 06:20:13 -0500"
      },
      "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-25 06:20:13 -0500"
      },
      "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-25 06:20:13 -0500"
      }
    },
    "protocol": {
      "v40_features": {
        "acl_max_aces": 500
      }
    },
    "protocol_access_rules": {
      "cifs_access_type": "read",
      "nfs3_access_type": "read",
      "nfs4_access_type": "read"
    },
    "security": {
      "chown_mode": "restricted",
      "ntfs_unix_security": "ignore",
      "permitted_encryption_types": {
      }
    },
    "state": "online",
    "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-25 06:20:13 -0500"
      },
      "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-25 06:20:13 -0500"
      },
      "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-25 06:20:13 -0500"
      }
    },
    "svm": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "svm1",
      "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
    },
    "transport": {
      "tcp_max_transfer_size": 16384
    }
  }
}

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.

credential_cache

Name Type Description

negative_ttl

integer

Specifies the age in milliseconds, of the negative cached credentials after which they are cleared from the cache.

positive_ttl

integer

Specifies the age in milliseconds, of the positive cached credentials after which they are cleared from the cache.

transient_error_ttl

integer

Specifies the age in milliseconds, of the cached entries during a transient error situation.

exports

Name Type Description

name_service_lookup_protocol

string

Specifies the protocol to use for doing name service lookups.

netgroup_trust_any_nsswitch_no_match

boolean

Specifies if you can consider a no-match result from any of the netgroup ns-switch sources to be authoritative. If this option is enabled, then a no-match response from any of the netgroup ns-switch sources is deemed conclusive even if other sources could not be searched.

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

v3_features

Name Type Description

connection_drop

boolean

Specfies whether the dropping of a connection when an NFSv3 request is dropped is enabled.

ejukebox_enabled

boolean

Specifies whether NFSv3 EJUKEBOX error is enabled.

fsid_change

boolean

Specifies whether the change in FSID as NFSv3 clients traverse filesystems should be shown.

hide_snapshot_enabled

boolean

Specifies whether hiding a Snapshot copy directory under a NFSv3 mount point is enabled.

mount_daemon_port

integer

Specifies which port the NFS mount daemon (mountd) uses.

mount_root_only

boolean

Specifies whether the SVM allows MOUNT protocol calls only from privileged ports (port numbers less than 1024).

network_lock_manager_port

integer

Specifies which port the Network lock manager uses.

network_status_monitor_port

integer

Specifies which port the Network status monitor port uses.

rquota_daemon_port

integer

Specifies which port the NFS quota daemon port uses.

v40_features

Name Type Description

acl_enabled

boolean

Specifies whether NFSv4.0 ACLs is enabled.

acl_max_aces

integer

Specifies the maximum number of aces in a NFSv4.0 ACL.

acl_preserve

boolean

Specifies if the NFSv4 ACL is preserved or dropped when chmod is performed. In unified security style, this parameter also specifies if NTFS file permissions are preserved or dropped when chmod, chgrp, or chown are performed.

read_delegation_enabled

boolean

Specifies whether NFSv4.0 Read Delegation is enabled.

referrals_enabled

boolean

Specifies whether NFSv4.0 referrals 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.

implementation_domain

string

Specifies the NFSv4.1 or later implementation ID domain.

implementation_name

string

Specifies the NFSv4.1 or later implementation ID name.

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.

referrals_enabled

boolean

Specifies whether NFSv4.1 referrals is enabled.

trunking_enabled

boolean

Specifies whether NFSv4.1 or later trunking is enabled.

write_delegation_enabled

boolean

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

v42_features

Name Type Description

seclabel_enabled

boolean

Specifies whether NFSv4.2 or later security label is enabled.

sparsefile_ops_enabled

boolean

Specifies whether NFSv4.2 or later sparsefile operation is enabled.

xattrs_enabled

boolean

Specifies whether NFSv4.2 or later extended attributes 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.

v3_features

v3_features

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

v42_features

v42_features

v4_64bit_identifiers_enabled

boolean

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

v4_fsid_change

boolean

Specifies whether the change in FSID when NFSv4 clients traverse file systems is displayed.

v4_grace_seconds

integer

Specifies the grace period for clients to reclaim file locks after a server failure.

v4_id_domain

string

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

v4_lease_seconds

integer

Specifies the lease seconds of the NFSv4 clients. If it is inactive for more than the time displayed, all of the file lock states on a node might be lost.

v4_session_slot_reply_cache_size

integer

Specifies the number of bytes of the reply that is cached in each NFSv4.x session slot.

v4_session_slots

integer

Specifies the number of entries in NFSv4.x session slot table.

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.

root

Name Type Description

ignore_nt_acl

boolean

Specifies whether Windows ACLs affect root access from NFS. If this option is enabled, root access from NFS ignores the NT ACL set on the file or directory.

skip_write_permission_check

boolean

Specifies if permission checks are to be skipped for NFS WRITE calls from root/owner. For copying read-only files to a destination folder which has inheritable ACLs, this option must be enabled.

security

Name Type Description

chown_mode

string

Specifies whether file ownership can be changed only by the superuser, or if a non-root user can also change file ownership. If you set this parameter to restricted, file ownership can be changed only by the superuser, even though the on-disk permissions allow a non-root user to change file ownership. If you set this parameter to unrestricted, file ownership can be changed by the superuser and by the non-root user, depending upon the access granted by on-disk permissions. If you set this parameter to use-export-policy, file ownership can be changed in accordance with the relevant export rules.

nt_acl_display_permission

boolean

Controls the permissions that are displayed to NFSv3 and NFSv4 clients on a file or directory that has an NT ACL set. When true, the displayed permissions are based on the maximum access granted by the NT ACL to any user. When false, the displayed permissions are based on the minimum access granted by the NT ACL to any user.

ntfs_unix_security

string

Specifies how NFSv3 security changes affect NTFS volumes. If you set this parameter to ignore, ONTAP ignores NFSv3 security changes. If you set this parameter to fail, this overrides the UNIX security options set in the relevant export rules. If you set this parameter to use_export_policy, ONTAP processes NFSv3 security changes in accordance with the relevant export rules.

  • Default value: 1

  • enum: ["ignore", "fail", "use_export_policy"]

  • Introduced in: 9.11

  • x-nullable: true

permitted_encryption_types

array[string]

Specifies the permitted encryption types for Kerberos over NFS.

rpcsec_context_idle

integer

Specifies, in seconds, the amount of time a RPCSEC_GSS context is permitted to remain unused before it is deleted.

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

rdma_enabled

boolean

Specifies whether RDMA transport is enabled for the NFS server.

tcp_enabled

boolean

Specifies whether TCP transports are enabled on the server.

tcp_max_transfer_size

integer

Specifies the maximum transfer size in bytes, that the storage system negotiates with the client for TCP transport of data for NFSv3 and NFSv4.x protocols. The range is 8192 to 1048576.

udp_enabled

boolean

Specifies whether UDP transports are enabled on the server.

windows

Name Type Description

default_user

string

Specifies the default Windows user for the NFS server.

map_unknown_uid_to_default_user

boolean

Specifies whether or not the mapping of an unknown UID to the default Windows user is enabled.

v3_ms_dos_client_enabled

boolean

Specifies whether NFSv3 MS-DOS client support is enabled.

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.

credential_cache

credential_cache

enabled

boolean

Specifies if the NFS service is administratively enabled.

exports

exports

extended_groups_limit

integer

Specifies the maximum auxiliary groups supported over AUTH_SYS and RPCSEC_GSS.

file_session_io_grouping_count

integer

Number of I/O operations on a file to be grouped and considered as one session for event generation applications, such as FPolicy.

file_session_io_grouping_duration

integer

The duration for which I/O operations on a file will be grouped and considered as one session for event generation applications, such as FPolicy.

metric

metric

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

protocol

protocol

protocol_access_rules

protocol_access_rules

qtree

qtree

root

root

rquota_enabled

boolean

Specifies whether or not the remote quota feature is enabled.

security

security

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.

windows

windows

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.