Current File : //lib/python2.7/site-packages/salt/states/hipchat.pyo
�
���^c @@ sG d Z d d l m Z m Z m Z d � Z d d d d e d � Z d S( u�
Send a message to Hipchat
=========================
This state is useful for sending messages to Hipchat during state runs.
The property api_url is optional. By defaul will use the public HipChat API at https://api.hipchat.com
.. versionadded:: 2015.5.0
.. code-block:: yaml
hipchat-message:
hipchat.send_message:
- room_id: 123456
- from_name: SuperAdmin
- message: 'This state was executed successfully.'
- api_url: https://hipchat.myteam.com
- api_key: peWcBiMOS9HrZG15peWcBiMOS9HrZG15
- api_version: v1
The api key can be specified in the master or minion configuration like below:
.. code-block:: yaml
hipchat:
api_key: peWcBiMOS9HrZG15peWcBiMOS9HrZG15
api_version: v1
i ( t absolute_importt print_functiont unicode_literalsc C@ s d t k r d St S( uB
Only load if the hipchat module is available in __salt__
u hipchat.send_messageu hipchat( t __salt__t False( ( ( s7 /usr/lib/python2.7/site-packages/salt/states/hipchat.pyt __virtual__% s u yellowc
C@ s" i | d 6i d 6t d 6d d 6} t d rM d j | � | d <d | d <| S| sj d j | � | d <| S| s� d j | � | d <| S| s� d
j | � | d <| St d d | d
| d | d | d | d | d | d | � | d <| r | d r d j | � | d <n d j | � | d <| S( u9
Send a message to a Hipchat room.
.. code-block:: yaml
hipchat-message:
hipchat.send_message:
- room_id: 123456
- from_name: SuperAdmin
- message: 'This state was executed successfully.'
- api_url: https://hipchat.myteam.com
- api_key: peWcBiMOS9HrZG15peWcBiMOS9HrZG15
- api_version: v1
- message_color: green
- notify: True
The following parameters are required:
name
The unique name for this event.
room_id
The room to send the message to. Can either be the ID or the name.
from_name
The name of that is to be shown in the "from" field.
If not specified, defaults to.
message
The message that is to be sent to the Hipchat room.
The following parameters are optional:
api_url
The API URl to be used.
If not specified here or in the configuration options of master or minion,
will use the public HipChat API: https://api.hipchat.com
api_key
The api key for Hipchat to use for authentication,
if not specified in the configuration options of master or minion.
api_version
The api version for Hipchat to use,
if not specified in the configuration options of master or minion.
message_color
The color the Hipchat message should be displayed in. One of the following, default: yellow
"yellow", "red", "green", "purple", "gray", or "random".
notify
Should a notification in the room be raised.
u nameu changesu resultu u commentu testu3 The following message is to be sent to Hipchat: {0}u Hipchat room id is missing: {0}u! Hipchat from name is missing: {0}u Hipchat message is missing: {0}u hipchat.send_messaget room_idt messaget from_namet api_urlt api_keyt api_versiont colort notifyu Sent message: {0}u Failed to send message: {0}N( R t __opts__t formatt NoneR (
t nameR R R R R
R t
message_colorR
t ret( ( s7 /usr/lib/python2.7/site-packages/salt/states/hipchat.pyt send_message, s< >
N( t __doc__t
__future__R R R R R R R ( ( ( s7 /usr/lib/python2.7/site-packages/salt/states/hipchat.pyt <module> s
Mini Shell