This manual page is for Mac OS X Server version 10.6

If you are running Mac OS X (client), this command is not available.

If you are running a different version of Mac OS X Server, view the documentation locally:

  • In Xcode

  • In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

  • For more information about the manual page format, see the manual page for manpages(5).

  • For more information about this technology, look for other documentation in the Apple Reference Library.

  • For general information about writing shell scripts, read Shell Scripting Primer.



CALENDARSERVER_MANAGE_PRINCIPALS(8)      BSD System Manager's Manual     CALENDARSERVER_MANAGE_PRINCIPALS(8)

NAME
     calendarserver_manage_principals -- Darwin Calendar Server principal management utility

SYNOPSIS
     calendarserver_manage_principals [--config file] [--read-property property] [--list-read-proxies]
                                      [--list-write-proxies] [--list-proxies] [--add-read-proxy principal]
                                      [--add-write-proxy principal] [--remove-proxy principal]
                                      [--set-auto-schedule true|false] [--get-auto-schedule] principal
                                      [principal ...]

DESCRIPTION
     calendarserver_manage_principals is a tool for accessing and manipulating information regarding princi-pals principals
     pals on a Darwin Calendar Server.  Principals represent any form of actor that can access the server,
     such as users, groups, locations and resources.

     calendarserver_manage_principals should be run as a user with the same priviledges as the Calendar
     Server itself, as it needs to read and write data that belongs to the server.
     calendarserver_manage_principals takes a list of principals as arguments and then performs the
     requested actions on each of the given principals.

     A principal may be specified as the principal's GUID. Alternatively, it may be specified in the form
     recordType:shortName, where recordType is a directory record type (eg.  users, groups, locations,
     resources) and shortName is the principal's short name.

     Actions to perform are specified via the options below.  Multiple actions may be given, and will be
     performed in the order given on each principal specified.

OPTIONS
     -h, --help
           Displays usage information

     -f, --config FILE
           Use the Calendar Server configuration specified in the given file.  Defaults to /etc/caldavd/cal-davd.plist. /etc/caldavd/caldavd.plist.
           davd.plist.

ACTIONS
     --read-property property
           Read the given WebDAV property on the principal resource.  property must be a fully qualified XML
           element name in the form {namespace}name, for example: {DAV:}displayname.

     --list-read-proxies
           List the read proxies.

     --list-write-proxies
           List the write proxies.

     --list-proxies
           List all proxies.

     --add-read-proxy principal
           Add the given principal as a read proxy.

     --add-write-proxy principal
           Add the given principal as a write proxy.

     --remove-proxy principal
           Remove the given principal as a proxy.

     --set-auto-schedule true|false
           Enable or disable automatic scheduling.

     --get-auto-schedule
           Get the automatic scheduling state.

EXAMPLES
     Add Alice and Bob as read proxies for Joe and display the list of Joe's proxies:

           calendarserver_manage_principals --add-read-proxy users:alice --add-read-proxy users:bob --list-proxies --listproxies
           proxies users:joe

     Add a group of room admins as write proxy for a couple of rooms:

           calendarserver_manage_principals --add-write-proxy groups:room-admins locations:bigroom
           locations:littleroom

     Turn on auto-scheduling for a resource, and confirm the setting:

           calendarserver_manage_principals --set-auto-schedule true --get-auto-schedule resources:projector

FILES
     /etc/caldavd/caldavd.plist
           The Calendar Server configuration file.

SEE ALSO
     caldavd(8)

BSD                                             June 17, 2009                                            BSD

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors
Report errors in the content of this documentation with the feedback links below.
Bug reports
Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems
Report formatting mistakes in the online version of these pages with the feedback links below.