Xen API

https://github.com/xapi-project/xen-api
Admin
Xen API is a management API for XenServer and Xen Cloud Platform, providing a unified interface for...
Tokens:146,547
Snippets:1,909
Trust Score:9.3
License:LGPL-2.1
Update:3 months ago
Show doc for...
Tokens:
Raw
### Installing and running pre-commit

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/python/_index.md

Commands to install the pre-commit framework and execute the defined test suite.

```bash
pip3 install pre-commit
pre-commit run -av
# Or, to just run the pytest hook:
pre-commit run -av pytest
```

--------------------------------

### Install project dependencies and tools

Source: https://github.com/xapi-project/xen-api/blob/master/README.markdown

Installs the toolstack and developer utilities.

```bash
opam install xs-toolstack

# Install developer tools (utop, ocamlformat, ocaml-lsp-server, etc.)
opam install dev-tools

# Update the current switch. (You're already on the correct one, just refresh it).
eval $(opam env)
```

--------------------------------

### Invoking VM Lifecycle Operations

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xen-api/wire-protocol.md

Example of starting a VM and handling potential errors.

```python
>>> try:
...     jsonrpccall("VM.start", (session, next(all_templates), False, False))
... except Exception as e:
...     e
...
Exception('VM_IS_TEMPLATE', ['OpaqueRef:1', 'start'])
```

--------------------------------

### Initialize Mirror Start

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xapi/storage/sxm/index.md

Starts the mirroring process by locating the local VDI and establishing a remote SMAPIv2 client.

```ocaml
let start' ~task ~dbg ~sr ~vdi ~dp ~url ~dest =
  debug "Mirror.start sr:%s vdi:%s url:%s dest:%s" sr vdi url dest;
  SMPERF.debug "mirror.start called sr:%s vdi:%s url:%s dest:%s" sr vdi url dest;
  let remote_url = Http.Url.of_string url in
  let module Remote = Client(struct let rpc = rpc ~srcstr:"smapiv2" ~dststr:"dst_smapiv2" remote_url end) in

  (* Find the local VDI *)
  let vdis = Local.SR.scan ~dbg ~sr in
  let local_vdi =
    try List.find (fun x -> x.vdi = vdi) vdis
    with Not_found -> failwith (Printf.sprintf "Local VDI %s not found" vdi) in
```

--------------------------------

### Install NuGet Package

Source: https://github.com/xapi-project/xen-api/blob/master/ocaml/sdk-gen/csharp/autogen/README.md

Install the XenServer.NET package using the NuGet CLI.

```pwsh
nuget install XenServer.NET
```

--------------------------------

### Start an RPC Server

Source: https://github.com/xapi-project/xen-api/blob/master/ocaml/message-switch/README.md

Start an RPC server that services the 'foo' queue using a specified program.

```sh
_build/install/default/bin/message-cli serve foo --program /bin/cat
```

--------------------------------

### Hook point directory example

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xenopsd/design/hooks.md

Example path for a script configured to run on the vm-post-destroy hook.

```bash
/etc/xapi.d/vm-post-destroy/01myscript.sh
```

--------------------------------

### Install xcp-rrdd via opam

Source: https://github.com/xapi-project/xen-api/blob/master/ocaml/xcp-rrdd/README.markdown

Use these commands to set up the environment and install the xcp-rrdd package from the official repository.

```bash
opam switch create new-env
opam repo remove default
opam repo add xs-opam https://github.com/xapi-project/xs-opam.git
opam install xcp-rrdd
```

--------------------------------

### Initialize Python Environment

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xen-api/wire-protocol.md

Start the Python interpreter for interactive API testing.

```bash
$ python3
>>>
```

--------------------------------

### JSON-RPC v2.0 Request Example

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xen-api/wire-protocol.md

Example of a request body to retrieve resident VMs on a host.

