.. Document meta
:orphan:
.. |antsibull-internal-nbsp| unicode:: 0xA0
:trim:
.. role:: ansible-attribute-support-label
.. role:: ansible-attribute-support-property
.. role:: ansible-attribute-support-full
.. role:: ansible-attribute-support-partial
.. role:: ansible-attribute-support-none
.. role:: ansible-attribute-support-na
.. role:: ansible-option-type
.. role:: ansible-option-elements
.. role:: ansible-option-required
.. role:: ansible-option-versionadded
.. role:: ansible-option-aliases
.. role:: ansible-option-choices
.. role:: ansible-option-choices-default-mark
.. role:: ansible-option-default-bold
.. role:: ansible-option-configuration
.. role:: ansible-option-returned-bold
.. role:: ansible-option-sample-bold
.. Anchors
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module:
.. Anchors: short name for ansible.builtin
.. Anchors: aliases
.. Title
cisco.meraki.meraki_mx_vlan module -- Manage VLANs in the Meraki cloud
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. Collection note
.. note::
This module is part of the `cisco.meraki collection <https://galaxy.ansible.com/cisco/meraki>`_ (version 2.21.0).
To install it, use: :code:`ansible-galaxy collection install cisco.meraki`.
To use it in a playbook, specify: :code:`cisco.meraki.meraki_mx_vlan`.
.. version_added
.. contents::
:local:
:depth: 1
.. Deprecated
DEPRECATED
----------
:Removed in: version 3.0.0
:Why: Updated modules released with increased functionality
:Alternative: cisco.meraki.networks\_appliance\_vlans
Synopsis
--------
.. Description
- Create, edit, query, or delete VLANs in a Meraki environment.
.. Aliases
.. Requirements
.. Options
Parameters
----------
.. rst-class:: ansible-option-table
.. list-table::
:width: 100%
:widths: auto
:header-rows: 1
* - Parameter
- Comments
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-appliance_ip"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-appliance_ip:
.. rst-class:: ansible-option-title
**appliance_ip**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-appliance_ip" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
IP address of appliance.
Address must be within subnet specified in \ :literal:`subnet`\ parameter.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-auth_key"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-auth_key:
.. rst-class:: ansible-option-title
**auth_key**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-auth_key" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
Authentication key provided by the dashboard. Required if environmental variable \ :literal:`MERAKI\_KEY`\ is not set.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dhcp_boot_filename"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-dhcp_boot_filename:
.. rst-class:: ansible-option-title
**dhcp_boot_filename**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dhcp_boot_filename" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
Filename to boot from for DHCP boot
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dhcp_boot_next_server"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-dhcp_boot_next_server:
.. rst-class:: ansible-option-title
**dhcp_boot_next_server**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dhcp_boot_next_server" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
DHCP boot option to direct boot clients to the server to load boot file from.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dhcp_boot_options_enabled"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-dhcp_boot_options_enabled:
.. rst-class:: ansible-option-title
**dhcp_boot_options_enabled**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dhcp_boot_options_enabled" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`boolean`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
Enable DHCP boot options
.. rst-class:: ansible-option-line
:ansible-option-choices:`Choices:`
- :ansible-option-choices-entry:`false`
- :ansible-option-choices-entry:`true`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dhcp_handling"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-dhcp_handling:
.. rst-class:: ansible-option-title
**dhcp_handling**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dhcp_handling" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
How to handle DHCP packets on network.
.. rst-class:: ansible-option-line
:ansible-option-choices:`Choices:`
- :ansible-option-choices-entry:`"Run a DHCP server"`
- :ansible-option-choices-entry:`"Relay DHCP to another server"`
- :ansible-option-choices-entry:`"Do not respond to DHCP requests"`
- :ansible-option-choices-entry:`"none"`
- :ansible-option-choices-entry:`"server"`
- :ansible-option-choices-entry:`"relay"`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dhcp_lease_time"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-dhcp_lease_time:
.. rst-class:: ansible-option-title
**dhcp_lease_time**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dhcp_lease_time" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
DHCP lease timer setting
.. rst-class:: ansible-option-line
:ansible-option-choices:`Choices:`
- :ansible-option-choices-entry:`"30 minutes"`
- :ansible-option-choices-entry:`"1 hour"`
- :ansible-option-choices-entry:`"4 hours"`
- :ansible-option-choices-entry:`"12 hours"`
- :ansible-option-choices-entry:`"1 day"`
- :ansible-option-choices-entry:`"1 week"`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dhcp_options"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-dhcp_options:
.. rst-class:: ansible-option-title
**dhcp_options**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dhcp_options" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
List of DHCP option values
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dhcp_options/code"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-dhcp_options/code:
.. rst-class:: ansible-option-title
**code**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dhcp_options/code" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`integer`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
DHCP option number.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dhcp_options/type"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-dhcp_options/type:
.. rst-class:: ansible-option-title
**type**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dhcp_options/type" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Type of value for DHCP option.
.. rst-class:: ansible-option-line
:ansible-option-choices:`Choices:`
- :ansible-option-choices-entry:`"text"`
- :ansible-option-choices-entry:`"ip"`
- :ansible-option-choices-entry:`"hex"`
- :ansible-option-choices-entry:`"integer"`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dhcp_options/value"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-dhcp_options/value:
.. rst-class:: ansible-option-title
**value**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dhcp_options/value" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Value for DHCP option.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dhcp_relay_server_ips"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-dhcp_relay_server_ips:
.. rst-class:: ansible-option-title
**dhcp_relay_server_ips**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dhcp_relay_server_ips" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`list` / :ansible-option-elements:`elements=string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
IP addresses to forward DHCP packets to.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-dns_nameservers"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-dns_nameservers:
.. rst-class:: ansible-option-title
**dns_nameservers**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-dns_nameservers" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
Semi-colon delimited list of DNS IP addresses.
Specify one of the following options for preprogrammed DNS entries opendns, google\_dns, upstream\_dns
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-fixed_ip_assignments"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-fixed_ip_assignments:
.. rst-class:: ansible-option-title
**fixed_ip_assignments**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-fixed_ip_assignments" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
Static IP address assignments to be distributed via DHCP by MAC address.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-fixed_ip_assignments/ip"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-fixed_ip_assignments/ip:
.. rst-class:: ansible-option-title
**ip**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-fixed_ip_assignments/ip" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
IP address for fixed IP assignment binding.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-fixed_ip_assignments/mac"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-fixed_ip_assignments/mac:
.. rst-class:: ansible-option-title
**mac**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-fixed_ip_assignments/mac" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
MAC address for fixed IP assignment binding.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-fixed_ip_assignments/name"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-fixed_ip_assignments/name:
.. rst-class:: ansible-option-title
**name**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-fixed_ip_assignments/name" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Descriptive name of IP assignment binding.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-host"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-host:
.. rst-class:: ansible-option-title
**host**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
Hostname for Meraki dashboard.
Can be used to access regional Meraki environments, such as China.
.. rst-class:: ansible-option-line
:ansible-option-default-bold:`Default:` :ansible-option-default:`"api.meraki.com"`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-internal_error_retry_time"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-internal_error_retry_time:
.. rst-class:: ansible-option-title
**internal_error_retry_time**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-internal_error_retry_time" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`integer`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
Number of seconds to retry if server returns an internal server error.
.. rst-class:: ansible-option-line
:ansible-option-default-bold:`Default:` :ansible-option-default:`60`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-name"></div>
<div class="ansibleOptionAnchor" id="parameter-vlan_name"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-name:
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-vlan_name:
.. rst-class:: ansible-option-title
**name**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-aliases:`aliases: vlan_name`
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
Name of VLAN.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-net_id"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-net_id:
.. rst-class:: ansible-option-title
**net_id**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-net_id" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
ID of network which VLAN is in or should be in.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-net_name"></div>
<div class="ansibleOptionAnchor" id="parameter-network"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-net_name:
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-network:
.. rst-class:: ansible-option-title
**net_name**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-net_name" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-aliases:`aliases: network`
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
Name of network which VLAN is in or should be in.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-org_id"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-org_id:
.. rst-class:: ansible-option-title
**org_id**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-org_id" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
ID of organization.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-org_name"></div>
<div class="ansibleOptionAnchor" id="parameter-organization"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-org_name:
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-organization:
.. rst-class:: ansible-option-title
**org_name**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-org_name" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-aliases:`aliases: organization`
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
Name of organization.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-output_format"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-output_format:
.. rst-class:: ansible-option-title
**output_format**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-output_format" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
Instructs module whether response keys should be snake case (ex. \ :literal:`net\_id`\ ) or camel case (ex. \ :literal:`netId`\ ).
.. rst-class:: ansible-option-line
:ansible-option-choices:`Choices:`
- :ansible-option-choices-entry-default:`"snakecase"` :ansible-option-choices-default-mark:`← (default)`
- :ansible-option-choices-entry:`"camelcase"`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-output_level"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-output_level:
.. rst-class:: ansible-option-title
**output_level**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-output_level" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
Set amount of debug output during module execution.
.. rst-class:: ansible-option-line
:ansible-option-choices:`Choices:`
- :ansible-option-choices-entry:`"debug"`
- :ansible-option-choices-entry-default:`"normal"` :ansible-option-choices-default-mark:`← (default)`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-rate_limit_retry_time"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-rate_limit_retry_time:
.. rst-class:: ansible-option-title
**rate_limit_retry_time**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-rate_limit_retry_time" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`integer`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
Number of seconds to retry if rate limiter is triggered.
.. rst-class:: ansible-option-line
:ansible-option-default-bold:`Default:` :ansible-option-default:`165`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-reserved_ip_range"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-reserved_ip_range:
.. rst-class:: ansible-option-title
**reserved_ip_range**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-reserved_ip_range" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
IP address ranges which should be reserve and not distributed via DHCP.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-reserved_ip_range/comment"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-reserved_ip_range/comment:
.. rst-class:: ansible-option-title
**comment**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-reserved_ip_range/comment" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Description of IP addresses reservation
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-reserved_ip_range/end"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-reserved_ip_range/end:
.. rst-class:: ansible-option-title
**end**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-reserved_ip_range/end" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Last IP address of reserved IP address range, inclusive.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-reserved_ip_range/start"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-reserved_ip_range/start:
.. rst-class:: ansible-option-title
**start**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-reserved_ip_range/start" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
First IP address of reserved IP address range, inclusive.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-state"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-state:
.. rst-class:: ansible-option-title
**state**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
Specifies whether object should be queried, created/modified, or removed.
.. rst-class:: ansible-option-line
:ansible-option-choices:`Choices:`
- :ansible-option-choices-entry:`"absent"`
- :ansible-option-choices-entry:`"present"`
- :ansible-option-choices-entry-default:`"query"` :ansible-option-choices-default-mark:`← (default)`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-subnet"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-subnet:
.. rst-class:: ansible-option-title
**subnet**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-subnet" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
CIDR notation of network subnet.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-timeout"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-timeout:
.. rst-class:: ansible-option-title
**timeout**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-timeout" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`integer`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
Time to timeout for HTTP requests.
.. rst-class:: ansible-option-line
:ansible-option-default-bold:`Default:` :ansible-option-default:`30`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-use_https"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-use_https:
.. rst-class:: ansible-option-title
**use_https**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-use_https" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`boolean`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
If \ :literal:`no`\ , it will use HTTP. Otherwise it will use HTTPS.
Only useful for internal Meraki developers.
.. rst-class:: ansible-option-line
:ansible-option-choices:`Choices:`
- :ansible-option-choices-entry:`false`
- :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-use_proxy"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-use_proxy:
.. rst-class:: ansible-option-title
**use_proxy**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-use_proxy" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`boolean`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
If \ :literal:`no`\ , it will not use a proxy, even if one is defined in an environment variable on the target hosts.
.. rst-class:: ansible-option-line
:ansible-option-choices:`Choices:`
- :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)`
- :ansible-option-choices-entry:`true`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-validate_certs"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-validate_certs:
.. rst-class:: ansible-option-title
**validate_certs**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-validate_certs" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`boolean`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
Whether to validate HTTP certificates.
.. rst-class:: ansible-option-line
:ansible-option-choices:`Choices:`
- :ansible-option-choices-entry:`false`
- :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-vlan_id"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-vlan_id:
.. rst-class:: ansible-option-title
**vlan_id**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-vlan_id" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`integer`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
ID number of VLAN.
ID should be between 1-4096.
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-vpn_nat_subnet"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__parameter-vpn_nat_subnet:
.. rst-class:: ansible-option-title
**vpn_nat_subnet**
.. raw:: html
<a class="ansibleOptionLink" href="#parameter-vpn_nat_subnet" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
The translated VPN subnet if VPN and VPN subnet translation are enabled on the VLAN.
.. raw:: html
</div>
.. Attributes
.. Notes
Notes
-----
.. note::
- Meraki's API will return an error if VLANs aren't enabled on a network. VLANs are returned properly if VLANs are enabled on a network.
- Some of the options are likely only used for developers within Meraki.
- Meraki's API defaults to networks having VLAN support disabled and there is no way to enable VLANs support in the API. VLAN support must be enabled manually.
- 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 \ :literal:`ANSIBLE\_MERAKI\_FORMAT`\ environment variable to \ :literal:`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.
.. Seealso
.. Examples
Examples
--------
.. code-block:: yaml+jinja
- name: Query all VLANs in a network.
meraki_vlan:
auth_key: abc12345
org_name: YourOrg
net_name: YourNet
state: query
delegate_to: localhost
- name: Query information about a single VLAN by ID.
meraki_vlan:
auth_key: abc12345
org_name: YourOrg
net_name: YourNet
vlan_id: 2
state: query
delegate_to: localhost
- name: Create a VLAN.
meraki_vlan:
auth_key: abc12345
org_name: YourOrg
net_name: YourNet
state: present
vlan_id: 2
name: TestVLAN
subnet: 192.0.1.0/24
appliance_ip: 192.0.1.1
delegate_to: localhost
- name: Update a VLAN.
meraki_vlan:
auth_key: abc12345
org_name: YourOrg
net_name: YourNet
state: present
vlan_id: 2
name: TestVLAN
subnet: 192.0.1.0/24
appliance_ip: 192.168.250.2
fixed_ip_assignments:
- mac: "13:37:de:ad:be:ef"
ip: 192.168.250.10
name: fixed_ip
reserved_ip_range:
- start: 192.168.250.10
end: 192.168.250.20
comment: reserved_range
dns_nameservers: opendns
delegate_to: localhost
- name: Enable DHCP on VLAN with options
meraki_vlan:
auth_key: abc123
state: present
org_name: YourOrg
net_name: YourNet
vlan_id: 2
name: TestVLAN
subnet: 192.168.250.0/24
appliance_ip: 192.168.250.2
dhcp_handling: server
dhcp_lease_time: 1 hour
dhcp_boot_options_enabled: false
dhcp_options:
- code: 5
type: ip
value: 192.0.1.1
delegate_to: localhost
- name: Delete a VLAN.
meraki_vlan:
auth_key: abc12345
org_name: YourOrg
net_name: YourNet
state: absent
vlan_id: 2
delegate_to: localhost
.. Facts
.. Return values
Return Values
-------------
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
.. rst-class:: ansible-option-table
.. list-table::
:width: 100%
:widths: auto
:header-rows: 1
* - Key
- Description
* - .. raw:: html
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__return-response:
.. rst-class:: ansible-option-title
**response**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`complex`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-cell">
Information about the organization which was created or modified
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` success
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response/appliance_ip"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__return-response/appliance_ip:
.. rst-class:: ansible-option-title
**appliance_ip**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response/appliance_ip" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
IP address of Meraki appliance in the VLAN
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` success
.. rst-class:: ansible-option-line
.. rst-class:: ansible-option-sample
:ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"192.0.1.1"`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response/dhcp_boot_filename"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__return-response/dhcp_boot_filename:
.. rst-class:: ansible-option-title
**dhcp_boot_filename**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response/dhcp_boot_filename" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Filename for boot file.
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` success
.. rst-class:: ansible-option-line
.. rst-class:: ansible-option-sample
:ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"boot.txt"`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response/dhcp_boot_next_server"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__return-response/dhcp_boot_next_server:
.. rst-class:: ansible-option-title
**dhcp_boot_next_server**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response/dhcp_boot_next_server" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
DHCP boot option to direct boot clients to the server to load the boot file from.
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` success
.. rst-class:: ansible-option-line
.. rst-class:: ansible-option-sample
:ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"192.0.1.2"`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response/dhcp_boot_options_enabled"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__return-response/dhcp_boot_options_enabled:
.. rst-class:: ansible-option-title
**dhcp_boot_options_enabled**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response/dhcp_boot_options_enabled" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`boolean`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Whether DHCP boot options are enabled.
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` success
.. rst-class:: ansible-option-line
.. rst-class:: ansible-option-sample
:ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`false`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response/dhcp_handling"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__return-response/dhcp_handling:
.. rst-class:: ansible-option-title
**dhcp_handling**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response/dhcp_handling" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Status of DHCP server on VLAN.
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` success
.. rst-class:: ansible-option-line
.. rst-class:: ansible-option-sample
:ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"Run a DHCP server"`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response/dhcp_lease_time"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__return-response/dhcp_lease_time:
.. rst-class:: ansible-option-title
**dhcp_lease_time**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response/dhcp_lease_time" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
DHCP lease time when server is active.
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` success
.. rst-class:: ansible-option-line
.. rst-class:: ansible-option-sample
:ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"1 day"`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response/dhcp_options"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__return-response/dhcp_options:
.. rst-class:: ansible-option-title
**dhcp_options**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response/dhcp_options" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`complex`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
DHCP options.
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` success
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response/dhcp_options/code"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__return-response/dhcp_options/code:
.. rst-class:: ansible-option-title
**code**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response/dhcp_options/code" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`integer`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Code for DHCP option.
Integer between 2 and 254.
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` success
.. rst-class:: ansible-option-line
.. rst-class:: ansible-option-sample
:ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`43`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response/dhcp_options/type"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__return-response/dhcp_options/type:
.. rst-class:: ansible-option-title
**type**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response/dhcp_options/type" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Type for DHCP option.
Choices are \ :literal:`text`\ , \ :literal:`ip`\ , \ :literal:`hex`\ , \ :literal:`integer`\ .
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` success
.. rst-class:: ansible-option-line
.. rst-class:: ansible-option-sample
:ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"text"`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response/dhcp_options/value"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__return-response/dhcp_options/value:
.. rst-class:: ansible-option-title
**value**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response/dhcp_options/value" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Value for the DHCP option.
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` success
.. rst-class:: ansible-option-line
.. rst-class:: ansible-option-sample
:ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"192.0.1.2"`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response/dnsnamservers"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__return-response/dnsnamservers:
.. rst-class:: ansible-option-title
**dnsnamservers**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response/dnsnamservers" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
IP address or Meraki defined DNS servers which VLAN should use by default
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` success
.. rst-class:: ansible-option-line
.. rst-class:: ansible-option-sample
:ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"upstream\_dns"`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response/fixed_ip_assignments"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__return-response/fixed_ip_assignments:
.. rst-class:: ansible-option-title
**fixed_ip_assignments**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response/fixed_ip_assignments" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`complex`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
List of MAC addresses which have IP addresses assigned.
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` success
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response/fixed_ip_assignments/macaddress"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__return-response/fixed_ip_assignments/macaddress:
.. rst-class:: ansible-option-title
**macaddress**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response/fixed_ip_assignments/macaddress" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`complex`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
MAC address which has IP address assigned to it. Key value is the actual MAC address.
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` success
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response/fixed_ip_assignments/macaddress/ip"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__return-response/fixed_ip_assignments/macaddress/ip:
.. rst-class:: ansible-option-title
**ip**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response/fixed_ip_assignments/macaddress/ip" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
IP address which is assigned to the MAC address.
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` success
.. rst-class:: ansible-option-line
.. rst-class:: ansible-option-sample
:ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"192.0.1.4"`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response/fixed_ip_assignments/macaddress/name"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__return-response/fixed_ip_assignments/macaddress/name:
.. rst-class:: ansible-option-title
**name**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response/fixed_ip_assignments/macaddress/name" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Descriptive name for binding.
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` success
.. rst-class:: ansible-option-line
.. rst-class:: ansible-option-sample
:ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"fixed\_ip"`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response/id"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__return-response/id:
.. rst-class:: ansible-option-title
**id**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response/id" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`integer`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
VLAN ID number.
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` success
.. rst-class:: ansible-option-line
.. rst-class:: ansible-option-sample
:ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`2`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response/name"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__return-response/name:
.. rst-class:: ansible-option-title
**name**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response/name" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Descriptive name of VLAN.
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` success
.. rst-class:: ansible-option-line
.. rst-class:: ansible-option-sample
:ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"TestVLAN"`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response/networkId"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__return-response/networkid:
.. rst-class:: ansible-option-title
**networkId**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response/networkId" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
ID number of Meraki network which VLAN is associated to.
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` success
.. rst-class:: ansible-option-line
.. rst-class:: ansible-option-sample
:ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"N\_12345"`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response/reserved_ip_ranges"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__return-response/reserved_ip_ranges:
.. rst-class:: ansible-option-title
**reserved_ip_ranges**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response/reserved_ip_ranges" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`complex`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
List of IP address ranges which are reserved for static assignment.
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` success
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response/reserved_ip_ranges/comment"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__return-response/reserved_ip_ranges/comment:
.. rst-class:: ansible-option-title
**comment**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response/reserved_ip_ranges/comment" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Description for IP address reservation.
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` success
.. rst-class:: ansible-option-line
.. rst-class:: ansible-option-sample
:ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"reserved\_range"`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response/reserved_ip_ranges/end"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__return-response/reserved_ip_ranges/end:
.. rst-class:: ansible-option-title
**end**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response/reserved_ip_ranges/end" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
Last IP address in reservation range.
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` success
.. rst-class:: ansible-option-line
.. rst-class:: ansible-option-sample
:ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"192.0.1.10"`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response/reserved_ip_ranges/start"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__return-response/reserved_ip_ranges/start:
.. rst-class:: ansible-option-title
**start**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response/reserved_ip_ranges/start" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
First IP address in reservation range.
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` success
.. rst-class:: ansible-option-line
.. rst-class:: ansible-option-sample
:ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"192.0.1.5"`
.. raw:: html
</div>
* - .. raw:: html
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-response/subnet"></div>
.. _ansible_collections.cisco.meraki.meraki_mx_vlan_module__return-response/subnet:
.. rst-class:: ansible-option-title
**subnet**
.. raw:: html
<a class="ansibleOptionLink" href="#return-response/subnet" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
.. raw:: html
</div>
- .. raw:: html
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
CIDR notation IP subnet of VLAN.
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` success
.. rst-class:: ansible-option-line
.. rst-class:: ansible-option-sample
:ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"192.0.1.0/24"`
.. raw:: html
</div>
.. Status (Presently only deprecated)
Status
------
.. Deprecated note
- This module will be removed in version 3.0.0.
*[deprecated]*
- For more information see `DEPRECATED`_.
.. Authors
Authors
~~~~~~~
- Kevin Breit (@kbreit)
.. Extra links
Collection links
~~~~~~~~~~~~~~~~
.. raw:: html
<p class="ansible-links">
<a href="https://github.com/meraki/dashboard-api-ansible/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
<a href="https://github.com/meraki/dashboard-api-ansible" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
</p>
.. Parsing errors