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_int hpvm_api_version_get(HPVM_str version)
HPVM_int hpvm_api_my_uuid_get(HPVM_str uuid)
HPVM_int hpvm_api_server_uuid_get(HPVM_str
uuid)
HPVM_int hpvm_api_server_hostname_get(HPVM_str
hostname)
DESCRIPTION
The hpvmpubapi command 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
If run on an operational Integrity VM server,
the hpvm_api_server_check routine returns HPVM_TRUE;
otherwise returns HPVM_FALSE.
If run on an Integrity VM virtual machine, the hpvm_api_virtmach_check routine returns HPVM_TRUE; otherwise
returns HPVM_FALSE.
If successful, the hpvm_api_version_get, hpvm_api_my_uuid_get, hpvm_api_server_uuid_get, and hpvm_api_server_hostname_get routines return
0.
DIAGNOSTICS
There are no error returns for the hpvm_api_server_check and hpvm_api_virtmach_check routines. If an error
occurs on the hpvm_api_version_get, hpvm_api_my_uuid_get, hpvm_api_server_uuid_get, or hpvm_api_server_hostname_get routine, one of the following error codes defined in hpvm_api_public.h is returned:
HPVMAPINOMEMORY — Inadequate memory resources.
HPVMAPIINVALARG — Invalid argument.
HPVMAPIBADFORMAT — Retrieved uuid was formatted
badly.
HPVMNOTVM — Not being run on an HPVM virtual
machine.
HPVMAPINOTSUP — Not supported.
AUTHORS
The hpvmpubapi public APIs
were developed by HP.
SEE ALSO
On the VM Host:
hpvm(5), hpvmclone(1M), hpvmcollect(1M), hpvmconsole(1M), hpvmcreate(1M), hpvmdevmgmt(1M), hpvmdevtranslate(1M), hpvmhostrdev(1M), hpvminfo(1M), hpvmmigrate(1M), hpvmmodify(1M), hpvmpubapi(3), hpvmremove(1M), hpvmresources(5), hpvmsar(1M), hpvmstart(1M), hpvmstatus(1M), hpvmstop(1M), hpmvupgrade(1M), p2vassist(1M)
On the Integrity VM guest:
hpvmcollect(1M), hpvminfo(1M), hpvmmgmt(1M), hpvmpubapi(3)
Printable version
