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

Requirements (on host that executes module)

  • bigsuds

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
    BIG-IP password
    server
    yes
      BIG-IP host
      user
      yes
        BIG-IP username
        wide_ip
        yes
          Wide IP name

          Examples

          - name: Set lb method
            local_action: >
              bigip_gtm_wide_ip
              server=192.168.0.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

          Note

          F5 developed module ‘bigsuds’ required (see http://devcentral.f5.com)

          Note

          Best run as a local_action in your playbook

          Note

          Tested with manager and above account privilege level

          This is an Extras Module

          For more information on what this means please read Extras Modules

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