IOvReqCheckSrv::CheckNodeOv
Check the prerequisites for the node specified with the
properties of the OV_ManagedNode WMI class.
-
- HRESULT CheckNodeOv(
- [in] BSTR Node,
[in] long SystemType,
[in] long OsType,
[in] BSTR OSVersion,
[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
-
- Node
- Primary node name or IP address.
- SystemType
- HPOM for Windows node property SystemTypeId.
- OsType
- 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.
- 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, 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.
-
- 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.
- 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 CheckNodeOv 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 SystemType, OsType, 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 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.