Use Kaseya VSA 10 to install or remove the Endpoint Defense agents

You can follow the steps below to use Kaseya VSA 10 to install the Aurora Protect Desktop or Aurora Focus agent on Windows or macOS devices, or to remove the agent from devices. Note that this method requires use of the Aurora Multi-Tenant Console. Kaseya VSA 10 does not support deployments to Linux devices.
  1. In Kaseya VSA 10, create a Custom Field with the following variables. For all variables, disable expiration.
    For more information about creating a Custom Field, see Kaseya VSA 10: Custom fields.

    Name

    Context

    Variable Type

    Description

    Cylance_Application_Id

    Global (Read Only)

    text

    Specify the application ID.

    Cylance_Application_Key

    Global (Read Only)

    text

    Specify the application secret.

    Cylance_Tenant_ID
    Any of:
    • Global
    • Organization
    • Site
    • Agent Group

    text

    Specify the tenant ID from the Aurora Multi-Tenant Console.

    Cylance_Region

    Global (Read Only)

    text
    Specify the appropriate region:
    • United States = us (default)
    • Asia Pacific SE/Australia = au
    • European Union = eu
    • Asia Pacific NE/Japan = jp
    • South America/Sao Paulo = sp

    Cylance_Install_Token
    Any of:
    • Global
    • Organization
    • Site
    • Agent Group

    text

    Specify the installation token from the Aurora Multi-Tenant Console.

    Cylance_Uninstall_Key
    Any of:
    • Global
    • Organization
    • Site
    • Agent Group

    text

    If you configured the Aurora Protect Desktop and Aurora Focus agents to require a user to enter a password to uninstall, specify the uninstall password from the Endpoint Defense console.

    Cylance_Download_Token
    Any of:
    • Organization
    • Site
    • Agent Group

    text

    A workflow-only variable to pass a download token from one script to another. Leave the value blank.

    Cylance_Product_Type
    Any of:
    • Organization
    • Site
    • Agent Group
    • System

    text
    Specify one of the following values to select the agent that you want to install or remove:
    • protect
    • optics

    The default value is protect.
  2. Navigate to Automation > Scripts.
  3. Create a folder named Cylance.
  4. In the Cylance folder, create the following scripts with the specified inputs and outputs. The inputs map to the variables that you created in step 1. Copy and paste the body of each script from the Cylance_Kaseya_<version> package that you downloaded.

    Script name

    Inputs

    Outputs

    Cylance_Is_Installed

    c_product_type

    c_is_installed

    Type: Number

    Default value: 0

    Cylance_Get_Download_Token

    c_app_id

    c_app_key

    c_region

    c_tenant_id

    c_product_type

    download_token

    Type: Text

    Default value: -1

    Cylance_Get_Installer

    c_download_token

    c_install_token

    c_region

    c_product_type

    post_action_check

    Type: Number

    Default value: 0

    Cylance_Uninstall

    c_product_type

    c_uninstall_passcode

    post_action_check

    Type: Number

    Default value: 0
  5. In Automation > Workflows, use Actions > Import Workflow to import the following workflows (.wfl) from the scripts folder of the Cylance_Kaseya_<version> package. You must import the workflows in the following order:
    1. Cylance_Windows_Install.wfl
    2. Cylance_MacOS_Install.wfl
    3. Cylance_Install_Workflow.wfl
    4. Cylance_Uninstall_Workflow.wfl
  6. Set the status of each imported workflow to Active.
  7. Validate the following for each workflow using the workflow condition type. If the values do not resolve to those specified below, manually reset to the expected outcome.

    Workflow

    Script or Custom Field variable

    Expected value

    Cylance_Windows_Install.wfl

    Script: Cylance_Is_Installed

    c_is_installed = 0

    Script: Cylance_Get_Download_Token

    download_token ≠ -1

    Cylance_MacOS_Install.wfl

    Script: Cylance_Is_Installed

    c_is_installed = 0

    Script: Cylance_Get_Download_Token

    download_token ≠ -1

    Cylance_Install_Workflow.wfl

    Custom Field variable: Cylance_Download_Token

    ≠ -1

    Script: Cylance_Get_Installer

    post_action_check = 0

    Cylance_Uninstall_Workflow.wfl

    Script: Cylance_Is_Installed

    c_is_installed = 0
Assign the Custom Field values to an endpoint (Organization, Site, or Agent Group), setting the value of Cylance_Product_Type to “protect” or “optics”, and run the appropriate workflow to install or remove the Aurora Protect Desktop or Aurora Focus agent. It is a best practice to test the installation or removal on a small number of devices first.