...
The UDMG Command Line Interface (CLI) is implemented by the waarpudmg-gatewayclient client.
In addition to what is supported by the original version of the waarp-gateway v0.67.2 1 client, the following commands have been added for UDMG:
...
Only Local User Account authentication is supported for the CLI. SSO and LDAP authentication is only used for the Graphical User Interface.
See Waarp Gateway Client Connection Settings on how to give the credentials.
...
Both private and public PGP keys can be stored in the database with AES encryption.
Add key
| Code Block |
|---|
waarpudmg-gateway sbclient sb_pgp add |
Adds a new pgp key with the given parameters.
...
To create a public pgp key from a file containing the key that was given by a partner, the syntax is as follows:
| Code Block |
|---|
waarpudmg-gatewayclient sb_pgp add --name=rhelsec --pgp-name="Red Hat, Inc. (Product Security)" --pgp-email="secalert@redhat.com" --pgp-algo="4096R" --comment="https://access.redhat.com/security/team/contact" --public-key="$(cat dce3823597f5eac4.txt)" |
List keys
| Code Block |
|---|
waarpudmg-gateway sbclient sb_pgp list |
Displays a list of all keys meeting the criteria below.
| short option | long option | description |
|---|---|---|
| -l | --limit= | The maximum number of keys allowed in the response. Set to 20 by default. |
| -o | --offset= | Index of the first returned entry (default: 0). |
| -s | --sort=[name+|name-] | The setting and order in which keys will be displayed. The possible choices are:
|
Example
| Code Block |
|---|
waarpudmg-gatewayclient sb_pgp list -l 10 -o 5 -s 'name+' |
Get a key
| Code Block |
|---|
waarpudmg-gateway sbclient sb_pgp <key_name> |
Retrieve a PGP key details. The private key content is not output on screen.
...
To get the details for a PGP key:
| Code Block |
|---|
waarpudmg-gatewayclient sb_pgp get test1.key |
To get the details for a PGP key and extract the key contents:
| Code Block |
|---|
waarpudmg-gatewayclient sb_pgp get -x test1.txt test1.key |
...
test1.txt: content of the private key fieldtest1.txt.pub: content of the public key field
Delete a key
| Code Block |
|---|
waarpudmg-gateway sbclient sb_pgp delete <key_name> |
Delete the given key.
Example
| Code Block |
|---|
waarpudmg-gatewayclient sb_pgp delete test1.key |
Audit Management
...
List audit records
| Code Block |
|---|
waarpudmg-gateway sbclient sb_audit list |
Displays a list of all audit records meeting the criteria below.
| short option | long option | description |
|---|---|---|
| -l | --limit= | The maximum number of records allowed in the response. Set to 20 by default. |
| -o | --offset= | Index of the first returned entry (default: 0). |
| -s | --sort=[id+|id-] | The setting and order in which records will be displayed. The possible choices are:
|
Example
| Code Block |
|---|
waarpudmg-gatewayclient sb_audit list -l 10 -o 5 -s 'id+' |
Get an audit record
| Code Block |
|---|
waarpudmg-gateway sbclient sb_audit get <id> |
Retrieve an audit record details.
...
To get the details for a PGP key:
| Code Block |
|---|
waarpudmg-gatewayclient sb_pgp getaudit get 12 |