List FireNet

Query Parameters

subaction

enum<string>

required

Component to be edited.

Available options:

arm_resource_group,

availability_domain,

dmz,

dmz_vpc_display_fields,

fault_domain,

firewall,

firewall_display_fields,

firewall_image,

firewall_lan_cidr,

firewall_manager,

firewall_manager_vendor,

firewall_manager_vendor_display_fields,

firewall_vendor,

firewall_vendor_display_fields,

fqdn_gw,

gateway,

gce_resources,

instance,

subnet,

tgw,

vpc

gateway_name

string

Transit gateway name to enable dmz interface.

mode

enum<string>

Available options:

default,

gwlb

vpc_id

string

Transit vpc to be configured.

region

string

The region of the vpc to be configured.

account

string

The account that should be used to configure the vpc.

firewall_id

string

Firewall instance id.

firewall_name

string

Firewall instance name.

main

string

Firewall main side interface or subnet.

zone

string

Zone to launch Firewall.

main_ha

string

Firewall main side interface or subnet for hagw.

egress_vpc

string

GCE Firewall egress side vpc.

egress

string

Firewall egress side interface or subnet.

management_vpc

string

GCE Firewall management side vpc.

management

string

Firewall management side interface or subnet.

detail

boolean

Show detail info.

json_format

boolean

Return structured JSON in vendor_info for CoPilot UI.

firewall_egress

enum<string>

Support egress traffic through firewall. A boolean choice expressed as a string

Available options:

yes,

no

east_west

enum<string>

Support east-west traffic inspection through firewall. A boolean choice expressed as a string

Available options:

yes,

no

firewall_hashing

enum<string>

Select Firewall hashing selection.

Available options:

2-Tuple,

5-Tuple

fail_close

enum<string>

Enable close on all fail firewalls. A boolean choice expressed as a string

Available options:

yes,

no

private

boolean

List private subnets.

attach

boolean

Enable firewall at the same time when insert firewall.

no_associate

boolean

Skip associating firewall to gateway.

management_access

string

Spoke name that allow management access to.

exclude_cidr

string

Excluded CIDR List from inspection.

lan_ping

enum<string>

Enable Lan Interface Ping. A boolean choice expressed as a string

Available options:

yes,

no

egress_static_cidr

string

Static Cidr for egress traffic.

tgw_segmentation

enum<string>

Enable TGW domain segmentation for Egress FireNet. A boolean choice expressed as a string

Available options:

yes,

no

tag

string

Tag key:value pair comma separated list.

json_tags

string

Json string of key:value tags.

cloud_type

integer

Cloud type.

extended_zone

string

Extended Zone.

version_count

integer

Version count.

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

public_ip

string

Firewall management interface IP.

user

string

Administrator user name.

password

string

Administrator password.

api_token

string

Administrator API token for Fortigate.

route_table

string

Default route table.

sync

boolean

Sync local config with vendor config.

private_key_file

string

SSH private key file.

firewall_instance

boolean

List Firewall instances for Firewall Network.

template

string

Template name that the firewall belongs to.

template_stack

string

Template stack name that the firewall belongs to.

config_mode

enum<string>

Config mode for firewall manager.

Available options:

ADVANCE,

DEFAULT

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_image_id

string

Custom firewall image id.

firewall_image

string

Firewall VM image name.

key_name

string

Firewall instance key pair name.

iam

string

AWS IAM role to be attached to the new instance.

bucket_name

string

AWS S3 bucket name for bootstrap.

firewall_size

string

Firewall instance ID.

firewall_image_version

string

Firewall image version.

sic

string

Check point sic key.

user_data

string

User data to boot strap firewall instance.

availability_domain

string

Availability domain (OCI only).

fault_domain

string

Fault domain (OCI only).

enable_ipv6

boolean

Enable ipv6 on the Firewall.

tgw_name

string

AWS TGW name.

domain_name

string

AWS TGW domain name.

arm_resource_group

string

Azure resource group name.

ssh_public_key

string

SSH Public Key.

sic_key

string

CheckPoint SIC Activation Key.

storage_name

string

Azure Storage Account Name for bootstrap.

storage_access_key

string

Azure Storage Access Key for PAN bootstrap.

Azure File share folder to store PAN bootstrap data.

Optional Azure common file share directory for PAN bootstrap.

container_folder

string

Azure container folder name for FortiGate bootstrap.

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.

log_file

string

Full path of the progress log file.

action

string

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

CID

string

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

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

List FireNet

Query Parameters

Response