.. 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_management_interface_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.meraki.meraki_management_interface module -- Configure Meraki management interfaces +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.meraki collection <https://galaxy.ansible.com/cisco/meraki>`_ (version 2.20.10). To install it, use: :code:`ansible-galaxy collection install cisco.meraki`. To use it in a playbook, specify: :code:`cisco.meraki.meraki_management_interface`. .. version_added .. rst-class:: ansible-version-added New in cisco.meraki 1.1.0 .. contents:: :local: :depth: 1 .. Deprecated DEPRECATED ---------- :Removed in: version 3.0.0 :Why: Updated modules released with increased functionality :Alternative: cisco.meraki.devices\_management\_interface Synopsis -------- .. Description - Allows for configuration of management interfaces on Meraki MX, MS, and MR devices. .. 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-auth_key"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_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-host"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_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_management_interface_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-net_id"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_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 the network to bind or unbind configuration template to. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-net_name"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-net_name: .. 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-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Name of the network to bind or unbind configuration template to. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-org_id"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_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 associated to a configuration template. .. 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_management_interface_module__parameter-org_name: .. _ansible_collections.cisco.meraki.meraki_management_interface_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 containing the configuration template. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-output_format"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_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_management_interface_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_management_interface_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-serial"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-serial: .. rst-class:: ansible-option-title **serial** .. raw:: html <a class="ansibleOptionLink" href="#parameter-serial" 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"> serial number of the device to configure. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-state"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_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 configuration template information should be queried, modified, or deleted. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"absent"` - :ansible-option-choices-entry-default:`"query"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"present"` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-timeout"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_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_management_interface_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_management_interface_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_management_interface_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-wan1"></div> <div class="ansibleOptionAnchor" id="parameter-mgmt1"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-mgmt1: .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-wan1: .. rst-class:: ansible-option-title **wan1** .. raw:: html <a class="ansibleOptionLink" href="#parameter-wan1" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: mgmt1` .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Management interface details for management interface. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-wan1/static_dns"></div> <div class="ansibleOptionAnchor" id="parameter-mgmt1/static_dns"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-mgmt1/static_dns: .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-wan1/static_dns: .. rst-class:: ansible-option-title **static_dns** .. raw:: html <a class="ansibleOptionLink" href="#parameter-wan1/static_dns" 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-indent-desc"></div><div class="ansible-option-cell"> DNS servers to use. Allows for a maximum of 2 addresses. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-wan1/static_gateway_ip"></div> <div class="ansibleOptionAnchor" id="parameter-mgmt1/static_gateway_ip"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-mgmt1/static_gateway_ip: .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-wan1/static_gateway_ip: .. rst-class:: ansible-option-title **static_gateway_ip** .. raw:: html <a class="ansibleOptionLink" href="#parameter-wan1/static_gateway_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 default gateway. Valid only if \ :literal:`using\_static\_ip`\ is \ :literal:`True`\ . .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-wan1/static_ip"></div> <div class="ansibleOptionAnchor" id="parameter-mgmt1/static_ip"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-mgmt1/static_ip: .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-wan1/static_ip: .. rst-class:: ansible-option-title **static_ip** .. raw:: html <a class="ansibleOptionLink" href="#parameter-wan1/static_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 assigned to Management interface. Valid only if \ :literal:`using\_static\_ip`\ is \ :literal:`True`\ . .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-wan1/static_subnet_mask"></div> <div class="ansibleOptionAnchor" id="parameter-mgmt1/static_subnet_mask"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-mgmt1/static_subnet_mask: .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-wan1/static_subnet_mask: .. rst-class:: ansible-option-title **static_subnet_mask** .. raw:: html <a class="ansibleOptionLink" href="#parameter-wan1/static_subnet_mask" 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"> Netmask for static IP address. Valid only if \ :literal:`using\_static\_ip`\ is \ :literal:`True`\ . .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-wan1/using_static_ip"></div> <div class="ansibleOptionAnchor" id="parameter-mgmt1/using_static_ip"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-mgmt1/using_static_ip: .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-wan1/using_static_ip: .. rst-class:: ansible-option-title **using_static_ip** .. raw:: html <a class="ansibleOptionLink" href="#parameter-wan1/using_static_ip" 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-indent-desc"></div><div class="ansible-option-cell"> Configures the interface to use static IP or DHCP. .. 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-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-wan1/vlan"></div> <div class="ansibleOptionAnchor" id="parameter-mgmt1/vlan"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-mgmt1/vlan: .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-wan1/vlan: .. rst-class:: ansible-option-title **vlan** .. raw:: html <a class="ansibleOptionLink" href="#parameter-wan1/vlan" 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"> VLAN number to use for the management network. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-wan1/wan_enabled"></div> <div class="ansibleOptionAnchor" id="parameter-mgmt1/wan_enabled"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-mgmt1/wan_enabled: .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-wan1/wan_enabled: .. rst-class:: ansible-option-title **wan_enabled** .. raw:: html <a class="ansibleOptionLink" href="#parameter-wan1/wan_enabled" 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"> States whether the management interface is enabled. Only valid for MX devices. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"disabled"` - :ansible-option-choices-entry:`"enabled"` - :ansible-option-choices-entry:`"not configured"` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-wan2"></div> <div class="ansibleOptionAnchor" id="parameter-mgmt2"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-mgmt2: .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-wan2: .. rst-class:: ansible-option-title **wan2** .. raw:: html <a class="ansibleOptionLink" href="#parameter-wan2" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: mgmt2` .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Management interface details for management interface. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-wan2/static_dns"></div> <div class="ansibleOptionAnchor" id="parameter-mgmt2/static_dns"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-mgmt2/static_dns: .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-wan2/static_dns: .. rst-class:: ansible-option-title **static_dns** .. raw:: html <a class="ansibleOptionLink" href="#parameter-wan2/static_dns" 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-indent-desc"></div><div class="ansible-option-cell"> DNS servers to use. Allows for a maximum of 2 addresses. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-wan2/static_gateway_ip"></div> <div class="ansibleOptionAnchor" id="parameter-mgmt2/static_gateway_ip"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-mgmt2/static_gateway_ip: .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-wan2/static_gateway_ip: .. rst-class:: ansible-option-title **static_gateway_ip** .. raw:: html <a class="ansibleOptionLink" href="#parameter-wan2/static_gateway_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 default gateway. Valid only if \ :literal:`using\_static\_ip`\ is \ :literal:`True`\ . .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-wan2/static_ip"></div> <div class="ansibleOptionAnchor" id="parameter-mgmt2/static_ip"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-mgmt2/static_ip: .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-wan2/static_ip: .. rst-class:: ansible-option-title **static_ip** .. raw:: html <a class="ansibleOptionLink" href="#parameter-wan2/static_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 assigned to Management interface. Valid only if \ :literal:`using\_static\_ip`\ is \ :literal:`True`\ . .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-wan2/static_subnet_mask"></div> <div class="ansibleOptionAnchor" id="parameter-mgmt2/static_subnet_mask"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-mgmt2/static_subnet_mask: .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-wan2/static_subnet_mask: .. rst-class:: ansible-option-title **static_subnet_mask** .. raw:: html <a class="ansibleOptionLink" href="#parameter-wan2/static_subnet_mask" 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"> Netmask for static IP address. Valid only if \ :literal:`using\_static\_ip`\ is \ :literal:`True`\ . .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-wan2/using_static_ip"></div> <div class="ansibleOptionAnchor" id="parameter-mgmt2/using_static_ip"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-mgmt2/using_static_ip: .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-wan2/using_static_ip: .. rst-class:: ansible-option-title **using_static_ip** .. raw:: html <a class="ansibleOptionLink" href="#parameter-wan2/using_static_ip" 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-indent-desc"></div><div class="ansible-option-cell"> Configures the interface to use static IP or DHCP. .. 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-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-wan2/vlan"></div> <div class="ansibleOptionAnchor" id="parameter-mgmt2/vlan"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-mgmt2/vlan: .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-wan2/vlan: .. rst-class:: ansible-option-title **vlan** .. raw:: html <a class="ansibleOptionLink" href="#parameter-wan2/vlan" 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"> VLAN number to use for the management network. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-wan2/wan_enabled"></div> <div class="ansibleOptionAnchor" id="parameter-mgmt2/wan_enabled"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-mgmt2/wan_enabled: .. _ansible_collections.cisco.meraki.meraki_management_interface_module__parameter-wan2/wan_enabled: .. rst-class:: ansible-option-title **wan_enabled** .. raw:: html <a class="ansibleOptionLink" href="#parameter-wan2/wan_enabled" 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"> States whether the management interface is enabled. Only valid for MX devices. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"disabled"` - :ansible-option-choices-entry:`"enabled"` - :ansible-option-choices-entry:`"not configured"` .. raw:: html </div> .. Attributes .. Notes Notes ----- .. note:: - \ :literal:`WAN2`\ parameter is only valid for MX appliances. - \ :literal:`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 \ :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: 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: true 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 .. 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-data"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__return-data: .. rst-class:: ansible-option-title **data** .. raw:: html <a class="ansibleOptionLink" href="#return-data" 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 queried object. .. 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-data/wan1"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__return-data/wan1: .. rst-class:: ansible-option-title **wan1** .. raw:: html <a class="ansibleOptionLink" href="#return-data/wan1" 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"> Management configuration for WAN1 interface .. 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-data/wan1/static_dns"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__return-data/wan1/static_dns: .. rst-class:: ansible-option-title **static_dns** .. raw:: html <a class="ansibleOptionLink" href="#return-data/wan1/static_dns" title="Permalink to this return value"></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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> List of DNS IP addresses .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` only if static IP assignment is used .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`["1.1.1.1"]` .. 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-data/wan1/static_gateway_ip"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__return-data/wan1/static_gateway_ip: .. rst-class:: ansible-option-title **static_gateway_ip** .. raw:: html <a class="ansibleOptionLink" href="#return-data/wan1/static_gateway_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-cell"> Assigned static gateway IP .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` only if static IP assignment is used .. 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-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="return-data/wan1/static_ip"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__return-data/wan1/static_ip: .. rst-class:: ansible-option-title **static_ip** .. raw:: html <a class="ansibleOptionLink" href="#return-data/wan1/static_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-cell"> Assigned static IP .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` only if static IP assignment is used .. 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-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="return-data/wan1/static_subnet_mask"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__return-data/wan1/static_subnet_mask: .. rst-class:: ansible-option-title **static_subnet_mask** .. raw:: html <a class="ansibleOptionLink" href="#return-data/wan1/static_subnet_mask" 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"> Assigned netmask for static IP .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` only if static IP assignment is used .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"255.255.255.0"` .. 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-data/wan1/using_static_ip"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__return-data/wan1/using_static_ip: .. rst-class:: ansible-option-title **using_static_ip** .. raw:: html <a class="ansibleOptionLink" href="#return-data/wan1/using_static_ip" 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-indent-desc"></div><div class="ansible-option-cell"> Boolean value of whether static IP assignment is used on interface .. 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:`true` .. 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-data/wan1/vlan"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__return-data/wan1/vlan: .. rst-class:: ansible-option-title **vlan** .. raw:: html <a class="ansibleOptionLink" href="#return-data/wan1/vlan" 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"> VLAN tag id of management 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:`2` .. 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-data/wan1/wan_enabled"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__return-data/wan1/wan_enabled: .. rst-class:: ansible-option-title **wan_enabled** .. raw:: html <a class="ansibleOptionLink" href="#return-data/wan1/wan_enabled" 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"> Enabled state of interface .. 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:`"enabled"` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="return-data/wan2"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__return-data/wan2: .. rst-class:: ansible-option-title **wan2** .. raw:: html <a class="ansibleOptionLink" href="#return-data/wan2" 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"> Management configuration for WAN1 interface .. 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-data/wan2/static_dns"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__return-data/wan2/static_dns: .. rst-class:: ansible-option-title **static_dns** .. raw:: html <a class="ansibleOptionLink" href="#return-data/wan2/static_dns" title="Permalink to this return value"></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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> List of DNS IP addresses .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` only if static IP assignment is used .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`["1.1.1.1"]` .. 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-data/wan2/static_gateway_ip"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__return-data/wan2/static_gateway_ip: .. rst-class:: ansible-option-title **static_gateway_ip** .. raw:: html <a class="ansibleOptionLink" href="#return-data/wan2/static_gateway_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-cell"> Assigned static gateway IP .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` only if static IP assignment is used .. 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-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="return-data/wan2/static_ip"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__return-data/wan2/static_ip: .. rst-class:: ansible-option-title **static_ip** .. raw:: html <a class="ansibleOptionLink" href="#return-data/wan2/static_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-cell"> Assigned static IP .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` only if static IP assignment is used .. 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-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="return-data/wan2/static_subnet_mask"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__return-data/wan2/static_subnet_mask: .. rst-class:: ansible-option-title **static_subnet_mask** .. raw:: html <a class="ansibleOptionLink" href="#return-data/wan2/static_subnet_mask" 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"> Assigned netmask for static IP .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` only if static IP assignment is used .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"255.255.255.0"` .. 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-data/wan2/using_static_ip"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__return-data/wan2/using_static_ip: .. rst-class:: ansible-option-title **using_static_ip** .. raw:: html <a class="ansibleOptionLink" href="#return-data/wan2/using_static_ip" 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-indent-desc"></div><div class="ansible-option-cell"> Boolean value of whether static IP assignment is used on interface .. 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:`true` .. 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-data/wan2/vlan"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__return-data/wan2/vlan: .. rst-class:: ansible-option-title **vlan** .. raw:: html <a class="ansibleOptionLink" href="#return-data/wan2/vlan" 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"> VLAN tag id of management 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:`2` .. 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-data/wan2/wan_enabled"></div> .. _ansible_collections.cisco.meraki.meraki_management_interface_module__return-data/wan2/wan_enabled: .. rst-class:: ansible-option-title **wan_enabled** .. raw:: html <a class="ansibleOptionLink" href="#return-data/wan2/wan_enabled" 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"> Enabled state of interface .. 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:`"enabled"` .. 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