fortinet.fortimanager.fmgr_firewall_addrgrp6 (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 IPv6 address groups.
      fortinet.fortimanager.fmgr_firewall_addrgrp6:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_addrgrp6:
          color: 0
          comment: "ansible-comment"
          member: "ansible-test" # IPv6 address name
          name: "ansible-addrgrp6" # could not the same with other group, adress name, including IPv4 group and address
          visibility: enable

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 IPv6 address groups
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_addrgrp6"
          params:
            adom: "ansible"
            addrgrp6: "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

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

firewall_addrgrp6:
    description: The top level parameters set.
    required: false
    suboptions:
      _image-base64:
        description: Deprecated, please rename it to _image_base64. _Image-Base64.
        type: str
      color:
        description: Integer value to determine the color of the icon in the GUI
        type: int
      comment:
        description: Comment.
        type: str
      dynamic_mapping:
        description: Dynamic_Mapping.
        elements: dict
        suboptions:
          _image-base64:
            description: Deprecated, please rename it to _image_base64. _Image-Base64.
            type: str
          _scope:
            description: _Scope.
            elements: dict
            suboptions:
              name:
                description: Name.
                type: str
              vdom:
                description: Vdom.
                type: str
            type: list
          color:
            description: Integer value to determine the color of the icon in the GUI
            type: int
          comment:
            description: Comment.
            type: str
          exclude:
            choices:
            - disable
            - enable
            description: Enable/disable address6 exclusion.
            type: str
          exclude-member:
            description: (list) Deprecated, please rename it to exclude_member.
            type: raw
          fabric-object:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to fabric_object. Security Fabric
              global object setting.
            type: str
          global-object:
            description: Deprecated, please rename it to global_object. Global-Object.
            type: int
          member:
            description: (list or str) Address objects contained within the group.
            type: raw
          tags:
            description: (list or str) Tags.
            type: raw
          uuid:
            description: Universally Unique Identifier
            type: str
          visibility:
            choices:
            - disable
            - enable
            description: Enable/disable address group6 visibility in the GUI.
            type: str
        type: list
      exclude:
        choices:
        - disable
        - enable
        description: Enable/disable address6 exclusion.
        type: str
      exclude-member:
        description: (list) Deprecated, please rename it to exclude_member.
        type: raw
      fabric-object:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to fabric_object. Security Fabric global
          object setting.
        type: str
      global-object:
        description: Deprecated, please rename it to global_object. Global Object.
        type: int
      member:
        description: (list or str) Address objects contained within the group.
        type: raw
      name:
        description: IPv6 address group name.
        required: true
        type: str
      tagging:
        description: Tagging.
        elements: dict
        suboptions:
          category:
            description: Tag category.
            type: str
          name:
            description: Tagging entry name.
            type: str
          tags:
            description: (list) Tags.
            type: raw
        type: list
      tags:
        description: Names of object-tags applied to address.
        type: str
      uuid:
        description: Universally Unique Identifier
        type: str
      visibility:
        choices:
        - disable
        - enable
        description: Enable/disable address group6 visibility in the GUI.
        type: str
    type: dict

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

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