virtual_image_info_module.rst

orphan:

morpheus.core.virtual_image_info module -- Gather Virtual Image information

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_info.

.. rst-class:: ansible-version-added

New in morpheus.core 0.6.0

• Synopsis
• Parameters
• Attributes
• Examples
• Return Values

Synopsis

• Gathers information about Virtual Images.

Parameters

.. tabularcolumns:: \X{1}{3}\X{2}{3}

Parameter	Comments
.. rst-class:: ansible-option-title detail .. ansible-option-type-line:: :ansible-option-type:`string`	Level of detail returned about Virtual Images .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"full"` :ansible-option-choices-entry-default:`"summary"` :ansible-option-choices-default-mark:`← (default)`
.. rst-class:: ansible-option-title filter_type .. ansible-option-type-line:: :ansible-option-type:`string`	Filter Virtual Images by type .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` :ansible-option-choices-entry-default:`"all"` :ansible-option-choices-default-mark:`← (default)` :ansible-option-choices-entry:`"synced"` :ansible-option-choices-entry:`"system"` :ansible-option-choices-entry:`"user"`
.. rst-class:: ansible-option-title image_type .. ansible-option-type-line:: :ansible-option-type:`string`	Filter by image type code, e.g. vmware, ami
.. rst-class:: ansible-option-title labels .. ansible-option-type-line:: :ansible-option-type:`list` / :ansible-option-elements:`elements=string`	Filter by matching labels
.. rst-class:: ansible-option-title match_all_labels .. ansible-option-type-line:: :ansible-option-type:`boolean`	If true, match all specified labels .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` :ansible-option-choices-entry:`true`
.. rst-class:: ansible-option-title name .. ansible-option-type-line:: :ansible-option-type:`string`	Return info for Virtual Image by Name
.. rst-class:: ansible-option-title regex_name .. ansible-option-type-line:: :ansible-option-type:`boolean`	Treat name parameter as a Regular Expression .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` :ansible-option-choices-entry:`true`
.. rst-class:: ansible-option-title virtual_image_id .. ansible-option-type-line:: :ansible-option-type:`integer`	Return info for specic Virtual Image by Id

Attributes

.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10}

Attribute	Support	Description
.. rst-class:: ansible-option-title check_mode	:ansible-attribute-support-label:`Support: \ ` :ansible-attribute-support-na:`N/A` Not Required, Module does not make changes.	Can run in check_mode and return changed status prediction without modifying target
.. rst-class:: ansible-option-title diff_mode	:ansible-attribute-support-label:`Support: \ ` :ansible-attribute-support-na:`N/A`	Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode
.. rst-class:: ansible-option-title platform	:ansible-attribute-support-property:`Platform:` :ansible-attribute-support-full:`httpapi`	Target OS/families that can be operated against

Examples

- name: Get Virtual Image by Id
  morpheus.core.virtual_image_info:
    virtual_image_id: 500

- name: Get Virtual Image by Name
  morpheus.core.virtual_image_info:
    name: redhat_image

- name: Get Virtual Images by Regex Match
  morpheus.core.virtual_image_info:
    name: ^.*$
    regex_name: true

- name: Get Synced VMware Virtual Images
  morpheus.core.virtual_image_info:
    filter_type: synced
    image_type: vmware

- name: Get User Virtual Images
  morpheus.core.virtual_image_info:
    filter_type: user

Return Values

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}

Key

Description

.. rst-class:: ansible-option-title virtual_images .. ansible-option-type-line:: :ansible-option-type:`list` / :ansible-option-elements:`elements=string`

List of Virtual Images .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"virtual\_images": [{"date\_created": "2023-01-01T00:00:00Z", "description": null, "id": 500, "image\_type": "vmdk", "install\_agent": false, "is\_cloud\_init": false, "is\_force\_customization": false, "labels": [], "locations": [], "min\_disk\_gb": null, "min\_ram\_gb": 4, "name": "My User Image", "os\_type": {"bit\_count": 64, "category": "suse", "code": "suse.11.64", "description": null, "id": 92, "name": "suse enterprise 11 64-bit", "os\_family": "suse", "os\_version": "11", "platform": "linux", "vendor": "suse"}, "raw\_size\_gb": null, "ssh\_username": null, "status": "queued", "vm\_tools\_installed": true, "volumes": []}]}`

Authors

• James Riach (@McGlovin1337)

Collection links

.. ansible-links::

  - title: "Repository (Sources)"
    url: "https://www.github.com/gomorpheus/ansible-collection-morpheus-core"
    external: true