"""
Management of Zabbix Valuemap object over Zabbix API.
.. versionadded:: 2017.7.0
:codeauthor: Jakub Sliva <jakub.sliva@ultimum.io>
"""
import json
import logging
from salt.exceptions import SaltException
log = logging.getLogger(__name__)
[docs]
def __virtual__():
"""
Only make these states available if Zabbix module and run_query function is available
and all 3rd party modules imported.
"""
if "zabbix.run_query" in __salt__:
return True
return False, "Import zabbix or other needed modules failed."
[docs]
def present(name, params, **kwargs):
"""
Creates Zabbix Value map object or if differs update it according defined parameters
:param name: Zabbix Value map name
:param params: Definition of the Zabbix Value map
:param _connection_user: Optional - zabbix user (can also be set in opts or pillar, see module's docstring)
:param _connection_password: Optional - zabbix password (can also be set in opts or pillar, see module's docstring)
:param _connection_url: Optional - url of zabbix frontend (can also be set in opts, pillar, see module's docstring)
.. code-block:: yaml
zabbix-valuemap-present:
zabbix_valuemap.present:
- name: Number mapping
- params:
mappings:
- value: 1
newvalue: one
- value: 2
newvalue: two
"""
zabbix_id_mapper = __salt__["zabbix.get_zabbix_id_mapper"]()
dry_run = __opts__["test"]
ret = {"name": name, "result": False, "comment": "", "changes": {}}
# Create input params substituting functions with their results
params["name"] = name
input_params = __salt__["zabbix.substitute_params"](params, **kwargs)
log.info(
"Zabbix Value map: input params: %s",
str(json.dumps(input_params, indent=4)),
)
search = {"output": "extend", "selectMappings": "extend", "filter": {"name": name}}
# GET Value map object if exists
valuemap_get = __salt__["zabbix.run_query"]("valuemap.get", search, **kwargs)
log.info(
"Zabbix Value map: valuemap.get result: %s",
str(json.dumps(valuemap_get, indent=4)),
)
existing_obj = (
__salt__["zabbix.substitute_params"](valuemap_get[0], **kwargs)
if valuemap_get and len(valuemap_get) == 1
else False
)
if existing_obj:
diff_params = __salt__["zabbix.compare_params"](input_params, existing_obj)
log.info(
"Zabbix Value map: input params: {%s",
str(json.dumps(input_params, indent=4)),
)
log.info(
"Zabbix Value map: Object comparison result. Differences: %s",
str(diff_params),
)
if diff_params:
diff_params[zabbix_id_mapper["valuemap"]] = existing_obj[zabbix_id_mapper["valuemap"]]
log.info(
"Zabbix Value map: update params: %s",
str(json.dumps(diff_params, indent=4)),
)
if dry_run:
ret["result"] = True
ret["comment"] = f'Zabbix Value map "{name}" would be fixed.'
ret["changes"] = {
name: {
"old": (
f'Zabbix Value map "{name}" differs '
f"in following parameters: {diff_params}"
),
"new": f'Zabbix Value map "{name}" would correspond to definition.',
}
}
else:
valuemap_update = __salt__["zabbix.run_query"](
"valuemap.update", diff_params, **kwargs
)
log.info(
"Zabbix Value map: valuemap.update result: %s",
str(valuemap_update),
)
if valuemap_update:
ret["result"] = True
ret["comment"] = f'Zabbix Value map "{name}" updated.'
ret["changes"] = {
name: {
"old": (
f'Zabbix Value map "{name}" differed '
f"in following parameters: {diff_params}"
),
"new": f'Zabbix Value map "{name}" fixed.',
}
}
else:
ret["result"] = True
ret["comment"] = (
f'Zabbix Value map "{name}" already exists and corresponds to a definition.'
)
else:
if dry_run:
ret["result"] = True
ret["comment"] = f'Zabbix Value map "{name}" would be created.'
ret["changes"] = {
name: {
"old": f'Zabbix Value map "{name}" does not exist.',
"new": f'Zabbix Value map "{name}" would be created according definition.',
}
}
else:
# ACTION.CREATE
valuemap_create = __salt__["zabbix.run_query"](
"valuemap.create", input_params, **kwargs
)
log.info(
"Zabbix Value map: valuemap.create result: %s",
str(valuemap_create),
)
if valuemap_create:
ret["result"] = True
ret["comment"] = f'Zabbix Value map "{name}" created.'
ret["changes"] = {
name: {
"old": f'Zabbix Value map "{name}" did not exist.',
"new": (f'Zabbix Value map "{name}" created according definition.'),
}
}
return ret
[docs]
def absent(name, **kwargs):
"""
Makes the Zabbix Value map to be absent (either does not exist or delete it).
:param name: Zabbix Value map name
:param _connection_user: Optional - zabbix user (can also be set in opts or pillar, see module's docstring)
:param _connection_password: Optional - zabbix password (can also be set in opts or pillar, see module's docstring)
:param _connection_url: Optional - url of zabbix frontend (can also be set in opts, pillar, see module's docstring)
.. code-block:: yaml
zabbix-valuemap-absent:
zabbix_valuemap.absent:
- name: Value map name
"""
dry_run = __opts__["test"]
ret = {"name": name, "result": False, "comment": "", "changes": {}}
try:
object_id = __salt__["zabbix.get_object_id_by_params"](
"valuemap", {"filter": {"name": name}}, **kwargs
)
except SaltException:
object_id = False
if not object_id:
ret["result"] = True
ret["comment"] = f'Zabbix Value map "{name}" does not exist.'
else:
if dry_run:
ret["result"] = True
ret["comment"] = f'Zabbix Value map "{name}" would be deleted.'
ret["changes"] = {
name: {
"old": f'Zabbix Value map "{name}" exists.',
"new": f'Zabbix Value map "{name}" would be deleted.',
}
}
else:
valuemap_delete = __salt__["zabbix.run_query"]("valuemap.delete", [object_id], **kwargs)
if valuemap_delete:
ret["result"] = True
ret["comment"] = f'Zabbix Value map "{name}" deleted.'
ret["changes"] = {
name: {
"old": f'Zabbix Value map "{name}" existed.',
"new": f'Zabbix Value map "{name}" deleted.',
}
}
return ret