fortinet.fortimanager.fmgr_firewall_vip_realservers – Select the real servers that this server load balancing VIP will distribute traffic to.
Note
This plugin is part of the fortinet.fortimanager collection (version 2.1.4).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_firewall_vip_realservers
.
New in version 2.10: of fortinet.fortimanager
Synopsis
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.
Parameters
Parameter |
Comments |
---|---|
the parameter (adom) in requested url |
|
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters Choices:
|
|
Enable/Disable logging for task Choices:
|
|
the top level parameters set |
|
Dynamic address of the real server. |
|
no description |
|
Enable to check the responsiveness of the real server before forwarding traffic. Choices:
|
|
Time in seconds that the health check monitor continues to monitor and unresponsive server that should be active. |
|
HTTP server domain name in HTTP header. |
|
Real server ID. |
|
IP address of the real server. |
|
Max number of active connections that can be directed to the real server. When reached, sessions are sent to other real servers. |
|
Name of the health check monitor to use when polling to determine a virtual servers connectivity status. |
|
Port for communicating with the real server. Required if port forwarding is enabled. |
|
Seq. |
|
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. Choices:
|
|
Type of address. Choices:
|
|
Weight of the real server. If weighted load balancing is enabled, the server with the highest weight gets more connections. |
|
The overridden method for the underlying Json RPC request Choices:
|
|
the rc codes list with which the conditions to fail will be overriden |
|
the rc codes list with which the conditions to succeed will be overriden |
|
the directive to create, update or delete an object Choices:
|
|
the parameter (vip) in requested url |
|
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
|
the maximum time in seconds to wait for other user to release the workspace lock Default: 300 |
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: fortimanager00
collections:
- fortinet.fortimanager
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.
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: fortimanager00
gather_facts: no
connection: httpapi
collections:
- fortinet.fortimanager
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
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: ''
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The full url requested Returned: always Sample: “/sys/login/user” |
|
The status of api request Returned: always Sample: 0 |
|
The descriptive message of the api response Returned: always Sample: “OK.” |
Authors
Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)