Management endpoints REST API

Use this REST API to manage management endpoints.

Get all management endpoints

Table 1. Get all management endpoints
REST API information	Value	Description
URI	/admin/resources/management_endpoints
Method	GET
Returns	200	Returns a list of all management endpoints
	404	The management endpoint list was not found
	500	Platform System Manager encountered an internal error while processing the request.

Returns a list of management endpoints.

You can use optional parameters to modify the response from the REST API call. For more information, see the Related information section.

Response body

[
   {
      "vendor_informations": [
      ],
      "created_time_raw": 1466086474407,
      "events": [
      ],
      "mgmt_endpoint_eth_adapters": [
      ],
      "hypervisors": "/admin/resources/hypervisors/6dd514d8-da71-4754-b95c-583411ba0bd1",
      "isas_rn": 1,
      "state": "available",
      "label_text": "Management Endpoint(VIOS)",
      "stats_agent_state": "unknown",
      "updated_time": "Thu 16 Jun 2016 14:34:59.622 UTC",
      "label_key": "pure0532",
      "version": "2.2.2.0",
      "management_endpoint_memory": [
      ],
      "id": "/admin/resources/management_endpoints/8939e912-95e0-41ff-8f87-56718dccc195",
      "state_updated_time": 0,
      "machine_type": null,
      "management_endpoint_cpus": [
      ],
      "label_user": "Management Endpoint(VIOS)",
      "updated_time_raw": 1466087699622,
      "locations": [
      ],
      "software_version": null,
      "name": null,
      "created_time": "Thu 16 Jun 2016 14:14:34.407 UTC"
   }
]

created_time: The time at which the object is created
hypervisors: The location of the management endpoint
id: The unique ID of the object in the system.
label_key: Key for retrieving the label for the management endpoint
label_text: Default translated message text
label_user: User modified message text
machine_type: The machine type that contains the management endpoint
name: The name of the management endpoint
software_version: The software version for the management endpoint
state: The general availability of the object. If "pending" the object has been created but not activated. If "available" the object is active in the system.
stats_agent_state: The state of the Statistics agent
updated_time: The time at which the object was last updated

Parents:

hypervisors

Children:

vendor_informations, events, locations

Get a specific management endpoint

Table 2. Get a specific management endpoint
REST API information	Value	Description
URI	/admin/resources/management_endpoints/{id}
Method	GET
Returns	200	The management endpoint was returned.
	404	The management endpoint was not found
	500	Platform System Manager encountered an internal error while processing the request.

Returns a single management endpoint identified by {id}.

You can use optional parameters to modify the response from the REST API call. For more information, see the Related information section.