Instance by id

Query Parameters

instance_name

string

Firewall instance name.

account_name

string

Account name to launch the firewall instance.

region

enum<string>

The region of an existing vpc you wish to connect.

Available options:

ap-chuncheon-1,

ap-hyderabad-1,

ap-melbourne-1,

ap-mumbai-1,

ap-osaka-1,

ap-seoul-1,

ap-singapore-1,

ap-singapore-2,

ap-sydney-1,

ap-tokyo-1,

ca-montreal-1,

ca-toronto-1,

eu-amsterdam-1,

eu-frankfurt-1,

eu-madrid-1,

eu-marseille-1,

eu-milan-1,

eu-paris-1,

eu-stockholm-1,

eu-zurich-1,

il-jerusalem-1,

me-abudhabi-1,

me-dubai-1,

me-jeddah-1,

me-riyadh-1,

mx-monterrey-1,

mx-queretaro-1,

sa-bogota-1,

sa-santiago-1,

sa-saopaulo-1,

sa-valparaiso-1,

sa-vinhedo-1,

uk-cardiff-1,

uk-london-1,

us-ashburn-1,

us-chicago-1,

us-langley-1,

us-luke-1,

us-phoenix-1,

us-sanjose-1

zone

string

Zone to launch Firewall.

vpc_id

string

Transit vpc to be configured.

egress_vpc

string

GCE Firewall egress side vpc.

egress

string

Firewall egress interface subnet.

management

string

Firewall management interface subnet.

management_vpc

string

GCE Firewall management side vpc.

main

string

Firewall main interface subnet.

companion

string

Firewall companion interface subnet.

instance_id

string

required

Firewall instance ID.

firewall_network

boolean

Instance is for Firewall Network.

log_file

string

Full path of the progress log file.

gw_name

string

FireNet gateway attach to.

admin_username

string

Firewall instance admin username.

admin_password

string

Firewall instance admin password.

ssh_public_key

string

SSH Public Key to Access Firewall Instance.

sic_key

string

CheckPoint SIC Activation Key.

tag

string

Tag key:value pair comma separated list.

json_tags

string

Json string of key:value tags.

extended_zone

string

Extended zone.

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.

storage_name

string

Azure Storage Account Name for PAN 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.

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

Instance by id

Query Parameters

Response