endpoint_ztna_profiles - ZTNA Profile Resource

Added in version 1.0.0.

Synopsis

ZTNA Profile Resource.

Use API “/resource-api/v2/endpoint/ztna-profiles/{primaryKey}”.

Requirements

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

  • ansible>=2.17.0

Parameters

  • state The state of the module. "present" means update the resource. This resource can't be deleted, and does not support "absent" state.type: strchoices: ['present', 'absent']default: present
  • force_behavior Specify this option to force the method to use to interact with the resource.type: strchoices: ['none', 'read', 'create', 'update', 'delete']default: none
  • bypass_validation Bypass validation of the module.type: booldefault: False
  • params The parameters of the module.[Required]type: dict
    • primary_key [Required]type: str
    • allow_automatic_sign_on type: strchoices: ['disable', 'enable']
    • connection_rules type: listelements: dict
      • id type: int
      • address type: str
      • uid type: str
      • gateways type: listelements: dict
        • alias type: str
        • private_app_count type: int
        • vip type: str
        • redirect type: strchoices: ['disable', 'enable']
      • mask type: str
      • port type: str
      • name type: str
      • encryption type: strchoices: ['disable', 'enable']
    • entra_id type: dict
      • application_id type: str
      • domain_name type: str

Examples

- name: Endpoint ZTNA profiles
  hosts: fortisase
  gather_facts: false
  vars:
    primary_key: "policy1"
  tasks:
    - name: Create a new endpoint profile, do nothing if the endpoint profile already exists
      fortinet.fortisase.endpoint_policies:
        state: present
        params:
          primary_key: "{{ primary_key }}"
          enabled: true
    - name: Enable endpoint ZTNA profiles
      fortinet.fortisase.endpoint_ztna_profiles:
        state: present
        params:
          primary_key: "{{ primary_key }}"
          allow_automatic_sign_on: "enable"
          connection_rules:
            - id: 1
              address: "192.168.1.1"
              uid: "1"
              gateways: []
              mask: "255.255.255.0"
              name: "test"
              port: "80"
              encryption: "enable"
          entra_id:
            application_id: "0"
            domain_name: "0"

Return Values

  • http_code type: intreturned: always
  • response type: rawreturned: always

Authors

  • Xinwei Du (@dux-fortinet)