HP Integrity Virtual Machines Installation, Configuration, and Administration Version A.03.50

hpvmpubapi(3)
NAME
hpvmpubapi -- Integrity VM public application interface descriptions.
SYNOPSIS
#include <hpvm_api_public.h>
HPVM_boolean hpvm_api_server_check()
HPVM_boolean hpvm_api_virtmach_check()
HPVM_boolean hpvm_api_version_get(HPVM_str version)
HPVM_boolean hpvm_api_my_uuid_get(HPVM_str uuid)
HPVM_boolean hpvm_api_server_uuid_get(HPVM_str uuid)
HPVM_boolean hpvm_api_server_hostname_get(HPVM_str hostname)
DESCRIPTION
hpvmpubapi contains the following public APIs:
• hpvm_api_server_check — returns the HPVM_boolean type. If this API is run on an
operational Integrity VM server, it returns HPVM_TRUE; otherwise, it returns HPVM_FALSE
as defined in hpvm_api_public.h.
• hpvm_api_virtmach — returns the HPVM_boolean type. If this API is run on a virtual
machine that has the appropriate guest kit installed, it returns HPVM_TRUE; otherwise, it
returns HPVM_FALSE as defined in hpvm_api_public.h.
• hpvm_api_version_get — returns the HPVM_int type as an error code and, if successful,
the Integrity VM version string. This API copies the Integrity VM version string into the
buffer referenced by the version parameter. The version pointer must be a preallocated buffer
that is at least HPVMAPIDEFMEMSIZ bytes long. If an error occurs, a nonzero error code
is returned.
• hpvm_api_my_uuid_get — returns the HPVM_int type as an error code and, if successful,
the Integrity VM version string. This API copies the uuid string into the buffer referenced
by the uuid parameter. The uuid pointer must be a preallocated buffer that is at least
HPVMAPIDEFMEMSIZ bytes long. If an error code occurs, a nonzero error code is returned.
• hpvm_api_server_uuid_get — returns the HPVM_int type as an error code and if
successful, the Integrity VM version string. This API copies the uuid string of the Integrity
VM server into the buffer referenced by the uuid parameter. The uuid pointer must be a
preallocated buffer that is at least HPVMAPIDEFMEMSIZ bytes long. If an error occurs, a
nonzero error code is returned. This routine returns an error if run on an Integrity VM server.
• hpvm_api_server_hostname_get — returns the HPVM_int type as an error code and,
if successful, the Integrity VM version string. This API copies the uuid string of the HPVM
server into the buffer referenced by the hostname parameter. The hostname pointer must be
a preallocated buffer that is at least HPVMAPIDEFMEMSIZ bytes long. If an error occurs,
a nonzero error code is returned. This routine returns an error if run on an Integrity VM
server.
RETURN VALUES
The hpvm_api_server_check routine returns HPVM_TRUE if run on an operational Integrity
VM server; otherwise, it returns HPVM_FALSE.
The hpvm_api_virtmach_check routine returns HPVM_TRUE if run on an Integrity VM
virtual machine; otherwise, it returns HPVM_FALSE.
The hpvm_api_version_get, hpvm_api_my_uuid_get, hpvm_api_server_uuid_get,
and the hpvm_api_server_hostname_get routines return 0 if successful.
230