community.vmware.vmware_host_logbundle_info – Gathers manifest info for logbundle
Note
This plugin is part of the community.vmware collection (version 1.15.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_info.
Synopsis
- This module can be used to gather manifest information for logbundle from ESXi.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- PyVmomi
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| esxi_hostname
string / required
|
Name of the host system to fetch the manifests for logbundle.
|
|
| hostname
string
|
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
VMWARE_HOST will be used instead.
Environment variable support added in Ansible 2.6.
|
|
| password
string
|
The password of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable
VMWARE_PASSWORD will be used instead.
Environment variable support added in Ansible 2.6.
aliases: pass, pwd |
|
| port
integer
|
Default:
443
|
The port number of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable
VMWARE_PORT will be used instead.
Environment variable support added in Ansible 2.6.
|
| proxy_host
string
|
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
VMWARE_PROXY_HOST will be used instead.
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
|
|
| proxy_port
integer
|
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 VMWARE_PROXY_PORT will be used instead.
|
|
| username
string
|
The username of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable
VMWARE_USER will be used instead.
Environment variable support added in Ansible 2.6.
aliases: admin, user |
|
| validate_certs
boolean
|
|
Allows connection when SSL certificates are not valid. Set to
false when certificates are not trusted.
If the value is not specified in the task, the value of environment variable
VMWARE_VALIDATE_CERTS will be used instead.
Environment variable support added in Ansible 2.6.
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
|
Notes
Note
- All modules requires API write access and hence is not supported on a free ESXi license.
Examples
- name: fetch the manifests for logbundle from ESXi
community.vmware.vmware_host_logbundle_info:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
esxi_hostname: "{{ esxi_hostname }}"
register: fetch_manifests_result
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| manifests
list / elements=string
|
always |
list of dictionary of manifest information for logbundle
Sample:
[{'enabled': 'true', 'group': 'System', 'id': 'System:Base', 'name': 'Base', 'vmOnly': 'false'}, {'enabled': 'false', 'group': 'System', 'id': 'System:BaseMinmal', 'name': 'BaseMinmal', 'vmOnly': 'false'}, {'enabled': 'true', 'group': 'Fcd', 'id': 'Fcd:Catalog', 'name': 'Catalog', 'vmOnly': 'false'}, {'enabled': 'false', 'group': 'VirtualMachines', 'id': 'VirtualMachines:CoreDumpHung', 'name': 'CoreDumpHung', 'vmOnly': 'true'}, {'enabled': 'true', 'group': 'System', 'id': 'System:CoreDumps', 'name': 'CoreDumps', 'vmOnly': 'false'}]
|
Authors
- sky-joker (@sky-joker)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_host_logbundle_info_module.html