0% found this document useful (0 votes)

2K views

Xenserver 7 0 Management API Guide

XenServer 7, management api (english)

Uploaded by

rohight

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

2K views

Xenserver 7 0 Management API Guide

XenServer 7, management api (english)

Uploaded by

rohight

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 600

Citrix XenServer Management API API Revision 2.

Citrix XenServer Management API

Version: API Revision 2.4
Date: May 2016

c 2006-2016 Citrix Systems, Inc. All Rights Reserved.

1 Introduction 3
1.1 RPCs associated with fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.2 RPCs associated with classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.2.1 Additional RPCs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.3 Wire Protocol for Remote API Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.3.1 Note on References vs UUIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.3.2 Return Values/Status Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.4 Making XML-RPC Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.4.1 Transport Layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.4.2 Session Layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.4.3 Synchronous and Asynchronous invocation . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.5 Example interactive session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.6 VM Lifecycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.7 VM boot parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

2 API Reference 12
2.1 Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
2.2 Relationships Between Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
2.3 Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.3.1 Primitives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.3.2 Higher-order types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.3.3 Enumeration types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.4 Class: session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
2.4.1 Fields for class: session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
2.4.2 RPCs associated with class: session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
2.5 Class: auth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
2.5.1 Fields for class: auth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
2.5.2 RPCs associated with class: auth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
2.6 Class: subject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
2.6.1 Fields for class: subject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
2.6.2 RPCs associated with class: subject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
2.7 Class: role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
2.7.1 Fields for class: role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
2.7.2 RPCs associated with class: role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
2.8 Class: task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
2.8.1 Fields for class: task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
2.8.2 RPCs associated with class: task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
2.9 Class: event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
2.9.1 Fields for class: event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

2
CONTENTS CONTENTS

2.9.2 RPCs associated with class: event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

2.10 Class: pool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
2.10.1 Fields for class: pool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
2.10.2 RPCs associated with class: pool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
2.11 Class: pool patch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
2.11.1 Fields for class: pool patch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
2.11.2 RPCs associated with class: pool patch . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
2.12 Class: VM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
2.12.1 Fields for class: VM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
2.12.2 RPCs associated with class: VM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
2.13 Class: VM metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
2.13.1 Fields for class: VM metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
2.13.2 RPCs associated with class: VM metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
2.14 Class: VM guest metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
2.14.1 Fields for class: VM guest metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
2.14.2 RPCs associated with class: VM guest metrics . . . . . . . . . . . . . . . . . . . . . . . . 182
2.15 Class: VMPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
2.15.1 Fields for class: VMPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
2.15.2 RPCs associated with class: VMPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
2.16 Class: VM appliance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
2.16.1 Fields for class: VM appliance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
2.16.2 RPCs associated with class: VM appliance . . . . . . . . . . . . . . . . . . . . . . . . . . 209
2.17 Class: DR task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
2.17.1 Fields for class: DR task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
2.17.2 RPCs associated with class: DR task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
2.18 Class: host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
2.18.1 Fields for class: host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
2.18.2 RPCs associated with class: host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
2.19 Class: host crashdump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
2.19.1 Fields for class: host crashdump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
2.19.2 RPCs associated with class: host crashdump . . . . . . . . . . . . . . . . . . . . . . . . . 267
2.20 Class: host patch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
2.20.1 Fields for class: host patch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
2.20.2 RPCs associated with class: host patch . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
2.21 Class: host metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
2.21.1 Fields for class: host metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
2.21.2 RPCs associated with class: host metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
2.22 Class: host cpu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
2.22.1 Fields for class: host cpu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
2.22.2 RPCs associated with class: host cpu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
2.23 Class: network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
2.23.1 Fields for class: network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
2.23.2 RPCs associated with class: network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
2.24 Class: VIF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
2.24.1 Fields for class: VIF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
2.24.2 RPCs associated with class: VIF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
2.25 Class: VIF metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
2.25.1 Fields for class: VIF metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
2.25.2 RPCs associated with class: VIF metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
2.26 Class: PIF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
2.26.1 Fields for class: PIF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327

3
CONTENTS CONTENTS

2.26.2 RPCs associated with class: PIF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

2.27 Class: PIF metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
2.27.1 Fields for class: PIF metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
2.27.2 RPCs associated with class: PIF metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
2.28 Class: Bond . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
2.28.1 Fields for class: Bond . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
2.28.2 RPCs associated with class: Bond . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
2.29 Class: VLAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
2.29.1 Fields for class: VLAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
2.29.2 RPCs associated with class: VLAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
2.30 Class: SM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
2.30.1 Fields for class: SM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
2.30.2 RPCs associated with class: SM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
2.31 Class: SR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
2.31.1 Fields for class: SR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
2.31.2 RPCs associated with class: SR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
2.32 Class: LVHD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
2.32.1 Fields for class: LVHD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
2.32.2 RPCs associated with class: LVHD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
2.33 Class: VDI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
2.33.1 Fields for class: VDI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
2.33.2 RPCs associated with class: VDI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
2.34 Class: VBD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
2.34.1 Fields for class: VBD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
2.34.2 RPCs associated with class: VBD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
2.35 Class: VBD metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
2.35.1 Fields for class: VBD metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
2.35.2 RPCs associated with class: VBD metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
2.36 Class: PBD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
2.36.1 Fields for class: PBD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
2.36.2 RPCs associated with class: PBD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
2.37 Class: crashdump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
2.37.1 Fields for class: crashdump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
2.37.2 RPCs associated with class: crashdump . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
2.38 Class: VTPM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
2.38.1 Fields for class: VTPM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
2.38.2 RPCs associated with class: VTPM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
2.39 Class: console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
2.39.1 Fields for class: console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
2.39.2 RPCs associated with class: console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
2.40 Class: user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
2.40.1 Fields for class: user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
2.40.2 RPCs associated with class: user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
2.41 Class: data source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
2.41.1 Fields for class: data source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
2.41.2 RPCs associated with class: data source . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
2.42 Class: blob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
2.42.1 Fields for class: blob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
2.42.2 RPCs associated with class: blob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
2.43 Class: message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
2.43.1 Fields for class: message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480

4
CONTENTS CONTENTS

2.43.2 RPCs associated with class: message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480

2.44 Class: secret . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
2.44.1 Fields for class: secret . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
2.44.2 RPCs associated with class: secret . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
2.45 Class: tunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
2.45.1 Fields for class: tunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
2.45.2 RPCs associated with class: tunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
2.46 Class: PCI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
2.46.1 Fields for class: PCI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
2.46.2 RPCs associated with class: PCI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
2.47 Class: PGPU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
2.47.1 Fields for class: PGPU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
2.47.2 RPCs associated with class: PGPU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
2.48 Class: GPU group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
2.48.1 Fields for class: GPU group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
2.48.2 RPCs associated with class: GPU group . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
2.49 Class: VGPU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
2.49.1 Fields for class: VGPU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
2.49.2 RPCs associated with class: VGPU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
2.50 Class: VGPU type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
2.50.1 Fields for class: VGPU type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
2.50.2 RPCs associated with class: VGPU type . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
2.51 Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
2.51.1 Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533

5
Chapter 1

Introduction

This document defines the Citrix XenServer Management APIan API for remotely configuring and controlling
virtualised guests running on a XenServer pool.

The API is presented here as a set of Remote Procedure Calls, with a wire format based upon XML-RPC. No
specific language bindings are prescribed, although examples will be given in the python programming language.
Although we adopt some terminology from object-oriented programming, future client language bindings may
or may not be object oriented. The API reference uses the terminology classes and objects. For our purposes a
class is simply a hierarchical namespace; an object is an instance of a class with its fields set to specific values.
Objects are persistent and exist on the server-side. Clients may obtain opaque references to these server-side
objects and then access their fields via get/set RPCs.
For each class we specify a list of fields along with their types and qualifiers. A qualifier is one of:
RO run : the field is Read Only. Furthermore, its value is automatically computed at runtime. For example:
current CPU load and disk IO throughput.
RO ins : the field must be manually set when a new object is created, but is then Read Only for the duration
of the objects life. For example, the maximum memory addressable by a guest is set before the guest
boots.
RW : the field is Read/Write. For example, the name of a VM.
A full list of types is given in Chapter 2. However, there are three types that require explicit mention:
t Ref : signifies a reference to an object of type t.
t Set: signifies a set containing values of type t.
(t1 , t2 ) Map: signifies a mapping from values of type t1 to values of type t2 .
Note that there are a number of cases where Refs are doubly linked e.g. a VM has a field called VIFs of type
(VIF Ref ) Set; this field lists the network interfaces attached to a particular VM. Similarly, the VIF class has a
field called VM of type (VM Ref ) which references the VM to which the interface is connected. These two fields
are bound together , in the sense that creating a new VIF causes the VIFs field of the corresponding VM object
to be updated automatically.
The API reference explicitly lists the fields that are bound together in this way. It also contains a diagram
that shows relationships between classes. In this diagram an edge signifies the existance of a pair of fields
that are bound together, using standard crows-foot notation to signify the type of relationship (e.g. one-many,
many-many).

6
1.1. RPCS ASSOCIATED WITH FIELDS CHAPTER 1. INTRODUCTION

1.1 RPCs associated with fields

Each field, f, has an RPC accessor associated with it that returns fs value:
get f(Ref x): takes a Ref that refers to an object and returns the value of f.
Each field, f, with attribute RW and whose outermost type is Set has the following additional RPCs associated
with it:
an add to f(Ref x, v) RPC adds a new element v to the set1 ;
a remove from f(Ref x, v) RPC removes element v from the set;
Each field, f, with attribute RW and whose outermost type is Map has the following additional RPCs associated
with it:
an add to f(Ref x, k, v) RPC adds new pair (k, v) to the mapping stored in f in object x. Adding
a new pair for duplicate key, k, overwrites any previous mapping for k.
a remove from f(Ref x, k) RPC removes the pair with key k from the mapping stored in f in object
x.
Each field whose outermost type is neither Set nor Map, but whose attribute is RW has an RPC acessor
associated with it that sets its value:
For RW (Read/W rite), a set f(Ref x, v) RPC function is also provided. This sets field f on object
x to value v.

1.2 RPCs associated with classes

Each class has a constructor RPC named create that takes as parameters all fields marked RW and
RO ins . The result of this RPC is that a new persistent object is created on the server-side with the
specified field values.
Each class has a get by uuid(uuid) RPC that returns the object of that class that has the specified uuid.

Each class that has a name label field has a get by name label(name) RPC that returns a set of objects
of that class that have the specified label.
Each class has a destroy(Ref x) RPC that explicitly deletes the persistent object specified by x from
the system. This is a non-cascading delete if the object being removed is referenced by another object
then the destroy call will fail.

1.2.1 Additional RPCs

As well as the RPCs enumerated above, some classes have additional RPCs associated with them. For example,
the VM class has RPCs for cloning, suspending, starting etc. Such additional RPCs are described explicitly in
the API reference.

1 Since sets cannot contain duplicate values this operation has no action in the case that v was already in the set.

7
1.3. WIRE PROTOCOL FOR REMOTE API CALLS CHAPTER 1. INTRODUCTION

1.3 Wire Protocol for Remote API Calls

API calls are sent over a network to a Xen-enabled host using the XML-RPC protocol. In this Section we
describe how the higher-level types used in our API Reference are mapped to primitive XML-RPC types.
In our API Reference we specify the signatures of API functions in the following style:
(ref_vm Set) VM.get_all()
This specifies that the function with name VM.get all takes no parameters and returns a Set of ref vms. These
types are mapped onto XML-RPC types in a straight-forward manner:
Floats, Bools, DateTimes and Strings map directly to the XML-RPC double, boolean, dateTime.iso8601,
and string elements.
all ref types are opaque references, encoded as the XML-RPCs String type. Users of the API should
not make assumptions about the concrete form of these strings and should not expect them to remain
valid after the clients session with the server has terminated.
fields named uuid of type String are mapped to the XML-RPC String type. The string itself is the
OSF DCE UUID presentation format (as output by uuidgen, etc).
ints are all assumed to be 64-bit in our API and are encoded as a string of decimal digits (rather than
using XML-RPCs built-in 32-bit i4 type).
values of enum types are encoded as strings. For example, a value of destroy of type on normal exit,
would be conveyed as:

<value><string>destroy</string></value>

for all our types, t, our type t Set simply maps to XML-RPCs Array type, so for example a value of
type String Set would be transmitted like this:

for types k and v, our type (k, v) Map maps onto an XML-RPC struct, with the key as the name of the
struct. Note that the (k, v) Map type is only valid when k is a String, Ref, or Int, and in each case
the keys of the maps are stringified as above. For example, the (String, double) Map containing a the
mappings Mike 2.3 and John 1.2 would be represented as:

8
1.3. WIRE PROTOCOL FOR REMOTE API CALLS CHAPTER 1. INTRODUCTION

our Void type is transmitted as an empty string.

1.3.1 Note on References vs UUIDs

