Create peering HA gateway

Body

application/json

gw_name

string

required

The name of the VPC.

CID

string

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

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

autogen_hagw_name

boolean

Auto generate HA gateway name.

autoscale

boolean

Indicates it is from autoscaling module.

availability_domain

string

OCI availability domain.

backup_link_config

string

Backup link configuration for transit HA gateway.

bgp_lan

boolean

Create transit gateway for BGP over LAN.

bgp_lan_specify_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.

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_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

Sanity check for GA gateway.

eip

string

Reuse a specific 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.

extended_zone

string

Extended Zone.

fault_domain

string

OCI fault domain.

group_uuid

string

Gateway group uuid.

guest_mgmt_interfaces

string

Guest management interfaces.

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

Instance size of vpc cloudx.

hagw_name

string

HA gateway name.

hpe

boolean

Use high performance encryption for this Aviatrix Edge gateway.

insane_mode

enum<string>

High performance spoke/transit gateway.

Available options:

yes,

no

insertion_gateway

boolean

Insert a new subnet for the 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.

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

Indicates it is a multi-cloud transit/spoke gateway.

name

string

Name for the Aviatrix Edge gateway instance.

native_vlan

string

Native vlan-id.

new_zone

string

New Gateway Zone. This parameter is part of the required parameter group:

public_subnet
new_zone

no_progress_bar

boolean

Do not show gateway creation progress bar.

oob_mgmt_subnet

string

Oob_mgmt subnet.

phase2_dh

string

Phase 2 PFS policy for the gateway.

phase2_encryption

string

Phase 2 encryption policy for the gateway.

public_subnet

string

The new subnet. This parameter is part of the required parameter group:

public_subnet
new_zone

site_id

string

Optional site id.

storage

string

Azure ARM image storage.

vlan

string

VLAN configuration.

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.

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 peering HA gateway

Body

Response