Stop-VM
Resumo
- O comando cmdlet Stop-VM para, desliga ou salva uma VM
Parâmetros
Parâmetro | Tipo | Escolhas | Valor Padrão | Comentários |
|---|---|---|---|
-AsJob | boolean | | Executa o cmdlet como um trabalho de background |
-CimSession | string | | Executa o cmdlet em uma sessão remota ou em um computador remoto. Insira um nome de computador ou um objeto de sessão, como a saída de um cmdlet New-CimSession ou Get-CimSession . O padrão é a sessão atual no computador local. |
-ComputerName | string | | Especifica um ou mais hosts Hyper-V dos quais as máquinas virtuais devem ser recuperadas. Nomes NetBIOS, endereços IP e nomes de domínio totalmente qualificados são permitidos. O padrão é o computador local. Use localhost ou um ponto (.) para especificar o computador local explicitamente. |
-Confirm | boolean | | Requere de você uma cofirmação antes de executar o cmdlet |
-Credential | string | | Especifica uma ou mais contas de usuário que têm permissão para executar esta ação. O padrão é o usuário atual. |
-Force | boolean | | Especifica que o desligamento da VM deve ser forçado. Se a VM tiver dados não salvos, a VM terá 5 minutos para salvar. Se a VM estiver em modo locked, será desligada imediatamente. |
-Name | string | | Especifica o nome da máquina virtual a ser desligada. |
-Passthru | boolean | | Especifica que o objeto Microsoft.HyperV.PowerShell.VirtualMachine é para ser passado através de uma pipeline representando a VM a ser iniciada |
-Save | boolean | | Especifica que a VM deve ser salva |
-TurnOff | boolean | | Especifica que a VM deve ser desligada |
-VM | string | | Especifica a VM a ser iniciada |
-WhatIf | boolean | | Mostra o que aconteceria se o cmdlet for executado. O cmdlet não é executado. |
Exemplos
tasks:
# Desliga a VM através do sistema operacional do guest
powershell_command:
server: {{ server }}
username: {{ username }}
password: {{ password }}
command: |
Stop-VM -Name VMName
register: result
- debug:
msg: |
{{ result.output }}
{{ result.had_errors }}
{{ result.output_errors }}
{{ result.output_warnings }}
# Desliga a VM através do sistema operacional do guest, sem considerar
# dados não salvos, Hyper-V dá 5 minutos para os guest salvar os dados antes
# de forçar o desligamento
#(pode resultar em dados não salvos)
powershell_command:
server: {{ server }}
username: {{ username }}
password: {{ password }}
command: |
Stop-VM -Name VM1 -Force
register: result
- debug:
msg: |
{{ result.output }}
{{ result.had_errors }}
{{ result.output_errors }}
{{ result.output_warnings }}
# Desliga a VM, equivalente a tirar a desligar a energia da VM (pode resultar em dados não salvos)
powershell_command:
server: {{ server }}
username: {{ username }}
password: {{ password }}
command: |
Stop-VM -Name TestVM -TurnOff
register: result
- debug:
msg: |
{{ result.output }}
{{ result.had_errors }}
{{ result.output_errors }}
{{ result.output_warnings }}Valores retornados
Chave | Tipo | Retornado quando | Descrição |
|---|---|---|---|
output | string | Sempre | Saída da execução |
had_errors | boolean | Sempre | Se teve erros |
output_errors | string | Sempre | erros de saída da execução |
output_warnings | string | Sempre | Avisos de saída |