REST Resources

/api/space/managed-domain/managed-elements/{id}/equipment-holders/{eqId} (v2)

The following operation is supported on this resource:

  • GET - Get information about a equipment holder
GET /managed-elements/{id}/equipment-holders/{eqId}Version 2

This API returns equipment holder information from an equipment holder list in a managed element. The API takes a managed element ID and an equipment holder ID.

Sample Usage

GET /managed-elements/{id}/equipment-holders/{eqId}


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    me-idintPathThe ID of the managed element containing the requested equipment holder. Y
    equipment-holder-idintPathThe ID of the equipment holder from which to retrieve information. Y
  • Sample Output XML:

    <equipment-holder uri="/api/space/managed-domain/managed-elements/589997/equipment-holders/589999">
     <id>589999</id>
     <name>Chassis</name>
     <path>491546/Chassis</path>
     <equipments>
      <containedEquipment>
       <id>590001</id>
       <name>Routing Engine 0</name>
       <path>491546/Chassis/Routing Engine 0</path>
       <holderType>SLOT</holderType>
       <holderState>INSTALLED_AND_EXPECTED</holderState>
      </containedEquipment>
      <containedEquipment>
       <id>590003</id>
       <name>FPC 0</name>
       <path>491546/Chassis/FPC 0</path>
       <holderType>SLOT</holderType>
       <holderState>INSTALLED_AND_EXPECTED</holderState>
       <expectedOrInstalledEquipment>
        <name>FPC 0</name>3
        <expectedEquipmentObjectType>EX4200-24T</expectedEquipmentObjectType>
        <installedEquipmentObjectType>EX4200-24T</installedEquipmentObjectType>
        <installedPartNumber>750-033065</installedPartNumber>
        <installedSerialNumber>BM0210293858</installedSerialNumber>
        <manufacturer>juniper</manufacturer>
        <description>EX 4200, 24-port 10/100/1000BaseT (8-ports PoE) + 320W AC PS, includes 50cm VC cable</description>
        <installedVersion>REV 02</installedVersion>
        <ptps>
         <ptp uri="/api/space/managed-domain/ptps/590013">
          <name>ge-0/0/0</name>
          <deviceId>491546</deviceId>
          <adminStatus>up</adminStatus>
          <operationStatus>down</operationStatus>
          <speed>1000</speed>
          <speedStr>Auto</speedStr>
          <mtu>1514</mtu>
         </ptp>
        </ptps>
       </expectedOrInstalledEquipment>
      </containedEquipment>
     </equipments>
     <holderType>SHELF</holderType>
     <holderState>INSTALLED_AND_EXPECTED</holderState>
     <expectedOrInstalledEquipment>
      <name>Chassis</name>
        <expectedEquipmentObjectType>EX4200-24T</expectedEquipmentObjectType>
        <installedEquipmentObjectType>EX4200-24T</installedEquipmentObjectType>
        <installedPartNumber>750-033065</installedPartNumber>
      <installedSerialNumber>BM0210293858</installedSerialNumber>
      <manufacturer>juniper</manufacturer>
      <description>EX4200-24T</description>
     </expectedOrInstalledEquipment>
    </equipment-holder>

  • Sample Output JSON:

    {
      "equipment-holder": {
        "@uri": "/api/space/managed-domain/managed-elements/589997/equipment-holders/589999",
        "id": "589999",
        "name": "Chassis",
        "path": "491546/Chassis",
        "equipments": {
          "containedEquipment": [
            {
              "id": "590001",
              "name": "Routing Engine 0",
              "path": "491546/Chassis/Routing Engine 0",
              "holderType": "SLOT",
              "holderState": "INSTALLED_AND_EXPECTED"
            },
            {
              "id": "590003",
              "name": "FPC 0",
              "path": "491546/Chassis/FPC 0",
              "holderType": "SLOT",
              "holderState": "INSTALLED_AND_EXPECTED",
              "expectedOrInstalledEquipment": {
                "name": "FPC 0",
                "expectedEquipmentObjectType": "EX4200-24T",
                "installedEquipmentObjectType": "EX4200-24T",
                "installedPartNumber": "750-033065",
                "installedSerialNumber": "BM0210293858",
                "manufacturer": "juniper",
                "description": "EX 4200, 24-port 10/100/1000BaseT (8-ports PoE) + 320W AC PS, includes 50cm VC cable",
                "installedVersion": "REV 02",
                "ptps": {
                  "ptp": {
                    "@uri": "/api/space/managed-domain/ptps/590013",
                    "name": "ge-0/0/0",
                    "deviceId": "491546",
                    "adminStatus": "up",
                    "operationStatus": "down",
                    "speed": "1000",
                    "speedStr": "Auto",
                    "mtu": "1514"
                  }
                }
              }
            }
          ]
        },
        "holderType": "SHELF",
        "holderState": "INSTALLED_AND_EXPECTED",
        "expectedOrInstalledEquipment": {
          "name": "Chassis",
          "expectedEquipmentObjectType": "EX4200-24T",
          "installedEquipmentObjectType": "EX4200-24T",
          "installedPartNumber": "750-033065",
          "installedSerialNumber": "BM0210293858",
          "manufacturer": "juniper",
          "description": "EX4200-24T",
        }
      }
    }

    • Access Control

    The following capabilities are required to access this API: ViewPhysicalInventory

      For the current version of this API, refer to :
    • version 3