ansible-meraki module for Alert Settings #199

richardjohnallsopp · 2020-09-29T18:52:27Z

I would love an ansible-meraki module to configure the alert settings for a network using this endpoint .

kbreit · 2020-10-06T17:20:48Z

Follow up on this one. I've spent some time on this last night and lunch today. Unfortunately, getting idempotency is more challenging than I thought. I'm working through it but taking longer than I hoped.

kbreit · 2020-10-08T20:46:20Z

@richardjohnallsopp I just submitted a pull request (#204) for this. Can you give it a try and let me know what you think? Thanks.

richardjohnallsopp · 2020-10-09T10:55:49Z

Yup I’ll give it go bud :-) Richard Allsopp Epic Games Senior Infrastructure Engineer Mobile +447590263111

…

On 8 Oct 2020, at 21:46, Kevin Breit ***@***.***> wrote: @richardjohnallsopp I just submitted a pull request (#204) for this. Can you give it a try and let me know what you think? Thanks. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or unsubscribe.

richardjohnallsopp · 2020-10-09T11:03:03Z

What is the process for getting these and running them? If you could point me to some docs I'd appreciate it.

kbreit · 2020-10-09T13:16:19Z

@richardjohnallsopp There are a couple of ways to go about this. The most straight forward and simple way is to download https://raw.githubusercontent.com/kbreit/ansible-meraki/module/meraki_alert/plugins/modules/meraki_alert.py and save it locally. You should have a directory called ~/.ansible/collections/ansible_collections/cisco/meraki. Copy that file into ~/.ansible/collections/ansible_collections/cisco/meraki/plugins/modules and you should be able to call it like any other module.

richardjohnallsopp · 2020-10-09T13:25:53Z

Awesome, thanks man I'm off this weekend so will try all this out and report back.

richardjohnallsopp · 2020-10-11T17:24:02Z

I get the following from this module:

(tanglewoodgames_meraki) flynn@NCL-WL-16612:~/tanglewoodgames_meraki$ ./configure_mx_home.sh --tags "configure_alerts"

PLAY [localhost] *****************************************************************************

TASK [Gathering Facts] ***********************************************************************
ok: [127.0.0.1]

TASK [configure alert settings] **************************************************************
An exception occurred during task execution. To see the full traceback, use -vvv. The error was: AttributeError: 'MerakiModule' object has no attribute 'convert_snake_to_camel'
fatal: [127.0.0.1 -> localhost]: FAILED! => changed=false 
  module_stderr: |-
    Traceback (most recent call last):
      File "/home/flynn/.ansible/tmp/ansible-tmp-1602436989.3608868-3174-24665290994372/AnsiballZ_meraki_alert.py", line 102, in <module>
        _ansiballz_main()
      File "/home/flynn/.ansible/tmp/ansible-tmp-1602436989.3608868-3174-24665290994372/AnsiballZ_meraki_alert.py", line 94, in _ansiballz_main
        invoke_module(zipped_mod, temp_path, ANSIBALLZ_PARAMS)
      File "/home/flynn/.ansible/tmp/ansible-tmp-1602436989.3608868-3174-24665290994372/AnsiballZ_meraki_alert.py", line 40, in invoke_module
        runpy.run_module(mod_name='ansible_collections.cisco.meraki.plugins.modules.meraki_alert', init_globals=None, run_name='__main__', alter_sys=True)
      File "/usr/lib/python3.6/runpy.py", line 205, in run_module
        return _run_module_code(code, init_globals, run_name, mod_spec)
      File "/usr/lib/python3.6/runpy.py", line 96, in _run_module_code
        mod_name, mod_spec, pkg_name, script_name)
      File "/usr/lib/python3.6/runpy.py", line 85, in _run_code
        exec(code, run_globals)
      File "/tmp/ansible_meraki_alert_payload_x5wvf7o0/ansible_meraki_alert_payload.zip/ansible_collections/cisco/meraki/plugins/modules/meraki_alert.py", line 330, in <module>
      File "/tmp/ansible_meraki_alert_payload_x5wvf7o0/ansible_meraki_alert_payload.zip/ansible_collections/cisco/meraki/plugins/modules/meraki_alert.py", line 305, in main
      File "/tmp/ansible_meraki_alert_payload_x5wvf7o0/ansible_meraki_alert_payload.zip/ansible_collections/cisco/meraki/plugins/modules/meraki_alert.py", line 234, in construct_payload
    AttributeError: 'MerakiModule' object has no attribute 'convert_snake_to_camel'
  module_stdout: ''
  msg: |-
    MODULE FAILURE
    See stdout/stderr for the exact error
  rc: 1

