nttmcp.mcp.server_info (1.0.9) — module

Get and List Servers

| "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 and List Servers


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: List all servers
    server_info:
      region: na
      datacenter: NA9
      network_domain: xxxx

  - name: Get a server
    server_info:
      region: na
      datacenter: NA9
      network_domain: xxxx
      name: APITEST

Inputs

    
id:
    description:
    - The UUID of the server
    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 server
    required: false
    type: str

vlan:
    description:
    - The name of the vlan in which the server is housed
    - Not used for create
    required: false
    type: str

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

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

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

Outputs

data:
  contains:
    count:
      description: The number of objects returned in the list
      returned: success
      sample: 1
      type: int
    server:
      contains:
        cpu:
          contains:
            coresPerSocket:
              description: The number of cores per CPU socket
              sample: 1
              type: int
            count:
              description: The number of CPUs
              sample: 2
              type: int
            speed:
              description: The CPU reservation to be applied
              sample: STANDARD
              type: str
          description: The default CPU specifications for the image
          type: complex
        createTime:
          description: The creation date of the server
          sample: '2019-01-14T11:12:31.000Z'
          type: str
        datacenterId:
          description: Datacenter id/location
          sample: NA9
          type: str
        deployed:
          description: Is the server deployed
          type: bool
        floppy:
          contains:
            driveNumber:
              description: The drive number
              sample: 0
              type: int
            id:
              description: The UUID of the drive
              sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
              type: str
            key:
              description: Internal usage
              sample: 8000
              type: int
            state:
              description: The state of the drive
              sample: NORMAL
              type: str
          description: List of the attached floppy drives
          type: complex
        guest:
          contains:
            operatingSystem:
              contains:
                displayName:
                  description: The OS display name
                  sample: CENTOS7/64
                  type: str
                family:
                  description: The OS family
                  sample: UNIX
                  type: str
                id:
                  description: The OS UUID
                  sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
                  type: str
                osUnitsGroupId:
                  description: The OS billing group
                  sample: CENTOS
                  type: str
              description: Operating System information
              type: complex
            osCustomization:
              description: Does the image support guest OS customization
              type: bool
            vmTools:
              contains:
                apiVersion:
                  description: The version of VMWare Tools
                  sample: 9256
                  type: int
                runningStatus:
                  description: Is VMWare Tools running
                  sample: NOT_RUNNING
                  type: str
                type:
                  description: VMWare Tools or Open VM Tools
                  sample: VMWARE_TOOLS
                  type: str
                versionStatus:
                  description: Additional information
                  sample: NEED_UPGRADE
                  type: str
              description: VMWare Tools information
              type: complex
          description: Information about the guest OS
          type: complex
        id:
          description: The UUID of the server
          sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
          type: str
        ideController:
          contains:
            adapterType:
              description: The type of the controller
              sample: IDE
              type: str
            channel:
              description: The IDE channel number
              sample: 0
              type: int
            deviceOrDisk:
              contains:
                device:
                  contains:
                    id:
                      description: The UUID of the device/disk
                      sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
                      type: str
                    slot:
                      description: The slot number on the controller used by this
                        device
                      sample: 0
                      type: int
                    state:
                      description: The state of the device/disk
                      sample: NORMAL
                      type: str
                    type:
                      description: The type of the device/disk
                      sample: CDROM
                      type: str
                  description: Device/Disk object
                  type: complex
              description: List of the attached devices/disks
              type: complex
            id:
              description: The UUID of the controller
              sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
              type: str
            key:
              description: Internal Usage
              sample: 200
              type: int
            state:
              description: The state of the controller
              sample: NORMAL
              type: str
          description: List of the server's IDE controllers
          type: complex
        memoryGb:
          description: Server memory in GB
          sample: 4
          type: int
        name:
          description: The name of the server
          sample: my_server
          type: str
        networkInfo:
          contains:
            networkDomainId:
              description: The UUID of the Cloud Network Domain the server resides
                in
              sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
              type: str
            primaryNic:
              contains:
                connected:
                  description: Is the NIC connected
                  type: bool
                id:
                  description: The UUID of the NIC
                  sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
                  type: str
                ipv6:
                  description: The IPv6 address of the server
                  sample: 1111:1111:1111:1111:0:0:0:1
                  type: str
                key:
                  description: Internal Usage
                  sample: 4000
                  type: int
                macAddress:
                  description: the MAC address
                  sample: aa:aa:aa:aa:aa:aa
                  type: str
                networkAdapter:
                  description: The VMWare NIC type
                  sample: VMXNET3
                  type: str
                privateIpv4:
                  description: The IPv4 address of the server
                  sample: 10.0.0.10
                  type: str
                state:
                  description: The state of the NIC
                  sample: NORMAL
                  type: str
                vlanId:
                  description: the UUID of the VLAN the server resides in
                  sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
                  type: str
                vlanName:
                  description: The name of the VLAN the server resides in
                  sample: my_vlan
                  type: str
              description: The primary NIC on the server
              type: complex
          description: Server network information
          type: complex
        sataController:
          contains:
            adapterType:
              description: The name of the adapter
              sample: LSI_LOGIC_SAS
              type: str
            busNumber:
              description: The SCSI bus number
              sample: 1
              type: int
            disk:
              contains:
                id:
                  description: The disk id
                  sample: 112b7faa-ffff-ffff-ffff-dc273085cbe4
                  type: str
                scsiId:
                  description: The id of the disk on the SCSI controller
                  sample: 0
                  type: int
                sizeGb:
                  description: The initial size of the disk in GB
                  sample: 10
                  type: int
                speed:
                  description: The disk speed
                  sample: STANDARD
                  type: str
              description: List of disks associated with this image
              type: complex
            id:
              description: The SCSI controller id
              sample: 112b7faa-ffff-ffff-ffff-dc273085cbe4
              type: str
            key:
              description: Internal use
              sample: 1000
              type: int
          description: List of SATA controllers on the server
          type: list
        scsiController:
          contains:
            adapterType:
              description: The name of the adapter
              sample: LSI_LOGIC_SAS
              type: str
            busNumber:
              description: The SCSI bus number
              sample: 1
              type: int
            disk:
              contains:
                id:
                  description: The disk id
                  sample: 112b7faa-ffff-ffff-ffff-dc273085cbe4
                  type: str
                scsiId:
                  description: The id of the disk on the SCSI controller
                  sample: 0
                  type: int
                sizeGb:
                  description: The initial size of the disk in GB
                  sample: 10
                  type: int
                speed:
                  description: The disk speed
                  sample: STANDARD
                  type: str
              description: List of disks associated with this image
              type: complex
            id:
              description: The SCSI controller id
              sample: 112b7faa-ffff-ffff-ffff-dc273085cbe4
              type: str
            key:
              description: Internal use
              sample: 1000
              type: int
          description: List of the SCSI controllers and disk configuration for the
            image
          type: complex
        source:
          contains:
            type:
              description: The id type of the image
              sample: IMAGE_ID
              type: str
            value:
              description: The UUID of the image
              sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
              type: str
          description: The source of the image
          type: complex
        started:
          description: Is the server running
          type: bool
        state:
          description: The state of the server
          sample: NORMAL
          type: str
        tag:
          contains:
            tagKeyId:
              description: the UUID of the tag
              sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
              type: str
            tagKeyName:
              description: The tag name
              sample: my_tag
              type: str
            value:
              description: The tag value
              sample: my_tag_value
              type: str
          description: List of informational tags associated with the server
          type: complex
        virtualHardware:
          contains:
            upToDate:
              description: Is the VM hardware up to date
              type: bool
            version:
              description: The VM hardware version
              sample: VMX-10
              type: str
          description: Information on the virtual hardware of the server
          type: complex
      description: List of server objects
      returned: success
      type: complex
  description: dict of returned Objects
  returned: success
  type: complex