fortinet.fortimanager.fmgr_pkg_firewall_multicastpolicy – Configure multicast NAT policies.

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_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		Choices/Defaults	Comments
adom string / required			the parameter (adom) in requested url
bypass_validation boolean		Choices: no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
pkg string / required			the parameter (pkg) in requested url
pkg_firewall_multicastpolicy dictionary			the top level parameters set
	action string	Choices: deny accept	Accept or deny traffic matching the policy.
	auto-asic-offload string	Choices: disable enable	Enable/disable offloading policy traffic for hardware acceleration.
	dnat string		IPv4 DNAT address used for multicast destination addresses.
	dstaddr string		Destination address objects.
	dstintf string		Destination interface name.
	end-port integer		Integer value for ending TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
	id integer		Policy ID.
	logtraffic string	Choices: disable enable	Enable/disable logging traffic accepted by this policy.
	protocol integer		Integer value for the protocol type as defined by IANA (0 - 255, default = 0).
	snat string	Choices: disable enable	Enable/disable substitution of the outgoing interface IP address for the original source IP address (called source NAT or SNAT).
	snat-ip string		IPv4 address to be used as the source address for NATed traffic.
	srcaddr string		Source address objects.
	srcintf string		Source interface name.
	start-port integer		Integer value for starting TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
	status string	Choices: disable enable	Enable/disable this policy.
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		Choices: 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 multicast NAT policies.
     fmgr_pkg_firewall_multicastpolicy:
        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>
        pkg: <your own value>
        state: <value in [present, absent]>
        pkg_firewall_multicastpolicy:
           action: <value in [deny, accept]>
           auto-asic-offload: <value in [disable, enable]>
           dnat: <value of string>
           dstaddr: <value of string>
           dstintf: <value of string>
           end-port: <value of integer>
           id: <value of integer>
           logtraffic: <value in [disable, enable]>
           protocol: <value of integer>
           snat: <value in [disable, enable]>
           snat-ip: <value of string>
           srcaddr: <value of string>
           srcintf: <value of string>
           start-port: <value of integer>
           status: <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_pkg_firewall_multicastpolicy_module.html

Docs

Docs4dev

Title here