fortinet.fortimanager.fmgr_firewall_vip6_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.3).

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_vip6_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		Choices/Defaults	Comments
adom string / required			the parameter (adom) in requested url
bypass_validation boolean		Choices: no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log boolean		Choices: no ← yes	Enable/Disable logging for task
firewall_vip6_realservers dictionary			the top level parameters set
	client-ip string		Only clients in this IP range can connect to this real server.
	healthcheck string	Choices: disable enable vip	Enable to check the responsiveness of the real server before forwarding traffic.
	holddown-interval integer		Time in seconds that the health check monitor continues to monitor an unresponsive server that should be active.
	http-host string		HTTP server domain name in HTTP header.
	id integer		Real server ID.
	ip string		IPv6 address of the real server.
	max-connections integer		Max number of active connections that can directed to the real server. When reached, sessions are sent to other real servers.
	monitor string		Name of the health check monitor to use when polling to determine a virtual servers connectivity status.
	port integer		Port for communicating with the real server. Required if port forwarding is enabled.
	status string	Choices: active standby disable	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.
	weight integer		Weight of the real server. If weighted load balancing is enabled, the server with the highest weight gets more connections.
proposed_method string		Choices: update set add	The overridden method for the underlying Json RPC request
rc_failed list / elements=string			the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string			the rc codes list with which the conditions to succeed will be overriden
state string / required		Choices: present absent	the directive to create, update or delete an object
vip6 string / required			the parameter (vip6) in requested url
workspace_locking_adom string			the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout integer		Default: 300	the maximum time in seconds to wait for other user to release the workspace lock

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: Select the real servers that this server load balancing VIP will distribute traffic to.
     fmgr_firewall_vip6_realservers:
        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>
        vip6: <your own value>
        state: <value in [present, absent]>
        firewall_vip6_realservers:
           client-ip: <value of string>
           healthcheck: <value in [disable, enable, vip]>
           holddown-interval: <value of integer>
           http-host: <value of string>
           id: <value of integer>
           ip: <value of string>
           max-connections: <value of integer>
           monitor: <value of string>
           port: <value of integer>
           status: <value in [active, standby, disable]>
           weight: <value of integer>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
request_url string	always	The full url requested Sample: /sys/login/user
response_code integer	always	The status of api request
response_message string	always	The descriptive message of the api response Sample: OK.

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_firewall_vip6_realservers_module.html

Docs

Docs4dev

Title here