NSX-T Data Center REST API
GatewayInstanceStatus (schema)
Gateway instance status
Stores information about gateway instance status
| Name | Description | Type | Notes |
|---|---|---|---|
| _links | References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink | Readonly |
| _schema | Schema for this resource | string | Readonly |
| _self | Link to this resource | SelfResourceLink | Readonly |
| configuration_operation_status | Status of different gateway configuration operations This property provides a consolidated status of supported gateway configuration operations. |
GatewayConfigOperationStatus | Readonly |
| deployment_step | Different states of gateway deployment | string | Readonly Enum: VALIDATING_ENVIRONMENT, COPYING_IMAGE, CREATING_SECURITY_GROUPS, LAUNCHING_GATEWAY, CREATING_NETWORK_INTERFACES, ATTACHING_NETWORK_INTERFACES, ATTACHING_SECURITY_GROUPS, CONFIGURING_GATEWAY, CREATING_LOGICAL_NETWORK_CONSTRUCTS, DEPLOYMENT_SUCCESSFUL, DEPLOYMENT_FAILED, UNCONFIGURING_GATEWAY, RELEASING_EIPS, TERMINATING_GATEWAY, DELETING_SECURITY_GROUPS, DELETING_CLOUD_RESOURCES, UNDEPLOYMENT_SUCCESSFUL, UNDEPLOYMENT_FAILED, NOT_APPLICABLE, CLEANUP_INPROGRESS, CLEANUP_FAILED |
| error_code | Error code for gateway operation failure | integer | Readonly |
| error_message | Error message for gateway operation failure | string | Readonly |
| gateway_ha_index | Index of HA that indicates whether gateway is primary or secondary. If index is 0, then it is primary gateway. Else secondary gateway. | integer | |
| gateway_instance_id | ID of the gateway instance | string | |
| gateway_lcp_connectivity_status | Gateway to NSX Controller connectivity status Status of connectivity between NSX controller and public cloud gateway. |
string | Readonly Enum: UP, DOWN, DEGRADED, UNKNOWN |
| gateway_mpa_connectivity_status | Gateway to NSX Manager connectivity status Status of connectivity between NSX manager and public cloud gateway. |
string | Readonly Enum: UP, DOWN, UNKNOWN |
| gateway_name | Name of the gateway instance | string | |
| gateway_node_id | NSX Node ID of the public cloud gateway | string | |
| gateway_status | Gateway instance status | string | Readonly Enum: UP, DOWN, DEPLOYING, NOT_AVAILABLE, UNDEPLOYING, COPYING_IMAGE |
| gateway_tn_id | NSX transport node id of the public cloud gateway | string | |
| is_gateway_active | Flag to identify if this is an active gateway | boolean | Readonly |
| private_ip | Private IP address of the virtual machine | string | Readonly |
| public_ip | Public IP address of the virtual machine | string | Readonly |
| vpn_private_ip | VPN Private IP address Private IP address of the virtual machine for VPN |
string | Readonly |