fortinet.fortimanager.fmgr_firewall_vip64 – Configure IPv6 to IPv4 virtual IPs.
Note
This plugin is part of the fortinet.fortimanager collection (version 2.1.3).
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_vip64.
New in version 2.10: of fortinet.fortimanager
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 | Choices/Defaults | Comments | |||
|---|---|---|---|---|---|
| adom
string / required
|
the parameter (adom) in requested url
|
||||
| bypass_validation
boolean
|
|
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
|
|||
| enable_log
boolean
|
|
Enable/Disable logging for task
|
|||
| firewall_vip64
dictionary
|
the top level parameters set
|
||||
| arp-reply
string
|
|
Enable ARP reply.
|
|||
| color
integer
|
Color of icon on the GUI.
|
||||
| comment
string
|
Comment.
|
||||
| dynamic_mapping
list / elements=string
|
no description
|
||||
| _scope
list / elements=string
|
no description
|
||||
| name
string
|
no description
|
||||
| vdom
string
|
no description
|
||||
| arp-reply
string
|
|
no description
|
|||
| color
integer
|
no description
|
||||
| comment
string
|
no description
|
||||
| extip
string
|
no description
|
||||
| extport
string
|
no description
|
||||
| id
integer
|
no description
|
||||
| ldb-method
string
|
|
no description
|
|||
| mappedip
string
|
no description
|
||||
| mappedport
string
|
no description
|
||||
| monitor
string
|
no description
|
||||
| portforward
string
|
|
no description
|
|||
| protocol
string
|
|
no description
|
|||
| server-type
string
|
|
no description
|
|||
| src-filter
string
|
no description
|
||||
| type
string
|
|
no description
|
|||
| uuid
string
|
no description
|
||||
| extip
string
|
Start-external-IP [-end-external-IP].
|
||||
| extport
string
|
External service port.
|
||||
| id
integer
|
Custom defined id.
|
||||
| ldb-method
string
|
|
Load balance method.
|
|||
| mappedip
string
|
Start-mapped-IP [-end-mapped-IP].
|
||||
| mappedport
string
|
Mapped service port.
|
||||
| monitor
string
|
Health monitors.
|
||||
| name
string
|
VIP64 name.
|
||||
| portforward
string
|
|
Enable port forwarding.
|
|||
| protocol
string
|
|
Mapped port protocol.
|
|||
| realservers
list / elements=string
|
no description
|
||||
| client-ip
string
|
Restrict server to a client IP in this range.
|
||||
| healthcheck
string
|
|
Per server health check.
|
|||
| holddown-interval
integer
|
Hold down interval.
|
||||
| id
integer
|
Real server ID.
|
||||
| ip
string
|
Mapped server IP.
|
||||
| max-connections
integer
|
Maximum number of connections allowed to server.
|
||||
| monitor
string
|
Health monitors.
|
||||
| port
integer
|
Mapped server port.
|
||||
| status
string
|
|
Server administrative status.
|
|||
| weight
integer
|
no description
|
||||
| server-type
string
|
|
Server type.
|
|||
| src-filter
string
|
no description
|
||||
| type
string
|
|
VIP type: static NAT.
|
|||
| uuid
string
|
Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
|
||||
| proposed_method
string
|
|
The overridden method for the underlying Json RPC request
|
|||
| rc_failed
list / elements=string
|
the rc codes list with which the conditions to fail will be overriden
|
||||
| rc_succeeded
list / elements=string
|
the rc codes list with which the conditions to succeed will be overriden
|
||||
| state
string / required
|
|
the directive to create, update or delete an object
|
|||
| workspace_locking_adom
string
|
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
|
||||
| workspace_locking_timeout
integer
|
Default:
300
|
the maximum time in seconds to wait for other user to release the workspace lock
|
|||
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 here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| request_url
string
|
always |
The full url requested
Sample:
/sys/login/user
|
| response_code
integer
|
always |
The status of api request
|
| response_message
string
|
always |
The descriptive message of the api response
Sample:
OK.
|
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_firewall_vip64_module.html