f5networks.f5_bigip.bigip_sslo_service_swg (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 Secure Web Gateway service.

Usage examples

Scanned by Steampunk Spotter

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

- name: Create SSLO SWG service with defaults
  bigip_sslo_service_swg:
    name: "swg2"
    swg_policy: "/Common/test-swg"

Scanned by Steampunk Spotter

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

- name: Modify SSLO SWG service
  bigip_sslo_service_swg:
    name: "swg2"
    profile_scope: "named"
    named_scope: "SSLO"
    access_profile: "/Common/test-access"
    log_settings:
      - "/Common/default-log-setting1"
      - "/Common/default-log-setting2"
    rules:
      - "/Common/test-rule"

Scanned by Steampunk Spotter

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

- name: Delete SSLO SWG service
  bigip_sslo_service_swg:
    name: "swg2"
    state: "absent"

Inputs

    
name:
    description:
    - Specifies the name of the SWG service object.
    - The configuration auto-prepends C(ssloS_) to the object.
    - Names should be less than 14 characters and not contain dashes C(-).
    required: true
    type: str

rules:
    description:
    - Specifies custom iRules to apply to the SWG service.
    elements: str
    type: list

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

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

swg_policy:
    description:
    - Specifies the name of the SWG per-request policy to attach to the service configuration.
    - This parameter is required when creating a new service.
    type: str

named_scope:
    description:
    - Required when C(profile_scope) is C(named), and specifies a name string the authentication
      and SWG policies share to allow access to identity information.
    - This parameter is ignored when C(profile_scope) is C(profile).
    type: str

log_settings:
    description:
    - Specifies a custom log setting for the SWG service.
    elements: str
    type: list

profile_scope:
    choices:
    - profile
    - named
    description:
    - Specifies the level of information sharing. When using named scope, an authentication
      access profile attached to the topology can share its user identity information
      with the SWG policy.
    type: str

access_profile:
    description:
    - Specifies a custom SWG-Transparent access profile to apply to the SWG service.
    - During creation of a new SWG service, when the parameter is not specified, the configuration
      auto generates the access profile.
    type: str

swg_policy_type:
    choices:
    - standard
    - modern
    description:
    - The custom type of per-request policy attached to the SWG service configuration.
    required: true
    type: str

service_down_action:
    choices:
    - ignore
    - reset
    - drop
    description:
    - Specifies the action taken if the SWG service fails.
    type: str

Outputs

access_profile:
  description:
  - A custom SWG-Transparent access profile to apply to the SWG service.
  returned: changed
  sample: /Common/my-access-profile
  type: str
log_settings:
  description:
  - The custom log setting for the SWG service.
  returned: changed
  sample: /Common/my-log-settings
  type: str
named_scope:
  description:
  - The name string the authentication and SWG policies share to allow access to identity
    information.
  returned: changed
  sample: SSLO
  type: str
profile_scope:
  description:
  - The the level of information sharing.
  returned: changed
  sample: named
  type: str
rules:
  description:
  - The custom iRules to apply to the SWG service.
  returned: changed
  sample: /Common/my-swg-rule1
  type: str
service_down_action:
  description:
  - The action taken if the SWG service fails.
  returned: changed
  sample: reset
  type: str
swg_policy:
  description:
  - The name of the SWG per-request policy attached to the service configuration.
  returned: changed
  sample: /Common/my-swg-policy
  type: str
swg_policy_type:
  description:
  - The name of the SWG per-request policy attached to the service configuration.
  returned: changed
  sample: /Common/my-swg-policy
  type: str