o

�N�gy�@s�
dZzd
dl
Z
dZWney


dZYn
wdZdd�Zdd	�Zd
d�ZdMd
d�
ZdMdd�
Z	dMdd�
Z
dMdd�
ZdMdd�
ZdMdd�
Z
dMdd�
ZdMdd�
ZdMdd�
ZdMdd �
ZdMd!d"�
ZdMd#d$�
ZdMd%d&�
ZdNd'd(�
ZdNd)d*�
ZdNd+d,�
ZdNd-d.�
ZdNd/d0�
ZdNd1d2�
ZdNd3d4�
ZdNd5d6�
ZdMd7d8�
ZdMd9d:�
ZdMd;d<�
ZdNd=d>�
Z dNd?d@�
Z!dNdAdB�
Z"dNdCdD�
Z#dNdEdF�
Z$dNdGdH�
Z%dNdIdJ�
Z&dNdKdL�
Z'dS)Oa�

Module for working with the Grafana v4 API

.. versionadded:: 2017.7.0

:depends: requests

:configuration: This module requires a configuration profile to be configured
    in the minion config, minion pillar, or master config.
    The module will use the 'grafana' key by default, if defined.

    For example:

    .. code-block:: yaml

        grafana:
            grafana_url: http://grafana.localhost
            grafana_user: admin
            grafana_password: admin
            grafana_timeout: 3
�NTFZgrafana4cCstrt
Sd
d�t
�
fS)z,
    Only load if requests is installed
    FzAThe "{}" module could not be loaded: "requests" is not installed.)�HAS_LIBS�__virtualname__�format�rr�I/opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/grafana4.py�__virtual__"s


��rc
Cs*d
di
}
|�dd�rd�
|d�
|
d<|
S)NzContent-typezapplication/json�
grafana_tokenFz	Bearer {}Z
Authorization)�getr)�profile�headersrrr�_get_headers1s



rc

Cs&|�d
d�rdSt
j�|d|d�S)NrFZgrafana_userZgrafana_password)r	�requests�authZ
HTTPBasicAuth)
r
rrr�	_get_auth8s




�r�grafanac
C�\t|t
�rtd
|�
}tjd�|d�
t|�
t|�
|�dd�d�}
|
jdkr*|
�	�
|
�
�S)z�
    List all users.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.get_users
    �
config.optionz{}/api/users�grafana_url�grafana_timeout��rr�timeout�
��
isinstance�str�__salt__r
r	rrr�status_code�raise_for_status�json�r
�responserrr�	get_users@�







�


r"cCs*t|
�
}|D]}|d
|kr|
SqdS)a


    Show a single user.

    login
        Login of the user.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.get_user <login>
    �loginN)
r")r$r
�data�userrrr�get_user[s


�r'cC�^t|
t
�rtd
|
�
}
tjd�|
d|�t|
�
t|
�
|
�dd�d�}|jdkr+|�	�
|�
�S)a


    Get user data.

    userid
        Id of the user.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.get_user_data <user_id>
    r�{}/api/users/{}rrrrrr��useridr
r!rrr�
get_user_datas�







�


r,c
	K�^t|t
�rtd
|�
}tjd�|d�
|
t|�
t|�
|�dd�d�}|j	dkr+|�
�
|��S)a�

    Create a new user.

    login
        Login of the new user.

    password
        Password of the new user.

    email
        Email of the new user.

    name
        Optional - Full name of the new user.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.create_user login=<login> password=<password> email=<email>
    rz{}/api/admin/usersrrr�rrrrr�rrrr
�postrrrr	rrr�r
�kwargsr!rrr�create_user�s








�


