| orphan: |
|---|
Note
This module is part of the morpheus.core collection (version 0.7.1).
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install morpheus.core.
To use it in a playbook, specify: morpheus.core.virtual_image.
.. rst-class:: ansible-version-added
New in morpheus.core 0.6.0
- Manage Morpheus Virtual Images.
.. tabularcolumns:: \X{1}{3}\X{2}{3}
| Parameter | Comments |
|---|---|
List of Tenants by Id Virtual Image is available to. |
|
For Azure Virtual Images, specify further options. |
|
Name of Offer in the Azure Marketplace. |
|
Name of Publisher in the Azure Marketplace. |
|
Name of SKU in the Azure Marketplace. |
|
Name of Version in the Azure Marketplace. |
|
Dictionary of Virtual Image configuration. |
|
URL of file to upload. |
|
Name of uploaded file. |
|
Set the Image Type code, e.g. vmware |
|
Specify if Morpheus Agent should be installed. .. rst-class:: ansible-option-line |
|
Whether to Auto Join Domain. .. rst-class:: ansible-option-line |
|
Specify if Cloud Init is enabled. .. rst-class:: ansible-option-line |
|
Specify if Sysprep is Enabled. .. rst-class:: ansible-option-line |
|
Provide a list of labels to apply to Virtual Image. |
|
Set the Name of the Virtual Image |
|
Specify the OS Type code or name. |
|
Specify the Password for the Virtual Image. |
|
Specify an SSH Key for the Virtual Image. |
|
Create, update or remove a Virtual Image. If :ansopt:`morpheus.core.virtual\_image#module:state=absent` and :ansopt:`morpheus.core.virtual\_image#module:filename` is specified then remove the specified file. .. rst-class:: ansible-option-line |
|
Specify the Storage Provider by Id. |
|
List of Tags to apply. |
|
The Tag name. |
|
The Tag value. |
|
Is the Virtual Image a Trial Version. .. rst-class:: ansible-option-line |
|
Cloud Init user data. |
|
Specify the Username for the Virtual Image. |
|
Are Virtio Drivers installed. .. rst-class:: ansible-option-line |
|
Specify Virtual Image by Id. |
|
If the Virtual Image should be private or public. .. rst-class:: ansible-option-line |
|
Are VMware Tools installed. .. rst-class:: ansible-option-line |
.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10}
| Attribute | Support | Description |
|---|---|---|
Can run in check_mode and return changed status prediction without modifying target |
||
Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode |
||
Target OS/families that can be operated against |
- name: Create Virtual Image and upload File
morpheus.core.virtual_image:
state: present
name: My VMware Image
image_type: vmware
is_cloud_init: true
install_agent: true
username: root
password: Password123
os_type: redhat 8 64bit
visibility: public
accounts:
- 1
vm_tools_installed: true
filename: rhel8x64.ova
file_url: https://my.domain.tld/rhel8x64.ova
- name: Remove Virtual Image by Name
morpheus.core.virtual_image:
state: absent
name: Win2016
- name: Remove Virtual Image by Id
morpheus.core.virtual_image:
state: absent
virtual_image_id: 700
- name: Remove Virtual Image File
morpheus.core.virtual_image:
virtual_image_id: 750
filename: windows_template.ova
state: absent
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
.. tabularcolumns:: \X{1}{3}\X{2}{3}
- James Riach (@McGlovin1337)
.. ansible-links::
- title: "Repository (Sources)"
url: "https://www.github.com/gomorpheus/ansible-collection-morpheus-core"
external: true