Performs operations on a schedule. When it is used without other schedule action options, all schedules on the server are listed.
Syntax
DswCli.exe -schedule
[-add | -modify | -delete | -detail]
[-scheduleId]
[schedule_option]
[authentication_parameters]
For information about how to provide the servername and login credentials that are needed to connect to the server that you want to manage, see Section 3.3, Authentication Parameters.
Specifies a textual description of the schedule. The description is optional.
Syntax
-description=<"text">
Example
-description="Custom schedule for the Finance department"
Specifies the schedule identifier. You can provide the schedule name, or provide the GUID of the schedule. A GUID is automatically assigned by Dynamic File Services when you create a schedule.
Syntax
-scheduleId=<"schedulename"|"GUID">
Examples
-scheduleId="quarterly_1st" -scheduleId="custom_financial"
Specifies whether the type of schedule is a review schedule or a policy schedule.
Syntax
-scheduleType=<"review"|"policy">
Examples
-scheduleType="review" -scheduleType="policy"
The -add action with the “review” schedule type creates a review schedule with the specified name and stores the configuration as an XML file in the C:\ProgramData\Dynamic File Services\Schedules folder.
DswCli.exe -SCHEDULE
-ADD
-name=<schedulename>
-scheduleType="review"
[-description=<"text">]
[-monthly=<SEE FORMAT>]
[-quarterly=<SEE FORMAT>]
[-yearly=<SEE FORMAT>]
[-custom=<SEE FORMAT>]
[authentication_parameters]
After you add a review schedule, you can associate it with one or more retention pairs. For information, see Section 3.8.9, Associate a Review Schedule to a Retention Pair.
Specifies a name for the schedule. The name must be unique on the server you are managing.
Syntax
-name=<"schedulename">
Example
-name="quarterly_1st"
Specify one of the following date options for the schedule. The dates indicate when you want to perform reviews. Notifications are sent by default at 12:10 a.m. (0010 hours) on that date. The default time is controlled by the setting in the ..\Dynamic File Services\DswCore.xml file.
Use the “last” option to specify that the policy runs on the last day of every month. The policy runs on day 28, 29, 30, or 31, according to how many days are in the month.
Specifies the custom dates that you want to review the retained data in a retention pair.
Syntax
-Custom=<"dd:nn:<yy|yyyy>[,dd:nn:<yy|yyyy>,...]">
Where:
Example
The following example sends review notifications for a retention pair so that reviews can be held on March 30, 2011, April 15, 2011, and June 30, 2011:
-custom="30:03:2011,15:04:11,30:06:11"
Specifies a monthly review frequency. You must specify the month and calendar day to begin the review cycle. Reviews are planned on the same calendar day in each month. The cycle repeats with no end time.
Syntax
-monthly=<"<dd|'last'>:nn">
Where:
Example
The following example sends review notifications for a retention pair so that reviews can be held on the last day of every month, beginning in June of the current year. Reviews are planned for June 30, July 31, August 31, September 30, October 31, November 30, December 31, January 31, February 28 (or 29 in a leap year), March 31, April 30, and May 31. The cycle repeats with no end time.
-monthly="last:06"
Specifies a quarterly review frequency. You must specify the month and calendar day to begin the review cycle. Reviews are planned on the same calendar day every three months. The cycle repeats with no end time.
Syntax
-quarterly=<"<dd|'last'>:nn">
Where:
Example
The following example sends review notifications for a retention pair so that reviews can be held on the last day of every quarter, beginning in June of the current year. Reviews are planned for June 30, September 30, December 31, and March 31. The cycle repeats with no end time.
-quarterly="last:06"
Specifies a yearly frequency. You must specify the month and calendar day to begin the review cycle. Reviews are planned on the same calendar day in each year. The cycle repeats with no end time.
Syntax
-yearly=<"<dd|'last'>:nn">
Where:
Example
The following example sends review notifications for a retention pair so that reviews can be held on January 15 of each year, beginning in January of the current year. Reviews are planned for January 15. The cycle repeats with no end time.
-yearly="15:01"
Each of the following -schedule commands creates a review schedule with the frequency specified. A schedule must be separately associated with a retention pair.
The following example sends review notifications for a retention pair so that reviews can be held on March 30, 2011, April 15, 2011, June 30, 2011, and January 2, 2012:
DswCli.exe -servername=localhost -u=Administrator -p=novell
-schedule
-add
-name="custom_financial"
-description="Custom schedule for the Finance department"
-custom="30:03:2011,15:04:11,30:06:11,02:01:12"
The following example sends review notifications for a retention pair so that reviews can be held quarterly, beginning on July 1 of the current year. Reviews are planned for July 1, October 1, January 1, and April 1 of each year.
DswCli.exe -servername=localhost -u=Administrator -p=novell
-schedule
-add
-name="quarterly_1st"
-quarterly="01:07"
The -add action with the “policy” schedule type creates a policy schedule with the specified name and stores the configuration as an XML file in the C:\ProgramData\Dynamic File Services\Schedules folder.
DswCli.exe -SCHEDULE
-ADD
-name=<schedulename>
-scheduleType="policy"
[-description=<"text">]
[-time=<SEE FORMAT>]
[-hourly=<SEE FORMAT>]
[-daily=<SEE FORMAT>]
[-weekly=<SEE FORMAT>]
[-monthly=<SEE FORMAT>]
[-quarterly=<SEE FORMAT>]
[-yearly=<SEE FORMAT>]
[-custom=<SEE FORMAT>]
[authentication_parameters]
After you add a policy schedule, you can associate it with one or more policies. For information, see Section 3.9.7, Associate a Policy Schedule to a Policy.
Specifies a name for the schedule. The name must be unique on the server you are managing.
Syntax
-name=<"schedulename">
Example
-name="quarterly_1st"
Specify only one frequency option in combination with the -add action. The specified frequency option determines when the is enforced. The policy is enforced for all pairs associated with the policy.
You can specify the start and stop time by using the -time option or by specifying the times as part of the frequency parameter.
The following frequency options are available:
If the -time option is not used, or if the time is not specified by a frequency option, a default start time of 00:00 (midnight) is assumed and the scan runs until complete.
If the start time is provided and the stop time is omitted, the scan starts at the given time and runs until complete.
Syntax
-time=<"hh[:mm[-hh:mm]]">
hh[:mm[hh:mm] ] specifies the scan start and stop time. Twenty-four-hour time is required with valid values of 00:00 to 23:45 (that is, midnight to 11:45 p.m.). The first two units specify hours from 00 to 23. The second two units specify minutes in 15-minute increments of 00, 15, 30, or 45.
Restrictions: This option cannot be combined with the following frequency options:
This option cannot be used in combination with other frequency options where the time is set explicitly as a parameter for the frequency.
Scan frequency is performed manually.
Restrictions: This option cannot be combined with the following frequency options:
Scan frequency is performed hourly.
Restrictions: This option cannot be combined with the following frequency options:
Scan frequency is performed daily.
If the start and stop time are omitted, a default start time of 00:00 (midnight) is assumed and the scan runs until complete.
If the start time is provided and the stop time is omitted, the scan starts at the given time and runs until complete.
Syntax
-daily[="hh:mm[-hh:mm]"]
hh:mm[hh:mm] specifies the scan start and stop time, respectively. Twenty-four-hour time is required with valid values of 00:00 to 23:45 (that is, midnight to 11:45 p.m.). The first two units specify hours from 00 to 23. The second two units specify minutes in 15-minute increments of 00, 15, 30, or 45.
Restrictions: This option cannot be combined with the following frequency options:
Example
The scan runs daily from 1:00 p.m. to 3:00 p.m.:
-daily="13:00-15:00"
Scan frequency is performed weekly.
If the day of the week and the start and stop times are omitted, the scan starts on Sunday at 00:00 (12:00 midnight), and the scan runs until complete.
If the start and stop time are omitted, a default start time of 00:00 (midnight) is assumed, and the scan runs until complete.
If the start time is provided and the stop time is omitted, the scan starts at the given time and runs until complete.
Syntax
-weekly[="ww|[@hh:mm[-hh:mm]]"]
Where
ww specifies the day of the week. Valid values are:
@hh:mm[-hh:mm] specifies the scan start and stop time.Twenty-four-hour time is required with valid values of 00:00 to 23:45 (that is, midnight to 11:45 p.m.). The first two units specify hours from 00 to 23. The second two units specify minutes in 15-minute increments of 00, 15, 30, or 45.
Restrictions: This option cannot be combined with the following frequency options:
Examples
The scan runs every Monday from 1:00 p.m. until complete:
-weekly="02@13:00"
The scan runs every Monday from 1:00 a.m. to 5:00 a.m.:
-weekly="02@01:00-05:00"
Scan frequency is performed monthly.
If the day of the month and the start and stop times are omitted, the scan starts on first day of the month at 00:00 (midnight) and runs until complete.
If the start and stop time are omitted, a default start time of 00:00 is assumed and the scan runs until complete.
If the start time is provided and the stop time is omitted, the scan starts at the given time and runs until complete.
Syntax
-monthly[="<dd|'last'>[@hh:mm-hh:mm]]"]
dd specifies the day of the month numerically. Valid values are from 01 to 31.
last specifies the last day of the calendar month (that is, 28, 29, 30, or 31 as appropriate).
@hh:mm[hh:mm] specifies the scan start and stop time. Twenty-four-hour time is required with valid values of 00:00 to 23:45 (that is, midnight to 11:45 p.m.). The first two units specify hours from 00 to 23. The second two units specify minutes in 15-minute increments of 00, 15, 30, or 45.
Restrictions: This option cannot be combined with the following frequency options:
Example
The scan runs on the 25th day of the month from 1:00 p.m. until complete:
-monthly="25@13:00"
Scan frequency is performed quarterly. You must specify the month and calendar day to begin the run. Reviews are planned on the same calendar day every three months. The cycle repeats with no end time.
Syntax
-quarterly=<"<dd|'last'>:nn">
Where:
Restrictions: This option cannot be combined with the following frequency options:
Example
Run the policy on the last day of every quarter, beginning in June of the current year. The scans occur on June 30, September 30, December 31, and March 31. The cycle repeats with no end time.
-quarterly="last:06"
Scan frequency is performed yearly.
The day of the month and the month fields are required to be specified. There are no defaults specified.
If the start and stop times are omitted, a default start time of 00:00 is assumed and the scan runs until complete.
If start time is provided and the stop time is omitted, the scan starts at the given time and runs until complete.
Syntax
-yearly=<"dd:nn[@hh:mm[-hh:mm]]">
dd specifies the day of the month numerically. Valid values are from 01 to 31.
nn specifies the month numerically. Valid values are 01 to 12, where the numbers correspond to the sequential months of the year in the Gregorian calendar.
@hh:mm[hh:mm] specifies the scan start and stop time. Twenty-four-hour time is required with valid values of 00:00 to 23:45 (that is, midnight to 11:45 p.m.). The first two units specify hours from 00 to 23. The second two units specify minutes in 15-minute increments of 00, 15, 30, or 45.
Restrictions: This option cannot be combined with the following frequency options:
Example
The scan runs on day 15, month 6, starting at 1:00 p.m. and running until complete:
-yearly="15:06@13:00"
Specifies the custom dates that you want to run the policy.
Syntax
-custom=<"dd:nn:<yy|yyyy>[,dd:nn:<yy|yyyy>,...]">
Where:
Restrictions: This option cannot be combined with the following frequency options:
Example
Schedule a policy to run on March 30, 2011, April 15, 2011, and June 30, 2011:
-custom="30:03:2011,15:04:11,30:06:11"
Each of the following -schedule commands creates a policy schedule with the frequency specified. A policy schedule is separately associated with one or more pairs.
The following example specifies the start and stop times as part of the frequency parameter:
DswCli.exe -servername=localhost -u=Administrator -p=novell
-schedule
-add
-scheduleType="policy"
-name="Weekly on Sunday"
‑weekly="01@01:00-05:00"
The following example specifies the start and stop times using the -time option:
DswCli.exe -servername=localhost -u=Administrator -p=novell
-schedule
-add
-scheduleType="policy"
-name="Weekly on Sunday"
-time="01:00-05:00"
‑weekly="01"
DswCli.exe -servername=localhost -u=Administrator -p=novell
-schedule
-add
-scheduleType="policy"
-name="Monthly Last Day of the Month"
-time="01:30"
‑monthly="last"
The -delete action removes the specified schedule from the database. All links to any retention pairs are removed.
DswCli.exe [authentication_parameters] -schedule
-delete
-scheduleId=<"schedulename"|"GUID">
Delete a schedule named custom_financial:
DswCli.exe -servername=localhost -u=Administrator -p=novell
-schedule
-delete
-scheduleId="custom_financial"
The -modify action changes the settings for an existing schedule. You cannot modify the schedule type. The new configuration is written to the schedule’s XML file in the C:\ProgramData\Dynamic File Services\Schedules folder.
DswCli.exe -schedule
-modify
-scheduleId=<"schedulename"|"GUID">
[-name=<schedulename>]
[-description=<"text">]
[-custom=<SEE FORMAT>]
[-monthly=<SEE FORMAT>]
[-quarterly=<SEE FORMAT>]
[-yearly=<SEE FORMAT>]
[authentication_parameters]
For modifying a schedule, the required parameters are schedule and scheduleId. Name, description, frequency, and time options can be changed. Schedule GUIDs and types cannot be changed.
The changes apply to all retention pairs that are associated with the review schedule.
For information, see the Add Schedule Dates Option
in Add a Review Schedule.
Each of the following -schedule commands modifies an existing schedule with the frequency specified. The changes apply to all retention pairs associated with the schedule.
A custom schedule is currently set for the dates March 30, 2011, April 15, 2011, June 30, 2011, and January 2, 2012. In December 2011, you decide to use the same dates for 2012. You must create a new schedule, or modify the existing custom dates. Make sure to account for the pending date in January. The revised schedule has five custom dates: January 2, 2012, March 30, 2012, April 15, 2012, June 30, 2012, and January 2, 2013.
DswCli.exe -servername=localhost -u=Administrator -p=novell
-schedule
-modify
-scheduleId="custom_financial"
-description="Custom schedule for the Finance department"
-custom=
"02:01:12,30:03:2012,15:04:12,30:06:12,02:01:13"
A current schedule is set for the first day of each quarter, beginning on July 1 of the current year. You want to modify the schedule to the 15th. The schedule name of quarterly_1st can be modified, such as quarterly_15th. You decide to modify the dates anyway. The revised schedule is planned for July 15, October 15, January 15, and April 15.
DswCli.exe -servername=localhost -u=Administrator -p=novell
-schedule
-modify
-scheduleId="quarterly_1st"
-name="quarterly_15th"
-quarterly="15:07"
The -modify action changes the settings for an existing schedule. You cannot modify the schedule type. The new configuration is written to the schedule’s XML file in the C:\ProgramData\Dynamic File Services\Schedules folder.
DswCli.exe -schedule
-modify
-scheduleId=<"schedulename"|"GUID">
[-name=<schedulename>]
[-description=<"text">]
[-time=<SEE FORMAT>]
[-hourly=<SEE FORMAT>]
[-daily=<SEE FORMAT>]
[-weekly=<SEE FORMAT>]
[-monthly=<SEE FORMAT>]
[-quarterly=<SEE FORMAT>]
[-yearly=<SEE FORMAT>]
[-custom=<SEE FORMAT>]
[authentication_parameters]
For modifying a schedule, the required parameters are schedule and scheduleId. Name, description, frequency and time options can be changed. Schedule GUIDs and types cannot be changed.
The changes apply to all polices that are associated with the policy schedule.
For information, see the Add Schedule Dates Option
in Add a Policy Schedule.
Each of the following -schedule commands modifies an existing policy schedule with the frequency specified. The changes apply to all policies associated with the schedule.
A custom schedule is currently set to run on the dates March 30, 2011, April 15, 2011, June 30, 2011, and January 2, 2012. In December 2011, you decide to use the same dates for 2012. You must create a new schedule, or modify the existing custom dates. Make sure to account for the pending date in January. The revised schedule has five custom dates: January 2, 2012, March 30, 2012, April 15, 2012, June 30, 2012, and January 2, 2013.
DswCli.exe -servername=localhost -u=Administrator -p=novell
-schedule
-modify
-scheduleId="custom_financial_policy"
-description="Custom policy schedule for the Finance department"
-custom=
"02:01:12,30:03:2012,15:04:12,30:06:12,02:01:13"
A current policy schedule is set to start a run on the first day of each quarter, beginning on July 1 of the current year. You want to modify the schedule to the 15th. The schedule name of quarterly_1st can be modified, such as quarterly_15th. You decide to modify the dates rather than creating a new schedule. The revised policy schedule is planned for July 15, October 15, January 15, and April 15. Any policies associated with the schedule runs on those dates.
DswCli.exe -servername=localhost -u=Administrator -p=novell
-schedule
-scheduleId="quarterly_1st"
-modify
-name="quarterly_15th"
-quarterly="15:07"
When -schedule action option is used without any other parameters or options, all review schedules on the server are listed.
DswCli.exe -schedule
[authentication_parameters]
The following -schedule command displays a list of all schedules on the specified server:
DswCli.exe -servername=localhost -u=Administrator -p=novell
‑schedule
The -detail action provides a details for a schedule, including its schedule type and frequency. For review schedules, the associated pairs are identified. For policy schedules, the associated pairs are identified. You must specify the scheduleId parameter for the policy.
Syntax
DswCli.exe -schedule
-detail
-scheduleId=<"schedulename"|"GUID">
[authentication_parameters]
Example
The following -schedule command lists details for the schedule named custom_financial on the specified server:
DswCli.exe -servername=localhost -u=Administrator -p=novell
‑schedule
-detail
-scheduleId="custom_financial"
See Section 3.8.9, Associate a Review Schedule to a Retention Pair.
See Section 3.8.10, Disassociate a Review Schedule from a Retention Pair.
See Section 3.9.8, Disassociate a Policy Schedule from a Policy.