constants.h

Pegasus is an open-source implementationof the DMTF CIM and WBEM standards. It is designed to be por

#ifndef PEGASUS_DISABLE_PERFINST
PEGASUS_COMMON_LINKAGE
    extern const CIMNamespaceName PEGASUS_NAMESPACENAME_CIMOMSTATDATA;
#endif

#ifndef PEGASUS_DISABLE_CQL
PEGASUS_COMMON_LINKAGE
    extern const CIMNamespaceName PEGASUS_NAMESPACENAME_CIMQUERYCAPABILITIES;
#endif

//
// HTTP Header Tags, Status Codes, and Reason Phrases
//

#define PEGASUS_HTTPHEADERTAG_ERRORDETAIL "PGErrorDetail"

#define HTTP_STATUSCODE_OK 200
#define HTTP_REASONPHRASE_OK "OK"
#define HTTP_STATUS_OK "200 OK"

#define HTTP_STATUSCODE_BADREQUEST 400
#define HTTP_REASONPHRASE_BADREQUEST "Bad Request"
#define HTTP_STATUS_BADREQUEST "400 Bad Request"

#define HTTP_STATUSCODE_UNAUTHORIZED 401
#define HTTP_REASONPHRASE_UNAUTHORIZED "Unauthorized"
#define HTTP_STATUS_UNAUTHORIZED "401 Unauthorized"

#define HTTP_STATUSCODE_FORBIDDEN    403
#define HTTP_REASONPHRASE_FORBIDDEN    "Forbidden"
#define HTTP_STATUS_FORBIDDEN    "403 Forbidden"

#define HTTP_STATUSCODE_REQUEST_TOO_LARGE 413
#define HTTP_REASONPHRASE_REQUEST_TOO_LARGE "Request Entity Too Large"
#define HTTP_STATUS_REQUEST_TOO_LARGE "413 Request Entity Too Large"

#define HTTP_STATUSCODE_INTERNALSERVERERROR 500
#define HTTP_REASONPHRASE_INTERNALSERVERERROR "Internal Server Error"
#define HTTP_STATUS_INTERNALSERVERERROR "500 Internal Server Error"

#define HTTP_STATUSCODE_NOTIMPLEMENTED 501
#define HTTP_REASONPHRASE_NOTIMPLEMENTED "Not Implemented"
#define HTTP_STATUS_NOTIMPLEMENTED "501 Not Implemented"

#define HTTP_STATUSCODE_SERVICEUNAVAILABLE 503
#define HTTP_REASONPHRASE_SERVICEUNAVAILABLE "Service Unavailable"
#define HTTP_STATUS_SERVICEUNAVAILABLE "503 Service Unavailable"


//
// Default port numbers
//

#define WBEM_DEFAULT_HTTP_PORT 5988
#define WBEM_DEFAULT_HTTPS_PORT 5989

#define SNMP_TRAP_DEFAULT_PORT 162


//
// Wbem service names
//
#define WBEM_HTTP_SERVICE_NAME "wbem-http"
#define WBEM_HTTPS_SERVICE_NAME "wbem-https"



//
// File system layout
//

#ifdef PEGASUS_USE_RELEASE_DIRS
#ifdef PEGASUS_OVERRIDE_DEFAULT_RELEASE_DIRS
# include <Pegasus/Common/ProductDirectoryStructure.h>
#else
# if defined(PEGASUS_OS_HPUX)
#  undef CIMSERVER_LOCK_FILE
#  define CIMSERVER_LOCK_FILE               "/var/opt/wbem/cimserver_start.lock"
#  undef PEGASUS_REPOSITORY_DIR
#  define PEGASUS_REPOSITORY_DIR            "/var/opt/wbem/repository"
#  undef PEGASUS_CURRENT_CONFIG_FILE_PATH
#  define PEGASUS_CURRENT_CONFIG_FILE_PATH  \
    "/var/opt/wbem/cimserver_current.conf"
