f5networks.f5_bigip.bigip_sslo_config_service_chain (1.13.0) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: f5networks.f5_bigip
      version: 1.13.0

Description

Manage an SSL Orchestrator service chain.

Usage examples

Scanned by Steampunk Spotter

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

- 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: Create SSLO service chain
      bigip_sslo_config_service_chain:
        name: "demo_chain_1"
        services:
          - service_name: "icap1"
            type: "icap"
            ip_family: "ipv4"
          - service_name: "layer3a"
            type: "L3"
            ip_family: "ipv4"

    - name: Modify SSLO service chain
      bigip_sslo_config_service_chain:
        name: "demo_chain_1"
        services:
          - service_name: "icap1"
            type: "icap"
            ip_family: "ipv4"

    - name: Delete SSLO service chain
      bigip_sslo_config_service_chain:
        name: "demo_chain_1"
        state: absent

Inputs

    
name:
    description:
    - Specifies the name of the service chain.
    - The configuration auto-prepends "ssloSC_" to the service if not present.
    - The service name should be less than 14 characters and not contain dashes "-".
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - When C(state) is C(present), ensures the object is created or modified.
    - When C(state) is C(absent), ensures the service is removed.
    type: str

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

services:
    description:
    - Specifies the client-side SSL settings.
    - This parameter is required when C(state) is C(present)
    elements: dict
    suboptions:
      ip_family:
        choices:
        - ipv4
        - ipv6
        description:
        - Defines the IP family for this service.
        - If missing, C(ipv4) is assumed.
        type: str
      service_name:
        description:
        - Defines the name of the service.
        type: str
      type:
        choices:
        - L2
        - L3
        - http-proxy
        - icap
        - tap
        description:
        - Defines the type of service.
        type: str
    type: list

dump_json:
    default: false
    description:
    - Sets the module to output a JSON blob for further consumption.
    - When C(yes), does not make any changes on 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

Outputs

name:
  description:
  - Changed name of service chain.
  returned: changed
  sample: demo_chain_1
  type: str
services:
  contains:
    ip_family:
      description: The IP family for the specified service. Options are 'ipv4', or
        'ipv6'.
      sample: ipv4
      type: str
    service_name:
      description: The name of the service.
      sample: icap3
      type: str
    type:
      description: The service type for the specified service.
      sample: icap
      type: str
  description: List of services to include in the service chain
  returned: changed
  type: complex