Schedule

Prints the report of a feature or schedule.

This web service runs the fsschedule command.

Parameters

Parameter

Req / Opt

Num

Description

CLI Option

mode

Optional 1 This option specifies if the job will be run synchronously or asynchronously. The valid values are sync and async. The default value is sync. None

jobtype

Optional 1

This parameter is used for async mode only and enables the user to run it as a fast or slow job. Valid values are fast and slow. The default value is fast.

Note: The fast and slow queues provide a method for segregating jobs that run quickly from jobs that take a long time to complete. Each queue is configured by default to run up to four jobs simultaneously in order within their respective queues.

 None

format

Optional

1

The output format requested. Valid values are xml, json and text. The default is text.

-F

feature

Optional

1

The name of the feature. Valid types are: clninfo, clnver, defrag, rebuild, p_backup, f_backup, spolicy, healthck, activevault, and archive_cmp.

-f

schedule

Optional

1

The schedule name.

-n

Example

https://<<SERVER>>/sws/v2/schedule/fsschedule/info

?feature=defrag

&schedule=schedule1

&format=xml

Output

<?xml version="1.0" encoding="UTF-8" ?>

<fsschedule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="fsschedule.xsd">

<header>

<commandName>fsschedule</commandName>

<commandLine>/usr/adic/TSM/exec/fsschedule -n schedule1 -F xml</commandLine>

<commandDescription>Insert, modify, delete, reset, or report all maintenance features in the Quantum storage subsystem.</commandDescription>

<localDateISO>2014-05-15T12:21:43</localDateISO>

<localDate>2014-05-15</localDate>

<localTime>12:21:43</localTime>

<localDayOfWeek>4</localDayOfWeek>

<gmtDateISO>2014-05-15T17:21:43Z</gmtDateISO>

<gmtDate>2014-05-15</gmtDate>

<gmtTime>17:21:43</gmtTime>

<gmtDayOfWeek>4</gmtDayOfWeek>

</header>

<schedules>

<schedule>

<name>schedule1</name>

<feature>defrag</feature>

<period>daily</period>

<lastRun>None</lastRun>

<lastRunISODate>None</lastRunISODate>

<lastRunTime>None</lastRunTime>

<calendar>

<dailyflags>YYYYYYY</dailyflags>

</calendar>

<startWindowStartHr>00</startWindowStartHr>

<startWindowStartMin>00</startWindowStartMin>

<startWindowEndHr>01</startWindowEndHr>

<startWindowEndMin>00</startWindowEndMin>

<lastRunStatus>None</lastRunStatus>

</schedule>

</schedules>

<statuses>

<status>

<statusCode>FS0000</statusCode>

<statusNumber>0</statusNumber>

<dayOfMonth>15</dayOfMonth>

<requestId>388079</requestId>

<commandName>/usr/adic/TSM/exec/fsschedule</commandName>

<commandStatus>completed</commandStatus>

<statusText>Command Successful.</statusText>

</status>

</statuses>

<footer>

<returnCode>0</returnCode>

<localDateISOEnd>2014-05-15T12:21:43</localDateISOEnd>

<localDateEnd>2014-05-15</localDateEnd>

<localTimeEnd>12:21:43</localTimeEnd>

<localDayOfWeekEnd>4</localDayOfWeekEnd>

<gmtDateISOEnd>2014-05-15T17:21:43Z</gmtDateISOEnd>

<gmtDateEnd>2014-05-15</gmtDateEnd>

<gmtTimeEnd>17:21:43</gmtTimeEnd>

<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>

<elapsedTimeInSeconds>0.0001</elapsedTimeInSeconds>

</footer>

</fsschedule>

This web service will create a schedule.

This web service runs the fsschedule command.

Parameters

Parameter

Req / Opt

Num

Description

CLI Option

mode

Optional 1 This option specifies if the job will be run synchronously or asynchronously. The valid values are sync and async. The default value is sync. None

jobtype

Optional 1

This parameter is used for async mode only and enables the user to run it as a fast or slow job. Valid values are fast and slow. The default value is fast.

