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