pegasus/src/Pegasus/Config/ConfigPropertyHelp.cpp - diff

Return to ConfigPropertyHelp.cpp CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Config

Diff for /pegasus/src/Pegasus/Config/ConfigPropertyHelp.cpp between version 1.3 and 1.4

version 1.3, 2012/11/29 09:59:23

version 1.4, 2013/04/15 13:50:43

Line 58

// characters should be used at any point the user wants to insure that

// there is a new line and spaces used for indenting. Do not put an NL at

// the end of the message.

// Rules for formatting the messages:

// 1. Formatting is done here. The help display just uses the formatting

// defined here. Thus, any indenting of Possible Values, etc. andf EOLs

// must be defined in this file. Lines should not exceed 80 characters.

// 2. This text may be translated since it goes into the message bundle.

// Put any words or phrases that are NOT to be translated into single

// quotes. This applies primarily to the possible values but should

// include words like 'true', etc. if they are to be literally used\

// on the command line or displayed and used literally.

struct configPropertyDescription configPropertyDescriptionList[] =

{

{"traceComponents",

"Defines OpenPegasus components to be traced. Multiple components\n"

"Defines OpenPegasus server components to be traced.\n"

"input as comma-separated list. 'ALL' traces all components."},

"Define multiple components as comma-separated list. 'ALL' traces\n"

"all components. Only OpenPegasus server components on this list\n"

"generate entries in the trace output."},

{"traceLevel",

"Defines Level of server tracing Enabled.\n"

"Single digit defines level of server tracing enabled.\n"

"Possible Values:\n"

" 0 Trace off (default)\n"

" 1 Severe and log messages\n"

Line 75

Line 86

" 4 High data detail\n"

" 5 High data detail + Method Enter & Exit"},

{"traceFilePath", "Specifies location and name of OpenPegasus trace file."},

{"traceFilePath",

"Specifies location and name of OpenPegasus trace file.\n"

"Ignored when 'traceFacility!=File."},

{"traceMemoryBufferKbytes",

"Defines size of buffer for in-memory tracing in kbytes.\n"

"Integer defines size of buffer for in-memory tracing.\n"

"Smallest value is 16 (10240 bytes). Ignored if traceFacility!=memory"},

"Value is in in kbytes. Minimum value is 16 kbytes. Ignored if\n"

"'traceFacility!=memory'"},

{"traceFileSizeKBytes",

"Integer defines the maximum size of the tracefile in kbytes.\n"

"The trace file will be rolled over when size exceeds the specified\n"

"size. Minimum is 10,240 kbytes. Maximum is 2,097 mbytes."

"Ignored if 'traceFacility=memory'. See also 'numberOfTraceFiles'."},

{"numberOfTraceFiles","Integer defines the maximum number of trace files\n"

"kept when trace files are rolled over upon reaching maximum size\n"

"'traceFileSizeKBytes'. Minimum is 3. Maximum is 20"},

{"traceFacility", "Keyword configures the trace destination.\n"

{"traceFacility", "Keyword selects the trace destination.\n"

"Possible Values:\n"

" 'File' - Trace output to file defined by traceFilePath\n"

" 'File' Trace output to file defined by 'traceFilePath'\n"

" 'Log' - Trace output to log file\n"

" 'Log' Trace output to log file\n"

" 'Memory' - Trace output to memory"},

" 'Memory' Trace output to memory"},

