gcore.cloud.image_info (1.0.1) — module

Gather infos about all GCore images.

Authors: GCore (@GCore)

Install collection

Install with ansible-galaxy collection install gcore.cloud:==1.0.1


Add to requirements.yml

  collections:
    - name: gcore.cloud
      version: 1.0.1

Description

Gather infos about all GCore images.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Gather gcore images info
  gcore.cloud.image_info:
    api_key: "{{ api_key }}"
    region_id: "{{ region_id }}"
    project_id: "{{ project_id }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Gather gcore specific image info
  gcore.cloud.image_info:
    api_key: "{{ api_key }}"
    region_id: "{{ region_id }}"
    project_id: "{{ project_id }}"
    image_id: "{{ image_id }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Gather gcore images owned by project
  gcore.cloud.image_info:
    api_key: "{{ api_key }}"
    region_id: "{{ region_id }}"
    project_id: "{{ project_id }}"
    project: true

Inputs

    
api_key:
    description:
    - GCore API auth key
    - Can be passed as I(CLOUD_API_KEY) environment variable.
    type: str

private:
    description:
    - Any value to show private images
    required: false
    type: str

project:
    description:
    - Show images owned by project
    required: false
    type: bool

api_host:
    default: https://api.gcore.com/cloud
    description:
    - GCore API base host
    - Can be passed as I(CLOUD_API_HOST) environment variable.
    type: str

image_id:
    description:
    - The ID of the image you want to get.
    - The module will fail if the provided ID is invalid.
    required: false
    type: str

region_id:
    description:
    - GCore API region ID
    - Required if I(region_name) is not passed
    - Can be passed as I(CLOUD_REGION_ID) environment variable.
    type: int

metadata_k:
    description:
    - Filter by metadata keys. Must be a valid JSON string
    required: false
    type: str

project_id:
    description:
    - GCore API project ID
    - Required if I(project_name) is not passed
    - Can be passed as I(CLOUD_PROJECT_ID) environment variable.
    type: int

visibility:
    choices:
    - private
    - public
    - shared
    description:
    - Image visibility. Globally visible images are public.
    required: false
    type: str

api_timeout:
    default: 30
    description:
    - Timeout in seconds to polling GCore API
    type: int

metadata_kv:
    description:
    - Filter by metadata key-value pairs. Must be a valid JSON string
    required: false
    type: str

region_name:
    description:
    - GCore API region name
    - Required if I(region_id) is not passed
    - Can be passed as I(CLOUD_REGION_NAME) environment variable.
    type: str

project_name:
    description:
    - GCore API project name
    - Required if I(project_id) is not passed
    - Can be passed as I(CLOUD_PROJECT_NAME) environment variable.
    type: str

include_prices:
    description:
    - Show price
    required: false
    type: bool

Outputs

image_info:
  contains:
    architecture:
      description: An image architecture type
      returned: if available
      sample: x86_64
      type: str
    created_at:
      description: Datetime when the image was created
      returned: always
      sample: 2020-11-13T11:26:19+0000
      type: str
    creator_task_id:
      description: Task that created this entity
      returned: if available
      sample: b10dd116-07f5-4225-abb7-f42da5cb78fb
      type: str
    currency_code:
      description: Currency code
      returned: if available
      sample: USD
      type: str
    description:
      description: Image description
      returned: if available
      sample: Test image
      type: str
    disk_format:
      description: Disk format
      returned: if available
      sample: raw
      type: str
    display_order:
      description: Display order
      returned: if available
      sample: 2010
      type: int
    hw_firmware_type:
      description: Specifies the type of firmware with which to boot the guest
      returned: if available
      sample: bios
      type: str
    hw_machine_type:
      description: A virtual chipset type
      returned: if available
      sample: q35
      type: str
    id:
      description: Image ID
      returned: always
      sample: 44e136a7-15c1-4b5f-a086-20b7b3237d40
      type: str
    is_baremetal:
      description: Set to true if the image will be used by baremetal instances. Defaults
        to false
      returned: if availble
      sample: false
      type: bool
    metadata:
      description: Metadata
      returned: if available
      sample:
        key: value
      type: dict
    metadata_detailed:
      description: Image metadata
      returned: if available
      sample:
      - key: key
        read_only: false
        value: value
      type: list
    min_disk:
      description: Minimal boot volume required
      returned: if available
      sample: 3
      type: int
    min_ram:
      description: Minimal VM RAM required
      returned: if available
      sample: 0
      type: int
    name:
      description: Image display name
      returned: always
      sample: ubuntu-20.10-x64
      type: str
    os_distro:
      description: OS Distribution, i.e. Debian, CentOS, Ubuntu, CoreOS etc
      returned: if available
      sample: ubuntu
      type: str
    os_type:
      description: The operating system installed on the image
      returned: if available
      sample: linux
      type: str
    os_version:
      description: OS version, i.e. 19.04 (for Ubuntu) or 9.4 for Debian
      returned: if available
      sample: 20.1
      type: str
    price_per_hour:
      description: Price per hour
      returned: if available
      sample: 1
      type: int
    price_per_month:
      description: Price per month
      returned: if available
      sample: 720
      type: int
    price_status:
      description: Price status
      returned: if available
      sample: show
      type: str
    project_id:
      description: Project ID
      returned: always
      sample: 1
      type: int
    region:
      description: Region name
      returned: always
      sample: Luxembourg 1
      type: str
    region_id:
      description: Region ID
      returned: always
      sample: 1
      type: int
    size:
      description: Image size in bytes
      returned: if available
      sample: 2361393152
      type: int
    ssh_key:
      description: Whether the image supports SSH key or not
      returned: if available
      sample: allow
      type: str
    status:
      description: Image status, i.e. active
      returned: if available
      sample: active
      type: str
    task_id:
      description: Active task. If None, action has been performed immediately in
        the request itself
      returned: if available
      sample: 907a87b0-7b63-4fd5-beb3-5ab4ba445c93
      type: str
    updated_at:
      description: Datetime when the image was updated
      returned: if available
      sample: 2020-12-18T14:51:20+0000
      type: str
    visibility:
      description: Image visibility. Globally visible images are public
      returned: if available
      sample: public
      type: str
  description:
  - When I(image_id) is passed, it is a dict of resource.
  - Otherwise it is a list of dictionaries.
  returned: always
  type: complex

See also