diff --git a/artifacts/openapi.html b/artifacts/openapi.html index 9d2e6ed9..8af0ebc1 100644 --- a/artifacts/openapi.html +++ b/artifacts/openapi.html @@ -602,7 +602,7 @@
The request to retrieve DHCP Server host allocated status.
{- "choice": "ipv4_neighbors",
- "ipv4_neighbors": {
- "ethernet_names": [
- "string"
]
}, - "ipv6_neighbors": {
- "ethernet_names": [
- "string"
]
}, - "bgp_prefixes": {
- "bgp_peer_names": [
- "string"
], - "prefix_filters": [
- "ipv4_unicast"
], - "ipv4_unicast_filters": [
- {
- "addresses": [
- "192.168.0.1"
], - "prefix_length": 0,
- "origin": "igp",
- "path_id": 0
}
], - "ipv6_unicast_filters": [
- {
- "addresses": [
- "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
], - "prefix_length": 0,
- "origin": "igp",
- "path_id": 0
}
]
}, - "isis_lsps": {
- "isis_router_names": [
- "string"
]
}, - "lldp_neighbors": {
- "lldp_names": [
- "string"
], - "neighbor_id_filters": [
- "string"
]
}, - "rsvp_lsps": {
- "rsvp_router_names": [
- "string"
]
}, - "dhcpv4_interfaces": {
- "dhcp_client_names": [
- "string"
]
}, - "dhcpv4_leases": {
- "dhcp_server_names": [
- "string"
]
}, - "dhcpv6_interfaces": {
- "dhcp_client_names": [
- "string"
]
}, - "dhcpv6_leases": {
- "dhcp_server_names": [
- "string"
]
}
}
{- "choice": "ipv4_neighbors",
- "ipv4_neighbors": [
- {
- "ethernet_name": "string",
- "ipv4_address": "192.168.0.1",
- "link_layer_address": "string"
}
], - "ipv6_neighbors": [
- {
- "ethernet_name": "string",
- "ipv6_address": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
- "link_layer_address": "string"
}
], - "bgp_prefixes": [
- {
- "bgp_peer_name": "string",
- "ipv4_unicast_prefixes": [
- {
- "ipv4_address": "string",
- "prefix_length": 0,
- "origin": "igp",
- "path_id": 0,
- "ipv4_next_hop": "192.168.0.1",
- "ipv6_next_hop": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
- "communities": [
- {
- "type": "manual_as_number",
- "as_number": 0,
- "as_custom": 0
}
], - "extended_communities": [
- {
- "raw": "string",
- "structured": {
- "choice": "transitive_2octet_as_type",
- "transitive_2octet_as_type": {
- "choice": "route_target_subtype",
- "route_target_subtype": {
- "global_2byte_as": null,
- "local_4byte_admin": null
}, - "route_origin_subtype": {
- "global_2byte_as": null,
- "local_4byte_admin": null
}
}, - "transitive_ipv4_address_type": {
- "choice": "route_target_subtype",
- "route_target_subtype": {
- "global_ipv4_admin": null,
- "local_2byte_admin": null
}, - "route_origin_subtype": {
- "global_ipv4_admin": null,
- "local_2byte_admin": null
}
}, - "transitive_4octet_as_type": {
- "choice": "route_target_subtype",
- "route_target_subtype": {
- "global_4byte_as": null,
- "local_2byte_admin": null
}, - "route_origin_subtype": {
- "global_4byte_as": null,
- "local_2byte_admin": null
}
}, - "transitive_opaque_type": {
- "choice": "color_subtype",
- "color_subtype": {
- "flags": null,
- "color": null
}, - "encapsulation_subtype": {
- "reserved": null,
- "tunnel_type": null
}
}, - "non_transitive_2octet_as_type": {
- "choice": "link_bandwidth_subtype",
- "link_bandwidth_subtype": {
- "global_2byte_as": null,
- "bandwidth": null
}
}
}
}
], - "as_path": {
- "segments": [
- {
- "type": "as_seq",
- "as_numbers": [
- 0
]
}
]
}, - "local_preference": 0,
- "multi_exit_discriminator": 0
}
], - "ipv6_unicast_prefixes": [
- {
- "ipv6_address": "string",
- "prefix_length": 0,
- "origin": "igp",
- "path_id": 0,
- "ipv4_next_hop": "192.168.0.1",
- "ipv6_next_hop": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
- "communities": [
- {
- "type": "manual_as_number",
- "as_number": 0,
- "as_custom": 0
}
], - "extended_communities": [
- {
- "raw": "string",
- "structured": {
- "choice": "transitive_2octet_as_type",
- "transitive_2octet_as_type": {
- "choice": "route_target_subtype",
- "route_target_subtype": {
- "global_2byte_as": null,
- "local_4byte_admin": null
}, - "route_origin_subtype": {
- "global_2byte_as": null,
- "local_4byte_admin": null
}
}, - "transitive_ipv4_address_type": {
- "choice": "route_target_subtype",
- "route_target_subtype": {
- "global_ipv4_admin": null,
- "local_2byte_admin": null
}, - "route_origin_subtype": {
- "global_ipv4_admin": null,
- "local_2byte_admin": null
}
}, - "transitive_4octet_as_type": {
- "choice": "route_target_subtype",
- "route_target_subtype": {
- "global_4byte_as": null,
- "local_2byte_admin": null
}, - "route_origin_subtype": {
- "global_4byte_as": null,
- "local_2byte_admin": null
}
}, - "transitive_opaque_type": {
- "choice": "color_subtype",
- "color_subtype": {
- "flags": null,
- "color": null
}, - "encapsulation_subtype": {
- "reserved": null,
- "tunnel_type": null
}
}, - "non_transitive_2octet_as_type": {
- "choice": "link_bandwidth_subtype",
- "link_bandwidth_subtype": {
- "global_2byte_as": null,
- "bandwidth": null
}
}
}
}
], - "as_path": {
- "segments": [
- {
- "type": "as_seq",
- "as_numbers": [
- 0
]
}
]
}, - "local_preference": 0,
- "multi_exit_discriminator": 0
}
]
}
], - "isis_lsps": [
- {
- "isis_router_name": "string",
- "lsps": [
- {
- "lsp_id": "string",
- "pdu_type": "level_1",
- "remaining_lifetime": 0,
- "sequence_number": 0,
- "pdu_length": 0,
- "flags": {
- "partition_repair": true,
- "attached_error": true,
- "attached_expense": true,
- "attached_delay": true,
- "attached_default": true,
- "overload": true
}, - "is_type": 0,
- "tlvs": {
- "hostname_tlvs": [
- {
- "hostname": "string"
}
], - "is_reachability_tlvs": [
- {
- "neighbors": [
- {
- "system_id": null
}
]
}
], - "extended_is_reachability_tlvs": [
- {
- "neighbors": [
- {
- "system_id": null
}
]
}
], - "ipv4_internal_reachability_tlvs": [
- {
- "prefixes": [
- {
- "ipv4_address": null,
- "prefix_length": null,
- "redistribution_type": null,
- "default_metric": null,
- "origin_type": null
}
]
}
], - "ipv4_external_reachability_tlvs": [
- {
- "prefixes": [
- {
- "ipv4_address": null,
- "prefix_length": null,
- "redistribution_type": null,
- "default_metric": null,
- "origin_type": null
}
]
}
], - "extended_ipv4_reachability_tlvs": [
- {
- "prefixes": [
- {
- "ipv4_address": null,
- "prefix_length": null,
- "metric": null,
- "redistribution_type": null,
- "prefix_attributes": null
}
]
}
], - "ipv6_reachability_tlvs": [
- {
- "prefixes": [
- {
- "ipv6_address": null,
- "prefix_length": null,
- "metric": null,
- "redistribution_type": null,
- "origin_type": null,
- "prefix_attributes": null
}
]
}
]
}
}
]
}
], - "lldp_neighbors": [
- {
- "lldp_name": "string",
- "system_name": "string",
- "system_description": "string",
- "chassis_id": "string",
- "chassis_id_type": "port_component",
- "neighbor_id": "string",
- "age": 0,
- "last_update": 0,
- "ttl": 0,
- "port_id": "string",
- "port_id_type": "port_component",
- "port_description": "string",
- "management_address": "string",
- "management_address_type": "string",
- "custom_tlvs": [
- {
- "custom_type": 0,
- "oui": "string",
- "oui_subtype": "string"
}
], - "capabilities": [
- {
- "capability_name": "mac_bridge",
- "capability_enabled": true
}
]
}
], - "rsvp_lsps": [
- {
- "rsvp_router_name": "string",
- "ipv4_lsps": [
- {
- "source_address": "192.168.0.1",
- "destination_address": "192.168.0.1",
- "lsp": {
- "tunnel_id": 0,
- "lsp_id": 0,
- "session_name": "string",
- "label_in": 0,
- "label_out": 0,
- "session_status": "up",
- "last_flap_reason": "resv_tear",
- "up_time": 0
}, - "rros": [
- {
- "address": "192.168.0.1",
- "reported_label": 0
}
], - "eros": [
- {
- "prefix": "192.168.0.1",
- "asn": 0,
- "type": "ipv4"
}
]
}
]
}
], - "dhcpv4_interfaces": [
- {
- "dhcp_client_name": "string",
- "ipv4_address": "string",
- "prefix_length": 0,
- "gateway_address": "string",
- "lease_time": 0,
- "renew_time": 0,
- "rebind_time": 0
}
], - "dhcpv4_leases": [
- {
- "dhcp_server_name": "string",
- "leases": [
- {
- "address": "string",
- "valid_time": 0,
- "preferred_time": 0,
- "renew_time": 0,
- "rebind_time": 0,
- "client_id": "string",
- "circuit_id": "string",
- "remote_id": "string"
}
]
}
], - "dhcpv6_interfaces": [
- {
- "dhcp_client_name": "string",
- "ipv6_iapd_address": "string",
- "iapd_prefix_length": 0,
- "ipv6_address": "string",
- "gateway_address": "string",
- "lease_time": 0,
- "renew_time": 0,
- "rebind_time": 0
}
], - "dhcpv6_leases": [
- {
- "dhcp_server_name": "string",
- "leases": [
- {
- "address": "string",
- "valid_time": 0,
- "preferred_time": 0,
- "renew_time": 0,
- "rebind_time": 0,
- "client_id": "string",
- "remote_id": "string",
- "interface_id": "string"
}
]
}
]
}
{- "choice": "ipv4_neighbors",
- "ipv4_neighbors": {
- "ethernet_names": [
- "string"
]
}, - "ipv6_neighbors": {
- "ethernet_names": [
- "string"
]
}, - "bgp_prefixes": {
- "bgp_peer_names": [
- "string"
], - "prefix_filters": [
- "ipv4_unicast"
], - "ipv4_unicast_filters": [
- {
- "addresses": [
- "192.168.0.1"
], - "prefix_length": 0,
- "origin": "igp",
- "path_id": 0
}
], - "ipv6_unicast_filters": [
- {
- "addresses": [
- "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
], - "prefix_length": 0,
- "origin": "igp",
- "path_id": 0
}
]
}, - "isis_lsps": {
- "isis_router_names": [
- "string"
]
}, - "lldp_neighbors": {
- "lldp_names": [
- "string"
], - "neighbor_id_filters": [
- "string"
]
}, - "rsvp_lsps": {
- "rsvp_router_names": [
- "string"
]
}, - "dhcpv4_interfaces": {
- "dhcp_client_names": [
- "string"
]
}, - "dhcpv4_leases": {
- "dhcp_server_names": [
- "string"
]
}, - "dhcpv6_interfaces": {
- "dhcp_client_names": [
- "string"
]
}, - "dhcpv6_leases": {
- "dhcp_server_names": [
- "string"
]
}
}
{- "choice": "ipv4_neighbors",
- "ipv4_neighbors": [
- {
- "ethernet_name": "string",
- "ipv4_address": "192.168.0.1",
- "link_layer_address": "string"
}
], - "ipv6_neighbors": [
- {
- "ethernet_name": "string",
- "ipv6_address": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
- "link_layer_address": "string"
}
], - "bgp_prefixes": [
- {
- "bgp_peer_name": "string",
- "ipv4_unicast_prefixes": [
- {
- "ipv4_address": "string",
- "prefix_length": 0,
- "origin": "igp",
- "path_id": 0,
- "ipv4_next_hop": "192.168.0.1",
- "ipv6_next_hop": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
- "communities": [
- {
- "type": "manual_as_number",
- "as_number": 0,
- "as_custom": 0
}
], - "extended_communities": [
- {
- "raw": "string",
- "structured": {
- "choice": "transitive_2octet_as_type",
- "transitive_2octet_as_type": {
- "choice": "route_target_subtype",
- "route_target_subtype": {
- "global_2byte_as": null,
- "local_4byte_admin": null
}, - "route_origin_subtype": {
- "global_2byte_as": null,
- "local_4byte_admin": null
}
}, - "transitive_ipv4_address_type": {
- "choice": "route_target_subtype",
- "route_target_subtype": {
- "global_ipv4_admin": null,
- "local_2byte_admin": null
}, - "route_origin_subtype": {
- "global_ipv4_admin": null,
- "local_2byte_admin": null
}
}, - "transitive_4octet_as_type": {
- "choice": "route_target_subtype",
- "route_target_subtype": {
- "global_4byte_as": null,
- "local_2byte_admin": null
}, - "route_origin_subtype": {
- "global_4byte_as": null,
- "local_2byte_admin": null
}
}, - "transitive_opaque_type": {
- "choice": "color_subtype",
- "color_subtype": {
- "flags": null,
- "color": null
}, - "encapsulation_subtype": {
- "reserved": null,
- "tunnel_type": null
}
}, - "non_transitive_2octet_as_type": {
- "choice": "link_bandwidth_subtype",
- "link_bandwidth_subtype": {
- "global_2byte_as": null,
- "bandwidth": null
}
}
}
}
], - "as_path": {
- "segments": [
- {
- "type": "as_seq",
- "as_numbers": [
- 0
]
}
]
}, - "local_preference": 0,
- "multi_exit_discriminator": 0
}
], - "ipv6_unicast_prefixes": [
- {
- "ipv6_address": "string",
- "prefix_length": 0,
- "origin": "igp",
- "path_id": 0,
- "ipv4_next_hop": "192.168.0.1",
- "ipv6_next_hop": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
- "communities": [
- {
- "type": "manual_as_number",
- "as_number": 0,
- "as_custom": 0
}
], - "extended_communities": [
- {
- "raw": "string",
- "structured": {
- "choice": "transitive_2octet_as_type",
- "transitive_2octet_as_type": {
- "choice": "route_target_subtype",
- "route_target_subtype": {
- "global_2byte_as": null,
- "local_4byte_admin": null
}, - "route_origin_subtype": {
- "global_2byte_as": null,
- "local_4byte_admin": null
}
}, - "transitive_ipv4_address_type": {
- "choice": "route_target_subtype",
- "route_target_subtype": {
- "global_ipv4_admin": null,
- "local_2byte_admin": null
}, - "route_origin_subtype": {
- "global_ipv4_admin": null,
- "local_2byte_admin": null
}
}, - "transitive_4octet_as_type": {
- "choice": "route_target_subtype",
- "route_target_subtype": {
- "global_4byte_as": null,
- "local_2byte_admin": null
}, - "route_origin_subtype": {
- "global_4byte_as": null,
- "local_2byte_admin": null
}
}, - "transitive_opaque_type": {
- "choice": "color_subtype",
- "color_subtype": {
- "flags": null,
- "color": null
}, - "encapsulation_subtype": {
- "reserved": null,
- "tunnel_type": null
}
}, - "non_transitive_2octet_as_type": {
- "choice": "link_bandwidth_subtype",
- "link_bandwidth_subtype": {
- "global_2byte_as": null,
- "bandwidth": null
}
}
}
}
], - "as_path": {
- "segments": [
- {
- "type": "as_seq",
- "as_numbers": [
- 0
]
}
]
}, - "local_preference": 0,
- "multi_exit_discriminator": 0
}
]
}
], - "isis_lsps": [
- {
- "isis_router_name": "string",
- "lsps": [
- {
- "lsp_id": "string",
- "pdu_type": "level_1",
- "remaining_lifetime": 0,
- "sequence_number": 0,
- "pdu_length": 0,
- "flags": {
- "partition_repair": true,
- "attached_error": true,
- "attached_expense": true,
- "attached_delay": true,
- "attached_default": true,
- "overload": true
}, - "is_type": 0,
- "tlvs": {
- "hostname_tlvs": [
- {
- "hostname": "string"
}
], - "is_reachability_tlvs": [
- {
- "neighbors": [
- {
- "system_id": null
}
]
}
], - "extended_is_reachability_tlvs": [
- {
- "neighbors": [
- {
- "system_id": null
}
]
}
], - "ipv4_internal_reachability_tlvs": [
- {
- "prefixes": [
- {
- "ipv4_address": null,
- "prefix_length": null,
- "redistribution_type": null,
- "default_metric": null,
- "origin_type": null
}
]
}
], - "ipv4_external_reachability_tlvs": [
- {
- "prefixes": [
- {
- "ipv4_address": null,
- "prefix_length": null,
- "redistribution_type": null,
- "default_metric": null,
- "origin_type": null
}
]
}
], - "extended_ipv4_reachability_tlvs": [
- {
- "prefixes": [
- {
- "ipv4_address": null,
- "prefix_length": null,
- "metric": null,
- "redistribution_type": null,
- "prefix_attributes": null
}
]
}
], - "ipv6_reachability_tlvs": [
- {
- "prefixes": [
- {
- "ipv6_address": null,
- "prefix_length": null,
- "metric": null,
- "redistribution_type": null,
- "origin_type": null,
- "prefix_attributes": null
}
]
}
]
}
}
]
}
], - "lldp_neighbors": [
- {
- "lldp_name": "string",
- "system_name": "string",
- "system_description": "string",
- "chassis_id": "string",
- "chassis_id_type": "port_component",
- "neighbor_id": "string",
- "age": 0,
- "last_update": 0,
- "ttl": 0,
- "port_id": "string",
- "port_id_type": "port_component",
- "port_description": "string",
- "management_address": "string",
- "management_address_type": "string",
- "custom_tlvs": [
- {
- "custom_type": 0,
- "oui": "string",
- "oui_subtype": "string"
}
], - "capabilities": [
- {
- "capability_name": "mac_bridge",
- "capability_enabled": true
}
]
}
], - "rsvp_lsps": [
- {
- "rsvp_router_name": "string",
- "ipv4_lsps": [
- {
- "source_address": "192.168.0.1",
- "destination_address": "192.168.0.1",
- "lsp": {
- "tunnel_id": 0,
- "lsp_id": 0,
- "session_name": "string",
- "label_in": 0,
- "label_out": 0,
- "session_status": "up",
- "last_flap_reason": "resv_tear",
- "up_time": 0
}, - "rros": [
- {
- "address": "192.168.0.1",
- "reported_label": 0
}
], - "eros": [
- {
- "prefix": "192.168.0.1",
- "asn": 0,
- "type": "ipv4"
}
]
}
]
}
], - "dhcpv4_interfaces": [
- {
- "dhcp_client_name": "string",
- "ipv4_address": "string",
- "prefix_length": 0,
- "gateway_address": "string",
- "lease_time": 0,
- "renew_time": 0,
- "rebind_time": 0
}
], - "dhcpv4_leases": [
- {
- "dhcp_server_name": "string",
- "leases": [
- {
- "address": "string",
- "valid_time": 0,
- "preferred_time": 0,
- "renew_time": 0,
- "rebind_time": 0,
- "client_id": "string",
- "circuit_id": "string",
- "remote_id": "string"
}
]
}
], - "dhcpv6_interfaces": [
- {
- "dhcp_client_name": "string",
- "iapds": [
- {
- "address": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
- "prefix_length": 0
}
], - "addresses": [
- {
- "address": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
- "gateway": 0
}
], - "lease_time": 0,
- "renew_time": 0,
- "rebind_time": 0
}
], - "dhcpv6_leases": [
- {
- "dhcp_server_name": "string",
- "leases": [
- {
- "address": "string",
- "valid_time": 0,
- "preferred_time": 0,
- "renew_time": 0,
- "rebind_time": 0,
- "client_id": "string",
- "remote_id": "string",
- "interface_id": "string"
}
]
}
]
}
Capture results request to the traffic generator.
port_name required | string The name of a port a capture is started on. x-constraint:
Response samples
Content type application/json { |