Fortinet white logo
Fortinet white logo

CLI Reference

config system sdn-connector

config system sdn-connector

Configure connection to SDN Connector.

config system sdn-connector
    Description: Configure connection to SDN Connector.
    edit <name>
        set access-key {string}
        set azure-region [global|china|...]
        set client-id {string}
        set client-secret {password}
        set compartment-id {string}
        set domain {string}
        config external-ip
            Description: Configure GCP external IP.
            edit <name>
            next
        end
        set gcp-project {string}
        set group-name {string}
        set ha-status [disable|enable]
        set login-endpoint {string}
        config nic
            Description: Configure Azure network interface.
            edit <name>
                config ip
                    Description: Configure IP configuration.
                    edit <name>
                        set public-ip {string}
                        set resource-group {string}
                    next
                end
            next
        end
        set oci-cert {string}
        set oci-fingerprint {string}
        set oci-region {string}
        set oci-region-type [commercial|government]
        set password {password_aes256}
        set private-key {user}
        set region {string}
        set resource-group {string}
        set resource-url {string}
        config route
            Description: Configure GCP route.
            edit <name>
            next
        end
        config route-table
            Description: Configure Azure route table.
            edit <name>
                set subscription-id {string}
                set resource-group {string}
                config route
                    Description: Configure Azure route.
                    edit <name>
                        set next-hop {string}
                    next
                end
            next
        end
        set secret-key {password}
        set secret-token {user}
        set server {string}
        set server-port {integer}
        set service-account {string}
        set status [disable|enable]
        set subscription-id {string}
        set tenant-id {string}
        set type [aci|alicloud|...]
        set update-interval {integer}
        set use-metadata-iam [disable|enable]
        set user-id {string}
        set username {string}
        set vpc-id {string}
    next
end

config system sdn-connector

Parameter

Description

Type

Size

access-key

AWS / ACS access key ID.

string

Maximum length: 31

azure-region

Azure server region.

option

-

Option

Description

global

Global Azure Server.

china

China Azure Server.

germany

Germany Azure Server.

usgov

US Government Azure Server.

local

Azure Stack Local Server.

client-id

Azure client ID (application ID).

string

Maximum length: 63

client-secret

Azure client secret (application key).

password

Not Specified

compartment-id

Compartment ID.

string

Maximum length: 127

domain

Domain name.

string

Maximum length: 127

gcp-project

GCP project name.

string

Maximum length: 127

group-name

Group name of computers.

string

Maximum length: 127

ha-status

Enable/disable use for FortiGate HA service.

option

-

Option

Description

disable

Disable use for FortiGate HA service.

enable

Enable use for FortiGate HA service.

login-endpoint

Azure Stack login endpoint.

string

Maximum length: 127

name

SDN connector name.

string

Maximum length: 35

oci-cert

OCI certificate.

string

Maximum length: 63

oci-fingerprint

OCI pubkey fingerprint.

string

Maximum length: 63

oci-region

OCI server region.

string

Maximum length: 31

oci-region-type

OCI region type.

option

-

Option

Description

commercial

Commercial region.

government

Government region.

password

Password of the remote SDN connector as login credentials.

password_aes256

Not Specified

private-key

Private key of GCP service account.

user

Not Specified

region

AWS / ACS region name.

string

Maximum length: 31

resource-group

Azure resource group.

string

Maximum length: 63

resource-url

Azure Stack resource URL.

string

Maximum length: 127

secret-key

AWS / ACS secret access key.

password

Not Specified

secret-token

Secret token of Kubernetes service account.

user

Not Specified

server

Server address of the remote SDN connector.

string

Maximum length: 127

server-port

Port number of the remote SDN connector.

integer

Minimum value: 0 Maximum value: 65535

service-account

GCP service account email.

string

Maximum length: 127

status

Enable/disable connection to the remote SDN connector.

option

-

Option

Description

disable

Disable connection to this SDN Connector.

enable

Enable connection to this SDN Connector.

subscription-id

Azure subscription ID.

string

Maximum length: 63

tenant-id

Tenant ID (directory ID).

string

Maximum length: 127

type

Type of SDN connector.

option

-

Option

Description

