Attach firewall to FireNet

Body

application/json

firewall_id

string

required

Firewall instance id.

vpc_id

string

required

Transit vpc to be configured.

CID

string

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

account

string

The account that should be used to configure the vpc.

action

string

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

api_token

string

Administrator API token for Fortigate.

arm_resource_group

string

Azure resource group name.

attach

boolean

Enable firewall at the same time when insert firewall.

availability_domain

string

Availability domain (OCI only).

bucket_name

string

AWS S3 bucket name for bootstrap.

cloud_type

integer

Cloud type.

config_mode

enum<string>

Config mode for firewall manager.

Available options:

ADVANCE,

DEFAULT

container_folder

string

Azure container folder name for FortiGate bootstrap.

detail

boolean

Show detail info.

domain_name

string

AWS TGW domain name.

east_west

enum<string>

Support east-west traffic inspection through firewall.

Available options:

yes,

no

egress

string

Firewall egress side interface or subnet.

egress_static_cidr

string

Static Cidr for egress traffic.

egress_vpc

string

GCE Firewall egress side vpc.

enable_ipv6

boolean

Enable ipv6 on the Firewall.

exclude_cidr

string

Excluded CIDR List from inspection.

extended_zone

string

Extended Zone.

fail_close

enum<string>

Enable close on all fail firewalls.

Available options:

yes,

no

fault_domain

string

Fault domain (OCI only).

Azure File share folder to store PAN bootstrap data.

firewall_egress

enum<string>

Support egress traffic through firewall.

Available options:

yes,

no

firewall_hashing

enum<string>

Select Firewall hashing selection.

Available options:

2-Tuple,

5-Tuple

firewall_image

string

Firewall VM image name.

firewall_image_id

string

Custom firewall image id.

firewall_image_version

string

Firewall image version.

firewall_instance

boolean

List Firewall instances for Firewall Network.

firewall_name

string

Firewall instance name.

firewall_size

string

Firewall instance ID.

firewall_template_config

string

Firewall template config with config_mode advance. dict {"firewall_id":{"template":"template_name", "template_stack":"stack_name","route_table":"route_table_name"}}.

firewall_vendor

enum<string>

Firewall type.

Available options:

Aviatrix FQDN Gateway,

Check Point Cloud Guard,

Fortinet FortiGate,

Generic,

Palo Alto Networks Panorama,

Palo Alto Networks VM-Series

gw_name

string

Transit gateway name to enable dmz interface.

iam

string

AWS IAM role to be attached to the new instance.

json_format

boolean

Return structured JSON in vendor_info for CoPilot UI.

json_tags

string

Json string of key:value tags.

key_name

string

Firewall instance key pair name.

lan_ping

enum<string>

Enable Lan Interface Ping.

Available options:

yes,

no

log_file

string

Full path of the progress log file.

main

string

Firewall main side interface or subnet.

main_ha

string

Firewall main side interface or subnet for hagw.

management

string

Firewall management side interface or subnet.

management_access

string

Spoke name that allow management access to.

management_vpc

string

GCE Firewall management side vpc.

mode

enum<string>

Available options:

default,

gwlb

no_associate

boolean

Skip associating firewall to gateway.

password

string

Administrator password.

private

boolean

List private subnets.

private_key_file

string

SSH private key file.

public_ip

string

Firewall management interface IP.

region

string

The region of the vpc to be configured.

route_table

string

Default route table.

sas_url_config

string

Azure SAS URL to access FortiGate configURI bootstrap data.

sas_url_license

string

Azure SAS URL to access FortiGate licenseURI bootstrap data.

Optional Azure common file share directory for PAN bootstrap.

sic

string

Check point sic key.

sic_key

string

CheckPoint SIC Activation Key.

ssh_public_key

string

SSH Public Key.

storage_access_key

string

Azure Storage Access Key for PAN bootstrap.

storage_name

string

Azure Storage Account Name for bootstrap.

sync

boolean

Sync local config with vendor config.

tag

string

Tag key:value pair comma separated list.

template

string

Template name that the firewall belongs to.

template_stack

string

Template stack name that the firewall belongs to.

tgw_name

string

AWS TGW name.

tgw_segmentation

enum<string>

Enable TGW domain segmentation for Egress FireNet.

Available options:

yes,

no

user

string

Administrator user name.

user_data

string

User data to boot strap firewall instance.

version_count

integer

Version count.

zone

string

Zone to launch Firewall.

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

Attach firewall to FireNet

Body

Response