Fortinet white logo
Fortinet white logo

CLI Reference

config system external-resource

config system external-resource

Configure external resource.

config system external-resource
    Description: Configure external resource.
    edit <name>
        set address-comment-field {string}
        set address-data-field {string}
        set address-name-field {string}
        set category {integer}
        set client-cert {string}
        set client-cert-auth [enable|disable]
        set comments {var-string}
        set interface {string}
        set interface-select-method [auto|sdwan|...]
        set namespace {string}
        set object-array-path {string}
        set password {password}
        set refresh-rate {integer}
        set resource {string}
        set server-identity-check [none|basic|...]
        set source-ip {ipv4-address}
        set status [enable|disable]
        set type [category|domain|...]
        set update-method [feed|push]
        set user-agent {var-string}
        set username {string}
        set uuid {uuid}
        set vrf-select {integer}
    next
end

config system external-resource

Parameter

Description

Type

Size

Default

address-comment-field

JSON Path to address description in generic address entry.

string

Maximum length: 511

$.description

address-data-field

JSON Path to address data in generic address entry.

string

Maximum length: 511

$.value

address-name-field

JSON Path to address name in generic address entry.

string

Maximum length: 511

$.name

category

User resource category.

integer

Minimum value: 192 Maximum value: 221

0

client-cert

Client certificate name.

string

Maximum length: 79

client-cert-auth

Enable/disable using client certificate for TLS authentication.

option

-

disable

Option

Description

enable

Enable using client certificate for TLS authentication.

disable

Disable using client certificate for TLS authentication.

comments

Comment.

var-string

Maximum length: 255

interface

Specify outgoing interface to reach server.

string

Maximum length: 15

interface-select-method

Specify how to select outgoing interface to reach server.

option

-

auto

Option

Description

auto

Set outgoing interface automatically.

sdwan

Set outgoing interface by SD-WAN or policy routing rules.

specify

Set outgoing interface manually.

name

External resource name.

string

Maximum length: 35

namespace

Generic external connector address namespace.

string

Maximum length: 15

object-array-path

JSON Path to array of generic addresses in resource.

string

Maximum length: 511

$.addresses

password

HTTP basic authentication password.

password

Not Specified

refresh-rate

Time interval to refresh external resource.

integer

Minimum value: 1 Maximum value: 43200

5

resource

URL of external resource.

string

Maximum length: 511

server-identity-check

Certificate verification option.

option

-

none

Option

Description

none

No certificate verification.

basic

Check server certifcate only.

full

Check server certificate and verify the domain matches in the server certificate.

source-ip

Source IPv4 address used to communicate with server.

ipv4-address

Not Specified

0.0.0.0

status

Enable/disable user resource.

option

-

enable

Option

Description

enable

Enable user resource.

disable

Disable user resource.

type

User resource type.

option

-

category

Option

Description

category

FortiGuard category.

domain

Domain Name.

malware

Malware hash.

address

Firewall IP address.

mac-address

Firewall MAC address.

data

Data file.

generic-address

Generic addresses.

update-method

External resource update method.

option

-

feed

Option

Description

feed

FortiGate unit will pull update from the external resource.

push

External Resource update is pushed to the FortiGate unit through the FortiGate unit's RESTAPI/CLI.

user-agent

HTTP User-Agent header.

var-string

Maximum length: 255

username

HTTP basic authentication user name.

string

Maximum length: 64

uuid

Universally Unique Identifier (UUID; automatically assigned but can be manually reset).

uuid

Not Specified

00000000-0000-0000-0000-000000000000

vrf-select

VRF ID used for connection to server.

integer

Minimum value: 0 Maximum value: 511

0

config system external-resource

config system external-resource

Configure external resource.

config system external-resource
    Description: Configure external resource.
    edit <name>
        set address-comment-field {string}
        set address-data-field {string}
        set address-name-field {string}
        set category {integer}
        set client-cert {string}
        set client-cert-auth [enable|disable]
        set comments {var-string}
        set interface {string}
        set interface-select-method [auto|sdwan|...]
        set namespace {string}
        set object-array-path {string}
        set password {password}
        set refresh-rate {integer}
        set resource {string}
        set server-identity-check [none|basic|...]
        set source-ip {ipv4-address}
        set status [enable|disable]
        set type [category|domain|...]
        set update-method [feed|push]
        set user-agent {var-string}
        set username {string}
        set uuid {uuid}
        set vrf-select {integer}
    next
end

config system external-resource

Parameter

Description

Type

Size

Default

address-comment-field

JSON Path to address description in generic address entry.

string

Maximum length: 511

$.description

address-data-field

JSON Path to address data in generic address entry.

string

Maximum length: 511

$.value

address-name-field

JSON Path to address name in generic address entry.

string

Maximum length: 511

$.name

category

User resource category.

integer

Minimum value: 192 Maximum value: 221

0

client-cert

Client certificate name.

string

Maximum length: 79

client-cert-auth

Enable/disable using client certificate for TLS authentication.

option

-

disable

Option

Description

enable

Enable using client certificate for TLS authentication.

disable

Disable using client certificate for TLS authentication.

comments

Comment.

var-string

Maximum length: 255

interface

Specify outgoing interface to reach server.

string

Maximum length: 15

interface-select-method

Specify how to select outgoing interface to reach server.

option

-

auto

Option

Description

auto

Set outgoing interface automatically.

sdwan

Set outgoing interface by SD-WAN or policy routing rules.

specify

Set outgoing interface manually.

name

External resource name.

string

Maximum length: 35

namespace

Generic external connector address namespace.

string

Maximum length: 15

object-array-path

JSON Path to array of generic addresses in resource.

string

Maximum length: 511

$.addresses

password

HTTP basic authentication password.

password

Not Specified

refresh-rate

Time interval to refresh external resource.

integer

Minimum value: 1 Maximum value: 43200

5

resource

URL of external resource.

string

Maximum length: 511

server-identity-check

Certificate verification option.

option

-

none

Option

Description

none

No certificate verification.

basic

Check server certifcate only.

full

Check server certificate and verify the domain matches in the server certificate.

source-ip

Source IPv4 address used to communicate with server.

ipv4-address

Not Specified

0.0.0.0

status

Enable/disable user resource.

option

-

enable

Option

Description

enable

Enable user resource.

disable

Disable user resource.

type

User resource type.

option

-

category

Option

Description

category

FortiGuard category.

domain

Domain Name.

malware

Malware hash.

address

Firewall IP address.

mac-address

Firewall MAC address.

data

Data file.

generic-address

Generic addresses.

update-method

External resource update method.

option

-

feed

Option

Description

feed

FortiGate unit will pull update from the external resource.

push

External Resource update is pushed to the FortiGate unit through the FortiGate unit's RESTAPI/CLI.

user-agent

HTTP User-Agent header.

var-string

Maximum length: 255

username

HTTP basic authentication user name.

string

Maximum length: 64

uuid

Universally Unique Identifier (UUID; automatically assigned but can be manually reset).

uuid

Not Specified

00000000-0000-0000-0000-000000000000

vrf-select

VRF ID used for connection to server.

integer

Minimum value: 0 Maximum value: 511

0