fortinet.fortimanager.fmgr_pkg_firewall_multicastpolicy – Configure multicast NAT policies.
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_pkg_firewall_multicastpolicy
.
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 |
---|---|
the parameter (adom) in requested url |
|
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters Choices:
|
|
Enable/Disable logging for task Choices:
|
|
the parameter (pkg) in requested url |
|
the top level parameters set |
|
Accept or deny traffic matching the policy. Choices:
|
|
Enable/disable offloading policy traffic for hardware acceleration. Choices:
|
|
Comment. |
|
IPv4 DNAT address used for multicast destination addresses. |
|
Destination address objects. |
|
Destination interface name. |
|
Integer value for ending TCP/UDP/SCTP destination port in range (1 - 65535, default = 1). |
|
Policy ID. |
|
Enable/disable logging traffic accepted by this policy. Choices:
|
|
Policy name. |
|
Integer value for the protocol type as defined by IANA (0 - 255, default = 0). |
|
Enable/disable substitution of the outgoing interface IP address for the original source IP address (called source NAT or SNAT). Choices:
|
|
IPv4 address to be used as the source address for NATed traffic. |
|
Source address objects. |
|
Source interface name. |
|
Integer value for starting TCP/UDP/SCTP destination port in range (1 - 65535, default = 1). |
|
Enable/disable this policy. Choices:
|
|
Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
|
The overridden method for the underlying Json RPC request Choices:
|
|
the rc codes list with which the conditions to fail will be overriden |
|
the rc codes list with which the conditions to succeed will be overriden |
|
the directive to create, update or delete an object Choices:
|
|
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
|
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
- 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 multicast NAT policies
fmgr_fact:
facts:
selector: 'pkg_firewall_multicastpolicy'
params:
adom: 'ansible'
pkg: 'ansible' # package name
multicast-policy: ''
- 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 NAT policies.
fmgr_pkg_firewall_multicastpolicy:
bypass_validation: False
adom: ansible
pkg: ansible # package name
state: present
pkg_firewall_multicastpolicy:
action: accept #<value in [deny, accept]>
dstaddr: all
dstintf: any
id: 2
srcaddr: all
srcintf: any
status: disable
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The full url requested Returned: always Sample: “/sys/login/user” |
|
The status of api request Returned: always Sample: 0 |
|
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)