morpheus.core.instance_snapshot_info (0.5.1) — module

Install collection

Install with ansible-galaxy collection install morpheus.core:==0.5.1

Add to requirements.yml

  collections:
    - name: morpheus.core
      version: 0.5.1

Description

Gather Snapshot information for instances.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get Snapshots for specific instance
  morpheus.core.instance_snapshot_info:
    id: 200

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
id:
    description:
    - Specify the id of an instance.
    type: int

name:
    description:
    - Filter instances by name.
    type: string

tags:
    description:
    - Filter instances by matching tags.
    elements: string
    type: list

labels:
    description:
    - Filter instances by matching labels.
    elements: string
    type: list

match_name:
    choices:
    - none
    - first
    - last
    - all
    default: all
    description:
    - Define instance selection method when specifying I(name) should more than one instance
      match.
    type: string

regex_name:
    default: false
    description:
    - Treat the name parameter as a regular expression.
    type: bool

environment:
    description:
    - Filter instances by environment.
    type: string

match_all_labels:
    default: false
    description:
    - If labels have been specified, filter instances by those that match all specified
      labels.
    type: bool

Outputs

instance_snapshots:
  description:
  - List of Instances and their snapshots
  returned: always
  sample:
    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