#261 Dogtag 10: Revisit command-line options of 'pkispawn' and 'pkidestroy' . . .
Closed: Fixed None Opened 11 years ago by mharmsen.

Consider making the following changes to 'pkispawn':

CURRENT 'pkispawn':

# pkispawn -h
usage: pkispawn -s <subsystem> -f <file> [--dry_run] [-h] [-u] [-v]
                [-i <instance>] [-d <admin_domain>] [--http_port <port>]
                [--https_port <port>] [--ajp_port <port>] [-p <prefix>]

PKI Instance Installation and Configuration

mandatory arguments:
  -s <subsystem>       where <subsystem> is CA, KRA, OCSP, RA, TKS, or TPS
  -f <file>            specifies configuration filename

optional arguments:
  --dry_run            do not actually perform any actions
  -h, --help           show this help message and exit
  -u                   update instance of specified subsystem
  -v                   display verbose information (details below)

custom arguments (OVERRIDES configuration file values):
  -i <instance>        PKI instance name (MUST specify REQUIRED ports)
  -d <admin_domain>    PKI admin domain name (instance name suffix)
  --http_port <port>   HTTP port (CA, KRA, OCSP, RA, TKS, TPS)
  --https_port <port>  HTTPS port (CA, KRA, OCSP, RA, TKS, TPS)
  --ajp_port <port>    AJP port (CA, KRA, OCSP, TKS)

test arguments:
  -p <prefix>          directory prefix to specify local directory [TEST ONLY]

VERBOSITY FLAGS    CONSOLE MESSAGE LEVEL       LOG MESSAGE LEVEL
=======================================================================
  NONE             error|warning               error|warning|info
  -v               error|warning|info          error|warning|info
  -vv              error|warning|info          error|warning|info|debug
  -vvv             error|warning|info|debug    error|warning|info|debug

PROPOSED 'pkispawn':

# pkispawn -h
usage: pkispawn -s <subsystem> -f <file> [--dry_run] [-h] [-u] [-v]
                [-p <prefix>]

PKI Instance Installation and Configuration

mandatory arguments:
  -s <subsystem>       where <subsystem> is CA, KRA, OCSP, RA, TKS, or TPS
  -f <file>            configuration filename (MUST specify complete path)

optional arguments:
  --dry_run            do not actually perform any actions
  -h, --help           show this help message and exit
  -u                   update instance of specified subsystem
  -v                   display verbose information (details below)

test arguments:
  -p <prefix>          directory prefix to specify local directory [TEST ONLY]

{POSSIBLY ADDITIONAL HELP TEXT REGARDING INSTANCE, DOMAIN, PORT INTERACTIONS}

VERBOSITY FLAGS    CONSOLE MESSAGE LEVEL       LOG MESSAGE LEVEL
=======================================================================
  NONE             error|warning               error|warning|info
  -v               error|warning|info          error|warning|info
  -vv              error|warning|info          error|warning|info|debug
  -vvv             error|warning|info|debug    error|warning|info|debug
 ```

CURRENT 'pkidestroy':

pkidestroy -h

usage: pkidestroy -s <subsystem> [--dry_run] [-h] [-v] [-i <instance>]
[-d <admin_domain>] [-p <prefix>]

PKI Instance Removal

mandatory arguments:
-s <subsystem> where <subsystem> is CA, KRA, OCSP, RA, TKS, or TPS

optional arguments:
--dry_run do not actually perform any actions
-h, --help show this help message and exit
-v display verbose information (details below)

custom arguments (OVERRIDES configuration file values):
-i <instance> PKI instance name
-d <admin_domain> PKI admin domain name (instance name suffix)

test arguments:
-p <prefix> directory prefix to specify local directory [TEST ONLY]

VERBOSITY FLAGS CONSOLE MESSAGE LEVEL LOG MESSAGE LEVEL

NONE error|warning error|warning|info
-v error|warning|info error|warning|info
-vv error|warning|info error|warning|info|debug
-vvv error|warning|info|debug error|warning|info|debug
```

PROPOSED 'pkidestroy':

# pkidestroy -h
usage: pkidestroy -s <subsystem> -i <instance> [--dry_run] [-h] [-v]
                  [-p <prefix>]

PKI Instance Removal

mandatory arguments:
  -s <subsystem>     where <subsystem> is CA, KRA, OCSP, RA, TKS, or TPS
  -i <instance>      FORMAT:  ${pki_instance_name}[.${pki_admin_domain_name}]

optional arguments:
  --dry_run          do not actually perform any actions
  -h, --help         show this help message and exit
  -v                 display verbose information (details below)

test arguments:
  -p <prefix>        directory prefix to specify local directory [TEST ONLY]

{POSSIBLE ADDITIONAL HELP TEXT EXPLAINING WHEN DOMAIN MUST BE SPECIFIED}

VERBOSITY FLAGS    CONSOLE MESSAGE LEVEL       LOG MESSAGE LEVEL
=======================================================================
  NONE             error|warning               error|warning|info
  -v               error|warning|info          error|warning|info
  -vv              error|warning|info          error|warning|info|debug
  -vvv             error|warning|info|debug    error|warning|info|debug

Resolved:

commit f589cc1e267d6d7b67a6463b4495b7a9c982669f
Author: Matthew Harmsen <mharmsen@redhat.com>
Date:   Sat Jul 28 18:59:30 2012 -0700

Metadata Update from @mharmsen:
- Issue assigned to mharmsen
- Issue set to the milestone: Dogtag 10.0 Alpha

7 years ago

Dogtag PKI is moving from Pagure issues to GitHub issues. This means that existing or new
issues will be reported and tracked through Dogtag PKI's GitHub Issue tracker.

This issue has been cloned to GitHub and is available here:
https://github.com/dogtagpki/pki/issues/832

If you want to receive further updates on the issue, please navigate to the
GitHub issue and click on Subscribe button.

Thank you for understanding, and we apologize for any inconvenience.

Login to comment on this ticket.

Metadata