richardjohnallsopp · 2020-10-11T17:24:18Z

Let me know if I'm doing something wrong?

kbreit · 2020-10-12T14:00:48Z

I forgot about a change to the module utility I had to do. Please download https://raw.githubusercontent.com/CiscoDevNet/ansible-meraki/2c0bc3ba5d16de222d5c8d7a032a3b9fb4ef4ec9/plugins/module_utils/network/meraki/meraki.py and put it in the plugins/module_utils/network/meraki directory. That should fix it.

richardjohnallsopp · 2020-10-12T14:20:15Z

Got it, will try and test today.

kbreit · 2020-10-14T14:10:56Z

@richardjohnallsopp Were you able to test this module?

richardjohnallsopp · 2020-10-16T17:27:25Z

This one completes now, but do you have a list of names for the alert types? Also I have all_admins set to false and it keeps adding it back in. It does add the emails I've listed, but using the gatewayDown example doesn't set an alert.

richardjohnallsopp · 2020-10-16T17:27:45Z

# configure alerts for network
    - name: configure alert settings
      meraki_alert:
        auth_key: "{{   auth_key  }}"
        org_name: "{{  org_name  }}"
        net_name: "{{  network_name  }}"
        state: present
        default_destinations:
          emails:
            "{{  email_list  }}"
          all_admins: false
          snmp: false
        alerts:
          - type: "gatewayDown"
            enabled: yes
            filters:
              timeout: 60
            alert_destinations:
              emails:
                "{{  email_list  }}"
              all_admins: false
              snmp: false
      delegate_to: localhost
      tags:
        - "configure_alerts"

richardjohnallsopp · 2020-10-16T17:37:01Z

I'm not sure how to translate these network alerts into alert type as I see no mention of gateway

kbreit · 2020-10-16T17:47:01Z

Hopefully I catch you while you're still working and able to test. Here is a list of alerts, which I'll add to the documentation and enforce. What type of network are you using? MX? If so, it's possible it changes the available alerts based on network type.

gatewayDown
gatewayToRepeater
repeaterDown
rogueAp
settingsChanged
vpnConnectivityChange
usageAlert
weeklyPresence

richardjohnallsopp · 2020-10-16T17:57:22Z

Yeah it's an MX network, but it's not setting the alert type (maybe due to the type name) and it's adding all admins regardless of the bool setting.

richardjohnallsopp · 2020-10-16T17:59:37Z

Yeah so that list you gave kinda makes sense on the MR network:

