VhBddlmZddlmZddlmZddlmZddlm Z ddl m Z ddl m Z  ddlmZdd lmZmZmZd Zd Z dd lmZmZmZmZdZGdde Z y #e$rZd ZeZYd Z[*d Z[wwxYw#e$rdd lmZmZmZmZY8wxYw)) annotations)abstractmethodwraps) AnsibleError) AnsiblePlugin) to_native)missing_required_lib)RPCError)to_xmlto_ele NCElementTNF)Element SubElementtostring fromstringc.tfd}|S)Nctts&ttddtt|g|i|S)Nncclientz: ) HAS_NCCLIENTrr r NCCLIENT_IMP_ERR)selfargskwargsfuncs P/home/dcms/DCMS/lib/python3.12/site-packages/ansible/plugins/netconf/__init__.pywrappedz ensure_ncclient..wrapped0s7+? +KYWgMhij jD*4*6**r)rrs` rensure_ncclientr/s  4[++ NrceZdZdZgdZfdZedZdZddZ ddZ ddZ dd Z d Z dd Zdd Zdd ZdZddZddZdZdZedZedZdZdZdZdZxZS) NetconfBasea A base class for implementing Netconf connections .. note:: Unlike most of Ansible, nearly all strings in :class:`TerminalBase` plugins are byte strings. This is because of how close to the underlying platform these plugins operate. Remember to mark literal strings as byte string (``b"string"``) and to use :func:`~ansible.module_utils.common.text.converters.to_bytes` and :func:`~ansible.module_utils.common.text.converters.to_text` to avoid unexpected problems. List of supported rpc's: :get: Retrieves running configuration and device state information :get_config: Retrieves the specified configuration from the device :edit_config: Loads the specified commands into the remote device :commit: Load configuration from candidate to running :discard_changes: Discard changes to candidate datastore :validate: Validate the contents of the specified configuration. :lock: Allows the client to lock the configuration system of a device. :unlock: Release a configuration lock, previously obtained with the lock operation. :copy_config: create or replace an entire configuration datastore with the contents of another complete configuration datastore. :get-schema: Retrieves the required schema from the device :get_capabilities: Retrieves device information and supported rpc methods For JUNOS: :execute_rpc: RPC to be execute on remote device :load_configuration: Loads given configuration on device Note: rpc support depends on the capabilities of remote device. :returns: Returns output received from remote device as byte string Note: the 'result' or 'error' from response should to be converted to object of ElementTree using 'fromstring' to parse output as xml doc 'get_capabilities()' returns 'result' as a json string. Usage: from ansible.module_utils.connection import Connection conn = Connection() data = conn.execute_rpc(rpc) reply = fromstring(reply) data = conn.get_capabilities() json.loads(data) conn.load_configuration(config=[''set system ntp server 1.1.1.1''], action='set', format='text') )rpc get_configget edit_configvalidate copy_configdispatchlockunlockdiscard_changescommit get_schema delete_configget_device_operationsc8tt| ||_yN)superr!__init__ _connection)r connection __class__s rr3zNetconfBase.__init__ns k4)+%rc.|jjSr1)r4managerrs rmz NetconfBase.mrs'''rc t|}|jj|}t|dr |jS|j S#t $r%}|j }tt|d}~wwxYw)z RPC to be execute on remote device :param name: Name of rpc in string format :return: Received rpc response from remote host data_xmlN) r r:r"hasattrr<xmlr Exceptionr )rnameobjrespexcmsgs rr"zNetconfBase.rpcvse  ),C66::c?D$+D*$=4== K488 K )''CF3K( ( )s=A A A: A55A:ct|tr t|}|sd}|jj ||}t |dr |j S|jS)a Retrieve all or part of a specified configuration (by default entire configuration is retrieved). :param source: Name of the configuration datastore being queried, defaults to running datastore :param filter: This argument specifies the portion of the configuration data to retrieve :return: Returns xml string containing the RPC response received from remote host runningsourcefilterr<) isinstancelisttupler:r#r=r<r>)rrHrIrBs rr#zNetconfBase.get_configsT fd #6]FFvv  v > 'j 9t}}GtxxGrct|tr t|}|jj ||}t |dr|j }|S|j}|S)a Retrieve device configuration and state information. :param filter: This argument specifies the portion of the state data to retrieve (by default entire state data is retrieved) :param with_defaults: defines an explicit method of retrieving default values from the configuration :return: Returns xml string containing the RPC response received from remote host )rI with_defaultsr<)rJrKrLr:r$r=r<r>)rrIrNrBresponses rr$zNetconfBase.getsV fd #6]Fvvzz}zE$+D*$=4==DH88rc| td|jj||||||}t|dr |jS|j S)a Loads all or part of the specified *config* to the *target* configuration datastore. :param config: Is the configuration, which must be rooted in the `config` element. It can be specified either as a string or an :class:`~xml.etree.ElementTree.Element`. :param format: The format of configuration eg. xml, text :param target: Is the name of the configuration datastore being edited :param default_operation: If specified must be one of { `"merge"`, `"replace"`, or `"none"` } :param test_option: If specified must be one of { `"test_then_set"`, `"set"` } :param error_option: If specified must be one of { `"stop-on-error"`, `"continue-on-error"`, `"rollback-on-error"` } The `"rollback-on-error"` *error_option* depends on the `:rollback-on-error` capability. :return: Returns xml string containing the RPC response received from remote host zconfig value must be provided)formattargetdefault_operation test_option error_optionr<) ValueErrorr:r%r=r<r>)rconfigrQrRrSrTrUrBs rr%zNetconfBase.edit_configs] ><= =vv!!&ZkzE/;"= 'j 9t}}GtxxGrc|jj|}t|dr |jS|jS)aS Validate the contents of the specified configuration. :param source: Is the name of the configuration datastore being validated or `config` element containing the configuration subtree to be validated :return: Returns xml string containing the RPC response received from remote host )rHr<)r:r&r=r<r>)rrHrBs rr&zNetconfBase.validates4vvf- 'j 9t}}GtxxGrc|jj||}t|dr |jS|jS)a Create or replace an entire configuration datastore with the contents of another complete configuration datastore. :param source: Is the name of the configuration datastore to use as the source of the copy operation or `config` element containing the configuration subtree to copy :param target: Is the name of the configuration datastore to use as the destination of the copy operation :return: Returns xml string containing the RPC response received from remote host r<)r:r'r=r<r>)rrHrRrBs rr'zNetconfBase.copy_configs6vv!!&&1 'j 9t}}GtxxGrc| td|jjt|||}t |t r|j }|St|dr|jr|j }|S|j}|S)a Execute rpc on the remote device eg. dispatch('clear-arp-table') :param rpc_command: specifies rpc command to be dispatched either in plain text or in xml element format (depending on command) :param source: name of the configuration datastore being queried :param filter: specifies the portion of the configuration to retrieve (by default entire configuration is retrieved) :return: Returns xml string containing the RPC response received from remote host z"rpc_command value must be providedrGdata_ele) rVr:r(rrJrr<r=r[r>)r rpc_commandrHrIrBresults rr(zNetconfBase.dispatchs  AB Bvvz+6vfU dI &]]F T: &4==]]F  XXF rc|jj|}t|dr |jS|jS)a. Allows the client to lock the configuration system of a device. :param target: is the name of the configuration datastore to lock, defaults to candidate datastore :return: Returns xml string containing the RPC response received from remote host rRr<)r:r)r=r<r>rrRrBs rr)zNetconfBase.locks4vv{{&{) 'j 9t}}GtxxGrc|jj|}t|dr |jS|jS)a: Release a configuration lock, previously obtained with the lock operation. :param target: is the name of the configuration datastore to unlock, defaults to candidate datastore :return: Returns xml string containing the RPC response received from remote host r_r<)r:r*r=r<r>r`s rr*zNetconfBase.unlocks4vv}}F}+ 'j 9t}}GtxxGrc~|jj}t|dr |jS|jS)z Revert the candidate configuration to the currently running configuration. Any uncommitted changes are discarded. :return: Returns xml string containing the RPC response received from remote host r<)r:r+r=r<r>)rrBs rr+zNetconfBase.discard_changess2 vv%%' 'j 9t}}GtxxGrc|jj|||}t|dr |jS|jS)az Commit the candidate configuration as the device's new current configuration. Depends on the `:candidate` capability. A confirmed commit (i.e. if *confirmed* is `True`) is reverted if there is no followup commit within the *timeout* interval. If no timeout is specified the confirm timeout defaults to 600 seconds (10 minutes). A confirming commit may have the *confirmed* parameter but this is not required. Depends on the `:confirmed-commit` capability. :param confirmed: whether this is a confirmed commit :param timeout: specifies the confirm timeout in seconds :param persist: make the confirmed commit survive a session termination, and set a token on the ongoing confirmed commit :return: Returns xml string containing the RPC response received from remote host ) confirmedtimeoutpersistr<)r:r,r=r<r>)rrdrerfrBs rr,zNetconfBase.commits8vv}}y'7}S 'j 9t}}GtxxGrc|jj|||}t|dr |jS|jS)ae Retrieve a named schema, with optional revision and type. :param identifier: name of the schema to be retrieved :param version: version of schema to get :param format: format of the schema to be retrieved, yang is the default :return: Returns xml string containing the RPC response received from remote host )versionrQr<)r:r-r=r<r>)r identifierrhrQrBs rr-zNetconfBase.get_schemas;vv  WV L 'j 9t}}GtxxGrc|jj|}t|dr |jS|jS)z delete a configuration datastore :param target: specifies the name or URL of configuration datastore to delete :return: Returns xml string containing the RPC response received from remote host r<)r:r.r=r<r>r`s rr.zNetconfBase.delete_config s4 vv##F+ 'j 9t}}GtxxGrc8|jj|Sr1)r:locked)rrRs rrlzNetconfBase.locked)svv}}V$$rcy)z Retrieves device information and supported rpc methods by device platform and return result as a string :return: Netconf session capability Nr9s rget_capabilitieszNetconfBase.get_capabilities,s rcy)z Identifies the operating system of network device. :param obj: ncclient manager connection instance :return: The name of network operating system. Nrn)rAs rguess_network_oszNetconfBase.guess_network_os6 rc|jS)zs Returns list of base rpc method supported by remote device :return: List of RPC supported )__rpc__r9s r get_base_rpczNetconfBase.get_base_rpc?s ||rcy)z Copies file to remote host :param source: Source location of file :param destination: Destination file path :return: Returns xml string containing the RPC response received from remote host NrnrrH destinations rput_filezNetconfBase.put_fileFrrrcy)z Fetch file from remote host :param source: Source location of file :param destination: Source location of file :return: Returns xml string containing the RPC response received from remote host Nrnrws r fetch_filezNetconfBase.fetch_fileOrrrcPi}dj|}d|v|d<d|v|d<d|v|d<d|v|d <d |v|d <d |v|d <d|v|d<g|d<|d r|djd|dr|djd|d r|djdt|d|d<|S)z Retrieve remote host capability from Netconf server hello message. :param server_capabilities: Server capabilities received during Netconf session initialization :return: Remote host capabilities in dictionary format  z :candidatesupports_commitz:with-defaultssupports_defaultsz:confirmed-commitsupports_confirm_commitz:startupsupports_startupz:xpathsupports_xpathz:writable-runningsupports_writable_runningz :validatesupports_validatelock_datastorerF candidatestartup supports_lock)joinappendbool)rserver_capabilities operations capabilitiess rr/z!NetconfBase.get_device_operationsXs  yy!45 (4 (D $%*:l*J &'0C|0S ,-)3|)C %&'/<'? #$2E2U ./*5*E &'') #$ 1 2 ' ( / / : ' ( ' ( / / < ( ) ' ( / / :&*:6F+G&H ?#r)NN)Nr>rNNN)r)NNN)FNN)__name__ __module__ __qualname____doc__rtr3propertyr:r"r#r$r%r&r'r(r)r*r+r,r-r.rlrro staticmethodrqruryr{r/ __classcell__)r6s@rr!r!8s0ddG&(( )H H&H H6HHHH$ HH%      rr!)! __future__rabcr functoolsransible.errorsransible.pluginsr+ansible.module_utils.common.text.convertersr ansible.module_utils.basicr ncclient.operationsr ncclient.xml_r r rrrr?err lxml.etreerrrr ImportErrorxml.etree.ElementTreerr!rnrrrs&#')A; ,77LPDD |-|'L POOPs)A A2A/!A**A/2BB