Current File : //usr/lib/python2.7/site-packages/salt/modules/zabbix.pyo
�
���^c
@@ s� d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l m Z d d l
m Z d d l Z
d d l Z
d d l Z
d d l Z
d d l m Z d d l m Z m Z e j e � Z d d d
d g Z d� Z i) d d 6d d 6d d 6d d 6d d! 6d" d# 6d$ d 6d% d& 6d' d( 6d) d* 6d' d+ 6d, d- 6d. d 6d/ d 6d0 d1 6d. d2 6d3 d4 6d5 d6 6d, d7 6d, d8 6d9 d 6d, d: 6d; d 6d< d= 6d> d? 6d@ d 6dA d 6dB d 6dC dD 6dE d 6dF d
6dB dG 6dC dH 6d, dI 6dJ dK 6dJ dL 6dM dN 6dO d 6dP dQ 6dR d 6dS dT 6Z dU Z dV � Z dW � Z d dX � Z! dY � Z" e# dZ � Z$ d[ � Z% d d\ d] � Z& e# d^ � Z' d d_ � Z( d` � Z) da � Z* db � Z+ dc � Z, d d dd � Z- de � Z. d df � Z/ dg � Z0 dh � Z1 di � Z2 dj � Z3 dk � Z4 d d d dl � Z5 d d d dm � Z6 dn � Z7 do � Z8 dp � Z9 dq � Z: d d d d d dr � Z; d d d ds � Z< dt � Z= du � Z> dv � Z? dw � Z@ dx � ZA dy � ZB d d d d dz � ZC d d d d{ � ZD d d| � ZE d} � ZF d~ � ZG d d� d� d� d d� � ZH d� � ZI d� � ZJ d d d d d e# d� � ZK d� � ZL d� � ZM d� � ZN d� � ZO d� � ZP d� � ZQ d d d� � ZR d� � ZS d� � ZT e# e# d� � ZU d d d d� � ZV d� � ZW d d� d� � ZX d S(� u�
Support for Zabbix
:optdepends: - zabbix server
:configuration: This module is not usable until the zabbix user and zabbix password are specified either in a pillar
or in the minion's config file. Zabbix url should be also specified.
.. code-block:: yaml
zabbix.user: Admin
zabbix.password: mypassword
zabbix.url: http://127.0.0.1/zabbix/api_jsonrpc.php
Connection arguments from the minion config file can be overridden on the CLI by using arguments with
``_connection_`` prefix.
.. code-block:: bash
zabbix.apiinfo_version _connection_user=Admin _connection_password=zabbix _connection_url=http://host/zabbix/
:codeauthor: Jiri Kotlin <jiri.kotlin@ultimum.io>
i ( t absolute_importt print_functiont unicode_literalsN( t six( t
SaltException( t LooseVersion( t HTTPErrort URLErroriB' i� io i90 u hostgroupu templateu hostu maintenanceu actionu druleu serviceu proxyu screenu usergroupu mediatypeu scriptu valuemapu actionidu alertidu alertu
applicationidu applicationu dhostidu dhostu
dserviceidu dserviceu dcheckidu dchecku druleidu eventidu eventu graphidu graphu gitemidu graphitemu graphprototypeu itemidu historyu hostidu groupidu interfaceidu
hostinterfaceu
hostprototypeu iconmapidu iconmapu imageidu imageu itemu
itemprototypeu serviceidu
discoveryruleu
maintenanceidu sysmapidu mapu mediaidu usermediau mediatypeidu proxyidu screenidu screenitemidu
screenitemu scriptidu
templateidu templatescreenu templatescreenitemu trendu triggeridu triggeru triggerprototypeu useridu useru usrgrpidu
globalmacroidu usermacrou
valuemapidu
httptestidu httptestu zabbixc C@ s t S( uE
Only load the module if all modules are imported correctly.
( t __virtualname__( ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt __virtual__e s c C@ s� t j � } d | d } ye y# t j j j | � } | d } Wn" t k
rd } t j | � } n X| j d � rx | St
� Wn t t
f k
r� t SXd S( uT
Tries to guess the url of zabbix frontend.
.. versionadded:: 2016.3.0
u http://u /zabbix/api_jsonrpc.phpu erroru 412: Precondition FailedN(
t sockett gethostnamet saltt utilst httpt queryR R t text_typet findt KeyErrort
ValueErrort False( t hostnamet frontend_urlt responset errort http_e( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt
_frontend_urll s
c
C@ s� d d g } i d d 6} i d d 6d d 6| d 6| d
6} | | k rT | | d <n t j j j | � } t j d t j | � t j | � � y� t j j j | d
d d | d | d d d t
d t
d t
�} t j d t j | � � d | k rt d j | d | d � � � n | j
d i � } d | k rat d j | d d | d d � � � n | SWnR t k
r�} t d j | � � � n+ t j k
r�} t d j | � � � n Xd S(! u�
JSON request to Zabbix API.
.. versionadded:: 2016.3.0
:param method: actual operation to perform via the API
:param params: parameters required for specific method
:param url: url of zabbix api
:param auth: auth token for zabbix api (only for methods with required authentication)
:return: Response from API with desired data in JSON format. In case of error returns more specific description.
.. versionchanged:: 2017.7
u
user.loginu apiinfo.versionu application/jsonu Content-typeu 2.0u jsonrpci u idu methodu paramsu authu _QUERY input:
url: %s
data: %st methodu POSTt datat header_dictt decode_typeu jsont decodet statust headersu _QUERY result: %su erroru Zabbix API: Status: {0} ({1})u statusu dictu Zabbix API: {} ({})u messageu datau2 URL or HTTP headers are probably not correct! ({})u Check hostname in URL! ({})N( R R
t jsont dumpst logt infoR R R R t TrueR t formatt getR R
R (
R t paramst urlt autht unauthenticated_methodsR R t resultt rett err( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt _query� s6
"
% # +c @ s( t � � d � � f d � } | d d � | d d � | d d � d � k ra t � � d <n y� � d r� � d r� � d r� i � d d 6� d d 6} d } t | | � d � } | d } | � d
<� j d d � � j d d � � St � Wn( t k
r#} t d j | � � � n Xd S(
u%
Log in to the API and generate the authentication token.
.. versionadded:: 2016.3.0
: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)
:return: On success connargs dictionary with auth token and frontend url, False on failure.
c @ s� | d k r | } n | � k r2 � | � | <nv d } | j | � rs y | t | � } Wqs t k
ro d SXn t d d j | � d � } | d k r� | � | <n d S( up
Add key to connargs, only if name exists in our kwargs or, as zabbix.<name> in __opts__ or __pillar__
Evaluate in said order - kwargs, opts, then pillar. To avoid collision with other functions,
kwargs-based connection arguments are prefixed with 'connection_' (i.e. '_connection_user', etc.).
Inspired by mysql salt module.
u _connection_Nu
config.optionu
zabbix.{0}( t Nonet
startswitht lent
IndexErrort __salt__R' ( t namet keyt prefixt val( t connargst kwargs( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt _connarg� s
u _connection_useru useru _connection_passwordu passwordu _connection_urlu urlu
user.loginu resultu authu! URL is probably not correct! ({})N( t dictR1 R R0 t popR R R' ( R; R< R) R R. R+ R/ ( ( R: R; s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt _login� s(
c K@ s� x4 | D], } | j d � s | j | | | � q q W| r� | j d d � d | k ro | j d � | d <q� d | k r� | j d � | d <q� n | S( uG
Extends the params dictionary by values from keyword arguments.
.. versionadded:: 2016.3.0
:param params: Dictionary with parameters for zabbix API.
:param _ignore_name: Salt State module is passing first line as 'name' parameter. If API uses optional parameter
'name' (for ex. host_create, user_create method), please use 'visible_name' or 'firstname' instead of 'name' to
not mess these values.
: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)
:return: Extended params dictionary with parameters.
u _u nameu firstnameu visible_nameN( R2 t
setdefaultR> R1 ( R) t _ignore_nameR; R7 ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt _params_extend� s
c C@ s t S( u�
.. versionadded:: 2017.7
Make ZABBIX_ID_MAPPER constant available to state modules.
:return: ZABBIX_ID_MAPPER
( t ZABBIX_ID_MAPPER( ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt get_zabbix_id_mapper s u namec @ s" � d k r i � n t | t � rJ g | D] } t | � � � � ^ q+ St | t � rd | k r� i } | d t k r� | j � � n y7 | j i i | d � 6d 6� t | d | � � SWqt k
r� t d j
| � � � qXq � � � f d � | j � D� Sn
t j
| � Sd S( up
.. versionadded:: 2017.7
Go through Zabbix object params specification and if needed get given object ID from Zabbix API and put it back
as a value. Definition of the object is done via dict with keys "query_object" and "query_name".
:param input_object: Zabbix object type specified in state file
:param extend_params: Specify query with params
:param filter_key: Custom filtering key (default: 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)
:return: Params structure with values converted to string for further comparison purposes
u query_objectu
query_nameu filteru> Qyerying object ID requested but object name not provided: {0}c @ s. i | ]$ \ } } t | � � � � | � q S( ( t substitute_params( t .0R7 R9 ( t
extend_paramst
filter_keyR; ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pys
<dictcomp>? s N( R1 t
isinstancet listRE R= t ZABBIX_TOP_LEVEL_OBJECTSt updatet get_object_id_by_paramsR R R' t itemsR R ( t input_objectRG RH R; t oitemt query_params( ( RG RH R; s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyRE s$ &
c C@ sm t | t | � � sB t d j t | � t | � | | � � � n t j j j | � s� t j | � t j | � k r� | r� i t j | � d 6t j | � d 6St j | � t j | � k r� | r� t j | � Sn t | t
� r�t | � t | � k r$t j
d � | r i | d 6| d 6S| Sg } xz | D]r } g } xG | D]? } t | | | � } | rv| j | d � qD| j | � qDWt | � r1| j | � q1q1Wt | � r�| r�i | d 6| d 6St | � r�| r�| Sn t | t � riy4t | � t | � k r t | � t | � @} | r?i i d 6i d 6n i } x� | D]� }
t | |
| |
| � } | r�| s�| rt | t
� r| d j i | |
|
6� | d j i | |
|
6� qqL| s�| rLt | t
� rL| j i | |
|
6� qLqLW| S| r#i | d 6| d 6S| SWqit k
ret d j t | � t | � | | � � � qiXn d S( u
.. versionadded:: 2017.7
Compares Zabbix object definition against existing Zabbix object.
:param defined: Zabbix object definition taken from sls file.
:param existing: Existing Zabbix object taken from result of an API call.
:param return_old_value: Default False. If True, returns dict("old"=old_val, "new"=new_val) for rollback purpose.
:return: Params that are different from existing object. Result extended by
object ID can be passed directly to Zabbix API update method.
u{ Zabbix object comparison failed (data type mismatch). Expecting {0}, got {1}. Existing value: "{2}", defined value: "{3}").u newu oldu Different list length!N( RI t typeR R' R R
R t is_iterR R RJ R3 R$ R% t compare_paramst appendt allt anyR= t setRL t TypeError( t definedt existingt return_old_valuet difflistt ditemt d_in_et eitemt compt intersectiont diffdictt i( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyRT G sd
$$%
"
c K@ s | d k r i } n t | d | | � } | r\ t | � d k r\ t j | d t | � St d j | d | | � � � d S( u>
.. versionadded:: 2017.7
Get ID of single Zabbix object specified by its name.
:param obj: Zabbix object type
:param params: Parameters by which object is uniquely identified
: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)
:return: object ID
u .geti i u� Zabbix API: Object does not exist or bad Zabbix user permissions or other unexpected result. Called method {0} with params {1}. Result: {2}N( R1 t run_queryR3 R R RC R R' ( t objR) t connection_argst res( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyRM � s c K@ sl t | � } t } yA | rL d } i } t | | | d | d � } | d St � Wn t k
rg t SXd S( uQ
Retrieve the version of the Zabbix API.
.. versionadded:: 2016.3.0
: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)
:return: On success string with Zabbix API version, False on failure.
CLI Example:
.. code-block:: bash
salt '*' zabbix.apiinfo_version
u apiinfo.versionu urlu authu resultN( R? R R0 R ( Rg t conn_argsR. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt apiinfo_version� s
c K@ s� t | � } t } y� | r� d } i | d 6| d 6g d 6} t | t � sW | g } n x& | D] } | d j i | d 6� q^ Wt | d t | �} t | | | d | d � } | d d
St � Wn t k
r� | SXd S( uh
.. versionadded:: 2016.3.0
Create new zabbix user
.. note::
This function accepts all standard user properties: keyword argument
names differ depending on your zabbix version, see here__.
.. __: https://www.zabbix.com/documentation/2.0/manual/appendix/api/user/definitions#user
:param alias: user alias
:param passwd: user's password
:param usrgrps: user groups to add the user to
:param _connection_user: zabbix user (can also be set in opts or pillar, see module's docstring)
:param _connection_password: zabbix password (can also be set in opts or pillar, see module's docstring)
:param _connection_url: url of zabbix frontend (can also be set in opts or pillar, see module's docstring)
:param firstname: string with firstname of the user, use 'firstname' instead of 'name' parameter to not mess
with value supplied from Salt sls file.
:return: On success string with id of the created user.
CLI Example:
.. code-block:: bash
salt '*' zabbix.user_create james password007 '[7, 12]' firstname='James Bond'
u user.createu aliasu passwdu usrgrpsu usrgrpidRA u urlu authu resultu useridsN( R? R RI RJ RU RB R& R0 R ( t aliast passwdt usrgrpsRg Ri R. R R) t usrgrp( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt user_create� s
c K@ s� t | � } t } y` | rk d } t | t � s< | g } n | } t | | | d | d � } | d d St � Wn t k
r� | SXd S( ue
Delete zabbix users.
.. versionadded:: 2016.3.0
:param users: array of users (userids) to delete
: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)
:return: On success array with userids of deleted users.
CLI Example:
.. code-block:: bash
salt '*' zabbix.user_delete 15
u user.deleteu urlu authu resultu useridsN( R? R RI RJ R0 R ( t usersRg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt user_delete s
c K@ s� t | � } t } yl | rw d } i d d 6i | d 6d 6} t | | | d | d � } t | d � d k rs t St St � Wn t k
r� | SXd
S( uT
Checks if user with given alias exists.
.. versionadded:: 2016.3.0
:param alias: user alias
: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)
:return: True if user exists, else False.
CLI Example:
.. code-block:: bash
salt '*' zabbix.user_exists james
u user.getu extendu outputu aliasu filteru urlu authu resulti N( R? R R0 R3 R& R ( Rk Rg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt user_exists$ s
c K@ s� t | � } t } y� | r� d } i d d 6i d 6} | rU | rU i t d 6d d 6S| rr | d j d | � n | r� | j d | � n t | | � } t | | | d
| d � } t | d � d k r� | d St St � Wn t k
r� | SXd
S( u�
Retrieve users according to the given parameters.
.. versionadded:: 2016.3.0
:param alias: user alias
:param userids: return only users with the given IDs
: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)
:return: Array with details of convenient users, False on failure of if no user found.
CLI Example:
.. code-block:: bash
salt '*' zabbix.user_get james
u user.getu extendu outputu filteru resultu; Please submit alias or userids parameter to retrieve users.u commentu aliasu useridsu urlu authi N( R? R R@ RB R0 R3 R ( Rk t useridsRg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt user_getD s$ "
c K@ s� t | � } t } ya | rl d } i | d 6} t | d t | �} t | | | d | d � } | d d St � Wn t k
r� | SXd S( um
.. versionadded:: 2016.3.0
Update existing users
.. note::
This function accepts all standard user properties: keyword argument
names differ depending on your zabbix version, see here__.
.. __: https://www.zabbix.com/documentation/2.0/manual/appendix/api/user/definitions#user
:param userid: id of the user to update
: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)
:return: Id of the updated user on success.
CLI Example:
.. code-block:: bash
salt '*' zabbix.user_update 16 visible_name='James Brown'
u user.updateu useridRA u urlu authu resultu useridsN( R? R RB R& R0 R ( t useridRg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt user_updatel s
c K@ s� t | � } t } yf | rq d } | r7 i | d 6} n i } t | | � } t | | | d | d � } | d St � Wn t k
r� | SXd S( u�
.. versionadded:: 2016.3.0
Retrieve media according to the given parameters
.. note::
This function accepts all standard usermedia.get properties: keyword
argument names differ depending on your zabbix version, see here__.
.. __: https://www.zabbix.com/documentation/3.2/manual/api/reference/usermedia/get
:param userids: return only media that are used by the given users
: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)
:return: List of retrieved media, False on failure.
CLI Example:
.. code-block:: bash
salt '*' zabbix.user_getmedia
u
usermedia.getu useridsu urlu authu resultN( R? R RB R0 R ( Rs Rg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt
user_getmedia� s
c K@ s� t | � } t } y� | r� d } i g d 6}
t | t � sI | g } n x& | D] } |
d j i | d 6� qP Wi | d 6| d 6| d 6| d 6| d 6g |
d <t | |
| d
| d � } | d d
St � Wn t k
r� | SXd S( u#
Add new media to multiple users.
.. versionadded:: 2016.3.0
:param userids: ID of the user that uses the media
:param active: Whether the media is enabled (0 enabled, 1 disabled)
:param mediatypeid: ID of the media type used by the media
:param period: Time when the notifications can be sent as a time period
:param sendto: Address, user name or other identifier of the recipient
:param severity: Trigger severities to send notifications about
: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)
:return: IDs of the created media.
CLI Example:
.. code-block:: bash
salt '*' zabbix.user_addmedia 4 active=0 mediatypeid=1 period='1-7,00:00-24:00' sendto='support2@example.com'
severity=63
u
user.addmediau usersu useridu activeu mediatypeidu periodu sendtou severityu mediasu urlu authu resultu mediaidsN( R? R RI RJ RU R0 R ( Rs t activet mediatypeidt periodt sendtot severityRg Ri R. R R) t user( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt
user_addmedia� s"
c K@ s� t | � } t } y` | rk d } t | t � s< | g } n | } t | | | d | d � } | d d St � Wn t k
r� | SXd S( u`
Delete media by id.
.. versionadded:: 2016.3.0
:param mediaids: IDs of the media to delete
: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)
:return: IDs of the deleted media, False on failure.
CLI Example:
.. code-block:: bash
salt '*' zabbix.user_deletemedia 27
u user.deletemediau urlu authu resultu mediaidsN( R? R RI RJ R0 R ( t mediaidsRg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt user_deletemedia� s
c K@ ss t | � } t } yH | rS d } i d d 6} t | | | d | d � } | d St � Wn t k
rn | SXd S( u%
Retrieve all of the configured users.
.. versionadded:: 2016.3.0
: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)
:return: Array with user details.
CLI Example:
.. code-block:: bash
salt '*' zabbix.user_list
u user.getu extendu outputu urlu authu resultN( R? R R0 R ( Rg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt user_list s
c K@ s� t | � } t } y[ | rf d } i | d 6} t | | � } t | | | d | d � } | d d St � Wn t k
r� | SXd S( ui
.. versionadded:: 2016.3.0
Create new user group
.. note::
This function accepts all standard user group properties: keyword
argument names differ depending on your zabbix version, see here__.
.. __: https://www.zabbix.com/documentation/2.0/manual/appendix/api/usergroup/definitions#user_group
:param name: name of the user group
: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)
:return: IDs of the created user groups.
CLI Example:
.. code-block:: bash
salt '*' zabbix.usergroup_create GroupName
u usergroup.createu nameu urlu authu resultu usrgrpidsN( R? R RB R0 R ( R6 Rg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt usergroup_create0 s
c K@ s� t | � } t } y` | rk d } t | t � s< | g } n | } t | | | d | d � } | d d St � Wn t k
r� | SXd S( uF
.. versionadded:: 2016.3.0
:param usergroupids: IDs of the user groups to delete
: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)
:return: IDs of the deleted user groups.
CLI Example:
.. code-block:: bash
salt '*' zabbix.usergroup_delete 28
u usergroup.deleteu urlu authu resultu usrgrpidsN( R? R RI RJ R0 R ( t usergroupidsRg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt usergroup_deleteW s
c K@ s9 t | � } t | � } t } y| rt | � t d � k rj | sN d } n t | d
| � } t | � Sd } i } | r� | r� | r� i t d 6d d 6S| r� | | d <n t | � t d � k r� | r� | | d <n | r� | | d
<q� n t | | | d | d � } | d Sn t � Wn t k
r4| SXd
S( u{
Checks if at least one user group that matches the given filter criteria exists
.. versionadded:: 2016.3.0
:param name: names of the user groups
:param node: name of the node the user groups must belong to (This will override the nodeids parameter.)
:param nodeids: IDs of the nodes the user groups must belong to
: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)
:return: True if at least one user group that matches the given filter criteria exists, else False.
CLI Example:
.. code-block:: bash
salt '*' zabbix.usergroup_exists Guests
u 2.5u u usergroup.existsu resultuY Please submit name, node or nodeids parameter to check if at least one user group exists.u commentu nameu 2.4u nodeu nodeidsu urlu authN( R? Rj R t
_LooseVersiont
usergroup_getR1 t boolR0 R ( R6 t nodet nodeidsRg Ri t zabbix_versionR. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt usergroup_existsx s4
c K@ sM t | � } t | � } t } y| r-d } t | � t d � k rc i d d 6d d 6i d 6} n i d d 6i d 6} | r� | r� | r� t S| r� | d j d | � n | r� | j d | � n | r� | j d | � n t | | � } t | | | d
| d � } t | d � d
k r%t S| d St � Wn t k
rH| SXd S( u.
.. versionadded:: 2016.3.0
Retrieve user groups according to the given parameters
.. note::
This function accepts all usergroup_get properties: keyword argument
names differ depending on your zabbix version, see here__.
.. __: https://www.zabbix.com/documentation/2.4/manual/api/reference/usergroup/get
:param name: names of the user groups
:param usrgrpids: return only user groups with the given IDs
:param userids: return only user groups that contain the given users
: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)
:return: Array with convenient user groups details, False if no user group found or on failure.
CLI Example:
.. code-block:: bash
salt '*' zabbix.usergroup_get Guests
u
usergroup.getu 2.5u extendu selectRightsu outputu filteru nameu usrgrpidsu useridsu urlu authu resulti N( R? Rj R R� R@ RB R0 R3 R ( R6 t usrgrpidsRs Rg Ri R� R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyR� � s. "
c K@ s� t | � } t } y[ | rf d } i | d 6} t | | � } t | | | d | d � } | d d St � Wn t k
r� | SXd S( u�
.. versionadded:: 2016.3.0
Update existing user group
.. note::
This function accepts all standard user group properties: keyword
argument names differ depending on your zabbix version, see here__.
.. __: https://www.zabbix.com/documentation/2.4/manual/api/reference/usergroup/object#user_group
:param usrgrpid: ID of the user group to update.
: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)
:return: IDs of the updated user group, False on failure.
CLI Example:
.. code-block:: bash
salt '*' zabbix.usergroup_update 8 name=guestsRenamed
u usergroup.updateu usrgrpidu urlu authu resultu usrgrpidsN( R? R RB R0 R ( t usrgrpidRg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt usergroup_update� s
c K@ ss t | � } t } yH | rS d } i d d 6} t | | | d | d � } | d St � Wn t k
rn | SXd S( uG
Retrieve all enabled user groups.
.. versionadded:: 2016.3.0
: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)
:return: Array with enabled user groups details, False on failure.
CLI Example:
.. code-block:: bash
salt '*' zabbix.usergroup_list
u
usergroup.getu extendu outputu urlu authu resultN( R? R R0 R ( Rg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt usergroup_list
s
c
K@ s t | � } t } y� | r� d } i | d 6} t | t � sI | g } n g } x" | D] } | j i | d 6� qV W| | d <t | t � s� | g } n | | d <t | d t | �} t | | | d | d � } | d d
St � Wn t k
r� | SXd S( u/
.. versionadded:: 2016.3.0
Create new host
.. note::
This function accepts all standard host properties: keyword argument
names differ depending on your zabbix version, see here__.
.. __: https://www.zabbix.com/documentation/2.4/manual/api/reference/host/object#host
:param host: technical name of the host
:param groups: groupids of host groups to add the host to
:param interfaces: interfaces to be created for the host
: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)
:param visible_name: string with visible name of the host, use
'visible_name' instead of 'name' parameter to not mess with value
supplied from Salt sls file.
return: ID of the created host.
CLI Example:
.. code-block:: bash
salt '*' zabbix.host_create technicalname 4
interfaces='{type: 1, main: 1, useip: 1, ip: "192.168.3.1", dns: "", port: 10050}'
visible_name='Host Visible Name' inventory_mode=0 inventory='{"alias": "something"}'
u host.createu hostu groupidu groupsu
interfacesRA u urlu authu resultu hostidsN( R? R RI RJ RU RB R& R0 R (
t hostt groupst
interfacesRg Ri R. R R) t grpst group( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt host_create, s*
c K@ s� t | � } t } y` | rk d } t | t � s< | g } n | } t | | | d | d � } | d d St � Wn t k
r� | SXd S( uE
Delete hosts.
.. versionadded:: 2016.3.0
:param hostids: Hosts (hostids) to delete.
: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)
:return: IDs of the deleted hosts.
CLI Example:
.. code-block:: bash
salt '*' zabbix.host_delete 10106
u host.deleteu urlu authu resultu hostidsN( R? R RI RJ R0 R ( t hostidsRg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt host_deletef s
c
K@ s� t | � } t | � } t } yW| rnt | � t d � k r� | sN d } n | s] d } n | sl d } n t | | | | � } t | � Sd } i }
| r� | |
d <n | r� | |
d <n | r� | |
d <n t | � t d � k r| r� | |
d <n | r| |
d <qn | rF| rF| rF| rF| rFi t d 6d
d 6St | |
| d | d
� } | d Sn t � Wn t k
r�| SXd S( u�
Checks if at least one host that matches the given filter criteria exists.
.. versionadded:: 2016.3.0
:param host: technical name of the host
:param hostids: Hosts (hostids) to delete.
:param name: visible name of the host
:param node: name of the node the hosts must belong to (zabbix API < 2.4)
:param nodeids: IDs of the node the hosts must belong to (zabbix API < 2.4)
: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)
:return: IDs of the deleted hosts, False on failure.
CLI Example:
.. code-block:: bash
salt '*' zabbix.host_exists 'Zabbix server'
u 2.5u host.existsu hostidu hostu nameu 2.4u nodeu nodeidsu resultu� Please submit hostid, host, name, node or nodeids parameter tocheck if at least one host that matches the given filter criteria exists.u commentu urlu authN( R? Rj R R� R1 t host_getR� R0 R ( R� t hostidR6 R� R� Rg Ri R� R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt host_exists� sD
#
c K@ s t | � } t } y� | r� d } i d d 6i d 6} | rN | rN | rN t S| rk | d j d | � n | r� | j d | � n | r� | d j d | � n t | | � } t | | | d | d � } t | d
� d k r� | d
St St � Wn t k
r
| SXd S(
u�
.. versionadded:: 2016.3.0
Retrieve hosts according to the given parameters
.. note::
This function accepts all optional host.get parameters: keyword
argument names differ depending on your zabbix version, see here__.
.. __: https://www.zabbix.com/documentation/2.4/manual/api/reference/host/get
:param host: technical name of the host
:param name: visible name of the host
:param hostids: ids of the hosts
: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)
:return: Array with convenient hosts details, False if no host found or on failure.
CLI Example:
.. code-block:: bash
salt '*' zabbix.host_get 'Zabbix server'
u host.getu extendu outputu filteru nameu hostidsu hostu urlu authu resulti N( R? R R@ RB R0 R3 R ( R� R6 R� Rg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyR� � s( "
c K@ s� t | � } t } ya | rl d } i | d 6} t | d t | �} t | | | d | d � } | d d St � Wn t k
r� | SXd S( u�
.. versionadded:: 2016.3.0
Update existing hosts
.. note::
This function accepts all standard host and host.update properties:
keyword argument names differ depending on your zabbix version, see the
documentation for `host objects`_ and the documentation for `updating
hosts`_.
.. _`host objects`: https://www.zabbix.com/documentation/2.4/manual/api/reference/host/object#host
.. _`updating hosts`: https://www.zabbix.com/documentation/2.4/manual/api/reference/host/update
:param hostid: ID of the host to update
: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)
:param visible_name: string with visible name of the host, use
'visible_name' instead of 'name' parameter to not mess with value
supplied from Salt sls file.
:return: ID of the updated host.
CLI Example:
.. code-block:: bash
salt '*' zabbix.host_update 10084 name='Zabbix server2'
u host.updateu hostidRA u urlu authu resultu hostidsN( R? R RB R& R0 R ( R� Rg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt host_update� s
c K@ s� t | � } t } y� | r� d } i d d 6} | rG | j d | � n t | | � } t | | | d | d � } t | d d d � d k r� | d d d St St � Wn t k
r� | SXd
S( u<
Retrieve host inventory according to the given parameters.
See: https://www.zabbix.com/documentation/2.4/manual/api/reference/host/object#host_inventory
.. versionadded:: 2019.2.0
:param hostids: Return only host interfaces used by the given hosts.
: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)
:return: Array with host interfaces details, False if no convenient host interfaces found or on failure.
CLI Example:
.. code-block:: bash
salt '*' zabbix.host_inventory_get 101054
u host.getu extendu selectInventoryu hostidsu urlu authu resulti u inventoryN( R? R R@ RB R0 R3 R ( R� Rg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt host_inventory_get) s
2
c K@ s- t | � } t } y| r
i } t } d } | j d � rE t } n | j d d � t t | | � � } x | D] } | j | d � qq W| r� | j d | � n | r� d | d <t | | | d | d � } n d | d <| | d <t | | | d | d � } | d
St
� Wn t
k
r(| SXd S( u�
Update host inventory items
NOTE: This function accepts all standard host: keyword argument names for inventory
see: https://www.zabbix.com/documentation/2.4/manual/api/reference/host/object#host_inventory
.. versionadded:: 2019.2.0
:param hostid: ID of the host to update
:param clear_old: Set to True in order to remove all existing inventory items before setting the specified items
: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)
:return: ID of the updated host, False on failure.
CLI Example:
.. code-block:: bash
salt '*' zabbix.host_inventory_set 101054 asset_tag=jml3322 type=vm clear_old=True
u host.updateu clear_oldu hostidu -1u inventory_modeu urlu authu 0u inventoryu resultN( R? R R( R& R> R1 R= RB R@ R0 R ( R� Rg Ri R. R) t clear_oldR t inventory_paramsR7 ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt host_inventory_setM s2
c K@ ss t | � } t } yH | rS d } i d d 6} t | | | d | d � } | d St � Wn t k
rn | SXd S( u,
Retrieve all hosts.
.. versionadded:: 2016.3.0
: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)
:return: Array with details about hosts, False on failure.
CLI Example:
.. code-block:: bash
salt '*' zabbix.host_list
u host.getu extendu outputu urlu authu resultN( R? R R0 R ( Rg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt host_list� s
c K@ s� t | � } t } y[ | rf d } i | d 6} t | | � } t | | | d | d � } | d d St � Wn t k
r� | SXd S( ua
.. versionadded:: 2016.3.0
Create a host group
.. note::
This function accepts all standard host group properties: keyword
argument names differ depending on your zabbix version, see here__.
.. __: https://www.zabbix.com/documentation/2.4/manual/api/reference/hostgroup/object#host_group
:param name: name of the host group
: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)
:return: ID of the created host group.
CLI Example:
.. code-block:: bash
salt '*' zabbix.hostgroup_create MyNewGroup
u hostgroup.createu nameu urlu authu resultu groupidsN( R? R RB R0 R ( R6 Rg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt hostgroup_create� s
c K@ s� t | � } t } y` | rk d } t | t � s< | g } n | } t | | | d | d � } | d d St � Wn t k
r� | SXd S( ur
Delete the host group.
.. versionadded:: 2016.3.0
:param hostgroupids: IDs of the host groups to delete
: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)
:return: ID of the deleted host groups, False on failure.
CLI Example:
.. code-block:: bash
salt '*' zabbix.hostgroup_delete 23
u hostgroup.deleteu urlu authu resultu groupidsN( R? R RI RJ R0 R ( t hostgroupidsRg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt hostgroup_delete� s
c
K@ sb t | � } t | � } t } y+| rBt | � t d � k ry | sN d
} n | s] d
} n t | | | � } t | � Si } d } | r� | | d <n | r� | | d <n t | � t d � k r� | r� | | d <n | r� | | d <q� n | r| r| r| ri t d 6d d
6St | | | d | d � } | d Sn t � Wn t k
r]| SXd
S( u�
Checks if at least one host group that matches the given filter criteria exists.
.. versionadded:: 2016.3.0
:param name: names of the host groups
:param groupid: host group IDs
:param node: name of the node the host groups must belong to (zabbix API < 2.4)
:param nodeids: IDs of the nodes the host groups must belong to (zabbix API < 2.4)
: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)
:return: True if at least one host group exists, False if not or on failure.
CLI Example:
.. code-block:: bash
salt '*' zabbix.hostgroup_exists MyNewGroup
u 2.5u hostgroup.existsu groupidu nameu 2.4u nodeu nodeidsu resultu� Please submit groupid, name, node or nodeids parameter tocheck if at least one host group that matches the given filter criteria exists.u commentu urlu authN( R? Rj R R� R1 t
hostgroup_getR� R0 R (
R6 t groupidR� R� Rg Ri R� R. R) R ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt hostgroup_exists� s<
c K@ s
t | � } t } y� | r� d } i d d 6} | rG | rG | rG t S| rm i | d 6} | j d | � n | r� | j d | � n | r� | j d | � n t | | � } t | | | d | d � } t | d
� d k r� | d
St St � Wn t k
r| SXd S(
u�
.. versionadded:: 2016.3.0
Retrieve host groups according to the given parameters
.. note::
This function accepts all standard hostgroup.get properities: keyword
argument names differ depending on your zabbix version, see here__.
.. __: https://www.zabbix.com/documentation/2.2/manual/api/reference/hostgroup/get
:param name: names of the host groups
:param groupid: host group IDs
:param node: name of the node the host groups must belong to
:param nodeids: IDs of the nodes the host groups must belong to
:param hostids: return only host groups that contain the given hosts
: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)
:return: Array with host groups details, False if no convenient host group found or on failure.
CLI Example:
.. code-block:: bash
salt '*' zabbix.hostgroup_get MyNewGroup
u
hostgroup.getu extendu outputu nameu filteru groupidsu hostidsu urlu authu resulti N( R? R R@ RB R0 R3 R ( R6 t groupidsR� Rg Ri R. R R) t name_dict( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyR� ) s*
"
c K@ s� t | � } t } yn | ry d } i | d 6} | rA | | d <n t | | � } t | | | d | d � } | d d St � Wn t k
r� | SXd S( u�
.. versionadded:: 2016.3.0
Update existing hosts group
.. note::
This function accepts all standard host group properties: keyword
argument names differ depending on your zabbix version, see here__.
.. __: https://www.zabbix.com/documentation/2.4/manual/api/reference/hostgroup/object#host_group
:param groupid: ID of the host group to update
:param name: name of the host group
: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)
:return: IDs of updated host groups.
CLI Example:
.. code-block:: bash
salt '*' zabbix.hostgroup_update 24 name='Renamed Name'
u hostgroup.updateu groupidu nameu urlu authu resultu groupidsN( R? R RB R0 R ( R� R6 Rg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt hostgroup_update^ s
c K@ ss t | � } t } yH | rS d } i d d 6} t | | | d | d � } | d St � Wn t k
rn | SXd S( u=
Retrieve all host groups.
.. versionadded:: 2016.3.0
: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)
:return: Array with details about host groups, False on failure.
CLI Example:
.. code-block:: bash
salt '*' zabbix.hostgroup_list
u
hostgroup.getu extendu outputu urlu authu resultN( R? R R0 R ( Rg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt hostgroup_list� s
c K@ s� t | � } t } y� | r� d } i d d 6} | rG | j d | � n t | | � } t | | | d | d � } t | d � d k r� | d St St � Wn t k
r� | SXd S(
u�
.. versionadded:: 2016.3.0
Retrieve host groups according to the given parameters
.. note::
This function accepts all standard hostinterface.get properities:
keyword argument names differ depending on your zabbix version, see
here__.
.. __: https://www.zabbix.com/documentation/2.4/manual/api/reference/hostinterface/get
:param hostids: Return only host interfaces used by the given hosts.
: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)
:return: Array with host interfaces details, False if no convenient host interfaces found or on failure.
CLI Example:
.. code-block:: bash
salt '*' zabbix.hostinterface_get 101054
u hostinterface.getu extendu outputu hostidsu urlu authu resulti N( R? R R@ RB R0 R3 R ( R� Rg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt hostinterface_get� s
"
u i c K@ s� t | � } t } | s% t | } n y� | r� d }
i | d 6| d 6| d 6| d 6| d 6| d 6| d 6} t | | � } t |
| | d | d
� } | d d St � Wn t k
r� | SXd
S( u�
.. versionadded:: 2016.3.0
Create new host interface
.. note::
This function accepts all standard host group interface: keyword
argument names differ depending on your zabbix version, see here__.
.. __: https://www.zabbix.com/documentation/3.0/manual/api/reference/hostinterface/object
:param hostid: ID of the host the interface belongs to
:param ip_: IP address used by the interface
:param dns: DNS name used by the interface
:param main: whether the interface is used as default on the host (0 - not default, 1 - default)
:param port: port number used by the interface
:param type: Interface type (1 - agent; 2 - SNMP; 3 - IPMI; 4 - JMX)
:param useip: Whether the connection should be made via IP (0 - connect
using host DNS name; 1 - connect using host IP address for this host
interface)
: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)
:return: ID of the created host interface, False on failure.
CLI Example:
.. code-block:: bash
salt '*' zabbix.hostinterface_create 10105 192.193.194.197
u hostinterface.createu hostidu ipu dnsu mainu portu typeu useipu urlu authu resultu interfaceidsN( R? R t INTERFACE_DEFAULT_PORTSRB R0 R ( R� t ip_t dnst maint if_typet useipt portRg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt hostinterface_create� s( ,
c K@ s� t | � } t } y` | rk d } t | t � r9 | } n | g } t | | | d | d � } | d d St � Wn t k
r� | SXd S( uy
Delete host interface
.. versionadded:: 2016.3.0
:param interfaceids: IDs of the host interfaces to delete
: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)
:return: ID of deleted host interfaces, False on failure.
CLI Example:
.. code-block:: bash
salt '*' zabbix.hostinterface_delete 50
u hostinterface.deleteu urlu authu resultu interfaceidsN( R? R RI RJ R0 R ( t interfaceidsRg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt hostinterface_delete s
c K@ s� t | � } t } y[ | rf d } i | d 6} t | | � } t | | | d | d � } | d d St � Wn t k
r� | SXd S( u�
.. versionadded:: 2016.3.0
Update host interface
.. note::
This function accepts all standard hostinterface: keyword argument
names differ depending on your zabbix version, see here__.
.. __: https://www.zabbix.com/documentation/2.4/manual/api/reference/hostinterface/object#host_interface
:param interfaceid: ID of the hostinterface to update
: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)
:return: ID of the updated host interface, False on failure.
CLI Example:
.. code-block:: bash
salt '*' zabbix.hostinterface_update 6 ip_=0.0.0.2
u hostinterface.updateu interfaceidu urlu authu resultu interfaceidsN( R? R RB R0 R ( t interfaceidRg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt hostinterface_update< s
c K@ s� t | � } t } y~| r�d } i d d 6i d 6}
| r� t | t � rn d t j | j � d � d } n | j d � r� | j d � r� d | d } n |
d j d | � n | r� |
j d | � n | r� |
j d
| � n | r|
j d | � n | r t
} |
j d | � n | r;t |
d
t
�}
n t |
| � }
t | |
| d | d � } t
| d � d k r�| d St St � Wn t k
r�| SXd S( u
Retrieve user macros according to the given parameters.
Args:
macro: name of the usermacro
hostids: Return macros for the given hostids
templateids: Return macros for the given templateids
hostmacroids: Return macros with the given hostmacroids
globalmacroids: Return macros with the given globalmacroids (implies globalmacro=True)
globalmacro: if True, returns only global macros
optional connection_args:
_connection_user: zabbix user (can also be set in opts or pillar, see module's docstring)
_connection_password: zabbix password (can also be set in opts or pillar, see module's docstring)
_connection_url: url of zabbix frontend (can also be set in opts or pillar, see module's docstring)
Returns:
Array with usermacro details, False if no usermacro found or on failure.
CLI Example:
.. code-block:: bash
salt '*' zabbix.usermacro_get macro='{$SNMP_COMMUNITY}'
u
usermacro.getu extendu outputu filteru {i u }u macrou hostidsu templateidsu hostmacroidsu globalmacroidst globalmacrou urlu authu resultN( R? R RI R= R R t keysR2 t endswithR@ R& RB R0 R3 R ( t macroR� t templateidst hostmacroidst globalmacroidsR� Rg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt
usermacro_getf s: $ "
c K@ s t | � } t } y� | r� i } d } | r� t | t � r` d t j | j � d � d } n | j d � r� | j d � r� d | d } n | | d <n | | d <| | d <t | d t
| �} t | | | d | d
� } | d d d St � Wn t k
r| SXd
S( u�
Create new host usermacro.
:param macro: name of the host usermacro
:param value: value of the host usermacro
:param hostid: hostid or templateid
: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)
return: ID of the created host usermacro.
CLI Example:
.. code-block:: bash
salt '*' zabbix.usermacro_create '{$SNMP_COMMUNITY}' 'public' 1
u usermacro.createu {i u }u macrou valueu hostidRA u urlu authu resultu hostmacroidsN(
R? R RI R= R R R� R2 R� RB R& R0 R ( R� t valueR� Rg Ri R. R) R ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt usermacro_create� s( $
c K@ s
t | � } t } y� | r� i } d } | r� t | t � r` d t j | j � d � d } n | j d � r� | j d � r� d | d } n | | d <n | | d <t | d t
| �} t | | | d | d � } | d
d d St � Wn t k
r| SXd S(
u�
Create new global usermacro.
:param macro: name of the global usermacro
:param value: value of the global usermacro
: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)
return: ID of the created global usermacro.
CLI Example:
.. code-block:: bash
salt '*' zabbix.usermacro_createglobal '{$SNMP_COMMUNITY}' 'public'
u usermacro.createglobalu {i u }u macrou valueRA u urlu authu resultu globalmacroidsN(
R? R RI R= R R R� R2 R� RB R& R0 R ( R� R� Rg Ri R. R) R ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt usermacro_createglobal� s& $
c K@ s� t | � } t } y` | rk d } t | t � r9 | } n | g } t | | | d | d � } | d d St � Wn t k
r� | SXd S( uA
Delete host usermacros.
:param macroids: macroids of the host usermacros
: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)
return: IDs of the deleted host usermacro.
CLI Example:
.. code-block:: bash
salt '*' zabbix.usermacro_delete 21
u usermacro.deleteu urlu authu resultu hostmacroidsN( R? R RI RJ R0 R ( t macroidsRg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt usermacro_delete� s
c K@ s� t | � } t } y` | rk d } t | t � r9 | } n | g } t | | | d | d � } | d d St � Wn t k
r� | SXd S( uM
Delete global usermacros.
:param macroids: macroids of the global usermacros
: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)
return: IDs of the deleted global usermacro.
CLI Example:
.. code-block:: bash
salt '*' zabbix.usermacro_deleteglobal 21
u usermacro.deleteglobalu urlu authu resultu globalmacroidsN( R? R RI RJ R0 R ( R� Rg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt usermacro_deleteglobal s
c K@ s� t | � } t } yr | r} i } d } | | d <| | d <t | d t | �} t | | | d | d � } | d d d St � Wn t k
r� | SXd
S( u|
Update existing host usermacro.
:param hostmacroid: id of the host usermacro
:param value: new value of the host usermacro
: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)
return: ID of the update host usermacro.
CLI Example:
.. code-block:: bash
salt '*' zabbix.usermacro_update 1 'public'
u usermacro.updateu hostmacroidu valueRA u urlu authu resultu hostmacroidsi N( R? R RB R& R0 R ( t hostmacroidR� Rg Ri R. R) R ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt usermacro_update< s
c K@ s� t | � } t } yr | r} i } d } | | d <| | d <t | d t | �} t | | | d | d � } | d d d St � Wn t k
r� | SXd
S( u�
Update existing global usermacro.
:param globalmacroid: id of the host usermacro
:param value: new value of the host usermacro
: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)
return: ID of the update global usermacro.
CLI Example:
.. code-block:: bash
salt '*' zabbix.usermacro_updateglobal 1 'public'
u usermacro.updateglobalu
globalmacroidu valueRA u urlu authu resultu globalmacroidsi N( R? R RB R& R0 R ( t
globalmacroidR� Rg Ri R. R) R ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt usermacro_updateglobal_ s
c K@ s� t | � } t } y� | r� d } i d d 6i d 6} | rR | d j d | � n | rk | j d | � n t | | � } t | | | d | d � } t | d � d
k r� | d St St � Wn t k
r� | SXd S( u�
Retrieve mediatypes according to the given parameters.
Args:
name: Name or description of the mediatype
mediatypeids: ids of the mediatypes
optional connection_args:
_connection_user: zabbix user (can also be set in opts or pillar, see module's docstring)
_connection_password: zabbix password (can also be set in opts or pillar, see module's docstring)
_connection_url: url of zabbix frontend (can also be set in opts or pillar, see module's docstring)
all optional mediatype.get parameters: keyword argument names depends on your zabbix version, see:
https://www.zabbix.com/documentation/2.2/manual/api/reference/mediatype/get
Returns:
Array with mediatype details, False if no mediatype found or on failure.
CLI Example:
.. code-block:: bash
salt '*' zabbix.mediatype_get name='Email'
salt '*' zabbix.mediatype_get mediatypeids="['1', '2', '3']"
u
mediatype.getu extendu outputu filteru descriptionu mediatypeidsu urlu authu resulti N( R? R R@ RB R0 R3 R ( R6 t mediatypeidsRg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt
mediatype_get� s "
c K@ s� t | � } t } yk | rv d } i | d 6} | | d <t | d t | �} t | | | d | d � } | d d St � Wn t k
r� | SXd S(
uR
Create new mediatype
.. note::
This function accepts all standard mediatype properties: keyword
argument names differ depending on your zabbix version, see here__.
.. __: https://www.zabbix.com/documentation/3.0/manual/api/reference/mediatype/object
:param mediatype: media type - 0: email, 1: script, 2: sms, 3: Jabber, 100: Ez Texting
:param exec_path: exec path - Required for script and Ez Texting types, see Zabbix API docs
:param gsm_modem: exec path - Required for sms type, see Zabbix API docs
:param smtp_email: email address from which notifications will be sent, required for email type
:param smtp_helo: SMTP HELO, required for email type
:param smtp_server: SMTP server, required for email type
:param status: whether the media type is enabled - 0: enabled, 1: disabled
:param username: authentication user, required for Jabber and Ez Texting types
:param passwd: authentication password, required for Jabber and Ez Texting types
: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)
return: ID of the created mediatype.
CLI Example:
.. code-block:: bash
salt '*' zabbix.mediatype_create 'Email' 0 smtp_email='noreply@example.com'
smtp_server='mailserver.example.com' smtp_helo='zabbix.example.com'
u mediatype.createu descriptionu typeRA u urlu authu resultu mediatypeidN( R? R RB R& R0 R ( R6 t mediatypeRg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt mediatype_create� s
c K@ s� t | � } t } y` | rk d } t | t � r9 | } n | g } t | | | d | d � } | d d St � Wn t k
r� | SXd S( uE
Delete mediatype
:param interfaceids: IDs of the mediatypes to delete
: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)
:return: ID of deleted mediatype, False on failure.
CLI Example:
.. code-block:: bash
salt '*' zabbix.mediatype_delete 3
u mediatype.deleteu urlu authu resultu mediatypeidsN( R? R RI RJ R0 R ( R� Rg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt mediatype_delete� s
c K@ s� t | � } t } y� | r� d } i | d 6} | rA | | d <n | rT | | d <n t | | � } t | | | d | d � } | d d St � Wn t k
r� | SXd S(
ug
Update existing mediatype
.. note::
This function accepts all standard mediatype properties: keyword
argument names differ depending on your zabbix version, see here__.
.. __: https://www.zabbix.com/documentation/3.0/manual/api/reference/mediatype/object
:param mediatypeid: ID of the mediatype to update
: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)
:return: IDs of the updated mediatypes, False on failure.
CLI Example:
.. code-block:: bash
salt '*' zabbix.usergroup_update 8 name="Email update"
u mediatype.updateu mediatypeidu descriptionu typeu urlu authu resultu mediatypeidsN( R? R RB R0 R ( Ry R6 R� Rg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt mediatype_update s
c K@ s� t | � } t } y� | r� d } i d d 6i d 6} | rR | d j d | � n | ro | d j d | � n | r� | j d | � n t | | � } t | | | d | d � } t | d
� d k r� | d
St St � Wn t k
r� | SXd S(
u"
Retrieve templates according to the given parameters.
Args:
host: technical name of the template
name: visible name of the template
hostids: ids of the templates
optional connection_args:
_connection_user: zabbix user (can also be set in opts or pillar, see module's docstring)
_connection_password: zabbix password (can also be set in opts or pillar, see module's docstring)
_connection_url: url of zabbix frontend (can also be set in opts or pillar, see module's docstring)
all optional template.get parameters: keyword argument names depends on your zabbix version, see:
https://www.zabbix.com/documentation/2.4/manual/api/reference/template/get
Returns:
Array with convenient template details, False if no template found or on failure.
CLI Example:
.. code-block:: bash
salt '*' zabbix.template_get name='Template OS Linux'
salt '*' zabbix.template_get templateids="['10050', '10001']"
u template.getu extendu outputu filteru nameu hostu templateidsu urlu authu resulti N( R? R R@ RB R0 R3 R ( R6 R� R� Rg Ri R. R R) ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt template_get* s$ "
c K@ s� t | � } t } y� | r� | } | } t | | � } t | | | d | d � } t | d t � rn | d St | d � d k r� | d St St � Wn t k
r� | SXd S( u�
Send Zabbix API call
Args:
method: actual operation to perform via the API
params: parameters required for specific method
optional connection_args:
_connection_user: zabbix user (can also be set in opts or pillar, see module's docstring)
_connection_password: zabbix password (can also be set in opts or pillar, see module's docstring)
_connection_url: url of zabbix frontend (can also be set in opts or pillar, see module's docstring)
all optional template.get parameters: keyword argument names depends on your zabbix version, see:
https://www.zabbix.com/documentation/2.4/manual/api/reference/
Returns:
Response from Zabbix API
CLI Example:
.. code-block:: bash
salt '*' zabbix.run_query proxy.create '{"host": "zabbixproxy.domain.com", "status": "5"}'
u urlu authu resulti N( R? R RB R0 RI R� R3 R ( R R) Rg Ri R. ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyRe Z s "
u xmlc
K@ sB | d k r i } n i i t d 6t d 6t d 6d 6i t d 6t d 6t d 6d 6i t d 6t d 6t d 6d 6i t d 6d 6i t d 6t d 6d 6i t d 6t d 6d 6i t d 6t d 6t d 6d
6i t d 6t d 6d 6i t d 6t d 6d 6i t d 6d
6i t d 6t d 6d 6i t d 6t d 6t d 6d 6i t d 6t d 6t d 6d 6i t d 6t d 6d 6} t | � } | r�xC | D]8 } | | k r�| | j | | � qv| | | | <qvWn d | k r!t j j j � } t d | | � } | st
j j | � d k rRi | d 6t d 6d d 6Sn1 | } t
j j
| � sRi | d 6t d 6d d 6St j j j | d d �� } | j � }
Wd QXd | k r�t j j j | � n i | d 6| d 6|
d 6} t j d t j | d � � y- t d! | | � i | d 6t d 6d" d 6SWn2 t k
r=} i | d 6t d 6t j | � d 6SXd S(# u�
.. versionadded:: 2017.7
Imports Zabbix configuration specified in file to Zabbix server.
:param config_file: File with Zabbix config (local or remote)
:param rules: Optional - Rules that have to be different from default (defaults are the same as in Zabbix web UI.)
:param file_format: Config file format (default: xml)
: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)
CLI Example:
.. code-block:: bash
salt '*' zabbix.configuration_import salt://zabbix/config/zabbix_templates.xml "{'screens': {'createMissing': True, 'updateExisting': True}}"
u
createMissingu updateExistingu
deleteMissingu applicationsu discoveryRulesu graphsu groupsu hostsu imagesu itemsu mapsu screensu templateLinkageu templatesu templateScreensu triggersu valueMapsu salt://u cp.get_filei u nameu resultu Failed to fetch config file.u messageu Invalid file path.t modeu rNu formatu rulesu sourceu CONFIGURATION IMPORT: rules: %su configuration.importu= Zabbix API "configuration.import" method called successfully.( R1 R& R R= RL R R
t filest mkstempR5 t ost patht getsizet isfilet fopent readt safe_rmR$ R% R R Re R (
t config_filet rulest file_formatRg t
default_rulest new_rulest rulet tmpfilet cfilet fp_t xmlR) t exc( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt configuration_import� sV
(
u hostgroupu templateu hostu maintenanceu actionu druleu serviceu proxyu screenu usergroupu mediatypeu scriptu valuemap(Y t __doc__t
__future__R R R t loggingR
R� t salt.extR t salt.exceptionsR t salt.utils.dataR t salt.utils.filest salt.utils.httpt salt.utils.jsont salt.utils.versionsR R� t salt.ext.six.moves.urllib.errorR R t getLoggert __name__R$ R� RK RC R R R R1 R0 R? R RB RD RE RT RM Rj Ro Rq Rr Rt Rv Rw R~ R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� Re R� ( ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/zabbix.pyt <module> s�
2 ? ! ( N 3 $ ( ' + 0 # ' !77 ' : #A2 - $ 7 ' #<5 * -E # * ; + ) # # # #- 0 ")0 *
Mini Shell