1#@!#!123s

: / proc / self / root / opt / saltstack / salt / lib / python3.10 / site-packages / salt / states /
Filename : zenoss.py
back
"""
State to manage monitoring in Zenoss.

.. versionadded:: 2016.3.0

This state module depends on the 'zenoss' Salt execution module.

Allows for setting a state of minions in Zenoss using the Zenoss API. Currently Zenoss 4.x and 5.x are supported.

.. code-block:: yaml

    enable_monitoring:
      zenoss.monitored:
        - name: web01.example.com
        - device_class: /Servers/Linux
        - collector: localhost
        - prod_state: 1000
"""


import logging

log = logging.getLogger(__name__)


def __virtual__():
    """
    Only load if the Zenoss execution module is available.
    """
    if "zenoss.add_device" in __salt__:
        return "zenoss"
    else:
        return False, "The zenoss execution module is not available"


def monitored(name, device_class=None, collector="localhost", prod_state=None):
    """
    Ensure a device is monitored. The 'name' given will be used for Zenoss device name and should be resolvable.

    .. code-block:: yaml

        enable_monitoring:
          zenoss.monitored:
            - name: web01.example.com
            - device_class: /Servers/Linux
            - collector: localhost
            - prod_state: 1000
    """

    ret = {}
    ret["name"] = name

    # If device is already monitored, return early
    device = __salt__["zenoss.find_device"](name)
    if device:
        ret["result"] = True
        ret["changes"] = None
        ret["comment"] = "{} is already monitored".format(name)

        # if prod_state is set, ensure it matches with the current state
        if prod_state is not None and device["productionState"] != prod_state:
            if __opts__["test"]:
                ret[
                    "comment"
                ] = "{} is already monitored but prodState will be updated".format(name)
                ret["result"] = None
            else:
                __salt__["zenoss.set_prod_state"](prod_state, name)
                ret[
                    "comment"
                ] = "{} is already monitored but prodState was updated".format(name)

            ret["changes"] = {
                "old": "prodState == {}".format(device["productionState"]),
                "new": "prodState == {}".format(prod_state),
            }
        return ret

    # Device not yet in Zenoss
    if __opts__["test"]:
        ret["comment"] = 'The state of "{}" will be changed.'.format(name)
        ret["changes"] = {"old": "monitored == False", "new": "monitored == True"}
        ret["result"] = None
        return ret

    # Add and check result
    if __salt__["zenoss.add_device"](name, device_class, collector, prod_state):
        ret["result"] = True
        ret["changes"] = {"old": "monitored == False", "new": "monitored == True"}
        ret["comment"] = "{} has been added to Zenoss".format(name)
    else:
        ret["result"] = False
        ret["changes"] = None
        ret["comment"] = "Unable to add {} to Zenoss".format(name)
    return ret