Sample RESTConf Request and Response Formats

Chassis Inventory Retrieval

This interface provides the operations to retrieve chassis entities. A specialization of Equipment that can contain other pieces of Equipment (such as enclosure, frame, and so on).

Chassis Data

Some of the attributes in the chassis object are fdn (Fully-qualified domain name (FDN) of the object), instanceid (Instance identifier of entity in the database) etc. Associated objects are represented by a collection, for one-to-many associations, or an attribute of the object type for one-to-one or many-to-one associates. The role of the object(s) in the association provides the name for association attributes. The API traverses selected associations, usually of one-to-many cardinality, to allow retrieval of a hierarchy of objects in a single request. Attribute names of such associations are followed by an asterisk (*). To prevent cycles in the retrieval or divide the hierarchy into manageable pieces, other associations are summarized as a list of strings with an entry for the FDN of each object in the collection. Some attributes may not be displayed since null values and empty associations are not included in the response.

Resource Path https://1.1.1.1/restconf/data/v1/cisco-resource-physical:chassis?.maxCount=3

json

xml

Copy{
    "com.response-message": {
        "com.header": {
            "com.firstIndex": 0,
            "com.lastIndex": 2
        },
        "com.data": {
            "eq.chassis": [
                {
                    "fdtn.name": "SHELF",
                    "eq.connectors": "",
                    "eq.contained-equipment": [
                        "MD=CISCO_EPNM!ND=Site7ILA!EQ=name=SLOT-2;partnumber=15454-OPT-EDFA-17",
                        "MD=CISCO_EPNM!ND=Site7ILA!EQ=name=SLOT-3;partnumber=NCS2K-EDRA2-26C",
                        "MD=CISCO_EPNM!ND=Site7ILA!EQ=name=ECU-1;partnumber=NCS2006-ECU",
                        "MD=CISCO_EPNM!ND=Site7ILA!EQ=name=SLOT-1;partnumber=NCS2K-TNCS-O-K9",
                        "MD=CISCO_EPNM!ND=Site7ILA!EQ=name=SLOT-8;partnumber=NCS2K-TNCS-K9",
                        "MD=CISCO_EPNM!ND=Site7ILA!EQ=name=PWR-A;partnumber=NCS2006-DC20",
                        "MD=CISCO_EPNM!ND=Site7ILA!EQ=name=PWR-B;partnumber=NCS2006-DC20",
                        "MD=CISCO_EPNM!ND=Site7ILA!EQ=name=FAN-1;partnumber=NCS2006-FTA",
                        "MD=CISCO_EPNM!ND=Site7ILA!EQ=name=LCD-1;partnumber=NCS2006-LCD"
                    ],
                    "eq.ent-physical-index": "SHELF",
                    "eq.equipment-type": "CHASSIS",
                    "eq.fdn": "MD=CISCO_EPNM!ND=Site7ILA!EQ=name=SHELF;partnumber=NCS2006-SA",
                    "eq.is-physically-present": true,
                    "eq.is-reporting-alarms-allowed": "UNKNOWN",
                    "eq.part-number": "NCS2006-SA",
                    "eq.product-id": "NCS2006-SA",
                    "eq.service-state": "UNKNOWN",
                    "eq.vendor-equipment-type": "WOM4C10KRA"
                },
                {
                    "fdtn.description": "ASR 9006 4 Line Card Slot Chassis with V1 AC PEM",
                    "fdtn.name": "chassis ASR-9006-AC",
                    "eq.assembly-revision": "B1  ",
                    "eq.connectors": "",
                    "eq.contained-equipment": [
                        "MD=CISCO_EPNM!ND=rupesh-9006-a!EQ=name=slot 0/RSP0;partnumber=cevContainerASR9KRSPSlot",
                        "MD=CISCO_EPNM!ND=rupesh-9006-a!EQ=name=slot 0/3;partnumber=cevContainerASR9KLCSlot",
                        "MD=CISCO_EPNM!ND=rupesh-9006-a!EQ=name=slot 0/0;partnumber=cevContainerASR9KLCSlot",
                        "MD=CISCO_EPNM!ND=rupesh-9006-a!EQ=name=slot 0/1;partnumber=cevContainerASR9KLCSlot",
                        "MD=CISCO_EPNM!ND=rupesh-9006-a!EQ=name=slot 0/RSP1;partnumber=cevContainerASR9KRSPSlot"
                    ],
                    "eq.ent-physical-index": 24555730,
                    "eq.equipment-type": "CHASSIS",
                    "eq.fdn": "MD=CISCO_EPNM!ND=rupesh-9006-a!EQ=name=chassis ASR-9006-AC;partnumber=ASR-9006-AC",
                    "eq.hardware-version": "V01",
                    "eq.is-field-replaceable-unit": "TRUE",
                    "eq.is-physically-present": true,
                    "eq.is-reporting-alarms-allowed": "UNKNOWN",
                    "eq.manufacturer": "Cisco Systems Inc.",
                    "eq.operational-state-code": "enabled",
                    "eq.part-number": "ASR-9006-AC",
                    "eq.product-id": "ASR-9006-AC",
                    "eq.serial-number": "FOX1325G3PB",
                    "eq.service-state": "UNKNOWN",
                    "eq.vendor-equipment-type": "cevChassisASR9006AC"
                },
                {
                    "fdtn.description": "NCS 4206 Series Router Chassis",
                    "fdtn.name": "Chassis",
                    "eq.connectors": "",
                    "eq.contained-equipment": [
                        "MD=CISCO_EPNM!ND=NCS4206-146.4.cisco-lab!EQ=name=subslot 0/3;partnumber=NCS4200-48T3E3-CE",
                        "MD=CISCO_EPNM!ND=NCS4206-146.4.cisco-lab!EQ=name=subslot 0/2;partnumber=A900-IMA8S",
                        "MD=CISCO_EPNM!ND=NCS4206-146.4.cisco-lab!EQ=name=subslot 0/5;partnumber=NCS4200-1T8S-10CS",
                        "MD=CISCO_EPNM!ND=NCS4206-146.4.cisco-lab!EQ=name=subslot 0/4;partnumber=cevContainerNCSLineCardSlot",
                        "MD=CISCO_EPNM!ND=NCS4206-146.4.cisco-lab!EQ=name=Fan Tray Bay 0;partnumber=cevContainerNCSFanTraySlot",
                        "MD=CISCO_EPNM!ND=NCS4206-146.4.cisco-lab!EQ=name=Power Supply Bay 1;partnumber=cevContainerNCSPwrTraySlot",
                        "MD=CISCO_EPNM!ND=NCS4206-146.4.cisco-lab!EQ=name=Power Supply Bay 0;partnumber=cevContainerNCSPwrTraySlot",
                        "MD=CISCO_EPNM!ND=NCS4206-146.4.cisco-lab!EQ=name=slot R1;partnumber=cevContainerNCSProcessorSlot",
                        "MD=CISCO_EPNM!ND=NCS4206-146.4.cisco-lab!EQ=name=slot R0;partnumber=cevContainerNCSProcessorSlot",
                        "MD=CISCO_EPNM!ND=NCS4206-146.4.cisco-lab!EQ=name=subslot 0/1;partnumber=NCS4200-48T1E1-CE",
                        "MD=CISCO_EPNM!ND=NCS4206-146.4.cisco-lab!EQ=name=subslot 0/0;partnumber=NCS4200-8T-PS"
                    ],
                    "eq.ent-physical-index": 1,
                    "eq.equipment-type": "CHASSIS",
                    "eq.fdn": "MD=CISCO_EPNM!ND=NCS4206-146.4.cisco-lab!EQ=name=Chassis;partnumber=NCS4206-SA",
                    "eq.hardware-version": "V01",
                    "eq.is-field-replaceable-unit": "TRUE",
                    "eq.is-physically-present": true,
                    "eq.is-reporting-alarms-allowed": "UNKNOWN",
                    "eq.manufacturer": "Cisco Systems Inc",
                    "eq.operational-state-code": "up",
                    "eq.part-number": "NCS4206-SA",
                    "eq.product-id": "NCS4206-SA",
                    "eq.serial-number": "FOX1752P0HE",
                    "eq.service-state": "UNKNOWN",
                    "eq.vendor-equipment-type": "cevChassisNCS4206SA",
                    "eq.number-of-slots": 0
                }
            ]
        }
    }
}

