diff --git a/artifacts/openapi.html b/artifacts/openapi.html index 79594974..745f3147 100644 --- a/artifacts/openapi.html +++ b/artifacts/openapi.html @@ -590,7 +590,7 @@
The request to retrieve OSPFv2 per Router metrics/statistics.
{- "choice": "port",
- "port": {
- "port_names": [
- "string"
], - "column_names": [
- "transmit"
]
}, - "flow": {
- "flow_names": [
- "string"
], - "metric_names": [
- "transmit"
], - "tagged_metrics": {
- "include": true,
- "include_empty_metrics": false,
- "metric_names": [
- "frames_tx"
], - "filters": [
- {
- "name": "string",
- "values": [
- "string"
]
}
]
}
}, - "bgpv4": {
- "peer_names": [
- "string"
], - "column_names": [
- "session_state"
]
}, - "bgpv6": {
- "peer_names": [
- "string"
], - "column_names": [
- "session_state"
]
}, - "isis": {
- "router_names": [
- "string"
], - "column_names": [
- "l1_sessions_up"
]
}, - "lag": {
- "lag_names": [
- "string"
], - "column_names": [
- "oper_status"
]
}, - "lacp": {
- "lag_names": [
- "string"
], - "lag_member_port_names": [
- "string"
], - "column_names": [
- "lacp_packets_rx"
]
}, - "lldp": {
- "lldp_names": [
- "string"
], - "column_names": [
- "frames_rx"
]
}, - "rsvp": {
- "router_names": [
- "string"
], - "column_names": [
- "ingress_p2p_lsps_configured"
]
}, - "dhcpv4_client": {
- "client_names": [
- "string"
], - "column_names": [
- "discovers_sent"
]
}, - "dhcpv4_server": {
- "server_names": [
- "string"
], - "column_names": [
- "discovers_received"
]
}, - "dhcpv6_client": {
- "client_names": [
- "string"
], - "column_names": [
- "solicits_sent"
]
}, - "dhcpv6_server": {
- "server_names": [
- "string"
], - "column_names": [
- "solicits_received"
]
}, - "ospfv2": {
- "router_names": [
- "string"
], - "column_names": [
- "full_state_count"
]
}
}
{- "choice": "port_metrics",
- "port_metrics": [
- {
- "name": "string",
- "location": "string",
- "link": "up",
- "capture": "started",
- "frames_tx": 0,
- "frames_rx": 0,
- "bytes_tx": 0,
- "bytes_rx": 0,
- "frames_tx_rate": 0,
- "frames_rx_rate": 0,
- "bytes_tx_rate": 0,
- "bytes_rx_rate": 0,
- "transmit": "started"
}
], - "flow_metrics": [
- {
- "name": "Tx -> Rx",
- "port_tx": "string",
- "port_rx": "string",
- "transmit": "started",
- "frames_tx": 0,
- "frames_rx": 0,
- "bytes_tx": 0,
- "bytes_rx": 0,
- "frames_tx_rate": 0,
- "frames_rx_rate": 0,
- "loss": 0,
- "timestamps": {
- "first_timestamp_ns": 0,
- "last_timestamp_ns": 0
}, - "latency": {
- "minimum_ns": 0,
- "maximum_ns": 0,
- "average_ns": 0
}, - "tagged_metrics": [
- {
- "tags": [
- {
- "name": "string",
- "value": {
- "choice": "hex",
- "hex": "string",
- "str": "string"
}
}
], - "frames_tx": 0,
- "frames_rx": 0,
- "bytes_tx": 0,
- "bytes_rx": 0,
- "frames_tx_rate": 0,
- "frames_rx_rate": 0,
- "loss": 0,
- "timestamps": {
- "first_timestamp_ns": 0,
- "last_timestamp_ns": 0
}, - "latency": {
- "minimum_ns": 0,
- "maximum_ns": 0,
- "average_ns": 0
}
}
]
}
], - "bgpv4_metrics": [
- {
- "name": "string",
- "session_state": "up",
- "session_flap_count": 0,
- "routes_advertised": 0,
- "routes_received": 0,
- "route_withdraws_sent": 0,
- "route_withdraws_received": 0,
- "updates_sent": 0,
- "updates_received": 0,
- "opens_sent": 0,
- "opens_received": 0,
- "keepalives_sent": 0,
- "keepalives_received": 0,
- "notifications_sent": 0,
- "notifications_received": 0,
- "fsm_state": "idle",
- "end_of_rib_received": 0
}
], - "bgpv6_metrics": [
- {
- "name": "string",
- "session_state": "up",
- "session_flap_count": 0,
- "routes_advertised": 0,
- "routes_received": 0,
- "route_withdraws_sent": 0,
- "route_withdraws_received": 0,
- "updates_sent": 0,
- "updates_received": 0,
- "opens_sent": 0,
- "opens_received": 0,
- "keepalives_sent": 0,
- "keepalives_received": 0,
- "notifications_sent": 0,
- "notifications_received": 0,
- "fsm_state": "idle",
- "end_of_rib_received": 0
}
], - "isis_metrics": [
- {
- "name": "string",
- "l1_sessions_up": 0,
- "l1_session_flap": 0,
- "l1_broadcast_hellos_sent": 0,
- "l1_broadcast_hellos_received": 0,
- "l1_point_to_point_hellos_sent": 0,
- "l1_point_to_point_hellos_received": 0,
- "l1_database_size": 0,
- "l1_psnp_sent": 0,
- "l1_psnp_received": 0,
- "l1_csnp_sent": 0,
- "l1_csnp_received": 0,
- "l1_lsp_sent": 0,
- "l1_lsp_received": 0,
- "l2_sessions_up": 0,
- "l2_session_flap": 0,
- "l2_broadcast_hellos_sent": 0,
- "l2_broadcast_hellos_received": 0,
- "l2_point_to_point_hellos_sent": 0,
- "l2_point_to_point_hellos_received": 0,
- "l2_database_size": 0,
- "l2_psnp_sent": 0,
- "l2_psnp_received": 0,
- "l2_csnp_sent": 0,
- "l2_csnp_received": 0,
- "l2_lsp_sent": 0,
- "l2_lsp_received": 0
}
], - "lag_metrics": [
- {
- "name": "string",
- "oper_status": "up",
- "member_ports_up": 0,
- "frames_tx": 0,
- "frames_rx": 0,
- "bytes_tx": 0,
- "bytes_rx": 0,
- "frames_tx_rate": 0,
- "frames_rx_rate": 0,
- "bytes_tx_rate": 0,
- "bytes_rx_rate": 0
}
], - "lacp_metrics": [
- {
- "lag_name": "string",
- "lag_member_port_name": "string",
- "lacp_packets_rx": 0,
- "lacp_packets_tx": 0,
- "lacp_rx_errors": 0,
- "activity": "active",
- "timeout": "short",
- "synchronization": "in_sync",
- "aggregatable": true,
- "collecting": true,
- "distributing": true,
- "system_id": "string",
- "oper_key": 0,
- "partner_id": "string",
- "partner_key": 0,
- "port_num": 0,
- "partner_port_num": 0
}
], - "lldp_metrics": [
- {
- "name": "string",
- "frames_rx": 0,
- "frames_tx": 0,
- "frames_error_rx": 0,
- "frames_discard": 0,
- "tlvs_discard": 0,
- "tlvs_unknown": 0
}
], - "rsvp_metrics": [
- {
- "name": "string",
- "ingress_p2p_lsps_configured": 0,
- "ingress_p2p_lsps_up": 0,
- "egress_p2p_lsps_up": 0,
- "lsp_flap_count": 0,
- "paths_tx": 0,
- "paths_rx": 0,
- "resvs_tx": 0,
- "resvs_rx": 0,
- "path_tears_tx": 0,
- "path_tears_rx": 0,
- "resv_tears_tx": 0,
- "resv_tears_rx": 0,
- "path_errors_tx": 0,
- "path_errors_rx": 0,
- "resv_errors_tx": 0,
- "resv_errors_rx": 0,
- "resv_conf_tx": 0,
- "resv_conf_rx": 0,
- "hellos_tx": 0,
- "hellos_rx": 0,
- "acks_tx": 0,
- "acks_rx": 0,
- "nacks_tx": 0,
- "nacks_rx": 0,
- "srefresh_tx": 0,
- "srefresh_rx": 0,
- "bundle_tx": 0,
- "bundle_rx": 0,
- "path_reevaluation_request_tx": 0,
- "path_reoptimizations": 0
}
], - "dhcpv4client_metrics": [
- {
- "name": "string",
- "discovers_sent": 0,
- "offers_received": 0,
- "requests_sent": 0,
- "acks_received": 0,
- "nacks_received": 0,
- "releases_sent": 0,
- "declines_sent": 0
}
], - "dhcpv4server_metrics": [
- {
- "name": "string",
- "discovers_received": 0,
- "offers_sent": 0,
- "requests_received": 0,
- "acks_sent": 0,
- "nacks_sent": 0,
- "releases_received": 0,
- "declines_received": 0
}
], - "dhcpv6client_metrics": [
- {
- "name": "string",
- "solicits_sent": 0,
- "advertisements_received": 0,
- "advertisements_ignored": 0,
- "requests_sent": 0,
- "nacks_received": 0,
- "replies_received": 0,
- "information_requests_sent": 0,
- "renews_sent": 0,
- "rebinds_sent": 0,
- "releases_sent": 0,
- "reconfigures_received": 0,
- "rapid_commit_solicits_sent": 0,
- "rapid_commit_replies_received": 0
}
], - "dhcpv6server_metrics": [
- {
- "name": "string",
- "solicits_received": 0,
- "solicits_ignored": 0,
- "advertisements_sent": 0,
- "requests_received": 0,
- "nacks_sent": 0,
- "confirms_received": 0,
- "renewals_received": 0,
- "rebinds_received": 0,
- "replies_sent": 0,
- "releases_received": 0,
- "declines_received": 0,
- "information_requests_received": 0,
- "relay_forwards_received": 0,
- "relay_replies_sent": 0,
- "reconfigures_sent": 0
}
], - "ospfv2_metrics": [
- {
- "name": "string",
- "full_state_count": 0,
- "down_state_count": 0,
- "sessions_flap": 0,
- "hellos_sent": 0,
- "hellos_received": 0,
- "dbd_sent": 0,
- "dbd_received": 0,
- "ls_request_sent": 0,
- "ls_request_received": 0,
- "ls_update_sent": 0,
- "ls_update_received": 0,
- "ls_ack_sent": 0,
- "ls_ack_received": 0,
- "lsa_sent": 0,
- "lsa_received": 0,
- "lsa_ack_sent": 0,
- "lsa_ack_received": 0,
- "router_lsa_sent": 0,
- "router_lsa_received": 0,
- "network_lsa_sent": 0,
- "network_lsa_received": 0,
- "summary_lsa_sent": 0,
- "summary_lsa_received": 0,
- "external_lsa_sent": 0,
- "external_lsa_received": 0,
- "nssa_lsa_sent": 0,
- "nssa_lsa_received": 0,
- "opaque_local_sent": 0,
- "opaque_local_received": 0,
- "opaque_area_sent": 0,
- "opaque_area_received": 0,
- "opaque_domain_sent": 0,
- "opaque_domain_received": 0
}
]
}
{- "choice": "port",
- "port": {
- "port_names": [
- "string"
], - "column_names": [
- "transmit"
]
}, - "flow": {
- "flow_names": [
- "string"
], - "metric_names": [
- "transmit"
], - "tagged_metrics": {
- "include": true,
- "include_empty_metrics": false,
- "metric_names": [
- "frames_tx"
], - "filters": [
- {
- "name": "string",
- "values": [
- "string"
]
}
]
}
}, - "bgpv4": {
- "peer_names": [
- "string"
], - "column_names": [
- "session_state"
]
}, - "bgpv6": {
- "peer_names": [
- "string"
], - "column_names": [
- "session_state"
]
}, - "isis": {
- "router_names": [
- "string"
], - "column_names": [
- "l1_sessions_up"
]
}, - "lag": {
- "lag_names": [
- "string"
], - "column_names": [
- "oper_status"
]
}, - "lacp": {
- "lag_names": [
- "string"
], - "lag_member_port_names": [
- "string"
], - "column_names": [
- "lacp_packets_rx"
]
}, - "lldp": {
- "lldp_names": [
- "string"
], - "column_names": [
- "frames_rx"
]
}, - "rsvp": {
- "router_names": [
- "string"
], - "column_names": [
- "ingress_p2p_lsps_configured"
]
}, - "dhcpv4_client": {
- "client_names": [
- "string"
], - "column_names": [
- "discovers_sent"
]
}, - "dhcpv4_server": {
- "server_names": [
- "string"
], - "column_names": [
- "discovers_received"
]
}, - "dhcpv6_client": {
- "client_names": [
- "string"
], - "column_names": [
- "solicits_sent"
]
}, - "dhcpv6_server": {
- "server_names": [
- "string"
], - "column_names": [
- "solicits_received"
]
}, - "ospfv2": {
- "router_names": [
- "string"
], - "column_names": [
- "full_state_count"
]
}
}
{- "choice": "port_metrics",
- "port_metrics": [
- {
- "name": "string",
- "location": "string",
- "link": "up",
- "capture": "started",
- "frames_tx": 0,
- "frames_rx": 0,
- "bytes_tx": 0,
- "bytes_rx": 0,
- "frames_tx_rate": 0,
- "frames_rx_rate": 0,
- "bytes_tx_rate": 0,
- "bytes_rx_rate": 0,
- "transmit": "started",
- "last_change": 0
}
], - "flow_metrics": [
- {
- "name": "Tx -> Rx",
- "port_tx": "string",
- "port_rx": "string",
- "transmit": "started",
- "frames_tx": 0,
- "frames_rx": 0,
- "bytes_tx": 0,
- "bytes_rx": 0,
- "frames_tx_rate": 0,
- "frames_rx_rate": 0,
- "loss": 0,
- "timestamps": {
- "first_timestamp_ns": 0,
- "last_timestamp_ns": 0
}, - "latency": {
- "minimum_ns": 0,
- "maximum_ns": 0,
- "average_ns": 0
}, - "tagged_metrics": [
- {
- "tags": [
- {
- "name": "string",
- "value": {
- "choice": "hex",
- "hex": "string",
- "str": "string"
}
}
], - "frames_tx": 0,
- "frames_rx": 0,
- "bytes_tx": 0,
- "bytes_rx": 0,
- "frames_tx_rate": 0,
- "frames_rx_rate": 0,
- "loss": 0,
- "timestamps": {
- "first_timestamp_ns": 0,
- "last_timestamp_ns": 0
}, - "latency": {
- "minimum_ns": 0,
- "maximum_ns": 0,
- "average_ns": 0
}
}
]
}
], - "bgpv4_metrics": [
- {
- "name": "string",
- "session_state": "up",
- "session_flap_count": 0,
- "routes_advertised": 0,
- "routes_received": 0,
- "route_withdraws_sent": 0,
- "route_withdraws_received": 0,
- "updates_sent": 0,
- "updates_received": 0,
- "opens_sent": 0,
- "opens_received": 0,
- "keepalives_sent": 0,
- "keepalives_received": 0,
- "notifications_sent": 0,
- "notifications_received": 0,
- "fsm_state": "idle",
- "end_of_rib_received": 0
}
], - "bgpv6_metrics": [
- {
- "name": "string",
- "session_state": "up",
- "session_flap_count": 0,
- "routes_advertised": 0,
- "routes_received": 0,
- "route_withdraws_sent": 0,
- "route_withdraws_received": 0,
- "updates_sent": 0,
- "updates_received": 0,
- "opens_sent": 0,
- "opens_received": 0,
- "keepalives_sent": 0,
- "keepalives_received": 0,
- "notifications_sent": 0,
- "notifications_received": 0,
- "fsm_state": "idle",
- "end_of_rib_received": 0
}
], - "isis_metrics": [
- {
- "name": "string",
- "l1_sessions_up": 0,
- "l1_session_flap": 0,
- "l1_broadcast_hellos_sent": 0,
- "l1_broadcast_hellos_received": 0,
- "l1_point_to_point_hellos_sent": 0,
- "l1_point_to_point_hellos_received": 0,
- "l1_database_size": 0,
- "l1_psnp_sent": 0,
- "l1_psnp_received": 0,
- "l1_csnp_sent": 0,
- "l1_csnp_received": 0,
- "l1_lsp_sent": 0,
- "l1_lsp_received": 0,
- "l2_sessions_up": 0,
- "l2_session_flap": 0,
- "l2_broadcast_hellos_sent": 0,
- "l2_broadcast_hellos_received": 0,
- "l2_point_to_point_hellos_sent": 0,
- "l2_point_to_point_hellos_received": 0,
- "l2_database_size": 0,
- "l2_psnp_sent": 0,
- "l2_psnp_received": 0,
- "l2_csnp_sent": 0,
- "l2_csnp_received": 0,
- "l2_lsp_sent": 0,
- "l2_lsp_received": 0
}
], - "lag_metrics": [
- {
- "name": "string",
- "oper_status": "up",
- "member_ports_up": 0,
- "frames_tx": 0,
- "frames_rx": 0,
- "bytes_tx": 0,
- "bytes_rx": 0,
- "frames_tx_rate": 0,
- "frames_rx_rate": 0,
- "bytes_tx_rate": 0,
- "bytes_rx_rate": 0
}
], - "lacp_metrics": [
- {
- "lag_name": "string",
- "lag_member_port_name": "string",
- "lacp_packets_rx": 0,
- "lacp_packets_tx": 0,
- "lacp_rx_errors": 0,
- "activity": "active",
- "timeout": "short",
- "synchronization": "in_sync",
- "aggregatable": true,
- "collecting": true,
- "distributing": true,
- "system_id": "string",
- "oper_key": 0,
- "partner_id": "string",
- "partner_key": 0,
- "port_num": 0,
- "partner_port_num": 0
}
], - "lldp_metrics": [
- {
- "name": "string",
- "frames_rx": 0,
- "frames_tx": 0,
- "frames_error_rx": 0,
- "frames_discard": 0,
- "tlvs_discard": 0,
- "tlvs_unknown": 0
}
], - "rsvp_metrics": [
- {
- "name": "string",
- "ingress_p2p_lsps_configured": 0,
- "ingress_p2p_lsps_up": 0,
- "egress_p2p_lsps_up": 0,
- "lsp_flap_count": 0,
- "paths_tx": 0,
- "paths_rx": 0,
- "resvs_tx": 0,
- "resvs_rx": 0,
- "path_tears_tx": 0,
- "path_tears_rx": 0,
- "resv_tears_tx": 0,
- "resv_tears_rx": 0,
- "path_errors_tx": 0,
- "path_errors_rx": 0,
- "resv_errors_tx": 0,
- "resv_errors_rx": 0,
- "resv_conf_tx": 0,
- "resv_conf_rx": 0,
- "hellos_tx": 0,
- "hellos_rx": 0,
- "acks_tx": 0,
- "acks_rx": 0,
- "nacks_tx": 0,
- "nacks_rx": 0,
- "srefresh_tx": 0,
- "srefresh_rx": 0,
- "bundle_tx": 0,
- "bundle_rx": 0,
- "path_reevaluation_request_tx": 0,
- "path_reoptimizations": 0
}
], - "dhcpv4client_metrics": [
- {
- "name": "string",
- "discovers_sent": 0,
- "offers_received": 0,
- "requests_sent": 0,
- "acks_received": 0,
- "nacks_received": 0,
- "releases_sent": 0,
- "declines_sent": 0
}
], - "dhcpv4server_metrics": [
- {
- "name": "string",
- "discovers_received": 0,
- "offers_sent": 0,
- "requests_received": 0,
- "acks_sent": 0,
- "nacks_sent": 0,
- "releases_received": 0,
- "declines_received": 0
}
], - "dhcpv6client_metrics": [
- {
- "name": "string",
- "solicits_sent": 0,
- "advertisements_received": 0,
- "advertisements_ignored": 0,
- "requests_sent": 0,
- "nacks_received": 0,
- "replies_received": 0,
- "information_requests_sent": 0,
- "renews_sent": 0,
- "rebinds_sent": 0,
- "releases_sent": 0,
- "reconfigures_received": 0,
- "rapid_commit_solicits_sent": 0,
- "rapid_commit_replies_received": 0
}
], - "dhcpv6server_metrics": [
- {
- "name": "string",
- "solicits_received": 0,
- "solicits_ignored": 0,
- "advertisements_sent": 0,
- "requests_received": 0,
- "nacks_sent": 0,
- "confirms_received": 0,
- "renewals_received": 0,
- "rebinds_received": 0,
- "replies_sent": 0,
- "releases_received": 0,
- "declines_received": 0,
- "information_requests_received": 0,
- "relay_forwards_received": 0,
- "relay_replies_sent": 0,
- "reconfigures_sent": 0
}
], - "ospfv2_metrics": [
- {
- "name": "string",
- "full_state_count": 0,
- "down_state_count": 0,
- "sessions_flap": 0,
- "hellos_sent": 0,
- "hellos_received": 0,
- "dbd_sent": 0,
- "dbd_received": 0,
- "ls_request_sent": 0,
- "ls_request_received": 0,
- "ls_update_sent": 0,
- "ls_update_received": 0,
- "ls_ack_sent": 0,
- "ls_ack_received": 0,
- "lsa_sent": 0,
- "lsa_received": 0,
- "lsa_ack_sent": 0,
- "lsa_ack_received": 0,
- "router_lsa_sent": 0,
- "router_lsa_received": 0,
- "network_lsa_sent": 0,
- "network_lsa_received": 0,
- "summary_lsa_sent": 0,
- "summary_lsa_received": 0,
- "external_lsa_sent": 0,
- "external_lsa_received": 0,
- "nssa_lsa_sent": 0,
- "nssa_lsa_received": 0,
- "opaque_local_sent": 0,
- "opaque_local_received": 0,
- "opaque_area_sent": 0,
- "opaque_area_received": 0,
- "opaque_domain_sent": 0,
- "opaque_domain_received": 0
}
]
}
Request to traffic generator for states of choice
choice | string Default: "ipv4_neighbors" Enum: "ipv4_neighbors" "ipv6_neighbors" "bgp_prefixes" "isis_lsps" "lldp_neighbors" "rsvp_lsps" "dhcpv4_interfaces" "dhcpv4_leases" "dhcpv6_interfaces" "dhcpv6_leases" "ospfv2_lsas" |
object (Neighborsv4.States.Request) The request to retrieve IPv4 Neighbor state (ARP cache entries) of a network interface(s). | |
object (Neighborsv6.States.Request) The request to retrieve IPv6 Neighbor state (NDISC cache entries) of a network interface(s). | |
object (BgpPrefix.State.Request) The request to retrieve BGP peer prefix information. @@ -616,7 +616,7 @@Response samples
Content type application/json { |