diff --git a/artifacts/openapi.html b/artifacts/openapi.html index a69a6d0a..fd2b2604 100644 --- a/artifacts/openapi.html +++ b/artifacts/openapi.html @@ -554,9 +554,9 @@

Responses

Request samples

Content type
application/json
{
  • "ports": [
    ],
  • "lags": [
    ],
  • "layer1": [
    ],
  • "captures": [
    ],
  • "devices": [
    ],
  • "flows": [
    ],
  • "events": {
    },
  • "options": {
    },
  • "lldp": [
    ]
}

Response samples

Content type
application/json
{
  • "warnings": [
    ]
}

get_config

Responses

Request samples

Content type
application/json
{
  • "ports": [
    ],
  • "lags": [
    ],
  • "layer1": [
    ],
  • "captures": [
    ],
  • "devices": [
    ],
  • "flows": [
    ],
  • "events": {
    },
  • "options": {
    },
  • "lldp": [
    ]
}

Response samples

Content type
application/json
{
  • "warnings": [
    ]
}

get_config

Responses

Response samples

Content type
application/json
{
  • "ports": [
    ],
  • "lags": [
    ],
  • "layer1": [
    ],
  • "captures": [
    ],
  • "devices": [
    ],
  • "flows": [
    ],
  • "events": {
    },
  • "options": {
    },
  • "lldp": [
    ]
}

update_config

Updates specific attributes of resources configured on the traffic generator. The fetched configuration shall reflect the updates applied successfully. +

Response samples

Content type
application/json
{
  • "ports": [
    ],
  • "lags": [
    ],
  • "layer1": [
    ],
  • "captures": [
    ],
  • "devices": [
    ],
  • "flows": [
    ],
  • "events": {
    },
  • "options": {
    },
  • "lldp": [
    ]
}

update_config

Updates specific attributes of resources configured on the traffic generator. The fetched configuration shall reflect the updates applied successfully. The Response.Warnings in the Success response is available for implementers to disclose additional information about a state change including any implicit changes that are outside the scope of the state change.

Request Body schema: application/json
choice
string
Value: "flows"
object (Flows.Update)

A container of flows with associated properties to be updated without affecting the flows current transmit state.

Responses

Responses

Request samples

Content type
application/json
{
  • "choice": "port",
  • "port": {
    },
  • "protocol": {
    },
  • "traffic": {
    }
}

Response samples

Content type
application/json
{
  • "warnings": [
    ]
}

set_control_action

Triggers actions against configured resources.

+

Request samples

Content type
application/json
{
  • "choice": "port",
  • "port": {
    },
  • "protocol": {
    },
  • "traffic": {
    }
}

Response samples

Content type
application/json
{
  • "warnings": [
    ]
}

set_control_action

Triggers actions against configured resources.

Request Body schema: application/json
choice
required
string
Value: "protocol"
object (Action.Protocol)

Actions associated with protocols on configured resources.

Responses

Request samples

Content type
application/json
{
  • "choice": "protocol",
  • "protocol": {
    }
}

Response samples

Content type
application/json
{
  • "warnings": [
    ],
  • "response": {
    }
}

Monitor

get_metrics

Request Body schema: application/json

Request to traffic generator for metrics of choice

-
choice
string
Default: "port"
Enum: "port" "flow" "bgpv4" "bgpv6" "isis" "lag" "lacp" "lldp" "rsvp" "dhcpv4_client" "dhcpv4_server" "dhcpv6_client" "dhcpv6_server"
object (Port.Metrics.Request)

The port result request to the traffic generator

+
choice
string
Default: "port"
Enum: "port" "flow" "bgpv4" "bgpv6" "isis" "lag" "lacp" "lldp" "rsvp" "dhcpv4_client" "dhcpv4_server" "dhcpv6_client" "dhcpv6_server" "ospfv2"
object (Port.Metrics.Request)

The port result request to the traffic generator

object (Flow.Metrics.Request)

The container for a flow metric request.

object (Bgpv4.Metrics.Request)

The request to retrieve BGPv4 per peer metrics/statistics.

object (Bgpv6.Metrics.Request)

The request to retrieve BGPv6 per peer metrics/statistics.

@@ -586,11 +586,12 @@
object (Dhcpv4Client.Metrics.Request)

The request to retrieve DHCPv4 per client metrics/statistics.

object (Dhcpv4Server.Metrics.Request)

The request to retrieve DHCPv4 per Server metrics/statistics.

object (Dhcpv6Client.Metrics.Request)

The request to retrieve DHCPv6 per client metrics/statistics.

-
object (Dhcpv6Server.Metrics.Request)

The request to retrieve DHCPv6 per Server metrics/statistics.

+
object (Dhcpv6Server.Metrics.Request)

The request to retrieve DHCPv6 per Server metrics/statistics.

+
object (Ospfv2.Metrics.Request)

The request to retrieve OSPFv2 per Router metrics/statistics.

Responses

Request samples

Content type
application/json
{
  • "choice": "port",
  • "port": {
    },
  • "flow": {
    },
  • "bgpv4": {
    },
  • "bgpv6": {
    },
  • "isis": {
    },
  • "lag": {
    },
  • "lacp": {
    },
  • "lldp": {
    },
  • "rsvp": {
    },
  • "dhcpv4_client": {
    },
  • "dhcpv4_server": {
    },
  • "dhcpv6_client": {
    },
  • "dhcpv6_server": {
    }
}

Response samples