```json
  {
    "jsonrpc": "2.0",
    "method": "host.get_resident_VMs",
    "params": [
      "OpaqueRef:c90cd28f-37ec-4dbf-88e6-f697ccb28b39",
      "OpaqueRef:08c34fc9-f418-4f09-8274-b9cb25cd8550"
    ],
    "id": 3
 }
```

--------------------------------

### Example GVT-g identifier mapping

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/design/vgpu-type-identifiers.md

An example of a GVT-g VGPU configuration and its corresponding serialized identifier string.

```ocaml
GVT_g {
  pdev_id = 0x162a;
  low_gm_sz = 128L;
  high_gm_sz = 384L;
  fence_sz = 4L;
  monitor_config_file = None;
}
```

--------------------------------

### Example NVIDIA identifier mapping

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/design/vgpu-type-identifiers.md

An example of an NVIDIA VGPU configuration and its corresponding serialized identifier string.

```ocaml
Nvidia {
  pdev_id = 0x11bf;
  psubdev_id = None;
  vdev_id = 0x11b0;
  vsubdev_id = 0x109d;
}
```

--------------------------------

### Importing Required Libraries

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xen-api/wire-protocol.md

Initial setup for using the jsonrpcclient and requests libraries.

```python
>>> import requests
>>> import jsonrpcclient
```

--------------------------------

### Import XenAPI bindings

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xen-api/usage.md

Initial setup for the Python script by importing necessary modules.

```python
import sys, time
import XenAPI
```

--------------------------------

### Install Hugo from Source on Ubuntu 22.04

Source: https://github.com/xapi-project/xen-api/blob/master/doc/README.md

Commands to install a specific Go compiler version and Hugo binary on Ubuntu 22.04.

```bash
sudo apt install golang-1.23-go
# Add it to your path, assuming your .local/bin/ is early in your PATH:
ln -s /usr/lib/go-1.23/bin/go ~/.local/bin/go
go version
go install github.com/gohugoio/hugo@v0.127.0
```

--------------------------------

### Run the Message Switch Server

Source: https://github.com/xapi-project/xen-api/blob/master/ocaml/message-switch/README.md

Start the server process, which binds to 127.0.0.1:8080 by default.

```sh
_build/install/default/bin/message-switch
```

--------------------------------

### Import VDI using vhd-tool

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/design/add-qcow-tool-for-vdi-import-export.md

Example command for serving a VDI from a source using vhd-tool.

```sh
/bin/vhd-tool serve \
    --source-format raw \
    --source-protocol none \
    --source-fd 3451d7ed-9078-8b01-95bf-293d3bc53e7a \
    --tar-filename-prefix  \
    --destination file:///dev/sm/backend/f939be89-5b9f-c7c7-e1e8-30c419ee5de6/4868ac1d-8321-4826-b058-952d37a29b82 \
    --destination-format raw \
    --progress \
    --machine \
    --direct \
    --destination-size 180405760 \
    --prezeroed
```

--------------------------------

### Configure vCPU pinning via template

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/lib/xenctrl/xc_vcpu_setaffinity.md

Example of setting vCPU pinning using a template parameter.

```py
xe template-param-set uuid=<template_uuid> vCPUs-params:mask=1,2,3
```

--------------------------------

### Initialize and use EzXenstore

Source: https://github.com/xapi-project/xen-api/blob/master/ocaml/libs/ezxenstore/README.md

Demonstrates loading the library, configuring the socket path, and performing a write operation using the with_xs helper.

```ocaml
# #require "ezxenstore";;
# #require "ezxenstore";;
# Xs_transport.xenstored_socket := "/home/jludlam/devel/ocaml-xenstore-server/mysocket";;
# with_xs (fun xs -> xs.write "/bar" "baz");;
```

--------------------------------

### List VM data sources via CLI

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xapi/alarms/index.md

Example output showing the data sources available for a specific VM.

