willguibr.zpacloud.zpa_application_segment (1.1.1) — module

Install collection

Install with ansible-galaxy collection install willguibr.zpacloud:==1.1.1

Add to requirements.yml

  collections:
    - name: willguibr.zpacloud
      version: 1.1.1

Description

This module will create/update/delete an application segment

Usage examples

Scanned by Steampunk Spotter

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

- name: Create/Update/Delete an application segment.
  willguibr.zpacloud.zpa_application_segment:
    name: Example Application Segment
    description: Example Application Segment
    enabled: true
    health_reporting: ON_ACCESS
    bypass_type: NEVER
    is_cname_enabled: true
    tcp_port_range:
      - from: "80"
        to: "80"
    domain_names:
      - crm.example.com
    segment_group_id: "216196257331291896"
    server_groups:
      - "216196257331291969"

Inputs

    
id:
    description:
    - ID of the application.
    required: false
    type: str

name:
    description:
    - Name of the application.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description: Whether the app should be present or absent.
    type: str

enabled:
    description:
    - Whether this application is enabled or not.
    required: false
    type: bool

client_id:
    description: ''
    required: false
    type: str

bypass_type:
    choices:
    - ALWAYS
    - NEVER
    - ON_NET
    default: NEVER
    description:
    - Indicates whether users can bypass ZPA to access applications.
    required: false
    type: str

customer_id:
    description: ''
    required: false
    type: str

description:
    description:
    - Description of the application.
    required: false
    type: str

ip_anchored:
    description:
    - Whether Source IP Anchoring for use with ZIA, is enabled or disabled for the app.
    required: false
    type: bool

config_space:
    choices:
    - DEFAULT
    - SIEM
    default: DEFAULT
    description:
    - config space.
    required: false
    type: str

domain_names:
    description:
    - List of domains and IPs.
    elements: str
    required: true
    type: list

client_secret:
    description: ''
    required: false
    type: str

server_groups:
    description:
    - ID of the server group.
    elements: dict
    required: true
    suboptions:
      id:
        description: ''
        required: true
        type: str
      name:
        description: ''
        required: false
        type: str
    type: list

double_encrypt:
    description:
    - Whether Double Encryption is enabled or disabled for the app.
    required: false
    type: bool

tcp_port_range:
    description:
    - List of tcp port range pairs, e.g. [22, 22] for port 22-22, [80, 100] for 80-100.
    elements: dict
    required: false
    suboptions:
      from:
        description:
        - List of valid TCP ports. The application segment API supports multiple TCP and
          UDP port ranges.
        required: false
        type: str
      to:
        description:
        - List of valid TCP ports. The application segment API supports multiple TCP and
          UDP port ranges.
        required: false
        type: str
    type: list

udp_port_range:
    description:
    - List of udp port range pairs, e.g. ['35000', '35000'] for port 35000.
    elements: dict
    required: false
    suboptions:
      from:
        description:
        - List of valid UDP ports. The application segment API supports multiple TCP and
          UDP port ranges.
        required: false
        type: str
      to:
        description:
        - List of valid UDP ports. The application segment API supports multiple TCP and
          UDP port ranges.
        required: false
        type: str
    type: list

default_max_age:
    description:
    - default_max_age
    required: false
    type: str

health_reporting:
    choices:
    - NONE
    - ON_ACCESS
    - CONTINUOUS
    default: NONE
    description:
    - Whether health reporting for the app is Continuous or On Access. Supported values
      are NONE, ON_ACCESS, CONTINUOUS
    required: false
    type: str

icmp_access_type:
    choices:
    - PING_TRACEROUTING
    - PING
    - NONE
    default: NONE
    description:
    - icmp access type.
    required: false
    type: str

is_cname_enabled:
    description:
    - Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives
      CNAME DNS records from the connectors.
    required: false
    type: bool

segment_group_id:
    description:
    - ID of the segment group.
    required: true
    type: str

health_check_type:
    description:
    - health check type.
    required: false
    type: str

segment_group_name:
    description:
    - segment group name.
    required: false
    type: str

default_idle_timeout:
    description:
    - default idle timeout.
    required: false
    type: str

passive_health_enabled:
    description:
    - passive health enabled.
    required: false
    type: bool