/ home / community / community.vmware / 4.2.0 / module / vmware_host_service_info

community.vmware.vmware_host_service_info (4.2.0) — module

Gathers info about an ESXi host's services

Authors: Abhijeet Kasurde (@Akasurde)

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 an ESXi host's services.

Usage examples

Scanned by Steampunk Spotter

- name: Gather info about all ESXi Host in given Cluster
  community.vmware.vmware_host_service_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: cluster_name
  delegate_to: localhost
  register: cluster_host_services

Scanned by Steampunk Spotter

- name: Gather info about ESXi Host
  community.vmware.vmware_host_service_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
  delegate_to: localhost
  register: host_services

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

cluster_name:
description:
- Name of the cluster.
- Service information about each ESXi server will be returned for given cluster.
- If O(esxi_hostname) is not given, this parameter is required.
type: str

esxi_hostname:
description:
- ESXi hostname.
- Service information about this ESXi server will be returned.
- If O(cluster_name) is not given, this parameter is required.
type: str

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

host_service_info:
  description:
  - dict with hostname as key and dict with host service config information
  returned: always
  sample:
    10.76.33.226:
    - key: DCUI
      label: Direct Console UI
      policy: 'on'
      required: false
      running: true
      source_package_desc: This VIB contains all of the base functionality of vSphere
        ESXi.
      source_package_name: esx-base
      uninstallable: false
    - key: TSM
      label: ESXi Shell
      policy: 'off'
      required: false
      running: false
      source_package_desc: This VIB contains all of the base functionality of vSphere
        ESXi.
      source_package_name: esx-base
      uninstallable: false
  type: dict