fortinet.fortimanager.fmgr_firewall_vip6_dynamicmapping – no description

Note

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

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 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
firewall_vip6_dynamicmapping
dictionary
the top level parameters set
_scope
list / elements=string
no description
name
string
no description
vdom
string
no description
arp-reply
string
    Choices:
  • disable
  • enable
no description
color
integer
no description
comment
string
no description
extip
string
no description
extport
string
no description
http-cookie-age
integer
no description
http-cookie-domain
string
no description
http-cookie-domain-from-host
string
    Choices:
  • disable
  • enable
no description
http-cookie-generation
integer
no description
http-cookie-path
string
no description
http-cookie-share
string
    Choices:
  • disable
  • same-ip
no description
http-ip-header
string
    Choices:
  • disable
  • enable
no description
http-ip-header-name
string
no description
http-multiplex
string
    Choices:
  • disable
  • enable
no description
https-cookie-secure
string
    Choices:
  • disable
  • enable
no description
id
integer
no description
ldb-method
string
    Choices:
  • static
  • round-robin
  • weighted
  • least-session
  • least-rtt
  • first-alive
  • http-host
no description
mappedip
string
no description
mappedport
string
no description
max-embryonic-connections
integer
no description
monitor
string
no description
outlook-web-access
string
    Choices:
  • disable
  • enable
no description
persistence
string
    Choices:
  • none
  • http-cookie
  • ssl-session-id
no description
portforward
string
    Choices:
  • disable
  • enable
no description
protocol
string
    Choices:
  • tcp
  • udp
  • sctp
no description
server-type
string
    Choices:
  • http
  • https
  • ssl
  • tcp
  • udp
  • ip
  • imaps
  • pop3s
  • smtps
no description
src-filter
string
no description
ssl-algorithm
string
    Choices:
  • high
  • low
  • medium
  • custom
no description
ssl-certificate
string
no description
ssl-client-fallback
string
    Choices:
  • disable
  • enable
no description
ssl-client-renegotiation
string
    Choices:
  • deny
  • allow
  • secure
no description
ssl-client-session-state-max
integer
no description
ssl-client-session-state-timeout
integer
no description
ssl-client-session-state-type
string
    Choices:
  • disable
  • time
  • count
  • both
no description
ssl-dh-bits
string
    Choices:
  • 768
  • 1024
  • 1536
  • 2048
  • 3072
  • 4096
no description
ssl-hpkp
string
    Choices:
  • disable
  • enable
  • report-only
no description
ssl-hpkp-age
integer
no description
ssl-hpkp-backup
string
no description
ssl-hpkp-include-subdomains
string
    Choices:
  • disable
  • enable
no description
ssl-hpkp-primary
string
no description
ssl-hpkp-report-uri
string
no description
ssl-hsts
string
    Choices:
  • disable
  • enable
no description
ssl-hsts-age
integer
no description
ssl-hsts-include-subdomains
string
    Choices:
  • disable
  • enable
no description
ssl-http-location-conversion
string
    Choices:
  • disable
  • enable
no description
ssl-http-match-host
string
    Choices:
  • disable
  • enable
no description
ssl-max-version
string
    Choices:
  • ssl-3.0
  • tls-1.0
  • tls-1.1
  • tls-1.2
no description
ssl-min-version
string
    Choices:
  • ssl-3.0
  • tls-1.0
  • tls-1.1
  • tls-1.2
no description
ssl-mode
string
    Choices:
  • half
  • full
no description
ssl-pfs
string
    Choices:
  • require
  • deny
  • allow
no description
ssl-send-empty-frags
string
    Choices:
  • disable
  • enable
no description
ssl-server-algorithm
string
    Choices:
  • high
  • low
  • medium
  • custom
  • client
no description
ssl-server-max-version
string
    Choices:
  • ssl-3.0
  • tls-1.0
  • tls-1.1
  • tls-1.2
  • client
no description
ssl-server-min-version
string
    Choices:
  • ssl-3.0
  • tls-1.0
  • tls-1.1
  • tls-1.2
  • client
no description
ssl-server-session-state-max
integer
no description
ssl-server-session-state-timeout
integer
no description
ssl-server-session-state-type
string
    Choices:
  • disable
  • time
  • count
  • both
no description
type
string
    Choices:
  • static-nat
  • server-load-balance
no description
uuid
string
no description
weblogic-server
string
    Choices:
  • disable
  • enable
no description
websphere-server
string
    Choices:
  • disable
  • enable
no description
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
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
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: no description
     fmgr_firewall_vip6_dynamicmapping:
        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>
        vip6: <your own value>
        state: <value in [present, absent]>
        firewall_vip6_dynamicmapping:
           _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>
           http-cookie-age: <value of integer>
           http-cookie-domain: <value of string>
           http-cookie-domain-from-host: <value in [disable, enable]>
           http-cookie-generation: <value of integer>
           http-cookie-path: <value of string>
           http-cookie-share: <value in [disable, same-ip]>
           http-ip-header: <value in [disable, enable]>
           http-ip-header-name: <value of string>
           http-multiplex: <value in [disable, enable]>
           https-cookie-secure: <value in [disable, enable]>
           id: <value of integer>
           ldb-method: <value in [static, round-robin, weighted, ...]>
           mappedip: <value of string>
           mappedport: <value of string>
           max-embryonic-connections: <value of integer>
           monitor: <value of string>
           outlook-web-access: <value in [disable, enable]>
           persistence: <value in [none, http-cookie, ssl-session-id]>
           portforward: <value in [disable, enable]>
           protocol: <value in [tcp, udp, sctp]>
           server-type: <value in [http, https, ssl, ...]>
           src-filter: <value of string>
           ssl-algorithm: <value in [high, low, medium, ...]>
           ssl-certificate: <value of string>
           ssl-client-fallback: <value in [disable, enable]>
           ssl-client-renegotiation: <value in [deny, allow, secure]>
           ssl-client-session-state-max: <value of integer>
           ssl-client-session-state-timeout: <value of integer>
           ssl-client-session-state-type: <value in [disable, time, count, ...]>
           ssl-dh-bits: <value in [768, 1024, 1536, ...]>
           ssl-hpkp: <value in [disable, enable, report-only]>
           ssl-hpkp-age: <value of integer>
           ssl-hpkp-backup: <value of string>
           ssl-hpkp-include-subdomains: <value in [disable, enable]>
           ssl-hpkp-primary: <value of string>
           ssl-hpkp-report-uri: <value of string>
           ssl-hsts: <value in [disable, enable]>
           ssl-hsts-age: <value of integer>
           ssl-hsts-include-subdomains: <value in [disable, enable]>
           ssl-http-location-conversion: <value in [disable, enable]>
           ssl-http-match-host: <value in [disable, enable]>
           ssl-max-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
           ssl-min-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
           ssl-mode: <value in [half, full]>
           ssl-pfs: <value in [require, deny, allow]>
           ssl-send-empty-frags: <value in [disable, enable]>
           ssl-server-algorithm: <value in [high, low, medium, ...]>
           ssl-server-max-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
           ssl-server-min-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
           ssl-server-session-state-max: <value of integer>
           ssl-server-session-state-timeout: <value of integer>
           ssl-server-session-state-type: <value in [disable, time, count, ...]>
           type: <value in [static-nat, server-load-balance]>
           uuid: <value of string>
           weblogic-server: <value in [disable, enable]>
           websphere-server: <value in [disable, enable]>

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)