cisco.meraki.meraki_management_interface module – Configure Meraki management interfaces
Note
This module is part of the cisco.meraki collection (version 2.13.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_management_interface
.
New in cisco.meraki 1.1.0
Synopsis
Allows for configuration of management interfaces on Meraki MX, MS, and MR devices.
Parameters
Parameter |
Comments |
---|---|
Authentication key provided by the dashboard. Required if environmental variable |
|
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 of the network to bind or unbind configuration template to. |
|
Name of the network to bind or unbind configuration template to. |
|
ID of organization associated to a configuration template. |
|
Name of organization containing the configuration template. |
|
Instructs module whether response keys should be snake case (ex. Choices:
|
|
Set amount of debug output during module execution. Choices:
|
|
Number of seconds to retry if rate limiter is triggered. Default: |
|
serial number of the device to configure. |
|
Specifies whether configuration template information should be queried, modified, or deleted. Choices:
|
|
Time to timeout for HTTP requests. Default: |
|
If Only useful for internal Meraki developers. Choices:
|
|
If Choices:
|
|
Whether to validate HTTP certificates. Choices:
|
|
Management interface details for management interface. |
|
DNS servers to use. Allows for a maximum of 2 addresses. |
|
IP address for default gateway. Valid only if |
|
IP address assigned to Management interface. Valid only if |
|
Netmask for static IP address. Valid only if |
|
Configures the interface to use static IP or DHCP. Choices:
|
|
VLAN number to use for the management network. |
|
States whether the management interface is enabled. Only valid for MX devices. Choices:
|
|
Management interface details for management interface. |
|
DNS servers to use. Allows for a maximum of 2 addresses. |
|
IP address for default gateway. Valid only if |
|
IP address assigned to Management interface. Valid only if |
|
Netmask for static IP address. Valid only if |
|
Configures the interface to use static IP or DHCP. Choices:
|
|
VLAN number to use for the management network. |
|
States whether the management interface is enabled. Only valid for MX devices. Choices:
|
Notes
Note
WAN2
parameter is only valid for MX appliances.wan_enabled
should not be provided for non-MX devies.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: Set WAN2 as static IP
meraki_management_interface:
auth_key: abc123
state: present
org_name: YourOrg
net_id: YourNetId
serial: AAAA-BBBB-CCCC
wan2:
wan_enabled: enabled
using_static_ip: yes
static_ip: 192.168.16.195
static_gateway_ip: 192.168.16.1
static_subnet_mask: 255.255.255.0
static_dns:
- 1.1.1.1
vlan: 1
delegate_to: localhost
- name: Query management information
meraki_management_interface:
auth_key: abc123
state: query
org_name: YourOrg
net_id: YourNetId
serial: AAAA-BBBB-CCCC
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Information about queried object. Returned: success |
|
Management configuration for WAN1 interface Returned: success |
|
List of DNS IP addresses Returned: only if static IP assignment is used Sample: |
|
Assigned static gateway IP Returned: only if static IP assignment is used Sample: |
|
Assigned static IP Returned: only if static IP assignment is used Sample: |
|
Assigned netmask for static IP Returned: only if static IP assignment is used Sample: |
|
Boolean value of whether static IP assignment is used on interface Returned: success Sample: |
|
VLAN tag id of management VLAN Returned: success Sample: |
|
Enabled state of interface Returned: success Sample: |
|
Management configuration for WAN1 interface Returned: success |
|
List of DNS IP addresses Returned: only if static IP assignment is used Sample: |
|
Assigned static gateway IP Returned: only if static IP assignment is used Sample: |
|
Assigned static IP Returned: only if static IP assignment is used Sample: |
|
Assigned netmask for static IP Returned: only if static IP assignment is used Sample: |
|
Boolean value of whether static IP assignment is used on interface Returned: success Sample: |
|
VLAN tag id of management VLAN Returned: success Sample: |
|
Enabled state of interface Returned: success Sample: |