W3cubDocs

/Ansible

cisco.meraki.meraki_mx_network_vlan_settings module – Manage VLAN settings for Meraki Networks

Note

This module is part of the cisco.meraki collection (version 2.21.4).

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_network_vlan_settings.

DEPRECATED

Removed in:

version 3.0.0

Why:

Updated modules released with increased functionality

Alternative:

cisco.meraki.networks_appliance_vlans_settings

Synopsis

  • Edits VLAN enabled status on a network within Meraki.

Parameters

Parameter

Comments

auth_key

string / required

Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set.

host

string

Hostname for Meraki dashboard.

Can be used to access regional Meraki environments, such as China.

Default: "api.meraki.com"

internal_error_retry_time

integer

Number of seconds to retry if server returns an internal server error.

Default: 60

net_id

string

ID number of a network.

net_name

aliases: name, network

string

Name of a network.

org_id

string

ID of organization.

org_name

aliases: organization

string

Name of organization.

output_format

string

Instructs module whether response keys should be snake case (ex. net_id) or camel case (ex. netId).

Choices:

  • "snakecase" ← (default)
  • "camelcase"

output_level

string

Set amount of debug output during module execution.

Choices:

  • "debug"
  • "normal" ← (default)

rate_limit_retry_time

integer

Number of seconds to retry if rate limiter is triggered.

Default: 165

state

string

Create or modify an alert.

Choices:

  • "present"
  • "query"

timeout

integer

Time to timeout for HTTP requests.

Default: 30

use_https

boolean

If no, it will use HTTP. Otherwise it will use HTTPS.

Only useful for internal Meraki developers.

Choices:

  • false
  • true ← (default)

use_proxy

boolean

If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

Choices:

  • false ← (default)
  • true

validate_certs

boolean

Whether to validate HTTP certificates.

Choices:

  • false
  • true ← (default)

vlans_enabled

boolean

Whether VLANs are enabled on the network.

Choices:

  • false
  • true

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: Update settings
  meraki_mx_network_vlan_settings:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    vlans_enabled: true

Return Values

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

Key

Description

data

complex

Information about the created or manipulated object.

Returned: info

vlans_enabled

boolean

Whether VLANs are enabled for this network.

Returned: success

Status

  • This module will be removed in version 3.0.0. [deprecated]
  • For more information see DEPRECATED.

Authors

  • Kevin Breit (@kbreit)

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