community.vmware.vmware_vcenter_statistics (4.2.0) — module

Install collection

Install with ansible-galaxy collection install community.vmware:==4.2.0

Add to requirements.yml

  collections:
    - name: community.vmware
      version: 4.2.0

Description

This module can be used to configure the vCenter server statistics.

The remaining settings can be configured with the module M(community.vmware.vmware_vcenter_settings).

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
port:
    default: 443
    description:
    - The port number of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_PORT)
      will be used instead.
    type: int

hostname:
    description:
    - 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 E(VMWARE_HOST)
      will be used instead.
    type: str

password:
    aliases:
    - pass
    - pwd
    description:
    - The password of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_PASSWORD)
      will be used instead.
    type: str

username:
    aliases:
    - admin
    - user
    description:
    - The username of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_USER)
      will be used instead.
    type: str

proxy_host:
    description:
    - 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 E(VMWARE_PROXY_HOST)
      will be used instead.
    required: false
    type: str

proxy_port:
    description:
    - 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 E(VMWARE_PROXY_PORT)
      will be used instead.
    required: false
    type: int

validate_certs:
    default: true
    description:
    - Allows connection when SSL certificates are not valid. Set to V(false) when certificates
      are not trusted.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_VALIDATE_CERTS)
      will be used instead.
    type: bool

interval_past_day:
    description:
    - Settings for vCenter server past day statistic collection.
    suboptions:
      enabled:
        default: true
        description: Past day statistics collection enabled.
        type: bool
      interval_minutes:
        choices:
        - 1
        - 2
        - 3
        - 4
        - 5
        default: 5
        description: Interval duration in minutes.
        type: int
      level:
        choices:
        - 1
        - 2
        - 3
        - 4
        default: 1
        description: Statistics level.
        type: int
      save_for_days:
        choices:
        - 1
        - 2
        - 3
        - 4
        - 5
        default: 1
        description: Save for value in days.
        type: int
    type: dict

interval_past_week:
    description:
    - Settings for vCenter server past week statistic collection.
    suboptions:
      enabled:
        default: true
        description: Past week statistics collection enabled.
        type: bool
      interval_minutes:
        choices:
        - 30
        default: 30
        description: Interval duration in minutes.
        type: int
      level:
        choices:
        - 1
        - 2
        - 3
        - 4
        default: 1
        description: Statistics level.
        type: int
      save_for_weeks:
        choices:
        - 1
        default: 1
        description: Save for value in weeks.
        type: int
    type: dict

interval_past_year:
    description:
    - Settings for vCenter server past month statistic collection.
    suboptions:
      enabled:
        default: true
        description: Past month statistics collection enabled.
        type: bool
      interval_days:
        choices:
        - 1
        default: 1
        description: Interval duration in days.
        type: int
      level:
        choices:
        - 1
        - 2
        - 3
        - 4
        default: 1
        description: Statistics level.
        type: int
      save_for_years:
        choices:
        - 1
        - 2
        - 3
        - 4
        - 5
        default: 1
        description: Save for value in years.
        type: int
    type: dict

interval_past_month:
    description:
    - Settings for vCenter server past month statistic collection.
    suboptions:
      enabled:
        default: true
        description: Past month statistics collection enabled.
        type: bool
      interval_hours:
        choices:
        - 2
        default: 2
        description: Interval duration in hours.
        type: int
      level:
        choices:
        - 1
        - 2
        - 3
        - 4
        default: 1
        description: Statistics level.
        type: int
      save_for_months:
        choices:
        - 1
        default: 1
        description: Save for value in months.
        type: int
    type: dict

Outputs

results:
  description: 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
  type: dict