fmgr_dynamic_virtualwanlink_members_dynamicmapping¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.0.0 |
6.2.1 |
6.2.3 |
6.2.5 |
6.4.0 |
6.4.2 |
6.4.5 |
|
| dynamic_virtualwanlink_members_dynamicmapping | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- adom - The parameter in requested url type: str required: true
- members - The parameter in requested url type: str required: true
- dynamic_virtualwanlink_members_dynamicmapping - no description type: dict
- _scope - No description for the parameter type: array more...
- comment - No description for the parameter type: str more...
- cost - No description for the parameter type: int more...
- detect-failtime - No description for the parameter type: int more...
- detect-http-get - No description for the parameter type: str more...
- detect-http-match - No description for the parameter type: str more...
- detect-http-port - No description for the parameter type: int more...
- detect-interval - No description for the parameter type: int more...
- detect-protocol - No description for the parameter type: str choices: [ping, tcp-echo, udp-echo, http] more...
- detect-recoverytime - No description for the parameter type: int more...
- detect-server - No description for the parameter type: str more...
- detect-timeout - No description for the parameter type: int more...
- gateway - No description for the parameter type: str more...
- gateway6 - No description for the parameter type: str more...
- ingress-spillover-threshold - No description for the parameter type: int more...
- interface - No description for the parameter type: str more...
- priority - No description for the parameter type: int more...
- source - No description for the parameter type: str more...
- source6 - No description for the parameter type: str more...
- spillover-threshold - No description for the parameter type: int more...
- status - No description for the parameter type: str choices: [disable, enable] more...
- volume-ratio - No description for the parameter type: int more...
- weight - No description for the parameter type: int more...
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_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>
members: <your own value>
state: <value in [present, absent]>
dynamic_virtualwanlink_members_dynamicmapping:
_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>
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- request_url - The full url requested returned: always type: str sample: /sys/login/user
- response_code - The status of api request returned: always type: int sample: 0
- response_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict