{
    "restSchemaVersion": "1.0",
    "errors": [
      {
        "error_id": "BAD_REQUEST",
        "description": "Invalid argument.",
        "http_status": "400"
      },
      {
        "error_id": "AUTH_REQUIRED",
        "description": "Authentication required.",
        "http_status": "401"
      },
      {
        "error_id": "AUTH_INVALID_CREDENTIALS",
        "description": "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_status": "401"
      },
      {
        "error_id": "HTTP_INVALID_METHOD",
        "description": "Requested method is not available for this resource.",
        "http_status": "405"
      },
      {
        "error_id": "INTERNAL_ERROR",
        "description": "Internal error.",
        "http_status": "500"
      }
    ],
    "name": "mgmt.bmc_settings",
    "title": "Baseboard Management Controller API.",
    "version": "1.0",
    "schemas": [],
    "defaultAuthorization": "required",
    "servicePath": "/api/mgmt.bmc_settings/1.0",
    "resources": {
      "Settings": {
        "methods": {
          "Display Settings": {
            "description": "Displays BMC settings.",
            "formats": [
              "json"
            ],
            "httpmethod": "GET",
            "path": "access_settings",
            "authorization_methods": [
              "BASIC",
              "COOKIE",
              "OAUTH_2_0"
            ],
            "response": {
              "description": "List addresses and credentials for BMC.",
              "properties": {
                "address":{
                    "description":"List of BMC addresses.",
                    "type":"array",
                    "required":true,
                    "items":{
                        "type":"object",
                        "description":"Address of BMC.",
                        "properties":{
                            "host": {
                                "type": "string",
                                "description":"Current host"
                            },
                            "label": {
                                "type": "string",
                                "description":"label of current host"
                            },
                            "mode": {
                                "type": "string",
                                "description":"mode of address"
                            },
                            "ipaddr": {
                                "type": "string",
                                "description":"IP Address of the BMC"
                            },
                            "netmask": {
                                "type": "string",
                                "description": "netmask of the BMC"
                            },
                            "gtway": {
                                "type": "string",
                                "description":"gateway of the BMC"
                            }
                        },
                        "required": [
                            "host",
                            "label",
                            "mode"
                        ]
                    }
                },
                "credentials":{
                    "description":"List of BMC credentials.",
                    "type":"array",
                    "required":true,
                    "items":{
                        "type":"object",
                        "description":"credential for BMC.",
                        "required":true,
                        "properties":{
                            "user":{
                                "description":"username for BMC",
                                "type":"string",
                                "required":true
                            },
                            "pswd":{
                                "description":"password for BMC",
                                "type":"string",
                                "required":true
                            }
                        }
                    }
                }
              },
              "id": "CurrentSettings",
              "type": "object",
              "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"
                  }
                ]
              }
            },
            "authorization": "required"
          },
          "Configure Settings": {
            "description": "Configures BMC settings.",
            "formats": [
              "json"
            ],
            "httpmethod": "POST",
            "path": "access_settings",
            "authorization_methods": [
              "BASIC",
              "COOKIE",
              "OAUTH_2_0"
            ],
            "request": {
                "description": "List addresses and credentials for BMC.",
                "properties": {
                  "address":{
                      "description":"List of BMC addresses.",
                      "type":"array",
                      "required":true,
                      "items":{
                          "type":"object",
                          "description":"Address of BMC.",
                          "properties":{
                              "host": {
                                  "type": "string",
                                  "required":true,
                                  "description":"Current host"
                              },
                              "label": {
                                  "type": "string",
                                  "required":true,
                                  "description":"label of current host"
                              },
                              "mode": {
                                  "type": "string",
                                  "required":true,
                                  "description":"mode of address"
                              },
                              "ipaddr": {
                                  "type": "string",
                                  "description":"IP Address of the BMC"
                              },
                              "netmask": {
                                  "type": "string",
                                  "description": "netmask of the BMC"
                              },
                              "gtway": {
                                  "type": "string",
                                  "description":"gateway of the BMC"
                              }
                          }
                      }
                  },
                  "credentials":{
                      "description":"List of BMC credentials.",
                      "type":"array",
                      "required":true,
                      "items":{
                          "type":"object",
                          "description":"credential for BMC.",
                          "required":true,
                          "properties":{
                              "user":{
                                  "description":"username for BMC",
                                  "type":"string",
                                  "required":true
                              },
                              "pswd":{
                                  "description":"password for BMC",
                                  "type":"string",
                                  "required":true
                              }
                          }
                      }
                  }
                },
                "id": "CurrentSettings",
                "type": "object",
                "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"
                    }
                  ]
                }
              },
            "authorization": "required"
          }
        }
      }
    },
    "description": "<h2>Overview</h2>\n\n<p>\nThe documentation pages in this section describe\nthe RESTful APIs included with Riverbed SteelCentral Product. It is assumed \nthat the reader has practical knowledge of\nRESTful APIs, so the documentation does not go into detail about what\nREST is and how to use it. Instead the documentation focuses on what\ndata can be accessed, how to configure it.\n</p>\n\n<p>\nThe following operations can be performed via the API:\n</p>\n<ul>\n <li>Display BMC settings</li> \n <li>Configure BMC settings</li> \n</ul>\n\n<p>\nDetails about REST resources can be found in the <b>Resources</b>\nsection. This overview continues with how to run these API's.\n</p>\n\n<h2>Authentication</h2>\n\n<p>\nAll REST requests must be authenticated. The <b>Authentication</b>\nsection of the Common API describes which authentication methods\nare presently supported. \n</p>\n\n"
}