f5os_auth_server – Manage Auth Server Groups and Server inside it.

New in version 1.15.0.

Synopsis

  • Manage Auth Server Groups and Server inside it on F5OS based systems.

Parameters

Parameter Choices/Defaults Configuration Comments
force_update
boolean
    Choices:
  • no ←
  • yes
If true, Update will be triggered forcefully irrespective of any changes.
name
string / required
Name of the Server Group.
provider_type
string / required
    Choices:
  • tacacs
  • radius
  • ldap
  • ocsp
Name of the Provider Type.
server
list / elements=dictionary
Server
port
integer
Port number to be used for Server.
secret
string
Secret key is the shared secret used to access the server.
server_ip
string
Server IP/Address.
timeout
integer
Timeout specifies seconds to wait for a response from the server.
type
string
    Choices:
  • ldap over tcp
  • ldap over ssl
Options are LDAP over TCP or LDAP over SSL (requires SSL certificate) depending on which protocol the LDAP server uses.
state
string
    Choices:
  • present ←
  • absent
Server Group and Servers state of F5OS system.
If present, Specified Server Groups and Server will be pushed to F5OS system.
If absent, deletes the Server Group and Servers if they exists.

Notes

Note

  • Server IP, Secret, Port and Timeout are required for Radius Server Group.
  • Server IP, Secret, Port are required for Tacacs Server Group.
  • Changes in Secret Key for Radius and Tacacs Server Group are not detected, so we need to force update in that case.
  • Server IP, Port and Type are required for LDAP Server Group.
  • User needs to specify which all servers are to be kept, rest will be deleted.
  • If not servers are specified, then all the servers would be deleted.

Examples

- name: Create Radius Server Group and Servers inside it
  f5os_auth_server:
    name: "test_server"
    provider_type: "radius"
    server:
      - server_ip: "1.1.1.1"
        port: 1000
        secret: "test"
        timeout: 5

- name: Create Tacacs Server Group and Servers inside it
  f5os_auth_server:
    name: "test_server"
    provider_type: "radius"
    server:
      - server_ip: "1.1.1.1"
        port: 1000
        secret: "test"

- name: Create Ldap Server Group and Servers inside it
  f5os_auth_server:
    name: "test_server"
    provider_type: "ldap"
    server:
      - server_ip: "1.1.1.1"
        port: 1000
        type: "ldap over tcp"

- name: Create Ocsp Server Group and Servers inside it
  f5os_auth_server:
    name: "test_server"
    provider_type: "ocsp"
    server:
      - server_ip: "1.1.1.1"
        port: 1000

- name: Delete Ocsp Server Group and Servers inside it
  f5os_auth_server:
    name: "test_server"
    provider_type: "ocsp"
    server:
      - server_ip: "1.1.1.1"
        port: 1000
    state: "absent"

Return Values

The following are the fields unique to this module:

Key Returned Description
name
string
changed
Name of the Server Group.
provider_type
string
changed
Name of the Provider Type.
server
list
changed
Server to added for the Server Group


Status

Authors

  • Prateek Ramani (@ramani)