fmgr_switchcontroller_dsl_policy – DSL policy.¶
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
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
- switchcontroller_dsl_policy - no description type: dict
- append_padding - device pause frame configuration. type: str choices: [disable, enable] more...
- cpe-aele - cpe AELE. type: str choices: [disable, enable] more...
- cpe-aele-mode - cpe AELE-Mode with given string. type: str choices: [ELE_M0, ELE_DS, ELE_PB, ELE_MIN] more...
- cs - No description for the parameter type: array choices: [A43, B43, A43C, V43] more...
- ds-bitswap - Enable/disable bitswap. type: str choices: [disable, enable] more...
- name - Policy name. type: str more...
- pause-frame - device pause frame configuration. type: str choices: [disable, enable] more...
- profile - vdsl CPE profile. type: str choices: [auto-30a, auto-17a, auto-12ab] more...
- type - Type. type: str choices: [Procend, Proscend] more...
- us-bitswap - Enable/disable bitswap. type: str choices: [disable, enable] 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_switchcontroller_dsl_policy:
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]>
switchcontroller_dsl_policy:
append_padding: <value in [disable, enable]>
cpe-aele: <value in [disable, enable]>
cpe-aele-mode: <value in [ELE_M0, ELE_DS, ELE_PB, ...]>
cs:
- A43
- B43
- A43C
- V43
ds-bitswap: <value in [disable, enable]>
name: <value of string>
pause-frame: <value in [disable, enable]>
profile: <value in [auto-30a, auto-17a, auto-12ab]>
type: <value in [Procend, Proscend]>
us-bitswap: <value in [disable, enable]>
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