REST endpoints: NAS servers

These endpoints mirror the CLI commands described in NAS servers, Local admins. Each endpoint runs the CLI command named under its heading, so the behavior, defaults, and restrictions are the same; this page lists how to call it over REST.

Conventions that apply to every endpoint (request format, the async and outputType parameters, and the response envelope) are in Requests and responses. In the tables below, Required is Yes when the parameter must always be supplied, No when it is optional, and Depends when it is required only in some combinations (for example, either an application and volume, or a consistency group ID); the CLI chapter for the same command explains the combinations.

POST /nas_servers/active_directory/local_admins/add

Add a local admin.

CLI command: nas_servers active_directory local_admins add

Body fields (JSON)

Name	Type	Required	Description
Name	string	Yes	The name of the local admin to add.

DELETE /nas_servers/active_directory/local_admins/delete

Delete a local admin.

CLI command: nas_servers active_directory local_admins delete

Query parameters

Name	Type	Required	Description
name	string	Yes	The name of the local admin to delete.
force	boolean	No	Skip the confirmation prompt.

GET /nas_servers/active_directory/local_admins/list

List local admins.

CLI command: nas_servers active_directory local_admins list

This endpoint takes no parameters.

Response: a list of LocalAdminElement objects in Result.

GET /nas_servers/active_directory/test_join

Test if NAS server is correctly joined to Active Directory.

CLI command: nas_servers active_directory test_join

This endpoint takes no parameters.

Response: the command output, in the format selected by outputType.

POST /nas_servers/create

Create a NAS server.

CLI command: nas_servers create

Body fields (JSON)

Name	Type	Required	Description
Name	string	Yes	The NetBIOS name of the new NAS server.
FloatingIps	array of string	Yes	Floating IPs to use for this NAS server.
Workgroup	boolean	Depends	Use SMB in Workgroup mode.
ActiveDirectory	boolean	Depends	Use SMB in Active Directory mode.
WorkgroupName	string	Yes	The name of the workgroup the NAS server will reside on.
ActiveDirectoryRealm	string	Depends	The name of the Active Directory realm which the NAS server will authenticate with.
ActiveDirectoryUsername	string	Depends	Username of the user that will authenticate with the Active Directory.
ActiveDirectoryPassword	string	Depends	Password for the user that will authenticate with the Active Directory.
NfsNoAuth	boolean	Depends	Use NFS without authentication.
NfsSameActiveDirectoryAsSmb	boolean	Depends	Use NFS in Active Directory mode, with the same AD configured for SMB.
NfsNonActiveDirectory	boolean	Depends	Use NFS with Non-Active Directory authentication.
NfsNonAdDomainName	string	Depends	Domain name for Non-Active Directory authentication.
NfsKerberosRealmName	string	Depends	Kerberos realm name for Non-Active Directory authentication.
NfsKerberosKdc	string	Depends	Kerberos key distribution center for Non-Active Directory authentication.
NfsKerberosAdminServer	string	Depends	Kerberos administration server for Non-Active Directory authentication.
NfsKerberosUsername	string	Depends	Kerberos username for Non-Active Directory authentication.
NfsKerberosPassword	string	Depends	Kerberos password for Non-Active Directory authentication.
NfsLdapQueriesUri	string	Depends	LDAP queries URI for Non-Active Directory authentication.
NfsLdapBaseSearchPath	string	Depends	LDAP base search path for Non-Active Directory authentication.
NfsLdapUsername	string	Depends	LDAP username for Non-Active Directory authentication.
NfsLdapPassword	string	Depends	LDAP password for Non-Active Directory authentication.
NfsKerberosAuthenticationOptional	boolean	Depends	Kerberos authentication and encryption are optional, and based on the client mount settings.
NfsKerberosAuthenticationRequired	boolean	Depends	Kerberos authentication is required.
NfsKerberosAuthenticationAndEncryptionRequired	boolean	Depends	Kerberos authentication and encryption are required.
NisDomain	string	No	The NIS (Network Information Service) domain to connect to.
NisServer	string	No	NIS server IP address or hostname.
Force	boolean	No	Skip the confirmation prompt (including overwriting an existing Active Directory computer object with the same name).

DELETE /nas_servers/delete

