Fortinet white logo
Fortinet white logo

CLI Reference

config user domain-controller

config user domain-controller

Configure domain controller entries.

config user domain-controller
    Description: Configure domain controller entries.
    edit <name>
        set ad-mode [none|ds|...]
        set hostname {string}
        set username {string}
        set password {password}
        set ip-address {ipv4-address}
        set ip6 {ipv6-address}
        set port {integer}
        set source-ip-address {ipv4-address}
        set source-ip6 {ipv6-address}
        set source-port {integer}
        set interface-select-method [auto|specify]
        set interface {string}
        config extra-server
            Description: Extra servers.
            edit <id>
                set ip-address {ipv4-address}
                set port {integer}
                set source-ip-address {ipv4-address}
                set source-port {integer}
            next
        end
        set domain-name {string}
        set domain-name-src [server|client]
        set replication-port {integer}
        set ldap-server <name1>, <name2>, ...
        set change-detection [enable|disable]
        set change-detection-period {integer}
        set dns-srv-lookup [enable|disable]
        set adlds-dn {string}
        set adlds-ip-address {ipv4-address}
        set adlds-ip6 {ipv6-address}
        set adlds-port {integer}
    next
end

config user domain-controller

Parameter

Description

Type

Size

Default

name

Domain controller entry name.

string

Maximum length: 35

ad-mode

Set Active Directory mode.

option

-

none

Option

Description

none

The server is not configured as an Active Directory Domain Server (AD DS).

ds

The server is configured as an Active Directory Domain Server (AD DS).

lds

The server is an Active Directory Lightweight Domain Server (AD LDS).

hostname

Hostname of the server to connect to.

string

Maximum length: 255

username

User name to sign in with. Must have proper permissions for service.

string

Maximum length: 64

password

Password for specified username.

password

Not Specified

ip-address

Domain controller IPv4 address.

ipv4-address

Not Specified

0.0.0.0

ip6

Domain controller IPv6 address.

ipv6-address

Not Specified

::

port

Port to be used for communication with the domain controller.

integer

Minimum value: 0 Maximum value: 65535

445

source-ip-address

FortiProxy IPv4 address to be used for communication with the domain controller.

ipv4-address

Not Specified

0.0.0.0

source-ip6

FortiProxy IPv6 address to be used for communication with the domain controller.

ipv6-address

Not Specified

::

source-port

Source port to be used for communication with the domain controller.

integer

Minimum value: 0 Maximum value: 65535

0

interface-select-method

Specify how to select outgoing interface to reach server.

option

-

auto

Option

Description

auto

Set outgoing interface automatically.

specify

Set outgoing interface manually.

interface

Specify outgoing interface to reach server.

string

Maximum length: 15

domain-name

Domain DNS name.

string

Maximum length: 255

domain-name-src

Select where to extract domain name.

option

-

client

Option

Description

server

Extract domain name from server's (Domain Controller) data.

client

Extract domain name from client's data.

replication-port

Port to be used for communication with the domain controller for replication service. Port number 0 indicates automatic discovery.

integer

Minimum value: 0 Maximum value: 65535

0

ldap-server <name>

LDAP server name(s).

LDAP server name.

string

Maximum length: 79

change-detection

Enable/disable detection of a configuration change in the Active Directory server.

option

-

disable

Option

Description

enable

Enable detection of a configuration change in the Active Directory server.

disable

Disable detection of a configuration change in the Active Directory server.

change-detection-period

Minutes to detect a configuration change in the Active Directory server.

integer

Minimum value: 5 Maximum value: 10080

60

dns-srv-lookup

Enable/disable DNS service lookup.

option

-

disable

Option

Description

enable

Enable DNS service lookup.

disable

Disable DNS service lookup.

adlds-dn

AD LDS distinguished name.

string

Maximum length: 255

adlds-ip-address

AD LDS IPv4 address.

ipv4-address

Not Specified

0.0.0.0

adlds-ip6

AD LDS IPv6 address.

ipv6-address

Not Specified

::

adlds-port

Port number of AD LDS service.

integer

Minimum value: 0 Maximum value: 65535

389

config extra-server

Parameter

Description

Type

Size

Default

id

Server ID.

integer

Minimum value: 1 Maximum value: 100

0

ip-address

Domain controller IP address.

ipv4-address

Not Specified

0.0.0.0

port

Port to be used for communication with the domain controller.

integer

Minimum value: 0 Maximum value: 65535

445

source-ip-address

FortiProxy IPv4 address to be used for communication with the domain controller.

ipv4-address

Not Specified

0.0.0.0

source-port

Source port to be used for communication with the domain controller.

integer

