Documentation

bigip_gtm_wide_ip - Manages F5 BIG-IP GTM wide ip

New in version 2.0.

Synopsis

  • Manages F5 BIG-IP GTM wide ip

Options

parameter required default choices comments
lb_method
yes
  • return_to_dns
  • null
  • round_robin
  • ratio
  • topology
  • static_persist
  • global_availability
  • vs_capacity
  • least_conn
  • lowest_rtt
  • lowest_hops
  • packet_rate
  • cpu
  • hit_ratio
  • qos
  • bps
  • drop_packet
  • explicit_ip
  • connection_rate
  • vs_score
LB method of wide ip
password
yes
The password for the user account used to connect to the BIG-IP. This option can be omitted if the environment variable F5_PASSWORD is set.
server
yes
The BIG-IP host. This option can be omitted if the environment variable F5_SERVER is set.
server_port
(added in 2.2)
no 443
The BIG-IP server port. This option can be omitted if the environment variable F5_SERVER_PORT is set.
user
yes
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. This option can be omitted if the environment variable F5_USER is set.
validate_certs
(added in 2.0)
no True
  • True
  • False
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. This option can be omitted if the environment variable F5_VALIDATE_CERTS is set.
wide_ip
yes
Wide IP name

Examples

- name: Set lb method
  local_action: >
    bigip_gtm_wide_ip
    server=192.0.2.1
    user=admin
    password=mysecret
    lb_method=round_robin
    wide_ip=my-wide-ip.example.com

Notes

Note

  • Requires BIG-IP software version >= 11.4
  • F5 developed module ‘bigsuds’ required (see http://devcentral.f5.com)
  • Best run as a local_action in your playbook
  • Tested with manager and above account privilege level

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.