#  undef PEGASUS_PLANNED_CONFIG_FILE_PATH
#  define PEGASUS_PLANNED_CONFIG_FILE_PATH  \
    "/var/opt/wbem/cimserver_planned.conf"
#  undef PEGASUS_CIMSERVER_START_FILE
#  define PEGASUS_CIMSERVER_START_FILE      "/etc/opt/wbem/cimserver_start.conf"
#  undef PEGASUS_SSLCLIENT_CERTIFICATEFILE
#  define PEGASUS_SSLCLIENT_CERTIFICATEFILE "/etc/opt/hp/sslshare/client.pem"
#  undef PEGASUS_SSLCLIENT_RANDOMFILE
#  define PEGASUS_SSLCLIENT_RANDOMFILE      "/var/opt/wbem/ssl.rnd"
#  undef PEGASUS_SSLSERVER_RANDOMFILE
#  define PEGASUS_SSLSERVER_RANDOMFILE      "/var/opt/wbem/cimserver.rnd"
#  undef PEGASUS_LOCAL_AUTH_DIR
#  define PEGASUS_LOCAL_AUTH_DIR            "/var/opt/wbem/localauth"
#  undef PEGASUS_LOCAL_DOMAIN_SOCKET_PATH
#  define PEGASUS_LOCAL_DOMAIN_SOCKET_PATH  "/var/opt/wbem/socket/cimxml.socket"
#  undef PEGASUS_CORE_DIR
#  define PEGASUS_CORE_DIR                  "/var/opt/wbem"
#  undef PEGASUS_PAM_STANDALONE_PROC_NAME
#  define PEGASUS_PAM_STANDALONE_PROC_NAME  "/opt/wbem/lbin/cimservera"
#  undef PEGASUS_PROVIDER_AGENT_PROC_NAME
#  define PEGASUS_PROVIDER_AGENT_PROC_NAME  "/opt/wbem/lbin/cimprovagt"
# elif defined(PEGASUS_OS_AIX)
#  undef CIMSERVER_LOCK_FILE
#  define CIMSERVER_LOCK_FILE               \
    "/opt/freeware/cimom/pegasus/etc/cimserver_start.lock"
#  undef PEGASUS_REPOSITORY_DIR
#  define PEGASUS_REPOSITORY_DIR            \
    "/opt/freeware/cimom/pegasus/etc/repository"
#  undef PEGASUS_CURRENT_CONFIG_FILE_PATH
#  define PEGASUS_CURRENT_CONFIG_FILE_PATH  \
    "/opt/freeware/cimom/pegasus/etc/cimserver_current.conf"
#  undef PEGASUS_PLANNED_CONFIG_FILE_PATH
#  define PEGASUS_PLANNED_CONFIG_FILE_PATH  \
    "/opt/freeware/cimom/pegasus/etc/cimserver_planned.conf"
#  undef PEGASUS_CIMSERVER_START_FILE
#  define PEGASUS_CIMSERVER_START_FILE      "/tmp/cimserver_start.conf"
#  undef PEGASUS_SSLCLIENT_CERTIFICATEFILE
#  define PEGASUS_SSLCLIENT_CERTIFICATEFILE \
    "/opt/freeware/cimom/pegasus/etc/client.pem"
#  undef PEGASUS_SSLCLIENT_RANDOMFILE
#  define PEGASUS_SSLCLIENT_RANDOMFILE      \
    "/opt/freeware/cimom/pegasus/etc/ssl.rnd"
#  undef PEGASUS_SSLSERVER_RANDOMFILE
#  define PEGASUS_SSLSERVER_RANDOMFILE      \
    "/opt/freeware/cimom/pegasus/etc/cimserver.rnd"
#  undef PEGASUS_LOCAL_DOMAIN_SOCKET_PATH
#  define PEGASUS_LOCAL_DOMAIN_SOCKET_PATH  \
    "/opt/freeware/cimom/pegasus/etc/cimxml.socket"
