1. REST API for Session Border Controller, Enterprise Session Border Controller, and Subscriber-Aware Load Balancer, Release 8.4.0
  2. Tasks
  3. configuration

Get the boot parameters

get

/rest/{version}/configuration/bootparams

Retrieves the boot parameters.

Request

Path Parameters
  • REST API version string.
    Available values: v1.2
Header Parameters
  • 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.
Back to Top

Response

200 Response

The boot parameters are returned as a series of name-value pairs in the data section of the response.

400 Response

The request is malformed in some way or is missing required information and therefore cannot be processed.

401 Response

Unauthorized - Request lacks valid authentication credentials.

404 Response

Unsupported versionId in URI.
Back to Top

Examples

Example of Accessing the API with cURL

The following example shows how to get the boot parameters by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. 

curl -X GET \
    --header "Accept: application/xml" \
    --header "Authorization: Bearer $TOKEN" \
    "https://${SBCIP}/rest/v1.1/configuration/bootparams"

Example of Accessing the API with Python

The following example shows how to get the boot parameters by submitting a GET request on the REST resource using Python. This example assumes you have a valid token stored in the token variable. For an example of authenticating with Python, see Authenticate. 

import requests
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url  = "https://" + sbcip + "/rest/v1.1/configuration/bootparams"
resp = requests.get(url, headers=headers)

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 200
Server: nginx/1.14.1
Date: Wed, 01 Apr 2020 13:37:01 GMT
Content-Type: application/xml
Transfer-Encoding: chunked
Connection: keep-alive

Example of the Response Body

The following example shows the contents of the response body in XML format.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
  <data>
    <bootparams>
      <bootparam>
        <name>Boot File</name>
        <value>/boot/bzImage</value>
      </bootparam>
      <bootparam>
        <name>IP Address</name>
        <value>${SBCIP}</value>
      </bootparam>
      <bootparam>
        <name>VLAN</name>
        <value/>
      </bootparam>
      ...
      <bootparam>
        <name>Target Name</name>
        <value>ORACLE</value>
      </bootparam>
      <bootparam>
        <name>Console Device</name>
        <value>VGA</value>
      </bootparam>
      <bootparam>
        <name>Console Baudrate</name>
        <value>115200</value>
      </bootparam>
      <bootparam>
        <name>Other</name>
        <value/>
      </bootparam>
    </bootparams>
  </data>
  <messages/>
  <links/>
</response>
Back to Top