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 PKI TPS profiles.
7
8

SYNOPSIS

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

DESCRIPTION

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

OPTIONS

53       The CLI options are described in pki(1).
54
55

OPERATIONS

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

AUTHORS

158       Endi S. Dewata lt;edewata@redhat.comgt;.
159
160

COPYRIGHT

162       Copyright  (c)  2015 Red Hat, Inc.  This is licensed under the GNU Gen‐
163       eral Public License, version 2 (GPLv2).  A  copy  of  this  license  is
164       available at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
165
166
167
168PKI                              Jul 14, 2015               pki-tps-profile(1)