faz_cli_system_webproxy – Configure system web proxy.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiAnalyzer 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
- 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 FortiAnalyzer API structure, module continues to execute without validating parameters type: bool required: false default: False
- 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
- cli_system_webproxy - Configure system web proxy. type: dict
- address - web proxy address. type: str more...
- mode - Web proxy mode (default = tunnel) type: str choices: [proxy, tunnel] default: tunnel more...
- password - No description for the parameter type: str more...
- port - The port number of the web proxy (1 - 65535, default = 1080). type: int default: 1080 more...
- status - Enable/disable system web proxy (default = disable). type: str choices: [disable, enable] default: disable more...
- username - The user name used for authentication. type: str more...
Notes¶
Note
- 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: fortianalyzer-inventory
collections:
- fortinet.fortianalyzer
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure system web proxy.
faz_cli_system_webproxy:
bypass_validation: False
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
cli_system_webproxy:
address: <value of string>
mode: <value in [proxy, tunnel]>
password: <value of string>
port: <value of integer>
status: <value in [disable, enable]>
username: <value of string>
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