Current File : //lib/python2.7/site-packages/salt/modules/napalm_snmp.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 d d d d e e d
� � Z e d d d d e e d � � Z d S(
u�
NAPALM SNMP
===========
Manages SNMP on network devices.
:codeauthor: Mircea Ulinic <mircea@cloudflare.com>
:maturity: new
:depends: napalm
:platform: unix
Dependencies
------------
- :mod:`NAPALM proxy minion <salt.proxy.napalm>`
- :mod:`NET basic features <salt.modules.napalm_network>`
.. seealso::
:mod:`SNMP configuration management state <salt.states.netsnmp>`
.. versionadded:: 2016.11.0
i ( t absolute_importt unicode_literalst print_functionN( t proxy_napalm_wrapu snmpu napalmu napalm_snmpc 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_snmp.pyt __virtual__/ s c K@ s t j j j t d i � S( ur
Returns the SNMP configuration
CLI Example:
.. code-block:: bash
salt '*' snmp.config
u get_snmp_information( R R R t callt
napalm_device( t kwargs( ( s< /usr/lib/python2.7/site-packages/salt/modules/napalm_snmp.pyt config> s
c K@ s i d d 6| d 6| d 6} | r. | | d <n | rA | | d <n | rT | | d <n | rg | | d <n t | d <t d
| � S( u7
Removes a configuration element from the SNMP configuration.
:param chassis_id: (optional) Chassis ID
:param community: (optional) A dictionary having the following optional keys:
- acl (if any policy / ACL need to be set)
- mode: rw or ro. Default: ro
:param contact: Contact details
:param location: Location
: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 '*' snmp.remove_config community='abcd'
u delete_snmp_configu
template_nameu testu commitu
chassis_idu communityu contactu locationu inherit_napalm_deviceu net.load_template( R
t __salt__( t
chassis_idt communityt contactt locationt testt commitR t dic( ( s< /usr/lib/python2.7/site-packages/salt/modules/napalm_snmp.pyt
remove_configS s 2
c K@ s i d d 6| d 6| d 6} | r. | | d <n | rA | | d <n | rT | | d <n | rg | | d <n t | d <t d
| � S( u�
Updates the SNMP configuration.
:param chassis_id: (optional) Chassis ID
:param community: (optional) A dictionary having the following optional keys:
- acl (if any policy / ACL need to be set)
- mode: rw or ro. Default: ro
:param contact: Contact details
:param location: Location
: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 'edge01.lon01' snmp.update_config location="Greenwich, UK" test=True
Output example (for the CLI example above):
.. code-block:: yaml
edge01.lon01:
----------
already_configured:
False
comment:
Configuration discarded.
diff:
[edit snmp]
- location "London, UK";
+ location "Greenwich, UK";
result:
True
u snmp_configu
template_nameu testu commitu
chassis_idu communityu contactu locationu inherit_napalm_deviceu net.load_template( R
R ( R R R R R R R R ( ( s< /usr/lib/python2.7/site-packages/salt/modules/napalm_snmp.pyt
update_config� s =
( u napalm_snmp( 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 Nonet Falset TrueR R ( ( ( s< /usr/lib/python2.7/site-packages/salt/modules/napalm_snmp.pyt <module> s0 ?
Mini Shell