```sh
# ./get_data_sources.py --vm 5a445deb-0a8e-c6fe-24c8-09a0508bbe21

List of data sources related to VM 5a445deb-0a8e-c6fe-24c8-09a0508bbe21
cpu0                         | CPU0 usage
cpu_usage                    | Domain CPU usage
memory                       | Memory currently allocated to VM
memory_internal_free         | Memory used as reported by the guest agent
memory_target                | Target of VM balloon driver
...
vbd_xvda_io_throughput_read  | Data read from the VDI, in MiB/s
...
```

--------------------------------

### Build the project

Source: https://github.com/xapi-project/xen-api/blob/master/README.markdown

Executes the configuration and build process.

```bash
./configure
make
make test
```

--------------------------------

### Initialize Go Project Dependencies

Source: https://github.com/xapi-project/xen-api/blob/master/ocaml/sdk-gen/go/README.md

Run these commands to update dependencies and clean up the module file before building the project.

```bash
go get -u all
go mod tidy
```

--------------------------------

### JSON-RPC v2.0 Response Examples

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xen-api/wire-protocol.md

Examples of successful and error response bodies for JSON-RPC v2.0 calls.

```json
  {
    "jsonrpc": "2.0",
    "result": [
        "OpaqueRef:604f51e7-630f-4412-83fa-b11c6cf008ab",
        "OpaqueRef:670d08f5-cbeb-4336-8420-ccd56390a65f"
    ],
    "id": 3
  }
```

```json
  {
    "jsonrpc": "2.0",
    "error": {
        "code": 1,
        "message": "SESSION_INVALID",
        "data": [
            "OpaqueRef:c90cd28f-37ec-4dbf-88e6-f697ccb28b39"
        ]
    },
    "id": 3
  }
```

--------------------------------

### Select Datasources via Command Line

Source: https://github.com/xapi-project/xen-api/blob/master/ocaml/rrd2csv/man/rrd2csv.1.md

Examples of filtering metrics by host, VM, or specific consolidation functions and metrics.

```bash
$ rrd2csv :host::
```

```bash
$ rrd2csv :vm::
```

```bash
$ rrd2csv AVERAGE:host:: MIN:::memory_target
```

--------------------------------

### Initialize opam environment

Source: https://github.com/xapi-project/xen-api/blob/master/README.markdown

Sets up the opam switch and environment variables for the project.

```bash
opam init
opam switch create xen-api ocaml-base-compiler.$OCAML_VERSION_FULL
# This basically "jumps you into" the environment you just created:
eval $(opam env --switch=xen-api --set-switch)
```

--------------------------------

### Initialize XE CLI environment

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xen-api/usage.md

Configures the XE binary path and prompts for credentials if a local configuration file is missing.

```bash
# Allow the path to the 'xe' binary to be overridden by the XE environment variable
if [ -z "${XE}" ]; then
  XE=xe
fi

if [ ! -e "${HOME}/.xe" ]; then
  read -p "Server name: " SERVER
  read -p "Username: " USERNAME
  read -p "Password: " PASSWORD
  XE="${XE} -s ${SERVER} -u ${USERNAME} -pw ${PASSWORD}"
fi
```

--------------------------------

### Typical CLI command implementation

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xapi/cli/_index.md

Example of a bond_create command implementation that retrieves parameters, performs XenAPI calls, and prints the result.

```ocaml
let bond_create printer rpc session_id params =
  let network = List.assoc "network-uuid" params in
  let mac = List.assoc_default "mac" params "" in
  let network = Client.Network.get_by_uuid rpc session_id network in
  let pifs = List.assoc "pif-uuids" params in
  let uuids = String.split_on_char ',' pifs in
  let pifs = List.map (fun uuid -> Client.PIF.get_by_uuid rpc session_id uuid) uuids in
  let mode = Record_util.bond_mode_of_string (List.assoc_default "mode" params "") in
  let properties = read_map_params "properties" params in
  let bond = Client.Bond.create rpc session_id network pifs mac mode properties in
  let uuid = Client.Bond.get_uuid rpc session_id bond in
  printer (Cli_printer.PList [ uuid])
```