#  undef PEGASUS_PAM_STANDALONE_PROC_NAME
#  define PEGASUS_PAM_STANDALONE_PROC_NAME  \
    "/opt/freeware/cimom/pegasus/bin/cimservera"
# elif defined(PEGASUS_OS_LINUX) && !defined(PEGASUS_OS_LSB)
#  undef CIMSERVER_LOCK_FILE
#  define CIMSERVER_LOCK_FILE               \
    "/var/opt/tog-pegasus/cimserver_start.lock"
#  undef PEGASUS_REPOSITORY_DIR
#  define PEGASUS_REPOSITORY_DIR            "/var/opt/tog-pegasus/repository"
#  undef PEGASUS_CURRENT_CONFIG_FILE_PATH
#  define PEGASUS_CURRENT_CONFIG_FILE_PATH  \
    "/var/opt/tog-pegasus/cimserver_current.conf"
#  undef PEGASUS_PLANNED_CONFIG_FILE_PATH
#  define PEGASUS_PLANNED_CONFIG_FILE_PATH  \
    "/var/opt/tog-pegasus/cimserver_planned.conf"
#  undef PEGASUS_CIMSERVER_START_FILE
#  define PEGASUS_CIMSERVER_START_FILE      "/var/run/tog-pegasus/cimserver.pid"
#  undef PEGASUS_SSLCLIENT_CERTIFICATEFILE
#  define PEGASUS_SSLCLIENT_CERTIFICATEFILE "/etc/opt/tog-pegasus/client.pem"
#  undef PEGASUS_SSLCLIENT_RANDOMFILE
#  define PEGASUS_SSLCLIENT_RANDOMFILE      "/var/opt/tog-pegasus/ssl.rnd"
#  undef PEGASUS_SSLSERVER_RANDOMFILE
#  define PEGASUS_SSLSERVER_RANDOMFILE      "/var/opt/tog-pegasus/cimserver.rnd"
#  undef PEGASUS_LOCAL_AUTH_DIR
#  define PEGASUS_LOCAL_AUTH_DIR            \
    "/var/opt/tog-pegasus/cache/localauth"
#  undef PEGASUS_LOCAL_DOMAIN_SOCKET_PATH
#  define PEGASUS_LOCAL_DOMAIN_SOCKET_PATH  \
    "/var/run/tog-pegasus/socket/cimxml.socket"
#  undef PEGASUS_CORE_DIR
#  define PEGASUS_CORE_DIR                  "/var/opt/tog-pegasus/cache"
#  undef PEGASUS_PAM_STANDALONE_PROC_NAME
#  define PEGASUS_PAM_STANDALONE_PROC_NAME  "/opt/tog-pegasus/sbin/cimservera"
#  undef PEGASUS_PROVIDER_AGENT_PROC_NAME
#  define PEGASUS_PROVIDER_AGENT_PROC_NAME  "/opt/tog-pegasus/sbin/cimprovagt"
# elif defined(PEGASUS_OS_LSB)
#  undef PEGASUS_REPOSITORY_DIR
#  define PEGASUS_REPOSITORY_DIR            "/var/opt/lsb-pegasus/repository"
#  undef PEGASUS_CURRENT_CONFIG_FILE_PATH
#  define PEGASUS_CURRENT_CONFIG_FILE_PATH  \
    "/etc/opt/lsb-pegasus/cimserver_current.conf"
#  undef PEGASUS_PLANNED_CONFIG_FILE_PATH
#  define PEGASUS_PLANNED_CONFIG_FILE_PATH  \
    "/etc/opt/lsb-pegasus/cimserver_planned.conf"
