Smarter by Design.Simpler for Business
lb private-key
The lb private-key command manages the library of the private keys created on the device. The keys are created in the certificate flows; this command lists them, names them and, when needed, deletes them. Its panel equivalent is the Private Key Library screen.
The key is not created with this command
The private key is formed on the device in a certificate request (lb certificate create-csr), in an internal creation (issue-internal) or in the ACME flow, and it does not leave the device. This command manages only the library.
Command Summary
# Tab after the command
admin@TR7LBWAF01> lb private-key
add delete list show update
admin@TR7LBWAF01> lb private-key list # list all of them
admin@TR7LBWAF01> lb private-key show <id> # show one
admin@TR7LBWAF01> lb private-key add name <name> # name the record
admin@TR7LBWAF01> lb private-key update id <id> … # change
admin@TR7LBWAF01> lb private-key delete <id> # delete
admin@TR7LBWAF01>
Required Fields
| Order | Field | Status | Value |
|---|---|---|---|
| 1 | name | Required | The name of the record; it must be unique in the collection |
There is no other required field in the add command; in the show and delete commands the id is written without the field name, and in the update command in the form id <id>.
Fields
| Field | Status | What it does | What is written after it |
|---|---|---|---|
name | Required | Gives a name to the key record | The name of the record; it must be unique in the collection |
There is no field in this command that writes the key content: the key is created on the device, is kept encrypted in the record and cannot be read from the command line.
Example
# the keys in the library
admin@TR7LBWAF01> lb private-key list
admin@TR7LBWAF01> lb private-key show <id>
# renaming and deleting the record
admin@TR7LBWAF01> lb private-key update id <id> --name portal-key
admin@TR7LBWAF01> lb private-key delete <id>
admin@TR7LBWAF01>
Things to Know
- The key does not leave the device. The private key stays where it is created; it can neither be written nor read from the command line.
- A key in use should not be deleted. When a key bound to a certificate is deleted, that certificate becomes unusable.
- The name is unique. A second key record with the same name cannot be created.
