VhWddlmZmZmZeZdZdZddlZddl Z ddl Z ddl m Z ddl mZddlmZddlmZdd lmZmZdd lmZdd lmZmZGd d eZy))absolute_importdivisionprint_functiona author: - Ansible Networking Team (@ansible-network) name: ios short_description: Use ios cliconf to run command on Cisco IOS platform description: - This ios plugin provides low level abstraction apis for sending and receiving CLI commands from Cisco IOS network devices. version_added: 1.0.0 options: commit_confirm_immediate: type: boolean default: false description: - Enable or disable commit confirm mode. - Confirms the configuration pushed after a custom/ default timeout.(default 1 minute). - For custom timeout configuration set commit_confirm_timeout value. - On commit_confirm_immediate default value for commit_confirm_timeout is considered 1 minute when variable in not explicitly declared. env: - name: ANSIBLE_IOS_COMMIT_CONFIRM_IMMEDIATE vars: - name: ansible_ios_commit_confirm_immediate commit_confirm_timeout: type: int description: - Commits the configuration on a trial basis for the time specified in minutes. - Using commit_confirm_timeout without specifying commit_confirm_immediate would need an explicit C(configure confirm) using the ios_command module to confirm/commit the changes made. - Refer to example for a use case demonstration. env: - name: ANSIBLE_IOS_COMMIT_CONFIRM_TIMEOUT vars: - name: ansible_ios_commit_confirm_timeout config_commands: description: - Specifies a list of commands that can make configuration changes to the target device. - When `ansible_network_single_user_mode` is enabled, if a command sent to the device is present in this list, the existing cache is invalidated. version_added: 2.0.0 type: list elements: str default: [] vars: - name: ansible_ios_config_commands a  # NOTE - IOS waits for a `configure confirm` when the configure terminal # command executed is `configure terminal revert timer ` within the timeout # period for the configuration to commit successfully, else a rollback # happens. # Use commit confirm with timeout and confirm the commit explicitly - name: Example commit confirmed vars: ansible_ios_commit_confirm_timeout: 1 tasks: - name: "Commit confirmed with timeout" cisco.ios.ios_hostname: state: merged config: hostname: R1 - name: "Confirm the Commit" cisco.ios.ios_command: commands: - configure confirm # Commands fired # - configure terminal revert timer 1 (cliconf specific) # - hostname R1 (from hostname resource module) # - configure confirm (from ios_command module) # Use commit confirm with timeout and confirm the commit via cliconf - name: Example commit confirmed vars: ansible_ios_commit_confirm_immediate: True ansible_ios_commit_confirm_timeout: 3 tasks: - name: "Commit confirmed with timeout" cisco.ios.ios_hostname: state: merged config: hostname: R1 # Commands fired # - configure terminal revert timer 3 (cliconf specific) # - hostname R1 (from hostname resource module) # - configure confirm (cliconf specific) # Use commit confirm via cliconf using default timeout - name: Example commit confirmed vars: ansible_ios_commit_confirm_immediate: True tasks: - name: "Commit confirmed with timeout" cisco.ios.ios_hostname: state: merged config: hostname: R1 # Commands fired # - configure terminal revert timer 1 (cliconf specific with default timeout) # - hostname R1 (from hostname resource module) # - configure confirm (cliconf specific) N)AnsibleConnectionFailure)to_text)Mapping) iteritems) NetworkConfigdumps)to_list) CliconfBase enable_modeceZdZfdZeddZeddZ ddZedZeddZ ddZ ddZ d Z d Z d Zd Zfd ZddZddZdZdZdZdZxZS)Cliconfc:i|_tt||i|yN) _device_infosuperr__init__)selfargskwargs __class__s a/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/cisco/ios/plugins/cliconf/ios.pyrzCliconf.__init__s gt%t6v6c|dvrtd|z|rtd|z|sg}|dk(rd}nd}|djt|z }|j}|j |S)N)runningstartupz/fetching configuration from %s is not supportedz1'format' value %s is not supported for get_configrzshow running-config zshow startup-config  ) ValueErrorjoinr strip send_command)rsourceflagsformatcmds r get_configzCliconf.get_configs / /NQWWX X PSYYZ ZE Y (C(C sxx''iik  %%rcN|s tdd||d}|j|S)Nz)'file_name' value is required for restorezconfigure replace z forcer r#)rfilenamepathr's rrestorezCliconf.restores4HI I"4& &9  %%rc ni}|j}|j} ||dr td|| dvr#td|ddj| d|| dvr#td|ddj| dt d } |j |\} } | j | |r=|d k7r8|j |\} }t d | | }| j|||| }n| j}i}|r t|dnd|d<|j| |}|r|ni|d<|S)aR Generate diff between candidate and running configuration. If the remote host supports onbox diff capabilities ie. supports_onbox_diff in that case candidate and running configurations are not required to be passed as argument. In case if onbox diff capability is not supported candidate argument is mandatory and running argument is optional. :param candidate: The configuration which is expected to be present on remote host. :param running: The base configuration which is used to generate diff. :param diff_match: Instructs how to match the candidate configuration with current device configuration Valid values are 'line', 'strict', 'exact', 'none'. 'line' - commands are matched line by line 'strict' - command lines are matched with respect to position 'exact' - command lines must be an equal match 'none' - will not compare the candidate configuration with the running configuration :param diff_ignore_lines: Use this argument to specify one or more lines that should be ignored during the diff. This is used for lines in the configuration that are automatically updated by the system. This argument takes a list of regular expressions or exact line matches. :param path: The ordered set of parents that uniquely identify the section or hierarchy the commands should be checked against. If the parents argument is omitted, the commands are checked against the set of top level or global commands. :param diff_replace: Instructs on the way to perform the configuration on the device. If the replace argument is set to I(line) then the modified lines are pushed to the device in configuration mode. If the replace argument is set to I(block) then the entire command block is pushed to the device in configuration mode if any line is not correct. :return: Configuration diff in json format. { 'config_diff': '', 'banner_diff': {} } supports_generate_diffz4candidate configuration is required to generate diff diff_matchz'match' value z in invalid, valid values are z, diff_replacez'replace' value )indentnone)r3contents ignore_lines)r,matchreplacecommands config_diff banner_diff) get_device_operationsget_option_valuesr r!r _extract_bannersload differenceitemsr _diff_banners)r candidaterr0diff_ignore_linesr,r1diffdevice_operations option_values candidate_objwant_src want_bannershave_src have_banners running_objconfigdiffobjsbannerss rget_diffzCliconf.get_diffsuT 668..0  !23K!LST T ]<8 8tyy|)DEG  }^< <=+H!IK  &Q/ !%!6!6y!A,8$ zV+%)%:%:7%C "Hl'q8RcdK*55 $ 6N+00NLCQeNJ?WY]$$\<@)0gb] rc|jds|jdr|jdr|jdnd}|jjd}|jd}|jd}||dzkDr tdt j d |r td t j d |s td |jd |y|jdy)zu Enter global configuration mode based on the status of commit_confirm :return: None commit_confirm_timeoutcommit_confirm_immediater2persistent_command_timeoutz show archivez"show archive config rollback timer<z`ansible_command_timeout can't be greater than commit_confirm_timeout Please adjust and try againzArchive.*not.enabledzocommit_confirm_immediate option set, but archiving not enabled on device. Please set up archiving and try againz%%No Rollback Confirmed Change pendingzqExisting rollback change already pending. Please resolve by issuing 'configure confirm' or 'configure revert now'z configure terminal revert timer zconfigure terminalN) get_option _connectionr#r research)rcommit_timeoutrU archive_staterollback_states r configurezCliconf.configures  ??3 4Hb8c??#;< 89  *.)9)9)D)DEa)b & --n=M!../STN)NR,?? 2 yy0-@ < 99E~V 0    @@PQ R   2 3rci}|j}|j|||||g}g}|jd} |r|jt |D]\} t | t sd| i} | d} | dk7s"| ddk7s+|j|jd i| |j| ^|jd| r|jdn td||d<||d <|S) NrTcommandendr!zconfigure confirmzcheck mode is not supportedrequestresponse) r=check_edit_config_capabilityrWr^r isinstancerappendr#r ) rrDcommitr8commentresp operationsresultsrequestscommit_confirmliner's r edit_configzCliconf.edit_config?s//1  ))*iRYZ)CD  NN  * )!$0%t,D9o%   HH[H ) K s  ''c|js_i}d|d<|jdd|jd}t|d j }t j d |}|r#|jd j d |d <ddg}|D]S}t j ||t j}|s+|jd jd}|d|d<nt j d|t j}|r|jd |d<t j d|}|r|jd |d<|j|d<||_|jS)Nios network_osz)#ra)config_context exit_commandz show versionrsurrogate_or_stricterrorsz Version (\S+)r2,network_os_versionz^[Cc]isco (.+) \(revisionz"^[Cc]isco (\S+).+bytes of .*memoryrrnetwork_os_modelz ^(.+) uptimenetwork_os_hostnamezimage file is "(.+)"network_os_imagenetwork_os_type) r_update_cli_prompt_contextrrr"rYrZgroupMsplitr)r device_inforeplydatar7model_search_strsitemversions rget_device_infozCliconf.get_device_infosf  K(-K %  + +4e + THH^H4E5)>?EEGDII.5E49KKN4H4H4M 01-5! *  $bdd3#kk!n2237G6=ajK 23  IIotRTT:E5:[[^ 12II5tzCliconf.get_option_valuessh=#W-   rctt| }|dxxgdz cc<|j|d<|j |j t j|S)Nrpc) edit_bannerrQ run_commandsget_defaults_flagrG)rrget_capabilitiesr=updater>jsonr )rresultrs rrzCliconf.get_capabilitiessYw68u YY &*&@&@&B"# d,,./zz&!!rc i}tj|}g}g}|rt|D]\}} |d|zz }|jdd|| |fD]9} | dd} |j |jd i| |j | ;|jddt j d|j |jd|j d||d <||d <|S) ab Edit banner on remote device :param banners: Banners to be loaded in json format :param multiline_delimiter: Line delimiter for banner :param commit: Boolean value that indicates if the device candidate configuration should be pushed in the running configuration or discarded. :param diff: Boolean flag to indicate if configuration that is applied on remote host should generated and returned in response or not :return: Returns response of executing the configuration command received from remote host z %srsTryrwrartrurcrdre)rloadsr r#rhrzr{) rrDr}rirk banners_objrmrnkeyvaluer'r~s rrzCliconf.edit_bannersjj+  ' 4 & Uu222!!"3d!C(;<)C&)trrrrrr?rC __classcell__)rs@rrrs7&&&&& Tl(4(4T>%R 0"!H   "!F0&5$&rr) __future__rrrtype __metaclass__ DOCUMENTATIONEXAMPLESrrYrzansible.errorsransible.module_utils._textr/ansible.module_utils.common._collections_compatransible.module_utils.sixr Pansible_collections.ansible.netcommon.plugins.module_utils.network.common.configr r Oansible_collections.ansible.netcommon.plugins.module_utils.network.common.utilsr Gansible_collections.ansible.netcommon.plugins.plugin_utils.cliconf_baser rrrerrrsZ&A@ 0 d? B 3.C.d BkBr