Install Vault Client

Download Vault Client from IBM Passport Advantage Online or the IBM Entitled Registry, and confirm that it runs.

Enterprise

Appropriate Vault Enterprise license required

Before you start

You must have a Vault Enterprise license. Any Vault Enterprise customer can get access to IBM Passport Advantage Online and the IBM Entitled Registry. To sign in or request access, refer to Passport Advantage Online for Customers.
Check your Vault server version. Vault Client 2.x works with Vault Enterprise deployments running v2.x or later and HCP Vault Dedicated.
Choose a binary or a container image. IBM Passport Advantage Online provides binaries for Linux, AIX, and Windows, and container image archives for Linux. The IBM Entitled Registry provides container images for Linux.

Download the Vault Client archive for your platform:

Platform	Archive
Linux (amd64)	`vault_<version>.cl_linux_amd64.zip`
Linux (arm64)	`vault_<version>.cl_linux_arm64.zip`
Linux (ppc64le)	`vault_<version>.cl_linux_ppc64le.zip`
Linux (s390x)	`vault_<version>.cl_linux_s390x.zip`
AIX (ppc64)	`vault_<version>.cl_aix_ppc64.zip`
Windows (386)	`vault_<version>.cl_windows_386.zip`
Windows (amd64)	`vault_<version>.cl_windows_amd64.zip`

Unzip the archive. The archive contains the vault-client binary, or vault-client.exe on Windows.
Move the binary to a directory in your system PATH. For example, on Linux:
```
$ sudo mv vault-client /usr/bin/
```

Architecture	Archive
amd64	`vault_linux_amd64_<version>.cl.tar`
arm64	`vault_linux_arm64_<version>.cl.tar`
ppc64le	`vault_linux_ppc64le_<version>.cl.tar`
s390x	`vault_linux_s390x_<version>.cl.tar`

Load the image archive. For example:

$ docker load --input vault_linux_amd64_2.2.2.cl.tar

You can find the loaded image with the tag hashicorp/vault-enterprise:<version>-ent.client.

Get your IBM entitlement key:
1. Sign in to the IBM Container Library with a user ID that has permission to download entitled software for your company.
2. If you do not see your current entitlement key displayed, select Get entitlement key.
3. Under Access your container software, click Copy key, and store the key in a safe location.
4. Optional: Select View library to confirm that your Vault entitlement is listed.
Sign in to the IBM Entitled Registry with the username cp and your entitlement key as the password:
```
$ echo "${ENTITLEMENT_KEY}" | docker login cp.icr.io --username cp --password-stdin
```
Pull the Vault Client image for your architecture:
Architecture Image
amd64, arm64, ppc64le cp.icr.io/cp/ibm-vault-client/ibm-vault-client:<version>-ent.client
s390x cp.icr.io/cp/ibm-vault-client-for-z/ibm-vault-client-for-z:<version>-ent.client
For example:
```
$ docker pull cp.icr.io/cp/ibm-vault-client/ibm-vault-client:2.2.2-ent.client
```

Architecture	Image
amd64, arm64, ppc64le	`cp.icr.io/cp/ibm-vault-client/ibm-vault-client:<version>-ent.client`
s390x	`cp.icr.io/cp/ibm-vault-client-for-z/ibm-vault-client-for-z:<version>-ent.client`

Run the version command and confirm that the output starts with Vault Client.

$ vault-client version

Vault Client v2.2.2+ent ('<commit>'), built <date>

The container image entrypoint is vault-client, so pass the command as the container arguments:

$ docker run --rm hashicorp/vault-enterprise:2.2.2-ent.client version

Vault Client v2.2.2+ent ('<commit>'), built <date>

The container image entrypoint is vault-client, so pass the command as the container arguments:

$ docker run --rm cp.icr.io/cp/ibm-vault-client/ibm-vault-client:2.2.2-ent.client version

Vault Client v2.2.2+ent ('<commit>'), built <date>