community.vmware.vmware_resource_pool_info (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 gather information about all resource configuration information.

Usage examples

Scanned by Steampunk Spotter

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

- name: Gather resource pool info about all resource pools available
  community.vmware.vmware_resource_pool_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
  register: rp_info
  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

Outputs

resource_pool_info:
  description: metadata about resource pool configuration
  returned: on success
  sample:
  - cpu_allocation_expandable_reservation: false
    cpu_allocation_limit: 4121
    cpu_allocation_overhead_limit: null
    cpu_allocation_reservation: 4121
    cpu_allocation_shares: 9000
    cpu_allocation_shares_level: custom
    mem_allocation_expandable_reservation: false
    mem_allocation_limit: 961
    mem_allocation_overhead_limit: null
    mem_allocation_reservation: 961
    mem_allocation_shares: 9000
    mem_allocation_shares_level: custom
    name: Resources
    overall_status: green
    owner: DC0_H0
    runtime_cpu_max_usage: 4121
    runtime_cpu_overall_usage: 0
    runtime_cpu_reservation_used: 0
    runtime_cpu_reservation_used_vm: 0
    runtime_cpu_unreserved_for_pool: 4121
    runtime_cpu_unreserved_for_vm: 4121
    runtime_memory_max_usage: 1007681536
    runtime_memory_overall_usage: 0
    runtime_memory_reservation_used: 0
    runtime_memory_reservation_used_vm: 0
    runtime_memory_unreserved_for_pool: 1007681536
    runtime_memory_unreserved_for_vm: 1007681536
  type: list