aci

Application Centric Infrastructure (ACI).

alicloud

AliCloud Service (ACS).

aws

Amazon Web Services (AWS).

azure

Microsoft Azure.

gcp

Google Cloud Platform (GCP).

nsx

VMware NSX.

nuage

Nuage VSP.

oci

Oracle Cloud Infrastructure.

openstack

OpenStack.

kubernetes

Kubernetes.

vmware

VMware vSphere (vCenter & ESXi).

sepm

Symantec Endpoint Protection Manager.

update-interval

Dynamic object update interval.

integer

Minimum value: 0 Maximum value: 3600

use-metadata-iam

Enable/disable using IAM role from metadata to call API.

option

-

Option

Description

disable

Disable using IAM role to call API.

enable

Enable using IAM role to call API.

user-id

User ID.

string

Maximum length: 127

username

Username of the remote SDN connector as login credentials.

string

Maximum length: 64

vpc-id

AWS VPC ID.

string

Maximum length: 31

config external-ip

Parameter

Description

Type

Size

name

External IP name.

string

Maximum length: 63

config nic

Parameter

Description

Type

Size

name

Network interface name.

string

Maximum length: 63

config ip

Parameter

Description

Type

Size

name

IP configuration name.

string

Maximum length: 63

public-ip

Public IP name.

string

Maximum length: 63

resource-group

Resource group of Azure public IP.

string

Maximum length: 63

config route

Parameter

Description

Type

Size

name

Route name.

string

Maximum length: 63

config route

Parameter

Description

Type

Size

name

Route name.

string

Maximum length: 63

next-hop

Next hop address.

string

Maximum length: 127

config route-table

Parameter

Description

Type

Size

name

Route table name.

string

Maximum length: 63

subscription-id

Subscription ID of Azure route table.

string

Maximum length: 63

resource-group

Resource group of Azure route table.

string

Maximum length: 63

config route

Parameter

Description

Type

Size

name

Route name.

string

Maximum length: 63

config route

Parameter

Description

Type

Size

name

Route name.

string

Maximum length: 63

next-hop

Next hop address.

string

Maximum length: 127

config system sdn-connector

config system sdn-connector

Configure connection to SDN Connector.

config system sdn-connector
    Description: Configure connection to SDN Connector.
    edit <name>
        set access-key {string}
        set azure-region [global|china|...]
        set client-id {string}
        set client-secret {password}
        set compartment-id {string}
        set domain {string}
        config external-ip
            Description: Configure GCP external IP.
            edit <name>
            next
        end
        set gcp-project {string}
        set group-name {string}
        set ha-status [disable|enable]
        set login-endpoint {string}
        config nic
            Description: Configure Azure network interface.
            edit <name>
                config ip
                    Description: Configure IP configuration.
                    edit <name>
                        set public-ip {string}
                        set resource-group {string}
                    next
                end
            next
        end
        set oci-cert {string}
        set oci-fingerprint {string}
        set oci-region {string}
        set oci-region-type [commercial|government]
        set password {password_aes256}
        set private-key {user}
        set region {string}
        set resource-group {string}
        set resource-url {string}
        config route
            Description: Configure GCP route.
            edit <name>
            next
        end
        config route-table
            Description: Configure Azure route table.
            edit <name>
                set subscription-id {string}
                set resource-group {string}
                config route
                    Description: Configure Azure route.
                    edit <name>
                        set next-hop {string}
                    next
                end
            next
        end
        set secret-key {password}
        set secret-token {user}
        set server {string}
        set server-port {integer}
        set service-account {string}
        set status [disable|enable]
        set subscription-id {string}
        set tenant-id {string}
        set type [aci|alicloud|...]
        set update-interval {integer}
        set use-metadata-iam [disable|enable]
        set user-id {string}
        set username {string}
        set vpc-id {string}
    next
end

config system sdn-connector

Parameter

Description

Type

Size

access-key

AWS / ACS access key ID.

string

Maximum length: 31

azure-region

Azure server region.

option

-

Option

Description

global

Global Azure Server.

china

China Azure Server.

germany

Germany Azure Server.

usgov

US Government Azure Server.

local

Azure Stack Local Server.

