Current File : //lib/python2.7/site-packages/salt/modules/win_snmp.pyc
�
���^c @@ sw d Z d d l m Z m Z m Z d d l Z d d l Z d d l m Z m
Z
d d l m Z d Z
d Z d j e � Z d j e � Z d
Z d j e � Z i d d 6d
d 6d d 6d d 6d d 6Z i d d 6d d 6d
d 6d d 6d d 6d d 6Z e j e � Z d Z d � Z d � Z d � Z d � Z d � Z d d d d! � Z d" � Z! e" d# � Z# d$ � Z$ d% � Z% d S(& uu
Module for managing SNMP service settings on Windows servers.
The Windows feature 'SNMP-Service' must be installed.
i ( t absolute_importt unicode_literalst print_functionN( t SaltInvocationErrort CommandExecutionError( t sixu HKLMu1 SYSTEM\CurrentControlSet\Services\SNMP\Parametersu {0}\RFC1156Agentu {0}\ValidCommunitiesu! SOFTWARE\Policies\SNMP\Parametersi u Nonei u Notifyi u Read Onlyi u
Read Writei u Read Createu Physicalu Datalink and subnetworku Internetu
End-to-endi@ u Applicationsu win_snmpc C@ s= t j j j � s t d f St d t t � s9 t d f St S( u(
Only works on Windows systems.
u! Module win_snmp: Requires Windowsu reg.key_existsu# Module win_snmp: SNMP not installed( t saltt utilst platformt
is_windowst Falset __salt__t _HKEYt _SNMP_KEYt __virtualname__( ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/win_snmp.pyt __virtual__, s
c C@ s6 | d k s t | t j � r" | St j | d � Sd S( u�
Converts from current users character encoding to unicode.
When instr has a value of None, the return value of the function
will also be None.
u utf8N( t Nonet
isinstanceR t text_type( t instr( ( s9 /usr/lib/python2.7/site-packages/salt/modules/win_snmp.pyt _to_unicode9 s c C@ s
t t � S( u�
Get the sysServices types that can be configured.
Returns:
list: A list of service types.
CLI Example:
.. code-block:: bash
salt '*' win_snmp.get_agent_service_types
( t listt _SERVICE_TYPES( ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/win_snmp.pyt get_agent_service_typesE s
c C@ s
t t � S( u�
Get the permission types that can be configured for communities.
Returns:
list: A list of permission types.
CLI Example:
.. code-block:: bash
salt '*' win_snmp.get_permission_types
( R t _PERMISSION_TYPES( ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/win_snmp.pyt get_permission_typesU s
c C@ s* t � } t t j � d d � �} t � | d <t d t t d � d | d <t d t t d � d | d <t d t t d
� d } | d k r� | d j | d d � nc x` | D]X \ } } | d
k r
| d k r
| | } | d k r| } | d j | � qq� Pq� Wt | d � | d <| S( u�
Determine the value of the SNMP sysContact, sysLocation, and sysServices
settings.
Returns:
dict: A dictionary of the agent settings.
CLI Example:
.. code-block:: bash
salt '*' win_snmp.get_agent_settings
t keyc S@ s | d | d f S( Ni i ( ( t x( ( s9 /usr/lib/python2.7/site-packages/salt/modules/win_snmp.pyt <lambda>t s u servicesu reg.read_valueu
sysContactu vdatau contactu sysLocationu locationu sysServicesi i����N(
t dictt sortedR t itemsR R R t
_AGENT_KEYt appendR ( t rett sorted_typest current_bitmaskt servicet bitmaskt remaining_bitmask( ( s9 /usr/lib/python2.7/site-packages/salt/modules/win_snmp.pyt get_agent_settingse s(
c C@ s9 | d k rb t t | � � } xA | D]6 } | t k r% d j | t � � } t | � � q% q% Wn t j r� t | � } t | � } n i | d 6| d 6| d 6} t
� } | | k r� t j d � t
S| d k r| | d k rt d t t d | d � qn | d k r?| | d k r?t d t t d | d � q?n | d k r�t | � t | d � k r�t d
� | D� � } t j d | � t d t t d | d
� q�n t
� } t � } xC | D]; }
| |
d k r�| |
| |
k r�| |
| |
<q�q�W| r t j d | � t St j d | j � � t
S( u
Manage the SNMP sysContact, sysLocation, and sysServices settings.
Args:
contact (str, optional): The SNMP contact.
location (str, optional): The SNMP location.
services (list, optional): A list of selected services. The possible
service names can be found via ``win_snmp.get_agent_service_types``.
To disable all services pass a list of None, ie: ['None']
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_snmp.set_agent_settings contact='Contact Name' location='Place' services="['Physical']"
u4 Invalid service '{0}' specified. Valid services: {1}u contactu locationu servicesu3 Agent settings already contain the provided values.u
reg.set_valueu
sysContactu REG_SZu sysLocationc s@ s | ] } t | Vq d S( N( R ( t .0R% ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/win_snmp.pys <genexpr>� s u Setting sysServices vdata to: %su sysServicesu REG_DWORDu& Unable to configure agent settings: %su* Agent settings configured successfully: %sN( R R t setR t formatR R R t PY2R R( t _LOGt debugt TrueR R R t sumR t errorR
t keys( t contactt locationt servicesR% t messaget settingst current_settingst vdatat new_settingst failed_settingst setting( ( s9 /usr/lib/python2.7/site-packages/salt/modules/win_snmp.pyt set_agent_settings� sP
c C@ s> t d t t d � } | d d k r* t St | d p: d � S( u�
Determine whether the host is configured to send authentication traps.
Returns:
bool: True if traps are enabled, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_snmp.get_auth_traps_enabled
u reg.read_valueu EnableAuthenticationTrapsu vdatau (value not set)i ( R R R
R
t bool( t reg_ret( ( s9 /usr/lib/python2.7/site-packages/salt/modules/win_snmp.pyt get_auth_traps_enabled� s
c C@ s� d } t � } t | � | k r5 t j d | � t St | � } t d t t | | d � t � } | | k r� t j d | | � t St j d | | � t
S( u+
Manage the sending of authentication traps.
Args:
status (bool): True to enable traps. False to disable.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_snmp.set_auth_traps_enabled status='True'
u EnableAuthenticationTrapsu' %s already contains the provided value.u
reg.set_valueu REG_DWORDu& Setting %s configured successfully: %su% Unable to configure %s with value: %s( R@ R> R- R. R/ t intR R R
R1 R
( t statust vnamet current_statusR9 t
new_status( ( s9 /usr/lib/python2.7/site-packages/salt/modules/win_snmp.pyt set_auth_traps_enabled� s c C@ sU t � } t d t t � r� t j d � t d t t d t �} t | t � r� x4 | D]) } t | t � ss qX n d | | d <qX Wq� n | s;t j d � t d t t d t �} t | t � r;xo | D]d } t | t � s� q� n t
j � } x, t D]$ } | d t | k r� | } Pq� q� W| | | d <q� Wq;n | sQt j d � n | S(
uE
Get the current accepted SNMP community names and their permissions.
If community names are being managed by Group Policy, those values will be
returned instead like this:
.. code-block:: bash
TestCommunity:
Managed by GPO
Community names managed normally will denote the permission instead:
.. code-block:: bash
TestCommunity:
Read Only
Returns:
dict: A dictionary of community names and permissions.
CLI Example:
.. code-block:: bash
salt '*' win_snmp.get_community_names
u reg.key_existsu. Loading communities from Group Policy settingsu reg.list_valuest include_defaultu Managed by GPOu vdatau& Loading communities from SNMP settingsu vnameu$ Unable to find existing communities.(
R R R t _COMMUNITIES_GPO_KEYR- R. R
R R t _COMMUNITIES_KEYR R R ( R" t current_valuest
current_valuet permissionst permission_name( ( s9 /usr/lib/python2.7/site-packages/salt/modules/win_snmp.pyt get_community_names s6
c
C@ s+ t � } t d t t � r8 t j d � t d � � n t � } | | k r^ t j d � t Sx} | D]u } | | s� d | | <n y t | | } Wn9 t
k
r� d j | | t j � � } t
| � � n X| | | <qe Wxf | D]^ } | | k r/| | | | k rCt d t t | | | d � qCq� t d t t | � q� Wx; | D]3 } | | k rNt d t t | | | d � qNqNWt � } t � } x' | D] } | | k r�d | | <q�q�Wx3 | D]+ } | | | | k r�| | | | <q�q�W| rt j d | � t St j d
| j � � t S( u(
Manage the SNMP accepted community names and their permissions.
.. note::
Settings managed by Group Policy will always take precedence over those
set using the SNMP interface. Therefore if this function finds Group
Policy settings it will raise a CommandExecutionError
Args:
communities (dict): A dictionary of SNMP community names and
permissions. The possible permissions can be found via
``win_snmp.get_permission_types``.
Returns:
bool: True if successful, otherwise False
Raises:
CommandExecutionError:
If SNMP settings are being managed by Group Policy
CLI Example:
.. code-block:: bash
salt '*' win_snmp.set_community_names communities="{'TestCommunity': 'Read Only'}'
u reg.key_existsu6 Communities on this system are managed by Group Policyu0 Communities already contain the provided values.u Noneu: Invalid permission '{0}' specified. Valid permissions: {1}u
reg.set_valueu REG_DWORDu reg.delete_valueu# Unable to configure communities: %su' Communities configured successfully: %sN( R R R RH R- R. R RN R/ R t KeyErrorR+ R2 R RI R R1 R
(
t communitiest valuest current_communitiesRC R9 R6 t
current_vnamet new_communitiest failed_communitiest new_vname( ( s9 /usr/lib/python2.7/site-packages/salt/modules/win_snmp.pyt set_community_names� sX
(& t __doc__t
__future__R R R t loggingt salt.utils.platformR t salt.exceptionsR R t salt.extR R R
R+ R RI t
_SNMP_GPO_KEYRH R R t getLoggert __name__R- R R R R R R( R R= R@ R/ RF RN RW ( ( ( s9 /usr/lib/python2.7/site-packages/salt/modules/win_snmp.pyt <module> sD
-U # b
Mini Shell