Create mct gateway

Body

application/json

group_uuid

string

required

UUID of the gateway group where the gateway will be created.

CID

string

The opaque session ID token. Required for 7.2 controllers only.

account_name

string

Account name created from setup_account_profile (optional, will use group's account if not provided).

action

string

The API action to perform. Required for 7.2 controllers only.

auto_advertise_lan_cidrs

enum<string>

Enable/Disable edge gateway auto adverise lan cidrs.

Available options:

disable,

enable

autoscale

boolean

Enable autoscale for HA gateway.

availability_domain

string

Availability domain (OCI specific).

backup_link_config

string

Backup link configuration.

bgp_lan

boolean

Enable BGP over LAN.

bgp_lan_intf_count

integer

BGP LAN interface count.

bgp_lan_subnet

string

Subnet for BGP over LAN interface.

bgp_lan_vpc

string

VPC for the BGP over LAN interface.

bgp_local_as_num

string

Local BGP ASN.

cloud_init

boolean

Supports cloud-init instead of ISO data.

cloud_type

integer

Edge platform type.

customer_managed_keys

string

Customer managed key.

default_mgmt_interface

string

The host interface to be used as mgmt, by default it is eth2.

device_id

string

Device UUID of the edge device.

dhcp

boolean

Use DHCP for management interface.

disable_active_standby

boolean

Disables edge gateways active-standby mode.

disable_active_standby_preemptive

boolean

Disables edge gateways active-standby preemptive mode.

dns_server

string

Public DNS server.

dns_server_ip

string

User provided DNS server IP.

dns_server_ip_secondary

string

User provided secondary DNS server IP.

do_not_delete_iso

boolean

Keep ISO file on the controller.

dry_run

boolean

Perform a dry run without creating the gateway.

edge_gateway

boolean

Create edge gateway.

eip

string

Reuse existing EIP.

eip_map

string

Public IP mapping for the gateway wan interfaces.

enable_active_standby

boolean

Supports edge gateways in active-standby mode.

enable_active_standby_preemptive

boolean

Supports edge gateways in active-standby preemptive mode.

enable_bgp

enum<string>

Enable BGP routing (spoke gateways only, transit always has BGP enabled).

Available options:

yes,

no

enable_gwlb

enum<string>

Enable Gateway Load Balancer.

Available options:

yes,

no

enable_ipv6

boolean

Enable IPv6 on the gateway.

enable_nat

string

Enable NAT (yes/no).

enc_volume

boolean

Encrypt EBS volume.

extended_zone

string

Extended availability zone.

fault_domain

string

Fault domain (OCI specific).

firenet

boolean

Create gateway for firenet.

global_vpc

boolean

Enable Global VPC (GCP specific).

guest_mgmt_interfaces

string

Guest management interfaces.

gw_name

string

Name of the gateway to be created. If not provided, auto-generated from group name.

gw_registration_method

enum<string>

Provide the method to register the gateway.

Available options:

cloud_init,

iso

gw_resource_size

string

Size of gw in terms of CPU and Memory, see edge csp API for choices.

gw_size

string

Cloud instance size of the gateway (optional, will use group's instance size if not provided).

gw_subnet

string

Subnet to deploy gateway (required for HA gateways on AWS/Azure/OCI).

hpe

boolean

Use high performance encryption for this Aviatrix Edge gateway.

image_disk_uri

string

Gateway image disk URI (Azure).

image_info

string

Gateway image info for selective deployment.

image_name

string

Gateway image name.

insane_mode

enum<string>

High performance spoke/transit gateway.

Available options:

yes,

no

insertion_gateway

boolean

Create insertion gateway.

interface_mapping

string

User specific interface mapping for the gateway.

interface_mapping_type

enum<string>

pci: Map interfaces by the PCIe IDs. mac: Map interfaces by the mac addresses.

Available options:

custom,

mac,

pci

interfaces

string

Interface configuration.

is_bgp_configured

boolean

Enable/Disable BGP on edge gateway.

is_transit

boolean

Creates Edge as a transit gateway.

lan_default_gateway

string

Default gateway for LAN network.

lan_ifnames

string

Comma separated list LAN host interface names on the edge gateway VM.

lan_ip

string

LAN IP to connect to on premises network.

lan_subnet

string

LAN subnet for BGP over LAN (alias for lan_specify_subnet).

lan_vpc

string

LAN VPC for BGP over LAN.

lb_vpc_id

string

Load balancer VPC ID.

learned_cidrs_approval

string

Learned CIDRs approval mode.

log_file

string

Full path of the progress log file.

logical_intf_eip_map

string

Public IP mapping for the gateway wan logical interfaces.

logical_wan_interface

string

WAN discovery on logical wan interface.

mgmt_default_gateway

string

Default gateway for mgmt interface.

mgmt_egress_ip

string

IP cidr for controller to reach gateway.

mgmt_ifnames

string

Comma separated list of Management host interface names on the edge gateway VM.

mgmt_ip

string

Static IP for mgmt interface, in CIDR notation.

mgmt_over_private_network

boolean

Indicate that Gateway to controller traffic is over a private network.

multicloud_gw

boolean

Create multi-cloud gateway.

name

string

Name for the Aviatrix Edge gateway instance.

native_vlan

string

Native vlan-id.

new_zone

string

New gateway zone (HA gateway).

no_progress_bar

boolean

Do not show gateway creation progress bar.

oob_mgmt_subnet

string

Secondary subnet for OOB management interface.

ph2_encryption_policy

string

Phase 2 encryption policy.

ph2_pfs_policy

string

Phase 2 PFS policy.

phase2_dh

string

Phase 2 PFS policy for the gateway.

phase2_encryption

string

Phase 2 encryption policy for the gateway.

private_channel

boolean

Enable private mode.

private_network

boolean

Deploy gateway without public IP.

private_subnet_egress_target

string

Egress target ID (e.g. nat-xxx, tgw-xxx) for the gateway route table. Required for HPE gateways with private_network.

regular_gateway

boolean

When specified indicates regular gateway.

site_id

string

Optional site id.

spoke

boolean

Create a spoke gateway.

spot_instance

boolean

Launch spot instance.

spot_price

string

Maximum spot instance price.

storage_name

string

Storage type for gateway.

tag_json

string

JSON string of key:value tags.

tag_string

string

Tag key:value pair comma separated list.

transit

boolean

Create a transit gateway.

vlan

string

VLAN configuration.

vpc_id

string

The VPC ID to deploy gateway (optional, will use group's VPC if not provided).

vpc_name

string

Primary gateway name (for HA creation when not using group_uuid flow).

vpc_region

string

The region of an existing VPC (optional, will use group's region if not provided).

wan_default_gateway

string

Default gateway for the WAN interface.

wan_discovery_ip

string

Edit wan discovery public ip.

wan_ifnames

string

Comma separated list of host WAN interfacess on the edge gateway VM.

wan_interface

string

WAN discovery interface.

wan_ip

string

WAN IP to connect to transit gateways.

zone

string

Availability zone for gateway deployment.

Response

General v2 API response schema.

A generic API response container for v2 style APIs.

errortype

string

Error type if the API failed.

reason

string

Failure reason if the API failed.

results

API response data

return

boolean

Whether the API returned successfully

Concepts & Architecture

Guides

Reference

Create mct gateway

Body

Response