{"logDir", "Specifies name of directory to be used for OpenPegasus\n"

{"hostname", "Override local system supplied hostname CIM Server uses to\n"

"specific log files. Not supported if PEGASUS_USE_SYSLOGS\n"

"build objects for WBEM operations that return hostname (ex.\n"

"associators). Used where environment needs operations to\n"

"return operation responses with hostname other than server name\n"

"(ex. behind firewalls). When setting this option,\n"

"'fullyQualifiedHostName' should be set also."},

{"fullyQualifiedHostName", "Override local system supplied fully\n"

"qualified hostname (with domain)CIM Server uses to build objects\n"

"for WBEM Operations that return hostname (ex. associators).\n"

"Used where environment needs operations to return operation\n"

"responses with hostname other than server name (ex. behind firewalls)."

"\nWhen setting this option 'hostname' should be set also."},

{"logDir", "Specifies name of directory to be used for OpenPegasus "

"specific log files.\n"

"Not supported if PEGASUS_USE_SYSLOGS "

"defined"},

{"maxLogFileSizeKBytes",

"Maximum size of the logfile in kbytes. If logfile size exceeds\n"

"Integer defines maximum size of the logfile in kbytes.\n"

"maxLogFileSizeKBytes logfile will be pruned. Minimum value is\n"

"If logfile size exceeds maxLogFileSizeKBytes logfile will be pruned.\n"

"32 KB. Not supported if PEGASUS_USE_SYSLOGS defined."},

"Minimum value is 32 KB. Not supported if PEGASUS_USE_SYSLOGS\n"

"defined."},

{"logLevel","Keyword defines the desired level of logging.\n"

{"logLevel",

"Keyword defines the desired level of logging.\n"

"Log levels are accumulative(i.e. 'warning' logs 'warning', 'severe',\n"

"and 'fatal'.\n"

"Possible Values:\n"

" TRACE, INFORMATION, WARNING, SEVERE, FATAL"},

" 'trace' Most Detailed. Output all log events\n"

" 'information' Log information level. Default \n"

" 'warning' Log warnings and more severe events \n"

" 'severe' Log fatal and severe events \n"

" 'fatal' Log only events that are fatal to server"},

{"enableHttpConnection",

"If 'true', allows connection to CIM Server using HTTP protocol"},

Line 107

Line 154

"If 'true', allows connection to the CIM Server using HTTPS protocol\n"

"(HTTP using Secure Socket Layer encryption)"},

{"httpPort",

{"httpPort", "Integer defines HTTP port number.\n"

"OpenPegasus first attempts to look up port number for HTTP\n"

"using getservbyname for the 'wbem-http' service. httpPort.\n"

"configuration setting used only when getservbyname lookup fails.\n"

"Use of port 5988 recommended by DMTF"},

{"httpsPort","OpenPegasus first attempts to look up port number for\n"

{"httpsPort", "Integer that defines HTTPS port number.\n"

"HTTP using getservbyname for the 'wbem-https' service. httpPorts\n"

"OpenPegasus first attempts to look up port number for\n"

"HTTPS using getservbyname for the 'wbem-https' service. httpPorts\n"

"configuration setting used only when the getservbyname lookup fails.\n"

"Use of port 5989 recommended by DMTF"},

{"daemon",

"If 'true' enables forking of the CIM Server to create a background\n"

"daemon process."},

/// needs more info

{"slp",

"If 'true', OpenPegasus activates an SLP SA and issues DMTF\n"

"If 'true', OpenPegasus activates an SLP SA and issues DMTF defined\n"

"defined SLP advertisements to this SA on startup."},

"SLP advertisements to this SA on startup."},

{"enableAssociationTraversal",

"If 'true', CIM Server supports the association traversal\n"

"If 'true', CIM Server supports the association traversal operators:\n"

"operators: Associators, AssociatorNames,References, and\n"

" Associators, AssociatorNames,References, and ReferenceNames."},

"ReferenceNames."},

{"enableIndicationService",

"If 'true', the CIM Server will support CIM Indications."},

Line 140

Line 187

{"enableNamespaceAuthorization",

"If 'true', CIM Server restricts access to namespaces based on\n"

"configured user authorizations [user authorizations may be\n"

"configured using the cimauth command]"},

"configured using the 'cimauth' command]"},

{"httpAuthType", "Type of HTTP authentication. Currently = 'basic'\n"

"indicating basic authentication"},

Line 150

