nttmcp.mcp.vip_pool_info (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

List/Get VIP Pools

It is quicker to use the option "id" to locate the VIP Pool if the UUID is known rather than search by name

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: List All VIP Pools
    vip_pool_info:
      region: na
      datacenter: NA9
      network_domain: "my_network_domain"

  - name: Get a specific VIP Pool by name
    vip_pool_info:
      region: na
      datacenter: NA9
      network_domain: "my_network_domain"
      name: "my_pool"

  - name: Get a specific VIP Pool by ID
    vip_pool_info:
      region: na
      datacenter: NA9
      network_domain: "my_network_domain"
      id: "b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae"

Inputs

    
id:
    description:
    - The UUID of the VIP Pool
    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 VIP Pool
    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 a Cloud Network Domain
    required: true
    type: str

Outputs

data:
  contains:
    count:
      description: The number of objects returned
      returned: success
      sample: 1
      type: int
    pool:
      contains:
        createTime:
          description: The creation date of the VIP Pool
          sample: '2019-01-14T11:12:31.000Z'
          type: str
        datacenterId:
          description: The MCP ID
          sample: NA9
          type: str
        description:
          description: Node description
          sample: My Node
          type: str
        healthMonitor:
          contains:
            id:
              description: The UUID of the Health Monitor
              sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
              type: str
            name:
              description: The Health Monitor display name
              sample: CCDEFAULT.Tcp
              type: str
          description: The procedure that the load balancer uses to verify that the
            VIP Pool is considered healthy and available for load balancing
          type: complex
        id:
          description: The UUID of the VIP Pool
          sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
          type: str
        loadBalanceMethod:
          description: Defines how the Pool will handle load balancing
          sample: Round Robin
          type: str
        members:
          contains:
            createTime:
              description: The creation date of the VIP Pool
              sample: '2019-01-14T11:12:31.000Z'
              type: str
            id:
              description: The UUID of the VIP Pool Member
              sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
              type: str
            node:
              contains:
                id:
                  description: The UUID of the node
                  sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
                  type: str
                ipAddress:
                  description: The IPv4/IPv6 address of the Node
                  sample: 10.0.0.10
                  type: str
                name:
                  description: The name of the Node
                  sample: my_node
                  type: str
                status:
                  description: The operational status of the node
                  sample: ENABLED
                  type: str
              description: The member node
              type: complex
            port:
              description: The TCP or UDP port for this VIP Pool Member
              sample: 80
              type: int
            state:
              description: The state of the VIP Pool Member
              sample: NORMAL
              type: str
            status:
              description: The operational status of the VIP Pool Member
              sample: DISABLED
              type: str
          description: List of VIP Pool Members
          type: complex
        name:
          description: The VIP Pool display name
          sample: my_pool
          type: str
        networkDomainId:
          description: The UUID of the Cloud Network Domain
          sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
          type: str
        serviceDownAction:
          description: When a Pool Member fails to respond to a Health Monitor, the
            system marks that Pool Member down and removes any persistence entries
            associated with the Pool Member
          sample: RESELECT
          type: str
        slowRampTime:
          description: This allows a Server to slowly ramp up connection
          sample: 10
          type: int
        state:
          description: Operational state of the VIP Pool configuration
          sample: NORMAL
          type: str
      description: VIP Pool Object
      returned: success
      type: complex
  description: Array of Port List objects
  returned: success
  type: complex