Locations REST API

Use this REST API to manage locations.

Get all locations

URI	/admin/resources/locations
Method	GET
Returns	200	Returns a list of all locations
	404	The location list was not found
	500	Platform System Manager encountered an internal error while processing the request.

Returns a list of locations.

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

Response body

[
   {
      "created_time_raw": 1465935873089,
      "hardware": "T",
      "rack_number": "8558/Rack37",
      "node_bay_number": 0,
      "state": "available",
      "drive_bay_number": 0,
      "ipaddress": "fd8c:215d:178e:c0de:a68c:dbff:fe6e:2800",
      "type": "internal_management_switch",
      "updated_time": "Tue 14 Jun 2016 20:25:49.163 UTC",
      "version": "2.2.2.0",
      "id": "/admin/resources/locations/81cb303f-9901-45c0-9289-9be6d5782766",
      "switches": "/admin/resources/switches/fc26e7e1-0668-4432-a282-40260aa05751",
      "height": 0,
      "name": "SN#Y01DJ110FBXL",
      "parent_type": "switches",
      "io_bay_number": 0,
      "chassis_number": 0,
      "rack_unit_number": 6,
      "mm_bay_number": 0,
      "width": 0,
      "isas_rn": 1,
      "label_text": "Rack 8558/Rack37 Rack Unit Number 6",
      "label_key": "pure4505",
      "physical_location": "n/a",
      "updated_time_raw": 1465935949163,
      "created_time": "Tue 14 Jun 2016 20:24:33.089 UTC"
   }
]

created_time: The time at which the object is created
hardware: Indicates whether the location is associated with hardware "T" or software "F"
height: The height of the location
id: The unique ID of the object in the system.
io_bay_number: IO bay number
ipaddress: IP address
label_key: Key for retrieving label for the location
label_text: Default translated message text
mm_bay_number: Management module bay number
name: The name of the location
node_bay_number: Node bay number
physical_location: Physical location
rack_number: The identifier of the rack of which this location is associated
rack_unit_number: The unit number of the rack of which this location is associated
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.
type: The type of the location
updated_time: The time at which the object was last updated
version: REST API version number
width: The width of the location
parent_type: The type of the generic parent

Parents:

, management_endpoints, clusters, , racks, management_nodes, media_trays, storage_controllers, switches, storage_expansions, compute_nodes

Get a specific location

URI	/admin/resources/locations/{id}
Method	GET
Returns	200	The location was returned.
	404	The location was not found
	500	Platform System Manager encountered an internal error while processing the request.

Returns a single location 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.