VhK7ddlmZdZdZdZddlZddlZddlZddlZddl m Z ddl m Z m Z mZddlmZd Zed k(reyy) ) annotationsa. --- module: command short_description: Execute commands on targets version_added: historical description: - The M(ansible.builtin.command) module takes the command name followed by a list of space-delimited arguments. - The given command will be executed on all selected nodes. - The command(s) will not be processed through the shell, so operations like C("*"), C("<"), C(">"), C("|"), C(";") and C("&") will not work. Also, environment variables are resolved via Python, not shell, see O(expand_argument_vars) and are left unchanged if not matched. Use the M(ansible.builtin.shell) module if you need these features. - To create C(command) tasks that are easier to read than the ones using space-delimited arguments, pass parameters using the C(args) L(task keyword,https://docs.ansible.com/ansible/latest/reference_appendices/playbooks_keywords.html#task) or use O(cmd) parameter. - Either a free form command or O(cmd) parameter is required, see the examples. - For Windows targets, use the M(ansible.windows.win_command) module instead. extends_documentation_fragment: - action_common_attributes - action_common_attributes.raw attributes: check_mode: details: while the command itself is arbitrary and cannot be subject to the check mode semantics it adds O(creates)/O(removes) options as a workaround support: partial diff_mode: support: none platform: support: full platforms: posix raw: support: full options: expand_argument_vars: description: - Expands the arguments that are variables, for example C($HOME) will be expanded before being passed to the command to run. - If a variable is not matched, it is left unchanged, unlike shell substitution which would remove it. - Set to V(false) to disable expansion and treat the value as a literal argument. type: bool default: true version_added: "2.16" free_form: description: - The command module takes a free form string as a command to run. - There is no actual parameter named C(free_form). cmd: type: str description: - The command to run. argv: type: list elements: str description: - Passes the command as a list rather than a string. - Use O(argv) to avoid quoting values that would otherwise be interpreted incorrectly (for example "user name"). - Only the string (free form) or the list (argv) form can be provided, not both. One or the other must be provided. version_added: "2.6" creates: type: path description: - A filename or (since 2.0) glob pattern. If a matching file already exists, this step B(will not) be run. - This is checked before O(removes) is checked. removes: type: path description: - A filename or (since 2.0) glob pattern. If a matching file exists, this step B(will) be run. - This is checked after O(creates) is checked. version_added: "0.8" chdir: type: path description: - Change into this directory before running the command. version_added: "0.6" stdin: description: - Set the stdin of the command directly to the specified value. type: str version_added: "2.4" stdin_add_newline: type: bool default: yes description: - If set to V(true), append a newline to stdin data. version_added: "2.8" strip_empty_ends: description: - Strip empty lines from the end of stdout/stderr in result. version_added: "2.8" type: bool default: yes notes: - If you want to run a command through the shell (say you are using C(<), C(>), C(|), and so on), you actually want the M(ansible.builtin.shell) module instead. Parsing shell metacharacters can lead to unexpected commands being executed if quoting is not done correctly so it is more secure to use the M(ansible.builtin.command) module when possible. - O(creates), O(removes), and O(chdir) can be specified after the command. For instance, if you only want to run a command if a certain file does not exist, use this. - Check mode is supported when passing O(creates) or O(removes). If running in check mode and either of these are specified, the module will check for the existence of the file and report the correct changed status. If these are not supplied, the task will be skipped. - The O(ignore:executable) parameter is removed since version 2.4. If you have a need for this parameter, use the M(ansible.builtin.shell) module instead. - For Windows targets, use the M(ansible.windows.win_command) module instead. - For rebooting systems, use the M(ansible.builtin.reboot) or M(ansible.windows.win_reboot) module. - If the command returns non UTF-8 data, it must be encoded to avoid issues. This may necessitate using M(ansible.builtin.shell) so the output can be piped through C(base64). seealso: - module: ansible.builtin.raw - module: ansible.builtin.script - module: ansible.builtin.shell - module: ansible.windows.win_command author: - Ansible Core Team - Michael DeHaan a - name: Return motd to registered var ansible.builtin.command: cat /etc/motd register: mymotd # free-form (string) arguments, all arguments on one line - name: Run command if /path/to/database does not exist (without 'args') ansible.builtin.command: /usr/bin/make_database.sh db_user db_name creates=/path/to/database # free-form (string) arguments, some arguments on separate lines with the 'args' keyword # 'args' is a task keyword, passed at the same level as the module - name: Run command if /path/to/database does not exist (with 'args' keyword) ansible.builtin.command: /usr/bin/make_database.sh db_user db_name args: creates: /path/to/database # 'cmd' is module parameter - name: Run command if /path/to/database does not exist (with 'cmd' parameter) ansible.builtin.command: cmd: /usr/bin/make_database.sh db_user db_name creates: /path/to/database - name: Change the working directory to somedir/ and run the command as db_owner if /path/to/database does not exist ansible.builtin.command: /usr/bin/make_database.sh db_user db_name become: yes become_user: db_owner args: chdir: somedir/ creates: /path/to/database # argv (list) arguments, each argument on a separate line, 'args' keyword not necessary # 'argv' is a parameter, indented one level from the module - name: Use 'argv' to send a command as a list - leave 'command' empty ansible.builtin.command: argv: - /usr/bin/make_database.sh - Username with whitespace - dbname with whitespace creates: /path/to/database - name: Run command using argv with mixed argument formats ansible.builtin.command: argv: - /path/to/binary - -v - --debug - --longopt - value for longopt - --other-longopt=value for other longopt - positional - name: Safely use templated variable to run command. Always use the quote filter to avoid injection issues ansible.builtin.command: cat {{ myfile|quote }} register: myoutput u msg: description: changed returned: always type: bool sample: True start: description: The command execution start time. returned: always type: str sample: '2017-09-29 22:03:48.083128' end: description: The command execution end time. returned: always type: str sample: '2017-09-29 22:03:48.084657' delta: description: The command execution delta time. returned: always type: str sample: '0:00:00.001529' stdout: description: The command standard output. returned: always type: str sample: 'Clustering node rabbit@slave1 with rabbit@master …' stderr: description: The command standard error. returned: always type: str sample: 'ls cannot access foo: No such file or directory' cmd: description: The command executed by the task. returned: always type: list sample: - echo - hello rc: description: The command return code (0 means success). returned: always type: int sample: 0 stdout_lines: description: The command standard output split in lines. returned: always type: list sample: [u'Clustering node rabbit@slave1 with rabbit@master …'] stderr_lines: description: The command standard error split in lines. returned: always type: list sample: [u'ls cannot access foo: No such file or directory', u'ls …'] N) AnsibleModule) to_nativeto_bytesto_text) is_iterablecrttttddtddtdttdd tdtdtd tdd tdd  d }|jd }|jd}|jd}|jd}|jd}|jd}|jd}|jd}|jd} |jd} |jd} dddddddddd } |s|r|jd|zd}|r|j dk(r|sd| d<d| d<|j d:i| |r|rd| d<d| d<|j d:i| |s|rt j|}|xs|}t|d r|D cgc]} t| d!d"#}} || d$<|r#t|d!%} tj||j rd'}nd(}|r-t#j"|r|d)|d*| d<d+|z| d,<d-| d<| ds/|r-t#j"|s|d)|d.| d<d/|z| d,<d-| d<| dr|j$d:i| d | d0<|j sit&j&j)| d1<|j+|||d|| | 2\| d<| d,<| d3<t&j&j)| d4<nd-| d<d5| d<| | d | d6<d| d0<| d1>| d49t| d4| d1z | d7<t| d4| d4<t| d1| d1<| r@t| d,j-d8| d,<t| d3j-d8| d3<| dd-k7rd9| d<|j d:i| |j$d:i| ycc} w#ttf$r.}d&t|z| d<|j d:i| Yd}~d}~wwxYw);NboolF)typedefaultliststr)r elementspath)r T)required) _raw_params _uses_shellargvchdir executableexpand_argument_varscreatesremovesstdinstdin_add_newlinestrip_empty_ends) argument_specsupports_check_moderrrrrrrrrrr) changedstdoutstderrrccmdstartenddeltamsgzoAs of Ansible 2.4, the parameter 'executable' is no longer supported with the 'command' module. Not using '%s'.r#zno command givenr(z+only command or argv can be given, not both)include_stringssurrogate_or_strict simplerepr)errors nonstringr$)r-z/Unable to change directory before execution: %sWouldDidz not run command since 'z' existszskipped, since %s existsr!rz' does not existz skipped, since %s does not existr r%)ruse_unsafe_shellencodingdata binary_dataexpand_user_and_varsr"r&z+Command would have run if not in check modeskippedr'z znon-zero return code)rdictparamswarnstrip fail_jsonshlexsplitrrrosrIOErrorOSErrorr check_modeglob exit_jsondatetimenow run_commandrstrip)moduleshellrrargsrrrrrr;rrargeshouldas G/home/dcms/DCMS/lib/python3.12/site-packages/ansible/modules/command.pymainrQs &%86E2F#v!%64!@f%f%&"=!vt<  !F" MM- (E MM' "E|,J == 'D == DmmI&GmmI&G MM' "E &9: MM, -E!==)?@R2T$Y]fjuyCE FA Z FISS T DJJLB&$%%1 $@%1 T{{4  <4D4/`deY\ #&;|TeeAeH '<= " HHUO  99W AH'RAeH4w>AhKAdG U8yy!IPRYZAeH,>tPZmr~BDI\mXmTh-?-j)$8ak$$((*%$@% ?wAiL AiL z!E("6QuX' 23' 1U8$%QwZ('  ak*11&9( ak*11&9( w!|)%1FqMf! "H7ST:UAeH F   !q ! ! "sO4 O99P6#P11P6__main__) __future__r DOCUMENTATIONEXAMPLESRETURNrErCr?r=ansible.module_utils.basicr+ansible.module_utils.common.text.convertersrrr'ansible.module_utils.common.collectionsrrQ__name__r7rPr\sX#n `6 p5 n 4TT?D zFr[