Update the boot parameters
put
https://{managementIp}/rest/{version}/configuration/bootparams
Updates the boot parameters. The client making the PUT request must already possess the configuration lock or the request fails. The client should first retrieve the full set of current boot parameters using /configuration/bootparams GET, update the desired parameter(s), then issue the PUT request with the complete set of boot parameters in the request payload.
Request
Path Parameters
-
version(required): string
REST API version string.
Available values: v1.2Allowed Values:[ "v1.2" ]
Header Parameters
-
Authorization(required):
The value in the Authorization header must be the string "
Bearer {access token}
", where{access token}
is a valid, unexpired token received in response to a prior/rest/{version}/auth/token
request.
Supported Media Types
- application/xml
Response
Supported Media Types
- application/xml
200 Response
Boot parameters successfully updated. The updated boot parameters are returned as a series of name-value pairs in the data section of the response.
Nested Schema : links
Type:
object
Nested Schema : messages
Type:
object
400 Response
One or more boot parameter names or values supplied by the client is not valid, or the request is malformed and cannot be processed.
Nested Schema : data
Type:
object
Nested Schema : items
Type:
Show Source
object
-
link: string
If available, a message with possible valid API URL(s) for the client to invokeExample:
Available URL(s) message string
401 Response
Unauthorized - Request lacks valid authentication credentials.
Nested Schema : data
Type:
object
Nested Schema : items
Type:
Show Source
object
-
link: string
If available, a message with possible valid API URL(s) for the client to invokeExample:
Available URL(s) message string
403 Response
This request requires the client credentials to have administrator privileges.
Nested Schema : data
Type:
object
Nested Schema : items
Type:
Show Source
object
-
link: string
If available, a message with possible valid API URL(s) for the client to invokeExample:
Available URL(s) message string
404 Response
Unsupported versionId in URI.
Nested Schema : data
Type:
object
Nested Schema : items
Type:
Show Source
object
-
link: string
If available, a message with possible valid API URL(s) for the client to invokeExample:
Available URL(s) message string
423 Response
The request requires the configuration lock and failed because the client does not currently own the lock. If another client or user currently owns the configuration lock, the error message is "Resource locked by another user". If no client or user owns the configuration lock, the error message is "User does not have the lock".
Nested Schema : data
Type:
object
Nested Schema : items
Type:
Show Source
object
-
link: string
If available, a message with possible valid API URL(s) for the client to invokeExample:
Available URL(s) message string
Examples
Examples of Accessing the API
See Authenticate for how to acquire a token.
The following example shows how to update the boot parameters using curl.
curl -X PUT \
-d@request.xml \
--header "Accept: application/xml" \
--header "Authorization: Bearer $TOKEN" \
"https://${SBCIP}/rest/v1.2/configuration/bootparams"
The following example shows how to update the boot parameters using Python.
import requests
from lxml import etree
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
data = etree.tostring(etree.parse("request.xml"), xml_declaration=True, encoding='utf-8')
url = "https://" + sbcip + "/rest/v1.2/configuration/bootparams"
resp = requests.put(url, headers=headers, data=data)
The following shows an example of the contents of the request.xml
file sent as the request body.
<?xml version="1.0" encoding="UTF-8"?>
<bootparams>
<bootparam>
<name>Target Name</name>
<value>PRIMARY</value>
</bootparam>
</bootparams>
Example of the Response Body
The following example shows the contents of the response body in XML.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
<data>
<bootparams>
<bootparam>
<name>Target Name</name>
<value>PRIMARY</value>
</bootparam>
</bootparams>
</data>
<messages/>
<links/>
</response>