#  undef PEGASUS_CIMSERVER_START_FILE
#  define PEGASUS_CIMSERVER_START_FILE      "/var/run/cimserver.pid"
#  undef PEGASUS_SSLCLIENT_CERTIFICATEFILE
#  define PEGASUS_SSLCLIENT_CERTIFICATEFILE "/etc/opt/lsb-pegasus/client.pem"
#  undef PEGASUS_SSLCLIENT_RANDOMFILE
#  define PEGASUS_SSLCLIENT_RANDOMFILE      "/var/opt/lsb-pegasus/ssl.rnd"
#  undef PEGASUS_SSLSERVER_RANDOMFILE
#  define PEGASUS_SSLSERVER_RANDOMFILE      "/var/opt/lsb-pegasus/cimserver.rnd"
#  undef PEGASUS_LOCAL_AUTH_DIR
#  define PEGASUS_LOCAL_AUTH_DIR            "/var/opt/lsb-pegasus/localauth"
#  undef PEGASUS_LOCAL_DOMAIN_SOCKET_PATH
#  define PEGASUS_LOCAL_DOMAIN_SOCKET_PATH  \
    "/var/opt/lsb-pegasus/socket/cimxml.socket"
#  undef PEGASUS_CORE_DIR
#  define PEGASUS_CORE_DIR                  "/var/opt/lsb-pegasus"
#  undef PEGASUS_PAM_STANDALONE_PROC_NAME
#  define PEGASUS_PAM_STANDALONE_PROC_NAME  "/opt/lsb-pegasus/sbin/cimservera"
#  undef PEGASUS_PROVIDER_AGENT_PROC_NAME
#  define PEGASUS_PROVIDER_AGENT_PROC_NAME  "/opt/lsb-pegasus/sbin/cimprovagt"
# elif defined(PEGASUS_OS_VMS)
#  undef CIMSERVER_LOCK_FILE
#  define CIMSERVER_LOCK_FILE               \
    "/wbem_var/opt/wbem/cimserver_start.lock"
#  undef PEGASUS_REPOSITORY_DIR
#  define PEGASUS_REPOSITORY_DIR            "/wbem_var/opt/wbem/repository"
#  undef PEGASUS_CURRENT_CONFIG_FILE_PATH
#  define PEGASUS_CURRENT_CONFIG_FILE_PATH  \
    "/wbem_var/opt/wbem/cimserver_current.conf"
#  undef PEGASUS_PLANNED_CONFIG_FILE_PATH
#  define PEGASUS_PLANNED_CONFIG_FILE_PATH  \
    "/wbem_var/opt/wbem/cimserver_planned.conf"
#  undef PEGASUS_CIMSERVER_START_FILE
#  define PEGASUS_CIMSERVER_START_FILE      \
    "/wbem_var/opt/wbem/cimserver_start.conf"
#  undef PEGASUS_SSLCLIENT_CERTIFICATEFILE
#  define PEGASUS_SSLCLIENT_CERTIFICATEFILE \
    "/wbem_etc/opt/hp/sslshare/client.pem"
#  undef PEGASUS_SSLCLIENT_RANDOMFILE
#  define PEGASUS_SSLCLIENT_RANDOMFILE      "/wbem_var/opt/wbem/ssl.rnd"
#  undef PEGASUS_SSLSERVER_RANDOMFILE
#  define PEGASUS_SSLSERVER_RANDOMFILE      "/wbem_var/opt/wbem/cimserver.rnd"
#  undef PEGASUS_LOCAL_AUTH_DIR
#  define PEGASUS_LOCAL_AUTH_DIR            "/wbem_var/opt/wbem/localauth"
#  undef PEGASUS_PAM_STANDALONE_PROC_NAME
#  undef PEGASUS_PROVIDER_AGENT_PROC_NAME
#  define PEGASUS_PROVIDER_AGENT_PROC_NAME  "/wbem_var/opt/wbem/bin/cimprovagt"
# elif defined(PEGASUS_PLATFORM_ZOS_ZSERIES_IBM)
#  undef PEGASUS_REPOSITORY_DIR
#  define PEGASUS_REPOSITORY_DIR            "/var/wbem/repository"
#  undef PEGASUS_CURRENT_CONFIG_FILE_PATH
#  define PEGASUS_CURRENT_CONFIG_FILE_PATH  "/etc/wbem/cimserver_current.conf"
#  undef PEGASUS_PLANNED_CONFIG_FILE_PATH
#  define PEGASUS_PLANNED_CONFIG_FILE_PATH  "/etc/wbem/cimserver_planned.conf"
#  undef PEGASUS_CIMSERVER_START_FILE
#  define PEGASUS_CIMSERVER_START_FILE      "/var/wbem/cimserver.pid"
#  undef PEGASUS_LOCAL_DOMAIN_SOCKET_PATH
#  define PEGASUS_LOCAL_DOMAIN_SOCKET_PATH  "/var/wbem/cimxml.socket"
# elif defined(PEGASUS_OS_DARWIN)
#  undef PEGASUS_CURRENT_CONFIG_FILE_PATH
#  define PEGASUS_CURRENT_CONFIG_FILE_PATH  \
    "/etc/pegasus/cimserver_current.conf"
