VhULddlmZddlmZddlZddlZddlZddlZddlZddl Z ddl m Z ddl m Z ddlmZddlmZddlmZmZdd lmZdd lmZdd lmZdd lmZdd lmZm Z ddl!m"Z"ddl#m$Z$ddl%m&Z&e&Z'GddeejPZ)ddZ*e+dk(re*yy)) annotations)CLIN) constants)context)option_helpers)TaskQueueManager) to_nativeto_text)boolean)parse_kv)Play) list_plugins) module_loaderfragment_loader) plugin_docs)stringc)DisplayceZdZdZdZgZddiZejxs ejZ fdZ fdZ fdZ dZd Zd Zd Zd5d Zd ZdZdZdZdZdZeZeZdZdZdZdZdZdZ dZ!dZ"dZ#dZ$dZ%dZ&dZ'd Z(d!Z)d"Z*d#Z+d$Z,d%Z-d&Z.d'Z/d(Z0d)Z1d*Z2d+Z3d,Z4d-Z5e4Z6e5Z7d.Z8d/Z9d0Z:d1Z;d2Z<fd3Z=d4Z>xZ?S)6 ConsoleCLIa A REPL that allows for running ad-hoc tasks against a chosen inventory from a nice shell with built-in tab completion (based on dominis' ``ansible-shell``). It supports several commands, and you can modify its configuration at runtime: - ``cd [pattern]``: change host/group (you can use host patterns eg.: ``app*.dc*:!app01*``) - ``list``: list available hosts in the current path - ``list groups``: list groups included in the current path - ``become``: toggle the become flag - ``!``: forces shell module instead of the ansible module (``!yum update -y``) - ``verbosity [num]``: set the verbosity level - ``forks [num]``: set the number of forks - ``become_user [user]``: set the become_user - ``remote_user [user]``: set the remote_user - ``become_method [method]``: set the privilege escalation method - ``check [bool]``: toggle check mode - ``diff [bool]``: toggle diff mode - ``timeout [integer]``: set the timeout of tasks in seconds (0 to disable) - ``help [command/module]``: display documentation for the command or module - ``exit``: exit ``ansible-console`` zansible-consolez host-patternzA name of a group in the inventory, a shell-like glob selecting hosts in inventory or any combination of the two separated by commas.chtt| |d|_g|_g|_d|_d|_d|_t|_ d|_ d|_ d|_ d|_d|_d|_d|_d|_d|_d|_t*j,j|y)NzAWelcome to the ansible console. Type help or ? to list commands. *)superr__init__introgroupshostspatternvariable_managerloaderdict passwordscwd remote_userbecome become_user become_method check_modediffforks task_timeout collectionscmdCmd)selfargs __class__s C/home/dcms/DCMS/lib/python3.12/site-packages/ansible/cli/console.pyrzConsoleCLI.__init__Ks j$(.Y    $   !    ctt| ddtj|j tj |j tj|j tj|j tj|j tj|j tj|j tj|j tj|j tj|j |j jddddd|j jd d d d y)Nz)REPL console for executing Ansible tasks.zgThis is not a live session/connection: each task is executed in the background and returns its results.)descepilogrz host patternall?)helpmetavardefaultnargsz--stepstep store_truez4one-step-at-a-time: confirm each task before running)destactionr8)rr init_parseropt_helpadd_runas_optionsparseradd_inventory_optionsadd_connect_optionsadd_check_optionsadd_vault_optionsadd_fork_optionsadd_module_optionsadd_basedir_optionsadd_runtask_optionsadd_tasknoplay_options add_argument)r.r0s r1r@zConsoleCLI.init_parsergs j$+<| ,  ""4;;/&&t{{3$$T[[1""4;;/""4;;/!!$++.##DKK0$$T[[1$$T[[1'' 4   \ail m   |&\ ! ^r2ctt| |}|jt_|j |dd|S)NT) runas_opts fork_opts)rrpost_process_args verbositydisplayvalidate_conflicts)r.optionsr0s r1rQzConsoleCLI.post_process_args|s< D;GD#-- DDIr2ct|SN)dirr.s r1 get_nameszConsoleCLI.get_namess 4yr2c tjj|y#t$r|jYyt$r%|j d|j |YywxYw)Nz[Ansible-console was exited])r,r-cmdloopKeyboardInterruptEOFErrorrSdo_exitrYs r1r\zConsoleCLI.cmdloopsP  GGOOD !   LLN  LL7 8 LL  s"A**A*)A*c|jxstj}|jj |j |_d||j t|j |jfz}|jr$|jdvr|dz }tj}n|dz }|j}t||d|_y)Nz%s@%s (%d)[f:%s])Nrootz# z$ T)wrap_nonvisible_chars)r#getpassgetuser inventory list_hostsr"selectedlenr)r$r%C COLOR_ERROR NORMAL_PROMPTrprompt)r. login_userrlcolors r1 set_promptzConsoleCLI.set_prompts%%:): 11$((; #z488S=OQUQ[Q[&\\ ;;4++~= dNFMME dNF&&Efe4H r2c.td|jS)Nmodule)rr+rYs r1 list_moduleszConsoleCLI.list_modulessHd&6&677r2c Z|jdry|jstjdyd}|}|dur?|j ^}}t j |r|}|rdj|}nd}|jr |j}n6tjr$tjdk7rtj}nd }d } |tjv} tt|t||  |j } td|jd| g|j |j"|j$|j&|j(|j*|j, } t/j1| |j2|j4} d |_ t=|j>|j2|j4|j@|tjd|jB|_|j:jE| }tjG||j:r|j:jI|j4r|j4jK |tjdyy #t6$r+} tjdt9| zYd } ~ yd } ~ wwxYw#|j:r|j:jI|j4r|j4jKwwxYw#tL$rtjdYyt6$r^} |jNdk\r'dd l(}tjS|jUtjt9| Yd } ~ yd } ~ wwxYw)z actually runs modules #Fz No host foundshellT r:minimalN) check_raw)rqr/)r?timeoutz Ansible Shellno) namer gather_factstasksr#r$r%r&r'r(r+)rrzUnable to build command: %s)rerrr!stdout_callbackrun_additional_callbacksrun_treer)zNo hosts foundzUser interrupted executionr)+ startswithr"rSerrorsplitr find_pluginjoincallbackriDEFAULT_LOAD_CALLBACK_PLUGINSDEFAULT_STDOUT_CALLBACK_ACTION_ALLOWS_RAW_ARGSr r r*r#r$r%r&r'r(r+r loadrr Exceptionr _tqmrrer!r)rundebugcleanupcleanup_all_tmp_filesr]rR tracebackv format_exc)r.line forceshellrq module_argspossible_module possible_argscbresultrytaskplay_dsplayers r1r:zConsoleCLI.defaults ??3 xx MM/ * T !.2jjl +Om((9( "%((="9K"$K ==B  , ,1J1Ji1W**BB !";";;It6Xa8bcmqm~m~D$hh!f ,,{{ ,,"00??YY ,, G6;;w9N9NW[WbWb;cD " DI 8,"nn%)%:%:;;"nn$&-.-L-L"**  t, f%99II%%';;KK557~ ./7  MM871:E F ,99II%%';;KK557 !  MM6 7 ~~"  )..01 MM'!* %  sSCJ%L$-BK5A$L$ K$!K  KAL!!L$$N*N* AN%%N*cyrWrYs r1 emptylinezConsoleCLI.emptylinesr2c(|j|dy)a You can run shell commands through the shell module. eg.: shell ps uax | grep java | wc -l shell killall python shell halt -n You can use the ! to force the shell module. eg.: !ps aux | grep java | wc -l TNr:r.args r1do_shellzConsoleCLI.do_shells S$r2c.tjdy)Nz4You can run shell commands through the shell module.rSrYs r1 help_shellzConsoleCLI.help_shellsNOr2c|r? t|}dkDr||_|j ytjdy|j y#t$r(tjd|j YtwxYw)zSet the number of forkszInvalid argument for "forks"rz(forks must be greater than or equal to 1N)int TypeErrorrSr usage_forksr)ro)r.rr)s r1do_forkszConsoleCLI.do_forks sr  #C qy" ! JK     # <=  " #s A.BBcNtjd|jy)Nz'Set the number of forks to use per task)rSrrYs r1 help_forkszConsoleCLI.help_forkssAB r2c.tjdy)NzUsage: forks rrYs r1rzConsoleCLI.usage_forks!s/0r2c|dvrd|_ng|s|jnT|jd}|D]>}|jg|_|jj|j @|jr2t j ddj|jzyt j dy)z.Set list of collections for 'short name' usage)rwnoneN,z%Collections name search is set to: %sz, z)Collections name search is using defaults)r+usage_collectionsrappendstriprSrr)r.rr+ collections r1do_collectionszConsoleCLI.do_collections's , #D   " " $))C.K) < ##+')D$  '' (8(8(:; <    II= $JZJZ@[[ \ IIA Br2cNtjd|jy)NzFSet the collection name search path when using short names for plugins)rSrrYs r1help_collectionszConsoleCLI.help_collections9s`a  r2c.tjdy)NzgUsage: collections [, ...] Use empty quotes or "none" to reset to default. rrYs r1rzConsoleCLI.usage_collections=sD Er2c|stjdy t|t_tjd|zy#tt f$r+}tj dt|zYd}~yd}~wwxYw)zSet verbosity levelzUsage: verbosity zverbosity level set to %sz)The verbosity must be a valid integer: %sN)rSrrRrr ValueErrorrr )r.rrs r1 do_verbosityzConsoleCLI.do_verbosity@sg OO7 8 X$'H! 5;<z* X IGTUJVWW Xs,AB!A<<Bc.tjdy)Nz@Set the verbosity level, equivalent to -v for 1 and -vvvv for 4.rrYs r1help_verbosityzConsoleCLI.help_verbosityKsZ[r2c|sd|_nD|dvrd|_n8|jj|r||_ntjd|j y)a Change active host/group. You can use hosts patterns as well eg.: cd webservers cd webservers:dbservers cd webservers:!phoenix cd webservers:&staging cd webservers:dbservers:&staging:!phoenix rz/*r6zno host matchedN)r"re get_hostsrSrors r1do_cdzConsoleCLI.do_cdNsLDH D[DH ^^ % %c *DH OO- . r2cNtjd|jy)NzChange active host/group. )rSusage_cdrYs r1help_cdzConsoleCLI.help_cdbs45 r2c.tjdy)Nz'Usage: cd ||rrYs r1rzConsoleCLI.usage_cdfsABr2c |s1|jD]!}tj|j#y|dk(r'|jD]}tj|ytj d|j y)z#List the hosts in the current grouprzInvalid option passed to "list"N)rgrSr|rr help_list)r.rhostgroups r1do_listzConsoleCLI.do_listisg  + * + H_ '& ' MM; < NN r2c.tjdy)NzLList the hosts in the current group or a list of groups if you add 'groups'.rrYs r1rzConsoleCLI.help_listusfgr2c|rEt|d|_tjd|jz|j ytjdy)z$Toggle whether plays run with becomeFstrictzbecome changed to %sz.Please specify become value, e.g. `become yes`N)r r$rSrrors r1 do_becomezConsoleCLI.do_becomexs@ !#e4DK II,t{{: ; OO  OOL Mr2c.tjdy)Nz,Toggle whether the tasks are run with becomerrYs r1 help_becomezConsoleCLI.help_becomesFGr2cb|r||_|jytjdy)z6Given a username, set the remote user plays are run byz5Please specify a remote user, e.g. `remote_user root`N)r#rorSrs r1do_remote_userzConsoleCLI.do_remote_users$ "D  OO  OOS Tr2c.tjdy)Nz2Set the user for use as login to the remote targetrrYs r1help_remote_userzConsoleCLI.help_remote_usersLMr2c|r||_n7tjdtjd|jz|jy)zFGiven a username, set the user that plays are run by when using becomez1Please specify a user, e.g. `become_user jenkins`zCurrent user is %sN)r%rSrrors r1do_become_userzConsoleCLI.do_become_users< "D  OOO P II*T-=-== > r2c.tjdy)NznSet the user for use with privilege escalation (which remote user attempts to 'become' when become is enabled)rrYs r1help_become_userzConsoleCLI.help_become_usersI Jr2c|r*||_tjd|jzytjdtjd|jzy)zLGiven a become_method, set the privilege escalation method when using becomezbecome_method changed to %sz7Please specify a become_method, e.g. `become_method su`zCurrent become_method is %sN)r&rSrrs r1do_become_methodzConsoleCLI.do_become_methodsJ !$D  II3d6H6HH I OOU V II3d6H6HH Ir2c.tjdy)NzASet the privilege escalation plugin to use when become is enabledrrYs r1help_become_methodzConsoleCLI.help_become_methods[\r2c|r5t|d|_tjd|jzytjdtjd|jzy)z(Toggle whether plays run with check modeFrzcheck mode changed to %sz1Please specify check mode value, e.g. `check yes`zcheck mode is currently %s.N)r r'rSrrs r1do_checkzConsoleCLI.do_checksL %c%8DO OO6H I OOO P II3dooE Fr2c.tjdy)NzToggle check_mode for the tasksrrYs r1 help_checkzConsoleCLI.help_checks9:r2c|r5t|d|_tjd|jzytjdtjd|jzy)z"Toggle whether plays run with diffFrzdiff mode changed to %sz-Please specify a diff value , e.g. `diff yes`zdiff mode is currently %sN)r r(rSrrs r1do_diffzConsoleCLI.do_diffsL E2DI OO5 A B OOK L II1DII= >r2c.tjdy)Nz Toggle diff output for the tasksrrYs r1 help_diffzConsoleCLI.help_diffs:;r2c|r0 t|}|dkrtjdn||_yy|jy#tt f$r+}tjdt |zYd}~yd}~wwxYw)zSet the timeoutrz@The timeout must be greater than or equal to 1, use 0 to disablezAThe timeout must be a valid positive integer, or 0 to disable: %sN)rrSrr*rrr usage_timeout)r.rrzrs r1 do_timeoutzConsoleCLI.do_timeoutsy  pc(Q;MM"de(/D%f    z* p adklmdnnoo ps-AA>!A99A>cNtjd|jy)NzSet task timeout in seconds)rSrrYs r1 help_timeoutzConsoleCLI.help_timeouts56 r2c.tjdy)NzUsage: timeout rrYs r1rzConsoleCLI.usage_timeouts23r2cBtjjdy)zExits from the consolez Ansible-console was exited. )sysstdoutwrite)r.r/s r1r_zConsoleCLI.do_exits :;r2c.tjdy)NzLEAVE!rrYs r1 help_exitzConsoleCLI.help_exits!r2c|rtj|}|rtj|t\}}}}|rt j |dt j d|dj D]@}t j dt||jzdz|d|ddzByt jd|zyt jd |zyy) Nshort_descriptionz Parameters:rUz rv descriptionrzNo documentation found for %s.z<%s is not a valid command, use ? to list all valid commands.) rrr get_docstringrrSkeysrrkr)r. module_namein_pathoca_dummy1_dummy2opts r1 helpdefaultzConsoleCLI.helpdefaults #// >+D+DTXX+NOa166OKO-8fIaL|jd|jvru|jdd}t|t|z }|j|jd}|Dcgc]}|j |s||ddzc}Sycc}w)Nrrvr=)rrrrhrr) r.r rr rrrrrs r1completedefaultzConsoleCLI.completedefaults ::<?d//1 1JJsOB'Eu:D )D**4::<?;K,7Oq1<<;NAdeHsNO O 2 Ps 5B Bctj|}tj|td\}}}}t |dj S)NT) is_modulerU)rrrrrlistr)r.rrrrrrs r1rzConsoleCLI.module_argssH++K8"-";";G_`d"eAwByM&&())r2chtt d}d}tjd_j _tjd_tjd_tjd_ tjd_ tjd_ tjd_ tjd_ tjd _tjd r0tjd D]}|stj |j#_j$D],}t'd |z|ffd t'd |z|ffd .j)\}}||d_j-\___j5j0tjdj }j0j7_|Dcgc]}|j:c}_dt>j@vrt?jBdnt?jBdtDjFjItDjFjKdd} t?jL|tQjRt>jT|jWjYycc}w#tN$rYUwxYw)Nrr#r$r%r&checkr(r)r* module_pathdo_c2j|dz|zSNrvrrrqr.s r1z ConsoleCLI.run..'sT\\RX[^R^adRdEer2help_c&j|SrWrrqr.s r1r"z ConsoleCLI.run..(s$BRBRSYBZr2) conn_pass become_passsubsetlibeditzbind ^I rl_completez tab: complete~z.ansible-console_history)-rrrrCLIARGSrr"r#r$r%r&r'r(r)r*r add_directoryrrmodulessetattr ask_passwordsr! _play_prereqsrrer get_host_list list_groupsrr|rreadline__doc__parse_and_bindospathr expanduserread_history_fileIOErroratexitregisterwrite_history_fileror\) r.sshpass becomepassr8rqrrhistfiler0s ` r1rzConsoleCLI.run st j$#% y1 <<#??=9ooh/ "??=9$___=!//'2OOF+ __W- #OON; ??= ) 6 6!//5 6 ((* ll \F D%&.V*e f D'F*&,Z [ \!% 2 2 4*'.zJ=A=O=O=Q: T^T%:""4>>7??83Ldll[nn002 &+,aff,  (( (  # #$9 :  # #O 477<< 2 23 79ST   & &x 0 33X>  #-   s0L L%% L10L1cd}|jdrP|jdd}tj|rt ||ffd t j |}n`|jdrO|jdd}tj|r(t ||ffd t j |}|tjd|d|S) z[ handle not found to populate dynamically a module function if module matching name exists Nrrwc2j|dz|zSr rr!s r1r"z(ConsoleCLI.__getattr__..Lst||FUXL[^L^?_r2r#c&j|SrWr%r&s r1r"z(ConsoleCLI.__getattr__..Qs$:J:J6:Rr2z does not have a z attribute) rreplacerrr/object __getattr__AttributeErrorr0)r.r|attrrqs` r1rGzConsoleCLI.__getattr__Es ??5 !\\%,F((0dv$_`))$5 __W %\\'2.F((0d&$RS))$5 < DNN#33DTF*!UV V r2)F)@__name__ __module__ __qualname__r5r|r. ARGUMENTSriCOLOR_CONSOLE_PROMPTCOLOR_HIGHLIGHTrkrr@rQrZr\rorrr:rrrrrr do_serial help_serialrrrrrrrrrrrrrrrrrrrrrrrrrr_rdo_EOFhelp_EOFrrrrrrrG __classcell__)r0s@r1rr%s\: DG"stI**?a.?.?M8^*   I8Vp  P$1IKC$!E X\(C hNHUNJJ]G;?< !4 "FH l/ gP* :xr2rc.tj|yrW)r cli_executor)r/s r1mainrWZsD!r2__main__rW), __future__r ansible.clirr<r,rcr4r7ransiblerriransible.cli.argumentsrrA#ansible.executor.task_queue_managerr+ansible.module_utils.common.text.convertersr r )ansible.module_utils.parsing.convert_boolr ansible.parsing.splitterr ansible.playbook.playr ansible.plugins.listransible.plugins.loaderrr ansible.utilsransible.utils.colorransible.utils.displayrrSr-rrWrJrr2r1rgs}#  "<@J=-&-A%') )rcggrj" zFr2