Set management access config
Set the configuration for one of the system management services.
HTTP request syntax (URI)
PATCH <base_URI>/v8/storage/file-devices/management-access/{type}
Parameters
Name | Type | Required | Values | Description |
type | URI_PARAM | Y | string |
Specifies the management access type. Accepted values are:
|
isEnabled | BODY | N | boolean | Controls whether access to the specific management interface is enabled or not. |
restrictedHosts | BODY | N | boolean | Restrict access to only those hosts in the allowedHosts list. |
isEvsIpAddressAllowed | BODY | N | boolean | Allow access via EVS addresses, in addition to the management addresses. |
port | BODY | N | integer | Port that the specific management interface listens on. |
allowedHosts | BODY | N | list of strings | Specifies a list of hosts allowed to access the specific management interface. The host values can be either IP address or valid DNS names |
maxAllowedConnections | BODY | N | integer | Maximum number of allowed concurrent connections. |
Return codes
Code | Data | Description |
204 | No Data | Management access successfully updated. |
400 | Error Message | Missing or invalid request contents. |
403 | Error Message | Operation forbidden by access level. |
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 1: Restrict SSC access to 2 specific hosts
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/file-devices/management-access/ssc -X PATCH -d '{"allowedHosts":["10.1.2.3", "host1.example.com"], "restrictedHosts":true}'
Response example 1
HTTP/1.1 204 No Content
Request example 2: Set the number of allowed REST API connections to 20
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/file-devices/management-access/rest -X PATCH -d '{"maxAllowedConnections":20}'
Response example 2
HTTP/1.1 204 No Content