IOvReqCheck::CheckNodeOv2

Check the prerequisites for the node specified as the ID of the managed node.

HRESULT CheckNodeOv2(

[in] BSTR NodeID,
[out] VARIANT* Report,
[out] VARIANT* ResultDescription,
[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

NodeID

ID of the managed node (key property of the instance of the WMI class OV_ManagedNode).

Report

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

ResultDescription

Textual description of the retval (Result) parameter.

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:
For UNIX nodes, 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:
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 where the prerequisite check configuration should be used.

ovrcErrNodeIdNotFound

Managed node with the ID (instance of the WMI class OV_ManagedNode with the key property). The NodeID does not exist.

ovrcErrConfigFileSyntax

Syntax of the prerequisite check configuration file is not valid.

(other FAILED)

Another type of error occurred.

Description

The CheckNodeOv2 method checks the prerequisites for the node specified with the NodeId parameter (the key property of the instance of the WMI class OV_ManagedNode). The node System Type, OS Type, and OS version are read from WMI, and matched with the SYSTEM sections in the prerequisite configuration file to find the 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 the report are determined with 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.

Since 8.00:
This method will also define variables AGENT_COMM_TYPE and AGENT_BINARY_FORMAT. In variable AGENT_COMM_TYPE value of WMI property OV_AgentCommType::Caption is copied. Instance of WMI class OV_AgentCommType is specified with property AgentCommTypeId of WMI instance OV_ManagedNode identified with parameter NodeID. In variable AGENT_BINARY_FORMAT value of WMI property OV_AgentBinaryFormat::Id is copied. Instance of WMI class OV_AgentBinaryFormat is specified with property AgentBinaryFormatId of WMI instance OV_ManagedNode identified with parameter NodeID.