Fortinet black logo

CLI Reference

config system ipam

config system ipam

Configure IP address management services.

config system ipam
    Description: Configure IP address management services.
    config pools
        Description: Configure IPAM pools.
        edit <name>
            set description {string}
            set subnet {ipv4-classnet}
        next
    end
    config rules
        Description: Configure IPAM allocation rules.
        edit <name>
            set description {string}
            set device <name1>, <name2>, ...
            set interface <name1>, <name2>, ...
            set role [any|lan|...]
            set pool <name1>, <name2>, ...
            set dhcp [enable|disable]
        next
    end
    set server-type [cloud|fabric-root]
    set status [enable|disable]
end

config system ipam

Parameter

Description

Type

Size

Default

server-type

Configure the type of IPAM server to use.

option

-

fabric-root

Option

Description

cloud

Use the FortiIPAM cloud server.

fabric-root

Use the IPAM server running on the Security Fabric root.

status

Enable/disable IP address management services.

option

-

disable

Option

Description

enable

Enable integration with IP address management services.

disable

Disable integration with IP address management services.

config pools

Parameter

Description

Type

Size

Default

name

IPAM pool name.

string

Maximum length: 79

description

Description.

string

Maximum length: 127

subnet

Configure IPAM pool subnet, Class A - Class B subnet.

ipv4-classnet

Not Specified

0.0.0.0 0.0.0.0

config rules

Parameter

Description

Type

Size

Default

name

IPAM rule name.

string

Maximum length: 79

description

Description.

string

Maximum length: 127

device <name>

Configure serial number or wildcard of Fortigate to match.

Fortigate serial number or wildcard.

string

Maximum length: 79

interface <name>

Configure name or wildcard of interface to match.

Interface name or wildcard.

string

Maximum length: 79

role

Configure role of interface to match.

option

-

any

Option

Description

any

Match any interface role.

lan

Match interface role lan.

wan

Match interface role wan.

dmz

Match interface role dmz.

undefined

Match interface role undefined.

pool <name>

Configure name of IPAM pool to use.

Ipam pool name.

string

Maximum length: 79

dhcp

Enable/disable DHCP server for matching IPAM interfaces.

option

-

disable

Option

Description

enable

Enable DHCP server on matched IPAM interface.

disable

Disable DHCP server on matched IPAM interface.

config system ipam

Configure IP address management services.

config system ipam
    Description: Configure IP address management services.
    config pools
        Description: Configure IPAM pools.
        edit <name>
            set description {string}
            set subnet {ipv4-classnet}
        next
    end
    config rules
        Description: Configure IPAM allocation rules.
        edit <name>
            set description {string}
            set device <name1>, <name2>, ...
            set interface <name1>, <name2>, ...
            set role [any|lan|...]
            set pool <name1>, <name2>, ...
            set dhcp [enable|disable]
        next
    end
    set server-type [cloud|fabric-root]
    set status [enable|disable]
end

config system ipam

Parameter

Description

Type

Size

Default

server-type

Configure the type of IPAM server to use.

option

-

fabric-root

Option

Description

cloud

Use the FortiIPAM cloud server.

fabric-root

Use the IPAM server running on the Security Fabric root.

status

Enable/disable IP address management services.

option

-

disable

Option

Description

enable

Enable integration with IP address management services.

disable

Disable integration with IP address management services.

config pools

Parameter

Description

Type

Size

Default

name

IPAM pool name.

string

Maximum length: 79

description

Description.

string

Maximum length: 127

subnet

Configure IPAM pool subnet, Class A - Class B subnet.

ipv4-classnet

Not Specified

0.0.0.0 0.0.0.0

config rules

Parameter

Description

Type

Size

Default

name

IPAM rule name.

string

Maximum length: 79

description

Description.

string

Maximum length: 127

device <name>

Configure serial number or wildcard of Fortigate to match.

Fortigate serial number or wildcard.

string

Maximum length: 79

interface <name>

Configure name or wildcard of interface to match.

Interface name or wildcard.

string

Maximum length: 79

role

Configure role of interface to match.

option

-

any

Option

Description

any

Match any interface role.

lan

Match interface role lan.

wan

Match interface role wan.

dmz

Match interface role dmz.

undefined

Match interface role undefined.

pool <name>

Configure name of IPAM pool to use.

Ipam pool name.

string

Maximum length: 79

dhcp

Enable/disable DHCP server for matching IPAM interfaces.

option

-

disable

Option

Description

enable

Enable DHCP server on matched IPAM interface.

disable

Disable DHCP server on matched IPAM interface.