--------------------------------

### V1 JSON Data Example

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/design/plugin-protocol-v2.md

A standalone example of the JSON structure used for datasource reporting in the V1 protocol.

```json
{
  "timestamp": 1339685573.245,
  "data_sources": {
    "cpu-temp-cpu0": {
      "description": "Temperature of CPU 0",
      "type": "absolute",
      "units": "degC",
      "value": "64.33"
      "value_type": "float",
    },
    "cpu-temp-cpu1": {
      "description": "Temperature of CPU 1",
      "type": "absolute",
      "units": "degC",
      "value": "62.14"
      "value_type": "float",
    }
  }
}
```

--------------------------------

### Install prototype dependencies via opam

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/design/distributed-database/index.md

Use these commands to pin the necessary development versions of the xen-api-client, xapi-database, and xapi repositories.

```bash
$ opam pin xen-api-client git://github.com/djs55/xen-api-client#improvements
$ opam pin add xapi-database git://github.com/djs55/xapi-database
$ opam pin add xapi git://github.com/djs55/xen-api#schema-sexp
```

--------------------------------

### GET /export_metadata

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xen-api/topics/importexport.md

Exports only the metadata of a VM.

```APIDOC
## GET /export_metadata

### Description
Exports only the metadata for a VM.

### Method
GET

### Endpoint
/export_metadata
```

--------------------------------

### Initialize session and parse arguments

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xen-api/usage.md

Parses command line arguments and establishes a session with the XenServer host.

```python
if __name__ == "__main__":
    if len(sys.argv) <> 5:
        print "Usage:"
        print sys.argv[0], " <url> <username> <password> <iterations>"
        sys.exit(1)
    url = sys.argv[1]
    username = sys.argv[2]
    password = sys.argv[3]
    iterations = int(sys.argv[4])
    # First acquire a valid session by logging in:
    session = XenAPI.Session(url)
    session.xenapi.login_with_password(username, password, "2.3",
                                       "Example migration-demo v0.1")
    try:
        for i in range(iterations):
            main(session, i)
    finally:
        session.xenapi.session.logout()
```

--------------------------------

### Represent enum value

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xen-api/wire-protocol.md

Example of how an enum value is conveyed in JSON.

```xml
  "destroy"
```

--------------------------------

### Example Filesystem Hierarchy for MVD

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/toolstack/features/MVD/index.md

Displays the directory structure under /lib/modules showing how symbolic links in the updates directory point to specific driver versions in the xenserver hierarchy.

```text
/lib/
└── modules
    └── 4.19.0+1 ->
        ├── updates
        │   ├── aacraid.ko
        │   ├── bnx2fc.ko -> ../xenserver/bnx2fc/2.12.13/bnx2fc.ko
        │   ├── bnx2i.ko
        │   ├── cxgb4i.ko
        │   ├── cxgb4.ko
        │   ├── dell_laptop.ko -> ../xenserver/dell_laptop/1.2.3/dell_laptop.ko
        │   ├── e1000e.ko
        │   ├── i40e.ko
        │   ├── ice.ko -> ../xenserver/intel-ice/1.11.17.1/ice.ko
        │   ├── igb.ko
        │   ├── smartpqi.ko
        │   └── tcm_qla2xxx.ko
        └── xenserver
            ├── bnx2fc
            │   ├── 2.12.13
            │   │   └── bnx2fc.ko
            │   └── 2.12.20-dell
            │       └── bnx2fc.ko
            ├── dell_laptop
            │   └── 1.2.3
            │       └── dell_laptop.ko
            └── intel-ice
                ├── 1.11.17.1
                │   └── ice.ko
                └── 1.6.4
                    └── ice.ko
```

--------------------------------

### GET /export_raw_vdi

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xen-api/topics/snapshots.md

Downloads a disk or snapshot in raw or vhd format.

