Avi Network Object API

##CLI## ``` - configure network - show network ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 17.2.4
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 /network
  2. post /network
  3. delete /network/{uuid}
  4. get /network/{uuid}
  5. patch /network/{uuid}
  6. put /network/{uuid}
Up
get /network
( networkGet)

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.
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

NetworkApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "dhcp_enabled" : true,
    "vrf_context_ref" : "aeiou",
    "configured_subnets" : [ {
      "static_ranges" : [ {
        "end" : "",
        "begin" : ""
      } ],
      "prefix" : {
        "ip_addr" : {
          "addr" : "aeiou",
          "type" : "aeiou"
        },
        "mask" : 123
      },
      "static_ips" : [ "" ]
    } ],
    "exclude_discovered_subnets" : true,
    "cloud_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "vimgrnw_ref" : "aeiou",
    "vcenter_dvs" : true,
    "uuid" : "aeiou",
    "url" : "aeiou",
    "synced_from_se" : true
  } ]
}

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 NetworkApiResponse

401

log in failed

Up
post /network
( networkPost)

Consumes

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

Request body

body (required)
Body Parameter — Network object creation

Return type

Network

Example data

Content-Type: application/json
{
  "dhcp_enabled" : true,
  "vrf_context_ref" : "aeiou",
  "configured_subnets" : [ {
    "static_ranges" : [ {
      "end" : "",
      "begin" : ""
    } ],
    "prefix" : {
      "ip_addr" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "mask" : 123
    },
    "static_ips" : [ "" ]
  } ],
  "exclude_discovered_subnets" : true,
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "vimgrnw_ref" : "aeiou",
  "vcenter_dvs" : true,
  "uuid" : "aeiou",
  "url" : "aeiou",
  "synced_from_se" : true
}

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 Network

401

log in failed

Up
delete /network/{uuid}
( networkUuidDelete)

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 /network/{uuid}
( networkUuidGet)

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.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

Network

Example data

Content-Type: application/json
{
  "dhcp_enabled" : true,
  "vrf_context_ref" : "aeiou",
  "configured_subnets" : [ {
    "static_ranges" : [ {
      "end" : "",
      "begin" : ""
    } ],
    "prefix" : {
      "ip_addr" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "mask" : 123
    },
    "static_ips" : [ "" ]
  } ],
  "exclude_discovered_subnets" : true,
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "vimgrnw_ref" : "aeiou",
  "vcenter_dvs" : true,
  "uuid" : "aeiou",
  "url" : "aeiou",
  "synced_from_se" : true
}

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 Network

401

log in failed

Up
patch /network/{uuid}
( networkUuidPatch)

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 — Network object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

Network

Example data

Content-Type: application/json
{
  "dhcp_enabled" : true,
  "vrf_context_ref" : "aeiou",
  "configured_subnets" : [ {
    "static_ranges" : [ {
      "end" : "",
      "begin" : ""
    } ],
    "prefix" : {
      "ip_addr" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "mask" : 123
    },
    "static_ips" : [ "" ]
  } ],
  "exclude_discovered_subnets" : true,
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "vimgrnw_ref" : "aeiou",
  "vcenter_dvs" : true,
  "uuid" : "aeiou",
  "url" : "aeiou",
  "synced_from_se" : true
}

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 Network

401

log in failed

Up
put /network/{uuid}
( networkUuidPut)

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 — Network object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

Network

Example data

Content-Type: application/json
{
  "dhcp_enabled" : true,
  "vrf_context_ref" : "aeiou",
  "configured_subnets" : [ {
    "static_ranges" : [ {
      "end" : "",
      "begin" : ""
    } ],
    "prefix" : {
      "ip_addr" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "mask" : 123
    },
    "static_ips" : [ "" ]
  } ],
  "exclude_discovered_subnets" : true,
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "vimgrnw_ref" : "aeiou",
  "vcenter_dvs" : true,
  "uuid" : "aeiou",
  "url" : "aeiou",
  "synced_from_se" : true
}

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 Network

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. IpAddr
  2. IpAddrPrefix
  3. IpAddrRange
  4. Network
  5. NetworkApiResponse
  6. Subnet

IpAddr Up

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

IpAddrPrefix Up

ip_addr
IpAddr Placeholder for description of property ip_addr of obj type IpAddrPrefix field type str type object
mask
Integer Number of mask. format: int32

IpAddrRange Up

begin
IpAddr Starting IP address of the range.
end
IpAddr Ending IP address of the range.

Network Up

cloud_ref (optional)
String It is a reference to an object of type Cloud.
configured_subnets (optional)
array[Subnet] Placeholder for description of property configured_subnets of obj type Network field type str type object
dhcp_enabled (optional)
Boolean Select the IP address management scheme for this Network.
exclude_discovered_subnets (optional)
Boolean When selected, excludes all discovered subnets in this network from consideration for virtual service placement.
name
String Name of the object.
synced_from_se (optional)
Boolean Placeholder for description of property synced_from_se of obj type Network field type str type boolean
tenant_ref (optional)
String It is a reference to an object of type Tenant.
url (optional)
String url
uuid (optional)
String Unique object identifier of the object.
vcenter_dvs (optional)
Boolean Placeholder for description of property vcenter_dvs of obj type Network field type str type boolean
vimgrnw_ref (optional)
String It is a reference to an object of type VIMgrNWRuntime.
vrf_context_ref (optional)
String It is a reference to an object of type VrfContext.

NetworkApiResponse Up

count
Integer format: int32
results

Subnet Up

prefix
IpAddrPrefix Specify an IP subnet prefix for this Network.
static_ips (optional)
array[IpAddr] Specify a pool of IP addresses for use in Service Engines.
static_ranges (optional)
array[IpAddrRange] Placeholder for description of property static_ranges of obj type Subnet field type str type object