Skip to main content

​
Before you start

  • Neo uses ControlUp’s platform API at api.controlup.com, the one ControlUp’s VDI & DaaS, Desktops, Compliance and Synthetic Monitoring products share. Your Monitor and console stay where they are.
  • A ControlUp API key carries the permissions of the user who makes it, and only the permissions given to that user directly: a permission that comes through an SSO group does not reach the API. Make the key as a user with the permissions your agents need, or create a ControlUp user for Neo.

​
1. Create an API key

1

Open API Key Management

In ControlUp, click your profile icon in the top-right corner and select API Key Management.
2

Create the key

Click + Create new, choose how long the key lasts, and copy the key. Copy the Organization ID shown on the same page too.
When the key reaches the end of its duration, or its user is disabled or deleted, Neo loses access until you save a new key here.

​
2. Add the key in Neo

1

Open Integrations

In the Neo Dashboard, open Integrations → ControlUp, under Servers & Virtualization.
2

Save the key and the organization ID

Paste the API key and the Organization ID, then click Save settings. Neo reads your organization’s tags with the key before saving, so a wrong key or organization ID is rejected straight away.

​
3. Make a maintenance folder (for muting)

To let Neo mute a machine’s alerts, create a folder such as Maintenance in the ControlUp console, in the place your folders allow, and exclude it from your triggers’ scope. Neo can add it to each trigger’s excluded folders for you; it cannot create a folder, because ControlUp’s API does not.

​
4. Turn ControlUp on per agent

Open the agent, go to the Integrations section, and configure the ControlUp block. Agents can do only what the key’s user may do in ControlUp.

​
Pick an access profile

Read Only

Read alerts, statistics, machines, triggers, devices and settings. Nothing is changed.

Helpdesk

Changes to machines, triggers, devices, sessions and DaaS wait on a technician. Users, roles, tenants and Azure credentials stay read only.

IT Admin

Machines, triggers, devices, sessions and DaaS change without approval. Users and access, Azure credentials and Compliance exceptions wait on a technician.

Full Automation

Every change runs without approval, except deleting a host pool from Azure.

​
Or set each area by hand

Each area can be Disabled, Read Only or Read/Write (VDI Metrics & History is Read Only at most), and has its own technician approval setting.

​
Changes that always ask a technician

Deleting a DaaS IQ host pool from Azure, which tears down its session host VMs and Azure resources, waits on a technician under every profile.

​
Troubleshooting