robotapi.RobotNodeData - Crosswork Network Controller 7.1 APIs

{"type":"model","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/b95772dc6c621d9842faced8610ee58b0cb9cb02/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":{"Inventory":{"type":"object","properties":{"Interfaces":{"type":"array","items":{"type":"object","properties":{"AdminState":{"type":"integer","enum":[0,1,2],"x-enum-varnames":["RobotNodeInterfaceStatus_Unknown","RobotNodeInterfaceStatus_Up","RobotNodeInterfaceStatus_Down"],"$$ref":"#/components/schemas/robotapi.RobotNodeInterfaceStatus"},"MAC":{"type":"string"},"Name":{"type":"string"},"OperState":{"type":"integer","enum":[0,1,2],"x-enum-varnames":["RobotNodeInterfaceStatus_Unknown","RobotNodeInterfaceStatus_Up","RobotNodeInterfaceStatus_Down"],"$$ref":"#/components/schemas/robotapi.RobotNodeInterfaceStatus"}},"$$ref":"#/components/schemas/robotapi.RobotNodeInterface"}},"architecture":{"type":"string"},"cli_cache_enabled":{"type":"boolean"},"created_by":{"type":"string"},"gnmi_preffered":{"type":"boolean"},"sys_desc":{"type":"string"},"sys_location":{"type":"string"},"tables":{"type":"object","additionalProperties":{"type":"object","properties":{"Name":{"type":"string"},"records":{"type":"array","items":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"type":"string"}}},"$$ref":"#/components/schemas/robotapi.RobotRecord"}}},"$$ref":"#/components/schemas/robotapi.RobotTable"}}},"$$ref":"#/components/schemas/robotapi.RobotNodeInventory"},"NsoMsg":{"type":"string"},"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":"Device Admin state"},"connectivity_info":{"type":"array","description":"List of Node Connections","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"}},"contact":{"type":"string","description":"Owner contact for this device"},"creation_time":{"type":"integer","description":"Device Creation time"},"device_fqdn":{"type":"object","properties":{"domain_name":{"type":"string","description":"Domain name"},"host_name":{"type":"string","description":"host name"}},"$$ref":"#/components/schemas/robotapi.FQDN","description":"Device fdqn"},"dg_name":{"type":"string"},"dg_uuid":{"type":"string","description":"RobotDataGateway mapped_dg = 27;"},"direct_access":{"type":"object","enum":[0,1],"x-enum-varnames":["DirectAccess_NOT_ALLOWED","DirectAccess_ALLOWED"],"$$ref":"#/components/schemas/robotapi.DirectAccess","description":"This attribute is only for internal use by scale testing. Not exposed via API/GUI/Swagger docs"},"disable_static_route":{"type":"boolean"},"encryption":{"type":"string"},"errors":{"type":"array","description":"List of errors for the node - readonly","items":{"type":"string"}},"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","description":"Geographical Info"},"host_name":{"type":"string","description":"Device Host name."},"inv_key_type":{"type":"object","enum":[0,1,2,3,4,5,6],"x-enum-varnames":["RobotInvKeyType_INVALID_TYPE","RobotInvKeyType_UUID","RobotInvKeyType_INVENTORY_ID","RobotInvKeyType_NODE_IP","RobotInvKeyType_SERIAL_NUMBER","RobotInvKeyType_MAC","RobotInvKeyType_HOST_NAME"],"$$ref":"#/components/schemas/robotapi.RobotInvKeyType","description":"Deprecated: Do not use."},"inventory_id":{"type":"string","description":"Custom unique device identifier"},"last_upd_time":{"type":"integer","description":"Last time this Inventory Entry was Updated in DB"},"lock_status":{"type":"object","properties":{"end_time":{"type":"integer"},"lock_id":{"type":"string"},"owner":{"type":"string"},"start_time":{"type":"integer"},"state":{"type":"integer","enum":[0,1,2,3],"x-enum-varnames":["RobotEntityLockState_INVALID_STATE","RobotEntityLockState_UNLOCKED","RobotEntityLockState_LOCKED","RobotEntityLockState_ERRORED"],"$$ref":"#/components/schemas/robotapi.RobotEntityLockState"}},"$$ref":"#/components/schemas/robotapi.RobotNodeLockStatus"},"mac":{"type":"string","description":"Chassis backplane Mac address."},"ned_id":{"type":"string","description":"Ned id required for RAK"},"node_ip":{"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"},"nso_service_state":{"type":"object","additionalProperties":{"type":"integer","enum":[0,1,2,3,4,5,6,7,8,9,10],"x-enum-varnames":["NsoServiceState_INVALID_NSO_SERVICE_STATE","NsoServiceState_REQUIRED","NsoServiceState_NOT_REQUIRED","NsoServiceState_SCHEDULED","NsoServiceState_DEPLOYING","NsoServiceState_DEPLOYED","NsoServiceState_DEPLOY_ERROR","NsoServiceState_CLEANUP_REQUIRED","NsoServiceState_CLEANUP_SCHEDULED","NsoServiceState_CLEANING","NsoServiceState_CLEAN_ERROR"],"$$ref":"#/components/schemas/robotapi.NsoServiceState"}},"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"},"nso_timestamp":{"type":"integer"},"operational_state":{"type":"object","enum":[0,1,2,3,4,5,6,7],"x-enum-varnames":["RobotNodeOperationalState_ROBOT_OPER_STATE_UNKNOWN","RobotNodeOperationalState_ROBOT_OPER_STATE_UNMANAGED","RobotNodeOperationalState_ROBOT_OPER_STATE_ADMIN_DOWN","RobotNodeOperationalState_ROBOT_OPER_STATE_CHECKING","RobotNodeOperationalState_ROBOT_OPER_STATE_OK","RobotNodeOperationalState_ROBOT_OPER_STATE_ERROR","RobotNodeOperationalState_ROBOT_OPER_STATE_LOCKED","RobotNodeOperationalState_ROBOT_OPER_STATE_DELETING"],"$$ref":"#/components/schemas/robotapi.RobotNodeOperationalState","description":"Device operational state -readonly"},"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","description":"Node Product Info"},"profile":{"type":"string","description":"MUST FIELD.\nCredential Profile applicable to this device."},"provider":{"type":"object","additionalProperties":{"type":"object","properties":{"provider":{"type":"object","properties":{"certificate_name":{"type":"string","description":"provider ceretificate name"},"cfs":{"type":"boolean","description":"Is CFS node"},"connectivity_info":{"type":"array","description":"All supported transports allowed to connect to this provider.","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"}},"family":{"type":"object","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12],"x-enum-comments":{"RobotProviderFamily_ROBOT_PROVIDER_ONC":"Deprecated: Do not use.","RobotProviderFamily_ROBOT_PROVIDER_XTC":"Deprecated: Do not use."},"x-enum-varnames":["RobotProviderFamily_ROBOT_PROVIDER_UNKNOWN","RobotProviderFamily_ROBOT_PROVIDER_EPNM","RobotProviderFamily_ROBOT_PROVIDER_NSO","RobotProviderFamily_ROBOT_PROVIDER_WAE","RobotProviderFamily_ROBOT_PROVIDER_CSM","RobotProviderFamily_ROBOT_PROVIDER_XTC","RobotProviderFamily_ROBOT_PROVIDER_SYSLOG_STORAGE","RobotProviderFamily_ROBOT_PROVIDER_SR_PCE","RobotProviderFamily_ROBOT_PROVIDER_ALERT","RobotProviderFamily_ROBOT_PROVIDER_DESTINATION","RobotProviderFamily_ROBOT_PROVIDER_OPTIMA","RobotProviderFamily_ROBOT_PROVIDER_PROXY","RobotProviderFamily_ROBOT_PROVIDER_ONC","RobotProviderFamily_ROBOT_PROVIDER_ACCEDIAN_PROXY"],"$$ref":"#/components/schemas/robotapi.RobotProviderFamily","description":"Provider Family. Not supoorted YET."},"last_reach_time":{"type":"integer","description":"Last time this provider was determined to be reachable.\nUnix time in seconds."},"last_upd_time":{"type":"integer","description":"Last time this Provider Entry was Updated in DB.\nUnix time in seconds."},"lock_state":{"type":"object","enum":[0,1,2,3],"x-enum-varnames":["RobotEntityLockState_INVALID_STATE","RobotEntityLockState_UNLOCKED","RobotEntityLockState_LOCKED","RobotEntityLockState_ERRORED"],"$$ref":"#/components/schemas/robotapi.RobotEntityLockState","description":"Deprecated: Do not use."},"name":{"type":"string","description":"User-defined key, mandatory field."},"profile":{"type":"string","description":"Credential Profile applicable to this provider. Mandatory field."},"properties":{"type":"object","additionalProperties":{"type":"string"},"description":"map to configure provider specific properties as key, value pairs"},"provider_device_key":{"type":"object","enum":[0,1,2,3],"x-enum-comments":{"RobotProviderDeviceKey_ROBOT_PROVDEVKEY_NODE_IP":"Deprecated: Do not use."},"x-enum-varnames":["RobotProviderDeviceKey_ROBOT_PROVDEVKEY_NONE","RobotProviderDeviceKey_ROBOT_PROVDEVKEY_HOST_NAME","RobotProviderDeviceKey_ROBOT_PROVDEVKEY_NODE_IP","RobotProviderDeviceKey_ROBOT_PROVDEVKEY_INVENTORY_ID"],"$$ref":"#/components/schemas/robotapi.RobotProviderDeviceKey","description":"Deprecated: Do not use."},"reachability_state":{"type":"integer","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"},"sitelocation":{"type":"string","description":"active NSO site location, discovered/read-only parameter applicable only in geo deployments"},"supported_models":{"type":"array","description":"provider models","items":{"type":"object","properties":{"model_prefix":{"type":"string","description":"Yang model prefix e.g. Cisco-IOS-XR, Cisco-NX-OS, Cisco-IOS-XE"},"model_version":{"type":"string","description":"Yang model version"}},"$$ref":"#/components/schemas/robotapi.SupportedModels"}},"type":{"type":"object","enum":[0,1,2,3,4,5,6],"x-enum-varnames":["RobotProviderType_ROBOT_PROVIDER_NONE","RobotProviderType_ROBOT_PROVIDER_CFG_LOCAL","RobotProviderType_ROBOT_PROVIDER_CFG_GLOBAL","RobotProviderType_ROBOT_PROVIDER_INSTALL","RobotProviderType_ROBOT_PROVIDER_COMPUTE","RobotProviderType_ROBOT_PROVIDER_CFG_DIRECT","RobotProviderType_ROBOT_PROVIDER_INSTALL_DIRECT"],"$$ref":"#/components/schemas/robotapi.RobotProviderType","description":"Deprecated: Do not use."},"uuid":{"type":"string","description":"Internal key, mandatory field. Allocated internally on provider\ncreation. UUID is a generated value based on the name"}},"$$ref":"#/components/schemas/robotapi.RobotProviderData"},"provider_name":{"type":"string"},"provider_node_id":{"type":"string"},"provider_params":{"type":"object","additionalProperties":{"type":"string"}}},"$$ref":"#/components/schemas/robotapi.RobotNodeCustomProvider"},"description":"List of providers - one per type strictly"},"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_check":{"type":"integer","enum":[0,1,2],"x-enum-varnames":["RobotReachCheck_REACH_CHECK_NONE","RobotReachCheck_REACH_CHECK_DISABLE","RobotReachCheck_REACH_CHECK_ENABLE"],"$$ref":"#/components/schemas/robotapi.RobotReachCheck"},"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 state"},"reachability_state_upd_time":{"type":"integer"},"routing_info":{"type":"object","properties":{"global_isis_system_id":{"type":"string"},"global_ospf_router_id":{"type":"string"},"ipv6_router_id":{"type":"string"},"is_opt_out_of_mdt_collection_config_enabled":{"type":"boolean","description":"Skip collection of MDT configuration on a device."},"mgmt_intf_ip":{"type":"array","description":"Deprecated: Do not use.","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"}},"mgmt_vrf":{"type":"string","description":"Deprecated: Do not use."},"router_loopback":{"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","description":"Deprecated: Do not use."},"te_router_id":{"type":"string","description":"Traffic engineering router id"},"telemetry_device_encoding":{"type":"integer","enum":[0,1],"x-enum-varnames":["TelemetryDeviceEncoding_UNKNOWN_ENCODING","TelemetryDeviceEncoding_GPBKV"],"$$ref":"#/components/schemas/robotapi.TelemetryDeviceEncoding"},"telemetry_intf_src_name":{"type":"string"},"telemetry_intf_src_vrf":{"type":"string"},"telemetry_transport_type":{"type":"integer","enum":[0,1],"x-enum-varnames":["TelemetryTransportType_UNKNOWN_TRANSPORT_TYPE","TelemetryTransportType_TCP_DIALOUT"],"$$ref":"#/components/schemas/robotapi.TelemetryTransportType"}},"$$ref":"#/components/schemas/robotapi.RobotRoutinginfo","description":"Routing info and Management Ip info"},"serial_number":{"type":"string","description":"Device Serial Number."},"state_map":{"type":"object","additionalProperties":{"type":"object","properties":{"element":{"type":"integer","enum":[0,1,2,3,4,5],"x-enum-varnames":["RobotNodeStateElement_UNSUPPORTED","RobotNodeStateElement_REACHABILITY","RobotNodeStateElement_DISCOVERY","RobotNodeStateElement_CLOCK_DRIFT","RobotNodeStateElement_LOCK","RobotNodeStateElement_SYNC"],"$$ref":"#/components/schemas/robotapi.RobotNodeStateElement"},"info":{"type":"string"},"last_updated_time":{"type":"integer"},"next_check_time":{"type":"integer"},"value":{"type":"integer","enum":[0,1,2,3,4,5],"x-enum-varnames":["State_UNKNOWN","State_UP","State_DOWN","State_DEGRADE","State_ERROR","State_DISABLE"],"$$ref":"#/components/schemas/robotapi.State"}},"$$ref":"#/components/schemas/robotapi.CurrentState"}},"tag_names":{"type":"array","description":"Tags names this device belongs to","items":{"type":"string"}},"tags":{"type":"array","description":"Tags this device belongs to","items":{"type":"object","properties":{"category":{"type":"string"},"created_by":{"type":"string"},"creation_time":{"type":"integer"},"devices_tagged":{"type":"integer"},"name":{"type":"string"},"tag_type":{"type":"object","enum":[0,1,2,3],"x-enum-varnames":["RobotTagType_TAG_TYPE_UNKNOWN","RobotTagType_TAG_TYPE_SYSTEM","RobotTagType_TAG_TYPE_USER_DEFINED","RobotTagType_TAG_TYPE_INTERNAL"],"$$ref":"#/components/schemas/robotapi.RobotTagType","description":"TagType is a readonly property with values system, user-defined, or internal."}},"$$ref":"#/components/schemas/robotapi.RobotNodeTag"}},"uptime":{"type":"string","description":"Device uptime"},"uuid":{"type":"string","description":"Uuid is randomly generated by crossworks, readonly"}},"$$ref":"#/components/schemas/robotapi.RobotNodeData","title":"robotapi.RobotNodeData"}}