fmgr_firewall_vip64 – Configure IPv6 to IPv4 virtual IPs.¶
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
- firewall_vip64 - Configure IPv6 to IPv4 virtual IPs. type: dict
- arp-reply - Enable ARP reply. type: str choices: [disable, enable]
- color - Color of icon on the GUI. type: int
- comment - Comment. type: str
- dynamic_mapping - No description for the parameter type: array
- _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
- extip - No description for the parameter type: str
- extport - No description for the parameter type: str
- 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]
- mappedip - No description for the parameter type: str
- mappedport - No description for the parameter type: str
- monitor - No description for the parameter type: str
- portforward - No description for the parameter type: str choices: [disable, enable]
- protocol - No description for the parameter type: str choices: [tcp, udp]
- server-type - No description for the parameter type: str choices: [http, tcp, udp, ip]
- src-filter - No description for the parameter type: str
- type - No description for the parameter type: str choices: [static-nat, server-load-balance]
- uuid - No description for the parameter type: str
- _scope - No description for the parameter type: array
- extip - Start-external-IP [-end-external-IP]. type: str
- extport - External service port. type: str
- id - Custom defined id. type: int
- ldb-method - Load balance method. type: str choices: [static, round-robin, weighted, least-session, least-rtt, first-alive]
- mappedip - Start-mapped-IP [-end-mapped-IP]. type: str
- mappedport - Mapped service port. type: str
- monitor - Health monitors. type: str
- name - VIP64 name. type: str
- portforward - Enable port forwarding. type: str choices: [disable, enable]
- protocol - Mapped port protocol. type: str choices: [tcp, udp]
- realservers - No description for the parameter type: array
- client-ip - Restrict server to a client IP in this range. type: str
- healthcheck - Per server health check. type: str choices: [disable, enable, vip]
- holddown-interval - Hold down interval. type: int
- id - Real server ID. type: int
- ip - Mapped server IP. type: str
- max-connections - Maximum number of connections allowed to server. type: int
- monitor - Health monitors. type: str
- port - Mapped server port. type: int
- status - Server administrative status. type: str choices: [active, standby, disable]
- weight - No description for the parameter type: int
- server-type - Server type. type: str choices: [http, tcp, udp, ip]
- src-filter - No description for the parameter type: str
- type - VIP type: static NAT. type: str choices: [static-nat, server-load-balance]
- uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str
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 IPv6 to IPv4 virtual IPs.
fmgr_firewall_vip64:
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>
state: <value in [present, absent]>
firewall_vip64:
arp-reply: <value in [disable, enable]>
color: <value of integer>
comment: <value of string>
dynamic_mapping:
-
_scope:
-
name: <value of string>
vdom: <value of string>
arp-reply: <value in [disable, enable]>
color: <value of integer>
comment: <value of string>
extip: <value of string>
extport: <value of string>
id: <value of integer>
ldb-method: <value in [static, round-robin, weighted, ...]>
mappedip: <value of string>
mappedport: <value of string>
monitor: <value of string>
portforward: <value in [disable, enable]>
protocol: <value in [tcp, udp]>
server-type: <value in [http, tcp, udp, ...]>
src-filter: <value of string>
type: <value in [static-nat, server-load-balance]>
uuid: <value of string>
extip: <value of string>
extport: <value of string>
id: <value of integer>
ldb-method: <value in [static, round-robin, weighted, ...]>
mappedip: <value of string>
mappedport: <value of string>
monitor: <value of string>
name: <value of string>
portforward: <value in [disable, enable]>
protocol: <value in [tcp, udp]>
realservers:
-
client-ip: <value of string>
healthcheck: <value in [disable, enable, vip]>
holddown-interval: <value of integer>
id: <value of integer>
ip: <value of string>
max-connections: <value of integer>
monitor: <value of string>
port: <value of integer>
status: <value in [active, standby, disable]>
weight: <value of integer>
server-type: <value in [http, tcp, udp, ...]>
src-filter: <value of string>
type: <value in [static-nat, server-load-balance]>
uuid: <value of string>
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