HP OneView REST API Reference

appliance/settings
appliance-settings.html[10/17/2013 10:35:52 AM]
Updated: October 16, 2013 4:20
MDT
API Specifications Create Read Update Delete
/rest/appliance/settings/enableServiceAccess PUT
/rest/appliance/settings/serviceaccess GET
HP OneView REST API Reference
appliance/settings
This API allows to disable or enable services access (i.e. root shell access) for emergency troubleshooting purposes by
Authorized support access Personnel, get service access status information.
URI: /rest/appliance/settings/enableServiceAccess
Method API
PUT This API is used to disable or enable services access (i.e. root shell access) for emergency
troubleshooting purposes by Authorized support access Personnel.
Request
Header
Attributes Description
REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the
current release, this must be set to "X-API-Version:3"
Request
Body
Attributes Description
boolean Required true to enable or false to disable service access
Response Description
boolean true if changed successfully
Response Codes
REST API Response Codes
Examples
PUT https://example.com/rest/appliance/settings/enableServiceAccess
ex: Enable Service Access
https://example.com/rest/appliance/settings/enableServiceAccess
Request Body - true
ex: Disable Service Access
https://example.com/rest/appliance/settings/enableServiceAccess
Request Body - false
URI: /rest/appliance/settings/serviceaccess