HYCU (preview)

This page gets Collimo reading your HYCU controller with a view-only account, so it can show the health of your HYCU and when each VM was last backed up.

What Collimo reads: room on each target; each policy's compliance, as HYCU judges it; the latest run of each job in the past week; and every VM HYCU knows, with its newest backup. What it can't: it changes nothing and doesn't read the backups themselves. Collimo watches your backup server; it doesn't make, keep or restore backups of your machines.

A preview

HYCU publishes no reference for its REST API, so Collimo's HYCU source is built from HYCU's user guide and the scripts people share, and every field is treated as optional. If something reads wrong or not at all, please send us what your controller serves at https://<controller>:8443/rest/v1.0/api-docs (it describes the API, and holds nothing of yours), and Settings → Diagnostics from Collimo.

Make the view-only account

1. In HYCU, as an administrator, add a user for Collimo and give it the Viewer role in the Infrastructure group. A Viewer in a Self-service group sees no targets.
2. Sign in to HYCU as that user, open the user menu at the top right → API Keys → New, name it collimo, and Generate. Copy the key now: it's shown once. Leave the expiry empty, or note the date.

Two-factor sign-in

With two-factor sign-in on for the REST API, an API key is the only way in. Without it, you can use the user name and password instead: fill in User, and give the password as the secret.

Enter it in the setup wizard

On the wizard's What you have page, set HYCU (preview) to the number you have. On its page:

1. Name: what you call it, such as hycu1.
2. Address: with the port: https://192.168.1.40:8443.
3. User: leave it blank to use the API key.
4. API key: the key from step 2.
5. Leave Verify the certificate off: HYCU's own certificate isn't trusted unless you replaced it.
6. Click Test.

Editing the stack by hand

SOURCE_4=hycu https://192.168.1.40:8443 name=hycu1
SOURCE_4_SECRET=<the API key>

With a user name and password instead, add user=collimo to the first line and put the password in SOURCE_4_SECRET.

Where it shows up

HYCU gets a panel on the Virtualization tab: targets, policies, jobs and the VMs longest since a backup. Each VM also shows in Last backup per VM.

It alerts on a job that ended in error, a policy HYCU itself judges out of compliance (red is critical, a warning a warning), and a target that's unhealthy or nearly full.

HYCU's VMs are matched to the hypervisor's by name. When the HYCU controller says it protects vSphere, a vCenter VM HYCU doesn't hold counts as having no backup; on other platforms Collimo can't tell, so those VMs say not checked unless another backup server answers for them.

A VM's newest backup takes one question per VM, so those are read once an hour, up to 500 VMs at a time.

If something's wrong

What you see	What to do
HYCU refused the credentials (401)	Check the API key, or the user and password. With two-factor sign-in on, use a key.
Connected, but 0 targets	The user is in a Self-service group. Use the Infrastructure group.
Nothing answered at that address and port.	Add the port, :8443.
The certificate isn't trusted.	Untick Verify the certificate.

See Troubleshooting for more.