Current File : //lib/python2.7/site-packages/salt/grains/napalm.pyo
�
���^c @@ sI 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 Z
d Z d g Z
i a i a d d g Z d � Z d d � Z d d � Z d d
� Z d d � Z d d � Z d d
� Z d d � Z d d � Z d d � Z d d � Z d d � Z d d � Z d d � Z d d � Z d d � Z! d d � Z" d S( u�
NAPALM Grains
=============
:codeauthor: Mircea Ulinic <mircea@cloudflare.com>
:maturity: new
:depends: napalm
:platform: unix
Dependencies
------------
- :mod:`NAPALM proxy module <salt.proxies.napalm>`
.. versionadded:: 2016.11.0
i ( t absolute_importt print_functiont unicode_literalsNu napalmu secretu enable_passwordc 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__( ( ( s6 /usr/lib/python2.7/site-packages/salt/grains/napalm.pyt __virtual__4 s c C@ sr t sn | r1 t j j j t � r1 | d � a qn | rn t j j j t � rn t j j j t d i � a qn n t S( uM
Retrieves the grains from the network device if not cached already.
u napalm.get_grainsu get_facts( t GRAINS_CACHER R R t is_proxyR t is_miniont callt DEVICE_CACHE( t proxy( ( s6 /usr/lib/python2.7/site-packages/salt/grains/napalm.pyt _retrieve_grains_cache? s c C@ s{ t sw | r@ t j j j t � r@ d | k rt | d � a qt qw | rw t j j j t � rw t j j j t � a qw n t S( uA
Loads the network device details if not cached already.
u napalm.get_device( R R R R R R R
t
get_device( R ( ( s6 /usr/lib/python2.7/site-packages/salt/grains/napalm.pyt _retrieve_device_cacheR s c C@ sM t d | � } | j d t � rI | j d i � rI | j d � j | � Sd S( u?
Retrieves the grain value from the cached dictionary.
R u resultu outN( R t gett False( t nameR t grains( ( s6 /usr/lib/python2.7/site-packages/salt/grains/napalm.pyt
_get_grainb s $c C@ s" t d | � } | j | j � � S( u+
Retrieves device-specific grains.
R ( R R t upper( R R t device( ( s6 /usr/lib/python2.7/site-packages/salt/grains/napalm.pyt _get_device_graink s c C@ s i t d d | �d 6S( u�
Returns the Operating System name running on the network device.
Example: junos, iosxr, eos, ios etc.
CLI Example - select all network devices running JunOS:
.. code-block:: bash
salt -G 'os:junos' test.ping
u driver_nameR u os( R ( R ( ( s6 /usr/lib/python2.7/site-packages/salt/grains/napalm.pyt getosw s c C@ s i t d d | �d 6S( u�
Returns the OS version.
Example: 13.3R6.5, 6.0.2 etc.
CLI Example - select all network devices running JunOS 13.3R6.5 and return the model:
.. code-block:: bash
salt -G 'os:junos and version:13.3R6.5' grains.get model
Output:
.. code-block:: yaml
edge01.bjm01:
MX2000
edge01.sjc01:
MX960
edge01.mrs01:
MX480
edge01.muc01:
MX240
u
os_versionR u version( R ( R ( ( s6 /usr/lib/python2.7/site-packages/salt/grains/napalm.pyt version� s c C@ s i t d d | �d 6S( u
Returns the network device chassis model.
Example: MX480, ASR-9904-AC etc.
CLI Example - select all Juniper MX480 routers and execute traceroute to 8.8.8.8:
.. code-block:: bash
salt -G 'model:MX480' net.traceroute 8.8.8.8
u modelR ( R ( R ( ( s6 /usr/lib/python2.7/site-packages/salt/grains/napalm.pyt model� s c C@ s i t d d | �d 6S( u�
Returns the chassis serial number.
Example: FOX1234W00F
CLI Example - select all devices whose serial number begins with `FOX` and display the serial number value:
.. code-block:: bash
salt -G 'serial:FOX*' grains.get serial
Output:
.. code-block:: yaml
edge01.icn01:
FOXW00F001
edge01.del01:
FOXW00F002
edge01.yyz01:
FOXW00F003
edge01.mrs01:
FOXW00F004
u
serial_numberR u serial( R ( R ( ( s6 /usr/lib/python2.7/site-packages/salt/grains/napalm.pyt serial� s c C@ s i t d d | �d 6S( u�
Returns the network device vendor.
Example: juniper, cisco, arista etc.
CLI Example - select all devices produced by Cisco and shutdown:
.. code-block:: bash
salt -G 'vendor:cisco' net.cli "shut"
u vendorR ( R ( R ( ( s6 /usr/lib/python2.7/site-packages/salt/grains/napalm.pyt vendor� s c C@ s i t d d | �d 6S( u�
Returns the uptime in seconds.
CLI Example - select all devices started/restarted within the last hour:
.. code-block:: bash
salt -G 'uptime<3600' test.ping
u uptimeR ( R ( R ( ( s6 /usr/lib/python2.7/site-packages/salt/grains/napalm.pyt uptime� s
c C@ s i t d d | �d 6S( uK
Returns the complete interfaces list of the network device.
Example: ['lc-0/0/0', 'pfe-0/0/0', 'xe-1/3/0', 'lo0', 'irb', 'demux0', 'fxp0']
CLI Example - select all devices that have a certain interface, e.g.: xe-1/1/1:
.. code-block:: bash
salt -G 'interfaces:xe-1/1/1' test.ping
Output:
.. code-block:: yaml
edge01.yyz01:
True
edge01.maa01:
True
edge01.syd01:
True
edge01.del01:
True
edge01.dus01:
True
edge01.kix01:
True
u interface_listR u
interfaces( R ( R ( ( s6 /usr/lib/python2.7/site-packages/salt/grains/napalm.pyt
interfaces� s c C@ s6 | r2 t j j j t � r2 i t d d | �d 6Sd S( uA
Return the username.
.. versionadded:: 2017.7.0
CLI Example - select all devices using `foobar` as username for connection:
.. code-block:: bash
salt -G 'username:foobar' test.ping
Output:
.. code-block::yaml
device1:
True
device2:
True
u usernameR N( R R R R R R ( R ( ( s6 /usr/lib/python2.7/site-packages/salt/grains/napalm.pyt username s c C@ s i t d d | �d 6S( u@
Return the hostname as configured on the network device.
CLI Example:
.. code-block:: bash
salt 'device*' grains.get hostname
Output:
.. code-block:: yaml
device1:
edge01.yyz01
device2:
edge01.bjm01
device3:
edge01.flw01
u hostnameR ( R ( R ( ( s6 /usr/lib/python2.7/site-packages/salt/grains/napalm.pyt hostname$ s c C@ s6 | r2 t j j j t � r2 i t d d | �d 6Sd S( u]
This grain is set by the NAPALM grain module
only when running in a proxy minion.
When Salt is installed directly on the network device,
thus running a regular minion, the ``host`` grain
provides the physical hostname of the network device,
as it would be on an ordinary minion server.
When running in a proxy minion, ``host`` points to the
value configured in the pillar: :mod:`NAPALM proxy module <salt.proxy.napalm>`.
.. note::
The diference between ``host`` and ``hostname`` is that
``host`` provides the physical location - either domain name or IP address,
while ``hostname`` provides the hostname as configured on the device.
They are not necessarily the same.
.. versionadded:: 2017.7.0
CLI Example:
.. code-block:: bash
salt 'device*' grains.get host
Output:
.. code-block:: yaml
device1:
ip-172-31-13-136.us-east-2.compute.internal
device2:
ip-172-31-11-193.us-east-2.compute.internal
device3:
ip-172-31-2-181.us-east-2.compute.internal
u hostnameR u hostN( R R R R R R ( R ( ( s6 /usr/lib/python2.7/site-packages/salt/grains/napalm.pyt host< s %c C@ s� t j d t � s d St d | � } | r� | d } i i g d 6g d 6d 6} t j j j | d � } | r | | d d <n t j j j | d � } | r� | | d d <n | Sd S( u�
Return the DNS information of the host.
This grain is a dictionary having two keys:
- ``A``
- ``AAAA``
.. note::
This grain is disabled by default, as the proxy startup may be slower
when the lookup fails.
The user can enable it using the ``napalm_host_dns_grain`` option (in
the pillar or proxy configuration file):
.. code-block:: yaml
napalm_host_dns_grain: true
.. versionadded:: 2017.7.0
CLI Example:
.. code-block:: bash
salt 'device*' grains.get host_dns
Output:
.. code-block:: yaml
device1:
A:
- 172.31.9.153
AAAA:
- fd52:188c:c068::1
device2:
A:
- 172.31.46.249
AAAA:
- fdca:3b17:31ab::17
device3:
A:
- 172.31.8.167
AAAA:
- fd0f:9fd6:5fab::1
u napalm_host_dns_grainNR u hostu Au AAAAu host_dns( R R R R% R R t dnst lookup( R t device_hostt device_host_valuet host_dns_rett dns_at dns_aaaa( ( s6 /usr/lib/python2.7/site-packages/salt/grains/napalm.pyt host_dnsg s .
c C@ sS t d d | �p i } | rH t rH x! t D] } | j | d � q+ Wn i | d 6S( u�
Return the connection optional args.
.. note::
Sensible data will not be returned.
.. versionadded:: 2017.7.0
CLI Example - select all devices connecting via port 1234:
.. code-block:: bash
salt -G 'optional_args:port:1234' test.ping
Output:
.. code-block:: yaml
device1:
True
device2:
True
u
optional_argsR N( R t _FORBIDDEN_OPT_ARGSt popt None( R t opt_argst arg( ( s6 /usr/lib/python2.7/site-packages/salt/grains/napalm.pyt
optional_args� s
(# t __doc__t
__future__R R R t loggingt getLoggert __name__t logt salt.utils.dnsR t salt.utils.napalmR t __proxyenabled__R R R. R
R0 R R R R R R R R R R! R" R# R$ R% R- R3 ( ( ( s6 /usr/lib/python2.7/site-packages/salt/grains/napalm.pyt <module> s8
+ B
Mini Shell