#  undef PEGASUS_PLANNED_CONFIG_FILE_PATH
#  define PEGASUS_PLANNED_CONFIG_FILE_PATH  \
    "/etc/pegasus/cimserver_planned.conf"
#  undef PEGASUS_CIMSERVER_START_FILE
#  define PEGASUS_CIMSERVER_START_FILE      \
    "/var/cache/pegasus/cimserver_start.conf"
# endif
#endif
#endif

#ifndef CIMSERVER_LOCK_FILE
#define CIMSERVER_LOCK_FILE               "cimserver_start.lock"
#endif
#ifndef PEGASUS_REPOSITORY_DIR
#define PEGASUS_REPOSITORY_DIR            "repository"
#endif
#ifndef PEGASUS_CURRENT_CONFIG_FILE_PATH 
#define PEGASUS_CURRENT_CONFIG_FILE_PATH  "cimserver_current.conf"
#endif
#ifndef PEGASUS_PLANNED_CONFIG_FILE_PATH
#define PEGASUS_PLANNED_CONFIG_FILE_PATH  "cimserver_planned.conf"
#endif
#ifndef PEGASUS_CIMSERVER_START_FILE
#define PEGASUS_CIMSERVER_START_FILE      "/tmp/cimserver_start.conf"
#endif
#ifndef PEGASUS_SSLCLIENT_CERTIFICATEFILE
#define PEGASUS_SSLCLIENT_CERTIFICATEFILE "client.pem"
#endif
#ifndef PEGASUS_SSLCLIENT_RANDOMFILE
#define PEGASUS_SSLCLIENT_RANDOMFILE      "ssl.rnd"
#endif
#ifndef PEGASUS_SSLSERVER_RANDOMFILE
#define PEGASUS_SSLSERVER_RANDOMFILE      "cimserver.rnd"
#endif
#ifndef PEGASUS_LOCAL_AUTH_DIR
#define PEGASUS_LOCAL_AUTH_DIR            "/tmp"
#endif
#ifndef PEGASUS_LOCAL_DOMAIN_SOCKET_PATH
#define PEGASUS_LOCAL_DOMAIN_SOCKET_PATH  "/tmp/cimxml.socket"
#endif
#ifndef PEGASUS_PAM_STANDALONE_PROC_NAME
#define PEGASUS_PAM_STANDALONE_PROC_NAME  "bin/cimservera"
#endif
#ifndef PEGASUS_PROVIDER_AGENT_PROC_NAME
#define PEGASUS_PROVIDER_AGENT_PROC_NAME  "bin/cimprovagt"
#endif

// Use the configuration file as a semaphore for repository access
#define PEGASUS_REPOSITORY_LOCK_FILE PEGASUS_CURRENT_CONFIG_FILE_PATH

