[{"label":"Latest (v1.0)","version":"latest"}]

nsx-vmc-policy

List Segments

Description

Paginated list of all segments under Tier-1 instance

Request

URL

get

https://nsxmanager.your.domain/policy/api/v1/infra/tier-1s/{tier-1-id}/segments

Copy

Path Parameters

string

tier-1-id Required

Query Parameters

string

cursor Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

boolean

include_mark_for_delete_objects Optional

Include objects that are marked for deletion in results

string

included_fields Optional

Comma separated list of fields that should be included in query result

integer

page_size Optional

Maximum number of results to return in this page (server may return fewer)

boolean

sort_ascending Optional

string

sort_by Optional

Field by which records are sorted

Authentication

This operation uses the following authentication methods.

BasicAuth

Response

Response Body

200 OK

Returns SegmentListResult of type(s) application/json

This response body class contains all of the following: ListResult, InlineSegmentListResult1

Errors

ApiError

400

Bad Request

ApiError

403

Forbidden

ApiError

404

Not Found

ApiError

412

Precondition Failed

ApiError

500

Internal Server Error

ApiError

503

Service Unavailable

Code Samples

PowerCLI Client SDK Example

Invoke-ListSegments -tier1Id "Mytier1Id" -cursor "Mycursor" -includeMarkForDeleteObjects $true -includedFields "MyincludedFields" -pageSize 789 -segmentType "DVPortgroup" -sortAscending $true -sortBy "MysortBy"

cURL Command

curl https://nsxmanager.your.domain/policy/api/v1/infra/tier-1s/{tier-1-id}/segments

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-vmw-doc-operation: list-segments
x-vmw-nsx-module: PolicyConnectivity

[{"label":"Latest (v1.0)","version":"latest"}]

nsx-vmc-policy

Tier 1s Operations

put

Create Port Discovery Binding

put

Create Port Monitoring Binding

put

Create Port QoS Profile Binding

put

Create Port Security Profile Binding

put

Create Segment

put

Create Segment Discovery Binding

put

Create Segment Discovery Binding

put

Create Segment Port

put

Create Segment QoS Binding

put

Create Segment Security Profile Bindings

put

Create Static ARP Config

delete

Delete Port Discovery Binding

delete

Delete Port Monitoring Binding

delete

Delete Port QoS Profile Binding

delete

Delete Port Security Profile Binding

delete

Delete Segment

delete

Delete Segment Discovery Binding

delete

Delete Segment Discovery Binding

delete

Delete Segment Port

delete

Delete Segment QoS Binding

delete

Delete Segment Security Profile Binding

delete

Delete Static ARP Config

delete

Force Delete Segment

get

Get Port Discovery Binding

get

Get Port Monitoring Binding

get

Get Port QoS Profile Binding

get

Get Port Security Profile Binding

get

Get Segment

get

Get Segment Discovery Binding

get

Get Segment Discovery Binding

get

Get Segment Port

get

Get Segment Port Stats

get

Get Segment Port Stats

get

Get Segment QoS Binding

get

Get Segment Security Profile Binding

get

Get Static ARP Config

get

List Port Discovery Bindings

get

List Port Monitoring Bindings

get

List Port QoS Profile Bindings

get

List Port Security Profile Bindings

get

List Segment Discovery Bindings

get

List Segment Monitoring Binding

get

List Segment Ports

get

List Segment QoS Bindings

get

List Segment Security Profile Bindings

get

List Segments

patch

Update Port Discovery Binding

patch

Update Port Monitoring Binding

patch

Update Port QoS Profile Binding

patch

Update Port Security Profile Binding

patch

Update Segment

patch

Update Segment Discovery Binding

patch

Update Segment Discovery Binding

patch

Update Segment Port

patch

Update Segment QoS Binding

patch

Update Segment Security Profile Binding

patch

Update Static ARP Config

List Segments

Request

URL

Path Parameters

Query Parameters

Authentication

BasicAuth

Response

Response Body

200 OK

Errors

Code Samples

PowerCLI Client SDK Example

cURL Command

Vendor Extensions

On This Page

Tier 1s Operations

Was this page helpful?