fadcos_real_server_pool_member – real server pool member configuration in Fortinet’s FortiADC

New in version 1.0.0.

Synopsis

  • Configure FortiADC real server pool member

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.8

FortiADC Version Compatibility


v7.0.0 v7.0.1 v7.0.2 v7.1.0 v7.1.4 v7.2.2 v7.4.0
fortiadc_real_server_pool_member yes yes yes yes yes yes yes

Parameters

  • action - Type of action to perform on the object.type: str required: true
  • pool_name - pool nametype: str required: true
  • member_id - pool member idtype: str required: true
  • port - pool member service porttype: str required: false default: 80
  • rs - real servertype: str required: true
  • status - (en|dis)able/maintain pool membertype: str required: false default: enable
  • recover - pool member recover time 0-86400type: str required: false default: 0
  • rs_profile_inherit - real server SSL profile inherit(enable/disable)type: str required: false default: enable
  • rs_profile - real server SSL profile nametype: str required: true
  • warmrate - pool member warm up rate 0-86400type: str required: false default: 100
  • weight - pool member weight 1-256type: str required: false default: 1
  • warmup - pool member warm up time 0-86400type: str required: false default: 0
  • backup - set as backup server(enable/disable)type: str required: false default: disable
  • connlimit - connection limit 0-1048576 type: str required: false default: 0
  • connection_ratelimit - pool member connection rate limit(0 - 86400, disable), only work for L4VStype: str required: false default: 0
  • cookie - pool member cookietype: str required: false
  • health_check_inherit - health check inherit (enable/disable)type: str required: false default: enable
  • health_check - health check control (enable/disable)type: str required: false default: disable
  • health_check_list - health check listtype: str required: true(if health_check enable)
  • health_check_relationship - health check relationship (AND/OR)type: str required: false default: AND
  • mysql_group_id - pool member mysql group idtype: str required: false default: 0
  • mysql_read_only - set as read only mysql server(enable/disable)type: str required: false default: disable
  • vdom - VDOM name if enabled.type: str required: true(if VDOM is enabled)

Examples

- name:
  hosts: all
  connection: httpapi
  gather_facts: false
  tasks:
        - name: Manage real server pool member
          fadcos_real_server_pool_member:
                action: delete
                pool_name: rs_pool
                member_id: 3
                rs: 999

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:

  • 200 - OK: Request returns successful.
  • 400 - Bad Request: Request cannot be processed by the API.
  • 401 - Not Authorized: Request without successful login session.
  • 403 - Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
  • 404 - Resource Not Found: Unable to find the specified resource.
  • 405 - Method Not Allowed: Specified HTTP method is not allowed for this resource.
  • 413 - Request Entity Too Large: Request cannot be processed due to large entity.
  • 424 - Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, or invalid attribute value.
  • 429 - Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
  • 500 - Internal Server Error: Internal error when processing the request.

For errorcode please check FortiADC API errorcode at : https://fndn.fortinet.net/index.php?/fortiapi/981-fortiadc/

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Jie Li
  • Aravindh Sri

Hint

If you notice any issues in this documentation, you can create a pull request to improve it at: https://github.com/fortinet-ansible-dev/ansible-galaxy-fortiadc-sphinxdoc/pulls