Note: The fast and slow queues provide a method for segregating jobs that run quickly from jobs that take a long time to complete. Each queue is configured by default to run up to four jobs simultaneously in order within their respective queues.

 None

format

Optional

1

The output format requested. Valid values are xml, json and text. The default is text.

-F

feature

Required

1

The name of the feature. Valid types are: clninfo, clnver, defrag, rebuild, p_backup, f_backup, spolicy, healthck, activevault, and archive_cmp.

-f

schedule

Required

1

The schedule name.

-n

period

Optional

1

The period of the schedule. Valid options are: daily, weekly, and monthly.

-p

weekday

Optional

1

The day of the week: Valid options are: Sun, Mon, Tue, Wed, Thu, Fri, or Sat.

-e

monthday

Optional

1

The day of the month: 1 – 31.

-y

runtime

Required

1

The start time of the feature defined as HHMM.

-t

window

Optional

1

The window or runtime offset defined as HHMM.

-w

option

Optional

1

The option used by the feature. Currently, only the spolicy feature requires an option, which is an existing policy class.

-o

archive

Optional

N

Applicable only for activevault feature. Media to be vaulted are selected from this list of archives.

--

vault

Optional

1

Applicable only for activevault feature. The destination archive vault media.

-vault

copy

Optional

1

Applicable only for activevault feature. A list of copy numbers to query on.

-copy

used

Optional

1

Applicable only for activevault feature. Select only media that have used size capacity. Size is in bytes by default, but a suffix of B(ytes), K(ibibytes), M(ebibytes), G(ibibytes) or T(ebibytes) may be used to specify capacity.

-used

free

Optional

1

Applicable only for activevault feature. Select only media that have size capacity remaining. Size is in bytes by default, but a suffix of B(ytes), K(ibibytes), M(ebibytes), G(ibibytes) or T(ebibytes) may be used to specify capacity.

-remaining

age

Optional

1

Applicable only for activevault feature. Vault media according to age. age by default is in seconds, but a time unit may also be provided to specify seconds, days, weeks, months or years. A specific date may also be specified with the YYYY:MM:DD:hh:mm:ss format.

-age

sort

Optional

1

Applicable only for activevault feature. Sort results based according to column where column can be age, id, full, remaining or used. Age will sort by last access time of the media. Id will sort by media ID. Full will sort by the percentage full of the media. This is the default behavior if no sort option is specified.Rremaining will sort by space remaining on the media. Used will sort by the amount of space used on the media.

-sort

migrate

Optional

1

Applicable only for activevault feature. Valid values are true and false. If true, Select from media in the MIGRATE media class. If false, Ignore media in the MIGRATE media class.

-migrate
or
-nomigrate

pending

Optional

1

Applicable only for activevault feature. Valid values are true and false. If true, Select media where a vaulting operation is pending. If false, Select media where no vaulting operation is pending.

-pending
or
-nopending

highmark

Optional

1

Applicable only for activevault feature. Override the ACTIVEVAULT_HIGH_USE sysparm value to start vaulting if the used capacity of the Storage Manager license is at or above the pct percent.

-highmark

lowmark

Optional

1

Applicable only for activevault feature. Override the ACTIVEVAULT_LOW_USE sysparm value to stop vaulting if the used capacity of the Storage Manager license is below the pct percent.

-lowmark

fill

Optional

1

Applicable only for activevault feature. Override the ACTIVEVAULT_FULL_PERCENT sysparm value to consider vaulting media that is at or above the specified percent.

-fullpct

report

Optional

1

Applicable only for activevault feature. Generate a media report based upon the selection criteria.

-report

includepolicy

Optional

N

Applicable only for activevault feature. Select media belonging to the list of policy classes. If this option is used, only media belonging to the list will be selected.

-include_policy

excludepolicy

Optional

N

Applicable only for activevault feature. Excludes media belonging to the listed policy classes.

-exclude_policy

capacity

Optional

1

Applicable only for activevault feature. Report the current licensed capacity and total available licensed capacity.

-capacity

dryrun

Optional

1

