cisco.meraki.meraki_ms_stack – Modify switch stacking configuration in Meraki.

Note

This plugin is part of the cisco.meraki collection (version 2.5.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.meraki.

To use it in a playbook, specify: cisco.meraki.meraki_ms_stack.

New in version 1.3.0: of cisco.meraki

Synopsis

Allows for modification of Meraki MS switch stacks.

Parameters

Parameter	Choices/Defaults	Comments
auth_key string / required		Authentication key provided by the dashboard. Required if environmental variable `MERAKI_KEY` is not set.
host string	Default: "api.meraki.com"	Hostname for Meraki dashboard. Can be used to access regional Meraki environments, such as China.
internal_error_retry_time integer	Default: 60	Number of seconds to retry if server returns an internal server error.
name string		Name of stack.
net_id string		ID of network which MX firewall is in.
net_name string		Name of network which MX firewall is in.
org_id string		ID of organization.
org_name string		Name of organization. aliases: organization
output_format string	Choices: snakecase ← camelcase	Instructs module whether response keys should be snake case (ex. `net_id`) or camel case (ex. `netId`).
output_level string	Choices: debug normal ←	Set amount of debug output during module execution.
rate_limit_retry_time integer	Default: 165	Number of seconds to retry if rate limiter is triggered.
serials list / elements=string		List of switch serial numbers which should be included or removed from a stack.
stack_id string		ID of stack which is to be modified or deleted.
state string	Choices: present ← query absent	Create or modify an organization.
timeout integer	Default: 30	Time to timeout for HTTP requests.
use_https boolean	Choices: no yes ←	If `no`, it will use HTTP. Otherwise it will use HTTPS. Only useful for internal Meraki developers.
use_proxy boolean	Choices: no ← yes	If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
validate_certs boolean	Choices: no yes ←	Whether to validate HTTP certificates.

Notes

Note

Not all actions are idempotent. Specifically, creating a new stack will error if any switch is already in a stack.
More information about the Meraki API can be found at https://dashboard.meraki.com/api_docs.
Some of the options are likely only used for developers within Meraki.
As of Ansible 2.9, Meraki modules output keys as snake case. To use camel case, set the ANSIBLE_MERAKI_FORMAT environment variable to camelcase.
Ansible’s Meraki modules will stop supporting camel case output in Ansible 2.13. Please update your playbooks.
Check Mode downloads the current configuration from the dashboard, then compares changes against this download. Check Mode will report changed if there are differences in the configurations, but does not submit changes to the API for validation of change.

Examples

- name: Create new stack
  meraki_switch_stack:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    name: Test stack
    serials:
    - "ABCD-1231-4579"
    - "ASDF-4321-0987"

- name: Add switch to stack
  meraki_switch_stack:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    stack_id: ABC12340987
    serials:
    - "ABCD-1231-4579"

- name: Remove switch from stack
  meraki_switch_stack:
    auth_key: abc123
    state: absent
    org_name: YourOrg
    net_name: YourNet
    stack_id: ABC12340987
    serials:
    - "ABCD-1231-4579"

- name: Query one stack
  meraki_switch_stack:
    auth_key: abc123
    state: query
    org_name: YourOrg
    net_name: YourNet
    stack_id: ABC12340987

Return Values

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

Key		Returned	Description
data complex		success	VPN settings.
	id string	always	ID of switch stack. Sample: 7636
	name string	always	Descriptive name of switch stack. Sample: MyStack
	serials list / elements=string	always	List of serial numbers in switch stack. Sample: ['QBZY-XWVU-TSRQ', 'QBAB-CDEF-GHIJ']

Authors

Kevin Breit (@kbreit)

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

Docs

Docs4dev

Title here