stskeyutil install utility
- Last Updated: March 30, 2020
- 2 minute read
- OpenEdge
- Version 12.2
- Documentation
stskeyutil install -url sts-url
[ -overwrite ]
| -node node-name]
[ common-options ]
- -url sts-url
- Specify the STS server's url in the format:
https://<host>[:port]/[web-app]. - -overwrite
- Overwrite an existing key file. By default, an existing key file is not overwritten.
- -node node-name
- Specify the cluster node named node-name.
The stskeyutil install creates and
installs an STS Client Key that corresponds to a specific OpenEdge STS server key. The
resulting STS Client Key is encrypted and stored inside the OpenEdge installation's
(default) %DLC%/keys directory.
Note: Each OpenEdge STS server used by an OpenEdge installation's products
requires that a separate STS Client Key be created and installed using the STS Server Key.
This requires the administrator to create the key by running
stskeyutil install on the host where the STS Client Key file will be written and
from within the OpenEdge installation the STS Client Key is generated for. Each installed STS Client Key file is bound to a single OpenEdge installation, on a single server, and to the OpenEdge STS (URL) used for access. The URL must match exactly how it is set up on the database configuration. This binding is reflected by the hashed file name of the STS Client Key file.
When the OpenEdge STS server is running in a clustered environment it may not always be
possible to generate each node's STS Client Key by logging directly into each node and
executing the install command. To enable generating a STS Client Key for each cluster node,
an administrator may follow this process:
- Ensure that each cluster node will use the same exact absolute path
to the OpenEdge installation. Warning: If this is not true, stop now!
- Obtain each cluster node's node-name (found using the UNIX uname -n)
- Log in to the active cluster node as the OpenEdge administrator, and execute
stskeyutil installfor the current cluster node - Repeat, executing
stskeyutil installonce for each additional cluster node, adding-node node-nameto the command line