Avi NetworkInventory Object API
CLI ``` - show networkinventory ```
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 /networkinventorypost /networkinventorydelete /networkinventory/{uuid}get /networkinventory/{uuid}patch /networkinventory/{uuid}put /networkinventory/{uuid}get /networkruntimepost /networkruntimedelete /networkruntime/{uuid}get /networkruntime/{uuid}patch /networkruntime/{uuid}put /networkruntime/{uuid}get /vimgrnwruntimepost /vimgrnwruntimedelete /vimgrnwruntime/{uuid}get /vimgrnwruntime/{uuid}patch /vimgrnwruntime/{uuid}put /vimgrnwruntime/{uuid}
(networkinventoryGet)
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.
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"discovery" : {
"dvs" : true,
"availability_zone" : "aeiou",
"tenant_name" : "aeiou",
"interested_nw" : true,
"vrf_context_ref" : "aeiou",
"vm_refs" : [ "aeiou" ],
"vlan_range" : [ {
"start" : 123,
"end" : 123
} ],
"host_refs" : [ "aeiou" ],
"MgmtNW" : true,
"num_ports" : 123,
"datacenter_uuid" : "aeiou",
"type" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"ip_subnet" : [ {
"fip_subnet_uuids" : [ "aeiou" ],
"ip_subnet" : "aeiou",
"fip_available" : true,
"prefix" : "",
"name" : "aeiou",
"floatingip_subnets" : [ {
"prefix" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"name" : "aeiou",
"uuid" : "aeiou"
} ],
"ref_count" : 123,
"uuid" : "aeiou",
"se_ref_count" : 123,
"primary" : true
} ],
"vlan" : 123,
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"auto_expand" : true,
"logical_switch_id" : "aeiou",
"switch_name" : "aeiou",
"managed_object_id" : "aeiou"
},
"runtime" : {
"subnet_runtime" : [ {
"prefix" : "",
"ip_range_runtimes" : [ {
"free_ip_count" : 123,
"allocated_ips" : [ {
"obj_info" : "aeiou",
"ip" : "",
"obj_uuid" : "aeiou"
} ],
"type" : "aeiou",
"total_ip_count" : 123
} ]
} ],
"obj_uuids" : [ "aeiou" ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou"
},
"config" : {
"dhcp_enabled" : true,
"vrf_context_ref" : "aeiou",
"exclude_discovered_subnets" : true,
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"vimgrnw_ref" : "aeiou",
"ip6_autocfg_enabled" : true,
"vcenter_dvs" : true,
"uuid" : "aeiou",
"url" : "aeiou",
"synced_from_se" : true
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
200
OK
NetworkInventoryApiResponse
401
log in failed
Up
post /networkinventory
(networkinventoryPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — NetworkInventory object creation
Return type
Example data
Content-Type: application/json
{
"discovery" : {
"dvs" : true,
"availability_zone" : "aeiou",
"tenant_name" : "aeiou",
"interested_nw" : true,
"vrf_context_ref" : "aeiou",
"vm_refs" : [ "aeiou" ],
"vlan_range" : [ {
"start" : 123,
"end" : 123
} ],
"host_refs" : [ "aeiou" ],
"MgmtNW" : true,
"num_ports" : 123,
"datacenter_uuid" : "aeiou",
"type" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"ip_subnet" : [ {
"fip_subnet_uuids" : [ "aeiou" ],
"ip_subnet" : "aeiou",
"fip_available" : true,
"prefix" : "",
"name" : "aeiou",
"floatingip_subnets" : [ {
"prefix" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"name" : "aeiou",
"uuid" : "aeiou"
} ],
"ref_count" : 123,
"uuid" : "aeiou",
"se_ref_count" : 123,
"primary" : true
} ],
"vlan" : 123,
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"auto_expand" : true,
"logical_switch_id" : "aeiou",
"switch_name" : "aeiou",
"managed_object_id" : "aeiou"
},
"runtime" : {
"subnet_runtime" : [ {
"prefix" : "",
"ip_range_runtimes" : [ {
"free_ip_count" : 123,
"allocated_ips" : [ {
"obj_info" : "aeiou",
"ip" : "",
"obj_uuid" : "aeiou"
} ],
"type" : "aeiou",
"total_ip_count" : 123
} ]
} ],
"obj_uuids" : [ "aeiou" ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou"
},
"config" : {
"dhcp_enabled" : true,
"vrf_context_ref" : "aeiou",
"exclude_discovered_subnets" : true,
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"vimgrnw_ref" : "aeiou",
"ip6_autocfg_enabled" : true,
"vcenter_dvs" : true,
"uuid" : "aeiou",
"url" : "aeiou",
"synced_from_se" : true
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
200
OK
NetworkInventory
401
log in failed
Up
delete /networkinventory/{uuid}
(networkinventoryUuidDelete)
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
Up
get /networkinventory/{uuid}
(networkinventoryUuidGet)
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
{
"discovery" : {
"dvs" : true,
"availability_zone" : "aeiou",
"tenant_name" : "aeiou",
"interested_nw" : true,
"vrf_context_ref" : "aeiou",
"vm_refs" : [ "aeiou" ],
"vlan_range" : [ {
"start" : 123,
"end" : 123
} ],
"host_refs" : [ "aeiou" ],
"MgmtNW" : true,
"num_ports" : 123,
"datacenter_uuid" : "aeiou",
"type" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"ip_subnet" : [ {
"fip_subnet_uuids" : [ "aeiou" ],
"ip_subnet" : "aeiou",
"fip_available" : true,
"prefix" : "",
"name" : "aeiou",
"floatingip_subnets" : [ {
"prefix" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"name" : "aeiou",
"uuid" : "aeiou"
} ],
"ref_count" : 123,
"uuid" : "aeiou",
"se_ref_count" : 123,
"primary" : true
} ],
"vlan" : 123,
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"auto_expand" : true,
"logical_switch_id" : "aeiou",
"switch_name" : "aeiou",
"managed_object_id" : "aeiou"
},
"runtime" : {
"subnet_runtime" : [ {
"prefix" : "",
"ip_range_runtimes" : [ {
"free_ip_count" : 123,
"allocated_ips" : [ {
"obj_info" : "aeiou",
"ip" : "",
"obj_uuid" : "aeiou"
} ],
"type" : "aeiou",
"total_ip_count" : 123
} ]
} ],
"obj_uuids" : [ "aeiou" ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou"
},
"config" : {
"dhcp_enabled" : true,
"vrf_context_ref" : "aeiou",
"exclude_discovered_subnets" : true,
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"vimgrnw_ref" : "aeiou",
"ip6_autocfg_enabled" : true,
"vcenter_dvs" : true,
"uuid" : "aeiou",
"url" : "aeiou",
"synced_from_se" : true
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
200
OK
NetworkInventory
401
log in failed
Up
patch /networkinventory/{uuid}
(networkinventoryUuidPatch)
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 — NetworkInventory object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"discovery" : {
"dvs" : true,
"availability_zone" : "aeiou",
"tenant_name" : "aeiou",
"interested_nw" : true,
"vrf_context_ref" : "aeiou",
"vm_refs" : [ "aeiou" ],
"vlan_range" : [ {
"start" : 123,
"end" : 123
} ],
"host_refs" : [ "aeiou" ],
"MgmtNW" : true,
"num_ports" : 123,
"datacenter_uuid" : "aeiou",
"type" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"ip_subnet" : [ {
"fip_subnet_uuids" : [ "aeiou" ],
"ip_subnet" : "aeiou",
"fip_available" : true,
"prefix" : "",
"name" : "aeiou",
"floatingip_subnets" : [ {
"prefix" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"name" : "aeiou",
"uuid" : "aeiou"
} ],
"ref_count" : 123,
"uuid" : "aeiou",
"se_ref_count" : 123,
"primary" : true
} ],
"vlan" : 123,
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"auto_expand" : true,
"logical_switch_id" : "aeiou",
"switch_name" : "aeiou",
"managed_object_id" : "aeiou"
},
"runtime" : {
"subnet_runtime" : [ {
"prefix" : "",
"ip_range_runtimes" : [ {
"free_ip_count" : 123,
"allocated_ips" : [ {
"obj_info" : "aeiou",
"ip" : "",
"obj_uuid" : "aeiou"
} ],
"type" : "aeiou",
"total_ip_count" : 123
} ]
} ],
"obj_uuids" : [ "aeiou" ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou"
},
"config" : {
"dhcp_enabled" : true,
"vrf_context_ref" : "aeiou",
"exclude_discovered_subnets" : true,
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"vimgrnw_ref" : "aeiou",
"ip6_autocfg_enabled" : true,
"vcenter_dvs" : true,
"uuid" : "aeiou",
"url" : "aeiou",
"synced_from_se" : true
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
200
OK
NetworkInventory
401
log in failed
Up
put /networkinventory/{uuid}
(networkinventoryUuidPut)
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 — NetworkInventory object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"discovery" : {
"dvs" : true,
"availability_zone" : "aeiou",
"tenant_name" : "aeiou",
"interested_nw" : true,
"vrf_context_ref" : "aeiou",
"vm_refs" : [ "aeiou" ],
"vlan_range" : [ {
"start" : 123,
"end" : 123
} ],
"host_refs" : [ "aeiou" ],
"MgmtNW" : true,
"num_ports" : 123,
"datacenter_uuid" : "aeiou",
"type" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"ip_subnet" : [ {
"fip_subnet_uuids" : [ "aeiou" ],
"ip_subnet" : "aeiou",
"fip_available" : true,
"prefix" : "",
"name" : "aeiou",
"floatingip_subnets" : [ {
"prefix" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"name" : "aeiou",
"uuid" : "aeiou"
} ],
"ref_count" : 123,
"uuid" : "aeiou",
"se_ref_count" : 123,
"primary" : true
} ],
"vlan" : 123,
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"auto_expand" : true,
"logical_switch_id" : "aeiou",
"switch_name" : "aeiou",
"managed_object_id" : "aeiou"
},
"runtime" : {
"subnet_runtime" : [ {
"prefix" : "",
"ip_range_runtimes" : [ {
"free_ip_count" : 123,
"allocated_ips" : [ {
"obj_info" : "aeiou",
"ip" : "",
"obj_uuid" : "aeiou"
} ],
"type" : "aeiou",
"total_ip_count" : 123
} ]
} ],
"obj_uuids" : [ "aeiou" ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou"
},
"config" : {
"dhcp_enabled" : true,
"vrf_context_ref" : "aeiou",
"exclude_discovered_subnets" : true,
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"vimgrnw_ref" : "aeiou",
"ip6_autocfg_enabled" : true,
"vcenter_dvs" : true,
"uuid" : "aeiou",
"url" : "aeiou",
"synced_from_se" : true
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
200
OK
NetworkInventory
401
log in failed
(networkruntimeGet)
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.
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"subnet_runtime" : [ {
"prefix" : {
"ip_addr" : "",
"mask" : 123
},
"ip_range_runtimes" : [ {
"free_ip_count" : 123,
"allocated_ips" : [ {
"obj_info" : "aeiou",
"ip" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"obj_uuid" : "aeiou"
} ],
"type" : "aeiou",
"total_ip_count" : 123
} ]
} ],
"obj_uuids" : [ "aeiou" ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
200
OK
NetworkRuntimeApiResponse
401
log in failed
(networkruntimePost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — NetworkRuntime object creation
Return type
Example data
Content-Type: application/json
{
"subnet_runtime" : [ {
"prefix" : {
"ip_addr" : "",
"mask" : 123
},
"ip_range_runtimes" : [ {
"free_ip_count" : 123,
"allocated_ips" : [ {
"obj_info" : "aeiou",
"ip" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"obj_uuid" : "aeiou"
} ],
"type" : "aeiou",
"total_ip_count" : 123
} ]
} ],
"obj_uuids" : [ "aeiou" ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
200
OK
NetworkRuntime
401
log in failed
Up
delete /networkruntime/{uuid}
(networkruntimeUuidDelete)
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
Up
get /networkruntime/{uuid}
(networkruntimeUuidGet)
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
{
"subnet_runtime" : [ {
"prefix" : {
"ip_addr" : "",
"mask" : 123
},
"ip_range_runtimes" : [ {
"free_ip_count" : 123,
"allocated_ips" : [ {
"obj_info" : "aeiou",
"ip" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"obj_uuid" : "aeiou"
} ],
"type" : "aeiou",
"total_ip_count" : 123
} ]
} ],
"obj_uuids" : [ "aeiou" ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
200
OK
NetworkRuntime
401
log in failed
Up
patch /networkruntime/{uuid}
(networkruntimeUuidPatch)
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 — NetworkRuntime object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"subnet_runtime" : [ {
"prefix" : {
"ip_addr" : "",
"mask" : 123
},
"ip_range_runtimes" : [ {
"free_ip_count" : 123,
"allocated_ips" : [ {
"obj_info" : "aeiou",
"ip" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"obj_uuid" : "aeiou"
} ],
"type" : "aeiou",
"total_ip_count" : 123
} ]
} ],
"obj_uuids" : [ "aeiou" ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
200
OK
NetworkRuntime
401
log in failed
Up
put /networkruntime/{uuid}
(networkruntimeUuidPut)
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 — NetworkRuntime object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"subnet_runtime" : [ {
"prefix" : {
"ip_addr" : "",
"mask" : 123
},
"ip_range_runtimes" : [ {
"free_ip_count" : 123,
"allocated_ips" : [ {
"obj_info" : "aeiou",
"ip" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"obj_uuid" : "aeiou"
} ],
"type" : "aeiou",
"total_ip_count" : 123
} ]
} ],
"obj_uuids" : [ "aeiou" ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
200
OK
NetworkRuntime
401
log in failed
(vimgrnwruntimeGet)
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.
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"dvs" : true,
"availability_zone" : "aeiou",
"tenant_name" : "aeiou",
"interested_nw" : true,
"vrf_context_ref" : "aeiou",
"vm_refs" : [ "aeiou" ],
"vlan_range" : [ {
"start" : 123,
"end" : 123
} ],
"host_refs" : [ "aeiou" ],
"MgmtNW" : true,
"num_ports" : 123,
"datacenter_uuid" : "aeiou",
"type" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"ip_subnet" : [ {
"fip_subnet_uuids" : [ "aeiou" ],
"ip_subnet" : "aeiou",
"fip_available" : true,
"prefix" : "",
"name" : "aeiou",
"floatingip_subnets" : [ {
"prefix" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"name" : "aeiou",
"uuid" : "aeiou"
} ],
"ref_count" : 123,
"uuid" : "aeiou",
"se_ref_count" : 123,
"primary" : true
} ],
"vlan" : 123,
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"auto_expand" : true,
"logical_switch_id" : "aeiou",
"switch_name" : "aeiou",
"managed_object_id" : "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
200
OK
VIMgrNWRuntimeApiResponse
401
log in failed
(vimgrnwruntimePost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — VIMgrNWRuntime object creation
Return type
Example data
Content-Type: application/json
{
"dvs" : true,
"availability_zone" : "aeiou",
"tenant_name" : "aeiou",
"interested_nw" : true,
"vrf_context_ref" : "aeiou",
"vm_refs" : [ "aeiou" ],
"vlan_range" : [ {
"start" : 123,
"end" : 123
} ],
"host_refs" : [ "aeiou" ],
"MgmtNW" : true,
"num_ports" : 123,
"datacenter_uuid" : "aeiou",
"type" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"ip_subnet" : [ {
"fip_subnet_uuids" : [ "aeiou" ],
"ip_subnet" : "aeiou",
"fip_available" : true,
"prefix" : "",
"name" : "aeiou",
"floatingip_subnets" : [ {
"prefix" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"name" : "aeiou",
"uuid" : "aeiou"
} ],
"ref_count" : 123,
"uuid" : "aeiou",
"se_ref_count" : 123,
"primary" : true
} ],
"vlan" : 123,
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"auto_expand" : true,
"logical_switch_id" : "aeiou",
"switch_name" : "aeiou",
"managed_object_id" : "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
200
OK
VIMgrNWRuntime
401
log in failed
Up
delete /vimgrnwruntime/{uuid}
(vimgrnwruntimeUuidDelete)
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
Up
get /vimgrnwruntime/{uuid}
(vimgrnwruntimeUuidGet)
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
{
"dvs" : true,
"availability_zone" : "aeiou",
"tenant_name" : "aeiou",
"interested_nw" : true,
"vrf_context_ref" : "aeiou",
"vm_refs" : [ "aeiou" ],
"vlan_range" : [ {
"start" : 123,
"end" : 123
} ],
"host_refs" : [ "aeiou" ],
"MgmtNW" : true,
"num_ports" : 123,
"datacenter_uuid" : "aeiou",
"type" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"ip_subnet" : [ {
"fip_subnet_uuids" : [ "aeiou" ],
"ip_subnet" : "aeiou",
"fip_available" : true,
"prefix" : "",
"name" : "aeiou",
"floatingip_subnets" : [ {
"prefix" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"name" : "aeiou",
"uuid" : "aeiou"
} ],
"ref_count" : 123,
"uuid" : "aeiou",
"se_ref_count" : 123,
"primary" : true
} ],
"vlan" : 123,
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"auto_expand" : true,
"logical_switch_id" : "aeiou",
"switch_name" : "aeiou",
"managed_object_id" : "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
200
OK
VIMgrNWRuntime
401
log in failed
Up
patch /vimgrnwruntime/{uuid}
(vimgrnwruntimeUuidPatch)
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 — VIMgrNWRuntime object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"dvs" : true,
"availability_zone" : "aeiou",
"tenant_name" : "aeiou",
"interested_nw" : true,
"vrf_context_ref" : "aeiou",
"vm_refs" : [ "aeiou" ],
"vlan_range" : [ {
"start" : 123,
"end" : 123
} ],
"host_refs" : [ "aeiou" ],
"MgmtNW" : true,
"num_ports" : 123,
"datacenter_uuid" : "aeiou",
"type" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"ip_subnet" : [ {
"fip_subnet_uuids" : [ "aeiou" ],
"ip_subnet" : "aeiou",
"fip_available" : true,
"prefix" : "",
"name" : "aeiou",
"floatingip_subnets" : [ {
"prefix" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"name" : "aeiou",
"uuid" : "aeiou"
} ],
"ref_count" : 123,
"uuid" : "aeiou",
"se_ref_count" : 123,
"primary" : true
} ],
"vlan" : 123,
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"auto_expand" : true,
"logical_switch_id" : "aeiou",
"switch_name" : "aeiou",
"managed_object_id" : "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
200
OK
VIMgrNWRuntime
401
log in failed
Up
put /vimgrnwruntime/{uuid}
(vimgrnwruntimeUuidPut)
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 — VIMgrNWRuntime object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"dvs" : true,
"availability_zone" : "aeiou",
"tenant_name" : "aeiou",
"interested_nw" : true,
"vrf_context_ref" : "aeiou",
"vm_refs" : [ "aeiou" ],
"vlan_range" : [ {
"start" : 123,
"end" : 123
} ],
"host_refs" : [ "aeiou" ],
"MgmtNW" : true,
"num_ports" : 123,
"datacenter_uuid" : "aeiou",
"type" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"ip_subnet" : [ {
"fip_subnet_uuids" : [ "aeiou" ],
"ip_subnet" : "aeiou",
"fip_available" : true,
"prefix" : "",
"name" : "aeiou",
"floatingip_subnets" : [ {
"prefix" : {
"ip_addr" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"mask" : 123
},
"name" : "aeiou",
"uuid" : "aeiou"
} ],
"ref_count" : 123,
"uuid" : "aeiou",
"se_ref_count" : 123,
"primary" : true
} ],
"vlan" : 123,
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"auto_expand" : true,
"logical_switch_id" : "aeiou",
"switch_name" : "aeiou",
"managed_object_id" : "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
200
OK
VIMgrNWRuntime
401
log in failed
[ Jump to Methods ]
Table of Contents
FloatingIpSubnetIpAddrIpAddrPrefixIpAllocInfoNetworkConfigNetworkConfigApiResponseNetworkInventoryNetworkInventoryApiResponseNetworkRuntimeNetworkRuntimeApiResponseStaticIpAllocInfoStaticIpRangeRuntimeSubnetRuntimeVIMgrIPSubnetRuntimeVIMgrNWRuntimeVIMgrNWRuntimeApiResponseVlanRange
name
String FloatingIp subnet name if available, else uuid. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
prefix (optional)
IpAddrPrefix FloatingIp subnet prefix. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
uuid (optional)
String FloatingIp subnet uuid. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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
ip
IpAddr Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mac
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_uuid
String 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. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
dhcp_enabled (optional)
Boolean Select the IP address management scheme for this Network. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, 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. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ip6_autocfg_enabled (optional)
Boolean Enable IPv6 auto configuration. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
name
String Name of the network. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
synced_from_se (optional)
Boolean Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
url (optional)
String URL of the Network. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
uuid (optional)
String UUID of the network. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
vcenter_dvs (optional)
Boolean Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
vimgrnw_ref (optional)
String It is a reference to an object of type VIMgrNWRuntime. Field introduced in 22.1.1. 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. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
count
results
next (optional)
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
config (optional)
NetworkConfig Configuration summary of the network. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
discovery (optional)
VIMgrNWRuntime Configuration summary of the service engine group. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
runtime (optional)
NetworkRuntime Runtime summary of the network. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
url (optional)
uuid (optional)
String UUID of the network. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
count
results
next (optional)
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
name
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
obj_uuids (optional)
array[String] Objects using static IPs in this network. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
subnet_runtime (optional)
array[SubnetRuntime] 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.
count
results
next (optional)
ip
IpAddr IP address. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
obj_info (optional)
String Object metadata. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
obj_uuid (optional)
String Object which this IP address is allocated to. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
allocated_ips (optional)
array[StaticIpAllocInfo] Allocated IPs. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
free_ip_count (optional)
Integer Free IP count. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
total_ip_count (optional)
Integer Total IP count. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
type (optional)
String Object type (VIP only, Service Engine only, or both) which is using this IP group. 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.
ip_range_runtimes (optional)
array[StaticIpRangeRuntime] Static IP range runtime. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
prefix
IpAddrPrefix Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
fip_available (optional)
Boolean If true, capable of floating/elastic IP association. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
fip_subnet_uuids (optional)
array[String] If fip_available is True, this is list of supported FIP subnets, possibly empty if Cloud does not support such a network list. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
floatingip_subnets (optional)
array[FloatingIpSubnet] If fip_available is True, the list of associated FloatingIP subnets, possibly empty if unsupported or implictly defined by the Cloud. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip_subnet (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
prefix
IpAddrPrefix Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
primary (optional)
Boolean True if prefix is primary IP on interface, else false. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ref_count (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
se_ref_count (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
uuid (optional)
String 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).
auto_expand (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
availability_zone (optional)
String 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.
datacenter_uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dvs (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
host_refs (optional)
array[String] It is a reference to an object of type VIMgrHostRuntime. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
interested_nw (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip_subnet (optional)
logical_switch_id (optional)
String UUID of NSX-T segment spanning multiple VDS with vCenter cloud. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
managed_object_id
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
MgmtNW (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
num_ports (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
switch_name (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_name (optional)
String 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.
type
String Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. 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.
vlan (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
vlan_range (optional)
array[VlanRange] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vm_refs (optional)
array[String] It is a reference to an object of type VIMgrVMRuntime. Allowed in Enterprise edition with any value, Essentials, Basic, 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)
end
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
start
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32