Xen Orchestra

https://docs.xen-orchestra.com/
Admin
Xen Orchestra is a complete management solution to visualize, manage, backup, and delegate XCP-ng...
Tokens:24,269
Snippets:315
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install cloud-initramfs-growroot on Ubuntu

Source: https://docs.xen-orchestra.com/vm-templates

Install the growroot package to enable automatic file system expansion during VM initialization.

```bash
sudo apt install cloud-initramfs-growroot
```

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

### Deploy VM with Pulumi

Source: https://docs.xen-orchestra.com/xo6/pulumi-provider

Commands and output examples for deploying infrastructure changes.

```bash
pulumi up  
```

```text
Previewing update (dev)  

  

View in Browser (Ctrl+O): https://app.pulumi.com/batchayw-org/xo-pulumi-project/dev/previews/13fa0ed6-67f7-463d-8e18-83a1fa9571e2  

  

    Type                      Name                   Plan         

+   pulumi:pulumi:Stack       xo-pulumi-project-dev  create       

+   └─ xenorchestra:index:Vm  xo-pulumi-tutorial     create       

  

Outputs:  

    ipv4  : [unknown]  

    vmId  : [unknown]  

    vmName: "XO Pulumi Tutorial"  

  

Resources:  

    + 2 to create  

  

Do you want to perform this update?  
```

```text
Updating (dev)  

  

View in Browser (Ctrl+O): https://app.pulumi.com/batchayw-org/xo-pulumi-project/dev/updates/1  

  

    Type                      Name                   Status              

+   pulumi:pulumi:Stack       xo-pulumi-project-dev  created (19s)       

+   └─ xenorchestra:index:Vm  xo-pulumi-tutorial     created (17s)       

  

Outputs:  

    vmId  : "0ae54d06-e3e2-100c-00e8-46f67945e37c"  

    vmName: "XO Pulumi Tutorial"  

  

Resources:  

    + 2 created  

  

Duration: 21s  
```

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

### Install xo-powershell module

Source: https://docs.xen-orchestra.com/xo6/powershell-module

Installs the module from the PowerShell Gallery. Requires PowerShell 7.0 or higher.

```powershell
Install-Module -Name xo-powershell -AllowPrerelease
```

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

### Execute deployment script

Source: https://docs.xen-orchestra.com/airgap

Set permissions and run the deployment script to install the XOA appliance.

```bash
chmod +x deploy.sh
```

```bash
./deploy.sh XOA.xva
```

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

### Install and Verify community.general Collection

Source: https://docs.xen-orchestra.com/xo6/ansible

Commands to install the required Ansible collection and verify the plugin documentation.

```bash
# Install the community.general collection  

ansible-galaxy collection install community.general  

  

# Verify the installation  

ansible-doc -t inventory community.general.xen_orchestra
```

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

### Import XOA to air-gapped pool

Source: https://docs.xen-orchestra.com/airgap

Import the transferred XVA file and start the appliance in the disconnected environment.

```bash
$ xe vm-import filename=xoa.xva  

c87a6dc3-9889-acf0-a680-79de3780c08f  

$ xe vm-start uuid=c87a6dc3-9889-acf0-a680-79de3780c08f
```

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

### Install Xen Orchestra Provider

Source: https://docs.xen-orchestra.com/xo6/pulumi-provider

Install the required Pulumi package for Xen Orchestra via npm.

```bash
npm install @vates/pulumi-xenorchestra  
```

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

### Example Dynamic Inventory Output

Source: https://docs.xen-orchestra.com/xo6/ansible

Sample JSON output returned by the Xen Orchestra inventory plugin for a virtual machine.

```json
{

    "ansible_host": null,  

    "cpus": 1,  

    "has_ip": false,  

    "ip": null,  

    "is_managed": true,  

    "memory": 21474xxx,  

    "name_label": "XO Tutorial",  

    "os_version": {  

        "distro": "Ubuntu",  

        "name": "Ubuntu 24.04",  

        "uname": "6.8.0-57-generic"  

    },  

    "power_state": "running",  

    "tags": [],  

    "type": "VM",  

    "uuid": "0ae54d06-xxx-100c-00e8-xxxxxxx",  

    "xo_power_state": "running",  

    "xo_vm_name": "XO Tutorial"  

}  
```

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

### Configure Host Variables

Source: https://docs.xen-orchestra.com/xo6/ansible

Setup for dynamic host variable assignment and default connection settings using Jinja2 templates.

```yaml
plugin: community.general.xen_orchestra  

api_host: ws://your-xo-hostname  

user: your_user  

password: your_password  

validate_certs: true  

use_ssl: false  

  

compose:  

  # Sets ansible_host as the first IPv4 address  

  ansible_host: |  

    {% if ipv4_addresses and ipv4_addresses[0] %}  

      {{ ipv4_addresses[0] }}  

    {% else %}  

      {{ name_label | lower | replace(' ', '-') }}.local  

    {% endif %}  

    

  # Sets the user based on the operating system  

  ansible_user: |  

    {% if ‘Windows’ in name_label %}  

    administrator  

    {% elif ‘Ubuntu’ in name_label %}  

    ubuntu  

    {% elif ‘CentOS’ in name_label %}  

    centos  

    {% else %}  

    root  

    {% endif %}  

    

  # Xen Orchestra custom variables  

  xo_vm_id: id  

  xo_vm_name: name_label  

  xo_pool: pool_name  

  xo_template: template_name  

  xo_power_state: power_state  

  xo_memory: memory_max  

  xo_cpus: cpus  

  

# Default variables  

vars:  

  ansible_connection: ssh  

  ansible_ssh_common_args: '-o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null'  

  xo_inventory_source: “xen_orchestra”  
```

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

