Nota

Questo plugin fa parte del pacchetto raccolta community.vmware (versione 1.7.0).

Per installarlo utilizzare: ansible-galaxy collection install community.vmware.

Per usarlo in un playbook, specificare: community.vmware.vmware_guest_screenshot.

  • Sinossi
  • Requisiti
  • Parametri
  • Note
  • Esempi
  • Valori di ritorno

Sinossi

  • Questo modulo viene utilizzato per scattare una schermata della macchina virtuale indicata quando la macchina virtuale è accesa.
  • Tutti i parametri e i nomi degli oggetti VMware sono sensibili alle maiuscole.

Requisiti

I seguenti requisiti sono necessari sull'host che esegue questo modulo.

  • python >= 2.6
  • PyVmomi

Parametri

Parametri Scelte/Defaults Commenti
clusterstringa Il nome del cluster in cui è in esecuzione la macchina virtuale.Questo è un parametro obbligatorio, se esxi_hostname non è impostato.esxi_hostname e cluster sono parametri che si escludono a vicenda.
centro datistringa Il nome del datacenter a cui appartiene la macchina virtuale.
esxi_hostnamestringa Il nome dell'host ESXi in cui è in esecuzione la macchina virtuale.Questo è un parametro obbligatorio, se cluster non è impostato.esxi_hostname e cluster sono parametri che si escludono a vicenda.
cartellastringa Cartella di destinazione, percorso assoluto o relativo per trovare un guest esistente.Questo è un parametro obbligatorio, solo se vengono trovate più macchine virtuali con lo stesso nome.La cartella deve includere il datacenter. Il datacenter del server ESXi è ha-datacenter.Esempi:cartella: /ha-datacenter/vmcartella: ha-datacenter/vmcartella: /datacenter1/vmfolder: datacenter1/vmfolder: /datacenter1/vm/folder1folder: datacenter1/vm/folder1folder: /cartella1/datacenter1/vmfolder: cartella1/datacenter1/vmfolder: /cartella1/datacenter1/vm/cartella2
hostnamestringa Il nome dell'host o l'indirizzo IP del server vSphere vCenter o ESXi. Se il valore non è specificato nell'attività, il valore della variabile d'ambiente VMWARE_HOST Il supporto per le variabili d'ambiente è stato aggiunto in Ansible 2.6.
percorso_localepercorso Se local_path non è impostato, il file di screenshot creato verrà conservato nella directory della macchina virtuale sull'host ESXi. Se local_path è impostato su un percorso valido sulla macchina locale, il file di screenshot verrà scaricato dall'host ESXi nella directory locale. Se non si scarica il file di screenshot sulla macchina locale, è possibile aprirlo manualmente tramite l'URL del file restituito nei fatti di screenshot.
moidstringa Managed Object ID dell'istanza da gestire, se noto; si tratta di un identificatore univoco solo all'interno di una singola istanza di vCenter.Questo è richiesto se name o uuid non sono forniti.
nomestringa Nome della macchina virtuale. Questo è un parametro obbligatorio, se il parametro uuid o moid non sono forniti.
passwordstringa La password del vSphere vCenter o del server ESXi. Se il valore non è specificato nell'attività, il valore della variabile d'ambiente VMWARE_PASSWORD Il supporto per le variabili d'ambiente è stato aggiunto in Ansible 2.6.
alias: pass, pwd
portaintero Predefinito:
443
Il numero di porta del server vSphere vCenter o ESXi. Se il valore non è specificato nell'attività, il valore della variabile d'ambiente VMWARE_PORT Il supporto delle variabili d'ambiente è stato aggiunto in Ansible 2.6.
proxy_hoststringa Indirizzo di un proxy che riceverà tutte le richieste HTTPS e le inoltrerà. Il formato è un hostname o un IP. Se il valore non è specificato nel task, il valore della variabile d'ambiente VMWARE_PROXY_HOST Questa funzione dipende da una versione di pyvmomi superiore alla v6.7.1.2018.12.
porta_proxyintero Porta del proxy HTTP che riceverà tutte le richieste HTTPS e le inoltrerà. Se il valore non è specificato nel task, il valore della variabile d'ambiente VMWARE_PROXY_PORT verrà utilizzato al suo posto.
nome utentestringa Il nome utente del vSphere vCenter o del server ESXi. Se il valore non è specificato nell'attività, il valore della variabile d'ambiente VMWARE_USER Se il valore non è specificato nel task, verrà utilizzato il valore della variabile d'ambiente VMWARE_USER.
alias: admin, user
uuidstringa UUID dell'istanza da raccogliere, se noto, questo è l'identificatore univoco di VMware. Questo è un parametro obbligatorio, se il parametro name o moid non sono forniti.
convalida_certbooleano
    Scelte:

  • no
Consente la connessione quando i certificati SSL non sono validi. Impostare su false se i certificati non sono attendibili. Se il valore non è specificato nel task, il valore della variabile d'ambiente VMWARE_VALIDATE_CERTS aggiunto in Ansible 2.6.Se impostato a trueassicurarsi che Python >= 2.7.9 sia installato sulla macchina in questione.

Note

Nota

  • Testato su vSphere 6.5 e 6.7

Esempi

-name: take a screenshot of the virtual machine console
  community.vmware.vmware_guest_screenshot:hostname:"{{ vcenter_hostname }}"username:"{{ vcenter_username }}"password:"{{ vcenter_password }}"datacenter:"{{ datacenter_name }}"folder:"{{ folder_name }}"name:"{{ vm_name }}"local_path:"/tmp/"delegate_to: localhost
  register: take_screenshot

-name: Take a screenshot of the virtual machine console using MoID
  community.vmware.vmware_guest_screenshot:hostname:"{{ vcenter_hostname }}"username:"{{ vcenter_username }}"password:"{{ vcenter_password }}"datacenter:"{{ datacenter_name }}"folder:"{{ folder_name }}"moid: vm-42local_path:"/tmp/"delegate_to: localhost
  register: take_screenshot

Valori di ritorno

I valori di ritorno più comuni sono documentati qui, i seguenti sono i campi unici di questo modulo:

Chiave Restituito Descrizione
screenshot_infodizionario sempre visualizza i fatti del file di screenshot della macchina virtuale catturato
Esempio:{'download_file_size': 2367, 'download_local_path': '/tmp/', 'result': 'success', 'screenshot_file': '[datastore0] test_vm/test_vm-1.png', 'screenshot_file_url': 'https://test_vcenter/folder/test_vm/test_vm-1.png?dcPath=test-dc&dsName=datastore0', 'task_complete_time': '2019-05-25T10:35:04.412622Z', 'task_start_time': '2019-05-25T10:35:04.215016Z', 'virtual_machine': 'test_vm'}

Autori