# salt.runners.f5

Runner to provide F5 Load Balancer functionality

depends:

  - pycontrol Python module

configuration:

  In order to connect to a F5 Load Balancer, you must specify in the Salt master configuration the currently available load balancers

      load_balancers:
        bigip1.example.com:
          username: admin
          password: secret
        bigip2.example.com:
          username: admin
          password: secret

class salt.runners.f5.F5Mgmt(lb, username, password)
  add_pool_member(name, port, pool_name)

    Add a node to a pool

  check_member_pool(member, pool_name)

    Check a pool member exists in a specific pool

  check_pool(name)

    Check to see if a pool exists

  check_virtualserver(name)

    Check to see if a virtual server exists

  create_pool(name, method='ROUND_ROBIN')

    Create a pool on the F5 load balancer

  create_vs(name, ip, port, protocol, profile, pool_name)

    Create a virtual server

  lbmethods()

    List all the load balancer methods

salt.runners.f5.add_pool_member(lb, name, port, pool_name)

  Add a node to a pool

  CLI Examples:

      salt-run f5.add_pool_member load_balancer 10.0.0.1 80 my_pool

salt.runners.f5.check_member_pool(lb, member, pool_name)

  Check a pool member exists in a specific pool

  CLI Examples:

      salt-run f5.check_member_pool load_balancer 10.0.0.1 my_pool

salt.runners.f5.check_pool(lb, name)

  Check to see if a pool exists

  CLI Examples:

      salt-run f5.check_pool load_balancer pool_name

salt.runners.f5.check_virtualserver(lb, name)

  Check to see if a virtual server exists

  CLI Examples:

      salt-run f5.check_virtualserver load_balancer virtual_server

salt.runners.f5.create_pool(lb, name, method='ROUND_ROBIN')

  Create a pool on the F5 load balancer

  CLI Examples:

      salt-run f5.create_pool load_balancer pool_name loadbalance_method
      salt-run f5.create_pool load_balancer my_pool ROUND_ROBIN

salt.runners.f5.create_vs(lb, name, ip, port, protocol, profile, pool_name)

  Create a virtual server

  CLI Examples:

      salt-run f5.create_vs lbalancer vs_name 10.0.0.1 80 tcp http poolname