Overview

The documentation pages in this section describe the RESTful APIs included with Riverbed SteelCentral Product. It is assumed that the reader has practical knowledge of RESTful APIs, so the documentation does not go into detail about what REST is and how to use it. Instead the documentation focuses on what data can be accessed, how to configure it.

The following operations can be performed via the API:

Display BMC settings
Configure BMC settings

Details about REST resources can be found in the Resources section. This overview continues with how to run these API's.

Authentication

All REST requests must be authenticated. The Authentication section of the Common API describes which authentication methods are presently supported.

Resources

Settings: Display Settings

Displays BMC settings.

GET https://{device}/api/mgmt.bmc_settings/1.0/access_settings

Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

JSON

{
  "address": [
    {
      "host": string,
      "label": string,
      "mode": string,
      "ipaddr": string,
      "netmask": string,
      "gtway": string
    }
  ],
  "credentials": [
    {
      "user": string,
      "pswd": string
    }
  ]
}

Example:
{
  "address": [
    {
      "host": "netprofiler-Blade0", 
      "label": "uihost", 
      "mode": "none", 
      "ipaddr": "0.0.0.0", 
      "netmask": "0.0.0.0", 
      "gtway": "0.0.0.0"
    }, 
    {
      "host": "netprofiler-Blade1", 
      "label": "dahost1", 
      "mode": "static", 
      "ipaddr": "192.168.10.111", 
      "netmask": "255.255.255.0", 
      "gtway": "0.0.0.0"
    }
  ], 
  "credentials": [
    {
      "user": "root", 
      "pswd": "haha"
    }, 
    {
      "user": "god", 
      "pswd": "x"
    }
  ]
}

{
  "address": [
    {
      "host": string,
      "label": string,
      "mode": string,
      "ipaddr": string,
      "netmask": string,
      "gtway": string
    }
  ],
  "credentials": [
    {
      "user": string,
      "pswd": string
    }
  ]
}

Example:
{
  "address": [
    {
      "host": "netprofiler-Blade0", 
      "label": "uihost", 
      "mode": "none", 
      "ipaddr": "0.0.0.0", 
      "netmask": "0.0.0.0", 
      "gtway": "0.0.0.0"
    }, 
    {
      "host": "netprofiler-Blade1", 
      "label": "dahost1", 
      "mode": "static", 
      "ipaddr": "192.168.10.111", 
      "netmask": "255.255.255.0", 
      "gtway": "0.0.0.0"
    }
  ], 
  "credentials": [
    {
      "user": "root", 
      "pswd": "haha"
    }, 
    {
      "user": "god", 
      "pswd": "x"
    }
  ]
}

Property Name	Type	Description
CurrentSettings	<object>	List addresses and credentials for BMC.
CurrentSettings.address	<array of <object>>	List of BMC addresses.
CurrentSettings.address[item]	<object>	Address of BMC.
CurrentSettings.address[item].host	<string>	Current host
CurrentSettings.address[item].label	<string>	label of current host
CurrentSettings.address[item].mode	<string>	mode of address
CurrentSettings.address[item].ipaddr	<string>	IP Address of the BMC
CurrentSettings.address[item].netmask	<string>	netmask of the BMC
CurrentSettings.address[item].gtway	<string>	gateway of the BMC
CurrentSettings.credentials	<array of <object>>	List of BMC credentials.
CurrentSettings.credentials[item]	<object>	credential for BMC.
CurrentSettings.credentials[item].user	<string>	username for BMC
CurrentSettings.credentials[item].pswd	<string>	password for BMC

Settings: Configure Settings

Configures BMC settings.

POST https://{device}/api/mgmt.bmc_settings/1.0/access_settings

Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

JSON

{
  "address": [
    {
      "host": string,
      "label": string,
      "mode": string,
      "ipaddr": string,
      "netmask": string,
      "gtway": string
    }
  ],
  "credentials": [
    {
      "user": string,
      "pswd": string
    }
  ]
}

Example:
{
  "address": [
    {
      "host": "netprofiler-Blade0", 
      "label": "uihost", 
      "mode": "none", 
      "ipaddr": "0.0.0.0", 
      "netmask": "0.0.0.0", 
      "gtway": "0.0.0.0"
    }, 
    {
      "host": "netprofiler-Blade1", 
      "label": "dahost1", 
      "mode": "static", 
      "ipaddr": "192.168.10.111", 
      "netmask": "255.255.255.0", 
      "gtway": "0.0.0.0"
    }
  ], 
  "credentials": [
    {
      "user": "root", 
      "pswd": "haha"
    }, 
    {
      "user": "god", 
      "pswd": "x"
    }
  ]
}

{
  "address": [
    {
      "host": string,
      "label": string,
      "mode": string,
      "ipaddr": string,
      "netmask": string,
      "gtway": string
    }
  ],
  "credentials": [
    {
      "user": string,
      "pswd": string
    }
  ]
}

Example:
{
  "address": [
    {
      "host": "netprofiler-Blade0", 
      "label": "uihost", 
      "mode": "none", 
      "ipaddr": "0.0.0.0", 
      "netmask": "0.0.0.0", 
      "gtway": "0.0.0.0"
    }, 
    {
      "host": "netprofiler-Blade1", 
      "label": "dahost1", 
      "mode": "static", 
      "ipaddr": "192.168.10.111", 
      "netmask": "255.255.255.0", 
      "gtway": "0.0.0.0"
    }
  ], 
  "credentials": [
    {
      "user": "root", 
      "pswd": "haha"
    }, 
    {
      "user": "god", 
      "pswd": "x"
    }
  ]
}

Property Name	Type	Description
CurrentSettings	<object>	List addresses and credentials for BMC.
CurrentSettings.address	<array of <object>>	List of BMC addresses.
CurrentSettings.address[item]	<object>	Address of BMC.
CurrentSettings.address[item].host	<string>	Current host
CurrentSettings.address[item].label	<string>	label of current host
CurrentSettings.address[item].mode	<string>	mode of address
CurrentSettings.address[item].ipaddr	<string>	IP Address of the BMC
CurrentSettings.address[item].netmask	<string>	netmask of the BMC
CurrentSettings.address[item].gtway	<string>	gateway of the BMC
CurrentSettings.credentials	<array of <object>>	List of BMC credentials.
CurrentSettings.credentials[item]	<object>	credential for BMC.
CurrentSettings.credentials[item].user	<string>	username for BMC
CurrentSettings.credentials[item].pswd	<string>	password for BMC

Response Body

On success, the server does not provide any body in the responses.

Error Codes

In the event that an error occurs while processing a request, the server will respond with appropriate HTTP status code and additional information in the response body:

{
     "error_id":   "{error identifier}",
     "error_text": "{error description}",
     "error_info": {error specific data structure, optional}
}

The table below lists the possible errors and the associated HTTP status codes that may returned.

Error ID	HTTP Status	Comments
BAD_REQUEST	400	Invalid argument.
AUTH_REQUIRED	401	Authentication required.
AUTH_INVALID_CREDENTIALS	401	Make sure the user name is correct and type your password again. Be sure to use the correct case for the user name and password.
HTTP_INVALID_METHOD	405	Requested method is not available for this resource.
INTERNAL_ERROR	500	Internal error.