Get Console Properties

The Get Console Properties operation retrieves the properties of the Console object. This operation is supported using the BCPii interface.

HTTP method and URI

GET /api/console

Query Parameters

Name Type Rqd/Opt Description
properties List of String Enum Optional Filter string to limit returned properties to those that are identified here. This is a list of comma-separated strings where each string is a property name defined in the Console object's Data Model.

Response body contents

On successful completion, the response body contains an object that provides the current values of the properties for the Console object as defined in Data model. Field names and data types in the object are the same as the property names and data types defined in the data model.

Description

This operation returns the current properties for the Console object.

On successful execution, HTTP status code 200 (OK) is returned and all of the current properties as defined by the data model for the Console object are provided in the response body.

Authorization requirements

This operation has the following authorization requirements:
  • For the web services interface, all authenticated users have permission.
  • For the BCPii interface the source partition must have receive BCPii security controls permissions for the CPC object.

HTTP status and reason codes

On success, HTTP status code 200 (OK) is returned and the response body is provided as described Response body contents.

The following HTTP status codes are returned for the indicated errors, and the response body is a standard error response body providing the reason code indicated and associated error message.

HTTP error status code Reason code Description
400 (Bad Request) Various Errors were detected during common request validation. See Common request validation reason codes for a list of the possible reason codes.

Additional standard status and reason codes can be returned, as described in Invoking API operations.

Example HTTP interaction

Figure 1. Get Console Properties: Request
GET /api/console HTTP/1.1
x-api-session: duqt0x27jl7a9sn50e9w2sh5f0nxitb56zbiqnc5yjwxrsvvz
Figure 2. Get Console Properties: Response (Part 1)
200 OK
server: Hardware management console API web server / 2.0
cache-control: no-cache
date: Wed, 18 Sep 2019 22:04:21 GMT
content-type: application/json;charset=UTF-8
content-length: 4397
{
   "class":"console",
   "description":"",
   "ec-mcl-description":{
      "ec":[
         {
            "description":"Hardware Management Console Framework",
            "mcl":[
               {
                  "last-update":null,
                  "level":"-",
                  "type":"retrieved"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"activated"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"accepted"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"installable-concurrent"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"removable-concurrent"
               }
            ],
            "number":"P46683",
            "part-number":"02WG827",
            "type":"SYSTEM"
         },
Figure 3. Get Console Properties: Response (Part 2)

         {
            "description":"Hardware Management Console Platform Firmware",
            "mcl":[
               {
                  "last-update":null,
                  "level":"-",
                  "type":"retrieved"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"activated"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"accepted"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"installable-concurrent"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"removable-concurrent"
               }
            ],
            "number":"P46658",
            "part-number":"02WF276",
            "type":"HMCBIOS"
         },
         {
            "description":"Licensed Internal Code Alerts",
            "mcl":[
               {
                  "last-update":null,
                  "level":"-",
                  "type":"retrieved"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"activated"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"accepted"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"installable-concurrent"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"removable-concurrent"
               }
            ],
            "number":"P46684",
            "part-number":"02WG828",
            "type":"MALERT"
         },
Figure 4. Get Console Properties: Response (Part 3)

         {
            "description":"Enablement of new features   ",
            "mcl":[
               {
                  "last-update":null,
                  "level":"-",
                  "type":"retrieved"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"activated"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"accepted"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"installable-concurrent"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"removable-concurrent"
               }
            ],
            "number":"P46685",
            "part-number":"02WG829",
            "type":"ENABLE1"
         },
         {
            "description":"Enablement of new features   ",
            "mcl":[
               {
                  "last-update":null,
                  "level":"-",
                  "type":"retrieved"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"activated"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"accepted"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"installable-concurrent"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"removable-concurrent"
               }
            ],
            "number":"P46686",
            "part-number":"02WG830",
            "type":"ENABLE2"
         },
Figure 5. Get Console Properties: Response (Part 4)

         {
            "description":"Firmware feature enablement  ",
            "mcl":[
               {
                  "last-update":null,
                  "level":"-",
                  "type":"retrieved"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"activated"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"accepted"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"installable-concurrent"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"removable-concurrent"
               }
            ],
            "number":"P46687",
            "part-number":"02WG831",
            "type":"FFE"
         },
         {
            "description":"Open source components",
            "mcl":[
               {
                  "last-update":null,
                  "level":"-",
                  "type":"retrieved"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"activated"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"accepted"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"installable-concurrent"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"removable-concurrent"
               }
            ],
            "number":"P46688",
            "part-number":"02WG832",
            "type":"OPENSRC"
         },
Figure 6. Get Console Properties: Response (Part 5)
         {
            "description":"Embedded Operating System",
            "mcl":[
               {
                  "last-update":null,
                  "level":"-",
                  "type":"retrieved"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"activated"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"accepted"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"installable-concurrent"
               },
               {
                  "last-update":null,
                  "level":"-",
                  "type":"removable-concurrent"
               }
            ],
            "number":"P45842",
            "part-number":"02WG826",
            "type":"OS"
         }
      ]
   },
   "is-locked":false,
   "machine-info":{
      "machine-model":"TW2",
      "machine-serial":"DK5C004",
      "machine-type":"2461"
   },
   "name":"HMCDAILY03",
   "network-info":{
      "this-hmc":[
         {
            "domain-name":"local",
            "hmc-name":"HMCDAILY03",
            "interface-name":"eth0",
            "ipv4-address":[
               {
                  "ip-address":"192.0.2.0",
                  "subnet-mask":"255.255.255.0"
               }
            ],
            "ipv6-address":[
               {
                  "ip-address":"2001:0db8:0:0:0:210:6fff:9759",
                  "prefix-length":64
               }
            ],
            "is-private":false,
            "mac":"00106f0d9759"
         },
Figure 7. Get Console Properties: Response (Part 6)

         {
            "domain-name":"local",
            "hmc-name":"HMCDAILY03",
            "interface-name":"eth1",
            "ipv4-address":[
               {
                  "ip-address":"0.0.0.0",
                  "subnet-mask":"255.255.255.255"
               }
            ],
            "ipv6-address":[],
            "is-private":false,
            "mac":"00106f0d975a"
         },
         {
            "domain-name":"local",
            "hmc-name":"HMCDAILY03",
            "interface-name":"eth2",
            "ipv4-address":[
               {
                  "ip-address":"0.0.0.0",
                  "subnet-mask":"255.255.255.0"
               }
            ],
            "ipv6-address":[],
            "is-private":false,
            "mac":"00106f0d975b"
         },
         {
            "domain-name":"local",
            "hmc-name":"HMCDAILY03",
            "interface-name":"eth3",
            "ipv4-address":[
               {
                  "ip-address":"0.0.0.0",
                  "subnet-mask":"255.255.255.0"
               }
            ],
            "ipv6-address":[],
            "is-private":false,
            "mac":"00106f0d975c"
         }
      ]
   },
   "object-id":"106ffdd7-04fa-376c-a059-6c69486bc57f",
   "object-uri":"/api/console",
   "parent":null,
   "version":"2.15.0"
}