Content type
application/json
{
  • "choice": "port_metrics",
  • "port_metrics": [
    ],
  • "flow_metrics": [
    ],
  • "bgpv4_metrics": [
    ],
  • "bgpv6_metrics": [
    ],
  • "isis_metrics": [
    ],
  • "lag_metrics": [
    ],
  • "lacp_metrics": [
    ],
  • "lldp_metrics": [
    ],
  • "rsvp_metrics": [
    ],
  • "dhcpv4client_metrics": [
    ],
  • "dhcpv4server_metrics": [
    ],
  • "dhcpv6client_metrics": [
    ],
  • "dhcpv6server_metrics": [
    ]
}

get_states

Request Body schema: application/json

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"
object (Neighborsv4.States.Request)

The request to retrieve IPv4 Neighbor state (ARP cache entries) of a network interface(s).

+

Request samples

Content type
application/json
{
  • "choice": "port",
  • "port": {
    },
  • "flow": {
    },
  • "bgpv4": {
    },
  • "bgpv6": {
    },
  • "isis": {
    },
  • "lag": {
    },
  • "lacp": {
    },
  • "lldp": {
    },
  • "rsvp": {
    },
  • "dhcpv4_client": {
    },
  • "dhcpv4_server": {
    },
  • "dhcpv6_client": {
    },
  • "dhcpv6_server": {
    },
  • "ospfv2": {
    }
}

Response samples

Content type
application/json
{
  • "choice": "port_metrics",
  • "port_metrics": [
    ],
  • "flow_metrics": [
    ],
  • "bgpv4_metrics": [
    ],
  • "bgpv6_metrics": [
    ],
  • "isis_metrics": [
    ],
  • "lag_metrics": [
    ],
  • "lacp_metrics": [
    ],
  • "lldp_metrics": [
    ],
  • "rsvp_metrics": [
    ],
  • "dhcpv4client_metrics": [
    ],
  • "dhcpv4server_metrics": [
    ],
  • "dhcpv6client_metrics": [
    ],
  • "dhcpv6server_metrics": [
    ],
  • "ospfv2_metrics": [
    ]
}

get_states

Request Body schema: application/json

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.

object (IsisLsps.State.Request)

The request to retrieve ISIS Link State PDU (LSP) information learned by the router.

@@ -599,10 +600,11 @@
object (Dhcpv4Interface.State.Request)

The request for assigned IPv4 address information associated with DHCP Client sessions.

object (Dhcpv4Lease.State.Request)

The request to retrieve DHCP Server host allocated status.

object (Dhcpv6Interface.State.Request)

The request for assigned IPv6 address information associated with DHCP Client sessions.

-
object (Dhcpv6Lease.State.Request)

The request to retrieve DHCP Server host allocated status.

+
object (Dhcpv6Lease.State.Request)

The request to retrieve DHCP Server host allocated status.

+
object (Ospfv2Lsas.State.Request)

The request to retrieve OSPFv2 Link State Advertisements (LSA) information learned by the routers.

Responses

Request samples

Content type
application/json
{
  • "choice": "ipv4_neighbors",
  • "ipv4_neighbors": {
    },
  • "ipv6_neighbors": {
    },
  • "bgp_prefixes": {
    },
  • "isis_lsps": {
    },
  • "lldp_neighbors": {
    },
  • "rsvp_lsps": {
    },
  • "dhcpv4_interfaces": {
    },
  • "dhcpv4_leases": {
    },
  • "dhcpv6_interfaces": {
    },
  • "dhcpv6_leases": {
    }
}

Response samples

Content type
application/json
{
  • "choice": "ipv4_neighbors",
  • "ipv4_neighbors": [
    ],
  • "ipv6_neighbors": [
    ],
  • "bgp_prefixes": [
    ],
  • "isis_lsps": [
    ],
  • "lldp_neighbors": [
    ],
  • "rsvp_lsps": [
    ],
  • "dhcpv4_interfaces": [
    ],
  • "dhcpv4_leases": [
    ],
  • "dhcpv6_interfaces": [
    ],
  • "dhcpv6_leases": [
    ]
}

get_capture

Request Body schema: application/json

Capture results request to the traffic generator.

+

Request samples

Content type
application/json
{
  • "choice": "ipv4_neighbors",
  • "ipv4_neighbors": {
    },
  • "ipv6_neighbors": {
    },
  • "bgp_prefixes": {
    },
  • "isis_lsps": {
    },
  • "lldp_neighbors": {
    },
  • "rsvp_lsps": {
    },
  • "dhcpv4_interfaces": {
    },
  • "dhcpv4_leases": {
    },
  • "dhcpv6_interfaces": {
    },
  • "dhcpv6_leases": {
    },
  • "ospfv2_lsas": {
    }
}

Response samples

Content type
application/json
{
  • "choice": "ipv4_neighbors",
  • "ipv4_neighbors": [
    ],
  • "ipv6_neighbors": [
    ],
  • "bgp_prefixes": [
    ],
  • "isis_lsps": [
    ],
  • "lldp_neighbors": [
    ],
  • "rsvp_lsps": [
    ],
  • "dhcpv4_interfaces": [
    ],
  • "dhcpv4_leases": [
    ],
  • "dhcpv6_interfaces": [
    ],
  • "dhcpv6_leases": [
    ],
  • "ospfv2_lsas": [
    ]
}

get_capture

Request Body schema: application/json

Capture results request to the traffic generator.

port_name
required
string

The name of a port a capture is started on.

x-constraint:

    @@ -614,7 +616,7 @@

Response samples

Content type
application/json
{
  • "api_spec_version": "",
  • "sdk_version": "",
  • "app_version": ""
}