Adaptec 2020ZCR Reference Guide - Page 13

Action, Object, Switch, Value

Page 13 highlights

Introduction Action An action specifies an operation to be performed by the CLI, such as open, create, list, exit, or show. An action is a required element, except in subcommand mode. In most cases, actions are preceded by a class and followed by an object, switches, and parameters. Object An object describes what to use in an action. Examples include mirror, volume, mstripe, and drive_letter. Switch A switch is an element applied to a command that allows a variation of the command. Switches are always optional. If you specify a switch, it may require a value. Switches that are Boolean do not require a value when the switch is used because the switch defaults to TRUE or FALSE. Optionally, you can explicitly set a Boolean switch to TRUE or FALSE. Value A value is a type that applies to a switch. For each switch, you can have only one type of value. For example, a switch that is defined as a string value can never take an integer value. A space may be used within a value only within a quoted string. Examples of valid value types include Boolean, integer, string, scsi_device, free_space, and array. You delimit a value that applies to a switch by using an equal sign, as in the following example: AAC0>disk list /all =TRUE Executing: disk list /all=TRUE Note that a space to the left or right of the equal sign is permitted. 1-6

  • 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
  • 251
  • 252
  • 253
  • 254
  • 255
  • 256
  • 257
  • 258
  • 259
  • 260
  • 261
  • 262
  • 263
  • 264
  • 265
  • 266
  • 267
  • 268
  • 269
  • 270
  • 271
  • 272
  • 273
  • 274
  • 275
  • 276
  • 277
  • 278

1-6
Introduction
Action
An
action
specifies an operation to be performed by the CLI, such
as open, create, list, exit, or show. An action is a required element,
except in subcommand mode. In most cases, actions are preceded
by a class and followed by an object, switches, and parameters.
Object
An
object
describes what to use in an action. Examples include
mirror, volume, mstripe, and drive_letter.
Switch
A
switch
is an element applied to a command that allows a
variation of the command. Switches are always optional.
If you specify a switch, it may require a value. Switches that are
Boolean do not require a value when the switch is used because the
switch defaults to
TRUE
or
FALSE
. Optionally, you can explicitly
set a Boolean switch to
TRUE
or
FALSE
.
Value
A
value
is a type that applies to a switch. For each switch, you can
have only
one
type of value. For example, a switch that is defined as
a string value can never take an integer value. A space may be used
within a value only within a quoted string. Examples of valid value
types include Boolean, integer, string,
scsi_device
,
free_space
,
and
array
.
You delimit a value that applies to a switch by using an equal sign,
as in the following example:
AAC0>disk list /all =TRUE
Executing: disk list /all=TRUE
Note that a space to the left or right of the equal sign is permitted.