/usr/include/cimc/cimc.h is in libcimcclient0-dev 2.2.6-0ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 | /*
* $Id: cimc.h,v 1.4 2007/12/21 15:10:43 sschuetz Exp $
*
* © Copyright IBM Corp. 2007
*
* THIS FILE IS PROVIDED UNDER THE TERMS OF THE ECLIPSE PUBLIC LICENSE
* ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS FILE
* CONSTITUTES RECIPIENTS ACCEPTANCE OF THE AGREEMENT.
*
* You can obtain a current copy of the Eclipse Public License from
* http://www.opensource.org/licenses/eclipse-1.0.php
*
* Authors: Adrian Schuur <schuur@de.ibm.com>
* Viktor Mihajlovski <mihajlov@de.ibm.com>
*
* Description:
*
* CIM C API Functions for Environment and Client Operations
*
*/
#ifndef _CIMC_H_
#define _CIMC_H_
#include "cimcdt.h"
#include "cimcft.h"
#ifdef __cplusplus
extern "C" {
#endif
/* NewCIMCEnv options */
#define CIMC_NO_CURL_INIT 1 /* don't call curl_global_init() or _cleanup() */
/*
* _CIMCClientFt Function Table
*/
struct _CIMCClient;
typedef struct _CIMCClient CIMCClient;
typedef struct _CIMCClientFT {
/** Function table version
*/
int ftVersion;
/** The Client object will not be used any further and may be freed by
cimc run time system.
@param cl Client this pointer.
@return Service return status.
*/
CIMCStatus (*release)
(CIMCClient* cl);
/** The clone operation is not supported.
Inserted here to conform with other cimc function table layouts.
@param cl Client this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return Always NULL.
*/
CIMCClient *(*clone) ( CIMCClient * cl, CIMCStatus * st );
/** Get Class using <op> as reference. Class structure can be
controled using the flags parameter.
@param cl Client this pointer.
@param op ObjectPath containing nameSpace and classname components.
@param flags Any combination of the following flags are supported:
CIMC_FLAG_LocalOnly, CIMC_FLAG_IncludeQualifiers and CIMC_FLAG_IncludeClassOrigin.
@param properties If not NULL, the members of the array define one or more Property
names. Each returned Object MUST NOT include elements for any Properties
missing from this list
@param rc Output: Service return status (suppressed when NULL).
@return The Class.
*/
CIMCClass* (*getClass)
(CIMCClient* cl,
CIMCObjectPath* op, CIMCFlags flags, char** properties, CIMCStatus* rc);
/** Enumerate Class Names (and subclass names) in the nameSpace defined by <op>. Inheritance scope can be controled using the
flags parameter.
@param cl Client this pointer.
@param op ObjectPath containing nameSpace component.
@param flags The following flag is supported: CIMC_FLAG_DeepInheritance.
@param rc Output: Service return status (suppressed when NULL).
@return Enumeration of ObjectPathes.
*/
CIMCEnumeration* (*enumClassNames)
(CIMCClient* cl,
CIMCObjectPath* op, CIMCFlags flags, CIMCStatus* rc);
/** Enumerate Classes (and subclasses) in the nameSpace defined by <op>.
Class structure and inheritance scope can be controled using the <flags> parameter.
@param cl Client this pointer.
@param op ObjectPath containing nameSpace and classname components.
@param flags Any combination of the following flags are supported: CIMC_FLAG_LocalOnly,
CIMC_FLAG_DeepInheritance, CIMC_FLAG_IncludeQualifiers and CIMC_FLAG_IncludeClassOrigin.
@param rc Output: Service return status (suppressed when NULL).
@return Enumeration of Instances.
*/
CIMCEnumeration* (*enumClasses)
(CIMCClient* cl,
CIMCObjectPath* op, CIMCFlags flags, CIMCStatus* rc);
/** Get Instance using <op> as reference. Instance structure can be
controled using the <flags> parameter.
@param cl Client this pointer.
@param op ObjectPath containing nameSpace, classname and key components.
@param flags Any combination of the following flags are supported:
CIMC_FLAG_LocalOnly, CIMC_FLAG_IncludeQualifiers and CIMC_FLAG_IncludeClassOrigin.
@param properties If not NULL, the members of the array define one or more Property
names. Each returned Object MUST NOT include elements for any Properties
missing from this list
@param rc Output: Service return status (suppressed when NULL).
@return The Instance.
*/
CIMCInstance* (*getInstance)
(CIMCClient* cl,
CIMCObjectPath* op, CIMCFlags flags, char** properties, CIMCStatus* rc);
/** Create Instance from <inst> using <op> as reference.
@param cl Client this pointer.
@param op ObjectPath containing nameSpace, classname and key components.
@param inst Complete instance.
@param rc Output: Service return status (suppressed when NULL).
@return The assigned instance reference.
*/
CIMCObjectPath* (*createInstance)
(CIMCClient* cl,
CIMCObjectPath* op, CIMCInstance* inst, CIMCStatus* rc);
/** Replace an existing Instance from <inst> using <op> as reference.
@param cl Client this pointer.
@param op ObjectPath containing nameSpace, classname and key components.
@param inst Complete instance.
@param flags The following flag is supported: CIMC_FLAG_IncludeQualifiers.
@param properties If not NULL, the members of the array define one or more Property
names, only those properties will be updated. Else, all properties will be updated.
@return Service return status.
*/
CIMCStatus (*setInstance)
(CIMCClient* cl,
CIMCObjectPath* op, CIMCInstance* inst, CIMCFlags flags, char ** properties);
/** Delete an existing Instance using <op> as reference.
@param cl Client this pointer.
@param op ObjectPath containing nameSpace, classname and key components.
@return Service return status.
*/
CIMCStatus (*deleteInstance)
(CIMCClient* cl,
CIMCObjectPath* op);
/** Query the enumeration of instances of the class (and subclasses) defined
by <op> using <query> expression.
@param cl Client this pointer.
@param op ObjectPath containing nameSpace and classname components.
@param query Query expression
@param lang Query Language
@param rc Output: Service return status (suppressed when NULL).
@return Resulting eumeration of Instances.
*/
CIMCEnumeration* (*execQuery)
(CIMCClient* cl,
CIMCObjectPath* op, const char *query, const char *lang, CIMCStatus* rc);
/** Enumerate Instance Names of the class (and subclasses) defined by <op>.
@param cl Client this pointer.
@param op ObjectPath containing nameSpace and classname components.
@param rc Output: Service return status (suppressed when NULL).
@return Enumeration of ObjectPathes.
*/
CIMCEnumeration* (*enumInstanceNames)
(CIMCClient* cl,
CIMCObjectPath* op, CIMCStatus* rc);
/** Enumerate Instances of the class (and subclasses) defined by <op>.
Instance structure and inheritance scope can be controled using the
<flags> parameter.
@param cl Client this pointer.
@param op ObjectPath containing nameSpace and classname components.
@param flags Any combination of the following flags are supported: CIMC_FLAG_LocalOnly,
CIMC_FLAG_DeepInheritance, CIMC_FLAG_IncludeQualifiers and CIMC_FLAG_IncludeClassOrigin.
@param properties If not NULL, the members of the array define one or more Property
names. Each returned Object MUST NOT include elements for any Properties
missing from this list
@param rc Output: Service return status (suppressed when NULL).
@return Enumeration of Instances.
*/
CIMCEnumeration* (*enumInstances)
(CIMCClient* cl,
CIMCObjectPath* op, CIMCFlags flags, char** properties, CIMCStatus* rc);
/** Enumerate instances associated with the Instance defined by the <op>.
@param cl Client this pointer.
@param op Source ObjectPath containing nameSpace, classname and key components.
@param assocClass If not NULL, MUST be a valid Association Class name.
It acts as a filter on the returned set of Objects by mandating that
each returned Object MUST be associated to the source Object via an
Instance of this Class or one of its subclasses.
@param resultClass If not NULL, MUST be a valid Class name.
It acts as a filter on the returned set of Objects by mandating that
each returned Object MUST be either an Instance of this Class (or one
of its subclasses).
@param role If not NULL, MUST be a valid Property name.
It acts as a filter on the returned set of Objects by mandating
that each returned Object MUST be associated to the source Object
via an Association in which the source Object plays the specified role
(i.e. the name of the Property in the Association Class that refers
to the source Object MUST match the value of this parameter).
@param resultRole If not NULL, MUST be a valid Property name.
It acts as a filter on the returned set of Objects by mandating
that each returned Object MUST be associated to the source Object
via an Association in which the returned Object plays the specified role
(i.e. the name of the Property in the Association Class that refers to
the returned Object MUST match the value of this parameter).
@param flags Any combination of the following flags are supported:
CIMC_FLAG_IncludeQualifiers and CIMC_FLAG_IncludeClassOrigin.
@param properties If not NULL, the members of the array define one or more Property
names. Each returned Object MUST NOT include elements for any Properties
missing from this list
@param rc Output: Service return status (suppressed when NULL).
@return Enumeration of Instances.
*/
CIMCEnumeration* (*associators)
(CIMCClient* cl,
CIMCObjectPath* op, const char *assocClass, const char *resultClass,
const char *role, const char *resultRole, CIMCFlags flags,
char** properties, CIMCStatus* rc);
/** Enumerate ObjectPaths associated with the Instance defined by <op>.
@param cl Client this pointer.
@param op Source ObjectPath containing nameSpace, classname and key components.
@param assocClass If not NULL, MUST be a valid Association Class name.
It acts as a filter on the returned set of Objects by mandating that
each returned Object MUST be associated to the source Object via an
Instance of this Class or one of its subclasses.
@param resultClass If not NULL, MUST be a valid Class name.
It acts as a filter on the returned set of Objects by mandating that
each returned Object MUST be either an Instance of this Class (or one
of its subclasses).
@param role If not NULL, MUST be a valid Property name.
It acts as a filter on the returned set of Objects by mandating
that each returned Object MUST be associated to the source Object
via an Association in which the source Object plays the specified role
(i.e. the name of the Property in the Association Class that refers
to the source Object MUST match the value of this parameter).
@param resultRole If not NULL, MUST be a valid Property name.
It acts as a filter on the returned set of Objects by mandating
that each returned Object MUST be associated to the source Object
via an Association in which the returned Object plays the specified role
(i.e. the name of the Property in the Association Class that refers to
the returned Object MUST match the value of this parameter).
@param rc Output: Service return status (suppressed when NULL).
@return Enumeration of ObjectPaths.
*/
CIMCEnumeration* (*associatorNames)
(CIMCClient* cl,
CIMCObjectPath* op, const char *assocClass, const char *resultClass,
const char *role, const char *resultRole, CIMCStatus* rc);
/** Enumerates the association instances that refer to the instance defined by
<op>.
@param cl Client this pointer.
@param op Source ObjectPath containing nameSpace, classname and key components.
@param resultClass If not NULL, MUST be a valid Class name.
It acts as a filter on the returned set of Objects by mandating that
each returned Object MUST be either an Instance of this Class (or one
of its subclasses).
@param role If not NULL, MUST be a valid Property name.
It acts as a filter on the returned set of Objects by mandating
that each returned Object MUST be associated to the source Object
via an Association in which the source Object plays the specified role
(i.e. the name of the Property in the Association Class that refers
to the source Object MUST match the value of this parameter).
@param flags Any combination of the following flags are supported:
CIMC_FLAG_IncludeQualifiers and CIMC_FLAG_IncludeClassOrigin.
@param properties If not NULL, the members of the array define one or more Property
names. Each returned Object MUST NOT include elements for any Properties
missing from this list
@param rc Output: Service return status (suppressed when NULL).
@return Enumeration of ObjectPaths.
*/
CIMCEnumeration* (*references)
(CIMCClient* cl,
CIMCObjectPath* op, const char *resultClass ,const char *role ,
CIMCFlags flags, char** properties, CIMCStatus* rc);
/** Enumerates the association ObjectPaths that refer to the instance defined by
<op>.
@param cl Client this pointer.
@param op Source ObjectPath containing nameSpace, classname and key components.
@param resultClass If not NULL, MUST be a valid Class name.
It acts as a filter on the returned set of Objects by mandating that
each returned Object MUST be either an Instance of this Class (or one
of its subclasses).
@param role If not NULL, MUST be a valid Property name.
It acts as a filter on the returned set of Objects by mandating
that each returned Object MUST be associated to the source Object
via an Association in which the source Object plays the specified role
(i.e. the name of the Property in the Association Class that refers
to the source Object MUST match the value of this parameter).
@param rc Output: Service return status (suppressed when NULL).
@return Enumeration of ObjectPaths.
*/
CIMCEnumeration* (*referenceNames)
(CIMCClient* cl,
CIMCObjectPath* op, const char *resultClass ,const char *role,
CIMCStatus* rc);
/** Invoke a named, extrinsic method of an Instance
defined by the <op> parameter.
@param cl Client this pointer.
@param op ObjectPath containing nameSpace, classname and key components.
@param method Method name
@param in Input parameters.
@param out Output parameters.
@param rc Output: Service return status (suppressed when NULL).
@return Method return value.
*/
CIMCData (*invokeMethod)
(CIMCClient* cl,
CIMCObjectPath* op,const char *method,
CIMCArgs* in, CIMCArgs* out, CIMCStatus* rc);
/** Set the named property value of an Instance defined by the <op> parameter.
@param cl Client this pointer.
@param op ObjectPath containing nameSpace, classname and key components.
@param name Property name
@param value Value.
@param type Value type.
@return Service return status.
*/
CIMCStatus (*setProperty)
(CIMCClient* cl,
CIMCObjectPath* op, const char *name , CIMCValue* value,
CIMCType type);
/** Get the named property value of an Instance defined by the <op> parameter.
@param cl Client this pointer.
@param op ObjectPath containing nameSpace, classname and key components.
@param name Property name
@param rc Output: Service return status (suppressed when NULL).
@return Property value.
*/
CIMCData (*getProperty)
(CIMCClient *cl,
CIMCObjectPath *op, const char *name, CIMCStatus *rc);
} CIMCClientFT;
struct _CIMCClient {
void *hdl;
CIMCClientFT *ft;
};
/*
* CIMCEnv function table definition
*/
struct _CIMCEnv;
typedef struct _CIMCEnv CIMCEnv;
typedef struct _CIMCEnvFT {
char *env;
void* (*release)(CIMCEnv *ce);
CIMCClient* (*connect)
(CIMCEnv *ce, const char *hn, const char *scheme, const char *port,
const char *user, const char *pwd,CIMCStatus *rc);
CIMCClient* (*connect2)
(CIMCEnv *ce, const char *hn, const char *scheme, const char *port,
const char *user, const char *pwd,
int verifyMode, const char * trustStore,
const char * certFile, const char * keyFile,
CIMCStatus *rc);
CIMCInstance* (*newInstance)
(CIMCEnv *ce, const CIMCObjectPath* op, CIMCStatus* rc);
CIMCObjectPath* (*newObjectPath)
(CIMCEnv *ce, const char *ns, const char *cn, CIMCStatus* rc);
CIMCArgs* (*newArgs)
(CIMCEnv *ce, CIMCStatus* rc);
CIMCString* (*newString)
(CIMCEnv *ce, const char *data, CIMCStatus* rc);
CIMCArray* (*newArray)
(CIMCEnv *ce, CIMCCount max, CIMCType type, CIMCStatus* rc);
CIMCDateTime* (*newDateTime)
(CIMCEnv *ce, CIMCStatus* rc);
CIMCDateTime* (*newDateTimeFromBinary)
(CIMCEnv *ce, CIMCUint64 binTime, CIMCBoolean interval, CIMCStatus* rc);
CIMCDateTime* (*newDateTimeFromChars)
(CIMCEnv *ce, const char *utcTime, CIMCStatus* rc);
CIMCIndicationListener* (*newIndicationListener)
(CIMCEnv *ce, int sslMode, int *portNumber, char **socketName,
void (*fp) (CIMCInstance *indInstance), CIMCStatus* rc);
} CIMCEnvFT;
struct _CIMCEnv {
void *hdl;
CIMCEnvFT *ft;
unsigned int options;
};
CIMCEnv* NewCIMCEnv(const char *id, unsigned int options, int *rc, char **msg);
void ReleaseCIMCEnv(CIMCEnv* env);
/*
* Prototype for CIMC Implementation Factory Function
*/
typedef CIMCEnv *(*InitCimcEnv) (const char *id, unsigned int options, int *rc, char **msg);
#ifdef __cplusplus
};
#endif
#endif // _cimcC_H_
|