client-id

Azure client ID (application ID).

string

Maximum length: 63

client-secret

Azure client secret (application key).

password

Not Specified

compartment-id

Compartment ID.

string

Maximum length: 127

domain

Domain name.

string

Maximum length: 127

gcp-project

GCP project name.

string

Maximum length: 127

group-name

Group name of computers.

string

Maximum length: 127

ha-status

Enable/disable use for FortiGate HA service.

option

-

Option

Description

disable

Disable use for FortiGate HA service.

enable

Enable use for FortiGate HA service.

login-endpoint

Azure Stack login endpoint.

string

Maximum length: 127

name

SDN connector name.

string

Maximum length: 35

oci-cert

OCI certificate.

string

Maximum length: 63

oci-fingerprint

OCI pubkey fingerprint.

string

Maximum length: 63

oci-region

OCI server region.

string

Maximum length: 31

oci-region-type

OCI region type.

option

-

Option

Description

commercial

Commercial region.

government

Government region.

password

Password of the remote SDN connector as login credentials.

password_aes256

Not Specified

private-key

Private key of GCP service account.

user

Not Specified

region

AWS / ACS region name.

string

Maximum length: 31

resource-group

Azure resource group.

string

Maximum length: 63

resource-url

Azure Stack resource URL.

string

Maximum length: 127

secret-key

AWS / ACS secret access key.

password

Not Specified

secret-token

Secret token of Kubernetes service account.

user

Not Specified

server

Server address of the remote SDN connector.

string

Maximum length: 127

server-port

Port number of the remote SDN connector.

integer

Minimum value: 0 Maximum value: 65535

service-account

GCP service account email.

string

Maximum length: 127

status

Enable/disable connection to the remote SDN connector.

option

-

Option

Description

disable

Disable connection to this SDN Connector.

enable

Enable connection to this SDN Connector.

subscription-id

Azure subscription ID.

string

Maximum length: 63

tenant-id

Tenant ID (directory ID).

string

Maximum length: 127

type

Type of SDN connector.

option

-

Option

Description

aci

Application Centric Infrastructure (ACI).

alicloud

AliCloud Service (ACS).

aws

Amazon Web Services (AWS).

azure

Microsoft Azure.

gcp

Google Cloud Platform (GCP).

nsx

VMware NSX.

nuage

Nuage VSP.

oci

Oracle Cloud Infrastructure.

openstack

OpenStack.

kubernetes

Kubernetes.

vmware

VMware vSphere (vCenter & ESXi).

sepm

Symantec Endpoint Protection Manager.

update-interval

Dynamic object update interval.

integer

Minimum value: 0 Maximum value: 3600

use-metadata-iam

Enable/disable using IAM role from metadata to call API.

option

-

Option

Description

disable

Disable using IAM role to call API.

enable

Enable using IAM role to call API.

user-id

User ID.

string

Maximum length: 127

username

Username of the remote SDN connector as login credentials.

string

Maximum length: 64

vpc-id

AWS VPC ID.

string

Maximum length: 31

config external-ip

Parameter

Description

Type

Size

name

External IP name.

string

Maximum length: 63

config nic

Parameter

Description

Type

Size

name

Network interface name.

string

Maximum length: 63

config ip

Parameter

Description

Type

Size

name

IP configuration name.

string

Maximum length: 63

public-ip

Public IP name.

string

Maximum length: 63

resource-group

Resource group of Azure public IP.

string

Maximum length: 63

config route

Parameter

Description

Type

Size

name

Route name.

string

Maximum length: 63

config route

Parameter

Description

Type

Size

name

Route name.

string

Maximum length: 63

next-hop

Next hop address.

string

Maximum length: 127

config route-table

Parameter

Description

Type

Size

name

Route table name.

string

Maximum length: 63

subscription-id

Subscription ID of Azure route table.

string

Maximum length: 63

resource-group

Resource group of Azure route table.

string

Maximum length: 63

config route

Parameter

Description

Type

Size

name

Route name.

string

Maximum length: 63

config route

Parameter

Description

Type

Size

name

Route name.

string

Maximum length: 63

next-hop

Next hop address.

string

Maximum length: 127