HP BL680c XenEnterprise Management API - Page 162

Class: VIF

Page 162 highlights

2.18. CLASS: VIF CHAPTER 2. API REFERENCE 2.18 Class: VIF 2.18.1 Fields for class: VIF Name Description Quals RO run RO run RO run RO ins RO ins RO ins RO ins RO ins RO run RW RO run RO run RO run RO run RW RW RO run RO run VIF A virtual network interface. Field uuid allowed operations current operations device network VM MAC MTU reserved other config currently attached status code status detail runtime properties qos/algorithm type qos/algorithm params qos/supported algorithms metrics Type string (vif operations) Set (string → vif operations) Map string network ref VM ref string int bool (string → string) Map bool int string (string → string) Map string (string → string) Map string Set VIF metrics ref Description unique identifier/object reference 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. order in which VIF backends are created by xapi virtual network to which this vif is connected virtual machine to which this vif is connected ethernet MAC address of virtual interface, as exposed to guest MTU in octets true if the VIF is reserved pending a reboot/migrate additional configuration is the device currently attached (erased on reboot) error/success code associated with last attach-operation (erased on reboot) error/success information associated with last attach-operation status (erased on reboot) Device runtime properties QoS algorithm to use parameters for chosen QoS algorithm supported QoS algorithms for this VIF metrics associated with this VIF 2.18.2 RPCs associated with class: VIF RPC name: plug Overview: Hotplug the specified VIF, dynamically attaching it to the running VM. Signature: void plug (session_id s, VIF ref self) Arguments: 162

  • 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.18. CLASS: VIF
CHAPTER 2. API REFERENCE
2.18
Class: VIF
2.18.1
Fields for class: VIF
Name
VIF
Description
A virtual network interface.
Quals
Field
Type
Description
RO
run
uuid
string
unique identifier/object reference
RO
run
allowed
operations
(vif
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
vif
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
ins
device
string
order in which VIF backends are cre-
ated by xapi
RO
ins
network
network ref
virtual network to which this vif is
connected
RO
ins
VM
VM ref
virtual machine to which this vif is
connected
RO
ins
MAC
string
ethernet MAC address of virtual in-
terface, as exposed to guest
RO
ins
MTU
int
MTU in octets
RO
run
reserved
bool
true if the VIF is reserved pending a
reboot/migrate
RW
other
config
(string
string) Map
additional configuration
RO
run
currently
attached
bool
is
the
device
currently
attached
(erased on reboot)
RO
run
status
code
int
error/success
code
associated
with
last attach-operation (erased on re-
boot)
RO
run
status
detail
string
error/success information associated
with
last
attach-operation
status
(erased on reboot)
RO
run
runtime
properties
(string
string) Map
Device runtime properties
RW
qos/algorithm
type
string
QoS algorithm to use
RW
qos/algorithm
params
(string
string) Map
parameters for chosen QoS algorithm
RO
run
qos/supported
algorithms
string Set
supported QoS algorithms for this
VIF
RO
run
metrics
VIF
metrics ref
metrics associated with this VIF
2.18.2
RPCs associated with class: VIF
RPC name: plug
Overview:
Hotplug the specified VIF, dynamically attaching it to the running VM.
Signature:
void plug (session_id s, VIF ref self)
Arguments:
162