nttmcp.mcp.ip_list_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 and Get IP Address Lists

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 IP address lists for a Cloud Network Domain
    ip_list_info:
      region: na
      datacenter: NA12
      network_domain: myCND

  - name: Get a specific IP address list by IP version (IPv6)
    ip_list_info:
      region: na
      datacenter: NA12
      network_domain: myCND
      version: IPV6

  - name: Get a specific IP address by name
    ip_list_info:
      region: na
      datacenter: NA12
      network_domain: myCND
      name: myIpAddressList

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

name:
    description:
    - The name of the IP Address List
    required: false
    type: str

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

version:
    choices:
    - IPV4
    - IPV6
    default: IPV4
    description:
    - The IP version for the IP Address List(s)
    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
    port_list:
      contains:
        childIpAddressList:
          contains:
            id:
              description: The ID of the IP Address List
              sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
              type: str
            name:
              description: The name of the IP Address List
              sample: My Child IP Address List
              type: str
          description: List of child IP Address Lists
          type: complex
        createTime:
          description: The creation date of the image
          sample: '2019-01-14T11:12:31.000Z'
          type: str
        description:
          description: IP Address List description
          sample: My IP Address List description
          type: str
        id:
          description: IP Address List UUID
          sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
          type: str
        ipAddress:
          contains:
            begin:
              description: The starting IP Address number for this IP Address or range
                (IPv4 or IPv6)
              sample: x.x.x.x
              type: int
            end:
              description: The end IP Address number for this range. This is not present
                for single IP Addresses (IPv4 or IPv6)
              sample: x.x.x.x
              type: int
            prefixSize:
              description: The prefix size for a given subnet
              sample: '24'
              type: str
          description: List of IP Addresses and/or IP Address Lists
          type: complex
        ipVersion:
          description: The IP version for the IP Address List
          sample: IPV6
          type: str
        name:
          description: IP Address List name
          sample: My IP Address List
          type: str
        state:
          description: Status of the VLAN
          sample: NORMAL
          type: str
      description: a list of IP Address List objects or strs
      returned: success
      type: complex
  description: dict of returned Objects
  returned: success
  type: complex