/ home / ansible / ansible.builtin / v2.9.24 / module / vmware_about_info

ansible.builtin.vmware_about_info (v2.9.24) — module

Provides information about VMware server to which user is connecting to

| "added in version" 2.9 of ansible.builtin"

Authors: Abhijeet Kasurde (@Akasurde)

preview | supported by community

Install Ansible via `pip`

Install with pip install ansible==2.9.24

Description

This module can be used to gather information about VMware server to which user is trying to connect.

Requirements

python >= 2.6
PyVmomi

Usage examples

Scanned by Steampunk Spotter

- name: Provide information about vCenter
  vmware_about_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
  delegate_to: localhost
  register: vcenter_about_info

Scanned by Steampunk Spotter

- name: Provide information about a standalone ESXi server
  vmware_about_info:
    hostname: '{{ esxi_hostname }}'
    username: '{{ esxi_username }}'
    password: '{{ esxi_password }}'
  delegate_to: localhost
  register: esxi_about_info

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 C(VMWARE_PORT)
will be used instead.
- Environment variable support added in Ansible 2.6.
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 C(VMWARE_HOST)
will be used instead.
- Environment variable support added in Ansible 2.6.
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 C(VMWARE_PASSWORD)
will be used instead.
- Environment variable support added in Ansible 2.6.
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 C(VMWARE_USER)
will be used instead.
- Environment variable support added in Ansible 2.6.
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 C(VMWARE_PROXY_HOST)
will be used instead.
- This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
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 C(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 C(false) when certificates
are not trusted.
- If the value is not specified in the task, the value of environment variable C(VMWARE_VALIDATE_CERTS)
will be used instead.
- Environment variable support added in Ansible 2.6.
- If set to C(true), please make sure Python >= 2.7.9 is installed on the given machine.
type: bool

Outputs

about_info:
  description:
  - dict about VMware server
  returned: success
  sample:
    api_type: VirtualCenter
    api_version: '6.5'
    build: '5973321'
    instance_uuid: dbed6e0c-bd88-4ef6-b594-21283e1c677f
    license_product_name: VMware VirtualCenter Server
    license_product_version: '6.0'
    locale_build: '000'
    locale_version: INTL
    os_type: darwin-amd64
    product_full_name: VMware vCenter Server 6.5.0 build-5973321
    product_line_id: vpx
    product_name: VMware vCenter Server (govmomi simulator)
    vendor: VMware, Inc.
    version: 6.5.0
  type: str

Install Ansible via pip