python-ncclient-doc 0.5.3-4 / usr / share / doc / python-ncclient / html / searchindex.js

Search.setIndex({docnames:["api","capabilities","extending","index","manager","operations","transport","xml_"],envversion:50,filenames:["api.rst","capabilities.rst","extending.rst","index.rst","manager.rst","operations.rst","transport.rst","xml_.rst"],objects:{"ncclient.capabilities":{Capabilities:[1,1,1,""],schemes:[1,2,1,""]},"ncclient.manager":{Manager:[4,1,1,""],OPERATIONS:[4,5,1,""],connect:[4,5,1,""],connect_ssh:[4,2,1,""]},"ncclient.manager.Manager":{async_mode:[4,3,1,""],client_capabilities:[4,3,1,""],close_session:[4,4,1,""],commit:[4,4,1,""],connected:[4,3,1,""],copy_config:[4,4,1,""],delete_config:[4,4,1,""],discard_changes:[4,4,1,""],dispatch:[4,4,1,""],edit_config:[4,4,1,""],get:[4,4,1,""],get_config:[4,4,1,""],kill_session:[4,4,1,""],lock:[4,4,1,""],locked:[4,4,1,""],raise_mode:[4,3,1,""],server_capabilities:[4,3,1,""],session_id:[4,3,1,""],timeout:[4,3,1,""],unlock:[4,4,1,""],validate:[4,4,1,""]},"ncclient.operations":{CloseSession:[5,1,1,""],Commit:[5,1,1,""],CopyConfig:[5,1,1,""],DeleteConfig:[5,1,1,""],DiscardChanges:[5,1,1,""],Dispatch:[5,1,1,""],EditConfig:[5,1,1,""],Get:[5,1,1,""],GetConfig:[5,1,1,""],GetReply:[5,1,1,""],KillSession:[5,1,1,""],Lock:[5,1,1,""],MissingCapabilityError:[5,6,1,""],OperationError:[5,6,1,""],RPC:[5,1,1,""],RPCError:[5,6,1,""],RPCReply:[5,1,1,""],RaiseMode:[5,1,1,""],TimeoutExpiredError:[5,6,1,""],Unlock:[5,1,1,""],Validate:[5,1,1,""]},"ncclient.operations.CloseSession":{request:[5,4,1,""]},"ncclient.operations.Commit":{request:[5,4,1,""]},"ncclient.operations.CopyConfig":{request:[5,4,1,""]},"ncclient.operations.DeleteConfig":{request:[5,4,1,""]},"ncclient.operations.DiscardChanges":{request:[5,4,1,""]},"ncclient.operations.Dispatch":{REPLY_CLS:[5,3,1,""],request:[5,4,1,""]},"ncclient.operations.EditConfig":{request:[5,4,1,""]},"ncclient.operations.Get":{REPLY_CLS:[5,3,1,""],request:[5,4,1,""]},"ncclient.operations.GetConfig":{REPLY_CLS:[5,3,1,""],request:[5,4,1,""]},"ncclient.operations.GetReply":{data:[5,3,1,""],data_ele:[5,3,1,""],data_xml:[5,3,1,""]},"ncclient.operations.KillSession":{request:[5,4,1,""]},"ncclient.operations.Lock":{request:[5,4,1,""]},"ncclient.operations.RPC":{DEPENDS:[5,3,1,""],REPLY_CLS:[5,3,1,""],_assert:[5,4,1,""],_request:[5,4,1,""],error:[5,3,1,""],event:[5,3,1,""],is_async:[5,3,1,""],raise_mode:[5,3,1,""],reply:[5,3,1,""],request:[5,4,1,""],timeout:[5,3,1,""]},"ncclient.operations.RPCError":{info:[5,3,1,""],message:[5,3,1,""],path:[5,3,1,""],severity:[5,3,1,""],tag:[5,3,1,""],type:[5,3,1,""]},"ncclient.operations.RPCReply":{_parsing_hook:[5,4,1,""],error:[5,3,1,""],errors:[5,3,1,""],ok:[5,3,1,""],xml:[5,3,1,""]},"ncclient.operations.RaiseMode":{ALL:[5,3,1,""],ERRORS:[5,3,1,""],NONE:[5,3,1,""]},"ncclient.operations.Unlock":{request:[5,4,1,""]},"ncclient.operations.Validate":{request:[5,4,1,""]},"ncclient.transport":{AuthenticationError:[6,6,1,""],SSHError:[6,6,1,""],SSHSession:[6,1,1,""],SSHUnknownHostError:[6,6,1,""],Session:[6,1,1,""],SessionCloseError:[6,6,1,""],SessionListener:[6,1,1,""],TransportError:[6,6,1,""]},"ncclient.transport.SSHSession":{connect:[6,4,1,""],load_known_hosts:[6,4,1,""],transport:[6,3,1,""]},"ncclient.transport.Session":{add_listener:[6,4,1,""],client_capabilities:[6,3,1,""],connected:[6,3,1,""],get_listener_instance:[6,4,1,""],id:[6,3,1,""],remove_listener:[6,4,1,""],server_capabilities:[6,3,1,""]},"ncclient.transport.SessionListener":{callback:[6,4,1,""],errback:[6,4,1,""]},"ncclient.transport.ssh":{default_unknown_host_cb:[6,4,1,""]},"ncclient.xml_":{BASE_NS_1_0:[7,5,1,""],CISCO_CPI_1_0:[7,5,1,""],FLOWMON_1_0:[7,5,1,""],JUNIPER_1_1:[7,5,1,""],TAILF_AAA_1_1:[7,5,1,""],TAILF_EXECD_1_1:[7,5,1,""],XMLError:[7,6,1,""],parse_root:[7,2,1,""],qualify:[7,2,1,""],register_namespace:[7,2,1,""],to_ele:[7,2,1,""],to_xml:[7,2,1,""],validated_element:[7,2,1,""]},ncclient:{capabilities:[1,0,0,"-"],manager:[4,0,0,"-"],operations:[5,0,0,"-"],transport:[6,0,0,"-"],xml_:[7,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","function","Python function"],"3":["py","attribute","Python attribute"],"4":["py","method","Python method"],"5":["py","data","Python data"],"6":["py","exception","Python exception"]},objtypes:{"0":"py:module","1":"py:class","2":"py:function","3":"py:attribute","4":"py:method","5":"py:data","6":"py:exception"},terms:{"6r4":7,"abstract":4,"boolean":5,"case":[4,6],"class":[0,1,3,4,6],"default":[4,5,6],"final":4,"function":3,"import":3,"long":5,"new":[2,3,4,5,6],"return":[1,4,5,6,7],"true":[4,5,6],"try":4,For:[1,3,4],NOT:5,The:[3,4,5,6,7],These:[4,5],Will:5,_assert:5,_parsing_hook:5,_request:5,aaa:7,abbrevi:5,abov:3,accept:6,access:5,add:[4,5],add_listen:6,added:[2,3],addit:[1,4],address:6,advanc:4,agent:[3,6],aim:3,alia:5,all:[3,4,5],allow:[4,5,6,7],allow_ag:6,alreadi:7,also:[4,5,6],altern:7,altogeth:6,alwai:[5,6],amiss:4,ani:[4,5,7],anoth:[4,5,6],api:3,appli:5,arg:4,argument:[4,6],around:4,arp:[4,5],assert:3,assign:4,async:5,async_mod:4,asynchron:[3,4,5],attempt:[5,6],attr:7,attribut:[4,5,6,7],authent:6,authenticationerror:6,avail:[1,4,5],avoid:6,await:4,base:[0,3,4,7],base_ns_1_0:7,been:[3,4,5,6],befor:5,behavior:4,being:[4,5],best:3,biggest:3,block:5,built:5,call:[4,5,6],callback:6,can:[1,2,3,4,5,6],candid:[1,4,5],cap:1,capabilti:4,capabl:[0,3,4,5,6],categori:5,chang:[3,4,5],check:[1,4,7],cisco:[3,4,7],cisco_cpi_1_0:7,clear:[4,5],client:[1,3,4,5,6],client_cap:[4,6],close:[4,5],close_sess:4,closesess:[4,5],cls:6,code:3,colon:6,com:7,command:[4,5],commit:[4,5],complet:[3,4,5],concept:3,concern:5,conf:3,config:[4,5,6],configur:[4,5,6],confirm:[4,5],connect:[3,4,5,6],connect_ssh:[3,4],constant:[4,5],construct:3,contain:[4,5,6],content:[3,4,5],context:[4,6],continu:[4,5],control:4,convers:[0,3],convert:7,copi:[4,5],copy_config:[3,4],copyconfig:[4,5],core:[4,7],correspond:[4,5],cpi_10:7,creat:[4,5,7],create_subscript:4,createsubscript:4,criteria:[4,7],csr:3,current:[4,5],custom:3,data:[4,5,7],data_el:5,data_xml:[3,4,5],datastor:[4,5],deal:7,dealt:4,default_oper:[4,5],default_unknown_host_cb:6,defin:[3,4,5],delet:[4,5],delete_config:4,deleteconfig:[4,5],delimit:6,deliveri:5,depend:[4,5],destin:[4,5],detail:4,determin:6,devic:[4,5,6],device_handl:[4,5,6],device_param:[3,4],devicehandl:5,dictionari:[4,6,7],differ:4,directli:[4,5],disabl:6,discard:[4,5],discard_chang:4,discardchang:[4,5],discuss:2,dispatch:[4,5],document:[3,4,6,7],doe:5,don:5,each:7,eas:3,easi:3,easier:3,easili:3,edit:[0,3,4],edit_config:4,editconfig:[4,5],effici:7,either:[4,5,7],ele:7,element:[4,5,6,7],elementtre:7,els:5,empti:5,enabl:6,encod:[3,7],entir:[4,5],err:5,errback:6,error:[0,3,4,5],error_filt:5,error_opt:[4,5],even:5,event:5,everyth:[0,3],exampl:[1,3,4,5],except:[0,3,4,6,7],exchang:4,execd:7,execut:4,exist:7,expect:4,expos:4,express:4,extens:3,extent:4,factori:3,fall:5,fals:[3,4,5,6,7],fashion:7,featur:3,file:[3,6],filenam:6,filter:[3,5],find:6,fingerprint:6,first:[4,5,6],flowmon:[4,7],flowmon_1_0:7,follow:4,followup:[4,5],forc:[4,5],fork:3,form:1,format:[4,5],found:6,from:[3,5,6],ftp:4,full:1,further:6,futureproof:3,gener:5,get:[4,5],get_config:[3,4],get_listener_inst:6,get_schema:4,getconfig:[4,5],getrepli:[4,5],getschema:4,given:[1,7],global:7,god:5,grace:[4,5],hand:5,handl:[0,3,4,5],handler:5,has:[1,3,4,5,6],have:[3,4,5],here:[2,4,6],hex:6,high:3,honest:5,host:[3,4,6],hostkei:6,hostkey_verifi:[3,6],hostnam:6,how:[2,5],howev:4,http:7,huawei:3,id_:6,identifi:[4,5],idiom:3,ietf:[1,7],ignor:6,immedi:[4,5],implement:[0,3,4,5],implicit:5,in_buf:6,includ:3,incom:6,index:3,indic:5,info:5,inform:[4,5],initi:[1,4,6],instanc:[4,5,6],instanti:5,instead:4,instruct:4,integr:3,intens:6,interest:4,interfac:4,interv:[4,5],introduc:3,introduct:3,intuit:3,invok:[3,4],irrelev:5,is_async:5,iter:1,its:[4,6,7],itself:5,junip:[3,4,7],juniper_1_1:7,juno:[3,4,5,7],keep:[3,4],kei:[1,3,6],key_filenam:6,kill:5,kill_sess:4,killsess:[4,5],kind:3,known_host:[3,6],kwarg:4,kwd:4,latest:3,latter:4,layer:[0,3,4],lead:[5,6],level:3,liberout:7,librari:[3,4],like:[4,5,6],list:[1,5],listen:6,load:[4,5,6],load_known_host:[4,6],locat:6,lock:[0,3,4],look:[5,6],look_for_kei:6,lookup:4,lot:3,made:5,mai:[4,5,6,7],make:[3,4,5,6],manag:3,manual:4,map:[2,3,4,7],match:5,meet:7,member:1,merg:[3,4,5],messag:[5,6],met:7,method:[4,5,6,7],minut:[4,5],missingcapabilityerror:[4,5],mode:[4,5],model:7,modul:[3,4],multipl:6,must:[4,5],name:[1,3,4,5,6,7],namespac:[0,3,4,5],natur:3,ncclient:[1,3,4,5,6,7],ncclienterror:[5,6,7],need:[3,5,6],net:7,netconf:[0,3,4,5,6,7],netop:7,network:3,never:6,new_checkpoint:3,new_el:[4,5],newli:7,nexu:[3,4],none:[4,5,6,7],note:[4,5],notifi:6,object:[1,4,5,6,7],obtain:[4,5],occur:[5,6],off:5,offer:3,old_checkpoint:3,one:[3,4,5],ongo:[4,5],onli:5,open:3,openssh:6,oper:[0,2,3,4],operationerror:5,option:6,org:7,other:3,out:3,out_buf:6,over:[1,4,6],overhead:5,page:3,param:[1,3,7],paramer:4,paramet:[3,5],paramiko:6,pars:[5,6,7],parse_root:7,part:[4,5],pass:[4,5],passphras:6,password:6,path:[5,6],persist:[4,5],pipelin:3,plain:[4,5],port:[3,6],portion:[4,5],possibl:[4,6],poweroff_machin:4,poweroffmachin:4,prefix:7,presenc:[1,4],present:5,pretty_print:7,prevent:5,previous:[4,5],primari:4,privat:6,process:[5,6],programat:6,protocol:6,prove:3,provid:4,publickei:6,pull:3,python:3,qualifi:[6,7],queri:[1,4,5,6],rais:[4,5,6,7],raise_mod:[4,5],raisemod:[4,5],raw:[5,6,7],realli:3,reboot_machin:4,rebootmachin:4,receiv:[4,5,6],recogn:6,refer:4,regist:[6,7],register_namespac:7,registri:7,relat:4,releas:[4,5],reli:3,remov:7,remove_listen:6,replac:[4,5],repli:[4,5],reply_cl:5,repres:[1,4,5,6],request:[3,4,5],requir:[4,5,6,7],respect:[3,4],retriev:[0,3,4],revert:[4,5],rfc:[3,4,6],rollback:[4,5],root:[4,5,6,7],rpc:[0,3,4],rpc_command:[4,5],rpcerror:[4,5],rpcrepli:[4,5],run:[3,4,5],same:5,schema:[4,5,7],scheme:[1,4],script:3,search:3,second:[4,5],see:[4,5,6],seealso:[4,5],self:5,send:5,sensibl:3,sequenc:7,server:[1,4,5,6],server_cap:[3,4,6],session:[0,3,4],session_id:[4,5],sessioncloseerror:6,sessionlisten:6,set:[1,4,5,6],set_keepal:6,sever:[5,7],shorthand:1,should:[4,5],signatur:6,signific:1,simpl:[3,4],simpli:7,singl:7,socket:6,some:[4,5,6],someth:4,sourc:[3,5],special:3,specif:4,specifi:[4,5,6,7],ssh:[0,3,4],ssh_config:6,ssherror:6,sshsession:[4,6],sshunknownhost:6,sshunknownhosterror:6,state:[4,5],statu:6,still:5,stop:[4,5],string:[1,4,5,6],stuff:4,style:6,sub_el:[4,5],subclass:[4,5],subscrib:4,subtre:[4,5],success:5,suppli:[6,7],support:[1,4],surviv:[4,5],synchron:[4,5],system:[4,5],tabl:[4,5],tag:[5,6,7],tagnam:7,tail:7,tailf_aaa_1_1:7,tailf_execd_1_1:7,take:[4,5,6],target:[3,5],task:6,termin:[4,5],test:7,test_opt:[4,5],test_then_set:[4,5],text:[4,5],thi:[1,4,5,6],thin:4,through:[3,4],thu:[3,4],time:[4,5,6],timeout:[4,5,6],timeoutexpirederror:5,to_el:7,to_xml:7,todo:2,token:[4,5],transport:[0,2,3,4,5],transporterror:[4,6],tupl:[4,6,7],two:6,type:[0,3,4,5],typic:5,uncommit:[4,5],underli:[4,6],unencrypt:3,unexpect:4,unknown:6,unknown_host_cb:6,unless:3,unlock:[4,5,6],unregist:6,until:5,uri:[1,5,7],url:[1,3,4,5],url_uri:1,urn:[1,7],usag:[4,5],use:[1,3,4,5,6,7],used:[1,4,6],user:[3,4],usernam:[3,6],using:[4,6],usual:[4,6],utf:7,valid:[4,5,6],validated_el:7,valu:[4,5],vendor:4,vendor_alia:4,verif:6,verifi:[4,5,6],version:[1,3],via:6,wai:3,wait:5,want:6,were:5,what:4,when:[5,6],where:[4,6],whether:[4,5,6],which:[4,5,6,7],window:6,within:[4,5],would:[1,6],wrapper:5,writabl:5,write:3,www:7,xml:[0,3,4,5,6],xml_:[0,3],xmlerror:7,xnm:[4,5,7],xpath:4,xsd_fetch:[4,5],yet:5,you:[4,6],your:4},titles:["Complete API documentation","<code class=\"docutils literal\"><span class=\"pre\">capabilities</span></code> &#8211; NETCONF Capabilities","Extending ncclient","Welcome","<code class=\"docutils literal\"><span class=\"pre\">manager</span></code> &#8211; High-level API","<code class=\"docutils literal\"><span class=\"pre\">operations</span></code> &#8211; Everything RPC","<code class=\"docutils literal\"><span class=\"pre\">transport</span></code> &#8211; Transport / Session layer","<code class=\"docutils literal\"><span class=\"pre\">xml_</span></code> &#8211; XML handling"],titleterms:{"class":5,"function":4,api:[0,4],base:[5,6],capabl:1,complet:0,convers:7,custom:4,devic:3,document:0,edit:5,error:6,everyth:5,except:5,extend:2,factori:4,filter:4,handl:7,handler:3,high:4,implement:6,indic:3,kind:4,layer:6,level:4,lock:5,manag:4,namespac:7,ncclient:2,netconf:1,oper:5,paramet:4,retriev:5,rpc:5,session:[5,6],sourc:4,special:4,ssh:6,support:3,tabl:3,target:4,transport:6,type:6,welcom:3,xml:7,xml_:7}})