nttmcp.mcp.static_route_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 Static Routes

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 static routes
    static_route_info:
      region: na
      datacenter: NA9
      network_domain: my_network_domain

  - name: List static routes with a specific next hop IP address
    static_route_info:
      region: na
      datacenter: NA9
      network_domain: my_network_domain
      next_hop: "172.16.0.10"

  - name: Get a specific static route
    static_route_info:
      region: na
      datacenter: NA9
      network_domain: my_network_domain
      cidr: "10.0.0.0/24"
      next_hop: "172.16.0.10"

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

cidr:
    description:
    - The IPv4 or IPv6 destination network address to modify in CIDR format for e.g. 192.168.0.0/24
    required: false
    type: str

name:
    description:
    - The name of the Static Route
    - If a name and a network is provided but there is a conflict, name takes precendence
    required: false
    type: str

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

version:
    choices:
    - 4
    - 6
    default: 4
    description:
    - The IP version. Used when searching (e.g. List all IPv6 routes)
    required: false
    type: int

next_hop:
    description:
    - The next host destination for the route e.g. 10.0.0.10
    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
    route:
      contains:
        createTime:
          description: The creation date of the image
          sample: '2019-01-14T11:12:31.000Z'
          type: str
        datacenterId:
          description: Datacenter id/location
          sample: NA3
          type: str
        description:
          description: Optional description for the static route
          sample: something
          type: str
        destinationNetworkAddress:
          description: The destination network address for the static route
          sample: 192.168.0.0
          type: str
        destinationPrefixSize:
          description: The destination prefix for the static route
          sample: 24
          type: int
        id:
          description: Static Route ID
          sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
          type: str
        ipVersion:
          description: The IP version of the static route
          sample: IPV4
          type: str
        name:
          description: The name of the Static Route
          sample: my_static_route
          type: str
        networkDomainId:
          description: Network Domain ID
          sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
          type: str
        nextHopAddress:
          description: The next hop destination for the route
          sample: 10.0.0.10
          type: str
        nextHopAddressVlanId:
          description: The UUID of the VLAN for the next hop address
          sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
          type: str
        state:
          description: Status of the static route
          sample: NORMAL
          type: str
        type:
          description: The type of static route e.g. SYSTEM or CLIENT
          sample: CLIENT
          type: str
      description: a single or list of Static Route objects or strings
      returned: success
      type: complex
  description: dict of returned Objects
  returned: success
  type: complex