Applicable only for activevault feature. Show what media would be vaulted according to the selection criteria.

-dryrun

limit

Optional

1

Applicable only for activevault feature. Limit the number of vaulted media to this number.

-limit

notify

Optional

1

Applicable only for activevault feature. Set the email notification level for active vault policy admin alerts where level is either none, error, warn, or info. None will suppress all email notifications. Error will only send notifications when an error occurs, such as database errors or licensing errors. Warn will send notifications for warnings, such as being unable to vault enough media to satisfy the low water mark. Info will cause email notifications to be sent indicating that the active vault policy completed successfully. The default notification level is warn.

-notify

noheader

Optional

1

Applicable only for the activevault feature. Do not display header or result count in the media report.

-noheader

verbose

Optional

1

Applicable only for activevault feature.

-verbose

policy

Optional

1

Applicable only for the activevault feature. The name of the Active Vault policy to use for email notifications.

-policy

Example

https://<<SERVER>>/sws/v2/schedule/fsschedule/create

?feature=f_backup

&schedule=schedule1

&period=daily

&weekday=Sun

&runtime=1000

&format=xml

Output

<?xml version="1.0" encoding="UTF-8" ?>

<fsschedule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="fsschedule.xsd">

<header>

<commandName>fsschedule</commandName>

<commandLine>/usr/adic/TSM/exec/fsschedule -a -n schedule2 -f f_backup -p daily -e Sun -t 1000 -F xml</commandLine>

<commandDescription>Insert, modify, delete, reset, or report all maintenance features in the Quantum storage subsystem.</commandDescription>

<localDateISO>2014-05-15T12:25:28</localDateISO>

<localDate>2014-05-15</localDate>

<localTime>12:25:28</localTime>

<localDayOfWeek>4</localDayOfWeek>

<gmtDateISO>2014-05-15T17:25:28Z</gmtDateISO>

<gmtDate>2014-05-15</gmtDate>

<gmtTime>17:25:28</gmtTime>

<gmtDayOfWeek>4</gmtDayOfWeek>

</header>

<statuses>

<status>

<statusCode>FS0000</statusCode>

<statusNumber>0</statusNumber>

<dayOfMonth>15</dayOfMonth>

<requestId>388090</requestId>

<commandName>/usr/adic/TSM/exec/fsschedule</commandName>

<commandStatus>completed</commandStatus>

<statusText>Command Successful.</statusText>

</status>

</statuses>

<footer>

<returnCode>0</returnCode>

<localDateISOEnd>2014-05-15T12:25:28</localDateISOEnd>

<localDateEnd>2014-05-15</localDateEnd>

<localTimeEnd>12:25:28</localTimeEnd>

<localDayOfWeekEnd>4</localDayOfWeekEnd>

<gmtDateISOEnd>2014-05-15T17:25:28Z</gmtDateISOEnd>

<gmtDateEnd>2014-05-15</gmtDateEnd>

<gmtTimeEnd>17:25:28</gmtTimeEnd>

<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>

<elapsedTimeInSeconds>0.0049</elapsedTimeInSeconds>

</footer>

</fsschedule>

This web service will update a schedule.

This web service runs the fsschedule command.

Parameters

Parameter

Req / Opt

Num

Description

CLI Option

mode

Optional 1 This option specifies if the job will be run synchronously or asynchronously. The valid values are sync and async. The default value is sync. None

jobtype

Optional 1

This parameter is used for async mode only and enables the user to run it as a fast or slow job. Valid values are fast and slow. The default value is fast.

Note: The fast and slow queues provide a method for segregating jobs that run quickly from jobs that take a long time to complete. Each queue is configured by default to run up to four jobs simultaneously in order within their respective queues.

 None

format

Optional

1

The output format requested. Valid values are xml, json and text. The default is text.

-F

schedule

Required

1

The schedule name.

-n

period

Optional

1

The period of the schedule. Valid options are: daily, weekly, or monthly.

-p

weekday

Optional

1

The day of the week: Valid options are: Sun, Mon, Tue, Wed, Thu, Fri, or Sat.