References are opaque types encoded as XML-RPC strings on the wire understood only by the particular
server which generated them. Servers are free to choose any concrete representation they find convenient; clients
should not make any assumptions or attempt to parse the string contents. References are not guaranteed to
be permanent identifiers for objects; clients should not assume that references generated during one session are
valid for any future session. References do not allow objects to be compared for equality. Two references to the
same object are not guaranteed to be textually identical.
UUIDs are intended to be permanent names for objects. They are guaranteed to be in the OSF DCE UUID
presentation format (as output by uuidgen. Clients may store UUIDs on disk and use them to lookup objects
in subsequent sessions with the server. Clients may also test equality on objects by comparing UUID strings.
The API provides mechanisms for translating between UUIDs and opaque references. Each class that contains
a UUID field provides:
A get by uuid method that takes a UUID, u, and returns an opaque reference to the server-side object
that has UUID=u;
A get uuid function (a regular field getter RPC) that takes an opaque reference, r, and returns the
UUID of the server-side object that is referenced by r.

1.3.2 Return Values/Status Codes

The return value of an RPC call is an XML-RPC Struct.

The first element of the struct is named Status; it contains a string value indicating whether the result of
the call was a Success or a Failure.

If Status was set to Success then the Struct contains a second element named Value:
The element of the struct named Value contains the functions return value.
In the case where Status is set to Failure then the struct contains a second element named ErrorDescription:
The element of the struct named ErrorDescription contains an array of string values. The first element
of the array is an error code; the remainder of the array are strings representing error parameters relating
to that code.
For example, an XML-RPC return value from the host.get resident VMs function above may look like this:
<struct>
<member>
<name>Status</name>
<value>Success</value>
</member>

9
1.4. MAKING XML-RPC CALLS CHAPTER 1. INTRODUCTION

<member>
<name>Value</name>
<value>
<array>
<data>
<value>81547a35-205c-a551-c577-00b982c5fe00</value>
<value>61c85a22-05da-b8a2-2e55-06b0847da503</value>
<value>1d401ec4-3c17-35a6-fc79-cee6bd9811fe</value>
</data>
</array>
</value>
</member>
</struct>

1.4 Making XML-RPC Calls

1.4.1 Transport Layer
The following transport layers are currently supported:
HTTP/S for remote administration
HTTP over Unix domain sockets for local administration

1.4.2 Session Layer

The XML-RPC interface is session-based; before you can make arbitrary RPC calls you must login and initiate
a session. For example:
session_id session.login_with_password(string uname, string pwd, string version, string originator)
Where uname and password refer to your username and password while version and originator are optional
and refer to the api version and client name respectively, as defined by the Xen administrator. (The version
is ignored at present though. A client that doesnt want to specify it can send uname, pwd, , originator) The
session id returned by session.login with password is passed to subequent RPC calls as an authentication
token.
A session can be terminated with the session.logout function:
void session.logout(session_id session)

1.4.3 Synchronous and Asynchronous invocation

Each method call (apart from methods on Session and Task objects and getters and setters derived
from fields) can be made either synchronously or asynchronously. A synchronous RPC call blocks until the
return value is received; the return value of a synchronous RPC call is exactly as specified in Section 1.3.2.
Only synchronous API calls are listed explicitly in this document. All asynchronous versions are in the special
Async namespace. For example, synchronous call VM.clone(...) (described in Chapter 2) has an asynchronous
counterpart, Async.VM.clone(...), that is non-blocking.
Instead of returning its result directly, an asynchronous RPC call returns a task-id; this identifier is subsequently
used to track the status of a running asynchronous RPC. Note that an asychronous call may fail immediately,
before a task-id has even been createdto represent this eventuality, the returned task-id is wrapped in an
XML-RPC struct with a Status, ErrorDescription and Value fields, exactly as specified in Section 1.3.2.
The task-id is provided in the Value field if Status is set to Success.
The RPC call

10
1.5. EXAMPLE INTERACTIVE SESSION CHAPTER 1. INTRODUCTION

(ref_task Set) Task.get_all(session_id s)

returns a set of all task IDs known to the system. The status (including any returned result and error codes) of
these tasks can then be queried by accessing the fields of the Task object in the usual way. Note that, in order
to get a consistent snapshot of a tasks state, it is advisable to call the get record function.

1.5 Example interactive session

This section describes how an interactive session might look, using the python XML-RPC client library.
First, initialise python and import the library xmlrpclib:

\$ python2.4
...
>>> import xmlrpclib

Create a python object referencing the remote server:

>>> xen = xmlrpclib.Server("https://localhost:443")

Acquire a session reference by logging in with a username and password (error-handling ommitted for brevity;
the session reference is returned under the key Value in the resulting dictionary)

>>> session = xen.session.login_with_password("user", "passwd", "version", "originator")[Value]

When serialised, this call looks like the following:

<?xml version=1.0?>
<methodCall>
<methodName>session.login_with_password</methodName>
<params>
<param>
<value><string>user</string></value>
</param>
<param>
<value><string>passwd</string></value>
</param>
<param>
<value><string>version</string></value>
</param>
<param>
<value><string>originator</string></value>
</param>
</params>
</methodCall>

Next, the user may acquire a list of all the VMs known to the system: (Note the call takes the session reference
as the only parameter)

>>> all_vms = xen.VM.get_all(session)[Value]

>>> all_vms
[OpaqueRef:1, OpaqueRef:2, OpaqueRef:3, OpaqueRef:4 ]

11
1.5. EXAMPLE INTERACTIVE SESSION CHAPTER 1. INTRODUCTION

The VM references here have the form OpaqueRef:X, though they may not be that simple in the future, and
you should treat them as opaque strings. Templates are VMs with the is a template field set to true. We can
find the subset of template VMs using a command like the following:
>>> all_templates = filter(lambda x: xen.VM.get_is_a_template(session, x)[Value], all_vms)
Once a reference to a VM has been acquired a lifecycle operation may be invoked:
>>> xen.VM.start(session, all_templates[0], False, False)
{Status: Failure, ErrorDescription: [VM_IS_TEMPLATE, OpaqueRef:X]}
In this case the start message has been rejected, because the VM is a template, and so an error response
has been returned. These high-level errors are returned as structured data (rather than as XML-RPC faults),
allowing them to be internationalised.
Rather than querying fields individually, whole records may be returned at once. To retrieve the record of a
single object as a python dictionary:
>>> record = xen.VM.get_record(session, all_templates[0])[Value]
>>> record[power_state]
Halted
>>> record[name_label]
XenSource P2V Server
To retrieve all the VM records in a single call:
>>> records = xen.VM.get_all_records(session)[Value]
>>> records.keys()
[OpaqueRef:1, OpaqueRef:2, OpaqueRef:3, OpaqueRef:4 ]
>>> records[OpaqueRef:1][name_label]
RHEL 4.1 Autoinstall Template

12
1.6. VM LIFECYCLE CHAPTER 1. INTRODUCTION

powered down

start(paused=true)

cleanShutdown /
paused start(paused=false)
hardShutdown

resume pause

suspend resume(paused=true) running

suspend resume(paused=false)

suspended

Figure 1.1: VM Lifecycle

1.6 VM Lifecycle
Figure 1.1 shows the states that a VM can be in and the API calls that can be used to move the VM between
these states.

1.7 VM boot parameters

The VM class contains a number of fields that control the way in which the VM is booted. With reference to
the fields defined in the VM class (see later in this document), this section outlines the boot options available
and the mechanisms provided for controlling them.
VM booting is controlled by setting one of the two mutually exclusive groups: PV, and HVM. If HVM.boot policy
is the empty string, then paravirtual domain building and booting will be used; otherwise the VM will be loaded
as an HVM domain, and booted using an emulated BIOS.
When paravirtual booting is in use, the PV/bootloader field indicates the bootloader to use. It may be pygrub,
in which case the platforms default installation of pygrub will be used, or a full path within the control domain
to some other bootloader. The other fields, PV/kernel, PV/ramdisk, PV/args and PV/bootloader args will be
passed to the bootloader unmodified, and interpretation of those fields is then specific to the bootloader itself,
including the possibility that the bootloader will ignore some or all of those given values. Finally the paths of
all bootable disks are added to the bootloader commandline (a disk is bootable if its VBD has the bootable flag
set). There may be zero, one or many bootable disks; the bootloader decides which disk (if any) to boot from.
If the bootloader is pygrub, then the menu.lst is parsed if present in the guests filesystem, otherwise the specified
kernel and ramdisk are used, or an autodetected kernel is used if nothing is specified and autodetection is possible.
PV/args is appended to the kernel command line, no matter which mechanism is used for finding the kernel.
If PV/bootloader is empty but PV/kernel is specified, then the kernel and ramdisk values will be treated as

13
1.7. VM BOOT PARAMETERS CHAPTER 1. INTRODUCTION

paths within the control domain. If both PV/bootloader and PV/kernel are empty, then the behaviour is as if
PV/bootloader was specified as pygrub.
When using HVM booting, HVM/boot policy and HVM/boot params specify the boot handling. Only one
policy is currently defined: BIOS order. In this case, HVM/boot params should contain one key-value pair
order = N where N is the string that will be passed to QEMU.

14
Chapter 2

API Reference

2.1 Classes
The following classes are defined:

15
2.1. CLASSES CHAPTER 2. API REFERENCE

Name Description
session A session
auth Management of remote authentication services
subject A user or group that can log in xapi
role A set of permissions associated with a subject
task A long-running asynchronous task
event Asynchronous event registration and handling
pool Pool-wide information
pool patch Pool-wide patches
VM A virtual machine (or guest)
VM metrics The metrics associated with a VM
VM guest metrics The metrics reported by the guest (as opposed to inferred from
outside)
VMPP VM Protection Policy
VM appliance VM appliance
DR task DR task
host A physical host
host crashdump Represents a host crash dump
host patch Represents a patch stored on a server
host metrics The metrics associated with a host
host cpu A physical CPU
network A virtual network
VIF A virtual network interface
VIF metrics The metrics associated with a virtual network device
PIF A physical network interface (note separate VLANs are repre-
sented as several PIFs)
PIF metrics The metrics associated with a physical network interface
Bond
VLAN A VLAN mux/demux
SM A storage manager plugin
SR A storage repository
LVHD LVHD SR specific operations
VDI A virtual disk image
VBD A virtual block device
VBD metrics The metrics associated with a virtual block device
PBD The physical block devices through which hosts access SRs
crashdump A VM crashdump
VTPM A virtual TPM device
console A console
user A user of the system
data source Data sources for logging in RRDs
blob A placeholder for a binary blob
message An message for the attention of the administrator
secret A secret
tunnel A tunnel for network traffic
PCI A PCI device
PGPU A physical GPU (pGPU)
GPU group A group of compatible GPUs across the resource pool
VGPU A virtual GPU (vGPU)
VGPU type A type of virtual GPU

16
2.2. RELATIONSHIPS BETWEEN CLASSES CHAPTER 2. API REFERENCE

2.2 Relationships Between Classes

Fields that are bound together are shown in the following table:
object.field object.field relationship
VM.snapshot of VM.snapshots one-to-many
VDI.snapshot of VDI.snapshots one-to-many
VM.parent VM.children one-to-many
task.subtask of task.subtasks one-to-many
PIF.bond slave of Bond.slaves one-to-many
Bond.master PIF.bond master of one-to-many
VLAN.tagged PIF PIF.VLAN slave of one-to-many
tunnel.access PIF PIF.tunnel access PIF of one-to-many
tunnel.transport PIF PIF.tunnel transport PIF of one-to-many
PBD.host host.PBDs one-to-many
PBD.SR SR.PBDs one-to-many
VBD.VDI VDI.VBDs one-to-many
crashdump.VDI VDI.crash dumps one-to-many
VBD.VM VM.VBDs one-to-many
crashdump.VM VM.crash dumps one-to-many
VIF.VM VM.VIFs one-to-many
VIF.network network.VIFs one-to-many
PIF.host host.PIFs one-to-many
PIF.network network.PIFs one-to-many
VDI.SR SR.VDIs one-to-many
VTPM.VM VM.VTPMs one-to-many
console.VM VM.consoles one-to-many
VM.resident on host.resident VMs one-to-many
host cpu.host host.host CPUs one-to-many
host crashdump.host host.crashdumps one-to-many
host patch.host host.patches one-to-many
host patch.pool patch pool patch.host patches one-to-many
subject.roles subject.roles unknown type
role.subroles role.subroles many-to-many
VM.protection policy VMPP.VMs one-to-many
VM.appliance VM appliance.VMs one-to-many
PGPU.GPU group GPU group.PGPUs one-to-many
VGPU.GPU group GPU group.VGPUs one-to-many
VGPU.type VGPU type.VGPUs one-to-many
VGPU.VM VM.VGPUs one-to-many
VGPU.resident on PGPU.resident VGPUs one-to-many
PGPU.supported VGPU types VGPU type.supported on PGPUs many-to-many
PGPU.enabled VGPU types VGPU type.enabled on PGPUs many-to-many
GPU group.supported VGPU types VGPU type.supported on GPU groups many-to-many
GPU group.enabled VGPU types VGPU type.enabled on GPU groups many-to-many
PCI.host host.PCIs one-to-many
PGPU.host host.PGPUs one-to-many
VDI.metadata of pool pool.metadata VDIs one-to-many
SR.introduced by DR task.introduced SRs one-to-many
The following represents bound fields (as specified above) diagramatically, using crows-foot notation to specify
one-to-one, one-to-many or many-to-many relationships:

17
2.3. TYPES CHAPTER 2. API REFERENCE

VIF_metrics
console VM_metrics

PIF_metrics
VIF
network
VM_guest_metrics
PIF VM
host_metrics
VTPM

host_cpu
host VBD

session VDI VBD_metrics

PBD
SR
user

PBD_metrics

2.3 Types
2.3.1 Primitives
The following primitive types are used to specify methods and fields in the API Reference:

Type Description
string text strings
int 64-bit integers
float IEEE double-precision floating-point numbers
bool boolean
datetime date and timestamp

2.3.2 Higher-order types

The following type constructors are used:

Type Description
c ref reference to an object of class c
t set a set of elements of type t
(a b) map a table mapping values of type a to values of type b

2.3.3 Enumeration types

The following enumeration types are used:

enum event operation

add An object has been created
del An object has been deleted
mod An object has been modified

18
2.3. TYPES CHAPTER 2. API REFERENCE

enum vgpu type implementation

passthrough Pass through an entire physical GPU to a guest
nvidia vGPU using NVIDIA hardware
gvt g vGPU using Intel GVT-g

enum pgpu dom0 access

enabled dom0 can access this device as normal
disable on reboot On host reboot dom0 will be blocked from accessing this device
disabled dom0 cannot access this device
enable on reboot On host reboot dom0 will be allowed to access this device

enum console protocol

vt100 VT100 terminal
rfb Remote FrameBuffer protocol (as used in VNC)
rdp Remote Desktop Protocol

enum vbd operations

attach Attempting to attach this VBD to a VM
eject Attempting to eject the media from this VBD
insert Attempting to insert new media into this VBD
plug Attempting to hotplug this VBD
unplug Attempting to hot unplug this VBD
unplug force Attempting to forcibly unplug this VBD
pause Attempting to pause a block device backend
unpause Attempting to unpause a block device backend

enum vdi operations

scan Scanning backends for new or deleted VDIs
clone Cloning the VDI
copy Copying the VDI
resize Resizing the VDI
resize online Resizing the VDI which may or may not be online
snapshot Snapshotting the VDI
destroy Destroying the VDI
forget Forget about the VDI
update Refreshing the fields of the VDI

19
2.3. TYPES CHAPTER 2. API REFERENCE

force unlock Forcibly unlocking the VDI

generate config Generating static configuration
blocked Operations on this VDI are temporarily blocked

enum storage operations

scan Scanning backends for new or deleted VDIs
destroy Destroying the SR
forget Forgetting about SR
plug Plugging a PBD into this SR
unplug Unplugging a PBD from this SR
update Refresh the fields on the SR
vdi create Creating a new VDI
vdi introduce Introducing a new VDI
vdi destroy Destroying a VDI
vdi resize Resizing a VDI
vdi clone Cloneing a VDI
vdi snapshot Snapshotting a VDI
pbd create Creating a PBD for this SR
pbd destroy Destroying one of this SRs PBDs

enum vif operations

attach Attempting to attach this VIF to a VM
plug Attempting to hotplug this VIF
unplug Attempting to hot unplug this VIF

enum network operations

attaching Indicates this network is attaching to a VIF or PIF

enum host allowed operations

provision Indicates this host is able to provision another VM
evacuate Indicates this host is evacuating
shutdown Indicates this host is in the process of shutting itself down
reboot Indicates this host is in the process of rebooting
power on Indicates this host is in the process of being powered on
vm start This host is starting a VM
vm resume This host is resuming a VM
vm migrate This host is the migration target of a VM

20
2.3. TYPES CHAPTER 2. API REFERENCE

enum vm appliance operation

start Start
clean shutdown Clean shutdown
hard shutdown Hard shutdown
shutdown Shutdown

enum tristate type

yes Known to be true
no Known to be false
unspecified Unknown or unspecified

enum vm power state

Halted VM is offline and not using any resources
Paused All resources have been allocated but the VM itself is paused and its vCPUs are not running
Running Running
Suspended VM state has been saved to disk and it is nolonger running. Note that disks remain in-use while the

enum after apply guidance

restartHVM This patch requires HVM guests to be restarted once applied.
restartPV This patch requires PV guests to be restarted once applied.
restartHost This patch requires the host to be restarted once applied.
restartXAPI This patch requires XAPI to be restarted once applied.

enum pool allowed operations

ha enable Indicates this pool is in the process of enabling HA
ha disable Indicates this pool is in the process of disabling HA

enum task status type

pending task is in progress
success task was completed successfully
failure task has failed
cancelling task is being cancelled
cancelled task has been cancelled

21
2.3. TYPES CHAPTER 2. API REFERENCE

enum task allowed operations

cancel refers to the operation cancel
destroy refers to the operation destroy

enum on normal exit

destroy destroy the VM state
restart restart the VM

enum on crash behaviour

destroy destroy the VM state
coredump and destroy record a coredump and then destroy the VM state
restart restart the VM
coredump and restart record a coredump and then restart the VM
preserve leave the crashed VM paused
rename restart rename the crashed VM and start a new copy

enum vm operations
snapshot refers to the operation snapshot
clone refers to the operation clone
copy refers to the operation copy
create template refers to the operation create template
revert refers to the operation revert
checkpoint refers to the operation checkpoint
snapshot with quiesce refers to the operation snapshot with quiesce
provision refers to the operation provision
start refers to the operation start
start on refers to the operation start on
pause refers to the operation pause
unpause refers to the operation unpause
clean shutdown refers to the operation clean shutdown
clean reboot refers to the operation clean reboot
hard shutdown refers to the operation hard shutdown
power state reset refers to the operation power state reset
hard reboot refers to the operation hard reboot
suspend refers to the operation suspend
csvm refers to the operation csvm
resume refers to the operation resume
resume on refers to the operation resume on
pool migrate refers to the operation pool migrate
migrate send refers to the operation migrate send

22
2.3. TYPES CHAPTER 2. API REFERENCE

get boot record refers to the operation get boot record

send sysrq refers to the operation send sysrq
send trigger refers to the operation send trigger
query services refers to the operation query services
shutdown refers to the operation shutdown
call plugin refers to the operation call plugin
changing memory live Changing the memory settings
awaiting memory live Waiting for the memory settings to change
changing dynamic range Changing the memory dynamic range
changing static range Changing the memory static range
changing memory limits Changing the memory limits
changing shadow memory Changing the shadow memory for a halted VM.
changing shadow memory live Changing the shadow memory for a running VM.
changing VCPUs Changing VCPU settings for a halted VM.
changing VCPUs live Changing VCPU settings for a running VM.
assert operation valid
data source op Add, remove, query or list data sources
update allowed operations
make into template Turning this VM into a template
import importing a VM from a network stream
export exporting a VM to a network stream
metadata export exporting VM metadata to a network stream
reverting Reverting the VM to a previous snapshotted state
destroy refers to the act of uninstalling the VM

enum vmpp backup frequency

hourly Hourly backups
daily Daily backups
weekly Weekly backups

enum vmpp archive frequency

never Never archive
always after backup Archive after backup
daily Daily archives
weekly Weekly backups

enum vmpp archive target type

none No target config
cifs CIFS target config
nfs NFS target config

23
2.3. TYPES CHAPTER 2. API REFERENCE

enum vmpp backup type

snapshot The backup is a snapshot
checkpoint The backup is a checkpoint

enum host display

enabled This host is outputting its console to a physical display device
disable on reboot The host will stop outputting its console to a physical display device on next boot
disabled This host is not outputting its console to a physical display device
enable on reboot The host will start outputting its console to a physical display device on next boot

enum network default locking mode

unlocked Treat all VIFs on this network with locking mode = default as if they have locking
disabled Treat all VIFs on this network with locking mode = default as if they have locking

enum vif locking mode

network default No specific configuration set - default network policy applies
locked Only traffic to a specific MAC and a list of IPv4 or IPv6 addresses is permitted
unlocked All traffic is permitted
disabled No traffic is permitted

enum vif ipv4 configuration mode

None Follow the default IPv4 configuration of the guest (this is guest-dependent)
Static Static IPv4 address configuration

enum vif ipv6 configuration mode

None Follow the default IPv6 configuration of the guest (this is guest-dependent)
Static Static IPv6 address configuration

enum ip configuration mode

24
2.3. TYPES CHAPTER 2. API REFERENCE

None Do not acquire an IP address

DHCP Acquire an IP address by DHCP
Static Static IP address configuration

enum ipv6 configuration mode

None Do not acquire an IPv6 address
DHCP Acquire an IPv6 address by DHCP
Static Static IPv6 address configuration
Autoconf Router assigned prefix delegation IPv6 allocation

enum primary address type

IPv4 Primary address is the IPv4 address
IPv6 Primary address is the IPv6 address

enum bond mode

balance-slb Source-level balancing
active-backup Active/passive bonding: only one NIC is carrying traffic
lacp Link aggregation control protocol

enum vdi type

system a disk that may be replaced on upgrade
user a disk that is always preserved on upgrade
ephemeral a disk that may be reformatted on upgrade
suspend a disk that stores a suspend image
crashdump a disk that stores VM crashdump information
ha statefile a disk used for HA storage heartbeating
metadata a disk used for HA Pool metadata
redo log a disk used for a general metadata redo-log
rrd a disk that stores SR-level RRDs

enum on boot
reset When a VM containing this VDI is started, the contents of the VDI are reset to the state they were in when
persist Standard behaviour.

25
2.3. TYPES CHAPTER 2. API REFERENCE

enum vbd mode

RO only read-only access will be allowed
RW read-write access will be allowed

enum vbd type

CD VBD will appear to guest as CD
Disk VBD will appear to guest as disk
Floppy VBD will appear as a floppy

enum cls
VM VM
Host Host
SR SR
Pool Pool
VMPP VMPP

enum allocation algorithm

breadth first vGPUs of a given type are allocated evenly across supporting pGPUs.
depth first vGPUs of a given type are allocated on supporting pGPUs until they are full.

26
2.4. CLASS: SESSION CHAPTER 2. API REFERENCE

2.4 Class: session

2.4.1 Fields for class: session

Name session
Description A session.
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO run this host host ref Currently connected host
RO run this user user ref Currently connected user
RO run last active datetime Timestamp for last time session was active
RO run pool bool True if this session relates to a intra-pool
login, false otherwise
RW other config (string string) map additional configuration
RO run is local superuser bool true iff this session was created using local
superuser credentials
RO run subject subject ref references the subject instance that cre-
ated the session. If a session instance has
is local superuser set, then the value of this
field is undefined.
RO run validation time datetime time when session was last validated
RO run auth user sid string the subject identifier of the user that was
externally authenticated. If a session in-
stance has is local superuser set, then the
value of this field is undefined.
RO run auth user name string the subject name of the user that was ex-
ternally authenticated. If a session in-
stance has is local superuser set, then the
value of this field is undefined.
RO ins rbac permissions string set list with all RBAC permissions for this ses-
sion
RO run tasks task ref set list of tasks created using the current ses-
sion
RO ins parent session ref references the parent session that created
this session
RO run originator string a key string provided by a API user to dis-
tinguish itself from other users sharing the
same login name

2.4.2 RPCs associated with class: session

RPC name: login with password
Overview:
Attempt to authenticate the user, returning a session reference if successful.
Signature:
(session ref) login_with_password (string uname, string pwd, string version, string originator)
Arguments:

27
2.4. CLASS: SESSION CHAPTER 2. API REFERENCE

type name description

string uname Username for login.
string pwd Password for login.
string version Client API version.
string originator Key string for distinguishing different API
users sharing the same login name.

Return Type: session ref

reference of newly created session

Possible Error Codes: SESSION AUTHENTICATION FAILED, HOST IS SLAVE

RPC name: logout

Overview:
Log out of a session.
Signature:
void logout (session_id s)

Return Type: void

RPC name: change password

Overview:
Change the account password; if your session is authenticated with root priviledges then the old pwd is validated
and the new pwd is set regardless.
Signature:
void change_password (session_id s, string old_pwd, string new_pwd)
Arguments:

type name description

string old pwd Old password for account
string new pwd New password for account

Return Type: void

RPC name: slave local login with password

Overview:
Authenticate locally against a slave in emergency mode. Note the resulting sessions are only good for use on
this host.
Signature:
(session ref) slave_local_login_with_password (string uname, string pwd)

28
2.4. CLASS: SESSION CHAPTER 2. API REFERENCE

Arguments:

type name description

string uname Username for login.
string pwd Password for login.

Return Type: session ref

ID of newly created session

RPC name: create from db file

Overview:
.
Signature:
(session ref) create_from_db_file (session_id s, string filename)
Arguments:

type name description

string filename Database dump filename.

Return Type: session ref

ID of newly created session

RPC name: local logout

Overview:
Log out of local session.
Signature:
void local_logout (session_id s)

Return Type: void

RPC name: get all subject identifiers

Overview:
Return a list of all the user subject-identifiers of all existing sessions.
Signature:
(string set) get_all_subject_identifiers (session_id s)

Return Type: string set

The list of user subject-identifiers of all existing sessions

29
2.4. CLASS: SESSION CHAPTER 2. API REFERENCE

RPC name: logout subject identifier

Overview:
Log out all sessions associated to a user subject-identifier, except the session associated with the context calling
this function.
Signature:
void logout_subject_identifier (session_id s, string subject_identifier)
Arguments:

type name description

string subject identifier User subject-identifier of the sessions to be de-
stroyed

Return Type: void

RPC name: get uuid

Overview:
Get the uuid field of the given session.
Signature:
string get_uuid (session_id s, session ref self)
Arguments:

type name description

session ref self reference to the object

Return Type: string

value of the field

RPC name: get this host

Overview:
Get the this host field of the given session.
Signature:

(host ref) get_this_host (session_id s, session ref self)

Arguments:

type name description

session ref self reference to the object

Return Type: host ref

type name description

session ref self reference to the object

Return Type: subject ref

Return Type: string

Return Type: session ref

Return Type: session record

all fields from the object

36
2.5. CLASS: AUTH CHAPTER 2. API REFERENCE

2.5 Class: auth

2.5.1 Fields for class: auth
Class auth has no fields.

2.5.2 RPCs associated with class: auth

RPC name: get subject identifier
Overview:
This call queries the external directory service to obtain the subject identifier as a string from the human-readable
subject name.
Signature:
string get_subject_identifier (session_id s, string subject_name)
Arguments:

type name description

string subject name The human-readable subject name, such as a
username or a groupname

Return Type: string

the subject identifier obtained from the external directory service

RPC name: get subject information from identifier

Overview:
This call queries the external directory service to obtain the user information (e.g. username, organization etc)
from the specified subject identifier.
Signature:
((string -> string) map) get_subject_information_from_identifier (session_id s, string subject_identifier)
Arguments:

type name description

string subject identifier A string containing the subject identifier,
unique in the external directory service

Return Type: (string string) map

key-value pairs containing at least a key called subject name

RPC name: get group membership

Overview:
This calls queries the external directory service to obtain the transitively-closed set of groups that the the
subject identifier is member of.
Signature:

37
2.5. CLASS: AUTH CHAPTER 2. API REFERENCE

(string set) get_group_membership (session_id s, string subject_identifier)

Arguments:

type name description

string subject identifier A string containing the subject identifier,
unique in the external directory service

Return Type: string set

set of subject identifiers that provides the group membership of subject identifier passed as argument, it contains,
recursively, all groups a subject identifier is member of.

38
2.6. CLASS: SUBJECT CHAPTER 2. API REFERENCE

2.6 Class: subject

2.6.1 Fields for class: subject

Name subject
Description A user or group that can log in xapi.
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO ins subject identifier string the subject identifier, unique in the exter-
nal directory service
RO ins other config (string string) map additional configuration
RO run roles role ref set the roles associated with this subject

2.6.2 RPCs associated with class: subject

RPC name: add to roles
Overview:
This call adds a new role to a subject.
Signature:
void add_to_roles (session_id s, subject ref self, role ref role)
Arguments:

type name description

subject ref self The subject who we want to add the role to
role ref role The unique role reference

Return Type: void

Overview:
Get a reference to the subject instance with the specified UUID.
Signature:
(subject ref) get_by_uuid (session_id s, string uuid)

42
2.6. CLASS: SUBJECT CHAPTER 2. API REFERENCE

Arguments:

type name description

string uuid UUID of object to return

Return Type: subject ref

reference to the object

RPC name: get record

Overview:
Get a record containing the current state of the given subject.
Signature:
(subject record) get_record (session_id s, subject ref self)
Arguments:

type name description

subject ref self reference to the object

Return Type: subject record

all fields from the object

43
2.7. CLASS: ROLE CHAPTER 2. API REFERENCE

2.7 Class: role

2.7.1 Fields for class: role

Name role
Description A set of permissions associated with a subject.
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO ins name label string a short user-friendly name for the role
RO ins name description string what this role is for
RO ins subroles role ref set a list of pointers to other roles or permis-
sions

2.7.2 RPCs associated with class: role

RPC name: get permissions
Overview:
This call returns a list of permissions given a role.
Signature:
(role ref set) get_permissions (session_id s, role ref self)
Arguments:

type name description

role ref self a reference to a role

Return Type: role ref set

a list of permissions

RPC name: get permissions name label

Overview:
This call returns a list of permission names given a role.
Signature:
(string set) get_permissions_name_label (session_id s, role ref self)
Arguments:

type name description

role ref self a reference to a role

Return Type: string set

RPC name: get all records

Overview:
Return a map of role references to role records for all roles known to the system.
Signature:

45
2.7. CLASS: ROLE CHAPTER 2. API REFERENCE

role ref self reference to the object

46
2.7. CLASS: ROLE CHAPTER 2. API REFERENCE

Return Type: string

value of the field

RPC name: get subroles

Overview:
Get the subroles field of the given role.
Signature:
(role ref set) get_subroles (session_id s, role ref self)
Arguments:

type name description

role ref self reference to the object

Return Type: role ref set

value of the field

RPC name: get by uuid

Overview:
Get a reference to the role instance with the specified UUID.
Signature:
(role ref) get_by_uuid (session_id s, string uuid)
Arguments:

type name description

string uuid UUID of object to return

Return Type: role ref

reference to the object

RPC name: get record

Overview:
Get a record containing the current state of the given role.
Signature:
(role record) get_record (session_id s, role ref self)
Arguments:

type name description

role ref self reference to the object

Return Type: role record

47
2.7. CLASS: ROLE CHAPTER 2. API REFERENCE

all fields from the object

RPC name: get by name label

Overview:
Get all the role instances with the given label.
Signature:
(role ref set) get_by_name_label (session_id s, string label)
Arguments:

type name description

string label label of object to return

Return Type: role ref set

references to objects with matching names

48
2.8. CLASS: TASK CHAPTER 2. API REFERENCE

2.8 Class: task

2.8.1 Fields for class: task

Name task
Description A long-running asynchronous task.
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO run name label string a human-readable name
RO run name description string a notes field containing human-readable
description
RO run allowed operations task allowed 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 task allowed 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 created datetime Time task was created
RO run finished datetime Time task finished (i.e. succeeded or
failed). If task-status is pending, then the
value of this field has no meaning
RO run status task status type current status of the task
RO run resident on host ref the host on which the task is running
RO run progress float This field contains the estimated fraction
of the task which is complete. This field
should not be used to determine whether
the task is complete - for this the status
field of the task should be used.
RO run type string if the task has completed successfully, this
field contains the type of the encoded result
(i.e. name of the class whose reference is
in the result field). Undefined otherwise.
RO run result string if the task has completed successfully, this
field contains the result value (either Void
or an object reference). Undefined other-
wise.
RO run error info string set if the task has failed, this field contains the
set of associated error strings. Undefined
otherwise.
RW other config (string string) map additional configuration
RO run subtask of task ref Ref pointing to the task this is a substask
of.
RO run subtasks task ref set List pointing to all the substasks.
RO run backtrace string Function call trace for debugging.

49
2.8. CLASS: TASK CHAPTER 2. API REFERENCE

2.8.2 RPCs associated with class: task

RPC name: create
Overview:
Create a new task object which must be manually destroyed.
Signature:
(task ref) create (session_id s, string label, string description)
Arguments:

type name description

string label short label for the new task
string description longer description for the new task

Return Type: task ref

The reference of the created task object

RPC name: destroy

Overview:
Destroy the task object.
Signature:
void destroy (session_id s, task ref self)
Arguments:

type name description

task ref self Reference to the task object

Return Type: void

RPC name: cancel

Overview:
Request that a task be cancelled. Note that a task may fail to be cancelled and may complete or fail normally
and note that, even when a task does cancel, it might take an arbitrary amount of time.
Signature:
void cancel (session_id s, task ref task)
Arguments:

type name description

task ref task The task

Return Type: void

Overview:
Add the given key-value pair to the other config field of the given task.
Signature:
void add_to_other_config (session_id s, task ref self, string key, string value)
Arguments:

type name description

task ref self reference to the object
string key Key to add
string value Value to add

Return Type: void

RPC name: remove from other config

Overview:
Remove the given key and its corresponding value from the other config field of the given task. If the key is not
in that Map, then do nothing.
Signature:
void remove_from_other_config (session_id s, task ref self, string key)

56
2.8. CLASS: TASK CHAPTER 2. API REFERENCE

Arguments:

type name description

task ref self reference to the object
string key Key to remove

Return Type: void

59
2.9. CLASS: EVENT CHAPTER 2. API REFERENCE

2.9 Class: event

2.9.1 Fields for class: event

Name event
Description Asynchronous event registration and handling.
Quals Field Type Description
RO ins id int An ID, monotonically increasing, and local
to the current session
RO ins timestamp datetime The time at which the event occurred
RO ins class string The name of the class of the object that
changed
RO ins operation event operation The operation that was performed
RO ins ref string A reference to the object that changed
RO ins obj uuid string The uuid of the object that changed

2.9.2 RPCs associated with class: event

RPC name: register
Overview:
Registers this session with the event system. Specifying * as the desired class will register for all classes.
Signature:
void register (session_id s, string set classes)
Arguments:

type name description

string set classes register for events for the indicated classes

Return Type: void

RPC name: unregister

Overview:
Unregisters this session with the event system.
Signature:
void unregister (session_id s, string set classes)
Arguments:

type name description

string set classes remove this sessions registration for the indi-
cated classes

Return Type: void

60
2.9. CLASS: EVENT CHAPTER 2. API REFERENCE

RPC name: next

Overview:
Blocking call which returns a (possibly empty) batch of events. This method is only recommended for legacy
use. New development should use event.from which supercedes this method. .
Signature:
(event record set) next (session_id s)

Return Type: event record set

the batch of events

Possible Error Codes: SESSION NOT REGISTERED, EVENTS LOST

RPC name: from

Overview:
Blocking call which returns a new token and a (possibly empty) batch of events. The returned token can be
used in subsequent calls to this function.
Signature:
(event record set) from (session_id s, string set classes, string token, float timeout)
Arguments:

type name description

string set classes register for events for the indicated classes
string token A token representing the point from which to
generate database events. The empty string
represents the beginning.
float timeout Return after this many seconds if no events
match

Return Type: event record set

the batch of events

Possible Error Codes: SESSION NOT REGISTERED, EVENTS LOST

RPC name: get current id

Overview:
Return the ID of the next event to be generated by the system.
Signature:
int get_current_id (session_id s)

Return Type: int

the event ID

61
2.9. CLASS: EVENT CHAPTER 2. API REFERENCE

RPC name: inject

Overview:
Injects an artificial event on the given object and return the corresponding ID.
Signature:
string inject (session_id s, string class, string ref)
Arguments:

type name description

string class class of the object
string ref A reference to the object that will be changed.

Return Type: string

the event ID

62
2.10. CLASS: POOL CHAPTER 2. API REFERENCE

2.10 Class: pool

2.10.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
are created
RW crash dump SR SR ref The SR in which VDIs for crash du
created
RW other config (string string) map additional configuration
RO run ha enabled bool true if HA is enabled on the pool, fa
erwise
RO run ha configuration (string string) map The current HA configuration
RO run ha statefiles string set HA statefile VDIs in use
RO run ha host failures to tolerate int Number of host failures to tolerat
the Pool is declared to be overcom
RO run ha plan exists for int Number of future host failures w
managed to find a plan for. On
reaches zero any future host failu
cause the failure of protected VMs
RW ha allow overcommit bool If set to false then operations whic
cause the Pool to become overcom
will be blocked.
RO run ha overcommitted bool True if the Pool is considered to
committed i.e. if there exist ins
physical resources to tolerate the
ured number of host failures
RO run blobs (string blob ref) map Binary blobs associated with this
RW tags string set user-specified tags for categorizat
poses
RW gui config (string string) map gui-specific configuration for pool
RW health check config (string string) map Configuration for the automatic
check feature
RO run wlb url string Url for the configured workload ba
host
RO run wlb username string Username for accessing the worklo
ancing host
RW wlb enabled bool true if workload balancing is ena
the pool, false otherwise
RW wlb verify cert bool true if communication with th
server should enforce SSL certific
ification.

63
2.10. CLASS: POOL CHAPTER 2. API REFERENCE

RO run redo log enabled bool true a redo-log is to be used oth

when HA is enabled, false otherwi
RO run redo log vdi VDI ref indicates the VDI to use for the
other than when HA is enabled
RO run vswitch controller string address of the vswitch controller
RO run restrictions (string string) map Pool-wide restrictions currently in
RO run metadata VDIs VDI ref set The set of currently known metada
for this pool
RO run ha cluster stack string The HA cluster stack that is curr
use. Only valid when HA is enable
RO run allowed operations pool allowed operations set list of the operations allowed in th
This list is advisory only and th
state may have changed by the ti
field is read by a client.
RO run current operations (string pool allowed operations) map links each of the running task
this object (by reference) to
rent operation enum which descri
nature of the task.
RO run guest agent config (string string) map Pool-wide guest agent configuratio
mation
RO run cpu info (string string) map Details about the physical CPUs
pool

2.10.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

65
2.10. CLASS: POOL CHAPTER 2. API REFERENCE

Arguments:

type name description

string master address The hostname of the master

Return Type: void

RPC name: recover slaves

Overview:
Instruct a pool master, M, to try and contact its slaves and, if slaves are in emergency mode, reset their master
address to M.
Signature:
(host ref set) recover_slaves (session_id s)

Return Type: host ref set

list of hosts whose master address were successfully reset

RPC name: create VLAN

Overview:
Create PIFs, mapping a network to the same physical interface/VLAN on each host. This call is deprecated:
use Pool.create VLAN from PIF instead.
Signature:
(PIF ref set) create_VLAN (session_id s, string device, network ref network, int VLAN)
Arguments:

type name description

string device physical interface on which to create the
VLAN interface
network ref network network to which this interface should be con-
nected
int VLAN VLAN tag for the new interface

Return Type: PIF ref set

The references of the created PIF objects

Possible Error Codes: VLAN TAG INVALID

RPC name: create VLAN from PIF

Overview:
Create a pool-wide VLAN by taking the PIF.
Signature:
(PIF ref set) create_VLAN_from_PIF (session_id s, PIF ref pif, network ref network, int VLAN)

66
2.10. CLASS: POOL CHAPTER 2. API REFERENCE

Arguments:

type name description

PIF ref pif physical interface on any particular host, that
identifies the PIF on which to create the (pool-
wide) VLAN interface
network ref network network to which this interface should be con-
nected
int VLAN VLAN tag for the new interface

Return Type: PIF ref set

The references of the created PIF objects

Possible Error Codes: VLAN TAG INVALID

RPC name: enable ha

Overview:
Turn on High Availability mode.
Signature:
void enable_ha (session_id s, SR ref set heartbeat_srs, (string -> string) map configuration)
Arguments:

type name description

SR ref set heartbeat srs Set of SRs to use for storage heartbeating
(string string) map configuration Detailed HA configuration to apply

Return Type: void

RPC name: disable ha

Overview:
Turn off High Availability mode.
Signature:
void disable_ha (session_id s)

Return Type: void

RPC name: sync database

type name description

int n The number of host failures to plan for

Return Type: bool

true if a failover plan exists for the supplied number of host failures

68
2.10. CLASS: POOL CHAPTER 2. API REFERENCE

RPC name: ha compute max host failures to tolerate

Overview:
Returns the maximum number of host failures we could tolerate before we would be unable to restart configured
VMs.
Signature:
int ha_compute_max_host_failures_to_tolerate (session_id s)

Return Type: int

maximum value for ha host failures to tolerate given current configuration

RPC name: ha compute hypothetical max host failures to tolerate

Overview:
Returns the maximum number of host failures we could tolerate before we would be unable to restart the
provided VMs.
Signature:
int ha_compute_hypothetical_max_host_failures_to_tolerate (session_id s, (VM ref -> string) map configurat
Arguments:

type name description

(VM ref string) map configuration Map of protected VM reference to restart pri-
ority

Return Type: int

maximum value for ha host failures to tolerate given provided configuration

RPC name: ha compute vm failover plan

Return Type: blob ref

The reference of the blob, needed for populating its data

RPC name: enable external auth

Overview:
This call enables external authentication on all the hosts of the pool.
Signature:
void enable_external_auth (session_id s, pool ref pool, (string -> string) map config, string service_name
Arguments:

70
2.10. CLASS: POOL CHAPTER 2. API REFERENCE

type name description

pool ref pool The pool whose external authentication
should be enabled
(string string) map config A list of key-values containing the configura-
tion data
string service name The name of the service
string auth type The type of authentication (e.g. AD for Active
Directory)

Return Type: void

RPC name: disable external auth

Overview:
This call disables external authentication on all the hosts of the pool.
Signature:
void disable_external_auth (session_id s, pool ref pool, (string -> string) map config)
Arguments:

type name description

pool ref pool The pool whose external authentication
should be disabled
(string string) map config Optional parameters as a list of key-values
containing the configuration data

Return Type: void

RPC name: detect nonhomogeneous external auth

Overview:
This call asynchronously detects if the external authentication configuration in any slave is different from that
in the master and raises appropriate alerts.
Signature:
void detect_nonhomogeneous_external_auth (session_id s, pool ref pool)
Arguments:

type name description

pool ref pool The pool where to detect non-homogeneous
external authentication configuration

Return Type: void

71
2.10. CLASS: POOL CHAPTER 2. API REFERENCE

RPC name: initialize wlb

Overview:
Initializes workload balancing monitoring on this pool with the specified wlb server.
Signature:
void initialize_wlb (session_id s, string wlb_url, string wlb_username, string wlb_password, string xenser
Arguments:

type name description

string wlb url The ip address and port to use when accessing
the wlb server
string wlb username The username used to authenticate with the
wlb server
string wlb password The password used to authenticate with the
wlb server
string xenserver username The username used by the wlb server to au-
thenticate with the xenserver
string xenserver password The password used by the wlb server to au-
thenticate with the xenserver

Return Type: void

RPC name: deconfigure wlb

Overview:
Permanently deconfigures workload balancing monitoring on this pool.
Signature:
void deconfigure_wlb (session_id s)

Return Type: void

RPC name: send wlb configuration

Overview:
Sets the pool optimization criteria for the workload balancing server.
Signature:
void send_wlb_configuration (session_id s, (string -> string) map config)
Arguments:

type name description

(string string) map config The configuration to use in optimizing this
pool

Return Type: void

72
2.10. CLASS: POOL CHAPTER 2. API REFERENCE

RPC name: retrieve wlb configuration

Overview:
Retrieves the pool optimization criteria from the workload balancing server.
Signature:
((string -> string) map) retrieve_wlb_configuration (session_id s)

Return Type: (string string) map

The configuration used in optimizing this pool

RPC name: retrieve wlb recommendations

Overview:
Retrieves vm migrate recommendations for the pool from the workload balancing server.
Signature:
((VM ref -> string set) map) retrieve_wlb_recommendations (session_id s)

Return Type: (VM ref string set) map

The list of vm migration recommendations

RPC name: send test post

Overview:
Send the given body to the given host and port, using HTTPS, and print the response. This is used for debugging
the SSL layer.
Signature:
string send_test_post (session_id s, string host, int port, string body)
Arguments:

type name description

string host
int port
string body

Return Type: string

The response

RPC name: certificate install

Overview:
Install an SSL certificate pool-wide.
Signature:
void certificate_install (session_id s, string name, string cert)

73
2.10. CLASS: POOL CHAPTER 2. API REFERENCE

Arguments:

type name description

string name A name to give the certificate
string cert The certificate

Return Type: void

RPC name: certificate uninstall

Overview:
Remove an SSL certificate.
Signature:
void certificate_uninstall (session_id s, string name)
Arguments:

type name description

string name The certificate name

Return Type: void

RPC name: certificate list

Overview:
List all installed SSL certificates.
Signature:
(string set) certificate_list (session_id s)

Return Type: string set

All installed certificates

RPC name: crl install

Overview:
Install an SSL certificate revocation list, pool-wide.
Signature:
void crl_install (session_id s, string name, string cert)
Arguments:

type name description

string name A name to give the CRL
string cert The CRL

Return Type: void

74
2.10. CLASS: POOL CHAPTER 2. API REFERENCE

RPC name: crl uninstall

Overview:
Remove an SSL certificate revocation list.
Signature:
void crl_uninstall (session_id s, string name)
Arguments:

type name description

string name The CRL name

Return Type: void

RPC name: crl list

Overview:
List all installed SSL certificate revocation lists.
Signature:
(string set) crl_list (session_id s)

Return Type: string set

All installed CRLs

RPC name: certificate sync

Overview:
Sync SSL certificates from master to slaves.
Signature:
void certificate_sync (session_id s)

Return Type: void

RPC name: enable redo log

Overview:
Enable the redo log on the given SR and start using it, unless HA is enabled.
Signature:
void enable_redo_log (session_id s, SR ref sr)
Arguments:

type name description

SR ref sr SR to hold the redo log.

75
2.10. CLASS: POOL CHAPTER 2. API REFERENCE

Return Type: void

RPC name: disable redo log

Overview:
Disable the redo log if in use, unless HA is enabled.
Signature:
void disable_redo_log (session_id s)

Return Type: void

RPC name: set vswitch controller

Overview:
Set the IP address of the vswitch controller.
Signature:
void set_vswitch_controller (session_id s, string address)
Arguments:

type name description

string address IP address of the vswitch controller.

Return Type: void

RPC name: test archive target

Overview:
This call tests if a location is valid.
Signature:
string test_archive_target (session_id s, pool ref self, (string -> string) map config)
Arguments:

type name description

pool ref self Reference to the pool
(string string) map config Location config settings to test

Return Type: string

An XMLRPC result

76
2.10. CLASS: POOL CHAPTER 2. API REFERENCE

pool ref self Reference to the pool
string edition The requested edition

Return Type: void

RPC name: enable ssl legacy

Overview:
Sets ssl legacy true on each host, pool-master last. See Host.ssl legacy and Host.set ssl legacy.
Signature:
void enable_ssl_legacy (session_id s, pool ref self)
Arguments:

type name description

pool ref self (ignored)

Return Type: void

RPC name: get name description

Overview:
Get the name description field of the given pool.
Signature:
string get_name_description (session_id s, pool ref self)
Arguments:

type name description

pool ref self reference to the object

Return Type: string

value of the field

RPC name: set name description

Overview:
Set the name description field of the given pool.
Signature:
void set_name_description (session_id s, pool ref self, string value)

81
2.10. CLASS: POOL CHAPTER 2. API REFERENCE

Arguments:

type name description

pool ref self reference to the object
string value New value to set

Return Type: void

Return Type: void

RPC name: get ha enabled

Overview:
Get the ha enabled field of the given pool.
Signature:
bool get_ha_enabled (session_id s, pool ref self)

85
2.10. CLASS: POOL CHAPTER 2. API REFERENCE

pool ref self reference to the object
bool value New value to set

Return Type: void

pool ref self reference to the object
string value Value to remove

Return Type: void

RPC name: get gui config

Overview:
Get the gui config field of the given pool.
Signature:
((string -> string) map) get_gui_config (session_id s, pool ref self)
Arguments:

type name description

pool ref self reference to the object

Return Type: (string string) map

value of the field

RPC name: set gui config

Overview:
Set the gui config field of the given pool.
Signature:
void set_gui_config (session_id s, pool ref self, (string -> string) map value)
Arguments:

type name description

pool ref self reference to the object
(string string) map value New value to set

Return Type: void

RPC name: add to gui config

Overview:
Add the given key-value pair to the gui config field of the given pool.
Signature:
void add_to_gui_config (session_id s, pool ref self, string key, string value)

value of the field

RPC name: set health check config

Overview:
Set the health check config field of the given pool.
Signature:
void set_health_check_config (session_id s, pool ref self, (string -> string) map value)

Return Type: bool

value of the field

RPC name: set wlb enabled

Overview:
Set the wlb enabled field of the given pool.
Signature:
void set_wlb_enabled (session_id s, pool ref self, bool value)

93
2.10. CLASS: POOL CHAPTER 2. API REFERENCE

Arguments:

type name description

pool ref self reference to the object
bool value New value to set

Return Type: void

RPC name: get wlb verify cert

Overview:
Get the wlb verify cert field of the given pool.
Signature:
bool get_wlb_verify_cert (session_id s, pool ref self)
Arguments:

type name description

pool ref self reference to the object

Return Type: bool

value of the field

RPC name: set wlb verify cert

Overview:
Set the wlb verify cert field of the given pool.
Signature:
void set_wlb_verify_cert (session_id s, pool ref self, bool value)
Arguments:

type name description

pool ref self reference to the object
bool value New value to set

Return Type: void

98
2.11. CLASS: POOL PATCH CHAPTER 2. API REFERENCE

2.11 Class: pool patch

2.11.1 Fields for class: pool patch

Name pool patch

RPC name: pool clean

Overview:
Removes the patchs files from all hosts in the pool, but does not remove the database entries.
Signature:
void pool_clean (session_id s, pool_patch ref self)
Arguments:

type name description

pool patch ref self The patch to clean up

Return Type: void

100
2.11. CLASS: POOL PATCH CHAPTER 2. API REFERENCE

RPC name: destroy

Overview:
Removes the patchs files from all hosts in the pool, and removes the database entries. Only works on unapplied
patches.
Signature:
void destroy (session_id s, pool_patch ref self)
Arguments:

type name description

pool patch ref self The patch to destroy

Return Type: void

RPC name: clean on host

Overview:
Removes the patchs files from the specified host.
Signature:
void clean_on_host (session_id s, pool_patch ref self, host ref host)
Arguments:

type name description

pool patch ref self The patch to clean up
host ref host The host on which to clean the patch

Return Type: void

RPC name: get all

Overview:
Return a list of all the pool patchs known to the system.
Signature:
(pool_patch ref set) get_all (session_id s)

Return Type: pool patch ref set

references to all objects

RPC name: get all records

Overview:
Return a map of pool patch references to pool patch records for all pool patchs known to the system.
Signature:

101
2.11. CLASS: POOL PATCH CHAPTER 2. API REFERENCE

type name description

pool patch ref self reference to the object

Return Type: bool

103
2.11. CLASS: POOL PATCH CHAPTER 2. API REFERENCE

Return Type: pool patch ref set

references to objects with matching names

106
2.12. CLASS: VM CHAPTER 2. API REFERENCE

2.12 Class: VM
2.12.1 Fields for class: VM

Name VM
Description A virtual machine (or guest).
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO run allowed operations vm 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 vm 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 power state vm power state Current power state of the machine
RW name label string a human-readable name
RW name description string a notes field containing human-readable
description
RW user version int Creators of VMs and templates may store
version information here.
RW is a template bool true if this is a template. Template VMs
can never be started, they are used only
for cloning other VMs
RO run suspend VDI VDI ref The VDI that a suspend image is stored
on. (Only has meaning if VM is currently
suspended)
RO run resident on host ref the host the VM is currently resident on
RW affinity host ref a host which the VM has some affinity
for (or NULL). This is used as a hint to
the start call when it decides where to run
the VM. Implementations are free to ignore
this field.
RO run memory overhead int Virtualization memory overhead (bytes).
RO ins memory target int Dynamically-set memory target (bytes).
The value of this field indicates the current
target for memory available to this VM.
RO ins memory static max int Statically-set (i.e. absolute) maximum
(bytes). The value of this field at VM start
time acts as a hard limit of the amount of
memory a guest can use. New values only
take effect on reboot.
RO ins memory dynamic max int Dynamic maximum (bytes)
RO ins memory dynamic min int Dynamic minimum (bytes)
RO ins memory static min int Statically-set (i.e. absolute) mininum
(bytes). The value of this field indicates
the least amount of memory this VM can
boot with without crashing.
RW VCPUs params (string string) map configuration parameters for the selected
VCPU policy

107
2.12. CLASS: VM CHAPTER 2. API REFERENCE

RO ins VCPUs max int Max number of VCPUs

RO ins VCPUs at startup int Boot number of VCPUs
RW actions after shutdown on normal exit action to take after the guest has shutdown
itself
RW actions after reboot on normal exit action to take after the guest has rebooted
itself
RW actions after crash on crash behaviour action to take if the guest crashes
RO run consoles console ref set virtual console devices
RO run VIFs VIF ref set virtual network interfaces
RO run VBDs VBD ref set virtual block devices
RO run crash dumps crashdump ref set crash dumps associated with this VM
RO run VTPMs VTPM ref set virtual TPMs
RW PV bootloader string name of or path to bootloader
RW PV kernel string path to the kernel
RW PV ramdisk string path to the initrd
RW PV args string kernel command-line arguments
RW PV bootloader args string miscellaneous arguments for the boot-
loader
RW PV legacy args string to make Zurich guests boot
RW HVM boot policy string HVM boot policy
RW HVM boot params (string string) map HVM boot params
RO ins HVM shadow multiplier float multiplier applied to the amount of shadow
that will be made available to the guest
RW platform (string string) map platform-specific configuration
RW PCI bus string PCI bus path for pass-through devices
RW other config (string string) map additional configuration
RO run domid int domain ID (if available, -1 otherwise)
RO run domarch string Domain architecture (if available, null
string otherwise)
RO run last boot CPU flags (string string) map describes the CPU flags on which the VM
was last booted
RO run is control domain bool true if this is a control domain (domain 0
or a driver domain)
RO run metrics VM metrics ref metrics associated with this VM
RO run guest metrics VM guest metrics ref metrics associated with the running guest
RO run last booted record string marshalled value containing VM record at
time of last boot, updated dynamically to
reflect the runtime state of the domain
RW recommendations string An XML specification of recommended val-
ues and ranges for properties of this VM
RW xenstore data (string string) map data to be inserted into the xenstore
tree (/local/domain/domid/vm-data) af-
ter the VM is created.
RO ins ha always run bool if true then the system will attempt to keep
the VM running as much as possible.
RO ins ha restart priority string has possible values: best-effort meaning
try to restart this VM if possible but dont
consider the Pool to be overcommitted if
this is not possible; restart meaning
this VM should be restarted; meaning
do not try to restart this VM

108
2.12. CLASS: VM CHAPTER 2. API REFERENCE

RO run is a snapshot bool true if this is a snapshot. Snapshotted VMs

can never be started, they are used only for
cloning other VMs
RO run snapshot of VM ref Ref pointing to the VM this snapshot is of.
RO run snapshots VM ref set List pointing to all the VM snapshots.
RO run snapshot time datetime Date/time when this snapshot was created.
RO run transportable snapshot id string Transportable ID of the snapshot VM
RO run blobs (string blob ref) map Binary blobs associated with this VM
RW tags string set user-specified tags for categorization pur-
poses
RW blocked operations (vm operations string) map List of operations which have been explic-
itly blocked and an error code
RO run snapshot info (string string) map Human-readable information concerning
this snapshot
RO run snapshot metadata string Encoded information about the VMs
metadata this is a snapshot of
RO run parent VM ref Ref pointing to the parent of this VM
RO run children VM ref set List pointing to all the children of this VM
RO run bios strings (string string) map BIOS strings
RO ins protection policy VMPP ref Ref pointing to a protection policy for this
VM
RO ins is snapshot from vmpp bool true if this snapshot was created by the
protection policy
RO ins appliance VM appliance ref the appliance to which this VM belongs
RO ins start delay int The delay to wait before proceeding to the
next order in the startup sequence (sec-
onds)
RO ins shutdown delay int The delay to wait before proceeding to the
next order in the shutdown sequence (sec-
onds)
RO ins order int The point in the startup or shutdown se-
quence at which this VM will be started
RO run VGPUs VGPU ref set Virtual GPUs
RO run attached PCIs PCI ref set Currently passed-through PCI devices
RW suspend SR SR ref The SR on which a suspend image is stored
RO ins version int The number of times this VM has been re-
covered
RO ins generation id string Generation ID of the VM
RW hardware platform version int The host virtual hardware platform version
the VM can run on
RO ins has vendor device bool When an HVM guest starts, this controls
the presence of the emulated C000 PCI
device which triggers Windows Update to
fetch or update PV drivers.

2.12.2 RPCs associated with class: VM

RPC name: snapshot
Overview:
Snapshots the specified VM, making a new VM. Snapshot automatically exploits the capabilities of the underlying

109
2.12. CLASS: VM CHAPTER 2. API REFERENCE

storage repository in which the VMs disk images are stored (e.g. Copy on Write).
Signature:
(VM ref) snapshot (session_id s, VM ref vm, string new_name)

Arguments:

type name description

VM ref vm The VM to be snapshotted
string new name The name of the snapshotted VM

Return Type: VM ref

The reference of the newly created VM.

Possible Error Codes: VM BAD POWER STATE, SR FULL, OPERATION NOT ALLOWED

RPC name: snapshot with quiesce

Overview:
Snapshots the specified VM with quiesce, making a new VM. Snapshot automatically exploits the capabilities
of the underlying storage repository in which the VMs disk images are stored (e.g. Copy on Write).
Signature:
(VM ref) snapshot_with_quiesce (session_id s, VM ref vm, string new_name)
Arguments:

type name description

VM ref vm The VM to be snapshotted
string new name The name of the snapshotted VM

Return Type: VM ref

The reference of the newly created VM.

Possible Error Codes: VM BAD POWER STATE, SR FULL, OPERATION NOT ALLOWED, VM SNAPSHOT WITH QUIESCE FAILED,
VM SNAPSHOT WITH QUIESCE TIMEOUT, VM SNAPSHOT WITH QUIESCE PLUGIN DEOS NOT RESPOND, VM SNAPSHOT WITH QUIESCE NOT

RPC name: clone

Overview:
Clones the specified VM, making a new VM. Clone automatically exploits the capabilities of the underlying
storage repository in which the VMs disk images are stored (e.g. Copy on Write). This function can only be
called when the VM is in the Halted State.
Signature:
(VM ref) clone (session_id s, VM ref vm, string new_name)
Arguments:

type name description

VM ref vm The VM to be cloned
string new name The name of the cloned VM

110
2.12. CLASS: VM CHAPTER 2. API REFERENCE

Return Type: VM ref

The reference of the newly created VM.

Possible Error Codes: VM BAD POWER STATE, SR FULL, OPERATION NOT ALLOWED, LICENCE RESTRICTION

RPC name: copy

Overview:
Copied the specified VM, making a new VM. Unlike clone, copy does not exploits the capabilities of the un-
derlying storage repository in which the VMs disk images are stored. Instead, copy guarantees that the disk
images of the newly created VM will be full disks - i.e. not part of a CoW chain. This function can only be
called when the VM is in the Halted State.
Signature:
(VM ref) copy (session_id s, VM ref vm, string new_name, SR ref sr)
Arguments:

type name description

VM ref vm The VM to be copied
string new name The name of the copied VM
SR ref sr An SR to copy all the VMs disks into (if an
invalid reference then it uses the existing SRs)

Return Type: VM ref

The reference of the newly created VM.

Possible Error Codes: VM BAD POWER STATE, SR FULL, OPERATION NOT ALLOWED, LICENCE RESTRICTION

RPC name: revert

Overview:
Reverts the specified VM to a previous state.
Signature:
void revert (session_id s, VM ref snapshot)
Arguments:

type name description

VM ref snapshot The snapshotted state that we revert to

Return Type: void

Possible Error Codes: VM BAD POWER STATE, OPERATION NOT ALLOWED, SR FULL, VM REVERT FAILED

RPC name: checkpoint

RPC name: start on

Overview:
Start the specified VM on a particular host. This function can only be called with the VM is in the Halted
State.
Signature:
void start_on (session_id s, VM ref vm, host ref host, bool start_paused, bool force)
Arguments:

type name description

VM ref vm The VM to start
host ref host The Host on which to start the VM
bool start paused Instantiate VM in paused state if set to true.
bool force Attempt to force the VM to start. If this flag
is false then the VM may fail pre-boot safety
checks (e.g. if the CPU the VM last booted
on looks substantially different to the current
one)

Return Type: void

Possible Error Codes: VM BAD POWER STATE, VM IS TEMPLATE, OTHER OPERATION IN PROGRESS, OPERATION NOT ALLOWED,
BOOTLOADER FAILED, UNKNOWN BOOTLOADER

RPC name: pause

Overview:
Pause the specified VM. This can only be called when the specified VM is in the Running state.
Signature:
void pause (session_id s, VM ref vm)
Arguments:

type name description

void shutdown (session_id s, VM ref vm)

Arguments:

type name description

Possible Error Codes: VM BAD POWER STATE, OPERATION NOT ALLOWED, VM IS TEMPLATE

RPC name: pool migrate

Overview:
Migrate a VM to another Host.
Signature:
void pool_migrate (session_id s, VM ref vm, host ref host, (string -> string) map options)
Arguments:

117
2.12. CLASS: VM CHAPTER 2. API REFERENCE

type name description

VM ref vm The VM to migrate
host ref host The target host
(string string) map options Extra configuration operations

Return Type: void

Possible Error Codes: VM BAD POWER STATE, OTHER OPERATION IN PROGRESS, VM IS TEMPLATE, OPERATION NOT ALLOWED,
VM MIGRATE FAILED

VM ref self The VM
string value The value

Return Type: void

RPC name: set ha always run

Overview: This message is deprecated Set the value of the ha always run.
Signature:
void set_ha_always_run (session_id s, VM ref self, bool value)
Arguments:

type name description

VM ref self The VM
bool value The value

Return Type: void

RPC name: compute memory overhead

Overview:
Computes the virtualization memory overhead of a VM.
Signature:
int compute_memory_overhead (session_id s, VM ref vm)
Arguments:

type name description

VM ref vm The VM for which to compute the memory
overhead

Return Type: int

the virtualization memory overhead of the VM.

RPC name: set memory dynamic max

Overview:
Set the value of the memory dynamic max field.
Signature:
void set_memory_dynamic_max (session_id s, VM ref self, int value)

RPC name: set memory static max

Overview:
Set the value of the memory static max field.
Signature:
void set_memory_static_max (session_id s, VM ref self, int value)

120
2.12. CLASS: VM CHAPTER 2. API REFERENCE

Arguments:

type name description

VM ref self The VM to modify
int value The new value of memory static max

Return Type: void

Possible Error Codes: HA OPERATION WOULD BREAK FAILOVER PLAN

RPC name: set memory static min

Overview:
Set the value of the memory static min field.
Signature:
void set_memory_static_min (session_id s, VM ref self, int value)
Arguments:

type name description

VM ref self The VM to modify
int value The new value of memory static min

Return Type: void

RPC name: set memory static range

Overview:
Set the static (ie boot-time) range of virtual memory that the VM is allowed to use.
Signature:
void set_memory_static_range (session_id s, VM ref self, int min, int max)
Arguments:

type name description

VM ref self The VM
int min The new minimum value
int max The new maximum value

Return Type: void

RPC name: set memory limits

Overview:
Set the memory limits of this VM.
Signature:
void set_memory_limits (session_id s, VM ref self, int static_min, int static_max, int dynamic_min, int dy

121
2.12. CLASS: VM CHAPTER 2. API REFERENCE

Arguments:

type name description

VM ref self The VM
int static min The new value of memory static min.
int static max The new value of memory static max.
int dynamic min The new value of memory dynamic min.
int dynamic max The new value of memory dynamic max.

Return Type: void

RPC name: set memory target live

Overview: This message is deprecated Set the memory target for a running VM.
Signature:
void set_memory_target_live (session_id s, VM ref self, int target)
Arguments:

type name description

VM ref self The VM
int target The target in bytes

Return Type: void

RPC name: wait memory target live

Overview: This message is deprecated Wait for a running VM to reach its current memory target.
Signature:

void wait_memory_target_live (session_id s, VM ref self)

Arguments:

type name description

VM ref self The VM

Return Type: void

RPC name: get cooperative

Overview: This message is deprecated Return true if the VM is currently co-operative i.e. is expected to
reach a balloon target and actually has done.
Signature:
bool get_cooperative (session_id s, VM ref self)

122
2.12. CLASS: VM CHAPTER 2. API REFERENCE

Arguments:

type name description

VM ref self The VM

Return Type: bool

true if the VM is currently co-operative; false otherwise

VM ref self The VM
int value The new maximum number of VCPUs

Return Type: void

RPC name: set VCPUs at startup

Overview:
Set the number of startup VCPUs for a halted VM.
Signature:
void set_VCPUs_at_startup (session_id s, VM ref self, int value)
Arguments:

type name description

VM ref self The VM
int value The new maximum number of VCPUs

Return Type: void

RPC name: send sysrq

Overview:
Send the given key as a sysrq to this VM. The key is specified as a single character (a String of length 1). This
can only be called when the specified VM is in the Running state.
Signature:
void send_sysrq (session_id s, VM ref vm, string key)
Arguments:

type name description

VM ref vm The VM
string key The key to send

Return Type: void

Possible Error Codes: VM BAD POWER STATE

RPC name: send trigger

Overview:
Send the named trigger to this VM. This can only be called when the specified VM is in the Running state.
Signature:
void send_trigger (session_id s, VM ref vm, string trigger)

124
2.12. CLASS: VM CHAPTER 2. API REFERENCE

Possible Error Codes: VM BAD POWER STATE, LICENCE RESTRICTION

RPC name: assert can migrate

Overview:
Assert whether a VM can be migrated to the specified destination.
Signature:
void assert_can_migrate (session_id s, VM ref vm, (string -> string) map dest, bool live, (VDI ref -> SR r
Arguments:

type name description

VM ref vm The VM
(string string) map dest The result of a VM.migrate receive call.
bool live Live migration
(VDI ref SR ref) map vdi map Map of source VDI to destination SR
(VIF ref network ref) map vif map Map of source VIF to destination network
(string string) map options Other parameters

Return Type: void

Possible Error Codes: LICENCE RESTRICTION

Return Type: void

RPC name: query data source

Overview:
Query the latest value of the specified data source.
Signature:
float query_data_source (session_id s, VM ref self, string data_source)
Arguments:

type name description

VM ref self The VM
string data source The data source to query

Return Type: float

The latest value, averaged over the last 5 seconds

RPC name: forget data source archives

Overview:
Forget the recorded statistics related to the specified data source.
Signature:
void forget_data_source_archives (session_id s, VM ref self, string data_source)

Return Type: void

RPC name: set protection policy

Overview:
Set the value of the protection policy field.
Signature:

void set_protection_policy (session_id s, VM ref self, VMPP ref value)

Arguments:

type name description

VM ref self The VM
VMPP ref value The value

Return Type: void

131
2.12. CLASS: VM CHAPTER 2. API REFERENCE

RPC name: set start delay

Overview:
Set this VMs start delay in seconds.
Signature:
void set_start_delay (session_id s, VM ref self, int value)
Arguments:

type name description

VM ref self The VM
int value This VMs start delay in seconds

Return Type: void

RPC name: set shutdown delay

Overview:
Set this VMs shutdown delay in seconds.
Signature:
void set_shutdown_delay (session_id s, VM ref self, int value)
Arguments:

type name description

VM ref self The VM
int value This VMs shutdown delay in seconds

Return Type: void

RPC name: set order

Overview:
Set this VMs boot order.
Signature:

void set_order (session_id s, VM ref self, int value)

Arguments:

type name description

VM ref self The VM
int value This VMs boot order

Return Type: void

132
2.12. CLASS: VM CHAPTER 2. API REFERENCE

RPC name: set suspend VDI

Overview:
Set this VMs suspend VDI, which must be indentical to its current one.
Signature:
void set_suspend_VDI (session_id s, VM ref self, VDI ref value)
Arguments:

type name description

VM ref self The VM
VDI ref value The suspend VDI uuid

Return Type: void

RPC name: assert can be recovered

Overview:
Assert whether all SRs required to recover this VM are available.
Signature:
void assert_can_be_recovered (session_id s, VM ref self, session ref session_to)
Arguments:

type name description

VM ref self The VM to recover
session ref session to The session to which the VM is to be recov-
ered.

Return Type: void

Possible Error Codes: VM IS PART OF AN APPLIANCE, VM REQUIRES SR

RPC name: get SRs required for recovery

Overview:
List all the SRs that are required for the VM to be recovered.
Signature:
(SR ref set) get_SRs_required_for_recovery (session_id s, VM ref self, session ref session_to)
Arguments:

type name description

VM ref self The VM for which the SRs have to be recov-
ered
session ref session to The session to which the SRs of the VM have
to be recovered.

Return Type: SR ref set

133
2.12. CLASS: VM CHAPTER 2. API REFERENCE

refs for SRs required to recover the VM

RPC name: recover

Overview:
Recover the VM.
Signature:
void recover (session_id s, VM ref self, session ref session_to, bool force)
Arguments:

type name description

VM ref self The VM to recover
session ref session to The session to which the VM is to be recov-
ered.
bool force Whether the VM should replace newer ver-
sions of itself.

Return Type: void

RPC name: import convert

Overview:
Import using a conversion service.
Signature:

void import_convert (session_id s, string type, string username, string password, SR ref sr, (string -> st
Arguments:

type name description

string type Type of the conversion
string username Admin username on the host
string password Password on the host
SR ref sr The destination SR
(string string) map remote config Remote configuration options

Return Type: void

RPC name: set appliance

Overview:
Assign this VM to an appliance.
Signature:
void set_appliance (session_id s, VM ref self, VM_appliance ref value)

134
2.12. CLASS: VM CHAPTER 2. API REFERENCE

Arguments:

type name description

VM ref self The VM to assign to an appliance.
VM appliance ref value The appliance to which this VM should be as-
signed.

Return Type: void

RPC name: query services

Overview:
Query the system services advertised by this VM and register them. This can only be applied to a system
domain.
Signature:
((string -> string) map) query_services (session_id s, VM ref self)
Arguments:

type name description

VM ref self The VM

Return Type: (string string) map

map of service type to name

RPC name: call plugin

Return Type: VM ref set

Imported VM reference

RPC name: get all

Overview:
Return a list of all the VMs known to the system.
Signature:
(VM ref set) get_all (session_id s)

Return Type: VM ref set

references to all objects

136
2.12. CLASS: VM CHAPTER 2. API REFERENCE

RPC name: get all records

Overview:
Return a map of VM references to VM records for all VMs known to the system.
Signature:
((VM ref -> VM record) map) get_all_records (session_id s)

Return Type: (VM ref VM record) map

records of all objects

RPC name: get uuid

Overview:
Get the uuid field of the given VM.
Signature:
string get_uuid (session_id s, VM ref self)
Arguments:

type name description

VM ref self reference to the object

Return Type: string

value of the field

RPC name: get allowed operations

Overview:
Get the allowed operations field of the given VM.
Signature:
(vm_operations set) get_allowed_operations (session_id s, VM ref self)
Arguments:

type name description

VM ref self reference to the object

Return Type: vm operations set

value of the field

RPC name: get current operations

Return Type: string

value of the field

RPC name: set name label

Overview:
Set the name/label field of the given VM.
Signature:
void set_name_label (session_id s, VM ref self, string value)

138
2.12. CLASS: VM CHAPTER 2. API REFERENCE

Arguments:

type name description

VM ref self reference to the object
string value New value to set

Return Type: void

Return Type: void

RPC name: set actions after shutdown

Overview:
Set the actions/after shutdown field of the given VM.
Signature:
void set_actions_after_shutdown (session_id s, VM ref self, on_normal_exit value)

146
2.12. CLASS: VM CHAPTER 2. API REFERENCE

Arguments:

type name description

VM ref self reference to the object
on normal exit value New value to set

Return Type: void

RPC name: get actions after reboot

Overview:
Get the actions/after reboot field of the given VM.
Signature:
(on_normal_exit) get_actions_after_reboot (session_id s, VM ref self)
Arguments:

type name description

VM ref self reference to the object

Return Type: on normal exit

value of the field

RPC name: set actions after reboot

Overview:
Set the actions/after reboot field of the given VM.
Signature:
void set_actions_after_reboot (session_id s, VM ref self, on_normal_exit value)
Arguments:

type name description

VM ref self reference to the object
on normal exit value New value to set

Return Type: void

RPC name: get actions after crash

Overview:
Get the actions/after crash field of the given VM.
Signature:
(on_crash_behaviour) get_actions_after_crash (session_id s, VM ref self)

147
2.12. CLASS: VM CHAPTER 2. API REFERENCE

Arguments:

type name description

VM ref self reference to the object

Return Type: on crash behaviour

value of the field

RPC name: set actions after crash

Overview:
Set the actions/after crash field of the given VM.
Signature:
void set_actions_after_crash (session_id s, VM ref self, on_crash_behaviour value)
Arguments:

type name description

VM ref self reference to the object
on crash behaviour value New value to set

Return Type: void

type name description

VM ref self reference to the object
string value New value to set

Return Type: void

RPC name: get PV kernel

Overview:
Get the PV/kernel field of the given VM.
Signature:
string get_PV_kernel (session_id s, VM ref self)

150
2.12. CLASS: VM CHAPTER 2. API REFERENCE

Arguments:

type name description

VM ref self reference to the object

Return Type: string

value of the field

RPC name: set PV kernel

Overview:
Set the PV/kernel field of the given VM.
Signature:
void set_PV_kernel (session_id s, VM ref self, string value)
Arguments:

type name description

VM ref self reference to the object
string value New value to set

Return Type: void

RPC name: get PV ramdisk

Overview:
Get the PV/ramdisk field of the given VM.
Signature:
string get_PV_ramdisk (session_id s, VM ref self)
Arguments:

type name description

VM ref self reference to the object

Return Type: string

value of the field

RPC name: set PV ramdisk

Overview:
Set the PV/ramdisk field of the given VM.
Signature:
void set_PV_ramdisk (session_id s, VM ref self, string value)

151
2.12. CLASS: VM CHAPTER 2. API REFERENCE

Arguments:

type name description

VM ref self reference to the object
string value New value to set

Return Type: void

type name description

VM ref self reference to the object

Return Type: string

value of the field

RPC name: set HVM boot policy

Overview:
Set the HVM/boot policy field of the given VM.
Signature:
void set_HVM_boot_policy (session_id s, VM ref self, string value)
Arguments:

type name description

VM ref self reference to the object
string value New value to set

Return Type: void

RPC name: get HVM boot params

Overview:
Get the HVM/boot params field of the given VM.
Signature:
((string -> string) map) get_HVM_boot_params (session_id s, VM ref self)

154
2.12. CLASS: VM CHAPTER 2. API REFERENCE

Arguments:

type name description

VM ref self reference to the object

Return Type: (string string) map

value of the field

VM ref self reference to the object
string key Key to remove

Return Type: void

VM ref self reference to the object
string key Key to remove

Return Type: void

RPC name: get PCI bus

Overview: This message is deprecated Get the PCI bus field of the given VM.
Signature:
string get_PCI_bus (session_id s, VM ref self)

157
2.12. CLASS: VM CHAPTER 2. API REFERENCE

Arguments:

type name description

VM ref self reference to the object

Return Type: string

value of the field

RPC name: set PCI bus

Overview: This message is deprecated Set the PCI bus field of the given VM.
Signature:
void set_PCI_bus (session_id s, VM ref self, string value)
Arguments:

type name description

VM ref self reference to the object
string value New value to set

Return Type: void

RPC name: get other config

Overview:
Get the other config field of the given VM.
Signature:
((string -> string) map) get_other_config (session_id s, VM ref self)
Arguments:

type name description

VM ref self reference to the object

Return Type: (string string) map

value of the field

RPC name: set other config

Overview:
Set the other config field of the given VM.
Signature:
void set_other_config (session_id s, VM ref self, (string -> string) map value)

RPC name: get xenstore data

Overview:
Get the xenstore data field of the given VM.
Signature:
((string -> string) map) get_xenstore_data (session_id s, VM ref self)

162
2.12. CLASS: VM CHAPTER 2. API REFERENCE

Arguments:

type name description

VM ref self reference to the object

Return Type: (string string) map

value of the field

VM ref self reference to the object
string key Key to remove

Return Type: void

Return Type: void

RPC name: add tags

Overview:
Add the given value to the tags field of the given VM. If the value is already in that Set, then do nothing.
Signature:
void add_tags (session_id s, VM ref self, string value)
Arguments:

type name description

VM ref self reference to the object
string value New value to add

Return Type: void

RPC name: remove tags

Overview:
Remove the given value from the tags field of the given VM. If the value is not in that Set, then do nothing.
Signature:
void remove_tags (session_id s, VM ref self, string value)

167
2.12. CLASS: VM CHAPTER 2. API REFERENCE

Arguments:

type name description

VM ref self reference to the object
string value Value to remove

Return Type: void

RPC name: get blocked operations

Overview:
Get the blocked operations field of the given VM.
Signature:
((vm_operations -> string) map) get_blocked_operations (session_id s, VM ref self)
Arguments:

type name description

VM ref self reference to the object

Return Type: (vm operations string) map

value of the field

RPC name: set blocked operations

Overview:
Set the blocked operations field of the given VM.
Signature:
void set_blocked_operations (session_id s, VM ref self, (vm_operations -> string) map value)
Arguments:

type name description

VM ref self reference to the object
(vm operations string) map value New value to set

Return Type: void

RPC name: add to blocked operations

Overview:
Add the given key-value pair to the blocked operations field of the given VM.
Signature:
void add_to_blocked_operations (session_id s, VM ref self, vm_operations key, string value)

168
2.12. CLASS: VM CHAPTER 2. API REFERENCE

Arguments:

type name description

VM ref self reference to the object
vm operations key Key to add
string value Value to add

Return Type: void

RPC name: remove from blocked operations

Overview:
Remove the given key and its corresponding value from the blocked operations field of the given VM. If the key
is not in that Map, then do nothing.
Signature:
void remove_from_blocked_operations (session_id s, VM ref self, vm_operations key)
Arguments:

type name description

VM ref self reference to the object
vm operations key Key to remove

Return Type: void

VM ref self reference to the object

Return Type: int

172
2.12. CLASS: VM CHAPTER 2. API REFERENCE

Return Type: int

value of the field

RPC name: get generation id

Overview:
Get the generation id field of the given VM.
Signature:
string get_generation_id (session_id s, VM ref self)
Arguments:

type name description

VM ref self reference to the object

Return Type: string

value of the field

174
2.12. CLASS: VM CHAPTER 2. API REFERENCE

RPC name: get hardware platform version

Overview:
Get the hardware platform version field of the given VM.
Signature:
int get_hardware_platform_version (session_id s, VM ref self)
Arguments:

type name description

VM ref self reference to the object

Return Type: int

value of the field

RPC name: get by name label

Overview:
Get all the VM instances with the given label.
Signature:
(VM ref set) get_by_name_label (session_id s, string label)
Arguments:

type name description

string label label of object to return

Return Type: VM ref set

references to objects with matching names

177
2.13. CLASS: VM METRICS CHAPTER 2. API REFERENCE

2.13 Class: VM metrics

2.13.1 Fields for class: VM metrics

Name VM metrics
Description The metrics associated with a VM.
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO run memory actual int Guests actual memory (bytes)
RO run VCPUs number int Current number of VCPUs
RO run VCPUs utilisation (int float) map Utilisation for all of guests current VCPUs
RO run VCPUs CPU (int int) map VCPU to PCPU map
RO run VCPUs params (string string) map The live equivalent to VM.VCPUs params
RO run VCPUs flags (int string set) map CPU flags (blocked,online,running)
RO run state string set The state of the guest, eg blocked, dying
etc
RO run start time datetime Time at which this VM was last booted
RO run install time datetime Time at which the VM was installed
RO run last updated datetime Time at which this information was last
updated
RW other config (string string) map additional configuration

2.13.2 RPCs associated with class: VM metrics

RPC name: get all
Overview:
Return a list of all the VM metrics instances known to the system.
Signature:
(VM_metrics ref set) get_all (session_id s)

Return Type: VM metrics ref set

references to all objects

RPC name: get all records

Overview:
Return a map of VM metrics references to VM metrics records for all VM metrics instances known to the system.
Signature:

((VM_metrics ref -> VM_metrics record) map) get_all_records (session_id s)

Return Type: (VM metrics ref VM metrics record) map

Return Type: int

Return Type: (string string) map

Return Type: datetime

Return Type: void

183
2.13. CLASS: VM METRICS CHAPTER 2. API REFERENCE

RPC name: get by uuid

Overview:
Get a reference to the VM metrics instance with the specified UUID.
Signature:
(VM_metrics ref) get_by_uuid (session_id s, string uuid)
Arguments:

type name description

string uuid UUID of object to return

Return Type: VM metrics ref

reference to the object

RPC name: get record

Overview:
Get a record containing the current state of the given VM metrics.
Signature:
(VM_metrics record) get_record (session_id s, VM_metrics ref self)
Arguments:

type name description

VM metrics ref self reference to the object

Return Type: VM metrics record

all fields from the object

184
2.14. CLASS: VM GUEST METRICS CHAPTER 2. API REFERENCE

2.14 Class: VM guest metrics

2.14.1 Fields for class: VM guest metrics

Name VM guest metrics

Description The metrics reported by the
guest (as opposed to inferred from outside).
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO run os version (string string) map version of the OS
RO run PV drivers version (string string) map version of the PV drivers
RO run PV drivers up to date bool Logical AND of network paths optimized
and storage paths optimized
RO run network paths optimized bool True if the network paths are optimized
with PV driver
RO run storage paths optimized bool True if the storage paths are optimized
with PV driver
RO run memory (string string) map This field exists but has no data. Use the
memory and memory internal free RRD
data-sources instead.
RO run disks (string string) map This field exists but has no data.
RO run networks (string string) map network configuration
RO run other (string string) map anything else
RO run last updated datetime Time at which this information was last
updated
RW other config (string string) map additional configuration
RO run live bool True if the guest is sending heartbeat mes-
sages via the guest agent
RO run can use hotplug vbd tristate type The guests statement of whether it sup-
ports VBD hotplug, i.e. whether it is ca-
pable of responding immediately to instan-
tiation of a new VBD by bringing online a
new PV block device. If the guest states
that it is not capable, then the VBD plug
and unplug operations will not be allowed
while the guest is running.
RO run can use hotplug vif tristate type The guests statement of whether it sup-
ports VIF hotplug, i.e. whether it is capa-
ble of responding immediately to instan-
tiation of a new VIF by bringing online a
new PV network device. If the guest states
that it is not capable, then the VIF plug
and unplug operations will not be allowed
while the guest is running.

2.14.2 RPCs associated with class: VM guest metrics

RPC name: get all
Overview:
Return a list of all the VM guest metrics instances known to the system.
Signature:

185
2.14. CLASS: VM GUEST METRICS CHAPTER 2. API REFERENCE

(VM_guest_metrics ref set) get_all (session_id s)

Return Type: VM guest metrics ref set

references to all objects

RPC name: get all records

Overview:
Return a map of VM guest metrics references to VM guest metrics records for all VM guest metrics instances
known to the system.
Signature:
((VM_guest_metrics ref -> VM_guest_metrics record) map) get_all_records (session_id s)

Return Type: (VM guest metrics ref VM guest metrics record) map
records of all objects

RPC name: get uuid

Overview:
Get the uuid field of the given VM guest metrics.
Signature:
string get_uuid (session_id s, VM_guest_metrics ref self)
Arguments:

type name description

VM guest metrics ref self reference to the object

Return Type: string

value of the field

RPC name: get os version

Overview:
Get the os version field of the given VM guest metrics.
Signature:
((string -> string) map) get_os_version (session_id s, VM_guest_metrics ref self)
Arguments:

type name description

VM guest metrics ref self reference to the object

Return Type: (string string) map

186
2.14. CLASS: VM GUEST METRICS CHAPTER 2. API REFERENCE

Return Type: (string string) map

type name description

VM guest metrics ref self reference to the object

Return Type: tristate type

Return Type: VM guest metrics record

all fields from the object

192
2.15. CLASS: VMPP CHAPTER 2. API REFERENCE

2.15 Class: VMPP

2.15.1 Fields for class: VMPP

Name VMPP
Description VM Protection Policy.
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 containing human-readable
description
RW is policy enabled bool enable or disable this policy
RW backup type vmpp backup type type of the backup sub-policy
RO ins backup retention value int maximum number of backups that should
be stored at any time
RO ins backup frequency vmpp backup frequency frequency of the backup schedule
RO ins backup schedule (string string) map schedule of the backup containing hour,
min, days. Date/time-related informa-
tion is in Local Timezone
RO run is backup running bool true if this protection policys backup is
running
RO run backup last run time datetime time of the last backup
RO ins archive target type vmpp archive target type type of the archive target config
RO ins archive target config (string string) map configuration for the archive, including its
location, username, password
RO ins archive frequency vmpp archive frequency frequency of the archive schedule
RO ins archive schedule (string string) map schedule of the archive containing hour,
min, days. Date/time-related informa-
tion is in Local Timezone
RO run is archive running bool true if this protection policys archive is
running
RO run archive last run time datetime time of the last archive
RO run VMs VM ref set all VMs attached to this protection policy
RO ins is alarm enabled bool true if alarm is enabled for this policy
RO ins alarm config (string string) map configuration for the alarm
RO run recent alerts string set recent alerts

2.15.2 RPCs associated with class: VMPP

RPC name: protect now
Overview:
This call executes the protection policy immediately.
Signature:
string protect_now (session_id s, VMPP ref vmpp)
Arguments:

type name description

VMPP ref vmpp The protection policy to execute

Return Type: string

type name description

VMPP ref self The protection policy
vmpp archive frequency value the archive frequency

Return Type: void

195
2.15. CLASS: VMPP CHAPTER 2. API REFERENCE

RPC name: set archive schedule

Overview:
.
Signature:
void set_archive_schedule (session_id s, VMPP ref self, (string -> string) map value)
Arguments:

type name description

VMPP ref self The protection policy
(string string) map value the value to set

RPC name: set alarm config

Overview:
.
Signature:
void set_alarm_config (session_id s, VMPP ref self, (string -> string) map value)
Arguments:

type name description

VMPP ref self The protection policy
(string string) map value the value to set

Return Type: void

RPC name: add to backup schedule

Overview:
.
Signature:

void add_to_backup_schedule (session_id s, VMPP ref self, string key, string value)
Arguments:

type name description

VMPP ref self The protection policy
string key the key to add
string value the value to add

Return Type: void

Return Type: void

198
2.15. CLASS: VMPP CHAPTER 2. API REFERENCE

RPC name: remove from backup schedule

Overview:
.
Signature:
void remove_from_backup_schedule (session_id s, VMPP ref self, string key)
Arguments:

type name description

VMPP ref self The protection policy
string key the key to remove

Return Type: void

RPC name: remove from archive target config

Overview:
.
Signature:
void remove_from_archive_target_config (session_id s, VMPP ref self, string key)
Arguments:

type name description

VMPP ref self The protection policy
string key the key to remove

Return Type: void

RPC name: remove from archive schedule

Overview:
.
Signature:

void remove_from_archive_schedule (session_id s, VMPP ref self, string key)

Arguments:

type name description

VMPP ref self The protection policy
string key the key to remove

Return Type: void

199
2.15. CLASS: VMPP CHAPTER 2. API REFERENCE

RPC name: remove from alarm config

Overview:
.
Signature:
void remove_from_alarm_config (session_id s, VMPP ref self, string key)
Arguments:

type name description

VMPP ref self The protection policy
string key the key to remove

Return Type: void

RPC name: set backup last run time

Overview:
.
Signature:
void set_backup_last_run_time (session_id s, VMPP ref self, datetime value)
Arguments:

type name description

VMPP ref self The protection policy
datetime value the value to set

Return Type: void

RPC name: set name label

Overview:
Set the name/label field of the given VMPP.
Signature:
void set_name_label (session_id s, VMPP ref self, string value)
Arguments:

type name description

VMPP ref self reference to the object
string value New value to set

Return Type: void

RPC name: get name description

Overview:
Get the name/description field of the given VMPP.
Signature:
string get_name_description (session_id s, VMPP ref self)
Arguments:

type name description

VMPP ref self reference to the object

Return Type: string

value of the field

RPC name: set name description

Overview:
Set the name/description field of the given VMPP.
Signature:
void set_name_description (session_id s, VMPP ref self, string value)

202
2.15. CLASS: VMPP CHAPTER 2. API REFERENCE

Arguments:

type name description

VMPP ref self reference to the object
string value New value to set

Return Type: void

RPC name: get is policy enabled

Overview:
Get the is policy enabled field of the given VMPP.
Signature:
bool get_is_policy_enabled (session_id s, VMPP ref self)
Arguments:

type name description

VMPP ref self reference to the object

Return Type: bool

value of the field

RPC name: set is policy enabled

Overview:
Set the is policy enabled field of the given VMPP.
Signature:
void set_is_policy_enabled (session_id s, VMPP ref self, bool value)
Arguments:

type name description

VMPP ref self reference to the object
bool value New value to set

Return Type: void

RPC name: get backup type

Overview:
Get the backup type field of the given VMPP.
Signature:
(vmpp_backup_type) get_backup_type (session_id s, VMPP ref self)

203
2.15. CLASS: VMPP CHAPTER 2. API REFERENCE

Arguments:

type name description

VMPP ref self reference to the object

Return Type: vmpp backup type

value of the field

RPC name: set backup type

Overview:
Set the backup type field of the given VMPP.
Signature:
void set_backup_type (session_id s, VMPP ref self, vmpp_backup_type value)
Arguments:

type name description

VMPP ref self reference to the object
vmpp backup type value New value to set

Return Type: void

Return Type: void

Return Type: VMPP ref set

references to objects with matching names

211
2.16. CLASS: VM APPLIANCE CHAPTER 2. API REFERENCE

2.16 Class: VM appliance

2.16.1 Fields for class: VM appliance

Name VM appliance
Description VM appliance.
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 containing human-readable
description
RO run allowed operations vm appliance operation 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 vm appliance operation) 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 VMs VM ref set all VMs in this appliance

2.16.2 RPCs associated with class: VM appliance

RPC name: start
Overview:
Start all VMs in the appliance.
Signature:
void start (session_id s, VM_appliance ref self, bool paused)
Arguments:

type name description

VM appliance ref self The VM appliance
bool paused Instantiate all VMs belonging to this appli-
ance in paused state if set to true.

Return Type: void

Return Type: void

Possible Error Codes: OPERATION PARTIALLY FAILED

RPC name: assert can be recovered

Overview:
Assert whether all SRs required to recover this VM appliance are available.
Signature:
void assert_can_be_recovered (session_id s, VM_appliance ref self, session ref session_to)

213
2.16. CLASS: VM APPLIANCE CHAPTER 2. API REFERENCE

RPC name: get all

Overview:
Return a list of all the VM appliances known to the system.
Signature:
(VM_appliance ref set) get_all (session_id s)

Return Type: VM appliance ref set

references to all objects

RPC name: get all records

Overview:
Return a map of VM appliance references to VM appliance records for all VM appliances known to the system.
Signature:
((VM_appliance ref -> VM_appliance record) map) get_all_records (session_id s)

Return Type: (VM appliance ref VM appliance record) map

records of all objects

RPC name: get uuid

Overview:
Get the uuid field of the given VM appliance.
Signature:
string get_uuid (session_id s, VM_appliance ref self)
Arguments:

type name description

VM appliance ref self reference to the object

Return Type: string

value of the field

RPC name: get name label

Overview:
Get the name/label field of the given VM appliance.
Signature:
string get_name_label (session_id s, VM_appliance ref self)

215
2.16. CLASS: VM APPLIANCE CHAPTER 2. API REFERENCE

Arguments:

type name description

VM appliance ref self reference to the object

Return Type: string

value of the field

RPC name: set name label

Overview:
Set the name/label field of the given VM appliance.
Signature:
void set_name_label (session_id s, VM_appliance ref self, string value)
Arguments:

type name description

VM appliance ref self reference to the object
string value New value to set

Return Type: void

RPC name: get name description

Overview:
Get the name/description field of the given VM appliance.
Signature:
string get_name_description (session_id s, VM_appliance ref self)
Arguments:

type name description

VM appliance ref self reference to the object

Return Type: string

value of the field

RPC name: set name description

Overview:
Set the name/description field of the given VM appliance.
Signature:
void set_name_description (session_id s, VM_appliance ref self, string value)

216
2.16. CLASS: VM APPLIANCE CHAPTER 2. API REFERENCE

Arguments:

type name description

VM appliance ref self reference to the object
string value New value to set

Return Type: void

Return Type: void

Return Type: VM appliance ref set

references to objects with matching names

219
2.17. CLASS: DR TASK CHAPTER 2. API REFERENCE

2.17 Class: DR task

2.17.1 Fields for class: DR task

Name DR task
Description DR task.
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO run introduced SRs SR ref set All SRs introduced by this appliance

2.17.2 RPCs associated with class: DR task

Return Type: string

value of the field

RPC name: get introduced SRs

Overview:
Get the introduced SRs field of the given DR task.
Signature:
(SR ref set) get_introduced_SRs (session_id s, DR_task ref self)

221
2.17. CLASS: DR TASK CHAPTER 2. API REFERENCE

Arguments:

type name description

DR task ref self reference to the object

Return Type: SR ref set

value of the field

RPC name: get by uuid

Overview:
Get a reference to the DR task instance with the specified UUID.
Signature:
(DR_task ref) get_by_uuid (session_id s, string uuid)
Arguments:

type name description

string uuid UUID of object to return

Return Type: DR task ref

reference to the object

RPC name: get record

Overview:
Get a record containing the current state of the given DR task.
Signature:
(DR_task record) get_record (session_id s, DR_task ref self)
Arguments:

type name description

DR task ref self reference to the object

Return Type: DR task record

all fields from the object

222
2.18. CLASS: HOST CHAPTER 2. API REFERENCE

2.18 Class: host

2.18.1 Fields for class: host

Name host
Description A physical host.
Quals Field Type Description
RO run uuid string Unique identifier/object re
RW name label string a human-readable name
RW name description string a notes field containing h
description
RO run memory overhead int Virtualization memory ove
RO run allowed operations host allowed operations set list of the operations allowe
This list is advisory only
state may have changed b
field is read by a client.
RO run current operations (string host allowed operations) map links each of the runnin
this object (by referenc
rent operation enum which
nature of the task.
RO run API version major int major version number
RO run API version minor int minor version number
RO run API version vendor string identification of vendor
RO run API version vendor implementation (string string) map details of vendor implemen
RO run enabled bool True if the host is currently
RO ins software version (string string) map version strings
RW other config (string string) map additional configuration
RO ins capabilities string set Xen capabilities
RO run cpu configuration (string string) map The CPU configuration
May contain keys such
sockets per node, cores
threads per core
RO run sched policy string Scheduler policy currently
host
RO run supported bootloaders string set a list of the bootloaders i
machine
RO run resident VMs VM ref set list of VMs currently reside
RW logging (string string) map logging configuration
RO run PIFs PIF ref set physical network interfaces
RW suspend image sr SR ref The SR in which VDIs for
are created
RW crash dump sr SR ref The SR in which VDIs for c
created
RO run crashdumps host crashdump ref set Set of host crash dumps
RO run patches host patch ref set Set of host patches
RO run PBDs PBD ref set physical blockdevices
RO run host CPUs host cpu ref set The physical CPUs on this
RO run cpu info (string string) map Details about the physical
host
RW hostname string The hostname of this host

223
2.18. CLASS: HOST CHAPTER 2. API REFERENCE

RW address string The address by which this h

tacted from any other host
RO run metrics host metrics ref metrics associated with thi
RO run license params (string string) map State of the current license
RO run ha statefiles string set The set of statefiles acces
host
RO run ha network peers string set The set of hosts visible v
from this host
RO run blobs (string blob ref) map Binary blobs associated wi
RW tags string set user-specified tags for cate
poses
RO run external auth type string type of external authenticat
figured; empty if none confi
RO run external auth service name string name of external authent
configured; empty if none c
RO run external auth configuration (string string) map configuration specific to ext
cation service
RO run edition string Product edition
RW license server (string string) map Contact information of the
RO run bios strings (string string) map BIOS strings
RO run power on mode string The power on mode
RO run power on config (string string) map The power on config
RO ins local cache sr SR ref The SR that is used as a lo
RO run chipset info (string string) map Information about chipset
RO run PCIs PCI ref set List of PCI devices in the h
RO run PGPUs PGPU ref set List of physical GPUs in th
RO run ssl legacy bool Allow SSLv3 protocol and
used by older XenServers.
both incoming and outgoi
When this is set to a diffe
host immediately restarts i
tening service; typically this
a second but existing conne
be broken. XenAPI login s
main valid.
RW guest VCPUs params (string string) map VCPUs params to apply
guests
RW display host display indicates whether the host
output its console to a phys
vice
RO run virtual hardware platform versions int set The set of versions of th
ware platform that the ho
its guests

2.18.2 RPCs associated with class: host

RPC name: disable
Overview:
Puts the host into a state in which no new VMs can be started. Currently active VMs on the host continue to
execute.

RPC name: reboot

Overview:
Reboot the host. (This function can only be called if there are no currently running VMs on the host and it is
disabled.).
Signature:
void reboot (session_id s, host ref host)

225
2.18. CLASS: HOST CHAPTER 2. API REFERENCE

Arguments:

type name description

host ref host The Host to reboot

Return Type: void

Return Type: void

RPC name: bugreport upload

Overview:
Run xen-bugtool yestoall and upload the output to support.
Signature:
void bugreport_upload (session_id s, host ref host, string url, (string -> string) map options)
Arguments:

type name description

host ref host The host on which to run xen-bugtool
string url The URL to upload to
(string string) map options Extra configuration operations

Return Type: void

RPC name: list methods

Overview:
List all supported methods.
Signature:
(string set) list_methods (session_id s)

227
2.18. CLASS: HOST CHAPTER 2. API REFERENCE

Return Type: string set

The name of every supported method.

RPC name: license apply

Overview:
Apply a new license to a host.
Signature:
void license_apply (session_id s, host ref host, string contents)
Arguments:

type name description

host ref host The host to upload the license to
string contents The contents of the license file, base64 en-
coded

Return Type: void

Possible Error Codes: LICENSE PROCESSING ERROR

RPC name: license add

Overview:
Apply a new license to a host.
Signature:
void license_add (session_id s, host ref host, string contents)
Arguments:

type name description

host ref host The host to upload the license to
string contents The contents of the license file, base64 en-
coded

Return Type: void

Possible Error Codes: LICENSE PROCESSING ERROR

RPC name: license remove

Overview:
Remove any license file from the specified host, and switch that host to the unlicensed edition.
Signature:
void license_remove (session_id s, host ref host)

Overview:
.
Signature:
(data_source record set) get_data_sources (session_id s, host ref host)
Arguments:

type name description

host ref host The host to interrogate

Return Type: data source record set

A set of data sources

host ref host The host
string data source The data source whose archives are to be for-
gotten

Return Type: void

RPC name: assert can evacuate

Overview:
Check this host can be evacuated.
Signature:
void assert_can_evacuate (session_id s, host ref host)
Arguments:

type name description

host ref host The host to evacuate

Return Type: void

Return Type: void

RPC name: management disable

Overview:
Disable the management network interface.
Signature:

void management_disable (session_id s)

Return Type: void

RPC name: get management interface

Return Type: void

234
2.18. CLASS: HOST CHAPTER 2. API REFERENCE

RPC name: shutdown agent

Overview:
Shuts the agent down after a 10 second pause. WARNING: this is a dangerous operation. Any operations in
progress will be aborted, and unrecoverable data loss may occur. The caller is responsible for ensuring that
there are no operations in progress when this method is called.
Signature:
void shutdown_agent (session_id s)

Return Type: void

RPC name: set hostname live

Overview:
Sets the host name to the specified string. Both the API and lower-level system hostname are changed imme-
diately.
Signature:
void set_hostname_live (session_id s, host ref host, string hostname)
Arguments:

type name description

host ref host The host whose host name to set
string hostname The new host name

Return Type: void

Possible Error Codes: HOST NAME INVALID

RPC name: compute free memory

Overview:
Computes the amount of free memory on the host.
Signature:
int compute_free_memory (session_id s, host ref host)
Arguments:

type name description

host ref host The host to send the request to

Return Type: int

the amount of free memory on the host.

235
2.18. CLASS: HOST CHAPTER 2. API REFERENCE

RPC name: compute memory overhead

Overview:
Computes the virtualization memory overhead of a host.
Signature:
int compute_memory_overhead (session_id s, host ref host)
Arguments:

type name description

host ref host The host for which to compute the memory
overhead

Return Type: int

the virtualization memory overhead of the host.

RPC name: sync data

Overview:
This causes the synchronisation of the non-database data (messages, RRDs and so on) stored on the master to
be synchronised with the host.
Signature:
void sync_data (session_id s, host ref host)
Arguments:

type name description

host ref host The host to whom the data should be sent

host ref host The host whose clock should be queried

237
2.18. CLASS: HOST CHAPTER 2. API REFERENCE

Return Type: datetime

The current time

RPC name: get server localtime

Overview:
This call queries the hosts clock for the current time in the hosts local timezone.
Signature:
datetime get_server_localtime (session_id s, host ref host)
Arguments:

type name description

host ref host The host whose clock should be queried

Return Type: datetime

The current local time

RPC name: enable external auth

Overview:
This call enables external authentication on a host.
Signature:
void enable_external_auth (session_id s, host ref host, (string -> string) map config, string service_name
Arguments:

type name description

host ref host The host whose external authentication
should be enabled
(string string) map config A list of key-values containing the configura-
tion data
string service name The name of the service
string auth type The type of authentication (e.g. AD for Active
Directory)

Return Type: void

RPC name: disable external auth

Overview:
This call disables external authentication on the local host.
Signature:
void disable_external_auth (session_id s, host ref host, (string -> string) map config)

238
2.18. CLASS: HOST CHAPTER 2. API REFERENCE

Arguments:

type name description

host ref host The host whose external authentication
should be disabled
(string string) map config Optional parameters as a list of key-values
containing the configuration data

Return Type: void

Return Type: void

241
2.18. CLASS: HOST CHAPTER 2. API REFERENCE

RPC name: disable local storage caching

Overview:
Disable the use of a local SR for caching purposes.
Signature:
void disable_local_storage_caching (session_id s, host ref host)
Arguments:

type name description

host ref host The host

Overview:
Get the uuid field of the given host.
Signature:
string get_uuid (session_id s, host ref self)
Arguments:

type name description

host ref self reference to the object

Return Type: string

value of the field

RPC name: get name label

Overview:
Get the name/label field of the given host.
Signature:
string get_name_label (session_id s, host ref self)

244
2.18. CLASS: HOST CHAPTER 2. API REFERENCE

Arguments:

type name description

host ref self reference to the object

Return Type: string

value of the field

RPC name: set name label

Overview:
Set the name/label field of the given host.
Signature:
void set_name_label (session_id s, host ref self, string value)
Arguments:

type name description

host ref self reference to the object
string value New value to set

Return Type: void

RPC name: get name description

Overview:
Get the name/description field of the given host.
Signature:
string get_name_description (session_id s, host ref self)
Arguments:

type name description

host ref self reference to the object

Return Type: string

value of the field

RPC name: set name description

Overview:
Set the name/description field of the given host.
Signature:
void set_name_description (session_id s, host ref self, string value)

245
2.18. CLASS: HOST CHAPTER 2. API REFERENCE

Arguments:

type name description

host ref self reference to the object
string value New value to set

Return Type: void

Overview:
Add the given key-value pair to the other config field of the given host.
Signature:
void add_to_other_config (session_id s, host ref self, string key, string value)

249
2.18. CLASS: HOST CHAPTER 2. API REFERENCE

Arguments:

type name description

host ref self reference to the object
string key Key to add
string value Value to add

Return Type: void

RPC name: remove from other config

Overview:
Remove the given key and its corresponding value from the other config field of the given host. If the key is not
in that Map, then do nothing.
Signature:
void remove_from_other_config (session_id s, host ref self, string key)
Arguments:

type name description

host ref self reference to the object
string key Key to remove

Return Type: void

type name description

host ref self reference to the object
(string string) map value New value to set

Return Type: void

RPC name: add to logging

Overview:
Add the given key-value pair to the logging field of the given host.
Signature:
void add_to_logging (session_id s, host ref self, string key, string value)

value of the field

RPC name: get suspend image sr

Overview:
Get the suspend image sr field of the given host.
Signature:
(SR ref) get_suspend_image_sr (session_id s, host ref self)

253
2.18. CLASS: HOST CHAPTER 2. API REFERENCE

Arguments:

type name description

host ref self reference to the object

Return Type: SR ref

value of the field

RPC name: set suspend image sr

Overview:
Set the suspend image sr field of the given host.
Signature:
void set_suspend_image_sr (session_id s, host ref self, SR ref value)
Arguments:

type name description

host ref self reference to the object
SR ref value New value to set

Return Type: void

RPC name: get crash dump sr

Overview:
Get the crash dump sr field of the given host.
Signature:
(SR ref) get_crash_dump_sr (session_id s, host ref self)
Arguments:

type name description

host ref self reference to the object

Return Type: SR ref

value of the field

RPC name: set crash dump sr

Overview:
Set the crash dump sr field of the given host.
Signature:
void set_crash_dump_sr (session_id s, host ref self, SR ref value)

254
2.18. CLASS: HOST CHAPTER 2. API REFERENCE

Arguments:

type name description

host ref self reference to the object
SR ref value New value to set

Return Type: void

type name description

host ref self reference to the object
string value New value to set

Return Type: void

RPC name: get address

Overview:
Get the address field of the given host.
Signature:
string get_address (session_id s, host ref self)
Arguments:

type name description

host ref self reference to the object

Return Type: string

value of the field

RPC name: set address

Overview:
Set the address field of the given host.
Signature:
void set_address (session_id s, host ref self, string value)

257
2.18. CLASS: HOST CHAPTER 2. API REFERENCE

Arguments:

type name description

host ref self reference to the object
string value New value to set

Return Type: void

type name description

host ref self reference to the object
string set value New value to set

Return Type: void

RPC name: add tags

Overview:
Add the given value to the tags field of the given host. If the value is already in that Set, then do nothing.
Signature:
void add_tags (session_id s, host ref self, string value)
Arguments:

type name description

host ref self reference to the object
string value New value to add

Return Type: void

RPC name: remove tags

Overview:
Remove the given value from the tags field of the given host. If the value is not in that Set, then do nothing.
Signature:
void remove_tags (session_id s, host ref self, string value)

260
2.18. CLASS: HOST CHAPTER 2. API REFERENCE

Arguments:

type name description

host ref self reference to the object
string value Value to remove

Return Type: void

host ref self reference to the object

Return Type: host display

value of the field

RPC name: set display

Overview:
Set the display field of the given host.
Signature:
void set_display (session_id s, host ref self, host_display value)
Arguments:

type name description

host ref self reference to the object
host display value New value to set

Return Type: void

Return Type: host ref set

references to objects with matching names

269
2.19. CLASS: HOST CRASHDUMP CHAPTER 2. API REFERENCE

2.19 Class: host crashdump

2.19.1 Fields for class: host crashdump

Name host crashdump

Description Represents a host crash dump.
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO ins host host ref Host the crashdump relates to
RO run timestamp datetime Time the crash happened
RO run size int Size of the crashdump
RW other config (string string) map additional configuration

2.19.2 RPCs associated with class: host crashdump

RPC name: destroy
Overview:
Destroy specified host crash dump, removing it from the disk.
Signature:
void destroy (session_id s, host_crashdump ref self)
Arguments:

type name description

host crashdump ref self The host crashdump to destroy

Return Type: void

type name description

host crashdump ref self reference to the object
(string string) map value New value to set

Return Type: void

RPC name: add to other config

Overview:
Add the given key-value pair to the other config field of the given host crashdump.
Signature:
void add_to_other_config (session_id s, host_crashdump ref self, string key, string value)
Arguments:

type name description

host crashdump ref self reference to the object
string key Key to add
string value Value to add

Return Type: void

RPC name: remove from other config

Overview:
Remove the given key and its corresponding value from the other config field of the given host crashdump. If
the key is not in that Map, then do nothing.
Signature:
void remove_from_other_config (session_id s, host_crashdump ref self, string key)

273
2.19. CLASS: HOST CRASHDUMP CHAPTER 2. API REFERENCE

string uuid UUID of object to return

Return Type: host metrics ref

reference to the object

RPC name: get record

Overview:
Get a record containing the current state of the given host metrics.
Signature:
(host_metrics record) get_record (session_id s, host_metrics ref self)
Arguments:

type name description

host metrics ref self reference to the object

Return Type: host metrics record

all fields from the object

286
2.22. CLASS: HOST CPU CHAPTER 2. API REFERENCE

2.22 Class: host cpu

2.22.1 Fields for class: host cpu

Name host cpu

Description A physical CPU.
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO run host host ref the host the CPU is in
RO run number int the number of the physical CPU within the
host
RO run vendor string the vendor of the physical CPU
RO run speed int the speed of the physical CPU
RO run modelname string the model name of the physical CPU
RO run family int the family (number) of the physical CPU
RO run model int the model number of the physical CPU
RO run stepping string the stepping of the physical CPU
RO run flags string the flags of the physical CPU (a decoded
version of the features field)
RO run features string the physical CPU feature bitmap
RO run utilisation float the current CPU utilisation
RW other config (string string) map additional configuration

2.22.2 RPCs associated with class: host cpu

RPC name: get all
Overview: This message is deprecated Return a list of all the host cpus known to the system.
Signature:
(host_cpu ref set) get_all (session_id s)

Return Type: host cpu ref set

references to all objects

RPC name: get all records

Overview:
Return a map of host cpu references to host cpu records for all host cpus known to the system.
Signature:

((host_cpu ref -> host_cpu record) map) get_all_records (session_id s)

Return Type: (host cpu ref host cpu record) map

records of all objects

287
2.22. CLASS: HOST CPU CHAPTER 2. API REFERENCE

RPC name: get uuid

Overview:
Get the uuid field of the given host cpu.
Signature:
string get_uuid (session_id s, host_cpu ref self)
Arguments:

type name description

host cpu ref self reference to the object

Return Type: string

value of the field

RPC name: get host

Overview:
Get the host field of the given host cpu.
Signature:
(host ref) get_host (session_id s, host_cpu ref self)
Arguments:

type name description

host cpu ref self reference to the object

Return Type: host ref

value of the field

RPC name: get number

Overview:
Get the number field of the given host cpu.
Signature:
int get_number (session_id s, host_cpu ref self)
Arguments:

type name description

host cpu ref self reference to the object

Return Type: int

Return Type: string

Return Type: string

type name description

host cpu ref self reference to the object

Return Type: host cpu record

all fields from the object

293
2.23. CLASS: NETWORK CHAPTER 2. API REFERENCE

2.23 Class: network

2.23.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 containing 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 MTU int MTU in octets
RW other config (string string) map additional configuration
RO run bridge string name of the bridge corresponding to this
network on the local host
RO run blobs (string blob ref) map Binary blobs associated with this network
RW tags string set user-specified tags for categorization pur-
poses
RO run default locking mode network default locking mode The network will use this value to deter-
mine the behaviour of all VIFs where lock-
ing mode = default
RO run assigned ips (VIF ref string) map The IP addresses assigned to VIFs on
networks that have active xapi-managed
DHCP

2.23.2 RPCs associated with class: network

RPC name: create new blob
Overview:
Create a placeholder for a named binary blob of data that is associated with this pool.
Signature:
(blob ref) create_new_blob (session_id s, network ref network, string name, string mime_type, bool public)
Arguments:

type name description

network ref network The network
string name The name associated with the blob
string mime type The mime type for the data. Empty string
translates to application/octet-stream
bool public True if the blob should be publicly available

294
2.23. CLASS: NETWORK CHAPTER 2. API REFERENCE

Return Type: blob ref

The reference of the blob, needed for populating its data

RPC name: set default locking mode

Overview:
Set the default locking mode for VIFs attached to this network.
Signature:
void set_default_locking_mode (session_id s, network ref network, network_default_locking_mode value)
Arguments:

type name description

network ref network The network
network default locking mode value The default locking mode for VIFs attached
to this network.

Return Type: void

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

network ref self reference to the object

Return Type: (string network operations) map

value of the field

RPC name: get VIFs

Overview:
Get the VIFs field of the given network.
Signature:
(VIF ref set) get_VIFs (session_id s, network ref self)
Arguments:

type name description

network ref self reference to the object

Return Type: VIF ref set

value of the field

RPC name: get PIFs

Overview:
Get the PIFs field of the given network.
Signature:
(PIF ref set) get_PIFs (session_id s, network ref self)
Arguments:

type name description

network ref self reference to the object

Return Type: PIF ref set

value of the field

298
2.23. CLASS: NETWORK CHAPTER 2. API REFERENCE

RPC name: get MTU

Overview:
Get the MTU field of the given network.
Signature:
int get_MTU (session_id s, network ref self)
Arguments:

type name description

network ref self reference to the object

Return Type: int

value of the field

network ref self reference to the object
(string string) map value New value to set

Return Type: void

RPC name: add to other config

Overview:
Add the given key-value pair to the other config field of the given network.
Signature:
void add_to_other_config (session_id s, network ref self, string key, string value)
Arguments:

type name description

network ref self reference to the object
string key Key to add
string value Value to add

value of the field

301
2.23. CLASS: NETWORK CHAPTER 2. API REFERENCE

RPC name: set tags

Overview:
Set the tags field of the given network.
Signature:
void set_tags (session_id s, network ref self, string set value)
Arguments:

type name description

network ref self reference to the object
string set value New value to set

Return Type: void

RPC name: add tags

Overview:
Add the given value to the tags field of the given network. If the value is already in that Set, then do nothing.
Signature:
void add_tags (session_id s, network ref self, string value)
Arguments:

type name description

network ref self reference to the object
string value New value to add

Return Type: network ref

reference to the object

RPC name: get record

Overview:
Get a record containing the current state of the given network.
Signature:
(network record) get_record (session_id s, network ref self)
Arguments:

type name description

network ref self reference to the object

Return Type: network record

all fields from the object

304
2.23. CLASS: NETWORK CHAPTER 2. API REFERENCE

RPC name: get by name label

Overview:
Get all the network instances with the given label.
Signature:
(network ref set) get_by_name_label (session_id s, string label)
Arguments:

type name description

string label label of object to return

Return Type: network ref set

references to objects with matching names

305
2.24. CLASS: VIF CHAPTER 2. API REFERENCE

2.24 Class: VIF

2.24.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 created
by xapi
RO ins network network ref virtual network to which this vif is con-
nected
RO ins VM VM ref virtual machine to which this vif is con-
nected
RO ins MAC string ethernet MAC address of virtual interface,
as exposed to guest
RO ins MTU int MTU in octets
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 reboot)
RO run status detail string error/success information associated with
last attach-operation status (erased on re-
boot)
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
RO run MAC autogenerated bool true if the MAC was autogenerated; false
indicates it was set manually
RO ins locking mode vif locking mode current locking mode of the VIF
RO ins ipv4 allowed string set A list of IPv4 addresses which can be used
to filter traffic passing through this VIF
RO ins ipv6 allowed string set A list of IPv6 addresses which can be used
to filter traffic passing through this VIF
RO run ipv4 configuration mode vif ipv4 configuration mode Determines whether IPv4 addresses are
configured on the VIF
RO run ipv4 addresses string set IPv4 addresses in CIDR format
RO run ipv4 gateway string IPv4 gateway (the empty string means
that no gateway is set)

VIF ref self The VIF to forcibly unplug

Return Type: void

Return Type: void

Arguments:

type name description

VIF ref self The VIF to configure
vif ipv6 configuration mode mode Whether to use static or no IPv6 assignment
string address The IPv6 address in addr/prefix length
format (for static mode only)
string gateway The IPv6 gateway (for static mode only; leave
empty to not set a gateway)

Return Type: void

RPC name: get all

Overview:
Return a list of all the VIFs known to the system.
Signature:
(VIF ref set) get_all (session_id s)

Return Type: VIF ref set

references to all objects

RPC name: get all records

Overview:
Return a map of VIF references to VIF records for all VIFs known to the system.
Signature:
((VIF ref -> VIF record) map) get_all_records (session_id s)

Return Type: (VIF ref VIF record) map

records of all objects

RPC name: get uuid

Overview:
Get the uuid field of the given VIF.
Signature:
string get_uuid (session_id s, VIF ref self)
Arguments:

type name description

type name description

VIF ref self reference to the object

Return Type: string

312
2.24. CLASS: VIF CHAPTER 2. API REFERENCE

Return Type: void

RPC name: remove from other config

Overview:
Remove the given key and its corresponding value from the other config field of the given VIF. If the key is not
in that Map, then do nothing.
Signature:
void remove_from_other_config (session_id s, VIF ref self, string key)

Arguments:

type name description

VIF ref self reference to the object
string key Key to remove

Return Type: void

RPC name: get currently attached

Overview:
Get the currently attached field of the given VIF.
Signature:
bool get_currently_attached (session_id s, VIF ref self)
Arguments:

type name description

VIF ref self reference to the object

Return Type: bool

Return Type: (string string) map

value of the field

316
2.24. CLASS: VIF CHAPTER 2. API REFERENCE

RPC name: get qos algorithm type

Overview:
Get the qos/algorithm type field of the given VIF.
Signature:
string get_qos_algorithm_type (session_id s, VIF ref self)
Arguments:

type name description

VIF ref self reference to the object

Return Type: string

value of the field

VIF ref self reference to the object
(string string) map value New value to set

Return Type: void

RPC name: add to qos algorithm params

Overview:
Add the given key-value pair to the qos/algorithm params field of the given VIF.
Signature:
void add_to_qos_algorithm_params (session_id s, VIF ref self, string key, string value)
Arguments:

type name description

VIF ref self reference to the object
string key Key to add
string value Value to add

Return Type: string set

Return Type: string

Return Type: string

value of the field

322
2.24. CLASS: VIF CHAPTER 2. API REFERENCE

RPC name: create

Overview:
Create a new VIF instance, and return its handle.
Signature:
(VIF ref) create (session_id s, VIF record args)
Arguments:

type name description

VIF record args All constructor arguments

Return Type: VIF ref

reference to the newly created object

VIF ref self reference to the object

Return Type: VIF record

all fields from the object

VIF metrics ref self reference to the object
(string string) map value New value to set

Return Type: void

RPC name: add to other config

Overview:
Add the given key-value pair to the other config field of the given VIF metrics.
Signature:
void add_to_other_config (session_id s, VIF_metrics ref self, string key, string value)

reference to the object

RPC name: get record

Overview:
Get a record containing the current state of the given VIF metrics.
Signature:
(VIF_metrics record) get_record (session_id s, VIF_metrics ref self)

328
2.25. CLASS: VIF METRICS CHAPTER 2. API REFERENCE

Arguments:

type name description

VIF metrics ref self reference to the object

Return Type: VIF metrics record

all fields from the object

329
2.26. CLASS: PIF CHAPTER 2. API REFERENCE

2.26 Class: PIF

2.26.1 Fields for class: PIF

Name PIF
A physical network interface (note separate VLANs are represented as
Description
several PIFs).
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO ins device string machine-readable name of the interface
(e.g. eth0)
RO ins network network ref virtual network to which this pif is con-
nected
RO ins host host ref physical machine to which this pif is con-
nected
RO ins MAC string ethernet MAC address of physical interface
RO ins MTU int MTU in octets
RO ins VLAN int VLAN tag for all traffic passing through
this interface
RO run metrics PIF metrics ref metrics associated with this PIF
RO run physical bool true if this represents a physical network
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 results of
a bond
RO run VLAN master of VLAN ref Indicates wich VLAN this interface re-
ceives 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 software is
listening for connections on this interface
RW other config (string string) map Additional configuration
RW disallow unplug bool Prevent this PIF from being unplugged; set
this to notify the management tool-stack
that the PIF has a special use and should
not be unplugged under any circumstances
(e.g. because youre running storage traffic
over it)
RO run tunnel access PIF of tunnel ref set Indicates to which tunnel this PIF gives
access
RO run tunnel transport PIF of tunnel ref set Indicates to which tunnel this PIF provides
transport

330
2.26. CLASS: PIF CHAPTER 2. API REFERENCE

RO run ipv6 configuration mode ipv6 configuration mode Sets if and how this interface gets an IPv6
address
RO run IPv6 string set IPv6 address
RO run ipv6 gateway string IPv6 gateway
RO run primary address type primary address type Which protocol should define the primary
address of this interface
RO ins managed bool Indicates whether the interface is managed
by xapi. If it is not, then xapi will not
configure the interface, the commands
PIF.plug/unplug/reconfigure ip(v6) can
not be used, nor can the interface be
bonded or have VLANs based on top
through xapi.
RO run properties (string string) map Additional configuration properties for the
interface.
RO run capabilities string set Additional capabilities on the interface.

2.26.2 RPCs associated with class: PIF

RPC name: create VLAN
Overview: This message is deprecated Create a VLAN interface from an existing physical interface. This
call is deprecated: use VLAN.create instead.
Signature:
(PIF ref) create_VLAN (session_id s, string device, network ref network, host ref host, int VLAN)
Arguments:

type name description

string device physical interface on which to create the
VLAN interface
network ref network network to which this interface should be con-
nected
host ref host physical machine to which this PIF is con-
nected
int VLAN VLAN tag for the new interface

Return Type: PIF ref

The reference of the created PIF object

Possible Error Codes: VLAN TAG INVALID

RPC name: destroy

Overview: This message is deprecated Destroy the PIF object (provided it is a VLAN interface). This call
is deprecated: use VLAN.destroy or Bond.destroy instead.
Signature:
void destroy (session_id s, PIF ref self)

331
2.26. CLASS: PIF CHAPTER 2. API REFERENCE

Arguments:

type name description

PIF ref self the PIF object to destroy

Return Type: void

Possible Error Codes: PIF IS PHYSICAL

RPC name: reconfigure ip

Overview:
Reconfigure the IP address settings for this interface.
Signature:
void reconfigure_ip (session_id s, PIF ref self, ip_configuration_mode mode, string IP, string netmask, st
Arguments:

type name description

PIF ref self the PIF object to reconfigure
ip configuration mode mode whether to use dynamic/static/no-assignment
string IP the new IP address
string netmask the new netmask
string gateway the new gateway
string DNS the new DNS settings

Return Type: void

RPC name: reconfigure ipv6

Overview:
Reconfigure the IPv6 address settings for this interface.
Signature:
void reconfigure_ipv6 (session_id s, PIF ref self, ipv6_configuration_mode mode, string IPv6, string gatew
Arguments:

type name description

PIF ref self the PIF object to reconfigure
ipv6 configuration mode mode whether to use dynamic/static/no-assignment
string IPv6 the new IPv6 address (in addr/prefix
length format)
string gateway the new gateway
string DNS the new DNS settings

Return Type: void

Return Type: PIF ref

The reference of the created PIF object

333
2.26. CLASS: PIF CHAPTER 2. API REFERENCE

RPC name: forget

Overview:
Destroy the PIF object matching a particular network interface.
Signature:
void forget (session_id s, PIF ref self)
Arguments:

type name description

PIF ref self The PIF object to destroy

Return Type: void

Possible Error Codes: PIF TUNNEL STILL EXISTS

RPC name: unplug

Overview:
Attempt to bring down a physical interface.
Signature:
void unplug (session_id s, PIF ref self)
Arguments:

type name description

PIF ref self the PIF object to unplug

Return Type: void

RPC name: plug

Overview:
Attempt to bring up a physical interface.
Signature:
void plug (session_id s, PIF ref self)
Arguments:

type name description

PIF ref self the PIF object to plug

Return Type: void

Possible Error Codes: TRANSPORT PIF NOT CONFIGURED

RPC name: get all

Overview:
Return a list of all the PIFs known to the system.
Signature:
(PIF ref set) get_all (session_id s)

Return Type: PIF ref set

references to all objects

RPC name: get all records

Overview:
Return a map of PIF references to PIF records for all PIFs known to the system.
Signature:
((PIF ref -> PIF record) map) get_all_records (session_id s)

Return Type: (PIF ref PIF record) map

Return Type: network ref

Return Type: int

Return Type: bool

Return Type: string

Return Type: string

Return Type: VLAN ref

Return Type: void

344
2.26. CLASS: PIF CHAPTER 2. API REFERENCE

RPC name: get disallow unplug

Overview:
Get the disallow unplug field of the given PIF.
Signature:
bool get_disallow_unplug (session_id s, PIF ref self)
Arguments:

type name description

PIF ref self reference to the object

Return Type: bool

value of the field

PIF ref self reference to the object

Return Type: tunnel ref set

value of the field

RPC name: get ipv6 configuration mode

Overview:
Get the ipv6 configuration mode field of the given PIF.
Signature:
(ipv6_configuration_mode) get_ipv6_configuration_mode (session_id s, PIF ref self)
Arguments:

type name description

PIF ref self reference to the object

Return Type: ipv6 configuration mode

value of the field

RPC name: get IPv6

Overview:
Get the IPv6 field of the given PIF.
Signature:
(string set) get_IPv6 (session_id s, PIF ref self)
Arguments:

type name description

PIF ref self reference to the object

Return Type: string set

Return Type: bool

Return Type: PIF ref

reference to the object

348
2.26. CLASS: PIF CHAPTER 2. API REFERENCE

RPC name: get record

Overview:
Get a record containing the current state of the given PIF.
Signature:
(PIF record) get_record (session_id s, PIF ref self)
Arguments:

type name description

PIF ref self reference to the object

Return Type: PIF record

all fields from the object

349
2.27. CLASS: PIF METRICS CHAPTER 2. API REFERENCE

2.27 Class: PIF metrics

2.27.1 Fields for class: PIF metrics

Name PIF metrics

Description The metrics associated with a physical network interface.
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO run io read kbs float Read bandwidth (KiB/s)
RO run io write kbs float Write bandwidth (KiB/s)
RO run carrier bool Report if the PIF got a carrier or not
RO run vendor id string Report vendor ID
RO run vendor name string Report vendor name
RO run device id string Report device ID
RO run device name string Report device name
RO run speed int Speed of the link (if available)
RO run duplex bool Full duplex capability of the link (if avail-
able)
RO run pci bus path string PCI bus path of the pif (if available)
RO run last updated datetime Time at which this information was last
updated
RW other config (string string) map additional configuration

2.27.2 RPCs associated with class: PIF metrics

RPC name: get all
Overview:
Return a list of all the PIF metrics instances known to the system.
Signature:
(PIF_metrics ref set) get_all (session_id s)

Return Type: PIF metrics ref set

references to all objects

RPC name: get all records

Overview:
Return a map of PIF metrics references to PIF metrics records for all PIF metrics instances known to the
system.
Signature:
((PIF_metrics ref -> PIF_metrics record) map) get_all_records (session_id s)

Return Type: (PIF metrics ref PIF metrics record) map

Return Type: float

Return Type: string

Return Type: int

type name description

PIF metrics ref self reference to the object

Return Type: PIF metrics record

all fields from the object

356
2.28. CLASS: BOND CHAPTER 2. API REFERENCE

2.28 Class: Bond

2.28.1 Fields for class: Bond

Name Bond
Description .
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO ins master PIF ref The bonded interface
RO run slaves PIF ref set The interfaces which are part of this bond
RW other config (string string) map additional configuration
RO run primary slave PIF ref The PIF of which the IP configuration and
MAC were copied to the bond, and which
will receive all configuration/VLANs/VIFs
on the bond if the bond is destroyed
RO run mode bond mode The algorithm used to distribute traffic
among the bonded NICs
RO run properties (string string) map Additional configuration properties spe-
cific to the bond mode.
RO run links up int Number of links up in this bond

2.28.2 RPCs associated with class: Bond

RPC name: create
Overview:
Create an interface bond.
Signature:
(Bond ref) create (session_id s, network ref network, PIF ref set members, string MAC, bond_mode mode, (st
Arguments:

type name description

network ref network Network to add the bonded PIF to
PIF ref set members PIFs to add to this bond
string MAC The MAC address to use on the bond itself.
If this parameter is the empty string then the
bond will inherit its MAC address from the
primary slave.
bond mode mode Bonding mode to use for the new bond
(string string) map properties Additional configuration parameters specific
to the bond mode

Return Type: Bond ref

The reference of the created Bond object

RPC name: destroy

Overview:

RPC name: set other config

Overview:
Set the other config field of the given Bond.
Signature:
void set_other_config (session_id s, Bond ref self, (string -> string) map value)

Return Type: (string string) map

value of the field

RPC name: get links up

Overview:
Get the links up field of the given Bond.
Signature:
int get_links_up (session_id s, Bond ref self)

362
2.28. CLASS: BOND CHAPTER 2. API REFERENCE

Arguments:

type name description

Bond ref self reference to the object

Return Type: int

value of the field

RPC name: get by uuid

Overview:
Get a reference to the Bond instance with the specified UUID.
Signature:
(Bond ref) get_by_uuid (session_id s, string uuid)
Arguments:

type name description

string uuid UUID of object to return

Return Type: Bond ref

reference to the object

RPC name: get record

Overview:
Get a record containing the current state of the given Bond.
Signature:
(Bond record) get_record (session_id s, Bond ref self)
Arguments:

type name description

Bond ref self reference to the object

Return Type: Bond record

all fields from the object

363
2.29. CLASS: VLAN CHAPTER 2. API REFERENCE

2.29 Class: VLAN

RPC name: add to other config

Overview:
Add the given key-value pair to the other config field of the given VLAN.
Signature:
void add_to_other_config (session_id s, VLAN ref self, string key, string value)
Arguments:

type name description

VLAN ref self reference to the object
string key Key to add
string value Value to add

Return Type: void

RPC name: remove from other config

Overview:
Remove the given key and its corresponding value from the other config field of the given VLAN. If the key is
not in that Map, then do nothing.
Signature:
void remove_from_other_config (session_id s, VLAN ref self, string key)

367
2.29. CLASS: VLAN CHAPTER 2. API REFERENCE

Arguments:

type name description

VLAN ref self reference to the object
string key Key to remove

Return Type: void

RPC name: get by uuid

Overview:
Get a reference to the VLAN instance with the specified UUID.
Signature:
(VLAN ref) get_by_uuid (session_id s, string uuid)
Arguments:

type name description

string uuid UUID of object to return

Return Type: VLAN ref

reference to the object

RPC name: get record

Overview:
Get a record containing the current state of the given VLAN.
Signature:
(VLAN record) get_record (session_id s, VLAN ref self)
Arguments:

type name description

VLAN ref self reference to the object

Return Type: VLAN record

all fields from the object

368
2.30. CLASS: SM CHAPTER 2. API REFERENCE

2.30 Class: SM
2.30.1 Fields for class: SM

Name SM
Description A storage manager plugin.
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO run name label string a human-readable name
RO run name description string a notes field containing human-readable
description
RO run type string SR.type
RO run vendor string Vendor who created this plugin
RO run copyright string Entity which owns the copyright of this
plugin
RO run version string Version of the plugin
RO run required api version string Minimum SM API version required on the
server
RO run configuration (string string) map names and descriptions of device config
keys
RO run capabilities string set capabilities of the SM plugin
RO run features (string int) map capabilities of the SM plugin, with capa-
bility version numbers
RW other config (string string) map additional configuration
RO run driver filename string filename of the storage driver
RO run required cluster stack string set The storage plugin requires that one of
these cluster stacks is configured and run-
ning.

2.30.2 RPCs associated with class: SM

RPC name: get all
Overview:
Return a list of all the SMs known to the system.
Signature:
(SM ref set) get_all (session_id s)

Return Type: SM ref set

references to all objects

RPC name: get all records

Overview:
Return a map of SM references to SM records for all SMs known to the system.
Signature:
((SM ref -> SM record) map) get_all_records (session_id s)

369
2.30. CLASS: SM CHAPTER 2. API REFERENCE

Return Type: (SM ref SM record) map

records of all objects

RPC name: get uuid

Overview:
Get the uuid field of the given SM.
Signature:
string get_uuid (session_id s, SM ref self)
Arguments:

type name description

SM ref self reference to the object

Return Type: string

value of the field

RPC name: get name label

Overview:
Get the name/label field of the given SM.
Signature:
string get_name_label (session_id s, SM ref self)
Arguments:

type name description

SM ref self reference to the object

Return Type: string

value of the field

RPC name: get name description

Overview:
Get the name/description field of the given SM.
Signature:
string get_name_description (session_id s, SM ref self)
Arguments:

type name description

SM ref self reference to the object

Return Type: string

370
2.30. CLASS: SM CHAPTER 2. API REFERENCE

Return Type: (string string) map

Return Type: SM ref

reference to the object

375
2.30. CLASS: SM CHAPTER 2. API REFERENCE

RPC name: get record

host ref host The host to create/make the SR on
(string string) map device config The device config string that will be passed to
backend SR driver
int physical size The physical size of the new storage repository
string name label The name of the new storage repository
string name description The description of the new storage repository
string type The type of the SR; used to specify the SR
backend driver to use
string content type The type of the new SRs content, if required
(e.g. ISOs)
bool shared True if the SR (is capable of) being shared by
multiple hosts
(string string) map sm config Storage backend specific configuration options

Return Type: SR ref

The reference of the newly created Storage Repository.

Possible Error Codes: SR UNKNOWN DRIVER

RPC name: introduce

Overview:
Introduce a new Storage Repository into the managed system.
Signature:
(SR ref) introduce (session_id s, string uuid, string name_label, string name_description, string type, st
Arguments:

type name description

string uuid The uuid assigned to the introduced SR
string name label The name of the new storage repository
string name description The description of the new storage repository
string type The type of the SR; used to specify the SR
backend driver to use
string content type The type of the new SRs content, if required
(e.g. ISOs)
bool shared True if the SR (is capable of) being shared by
multiple hosts
(string string) map sm config Storage backend specific configuration options

378
2.31. CLASS: SR CHAPTER 2. API REFERENCE

Return Type: SR ref

The reference of the newly introduced Storage Repository.

RPC name: make

Overview: This message is deprecated Create a new Storage Repository on disk. This call is deprecated:
use SR.create instead.
Signature:
string make (session_id s, host ref host, (string -> string) map device_config, int physical_size, string
Arguments:

type name description

host ref host The host to create/make the SR on
(string string) map device config The device config string that will be passed to
backend SR driver
int physical size The physical size of the new storage repository
string name label The name of the new storage repository
string name description The description of the new storage repository
string type The type of the SR; used to specify the SR
backend driver to use
string content type The type of the new SRs content, if required
(e.g. ISOs)
(string string) map sm config Storage backend specific configuration options

Return Type: string

The uuid of the newly created Storage Repository.

RPC name: destroy

Overview:
Destroy specified SR, removing SR-record from database and remove SR from disk. (In order to affect this
operation the appropriate device config is read from the specified SRs PBD on current host).
Signature:
void destroy (session_id s, SR ref sr)
Arguments:

type name description

SR ref sr The SR to destroy

Return Type: void

Possible Error Codes: SR HAS PBD

379
2.31. CLASS: SR CHAPTER 2. API REFERENCE

RPC name: forget

Overview:
Removing specified SR-record from database, without attempting to remove SR from disk.
Signature:
void forget (session_id s, SR ref sr)
Arguments:

type name description

SR ref sr The SR to destroy

Return Type: void

Possible Error Codes: SR HAS PBD

RPC name: update

Overview:
Refresh the fields on the SR object.
Signature:
void update (session_id s, SR ref sr)
Arguments:

type name description

SR ref sr The SR whose fields should be refreshed

Return Type: void

RPC name: get supported types

Overview:
Return a set of all the SR types supported by the system.
Signature:
(string set) get_supported_types (session_id s)

Return Type: string set

the supported SR types

RPC name: scan

Overview:
Refreshes the list of VDIs associated with an SR.
Signature:
void scan (session_id s, SR ref sr)

380
2.31. CLASS: SR CHAPTER 2. API REFERENCE

Arguments:

type name description

SR ref sr The SR to scan

Return Type: void

RPC name: probe

Overview:
Perform a backend-specific scan, using the given device config. If the device config is complete, then this will
return a list of the SRs present of this type on the device, if any. If the device config is partial, then a backend-
specific scan will be performed, returning results that will guide the user in improving the device config.
Signature:
string probe (session_id s, host ref host, (string -> string) map device_config, string type, (string -> s
Arguments:

type name description

host ref host The host to create/make the SR on
(string string) map device config The device config string that will be passed to
backend SR driver
string type The type of the SR; used to specify the SR
backend driver to use
(string string) map sm config Storage backend specific configuration options

Return Type: string

An XML fragment containing the scan results. These are specific to the scan being performed, and the backend.

RPC name: set shared

Overview:
Sets the shared flag on the SR.
Signature:
void set_shared (session_id s, SR ref sr, bool value)
Arguments:

type name description

SR ref sr The SR
bool value True if the SR is shared

Return Type: void

Return Type: blob ref

The reference of the blob, needed for populating its data

382
2.31. CLASS: SR CHAPTER 2. API REFERENCE

RPC name: set physical size

Overview:
Sets the SRs physical size field.
Signature:
void set_physical_size (session_id s, SR ref self, int value)
Arguments:

type name description

SR ref self The SR to modify
int value The new value of the SRs physical size

Return Type: void

RPC name: set virtual allocation

Overview:
Sets the SRs virtual allocation field.
Signature:
void set_virtual_allocation (session_id s, SR ref self, int value)
Arguments:

type name description

SR ref self The SR to modify
int value The new value of the SRs virtual allocation

Return Type: void

RPC name: set physical utilisation

Overview:
Sets the SRs physical utilisation field.
Signature:

void set_physical_utilisation (session_id s, SR ref self, int value)

Arguments:

type name description

SR ref self The SR to modify
int value The new value of the SRs physical utilisation

Return Type: void

Return Type: void

384
2.31. CLASS: SR CHAPTER 2. API REFERENCE

RPC name: disable database replication

Overview:
.
Signature:
void disable_database_replication (session_id s, SR ref sr)
Arguments:

type name description

SR ref sr The SR to which metadata should be no longer
replicated

RPC name: get all

Overview:
Return a list of all the SRs known to the system.
Signature:
(SR ref set) get_all (session_id s)

Return Type: SR ref set

references to all objects

386
2.31. CLASS: SR CHAPTER 2. API REFERENCE

RPC name: get all records

Overview:
Return a map of SR references to SR records for all SRs known to the system.
Signature:
((SR ref -> SR record) map) get_all_records (session_id s)

Return Type: (SR ref SR record) map

records of all objects

RPC name: get uuid

Overview:
Get the uuid field of the given SR.
Signature:
string get_uuid (session_id s, SR ref self)
Arguments:

type name description

SR ref self reference to the object

Return Type: string

value of the field

RPC name: get name label

Overview:
Get the name/label field of the given SR.
Signature:
string get_name_label (session_id s, SR ref self)
Arguments:

type name description

SR ref self reference to the object

Return Type: string

value of the field

RPC name: get name description

Overview:
Get the name/description field of the given SR.
Signature:

Arguments:

type name description

SR ref self reference to the object

Return Type: string set

value of the field

SR ref self reference to the object
string value Value to remove

Return Type: void

RPC name: get sm config

Overview:
Get the sm config field of the given SR.
Signature:
((string -> string) map) get_sm_config (session_id s, SR ref self)
Arguments:

type name description

SR ref self reference to the object

Return Type: (string string) map

value of the field

RPC name: set sm config

Overview:
Set the sm config field of the given SR.
Signature:
void set_sm_config (session_id s, SR ref self, (string -> string) map value)
Arguments:

type name description

SR ref self reference to the object
(string string) map value New value to set

Return Type: void

RPC name: add to sm config

Overview:
Add the given key-value pair to the sm config field of the given SR.
Signature:
void add_to_sm_config (session_id s, SR ref self, string key, string value)

394
2.31. CLASS: SR CHAPTER 2. API REFERENCE

Arguments:

type name description

SR ref self reference to the object
string key Key to add
string value Value to add

Return Type: void

RPC name: remove from sm config

Overview:
Remove the given key and its corresponding value from the sm config field of the given SR. If the key is not in
that Map, then do nothing.
Signature:
void remove_from_sm_config (session_id s, SR ref self, string key)
Arguments:

type name description

SR ref self reference to the object
string key Key to remove

Return Type: void

type name description

string label label of object to return

Return Type: SR ref set

references to objects with matching names

398
2.32. CLASS: LVHD CHAPTER 2. API REFERENCE

2.32 Class: LVHD

2.32.1 Fields for class: LVHD

Name LVHD
Description LVHD SR specific operations.
Quals Field Type Description
RO run uuid string Unique identifier/object reference

string uuid UUID of object to return

Return Type: LVHD ref

reference to the object

RPC name: get record

Overview:
Get a record containing the current state of the given LVHD.
Signature:
(LVHD record) get_record (session_id s, LVHD ref self)
Arguments:

type name description

LVHD ref self reference to the object

Return Type: LVHD record

all fields from the object

400
2.33. CLASS: VDI CHAPTER 2. API REFERENCE

2.33 Class: VDI

2.33.1 Fields for class: VDI

Name VDI
Description A virtual disk image.
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO ins name label string a human-readable name
RO ins name description string a notes field containing human-readable
description
RO run allowed operations vdi 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 vdi 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 SR SR ref storage repository in which the VDI resides
RO run VBDs VBD ref set list of vbds that refer to this disk
RO run crash dumps crashdump ref set list of crash dumps that refer to this disk
RO ins virtual size int size of disk as presented to the guest (in
bytes). Note that, depending on storage
backend type, requested size may not be
respected exactly
RO run physical utilisation int amount of physical space that the disk im-
age is currently taking up on the storage
repository (in bytes)
RO ins type vdi type type of the VDI
RO ins sharable bool true if this disk may be shared
RO ins read only bool true if this disk may ONLY be mounted
read-only
RW other config (string string) map additional configuration
RO run storage lock bool true if this disk is locked at the storage
level
RO run location string location information
RO run managed bool
RO run missing bool true if SR scan operation reported this VDI
as not present on disk
RO run parent VDI ref References the parent disk, if this VDI is
part of a chain
RW xenstore data (string string) map data to be inserted into the xenstore tree
(/local/domain/0/backend/vbd/domid/device-
id/sm-data) after the VDI is attached.
This is generally set by the SM backends
on vdi attach.
RW sm config (string string) map SM dependent data
RO run is a snapshot bool true if this is a snapshot.
RO run snapshot of VDI ref Ref pointing to the VDI this snapshot is
of.

401
2.33. CLASS: VDI CHAPTER 2. API REFERENCE

RO run snapshots VDI ref set List pointing to all the VDIs snapshots.
RO run snapshot time datetime Date/time when this snapshot was created.
RW tags string set user-specified tags for categorization pur-
poses
RO run allow caching bool true if this VDI is to be cached in the local
cache SR
RO run on boot on boot The behaviour of this VDI on a VM boot
RO run metadata of pool pool ref The pool whose metadata is contained in
this VDI
RO run metadata latest bool Whether this VDI contains the latest
known accessible metadata for the pool
RO run is tools iso bool Whether this VDI is a Tools ISO

2.33.2 RPCs associated with class: VDI

RPC name: snapshot
Overview:
Take a read-only snapshot of the VDI, returning a reference to the snapshot. If any driver params are specified
then these are passed through to the storage-specific substrate driver that takes the snapshot. NB the snapshot
lives in the same Storage Repository as its parent.
Signature:
(VDI ref) snapshot (session_id s, VDI ref vdi, (string -> string) map driver_params)
Arguments:

type name description

VDI ref vdi The VDI to snapshot
(string string) map driver params Optional parameters that can be passed
through to backend driver in order to specify
storage-type-specific snapshot options

Return Type: VDI ref

The ID of the newly created VDI.

RPC name: clone

Overview:
Take an exact copy of the VDI and return a reference to the new disk. If any driver params are specified then
these are passed through to the storage-specific substrate driver that implements the clone operation. NB the
clone lives in the same Storage Repository as its parent.
Signature:
(VDI ref) clone (session_id s, VDI ref vdi, (string -> string) map driver_params)
Arguments:

type name description

VDI ref vdi The VDI to clone
(string string) map driver params Optional parameters that are passed through
to the backend driver in order to specify
storage-type-specific clone options

402
2.33. CLASS: VDI CHAPTER 2. API REFERENCE

Return Type: VDI ref

The ID of the newly created VDI.

string uuid The uuid of the disk to introduce
string name label The name of the disk record
string name description The description of the disk record
SR ref SR The SR that the VDI is in
vdi type type The type of the VDI
bool sharable true if this disk may be shared
bool read only true if this disk may ONLY be mounted read-
only
(string string) map other config additional configuration
string location location information
(string string) map xenstore data Data to insert into xenstore
(string string) map sm config Storage-specific config
bool managed Storage-specific config
int virtual size Storage-specific config
int physical utilisation Storage-specific config
pool ref metadata of pool Storage-specific config
bool is a snapshot Storage-specific config
datetime snapshot time Storage-specific config
VDI ref snapshot of Storage-specific config

Return Type: VDI ref

The ref of the newly created VDI record.

Possible Error Codes: SR OPERATION NOT SUPPORTED

RPC name: db introduce

Overview:
Create a new VDI record in the database only.
Signature:
(VDI ref) db_introduce (session_id s, string uuid, string name_label, string name_description, SR ref SR,
Arguments:

404
2.33. CLASS: VDI CHAPTER 2. API REFERENCE

type name description

Return Type: VDI ref

The ref of the newly created VDI record.

Possible Error Codes: VDI READONLY, VDI TOO SMALL, VDI NOT SPARSE

RPC name: set managed

Overview:
Sets the VDIs managed field.
Signature:
void set_managed (session_id s, VDI ref self, bool value)
Arguments:

type name description

VDI ref self The VDI to modify
bool value The new value of the VDIs managed field

Return Type: void

Return Type: void

407
2.33. CLASS: VDI CHAPTER 2. API REFERENCE

RPC name: set missing

Overview:
Sets the VDIs missing field.
Signature:
void set_missing (session_id s, VDI ref self, bool value)
Arguments:

type name description

VDI ref self The VDI to modify
bool value The new value of the VDIs missing field

Return Type: void

RPC name: set virtual size

Overview:
Sets the VDIs virtual size field.
Signature:
void set_virtual_size (session_id s, VDI ref self, int value)
Arguments:

type name description

VDI ref self The VDI to modify
int value The new value of the VDIs virtual size

Return Type: void

RPC name: set physical utilisation

Overview:
Sets the VDIs physical utilisation field.
Signature:

void set_physical_utilisation (session_id s, VDI ref self, int value)

Arguments:

type name description

VDI ref self The VDI to modify
int value The new value of the VDIs physical utilisation

Return Type: void

Return Type: void

Return Type: void

Return Type: session ref

411
2.33. CLASS: VDI CHAPTER 2. API REFERENCE

A session which can be used to query the database

RPC name: read database pool uuid

Overview:
Check the VDI cache for the pool UUID of the database on this VDI.
Signature:
string read_database_pool_uuid (session_id s, VDI ref self)
Arguments:

type name description

VDI ref self The metadata VDI to look up in the cache.

Return Type: string

The cached pool UUID of the database on the VDI.

RPC name: pool migrate

Overview:
Migrate a VDI, which may be attached to a running guest, to a different SR. The destination SR must be visible
to the guest.
Signature:
(VDI ref) pool_migrate (session_id s, VDI ref vdi, SR ref sr, (string -> string) map options)
Arguments:

type name description

VDI ref vdi The VDI to migrate
SR ref sr The destination SR
(string string) map options Other parameters

Return Type: VDI ref

The new reference of the migrated VDI.

RPC name: get all

Overview:
Return a list of all the VDIs known to the system.
Signature:
(VDI ref set) get_all (session_id s)

Return Type: VDI ref set

references to all objects

412
2.33. CLASS: VDI CHAPTER 2. API REFERENCE

RPC name: get all records

Overview:
Return a map of VDI references to VDI records for all VDIs known to the system.
Signature:
((VDI ref -> VDI record) map) get_all_records (session_id s)

Return Type: (VDI ref VDI record) map

records of all objects

RPC name: get uuid

Overview:
Get the uuid field of the given VDI.
Signature:
string get_uuid (session_id s, VDI ref self)
Arguments:

type name description

VDI ref self reference to the object

Return Type: string

value of the field

RPC name: get name label

Overview:
Get the name/label field of the given VDI.
Signature:
string get_name_label (session_id s, VDI ref self)
Arguments:

type name description

VDI ref self reference to the object

Return Type: string

value of the field

RPC name: get name description

Overview:
Get the name/description field of the given VDI.
Signature:

Arguments:

type name description

VDI ref self reference to the object

Return Type: (string string) map

value of the field

VDI ref self reference to the object
string key Key to remove

Return Type: void

Arguments:

type name description

VDI ref self reference to the object

Return Type: void

Return Type: VDI ref set

references to objects with matching names

429
2.34. CLASS: VBD CHAPTER 2. API REFERENCE

2.34 Class: VBD

2.34.1 Fields for class: VBD

Name VBD
Description A virtual block device.
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO run allowed operations vbd 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 vbd 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 VM VM ref the virtual machine
RO ins VDI VDI ref the virtual disk
RO run device string device seen by the guest e.g. hda1
RW userdevice string user-friendly device name e.g. 0,1,2,etc.
RW bootable bool true if this VBD is bootable
RW mode vbd mode the mode the VBD should be mounted
with
RW type vbd type how the VBD will appear to the guest (e.g.
disk or CD)
RW unpluggable bool true if this VBD will support hot-unplug
RO run storage lock bool true if a storage level lock was acquired
RO ins empty bool if true this represents an empty drive
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 reboot)
RO run status detail string error/success information associated with
last attach-operation status (erased on re-
boot)
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 VBD
RO run metrics VBD metrics ref metrics associated with this VBD

2.34.2 RPCs associated with class: VBD

RPC name: eject
Overview:
Remove the media from the device and leave it empty.
Signature:
void eject (session_id s, VBD ref vbd)

430
2.34. CLASS: VBD CHAPTER 2. API REFERENCE

431
2.34. CLASS: VBD CHAPTER 2. API REFERENCE

Arguments:

type name description

VBD ref self The VBD to hot-unplug

Return Type: void

Possible Error Codes: DEVICE DETACH REJECTED, DEVICE ALREADY DETACHED

RPC name: unplug force

Overview:
Forcibly unplug the specified VBD.
Signature:
void unplug_force (session_id s, VBD ref self)
Arguments:

type name description

VBD ref self The VBD to forcibly unplug

Return Type: void

RPC name: assert attachable

Overview:
Throws an error if this VBD could not be attached to this VM if the VM were running. Intended for debugging.
Signature:
void assert_attachable (session_id s, VBD ref self)
Arguments:

type name description

VBD ref self The VBD to query

Return Type: void

RPC name: get all

Overview:
Return a list of all the VBDs known to the system.
Signature:
(VBD ref set) get_all (session_id s)

Return Type: VBD ref set

references to all objects

432
2.34. CLASS: VBD CHAPTER 2. API REFERENCE

RPC name: get all records

Overview:
Return a map of VBD references to VBD records for all VBDs known to the system.
Signature:
((VBD ref -> VBD record) map) get_all_records (session_id s)

Return Type: (VBD ref VBD record) map

records of all objects

RPC name: get uuid

Overview:
Get the uuid field of the given VBD.
Signature:
string get_uuid (session_id s, VBD ref self)
Arguments:

type name description

VBD ref self reference to the object

Return Type: string

value of the field

RPC name: get allowed operations

Overview:
Get the allowed operations field of the given VBD.
Signature:
(vbd_operations set) get_allowed_operations (session_id s, VBD ref self)
Arguments:

type name description

VBD ref self reference to the object

Return Type: vbd operations set

value of the field

RPC name: get current operations

Overview:
Get the current operations field of the given VBD.
Signature:

VBD ref self reference to the object
string value New value to set

Return Type: void

RPC name: get bootable

Overview:
Get the bootable field of the given VBD.
Signature:
bool get_bootable (session_id s, VBD ref self)

435
2.34. CLASS: VBD CHAPTER 2. API REFERENCE

Arguments:

type name description

VBD ref self reference to the object

Return Type: bool

value of the field

RPC name: set bootable

Overview:
Set the bootable field of the given VBD.
Signature:
void set_bootable (session_id s, VBD ref self, bool value)
Arguments:

type name description

VBD ref self reference to the object
bool value New value to set

Return Type: void

RPC name: get mode

Overview:
Get the mode field of the given VBD.
Signature:
(vbd_mode) get_mode (session_id s, VBD ref self)
Arguments:

type name description

VBD ref self reference to the object

Return Type: vbd mode

value of the field

RPC name: set mode

Overview:
Set the mode field of the given VBD.
Signature:
void set_mode (session_id s, VBD ref self, vbd_mode value)

436
2.34. CLASS: VBD CHAPTER 2. API REFERENCE

Arguments:

type name description

VBD ref self reference to the object
vbd mode value New value to set

Return Type: void

RPC name: get type

Overview:
Get the type field of the given VBD.
Signature:
(vbd_type) get_type (session_id s, VBD ref self)
Arguments:

type name description

VBD ref self reference to the object

Return Type: vbd type

value of the field

RPC name: set type

Overview:
Set the type field of the given VBD.
Signature:
void set_type (session_id s, VBD ref self, vbd_type value)
Arguments:

type name description

VBD ref self reference to the object
vbd type value New value to set

Return Type: void

RPC name: get unpluggable

Overview:
Get the unpluggable field of the given VBD.
Signature:
bool get_unpluggable (session_id s, VBD ref self)

437
2.34. CLASS: VBD CHAPTER 2. API REFERENCE

Arguments:

type name description

VBD ref self reference to the object

Return Type: bool

value of the field

RPC name: set unpluggable

Overview:
Set the unpluggable field of the given VBD.
Signature:
void set_unpluggable (session_id s, VBD ref self, bool value)
Arguments:

type name description

VBD ref self reference to the object
bool value New value to set

Return Type: void

Return Type: void

RPC name: add to other config

Overview:
Add the given key-value pair to the other config field of the given VBD.
Signature:
void add_to_other_config (session_id s, VBD ref self, string key, string value)

439
2.34. CLASS: VBD CHAPTER 2. API REFERENCE

Arguments:

type name description

VBD ref self reference to the object
string key Key to add
string value Value to add

Return Type: void

RPC name: remove from other config

Overview:
Remove the given key and its corresponding value from the other config field of the given VBD. If the key is not
in that Map, then do nothing.
Signature:
void remove_from_other_config (session_id s, VBD ref self, string key)
Arguments:

type name description

VBD ref self reference to the object
string key Key to remove

Return Type: void

Overview:
Get the qos/algorithm params field of the given VBD.
Signature:
((string -> string) map) get_qos_algorithm_params (session_id s, VBD ref self)
Arguments:

type name description

VBD ref self reference to the object

Return Type: (string string) map

value of the field

RPC name: set qos algorithm params

Overview:
Set the qos/algorithm params field of the given VBD.
Signature:
void set_qos_algorithm_params (session_id s, VBD ref self, (string -> string) map value)

Return Type: VBD ref

reference to the newly created object

RPC name: destroy

Overview:
Destroy the specified VBD instance.
Signature:
void destroy (session_id s, VBD ref self)

444
2.34. CLASS: VBD CHAPTER 2. API REFERENCE

Arguments:

type name description

VBD ref self reference to the object

Return Type: void

RPC name: get by uuid

Overview:
Get a reference to the VBD instance with the specified UUID.
Signature:
(VBD ref) get_by_uuid (session_id s, string uuid)
Arguments:

type name description

string uuid UUID of object to return

Return Type: VBD ref

reference to the object

RPC name: get record

Overview:
Get a record containing the current state of the given VBD.
Signature:
(VBD record) get_record (session_id s, VBD ref self)
Arguments:

type name description

VBD ref self reference to the object

Return Type: VBD record

all fields from the object

VBD metrics ref self reference to the object
(string string) map value New value to set

Return Type: void

RPC name: add to other config

Overview:
Add the given key-value pair to the other config field of the given VBD metrics.
Signature:
void add_to_other_config (session_id s, VBD_metrics ref self, string key, string value)

reference to the object

RPC name: get record

Overview:
Get a record containing the current state of the given VBD metrics.
Signature:
(VBD_metrics record) get_record (session_id s, VBD_metrics ref self)

449
2.35. CLASS: VBD METRICS CHAPTER 2. API REFERENCE

Arguments:

type name description

VBD metrics ref self reference to the object

Return Type: VBD metrics record

all fields from the object

450
2.36. CLASS: PBD CHAPTER 2. API REFERENCE

2.36 Class: PBD

2.36.1 Fields for class: PBD

RPC name: create

Overview:
Create a new PBD instance, and return its handle.
Signature:
(PBD ref) create (session_id s, PBD record args)

455
2.36. CLASS: PBD CHAPTER 2. API REFERENCE

Arguments:

type name description

PBD record args All constructor arguments

Return Type: PBD ref

reference to the newly created object

RPC name: destroy

Overview:
Destroy the specified PBD instance.
Signature:
void destroy (session_id s, PBD ref self)
Arguments:

type name description

PBD ref self reference to the object

Return Type: void

RPC name: get by uuid

Overview:
Get a reference to the PBD instance with the specified UUID.
Signature:
(PBD ref) get_by_uuid (session_id s, string uuid)
Arguments:

type name description

string uuid UUID of object to return

Return Type: PBD ref

reference to the object

RPC name: get record

Overview:
Get a record containing the current state of the given PBD.
Signature:
(PBD record) get_record (session_id s, PBD ref self)

456
2.36. CLASS: PBD CHAPTER 2. API REFERENCE

Arguments:

type name description

PBD ref self reference to the object

Return Type: PBD record

all fields from the object

457
2.37. CLASS: CRASHDUMP CHAPTER 2. API REFERENCE

2.37 Class: crashdump

2.37.1 Fields for class: crashdump

Name crashdump
Description A VM crashdump.
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO ins VM VM ref the virtual machine
RO ins VDI VDI ref the virtual disk
RW other config (string string) map additional configuration

2.37.2 RPCs associated with class: crashdump

RPC name: destroy
Overview:
Destroy the specified crashdump.
Signature:
void destroy (session_id s, crashdump ref self)
Arguments:

type name description

crashdump ref self The crashdump to destroy

Return Type: void

RPC name: get all

Overview:
Return a list of all the crashdumps known to the system.
Signature:
(crashdump ref set) get_all (session_id s)

Return Type: crashdump ref set

references to all objects

RPC name: get all records

Overview:
Return a map of crashdump references to crashdump records for all crashdumps known to the system.
Signature:
((crashdump ref -> crashdump record) map) get_all_records (session_id s)

458
2.37. CLASS: CRASHDUMP CHAPTER 2. API REFERENCE

Return Type: (crashdump ref crashdump record) map

records of all objects

RPC name: get uuid

Overview:
Get the uuid field of the given crashdump.
Signature:
string get_uuid (session_id s, crashdump ref self)
Arguments:

type name description

crashdump ref self reference to the object

Return Type: string

value of the field

RPC name: get VM

Overview:
Get the VM field of the given crashdump.
Signature:
(VM ref) get_VM (session_id s, crashdump ref self)
Arguments:

type name description

crashdump ref self reference to the object

Return Type: VM ref

value of the field

RPC name: get VDI

reference to the object

RPC name: get record

Overview:
Get a record containing the current state of the given crashdump.
Signature:
(crashdump record) get_record (session_id s, crashdump ref self)
Arguments:

type name description

crashdump ref self reference to the object

Return Type: crashdump record

461
2.37. CLASS: CRASHDUMP CHAPTER 2. API REFERENCE

all fields from the object

462
2.38. CLASS: VTPM CHAPTER 2. API REFERENCE

2.38 Class: VTPM

2.38.1 Fields for class: VTPM

Name VTPM
Description A virtual TPM device.
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO ins VM VM ref the virtual machine
RO ins backend VM ref the domain where the backend is located

2.38.2 RPCs associated with class: VTPM

RPC name: get uuid
Overview:
Get the uuid field of the given VTPM.
Signature:
string get_uuid (session_id s, VTPM ref self)
Arguments:

type name description

VTPM ref self reference to the object

Return Type: string

value of the field

RPC name: get VM

Overview:
Get the VM field of the given VTPM.
Signature:
(VM ref) get_VM (session_id s, VTPM ref self)
Arguments:

type name description

VTPM ref self reference to the object

Return Type: VM ref

value of the field

RPC name: get backend

Return Type: void

RPC name: get by uuid

Overview:
Get a reference to the VTPM instance with the specified UUID.
Signature:
(VTPM ref) get_by_uuid (session_id s, string uuid)

464
2.38. CLASS: VTPM CHAPTER 2. API REFERENCE

Arguments:

type name description

string uuid UUID of object to return

Return Type: VTPM ref

reference to the object

RPC name: get record

Overview:
Get a record containing the current state of the given VTPM.
Signature:
(VTPM record) get_record (session_id s, VTPM ref self)
Arguments:

type name description

VTPM ref self reference to the object

Return Type: VTPM record

all fields from the object

465
2.39. CLASS: CONSOLE CHAPTER 2. API REFERENCE

2.39 Class: console

2.39.1 Fields for class: console

Name console
Description A console.
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO run protocol console protocol the protocol used by this console
RO run location string URI for the console service
RO run VM VM ref VM to which this console is attached
RW other config (string string) map additional configuration

2.39.2 RPCs associated with class: console

RPC name: get all
Overview:
Return a list of all the consoles known to the system.
Signature:
(console ref set) get_all (session_id s)

Return Type: console ref set

references to all objects

RPC name: get all records

Overview:
Return a map of console references to console records for all consoles known to the system.
Signature:
((console ref -> console record) map) get_all_records (session_id s)

Return Type: (console ref console record) map

records of all objects

RPC name: get uuid

Overview:
Get the uuid field of the given console.
Signature:
string get_uuid (session_id s, console ref self)
Arguments:

type name description

type name description

console ref self reference to the object

Return Type: VM ref

467
2.39. CLASS: CONSOLE CHAPTER 2. API REFERENCE

value of the field

RPC name: get other config

Overview:
Get the other config field of the given console.
Signature:
((string -> string) map) get_other_config (session_id s, console ref self)
Arguments:

type name description

console ref self reference to the object

Return Type: (string string) map

value of the field

RPC name: set other config

Overview:
Set the other config field of the given console.
Signature:
void set_other_config (session_id s, console ref self, (string -> string) map value)
Arguments:

type name description

console ref self reference to the object
(string string) map value New value to set

Return Type: void

RPC name: add to other config

Overview:
Add the given key-value pair to the other config field of the given console.
Signature:
void add_to_other_config (session_id s, console ref self, string key, string value)
Arguments:

type name description

console ref self reference to the object
string key Key to add
string value Value to add

468
2.39. CLASS: CONSOLE CHAPTER 2. API REFERENCE

Return Type: void

RPC name: remove from other config

Overview:
Remove the given key and its corresponding value from the other config field of the given console. If the key is
not in that Map, then do nothing.
Signature:
void remove_from_other_config (session_id s, console ref self, string key)
Arguments:

type name description

console ref self reference to the object
string key Key to remove

all fields from the object

470
2.40. CLASS: USER CHAPTER 2. API REFERENCE

2.40 Class: user

2.40.1 Fields for class: user

Name user
Description A user of the system.
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO ins short name string short name (e.g. userid)
RW fullname string full name
RW other config (string string) map additional configuration

2.40.2 RPCs associated with class: user

RPC name: get uuid
Overview:
Get the uuid field of the given user.
Signature:
string get_uuid (session_id s, user ref self)
Arguments:

type name description

user ref self reference to the object

Return Type: string

value of the field

RPC name: get short name

Overview:
Get the short name field of the given user.
Signature:
string get_short_name (session_id s, user ref self)
Arguments:

type name description

user ref self reference to the object

Return Type: string

value of the field

471
2.40. CLASS: USER CHAPTER 2. API REFERENCE

RPC name: get fullname

Overview:
Get the fullname field of the given user.
Signature:
string get_fullname (session_id s, user ref self)
Arguments:

type name description

user ref self reference to the object

Return Type: string

value of the field

user ref self reference to the object
(string string) map value New value to set

Return Type: void

RPC name: add to other config

Overview:
Add the given key-value pair to the other config field of the given user.
Signature:
void add_to_other_config (session_id s, user ref self, string key, string value)
Arguments:

type name description

user ref self reference to the object
string key Key to add
string value Value to add

RPC name: get by uuid

Overview: This message is deprecated Get a reference to the user instance with the specified UUID.
Signature:
(user ref) get_by_uuid (session_id s, string uuid)
Arguments:

type name description

string uuid UUID of object to return

Return Type: user ref

reference to the object

RPC name: get record

Overview: This message is deprecated Get a record containing the current state of the given user.
Signature:
(user record) get_record (session_id s, user ref self)

474
2.40. CLASS: USER CHAPTER 2. API REFERENCE

Arguments:

type name description

user ref self reference to the object

Return Type: user record

all fields from the object

475
2.41. CLASS: DATA SOURCE CHAPTER 2. API REFERENCE

2.41 Class: data source

2.41.1 Fields for class: data source

Name data source

Description Data sources for logging in RRDs.
Quals Field Type Description
RO run name label string a human-readable name
RO run name description string a notes field containing human-readable
description
RO run enabled bool true if the data source is being logged
RO run standard bool true if the data source is enabled by de-
fault. Non-default data sources cannot be
disabled
RO run units string the units of the value
RO run min float the minimum value of the data source
RO run max float the maximum value of the data source
RO run value float current value of the data source

2.41.2 RPCs associated with class: data source

Class data source has no additional RPCs associated with it.

476
2.42. CLASS: BLOB CHAPTER 2. API REFERENCE

2.42 Class: blob

2.42.1 Fields for class: blob

Name blob
Description A placeholder for a binary blob.
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 containing human-readable
description
RO run size int Size of the binary data, in bytes
RW public bool True if the blob is publicly accessible
RO ins last updated datetime Time at which the data in the blob was last
updated
RO ins mime type string The mime type associated with this object.
Defaults to application/octet-stream if
the empty string is supplied

2.42.2 RPCs associated with class: blob

RPC name: create
Overview:
Create a placeholder for a binary blob.
Signature:
(blob ref) create (session_id s, string mime_type, bool public)
Arguments:

type name description

string mime type The mime-type of the blob. Defaults to
application/octet-stream if the empty string
is supplied
bool public True if the blob should be publicly available

Return Type: blob ref

The reference to the created blob

RPC name: destroy

Overview:
.
Signature:
void destroy (session_id s, blob ref self)
Arguments:

type name description

blob ref self The reference of the blob to destroy

477
2.42. CLASS: BLOB CHAPTER 2. API REFERENCE

Return Type: void

RPC name: get all

Overview:
Return a list of all the blobs known to the system.
Signature:
(blob ref set) get_all (session_id s)

Return Type: blob ref set

references to all objects

RPC name: get all records

Overview:
Return a map of blob references to blob records for all blobs known to the system.
Signature:
((blob ref -> blob record) map) get_all_records (session_id s)

Return Type: (blob ref blob record) map

records of all objects

RPC name: get uuid

Overview:
Get the uuid field of the given blob.
Signature:
string get_uuid (session_id s, blob ref self)
Arguments:

type name description

blob ref self reference to the object

Return Type: string

value of the field

478
2.42. CLASS: BLOB CHAPTER 2. API REFERENCE

RPC name: get name label

Overview:
Get the name/label field of the given blob.
Signature:
string get_name_label (session_id s, blob ref self)
Arguments:

type name description

blob ref self reference to the object

Return Type: string

value of the field

blob ref self reference to the object
string value New value to set

Return Type: void

RPC name: get size

Overview:
Get the size field of the given blob.
Signature:
int get_size (session_id s, blob ref self)
Arguments:

type name description

blob ref self reference to the object

Return Type: int

value of the field

RPC name: get public

Return Type: datetime

value of the field

RPC name: get mime type

Overview:
Get the mime type field of the given blob.
Signature:
string get_mime_type (session_id s, blob ref self)
Arguments:

type name description

blob ref self reference to the object

Return Type: string

Return Type: blob ref set

references to objects with matching names

482
2.43. CLASS: MESSAGE CHAPTER 2. API REFERENCE

2.43 Class: message

2.43.1 Fields for class: message

Name message
Description An messagefor the attention of the administrator.
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO run name string The name of the message
RO run priority int The message priority, 0 being low priority
RO run cls cls The class of the object this message is as-
sociated with
RO run obj uuid string The uuid of the object this message is as-
sociated with
RO run timestamp datetime The time at which the message was created
RO run body string The body of the message

2.43.2 RPCs associated with class: message

RPC name: create
Overview:
.
Signature:
(message ref) create (session_id s, string name, int priority, cls cls, string obj_uuid, string body)
Arguments:

The relevant messages

RPC name: get all

Overview:
.
Signature:
(message ref set) get_all (session_id s)

Return Type: message ref set

The references to the messages

RPC name: get since

Overview:
.
Signature:
((message ref -> message record) map) get_since (session_id s, datetime since)
Arguments:

type name description

datetime since The cutoff time

Return Type: (message ref message record) map

484
2.43. CLASS: MESSAGE CHAPTER 2. API REFERENCE

The relevant messages

RPC name: get record

Overview:
.
Signature:
(message record) get_record (session_id s, message ref self)
Arguments:

type name description

message ref self The reference to the message

Return Type: message record

The message record

RPC name: get by uuid

Overview:
.
Signature:
(message ref) get_by_uuid (session_id s, string uuid)
Arguments:

type name description

string uuid The uuid of the message

Return Type: message ref

The message reference

RPC name: get all records

Overview:
.
Signature:
((message ref -> message record) map) get_all_records (session_id s)

Return Type: (message ref message record) map

The messages

485
2.43. CLASS: MESSAGE CHAPTER 2. API REFERENCE

RPC name: get all records where

Overview:
.
Signature:
((message ref -> message record) map) get_all_records_where (session_id s, string expr)
Arguments:

type name description

string expr The expression to match (not currently used)

Return Type: (message ref message record) map

The messages

486
2.44. CLASS: SECRET CHAPTER 2. API REFERENCE

2.44 Class: secret

2.44.1 Fields for class: secret

Name secret
Description A secret.
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RW value string the secret
RW other config (string string) map other config

2.44.2 RPCs associated with class: secret

RPC name: get all
Overview:
Return a list of all the secrets known to the system.
Signature:
(secret ref set) get_all (session_id s)

Return Type: secret ref set

references to all objects

RPC name: get all records

Overview:
Return a map of secret references to secret records for all secrets known to the system.
Signature:
((secret ref -> secret record) map) get_all_records (session_id s)

Return Type: (secret ref secret record) map

records of all objects

RPC name: get uuid

Overview:
Get the uuid field of the given secret.
Signature:
string get_uuid (session_id s, secret ref self)
Arguments:

type name description

secret ref self reference to the object

Return Type: string

487
2.44. CLASS: SECRET CHAPTER 2. API REFERENCE

value of the field

RPC name: get value

Overview:
Get the value field of the given secret.
Signature:
string get_value (session_id s, secret ref self)
Arguments:

type name description

secret ref self reference to the object

Return Type: string

value of the field

secret ref self reference to the object
(string string) map value New value to set

Return Type: void

RPC name: add to other config

Overview:
Add the given key-value pair to the other config field of the given secret.
Signature:
void add_to_other_config (session_id s, secret ref self, string key, string value)
Arguments:

type name description

secret ref self reference to the object
string key Key to add
string value Value to add

secret ref self reference to the object

Return Type: secret record

all fields from the object

491
2.45. CLASS: TUNNEL CHAPTER 2. API REFERENCE

2.45 Class: tunnel

2.45.1 Fields for class: tunnel

Name tunnel
Description A tunnel for network traffic.
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO ins access PIF PIF ref The interface through which the tunnel is
accessed
RO ins transport PIF PIF ref The interface used by the tunnel
RW status (string string) map Status information about the tunnel
RW other config (string string) map Additional configuration

2.45.2 RPCs associated with class: tunnel

RPC name: create
Overview:
Create a tunnel.
Signature:
(tunnel ref) create (session_id s, PIF ref transport_PIF, network ref network)
Arguments:

type name description

PIF ref transport PIF PIF which receives the tagged traffic
network ref network Network to receive the tunnelled traffic

Return Type: tunnel ref

Return Type: (string string) map

value of the field

RPC name: set status

Overview:
Set the status field of the given tunnel.
Signature:
void set_status (session_id s, tunnel ref self, (string -> string) map value)

RPC name: get other config

Overview:
Get the other config field of the given tunnel.
Signature:
((string -> string) map) get_other_config (session_id s, tunnel ref self)

495
2.45. CLASS: TUNNEL CHAPTER 2. API REFERENCE

Arguments:

type name description

tunnel ref self reference to the object

Return Type: (string string) map

value of the field

tunnel ref self reference to the object
string key Key to remove

Return Type: void

RPC name: get by uuid

Overview:
Get a reference to the tunnel instance with the specified UUID.
Signature:
(tunnel ref) get_by_uuid (session_id s, string uuid)
Arguments:

type name description

string uuid UUID of object to return

Return Type: tunnel ref

reference to the object

RPC name: get record

Overview:
Get a record containing the current state of the given tunnel.
Signature:
(tunnel record) get_record (session_id s, tunnel ref self)
Arguments:

type name description

tunnel ref self reference to the object

Return Type: tunnel record

all fields from the object

497
2.46. CLASS: PCI CHAPTER 2. API REFERENCE

2.46 Class: PCI

2.46.1 Fields for class: PCI

Name PCI
Description A PCI device.
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO ins class name string PCI class name
RO ins vendor name string Vendor name
RO ins device name string Device name
RO ins host host ref Physical machine that owns the PCI device
RO ins pci id string PCI ID of the physical device
RO run dependencies PCI ref set List of dependent PCI devices
RW other config (string string) map Additional configuration
RO ins subsystem vendor name string Subsystem vendor name
RO ins subsystem device name string Subsystem device name

2.46.2 RPCs associated with class: PCI

RPC name: get all
Overview:
Return a list of all the PCIs known to the system.
Signature:
(PCI ref set) get_all (session_id s)

Return Type: PCI ref set

references to all objects

RPC name: get all records

Overview:
Return a map of PCI references to PCI records for all PCIs known to the system.
Signature:
((PCI ref -> PCI record) map) get_all_records (session_id s)

Return Type: (PCI ref PCI record) map

records of all objects

RPC name: get uuid

Overview:
Get the uuid field of the given PCI.
Signature:

PCI ref self reference to the object
(string string) map value New value to set

Return Type: void

RPC name: add to other config

Overview:
Add the given key-value pair to the other config field of the given PCI.
Signature:
void add_to_other_config (session_id s, PCI ref self, string key, string value)

PCI ref self reference to the object

Return Type: PCI record

all fields from the object

503
2.47. CLASS: PGPU CHAPTER 2. API REFERENCE

2.47 Class: PGPU

2.47.1 Fields for class: PGPU

Name PGPU
Description A physical GPU (pGPU).
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO ins PCI PCI ref Link to underlying PCI device
RO ins GPU group GPU group ref GPU group the pGPU is contained in
RO run host host ref Host that own the GPU
RW other config (string string) map Additional configuration
RO run supported VGPU types VGPU type ref set List of VGPU types supported by the un-
derlying hardware
RO run enabled VGPU types VGPU type ref set List of VGPU types which have been en-
abled for this PGPU
RO run resident VGPUs VGPU ref set List of VGPUs running on this PGPU
RO run supported VGPU max capacities (VGPU type ref int) map A map relating each VGPU type supported
on this GPU to the maximum number of
VGPUs of that type which can run simul-
taneously on this GPU
RO run dom0 access pgpu dom0 access The accessibility of this device from dom0
RO run is system display device bool Is this device the system display device

2.47.2 RPCs associated with class: PGPU

RPC name: add enabled VGPU types
Overview:
.
Signature:
void add_enabled_VGPU_types (session_id s, PGPU ref self, VGPU_type ref value)
Arguments:

type name description

PGPU ref self The PGPU to which we are adding an enabled
VGPU type
VGPU type ref value The VGPU type to enable

Return Type: void

RPC name: remove enabled VGPU types

Overview:
.
Signature:

void remove_enabled_VGPU_types (session_id s, PGPU ref self, VGPU_type ref value)

504
2.47. CLASS: PGPU CHAPTER 2. API REFERENCE

Arguments:

type name description

PGPU ref self The PGPU from which we are removing an
enabled VGPU type
VGPU type ref value The VGPU type to disable

Return Type: void

RPC name: set enabled VGPU types

Overview:
.
Signature:
void set_enabled_VGPU_types (session_id s, PGPU ref self, VGPU_type ref set value)
Arguments:

type name description

PGPU ref self The PGPU on which we are enabling a set of
VGPU types
VGPU type ref set value The VGPU types to enable

Return Type: void

RPC name: set GPU group

Overview:
.
Signature:
void set_GPU_group (session_id s, PGPU ref self, GPU_group ref value)
Arguments:

type name description

PGPU ref self The PGPU to move to a new group
GPU group ref value The group to which the PGPU will be moved

Return Type: void

Return Type: pgpu dom0 access

The accessibility of this PGPU from dom0

RPC name: add to other config

Overview:
Add the given key-value pair to the other config field of the given PGPU.
Signature:
void add_to_other_config (session_id s, PGPU ref self, string key, string value)
Arguments:

type name description

PGPU ref self reference to the object
string key Key to add
string value Value to add

Return Type: void

RPC name: remove from other config

Overview:
Remove the given key and its corresponding value from the other config field of the given PGPU. If the key is
not in that Map, then do nothing.
Signature:
void remove_from_other_config (session_id s, PGPU ref self, string key)

509
2.47. CLASS: PGPU CHAPTER 2. API REFERENCE

Arguments:

type name description

PGPU ref self reference to the object
string key Key to remove

Return Type: void

Return Type: PGPU record

all fields from the object

512
2.48. CLASS: GPU GROUP CHAPTER 2. API REFERENCE

2.48 Class: GPU group

2.48.1 Fields for class: GPU group

Overview:
Return a list of all the GPU groups known to the system.
Signature:
(GPU_group ref set) get_all (session_id s)

Return Type: GPU group ref set

references to all objects

RPC name: get all records

Overview:
Return a map of GPU group references to GPU group records for all GPU groups known to the system.
Signature:
((GPU_group ref -> GPU_group record) map) get_all_records (session_id s)

Return Type: (GPU group ref GPU group record) map

GPU group ref self reference to the object

Return Type: VGPU ref set

value of the field

RPC name: get GPU types

Overview:
Get the GPU types field of the given GPU group.
Signature:
(string set) get_GPU_types (session_id s, GPU_group ref self)
Arguments:

type name description

GPU group ref self reference to the object

Return Type: string set

value of the field

RPC name: get other config

Return Type: void

518
2.48. CLASS: GPU GROUP CHAPTER 2. API REFERENCE

RPC name: get allocation algorithm

Overview:
Get the allocation algorithm field of the given GPU group.
Signature:
(allocation_algorithm) get_allocation_algorithm (session_id s, GPU_group ref self)
Arguments:

type name description

GPU group ref self reference to the object

Return Type: allocation algorithm

value of the field

GPU group ref self reference to the object

Return Type: VGPU type ref set

value of the field

RPC name: get by uuid

Overview:
Get a reference to the GPU group instance with the specified UUID.
Signature:
(GPU_group ref) get_by_uuid (session_id s, string uuid)
Arguments:

type name description

string uuid UUID of object to return

Return Type: GPU group ref

reference to the object

RPC name: get record

Overview:
Get a record containing the current state of the given GPU group.
Signature:
(GPU_group record) get_record (session_id s, GPU_group ref self)
Arguments:

type name description

GPU group ref self reference to the object

Return Type: GPU group record

all fields from the object

520
2.48. CLASS: GPU GROUP CHAPTER 2. API REFERENCE

RPC name: get by name label

Overview:
Get all the GPU group instances with the given label.
Signature:
(GPU_group ref set) get_by_name_label (session_id s, string label)
Arguments:

type name description

string label label of object to return

Return Type: GPU group ref set

references to objects with matching names

521
2.49. CLASS: VGPU CHAPTER 2. API REFERENCE

2.49 Class: VGPU

2.49.1 Fields for class: VGPU

Name VGPU
Description A virtual GPU (vGPU).
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO run VM VM ref VM that owns the vGPU
RO run GPU group GPU group ref GPU group used by the vGPU
RO run device string Order in which the devices are plugged into
the VM
RO run currently attached bool Reflects whether the virtual device is cur-
rently connected to a physical device
RW other config (string string) map Additional configuration
RO run type VGPU type ref Preset type for this VGPU
RO run resident on PGPU ref The PGPU on which this VGPU is running

2.49.2 RPCs associated with class: VGPU

RPC name: create
Overview:
.
Signature:
(VGPU ref) create (session_id s, VM ref VM, GPU_group ref GPU_group, string device, (string -> string) map
Arguments:

type name description

VM ref VM
GPU group ref GPU group
string device
(string string) map other config
VGPU type ref type

Return Type: VGPU ref

reference to the newly created object

RPC name: destroy

Overview:
.
Signature:
void destroy (session_id s, VGPU ref self)
Arguments:

type name description

VGPU ref self The vGPU to destroy

522
2.49. CLASS: VGPU CHAPTER 2. API REFERENCE

Return Type: void

RPC name: get all

Overview:
Return a list of all the VGPUs known to the system.
Signature:
(VGPU ref set) get_all (session_id s)

Return Type: VGPU ref set

references to all objects

RPC name: get all records

Overview:
Return a map of VGPU references to VGPU records for all VGPUs known to the system.
Signature:
((VGPU ref -> VGPU record) map) get_all_records (session_id s)

Return Type: (VGPU ref VGPU record) map

records of all objects

RPC name: get uuid

Overview:
Get the uuid field of the given VGPU.
Signature:
string get_uuid (session_id s, VGPU ref self)
Arguments:

type name description

VGPU ref self reference to the object

Return Type: string

Return Type: string

Return Type: void

RPC name: remove from other config

Overview:
Remove the given key and its corresponding value from the other config field of the given VGPU. If the key is
not in that Map, then do nothing.
Signature:
void remove_from_other_config (session_id s, VGPU ref self, string key)

Arguments:

type name description

VGPU ref self reference to the object
string key Key to remove

Return Type: void

RPC name: get type

Overview:
Get the type field of the given VGPU.
Signature:
(VGPU_type ref) get_type (session_id s, VGPU ref self)
Arguments:

type name description

VGPU ref self reference to the object

Return Type: VGPU type ref

Return Type: VGPU record

all fields from the object

527
2.50. CLASS: VGPU TYPE CHAPTER 2. API REFERENCE

2.50 Class: VGPU type

2.50.1 Fields for class: VGPU type

Name VGPU type

Description A type of virtual GPU.
Quals Field Type Description
RO run uuid string Unique identifier/object reference
RO ins vendor name string Name of VGPU vendor
RO ins model name string Model name associated with the VGPU
type
RO ins framebuffer size int Framebuffer size of the VGPU type, in
bytes
RO ins max heads int Maximum number of displays supported
by the VGPU type
RO ins max resolution x int Maximum resolution (width) supported by
the VGPU type
RO ins max resolution y int Maximum resolution (height) supported
by the VGPU type
RO run supported on PGPUs PGPU ref set List of PGPUs that support this VGPU
type
RO run enabled on PGPUs PGPU ref set List of PGPUs that have this VGPU type
enabled
RO run VGPUs VGPU ref set List of VGPUs of this type
RO run supported on GPU groups GPU group ref set List of GPU groups in which at least one
PGPU supports this VGPU type
RO run enabled on GPU groups GPU group ref set List of GPU groups in which at least one
have this VGPU type enabled
RO ins implementation vgpu type implementation The internal implementation of this VGPU
type
RO ins identifier string Key used to identify VGPU types and
avoid creating duplicates - this field is used
internally and not intended for interpreta-
tion by API clients
RO ins experimental bool Indicates whether VGPUs of this type
should be considered experimental

2.50.2 RPCs associated with class: VGPU type

RPC name: get all
Overview:
Return a list of all the VGPU types known to the system.
Signature:
(VGPU_type ref set) get_all (session_id s)

Return Type: VGPU type ref set

references to all objects

528
2.50. CLASS: VGPU TYPE CHAPTER 2. API REFERENCE

RPC name: get all records

Overview:
Return a map of VGPU type references to VGPU type records for all VGPU types known to the system.
Signature:
((VGPU_type ref -> VGPU_type record) map) get_all_records (session_id s)

Return Type: (VGPU type ref VGPU type record) map

records of all objects

RPC name: get uuid

Overview:
Get the uuid field of the given VGPU type.
Signature:
string get_uuid (session_id s, VGPU_type ref self)
Arguments:

type name description

VGPU type ref self reference to the object

Return Type: string

value of the field

RPC name: get vendor name

Overview:
Get the vendor name field of the given VGPU type.
Signature:
string get_vendor_name (session_id s, VGPU_type ref self)
Arguments:

type name description

VGPU type ref self reference to the object

Return Type: string

value of the field

RPC name: get model name

Overview:
Get the model name field of the given VGPU type.
Signature:

2.51 Error Handling

When a low-level transport error occurs, or a request is malformed at the HTTP or XML-RPC level, the server
may send an XML-RPC Fault response, or the client may simulate the same. The client must be prepared to
handle these errors, though they may be treated as fatal. On the wire, these are transmitted in a form similar
to this:
<methodResponse>
<fault>
<value>
<struct>
<member>
<name>faultCode</name>
<value><int>-1</int></value>
</member>
<member>
<name>faultString</name>
<value><string>Malformed request</string></value>
</member>
</struct>
</value>
</fault>
</methodResponse>
All other failures are reported with a more structured error response, to allow better automatic response to fail-
ures, proper internationalisation of any error message, and easier debugging. On the wire, these are transmitted
like this:
<struct>
<member>
<name>Status</name>
<value>Failure</value>
</member>
<member>
<name>ErrorDescription</name>
<value>
<array>
<data>
<value>MAP_DUPLICATE_KEY</value>
<value>Customer</value>
<value>eSpeil Inc.</value>
<value>eSpeil Incorporated</value>
</data>
</array>
</value>
</member>
</struct>
Note that ErrorDescription value is an array of string values. The first element of the array is an error code;
the remainder of the array are strings representing error parameters relating to that code. In this case, the client
has attempted to add the mapping Customer eSpiel Incorporated to a Map, but it already contains the
mapping Customer eSpiel Inc., and so the request has failed.
Each possible error code is documented in the following section.

535
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

2.51.1 Error Codes

ACTIVATION WHILE NOT FREE
An activation key can only be applied when the edition is set to free.

No parameters.

ADDRESS VIOLATES LOCKING CONSTRAINT

The specified IP address violates the VIF locking configuration.

Signature:
ADDRESS_VIOLATES_LOCKING_CONSTRAINT(address)

AUTH ALREADY ENABLED

External authentication for this host is already enabled.

Signature:
AUTH_ALREADY_ENABLED(current auth_type, current service_name)

AUTH DISABLE FAILED

The host failed to disable external authentication.

Signature:
AUTH_DISABLE_FAILED(message)

AUTH DISABLE FAILED PERMISSION DENIED

The host failed to disable external authentication.

Signature:
AUTH_DISABLE_FAILED_PERMISSION_DENIED(message)

AUTH DISABLE FAILED WRONG CREDENTIALS

The host failed to disable external authentication.

Signature:
AUTH_DISABLE_FAILED_WRONG_CREDENTIALS(message)

536
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

AUTH ENABLE FAILED

The host failed to enable external authentication.

Signature:
AUTH_ENABLE_FAILED(message)

AUTH ENABLE FAILED DOMAIN LOOKUP FAILED

The host failed to enable external authentication.

Signature:
AUTH_ENABLE_FAILED_DOMAIN_LOOKUP_FAILED(message)

AUTH ENABLE FAILED PERMISSION DENIED

The host failed to enable external authentication.

Signature:
AUTH_ENABLE_FAILED_PERMISSION_DENIED(message)

AUTH ENABLE FAILED UNAVAILABLE

The host failed to enable external authentication.

Signature:
AUTH_ENABLE_FAILED_UNAVAILABLE(message)

AUTH ENABLE FAILED WRONG CREDENTIALS

The host failed to enable external authentication.

Signature:
AUTH_ENABLE_FAILED_WRONG_CREDENTIALS(message)

AUTH IS DISABLED
External authentication is disabled, unable to resolve subject name.

No parameters.

537
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

AUTH SERVICE ERROR

Error querying the external directory service.

Signature:
AUTH_SERVICE_ERROR(message)

AUTH UNKNOWN TYPE

Unknown type of external authentication.

Signature:
AUTH_UNKNOWN_TYPE(type)

BACKUP SCRIPT FAILED

The backup could not be performed because the backup script failed.

Signature:
BACKUP_SCRIPT_FAILED(log)

BOOTLOADER FAILED
The bootloader returned an error

Signature:
BOOTLOADER_FAILED(vm, msg)

BRIDGE NOT AVAILABLE

Could not find bridge required by VM.

Signature:
BRIDGE_NOT_AVAILABLE(bridge)

CANNOT ADD TUNNEL TO BOND SLAVE

This PIF is a bond slave and cannot have a tunnel on it.

Signature:
CANNOT_ADD_TUNNEL_TO_BOND_SLAVE(PIF)

538
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

CANNOT ADD VLAN TO BOND SLAVE

This PIF is a bond slave and cannot have a VLAN on it.

Signature:
CANNOT_ADD_VLAN_TO_BOND_SLAVE(PIF)

CANNOT CHANGE PIF PROPERTIES

This properties of this PIF cannot be changed. Only the properties of non-bonded physical PIFs, or bond
masters can be changed.

Signature:
CANNOT_CHANGE_PIF_PROPERTIES(PIF)

CANNOT CONTACT HOST

Cannot forward messages because the host cannot be contacted. The host may be switched off or there may be
network connectivity problems.

Signature:
CANNOT_CONTACT_HOST(host)

CANNOT CREATE STATE FILE

An HA statefile could not be created, perhaps because no SR with the appropriate capability was found.

No parameters.

CANNOT DESTROY DISASTER RECOVERY TASK

The disaster recovery task could not be cleanly destroyed.

Signature:
CANNOT_DESTROY_DISASTER_RECOVERY_TASK(reason)

CANNOT DESTROY SYSTEM NETWORK

You tried to destroy a system network: these cannot be destroyed.

Signature:
CANNOT_DESTROY_SYSTEM_NETWORK(network)

539
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

CANNOT ENABLE REDO LOG

Could not enable redo log.

Signature:
CANNOT_ENABLE_REDO_LOG(reason)

CANNOT EVACUATE HOST

This host cannot be evacuated.

Signature:
CANNOT_EVACUATE_HOST(errors)

CANNOT FETCH PATCH

The requested update could to be obtained from the master.

Signature:
CANNOT_FETCH_PATCH(uuid)

CANNOT FIND OEM BACKUP PARTITION

The backup partition to stream the updat to cannot be found

No parameters.

CANNOT FIND PATCH

The requested update could not be found. This can occur when you designate a new master or xe patch-clean.
Please upload the update again

No parameters.

CANNOT FIND STATE PARTITION

This operation could not be performed because the state partition could not be found

No parameters.

540
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

CANNOT PLUG BOND SLAVE

This PIF is a bond slave and cannot be plugged.

Signature:
CANNOT_PLUG_BOND_SLAVE(PIF)

CANNOT PLUG VIF

Cannot plug VIF

Signature:
CANNOT_PLUG_VIF(VIF)

CANNOT RESET CONTROL DOMAIN

The power-state of a control domain cannot be reset.

Signature:
CANNOT_RESET_CONTROL_DOMAIN(vm)

CERTIFICATE ALREADY EXISTS

A certificate already exists with the specified name.

Signature:
CERTIFICATE_ALREADY_EXISTS(name)

CERTIFICATE CORRUPT
The specified certificate is corrupt or unreadable.

Signature:
CERTIFICATE_CORRUPT(name)

CERTIFICATE DOES NOT EXIST

The specified certificate does not exist.

Signature:
CERTIFICATE_DOES_NOT_EXIST(name)

541
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

CERTIFICATE LIBRARY CORRUPT

The certificate library is corrupt or unreadable.

No parameters.

CERTIFICATE NAME INVALID

The specified certificate name is invalid.

Signature:
CERTIFICATE_NAME_INVALID(name)

CHANGE PASSWORD REJECTED

The system rejected the password change request; perhaps the new password was too short?

Signature:
CHANGE_PASSWORD_REJECTED(msg)

CLUSTERED SR DEGRADED
An SR is using clustered local storage. It is not safe to reboot a host at the moment.

Signature:
CLUSTERED_SR_DEGRADED(sr)

COULD NOT FIND NETWORK INTERFACE WITH SPECIFIED DEVICE NAME AND MAC ADDRESS
Could not find a network interface with the specified device name and MAC address.

Signature:
COULD_NOT_FIND_NETWORK_INTERFACE_WITH_SPECIFIED_DEVICE_NAME_AND_MAC_ADDRESS(device, mac)

COULD NOT IMPORT DATABASE

An error occurred while attempting to import a database from a metadata VDI

Signature:
COULD_NOT_IMPORT_DATABASE(reason)

542
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

CPU FEATURE MASKING NOT SUPPORTED

The CPU does not support masking of features.

Signature:
CPU_FEATURE_MASKING_NOT_SUPPORTED(details)

CRL ALREADY EXISTS

A CRL already exists with the specified name.

Signature:
CRL_ALREADY_EXISTS(name)

CRL CORRUPT
The specified CRL is corrupt or unreadable.

Signature:
CRL_CORRUPT(name)

CRL DOES NOT EXIST

The specified CRL does not exist.

Signature:
CRL_DOES_NOT_EXIST(name)

CRL NAME INVALID

The specified CRL name is invalid.

Signature:
CRL_NAME_INVALID(name)

DB UNIQUENESS CONSTRAINT VIOLATION

You attempted an operation which would have resulted in duplicate keys in the database.

Signature:
DB_UNIQUENESS_CONSTRAINT_VIOLATION(table, field, value)

543
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

DEFAULT SR NOT FOUND

The default SR reference does not point to a valid SR

Signature:
DEFAULT_SR_NOT_FOUND(sr)

DEVICE ALREADY ATTACHED

The device is already attached to a VM

Signature:
DEVICE_ALREADY_ATTACHED(device)

DEVICE ALREADY DETACHED

The device is not currently attached

Signature:
DEVICE_ALREADY_DETACHED(device)

DEVICE ALREADY EXISTS

A device with the name given already exists on the selected VM

Signature:
DEVICE_ALREADY_EXISTS(device)

DEVICE ATTACH TIMEOUT

A timeout happened while attempting to attach a device to a VM.

Signature:
DEVICE_ATTACH_TIMEOUT(type, ref)

DEVICE DETACH REJECTED

The VM rejected the attempt to detach the device.

Signature:
DEVICE_DETACH_REJECTED(type, ref, msg)

544
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

DEVICE DETACH TIMEOUT

A timeout happened while attempting to detach a device from a VM.

Signature:
DEVICE_DETACH_TIMEOUT(type, ref)

DEVICE NOT ATTACHED

The operation could not be performed because the VBD was not connected to the VM.

Signature:
DEVICE_NOT_ATTACHED(VBD)

DISK VBD MUST BE READWRITE FOR HVM

All VBDs of type disk must be read/write for HVM guests

Signature:
DISK_VBD_MUST_BE_READWRITE_FOR_HVM(vbd)

DOMAIN BUILDER ERROR

An internal error generated by the domain builder.

Signature:
DOMAIN_BUILDER_ERROR(function, code, message)

DOMAIN EXISTS
The operation could not be performed because a domain still exists for the specified VM.

Signature:
DOMAIN_EXISTS(vm, domid)

DUPLICATE MAC SEED

This MAC seed is already in use by a VM in the pool

Signature:
DUPLICATE_MAC_SEED(seed)

545
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

DUPLICATE PIF DEVICE NAME

A PIF with this specified device name already exists.

Signature:
DUPLICATE_PIF_DEVICE_NAME(device)

DUPLICATE VM
Cannot restore this VM because it would create a duplicate

Signature:
DUPLICATE_VM(vm)

EVENTS LOST
Some events have been lost from the queue and cannot be retrieved.

No parameters.

EVENT FROM TOKEN PARSE FAILURE

The event.from token could not be parsed. Valid values include: , and a value returned from a previous
event.from call.

Signature:
EVENT_FROM_TOKEN_PARSE_FAILURE(token)

EVENT SUBSCRIPTION PARSE FAILURE

The server failed to parse your event subscription. Valid values include: *, class-name, class-name/object-
reference.

Signature:
EVENT_SUBSCRIPTION_PARSE_FAILURE(subscription)

FAILED TO START EMULATOR

An emulator required to run this VM failed to start

Signature:
FAILED_TO_START_EMULATOR(vm, name, msg)

546
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

FEATURE REQUIRES HVM

The VM is set up to use a feature that requires it to boot as HVM.

Signature:
FEATURE_REQUIRES_HVM(details)

FEATURE RESTRICTED
The use of this feature is restricted.

No parameters.

FIELD TYPE ERROR

The value specified is of the wrong type

Signature:
FIELD_TYPE_ERROR(field)

GPU GROUP CONTAINS NO PGPUS

The GPU group does not contain any PGPUs.

Signature:
GPU_GROUP_CONTAINS_NO_PGPUS(gpu_group)

GPU GROUP CONTAINS PGPU

The GPU group contains active PGPUs and cannot be deleted.

Signature:
GPU_GROUP_CONTAINS_PGPU(pgpus)

GPU GROUP CONTAINS VGPU

The GPU group contains active VGPUs and cannot be deleted.

Signature:
GPU_GROUP_CONTAINS_VGPU(vgpus)

547
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

HANDLE INVALID
You gave an invalid object reference. The object may have recently been deleted. The class parameter gives the
type of reference given, and the handle parameter echoes the bad value given.

Signature:
HANDLE_INVALID(class, handle)

HA ABORT NEW MASTER

This host cannot accept the proposed new master setting at this time.

Signature:
HA_ABORT_NEW_MASTER(reason)

HA CANNOT CHANGE BOND STATUS OF MGMT IFACE

This operation cannot be performed because creating or deleting a bond involving the management interface is
not allowed while HA is on. In order to do that, disable HA, create or delete the bond then re-enable HA.

No parameters.

HA CONSTRAINT VIOLATION NETWORK NOT SHARED

This operation cannot be performed because the referenced network is not properly shared. The network must
either be entirely virtual or must be physically present via a currently attached PIF on every host.

Signature:
HA_CONSTRAINT_VIOLATION_NETWORK_NOT_SHARED(network)

HA CONSTRAINT VIOLATION SR NOT SHARED

This operation cannot be performed because the referenced SR is not properly shared. The SR must both be
marked as shared and a currently attached PBD must exist for each host.

Signature:
HA_CONSTRAINT_VIOLATION_SR_NOT_SHARED(SR)

HA DISABLE IN PROGRESS
The operation could not be performed because HA disable is in progress

No parameters.

548
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

HA ENABLE IN PROGRESS
The operation could not be performed because HA enable is in progress

No parameters.

HA FAILED TO FORM LIVESET

HA could not be enabled on the Pool because a liveset could not be formed: check storage and network heartbeat
paths.

No parameters.

HA HEARTBEAT DAEMON STARTUP FAILED

The host could not join the liveset because the HA daemon failed to start.

No parameters.

HA HOST CANNOT ACCESS STATEFILE

The host could not join the liveset because the HA daemon could not access the heartbeat disk.

No parameters.

HA HOST CANNOT SEE PEERS

The operation failed because the HA software on the specified host could not see a subset of other hosts. Check
your network connectivity.

Signature:
HA_HOST_CANNOT_SEE_PEERS(host, all, subset)

HA HOST IS ARMED
The operation could not be performed while the host is still armed; it must be disarmed first

Signature:
HA_HOST_IS_ARMED(host)

549
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

HA IS ENABLED
The operation could not be performed because HA is enabled on the Pool

No parameters.

HA LOST STATEFILE
This host lost access to the HA statefile.

No parameters.

HA NOT ENABLED
The operation could not be performed because HA is not enabled on the Pool

No parameters.

HA NOT INSTALLED
The operation could not be performed because the HA software is not installed on this host.

Signature:
HA_NOT_INSTALLED(host)

The hosts in this pool are not homogeneous.

Signature:
HOSTS_NOT_HOMOGENEOUS(reason)

HOST BROKEN
This host failed in the middle of an automatic failover operation and needs to retry the failover action

No parameters.

HOST CANNOT ATTACH NETWORK

Host cannot attach network (in the case of NIC bonding, this may be because attaching the network on this
host would require other networks [that are currently active] to be taken down).

Signature:
HOST_CANNOT_ATTACH_NETWORK(host, network)

551
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

HOST CANNOT DESTROY SELF

The pool master host cannot be removed.

Signature:
HOST_CANNOT_DESTROY_SELF(host)

HOST CANNOT READ METRICS

The metrics of this host could not be read.

No parameters.

HOST CD DRIVE EMPTY

INCOMPATIBLE CLUSTER STACK ACTIVE

This operation cannot be performed, because it is incompatible with the currently active HA cluster stack.

Signature:
INCOMPATIBLE_CLUSTER_STACK_ACTIVE(cluster_stack)

INCOMPATIBLE PIF PROPERTIES

These PIFs can not be bonded, because their properties are different.

No parameters.

INCOMPATIBLE STATEFILE SR
The specified SR is incompatible with the selected HA cluster stack.

Signature:
INCOMPATIBLE_STATEFILE_SR(SR type)

INTERFACE HAS NO IP
The specified interface cannot be used because it has no IP address

Signature:
INTERFACE_HAS_NO_IP(interface)

INTERNAL ERROR
The server failed to handle your request, due to an internal error. The given message may give details useful for
debugging the problem.

Signature:
INTERNAL_ERROR(message)

INVALID CIDR ADDRESS SPECIFIED

A required parameter contained an invalid CIDR address (addr/prefix length)

Signature:
INVALID_CIDR_ADDRESS_SPECIFIED(parameter)

557
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

INVALID DEVICE
The device name is invalid

Signature:
INVALID_DEVICE(device)

INVALID EDITION
The edition you supplied is invalid.

Signature:
INVALID_EDITION(edition)

INVALID FEATURE STRING

The given feature string is not valid.

Signature:
INVALID_FEATURE_STRING(details)

INVALID IP ADDRESS SPECIFIED

A required parameter contained an invalid IP address

Signature:
INVALID_IP_ADDRESS_SPECIFIED(parameter)

INVALID PATCH
The uploaded patch file is invalid

No parameters.

INVALID PATCH WITH LOG

The uploaded patch file is invalid. See attached log for more details.

Signature:
INVALID_PATCH_WITH_LOG(log)

558
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

The host joining the pool cannot have any VMs with active tasks.

No parameters.

559
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

JOINING HOST CONNECTION FAILED

There was an error connecting to the host while joining it in the pool.

No parameters.

JOINING HOST SERVICE FAILED

There was an error connecting to the host. the service contacted didnt reply properly.

No parameters.

LICENCE RESTRICTION
This operation is not allowed because your license lacks a needed feature. Please contact your support repre-
sentative.

Signature:
LICENCE_RESTRICTION(feature)

LICENSE CANNOT DOWNGRADE WHILE IN POOL

Cannot downgrade license while in pool. Please disband the pool first, then downgrade licenses on hosts sepa-
rately.

No parameters.

LICENSE CHECKOUT ERROR

The license for the edition you requested is not available.

Signature:
LICENSE_CHECKOUT_ERROR(reason)

LICENSE DOES NOT SUPPORT POOLING

This host cannot join a pool because its license does not support pooling.

No parameters.

560
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

LICENSE DOES NOT SUPPORT XHA

XHA cannot be enabled because this hosts license does not allow it.

No parameters.

You tried to add a key-value pair to a map, but that key is already there.

Signature:
MAP_DUPLICATE_KEY(type, param_name, uuid, key)

MESSAGE DEPRECATED
This message has been deprecated.

No parameters.

MESSAGE METHOD UNKNOWN

You tried to call a method that does not exist. The method name that you used is echoed.

Signature:
MESSAGE_METHOD_UNKNOWN(method)

MESSAGE PARAMETER COUNT MISMATCH

You tried to call a method with the incorrect number of parameters. The fully-qualified method name that you
used, and the number of received and expected parameters are returned.

Signature:
MESSAGE_PARAMETER_COUNT_MISMATCH(method, expected, received)

562
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

MESSAGE REMOVED
This function is no longer available.

No parameters.

MIRROR FAILED
The VDI mirroring cannot be performed

Signature:
MIRROR_FAILED(vdi)

MISSING CONNECTION DETAILS

The license-server connection details (address or port) were missing or incomplete.

No parameters.

NETWORK ALREADY CONNECTED

You tried to create a PIF, but the network you tried to attach it to is already attached to some other PIF, and
so the creation failed.

Signature:
NETWORK_ALREADY_CONNECTED(network, connected PIF)

NETWORK CONTAINS PIF

The network contains active PIFs and cannot be deleted.

Signature:
NETWORK_CONTAINS_PIF(pifs)

NETWORK CONTAINS VIF

The network contains active VIFs and cannot be deleted.

Signature:
NETWORK_CONTAINS_VIF(vifs)

563
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

NOT ALLOWED ON OEM EDITION

This command is not allowed on the OEM edition.

Signature:
NOT_ALLOWED_ON_OEM_EDITION(command)

This operation needs the OpenVSwitch networking backend to be enabled on all hosts in the pool.

No parameters.

OPERATION BLOCKED
You attempted an operation that was explicitly blocked (see the blocked operations field of the given object).

Signature:
OPERATION_BLOCKED(ref, code)

OPERATION NOT ALLOWED

You attempted an operation that was not allowed.

Signature:
OPERATION_NOT_ALLOWED(reason)

565
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

OPERATION PARTIALLY FAILED

Some VMs belonging to the appliance threw an exception while carrying out the specified operation

Signature:
OPERATION_PARTIALLY_FAILED(operation)

OTHER OPERATION IN PROGRESS

Another operation involving the object is currently in progress

Signature:
OTHER_OPERATION_IN_PROGRESS(class, object)

OUT OF SPACE
There is not enough space to upload the update

Signature:
OUT_OF_SPACE(location)

PATCH ALREADY APPLIED

This patch has already been applied

Signature:
PATCH_ALREADY_APPLIED(patch)

PATCH ALREADY EXISTS

The uploaded patch file already exists

Signature:
PATCH_ALREADY_EXISTS(uuid)

PATCH APPLY FAILED

The patch apply failed. Please see attached output.

Signature:
PATCH_APPLY_FAILED(output)

566
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

PATCH APPLY FAILED BACKUP FILES EXIST

The patch apply failed: there are backup files created while applying patch. Please remove these backup files
before applying patch again.

Signature:
PATCH_APPLY_FAILED_BACKUP_FILES_EXIST(output)

PATCH IS APPLIED
The specified patch is applied and cannot be destroyed.

No parameters.

PATCH PRECHECK FAILED ISO MOUNTED

Tools ISO must be ejected from all running VMs.

Signature:
PATCH_PRECHECK_FAILED_ISO_MOUNTED(patch)

PATCH PRECHECK FAILED OUT OF SPACE

The patch precheck stage failed: the server does not have enough space.

Signature:
PATCH_PRECHECK_FAILED_OUT_OF_SPACE(patch, found_space, required_required)

PATCH PRECHECK FAILED PREREQUISITE MISSING

The patch precheck stage failed: prerequisite patches are missing.

Signature:
PATCH_PRECHECK_FAILED_PREREQUISITE_MISSING(patch, prerequisite_patch_uuid_list)

PATCH PRECHECK FAILED UNKNOWN ERROR

The patch precheck stage failed with an unknown error. See attached info for more details.

Signature:
PATCH_PRECHECK_FAILED_UNKNOWN_ERROR(patch, info)

567
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

PATCH PRECHECK FAILED VM RUNNING

The patch precheck stage failed: there are one or more VMs still running on the server. All VMs must be
suspended before the patch can be applied.

Signature:
PATCH_PRECHECK_FAILED_VM_RUNNING(patch)

PATCH PRECHECK FAILED WRONG SERVER BUILD

The patch precheck stage failed: the server is of an incorrect build.

Signature:
PATCH_PRECHECK_FAILED_WRONG_SERVER_BUILD(patch, found_build, required_build)

PATCH PRECHECK FAILED WRONG SERVER VERSION

The patch precheck stage failed: the server is of an incorrect version.

Signature:
PATCH_PRECHECK_FAILED_WRONG_SERVER_VERSION(patch, found_version, required_version)

PBD EXISTS
A PBD already exists connecting the SR to the host

Signature:
PBD_EXISTS(sr, host, pbd)

PERMISSION DENIED
Caller not allowed to perform this operation.

Signature:
PERMISSION_DENIED(message)

PGPU INSUFFICIENT CAPACITY FOR VGPU

There is insufficient capacity on this PGPU to run the VGPU.

Signature:
PGPU_INSUFFICIENT_CAPACITY_FOR_VGPU(pgpu, vgpu_type)

568
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

PIF IS VLAN
You tried to create a VLAN on top of another VLAN - use the underlying physical PIF/bond instead

Signature:
PIF_IS_VLAN(PIF)

PIF TUNNEL STILL EXISTS

Operation cannot proceed while a tunnel exists on this interface.

Signature:
PIF_TUNNEL_STILL_EXISTS(PIF)

PIF UNMANAGED
The operation you requested cannot be performed because the specified PIF is not managed by xapi.

Signature:
PIF_UNMANAGED(PIF)

PIF VLAN EXISTS

You tried to create a PIF, but it already exists.

Signature:
PIF_VLAN_EXISTS(PIF)

PIF VLAN STILL EXISTS

Operation cannot proceed while a VLAN exists on this interface.

Signature:
PIF_VLAN_STILL_EXISTS(PIF)

571
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

POOL AUTH ALREADY ENABLED

External authentication in this pool is already enabled for at least one host.

Signature:
POOL_AUTH_ALREADY_ENABLED(host)

POOL AUTH DISABLE FAILED

The pool failed to disable the external authentication of at least one host.

Signature:
POOL_AUTH_DISABLE_FAILED(host, message)

POOL AUTH DISABLE FAILED PERMISSION DENIED

The pool failed to disable the external authentication of at least one host.

Signature:
POOL_AUTH_DISABLE_FAILED_PERMISSION_DENIED(host, message)

POOL AUTH DISABLE FAILED WRONG CREDENTIALS

The pool failed to disable the external authentication of at least one host.

Signature:
POOL_AUTH_DISABLE_FAILED_WRONG_CREDENTIALS(host, message)

POOL AUTH ENABLE FAILED

The pool failed to enable external authentication.

Signature:
POOL_AUTH_ENABLE_FAILED(host, message)

POOL AUTH ENABLE FAILED DOMAIN LOOKUP FAILED

The pool failed to enable external authentication.

Signature:
POOL_AUTH_ENABLE_FAILED_DOMAIN_LOOKUP_FAILED(host, message)

572
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

POOL AUTH ENABLE FAILED DUPLICATE HOSTNAME

The pool failed to enable external authentication.

Signature:
POOL_AUTH_ENABLE_FAILED_DUPLICATE_HOSTNAME(host, message)

POOL AUTH ENABLE FAILED INVALID OU

The pool failed to enable external authentication.

Signature:
POOL_AUTH_ENABLE_FAILED_INVALID_OU(host, message)

POOL AUTH ENABLE FAILED PERMISSION DENIED

The pool failed to enable external authentication.

Signature:
POOL_AUTH_ENABLE_FAILED_PERMISSION_DENIED(host, message)

POOL AUTH ENABLE FAILED WRONG CREDENTIALS

The pool failed to enable external authentication.

Signature:
POOL_AUTH_ENABLE_FAILED_WRONG_CREDENTIALS(host, message)

POOL JOINING EXTERNAL AUTH MISMATCH

Cannot join pool whose external authentication configuration is different.

No parameters.

POOL JOINING HOST MUST HAVE PHYSICAL MANAGEMENT NIC

The host joining the pool must have a physical management NIC (i.e. the management NIC must not be on a
VLAN or bonded PIF).

SR ATTACH FAILED
Attaching this SR failed.

Signature:
SR_ATTACH_FAILED(sr)

SR BACKEND FAILURE
There was an SR backend failure.

Signature:
SR_BACKEND_FAILURE(status, stdout, stderr)

576
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

SR DEVICE IN USE
The SR operation cannot be performed because a device underlying the SR is in use by the host.

No parameters.

SR DOES NOT SUPPORT MIGRATION

You attempted to migrate a VDI on SR which doesnt have snapshot capability

Signature:
SR_DOES_NOT_SUPPORT_MIGRATION(sr)

SR FULL
The SR is full. Requested new size exceeds the maximum size

Signature:
SR_FULL(requested, maximum)

SR HAS MULTIPLE PBDS

The SR.shared flag cannot be set to false while the SR remains connected to multiple hosts

Signature:
SR_HAS_MULTIPLE_PBDS(PBD)

SR HAS NO PBDS
The SR has no attached PBDs

Signature:
SR_HAS_NO_PBDS(sr)

SR HAS PBD
The SR is still connected to a host via a PBD. It cannot be destroyed or forgotten.

Signature:
SR_HAS_PBD(sr)

577
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

SR INDESTRUCTIBLE
The SR could not be destroyed, as the indestructible flag was set on it.

Signature:
SR_INDESTRUCTIBLE(sr)

SR IS CACHE SR
The SR is currently being used as a local cache SR.

Signature:
SR_IS_CACHE_SR(host)

SR NOT ATTACHED
The SR is not attached.

Signature:
SR_NOT_ATTACHED(sr)

SR NOT EMPTY
The SR operation cannot be performed because the SR is not empty.

No parameters.

SR NOT SHARABLE
The PBD could not be plugged because the SR is in use by another host and is not marked as sharable.

Signature:
SR_NOT_SHARABLE(sr, host)

SR OPERATION NOT SUPPORTED

The SR backend does not support the operation (check the SRs allowed operations)

Signature:
SR_OPERATION_NOT_SUPPORTED(sr)

578
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

SR REQUIRES UPGRADE
The operation cannot be performed until the SR has been upgraded

Signature:
SR_REQUIRES_UPGRADE(SR)

SR UNKNOWN DRIVER
The SR could not be connected because the driver was not recognised.

Signature:
SR_UNKNOWN_DRIVER(driver)

SR UUID EXISTS
An SR with that uuid already exists.

Signature:
SR_UUID_EXISTS(uuid)

SR VDI LOCKING FAILED

The operation could not proceed because necessary VDIs were already locked at the storage level.

No parameters.

SSL VERIFY ERROR

The remote systems SSL certificate failed to verify against our certificate library.

Signature:
SSL_VERIFY_ERROR(reason)

SUBJECT ALREADY EXISTS

Subject already exists.

No parameters.

579
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

SUBJECT CANNOT BE RESOLVED

Signature:
USER_IS_NOT_LOCAL_SUPERUSER(msg)

UUID INVALID
The uuid you supplied was invalid.

Signature:
UUID_INVALID(type, uuid)

581
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

V6D FAILURE
There was a problem with the license daemon (v6d).

No parameters.

VALUE NOT SUPPORTED

You attempted to set a value that is not supported by this implementation. The fully-qualified field name and
the value that you tried to set are returned. Also returned is a developer-only diagnostic reason.

Signature:
VALUE_NOT_SUPPORTED(field, value, reason)

VBD CDS MUST BE READONLY

Read/write CDs are not supported

No parameters.

VBD IS EMPTY
Operation could not be performed because the drive is empty

Signature:
VBD_IS_EMPTY(vbd)

VBD NOT EMPTY

Operation could not be performed because the drive is not empty

Signature:
VBD_NOT_EMPTY(vbd)

VBD NOT REMOVABLE MEDIA

Media could not be ejected because it is not removable

Signature:
VBD_NOT_REMOVABLE_MEDIA(vbd)

582
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

VBD NOT UNPLUGGABLE

Drive could not be hot-unplugged because it is not marked as unpluggable

Signature:
VBD_NOT_UNPLUGGABLE(vbd)

VBD TRAY LOCKED

This VM has locked the DVD drive tray, so the disk cannot be ejected

Signature:
VBD_TRAY_LOCKED(vbd)

VDI CONTAINS METADATA OF THIS POOL

The VDI could not be opened for metadata recovery as it contains the current pools metadata.

Signature:
VDI_CONTAINS_METADATA_OF_THIS_POOL(vdi, pool)

VDI COPY FAILED

The VDI copy action has failed

No parameters.

VDI HAS RRDS

The operation cannot be performed because this VDI has rrd stats

Signature:
VDI_HAS_RRDS(vdi)

VDI INCOMPATIBLE TYPE

This operation cannot be performed because the specified VDI is of an incompatible type (eg: an HA statefile
cannot be attached to a guest)

Signature:
VDI_INCOMPATIBLE_TYPE(vdi, type)

583
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

VDI IN USE
This operation cannot be performed because this VDI is in use by some other operation

Signature:
VDI_IN_USE(vdi, operation)

VDI IS A PHYSICAL DEVICE

The operation cannot be performed on physical device

Signature:
VDI_IS_A_PHYSICAL_DEVICE(vdi)

VDI IS NOT ISO

This operation can only be performed on CD VDIs (iso files or CDROM drives)

Signature:
VDI_IS_NOT_ISO(vdi, type)

VDI LOCATION MISSING

This operation cannot be performed because the specified VDI could not be found in the specified SR

Signature:
VDI_LOCATION_MISSING(sr, location)

VDI MISSING
This operation cannot be performed because the specified VDI could not be found on the storage substrate

Signature:
VDI_MISSING(sr, vdi)

VDI NEEDS VM FOR MIGRATE

You attempted to migrate a VDI which is not attached to a running VM.

Signature:
VDI_NEEDS_VM_FOR_MIGRATE(vdi)

584
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

VDI NOT AVAILABLE

This operation cannot be performed because this VDI could not be properly attached to the VM.

Signature:
VDI_NOT_AVAILABLE(vdi)

VDI NOT IN MAP

This VDI was not mapped to a destination SR in VM.migrate send operation

Signature:
VDI_NOT_IN_MAP(vdi)

VDI NOT MANAGED

This operation cannot be performed because the system does not manage this VDI

Signature:
VDI_NOT_MANAGED(vdi)

VDI NOT SPARSE

The VDI is not stored using a sparse format. It is not possible to query and manipulate only the changed
blocks (or block differences or disk deltas) between two VDIs. Please select a VDI which uses a sparse-aware
technology such as VHD.

Signature:
VDI_NOT_SPARSE(vdi)

VDI ON BOOT MODE INCOMPATIBLE WITH OPERATION

This operation is not permitted on VMs containing VDIs in the on-boot=reset mode

No parameters.

VDI READONLY
The operation required write access but this VDI is read-only

Signature:
VDI_READONLY(vdi)

585
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

VDI TOO SMALL

The VDI is too small. Please resize it to at least the minimum size.

Signature:
VDI_TOO_SMALL(vdi, minimum size)

VGPU TYPE NOT COMPATIBLE WITH RUNNING TYPE

VGPU type is not compatible with one or more of the VGPU types currently running on this PGPU

Signature:
VGPU_TYPE_NOT_COMPATIBLE_WITH_RUNNING_TYPE(pgpu, type, running_type)

VGPU TYPE NOT ENABLED

VGPU type is not one of the PGPUs enabled types.

Signature:
VGPU_TYPE_NOT_ENABLED(type, enabled_types)

VGPU TYPE NOT SUPPORTED

VGPU type is not one of the PGPUs supported types.

Signature:
VGPU_TYPE_NOT_SUPPORTED(type, supported_types)

VIF IN USE
Network has active VIFs

Signature:
VIF_IN_USE(network, VIF)

VIF NOT IN MAP

This VIF was not mapped to a destination Network in VM.migrate send operation

Signature:
VIF_NOT_IN_MAP(vif)

586
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

VLAN TAG INVALID

You tried to create a VLAN, but the tag you gave was invalid it must be between 0 and 4094. The parameter
echoes the VLAN tag you gave.

Signature:
VLAN_TAG_INVALID(VLAN)

VMPP ARCHIVE MORE FREQUENT THAN BACKUP

Signature:
VM_CHECKPOINT_RESUME_FAILED(vm)

VM CHECKPOINT SUSPEND FAILED

An error occured while saving the memory image of the specified virtual machine

Signature:
VM_CHECKPOINT_SUSPEND_FAILED(vm)

588
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

VM CRASHED
The VM crashed

Signature:
VM_CRASHED(vm)

VM DUPLICATE VBD DEVICE

The specified VM has a duplicate VBD device and cannot be started.

Signature:
VM_DUPLICATE_VBD_DEVICE(vm, vbd, device)

VM FAILED SHUTDOWN ACKNOWLEDGMENT

VM didnt acknowledge the need to shutdown.

No parameters.

VM HALTED
The VM unexpectedly halted

Signature:
VM_HALTED(vm)

VM HAS CHECKPOINT
You attempted to migrate a VM which has a checkpoint.

Signature:
VM_HAS_CHECKPOINT(vm)

VM HAS PCI ATTACHED

This operation could not be performed, because the VM has one or more PCI devices passed through.

Signature:
VM_HAS_PCI_ATTACHED(vm)

589
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

VM HAS TOO MANY SNAPSHOTS

You attempted to migrate a VM with more than one snapshot.

Signature:
VM_HAS_TOO_MANY_SNAPSHOTS(vm)

VM HAS VGPU
This operation could not be performed, because the VM has one or more virtual GPUs.

Signature:
VM_HAS_VGPU(vm)

VM HOST INCOMPATIBLE VERSION

This VM operation cannot be performed on an older-versioned host during an upgrade.

Signature:
VM_HOST_INCOMPATIBLE_VERSION(host, vm)

VM HOST INCOMPATIBLE VIRTUAL HARDWARE PLATFORM VERSION

You attempted to run a VM on a host that cannot provide the VMs required Virtual Hardware Platform version.

Signature:
VM_HOST_INCOMPATIBLE_VIRTUAL_HARDWARE_PLATFORM_VERSION(host, host_versions, vm, vm_version)

VM HVM REQUIRED
HVM is required for this operation

Signature:
VM_HVM_REQUIRED(vm)

VM INCOMPATIBLE WITH THIS HOST

The VM is incompatible with the CPU features of this host.

Signature:
VM_INCOMPATIBLE_WITH_THIS_HOST(vm, host, reason)

590
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

VM IS PART OF AN APPLIANCE
This operation is not allowed as the VM is part of an appliance.

Signature:
VM_IS_PART_OF_AN_APPLIANCE(vm, appliance)

VM IS PROTECTED
This operation cannot be performed because the specified VM is protected by xHA

Signature:
VM_IS_PROTECTED(vm)

VM IS TEMPLATE
The operation attempted is not valid for a template VM

Signature:
VM_IS_TEMPLATE(vm)

VM LACKS FEATURE SHUTDOWN

You attempted an operation which needs the cooperative shutdown feature on a VM which lacks it.

Signature:
VM_LACKS_FEATURE_SHUTDOWN(vm)

VM LACKS FEATURE STATIC IP SETTING

You attempted an operation which needs the VM static-ip-setting feature on a VM which lacks it.

Signature:
VM_LACKS_FEATURE_STATIC_IP_SETTING(vm)

VM LACKS FEATURE SUSPEND

You attempted an operation which needs the VM cooperative suspend feature on a VM which lacks it.

Signature:
VM_LACKS_FEATURE_SUSPEND(vm)

591
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

VM LACKS FEATURE VCPU HOTPLUG

You attempted an operation which needs the VM hotplug-vcpu feature on a VM which lacks it.

Signature:
VM_LACKS_FEATURE_VCPU_HOTPLUG(vm)

VM MEMORY SIZE TOO LOW

The specified VM has too little memory to be started.

Signature:
VM_MEMORY_SIZE_TOO_LOW(vm)

VM MIGRATE FAILED
An error occurred during the migration process.

Signature:
VM_MIGRATE_FAILED(vm, source, destination, msg)

VM MISSING PV DRIVERS
You attempted an operation on a VM which requires PV drivers to be installed but the drivers were not detected.

Signature:
VM_MISSING_PV_DRIVERS(vm)

VM NOT RESIDENT HERE

The specified VM is not currently resident on the specified host.

Signature:
VM_NOT_RESIDENT_HERE(vm, host)

VM NO CRASHDUMP SR
This VM does not have a crashdump SR specified.

Signature:
VM_NO_CRASHDUMP_SR(vm)

592
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

VM NO EMPTY CD VBD
The VM has no empty CD drive (VBD).

Signature:
VM_NO_EMPTY_CD_VBD(vm)

VM NO SUSPEND SR
This VM does not have a suspend SR specified.

Signature:
VM_NO_SUSPEND_SR(vm)

VM NO VCPUS
You need at least 1 VCPU to start a VM

Signature:
VM_NO_VCPUS(vm)

VM OLD PV DRIVERS
You attempted an operation on a VM which requires a more recent version of the PV drivers. Please upgrade
your PV drivers.

Signature:
VM_OLD_PV_DRIVERS(vm, major, minor)

VM PV DRIVERS IN USE
VM PV drivers still in use

Signature:
VM_PV_DRIVERS_IN_USE(vm)

VM REBOOTED
The VM unexpectedly rebooted

Signature:
VM_REBOOTED(vm)

593
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

VM REQUIRES GPU
You attempted to run a VM on a host which doesnt have a pGPU available in the GPU group needed by the
VM. The VM has a vGPU attached to this GPU group.

Signature:
VM_REQUIRES_GPU(vm, GPU_group)

VM REQUIRES IOMMU
You attempted to run a VM on a host which doesnt have I/O virtualization (IOMMU/VT-d) enabled, which
is needed by the VM.

Signature:
VM_REQUIRES_IOMMU(host)

VM REQUIRES NETWORK
You attempted to run a VM on a host which doesnt have a PIF on a Network needed by the VM. The VM has
at least one VIF attached to the Network.

Signature:
VM_REQUIRES_NETWORK(vm, network)

VM REQUIRES SR
You attempted to run a VM on a host which doesnt have access to an SR needed by the VM. The VM has at
least one VBD attached to a VDI in the SR.

Signature:
VM_REQUIRES_SR(vm, sr)

VM REQUIRES VDI
VM cannot be started because it requires a VDI which cannot be attached

Signature:
VM_REQUIRES_VDI(vm, vdi)

594
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

VM REQUIRES VGPU
You attempted to run a VM on a host on which the vGPU required by the VM cannot be allocated on any
pGPUs in the GPU group needed by the VM.

Signature:
VM_REQUIRES_VGPU(vm, GPU_group, vGPU_type)

VM REVERT FAILED
An error occured while reverting the specified virtual machine to the specified snapshot

Signature:
VM_REVERT_FAILED(vm, snapshot)

VM SHUTDOWN TIMEOUT
VM failed to shutdown before the timeout expired

Signature:
VM_SHUTDOWN_TIMEOUT(vm, timeout)

VM SNAPSHOT WITH QUIESCE FAILED

The quiesced-snapshot operation failed for an unexpected reason

Signature:
VM_SNAPSHOT_WITH_QUIESCE_FAILED(vm)

VM SNAPSHOT WITH QUIESCE NOT SUPPORTED

The VSS plug-in is not installed on this virtual machine

Signature:
VM_SNAPSHOT_WITH_QUIESCE_NOT_SUPPORTED(vm, error)

VM SNAPSHOT WITH QUIESCE PLUGIN DEOS NOT RESPOND

The VSS plug-in cannot be contacted

Signature:
VM_SNAPSHOT_WITH_QUIESCE_PLUGIN_DEOS_NOT_RESPOND(vm)

595
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

VM SNAPSHOT WITH QUIESCE TIMEOUT

The VSS plug-in has timed out

Signature:
VM_SNAPSHOT_WITH_QUIESCE_TIMEOUT(vm)

VM TOO MANY VCPUS

Too many VCPUs to start this VM

Signature:
VM_TOO_MANY_VCPUS(vm)

VM TO IMPORT IS NOT NEWER VERSION

The VM cannot be imported unforced because it is either the same version or an older version of an existing
VM.

Signature:
VM_TO_IMPORT_IS_NOT_NEWER_VERSION(vm, existing_version, version_to_import)

VM UNSAFE BOOT
You attempted an operation on a VM that was judged to be unsafe by the server. This can happen if the VM
would run on a CPU that has a potentially incompatible set of feature flags to those the VM requires. If you
want to override this warning then use the force option.

Signature:
VM_UNSAFE_BOOT(vm)

WLB AUTHENTICATION FAILED

WLB rejected our configured authentication details.

No parameters.

WLB CONNECTION REFUSED

WLB refused a connection to the server.

No parameters.

596
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

WLB CONNECTION RESET

The connection to the WLB server was reset.

No parameters.

WLB reported that its configured server name for this server instance failed to resolve in DNS.

No parameters.

598
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

XAPI HOOK FAILED

3rd party xapi hook failed

Signature:
XAPI_HOOK_FAILED(hook_name, reason, stdout, exit_code)

XENAPI MISSING PLUGIN

The requested plugin could not be found.

Signature:
XENAPI_MISSING_PLUGIN(name)

XENAPI PLUGIN FAILURE

There was a failure communicating with the plugin.

Signature:
XENAPI_PLUGIN_FAILURE(status, stdout, stderr)

XEN VSS REQ ERROR ADDING VOLUME TO SNAPSET FAILED

Some volumes to be snapshot could not be added to the VSS snapshot set

Signature:
XEN_VSS_REQ_ERROR_ADDING_VOLUME_TO_SNAPSET_FAILED(vm, error_code)

XEN VSS REQ ERROR CREATING SNAPSHOT

An attempt to create the snapshots failed

Signature:
XEN_VSS_REQ_ERROR_CREATING_SNAPSHOT(vm, error_code)

XEN VSS REQ ERROR CREATING SNAPSHOT XML STRING

Could not create the XML string generated by the transportable snapshot

Signature:
XEN_VSS_REQ_ERROR_CREATING_SNAPSHOT_XML_STRING(vm, error_code)

599
2.51. ERROR HANDLING CHAPTER 2. API REFERENCE

XEN VSS REQ ERROR INIT FAILED

Initialization of the VSS requester failed

Signature:
XEN_VSS_REQ_ERROR_INIT_FAILED(vm, error_code)

XEN VSS REQ ERROR NO VOLUMES SUPPORTED

Could not find any volumes supported by the Vss Provider

Signature:
XEN_VSS_REQ_ERROR_NO_VOLUMES_SUPPORTED(vm, error_code)

XEN VSS REQ ERROR PREPARING WRITERS

An attempt to prepare VSS writers for the snapshot failed

Signature:
XEN_VSS_REQ_ERROR_PREPARING_WRITERS(vm, error_code)

XEN VSS REQ ERROR PROV NOT LOADED

The Vss Provider is not loaded

Signature:
XEN_VSS_REQ_ERROR_PROV_NOT_LOADED(vm, error_code)

XEN VSS REQ ERROR START SNAPSHOT SET FAILED

An attempt to start a new VSS snapshot failed

Signature:
XEN_VSS_REQ_ERROR_START_SNAPSHOT_SET_FAILED(vm, error_code)

XMLRPC UNMARSHAL FAILURE

The server failed to unmarshal the XMLRPC message; it was expecting one element and received something
else.

Signature:
XMLRPC_UNMARSHAL_FAILURE(expected, received)

600

Intrusion Detection Honeypots
From Everand
Intrusion Detection Honeypots
Chris Sanders
3/5 (2)
ASCET V5.2 Reference
No ratings yet
ASCET V5.2 Reference
276 pages
Nuage VSP 5.4.1 Release Notes
No ratings yet
Nuage VSP 5.4.1 Release Notes
127 pages
Clean Up Audit Vault
No ratings yet
Clean Up Audit Vault
3 pages
Audio, Video, and Media in the Ministry
From Everand
Audio, Video, and Media in the Ministry
Clarence Floyd Richmond
No ratings yet
Cgrates Readthedocs Io en v0.10
No ratings yet
Cgrates Readthedocs Io en v0.10
116 pages
XenServer - Understanding Snapshots (v1.1)
No ratings yet
XenServer - Understanding Snapshots (v1.1)
24 pages
Aspect® Unified IP® 7.4 SP1 Aspect® Unified IP® - Advanced List Management 7.4 ™ SP1 Product Release Notes
No ratings yet
Aspect® Unified IP® 7.4 SP1 Aspect® Unified IP® - Advanced List Management 7.4 ™ SP1 Product Release Notes
29 pages
Citrix Xen Enterprise
No ratings yet
Citrix Xen Enterprise
533 pages
Xenapi-1 0 6
No ratings yet
Xenapi-1 0 6
198 pages
Gray Hat Hacking the Ethical Hacker's
From Everand
Gray Hat Hacking the Ethical Hacker's
Çağatay Şanlı
5/5 (1)
Content Creation Revolution with chatGPT
From Everand
Content Creation Revolution with chatGPT
Maria Cowen
No ratings yet
ChatGPT for Business: Strategies for Success
From Everand
ChatGPT for Business: Strategies for Success
Matthew C. Smith
1/5 (1)
The Linux Terminal for Advanced Users - The Command Line Made Easy: First Edition
From Everand
The Linux Terminal for Advanced Users - The Command Line Made Easy: First Edition
Michael Basler
No ratings yet
DSP2046_2023.1
No ratings yet
DSP2046_2023.1
993 pages
Advanced Multiplayer Game Development with Ureal Engine 5: A Comprehensive Guide to C++ Scripting
From Everand
Advanced Multiplayer Game Development with Ureal Engine 5: A Comprehensive Guide to C++ Scripting
Vladimir Kiselev
No ratings yet
Human Nature Potential in Nurture
From Everand
Human Nature Potential in Nurture
David L. Hawk
No ratings yet
Kellory the Warlock
From Everand
Kellory the Warlock
Lin Carter
No ratings yet
A Discourse Analysis of 1 Peter
From Everand
A Discourse Analysis of 1 Peter
Ervin Ray Starwalt
No ratings yet
OCPI 2.1.1-d2
No ratings yet
OCPI 2.1.1-d2
76 pages
Unlocking Statistics for the Social Sciences
From Everand
Unlocking Statistics for the Social Sciences
Norma Sinclair
No ratings yet
Software Patterns Made Easy
From Everand
Software Patterns Made Easy
Justice Nanhou
No ratings yet
ADVANCED COLLEGE ALGEBRA STUDY GUIDE
From Everand
ADVANCED COLLEGE ALGEBRA STUDY GUIDE
Harrison K Cook
No ratings yet
Advanced college algebra study guide
From Everand
Advanced college algebra study guide
Harrison Cook
No ratings yet
Frrouting Developers Guide
No ratings yet
Frrouting Developers Guide
315 pages
Osama the Gun
From Everand
Osama the Gun
Norman Spinrad
5/5 (1)
RedFish_1.21.0
No ratings yet
RedFish_1.21.0
222 pages
Securing ChatGPT: Best Practices for Protecting Sensitive Data in AI Language Models
From Everand
Securing ChatGPT: Best Practices for Protecting Sensitive Data in AI Language Models
Matthew C. Smith
No ratings yet
Blog Smarter, Not Harder: SEO, Blogging, and AI Strategies to Skyrocket Your Traffic
From Everand
Blog Smarter, Not Harder: SEO, Blogging, and AI Strategies to Skyrocket Your Traffic
Jay Nans
No ratings yet
OCPI 2.2 d2
No ratings yet
OCPI 2.2 d2
186 pages
Frrouting Developers Guide
No ratings yet
Frrouting Developers Guide
321 pages
Sforce API Reference Manual
No ratings yet
Sforce API Reference Manual
138 pages
Omni ORB
No ratings yet
Omni ORB
133 pages
Plain JavaScript: Learning the Front-End
From Everand
Plain JavaScript: Learning the Front-End
Roger Beans-Rivet
No ratings yet
XTSC RM
No ratings yet
XTSC RM
1,461 pages
Base Functions Connectivity and Routing Voulme 1 IBM
No ratings yet
Base Functions Connectivity and Routing Voulme 1 IBM
514 pages
DSP0266 1.12.1
No ratings yet
DSP0266 1.12.1
192 pages
Mechatronicuml - Syntax and Semantics: Technical Report
No ratings yet
Mechatronicuml - Syntax and Semantics: Technical Report
190 pages
Omni Orb
No ratings yet
Omni Orb
137 pages
The Omniorb Version 4.2 Users' Guide: Duncan Grisby
No ratings yet
The Omniorb Version 4.2 Users' Guide: Duncan Grisby
138 pages
Communication Server V1
No ratings yet
Communication Server V1
560 pages
Mastering Python Advanced Concepts and Practical Applications
From Everand
Mastering Python Advanced Concepts and Practical Applications
Aissa Younes
No ratings yet
Keys to Better Reading
From Everand
Keys to Better Reading
Judy McFall
No ratings yet
Akka Scala
No ratings yet
Akka Scala
771 pages
Snort++ User Manual
No ratings yet
Snort++ User Manual
145 pages
Riscv Iommu PDF
No ratings yet
Riscv Iommu PDF
103 pages
Yaz
No ratings yet
Yaz
202 pages
Dibbler User
No ratings yet
Dibbler User
74 pages
Ocpi-2 2 1
No ratings yet
Ocpi-2 2 1
192 pages
Ns Notes and Documentation: February 25, 2000
No ratings yet
Ns Notes and Documentation: February 25, 2000
303 pages
MAGE: A Distributed Programming Model
No ratings yet
MAGE: A Distributed Programming Model
228 pages
Snort User Manual
No ratings yet
Snort User Manual
214 pages
Deadline Yemen (The Elizabeth Darcy Series)
From Everand
Deadline Yemen (The Elizabeth Darcy Series)
Peggy Hanson
5/5 (1)
Extension Package Programmers Manual
No ratings yet
Extension Package Programmers Manual
149 pages
Nuage VSP 20.10.R5 Release Notes
No ratings yet
Nuage VSP 20.10.R5 Release Notes
237 pages
The Stock Market from A to See - 2nd Edition
From Everand
The Stock Market from A to See - 2nd Edition
John Nunez
No ratings yet
AkkaJava PDF
No ratings yet
AkkaJava PDF
761 pages
Glpi Plugins Readthedocs Io en Master
No ratings yet
Glpi Plugins Readthedocs Io en Master
125 pages
Glpi Agent Readthedocs Io en Latest
No ratings yet
Glpi Agent Readthedocs Io en Latest
95 pages
Draft
No ratings yet
Draft
232 pages
OpenVX Specification 1 1
No ratings yet
OpenVX Specification 1 1
302 pages
Understanding Quarkus 1st Edition Antonio Goncalves download pdf
100% (13)
Understanding Quarkus 1st Edition Antonio Goncalves download pdf
83 pages
ROSE Tutorial
No ratings yet
ROSE Tutorial
430 pages
A Freecad Manual
91% (11)
A Freecad Manual
181 pages
Bohr en PDF
No ratings yet
Bohr en PDF
6 pages
Xenserver 7 0 Management API Guide
No ratings yet
Xenserver 7 0 Management API Guide
600 pages
Xenserver 7 0 Supplemental Packs Guide
No ratings yet
Xenserver 7 0 Supplemental Packs Guide
34 pages
DLP 7-3 Installing Drivers (SDLP)
No ratings yet
DLP 7-3 Installing Drivers (SDLP)
4 pages
E-Commerce - Solution 2077,2079
No ratings yet
E-Commerce - Solution 2077,2079
28 pages
Cloud Agent Lab Exercises V22
No ratings yet
Cloud Agent Lab Exercises V22
59 pages
Sinamics g120
No ratings yet
Sinamics g120
732 pages
Microsoft File
No ratings yet
Microsoft File
7 pages
Assignment
No ratings yet
Assignment
3 pages
Ethics Scenarios
No ratings yet
Ethics Scenarios
4 pages
Mobile Based Dwell Time Management System Using Iot
No ratings yet
Mobile Based Dwell Time Management System Using Iot
5 pages
Ccnet Lec 03 Protocol Architecture
No ratings yet
Ccnet Lec 03 Protocol Architecture
27 pages
Viva Questions
No ratings yet
Viva Questions
12 pages
08 - Ai-900 36 - 70 - M
No ratings yet
08 - Ai-900 36 - 70 - M
10 pages
Blackbox Technologies: Presents Introduction To Gear Inspection Software (Gearsoft)
No ratings yet
Blackbox Technologies: Presents Introduction To Gear Inspection Software (Gearsoft)
25 pages
HTML Basic Quiz
No ratings yet
HTML Basic Quiz
12 pages
PON-Dimensioning - R6.2.04
No ratings yet
PON-Dimensioning - R6.2.04
6 pages
HP Networking Portfolio
No ratings yet
HP Networking Portfolio
45 pages
Hard Disk
75% (4)
Hard Disk
41 pages
POINTERS & ARRAYS
No ratings yet
POINTERS & ARRAYS
4 pages
Capsule Neural Network and Its Implementation For Object Recognition in Resource-Limited Devices
No ratings yet
Capsule Neural Network and Its Implementation For Object Recognition in Resource-Limited Devices
103 pages
Smart Forms - Text and Data
No ratings yet
Smart Forms - Text and Data
12 pages
Lecture 1 IMT
No ratings yet
Lecture 1 IMT
41 pages
Psygroup PDF
No ratings yet
Psygroup PDF
8 pages
Lec 03
No ratings yet
Lec 03
13 pages
Xss & CSRF
No ratings yet
Xss & CSRF
26 pages
Exam Instructions For CBT
No ratings yet
Exam Instructions For CBT
2 pages
Interference Management in Nb-Iot For Heterogeneous Wireless Network
No ratings yet
Interference Management in Nb-Iot For Heterogeneous Wireless Network
70 pages
p13 3 7
No ratings yet
p13 3 7
4 pages
Sambitan - Activity 1-4
No ratings yet
Sambitan - Activity 1-4
6 pages
The Core Components of Entrust/PKI v5
No ratings yet
The Core Components of Entrust/PKI v5
19 pages