Do you know where to get the MX ones I listed above? It's annoying that API docs don't have a list of all alerts :-(

kbreit · 2020-10-16T18:02:03Z

I'm going to provide feedback to the API team to see if they can update documentation.

Regarding where to get it, I did a query (state: query) and it will list the full data structure for the entire network. There you'll manually pull the types.

richardjohnallsopp · 2020-10-16T18:07:53Z

That worked to get the alert types and it works great, but it's still adding the all admins despite being set to false:

kbreit · 2020-10-16T18:08:24Z

I'm looking into the all admins problem right now.

richardjohnallsopp · 2020-10-16T18:10:17Z

I'll post the alerts here for anyone else that might need them:

        type: ampMalwareDetected
        type: ampMalwareBlocked
        type: applianceDown
        type: failoverEvent
        type: dhcpNoLeases
        type: rogueDhcp
        type: ipConflict
        type: cellularUpDown
        type: clientConnectivity
        type: vrrp
        type: vpnConnectivityChange
        type: settingsChanged
        type: usageAlert

kbreit · 2020-10-16T18:11:24Z

Very helpful, thank you. I'm going to document these and probably enforce the values.

kbreit · 2020-10-16T18:17:20Z

@richardjohnallsopp I think I fixed the bug. It's pushed to the branch so please download the file and use the latest version. I've renamed type to alert_type as well.

richardjohnallsopp · 2020-10-16T18:24:02Z

It's working great:
data

# list of alert type
alert_list:
  - type: "ampMalwareDetected"
    state: "yes"
  - type: "ampMalwareBlocked"
    state: "yes"
  - type: "applianceDown"
    state: "yes"
  - type: "failoverEvent"
    state: "yes"
  - type: "dhcpNoLeases"
    state: "no"
  - type: "rogueDhcp"
    state: "no"
  - type: "ipConflict"
    state: "no"
  - type: "cellularUpDown"
    state: "no"
  - type: "clientConnectivity"
    state: "no"
  - type: "vrrp"
    state: "no"
  - type: "vpnConnectivityChange"
    state: "no"
  - type: "settingsChanged"
    state: "no"
  - type: "usageAlert"
    state: "no"

task

   # configure alerts for network
    - name: configure alert settings
      meraki_alert:
        auth_key: "{{   auth_key  }}"
        org_name: "{{  org_name  }}"
        net_name: "{{  network_name  }}"
        state: present
        default_destinations:
          emails:
            "{{  email_list  }}"
          all_admins: false
          snmp: false
        alerts:
          - type: "{{  item.type  }}"
            enabled: "{{  item.state  }}"
            filters:
              timeout: 60
            alert_destinations:
              emails:
                "{{  email_list  }}"
              all_admins: false
              snmp: false
      delegate_to: localhost
      with_items: "{{  alert_list  }}"
      tags:
        - "configure_alert"

output

richardjohnallsopp · 2020-10-16T18:40:29Z

Yup you fixed it, it all works perfectly, thanks so much for the hard work on this man!!

kbreit · 2020-10-16T19:17:58Z

@richardjohnallsopp 2.1.0 is released. Please redownload using ansible-galaxy.

kbreit self-assigned this Oct 4, 2020

kbreit added the new module Issue or pull request for a new module label Oct 4, 2020

kbreit mentioned this issue Oct 8, 2020

New module - meraki_alert #204

Merged

kbreit closed this as completed in #204 Oct 16, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ansible-meraki module for Alert Settings #199

ansible-meraki module for Alert Settings #199

richardjohnallsopp commented Sep 29, 2020

kbreit commented Oct 6, 2020

kbreit commented Oct 8, 2020

richardjohnallsopp commented Oct 9, 2020 via email

richardjohnallsopp commented Oct 9, 2020

kbreit commented Oct 9, 2020

richardjohnallsopp commented Oct 9, 2020

richardjohnallsopp commented Oct 11, 2020

richardjohnallsopp commented Oct 11, 2020

kbreit commented Oct 12, 2020

richardjohnallsopp commented Oct 12, 2020

kbreit commented Oct 14, 2020

richardjohnallsopp commented Oct 16, 2020

richardjohnallsopp commented Oct 16, 2020

richardjohnallsopp commented Oct 16, 2020 •

edited

Loading

kbreit commented Oct 16, 2020

richardjohnallsopp commented Oct 16, 2020

richardjohnallsopp commented Oct 16, 2020

kbreit commented Oct 16, 2020

richardjohnallsopp commented Oct 16, 2020

kbreit commented Oct 16, 2020

richardjohnallsopp commented Oct 16, 2020

kbreit commented Oct 16, 2020

kbreit commented Oct 16, 2020

richardjohnallsopp commented Oct 16, 2020

richardjohnallsopp commented Oct 16, 2020

kbreit commented Oct 16, 2020

ansible-meraki module for Alert Settings #199

ansible-meraki module for Alert Settings #199

Comments

richardjohnallsopp commented Sep 29, 2020

kbreit commented Oct 6, 2020

kbreit commented Oct 8, 2020

richardjohnallsopp commented Oct 9, 2020 via email

richardjohnallsopp commented Oct 9, 2020

kbreit commented Oct 9, 2020

richardjohnallsopp commented Oct 9, 2020

richardjohnallsopp commented Oct 11, 2020

richardjohnallsopp commented Oct 11, 2020

kbreit commented Oct 12, 2020

richardjohnallsopp commented Oct 12, 2020

kbreit commented Oct 14, 2020

richardjohnallsopp commented Oct 16, 2020

richardjohnallsopp commented Oct 16, 2020

richardjohnallsopp commented Oct 16, 2020 • edited Loading

kbreit commented Oct 16, 2020

richardjohnallsopp commented Oct 16, 2020

richardjohnallsopp commented Oct 16, 2020

kbreit commented Oct 16, 2020

richardjohnallsopp commented Oct 16, 2020

kbreit commented Oct 16, 2020

richardjohnallsopp commented Oct 16, 2020

kbreit commented Oct 16, 2020

kbreit commented Oct 16, 2020

richardjohnallsopp commented Oct 16, 2020

richardjohnallsopp commented Oct 16, 2020

kbreit commented Oct 16, 2020

richardjohnallsopp commented Oct 16, 2020 •

edited

Loading