VIRT-WHO-CONFIG(5)

NAME
virt-who-config - configuration for virt-who

SYNOPISIS
/etc/virt-who.d/*

DESCRIPTION
Configuration format is ini-like, where group name (in square brackets) is arbitrary name of the configuration. Only required key is type that has to have one of the allowed virtualization backend names, see virt-who(8). Please note that special characters must not be escaped (opposed to /etc/sysconfig/virt-who). Other options that can be supplied are:

server
    Hostname, IP address or URL of the server that provides virtualization information (not applicable for vdsm mode).

username
    Username for authentication to the server (not applicable for vdsm mode).

password
    Password for authentication to the server (not applicable for vdsm mode).

encrypted_password
    Alternative to the password option, encrypted password that is generated by virt-who-password(8) utility.

owner
    Owner for use with Subscription Asset Manager, the Red Hat Customer Portal, or Satellite 6 (not applicable for Satellite 5)

env Environment for use with Subscription Asset Manager or Satellite 6 (not applicable for Satellite 5)

rhsm_username
    Optional username to use to communicate with Subscription Asset Manager or Satellite 6 instead of the registered system's identity certificate. (not applicable for Satellite 5)

rhsm_password
    Optional password to use to communicate with Subscription Asset Manager or Satellite 6 instead of the registered system's identity certificate. (not applicable for Satellite 5)

rhsm_encrypted_password
    Alternative to the rhsm_password option, encrypted password that is generated by virt-who-password(8) utility.

rhsm_hostname
    Optional hostname of the Subscription Asset Manager or Satellite 6 server to use in place of the host defined in the system's rhsm.conf.

rhsm_port
    Optional port for the Subscription Asset Manager or Satellite 6 server to use in place of the port defined in the system's rhsm.conf.

rhsm_prefix
    Optional prefix for the Subscription Asset Manager or Satellite 6 server to use in place of the prefix defined in the system's rhsm.conf.

rhsm_proxy_hostname
    Optional proxy host name for the Subscription Asset Manager or Satellite 6 server to use in place of the proxy host name defined in the system's rhsm.conf.

rhsm_proxy_port
    Optional proxy port for the Subscription Asset Manager or Satellite 6 server to use in place of the proxy port defined in the system's rhsm.conf.

rhsm_proxy_user
    Optional proxy username for the Subscription Asset Manager or Satellite 6 server to use in place of the proxy username defined in the system's rhsm.conf.

rhsm_proxy_password
    Optional proxy password for the Subscription Asset Manager or Satellite 6 server to use in place of the proxy password defined in the system's rhsm.conf.

rhsm_encrypted_proxy_password
    Alternative to the rhsm_proxy_password option; encrypted password generated by the virt-who-password(8) utility.

filter_host_uuids
    Only hosts which uuid is specified in comma-separated list in this option will be reported. Put the uuid into the double-quotes if it contains special characters (like comma).

exclude_host_uuids
    Hosts which uuid is specified in comma-separated list in this option will NOT be reported. Put the uuid into the double-quotes if it contains special characters (like comma).

hypervisor_id
    Property that should be used as identification of the hypervisor. Can be one of following: uuid, hostname, hwuuid. Note that some virtualization backends don't have all of them implemented. Default is uuid. Applicable to esx, hyperv and rhevm only. This property is meant to be set up before initial run of virt-who. Changing it later will result in duplicated entries in the subscription manager.

EXAMPLE
[test-esx]
type=esx
server=1.2.3.4
username=admin
password=password
owner=test
env=staging
rhsm_username=admin
rhsm_password=password

BACKEND SPECIFIC OPTIONS

  ESX BACKEND

filter_host_parents
    Only hosts which parent (usually ComputeResource) name is specified in comma-separated list in this option will be reported. Put the name into the double-quotes if it contains special characters (like comma).

exclude_host_parents
    Hosts which parent (usually ComputeResource) name is specified in comma-separated list in this option will NOT be reported. Put the name into the double-quotes if it contains special characters (like comma).

simplified_vim
    virt-who by default uses stripped-down version of vimService.wsdl file that contains vSphere SOAP API definition. Set this option to false to use server provided wsdl file that will be retrieved automatically.

  RHEV-M BACKEND

server
    The default port number is 8443 (that was used the default in RHEV-M <= 3.0). Newer RHEV-M installations uses port 443 by default. Use correct value for your server in format: server=<HOSTNAME_OR_IP_ADDRESS>:<PORT_NUMBER>

  FAKE BACKEND
Fake backend reads host/guests associations from the file on disk, for example: [fake-virt]
type=fake
file=/path/to/json
is_hypervisor=True

type
    Must be always fake.

is_hypervisor
    If true (default), the option determines that the fake data are fetched from multihost environment.

file
    Absolute path to the JSON file that has the same structure as file returned from virt-who --print command, for example:
    {
        "hypervisors": [
            {
                "uuid": "7e98b6ea-0af1-4afa-b846-919549bb0fe2",
                "guests": [
                    {
                        "guestId": "8ae19f08-2605-b476-d42e-4bd5a39f466c"
                    },
                    ...
                ]
            },
            ...
        ]
    }

AUTHOR
Radek Novacek <rnovacek at redhat dot com>

SEE ALSO
virt-who(8), virt-who-password(8)