nttmcp.mcp.mcp_info (1.0.9) — module

Get NTT LTD MCP datacenter 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 MCP datacenter 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 MCPs
    mcp_info:
      region: na

  - name: Get details on a specific MCP
    mcp_info:
      region: na
      name: NA9

Inputs

    
id:
    description:
    - The id of an MCP (e.g. NA9)
    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

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

Outputs

data:
  contains:
    count:
      description: The number of objects returned
      returned: success
      sample: 1
      type: int
    mcp:
      contains:
        backup:
          contains:
            maintenanceStatus:
              description: The maintenance status of backups within the MCP
              sample: NORMAL
              type: str
            type:
              description: The type of backups available in the MCP
              sample: xxxxxx
              type: str
          description: Object containing backup information within the MCP
          type: complex
        city:
          description: The city the MCP is located in
          sample: xxxx
          type: str
        consoleAccess:
          contains:
            maintenanceStatus:
              description: The maintenance status of the console service with in the
                MCP
              sample: NORMAL
              type: str
          description: Object containing information on the virtual console status
            within an MCP
          type: complex
        country:
          description: The country the MCP resides in
          sample: US
          type: str
        displayName:
          description: The UI display name for the MCP
          sample: US - East 3 - MCP 2.0
          type: str
        ftpsHost:
          description: The FTPS host for copying images to/from the MCP
          sample: xxxx.xxxxx.xxx
          type: str
        hypervisor:
          contains:
            cpuSpeed:
              contains:
                available:
                  description: Is the CPU speed available for the hypervisor in this
                    MCP
                  type: bool
                default:
                  description: Is this the default CPU speed
                  type: bool
                description:
                  description: The description of the CPU speed
                  sample: Standard CPU Speed
                  type: str
                displayName:
                  description: The UI display name for the CPU speed
                  sample: Standard
                  type: str
                id:
                  description: The ID of the CPU speed object
                  sample: STANDARD
                  type: str
              description: List of hypervisor CPU speeds
              type: list
            diskSpeed:
              contains:
                abbreviation:
                  description: Shortcode for the disk speed
                  sample: STD
                  type: str
                available:
                  description: Is the disk speed currently available
                  type: bool
                default:
                  description: Is this the default disk speed option
                  type: bool
                description:
                  description: The description for the disk speed
                  sample: Standard Disk Speed
                  type: str
                displayName:
                  description: The UI display name for the disk speed
                  sample: Standard
                  type: str
                id:
                  description: The ID for the disk speed object
                  sample: STANDARD
                  type: str
                variableIopLimits:
                  contains:
                    maxDiskIops:
                      description: The maximum supported IOPS for the disk
                      sample: 1
                      type: int
                    maxIopsPerGb:
                      description: The maximum supported IOPS per GB of disk space
                      sample: 1
                      type: int
                    minDiskIops:
                      description: The minimum supported IOPS for the disk
                      sample: 1
                      type: int
                    minIopsPerGb:
                      description: The minimum supported IOPS per GB of disk space
                      sample: 1
                      type: int
                  description: Object containing the information on variable IOPS
                    limits for the disk speed
                  type: complex
                variableIops:
                  description: Does this disk speed support variable IOPs
                  type: bool
              description: List of disk speed options within the MCP
              type: list
            maintenanceStatus:
              description: The maintenance status of the MCP
              sample: NORMAL
              type: str
            property:
              contains:
                name:
                  description: The name of the hypervisor property
                  sample: MIN_DISK_COUNT
                  type: str
                value:
                  description: The value of the hypervisor property
                  sample: 0
                  type: str
              description: List of hypervisor properties and values
              type: list
            type:
              description: The hyervisor type
              sample: xxxx
              type: str
          description: Objecting containing the hypervisor capabilities for the MCP
          type: complex
        id:
          description: The ID of the MCP
          sample: NA9
          type: str
        monitoring:
          contains:
            maintenanceStatus:
              description: The maintenance status of monitoring within the MCP
              sample: NORMAL
              type: str
          description: Object containing monitoring information within the MCP
          type: complex
        networking:
          contains:
            maintenanceStatus:
              description: The maintenance status of the network within the MCP
              sample: NORMAL
              type: str
            property:
              contains:
                name:
                  description: The name of the networking property
                  sample: MAX_POOL_MEMBERS_PER_POOL
                  type: str
                value:
                  description: The value for the networking property
                  sample: '100'
                  type: str
              description: List of network properties and values for the MCP
              type: list
            type:
              description: Internal Use
              sample: '2'
              type: str
          description: The networking capabilities of the MCP
          type: complex
        snapshot:
          contains:
            maintenanceStatus:
              description: The maintenance status for snapshots within the MCP
              sample: NORMAL
              type: str
            property:
              contains:
                name:
                  description: The name of the snapshot property
                  sample: MAX_MANUAL_SNAPSHOTS_PER_SERVER
                  type: str
                value:
                  description: The value of the snapshot property
                  sample: '10'
                  type: str
              description: List of the snapshot capabilities in the MCP
              type: list
          description: Object containing the snapshot capabilities for the MCP
          type: complex
        state:
          description: The state the MCP resides in
          sample: Virginia
          type: str
        type:
          description: The type/version of the MCP
          sample: MCP 2.0
          type: str
        vpnUrl:
          description: The VPN URL for client MCP VPN access
          sample: xxxx.xxx.xxx
          type: str
      description: List of MCP Objects
      returned: success
      type: complex
  description: dict of returned Objects
  returned: success
  type: complex