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

Getting Help with CLI Commands, Help Summary

Page 38 highlights

3.4 Getting Help with CLI Commands The help subsystem consists of two levels: help summary and command help. 3.4.1 Help Summary Typing the global command help as the sole command on a command line from any context lists all of the supported global and context-specific commands: 192.168.59.25 :: help Global Commands Help This help List Brief list of current context properties/methods Exit To end the session Echo Echo a line of text to STDOUT Execute Execute a CLI script file (same as '@' prefix) RequireArgs Requires at least # arguments, or exits ShiftArgs Shifts off # arguments Mode Sets some session options Push Saves the current context on a LIFO stack and changes context Pop Returns to the last pushed context Select Changes context Show Shows a property in the current context Set Sets a property in the current context Do Performs a command in current context System Invokes a system shell command (same as '!' prefix) Context Specific Commands show ID Returns: ID - The service's ID show Status - The service's Operational Status Returns: Status show Name - Gets the user-settable system name Returns: name set Name - Sets the user-settable system name > name (String) - Name of the system show Identity - Gets the %productshortname% identity Returns: identity show DurableName - Gets the Durable system name Returns: name show ProductId - Gets the system ProductId Returns: productId show RevisionLevel - Gets the system RevisionLevel 28 Chapter 3 Using the CLI

  • 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

28
Chapter 3
Using the CLI
3.4
Getting Help with CLI Commands
The help subsystem consists of two levels: help summary and command help.
3.4.1
Help Summary
Typing the global command
help
as the sole command on a command line from any context
lists all of the supported global and context-specific commands:
192.168.59.25 :: help
Global Commands ----------------------------------------
Help
This help
List
Brief list of current context properties/methods
Exit
To end the session
Echo
Echo a line of text to STDOUT
Execute Execute a CLI script file (same as '@' prefix)
RequireArgs Requires at least # arguments, or exits
ShiftArgs Shifts off # arguments
Mode
Sets some session options
Push
Saves the current context on a LIFO stack and changes context
Pop
Returns to the last pushed context
Select
Changes context
Show
Shows a property in the current context
Set
Sets a property in the current context
Do
Performs a command in current context
System
Invokes a system shell command (same as '!' prefix)
Context Specific Commands ------------------------------
show
ID
- The service's ID
Returns: ID
show
Status
- The service's Operational Status
Returns: Status
show
Name
- Gets the user-settable system name
Returns: name
set
Name
- Sets the user-settable system name
> name (String)
- Name of the system
show
Identity
- Gets the %productshortname% identity
Returns: identity
show
DurableName
- Gets the Durable system name
Returns: name
show
ProductId
- Gets the system ProductId
Returns: productId
show
RevisionLevel
- Gets the system RevisionLevel