manpagez: man (manual) pages & more
man calendarserver_manage_principals(8)
Home | html | info | man
CALENDARSERVER_MANAGE_... BSD System Manager's ManualCALENDARSERVER_MANAGE_...


NAME

     calendarserver_manage_principals -- Darwin Calendar Server principal man-
     agement 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 principals 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/caldavd.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 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

Mac OS X 10.6Server - Generated Thu Apr 15 07:12:58 CDT 2010