nttmcp.mcp.snapshot (1.0.9) — module

Initiate, update or delete a manual snapshot on a server

| "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

Initiate a manual snapshot on a server


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: Initiate a manual snapshot
    snapshot_info:
      region: na
      datacenter: NA9
      server: myServer
      description: A random snapshot

  - name: Update the metadata on a manual snapshot
    snapshot_info:
      region: na
      id: 112b7faa-ffff-ffff-ffff-dc273085cbe4
      description: A random snapshot description

  - name: Delete a manual snapshot
    snapshot_info:
      region: na
      id: 112b7faa-ffff-ffff-ffff-dc273085cbe4
      state: absent

Inputs

    
id:
    description:
    - The UUID of the snapshot to delete
    required: false
    type: str

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

state:
    choices:
    - present
    - absent
    default: present
    description:
    - The action to be performed
    required: false
    type: str

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

server:
    description:
    - The name of a server to enable Snapshots on
    required: false
    type: str

server_id:
    description:
    - The UUID of a server to enable Snapshots on
    required: false
    type: str

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

description:
    description:
    - Optional description for the manual snapshot
    required: false
    type: str

network_domain:
    description:
    - The name of a Cloud Network Domain
    required: false
    type: str

Outputs

data:
  description: Manual snapshot UUID
  returned: success
  sample: 112b7faa-ffff-ffff-ffff-dc273085cbe4
  type: str
msg:
  description: Message
  returned: fail
  sample: Could not ascertain the status of the snapshot deletion. Check manually
  type: str