IOvReqCheck2::CheckNodeOv3
Check the prerequisites for the node specified with the properties of the OV_ManagedNode WMI class.
- HRESULT CheckNodeOv3(
- [in] BSTR Node,
[in] long SystemTypeId,
[in] long OsTypeId,
[in] BSTR OSVersion,
[out] VARIANT* Report,
[out] VARIANT* ResultDescription,
[in, optional] VARIANT AgentCommType,
[in, optional] VARIANT AgentBinaryFormat,
[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
- Value of this parameter (VARIANT of type string) is copied to variable AGENT_COMM_TYPE. If parameter is not specified (VARIANT of type Empty), variable is defined as empty string. Possible values 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
- Value of this parameter (VARIANT of type Int16) is copied to variable AGENT_BINARY_FORMAT. If parameter is not specified (VARIANT of type Empty), variable is defined as empty string. Possible values 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:
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:
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 CheckNodeOv3 is similar as method IOvReqCheck::CheckNodeOv. You can specify the agent communication type and agent binary format.
The CheckNodeOv3 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:Variable AGENT_COMM_TYPE / AGENT_BINARY_FORMAT is defined as empty string if parameter AgentCommType / AgentBinaryFormat is not specified.