nttmcp.mcp.image_export (1.0.9) — module

Export a customer image to an OVF

| "added in version" 2.10.0 of nttmcp.mcp"

Authors: Ken Sinfield (@kensinfield)

preview | supported by NTT Ltd.

Install collection

Install with ansible-galaxy collection install nttmcp.mcp:==1.0.9


Add to requirements.yml

  collections:
    - name: nttmcp.mcp
      version: 1.0.9

Description

Export a customer image in Cloud Control to an OVF for download

For large images, set a higher wait_time to ensure Ansible will wait for the complete export or set wait == False

https://docs.mcp-services.net/x/rgMk


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- hosts: 127.0.0.1
  connection: local
  collections:
    - nttmcp.mcp
  tasks:

  - name: Export an image from NA9
    image_export:
      region: na
      datacenter: NA9
      name: myImage
      ovf_name: myImage_export

Inputs

    
auth:
    description:
    - Optional dictionary containing the authentication and API information for Cloud
      Control
    required: false
    suboptions:
      api:
        description:
        - The Cloud Control API endpoint e.g. api-na.mcp-services.net
        required: false
        type: str
      api_version:
        description:
        - The Cloud Control API version e.g. 2.11
        required: false
        type: str
      password:
        description:
        - The Cloud Control API user password
        required: false
        type: str
      username:
        description:
        - The Cloud Control API username
        required: false
        type: str
    type: dict

name:
    description:
    - The name of the image in Cloud Control
    required: true
    type: str

wait:
    default: true
    description:
    - Should Ansible wait for the task to complete before continuing
    required: false
    type: bool

region:
    default: na
    description:
    - The geographical region
    required: false
    type: str

ovf_name:
    description:
    - The name to be used for the exported OVF packacge
    - The OVF will be available on the FTPS server for this GEO
    required: true
    type: str

wait_time:
    default: 3600
    description: The maximum time the Ansible should wait for the task to complete in
      seconds
    required: false
    type: int

datacenter:
    description:
    - The datacenter name
    required: true
    type: str

wait_poll_interval:
    default: 15
    description:
    - The time in between checking the status of the task in seconds
    required: false
    type: int

Outputs

msg:
  description: A helpful message
  returned: always
  sample: The image was successfully exported with the export ID 71a365c4-f702-4e3c-ac11-34924aa36bf5
  type: str