fortinet.fortimanager.fmgr_firewall_addrgrp6 – Configure IPv6 address groups.

From Get docs
Ansible/docs/2.11/collections/fortinet/fortimanager/fmgr firewall addrgrp6 module


fortinet.fortimanager.fmgr_firewall_addrgrp6 – Configure IPv6 address groups.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_firewall_addrgrp6.


New in version 2.10: of fortinet.fortimanager


Synopsis

  • 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.

Parameters

Parameter Choices/Defaults Comments

adom

string / required

the parameter (adom) in requested url

bypass_validation

boolean

  • no

  • yes

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

firewall_addrgrp6

dictionary

the top level parameters set

color

integer

Integer value to determine the color of the icon in the GUI (1 - 32, default = 0, which sets the value to 1).

comment

string

Comment.

dynamic_mapping

list / elements=string

no description

_scope

list / elements=string

no description

name

string

no description

vdom

string

no description

color

integer

no description

comment

string

no description

member

string

no description

tags

string

no description

uuid

string

no description

visibility

string

  • disable
  • enable

no description

member

string

Address objects contained within the group.

name

string

IPv6 address group name.

tagging

list / elements=string

no description

category

string

Tag category.

name

string

Tagging entry name.

tags

string

no description

uuid

string

Universally Unique Identifier (UUID; automatically assigned but can be manually reset).

visibility

string

  • disable
  • enable

Enable/disable address group6 visibility in the GUI.

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

the rc codes list with which the conditions to succeed will be overriden

state

string / required

  • present
  • absent

the directive to create, update or delete an object

workspace_locking_adom

string

the adom to lock for FortiManager running in workspace mode, the value can be global and others including root

workspace_locking_timeout

integer

Default:

300

the maximum time in seconds to wait for other user to release the workspace lock



Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
  • To create or update an object, use state present directive.
  • To delete an object, use state absent directive.
  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded


Examples

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure IPv6 address groups.
     fmgr_firewall_addrgrp6:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        firewall_addrgrp6:
           color: <value of integer>
           comment: <value of string>
           dynamic_mapping:
             -
                 _scope:
                   -
                       name: <value of string>
                       vdom: <value of string>
                 color: <value of integer>
                 comment: <value of string>
                 member: <value of string>
                 tags: <value of string>
                 uuid: <value of string>
                 visibility: <value in [disable, enable]>
           member: <value of string>
           name: <value of string>
           tagging:
             -
                 category: <value of string>
                 name: <value of string>
                 tags: <value of string>
           uuid: <value of string>
           visibility: <value in [disable, enable]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description

request_url

string

always

The full url requested


Sample:

/sys/login/user

response_code

integer

always

The status of api request


response_message

string

always

The descriptive message of the api response


Sample:

OK.




Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_firewall_addrgrp6_module.html