New in version 2.8.
The below requirements are needed on the host that executes this module.
python >= 2.6
XenAPI
Parameter | Choices/Defaults | Comments |
---|---|---|
hostname
string
|
Default: "localhost"
|
The hostname or IP address of the XenServer host or XenServer pool master.
If the value is not specified in the task, the value of environment variable
XENSERVER_HOST will be used instead.aliases: host, pool |
name
string
/ required
|
Name of the VM to gather facts from.
VMs running on XenServer do not necessarily have unique names. The module will fail if multiple VMs with same name are found.
In case of multiple VMs with same name, use
uuid to uniquely specify VM to manage.This parameter is case sensitive.
aliases: name_label |
|
password
string
|
The password to use for connecting to XenServer.
If the value is not specified in the task, the value of environment variable
XENSERVER_PASSWORD will be used instead.aliases: pass, pwd |
|
username
string
|
Default: "root"
|
The username to use for connecting to XenServer.
If the value is not specified in the task, the value of environment variable
XENSERVER_USER will be used instead.aliases: admin, user |
uuid
string
|
UUID of the VM to gather fact of. This is XenServer's unique identifier.
It is required if name is not unique.
|
|
validate_certs
boolean
|
|
Allows connection when SSL certificates are not valid. Set to
false when certificates are not trusted.If the value is not specified in the task, the value of environment variable
XENSERVER_VALIDATE_CERTS will be used instead. |
Note
Minimal supported version of XenServer is 5.6.
Module was tested with XenServer 6.5, 7.1 and 7.2.
XenAPI Python library can be acquired from XenServer SDK (downloadable from Citrix website) or by running pip install XenAPI
(possibly very old version, not compatible with Python 3.x). Latest version can also be acquired from GitHub: https://raw.githubusercontent.com/xapi-project/xen-api/master/scripts/examples/python/XenAPI.py
If no scheme is specified in hostname
, module defaults to http://
because https://
is problematic in most setups. Make sure you are accessing XenServer host in trusted environment or use https://
scheme explicitly.
To use https://
scheme for hostname
you have to either import host certificate to your OS certificate store or use validate_certs: no
which requires XenAPI library from XenServer 7.2 SDK or newer and Python 2.7.9 or newer.
- name: Gather facts
xenserver_guest_facts:
hostname: "{{ xenserver_hostname }}"
username: "{{ xenserver_username }}"
password: "{{ xenserver_password }}"
name: testvm_11
delegate_to: localhost
register: facts
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
instance
dictionary
|
always |
Metadata about the VM
Sample:
{'cdrom': {'type': 'none'}, 'customization_agent': 'native', 'disks': [{'name': 'testvm_11-0', 'name_desc': '', 'os_device': 'xvda', 'size': 42949672960, 'sr': 'Local storage', 'sr_uuid': '0af1245e-bdb0-ba33-1446-57a962ec4075', 'vbd_userdevice': '0'}, {'name': 'testvm_11-1', 'name_desc': '', 'os_device': 'xvdb', 'size': 42949672960, 'sr': 'Local storage', 'sr_uuid': '0af1245e-bdb0-ba33-1446-57a962ec4075', 'vbd_userdevice': '1'}], 'domid': '56', 'folder': '', 'hardware': {'memory_mb': 8192, 'num_cpu_cores_per_socket': 2, 'num_cpus': 4}, 'home_server': '', 'is_template': False, 'name': 'testvm_11', 'name_desc': '', 'networks': [{'gateway': '192.168.0.254', 'gateway6': 'fc00::fffe', 'ip': '192.168.0.200', 'ip6': ['fe80:0000:0000:0000:e9cb:625a:32c5:c291', 'fc00:0000:0000:0000:0000:0000:0000:0001'], 'mac': 'ba:91:3a:48:20:76', 'mtu': '1500', 'name': 'Pool-wide network associated with eth1', 'netmask': '255.255.255.128', 'prefix': '25', 'prefix6': '64', 'vif_device': '0'}], 'other_config': {'base_template_name': 'Windows Server 2016 (64-bit)', 'import_task': 'OpaqueRef:e43eb71c-45d6-5351-09ff-96e4fb7d0fa5', 'install-methods': 'cdrom', 'instant': 'true', 'mac_seed': 'f83e8d8a-cfdc-b105-b054-ef5cb416b77e'}, 'platform': {'acpi': '1', 'apic': 'true', 'cores-per-socket': '2', 'device_id': '0002', 'hpet': 'true', 'nx': 'true', 'pae': 'true', 'timeoffset': '-25200', 'vga': 'std', 'videoram': '8', 'viridian': 'true', 'viridian_reference_tsc': 'true', 'viridian_time_ref_count': 'true'}, 'state': 'poweredon', 'uuid': 'e3c0b2d5-5f05-424e-479c-d3df8b3e7cda', 'xenstore_data': {'vm-data': ''}}
|
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]
Bojan Vitnik (@bvitnik) <bvitnik@mainstream.rs>
Hint
If you notice any issues in this documentation you can edit this document to improve it.