fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_webproxy_forwardserver Configure forward-server addresses. | "added in version" 2.0.0 of fortinet.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communityfortinet.fortimanager.fmgr_webproxy_forwardserver (2.4.0) — module
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections: - name: fortinet.fortimanager version: 2.4.0
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.
- name: Example playbook (generated based on argument schema) hosts: fortimanagers connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Configure forward-server addresses. fortinet.fortimanager.fmgr_webproxy_forwardserver: # 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: present # <value in [present, absent]> webproxy_forwardserver: addr_type: <value in [fqdn, ip, ipv6]> comment: <string> fqdn: <string> healthcheck: <value in [disable, enable]> ip: <string> monitor: <string> name: <string> port: <integer> server_down_option: <value in [block, pass]> password: <list or string> username: <string> ipv6: <string> masquerade: <value in [disable, enable]>
adom: description: The parameter (adom) in requested url. required: true type: str state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int type: list enable_log: default: false description: Enable/Disable logging for task. type: bool access_token: description: The token to access FortiManager without using username and password. type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool webproxy_forwardserver: description: The top level parameters set. required: false suboptions: addr-type: choices: - fqdn - ip - ipv6 description: Deprecated, please rename it to addr_type. Address type of the forwarding proxy server type: str comment: description: Comment. type: str fqdn: description: Forward server Fully Qualified Domain Name type: str healthcheck: choices: - disable - enable description: Enable/disable forward server health checking. type: str ip: description: Forward proxy server IP address. type: str ipv6: description: Forward proxy server IPv6 address. type: str masquerade: choices: - disable - enable description: Enable/disable use of the of the IP address of the outgoing interface as the client IP address type: str monitor: description: URL for forward server health check monitoring type: str name: description: Server name. required: true type: str password: description: (list) HTTP authentication password. type: raw port: description: Port number that the forwarding server expects to receive HTTP sessions on type: int server-down-option: choices: - block - pass description: Deprecated, please rename it to server_down_option. Action to take when the forward server is found to be down type: str username: description: HTTP authentication user name. type: str type: dict workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. type: int
meta: contains: request_url: description: The full url requested. returned: always sample: /sys/login/user type: str response_code: description: The status of api request. returned: always sample: 0 type: int response_data: description: The api response. returned: always type: list response_message: description: The descriptive message of the api response. returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: complex type: list