cisco.meraki.meraki_switch_access_list (1.4.0) — module

Install collection

Install with ansible-galaxy collection install cisco.meraki:==1.4.0

Add to requirements.yml

  collections:
    - name: cisco.meraki
      version: 1.4.0

Description

Configure and query information about access lists on Meraki switches within the Meraki cloud.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Set access list
  meraki_switch_access_list:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    rules:
      - comment: Fake rule
        policy: allow
        ip_version: ipv4
        protocol: udp
        src_cidr: 192.0.1.0/24
        src_port: "4242"
        dst_cidr: 1.2.3.4/32
        dst_port: "80"
        vlan: "100"
  delegate_to: localhost

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Query access lists
  meraki_switch_access_list:
    auth_key: abc123
    state: query
    org_name: YourOrg
    net_name: YourNet
  delegate_to: localhost

Inputs

    
host:
    default: api.meraki.com
    description:
    - Hostname for Meraki dashboard.
    - Can be used to access regional Meraki environments, such as China.
    type: str

rules:
    description:
    - List of access control rules.
    elements: dict
    suboptions:
      comment:
        description:
        - Description of the rule.
        type: str
      dst_cidr:
        description:
        - CIDR notation of source IP address to match.
        type: str
      dst_port:
        description:
        - Port number of destination port to match.
        - May be a port number or 'any'.
        type: str
      ip_version:
        choices:
        - any
        - ipv4
        - ipv6
        description:
        - Type of IP packets to match.
        type: str
      policy:
        choices:
        - allow
        - deny
        description:
        - Action to take on matching traffic.
        type: str
      protocol:
        choices:
        - any
        - tcp
        - udp
        description:
        - Type of protocol to match.
        type: str
      src_cidr:
        description:
        - CIDR notation of source IP address to match.
        type: str
      src_port:
        description:
        - Port number of source port to match.
        - May be a port number or 'any'.
        type: str
      vlan:
        description:
        - Incoming traffic VLAN.
        - May be any port between 1-4095 or 'any'.
        type: str
    type: list

state:
    choices:
    - absent
    - present
    - query
    default: query
    description:
    - Specifies whether object should be queried, created/modified, or removed.
    type: str

net_id:
    description:
    - ID of network which configuration is applied to.
    type: str

org_id:
    description:
    - ID of organization.
    type: str

timeout:
    default: 30
    description:
    - Time to timeout for HTTP requests.
    type: int

auth_key:
    description:
    - Authentication key provided by the dashboard. Required if environmental variable
      C(MERAKI_KEY) is not set.
    required: true
    type: str

net_name:
    aliases:
    - network
    description:
    - Name of network which configuration is applied to.
    type: str

org_name:
    aliases:
    - organization
    description:
    - Name of organization.
    type: str

use_https:
    default: true
    description:
    - If C(no), it will use HTTP. Otherwise it will use HTTPS.
    - Only useful for internal Meraki developers.
    type: bool

use_proxy:
    description:
    - If C(no), it will not use a proxy, even if one is defined in an environment variable
      on the target hosts.
    type: bool

output_level:
    choices:
    - debug
    - normal
    default: normal
    description:
    - Set amount of debug output during module execution.
    type: str

output_format:
    choices:
    - snakecase
    - camelcase
    default: snakecase
    description:
    - Instructs module whether response keys should be snake case (ex. C(net_id)) or camel
      case (ex. C(netId)).
    type: str

validate_certs:
    default: true
    description:
    - Whether to validate HTTP certificates.
    type: bool

rate_limit_retry_time:
    default: 165
    description:
    - Number of seconds to retry if rate limiter is triggered.
    type: int

internal_error_retry_time:
    default: 60
    description:
    - Number of seconds to retry if server returns an internal server error.
    type: int

Outputs

data:
  contains:
    rules:
      contains:
        comment:
          description:
          - Description of the rule.
          returned: success
          sample: User rule
          type: str
        dst_cidr:
          description:
          - CIDR notation of source IP address to match.
          returned: success
          sample: 1.2.3.4/32
          type: str
        dst_port:
          description:
          - Port number of destination port to match.
          returned: success
          sample: 80
          type: str
        ip_version:
          description:
          - Type of IP packets to match.
          returned: success
          sample: ipv4
          type: str
        policy:
          description:
          - Action to take on matching traffic.
          returned: success
          sample: allow
          type: str
        protocol:
          description:
          - Type of protocol to match.
          returned: success
          sample: udp
          type: str
        src_cidr:
          description:
          - CIDR notation of source IP address to match.
          returned: success
          sample: 192.0.1.0/24
          type: str
        src_port:
          description:
          - Port number of source port to match.
          returned: success
          sample: 1234
          type: str
        vlan:
          description:
          - Incoming traffic VLAN.
          returned: success
          sample: 100
          type: str
      description:
      - List of access control rules.
      type: list
  description: List of administrators.
  returned: success
  type: complex