cisco.meraki.meraki_mr_settings (2.18.0) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: cisco.meraki
      version: 2.18.0

Description

Allows for configuration of general settings in Meraki MR wireless networks.

Usage examples

Scanned by Steampunk Spotter

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

- name: Query all settings
  meraki_mr_settings:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
  delegate_to: localhost

Scanned by Steampunk Spotter

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

- name: Configure settings
  meraki_mr_settings:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    upgrade_strategy: minimize_upgrade_time
    ipv6_bridge_enabled: false
    led_lights_on: true
    location_analytics_enabled: true
    meshing_enabled: true
  delegate_to: localhost

Inputs

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

state:
    choices:
    - present
    - query
    default: present
    description:
    - Query or edit wireless settings.
    type: str

net_id:
    description:
    - ID of network.
    type: str

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

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.
    type: str

org_name:
    aliases:
    - organization
    description:
    - Name of organization.
    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:
    default: false
    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

led_lights_on:
    description:
    - Toggle for enabling or disabling LED lights on all APs in the network.
    type: bool

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

meshing_enabled:
    description: Toggle for enabling or disabling meshing in a network.
    type: bool

upgrade_strategy:
    choices:
    - minimize_upgrade_time
    - minimize_client_downtime
    description:
    - The upgrade strategy to apply to the network.
    - Requires firmware version MR 26.8 or higher.
    type: str

ipv6_bridge_enabled:
    description:
    - Toggle for enabling or disabling IPv6 bridging in a network.
    - If enabled, SSIDs must also be configured to use bridge mode.
    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

location_analytics_enabled:
    description:
    - Toggle for enabling or disabling location analytics for your network.
    type: bool

Outputs

data:
  contains:
    ipv6_bridge_enabled:
      description:
      - Toggle for enabling or disabling IPv6 bridging in a network.
      - If enabled, SSIDs must also be configured to use bridge mode.
      returned: success
      sample: true
      type: bool
    led_lights_on:
      description:
      - Toggle for enabling or disabling LED lights on all APs in the network.
      returned: success
      sample: true
      type: bool
    location_analytics_enabled:
      description:
      - Toggle for enabling or disabling location analytics for your network.
      returned: success
      sample: true
      type: bool
    meshing_enabled:
      description: Toggle for enabling or disabling meshing in a network.
      returned: success
      sample: true
      type: bool
    upgrade_strategy:
      description:
      - The upgrade strategy to apply to the network.
      - Requires firmware version MR 26.8 or higher.
      returned: success
      sample: minimize_upgrade_time
      type: str
  description: List of wireless settings.
  returned: success
  type: complex