fortinet.fortios.fortios_firewall_multicast_address – Configure multicast addresses in Fortinet’s FortiOS and FortiGate.
fortinet.fortios.fortios_firewall_multicast_address – Configure multicast addresses in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 1.1.8).
To install it use: ansible-galaxy collection install fortinet.fortios
.
To use it in a playbook, specify: fortinet.fortios.fortios_firewall_multicast_address
.
New in version 2.8: of fortinet.fortios
Synopsis
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and multicast_address category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters
Parameter | Choices/Defaults | Comments | |||
---|---|---|---|---|---|
access_token string |
Token-based authentication. Generated from GUI of Fortigate. | ||||
firewall_multicast_address dictionary |
Configure multicast addresses. | ||||
associated_interface string |
Interface associated with the address object. When setting up a policy, only addresses associated with this interface are available. Source system.interface.name. | ||||
color integer |
Integer value to determine the color of the icon in the GUI (1 - 32). | ||||
comment string |
Comment. | ||||
end_ip string |
Final IPv4 address (inclusive) in the range for the address. | ||||
name string / required |
Multicast address name. | ||||
start_ip string |
First IPv4 address (inclusive) in the range for the address. | ||||
state string |
|
Deprecated Starting with Ansible 2.9 we recommend using the top-level 'state' parameter. Indicates whether to create or remove the object. | |||
subnet string |
Broadcast address and subnet. | ||||
tagging list / elements=string |
Config object tagging. | ||||
category string |
Tag category. Source system.object-tagging.category. | ||||
name string / required |
Tagging entry name. | ||||
tags list / elements=string |
Tags. | ||||
name string / required |
Tag name. Source system.object-tagging.tags.name. | ||||
type string |
|
Type of address object: multicast IP address range or broadcast IP/mask to be treated as a multicast address. | |||
visibility string |
|
Enable/disable visibility of the multicast address on the GUI. | |||
state string added in 2.9 of fortinet.fortios |
|
Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level. | |||
vdom string |
Default: "root" |
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. |
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure multicast addresses.
fortios_firewall_multicast_address:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_multicast_address:
associated_interface: "<your_own_value> (source system.interface.name)"
color: "4"
comment: "Comment."
end_ip: "<your_own_value>"
name: "default_name_7"
start_ip: "<your_own_value>"
subnet: "<your_own_value>"
tagging:
-
category: "<your_own_value> (source system.object-tagging.category)"
name: "default_name_12"
tags:
-
name: "default_name_14 (source system.object-tagging.tags.name)"
type: "multicastrange"
visibility: "enable"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
build string |
always |
Build number of the fortigate image
Sample: 1547 |
http_method string |
always |
Last method used to provision the content into FortiGate
Sample: PUT |
http_status string |
always |
Last result given by FortiGate on last operation applied
Sample: 200 |
mkey string |
success |
Master key (id) used in the last call to FortiGate
Sample: id |
name string |
always |
Name of the table used to fulfill the request
Sample: urlfilter |
path string |
always |
Path of the table used to fulfill the request
Sample: webfilter |
revision string |
always |
Internal revision number
Sample: 17.0.2.10658 |
serial string |
always |
Serial number of the unit
Sample: FGVMEVYYQT3AB5352 |
status string |
always |
Indication of the operation's result
Sample: success |
vdom string |
always |
Virtual domain used
Sample: root |
version string |
always |
Version of the FortiGate
Sample: v5.6.3 |
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 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/fortios/fortios_firewall_multicast_address_module.html