morpheus.core.virtual_image_info (0.6.0) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: morpheus.core
      version: 0.6.0

Description

Gathers information about Virtual Images.

Usage examples

Scanned by Steampunk Spotter

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

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

Scanned by Steampunk Spotter

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

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

Scanned by Steampunk Spotter

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

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

Scanned by Steampunk Spotter

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

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

Scanned by Steampunk Spotter

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

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

Inputs

    
name:
    description:
    - Return info for Virtual Image by Name
    type: string

detail:
    choices:
    - full
    - summary
    default: summary
    description:
    - Level of detail returned about Virtual Images
    type: string

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

image_type:
    description:
    - Filter by image type code, e.g. vmware, ami
    type: string

regex_name:
    default: false
    description:
    - Treat name parameter as a Regular Expression
    type: bool

filter_type:
    choices:
    - all
    - synced
    - system
    - user
    default: all
    description:
    - Filter Virtual Images by type
    type: string

match_all_labels:
    default: false
    description:
    - If true, match all specified labels
    type: bool

virtual_image_id:
    description:
    - Return info for specic Virtual Image by Id
    type: int

Outputs

virtual_images:
  description:
  - List of Virtual Images
  returned: always
  sample:
    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: []