HP BL680c XenEnterprise Management API - Page 154

Class: network

Page 154 highlights

2.17. CLASS: NETWORK CHAPTER 2. API REFERENCE 2.17 Class: network 2.17.1 Fields for class: network Name Description Quals RO run RW RW RO run RO run RO run RO run RW RO run network A virtual network. Field uuid name/label name/description allowed operations current operations VIFs PIFs other config bridge Type string string string (network operations) Set (string → network operations) Map (VIF ref) Set (PIF ref) Set (string → string) Map string Description unique identifier/object reference a human-readable name a notes field containg humanreadable description list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client. links each of the running tasks using this object (by reference) to a current operation enum which describes the nature of the task. list of connected vifs list of connected pifs additional configuration name of the bridge corresponding to this network on the local host 2.17.2 RPCs associated with class: network RPC name: get all Overview: Return a list of all the networks known to the system. Signature: ((network ref) Set) get_all (session_id s) Return Type: (network ref) Set references to all objects RPC name: get all records Overview: Return a map of network references to network records for all networks known to the system. Signature: ((network ref -> network record) Map) get_all_records (session_id s) Return Type: (network ref → network record) Map records of all objects 154

  • 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
  • 279
  • 280
  • 281
  • 282
  • 283
  • 284
  • 285
  • 286
  • 287
  • 288
  • 289
  • 290
  • 291
  • 292
  • 293
  • 294
  • 295
  • 296
  • 297
  • 298
  • 299
  • 300
  • 301
  • 302
  • 303
  • 304
  • 305
  • 306
  • 307
  • 308
  • 309
  • 310
  • 311
  • 312
  • 313

2.17. CLASS: NETWORK
CHAPTER 2. API REFERENCE
2.17
Class: network
2.17.1
Fields for class: network
Name
network
Description
A virtual network.
Quals
Field
Type
Description
RO
run
uuid
string
unique identifier/object reference
RW
name/label
string
a human-readable name
RW
name/description
string
a
notes
field
containg
human-
readable description
RO
run
allowed
operations
(network
operations) Set
list of the operations allowed in this
state. This list is advisory only and
the server state may have changed by
the time this field is read by a client.
RO
run
current
operations
(string
network
operations) Map
links each of the running tasks using
this object (by reference) to a cur-
rent
operation enum which describes
the nature of the task.
RO
run
VIFs
(VIF ref) Set
list of connected vifs
RO
run
PIFs
(PIF ref) Set
list of connected pifs
RW
other
config
(string
string) Map
additional configuration
RO
run
bridge
string
name of the bridge corresponding to
this network on the local host
2.17.2
RPCs associated with class: network
RPC name: get
all
Overview:
Return a list of all the networks known to the system.
Signature:
((network ref) Set) get_all (session_id s)
Return Type:
(network ref) Set
references to all objects
RPC name: get
all
records
Overview:
Return a map of network references to network records for all networks known to the system.
Signature:
((network ref -> network record) Map) get_all_records (session_id s)
Return Type:
(network ref
network record) Map
records of all objects
154