Line 197

{"sslCertificateFilePath",

"File containing the CIM Server SSL Certificate."},

//// TBD Clarify if just file name or path also. Both above and following

{"sslKeyFilePath",

"File Containing private key for CIM Server SSL Certificate."},

{"sslTrustStore",

"Specifies location of OpenSSL truststore. Truststore can be either\n"

"Specifies location of OpenSSL truststore.\n"

"file or directory. If the truststore is a directory, all\n"

"Truststore can be either file or directory. If the truststore is a\n"

"certificates in the directory are trusted."},

"directory, all certificates in the directory are trusted."},

{"crlStore", "Specifies location of OpenSSL certificate revocation list.\n"

"if enabled."},

{"sslClientVerificationMode",

"Level of support for certificate-based authentication.\n"

"Valid only if enableHttpsConnection=true\n"

"Valid only if 'enableHttpsConnection=true'\n"

"Options are:\n"

"Possible Values:\n"

"'required': client MUST present a trusted certificate to access\n"

"'required': HTTPS client MUST present a trusted certificate to"

" access\n"

" CIM Server. If client fails to send a certificate or sends an\n"

" untrusted certificate, the connection will be rejected.\n"

" untrusted certificate, the connection is rejected.\n"

"'optional': server supports, but does not require, certificate-based\n"

"'optional': HTTPS client may, but is not required to, present a\n"

" client authentication. Server requests and validates client \n"

" trusted certificate to access the server. Server requests and\n"

" certificate, but the connection will be accepted if no\n"

" validates client certificate, but the connection is accepted if"

" no\n"

" certificate or an untrusted certificate issent. Server will\n"

" then seek to authenticate client via authentication header.\n"

"'disabled': Server does not support certificate-based client\n"

"'disabled': CIM Server will not allow HTTPS clients to authenticate\n"

" authentication."},

" using a certificate. Basic authentication will be used to\n"

" authenticate HTTPS clients"},

{"sslTrustStoreUserName",

"System user name to be associated with all certificate-based\n"

"System user name to be associated with all certificate-based "

"authenticated requests. No default; for security reasons, system\n"

"authenticated\nrequests.\n"

"administrator must explicitly specify this value. Allows a single\n"

"No default; for security reasons, system administrator must\n"

"user name to be specified. This user will be associated with all\n"

"explicitly specify this value. Allows a single user name to be\n"

"certificates in the truststore"},

"specified. This user will be associated with all certificates in\n"

"the truststore"},

{"kerberosServiceName", "TBD"},

{"enableCFZAPPLID", "TBD"},

//// Definition Format needs clarification. i.e. multiple ciphers

{"sslCipherSuite",

"String containing OpenSSL cipher specifications to configure\n"

"cipher suite the client is permitted to negotiate with the server\n"

"during SSL handshake phase. Enclose values in single quotes to"

"during SSL handshake phase. Enclose values in single quotes to\n"

"avoid issues with special characters"},

"avoid issues with special characters. Default if this parameter is\n"

"is the list of ciphers in OpenSSL."},

{"repositoryIsDefaultInstanceProvider",

"If 'true', Repository functions as Provider (for instance and\n"

Line 200

Line 252

"registered Provider."},

{"enableBinaryRepository",

"Setting this to 'true' will activate the binary repository support\n"

"If 'true' activates the binary repository support on the next\n"

"on the next restart of cimserver. OpenPegasus supports repositories\n"

"restart of cimserver. OpenPegasus supports repositories with a\n"

"with a mixture of binary and XML objects."},

"mixture of binary and XML objects."},

{"shutdownTimeout",

"When 'cimserver -s' shutdown command is issued, specifies maximum\n"

Line 220

Line 272

"non-applicable files."},

{"providerDir",

"Names of directories that contains Provider executables. If\n"

"Names of directories that contains provider executables.\n"

"multiple directories they should be comma-separated."},

