nttmcp.mcp.network_info (1.0.9) — module

List, Get Cloud Network Domains (CND)

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

List, Get Cloud Network Domains (CND)


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 Network Domains in a datacenter
    network_info:
      region: na
      datacenter: NA12

  - name: Get a specific Cloud Network Domain
    network_info:
      region: na
      datacenter: NA12
      name: myCND

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 Cloud Network Domain
    required: false
    type: str

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

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

Outputs

data:
  contains:
    count:
      description: The number of objects returned
      returned: success
      type: int
    network:
      contains:
        createTime:
          description: The creation date of the image
          sample: '2019-01-14T11:12:31.000Z'
          type: str
        datacenterId:
          description: Datacenter id/location
          sample: NA9
          type: str
        description:
          description: Network Domain description
          sample: My network description
          type: str
        id:
          description: Network Domain ID
          sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
          type: str
        ipv4CpncGatewayAddress:
          description: The CPNC gateway address (mostly for internal use)
          sample: 10.10.10.10
          type: str
        ipv4InternetGatewayAddress:
          description: The upstream gateway address
          sample: 10.10.10.10
          type: str
        ipv6CpncGatewayAddress:
          description: The CPNC gateway address (mostly for internal use)
          sample: 1111:1111:1111:1111:0:0:0:1
          type: str
        ipv6InternetGatewayAddress:
          description: The upstream gateway address
          sample: 1111:1111:1111:1111:0:0:0:1
          type: str
        name:
          description: Network Domain name
          sample: My network
          type: str
        outsideTransitVlanIpv4Subnet:
          contains:
            address:
              description: The upstream IPv4 transit network gateway
              sample: 10.10.10.0
              type: str
            prefixSize:
              description: The upstream IPv4 transit network prefix
              sample: 24
              type: int
          description: The upstream IPv4 transit network
          type: complex
        outsideTransitVlanIpv6Subnet:
          contains:
            address:
              description: The upstream IPv6 transit network gateway
              sample: 1111:1111:1111:1111:0:0:0:0
              type: str
            prefixSize:
              description: The upstream IPv6 transit network prefix
              sample: 64
              type: int
          description: The upstream IPv6 transit network
          type: complex
        snatIpv4Address:
          description: The outgoing public IPv4 source address
          sample: 1.1.1.1
          type: str
        state:
          description: Status of the Network Domain
          sample: NORMAL
          type: str
        type:
          description: The VLAN type
          sample: ADVANCED
          type: str
      description: Dictionary of the network domain
      returned: success
      type: complex
  description: dict of returned Objects
  returned: success
  type: complex