Citrix

This guide covers Citrix NetScaler (Citrix ADC) virtual appliances.

Create a backup account

Create a dedicated system user for QUARK from the NetScaler CLI:

add system user netwatch-backup <password>
bind system user netwatch-backup superuser 100
save ns config

The built-in read-only command policy on NetScaler explicitly excludes viewing the running configuration and the saved ns.conf, so it is not sufficient for backups. Either bind the superuser policy as shown, or create a custom command policy that additionally allows the running-configuration show commands and bind that instead if you want tighter scoping.

You can also create the user in the GUI under System > User Administration > Users.

Enable SSH access

SSH is enabled by default on the NetScaler IP (NSIP). Verify the collector can reach the NSIP on TCP port 22. If you restrict management access with ACLs or an external firewall, permit the collector's IP address. Avoid pointing QUARK at a SNIP unless management access is explicitly enabled on it.

Platform notes

• Do not use the built-in nsroot account for backups; a dedicated account keeps an auditable trail and can be revoked independently.
• On a high-availability pair, add both nodes so each node's configuration is versioned; QUARK is read-only and does not trigger HA synchronization.
• QUARK only runs show commands and never issues save ns config or any configuration command against the appliance.

Enable backup in Netwatch

Once the device is prepared, open its host in Netwatch (Data collection > Hosts) and add the Config Backup macros — the supported status flag, the model code for this platform, and the credentials you created. See Getting started for the full macro list and values.