Search.setIndex({docnames:["_api/airflow/providers/ssh/hooks/index","_api/airflow/providers/ssh/hooks/ssh/index","_api/airflow/providers/ssh/index","_api/airflow/providers/ssh/operators/index","_api/airflow/providers/ssh/operators/ssh/index","commits","connections/ssh","index","installing-providers-from-sources"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":5,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,sphinx:56},filenames:["_api/airflow/providers/ssh/hooks/index.rst","_api/airflow/providers/ssh/hooks/ssh/index.rst","_api/airflow/providers/ssh/index.rst","_api/airflow/providers/ssh/operators/index.rst","_api/airflow/providers/ssh/operators/ssh/index.rst","commits.rst","connections/ssh.rst","index.rst","installing-providers-from-sources.rst"],objects:{"airflow.providers":[[2,0,0,"-","ssh"]],"airflow.providers.ssh":[[0,0,0,"-","hooks"],[3,0,0,"-","operators"]],"airflow.providers.ssh.hooks":[[1,0,0,"-","ssh"]],"airflow.providers.ssh.hooks.ssh":[[1,1,1,"","SSHHook"],[1,4,1,"","TIMEOUT_DEFAULT"]],"airflow.providers.ssh.hooks.ssh.SSHHook":[[1,2,1,"","__enter__"],[1,2,1,"","__exit__"],[1,3,1,"","conn_name_attr"],[1,3,1,"","conn_type"],[1,2,1,"","create_tunnel"],[1,3,1,"","default_conn_name"],[1,2,1,"","exec_ssh_client_command"],[1,2,1,"","get_conn"],[1,2,1,"","get_tunnel"],[1,2,1,"","get_ui_field_behaviour"],[1,3,1,"","hook_name"],[1,2,1,"","host_proxy"]],"airflow.providers.ssh.operators":[[4,0,0,"-","ssh"]],"airflow.providers.ssh.operators.ssh":[[4,4,1,"","CMD_TIMEOUT"],[4,1,1,"","SSHOperator"]],"airflow.providers.ssh.operators.ssh.SSHOperator":[[4,2,1,"","exec_ssh_client_command"],[4,2,1,"","execute"],[4,2,1,"","get_hook"],[4,2,1,"","get_ssh_client"],[4,2,1,"","raise_for_status"],[4,2,1,"","run_ssh_client_command"],[4,3,1,"","template_ext"],[4,3,1,"","template_fields"],[4,3,1,"","template_fields_renderers"],[4,2,1,"","tunnel"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","data","Python data"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:data"},terms:{"0":[0,1,2,3,4,6,8],"00642a46d0":5,"0080354502":5,"01":5,"02":5,"03":5,"04":5,"042be2e4e0":5,"05":5,"06":5,"07":5,"08":5,"09":5,"0a":6,"0a0e1af800":5,"0a3440i":6,"0a5xge1ivp4ygmquvmvw5dj11jmna5ew3ofxlyoqrlth9hrexui":6,"0a612":6,"0a68588479":5,"0acmanhc0yauabn08pjac94":6,"0adavcr0h0n6bo":6,"0adzexlajusfr7i0uzwbibskjdepmnwgvzzo":6,"0aelatl3ikh8uaodrlzecavhptaogaxcreoc58h2zq3faueuzchqlafki2gkf9u1zm":6,"0ah1dhgbx4ar9joyvhzdxkuxynxvogljuioiak23od8q9xomqaituwkc1qavrxwie7":6,"0aiauvqtbuow1cmjvd0ibapjdkiei14k4pdh2qqbnoh8lmmmfbupox5sptsxl91pqc":6,"0akstey85cqugjwfo57ye3tyhbfmzi3fbqdx5rjgkgazmupkmv6ttsicfdggxlwed7":6,"0akylxcqvn":6,"0alaqnx":6,"0amiiepaibaakcaqeavyum9xousutckmwm":6,"0amlxmdd3bmtgwgtd14g6x":6,"0an6hfgpr9qrsmxe3ehm7":6,"0anhsgnypnaqxbxe3gjjeb4fzw3ufz3mq5pllytxkhc":6,"0anky2qotmwxe9lhuddap6i8btprvlq35y72icbgg0zk5fiyv":6,"0aohi":6,"0ap0jmi7qwemvaewicz":6,"0apprx3nn3lrmgngmbryuj5og6bocfxrbg8gxt05jcr4bhb4jkobiyb7i87r2vq19b":6,"0avwcvyrx8faxkl7ngf2sqz0z3jlhmdwmsxuc1aqidaqabaoibaqc8":6,"0aw41lmc8zaogbaob9pefyzgwyzgireoqsajrlwt7zsy053ogsxaeolc2ozylnb8v7":6,"0ax6mazyl5rpqbz":6,"0b0e4f7a4c":5,"0b2":5,"0beta1":5,"1":6,"10":[1,4,5,6,7],"10097":5,"10205":5,"10343ec29f":5,"10483":5,"10528":5,"10543":5,"10818":5,"10874":[5,7],"11":[5,8],"11032":5,"11097":5,"11216":5,"11238":5,"11242":5,"11249":5,"11361":5,"11447":5,"11487":5,"11688":5,"11826":5,"11855":5,"12":[5,8],"12082":5,"12093":5,"12206":5,"12212":5,"12216":5,"12304":5,"12366":5,"12390":5,"12444":5,"12449":5,"12467":[5,7],"12558":5,"127":6,"12917":5,"12944":[5,7],"12955":5,"129b4d2ac2":5,"12af6a0800":5,"12c5e5d8a":5,"13":5,"13148":5,"13380":5,"13717":5,"13732":5,"13767":5,"13943":5,"14":5,"14013":5,"14082":5,"14487":5,"14489":[5,7],"14886":5,"15":5,"15130":[5,7],"15212":[5,7],"15236":5,"15408":5,"15576":5,"15667":[5,7],"1571f80546":5,"15964":[5,7],"16":5,"16294":5,"16314":[5,7],"16364":[5,7],"16405":5,"16464":5,"16501":5,"16682":5,"16756":[5,7],"16adc035b1":5,"16e7129719":5,"17":5,"17015":5,"17020":5,"17116":5,"17236":[5,7],"17378":[5,7],"17528":5,"17682":5,"17890":5,"18":5,"18613":5,"18684":[5,7],"18964":5,"19":5,"19321":5,"19323":[5,7],"19981":[5,7],"1fba5402bb":5,"2":[0,1,2,3,4,6,8],"20":5,"2020":5,"2021":[5,8],"2022":5,"20241":5,"20474":[5,7],"20523":5,"20571":5,"20608":5,"20614":5,"20951":5,"21":5,"21020":5,"21074":5,"21257":5,"21262":[5,7],"21326":5,"21439":5,"2197e4b59a":5,"21cc7d7298":5,"22":[5,6],"22056":5,"22226":5,"22382":7,"2248a5da1d":5,"23":5,"23rc1":5,"24":5,"25":5,"26":5,"27":5,"27e637fbe3":5,"28":5,"29":5,"295d66f914":5,"2a1":5,"2b":6,"2b3sn5ugow":6,"2b5hldisoo":6,"2bdlekkb8htk1oqooa5t9ilmpext1bti7719plthxtdot":6,"2bg":6,"2bg25qwvaogbangf":6,"2bgergloik":6,"2bh7h0ipnd7df9skcht9fpj":6,"2bi5b6h4qm5mi3yyfyezraf9w0ko":6,"2bl3ny":6,"2bl5":6,"2bmc4":6,"2bp1revqyvc8k":6,"2bqwmjgqgifygrbeisl":6,"2bqx5agmbnjqdhwn0u8ov":6,"2bt":6,"2bt03njvool1zeuuni":6,"2bwj9":6,"2bxigmn0cgybol2o0sn":6,"2bznqxrxngvtww6xybm":6,"2f":6,"2f0efr4j6wywwajvdfofbj7wdif5j":6,"2f26ifs1xv8cmjcp2hwj2sbtffwsynsn3sywhi2cufqjimex":6,"2f62elb4":6,"2f8d7uzazkubg1":6,"2fairflow":6,"2fb2nlee8nlpdl6cwiotwv0xfkoif3cthvutlhgbxakhetixisnqk7vxqgfp":6,"2fccu":6,"2fhome":6,"2fid_rsa":6,"2fkelwwmyw3f0hgkgcff0xthv34f":6,"2fkogt4r3i":6,"2fmdoaqsjewtrlhwdtbd9lt4wrpuo":6,"2fofyigrigwarbgg55rlqvilngfcj6i3dvlsrqfxnd4pvqzzwfcn3lhiggi8ct":6,"2font":6,"2frgnoopf5ysn42a1nmqv4wx5akdjeymijzn2g2whnol8rvjzp4s2ao":6,"2frkqcbrp":6,"2fst40fd3x4":6,"2fukwou3i9z5hmqm9hjjlukr3hl5jmjjbjug50a7fjvjzr52vfxh73z":6,"2fupmk53oipd9e0memptqh2afpub":6,"2fxmzphasytrbmtgd6zycuzoyxwk8khmeluagbyt3u7l":6,"2fxpaogbalvljqeqlbtsm2lsep68":6,"2fymvqnwdmugllsrnx3hgkcpqkh7reklftbs2zuu1txvsxuno8k8z":6,"3":[0,1,2,3,4,6,8],"30":[1,4,5],"31":5,"32971a1a2d":5,"349b0811c3":5,"3696c34c28":5,"375d1ca229":5,"37681bca00":5,"3d":6,"3e9e954d9":5,"3fd5ef3555":5,"4":[0,1,2,3,4,6,8],"406f":8,"41bf172c1d":5,"49":8,"4bde99f132":5,"4d3a":8,"4e8f9cc8d0":5,"50e334df32":5,"512":8,"5220e4c384":5,"52339a55c0":5,"537963f24d":5,"54":8,"589d6dec92":5,"59eb5de78c":5,"5a439e84eb":5,"5c6e":8,"6":[5,7],"602abe8394":5,"6646":5,"6674":8,"6714":5,"6800":5,"6889a333cf":5,"68d99bc558":5,"68e4c4dcb0":5,"68fa29bff0":5,"6c3a67d4fc":5,"6cf76d7ac0":5,"7044":[5,7],"7268":5,"7338":5,"73fcbb0e4e":5,"7415":5,"74c2a6ded4":5,"76ed2a49c6":5,"7777d4f2fd":5,"7802":5,"7822":5,"7825e8f590":5,"7a0d412245":5,"8":5,"807ad32ce5":5,"83f8e178ba":5,"840ea3efb9":5,"85a18e13d9":5,"866a601b76":5,"872b1566a1":5,"8744":5,"8793":5,"87f408b1e7":5,"8807":5,"8886":5,"8891":5,"8898":5,"88bdcfa0df":5,"8994":5,"8b1":5,"8c42cf1b00":5,"8ec4":8,"9":7,"9026":5,"92585ca4cb":5,"9320":5,"9370":5,"9404":5,"9408":5,"9549274d11":5,"9550":5,"97496ba2b4":5,"97a429f9d0":5,"9a04013b0":5,"9b39f24780":5,"9b76b94c94":5,"9c94b72d44":5,"9ed9b5170c":5,"case":[5,7],"class":[5,7],"default":[1,4,5,6,7],"do":8,"export":6,"final":5,"float":[1,4],"import":[5,7,8],"int":[1,4],"new":[5,6],"public":6,"return":1,"static":1,"super":5,"switch":5,"true":[4,6],A:[5,7],By:8,For:[5,8],If:[1,4,7,8],In:6,It:8,The:[1,4,6,8],There:8,To:8,__enter__:1,__exit__:1,a2dc01b345:5,a9ac2b040b:5,aaahd:6,ab762a5a8a:5,about:[5,8],abov:8,ac2f72c98d:5,acceptenv:4,actual:[5,6,7],ad:[5,7],add:[5,6,7],addit:[5,7],ae7cb4a1e2:5,aeea71274d:5,after:5,against:6,aip:5,airflow:[6,8],airflow_conn_:6,airflow_conn_main_serv:6,airflow_conn_ssh_serv:6,aka:8,all:[1,5,6,7],allow:6,allow_host_key_chang:6,alreadi:8,also:[1,8],amazon:5,an:[0,1,2,3,4,5,6,7,8],ani:8,apach:8,apache_airflow_providers_ssh:8,api:7,appli:[5,7],apply_default:[5,7],april:5,ar:[6,7,8],arg:5,asc:8,ask:6,attach:1,attack:6,attempt:1,attribut:[5,7],august:5,auto:[5,7],autoapi:5,autom:5,automat:[6,7],avail:8,b2a28d1590:5,b40dffa085:5,b6d5d1e985:5,b6edc3bfa1:5,b916b75079:5,ba4b:8,backport:5,banner:[1,4],banner_timeout:[1,4,5,7],base64:6,base:[1,4],basehook:1,baseoper:4,bash:8,basi:1,batch:5,bbc627a3da:5,be75dcd39c:5,befor:5,begin:6,behaviour:1,belong:8,below:8,between:1,bin:8,binari:8,black:5,bool:4,broken:5,bst:8,bugfix:5,buggfix:5,build:[5,8],bunch:[5,7],c34ef853c8:5,c7e5bce57f:5,ca4238eb4d:5,call:5,can:[1,5,6,7,8],candid:5,cb73053211:5,cbf8001d76:5,cde15c6e4d3a8ec4ecf4ba4b6674e08ad7de406f:8,cde1:8,cdec301254:5,certif:8,certifi:8,chang:[5,6],changelog:5,chapter:8,charact:5,check:[5,8],checksum:8,choos:8,classifi:[5,7],cleanup:5,client:[1,6],close:5,cmd_timeout:[4,5,7],code:8,com:[1,8],come:5,command:[1,4,5,6,7],comment:5,commit:5,common:5,compat:5,complet:7,compon:6,compress:6,config:[4,5],conn_id:6,conn_name_attr:1,conn_timeout:[1,4,5,6,7],conn_typ:1,connect:[1,4,5,7],constructor:5,contain:8,content:6,context:4,correct:[5,7,8],correctli:[5,7],creat:[1,4,8],create_tunnel:1,creation:[5,7],cross:5,curl:8,custom:1,d02ded65ea:5,d0e7db4024:5,d200:5,d202:5,d353f023ff:5,d56e7b56bb:5,d7de:8,d94fa37830:5,d9567eb106:5,d:8,da783f88a1:5,daedc99851:5,data:[5,6],db:7,dd2095f4a8:5,decemb:5,decod:5,decor:[5,7],decrypt:6,default_conn_nam:1,defin:4,delai:[5,7],dep:8,depend:5,deprec:[1,4,6],deriv:4,describ:8,descript:5,dest:8,detail:[5,7,8],dev0:[0,1,2,3,4,5,6,7,8],dev:5,df24b43370:5,dict:4,dictionari:[4,6],diff:8,differ:8,directori:8,disabl:6,discover:6,displai:[5,7],distribut:8,doc:5,document:[5,7],down:8,download:8,drop:8,dss:[5,7],due:7,dure:[1,5],dynam:5,e08a:8,ecdsa:[5,7],ecf4:8,echo:8,ed25519:[5,7],ee7ca128a1:5,either:4,enabl:5,encod:6,encrypt:5,end:6,endpoint:6,entri:6,environ:[1,4],error:[5,6,7],escap:5,essenti:8,etc:6,even:5,everi:1,exampl:[6,8],exc_tb:1,exc_typ:1,exc_val:1,except:5,exec_ssh_client_command:[1,4],execut:[1,4],exist:7,exit_statu:4,experiment:[0,1,2,3,4,5,6,7,8],explicit:[5,7],expos:5,express:5,ext:5,extra:[5,6,7],f180fa13bf:5,f3521fb0e3:5,f3e87c5030:5,f42478009a:5,f5b96315fe:5,f6bd817a3a:5,f77417eb0d:5,f:5,fals:[4,6],fdd9b6f65b:5,featur:[0,1,2,3,4,5,6,8],feb:5,fetch:1,field:[1,5,6],file:[1,5,6,7,8],find:6,fingerprint:8,first:7,fix:5,flynt:5,folder:8,follow:[6,8],forc:[4,6],form:5,formmatt:5,foundat:8,framework:7,frequent:6,fresh:5,friendli:5,from:[1,4,5,6,7],ftp:5,full:6,gener:5,geren:[5,7],get:[4,6,8],get_conn:[1,5,7],get_hook:4,get_pti:[1,4,5,7],get_ssh_client:4,get_template_context:4,get_tunnel:1,get_ui_field_behaviour:1,github:1,given:[1,4],gmail:8,good:8,gpg:8,grammar:5,guid:8,gz:8,ha:[5,6,7],handl:[5,7],hash:5,have:[4,5,7],high:5,home:6,hook:[2,4,5,7],hook_nam:1,hors:6,host:[1,4,5,6,7],host_kei:[5,6,7],host_proxi:1,hostnam:[5,7],how:8,http:[1,8],i:8,id:[1,4,8],id_rsa:6,identif:6,ignor:[4,5],implement:5,improv:5,includ:5,indic:8,individu:5,inform:5,init:1,initi:7,instal:5,install_requir:7,instead:[1,4,6],instruct:8,integr:5,interv:[5,7],introduc:5,issuer:8,januari:5,jinja:4,json:6,juli:5,june:5,k8:5,ka:8,kaxil:8,kaxilnaik:8,keepal:1,keepalive_interv:1,kei:[1,5,6,7,8],key_fil:[1,6],kill:4,know:8,known:6,known_host:6,kwarg:4,l:[1,8],la:8,last:5,latest:5,lazili:5,least:7,left:8,let:1,level:5,like:1,line:5,link:[5,8],list:[5,7],load:[5,7],local:[1,8],local_port:1,localhost:[1,6],log:5,logo:5,look_for_kei:[5,6],ls:8,made:[6,8],magic:5,main:[4,8],maintain:[4,6],make:[5,6],man:6,manag:[5,8],mani:[5,7],manual:[6,7],march:5,markdown:5,match:[5,6,8],maximum:6,meta:5,method:4,middl:6,migrat:7,minimum:[5,7],mirror:8,miss:5,misspel:5,mistakenli:7,mktemp:8,model:4,modul:5,month:5,more:[4,5],most:8,move:5,mypi:5,naik:8,name:5,need:4,next:5,no_host_key_check:6,non:[5,7],none:[1,4,5,8],note:[4,5,6],now:5,nullabl:4,number:[1,5],o:8,object:[1,5],octob:5,offici:8,onc:8,one:8,onli:6,open:1,openssh:[5,7],oper:[2,5,7],optimis:7,option:[1,4,5,6],org:8,origin:8,other:6,otherwis:7,our:5,out:[5,6],owner:8,package_nam:8,package_vers:8,packet:1,page:[5,8],param:[1,5,7],paramet:[1,4,5,6],paramiko:[1,7],pars:5,pass:[1,5,6,7],passphras:6,password:[1,6],path:[1,6],per:5,pgp:8,pgpk:8,pgpv:8,pip:[5,8],pleas:8,point:5,poorli:6,port:[1,5,6,7],possibl:6,pre:5,predefin:[1,4],prepar:5,previou:8,primari:8,prioriti:1,privat:[5,6,7],private_kei:6,private_key_passphras:6,process:4,project:5,protect:6,protocol:5,provid:[6,8],provider_download_dir:8,proxi:[5,7],pseudo:4,py3:8,pydocstyl:5,pylint:5,pypi:[5,7],pysftp:7,python:[5,6,7,8],pyupgrad:5,rais:5,raise_for_statu:4,rc2:5,rc3:5,rc:5,readm:[5,7],recommend:8,ref:[1,5],refactor:[5,7],refer:4,refernc:5,refus:6,regener:5,reject:4,relas:5,releas:[5,7],relev:8,rema:5,remain:5,remot:[1,4,6],remote_host:[1,4,6],remote_port:1,remov:[5,6,7,8],renam:5,render:4,replac:[1,4],repositori:7,request:4,requir:[1,6],restrict:6,retri:[5,7],rsa:[5,6,7,8],run:[5,6,7,8],run_ssh_client_command:4,s:[5,8],same:4,sat:8,script:[5,8],sdist:8,search:6,second:[1,4,6],secur:[5,7],see:5,select:8,self:[1,4,8],send:1,sensor:5,sep:8,separ:5,septemb:5,sequenc:[4,5],serv:1,server:[1,4,5,6,8],set:[4,6],setup:5,sftp:[1,5,7],sftpoper:6,sh:4,sha512:8,sha:8,shasum:8,shell:[4,5,7],should:[6,8],sign:8,signatur:[5,8],silent:4,simplifi:5,so:[5,7],softwar:8,solut:6,sourc:[1,4,7],specifi:[5,6,7],sphinx:5,ssh:8,ssh_client:[1,4],ssh_conn_id:[1,4],ssh_default:1,ssh_hook:[4,5],ssh_known_host:6,ssh_port:1,sshclient:1,sshhook:[1,4,5,6,7],sshoper:[4,5,6,7],sshtunnel:[1,5,7],sshtunnelforward:1,standard:6,start:4,stderr:4,step:8,str:[1,4],strict:5,string:[5,6],subclass:[5,7],subject:5,sudo:4,sum:8,support:[5,6,7],synchron:5,syntax:6,t:6,tar:8,task:4,tcp:6,templat:[4,5,7],template_ext:4,template_field:[4,5],template_fields_render:[4,5,7],temporari:8,termin:4,test:5,them:4,thi:[0,1,2,3,4,5,6,7,8],those:8,thought:1,timeout:[1,4,5,6],timeout_default:1,toc:5,tool:5,toolchain:5,top:[7,8],traffic:6,transfer:[1,5,6],trojan:6,troublesom:6,trove:7,trust:8,tunnel:[1,4],two:1,type:[1,5,6,7],typehint:5,typo:5,uid:[5,7],unknown:8,until:[5,7],up:5,updat:[5,7],upgrad:[5,7],upon:4,uri:6,url:6,us:[1,4,5,6,7,8],user:[6,8],usernam:[1,5,6,7],utf:5,valid:8,valu:[5,6],variabl:[4,6],version:[5,7,8],via:[5,7,8],wa:[1,4],wait:[1,4,5,7],want:[6,7,8],warn:[5,8],wave:5,well:8,when:[4,5,6,7],where:[1,6],which:[1,4],whl:8,why:8,won:6,word:5,worri:8,would:6,wrong:5,wrongli:5,xcomarg:[5,7],ydwwq:6,you:[1,6,7,8],your:7},titles:["<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.ssh.hooks</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.ssh.hooks.ssh</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.ssh</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.ssh.operators</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.ssh.operators.ssh</span></code>","Package apache-airflow-providers-ssh","SSH Connection","<code class=\"docutils literal notranslate\"><span class=\"pre\">apache-airflow-providers-ssh</span></code>","Installing from sources"],titleterms:{"0":[5,7],"1":[5,7],"2":[5,7],"3":[5,7],"4":[5,7],"break":7,"class":[1,4],airflow:[0,1,2,3,4,5,7],apach:[5,7],attribut:[1,4],bug:7,chang:7,changelog:7,commit:7,configur:6,connect:6,content:[1,4,7],featur:7,fix:7,from:8,guid:7,hook:[0,1],instal:[7,8],integr:8,misc:7,modul:[1,4],oper:[3,4],packag:[5,7,8],pip:7,provid:[0,1,2,3,4,5,7],pypi:8,refer:7,releas:8,requir:7,resourc:7,sourc:8,ssh:[0,1,2,3,4,5,6,7],submodul:[0,3],subpackag:2,verifi:8}})