fortinet.fortimanager.fmgr_dynamic_virtualwanlink_members – 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_dynamic_virtualwanlink_members.

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
dynamic_virtualwanlink_members
dictionary
the top level parameters set
comment
string
no description
cost
integer
no description
detect-failtime
integer
no description
detect-http-get
string
no description
detect-http-match
string
no description
detect-http-port
integer
no description
detect-interval
integer
no description
detect-protocol
string
    Choices:
  • ping
  • tcp-echo
  • udp-echo
  • http
no description
detect-recoverytime
integer
no description
detect-server
string
no description
detect-timeout
integer
no description
dynamic_mapping
list / elements=string
no description
_scope
list / elements=string
no description
name
string
no description
vdom
string
no description
comment
string
no description
cost
integer
no description
detect-failtime
integer
no description
detect-http-get
string
no description
detect-http-match
string
no description
detect-http-port
integer
no description
detect-interval
integer
no description
detect-protocol
string
    Choices:
  • ping
  • tcp-echo
  • udp-echo
  • http
no description
detect-recoverytime
integer
no description
detect-server
string
no description
detect-timeout
integer
no description
gateway
string
no description
gateway6
string
no description
ingress-spillover-threshold
integer
no description
interface
string
no description
priority
integer
no description
source
string
no description
source6
string
no description
spillover-threshold
integer
no description
status
string
    Choices:
  • disable
  • enable
no description
volume-ratio
integer
no description
weight
integer
no description
gateway
string
no description
gateway6
string
no description
ingress-spillover-threshold
integer
no description
interface
string
no description
name
string
no description
priority
integer
no description
source
string
no description
source6
string
no description
spillover-threshold
integer
no description
status
string
    Choices:
  • disable
  • enable
no description
volume-ratio
integer
no description
weight
integer
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
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_dynamic_virtualwanlink_members:
        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]>
        dynamic_virtualwanlink_members:
           comment: <value of string>
           cost: <value of integer>
           detect-failtime: <value of integer>
           detect-http-get: <value of string>
           detect-http-match: <value of string>
           detect-http-port: <value of integer>
           detect-interval: <value of integer>
           detect-protocol: <value in [ping, tcp-echo, udp-echo, ...]>
           detect-recoverytime: <value of integer>
           detect-server: <value of string>
           detect-timeout: <value of integer>
           dynamic_mapping:
             -
                 _scope:
                   -
                       name: <value of string>
                       vdom: <value of string>
                 comment: <value of string>
                 cost: <value of integer>
                 detect-failtime: <value of integer>
                 detect-http-get: <value of string>
                 detect-http-match: <value of string>
                 detect-http-port: <value of integer>
                 detect-interval: <value of integer>
                 detect-protocol: <value in [ping, tcp-echo, udp-echo, ...]>
                 detect-recoverytime: <value of integer>
                 detect-server: <value of string>
                 detect-timeout: <value of integer>
                 gateway: <value of string>
                 gateway6: <value of string>
                 ingress-spillover-threshold: <value of integer>
                 interface: <value of string>
                 priority: <value of integer>
                 source: <value of string>
                 source6: <value of string>
                 spillover-threshold: <value of integer>
                 status: <value in [disable, enable]>
                 volume-ratio: <value of integer>
                 weight: <value of integer>
           gateway: <value of string>
           gateway6: <value of string>
           ingress-spillover-threshold: <value of integer>
           interface: <value of string>
           name: <value of string>
           priority: <value of integer>
           source: <value of string>
           source6: <value of string>
           spillover-threshold: <value of integer>
           status: <value in [disable, enable]>
           volume-ratio: <value of integer>
           weight: <value of integer>

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/2.11/collections/fortinet/fortimanager/fmgr_dynamic_virtualwanlink_members_module.html