-e

monthday

Optional

1

The day of the month: 1 – 31.

-y

runtime

Optional

1

The start time of the feature defined as HHMM.

-t

window

Optional

1

The window or runtime offset defined as HHMM.

-w

option

Optional

1

The option used by the feature. Currently, only the spolicy feature requires an option, which is an existing policy class.

-o

archive

Optional

N

Applicable only for the activevault feature. Media to be vaulted are selected from this list of archives.

--

vault

Optional

1

Applicable only for the activevault feature. The destination archive where to vault media.

-vault

copy

Optional

1

Applicable only for the activevault feature. A list of copy numbers to query.

-copy

used

Optional

1

Applicable only for the activevault feature. Select only media that have used size capacity. Size is in bytes by default, but a suffix of B(ytes), K(ibibytes), M(ebibytes), G(ibibytes) or T(ebibytes) may be used to specify capacity.

-used

free

Optional

1

Applicable only for the activevault feature. Select only media that have size capacity remaining. Size is in bytes by default, but a suffix of B(ytes), K(ibibytes), M(ebibytes), G(ibibytes) or T(ebibytes) may be used to specify capacity.

-remaining

age

Optional

1

Applicable only for the activevault feature. Vault media according to age. Age by default is in seconds, but a time unit may also be provided to specify seconds, days, weeks, months or years. A specific date may also be specified with the YYYY:MM:DD:hh:mm:ss format.

-age

sort

Optional

1

Applicable only for the activevault feature. Sort results based according to column where column can be age, id, full, remaining or used. Age will sort by last access time of the media. Id will sort by media ID. Full will sort by the percentage full of the media. This is the default behavior if no sort option is specified. Remaining will sort by space remaining on the media. Used will sort by the amount of space used on the media.

-sort

migrate

Optional

1

Applicable only for the activevault feature. Valid values are true and false. If true, select from media in the MIGRATE media class. If false, ignore media in the MIGRATE media class.

-migrate
or
- nomigrate

pending

Optional

1

Applicable only for the activevault feature. Valid values are true and false. If true, select media where a vaulting operation is pending. If false, select media where no vaulting operation is pending.

-pending
or
-nopending

highmark

Optional

1

Applicable only for the activevault feature. Override the ACTIVEVAULT_HIGH_USE sysparm value to start vaulting if the used capacity of the Storage Manager license is at or above the pct percent.

-highmark

lowmark

Optional

1

Applicable only for the activevault feature. Override the ACTIVEVAULT_LOW_USE sysparm value to stop vaulting if the used capacity of the Storage Manager license is below the pct percent.

-lowmark

fill

Optional

1

Applicable only for the activevault feature. Override the ACTIVEVAULT_FULL_PERCENT sysparm value to consider vaulting media that is at or above the pct percent.

-fullpct

report

Optional

1

Applicable only for the activevault feature. Generate a media report based upon the selection criteria.

-report

includepolicy

Optional

N

Applicable only for the activevault feature. Select media belonging to the list of policy classes. If this option is used, only media belonging to the list will be selected.

-include_policy

excludepolicy

Optional

N

Applicable only for the activevault feature. Excludes media belonging to the listed policy classes.

-exclude_policy

capacity

Optional

1

Applicable only for the activevault feature. Report the current licensed capacity and total available licensed capacity.

-capacity

dryrun

Optional

1

Applicable only for the activevault feature. Show media that would be vaulted according to the selection criteria.

-dryrun

limit

Optional

1

Applicable only for the activevault feature. Limit the number of vaulted media to this number.

-limit

notify

Optional

1

Applicable only for the activevault feature. Set the email notification level for active vault policy admin alerts where level is either none, error, warn, or info. Nnone will suppress all email notifications. Error will only send notifications when an error occurrs, such as database errors or licensing errors. Warn will send notifications for warnings, such as being unable to vault enough media to satisfy the low water mark. Info will cause email notifications to be sent indicating that the active vault policy completed successfully. The default notification level is warn.

-notify

noheader

Optional

1

Applicable only for the activevault feature. Do not display header or result count in the media report.

