@ -19,58 +19,82 @@
from __future__ import ( absolute_import , division , print_function )
__metaclass__ = type
DOCUMENTATION = """
- - -
author : Ansible Networking Team
cliconf : eos
short_description : Use eos cliconf to run command on eos platform
description :
- This eos plugin provides low level abstraction api ' s for
sending and receiving CLI commands from eos network devices .
version_added : " 2.7 "
options :
eos_use_sessions :
type : int
default : 1
description :
- Specifies if sessions should be used on remote host or not
env :
- name : ANSIBLE_EOS_USE_SESSIONS
vars :
- name : ansible_eos_use_sessions
version_added : ' 2.7 '
"""
import collections
import json
import time
from itertools import chain
from ansible . errors import AnsibleConnectionFailure
from ansible . module_utils . _text import to_bytes
from ansible . module_utils . _text import to_text
from ansible . module_utils . network . common . utils import to_list
from ansible . module_utils . network . common . config import NetworkConfig , dumps
from ansible . plugins . cliconf import CliconfBase , enable_mode
from ansible . plugins . connection . network_cli import Connection as NetworkCli
from ansible . plugins . connection . httpapi import Connection as HttpApi
class Cliconf ( CliconfBase ) :
def send_command ( self , command , prompt = None , answer = None , sendonly = False , newline = True , prompt_retry_check = False ) :
def __init__ ( self , * args , * * kwargs ) :
super ( Cliconf , self ) . __init__ ( * args , * * kwargs )
self . _session_support = None
if isinstance ( self . _connection , NetworkCli ) :
self . network_api = ' network_cli '
elif isinstance ( self . _connection , HttpApi ) :
self . network_api = ' eapi '
else :
raise ValueError ( " Invalid connection type " )
def _get_command_with_output ( self , command , output ) :
options_values = self . get_option_values ( )
if output not in options_values [ ' output ' ] :
raise ValueError ( " ' output ' value %s is invalid. Valid values are %s " % ( output , ' , ' . join ( options_values [ ' output ' ] ) ) )
if output == ' json ' and not command . endswith ( ' | json ' ) :
cmd = ' %s | json ' % command
else :
cmd = command
return cmd
def send_command ( self , command , * * kwargs ) :
""" Executes a cli command and returns the results
This method will execute the CLI command on the connection and return
the results to the caller . The command output will be returned as a
string
"""
kwargs = { ' command ' : to_bytes ( command ) , ' sendonly ' : sendonly ,
' newline ' : newline , ' prompt_retry_check ' : prompt_retry_check }
if prompt is not None :
kwargs [ ' prompt ' ] = to_bytes ( prompt )
if answer is not None :
kwargs [ ' answer ' ] = to_bytes ( answer )
if isinstance ( self . _connection , NetworkCli ) :
resp = self . _connection . send ( * * kwargs )
if self . network_api == ' network_cli ' :
resp = super ( Cliconf , self ) . send_command ( command , * * kwargs )
else :
resp = self . _connection . send_request ( command , * * kwargs )
return resp
def get_device_info ( self ) :
device_info = { }
device_info [ ' network_os ' ] = ' eos '
reply = self . get ( ' show version | json ' )
data = json . loads ( reply )
device_info [ ' network_os_version ' ] = data [ ' version ' ]
device_info [ ' network_os_model ' ] = data [ ' modelName ' ]
reply = self . get ( ' show hostname | json ' )
data = json . loads ( reply )
device_info [ ' network_os_hostname ' ] = data [ ' hostname ' ]
return device_info
@enable_mode
def get_config ( self , source = ' running ' , format = ' text ' , flags = None ) :
def get_config ( self , source = ' running ' , format = ' text ' , filter = None ) :
options_values = self . get_option_values ( )
if format not in options_values [ ' format ' ] :
raise ValueError ( " ' format ' value %s is invalid. Valid values are %s " % ( format , ' , ' . join ( options_values [ ' format ' ] ) ) )
lookup = { ' running ' : ' running-config ' , ' startup ' : ' startup-config ' }
if source not in lookup :
return self . invalid_params ( " fetching configuration from %s is not supported " % source )
@ -79,60 +103,112 @@ class Cliconf(CliconfBase):
if format and format is not ' text ' :
cmd + = ' | %s ' % format
cmd + = ' ' . join ( to_list ( flags ) )
cmd + = ' ' . join ( to_list ( filter ) )
cmd = cmd . strip ( )
return self . send_command ( cmd )
@enable_mode
def edit_config ( self , command ) :
for cmd in chain ( [ ' configure ' ] , to_list ( command ) , [ ' end ' ] ) :
self . send_command ( cmd )
def edit_config ( self , candidate = None , commit = True , replace = False , comment = None ) :
def get ( self , command , prompt = None , answer = None , sendonly = False ) :
return self . send_command ( command , prompt = prompt , answer = answer , sendonly = sendonly )
if not candidate :
raise ValueError ( " must provide a candidate config to load " )
def get_capabilities ( self ) :
result = { }
result [ ' rpc ' ] = self . get_base_rpc ( )
result [ ' device_info ' ] = self . get_device_info ( )
if isinstance ( self . _connection , NetworkCli ) :
result [ ' network_api ' ] = ' cliconf '
else :
result [ ' network_api ' ] = ' eapi '
return json . dumps ( result )
if commit not in ( True , False ) :
raise ValueError ( " ' commit ' must be a bool, got %s " % commit )
# Imported from module_utils
def close_session ( self , session ) :
# to close session gracefully execute abort in top level session prompt.
self . get ( ' end ' )
self . get ( ' configure session %s ' % session )
self . get ( ' abort ' )
operations = self . get_device_operations ( )
if replace not in ( True , False ) :
raise ValueError ( " ' replace ' must be a bool, got %s " % replace )
def run_commands ( self , commands , check_rc = True ) :
""" Run list of commands on remote device and return results
"""
responses = list ( )
multiline = False
if replace and not operations [ ' supports_replace ' ] :
raise ValueError ( " configuration replace is supported only with configuration session " )
for cmd in to_list ( commands ) :
if isinstance ( cmd , dict ) :
command = cmd [ ' command ' ]
prompt = cmd [ ' prompt ' ]
answer = cmd [ ' answer ' ]
else :
command = cmd
prompt = None
answer = None
if comment and not operations [ ' supports_commit_comment ' ] :
raise ValueError ( " commit comment is not supported " )
if ( commit is False ) and ( not self . supports_sessions ) :
raise ValueError ( ' check mode is not supported without configuration session ' )
response = { }
session = None
if self . supports_sessions :
session = ' ansible_ %s ' % int ( time . time ( ) )
response . update ( { ' session ' : session } )
self . send_command ( ' configure session %s ' % session )
if replace :
self . send_command ( ' rollback clean-config ' )
else :
self . send_command ( ' configure ' )
results = [ ]
multiline = False
for line in to_list ( candidate ) :
if not isinstance ( line , collections . Mapping ) :
line = { ' command ' : line }
if command == ' end ' :
cmd = line [ ' command ' ]
if cmd == ' end ' :
continue
elif command . startswith ( ' banner ' ) or multiline :
elif c md. startswith ( ' banner ' ) or multiline :
multiline = True
elif command == ' EOF ' and multiline :
elif c md == ' EOF ' and multiline :
multiline = False
if multiline :
line [ ' sendonly ' ] = True
if cmd != ' end ' and cmd [ 0 ] != ' ! ' :
try :
results . append ( self . send_command ( * * line ) )
except AnsibleConnectionFailure as e :
self . discard_changes ( session )
raise AnsibleConnectionFailure ( e . message )
response [ ' response ' ] = results
if self . supports_sessions :
out = self . send_command ( ' show session-config diffs ' )
if out :
response [ ' diff ' ] = out . strip ( )
if commit :
self . commit ( )
else :
self . discard_changes ( session )
else :
self . send_command ( ' end ' )
return response
def get ( self , command , prompt = None , answer = None , sendonly = False , output = None ) :
if output :
command = self . _get_command_with_output ( command , output )
return self . send_command ( command , prompt = prompt , answer = answer , sendonly = sendonly )
def commit ( self ) :
self . send_command ( ' commit ' )
def discard_changes ( self , session = None ) :
commands = [ ' end ' ]
if self . supports_sessions :
# to close session gracefully execute abort in top level session prompt.
commands . extend ( [ ' configure session %s ' % session , ' abort ' ] )
for cmd in commands :
self . send_command ( cmd )
def run_commands ( self , commands = None , check_rc = True ) :
if commands is None :
raise ValueError ( " ' commands ' value is required " )
responses = list ( )
for cmd in to_list ( commands ) :
if not isinstance ( cmd , collections . Mapping ) :
cmd = { ' command ' : cmd }
output = cmd . pop ( ' output ' , None )
if output :
cmd [ ' command ' ] = self . _get_command_with_output ( cmd [ ' command ' ] , output )
try :
out = self . get ( command , prompt , answer , multiline )
out = self . send_command( * * cmd )
except AnsibleConnectionFailure as e :
if check_rc :
raise
@ -142,35 +218,106 @@ class Cliconf(CliconfBase):
try :
out = json . loads ( out )
except ValueError :
out = str ( out ) . strip ( )
out = to_text ( out , errors = ' surrogate_or_strict ' ) . strip ( )
responses . append ( out )
return responses
def load_config ( self , commands , commit = False , replace = False ) :
""" Loads the config commands onto the remote device
"""
session = ' ansible_ %s ' % int ( time . time ( ) )
result = { ' session ' : session }
def get_diff ( self , candidate = None , running = None , match = ' line ' , diff_ignore_lines = None , path = None , replace = ' line ' ) :
diff = { }
device_operations = self . get_device_operations ( )
option_values = self . get_option_values ( )
self . get ( ' configure session %s ' % session )
if replace :
self . get ( ' rollback clean-config ' )
if candidate is None and device_operations [ ' supports_generate_diff ' ] :
raise ValueError ( " candidate configuration is required to generate diff " )
try :
self . run_commands ( commands )
except AnsibleConnectionFailure :
self . close_session ( session )
raise
if match not in option_values [ ' diff_match ' ] :
raise ValueError ( " ' match ' value %s in invalid, valid values are %s " % ( match , ' , ' . join ( option_values [ ' diff_match ' ] ) ) )
if replace not in option_values [ ' diff_replace ' ] :
raise ValueError ( " ' replace ' value %s in invalid, valid values are %s " % ( replace , ' , ' . join ( option_values [ ' diff_replace ' ] ) ) )
# prepare candidate configuration
candidate_obj = NetworkConfig ( indent = 3 )
candidate_obj . load ( candidate )
if running and match != ' none ' and replace != ' config ' :
# running configuration
running_obj = NetworkConfig ( indent = 3 , contents = running , ignore_lines = diff_ignore_lines )
configdiffobjs = candidate_obj . difference ( running_obj , path = path , match = match , replace = replace )
out = self . get ( ' show session-config diffs ' )
if out :
result [ ' diff ' ] = out . strip ( )
else :
configdiffobjs = candidate_obj . items
configdiff = dumps ( configdiffobjs , ' commands ' ) if configdiffobjs else ' '
diff [ ' config_diff ' ] = configdiff if configdiffobjs else { }
return diff
@property
def supports_sessions ( self ) :
use_session = self . get_option ( ' eos_use_sessions ' )
try :
use_session = int ( use_session )
except ValueError :
pass
if commit :
self . get ( ' commit ' )
if not bool ( use_session ) :
self . _session_support = False
else :
self . close_session ( session )
if self . _session_support :
return self . _session_support
response = self . get ( ' show configuration sessions ' )
self . _session_support = ' error ' not in response
return self . _session_support
return result
def get_device_info ( self ) :
device_info = { }
device_info [ ' network_os ' ] = ' eos '
reply = self . get ( ' show version | json ' )
data = json . loads ( reply )
device_info [ ' network_os_version ' ] = data [ ' version ' ]
device_info [ ' network_os_model ' ] = data [ ' modelName ' ]
reply = self . get ( ' show hostname | json ' )
data = json . loads ( reply )
device_info [ ' network_os_hostname ' ] = data [ ' hostname ' ]
return device_info
def get_device_operations ( self ) :
return {
' supports_diff_replace ' : True ,
' supports_commit ' : True if self . supports_sessions else False ,
' supports_rollback ' : True if self . supports_sessions else False ,
' supports_defaults ' : False ,
' supports_onbox_diff ' : True if self . supports_sessions else False ,
' supports_commit_comment ' : False ,
' supports_multiline_delimiter ' : False ,
' support_diff_match ' : True ,
' support_diff_ignore_lines ' : True ,
' supports_generate_diff ' : True ,
' supports_replace ' : True if self . supports_sessions else False
}
def get_option_values ( self ) :
return {
' format ' : [ ' text ' , ' json ' ] ,
' diff_match ' : [ ' line ' , ' strict ' , ' exact ' , ' none ' ] ,
' diff_replace ' : [ ' line ' , ' block ' , ' config ' ] ,
' output ' : [ ' text ' , ' json ' ]
}
def get_capabilities ( self ) :
result = { }
result [ ' rpc ' ] = self . get_base_rpc ( )
result [ ' device_info ' ] = self . get_device_info ( )
result [ ' network_api ' ] = self . network_api
result [ ' device_info ' ] = self . get_device_info ( )
result [ ' device_operations ' ] = self . get_device_operations ( )
result . update ( self . get_option_values ( ) )
return json . dumps ( result )
Ganesh Nalawade
6 years ago
committed by