r4c	K�`t|
t
�rtd
|
�
}
tjd�|
d|�|t|
�
t|
�
|
�dd�d�}|j	dkr,|�
�
|��S)a�

    Update an existing user.

    userid
        Id of the user.

    login
        Optional - Login of the user.

    email
        Optional - Email of the user.

    name
        Optional - Full name of the user.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.update_user <user_id> login=<login> email=<email>
    rr)rrrr/r�rrrr
�putrrrr	rrr�r+r
r3r!rrr�update_user�s








�


r9c	Kr5)aa

    Update a user password.

    userid
        Id of the user.

    password
        New password of the user.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.update_user_password <user_id> password=<password>
    rz{}/api/admin/users/{}/passwordrrrr/rr6r8rrr�update_user_password��








�


r:c	Kr5)ay

    Update a user password.

    userid
        Id of the user.

    isGrafanaAdmin
        Whether user is a Grafana admin.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.update_user_permissions <user_id> isGrafanaAdmin=<true|false>
    rz!{}/api/admin/users/{}/permissionsrrrr/rr6r8rrr�update_user_permissions
r;r<cC�^t|
t
�rtd
|
�
}
tjd�|
d|�t|
�
t|
�
|
�dd�d�}|j	dkr+|�
�
|��S)a

    Delete a user.

    userid
        Id of the user.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.delete_user <user_id>
    rz{}/api/admin/users/{}rrrrr�rrrr
�deleterrrr	rrrr*rrr�delete_user%
r-r@cCr()a.

    Get the list of organisations a user belong to.

    userid
        Id of the user.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.get_user_orgs <user_id>
    rz{}/api/users/{}/orgsrrrrrrr*rrr�
get_user_orgsC
r-rAcCs`t|t
�rtd
|�
}tjd�|d|
|�t|�
t|�
|�dd�d�}|j	dkr,|�
�
|��S)aX

    Remove a user from an organization.

    userid
        Id of the user.

    orgid
        Id of the organization.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.delete_user_org <user_id> <org_id>
    rz{}/api/orgs/{}/users/{}rrrrrr>)r+�orgidr
r!rrr�delete_user_orga
s







�


rCc
Cr)z�
    List all organizations.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.get_orgs
    r�{}/api/orgsrrrrrrr rrr�get_orgs�
r#rEcCr()a

    Show a single organization.

    name
        Name of the organization.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.get_org <name>
    rz{}/api/orgs/name/{}rrrrrr)�namer
r!rrr�get_org�
r-rGcCsht|
t
�rtd
|
�
}
t||
�}tjd�|
d|d�t|
�
t|
�
|
�	dd�d�}|j
dkr2|��
|S)	a.

    Switch the current organization.

    name
        Name of the organization to switch to.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.switch_org <name>
    rz{}/api/user/using/{}r�idrrrr)rrrrGr
r1rrrr	rr)�orgnamer
Zorgr!rrr�
switch_org�
s









�


rJcC�jt|
t
�rtd
|
�
}
|rt||
�
tjd�|
d�
t|
�
t|
�
|
�dd�d�}|j	dkr1|�
�
|��S)a@

    Get the list of users that belong to the organization.

    orgname
        Name of the organization.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.get_org_users <orgname>
    r�{}/api/org/usersrrrrr�rrrrJr
r	rrrrrr�rIr
r!rrr�
get_org_users�
�










�


rOc	K�lt|
t
�rtd
|
�
}
|rt||
�
tjd�|
d�
|t|
�
t|
�
|
�	dd�d�}|j
dkr2|��
|��S)aI
    Add user to the organization.

    loginOrEmail
        Login or email of the user.

    role
        Role of the user for this organization. Should be one of:
            - Admin
            - Editor
            - Read Only Editor
            - Viewer

    orgname
        Name of the organization in which users are added.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.create_org_user <orgname> loginOrEmail=<loginOrEmail> role=<role>
    rrLrrrr/r�
rrrrJr
r1rrrr	rrr�rIr
r3r!rrr�create_org_user�
s











�


rTc	Ksnt|t
�rtd
|�
}|
rt|
|�
tjd�|d|�|t|�
t|�
|�	dd�d�}|j
dkr3|��
|��S)a�
    Update user role in the organization.

    userid
        Id of the user.

    loginOrEmail
        Login or email of the user.

    role
        Role of the user for this organization. Should be one of:
            - Admin
            - Editor
            - Read Only Editor
            - Viewer

    orgname
        Name of the organization in which users are updated.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.update_org_user <user_id> <orgname> loginOrEmail=<loginOrEmail> role=<role>
    r�{}/api/org/users/{}rrrr/r)
