fortinet.fortimanager.fmgr_firewall_vip46 – Configure IPv4 to IPv6 virtual IPs.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.4).

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_vip46.

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
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
firewall_vip46
dictionary
the top level parameters set
arp-reply
string
    Choices:
  • disable
  • enable
Enable ARP reply.
color
integer
Color of icon on the GUI.
comment
string
Comment.
dynamic_mapping
list / elements=string
Dynamic_Mapping.
_scope
list / elements=string
_Scope.
name
string
Name.
vdom
string
Vdom.
arp-reply
string
    Choices:
  • disable
  • enable
Enable ARP reply.
color
integer
Color of icon on the GUI.
comment
string
Comment.
extip
string
Start-external-IP [-end-external-IP].
extport
string
External service port.
id
integer
Custom defined id.
ldb-method
string
    Choices:
  • static
  • round-robin
  • weighted
  • least-session
  • least-rtt
  • first-alive
Load balance method.
mappedip
string
Start-mapped-IP [-end mapped-IP].
mappedport
string
Mapped service port.
monitor
string
Health monitors.
portforward
string
    Choices:
  • disable
  • enable
Enable port forwarding.
protocol
string
    Choices:
  • tcp
  • udp
Mapped port protocol.
server-type
string
    Choices:
  • http
  • tcp
  • udp
  • ip
Server type.
src-filter
string
Source IP filter (x.x.x.x/x).
srcintf-filter
string
Interfaces to which the VIP46 applies. Separate the names with spaces.
type
string
    Choices:
  • static-nat
  • server-load-balance
VIP type: static NAT or server load balance.
uuid
string
Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
extip
string
Start-external-IP [-end-external-IP].
extport
string
External service port.
id
integer
Custom defined id.
ldb-method
string
    Choices:
  • static
  • round-robin
  • weighted
  • least-session
  • least-rtt
  • first-alive
Load balance method.
mappedip
string
Start-mapped-IP [-end mapped-IP].
mappedport
string
Mapped service port.
monitor
string
Health monitors.
name
string
VIP46 name.
portforward
string
    Choices:
  • disable
  • enable
Enable port forwarding.
protocol
string
    Choices:
  • tcp
  • udp
Mapped port protocol.
realservers
list / elements=string
Realservers.
client-ip
string
Restrict server to a client IP in this range.
healthcheck
string
    Choices:
  • disable
  • enable
  • vip
Per server health check.
holddown-interval
integer
Hold down interval.
id
integer
Real server ID.
ip
string
Mapped server IPv6.
max-connections
integer
Maximum number of connections allowed to server.
monitor
string
Health monitors.
port
integer
Mapped server port.
status
string
    Choices:
  • active
  • standby
  • disable
Server administrative status.
weight
integer
Weight.
server-type
string
    Choices:
  • http
  • tcp
  • udp
  • ip
Server type.
src-filter
string
Source IP filter (x.x.x.x/x).
srcintf-filter
string
Interfaces to which the VIP46 applies. Separate the names with spaces.
type
string
    Choices:
  • static-nat
  • server-load-balance
VIP type: static NAT.
uuid
string
Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
proposed_method
string
    Choices:
  • update
  • set
  • add
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
    Choices:
  • present
  • absent
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

- 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 IPv4 to IPv6 virtual IPs
     fmgr_fact:
       facts:
           selector: 'firewall_vip46'
           params:
               adom: 'ansible'
               vip46: ''
- 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 IPv4 to IPv6 virtual IPs.
     fmgr_firewall_vip46:
        bypass_validation: False
        adom: ansible
        state: present
        firewall_vip46:
           arp-reply: enable
           color: 1
           comment: 'ansible-comment'
           id: 1
           ldb-method: static #<value in [static, round-robin, weighted, ...]>
           name: 'ansible-test-vip46'
           protocol: tcp #<value in [tcp, udp]>

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)