Current File : //lib/python2.7/site-packages/salt/client/api.pyc
�
���^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 Z d d l
Z d d l Z d d l Z d d l
Z d d l j Z d d l m Z d d � Z d e f d � � YZ d S( uF
This module provides the point of entry for client applications to interface to
salt. The purpose is to have a simplified consistent interface for various
client applications.
.. warning:: This API is not yet public or stable!
This API exists in its current form as an entry point for Halite only. This
interface is likely to change without warning. Long-term plans are to make
this public as a unified interface to Salt's *Client() APIs. Until that
time please use Salt's *Client() interfaces individually:
http://docs.saltstack.com/ref/clients/index.html
i ( t absolute_importt print_functiont unicode_literalsN( t EauthAuthenticationErrorc C@ s | d k r | | d <n | S( u{
If token is not None Then assign token to 'token' key of cmd dict
and return cmd
Otherwise return cmd
u tokenN( t None( t cmdt token( ( s3 /usr/lib/python2.7/site-packages/salt/client/api.pyt tokenify" s
t APIClientc B@ s� e Z d Z d e d � Z d � Z d � Z d � Z d � Z e Z
d � Z e Z d � Z
d � Z d � Z d
� Z d d e d
� Z d � Z RS( u�
Provide a uniform method of accessing the various client interfaces in Salt
in the form of low-data data structures. For example:
c C@ s� | s< t j j t j j d t j j t j d � � � } n | | _
t j j | j
d � | _
t j j | j
� | _ t j j | j
� | _ t j j | j
� | _ t j j j d | j
d | j
d d | j
d | �| _ d S( Nu SALT_MASTER_CONFIGu masteru conf_fileu sock_diru transportt optst listen( t saltt configt
client_configt ost environt gett patht joint syspathst
CONFIG_DIRR t clientt get_local_clientt localClientt runnert RunnerClientt runnerClientt wheelt Wheelt wheelClientt autht Resolvert resolvert utilst eventt get_event( t selfR R
( ( s3 /usr/lib/python2.7/site-packages/salt/client/api.pyt __init__2 s !
c C@ s� t | � } d } | j d d � } | j d d � j d � } t | � d k r� | d d k r� | d } d j | d � | d <n d | k p� d
| k o� d | k o� d | k s� t d � � n t | d j | | � � } | | � } | S( u�
Execute the salt command given by cmd dict.
cmd is a dictionary of the following form:
{
'mode': 'modestring',
'fun' : 'modulefunctionstring',
'kwarg': functionkeywordargdictionary,
'tgt' : 'targetpatternstring',
'tgt_type' : 'targetpatterntype',
'ret' : 'returner namestring',
'timeout': 'functiontimeout',
'arg' : 'functionpositionalarg sequence',
'token': 'salttokenstring',
'username': 'usernamestring',
'password': 'passwordstring',
'eauth': 'eauthtypestring',
}
Implied by the fun is which client is used to run the command, that is, either
the master local minion client, the master runner client, or the master wheel client.
The cmd dict items are as follows:
mode: either 'sync' or 'asynchronous'. Defaults to 'asynchronous' if missing
fun: required. If the function is to be run on the master using either
a wheel or runner client then the fun: includes either
'wheel.' or 'runner.' as a prefix and has three parts separated by '.'.
Otherwise the fun: specifies a module to be run on a minion via the local
minion client.
Example:
fun of 'wheel.config.values' run with master wheel client
fun of 'runner.manage.status' run with master runner client
fun of 'test.ping' run with local minion client
fun of 'wheel.foobar' run with with local minion client not wheel
kwarg: A dictionary of keyword function parameters to be passed to the eventual
salt function specified by fun:
tgt: Pattern string specifying the targeted minions when the implied client is local
tgt_type: Optional target pattern type string when client is local minion.
Defaults to 'glob' if missing
ret: Optional name string of returner when local minion client.
arg: Optional positional argument string when local minion client
token: the salt token. Either token: is required or the set of username:,
password: , and eauth:
username: the salt username. Required if token is missing.
password: the user's password. Required if token is missing.
eauth: the authentication type such as 'pam' or 'ldap'. Required if token is missing
u minionu modeu asyncu funu u .i i u wheelu runneri u tokenu eauthu passwordu usernameu# No authentication credentials givenu {0}_{1}( u wheelu runner( t dictR t splitt lenR R t getattrt format( R$ R R t modet funpartst executort result( ( s3 /usr/lib/python2.7/site-packages/salt/client/api.pyt runF s 3 "
$ c K@ s | j j | � S( u�
Wrap LocalClient for running :ref:`execution modules <all-salt.modules>`
and immediately return the job ID. The results of the job can then be
retrieved at a later time.
.. seealso:: :ref:`python-api`
( R t run_job( R$ t kwargs( ( s3 /usr/lib/python2.7/site-packages/salt/client/api.pyt minion_async� s c K@ s | j j | � S( u�
Wrap LocalClient for running :ref:`execution modules <all-salt.modules>`
.. seealso:: :ref:`python-api`
( R R ( R$ R1 ( ( s3 /usr/lib/python2.7/site-packages/salt/client/api.pyt minion_sync� s c K@ s | j j | � S( u�
Wrap RunnerClient for executing :ref:`runner modules <all-salt.runners>`
Expects that one of the kwargs is key 'fun' whose value is the namestring
of the function to call
( R t master_call( R$ R1 ( ( s3 /usr/lib/python2.7/site-packages/salt/client/api.pyt runner_async� s c K@ s | j j | � S( u�
Wrap Wheel to enable executing :ref:`wheel modules <all-salt.wheel>`
Expects that one of the kwargs is key 'fun' whose value is the namestring
of the function to call
( R R4 ( R$ R1 ( ( s3 /usr/lib/python2.7/site-packages/salt/client/api.pyt
wheel_sync� s c C@ s` d | d <t | d j d � � d k rS | d j d � d d
k rS d | d <n | j | � S( u�
Convenience function that returns dict of function signature(s) specified by cmd.
cmd is dict of the form:
{
'module' : 'modulestring',
'tgt' : 'targetpatternstring',
'tgt_type' : 'targetpatterntype',
'token': 'salttokenstring',
'username': 'usernamestring',
'password': 'passwordstring',
'eauth': 'eauthtypestring',
}
The cmd dict items are as follows:
module: required. This is either a module or module function name for
the specified client.
tgt: Optional pattern string specifying the targeted minions when client
is 'minion'
tgt_type: Optional target pattern type string when client is 'minion'.
Example: 'glob' defaults to 'glob' if missing
token: the salt token. Either token: is required or the set of username:,
password: , and eauth:
username: the salt username. Required if token is missing.
password: the user's password. Required if token is missing.
eauth: the authentication type such as 'pam' or 'ldap'. Required if token is missing
Adds client per the command.
u minionu clientu moduleu .i i u runneru wheelu master( u runneru wheel( R( R' t
_signature( R$ R ( ( s3 /usr/lib/python2.7/site-packages/salt/client/api.pyt signature� s
<
c C@ s� i } | j d d � } | d k rW d | d <t d | d � | d <| j | � } n� | d k r� | d j d � } | d
} d j | d � } | d k r� | j j } n | d
k r� | j j } n i t j j
j | | � d 6} n | S( u�
Expects everything that signature does and also a client type string.
client can either be master or minion.
u clientu minionu sys.argspecu funt moduleu moduleu kwargu masteru .i i u wheelu runner( R R& R/ R' R R t functionsR R R! t argst argspec_report( R$ R R. R t partsR9 R: ( ( s3 /usr/lib/python2.7/site-packages/salt/client/api.pyR7 � s
"c C@ s� y | j j | � } Wn. t k
rF } t d j t | � � � � n Xd | k rb t d � � n | j d | d } | d | k r� | | d | d <n | d | d <| d | d <| d | d
<| S( u*
Create token with creds.
Token authorizes salt access if successful authentication
with the credentials in creds.
creds format is as follows:
{
'username': 'namestring',
'password': 'passwordstring',
'eauth': 'eauthtypestring',
}
examples of valid eauth type strings: 'pam' or 'ldap'
Returns dictionary of token information with the following format:
{
'token': 'tokenstring',
'start': starttimeinfractionalseconds,
'expire': expiretimeinfractionalseconds,
'name': 'usernamestring',
'user': 'usernamestring',
'username': 'usernamestring',
'eauth': 'eauthtypestring',
'perms: permslistofstrings,
}
The perms list provides those parts of salt for which the user is authorised
to execute.
example perms list:
[
"grains.*",
"status.*",
"sys.*",
"test.*"
]
u Authentication failed with {0}.u tokenu0 Authentication failed with provided credentials.u
external_authu eauthu nameu permsu *u useru username( R t mk_tokent ExceptionR R* t reprR ( R$ t credst tokenaget ext tokenage_eauth( ( s3 /usr/lib/python2.7/site-packages/salt/client/api.pyt create_token� s & c C@ sK y | j j | � } Wn. t k
rF } t d j t | � � � � n X| S( ud
If token is valid Then returns user name associated with token
Else False.
u! Token validation failed with {0}.( R t get_tokenR? R R* R@ ( R$ R R. RC ( ( s3 /usr/lib/python2.7/site-packages/salt/client/api.pyt verify_token' s g �?u c C@ s% | j j d | d | d | d t � S( u(
Get a single salt event.
If no events are available, then block for up to ``wait`` seconds.
Return the event if it matches the tag (or ``tag`` is empty)
Otherwise return None
If wait is 0 then block forever or until next event becomes available.
t waitt tagt fullt auto_reconnect( R" R# t True( R$ RH RI RJ ( ( s3 /usr/lib/python2.7/site-packages/salt/client/api.pyR# 4 s c C@ s% | j j | t j j j | d � � S( u�
fires event with data and tag
This only works if api is running with same user permissions as master
Need to convert this to a master call with appropriate authentication
u wui( R" t
fire_eventR R! t tagify( R$ t dataRI ( ( s3 /usr/lib/python2.7/site-packages/salt/client/api.pyRM ? s N( t __name__t
__module__t __doc__R RL R% R/ R2 R3 R5 t runner_syncR6 t wheel_asyncR8 R7 RE RG t FalseR# RM ( ( ( s3 /usr/lib/python2.7/site-packages/salt/client/api.pyR - s E
$ ;
( RR t
__future__R R R R t salt.configR t salt.autht salt.clientt salt.runnert
salt.wheelt salt.utils.argst salt.utils.eventt
salt.syspathsR t salt.exceptionsR R R t objectR ( ( ( s3 /usr/lib/python2.7/site-packages/salt/client/api.pyt <module> s
Mini Shell