Software Installation

Before you install CIOP:

  • See the latest Release Notes at https://nshieldsupport.entrust.com/hc/en-us/sections/360001115837-Release-Notes for hardware and software compatibility, and known and fixed issues.

  • Remove any previous installations of CIOP.

  • Check you have the Security World software (v12.80 or later) installed and a working Security World configured. For more information on creating a Security World, see the User Guide for your nShield HSM.

Note that CIOP has different Security World version requirements depending on which cloud service provider you are attempting to export keys for. Refer to the Release Notes for further details.

Install on Windows

To install the Cloud Integration Option Pack on Windows:

  1. Download the CIOP-2.3.0.zip file.

  2. Extract the CIOP-2.3.0.zip.

  3. Start a command prompt with Run as administrator.

  4. Change to the extracted directory from step 2.

  5. In the command prompt, install using the nShield Python pip tool.

    "%NFAST_HOME%\python3\python.exe" -m pip install nshield_citool-2.3.0-py3-none-any.whl

Install on Linux

To install the Cloud Integration Option Pack on Linux:

  1. Download the CIOP-2.3.0.zip file.

  2. Extract the CIOP-2.3.0.zip.

  3. Change to the extracted directory from step 2.

  4. In the command prompt, install using the nShield Python pip tool.

    sudo /opt/nfast/python3/bin/python3 -m pip install nshield_citool-2.3.0-py3-none-any.whl

Uninstall CIOP

To uninstall CIOP on Windows, using Run as administrator:

"%NFAST_HOME%\python3\python.exe" -m pip uninstall nshield-citool

To uninstall CIOP on Linux:

sudo /opt/nfast/python3/bin/python3 -m pip uninstall nshield-citool