HP Operations Manager for Windows

IOvReqCheck2::CheckNodeOv4


Check the prerequisites for the node specified with the properties of the OV_ManagedNode WMI class.

HRESULT CheckNodeOv4(
[in] BSTR Node,
[in] long SystemTypeId,
[in] long OsTypeId,
[in] BSTR OSVersion,
[out] VARIANT* Report,
[out] VARIANT* ResultDescription,
[in, defaultvalue(0)] long AgentCommTypeId,
[in, defaultvalue(0)] long AgentBinaryFormatId,
[in, defaultvalue(RP_TXT)] ReportFormat rpFormat,
[in, defaultvalue(RP_REQ_FAILED)] ReportType rpType,
[in, defaultvalue("")] BSTR User,
[in, defaultvalue("")] BSTR Password,
[out, retval] long* Result
);

Parameters

Node
Primary node name or IP address.

SystemTypeId
HPOM for Windows node property SystemTypeId.

OsTypeId
HPOM for Windows node property OsTypeId.

OSVersion
Caption property of OV_OsVersion instance on which points HPOM for Windows node property OsVersionId.

Report
String containing prerequisite check report (list of requirements and recommendations with the status).

ResultDescription
Textual description of the retval (Result) parameter.
AgentCommType
HPOM for Windows node property AgentCommTypeId.
Value of this parameter identifies (property Id) instance of WMI class OV_AgentCommType, from where property Caption is copied to variable AGENT_COMM_TYPE. If parameter has value 0 (OV_AgentCommType.Caption="n/a"), variable is defined as empty string. Possible string equivalents are defined with tag [AGT_COMM_TYPE], If tag [AGT_COMM_TYPE] is used and this parameter is not specified, a platform won't be recognized.
AgentBinaryFormat
HPOM for Windows node property AgentBinaryFormatId.
Value of this parameter identifies (property Id) instance of WMI class OV_AgentBinaryFormat, from where property Caption is copied to variable AGENT_BINARY_FORMAT. If parameter has value 0 (OV_AgentBinaryFormat.Caption="n/a"), variable is defined as empty string. Possible string equivalents are defined with tag [AGT_BIN_FRMT]. If tag [AGT_BIN_FRMT] is used and this parameter is not specified, a platform won't be recognized.

rpFormat
Specifies how detailed report should be. For valid values, see CheckNode.

rpType
Specifies the format of the report. For valid values, see CheckNode.

User
Optional user account (with domain) that has administrative privileges on the node where prerequisites are checked. If not specified, OvOWReqCheckCon.exe impersonates the user account of the calling client application. Otherwise, the call is routed to the OvOWReqChecSrv component.
Note NOTE:
For UNIX nodes, you must always specify the User.
Password
Password for the User.

Returning Parameter

Result
Status of the prerequisite checking. A textual description is returned in the ResultDescription parameter.
Note NOTE:
The returned status is 2 if at least one requirement fails, and if any other requirement could not be checked.
For possible returned values, see CheckNode.

HRESULT Return Values

If not ovrcNoError, IErrorInfo is created, and a detailed error description is traced.

ovrcNoError
Method executed successfully.

ovrcErrCannotOpenFile
Prerequisite check configuration file cannot be accessed.

ovrcErrCannotReadFile
Prerequisite check configuration file cannot be read.

ovrcErrCannotCloseFile
Prerequisite check configuration file cannot be closed.

ovrcErrMgmtServerNotSet
UseManagementServer method was not called. Each client should first call the UseManagementServer method to set the management server from which the prerequisite check configuration should be used.

ovrcErrConfigFileSyntax
Syntax of the prerequisite check configuration file is not valid.

(other FAILED)
Another type of error occurred.

Description

The CheckNodeOv4 is similar as method IOvReqCheck::CheckNodeOv. You can specify the agent communication type and agent binary format. You specify the OS Version with the numeric parameter OsVersionId instead of the string parameter OSVersion. Conversion to string is performed by matching parameter OsVersionId to property Id of instance of WMI class OV_OsVersion. From matched OV_OsVersion instance then Caption property is used for OS version string.

The CheckNodeOv4 method checks the prerequisites for the node specified with the Node parameter (primary node name or IP address). The node System Type, OS Type, and OS version are specified with the parameters SystemTypeId, OsTypeId, and OSVersion, and are matched with the SYSTEM sections in the prerequisite configuration file to find the correct prerequisites for the specified OS. The prerequisite check report (list of requirements and recommendations with the status) is returned as a string in the Report parameter. The content and format of report are determined by the rpFormat and rpType parameters. If the User and Password parameters are provided, the prerequisite check is performed in the context of the provided user. The call is routed to the OvOWReqCheckSrv.exe component on the server, which actually checks requirements. If the User and Password are not provided, OvOWReqCheck.exe component "impersonates" the client, and contacts the node directly.

Note NOTE:
Variable AGENT_COMM_TYPE / AGENT_BINARY_FORMAT is defined as empty string if parameter AgentCommType / AgentBinaryFormat is not specified or 0.