nttmcp.mcp.snapshot_service (1.0.9) — module

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

Enable/Disable and Update the Snapshot Service on a server

When disabling snapshot replication on a server it can take 2-4 hours for this process to finish even if though

the tasks returns immediately. Disabling the snapshot service on a server requires that snapshot replication is

already disabled.

Requirements

• requests
• configparser
• pyOpenSSL
• netaddr

Usage examples

Scanned by Steampunk Spotter

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

- hosts: 127.0.0.1
  connection: local
  collections:
    - nttmcp.mcp
  tasks:

  - name: Enable Snapshots at 8am
    snapshot_service:
      region: na
      datacenter: NA9
      network_domain_id: my_network_domain_uuid
      name: My_Server
      plan: ONE_MONTH
      window: 8

  - name: Enable Snapshots at 8am
    snapshot_service:
      region: na
      datacenter: NA9
      network_domain: my_network_domain
      name: My_Server
      plan: ONE_MONTH
      window: 8
      state: present

  - name: Enable Snapshots at 8am and enable replication
    snapshot_service:
      region: na
      datacenter: NA9
      network_domain: my_network_domain
      name: My_Server
      plan: ONE_MONTH
      window: 8
      replication: NA12

  - name: Update Snapshot config on a server
    snapshot_service:
      region: na
      datacenter: NA9
      network_domain: my_network_domain
      name: My_Server
      plan: TWELVE_MONTH
      window: 10

  - name: Add replication to the service
    snapshot_service:
      region: na
      datacenter: NA9
      network_domain: my_network_domain
      name: My_Server
      replication: NA12

  - name: Disable replication only
    snapshot_service:
      region: na
      datacenter: NA9
      network_domain: my_network_domain
      name: My_Server
      replication: NA12
      state: absent

  - name: Disable Snapshots Completely
    snapshot_service:
      region: na
      datacenter: NA9
      network_domain: my_network_domain
      name: My_Server
      state: absent

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

plan:
    description:
    - The name of a desired Service Plan. Use snapshot_info to get a list of valid plans.
    required: false
    type: str

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

window:
    description:
    - The starting hour for the snapshot window (24 hour notation). Use snapshot_info
      to find a window.
    required: false
    type: int

server_id:
    description:
    - The UUID of a server to enable Snapshots on. Takes precendence over a server name
    required: false
    type: str

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

replication:
    description:
    - Enable replication of snapshots for this server to the target datacenter/MCP
    - Value should be the target datacenter ID within the same GEO e.g. NA12
    - This is an optional parameter that should only be specified if replication is required
    required: false
    type: str

take_snapshot:
    default: false
    description:
    - Whether to initiate a manual snapshot
    required: false
    type: bool

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

network_domain_id:
    description:
    - The ID of a Cloud Network Domain.
    required: false
    type: str

Outputs

msg:
  description: Status of the operation
  returned: always
  type: str