community.vmware.vmware_vcenter_statistics – Configures statistics on a vCenter server
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_vcenter_statistics.
Synopsis
- This module can be used to configure the vCenter server statistics.
- The remaining settings can be configured with the module
vmware_vcenter_settings.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- PyVmomi
Parameters
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| 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.
|
||
| interval_past_day
dictionary
|
Settings for vCenter server past day statistic collection.
|
||
| enabled
boolean
|
|
Past day statistics collection enabled.
|
|
| interval_minutes
integer
|
5
|
Interval duration in minutes.
|
|
| level
integer
|
1
|
Statistics level.
|
|
| save_for_days
integer
|
1
|
Save for value in days.
|
|
| interval_past_month
dictionary
|
Settings for vCenter server past month statistic collection.
|
||
| enabled
boolean
|
|
Past month statistics collection enabled.
|
|
| interval_hours
integer
|
2
|
Interval duration in hours.
|
|
| level
integer
|
1
|
Statistics level.
|
|
| save_for_months
integer
|
1
|
Save for value in months.
|
|
| interval_past_week
dictionary
|
Settings for vCenter server past week statistic collection.
|
||
| enabled
boolean
|
|
Past week statistics collection enabled.
|
|
| interval_minutes
integer
|
30
|
Interval duration in minutes.
|
|
| level
integer
|
1
|
Statistics level.
|
|
| save_for_weeks
integer
|
1
|
Save for value in weeks.
|
|
| interval_past_year
dictionary
|
Settings for vCenter server past month statistic collection.
|
||
| enabled
boolean
|
|
Past month statistics collection enabled.
|
|
| interval_days
integer
|
1
|
Interval duration in days.
|
|
| level
integer
|
1
|
Statistics level.
|
|
| save_for_years
integer
|
1
|
Save for value in years.
|
|
| 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
- Tested with vCenter Server Appliance (vCSA) 6.5 and 6.7
- All modules requires API write access and hence is not supported on a free ESXi license.
Examples
- name: Configure vCenter statistics
community.vmware.vmware_vcenter_statistics:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
interval_past_day:
enabled: true
interval_minutes: 5
save_for_days: 1
level: 1
interval_past_week:
enabled: true
level: 1
interval_past_month:
enabled: true
level: 1
interval_past_year:
enabled: true
save_for_years: 1
level: 1
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| results
dictionary
|
always |
metadata about vCenter statistics settings
Sample:
{'changed': False, 'msg': 'vCenter statistics already configured properly', 'past_day_enabled': True, 'past_day_interval': 5, 'past_day_level': 1, 'past_day_save_for': 1, 'past_month_enabled': True, 'past_month_interval': 2, 'past_month_level': 1, 'past_month_save_for': 1, 'past_week_enabled': True, 'past_week_interval': 30, 'past_week_level': 1, 'past_week_save_for': 1, 'past_year_enabled': True, 'past_year_interval': 1, 'past_year_level': 1, 'past_year_save_for': 1}
|
Authors
- Christian Kotte (@ckotte)
© 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_vcenter_statistics_module.html