Current File : //usr/lib/python2.7/site-packages/salt/modules/napalm_users.pyc
�
���^c @@ s� d Z d d l m Z m Z m Z d d l Z e j e � Z d d l Z
d d l m Z d Z d g Z
d Z d � Z e d � � Z e e e d
� � Z e e e d � � Z d S(
ur
NAPALM Users
============
Manages the configuration of the users on network devices.
:codeauthor: Mircea Ulinic <mircea@cloudflare.com>
:maturity: new
:depends: napalm
:platform: unix
Dependencies
------------
- :mod:`NAPALM proxy minion <salt.proxy.napalm>`
.. seealso::
:mod:`Users management state <salt.states.netusers>`
.. versionadded:: 2016.11.0
i ( t absolute_importt unicode_literalst print_functionN( t proxy_napalm_wrapu usersu napalmu napalm_usersc 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__( ( ( s= /usr/lib/python2.7/site-packages/salt/modules/napalm_users.pyt __virtual__. s c K@ s t j j j t d i � S( u�
Returns the configuration of the users on the device
CLI Example:
.. code-block:: bash
salt '*' users.config
Output example:
.. code-block:: python
{
'mircea': {
'level': 15,
'password': '$1$0P70xKPa$4jt5/10cBTckk6I/w/',
'sshkeys': [
'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC4pFn+shPwTb2yELO4L7NtQrKOJXNeCl1je l9STXVaGnRAnuc2PXl35vnWmcUq6YbUEcgUTRzzXfmelJKuVJTJIlMXii7h2xkbQp0YZIEs4P 8ipwnRBAxFfk/ZcDsN3mjep4/yjN56ejk345jhk345jk345jk341p3A/9LIL7l6YewLBCwJj6 D+fWSJ0/YW+7oH17Fk2HH+tw0L5PcWLHkwA4t60iXn16qDbIk/ze6jv2hDGdCdz7oYQeCE55C CHOHMJWYfN3jcL4s0qv8/u6Ka1FVkV7iMmro7ChThoV/5snI4Ljf2wKqgHH7TfNaCfpU0WvHA nTs8zhOrGScSrtb mircea@master-roshi'
]
}
}
u get_users( R R R t callt
napalm_device( t kwargs( ( s= /usr/lib/python2.7/site-packages/salt/modules/napalm_users.pyt config= s c
K@ s& t d d d | d | d | d t �S( u[
Configures users on network devices.
:param users: Dictionary formatted as the output of the function config()
:param test: Dry run? If set as True, will apply the config, discard and
return the changes. Default: False
:param commit: Commit? (default: True) Sometimes it is not needed to commit
the config immediately after loading the changes. E.g.: a state loads a
couple of parts (add / remove / update) and would not be optimal to
commit after each operation. Also, from the CLI when the user needs to
apply the similar changes before committing, can specify commit=False
and will not discard the config.
:raise MergeConfigException: If there is an error on the configuration sent.
:return a dictionary having the following keys:
- result (bool): if the config was applied successfully. It is `False` only
in case of failure. In case there are no changes to be applied and
successfully performs all operations it is still `True` and so will be
the `already_configured` flag (example below)
- comment (str): a message for the user
- already_configured (bool): flag to check if there were no changes applied
- diff (str): returns the config changes applied
CLI Example:
.. code-block:: bash
salt '*' users.set_users "{'mircea': {}}"
u net.load_templateu set_userst userst testt committ inherit_napalm_device( t __salt__R
( R R R R ( ( s= /usr/lib/python2.7/site-packages/salt/modules/napalm_users.pyt set_userse s
$
c
K@ s& t d d d | d | d | d t �S( uy
Removes users from the configuration of network devices.
:param users: Dictionary formatted as the output of the function config()
:param test: Dry run? If set as True, will apply the config, discard and return the changes. Default: False
:param commit: Commit? (default: True) Sometimes it is not needed to commit the config immediately
after loading the changes. E.g.: a state loads a couple of parts (add / remove / update)
and would not be optimal to commit after each operation.
Also, from the CLI when the user needs to apply the similar changes before committing,
can specify commit=False and will not discard the config.
:raise MergeConfigException: If there is an error on the configuration sent.
:return a dictionary having the following keys:
- result (bool): if the config was applied successfully. It is `False`
only in case of failure. In case there are no changes to be applied
and successfully performs all operations it is still `True` and so
will be the `already_configured` flag (example below)
- comment (str): a message for the user
- already_configured (bool): flag to check if there were no changes applied
- diff (str): returns the config changes applied
CLI Example:
.. code-block:: bash
salt '*' users.delete_users "{'mircea': {}}"
u net.load_templateu delete_usersR R R R ( R R
( R R R R ( ( s= /usr/lib/python2.7/site-packages/salt/modules/napalm_users.pyt delete_users� s
( u napalm_users( t __doc__t
__future__R R R t loggingt getLoggerR
t logt salt.utils.napalmR R R t __proxyenabled__t __virtual_aliases__R R t Falset TrueR R ( ( ( s= /usr/lib/python2.7/site-packages/salt/modules/napalm_users.pyt <module> s (*
Mini Shell