NSX-T Data Center REST API

GatewayInstanceStatus (type)

{
  "additionalProperties": false, 
  "description": "Stores information about gateway instance status", 
  "extends": {
    "$ref": "Resource
  }, 
  "id": "GatewayInstanceStatus", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "configuration_operation_status": {
      "$ref": "GatewayConfigOperationStatus, 
      "description": "This property provides a consolidated status of supported gateway configuration operations.", 
      "readonly": true, 
      "required": false, 
      "title": "Status of different gateway configuration operations"
    }, 
    "deployment_step": {
      "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"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Different states of gateway deployment", 
      "type": "string"
    }, 
    "error_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code for gateway operation failure", 
      "type": "integer"
    }, 
    "error_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message for gateway operation failure", 
      "type": "string"
    }, 
    "gateway_ha_index": {
      "required": false, 
      "title": "Index of HA that indicates whether gateway is primary or secondary.\nIf index is 0, then it is primary gateway. Else secondary gateway.\n", 
      "type": "integer"
    }, 
    "gateway_instance_id": {
      "required": false, 
      "title": "ID of the gateway instance", 
      "type": "string"
    }, 
    "gateway_lcp_connectivity_status": {
      "description": "Status of connectivity between NSX controller and public cloud gateway.", 
      "enum": [
        "UP", 
        "DOWN", 
        "DEGRADED", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Gateway to NSX Controller connectivity status", 
      "type": "string"
    }, 
    "gateway_mpa_connectivity_status": {
      "description": "Status of connectivity between NSX manager and public cloud gateway.", 
      "enum": [
        "UP", 
        "DOWN", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Gateway to NSX Manager connectivity status", 
      "type": "string"
    }, 
    "gateway_name": {
      "required": false, 
      "title": "Name of the gateway instance", 
      "type": "string"
    }, 
    "gateway_node_id": {
      "required": false, 
      "title": "NSX Node ID of the public cloud gateway", 
      "type": "string"
    }, 
    "gateway_status": {
      "enum": [
        "UP", 
        "DOWN", 
        "DEPLOYING", 
        "NOT_AVAILABLE", 
        "UNDEPLOYING", 
        "COPYING_IMAGE"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Gateway instance status", 
      "type": "string"
    }, 
    "gateway_tn_id": {
      "required": false, 
      "title": "NSX transport node id of the public cloud gateway", 
      "type": "string"
    }, 
    "is_gateway_active": {
      "readonly": true, 
      "required": false, 
      "title": "Flag to identify if this is an active gateway", 
      "type": "boolean"
    }, 
    "private_ip": {
      "readonly": true, 
      "required": false, 
      "title": "Private IP address of the virtual machine", 
      "type": "string"
    }, 
    "public_ip": {
      "readonly": true, 
      "required": false, 
      "title": "Public IP address of the virtual machine", 
      "type": "string"
    }, 
    "vpn_private_ip": {
      "description": "Private IP address of the virtual machine for VPN", 
      "readonly": true, 
      "required": false, 
      "title": "VPN Private IP address", 
      "type": "string"
    }
  }, 
  "title": "Gateway instance status", 
  "type": "object"
}