fortinet.fortimanager.fmgr_firewall_vip6_dynamicmapping – Configure virtual IP for IPv6.

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

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

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

Choices:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

firewall_vip6_dynamicmapping

dictionary

the top level parameters set

_scope

list / elements=string

no description

name

string

Name.

vdom

string

Vdom.

arp-reply

string

Enable to respond to ARP requests for this virtual IP address. Enabled by default.

Choices:

  • disable

  • enable

color

integer

Color of icon on the GUI.

comment

string

Comment.

extip

string

IP address or address range on the external interface that you want to map to an address or address range on the destination n…

extport

string

Incoming port number range that you want to map to a port number range on the destination network.

integer

Time in minutes that client web browsers should keep a cookie. Default is 60 seconds. 0 = no time limit.

string

Domain that HTTP cookie persistence should apply to.

string

Enable/disable use of HTTP cookie domain from host field in HTTP.

Choices:

  • disable

  • enable

integer

Generation of HTTP cookie to be accepted. Changing invalidates all existing cookies.

string

Limit HTTP cookie persistence to the specified path.

string

Control sharing of cookies across virtual servers. same-ip means a cookie from one virtual server can be used by another. Disa…

Choices:

  • disable

  • same-ip

http-ip-header

string

For HTTP multiplexing, enable to add the original client IP address in the XForwarded-For HTTP header.

Choices:

  • disable

  • enable

http-ip-header-name

string

For HTTP multiplexing, enter a custom HTTPS header name. The original client IP address is added to this header. If empty, X-F…

http-multiplex

string

Enable/disable HTTP multiplexing.

Choices:

  • disable

  • enable

http-redirect

string

Enable/disable redirection of HTTP to HTTPS

Choices:

  • disable

  • enable

string

Enable/disable verification that inserted HTTPS cookies are secure.

Choices:

  • disable

  • enable

id

integer

Custom defined ID.

ldb-method

string

Method used to distribute sessions to real servers.

Choices:

  • static

  • round-robin

  • weighted

  • least-session

  • least-rtt

  • first-alive

  • http-host

mappedip

string

Mapped IP address range in the format startIP-endIP.

mappedport

string

Port number range on the destination network to which the external port number range is mapped.

max-embryonic-connections

integer

Maximum number of incomplete connections.

monitor

string

Name of the health check monitor to use when polling to determine a virtual servers connectivity status.

nat-source-vip

string

Nat-Source-Vip.

Choices:

  • disable

  • enable

outlook-web-access

string

Enable to add the Front-End-Https header for Microsoft Outlook Web Access.

Choices:

  • disable

  • enable

persistence

string

Configure how to make sure that clients connect to the same server every time they make a request that is part of the same ses…

Choices:

  • none

  • http-cookie

  • ssl-session-id

portforward

string

Enable port forwarding.

Choices:

  • disable

  • enable

protocol

string

Protocol to use when forwarding packets.

Choices:

  • tcp

  • udp

  • sctp

server-type

string

Protocol to be load balanced by the virtual server (also called the server load balance virtual IP).

Choices:

  • http

  • https

  • ssl

  • tcp

  • udp

  • ip

  • imaps

  • pop3s

  • smtps

src-filter

string

no description

ssl-algorithm

string

Permitted encryption algorithms for SSL sessions according to encryption strength.

Choices:

  • high

  • low

  • medium

  • custom

ssl-certificate

string

The name of the SSL certificate to use for SSL acceleration.

ssl-client-fallback

string

Enable/disable support for preventing Downgrade Attacks on client connections (RFC 7507).

Choices:

  • disable

  • enable

ssl-client-rekey-count

integer

Maximum length of data in MB before triggering a client rekey (0 = disable).

ssl-client-renegotiation

string

Allow, deny, or require secure renegotiation of client sessions to comply with RFC 5746.

Choices:

  • deny

  • allow

  • secure

ssl-client-session-state-max

integer

Maximum number of client to FortiGate SSL session states to keep.

ssl-client-session-state-timeout

integer

Number of minutes to keep client to FortiGate SSL session state.

ssl-client-session-state-type

string

How to expire SSL sessions for the segment of the SSL connection between the client and the FortiGate.

Choices:

  • disable

  • time

  • count

  • both

ssl-dh-bits

string

Number of bits to use in the Diffie-Hellman exchange for RSA encryption of SSL sessions.

Choices:

  • 768

  • 1024

  • 1536

  • 2048

  • 3072

  • 4096

ssl-hpkp

string

Enable/disable including HPKP header in response.

Choices:

  • disable

  • enable

  • report-only

