bigip_sslo_config_service_chain – Manage an SSL Orchestrator service chain

New in version 1.6.0.

Synopsis

  • Manage an SSL Orchestrator service chain.

Parameters

Parameter Choices/Defaults Configuration Comments
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 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.
name
string / required
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 "-".
services
list / elements=dictionary
Specifies the client-side SSL settings.
This parameter is required when state is present
ip_family
string
    Choices:
  • ipv4
  • ipv6
Defines the IP family for this service.
If missing, ipv4 is assumed.
service_name
string
Defines the name of the service.
type
string
    Choices:
  • L2
  • L3
  • http-proxy
  • icap
  • tap
Defines the type of service.
state
string
    Choices:
  • present ←
  • absent
When state is present, ensures the object is created or modified.
When state is absent, ensures the service is removed.
timeout
integer
Default:
300
The amount of time to wait for the CREATE, MODIFY or DELETE task to complete, in seconds.
The accepted value range is between 10 and 1800 seconds.

Notes

Note

  • Service chain creation/management does not verify the defined services exist.

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

Return Values

The following are the fields unique to this module:

Key Returned Description
name
string
changed
Changed name of service chain.

Sample:
demo_chain_1
services
complex
changed
List of services to include in the service chain

  ip_family
string
The IP family for the specified service. Options are 'ipv4', or 'ipv6'.

Sample:
ipv4
  service_name
string
The name of the service.

Sample:
icap3
  type
string
The service type for the specified service.

Sample:
icap


Status

Authors

  • Wojciech Wypior (@wojtek0806)
  • Kevin Stewart (@kevingstewart)