f5networks.f5_modules.bigip_device_auth_radius_server (1.28.0) — module

Install collection

Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0

Add to requirements.yml

  collections:
    - name: f5networks.f5_modules
      version: 1.28.0

Description

Manages a device's RADIUS server configuration.

Used in tandem with the C(bigip_device_auth_radius) module.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create a RADIUS server configuration
  bigip_device_auth_radius_server:
    name: "ansible_test"
    ip: "1.1.1.1"
    port: 1812
    secret: "secret"
    timeout: 5
    update_secret: on_create
    state: present
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Update RADIUS server configuration
  bigip_device_auth_radius_server:
    name: "ansible_test"
    ip: "10.10.10.1"
    description: "this is a test"
    port: 1813
    timeout: 10
    state: present
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Remove RADIUS server configuration
  bigip_device_auth_radius_server:
    name: "ansible_test"
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Inputs

    
ip:
    description:
    - The IP address of the server.
    - This parameter is mandatory when creating a new resource.
    type: str

name:
    description:
    - Specifies the name of the RADIUS server to manage.
    required: true
    type: str

port:
    description:
    - The port of the server.
    - Valid range of values is between C(0) and C(65535) inclusive.
    type: int

state:
    choices:
    - present
    - absent
    default: present
    description:
    - When C(state) is C(present), ensures the RADIUS server exists.
    - When C(state) is C(absent), ensures the RADIUS server is removed.
    type: str

secret:
    description:
    - Specifies the secret used for accessing RADIUS server.
    - This parameter is mandatory when creating a new resource.
    type: str

timeout:
    description:
    - Specifies the timeout value in seconds.
    - Valid range of values is between C(1) and C(60) inclusive.
    type: int

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      auth_provider:
        description:
        - Configures the auth provider for to obtain authentication tokens from the remote
          device.
        - This option is really used when working with BIG-IQ devices.
        type: str
      no_f5_teem:
        default: false
        description:
        - If C(yes), TEEM telemetry data is not sent to F5.
        - You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
        - Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
        type: bool
      password:
        aliases:
        - pass
        - pwd
        description:
        - The password for the user account used to connect to the BIG-IP or the BIG-IQ.
        - You may omit this option by setting the environment variable C(F5_PASSWORD).
        required: true
        type: str
      server:
        description:
        - The BIG-IP host or the BIG-IQ host.
        - You may omit this option by setting the environment variable C(F5_SERVER).
        required: true
        type: str
      server_port:
        default: 443
        description:
        - The BIG-IP server port.
        - You may omit this option by setting the environment variable C(F5_SERVER_PORT).
        type: int
      timeout:
        description:
        - Specifies the timeout in seconds for communicating with the network device for
          either connecting or sending commands.  If the timeout is exceeded before the
          operation is completed, the module will error.
        type: int
      transport:
        choices:
        - rest
        default: rest
        description:
        - Configures the transport connection to use when connecting to the remote device.
        type: str
      user:
        description:
        - The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative
          privileges on the device.
        - You may omit this option by setting the environment variable C(F5_USER).
        required: true
        type: str
      validate_certs:
        default: true
        description:
        - If C(no), SSL certificates are not validated. Use this only on personally controlled
          sites using self-signed certificates.
        - You may omit this option by setting the environment variable C(F5_VALIDATE_CERTS).
        type: bool
    type: dict
    version_added: 1.0.0
    version_added_collection: f5networks.f5_modules

partition:
    default: Common
    description:
    - Device partition to manage resources on.
    type: str

description:
    description:
    - The description of the RADIUS server.
    type: str

update_secret:
    choices:
    - always
    - on_create
    default: always
    description:
    - C(always) will update passwords if the C(secret) is specified.
    - C(on_create) will only set the password for newly created servers.
    type: str

Outputs

description:
  description: User defined description of the RADIUS server.
  returned: changed
  sample: this is my server
  type: str
ip:
  description: IP address of the RADIUS Server.
  returned: changed
  sample: 1.1.1.1
  type: str
port:
  description: RADIUS service port.
  returned: changed
  sample: 1812
  type: int
timeout:
  description: Timeout value.
  returned: changed
  sample: 3
  type: int