Delete a NAS server.

CLI command: nas_servers delete

Query parameters

Name	Type	Required	Description
name	string	Yes	The name of the NAS server to delete.
force	boolean	No	Skip the confirmation prompt.

PUT /nas_servers/edit

Edit a NAS server.

CLI command: nas_servers edit

Query parameters

Name	Type	Required	Description
name	string	Yes	The name of the NAS server to edit.

Body fields (JSON)

Name	Type	Required	Description
Name	string	Yes	The name of the NAS server to edit.
FloatingIps	array of string	No	Floating IPs to use for this NAS server.
Workgroup	boolean	Depends	Use SMB in Workgroup mode.
ActiveDirectory	boolean	Depends	Use SMB in Active Directory mode.
WorkgroupName	string	No	The name of the workgroup the NAS server will reside on.
ActiveDirectoryRealm	string	No	The name of the Active Directory realm which the NAS server will authenticate with.
ActiveDirectoryUsername	string	No	Username of the user that will authenticate with the Active Directory.
ActiveDirectoryPassword	string	No	Password for the user that will authenticate with the Active Directory.
NfsNoAuth	boolean	No	Use NFS without authentication.
NfsSameActiveDirectoryAsSmb	boolean	No	Use NFS in Active Directory mode, with the same AD configured for SMB.
NfsNonActiveDirectory	boolean	No	Use NFS with Non-Active Directory authentication.
NfsNonAdDomainName	string	No	Domain name for Non-Active Directory authentication.
NfsKerberosRealmName	string	No	Kerberos realm name for Non-Active Directory authentication.
NfsKerberosKdc	string	No	Kerberos key distribution center for Non-Active Directory authentication.
NfsKerberosAdminServer	string	No	Kerberos administration server for Non-Active Directory authentication.
NfsKerberosUsername	string	No	Kerberos username for Non-Active Directory authentication.
NfsKerberosPassword	string	No	Kerberos password for Non-Active Directory authentication.
NfsLdapQueriesUri	string	No	LDAP queries URI for Non-Active Directory authentication.
NfsLdapBaseSearchPath	string	No	LDAP base search path for Non-Active Directory authentication.
NfsLdapUsername	string	No	LDAP username for Non-Active Directory authentication.
NfsLdapPassword	string	No	LDAP password for Non-Active Directory authentication.
NfsKerberosAuthenticationOptional	boolean	No	Kerberos authentication and encryption are optional, and based on the client mount settings.
NfsKerberosAuthenticationRequired	boolean	No	Kerberos authentication is required.
NfsKerberosAuthenticationAndEncryptionRequired	boolean	No	Kerberos authentication and encryption are required.
DisableNis	boolean	No	Disable usage of network information service.
NisDomain	string	No	The NIS (Network Information Service) domain to connect to.
NisServer	string	No	NIS server IP address or hostname.
Force	boolean	No	Skip the confirmation prompt (including overwriting an existing Active Directory computer object with the same name).

GET /nas_servers/list

List NAS servers.

CLI command: nas_servers list

This endpoint takes no parameters.

Response: a list of NasServerElement objects in Result.NASServers, each with: Name (string), FloatingIps (array of string), Workgroup (boolean), WorkgroupName (string), ActiveDirectory (boolean), ActiveDirectoryRealm (string), ActiveDirectoryUsername (string), ActiveDirectoryPassword (string), Force (boolean), NfsNoAuth (boolean), NfsSameActiveDirectoryAsSmb (boolean), NfsNonActiveDirectory (boolean), NfsNonAdDomainName (string), NfsKerberosRealmName (string), NfsKerberosKdc (string), NfsKerberosAdminServer (string), NfsKerberosUsername (string), NfsKerberosPassword (string), NfsLdapQueriesUri (string), NfsLdapBaseSearchPath (string), NfsLdapUsername (string), NfsLdapPassword (string), NfsKerberosAuthenticationOptional (boolean), NfsKerberosAuthenticationRequired (boolean), NfsKerberosAuthenticationAndEncryptionRequired (boolean), DisableNis (boolean), NisServer (string), NisDomain (string), DisableAutoRid (boolean).

---

See also: Requests and responses - Authentication - Examples