### Pulumi preview output

Source: https://docs.xen-orchestra.com/xo6/pulumi-provider

Example of the terminal output when running pulumi up to preview infrastructure changes.

```text
Previewing update (dev)  

  

View in Browser (Ctrl+O): https://app.pulumi.com/batchayw-org/xo-pulumi-project/dev/previews/9c687495-ba9d-4a8a-8446-f9bb8c2f1826  

  

    Type                      Name                   Plan       Info  

    pulumi:pulumi:Stack       xo-pulumi-project-dev               

~   └─ xenorchestra:index:Vm  xo-pulumi-tutorial     update     [diff: ~networks]  

  

Resources:  

    ~ 1 to update  

    1 unchanged  

  

Do you want to perform this update?
```

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

### Configure Xen Orchestra Dynamic Inventory Plugin

Source: https://docs.xen-orchestra.com/xo6/ansible

Example configuration file for the xen_orchestra inventory plugin, defining connection parameters and automatic host grouping.

```yaml
# xen orchestra connection  

plugin: community.general.xen_orchestra  

api_host: ws://your-xo-hostname  

user: your_username  

password: your_password  

validate_certs: false  

use_ssl: false  

  

# Automatic groups  

groups:  

  running: power_state == “Running”  

  halted: power_state == “Halted”  

  windows: “‘Windows’ in name_label”  

  linux: “‘Linux’ in name_label” or “‘Ubuntu’ in name_label” or “‘CentOS’ in name_label” or “‘Debian’ in name_label”  

  

# Compound variables  

compose:  

  ansible_host: ipv4_addresses[0] if ipv4_addresses else None  

  ansible_user: “root”  

  xo_vm_name: name_label  

  xo_pool: pool_name
```

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

### Pulumi update output

Source: https://docs.xen-orchestra.com/xo6/pulumi-provider

Example of the terminal output after confirming and applying infrastructure changes.

```text
Updating (dev)  

  

View in Browser (Ctrl+O): https://app.pulumi.com/batchayw-org/xo-pulumi-project/dev/updates/2  

  

    Type                      Name                   Status            Info  

    pulumi:pulumi:Stack       xo-pulumi-project-dev                      

~   └─ xenorchestra:index:Vm  xo-pulumi-tutorial     updated (29s)     [diff: ~networks]  

  

Outputs:  

    vmId  : "0ae54d06-e3e2-100c-00e8-46f67945e37c"  

    vmName: "XO Pulumi Tutorial"  

  

Resources:  

    ~ 1 updated  

    1 unchanged  

  

Duration: 32s
```

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

### Perform VM Maintenance via XO Inventory

Source: https://docs.xen-orchestra.com/xo6/ansible

A playbook example demonstrating system updates and automated reboots for VMs managed by Xen Orchestra.

```yaml
# playbook-xo-maintenance.yaml  

---  

- name: VM maintenance via XO inventory  

  hosts: uuid_of_your_vm # you can use (all/group_label/statut_vm/...)  

  gather_facts: true  

  become: yes  

  

  tasks:  

    - name: Update package index  

      apt:  

        update_cache: yes  

        cache_valid_time: 3600  

      when: ansible_distribution in [“Ubuntu”, “Debian”]  

  

    - name: Update system packages  

      apt:  

        name: “*”  

        state: latest  

      when: ansible_distribution in [“Ubuntu”, “Debian”]  

      register: apt_upgrade  

  

    - name: Check if a reboot is required  

      stat:  

        path: /var/run/reboot-required  

      register: reboot_required_file  

      when: ansible_distribution in [“Ubuntu”, “Debian”]  

  

    - name: Reboot if necessary  

      reboot:  

        msg: “Reboot after update”  

        connect_timeout: 5  

        reboot_timeout: 300  

        pre_reboot_delay: 0  

        post_reboot_delay: 30  

        test_command: uptime  

      when: reboot_required_file.stat.exists  

  

    - name: Clean up package cache  

      apt:  

        autoclean: yes  

        autoremove: yes  

      when: ansible_distribution in [“Ubuntu”, “Debian”]  
```

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

### Execute Sysprep for template resealing

Source: https://docs.xen-orchestra.com/windows-templates

Run the Sysprep utility with the required Unattend.xml file to generalize the Windows installation and shut down the VM.

```powershell
C:\Windows\System32\Sysprep\sysprep.exe /generalize /oobe /shutdown "/unattend:C:\Program Files\Cloudbase Solutions\Cloudbase-Init\conf\Unattend.xml"
```

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

### Define credentials in a vault file

Source: https://docs.xen-orchestra.com/xo6/ansible

