Get Segment
Read infra segment
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/segments/{segment-id}
Parameters
Parameters
string
segment-id
Required
Segment ID
Response
Response
Response BodyResponse Body
200 OK returns
Segment
{
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_protection": "string",
"_revision": 0,
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_system_owned": false,
"advanced_config": {
"address_pool_paths": [
"string"
],
"connectivity": "string",
"hybrid": false,
"local_egress": false
},
"children": [
{
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_protection": "string",
"_revision": 0,
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_system_owned": false,
"description": "string",
"display_name": "string",
"id": "string",
"marked_for_delete": false,
"resource_type": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
]
}
],
"connectivity_path": "string",
"description": "string",
"display_name": "string",
"domain_name": "string",
"id": "string",
"l2_extension": {
"l2vpn_path": "string",
"l2vpn_paths": [
"string"
],
"tunnel_id": 0
},
"ls_id": "string",
"marked_for_delete": false,
"overlay_id": 0,
"parent_path": "string",
"path": "string",
"relative_path": "string",
"resource_type": "string",
"subnets": [
{
"dhcp_ranges": [
"string"
],
"gateway_address": "string",
"network": "string"
}
],
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"transport_zone_path": "string",
"type": "string",
"vlan_ids": [
"string"
]
}
integer
_create_time
Optional
Timestamp of resource creation
string
_create_user
Optional
ID of the user who created this resource
integer
_last_modified_time
Optional
Timestamp of last modification
string
_last_modified_user
Optional
ID of the user who last modified this resource
array of
ResourceLink
_links
Optional
The server will populate this field when returing the resource. Ignored on PUT and POST.
string
_protection
Optional
Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.
integer
_revision
Optional
The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.
string
_schema
Optional
Schema for this resource
boolean
_system_owned
Optional
Indicates system owned resource
array of
ChildPolicyConfigResource
children
Optional
subtree for this type within policy tree containing nested elements.
string
connectivity_path
Optional
Policy path to the connecting Tier-0 or Tier-1. Valid only for segments created under Infra.
string
description
Optional
Description of this resource
string
display_name
Optional
Defaults to ID if not set
string
domain_name
Optional
DNS domain name
string
id
Optional
Unique identifier of this resource
string
ls_id
Optional
This property is deprecated. The property will continue to work as expected for existing segments. The segments that are newly created with ls_id will be ignored. Sepcify pre-creted logical switch id for Segment.
boolean
marked_for_delete
Optional
Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.
integer
overlay_id
Optional
Used for overlay connectivity of segments. The overlay_id should be allocated from the pool as definied by enforcement-point. If not provided, it is auto-allocated from the default pool on the enforcement-point.
string
parent_path
Optional
Path of its parent
string
path
Optional
Absolute path of this object
string
relative_path
Optional
Path relative from its parent
string
resource_type
Optional
The type of this resource.
string
transport_zone_path
Optional
Policy path to the transport zone. Supported for VLAN backed segments as well as Overlay Segments. This field is required for VLAN backed Segments. Auto assigned if only one transport zone exists in the enforcement point. Default transport zone is auto assigned for overlay segments if none specified.
string
type
Optional
Segment type based on configuration.
Possible values are: ROUTED, EXTENDED, ROUTED_AND_EXTENDED, DISCONNECTED
array of
string
vlan_ids
Optional
VLAN ids for a VLAN backed Segment. Can be a VLAN id or a range of VLAN ids specified with ‘-’ in between.
cURL Command
curl https://nsxmanager.your.domain/policy/api/v1/infra/segments/{segment-id}
Errors
Not available
404
The requested resource could not be found but may be available again in the future.
500
The server encountered an unexpected condition which prevented it from fulfilling the request.
503
The server is currently unavailable (because it is overloaded or down for maintenance).
On This Page
Segments Operations
put
delete
delete
delete
delete
delete
delete
get
get
patch
patch
patch
patch
