NSX-T Data Center REST API

AwsGatewayConfig (schema)

AWS gateway configuration

Stores AWS gateway configuration like ami_id, key_pair_name and
gateway_ha_configuration.

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
ami_id AMI id

The ID of the Amazon Machine Image on which this gateway resides
string
ami_id_obsolete Flag to identify if the AMI ID is related to the previous NSX release

If this flag is set, NSX was upgraded after the gateway was deployed and this AMI ID should no longer be used
boolean Readonly
Default: "False"
cloud_fallback_security_group_id Id of cloud security group

Id of security group where the VMs should be moved after last gateway
undeployed.
string
default_quarantine_policy_enabled Flag to identify if default quarantine policy is enabled boolean Default: "False"
dns_settings DNS settings

Settings related to Cloud gateway DNS configuration. This determines
DNS configuration based on dns_mode.
DnsSettings Deprecated
gateway_connectivity_mode Gateway Connectivity Mode

Helps the user choose default connectivity mode that will be used
between Cloud Service Manager and Gateway.
PUBLIC IP: All the connections will go through the internet. When this mode
is selected by the user, the user will have to select a public Ip address from
the list of public IP's from the 'Public IP on Mgmt NIC' field.
PRIVATE IP: All the connections will go through the VGW or any other configured
VPN.
When there is no input provided by the user, an attempt will be made using
PRIVATE_IP (VGW) first and if that doesn't go through, an attempt will be made
using PUBLIC_IP (IGW). And if both fail, it will cause an exception.
string Enum: PUBLIC_IP, PRIVATE_IP
gateway_ha_configuration Aws Gateway HA configuration array of AwsGatewayHaConfig
is_ha_enabled Flag to identify if HA is enabled boolean
key_pair_name The key pair name required to authenticate into any instance string
managed_without_agents Managed Without NSX Agents

This flag determines if this virtual private cloud is managed with or
without NSX agents. This flag is applicable only for this network.
If this virtual private cloud is being managed without NSX agents,
quarantine state and threat state will be NOT_APPLICABLE for all the
virtual machines under it.
boolean Default: "False"
nsx_manager_connection NSX Manager connection

Determines if connection to NSX Manager is via public IP or private IP
string Enum: PUBLIC_IP, PRIVATE_IP
proxy_server_profile Id of the proxy server profile

Id of the proxy server profile, corresponding proxy settings
will be applied while deploying the gateway.
string
target_disk_size Target Disk Size

This is the target disk size of the PCG appliance in GB. Based on this
an additional disk is attached to the PCG appliance, if required.
The supported size is 191 GB and this property should only be modified
post upgrade for exisiting PCG appliances.
integer
vpn_service_enabled Flag to enable or disable inter-operation with services via VPN

Flag that will enable or disable inter-operation between NSX and
non-NSX services via VPN.
boolean Default: "True"