fadcos_load_balance_content_routing – configure content routing in Fortinet’s FortiADC

New in version 1.1.0.

Synopsis

  • Configure Content Routing on Virtual Server in Server Load Balance Page

Requirements

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

  • ansible>=2.8

FortiADC Version Compatibility


v7.1.4 v7.2.2 v7.4.0
fadcos_load_balance_content_routing yes yes yes

Parameters

  • action - Type of action to perform on the object. type: str required: true
  • name - config name type: str required: false
  • connection_pool_inherit - enable to use the connection pool configuration object specified in the virtual server configuration.type: str required: false default: enable
  • type - Layer 4 or Layer 7 content routing.type: str required: false default: l4-content-routing
  • ip - Address/mask notation to match the source IP address in the packet header.type: str required: false default: 0.0.0.0/0
  • ip6 - Address/mask notation to match the source IP address in the packet header.type: str required: false default: ::/0
  • pool - Specify Real Server Pool.type: str required: false default: rs_pool
  • method_inherit - Enable (default) to use the method specified in the virtual server configuration.type: str required: false default: enable
  • persistence_inherit - Enable (default) to use the persistence object specified in the virtual server configuration.type: str required: false default: enable
  • method - If not using inheritance, select a load balancing method type.type: str required: false
  • persistence - If not using inheritance, select a session persistence type.type: str required: false
  • comments - Optional administrator note.type: str required: false
  • schedule_list - Enable/disable schedule pool list.type: str required: false default: disable
  • schedule_pool_list - Specify the schedule pool.type: str required: false
  • source_pool_list - Specify source pool list.type: str required: false
  • names - cotent routing listtype: list required: false
  • vdom - VDOM name if enabled.type: str required: true(if VDOM is enabled)

Examples

- name:
  hosts: all
  vars:
  connection: httpapi
  gather_facts: false
  tasks:
    - name: create
      fadcos_load_balance_content_routing:
       action: add
       name: test1
       type: l4-content-routing
       ip: 172.23.133.178/24
       method_inherit: disable
       method: LB_METHOD_LEAST_CONNECTION
       persistence_inherit: disable
       persistence: LB_PERSIS_SRC_ADDR
       schedule_list: disable
       pool: rs_pool
       comments: nothings

    - name: create
      fadcos_load_balance_content_routing:
       action: add
       name: test2
       type: l7-content-routing
       method_inherit: disable
       method: LB_METHOD_LEAST_CONNECTION
       persistence_inherit: disable
       persistence: LB_PERSIS_SRC_ADDR
       schedule_list: disable
       pool: rs_pool
       comments: nothings

    - name: edit
      fadcos_load_balance_content_routing:
       action: edit
       name: test1
       type: l7-content-routing
       method_inherit: enable
       persistence_inherit: enable
       schedule_list: disable
       pool: rs_pool
       comments: nothings

    - name: get
      fadcos_load_balance_content_routing:
       action: get

    - name: delete
      fadcos_load_balance_content_routing:
       action: remove
       names:
            - test1

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

  • Wayne Chou

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.