Equipment - Crosswork Network Controller 7.1 APIs

{"type":"model","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":{"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","title":"Equipment"}}