config system automation-action

Action for automation stitches.

config system automation-action
    Description: Action for automation stitches.
    edit <name>
        set accprofile {string}
        set action-type [email|ios-notification|...]
        set alicloud-access-key-id {string}
        set alicloud-access-key-secret {password}
        set alicloud-account-id {string}
        set alicloud-function {string}
        set alicloud-function-authorization [anonymous|function]
        set alicloud-function-domain {string}
        set alicloud-region {string}
        set alicloud-service {string}
        set alicloud-version {string}
        set aws-api-id {string}
        set aws-api-key {password}
        set aws-api-path {string}
        set aws-api-stage {string}
        set aws-domain {string}
        set aws-region {string}
        set azure-api-key {password}
        set azure-app {string}
        set azure-domain {string}
        set azure-function {string}
        set azure-function-authorization [anonymous|function|...]
        set delay {integer}
        set email-body {string}
        set email-from {var-string}
        set email-subject {var-string}
        set email-to <name1>, <name2>, ...
        set gcp-function {string}
        set gcp-function-domain {string}
        set gcp-function-region {string}
        set gcp-project {string}
        set headers <header1>, <header2>, ...
        set http-body {var-string}
        set method [post|put|...]
        set minimum-interval {integer}
        set port {integer}
        set protocol [http|https]
        set required [enable|disable]
        set script {var-string}
        set sdn-connector <name1>, <name2>, ...
        set security-tag {string}
        set tls-certificate {string}
        set uri {var-string}
    next
end

config system automation-action

Parameter

Description

Type

Size

accprofile

Access profile for CLI script action to access FortiGate features.

string

Maximum length: 35

action-type

Action type.

option

Option	Description
email	Send notification email.
ios-notification	Send push notification to FortiExplorer iOS.
alert	Generate FortiOS dashboard alert.
disable-ssid	Disable interface.
quarantine	Quarantine host.
quarantine-forticlient	Quarantine FortiClient by EMS.
quarantine-nsx	Quarantine NSX instance.
ban-ip	Ban IP address.
aws-lambda	Send log data to integrated AWS service.
azure-function	Send log data to an Azure function.
google-cloud-function	Send log data to a Google Cloud function.
alicloud-function	Send log data to an AliCloud function.
webhook	Send an HTTP request.
cli-script	Run CLI script.

alicloud-access-key-id

AliCloud AccessKey ID.

string

Maximum length: 35

alicloud-access-key-secret

AliCloud AccessKey secret.

password

Not Specified

alicloud-account-id

AliCloud account ID.

string

Maximum length: 63

alicloud-function

AliCloud function name.

string

Maximum length: 128

alicloud-function-authorization

AliCloud function authorization type.

option

Option	Description
anonymous	Anonymous authorization (No authorization required).
function	Function authorization (Authorization required).

alicloud-function-domain

AliCloud function domain.

string

Maximum length: 63

alicloud-region

AliCloud region.

string

Maximum length: 63

alicloud-service

AliCloud service name.

string

Maximum length: 128

alicloud-version

AliCloud version.

string

Maximum length: 63

aws-api-id

AWS API Gateway ID.

string

Maximum length: 35

aws-api-key

AWS API Gateway API key.

password

Not Specified

aws-api-path

AWS API Gateway path.

string

Maximum length: 63

aws-api-stage

AWS API Gateway deployment stage name.

string

Maximum length: 63

aws-domain

AWS domain.

string

Maximum length: 63

aws-region

AWS region.

string

Maximum length: 35

azure-api-key

Azure function API key.

password

Not Specified

azure-app

Azure function application name.

string

Maximum length: 63

azure-domain

Azure function domain.

string

Maximum length: 63

azure-function

Azure function name.

string

Maximum length: 63

azure-function-authorization

Azure function authorization level.

option

Option	Description
anonymous	Anonymous authorization level (No authorization required).
function	Function authorization level (Function or Host Key required).
admin	Admin authorization level (Master Host Key required).

delay

Delay before execution (in seconds).

integer

Minimum value: 0 Maximum value: 3600

email-body

Email body.

string

Maximum length: 1023

email-from

Email sender name.

var-string

Maximum length: 127

email-subject

Email subject.

var-string

Maximum length: 511

email-to <name>

Email addresses.

Email address.

string

Maximum length: 255

gcp-function

Google Cloud function name.

string

Maximum length: 63

gcp-function-domain

Google Cloud function domain.

string

Maximum length: 63

gcp-function-region

Google Cloud function region.

string

Maximum length: 63

gcp-project

Google Cloud Platform project name.

string

Maximum length: 63

headers <header>

Request headers.

Request header.

string

Maximum length: 255

http-body

Request body (if necessary). Should be serialized json string.

var-string

Maximum length: 1023

method

Request method (POST, PUT, GET, PATCH or DELETE).

option

Option	Description
post	POST.
put	PUT.
get	GET.
patch	PATCH.
delete	DELETE.

minimum-interval

Limit execution to no more than once in this interval (in seconds).

integer

Minimum value: 0 Maximum value: 2592000

name

Name.

string

Maximum length: 64

port

Protocol port.

integer

Minimum value: 1 Maximum value: 65535

protocol

Request protocol.

option

Option	Description
http	HTTP.
https	HTTPS.

required

Required in action chain.

option

Option	Description
enable	Required in action chain.
disable	Not required in action chain.

script

CLI script.

var-string

Maximum length: 1023

sdn-connector <name>

NSX SDN connector names.

SDN connector name.

string

Maximum length: 79

security-tag

NSX security tag.

string

Maximum length: 255

tls-certificate

Custom TLS certificate for API request.

string

Maximum length: 35

