D-Link DSN-540 CLI User's Guide for DSN-1100-10 - Page 69

Task Commands and Properties

Page 69 highlights

5.12 Task Commands and Properties Task commands and properties let you perform task-related activities such as scheduling, modifying, and suspending tasks. Table 5-18 provides an alphabetical list of the commands in the Task context and Table 5-19 provides an alphabetical list of the properties in the Task context. Both tables include a description of the command or property, the global action commands that can be used with the command or property, and the return parameter (if any). In Table 5-18, for example, Cancel is used with the global action command Do. Table 5-18. Task Commands Command Cancel Delete Modify Resume Suspend Description Cancels a task Deletes a task Modifies a task Resumes a suspended task Suspends the task Associated Global Action Commands Return Parameter Do No Return Value Do No Return Value Do No Return Value Do No Return Value Do No Return Value Table 5-19. Task Properties Property EstimatedCompletionTime ObjectName PercentComplete PeriodicityType Priority ScheduledStartTime StartTime State StatusDescription TaskID Description Estimate completion time Returns the object name Returns a task's percent completion Returns the units of the periodicity interval Returns the task priority Sets the task priority Returns the scheduled start time Returns the task start time Returns the task state Returns the status description Returns the task ID Associated Global Action Commands Return Parameter Show Value Show Value Show Value Show Value Show Value Set Value Show Value Show Value Show Value Show Value Show Value Command Line Interface User's Guide 59

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97

Command Line Interface User’s Guide
59
5.12
Task Commands and Properties
Task
commands and properties let you perform task-related activities such as scheduling,
modifying, and suspending tasks. Table 5-18 provides an alphabetical list of the commands in
the
Task
context and Table 5-19 provides an alphabetical list of the properties in the
Task
context. Both tables include a description of the command or property, the global action
commands that can be used with the command or property, and the return parameter (if
any). In Table 5-18, for example,
Cancel
is used with the global action command
Do
.
Table 5-18. Task Commands
Command
Description
Associated Global Action Commands
Return Parameter
Cancel
Cancels a task
Do
No Return Value
Delete
Deletes a task
Do
No Return Value
Modify
Modifies a task
Do
No Return Value
Resume
Resumes a suspended task
Do
No Return Value
Suspend
Suspends the task
Do
No Return Value
Table 5-19. Task Properties
Property
Description
Associated Global Action Commands
Return Parameter
EstimatedCompletionTime
Estimate completion time
Show
Value
ObjectName
Returns the object name
Show
Value
PercentComplete
Returns a task’s percent completion
Show
Value
PeriodicityType
Returns the units of the periodicity interval
Show
Value
Priority
Returns the task priority
Show
Value
Sets the task priority
Set
Value
ScheduledStartTime
Returns the scheduled start time
Show
Value
StartTime
Returns the task start time
Show
Value
State
Returns the task state
Show
Value
StatusDescription
Returns the status description
Show
Value
TaskID
Returns the task ID
Show
Value