valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-08 17:33:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix documentation

Browse Source
This commit is contained in:
rajvidhimar 2017-02-01 16:05:08 +05:30
parent eabc590ed7
commit 061ae302f0
2 changed files with 19 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
salt/modules/junos.py
View File

@ -4,8 +4,6 @@ Module to interact with Junos devices.
''' '''
# Import python libraries # Import python libraries
from __future__ import absolute_import
from __future__ import print_function
import logging import logging
import json import json
import os import os
@ -121,9 +119,9 @@ def rpc(cmd=None, dest=None, format='xml', **kwargs):
.. code-block:: bash .. code-block:: bash
salt 'device' junos.rpc 'get_config' dest='/var/log/config.txt' format='text' filter='<configuration><system/></configuration>' salt 'device' junos.rpc 'get_config' '/var/log/config.txt' 'text' filter='<configuration><system/></configuration>'
salt 'device' junos.rpc 'get-interface-information' dest='/home/user/interface.xml' interface_name='lo0' terse=True salt 'device' junos.rpc 'get-interface-information' '/home/user/interface.xml' interface_name='lo0' terse=True
salt 'device' junos.rpc 'get-chassis-inventory' salt 'device' junos.rpc 'get-chassis-inventory'
@ -166,7 +164,6 @@ def rpc(cmd=None, dest=None, format='xml', **kwargs):
op.update(kwargs['__pub_arg'][-1]) op.update(kwargs['__pub_arg'][-1])
else: else:
op.update(kwargs) op.update(kwargs)
if dest is None and format != 'xml': if dest is None and format != 'xml':
log.warning( log.warning(
'Format ignored as it is only used for \ 'Format ignored as it is only used for \
@ -237,7 +234,7 @@ def set_hostname(hostname=None, **kwargs):
.. code-block:: bash .. code-block:: bash
salt 'device_name' junos.set_hostname hostname=salt-device salt 'device_name' junos.set_hostname salt-device
Parameters: Parameters:
Required Required
@ -406,7 +403,7 @@ def rollback(id=0, **kwargs):
.. code-block:: bash .. code-block:: bash
salt 'device_name' junos.rollback id=10 salt 'device_name' junos.rollback 10
Parameters: Parameters:
Optional Optional
@ -492,7 +489,7 @@ def diff(id=0):
.. code-block:: bash .. code-block:: bash
salt 'device_name' junos.diff id=3 salt 'device_name' junos.diff 3
Parameters: Parameters:
@ -522,9 +519,9 @@ def ping(dest_ip=None, **kwargs):
.. code-block:: bash .. code-block:: bash
salt 'device_name' junos.ping dest_ip='8.8.8.8' count=5 salt 'device_name' junos.ping '8.8.8.8' count=5
salt 'device_name' junos.ping dest_ip='8.8.8.8' ttl=1 rapid=True salt 'device_name' junos.ping '8.8.8.8' ttl=1 rapid=True
Parameters: Parameters:
@ -591,11 +588,11 @@ def cli(command=None, format='text', **kwargs):
.. code-block:: bash .. code-block:: bash
salt 'device_name' junos.cli command='show system commit' salt 'device_name' junos.cli 'show system commit'
salt 'device_name' junos.cli command='show version' dev_timeout=40 salt 'device_name' junos.cli 'show version' dev_timeout=40
salt 'device_name' junos.cli command='show system alarms' format='xml' dest=/home/user/cli_output.txt salt 'device_name' junos.cli 'show system alarms' format='xml' dest=/home/user/cli_output.txt
Parameters: Parameters:
@ -725,11 +722,11 @@ def install_config(path=None, **kwargs):
.. code-block:: bash .. code-block:: bash
salt 'device_name' junos.install_config path='salt://production/network/routers/config.set' salt 'device_name' junos.install_config 'salt://production/network/routers/config.set'
salt 'device_name' junos.install_config path='salt://templates/replace_config.conf' replace=True comment='Committed via SaltStack' salt 'device_name' junos.install_config 'salt://templates/replace_config.conf' replace=True comment='Committed via SaltStack'
salt 'device_name' junos.install_config path='salt://my_new_configuration.conf' dev_timeout=300 diffs_file='/salt/confs/old_config.conf' overwrite=True salt 'device_name' junos.install_config 'salt://my_new_configuration.conf' dev_timeout=300 diffs_file='/salt/confs/old_config.conf' overwrite=True
Parameters: Parameters:
@ -916,9 +913,9 @@ def install_os(path=None, **kwargs):
.. code-block:: bash .. code-block:: bash
salt 'device_name' junos.install_os path='/home/user/junos_image.tgz' reboot=True salt 'device_name' junos.install_os '/home/user/junos_image.tgz' reboot=True
salt 'device_name' junos.install_os path='/home/user/junos_16_1.tgz' dev_timeout=300 salt 'device_name' junos.install_os '/home/user/junos_16_1.tgz' dev_timeout=300
Parameters: Parameters:
@ -961,7 +958,7 @@ def install_os(path=None, **kwargs):
op.update(kwargs) op.update(kwargs)
try: try:
install = conn.sw.install(path, progress=True) conn.sw.install(path, progress=True)
ret['message'] = 'Installed the os.' ret['message'] = 'Installed the os.'
except Exception as exception: except Exception as exception:
ret['message'] = 'Installation failed due to : "{0}"'.format(exception) ret['message'] = 'Installation failed due to : "{0}"'.format(exception)
@ -970,7 +967,7 @@ def install_os(path=None, **kwargs):
if 'reboot' in op and op['reboot'] is True: if 'reboot' in op and op['reboot'] is True:
try: try:
rbt = conn.sw.reboot() conn.sw.reboot()
except Exception as exception: except Exception as exception:
ret['message'] = 'Installation successful but \ ret['message'] = 'Installation successful but \
reboot failed due to : "{0}"'.format( reboot failed due to : "{0}"'.format(
@ -990,7 +987,7 @@ def file_copy(src=None, dest=None, **kwargs):
.. code-block:: bash .. code-block:: bash
salt 'device_name' junos.file_copy src=/home/m2/info.txt dest=info_copy.txt salt 'device_name' junos.file_copy /home/m2/info.txt info_copy.txt
Parameters: Parameters:

3
salt/states/junos.py
View File

@ -6,7 +6,7 @@ State modules to interact with Junos devices.
State module to connect the junos devices connected via a junos proxy. State module to connect the junos devices connected via a junos proxy.
Refer to :mod:`junos <salt.proxy.junos>` for information on connecting to junos proxy. Refer to :mod:`junos <salt.proxy.junos>` for information on connecting to junos proxy.
''' '''
from __future__ import absolute_import
import logging import logging
log = logging.getLogger() log = logging.getLogger()
@ -48,7 +48,6 @@ def rpc(name, dest=None, format='xml', args=None, **kwargs):
Name of the interface whose information you want. Name of the interface whose information you want.
''' '''
ret = {'name': name, 'changes': {}, 'result': True, 'comment': ''} ret = {'name': name, 'changes': {}, 'result': True, 'comment': ''}
if args is not None: if args is not None:
ret['changes'] = __salt__['junos.rpc']( ret['changes'] = __salt__['junos.rpc'](
name, name,