community.general.fmgr_fwobj_ippool6 (0.1.1) — module

Allows the editing of IP Pool Objects within FortiManager.

Authors: Luke Weighall (@lweighall), Andrew Welsh (@Ghilli3), Jim Huber (@p4r4n0y1ng)

preview | supported by community

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1


Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

Allows users to add/edit/delete IPv6 Pool Objects.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: ADD FMGR_FIREWALL_IPPOOL6
  fmgr_firewall_ippool6:
    mode: "add"
    adom: "ansible"
    startip:
    name: "IPv6 IPPool"
    endip:
    comments: "Created by Ansible"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: DELETE FMGR_FIREWALL_IPPOOL6
  fmgr_firewall_ippool6:
    mode: "delete"
    adom: "ansible"
    name: "IPv6 IPPool"

Inputs

    
adom:
    default: root
    description:
    - The ADOM the configuration should belong to.
    required: false

mode:
    choices:
    - add
    - set
    - delete
    - update
    default: add
    description:
    - Sets one of three modes for managing the object.
    - Allows use of soft-adds instead of overwriting existing values
    required: false

name:
    description:
    - IPv6 IP pool name.
    required: false

endip:
    description:
    - Final IPv6 address (inclusive) in the range for the address pool.
    required: false

startip:
    description:
    - First IPv6 address (inclusive) in the range for the address pool.
    required: false

comments:
    description:
    - Comment.
    required: false

dynamic_mapping:
    description:
    - EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED!
    - List of multiple child objects to be added. Expects a list of dictionaries.
    - Dictionaries must use FortiManager API parameters, not the ansible ones listed below.
    - If submitted, all other prefixed sub-parameters ARE IGNORED.
    - This object is MUTUALLY EXCLUSIVE with its options.
    - We expect that you know what you are doing with these list parameters, and are leveraging
      the JSON API Guide.
    - WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE
      TASKS
    required: false

dynamic_mapping_endip:
    description:
    - Dynamic Mapping clone of original suffixed parameter.
    required: false

dynamic_mapping_startip:
    description:
    - Dynamic Mapping clone of original suffixed parameter.
    required: false

dynamic_mapping_comments:
    description:
    - Dynamic Mapping clone of original suffixed parameter.
    required: false

Outputs

api_result:
  description: full API response, includes status code and message
  returned: always
  type: str