fortinet.fortimanager.fmgr_firewall_vip module – Configure virtual IP for IPv4.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.0).
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_vip
.
New in fortinet.fortimanager 1.0.0
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 token to access FortiManager without using username and password. |
|
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. |
|
Deprecated, please rename it to add_nat46_route. Enable/disable adding NAT46 route. Choices:
|
|
Deprecated, please rename it to arp_reply. Enable to respond to ARP requests for this virtual IP address. Choices:
|
|
Color of icon on the GUI. |
|
Comment. |
|
Deprecated, please rename it to dns_mapping_ttl. DNS mapping TTL |
|
Dynamic mapping. |
|
Scope. |
|
Name. |
|
Vdom. |
|
Deprecated, please rename it to add_nat46_route. Enable/disable adding NAT46 route. Choices:
|
|
Deprecated, please rename it to arp_reply. Arp reply. Choices:
|
|
Color. |
|
Comment. |
|
Deprecated, please rename it to dns_mapping_ttl. Dns mapping ttl. |
|
(list or str) Extaddr. |
|
Extintf. |
|
Extip. |
|
Extport. |
|
Deprecated, please rename it to gratuitous_arp_interval. Gratuitous arp interval. |
|
Deprecated, please rename it to gslb_domain_name. Domain to use when integrating with FortiGSLB. |
|
Deprecated, please rename it to gslb_hostname. Hostname to use within the configured FortiGSLB domain. |
|
Deprecated, please rename it to h2_support. Enable/disable HTTP2 support Choices:
|
|
Deprecated, please rename it to h3_support. Enable/disable HTTP3/QUIC support Choices:
|
|
Deprecated, please rename it to http_cookie_age. Http cookie age. |
|
Deprecated, please rename it to http_cookie_domain. Http cookie domain. |
|
Deprecated, please rename it to http_cookie_domain_from_host. Http cookie domain from host. Choices:
|
|
Deprecated, please rename it to http_cookie_generation. Http cookie generation. |
|
Deprecated, please rename it to http_cookie_path. Http cookie path. |
|
Deprecated, please rename it to http_cookie_share. Http cookie share. Choices:
|
|
Deprecated, please rename it to http_ip_header. Http ip header. Choices:
|
|
Deprecated, please rename it to http_ip_header_name. Http ip header name. |
|
Deprecated, please rename it to http_multiplex. Http multiplex. Choices:
|
|
Deprecated, please rename it to http_multiplex_max_concurrent_request. Maximum number of concurrent requests that … |
|
Deprecated, please rename it to http_multiplex_max_request. Maximum number of requests that a multiplex server can… |
|
Deprecated, please rename it to http_multiplex_ttl. Time-to-live for idle connections to servers. |
|
Deprecated, please rename it to http_redirect. Http redirect. Choices:
|
|
Deprecated, please rename it to http_supported_max_version. Maximum supported HTTP versions. Choices:
|
|
Deprecated, please rename it to https_cookie_secure. Https cookie secure. Choices:
|
|
Id. |
|
Deprecated, please rename it to ipv6_mappedip. Range of mapped IPv6 addresses. |
|
Deprecated, please rename it to ipv6_mappedport. IPv6 port number range on the destination network to which the ex… |
|
Deprecated, please rename it to ldb_method. Ldb method. Choices:
|
|
Deprecated, please rename it to mapped_addr. Mapped addr. |
|
(list) Mappedip. |
|
Mappedport. |
|
Deprecated, please rename it to max_embryonic_connections. Max embryonic connections. |
|
(list or str) Monitor. |
|
Deprecated, please rename it to nat_source_vip. Nat source vip. Choices:
|
|
Enable/disable NAT44. Choices:
|
|
Enable/disable NAT46. Choices:
|
|
Deprecated, please rename it to one_click_gslb_server. Enable/disable one click GSLB server integration with Forti… Choices:
|
|
Deprecated, please rename it to outlook_web_access. Outlook web access. Choices:
|
|
Persistence. Choices:
|
|
Portforward. Choices:
|
|
Deprecated, please rename it to portmapping_type. Portmapping type. Choices:
|
|
Protocol. Choices:
|
|
Realservers. |
|
Address. |
|
(list) Deprecated, please rename it to client_ip. Client ip. |
|
Deprecated, please rename it to health_check_proto. Health check proto. Choices:
|
|
Healthcheck. Choices:
|
|
Deprecated, please rename it to holddown_interval. Holddown interval. |
|
Deprecated, please rename it to http_host. Http host. |
|
Id. |
|
Ip. |
|
Deprecated, please rename it to max_connections. Max connections. |
|
(list or str) Monitor. |
|
Port. |
|
Seq. |
|
Status. Choices:
|
|
Deprecated, please rename it to translate_host. Enable/disable translation of hostname/IP from virtual ser… Choices:
|
|
Type. Choices:
|
|
Weight. |
|
Deprecated, please rename it to server_type. Server type. Choices:
|
|
(list or str) Service. |
|
(list) Deprecated, please rename it to src_filter. Src filter. |
|
Deprecated, please rename it to src_vip_filter. Enable/disable use of src-filter to match destinations for the rev… Choices:
|
|
(list) Deprecated, please rename it to srcintf_filter. Srcintf filter. |
|
Deprecated, please rename it to ssl_accept_ffdhe_groups. Enable/disable FFDHE cipher suite for SSL key exchange. Choices:
|
|
Deprecated, please rename it to ssl_algorithm. Ssl algorithm. Choices:
|
|
Deprecated, please rename it to ssl_certificate. Ssl certificate. |
|
Deprecated, please rename it to ssl_cipher_suites. Ssl cipher suites. |
|
Cipher. Choices:
|
|
Id. |
|
Priority. |
|
Versions. Choices:
|
|
Deprecated, please rename it to ssl_client_fallback. Ssl client fallback. Choices:
|
|
Deprecated, please rename it to ssl_client_rekey_count. Ssl client rekey count. |
|
Deprecated, please rename it to ssl_client_renegotiation. Ssl client renegotiation. Choices:
|
|
Deprecated, please rename it to ssl_client_session_state_max. Ssl client session state max. |
|
Deprecated, please rename it to ssl_client_session_state_timeout. Ssl client session state timeout. |
|
Deprecated, please rename it to ssl_client_session_state_type. Ssl client session state type. Choices:
|
|
Deprecated, please rename it to ssl_dh_bits. Ssl dh bits. Choices:
|
|
Deprecated, please rename it to ssl_hpkp. Ssl hpkp. Choices:
|
|
Deprecated, please rename it to ssl_hpkp_age. Ssl hpkp age. |
|
Deprecated, please rename it to ssl_hpkp_backup. Ssl hpkp backup. |
|
Deprecated, please rename it to ssl_hpkp_include_subdomains. Ssl hpkp include subdomains. Choices:
|
|
Deprecated, please rename it to ssl_hpkp_primary. Ssl hpkp primary. |
|
Deprecated, please rename it to ssl_hpkp_report_uri. Ssl hpkp report uri. |
|
Deprecated, please rename it to ssl_hsts. Ssl hsts. Choices:
|
|
Deprecated, please rename it to ssl_hsts_age. Ssl hsts age. |
|
Deprecated, please rename it to ssl_hsts_include_subdomains. Ssl hsts include subdomains. Choices:
|
|
Deprecated, please rename it to ssl_http_location_conversion. Ssl http location conversion. Choices:
|
|
Deprecated, please rename it to ssl_http_match_host. Ssl http match host. Choices:
|
|
Deprecated, please rename it to ssl_max_version. Ssl max version. Choices:
|
|
Deprecated, please rename it to ssl_min_version. Ssl min version. Choices:
|
|
Deprecated, please rename it to ssl_mode. Ssl mode. Choices:
|
|
Deprecated, please rename it to ssl_pfs. Ssl pfs. Choices:
|
|
Deprecated, please rename it to ssl_send_empty_frags. Ssl send empty frags. Choices:
|
|
Deprecated, please rename it to ssl_server_algorithm. Ssl server algorithm. Choices:
|
|
Deprecated, please rename it to ssl_server_max_version. Ssl server max version. Choices:
|
|
Deprecated, please rename it to ssl_server_min_version. Ssl server min version. Choices:
|
|
Deprecated, please rename it to ssl_server_renegotiation. Enable/disable secure renegotiation to comply with RFC 5746. Choices:
|
|
Deprecated, please rename it to ssl_server_session_state_max. Ssl server session state max. |
|
Deprecated, please rename it to ssl_server_session_state_timeout. Ssl server session state timeout. |
|
Deprecated, please rename it to ssl_server_session_state_type. Ssl server session state type. Choices:
|
|
Enable/disable VIP. Choices:
|
|
Type. Choices:
|
|
Uuid. |
|
Deprecated, please rename it to weblogic_server. Weblogic server. Choices:
|
|
Deprecated, please rename it to websphere_server. Websphere server. Choices:
|
|
(list or str) External FQDN address name. |
|
Interface connected to the source network that receives the packets that will be forwarded to the destination network. |
|
IP address or address range on the external interface that you want to map to an address or address range on the destinati… |
|
Incoming port number range that you want to map to a port number range on the destination network. |
|
Deprecated, please rename it to gratuitous_arp_interval. Enable to have the VIP send gratuitous ARPs. |
|
Deprecated, please rename it to gslb_domain_name. Domain to use when integrating with FortiGSLB. |
|
Deprecated, please rename it to gslb_hostname. Hostname to use within the configured FortiGSLB domain. |
|
Deprecated, please rename it to gslb_public_ips. Gslb public ips. |
|
Index of this public IP setting. |
|
The publicly accessible IP address. |
|
Deprecated, please rename it to h2_support. Enable/disable HTTP2 support Choices:
|
|
Deprecated, please rename it to h3_support. Enable/disable HTTP3/QUIC support Choices:
|
|
Deprecated, please rename it to http_cookie_age. Time in minutes that client web browsers should keep a cookie. |
|
Deprecated, please rename it to http_cookie_domain. Domain that HTTP cookie persistence should apply to. |
|
Deprecated, please rename it to http_cookie_domain_from_host. Enable/disable use of HTTP cookie domain from host field in … Choices:
|
|
Deprecated, please rename it to http_cookie_generation. Generation of HTTP cookie to be accepted. |
|
Deprecated, please rename it to http_cookie_path. Limit HTTP cookie persistence to the specified path. |
|
Deprecated, please rename it to http_cookie_share. Control sharing of cookies across virtual servers. Choices:
|
|
Deprecated, please rename it to http_ip_header. For HTTP multiplexing, enable to add the original client IP address in the… Choices:
|
|
Deprecated, please rename it to http_ip_header_name. For HTTP multiplexing, enter a custom HTTPS header name. |
|
Deprecated, please rename it to http_multiplex. Enable/disable HTTP multiplexing. Choices:
|
|
Deprecated, please rename it to http_multiplex_max_concurrent_request. Maximum number of concurrent requests that a multip… |
|
Deprecated, please rename it to http_multiplex_max_request. Maximum number of requests that a multiplex server can handle … |
|
Deprecated, please rename it to http_multiplex_ttl. Time-to-live for idle connections to servers. |
|
Deprecated, please rename it to http_redirect. Enable/disable redirection of HTTP to HTTPS Choices:
|
|
Deprecated, please rename it to http_supported_max_version. Maximum supported HTTP versions. Choices:
|
|
Deprecated, please rename it to https_cookie_secure. Enable/disable verification that inserted HTTPS cookies are secure. Choices:
|
|
Custom defined ID. |
|
Deprecated, please rename it to ipv6_mappedip. Range of mapped IPv6 addresses. |
|
Deprecated, please rename it to ipv6_mappedport. IPv6 port number range on the destination network to which the external p… |
|
Deprecated, please rename it to ldb_method. Method used to distribute sessions to real servers. Choices:
|
|
Deprecated, please rename it to mapped_addr. Mapped FQDN address name. |
|
(list) IP address or address range on the destination network to which the external IP address is mapped. |
|
Port number range on the destination network to which the external port number range is mapped. |
|
Deprecated, please rename it to max_embryonic_connections. Maximum number of incomplete connections. |
|
(list or str) Name of the health check monitor to use when polling to determine a virtual servers connectivity status. |
|
Virtual IP name. |
|
Deprecated, please rename it to nat_source_vip. Enable/disable forcing the source NAT mapped IP to the external IP for all… Choices:
|
|
Enable/disable NAT44. Choices:
|
|
Enable/disable NAT46. Choices:
|
|
Deprecated, please rename it to one_click_gslb_server. Enable/disable one click GSLB server integration with FortiGSLB. Choices:
|
|
Deprecated, please rename it to outlook_web_access. 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… Choices:
|
|
Enable/disable port forwarding. Choices:
|
|
Deprecated, please rename it to portmapping_type. Port mapping type. Choices:
|
|
Protocol to use when forwarding packets. Choices:
|
|
Quic. |
|
Deprecated, please rename it to ack_delay_exponent. ACK delay exponent |
|
Deprecated, please rename it to active_connection_id_limit. Active connection ID limit |
|
Deprecated, please rename it to active_migration. Enable/disable active migration Choices:
|
|
Deprecated, please rename it to grease_quic_bit. Enable/disable grease QUIC bit Choices:
|
|
Deprecated, please rename it to max_ack_delay. Maximum ACK delay in milliseconds |
|
Deprecated, please rename it to max_datagram_frame_size. Maximum datagram frame size in bytes |
|
Deprecated, please rename it to max_idle_timeout. Maximum idle timeout milliseconds |
|
Deprecated, please rename it to max_udp_payload_size. Maximum UDP payload size in bytes |
|
Realservers. |
|
Dynamic address of the real server. |
|
(list) Deprecated, please rename it to client_ip. Only clients in this IP range can connect to this real server. |
|
Enable to check the responsiveness of the real server before forwarding traffic. Choices:
|
|
Deprecated, please rename it to holddown_interval. Time in seconds that the health check monitor continues to moni… |
|
Deprecated, please rename it to http_host. HTTP server domain name in HTTP header. |
|
Real server ID. |
|
IP address of the real server. |
|
Deprecated, please rename it to max_connections. Max number of active connections that can be directed to the real… |
|
(list or str) Name of the health check monitor to use when polling to determine a virtual servers connectivity status. |
|
Port for communicating with the real server. |
|
Seq. |
|
Set the status of the real server to active so that it can accept traffic, or on standby or disabled so no traffic… Choices:
|
|
Deprecated, please rename it to translate_host. Enable/disable translation of hostname/IP from virtual server to r… Choices:
|
|
Type of address. Choices:
|
|
Weight of the real server. |
|
Deprecated, please rename it to server_type. Protocol to be load balanced by the virtual server Choices:
|
|
(list or str) Service name. |
|
(list) Deprecated, please rename it to src_filter. Source address filter. |
|
Deprecated, please rename it to src_vip_filter. Enable/disable use of src-filter to match destinations for the reverse SNA… Choices:
|
|
(list or str) Deprecated, please rename it to srcintf_filter. Interfaces to which the VIP applies. |
|
Deprecated, please rename it to ssl_accept_ffdhe_groups. Enable/disable FFDHE cipher suite for SSL key exchange. Choices:
|
|
Deprecated, please rename it to ssl_algorithm. Permitted encryption algorithms for SSL sessions according to encryption st… Choices:
|
|
Deprecated, please rename it to ssl_certificate. The name of the SSL certificate to use for SSL acceleration. |
|
Deprecated, please rename it to ssl_cipher_suites. Ssl cipher suites. |
|
Cipher suite name. Choices:
|
|
Id. |
|
SSL/TLS cipher suites priority. |
|
SSL/TLS versions that the cipher suite can be used with. Choices:
|
|
Deprecated, please rename it to ssl_client_fallback. Enable/disable support for preventing Downgrade Attacks on client con… Choices:
|
|
Deprecated, please rename it to ssl_client_rekey_count. Maximum length of data in MB before triggering a client rekey |
|
Deprecated, please rename it to ssl_client_renegotiation. Allow, deny, or require secure renegotiation of client sessions … Choices:
|
|
Deprecated, please rename it to ssl_client_session_state_max. Maximum number of client to FortiGate SSL session states to … |
|
Deprecated, please rename it to ssl_client_session_state_timeout. Number of minutes to keep client to FortiGate SSL sessio… |
|
Deprecated, please rename it to ssl_client_session_state_type. How to expire SSL sessions for the segment of the SSL conne… Choices:
|
|
Deprecated, please rename it to ssl_dh_bits. Number of bits to use in the Diffie-Hellman exchange for RSA encryption of SS… Choices:
|
|
Deprecated, please rename it to ssl_hpkp. Enable/disable including HPKP header in response. Choices:
|
|
Deprecated, please rename it to ssl_hpkp_age. Number of seconds the client should honour the HPKP setting. |
|
Deprecated, please rename it to ssl_hpkp_backup. Certificate to generate backup HPKP pin from. |
|
Deprecated, please rename it to ssl_hpkp_include_subdomains. Indicate that HPKP header applies to all subdomains. Choices:
|
|
Deprecated, please rename it to ssl_hpkp_primary. Certificate to generate primary HPKP pin from. |
|
Deprecated, please rename it to ssl_hpkp_report_uri. URL to report HPKP violations to. |
|
Deprecated, please rename it to ssl_hsts. Enable/disable including HSTS header in response. Choices:
|
|
Deprecated, please rename it to ssl_hsts_age. Number of seconds the client should honour the HSTS setting. |
|
Deprecated, please rename it to ssl_hsts_include_subdomains. Indicate that HSTS header applies to all subdomains. Choices:
|
|
Deprecated, please rename it to ssl_http_location_conversion. Enable to replace HTTP with HTTPS in the replys Location HTT… Choices:
|
|
Deprecated, please rename it to ssl_http_match_host. Enable/disable HTTP host matching for location conversion. Choices:
|
|
Deprecated, please rename it to ssl_max_version. Highest SSL/TLS version acceptable from a client. Choices:
|
|
Deprecated, please rename it to ssl_min_version. Lowest SSL/TLS version acceptable from a client. Choices:
|
|
Deprecated, please rename it to ssl_mode. Apply SSL offloading between the client and the FortiGate Choices:
|
|
Deprecated, please rename it to ssl_pfs. Select the cipher suites that can be used for SSL perfect forward secrecy Choices:
|
|
Deprecated, please rename it to ssl_send_empty_frags. Enable/disable sending empty fragments to avoid CBC IV attacks Choices:
|
|
Deprecated, please rename it to ssl_server_algorithm. Permitted encryption algorithms for the server side of SSL full mode… Choices:
|
|
Deprecated, please rename it to ssl_server_cipher_suites. Ssl server cipher suites. |
|
Cipher suite name. Choices:
|
|
SSL/TLS cipher suites priority. |
|
SSL/TLS versions that the cipher suite can be used with. Choices:
|
|
Deprecated, please rename it to ssl_server_max_version. Highest SSL/TLS version acceptable from a server. Choices:
|
|
Deprecated, please rename it to ssl_server_min_version. Lowest SSL/TLS version acceptable from a server. Choices:
|
|
Deprecated, please rename it to ssl_server_renegotiation. Enable/disable secure renegotiation to comply with RFC 5746. Choices:
|
|
Deprecated, please rename it to ssl_server_session_state_max. Maximum number of FortiGate to Server SSL session states to … |
|
Deprecated, please rename it to ssl_server_session_state_timeout. Number of minutes to keep FortiGate to Server SSL sessio… |
|
Deprecated, please rename it to ssl_server_session_state_type. How to expire SSL sessions for the segment of the SSL conne… Choices:
|
|
Enable/disable VIP. Choices:
|
|
Configure a static NAT, load balance, DNS translation, or FQDN VIP. Choices:
|
|
Universally Unique Identifier |
|
Deprecated, please rename it to weblogic_server. Enable to add an HTTP header to indicate SSL offloading for a WebLogic se… Choices:
|
|
Deprecated, please rename it to websphere_server. Enable to add an HTTP header to indicate SSL offloading for a WebSphere … Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
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: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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: Demo of cloning objects in FortiManager
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
initial_vip_object: "vip_object0"
cloned_vip_objects:
- name: "vip_object1"
comment: "vip_object1 is cloned!"
- name: "vip_object2"
comment: "vip_object2 is cloned!"
tasks:
- name: Create An VIP object
fortinet.fortimanager.fmgr_firewall_vip:
adom: "root"
state: "present"
firewall_vip:
arp-reply: "disable"
comment: "The VIP is created via Ansible"
name: "{{ initial_vip_object }}"
protocol: "tcp"
type: "load-balance"
- name: Clone an VIP object using fmgr_clone module.
fortinet.fortimanager.fmgr_clone:
rc_succeeded: [-2]
clone:
selector: "firewall_vip"
self:
adom: "root"
vip: "{{ initial_vip_object }}"
target:
name: "{{ item.name }}"
comment: "{{ item.comment }}"
with_items: "{{ cloned_vip_objects }}"
- name: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure virtual IP for IPv4.
fortinet.fortimanager.fmgr_firewall_vip:
bypass_validation: true
adom: ansible
state: present
firewall_vip:
arp-reply: disable # <value in [disable, enable]>
color: 1
comment: "ansible-comment"
id: 1
name: "ansible-test-vip"
protocol: tcp # <value in [tcp, udp, sctp, ...]>
type: load-balance # <value in [static-nat, load-balance, server-load-balance, ...]>
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the virtual IPs for IPv4
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_vip"
params:
adom: "ansible"
vip: "your_value"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |