f5networks.f5_bigip.bigip_sslo_service_tap (3.4.0) — module

Install collection

Install with ansible-galaxy collection install f5networks.f5_bigip:==3.4.0

Add to requirements.yml

  collections:
    - name: f5networks.f5_bigip
      version: 3.4.0

Description

Manage an SSL Orchestrator TAP security device

Usage examples

Scanned by Steampunk Spotter

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

- 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"

Scanned by Steampunk Spotter

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

- name: Create TAP service VLAN
  bigip_vlan:
    name: TAPservice_vlan
    tagged_interface: 1.7

Scanned by Steampunk Spotter

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

- 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"

Inputs

    
name:
    description:
    - 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 "-".
    required: true
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Specifies the present/absent state required.
    type: str

devices:
    description:
    - Specifies the network attachment for the TAP security device.
    suboptions:
      interface:
        description:
        - Defines the interface on the to-service side.
        - Mutually exclusive with C(vlan).
        type: str
      tag:
        description:
        - Defines the VLAN tag on the to-service side.
        - Mutually exclusive with C(vlan).
        type: int
      vlan:
        description:
        - Defines an existing VLAN to attach the TAP service to.
        - Mutually exclusive with C(tag) or C(interface) parameter.
        type: str
    type: dict

timeout:
    default: 300
    description:
    - The number of seconds to wait for the C(CREATE) or C(MODIFY) task to complete.
    - The accepted value range is between C(10) and C(1800) seconds.
    type: int

dump_json:
    default: false
    description:
    - Sets the module to output a JSON blob for further consumption.
    - When C(true), does not make any changes on the device and always returns C(changed=False).
    - The output provided is idempotent in nature, meaning if there are no changes to
      be made during C(MODIFY) on an existing service, no JSON output is generated.
    type: bool

port_remap:
    description:
    - Specifies the port number to remap to for traffic to this TAP service.
    type: int

mac_address:
    description:
    - Specifies the MAC address to use for the TAP service clone pool (static ARP).
    type: str

vendor_info:
    description:
    - Specifies the vendor-specific TAP service used. The default is C(Generic TAP Service).
    type: str

Outputs

devices:
  contains:
    interface:
      description: Defines a TAP service interface.
      sample: 1.3
      type: str
    ipv4_deviceip:
      description: Defines the to-service VLAN self IP.
      sample: 198.19.64.7
      type: str
    ipv6_deviceip:
      description: Defines the to-service VLAN self IP netmask.
      sample: 255.255.255.128
      type: str
    tag:
      description: Defines a TAG used VLAN in TAP service.
      sample: 40
      type: int
    vlan:
      description: Defines an existing TAP service VLAN.
      sample: /Common/tapservice-vlan
      type: str
  description:
  - Network settings for TAP service configuration.
  returned: changed
  type: complex
mac_address:
  description:
  - Changed MAC address value of TAP services.
  returned: changed
  sample: '12:12:12:12:12:12'
  type: str
port_remap:
  description:
  - Port remap settings.
  returned: changed
  sample: 8080
  type: int