Endpoint

/v2/nfs/settings

GET

Retrieve current NFS server configuration.

Parameters

This resource has no parameters.

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

Modify current NFS server configuration.

Parameters

This resource has no parameters.

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"
    }
  }
}

PATCH

Modify current NFS server configuration.

Parameters

This resource has no parameters.

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"
    }
  }
}