-noheader

verbose

Optional

1

Applicable only for activevault feature.

-verbose

policy

Optional

1

Applicable only for the activevault feature. The name of the Active Vault policy to use for email notifications.

-policy

Example

https://<<SERVER>>/sws/v2/schedule/fsschedule/update

?feature=defrag

&schedule=schedule1

&period=daily

&weekday=Sun

&runtime=1000

&format=xml

Output

<?xml version="1.0" encoding="UTF-8" ?>

<fsschedule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="fsschedule.xsd">

<header>

<commandName>fsschedule</commandName>

<commandLine>/usr/adic/TSM/exec/fsschedule -m -n schedule1 -p daily -e Sun -t 1000 -F xml</commandLine>

<commandDescription>Insert, modify, delete, reset, or report all maintenance features in the Quantum storage subsystem.</commandDescription>

<localDateISO>2014-05-15T12:27:59</localDateISO>

<localDate>2014-05-15</localDate>

<localTime>12:27:59</localTime>

<localDayOfWeek>4</localDayOfWeek>

<gmtDateISO>2014-05-15T17:27:59Z</gmtDateISO>

<gmtDate>2014-05-15</gmtDate>

<gmtTime>17:27:59</gmtTime>

<gmtDayOfWeek>4</gmtDayOfWeek>

</header>

<statuses>

<status>

<statusCode>FS0000</statusCode>

<statusNumber>0</statusNumber>

<dayOfMonth>15</dayOfMonth>

<requestId>388095</requestId>

<commandName>/usr/adic/TSM/exec/fsschedule</commandName>

<commandStatus>completed</commandStatus>

<statusText>Command Successful.</statusText>

</status>

</statuses>

<footer>

<returnCode>0</returnCode>

<localDateISOEnd>2014-05-15T12:27:59</localDateISOEnd>

<localDateEnd>2014-05-15</localDateEnd>

<localTimeEnd>12:27:59</localTimeEnd>

<localDayOfWeekEnd>4</localDayOfWeekEnd>

<gmtDateISOEnd>2014-05-15T17:27:59Z</gmtDateISOEnd>

<gmtDateEnd>2014-05-15</gmtDateEnd>

<gmtTimeEnd>17:27:59</gmtTimeEnd>

<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>

<elapsedTimeInSeconds>0.0057</elapsedTimeInSeconds>

</footer>

</fsschedule>

This web service deletes an existing schedule.

This web service runs the fsschedule command.

Parameters

Parameter

Req / Opt

Num

Description

CLI Option

mode

Optional 1 This option specifies if the job will be run synchronously or asynchronously. The valid values are sync and async. The default value is sync. None

jobtype

Optional 1

This parameter is used for async mode only and enables the user to run it as a fast or slow job. Valid values are fast and slow. The default value is fast.

Note: The fast and slow queues provide a method for segregating jobs that run quickly from jobs that take a long time to complete. Each queue is configured by default to run up to four jobs simultaneously in order within their respective queues.

 None

format

Optional

1

The output format requested. Valid values are xml, json and text. The default is text.

-F

schedule

Required

1

The schedule name.

-n

Example

https://<<SERVER>>/sws/v2/schedule/fsschedule/delete

?schedule=schedule1

&format=xml

Output

<?xml version="1.0" encoding="UTF-8" ?>

<fsschedule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="fsschedule.xsd">

<header>

<commandName>fsschedule</commandName>

<commandLine>/usr/adic/TSM/exec/fsschedule -d -n schedule1 -F xml</commandLine>

<commandDescription>Insert, modify, delete, reset, or report all maintenance features in the Quantum storage subsystem.</commandDescription>

<localDateISO>2014-05-15T12:29:23</localDateISO>

<localDate>2014-05-15</localDate>

<localTime>12:29:23</localTime>

<localDayOfWeek>4</localDayOfWeek>

<gmtDateISO>2014-05-15T17:29:23Z</gmtDateISO>

<gmtDate>2014-05-15</gmtDate>

<gmtTime>17:29:23</gmtTime>

