Skip to main content
Actions

Ensure Lywand agent

How to roll the Lywand agent out to your Windows devices with an automation, what the action needs and when the step fails.

Use this action to make sure the Lywand security agent is installed on a Windows device. If it is missing, octoja installs it with the license key of the Lywand partner matched to the device's customer. You never have to handle an installer or a key yourself. The device must be online.

Prerequisites

  • lywand software is connected under Integrations — see Set up lywand software.
  • The device's customer is matched to a Lywand partner under Match customers, and Lywand has an agent license key for that partner. A missing match is the most common reason the step fails.
  • The device can download the installer from agent.lywand.com over HTTPS.

Configuration fields

This action has no fields of its own. You only set the common step settings, such as the condition, On failure and If device is offline. If lywand software is not connected, the properties panel shows Lywand is not connected. Connect it under Integrations first.

Platform support

PlatformSupported
WindowsYes
LinuxNo
macOSNo

Outputs

OutputDescription
installedInstalled: true when the Lywand agent is present on the device after the step.
actionAction: installed after a fresh install, alreadyInstalled when the agent was already there, none when the installation on the device failed.

Use action in the condition of a later step to check whether an installation actually happened — for example, to open a ticket with Create ticket only then.

If the step fails before it reaches the device, for example because the customer is not matched, there are no outputs. You'll find the installer's messages in the step's standard and error output in Run history.

Result behaviour

octoja checks the integration, the customer match and the license key on every run, before the step reaches the device. So these checks can fail even when the Lywand agent is already installed.

SituationResult
The Lywand agent is already installedSucceeded, action = alreadyInstalled. Nothing changes on the device.
The agent is missing and the installation worksSucceeded, action = installed. This also applies when the installer asks for a restart.
The installer reports an errorFailed. The error output shows the exit code and the last 40 lines of the installer log.
The installer finishes, but the agent is still missingFailed.
The installation takes longer than four minutesThe installation is stopped and the step does not succeed.
The device is not a Windows deviceFailed: The Lywand agent supports Windows devices only. Remove non-Windows devices from the automation's target devices.
lywand software is not connectedFailed: The Lywand integration is not connected.
The device has no customer, or the customer is not matchedFailed: The device's customer is not matched to a Lywand customer. Match the customer under Match customers in the lywand software integration.
Lywand has no license key for the matched partnerFailed: Lywand has no agent license key for the matched customer. Check that customer's licensing in Lywand.
The Lywand API cannot be reachedFailed: The Lywand API could not be reached. This is usually temporary — just run the automation again. If it persists, check Lywand's service status.
The device is offline when the step startsDevice offline. Depending on If device is offline, the run ends with this status or the step is skipped.

octoja detects the agent by the registry key HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Lywand. The step never restarts the device itself.

Roll the agent out to your Windows devices

  1. Under Automations, create an automation or open an existing one and add the Ensure Lywand agent action.
  2. Choose the trigger: with Device added, every newly registered device gets the agent. With Schedule, you also cover existing devices.
  3. Limit the Target devices to the Windows devices of customers that are matched to a Lywand partner.
  4. Try the automation with a Test run on a single device before you enable it.

You can safely run the step again: if the agent is already there, octoja just reports it and installs nothing. An automation with a Schedule therefore also puts the agent back on devices where it was removed.

Once the agent reports data to Lywand, octoja shows the device's Lywand score. Set up lywand software describes when that happens.

See also: Create an automation · Set up lywand software