Set NIS LDAP mode for a virtual server
Sets whether LDAP or traditional NIS servers are used to satisfy NIS requests.
Specify a virtual server ID of 0 to ensure the global NIS/LDAP mode is updated. If the virtual server specified has a global security context, then the global NIS/LDAP mode will be updated, otherwise the NIS/LDAP mode will be updated for the specified virtual server.
HTTP request syntax (URI)
PATCH <base_URI>/v8/storage/virtual-servers/{virtualServerId}/name-services/nis-ldap-mode
Parameters
| Name | Type | Required | Values | Description |
| virtualServerId | URI_PARAM | Y | string/number | Specifies either the virtual server object ID or the HNAS storage virtual server ID. |
| isEnabled | BODY | N | boolean | Controls whether NIS/LDAP are enabled or not. |
| mode | BODY | N | string |
Selects which service is used - NIS or LDAP. Accepted values are:
|
Return codes
| Code | Data | Description |
| 204 | No Data | NIS LDAP mode successfully updated. |
| 400 | Error Message | Missing or invalid request contents. |
| 403 | Error Message | Operation forbidden by access level. |
| 404 | Error Message | Requested resource not found. |
| 500 | Error message | Error associated with the storage system. |
Any HTTP status code other than 204 indicates that the API did not complete successfully.
Request example
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/virtual-servers/4/name-services/nis-ldap-mode -X PATCH -d '{"mode":"NIS"}'
Response example
HTTP/1.1 204 No Content