Avi NetworkService Object API

CLI ``` - configure networkservice - show networkservice ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 20.1.2
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /networkservice
  2. post /networkservice
  3. delete /networkservice/{uuid}
  4. get /networkservice/{uuid}
  5. patch /networkservice/{uuid}
  6. put /networkservice/{uuid}
Up
get /networkservice
(networkserviceGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
cloud_uuid (optional)
Query Parameter — Filter to get objects that belongs to a specific cloud using its uuid. Eg. cloud_uuid=cloud-xyz.
cloud_ref.name (optional)
Query Parameter — Filter to get objects that belongs to a specific cloud usings its name. This uses cloud name rather than uuid. Eg. cloud_ref.name=Default-Cloud.

Return type

NetworkServiceApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "service_type" : "aeiou",
    "routing_service" : {
      "enable_routing" : true,
      "flowtable_profile" : {
        "udp_idle_timeout" : 123,
        "tcp_idle_timeout" : 123,
        "tcp_connection_setup_timeout" : 123,
        "tcp_closed_timeout" : 123,
        "tcp_reset_timeout" : 123,
        "tcp_half_closed_timeout" : 123
      },
      "advertise_backend_networks" : true,
      "enable_vmac" : true,
      "nat_policy_ref" : "aeiou",
      "routing_by_linux_ipstack" : true,
      "floating_intf_ip_se_2" : [ "" ],
      "enable_vip_on_all_interfaces" : true,
      "graceful_restart" : true,
      "floating_intf_ip" : [ {
        "addr" : "aeiou",
        "type" : "aeiou"
      } ],
      "enable_auto_gateway" : true
    },
    "cloud_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "vrf_ref" : "aeiou",
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou",
    "labels" : [ {
      "value" : "aeiou",
      "key" : "aeiou"
    } ],
    "se_group_ref" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK NetworkServiceApiResponse

401

log in failed

Up
post /networkservice
(networkservicePost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — NetworkService object creation

Return type

NetworkService

Example data

Content-Type: application/json
{
  "service_type" : "aeiou",
  "routing_service" : {
    "enable_routing" : true,
    "flowtable_profile" : {
      "udp_idle_timeout" : 123,
      "tcp_idle_timeout" : 123,
      "tcp_connection_setup_timeout" : 123,
      "tcp_closed_timeout" : 123,
      "tcp_reset_timeout" : 123,
      "tcp_half_closed_timeout" : 123
    },
    "advertise_backend_networks" : true,
    "enable_vmac" : true,
    "nat_policy_ref" : "aeiou",
    "routing_by_linux_ipstack" : true,
    "floating_intf_ip_se_2" : [ "" ],
    "enable_vip_on_all_interfaces" : true,
    "graceful_restart" : true,
    "floating_intf_ip" : [ {
      "addr" : "aeiou",
      "type" : "aeiou"
    } ],
    "enable_auto_gateway" : true
  },
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "vrf_ref" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "se_group_ref" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK NetworkService

401

log in failed

Up
delete /networkservice/{uuid}
(networkserviceUuidDelete)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found

Up
get /networkservice/{uuid}
(networkserviceUuidGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

NetworkService

Example data

Content-Type: application/json
{
  "service_type" : "aeiou",
  "routing_service" : {
    "enable_routing" : true,
    "flowtable_profile" : {
      "udp_idle_timeout" : 123,
      "tcp_idle_timeout" : 123,
      "tcp_connection_setup_timeout" : 123,
      "tcp_closed_timeout" : 123,
      "tcp_reset_timeout" : 123,
      "tcp_half_closed_timeout" : 123
    },
    "advertise_backend_networks" : true,
    "enable_vmac" : true,
    "nat_policy_ref" : "aeiou",
    "routing_by_linux_ipstack" : true,
    "floating_intf_ip_se_2" : [ "" ],
    "enable_vip_on_all_interfaces" : true,
    "graceful_restart" : true,
    "floating_intf_ip" : [ {
      "addr" : "aeiou",
      "type" : "aeiou"
    } ],
    "enable_auto_gateway" : true
  },
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "vrf_ref" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "se_group_ref" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK NetworkService

401

log in failed

Up
patch /networkservice/{uuid}
(networkserviceUuidPatch)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — NetworkService object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

NetworkService

Example data

Content-Type: application/json
{
  "service_type" : "aeiou",
  "routing_service" : {
    "enable_routing" : true,
    "flowtable_profile" : {
      "udp_idle_timeout" : 123,
      "tcp_idle_timeout" : 123,
      "tcp_connection_setup_timeout" : 123,
      "tcp_closed_timeout" : 123,
      "tcp_reset_timeout" : 123,
      "tcp_half_closed_timeout" : 123
    },
    "advertise_backend_networks" : true,
    "enable_vmac" : true,
    "nat_policy_ref" : "aeiou",
    "routing_by_linux_ipstack" : true,
    "floating_intf_ip_se_2" : [ "" ],
    "enable_vip_on_all_interfaces" : true,
    "graceful_restart" : true,
    "floating_intf_ip" : [ {
      "addr" : "aeiou",
      "type" : "aeiou"
    } ],
    "enable_auto_gateway" : true
  },
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "vrf_ref" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "se_group_ref" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK NetworkService

401

log in failed

Up
put /networkservice/{uuid}
(networkserviceUuidPut)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — NetworkService object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

NetworkService

Example data

Content-Type: application/json
{
  "service_type" : "aeiou",
  "routing_service" : {
    "enable_routing" : true,
    "flowtable_profile" : {
      "udp_idle_timeout" : 123,
      "tcp_idle_timeout" : 123,
      "tcp_connection_setup_timeout" : 123,
      "tcp_closed_timeout" : 123,
      "tcp_reset_timeout" : 123,
      "tcp_half_closed_timeout" : 123
    },
    "advertise_backend_networks" : true,
    "enable_vmac" : true,
    "nat_policy_ref" : "aeiou",
    "routing_by_linux_ipstack" : true,
    "floating_intf_ip_se_2" : [ "" ],
    "enable_vip_on_all_interfaces" : true,
    "graceful_restart" : true,
    "floating_intf_ip" : [ {
      "addr" : "aeiou",
      "type" : "aeiou"
    } ],
    "enable_auto_gateway" : true
  },
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "vrf_ref" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "se_group_ref" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK NetworkService

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. FlowtableProfile
  2. IpAddr
  3. KeyValue
  4. NetworkService
  5. NetworkServiceApiResponse
  6. RoutingService

FlowtableProfile Up

tcp_closed_timeout (optional)
Integer Idle timeout in seconds for TCP flows in closed state. Allowed values are 1-36000. Field introduced in 18.2.5. Unit is SECONDS. format: int32
tcp_connection_setup_timeout (optional)
Integer Idle timeout in seconds for nat TCP flows in connection setup state. Allowed values are 1-36000. Field introduced in 18.2.5. Unit is SECONDS. format: int32
tcp_half_closed_timeout (optional)
Integer Idle timeout in seconds for TCP flows in half closed state. Allowed values are 1-36000. Field introduced in 18.2.5. Unit is SECONDS. format: int32
tcp_idle_timeout (optional)
Integer Idle timeout in seconds for TCP flows. Allowed values are 1-36000. Field introduced in 18.2.5. Unit is SECONDS. format: int32
tcp_reset_timeout (optional)
Integer Timeout in seconds for TCP flows after RST is seen.Within this timeout, if any non-syn packet is seenfrom the endpoint from which RST is received,nat-flow moves to established state. Otherwise nat-flowis cleaned up. This state helps to mitigate the impactof RST attacks. Allowed values are 1-36000. Field introduced in 18.2.5. Unit is SECONDS. format: int32
udp_idle_timeout (optional)
Integer Idle timeout in seconds for UDP flows. Allowed values are 1-36000. Field introduced in 18.2.5. Unit is SECONDS. format: int32

IpAddr Up

addr
String IP address.
type
String Enum options - V4, DNS, V6.

KeyValue Up

key
String Key.
value (optional)
String Value.

NetworkService Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
cloud_ref (optional)
String It is a reference to an object of type Cloud. Field introduced in 18.2.5.
labels (optional)
array[KeyValue] Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2.
name
String Name of the NetworkService. Field introduced in 18.2.5.
routing_service (optional)
RoutingService Routing Information of the NetworkService. Field introduced in 18.2.5.
se_group_ref
String Service Engine Group to which the service is applied. It is a reference to an object of type ServiceEngineGroup. Field introduced in 18.2.5.
service_type
String Indicates the type of NetworkService. Enum options - ROUTING_SERVICE. Field introduced in 18.2.5.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Field introduced in 18.2.5.
url (optional)
String url
uuid (optional)
String UUID of the NetworkService. Field introduced in 18.2.5.
vrf_ref
String VRF context to which the service is scoped. It is a reference to an object of type VrfContext. Field introduced in 18.2.5.

NetworkServiceApiResponse Up

count
Integer format: int32
results
next (optional)

RoutingService Up

advertise_backend_networks (optional)
Boolean Advertise reachability of backend server networks via ADC through BGP for default gateway feature. Field introduced in 18.2.5.
enable_auto_gateway (optional)
Boolean Enable auto gateway to save and use the same L2 path to send the return traffic. Field introduced in 20.1.1.
enable_routing (optional)
Boolean Service Engine acts as Default Gateway for this service. Field introduced in 18.2.5.
enable_vip_on_all_interfaces (optional)
Boolean Enable VIP on all interfaces of this service. Field introduced in 18.2.5.
enable_vmac (optional)
Boolean Use Virtual MAC address for interfaces on which floating interface IPs are placed. Field introduced in 18.2.5.
floating_intf_ip (optional)
array[IpAddr] Floating Interface IPs for the RoutingService. Field introduced in 18.2.5.
floating_intf_ip_se_2 (optional)
array[IpAddr] If ServiceEngineGroup is configured for Legacy 1+1 Active Standby HA Mode, Floating IP's will be advertised only by the Active SE in the Pair. Virtual Services in this group must be disabled/enabled for any changes to the Floating IP's to take effect. Only active SE hosting VS tagged with Active Standby SE 2 Tag will advertise this floating IP when manual load distribution is enabled. Field introduced in 18.2.5.
flowtable_profile (optional)
FlowtableProfile Routing Service related Flow profile information. Field introduced in 18.2.5.
graceful_restart (optional)
Boolean Enable graceful restart feature in routing service. For example, BGP. Field introduced in 18.2.6.
nat_policy_ref (optional)
String NAT policy for outbound NAT functionality. This is done in post-routing. It is a reference to an object of type NatPolicy. Field introduced in 18.2.5.
routing_by_linux_ipstack (optional)
Boolean For IP Routing feature, enabling this knob will fallback to routing through Linux, by default routing is done via Service Engine data-path. Field introduced in 18.2.5.