fmgr_firewall_vip_dynamicmapping¶
New in version 2.10.
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.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- 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
- 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
- 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
- adom - The parameter in requested url type: str required: true
- vip - The parameter in requested url type: str required: true
- firewall_vip_dynamicmapping - no description type: dict
- _scope - No description for the parameter type: array
- name - No description for the parameter type: str
- vdom - No description for the parameter type: str
- arp-reply - No description for the parameter type: str choices: [disable, enable]
- color - No description for the parameter type: int
- comment - No description for the parameter type: str
- dns-mapping-ttl - No description for the parameter type: int
- extaddr - No description for the parameter type: str
- extintf - No description for the parameter type: str
- extip - No description for the parameter type: str
- extport - No description for the parameter type: str
- gratuitous-arp-interval - No description for the parameter type: int
- http-cookie-age - No description for the parameter type: int
- http-cookie-domain - No description for the parameter type: str
- http-cookie-domain-from-host - No description for the parameter type: str choices: [disable, enable]
- http-cookie-generation - No description for the parameter type: int
- http-cookie-path - No description for the parameter type: str
- http-cookie-share - No description for the parameter type: str choices: [disable, same-ip]
- http-ip-header - No description for the parameter type: str choices: [disable, enable]
- http-ip-header-name - No description for the parameter type: str
- http-multiplex - No description for the parameter type: str choices: [disable, enable]
- https-cookie-secure - No description for the parameter type: str choices: [disable, enable]
- id - No description for the parameter type: int
- ldb-method - No description for the parameter type: str choices: [static, round-robin, weighted, least-session, least-rtt, first-alive, http-host]
- mapped-addr - No description for the parameter type: str
- mappedip - No description for the parameter type: str
- mappedport - No description for the parameter type: str
- max-embryonic-connections - No description for the parameter type: int
- monitor - No description for the parameter type: str
- nat-source-vip - No description for the parameter type: str choices: [disable, enable]
- outlook-web-access - No description for the parameter type: str choices: [disable, enable]
- persistence - No description for the parameter type: str choices: [none, http-cookie, ssl-session-id]
- portforward - No description for the parameter type: str choices: [disable, enable]
- portmapping-type - No description for the parameter type: str choices: [1-to-1, m-to-n]
- protocol - No description for the parameter type: str choices: [tcp, udp, sctp, icmp]
- realservers - No description for the parameter type: array
- client-ip - No description for the parameter type: str
- healthcheck - No description for the parameter type: str choices: [disable, enable, vip]
- holddown-interval - No description for the parameter type: int
- http-host - No description for the parameter type: str
- ip - No description for the parameter type: str
- max-connections - No description for the parameter type: int
- monitor - No description for the parameter type: str
- port - No description for the parameter type: int
- seq - No description for the parameter type: int
- status - No description for the parameter type: str choices: [active, standby, disable]
- weight - No description for the parameter type: int
- server-type - No description for the parameter type: str choices: [http, https, ssl, tcp, udp, ip, imaps, pop3s, smtps]
- service - No description for the parameter type: str
- src-filter - No description for the parameter type: str
- srcintf-filter - No description for the parameter type: str
- ssl-algorithm - No description for the parameter type: str choices: [high, medium, low, custom]
- ssl-certificate - No description for the parameter type: str
- ssl-cipher-suites - No description for the parameter type: array
- 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]
- id - No description for the parameter type: int
- versions - No description for the parameter type: array choices: [ssl-3.0, tls-1.0, tls-1.1, tls-1.2]
- ssl-client-fallback - No description for the parameter type: str choices: [disable, enable]
- ssl-client-renegotiation - No description for the parameter type: str choices: [deny, allow, secure]
- ssl-client-session-state-max - No description for the parameter type: int
- ssl-client-session-state-timeout - No description for the parameter type: int
- ssl-client-session-state-type - No description for the parameter type: str choices: [disable, time, count, both]
- ssl-dh-bits - No description for the parameter type: str choices: [768, 1024, 1536, 2048, 3072, 4096]
- ssl-hpkp - No description for the parameter type: str choices: [disable, enable, report-only]
- ssl-hpkp-age - No description for the parameter type: int
- ssl-hpkp-backup - No description for the parameter type: str
- ssl-hpkp-include-subdomains - No description for the parameter type: str choices: [disable, enable]
- ssl-hpkp-primary - No description for the parameter type: str
- ssl-hpkp-report-uri - No description for the parameter type: str
- ssl-hsts - No description for the parameter type: str choices: [disable, enable]
- ssl-hsts-age - No description for the parameter type: int
- ssl-hsts-include-subdomains - No description for the parameter type: str choices: [disable, enable]
- ssl-http-location-conversion - No description for the parameter type: str choices: [disable, enable]
- ssl-http-match-host - No description for the parameter type: str choices: [disable, enable]
- ssl-max-version - No description for the parameter type: str choices: [ssl-3.0, tls-1.0, tls-1.1, tls-1.2]
- ssl-min-version - No description for the parameter type: str choices: [ssl-3.0, tls-1.0, tls-1.1, tls-1.2]
- ssl-mode - No description for the parameter type: str choices: [half, full]
- ssl-pfs - No description for the parameter type: str choices: [require, deny, allow]
- ssl-send-empty-frags - No description for the parameter type: str choices: [disable, enable]
- ssl-server-algorithm - No description for the parameter type: str choices: [high, low, medium, custom, client]
- 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]
- 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]
- ssl-server-session-state-max - No description for the parameter type: int
- ssl-server-session-state-timeout - No description for the parameter type: int
- ssl-server-session-state-type - No description for the parameter type: str choices: [disable, time, count, both]
- type - No description for the parameter type: str choices: [static-nat, load-balance, server-load-balance, dns-translation, fqdn]
- uuid - No description for the parameter type: str
- weblogic-server - No description for the parameter type: str choices: [disable, enable]
- websphere-server - No description for the parameter type: str choices: [disable, enable]
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: no description
fmgr_firewall_vip_dynamicmapping:
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>
vip: <your own value>
state: <value in [present, absent]>
firewall_vip_dynamicmapping:
_scope:
-
name: <value of string>
vdom: <value of string>
arp-reply: <value in [disable, enable]>
color: <value of integer>
comment: <value of string>
dns-mapping-ttl: <value of integer>
extaddr: <value of string>
extintf: <value of string>
extip: <value of string>
extport: <value of string>
gratuitous-arp-interval: <value of integer>
http-cookie-age: <value of integer>
http-cookie-domain: <value of string>
http-cookie-domain-from-host: <value in [disable, enable]>
http-cookie-generation: <value of integer>
http-cookie-path: <value of string>
http-cookie-share: <value in [disable, same-ip]>
http-ip-header: <value in [disable, enable]>
http-ip-header-name: <value of string>
http-multiplex: <value in [disable, enable]>
https-cookie-secure: <value in [disable, enable]>
id: <value of integer>
ldb-method: <value in [static, round-robin, weighted, ...]>
mapped-addr: <value of string>
mappedip: <value of string>
mappedport: <value of string>
max-embryonic-connections: <value of integer>
monitor: <value of string>
nat-source-vip: <value in [disable, enable]>
outlook-web-access: <value in [disable, enable]>
persistence: <value in [none, http-cookie, ssl-session-id]>
portforward: <value in [disable, enable]>
portmapping-type: <value in [1-to-1, m-to-n]>
protocol: <value in [tcp, udp, sctp, ...]>
realservers:
-
client-ip: <value of string>
healthcheck: <value in [disable, enable, vip]>
holddown-interval: <value of integer>
http-host: <value of string>
ip: <value of string>
max-connections: <value of integer>
monitor: <value of string>
port: <value of integer>
seq: <value of integer>
status: <value in [active, standby, disable]>
weight: <value of integer>
server-type: <value in [http, https, ssl, ...]>
service: <value of string>
src-filter: <value of string>
srcintf-filter: <value of string>
ssl-algorithm: <value in [high, medium, low, ...]>
ssl-certificate: <value of string>
ssl-cipher-suites:
-
cipher: <value in [TLS-RSA-WITH-RC4-128-MD5, TLS-RSA-WITH-RC4-128-SHA, TLS-RSA-WITH-DES-CBC-SHA, ...]>
id: <value of integer>
versions:
- ssl-3.0
- tls-1.0
- tls-1.1
- tls-1.2
ssl-client-fallback: <value in [disable, enable]>
ssl-client-renegotiation: <value in [deny, allow, secure]>
ssl-client-session-state-max: <value of integer>
ssl-client-session-state-timeout: <value of integer>
ssl-client-session-state-type: <value in [disable, time, count, ...]>
ssl-dh-bits: <value in [768, 1024, 1536, ...]>
ssl-hpkp: <value in [disable, enable, report-only]>
ssl-hpkp-age: <value of integer>
ssl-hpkp-backup: <value of string>
ssl-hpkp-include-subdomains: <value in [disable, enable]>
ssl-hpkp-primary: <value of string>
ssl-hpkp-report-uri: <value of string>
ssl-hsts: <value in [disable, enable]>
ssl-hsts-age: <value of integer>
ssl-hsts-include-subdomains: <value in [disable, enable]>
ssl-http-location-conversion: <value in [disable, enable]>
ssl-http-match-host: <value in [disable, enable]>
ssl-max-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
ssl-min-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
ssl-mode: <value in [half, full]>
ssl-pfs: <value in [require, deny, allow]>
ssl-send-empty-frags: <value in [disable, enable]>
ssl-server-algorithm: <value in [high, low, medium, ...]>
ssl-server-max-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
ssl-server-min-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
ssl-server-session-state-max: <value of integer>
ssl-server-session-state-timeout: <value of integer>
ssl-server-session-state-type: <value in [disable, time, count, ...]>
type: <value in [static-nat, load-balance, server-load-balance, ...]>
uuid: <value of string>
weblogic-server: <value in [disable, enable]>
websphere-server: <value in [disable, enable]>
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:
- 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_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict