Switches REST API

Get all switches

Returns a list of Switches.

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": [
         "/admin/resources/vendor_informations/db2d5213-d9ec-4222-af9b-0bf80cdd9ca9"
      ],
      "racks": "/admin/resources/racks/2611d67c-0ca4-4771-a14e-87d575cddfba",
      "created_time_raw": 1463766753282,
      "in_maintenance": "F",
      "events": [
      ],
      "switch_type": "tor_network_switch",
      "power_target_state": "pending",
      "state": "available",
      "updated_time": "Fri 03 Jun 2016 11:07:15.489 UTC",
      "version": "2.2.2.0",
      "id": "/admin/resources/switches/5ac451c5-05ad-4869-a878-41074719045c",
      "label_user": "Top of Rack Switch",
      "last_boot_time_raw": "17:07:24 Mon Feb  6, 2000",
      "locations": [
         "/admin/resources/locations/21a6a573-55ff-4710-b2ab-a850eabd9fcc"
      ],
      "software_version": "8.2.2",
      "name": "SN#Y019J110DYC4",
      "power_target_result": "done",
      "parent_type": "racks",
      "trunk_groups": [
      ],
      "temperature_stats": [
      ],
      "networks": [
      ],
      "firmware_level": "8.2.2",
      "switchid": "1",
      "power_state": "available",
      "isas_rn": 1,
      "label_text": "Top of Rack Switch",
      "label": "Lenovo RackSwitch G8272",
      "vlag_tier_id": 250,
      "last_boot_time": "Sun 06 Feb 2000 17:07:24.000 UTC",
      "label_key": "pure2314",
      "switch_power_supplies": [
         "/admin/resources/switch_power_supplies/60a1d92c-7520-4576-9b9e-bcf28d35fdce",
         "/admin/resources/switch_power_supplies/29d1f600-3564-4e30-b0e1-6d97feec5dcf"
      ],
      "switch_model": "G8272",
      "switch_fans": [
         "/admin/resources/switch_fans/92270f9a-c46b-4a75-8315-f35f55a38ee9",
         "/admin/resources/switch_fans/958e4d4e-e81c-49f5-b7c3-856b4823272f",
         "/admin/resources/switch_fans/4b8e9ae4-e1d6-48ae-8220-48720fac24fc",
         "/admin/resources/switch_fans/92b241fb-54e9-4a35-879e-b271824ed8fc",
         "/admin/resources/switch_fans/f9de9366-5a09-475c-8d73-9e7ac2d32ca3",
         "/admin/resources/switch_fans/39911830-2fb1-4f61-bbf2-2ad9bf0175c6",
         "/admin/resources/switch_fans/dfed683f-6005-4e05-9cf6-d526d6463d21",
         "/admin/resources/switch_fans/52022f40-2a27-4406-a444-aa14118dad0f"
      ],
      "updated_time_raw": 1464952035489,
      "stacking_group_id": null,
      "vlag_system_id": "08:17:f4:c3:dd:f9",
      "created_time": "Fri 20 May 2016 17:52:33.282 UTC",
      "switch_ports": [
         "/admin/resources/switch_ports/415fdb52-488b-4f7b-b72d-605ccdc955f9",
         "/admin/resources/switch_ports/dbc52e10-2b4f-4777-87e8-a2f1f2e4b0c5",
         "/admin/resources/switch_ports/95f42786-1995-4fab-bcd5-8b86137b61e5",
         "/admin/resources/switch_ports/dc7e4829-b6eb-4f7b-a4c9-5f705eadfac0",
         "/admin/resources/switch_ports/86bdba80-ab9a-4866-8169-537a3e25af0e",
         "/admin/resources/switch_ports/8274b67b-1200-4909-896f-5178e23793b8",
         "/admin/resources/switch_ports/2e101dd1-cc92-4d51-bf4c-01a488f27a34",
         "/admin/resources/switch_ports/08f82106-be40-4f39-838d-f52ba4c9b175",
         "/admin/resources/switch_ports/ce343698-9fb2-43a7-9ca1-b94b5861e55c",
         "/admin/resources/switch_ports/851e22d8-569c-482e-aa81-1f8820e4a8f0",
         "/admin/resources/switch_ports/4bf4ee48-218e-476c-8ad2-80d8e0599e82",
         "/admin/resources/switch_ports/ec8abbb3-087f-46c5-8fb5-d263900ea75b",
         "/admin/resources/switch_ports/4744fa80-3822-4b11-936b-86bb22e700ea",
         "/admin/resources/switch_ports/f51eae5a-4b56-4716-81c0-03e7633f8152",
         "/admin/resources/switch_ports/8b05e4d9-e42d-4ced-8096-6b81e76fd57e",
         "/admin/resources/switch_ports/f6dc949c-64e4-4ad3-9ab8-29324aeea113",
         "/admin/resources/switch_ports/6bf96d43-5f50-4d5f-bf41-8c7bd0571fe3",
         "/admin/resources/switch_ports/f900f764-a647-4a64-8e2b-f961fe2bd2c7",
         "/admin/resources/switch_ports/b0235349-9644-4575-a902-09196363edc8",
         "/admin/resources/switch_ports/65866a78-cf7b-4017-9b16-17467d1a40b5",
         "/admin/resources/switch_ports/698ee705-ac64-4ec4-887f-99e245d407c3",
         "/admin/resources/switch_ports/f0bfc69f-7239-4676-8485-cc90350f467c",
         "/admin/resources/switch_ports/8b25bc50-4353-4d27-842a-4830cf2bc6e7",
         "/admin/resources/switch_ports/8bb3a90b-893b-4a7a-919b-d4feb1f88593",
         "/admin/resources/switch_ports/dd3e20c5-35ff-4e0f-a6c4-91144a78b3ed",
         "/admin/resources/switch_ports/3ceb5fcb-8d81-4cb9-82bb-1a654640da94",
         "/admin/resources/switch_ports/81d25615-d4d0-4459-bb5e-8b23e5c5add2",
         "/admin/resources/switch_ports/d0fce3e0-b309-42c4-b7ef-80937f7de846",
         "/admin/resources/switch_ports/0412a7ba-5573-4dfd-a199-00928591d5d4",
         "/admin/resources/switch_ports/57f3dc5d-f6d4-4c18-a432-2f1001b78675",
         "/admin/resources/switch_ports/18d5ff61-f8f3-4721-b663-4bd90cf54f9b",
         "/admin/resources/switch_ports/f7493b3f-fc1b-442d-988a-934647a3e1a4",
         "/admin/resources/switch_ports/948646d1-95a0-4b04-95f1-a8f8016b8442",
         "/admin/resources/switch_ports/f9cf29c0-a74c-4c10-b9d2-7ae74b539fbf",
         "/admin/resources/switch_ports/38d65703-2b18-4401-94ca-f1600b7fd382",
         "/admin/resources/switch_ports/1ce81eaf-48bf-4404-b9d7-5b3e0510b195",
         "/admin/resources/switch_ports/d65fe29b-bde8-4c8f-be4e-921ee574c146",
         "/admin/resources/switch_ports/cf7fa32d-2c74-4907-b2b8-9b395a446609",
         "/admin/resources/switch_ports/950ab79e-0ab0-4549-b281-9b6ababa345a",
         "/admin/resources/switch_ports/f9961d65-5d7e-4063-b54d-d98813a99852",
         "/admin/resources/switch_ports/ad166d70-e0c3-483e-bce2-130eca8ec8ac",
         "/admin/resources/switch_ports/5f524263-7ad7-4fa6-ad3a-03273ab12933",
         "/admin/resources/switch_ports/d97b485f-2d55-4b12-bdfa-475c4a3e0730",
         "/admin/resources/switch_ports/81c7cd01-649c-4c42-ad7b-2cd49cccc8cd",
         "/admin/resources/switch_ports/12c5390e-3af4-4ff9-b9a5-e24f6505f470",
         "/admin/resources/switch_ports/a599260d-4857-4a24-8697-9137e3f81fce",
         "/admin/resources/switch_ports/17fc7a4f-60bf-47b7-b1ed-702e6c46e57a",
         "/admin/resources/switch_ports/77f69054-b154-4c2d-8bab-8b81e25b24b1",
         "/admin/resources/switch_ports/cc519a0a-2972-453c-993d-0cd6a0703c8f",
         "/admin/resources/switch_ports/2b7a34c6-a10b-4ea9-9f64-cbba58a0b4bb",
         "/admin/resources/switch_ports/258ddea9-c99c-4793-b4cc-ef8f7e43803e",
         "/admin/resources/switch_ports/a0aff519-511a-4825-b2e3-bb9550b11421",
         "/admin/resources/switch_ports/c8768a90-11ba-4043-9888-4b20d6c87770",
         "/admin/resources/switch_ports/84cbbe8a-5dea-49d9-8260-e943dbde2647",
         "/admin/resources/switch_ports/c7339b05-7d80-4c77-bb2c-f6168d0a6af6"
      ]
   }
]

created_time

The time at which the object is created

firmware_level

The level of firmware on the switch

id

The unique ID of the object in the system.

label

A descriptive label for the switch

label_key

The key for retrieving the label for the subnet

label_text

Default translated message text

label_user

User modified message text

last_boot_time

The time (in milliseconds) the switch was last booted

name

A descriptive name of the switch

parent_type

The type of the parent that the switch belongs to

power_state

The current power state of the switch (off or on)

power_target_result

The result state of the switch in the event of powering the switch on or off

power_target_state

The target state of the switch in the event of powering the switch on or off

software_version

The version of software on the switch

stacking_group_id

The stacking group associated with the switch

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.

switch_model

The model of the switch

switch_type

The type of the switch

switchid

The number of the switch's I/O bay

temperature

The temperature of the switch at the point of last contact with the switch

updated_time

The time at which the object was last updated

vlag_system_id

The unique identifier of the switch units in the customer network

vlag_tier_id

The unique identifier of the switch units in the customer network

parent_type

The type of the generic parent

Parents:

compute_node_chassis, racks

Children:

locations, switch_ports, vendor_informations, events, switch_fans, switch_power_supplies, networks

Get a specific Switch

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