HP BL680c XenEnterprise Management API - Page 37

Class: pool

Page 37 highlights

2.7. CLASS: POOL CHAPTER 2. API REFERENCE 2.7 Class: pool 2.7.1 Fields for class: pool Name Description Quals RO run RW RW RO run RW RW RW RW pool Pool-wide information. Field Type uuid string name label string name description string master host ref default SR SR ref suspend image SR SR ref crash dump SR SR ref other config (string → string) Map Description unique identifier/object reference Short name Description The host that is pool master Default SR for VDIs The SR in which VDIs for suspend images are created The SR in which VDIs for crash dumps are created additional configuration 2.7.2 RPCs associated with class: pool RPC name: join Overview: Instruct host to join a new pool. Signature: void join (session_id s, string master_address, string master_username, string master_password) Arguments: type string string string name master address master username master password description The hostname of the master of the pool to join The username of the master (for initial authentication) The password for the master (for initial authentication) Return Type: void Possible Error Codes: JOINING HOST CANNOT CONTAIN SHARED SRS RPC name: join force Overview: Instruct host to join a new pool. Signature: void join_force (session_id s, string master_address, string master_username, string master_password) Arguments: type string string string name master address master username master password description The hostname of the master of the pool to join The username of the master (for initial authentication) The password for the master (for initial authentication) 37

  • 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.7. CLASS: POOL
CHAPTER 2. API REFERENCE
2.7
Class: pool
2.7.1
Fields for class: pool
Name
pool
Description
Pool-wide information.
Quals
Field
Type
Description
RO
run
uuid
string
unique identifier/object reference
RW
name
label
string
Short name
RW
name
description
string
Description
RO
run
master
host ref
The host that is pool master
RW
default
SR
SR ref
Default SR for VDIs
RW
suspend
image
SR
SR ref
The SR in which VDIs for suspend
images are created
RW
crash
dump
SR
SR ref
The
SR
in
which
VDIs
for
crash
dumps are created
RW
other
config
(string
string) Map
additional configuration
2.7.2
RPCs associated with class: pool
RPC name: join
Overview:
Instruct host to join a new pool.
Signature:
void join (session_id s, string master_address, string master_username, string master_password)
Arguments:
type
name
description
string
master
address
The hostname of the master of the pool to join
string
master
username
The username of the master (for initial au-
thentication)
string
master
password
The password for the master (for initial au-
thentication)
Return Type:
void
Possible Error Codes:
JOINING
HOST
CANNOT
CONTAIN
SHARED
SRS
RPC name: join
force
Overview:
Instruct host to join a new pool.
Signature:
void join_force (session_id s, string master_address, string master_username, string master_password)
Arguments:
type
name
description
string
master
address
The hostname of the master of the pool to join
string
master
username
The username of the master (for initial au-
thentication)
string
master
password
The password for the master (for initial au-
thentication)
37