community.vmware.vmware_host_logbundle module – Fetch logbundle file from ESXi
Note
This module is part of the community.vmware collection (version 4.8.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.vmware
.
To use it in a playbook, specify: community.vmware.vmware_host_logbundle
.
Synopsis
This module can be used to fetch logbundle file from ESXi.
Parameters
Parameter |
Comments |
---|---|
file destination on localhost, path must be exist. |
|
The user defined timeout in seconds of exporting the log file. The default of the function this module uses is so low that you have to set this this to a higher value in all probabilty. |
|
Name of the host system to fetch the logbundle. |
|
The hostname or IP address of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
Logs to include in the logbundle file. Refer to the id key of the community.vmware.vmware_host_logbundle_info module for values that can be specified in the manifest. Default: |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
Gather performance data for ESXi. |
|
Duration for which performance data is gathered. Default: |
|
Interval for which performance data is gathered. Default: |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Default: |
|
Address of a proxy that will receive all HTTPS requests and relay them. The format is a hostname or a IP. If the value is not specified in the task, the value of environment variable |
|
Port of the HTTP proxy that will receive all HTTPS requests and relay them. If the value is not specified in the task, the value of environment variable |
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
Notes
Note
All modules requires API write access and hence is not supported on a free ESXi license.
All variables and VMware object names are case sensitive.
Examples
- name: fetch logbundle file from ESXi
community.vmware.vmware_host_logbundle:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
esxi_hostname: "{{ esxi_hostname }}"
dest: ./esxi-log.tgz
- name: fetch logbundle file from ESXi with manifests
community.vmware.vmware_host_logbundle:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
esxi_hostname: "{{ esxi_hostname }}"
dest: ./esxi-log.tgz
manifests:
- System:Base
- VirtualMachines:VirtualMachineStats
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
saved path of a logbundle file for ESXi Returned: on success Sample: |