Example content for a vault file containing Xen Orchestra API credentials.

```yaml
xen_api_user: your_username

xen_api_password: your_password

xen_api_host: your-xo-hostname
```

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

### Analyze xo-server memory logs

Source: https://docs.xen-orchestra.com/troubleshooting

Example of memory exhaustion logs found in journalctl when the Node.js heap limit is reached.

```text
<--- Last few GCs --->  

48734864 ms: Mark-sweep 1359.7 (1422.6) -> 1359.7 (1438.6) MB, 1675.5 / 0.0 ms [allocation failure] [scavenge might not succeed].  

48736444 ms: Mark-sweep 1359.7 (1438.6) -> 1359.7 (1438.6) MB, 1579.5 / 0.0 ms [allocation failure] [scavenge might not succeed].  

48738329 ms: Mark-sweep 1359.7 (1438.6) -> 1368.7 (1422.6) MB, 1885.0 / 0.0 ms [last resort gc].  

48740025 ms: Mark-sweep 1368.7 (1422.6) -> 1377.7 (1422.6) MB, 1695.0 / 0.0 ms [last resort gc].  

<--- JS stacktrace --->  

==== JS stack trace =========================================  

Security context: 0x12ba820cfb51 <JS Object>  

1: stringify(aka stringify) [native json.js:178] [pc=0x12d240955b57] (this=0x12ba82004381 <undefined>,E=0x162cbe055041 <an Object with map 0x8ecabcc95a1>,F=0x12ba82004381 <undefined>,S=0x12ba82004381 <undefined>)  

2: arguments adaptor frame: 1->3  

3: response [/usr/local/lib/node_modules/xo-server/node_modules/json-rpc-protocol/dist/format.js:~54] [pc=0x12d240cc1301] (this=0x1de505db7...  

FATAL ERROR: CALL_AND_RETRY_LAST Allocation failed - JavaScript heap out of memory  

1: node::Abort() [node]
```

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

### Common selector patterns

Source: https://docs.xen-orchestra.com/xo6/acl-v2

Examples of selector strings used to filter object permissions by ID, pool, tags, power state, or creator.

```text
id: <uuid>
```

```text
$pool: <pool-uuid>
```

```text
tags: <tag>
```

```text
power_state: Running
```

```text
creation:creator: <user-id>
```

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

### GET /rest/v0/users/me/privileges

Source: https://docs.xen-orchestra.com/xo6/acl-v2

Lists the privileges assigned to the currently authenticated user.

```APIDOC
## GET /rest/v0/users/me/privileges

### Description
List your own privileges.

### Method
GET

### Endpoint
/rest/v0/users/me/privileges
```

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

### Create Filesystem for Local Backups

Source: https://docs.xen-orchestra.com/backups

Format the newly attached disk to ext4 to prepare it for storing backup data.

```bash
mkfs.ext4 /dev/xvdb
```

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

### GET /rest/v0/users/me

Source: https://docs.xen-orchestra.com/xo6/acl-v2

Retrieves the profile information for the currently authenticated user.

```APIDOC
## GET /rest/v0/users/me

### Description
Get your own user profile.

### Method
GET

### Endpoint
/rest/v0/users/me
```

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

### Initialize Pulumi Project

Source: https://docs.xen-orchestra.com/xo6/pulumi-provider

Commands to create a new directory and initialize a TypeScript Pulumi project.

```bash
mkdir xo-pulumi-project  

cd xo-pulumi-project  

pulumi new typescript  
```

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

### GET /rest/v0/users/me/authentication_tokens

Source: https://docs.xen-orchestra.com/xo6/acl-v2

Lists all authentication tokens associated with the currently authenticated user.

```APIDOC
## GET /rest/v0/users/me/authentication_tokens

### Description
List your own authentication tokens.

### Method
GET

### Endpoint
/rest/v0/users/me/authentication_tokens
```

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

### Manage VM Groups and Configuration

Source: https://docs.xen-orchestra.com/xo6/ansible

Demonstrates applying configurations to specific VM groups and retrieving system metrics from managed instances.

```yaml
# manage-vm-groups.yaml  

---  

- name: Configuring application servers  

  hosts: group_label  

  gather_facts: true  

  become: yes  

  

  tasks:  

    - name: Installing basic packages  

      apt:  

        name:  

          - curl  

          - wget  

          - htop  

          - net-tools  

        state: present  

        update_cache: yes  

  

    - name: Timezone configuration  

      timezone:  

        name: Europe/Paris  

  

    - name: Creation of custom motd file  

      copy:  

        content: |  

          VM managed by Ansible via Xen Orchestra  

          Template: {{ xo_template }}  

          Pool: {{ xo_pool }}  

        dest: /etc/motd  

        owner: root  

        group: root  

        mode: 0644  

  

- name: Maintain specific VMs  

  hosts: lab_vms  

  gather_facts: true  

  become: yes  

  

  tasks:  

    - name: Check disk space  

      shell: df -h /  

      register: disk_usage  

  

    - name: Check memory usage  

      shell: free -h  

      register: memory_usage  

  

    - name: Display system information  

      debug:  

        msg: |  

          VM: {{ xo_vm_name }}  

          Disk: {{ disk_usage.stdout_lines[1] if disk_usage.stdout_lines|length > 1 else ‘N/A’ }}  

          Memory: {{ memory_usage.stdout_lines[1] if memory_usage.stdout_lines|length > 1 else ‘N/A’ }}  
```

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

