PATCH /nsxtsegmentruntime/{uuid}

PATCH /nsxtsegmentruntime/{uuid}

/nsxtsegmentruntime/{uuid}

Request
URI
PATCH
https://{api_host}/api/nsxtsegmentruntime/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.

Request Body

NsxtSegmentRuntime object creation

NsxtSegmentRuntime of type(s) application/json
Optional 
{
    "_last_modified": "string",
    "cloud_ref": "string",
    "dhcp6_ranges": [
        "string"
    ],
    "dhcp_enabled": false,
    "dhcp_ranges": [
        "string"
    ],
    "name": "string",
    "nw_name": "string",
    "nw_ref": "string",
    "opaque_network_id": "string",
    "origin_id": "string",
    "security_only_nsxt": false,
    "segment_gw": "string",
    "segment_gw6": "string",
    "segment_id": "string",
    "segname": "string",
    "subnet": "string",
    "subnet6": "string",
    "tenant_ref": "string",
    "tier1_id": "string",
    "url": "string",
    "uuid": "string",
    "vlan_ids": [
        "string"
    ],
    "vrf_context_ref": "string"
}
Responses
200

OK

Returns NsxtSegmentRuntime of type(s) application/json 
"NsxtSegmentRuntime Object"
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

string
cloud_ref
Optional

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.

array of string
dhcp6_ranges
Optional

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.

boolean
dhcp_enabled
Optional
Constraints: default: true

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.

array of string
dhcp_ranges
Optional

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.

string
name
Optional

Segment object name. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
nw_name
Optional

Network Name. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
nw_ref
Optional

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.

string
opaque_network_id
Optional

Opaque network Id. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
origin_id
Optional

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.

boolean
security_only_nsxt
Optional

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.

string
segment_gw
Optional

Segment Gateway. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
segment_gw6
Optional

V6 segment Gateway. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
segment_id
Optional

Segment Id. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
segname
Optional

Segment name. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
subnet
Optional

Segment Cidr. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
subnet6
Optional

V6 Segment Cidr. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

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.

string
tier1_id
Optional

Tier1 router Id. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

Uuid. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of string
vlan_ids
Optional

Segment Vlan ids. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
vrf_context_ref
Optional

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.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'
On This Page
Nsxt Segment Runtime Operations
GET
GET /nsxtsegmentruntime
POST
POST /nsxtsegmentruntime
GET
GET /nsxtsegmentruntime/{uuid}
PUT
PUT /nsxtsegmentruntime/{uuid}
PATCH
PATCH /nsxtsegmentruntime/{uuid}
DELETE
DELETE /nsxtsegmentruntime/{uuid}