fortinet.fortios.fortios_system_ipam module – Configure IP address management services in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortios.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_system_ipam.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and ipam category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Configure IP address management services. |
|
Enable/disable automatic conflict resolution. Choices:
|
|
Enable/disable default management of LAN interface addresses. Choices:
|
|
Enable/disable default management of FortiExtender LAN extension interface addresses. Choices:
|
|
Enable/disable default management of FortiAP SSID addresses. Choices:
|
|
Configure IPAM pool subnet, Class A - Class B subnet. |
|
Configure IPAM pools. |
|
Description. |
|
Configure pool exclude subnets. |
|
Configure subnet to exclude from the IPAM pool. |
|
Exclude ID. see <a href=’#notes’>Notes</a>. |
|
IPAM pool name. |
|
Configure IPAM pool subnet, Class A - Class B subnet. |
|
Enable/disable reassignment of subnets to make requested and actual sizes match. Choices:
|
|
Configure IPAM allocation rules. |
|
Description. |
|
Configure serial number or wildcard of FortiGate to match. |
|
FortiGate serial number or wildcard. |
|
Enable/disable DHCP server for matching IPAM interfaces. Choices:
|
|
Configure name or wildcard of interface to match. |
|
Interface name or wildcard. |
|
IPAM rule name. |
|
Configure name of IPAM pool to use. |
|
IPAM pool name. Source system.ipam.pools.name. |
|
Configure role of interface to match. Choices:
|
|
Configure the type of IPAM server to use. Choices:
|
|
Enable/disable IP address management services. Choices:
|
|
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure IP address management services.
fortinet.fortios.fortios_system_ipam:
vdom: "{{ vdom }}"
system_ipam:
automatic_conflict_resolution: "disable"
manage_lan_addresses: "disable"
manage_lan_extension_addresses: "disable"
manage_ssid_addresses: "disable"
pool_subnet: "<your_own_value>"
pools:
-
description: "<your_own_value>"
exclude:
-
exclude_subnet: "<your_own_value>"
ID: "<you_own_value>"
name: "default_name_13"
subnet: "<your_own_value>"
require_subnet_size_match: "disable"
rules:
-
description: "<your_own_value>"
device:
-
name: "default_name_19"
dhcp: "enable"
interface:
-
name: "default_name_22"
name: "default_name_23"
pool:
-
name: "default_name_25 (source system.ipam.pools.name)"
role: "any"
server_type: "fabric-root"
status: "enable"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |