/v1/multitenancy/nfs/settings/{id} | Qumulo Documentation Portal

Endpoint

/v1/multitenancy/nfs/settings/{id}

GET

Retrieve current tenant-specific NFS configuration.

Important
This preview REST API is under development. Its functionality or backwards compatibility can change without notice.

Parameters

Name	Description	Required
`id`	The tenant ID of the NFS settings.	Yes

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_nfs_settings",
  "type": "object",
  "properties": {
    "v4_enabled": {
      "description": "Whether NFSv4 is enabled",
      "type": "boolean"
    },
    "krb5_enabled": {
      "description": "Whether Kerberos5 is enabled",
      "type": "boolean"
    },
    "krb5p_enabled": {
      "description": "Whether Kerberos5p (privacy) is enabled",
      "type": "boolean"
    },
    "krb5i_enabled": {
      "description": "Whether Kerberos5i (integrity) is enabled",
      "type": "boolean"
    },
    "auth_sys_enabled": {
      "description": "Whether AUTH_SYS is enabled",
      "type": "boolean"
    },
    "idmap_domain": {
      "description": "The domain used for mapping NFSv4 string identities. The value must match what idmapd on the clients expects for correct name resolution.",
      "type": "string"
    }
  }
}

PUT

Set current tenant-specific NFS configuration.

Important
This preview REST API is under development. Its functionality or backwards compatibility can change without notice.

Parameters

Name	Description	Required
`id`	The tenant ID of the NFS settings.	Yes
`If-Match`	ETag for expected version	No

Request

Schema

{
  "description": "api_nfs_settings",
  "type": "object",
  "properties": {
    "v4_enabled": {
      "description": "Whether NFSv4 is enabled",
      "type": "boolean"
    },
    "krb5_enabled": {
      "description": "Whether Kerberos5 is enabled",
      "type": "boolean"
    },
    "krb5p_enabled": {
      "description": "Whether Kerberos5p (privacy) is enabled",
      "type": "boolean"
    },
    "krb5i_enabled": {
      "description": "Whether Kerberos5i (integrity) is enabled",
      "type": "boolean"
    },
    "auth_sys_enabled": {
      "description": "Whether AUTH_SYS is enabled",
      "type": "boolean"
    },
    "idmap_domain": {
      "description": "The domain used for mapping NFSv4 string identities. The value must match what idmapd on the clients expects for correct name resolution.",
      "type": "string"
    }
  }
}

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_nfs_settings",
  "type": "object",
  "properties": {
    "v4_enabled": {
      "description": "Whether NFSv4 is enabled",
      "type": "boolean"
    },
    "krb5_enabled": {
      "description": "Whether Kerberos5 is enabled",
      "type": "boolean"
    },
    "krb5p_enabled": {
      "description": "Whether Kerberos5p (privacy) is enabled",
      "type": "boolean"
    },
    "krb5i_enabled": {
      "description": "Whether Kerberos5i (integrity) is enabled",
      "type": "boolean"
    },
    "auth_sys_enabled": {
      "description": "Whether AUTH_SYS is enabled",
      "type": "boolean"
    },
    "idmap_domain": {
      "description": "The domain used for mapping NFSv4 string identities. The value must match what idmapd on the clients expects for correct name resolution.",
      "type": "string"
    }
  }
}

DELETE

Delete current NFS configuration, restoring the global settings for this tenant.

Important
This preview REST API is under development. Its functionality or backwards compatibility can change without notice.

Parameters

Name	Description	Required
`id`	The tenant ID of the NFS settings.	Yes
`If-Match`	ETag for expected version	No

Response

Codes

Code	Description
200	Return value on success

PATCH

Modify current tenant-specific NFS configuration.

Important
This preview REST API is under development. Its functionality or backwards compatibility can change without notice.

Parameters

Name	Description	Required
`id`	The tenant ID of the NFS settings.	Yes
`If-Match`	ETag for expected version	No

Request

Schema

{
  "description": "api_nfs_settings_patch",
  "type": "object",
  "properties": {
    "v4_enabled": {
      "description": "Whether NFSv4 is enabled",
      "type": "boolean"
    },
    "krb5_enabled": {
      "description": "Whether Kerberos5 is enabled",
      "type": "boolean"
    },
    "krb5p_enabled": {
      "description": "Whether Kerberos5p (privacy) is enabled",
      "type": "boolean"
    },
    "krb5i_enabled": {
      "description": "Whether Kerberos5i (integrity) is enabled",
      "type": "boolean"
    },
    "auth_sys_enabled": {
      "description": "Whether AUTH_SYS is enabled",
      "type": "boolean"
    },
    "idmap_domain": {
      "description": "The domain used for mapping NFSv4 string identities. The value must match what idmapd on the clients expects for correct name resolution.",
      "type": "string"
    }
  }
}

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_nfs_settings",
  "type": "object",
  "properties": {
    "v4_enabled": {
      "description": "Whether NFSv4 is enabled",
      "type": "boolean"
    },
    "krb5_enabled": {
      "description": "Whether Kerberos5 is enabled",
      "type": "boolean"
    },
    "krb5p_enabled": {
      "description": "Whether Kerberos5p (privacy) is enabled",
      "type": "boolean"
    },
    "krb5i_enabled": {
      "description": "Whether Kerberos5i (integrity) is enabled",
      "type": "boolean"
    },
    "auth_sys_enabled": {
      "description": "Whether AUTH_SYS is enabled",
      "type": "boolean"
    },
    "idmap_domain": {
      "description": "The domain used for mapping NFSv4 string identities. The value must match what idmapd on the clients expects for correct name resolution.",
      "type": "string"
    }
  }
}