fortios_system_ipam – Configure IP address management services in Fortinet’s FortiOS and FortiGate.

New in version 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.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_system_ipam v7.0.2 -> latest

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - 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. type: str default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • system_ipam - Configure IP address management services. type: dict more...
    • automatic_conflict_resolution - Enable/disable automatic conflict resolution. type: str choices: disable, enable more...
    • manage_lan_addresses - Enable/disable default management of LAN interface addresses. type: str choices: disable, enable more...
    • manage_lan_extension_addresses - Enable/disable default management of FortiExtender LAN extension interface addresses. type: str choices: disable, enable more...
    • manage_ssid_addresses - Enable/disable default management of FortiAP SSID addresses. type: str choices: disable, enable more...
    • pool_subnet - Configure IPAM pool subnet, Class A - Class B subnet. type: str more...
    • pools - Configure IPAM pools. type: list member_path: pools:name more...
      • description - Description. type: str more...
      • name - IPAM pool name. type: str required: true more...
      • subnet - Configure IPAM pool subnet, Class A - Class B subnet. type: str more...
    • rules - Configure IPAM allocation rules. type: list member_path: rules:name more...
      • description - Description. type: str more...
      • device - Configure serial number or wildcard of FortiGate to match. type: list member_path: rules:name/device:name more...
        • name - FortiGate serial number or wildcard. type: str required: true more...
      • dhcp - Enable/disable DHCP server for matching IPAM interfaces. type: str choices: enable, disable more...
      • interface - Configure name or wildcard of interface to match. type: list member_path: rules:name/interface:name more...
        • name - Interface name or wildcard. type: str required: true more...
      • name - IPAM rule name. type: str required: true more...
      • pool - Configure name of IPAM pool to use. type: list member_path: rules:name/pool:name more...
        • name - IPAM pool name. Source system.ipam.pools.name. type: str required: true more...
      • role - Configure role of interface to match. type: str choices: any, lan, wan, dmz, undefined more...
    • server_type - Configure the type of IPAM server to use. type: str choices: fabric-root, cloud more...
    • status - Enable/disable IP address management services. type: str choices: enable, disable more...

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>"
                  name: "default_name_10"
                  subnet: "<your_own_value>"
          rules:
              -
                  description: "<your_own_value>"
                  device:
                      -
                          name: "default_name_15"
                  dhcp: "enable"
                  interface:
                      -
                          name: "default_name_18"
                  name: "default_name_19"
                  pool:
                      -
                          name: "default_name_21 (source system.ipam.pools.name)"
                  role: "any"
          server_type: "fabric-root"
          status: "enable"

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.