TIBCO Spotfire® Server and Environment - Installation and Administration

config-windows-userdir

Configures the Windows user directory mode.

config-windows-userdir 
[-c value | --configuration=value] 
[-b value | --bootstrap-config=value] 
[-d value | --domains=value] 
[-t value | --sleep-time=value] 
[--schedules=value]

Overview

Use this command to configure the Windows user directory mode. If no arguments are specified, the command displays the current configuration.

Options

Option Optional or Required Default Value Description
-c value
--configuration=value
Optional configuration.xml The path to the server configuration file.
-b value
--bootstrap-config=value
Optional none The path to the bootstrap configuration file. See Bootstrap.xml file for more information about this file.
-d value
--domains=value
Optional none A comma-separated list of domain names. When specifying more than one domain name, make sure to enclose the list of names in quotes.
-t value
--sleep-time=value
Optional 60 minutes The number of minutes between each synchronization. The --sleep-time and --schedules arguments are mutually exclusive. If neither the ‐‐sleep‐time argument nor the ‐‐schedules argument is specified, the synchronization is performed with a sleep time of 60 minutes.
--schedules=value
Optional none A comma-separated list of schedules for when the synchronization should be performed. The --sleep-time and --schedules arguments are mutually exclusive. The schedules are given in a cron-compatible format, where each schedule consists of either five fields or one shorthand label. Make sure to enclose the value in double quotes.

The five fields are, from left to right, with their valid ranges: minute (0-59), hour (0-23), day of month (1-31), month (1-12) and day of week (0-7, where both 0 and 7 indicate Sunday). You can configure a field with the wildcard character *, indicating that any moment in time matches this field. An LDAP synchronization is triggered when all fields match the current time. If both day of month and day of week have non-wildcard values, then only one of them has to match.

You can use the following shorthand labels instead of the full cron expressions:

@yearly or @annually: run once a year (equivalent to 0 0 1 1 *)

@monthly: run once a month (equivalent to 0 0 1 * *)

@weekly: run once a week (equivalent to 0 0 * * 0)

@daily or @midnight: run once a day (equivalent to 0 0 * * *) @hourly: run once an hour (equivalent to 0 * * * *)

@minutely: run once a minute (equivalent to * * * * *)

@reboot or @restart: run every time Spotfire Server is started

Consult the Wikipedia article for an overview of the cron scheduler: http://en.wikipedia.org/wiki/Cron.