### Configure Credentials via Environment Variables

Source: https://docs.xen-orchestra.com/xo6/pulumi-provider

Set up authentication credentials using environment variables for the Xen Orchestra API.

```bash
export XOA_URL=ws://hostname-of-your-deployment  

export XOA_USER=YOUR_USERNAME  

export XOA_PASSWORD=YOUR_PASSWORD  
```

```bash
export XOA_URL=ws://hostname-of-your-deployment  

export XOA_TOKEN=YOUR_TOKEN  
```

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

### Run Terraform Plan

Source: https://docs.xen-orchestra.com/xo6/terraform-provider

Execute the plan command to analyze the configuration and preview the creation of a new virtual machine resource.

```bash
william@william:~$ terraform plan  

data.xenorchestra_pool.pool: Reading...  

data.xenorchestra_template.vm_template: Reading...  

data.xenorchestra_pool.pool: Read complete after 1s [id=355ee47d-ff4c-4924-3db2-fd86ae629676]  

data.xenorchestra_network.network: Reading...  

data.xenorchestra_sr.sr: Reading...  

data.xenorchestra_template.vm_template: Read complete after 1s [id=d0b0869b-2503-0c17-1e5e-3725f6eba342]  

data.xenorchestra_network.network: Read complete after 0s [id=a12df741-f34f-7d05-f120-462f0ab39a48]  

data.xenorchestra_sr.sr: Read complete after 0s [id=86a9757d-9c05-9fe0-e79a-8243cb1f37f3]  

  

Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following  

symbols:  

+ create  

  

Terraform will perform the following actions:  

  

# xenorchestra_vm.vm will be created  

+ resource "xenorchestra_vm" "vm" {  

    + auto_poweron                        = false  

    + clone_type                          = "fast"  

    + core_os                             = false  

    + cpu_cap                             = 0  

    + cpu_weight                          = 0  

    + cpus                                = 1  

    + destroy_cloud_config_vdi_after_boot = false  

    + exp_nested_hvm                      = false  

    + hvm_boot_firmware                   = "bios"  

    + id                                  = (known after apply)  

    + ipv4_addresses                      = (known after apply)  

    + ipv6_addresses                      = (known after apply)  

    + memory_max                          = 2147467264  

    + memory_min                          = (known after apply)  

    + name_label                          = "XO terraform tutorial"  

    + power_state                         = "Running"  

    + start_delay                         = 0  

    + template                            = "d0b0869b-2503-0c17-1e5e-3725f6eba342"  

    + vga                                 = "std"  

    + videoram                            = 8  

  

    + disk {  

        + name_label = "VM root volume"  

        + position   = (known after apply)  

        + size       = 50214207488  

        + sr_id      = "86a9757d-9c05-9fe0-e79a-8243cb1f37f3"  

        + vbd_id     = (known after apply)  

        + vdi_id     = (known after apply)  

        }  

  

    + network {  

        + device         = (known after apply)  

        + ipv4_addresses = (known after apply)  

        + ipv6_addresses = (known after apply)  

        + mac_address    = (known after apply)  

        + network_id     = "a12df741-f34f-7d05-f120-462f0ab39a48"  

        }  

    }  

  

Plan: 1 to add, 0 to change, 0 to destroy.
```

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

### Get information about virtual disks

Source: https://docs.xen-orchestra.com/xo6/powershell-module

Retrieves details regarding virtual disks (VDI) managed by the system.

```powershell
Get-XoVdi
```

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

### Initialize Terraform Provider

Source: https://docs.xen-orchestra.com/xo6/terraform-provider

Run this command in your terminal to download the Xen Orchestra provider and initialize the working directory.

```bash
william@william:~$ terraform init   

Initializing the backend...  

Initializing provider plugins...  

- Finding vatesfr/xenorchestra versions matching "~> 0.35"...  

- Installing vatesfr/xenorchestra v0.35.1...  

- Installed vatesfr/xenorchestra v0.35.1 (self-signed, key ID 3084D82948625D89)  

Partner and community providers are signed by their developers.  

If you'd like to know more about provider signing, you can read about it here:  

https://developer.hashicorp.com/terraform/cli/plugins/signing  

Terraform has created a lock file .terraform.lock.hcl to record the provider  

selections it made above. Include this file in your version control repository  

so that Terraform can guarantee to make the same selections by default when  

you run "terraform init" in the future.  

  

Terraform has been successfully initialized!  

  

You may now begin working with Terraform. Try running "terraform plan" to see  

any changes that are required for your infrastructure. All Terraform commands  

should now work.  

  

If you ever set or change modules or backend configuration for Terraform,  

rerun this command to reinitialize your working directory. If you forget, other  

commands will detect it and remind you to do so if necessary.
```

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

### Configure Pulumi State Backends

Source: https://docs.xen-orchestra.com/xo6/pulumi-provider

