fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_firewall_vip_realservers Select the real servers that this server load balancing VIP will distribute traffic to. | "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_firewall_vip_realservers (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 hosts: fortimanagers connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Select the real servers that this server load balancing VIP will distribute traffic to. fortinet.fortimanager.fmgr_firewall_vip_realservers: bypass_validation: false adom: ansible vip: "ansible-test-vip" # name state: present firewall_vip_realservers: # available only when type is set to 'server-load-balance' in vip healthcheck: enable # <value in [disable, enable, vip]> ip: "222.222.222.1" port: 1 seq: 1 status: active # <value in [active, standby, disable]>
- name: Gathering fortimanager facts hosts: fortimanagers gather_facts: false connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Retrieve all the real servers of IPv4 virtual ip fortinet.fortimanager.fmgr_fact: facts: selector: "firewall_vip_realservers" # available only when type is set to 'server-load-balance' in vip params: adom: "ansible" vip: "ansible-test-vip" # name realservers: "your_value"
vip: description: The parameter (vip) in requested url. required: true type: str 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 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 firewall_vip_realservers: description: The top level parameters set. required: false suboptions: address: description: Dynamic address of the real server. type: str client-ip: description: (list) Deprecated, please rename it to client_ip. type: raw healthcheck: choices: - disable - enable - vip description: Enable to check the responsiveness of the real server before forwarding traffic. type: str holddown-interval: description: Deprecated, please rename it to holddown_interval. Time in seconds that the health check monitor continues to monitor and ... type: int http-host: description: Deprecated, please rename it to http_host. HTTP server domain name in HTTP header. type: str id: description: Real server ID. type: int ip: description: IP address of the real server. type: str max-connections: description: Deprecated, please rename it to max_connections. Max number of active connections that can be directed to the real server. type: int monitor: description: (list or str) Name of the health check monitor to use when polling to determine a virtual servers connectivity status. type: raw port: description: Port for communicating with the real server. type: int seq: description: No description. required: true type: int status: choices: - active - standby - disable description: Set the status of the real server to active so that it can accept traffic, or on standby or disabled so no traffic is sent. type: str translate-host: choices: - disable - enable description: Deprecated, please rename it to translate_host. Enable/disable translation of hostname/IP from virtual server to real server. type: str type: choices: - ip - address description: Type of address. type: str weight: description: Weight of the real server. type: int type: dict 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