1. REST API for Session Border Controller Release 8.2
  2. Tasks
  3. configuration

Get the boot parameters

get

/rest/{version}/configuration/bootparams

Retrieves the boot parameters.

Request

Path Parameters
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 /auth/token request.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The boot parameters are returned as a series of name-value pairs in the data section of the response.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Show Source
Nested Schema : messages
Type: object
Nested Schema : bootparams
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : NameValuePair
Type: object
Show Source

400 Response

The request is malformed or missing required information.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: object
Show Source

401 Response

The client is not authorized.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: object
Show Source

404 Response

Unsupported versionId in URI.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: object
Show Source
Back to Top

Examples

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://10.0.0.2/rest/v1.0/configuration/bootparams'

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Tue, 07 Aug 2018 15:42:20 GMT
Cache-Control: no-cache
Content-Length: 1392
Content-Type: application/xml
Connection: keep-alive
Keep-Alive: timeout=60, max=99
Last-Modified: Tue, 07 Aug 2018 15:42:20 GMT
X-Appweb-Seq: 2

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>10.0.0.1</value>
      </bootparam>
      <bootparam>
        <name>VLAN</name>
        <value/>
      </bootparam>
      <bootparam>
        <name>Netmask</name>
        <value>255.255.255.0</value>
      </bootparam>
      <bootparam>
        <name>Gateway</name>
        <value>10.0.0.10</value>
      </bootparam>
      <bootparam>
        <name>IPv6 Address</name>
        <value/>
      </bootparam>
      <bootparam>
        <name>IPv6 Gateway</name>
        <value/>
      </bootparam>
      <bootparam>
        <name>FTP Host IP</name>
        <value/>
      </bootparam>
      <bootparam>
        <name>FTP username</name>
        <value/>
      </bootparam>
      <bootparam>
        <name>FTP password</name>
        <value/>
      </bootparam>
      <bootparam>
        <name>Flags</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