zscaler.zpacloud.zpa_lss_config_controller module – Create a LSS CONFIG.

Note

This module is part of the zscaler.zpacloud collection (version 1.4.2).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install zscaler.zpacloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: zscaler.zpacloud.zpa_lss_config_controller.

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module create/update/delete a LSS CONFIG in the ZPA Cloud.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter

Comments

app_connector_group_ids

list / elements=string

App Connector Group(s) to be added to the LSS configuration

client_id

string

The ZPA API client ID generated from the ZPA console.

client_secret

string

The ZPA API client secret generated from the ZPA console.

cloud

string

The ZPA cloud provisioned for your organization.

Choices:

  • "PRODUCTION"

  • "BETA"

  • "QA"

  • "QA2"

  • "GOV"

  • "GOVUS"

  • "PREVIEW"

  • "ZPATWO"

config

dictionary

Name of the LSS configuration

audit_message

string

description

string

Name of the LSS configuration

enabled

boolean

Whether this LSS configuration is enabled or not

Choices:

  • false

  • true

filter

list / elements=string

Filter for the LSS configuration

id

string

lss_host

string / required

Host of the LSS configuration

lss_port

string / required

Port of the LSS configuration

name

string / required

Name of the LSS configuration

source_log_format

string

Format of the log type

Choices:

  • "json"

  • "csv"

  • "tsv"

source_log_type

string / required

Log type of the LSS configuration

Choices:

  • "app_connector_metrics"

  • "app_connector_status"

  • "audit_logs"

  • "browser_access"

  • "private_svc_edge_status"

  • "user_activity"

  • "user_status"

  • "web_inspection"

use_tls

boolean

Whether TLS is enabled or not

Choices:

  • false

  • true

customer_id

string

The ZPA tenant ID found in the Administration Company menu in the ZPA console.

id

string

policy_rule_resource

dictionary

Object Type

action

string

action_id

string

bypass_default_rule

boolean

Choices:

  • false

  • true

conditions

list / elements=dictionary

negated

boolean

Choices:

  • false

  • true

operands

list / elements=dictionary

object_type

string / required

Choices:

  • "APP"

  • "APP_GROUP"

  • "CLIENT_TYPE"

values

list / elements=string

operator

string / required

custom_msg

string

default_rule

boolean

Choices:

  • false

  • true

description

string

Object Type

id

string

lss_default_rule

boolean

Choices:

  • false

  • true

name

string / required

operator

string

policy_set_id

string

policy_type

string

priority

string

reauth_default_rule

boolean

Choices:

  • false

  • true

reauth_idle_timeout

string

reauth_timeout

string

rule_order

string

provider

dictionary

A dict object containing authentication details.

client_id

string

The ZPA API client ID generated from the ZPA console.

client_secret

string

The ZPA API client secret generated from the ZPA console.

cloud

string

The ZPA cloud provisioned for your organization.

Choices:

  • "PRODUCTION"

  • "BETA"

  • "QA"

  • "QA2"

  • "GOV"

  • "GOVUS"

  • "PREVIEW"

  • "ZPATWO"

customer_id

string

The ZPA tenant ID found in the Administration Company menu in the ZPA console.

state

string

The state.

Choices:

  • "present" ← (default)

  • "absent"

Notes

Note

  • Check mode is supported.

Examples

- name: LSS Controller
  hosts: localhost
  tasks:
    - name: Create a LSS Controller
      zscaler.zpacloud.zpa_lss_config_controller:
        provider: "{{ zpa_cloud }}"
        config:
          name: Status
          description: status
          enabled: true
          lss_host: 10.1.1.1
          lss_port: 20000
          format: "..."
          source_log_type: "zpn_ast_auth_log"
        app_connector_group_ids:
          - "11111"
      register: lss_controller

Authors

  • William Guilherme (@willguibr)