cisco.meraki.meraki_mx_l2_interface module – Configure MX layer 2 interfaces
Note
This module is part of the cisco.meraki collection (version 2.18.2).
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 cisco.meraki 2.1.0
DEPRECATED
- Removed in:
version 3.0.0
- Why:
Updated modules released with increased functionality
- Alternative:
cisco.meraki.networks_appliance_ports
Synopsis
Allows for management and visibility of Merkai MX layer 2 ports.
Parameters
Parameter |
Comments |
---|---|
The name of the policy. Only applicable to access ports. Choices:
|
|
Comma-delimited list of the VLAN ID’s allowed on the port, or ‘all’ to permit all VLAN’s on the port. |
|
Authentication key provided by the dashboard. Required if environmental variable |
|
Trunk port can Drop all Untagged traffic. When true, no VLAN is required. Access ports cannot have dropUntaggedTraffic set to true. Choices:
|
|
Enabled state of port. Choices:
|
|
Hostname for Meraki dashboard. Can be used to access regional Meraki environments, such as China. Default: |
|
Number of seconds to retry if server returns an internal server error. Default: |
|
ID number of a network. |
|
Name of a network. |
|
ID number of MX port. |
|
ID of organization associated to a network. |
|
Name of organization. |
|
Instructs module whether response keys should be snake case (ex. Choices:
|
|
Set amount of debug output during module execution. Choices:
|
|
Type of port. Choices:
|
|
Number of seconds to retry if rate limiter is triggered. Default: |
|
Modify or query an port. Choices:
|
|
Time to timeout for HTTP requests. Default: |
|
If Only useful for internal Meraki developers. Choices:
|
|
If Choices:
|
|
Whether to validate HTTP certificates. Choices:
|
|
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 tocamelcase
.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 |
Description |
---|---|
Information about the created or manipulated object. Returned: success |
|
The name of the policy. Only applicable to access ports. Returned: success Sample: |
|
Comma-delimited list of the VLAN ID’s allowed on the port, or ‘all’ to permit all VLAN’s on the port. Returned: success Sample: |
|
Trunk port can Drop all Untagged traffic. When true, no VLAN is required. Access ports cannot have dropUntaggedTraffic set to true. Returned: success Sample: |
|
Enabled state of port. Returned: success Sample: |
|
ID number of MX port. Returned: success Sample: |
|
Type of port. Returned: success Sample: |
|
Native VLAN when the port is in Trunk mode. Access VLAN when the port is in Access mode. Returned: success Sample: |
Status
This module will be removed in version 3.0.0. [deprecated]
For more information see DEPRECATED.