Commands for setting up local encrypted storage or cloud-based backends for Pulumi state management.

```bash
# Configuration with local encrypted backend (recommended for full control)  

pulumi login file://~          # Encrypted local storage in home directory  

pulumi login --local           # Default location  

  

# Or configuration with a self-hosted backend  

pulumi login s3://my-pulumi-state-bucket  
pulumi login gs://my-pulumi-state-bucket  
pulumi login azblob://my-pulumi-state-bucket
```

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

### Verify VM access via SSH

Source: https://docs.xen-orchestra.com/vm-templates

Connect to the newly created VM using the configured SSH key.

```bash
$ ssh centos@192.168.100.226  

[centos@tmp-app1 ~]$
```

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

### Create a Virtual Machine Snapshot

Source: https://docs.xen-orchestra.com/xo6/powershell-module

Initiates a snapshot for a specific virtual machine using its UUID.

```powershell
New-XoVmSnapshot -VmUuid "993d84c2-2571-8451-8073-afa8ef510a8d" -SnapshotName "your-snapshot-name"
```

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

### Configure Persistent Mount for Backups

Source: https://docs.xen-orchestra.com/backups

Add an entry to /etc/fstab to ensure the backup disk is automatically mounted at the designated backup directory upon system boot.

```bash
/dev/xvdb /var/lib/xoa-backups ext4 defaults 0 0
```

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

### Download deployment script

Source: https://docs.xen-orchestra.com/airgap

Retrieve the XOA deployment script from the official source.

```bash
wget --no-verbose -O deploy.sh https://xoa.io/deploy
```

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

### Configure Inventory with Environment Variables

Source: https://docs.xen-orchestra.com/xo6/ansible

Configuration snippet using placeholders for credentials to be supplied via environment variables.

```yaml
plugin: community.general.xen_orchestra  

api_host: “{{xen_api_host}}”  

user: “{{ xen_api_user }}”  

password: “{{ xen_api_password }}”  

validate_certs: true  

use_ssl: false
```

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

### Retrieve Template Details via CLI

Source: https://docs.xen-orchestra.com/vm-templates

Use the xe CLI to list templates by name and inspect their parameters using a UUID.

```bash
xe template-list name-label="My Debian Template"  

uuid=$(xe template-list name-label="My Debian Template" --minimal)  

xe template-param-list uuid=$uuid | less  
```

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

### Verify sudo privileges

Source: https://docs.xen-orchestra.com/vm-templates

Test that the cloud-init configuration correctly granted sudo access to the user.

```bash
[centos@tmp-app1 ~]$ sudo -s  

[root@tmp-app1 centos]#
```

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

### Verify Terraform configuration with plan

Source: https://docs.xen-orchestra.com/xo6/terraform-provider

Run this command to ensure Terraform can connect to Xen Orchestra and locate declared resources.

```bash
william@william:~$ terraform plan  

data.xenorchestra_pool.pool: Reading...  

data.xenorchestra_template.vm_template: Reading...  

data.xenorchestra_pool.pool: Read complete after 0s [id=355ee47d-ff4c-4924-3db2-fd86ae629676]  

data.xenorchestra_network.network: Reading...  

data.xenorchestra_sr.sr: Reading...  

data.xenorchestra_network.network: Read complete after 0s [id=a12df741-f34f-7d05-f120-462f0ab39a48]  

data.xenorchestra_template.vm_template: Read complete after 0s [id=d0b0869b-2503-0c17-1e5e-3725f6eba342]  

data.xenorchestra_sr.sr: Read complete after 0s [id=86a9757d-9c05-9fe0-e79a-8243cb1f37f3]  

  

No changes. Your infrastructure matches the configuration.  

  

Terraform has compared your real infrastructure against your configuration and found no differences, so no changes are needed.  
```

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

### Check hardware virtualization support

Source: https://docs.xen-orchestra.com/troubleshooting

Verify if the host CPU supports HVM mode required for XOA.

```bash
grep --color vmx /proc/cpuinfo
```

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

### Configure Cloudbase-init metadata services

Source: https://docs.xen-orchestra.com/windows-templates

Update the metadata_services configuration to ensure Cloudbase-init uses the NoCloud configuration drive.

```text
metadata_services=cloudbaseinit.metadata.services.nocloudservice.NoCloudConfigDriveService
```

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

### Monitoring and Reporting Playbook

Source: https://docs.xen-orchestra.com/xo6/ansible

Collects system metrics from VMs and generates a centralized report file using local actions.

