{"type":"api","title":"Retrieves Devices with given collection status","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/7c48b645-9c1b-3c59-9c5a-150c8b12ee59","info":{"title":"Inventory APIs","description":"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":"7.1.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/inventory-api-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{server_ip}:30603/crosswork/inventory/v1/networkelement","description":"Generated server url"}]},"spec":{"tags":["Inventory"],"summary":"Retrieves Devices with given collection status","description":"\u003cb\u003e Payload details: \u003c/b\u003e \n\n collectionstatus: Represents the collection status of a device. \n\n - Values(string) can be \u003cb\u003e \"completed\" , \"inprogress\" , \"failed\" , \"maintenance\" and \"warning\" \u003c/b\u003e ","operationId":"nodesPerCollectionStatus","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"UUIDPerCollStatusRequestDTO","properties":{"collectionstatus":{"type":"string","description":"collectionstatus"},"offset":{"type":"integer","format":"int32","description":"offset"},"count":{"type":"integer","format":"int32","description":"count"}},"$$ref":"#/components/schemas/UUIDPerCollStatusRequestDTO"},"example":{"collectionstatus":"completed","offset":0,"count":0}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"RobotNodeData","properties":{"node_ip":{"description":"node_ip","type":"object","properties":{"inet_af":{"type":"string","description":"inet_af"},"inet_addr":{"type":"object","description":"inet_addr"},"mask":{"type":"object","description":"mask"}},"$$ref":"#/components/schemas/NodeInetAddr"},"uuid":{"type":"string","description":"uuid"},"host_name":{"type":"string","description":"host_name"},"profile":{"type":"string","description":"profile"},"reachability_state":{"type":"string","description":"reachability_state"},"admin_state":{"type":"string","description":"admin_state"},"connectivity_info":{"type":"object","description":"connectivity_info"},"product_info":{"type":"object","description":"product_info"},"geo_info":{"type":"object","description":"geo_info"},"routing_info":{"type":"object","description":"routing_info"},"contact":{"type":"object","description":"contact"},"uptime":{"type":"string","description":"uptime"},"last_upd_time":{"type":"string","description":"last_upd_time"},"reachability_check":{"type":"string","description":"reachability_check"},"reachability_state_upd_time":{"type":"string","description":"reachability_state_upd_time"},"operational_state":{"type":"string","description":"operational_state"},"state_map":{"type":"object","description":"state_map"},"Inventory":{"type":"object","description":"Inventory"},"dg_uuid":{"type":"string","description":"dg_uuid"},"dg_name":{"type":"string","description":"dg_name"},"tag_names":{"type":"object","description":"tag_names"},"device_fqdn":{"type":"object","description":"device_fqdn"}},"$$ref":"#/components/schemas/RobotNodeData"},"example":{"data":[{"node_ip":{"inet_af":"ROBOT_INET_ADDR_TYPE_v4","inet_addr":"10.65.110.17","mask":"24"},"uuid":"9f5282f3-2764-47bd-9b5f-73a1937fe7f2","host_name":"R2","profile":"vmx","reachability_state":"CONN_STATE_REACHABLE","admin_state":"ROBOT_ADMIN_STATE_UP","connectivity_info":[{"type":"ROBOT_MSVC_TRANS_SNMP","ipaddrs":[{"inet_af":"ROBOT_INET_ADDR_TYPE_v4","inet_addr":"10.65.110.17","mask":"24"}],"port":161,"timeout":"30","reachability_state":"CONN_STATE_REACHABLE","reachability_state_upd_time":"1730948730"}],"product_info":{"product_type":"VMX","product_family":"Juniper Networks Inc. vmx internet","product_series":"Juniper Networks Inc. vmx internet","manufacturer":"Juniper Networks","sys_object_id":"1.3.6.1.4.1.2636.1.1.1.2.108","hw_change_timestamp":"noSuchObject","capability":["SNMP"],"device_type":"NODE_TYPE_ROUTER","syslog_format":"RFC_UNKNOWN"},"geo_info":{"coordinates":{},"range_incr":{}},"routing_info":{},"uptime":"43w3d22h25m30s","last_upd_time":"1730948691","reachability_check":"REACH_CHECK_ENABLE","reachability_state_upd_time":"1730948730","operational_state":"ROBOT_OPER_STATE_OK","state_map":{"1":{"value":"UP","last_updated_time":"1731395093","next_check_time":"1731395093"},"2":{"value":"UP","last_updated_time":"1730948730","next_check_time":"1730948730"}},"Inventory":{"sys_desc":"Juniper Networks, Inc. vmx internet router, kernel JUNOS 21.1R1.11, Build date: 2021-03-18 19:44:12 UTC Copyright (c) 1996-2021 Juniper Networks, Inc."},"dg_uuid":"ce5c70f5-a47c-43fe-8be6-6d302061ccg9","providers_family":{"ROBOT_PROVIDER_NSO":{"providers":{"":{}}}},"dg_name":"EMBEDDED_DEF_POOL-1","tag_names":["reach-check","snmp","fault-gnmi"],"device_fqdn":{"host_name":"R2"}}],"total_count":1,"result_count":1}}}},"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"}},"__originalOperationId":"nodesPerCollectionStatus","method":"post","path":"/query"}}