List NSX Tier0 Gateway
Returns information of NSX-T Tier0 Gateways associated with a Distributed Switch.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/nsx-tier0-gateways
Path Parameters
Path Parameters
string
distributed_switch
Required
Identifier of a Distributed Switch. Only CVDS type of distributed switches is supported. Only Tier0 Gateways that are associated with the particular Distributed Switch will be listed. The parameter must be an identifier for the resource type: vSphereDistributedSwitch.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
NamespaceManagementNSXTier0GatewaySummary
of type application/json
List of summaries of Tier0 Gateways associated with the given Distributed Switch.
[
{
"display_name": "string",
"tier0_gateway": "string"
}
]
string
display_name
Required
Display name of the Tier0 Gateway.
string
tier0_gateway
Required
Identifier of the Tier0 Gateway. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: NSXTier0Gateway. When operations return a value of this structure as a result, the field will be an identifier for the resource type: NSXTier0Gateway.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read privilege.
404
com.vmware.vapi.std.errors.not_found : if no existing Tier0 Gateways associated with the given Distributed Switch can be found.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.internal_server_error : if the server reports an unknown internal error.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-ListNamespaceManagementNsxTier0Gateways -DistributedSwitch "MyDistributedSwitch"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/nsx-tier0-gateways
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list
Availability
Added in 7.0.2.0
