Avi Network Object API
CLI ``` - configure network - show network ```
Version: 22.1.5
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /networkpost /networkdelete /network/{uuid}get /network/{uuid}patch /network/{uuid}put /network/{uuid}
(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.
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
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"vrf_context_ref" : "aeiou",
"configured_subnets" : [ {
"prefix" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"static_ip_ranges" : [ {
"range" : {
"end" : "",
"begin" : ""
},
"type" : "aeiou"
} ]
} ],
"ip6_autocfg_enabled" : true,
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"attrs" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"synced_from_se" : true,
"dhcp_enabled" : true,
"exclude_discovered_subnets" : true,
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"vimgrnw_ref" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"vcenter_dvs" : true
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
NetworkApiResponse
401
log in failed
(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
Example data
Content-Type: application/json
{
"vrf_context_ref" : "aeiou",
"configured_subnets" : [ {
"prefix" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"static_ip_ranges" : [ {
"range" : {
"end" : "",
"begin" : ""
},
"type" : "aeiou"
} ]
} ],
"ip6_autocfg_enabled" : true,
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"attrs" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"synced_from_se" : true,
"dhcp_enabled" : true,
"exclude_discovered_subnets" : true,
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"vimgrnw_ref" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"vcenter_dvs" : true
}
Produces
This API call produces the following media types according to the 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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
object deleted
String
404
not found
(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.
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
Example data
Content-Type: application/json
{
"vrf_context_ref" : "aeiou",
"configured_subnets" : [ {
"prefix" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"static_ip_ranges" : [ {
"range" : {
"end" : "",
"begin" : ""
},
"type" : "aeiou"
} ]
} ],
"ip6_autocfg_enabled" : true,
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"attrs" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"synced_from_se" : true,
"dhcp_enabled" : true,
"exclude_discovered_subnets" : true,
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"vimgrnw_ref" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"vcenter_dvs" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
Network
401
log in failed
(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
Example data
Content-Type: application/json
{
"vrf_context_ref" : "aeiou",
"configured_subnets" : [ {
"prefix" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"static_ip_ranges" : [ {
"range" : {
"end" : "",
"begin" : ""
},
"type" : "aeiou"
} ]
} ],
"ip6_autocfg_enabled" : true,
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"attrs" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"synced_from_se" : true,
"dhcp_enabled" : true,
"exclude_discovered_subnets" : true,
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"vimgrnw_ref" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"vcenter_dvs" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
Network
401
log in failed
(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
Example data
Content-Type: application/json
{
"vrf_context_ref" : "aeiou",
"configured_subnets" : [ {
"prefix" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"static_ip_ranges" : [ {
"range" : {
"end" : "",
"begin" : ""
},
"type" : "aeiou"
} ]
} ],
"ip6_autocfg_enabled" : true,
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"attrs" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"synced_from_se" : true,
"dhcp_enabled" : true,
"exclude_discovered_subnets" : true,
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"vimgrnw_ref" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"vcenter_dvs" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
Network
401
log in failed
[ Jump to Methods ]
Table of Contents
ConfigPbAttributesIpAddrIpAddrPrefixIpAddrRangeKeyValueNetworkNetworkApiResponseRoleFilterMatchLabelStaticIpRangeSubnet
version (optional)
Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32
addr
String IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
type
String Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip_addr
IpAddr Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mask
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
begin
IpAddr Starting IP address of the range. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
end
IpAddr Ending IP address of the range. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
key
String Key. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
String Value. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
attrs (optional)
array[KeyValue] Key/value network attributes. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cloud_ref (optional)
String It is a reference to an object of type Cloud. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
configpb_attributes (optional)
ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
configured_subnets (optional)
array[Subnet] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dhcp_enabled (optional)
Boolean Select the IP address management scheme for this Network. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
exclude_discovered_subnets (optional)
Boolean When selected, excludes all discovered subnets in this network from consideration for virtual service placement. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip6_autocfg_enabled (optional)
Boolean Enable IPv6 auto configuration. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
markers (optional)
array[RoleFilterMatchLabel] List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
name
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
synced_from_se (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vcenter_dvs (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vimgrnw_ref (optional)
String It is a reference to an object of type VIMgrNWRuntime. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
vrf_context_ref (optional)
String It is a reference to an object of type VrfContext. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
count
results
next (optional)
key
String Key for filter match. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
values (optional)
array[String] Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
range
IpAddrRange IP range. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
type (optional)
String Object type (VIP only, Service Engine only, or both) which can use this IP range. Enum options - STATIC_IPS_FOR_SE, STATIC_IPS_FOR_VIP, STATIC_IPS_FOR_VIP_AND_SE. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
prefix
IpAddrPrefix Specify an IP subnet prefix for this Network. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
static_ip_ranges (optional)
array[StaticIpRange] Static IP ranges for this subnet. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.