VMware VM Shell

5 min

Resumo

O módulo permite que o usuário execute comandos comuns de administração do sistema no sistema operacional convidado.

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
datacenter	string		Se definido como C(vm), as informações serão coletadas apenas para máquinas virtuais. Se definido como C(template), as informações são coletadas apenas para modelos de máquinas virtuais. Se definido como C(all), as informações serão reunidas para todas as máquinas virtuais e modelos de máquina virtual.
cluster	bool	False True	Atributos relacionados ao convidado da VM mostrados nas informações somente quando isso é definido como C(true).
folder	string		Especifique um local de pasta de VMs para coletar informações
vm_id	bool		Nome da máquina virtual com a qual trabalhar.
vm_id_type	string	uuid instance_uuid dns_name inventory_path vm_name	O método de identificação VMware pelo qual a máquina virtual será identificada.
vm_username	string		O usuário deve fazer login na máquina virtual.
vm_password	string		A senha usada para fazer login na máquina virtual.
vm_shell	string		O caminho absoluto para o programa iniciar. No Linux, o shell é executado via bash.
vm_shell_args	string	" "	O argumento para o programa. Os caracteres que devem ser escapados para o shell também são escapados na linha de comando fornecida.
vm_shell_env	list		Lista separada por vírgulas de variáveis de ambiente, especificada na notação do sistema operacional convidado.
vm_shell_cwd	string		O diretório de trabalho atual do aplicativo a partir do qual ele será executado.
wait_for_process	bool	False True	Se definido como C(True), o módulo aguardará a conclusão do processo na máquina virtual fornecida.
timeout	interger	3600	Tempo limite em segundos. Se definido como inteiros positivos, C(wait_for_process) honrará esse parâmetro e sairá após esse tempo limite.

Estende fragmentos da documentação do módulo VMware Options.

Notas

Observação

Testado em ESXi 7.0.2
Todos os módulos requerem acesso de gravação API e, portanto, não são suportados em uma licença ESXi gratuita.

Exemplos

- name: Run command inside a virtual machine
  community.vmware.vmware_vm_shell:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter }}"
    folder: "/{{datacenter}}/vm"
    vm_id: "{{ vm_name }}"
    vm_username: root
    vm_password: superSecret
    vm_shell: /bin/echo
    vm_shell_args: " $var >> myFile "
    vm_shell_env:
      - "PATH=/bin"
      - "VAR=test"
    vm_shell_cwd: "/tmp"
  delegate_to: localhost
  register: shell_command_output

- name: Run command inside a virtual machine with wait and timeout
  community.vmware.vmware_vm_shell:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter }}"
    folder: "/{{datacenter}}/vm"
    vm_id: NameOfVM
    vm_username: root
    vm_password: superSecret
    vm_shell: /bin/sleep
    vm_shell_args: 100
    wait_for_process: True
    timeout: 2000
  delegate_to: localhost
  register: shell_command_with_wait_timeout

- name: Change user password in the guest machine
  community.vmware.vmware_vm_shell:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter }}"
    folder: "/{{datacenter}}/vm"
    vm_id: "{{ vm_name }}"
    vm_username: sample
    vm_password: old_password
    vm_shell: "/bin/echo"
    vm_shell_args: "-e 'old_password\nnew_password\nnew_password' | passwd sample > /tmp/$$.txt 2>&1"
  delegate_to: localhost

- name: Change hostname of guest machine
  community.vmware.vmware_vm_shell:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter }}"
    folder: "/{{datacenter}}/vm"
    vm_id: "{{ vm_name }}"
    vm_username: testUser
    vm_password: SuperSecretPassword
    vm_shell: "/usr/bin/hostnamectl"
    vm_shell_args: "set-hostname new_hostname > /tmp/$$.txt 2>&1"
  delegate_to: localhost

Valores Retornados

Chave	Tipo	Retornado quando	Descrição
results	dict	sucesso	metadados sobre o novo processo após a conclusão com wait_for_process