```yaml
# monitoring-playbook.yaml  

---  

- name: Collect information from XO VMs  

  hosts: uuid_of_your_vm # use 'all' if you want to target all VMs  

  gather_facts: true  

  become: yes  

  

  tasks:  

    - name: Collect detailed information  

      setup:  

        gather_subset:  

          - hardware  

          - network  

          - virtual  

  

    - name: Check memory usage  

      shell: free -m | awk 'NR==2{printf "%.2f%%", $3*100/$2 }'  

      register: memory_usage  

  

    - name: Check CPU usage  

      shell: top -bn1 | grep "Cpu(s)" | awk '{print $2}' | cut -d'%' -f1  

      register: cpu_usage  

  

    - name: Check uptime  

      shell: uptime -p  

      register: uptime  

  

    - name: Create XO report  

      local_action:  

        module: copy  

        content: |  

          XEN ORCHESTRA REPORT - {{ ansible_date_time.iso8601 }}  

          ===================================================  

          {% for host in groups['all'] %}  

          VM: {{ hostvars[host].xo_vm_name }}  

          UUID: {{ hostvars[host].xo_vm_id }}  

          IP: {{ hostvars[host].ansible_host }}  

          Hostname: {{ hostvars[host].ansible_hostname }}  

          Memory: {{ hostvars[host].memory_usage.stdout }}  

          CPU: {{ hostvars[host].cpu_usage.stdout }}%  

          Uptime: {{ hostvars[host].uptime.stdout }}  

          Pool: {{ hostvars[host].xo_pool }}  

          Template: {{ hostvars[host].xo_template }}  

          Status: {{ hostvars[host].xo_power_state }}  

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

          {% endfor %}  

        dest: "./xo-report-{{ ansible_date_time.epoch }}.txt"  

      run_once: true  

  

    - name: Monitoring summary  

      debug:  

        msg: |  

          XO monitoring completed  

          Report generated: xo-report-{{ ansible_date_time.epoch }}.txt  

          {{ groups['all'] | length }} VMs inventoried  
```

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

### Configure Credentials via Pulumi Config

Source: https://docs.xen-orchestra.com/xo6/pulumi-provider

Store credentials securely using Pulumi's built-in configuration management.

```bash
pulumi config set xenorchestra:url ws://your-xo-hostname  

pulumi config set xenorchestra:token YOUR_TOKEN --secret  
```

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

### Restart xo-server service

Source: https://docs.xen-orchestra.com/troubleshooting

Apply changes to the systemd service configuration.

```bash
systemctl daemon-reload  

systemctl restart xo-server
```

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

### Configure VM with Cloud-Init

Source: https://docs.xen-orchestra.com/xo6/pulumi-provider

Use the cloudConfig property to pass cloud-init YAML configuration for VM customization during deployment.

```typescript
const vmWithCloudInit = new xenorchestra.Vm("vm-with-cloudinit", {  

    // ... other parameters  

    cloudConfig: `#cloud-config  

users:  

  - name: demo  

    sudo: ALL=(ALL) NOPASSWD:ALL  

    ssh-authorized-keys:  

      - ssh-rsa <YOUR_PUBLIC_KEY_HERE>  

packages:  

  - nginx  

  - git  

runcmd:  

  - systemctl enable nginx  

  - systemctl start nginx  

`,  

});  
```

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

### Redirect Logs to a File

Source: https://docs.xen-orchestra.com/xo6/terraform-provider

Configure both the log level and the output file path to save provider logs for later analysis.

```bash
export TF_LOG_PROVIDER=DEBUG  

export TF_LOG_PATH=./terraform.log  

terraform apply  
```

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

### Test Xen Orchestra Dynamic Inventory

Source: https://docs.xen-orchestra.com/xo6/ansible

Commands to verify inventory connectivity, view host lists, and inspect specific VM details.

```bash
# List all hosts  

ansible-inventory -i xo_inventory.yaml --list   

  

# Display groups in tree form  

ansible-inventory -i xo_inventory.yaml --graph  

  

# Provides information about a specific host (VM UUID in XO)  

ansible-inventory -i xo_inventory.yaml --host=uuid-of-your-vm  
```

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

### Create an Ansible Vault file

Source: https://docs.xen-orchestra.com/xo6/ansible

Command to initialize a new encrypted vault file for storing sensitive credentials.

```bash
ansible-vault create vault.yaml
```

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

### Apply Terraform Configuration

Source: https://docs.xen-orchestra.com/xo6/terraform-provider

Execute the terraform apply command to provision resources defined in the configuration files.

