| 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.vcenter_cloud.
.. rst-class:: ansible-version-added
New in morpheus.core 0.7.0
- Manage VMware VCenter Clouds.
.. tabularcolumns:: \X{1}{3}\X{2}{3}
| Parameter | Comments |
|---|---|
Set the tenant for which Cloud is assigned to. |
|
Agent Install Mode. :ansval:`cloudinit` and :ansval:`unattend` are the same. :ansval:`guestexec`, :ansval:`ssh` and :ansval:`winrm` are the same. .. rst-class:: ansible-option-line |
|
The VCenter API URL. |
|
The VCenter API Version. .. rst-class:: ansible-option-line |
|
URL of the Morpheus Appliance. |
|
Automatically Power-on Virtual Machines. .. rst-class:: ansible-option-line |
|
VCenter Cluster name. |
|
The code to reference the Cloud for use in polcies etc. |
|
Guest console keyboard layout. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:`
|
|
Enable costing on the Cloud. .. rst-class:: ansible-option-line |
|
Specify id of existing credentials to use. |
|
Path to an image file to use as the Cloud logo when in dark mode. |
|
VCenter Datacenter name. |
|
Custom Datacenter Identifier. |
|
Set the description of the Cloud. |
|
The default Virtual Machine Disk type. .. rst-class:: ansible-option-line |
|
Enable user to select Virtual Machine Disk type. .. rst-class:: ansible-option-line |
|
Enable user to select the Network Interface type. .. rst-class:: ansible-option-line |
|
Enable user to select the Storage type. .. rst-class:: ansible-option-line |
|
Enable Hyper-Visor Console. .. rst-class:: ansible-option-line |
|
Enable :ansopt:`morpheus.core.vcenter\_cloud#module:enabled=true` or Disable :ansopt:`morpheus.core.vcenter\_cloud#module:enabled=false` the Cloud. .. rst-class:: ansible-option-line |
|
Force removal if Cloud is still in a group. .. rst-class:: ansible-option-line |
|
Set the Cloud Group this Cloud is a member of. |
|
Enable/Disable Cloud Guidance .. rst-class:: ansible-option-line |
|
Hide Cloud Host selection. .. rst-class:: ansible-option-line |
|
Specify an existing Cloud to Update or Remove. |
|
Inventory Cloud and Import existing Virtual Machines. .. rst-class:: ansible-option-line |
|
Add location information for the Cloud. |
|
Path to an image file to use as the Cloud logo. |
|
Set the name of the Cloud. |
|
Specify a password to access the cloud. |
|
The type of refresh to perform. :ansval:`costing` Pull costing data. :ansval:`costing\_rebuild` Purge existing costing data and rebuild by calling the Cloud API. :ansval:`daily` Perform a daily Cloud Sync. :ansval:`hourly` Perform hourly Cloud Sync. .. rst-class:: ansible-option-line |
|
The invoice billing period to refresh. The value should be in the format of YYYYMM. |
|
Relevant when :ansopt:`morpheus.core.vcenter\_cloud#module:state=absent`, remove associated resources when removing the cloud. Includes removal of Virtual Machines and other forms of Compute. .. rst-class:: ansible-option-line |
|
VCenter Resource Pool name. |
|
Cloud workload interaction method. :ansval:`guestexec` = VMWare Tools :ansval:`rpc` = SSH/WinRM .. rst-class:: ansible-option-line |
|
Set Scale Priority. |
|
Host firewall. .. rst-class:: ansible-option-line |
|
Create, Update or Remove a Cloud. .. rst-class:: ansible-option-line |
|
The Time Zone of the Cloud. |
|
Specify a username to access the cloud. |
|
Toggle tenant visibility between Private or Public. .. 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 new VCenter Cloud
morpheus.core.vcenter_cloud:
state: present
name: VCenter Cloud
description: A VCenter Cloud
code: 'vccloud'
location: 'south'
visibility: private
group_id: 50
account_id: 1
enabled: true
agent_mode: cloudinit
auto_recover_power_state: false
import_existing: false
costing_mode: off
guidance_mode: off
security_mode: off
credential_id: 3
api_url: 'https://vcenter.domain.tld/sdk'
api_version: '7.0'
datacenter: 'VCCloud'
cluster: 'Cluster01'
resource_pool: 'All'
rpc_mode: guestexec
disk_storage_type: thin
enable_disk_type_selection: true
enable_storage_type_selection: false
enable_network_type_selection: true
enable_vnc: true
hide_host_selection: true
console_keymap: uk
timezone: "Europe/London"
- name: Remove VCenter Cloud
morpheus.core.vcenter_cloud:
state: absent
id: 56
force_remove: true
- name: Refresh and Rebuild Cloud Costing
morpheus.core.vcenter_cloud:
state: refresh
name: VCenter Cloud
refresh_mode: costing_rebuild
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