fortinet.fortios.fortios_system_ipam (2.3.6) — module

Configure IP address management services in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of fortinet.fortios"

Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6


Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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>"
          require_subnet_size_match: "disable"
          rules:
              -
                  description: "<your_own_value>"
                  device:
                      -
                          name: "default_name_16"
                  dhcp: "enable"
                  interface:
                      -
                          name: "default_name_19"
                  name: "default_name_20"
                  pool:
                      -
                          name: "default_name_22 (source system.ipam.pools.name)"
                  role: "any"
          server_type: "fabric-root"
          status: "enable"

Inputs

    
vdom:
    default: root
    description:
    - 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

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - 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.
    type: str

system_ipam:
    default: null
    description:
    - Configure IP address management services.
    suboptions:
      automatic_conflict_resolution:
        choices:
        - disable
        - enable
        description:
        - Enable/disable automatic conflict resolution.
        type: str
      manage_lan_addresses:
        choices:
        - disable
        - enable
        description:
        - Enable/disable default management of LAN interface addresses.
        type: str
      manage_lan_extension_addresses:
        choices:
        - disable
        - enable
        description:
        - Enable/disable default management of FortiExtender LAN extension interface addresses.
        type: str
      manage_ssid_addresses:
        choices:
        - disable
        - enable
        description:
        - Enable/disable default management of FortiAP SSID addresses.
        type: str
      pool_subnet:
        description:
        - Configure IPAM pool subnet, Class A - Class B subnet.
        type: str
      pools:
        description:
        - Configure IPAM pools.
        elements: dict
        suboptions:
          description:
            description:
            - Description.
            type: str
          name:
            description:
            - IPAM pool name.
            required: true
            type: str
          subnet:
            description:
            - Configure IPAM pool subnet, Class A - Class B subnet.
            type: str
        type: list
      require_subnet_size_match:
        choices:
        - disable
        - enable
        description:
        - Enable/disable reassignment of subnets to make requested and actual sizes match.
        type: str
      rules:
        description:
        - Configure IPAM allocation rules.
        elements: dict
        suboptions:
          description:
            description:
            - Description.
            type: str
          device:
            description:
            - Configure serial number or wildcard of FortiGate to match.
            elements: dict
            suboptions:
              name:
                description:
                - FortiGate serial number or wildcard.
                required: true
                type: str
            type: list
          dhcp:
            choices:
            - enable
            - disable
            description:
            - Enable/disable DHCP server for matching IPAM interfaces.
            type: str
          interface:
            description:
            - Configure name or wildcard of interface to match.
            elements: dict
            suboptions:
              name:
                description:
                - Interface name or wildcard.
                required: true
                type: str
            type: list
          name:
            description:
            - IPAM rule name.
            required: true
            type: str
          pool:
            description:
            - Configure name of IPAM pool to use.
            elements: dict
            suboptions:
              name:
                description:
                - IPAM pool name. Source system.ipam.pools.name.
                required: true
                type: str
            type: list
          role:
            choices:
            - any
            - lan
            - wan
            - dmz
            - undefined
            description:
            - Configure role of interface to match.
            type: str
        type: list
      server_type:
        choices:
        - fabric-root
        - cloud
        description:
        - Configure the type of IPAM server to use.
        type: str
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable IP address management services.
        type: str
    type: dict

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

Outputs

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