instance_snapshot_info_module.rst

orphan:

morpheus.core.instance_snapshot_info module -- Gather Snapshot information for instances

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

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

New in morpheus.core 0.5.0

• Synopsis
• Parameters
• Attributes
• Examples
• Return Values

Synopsis

• Gather Snapshot information for instances.

Parameters

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

Parameter	Comments
.. rst-class:: ansible-option-title environment .. ansible-option-type-line:: :ansible-option-type:`string`	Filter instances by environment.
.. rst-class:: ansible-option-title id .. ansible-option-type-line:: :ansible-option-type:`integer`	Specify the id of an instance.
.. rst-class:: ansible-option-title labels .. ansible-option-type-line:: :ansible-option-type:`list` / :ansible-option-elements:`elements=string`	Filter instances by matching labels.
.. rst-class:: ansible-option-title match_all_labels .. ansible-option-type-line:: :ansible-option-type:`boolean`	If labels have been specified, filter instances by those that 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 match_name .. ansible-option-type-line:: :ansible-option-type:`string`	Define instance selection method when specifying name should more than one instance match. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"none"` :ansible-option-choices-entry:`"first"` :ansible-option-choices-entry:`"last"` :ansible-option-choices-entry-default:`"all"` :ansible-option-choices-default-mark:`← (default)`
.. rst-class:: ansible-option-title name .. ansible-option-type-line:: :ansible-option-type:`string`	Filter instances by name.
.. rst-class:: ansible-option-title regex_name .. ansible-option-type-line:: :ansible-option-type:`boolean`	Treat the 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 tags .. ansible-option-type-line:: :ansible-option-type:`list` / :ansible-option-elements:`elements=string`	Filter instances by matching tags.

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 Snapshots for specific instance
  morpheus.core.instance_snapshot_info:
    id: 200

- name: Get Snapshots for instances matching regex pattern
  morpheus.core.instance_snapshot_info:
    name: ^PRODWEB.*$
    regex_name: true

- name: Get Snapshots for instances with assigned labels
  morpheus.core.instance_snapshot_info:
    labels:
      - PROD
      - WEB

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 instance_snapshots .. ansible-option-type-line:: :ansible-option-type:`list` / :ansible-option-elements:`elements=string`

List of Instances and their snapshots .. 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:`{"instance\_snapshots": [{"instance\_id": 200, "instance\_name": "PRODWEBSVR001", "snapshot\_count": 1, "snapshots": [{"currently\_active": true, "datastore": null, "date\_created": "2023-07-29T15:33:05Z", "description": "Pre-maintenance Snapshot", "external\_id": "snapshot-100000", "id": 1, "name": "PRODWEBSVR001-2023-07-29T15:32:51.774Z", "parent\_snapshot": null, "snapshot\_created": "2023-07-29T15:33:36Z", "snapshot\_type": "vm", "state": null, "status": "complete", "zone": {"id": 5, "name": "Web Cloud"}}]}]}`

Authors

• James Riach (@McGlovin1337)

Collection links

.. ansible-links::

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