Deprecated

Removed in 3.0.0

i

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

cisco.meraki.meraki_mr_rf_profile (2.18.0) — module

Manage RF profiles for Meraki wireless networks

Authors: Kevin Breit (@kbreit)

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 frequency (RF) profiles in Meraki MR wireless networks.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create RF profile in check mode
  meraki_mr_rf_profile:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    name: Test Profile
    band_selection_type: ap
    client_balancing_enabled: True
    ap_band_settings:
        mode: dual
        band_steering_enabled: true
    five_ghz_settings:
      max_power: 10
      min_bitrate: 12
      min_power: 8
      rxsop: -65
      channel_width: 20
      valid_auto_channels:
        - 36
        - 40
        - 44
    two_four_ghz_settings:
      max_power: 10
      min_bitrate: 12
      min_power: 8
      rxsop: -65
      ax_enabled: false
      valid_auto_channels:
        - 1
  delegate_to: localhost
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Query all RF profiles
  meraki_mr_rf_profile:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
  delegate_to: localhost
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Query one RF profile by ID
  meraki_mr_rf_profile:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
    profile_id: '{{ profile_id }}'
  delegate_to: localhost
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Update profile
  meraki_mr_rf_profile:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    profile_id: 12345
    band_selection_type: ap
    client_balancing_enabled: True
    ap_band_settings:
        mode: dual
        band_steering_enabled: true
    five_ghz_settings:
      max_power: 10
      min_bitrate: 12
      min_power: 8
      rxsop: -65
      channel_width: 20
      valid_auto_channels:
        - 36
        - 44
    two_four_ghz_settings:
      max_power: 10
      min_bitrate: 12
      min_power: 8
      rxsop: -75
      ax_enabled: false
      valid_auto_channels:
        - 1
  delegate_to: localhost
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete RF profile
  meraki_mr_rf_profile:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: absent
    profile_id: 12345
  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

name:
    description:
    - The unique name of the new profile.
    - This param is required on creation.
    type: str

state:
    choices:
    - present
    - query
    - absent
    default: present
    description:
    - Query, edit, or delete wireless RF profile 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

profile_id:
    aliases:
    - id
    description:
    - Unique identifier of existing RF profile.
    type: str

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

ap_band_settings:
    description:
    - Settings that will be enabled if selectionType is set to 'ap'.
    suboptions:
      band_steering_enabled:
        description:
        - Steers client to most open band.
        type: bool
      mode:
        aliases:
        - band_operation_mode
        choices:
        - 2.4ghz
        - 5ghz
        - dual
        description:
        - Sets which RF band the AP will support.
        type: str
    type: dict

min_bitrate_type:
    choices:
    - band
    - ssid
    description:
    - Type of minimum bitrate.
    type: str

five_ghz_settings:
    description:
    - Settings related to 5Ghz band.
    suboptions:
      channel_width:
        choices:
        - auto
        - '20'
        - '40'
        - '80'
        description:
        - Sets channel width (MHz) for 5Ghz band.
        type: str
      max_power:
        description:
        - Sets max power (dBm) of 5Ghz band.
        - Can be integer between 8 and 30.
        type: int
      min_bitrate:
        choices:
        - 6
        - 9
        - 12
        - 18
        - 24
        - 36
        - 48
        - 54
        description:
        - Sets minimum bitrate (Mbps) of 5Ghz band.
        type: int
      min_power:
        description:
        - Sets minmimum power (dBm) of 5Ghz band.
        - Can be integer between 8 and 30.
        type: int
      rxsop:
        description:
        - The RX-SOP level controls the sensitivity of the radio.
        - It is strongly recommended to use RX-SOP only after consulting a wireless expert.
        - RX-SOP can be configured in the range of -65 to -95 (dBm).
        type: int
      valid_auto_channels:
        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 valid auto channels for 5Ghz band.
        elements: int
        type: list
    type: dict

band_selection_type:
    choices:
    - ssid
    - ap
    description:
    - Sets whether band selection is assigned per access point or SSID.
    - This param is required on creation.
    type: str

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

