Upgrading an appliance with sdpctl

Prev Next

sdpctl is a command-line tool for managing AppGate Collectives. It supports critical operations such as upgrading and backing up a Collective, as well as several other functions. For the full list of sdpctl capabilities, see the see the documentation hosted in GitHub.


Before upgrading

Before upgrading, complete the following steps:

  1. Note the hostname of your primary Controller. You will connect to its admin interface and may need to reference this Controller if you revert the upgrade.

    NOTE

    Do not use a load-balanced address or hostname. sdpctl must work consistently with the same Controller.

  2. Download the CA certificate file from the Controller Certificate Authority page (System > Certificate Authority). This establishes a mutually trusted TLS connection between sdpctl and the Controller when the self-signed certificate is still in use.

  3. Create an admin user account for sdpctl with the appropriate privileges: Upgrade on the Controller, or Backup on other appliances.

  4. Create a policy for the admin user and assign the appropriate Admin role.


Using sdpctl

To use sdpctl:

  1. Download the latest version. This site is not linked to AppGate ZTNA versions. Check the GitHub page before using sdpctl to verify whether a newer version is available.

  2. Copy the relevant version of sdpctl to the system on which it will run. This system must be outside the AppGate ZTNA Collective.