bigip_sslo_service_tap – Manage an SSL Orchestrator TAP security device

New in version 1.6.0.

Synopsis

  • Manage an SSL Orchestrator TAP security device

Parameters

Parameter Choices/Defaults Configuration Comments
devices
dictionary
Specifies the network attachment for the TAP security device.
interface
string
Defines the interface on the to-service side.
Mutually exclusive with vlan.
tag
integer
Defines the VLAN tag on the to-service side.
Mutually exclusive with vlan.
vlan
string
Defines an existing VLAN to attach the TAP service to.
Mutually exclusive with tag or interface parameter.
dump_json
boolean
    Choices:
  • no ←
  • yes
Sets the module to output a JSON blob for further consumption.
When yes, does not make any changes on the device and always returns changed=False.
The output provided is idempotent in nature, meaning if there are no changes to be made during MODIFY on an existing service, no JSON output is generated.
mac_address
string
Specifies the MAC address to use for the TAP service clone pool (static ARP).
name
string / required
Specifies the name of the TAP security service.
The configuration auto-prepends "ssloS_" to the service.
The service name should be less than 14 characters and not contain dashes "-".
port_remap
integer
Specifies the port number to remap to for traffic to this TAP service.
state
string
    Choices:
  • absent
  • present ←
Specifies the present/absent state required.
timeout
integer
Default:
300
The number of seconds to wait for the CREATE or MODIFY task to complete.
The accepted value range is between 10 and 1800 seconds.
vendor_info
string
Specifies the vendor-specific TAP service used. The default is Generic TAP Service.

Examples

- hosts: all
  collections:
    - f5networks.f5_bigip
  connection: httpapi

  vars:
    ansible_host: "lb.mydomain.com"
    ansible_user: "admin"
    ansible_httpapi_password: "secret"
    ansible_network_os: f5networks.f5_bigip.bigip
    ansible_httpapi_use_ssl: yes

  tasks:
    - name: SSLO TAP service with interface
      bigip_sslo_service_tap:
        name: "tap_test_interface"
        devices:
          interface: "1.1"
          tag: 400
        mac_address: "xx:xx:xx:xx:xx:xx"
    - name: create TAP service VLAN
      bigip_vlan:
        name: TAPservice_vlan
        tagged_interface: 1.7
    - name: SSLO TAP service with vlan
      bigip_sslo_service_tap:
        name: "tap_test_vlan"
        devices:
          vlan: "/Common/TAPservice_vlan"
        mac_address: "xx:xx:xx:xx:xx:xx"
        port_remap: 8081
        state: "absent"

Return Values

The following are the fields unique to this module:

Key Returned Description
devices
complex
changed
Network settings for TAP service configuration.

  interface
string
Defines a TAP service interface.

Sample:
1.3
  ipv4_deviceip
string
Defines the to-service VLAN self IP.

Sample:
198.19.64.7
  ipv6_deviceip
string
Defines the to-service VLAN self IP netmask.

Sample:
255.255.255.128
  tag
integer
Defines a TAG used VLAN in TAP service.

Sample:
40
  vlan
string
Defines an existing TAP service VLAN.

Sample:
/Common/tapservice-vlan
mac_address
string
changed
Changed MAC address value of TAP services.

Sample:
12:12:12:12:12:12
port_remap
integer
changed
Port remap settings.

Sample:
8080


Status

Authors

  • Ravinder Reddy (@chinthalapalli)
  • Kevin Stewart (@kevingstewart)