rrrrJr
Zpatchrrrr	rrr)r+rIr
r3r!rrr�update_org_user%s











�


rVcC�lt|t
�rtd
|�
}|
rt|
|�
tjd�|d|�t|�
t|�
|�	dd�d�}|j
dkr2|��
|��S)aw

    Remove user from the organization.

    userid
        Id of the user.

    orgname
        Name of the organization in which users are updated.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.delete_org_user <user_id> <orgname>
    rrUrrrrr�
rrrrJr
r?rrrr	rrr)r+rIr
r!rrr�delete_org_userS�










�


rYcCrK)aD

    Get the organization address.

    orgname
        Name of the organization in which users are updated.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.get_org_address <orgname>
    r�{}/api/org/addressrrrrrrMrNrrr�get_org_addressvrPr\c	KrQ)a�
    Update the organization address.

    orgname
        Name of the organization in which users are updated.

    address1
        Optional - address1 of the org.

    address2
        Optional - address2 of the org.

    city
        Optional - city of the org.

    zip_code
        Optional - zip_code of the org.

    state
        Optional - state of the org.

    country
        Optional - country of the org.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.update_org_address <orgname> country=<country>
    rr[rrrr/r�
rrrrJr
r7rrrr	rrrrSrrr�update_org_address�s
#










�


r^cCrK)aF

    Get the organization preferences.

    orgname
        Name of the organization in which users are updated.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.get_org_prefs <orgname>
    r�{}/api/org/preferencesrrrrrrMrNrrr�
