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 status [disable|enable]
        set type [aci|aws|...]
        set server-ip {string}
        set server-port {integer}
        set username {string}
        set password {user}
        set access-key {string}
        set secret-key {password}
        set region {string}
        set vpc-id {string}
        set server {string}
        set tenant-id {string}
        set subscription-id {string}
        set client-id {string}
        set client-secret {password}
        set login-endpoint {string}
        set resource-url {string}
        set resource-group {string}
        set azure-region [global|china|...]
        config nic
            Description: Configure Azure network interface.
            edit <name>
                config ip
                    Description: Configure IP configuration.
                    edit <name>
                        set public-ip {string}
                    next
                end
            next
        end
        config route-table
            Description: Configure Azure route table.
            edit <name>
                config route
                    Description: Configure Azure route.
                    edit <name>
                        set next-hop {string}
                    next
                end
            next
        end
        config external-ip
            Description: Configure GCP external IP.
            edit <name>
            next
        end
        config route
            Description: Configure GCP route.
            edit <name>
            next
        end
        set update-interval {integer}
    next
end

config system sdn-connector

Parameter

Description

Type

Size

name

SDN connector name.

string

Maximum length: 35

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.

type

Type of SDN connector.

option

-

Option

Description

aci

Application Centric Infrastructure (ACI).

aws

Amazon Web Services (AWS).

azure

Microsoft Azure.

nsx

VMware NSX

nuage

Nuage VSP.

gcp

Google Cloud Platform (GCP).

server-ip

Server address of the remote SDN connector.

string

Maximum length: 127

server-port

Port number of the remote SDN connector.

integer

Minimum value: 1 Maximum value: 65535

username

Username of the remote SDN connector as login credentials.

string

Maximum length: 64

password

Password of the remote SDN connector as login credentials.

user

Not Specified

access-key

AWS access key ID.

string

Maximum length: 31

secret-key

AWS secret access key.

password

Not Specified

region

AWS region name.

string

Maximum length: 15

vpc-id

AWS VPC ID.

string

Maximum length: 31

server

Azure Stack server domain.

string

Maximum length: 127

tenant-id

Azure tenant ID (directory ID).

string

Maximum length: 127

subscription-id

Azure subscription ID.

string

Maximum length: 63

client-id

Azure client ID (application ID).

string

Maximum length: 63

client-secret

Azure client secret (application key).

password

Not Specified

login-endpoint

Azure Stack login endpoint.

string

Maximum length: 127

resource-url

Azure Stack resource URL.

string

Maximum length: 127

resource-group

Azure resource group.

string

Maximum length: 63

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.

update-interval

Dynamic object update interval.

integer

Minimum value: 0 Maximum value: 3600

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

config route-table

Parameter

Description

Type

Size

name

Route table 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

Parameter

Description

Type

Size

name

Route name.

string

Maximum length: 63

config external-ip

Parameter

Description

Type

Size

name

External IP 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

Parameter

Description

Type

Size

name

Route name.

string

Maximum length: 63

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 status [disable|enable]
        set type [aci|aws|...]
        set server-ip {string}
        set server-port {integer}
        set username {string}
        set password {user}
        set access-key {string}
        set secret-key {password}
        set region {string}
        set vpc-id {string}
        set server {string}
        set tenant-id {string}
        set subscription-id {string}
        set client-id {string}
        set client-secret {password}
        set login-endpoint {string}
        set resource-url {string}
        set resource-group {string}
        set azure-region [global|china|...]
        config nic
            Description: Configure Azure network interface.
            edit <name>
                config ip
                    Description: Configure IP configuration.
                    edit <name>
                        set public-ip {string}
                    next
                end
            next
        end
        config route-table
            Description: Configure Azure route table.
            edit <name>
                config route
                    Description: Configure Azure route.
                    edit <name>
                        set next-hop {string}
                    next
                end
            next
        end
        config external-ip
            Description: Configure GCP external IP.
            edit <name>
            next
        end
        config route
            Description: Configure GCP route.
            edit <name>
            next
        end
        set update-interval {integer}
    next
end

config system sdn-connector

Parameter

Description

Type

Size

name

SDN connector name.

string

Maximum length: 35

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.

type

Type of SDN connector.

option

-

Option

Description

aci

Application Centric Infrastructure (ACI).

aws

Amazon Web Services (AWS).

azure

Microsoft Azure.

nsx

VMware NSX

nuage

Nuage VSP.

gcp

Google Cloud Platform (GCP).

server-ip

Server address of the remote SDN connector.

string

Maximum length: 127

server-port

Port number of the remote SDN connector.

integer

Minimum value: 1 Maximum value: 65535

username

Username of the remote SDN connector as login credentials.

string

Maximum length: 64

password

Password of the remote SDN connector as login credentials.

user

Not Specified

access-key

AWS access key ID.

string

Maximum length: 31

secret-key

AWS secret access key.

password

Not Specified

region

AWS region name.

string

Maximum length: 15

vpc-id

AWS VPC ID.

string

Maximum length: 31

server

Azure Stack server domain.

string

Maximum length: 127

tenant-id

Azure tenant ID (directory ID).

string

Maximum length: 127

subscription-id

Azure subscription ID.

string

Maximum length: 63

client-id

Azure client ID (application ID).

string

Maximum length: 63

client-secret

Azure client secret (application key).

password

Not Specified

login-endpoint

Azure Stack login endpoint.

string

Maximum length: 127

resource-url

Azure Stack resource URL.

string

Maximum length: 127

resource-group

Azure resource group.

string

Maximum length: 63

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.

update-interval

Dynamic object update interval.

integer

Minimum value: 0 Maximum value: 3600

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

config route-table

Parameter

Description

Type

Size

name

Route table 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

Parameter

Description

Type

Size

name

Route name.

string

Maximum length: 63

config external-ip

Parameter

Description

Type

Size

name

External IP 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

Parameter

Description

Type

Size

name

Route name.

string

Maximum length: 63