IOvReqCheckSrv::CheckNode
Check the prerequisites for the node specified as the primary node name or IP address.
- HRESULT CheckNode(
- [in] BSTR Node,
[out] VARIANT* Report,
[out] VARIANT* ResultDescription,
[in] BSTR Platform,
[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.
- Report
- String containing prerequisite check report (list of requirements and recommendations with the status).
- ResultDescription
- Textual description of the retval (Result) parameter.
- Platform
- Platform of the checked node. Valid values are "UNIX" and "WINDOWS" (without quotes).
- rpFormat
- Specifies how detailed report should be. Valid values are:
- RP_REQ_REC_INF
- All prerequisites (requirements and recommendations) together with information data are returned. Each prerequisite has an associated state (PASS, FAIL, or UNCHECK). Each failed prerequisite has an additional error description.
- RP_REQ_REC
- All prerequisites (requirements and recommendations) are returned. Each prerequisite has an associated state (PASS, FAIL, or UNCHECK). Each failed prerequisite has an additional error description.
- RP_REQ_REC_FAILED
- Only prerequisites (requirements and recommendations) that have failed are returned. Each prerequisite has an associated state (FAIL or UNCHECK). Each failed prerequisite has an additional error description.
- RP_REQ
- All requirements are returned. Each requirement has an associated state (PASS, FAIL, or UNCHECK). Each failed requirement has an additional error description.
- RP_REQ_FAILED
- Only requirements that have failed are returned. Each requirement has an associated state (FAIL or UNCHECK). Each failed requirement has an additional error description.
- rpType
- Specifies format of report. Valid values are:
- RP_XML
- Report is generated in XML format (appropriate for further processing). This is not yet implemented.
- RP_TXT
- Report is generated in text format (appropriate for directly displaying to the user).
- User
- Optional user account (with domain) that has administrative
privileges on the node where prerequisites are checked. If not
specified, OvOWReqCheckSrv.exe impersonates the user account of the
calling client application.
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.- PREREQUISITES WERE CHECKED:
- ovrcResAllPrereqOK
- (0) - All checked prerequisites are OK.
- ovrcResReqOKRecFailed
- (1) - All requirements are OK. At least one recommendation has failed.
- ovrcResReqOKRecNotCheked
- (2) - All requirements are OK. At least one recommendation could not be checked.
- ovrcResReqFailed
- (3) - At least one requirement has failed.
- ovrcResNoPrerequisitesSpecified
- (55) - No prerequisites were specified for the <system>
system.
PREREQUISTES WERE NOT CHECKED:
- ovrcResNoAdminRight
- (101) - Client does not have administrative privileges on the node. Prerequisites can be checked only with administrative rights.
- ovrcResOneReqNotChecked
- (102) - At least one requirement could not be checked (it is unknown whether the requirement is OK). All other successfully checked requirements are OK.
- ovrcResNodeNotAvailable
- (103) - Checked node is not available. Either there is no network connection or the firewall ports are not opened.
- ovrcResNodeNotExists
- (104) - Node (name) cannot be resolved.
- ovrcResPlatformNotSupported
- (105) - Platform on the node is not yet supported.
- ovrcResPlatformNotDefined
- (106) - The platform properties of the node (System Type, Operating System, and Version) are not set.
- ovrcResPlatformNotDiscovered
- (107) - Cannot discover the platform on the specified node.
- ovrcResRexecUnavailable
- (108) - Rexec communication to the node cannot be established. Either there is no rexec daemon on the node, or it is monitoring a custom defined port (other than 512).
- ovrcResNoRemoteRegistry
- (109) - Remote Registry Service does not run on the node. Prerequisites can be checked only when the Remote Registry Service is running.
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.
- ovrcErrImpersonationFailed
- OvOWReqCheckSrv.exe component cannot impersonate the specified user account.
- ovrcErrConfigFileSyntax
- Syntax of the prerequisite check configuration file is not valid.
- (other FAILED)
- Another type of error occurred.
Description
The CheckNode method checks prerequisites for the node specified with the Node parameter (the primary node name or IP address). Other properties of the node are discovered, as specified in the prerequisite configuration file. A 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 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. If the User and Password are not provided, the OvOWReqCheckSrv.exe component "impersonates" the client.
NOTE (since 8.00):Variables AGENT_COMM_TYPE and AGENT_BINARY_FORMAT are defined as empty strings. If tags [AGT_BIN_FRMT] and/or [AGT_COMM_TYPE] are used in the configuration file, a platform won't be recognized.