```bash
william@william:~$ terraform apply   

data.xenorchestra_template.vm_template: Reading...  

data.xenorchestra_pool.pool: Reading...  

data.xenorchestra_pool.pool: Read complete after 1s [id=355ee47d-ff4c-4924-3db2-fd86ae629676]  

data.xenorchestra_network.network: Reading...  

data.xenorchestra_sr.sr: Reading...  

data.xenorchestra_template.vm_template: Read complete after 1s [id=d0b0869b-2503-0c17-1e5e-3725f6eba342]  

data.xenorchestra_network.network: Read complete after 0s [id=a12df741-f34f-7d05-f120-462f0ab39a48]  

data.xenorchestra_sr.sr: Read complete after 0s [id=86a9757d-9c05-9fe0-e79a-8243cb1f37f3]  

  

Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following  

symbols:  

+ create  

  

Terraform will perform the following actions:  

  

# xenorchestra_vm.vm will be created  

+ resource "xenorchestra_vm" "vm" {  

    + auto_poweron                        = false  

    + clone_type                          = "fast"  

    + core_os                             = false  

    + cpu_cap                             = 0  

    + cpu_weight                          = 0  

    + cpus                                = 1  

    + destroy_cloud_config_vdi_after_boot = false  

    + exp_nested_hvm                      = false  

    + hvm_boot_firmware                   = "bios"  

    + id                                  = (known after apply)  

    + ipv4_addresses                      = (known after apply)  

    + ipv6_addresses                      = (known after apply)  

    + memory_max                          = 2147467264  

    + memory_min                          = (known after apply)  

    + name_label                          = "XO terraform tutorial"  

    + power_state                         = "Running"  

    + start_delay                         = 0  

    + template                            = "d0b0869b-2503-0c17-1e5e-3725f6eba342"  

    + vga                                 = "std"  

    + videoram                            = 8  

  

    + disk {  

        + name_label = "VM root volume"  

        + position   = (known after apply)  

        + size       = 50214207488  

        + sr_id      = "86a9757d-9c05-9fe0-e79a-8243cb1f37f3"  

        + vbd_id     = (known after apply)  

        + vdi_id     = (known after apply)  

        }  

  

    + network {  

        + device         = (known after apply)  

        + ipv4_addresses = (known after apply)  

        + ipv6_addresses = (known after apply)  

        + mac_address    = (known after apply)  

        + network_id     = "a12df741-f34f-7d05-f120-462f0ab39a48"  

        }  

    }  

  

Plan: 1 to add, 0 to change, 0 to destroy.  

  

Do you want to perform these actions?  

Terraform will perform the actions described above.  

Only 'yes' will be accepted to approve.  

  

Enter a value: yes  

  

xenorchestra_vm.vm: Creating...  

xenorchestra_vm.vm: Still creating... [00m10s elapsed]  

xenorchestra_vm.vm: Creation complete after 17s [id=66ec6080-1a77-b460-1d63-8b39baa4a844]  

  

Apply complete! Resources: 1 added, 0 changed, 0 destroyed.
```

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

### Plan Infrastructure Updates

Source: https://docs.xen-orchestra.com/xo6/terraform-provider

Run the terraform plan command to preview changes to existing infrastructure, such as adding a network interface to a VM.

```bash
william@william:~$ terraform plan  

data.xenorchestra_pool.pool: Reading...  

data.xenorchestra_template.vm_template: Reading...  

data.xenorchestra_pool.pool: Read complete after 0s [id=355ee47d-ff4c-4924-3db2-fd86ae629676]  

data.xenorchestra_network.network: Reading...  

data.xenorchestra_sr.sr: Reading...  

data.xenorchestra_template.vm_template: Read complete after 0s [id=d0b0869b-2503-0c17-1e5e-3725f6eba342]  

data.xenorchestra_network.network: Read complete after 0s [id=a12df741-f34f-7d05-f120-462f0ab39a48]  

data.xenorchestra_sr.sr: Read complete after 0s [id=86a9757d-9c05-9fe0-e79a-8243cb1f37f3]  

xenorchestra_vm.vm: Refreshing state... [id=66ec6080-1a77-b460-1d63-8b39baa4a844]  

  

Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following  

symbols:  

~ update in-place  

  

Terraform will perform the following actions:  

  

# xenorchestra_vm.vm will be updated in-place  

~ resource "xenorchestra_vm" "vm" {  

        id                                  = "66ec6080-1a77-b460-1d63-8b39baa4a844"  

        tags                                = []  

        # (24 unchanged attributes hidden)  

  

      disk {  

            # (8 unchanged attributes hidden)  

        }  

  

    + network {  

        + attached       = true  

        + ipv4_addresses = (known after apply)  

        + ipv6_addresses = (known after apply)  

        + network_id     = "a12df741-f34f-7d05-f120-462f0ab39a48"  

        }  

  

        # (1 unchanged block hidden)  

    }  

  

Plan: 0 to add, 1 to change, 0 to destroy.
```

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

### Compose dynamic inventory variables

Source: https://docs.xen-orchestra.com/xo6/ansible

Configuration to dynamically set host and user variables based on VM metadata.

```yaml
compose:

  ansible_host: ipv4_addresses[0] if ipv4_addresses else "unknown"

  ansible_user: "{{ 'ubuntu' if 'Ubuntu' in name_label else 'root' }}"
```

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

### Apply inventory filters

Source: https://docs.xen-orchestra.com/xo6/ansible

Configuration snippet to filter VMs by power state.

```yaml
filters:

  - power_state == "Running"

strict: false
```

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

### Connect to Xen Orchestra session

Source: https://docs.xen-orchestra.com/xo6/powershell-module

Establishes a connection to the Xen Orchestra instance using a host URL and an API token generated in the user settings.

```powershell
Connect-XoSession -HostName "https://your-xo-server" -Token "your-api-token"
```

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

### Configure VM Tags

Source: https://docs.xen-orchestra.com/xo6/pulumi-provider

Assign an array of strings to the tags property to organize and categorize resources.

```typescript
const taggedVm = new xenorchestra.Vm(“tagged-vm”, {  

    // ... other parameters  

    tags: [“production”, “web-server”, “pulumi-managed”],  

});  
```

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

### Configure Provider via Variables

Source: https://docs.xen-orchestra.com/xo6/terraform-provider

Use a provider block to configure authentication details using local variables or environment variables.

