cisco.meraki.meraki_switch_stack (1.4.0) — module

Install collection

Install with ansible-galaxy collection install cisco.meraki:==1.4.0

Add to requirements.yml

  collections:
    - name: cisco.meraki
      version: 1.4.0

Description

Allows for modification of Meraki MS switch stacks.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
host:
    default: api.meraki.com
    description:
    - Hostname for Meraki dashboard.
    - Can be used to access regional Meraki environments, such as China.
    type: str

name:
    description:
    - Name of stack.
    type: str

state:
    choices:
    - present
    - query
    - absent
    default: present
    description:
    - Create or modify an organization.
    type: str

net_id:
    description:
    - ID of network which MX firewall is in.
    type: str

org_id:
    description:
    - ID of organization.
    type: str

serials:
    description:
    - List of switch serial numbers which should be included or removed from a stack.
    elements: str
    type: list

timeout:
    default: 30
    description:
    - Time to timeout for HTTP requests.
    type: int

auth_key:
    description:
    - Authentication key provided by the dashboard. Required if environmental variable
      C(MERAKI_KEY) is not set.
    required: true
    type: str

net_name:
    description:
    - Name of network which MX firewall is in.
    type: str

org_name:
    aliases:
    - organization
    description:
    - Name of organization.
    type: str

stack_id:
    description:
    - ID of stack which is to be modified or deleted.
    type: str

use_https:
    default: true
    description:
    - If C(no), it will use HTTP. Otherwise it will use HTTPS.
    - Only useful for internal Meraki developers.
    type: bool

use_proxy:
    description:
    - If C(no), it will not use a proxy, even if one is defined in an environment variable
      on the target hosts.
    type: bool

output_level:
    choices:
    - debug
    - normal
    default: normal
    description:
    - Set amount of debug output during module execution.
    type: str

output_format:
    choices:
    - snakecase
    - camelcase
    default: snakecase
    description:
    - Instructs module whether response keys should be snake case (ex. C(net_id)) or camel
      case (ex. C(netId)).
    type: str

validate_certs:
    default: true
    description:
    - Whether to validate HTTP certificates.
    type: bool

rate_limit_retry_time:
    default: 165
    description:
    - Number of seconds to retry if rate limiter is triggered.
    type: int

internal_error_retry_time:
    default: 60
    description:
    - Number of seconds to retry if server returns an internal server error.
    type: int

Outputs

data:
  contains:
    id:
      description: ID of switch stack.
      returned: always
      sample: 7636
      type: str
    name:
      description: Descriptive name of switch stack.
      returned: always
      sample: MyStack
      type: str
    serials:
      description: List of serial numbers in switch stack.
      returned: always
      sample:
      - QBZY-XWVU-TSRQ
      - QBAB-CDEF-GHIJ
      type: list
  description: VPN settings.
  returned: success
  type: complex