fortinet.fortimanager.fmgr_firewall_vip6_dynamicmapping module – Configure virtual IP for IPv6.
Note
This module is part of the fortinet.fortimanager collection (version 2.1.5).
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_vip6_dynamicmapping.
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 top level parameters set |
|
no description |
|
Name. |
|
Vdom. |
|
Enable to respond to ARP requests for this virtual IP address. Enabled by default. Choices:
|
|
Color of icon on the GUI. |
|
Comment. |
|
IP address or address range on the external interface that you want to map to an address or address range on the destination n… |
|
Incoming port number range that you want to map to a port number range on the destination network. |
|
Time in minutes that client web browsers should keep a cookie. Default is 60 seconds. 0 = no time limit. |
|
Domain that HTTP cookie persistence should apply to. |
|
Enable/disable use of HTTP cookie domain from host field in HTTP. Choices:
|
|
Generation of HTTP cookie to be accepted. Changing invalidates all existing cookies. |
|
Limit HTTP cookie persistence to the specified path. |
|
Control sharing of cookies across virtual servers. same-ip means a cookie from one virtual server can be used by another. Disa… Choices:
|
|
For HTTP multiplexing, enable to add the original client IP address in the XForwarded-For HTTP header. Choices:
|
|
For HTTP multiplexing, enter a custom HTTPS header name. The original client IP address is added to this header. If empty, X-F… |
|
Enable/disable HTTP multiplexing. Choices:
|
|
Enable/disable redirection of HTTP to HTTPS Choices:
|
|
Enable/disable verification that inserted HTTPS cookies are secure. Choices:
|
|
Custom defined ID. |
|
Method used to distribute sessions to real servers. Choices:
|
|
Mapped IP address range in the format startIP-endIP. |
|
Port number range on the destination network to which the external port number range is mapped. |
|
Maximum number of incomplete connections. |
|
Name of the health check monitor to use when polling to determine a virtual servers connectivity status. |
|
Nat-Source-Vip. Choices:
|
|
Enable to add the Front-End-Https header for Microsoft Outlook Web Access. Choices:
|
|
Configure how to make sure that clients connect to the same server every time they make a request that is part of the same ses… Choices:
|
|
Enable port forwarding. Choices:
|
|
Protocol to use when forwarding packets. Choices:
|
|
Protocol to be load balanced by the virtual server (also called the server load balance virtual IP). Choices:
|
|
no description |
|
Permitted encryption algorithms for SSL sessions according to encryption strength. Choices:
|
|
The name of the SSL certificate to use for SSL acceleration. |
|
Enable/disable support for preventing Downgrade Attacks on client connections (RFC 7507). Choices:
|
|
Maximum length of data in MB before triggering a client rekey (0 = disable). |
|
Allow, deny, or require secure renegotiation of client sessions to comply with RFC 5746. Choices:
|
|
Maximum number of client to FortiGate SSL session states to keep. |
|
Number of minutes to keep client to FortiGate SSL session state. |
|
How to expire SSL sessions for the segment of the SSL connection between the client and the FortiGate. Choices:
|
|
Number of bits to use in the Diffie-Hellman exchange for RSA encryption of SSL sessions. Choices:
|
|
Enable/disable including HPKP header in response. Choices:
|
|
Number of minutes the web browser should keep HPKP. |
|
Certificate to generate backup HPKP pin from. |
|
Indicate that HPKP header applies to all subdomains. Choices:
|
|
Certificate to generate primary HPKP pin from. |
|
URL to report HPKP violations to. |
|
Enable/disable including HSTS header in response. Choices:
|
|
Number of seconds the client should honour the HSTS setting. |
|
Indicate that HSTS header applies to all subdomains. Choices:
|
|
Enable to replace HTTP with HTTPS in the replys Location HTTP header field. Choices:
|
|
Enable/disable HTTP host matching for location conversion. Choices:
|
|
Highest SSL/TLS version acceptable from a client. Choices:
|
|
Lowest SSL/TLS version acceptable from a client. Choices:
|
|
Apply SSL offloading between the client and the FortiGate (half) or from the client to the FortiGate and from the FortiGate to… Choices:
|
|
Select the cipher suites that can be used for SSL perfect forward secrecy (PFS). Applies to both client and server sessions. Choices:
|
|
Enable/disable sending empty fragments to avoid CBC IV attacks (SSL 3.0 & TLS 1.0 only). May need to be disabled for compatibi… Choices:
|
|
Permitted encryption algorithms for the server side of SSL full mode sessions according to encryption strength. Choices:
|
|
Highest SSL/TLS version acceptable from a server. Use the client setting by default. Choices:
|
|
Lowest SSL/TLS version acceptable from a server. Use the client setting by default. Choices:
|
|
Maximum number of FortiGate to Server SSL session states to keep. |
|
Number of minutes to keep FortiGate to Server SSL session state. |
|
How to expire SSL sessions for the segment of the SSL connection between the server and the FortiGate. Choices:
|
|
Configure a static NAT or server load balance VIP. Choices:
|
|
Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
|
Enable to add an HTTP header to indicate SSL offloading for a WebLogic server. Choices:
|
|
Enable to add an HTTP header to indicate SSL offloading for a WebSphere server. Choices:
|
|
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 parameter (vip6) in requested url |
|
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
- 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 dynamic mappings of virtual IP for IPv6
fmgr_firewall_vip6_dynamicmapping:
bypass_validation: False
adom: ansible
vip6: 'ansible-test-vip6' # name
state: present
firewall_vip6_dynamicmapping:
_scope:
-
name: FGT_AWS # need a valid device name
vdom: root # need a valid vdom name under the device
arp-reply: disable
color: 1
comment: 'ansible-comment'
id: 1
- 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 dynamic mappings of virtual IP for IPv6
fmgr_fact:
facts:
selector: 'firewall_vip6_dynamicmapping'
params:
adom: 'ansible'
vip6: 'ansible-test-vip6' # name
dynamic_mapping: ''
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)