f5networks.f5_modules.bigip_profile_udp (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

Manage UDP profiles on a BIG-IP system. There are many UDP profiles, each with their own adjustments to the standard C(udp) profile. Users of this module should be aware that many of the available options have no module default. Instead, the default is assigned by the BIG-IP system itself which, in most cases, is acceptable.

Usage examples

Scanned by Steampunk Spotter

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

- name: Create a TCP profile
  bigip_profile_tcp:
    name: foo
    parent: udp
    idle_timeout: 300
    datagram_load_balancing: false
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

Inputs

    
name:
    description:
    - Specifies the name of the profile.
    required: true
    type: str

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

parent:
    description:
    - Specifies the profile from which this profile inherits settings.
    - When creating a new profile, if this parameter is not specified, the default is
      the system-supplied C(udp) profile.
    type: str

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

idle_timeout:
    description:
    - Specifies the length of time a connection is idle (has no traffic) before the connection
      is eligible for deletion.
    - When creating a new profile, if this parameter is not specified, the remote device
      will choose a default value appropriate for the profile, based on its C(parent)
      profile.
    - When a number is specified, indicates the number of seconds the UDP connection can
      remain idle before the system deletes it.
    - When C(indefinite), specifies UDP connections can remain idle indefinitely.
    - When C(0) or C(immediate), specifies you do not want the UDP connection to remain
      idle, and it is therefore immediately eligible for deletion.
    type: str

datagram_load_balancing:
    description:
    - When C(true), specifies the system load balances UDP traffic packet-by-packet.
    type: bool

Outputs

datagram_load_balancing:
  description: The new datagram load balancing setting of the resource.
  returned: changed
  sample: true
  type: bool
idle_timeout:
  description: The new idle timeout of the resource.
  returned: changed
  sample: 100
  type: int
parent:
  description: The new parent of the resource.
  returned: changed
  sample: udp
  type: str