HP BL680c XenEnterprise Management API - Page 176

Class: PIF

Page 176 highlights

2.20. CLASS: PIF CHAPTER 2. API REFERENCE 2.20 Class: PIF 2.20.1 Fields for class: PIF Name Description Quals RO run RO ins RO ins RO ins RO ins RO ins RO ins RW RO run RO run RO run RO run RO run RO run RO run RO run RO run RO run RO run RO run RO run RW PIF A physical network interface (note separate VLANs are represented as several PIFs). Field Type Description uuid string unique identifier/object reference device string machine-readable name of the inter- face (e.g. eth0) network network ref virtual network to which this pif is connected host host ref physical machine to which this pif is connected MAC string ethernet MAC address of physical in- terface MTU int MTU in octets VLAN int VLAN tag for all traffic passing through this interface device name string actual dom0 device name metrics PIF metrics ref metrics associated with this PIF physical bool true if this represents a physical net- work interface currently attached bool true if this interface is online ip configuration mode ip configuration mode Sets if and how this interface gets an IP address IP string IP address netmask string IP netmask gateway string IP gateway DNS string IP address of DNS servers to use bond slave of Bond ref indicates which bond this interface is part of bond master of (Bond ref) Set indicates this PIF represents the re- sults of a bond VLAN master of VLAN ref indicates wich VLAN this interface receives untagged traffic from VLAN slave of (VLAN ref) Set indicates which VLANs this interface transmits tagged traffic to management bool indicates whether the control soft- ware is listening for connections on this interface other config (string → string) Map additional configuration 2.20.2 RPCs associated with class: PIF RPC name: create VLAN Overview: This message is deprecated Create a VLAN interface from an existing physical interface. Signature: (PIF ref) create_VLAN (session_id s, string device, network ref network, host ref host, int VLAN) Arguments: 176

  • 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.20. CLASS: PIF
CHAPTER 2. API REFERENCE
2.20
Class: PIF
2.20.1
Fields for class: PIF
Name
PIF
Description
A physical network interface (note separate VLANs are represented as
several PIFs).
Quals
Field
Type
Description
RO
run
uuid
string
unique identifier/object reference
RO
ins
device
string
machine-readable name of the inter-
face (e.g. eth0)
RO
ins
network
network ref
virtual network to which this pif is
connected
RO
ins
host
host ref
physical machine to which this pif is
connected
RO
ins
MAC
string
ethernet MAC address of physical in-
terface
RO
ins
MTU
int
MTU in octets
RO
ins
VLAN
int
VLAN
tag
for
all
traffic
passing
through this interface
RW
device
name
string
actual dom0 device name
RO
run
metrics
PIF
metrics ref
metrics associated with this PIF
RO
run
physical
bool
true if this represents a physical net-
work interface
RO
run
currently
attached
bool
true if this interface is online
RO
run
ip
configuration
mode
ip
configuration
mode
Sets if and how this interface gets an
IP address
RO
run
IP
string
IP address
RO
run
netmask
string
IP netmask
RO
run
gateway
string
IP gateway
RO
run
DNS
string
IP address of DNS servers to use
RO
run
bond
slave
of
Bond ref
indicates which bond this interface is
part of
RO
run
bond
master
of
(Bond ref) Set
indicates this PIF represents the re-
sults of a bond
RO
run
VLAN
master
of
VLAN ref
indicates wich VLAN this interface
receives untagged traffic from
RO
run
VLAN
slave
of
(VLAN ref) Set
indicates which VLANs this interface
transmits tagged traffic to
RO
run
management
bool
indicates whether the control soft-
ware is listening for connections on
this interface
RW
other
config
(string
string) Map
additional configuration
2.20.2
RPCs associated with class: PIF
RPC name: create
VLAN
Overview: This message is deprecated
Create a VLAN interface from an existing physical
interface.
Signature:
(PIF ref) create_VLAN (session_id s, string device, network ref network, host ref host, int VLAN)
Arguments:
176