Deprecated

Removed in 3.0.0

i

Reason:Updated modules released with increased functionality | Alternative:cisco.meraki.devices_wireless_radio_settings

cisco.meraki.meraki_mr_radio (2.18.0) — module

Manage device radio settings for Meraki wireless networks

Authors: Tyler Christiansen (@supertylerc)

deprecated | supported by community

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 radio settings in Meraki MR wireless networks.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Query a device's radio configuration
  meraki_mr_radio:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    serial: YourSerialNumber
    state: query
  delegate_to: localhost
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure a device's radios
  meraki_mr_radio:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    serial: YourSerialNumber
    state: present
    five_ghz_settings:
      channel: 56
      channel_width: 20
      target_power: 10
    two_four_ghz_settings:
      channel: 6
      target_power: 12
    rf_profile_name: Test Profile
  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 radio settings on a device.
    type: str

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

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

serial:
    description:
    - Serial number of a device to query.
    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:
    aliases:
    - network
    description:
    - Name of a 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

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

rf_profile_id:
    description:
    - The ID of an RF profile to assign to the device.
    - If the value of this parameter is null, the appropriate basic RF profile (indoor
      or outdoor) will be assigned to the device.
    - Assigning an RF profile will clear ALL manually configured overrides on the device
      (channel width, channel, power).
    type: str

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

rf_profile_name:
    description:
    - The name of an RF profile to assign to the device.
    - Similar to ``rf_profile_id``, but requires ``net_id`` (preferred) or ``net_name``.
    type: str

five_ghz_settings:
    default: {}
    description:
    - Manual radio settings for 5 GHz.
    suboptions:
      channel:
        choices:
        - 36
        - 40
        - 44
        - 48
        - 52
        - 56
        - 60
        - 64
        - 100
        - 104
        - 108
        - 112
        - 116
        - 120
        - 124
        - 128
        - 132
        - 136
        - 140
        - 144
        - 149
        - 153
        - 157
        - 161
        - 165
        description:
        - Sets a manual channel for 5 GHz.
        type: int
      channel_width:
        choices:
        - auto
        - '20'
        - '40'
        - '80'
        description:
        - Sets a manual channel for 5 GHz.
        - Can be '0', '20', '40', or '80' or null for using auto channel width.
        type: str
      target_power:
        description:
        - Set a manual target power for 5 GHz.
        - Can be between '8' or '30' or null for using auto power range.
        type: int
    type: dict

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

two_four_ghz_settings:
    default: {}
    description:
    - Manual radio settings for 2.4 GHz.
    suboptions:
      channel:
        choices:
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
        - 8
        - 9
        - 10
        - 11
        - 12
        - 13
        - 14
        description:
        - Sets a manual channel for 2.4 GHz.
        - Can be '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13' or
          '14' or null for using auto channel.
        type: int
      target_power:
        description:
        - Set a manual target power for 2.4 GHz.
        - Can be between '5' or '30' or null for using auto power range.
        type: int
    type: dict

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

Outputs

data:
  contains:
    five_ghz_settings:
      contains:
        channel:
          description:
          - Configured manual channel for 5 GHz.
          - Null indicates auto channel.
          sample: 56
          type: str
        channel_width:
          description:
          - Configured manual channel for 5 GHz.
          - Null indicates auto channel width.
          sample: 40
          type: str
        target_power:
          description:
          - Configured manual target power for 5 GHz.
          - Null indicates auto power.
          sample: 25
          type: int
      description:
      - Configured manual radio settings for 5 GHz.
      returned: success
      type: dict
    rf_profile_id:
      description:
      - The ID of an RF profile assigned to the device.
      - Null indicates the appropriate basic RF profile (indoor or outdoor) is assigned
        to the device.
      returned: success
      sample: null
      type: str
    serial:
      description:
      - Serial number of the device that was configured.
      returned: success
      sample: xyz
      type: str
    two_four_ghz_settings:
      contains:
        channel:
          description:
          - Configured manual channel for 2.4 GHz.
          - Null indicates auto channel.
          sample: 11
          type: str
        target_power:
          description:
          - Configured manual target power for 2.4 GHz.
          - Null indicates auto power.
          sample: 15
          type: int
      description:
      - Configured manual radio settings for 2.4 GHz.
      returned: success
      type: dict
  description: RF settings configured on a specific device.
  returned: success
  type: complex