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

Create, update and delete Firewall Port 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: Create a port list
    port_list:
      region: na
      datacenter: NA12
      network_domain: myCND
      name: myPortList
      description: "API Testing"
      ports:
        - port_begin: 80
        - port_begin: 443
          port_end: 444
      state: present

  - name: Create a port list with a child port list
    port_list:
      region: na
      datacenter: NA12
      network_domain: myCND
      name: myPortList2
      description: "API Testing2"
      ports:
        - port_begin: 1077
        - port_begin: 1177
          port_end: 1277
      child_port_lists:
        - myPortList
      state: present

  - name: Update a port list
    port_list:
      region: na
      datacenter: NA12
      network_domain: myCND
      name: myPortList2
      description: "API Testing2_new"
      ports:
        - port_begin: 1200
        - port_begin: 1177
          port_end: 1500
      child_port_lists_nil: True
      state: present

  - name: Delete a  port list
    port_list:
      region: na
      datacenter: NA12
      network_domain: myCND
      name: myPortList2
      state: absent

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 Port List
    required: true
    type: str

ports:
    description:
    - List of port groups with port_begin and optionally port_end
    elements: dict
    required: false
    type: list

state:
    choices:
    - present
    - absent
    default: present
    description:
    - The action to be performed
    required: false
    type: str

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

ports_nil:
    default: false
    description:
    - Used on updating to remove all ports
    required: false
    type: bool

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

description:
    description:
    - The description of the Port List
    required: false
    type: str

network_domain:
    description:
    - The name of a Cloud Network Domain
    required: true
    type: str

child_port_lists:
    description:
    - List of port list names that will be included in this port list
    elements: str
    required: false
    type: list

child_port_lists_nil:
    default: false
    description:
    - Used on updating to remove all child port lists
    required: false
    type: bool

Outputs

data:
  contains:
    childPortList:
      contains:
        id:
          description: The ID of the Port List
          sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
          type: str
        name:
          description: The name of the Port List
          sample: My Child Port List
          type: str
      description: List of child Port Lists
      returned: when state == present
      type: complex
    createTime:
      description: The creation date of the image
      returned: when state == present
      sample: '2019-01-14T11:12:31.000Z'
      type: str
    description:
      description: Port List description
      returned: when state == present
      sample: My Port List description
      type: str
    id:
      description: Port List UUID
      returned: when state == present
      sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
      type: str
    name:
      description: Port List name
      returned: when state == present
      sample: My Port List
      type: str
    port:
      contains:
        begin:
          description: The starting port number for this port or range
          sample: 22
          type: int
        end:
          description: The end port number for this range. This is not present for
            single ports
          sample: 23
          type: int
      description: List of ports and/or port ranges
      returned: when state == present
      type: complex
    state:
      description: Status of the VLAN
      returned: when state == present
      sample: NORMAL
      type: str
  description: Array of Port List objects
  returned: success
  type: complex