diff --git "a/base_tools.yaml" "b/base_tools.yaml" new file mode 100644--- /dev/null +++ "b/base_tools.yaml" @@ -0,0 +1,83477 @@ +- type: function + function: + name: get_bgp_flap_rate + description: The rate at which a BGP session is established and terminated. + parameters: + type: object + properties: + device: + type: array + items: + type: string + description: A network device such as a router or switch. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + remote_site: + type: array + items: + type: string + description: A remote location or network site, often used in network management + or monitoring. + remote_device: + type: array + items: + type: string + description: A network device located at a remote site or location. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + bgp_local_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of the local BGP router. + remote_if_name: + type: array + items: + type: string + description: The name of a remote interface on a network device. + bgp_remote_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of a remote BGP router. + bgp_remote_address: + type: array + items: + type: string + description: The IP address of a remote BGP router. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + version: + type: array + items: + type: string + description: The software version of a network device or application. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + bgp_remote_port: + type: array + items: + type: string + description: The TCP port used for BGP communication with a remote router. + bgp_local_address: + type: array + items: + type: string + description: The IP address of the local BGP router. + bgp_description: + type: array + items: + type: string + description: A description of a BGP session or configuration. + bgp_tags: + type: array + items: + type: string + description: Metadata or keywords associated with a BGP session or configuration. + os: + type: array + items: + type: string + description: The operating system running on a network device. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_bgp_flap_rate_device_status_by_kpi + description: Monitors the rate of BGP route flaps on devices, categorized by key + performance indicators. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + bgp_remote_port: + type: array + items: + type: string + description: The TCP port used for BGP communication with a remote router. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + bgp_remote_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of a remote BGP router. + bgp_local_address: + type: array + items: + type: string + description: The IP address of the local BGP router. + bgp_local_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of the local BGP router. + bgp_tags: + type: array + items: + type: string + description: Metadata or keywords associated with a BGP session or configuration. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + remote_device: + type: array + items: + type: string + description: A network device located at a remote site or location. + remote_if_name: + type: array + items: + type: string + description: The name of a remote interface on a network device. + bgp_description: + type: array + items: + type: string + description: A description of a BGP session or configuration. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + bgp_remote_address: + type: array + items: + type: string + description: The IP address of a remote BGP router. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_bgp_peer_admin + description: Represents the administrative status of a BGP peer in the network + configuration. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + bgp_remote_port: + type: array + items: + type: string + description: The TCP port used for BGP communication with a remote router. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + remote_site: + type: array + items: + type: string + description: A remote location or network site, often used in network management + or monitoring. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + bgp_remote_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of a remote BGP router. + bgp_local_address: + type: array + items: + type: string + description: The IP address of the local BGP router. + bgp_local_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of the local BGP router. + bgp_tags: + type: array + items: + type: string + description: Metadata or keywords associated with a BGP session or configuration. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + remote_device: + type: array + items: + type: string + description: A network device located at a remote site or location. + remote_if_name: + type: array + items: + type: string + description: The name of a remote interface on a network device. + bgp_description: + type: array + items: + type: string + description: A description of a BGP session or configuration. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + bgp_remote_address: + type: array + items: + type: string + description: The IP address of a remote BGP router. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_bgp_peer_admin_status_raw + description: Represents the raw administrative status of a BGP peer in the network. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + bgp_remote_port: + type: array + items: + type: string + description: The TCP port used for BGP communication with a remote router. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + remote_site: + type: array + items: + type: string + description: A remote location or network site, often used in network management + or monitoring. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + bgp_remote_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of a remote BGP router. + bgp_local_address: + type: array + items: + type: string + description: The IP address of the local BGP router. + bgp_local_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of the local BGP router. + bgp_tags: + type: array + items: + type: string + description: Metadata or keywords associated with a BGP session or configuration. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + remote_device: + type: array + items: + type: string + description: A network device located at a remote site or location. + remote_if_name: + type: array + items: + type: string + description: The name of a remote interface on a network device. + bgp_description: + type: array + items: + type: string + description: A description of a BGP session or configuration. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + bgp_remote_address: + type: array + items: + type: string + description: The IP address of a remote BGP router. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_bgp_peer_downtime + description: Measures the duration of downtime experienced by a BGP peer in the + network. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + bgp_remote_port: + type: array + items: + type: string + description: The TCP port used for BGP communication with a remote router. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + remote_site: + type: array + items: + type: string + description: A remote location or network site, often used in network management + or monitoring. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + bgp_remote_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of a remote BGP router. + bgp_local_address: + type: array + items: + type: string + description: The IP address of the local BGP router. + bgp_local_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of the local BGP router. + bgp_tags: + type: array + items: + type: string + description: Metadata or keywords associated with a BGP session or configuration. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + remote_device: + type: array + items: + type: string + description: A network device located at a remote site or location. + remote_if_name: + type: array + items: + type: string + description: The name of a remote interface on a network device. + bgp_description: + type: array + items: + type: string + description: A description of a BGP session or configuration. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + bgp_remote_address: + type: array + items: + type: string + description: The IP address of a remote BGP router. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_bgp_peer_fsm_established_time_raw + description: Represents the raw time duration a BGP peer has been in the established + state. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + bgp_remote_port: + type: array + items: + type: string + description: The TCP port used for BGP communication with a remote router. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + remote_site: + type: array + items: + type: string + description: A remote location or network site, often used in network management + or monitoring. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + bgp_remote_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of a remote BGP router. + bgp_local_address: + type: array + items: + type: string + description: The IP address of the local BGP router. + bgp_local_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of the local BGP router. + bgp_tags: + type: array + items: + type: string + description: Metadata or keywords associated with a BGP session or configuration. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + remote_device: + type: array + items: + type: string + description: A network device located at a remote site or location. + remote_if_name: + type: array + items: + type: string + description: The name of a remote interface on a network device. + bgp_description: + type: array + items: + type: string + description: A description of a BGP session or configuration. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + bgp_remote_address: + type: array + items: + type: string + description: The IP address of a remote BGP router. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_bgp_peer_in_updates_raw + description: Counts the raw number of BGP update messages received from a peer. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + bgp_remote_port: + type: array + items: + type: string + description: The TCP port used for BGP communication with a remote router. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + remote_site: + type: array + items: + type: string + description: A remote location or network site, often used in network management + or monitoring. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + bgp_remote_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of a remote BGP router. + bgp_local_address: + type: array + items: + type: string + description: The IP address of the local BGP router. + bgp_local_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of the local BGP router. + bgp_tags: + type: array + items: + type: string + description: Metadata or keywords associated with a BGP session or configuration. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + remote_device: + type: array + items: + type: string + description: A network device located at a remote site or location. + remote_if_name: + type: array + items: + type: string + description: The name of a remote interface on a network device. + bgp_description: + type: array + items: + type: string + description: A description of a BGP session or configuration. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + bgp_remote_address: + type: array + items: + type: string + description: The IP address of a remote BGP router. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_bgp_peer_out_updates_raw + description: Represents the raw count of update messages sent to BGP peers. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + bgp_remote_port: + type: array + items: + type: string + description: The TCP port used for BGP communication with a remote router. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + remote_site: + type: array + items: + type: string + description: A remote location or network site, often used in network management + or monitoring. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + bgp_remote_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of a remote BGP router. + bgp_local_address: + type: array + items: + type: string + description: The IP address of the local BGP router. + bgp_local_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of the local BGP router. + bgp_tags: + type: array + items: + type: string + description: Metadata or keywords associated with a BGP session or configuration. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + remote_device: + type: array + items: + type: string + description: A network device located at a remote site or location. + remote_if_name: + type: array + items: + type: string + description: The name of a remote interface on a network device. + bgp_description: + type: array + items: + type: string + description: A description of a BGP session or configuration. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + bgp_remote_address: + type: array + items: + type: string + description: The IP address of a remote BGP router. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_bgp_peer_state + description: Represents the current state of a BGP peer connection in the network. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + bgp_remote_port: + type: array + items: + type: string + description: The TCP port used for BGP communication with a remote router. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + remote_site: + type: array + items: + type: string + description: A remote location or network site, often used in network management + or monitoring. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + bgp_remote_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of a remote BGP router. + bgp_local_address: + type: array + items: + type: string + description: The IP address of the local BGP router. + bgp_local_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of the local BGP router. + bgp_tags: + type: array + items: + type: string + description: Metadata or keywords associated with a BGP session or configuration. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + remote_device: + type: array + items: + type: string + description: A network device located at a remote site or location. + remote_if_name: + type: array + items: + type: string + description: The name of a remote interface on a network device. + bgp_description: + type: array + items: + type: string + description: A description of a BGP session or configuration. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + bgp_remote_address: + type: array + items: + type: string + description: The IP address of a remote BGP router. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_bgp_peer_state_device_status_by_kpi + description: Monitors the status of BGP peer devices based on key performance + indicators (KPIs). + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + bgp_remote_port: + type: array + items: + type: string + description: The TCP port used for BGP communication with a remote router. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + bgp_remote_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of a remote BGP router. + bgp_local_address: + type: array + items: + type: string + description: The IP address of the local BGP router. + bgp_local_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of the local BGP router. + bgp_tags: + type: array + items: + type: string + description: Metadata or keywords associated with a BGP session or configuration. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + remote_device: + type: array + items: + type: string + description: A network device located at a remote site or location. + remote_if_name: + type: array + items: + type: string + description: The name of a remote interface on a network device. + bgp_description: + type: array + items: + type: string + description: A description of a BGP session or configuration. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + bgp_remote_address: + type: array + items: + type: string + description: The IP address of a remote BGP router. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_bgp_peer_state_raw + description: Represents the raw state information of BGP peers in the network. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + bgp_remote_port: + type: array + items: + type: string + description: The TCP port used for BGP communication with a remote router. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + remote_site: + type: array + items: + type: string + description: A remote location or network site, often used in network management + or monitoring. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + bgp_remote_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of a remote BGP router. + bgp_local_address: + type: array + items: + type: string + description: The IP address of the local BGP router. + bgp_local_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of the local BGP router. + bgp_tags: + type: array + items: + type: string + description: Metadata or keywords associated with a BGP session or configuration. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + remote_device: + type: array + items: + type: string + description: A network device located at a remote site or location. + remote_if_name: + type: array + items: + type: string + description: The name of a remote interface on a network device. + bgp_description: + type: array + items: + type: string + description: A description of a BGP session or configuration. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + bgp_remote_address: + type: array + items: + type: string + description: The IP address of a remote BGP router. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_bgp_peer_status_by_kpi + description: Evaluates the status of BGP peers based on key performance indicators. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + bgp_remote_port: + type: array + items: + type: string + description: The TCP port used for BGP communication with a remote router. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + bgp_remote_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of a remote BGP router. + bgp_local_address: + type: array + items: + type: string + description: The IP address of the local BGP router. + bgp_local_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of the local BGP router. + bgp_tags: + type: array + items: + type: string + description: Metadata or keywords associated with a BGP session or configuration. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + remote_device: + type: array + items: + type: string + description: A network device located at a remote site or location. + remote_if_name: + type: array + items: + type: string + description: The name of a remote interface on a network device. + bgp_description: + type: array + items: + type: string + description: A description of a BGP session or configuration. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + bgp_remote_address: + type: array + items: + type: string + description: The IP address of a remote BGP router. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_bgp_peer_uptime + description: Measures the duration of time a BGP peer has been continuously connected + and operational. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + bgp_remote_port: + type: array + items: + type: string + description: The TCP port used for BGP communication with a remote router. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + remote_site: + type: array + items: + type: string + description: A remote location or network site, often used in network management + or monitoring. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + bgp_remote_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of a remote BGP router. + bgp_local_address: + type: array + items: + type: string + description: The IP address of the local BGP router. + bgp_local_as: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of the local BGP router. + bgp_tags: + type: array + items: + type: string + description: Metadata or keywords associated with a BGP session or configuration. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + remote_device: + type: array + items: + type: string + description: A network device located at a remote site or location. + remote_if_name: + type: array + items: + type: string + description: The name of a remote interface on a network device. + bgp_description: + type: array + items: + type: string + description: A description of a BGP session or configuration. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + bgp_remote_address: + type: array + items: + type: string + description: The IP address of a remote BGP router. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_site_bgp_status + description: Represents the operational status of BGP at a specific network site. + parameters: + type: object + properties: + device: + type: array + items: + type: string + description: A network device such as a router or switch. + remote_site: + type: array + items: + type: string + description: A remote location or network site, often used in network management + or monitoring. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min +- type: function + function: + name: get_avg_price + description: Average price of a stock over a specified period. + parameters: + type: object + properties: + ticker: + type: array + items: + type: string + description: Unique symbol representing a stock on a stock exchange. + stock_exchange: + type: array + items: + type: string + description: Platform where stocks are bought and sold. + sector: + type: array + items: + type: string + description: Category of companies within the stock market. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_price + description: Represents the cost or value of a product or service in monetary + terms. + parameters: + type: object + properties: + stock_exchange: + type: array + items: + type: string + description: Platform where stocks are bought and sold. + sector: + type: array + items: + type: string + description: Category of companies within the stock market. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + ticker: + type: array + items: + type: string + description: Unique symbol representing a stock on a stock exchange. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_cadvisor_container_cpu_usage + description: Monitors CPU usage of containers for resource optimization. + parameters: + type: object + properties: + container: + type: array + items: + type: string + description: Represents a container in a Kubernetes cluster, encapsulating + an application. + pod: + type: array + items: + type: string + description: A logical unit in Kubernetes that groups one or more containers. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_cadvisor_container_memory_working_set_bytes + description: Measures the memory usage of a container, excluding cache and swap, + in bytes. + parameters: + type: object + properties: + container: + type: array + items: + type: string + description: Represents a container in a Kubernetes cluster, encapsulating + an application. + pod: + type: array + items: + type: string + description: A logical unit in Kubernetes that groups one or more containers. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_cadvisor_inst_status + description: Monitors the status and performance of cAdvisor instances for container + resource usage. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_cadvisor_pod_cpu_usage + description: Measures the CPU usage of a pod using cAdvisor for performance monitoring. + parameters: + type: object + properties: + pod: + type: array + items: + type: string + description: A logical unit in Kubernetes that groups one or more containers. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_cadvisor_pod_memory_working_set_bytes + description: Measures the memory usage of a pod, excluding cache and swap, in + bytes. + parameters: + type: object + properties: + pod: + type: array + items: + type: string + description: A logical unit in Kubernetes that groups one or more containers. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_cadvisor_pod_network_err + description: Tracks network errors encountered by a pod as monitored by cAdvisor. + parameters: + type: object + properties: + pod: + type: array + items: + type: string + description: A logical unit in Kubernetes that groups one or more containers. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_cadvisor_pod_oom_event + description: Tracks events where a pod is terminated due to an out-of-memory (OOM) + condition. + parameters: + type: object + properties: + pod: + type: array + items: + type: string + description: A logical unit in Kubernetes that groups one or more containers. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_cadvisor_pod_start_time_in_min + description: Represents the start time of a cAdvisor-monitored pod in minutes + since epoch. + parameters: + type: object + properties: + pod: + type: array + items: + type: string + description: A logical unit in Kubernetes that groups one or more containers. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_cadvisor_pod_status + description: Monitors the status and resource usage of pods using cAdvisor in + a Kubernetes environment. + parameters: + type: object + properties: + pod: + type: array + items: + type: string + description: A logical unit in Kubernetes that groups one or more containers. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_container_cpu_load_average_10s + description: Represents the average CPU load of a container over the last 10 seconds. + parameters: + type: object + properties: + container: + type: array + items: + type: string + description: Represents a container in a Kubernetes cluster, encapsulating + an application. + pod: + type: array + items: + type: string + description: A logical unit in Kubernetes that groups one or more containers. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_container_fs_reads_bytes_total_rate + description: Measures the rate of bytes read from the filesystem by a container + over time. + parameters: + type: object + properties: + container: + type: array + items: + type: string + description: Represents a container in a Kubernetes cluster, encapsulating + an application. + pod: + type: array + items: + type: string + description: A logical unit in Kubernetes that groups one or more containers. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_container_fs_usage_bytes + description: Represents the amount of filesystem space used by a container in + bytes. + parameters: + type: object + properties: + device: + type: array + items: + type: string + description: A network device such as a router or switch. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_container_fs_writes_bytes_total_rate + description: Measures the rate of bytes written to the filesystem by a container + over time. + parameters: + type: object + properties: + container: + type: array + items: + type: string + description: Represents a container in a Kubernetes cluster, encapsulating + an application. + pod: + type: array + items: + type: string + description: A logical unit in Kubernetes that groups one or more containers. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_container_memory_cache + description: Represents the amount of memory cache used by a container in the + system. + parameters: + type: object + properties: + container: + type: array + items: + type: string + description: Represents a container in a Kubernetes cluster, encapsulating + an application. + pod: + type: array + items: + type: string + description: A logical unit in Kubernetes that groups one or more containers. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_container_memory_failcnt + description: Counts the number of times a containers memory allocation has failed. + parameters: + type: object + properties: + container: + type: array + items: + type: string + description: Represents a container in a Kubernetes cluster, encapsulating + an application. + pod: + type: array + items: + type: string + description: A logical unit in Kubernetes that groups one or more containers. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_container_memory_max_usage_bytes + description: Represents the maximum memory usage in bytes for a container over + its lifetime. + parameters: + type: object + properties: + container: + type: array + items: + type: string + description: Represents a container in a Kubernetes cluster, encapsulating + an application. + pod: + type: array + items: + type: string + description: A logical unit in Kubernetes that groups one or more containers. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_container_memory_usage_bytes + description: Represents the amount of memory in bytes used by a container in the + system. + parameters: + type: object + properties: + container: + type: array + items: + type: string + description: Represents a container in a Kubernetes cluster, encapsulating + an application. + pod: + type: array + items: + type: string + description: A logical unit in Kubernetes that groups one or more containers. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_container_network_receive_bytes_total_rate + description: Measures the rate of bytes received by a containers network interface + over time. + parameters: + type: object + properties: + pod: + type: array + items: + type: string + description: A logical unit in Kubernetes that groups one or more containers. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_container_network_receive_errors_total + description: Total number of errors encountered while receiving data on the containers + network interface. + parameters: + type: object + properties: + pod: + type: array + items: + type: string + description: A logical unit in Kubernetes that groups one or more containers. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_container_network_transmit_bytes_total_rate + description: Measures the rate of bytes transmitted over the network by a container. + parameters: + type: object + properties: + pod: + type: array + items: + type: string + description: A logical unit in Kubernetes that groups one or more containers. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_container_network_transmit_errors_total + description: Total number of errors encountered during network data transmission + from a container. + parameters: + type: object + properties: + pod: + type: array + items: + type: string + description: A logical unit in Kubernetes that groups one or more containers. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_bad_blob_request + description: A metric that tracks the number of bad blob requests in the engine2 + cloud storage. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_bgp_inet_snapshots + description: Captures snapshots of BGP internet routes stored in cloud storage + for analysis. + parameters: + type: object + properties: + blob: + type: array + items: + type: string + description: A large binary object stored in a database or file system, + often unstructured data. + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_bgp_inet_snapshots_rate + description: Measures the rate of BGP internet snapshots taken in the cloud storage + engine. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + blob: + type: array + items: + type: string + description: A large binary object stored in a database or file system, + often unstructured data. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_bgp_inet_updates + description: Tracks the number of BGP internet updates received by the cloud storage + engine. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + blob: + type: array + items: + type: string + description: A large binary object stored in a database or file system, + often unstructured data. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_bgp_inet_updates_rate + description: Measures the rate of BGP internet updates received by the cloud storage + engine. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + blob: + type: array + items: + type: string + description: A large binary object stored in a database or file system, + often unstructured data. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_bgp_l3vpn_snapshots + description: Captures snapshots of BGP Layer 3 VPN configurations in cloud storage + for analysis. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + blob: + type: array + items: + type: string + description: A large binary object stored in a database or file system, + often unstructured data. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_bgp_l3vpn_snapshots_rate + description: Measures the rate of BGP L3VPN snapshots in cloud storage for network + performance analysis. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + blob: + type: array + items: + type: string + description: A large binary object stored in a database or file system, + often unstructured data. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_bgp_l3vpn_updates + description: Tracks updates for BGP Layer 3 VPNs in cloud storage environments. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + blob: + type: array + items: + type: string + description: A large binary object stored in a database or file system, + often unstructured data. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_bgp_l3vpn_updates_rate + description: Measures the rate of BGP L3VPN updates in the cloud storage engine. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + blob: + type: array + items: + type: string + description: A large binary object stored in a database or file system, + often unstructured data. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_bgp_snapshot_route_processed + description: Tracks the number of BGP snapshot routes processed in cloud storage + by Engine2. + parameters: + type: object + properties: + filetimestamp: + type: array + items: + type: string + description: Records the timestamp of when a specific file was created or + last modified. + afisafi: + type: array + items: + type: string + description: Represents Address Family Identifier (AFI) and Subsequent Address + Family Identifier (SAFI) in networking. + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_bgp_snapshot_route_send_failed + description: Indicates a failure in sending BGP snapshot routes to cloud storage + in engine2. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + afisafi: + type: array + items: + type: string + description: Represents Address Family Identifier (AFI) and Subsequent Address + Family Identifier (SAFI) in networking. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + filetimestamp: + type: array + items: + type: string + description: Records the timestamp of when a specific file was created or + last modified. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_bgp_snapshot_route_send_success + description: Indicates successful transmission of BGP snapshot routes to cloud + storage by Engine2. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + afisafi: + type: array + items: + type: string + description: Represents Address Family Identifier (AFI) and Subsequent Address + Family Identifier (SAFI) in networking. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + filetimestamp: + type: array + items: + type: string + description: Records the timestamp of when a specific file was created or + last modified. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_bgp_snapshot_total_route_send_success + description: Counts successful BGP route snapshot transmissions to cloud storage + by Engine2. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + afisafi: + type: array + items: + type: string + description: Represents Address Family Identifier (AFI) and Subsequent Address + Family Identifier (SAFI) in networking. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + filetimestamp: + type: array + items: + type: string + description: Records the timestamp of when a specific file was created or + last modified. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_bgp_update_processed + description: Tracks the number of BGP updates processed by the cloud storage engine. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + afisafi: + type: array + items: + type: string + description: Represents Address Family Identifier (AFI) and Subsequent Address + Family Identifier (SAFI) in networking. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + filetimestamp: + type: array + items: + type: string + description: Records the timestamp of when a specific file was created or + last modified. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_bgp_update_route_send_failed + description: Indicates a failure in sending BGP update routes from cloud storage + in engine2. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + afisafi: + type: array + items: + type: string + description: Represents Address Family Identifier (AFI) and Subsequent Address + Family Identifier (SAFI) in networking. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + filetimestamp: + type: array + items: + type: string + description: Records the timestamp of when a specific file was created or + last modified. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_bgp_update_route_send_success + description: Tracks successful BGP route update transmissions to cloud storage + from engine2. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + afisafi: + type: array + items: + type: string + description: Represents Address Family Identifier (AFI) and Subsequent Address + Family Identifier (SAFI) in networking. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + filetimestamp: + type: array + items: + type: string + description: Records the timestamp of when a specific file was created or + last modified. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_bgp_update_total_route_send_success + description: Tracks the total number of successful BGP route updates sent by the + cloud storage engine. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + afisafi: + type: array + items: + type: string + description: Represents Address Family Identifier (AFI) and Subsequent Address + Family Identifier (SAFI) in networking. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + filetimestamp: + type: array + items: + type: string + description: Records the timestamp of when a specific file was created or + last modified. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_blob + description: Represents a storage object in cloud storage managed by the Engine2 + system. + parameters: + type: object + properties: + network: + type: array + items: + type: string + description: Refers to the interconnected system of computers and devices + for data communication. + folder: + type: array + items: + type: string + description: A directory used to organize files and other folders in a hierarchical + structure. + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + container: + type: array + items: + type: string + description: Represents a container in a Kubernetes cluster, encapsulating + an application. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + blob: + type: array + items: + type: string + description: A large binary object stored in a database or file system, + often unstructured data. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_blob_download_err + description: Tracks errors encountered during the download of blobs from cloud + storage in engine2. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + container: + type: array + items: + type: string + description: Represents a container in a Kubernetes cluster, encapsulating + an application. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + blob: + type: array + items: + type: string + description: A large binary object stored in a database or file system, + often unstructured data. + network: + type: array + items: + type: string + description: Refers to the interconnected system of computers and devices + for data communication. + folder: + type: array + items: + type: string + description: A directory used to organize files and other folders in a hierarchical + structure. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_blob_download_error + description: Tracks errors encountered during the download of blobs from cloud + storage in Engine2. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + container: + type: array + items: + type: string + description: Represents a container in a Kubernetes cluster, encapsulating + an application. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + blob: + type: array + items: + type: string + description: A large binary object stored in a database or file system, + often unstructured data. + network: + type: array + items: + type: string + description: Refers to the interconnected system of computers and devices + for data communication. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + folder: + type: array + items: + type: string + description: A directory used to organize files and other folders in a hierarchical + structure. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_blob_process_err + description: Tracks errors encountered during the processing of cloud storage + blobs in the engine2 system. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + container: + type: array + items: + type: string + description: Represents a container in a Kubernetes cluster, encapsulating + an application. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + blob: + type: array + items: + type: string + description: A large binary object stored in a database or file system, + often unstructured data. + network: + type: array + items: + type: string + description: Refers to the interconnected system of computers and devices + for data communication. + folder: + type: array + items: + type: string + description: A directory used to organize files and other folders in a hierarchical + structure. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_blob_process_error + description: Indicates an error occurred during the processing of a cloud storage + blob in Engine2. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + container: + type: array + items: + type: string + description: Represents a container in a Kubernetes cluster, encapsulating + an application. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + blob: + type: array + items: + type: string + description: A large binary object stored in a database or file system, + often unstructured data. + network: + type: array + items: + type: string + description: Refers to the interconnected system of computers and devices + for data communication. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + folder: + type: array + items: + type: string + description: A directory used to organize files and other folders in a hierarchical + structure. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_blob_processing + description: Monitors the processing and management of blobs in cloud storage + by Engine2. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + container: + type: array + items: + type: string + description: Represents a container in a Kubernetes cluster, encapsulating + an application. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + blob: + type: array + items: + type: string + description: A large binary object stored in a database or file system, + often unstructured data. + network: + type: array + items: + type: string + description: Refers to the interconnected system of computers and devices + for data communication. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + folder: + type: array + items: + type: string + description: A directory used to organize files and other folders in a hierarchical + structure. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_blob_report_sent_cnt + description: Counts the number of blob reports sent to cloud storage by engine2. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + container: + type: array + items: + type: string + description: Represents a container in a Kubernetes cluster, encapsulating + an application. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + blob: + type: array + items: + type: string + description: A large binary object stored in a database or file system, + often unstructured data. + network: + type: array + items: + type: string + description: Refers to the interconnected system of computers and devices + for data communication. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + folder: + type: array + items: + type: string + description: A directory used to organize files and other folders in a hierarchical + structure. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_container + description: Represents a storage container in the cloud managed by the Engine2 + system. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + container: + type: array + items: + type: string + description: Represents a container in a Kubernetes cluster, encapsulating + an application. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_container_download_err + description: Tracks errors encountered during download operations from cloud storage + containers in Engine2. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + container: + type: array + items: + type: string + description: Represents a container in a Kubernetes cluster, encapsulating + an application. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_container_process_err + description: Tracks errors encountered during the processing of cloud storage + containers in Engine2. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + container: + type: array + items: + type: string + description: Represents a container in a Kubernetes cluster, encapsulating + an application. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_container_sent_count + description: Counts the number of data packets sent from a cloud storage container + by Engine2. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + container: + type: array + items: + type: string + description: Represents a container in a Kubernetes cluster, encapsulating + an application. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_folder + description: Represents a directory in cloud storage managed by the Engine2 system. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + container: + type: array + items: + type: string + description: Represents a container in a Kubernetes cluster, encapsulating + an application. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + network: + type: array + items: + type: string + description: Refers to the interconnected system of computers and devices + for data communication. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + folder: + type: array + items: + type: string + description: A directory used to organize files and other folders in a hierarchical + structure. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_idl_pairs + description: Represents the mapping of IDL pairs in the cloud storage engine version + 2. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_igp_topo_updates + description: Tracks updates to the IGP topology in the cloud storage engine for + network optimization. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + blob: + type: array + items: + type: string + description: A large binary object stored in a database or file system, + often unstructured data. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_igp_topo_updates_rate + description: Measures the rate of IGP topology updates in the cloud storage engine. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + blob: + type: array + items: + type: string + description: A large binary object stored in a database or file system, + often unstructured data. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_igp_topology_processed + description: Represents the processed state of IGP topology data in cloud storage + for Engine2. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + filetimestamp: + type: array + items: + type: string + description: Records the timestamp of when a specific file was created or + last modified. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_igp_topology_send_failed + description: Indicates a failure in sending IGP topology data to cloud storage + in Engine2. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + filetimestamp: + type: array + items: + type: string + description: Records the timestamp of when a specific file was created or + last modified. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_igp_topology_send_success + description: Measures the success rate of sending IGP topology data to cloud storage + in Engine2. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + filetimestamp: + type: array + items: + type: string + description: Records the timestamp of when a specific file was created or + last modified. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_igp_update_processed + description: Tracks the number of IGP updates processed by the cloud storage engine. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + filetimestamp: + type: array + items: + type: string + description: Records the timestamp of when a specific file was created or + last modified. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_igp_update_route_send_failed + description: Indicates a failure in sending IGP update routes to cloud storage + in engine2. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + filetimestamp: + type: array + items: + type: string + description: Records the timestamp of when a specific file was created or + last modified. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_igp_update_route_send_success + description: Tracks successful IGP route update transmissions to cloud storage + by the engine. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + filetimestamp: + type: array + items: + type: string + description: Records the timestamp of when a specific file was created or + last modified. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_igp_update_total_route_send_success + description: Counts successful route updates sent by the IGP engine to cloud storage. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + filetimestamp: + type: array + items: + type: string + description: Records the timestamp of when a specific file was created or + last modified. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_inst_status + description: Represents the status of cloud storage instances managed by Engine2 + in the network. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_integration_delete + description: Handles the deletion of data from cloud storage within the Engine2 + integration framework. + parameters: + type: object + properties: + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_integration_invalid + description: Indicates an invalid integration between Engine2 and cloud storage + services. + parameters: + type: object + properties: + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_integration_missing + description: Indicates a missing integration between Engine2 and cloud storage + services. + parameters: + type: object + properties: + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_integration_update + description: Updates the integration settings between Engine2 and cloud storage + services for data management. + parameters: + type: object + properties: + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_isis_topo_snapshots + description: Stores snapshots of IS-IS topology in cloud storage for network analysis + and recovery. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_network + description: Represents the network infrastructure and connectivity for cloud + storage in the Engine2 environment. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + container: + type: array + items: + type: string + description: Represents a container in a Kubernetes cluster, encapsulating + an application. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + network: + type: array + items: + type: string + description: Refers to the interconnected system of computers and devices + for data communication. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_network_download_err + description: Tracks errors encountered during network download operations from + cloud storage in engine2. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + container: + type: array + items: + type: string + description: Represents a container in a Kubernetes cluster, encapsulating + an application. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + network: + type: array + items: + type: string + description: Refers to the interconnected system of computers and devices + for data communication. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_network_process_err + description: Tracks errors occurring in the network process of cloud storage within + the Engine2 system. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + container: + type: array + items: + type: string + description: Represents a container in a Kubernetes cluster, encapsulating + an application. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + network: + type: array + items: + type: string + description: Refers to the interconnected system of computers and devices + for data communication. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_network_sent_count + description: Counts the number of network packets sent from engine2 to cloud storage. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + container: + type: array + items: + type: string + description: Represents a container in a Kubernetes cluster, encapsulating + an application. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + network: + type: array + items: + type: string + description: Refers to the interconnected system of computers and devices + for data communication. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_ospf_topo_snapshots + description: Captures snapshots of OSPF topology in cloud storage for network + analysis and troubleshooting. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_protocol + description: Specifies the protocol used by Engine2 for accessing cloud storage + services. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_protocol_download_error + description: Tracks errors encountered during download operations using cloud + storage protocols in Engine2. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_protocol_process_err + description: Tracks errors encountered during the processing of cloud storage + protocols in Engine2. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_protocol_report_sent_cnt + description: Counts the number of protocol reports sent by the cloud storage engine. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_starting + description: Indicates the initiation of cloud storage services in the Engine2 + environment. + parameters: + type: object + properties: + start_time: + type: array + items: + type: string + description: Represents the initial timestamp when a specific event or process + begins. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + version: + type: array + items: + type: string + description: The software version of a network device or application. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_starting_controller + description: Initiates the control process for starting cloud storage services + in the network engine. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_starting_device_manager + description: Initiates the device manager for cloud storage in the Engine2 system. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_stopped_controller + description: Monitors the status of stopped controllers in the Engine2 cloud storage + system. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_stopped_device_manager + description: Monitors and reports on devices that have stopped interacting with + cloud storage services. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_worker_no_support + description: Indicates that the cloud storage worker in engine2 lacks support + for certain operations. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_worker_started + description: Indicates the initiation of a cloud storage worker process in the + Engine2 system. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_cloudstorage_worker_stopped + description: Indicates that a cloud storage worker in engine2 has stopped functioning. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_container_processes + description: A label that tracks the number of processes running within a container. + parameters: + type: object + properties: + name: + type: array + items: + type: string + description: A label that identifies the name of a resource or object within + a system. + namespace: + type: array + items: + type: string + description: A label that defines the scope or context of a resource or + object within a system. + pod: + type: array + items: + type: string + description: A logical unit in Kubernetes that groups one or more containers. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min +- type: function + function: + name: get_container_spec_memory_limit_bytes + description: Specifies the memory limit in bytes for a container as defined in + its specification. + parameters: + type: object + properties: + namespace: + type: array + items: + type: string + description: A label that defines the scope or context of a resource or + object within a system. + pod: + type: array + items: + type: string + description: A logical unit in Kubernetes that groups one or more containers. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + name: + type: array + items: + type: string + description: A label that identifies the name of a resource or object within + a system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min +- type: function + function: + name: get_cpu_util_5min_raw + description: CPU utilization over the last 5 minutes in raw format. + parameters: + type: object + properties: + index: + type: array + items: + type: string + description: Index label for identifying and organizing data. + cpu_description: + type: array + items: + type: string + description: Description of CPU performance and utilization metrics. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + os: + type: array + items: + type: string + description: The operating system running on a network device. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_cpu_util_by_device + description: Measures the CPU utilization percentage for each device in the network. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_cpu_util_raw + description: Represents the raw CPU utilization percentage of a network device + or server. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + index: + type: array + items: + type: string + description: Index label for identifying and organizing data. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + cpu_description: + type: array + items: + type: string + description: Description of CPU performance and utilization metrics. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_cpu_util_raw_nrt + description: Represents the real-time raw CPU utilization percentage of a network + device. + parameters: + type: object + properties: + metric_value: + type: array + items: + type: string + description: The numerical value representing a specific metrics measurement + in the network. + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + index: + type: array + items: + type: string + description: Index label for identifying and organizing data. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + cpu_description: + type: array + items: + type: string + description: Description of CPU performance and utilization metrics. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_memory_available_extreme + description: Indicates the amount of memory available on the system, with extreme + values indicating high memory usage. + parameters: + type: object + properties: + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + os: + type: array + items: + type: string + description: The operating system running on a network device. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_memory_total_extreme + description: Represents the total extreme memory usage across network devices + or systems. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_memory_usage_extreme + description: Represents the extreme levels of memory usage in a network device + or system. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_bgp_device_health + description: Indicates the health and performance of BGP devices in the network. + parameters: + type: object + properties: + version: + type: array + items: + type: string + description: The software version of a network device or application. + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + os: + type: array + items: + type: string + description: The operating system running on a network device. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_cpu_device_health + description: Monitors the health and performance of CPU devices within the network + infrastructure. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_fru_power_supply_health + description: Monitors the health and operational status of the power supply units + in a device. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_harddown_health + description: Monitors the status and health of devices that are completely non-operational + in the network. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_health + description: Represents the operational status and performance metrics of a network + device. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_health_by_kpi + description: Evaluates the health of network devices based on key performance + indicators (KPIs). + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_mcast_health + description: Monitors the health and performance of multicast devices within the + network. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_ping_availability + description: Measures the availability of a device by checking its response to + ping requests. + parameters: + type: object + properties: + probe_hostname: + type: array + items: + type: string + description: The hostname of the probe used to monitor network performance + and availability. + probe_ipaddress: + type: array + items: + type: string + description: The IP address of the probe used for network monitoring and + diagnostics. + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_ping_health + description: Measures the responsiveness and connectivity status of a network + device using ping tests. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_power_supply_health + description: Monitors the operational status and reliability of a devices power + supply unit. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_reset_health + description: Monitors the health and status of devices after a reset operation + in the network. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_snmp_availability + description: Measures the availability and responsiveness of a device using SNMP + protocol. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + probe_ipaddress: + type: array + items: + type: string + description: The IP address of the probe used for network monitoring and + diagnostics. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + probe_hostname: + type: array + items: + type: string + description: The hostname of the probe used to monitor network performance + and availability. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_snmp_health + description: Monitors the health and performance of network devices using SNMP + protocols. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_temp_health + description: Monitors and reports the temperature status of network devices to + ensure optimal performance. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_temp_sensor_health + description: Monitors the operational status and accuracy of temperature sensors + in network devices. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_memory_device_health + description: Indicates the health and performance status of memory devices in + the network. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_port_device_health + description: Monitors the operational status and performance of network device + ports. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_site_health + description: Represents the overall operational status and performance of a network + site. + parameters: + type: object + properties: + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_es_cluster_pending_tasks_number + description: The number of pending tasks in an Elasticsearch cluster. + parameters: + type: object + properties: + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_es_cluster_status + description: Represents the current operational status and health of an Elasticsearch + cluster. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_es_http_open_total_count + description: Total count of open HTTP connections to the Elasticsearch server. + parameters: + type: object + properties: + nodeid: + type: array + items: + type: string + description: Unique identifier for a node within a network or system. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_es_index_get_missing_count + description: Counts the number of missing documents in an Elasticsearch index. + parameters: + type: object + properties: + context: + type: array + items: + type: string + description: Provides additional information or background relevant to the + current network operation. + index: + type: array + items: + type: string + description: Index label for identifying and organizing data. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_es_indices_search_fetch_count + description: Counts the number of fetch operations performed during search queries + on Elasticsearch indices. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + nodeid: + type: array + items: + type: string + description: Unique identifier for a node within a network or system. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_es_indices_search_fetch_current_number + description: Represents the current number of ongoing search fetch operations + in Elasticsearch indices. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + nodeid: + type: array + items: + type: string + description: Unique identifier for a node within a network or system. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_es_indices_search_fetch_time_seconds + description: Measures the time taken in seconds to fetch search results from Elasticsearch + indices. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + nodeid: + type: array + items: + type: string + description: Unique identifier for a node within a network or system. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_es_indices_search_query_count + description: Counts the number of search queries executed on Elasticsearch indices. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + nodeid: + type: array + items: + type: string + description: Unique identifier for a node within a network or system. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_es_indices_search_query_current_number + description: Represents the current number of search queries being processed by + Elasticsearch indices. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + nodeid: + type: array + items: + type: string + description: Unique identifier for a node within a network or system. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_es_indices_search_query_time_seconds + description: Measures the time taken in seconds to execute search queries on Elasticsearch + indices. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + nodeid: + type: array + items: + type: string + description: Unique identifier for a node within a network or system. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_es_jvm_mem_heap_committed_bytes + description: Represents the amount of memory committed for the Java Virtual Machine + heap in Elasticsearch. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + nodeid: + type: array + items: + type: string + description: Unique identifier for a node within a network or system. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_es_jvm_mem_heap_used_percent + description: Represents the percentage of JVM heap memory currently used in an + Elasticsearch node. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + nodeid: + type: array + items: + type: string + description: Unique identifier for a node within a network or system. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_es_threadpool_threads_count + description: Represents the number of threads in the Elasticsearch thread pool + for handling tasks. + parameters: + type: object + properties: + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + name: + type: array + items: + type: string + description: A label that identifies the name of a resource or object within + a system. + nodeid: + type: array + items: + type: string + description: Unique identifier for a node within a network or system. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_es_threadpool_threads_number + description: Represents the number of threads in the Elasticsearch thread pool + for handling tasks. + parameters: + type: object + properties: + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + name: + type: array + items: + type: string + description: A label that identifies the name of a resource or object within + a system. + nodeid: + type: array + items: + type: string + description: Unique identifier for a node within a network or system. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_manager_inst_status + description: Status of the engine 2 manager instance. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_manager_num_of_distributions + description: Represents the number of distributions managed by the Engine2 manager + in the network. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_manager_num_of_engines + description: Represents the number of engines managed by the Engine2 manager in + the network. + parameters: + type: object + properties: + integration: + type: array + items: + type: string + description: Refers to the process of combining different systems or components + to function as a unified whole. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_manager_processing + description: Monitors the processing performance and efficiency of the Engine2 + manager in the network system. + parameters: + type: object + properties: + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + integration: + type: array + items: + type: string + description: Refers to the process of combining different systems or components + to function as a unified whole. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_manager_processing_time + description: Measures the time taken by the engine2 manager to process tasks or + requests. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_manager_starting + description: Indicates the initialization process of the Engine2 manager within + the network system. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + start_time: + type: array + items: + type: string + description: Represents the initial timestamp when a specific event or process + begins. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + version: + type: array + items: + type: string + description: The software version of a network device or application. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_manager_target_engine_mapping + description: Maps target engines to their respective managers for efficient resource + allocation. + parameters: + type: object + properties: + engine_type: + type: array + items: + type: string + description: Specifies the type of engine used in the network infrastructure. + engine: + type: array + items: + type: string + description: Refers to the core component responsible for processing and + managing network tasks. + target: + type: array + items: + type: string + description: A target entity in a network, such as a server or a device. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + integration: + type: array + items: + type: string + description: Refers to the process of combining different systems or components + to function as a unified whole. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_fan_f5_chassis_status + description: Indicates the status of the fans in the F5 chassis of a device. + parameters: + type: object + properties: + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + os: + type: array + items: + type: string + description: The operating system running on a network device. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_fan_state + description: Represents the operational state of a devices cooling fan within + the network equipment. + parameters: + type: object + properties: + fan_desc: + type: array + items: + type: string + description: Provides a description or identifier for a specific fan in + the network device. + fan_index: + type: array + items: + type: string + description: Indicates the index or position of a fan within a network device. + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_fan_status + description: Monitors the operational status and performance of cooling fans in + network devices. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_fan_tray_status + description: Monitors the operational status of the fan tray in a network device. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_fru_power_status + description: Monitors the power status of Field Replaceable Units (FRUs) in network + devices. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_power_f5_chassis_status + description: Monitors the power status and operational health of the F5 chassis + in the network. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_power_state + description: Represents the current power state of a network device, such as on, + off, or standby. + parameters: + type: object + properties: + power_supply_desc: + type: array + items: + type: string + description: Provides a description of the power supply unit used in a network + device. + power_supply_index: + type: array + items: + type: string + description: Identifies the index or position of a power supply unit within + a device. + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_power_status + description: Indicates the current power status and availability of a network + device. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_sensor_temp_c + description: Measures the temperature in Celsius of a devices sensor for monitoring + thermal conditions. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_sensor_temp_f + description: Measures the temperature in Fahrenheit from sensors on network devices. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_temp_c + description: Represents the temperature of a network device in degrees Celsius. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_temp_f + description: Represents the temperature of a network device in degrees Fahrenheit. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_temperature_f + description: Represents the temperature of a network device in Fahrenheit. + parameters: + type: object + properties: + temp_index: + type: array + items: + type: string + description: An index value indicating the relative temperature status of + a device. + temp_desc: + type: array + items: + type: string + description: A descriptive label providing details about the temperature + condition of a device. + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_ent_sensor_metric_temp + description: Represents the temperature reading from an enterprise sensor device. + parameters: + type: object + properties: + ent_sensor_type: + type: array + items: + type: string + description: Specifies the type or category of an enterprise sensor device. + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + temp_index: + type: array + items: + type: string + description: An index value indicating the relative temperature status of + a device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + temp_desc: + type: array + items: + type: string + description: A descriptive label providing details about the temperature + condition of a device. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_ent_sensor_temp_metric_c + description: Measures the temperature in Celsius of a sensor within an enterprise + network device. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + ent_sensor_type: + type: array + items: + type: string + description: Specifies the type or category of an enterprise sensor device. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + temp_index: + type: array + items: + type: string + description: An index value indicating the relative temperature status of + a device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + temp_desc: + type: array + items: + type: string + description: A descriptive label providing details about the temperature + condition of a device. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_ent_sensor_temp_metric_f + description: Measures the temperature of enterprise sensors in Fahrenheit for + monitoring purposes. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + ent_sensor_type: + type: array + items: + type: string + description: Specifies the type or category of an enterprise sensor device. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + temp_index: + type: array + items: + type: string + description: An index value indicating the relative temperature status of + a device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + temp_desc: + type: array + items: + type: string + description: A descriptive label providing details about the temperature + condition of a device. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_fan_f5_chassis_state + description: Represents the operational state of the fan within an F5 chassis + system. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + fan_desc: + type: array + items: + type: string + description: Provides a description or identifier for a specific fan in + the network device. + fan_index: + type: array + items: + type: string + description: Indicates the index or position of a fan within a network device. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_fan_state + description: Represents the operational status of cooling fans in network equipment. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + fan_desc: + type: array + items: + type: string + description: Provides a description or identifier for a specific fan in + the network device. + fan_index: + type: array + items: + type: string + description: Indicates the index or position of a fan within a network device. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_fan_tray_oper_status + description: Represents the operational status of the fan tray in a network device. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + fan_desc: + type: array + items: + type: string + description: Provides a description or identifier for a specific fan in + the network device. + fan_index: + type: array + items: + type: string + description: Indicates the index or position of a fan within a network device. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_fru_power_oper_status + description: Indicates the operational status of power for a Field Replaceable + Unit (FRU) in the network. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + power_supply_desc: + type: array + items: + type: string + description: Provides a description of the power supply unit used in a network + device. + power_supply_index: + type: array + items: + type: string + description: Identifies the index or position of a power supply unit within + a device. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_power_supply_f5_chassis_state + description: Represents the operational state of the power supply units in an + F5 chassis. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + power_supply_desc: + type: array + items: + type: string + description: Provides a description of the power supply unit used in a network + device. + power_supply_index: + type: array + items: + type: string + description: Identifies the index or position of a power supply unit within + a device. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_power_supply_state + description: Indicates the current operational status of the power supply units + in a network device. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + power_supply_desc: + type: array + items: + type: string + description: Provides a description of the power supply unit used in a network + device. + power_supply_index: + type: array + items: + type: string + description: Identifies the index or position of a power supply unit within + a device. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_temp_value_c + description: Represents the temperature value in degrees Celsius for a specific + network device or location. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + temp_index: + type: array + items: + type: string + description: An index value indicating the relative temperature status of + a device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + temp_desc: + type: array + items: + type: string + description: A descriptive label providing details about the temperature + condition of a device. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_temp_value_f + description: Represents the temperature value in Fahrenheit for monitoring environmental + conditions. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + temp_index: + type: array + items: + type: string + description: An index value indicating the relative temperature status of + a device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + temp_desc: + type: array + items: + type: string + description: A descriptive label providing details about the temperature + condition of a device. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_temp_value_f5_chassis_c + description: Represents the temperature reading in Celsius for the F5 chassis + component. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + temp_index: + type: array + items: + type: string + description: An index value indicating the relative temperature status of + a device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + temp_desc: + type: array + items: + type: string + description: A descriptive label providing details about the temperature + condition of a device. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_temp_value_f5_chassis_f + description: Represents the temperature reading of the F5 chassis component in + Fahrenheit. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + temp_index: + type: array + items: + type: string + description: An index value indicating the relative temperature status of + a device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + temp_desc: + type: array + items: + type: string + description: A descriptive label providing details about the temperature + condition of a device. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_brokers + description: Kafka brokers are the nodes in a Kafka cluster that manage and distribute + data across the network. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_consumergroup_current_offset + description: Represents the current offset position of a Kafka consumer group + in a topic partition. + parameters: + type: object + properties: + consumergroup: + type: array + items: + type: string + description: A group of Kafka consumers that work together to consume messages + from a set of topics. + partition: + type: array + items: + type: string + description: A division of a Kafka topic that allows for parallel processing + of data. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_consumergroup_lag + description: Measures the delay between the latest message and the consumers + current position in a Kafka topic. + parameters: + type: object + properties: + consumergroup: + type: array + items: + type: string + description: A group of Kafka consumers that work together to consume messages + from a set of topics. + partition: + type: array + items: + type: string + description: A division of a Kafka topic that allows for parallel processing + of data. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_consumergroup_lag_sum + description: Represents the total lag of a Kafka consumer group, indicating message + processing delays. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + consumergroup: + type: array + items: + type: string + description: A group of Kafka consumers that work together to consume messages + from a set of topics. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_consumergroup_members + description: Represents the members of a Kafka consumer group responsible for + consuming messages from topics. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + consumergroup: + type: array + items: + type: string + description: A group of Kafka consumers that work together to consume messages + from a set of topics. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_topic_partition_current_offset + description: Represents the current offset position of a partition in a Kafka + topic. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + partition: + type: array + items: + type: string + description: A division of a Kafka topic that allows for parallel processing + of data. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_topic_partition_replicas + description: Represents the number of replicas for each partition in a Kafka topic. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + partition: + type: array + items: + type: string + description: A division of a Kafka topic that allows for parallel processing + of data. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_topic_partitions + description: Represents the number of partitions for a specific Kafka topic in + the cluster. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mongodb_connector_config_error_rate + description: Measures the frequency of configuration errors in the MongoDB connector + setup. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mongodb_connector_config_error_total + description: Total number of configuration errors encountered by the MongoDB connector. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mongodb_connector_connection_id_missing_rate + description: Measures the rate at which connection IDs are missing in the MongoDB + connector. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mongodb_connector_connection_id_missing_total + description: Counts the total number of missing connection IDs in the MongoDB + connector. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mongodb_connector_consume_error_rate + description: Measures the rate of errors encountered by the MongoDB connector + during data consumption. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mongodb_connector_consume_error_total + description: Total number of errors encountered by the MongoDB connector during + data consumption. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mongodb_connector_etcd_connection_id_missing + description: Indicates that the connection ID for MongoDB connector to etcd is + missing. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mongodb_connector_etcd_delete_handled + description: Tracks the number of delete operations handled by the MongoDB connector + with etcd. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mongodb_connector_etcd_delete_rvcd + description: Tracks the receipt of delete operations in MongoDBs etcd connector + for synchronization. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mongodb_connector_etcd_put_handled + description: Tracks the number of successful put operations handled by the MongoDB + connector with etcd. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mongodb_connector_etcd_put_rvcd + description: Tracks the number of received put requests by the MongoDB connector + in the etcd system. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mongodb_connector_etcd_schema_errors + description: Tracks errors related to schema mismatches in MongoDB connector with + etcd integration. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mongodb_connector_processed_messages_rate + description: Measures the rate at which messages are processed by the MongoDB + connector. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mongodb_connector_processed_messages_total + description: Total number of messages processed by the MongoDB connector in the + network. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mongodb_connector_rcvd_messages_rate + description: Measures the rate at which messages are received by the MongoDB connector. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mongodb_connector_rcvd_messages_total + description: Total number of messages received by the MongoDB connector from the + network. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mongodb_connector_schema_error_rate + description: Measures the rate of schema errors encountered by the MongoDB connector + during data operations. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mongodb_connector_schema_error_total + description: Total count of schema errors encountered by the MongoDB connector. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mongodb_connector_status + description: Represents the operational status of the MongoDB connector in the + network environment. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mongodb_connector_total_bytes_rate + description: Measures the rate of total bytes processed by the MongoDB connector + over time. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mongodb_connector_total_bytes_total + description: Represents the total number of bytes processed by the MongoDB connector. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mongodb_connector_write_error_rate + description: Measures the rate of write errors occurring in the MongoDB connector + over a specified period. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mongodb_connector_write_error_total + description: Total number of write errors encountered by the MongoDB connector. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mongodb_connector_write_success_rate + description: Measures the success rate of write operations through the MongoDB + connector. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mongodb_connector_write_success_total + description: Total number of successful write operations performed by the MongoDB + connector. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prom_connector_config_error_rate + description: Measures the rate of configuration errors in the Prometheus connector + setup. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prom_connector_config_error_total + description: Counts the total number of configuration errors encountered by the + Prometheus connector. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prom_connector_consume_error_rate + description: Measures the rate of errors encountered while consuming messages + from a Prometheus connector. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prom_connector_consume_error_total + description: Total number of errors encountered by the Prometheus connector while + consuming data. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prom_connector_etcd_connection_id_missing + description: Indicates a missing connection ID in the etcd component of the Prometheus + connector. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prom_connector_etcd_delete_handled + description: Tracks the number of delete operations successfully handled by the + etcd connector. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prom_connector_etcd_delete_rvcd + description: Tracks the number of delete operations received by the etcd connector + in Prometheus. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prom_connector_etcd_put_handled + description: Tracks the number of successful put operations handled by the etcd + connector. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prom_connector_etcd_put_rvcd + description: Tracks the number of received put requests in the etcd connector + for Prometheus. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prom_connector_etcd_schema_errors + description: Tracks the number of schema errors encountered by the Prometheus + connector with etcd. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prom_connector_latency_errors_exceeding_5_min_rate + description: Measures the rate of latency errors in the Prometheus connector exceeding + five minutes. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prom_connector_latency_errors_exceeding_5_min_total + description: Counts the total number of latency errors exceeding five minutes + in the Prometheus connector. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prom_connector_processed_messages_rate + description: Measures the rate at which messages are processed by the Prometheus + connector. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prom_connector_processed_messages_total + description: Total number of messages processed by the Prometheus connector in + the network. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prom_connector_rcvd_messages_rate + description: Measures the rate at which messages are received by the Prometheus + connector. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prom_connector_rcvd_messages_total + description: Total number of messages received by the Prometheus connector from + the network. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prom_connector_remote_write_error_rate + description: Measures the error rate of remote write operations in the Prometheus + connector. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prom_connector_remote_write_error_total + description: Counts the total number of errors encountered during remote write + operations in Prometheus. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prom_connector_remote_write_success_rate + description: Measures the success rate of remote write operations in Prometheus + connectors. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prom_connector_remote_write_success_total + description: Total number of successful remote write operations by the Prometheus + connector. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prom_connector_schema_error_rate + description: Measures the rate of schema errors encountered by the Prometheus + connector in the network. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prom_connector_schema_error_total + description: Total number of schema errors encountered by the Prometheus connector. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prom_connector_status + description: Indicates the operational status of the Prometheus connector in the + network monitoring system. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prom_connector_total_bytes_rate + description: Measures the rate of total bytes transferred through the Prometheus + connector over time. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prom_connector_total_bytes_total + description: Tracks the total number of bytes processed by the Prometheus connector + over time. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_go_gc_heap_frees_bytes_total + description: Total number of bytes freed by the garbage collector in a single + garbage collection cycle. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_go_goroutines + description: Represents the number of goroutines currently running in a Go application. + parameters: + type: object + properties: + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_go_info + description: Provides information about the Go programming language environment + and version. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + version: + type: array + items: + type: string + description: The software version of a network device or application. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_go_memstats_frees_total + description: Total number of memory frees in the Go runtime since the program + started. + parameters: + type: object + properties: + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_go_memstats_gc_cpu_fraction + description: Represents the fraction of CPU time used by the garbage collector + in Go applications. + parameters: + type: object + properties: + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_go_memstats_heap_idle_bytes + description: Represents the number of bytes in idle heap memory not currently + in use by Go applications. + parameters: + type: object + properties: + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_go_memstats_heap_inuse_bytes + description: Represents the number of bytes in use by the heap memory allocator + in Go. + parameters: + type: object + properties: + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_go_memstats_heap_objects + description: Represents the number of allocated heap objects in the Go runtime + memory statistics. + parameters: + type: object + properties: + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_go_memstats_stack_inuse_bytes + description: Represents the number of bytes in use by the stack allocator in Gos + memory statistics. + parameters: + type: object + properties: + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_go_memstats_sys_bytes + description: Reports the total bytes of memory obtained from the system by the + Go runtime. + parameters: + type: object + properties: + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_go_threads + description: Represents the number of operating system threads created by the + Go runtime. + parameters: + type: object + properties: + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pan_ha_mode + description: Determines the High Availability (HA) mode for Palo Alto Networks + firewalls. + parameters: + type: object + properties: + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + os: + type: array + items: + type: string + description: The operating system running on a network device. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pan_ha_peer_state + description: Represents the state of the high availability peer in a Palo Alto + Networks setup. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pan_ha_state + description: Represents the high availability state of a Palo Alto Networks firewall + in a cluster. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_admin_oper_status + description: Current operational status of an interface as reported by the local + system. + parameters: + type: object + properties: + if_remote_long: + type: array + items: + type: string + description: A long identifier for a remote interface. + if_role: + type: array + items: + type: string + description: The role of an interface within a network. + if_index: + type: array + items: + type: string + description: A unique identifier for an interface. + if_service_id: + type: array + items: + type: string + description: An identifier for a service associated with an interface. + if_tags: + type: array + items: + type: string + description: Tags or keywords associated with an interface. + if_service_name: + type: array + items: + type: string + description: The name of a service associated with an interface. + if_remote_site: + type: array + items: + type: string + description: The remote site associated with an interface. + if_alias: + type: array + items: + type: string + description: An alias or nickname for an interface. + if_service_type: + type: array + items: + type: string + description: The type of service associated with an interface. + if_type: + type: array + items: + type: string + description: The type of interface. + if_remote: + type: array + items: + type: string + description: A remote interface. + if_remote_lat: + type: array + items: + type: string + description: The latency of a remote interface. + if_remote_device: + type: array + items: + type: string + description: The remote device associated with an interface. + if_description: + type: array + items: + type: string + description: A description of an interface. + version: + type: array + items: + type: string + description: The software version of a network device or application. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + os: + type: array + items: + type: string + description: The operating system running on a network device. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_admin_status + description: Represents the administrative status of a network interface, indicating + if it is enabled or disabled. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + if_tags: + type: array + items: + type: string + description: Tags or keywords associated with an interface. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + if_remote_lat: + type: array + items: + type: string + description: The latency of a remote interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + if_remote_long: + type: array + items: + type: string + description: A long identifier for a remote interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + if_remote_site: + type: array + items: + type: string + description: The remote site associated with an interface. + if_role: + type: array + items: + type: string + description: The role of an interface within a network. + version: + type: array + items: + type: string + description: The software version of a network device or application. + if_service_id: + type: array + items: + type: string + description: An identifier for a service associated with an interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + if_service_type: + type: array + items: + type: string + description: The type of service associated with an interface. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + if_description: + type: array + items: + type: string + description: A description of an interface. + if_type: + type: array + items: + type: string + description: The type of interface. + if_remote: + type: array + items: + type: string + description: A remote interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + if_remote_device: + type: array + items: + type: string + description: The remote device associated with an interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + if_alias: + type: array + items: + type: string + description: An alias or nickname for an interface. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + if_service_name: + type: array + items: + type: string + description: The name of a service associated with an interface. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + if_index: + type: array + items: + type: string + description: A unique identifier for an interface. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_admin_status_nrt + description: Represents the near real-time administrative status of a network + interface. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + if_tags: + type: array + items: + type: string + description: Tags or keywords associated with an interface. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + if_remote_lat: + type: array + items: + type: string + description: The latency of a remote interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + if_remote_long: + type: array + items: + type: string + description: A long identifier for a remote interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + if_remote_site: + type: array + items: + type: string + description: The remote site associated with an interface. + if_role: + type: array + items: + type: string + description: The role of an interface within a network. + version: + type: array + items: + type: string + description: The software version of a network device or application. + metric_value: + type: array + items: + type: string + description: The numerical value representing a specific metrics measurement + in the network. + if_service_id: + type: array + items: + type: string + description: An identifier for a service associated with an interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + if_service_type: + type: array + items: + type: string + description: The type of service associated with an interface. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + if_description: + type: array + items: + type: string + description: A description of an interface. + if_type: + type: array + items: + type: string + description: The type of interface. + if_remote: + type: array + items: + type: string + description: A remote interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + if_remote_device: + type: array + items: + type: string + description: The remote device associated with an interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + if_alias: + type: array + items: + type: string + description: An alias or nickname for an interface. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + if_service_name: + type: array + items: + type: string + description: The name of a service associated with an interface. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + if_index: + type: array + items: + type: string + description: A unique identifier for an interface. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_host_flap_count + description: Counts the number of times a network interface has flapped, indicating + instability. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_host_status + description: Represents the operational status of a network interface on a host + device. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_in_bits_rate + description: Measures the rate of incoming bits per second on a network interface. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + if_tags: + type: array + items: + type: string + description: Tags or keywords associated with an interface. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + if_remote_lat: + type: array + items: + type: string + description: The latency of a remote interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + if_remote_long: + type: array + items: + type: string + description: A long identifier for a remote interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + if_remote_site: + type: array + items: + type: string + description: The remote site associated with an interface. + if_role: + type: array + items: + type: string + description: The role of an interface within a network. + version: + type: array + items: + type: string + description: The software version of a network device or application. + if_service_id: + type: array + items: + type: string + description: An identifier for a service associated with an interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + if_service_type: + type: array + items: + type: string + description: The type of service associated with an interface. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + if_description: + type: array + items: + type: string + description: A description of an interface. + if_type: + type: array + items: + type: string + description: The type of interface. + if_remote: + type: array + items: + type: string + description: A remote interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + if_remote_device: + type: array + items: + type: string + description: The remote device associated with an interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + if_alias: + type: array + items: + type: string + description: An alias or nickname for an interface. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + if_service_name: + type: array + items: + type: string + description: The name of a service associated with an interface. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + if_index: + type: array + items: + type: string + description: A unique identifier for an interface. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_in_bits_rate_nrt + description: Measures the rate of incoming bits per second on an interface in + near real-time. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + if_tags: + type: array + items: + type: string + description: Tags or keywords associated with an interface. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + if_remote_lat: + type: array + items: + type: string + description: The latency of a remote interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + if_remote_long: + type: array + items: + type: string + description: A long identifier for a remote interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + if_remote_site: + type: array + items: + type: string + description: The remote site associated with an interface. + if_role: + type: array + items: + type: string + description: The role of an interface within a network. + version: + type: array + items: + type: string + description: The software version of a network device or application. + metric_value: + type: array + items: + type: string + description: The numerical value representing a specific metrics measurement + in the network. + if_service_id: + type: array + items: + type: string + description: An identifier for a service associated with an interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + if_service_type: + type: array + items: + type: string + description: The type of service associated with an interface. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + if_description: + type: array + items: + type: string + description: A description of an interface. + if_type: + type: array + items: + type: string + description: The type of interface. + if_remote: + type: array + items: + type: string + description: A remote interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + if_remote_device: + type: array + items: + type: string + description: The remote device associated with an interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + if_alias: + type: array + items: + type: string + description: An alias or nickname for an interface. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + if_service_name: + type: array + items: + type: string + description: The name of a service associated with an interface. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + if_index: + type: array + items: + type: string + description: A unique identifier for an interface. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_in_discards + description: Counts the number of inbound packets discarded by the interface due + to errors or congestion. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + if_tags: + type: array + items: + type: string + description: Tags or keywords associated with an interface. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + if_remote_lat: + type: array + items: + type: string + description: The latency of a remote interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + if_remote_long: + type: array + items: + type: string + description: A long identifier for a remote interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + if_remote_site: + type: array + items: + type: string + description: The remote site associated with an interface. + if_role: + type: array + items: + type: string + description: The role of an interface within a network. + version: + type: array + items: + type: string + description: The software version of a network device or application. + if_service_id: + type: array + items: + type: string + description: An identifier for a service associated with an interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + if_service_type: + type: array + items: + type: string + description: The type of service associated with an interface. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + if_description: + type: array + items: + type: string + description: A description of an interface. + if_type: + type: array + items: + type: string + description: The type of interface. + if_remote: + type: array + items: + type: string + description: A remote interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + if_remote_device: + type: array + items: + type: string + description: The remote device associated with an interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + if_alias: + type: array + items: + type: string + description: An alias or nickname for an interface. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + if_service_name: + type: array + items: + type: string + description: The name of a service associated with an interface. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + if_index: + type: array + items: + type: string + description: A unique identifier for an interface. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_in_discards_rate + description: Measures the rate at which incoming packets are discarded on a network + interface. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + if_tags: + type: array + items: + type: string + description: Tags or keywords associated with an interface. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + if_remote_lat: + type: array + items: + type: string + description: The latency of a remote interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + if_remote_long: + type: array + items: + type: string + description: A long identifier for a remote interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + if_remote_site: + type: array + items: + type: string + description: The remote site associated with an interface. + if_role: + type: array + items: + type: string + description: The role of an interface within a network. + version: + type: array + items: + type: string + description: The software version of a network device or application. + if_service_id: + type: array + items: + type: string + description: An identifier for a service associated with an interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + if_service_type: + type: array + items: + type: string + description: The type of service associated with an interface. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + if_description: + type: array + items: + type: string + description: A description of an interface. + if_type: + type: array + items: + type: string + description: The type of interface. + if_remote: + type: array + items: + type: string + description: A remote interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + if_remote_device: + type: array + items: + type: string + description: The remote device associated with an interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + if_alias: + type: array + items: + type: string + description: An alias or nickname for an interface. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + if_service_name: + type: array + items: + type: string + description: The name of a service associated with an interface. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + if_index: + type: array + items: + type: string + description: A unique identifier for an interface. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_in_errors + description: Counts the number of inbound errors on a network interface, indicating + potential issues. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + if_tags: + type: array + items: + type: string + description: Tags or keywords associated with an interface. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + if_remote_lat: + type: array + items: + type: string + description: The latency of a remote interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + if_remote_long: + type: array + items: + type: string + description: A long identifier for a remote interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + if_remote_site: + type: array + items: + type: string + description: The remote site associated with an interface. + if_role: + type: array + items: + type: string + description: The role of an interface within a network. + version: + type: array + items: + type: string + description: The software version of a network device or application. + if_service_id: + type: array + items: + type: string + description: An identifier for a service associated with an interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + if_service_type: + type: array + items: + type: string + description: The type of service associated with an interface. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + if_description: + type: array + items: + type: string + description: A description of an interface. + if_type: + type: array + items: + type: string + description: The type of interface. + if_remote: + type: array + items: + type: string + description: A remote interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + if_remote_device: + type: array + items: + type: string + description: The remote device associated with an interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + if_alias: + type: array + items: + type: string + description: An alias or nickname for an interface. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + if_service_name: + type: array + items: + type: string + description: The name of a service associated with an interface. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + if_index: + type: array + items: + type: string + description: A unique identifier for an interface. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_in_errors_rate + description: Measures the rate of incoming errors on a network interface over + a specified period. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + if_tags: + type: array + items: + type: string + description: Tags or keywords associated with an interface. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + if_remote_lat: + type: array + items: + type: string + description: The latency of a remote interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + if_remote_long: + type: array + items: + type: string + description: A long identifier for a remote interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + if_remote_site: + type: array + items: + type: string + description: The remote site associated with an interface. + if_role: + type: array + items: + type: string + description: The role of an interface within a network. + version: + type: array + items: + type: string + description: The software version of a network device or application. + if_service_id: + type: array + items: + type: string + description: An identifier for a service associated with an interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + if_service_type: + type: array + items: + type: string + description: The type of service associated with an interface. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + if_description: + type: array + items: + type: string + description: A description of an interface. + if_type: + type: array + items: + type: string + description: The type of interface. + if_remote: + type: array + items: + type: string + description: A remote interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + if_remote_device: + type: array + items: + type: string + description: The remote device associated with an interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + if_alias: + type: array + items: + type: string + description: An alias or nickname for an interface. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + if_service_name: + type: array + items: + type: string + description: The name of a service associated with an interface. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + if_index: + type: array + items: + type: string + description: A unique identifier for an interface. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_in_utilization + description: Measures the input bandwidth utilization of a network interface over + a specific period. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + if_tags: + type: array + items: + type: string + description: Tags or keywords associated with an interface. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + if_remote_lat: + type: array + items: + type: string + description: The latency of a remote interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + if_remote_long: + type: array + items: + type: string + description: A long identifier for a remote interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + if_remote_site: + type: array + items: + type: string + description: The remote site associated with an interface. + if_role: + type: array + items: + type: string + description: The role of an interface within a network. + version: + type: array + items: + type: string + description: The software version of a network device or application. + if_service_id: + type: array + items: + type: string + description: An identifier for a service associated with an interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + if_service_type: + type: array + items: + type: string + description: The type of service associated with an interface. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + if_description: + type: array + items: + type: string + description: A description of an interface. + if_type: + type: array + items: + type: string + description: The type of interface. + if_remote: + type: array + items: + type: string + description: A remote interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + if_remote_device: + type: array + items: + type: string + description: The remote device associated with an interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + if_alias: + type: array + items: + type: string + description: An alias or nickname for an interface. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + if_service_name: + type: array + items: + type: string + description: The name of a service associated with an interface. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + if_index: + type: array + items: + type: string + description: A unique identifier for an interface. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_lastchange + description: Records the last time a network interface experienced a change in + its operational state. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + if_tags: + type: array + items: + type: string + description: Tags or keywords associated with an interface. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + if_remote_lat: + type: array + items: + type: string + description: The latency of a remote interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + if_remote_long: + type: array + items: + type: string + description: A long identifier for a remote interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + if_remote_site: + type: array + items: + type: string + description: The remote site associated with an interface. + if_role: + type: array + items: + type: string + description: The role of an interface within a network. + version: + type: array + items: + type: string + description: The software version of a network device or application. + if_service_id: + type: array + items: + type: string + description: An identifier for a service associated with an interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + if_service_type: + type: array + items: + type: string + description: The type of service associated with an interface. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + if_description: + type: array + items: + type: string + description: A description of an interface. + if_type: + type: array + items: + type: string + description: The type of interface. + if_remote: + type: array + items: + type: string + description: A remote interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + if_remote_device: + type: array + items: + type: string + description: The remote device associated with an interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + if_alias: + type: array + items: + type: string + description: An alias or nickname for an interface. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + if_service_name: + type: array + items: + type: string + description: The name of a service associated with an interface. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + if_index: + type: array + items: + type: string + description: A unique identifier for an interface. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_lastchange_time + description: Records the last time a network interface experienced a change in + its operational state. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + if_tags: + type: array + items: + type: string + description: Tags or keywords associated with an interface. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + if_remote_lat: + type: array + items: + type: string + description: The latency of a remote interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + if_remote_long: + type: array + items: + type: string + description: A long identifier for a remote interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + if_remote_site: + type: array + items: + type: string + description: The remote site associated with an interface. + if_role: + type: array + items: + type: string + description: The role of an interface within a network. + version: + type: array + items: + type: string + description: The software version of a network device or application. + if_service_id: + type: array + items: + type: string + description: An identifier for a service associated with an interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + if_service_type: + type: array + items: + type: string + description: The type of service associated with an interface. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + if_description: + type: array + items: + type: string + description: A description of an interface. + if_type: + type: array + items: + type: string + description: The type of interface. + if_remote: + type: array + items: + type: string + description: A remote interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + if_remote_device: + type: array + items: + type: string + description: The remote device associated with an interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + if_alias: + type: array + items: + type: string + description: An alias or nickname for an interface. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + if_service_name: + type: array + items: + type: string + description: The name of a service associated with an interface. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + if_index: + type: array + items: + type: string + description: A unique identifier for an interface. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_oper_status + description: Represents the operational status of a network interface, indicating + if it is up or down. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + if_tags: + type: array + items: + type: string + description: Tags or keywords associated with an interface. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + if_remote_lat: + type: array + items: + type: string + description: The latency of a remote interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + if_remote_long: + type: array + items: + type: string + description: A long identifier for a remote interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + if_remote_site: + type: array + items: + type: string + description: The remote site associated with an interface. + if_role: + type: array + items: + type: string + description: The role of an interface within a network. + version: + type: array + items: + type: string + description: The software version of a network device or application. + if_service_id: + type: array + items: + type: string + description: An identifier for a service associated with an interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + if_service_type: + type: array + items: + type: string + description: The type of service associated with an interface. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + if_description: + type: array + items: + type: string + description: A description of an interface. + if_type: + type: array + items: + type: string + description: The type of interface. + if_remote: + type: array + items: + type: string + description: A remote interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + if_remote_device: + type: array + items: + type: string + description: The remote device associated with an interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + if_alias: + type: array + items: + type: string + description: An alias or nickname for an interface. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + if_service_name: + type: array + items: + type: string + description: The name of a service associated with an interface. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + if_index: + type: array + items: + type: string + description: A unique identifier for an interface. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_oper_status_nrt + description: Represents the near real-time operational status of a network interface. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + if_tags: + type: array + items: + type: string + description: Tags or keywords associated with an interface. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + if_remote_lat: + type: array + items: + type: string + description: The latency of a remote interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + if_remote_long: + type: array + items: + type: string + description: A long identifier for a remote interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + if_remote_site: + type: array + items: + type: string + description: The remote site associated with an interface. + if_role: + type: array + items: + type: string + description: The role of an interface within a network. + version: + type: array + items: + type: string + description: The software version of a network device or application. + metric_value: + type: array + items: + type: string + description: The numerical value representing a specific metrics measurement + in the network. + if_service_id: + type: array + items: + type: string + description: An identifier for a service associated with an interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + if_service_type: + type: array + items: + type: string + description: The type of service associated with an interface. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + if_description: + type: array + items: + type: string + description: A description of an interface. + if_type: + type: array + items: + type: string + description: The type of interface. + if_remote: + type: array + items: + type: string + description: A remote interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + if_remote_device: + type: array + items: + type: string + description: The remote device associated with an interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + if_alias: + type: array + items: + type: string + description: An alias or nickname for an interface. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + if_service_name: + type: array + items: + type: string + description: The name of a service associated with an interface. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + if_index: + type: array + items: + type: string + description: A unique identifier for an interface. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_out_bits_rate + description: Measures the rate of outbound bits per second on a network interface. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + if_tags: + type: array + items: + type: string + description: Tags or keywords associated with an interface. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + if_remote_lat: + type: array + items: + type: string + description: The latency of a remote interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + if_remote_long: + type: array + items: + type: string + description: A long identifier for a remote interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + if_remote_site: + type: array + items: + type: string + description: The remote site associated with an interface. + if_role: + type: array + items: + type: string + description: The role of an interface within a network. + version: + type: array + items: + type: string + description: The software version of a network device or application. + if_service_id: + type: array + items: + type: string + description: An identifier for a service associated with an interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + if_service_type: + type: array + items: + type: string + description: The type of service associated with an interface. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + if_description: + type: array + items: + type: string + description: A description of an interface. + if_type: + type: array + items: + type: string + description: The type of interface. + if_remote: + type: array + items: + type: string + description: A remote interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + if_remote_device: + type: array + items: + type: string + description: The remote device associated with an interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + if_alias: + type: array + items: + type: string + description: An alias or nickname for an interface. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + if_service_name: + type: array + items: + type: string + description: The name of a service associated with an interface. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + if_index: + type: array + items: + type: string + description: A unique identifier for an interface. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_out_bits_rate_nrt + description: Measures the real-time rate of outgoing bits on a network interface. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + if_tags: + type: array + items: + type: string + description: Tags or keywords associated with an interface. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + if_remote_lat: + type: array + items: + type: string + description: The latency of a remote interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + if_remote_long: + type: array + items: + type: string + description: A long identifier for a remote interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + if_remote_site: + type: array + items: + type: string + description: The remote site associated with an interface. + if_role: + type: array + items: + type: string + description: The role of an interface within a network. + version: + type: array + items: + type: string + description: The software version of a network device or application. + metric_value: + type: array + items: + type: string + description: The numerical value representing a specific metrics measurement + in the network. + if_service_id: + type: array + items: + type: string + description: An identifier for a service associated with an interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + if_service_type: + type: array + items: + type: string + description: The type of service associated with an interface. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + if_description: + type: array + items: + type: string + description: A description of an interface. + if_type: + type: array + items: + type: string + description: The type of interface. + if_remote: + type: array + items: + type: string + description: A remote interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + if_remote_device: + type: array + items: + type: string + description: The remote device associated with an interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + if_alias: + type: array + items: + type: string + description: An alias or nickname for an interface. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + if_service_name: + type: array + items: + type: string + description: The name of a service associated with an interface. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + if_index: + type: array + items: + type: string + description: A unique identifier for an interface. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_out_discards + description: Counts the number of outbound packets discarded due to errors or + congestion on the interface. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + if_tags: + type: array + items: + type: string + description: Tags or keywords associated with an interface. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + if_remote_lat: + type: array + items: + type: string + description: The latency of a remote interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + if_remote_long: + type: array + items: + type: string + description: A long identifier for a remote interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + if_remote_site: + type: array + items: + type: string + description: The remote site associated with an interface. + if_role: + type: array + items: + type: string + description: The role of an interface within a network. + version: + type: array + items: + type: string + description: The software version of a network device or application. + if_service_id: + type: array + items: + type: string + description: An identifier for a service associated with an interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + if_service_type: + type: array + items: + type: string + description: The type of service associated with an interface. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + if_description: + type: array + items: + type: string + description: A description of an interface. + if_type: + type: array + items: + type: string + description: The type of interface. + if_remote: + type: array + items: + type: string + description: A remote interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + if_remote_device: + type: array + items: + type: string + description: The remote device associated with an interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + if_alias: + type: array + items: + type: string + description: An alias or nickname for an interface. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + if_service_name: + type: array + items: + type: string + description: The name of a service associated with an interface. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + if_index: + type: array + items: + type: string + description: A unique identifier for an interface. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_out_discards_rate + description: Measures the rate at which outbound packets are discarded on a network + interface. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + if_tags: + type: array + items: + type: string + description: Tags or keywords associated with an interface. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + if_remote_lat: + type: array + items: + type: string + description: The latency of a remote interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + if_remote_long: + type: array + items: + type: string + description: A long identifier for a remote interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + if_remote_site: + type: array + items: + type: string + description: The remote site associated with an interface. + if_role: + type: array + items: + type: string + description: The role of an interface within a network. + version: + type: array + items: + type: string + description: The software version of a network device or application. + if_service_id: + type: array + items: + type: string + description: An identifier for a service associated with an interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + if_service_type: + type: array + items: + type: string + description: The type of service associated with an interface. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + if_description: + type: array + items: + type: string + description: A description of an interface. + if_type: + type: array + items: + type: string + description: The type of interface. + if_remote: + type: array + items: + type: string + description: A remote interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + if_remote_device: + type: array + items: + type: string + description: The remote device associated with an interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + if_alias: + type: array + items: + type: string + description: An alias or nickname for an interface. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + if_service_name: + type: array + items: + type: string + description: The name of a service associated with an interface. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + if_index: + type: array + items: + type: string + description: A unique identifier for an interface. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_out_errors + description: Counts the number of outbound errors on a network interface, indicating + potential issues. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + if_tags: + type: array + items: + type: string + description: Tags or keywords associated with an interface. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + if_remote_lat: + type: array + items: + type: string + description: The latency of a remote interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + if_remote_long: + type: array + items: + type: string + description: A long identifier for a remote interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + if_remote_site: + type: array + items: + type: string + description: The remote site associated with an interface. + if_role: + type: array + items: + type: string + description: The role of an interface within a network. + version: + type: array + items: + type: string + description: The software version of a network device or application. + if_service_id: + type: array + items: + type: string + description: An identifier for a service associated with an interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + if_service_type: + type: array + items: + type: string + description: The type of service associated with an interface. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + if_description: + type: array + items: + type: string + description: A description of an interface. + if_type: + type: array + items: + type: string + description: The type of interface. + if_remote: + type: array + items: + type: string + description: A remote interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + if_remote_device: + type: array + items: + type: string + description: The remote device associated with an interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + if_alias: + type: array + items: + type: string + description: An alias or nickname for an interface. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + if_service_name: + type: array + items: + type: string + description: The name of a service associated with an interface. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + if_index: + type: array + items: + type: string + description: A unique identifier for an interface. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_out_errors_rate + description: Measures the rate of outbound errors on a network interface over + a specific time period. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + if_tags: + type: array + items: + type: string + description: Tags or keywords associated with an interface. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + if_remote_lat: + type: array + items: + type: string + description: The latency of a remote interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + if_remote_long: + type: array + items: + type: string + description: A long identifier for a remote interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + if_remote_site: + type: array + items: + type: string + description: The remote site associated with an interface. + if_role: + type: array + items: + type: string + description: The role of an interface within a network. + version: + type: array + items: + type: string + description: The software version of a network device or application. + if_service_id: + type: array + items: + type: string + description: An identifier for a service associated with an interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + if_service_type: + type: array + items: + type: string + description: The type of service associated with an interface. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + if_description: + type: array + items: + type: string + description: A description of an interface. + if_type: + type: array + items: + type: string + description: The type of interface. + if_remote: + type: array + items: + type: string + description: A remote interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + if_remote_device: + type: array + items: + type: string + description: The remote device associated with an interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + if_alias: + type: array + items: + type: string + description: An alias or nickname for an interface. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + if_service_name: + type: array + items: + type: string + description: The name of a service associated with an interface. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + if_index: + type: array + items: + type: string + description: A unique identifier for an interface. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_out_utilization + description: Measures the percentage of outbound traffic utilization on a network + interface. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + if_tags: + type: array + items: + type: string + description: Tags or keywords associated with an interface. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + if_remote_lat: + type: array + items: + type: string + description: The latency of a remote interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + if_remote_long: + type: array + items: + type: string + description: A long identifier for a remote interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + if_remote_site: + type: array + items: + type: string + description: The remote site associated with an interface. + if_role: + type: array + items: + type: string + description: The role of an interface within a network. + version: + type: array + items: + type: string + description: The software version of a network device or application. + if_service_id: + type: array + items: + type: string + description: An identifier for a service associated with an interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + if_service_type: + type: array + items: + type: string + description: The type of service associated with an interface. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + if_description: + type: array + items: + type: string + description: A description of an interface. + if_type: + type: array + items: + type: string + description: The type of interface. + if_remote: + type: array + items: + type: string + description: A remote interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + if_remote_device: + type: array + items: + type: string + description: The remote device associated with an interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + if_alias: + type: array + items: + type: string + description: An alias or nickname for an interface. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + if_service_name: + type: array + items: + type: string + description: The name of a service associated with an interface. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + if_index: + type: array + items: + type: string + description: A unique identifier for an interface. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_status + description: Represents the operational status of a network interface, such as + up or down. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + if_tags: + type: array + items: + type: string + description: Tags or keywords associated with an interface. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + if_remote_lat: + type: array + items: + type: string + description: The latency of a remote interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + if_remote_long: + type: array + items: + type: string + description: A long identifier for a remote interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + if_remote_site: + type: array + items: + type: string + description: The remote site associated with an interface. + if_role: + type: array + items: + type: string + description: The role of an interface within a network. + version: + type: array + items: + type: string + description: The software version of a network device or application. + if_service_id: + type: array + items: + type: string + description: An identifier for a service associated with an interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + if_service_type: + type: array + items: + type: string + description: The type of service associated with an interface. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + if_description: + type: array + items: + type: string + description: A description of an interface. + if_type: + type: array + items: + type: string + description: The type of interface. + if_remote: + type: array + items: + type: string + description: A remote interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + if_remote_device: + type: array + items: + type: string + description: The remote device associated with an interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + if_alias: + type: array + items: + type: string + description: An alias or nickname for an interface. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + if_service_name: + type: array + items: + type: string + description: The name of a service associated with an interface. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + if_index: + type: array + items: + type: string + description: A unique identifier for an interface. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_status_by_kpi + description: Represents the interface status evaluated against key performance + indicators in the network. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + if_tags: + type: array + items: + type: string + description: Tags or keywords associated with an interface. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + if_remote_lat: + type: array + items: + type: string + description: The latency of a remote interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + if_remote_long: + type: array + items: + type: string + description: A long identifier for a remote interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + if_remote_site: + type: array + items: + type: string + description: The remote site associated with an interface. + if_role: + type: array + items: + type: string + description: The role of an interface within a network. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + if_service_type: + type: array + items: + type: string + description: The type of service associated with an interface. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + if_description: + type: array + items: + type: string + description: A description of an interface. + if_type: + type: array + items: + type: string + description: The type of interface. + if_remote: + type: array + items: + type: string + description: A remote interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + if_remote_device: + type: array + items: + type: string + description: The remote device associated with an interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + if_alias: + type: array + items: + type: string + description: An alias or nickname for an interface. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + if_service_name: + type: array + items: + type: string + description: The name of a service associated with an interface. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + if_index: + type: array + items: + type: string + description: A unique identifier for an interface. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_status_changes + description: Tracks changes in the status of network interfaces to monitor connectivity + and performance. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + if_tags: + type: array + items: + type: string + description: Tags or keywords associated with an interface. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + if_remote_lat: + type: array + items: + type: string + description: The latency of a remote interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + if_remote_long: + type: array + items: + type: string + description: A long identifier for a remote interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + if_remote_site: + type: array + items: + type: string + description: The remote site associated with an interface. + if_role: + type: array + items: + type: string + description: The role of an interface within a network. + version: + type: array + items: + type: string + description: The software version of a network device or application. + if_service_id: + type: array + items: + type: string + description: An identifier for a service associated with an interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + if_service_type: + type: array + items: + type: string + description: The type of service associated with an interface. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + if_description: + type: array + items: + type: string + description: A description of an interface. + if_type: + type: array + items: + type: string + description: The type of interface. + if_remote: + type: array + items: + type: string + description: A remote interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + if_remote_device: + type: array + items: + type: string + description: The remote device associated with an interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + if_alias: + type: array + items: + type: string + description: An alias or nickname for an interface. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + if_service_name: + type: array + items: + type: string + description: The name of a service associated with an interface. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + if_index: + type: array + items: + type: string + description: A unique identifier for an interface. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_inventory_presence + description: Indicates the presence of a device in the inventory. + parameters: + type: object + properties: + model: + type: array + items: + type: string + description: Represents the model of a device or network equipment. + ping_profile: + type: array + items: + type: string + description: Describes the ping profile settings for network performance + monitoring. + vendor: + type: array + items: + type: string + description: Identifies the manufacturer or vendor of network equipment. + serial_number: + type: array + items: + type: string + description: Provides the unique serial number of a device or network equipment. + profile: + type: array + items: + type: string + description: Defines a specific configuration or setting for network devices. + cluster_class: + type: array + items: + type: string + description: Classifies devices into clusters based on their characteristics + or functions. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + os: + type: array + items: + type: string + description: The operating system running on a network device. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_inventory_bulk_delete_total + description: Total number of inventory items deleted in bulk. + parameters: + type: object + properties: + inventoryname: + type: array + items: + type: string + description: Name of the inventory item. + category: + type: array + items: + type: string + description: Category of the inventory item. + reason: + type: array + items: + type: string + description: Reason for the inventory item deletion. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_inventory_bulk_post_total + description: Tracks the total number of bulk post operations performed in the + inventory system. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + category: + type: array + items: + type: string + description: Category of the inventory item. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + inventoryname: + type: array + items: + type: string + description: Name of the inventory item. + reason: + type: array + items: + type: string + description: Reason for the inventory item deletion. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_inventory_bulk_put_total + description: Tracks the total number of bulk put operations performed in the inventory + system. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + category: + type: array + items: + type: string + description: Category of the inventory item. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + inventoryname: + type: array + items: + type: string + description: Name of the inventory item. + reason: + type: array + items: + type: string + description: Reason for the inventory item deletion. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_inventory_csv_delete_total + description: Total count of CSV inventory deletions performed in the network management + system. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + category: + type: array + items: + type: string + description: Category of the inventory item. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + inventoryname: + type: array + items: + type: string + description: Name of the inventory item. + reason: + type: array + items: + type: string + description: Reason for the inventory item deletion. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_inventory_csv_post_total + description: Total number of CSV files posted to the inventory system for processing. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + category: + type: array + items: + type: string + description: Category of the inventory item. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + inventoryname: + type: array + items: + type: string + description: Name of the inventory item. + reason: + type: array + items: + type: string + description: Reason for the inventory item deletion. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_inventory_csv_put_total + description: Total number of CSV files uploaded to the inventory system. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + category: + type: array + items: + type: string + description: Category of the inventory item. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + inventoryname: + type: array + items: + type: string + description: Name of the inventory item. + reason: + type: array + items: + type: string + description: Reason for the inventory item deletion. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_inventory_data_delete_total + description: Total count of inventory data deletions performed in the network + system. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + category: + type: array + items: + type: string + description: Category of the inventory item. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + inventoryname: + type: array + items: + type: string + description: Name of the inventory item. + reason: + type: array + items: + type: string + description: Reason for the inventory item deletion. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_inventory_data_get_total + description: Retrieves the total count of inventory data entries in the system. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + category: + type: array + items: + type: string + description: Category of the inventory item. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + inventoryname: + type: array + items: + type: string + description: Name of the inventory item. + reason: + type: array + items: + type: string + description: Reason for the inventory item deletion. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_inventory_data_post_total + description: Total number of inventory data posts made to the network system. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + category: + type: array + items: + type: string + description: Category of the inventory item. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + inventoryname: + type: array + items: + type: string + description: Name of the inventory item. + reason: + type: array + items: + type: string + description: Reason for the inventory item deletion. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_inventory_data_put_total + description: Total number of inventory data entries successfully stored in the + database. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + category: + type: array + items: + type: string + description: Category of the inventory item. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + inventoryname: + type: array + items: + type: string + description: Name of the inventory item. + reason: + type: array + items: + type: string + description: Reason for the inventory item deletion. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_inventory_manager_rest_rate + description: Measures the rate of REST API requests handled by the inventory manager. + parameters: + type: object + properties: + status_code: + type: array + items: + type: string + description: HTTP status code indicating the result of a network request. + method: + type: array + items: + type: string + description: HTTP method used in a network request, such as GET, POST, PUT, + or DELETE. + path: + type: array + items: + type: string + description: The specific endpoint or resource path accessed in a network + request. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_inventory_manager_status + description: Represents the current operational status of the networks inventory + management system. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_inventory_schema_configmap_total + description: Total number of ConfigMaps related to inventory schema configurations + in the network. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + category: + type: array + items: + type: string + description: Category of the inventory item. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + inventoryname: + type: array + items: + type: string + description: Name of the inventory item. + reason: + type: array + items: + type: string + description: Reason for the inventory item deletion. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_inventory_schema_del_total + description: Total number of deletions in the inventory schema over a specified + period. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + category: + type: array + items: + type: string + description: Category of the inventory item. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + inventoryname: + type: array + items: + type: string + description: Name of the inventory item. + reason: + type: array + items: + type: string + description: Reason for the inventory item deletion. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_inventory_schema_get_total + description: Retrieves the total count of items in the inventory schema. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + category: + type: array + items: + type: string + description: Category of the inventory item. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + inventoryname: + type: array + items: + type: string + description: Name of the inventory item. + reason: + type: array + items: + type: string + description: Reason for the inventory item deletion. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_inventory_schema_post_total + description: Total number of POST requests made to the inventory schema endpoint. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + category: + type: array + items: + type: string + description: Category of the inventory item. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + inventoryname: + type: array + items: + type: string + description: Name of the inventory item. + reason: + type: array + items: + type: string + description: Reason for the inventory item deletion. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_inventory_schema_put_total + description: Counts the total number of PUT operations on the inventory schema + in the network. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + category: + type: array + items: + type: string + description: Category of the inventory item. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + inventoryname: + type: array + items: + type: string + description: Name of the inventory item. + reason: + type: array + items: + type: string + description: Reason for the inventory item deletion. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_jnpr_operating_state + description: Indicates the current operational state of the Juniper Networks device. + parameters: + type: object + properties: + module_description: + type: array + items: + type: string + description: Provides a description of the module or component within the + Juniper Networks device. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + os: + type: array + items: + type: string + description: The operating system running on a network device. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_broker_connects + description: The number of connections between Kafka brokers. + parameters: + type: object + properties: + broker: + type: array + items: + type: string + description: A server that hosts a Kafka cluster and manages data replication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_broker_disconnects + description: Tracks the number of disconnections experienced by Kafka brokers + in the network. + parameters: + type: object + properties: + broker: + type: array + items: + type: string + description: A server that hosts a Kafka cluster and manages data replication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_broker_rtt_avg + description: Represents the average round-trip time for data packets to Kafka + brokers in the network. + parameters: + type: object + properties: + broker: + type: array + items: + type: string + description: A server that hosts a Kafka cluster and manages data replication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_broker_rtt_p95 + description: Represents the 95th percentile round-trip time for messages to Kafka + brokers. + parameters: + type: object + properties: + broker: + type: array + items: + type: string + description: A server that hosts a Kafka cluster and manages data replication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_broker_state + description: Represents the current operational state of a Kafka broker within + the cluster. + parameters: + type: object + properties: + broker: + type: array + items: + type: string + description: A server that hosts a Kafka cluster and manages data replication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_broker_stateage_ms + description: Measures the age of the current state of a Kafka broker in milliseconds. + parameters: + type: object + properties: + broker: + type: array + items: + type: string + description: A server that hosts a Kafka cluster and manages data replication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_cgrp_state + description: Represents the current state of a Kafka consumer group within the + cluster. + parameters: + type: object + properties: + broker: + type: array + items: + type: string + description: A server that hosts a Kafka cluster and manages data replication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_cgrp_stateage_ms + description: Represents the age in milliseconds of the state of a Kafka consumer + group. + parameters: + type: object + properties: + broker: + type: array + items: + type: string + description: A server that hosts a Kafka cluster and manages data replication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_partition_committed_offset + description: Represents the last committed offset for a partition in a Kafka topic. + parameters: + type: object + properties: + partition: + type: array + items: + type: string + description: A division of a Kafka topic that allows for parallel processing + of data. + broker: + type: array + items: + type: string + description: A server that hosts a Kafka cluster and manages data replication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_partition_consumer_lag + description: Measures the delay between the latest message and the consumers + current position in a Kafka partition. + parameters: + type: object + properties: + partition: + type: array + items: + type: string + description: A division of a Kafka topic that allows for parallel processing + of data. + broker: + type: array + items: + type: string + description: A server that hosts a Kafka cluster and manages data replication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_partition_msgq_bytes + description: Represents the number of bytes in the message queue for a Kafka partition. + parameters: + type: object + properties: + partition: + type: array + items: + type: string + description: A division of a Kafka topic that allows for parallel processing + of data. + broker: + type: array + items: + type: string + description: A server that hosts a Kafka cluster and manages data replication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_partition_rxbytes + description: Represents the number of bytes received by a Kafka partition over + the network. + parameters: + type: object + properties: + partition: + type: array + items: + type: string + description: A division of a Kafka topic that allows for parallel processing + of data. + broker: + type: array + items: + type: string + description: A server that hosts a Kafka cluster and manages data replication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_partition_rxmsgs + description: Tracks the number of messages received by a Kafka partition over + a specific period. + parameters: + type: object + properties: + partition: + type: array + items: + type: string + description: A division of a Kafka topic that allows for parallel processing + of data. + broker: + type: array + items: + type: string + description: A server that hosts a Kafka cluster and manages data replication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_partition_txbytes + description: Tracks the number of bytes transmitted from a specific Kafka partition + over the network. + parameters: + type: object + properties: + partition: + type: array + items: + type: string + description: A division of a Kafka topic that allows for parallel processing + of data. + broker: + type: array + items: + type: string + description: A server that hosts a Kafka cluster and manages data replication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_partition_txmsgs + description: Represents the number of messages transmitted from a specific Kafka + partition. + parameters: + type: object + properties: + partition: + type: array + items: + type: string + description: A division of a Kafka topic that allows for parallel processing + of data. + broker: + type: array + items: + type: string + description: A server that hosts a Kafka cluster and manages data replication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + topic: + type: array + items: + type: string + description: A category or feed name to which records are published in a + Kafka system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kong_bandwidth_bytes + description: A metric label that measures the bandwidth in bytes for Kong. + parameters: + type: object + properties: + service: + type: array + items: + type: string + description: A label that identifies a service in a network. + direction: + type: array + items: + type: string + description: A label that indicates the direction of network traffic. + route: + type: array + items: + type: string + description: A label that specifies the route taken by network traffic. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kong_bandwidth_bytes_rate + description: Measures the rate of bandwidth usage in bytes per second for Kong + API gateway. + parameters: + type: object + properties: + direction: + type: array + items: + type: string + description: A label that indicates the direction of network traffic. + route: + type: array + items: + type: string + description: A label that specifies the route taken by network traffic. + service: + type: array + items: + type: string + description: A label that identifies a service in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kong_http_requests_error_rate + description: Measures the rate of HTTP request errors processed by the Kong API + gateway. + parameters: + type: object + properties: + code: + type: array + items: + type: string + description: Represents the status or error code returned by a network service + or application. + route: + type: array + items: + type: string + description: A label that specifies the route taken by network traffic. + service: + type: array + items: + type: string + description: A label that identifies a service in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kong_http_requests_success_rate + description: Measures the percentage of successful HTTP requests processed by + the Kong API gateway. + parameters: + type: object + properties: + route: + type: array + items: + type: string + description: A label that specifies the route taken by network traffic. + service: + type: array + items: + type: string + description: A label that identifies a service in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + code: + type: array + items: + type: string + description: Represents the status or error code returned by a network service + or application. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kong_http_requests_total + description: Total number of HTTP requests processed by the Kong API gateway. + parameters: + type: object + properties: + source: + type: array + items: + type: string + description: Identifies the origin or starting point of network traffic + or data. + route: + type: array + items: + type: string + description: A label that specifies the route taken by network traffic. + service: + type: array + items: + type: string + description: A label that identifies a service in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + code: + type: array + items: + type: string + description: Represents the status or error code returned by a network service + or application. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kong_inst_status + description: Represents the operational status of a Kong API gateway instance + in the network. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_exporter_num_export_fails + description: The number of export failures reported by the DHV exporter. + parameters: + type: object + properties: + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + subtype: + type: array + items: + type: string + description: A subcategory or variant of a main category or type. + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_exporter_num_export_fails_rate + description: Measures the rate at which export operations fail in the DHV exporter + system. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + subtype: + type: array + items: + type: string + description: A subcategory or variant of a main category or type. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_exporter_num_export_nodata_rate + description: Measures the rate at which the exporter sends data with no content + or missing information. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + subtype: + type: array + items: + type: string + description: A subcategory or variant of a main category or type. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_exporter_num_export_records_fails + description: Counts the number of failed attempts to export records by the DHV + exporter. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + subtype: + type: array + items: + type: string + description: A subcategory or variant of a main category or type. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_exporter_num_exported_records + description: Represents the total number of records exported by the DHV exporter + in the network. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + subtype: + type: array + items: + type: string + description: A subcategory or variant of a main category or type. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_exporter_num_exported_records_rate + description: Measures the rate at which records are exported by the DHV exporter + in the network. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + subtype: + type: array + items: + type: string + description: A subcategory or variant of a main category or type. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_exporter_num_exports + description: Represents the number of export operations performed by the DHV exporter. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + subtype: + type: array + items: + type: string + description: A subcategory or variant of a main category or type. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_exporter_num_exports_rate + description: Measures the rate at which the DHV exporter is exporting data over + time. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + subtype: + type: array + items: + type: string + description: A subcategory or variant of a main category or type. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_exporter_num_record_exists + description: Represents the number of existing records exported by the DHV exporter. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + subtype: + type: array + items: + type: string + description: A subcategory or variant of a main category or type. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_exporter_num_replaced_records + description: Counts the number of records replaced by the DHV exporter in the + data processing pipeline. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + subtype: + type: array + items: + type: string + description: A subcategory or variant of a main category or type. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_exporter_status + description: Represents the operational status of the DHV exporter in the network + monitoring system. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + subtype: + type: array + items: + type: string + description: A subcategory or variant of a main category or type. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_extractor_num_extracts + description: Represents the number of data extractions performed by the DHV extractor + in the network. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_extractor_num_extracts_rate + description: Measures the rate at which data extracts are performed by the DHV + extractor. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + subtype: + type: array + items: + type: string + description: A subcategory or variant of a main category or type. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_last_update + description: Represents the timestamp of the last update for the device health + verification process. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_bad_responses + description: Counts the number of unsuccessful or erroneous responses received + by the DHV loader. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_bad_responses_rate + description: Measures the rate of unsuccessful responses received by the DHV loader + in the network. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_clears + description: Counts the number of times the DHV loader has been cleared or reset. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_empty_responses + description: Counts the number of empty responses received by the DHV loader during + data retrieval. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_empty_responses_rate + description: Measures the rate of empty responses received by the DHV loader in + the network. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_filter_drops + description: Counts the number of packets dropped by the filter in the DHV loader + process. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_filter_drops_rate + description: Measures the rate at which packets are dropped by filters in the + DHV loader. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_filter_pass + description: Represents the number of data packets that passed through the filter + in the loader process. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_filter_pass_rate + description: Represents the rate at which data passes through filters in the DHV + loader process. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_invalid_reports + description: Counts the number of invalid reports processed by the DHV loader + in the network. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_invalid_reports_rate + description: Measures the rate of invalid reports processed by the DHV loader + in the network. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_kafka_msgs_rcvd + description: Represents the number of Kafka messages received by the DHV loader + component. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_kafka_msgs_rcvd_rate + description: Measures the rate at which Kafka messages are received by the DHV + loader. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_keymatch_fails + description: Counts the number of key match failures encountered by the DHV loader + during operations. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_mutations_applied + description: Represents the number of mutations successfully applied by the DHV + loader in the system. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_mutations_applied_rate + description: Measures the rate at which mutations are applied by the DHV loader + in the network. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_no_responses + description: Counts the number of times the data loader received no response from + the network. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_no_responses_rate + description: Measures the rate of no responses from the loader in the DHV system. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_parse_errors + description: Counts the number of parsing errors encountered by the DHV loader + during data processing. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_parse_errors_rate + description: Measures the rate of parsing errors encountered by the DHV loader + during data processing. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_parsed_reports + description: Represents the number of reports successfully parsed by the DHV loader. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_records_loaded + description: Represents the number of records successfully loaded by the DHV loader + process. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_records_loaded_rate + description: Measures the rate at which records are successfully loaded by the + DHV loader. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_requests + description: Tracks the number of requests processed by the DHV loader in the + network. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_requests_rate + description: Measures the rate of requests handled by the DHV loader over a specific + time period. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_responses + description: Represents the number of responses received by the DHV loader in + the network. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_responses_rate + description: Measures the rate of responses received by the DHV loader in the + network. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_selected_records + description: Represents the number of records selected by the DHV loader for processing. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_skipped_reports + description: Counts the number of reports skipped by the DHV loader during data + processing. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_skipped_reports_rate + description: Measures the rate at which reports are skipped by the DHV loader + process. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_source_not_found + description: Counts the number of data sources not found during the DHV loading + process. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_source_not_found_rate + description: Measures the rate at which data sources are not found by the DHV + loader. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_udc_fetch_errors + description: Counts the number of errors encountered while fetching data from + UDC in the DHV loader. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_udc_fetch_errors_rate + description: Measures the rate of errors encountered while fetching data from + UDC by the DHV loader. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_udc_response_errors + description: Counts the number of response errors encountered by the DHV loader + from UDC services. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_udc_response_errors_rate + description: Measures the rate of response errors from the UDC in the DHV loader + process. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_udf_fetch_errors + description: Counts the number of errors encountered while fetching User Defined + Functions (UDF) in the loader. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_udf_fetch_errors_rate + description: Measures the rate of errors encountered when fetching User Defined + Functions (UDF) in the loader. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_udf_response_errors + description: Counts the number of errors encountered in user-defined function + responses during data loading. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_udf_response_errors_rate + description: Measures the rate of user-defined function response errors in the + DHV loader process. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_unknown_api_type + description: Counts the number of unknown API types encountered by the DHV loader. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_num_unknown_api_type_rate + description: Measures the rate of unknown API types encountered by the DHV loader + in the network. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_loader_status + description: Represents the current operational status of the DHV data loader + in the network. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_master_status + description: Represents the current operational status of the master device in + a distributed network system. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_pipeline_num_exec_aborts + description: Counts the number of execution aborts in the data handling and validation + pipeline. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_pipeline_num_exec_aborts_rate + description: Measures the rate of execution aborts in the DHV pipeline process. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_pipeline_num_executes + description: Represents the number of times the DHV pipeline has been executed. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_pipeline_num_executes_rate + description: Measures the rate at which the DHV pipeline executes tasks over a + given time period. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_pipeline_num_fetch_aborts + description: Counts the number of aborted fetch operations in the data handling + pipeline. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_pipeline_num_fetch_aborts_rate + description: Measures the rate at which fetch operations are aborted in the DHV + pipeline. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_pipeline_num_fetches + description: Represents the number of data fetch operations performed by the DHV + pipeline. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_pipeline_num_fetches_rate + description: Measures the rate at which data fetches occur in the DHV pipeline. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_retriever_num_retrieves + description: Counts the number of retrieval operations performed by the DHV retriever + in the network. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_retriever_num_udf_errors + description: Counts the number of user-defined function errors encountered by + the DHV retriever. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_retriever_num_unresolved_udfs + description: Counts the number of unresolved User Defined Functions (UDFs) in + the data retrieval process. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + pipeline: + type: array + items: + type: string + description: A series of connected processes or stages that work together + to achieve a specific outcome. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_status + description: Represents the current operational status of the Data Handling and + Verification system. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_updates + description: Tracks updates to the Dynamic Host Configuration Protocol (DHCP) + version in the network. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_worker_num_executes + description: Represents the number of executions performed by a distributed hypervisor + worker. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_worker_num_executes_rate + description: Measures the rate at which tasks are executed by a distributed hypervisor + worker. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_worker_num_idleruns + description: Counts the number of idle runs performed by a worker in the distributed + system. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_worker_num_idleruns_rate + description: Measures the rate at which idle runs occur for workers in a distributed + network system. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_worker_opstat_updates + description: Tracks the operational status updates of distributed hardware virtualization + workers in the network. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_worker_process_liveness + description: Monitors the operational status and activity of worker processes + in a distributed system. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_worker_status + description: Represents the operational status of a distributed hypervisor worker + in the network. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_workflow_num_execute_errors + description: Counts the number of execution errors in the DHV workflow process. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_workflow_num_execute_errors_rate + description: Measures the rate of execution errors in the DHV workflow process. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_workflow_num_executes + description: Tracks the number of times a specific workflow has been executed + in the network. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_workflow_num_executes_rate + description: Measures the rate at which workflows are executed in the DHV system. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_workflow_num_idleruns + description: Counts the number of idle runs in a distributed hybrid vehicle workflow + system. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_dhv_workflow_num_idleruns_rate + description: Measures the rate of idle runs in a DHV workflow, indicating potential + inefficiencies. + parameters: + type: object + properties: + worker: + type: array + items: + type: string + description: An entity responsible for performing tasks or operations within + a system. + workflow: + type: array + items: + type: string + description: A sequence of tasks or operations that are performed to achieve + a specific goal. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + job: + type: array + items: + type: string + description: A task or set of tasks assigned to a worker to complete a specific + objective. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_loki_cardinality + description: A metric label that represents the number of unique values in a dimension. + parameters: + type: object + properties: + label_name: + type: array + items: + type: string + description: A generic label used to identify and categorize data in a metric. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_jnpr_mem_usage_raw + description: A raw metric label for JUNOS device memory usage. + parameters: + type: object + properties: + version: + type: array + items: + type: string + description: The software version of a network device or application. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + os: + type: array + items: + type: string + description: The operating system running on a network device. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + cpu_description: + type: array + items: + type: string + description: Description of CPU performance and utilization metrics. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_memory_size + description: Represents the total amount of memory available or used in a system + or device. + parameters: + type: object + properties: + storage_index: + type: array + items: + type: string + description: A unique identifier for a specific storage unit or location + within a system. + storage_type: + type: array + items: + type: string + description: Defines the category or technology of storage, such as SSD, + HDD, or cloud storage. + storage_description: + type: array + items: + type: string + description: Provides detailed information about the characteristics and + purpose of a storage unit. + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_memory_usage + description: Represents the amount of memory currently being used by applications + and processes on a device. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_memory_usage_nrt + description: Represents the near real-time memory usage statistics of a network + device or system. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + metric_value: + type: array + items: + type: string + description: The numerical value representing a specific metrics measurement + in the network. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_memory_used + description: Represents the amount of memory currently utilized by the system + or application. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + storage_type: + type: array + items: + type: string + description: Defines the category or technology of storage, such as SSD, + HDD, or cloud storage. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + storage_description: + type: array + items: + type: string + description: Provides detailed information about the characteristics and + purpose of a storage unit. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + storage_index: + type: array + items: + type: string + description: A unique identifier for a specific storage unit or location + within a system. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_s2ap_baseline_health_monitoring + description: Monitors the health of the S2AP baseline to ensure it is functioning + correctly. + parameters: + type: object + properties: + metric: + type: array + items: + type: string + description: A measure of performance or activity used to evaluate the efficiency + or effectiveness of a system. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_app_info + description: Information about the application, such as its name, version, and + other relevant details. + parameters: + type: object + properties: + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_client_host_gibytes + description: Measures the amount of data in gibibytes transferred to or from a + client host. + parameters: + type: object + properties: + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_collector_status + description: Represents the operational status and performance of a network data + collector. + parameters: + type: object + properties: + application: + type: array + items: + type: string + description: Refers to a software program or group of programs designed + for end-users. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_collector_status_by_kpi + description: Represents the status of data collectors based on Key Performance + Indicators (KPIs). + parameters: + type: object + properties: + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + application: + type: array + items: + type: string + description: Refers to a software program or group of programs designed + for end-users. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_flow_bytes + description: Represents the total number of bytes transferred in a network flow. + parameters: + type: object + properties: + flow_end_timestamp: + type: array + items: + type: string + description: The timestamp indicating when the network flow ended. + flow_export_host_name: + type: array + items: + type: string + description: The name of the host exporting the flow data. + flow_community_id: + type: array + items: + type: string + description: A unique identifier for the network flow community. + flow_client_host_name: + type: array + items: + type: string + description: The host name of the client involved in the network flow. + flow_end_sysuptime: + type: array + items: + type: string + description: The system uptime at the end of the network flow. + flow_dst_host_name: + type: array + items: + type: string + description: The host name of the destination in the network flow. + flow_client_as_asn: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of the client in the flow. + flow_in_bytes: + type: array + items: + type: string + description: The number of incoming bytes in the network flow. + flow_client_ip_addr: + type: array + items: + type: string + description: The IP address of the client in the network flow. + flow_dst_as_org: + type: array + items: + type: string + description: The organization associated with the destinations ASN in the + flow. + flow_in_ip_ecn_name: + type: array + items: + type: string + description: The name of the Explicit Congestion Notification (ECN) for + incoming IP packets. + flow_dst_ip_addr: + type: array + items: + type: string + description: The IP address of the destination in the network flow. + flow_in_ip_dscp_name: + type: array + items: + type: string + description: The name of the Differentiated Services Code Point (DSCP) for + incoming IP packets. + flow_dst_l4_port_name: + type: array + items: + type: string + description: The name of the Layer 4 port at the destination in the flow. + flow_seq_num: + type: array + items: + type: string + description: The sequence number of the network flow record. + flow_start_sysuptime: + type: array + items: + type: string + description: The system uptime at the start of the network flow. + flow_dst_as_label: + type: array + items: + type: string + description: The label associated with the destinations Autonomous System + in the flow. + flow_in_netif_name: + type: array + items: + type: string + description: The name of the network interface for incoming traffic in the + flow. + flow_in_packets: + type: array + items: + type: string + description: The number of incoming packets in the network flow. + flow_client_as_label: + type: array + items: + type: string + description: The label associated with the clients Autonomous System in + the flow. + flow_out_netif_name: + type: array + items: + type: string + description: The name of the network interface for outgoing traffic in the + flow. + flow_client_l4_port_id: + type: array + items: + type: string + description: The identifier of the Layer 4 port used by the client in the + flow. + flow_dst_l4_port_id: + type: array + items: + type: string + description: The identifier of the Layer 4 port at the destination in the + flow. + flow_client_as_org: + type: array + items: + type: string + description: The organization associated with the clients ASN in the flow. + flow_client_l4_port_name: + type: array + items: + type: string + description: The name of the Layer 4 port used by the client in the flow. + flow_start_timestamp: + type: array + items: + type: string + description: The timestamp indicating when the network flow started. + flow_conversation_id: + type: array + items: + type: string + description: A unique identifier for the conversation in the network flow. + flow_duration_secs: + type: array + items: + type: string + description: The duration of the network flow in seconds. + flow_dst_as_asn: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of the destination in the + flow. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_flow_packets + description: Represents the number of packets transmitted through a network flow + over a specific period. + parameters: + type: object + properties: + flow_end_timestamp: + type: array + items: + type: string + description: The timestamp indicating when the network flow ended. + flow_export_host_name: + type: array + items: + type: string + description: The name of the host exporting the flow data. + flow_community_id: + type: array + items: + type: string + description: A unique identifier for the network flow community. + flow_client_host_name: + type: array + items: + type: string + description: The host name of the client involved in the network flow. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + flow_end_sysuptime: + type: array + items: + type: string + description: The system uptime at the end of the network flow. + flow_dst_host_name: + type: array + items: + type: string + description: The host name of the destination in the network flow. + flow_client_as_asn: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of the client in the flow. + flow_in_bytes: + type: array + items: + type: string + description: The number of incoming bytes in the network flow. + flow_client_ip_addr: + type: array + items: + type: string + description: The IP address of the client in the network flow. + flow_dst_as_org: + type: array + items: + type: string + description: The organization associated with the destinations ASN in the + flow. + flow_in_ip_ecn_name: + type: array + items: + type: string + description: The name of the Explicit Congestion Notification (ECN) for + incoming IP packets. + flow_dst_ip_addr: + type: array + items: + type: string + description: The IP address of the destination in the network flow. + flow_in_ip_dscp_name: + type: array + items: + type: string + description: The name of the Differentiated Services Code Point (DSCP) for + incoming IP packets. + flow_dst_l4_port_name: + type: array + items: + type: string + description: The name of the Layer 4 port at the destination in the flow. + flow_seq_num: + type: array + items: + type: string + description: The sequence number of the network flow record. + flow_start_sysuptime: + type: array + items: + type: string + description: The system uptime at the start of the network flow. + flow_dst_as_label: + type: array + items: + type: string + description: The label associated with the destinations Autonomous System + in the flow. + flow_in_netif_name: + type: array + items: + type: string + description: The name of the network interface for incoming traffic in the + flow. + flow_in_packets: + type: array + items: + type: string + description: The number of incoming packets in the network flow. + flow_client_as_label: + type: array + items: + type: string + description: The label associated with the clients Autonomous System in + the flow. + flow_out_netif_name: + type: array + items: + type: string + description: The name of the network interface for outgoing traffic in the + flow. + flow_client_l4_port_id: + type: array + items: + type: string + description: The identifier of the Layer 4 port used by the client in the + flow. + flow_dst_l4_port_id: + type: array + items: + type: string + description: The identifier of the Layer 4 port at the destination in the + flow. + flow_client_as_org: + type: array + items: + type: string + description: The organization associated with the clients ASN in the flow. + flow_client_l4_port_name: + type: array + items: + type: string + description: The name of the Layer 4 port used by the client in the flow. + flow_start_timestamp: + type: array + items: + type: string + description: The timestamp indicating when the network flow started. + flow_conversation_id: + type: array + items: + type: string + description: A unique identifier for the conversation in the network flow. + flow_duration_secs: + type: array + items: + type: string + description: The duration of the network flow in seconds. + flow_dst_as_asn: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of the destination in the + flow. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_flow_processor_burst_total + description: Total number of burst events processed by the flow processor in the + network. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + application: + type: array + items: + type: string + description: Refers to a software program or group of programs designed + for end-users. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_flow_processor_errored_records_rate + description: Measures the rate of errored records processed by the flow processor + in the network. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + application: + type: array + items: + type: string + description: Refers to a software program or group of programs designed + for end-users. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_flow_processor_errored_records_total + description: Total number of errored records processed by the flow processor in + the network. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + application: + type: array + items: + type: string + description: Refers to a software program or group of programs designed + for end-users. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_flow_processor_packets_total + description: Total number of packets processed by the flow processor in the network. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + application: + type: array + items: + type: string + description: Refers to a software program or group of programs designed + for end-users. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_flow_processor_records_total + description: Total number of records processed by the flow processor in the network. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + application: + type: array + items: + type: string + description: Refers to a software program or group of programs designed + for end-users. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_netflow_app_bytes + description: Measures the total bytes transferred by a specific application in + network flow data. + parameters: + type: object + properties: + port: + type: array + items: + type: string + description: Identifies the communication endpoint for network services + using a numerical label. + app: + type: array + items: + type: string + description: Represents a specific application or service within the network + traffic data. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_netflow_conversation_bytes + description: Represents the total number of bytes exchanged in a network conversation + using NetFlow data. + parameters: + type: object + properties: + conversation: + type: array + items: + type: string + description: Refers to a communication session between two or more network + entities. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_netflow_device_bytes + description: Represents the total number of bytes processed by a device using + NetFlow protocol. + parameters: + type: object + properties: + device: + type: array + items: + type: string + description: A network device such as a router or switch. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_netflow_device_packets + description: Represents the number of packets processed by a device using NetFlow + for traffic analysis. + parameters: + type: object + properties: + device: + type: array + items: + type: string + description: A network device such as a router or switch. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_netflow_host_bytes + description: Represents the total number of bytes transferred to or from a specific + host in the network. + parameters: + type: object + properties: + ipaddr: + type: array + items: + type: string + description: Denotes the unique numerical label assigned to each device + connected to a computer network. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_netflow_if_bytes + description: Represents the total number of bytes transferred through a network + interface using NetFlow. + parameters: + type: object + properties: + input_if: + type: array + items: + type: string + description: Denotes the network interface receiving incoming traffic on + a device. + output_if: + type: array + items: + type: string + description: Denotes the network interface sending outgoing traffic from + a device. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_outputs_bulk_requests_errored_total + description: Total number of bulk requests that encountered errors during processing. + parameters: + type: object + properties: + output: + type: array + items: + type: string + description: Represents the data or result produced by a system or process. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + application: + type: array + items: + type: string + description: Refers to a software program or group of programs designed + for end-users. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_outputs_bulk_requests_total + description: Total number of bulk requests processed by the output system in the + network. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + application: + type: array + items: + type: string + description: Refers to a software program or group of programs designed + for end-users. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + output: + type: array + items: + type: string + description: Represents the data or result produced by a system or process. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_outputs_records_errored_rate + description: Measures the rate of errored records outputted by a system or network + process. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + application: + type: array + items: + type: string + description: Refers to a software program or group of programs designed + for end-users. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + output: + type: array + items: + type: string + description: Represents the data or result produced by a system or process. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_outputs_records_errored_total + description: Total number of records that encountered errors during output processing + in the network. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + application: + type: array + items: + type: string + description: Refers to a software program or group of programs designed + for end-users. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + output: + type: array + items: + type: string + description: Represents the data or result produced by a system or process. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_outputs_records_received_total + description: Total number of records received by the output system in the network. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + application: + type: array + items: + type: string + description: Refers to a software program or group of programs designed + for end-users. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + output: + type: array + items: + type: string + description: Represents the data or result produced by a system or process. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_outputs_records_sent_rate + description: Measures the rate at which records are sent from the output system + in the network. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + application: + type: array + items: + type: string + description: Refers to a software program or group of programs designed + for end-users. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + output: + type: array + items: + type: string + description: Represents the data or result produced by a system or process. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_outputs_records_sent_total + description: Total number of records successfully sent by the output component + in the network. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + application: + type: array + items: + type: string + description: Refers to a software program or group of programs designed + for end-users. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + output: + type: array + items: + type: string + description: Represents the data or result produced by a system or process. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_port_flows_gibytes + description: Measures the volume of data in gibibytes flowing through a specific + network port. + parameters: + type: object + properties: + service_name: + type: array + items: + type: string + description: Identifies the name of the service associated with a network + connection or transaction. + description: + type: array + items: + type: string + description: Provides a brief explanation or details about a specific network + metric or component. + transport_protocol: + type: array + items: + type: string + description: Specifies the protocol used for data transmission, such as + TCP or UDP. + dst_port: + type: array + items: + type: string + description: Indicates the destination port number used in a network communication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_server_host_gibytes + description: Represents the amount of memory in gibibytes available on the server + host. + parameters: + type: object + properties: + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_udp_server_bytes_received_total + description: Total number of bytes received by the UDP server over the network. + parameters: + type: object + properties: + port: + type: array + items: + type: string + description: Identifies the communication endpoint for network services + using a numerical label. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + application: + type: array + items: + type: string + description: Refers to a software program or group of programs designed + for end-users. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_udp_server_packet_queue_util + description: Measures the utilization of the packet queue on a UDP server to ensure + efficient data handling. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + application: + type: array + items: + type: string + description: Refers to a software program or group of programs designed + for end-users. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_udp_server_packets_received_total + description: Total number of packets received by the UDP server over a given period. + parameters: + type: object + properties: + port: + type: array + items: + type: string + description: Identifies the communication endpoint for network services + using a numerical label. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + application: + type: array + items: + type: string + description: Refers to a software program or group of programs designed + for end-users. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_udp_server_rx_bps + description: Measures the rate of incoming data in bits per second on a UDP server. + parameters: + type: object + properties: + port: + type: array + items: + type: string + description: Identifies the communication endpoint for network services + using a numerical label. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + application: + type: array + items: + type: string + description: Refers to a software program or group of programs designed + for end-users. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_udp_server_rx_pps + description: Measures the packets per second received by a UDP server, indicating + network traffic load. + parameters: + type: object + properties: + port: + type: array + items: + type: string + description: Identifies the communication endpoint for network services + using a numerical label. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + application: + type: array + items: + type: string + description: Refers to a software program or group of programs designed + for end-users. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_cpu_interrupt_cycles_5 + description: A metric that measures the number of CPU interrupt cycles for a specific + time period. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_cpu_iowait_cycles_5 + description: Measures the percentage of CPU cycles spent waiting for I/O operations + over 5 minutes. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_cpu_saturation_1 + description: Measures the level of CPU usage saturation on a network device or + server. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_cpu_saturation_15 + description: Measures CPU saturation over a 15-minute interval to assess processing + load and performance. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_cpu_saturation_5 + description: Measures the CPU saturation level over a 5-minute interval, indicating + potential performance issues. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_cpu_steal_cycles_5 + description: Measures the percentage of CPU cycles stolen by the hypervisor over + a 5-minute interval. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_cpu_system_cycles_5 + description: Represents the number of CPU system cycles over a 5-minute interval. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_cpu_user_cycles_5 + description: Measures the number of CPU cycles used by user processes over a 5-minute + interval. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_cpu_utilization_1 + description: Measures the percentage of CPU resources being used by a device or + system. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_cpu_utilization_15 + description: Represents the average CPU utilization over a 15-minute interval + on a network device. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_cpu_utilization_5 + description: Represents the CPU utilization percentage over a 5-minute interval. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_boot_time_seconds + description: Represents the time in seconds since the network node last booted. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_cpu_count + description: Represents the total number of CPU cores available on a network node. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_cpu_guest_seconds_total + description: Total time spent by the CPU in guest mode, measured in seconds. + parameters: + type: object + properties: + cpu: + type: array + items: + type: string + description: Represents the central processing unit (CPU) of a device or + system. + mode: + type: array + items: + type: string + description: Specifies the operational mode or state of a network or system + component. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_cpu_seconds_total + description: Total seconds the CPU has spent in various states, like user, system, + and idle. + parameters: + type: object + properties: + cpu: + type: array + items: + type: string + description: Represents the central processing unit (CPU) of a device or + system. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + mode: + type: array + items: + type: string + description: Specifies the operational mode or state of a network or system + component. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_disk_io_time_seconds_total + description: Total time in seconds spent on input/output operations for a disk + node. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + device: + type: array + items: + type: string + description: A network device such as a router or switch. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_disk_read_bytes_total + description: Total number of bytes read from disk by the node over time. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + device: + type: array + items: + type: string + description: A network device such as a router or switch. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_disk_reads_completed_total + description: Total number of completed read operations on a nodes disk. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + device: + type: array + items: + type: string + description: A network device such as a router or switch. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_disk_writes_completed_total + description: Total number of completed disk write operations on a node. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + device: + type: array + items: + type: string + description: A network device such as a router or switch. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_disk_written_bytes_total + description: Total number of bytes written to disk by a node over a specified + period. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + device: + type: array + items: + type: string + description: A network device such as a router or switch. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_filefd_allocated + description: Represents the number of file descriptors currently allocated on + a network node. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_filefd_maximum + description: Represents the maximum number of file descriptors that a node can + open simultaneously. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_filesystem_avail_bytes + description: Represents the available bytes in the filesystem of a network node. + parameters: + type: object + properties: + mountpoint: + type: array + items: + type: string + description: Specifies the directory where a filesystem is mounted in the + network. + fstype: + type: array + items: + type: string + description: Indicates the type of filesystem used in the network environment. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + device: + type: array + items: + type: string + description: A network device such as a router or switch. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_filesystem_files + description: Represents the number of files on a nodes filesystem, indicating + storage usage and capacity. + parameters: + type: object + properties: + fstype: + type: array + items: + type: string + description: Indicates the type of filesystem used in the network environment. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + device: + type: array + items: + type: string + description: A network device such as a router or switch. + mountpoint: + type: array + items: + type: string + description: Specifies the directory where a filesystem is mounted in the + network. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_filesystem_files_free + description: Represents the number of free inodes available on a filesystem in + a network node. + parameters: + type: object + properties: + fstype: + type: array + items: + type: string + description: Indicates the type of filesystem used in the network environment. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + device: + type: array + items: + type: string + description: A network device such as a router or switch. + mountpoint: + type: array + items: + type: string + description: Specifies the directory where a filesystem is mounted in the + network. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_filesystem_free_bytes + description: Represents the amount of free space available in bytes on a nodes + filesystem. + parameters: + type: object + properties: + fstype: + type: array + items: + type: string + description: Indicates the type of filesystem used in the network environment. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + device: + type: array + items: + type: string + description: A network device such as a router or switch. + mountpoint: + type: array + items: + type: string + description: Specifies the directory where a filesystem is mounted in the + network. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_filesystem_size_bytes + description: Represents the total size of the filesystem in bytes on a network + node. + parameters: + type: object + properties: + fstype: + type: array + items: + type: string + description: Indicates the type of filesystem used in the network environment. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + device: + type: array + items: + type: string + description: A network device such as a router or switch. + mountpoint: + type: array + items: + type: string + description: Specifies the directory where a filesystem is mounted in the + network. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_load1 + description: Represents the average system load over one minute on a network node. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_load15 + description: Represents the average system load over the last 15 minutes on a + network node. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_load5 + description: Represents the average system load over the last five minutes on + a network node. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_memory_Buffers_bytes + description: Represents the amount of memory allocated for buffer cache in bytes + on a node. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_memory_Cached_bytes + description: Represents the amount of memory in bytes used for caching by the + node. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_memory_MemAvailable_bytes + description: Represents the amount of available memory in bytes on a network node. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_memory_MemFree_bytes + description: Represents the amount of free memory available on a node in bytes. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_memory_MemTotal_bytes + description: Represents the total amount of physical memory available on a node + in bytes. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_memory_SwapFree_bytes + description: Represents the amount of free swap memory available on a node in + bytes. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_memory_SwapTotal_bytes + description: Total amount of swap memory available on the node, measured in bytes. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_memory_usage + description: Represents the amount of memory being used by a specific node in + the network. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_memory_user_space_application + description: Tracks memory usage by user space applications on a network node. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_network_receive_bytes_total + description: Total number of bytes received over the network interface on a node. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + device: + type: array + items: + type: string + description: A network device such as a router or switch. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_network_transmit_bytes_total + description: Total number of bytes transmitted over the network interface by the + node. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + device: + type: array + items: + type: string + description: A network device such as a router or switch. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_network_transmit_error_rate + description: Measures the rate of errors occurring during data transmission on + a network node. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + device: + type: array + items: + type: string + description: A network device such as a router or switch. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_root_fs_usage_break_down + description: Provides a detailed breakdown of the root filesystem usage on a network + node. + parameters: + type: object + properties: + fstype: + type: array + items: + type: string + description: Indicates the type of filesystem used in the network environment. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + device: + type: array + items: + type: string + description: A network device such as a router or switch. + mountpoint: + type: array + items: + type: string + description: Specifies the directory where a filesystem is mounted in the + network. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_root_fs_used + description: Represents the amount of used space on the root filesystem of a node. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + device: + type: array + items: + type: string + description: A network device such as a router or switch. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_time_seconds + description: Represents the current time in seconds since the epoch for a network + node. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_up_time + description: Represents the duration for which a network node has been continuously + operational. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_nodemon_cpu_status + description: A label indicating the CPU status of the node monitoring process. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_nodemon_filesystem_status + description: Monitors the status and health of the filesystem in a network node. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_nodemon_health + description: Monitors the health and status of Nodemon processes in the network + environment. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_nodemon_health_by_kpi + description: Monitors the health of network nodes based on key performance indicators + (KPIs). + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_nodemon_memory_status + description: Monitors the memory usage and status of the Nodemon process in the + network. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_nodemon_network_status + description: Monitors and reports the current status and performance of the network + nodes. + parameters: + type: object + properties: + node: + type: array + items: + type: string + description: A node in the Elasticsearch cluster. + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_asn_status + description: Indicates the status of an Autonomous System Number (ASN) in the + routing table. + parameters: + type: object + properties: + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + origin_as: + type: array + items: + type: string + description: Identifies the origin Autonomous System Number (ASN) of a route + in the routing table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_asn_updates + description: Tracks the number of updates for a specific Autonomous System Number + (ASN) in the network. + parameters: + type: object + properties: + peer_address: + type: array + items: + type: string + description: The IP address of a peer in a network connection. + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_router_name: + type: array + items: + type: string + description: The name of the router associated with a network peer. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + asn: + type: array + items: + type: string + description: An Autonomous System Number (ASN) used to identify a network + on the internet. + peer_router_address: + type: array + items: + type: string + description: The IP address of the router associated with a network peer. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_asn_v4_prefixes + description: Represents the IPv4 prefixes associated with a specific Autonomous + System Number (ASN). + parameters: + type: object + properties: + asn: + type: array + items: + type: string + description: An Autonomous System Number (ASN) used to identify a network + on the internet. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_asn_v4_with_irr + description: Represents IPv4 Autonomous System Numbers with Internet Routing Registry + (IRR) data. + parameters: + type: object + properties: + asn: + type: array + items: + type: string + description: An Autonomous System Number (ASN) used to identify a network + on the internet. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_asn_v4_with_rpki + description: Validates IPv4 Autonomous System Numbers (ASN) using Resource Public + Key Infrastructure (RPKI) for security. + parameters: + type: object + properties: + asn: + type: array + items: + type: string + description: An Autonomous System Number (ASN) used to identify a network + on the internet. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_asn_v6_prefixes + description: Represents the IPv6 prefixes associated with a specific Autonomous + System Number (ASN). + parameters: + type: object + properties: + asn: + type: array + items: + type: string + description: An Autonomous System Number (ASN) used to identify a network + on the internet. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_asn_v6_with_irr + description: Represents IPv6 Autonomous System Numbers (ASN) with Internet Routing + Registry (IRR) data. + parameters: + type: object + properties: + asn: + type: array + items: + type: string + description: An Autonomous System Number (ASN) used to identify a network + on the internet. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_asn_v6_with_rpki + description: Represents IPv6 Autonomous System Numbers validated with Resource + Public Key Infrastructure (RPKI). + parameters: + type: object + properties: + asn: + type: array + items: + type: string + description: An Autonomous System Number (ASN) used to identify a network + on the internet. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_asn_withdraws + description: Tracks the number of times an Autonomous System Number (ASN) is withdrawn + from the network. + parameters: + type: object + properties: + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_address: + type: array + items: + type: string + description: The IP address of a peer in a network connection. + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_router_name: + type: array + items: + type: string + description: The name of the router associated with a network peer. + asn: + type: array + items: + type: string + description: An Autonomous System Number (ASN) used to identify a network + on the internet. + peer_router_address: + type: array + items: + type: string + description: The IP address of the router associated with a network peer. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_known_dup_prefixes + description: Represents the number of duplicate prefixes known in the network + routing table. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + peer_asn: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of a peer in a BGP session. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_known_dup_withdraws + description: Tracks the number of duplicate BGP route withdrawals detected in + the network. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_asn: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of a peer in a BGP session. + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_l3vpn_asn_updates + description: Tracks updates to Autonomous System Numbers (ASN) in Layer 3 VPN + configurations. + parameters: + type: object + properties: + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_address: + type: array + items: + type: string + description: The IP address of a peer in a network connection. + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_router_name: + type: array + items: + type: string + description: The name of the router associated with a network peer. + asn: + type: array + items: + type: string + description: An Autonomous System Number (ASN) used to identify a network + on the internet. + peer_router_address: + type: array + items: + type: string + description: The IP address of the router associated with a network peer. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_l3vpn_asn_withdraws + description: Tracks the number of ASN withdrawals in Layer 3 VPNs within the network. + parameters: + type: object + properties: + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_address: + type: array + items: + type: string + description: The IP address of a peer in a network connection. + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_router_name: + type: array + items: + type: string + description: The name of the router associated with a network peer. + asn: + type: array + items: + type: string + description: An Autonomous System Number (ASN) used to identify a network + on the internet. + peer_router_address: + type: array + items: + type: string + description: The IP address of the router associated with a network peer. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_l3vpn_peer_advertise_avg + description: Average rate at which L3VPN peers advertise routes in the network. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_l3vpn_peer_advertise_max + description: Specifies the maximum number of routes a peer can advertise in an + L3VPN. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_l3vpn_peer_advertise_min + description: Minimum time interval for advertising routes to peers in an L3VPN + environment. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_l3vpn_peer_rd_updates + description: Tracks the updates of route distinguishers for L3VPN peers in the + network. + parameters: + type: object + properties: + rd: + type: array + items: + type: string + description: A route distinguisher is used to uniquely identify routes in + a VPN. + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_l3vpn_peer_rd_withdraws + description: Tracks the number of route distinguisher withdrawals from L3VPN peers + in the network. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + rd: + type: array + items: + type: string + description: A route distinguisher is used to uniquely identify routes in + a VPN. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_l3vpn_peer_updates + description: Tracks updates and changes in Layer 3 VPN peer connections within + the network. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_l3vpn_peer_v4_prefixes + description: Represents the IPv4 prefixes associated with a Layer 3 VPN peer in + the network. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_l3vpn_peer_v6_prefixes + description: Represents the IPv6 prefixes associated with a Layer 3 VPN peer in + the network. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_l3vpn_peer_withdraw_avg + description: Average number of peer withdrawals in Layer 3 VPN connections over + a specified period. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_l3vpn_peer_withdraw_max + description: Represents the maximum number of peer withdrawals in an L3VPN network + session. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_l3vpn_peer_withdraw_min + description: Represents the minimum time taken for a peer to withdraw from an + L3VPN session. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_l3vpn_peer_withdraws + description: Tracks the number of L3VPN peer withdrawals in the network, indicating + potential connectivity issues. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_l3vpn_rib_size + description: Represents the size of the Routing Information Base (RIB) for Layer + 3 VPNs. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_num_routes_adj_rib_in + description: Represents the number of routes received from peers in the Adj-RIB-In + table. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_asn: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of a peer in a BGP session. + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_num_routes_local_rib + description: Represents the number of routes stored in the local Routing Information + Base (RIB). + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_asn: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of a peer in a BGP session. + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_peer_advertise_avg + description: Represents the average time taken for peers to advertise routes in + the network. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_peer_advertise_max + description: Specifies the maximum number of routes a peer can advertise in a + network. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_peer_advertise_min + description: Specifies the minimum time interval for advertising routes to a peer + in a network. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_peer_count + description: Represents the number of peers connected to a network device or system. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_peer_downs_in_a_day + description: Counts the number of times a network peer connection goes down within + a day. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_peer_status + description: Represents the current operational status of a network peer connection. + parameters: + type: object + properties: + is_peer_vpn: + type: array + items: + type: string + description: Indicates whether the peer connection is established over a + VPN. + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_peer_updates + description: Tracks changes and updates in the status of network peers over time. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_peer_v4_prefixes + description: Represents the IPv4 prefixes exchanged between BGP peers in a network. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_peer_v6_prefixes + description: Represents the IPv6 prefixes associated with a network peer in a + routing table. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_peer_withdraw_avg + description: Represents the average number of peer withdrawals in a given time + period. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_peer_withdraw_max + description: Represents the maximum number of peer withdrawals in a given time + period. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_peer_withdraw_min + description: Represents the minimum time taken for a peer to withdraw a route + in the network. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_peer_withdraws + description: Tracks the number of BGP peer withdrawals from the routing table. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_hash_id: + type: array + items: + type: string + description: A unique hash identifier for a network peer. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prefix_as_path_changed + description: Tracks changes in the AS path for a specific network prefix. + parameters: + type: object + properties: + peer_alias: + type: array + items: + type: string + description: A human-readable name assigned to a network peer for easier + identification. + prefix: + type: array + items: + type: string + description: A network prefix represents a range of IP addresses in routing + tables. + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + description: + type: array + items: + type: string + description: Provides a brief explanation or details about a specific network + metric or component. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + origin_as: + type: array + items: + type: string + description: Identifies the origin Autonomous System Number (ASN) of a route + in the routing table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prefix_as_path_count_changed + description: Tracks changes in the count of AS paths for a specific network prefix. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + description: + type: array + items: + type: string + description: Provides a brief explanation or details about a specific network + metric or component. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + prefix: + type: array + items: + type: string + description: A network prefix represents a range of IP addresses in routing + tables. + origin_as: + type: array + items: + type: string + description: Identifies the origin Autonomous System Number (ASN) of a route + in the routing table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_alias: + type: array + items: + type: string + description: A human-readable name assigned to a network peer for easier + identification. + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prefix_communities_changed + description: Tracks changes in the community attributes of network prefixes in + routing tables. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + description: + type: array + items: + type: string + description: Provides a brief explanation or details about a specific network + metric or component. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + prefix: + type: array + items: + type: string + description: A network prefix represents a range of IP addresses in routing + tables. + origin_as: + type: array + items: + type: string + description: Identifies the origin Autonomous System Number (ASN) of a route + in the routing table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_alias: + type: array + items: + type: string + description: A human-readable name assigned to a network peer for easier + identification. + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prefix_local_pref_changed + description: Indicates a change in the local preference value for a specific network + prefix. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + description: + type: array + items: + type: string + description: Provides a brief explanation or details about a specific network + metric or component. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + prefix: + type: array + items: + type: string + description: A network prefix represents a range of IP addresses in routing + tables. + origin_as: + type: array + items: + type: string + description: Identifies the origin Autonomous System Number (ASN) of a route + in the routing table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_alias: + type: array + items: + type: string + description: A human-readable name assigned to a network peer for easier + identification. + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prefix_med_changed + description: Indicates a change in the Multi-Exit Discriminator (MED) value for + a network prefix. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + description: + type: array + items: + type: string + description: Provides a brief explanation or details about a specific network + metric or component. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + prefix: + type: array + items: + type: string + description: A network prefix represents a range of IP addresses in routing + tables. + origin_as: + type: array + items: + type: string + description: Identifies the origin Autonomous System Number (ASN) of a route + in the routing table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_alias: + type: array + items: + type: string + description: A human-readable name assigned to a network peer for easier + identification. + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prefix_nh_changed + description: Indicates a change in the next-hop for a specific network prefix + in the routing table. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + description: + type: array + items: + type: string + description: Provides a brief explanation or details about a specific network + metric or component. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + prefix: + type: array + items: + type: string + description: A network prefix represents a range of IP addresses in routing + tables. + origin_as: + type: array + items: + type: string + description: Identifies the origin Autonomous System Number (ASN) of a route + in the routing table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_alias: + type: array + items: + type: string + description: A human-readable name assigned to a network peer for easier + identification. + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prefix_origin_as_changed + description: Detects changes in the origin Autonomous System (AS) for a given + IP prefix. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + description: + type: array + items: + type: string + description: Provides a brief explanation or details about a specific network + metric or component. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + prefix: + type: array + items: + type: string + description: A network prefix represents a range of IP addresses in routing + tables. + origin_as: + type: array + items: + type: string + description: Identifies the origin Autonomous System Number (ASN) of a route + in the routing table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_alias: + type: array + items: + type: string + description: A human-readable name assigned to a network peer for easier + identification. + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prefix_status + description: Indicates the current status and reachability of a network prefix + in the routing table. + parameters: + type: object + properties: + violation: + type: array + items: + type: string + description: Represents a breach of network policy or protocol, requiring + attention or remediation. + description: + type: array + items: + type: string + description: Provides a brief explanation or details about a specific network + metric or component. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + prefix: + type: array + items: + type: string + description: A network prefix represents a range of IP addresses in routing + tables. + origin_as: + type: array + items: + type: string + description: Identifies the origin Autonomous System Number (ASN) of a route + in the routing table. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prefix_updates_count + description: Counts the number of prefix updates received in the network routing + table. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + description: + type: array + items: + type: string + description: Provides a brief explanation or details about a specific network + metric or component. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + prefix: + type: array + items: + type: string + description: A network prefix represents a range of IP addresses in routing + tables. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_alias: + type: array + items: + type: string + description: A human-readable name assigned to a network peer for easier + identification. + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prefix_withdrawn + description: Indicates the withdrawal of a network prefix from the routing table. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + description: + type: array + items: + type: string + description: Provides a brief explanation or details about a specific network + metric or component. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + prefix: + type: array + items: + type: string + description: A network prefix represents a range of IP addresses in routing + tables. + origin_as: + type: array + items: + type: string + description: Identifies the origin Autonomous System Number (ASN) of a route + in the routing table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_alias: + type: array + items: + type: string + description: A human-readable name assigned to a network peer for easier + identification. + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prefix_withdraws_count + description: Counts the number of prefix withdrawals in a network routing table. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + description: + type: array + items: + type: string + description: Provides a brief explanation or details about a specific network + metric or component. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + prefix: + type: array + items: + type: string + description: A network prefix represents a range of IP addresses in routing + tables. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_alias: + type: array + items: + type: string + description: A human-readable name assigned to a network peer for easier + identification. + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_prefixes_rejected + description: Counts the number of network prefixes rejected by routing policies + or filters. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_asn: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of a peer in a BGP session. + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_rib_size + description: Represents the size of the Routing Information Base (RIB) in a network + device. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_router_count + description: Represents the total number of routers present in the network infrastructure. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_router_status + description: Indicates the operational status of a network router within the infrastructure. + parameters: + type: object + properties: + init_data: + type: array + items: + type: string + description: Represents the initial data collected or transmitted at the + start of a session. + term_data: + type: array + items: + type: string + description: Represents the data collected or transmitted at the end of + a session. + term_reason_text: + type: array + items: + type: string + description: Provides a textual explanation for the termination of a network + session. + term_reason_code: + type: array + items: + type: string + description: Numerical code indicating the reason for the termination of + a network session. + ispassive: + type: array + items: + type: string + description: Indicates whether a network device or session is operating + in a passive mode. + ip_address: + type: array + items: + type: string + description: Numerical label assigned to each device connected to a computer + network using IP. + collector_hash_id: + type: array + items: + type: string + description: Unique identifier for a data collector in the network, represented + as a hash. + router_as: + type: array + items: + type: string + description: Autonomous System number associated with a specific network + router. + bgp_id: + type: array + items: + type: string + description: Identifier for a BGP (Border Gateway Protocol) instance or + session. + geo_ip_start: + type: array + items: + type: string + description: Starting IP address for a geographical IP range used in network + routing. + hash_id: + type: array + items: + type: string + description: Unique identifier represented as a hash for tracking or referencing + purposes. + description: + type: array + items: + type: string + description: Provides a brief explanation or details about a specific network + metric or component. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + name: + type: array + items: + type: string + description: A label that identifies the name of a resource or object within + a system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_router_status_from_peers + description: Shows the status and connectivity of a router as reported by its + network peers. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_updates_invalid_by_as_confed_loop + description: Counts the number of BGP updates invalidated due to AS confederation + loop detection. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_asn: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of a peer in a BGP session. + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_updates_invalid_by_as_path_loop + description: Counts the number of routing updates invalidated due to AS path loops. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_asn: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of a peer in a BGP session. + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_updates_invalid_by_cluster_list + description: Lists the invalid updates received by each cluster in the network. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_asn: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of a peer in a BGP session. + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_updates_invalid_by_originator_id + description: Counts the number of invalid routing updates identified by their + originator ID. + parameters: + type: object + properties: + router_name: + type: array + items: + type: string + description: The identifier or name assigned to a specific network router. + as_name: + type: array + items: + type: string + description: Represents the name of an Autonomous System (AS) in the routing + table. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + peer_asn: + type: array + items: + type: string + description: The Autonomous System Number (ASN) of a peer in a BGP session. + peer_name: + type: array + items: + type: string + description: The designated name of a peer in a network connection. + peer_ip: + type: array + items: + type: string + description: The IP address of a peer device in a network connection. + router_ip: + type: array + items: + type: string + description: The IP address assigned to a network router for communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_optics_status_by_kpi + description: A metric label that tracks the status of optics based on key performance + indicators (KPIs) for network performance monitoring. + parameters: + type: object + properties: + version: + type: array + items: + type: string + description: The software version of a network device or application. + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + os: + type: array + items: + type: string + description: The operating system running on a network device. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_transceiver_rx_laser_power + description: Measures the received laser power level in a transceiver for optical + communication. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_transceiver_rx_laser_power_low_alarm_threshold + description: Threshold indicating low alarm for received laser power in a transceiver + module. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_transceiver_rx_laser_power_low_threshold_status + description: Indicates if the received laser power is below the low threshold + in a transceiver. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_transceiver_temperature + description: Monitors the temperature of optical transceivers to ensure optimal + performance and prevent overheating. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_transceiver_temperature_high_warning_threshold + description: Specifies the temperature limit at which a warning is triggered for + a transceiver module. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_transceiver_temperature_status + description: Monitors the temperature status of network transceivers to ensure + optimal performance. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_transceiver_tx_laser_power + description: Measures the output power of the laser in a transceivers transmission + module. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_transceiver_tx_laser_power_low_alarm_threshold + description: Specifies the minimum laser power level for transmission before triggering + a low alarm. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_transceiver_tx_laser_power_low_threshold_status + description: Indicates if the transmit laser power of a transceiver is below the + low threshold. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_ospf_admin_stat + description: Indicates the administrative status of OSPF protocol. + parameters: + type: object + properties: + ospf_as_bdr_rtr_status: + type: array + items: + type: string + description: Represents the status of OSPF border router. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + os: + type: array + items: + type: string + description: The operating system running on a network device. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_ospf_area_bdr_rtr_count + description: Counts the number of Backup Designated Routers (BDR) in a specific + OSPF area. + parameters: + type: object + properties: + ospf_area_id: + type: array + items: + type: string + description: Identifies the unique ID assigned to a specific OSPF area within + the network. + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_ospf_area_lsa_count + description: Represents the number of Link State Advertisements (LSAs) in a specific + OSPF area. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + ospf_area_id: + type: array + items: + type: string + description: Identifies the unique ID assigned to a specific OSPF area within + the network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_ospf_as_bdr_rtr_count + description: Counts the number of OSPF routers acting as Backup Designated Routers + in an area. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + ospf_area_id: + type: array + items: + type: string + description: Identifies the unique ID assigned to a specific OSPF area within + the network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_ospf_extern_lsa_count + description: Counts the number of external Link State Advertisements (LSAs) in + an OSPF network. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + ospf_as_bdr_rtr_status: + type: array + items: + type: string + description: Represents the status of OSPF border router. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_ospf_if_admin_stat + description: Shows the administrative status of an OSPF interface, whether it + is up or down. + parameters: + type: object + properties: + ospf_if_area_id: + type: array + items: + type: string + description: Identifies the OSPF area to which the interface belongs. + ospf_if_ip_address: + type: array + items: + type: string + description: Displays the IP address assigned to the OSPF interface. + ospf_if_type: + type: array + items: + type: string + description: Specifies the type of OSPF interface, such as broadcast or + point-to-point. + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_ospf_if_down + description: Indicates that an OSPF interface is currently down or not operational. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + ospf_if_type: + type: array + items: + type: string + description: Specifies the type of OSPF interface, such as broadcast or + point-to-point. + ospf_if_area_id: + type: array + items: + type: string + description: Identifies the OSPF area to which the interface belongs. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + ospf_if_ip_address: + type: array + items: + type: string + description: Displays the IP address assigned to the OSPF interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_ospf_if_events_rate + description: Measures the rate of interface events in the OSPF protocol on the + network. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + ospf_if_type: + type: array + items: + type: string + description: Specifies the type of OSPF interface, such as broadcast or + point-to-point. + ospf_if_area_id: + type: array + items: + type: string + description: Identifies the OSPF area to which the interface belongs. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + ospf_if_ip_address: + type: array + items: + type: string + description: Displays the IP address assigned to the OSPF interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_ospf_if_state + description: Represents the current state of an OSPF interface in the network + topology. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + ospf_if_type: + type: array + items: + type: string + description: Specifies the type of OSPF interface, such as broadcast or + point-to-point. + ospf_if_area_id: + type: array + items: + type: string + description: Identifies the OSPF area to which the interface belongs. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + ospf_if_ip_address: + type: array + items: + type: string + description: Displays the IP address assigned to the OSPF interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_ospf_if_status + description: Represents the operational status of an OSPF interface within the + network. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + ospf_if_type: + type: array + items: + type: string + description: Specifies the type of OSPF interface, such as broadcast or + point-to-point. + ospf_if_area_id: + type: array + items: + type: string + description: Identifies the OSPF area to which the interface belongs. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + ospf_if_ip_address: + type: array + items: + type: string + description: Displays the IP address assigned to the OSPF interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_ospf_nbr_down + description: Indicates that an OSPF neighbor is currently down or unreachable. + parameters: + type: object + properties: + ospf_nbr_ip_addr: + type: array + items: + type: string + description: Represents the IP address of an OSPF neighbor in the network. + ospf_nbr_rtr_id: + type: array + items: + type: string + description: Denotes the router ID of an OSPF neighbor in the network. + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_ospf_nbr_events + description: Tracks events related to OSPF neighbor relationships and their state + changes. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + ospf_nbr_ip_addr: + type: array + items: + type: string + description: Represents the IP address of an OSPF neighbor in the network. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + ospf_nbr_rtr_id: + type: array + items: + type: string + description: Denotes the router ID of an OSPF neighbor in the network. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_ospf_nbr_events_rate + description: Measures the rate of OSPF neighbor events occurring within the network. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + ospf_nbr_ip_addr: + type: array + items: + type: string + description: Represents the IP address of an OSPF neighbor in the network. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + ospf_nbr_rtr_id: + type: array + items: + type: string + description: Denotes the router ID of an OSPF neighbor in the network. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_ospf_nbr_state + description: Represents the current state of OSPF neighbors in the network topology. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + ospf_nbr_ip_addr: + type: array + items: + type: string + description: Represents the IP address of an OSPF neighbor in the network. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + ospf_nbr_rtr_id: + type: array + items: + type: string + description: Denotes the router ID of an OSPF neighbor in the network. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + if_name: + type: array + items: + type: string + description: The name of an interface on a network device. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_ospf_originate_new_lsas + description: Tracks the origination of new Link State Advertisements (LSAs) in + an OSPF network. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + ospf_as_bdr_rtr_status: + type: array + items: + type: string + description: Represents the status of OSPF border router. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_ospf_rx_new_lsas + description: Tracks the number of new Link State Advertisements (LSAs) received + by OSPF routers. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + ospf_as_bdr_rtr_status: + type: array + items: + type: string + description: Represents the status of OSPF border router. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_ospf_spf_runs + description: Tracks the number of Shortest Path First (SPF) calculations performed + by OSPF routers. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + ospf_area_id: + type: array + items: + type: string + description: Identifies the unique ID assigned to a specific OSPF area within + the network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_ospf_spf_runs_rate + description: Measures the frequency of Shortest Path First (SPF) calculations + in an OSPF network. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + ospf_area_id: + type: array + items: + type: string + description: Identifies the unique ID assigned to a specific OSPF area within + the network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_ospf_status_by_kpi + description: Evaluates the performance and status of OSPF protocol using key performance + indicators. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_availability + description: A measure of the percentage of time a system or service is operational + and accessible to users. + parameters: + type: object + properties: + src_ipaddress6: + type: array + items: + type: string + description: Source IPv6 address of a network packet. + src_ipaddress: + type: array + items: + type: string + description: Source IPv4 address of a network packet. + src_suite: + type: array + items: + type: string + description: Source suite of a network packet. + pingmesh_type: + type: array + items: + type: string + description: Type of ping mesh used in network testing. + dst_cluster: + type: array + items: + type: string + description: Destination cluster of a network packet. + dst_ipaddress6: + type: array + items: + type: string + description: Destination IPv6 address of a network packet. + pingmesh_instance: + type: array + items: + type: string + description: Instance of a ping mesh used in network testing. + dst_suite: + type: array + items: + type: string + description: Destination suite of a network packet. + dst_rack: + type: array + items: + type: string + description: Destination rack of a network packet. + src_hostname: + type: array + items: + type: string + description: Source hostname of a network packet. + dst_site: + type: array + items: + type: string + description: Destination site of a network packet. + dst_hostname: + type: array + items: + type: string + description: Destination hostname of a network packet. + src_rack: + type: array + items: + type: string + description: Source rack of a network packet. + src_cluster: + type: array + items: + type: string + description: Source cluster of a network packet. + src_site: + type: array + items: + type: string + description: Source site of a network packet. + dst_ipaddress: + type: array + items: + type: string + description: Destination IPv4 address of a network packet. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_jitter + description: Measures the variation in packet arrival times in a network connection. + parameters: + type: object + properties: + src_lng: + type: array + items: + type: string + description: Represents the longitude of the source location in a network + connection. + src_port: + type: array + items: + type: string + description: Specifies the port number used by the source in a network communication. + dst_meshtype: + type: array + items: + type: string + description: Indicates the type of mesh network configuration at the destination. + dst_lng: + type: array + items: + type: string + description: Represents the longitude of the destination location in a network + connection. + dst_caption: + type: array + items: + type: string + description: Provides a descriptive label for the destination in a network + connection. + src_lat: + type: array + items: + type: string + description: Represents the latitude of the source location in a network + connection. + src_caption: + type: array + items: + type: string + description: Provides a descriptive label for the source in a network connection. + src_meshtype: + type: array + items: + type: string + description: Indicates the type of mesh network configuration at the source. + dst_lat: + type: array + items: + type: string + description: Represents the latitude of the destination location in a network + connection. + dst_cluster: + type: array + items: + type: string + description: Destination cluster of a network packet. + dst_tag2: + type: array + items: + type: string + description: Destination tag 2 of a network packet. + src_tag2: + type: array + items: + type: string + description: Source tag 2 of a network packet. + src_site: + type: array + items: + type: string + description: Source site of a network packet. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + src_state: + type: array + items: + type: string + description: Source state of a network packet. + dst_tag1: + type: array + items: + type: string + description: Destination tag 1 of a network packet. + src_ipaddress: + type: array + items: + type: string + description: Source IPv4 address of a network packet. + src_tag1: + type: array + items: + type: string + description: Source tag 1 of a network packet. + dst_suite: + type: array + items: + type: string + description: Destination suite of a network packet. + dst_continent: + type: array + items: + type: string + description: Destination continent of a network packet. + dst_hostname: + type: array + items: + type: string + description: Destination hostname of a network packet. + pingmesh_type: + type: array + items: + type: string + description: Type of ping mesh used in network testing. + src_country: + type: array + items: + type: string + description: Source country of a network packet. + src_rack: + type: array + items: + type: string + description: Source rack of a network packet. + dst_ipaddress6: + type: array + items: + type: string + description: Destination IPv6 address of a network packet. + pingmesh_instance: + type: array + items: + type: string + description: Instance of a ping mesh used in network testing. + src_suite: + type: array + items: + type: string + description: Source suite of a network packet. + dst_rack: + type: array + items: + type: string + description: Destination rack of a network packet. + dst_country: + type: array + items: + type: string + description: Destination country of a network packet. + src_city: + type: array + items: + type: string + description: Source city of a network packet. + src_hostname: + type: array + items: + type: string + description: Source hostname of a network packet. + dst_city: + type: array + items: + type: string + description: Destination city of a network packet. + src_continent: + type: array + items: + type: string + description: Source continent of a network packet. + src_cluster: + type: array + items: + type: string + description: Source cluster of a network packet. + dst_ipaddress: + type: array + items: + type: string + description: Destination IPv4 address of a network packet. + src_ipaddress6: + type: array + items: + type: string + description: Source IPv6 address of a network packet. + dst_state: + type: array + items: + type: string + description: Destination state of a network packet. + dst_port: + type: array + items: + type: string + description: Indicates the destination port number used in a network communication. + dst_site: + type: array + items: + type: string + description: Destination site of a network packet. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_latency + description: Measures the time taken for data to travel from source to destination + across the network. + parameters: + type: object + properties: + dst_cluster: + type: array + items: + type: string + description: Destination cluster of a network packet. + dst_tag2: + type: array + items: + type: string + description: Destination tag 2 of a network packet. + src_tag2: + type: array + items: + type: string + description: Source tag 2 of a network packet. + src_site: + type: array + items: + type: string + description: Source site of a network packet. + dst_lng: + type: array + items: + type: string + description: Represents the longitude of the destination location in a network + connection. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + src_state: + type: array + items: + type: string + description: Source state of a network packet. + dst_tag1: + type: array + items: + type: string + description: Destination tag 1 of a network packet. + src_ipaddress: + type: array + items: + type: string + description: Source IPv4 address of a network packet. + src_tag1: + type: array + items: + type: string + description: Source tag 1 of a network packet. + dst_suite: + type: array + items: + type: string + description: Destination suite of a network packet. + dst_continent: + type: array + items: + type: string + description: Destination continent of a network packet. + dst_hostname: + type: array + items: + type: string + description: Destination hostname of a network packet. + src_port: + type: array + items: + type: string + description: Specifies the port number used by the source in a network communication. + pingmesh_type: + type: array + items: + type: string + description: Type of ping mesh used in network testing. + src_country: + type: array + items: + type: string + description: Source country of a network packet. + src_lat: + type: array + items: + type: string + description: Represents the latitude of the source location in a network + connection. + src_rack: + type: array + items: + type: string + description: Source rack of a network packet. + dst_ipaddress6: + type: array + items: + type: string + description: Destination IPv6 address of a network packet. + pingmesh_instance: + type: array + items: + type: string + description: Instance of a ping mesh used in network testing. + src_suite: + type: array + items: + type: string + description: Source suite of a network packet. + dst_rack: + type: array + items: + type: string + description: Destination rack of a network packet. + dst_country: + type: array + items: + type: string + description: Destination country of a network packet. + src_city: + type: array + items: + type: string + description: Source city of a network packet. + src_caption: + type: array + items: + type: string + description: Provides a descriptive label for the source in a network connection. + src_hostname: + type: array + items: + type: string + description: Source hostname of a network packet. + dst_lat: + type: array + items: + type: string + description: Represents the latitude of the destination location in a network + connection. + dst_city: + type: array + items: + type: string + description: Destination city of a network packet. + src_continent: + type: array + items: + type: string + description: Source continent of a network packet. + src_cluster: + type: array + items: + type: string + description: Source cluster of a network packet. + dst_ipaddress: + type: array + items: + type: string + description: Destination IPv4 address of a network packet. + src_lng: + type: array + items: + type: string + description: Represents the longitude of the source location in a network + connection. + dst_meshtype: + type: array + items: + type: string + description: Indicates the type of mesh network configuration at the destination. + dst_caption: + type: array + items: + type: string + description: Provides a descriptive label for the destination in a network + connection. + src_ipaddress6: + type: array + items: + type: string + description: Source IPv6 address of a network packet. + src_meshtype: + type: array + items: + type: string + description: Indicates the type of mesh network configuration at the source. + dst_state: + type: array + items: + type: string + description: Destination state of a network packet. + dst_port: + type: array + items: + type: string + description: Indicates the destination port number used in a network communication. + dst_site: + type: array + items: + type: string + description: Destination site of a network packet. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_packet_loss_pct + description: Represents the percentage of data packets lost during transmission + over a network. + parameters: + type: object + properties: + dst_cluster: + type: array + items: + type: string + description: Destination cluster of a network packet. + dst_tag2: + type: array + items: + type: string + description: Destination tag 2 of a network packet. + src_tag2: + type: array + items: + type: string + description: Source tag 2 of a network packet. + src_site: + type: array + items: + type: string + description: Source site of a network packet. + dst_lng: + type: array + items: + type: string + description: Represents the longitude of the destination location in a network + connection. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + src_state: + type: array + items: + type: string + description: Source state of a network packet. + dst_tag1: + type: array + items: + type: string + description: Destination tag 1 of a network packet. + src_ipaddress: + type: array + items: + type: string + description: Source IPv4 address of a network packet. + src_tag1: + type: array + items: + type: string + description: Source tag 1 of a network packet. + dst_suite: + type: array + items: + type: string + description: Destination suite of a network packet. + dst_continent: + type: array + items: + type: string + description: Destination continent of a network packet. + dst_hostname: + type: array + items: + type: string + description: Destination hostname of a network packet. + src_port: + type: array + items: + type: string + description: Specifies the port number used by the source in a network communication. + pingmesh_type: + type: array + items: + type: string + description: Type of ping mesh used in network testing. + src_country: + type: array + items: + type: string + description: Source country of a network packet. + src_lat: + type: array + items: + type: string + description: Represents the latitude of the source location in a network + connection. + src_rack: + type: array + items: + type: string + description: Source rack of a network packet. + dst_ipaddress6: + type: array + items: + type: string + description: Destination IPv6 address of a network packet. + pingmesh_instance: + type: array + items: + type: string + description: Instance of a ping mesh used in network testing. + src_suite: + type: array + items: + type: string + description: Source suite of a network packet. + dst_rack: + type: array + items: + type: string + description: Destination rack of a network packet. + dst_country: + type: array + items: + type: string + description: Destination country of a network packet. + src_city: + type: array + items: + type: string + description: Source city of a network packet. + src_caption: + type: array + items: + type: string + description: Provides a descriptive label for the source in a network connection. + src_hostname: + type: array + items: + type: string + description: Source hostname of a network packet. + dst_lat: + type: array + items: + type: string + description: Represents the latitude of the destination location in a network + connection. + dst_city: + type: array + items: + type: string + description: Destination city of a network packet. + src_continent: + type: array + items: + type: string + description: Source continent of a network packet. + src_cluster: + type: array + items: + type: string + description: Source cluster of a network packet. + dst_ipaddress: + type: array + items: + type: string + description: Destination IPv4 address of a network packet. + src_lng: + type: array + items: + type: string + description: Represents the longitude of the source location in a network + connection. + dst_meshtype: + type: array + items: + type: string + description: Indicates the type of mesh network configuration at the destination. + dst_caption: + type: array + items: + type: string + description: Provides a descriptive label for the destination in a network + connection. + src_ipaddress6: + type: array + items: + type: string + description: Source IPv6 address of a network packet. + src_meshtype: + type: array + items: + type: string + description: Indicates the type of mesh network configuration at the source. + dst_state: + type: array + items: + type: string + description: Destination state of a network packet. + dst_port: + type: array + items: + type: string + description: Indicates the destination port number used in a network communication. + dst_site: + type: array + items: + type: string + description: Destination site of a network packet. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_packet_loss_pct_by_dst + description: Represents the percentage of packet loss for each destination in + the network. + parameters: + type: object + properties: + dst_hostname: + type: array + items: + type: string + description: Destination hostname of a network packet. + dst_lat: + type: array + items: + type: string + description: Represents the latitude of the destination location in a network + connection. + dst_lng: + type: array + items: + type: string + description: Represents the longitude of the destination location in a network + connection. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min +- type: function + function: + name: get_pingmesh_destinations + description: Lists the target destinations for network latency and connectivity + tests using pingmesh. + parameters: + type: object + properties: + src_hostname: + type: array + items: + type: string + description: Source hostname of a network packet. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + src_ipaddress: + type: array + items: + type: string + description: Source IPv4 address of a network packet. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_cpu_usage + description: Represents the percentage of CPU resources being utilized by a network + device or server. + parameters: + type: object + properties: + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_host_cpu_usage + description: Measures the percentage of CPU resources used by a host in the network. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_host_mem_usage_mb + description: Represents the memory usage in megabytes for a specific host in the + network. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_host_mem_usage_pct + description: Represents the percentage of memory usage on a host machine in the + network. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_host_rx_byte_rate + description: Measures the rate of incoming bytes received by a host over the network. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_host_rx_bytes + description: Represents the total number of bytes received by a host over the + network. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_host_rx_error_rate + description: Measures the rate of receive errors on a hosts network interface. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_host_rx_errors + description: Counts the number of receive errors on a network host, indicating + potential connectivity issues. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_host_rx_packet_rate + description: Measures the rate at which packets are received by a host on the + network. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_host_rx_packets + description: Counts the number of packets received by a host on the network interface. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_host_tx_byte_rate + description: Measures the rate of bytes transmitted from a host over the network + per second. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_host_tx_bytes + description: Represents the total number of bytes transmitted by a host over the + network. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_host_tx_error_rate + description: Measures the rate of transmission errors occurring on a network hosts + interface. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_host_tx_errors + description: Counts the number of transmission errors encountered by a host on + the network. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_host_tx_packet_rate + description: Measures the rate at which packets are transmitted from a host over + the network. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_host_tx_packets + description: Represents the number of packets transmitted by a host over the network. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_icmp_in_dest_unreachable + description: Counts incoming ICMP packets indicating a destination is unreachable + in the network. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_icmp_in_echo_replies + description: Counts the number of ICMP echo reply messages received by the network + device. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_icmp_in_echos + description: Counts the number of ICMP echo requests received by a network device. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_icmp_in_errors + description: Counts the number of ICMP packets that encountered errors during + processing. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_icmp_in_messages + description: Counts the number of incoming ICMP messages received by the network + device. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_icmp_in_time_exceeds + description: Counts the number of ICMP packets received with a Time Exceeded error + message. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_icmp_out_echo_replies + description: Counts the number of ICMP echo reply messages sent from the network + device. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_icmp_out_echos + description: Counts the number of ICMP echo requests sent from a network device. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_icmp_out_errors + description: Counts the number of ICMP packets that failed to be sent due to errors. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_icmp_out_messages + description: Counts the number of ICMP messages sent out from a network device. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_mem_usage + description: Represents the amount of memory currently being used by the system + or application. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_cluster_latency + description: Measures the time delay experienced between nodes within a cluster + in the network. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + pingmesh_instance: + type: array + items: + type: string + description: Instance of a ping mesh used in network testing. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_cluster_loss + description: Measures the data loss or connectivity issues within a cluster of + network nodes. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + pingmesh_instance: + type: array + items: + type: string + description: Instance of a ping mesh used in network testing. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_host_latency + description: Measures the time delay experienced between a node and its host in + the network. + parameters: + type: object + properties: + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + pingmesh_instance: + type: array + items: + type: string + description: Instance of a ping mesh used in network testing. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_host_loss + description: Measures the packet loss percentage between a network node and its + host. + parameters: + type: object + properties: + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + pingmesh_instance: + type: array + items: + type: string + description: Instance of a ping mesh used in network testing. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_rack_latency + description: Measures the time delay experienced between nodes and their respective + racks in a data center. + parameters: + type: object + properties: + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + pingmesh_instance: + type: array + items: + type: string + description: Instance of a ping mesh used in network testing. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_rack_loss + description: Measures the data loss or connectivity issues within a specific node + rack in the network. + parameters: + type: object + properties: + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + pingmesh_instance: + type: array + items: + type: string + description: Instance of a ping mesh used in network testing. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_site_latency + description: Measures the time delay experienced between a network node and a + specific site. + parameters: + type: object + properties: + pingmesh_instance: + type: array + items: + type: string + description: Instance of a ping mesh used in network testing. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_site_loss + description: Measures the packet loss percentage at a specific network node site. + parameters: + type: object + properties: + pingmesh_instance: + type: array + items: + type: string + description: Instance of a ping mesh used in network testing. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_suite_latency + description: Measures the time delay experienced by data packets within a node + suite in the network. + parameters: + type: object + properties: + pingmesh_instance: + type: array + items: + type: string + description: Instance of a ping mesh used in network testing. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_node_suite_loss + description: Measures the packet loss rate in a suite of network nodes. + parameters: + type: object + properties: + pingmesh_instance: + type: array + items: + type: string + description: Instance of a ping mesh used in network testing. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_num_go_routines + description: Represents the number of active goroutines running in a Go application. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_num_threads + description: Represents the number of concurrent threads running in a network + process or application. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_tcp_active_opens + description: Counts the number of times TCP connections have been actively opened + by a host. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_tcp_curr_established + description: Represents the current number of established TCP connections in the + network. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_tcp_in_errors + description: Counts the number of incoming TCP packets that contain errors in + the network. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_tcp_in_segs + description: Counts the number of incoming TCP segments received by the network + device. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_tcp_out_resets + description: Counts the number of TCP reset packets sent from the network device + to terminate connections. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_tcp_out_segs + description: Counts the number of TCP segments sent from a host to the network. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_tcp_passive_opens + description: Counts the number of times a TCP connection has been passively opened + by a server. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_traceroute_hopcount + description: Measures the number of hops a packet takes to reach its destination + in a network. + parameters: + type: object + properties: + tos: + type: array + items: + type: string + description: Type of Service (ToS) is a field in IP headers that specifies + the priority of packets. + dst_cluster: + type: array + items: + type: string + description: Destination cluster of a network packet. + dst_rack: + type: array + items: + type: string + description: Destination rack of a network packet. + dst_hostname: + type: array + items: + type: string + description: Destination hostname of a network packet. + src_ipaddress6: + type: array + items: + type: string + description: Source IPv6 address of a network packet. + src_site: + type: array + items: + type: string + description: Source site of a network packet. + pingmesh_type: + type: array + items: + type: string + description: Type of ping mesh used in network testing. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + src_ipaddress: + type: array + items: + type: string + description: Source IPv4 address of a network packet. + src_rack: + type: array + items: + type: string + description: Source rack of a network packet. + dst_ipaddress6: + type: array + items: + type: string + description: Destination IPv6 address of a network packet. + dst_suite: + type: array + items: + type: string + description: Destination suite of a network packet. + src_hostname: + type: array + items: + type: string + description: Source hostname of a network packet. + pingmesh_instance: + type: array + items: + type: string + description: Instance of a ping mesh used in network testing. + src_cluster: + type: array + items: + type: string + description: Source cluster of a network packet. + dst_site: + type: array + items: + type: string + description: Destination site of a network packet. + src_suite: + type: array + items: + type: string + description: Source suite of a network packet. + dst_ipaddress: + type: array + items: + type: string + description: Destination IPv4 address of a network packet. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_traceroute_hopcount_change + description: Detects changes in the number of hops in a traceroute path, indicating + network path alterations. + parameters: + type: object + properties: + dst_cluster: + type: array + items: + type: string + description: Destination cluster of a network packet. + dst_rack: + type: array + items: + type: string + description: Destination rack of a network packet. + dst_hostname: + type: array + items: + type: string + description: Destination hostname of a network packet. + src_ipaddress6: + type: array + items: + type: string + description: Source IPv6 address of a network packet. + src_site: + type: array + items: + type: string + description: Source site of a network packet. + pingmesh_type: + type: array + items: + type: string + description: Type of ping mesh used in network testing. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + src_ipaddress: + type: array + items: + type: string + description: Source IPv4 address of a network packet. + src_rack: + type: array + items: + type: string + description: Source rack of a network packet. + dst_ipaddress6: + type: array + items: + type: string + description: Destination IPv6 address of a network packet. + dst_suite: + type: array + items: + type: string + description: Destination suite of a network packet. + src_hostname: + type: array + items: + type: string + description: Source hostname of a network packet. + tos: + type: array + items: + type: string + description: Type of Service (ToS) is a field in IP headers that specifies + the priority of packets. + pingmesh_instance: + type: array + items: + type: string + description: Instance of a ping mesh used in network testing. + src_cluster: + type: array + items: + type: string + description: Source cluster of a network packet. + dst_site: + type: array + items: + type: string + description: Destination site of a network packet. + src_suite: + type: array + items: + type: string + description: Source suite of a network packet. + dst_ipaddress: + type: array + items: + type: string + description: Destination IPv4 address of a network packet. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_traceroute_path_hopcount + description: Measures the number of hops a packet takes to reach its destination + in a network. + parameters: + type: object + properties: + dst_cluster: + type: array + items: + type: string + description: Destination cluster of a network packet. + src_site: + type: array + items: + type: string + description: Source site of a network packet. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + src_ipaddress: + type: array + items: + type: string + description: Source IPv4 address of a network packet. + dst_suite: + type: array + items: + type: string + description: Destination suite of a network packet. + dst_hostname: + type: array + items: + type: string + description: Destination hostname of a network packet. + pingmesh_type: + type: array + items: + type: string + description: Type of ping mesh used in network testing. + src_rack: + type: array + items: + type: string + description: Source rack of a network packet. + dst_ipaddress6: + type: array + items: + type: string + description: Destination IPv6 address of a network packet. + tos: + type: array + items: + type: string + description: Type of Service (ToS) is a field in IP headers that specifies + the priority of packets. + pingmesh_instance: + type: array + items: + type: string + description: Instance of a ping mesh used in network testing. + src_suite: + type: array + items: + type: string + description: Source suite of a network packet. + dst_rack: + type: array + items: + type: string + description: Destination rack of a network packet. + src_hostname: + type: array + items: + type: string + description: Source hostname of a network packet. + src_cluster: + type: array + items: + type: string + description: Source cluster of a network packet. + dst_ipaddress: + type: array + items: + type: string + description: Destination IPv4 address of a network packet. + port: + type: array + items: + type: string + description: Identifies the communication endpoint for network services + using a numerical label. + src_ipaddress6: + type: array + items: + type: string + description: Source IPv6 address of a network packet. + dst_site: + type: array + items: + type: string + description: Destination site of a network packet. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_traceroute_path_partial + description: Represents a partial path of network hops identified during a traceroute + operation. + parameters: + type: object + properties: + dst_cluster: + type: array + items: + type: string + description: Destination cluster of a network packet. + src_site: + type: array + items: + type: string + description: Source site of a network packet. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + src_ipaddress: + type: array + items: + type: string + description: Source IPv4 address of a network packet. + dst_suite: + type: array + items: + type: string + description: Destination suite of a network packet. + dst_hostname: + type: array + items: + type: string + description: Destination hostname of a network packet. + pingmesh_type: + type: array + items: + type: string + description: Type of ping mesh used in network testing. + src_rack: + type: array + items: + type: string + description: Source rack of a network packet. + dst_ipaddress6: + type: array + items: + type: string + description: Destination IPv6 address of a network packet. + tos: + type: array + items: + type: string + description: Type of Service (ToS) is a field in IP headers that specifies + the priority of packets. + pingmesh_instance: + type: array + items: + type: string + description: Instance of a ping mesh used in network testing. + src_suite: + type: array + items: + type: string + description: Source suite of a network packet. + dst_rack: + type: array + items: + type: string + description: Destination rack of a network packet. + src_hostname: + type: array + items: + type: string + description: Source hostname of a network packet. + src_cluster: + type: array + items: + type: string + description: Source cluster of a network packet. + dst_ipaddress: + type: array + items: + type: string + description: Destination IPv4 address of a network packet. + port: + type: array + items: + type: string + description: Identifies the communication endpoint for network services + using a numerical label. + src_ipaddress6: + type: array + items: + type: string + description: Source IPv6 address of a network packet. + dst_site: + type: array + items: + type: string + description: Destination site of a network packet. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_traceroute_status + description: Displays the status and results of a traceroute operation to diagnose + network paths. + parameters: + type: object + properties: + dst_cluster: + type: array + items: + type: string + description: Destination cluster of a network packet. + dst_rack: + type: array + items: + type: string + description: Destination rack of a network packet. + dst_hostname: + type: array + items: + type: string + description: Destination hostname of a network packet. + src_ipaddress6: + type: array + items: + type: string + description: Source IPv6 address of a network packet. + src_site: + type: array + items: + type: string + description: Source site of a network packet. + pingmesh_type: + type: array + items: + type: string + description: Type of ping mesh used in network testing. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + src_ipaddress: + type: array + items: + type: string + description: Source IPv4 address of a network packet. + src_rack: + type: array + items: + type: string + description: Source rack of a network packet. + dst_ipaddress6: + type: array + items: + type: string + description: Destination IPv6 address of a network packet. + dst_suite: + type: array + items: + type: string + description: Destination suite of a network packet. + src_hostname: + type: array + items: + type: string + description: Source hostname of a network packet. + tos: + type: array + items: + type: string + description: Type of Service (ToS) is a field in IP headers that specifies + the priority of packets. + pingmesh_instance: + type: array + items: + type: string + description: Instance of a ping mesh used in network testing. + src_cluster: + type: array + items: + type: string + description: Source cluster of a network packet. + dst_site: + type: array + items: + type: string + description: Destination site of a network packet. + src_suite: + type: array + items: + type: string + description: Source suite of a network packet. + dst_ipaddress: + type: array + items: + type: string + description: Destination IPv4 address of a network packet. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_udp_err + description: Tracks errors encountered in the User Datagram Protocol (UDP) communication + process. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_udp_in_pkts + description: Counts the number of incoming UDP packets received by the network + interface. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_udp_out_pkts + description: Counts the number of outgoing UDP packets transmitted from a network + interface. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_udp_rcv_buf_err + description: Counts the number of UDP packets dropped due to receive buffer errors. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_udp_snd_buf_err + description: Represents errors encountered when the UDP send buffer is full or + unavailable. + parameters: + type: object + properties: + agenttype: + type: array + items: + type: string + description: Specifies the type of agent responsible for monitoring or managing + network activities. + rack: + type: array + items: + type: string + description: Refers to the physical framework used to house networking equipment + and servers. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + cluster: + type: array + items: + type: string + description: A group of nodes that work together to provide a shared resource + or service. + suite: + type: array + items: + type: string + description: Denotes a collection of related software tools or applications + used in network management. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pm_ops_agent_health + description: The health status of the Performance Monitoring Operations Agent. + parameters: + type: object + properties: + manual_instance: + type: array + items: + type: string + description: A manually created instance of a network component. + auto_instance: + type: array + items: + type: string + description: An automatically created instance of a network component. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + version: + type: array + items: + type: string + description: The software version of a network device or application. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pm_ops_agent_health_pinger + description: Monitors the health and operational status of network agents using + ping tests. + parameters: + type: object + properties: + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + manual_instance: + type: array + items: + type: string + description: A manually created instance of a network component. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + mode: + type: array + items: + type: string + description: Specifies the operational mode or state of a network or system + component. + auto_instance: + type: array + items: + type: string + description: An automatically created instance of a network component. + version: + type: array + items: + type: string + description: The software version of a network device or application. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pm_ops_agent_health_ponger + description: Monitors the health and responsiveness of the operations agent in + the network. + parameters: + type: object + properties: + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + manual_instance: + type: array + items: + type: string + description: A manually created instance of a network component. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + mode: + type: array + items: + type: string + description: Specifies the operational mode or state of a network or system + component. + auto_instance: + type: array + items: + type: string + description: An automatically created instance of a network component. + version: + type: array + items: + type: string + description: The software version of a network device or application. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pm_ops_clock_skew + description: Measures the time difference between system clocks in a network to + ensure synchronization. + parameters: + type: object + properties: + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + manual_instance: + type: array + items: + type: string + description: A manually created instance of a network component. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + mode: + type: array + items: + type: string + description: Specifies the operational mode or state of a network or system + component. + auto_instance: + type: array + items: + type: string + description: An automatically created instance of a network component. + version: + type: array + items: + type: string + description: The software version of a network device or application. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pm_ops_errors + description: Tracks the number of errors encountered during performance management + operations in the network. + parameters: + type: object + properties: + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + manual_instance: + type: array + items: + type: string + description: A manually created instance of a network component. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + mode: + type: array + items: + type: string + description: Specifies the operational mode or state of a network or system + component. + auto_instance: + type: array + items: + type: string + description: An automatically created instance of a network component. + version: + type: array + items: + type: string + description: The software version of a network device or application. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pm_ops_errors_rate + description: Measures the rate of operational errors occurring in the performance + management system. + parameters: + type: object + properties: + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + manual_instance: + type: array + items: + type: string + description: A manually created instance of a network component. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + mode: + type: array + items: + type: string + description: Specifies the operational mode or state of a network or system + component. + auto_instance: + type: array + items: + type: string + description: An automatically created instance of a network component. + version: + type: array + items: + type: string + description: The software version of a network device or application. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pm_ops_iteration_health + description: Evaluates the health and efficiency of operations during each iteration + in project management. + parameters: + type: object + properties: + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + manual_instance: + type: array + items: + type: string + description: A manually created instance of a network component. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + mode: + type: array + items: + type: string + description: Specifies the operational mode or state of a network or system + component. + auto_instance: + type: array + items: + type: string + description: An automatically created instance of a network component. + version: + type: array + items: + type: string + description: The software version of a network device or application. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pm_ops_iteration_rate + description: Measures the rate of operations iterations per minute in performance + monitoring tasks. + parameters: + type: object + properties: + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + manual_instance: + type: array + items: + type: string + description: A manually created instance of a network component. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + mode: + type: array + items: + type: string + description: Specifies the operational mode or state of a network or system + component. + auto_instance: + type: array + items: + type: string + description: An automatically created instance of a network component. + version: + type: array + items: + type: string + description: The software version of a network device or application. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pm_ops_perf_report_errors + description: Reports errors encountered during performance operations in network + management systems. + parameters: + type: object + properties: + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + manual_instance: + type: array + items: + type: string + description: A manually created instance of a network component. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + mode: + type: array + items: + type: string + description: Specifies the operational mode or state of a network or system + component. + auto_instance: + type: array + items: + type: string + description: An automatically created instance of a network component. + version: + type: array + items: + type: string + description: The software version of a network device or application. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pm_ops_perf_report_errors_rate + description: Measures the rate of errors encountered during performance report + operations in the network. + parameters: + type: object + properties: + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + manual_instance: + type: array + items: + type: string + description: A manually created instance of a network component. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + mode: + type: array + items: + type: string + description: Specifies the operational mode or state of a network or system + component. + auto_instance: + type: array + items: + type: string + description: An automatically created instance of a network component. + version: + type: array + items: + type: string + description: The software version of a network device or application. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pm_ops_report_errors + description: Reports errors encountered during performance management operations + in the network. + parameters: + type: object + properties: + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + manual_instance: + type: array + items: + type: string + description: A manually created instance of a network component. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + mode: + type: array + items: + type: string + description: Specifies the operational mode or state of a network or system + component. + auto_instance: + type: array + items: + type: string + description: An automatically created instance of a network component. + version: + type: array + items: + type: string + description: The software version of a network device or application. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pm_ops_report_errors_rate + description: Measures the rate of errors occurring in operations reports within + the network. + parameters: + type: object + properties: + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + manual_instance: + type: array + items: + type: string + description: A manually created instance of a network component. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + mode: + type: array + items: + type: string + description: Specifies the operational mode or state of a network or system + component. + auto_instance: + type: array + items: + type: string + description: An automatically created instance of a network component. + version: + type: array + items: + type: string + description: The software version of a network device or application. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pm_ops_report_internal_errors + description: Reports internal errors encountered during performance management + operations. + parameters: + type: object + properties: + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + manual_instance: + type: array + items: + type: string + description: A manually created instance of a network component. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + mode: + type: array + items: + type: string + description: Specifies the operational mode or state of a network or system + component. + auto_instance: + type: array + items: + type: string + description: An automatically created instance of a network component. + version: + type: array + items: + type: string + description: The software version of a network device or application. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pm_ops_report_internal_errors_rate + description: Measures the rate of internal errors reported by performance management + operations. + parameters: + type: object + properties: + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + manual_instance: + type: array + items: + type: string + description: A manually created instance of a network component. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + mode: + type: array + items: + type: string + description: Specifies the operational mode or state of a network or system + component. + auto_instance: + type: array + items: + type: string + description: An automatically created instance of a network component. + version: + type: array + items: + type: string + description: The software version of a network device or application. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pm_ops_response_health + description: Measures the health and responsiveness of operations in the performance + management system. + parameters: + type: object + properties: + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + manual_instance: + type: array + items: + type: string + description: A manually created instance of a network component. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + mode: + type: array + items: + type: string + description: Specifies the operational mode or state of a network or system + component. + auto_instance: + type: array + items: + type: string + description: An automatically created instance of a network component. + version: + type: array + items: + type: string + description: The software version of a network device or application. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pm_ops_response_rate + description: Measures the rate of successful responses to operations in performance + management systems. + parameters: + type: object + properties: + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + manual_instance: + type: array + items: + type: string + description: A manually created instance of a network component. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + mode: + type: array + items: + type: string + description: Specifies the operational mode or state of a network or system + component. + auto_instance: + type: array + items: + type: string + description: An automatically created instance of a network component. + version: + type: array + items: + type: string + description: The software version of a network device or application. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pm_ops_state + description: Represents the operational state of performance management processes + in the network. + parameters: + type: object + properties: + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + manual_instance: + type: array + items: + type: string + description: A manually created instance of a network component. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + mode: + type: array + items: + type: string + description: Specifies the operational mode or state of a network or system + component. + auto_instance: + type: array + items: + type: string + description: An automatically created instance of a network component. + version: + type: array + items: + type: string + description: The software version of a network device or application. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_probe_agent_agent_state + description: The state of the probe agent, indicating its operational status and + any errors or issues encountered. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_probe_agent_num_connect_fails + description: Counts the number of connection failures encountered by the probe + agent. + parameters: + type: object + properties: + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_probe_agent_num_connect_initiated + description: Counts the number of connection initiation attempts made by the probe + agent. + parameters: + type: object + properties: + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_probe_agent_num_connect_successes + description: Counts the number of successful connection attempts made by the probe + agent. + parameters: + type: object + properties: + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + s2_engine_type: + type: array + items: + type: string + description: The type of engine used in the S2 system for processing and + analysis. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_probe_agent_status + description: Indicates the operational status of a network probe agent within + the monitoring system. + parameters: + type: object + properties: + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_probe_destinations + description: Identifies the target endpoints for network probes to assess connectivity + and performance. + parameters: + type: object + properties: + src_hostname: + type: array + items: + type: string + description: Source hostname of a network packet. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + src_ipaddress: + type: array + items: + type: string + description: Source IPv4 address of a network packet. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_loki_tcp_connections + description: Represents the number of active TCP connections in the Loki system. + parameters: + type: object + properties: + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_promtail_aggregate_dropped_bytes_total_rate + description: Measures the rate at which bytes are dropped by Promtail during log + aggregation. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_promtail_aggregate_dropped_entries_total_rate + description: Measures the rate at which entries are dropped by Promtail during + aggregation. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_promtail_aggregate_encoded_bytes_total_rate + description: Measures the rate of total encoded bytes processed by Promtail in + the network. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_promtail_dropped_bytes_total + description: Total number of bytes dropped by Promtail during log collection and + forwarding. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_promtail_dropped_bytes_total_rate + description: Measures the rate at which bytes are dropped by Promtail during log + processing. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_promtail_dropped_entries_total + description: Total number of log entries dropped by Promtail due to errors or + rate limits. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_promtail_dropped_entries_total_rate + description: Measures the rate at which log entries are dropped by Promtail due + to various reasons. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_promtail_encoded_bytes_total + description: Total number of bytes encoded by Promtail for log shipping to Loki. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_promtail_encoded_bytes_total_rate + description: Measures the rate of bytes encoded by Promtail over a specified time + period. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_promtail_fluentd_tcp_connections + description: Tracks the number of TCP connections between Promtail and Fluentd + for log forwarding. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_promtail_loki_request_duration_average + description: Average duration of requests made by Promtail to Loki for log processing. + parameters: + type: object + properties: + host: + type: array + items: + type: string + description: Refers to the server or device in a network where services + or applications are hosted. + status_code: + type: array + items: + type: string + description: HTTP status code indicating the result of a network request. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_promtail_loki_request_duration_p90 + description: Measures the 90th percentile duration of requests from Promtail to + Loki for log processing. + parameters: + type: object + properties: + status_code: + type: array + items: + type: string + description: HTTP status code indicating the result of a network request. + host: + type: array + items: + type: string + description: Refers to the server or device in a network where services + or applications are hosted. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_promtail_loki_request_duration_p99 + description: Measures the 99th percentile duration of requests from Promtail to + Loki for log processing. + parameters: + type: object + properties: + status_code: + type: array + items: + type: string + description: HTTP status code indicating the result of a network request. + host: + type: array + items: + type: string + description: Refers to the server or device in a network where services + or applications are hosted. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_promtail_request_codes + description: Tracks the HTTP request status codes received by Promtail during + log ingestion. + parameters: + type: object + properties: + status_code: + type: array + items: + type: string + description: HTTP status code indicating the result of a network request. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_promtail_request_counts + description: Tracks the number of requests received by Promtail for log data collection + and processing. + parameters: + type: object + properties: + status_code: + type: array + items: + type: string + description: HTTP status code indicating the result of a network request. + route: + type: array + items: + type: string + description: A label that specifies the route taken by network traffic. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_promtail_request_counts_aggregate + description: Aggregates the total number of requests received by Promtail over + a specified period. + parameters: + type: object + properties: + route: + type: array + items: + type: string + description: A label that specifies the route taken by network traffic. + status_code: + type: array + items: + type: string + description: HTTP status code indicating the result of a network request. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_promtail_request_duration_average + description: Represents the average duration of requests processed by Promtail + in the logging pipeline. + parameters: + type: object + properties: + status_code: + type: array + items: + type: string + description: HTTP status code indicating the result of a network request. + method: + type: array + items: + type: string + description: HTTP method used in a network request, such as GET, POST, PUT, + or DELETE. + route: + type: array + items: + type: string + description: A label that specifies the route taken by network traffic. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_promtail_request_duration_p90 + description: Measures the 90th percentile of request duration times for Promtail + in the network. + parameters: + type: object + properties: + status_code: + type: array + items: + type: string + description: HTTP status code indicating the result of a network request. + method: + type: array + items: + type: string + description: HTTP method used in a network request, such as GET, POST, PUT, + or DELETE. + route: + type: array + items: + type: string + description: A label that specifies the route taken by network traffic. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_promtail_request_duration_p99 + description: Represents the 99th percentile of request duration times for Promtail + in the network. + parameters: + type: object + properties: + status_code: + type: array + items: + type: string + description: HTTP status code indicating the result of a network request. + method: + type: array + items: + type: string + description: HTTP method used in a network request, such as GET, POST, PUT, + or DELETE. + route: + type: array + items: + type: string + description: A label that specifies the route taken by network traffic. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_promtail_request_size_average + description: Represents the average size of requests handled by Promtail in the + logging pipeline. + parameters: + type: object + properties: + status_code: + type: array + items: + type: string + description: HTTP status code indicating the result of a network request. + method: + type: array + items: + type: string + description: HTTP method used in a network request, such as GET, POST, PUT, + or DELETE. + route: + type: array + items: + type: string + description: A label that specifies the route taken by network traffic. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_promtail_request_size_p90 + description: Represents the 90th percentile of request sizes handled by Promtail + in the network. + parameters: + type: object + properties: + status_code: + type: array + items: + type: string + description: HTTP status code indicating the result of a network request. + method: + type: array + items: + type: string + description: HTTP method used in a network request, such as GET, POST, PUT, + or DELETE. + route: + type: array + items: + type: string + description: A label that specifies the route taken by network traffic. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_promtail_request_size_p99 + description: Represents the 99th percentile of request sizes handled by Promtail + in the network. + parameters: + type: object + properties: + status_code: + type: array + items: + type: string + description: HTTP status code indicating the result of a network request. + method: + type: array + items: + type: string + description: HTTP method used in a network request, such as GET, POST, PUT, + or DELETE. + route: + type: array + items: + type: string + description: A label that specifies the route taken by network traffic. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_promtail_vector_tcp_connections + description: Monitors the number of TCP connections established by Promtail to + Vector for log forwarding. + parameters: + type: object + properties: + protocol: + type: array + items: + type: string + description: A label that represents a specific network protocol used for + communication. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_syslog_engine_health + description: Monitors the operational status and performance of the syslog engine + in the network. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + instance: + type: array + items: + type: string + description: The specific instance of the API that was accessed. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_bmp_engine_health + description: Indicates the health status of the BMP engine, which is responsible + for managing network traffic. + parameters: + type: object + properties: + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_commit_count + description: Represents the total number of commits made to a version control + repository. + parameters: + type: object + properties: + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pg_exporter_last_scrape_duration_seconds + description: Measures the time taken for the last scrape of PostgreSQL metrics + by the exporter. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pg_exporter_last_scrape_error + description: Indicates whether the last scrape attempt by the PostgreSQL exporter + resulted in an error. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pg_stat_activity_count + description: Counts the number of active connections to the PostgreSQL database. + parameters: + type: object + properties: + datname: + type: array + items: + type: string + description: Represents the name of the database in PostgreSQL. + server: + type: array + items: + type: string + description: Refers to the host or machine where the network service is + running. + application_name: + type: array + items: + type: string + description: Identifies the name of the application connected to the database + or network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pg_stat_database_xact_commit + description: Tracks the number of transactions that have been committed in a PostgreSQL + database. + parameters: + type: object + properties: + datname: + type: array + items: + type: string + description: Represents the name of the database in PostgreSQL. + server: + type: array + items: + type: string + description: Refers to the host or machine where the network service is + running. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_nginx_connections_accepted + description: The number of HTTP requests accepted by the Nginx web server. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_nginx_connections_active + description: Represents the current number of active connections being handled + by the Nginx server. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_nginx_connections_handled + description: Tracks the total number of connections successfully handled by the + Nginx server. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_nginx_connections_waiting + description: Represents the number of connections currently waiting for processing + in the Nginx server. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_nginx_http_requests_total + description: Total number of HTTP requests processed by the Nginx server. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_nginx_up + description: Indicates whether the Nginx server is currently running and accessible. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_proxy_connections_accepted + description: Counts the number of successful connections accepted by the proxy + server. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_proxy_connections_active + description: Represents the number of active connections currently being handled + by the proxy server. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_proxy_connections_handled + description: Tracks the number of connections successfully managed by the proxy + server. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_proxy_connections_status + description: Shows the current status of connections through a proxy server in + the network. + parameters: + type: object + properties: + kpi_by_connections: + type: array + items: + type: string + description: Measures key performance indicators based on the number and + quality of network connections. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_proxy_connections_waiting + description: Represents the number of connections waiting to be processed by the + proxy server. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_proxy_engine_health + description: Monitors the operational status and performance of the proxy engine + in the network. + parameters: + type: object + properties: + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_proxy_http_requests_total + description: Total number of HTTP requests processed by the proxy server. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_proxy_status + description: Indicates the operational status and performance of a network proxy + server. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_reporting_api + description: An API for reporting and analyzing network performance metrics. + parameters: + type: object + properties: + include_details: + type: array + items: + type: string + description: A label indicating whether detailed information should be included + in the report. + report_name: + type: array + items: + type: string + description: The name of the report being generated or analyzed. + value: + type: array + items: + type: string + description: The specific value or metric being reported or analyzed. + lookback_duration: + type: array + items: + type: string + description: The duration for which historical data is being considered + for analysis. + report_filter: + type: array + items: + type: string + description: A filter used to narrow down the data for the report. + kpi: + type: array + items: + type: string + description: A key performance indicator used to measure network performance. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_broker_msg_rate + description: The rate at which messages are sent to or received from a message + broker. + parameters: + type: object + properties: + broker_name: + type: array + items: + type: string + description: The name of the message broker used in the network. + inst: + type: array + items: + type: string + description: An instance of a network component, such as a server or a service. + topic_name: + type: array + items: + type: string + description: The name of a specific topic in a publish-subscribe messaging + system. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_consumer_msg_rate + description: Represents the rate at which messages are consumed by a consumer + in the network. + parameters: + type: object + properties: + consumer_name: + type: array + items: + type: string + description: Identifies the name of the consumer within the network system. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + inst: + type: array + items: + type: string + description: An instance of a network component, such as a server or a service. + broker_name: + type: array + items: + type: string + description: The name of the message broker used in the network. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_decoder_match_rate + description: Represents the percentage of successful matches by the decoder against + expected patterns. + parameters: + type: object + properties: + decoder_name: + type: array + items: + type: string + description: Specifies the name of the decoder used for processing network + data. + topic_name: + type: array + items: + type: string + description: The name of a specific topic in a publish-subscribe messaging + system. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + inst: + type: array + items: + type: string + description: An instance of a network component, such as a server or a service. + broker_name: + type: array + items: + type: string + description: The name of the message broker used in the network. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_decoder_queue_max_size + description: Represents the maximum size of the queue for the decoder in the network + system. + parameters: + type: object + properties: + broker_name: + type: array + items: + type: string + description: The name of the message broker used in the network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + decoder_name: + type: array + items: + type: string + description: Specifies the name of the decoder used for processing network + data. + topic_name: + type: array + items: + type: string + description: The name of a specific topic in a publish-subscribe messaging + system. + inst: + type: array + items: + type: string + description: An instance of a network component, such as a server or a service. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_decoder_queue_size + description: Represents the number of packets waiting to be processed in the decoder + queue. + parameters: + type: object + properties: + broker_name: + type: array + items: + type: string + description: The name of the message broker used in the network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + decoder_name: + type: array + items: + type: string + description: Specifies the name of the decoder used for processing network + data. + topic_name: + type: array + items: + type: string + description: The name of a specific topic in a publish-subscribe messaging + system. + inst: + type: array + items: + type: string + description: An instance of a network component, such as a server or a service. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_in_bgp_record_rate + description: Measures the rate at which Kafka records are processed within BGP + sessions. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + inst: + type: array + items: + type: string + description: An instance of a network component, such as a server or a service. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_in_port_record_rate + description: Measures the rate at which records are received on a specific Kafka + port. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + inst: + type: array + items: + type: string + description: An instance of a network component, such as a server or a service. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_kafka_in_system_record_rate + description: Measures the rate at which records are ingested into the Kafka system + per second. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + inst: + type: array + items: + type: string + description: An instance of a network component, such as a server or a service. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_topic_bulk_reports + description: Aggregates and provides detailed reports on various network topics + in bulk format. + parameters: + type: object + properties: + broker_name: + type: array + items: + type: string + description: The name of the message broker used in the network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + inst: + type: array + items: + type: string + description: An instance of a network component, such as a server or a service. + topic_name: + type: array + items: + type: string + description: The name of a specific topic in a publish-subscribe messaging + system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_topic_msg_rate + description: Measures the rate at which messages are produced or consumed in a + specific Kafka topic. + parameters: + type: object + properties: + broker_name: + type: array + items: + type: string + description: The name of the message broker used in the network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + inst: + type: array + items: + type: string + description: An instance of a network component, such as a server or a service. + topic_name: + type: array + items: + type: string + description: The name of a specific topic in a publish-subscribe messaging + system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_topic_msg_total + description: Represents the total number of messages processed by a specific topic + in the network. + parameters: + type: object + properties: + broker_name: + type: array + items: + type: string + description: The name of the message broker used in the network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + inst: + type: array + items: + type: string + description: An instance of a network component, such as a server or a service. + topic_name: + type: array + items: + type: string + description: The name of a specific topic in a publish-subscribe messaging + system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_topic_report_rate + description: Measures the frequency at which reports are generated for a specific + topic in the network. + parameters: + type: object + properties: + broker_name: + type: array + items: + type: string + description: The name of the message broker used in the network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + inst: + type: array + items: + type: string + description: An instance of a network component, such as a server or a service. + topic_name: + type: array + items: + type: string + description: The name of a specific topic in a publish-subscribe messaging + system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_topic_report_record_rate + description: Measures the rate at which records are produced or consumed in a + Kafka topic. + parameters: + type: object + properties: + broker_name: + type: array + items: + type: string + description: The name of the message broker used in the network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + inst: + type: array + items: + type: string + description: An instance of a network component, such as a server or a service. + topic_name: + type: array + items: + type: string + description: The name of a specific topic in a publish-subscribe messaging + system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_topic_report_records + description: Provides a summary of records processed or stored in a specific topic. + parameters: + type: object + properties: + broker_name: + type: array + items: + type: string + description: The name of the message broker used in the network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + inst: + type: array + items: + type: string + description: An instance of a network component, such as a server or a service. + topic_name: + type: array + items: + type: string + description: The name of a specific topic in a publish-subscribe messaging + system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_topic_report_send_err + description: Tracks the number of errors encountered while sending reports on + a specific topic. + parameters: + type: object + properties: + broker_name: + type: array + items: + type: string + description: The name of the message broker used in the network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + inst: + type: array + items: + type: string + description: An instance of a network component, such as a server or a service. + topic_name: + type: array + items: + type: string + description: The name of a specific topic in a publish-subscribe messaging + system. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_fw_pan_vsys_session_max + description: Maximum number of sessions allowed in a firewall virtual system (vsys) + on a Palo Alto Networks firewall. + parameters: + type: object + properties: + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + os: + type: array + items: + type: string + description: The operating system running on a network device. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pan_session_active + description: Represents the number of active sessions currently managed by the + Palo Alto Networks firewall. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pan_session_active_icmp + description: Tracks the number of active ICMP sessions on a Palo Alto Networks + firewall. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pan_session_active_ssl_proxy + description: Represents the number of active SSL proxy sessions on a Palo Alto + Networks device. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pan_session_active_tcp + description: Represents the number of active TCP sessions currently managed by + the Palo Alto Networks firewall. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pan_session_active_udp + description: Represents the number of active UDP sessions on a Palo Alto Networks + firewall. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pan_session_max + description: Represents the maximum number of concurrent sessions supported by + a Palo Alto Networks device. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pan_session_ssl_proxy_utilization + description: Measures the utilization of SSL proxy sessions on a Palo Alto Networks + firewall. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pan_session_utilization + description: Measures the percentage of session capacity used on a Palo Alto Networks + firewall. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pan_vsys_session_active + description: Represents the number of active sessions in a virtual system on a + Palo Alto Networks device. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pan_vsys_session_utilization_pct + description: Represents the percentage of session utilization for a virtual system + in a Palo Alto network. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmp_attempting_bulk_walk + description: An SNMP bulk walk attempt is being made by the engine 2 to retrieve + a large number of OID values. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + target: + type: array + items: + type: string + description: A target entity in a network, such as a server or a device. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmp_attempting_bulk_walk_inc + description: Tracks the number of SNMP bulk walk attempts initiated by engine2. + parameters: + type: object + properties: + target: + type: array + items: + type: string + description: A target entity in a network, such as a server or a device. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmp_bulk_walk_all_failed + description: Indicates failure in executing SNMP bulk walk operations across all + devices in the network. + parameters: + type: object + properties: + target: + type: array + items: + type: string + description: A target entity in a network, such as a server or a device. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmp_bulk_walk_all_failed_inc + description: Tracks the increase in failed SNMP bulk walk operations across all + devices. + parameters: + type: object + properties: + target: + type: array + items: + type: string + description: A target entity in a network, such as a server or a device. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmp_bulk_walk_error_inc + description: Tracks the increase in errors encountered during SNMP bulk walk operations + on network devices. + parameters: + type: object + properties: + target: + type: array + items: + type: string + description: A target entity in a network, such as a server or a device. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmp_collection_post_error_inc + description: Tracks the increase in SNMP collection post errors for engine2 in + the network. + parameters: + type: object + properties: + target: + type: array + items: + type: string + description: A target entity in a network, such as a server or a device. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmp_collection_post_success_inc + description: Counts the successful SNMP data collection posts by the Engine2 system. + parameters: + type: object + properties: + target: + type: array + items: + type: string + description: A target entity in a network, such as a server or a device. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmp_device_added + description: Tracks the addition of SNMP-enabled devices to the network monitoring + system. + parameters: + type: object + properties: + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmp_engine_post_bytes_rate + description: Measures the rate of bytes posted by the SNMP engine in the network. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + label: + type: array + items: + type: string + description: A generic label used to identify a specific entity or object + in a network or system. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmp_engine_post_bytes_rate_avg + description: Average rate of bytes posted by SNMP engine 2 over a specified period. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + label: + type: array + items: + type: string + description: A generic label used to identify a specific entity or object + in a network or system. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmp_engine_post_rate + description: Measures the rate at which SNMP engine posts are processed by engine2. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + label: + type: array + items: + type: string + description: A generic label used to identify a specific entity or object + in a network or system. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmp_engine_post_rate_avg + description: Average rate of SNMP engine post operations for engine2 over a specified + period. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + label: + type: array + items: + type: string + description: A generic label used to identify a specific entity or object + in a network or system. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmp_heartbeat_status + description: Monitors the SNMP heartbeat status to ensure connectivity and performance + of network devices. + parameters: + type: object + properties: + target: + type: array + items: + type: string + description: A target entity in a network, such as a server or a device. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmp_inst_status + description: Represents the status of SNMP instances on the Engine2 network device. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmp_poll_success_inc + description: Tracks the increase in successful SNMP poll operations by the engine. + parameters: + type: object + properties: + target: + type: array + items: + type: string + description: A target entity in a network, such as a server or a device. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmp_poll_time + description: Measures the time taken to poll SNMP data from network devices using + engine2. + parameters: + type: object + properties: + oid_name: + type: array + items: + type: string + description: Represents the name of the Object Identifier (OID) used in + SNMP operations. + target: + type: array + items: + type: string + description: A target entity in a network, such as a server or a device. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + oid: + type: array + items: + type: string + description: A unique identifier for an object in a management information + base (MIB). + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmp_poll_time_count + description: Counts the number of SNMP poll operations performed by engine2 over + a specific time period. + parameters: + type: object + properties: + target: + type: array + items: + type: string + description: A target entity in a network, such as a server or a device. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmp_poll_time_sum + description: Total time taken for SNMP polling operations by engine2 across the + network. + parameters: + type: object + properties: + target: + type: array + items: + type: string + description: A target entity in a network, such as a server or a device. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmp_sent_update_to_device_manager + description: Tracks the updates sent from SNMP engine to the device manager for + configuration changes. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmp_starting + description: Indicates the initiation status of SNMP on the second engine in the + network. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + start_time: + type: array + items: + type: string + description: Represents the initial timestamp when a specific event or process + begins. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + version: + type: array + items: + type: string + description: The software version of a network device or application. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmp_starting_controller + description: Initiates the SNMP protocol on the controller for network management + and monitoring. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmp_starting_device_manager + description: Initiates the SNMP protocol to manage and monitor network devices + efficiently. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmp_target_status + description: Represents the operational status of SNMP targets monitored by the + Engine2 system. + parameters: + type: object + properties: + target: + type: array + items: + type: string + description: A target entity in a network, such as a server or a device. + hostname: + type: array + items: + type: string + description: The name or identifier of the device or server in a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmp_timer_kicked_in + description: Indicates that the SNMP timer for engine2 has been activated or triggered. + parameters: + type: object + properties: + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmp_updated_device_cnt + description: Counts the number of devices updated via SNMP in the Engine2 system. + parameters: + type: object + properties: + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_admin + description: Indicates whether the interface is an administrative interface. + parameters: + type: object + properties: + target: + type: array + items: + type: string + description: A target entity in a network, such as a server or a device. + name: + type: array + items: + type: string + description: A label that identifies the name of a resource or object within + a system. + oid: + type: array + items: + type: string + description: A unique identifier for an object in a management information + base (MIB). + index: + type: array + items: + type: string + description: Index label for identifying and organizing data. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_descr + description: Provides a textual description of the network interface, including + its purpose and configuration. + parameters: + type: object + properties: + target: + type: array + items: + type: string + description: A target entity in a network, such as a server or a device. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + name: + type: array + items: + type: string + description: A label that identifies the name of a resource or object within + a system. + index: + type: array + items: + type: string + description: Index label for identifying and organizing data. + oid: + type: array + items: + type: string + description: A unique identifier for an object in a management information + base (MIB). + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_in_octet + description: Represents the number of octets received on a network interface. + parameters: + type: object + properties: + target: + type: array + items: + type: string + description: A target entity in a network, such as a server or a device. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + name: + type: array + items: + type: string + description: A label that identifies the name of a resource or object within + a system. + index: + type: array + items: + type: string + description: Index label for identifying and organizing data. + oid: + type: array + items: + type: string + description: A unique identifier for an object in a management information + base (MIB). + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_index + description: Represents the unique identifier for an interface on a network device. + parameters: + type: object + properties: + target: + type: array + items: + type: string + description: A target entity in a network, such as a server or a device. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + name: + type: array + items: + type: string + description: A label that identifies the name of a resource or object within + a system. + index: + type: array + items: + type: string + description: Index label for identifying and organizing data. + oid: + type: array + items: + type: string + description: A unique identifier for an object in a management information + base (MIB). + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_oper + description: Represents the operational status of a network interface, indicating + if it is up or down. + parameters: + type: object + properties: + target: + type: array + items: + type: string + description: A target entity in a network, such as a server or a device. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + name: + type: array + items: + type: string + description: A label that identifies the name of a resource or object within + a system. + index: + type: array + items: + type: string + description: Index label for identifying and organizing data. + oid: + type: array + items: + type: string + description: A unique identifier for an object in a management information + base (MIB). + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_out_octet + description: Represents the number of octets transmitted out of a network interface. + parameters: + type: object + properties: + target: + type: array + items: + type: string + description: A target entity in a network, such as a server or a device. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + name: + type: array + items: + type: string + description: A label that identifies the name of a resource or object within + a system. + index: + type: array + items: + type: string + description: Index label for identifying and organizing data. + oid: + type: array + items: + type: string + description: A unique identifier for an object in a management information + base (MIB). + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_if_speed + description: Represents the speed or bandwidth capacity of a network interface + in bits per second. + parameters: + type: object + properties: + target: + type: array + items: + type: string + description: A target entity in a network, such as a server or a device. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + name: + type: array + items: + type: string + description: A label that identifies the name of a resource or object within + a system. + index: + type: array + items: + type: string + description: Index label for identifying and organizing data. + oid: + type: array + items: + type: string + description: A unique identifier for an object in a management information + base (MIB). + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmptrap_custom_label + description: A custom label for SNMP traps received by the engine2. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + label: + type: array + items: + type: string + description: A generic label used to identify a specific entity or object + in a network or system. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmptrap_device_added + description: Indicates a new device has been added to the network via SNMP trap + notification. + parameters: + type: object + properties: + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmptrap_device_filter_drop + description: Counts the number of SNMP trap messages dropped due to device filter + settings. + parameters: + type: object + properties: + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmptrap_engine_post_failed_rate + description: Measures the rate of failed SNMP trap posts by the engine in the + network. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + label: + type: array + items: + type: string + description: A generic label used to identify a specific entity or object + in a network or system. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmptrap_engine_post_failed_rate_avg + description: Average rate of failed SNMP trap posts by the engine in the network. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + label: + type: array + items: + type: string + description: A generic label used to identify a specific entity or object + in a network or system. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmptrap_engine_post_failed_sum + description: Counts the total number of failed SNMP trap posts by the engine. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + label: + type: array + items: + type: string + description: A generic label used to identify a specific entity or object + in a network or system. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmptrap_engine_post_rate + description: Measures the rate at which SNMP trap messages are posted by the engine. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + label: + type: array + items: + type: string + description: A generic label used to identify a specific entity or object + in a network or system. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmptrap_engine_post_rate_avg + description: Average rate of SNMP trap posts processed by engine2 over a specified + period. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + label: + type: array + items: + type: string + description: A generic label used to identify a specific entity or object + in a network or system. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmptrap_engine_post_sum + description: Represents the total number of SNMP trap messages processed by the + engine. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + label: + type: array + items: + type: string + description: A generic label used to identify a specific entity or object + in a network or system. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmptrap_inst_status + description: Represents the status of SNMP trap instances in the Engine2 network + monitoring system. + parameters: + type: object + properties: + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmptrap_listen_on_port_error + description: Indicates an error occurred while listening for SNMP traps on a specified + port. + parameters: + type: object + properties: + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmptrap_oid_filter_drop + description: Filters and drops SNMP trap messages based on specified Object Identifier + (OID) criteria. + parameters: + type: object + properties: + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmptrap_received_cnt + description: Counts the number of SNMP traps received by the engine2 component + in the network. + parameters: + type: object + properties: + source: + type: array + items: + type: string + description: Identifies the origin or starting point of network traffic + or data. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmptrap_received_cnt_rate + description: Measures the rate at which SNMP traps are received by the engine2 + component. + parameters: + type: object + properties: + source: + type: array + items: + type: string + description: Identifies the origin or starting point of network traffic + or data. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmptrap_received_cnt_rate_avg + description: Average rate of SNMP trap messages received by engine 2 over a specified + period. + parameters: + type: object + properties: + source: + type: array + items: + type: string + description: Identifies the origin or starting point of network traffic + or data. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmptrap_received_cnt_sum + description: Total count of SNMP traps received by engine2, indicating network + event notifications. + parameters: + type: object + properties: + source: + type: array + items: + type: string + description: Identifies the origin or starting point of network traffic + or data. + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmptrap_report_post_failed + description: Indicates a failure in posting SNMP trap reports from engine2 to + the designated endpoint. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + label: + type: array + items: + type: string + description: A generic label used to identify a specific entity or object + in a network or system. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmptrap_report_post_success + description: Indicates successful posting of SNMP trap reports by Engine2 to the + designated endpoint. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + label: + type: array + items: + type: string + description: A generic label used to identify a specific entity or object + in a network or system. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmptrap_sent_update_to_device_manager + description: Indicates an SNMP trap update has been sent to the device manager + by engine2. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmptrap_starting + description: Indicates the initiation of SNMP trap processing by the Engine2 system. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + start_time: + type: array + items: + type: string + description: Represents the initial timestamp when a specific event or process + begins. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + version: + type: array + items: + type: string + description: The software version of a network device or application. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmptrap_starting_controller + description: Indicates the initiation of the SNMP trap controller in the network + engine. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmptrap_starting_device_manager + description: Initiates the SNMP trap process for monitoring and managing network + devices. + parameters: + type: object + properties: + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + module: + type: array + items: + type: string + description: A self-contained unit of code that performs a specific function + in a larger program. + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_engine2_snmptrap_updated_device_cnt + description: Counts the number of devices updated via SNMP traps in the network + engine. + parameters: + type: object + properties: + pod_label_app: + type: array + items: + type: string + description: A label for identifying the application associated with a pod + in a Kubernetes cluster. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + pod_name: + type: array + items: + type: string + description: A label for identifying the name of a pod in a Kubernetes cluster. + s2_inst: + type: array + items: + type: string + description: Represents a service instance in a Kubernetes cluster, providing + a network interface. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_device_reset_status + description: Indicates the current status of device reset operations. + parameters: + type: object + properties: + version: + type: array + items: + type: string + description: The software version of a network device or application. + kpi_name: + type: array + items: + type: string + description: A key performance indicator that represents a measurable value + used to evaluate the performance of a network. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + os: + type: array + items: + type: string + description: The operating system running on a network device. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_sys_uptime + description: Represents the total time a system has been running without interruption. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + tags: + type: array + items: + type: string + description: Metadata or keywords associated with a network object for categorization + or filtering. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pan_gpgw_utilization_active_tunnels + description: Indicates the active tunnels utilization on the Palo Alto Networks + GlobalProtect Gateway. + parameters: + type: object + properties: + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + version: + type: array + items: + type: string + description: The software version of a network device or application. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + os: + type: array + items: + type: string + description: The operating system running on a network device. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pan_gpgw_utilization_max_tunnels + description: Represents the maximum number of tunnels utilized by the GlobalProtect + Gateway in the network. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_pan_gpgw_utilization_pct + description: Represents the percentage of utilization of the GlobalProtect Gateway + in a Palo Alto network. + parameters: + type: object + properties: + os: + type: array + items: + type: string + description: The operating system running on a network device. + region: + type: array + items: + type: string + description: A geographical area or region within a country or continent. + long: + type: array + items: + type: string + description: The longitude coordinate of a geographical location. + type: + type: array + items: + type: string + description: The type of network device or object, such as router, switch, + or firewall. + org: + type: array + items: + type: string + description: An organization or entity that owns or operates a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + site: + type: array + items: + type: string + description: A specific location or network site, often used in network + management or monitoring. + platform: + type: array + items: + type: string + description: The hardware or software platform on which a network device + operates. + state: + type: array + items: + type: string + description: A political subdivision within a country, often used to identify + geographical locations. + device: + type: array + items: + type: string + description: A network device such as a router or switch. + ipaddress: + type: array + items: + type: string + description: An IP address assigned to a network device or interface. + country: + type: array + items: + type: string + description: A sovereign nation with defined borders and a government. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + continent: + type: array + items: + type: string + description: A large landmass on Earth, often used to categorize geographical + locations. + city: + type: array + items: + type: string + description: A populated area with defined boundaries, typically smaller + than a state or country. + version: + type: array + items: + type: string + description: The software version of a network device or application. + lat: + type: array + items: + type: string + description: The latitude coordinate of a geographical location. + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10 +- type: function + function: + name: get_vm_status + description: Indicates the operational status of a virtual machine. + parameters: + type: object + properties: + server_ip: + type: array + items: + type: string + description: Represents the IP address of a server. + tag: + type: array + items: + type: string + description: A label used to categorize or identify network resources. + server_name: + type: array + items: + type: string + description: Identifies a server by its unique name. + server_role: + type: array + items: + type: string + description: Describes the function or purpose of a server in the network. + server_s2_name: + type: array + items: + type: string + description: A label used to identify a server in a specific context. + server_function: + type: array + items: + type: string + description: Describes the specific function or service provided by a server. + role: + type: array + items: + type: string + description: The functional role of a network device within a network. + timestamp: + type: string + description: The time range, e.g., last 30 minutes, last 1 day, or last + 2 days + default: last 30 min + render-type: + type: string + description: render type for the metrics. e.g. line-plot or table + enum: + - line-plot + - timeline-heatmap + - honeycomb + - sunburst + - analysis + - big-text + - donut + - drilldown + - gauge + - table + - map + - stacked-graph + - stacked-area-plot + default: line-plot + group-by: + type: array + items: + type: string + description: If user explictly says that wants data to by group by some + label + show-by: + type: array + items: + type: string + description: If user explictly says that wants data to by show by some label + order-by: + type: string + description: If user explictly says that wants data ordered by either min, + max or avg. + enum: + - min + - max + - avg + rank-by: + type: string + description: If user explictly says that wants data to by rank by either + top or bottom. + enum: + - top + - bottom + default: top + rank-value: + type: integer + description: Integer amount of rank that user wants to see e.g order-by + top 10, order by bottom 5. + default: 10