{"type":"model","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/1c070d4e-8870-3df3-a541-e46a890a47cb","info":{"title":"Crosswork Workflow Manager Solutions - Inventory","description":"Inventory component addresses the need where we require device details like device name, IP, hostname, Software Type, installed packages.\nFor collecting the required device details, Inventory performs the minimal device data collection using the inventory package in NSO.","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"},"version":"7.1.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/CWM-SOLUTIONS/inventory-api.overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://crosswork-ip:30603/crosswork/cwms/inventory/v1"}],"securitySchemes":{"Bearer":{"type":"apiKey","description":"Type \"Bearer\" followed by a space and JWT token.","name":"Authorization","in":"header"}}},"spec":{"type":"object","properties":{"admin_state":{"type":"object","enum":[0,1,2,3],"x-enum-varnames":["RobotNodeAdminState_ROBOT_ADMIN_STATE_UNKNOWN","RobotNodeAdminState_ROBOT_ADMIN_STATE_UNMANAGED","RobotNodeAdminState_ROBOT_ADMIN_STATE_DOWN","RobotNodeAdminState_ROBOT_ADMIN_STATE_UP"],"$$ref":"#/components/schemas/robotapi.RobotNodeAdminState","description":"Mandatory"},"app_status":{"type":"array","description":"RAK fields","items":{"type":"object","properties":{"app_name":{"type":"string","description":"Application name"},"metadata":{"type":"object","properties":{"fields":{"type":"object","additionalProperties":{"type":"object","properties":{"kind":{"type":"object","description":"The kind of value.\n\nTypes that are valid to be assigned to Kind:\n\n\t*Value_NullValue\n\t*Value_NumberValue\n\t*Value_StringValue\n\t*Value_BoolValue\n\t*Value_StructValue\n\t*Value_ListValue"}},"$$ref":"#/components/schemas/structpb.Value"},"description":"Unordered map of dynamically typed values."}},"$$ref":"#/components/schemas/structpb.Struct","description":"Metadata contains additional details about the application"},"status":{"type":"string","description":"Status of device app name"},"uuid":{"type":"string","description":"UUID of device"}},"description":"API APP Status","$$ref":"#/components/schemas/rakapi.AppStatus"}},"connectivity_info":{"type":"array","description":"Mandatory if Device is not UNMANAGED","items":{"type":"object","properties":{"ReachabilityErrorRetryCount":{"type":"integer","description":"Retry count for the connection type"},"disable_trap_community_check":{"type":"boolean","description":"Flag for disabling community string validation for SNMPv2"},"encoding_type":{"type":"integer","enum":[0,1,2,3,4,5,6,7],"x-enum-varnames":["EncodingType_UNKNOWN_ENCODING_TYPE","EncodingType_ASCII","EncodingType_BYTES","EncodingType_PROTO","EncodingType_JSON","EncodingType_JSON_IETF","EncodingType_XML","EncodingType_YANG"],"$$ref":"#/components/schemas/robotapi.EncodingType"},"error":{"type":"string"},"fqdn":{"type":"object","properties":{"domain_name":{"type":"string","description":"Domain name"},"host_name":{"type":"string","description":"host name"}},"$$ref":"#/components/schemas/robotapi.FQDN","description":"Fully qualified domain of the entity"},"ipaddrs":{"type":"array","description":"V4/V6 ip address for this connectivity type","items":{"type":"object","properties":{"gateway":{"type":"string"},"inet_addr":{"type":"string"},"inet_af":{"type":"integer","enum":[0,1,2],"x-enum-varnames":["RobotInetAddressFamily_ROBOT_INET_ADDR_TYPE_NONE","RobotInetAddressFamily_ROBOT_INET_ADDR_TYPE_v4","RobotInetAddressFamily_ROBOT_INET_ADDR_TYPE_v6"],"$$ref":"#/components/schemas/robotapi.RobotInetAddressFamily"},"mask":{"type":"string"}},"$$ref":"#/components/schemas/robotapi.RobotInetAddr"}},"port":{"type":"integer","description":"Port for this connectivity type"},"primary_proxy":{"type":"string"},"reachability_state":{"type":"object","enum":[0,1,2,3,4,5],"x-enum-comments":{"RobotEntityConnectivityState_CONN_STATE_MAX":"Deprecated: Do not use."},"x-enum-varnames":["RobotEntityConnectivityState_CONN_STATE_INVALID","RobotEntityConnectivityState_CONN_STATE_UNKNOWN","RobotEntityConnectivityState_CONN_STATE_REACHABLE","RobotEntityConnectivityState_CONN_STATE_UNREACHABLE","RobotEntityConnectivityState_CONN_STATE_MAX","RobotEntityConnectivityState_CONN_STATE_DEGRADED"],"$$ref":"#/components/schemas/robotapi.RobotEntityConnectivityState","description":"Reachability Status for Transport Connection"},"reachability_state_upd_time":{"type":"integer","description":"Reachability timestamp. Time when the reach state was updated.\nUnix epoch time in seconds."},"retries":{"type":"integer","description":"Deleted as it was a mistak\nstring snmpv3_engine_id = 12;"},"secondary_proxy":{"type":"string"},"single_session":{"type":"boolean"},"timeout":{"type":"integer","description":"Timeout for this connectivity type"},"trap_source_ip":{"type":"string","description":"Source IP for SNMP traps"},"type":{"type":"object","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17],"x-enum-varnames":["RobotTransportType_ROBOT_MSVC_TRANS_NONE","RobotTransportType_ROBOT_MSVC_TRANS_TCP","RobotTransportType_ROBOT_MSVC_TRANS_UDP","RobotTransportType_ROBOT_MSVC_TRANS_HTTP","RobotTransportType_ROBOT_MSVC_TRANS_HTTPS","RobotTransportType_ROBOT_MSVC_TRANS_GRPC","RobotTransportType_ROBOT_MSVC_TRANS_SSH","RobotTransportType_ROBOT_MSVC_TRANS_NETCONF","RobotTransportType_ROBOT_MSVC_TRANS_TELNET","RobotTransportType_ROBOT_MSVC_TRANS_SNMP","RobotTransportType_ROBOT_MSVC_TRANS_TL1","RobotTransportType_ROBOT_MSVC_TRANS_TL1_SECURE","RobotTransportType_ROBOT_MSVC_TRANS_ICMP","RobotTransportType_ROBOT_MSVC_TRANS_KAFKA","RobotTransportType_ROBOT_MSVC_TRANS_NATS","RobotTransportType_ROBOT_MSVC_TRANS_GNMI","RobotTransportType_ROBOT_MSVC_TRANS_GNMI_SECURE","RobotTransportType_ROBOT_MSVC_TRANS_GRPC_SECURE"],"$$ref":"#/components/schemas/robotapi.RobotTransportType","description":"Device connectivity type."}},"$$ref":"#/components/schemas/robotapi.RobotTransport"}},"geo_info":{"type":"object","properties":{"building":{"type":"string"},"city":{"type":"string"},"coordinates":{"type":"object","properties":{"altitude":{"type":"object","properties":{"value":{"type":"number"}},"$$ref":"#/components/schemas/robotapi.Double"},"latitude":{"type":"object","properties":{"value":{"type":"number"}},"$$ref":"#/components/schemas/robotapi.Double"},"longitude":{"type":"object","properties":{"value":{"type":"number"}},"$$ref":"#/components/schemas/robotapi.Double"}},"$$ref":"#/components/schemas/robotapi.RobotGeoCoordinates"},"country":{"type":"string"},"range_incr":{"type":"object","properties":{"altitude":{"type":"object","properties":{"value":{"type":"number"}},"$$ref":"#/components/schemas/robotapi.Double"},"latitude":{"type":"object","properties":{"value":{"type":"number"}},"$$ref":"#/components/schemas/robotapi.Double"},"longitude":{"type":"object","properties":{"value":{"type":"number"}},"$$ref":"#/components/schemas/robotapi.Double"}},"$$ref":"#/components/schemas/robotapi.RobotGeoCoordinates","description":"Applicable only on the Request. Used only for transitional data\nto specify the increments(+/-) on the coordinates above for\nsearching the list of device in the Range."},"region":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"},"zip":{"type":"string"}},"$$ref":"#/components/schemas/robotapi.RobotNodeGeoData"},"host_name":{"type":"string","description":"Discovered parameter. If value entered is different from the discovered value, it is overwritten."},"last_upd_time":{"type":"integer"},"ned_id":{"type":"string"},"nso_state":{"type":"integer","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22],"x-enum-varnames":["NsoDeviceOperState_INVALID_NSO_OPER_STATE","NsoDeviceOperState_ASSOCIATED","NsoDeviceOperState_NOT_ASSOCIATED","NsoDeviceOperState_MATCH","NsoDeviceOperState_NO_MATCH","NsoDeviceOperState_ONBOARD_FAIL","NsoDeviceOperState_FETCH_SSH_KEYS_SCHEDULED","NsoDeviceOperState_FETCH_SSH_KEYS_STARTED","NsoDeviceOperState_FETCH_SSH_KEYS_FAILED","NsoDeviceOperState_CONNECT_SCHEDULED","NsoDeviceOperState_CONNECT_STARTED","NsoDeviceOperState_CONNECT_FAILED","NsoDeviceOperState_SYNC_FROM_SCHEDULED","NsoDeviceOperState_SYNC_FROM_STARTED","NsoDeviceOperState_SYNC_TO_SCHEDULED","NsoDeviceOperState_SYNC_TO_STARTED","NsoDeviceOperState_SYNCED","NsoDeviceOperState_SYNC_FAILED","NsoDeviceOperState_CHECK_SYNC_SCHEDULED","NsoDeviceOperState_CHECK_SYNC_STARTED","NsoDeviceOperState_NOT_SYNCED","NsoDeviceOperState_COMPARE_CONFIG_SCHEDULED","NsoDeviceOperState_COMPARE_CONFIG_STARTED"],"$$ref":"#/components/schemas/robotapi.NsoDeviceOperState"},"product_info":{"type":"object","properties":{"capability":{"type":"array","description":"Device capability. Enum of TL1, SNMP, YANG, MDT, PDT, etc.","items":{"type":"integer","enum":[0,1,2,3,4,5,6,7,8,9],"x-enum-comments":{"RobotNodeCapability_SCHEMA_MDT":"Deprecated: Do not use.","RobotNodeCapability_SCHEMA_PDT":"Deprecated: Do not use."},"x-enum-varnames":["RobotNodeCapability_NONE","RobotNodeCapability_YANG_MDT","RobotNodeCapability_SCHEMA_MDT","RobotNodeCapability_SCHEMA_PDT","RobotNodeCapability_SNMP","RobotNodeCapability_TL1","RobotNodeCapability_YANG_CLI","RobotNodeCapability_YANG_EPNM","RobotNodeCapability_SNMPTRAPS","RobotNodeCapability_GNMI"],"$$ref":"#/components/schemas/robotapi.RobotNodeCapability"}},"config_change_timestamp":{"type":"string"},"device_type":{"type":"object","enum":[0,1,2,3,4,5,6,7],"x-enum-varnames":["RobotNodeType_NODE_TYPE_UNKNOWN","RobotNodeType_NODE_TYPE_ROUTER","RobotNodeType_NODE_TYPE_SWITCH","RobotNodeType_NODE_TYPE_ROADM","RobotNodeType_NODE_TYPE_AMPLIFIER","RobotNodeType_NODE_TYPE_CBR","RobotNodeType_NODE_TYPE_TERMINAL","RobotNodeType_NODE_TYPE_TXP"],"$$ref":"#/components/schemas/robotapi.RobotNodeType","description":"Node Type. e.g. SWITCH, ROUTER.."},"hw_change_timestamp":{"type":"string"},"manufacturer":{"type":"string"},"product_family":{"type":"string"},"product_series":{"type":"string"},"product_type":{"type":"string"},"snmp_engine_id":{"type":"string"},"software_type":{"type":"string"},"software_version":{"type":"string"},"support_level":{"type":"object","enum":[0,1,2],"x-enum-varnames":["DeviceSupportLevel_DEVICE_SUPPORT_LEVEL_UNKNOWN","DeviceSupportLevel_DEVICE_SUPPORT_LEVEL_CERTIFIED","DeviceSupportLevel_DEVICE_SUPPORT_LEVEL_UNCERTIFIED"],"$$ref":"#/components/schemas/robotapi.DeviceSupportLevel","description":"Device support level"},"sys_object_id":{"type":"string"},"syslog_format":{"type":"object","enum":[0,1,2,3],"x-enum-varnames":["RobotSyslogFormat_RFC_INVALID","RobotSyslogFormat_RFC_UNKNOWN","RobotSyslogFormat_RFC_5424","RobotSyslogFormat_RFC_3164"],"$$ref":"#/components/schemas/robotapi.RobotSyslogFormat","description":"Syslog format on the device"}},"$$ref":"#/components/schemas/robotapi.RobotNodeProductInfo"},"profile":{"type":"string","description":"Mandatory if Device is not UNMANAGED"},"providers_family":{"type":"object","additionalProperties":{"type":"object","properties":{"providers":{"type":"object","additionalProperties":{"type":"object","properties":{"provider_name":{"type":"string"},"provider_node_id":{"type":"string"},"provider_params":{"type":"object","additionalProperties":{"type":"string"}},"provider_uuid":{"type":"string"}},"$$ref":"#/components/schemas/robotapi.RobotNodeProvider"}}},"$$ref":"#/components/schemas/robotapi.RobotProviderFamilyGroup"}},"rak_inv_collection_status":{"type":"object","enum":[0,1,2,3],"x-enum-varnames":["RAKInvCollectionStatus_RAK_INV_COLLECTION_STATUS_UNKNOWN","RAKInvCollectionStatus_RAK_INV_COLLECTION_STATUS_INITIATED","RAKInvCollectionStatus_RAK_INV_COLLECTION_STATUS_COMPLETED","RAKInvCollectionStatus_RAK_INV_COLLECTION_STATUS_FAILED"],"$$ref":"#/components/schemas/robotapi.RAKInvCollectionStatus","description":"RAK Inventory Collection Status"},"reachability_state":{"type":"object","enum":[0,1,2,3,4,5],"x-enum-comments":{"RobotEntityConnectivityState_CONN_STATE_MAX":"Deprecated: Do not use."},"x-enum-varnames":["RobotEntityConnectivityState_CONN_STATE_INVALID","RobotEntityConnectivityState_CONN_STATE_UNKNOWN","RobotEntityConnectivityState_CONN_STATE_REACHABLE","RobotEntityConnectivityState_CONN_STATE_UNREACHABLE","RobotEntityConnectivityState_CONN_STATE_MAX","RobotEntityConnectivityState_CONN_STATE_DEGRADED"],"$$ref":"#/components/schemas/robotapi.RobotEntityConnectivityState","description":"Derived value"},"serial_number":{"type":"string"},"uuid":{"type":"string","description":"DLM fields"}},"description":"response of device query API","$$ref":"#/components/schemas/rakapi.RakDeviceDataGet","title":"rakapi.RakDeviceDataGet"}}