Current File : //lib/python2.7/site-packages/salt/modules/environ.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
e j e � Z
d � Z e e d � Z e e e e d � Z d d � Z d d
� Z d d � Z d � Z d S(
uX
Support for getting and setting the environment variables
of the current salt process.
i ( t absolute_importt print_functiont unicode_literalsN( t sixc C@ s t S( uB
No dependency checks, and not renaming, just return True
( t True( ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/environ.pyt __virtual__ s c C@ s� t j j j � } | rB d } d } | d k rB d } d } qB n t | t j � sp t j d j t
| � � n | t k r| t k r� y> t
j j | d � | r� | r� t d | | | � n d SWqt k
r� } t j d j t
| | � � t SXqd } n t | t j � r�yB | t
j | <| rM| rMt d | | | | � n t
j | SWq�t k
r�} t j d
j t
| | � � t SXn t j d j t
| | � � t Sd S(
u
Set a single salt process environment variable. Returns True
on success.
key
The environment key to set. Must be a string.
val
The value to set. Must be a string or False. Refer to the
'false_unsets' parameter for behavior when set to False.
false_unsets
If val is False and false_unsets is True, then the key will be
removed from the salt processes environment dict entirely.
If val is False and false_unsets is not True, then the key's
value will be set to an empty string.
Default: False.
permanent
On Windows minions this will set the environment variable in the
registry so that it is always added as an environment variable when
applications open. If you want to set the variable to HKLM instead of
HKCU just pass in "HKLM" for this parameter. On all other minion types
this will be ignored. Note: This will only take affect on applications
opened after this has been set.
CLI Example:
.. code-block:: bash
salt '*' environ.setval foo bar
salt '*' environ.setval baz val=False false_unsets=True
salt '*' environ.setval baz bar permanent=True
salt '*' environ.setval baz bar permanent=HKLM
u HKCUu Environmentu HKLMu< SYSTEM\CurrentControlSet\Control\Session Manager\Environmentu/ {0}: 'key' argument is not a string type: '{1}'u reg.delete_valueu? {0}: Exception occurred when unsetting environ key '{1}': '{2}'u u
reg.set_valueu< {0}: Exception occurred when settingenviron key '{1}': '{2}'uA {0}: 'val' argument for key '{1}' is not a string or False: '{2}'N( t saltt utilst platformt
is_windowst
isinstanceR t string_typest logt debugt formatt __name__t FalseR t ost environt popt Nonet __salt__t Exceptiont error( t keyt valt false_unsetst permanentR t permanent_hivet
permanent_keyt exc( ( s8 /usr/lib/python2.7/site-packages/salt/modules/environ.pyt setval sN $
c C@ so i } t | t � s2 t j d j t | � � t S| t k r� g t j D] } | | k rH | ^ qH } x- | D]" } t
| t | d | �| | <qm Wn x� t j | � D]� \ } } t | t j
� r� t
| | d | �| | <q� | t k r t
| | | d | �| | <q� t j d j t | | � � t Sq� W| t k rkt d i | d 6| d 6| d 6| d 6d � n | S(
u�
Set multiple salt process environment variables from a dict.
Returns a dict.
environ
Must be a dict. The top-level keys of the dict are the names
of the environment variables to set. Each key's value must be
a string or False. Refer to the 'false_unsets' parameter for
behavior when a value set to False.
false_unsets
If a key's value is False and false_unsets is True, then the
key will be removed from the salt processes environment dict
entirely. If a key's value is False and false_unsets is not
True, then the key's value will be set to an empty string.
Default: False
clear_all
USE WITH CAUTION! This option can unset environment variables
needed for salt to function properly.
If clear_all is True, then any environment variables not
defined in the environ dict will be deleted.
Default: False
update_minion
If True, apply these environ changes to the main salt-minion
process. If False, the environ changes will only affect the
current salt subprocess.
Default: False
permanent
On Windows minions this will set the environment variable in the
registry so that it is always added as an environment variable when
applications open. If you want to set the variable to HKLM instead of
HKCU just pass in "HKLM" for this parameter. On all other minion types
this will be ignored. Note: This will only take affect on applications
opened after this has been set.
CLI Example:
.. code-block:: bash
salt '*' environ.setenv '{"foo": "bar", "baz": "quux"}'
salt '*' environ.setenv '{"a": "b", "c": False}' false_unsets=True
u, {0}: 'environ' argument is not a dict: '{1}'R uA {0}: 'val' argument for key '{1}' is not a string or False: '{2}'u
event.fireu environu false_unsetsu clear_allu permanentu environ_setenv( R
t dictR R
R R R R R R R R t iteritemsR R ( R R t clear_allt
update_minionR t retR t to_unsetR ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/environ.pyt setenvr s4 /
(
#
u c C@ sB t | t j � s/ t j d j t | � � t St j j
| | � S( u_
Get a single salt process environment variable.
key
String used as the key for environment lookup.
default
If the key is not found in the environment, return this value.
Default: ''
CLI Example:
.. code-block:: bash
salt '*' environ.get foo
salt '*' environ.get baz default=False
u/ {0}: 'key' argument is not a string type: '{1}'( R
R R R R
R R R R R t get( R t default( ( s8 /usr/lib/python2.7/site-packages/salt/modules/environ.pyR' � s
c C@ s| t | t j � s/ t j d j t | � � t Sy4 t j | } | d k rb | | k r[ t St Sn Wn t k
rw t SXt S( u�
Determine whether the key exists in the current salt process
environment dictionary. Optionally compare the current value
of the environment against the supplied value string.
key
Must be a string. Used as key for environment lookup.
value:
Optional. If key exists in the environment, compare the
current value with this value. Return True if they are equal.
CLI Example:
.. code-block:: bash
salt '*' environ.has_value foo
u/ {0}: 'key' argument is not a string type: '{1}'N(
R
R R R R
R R R R R R R t KeyError( R t valuet cur_val( ( s8 /usr/lib/python2.7/site-packages/salt/modules/environ.pyt has_value� s
c C@ s� i } g } t | t j � r. | j | � n1 t | t � rF | } n t j d j t | � � x' | D] } t j
j | | � | | <qf W| S( u�
Get one or more salt process environment variables.
Returns a dict.
keys
Either a string or a list of strings that will be used as the
keys for environment lookup.
default
If the key is not found in the environment, return this value.
Default: ''
CLI Example:
.. code-block:: bash
salt '*' environ.item foo
salt '*' environ.item '[foo, baz]' default=None
u8 {0}: 'keys' argument is not a string or list type: '{1}'( R
R R t appendt listR R
R R R R R' ( t keysR( R$ t key_listR ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/environ.pyt item s
c C@ s
t t j � S( u�
Return a dict of the entire environment set for the salt process
CLI Example:
.. code-block:: bash
salt '*' environ.items
( R R R ( ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/environ.pyt items) s
( t __doc__t
__future__R R R R t loggingt salt.utils.platformR t salt.extR t getLoggerR R R R R R& R' R R, R1 R2 ( ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/environ.pyt <module> s WR % $
Mini Shell