openchangepfadmin(1)

1OPENCHANGEPFADMIN(1)       OpenChange Users' Manual       OPENCHANGEPFADMIN(1)
2
3
4

NAME

6       openchangepfadmin  -  Exchange  users  and Public Folder administration
7       tool
8
9

SYNOPSIS

11       openchangepfadmin [-?] [-?|--help] [--usage] [-f|--database PATH] [-p|--profile PROFILE]
12           [-P|--password PASSWORD] [--apassword=PASSWORD] [--adesc=DESCRIPTION] [--acomment=COMMENT]
13           [--afullname=NAME] [--list] [--mkdir] [--rmdir] [--comment=COMMENT] [--dirclass=CLASS]
14           [--adduser=USERNAME] [--rmuser=USERNAME] [--addright=RIGHT] [--rmright] [--modright=RIGHT]
15           [--debuglevel=LEVEL] [--dump-data] [--folder=FOLDER] [--username=USERNAME]
16
17

DESCRIPTION

19       openchangepfadmin is a administrative command  line  tool  designed  to
20       facilitate  user management related operations (create, delete, modify)
21       on a remote Exchange server and manage public folder store and  permis‐
22       sions.
23
24

COMMANDS

26       --adduser=USERNAME
27              Create a Exchange user with the username specified by USERNAME
28
29
30       --rmuser=USERNAME
31              Delete the Exchange user account specified by USERNAME
32
33
34       --list List Public Folder hierarchy (IPM_SUBTREE)
35
36
37       --mkdir
38              Create a folder in the Public Folder store
39
40
41       --rmdir
42              Delete a folder in the Public Folder store
43
44
45       --addright=RIGHT
46              Add  permission  and  roles for a user on a Public Folder direc‐
47              tory.
48
49
50       --modright=RIGHT
51              Modify permissions and roles for  a  user  on  a  Public  Folder
52              directory
53
54
55       --rmright
56              Delete permissions and roles for a specific user
57
58
59

OPTIONS

61       --database=DATABASE
62
63       -f     Set the MAPI profile database. If no database is specified, then
64              openchangeclient tries to load  the  default  one:  $HOME/.open‐
65              change/profiles.ldb
66
67
68       --profile=PROFILE
69
70       -p     Set  the  profile to use. If a profile is not specified, and one
71              of the profiles has been set as the default in the profile data‐
72              base (for example, using mapiprofile -S), then that default pro‐
73              file will be used.
74
75
76       --password
77
78       -P     Set the password for the profile to use. This can be omitted  if
79              the password is stored in the profile.
80
81
82       --apassword=PASSWORD
83              Define   the  password  to  set  for  the  user  specified  with
84              --adduser. If no password is explicitely supplied,  openchangep‐
85              fadmin will arbitrary set a random one.
86
87
88       --adesc=DESCRIPTION
89              This  command  can  only  be used with --adduser and specifies a
90              description for this account
91
92
93       --acomment=COMMENT
94              This command can only be used with  --adduser  and  specifies  a
95              comment for this account.
96
97
98       --afullname=NAME
99              This  command  can only be used with --adduser and specifies the
100              user full name for this account.
101
102
103       --comment=COMMENT
104              This command can only be used with --mkdir and specifies a  com‐
105              ment for the folder.
106
107
108       --dirclass=CLASS
109              This  command  can  only  be used with --mkdir and specifies the
110              container class of the directory we  want  to  create.  Possible
111              values are: IPF.Appointment, IPF.Contact, IPF.Journal, IPF.Note,
112              IPF.StickyNote, IPF.Task, IPF.Post
113
114
115       --folder=FOLDER
116              This command can only be used with  --addright,  --modright  and
117              --rmright.  Specify  the folder where permissions and roles have
118              to be changed.
119
120
121       --username=USERNAME
122              This command can only be used with  --addright,  --modright  and
123              --rmright.  Specify  the  username we want to change permissions
124              and roles for.
125
126
127       --dump-data
128              Dump the hex data. This is only required for debugging or educa‐
129              tional purposes.
130
131
132       --debuglevel LEVEL
133
134       -d     Set the debug level.
135
136

EXAMPLES

138       Creating user
139       openchangepfadmin --adduser=linuxowner --apassword=linuxowner   \
140                           --adesc="Linux Owner Test account"          \
141                     --afullname="Linux Owner"
142           mapiadmin_user_add       : MAPI_E_SUCCESS (0x0)
143       username: linuxowner
144       password: linuxowner
145
146       Creates a user account with username and password set to linuxowner.
147
148       Deleting user:
149       openchangepfadmin --rmuser=linuxowner
150           mapiadmin_user_del       : MAPI_E_SUCCESS (0x0)
151
152       Create Public Folder:
153       openchangepfadmin --mkdir --folder=public_events --dirclass=IPF.Appointment
154
155       Creates  a folder in the Public Folder store named public_events with a
156       container class set to Appointment. This folder will  display  calendar
157       items.
158
159       Delete Public Folder:
160       openchangepfadmin --rmdir --folder=public_events
161
162       List Public Folder hierarchy:
163       openchangepfadmin --list
164
165       Add Permission:
166       openchangepfadmin --username=linuxowner --folder=public_events \
167                           --addright=RoleOwner
168       Permission RoleOwner added for linuxowner on folder public_events
169
170       Modify Permission
171       openchangepfadmin --username=Anonymous --folder=public_events \
172                     --modright=RoleNone
173       Permission changed to RoleNone for Anonymous on folder appointment
174
175       Note  that you can only change permissions for a user already listed in
176       the ACL table.
177
178

NOTE

180       Permissions and Roles possible values are:
181
182       · RightsNone
183
184       · RightsReadItems
185
186       · RightsCreateItems
187
188       · RightsEditOwn
189
190       · RightsDeleteOwn
191
192       · RightsEditAll
193
194       · RightsDeleteAll
195
196       · RightsCreateSubfolders
197
198       · RightsFolderOwner
199
200       · RightsFolderContact
201
202       · RoleNone
203
204       · RoleReviewer
205
206       · RoleContributor
207
208       · RoleNoneditingAuthor
209
210       · RoleAuthor
211
212       · RoleEditor
213
214       · RolePublishAuthor
215
216       · RolePublishEditor
217
218       · RightsAll
219
220       · RoleOwner
221
222

AUTHOR

228       Julien Kerihuel <j.kerihuel at openchange dot org>
229
230
231
232OpenChange 2.0 QUADRANT           2013-01-24              OPENCHANGEPFADMIN(1)