Class CIM_LogEntry
CIM_ManagedElement
CIM_RecordForLog
CIM_LogEntry
- Known Subclasses:
- AMT_EventLogEntry IPS_ProvisioningAuditRecord IPS_AdminProvisioningRecord IPS_ManualProvisioningRecord IPS_DALProvisioningRecord IPS_TLSProvisioningRecord IPS_ClientProvisioningRecord
class CIM_LogEntry
- extends CIM_RecordForLog
General Information:
The LogEntry object can describe the
definitional format for entries in a Log, or can be used to instantiate the
actual entries in the
Log.
Qualifiers:
-------------
Version=2.27.0
UMLPackagePath=CIM::System::Logs
Supported Fields
Summary |
string
|
Locale A locale
indicates a particular geographical, political, or cultural region . .
.
|
string
|
RecordData A string
containing LogRecord data . . .
|
string
|
RecordFormat A
string describing the data structure of the information in the property,
RecordData . . .
|
string
|
Caption The Caption
property is a short textual description (one- line string) of the
object.
|
string
|
Description The
Description property provides a textual description of the object.
|
string
|
ElementName A
user-friendly name for the object . . .
|
string
|
InstanceID Within the scope of the instantiating Namespace,
InstanceID opaquely and uniquely identifies an instance of this class . .
.
|
string
|
LogInstanceID The
containing Log's InstanceID.
|
string
|
LogName The containing
Log's Name . . .
|
string
|
RecordID RecordID may
be used to provide a representation of log entry ordering or
pointers/handles for log entries.
|
datetime
|
CreationTimeStamp
A LogEntry may include a timestamp for the
entry.
|
Methods Summary |
|
Create(Instance,
ResourceCreated) Creates a new instance of this class
|
|
Put(Instance) Changes
properties of the selected instance
|
|
Get(Instance) Gets the
representation of the instance
|
|
Delete() Deletes an
instance
|
|
Pull(EnumerationContext,
MaxElements) Pulls instances of this class, following an
Enumerate operation
|
|
Enumerate()
Enumerates the instances of this class
|
|
Release(EnumerationContext)
Releases an enumeration context
|
|
Subscribe()
Subscribes to this resource (WS-Eventing)
|
|
Unsubscribe()
Remove subscription to this resource
(WS-Eventing)
|
Locale
public string Locale
- General Information:
A locale indicates a particular
geographical, political, or cultural region. The Locale specifies the language
used in creating the RecordForLog data. If the Locale property is empty, it is
assumed that the default locale is en_US (English).
The locale string
consists of three sub-strings, separated by underscores:
- The first
sub-string is the language code, as specified in ISO639.
- The second
sub-string is the country code, as specified in ISO3166.
- The third
sub-string is a variant, which is vendor specific.
For example, US English
appears as: "en_US_WIN", where the "WIN" variant would specify a Windows
browser-specific collation (if one exists). Since the variant is not
standardized, it is not commonly used and generally is limited to easily
recognizable values ("WIN", "UNIX", "EURO", etc.) used in standard
environments. The language and country codes are required; the variant may be
empty.
Qualifiers:
-------------
MaxLen=256
RecordData
public string RecordData
- General Information:
A string containing LogRecord data.
If
the corresponding RecordFormat property is <empty>, or cannot be parsed
according to the recommended format, RecordData should be interpreted as a
free-form string. If the RecordFormat property contains parseable format
information (as recommended in the RecordFormat Description qualifier), the
RecordData string SHOULD be parsed in accordance with this format. In this
case, RecordData SHOULD begin with the delimiter character and this character
SHOULD be used to separate substrings in the manner described. The RecordData
string can then be parsed by the data consumer and appropriately
typed.
Qualifiers:
-------------
ModelCorrespondence={CIM_RecordForLog.RecordFormat}
MaxLen=256
RecordFormat
public string RecordFormat
- General Information:
A string describing the data structure of
the information in the property, RecordData. If the RecordFormat string is
<empty>, RecordData should be interpreted as a free-form string.
To describe the data structure of RecordData, the RecordFormat string
should be constructed as follows:
- The first character is a delimiter
character and is used to parse the remainder of the string into sub-strings.
- Each sub-string is separated by the delimiter character and should be in
the form of a CIM property declaration (i.e., datatype and property name).
This set of declarations may be used to interpret the similarly delimited
RecordData property.
For example, using a '*' delimiter, RecordFormat =
"*string ThisDay*uint32 ThisYear*datetime SomeTime"
may be used to
interpret: RecordData = "*This is
Friday*2002*20020807141000.000000-300".
Qualifiers:
-------------
ModelCorrespondence={CIM_RecordForLog.RecordData}
MaxLen=256
Caption
public string Caption
- General Information:
The Caption property is a short textual
description (one- line string) of the
object.
Qualifiers:
-------------
MaxLen=64
Description
public string Description
- General Information:
The Description property provides a textual
description of the
object.
Qualifiers:
-------------
MaxLen=256
ElementName
public string ElementName
- General Information:
A user-friendly name for the object. This
property allows each instance to define a user-friendly name in addition to
its key properties, identity data, and description information.
Note that
the Name property of ManagedSystemElement is also defined as a user-friendly
name. But, it is often subclassed to be a Key. It is not reasonable that the
same property can convey both identity and a user-friendly name, without
inconsistencies. Where Name exists and is not a Key (such as for instances of
LogicalDevice), the same information can be present in both the Name and
ElementName properties. Note that if there is an associated instance of
CIM_EnabledLogicalElementCapabilities, restrictions on this properties may
exist as defined in ElementNameMask and MaxElementNameLen properties defined
in that
class.
Qualifiers:
-------------
MaxLen=256
InstanceID
public string InstanceID
- General Information:
Within the scope of the instantiating
Namespace, InstanceID opaquely and uniquely identifies an instance of this
class. In order to ensure uniqueness within the NameSpace, the value of
InstanceID SHOULD be constructed using the following 'preferred' algorithm:
<OrgID>:<LocalID>
Where <OrgID> and <LocalID>
are separated by a colon ':', and where <OrgID> MUST include a
copyrighted, trademarked or otherwise unique name that is owned by the
business entity creating/defining the InstanceID, or is a registered ID that
is assigned to the business entity by a recognized global authority (This is
similar to the <Schema Name>_<Class Name> structure of Schema
class names.) In addition, to ensure uniqueness <OrgID> MUST NOT contain
a colon (':'). When using this algorithm, the first colon to appear in
InstanceID MUST appear between <OrgID> and <LocalID>.
<LocalID> is chosen by the business entity and SHOULD not be re-used
to identify different underlying (real-world) elements. If the above
'preferred' algorithm is not used, the defining entity MUST assure that the
resultant InstanceID is not re-used across any InstanceIDs produced by this or
other providers for this instance's NameSpace.
For DMTF defined instances,
the 'preferred' algorithm MUST be used with the <OrgID> set to
'CIM'.
Qualifiers:
-------------
Key
Override=InstanceID
MaxLen=256
LogInstanceID
public string LogInstanceID
- General Information:
The containing Log's
InstanceID.
Qualifiers:
-------------
MaxLen=256
LogName
public string LogName
- General Information:
The containing Log's Name. This property is
available for backwards continuity with
CIM_LogRecord.
Qualifiers:
-------------
MaxLen=256
RecordID
public string RecordID
- General Information:
RecordID may be used to provide a
representation of log entry ordering or pointers/handles for log
entries.
Qualifiers:
-------------
MaxLen=256
CreationTimeStamp
public datetime CreationTimeStamp
- General Information:
A LogEntry may include a timestamp for the
entry.
Create
public Create([IN]CIM_LogEntry Instance, [OUT] REF CIM_LogEntry ResourceCreated)
- Permission Information:
No permissions defined
General
Information:
Creates a new instance of this class
Product
Specific Usage:
The following properties must be included in any
representation of CIM_LogEntry:
InstanceID
Put
public Put([IN]CIM_LogEntry Instance)
- Permission Information:
No permissions defined
General
Information:
Changes properties of the selected
instance
Product Specific Usage:
The following properties
must be included in any representation of CIM_LogEntry:
InstanceID
Get
public Get([OUT]CIM_LogEntry Instance)
- Permission Information:
No permissions defined
General
Information:
Gets the representation of the instance
Delete
public Delete()
- Permission Information:
No permissions defined
General
Information:
Deletes an instance
Pull
public Pull([IN]String EnumerationContext, [IN]String MaxElements)
- Permission Information:
All users permitted to use method, only
instances to whom the user has permissions will be returned
General
Information:
Pulls instances of this class, following an Enumerate
operation
Enumerate
public Enumerate()
- Permission Information:
All users permitted to use
method
General Information:
Enumerates the instances of this
class
Release
public Release([IN]String EnumerationContext)
- Permission Information:
All users permitted to use
method
General Information:
Releases an enumeration
context
Subscribe
public Subscribe()
- Permission Information:
No permissions defined
General
Information:
Subscribes to this resource (WS-Eventing)
Unsubscribe
public Unsubscribe()
- Permission Information:
No permissions defined
General
Information:
Remove subscription to this resource
(WS-Eventing)