pki-server-instance(8)

🌸 NAME 🌸

pki-server-instance — the command-line interface for managing PKI server instances. This is pki-server-instance(8), from the PKI Instance Management Commands fam, and yes bestie, it’s giving terminal royalty. ✨

✨ SYNOPSIS ✨

pki-server [CLI-options] instance
pki-server [CLI-options] instance-cert
pki-server [CLI-options] instance-cert-export
pki-server [CLI-options] instance-find
pki-server [CLI-options] instance-show instance-ID
pki-server [CLI-options] instance-start instance-ID
pki-server [CLI-options] instance-stop instance-ID
pki-server [CLI-options] instance-migrate --tomcat version instance-ID
pki-server [CLI-options] instance-nuxwdog-enable instance-ID
pki-server [CLI-options] instance-nuxwdog-disable instance-ID
pki-server [CLI-options] instance-externalcert-add -i instance-ID
--cert-file path --trust-args args --nickname nickname --token token
pki-server [CLI-options] instance-externalcert-del -i instance-ID
--nickname nickname --token token

💅 DESCRIPTION 💅

Okay so the pki-server instance commands are your CLI besties for managing PKI server instances. A PKI server instance is literally a single Apache Tomcat instance that contains one or more subsystems. Iconic setup, no cap. 🎀

The operations you can do include: listing and showing details about local instances; starting and stopping instances; performing instance migrations; and enabling or disabling password prompted instance startup using nuxwdog. All the important stuff, fr fr.

Here’s the whole roster:

• pki-server [CLI-options] instance — lists the available instance commands. It’s the “what can I even do here?” command. 💅
• pki-server [CLI-options] instance-cert — lists the available instance certificate commands. Certificate business, but make it organized. 🎀
• pki-server [CLI-options] instance-cert-export — exports system certificates and keys to a PKCS #12 file. The output filename and either a password or a password file are required. If no nicknames are specified, all the system certificates will be exported. Otherwise, it is possible to extract individual certificates (with or without their keys and trust arguments), and to append to an existing PKCS #12 file. Lowkey powerful. 🔥
• pki-server [CLI-options] instance-find — lists local PKI server instances. A little “who’s here?” roll call. ✨
• pki-server [CLI-options] instance-show instance-ID — views details about a particular instance. Main character energy for one specific instance. 👑
• pki-server [CLI-options] instance-start instance-ID — starts a PKI server instance. Classic start button behavior, but make it command line. 🫶

⚠️ Heads up: currently this command cannot be used to start nuxwdog-enabled instances.

• pki-server [CLI-options] instance-stop instance-ID — stops a PKI server instance. The “okay bestie, wrap it up” command. 💀

⚠️ Heads up: currently this command cannot be used to stop nuxwdog-enabled instances.

• pki-server [CLI-options] instance-migrate --tomcat version instance-ID — there are differences in configuration between Apache Tomcat 7 and Apache Tomcat 8. This command reconfigures a PKI server instance to match the specified Tomcat version. You can use this to migrate an instance that was initially created under Tomcat 7 when Tomcat gets upgraded. See pki-server migrate(8) for further details. Migration glow-up, periodt. 🌈
• pki-server [CLI-options] instance-nuxwdog-enable instance-ID — converts a PKI server instance to start without access to a password file, using the nuxwdog daemon. See pki-server nuxwdog(8) for further details. Turning on the nuxwdog vibe. 🦋
• pki-server [CLI-options] instance-nuxwdog-disable instance-ID — converts a PKI server instance to start with access to a password file, rather than using the nuxwdog daemon. See pki-server nuxwdog(8) for further details. Turning the nuxwdog vibe back off. 💜
• pki-server [CLI-options] instance-externalcert-add -i instance-ID --cert-file path --trust-args args --nickname nickname --token token — adds a certificate to the certificate database for a PKI server instance. The certificate will be kept track of in the configuration file external_certs.conf, and will automatically be exported when the system certificates are exported. To update a certificate, the old one needs to be removed first using the delete command below. The trust arguments are those defined for NSS databases, e.g. "CT,C,C". See certutil(1) for more details. Certificate admin slay. 🎀
• pki-server [CLI-options] instance-externalcert-del -i instance-ID --nickname nickname --token token — removes a certificate from the certificate database for a PKI server instance. The “it’s not you, it’s the certificate database” command. 💅

🎀 OPTIONS 🎀

The CLI options are described in pki-server(8). Go check that page, bestie — that’s where the CLI-options tea lives. 🫶

🦋 OPERATIONS 🦋

To view available instance management commands, type pki-server instance. To view each command's usage, type pki-server instance-lt;commandgt; --help. Peak “help me help you” energy. ✨

💖 AUTHORS 💖

Ade Lee lt;alee@redhat.comgt;. Big slay to Ade. 👑

📜 COPYRIGHT 📜

Copyright (c) 2015 Red Hat, Inc. This is licensed under the GNU General Public License, version 2 (GPLv2). A copy of this license is available at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt. Legal bestie moment, but make it iconic. 💜

---

🎀 Source/version: PKI · Date: July 15, 2015 · Manual: pki-server-instance(8) — that’s the footer bestie, and that’s the whole page! 💖