pki-group(1)

pki-group1

Command-line interface for managing pki groups.

Usage

pki [CLI-options] lt;subsystemgt;-group

pki [CLI-options] lt;subsystemgt;-group-find [command-options]

pki [CLI-options] lt;subsystemgt;-group-show group-ID [command-options]

pki [CLI-options] lt;subsystemgt;-group-add group-ID [command-options]

pki [CLI-options] lt;subsystemgt;-group-mod group-ID [command-options]

pki [CLI-options] lt;subsystemgt;-group-del group-ID [command-options]

Overview

The pki lt;subsystemgt;-group commands provide command-line interfaces to manage groups on the specified subsystem.

Valid subsystems are ca, kra, ocsp, tks, and tps.

pki [CLI-options] lt;subsystemgt;-group

This command is to list available group commands for the subsystem.

pki [CLI-options] lt;subsystemgt;-group-find [command-options]

This command is to list groups in the subsystem.

pki [CLI-options] lt;subsystemgt;-group-show group-ID [command-options]

This command is to view a group details in the subsystem.

pki [CLI-options] lt;subsystemgt;-group-add group-ID [command-options]

This command is to add a group into the subsystem.

pki [CLI-options] lt;subsystemgt;-group-mod group-ID [command-options]

This command is to modify a group in the subsystem.

pki [CLI-options] lt;subsystemgt;-group-del group-ID [command-options]

This command is to delete a group from the subsystem.

Options

The CLI options are described in pki(1).

Operations

To view available group commands, type pki lt;subsystemgt;-group. To view each command's usage, type pki lt;subsystemgt;-group-lt;commandgt; --help.

All group commands must be executed as the subsystem administrator.

For example, to list groups in CA execute the following command:

$ pki <CA admin authentication> ca-group-find

The results can be paged by specifying the (0-based) index of the first entry to return and the maximum number of entries returned:

$ pki <CA admin authentication> ca-group-find --start 20 --size 10

The above command will return entries #20 to #29.

To view a CA group, specify the group ID in the following command:

$ pki <CA admin authentication> ca-group-show testgroup

To add a CA group, specify the group ID in the following command:

$ pki <CA admin authentication> ca-group-add testgroup

To modify a CA group, specify the group ID and the attributes to be modified in the following command:

$ pki <CA admin authentication> ca-group-mod testgroup --description "Test Group"

To delete a CA group, specify the group ID in the following command:

$ pki <CA admin authentication> ca-group-del testgroup

Authors

Ade Lee lt;[email protected];, Endi S. Dewata lt;[email protected];, and Matthew Harmsen lt;[email protected];.

From pki-tools 10.10.2-3 in Debian 11 (Bullseye). Parsed by carta from the page's man source.