```hcl
provider "xenorchestra" {  

# Must be ws or wss  

token = local.xoa_token         # or set the XOA_TOKEN environment variable  

url   = "ws://${local.xoa_url}" # or set the XOA_URL environment variable  

}
```

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

### Define Data Sources for Existing Resources

Source: https://docs.xen-orchestra.com/xo6/terraform-provider

Use data blocks to fetch information about existing pools, templates, storage repositories, and networks.

```hcl
# vm.tf  

  
data "xenorchestra_pool" "pool" {  

name_label = "Main pool"  

}  

  
data "xenorchestra_template" "vm_template" {  

name_label = "Ubuntu 24.04 Cloud-Init"  

}  

  
data "xenorchestra_sr" "sr" {  

name_label = "ZFS"  

pool_id = data.xenorchestra_pool.pool.id  

}  

  
data "xenorchestra_network" "network" {  

name_label = "Pool-wide network"  

pool_id = data.xenorchestra_pool.pool.id  

}
```

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

### Run XOA diagnostic check

Source: https://docs.xen-orchestra.com/troubleshooting

Execute this command in the terminal to verify system health, including Node version, disk space, and connectivity.

```bash
$ xoa check
```

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

### Configure XOA for transparent proxy

Source: https://docs.xen-orchestra.com/troubleshooting

Disable SSL verification for the updater to bypass transparent proxy issues.

```bash
sudo -s  

echo NODE_TLS_REJECT_UNAUTHORIZED=0 >> /etc/xo-appliance/env  

npm config -g set strict-ssl=false  

systemctl restart xoa-updater
```

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

### Configure default SR for XOA deployment

Source: https://docs.xen-orchestra.com/troubleshooting

Use these commands to identify and set the default Storage Repository (SR) when encountering auto-deploy failures.

```bash
xe sr-list
```

```bash
xe pool-param-set uuid=<pool-uuid> default-SR=<sr-uuid>
```

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

### Verify connection with debug mode

Source: https://docs.xen-orchestra.com/xo6/ansible

Command to troubleshoot API connection issues by enabling verbose debug output.

```bash
# Verify URL and credentials

ANSIBLE_DEBUG=1 ansible-inventory -i your_file.xen_orchestra.yml --list
```

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

### Identify a Base VM

Source: https://docs.xen-orchestra.com/xo6/powershell-module

Lists virtual machines to retrieve their names, UUIDs, and power states.

```powershell
Get-XoVm | Format-Table Name, Uuid, PowerState
```

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

### Create a role response

Source: https://docs.xen-orchestra.com/xo6/acl-v2

The JSON response received after successfully creating a new role.

```json
{ "id": "e4b1f3c2-1234-5678-abcd-000000000001" }
```

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

### Execute inventory with vault password

Source: https://docs.xen-orchestra.com/xo6/ansible

Command to list inventory items while prompting for the vault password.

```bash
ansible-inventory -i test.xen_orchestra.yaml --list --ask-vault-pass
```

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

### Verify Snapshot Creation

Source: https://docs.xen-orchestra.com/xo6/powershell-module

Queries for a snapshot by its label to confirm it was created successfully.

```powershell
Get-XoVmSnapshot -Filter "name_label:your-snapshot-name"
```

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

### Run XOA diagnostic check

Source: https://docs.xen-orchestra.com/troubleshooting

Execute the built-in check service to verify the health of the XOA appliance.

```bash
$ xoa check  

✔ Node version  

✔ Disk space for /var  

✔ Disk space for /  

✔ XOA version  

✔ xo-server config syntax  

✔ Appliance registration  

✔ Internet connectivity
```

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

### Configure the Xen Orchestra provider

Source: https://docs.xen-orchestra.com/xo6/terraform-provider

Define the required provider source and version in a provider.tf file to enable communication with Xen Orchestra.

```hcl
# provider.tf  

terraform {  

    required_providers {  

        xenorchestra = {  

            source  = "vatesfr/xenorchestra"  

            version = "~> 0.35"  

        }  

    }  

}  
```

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

### Configure Syslog Transport

Source: https://docs.xen-orchestra.com/backups

Add this configuration to /etc/xo-server/config.toml to enable forwarding logs to a remote syslog server.

```toml
[logs.transport.syslog]  

target = 'tcp://syslog.example.org:514'
```

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

### Debug and validate inventory

Source: https://docs.xen-orchestra.com/xo6/ansible

Commands for listing inventory, enabling debug mode, querying specific hosts, and testing connectivity.

```bash
ansible-inventory -i your_file.xen_orchestra.yml --list

  

ANSIBLE_DEBUG=1 ansible-inventory -i your_file.xen_orchestra.yml --list

  

ansible-inventory -i your_file.xen_orchestra.yml --host=uuid-vm-specific

  

ansible -i your_file.xen_orchestra.yml all -m ping
```

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

### Enable Pulumi Debug Logging

Source: https://docs.xen-orchestra.com/xo6/pulumi-provider

Use CLI flags to increase verbosity for troubleshooting. Note that high verbosity levels can impact performance.

```bash
pulumi up --debug  
```

```bash
pulumi up --logtostderr -v=9  
```
Tokens:
Raw