fmgr_firewall_vip_dynamicmapping – Configure virtual IP for IPv4.¶
New in version 2.0.0.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.x and v7.x.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.0.0 |
||||||||||||
| True | ||||||||||||
6.2.0 |
6.2.1 |
6.2.2 |
6.2.3 |
6.2.5 |
6.2.6 |
6.2.7 |
6.2.8 |
6.2.9 |
6.2.10 |
6.2.11 |
||
| True | True | True | True | True | True | True | True | True | True | True | ||
6.4.0 |
6.4.1 |
6.4.2 |
6.4.3 |
6.4.4 |
6.4.5 |
6.4.6 |
6.4.7 |
6.4.8 |
6.4.9 |
6.4.10 |
6.4.11 |
6.4.12 |
| True | True | True | True | True | True | True | True | True | True | True | True | True |
7.0.0 |
7.0.1 |
7.0.2 |
7.0.3 |
7.0.4 |
7.0.5 |
7.0.6 |
7.0.7 |
7.0.8 |
||||
| True | True | True | True | True | True | True | True | True | ||||
7.2.0 |
7.2.1 |
7.2.2 |
7.2.3 |
|||||||||
| True | True | True | True | |||||||||
7.4.0 |
||||||||||||
| True |
Parameters¶
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- adom - The parameter in requested url type: str required: true
- vip - The parameter in requested url type: str required: true
- firewall_vip_dynamicmapping - Configure virtual IP for IPv4. type: dict
- _scope - No description for the parameter type: array more...
- arp-reply - No description for the parameter type: str choices: [disable, enable] more...
- color - No description for the parameter type: int more...
- comment - No description for the parameter type: str more...
- dns-mapping-ttl - No description for the parameter type: int more...
- extaddr - No description for the parameter type: str more...
- extintf - No description for the parameter type: str more...
- extip - No description for the parameter type: str more...
- extport - No description for the parameter type: str more...
- gratuitous-arp-interval - No description for the parameter type: int more...
- http-cookie-age - No description for the parameter type: int more...
- http-cookie-domain - No description for the parameter type: str more...
- http-cookie-domain-from-host - No description for the parameter type: str choices: [disable, enable] more...
- http-cookie-generation - No description for the parameter type: int more...
- http-cookie-path - No description for the parameter type: str more...
- http-cookie-share - No description for the parameter type: str choices: [disable, same-ip] more...
- http-ip-header - No description for the parameter type: str choices: [disable, enable] more...
- http-ip-header-name - No description for the parameter type: str more...
- http-multiplex - No description for the parameter type: str choices: [disable, enable] more...
- https-cookie-secure - No description for the parameter type: str choices: [disable, enable] more...
- id - No description for the parameter type: int more...
- ldb-method - No description for the parameter type: str choices: [static, round-robin, weighted, least-session, least-rtt, first-alive, http-host] more...
- mapped-addr - No description for the parameter type: str more...
- mappedip - No description for the parameter type: str more...
- mappedport - No description for the parameter type: str more...
- max-embryonic-connections - No description for the parameter type: int more...
- monitor - No description for the parameter type: str more...
- nat-source-vip - No description for the parameter type: str choices: [disable, enable] more...
- outlook-web-access - No description for the parameter type: str choices: [disable, enable] more...
- persistence - No description for the parameter type: str choices: [none, http-cookie, ssl-session-id] more...
- portforward - No description for the parameter type: str choices: [disable, enable] more...
- portmapping-type - No description for the parameter type: str choices: [1-to-1, m-to-n] more...
- protocol - No description for the parameter type: str choices: [tcp, udp, sctp, icmp] more...
- realservers - No description for the parameter type: array
more...
- client-ip - No description for the parameter type: str more...
- healthcheck - No description for the parameter type: str choices: [disable, enable, vip] more...
- holddown-interval - No description for the parameter type: int more...
- http-host - No description for the parameter type: str more...
- ip - No description for the parameter type: str more...
- max-connections - No description for the parameter type: int more...
- monitor - No description for the parameter type: str more...
- port - No description for the parameter type: int more...
- seq - No description for the parameter type: int more...
- status - No description for the parameter type: str choices: [active, standby, disable] more...
- weight - No description for the parameter type: int more...
- address - No description for the parameter type: str more...
- id - No description for the parameter type: int more...
- type - No description for the parameter type: str choices: [ip, address] more...
- translate-host - Enable/disable translation of hostname/IP from virtual server to real server. type: str choices: [disable, enable] more...
- health-check-proto - No description for the parameter type: str choices: [ping, http] more...
- server-type - No description for the parameter type: str choices: [http, https, ssl, tcp, udp, ip, imaps, pop3s, smtps, ssh] more...
- service - No description for the parameter type: str more...
- src-filter - No description for the parameter type: str more...
- srcintf-filter - No description for the parameter type: str more...
- ssl-algorithm - No description for the parameter type: str choices: [high, medium, low, custom] more...
- ssl-certificate - No description for the parameter type: str more...
- ssl-cipher-suites - No description for the parameter type: array
more...
- cipher - No description for the parameter type: str choices: [TLS-RSA-WITH-RC4-128-MD5, TLS-RSA-WITH-RC4-128-SHA, TLS-RSA-WITH-DES-CBC-SHA, TLS-RSA-WITH-3DES-EDE-CBC-SHA, TLS-RSA-WITH-AES-128-CBC-SHA, TLS-RSA-WITH-AES-256-CBC-SHA, TLS-RSA-WITH-AES-128-CBC-SHA256, TLS-RSA-WITH-AES-256-CBC-SHA256, TLS-RSA-WITH-CAMELLIA-128-CBC-SHA, TLS-RSA-WITH-CAMELLIA-256-CBC-SHA, TLS-RSA-WITH-CAMELLIA-128-CBC-SHA256, TLS-RSA-WITH-CAMELLIA-256-CBC-SHA256, TLS-RSA-WITH-SEED-CBC-SHA, TLS-RSA-WITH-ARIA-128-CBC-SHA256, TLS-RSA-WITH-ARIA-256-CBC-SHA384, TLS-DHE-RSA-WITH-DES-CBC-SHA, TLS-DHE-RSA-WITH-3DES-EDE-CBC-SHA, TLS-DHE-RSA-WITH-AES-128-CBC-SHA, TLS-DHE-RSA-WITH-AES-256-CBC-SHA, TLS-DHE-RSA-WITH-AES-128-CBC-SHA256, TLS-DHE-RSA-WITH-AES-256-CBC-SHA256, TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA, TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA, TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA256, TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA256, TLS-DHE-RSA-WITH-SEED-CBC-SHA, TLS-DHE-RSA-WITH-ARIA-128-CBC-SHA256, TLS-DHE-RSA-WITH-ARIA-256-CBC-SHA384, TLS-ECDHE-RSA-WITH-RC4-128-SHA, TLS-ECDHE-RSA-WITH-3DES-EDE-CBC-SHA, TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA, TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA, TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256, TLS-ECDHE-ECDSA-WITH-CHACHA20-POLY1305-SHA256, TLS-DHE-RSA-WITH-CHACHA20-POLY1305-SHA256, TLS-DHE-RSA-WITH-AES-128-GCM-SHA256, TLS-DHE-RSA-WITH-AES-256-GCM-SHA384, TLS-DHE-DSS-WITH-AES-128-CBC-SHA, TLS-DHE-DSS-WITH-AES-256-CBC-SHA, TLS-DHE-DSS-WITH-AES-128-CBC-SHA256, TLS-DHE-DSS-WITH-AES-128-GCM-SHA256, TLS-DHE-DSS-WITH-AES-256-CBC-SHA256, TLS-DHE-DSS-WITH-AES-256-GCM-SHA384, TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA256, TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256, TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA384, TLS-ECDHE-RSA-WITH-AES-256-GCM-SHA384, TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA, TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA256, TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256, TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA384, TLS-ECDHE-ECDSA-WITH-AES-256-GCM-SHA384, TLS-RSA-WITH-AES-128-GCM-SHA256, TLS-RSA-WITH-AES-256-GCM-SHA384, TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA, TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA, TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA256, TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA256, TLS-DHE-DSS-WITH-SEED-CBC-SHA, TLS-DHE-DSS-WITH-ARIA-128-CBC-SHA256, TLS-DHE-DSS-WITH-ARIA-256-CBC-SHA384, TLS-ECDHE-RSA-WITH-ARIA-128-CBC-SHA256, TLS-ECDHE-RSA-WITH-ARIA-256-CBC-SHA384, TLS-ECDHE-ECDSA-WITH-ARIA-128-CBC-SHA256, TLS-ECDHE-ECDSA-WITH-ARIA-256-CBC-SHA384, TLS-DHE-DSS-WITH-3DES-EDE-CBC-SHA, TLS-DHE-DSS-WITH-DES-CBC-SHA, TLS-AES-128-GCM-SHA256, TLS-AES-256-GCM-SHA384, TLS-CHACHA20-POLY1305-SHA256, TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA] more...
- id - No description for the parameter type: int more...
- versions - No description for the parameter type: array choices: [ssl-3.0, tls-1.0, tls-1.1, tls-1.2, tls-1.3] more...
- priority - No description for the parameter type: int more...
- ssl-client-fallback - No description for the parameter type: str choices: [disable, enable] more...
- ssl-client-renegotiation - No description for the parameter type: str choices: [deny, allow, secure] more...
- ssl-client-session-state-max - No description for the parameter type: int more...
- ssl-client-session-state-timeout - No description for the parameter type: int more...
- ssl-client-session-state-type - No description for the parameter type: str choices: [disable, time, count, both] more...
- ssl-dh-bits - No description for the parameter type: str choices: [768, 1024, 1536, 2048, 3072, 4096] more...
- ssl-hpkp - No description for the parameter type: str choices: [disable, enable, report-only] more...
- ssl-hpkp-age - No description for the parameter type: int more...
- ssl-hpkp-backup - No description for the parameter type: str more...
- ssl-hpkp-include-subdomains - No description for the parameter type: str choices: [disable, enable] more...
- ssl-hpkp-primary - No description for the parameter type: str more...
- ssl-hpkp-report-uri - No description for the parameter type: str more...
- ssl-hsts - No description for the parameter type: str choices: [disable, enable] more...
- ssl-hsts-age - No description for the parameter type: int more...
- ssl-hsts-include-subdomains - No description for the parameter type: str choices: [disable, enable] more...
- ssl-http-location-conversion - No description for the parameter type: str choices: [disable, enable] more...
- ssl-http-match-host - No description for the parameter type: str choices: [disable, enable] more...
- ssl-max-version - No description for the parameter type: str choices: [ssl-3.0, tls-1.0, tls-1.1, tls-1.2, tls-1.3] more...
- ssl-min-version - No description for the parameter type: str choices: [ssl-3.0, tls-1.0, tls-1.1, tls-1.2, tls-1.3] more...
- ssl-mode - No description for the parameter type: str choices: [half, full] more...
- ssl-pfs - No description for the parameter type: str choices: [require, deny, allow] more...
- ssl-send-empty-frags - No description for the parameter type: str choices: [disable, enable] more...
- ssl-server-algorithm - No description for the parameter type: str choices: [high, low, medium, custom, client] more...
- ssl-server-max-version - No description for the parameter type: str choices: [ssl-3.0, tls-1.0, tls-1.1, tls-1.2, client, tls-1.3] more...
- ssl-server-min-version - No description for the parameter type: str choices: [ssl-3.0, tls-1.0, tls-1.1, tls-1.2, client, tls-1.3] more...
- ssl-server-session-state-max - No description for the parameter type: int more...
- ssl-server-session-state-timeout - No description for the parameter type: int more...
- ssl-server-session-state-type - No description for the parameter type: str choices: [disable, time, count, both] more...
- type - No description for the parameter type: str choices: [static-nat, load-balance, server-load-balance, dns-translation, fqdn, access-proxy] more...
- uuid - No description for the parameter type: str more...
- weblogic-server - No description for the parameter type: str choices: [disable, enable] more...
- websphere-server - No description for the parameter type: str choices: [disable, enable] more...
- http-redirect - No description for the parameter type: str choices: [disable, enable] more...
- ssl-client-rekey-count - No description for the parameter type: int more...
- status - Enable/disable VIP. type: str choices: [disable, enable] more...
- add-nat46-route - Enable/disable adding NAT46 route. type: str choices: [disable, enable] more...
- ipv6-mappedip - Range of mapped IPv6 addresses. type: str more...
- ipv6-mappedport - IPv6 port number range on the destination network to which the external port number range is mapped. type: str more...
- nat44 - Enable/disable NAT44. type: str choices: [disable, enable] more...
- nat46 - Enable/disable NAT46. type: str choices: [disable, enable] more...
- ssl-accept-ffdhe-groups - Enable/disable FFDHE cipher suite for SSL key exchange. type: str choices: [disable, enable] more...
- http-multiplex-max-request - Maximum number of requests that a multiplex server can handle before disconnecting sessions (default = unlimited). type: int more...
- http-multiplex-ttl - Time-to-live for idle connections to servers. type: int more...
- http-supported-max-version - Maximum supported HTTP versions. type: str choices: [http1, http2] more...
- ssl-server-renegotiation - Enable/disable secure renegotiation to comply with RFC 5746. type: str choices: [disable, enable] more...
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 dynamic mappings of virtual IP for IPv4
fmgr_fact:
facts:
selector: 'firewall_vip_dynamicmapping'
params:
adom: 'ansible'
vip: 'ansible-test-vip' # name
dynamic_mapping: 'your_value'
- 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 IPv4
fmgr_firewall_vip_dynamicmapping:
bypass_validation: False
adom: ansible
vip: 'ansible-test-vip' # name
state: present
firewall_vip_dynamicmapping:
_scope: # Required
-
name: FGT_AWS # need a valid device name
vdom: root # need a valid vdom name under the device
arp-reply: enable
color: 2
comment: 'ansible-comment'
id: 1
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0