two_four_ghz_settings:
    description:
    - Settings related to 2.4Ghz band
    suboptions:
      ax_enabled:
        description:
        - Determines whether ax radio on 2.4Ghz band is on or off.
        type: bool
      max_power:
        description:
        - Sets max power (dBm) of 2.4Ghz band.
        - Can be integer between 5 and 30.
        type: int
      min_bitrate:
        choices:
        - 1
        - 2
        - 5.5
        - 6
        - 9
        - 11
        - 12
        - 18
        - 24
        - 36
        - 48
        - 54
        description:
        - Sets minimum bitrate (Mbps) of 2.4Ghz band.
        type: float
      min_power:
        description:
        - Sets minmimum power (dBm) of 2.4Ghz band.
        - Can be integer between 5 and 30.
        type: int
      rxsop:
        description:
        - The RX-SOP level controls the sensitivity of the radio.
        - It is strongly recommended to use RX-SOP only after consulting a wireless expert.
        - RX-SOP can be configured in the range of -65 to -95 (dBm).
        type: int
      valid_auto_channels:
        choices:
        - 1
        - 6
        - 11
        description:
        - Sets valid auto channels for 2.4Ghz band.
        elements: int
        type: list
    type: dict

client_balancing_enabled:
    description:
    - Steers client to best available access point.
    type: bool

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

Outputs

data:
  contains:
    ap_band_settings:
      contains:
        band_steering_enabled:
          description:
          - Steers client to most open band.
          returned: success
          sample: true
          type: bool
        mode:
          description:
          - Sets which RF band the AP will support.
          returned: success
          sample: dual
          type: str
      description:
      - Settings that will be enabled if selectionType is set to 'ap'.
      returned: success
      type: complex
    band_selection_type:
      description:
      - Sets whether band selection is assigned per access point or SSID.
      - This param is required on creation.
      returned: success
      sample: ap
      type: str
    client_balancing_enabled:
      description:
      - Steers client to best available access point.
      returned: success
      sample: true
      type: bool
    five_ghz_settings:
      contains:
        channel_width:
          description:
          - Sets channel width (MHz) for 5Ghz band.
          returned: success
          sample: auto
          type: str
        max_power:
          description:
          - Sets max power (dBm) of 5Ghz band.
          - Can be integer between 8 and 30.
          returned: success
          sample: 12
          type: int
        min_bitrate:
          description:
          - Sets minimum bitrate (Mbps) of 5Ghz band.
          returned: success
          sample: 6
          type: int
        min_power:
          description:
          - Sets minmimum power (dBm) of 5Ghz band.
          - Can be integer between 8 and 30.
          returned: success
          sample: 12
          type: int
        rxsop:
          description:
          - The RX-SOP level controls the sensitivity of the radio.
          returned: success
          sample: -70
          type: int
        valid_auto_channels:
          description:
          - Sets valid auto channels for 5Ghz band.
          returned: success
          type: list
      description:
      - Settings related to 5Ghz band.
      returned: success
      type: complex
    id:
      description:
      - Unique identifier of existing RF profile.
      returned: success
      sample: 12345
      type: str
    min_bitrate_type:
      description:
      - Type of minimum bitrate.
      returned: success
      sample: ssid
      type: str
    name:
      description:
      - The unique name of the new profile.
      - This param is required on creation.
      returned: success
      sample: Guest RF profile
      type: str
    two_four_ghz_settings:
      contains:
        ax_enabled:
          description:
          - Determines whether ax radio on 2.4Ghz band is on or off.
          returned: success
          sample: true
          type: bool
        max_power:
          description:
          - Sets max power (dBm) of 2.4Ghz band.
          returned: success
          sample: 12
          type: int
        min_bitrate:
          description:
          - Sets minimum bitrate (Mbps) of 2.4Ghz band.
          returned: success
          sample: 5.5
          type: float
        min_power:
          description:
          - Sets minmimum power (dBm) of 2.4Ghz band.
          returned: success
          sample: 12
          type: int
        rxsop:
          description:
          - The RX-SOP level controls the sensitivity of the radio.
          returned: success
          sample: -70
          type: int
        valid_auto_channels:
          description:
          - Sets valid auto channels for 2.4Ghz band.
          returned: success
          sample: 6
          type: list
      description:
      - Settings related to 2.4Ghz band
      returned: success
      type: complex
  description: List of wireless RF profile settings.
  returned: success
  type: complex