Minimum value: 0 Maximum value: 65535

0

config user domain-controller

config user domain-controller

Configure domain controller entries.

config user domain-controller
    Description: Configure domain controller entries.
    edit <name>
        set ad-mode [none|ds|...]
        set hostname {string}
        set username {string}
        set password {password}
        set ip-address {ipv4-address}
        set ip6 {ipv6-address}
        set port {integer}
        set source-ip-address {ipv4-address}
        set source-ip6 {ipv6-address}
        set source-port {integer}
        set interface-select-method [auto|specify]
        set interface {string}
        config extra-server
            Description: Extra servers.
            edit <id>
                set ip-address {ipv4-address}
                set port {integer}
                set source-ip-address {ipv4-address}
                set source-port {integer}
            next
        end
        set domain-name {string}
        set domain-name-src [server|client]
        set replication-port {integer}
        set ldap-server <name1>, <name2>, ...
        set change-detection [enable|disable]
        set change-detection-period {integer}
        set dns-srv-lookup [enable|disable]
        set adlds-dn {string}
        set adlds-ip-address {ipv4-address}
        set adlds-ip6 {ipv6-address}
        set adlds-port {integer}
    next
end

config user domain-controller

Parameter

Description

Type

Size

Default

name

Domain controller entry name.

string

Maximum length: 35

ad-mode

Set Active Directory mode.

option

-

none

Option

Description

none

The server is not configured as an Active Directory Domain Server (AD DS).

ds

The server is configured as an Active Directory Domain Server (AD DS).

lds

The server is an Active Directory Lightweight Domain Server (AD LDS).

hostname

Hostname of the server to connect to.

string

Maximum length: 255

username

User name to sign in with. Must have proper permissions for service.

string

Maximum length: 64

password

Password for specified username.

password

Not Specified

ip-address

Domain controller IPv4 address.

ipv4-address

Not Specified

0.0.0.0

ip6

Domain controller IPv6 address.

ipv6-address

Not Specified

::

port

Port to be used for communication with the domain controller.

integer

Minimum value: 0 Maximum value: 65535

445

source-ip-address

FortiProxy IPv4 address to be used for communication with the domain controller.

ipv4-address

Not Specified

0.0.0.0

source-ip6

FortiProxy IPv6 address to be used for communication with the domain controller.

ipv6-address

Not Specified

::

source-port

Source port to be used for communication with the domain controller.

integer

Minimum value: 0 Maximum value: 65535

0

interface-select-method

Specify how to select outgoing interface to reach server.

option

-

auto

Option

Description

auto

Set outgoing interface automatically.

specify

Set outgoing interface manually.

interface

Specify outgoing interface to reach server.

string

Maximum length: 15

domain-name

Domain DNS name.

string

Maximum length: 255

domain-name-src

Select where to extract domain name.

option

-

client

Option

Description

server

Extract domain name from server's (Domain Controller) data.

client

Extract domain name from client's data.

replication-port

Port to be used for communication with the domain controller for replication service. Port number 0 indicates automatic discovery.

integer

Minimum value: 0 Maximum value: 65535

0

ldap-server <name>

LDAP server name(s).

LDAP server name.

string

Maximum length: 79

change-detection

Enable/disable detection of a configuration change in the Active Directory server.

option

-

disable

Option

Description

enable

Enable detection of a configuration change in the Active Directory server.

disable

Disable detection of a configuration change in the Active Directory server.

change-detection-period

Minutes to detect a configuration change in the Active Directory server.

integer

Minimum value: 5 Maximum value: 10080

60

dns-srv-lookup

Enable/disable DNS service lookup.

option

-

disable

Option

Description

enable

Enable DNS service lookup.

disable

Disable DNS service lookup.

adlds-dn

AD LDS distinguished name.

string

Maximum length: 255

adlds-ip-address

AD LDS IPv4 address.

ipv4-address

Not Specified

0.0.0.0

adlds-ip6

AD LDS IPv6 address.

ipv6-address

Not Specified

::

adlds-port

Port number of AD LDS service.

integer

Minimum value: 0 Maximum value: 65535

389

config extra-server

Parameter

Description

Type

Size

Default

id

Server ID.

integer

Minimum value: 1 Maximum value: 100

0

ip-address

Domain controller IP address.

ipv4-address

Not Specified

0.0.0.0

port

Port to be used for communication with the domain controller.

integer

Minimum value: 0 Maximum value: 65535

445

source-ip-address

FortiProxy IPv4 address to be used for communication with the domain controller.

ipv4-address

Not Specified

0.0.0.0

source-port

Source port to be used for communication with the domain controller.

integer

Minimum value: 0 Maximum value: 65535

0