Current File : //lib/python2.7/site-packages/salt/states/netusers.pyo
�
���^c @@ s� d Z d d l m Z m Z m Z d d l Z e j e � Z d d l m
Z
d d l m Z m
Z
d d l m Z d d l Z d Z d � Z d � Z d
� Z d � Z d � Z d
� Z d � Z d � Z d � Z d d d � Z d S( u�
Network Users
=============
Manage the users configuration on network devices via the NAPALM proxy.
:codeauthor: Mircea Ulinic <mircea@cloudflare.com>
:maturity: new
:depends: napalm
:platform: unix
Dependencies
------------
- :mod:`NAPALM proxy minion <salt.proxy.napalm>`
- :mod:`Users configuration management module <salt.modules.napalm_users>`
.. versionadded:: 2016.11.0
i ( t absolute_importt print_functiont unicode_literalsN( t deepcopy( t loadst dumps( t sixu netusersc C@ s t j j j t t t � S( u_
NAPALM library must be installed for this module to work and run in a (proxy) minion.
( t saltt utilst napalmt virtualt __opts__t __virtualname__t __file__( ( ( s8 /usr/lib/python2.7/site-packages/salt/states/netusers.pyt __virtual__2 s c C@ s t d � S( u Retrieves configured usersu users.config( t __salt__( ( ( s8 /usr/lib/python2.7/site-packages/salt/states/netusers.pyt _retrieve_users= s c C@ s t t | � � S( u .( R R ( t probes( ( s8 /usr/lib/python2.7/site-packages/salt/states/netusers.pyt _ordered_dict_to_dictD s c C@ s t | � } | j | � | S( u6 Creates a longer list of accepted users on the device.( R t update( t device_userst common_userst expected_users( ( s8 /usr/lib/python2.7/site-packages/salt/states/netusers.pyt
_expand_usersK s
c C@ s� d } t } x� t j | � D]� \ } } | sP t } | d j d | � 7} q n t | j d � t � p� d | j d � k o� d k n s | d j d | � 7} q q W| | f S( u1 Checks if the input dictionary of users is valid.u u, Please provide details for username {user}.
t useru leveli i uM Level must be a integer between 0 and 15 for username {user}. Will assume 0.
( t TrueR t iteritemst Falset formatt
isinstancet gett int( t userst messgt validR t user_details( ( s8 /usr/lib/python2.7/site-packages/salt/states/netusers.pyt _check_usersU s = c @ sR i i d 6i d 6i d 6} t � j � � } t � j � � } | | } | | } | | @} t � f d � | D� � } t � f d � | D� � } i }
x� | D]� } � j | � } � j | � }
| |
k r� q� n i |
| <xC t j |
� D]2 \ } } | j | � | k r� | |
| | <q� q� Wq� W| j i | d 6|
d 6| d 6� | S( uJ Computes the differences between the actual config and the expected configu addu updateu removec 3@ s$ | ] } | � j | � f Vq d S( N( R ( t .0t username( t expected( s8 /usr/lib/python2.7/site-packages/salt/states/netusers.pys <genexpr>y s c 3@ s$ | ] } | � j | � f Vq d S( N( R ( R% R& ( t
configured( s8 /usr/lib/python2.7/site-packages/salt/states/netusers.pys <genexpr>z s ( t sett keyst dictR R R R ( R( R' t difft configured_usersR t
add_usernamest remove_usernamest common_usernamest addt removeR R& t user_configurationt
user_expectedt fieldt field_value( ( R( R' s8 /usr/lib/python2.7/site-packages/salt/states/netusers.pyt
_compute_diffh s4
c C@ s t d | d t �S( u Calls users.set_users.u users.set_userst commit( R R ( R ( ( s8 /usr/lib/python2.7/site-packages/salt/states/netusers.pyt
_set_users� s c C@ s t d | d t �S( u Calls users.set_users.u users.set_usersR8 ( R R ( R ( ( s8 /usr/lib/python2.7/site-packages/salt/states/netusers.pyt
_update_users� s c C@ s t d | d t �S( u Calls users.delete_users.u users.delete_usersR8 ( R R ( R ( ( s8 /usr/lib/python2.7/site-packages/salt/states/netusers.pyt
_delete_users� s c C@ s t } d } i } i | d 6| d 6| d 6| d 6} t | � } t | � } t | | � } t | � \ } } | s� d j d | � | d <| St � }
|
j d � s� d j d |
j d � � | d <| S|
j d
i � } | | k r| j i d d 6t d 6� | St | | � } | j d i � }
| j d
i � } | j d i � } i |
d 6| d 6| d 6} | j i | d 6� t
d t k r�| j i d d 6d d 6� | St } t } |
rt |
� } | j d � r�t } qt } | d j d | j d � � 7} n | rXt
| � } | j d � r0t } qXt } | d j d | j d � � 7} n | r�t | � } | j d � r�t } q�t } | d j d | j d � � 7} n | r�| r�t d � \ } } | } | | 7} n | r�| r�| r�d } n | j i | d 6| d 6� | S( u@
Manages the configuration of the users on the device, as specified in the state SLS file. Users not defined in that
file will be remove whilst users not configured on the device, will be added.
SLS Example:
.. code-block:: yaml
netusers_example:
netusers.managed:
- users:
admin:
level: 15
password: $1$knmhgPPv$g8745biu4rb.Zf.IT.F/U1
sshkeys: []
restricted:
level: 1
password: $1$j34j5k4b$4d5SVjTiz1l.Zf.IT.F/K7
martin:
level: 15
password: ''
sshkeys:
- ssh-dss AAAAB3NzaC1kc3MAAACBAK9dP3KariMlM/JmFW9rTSm5cXs4nR0+o6fTHP9o+bOLXMBTP8R4vwWHh0w
JPjQmJYafAqZTnlgi0srGjyifFwPtODppDWLCgLe2M4LXnu3OMqknr54w344zPHP3iFwWxHrBrZKtCjO8LhbWCa+
X528+i87t6r5e4ersdfxgchvjbknlio87t6r5drcfhgjhbknio8976tycv7t86ftyiu87Oz1nKsKuNzm2csoUQlJ
trmRfpjsOPNookmOz5wG0YxhwDmKeo6fWK+ATk1OiP+QT39fn4G77j8o+e4WAwxM570s35Of/vV0zoOccj753sXn
pvJenvwpM2H6o3a9ALvehAJKWodAgZT7X8+iu786r5drtycghvjbiu78t+wAAAIBURwSPZVElXe+9a43sF6M4ysT
7Xv+6wTsa8q86E3+RYyu8O2ObI2kwNLC3/HTgFniE/YqRG+WJac81/VHWQNP822gns8RVrWKjqBktmQoEm7z5yy0
bkjui78675dytcghvjkoi9y7t867ftcuvhbuu9t78gy/v+zvMmv8KvQgHg
jonathan:
level: 15
password: ''
sshkeys:
- ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDcgxE6HZF/xjFtIt0thEDKPjFJxW9BpZtTVstYbDgGR9zPkHG
ZJT/j345jk345jk453jk43545j35nl3kln34n5kl4ghv3/JzWt/0Js5KZp/51KRNCs9O4t07qaoqwpLB15GwLfEX
Bx9dW26zc4O+hi6754trxcfghvjbo98765drt/LYIEg0KSQPWyJEK1g31gacbxN7Ab006xeHh7rv7HtXF6zH3WId
Uhq9rtdUag6kYnv6qvjG7sbCyHGYu5vZB7GytnNuVNbZuI+RdFvmHSnErV9HCu9xZBq6DBb+sESMS4s7nFcsruMo
edb+BAc3aww0naeWpogjSt+We7y2N
CLI Example:
salt 'edge01.kix01' state.sls router.users
Output example (raw python - can be reused in other modules):
.. code-block:: python
{
'netusers_|-netusers_example_|-netusers_example_|-managed': {
'comment': 'Configuration updated!',
'name': 'netusers_example',
'start_time': '10:57:08.678811',
'__id__': 'netusers_example',
'duration': 1620.982,
'__run_num__': 0,
'changes': {
'updated': {
'admin': {
'level': 15
},
'restricted': {
'level': 1
},
'martin': {
'sshkeys': [
'ssh-dss AAAAB3NzaC1kc3MAAACBAK9dP3KariMlM/JmFW9rTSm5cXs4nR0+o6fTHP9o+bOLXMBTP8R4vwWHh0w
JPjQmJYafAqZTnlgi0srGjyifFwPtODppDWLCgLe2M4LXnu3OMqknr54w344zPHP3iFwWxHrBrZKtCjO8LhbWCa+
X528+i87t6r5e4ersdfxgchvjbknlio87t6r5drcfhgjhbknio8976tycv7t86ftyiu87Oz1nKsKuNzm2csoUQlJ
trmRfpjsOPNookmOz5wG0YxhwDmKeo6fWK+ATk1OiP+QT39fn4G77j8o+e4WAwxM570s35Of/vV0zoOccj753sXn
pvJenvwpM2H6o3a9ALvehAJKWodAgZT7X8+iu786r5drtycghvjbiu78t+wAAAIBURwSPZVElXe+9a43sF6M4ysT
7Xv+6wTsa8q86E3+RYyu8O2ObI2kwNLC3/HTgFniE/YqRG+WJac81/VHWQNP822gns8RVrWKjqBktmQoEm7z5yy0
bkjui78675dytcghvjkoi9y7t867ftcuvhbuu9t78gy/v+zvMmv8KvQgHg'
]
}
},
'added': {
'jonathan': {
'password': '',
'sshkeys': [
'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDcgxE6HZF/xjFtIt0thEDKPjFJxW9BpZtTVstYbDgGR9zPkHG
ZJT/j345jk345jk453jk43545j35nl3kln34n5kl4ghv3/JzWt/0Js5KZp/51KRNCs9O4t07qaoqwpLB15GwLfEX
Bx9dW26zc4O+hi6754trxcfghvjbo98765drt/LYIEg0KSQPWyJEK1g31gacbxN7Ab006xeHh7rv7HtXF6zH3WId
Uhq9rtdUag6kYnv6qvjG7sbCyHGYu5vZB7GytnNuVNbZuI+RdFvmHSnErV9HCu9xZBq6DBb+sESMS4s7nFcsruMo
edb+BAc3aww0naeWpogjSt+We7y2N'
],
'level': 15
}
},
'removed': {
}
},
'result': True
}
}
CLI Output:
.. code-block:: bash
edge01.kix01:
----------
ID: netusers_example
Function: netusers.managed
Result: True
Comment: Configuration updated!
Started: 11:03:31.957725
Duration: 1220.435 ms
Changes:
----------
added:
----------
jonathan:
----------
level:
15
password:
sshkeys:
- ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDcgxE6HZF/xjFtIt0thEDKPjFJxW9BpZtTVstYbDgG
R9zPkHGZJT/j345jk345jk453jk43545j35nl3kln34n5kl4ghv3/JzWt/0Js5KZp/51KRNCs9O4t07qao
qwpLB15GwLfEXBx9dW26zc4O+hi6754trxcfghvjbo98765drt/LYIEg0KSQPWyJEK1g31gacbxN7Ab006
xeHh7rv7HtXF6zH3WIdUhq9rtdUag6kYnv6qvjG7sbCyHGYu5vZB7GytnNuVNbZuI+RdFvmHSnErV9HCu9
xZBq6DBb+sESMS4s7nFcsruMoedb+BAc3aww0naeWpogjSt+We7y2N
removed:
----------
updated:
----------
martin:
----------
sshkeys:
- ssh-dss AAAAB3NzaC1kc3MAAACBAK9dP3KariMlM/JmFW9rTSm5cXs4nR0+o6fTHP9o+bOLXMBTP8R4
vwWHh0wJPjQmJYafAqZTnlgi0srGjyifFwPtODppDWLCgLe2M4LXnu3OMqknr54w344zPHP3iFwWxHrBrZ
KtCjO8LhbWCa+X528+i87t6r5e4ersdfxgchvjbknlio87t6r5drcfhgjhbknio8976tycv7t86ftyiu87
Oz1nKsKuNzm2csoUQlJtrmRfpjsOPNookmOz5wG0YxhwDmKeo6fWK+ATk1OiP+QT39fn4G77j8o+e4WAwx
M570s35Of/vV0zoOccj753sXnpvJenvwpM2H6o3a9ALvehAJKWodAgZT7X8+iu786r5drtycghvjbiu78t
+wAAAIBURwSPZVElXe+9a43sF6M4ysT7Xv+6wTsa8q86E3+RYyu8O2ObI2kwNLC3/HTgFniE/YqRG+WJac
81/VHWQNP822gns8RVrWKjqBktmQoEm7z5yy0bkjui78675dytcghvjkoi9y7t867ftcuvhbuu9t78gy/v
+zvMmv8KvQgHg
admin:
----------
level:
15
restricted:
----------
level:
1
Summary for edge01.kix01
------------
Succeeded: 1 (changed=1)
Failed: 0
------------
Total states run: 1
Total run time: 1.220 s
u u nameu changesu resultu commentu- Please provide a valid configuration: {error}t erroru/ Cannot retrieve users from the device: {reason}t reasonu outu# Users already configured as needed.u addu updateu removeu addedu updatedu removedu testu, Testing mode: configuration was not changed!u$ Cannot configure new users: {reason}u/ Cannot update the users configuration: {reason}u Cannot remove users: {reason}u net.config_controlu Configuration updated!N( R R R R$ R R R R R R7 R t NoneR9 R: R; R ( t nameR t defaultst resultt commentt changest retR R" t messaget users_outputR- R, t users_to_addt users_to_updatet users_to_removet expected_config_changet successfully_changedt _sett _updatet _deletet
config_resultt config_comment( ( s8 /usr/lib/python2.7/site-packages/salt/states/netusers.pyt managed� s� �
( t __doc__t
__future__R R R t loggingt getLoggert __name__t logt copyR t jsonR R t salt.extR t salt.utils.napalmR R R R R R R$ R7 R9 R: R; R> RQ ( ( ( s8 /usr/lib/python2.7/site-packages/salt/states/netusers.pyt <module> s$
(
Mini Shell