{"type":"api","title":"Retrieves the Equipment in the system","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/28ed564a-8eed-31ee-a202-dcc7b5d361f7","info":{"title":"RESTCONF Inventory APIs","description":"RESTCONF Inventory APIs exposed by Inventory service.","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"1.0.0"},"tags":[{"name":"RESTCONF APIs","description":"Points to note: \nThe actual response will,\n- Have namespace prefixed in the attribute name\n- Not have attributes whose values are null\n- Have the attribute names \"-\" separated in some cases\n- Have additional section with firstIndex and lastIndex attributes"}],"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/inventory-restconf-api-overview.md"}},"openapi":"3.1.0","servers":[{"url":"https://{server_ip}:30603/crosswork/inventory/restconf/data/v2","description":"Generated server url"}]},"spec":{"tags":["RESTCONF APIs"],"summary":"Retrieves the Equipment in the system","description":"\u003cb\u003eBatch Retrieval\u003c/b\u003e \nThe default max batch size for retrieval is set to 100 and maximum 100 objects can be retrieved. \n\u003cb\u003e.startIndex=<value>\u003c/b\u003e 0 based index as a start index of the data to be retrieved \n\u003cb\u003e.maxCount=<value>\u003c/b\u003e Maximum number of objects to be retrieved \n\nAdditional filters can be provided as URL parameters e.g. \n\u003cb\u003efdn=<value>\u003c/b\u003e Fully Distinguished Name (FDN) of the Equipment to retrieve, e.g. 'MD=CISCO_EMS!ND=RON_NCS5700_14.cisco-lab.com!EQ=name=0/FT0;partnumber=800-107872-01' \nIt can be obtained from node API response '/crosswork/inventory/restconf/data/v2/resource-physical:equipment'. \nFor e.g. in the json format of the response, \"eq.fdn\": \"MD=CISCO_EMS!ND=RON_NCS5700_14.cisco-lab.com!EQ=name=0/FT0;partnumber=800-107872-01\"\n\n\u003cb\u003ename=<value>\u003c/b\u003e Name of the Equipment to retrieve (not unique), e.g. '0/FT0' \nIt can be obtained from node API response '/crosswork/inventory/restconf/data/v2/resource-physical:equipment'. \nFor e.g. in the json format of the response, \"fdtn.name\": \"0/FT0\"\n\n\u003cb\u003edescription=<value>\u003c/b\u003e Description of the Equipment to retrieve (not unique), e.g. 'NC57 C3 60 mm fan tray' \nIt can be obtained from node API response '/crosswork/inventory/restconf/data/v2/resource-physical:equipment'. \nFor e.g. in the json format of the response, \"fdtn.description\": \"NC57 C3 60 mm fan tray\"\n\n\u003cb\u003e<attribute>=<value>\u003c/b\u003e Uses any non-collection attribute to retrieve Equipment object(s) \n\u003cb\u003eNote:\u003c/b\u003e Attributes not supported in filter [contained-equipment-recurse, containing-equipment, contained-equipment]","operationId":"getEquipmentResources","responses":{"200":{"description":"Success with response message-body","content":{"application/json":{"schema":{"type":"object","description":"response","xml":{"name":"response-message","namespace":"urn:cisco:params:xml:ns:yang:nrf-common:v1","prefix":"ns14"},"properties":{"header":{"type":"object","description":"header","properties":{"firstIndex":{"type":"integer","format":"int64","description":"firstIndex","xml":{"prefix":"ns14"}},"lastIndex":{"type":"integer","format":"int64","description":"lastIndex","xml":{"prefix":"ns14"}}},"xml":{"prefix":"ns14"},"$$ref":"#/components/schemas/Header"},"data":{"type":"object","description":"data","xml":{"prefix":"ns14"},"properties":{"equipment":{"type":"array","description":"equipment","items":{"type":"object","description":"Represents a piece of hardware that has some well-specified function (for example, a line card, memory board, or power supply). The structure of an Equipment instance can be compound so that an instance of Equipment can contain one or more instances of Equipment (containment is represented by linking two instances of Equipment using the EquipmentHasEquipment association).","xml":{"name":"equipment","prefix":"ns13"},"properties":{"description":{"type":"string","description":"description","xml":{"name":"description","prefix":"ns12"}},"name":{"type":"string","description":"name","xml":{"name":"name","prefix":"ns12"}},"owningEntityId":{"type":"string","description":"owningEntityId"},"entityTag":{"type":"string","description":"Generic tag"},"debugMode":{"type":"boolean","description":"Debug mode"},"instanceId":{"type":"integer","description":"instanceId","xml":{"name":"instanceId","prefix":"ns13"},"format":"int64"},"businessKey":{"type":"string","description":"businessKey"},"administrativeStateCode":{"type":"string","description":"administrativeStateCode","xml":{"name":"administrative-state-code","prefix":"ns13"},"deprecated":true},"assemblyNumber":{"type":"string","description":"Assembly number","xml":{"name":"assembly-number","prefix":"ns13"}},"assemblyRevision":{"type":"string","description":"Assembly revision","xml":{"name":"assembly-revision","prefix":"ns13"}},"cleiCode":{"type":"string","description":"This object represents the CLEI (Common Language Equipment Identifier) code for the physical entity. If the physical entity is not present in the system, or does not have an associated CLEI code, the value of this object will be null","xml":{"name":"clei-code","prefix":"ns13"}},"configuredIMType":{"type":"string","description":"configuredIMType"},"deviationNumber":{"type":"string","description":"Deviation number","xml":{"name":"deviation-number","prefix":"ns13"}},"entPhysicalContainedIn":{"type":"string","description":"entPhysicalContainedIn"},"entPhysicalIndex":{"type":"string","description":"entPhysicalIndex"},"equipmentType":{"type":"string","description":"Equipment type","xml":{"name":"equipment-type","prefix":"ns13"},"enum":["OTHER","UNKNOWN","CHASSIS","BACKPLANE","POWERSUPPLY","FAN","MODULE","RACK","PROCESSOR","DISK","MEMORY_MODULE","COMPUTE_BLADE","CHASSIS_EXTENDER","MOTHERBOARD","IP_PHONE","WIRELESS_AP","PLUGGABLE_TRANSCEIVER"]},"formFactor":{"type":"string","description":"formFactor","xml":{"name":"form-factor","prefix":"ns13"}},"freeSlotNames":{"type":"string","description":"freeSlotNames","xml":{"name":"free-slot-names","prefix":"ns13"}},"genericAdminState":{"type":"string","description":"Generic admin state","xml":{"name":"generic-admin-state","prefix":"ns13"},"enum":["IS","IS_AINS","OOS_MT","OOS_DSBLD"]},"genericServiceState":{"type":"object","description":"GenericServiceState","properties":{"combinedState":{"type":"string","description":"combinedState","xml":{"name":"combined-state","prefix":"ns13"}},"primaryState":{"type":"string","description":"primaryState","xml":{"name":"primary-state","prefix":"ns13"},"enum":["N_A","IS","OOS"]},"primaryStateQualifier":{"type":"string","description":"primaryStateQualifier","xml":{"name":"primary-state-qualifier","prefix":"ns13"},"enum":["NR","ANR","RST","ANRST","AU","MA","AUMA","AURST","MAANR"]},"secondaryStates":{"uniqueItems":true,"type":"array","description":"secondaryStates","xml":{"name":"secondary-states","prefix":"ns13"},"items":{"type":"string","enum":["ACT","AINS","BLKD","BUSY","CEMA","COMB","DCHL","DSBLD","EX","FAF","FEPO","FLT","IDLE","IDLERCV","IDLETRMT","INHIP","L1ACT","L1DEACT","LKDO","LPBK","MEA","MON","MT","MTCELIMD","NALM","NALMNR","NALMCD","NALMTI","NBK","OVFL","PMI","PPS","PRI","PRTCL","PSE","PSI","PWR","RAR","RDLD","SB","SDEA","SDEE","SGEO","SGES","SO","ST","STBYC","STBYH","STBYI","STBYS","SWDL","SWTCH","SWTI","SWTO","SWUL","TRD","TRMB","TRMF","TRMT","TS","TSTF","UAS","UEQ","WRK"]}}},"$$ref":"#/components/schemas/GenericServiceState"},"hardwareVersion":{"type":"string","description":"hardwareVersion","xml":{"name":"hardware-version","prefix":"ns13"}},"isFRUable":{"type":"string","description":"isFRUable","xml":{"name":"is-field-replaceable-unit","prefix":"ns13"},"enum":["UNKNOWN","TRUE","FALSE","NOT_APPLICABLE"]},"isInMaintenance":{"type":"boolean","description":"isInMaintenance"},"isPhysicallyPresent":{"type":"boolean","description":"isPhysicallyPresent","xml":{"name":"is-physically-present","prefix":"ns13"}},"isReportingAlarmsAllowed":{"type":"string","description":"isReportingAlarmsAllowed","xml":{"name":"is-reporting-alarms-allowed","prefix":"ns13"},"enum":["UNKNOWN","TRUE","FALSE","NOT_APPLICABLE"]},"manufacturedDate":{"type":"string","description":"manufacturedDate","xml":{"name":"manufactured-date","prefix":"ns13"},"format":"date-time"},"manufacturer":{"type":"string","description":"manufacturer","xml":{"name":"manufacturer","prefix":"ns13"}},"mtosiLabel":{"type":"string","description":"mtosiLabel"},"operationalStateCode":{"type":"string","description":"operationalStateCode","xml":{"name":"operational-state-code","prefix":"ns13"},"deprecated":true},"partNumber":{"type":"string","description":"partNumber","xml":{"name":"part-number","prefix":"ns13"}},"position":{"uniqueItems":true,"type":"array","description":"position","xml":{"name":"position","prefix":"ns13"},"deprecated":true,"items":{"type":"string"}},"productFamily":{"type":"string","description":"productFamily","xml":{"name":"product-family","prefix":"ns13"}},"productId":{"type":"string","description":"productId","xml":{"name":"product-id","prefix":"ns13"}},"productName":{"type":"string","description":"productName","xml":{"name":"product-name","prefix":"ns13"}},"restconfFdn":{"type":"string","description":"restconfFdn"},"serialNumber":{"type":"string","description":"serialNumber","xml":{"name":"serial-number","prefix":"ns13"}},"serviceState":{"type":"string","description":"serviceState","xml":{"name":"service-state","prefix":"ns13"},"enum":["STANDBY","UNKNOWN","INSERVICE","OUTOFSERVICE","OUTOFSERVICE_FORMAINTENANCE","NOT_APPLICABLE","SOFTWARE_DOWNLOAD","NOT_INSTALLED","MISMATCH_OF_EQUIPMENT_ALARM"]},"subclassName":{"type":"string","description":"subclassName","xml":{"name":"subclass-name","prefix":"ns13"}},"udi":{"type":"string","description":"udi","xml":{"name":"udi","prefix":"ns13"}},"vendorEquipmentType":{"type":"string","description":"vendorEquipmentType","xml":{"name":"vendor-equipment-type","prefix":"ns13"}},"fdn":{"type":"string","description":"fdn","xml":{"name":"fdn","prefix":"ns13"}},"connectors":{"uniqueItems":true,"type":"array","description":"uniqueItems","xml":{"name":"unique-items","prefix":"ns13"},"items":{"type":"object","description":"PhysicalConnector","xml":{"name":"physical-connector","prefix":"ns13"},"properties":{"description":{"type":"string","description":"description","xml":{"name":"description","prefix":"ns12"}},"name":{"type":"string","description":"name","xml":{"name":"name","prefix":"ns12"}},"owningEntityId":{"type":"string","description":"owningEntityId"},"entityTag":{"type":"string","description":"Generic tag"},"debugMode":{"type":"boolean","description":"Debug mode"},"instanceId":{"type":"integer","description":"Instance id","xml":{"name":"instanceId","prefix":"ns13"},"format":"int64"},"businessKey":{"type":"string","description":"Business key"},"aliasName":{"type":"string","description":"Alias name"},"connectorType":{"type":"string","description":"Connector type"},"entAliasLogicalIndexOrZero":{"type":"string","description":"entAliasLogicalIndexOrZero"},"entPhysicalContainedIn":{"type":"string","description":"entPhysicalContainedIn"},"entPhysicalIndex":{"type":"string","description":"entPhysicalIndex"},"restconfFdn":{"type":"string","description":"restconfFdn"},"vendorEquipmentType":{"type":"string","description":"vendorEquipmentType"},"fdn":{"type":"string","description":"fdn","xml":{"name":"fdn","prefix":"ns13"}},"equipment":{"type":"string","description":"equipment"}},"$$ref":"#/components/schemas/PhysicalConnector"}},"containingEquipment":{"type":"string","description":"containingEquipment","xml":{"name":"containing-equipment","prefix":"ns13"}},"containedEquipmentString":{"type":"array","description":"containedEquipmentString","xml":{"name":"contained-equipment-string","prefix":"ns13"},"items":{"type":"string"}},"processedDescription":{"type":"object","description":"processedDescription","xml":{"name":"processed-description","prefix":"ns13"},"additionalProperties":{"type":"string","description":"additionalProperties","xml":{"name":"additional-properties","prefix":"ns13"}}}},"$$ref":"#/components/schemas/Equipment"}},"module":{"type":"array","description":"termination point","items":{"type":"object","description":"Module","xml":{"name":"module","prefix":"ns13"},"properties":{"description":{"type":"string","description":"description","xml":{"name":"description","prefix":"ns13"}},"name":{"type":"string","description":"name","xml":{"name":"name","prefix":"ns13"}},"owningEntityId":{"type":"string","description":"owningEntityId"},"entityTag":{"type":"string","description":"Generic tag"},"debugMode":{"type":"boolean","description":"debugMode"},"instanceId":{"type":"integer","description":"instanceId","xml":{"name":"instanceId","prefix":"ns13"},"format":"int64"},"businessKey":{"type":"string","description":"businessKey"},"administrativeStateCode":{"type":"string","description":"administrativeStateCode","xml":{"name":"administrative-state-code","prefix":"ns13"},"deprecated":true},"assemblyNumber":{"type":"string","description":"assemblyNumber","xml":{"name":"assembly-number","prefix":"ns13"}},"assemblyRevision":{"type":"string","description":"assemblyRevision","xml":{"name":"assembly-revision","prefix":"ns13"}},"cleiCode":{"type":"string","description":"cleiCode","xml":{"name":"clei-code","prefix":"ns13"}},"configuredIMType":{"type":"string","description":"configuredIMType","xml":{"name":"configured-IM-type","prefix":"ns13"}},"deviationNumber":{"type":"string","description":"deviationumber","xml":{"name":"deviation-number","prefix":"ns13"}},"entPhysicalContainedIn":{"type":"string","description":"entPhysicalContainedIn","xml":{"name":"ent-physical-contained-in","prefix":"ns13"}},"entPhysicalIndex":{"type":"string","description":"entPhysicalIndex","xml":{"name":"ent-pysical-index","prefix":"ns13"}},"equipmentType":{"type":"string","description":"equipmentType","xml":{"name":"equipment-type","prefix":"ns13"},"enum":["OTHER","UNKNOWN","CHASSIS","BACKPLANE","POWERSUPPLY","FAN","MODULE","RACK","PROCESSOR","DISK","MEMORY_MODULE","COMPUTE_BLADE","CHASSIS_EXTENDER","MOTHERBOARD","IP_PHONE","WIRELESS_AP","PLUGGABLE_TRANSCEIVER"]},"formFactor":{"type":"string","description":"formFactor","xml":{"name":"form-factor","prefix":"ns13"}},"freeSlotNames":{"type":"string","description":"freeSlotNames","xml":{"name":"free-slot-names","prefix":"ns13"}},"genericAdminState":{"type":"string","description":"Generic admin state","xml":{"name":"generic-admin-state","prefix":"ns13"},"enum":["IS","IS_AINS","OOS_MT","OOS_DSBLD"]},"genericServiceState":{"type":"object","description":"GenericServiceState","properties":{"combinedState":{"type":"string","description":"combinedState","xml":{"name":"combined-state","prefix":"ns13"}},"primaryState":{"type":"string","description":"primaryState","xml":{"name":"primary-state","prefix":"ns13"},"enum":["N_A","IS","OOS"]},"primaryStateQualifier":{"type":"string","description":"primaryStateQualifier","xml":{"name":"primary-state-qualifier","prefix":"ns13"},"enum":["NR","ANR","RST","ANRST","AU","MA","AUMA","AURST","MAANR"]},"secondaryStates":{"uniqueItems":true,"type":"array","description":"secondaryStates","xml":{"name":"secondary-states","prefix":"ns13"},"items":{"type":"string","enum":["ACT","AINS","BLKD","BUSY","CEMA","COMB","DCHL","DSBLD","EX","FAF","FEPO","FLT","IDLE","IDLERCV","IDLETRMT","INHIP","L1ACT","L1DEACT","LKDO","LPBK","MEA","MON","MT","MTCELIMD","NALM","NALMNR","NALMCD","NALMTI","NBK","OVFL","PMI","PPS","PRI","PRTCL","PSE","PSI","PWR","RAR","RDLD","SB","SDEA","SDEE","SGEO","SGES","SO","ST","STBYC","STBYH","STBYI","STBYS","SWDL","SWTCH","SWTI","SWTO","SWUL","TRD","TRMB","TRMF","TRMT","TS","TSTF","UAS","UEQ","WRK"]}}},"$$ref":"#/components/schemas/GenericServiceState"},"hardwareVersion":{"type":"string","description":"hardwareVersion","xml":{"name":"hardware-version","prefix":"ns13"}},"isFRUable":{"type":"string","description":"isFRUable","xml":{"name":"is-field-replaceable-unit","prefix":"ns13"},"enum":["UNKNOWN","TRUE","FALSE","NOT_APPLICABLE"]},"isInMaintenance":{"type":"boolean","description":"isInMaintenance"},"isPhysicallyPresent":{"type":"boolean","description":"is physically present","xml":{"name":"is-physically-present","prefix":"ns13"}},"isReportingAlarmsAllowed":{"type":"string","description":"isReportingAlarmsAllowed","xml":{"name":"is-reporting-alarms-allowed","prefix":"ns13"},"enum":["UNKNOWN","TRUE","FALSE","NOT_APPLICABLE"]},"manufacturedDate":{"type":"string","description":"manufacturedDate","xml":{"name":"manufactured-date","prefix":"ns13"},"format":"date-time"},"manufacturer":{"type":"string","description":"manufacturer","xml":{"name":"manufacturer","prefix":"ns13"}},"mtosiLabel":{"type":"string","description":"mtosiLabel"},"operationalStateCode":{"type":"string","description":"operationalStateCode","xml":{"name":"operational-state-code","prefix":"ns13"},"deprecated":true},"partNumber":{"type":"string","description":"partNumber","xml":{"name":"part-number","prefix":"ns13"}},"position":{"uniqueItems":true,"type":"array","description":"position","xml":{"name":"position","prefix":"ns13"},"deprecated":true,"items":{"type":"string"}},"productFamily":{"type":"string","description":"productFamily","xml":{"name":"product-family","prefix":"ns13"}},"productId":{"type":"string","description":"productId","xml":{"name":"product-id","prefix":"ns13"}},"productName":{"type":"string","description":"productName","xml":{"name":"product-name","prefix":"ns13"}},"restconfFdn":{"type":"string","description":"restconfFdn"},"serialNumber":{"type":"string","description":"serialNumber","xml":{"name":"serial-number","prefix":"ns13"}},"serviceState":{"type":"string","description":"serviceState","xml":{"name":"service-state","prefix":"ns13"},"enum":["STANDBY","UNKNOWN","INSERVICE","OUTOFSERVICE","OUTOFSERVICE_FORMAINTENANCE","NOT_APPLICABLE","SOFTWARE_DOWNLOAD","NOT_INSTALLED","MISMATCH_OF_EQUIPMENT_ALARM"]},"subclassName":{"type":"string","description":"subclassName","xml":{"name":"subclass-name","prefix":"ns13"}},"udi":{"type":"string","description":"udi","xml":{"name":"udi","prefix":"ns13"}},"vendorEquipmentType":{"type":"string","description":"vendorEquipmentType","xml":{"name":"vendor-equipment-type","prefix":"ns13"}},"fdn":{"type":"string","description":"fdn","xml":{"name":"fdn","prefix":"ns13"}},"connectors":{"uniqueItems":true,"type":"array","description":"connectors","items":{"type":"object","description":"PhysicalConnector","xml":{"name":"physical-connector","prefix":"ns13"},"properties":{"description":{"type":"string","description":"description","xml":{"name":"description","prefix":"ns12"}},"name":{"type":"string","description":"name","xml":{"name":"name","prefix":"ns12"}},"owningEntityId":{"type":"string","description":"owningEntityId"},"entityTag":{"type":"string","description":"Generic tag"},"debugMode":{"type":"boolean","description":"Debug mode"},"instanceId":{"type":"integer","description":"Instance id","xml":{"name":"instanceId","prefix":"ns13"},"format":"int64"},"businessKey":{"type":"string","description":"Business key"},"aliasName":{"type":"string","description":"Alias name"},"connectorType":{"type":"string","description":"Connector type"},"entAliasLogicalIndexOrZero":{"type":"string","description":"entAliasLogicalIndexOrZero"},"entPhysicalContainedIn":{"type":"string","description":"entPhysicalContainedIn"},"entPhysicalIndex":{"type":"string","description":"entPhysicalIndex"},"restconfFdn":{"type":"string","description":"restconfFdn"},"vendorEquipmentType":{"type":"string","description":"vendorEquipmentType"},"fdn":{"type":"string","description":"fdn","xml":{"name":"fdn","prefix":"ns13"}},"equipment":{"type":"string","description":"equipment"}},"$$ref":"#/components/schemas/PhysicalConnector"}},"containedEquipment":{"uniqueItems":true,"type":"array","description":"containedEquipment","xml":{"name":"contained-equipment","prefix":"ns13"},"items":{"type":"object","description":"Represents a piece of hardware that has some well-specified function (for example, a line card, memory board, or power supply). The structure of an Equipment instance can be compound so that an instance of Equipment can contain one or more instances of Equipment (containment is represented by linking two instances of Equipment using the EquipmentHasEquipment association).","xml":{"name":"equipment","prefix":"ns13"},"properties":{"description":{"type":"string","description":"description","xml":{"name":"description","prefix":"ns12"}},"name":{"type":"string","description":"name","xml":{"name":"name","prefix":"ns12"}},"owningEntityId":{"type":"string","description":"owningEntityId"},"entityTag":{"type":"string","description":"Generic tag"},"debugMode":{"type":"boolean","description":"Debug mode"},"instanceId":{"type":"integer","description":"instanceId","xml":{"name":"instanceId","prefix":"ns13"},"format":"int64"},"businessKey":{"type":"string","description":"businessKey"},"administrativeStateCode":{"type":"string","description":"administrativeStateCode","xml":{"name":"administrative-state-code","prefix":"ns13"},"deprecated":true},"assemblyNumber":{"type":"string","description":"Assembly number","xml":{"name":"assembly-number","prefix":"ns13"}},"assemblyRevision":{"type":"string","description":"Assembly revision","xml":{"name":"assembly-revision","prefix":"ns13"}},"cleiCode":{"type":"string","description":"This object represents the CLEI (Common Language Equipment Identifier) code for the physical entity. If the physical entity is not present in the system, or does not have an associated CLEI code, the value of this object will be null","xml":{"name":"clei-code","prefix":"ns13"}},"configuredIMType":{"type":"string","description":"configuredIMType"},"deviationNumber":{"type":"string","description":"Deviation number","xml":{"name":"deviation-number","prefix":"ns13"}},"entPhysicalContainedIn":{"type":"string","description":"entPhysicalContainedIn"},"entPhysicalIndex":{"type":"string","description":"entPhysicalIndex"},"equipmentType":{"type":"string","description":"Equipment type","xml":{"name":"equipment-type","prefix":"ns13"},"enum":["OTHER","UNKNOWN","CHASSIS","BACKPLANE","POWERSUPPLY","FAN","MODULE","RACK","PROCESSOR","DISK","MEMORY_MODULE","COMPUTE_BLADE","CHASSIS_EXTENDER","MOTHERBOARD","IP_PHONE","WIRELESS_AP","PLUGGABLE_TRANSCEIVER"]},"formFactor":{"type":"string","description":"formFactor","xml":{"name":"form-factor","prefix":"ns13"}},"freeSlotNames":{"type":"string","description":"freeSlotNames","xml":{"name":"free-slot-names","prefix":"ns13"}},"genericAdminState":{"type":"string","description":"Generic admin state","xml":{"name":"generic-admin-state","prefix":"ns13"},"enum":["IS","IS_AINS","OOS_MT","OOS_DSBLD"]},"genericServiceState":{"type":"object","description":"GenericServiceState","properties":{"combinedState":{"type":"string","description":"combinedState","xml":{"name":"combined-state","prefix":"ns13"}},"primaryState":{"type":"string","description":"primaryState","xml":{"name":"primary-state","prefix":"ns13"},"enum":["N_A","IS","OOS"]},"primaryStateQualifier":{"type":"string","description":"primaryStateQualifier","xml":{"name":"primary-state-qualifier","prefix":"ns13"},"enum":["NR","ANR","RST","ANRST","AU","MA","AUMA","AURST","MAANR"]},"secondaryStates":{"uniqueItems":true,"type":"array","description":"secondaryStates","xml":{"name":"secondary-states","prefix":"ns13"},"items":{"type":"string","enum":["ACT","AINS","BLKD","BUSY","CEMA","COMB","DCHL","DSBLD","EX","FAF","FEPO","FLT","IDLE","IDLERCV","IDLETRMT","INHIP","L1ACT","L1DEACT","LKDO","LPBK","MEA","MON","MT","MTCELIMD","NALM","NALMNR","NALMCD","NALMTI","NBK","OVFL","PMI","PPS","PRI","PRTCL","PSE","PSI","PWR","RAR","RDLD","SB","SDEA","SDEE","SGEO","SGES","SO","ST","STBYC","STBYH","STBYI","STBYS","SWDL","SWTCH","SWTI","SWTO","SWUL","TRD","TRMB","TRMF","TRMT","TS","TSTF","UAS","UEQ","WRK"]}}},"$$ref":"#/components/schemas/GenericServiceState"},"hardwareVersion":{"type":"string","description":"hardwareVersion","xml":{"name":"hardware-version","prefix":"ns13"}},"isFRUable":{"type":"string","description":"isFRUable","xml":{"name":"is-field-replaceable-unit","prefix":"ns13"},"enum":["UNKNOWN","TRUE","FALSE","NOT_APPLICABLE"]},"isInMaintenance":{"type":"boolean","description":"isInMaintenance"},"isPhysicallyPresent":{"type":"boolean","description":"isPhysicallyPresent","xml":{"name":"is-physically-present","prefix":"ns13"}},"isReportingAlarmsAllowed":{"type":"string","description":"isReportingAlarmsAllowed","xml":{"name":"is-reporting-alarms-allowed","prefix":"ns13"},"enum":["UNKNOWN","TRUE","FALSE","NOT_APPLICABLE"]},"manufacturedDate":{"type":"string","description":"manufacturedDate","xml":{"name":"manufactured-date","prefix":"ns13"},"format":"date-time"},"manufacturer":{"type":"string","description":"manufacturer","xml":{"name":"manufacturer","prefix":"ns13"}},"mtosiLabel":{"type":"string","description":"mtosiLabel"},"operationalStateCode":{"type":"string","description":"operationalStateCode","xml":{"name":"operational-state-code","prefix":"ns13"},"deprecated":true},"partNumber":{"type":"string","description":"partNumber","xml":{"name":"part-number","prefix":"ns13"}},"position":{"uniqueItems":true,"type":"array","description":"position","xml":{"name":"position","prefix":"ns13"},"deprecated":true,"items":{"type":"string"}},"productFamily":{"type":"string","description":"productFamily","xml":{"name":"product-family","prefix":"ns13"}},"productId":{"type":"string","description":"productId","xml":{"name":"product-id","prefix":"ns13"}},"productName":{"type":"string","description":"productName","xml":{"name":"product-name","prefix":"ns13"}},"restconfFdn":{"type":"string","description":"restconfFdn"},"serialNumber":{"type":"string","description":"serialNumber","xml":{"name":"serial-number","prefix":"ns13"}},"serviceState":{"type":"string","description":"serviceState","xml":{"name":"service-state","prefix":"ns13"},"enum":["STANDBY","UNKNOWN","INSERVICE","OUTOFSERVICE","OUTOFSERVICE_FORMAINTENANCE","NOT_APPLICABLE","SOFTWARE_DOWNLOAD","NOT_INSTALLED","MISMATCH_OF_EQUIPMENT_ALARM"]},"subclassName":{"type":"string","description":"subclassName","xml":{"name":"subclass-name","prefix":"ns13"}},"udi":{"type":"string","description":"udi","xml":{"name":"udi","prefix":"ns13"}},"vendorEquipmentType":{"type":"string","description":"vendorEquipmentType","xml":{"name":"vendor-equipment-type","prefix":"ns13"}},"fdn":{"type":"string","description":"fdn","xml":{"name":"fdn","prefix":"ns13"}},"connectors":{"uniqueItems":true,"type":"array","description":"uniqueItems","xml":{"name":"unique-items","prefix":"ns13"},"items":{"type":"object","description":"PhysicalConnector","xml":{"name":"physical-connector","prefix":"ns13"},"properties":{"description":{"type":"string","description":"description","xml":{"name":"description","prefix":"ns12"}},"name":{"type":"string","description":"name","xml":{"name":"name","prefix":"ns12"}},"owningEntityId":{"type":"string","description":"owningEntityId"},"entityTag":{"type":"string","description":"Generic tag"},"debugMode":{"type":"boolean","description":"Debug mode"},"instanceId":{"type":"integer","description":"Instance id","xml":{"name":"instanceId","prefix":"ns13"},"format":"int64"},"businessKey":{"type":"string","description":"Business key"},"aliasName":{"type":"string","description":"Alias name"},"connectorType":{"type":"string","description":"Connector type"},"entAliasLogicalIndexOrZero":{"type":"string","description":"entAliasLogicalIndexOrZero"},"entPhysicalContainedIn":{"type":"string","description":"entPhysicalContainedIn"},"entPhysicalIndex":{"type":"string","description":"entPhysicalIndex"},"restconfFdn":{"type":"string","description":"restconfFdn"},"vendorEquipmentType":{"type":"string","description":"vendorEquipmentType"},"fdn":{"type":"string","description":"fdn","xml":{"name":"fdn","prefix":"ns13"}},"equipment":{"type":"string","description":"equipment"}},"$$ref":"#/components/schemas/PhysicalConnector"}},"containingEquipment":{"type":"string","description":"containingEquipment","xml":{"name":"containing-equipment","prefix":"ns13"}},"containedEquipmentString":{"type":"array","description":"containedEquipmentString","xml":{"name":"contained-equipment-string","prefix":"ns13"},"items":{"type":"string"}},"processedDescription":{"type":"object","description":"processedDescription","xml":{"name":"processed-description","prefix":"ns13"},"additionalProperties":{"type":"string","description":"additionalProperties","xml":{"name":"additional-properties","prefix":"ns13"}}}},"$$ref":"#/components/schemas/Equipment"}},"containingEquipment":{"type":"string","description":"containingEquipment","xml":{"name":"containing-equipment","prefix":"ns13"}},"isInlinePowercapable":{"type":"boolean","description":"isInlinePowercapable","xml":{"name":"is-inline-power-capable","prefix":"ns13"}},"moduleIndex":{"type":"integer","description":"moduleIndex","xml":{"name":"module-index","prefix":"ns13"},"format":"int32"},"nrFreeSlots":{"type":"integer","description":"nrFreeSlots","xml":{"name":"nr-free-slots","prefix":"ns13"},"format":"int32"},"nrPorts":{"type":"integer","description":"nrPorts","xml":{"name":"nr-ports","prefix":"ns13"},"format":"int32"},"nrSlots":{"type":"integer","description":"nrSlots","xml":{"name":"nr-slots","prefix":"ns13"},"format":"int32"},"protectionRole":{"type":"string","description":"protectionRole","xml":{"name":"protection-role","prefix":"ns13"},"enum":["NOT_APPLICABLE","ACTIVE","STANDBY"]},"qos10gOnlyMode":{"type":"boolean","description":"qos10gOnlyMode","xml":{"name":"qos-10g-only-mode","prefix":"ns13"}},"resetReason":{"type":"string","description":"resetReason","xml":{"name":"reset-reason","prefix":"ns13"},"enum":["UNKNOWN","POWERUP","PARITYERROR","CLEARCONFIGRESET","MANUALRESET","WATCHDOGTIMEOUTRESET","RESOURCEOVERFLOWRESET","MISSINGTASKRESET","LOWVOLTAGERESET","CONTROLLERRESET","SYSTEMRESET","SWITCHOVERRESET","UPGRADERESET","DOWNGRADERESET","CACHEERRORRESET","DEVICEDRIVERRESET","SOFTWAREEXCEPTIONRESET","RESTORECONFIGRESET","ABORTREVRESET","BURNBOOTRESET","STANDBYCDHEALTHIERRESET","NONNATIVECONFIGCLEARRESET","MEMORYPROTECTIONERRORRESET"]},"resetReasonDescription":{"type":"string","description":"resetReasonDescription","xml":{"name":"reset-reason-description","prefix":"ns13"}},"containedEquipmentString":{"type":"array","description":"containedEquipmentString","xml":{"name":"contained-equipment-string","prefix":"ns13"},"items":{"type":"string"}},"processedDescription":{"type":"object","description":"processedDescription","xml":{"name":"processed-description","prefix":"ns13"},"additionalProperties":{"type":"string","description":"additionalProperties","xml":{"name":"additional-properties","prefix":"ns13"}}}},"$$ref":"#/components/schemas/Module"}},"chassis":{"type":"array","description":"equipment","items":{"type":"object","description":"chassis","xml":{"name":"chassis","prefix":"ns13"},"properties":{"description":{"type":"string","description":"description","xml":{"name":"description","prefix":"ns13"}},"name":{"type":"string","description":"name","xml":{"name":"name","prefix":"ns13"}},"owningEntityId":{"type":"string","description":"owningEntityId"},"entityTag":{"type":"string","description":"Generic tag"},"debugMode":{"type":"boolean","description":"debugMode"},"instanceId":{"type":"integer","description":"instanceId","xml":{"name":"instanceId","prefix":"ns13"},"format":"int64"},"businessKey":{"type":"string","description":"businessKey"},"administrativeStateCode":{"type":"string","description":"administrativeStateCode","xml":{"name":"administrative-state-code","prefix":"ns13"},"deprecated":true},"assemblyNumber":{"type":"string","description":"assemblyNumber","xml":{"name":"assembly-number","prefix":"ns13"}},"assemblyRevision":{"type":"string","description":"assemblyRevision","xml":{"name":"assembly-revision","prefix":"ns13"}},"cleiCode":{"type":"string","description":"cleiCode","xml":{"name":"clei-code","prefix":"ns13"}},"configuredIMType":{"type":"string","description":"configuredIMType","xml":{"name":"configured-IM-type","prefix":"ns13"}},"deviationNumber":{"type":"string","description":"deviationumber","xml":{"name":"deviation-number","prefix":"ns13"}},"entPhysicalContainedIn":{"type":"string","description":"entPhysicalContainedIn","xml":{"name":"ent-physical-contained-in","prefix":"ns13"}},"entPhysicalIndex":{"type":"string","description":"entPhysicalIndex","xml":{"name":"ent-pysical-index","prefix":"ns13"}},"equipmentType":{"type":"string","description":"equipmentType","xml":{"name":"equipment-type","prefix":"ns13"},"enum":["OTHER","UNKNOWN","CHASSIS","BACKPLANE","POWERSUPPLY","FAN","MODULE","RACK","PROCESSOR","DISK","MEMORY_MODULE","COMPUTE_BLADE","CHASSIS_EXTENDER","MOTHERBOARD","IP_PHONE","WIRELESS_AP","PLUGGABLE_TRANSCEIVER"]},"formFactor":{"type":"string","description":"formFactor","xml":{"name":"form-factor","prefix":"ns13"}},"freeSlotNames":{"type":"string","description":"freeSlotNames","xml":{"name":"free-slot-names","prefix":"ns13"}},"genericAdminState":{"type":"string","description":"Generic admin state","xml":{"name":"generic-admin-state","prefix":"ns13"},"enum":["IS","IS_AINS","OOS_MT","OOS_DSBLD"]},"genericServiceState":{"type":"object","description":"GenericServiceState","properties":{"combinedState":{"type":"string","description":"combinedState","xml":{"name":"combined-state","prefix":"ns13"}},"primaryState":{"type":"string","description":"primaryState","xml":{"name":"primary-state","prefix":"ns13"},"enum":["N_A","IS","OOS"]},"primaryStateQualifier":{"type":"string","description":"primaryStateQualifier","xml":{"name":"primary-state-qualifier","prefix":"ns13"},"enum":["NR","ANR","RST","ANRST","AU","MA","AUMA","AURST","MAANR"]},"secondaryStates":{"uniqueItems":true,"type":"array","description":"secondaryStates","xml":{"name":"secondary-states","prefix":"ns13"},"items":{"type":"string","enum":["ACT","AINS","BLKD","BUSY","CEMA","COMB","DCHL","DSBLD","EX","FAF","FEPO","FLT","IDLE","IDLERCV","IDLETRMT","INHIP","L1ACT","L1DEACT","LKDO","LPBK","MEA","MON","MT","MTCELIMD","NALM","NALMNR","NALMCD","NALMTI","NBK","OVFL","PMI","PPS","PRI","PRTCL","PSE","PSI","PWR","RAR","RDLD","SB","SDEA","SDEE","SGEO","SGES","SO","ST","STBYC","STBYH","STBYI","STBYS","SWDL","SWTCH","SWTI","SWTO","SWUL","TRD","TRMB","TRMF","TRMT","TS","TSTF","UAS","UEQ","WRK"]}}},"$$ref":"#/components/schemas/GenericServiceState"},"hardwareVersion":{"type":"string","description":"hardwareVersion","xml":{"name":"hardware-version","prefix":"ns13"}},"isFRUable":{"type":"string","description":"isFRUable","xml":{"name":"is-field-replaceable-unit","prefix":"ns13"},"enum":["UNKNOWN","TRUE","FALSE","NOT_APPLICABLE"]},"isInMaintenance":{"type":"boolean","description":"isInMaintenance"},"isPhysicallyPresent":{"type":"boolean","description":"is physically present","xml":{"name":"is-physically-present","prefix":"ns13"}},"isReportingAlarmsAllowed":{"type":"string","description":"isReportingAlarmsAllowed","xml":{"name":"is-reporting-alarms-allowed","prefix":"ns13"},"enum":["UNKNOWN","TRUE","FALSE","NOT_APPLICABLE"]},"manufacturedDate":{"type":"string","description":"manufacturedDate","xml":{"name":"manufactured-date","prefix":"ns13"},"format":"date-time"},"manufacturer":{"type":"string","description":"manufacturer","xml":{"name":"manufacturer","prefix":"ns13"}},"mtosiLabel":{"type":"string","description":"mtosiLabel"},"operationalStateCode":{"type":"string","description":"operationalStateCode","xml":{"name":"operational-state-code","prefix":"ns13"},"deprecated":true},"partNumber":{"type":"string","description":"partNumber","xml":{"name":"part-number","prefix":"ns13"}},"position":{"uniqueItems":true,"type":"array","description":"position","xml":{"name":"position","prefix":"ns13"},"deprecated":true,"items":{"type":"string"}},"productFamily":{"type":"string","description":"productFamily","xml":{"name":"product-family","prefix":"ns13"}},"productId":{"type":"string","description":"productId","xml":{"name":"product-id","prefix":"ns13"}},"productName":{"type":"string","description":"productName","xml":{"name":"product-name","prefix":"ns13"}},"restconfFdn":{"type":"string","description":"restconfFdn"},"serialNumber":{"type":"string","description":"serialNumber","xml":{"name":"serial-number","prefix":"ns13"}},"serviceState":{"type":"string","description":"serviceState","xml":{"name":"service-state","prefix":"ns13"},"enum":["STANDBY","UNKNOWN","INSERVICE","OUTOFSERVICE","OUTOFSERVICE_FORMAINTENANCE","NOT_APPLICABLE","SOFTWARE_DOWNLOAD","NOT_INSTALLED","MISMATCH_OF_EQUIPMENT_ALARM"]},"subclassName":{"type":"string","description":"subclassName","xml":{"name":"subclass-name","prefix":"ns13"}},"udi":{"type":"string","description":"udi","xml":{"name":"udi","prefix":"ns13"}},"vendorEquipmentType":{"type":"string","description":"vendorEquipmentType","xml":{"name":"vendor-equipment-type","prefix":"ns13"}},"fdn":{"type":"string","description":"fdn","xml":{"name":"fdn","prefix":"ns13"}},"connectors":{"uniqueItems":true,"type":"array","description":"connectors","items":{"type":"object","description":"PhysicalConnector","xml":{"name":"physical-connector","prefix":"ns13"},"properties":{"description":{"type":"string","description":"description","xml":{"name":"description","prefix":"ns12"}},"name":{"type":"string","description":"name","xml":{"name":"name","prefix":"ns12"}},"owningEntityId":{"type":"string","description":"owningEntityId"},"entityTag":{"type":"string","description":"Generic tag"},"debugMode":{"type":"boolean","description":"Debug mode"},"instanceId":{"type":"integer","description":"Instance id","xml":{"name":"instanceId","prefix":"ns13"},"format":"int64"},"businessKey":{"type":"string","description":"Business key"},"aliasName":{"type":"string","description":"Alias name"},"connectorType":{"type":"string","description":"Connector type"},"entAliasLogicalIndexOrZero":{"type":"string","description":"entAliasLogicalIndexOrZero"},"entPhysicalContainedIn":{"type":"string","description":"entPhysicalContainedIn"},"entPhysicalIndex":{"type":"string","description":"entPhysicalIndex"},"restconfFdn":{"type":"string","description":"restconfFdn"},"vendorEquipmentType":{"type":"string","description":"vendorEquipmentType"},"fdn":{"type":"string","description":"fdn","xml":{"name":"fdn","prefix":"ns13"}},"equipment":{"type":"string","description":"equipment"}},"$$ref":"#/components/schemas/PhysicalConnector"}},"contained-equipment":{"uniqueItems":true,"type":"array","description":"containedEquipment","xml":{"name":"contained-equipment","prefix":"ns13"},"items":{"type":"object","description":"Represents a piece of hardware that has some well-specified function (for example, a line card, memory board, or power supply). The structure of an Equipment instance can be compound so that an instance of Equipment can contain one or more instances of Equipment (containment is represented by linking two instances of Equipment using the EquipmentHasEquipment association).","xml":{"name":"equipment","prefix":"ns13"},"properties":{"description":{"type":"string","description":"description","xml":{"name":"description","prefix":"ns12"}},"name":{"type":"string","description":"name","xml":{"name":"name","prefix":"ns12"}},"owningEntityId":{"type":"string","description":"owningEntityId"},"entityTag":{"type":"string","description":"Generic tag"},"debugMode":{"type":"boolean","description":"Debug mode"},"instanceId":{"type":"integer","description":"instanceId","xml":{"name":"instanceId","prefix":"ns13"},"format":"int64"},"businessKey":{"type":"string","description":"businessKey"},"administrativeStateCode":{"type":"string","description":"administrativeStateCode","xml":{"name":"administrative-state-code","prefix":"ns13"},"deprecated":true},"assemblyNumber":{"type":"string","description":"Assembly number","xml":{"name":"assembly-number","prefix":"ns13"}},"assemblyRevision":{"type":"string","description":"Assembly revision","xml":{"name":"assembly-revision","prefix":"ns13"}},"cleiCode":{"type":"string","description":"This object represents the CLEI (Common Language Equipment Identifier) code for the physical entity. If the physical entity is not present in the system, or does not have an associated CLEI code, the value of this object will be null","xml":{"name":"clei-code","prefix":"ns13"}},"configuredIMType":{"type":"string","description":"configuredIMType"},"deviationNumber":{"type":"string","description":"Deviation number","xml":{"name":"deviation-number","prefix":"ns13"}},"entPhysicalContainedIn":{"type":"string","description":"entPhysicalContainedIn"},"entPhysicalIndex":{"type":"string","description":"entPhysicalIndex"},"equipmentType":{"type":"string","description":"Equipment type","xml":{"name":"equipment-type","prefix":"ns13"},"enum":["OTHER","UNKNOWN","CHASSIS","BACKPLANE","POWERSUPPLY","FAN","MODULE","RACK","PROCESSOR","DISK","MEMORY_MODULE","COMPUTE_BLADE","CHASSIS_EXTENDER","MOTHERBOARD","IP_PHONE","WIRELESS_AP","PLUGGABLE_TRANSCEIVER"]},"formFactor":{"type":"string","description":"formFactor","xml":{"name":"form-factor","prefix":"ns13"}},"freeSlotNames":{"type":"string","description":"freeSlotNames","xml":{"name":"free-slot-names","prefix":"ns13"}},"genericAdminState":{"type":"string","description":"Generic admin state","xml":{"name":"generic-admin-state","prefix":"ns13"},"enum":["IS","IS_AINS","OOS_MT","OOS_DSBLD"]},"genericServiceState":{"type":"object","description":"GenericServiceState","properties":{"combinedState":{"type":"string","description":"combinedState","xml":{"name":"combined-state","prefix":"ns13"}},"primaryState":{"type":"string","description":"primaryState","xml":{"name":"primary-state","prefix":"ns13"},"enum":["N_A","IS","OOS"]},"primaryStateQualifier":{"type":"string","description":"primaryStateQualifier","xml":{"name":"primary-state-qualifier","prefix":"ns13"},"enum":["NR","ANR","RST","ANRST","AU","MA","AUMA","AURST","MAANR"]},"secondaryStates":{"uniqueItems":true,"type":"array","description":"secondaryStates","xml":{"name":"secondary-states","prefix":"ns13"},"items":{"type":"string","enum":["ACT","AINS","BLKD","BUSY","CEMA","COMB","DCHL","DSBLD","EX","FAF","FEPO","FLT","IDLE","IDLERCV","IDLETRMT","INHIP","L1ACT","L1DEACT","LKDO","LPBK","MEA","MON","MT","MTCELIMD","NALM","NALMNR","NALMCD","NALMTI","NBK","OVFL","PMI","PPS","PRI","PRTCL","PSE","PSI","PWR","RAR","RDLD","SB","SDEA","SDEE","SGEO","SGES","SO","ST","STBYC","STBYH","STBYI","STBYS","SWDL","SWTCH","SWTI","SWTO","SWUL","TRD","TRMB","TRMF","TRMT","TS","TSTF","UAS","UEQ","WRK"]}}},"$$ref":"#/components/schemas/GenericServiceState"},"hardwareVersion":{"type":"string","description":"hardwareVersion","xml":{"name":"hardware-version","prefix":"ns13"}},"isFRUable":{"type":"string","description":"isFRUable","xml":{"name":"is-field-replaceable-unit","prefix":"ns13"},"enum":["UNKNOWN","TRUE","FALSE","NOT_APPLICABLE"]},"isInMaintenance":{"type":"boolean","description":"isInMaintenance"},"isPhysicallyPresent":{"type":"boolean","description":"isPhysicallyPresent","xml":{"name":"is-physically-present","prefix":"ns13"}},"isReportingAlarmsAllowed":{"type":"string","description":"isReportingAlarmsAllowed","xml":{"name":"is-reporting-alarms-allowed","prefix":"ns13"},"enum":["UNKNOWN","TRUE","FALSE","NOT_APPLICABLE"]},"manufacturedDate":{"type":"string","description":"manufacturedDate","xml":{"name":"manufactured-date","prefix":"ns13"},"format":"date-time"},"manufacturer":{"type":"string","description":"manufacturer","xml":{"name":"manufacturer","prefix":"ns13"}},"mtosiLabel":{"type":"string","description":"mtosiLabel"},"operationalStateCode":{"type":"string","description":"operationalStateCode","xml":{"name":"operational-state-code","prefix":"ns13"},"deprecated":true},"partNumber":{"type":"string","description":"partNumber","xml":{"name":"part-number","prefix":"ns13"}},"position":{"uniqueItems":true,"type":"array","description":"position","xml":{"name":"position","prefix":"ns13"},"deprecated":true,"items":{"type":"string"}},"productFamily":{"type":"string","description":"productFamily","xml":{"name":"product-family","prefix":"ns13"}},"productId":{"type":"string","description":"productId","xml":{"name":"product-id","prefix":"ns13"}},"productName":{"type":"string","description":"productName","xml":{"name":"product-name","prefix":"ns13"}},"restconfFdn":{"type":"string","description":"restconfFdn"},"serialNumber":{"type":"string","description":"serialNumber","xml":{"name":"serial-number","prefix":"ns13"}},"serviceState":{"type":"string","description":"serviceState","xml":{"name":"service-state","prefix":"ns13"},"enum":["STANDBY","UNKNOWN","INSERVICE","OUTOFSERVICE","OUTOFSERVICE_FORMAINTENANCE","NOT_APPLICABLE","SOFTWARE_DOWNLOAD","NOT_INSTALLED","MISMATCH_OF_EQUIPMENT_ALARM"]},"subclassName":{"type":"string","description":"subclassName","xml":{"name":"subclass-name","prefix":"ns13"}},"udi":{"type":"string","description":"udi","xml":{"name":"udi","prefix":"ns13"}},"vendorEquipmentType":{"type":"string","description":"vendorEquipmentType","xml":{"name":"vendor-equipment-type","prefix":"ns13"}},"fdn":{"type":"string","description":"fdn","xml":{"name":"fdn","prefix":"ns13"}},"connectors":{"uniqueItems":true,"type":"array","description":"uniqueItems","xml":{"name":"unique-items","prefix":"ns13"},"items":{"type":"object","description":"PhysicalConnector","xml":{"name":"physical-connector","prefix":"ns13"},"properties":{"description":{"type":"string","description":"description","xml":{"name":"description","prefix":"ns12"}},"name":{"type":"string","description":"name","xml":{"name":"name","prefix":"ns12"}},"owningEntityId":{"type":"string","description":"owningEntityId"},"entityTag":{"type":"string","description":"Generic tag"},"debugMode":{"type":"boolean","description":"Debug mode"},"instanceId":{"type":"integer","description":"Instance id","xml":{"name":"instanceId","prefix":"ns13"},"format":"int64"},"businessKey":{"type":"string","description":"Business key"},"aliasName":{"type":"string","description":"Alias name"},"connectorType":{"type":"string","description":"Connector type"},"entAliasLogicalIndexOrZero":{"type":"string","description":"entAliasLogicalIndexOrZero"},"entPhysicalContainedIn":{"type":"string","description":"entPhysicalContainedIn"},"entPhysicalIndex":{"type":"string","description":"entPhysicalIndex"},"restconfFdn":{"type":"string","description":"restconfFdn"},"vendorEquipmentType":{"type":"string","description":"vendorEquipmentType"},"fdn":{"type":"string","description":"fdn","xml":{"name":"fdn","prefix":"ns13"}},"equipment":{"type":"string","description":"equipment"}},"$$ref":"#/components/schemas/PhysicalConnector"}},"containingEquipment":{"type":"string","description":"containingEquipment","xml":{"name":"containing-equipment","prefix":"ns13"}},"containedEquipmentString":{"type":"array","description":"containedEquipmentString","xml":{"name":"contained-equipment-string","prefix":"ns13"},"items":{"type":"string"}},"processedDescription":{"type":"object","description":"processedDescription","xml":{"name":"processed-description","prefix":"ns13"},"additionalProperties":{"type":"string","description":"additionalProperties","xml":{"name":"additional-properties","prefix":"ns13"}}}},"$$ref":"#/components/schemas/Equipment"}},"containingEquipment":{"type":"string","description":"containingEquipment","xml":{"name":"containing-equipment","prefix":"ns13"}},"isRackMountable":{"type":"boolean","description":"isRackMountable","xml":{"name":"is-rack-mountable","prefix":"ns13"}},"nrFreeSlots":{"type":"integer","description":"nrFreeSlots","xml":{"name":"nr-free-slots","prefix":"ns13"},"format":"int32"},"nrSlots":{"type":"integer","description":"nrSlots","xml":{"name":"nr-slots","prefix":"ns13"},"format":"int32"},"slotConfig":{"type":"string","description":"slotConfig","xml":{"name":"slot-config","prefix":"ns13"},"deprecated":true},"containedEquipmentString":{"type":"array","description":"containedEquipmentString","xml":{"name":"contained-equipment-string","prefix":"ns13"},"items":{"type":"string"}},"processedDescription":{"type":"object","description":"processedDescription","xml":{"name":"processed-description","prefix":"ns13"},"additionalProperties":{"type":"string","description":"additionalProperties","xml":{"name":"additional-properties","prefix":"ns13"}}}},"$$ref":"#/components/schemas/Chassis"}}},"$$ref":"#/components/schemas/DataEq"}},"$$ref":"#/components/schemas/ResponseMessageEq"},"examples":{"example":{"summary":"Sample response","value":{"com.response-message":{"com.header":{"com.firstIndex":0,"com.lastIndex":2},"com.data":{"eq.module":[{"fdtn.description":"SFP+ 10GBASE-SR","fdtn.name":"subslot 0/5 transceiver 0","eq.containing-equipment":"MD=CISCO_EMS!ND=ASR903-47.cisco-lab!EQ=name=subslot 0/5 transceiver container 0;partnumber=N/A","eq.ent-physical-index":2404,"eq.equipment-type":"MODULE","eq.fdn":"MD=CISCO_EMS!ND=ASR903-47.cisco-lab!EQ=name=subslot 0/5 transceiver 0;partnumber=N/A","eq.hardware-version":"V03","eq.instanceId":440442,"eq.is-field-replaceable-unit":"TRUE","eq.is-physically-present":true,"eq.is-reporting-alarms-allowed":"UNKNOWN","eq.manufactured-date":"2019-01-05T22:00:20Z","eq.manufacturer":"CISCO-AVAGO ","eq.operational-state-code":"Up","eq.product-id":"SFP-10G-SR ","eq.serial-number":"AVD230194V3 ","eq.service-state":"UNKNOWN","eq.vendor-equipment-type":"cevSFP10GSR"}],"eq.equipment":[{"fdtn.description":"subslot 0/5 transceiver container 0","fdtn.name":"subslot 0/5 transceiver container 0","eq.contained-equipment":["MD=CISCO_EMS!ND=ASR903-47.cisco-lab!EQ=name=subslot 0/5 transceiver 0;partnumber=N/A"],"eq.containing-equipment":"MD=CISCO_EMS!ND=ASR903-47.cisco-lab!EQ=name=IM subslot 0/5;partnumber=68-5551-02","eq.ent-physical-index":2403,"eq.equipment-type":"OTHER","eq.fdn":"MD=CISCO_EMS!ND=ASR903-47.cisco-lab!EQ=name=subslot 0/5 transceiver container 0;partnumber=N/A","eq.instanceId":440441,"eq.is-field-replaceable-unit":"FALSE","eq.is-physically-present":true,"eq.is-reporting-alarms-allowed":"UNKNOWN","eq.operational-state-code":"Up","eq.product-id":"N/A","eq.service-state":"UNKNOWN","eq.vendor-equipment-type":"cevContainerSFP"}],"eq.chassis":[{"fdtn.description":"ASR 903 Series Router Chassis","fdtn.name":"Chassis","eq.assembly-number":"68-3992-01","eq.assembly-revision":"G0","eq.clei-code":"URN:CLEI:IPMJ710BRA","eq.contained-equipment":["MD=CISCO_EMS!ND=ASR903-47.cisco-lab!EQ=name=subslot 0/0;partnumber=N/A"],"eq.ent-physical-index":1,"eq.equipment-type":"CHASSIS","eq.fdn":"MD=CISCO_EMS!ND=ASR903-47.cisco-lab!EQ=name=Chassis;partnumber=68-3992-01","eq.hardware-version":"V01","eq.instanceId":440471,"eq.is-field-replaceable-unit":"TRUE","eq.is-physically-present":true,"eq.is-reporting-alarms-allowed":"UNKNOWN","eq.manufactured-date":"2015-01-24T22:00:20Z","eq.manufacturer":"Cisco Systems Inc","eq.operational-state-code":"Up","eq.part-number":"68-3992-01","eq.product-id":"ASR-903","eq.serial-number":"FOX1904PC8W","eq.service-state":"UNKNOWN","eq.vendor-equipment-type":"cevChassisASR903","eq.number-of-slots":0}]}}},"$$ref":"#/components/examples/GetEquipmentJson"}}},"application/xml":{"schema":{"type":"object","description":"response","xml":{"name":"response-message","namespace":"urn:cisco:params:xml:ns:yang:nrf-common:v1","prefix":"ns14"},"properties":{"header":{"type":"object","description":"header","properties":{"firstIndex":{"type":"integer","format":"int64","description":"firstIndex","xml":{"prefix":"ns14"}},"lastIndex":{"type":"integer","format":"int64","description":"lastIndex","xml":{"prefix":"ns14"}}},"xml":{"prefix":"ns14"},"$$ref":"#/components/schemas/Header"},"data":{"type":"object","description":"data","xml":{"prefix":"ns14"},"properties":{"equipment":{"type":"array","description":"equipment","items":{"type":"object","description":"Represents a piece of hardware that has some well-specified function (for example, a line card, memory board, or power supply). The structure of an Equipment instance can be compound so that an instance of Equipment can contain one or more instances of Equipment (containment is represented by linking two instances of Equipment using the EquipmentHasEquipment association).","xml":{"name":"equipment","prefix":"ns13"},"properties":{"description":{"type":"string","description":"description","xml":{"name":"description","prefix":"ns12"}},"name":{"type":"string","description":"name","xml":{"name":"name","prefix":"ns12"}},"owningEntityId":{"type":"string","description":"owningEntityId"},"entityTag":{"type":"string","description":"Generic tag"},"debugMode":{"type":"boolean","description":"Debug mode"},"instanceId":{"type":"integer","description":"instanceId","xml":{"name":"instanceId","prefix":"ns13"},"format":"int64"},"businessKey":{"type":"string","description":"businessKey"},"administrativeStateCode":{"type":"string","description":"administrativeStateCode","xml":{"name":"administrative-state-code","prefix":"ns13"},"deprecated":true},"assemblyNumber":{"type":"string","description":"Assembly number","xml":{"name":"assembly-number","prefix":"ns13"}},"assemblyRevision":{"type":"string","description":"Assembly revision","xml":{"name":"assembly-revision","prefix":"ns13"}},"cleiCode":{"type":"string","description":"This object represents the CLEI (Common Language Equipment Identifier) code for the physical entity. If the physical entity is not present in the system, or does not have an associated CLEI code, the value of this object will be null","xml":{"name":"clei-code","prefix":"ns13"}},"configuredIMType":{"type":"string","description":"configuredIMType"},"deviationNumber":{"type":"string","description":"Deviation number","xml":{"name":"deviation-number","prefix":"ns13"}},"entPhysicalContainedIn":{"type":"string","description":"entPhysicalContainedIn"},"entPhysicalIndex":{"type":"string","description":"entPhysicalIndex"},"equipmentType":{"type":"string","description":"Equipment type","xml":{"name":"equipment-type","prefix":"ns13"},"enum":["OTHER","UNKNOWN","CHASSIS","BACKPLANE","POWERSUPPLY","FAN","MODULE","RACK","PROCESSOR","DISK","MEMORY_MODULE","COMPUTE_BLADE","CHASSIS_EXTENDER","MOTHERBOARD","IP_PHONE","WIRELESS_AP","PLUGGABLE_TRANSCEIVER"]},"formFactor":{"type":"string","description":"formFactor","xml":{"name":"form-factor","prefix":"ns13"}},"freeSlotNames":{"type":"string","description":"freeSlotNames","xml":{"name":"free-slot-names","prefix":"ns13"}},"genericAdminState":{"type":"string","description":"Generic admin state","xml":{"name":"generic-admin-state","prefix":"ns13"},"enum":["IS","IS_AINS","OOS_MT","OOS_DSBLD"]},"genericServiceState":{"type":"object","description":"GenericServiceState","properties":{"combinedState":{"type":"string","description":"combinedState","xml":{"name":"combined-state","prefix":"ns13"}},"primaryState":{"type":"string","description":"primaryState","xml":{"name":"primary-state","prefix":"ns13"},"enum":["N_A","IS","OOS"]},"primaryStateQualifier":{"type":"string","description":"primaryStateQualifier","xml":{"name":"primary-state-qualifier","prefix":"ns13"},"enum":["NR","ANR","RST","ANRST","AU","MA","AUMA","AURST","MAANR"]},"secondaryStates":{"uniqueItems":true,"type":"array","description":"secondaryStates","xml":{"name":"secondary-states","prefix":"ns13"},"items":{"type":"string","enum":["ACT","AINS","BLKD","BUSY","CEMA","COMB","DCHL","DSBLD","EX","FAF","FEPO","FLT","IDLE","IDLERCV","IDLETRMT","INHIP","L1ACT","L1DEACT","LKDO","LPBK","MEA","MON","MT","MTCELIMD","NALM","NALMNR","NALMCD","NALMTI","NBK","OVFL","PMI","PPS","PRI","PRTCL","PSE","PSI","PWR","RAR","RDLD","SB","SDEA","SDEE","SGEO","SGES","SO","ST","STBYC","STBYH","STBYI","STBYS","SWDL","SWTCH","SWTI","SWTO","SWUL","TRD","TRMB","TRMF","TRMT","TS","TSTF","UAS","UEQ","WRK"]}}},"$$ref":"#/components/schemas/GenericServiceState"},"hardwareVersion":{"type":"string","description":"hardwareVersion","xml":{"name":"hardware-version","prefix":"ns13"}},"isFRUable":{"type":"string","description":"isFRUable","xml":{"name":"is-field-replaceable-unit","prefix":"ns13"},"enum":["UNKNOWN","TRUE","FALSE","NOT_APPLICABLE"]},"isInMaintenance":{"type":"boolean","description":"isInMaintenance"},"isPhysicallyPresent":{"type":"boolean","description":"isPhysicallyPresent","xml":{"name":"is-physically-present","prefix":"ns13"}},"isReportingAlarmsAllowed":{"type":"string","description":"isReportingAlarmsAllowed","xml":{"name":"is-reporting-alarms-allowed","prefix":"ns13"},"enum":["UNKNOWN","TRUE","FALSE","NOT_APPLICABLE"]},"manufacturedDate":{"type":"string","description":"manufacturedDate","xml":{"name":"manufactured-date","prefix":"ns13"},"format":"date-time"},"manufacturer":{"type":"string","description":"manufacturer","xml":{"name":"manufacturer","prefix":"ns13"}},"mtosiLabel":{"type":"string","description":"mtosiLabel"},"operationalStateCode":{"type":"string","description":"operationalStateCode","xml":{"name":"operational-state-code","prefix":"ns13"},"deprecated":true},"partNumber":{"type":"string","description":"partNumber","xml":{"name":"part-number","prefix":"ns13"}},"position":{"uniqueItems":true,"type":"array","description":"position","xml":{"name":"position","prefix":"ns13"},"deprecated":true,"items":{"type":"string"}},"productFamily":{"type":"string","description":"productFamily","xml":{"name":"product-family","prefix":"ns13"}},"productId":{"type":"string","description":"productId","xml":{"name":"product-id","prefix":"ns13"}},"productName":{"type":"string","description":"productName","xml":{"name":"product-name","prefix":"ns13"}},"restconfFdn":{"type":"string","description":"restconfFdn"},"serialNumber":{"type":"string","description":"serialNumber","xml":{"name":"serial-number","prefix":"ns13"}},"serviceState":{"type":"string","description":"serviceState","xml":{"name":"service-state","prefix":"ns13"},"enum":["STANDBY","UNKNOWN","INSERVICE","OUTOFSERVICE","OUTOFSERVICE_FORMAINTENANCE","NOT_APPLICABLE","SOFTWARE_DOWNLOAD","NOT_INSTALLED","MISMATCH_OF_EQUIPMENT_ALARM"]},"subclassName":{"type":"string","description":"subclassName","xml":{"name":"subclass-name","prefix":"ns13"}},"udi":{"type":"string","description":"udi","xml":{"name":"udi","prefix":"ns13"}},"vendorEquipmentType":{"type":"string","description":"vendorEquipmentType","xml":{"name":"vendor-equipment-type","prefix":"ns13"}},"fdn":{"type":"string","description":"fdn","xml":{"name":"fdn","prefix":"ns13"}},"connectors":{"uniqueItems":true,"type":"array","description":"uniqueItems","xml":{"name":"unique-items","prefix":"ns13"},"items":{"type":"object","description":"PhysicalConnector","xml":{"name":"physical-connector","prefix":"ns13"},"properties":{"description":{"type":"string","description":"description","xml":{"name":"description","prefix":"ns12"}},"name":{"type":"string","description":"name","xml":{"name":"name","prefix":"ns12"}},"owningEntityId":{"type":"string","description":"owningEntityId"},"entityTag":{"type":"string","description":"Generic tag"},"debugMode":{"type":"boolean","description":"Debug mode"},"instanceId":{"type":"integer","description":"Instance id","xml":{"name":"instanceId","prefix":"ns13"},"format":"int64"},"businessKey":{"type":"string","description":"Business key"},"aliasName":{"type":"string","description":"Alias name"},"connectorType":{"type":"string","description":"Connector type"},"entAliasLogicalIndexOrZero":{"type":"string","description":"entAliasLogicalIndexOrZero"},"entPhysicalContainedIn":{"type":"string","description":"entPhysicalContainedIn"},"entPhysicalIndex":{"type":"string","description":"entPhysicalIndex"},"restconfFdn":{"type":"string","description":"restconfFdn"},"vendorEquipmentType":{"type":"string","description":"vendorEquipmentType"},"fdn":{"type":"string","description":"fdn","xml":{"name":"fdn","prefix":"ns13"}},"equipment":{"type":"string","description":"equipment"}},"$$ref":"#/components/schemas/PhysicalConnector"}},"containingEquipment":{"type":"string","description":"containingEquipment","xml":{"name":"containing-equipment","prefix":"ns13"}},"containedEquipmentString":{"type":"array","description":"containedEquipmentString","xml":{"name":"contained-equipment-string","prefix":"ns13"},"items":{"type":"string"}},"processedDescription":{"type":"object","description":"processedDescription","xml":{"name":"processed-description","prefix":"ns13"},"additionalProperties":{"type":"string","description":"additionalProperties","xml":{"name":"additional-properties","prefix":"ns13"}}}},"$$ref":"#/components/schemas/Equipment"}},"module":{"type":"array","description":"termination point","items":{"type":"object","description":"Module","xml":{"name":"module","prefix":"ns13"},"properties":{"description":{"type":"string","description":"description","xml":{"name":"description","prefix":"ns13"}},"name":{"type":"string","description":"name","xml":{"name":"name","prefix":"ns13"}},"owningEntityId":{"type":"string","description":"owningEntityId"},"entityTag":{"type":"string","description":"Generic tag"},"debugMode":{"type":"boolean","description":"debugMode"},"instanceId":{"type":"integer","description":"instanceId","xml":{"name":"instanceId","prefix":"ns13"},"format":"int64"},"businessKey":{"type":"string","description":"businessKey"},"administrativeStateCode":{"type":"string","description":"administrativeStateCode","xml":{"name":"administrative-state-code","prefix":"ns13"},"deprecated":true},"assemblyNumber":{"type":"string","description":"assemblyNumber","xml":{"name":"assembly-number","prefix":"ns13"}},"assemblyRevision":{"type":"string","description":"assemblyRevision","xml":{"name":"assembly-revision","prefix":"ns13"}},"cleiCode":{"type":"string","description":"cleiCode","xml":{"name":"clei-code","prefix":"ns13"}},"configuredIMType":{"type":"string","description":"configuredIMType","xml":{"name":"configured-IM-type","prefix":"ns13"}},"deviationNumber":{"type":"string","description":"deviationumber","xml":{"name":"deviation-number","prefix":"ns13"}},"entPhysicalContainedIn":{"type":"string","description":"entPhysicalContainedIn","xml":{"name":"ent-physical-contained-in","prefix":"ns13"}},"entPhysicalIndex":{"type":"string","description":"entPhysicalIndex","xml":{"name":"ent-pysical-index","prefix":"ns13"}},"equipmentType":{"type":"string","description":"equipmentType","xml":{"name":"equipment-type","prefix":"ns13"},"enum":["OTHER","UNKNOWN","CHASSIS","BACKPLANE","POWERSUPPLY","FAN","MODULE","RACK","PROCESSOR","DISK","MEMORY_MODULE","COMPUTE_BLADE","CHASSIS_EXTENDER","MOTHERBOARD","IP_PHONE","WIRELESS_AP","PLUGGABLE_TRANSCEIVER"]},"formFactor":{"type":"string","description":"formFactor","xml":{"name":"form-factor","prefix":"ns13"}},"freeSlotNames":{"type":"string","description":"freeSlotNames","xml":{"name":"free-slot-names","prefix":"ns13"}},"genericAdminState":{"type":"string","description":"Generic admin state","xml":{"name":"generic-admin-state","prefix":"ns13"},"enum":["IS","IS_AINS","OOS_MT","OOS_DSBLD"]},"genericServiceState":{"type":"object","description":"GenericServiceState","properties":{"combinedState":{"type":"string","description":"combinedState","xml":{"name":"combined-state","prefix":"ns13"}},"primaryState":{"type":"string","description":"primaryState","xml":{"name":"primary-state","prefix":"ns13"},"enum":["N_A","IS","OOS"]},"primaryStateQualifier":{"type":"string","description":"primaryStateQualifier","xml":{"name":"primary-state-qualifier","prefix":"ns13"},"enum":["NR","ANR","RST","ANRST","AU","MA","AUMA","AURST","MAANR"]},"secondaryStates":{"uniqueItems":true,"type":"array","description":"secondaryStates","xml":{"name":"secondary-states","prefix":"ns13"},"items":{"type":"string","enum":["ACT","AINS","BLKD","BUSY","CEMA","COMB","DCHL","DSBLD","EX","FAF","FEPO","FLT","IDLE","IDLERCV","IDLETRMT","INHIP","L1ACT","L1DEACT","LKDO","LPBK","MEA","MON","MT","MTCELIMD","NALM","NALMNR","NALMCD","NALMTI","NBK","OVFL","PMI","PPS","PRI","PRTCL","PSE","PSI","PWR","RAR","RDLD","SB","SDEA","SDEE","SGEO","SGES","SO","ST","STBYC","STBYH","STBYI","STBYS","SWDL","SWTCH","SWTI","SWTO","SWUL","TRD","TRMB","TRMF","TRMT","TS","TSTF","UAS","UEQ","WRK"]}}},"$$ref":"#/components/schemas/GenericServiceState"},"hardwareVersion":{"type":"string","description":"hardwareVersion","xml":{"name":"hardware-version","prefix":"ns13"}},"isFRUable":{"type":"string","description":"isFRUable","xml":{"name":"is-field-replaceable-unit","prefix":"ns13"},"enum":["UNKNOWN","TRUE","FALSE","NOT_APPLICABLE"]},"isInMaintenance":{"type":"boolean","description":"isInMaintenance"},"isPhysicallyPresent":{"type":"boolean","description":"is physically present","xml":{"name":"is-physically-present","prefix":"ns13"}},"isReportingAlarmsAllowed":{"type":"string","description":"isReportingAlarmsAllowed","xml":{"name":"is-reporting-alarms-allowed","prefix":"ns13"},"enum":["UNKNOWN","TRUE","FALSE","NOT_APPLICABLE"]},"manufacturedDate":{"type":"string","description":"manufacturedDate","xml":{"name":"manufactured-date","prefix":"ns13"},"format":"date-time"},"manufacturer":{"type":"string","description":"manufacturer","xml":{"name":"manufacturer","prefix":"ns13"}},"mtosiLabel":{"type":"string","description":"mtosiLabel"},"operationalStateCode":{"type":"string","description":"operationalStateCode","xml":{"name":"operational-state-code","prefix":"ns13"},"deprecated":true},"partNumber":{"type":"string","description":"partNumber","xml":{"name":"part-number","prefix":"ns13"}},"position":{"uniqueItems":true,"type":"array","description":"position","xml":{"name":"position","prefix":"ns13"},"deprecated":true,"items":{"type":"string"}},"productFamily":{"type":"string","description":"productFamily","xml":{"name":"product-family","prefix":"ns13"}},"productId":{"type":"string","description":"productId","xml":{"name":"product-id","prefix":"ns13"}},"productName":{"type":"string","description":"productName","xml":{"name":"product-name","prefix":"ns13"}},"restconfFdn":{"type":"string","description":"restconfFdn"},"serialNumber":{"type":"string","description":"serialNumber","xml":{"name":"serial-number","prefix":"ns13"}},"serviceState":{"type":"string","description":"serviceState","xml":{"name":"service-state","prefix":"ns13"},"enum":["STANDBY","UNKNOWN","INSERVICE","OUTOFSERVICE","OUTOFSERVICE_FORMAINTENANCE","NOT_APPLICABLE","SOFTWARE_DOWNLOAD","NOT_INSTALLED","MISMATCH_OF_EQUIPMENT_ALARM"]},"subclassName":{"type":"string","description":"subclassName","xml":{"name":"subclass-name","prefix":"ns13"}},"udi":{"type":"string","description":"udi","xml":{"name":"udi","prefix":"ns13"}},"vendorEquipmentType":{"type":"string","description":"vendorEquipmentType","xml":{"name":"vendor-equipment-type","prefix":"ns13"}},"fdn":{"type":"string","description":"fdn","xml":{"name":"fdn","prefix":"ns13"}},"connectors":{"uniqueItems":true,"type":"array","description":"connectors","items":{"type":"object","description":"PhysicalConnector","xml":{"name":"physical-connector","prefix":"ns13"},"properties":{"description":{"type":"string","description":"description","xml":{"name":"description","prefix":"ns12"}},"name":{"type":"string","description":"name","xml":{"name":"name","prefix":"ns12"}},"owningEntityId":{"type":"string","description":"owningEntityId"},"entityTag":{"type":"string","description":"Generic tag"},"debugMode":{"type":"boolean","description":"Debug mode"},"instanceId":{"type":"integer","description":"Instance id","xml":{"name":"instanceId","prefix":"ns13"},"format":"int64"},"businessKey":{"type":"string","description":"Business key"},"aliasName":{"type":"string","description":"Alias name"},"connectorType":{"type":"string","description":"Connector type"},"entAliasLogicalIndexOrZero":{"type":"string","description":"entAliasLogicalIndexOrZero"},"entPhysicalContainedIn":{"type":"string","description":"entPhysicalContainedIn"},"entPhysicalIndex":{"type":"string","description":"entPhysicalIndex"},"restconfFdn":{"type":"string","description":"restconfFdn"},"vendorEquipmentType":{"type":"string","description":"vendorEquipmentType"},"fdn":{"type":"string","description":"fdn","xml":{"name":"fdn","prefix":"ns13"}},"equipment":{"type":"string","description":"equipment"}},"$$ref":"#/components/schemas/PhysicalConnector"}},"containedEquipment":{"uniqueItems":true,"type":"array","description":"containedEquipment","xml":{"name":"contained-equipment","prefix":"ns13"},"items":{"type":"object","description":"Represents a piece of hardware that has some well-specified function (for example, a line card, memory board, or power supply). The structure of an Equipment instance can be compound so that an instance of Equipment can contain one or more instances of Equipment (containment is represented by linking two instances of Equipment using the EquipmentHasEquipment association).","xml":{"name":"equipment","prefix":"ns13"},"properties":{"description":{"type":"string","description":"description","xml":{"name":"description","prefix":"ns12"}},"name":{"type":"string","description":"name","xml":{"name":"name","prefix":"ns12"}},"owningEntityId":{"type":"string","description":"owningEntityId"},"entityTag":{"type":"string","description":"Generic tag"},"debugMode":{"type":"boolean","description":"Debug mode"},"instanceId":{"type":"integer","description":"instanceId","xml":{"name":"instanceId","prefix":"ns13"},"format":"int64"},"businessKey":{"type":"string","description":"businessKey"},"administrativeStateCode":{"type":"string","description":"administrativeStateCode","xml":{"name":"administrative-state-code","prefix":"ns13"},"deprecated":true},"assemblyNumber":{"type":"string","description":"Assembly number","xml":{"name":"assembly-number","prefix":"ns13"}},"assemblyRevision":{"type":"string","description":"Assembly revision","xml":{"name":"assembly-revision","prefix":"ns13"}},"cleiCode":{"type":"string","description":"This object represents the CLEI (Common Language Equipment Identifier) code for the physical entity. If the physical entity is not present in the system, or does not have an associated CLEI code, the value of this object will be null","xml":{"name":"clei-code","prefix":"ns13"}},"configuredIMType":{"type":"string","description":"configuredIMType"},"deviationNumber":{"type":"string","description":"Deviation number","xml":{"name":"deviation-number","prefix":"ns13"}},"entPhysicalContainedIn":{"type":"string","description":"entPhysicalContainedIn"},"entPhysicalIndex":{"type":"string","description":"entPhysicalIndex"},"equipmentType":{"type":"string","description":"Equipment type","xml":{"name":"equipment-type","prefix":"ns13"},"enum":["OTHER","UNKNOWN","CHASSIS","BACKPLANE","POWERSUPPLY","FAN","MODULE","RACK","PROCESSOR","DISK","MEMORY_MODULE","COMPUTE_BLADE","CHASSIS_EXTENDER","MOTHERBOARD","IP_PHONE","WIRELESS_AP","PLUGGABLE_TRANSCEIVER"]},"formFactor":{"type":"string","description":"formFactor","xml":{"name":"form-factor","prefix":"ns13"}},"freeSlotNames":{"type":"string","description":"freeSlotNames","xml":{"name":"free-slot-names","prefix":"ns13"}},"genericAdminState":{"type":"string","description":"Generic admin state","xml":{"name":"generic-admin-state","prefix":"ns13"},"enum":["IS","IS_AINS","OOS_MT","OOS_DSBLD"]},"genericServiceState":{"type":"object","description":"GenericServiceState","properties":{"combinedState":{"type":"string","description":"combinedState","xml":{"name":"combined-state","prefix":"ns13"}},"primaryState":{"type":"string","description":"primaryState","xml":{"name":"primary-state","prefix":"ns13"},"enum":["N_A","IS","OOS"]},"primaryStateQualifier":{"type":"string","description":"primaryStateQualifier","xml":{"name":"primary-state-qualifier","prefix":"ns13"},"enum":["NR","ANR","RST","ANRST","AU","MA","AUMA","AURST","MAANR"]},"secondaryStates":{"uniqueItems":true,"type":"array","description":"secondaryStates","xml":{"name":"secondary-states","prefix":"ns13"},"items":{"type":"string","enum":["ACT","AINS","BLKD","BUSY","CEMA","COMB","DCHL","DSBLD","EX","FAF","FEPO","FLT","IDLE","IDLERCV","IDLETRMT","INHIP","L1ACT","L1DEACT","LKDO","LPBK","MEA","MON","MT","MTCELIMD","NALM","NALMNR","NALMCD","NALMTI","NBK","OVFL","PMI","PPS","PRI","PRTCL","PSE","PSI","PWR","RAR","RDLD","SB","SDEA","SDEE","SGEO","SGES","SO","ST","STBYC","STBYH","STBYI","STBYS","SWDL","SWTCH","SWTI","SWTO","SWUL","TRD","TRMB","TRMF","TRMT","TS","TSTF","UAS","UEQ","WRK"]}}},"$$ref":"#/components/schemas/GenericServiceState"},"hardwareVersion":{"type":"string","description":"hardwareVersion","xml":{"name":"hardware-version","prefix":"ns13"}},"isFRUable":{"type":"string","description":"isFRUable","xml":{"name":"is-field-replaceable-unit","prefix":"ns13"},"enum":["UNKNOWN","TRUE","FALSE","NOT_APPLICABLE"]},"isInMaintenance":{"type":"boolean","description":"isInMaintenance"},"isPhysicallyPresent":{"type":"boolean","description":"isPhysicallyPresent","xml":{"name":"is-physically-present","prefix":"ns13"}},"isReportingAlarmsAllowed":{"type":"string","description":"isReportingAlarmsAllowed","xml":{"name":"is-reporting-alarms-allowed","prefix":"ns13"},"enum":["UNKNOWN","TRUE","FALSE","NOT_APPLICABLE"]},"manufacturedDate":{"type":"string","description":"manufacturedDate","xml":{"name":"manufactured-date","prefix":"ns13"},"format":"date-time"},"manufacturer":{"type":"string","description":"manufacturer","xml":{"name":"manufacturer","prefix":"ns13"}},"mtosiLabel":{"type":"string","description":"mtosiLabel"},"operationalStateCode":{"type":"string","description":"operationalStateCode","xml":{"name":"operational-state-code","prefix":"ns13"},"deprecated":true},"partNumber":{"type":"string","description":"partNumber","xml":{"name":"part-number","prefix":"ns13"}},"position":{"uniqueItems":true,"type":"array","description":"position","xml":{"name":"position","prefix":"ns13"},"deprecated":true,"items":{"type":"string"}},"productFamily":{"type":"string","description":"productFamily","xml":{"name":"product-family","prefix":"ns13"}},"productId":{"type":"string","description":"productId","xml":{"name":"product-id","prefix":"ns13"}},"productName":{"type":"string","description":"productName","xml":{"name":"product-name","prefix":"ns13"}},"restconfFdn":{"type":"string","description":"restconfFdn"},"serialNumber":{"type":"string","description":"serialNumber","xml":{"name":"serial-number","prefix":"ns13"}},"serviceState":{"type":"string","description":"serviceState","xml":{"name":"service-state","prefix":"ns13"},"enum":["STANDBY","UNKNOWN","INSERVICE","OUTOFSERVICE","OUTOFSERVICE_FORMAINTENANCE","NOT_APPLICABLE","SOFTWARE_DOWNLOAD","NOT_INSTALLED","MISMATCH_OF_EQUIPMENT_ALARM"]},"subclassName":{"type":"string","description":"subclassName","xml":{"name":"subclass-name","prefix":"ns13"}},"udi":{"type":"string","description":"udi","xml":{"name":"udi","prefix":"ns13"}},"vendorEquipmentType":{"type":"string","description":"vendorEquipmentType","xml":{"name":"vendor-equipment-type","prefix":"ns13"}},"fdn":{"type":"string","description":"fdn","xml":{"name":"fdn","prefix":"ns13"}},"connectors":{"uniqueItems":true,"type":"array","description":"uniqueItems","xml":{"name":"unique-items","prefix":"ns13"},"items":{"type":"object","description":"PhysicalConnector","xml":{"name":"physical-connector","prefix":"ns13"},"properties":{"description":{"type":"string","description":"description","xml":{"name":"description","prefix":"ns12"}},"name":{"type":"string","description":"name","xml":{"name":"name","prefix":"ns12"}},"owningEntityId":{"type":"string","description":"owningEntityId"},"entityTag":{"type":"string","description":"Generic tag"},"debugMode":{"type":"boolean","description":"Debug mode"},"instanceId":{"type":"integer","description":"Instance id","xml":{"name":"instanceId","prefix":"ns13"},"format":"int64"},"businessKey":{"type":"string","description":"Business key"},"aliasName":{"type":"string","description":"Alias name"},"connectorType":{"type":"string","description":"Connector type"},"entAliasLogicalIndexOrZero":{"type":"string","description":"entAliasLogicalIndexOrZero"},"entPhysicalContainedIn":{"type":"string","description":"entPhysicalContainedIn"},"entPhysicalIndex":{"type":"string","description":"entPhysicalIndex"},"restconfFdn":{"type":"string","description":"restconfFdn"},"vendorEquipmentType":{"type":"string","description":"vendorEquipmentType"},"fdn":{"type":"string","description":"fdn","xml":{"name":"fdn","prefix":"ns13"}},"equipment":{"type":"string","description":"equipment"}},"$$ref":"#/components/schemas/PhysicalConnector"}},"containingEquipment":{"type":"string","description":"containingEquipment","xml":{"name":"containing-equipment","prefix":"ns13"}},"containedEquipmentString":{"type":"array","description":"containedEquipmentString","xml":{"name":"contained-equipment-string","prefix":"ns13"},"items":{"type":"string"}},"processedDescription":{"type":"object","description":"processedDescription","xml":{"name":"processed-description","prefix":"ns13"},"additionalProperties":{"type":"string","description":"additionalProperties","xml":{"name":"additional-properties","prefix":"ns13"}}}},"$$ref":"#/components/schemas/Equipment"}},"containingEquipment":{"type":"string","description":"containingEquipment","xml":{"name":"containing-equipment","prefix":"ns13"}},"isInlinePowercapable":{"type":"boolean","description":"isInlinePowercapable","xml":{"name":"is-inline-power-capable","prefix":"ns13"}},"moduleIndex":{"type":"integer","description":"moduleIndex","xml":{"name":"module-index","prefix":"ns13"},"format":"int32"},"nrFreeSlots":{"type":"integer","description":"nrFreeSlots","xml":{"name":"nr-free-slots","prefix":"ns13"},"format":"int32"},"nrPorts":{"type":"integer","description":"nrPorts","xml":{"name":"nr-ports","prefix":"ns13"},"format":"int32"},"nrSlots":{"type":"integer","description":"nrSlots","xml":{"name":"nr-slots","prefix":"ns13"},"format":"int32"},"protectionRole":{"type":"string","description":"protectionRole","xml":{"name":"protection-role","prefix":"ns13"},"enum":["NOT_APPLICABLE","ACTIVE","STANDBY"]},"qos10gOnlyMode":{"type":"boolean","description":"qos10gOnlyMode","xml":{"name":"qos-10g-only-mode","prefix":"ns13"}},"resetReason":{"type":"string","description":"resetReason","xml":{"name":"reset-reason","prefix":"ns13"},"enum":["UNKNOWN","POWERUP","PARITYERROR","CLEARCONFIGRESET","MANUALRESET","WATCHDOGTIMEOUTRESET","RESOURCEOVERFLOWRESET","MISSINGTASKRESET","LOWVOLTAGERESET","CONTROLLERRESET","SYSTEMRESET","SWITCHOVERRESET","UPGRADERESET","DOWNGRADERESET","CACHEERRORRESET","DEVICEDRIVERRESET","SOFTWAREEXCEPTIONRESET","RESTORECONFIGRESET","ABORTREVRESET","BURNBOOTRESET","STANDBYCDHEALTHIERRESET","NONNATIVECONFIGCLEARRESET","MEMORYPROTECTIONERRORRESET"]},"resetReasonDescription":{"type":"string","description":"resetReasonDescription","xml":{"name":"reset-reason-description","prefix":"ns13"}},"containedEquipmentString":{"type":"array","description":"containedEquipmentString","xml":{"name":"contained-equipment-string","prefix":"ns13"},"items":{"type":"string"}},"processedDescription":{"type":"object","description":"processedDescription","xml":{"name":"processed-description","prefix":"ns13"},"additionalProperties":{"type":"string","description":"additionalProperties","xml":{"name":"additional-properties","prefix":"ns13"}}}},"$$ref":"#/components/schemas/Module"}},"chassis":{"type":"array","description":"equipment","items":{"type":"object","description":"chassis","xml":{"name":"chassis","prefix":"ns13"},"properties":{"description":{"type":"string","description":"description","xml":{"name":"description","prefix":"ns13"}},"name":{"type":"string","description":"name","xml":{"name":"name","prefix":"ns13"}},"owningEntityId":{"type":"string","description":"owningEntityId"},"entityTag":{"type":"string","description":"Generic tag"},"debugMode":{"type":"boolean","description":"debugMode"},"instanceId":{"type":"integer","description":"instanceId","xml":{"name":"instanceId","prefix":"ns13"},"format":"int64"},"businessKey":{"type":"string","description":"businessKey"},"administrativeStateCode":{"type":"string","description":"administrativeStateCode","xml":{"name":"administrative-state-code","prefix":"ns13"},"deprecated":true},"assemblyNumber":{"type":"string","description":"assemblyNumber","xml":{"name":"assembly-number","prefix":"ns13"}},"assemblyRevision":{"type":"string","description":"assemblyRevision","xml":{"name":"assembly-revision","prefix":"ns13"}},"cleiCode":{"type":"string","description":"cleiCode","xml":{"name":"clei-code","prefix":"ns13"}},"configuredIMType":{"type":"string","description":"configuredIMType","xml":{"name":"configured-IM-type","prefix":"ns13"}},"deviationNumber":{"type":"string","description":"deviationumber","xml":{"name":"deviation-number","prefix":"ns13"}},"entPhysicalContainedIn":{"type":"string","description":"entPhysicalContainedIn","xml":{"name":"ent-physical-contained-in","prefix":"ns13"}},"entPhysicalIndex":{"type":"string","description":"entPhysicalIndex","xml":{"name":"ent-pysical-index","prefix":"ns13"}},"equipmentType":{"type":"string","description":"equipmentType","xml":{"name":"equipment-type","prefix":"ns13"},"enum":["OTHER","UNKNOWN","CHASSIS","BACKPLANE","POWERSUPPLY","FAN","MODULE","RACK","PROCESSOR","DISK","MEMORY_MODULE","COMPUTE_BLADE","CHASSIS_EXTENDER","MOTHERBOARD","IP_PHONE","WIRELESS_AP","PLUGGABLE_TRANSCEIVER"]},"formFactor":{"type":"string","description":"formFactor","xml":{"name":"form-factor","prefix":"ns13"}},"freeSlotNames":{"type":"string","description":"freeSlotNames","xml":{"name":"free-slot-names","prefix":"ns13"}},"genericAdminState":{"type":"string","description":"Generic admin state","xml":{"name":"generic-admin-state","prefix":"ns13"},"enum":["IS","IS_AINS","OOS_MT","OOS_DSBLD"]},"genericServiceState":{"type":"object","description":"GenericServiceState","properties":{"combinedState":{"type":"string","description":"combinedState","xml":{"name":"combined-state","prefix":"ns13"}},"primaryState":{"type":"string","description":"primaryState","xml":{"name":"primary-state","prefix":"ns13"},"enum":["N_A","IS","OOS"]},"primaryStateQualifier":{"type":"string","description":"primaryStateQualifier","xml":{"name":"primary-state-qualifier","prefix":"ns13"},"enum":["NR","ANR","RST","ANRST","AU","MA","AUMA","AURST","MAANR"]},"secondaryStates":{"uniqueItems":true,"type":"array","description":"secondaryStates","xml":{"name":"secondary-states","prefix":"ns13"},"items":{"type":"string","enum":["ACT","AINS","BLKD","BUSY","CEMA","COMB","DCHL","DSBLD","EX","FAF","FEPO","FLT","IDLE","IDLERCV","IDLETRMT","INHIP","L1ACT","L1DEACT","LKDO","LPBK","MEA","MON","MT","MTCELIMD","NALM","NALMNR","NALMCD","NALMTI","NBK","OVFL","PMI","PPS","PRI","PRTCL","PSE","PSI","PWR","RAR","RDLD","SB","SDEA","SDEE","SGEO","SGES","SO","ST","STBYC","STBYH","STBYI","STBYS","SWDL","SWTCH","SWTI","SWTO","SWUL","TRD","TRMB","TRMF","TRMT","TS","TSTF","UAS","UEQ","WRK"]}}},"$$ref":"#/components/schemas/GenericServiceState"},"hardwareVersion":{"type":"string","description":"hardwareVersion","xml":{"name":"hardware-version","prefix":"ns13"}},"isFRUable":{"type":"string","description":"isFRUable","xml":{"name":"is-field-replaceable-unit","prefix":"ns13"},"enum":["UNKNOWN","TRUE","FALSE","NOT_APPLICABLE"]},"isInMaintenance":{"type":"boolean","description":"isInMaintenance"},"isPhysicallyPresent":{"type":"boolean","description":"is physically present","xml":{"name":"is-physically-present","prefix":"ns13"}},"isReportingAlarmsAllowed":{"type":"string","description":"isReportingAlarmsAllowed","xml":{"name":"is-reporting-alarms-allowed","prefix":"ns13"},"enum":["UNKNOWN","TRUE","FALSE","NOT_APPLICABLE"]},"manufacturedDate":{"type":"string","description":"manufacturedDate","xml":{"name":"manufactured-date","prefix":"ns13"},"format":"date-time"},"manufacturer":{"type":"string","description":"manufacturer","xml":{"name":"manufacturer","prefix":"ns13"}},"mtosiLabel":{"type":"string","description":"mtosiLabel"},"operationalStateCode":{"type":"string","description":"operationalStateCode","xml":{"name":"operational-state-code","prefix":"ns13"},"deprecated":true},"partNumber":{"type":"string","description":"partNumber","xml":{"name":"part-number","prefix":"ns13"}},"position":{"uniqueItems":true,"type":"array","description":"position","xml":{"name":"position","prefix":"ns13"},"deprecated":true,"items":{"type":"string"}},"productFamily":{"type":"string","description":"productFamily","xml":{"name":"product-family","prefix":"ns13"}},"productId":{"type":"string","description":"productId","xml":{"name":"product-id","prefix":"ns13"}},"productName":{"type":"string","description":"productName","xml":{"name":"product-name","prefix":"ns13"}},"restconfFdn":{"type":"string","description":"restconfFdn"},"serialNumber":{"type":"string","description":"serialNumber","xml":{"name":"serial-number","prefix":"ns13"}},"serviceState":{"type":"string","description":"serviceState","xml":{"name":"service-state","prefix":"ns13"},"enum":["STANDBY","UNKNOWN","INSERVICE","OUTOFSERVICE","OUTOFSERVICE_FORMAINTENANCE","NOT_APPLICABLE","SOFTWARE_DOWNLOAD","NOT_INSTALLED","MISMATCH_OF_EQUIPMENT_ALARM"]},"subclassName":{"type":"string","description":"subclassName","xml":{"name":"subclass-name","prefix":"ns13"}},"udi":{"type":"string","description":"udi","xml":{"name":"udi","prefix":"ns13"}},"vendorEquipmentType":{"type":"string","description":"vendorEquipmentType","xml":{"name":"vendor-equipment-type","prefix":"ns13"}},"fdn":{"type":"string","description":"fdn","xml":{"name":"fdn","prefix":"ns13"}},"connectors":{"uniqueItems":true,"type":"array","description":"connectors","items":{"type":"object","description":"PhysicalConnector","xml":{"name":"physical-connector","prefix":"ns13"},"properties":{"description":{"type":"string","description":"description","xml":{"name":"description","prefix":"ns12"}},"name":{"type":"string","description":"name","xml":{"name":"name","prefix":"ns12"}},"owningEntityId":{"type":"string","description":"owningEntityId"},"entityTag":{"type":"string","description":"Generic tag"},"debugMode":{"type":"boolean","description":"Debug mode"},"instanceId":{"type":"integer","description":"Instance id","xml":{"name":"instanceId","prefix":"ns13"},"format":"int64"},"businessKey":{"type":"string","description":"Business key"},"aliasName":{"type":"string","description":"Alias name"},"connectorType":{"type":"string","description":"Connector type"},"entAliasLogicalIndexOrZero":{"type":"string","description":"entAliasLogicalIndexOrZero"},"entPhysicalContainedIn":{"type":"string","description":"entPhysicalContainedIn"},"entPhysicalIndex":{"type":"string","description":"entPhysicalIndex"},"restconfFdn":{"type":"string","description":"restconfFdn"},"vendorEquipmentType":{"type":"string","description":"vendorEquipmentType"},"fdn":{"type":"string","description":"fdn","xml":{"name":"fdn","prefix":"ns13"}},"equipment":{"type":"string","description":"equipment"}},"$$ref":"#/components/schemas/PhysicalConnector"}},"contained-equipment":{"uniqueItems":true,"type":"array","description":"containedEquipment","xml":{"name":"contained-equipment","prefix":"ns13"},"items":{"type":"object","description":"Represents a piece of hardware that has some well-specified function (for example, a line card, memory board, or power supply). The structure of an Equipment instance can be compound so that an instance of Equipment can contain one or more instances of Equipment (containment is represented by linking two instances of Equipment using the EquipmentHasEquipment association).","xml":{"name":"equipment","prefix":"ns13"},"properties":{"description":{"type":"string","description":"description","xml":{"name":"description","prefix":"ns12"}},"name":{"type":"string","description":"name","xml":{"name":"name","prefix":"ns12"}},"owningEntityId":{"type":"string","description":"owningEntityId"},"entityTag":{"type":"string","description":"Generic tag"},"debugMode":{"type":"boolean","description":"Debug mode"},"instanceId":{"type":"integer","description":"instanceId","xml":{"name":"instanceId","prefix":"ns13"},"format":"int64"},"businessKey":{"type":"string","description":"businessKey"},"administrativeStateCode":{"type":"string","description":"administrativeStateCode","xml":{"name":"administrative-state-code","prefix":"ns13"},"deprecated":true},"assemblyNumber":{"type":"string","description":"Assembly number","xml":{"name":"assembly-number","prefix":"ns13"}},"assemblyRevision":{"type":"string","description":"Assembly revision","xml":{"name":"assembly-revision","prefix":"ns13"}},"cleiCode":{"type":"string","description":"This object represents the CLEI (Common Language Equipment Identifier) code for the physical entity. If the physical entity is not present in the system, or does not have an associated CLEI code, the value of this object will be null","xml":{"name":"clei-code","prefix":"ns13"}},"configuredIMType":{"type":"string","description":"configuredIMType"},"deviationNumber":{"type":"string","description":"Deviation number","xml":{"name":"deviation-number","prefix":"ns13"}},"entPhysicalContainedIn":{"type":"string","description":"entPhysicalContainedIn"},"entPhysicalIndex":{"type":"string","description":"entPhysicalIndex"},"equipmentType":{"type":"string","description":"Equipment type","xml":{"name":"equipment-type","prefix":"ns13"},"enum":["OTHER","UNKNOWN","CHASSIS","BACKPLANE","POWERSUPPLY","FAN","MODULE","RACK","PROCESSOR","DISK","MEMORY_MODULE","COMPUTE_BLADE","CHASSIS_EXTENDER","MOTHERBOARD","IP_PHONE","WIRELESS_AP","PLUGGABLE_TRANSCEIVER"]},"formFactor":{"type":"string","description":"formFactor","xml":{"name":"form-factor","prefix":"ns13"}},"freeSlotNames":{"type":"string","description":"freeSlotNames","xml":{"name":"free-slot-names","prefix":"ns13"}},"genericAdminState":{"type":"string","description":"Generic admin state","xml":{"name":"generic-admin-state","prefix":"ns13"},"enum":["IS","IS_AINS","OOS_MT","OOS_DSBLD"]},"genericServiceState":{"type":"object","description":"GenericServiceState","properties":{"combinedState":{"type":"string","description":"combinedState","xml":{"name":"combined-state","prefix":"ns13"}},"primaryState":{"type":"string","description":"primaryState","xml":{"name":"primary-state","prefix":"ns13"},"enum":["N_A","IS","OOS"]},"primaryStateQualifier":{"type":"string","description":"primaryStateQualifier","xml":{"name":"primary-state-qualifier","prefix":"ns13"},"enum":["NR","ANR","RST","ANRST","AU","MA","AUMA","AURST","MAANR"]},"secondaryStates":{"uniqueItems":true,"type":"array","description":"secondaryStates","xml":{"name":"secondary-states","prefix":"ns13"},"items":{"type":"string","enum":["ACT","AINS","BLKD","BUSY","CEMA","COMB","DCHL","DSBLD","EX","FAF","FEPO","FLT","IDLE","IDLERCV","IDLETRMT","INHIP","L1ACT","L1DEACT","LKDO","LPBK","MEA","MON","MT","MTCELIMD","NALM","NALMNR","NALMCD","NALMTI","NBK","OVFL","PMI","PPS","PRI","PRTCL","PSE","PSI","PWR","RAR","RDLD","SB","SDEA","SDEE","SGEO","SGES","SO","ST","STBYC","STBYH","STBYI","STBYS","SWDL","SWTCH","SWTI","SWTO","SWUL","TRD","TRMB","TRMF","TRMT","TS","TSTF","UAS","UEQ","WRK"]}}},"$$ref":"#/components/schemas/GenericServiceState"},"hardwareVersion":{"type":"string","description":"hardwareVersion","xml":{"name":"hardware-version","prefix":"ns13"}},"isFRUable":{"type":"string","description":"isFRUable","xml":{"name":"is-field-replaceable-unit","prefix":"ns13"},"enum":["UNKNOWN","TRUE","FALSE","NOT_APPLICABLE"]},"isInMaintenance":{"type":"boolean","description":"isInMaintenance"},"isPhysicallyPresent":{"type":"boolean","description":"isPhysicallyPresent","xml":{"name":"is-physically-present","prefix":"ns13"}},"isReportingAlarmsAllowed":{"type":"string","description":"isReportingAlarmsAllowed","xml":{"name":"is-reporting-alarms-allowed","prefix":"ns13"},"enum":["UNKNOWN","TRUE","FALSE","NOT_APPLICABLE"]},"manufacturedDate":{"type":"string","description":"manufacturedDate","xml":{"name":"manufactured-date","prefix":"ns13"},"format":"date-time"},"manufacturer":{"type":"string","description":"manufacturer","xml":{"name":"manufacturer","prefix":"ns13"}},"mtosiLabel":{"type":"string","description":"mtosiLabel"},"operationalStateCode":{"type":"string","description":"operationalStateCode","xml":{"name":"operational-state-code","prefix":"ns13"},"deprecated":true},"partNumber":{"type":"string","description":"partNumber","xml":{"name":"part-number","prefix":"ns13"}},"position":{"uniqueItems":true,"type":"array","description":"position","xml":{"name":"position","prefix":"ns13"},"deprecated":true,"items":{"type":"string"}},"productFamily":{"type":"string","description":"productFamily","xml":{"name":"product-family","prefix":"ns13"}},"productId":{"type":"string","description":"productId","xml":{"name":"product-id","prefix":"ns13"}},"productName":{"type":"string","description":"productName","xml":{"name":"product-name","prefix":"ns13"}},"restconfFdn":{"type":"string","description":"restconfFdn"},"serialNumber":{"type":"string","description":"serialNumber","xml":{"name":"serial-number","prefix":"ns13"}},"serviceState":{"type":"string","description":"serviceState","xml":{"name":"service-state","prefix":"ns13"},"enum":["STANDBY","UNKNOWN","INSERVICE","OUTOFSERVICE","OUTOFSERVICE_FORMAINTENANCE","NOT_APPLICABLE","SOFTWARE_DOWNLOAD","NOT_INSTALLED","MISMATCH_OF_EQUIPMENT_ALARM"]},"subclassName":{"type":"string","description":"subclassName","xml":{"name":"subclass-name","prefix":"ns13"}},"udi":{"type":"string","description":"udi","xml":{"name":"udi","prefix":"ns13"}},"vendorEquipmentType":{"type":"string","description":"vendorEquipmentType","xml":{"name":"vendor-equipment-type","prefix":"ns13"}},"fdn":{"type":"string","description":"fdn","xml":{"name":"fdn","prefix":"ns13"}},"connectors":{"uniqueItems":true,"type":"array","description":"uniqueItems","xml":{"name":"unique-items","prefix":"ns13"},"items":{"type":"object","description":"PhysicalConnector","xml":{"name":"physical-connector","prefix":"ns13"},"properties":{"description":{"type":"string","description":"description","xml":{"name":"description","prefix":"ns12"}},"name":{"type":"string","description":"name","xml":{"name":"name","prefix":"ns12"}},"owningEntityId":{"type":"string","description":"owningEntityId"},"entityTag":{"type":"string","description":"Generic tag"},"debugMode":{"type":"boolean","description":"Debug mode"},"instanceId":{"type":"integer","description":"Instance id","xml":{"name":"instanceId","prefix":"ns13"},"format":"int64"},"businessKey":{"type":"string","description":"Business key"},"aliasName":{"type":"string","description":"Alias name"},"connectorType":{"type":"string","description":"Connector type"},"entAliasLogicalIndexOrZero":{"type":"string","description":"entAliasLogicalIndexOrZero"},"entPhysicalContainedIn":{"type":"string","description":"entPhysicalContainedIn"},"entPhysicalIndex":{"type":"string","description":"entPhysicalIndex"},"restconfFdn":{"type":"string","description":"restconfFdn"},"vendorEquipmentType":{"type":"string","description":"vendorEquipmentType"},"fdn":{"type":"string","description":"fdn","xml":{"name":"fdn","prefix":"ns13"}},"equipment":{"type":"string","description":"equipment"}},"$$ref":"#/components/schemas/PhysicalConnector"}},"containingEquipment":{"type":"string","description":"containingEquipment","xml":{"name":"containing-equipment","prefix":"ns13"}},"containedEquipmentString":{"type":"array","description":"containedEquipmentString","xml":{"name":"contained-equipment-string","prefix":"ns13"},"items":{"type":"string"}},"processedDescription":{"type":"object","description":"processedDescription","xml":{"name":"processed-description","prefix":"ns13"},"additionalProperties":{"type":"string","description":"additionalProperties","xml":{"name":"additional-properties","prefix":"ns13"}}}},"$$ref":"#/components/schemas/Equipment"}},"containingEquipment":{"type":"string","description":"containingEquipment","xml":{"name":"containing-equipment","prefix":"ns13"}},"isRackMountable":{"type":"boolean","description":"isRackMountable","xml":{"name":"is-rack-mountable","prefix":"ns13"}},"nrFreeSlots":{"type":"integer","description":"nrFreeSlots","xml":{"name":"nr-free-slots","prefix":"ns13"},"format":"int32"},"nrSlots":{"type":"integer","description":"nrSlots","xml":{"name":"nr-slots","prefix":"ns13"},"format":"int32"},"slotConfig":{"type":"string","description":"slotConfig","xml":{"name":"slot-config","prefix":"ns13"},"deprecated":true},"containedEquipmentString":{"type":"array","description":"containedEquipmentString","xml":{"name":"contained-equipment-string","prefix":"ns13"},"items":{"type":"string"}},"processedDescription":{"type":"object","description":"processedDescription","xml":{"name":"processed-description","prefix":"ns13"},"additionalProperties":{"type":"string","description":"additionalProperties","xml":{"name":"additional-properties","prefix":"ns13"}}}},"$$ref":"#/components/schemas/Chassis"}}},"$$ref":"#/components/schemas/DataEq"}},"$$ref":"#/components/schemas/ResponseMessageEq"},"examples":{"example":{"summary":"Sample response","value":{"header":{"firstIndex":0,"lastIndex":2},"data":{"module":[{"ns12:description":"SFP+ 10GBASE-SR","ns12:name":"subslot 0/5 transceiver 0","ns13:containing-equipment":"MD=CISCO_EMS!ND=ASR903-47.cisco-lab!EQ=name=subslot 0/5 transceiver container 0;partnumber=N/A","ns13:ent-physical-index":2404,"ns13:equipment-type":"MODULE","ns13:fdn":"MD=CISCO_EMS!ND=ASR903-47.cisco-lab!EQ=name=subslot 0/5 transceiver 0;partnumber=N/A","ns13:hardware-version":"V03","ns13:instanceId":440442,"ns13:is-field-replaceable-unit":"TRUE","ns13:is-physically-present":true,"ns13:is-reporting-alarms-allowed":"UNKNOWN","ns13:manufactured-date":"2019-01-05T22:00:20Z","ns13:manufacturer":"CISCO-AVAGO ","ns13:operational-state-code":"Up","ns13:product-id":"SFP-10G-SR ","ns13:serial-number":"AVD230194V3 ","ns13:service-state":"UNKNOWN","ns13:vendor-equipment-type":"cevSFP10GSR"}],"equipment":[{"ns12:description":"subslot 0/5 transceiver container 0","ns12:name":"subslot 0/5 transceiver container 0","ns13:contained-equipment":["MD=CISCO_EMS!ND=ASR903-47.cisco-lab!EQ=name=subslot 0/5 transceiver 0;partnumber=N/A"],"ns13:containing-equipment":"MD=CISCO_EMS!ND=ASR903-47.cisco-lab!EQ=name=IM subslot 0/5;partnumber=68-5551-02","ns13:ent-physical-index":2403,"ns13:equipment-type":"OTHER","ns13:fdn":"MD=CISCO_EMS!ND=ASR903-47.cisco-lab!EQ=name=subslot 0/5 transceiver container 0;partnumber=N/A","ns13:instanceId":440441,"ns13:is-field-replaceable-unit":"FALSE","ns13:is-physically-present":true,"ns13:is-reporting-alarms-allowed":"UNKNOWN","ns13:operational-state-code":"Up","ns13:product-id":"N/A","ns13:service-state":"UNKNOWN","ns13:vendor-equipment-type":"cevContainerSFP"}],"chassis":[{"ns12:description":"ASR 903 Series Router Chassis","ns12:name":"Chassis","ns13:assembly-number":"68-3992-01","ns13:assembly-revision":"G0","ns13:clei-code":"URN:CLEI:IPMJ710BRA","ns13:contained-equipment":["MD=CISCO_EMS!ND=ASR903-47.cisco-lab!EQ=name=subslot 0/0;partnumber=N/A"],"ns13:ent-physical-index":1,"ns13:equipment-type":"CHASSIS","ns13:fdn":"MD=CISCO_EMS!ND=ASR903-47.cisco-lab!EQ=name=Chassis;partnumber=68-3992-01","ns13:hardware-version":"V01","ns13:instanceId":440471,"ns13:is-field-replaceable-unit":"TRUE","ns13:is-physically-present":true,"ns13:is-reporting-alarms-allowed":"UNKNOWN","ns13:manufactured-date":"2015-01-24T22:00:20Z","ns13:manufacturer":"Cisco Systems Inc","ns13:operational-state-code":"Up","ns13:part-number":"68-3992-01","ns13:product-id":"ASR-903","ns13:serial-number":"FOX1904PC8W","ns13:service-state":"UNKNOWN","ns13:vendor-equipment-type":"cevChassisASR903","ns13:number-of-slots":0}]}},"$$ref":"#/components/examples/GetEquipmentXml"}}}}},"400":{"description":"Bad Request - Invalid request"},"401":{"description":"Unauthorized. The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden. The server recognizes the authentication credentials, but the client is not authorized to perform this request."},"500":{"description":"Internal Server Error - operation-failed"}},"method":"get","path":"/resource-physical:equipment"}}