W3cubDocs

/Ansible

cisco.meraki.meraki_mx_l2_interface – Configure MX layer 2 interfaces

Note

This plugin is part of the cisco.meraki collection (version 2.5.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.meraki.

To use it in a playbook, specify: cisco.meraki.meraki_mx_l2_interface.

New in version 2.1.0: of cisco.meraki

Synopsis

  • Allows for management and visibility of Merkai MX layer 2 ports.

Parameters

Parameter Choices/Defaults Comments
access_policy
string
    Choices:
  • open
  • 8021x-radius
  • mac-radius
  • hybris-radius
The name of the policy. Only applicable to access ports.
allowed_vlans
string
Comma-delimited list of the VLAN ID's allowed on the port, or 'all' to permit all VLAN's on the port.
auth_key
string / required
Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set.
drop_untagged_traffic
boolean
    Choices:
  • no
  • yes
Trunk port can Drop all Untagged traffic. When true, no VLAN is required.
Access ports cannot have dropUntaggedTraffic set to true.
enabled
boolean
    Choices:
  • no
  • yes
Enabled state of port.
host
string
Default:
"api.meraki.com"
Hostname for Meraki dashboard.
Can be used to access regional Meraki environments, such as China.
internal_error_retry_time
integer
Default:
60
Number of seconds to retry if server returns an internal server error.
net_id
string
ID number of a network.
net_name
string
Name of a network.

aliases: name, network
number
integer
ID number of MX port.

aliases: port, port_id
org_id
string
ID of organization associated to a network.
org_name
string
Name of organization.

aliases: organization
output_format
string
    Choices:
  • snakecase ←
  • camelcase
Instructs module whether response keys should be snake case (ex. net_id) or camel case (ex. netId).
output_level
string
    Choices:
  • debug
  • normal ←
Set amount of debug output during module execution.
port_type
string
    Choices:
  • access
  • trunk
Type of port.
rate_limit_retry_time
integer
Default:
165
Number of seconds to retry if rate limiter is triggered.
state
string
    Choices:
  • present ←
  • query
Modify or query an port.
timeout
integer
Default:
30
Time to timeout for HTTP requests.
use_https
boolean
    Choices:
  • no
  • yes ←
If no, it will use HTTP. Otherwise it will use HTTPS.
Only useful for internal Meraki developers.
use_proxy
boolean
    Choices:
  • no ←
  • yes
If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
validate_certs
boolean
    Choices:
  • no
  • yes ←
Whether to validate HTTP certificates.
vlan
integer
Native VLAN when the port is in Trunk mode.
Access VLAN when the port is in Access mode.

Notes

Note

  • More information about the Meraki API can be found at https://dashboard.meraki.com/api_docs.
  • Some of the options are likely only used for developers within Meraki.
  • As of Ansible 2.9, Meraki modules output keys as snake case. To use camel case, set the ANSIBLE_MERAKI_FORMAT environment variable to camelcase.
  • Ansible’s Meraki modules will stop supporting camel case output in Ansible 2.13. Please update your playbooks.
  • Check Mode downloads the current configuration from the dashboard, then compares changes against this download. Check Mode will report changed if there are differences in the configurations, but does not submit changes to the API for validation of change.

Examples

- name: Query layer 2 interface settings
  meraki_mx_l2_interface:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
  delegate_to: localhost

- name: Query a single layer 2 interface settings
  meraki_mx_l2_interface:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
    number: 2
  delegate_to: localhost

- name: Update interface configuration
  meraki_mx_l2_interface:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    number: 2
    port_type: access
    vlan: 10
  delegate_to: localhost

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
data
complex
success
Information about the created or manipulated object.
access_policy
string
success
The name of the policy. Only applicable to access ports.

Sample:
guestUsers
allowed_vlans
string
success
Comma-delimited list of the VLAN ID's allowed on the port, or 'all' to permit all VLAN's on the port.

Sample:
1,5,10
drop_untagged_traffic
boolean
success
Trunk port can Drop all Untagged traffic. When true, no VLAN is required.
Access ports cannot have dropUntaggedTraffic set to true.

Sample:
True
enabled
boolean
success
Enabled state of port.

Sample:
True
number
integer
success
ID number of MX port.

Sample:
4
type
string
success
Type of port.

Sample:
access
vlan
integer
success
Native VLAN when the port is in Trunk mode.
Access VLAN when the port is in Access mode.

Sample:
1


Authors

  • Kevin Breit (@kbreit)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/meraki_mx_l2_interface_module.html