// Constant defines for path to icu resource bundles
#if defined(PEGASUS_PLATFORM_OS400_ISERIES_IBM)
# define PEGASUS_DEFAULT_MESSAGE_SOURCE  "/QIBM/ProdData/OS400/CIM/msg"
#elif defined(PEGASUS_PLATFORM_ZOS_ZSERIES_IBM)
# define PEGASUS_DEFAULT_MESSAGE_SOURCE  "/usr/lpp/wbem/msg"
#elif defined(PEGASUS_PLATFORM_AIX_RS_IBMCXX) && \
      !defined(PEGASUS_DEFAULT_MESSAGE_SOURCE)
# define PEGASUS_DEFAULT_MESSAGE_SOURCE  "/opt/freeware/cimom/pegasus/msg"
#else
# undef PEGASUS_DEFAULT_MESSAGE_SOURCE
#endif

//
// Miscellaneous Constants
//

// Constant defines the maximum number of providers that will be addressed in
// a single enumerate instance request.  This is strictly a performance
// requirement for different systems.  To disable the whole test, simply set
// this variable to 0
#define MAX_ENUMERATE_BREADTH 30

// Constant defines the maximum timeout to disable a provider
#define PROVIDER_DISABLE_TIMEOUT 15

// Constants defining the operational status of a CIM_ManagedSystemElement
#define CIM_MSE_OPSTATUS_VALUE_OK 2
#define CIM_MSE_OPSTATUS_VALUE_DEGRADED 3
#define CIM_MSE_OPSTATUS_VALUE_STOPPING 9
#define CIM_MSE_OPSTATUS_VALUE_STOPPED 10

// Constants defining UserContext values in a PG_ProviderModule
#define PG_PROVMODULE_USERCTXT_REQUESTOR 2
#define PG_PROVMODULE_USERCTXT_DESIGNATED 3
#define PG_PROVMODULE_USERCTXT_PRIVILEGED 4
#define PG_PROVMODULE_USERCTXT_CIMSERVER 5

// Constant defining Server truststore type value in a PG_SSLCertificate
#define PG_SSLCERTIFICATE_TSTYPE_VALUE_SERVER Uint16(2)

#ifdef PEGASUS_DEFAULT_USERCTXT_REQUESTOR
#define PEGASUS_DEFAULT_PROV_USERCTXT PG_PROVMODULE_USERCTXT_REQUESTOR
#else
#define PEGASUS_DEFAULT_PROV_USERCTXT PG_PROVMODULE_USERCTXT_PRIVILEGED
#endif

// Standard Pegasus Global Prefix.
// This prefix is used as the basis for pegasus defined classes
// and in identity creation that would require a standard
// Pegasus prefix
#define PEGASUS_INSTANCEID_GLOBAL_PREFIX "PG"

/**
    Values for the Perceived Severity property of the Alert Indication
    class, as defined in the CIM Events MOF
 */
enum PerceivedSeverity {_SEVERITY_UNKNOWN = 0, _SEVERITY_OTHER = 1,
    _SEVERITY_INFORMATION = 2, _SEVERITY_WARNING = 3, _SEVERITY_MINOR = 4,
    _SEVERITY_MAJOR = 5, _SEVERITY_CRITICAL = 6, _SEVERITY_FATAL = 7};

/**
    The name of the MailTo property for Email Handler subclass
*/
PEGASUS_COMMON_LINKAGE extern const CIMName
    PEGASUS_PROPERTYNAME_LSTNRDST_MAILTO;

/**
    The name of the MailSubject property for Email Handler subclass
*/
PEGASUS_COMMON_LINKAGE extern const CIMName
    PEGASUS_PROPERTYNAME_LSTNRDST_MAILSUBJECT;

/**
    The name of the MailCc  property for Email Handler subclass
*/
PEGASUS_COMMON_LINKAGE extern const
    CIMName PEGASUS_PROPERTYNAME_LSTNRDST_MAILCC;

PEGASUS_NAMESPACE_END

#endif /* Pegasus_Constants_h */