endpoint_connection_profiles - Connection Profile Resource

Added in version 1.0.0.

Synopsis

Connection Profile Resource.

Use API “/resource-api/v2/endpoint/connection-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
  • connect_to_fortisase type: strchoices: ['automatically', 'manually']
  • lockdown type: dict
    • status type: strchoices: ['disable', 'enable']
    • grace_period type: int
    • max_attempts type: int
    • ips type: listelements: dict
      • ip type: str
      • port type: str
      • protocol type: strchoices: ['', 'icmp', 'tcp', 'udp']
    • domains type: listelements: dict
      • address type: str
    • detect_captive_portal type: dict
      • status type: strchoices: ['disable', 'enable']
  • on_fabric_rule_set type: dict
    • primary_key type: str
    • datasource type: str
  • off_net_split_tunnel type: dict
    • local_apps type: listelements: str
    • isdbs type: listelements: dict
      • primary_key type: str
      • datasource type: str
    • fqdns type: listelements: str
    • subnets type: listelements: dict
      • primary_key type: str
      • datasource type: strchoices: ['network/host-groups', 'network/hosts']
    • subnets_ipsec type: listelements: str
  • split_tunnel type: dict
    • local_apps type: listelements: str
    • isdbs type: listelements: dict
      • primary_key type: str
      • datasource type: str
    • fqdns type: listelements: str
    • subnets type: listelements: dict
      • primary_key type: str
      • datasource type: strchoices: ['network/host-groups', 'network/hosts']
    • subnets_ipsec type: listelements: str
  • allow_invalid_server_certificate type: strchoices: ['disable', 'enable']
  • endpoint_on_net_bypass type: bool
  • auth_before_user_logon type: bool
  • secure_internet_access type: dict
    • authenticate_with_sso type: strchoices: ['disable', 'enable']
    • enable_local_lan type: strchoices: ['disable', 'enable']
    • failover_sequence type: listelements: str
    • posture_check type: dict
      • tag type: str
      • action type: strchoices: ['allow', 'prohibit']
      • check_failed_message type: str
    • external_browser_saml_login type: strchoices: ['disable', 'enable']
  • preferred_dtls_tunnel type: strchoices: ['disable', 'enable']
  • use_gui_saml_auth type: strchoices: ['disable', 'enable']
  • allow_personal_vpns type: bool
  • mtu_size type: int
  • available_vpns type: listelements: dict
    • type type: strchoices: ['ipSecVPN', 'sslVPN']
    • name type: str
    • remote_gateway type: str
    • username_prompt type: strchoices: ['disable', 'enable']
    • save_username type: strchoices: ['disable', 'enable']
    • show_always_up type: strchoices: ['disable', 'enable']
    • show_auto_connect type: strchoices: ['disable', 'enable']
    • show_remember_password type: strchoices: ['disable', 'enable']
    • authenticate_with_sso type: strchoices: ['disable', 'enable']
    • enable_local_lan type: strchoices: ['disable', 'enable']
    • external_browser_saml_login type: strchoices: ['disable', 'enable']
    • port type: int
    • require_certificate type: strchoices: ['disable', 'enable']
    • auth_method type: strchoices: ['preSharedKey', 'smartCardCert', 'systemStoreCert']
    • show_passcode type: strchoices: ['disable', 'enable']
    • posture_check type: dict
      • tag type: str
      • action type: strchoices: ['allow', 'prohibit']
      • check_failed_message type: str
    • pre_shared_key type: str
  • show_disconnect_btn type: strchoices: ['disable', 'enable']
  • enable_invalid_server_cert_warning type: strchoices: ['disable', 'enable']
  • pre_logon type: dict
    • vpn_type type: strchoices: ['ipSecVPN', 'sslVPN']
    • remote_gateway type: str
    • common_name type: dict
      • match_type type: strchoices: ['regex', 'wildcard']
      • pattern type: str
    • issuer type: dict
      • match_type type: strchoices: ['regex', 'wildcard']
      • pattern type: str
    • port type: int

Examples

- name: Connection profile
  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: Update connection profile
      fortinet.fortisase.endpoint_connection_profiles:
        params:
          primary_key: "{{ primary_key }}"
          allow_invalid_server_certificate: "enable"
          allow_personal_vpns: false
          auth_before_user_logon: false
          available_vpns: []
          connect_to_fortisase: "manually"
          enable_invalid_server_cert_warning: "disable"
          endpoint_on_net_bypass: false
          preferred_dtls_tunnel: "enable"
          secure_internet_access:
            authenticate_with_sso: "disable"
            external_browser_saml_login: "disable"
          use_gui_saml_auth: "disable"

Return Values

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

Authors

• Xinwei Du (@dux-fortinet)