fortinet.fortimanager.fmgr_firewall_ippool_dynamicmapping (2.4.0) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

Description

This module is able to configure a FortiManager device.

Examples include all parameters and values which need to be adjusted to data sources before usage.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure dynamic mappings of IPv4 IP pool
      fortinet.fortimanager.fmgr_firewall_ippool_dynamicmapping:
        bypass_validation: false
        adom: ansible
        ippool: "ansible-test" # name
        state: present
        firewall_ippool_dynamicmapping:
          _scope:
            - name: FGT_AWS # need a valid device name
              vdom: root # need a valid vdom name under the device
          comments: "ansible-comment"
          endip: "222.222.222.253"
          startip: "222.222.222.0"
          type: overload # <value in [overload, one-to-one, fixed-port-range, ...]>

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the dynamic mappings of IPv4 IP pool
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_ippool_dynamicmapping"
          params:
            adom: "ansible"
            ippool: "ansible-test" # name
            dynamic_mapping: "your_value"

Inputs

    
adom:
    description: The parameter (adom) in requested url.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object.
    required: true
    type: str

ippool:
    description: The parameter (ippool) in requested url.
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    type: list

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

access_token:
    description: The token to access FortiManager without using username and password.
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    type: str

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    type: bool

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    type: int

firewall_ippool_dynamicmapping:
    description: The top level parameters set.
    required: false
    suboptions:
      _scope:
        description: No description.
        elements: dict
        suboptions:
          name:
            description: No description.
            type: str
          vdom:
            description: No description.
            type: str
        type: list
      add-nat64-route:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to add_nat64_route. Enable/disable adding
          NAT64 route.
        type: str
      arp-intf:
        description: Deprecated, please rename it to arp_intf.
        type: str
      arp-reply:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to arp_reply.
        type: str
      associated-interface:
        description: Deprecated, please rename it to associated_interface.
        type: str
      block-size:
        description: Deprecated, please rename it to block_size.
        type: int
      cgn-block-size:
        description: Deprecated, please rename it to cgn_block_size.
        type: int
      cgn-client-endip:
        description: Deprecated, please rename it to cgn_client_endip.
        type: str
      cgn-client-ipv6shift:
        description: Deprecated, please rename it to cgn_client_ipv6shift. IPv6 shift
          for fixed-allocation.
        type: int
      cgn-client-startip:
        description: Deprecated, please rename it to cgn_client_startip.
        type: str
      cgn-fixedalloc:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to cgn_fixedalloc.
        type: str
      cgn-overload:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to cgn_overload.
        type: str
      cgn-port-end:
        description: Deprecated, please rename it to cgn_port_end.
        type: int
      cgn-port-start:
        description: Deprecated, please rename it to cgn_port_start.
        type: int
      cgn-spa:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to cgn_spa.
        type: str
      comments:
        description: No description.
        type: str
      endip:
        description: No description.
        type: str
      endport:
        description: Final port number
        type: int
      exclude-ip:
        description: (list) Deprecated, please rename it to exclude_ip.
        type: raw
      nat64:
        choices:
        - disable
        - enable
        description: Enable/disable NAT64.
        type: str
      num-blocks-per-user:
        description: Deprecated, please rename it to num_blocks_per_user.
        type: int
      pba-timeout:
        description: Deprecated, please rename it to pba_timeout.
        type: int
      permit-any-host:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to permit_any_host.
        type: str
      port-per-user:
        description: Deprecated, please rename it to port_per_user. Number of port for
          each user
        type: int
      source-endip:
        description: Deprecated, please rename it to source_endip.
        type: str
      source-startip:
        description: Deprecated, please rename it to source_startip.
        type: str
      startip:
        description: No description.
        type: str
      startport:
        description: First port number
        type: int
      subnet-broadcast-in-ippool:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to subnet_broadcast_in_ippool. Enable/disable
          inclusion of the subnetwork address and broadca...
        type: str
      type:
        choices:
        - overload
        - one-to-one
        - fixed-port-range
        - port-block-allocation
        - cgn-resource-allocation
        description: No description.
        type: str
      utilization-alarm-clear:
        description: Deprecated, please rename it to utilization_alarm_clear.
        type: int
      utilization-alarm-raise:
        description: Deprecated, please rename it to utilization_alarm_raise.
        type: int
    type: dict

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list