.nh
.TH pki-tps-profile 1 "Jul 14, 2015" PKI "PKI TPS Profile Management Commands"
.SH NAME
.PP
pki-tps-profile - Command-line interface for managing PKI TPS profiles.

.SH SYNOPSIS
.PP
\fBpki\fP [\fICLI-options\fP] \fBtps-profile\fP
.br
\fBpki\fP [\fICLI-options\fP] \fBtps-profile-find\fP [\fIcommand-options\fP]
.br
\fBpki\fP [\fICLI-options\fP] \fBtps-profile-show\fP \fIprofile-ID\fP [\fIcommand-options\fP]
.br
\fBpki\fP [\fICLI-options\fP] \fBtps-profile-add\fP --input \fIfile-path\fP [\fIcommand-options\fP]
.br
\fBpki\fP [\fICLI-options\fP] \fBtps-profile-mod\fP \fIprofile-ID\fP --action \fIaction\fP [\fIcommand-options\fP]
.br
\fBpki\fP [\fICLI-options\fP] \fBtps-profile-mod\fP \fIprofile-ID\fP --input \fIfile-path\fP [\fIcommand-options\fP]
.br
\fBpki\fP [\fICLI-options\fP] \fBtps-profile-del\fP \fIprofile-ID\fP [\fIcommand-options\fP]

.SH DESCRIPTION
.PP
The \fBpki tps-profile\fP commands provide command-line interfaces to manage profiles on the TPS.

.PP
\fBpki\fP [\fICLI-options\fP] \fBtps-profile-find\fP [\fIcommand-options\fP]
.br
    This command is to list the profiles.

.PP
\fBpki\fP [\fICLI-options\fP] \fBtps-profile-show\fP \fIprofile-ID\fP [\fIcommand-options\fP]
.br
    This command is to view the details of a profile.

.PP
\fBpki\fP [\fICLI-options\fP] \fBtps-profile-add\fP --input \fIfile-path\fP [\fIcommand-options\fP]
.br
    This command is to create a new profile.

.PP
\fBpki\fP [\fICLI-options\fP] \fBtps-profile-mod\fP \fIprofile-ID\fP --action \fIaction\fP [\fIcommand-options\fP]
.br
    This command is to change the status of a profile.

.PP
\fBpki\fP [\fICLI-options\fP] \fBtps-profile-mod\fP \fIprofile-ID\fP --input \fIfile-path\fP [\fIcommand-options\fP]
.br
    This command is to modify an existing profile.

.PP
\fBpki\fP [\fICLI-options\fP] \fBtps-profile-del\fP \fIprofile-ID\fP [\fIcommand-options\fP]
.br
    This command is to delete a profile.

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

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

.PP
All the \fBpki tps-profile\fP commands require TPS admin or agent authentication.

.SS Listing profiles
.PP
To list all profile:

.PP
.RS

.nf
$ pki <TPS admin/agent authentication> tps-profile-find

.fi
.RE

.PP
The results can be paged using the \fB--start\fP and \fB--size\fP options described in \fBpki(1)\fP\&.

.SS Viewing a profile
.PP
To view the status and properties of a profile:

.PP
.RS

.nf
$ pki <TPS admin/agent authentication> tps-profile-show <profile ID>

.fi
.RE

.PP
To store the output of the above operation into a file:

.PP
.RS

.nf
$ pki <TPS admin/agent authentication> tps-profile-show <profile ID> --output <file path>

.fi
.RE

.SS Adding a profile
.PP
To add a new profile, prepare an input file specifying the profile properties in the following format:

.PP
.RS

.nf
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Profile id="..." xmlns:ns2="http://www.w3.org/2005/Atom">
    <Properties>
        <Property name="...">...</Property>
        ...
    </Properties>
</Profile>

.fi
.RE

.PP
The profile properties are described in \fBpki-tps-profile(5)\fP\&.
Then execute the following command:

.PP
.RS

.nf
$ pki <TPS admin authentication> tps-profile-add --input <file path>

.fi
.RE

.SS Changing profile status
.PP
To change the profile status execute the following command:

.PP
.RS

.nf
$ pki <TPS admin/agent authentication> tps-profile-mod <profile ID> --action <action>

.fi
.RE

.PP
Available actions for admins: submit, cancel.
Available actions for agents: approve, reject.
Available actions for users with both admin and agent rights: enable, disable.

.SS Modifying a profile
.PP
To modify a profile, first disable the profile using the \fBtps-profile-mod --action disable\fP command.
Then download the current profile properties using the \fBtps-profile-show --output\fP command.
Make the modifications in the file, then upload the updated file using the following command:

.PP
.RS

.nf
$ pki <TPS admin authentication> tps-profile-mod <profile ID> --input <file path>

.fi
.RE

.PP
Finally, the profile should be re-enabled using the \fBtps-profile-mod --action enable\fP command.

.SS Deleting a profile
.PP
To delete a profile, first disable the profile using the \fBtps-profile-mod --action disable\fP command, then execute:

.PP
.RS

.nf
$ pki <TPS admin authentication> tps-profile-del <profile ID>

.fi
.RE

.SH SEE ALSO
.PP
\fBpki(1)\fP, \fBpki-tps-profile(5)\fP

.SH AUTHORS
.PP
Endi S. Dewata &lt;edewata@redhat.com&gt;\&.

.SH COPYRIGHT
.PP
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.