Skip to main content

Citrix NetScaler

SecTrail CM enables automatic deployment and renewal of SSL certificates by establishing agentless connections to Citrix NetScaler Application Delivery Controller (ADC) devices.

Connection Requirements​

RequirementDetailDescription
ProtocolNITRO REST API (HTTPS)NetScaler's native REST API is used
Port443Standard HTTPS port or custom management port
AuthenticationBasic AuthenticationAuthentication via Username and Password
User Permissionnsroot or superuser roleCertificate upload and configuration permission

Automated Operations​

SecTrail CM automatically performs the following operations on Citrix NetScaler:

  1. Certificate and Key Upload: Secure transfer of SSL certificate and private key
  2. CertKey Creation: Creating and managing certificate-key pairs
  3. Virtual Server Binding: Binding certificates to SSL Virtual Servers
  4. Configuration Save: Making configuration persistent

Configuration Steps​

1. Creating NetScaler User​

Navigate to Automation > Device Users and create a user for F5.

2. Adding NetScaler Device to SecTrail CM​

Click Automation > Devices > Add New Device button and enter the following information:

NetScaler Device Creation

  • Name: Provide a descriptive name for the device
  • Device Users: Select the user created in Step 1
  • IP: Enter the NSIP address of the NetScaler device
  • Device Type: Select Citrix NetScaler from the dropdown menu
  • Cert Upload Only: Should only certificate be uploaded? (Disabled/Enabled)
Automatic Discovery

After the NetScaler device is added to SecTrail CM, the IP addresses and ports of all Virtual Servers defined on the device are automatically included in the discovery period and scanned regularly.

3. Viewing Device Information​

After the device is added, it will be displayed in the Automation > Devices list. Click on the row to view device details:

NetScaler Device Details and Virtual Server List

  • Virtual Server: Virtual Server names defined on the NetScaler device
  • Address: IP address and port of the Virtual Server
  • CertKey Name: Current certificate-key pair names
  • SerialNumber: Certificate serial number
  • Type: Shows the address type
  • Deploy: For certificate deployment

Certificate Deployment​

Step 1: Virtual Server and Certificate Selection​

  1. Select your NetScaler device from Automation > Devices
  2. In the device details, find the Virtual Server where you want to deploy the certificate
  3. Click the Deploy button on the relevant row
  4. In the Deploy Certificate window that opens:
    • Virtual Servers: Target Virtual Server information is displayed (IP, port, CertKey name)
    • Certificate: Select the certificate you want to deploy from the dropdown menu

Certificate Deployment Screen

Step 2: Starting the Deployment Process​

Click the Deploy button to start the certificate deployment process.

Step 3: Process Tracking​

The deployment process can be tracked from Automation > Processes:

NetScaler Deployment and Rollback Operations

Operation Details​

The following steps are performed during deployment:

StepOperation Description
1Certificate and key file are uploaded to the system
2Certificate-key pair is created
3Existing certificate binding is removed
4New certificate is bound to virtual server
Automatic Cleanup

SecTrail CM automatically cleans up unused old certificate and key files after deployment.

Rollback Operation​

The Manual Rollback feature can be used in case of issues after certificate deployment.

Automatic Rollback

If an error occurs at any step during the deployment process, the system automatically performs a rollback and all changes are reverted.

Rollback Steps​

  1. Navigate to Automation > Processes
  2. Find the operation you want to rollback
  3. Use the Manual-Rollback option in the Status column
  4. Confirm

Operations During Rollback​

StepOperation
1Old certificate-key pair is preserved
2Virtual Server's previous binding settings are restored
3Newly uploaded certificate and key files are deleted
4Certkey created during deployment is removed