Avi NsxtSegmentRuntime Object API
CLI ``` - show nsxt segment ```
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 /nsxtsegmentruntimepost /nsxtsegmentruntimedelete /nsxtsegmentruntime/{uuid}get /nsxtsegmentruntime/{uuid}patch /nsxtsegmentruntime/{uuid}put /nsxtsegmentruntime/{uuid}
Up
get /nsxtsegmentruntime
(nsxtsegmentruntimeGet)
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" : [ {
"subnet" : "aeiou",
"segment_gw6" : "aeiou",
"segname" : "aeiou",
"tier1_id" : "aeiou",
"vrf_context_ref" : "aeiou",
"segment_gw" : "aeiou",
"origin_id" : "aeiou",
"dhcp_ranges" : [ "aeiou" ],
"nw_name" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"dhcp_enabled" : true,
"vlan_ids" : [ "aeiou" ],
"nw_ref" : "aeiou",
"subnet6" : "aeiou",
"dhcp6_ranges" : [ "aeiou" ],
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"security_only_nsxt" : true,
"opaque_network_id" : "aeiou",
"segment_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
NsxtSegmentRuntimeApiResponse
401
log in failed
Up
post /nsxtsegmentruntime
(nsxtsegmentruntimePost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — NsxtSegmentRuntime object creation
Return type
Example data
Content-Type: application/json
{
"subnet" : "aeiou",
"segment_gw6" : "aeiou",
"segname" : "aeiou",
"tier1_id" : "aeiou",
"vrf_context_ref" : "aeiou",
"segment_gw" : "aeiou",
"origin_id" : "aeiou",
"dhcp_ranges" : [ "aeiou" ],
"nw_name" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"dhcp_enabled" : true,
"vlan_ids" : [ "aeiou" ],
"nw_ref" : "aeiou",
"subnet6" : "aeiou",
"dhcp6_ranges" : [ "aeiou" ],
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"security_only_nsxt" : true,
"opaque_network_id" : "aeiou",
"segment_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
NsxtSegmentRuntime
401
log in failed
Up
delete /nsxtsegmentruntime/{uuid}
(nsxtsegmentruntimeUuidDelete)
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 /nsxtsegmentruntime/{uuid}
(nsxtsegmentruntimeUuidGet)
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" : "aeiou",
"segment_gw6" : "aeiou",
"segname" : "aeiou",
"tier1_id" : "aeiou",
"vrf_context_ref" : "aeiou",
"segment_gw" : "aeiou",
"origin_id" : "aeiou",
"dhcp_ranges" : [ "aeiou" ],
"nw_name" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"dhcp_enabled" : true,
"vlan_ids" : [ "aeiou" ],
"nw_ref" : "aeiou",
"subnet6" : "aeiou",
"dhcp6_ranges" : [ "aeiou" ],
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"security_only_nsxt" : true,
"opaque_network_id" : "aeiou",
"segment_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
NsxtSegmentRuntime
401
log in failed
Up
patch /nsxtsegmentruntime/{uuid}
(nsxtsegmentruntimeUuidPatch)
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 — NsxtSegmentRuntime object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"subnet" : "aeiou",
"segment_gw6" : "aeiou",
"segname" : "aeiou",
"tier1_id" : "aeiou",
"vrf_context_ref" : "aeiou",
"segment_gw" : "aeiou",
"origin_id" : "aeiou",
"dhcp_ranges" : [ "aeiou" ],
"nw_name" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"dhcp_enabled" : true,
"vlan_ids" : [ "aeiou" ],
"nw_ref" : "aeiou",
"subnet6" : "aeiou",
"dhcp6_ranges" : [ "aeiou" ],
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"security_only_nsxt" : true,
"opaque_network_id" : "aeiou",
"segment_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
NsxtSegmentRuntime
401
log in failed
Up
put /nsxtsegmentruntime/{uuid}
(nsxtsegmentruntimeUuidPut)
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 — NsxtSegmentRuntime object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"subnet" : "aeiou",
"segment_gw6" : "aeiou",
"segname" : "aeiou",
"tier1_id" : "aeiou",
"vrf_context_ref" : "aeiou",
"segment_gw" : "aeiou",
"origin_id" : "aeiou",
"dhcp_ranges" : [ "aeiou" ],
"nw_name" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"dhcp_enabled" : true,
"vlan_ids" : [ "aeiou" ],
"nw_ref" : "aeiou",
"subnet6" : "aeiou",
"dhcp6_ranges" : [ "aeiou" ],
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"security_only_nsxt" : true,
"opaque_network_id" : "aeiou",
"segment_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
NsxtSegmentRuntime
401
log in failed
[ Jump to Methods ]
Table of Contents
NsxtSegmentRuntimeNsxtSegmentRuntimeApiResponse
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
cloud_ref (optional)
String Nsxt segment belongs to cloud. It is a reference to an object of type Cloud. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dhcp6_ranges (optional)
array[String] V6 DHCP ranges configured in Nsxt. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dhcp_enabled (optional)
Boolean IP address management scheme for this Segment associated network. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dhcp_ranges (optional)
array[String] DHCP ranges configured in Nsxt. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name (optional)
String Segment object name. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
nw_name (optional)
String Network Name. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
nw_ref (optional)
String Corresponding network object in Avi. It is a reference to an object of type Network. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
opaque_network_id (optional)
String Opaque network Id. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
origin_id
String Origin ID applicable to security only cloud. Field introduced in 22.1.2. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
security_only_nsxt (optional)
Boolean Nsxt segment belongs to Security only cloud. Field introduced in 22.1.2. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
segment_gw (optional)
String Segment Gateway. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
segment_gw6 (optional)
String V6 segment Gateway. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
segment_id (optional)
String Segment Id. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
segname (optional)
String Segment name. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
subnet (optional)
String Segment Cidr. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
subnet6 (optional)
String V6 Segment Cidr. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_ref (optional)
String Nsxt segment belongs to tenant. It is a reference to an object of type Tenant. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tier1_id (optional)
String Tier1 router Id. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
uuid (optional)
String Uuid. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vlan_ids (optional)
array[String] Segment Vlan ids. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
vrf_context_ref (optional)
String Corresponding vrf context object in Avi. It is a reference to an object of type VrfContext. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
count
results
next (optional)