morpheus.core.instance_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

Gathers information about Morpheus instances

Usage examples

Scanned by Steampunk Spotter

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

- name: Get Info for a Specific Instance by id
  morpheus.core.instance_info:
    id: 200

Scanned by Steampunk Spotter

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

- name: Get a short summary of instances
  morpheus.core.instance_info:
    detail: summary

Scanned by Steampunk Spotter

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

- name: Get Info for instance by name
  morpheus.core.instance_info:
    name: WebServer001

Scanned by Steampunk Spotter

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

- name: Get Info for instances where name matches regular expression
  morpheus.core.instance_info:
    name: ^WebServer.*$
    regex_name: true

Scanned by Steampunk Spotter

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

- name: Get Extra Info for a Specific Instance by id
  morpheus.core.instance_info:
    id: 200
    detail: extra

Scanned by Steampunk Spotter

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

- name: Get Info for all Instances with any of the specified labels
  morpheus.core.instance_info:
    labels:
      - foo
      - bar
      - prod

Scanned by Steampunk Spotter

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

- name: Get Info of all Running Instances
  morpheus.core.instance_info:
    status: running

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

detail:
    choices:
    - minimal
    - full
    - extra
    - summary
    default: minimal
    description:
    - Specify the level of detail returned for matching instances.
    type: string

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

status:
    description:
    - Filter by instance status, e.g. running
    type: string

deleted:
    choices:
    - exclude
    - include
    - only
    default: exclude
    description:
    - Include, Exclude or Only show deleted instances or those pending removal.
    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

instance_type:
    description:
    - Filter by the instance type code.
    type: string

agent_installed:
    description:
    - Filter by if agent is installed or not.
    type: bool

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

Outputs

morpheus_instances:
  description:
  - List of instances with info
  returned: always
  sample:
    morpheus_instances:
    - cloud:
        id: 31
        name: VMWare Cloud
        type: vmware
      connection_info:
      - ip: 192.168.0.10
        name: null
        port: null
      date_created: '2023-06-01T13:37:00Z'
      description: Webserver Instance
      id: 100
      instance_type:
        code: win2019
        id: 110
        name: Windows Server 2019
      instance_version: '2019'
      interfaces:
      - id: network-100
        ip_address: null
        ip_mode: null
        network:
          dhcp_server: false
          group: null
          id: 150
          name: inside-network-001
          pool:
            id: 30
            name: inside-network-pool-001
          subnet: null
        network_interface_type_id: null
      labels:
      - production
      - webservers
      name: WebServ001
      owner:
        username: patrick.clifton@domain.tld
      plan:
        name: Cheap Plan 001
      stats:
        cpu_usage: 0
        cpu_usage_avg: 0
        cpu_usage_peak: 0.0
        max_memory: 4293943296
        max_storage: 53687091200
        used_cpu: 0.0
        used_memory: 2080228608
        used_storage: 25341928960
      status: running
      volumes:
      - name: root
        resizeable: true
        root_volume: true
        size: 50