Copy<ns4:response-message xmlns:ns40="urn:cisco:params:xml:ns:yang:restconf:party" xmlns:ns39="urn:cisco:params:xml:ns:yang:xmpim:events-alarms" xmlns:ns38="urn:cisco:params:xml:ns:yang:restconf:alarms" xmlns:ns37="urn:ietf:params:xml:ns:yang:ietf-restconf" xmlns:ns36="urn:cisco:params:xml:ns:yang:service:activation:status:v1" xmlns:ns35="urn:cisco:params:xml:ns:yang:restconf:resource:opt" xmlns:ns34="urn:cisco:params:xml:ns:yang:restconf:resource:physical" xmlns:ns33="urn:cisco:params:xml:ns:yang:restconf:location" xmlns:ns32="urn:cisco:params:xml:ns:yang:restconf:foundation" xmlns:ns31="urn:cisco:params:xml:ns:yang:resource:device" xmlns:ns30="urn:cisco:params:xml:ns:yang:nrf-vc-path:v1" xmlns:ns29="urn:cisco:params:xml:ns:yang:yang-push:v1" xmlns:ns28="urn:cisco:params:xml:ns:yang:network-resource:oam:v1" xmlns:ns27="urn:cisco:params:xml:ns:yang:service:action:v1" xmlns:ns26="urn:cisco:params:xml:ns:yang:qos:v1" xmlns:ns25="urn:cisco:params:xml:ns:yang:sb:customer:v1" xmlns:ns24="urn:cisco:params:xml:ns:yang:sb:service-profile:v1" xmlns:ns23="urn:cisco:params:xml:ns:yang:nrf:physical:ctrl:v1" xmlns:ns22="urn:cisco:params:xml:ns:yang:nrf-physical:v1" xmlns:ns21="urn:cisco:params:xml:ns:yang:profile-protection:v1" xmlns:ns20="urn:cisco:params:xml:ns:yang:nrf-ipsla:v1" xmlns:ns19="urn:cisco:params:xml:ns:yang:sb:srrg:v1" xmlns:ns18="urn:cisco:params:xml:ns:yang:nrp-perf:v1" xmlns:ns17="urn:cisco:params:xml:ns:yang:nrf-topology:v1" xmlns:ns16="urn:cisco:params:xml:ns:yang:nrf-mpls-te-extension:v1" xmlns:ns15="urn:cisco:params:xml:ns:yang:service:oam:v1" xmlns:ns14="urn:cisco:params:xml:ns:yang:service:activation:v1" xmlns:ns13="urn:cisco:params:xml:ns:yang:ra:v1" xmlns:ns12="urn:cisco:params:xml:ns:yang:si-service:v1" xmlns:ns11="urn:cisco:params:xml:ns:yang:nrf-virtualforward:v1" xmlns:ns10="urn:cisco:params:xml:ns:yang:sb:networkinterface:v1" xmlns:ns9="urn:cisco:params:xml:ns:yang:nrf-virtualconnection:v1" xmlns:ns8="urn:cisco:params:xml:ns:yang:alarms:v1" xmlns:ns7="urn:cisco:params:xml:ns:yang:nrf-tp:v1" xmlns:ns6="urn:cisco:params:xml:ns:yang:nrf-tdm-cem-extension:v1" xmlns:ns5="urn:cisco:params:xml:ns:yang:nrf-ce-extension:v1" xmlns:ns4="urn:cisco:params:xml:ns:yang:nrf-common:v1" xmlns:ns3="urn:ietf:params:xml:ns:yang:ietf-restconf-monitoring" xmlns:ns2="urn:ietf:params:xml:ns:yang:ietf-yang-library">
  <ns4:header>
    <ns4:firstIndex>0</ns4:firstIndex>
    <ns4:lastIndex>2</ns4:lastIndex>
  </ns4:header>
  <ns4:data>
    <ns34:chassis>
      <ns32:name>SHELF</ns32:name>
      <ns34:connectors>
      </ns34:connectors>
      <ns34:contained-equipment>MD=CISCO_EPNM!ND=Site7ILA!EQ=name=SLOT-2;partnumber=15454-OPT-EDFA-17</ns34:contained-equipment>
      <ns34:contained-equipment>MD=CISCO_EPNM!ND=Site7ILA!EQ=name=SLOT-3;partnumber=NCS2K-EDRA2-26C</ns34:contained-equipment>
      <ns34:contained-equipment>MD=CISCO_EPNM!ND=Site7ILA!EQ=name=ECU-1;partnumber=NCS2006-ECU</ns34:contained-equipment>
      <ns34:contained-equipment>MD=CISCO_EPNM!ND=Site7ILA!EQ=name=SLOT-1;partnumber=NCS2K-TNCS-O-K9</ns34:contained-equipment>
      <ns34:contained-equipment>MD=CISCO_EPNM!ND=Site7ILA!EQ=name=SLOT-8;partnumber=NCS2K-TNCS-K9</ns34:contained-equipment>
      <ns34:contained-equipment>MD=CISCO_EPNM!ND=Site7ILA!EQ=name=PWR-A;partnumber=NCS2006-DC20</ns34:contained-equipment>
      <ns34:contained-equipment>MD=CISCO_EPNM!ND=Site7ILA!EQ=name=PWR-B;partnumber=NCS2006-DC20</ns34:contained-equipment>
      <ns34:contained-equipment>MD=CISCO_EPNM!ND=Site7ILA!EQ=name=FAN-1;partnumber=NCS2006-FTA</ns34:contained-equipment>
      <ns34:contained-equipment>MD=CISCO_EPNM!ND=Site7ILA!EQ=name=LCD-1;partnumber=NCS2006-LCD</ns34:contained-equipment>
      <ns34:ent-physical-index>SHELF</ns34:ent-physical-index>
      <ns34:equipment-type>CHASSIS</ns34:equipment-type>
      <ns34:fdn>MD=CISCO_EPNM!ND=Site7ILA!EQ=name=SHELF;partnumber=NCS2006-SA</ns34:fdn>
      <ns34:is-physically-present>true</ns34:is-physically-present>
      <ns34:is-reporting-alarms-allowed>UNKNOWN</ns34:is-reporting-alarms-allowed>
      <ns34:part-number>NCS2006-SA</ns34:part-number>
      <ns34:product-id>NCS2006-SA</ns34:product-id>
      <ns34:service-state>UNKNOWN</ns34:service-state>
      <ns34:vendor-equipment-type>WOM4C10KRA</ns34:vendor-equipment-type>
    </ns34:chassis>
    <ns34:chassis>
      <ns32:description>ASR 9006 4 Line Card Slot Chassis with V1 AC PEM</ns32:description>
      <ns32:name>chassis ASR-9006-AC</ns32:name>
      <ns34:assembly-revision>B1  </ns34:assembly-revision>
      <ns34:connectors>
      </ns34:connectors>
      <ns34:contained-equipment>MD=CISCO_EPNM!ND=rupesh-9006-a!EQ=name=slot 0/RSP0;partnumber=cevContainerASR9KRSPSlot</ns34:contained-equipment>
      <ns34:contained-equipment>MD=CISCO_EPNM!ND=rupesh-9006-a!EQ=name=slot 0/3;partnumber=cevContainerASR9KLCSlot</ns34:contained-equipment>
      <ns34:contained-equipment>MD=CISCO_EPNM!ND=rupesh-9006-a!EQ=name=slot 0/0;partnumber=cevContainerASR9KLCSlot</ns34:contained-equipment>
      <ns34:contained-equipment>MD=CISCO_EPNM!ND=rupesh-9006-a!EQ=name=slot 0/1;partnumber=cevContainerASR9KLCSlot</ns34:contained-equipment>
      <ns34:contained-equipment>MD=CISCO_EPNM!ND=rupesh-9006-a!EQ=name=slot 0/RSP1;partnumber=cevContainerASR9KRSPSlot</ns34:contained-equipment>
      <ns34:ent-physical-index>24555730</ns34:ent-physical-index>
      <ns34:equipment-type>CHASSIS</ns34:equipment-type>
      <ns34:fdn>MD=CISCO_EPNM!ND=rupesh-9006-a!EQ=name=chassis ASR-9006-AC;partnumber=ASR-9006-AC</ns34:fdn>
      <ns34:hardware-version>V01</ns34:hardware-version>
      <ns34:is-field-replaceable-unit>TRUE</ns34:is-field-replaceable-unit>
      <ns34:is-physically-present>true</ns34:is-physically-present>
      <ns34:is-reporting-alarms-allowed>UNKNOWN</ns34:is-reporting-alarms-allowed>
      <ns34:manufacturer>Cisco Systems Inc.</ns34:manufacturer>
      <ns34:operational-state-code>enabled</ns34:operational-state-code>
      <ns34:part-number>ASR-9006-AC</ns34:part-number>
      <ns34:product-id>ASR-9006-AC</ns34:product-id>
      <ns34:serial-number>FOX1325G3PB</ns34:serial-number>
      <ns34:service-state>UNKNOWN</ns34:service-state>
      <ns34:vendor-equipment-type>cevChassisASR9006AC</ns34:vendor-equipment-type>
    </ns34:chassis>
    <ns34:chassis>
      <ns32:description>NCS 4206 Series Router Chassis</ns32:description>
      <ns32:name>Chassis</ns32:name>
      <ns34:connectors>
      </ns34:connectors>
      <ns34:contained-equipment>MD=CISCO_EPNM!ND=NCS4206-146.4.cisco-lab!EQ=name=subslot 0/3;partnumber=NCS4200-48T3E3-CE</ns34:contained-equipment>
      <ns34:contained-equipment>MD=CISCO_EPNM!ND=NCS4206-146.4.cisco-lab!EQ=name=subslot 0/2;partnumber=A900-IMA8S</ns34:contained-equipment>
      <ns34:contained-equipment>MD=CISCO_EPNM!ND=NCS4206-146.4.cisco-lab!EQ=name=subslot 0/5;partnumber=NCS4200-1T8S-10CS</ns34:contained-equipment>
      <ns34:contained-equipment>MD=CISCO_EPNM!ND=NCS4206-146.4.cisco-lab!EQ=name=subslot 0/4;partnumber=cevContainerNCSLineCardSlot</ns34:contained-equipment>
      <ns34:contained-equipment>MD=CISCO_EPNM!ND=NCS4206-146.4.cisco-lab!EQ=name=Fan Tray Bay 0;partnumber=cevContainerNCSFanTraySlot</ns34:contained-equipment>
      <ns34:contained-equipment>MD=CISCO_EPNM!ND=NCS4206-146.4.cisco-lab!EQ=name=Power Supply Bay 1;partnumber=cevContainerNCSPwrTraySlot</ns34:contained-equipment>
      <ns34:contained-equipment>MD=CISCO_EPNM!ND=NCS4206-146.4.cisco-lab!EQ=name=Power Supply Bay 0;partnumber=cevContainerNCSPwrTraySlot</ns34:contained-equipment>
      <ns34:contained-equipment>MD=CISCO_EPNM!ND=NCS4206-146.4.cisco-lab!EQ=name=slot R1;partnumber=cevContainerNCSProcessorSlot</ns34:contained-equipment>
      <ns34:contained-equipment>MD=CISCO_EPNM!ND=NCS4206-146.4.cisco-lab!EQ=name=slot R0;partnumber=cevContainerNCSProcessorSlot</ns34:contained-equipment>
      <ns34:contained-equipment>MD=CISCO_EPNM!ND=NCS4206-146.4.cisco-lab!EQ=name=subslot 0/1;partnumber=NCS4200-48T1E1-CE</ns34:contained-equipment>
      <ns34:contained-equipment>MD=CISCO_EPNM!ND=NCS4206-146.4.cisco-lab!EQ=name=subslot 0/0;partnumber=NCS4200-8T-PS</ns34:contained-equipment>
      <ns34:ent-physical-index>1</ns34:ent-physical-index>
      <ns34:equipment-type>CHASSIS</ns34:equipment-type>
      <ns34:fdn>MD=CISCO_EPNM!ND=NCS4206-146.4.cisco-lab!EQ=name=Chassis;partnumber=NCS4206-SA</ns34:fdn>
      <ns34:hardware-version>V01</ns34:hardware-version>
      <ns34:is-field-replaceable-unit>TRUE</ns34:is-field-replaceable-unit>
      <ns34:is-physically-present>true</ns34:is-physically-present>
      <ns34:is-reporting-alarms-allowed>UNKNOWN</ns34:is-reporting-alarms-allowed>
      <ns34:manufacturer>Cisco Systems Inc</ns34:manufacturer>
      <ns34:operational-state-code>up</ns34:operational-state-code>
      <ns34:part-number>NCS4206-SA</ns34:part-number>
      <ns34:product-id>NCS4206-SA</ns34:product-id>
      <ns34:serial-number>FOX1752P0HE</ns34:serial-number>
      <ns34:service-state>UNKNOWN</ns34:service-state>
      <ns34:vendor-equipment-type>cevChassisNCS4206SA</ns34:vendor-equipment-type>
      <ns34:number-of-slots>0</ns34:number-of-slots>
    </ns34:chassis>
  </ns4:data>
</ns4:response-message>