Dell N3200-ON Networking N-Series Switches RESTful API User Guide version 6.8. - Page 7

About This Document, Acronyms and Abbreviations, Document Conventions

Page 7 highlights

1 About This Document This document describes how to use the Dell Networking RESTful API, which allows you to configure various operational parameters and attributes, including selected protocols on the target switch. It is intended for software developers who design RESTful applications that target Dell Networking switch platforms. Acronyms and Abbreviations In most cases, acronyms and abbreviations are defined on first use. Document Conventions Table 1-1 describes the typographical conventions this document uses. Table 1-1. Document Conventions Convention Bold courier font [ ] { } Italic CTRL + Z Description Page names, field names, menu options, button names, and CLI commands and keywords. Command-line text (CLI output) and file names In a command line, square brackets indicate an optional entry. In a command line, inclusive brackets indicate a selection of compulsory parameters separated by the | character. One option must be selected. For example: spanning-tree mode {stp|rstp|mstp} means that for the spanning-tree mode command, stp, rstp, or mstp must be entered. In a command line, indicates a variable. Any individual key on the keyboard. A keyboard combination that involves pressing the Z key while holding the CTRL key. About This Document 7

  • 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

About This Document
7
1
About This Document
This document describes how to use the Dell Networking RESTful API,
which allows you to configure various operational parameters and attributes,
including selected protocols on the target switch. It is intended for software
developers who design RESTful applications that target Dell Networking
switch platforms.
Acronyms and Abbreviations
In most cases, acronyms and abbreviations are defined on first use.
Document Conventions
Table 1
-
1 describes the typographical conventions this document uses.
Table 1
-
1.
Document Conventions
Convention
Description
Bold
Page names, field names, menu options, button names, and
CLI commands and keywords.
courier font
Command-line text (CLI output) and file names
[ ]
In a command line, square brackets indicate an optional
entry.
{ }
In a command line, inclusive brackets indicate a selection of
compulsory parameters separated by the | character. One
option must be selected. For example:
spanning-tree mode
{
stp
|
rstp
|
mstp
} means that for the
spanning-tree mode
command,
stp
,
rstp
, or
mstp
must be entered.
Italic
In a command line, indicates a variable.
<Enter>
Any individual key on the keyboard.
CTRL + Z
A keyboard combination that involves pressing the Z key
while holding the CTRL key.