f5networks.f5_modules.bigip_traffic_selector (1.28.0) — module

Manage IPSec Traffic Selectors on BIG-IP

| "added in version" 1.0.0 of f5networks.f5_modules"

Authors: Tim Rupp (@caphrim007), Wojciech Wypior (@wojtek0806)

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 IPSec Traffic Selectors on BIG-IP.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a traffic selector
  bigip_traffic_selector:
    name: selector1
    destination_address: 1.1.1.1
    ipsec_policy: policy1
    order: 1
    source_address: 2.2.2.2
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Inputs

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

order:
    description:
    - Specifies the order in which traffic is matched, if traffic can be matched to multiple
      traffic selectors.
    - Traffic is matched to the traffic selector with the highest priority (lowest order
      number).
    - When creating a new traffic selector, if this parameter is not specified, the default
      is C(last).
    type: int

state:
    choices:
    - present
    - absent
    default: present
    description:
    - When C(present), ensures the resource exists.
    - When C(absent), ensures the resource is removed.
    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

description:
    description:
    - Description of the traffic selector.
    type: str

ipsec_policy:
    description:
    - Specifies the IPsec policy that tells the BIG-IP system how to handle the packets.
    - When creating a new traffic selector, if this parameter is not specified, the default
      is C(default-ipsec-policy).
    type: str

source_address:
    description:
    - Specifies the host or network IP address from which the application traffic originates.
    - When creating a new traffic selector, this parameter is required.
    type: str

destination_address:
    description:
    - Specifies the host or network IP address to which the application traffic is destined.
    - When creating a new traffic selector, this parameter is required.
    type: str

Outputs

destination_address:
  description: The new Destination IP Address.
  returned: changed
  sample: 1.2.3.4/32
  type: str
ipsec_policy:
  description: The new IPSec policy.
  returned: changed
  sample: /Common/policy1
  type: str
order:
  description: The new sort order.
  returned: changed
  sample: 1
  type: int
source_address:
  description: The new Source IP address.
  returned: changed
  sample: 2.3.4.5/32
  type: str