<gmtDayOfWeek>4</gmtDayOfWeek>

</header>

<statuses>

<status>

<statusCode>FS0000</statusCode>

<statusNumber>0</statusNumber>

<dayOfMonth>15</dayOfMonth>

<requestId>388098</requestId>

<commandName>/usr/adic/TSM/exec/fsschedule</commandName>

<commandStatus>completed</commandStatus>

<statusText>Command Successful.</statusText>

</status>

</statuses>

<footer>

<returnCode>0</returnCode>

<localDateISOEnd>2014-05-15T12:29:24</localDateISOEnd>

<localDateEnd>2014-05-15</localDateEnd>

<localTimeEnd>12:29:24</localTimeEnd>

<localDayOfWeekEnd>4</localDayOfWeekEnd>

<gmtDateISOEnd>2014-05-15T17:29:24Z</gmtDateISOEnd>

<gmtDateEnd>2014-05-15</gmtDateEnd>

<gmtTimeEnd>17:29:24</gmtTimeEnd>

<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>

<elapsedTimeInSeconds>0.0613</elapsedTimeInSeconds>

</footer>

</fsschedule>

This web service resets an existing schedule.

This web service runs the fsschedule command.

Parameters

Parameter

Req / Opt

Num

Description

CLI Option

mode

Optional 1 This option specifies if the job will be run synchronously or asynchronously. The valid values are sync and async. The default value is sync. None

jobtype

Optional 1

This parameter is used for async mode only and enables the user to run it as a fast or slow job. Valid values are fast and slow. The default value is fast.

Note: The fast and slow queues provide a method for segregating jobs that run quickly from jobs that take a long time to complete. Each queue is configured by default to run up to four jobs simultaneously in order within their respective queues.

 None

format

Optional

1

The output format requested. Valid values are xml, json and text. The default is text.

-F

feature

Required

1

The name of the feature. Valid types are: clninfo, clnver, defrag, rebuild, p_backup, f_backup, spolicy, healthck, activevault, or archive_cmp.

-f

Example

https://<<SERVER>>/sws/v2/schedule/fsschedule/reset

?feature=defrag

&format=xml

Output

<?xml version="1.0" encoding="UTF-8" ?>

<fsschedule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="fsschedule.xsd">

<header>

<commandName>fsschedule</commandName>

<commandLine>/usr/adic/TSM/exec/fsschedule -r -f defrag -F xml</commandLine>

<commandDescription>Insert, modify, delete, reset, or report all maintenance features in the Quantum storage subsystem.</commandDescription>

<localDateISO>2014-05-15T12:30:26</localDateISO>

<localDate>2014-05-15</localDate>

<localTime>12:30:26</localTime>

<localDayOfWeek>4</localDayOfWeek>

<gmtDateISO>2014-05-15T17:30:26Z</gmtDateISO>

<gmtDate>2014-05-15</gmtDate>

<gmtTime>17:30:26</gmtTime>

<gmtDayOfWeek>4</gmtDayOfWeek>

</header>

<statuses>

<status>

<statusCode>FS0000</statusCode>

<statusNumber>0</statusNumber>

<dayOfMonth>15</dayOfMonth>

<requestId>388101</requestId>

<commandName>/usr/adic/TSM/exec/fsschedule</commandName>

<commandStatus>completed</commandStatus>

<statusText>Command Successful.</statusText>

</status>

</statuses>

<footer>

<returnCode>0</returnCode>

<localDateISOEnd>2014-05-15T12:30:26</localDateISOEnd>

<localDateEnd>2014-05-15</localDateEnd>

<localTimeEnd>12:30:26</localTimeEnd>

<localDayOfWeekEnd>4</localDayOfWeekEnd>

<gmtDateISOEnd>2014-05-15T17:30:26Z</gmtDateISOEnd>

<gmtDateEnd>2014-05-15</gmtDateEnd>

<gmtTimeEnd>17:30:26</gmtTimeEnd>

<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>

<elapsedTimeInSeconds>0.0139</elapsedTimeInSeconds>

</footer>

</fsschedule>