```APIDOC
## GET /export_raw_vdi

### Description
Downloads a disk or snapshot using an HTTP 1.0 GET request.

### Method
GET

### Endpoint
/export_raw_vdi?session_id=%s&task_id=%s&vdi=%s&format=%s[&base=%s]

### Parameters
#### Query Parameters
- **session_id** (string) - Required - A currently logged-in session.
- **task_id** (string) - Required - A Task reference to monitor progress.
- **vdi** (string) - Required - The reference of the VDI to export.
- **format** (string) - Required - The format, either 'vhd' or 'raw'.
- **base** (string) - Optional - Reference of a VDI to perform a differential export.
```

--------------------------------

### GET /sr_rrd

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/design/sr-level-rrds.md

Downloads the RRD file for a specific Storage Repository.

```APIDOC
## GET /sr_rrd

### Description
Downloads the RRD file for a specific Storage Repository.

### Method
GET

### Endpoint
/sr_rrd

### Parameters
#### Query Parameters
- **session_id** (string) - Required - The session handle for authentication.
- **uuid** (string) - Required - The UUID of the SR.
```

--------------------------------

### XML-RPC Serialization Example

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xen-api/wire-protocol.md

The serialized XML representation of the login_with_password method call.

```xml
<?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>
```

--------------------------------

### Represent map type

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xen-api/wire-protocol.md

Example of how a map type is represented as a JSON object.

```json
  {
    "Mike": 2.3,
    "John": 1.2
  }
```

--------------------------------

### Represent set type

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xen-api/wire-protocol.md

Example of how a set type is transmitted as a JSON array.

```json
  [ "CX8", "PSE36", "FPU" ]
```

--------------------------------

### Configure NTP Modes and Retrieve Status

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/design/host-ntp-time.md

Examples for setting various NTP modes and checking synchronization status.

```python
session.xenapi.host.set_timezone(host_ref, 'UTC')
session.xenapi.host.set_ntp_mode(host_ref, 'DHCP')
session.xenapi.host.get_ntp_synchronized(host_ref)
session.xenapi.host.get_ntp_servers_status(host_ref)
```

```python
session.xenapi.host.set_timezone(host_ref, 'Europe/London')
servers = ['time.server1.com', 'time.server2.com', 'time.server3.com']
session.xenapi.host.set_ntp_custom_servers(host_ref, servers)
session.xenapi.host.set_ntp_mode(host_ref, 'Custom')
session.xenapi.host.get_ntp_synchronized(host_ref)
session.xenapi.host.get_ntp_servers_status(host_ref)
```

```python
session.xenapi.host.set_ntp_mode(host_ref, 'Factory')
session.xenapi.host.get_ntp_synchronized(host_ref)
session.xenapi.host.get_ntp_servers_status(host_ref)
```

--------------------------------

### Define API function signature

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xen-api/wire-protocol.md

Example of an API function signature definition.

```python
(VM ref set)  VM.get_all()
```

--------------------------------

### Implement OCaml VM Skeletons and Test Modules

Source: https://github.com/xapi-project/xen-api/blob/master/ocaml/xapi-idl/designs/interprocesscomms.md

Provides example implementations for the VM interface, including a skeleton that raises exceptions and a test module that returns successful results.

```ocaml
module Vm_skeleton = functor(M: Xcp.M) -> struct
    include M
    open Types

    let start x =
        let open Vm.Start in
        return (Result.Error (Unimplemented "Vm.start"))
end

module Vm_test = functor(M: Xcp.M) -> struct
    include M
    open Types

    let start x =
        let open Vm.Start in
        return (Result.Ok (Out.("string")))
end
```

--------------------------------

### VM_start Micro-operation Sequence

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xenopsd/walkthroughs/VM.start.md

The sequence of micro-operations generated during the VM start process.