ssl-hpkp-age

integer

Number of minutes the web browser should keep HPKP.

ssl-hpkp-backup

string

Certificate to generate backup HPKP pin from.

ssl-hpkp-include-subdomains

string

Indicate that HPKP header applies to all subdomains.

Choices:

  • disable

  • enable

ssl-hpkp-primary

string

Certificate to generate primary HPKP pin from.

ssl-hpkp-report-uri

string

URL to report HPKP violations to.

ssl-hsts

string

Enable/disable including HSTS header in response.

Choices:

  • disable

  • enable

ssl-hsts-age

integer

Number of seconds the client should honour the HSTS setting.

ssl-hsts-include-subdomains

string

Indicate that HSTS header applies to all subdomains.

Choices:

  • disable

  • enable

ssl-http-location-conversion

string

Enable to replace HTTP with HTTPS in the replys Location HTTP header field.

Choices:

  • disable

  • enable

ssl-http-match-host

string

Enable/disable HTTP host matching for location conversion.

Choices:

  • disable

  • enable

ssl-max-version

string

Highest SSL/TLS version acceptable from a client.

Choices:

  • ssl-3.0

  • tls-1.0

  • tls-1.1

  • tls-1.2

  • tls-1.3

ssl-min-version

string

Lowest SSL/TLS version acceptable from a client.

Choices:

  • ssl-3.0

  • tls-1.0

  • tls-1.1

  • tls-1.2

  • tls-1.3

ssl-mode

string

Apply SSL offloading between the client and the FortiGate (half) or from the client to the FortiGate and from the FortiGate to…

Choices:

  • half

  • full

ssl-pfs

string

Select the cipher suites that can be used for SSL perfect forward secrecy (PFS). Applies to both client and server sessions.

Choices:

  • require

  • deny

  • allow

ssl-send-empty-frags

string

Enable/disable sending empty fragments to avoid CBC IV attacks (SSL 3.0 & TLS 1.0 only). May need to be disabled for compatibi…

Choices:

  • disable

  • enable

ssl-server-algorithm

string

Permitted encryption algorithms for the server side of SSL full mode sessions according to encryption strength.

Choices:

  • high

  • low

  • medium

  • custom

  • client

ssl-server-max-version

string

Highest SSL/TLS version acceptable from a server. Use the client setting by default.

Choices:

  • ssl-3.0

  • tls-1.0

  • tls-1.1

  • tls-1.2

  • client

  • tls-1.3

ssl-server-min-version

string

Lowest SSL/TLS version acceptable from a server. Use the client setting by default.

Choices:

  • ssl-3.0

  • tls-1.0

  • tls-1.1

  • tls-1.2

  • client

  • tls-1.3

ssl-server-session-state-max

integer

Maximum number of FortiGate to Server SSL session states to keep.

ssl-server-session-state-timeout

integer

Number of minutes to keep FortiGate to Server SSL session state.

ssl-server-session-state-type

string

How to expire SSL sessions for the segment of the SSL connection between the server and the FortiGate.

Choices:

  • disable

  • time

  • count

  • both

type

string

Configure a static NAT or server load balance VIP.

Choices:

  • static-nat

  • server-load-balance

uuid

string

Universally Unique Identifier (UUID; automatically assigned but can be manually reset).

weblogic-server

string

Enable to add an HTTP header to indicate SSL offloading for a WebLogic server.

Choices:

  • disable

  • enable

websphere-server

string

Enable to add an HTTP header to indicate SSL offloading for a WebSphere server.

Choices:

  • disable

  • enable

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

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

Choices:

  • present

  • absent

vip6

string / required

the parameter (vip6) in requested url

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

the maximum time in seconds to wait for other user to release the workspace lock

Default: 300

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: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure dynamic mappings of virtual IP for IPv6
     fmgr_firewall_vip6_dynamicmapping:
        bypass_validation: False
        adom: ansible
        vip6: 'ansible-test-vip6' # name
        state: present
        firewall_vip6_dynamicmapping:
           _scope:
             -
                 name: FGT_AWS # need a valid device name
                 vdom: root # need a valid vdom name under the device
           arp-reply: disable
           color: 1
           comment: 'ansible-comment'
           id: 1

- 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 dynamic mappings of virtual IP for IPv6
     fmgr_fact:
       facts:
           selector: 'firewall_vip6_dynamicmapping'
           params:
               adom: 'ansible'
               vip6: 'ansible-test-vip6' # name
               dynamic_mapping: ''

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

request_url

string

The full url requested

Returned: always

Sample: “/sys/login/user”

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)