pki-tps-profile(1)

1pki-tps-profile(1)    PKI TPS Profile Management Commands   pki-tps-profile(1)
2
3
4

NAME

6       pki-tps-profile  - Command-Line Interface for managing Certificate Sys‐
7       tem TPS profiles.
8
9

SYNOPSIS

11       pki [CLI options] tps-profile
12       pki [CLI options] tps-profile-find [command options]
13       pki [CLI options] tps-profile-show <profile ID> [command options]
14       pki [CLI options] tps-profile-add --input <file path> [command options]
15       pki [CLI options] tps-profile-mod <profile ID> --action <action> [command options]
16       pki [CLI options] tps-profile-mod <profile ID> --input <file path> [command options]
17       pki [CLI options] tps-profile-del <profile ID> [command options]
18
19

DESCRIPTION

21       The pki tps-profile commands provide command-line interfaces to  manage
22       profiles on the TPS.
23
24
25       pki [CLI options] tps-profile-find [command options]
26           This command is to list the profiles.
27
28       pki [CLI options] tps-profile-show <profile ID> [command options]
29           This command is to view the details of a profile.
30
31       pki [CLI options] tps-profile-add --input <file path> [command options]
32           This command is to create a new profile.
33
34       pki  [CLI options] tps-profile-mod <profile ID> --action <action> [com‐
35       mand options]
36           This command is to change the status of a profile.
37
38       pki [CLI options]  tps-profile-mod  <profile  ID> --input  <file  path>
39       [command options]
40           This command is to modify an existing profile.
41
42       pki [CLI options] tps-profile-del <profile ID> [command options]
43           This command is to delete a profile.
44
45

OPTIONS

47       The CLI options are described in pki(1).
48
49

OPERATIONS

51       To  view available profile commands, type pki tps-profile. To view each
52       command's usage, type  pki tps-profile-<command> --help.
53
54       All the tps-profile commands require TPS admin or agent authentication.
55
56
57   Listing profiles
58       To list all profile:
59
60       pki <TPS admin/agent authentication> tps-profile-find
61
62       The results can be paged using the --start and --size options described
63       in pki(1).
64
65
66   Viewing a profile
67       To view the status and properties of a profile:
68
69       pki <TPS admin/agent authentication> tps-profile-show <profile ID>
70
71       To store the output of the above operation into a file:
72
73       pki  <TPS  admin/agent  authentication>  tps-profile-show  <profile ID>
74       --output <file path>
75
76
77   Adding a profile
78       To add a new profile, prepare an  input  file  specifying  the  profile
79       properties in the following format:
80
81
82              <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
83              <Profile id="..." xmlns:ns2="http://www.w3.org/2005/Atom">
84                  <Properties>
85                      <Property name="...">...</Property>
86                      ...
87                  </Properties>
88              </Profile>
89
90
91       The  profile properties are described in pki-tps-profile(5).  Then exe‐
92       cute the following command:
93
94       pki <TPS admin authentication> tps-profile-add --input <file path>
95
96
97   Changing profile status
98       To change the profile status execute the following command:
99
100       pki  <TPS  admin/agent  authentication>  tps-profile-mod  <profile  ID>
101       --action <action>
102
103       Available  actions  for  admins: submit, cancel.  Available actions for
104       agents: approve, reject.  Available actions for users with  both  admin
105       and agent rights: enable, disable.
106
107
108   Modifying a profile
109       To  modify  a profile, first disable the profile using the tps-profile-
110       mod --action disable command. Then download the current profile proper‐
111       ties  using  the  tps-profile-show --output command. Make the modifica‐
112       tions in the file, then upload the updated  file  using  the  following
113       command:
114
115       pki  <TPS  admin  authentication>  tps-profile-mod <profile ID> --input
116       <file path>
117
118       Finally, the profile should be  re-enabled  using  the  tps-profile-mod
119       --action enable command.
120
121
122   Deleting a profile
123       To  delete  a profile, first disable the profile using the tps-profile-
124       mod --action disable command, then execute:
125
126       pki <TPS admin authentication> tps-profile-del <profile ID>
127
128

AUTHORS

130       Endi S. Dewata <edewata@redhat.com>.
131
132

COPYRIGHT

134       Copyright (c) 2015 Red Hat, Inc. This is licensed under the GNU General
135       Public  License, version 2 (GPLv2). A copy of this license is available
136       at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
137
138