Transit Gateway APIs
A Transit Gateway in vCenter serves as the representation of a Transit Gateway in NSX.
The lifecycle and configuration of the Transit Gateway in vCenter are managed by NSX. In NSX, a Transit Gateway (TGW) acts as a central transit hub that interconnects a tenant's virtual private clouds (VPCs), external connections, and remote networks. The TGW enables inter-VPC connectivity between external or project-scoped subnets of connected VPCs, facilitating seamless communication across different network segments within the tenant's environment.
Since: vSphere API Release 9.1.0.0
Operations
POST
Transit Gateway Destroy Task
Destroys this object, deleting its contents and removing it from its parent
folder (if any).
POST
Transit Gateway Reload
Reload the entity state.
POST
Transit Gateway Rename Task
Renames this managed entity.
POST
Transit Gateway Set Custom Value
Assigns a value to a custom field.
GET
Transit Gateway Get Alarm Actions Enabled
Whether alarm actions are enabled for this entity.
GET
Transit Gateway Get Available Field
List of custom field definitions that are valid for the object's type.
GET
Transit Gateway Get Config
The configuration of the transit gateway
GET
Transit Gateway Get Config Issue
Current configuration issues that have been detected for this entity.
GET
Transit Gateway Get Config Status
The configStatus indicates whether or not the system has detected a configuration
issue involving this entity.
GET
Transit Gateway Get Custom Value
Custom field values.
GET
Transit Gateway Get Declared Alarm State
A set of alarm states for alarms that apply to this managed entity.
GET
Transit Gateway Get Disabled Method
List of operations that are disabled, given the current runtime
state of the entity.
GET
Transit Gateway Get Effective Role
Access rights the current session has to this entity.
GET
Transit Gateway Get Name
Name of this entity, unique relative to its parent.
GET
Transit Gateway Get Overall Status
General health of this managed entity.
GET
Transit Gateway Get Parent
Parent of this entity.
GET
Transit Gateway Get Permission
List of the permissions explicitly defined for this entity.
GET
Transit Gateway Get Recent Task
The set of recent tasks operating on this managed entity.
GET
Transit Gateway Get Tag
The set of tags associated with this managed entity.
GET
Transit Gateway Get Triggered Alarm State
A set of alarm states for alarms triggered by this entity
or by its descendants.
GET
Transit Gateway Get Value
List of custom field values.