nttmcp.mcp.geo_info (1.0.9) — module

Get NTT LTD Cloud Geo Information

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

Get NTT LTD Cloud Information


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: Get a list of datacenters
    geo_info:
      region: eu

  - name: Get a specific datacenter
    geo_info:
      region: eu
      name: Israel

Inputs

    
id:
    description:
    - The id of the infrastructure entity
    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

name:
    description:
    - The name of the infrastructure entity
    required: false
    type: str

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

is_home:
    default: false
    description:
    - Boolean flag to allow a user to just retrieve the home geo for their account if
      unknown
    required: false
    type: bool

Outputs

data:
  contains:
    count:
      description: The number of GEO objects returned
      returned: success
      type: int
    geo:
      contains:
        cloudApiHost:
          description: The API endpoint URL for this geo
          type: str
        cloudUiUrl:
          description: The Web UI URL for this geo
          type: str
        ftpsHost:
          description: The FTPS server for this geo
          type: str
        id:
          description: Object ID
          sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
          type: str
        isHome:
          description: Is this the home geo for the user
          type: bool
        monitoringUrl:
          description: The monitoring service URL for this geo
          type: str
        name:
          description: The geo common name
          type: str
        state:
          description: The state of the geo
          sample: ENABLED
          type: str
        timezone:
          description: The timezone for this geo
          sample: America/New_York
          type: str
      description: List of GEO objects
      returned: success
      type: complex
  description: dict of returned Objects
  returned: success
  type: complex