get_org_prefs�rPr`c	KrQ)a$
    Update the organization preferences.

    orgname
        Name of the organization in which users are updated.

    theme
        Selected theme for the org.

    homeDashboardId
        Home dashboard for the org.

    timezone
        Timezone for the org (one of: "browser", "utc", or "").

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.update_org_prefs <orgname> theme=<theme> timezone=<timezone>
    rr_rrrr/rr]rSrrr�update_org_prefs�s











�


rac
	Kr.)a

    Create a new organization.

    name
        Name of the organization.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.create_org <name>
    rrDrrrr/rr0r2rrr�
create_orgs








�


rbc	Kr5)a^

    Update an existing organization.

    orgid
        Id of the organization.

    name
        New name of the organization.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.update_org <org_id> name=<name>
    r�{}/api/orgs/{}rrrr/rr6)rBr
r3r!rrr�
update_org2r;rdcCr=)a

    Delete an organization.

    orgid
        Id of the organization.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.delete_org <org_id>
    rrcrrrrrr>)rBr
r!rrr�
delete_orgTr-recCrK)a4

    List all datasources in an organisation.

    orgname
        Name of the organization.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.get_datasources <orgname>
    r�{}/api/datasourcesrrrrrrMrNrrr�get_datasourcesrrPrgcCs.t|
|d
�}|D]}|d|kr|
SqdS)ah

    Show a single datasource in an organisation.

    name
        Name of the datasource.

    orgname
        Name of the organization.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.get_datasource <name> <orgname>
    )rIr
rFN)
rg)rFrIr
r%Z
datasourcerrr�get_datasource�s


�rhc	KrQ)ab
    Create a new datasource in an organisation.

    name
        Name of the data source.

    type
        Type of the datasource ('graphite', 'influxdb' etc.).

    access
        Use proxy or direct.

    url
        The URL to the data source API.

    user
        Optional - user to authenticate with the data source.

    password
        Optional - password to authenticate with the data source.

    database
        Optional - database to use with the data source.

    basicAuth
        Optional - set to True to use HTTP basic auth to authenticate with the
        data source.

    basicAuthUser
        Optional - HTTP basic auth username.

    basicAuthPassword
        Optional - HTTP basic auth password.

    jsonData
        Optional - additional json data to post (eg. "timeInterval").

    isDefault
        Optional - set data source as default.

    withCredentials
        Optional - Whether credentials such as cookies or auth headers should
        be sent with cross-site requests.

    typeLogoUrl
        Optional - Logo to use for this datasource.

    orgname
        Name of the organization in which the data source should be created.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.create_datasource

    rrfrrrr/rrRrSrrr�create_datasource�s
>










�


ric	Ks\t|t
�rtd
|�
}tjd�|d|�|t|�
t|�
|�dd�d�}|j	dkr,|�
�
iS)a0
    Update a datasource.

    datasourceid
        Id of the datasource.

    name
        Name of the data source.

    type
        Type of the datasource ('graphite', 'influxdb' etc.).

    access
        Use proxy or direct.

    url
        The URL to the data source API.

    user
        Optional - user to authenticate with the data source.

    password
        Optional - password to authenticate with the data source.

    database
        Optional - database to use with the data source.

    basicAuth
        Optional - set to True to use HTTP basic auth to authenticate with the
        data source.

    basicAuthUser
        Optional - HTTP basic auth username.

    basicAuthPassword
        Optional - HTTP basic auth password.

    jsonData
        Optional - additional json data to post (eg. "timeInterval").

    isDefault
        Optional - set data source as default.

    withCredentials
        Optional - Whether credentials such as cookies or auth headers should
        be sent with cross-site requests.

    typeLogoUrl
        Optional - Logo to use for this datasource.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.update_datasource <datasourceid>

    r�{}/api/datasources/{}rrrr/r)rrrr
r7rrrr	rr)�datasourceidrIr
r3r!rrr�update_datasource�s
>







�

rlcCs^t|t
�rtd
|�
}tjd�|d|�t|�
t|�
|�dd�d�}|j	dkr+|�
�
|��S)a)

    Delete a datasource.

    datasourceid
        Id of the datasource.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.delete_datasource <datasource_id>
    rrjrrrrrr>)rkrIr
r!rrr�delete_datasourceIr-rmcCs�t|t
�rtd
|�
}|
rt|
|�
tjd�|d|�t|�
t|�
|�dd�d�}|�	�}|j
dkr4dS|j
d	kr=|��
|�d
�
S)aG

    Get a dashboard.

    slug
        Slug (name) of the dashboard.

    orgname
        Name of the organization.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.get_dashboard <slug>
    r�{}/api/dashboards/db/{}rrrri�
NrZ	dashboard)rrrrJr
r	rrrrrr)�slugrIr
r!r%rrr�
get_dashboardgs 










�







rpcCrW)aM

    Delete a dashboard.

    slug
        Slug (name) of the dashboard.

    orgname
        Name of the organization.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.delete_dashboard <slug>
    rrnrrrrrrX)rorIr
r!rrr�delete_dashboard�rZrqc	Ksnt|
t
�rtd
|
�
}
|rt||
�
tjd�|
�d�
�
|t|
�
t	|
�
|
�dd�d�}|j
dkr3|��
|��S)a

    Create or update a dashboard.

    dashboard
        A dict that defines the dashboard to create/update.

    overwrite
        Whether the dashboard should be overwritten if already existing.

    orgname
        Name of the organization.

    profile
        Configuration profile used to connect to the Grafana instance.
        Default is 'grafana'.

    CLI Example:

    .. code-block:: bash

        salt '*' grafana4.create_update_dashboard dashboard=<dashboard> overwrite=True orgname=<orgname>
    rz{}/api/dashboards/dbrrrr/r)
rrrrJr
r1rr	rrrrrrSrrr�create_update_dashboard�s











�


rr)
r)Nr)(�__doc__r
r�ImportErrorrrrrr"r'r,r4r9r:r<r@rArCrErGrJrOrTrVrYr\r^r`rarbrdrergrhrirlrmrprqrrrrrr�<module>
sV


�




(
(
"
"


!



 
+
.
#
 
3
 
*

"

 

N
N

&#