xenserver_guest: copying from existing VM fails

[MATTHIASGOLIATH]

Summary

When attempting to deploy a VM by copying an existing VM using the xenserver_guest module, a task will fail with the XAPI error: PROVISION_ONLY_ALLOWED_ON_TEMPLATE despite copying from an existing VM via the template parameter being advised in teh documentation.

Issue Type

Bug Report

Component Name

xenserver_guest module

Ansible Version

$ ansible --version
ansible [core 2.16.3]
  config file = /.../ansible.cfg
  configured module search path = ['/.../.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python3/dist-packages/ansible
  ansible collection location = /.../.ansible/collections:/usr/share/ansible/collections
  executable location = /usr/bin/ansible
  python version = 3.12.3 (main, Jun 19 2026, 12:46:00) [GCC 13.3.0] (/usr/bin/python3)
  jinja version = 3.1.2
  libyaml = True

Community.general Version

$ ansible-galaxy collection list community.general

# /usr/lib/python3/dist-packages/ansible_collections
Collection        Version
----------------- -------
community.general 8.3.0

Configuration

$ ansible-config dump --only-changed

OS / Environment

No response

Steps to Reproduce

    - name: Copy VM
      community.general.xenserver_guest:
        hostname: "{{ xcp_host }}"
        username: "{{ xcp_username }}"
        password: "{{ xcp_password }}"
        name: "{{ new_vm_name }}"
        template: "{{ old_vm_name }}"
        state: poweredon
        name_desc: "{{ description }}"
        disks:
          - name: "{{ new_vm_name }}_root"
            name_desc: "{{ description }}"
      register: deploy

Expected Results

Expected: successful copy, similar to output if copied via template.

Actual Results

    "msg": "XAPI ERROR: ['PROVISION_ONLY_ALLOWED_ON_TEMPLATE']"

Code of Conduct

• I agree to follow the Ansible Code of Conduct

[ansibullbot]

Files identified in the description:

• plugins/modules/xenserver_guest.py

If these files are incorrect, please update the component name section of the description or use the !component bot command.

click here for bot help

[ansibullbot]

cc @bvitnik
click here for bot help

[bvitnik]

What's the version of XCP-ng or XenServer you are running? Is your old VM turned off?

[MATTHIASGOLIATH]

@bvitnik We are running XCP-ng 8.3. The old VM was turned off

[bvitnik]

Great. I'll try to reproduce this.

[bvitnik]

Hi @MATTHIASGOLIATH . I've managed to reproduce this issue. I guess it is one of those rare code paths that were never really tested. I've implemented the fix in my private fork and tested it in my home lab environment. I would like you to test it also so I can make a PR and get this fix upstreamed.

To test the fix, add this to your requirements.yml:

collections:
- name: https://github.com/bvitnik/community.general
  type: git
  version: xenserver-guest-fix-12576

After that, run ansible-galaxy collection install -r requirements.yml to install this fixed version of the community.general collection. Add -p ./collections/ to the command line if you want to install the collection to the local project folder instead of global collection installation path.

[bvitnik]

@MATTHIASGOLIATH a kindly reminder.

[MATTHIASGOLIATH]

@bvitnik apologies for the delay, will attempt to test by end-of-week

[bvitnik]

Great. My plan is to create a PR and push this fix upstream on weekend or at the beginning of next week.