.nh
.TH pki-group 1 "May 5, 2014" PKI "PKI Group Management Commands"
.SH NAME
.PP
pki-group - Command-line interface for managing PKI groups.

.SH SYNOPSIS
.PP
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-group\fP
.br
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-group-find\fP [\fIcommand-options\fP]
.br
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-group-show\fP \fIgroup-ID\fP [\fIcommand-options\fP]
.br
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-group-add\fP \fIgroup-ID\fP [\fIcommand-options\fP]
.br
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-group-mod\fP \fIgroup-ID\fP [\fIcommand-options\fP]
.br
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-group-del\fP \fIgroup-ID\fP [\fIcommand-options\fP]

.SH DESCRIPTION
.PP
The \fBpki <subsystem>-group\fP commands provide command-line interfaces to manage groups on the specified subsystem.

.PP
Valid subsystems are \fBca\fP, \fBkra\fP, \fBocsp\fP, \fBtks\fP, and \fBtps\fP\&.

.PP
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-group\fP
.br
    This command is to list available group commands for the subsystem.

.PP
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-group-find\fP [\fIcommand-options\fP]
.br
    This command is to list groups in the subsystem.

.PP
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-group-show\fP \fIgroup-ID\fP [\fIcommand-options\fP]
.br
    This command is to view a group details in the subsystem.

.PP
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-group-add\fP \fIgroup-ID\fP [\fIcommand-options\fP]
.br
    This command is to add a group into the subsystem.

.PP
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-group-mod\fP \fIgroup-ID\fP [\fIcommand-options\fP]
.br
    This command is to modify a group in the subsystem.

.PP
\fBpki\fP [\fICLI-options\fP] \fB<subsystem>-group-del\fP \fIgroup-ID\fP [\fIcommand-options\fP]
.br
    This command is to delete a group from the subsystem.

.SH OPTIONS
.PP
The CLI options are described in \fBpki(1)\fP\&.

.SH OPERATIONS
.PP
To view available group commands, type \fBpki <subsystem>-group\fP\&.
To view each command's usage, type \fBpki <subsystem>-group-<command> --help\fP\&.

.PP
All group commands must be executed as the subsystem administrator.

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

.PP
.RS

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

.fi
.RE

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

.PP
.RS

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

.fi
.RE

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

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

.PP
.RS

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

.fi
.RE

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

.PP
.RS

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

.fi
.RE

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

.PP
.RS

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

.fi
.RE

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

.PP
.RS

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

.fi
.RE

.SH SEE ALSO
.PP
\fBpki-group-member(1)\fP
.br
    Group member management commands

.SH AUTHORS
.PP
Ade Lee &lt;alee@redhat.com&gt;, Endi S. Dewata &lt;edewata@redhat.com&gt;,
and Matthew Harmsen &lt;mharmsen@redhat.com&gt;\&.

.SH COPYRIGHT
.PP
Copyright (c) 2014 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.