nttmcp.mcp.firewall_info (1.0.9) — module

List/Get Firewall rules

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


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 firewall rules within a Cloud Network Domain
    firewall_info:
      region: na
      datacenter: NA12
      network_domain: myCND

  - name: Get a specific firewall rule with statistics
    firewall_info:
      region: na
      datacenter: NA12
      network_domain: myCND
      name: CCDEFAULT.BlockOutboundMailIPv6

  - name: Get a specific firewall rule statistics
    firewall_info:
      region: na
      datacenter: NA12
      network_domain: myCND
      name: CCDEFAULT.BlockOutboundMailIPv6
      stats: True

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

stats:
    default: false
    description:
    - Return the firewall rule(s) statistics (works with or without a supplied rule name)
    required: false
    type: bool

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:
    acl:
      contains:
        action:
          description: The rule action
          sample: ACCEPT_DECISIVELY
          type: str
        datacenterId:
          description: Datacenter id/location
          sample: NA9
          type: str
        destination:
          contains:
            ip:
              contains:
                address:
                  description: The destination IP address
                  sample: 10.0.0.1
                  type: str
              description: The destination IP address object
              type: complex
            ipAddressList:
              contains:
                id:
                  description: the UUID of the IP address list
                  sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
                  type: str
                name:
                  description: The name of the IP address list
                  sample: my_ip_list
                  type: str
              description: The IP address list object
              type: complex
            port:
              contains:
                begin:
                  description: The starting port number
                  sample: 443
                  type: int
                end:
                  description: The ending port number
                  sample: 444
                  type: int
              description: The destination port object
              type: complex
            portList:
              contains:
                id:
                  description: The UUID of the port list
                  sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
                  type: str
                name:
                  description: The name of the port list
                  sample: my port list
                  type: str
              description: The destination port list
              type: complex
          description: The destination object for the rule, can be a single IP address
            or IP address list
          type: complex
        enabled:
          description: The status of the firewall rule
          type: bool
        id:
          description: The UUID of the firewall rule
          sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
          type: str
        ipVersion:
          description: IP Version
          sample: IPV6
          type: str
        name:
          description: The name of the firewall rule
          sample: my_firewall_rule
          type: str
        networkDomainId:
          description: The UUID of the Cloud Network Domain
          sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
          type: str
        protocol:
          description: The protocol for the firewall rule
          sample: TCP
          type: str
        ruleType:
          description: Internal Use - is the rule internally or client created
          sample: CLIENT_RULE
          type: str
        source:
          contains:
            ip:
              contains:
                address:
                  description: The source IP address
                  sample: 10.0.0.1
                  type: str
              description: The source IP address object
              type: complex
            ipAddressList:
              contains:
                id:
                  description: the UUID of the IP address list
                  sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae
                  type: str
                name:
                  description: The name of the IP address list
                  sample: my_ip_list
                  type: str
              description: The IP address list object
              type: complex
            port:
              contains:
                begin:
                  description: The starting port number
                  sample: 443
                  type: int
                end:
                  description: The ending port number
                  sample: 444
                  type: int
              description: The source port object
              type: complex
          description: The source object for the rule, can be a single IP address
            or IP address list
          type: complex
        state:
          description: Status of the VLAN
          sample: NORMAL
          type: str
        statistics:
          contains:
            hitCounter:
              description: The number of times the rule has been hit
              sample: 100
              type: int
            lastHitTimestamp:
              description: The timestamp of the last time a rule was hit in ZULU time
              sample: '2019-11-21T17:07:04.000Z'
              type: str
          description: The firewall rule hit counter statistics
          type: complex
      description: Dictonary of the firewall rule(s)
      returned: success
      type: complex
    count:
      description: The number of objects returned
      returned: success
      sample: 1
      type: int
  description: dict of returned Objects
  returned: success
  type: complex