```ml
        dequarantine_ops vgpus
      ; [
          VM_hook_script
            (id, Xenops_hooks.VM_pre_start, Xenops_hooks.reason__none)
        ; VM_create (id, None, None, no_sharept)
        ; VM_build (id, force)
        ]
```

--------------------------------

### GET /export

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xen-api/topics/importexport.md

Initiates an asynchronous export operation for a specified virtual machine.

```APIDOC
## GET /export

### Description
Initiates an asynchronous export operation for a virtual machine using the XenServer API.

### Method
GET

### Endpoint
/export

### Parameters
#### Query Parameters
- **session_id** (string) - Required - A valid session ID for the API.
- **task_id** (string) - Required - A valid task ID for the asynchronous operation.
- **ref** (string) - Required - The UUID of the VM to be exported.
```

--------------------------------

### Configure opam repositories and pinning

Source: https://github.com/xapi-project/xen-api/blob/master/README.markdown

Adds the required xs-opam repository and pins the current directory.

```bash
# Add the xs-opam library as the main repo to check for versions at:
opam repo add xs-opam https://github.com/xapi-project/xs-opam.git
# Remove the default, because how it handles version conflicts is different:
opam repo remove default
# (NOT needed with opam>=2.1.0) Have opam now figure out what versions of each package to use:
opam pin --yes add . --no-action
```

--------------------------------

### GET /export

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xen-api/topics/importexport.md

Exports a VM to a file. The request should be sent to the Pool master.

```APIDOC
## GET /export

### Description
Exports a VM to a file. The VM is specified by UUID or reference.

### Method
GET

### Endpoint
/export

### Parameters
#### Query Parameters
- **session_id** (string) - Optional - The reference of the session being used to authenticate; required only when not using HTTP basic authentication.
- **task_id** (string) - Optional - The reference of the task object with which to keep track of the operation.
- **ref** (string) - Optional - The reference of the VM; required only if not using the UUID.
- **uuid** (string) - Optional - The UUID of the VM; required only if not using the reference.
- **use_compression** (boolean) - Optional - If true, the output will be gzip-compressed.
```

--------------------------------

### Access XenServer Help and Commands

Source: https://github.com/xapi-project/xen-api/blob/master/ocaml/sdk-gen/powershell/autogen/README.md

Retrieve documentation and list available cmdlets for the XenServer module.

```powershell
Get-Help about_XenServer
```

```powershell
Get-Command -Module XenServerPSModule
```

```powershell
Get-Help [CommandName]
```

--------------------------------

### Serialized JSON-RPC Request Example

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xen-api/wire-protocol.md

The structure of a serialized JSON-RPC v2.0 request for login.

```json
  {
    "jsonrpc": "2.0",
    "method": "session.login_with_password",
    "params": ["user", "passwd", "version", "originator"],
    "id": 0
  }
```

--------------------------------

### Prepare Migration Environment

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xapi/storage/sxm/index.md

Performs final checks, initializes the Xenops client, and ejects CDs before migration.

```ocaml
  assert_no_cbt_enabled_vdi_migrated ~__context ~vdi_map;

  let dbg = Context.string_of_task __context in
  let open Xapi_xenops_queue in
  let queue_name = queue_of_vm ~__context ~self:vm in
  let module XenopsAPI = (val make_client queue_name : XENOPS) in

  let remote_vdis = ref [] in

  let ha_always_run_reset = not is_intra_pool && Db.VM.get_ha_always_run ~__context ~self:vm in

  let cd_vbds = find_cds_to_eject __context vdi_map vbds in
  eject_cds __context cd_vbds;
```

--------------------------------

### Malformed JSON-RPC Request

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xen-api/wire-protocol.md

Example of a malformed JSON-RPC request sent via curl.

```sh
$curl -D - -X POST https://server/jsonrpc -H 'Content-Type: application/json' \
  -d '{
      "jsonrpc": "2.0",
      "method": "session.login_with_password",
      "id": 0
  }'
```

--------------------------------

### Execute Asynchronous Task with Progress Tracking

