Adaptec 5325301507 Administration Guide - Page 183

B - Command Line Interface, SnapCLI Syntax

Page 183 highlights

Appendix B Command Line Interface GuardianOS includes a command line interface (SnapCLI) accessible through SSH. Using the CLI, users can access information about most of the SnapServer configuration parameters and perform configuration and maintenance functions without using the GuardianOS web interface or SSM. Note Some administrative tasks must still be performed using the Administration Tool. The CLI is intended as a convenient way to perform some functions; it is not intended as an alternative to using the GUI. Topics in Command Line Interface • SnapCLI Syntax • SnapCLI Commands • Scripts in SnapCLI SnapCLI Syntax SnapCLI command syntax uses three parameters: COMMANDS, ARGUMENTS, and OPTIONS. To generate commands in SnapCLI, use the following syntax: COMMAND [ARGUMENT] [OPTIONS] where COMMAND is the name of one of the SnapCLI commands, ARGUMENT is an action available for that command, and OPTIONS are additional parameters for the command. Once logged into the CLI, there are several ways of displaying information about available parameters. Type ? {command} help tab {command} tab To... see an overview of the CLI, with a list of available commands and a description of command syntax. see a description of that particular command's function and a list of options available for the command. finish the command you have started to type (i.e., tab-complete). list any arguments and/or options available for that command. SnapServer Administrator Guide 167

  • 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
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209
  • 210
  • 211
  • 212
  • 213
  • 214
  • 215
  • 216
  • 217
  • 218
  • 219
  • 220
  • 221
  • 222
  • 223
  • 224
  • 225
  • 226
  • 227
  • 228
  • 229
  • 230
  • 231
  • 232
  • 233
  • 234
  • 235
  • 236
  • 237
  • 238
  • 239
  • 240
  • 241
  • 242
  • 243
  • 244
  • 245
  • 246
  • 247
  • 248
  • 249
  • 250

SnapServer Administrator Guide
167
SnapServer Administrator Guide
167
Appendix B
Command Line Interface
GuardianOS includes a command line interface (SnapCLI) accessible through SSH.
Using the CLI, users can access information about most of the SnapServer
configuration parameters and perform configuration and maintenance functions
without using the GuardianOS web interface or SSM.
Note
Some administrative tasks must still be performed using the Administration
Tool. The CLI is intended as a convenient way to perform some functions; it is not
intended as an alternative to using the GUI.
Topics in Command Line Interface
SnapCLI Syntax
SnapCLI Commands
Scripts in SnapCLI
SnapCLI Syntax
SnapCLI command syntax uses three parameters: COMMANDS, ARGUMENTS,
and OPTIONS. To generate commands in SnapCLI, use the following syntax:
COMMAND [ARGUMENT] [OPTIONS]
where
COMMAND
is the name of one of the SnapCLI commands,
ARGUMENT
is an
action available for that command, and
OPTIONS
are additional parameters for
the command.
Once logged into the CLI, there are several ways of displaying information about
available parameters.
Type
To...
?
see an overview of the CLI, with a list of available commands and a
description of command syntax.
{command}
help
see a description of that particular command’s function and a list of
options available for the command.
tab
finish the command you have started to type (i.e., tab-complete).
{command}
tab
list any arguments and/or options available for that command.