"If multiple directories they should be comma-separated."},

{"enableRemotePrivilegedUserAccess",

"If 'true', the CIM Server allows access by a privileged user from a\n"

Line 233

Line 285

"If 'true', operations on indication filter, listener destination,\n"

"and subscription instances may be performed by non-privileged\n"

"users.Otherwise, these operations limited to privileged users."},

//// This whole description is backwards. It really defines what

//// server will accept, not what client may issue

{"authorizedUserGroups",

"If set, the value is list of comma-separated user\n"

"groups whose members may issue CIM requests. A user not a member of\n"

Line 242

Line 295

"CIM requests."},

{"messageDir",

"Name of the directory to be used for the OpenPegasus translated\n"

"Name of the directory used for the OpenPegasus translated\n"

"message bundles."},

{"enableNormalization",

"If 'true', objects returned from instance providers are validated\n"

"and normalized. Errors encountered during normalization cause\n"

"and normalized.\n"

"Errors encountered during normalization cause\n"

"CIMException with the status code set to CIM_ERR_FAILED. Provider\n"

"modules in excludeMOdulesFromNormalizationList excluded from\n"

"normalization."},

Line 256

Line 310

"If not Null, the value is interpreted as comma-separated list of\n"

"Provider Module names to exclude from validation and normalization."},

//// What is relation with the provider groups?

{"forceProviderProcesses",

"If 'true', CIM Server runs Providers in separate processes rather\n"

"than loading and calling Provider libraries directly within\n"

Line 266

Line 321

"that may run concurrently. Value '0' indicates that the number of\n"

" Provider Agent processes unlimited"},

{"enableAuditLog", "If 'true', audit logging at run time enabled."},

{"enableAuditLog", "If 'true', audit audit log entries for certain types\n"

"of CIM Server activities (i.e. activities that modify server state)\n"

"will be written to the system log. Aaudit log entries describe the\n"

"who, what, and when of audited activity."},

{"socketWriteTimeout",

"If CIM Server receives EWOULDBLOCK/EAGAIN error on a non-blocking\n"

"Integer defines the number of seconds the CIM Server will wait for a\n"

"write, socketWriteTimeout defines the number of seconds the CIM\n"

"client connection to be ready to receive data. If the CIM Server is\n"

"Server will wait for the socket to get ready and resume writing\n"

"unable to write to a connection in this time, the connection is\n"

"data."},

"closed."},

{"idleConnectionTimeout",

"If set to a positive integer, value specifies a minimum timeout\n"

Line 290

Line 348

"If set to a positive integer, value defines the number of times\n"

"indication service will try to deliver an indication to a\n"

"particular listener destination. This does not effect the original\n"

"delivery attempt, thus if set to 0, cimserver will only try to\n"

"delivery attempt. If set to 0, cimserver will only try to\n"

"deliver the indication once."},

{"minIndicationDeliveryRetryInterval",

Line 302

Line 360

{"slpProviderStartupTimeout",

"Timeout value in milli seconds used to specify how long the\n"

"registration with an SLP SA may take. Registration will be retried\n"

"three times. This value only needs to be increased in case that\n"

"three times. This value only needs to be increased in case\n"

"the loading of a set of providers who reporting their implementation\n"

"the loading of a set of providers whose implementation\n"

"of a registered profile takes very long."}

"of a registered profile takes very long."},

{"listenAddress",

"Network interface where the cimserver listens for connections."

" Default\n"

"value 'All' forces listening at all interfaces. A comma seperated\n"

"list(without spaces) forces listening at specific interfaces. For\n"

"example: 'listenAddress=All' or 'listenAddress=121.12.33.112', or\n"

"'listenAddress=121.33.21.26,127.0.0.1, fe80::fe62:9346%eth0'"}

};

Uint32 configPropertyDescriptionListSize =

Legend:

Removed from v.1.3
changed lines
	Added in v.1.4

No CVS admin address has been configured