uri

Request API URI.

var-string

Maximum length: 1023

config system automation-action

Action for automation stitches.

config system automation-action Description: Action for automation stitches. edit <name> set accprofile {string} set action-type [email|ios-notification|...] set alicloud-access-key-id {string} set alicloud-access-key-secret {password} set alicloud-account-id {string} set alicloud-function {string} set alicloud-function-authorization [anonymous|function] set alicloud-function-domain {string} set alicloud-region {string} set alicloud-service {string} set alicloud-version {string} set aws-api-id {string} set aws-api-key {password} set aws-api-path {string} set aws-api-stage {string} set aws-domain {string} set aws-region {string} set azure-api-key {password} set azure-app {string} set azure-domain {string} set azure-function {string} set azure-function-authorization [anonymous|function|...] set delay {integer} set email-body {string} set email-from {var-string} set email-subject {var-string} set email-to <name1>, <name2>, ... set gcp-function {string} set gcp-function-domain {string} set gcp-function-region {string} set gcp-project {string} set headers <header1>, <header2>, ... set http-body {var-string} set method [post|put|...] set minimum-interval {integer} set port {integer} set protocol [http|https] set required [enable|disable] set script {var-string} set sdn-connector <name1>, <name2>, ... set security-tag {string} set tls-certificate {string} set uri {var-string} next end

config system automation-action

Parameter

Description

Type

Size

accprofile

Access profile for CLI script action to access FortiGate features.

string

Maximum length: 35

action-type

Action type.

option

Option	Description
email	Send notification email.
ios-notification	Send push notification to FortiExplorer iOS.
alert	Generate FortiOS dashboard alert.
disable-ssid	Disable interface.
quarantine	Quarantine host.
quarantine-forticlient	Quarantine FortiClient by EMS.
quarantine-nsx	Quarantine NSX instance.
ban-ip	Ban IP address.
aws-lambda	Send log data to integrated AWS service.
azure-function	Send log data to an Azure function.
google-cloud-function	Send log data to a Google Cloud function.
alicloud-function	Send log data to an AliCloud function.
webhook	Send an HTTP request.
cli-script	Run CLI script.

alicloud-access-key-id

AliCloud AccessKey ID.

string

Maximum length: 35

alicloud-access-key-secret

AliCloud AccessKey secret.

password

Not Specified

alicloud-account-id

AliCloud account ID.

string

Maximum length: 63

alicloud-function

AliCloud function name.

string

Maximum length: 128

alicloud-function-authorization

AliCloud function authorization type.

option

Option	Description
anonymous	Anonymous authorization (No authorization required).
function	Function authorization (Authorization required).

alicloud-function-domain

AliCloud function domain.

string

Maximum length: 63

alicloud-region

AliCloud region.

string

Maximum length: 63

alicloud-service

AliCloud service name.

string

Maximum length: 128

alicloud-version

AliCloud version.

string

Maximum length: 63

aws-api-id

AWS API Gateway ID.

string

Maximum length: 35

aws-api-key

AWS API Gateway API key.

password

Not Specified

aws-api-path

AWS API Gateway path.

string

Maximum length: 63

aws-api-stage

AWS API Gateway deployment stage name.

string

Maximum length: 63

aws-domain

AWS domain.

string

Maximum length: 63

aws-region

AWS region.

string

Maximum length: 35

azure-api-key

Azure function API key.

password

Not Specified

azure-app

Azure function application name.

string

Maximum length: 63

azure-domain

Azure function domain.

string

Maximum length: 63

azure-function

Azure function name.

string

Maximum length: 63

azure-function-authorization

Azure function authorization level.

option

Option	Description
anonymous	Anonymous authorization level (No authorization required).
function	Function authorization level (Function or Host Key required).
admin	Admin authorization level (Master Host Key required).

delay

Delay before execution (in seconds).

integer

Minimum value: 0 Maximum value: 3600

email-body

Email body.

string

Maximum length: 1023

email-from

Email sender name.

var-string

Maximum length: 127

email-subject

Email subject.

var-string

Maximum length: 511

email-to <name>

Email addresses.

Email address.

string

Maximum length: 255

gcp-function

Google Cloud function name.

string

Maximum length: 63

gcp-function-domain

Google Cloud function domain.

string

Maximum length: 63

gcp-function-region

Google Cloud function region.

string

Maximum length: 63

gcp-project

Google Cloud Platform project name.

string

Maximum length: 63

headers <header>

Request headers.

Request header.

string

Maximum length: 255

http-body

Request body (if necessary). Should be serialized json string.

var-string

Maximum length: 1023

method

Request method (POST, PUT, GET, PATCH or DELETE).

option

Option	Description
post	POST.
put	PUT.
get	GET.
patch	PATCH.
delete	DELETE.

minimum-interval

Limit execution to no more than once in this interval (in seconds).

integer

Minimum value: 0 Maximum value: 2592000

name

Name.

string

Maximum length: 64

port

Protocol port.

integer

Minimum value: 1 Maximum value: 65535

protocol

Request protocol.

option

Option	Description
http	HTTP.
https	HTTPS.

required

Required in action chain.

option

Option	Description
enable	Required in action chain.
disable	Not required in action chain.

script

CLI script.

var-string

Maximum length: 1023

sdn-connector <name>

NSX SDN connector names.

SDN connector name.

string

Maximum length: 79

security-tag

NSX security tag.

string

Maximum length: 255

tls-certificate

Custom TLS certificate for API request.

string

Maximum length: 35

uri

Request API URI.

var-string

Maximum length: 1023

CLI Reference

config system automation-action

config system automation-action

config system automation-action

config system automation-action

config system automation-action