{"type":"api","title":"Retrieve node count","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/4ecd3a14-d0be-3ef0-ba5d-c3cd958217a7","info":{"title":"Crosswork Device Lifecycle Management (DLM) Inventory API","description":"Crosswork DLM Inventory APIs allow the user to perform CRUD operations on Crosswork Tags, Credentials, Providers and Nodes.","version":"1.0.0","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"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/DLM/nodedbapi-overview.md"}},"swagger":"2.0","basePath":"/crosswork/inventory/v1","schemes":["http","https"],"securityDefinitions":{"bearerAuth":{"type":"apiKey","description":"bearer auth","name":"Authorization","in":"header"}}},"spec":{"summary":"Retrieve node count","description":"Retrieves a count of all nodes in the database. Argument needs to be a RobotNodeGetReq structure, but needs no field\n```\n Input:\n RobotNodeGetReq -for Details, look at the Request Message\nOutput:\n RobotNodeDataCount - Returns the number of nodes in the database\n```\nDEPRECATED URL : post: /v1/dlm/invmgr/nodes/count","operationId":"NodeDb_GetNodeCount","responses":{"200":{"description":"A successful response.","schema":{"type":"object","properties":{"number_of_nodes":{"type":"integer","format":"int64","title":"Number that specifies number of nodes in DB"}},"example":{"number_of_nodes":0},"$$ref":"#/definitions/robotapiRobotNodeDataCount"}},"default":{"description":"An unexpected error response.","schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"type_url":{"type":"string"},"value":{"type":"string","format":"byte"}},"$$ref":"#/definitions/protobufAny"}}},"example":{"error":"string","code":0,"message":"string","details":[{"type_url":"string","value":"string"}]},"$$ref":"#/definitions/runtimeError"}}},"parameters":[{"name":"limit","description":"Number of nodes requested in the response.\nMax Limit is 1000 and Default Limit is 50.\n\nThe 'pagesize' parameter determines the number of nodes that can retrieved per page, where as the 'pagenum' specifies the page from which to retrieve these nodes. For instance, in the following example, the first case retrieves 1000 nodes with 'pagenum 0'. In the subsequent example, it retrieves the next 1000 nodes (from 1001 to 2000).\n\n{\n\"filterData\": {\n\"PageSize\": 1000,\n\"PageNum\": 0\n}\n}\n\n{\n\"filterData\": {\n\"PageSize\": 1000,\n\"PageNum\": 1\n}\n}","in":"query","required":false,"type":"integer","format":"int64"},{"name":"sort_by.inv_key_type","in":"query","description":"Supported Inventory Key Types","required":false,"type":"string","enum":["INVALID_TYPE","UUID","INVENTORY_ID","NODE_IP","SERIAL_NUMBER","MAC","HOST_NAME"],"default":"INVALID_TYPE"},{"name":"sort_by.inventory_id","description":"Custom unique device identifier.","in":"query","required":false,"type":"string"},{"name":"sort_by.node_ip.inet_af","in":"query","description":"Device Inet Address Family","required":false,"type":"string","enum":["ROBOT_INET_ADDR_TYPE_NONE","ROBOT_INET_ADDR_TYPE_v4","ROBOT_INET_ADDR_TYPE_v6"],"default":"ROBOT_INET_ADDR_TYPE_NONE"},{"name":"sort_by.node_ip.inet_addr","in":"query","description":"Device Inet Address","required":false,"type":"string"},{"name":"sort_by.node_ip.mask","in":"query","description":"Device mask","required":false,"type":"string"},{"name":"sort_by.node_ip.gateway","in":"query","description":"Device gateway","required":false,"type":"string"},{"name":"sort_by.uuid","description":"Uuid is randomly generated by crossworks, readonly.","in":"query","required":false,"type":"string"},{"name":"sort_by.mac","description":"Chassis backplane Mac address.","in":"query","required":false,"type":"string"},{"name":"sort_by.serial_number","description":"Device Serial Number.","in":"query","required":false,"type":"string"},{"name":"sort_by.host_name","description":"Device Host name.","in":"query","required":false,"type":"string"},{"name":"sort_by.profile","description":"MUST FIELD.\nCredential Profile applicable to this device.","in":"query","required":false,"type":"string"},{"name":"sort_by.reachability_state","description":"Reachability state.","in":"query","required":false,"type":"string","enum":["CONN_STATE_INVALID","CONN_STATE_UNKNOWN","CONN_STATE_REACHABLE","CONN_STATE_UNREACHABLE","CONN_STATE_MAX","CONN_STATE_DEGRADED"],"default":"CONN_STATE_INVALID"},{"name":"sort_by.admin_state","description":"Device Admin state.","in":"query","required":false,"type":"string","enum":["ROBOT_ADMIN_STATE_UNKNOWN","ROBOT_ADMIN_STATE_UNMANAGED","ROBOT_ADMIN_STATE_DOWN","ROBOT_ADMIN_STATE_UP"],"default":"ROBOT_ADMIN_STATE_UNKNOWN"},{"name":"sort_by.product_info.software_type","description":"Device product info.software type","in":"query","required":false,"type":"string"},{"name":"sort_by.product_info.software_version","description":"Device product info.software version","in":"query","required":false,"type":"string"},{"name":"sort_by.product_info.product_type","in":"query","description":"Device product info.product type","required":false,"type":"string"},{"name":"sort_by.product_info.product_family","in":"query","description":"Device product info.product family","required":false,"type":"string"},{"name":"sort_by.product_info.product_series","in":"query","description":"Device product info.product series","required":false,"type":"string"},{"name":"sort_by.product_info.manufacturer","in":"query","description":"Device product info.manufacturer","required":false,"type":"string"},{"name":"sort_by.product_info.sys_object_id","in":"query","description":"Device product info.sys object id","required":false,"type":"string"},{"name":"sort_by.product_info.hw_change_timestamp","in":"query","description":"Device product info.hw change timestamp","required":false,"type":"string"},{"name":"sort_by.product_info.config_change_timestamp","in":"query","description":"Device product info.config change timestamp","required":false,"type":"string"},{"name":"sort_by.product_info.capability","description":"Device capability. Enum of TL1, SNMP, YANG, MDT, PDT, etc.","in":"query","required":false,"type":"array","items":{"type":"string","enum":["NONE","YANG_MDT","SCHEMA_MDT","SCHEMA_PDT","SNMP","TL1","YANG_CLI","YANG_EPNM","SNMPTRAPS","GNMI"]},"collectionFormat":"multi"},{"name":"sort_by.product_info.device_type","description":"Node Type. e.g. SWITCH, ROUTER..\n\n - NODE_TYPE_UNKNOWN: Not known\n - NODE_TYPE_ROUTER: Layer 3 router\n - NODE_TYPE_SWITCH: Layer 2 ethernet switch\n - NODE_TYPE_ROADM: Layer 1 optical add/drop device NCS2000\n - NODE_TYPE_AMPLIFIER: Layer 1 optical repeater/ amplifier\n - NODE_TYPE_CBR: Converged broadband router\n - NODE_TYPE_TERMINAL: Layer 1 optical add/drop device NCS1010\n - NODE_TYPE_TXP: NCS 1004 family","in":"query","required":false,"type":"string","enum":["NODE_TYPE_UNKNOWN","NODE_TYPE_ROUTER","NODE_TYPE_SWITCH","NODE_TYPE_ROADM","NODE_TYPE_AMPLIFIER","NODE_TYPE_CBR","NODE_TYPE_TERMINAL","NODE_TYPE_TXP"],"default":"NODE_TYPE_UNKNOWN"},{"name":"sort_by.product_info.snmp_engine_id","in":"query","description":"Device product info.snmp engine id","required":false,"type":"string"},{"name":"sort_by.product_info.syslog_format","description":"Syslog format on the device.","in":"query","required":false,"type":"string","enum":["RFC_INVALID","RFC_UNKNOWN","RFC_5424","RFC_3164"],"default":"RFC_INVALID"},{"name":"sort_by.geo_info.coordinates.longitude.value","in":"query","description":"Geo coordinates longitude value.","required":false,"type":"number","format":"double"},{"name":"sort_by.geo_info.coordinates.latitude.value","in":"query","description":"Geo coordinates latitude value.","required":false,"type":"number","format":"double"},{"name":"sort_by.geo_info.coordinates.altitude.value","in":"query","description":"Geo coordinates altitude value.","required":false,"type":"number","format":"double"},{"name":"sort_by.geo_info.building","in":"query","description":"Geo info building.","required":false,"type":"string"},{"name":"sort_by.geo_info.street","in":"query","description":"Geo info street.","required":false,"type":"string"},{"name":"sort_by.geo_info.city","in":"query","description":"Geo info city.","required":false,"type":"string"},{"name":"sort_by.geo_info.state","in":"query","description":"Geo info state.","required":false,"type":"string"},{"name":"sort_by.geo_info.country","in":"query","description":"Geo info country.","required":false,"type":"string"},{"name":"sort_by.geo_info.region","in":"query","description":"Geo info region.","required":false,"type":"string"},{"name":"sort_by.geo_info.zip","in":"query","description":"Geo info zip code.","required":false,"type":"string"},{"name":"sort_by.geo_info.range_incr.longitude.value","in":"query","description":"Geo info (searching the list of device in the Range) longitude value.","required":false,"type":"number","format":"double"},{"name":"sort_by.geo_info.range_incr.latitude.value","in":"query","description":"Geo info (searching the list of device in the Range) latitude value.","required":false,"type":"number","format":"double"},{"name":"sort_by.geo_info.range_incr.altitude.value","in":"query","description":"Geo info (searching the list of device in the Range) altitude value.","required":false,"type":"number","format":"double"},{"name":"sort_by.routing_info.global_isis_system_id","in":"query","description":"Routing info global isis system id.","required":false,"type":"string"},{"name":"sort_by.routing_info.global_ospf_router_id","in":"query","description":"Routing info global ospf router id.","required":false,"type":"string"},{"name":"sort_by.routing_info.router_loopback.inet_af","in":"query","description":"Routing info router loopback Inet address Family.","required":false,"type":"string","enum":["ROBOT_INET_ADDR_TYPE_NONE","ROBOT_INET_ADDR_TYPE_v4","ROBOT_INET_ADDR_TYPE_v6"],"default":"ROBOT_INET_ADDR_TYPE_NONE"},{"name":"sort_by.routing_info.router_loopback.inet_addr","in":"query","description":"Routing info router loopback Inet address.","required":false,"type":"string"},{"name":"sort_by.routing_info.router_loopback.mask","in":"query","description":"Routing info router loopback mask.","required":false,"type":"string"},{"name":"sort_by.routing_info.router_loopback.gateway","in":"query","description":"Routing info router loopback gateway.","required":false,"type":"string"},{"name":"sort_by.routing_info.mgmt_vrf","in":"query","description":"Routing info mgmtvrf.","required":false,"type":"string"},{"name":"sort_by.routing_info.telemetry_intf_src_name","in":"query","description":"Routing info telemetry intf src name.","required":false,"type":"string"},{"name":"sort_by.routing_info.telemetry_intf_src_vrf","in":"query","description":"Routing info telemetry intf src vrf.","required":false,"type":"string"},{"name":"sort_by.routing_info.telemetry_transport_type","in":"query","description":"Routing info telemetry transport type.","required":false,"type":"string","enum":["UNKNOWN_TRANSPORT_TYPE","TCP_DIALOUT"],"default":"UNKNOWN_TRANSPORT_TYPE"},{"name":"sort_by.routing_info.telemetry_device_encoding","in":"query","description":"Routing info telemetry device encoding.","required":false,"type":"string","enum":["UNKNOWN_ENCODING","GPBKV"],"default":"UNKNOWN_ENCODING"},{"name":"sort_by.routing_info.te_router_id","description":"Traffic engineering router id.","in":"query","required":false,"type":"string"},{"name":"sort_by.routing_info.ipv6_router_id","in":"query","description":"Routing info ipv6 router id.","required":false,"type":"string"},{"name":"sort_by.routing_info.is_opt_out_of_mdt_collection_config_enabled","description":"Skip collection of MDT configuration on a device.","in":"query","required":false,"type":"boolean"},{"name":"sort_by.contact","description":"Owner contact for this device.","in":"query","required":false,"type":"string"},{"name":"sort_by.uptime","description":"Device uptime.","in":"query","required":false,"type":"string"},{"name":"sort_by.last_upd_time","description":"Last time this Inventory Entry was Updated in DB.","in":"query","required":false,"type":"string","format":"int64"},{"name":"sort_by.reachability_check","in":"query","description":"reachability check.","required":false,"type":"string","enum":["REACH_CHECK_NONE","REACH_CHECK_DISABLE","REACH_CHECK_ENABLE"],"default":"REACH_CHECK_NONE"},{"name":"sort_by.reachability_state_upd_time","in":"query","description":"reachability state update time.","required":false,"type":"string","format":"int64"},{"name":"sort_by.operational_state","description":"Device operational state -readonly.","in":"query","required":false,"type":"string","enum":["ROBOT_OPER_STATE_UNKNOWN","ROBOT_OPER_STATE_UNMANAGED","ROBOT_OPER_STATE_ADMIN_DOWN","ROBOT_OPER_STATE_CHECKING","ROBOT_OPER_STATE_OK","ROBOT_OPER_STATE_ERROR","ROBOT_OPER_STATE_LOCKED","ROBOT_OPER_STATE_DELETING"],"default":"ROBOT_OPER_STATE_UNKNOWN"},{"name":"sort_by.lock_status.lock_id","in":"query","description":"device lock status lock id","required":false,"type":"string"},{"name":"sort_by.lock_status.state","description":" - ERRORED: Node is in error state. This would happen when LOCK\nowner does not renew or release the state within timeout","in":"query","required":false,"type":"string","enum":["INVALID_STATE","UNLOCKED","LOCKED","ERRORED"],"default":"INVALID_STATE"},{"name":"sort_by.lock_status.owner","in":"query","description":"device lock status owner","required":false,"type":"string"},{"name":"sort_by.lock_status.start_time","in":"query","description":"device lock status start time","required":false,"type":"string","format":"int64"},{"name":"sort_by.lock_status.end_time","in":"query","description":"device lock status end time","required":false,"type":"string","format":"int64"},{"name":"sort_by.errors","description":"List of errors for the node - readonly.","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sort_by.Inventory.sys_desc","in":"query","description":"Inventory sys description","required":false,"type":"string"},{"name":"sort_by.Inventory.sys_location","in":"query","description":"Inventory sys location","required":false,"type":"string"},{"name":"sort_by.Inventory.architecture","in":"query","description":"Inventory architecture","required":false,"type":"string"},{"name":"sort_by.Inventory.cli_cache_enabled","in":"query","description":"Inventory cli cache enabled","required":false,"type":"boolean"},{"name":"sort_by.Inventory.created_by","in":"query","description":"Inventory created by","required":false,"type":"string"},{"name":"sort_by.Inventory.gnmi_preffered","in":"query","description":"Inventory gnmi preffered","required":false,"type":"boolean"},{"name":"sort_by.dg_uuid","description":"RobotDataGateway mapped_dg = 27;.","in":"query","required":false,"type":"string"},{"name":"sort_by.direct_access","description":"This attribute is only for internal use by scale testing. Not exposed via API/GUI/Swagger docs.","in":"query","required":false,"type":"string","enum":["NOT_ALLOWED","ALLOWED"],"default":"NOT_ALLOWED"},{"name":"sort_by.dg_name","in":"query","description":"data gateway name","required":false,"type":"string"},{"name":"sort_by.nso_state","in":"query","description":"NSO state","required":false,"type":"string","enum":["INVALID_NSO_OPER_STATE","ASSOCIATED","NOT_ASSOCIATED","MATCH","NO_MATCH","ONBOARD_FAIL","FETCH_SSH_KEYS_SCHEDULED","FETCH_SSH_KEYS_STARTED","FETCH_SSH_KEYS_FAILED","CONNECT_SCHEDULED","CONNECT_STARTED","CONNECT_FAILED","SYNC_FROM_SCHEDULED","SYNC_FROM_STARTED","SYNC_TO_SCHEDULED","SYNC_TO_STARTED","SYNCED","SYNC_FAILED","CHECK_SYNC_SCHEDULED","CHECK_SYNC_STARTED","NOT_SYNCED","COMPARE_CONFIG_SCHEDULED","COMPARE_CONFIG_STARTED"],"default":"INVALID_NSO_OPER_STATE"},{"name":"sort_by.NsoMsg","in":"query","description":"NSO message","required":false,"type":"string"},{"name":"sort_by.encryption","in":"query","description":"encryption","required":false,"type":"string"},{"name":"sort_by.nso_timestamp","in":"query","description":"NSO timestamp","required":false,"type":"string","format":"int64"},{"name":"sort_by.tag_names","description":"Tags names this device belongs to.","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sort_by.device_fqdn.host_name","description":"host name.","in":"query","required":false,"type":"string"},{"name":"sort_by.device_fqdn.domain_name","description":"Domain name.","in":"query","required":false,"type":"string"},{"name":"sort_by.disable_static_route","in":"query","description":"static route enabled or not","required":false,"type":"boolean"},{"name":"next_from","description":"Response would contain Data with keys \u003e next_from.","in":"query","required":false,"type":"string"},{"name":"filter.inv_key_type","in":"query","description":"Inventory key type","required":false,"type":"string","enum":["INVALID_TYPE","UUID","INVENTORY_ID","NODE_IP","SERIAL_NUMBER","MAC","HOST_NAME"],"default":"INVALID_TYPE"},{"name":"filter.inventory_id","description":"Custom unique device identifier.","in":"query","required":false,"type":"string"},{"name":"filter.node_ip.inet_af","in":"query","description":"Device Inet address family","required":false,"type":"string","enum":["ROBOT_INET_ADDR_TYPE_NONE","ROBOT_INET_ADDR_TYPE_v4","ROBOT_INET_ADDR_TYPE_v6"],"default":"ROBOT_INET_ADDR_TYPE_NONE"},{"name":"filter.node_ip.inet_addr","in":"query","description":"Device Inet address","required":false,"type":"string"},{"name":"filter.node_ip.mask","in":"query","description":"Device mask","required":false,"type":"string"},{"name":"filter.node_ip.gateway","in":"query","description":"Device gateway","required":false,"type":"string"},{"name":"filter.uuid","description":"Uuid is randomly generated by crossworks, readonly.","in":"query","required":false,"type":"string"},{"name":"filter.mac","description":"Chassis backplane Mac address.","in":"query","required":false,"type":"string"},{"name":"filter.serial_number","description":"Device Serial Number.","in":"query","required":false,"type":"string"},{"name":"filter.host_name","description":"Device Host name.","in":"query","required":false,"type":"string"},{"name":"filter.profile","description":"MUST FIELD.\nCredential Profile applicable to this device.","in":"query","required":false,"type":"string"},{"name":"filter.reachability_state","description":"Reachability state.","in":"query","required":false,"type":"string","enum":["CONN_STATE_INVALID","CONN_STATE_UNKNOWN","CONN_STATE_REACHABLE","CONN_STATE_UNREACHABLE","CONN_STATE_MAX","CONN_STATE_DEGRADED"],"default":"CONN_STATE_INVALID"},{"name":"filter.admin_state","description":"Device Admin state.","in":"query","required":false,"type":"string","enum":["ROBOT_ADMIN_STATE_UNKNOWN","ROBOT_ADMIN_STATE_UNMANAGED","ROBOT_ADMIN_STATE_DOWN","ROBOT_ADMIN_STATE_UP"],"default":"ROBOT_ADMIN_STATE_UNKNOWN"},{"name":"filter.product_info.software_type","in":"query","description":"Device product info.software type","required":false,"type":"string"},{"name":"filter.product_info.software_version","in":"query","description":"Device product info.software version","required":false,"type":"string"},{"name":"filter.product_info.product_type","in":"query","description":"Device product info.product type","required":false,"type":"string"},{"name":"filter.product_info.product_family","in":"query","description":"Device product info.product family","required":false,"type":"string"},{"name":"filter.product_info.product_series","in":"query","description":"Device product info.product series","required":false,"type":"string"},{"name":"filter.product_info.manufacturer","in":"query","description":"Device product info.manufacturer","required":false,"type":"string"},{"name":"filter.product_info.sys_object_id","in":"query","description":"Device product info.sys object id","required":false,"type":"string"},{"name":"filter.product_info.hw_change_timestamp","in":"query","description":"Device product info.hw change timestamp","required":false,"type":"string"},{"name":"filter.product_info.config_change_timestamp","in":"query","description":"Device product info.config change timestamp","required":false,"type":"string"},{"name":"filter.product_info.capability","description":"Device capability. Enum of TL1, SNMP, YANG, MDT, PDT, etc.","in":"query","required":false,"type":"array","items":{"type":"string","enum":["NONE","YANG_MDT","SCHEMA_MDT","SCHEMA_PDT","SNMP","TL1","YANG_CLI","YANG_EPNM","SNMPTRAPS","GNMI"]},"collectionFormat":"multi"},{"name":"filter.product_info.device_type","description":"Node Type. e.g. SWITCH, ROUTER..\n\n - NODE_TYPE_UNKNOWN: Not known\n - NODE_TYPE_ROUTER: Layer 3 router\n - NODE_TYPE_SWITCH: Layer 2 ethernet switch\n - NODE_TYPE_ROADM: Layer 1 optical add/drop device NCS2000\n - NODE_TYPE_AMPLIFIER: Layer 1 optical repeater/ amplifier\n - NODE_TYPE_CBR: Converged broadband router\n - NODE_TYPE_TERMINAL: Layer 1 optical add/drop device NCS1010\n - NODE_TYPE_TXP: NCS 1004 family","in":"query","required":false,"type":"string","enum":["NODE_TYPE_UNKNOWN","NODE_TYPE_ROUTER","NODE_TYPE_SWITCH","NODE_TYPE_ROADM","NODE_TYPE_AMPLIFIER","NODE_TYPE_CBR","NODE_TYPE_TERMINAL","NODE_TYPE_TXP"],"default":"NODE_TYPE_UNKNOWN"},{"name":"filter.product_info.snmp_engine_id","in":"query","description":"Device product info.snmp engine id","required":false,"type":"string"},{"name":"filter.product_info.syslog_format","description":"Syslog format on the device.","in":"query","required":false,"type":"string","enum":["RFC_INVALID","RFC_UNKNOWN","RFC_5424","RFC_3164"],"default":"RFC_INVALID"},{"name":"filter.geo_info.coordinates.longitude.value","in":"query","description":"Geo coordinates longitude value.","required":false,"type":"number","format":"double"},{"name":"filter.geo_info.coordinates.latitude.value","in":"query","description":"Geo coordinates latitude value.","required":false,"type":"number","format":"double"},{"name":"filter.geo_info.coordinates.altitude.value","in":"query","description":"Geo coordinates altitude value.","required":false,"type":"number","format":"double"},{"name":"filter.geo_info.building","in":"query","description":"Geo info building.","required":false,"type":"string"},{"name":"filter.geo_info.street","in":"query","description":"Geo info street.","required":false,"type":"string"},{"name":"filter.geo_info.city","in":"query","description":"Geo info city.","required":false,"type":"string"},{"name":"filter.geo_info.state","in":"query","description":"Geo info state.","required":false,"type":"string"},{"name":"filter.geo_info.country","in":"query","description":"Geo info country.","required":false,"type":"string"},{"name":"filter.geo_info.region","in":"query","description":"Geo info region.","required":false,"type":"string"},{"name":"filter.geo_info.zip","in":"query","description":"Geo info zip code.","required":false,"type":"string"},{"name":"filter.geo_info.range_incr.longitude.value","in":"query","description":"Geo info (searching the list of device in the Range) longitude value.","required":false,"type":"number","format":"double"},{"name":"filter.geo_info.range_incr.latitude.value","in":"query","description":"Geo info (searching the list of device in the Range) latitude value.","required":false,"type":"number","format":"double"},{"name":"filter.geo_info.range_incr.altitude.value","in":"query","description":"Geo info (searching the list of device in the Range) altitude value.","required":false,"type":"number","format":"double"},{"name":"filter.routing_info.global_isis_system_id","in":"query","description":"Routing info global isis system id.","required":false,"type":"string"},{"name":"filter.routing_info.global_ospf_router_id","in":"query","description":"Routing info global ospf router id.","required":false,"type":"string"},{"name":"filter.routing_info.router_loopback.inet_af","in":"query","description":"Routing info router loopback Inet address Family.","required":false,"type":"string","enum":["ROBOT_INET_ADDR_TYPE_NONE","ROBOT_INET_ADDR_TYPE_v4","ROBOT_INET_ADDR_TYPE_v6"],"default":"ROBOT_INET_ADDR_TYPE_NONE"},{"name":"filter.routing_info.router_loopback.inet_addr","in":"query","description":"Routing info router loopback Inet address.","required":false,"type":"string"},{"name":"filter.routing_info.router_loopback.mask","in":"query","description":"Routing info router loopback mask.","required":false,"type":"string"},{"name":"filter.routing_info.router_loopback.gateway","in":"query","description":"Routing info router loopback gateway.","required":false,"type":"string"},{"name":"filter.routing_info.mgmt_vrf","in":"query","description":"Routing info mgmtvrf.","required":false,"type":"string"},{"name":"filter.routing_info.telemetry_intf_src_name","in":"query","description":"Routing info telemetry intf src name.","required":false,"type":"string"},{"name":"filter.routing_info.telemetry_intf_src_vrf","in":"query","description":"Routing info telemetry intf src vrf.","required":false,"type":"string"},{"name":"filter.routing_info.telemetry_transport_type","in":"query","description":"Routing info telemetry transport type.","required":false,"type":"string","enum":["UNKNOWN_TRANSPORT_TYPE","TCP_DIALOUT"],"default":"UNKNOWN_TRANSPORT_TYPE"},{"name":"filter.routing_info.telemetry_device_encoding","in":"query","description":"Routing info telemetry device encoding.","required":false,"type":"string","enum":["UNKNOWN_ENCODING","GPBKV"],"default":"UNKNOWN_ENCODING"},{"name":"filter.routing_info.te_router_id","description":"Traffic engineering router id.","in":"query","required":false,"type":"string"},{"name":"filter.routing_info.ipv6_router_id","in":"query","description":"Routing info ipv6 router id.","required":false,"type":"string"},{"name":"filter.routing_info.is_opt_out_of_mdt_collection_config_enabled","description":"Skip collection of MDT configuration on a device.","in":"query","required":false,"type":"boolean"},{"name":"filter.contact","description":"Owner contact for this device.","in":"query","required":false,"type":"string"},{"name":"filter.uptime","description":"Device uptime.","in":"query","required":false,"type":"string"},{"name":"filter.last_upd_time","description":"Last time this Inventory Entry was Updated in DB.","in":"query","required":false,"type":"string","format":"int64"},{"name":"filter.reachability_check","in":"query","description":"reachability check.","required":false,"type":"string","enum":["REACH_CHECK_NONE","REACH_CHECK_DISABLE","REACH_CHECK_ENABLE"],"default":"REACH_CHECK_NONE"},{"name":"filter.reachability_state_upd_time","in":"query","description":"reachability state update time.","required":false,"type":"string","format":"int64"},{"name":"filter.operational_state","description":"Device operational state -readonly.","in":"query","required":false,"type":"string","enum":["ROBOT_OPER_STATE_UNKNOWN","ROBOT_OPER_STATE_UNMANAGED","ROBOT_OPER_STATE_ADMIN_DOWN","ROBOT_OPER_STATE_CHECKING","ROBOT_OPER_STATE_OK","ROBOT_OPER_STATE_ERROR","ROBOT_OPER_STATE_LOCKED","ROBOT_OPER_STATE_DELETING"],"default":"ROBOT_OPER_STATE_UNKNOWN"},{"name":"filter.lock_status.lock_id","in":"query","description":"device lock status lock id","required":false,"type":"string"},{"name":"filter.lock_status.state","description":" - ERRORED: Node is in error state. This would happen when LOCK\nowner does not renew or release the state within timeout","in":"query","required":false,"type":"string","enum":["INVALID_STATE","UNLOCKED","LOCKED","ERRORED"],"default":"INVALID_STATE"},{"name":"filter.lock_status.owner","in":"query","description":"device lock status owner","required":false,"type":"string"},{"name":"filter.lock_status.start_time","in":"query","description":"device lock status start time","required":false,"type":"string","format":"int64"},{"name":"filter.lock_status.end_time","in":"query","description":"device lock status end time","required":false,"type":"string","format":"int64"},{"name":"filter.errors","description":"List of errors for the node - readonly.","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"filter.Inventory.sys_desc","in":"query","description":"Inventory sys description","required":false,"type":"string"},{"name":"filter.Inventory.sys_location","in":"query","description":"Inventory sys location","required":false,"type":"string"},{"name":"filter.Inventory.architecture","in":"query","description":"Inventory architecture","required":false,"type":"string"},{"name":"filter.Inventory.cli_cache_enabled","in":"query","description":"Inventory cli cache enabled","required":false,"type":"boolean"},{"name":"filter.Inventory.created_by","in":"query","description":"Inventory created by","required":false,"type":"string"},{"name":"filter.Inventory.gnmi_preffered","in":"query","description":"Inventory gnmi preffered","required":false,"type":"boolean"},{"name":"filter.dg_uuid","description":"RobotDataGateway mapped_dg = 27;.","in":"query","required":false,"type":"string"},{"name":"filter.direct_access","description":"This attribute is only for internal use by scale testing. Not exposed via API/GUI/Swagger docs.","in":"query","required":false,"type":"string","enum":["NOT_ALLOWED","ALLOWED"],"default":"NOT_ALLOWED"},{"name":"filter.dg_name","in":"query","description":"data gateway name","required":false,"type":"string"},{"name":"filter.nso_state","in":"query","description":"NSO state","required":false,"type":"string","enum":["INVALID_NSO_OPER_STATE","ASSOCIATED","NOT_ASSOCIATED","MATCH","NO_MATCH","ONBOARD_FAIL","FETCH_SSH_KEYS_SCHEDULED","FETCH_SSH_KEYS_STARTED","FETCH_SSH_KEYS_FAILED","CONNECT_SCHEDULED","CONNECT_STARTED","CONNECT_FAILED","SYNC_FROM_SCHEDULED","SYNC_FROM_STARTED","SYNC_TO_SCHEDULED","SYNC_TO_STARTED","SYNCED","SYNC_FAILED","CHECK_SYNC_SCHEDULED","CHECK_SYNC_STARTED","NOT_SYNCED","COMPARE_CONFIG_SCHEDULED","COMPARE_CONFIG_STARTED"],"default":"INVALID_NSO_OPER_STATE"},{"name":"filter.NsoMsg","in":"query","description":"NSO message","required":false,"type":"string"},{"name":"filter.encryption","in":"query","description":"encryption","required":false,"type":"string"},{"name":"filter.nso_timestamp","in":"query","description":"NSO timestamp","required":false,"type":"string","format":"int64"},{"name":"filter.tag_names","description":"Tags names this device belongs to.","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"filter.device_fqdn.host_name","description":"host name.","in":"query","required":false,"type":"string"},{"name":"filter.device_fqdn.domain_name","description":"Domain name.","in":"query","required":false,"type":"string"},{"name":"filter.disable_static_route","in":"query","description":"static route enabled or not","required":false,"type":"boolean"},{"name":"filterData.SortBy","in":"query","description":"Sort by parameter","required":false,"type":"string"},{"name":"filterData.PageSize","in":"query","description":"Number of nodes that can retrieved per page","required":false,"type":"integer","format":"int64"},{"name":"filterData.PageNum","in":"query","description":"Page from which to retrieve nodes","required":false,"type":"integer","format":"int64"},{"name":"filterData.Descending","in":"query","description":"Descending","required":false,"type":"boolean"},{"name":"filterData.MatchCase","in":"query","description":"MatchCase","required":false,"type":"boolean"},{"name":"filterData.Criteria","in":"query","description":"Criteria to data","required":false,"type":"string"}],"tags":["NodeDb"],"__originalOperationId":"NodeDb_GetNodeCount","consumes":["application/json"],"produces":["application/json"],"security":[{"bearerAuth":[]}],"method":"get","path":"/nodes/count"}}