Fortinet black logo

CLI Reference

config system automation-action

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-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 message {string}
        set method [post|put|...]
        set minimum-interval {integer}
        set name {string}
        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}
        set verify-host-cert [enable|disable]
    next
end

config system automation-action

Parameter

Description

Type

Size

Default

accprofile

Access profile for CLI script action to access FortiGate features.

string

Not Specified

action-type

Action type.

option

-

alert

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.

quarantine-fortinac

Quarantine host by FortiNAC.

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.

slack-notification

Send a notification message to a Slack incoming webhook.

alicloud-access-key-id

AliCloud AccessKey ID.

string

Not Specified

alicloud-access-key-secret

AliCloud AccessKey secret.

password

Not Specified

alicloud-account-id

AliCloud account ID.

string

Not Specified

alicloud-function

AliCloud function name.

string

Not Specified

alicloud-function-authorization

AliCloud function authorization type.

option

-

anonymous

Option

Description

anonymous

Anonymous authorization (No authorization required).

function

Function authorization (Authorization required).

alicloud-function-domain

AliCloud function domain.

string

Not Specified

fc.aliyuncs.com

alicloud-region

AliCloud region.

string

Not Specified

alicloud-service

AliCloud service name.

string

Not Specified

alicloud-version

AliCloud version.

string

Not Specified

aws-api-id

AWS API Gateway ID.

string

Not Specified

aws-api-key

AWS API Gateway API key.

password

Not Specified

aws-api-path

AWS API Gateway path.

string

Not Specified

aws-api-stage

AWS API Gateway deployment stage name.

string

Not Specified

aws-domain

AWS domain.

string

Not Specified

amazonaws.com

aws-region

AWS region.

string

Not Specified

azure-api-key

Azure function API key.

password

Not Specified

azure-app

Azure function application name.

string

Not Specified

azure-domain

Azure function domain.

string

Not Specified

azurewebsites.net

azure-function

Azure function name.

string

Not Specified

azure-function-authorization

Azure function authorization level.

option

-

anonymous

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

0

email-from

Email sender name.

var-string

Not Specified

email-subject

Email subject.

var-string

Not Specified

email-to <name>

Email addresses.

Email address.

string

Maximum length: 255

gcp-function

Google Cloud function name.

string

Not Specified

gcp-function-domain

Google Cloud function domain.

string

Not Specified

cloudfunctions.net

gcp-function-region

Google Cloud function region.

string

Not Specified

gcp-project

Google Cloud Platform project name.

string

Not Specified

headers <header>

Request headers.

Request header.

string

Maximum length: 255

http-body

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

var-string

Not Specified

message

Message content.

string

Not Specified

%%log%%

method

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

option

-

post

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

0

name

Name.

string

Not Specified

port

Protocol port.

integer

Minimum value: 1 Maximum value: 65535

0

protocol

Request protocol.

option

-

http

Option

Description

http

HTTP.

https

HTTPS.

required

Required in action chain.

option

-

disable

Option

Description

enable

Required in action chain.

disable

Not required in action chain.

script

CLI script.

var-string

Not Specified

sdn-connector <name>

NSX SDN connector names.

SDN connector name.

string

Maximum length: 79

security-tag

NSX security tag.

string

Not Specified

tls-certificate

Custom TLS certificate for API request.

string

Not Specified

uri

Request API URI.

var-string

Not Specified

verify-host-cert

Enable/disable verification of the remote host certificate.

option

-

enable

Option

Description

enable

Enable verification of the remote host certificate.

disable

Disable verification of the remote host certificate.

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-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 message {string}
        set method [post|put|...]
        set minimum-interval {integer}
        set name {string}
        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}
        set verify-host-cert [enable|disable]
    next
end

config system automation-action

Parameter

Description

Type

Size

Default

accprofile

Access profile for CLI script action to access FortiGate features.

string

Not Specified

action-type

Action type.

option

-

alert

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.

quarantine-fortinac

Quarantine host by FortiNAC.

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.

slack-notification

Send a notification message to a Slack incoming webhook.

alicloud-access-key-id

AliCloud AccessKey ID.

string

Not Specified

alicloud-access-key-secret

AliCloud AccessKey secret.

password

Not Specified

alicloud-account-id

AliCloud account ID.

string

Not Specified

alicloud-function

AliCloud function name.

string

Not Specified

alicloud-function-authorization

AliCloud function authorization type.

option

-

anonymous

Option

Description

anonymous

Anonymous authorization (No authorization required).

function

Function authorization (Authorization required).

alicloud-function-domain

AliCloud function domain.

string

Not Specified

fc.aliyuncs.com

alicloud-region

AliCloud region.

string

Not Specified

alicloud-service

AliCloud service name.

string

Not Specified

alicloud-version

AliCloud version.

string

Not Specified

aws-api-id

AWS API Gateway ID.

string

Not Specified

aws-api-key

AWS API Gateway API key.

password

Not Specified

aws-api-path

AWS API Gateway path.

string

Not Specified

aws-api-stage

AWS API Gateway deployment stage name.

string

Not Specified

aws-domain

AWS domain.

string

Not Specified

amazonaws.com

aws-region

AWS region.

string

Not Specified

azure-api-key

Azure function API key.

password

Not Specified

azure-app

Azure function application name.

string

Not Specified

azure-domain

Azure function domain.

string

Not Specified

azurewebsites.net

azure-function

Azure function name.

string

Not Specified

azure-function-authorization

Azure function authorization level.

option

-

anonymous

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

0

email-from

Email sender name.

var-string

Not Specified

email-subject

Email subject.

var-string

Not Specified

email-to <name>

Email addresses.

Email address.

string

Maximum length: 255

gcp-function

Google Cloud function name.

string

Not Specified

gcp-function-domain

Google Cloud function domain.

string

Not Specified

cloudfunctions.net

gcp-function-region

Google Cloud function region.

string

Not Specified

gcp-project

Google Cloud Platform project name.

string

Not Specified

headers <header>

Request headers.

Request header.

string

Maximum length: 255

http-body

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

var-string

Not Specified

message

Message content.

string

Not Specified

%%log%%

method

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

option

-

post

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

0

name

Name.

string

Not Specified

port

Protocol port.

integer

Minimum value: 1 Maximum value: 65535

0

protocol

Request protocol.

option

-

http

Option

Description

http

HTTP.

https

HTTPS.

required

Required in action chain.

option

-

disable

Option

Description

enable

Required in action chain.

disable

Not required in action chain.

script

CLI script.

var-string

Not Specified

sdn-connector <name>

NSX SDN connector names.

SDN connector name.

string

Maximum length: 79

security-tag

NSX security tag.

string

Not Specified

tls-certificate

Custom TLS certificate for API request.

string

Not Specified

uri

Request API URI.

var-string

Not Specified

verify-host-cert

Enable/disable verification of the remote host certificate.

option

-

enable

Option

Description

enable

Enable verification of the remote host certificate.

disable

Disable verification of the remote host certificate.