Saltstack module grafana4 详解

grafana4.get_org

Show a single organization.

name
Name of the organization.

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

CLI Example:

salt '*' grafana4.get_org

grafana4.delete_user

Delete a user.

userid
Id of the user.

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

CLI Example:

salt '*' grafana4.delete_user <user_id>

grafana4.update_org

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:

salt '*' grafana4.update_org <org_id> name=

grafana4.get_datasources

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:

salt '*' grafana4.get_datasources

grafana4.delete_user_org

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:

salt '*' grafana4.delete_user_org <user_id> <org_id>

grafana4.get_users

List all users.

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

CLI Example:

salt '*' grafana4.get_users

grafana4.delete_dashboard

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:

salt '*' grafana4.delete_dashboard

grafana4.get_orgs

List all organizations.

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

CLI Example:

salt '*' grafana4.get_orgs

grafana4.update_user_password

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:

salt '*' grafana4.update_user_password <user_id> password=

grafana4.update_datasource

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:

salt '*' grafana4.update_datasource

grafana4.update_user_permissions

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:

salt '*' grafana4.update_user_permissions <user_id> isGrafanaAdmin=<true|false>

grafana4.create_org_user

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:

salt '*' grafana4.create_org_user loginOrEmail= role=

grafana4.update_org_address

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:

salt '*' grafana4.update_org_address country=

grafana4.create_datasource

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:

salt '*' grafana4.create_datasource

grafana4.create_update_dashboard

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:

salt '*' grafana4.create_update_dashboard dashboard= overwrite=True orgname=

grafana4.get_user

Show a single user.

login
Login of the user.

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

CLI Example:

salt '*' grafana4.get_user

grafana4.delete_org

Delete an organization.

orgid
Id of the organization.

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

CLI Example:

salt '*' grafana4.delete_org <org_id>

grafana4.update_user

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:

salt '*' grafana4.update_user <user_id> login= email=

grafana4.update_org_user

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:

salt '*' grafana4.update_org_user <user_id> loginOrEmail= role=

grafana4.create_org

Create a new organization.

name
Name of the organization.

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

CLI Example:

salt '*' grafana4.create_org

grafana4.switch_org

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:

salt '*' grafana4.switch_org

grafana4.get_org_users

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:

salt '*' grafana4.get_org_users

grafana4.get_user_data

Get user data.

userid
Id of the user.

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

CLI Example:

salt '*' grafana4.get_user_data <user_id>

grafana4.get_org_prefs

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:

salt '*' grafana4.get_org_prefs

grafana4.delete_org_user

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:

salt '*' grafana4.delete_org_user <user_id>

grafana4.get_user_orgs

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:

salt '*' grafana4.get_user_orgs <user_id>

grafana4.get_datasource

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:

salt '*' grafana4.get_datasource

grafana4.get_org_address

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:

salt '*' grafana4.get_org_address

grafana4.delete_datasource

Delete a datasource.

datasourceid
Id of the datasource.

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

CLI Example:

salt '*' grafana4.delete_datasource <datasource_id>

grafana4.create_user

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:

salt '*' grafana4.create_user login= password= email=

grafana4.get_dashboard

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:

salt '*' grafana4.get_dashboard

grafana4.update_org_prefs

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:

salt '*' grafana4.update_org_prefs theme= timezone=