Skip to content

Create a Citrix ADC machine

Create a Citrix ADC machine so Certificate Manager - SaaS can discover the certificates bound to the appliance's virtual servers, services, and service groups, and provision certificates to them. Certificate Manager - SaaS connects to the appliance's NITRO API through a VSatellite.

Before you begin

  • The System Administrator, PKI Administrator, or Resource Owner role. If you have the Resource Owner role, you must own or belong to at least one team.
  • An active VSatellite that can reach the Citrix ADC management address over HTTPS.
  • The hostname or IP address of the Citrix ADC.
  • The port the Citrix ADC management interface listens on, if it isn't 443.
  • A Citrix ADC user account for Certificate Manager - SaaS. For least privilege, create a regular user on the Citrix ADC and assign it a command policy with the following command spec:

    (^stat\s+(cr|cs|lb|system|vpn|authentication))|(^(add|rm|show)\s+system\s+file\s+.*)|(^\S+\s+ssl\s+.*)|(^(show|stat|sync)\s+HA\s+.*)|(^save\s+ns\s+config)|(^(switch|show)\s+ns\s+partition.*)
    
  • If the Citrix ADC uses admin partitions, an account that has permission to switch to each partition you discover or provision to, such as the Citrix ADC superuser permission. On a partitioned Citrix ADC in a high availability (HA) pair, the account also needs permission to switch to the default partition.

To create a Citrix ADC machine

  1. Sign in to Certificate Manager - SaaS.
  2. Click Installations > Machines.
  3. Click New, and then select Citrix ADC.
  4. On the Properties step, in Name, enter a name for the machine.
  5. For Owning Team, choose the team that owns the machine. System Administrators and PKI Administrators can choose any team. Resource Owners can choose only a team they own or belong to.
  6. For VSatellite, choose a VSatellite that can reach the machine. A VSatellite that's the primary of a high availability group shows its number of active replicas, and Certificate Manager - SaaS can run the machine's operations on any healthy VSatellite in the group.

  7. In Citrix Address/Hostname, enter the hostname or IP address of the Citrix ADC.

  8. (Optional) In Port, enter the port the management interface listens on. If you leave it empty, Certificate Manager - SaaS uses 443.
  9. For Credential Type, choose how to provide the credentials:

    • Enter Credentials to enter the credentials in the next step. This is the default.
    • Select Credentials to use shared credentials from a credential manager integration. Then, for Credential, choose the credential.

    Note

    Select Credentials requires the credential manager capability, which requires additional licensing. Without it, Credential shows No credentials are available. System Administrators and PKI Administrators can choose any credential. Resource Owners can choose only the credentials that belong to their teams.

  10. If you chose Enter Credentials, enter the Username and Password of the Citrix ADC account. If you chose Select Credentials, the stored account needs the same Citrix ADC access.

    Note

    Certificate Manager - SaaS encrypts the credentials you enter and doesn't display them again. On the machine's Properties tab, they appear masked. To keep a stored credential when you edit the machine, leave its masked value unchanged. Keep your own secure record of the credentials in case you need them again.

  11. Click Test Access. After the connection succeeds, click Continue. The Discovery step opens.

    Note

    A successful test confirms that Certificate Manager - SaaS can reach the Citrix ADC and sign in to the NITRO API with the credentials. It doesn't check what the account is allowed to change.

  12. (Optional) For Resource Types to Discover, choose the endpoints whose certificates you want to discover:

    • All of Virtual Servers, Services, and Service Groups
    • Services
    • Service Groups
    • Virtual Servers

    If you don't choose one, discovery covers all three, including scheduled discovery. Discovery finds only the certificates that are bound to an SSL endpoint of the chosen types, along with the CA certificates linked to them. It doesn't discover certificates that aren't bound to an endpoint.

  13. (Optional) In Partition(s), enter a comma-separated list of the partitions to discover. To discover only the default partition, enter default. If you leave it empty, discovery covers the default partition and every admin partition. If discovery can't switch to a partition, it skips that partition and continues with the others.

  14. (Optional) To skip certificates that have already expired, select Exclude expired certificates.
  15. (Optional) In Keystore and Private Key Credentials, enter the passwords of any password-protected PFX (PKCS#12) files that hold certificates on the Citrix ADC. Enter one password per line. Discovery tries an empty password first, and then each password you enter, until one opens the file. It skips a PFX file that none of the passwords open.

    Note

    Certificate Manager - SaaS encrypts these passwords and doesn't display them again. On the machine's Discovery tab, they appear masked. To keep the stored passwords when you edit the machine, leave the masked value unchanged.

  16. (Optional) Enable TLS Handshake Discovery to recover certificates whose files discovery can't read. When discovery can't download or read the certificate file bound to a virtual server, it connects to the virtual server's IP address and port and reads the certificate that the server presents during the Transport Layer Security (TLS) handshake. This applies only to virtual servers, and the VSatellite must be able to reach the virtual server's address.

  17. (Optional) To discover certificates on a schedule, enable Schedule. For Repeat every, choose Day, Week, or Month, and then in At, enter the time. For Week, select the days of the week. For Month, enter the days in Day of month. Times are in Coordinated Universal Time (UTC).
  18. Click Continue. The Provisioning step opens.
  19. (Optional) To provision certificates on a schedule, enable Schedule. For Repeat every, choose Day, Week, or Month, and then in At, enter the time. For Week, select the days of the week. For Month, enter the days in Day of month. Times are in Coordinated Universal Time (UTC).

    Scheduled provisioning pushes only certificates that are queued for deployment, such as renewed certificates, so renewals install during the window you choose.

  20. Click Finish.

What's next?

After you create the machine, provision a certificate to it. You can also run discovery on the machine at any time to track the certificates on your Citrix ADC.