fortinet.fortimanager.fmgr_firewall_multicastaddress – Configure multicast addresses.

Note

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

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

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

Comments

adom

string / required

the parameter (adom) in requested url

bypass_validation

boolean

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

Choices:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

firewall_multicastaddress

dictionary

the top level parameters set

associated-interface

string

Interface associated with the address object. When setting up a policy, only addresses associated with this interface are avai…

color

integer

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

comment

string

Comment.

end-ip

string

Final IPv4 address (inclusive) in the range for the address.

name

string

Multicast address name.

start-ip

string

First IPv4 address (inclusive) in the range for the address.

subnet

string

Broadcast address and subnet.

tagging

list / elements=string

Tagging.

category

string

Tag category.

name

string

Tagging entry name.

tags

string

Tags.

type

string

Type of address object: multicast IP address range or broadcast IP/mask to be treated as a multicast address.

Choices:

  • multicastrange

  • broadcastmask

visibility

string

Enable/disable visibility of the multicast address on the GUI.

Choices:

  • disable

  • enable

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

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

the directive to create, update or delete an object

Choices:

  • present

  • absent

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

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

Default: 300

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: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure multicast addresses.
     fmgr_firewall_multicastaddress:
        bypass_validation: False
        adom: ansible
        state: present
        firewall_multicastaddress:
           color: 0
           comment: 'ansible-comment'
           name: 'ansible-test'
           subnet: '222.222.221.0/24'
           type: broadcastmask #<value in [multicastrange, broadcastmask]>
           visibility: disable
- name: gathering fortimanager facts
  hosts: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the IPv4 multicast addresses
     fmgr_fact:
       facts:
           selector: 'firewall_multicastaddress'
           params:
               adom: 'ansible'
               multicast-address: ''

Return Values

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

Key

Description

request_url

string

The full url requested

Returned: always

Sample: “/sys/login/user”

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)