Source: https://github.com/xapi-project/xen-api/blob/master/ocaml/sdk-gen/powershell/autogen/about_XenServer.help.txt

Shows how to run a VM start operation asynchronously and track the resulting task progress.

```powershell
PS> Invoke-XenVM -Name $vm_name -XenAction Start -Async -PassThru |`
    Wait-XenTask -ShowProgress
```

--------------------------------

### Malformed XML-RPC Request

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xen-api/wire-protocol.md

Example of a malformed XML-RPC request sent via curl.

```sh
$curl -D - -X POST https://server -H 'Content-Type: application/xml' \
  -d '<?xml version="1.0"?>
  <methodCall>
    <methodName>session.logout</methodName>
  </methodCall>'
```

--------------------------------

### View Module Help and Commands

Source: https://github.com/xapi-project/xen-api/blob/master/ocaml/sdk-gen/powershell/autogen/README_51.md

Access module overview, list available cmdlets, or get help for specific commands.

```powershell
        PS> Get-Help about_XenServer
```

```powershell
        PS> Get-Command -Module XenServerPSModule
```

```powershell
        PS> Get-Help [CommandName]
```

--------------------------------

### JSON-RPC v1.0 return values

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xen-api/wire-protocol.md

Examples of successful and failed JSON-RPC v1.0 responses.

```json
  {
    "result": [
        "OpaqueRef:604f51e7-630f-4412-83fa-b11c6cf008ab",
        "OpaqueRef:670d08f5-cbeb-4336-8420-ccd56390a65f"
    ],
    "error": null,
    "id": "xyz"
  }
```

```json
  {
    "result": null,
    "error": [
        "SESSION_INVALID",
        "OpaqueRef:93f1a23cd-a640-41e3-b163-10f86e0eae67"
    ],
    "id": "xyz"
  }
```

--------------------------------

### Enable IOMMU/VT-d support

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/design/gpu-passthrough.md

Execute this command to enable IOMMU support in the Xen hypervisor, followed by a system reboot.

```bash
/opt/xensource/libexec/xen-cmdline --set-xen iommu=1
```

--------------------------------

### Encode map type in XML-RPC

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xen-api/wire-protocol.md

Example showing how a map is represented as an XML-RPC struct.

```xml
    <value>
      <struct>
        <member>
          <name>Mike</name>
          <value><double>2.3</double></value>
        </member>
        <member>
          <name>John</name>
          <value><double>1.2</double></value>
        </member>
      </struct>
    </value>
```

--------------------------------

### Importing Local SDK Module

Source: https://github.com/xapi-project/xen-api/blob/master/ocaml/sdk-gen/component-test/README.md

Commands and configuration for importing the generated SDK as a local module in the Go client.

```bash
cp -r ${{ github.workspace }}/_build/install/default/share/go/src jsonrpc-client/go/goSDK
```

```go
module github.com/xapi-project/xen-api/sdk-gen/component-test/jsonrpc-client/go

go 1.22.2

replace xenapi => ./goSDK
```

--------------------------------

### Hook script content

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xenopsd/design/hooks.md

A simple bash script example that logs the arguments passed to it.

```bash
#!/bin/bash
echo I was passed $@ > /tmp/output
```

--------------------------------

### VM_start Operation Handling

Source: https://github.com/xapi-project/xen-api/blob/master/doc/content/xenopsd/walkthroughs/VM.start.md

The logic for processing a VM_start operation, including state checking and atomic execution.

```ocaml
  | VM_start (id, force) -> (
      debug "VM.start %s (force=%b)" id force ;
      let power = (B.VM.get_state (VM_DB.read_exn id)).Vm.power_state in
      match power with
      | Running ->
          info "VM %s is already running" id
      | _ ->
          perform_atomics (atomics_of_operation op) t ;
          VM_DB.signal id "^^^^^^^^^^^^^^^^^^^^--------
    )
```
Tokens:
Raw