community.vmware.vmware_vcenter_statistics module – Configures statistics on a vCenter server

Note

This module is part of the community.vmware collection (version 2.5.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

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.

Choices:

  • no

  • yes ← (default)

interval_minutes

integer

Interval duration in minutes.

Choices:

  • 1

  • 2

  • 3

  • 4

  • 5

Default: 5

level

integer

Statistics level.

Choices:

  • 1

  • 2

  • 3

  • 4

Default: 1

save_for_days

integer

Save for value in days.

Choices:

  • 1

  • 2

  • 3

  • 4

  • 5

Default: 1

interval_past_month

dictionary

Settings for vCenter server past month statistic collection.

enabled

boolean

Past month statistics collection enabled.

Choices:

  • no

  • yes ← (default)

interval_hours

integer

Interval duration in hours.

Choices:

  • 2

Default: 2

level

integer

Statistics level.

Choices:

  • 1

  • 2

  • 3

  • 4

Default: 1

save_for_months

integer

Save for value in months.

Choices:

  • 1

Default: 1

interval_past_week

dictionary

Settings for vCenter server past week statistic collection.

enabled

boolean

Past week statistics collection enabled.

Choices:

  • no

  • yes ← (default)

interval_minutes

integer

Interval duration in minutes.

Choices:

  • 30

Default: 30

level

integer

Statistics level.

Choices:

  • 1

  • 2

  • 3

  • 4

Default: 1

save_for_weeks

integer

Save for value in weeks.

Choices:

  • 1

Default: 1

interval_past_year

dictionary

Settings for vCenter server past month statistic collection.

enabled

boolean

Past month statistics collection enabled.

Choices:

  • no

  • yes ← (default)

interval_days

integer

Interval duration in days.

Choices:

  • 1

Default: 1

level

integer

Statistics level.

Choices:

  • 1

  • 2

  • 3

  • 4

Default: 1

save_for_years

integer

Save for value in years.

Choices:

  • 1

  • 2

  • 3

  • 4

  • 5

Default: 1

password

aliases: pass, pwd

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.

port

integer

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.

Default: 443

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

aliases: admin, user

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.

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.

Choices:

  • no

  • yes ← (default)

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

Description

results

dictionary

metadata about vCenter statistics settings

Returned: always

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)