serverscom.sc_api.sc_cloud_computing_images_info (0.1.0) — module

List of available images and snapshots

| "added in version" 1.0.0 of serverscom.sc_api"

Authors: George Shuklin (@amarao)

preview | supported by community

Install collection

Install with ansible-galaxy collection install serverscom.sc_api:==0.1.0


Add to requirements.yml

  collections:
    - name: serverscom.sc_api
      version: 0.1.0

Description

Return list of all available images and snapshots in region.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
    - name: List all images in region
      sc_cloud_computing_images_info:
        token: '{{ sc_token }}'
        region_id: 0
      register: images
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
    - debug: var=images.cloud_images

Inputs

    
token:
    description:
    - Token to use.
    - You can create token for you account in https://portal.servers.com in Profile ->
      Public API section.
    required: true
    type: str

endpoint:
    default: https://api.servers.com/v1
    description:
    - Endpoint to use to connect to API.
    - Do not change until specifically asked to do otherwise.
    type: str

region_id:
    description:
    - Id of cloud computing region.
    - Use I(serverscom.sc_api.sc_cloud_computing_regions_info) module to retrive list
      of available regions.
    required: true
    type: int

Outputs

api_url:
  description: URL for the failed request
  returned: on failure
  type: str
cloud_images:
  contains:
    allowed_flavors:
      description:
      - List of flavors allowed to run this image.
      - Empy list means compatibility with any flavor.
      - Mostly used for license-specific images.
      elements: str
      type: list
    id:
      description:
      - Id of the image.
      type: str
    image_size:
      description:
      - Image size in bytes (compressed)
      type: int
    min_size:
      description:
      - Minimal size of the disk (flavor) to use image.
      type: int
    name:
      description:
      - Human-readable name of the image.
      type: str
  description:
  - List of available images
  returned: on success
  type: complex
status_code:
  description: Status code for the request
  returned: always
  type: int