HP StorageWorks 2/16V HP StorageWorks Fabric OS 5.X Procedures User Guide (AA- - Page 18

About the CLI, Help information, Displaying command help

Page 18 highlights

• Advanced Web Tools: For Advanced Web Tools procedures, see the HP StorageWorks Fabric OS 5.x Advanced Web Tools administrator guide. • Fabric Manager: For Fabric Manager procedures, see the HP StorageWorks Fabric Manager 5.x administrator guide. • A third-party application using the API: For third-party application procedures, see the third-party API documentation. About the CLI The Fabric OS CLI is the complete fabric management tool for HP StorageWorks SANs that enables you to: • Access the full range of Fabric OS features, based on license keys • Configure, monitor, dynamically provision, and manage every aspect of the SAN • Configure and manage the HP StorageWorks fabric on multiple, efficient levels • Identify, isolate, and manage SAN events across every switch in the fabric • Manage switch licenses • Perform fabric stamping To manage a switch using telnet, Simple Network Management Protocol (SNMP), and Advanced Web Tools, the switch must be connected to a network through the switch Ethernet port (out of band) or from the Fibre Channel (in band). The switch must be configured with an IP address to allow for the network connection. See the installation guide for your switch model for information on physically connecting to the switch. You can access switches from different connections, such as Advanced Web Tools, CLI, and API. When these connections are simultaneous, changes from one connection might not be updated to the other, and some modifications might be lost. When simultaneous connections are used, make sure that you do not overwrite the work of another connection. In a mixed fabric containing switches running various Fabric OS versions, you should use the latest-model switches running the most recent release for the primary management tasks. The principal management access should be set to the core switches in the fabric. For example, to run Secure Fabric OS, use the latest-model switch as the primary Fabric Configuration Server (FCS), the location to perform zoning tasks, and the time server. A number of management tasks are designed to make fabric-level changes; for example, zoning commands make changes that affect the entire fabric. When executing fabric-level configuration tasks, allow time for the changes to propagate across the fabric before executing any subsequent tasks. For a large fabric, it might be take a few minutes. Help information Each Fabric OS command provides Help information that explains the command function, its possible operands, its level in the command hierarchy, and additional pertinent information. Displaying command help To display help information: 1. Connect to the switch and log in as admin. 2. To display a list of all command help topics for a given login level, issue the help command with no arguments. For example, if you are logged in as user and issue the help command, a list of all user-level commands that can be executed is displayed. The same rule applies to the admin role. In addition, any user-configured command that uses a switchAdmin role also displays commands available to users with the switchAdmin role. 3. To display help for a specific command for a given login level, issue help command, where command is the name of the command for which you need information. 18 Introducing Fabric OS CLI procedures

  • 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

18
Introducing Fabric OS CLI procedures
Advanced Web Tools: For Advanced Web Tools procedures, see the
HP StorageWorks Fabric OS
5.x Advanced Web Tools administrator guide
.
Fabric Manager: For Fabric Manager procedures, see the
HP StorageWorks Fabric Manager 5.x
administrator guide
.
A third-party application using the API: For third-party application procedures, see the third-party API
documentation.
About the CLI
The Fabric OS CLI is the complete fabric management tool for HP StorageWorks SANs that enables you
to:
Access the full range of Fabric OS features, based on license keys
Configure, monitor, dynamically provision, and manage every aspect of the SAN
Configure and manage the HP StorageWorks fabric on multiple, efficient levels
Identify, isolate, and manage SAN events across every switch in the fabric
Manage switch licenses
Perform fabric stamping
To manage a switch using telnet, Simple Network Management Protocol (SNMP), and Advanced Web
Tools, the switch must be connected to a network through the switch Ethernet port (out of band) or from the
Fibre Channel (in band). The switch must be configured with an IP address to allow for the network
connection. See the installation guide for your switch model for information on physically connecting to
the switch.
You can access switches from different connections, such as Advanced Web Tools, CLI, and API. When
these connections are simultaneous, changes from one connection might not be updated to the other, and
some modifications might be lost. When simultaneous connections are used, make sure that you do not
overwrite the work of another connection.
In a mixed fabric containing switches running various Fabric OS versions, you should use the latest-model
switches running the most recent release for the primary management tasks. The principal management
access should be set to the core switches in the fabric. For example, to run Secure Fabric OS, use the
latest-model switch as the primary Fabric Configuration Server (FCS), the location to perform zoning tasks,
and the time server.
A number of management tasks are designed to make fabric-level changes; for example, zoning
commands make changes that affect the entire fabric. When executing fabric-level configuration tasks,
allow time for the changes to propagate across the fabric before executing any subsequent tasks. For a
large fabric, it might be take a few minutes.
Help information
Each Fabric OS command provides Help information that explains the command function, its possible
operands, its level in the command hierarchy, and additional pertinent information.
Displaying command help
To display help information:
1.
Connect to the switch and log in as admin.
2.
To display a list of all command help topics for a given login level, issue the
help
command with no
arguments.
For example, if you are logged in as user and issue the
help
command, a list of all user-level
commands that can be executed is displayed. The same rule applies to the admin role. In addition,
any user-configured command that uses a switchAdmin role also displays commands available to
users with the
switchAdmin
role.
3.
To display help for a specific command for a given login level, issue
help
command
, where
command
is the name of the command for which you need information.