Class AMT_FilterEntryBase
CIM_ManagedElement
CIM_ManagedSystemElement
CIM_LogicalElement
AMT_FilterEntryBase
- Known Subclasses:
- AMT_NetworkFilter AMT_ComplexFilterEntryBase AMT_IPHeadersFilter AMT_Hdr8021Filter
Abstract class AMT_FilterEntryBase
- extends CIM_LogicalElement
General Information:
Class AMT_FilterEntryBase is an abstract
class, representing any type of
filter
Qualifiers:
-------------
Abstract
Version=3.0.0
Supported Fields
Summary |
string
|
ElementName A
user-friendly name for the object . . .
|
string
|
Description The
Description property provides a textual description of the object.
|
string
|
Caption The Caption
property is a short textual description (one- line string) of the
object.
|
datetime
|
InstallDate A
datetime value that indicates when the object was installed . . .
|
string
|
Name The Name property
defines the label by which the object is known . . .
|
uint16[]
|
OperationalStatus
Indicates the current statuses of the element . . .
|
string[]
|
StatusDescriptions
Strings describing the various OperationalStatus array values .
. .
|
string
|
Status A string
indicating the current status of the object . . .
|
uint16
|
HealthState
Indicates the current health of the element . . .
|
boolean
|
IsNegated Boolean
indicating that the match condition described in the properties of the
FilterEntryBase subclass should be negated . .
.
|
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)
|
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
Description
public string Description
- General Information:
The Description property provides a textual
description of the
object.
Qualifiers:
-------------
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
InstallDate
public datetime InstallDate
- General Information:
A datetime value that indicates when the
object was installed. Lack of a value does not indicate that the object is not
installed.
Qualifiers:
-------------
MappingStrings={MIF.DMTF|ComponentID|001.5}
Name
public string Name
- General Information:
The Name property defines the label by
which the object is known. When subclassed, the Name property can be
overridden to be a Key
property.
Qualifiers:
-------------
MaxLen=1024
OperationalStatus
public uint16[] OperationalStatus
- General Information:
Indicates the current statuses of the
element. Various operational statuses are defined. Many of the enumeration's
values are self-explanatory. However, a few are not and are described here in
more detail.
"Stressed" indicates that the element is functioning, but
needs attention. Examples of "Stressed" states are overload, overheated, and
so on.
"Predictive Failure" indicates that an element is functioning
nominally but predicting a failure in the near future.
"In Service"
describes an element being configured, maintained, cleaned, or otherwise
administered.
"No Contact" indicates that the monitoring system has
knowledge of this element, but has never been able to establish communications
with it.
"Lost Communication" indicates that the ManagedSystem Element is
known to exist and has been contacted successfully in the past, but is
currently unreachable.
"Stopped" and "Aborted" are similar, although the
former implies a clean and orderly stop, while the latter implies an abrupt
stop where the state and configuration of the element might need to be
updated.
"Dormant" indicates that the element is inactive or quiesced.
"Supporting Entity in Error" indicates that this element might be "OK" but
that another element, on which it is dependent, is in error. An example is a
network service or endpoint that cannot function due to lower-layer networking
problems.
"Completed" indicates that the element has completed its
operation. This value should be combined with either OK, Error, or Degraded so
that a client can tell if the complete operation Completed with OK (passed),
Completed with Error (failed), or Completed with Degraded (the operation
finished, but it did not complete OK or did not report an error).
"Power
Mode" indicates that the element has additional power model information
contained in the Associated PowerManagementService association.
"Relocating" indicates the element is being
relocated.
OperationalStatus replaces the Status property on
ManagedSystemElement to provide a consistent approach to enumerations, to
address implementation needs for an array property, and to provide a migration
path from today's environment to the future. This change was not made earlier
because it required the deprecated qualifier. Due to the widespread use of the
existing Status property in management applications, it is strongly
recommended that providers or instrumentation provide both the Status and
OperationalStatus properties. Further, the first value of OperationalStatus
should contain the primary status for the element. When instrumented, Status
(because it is single-valued) should also provide the primary status of the
element.
Qualifiers:
-------------
ValueMap={0, 1, 2, 3,
4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, ..,
0x8000..}
Values={Unknown, Other, OK, Degraded, Stressed, Predictive
Failure, Error, Non-Recoverable Error, Starting, Stopping, Stopped, In
Service, No Contact, Lost Communication, Aborted, Dormant, Supporting Entity
in Error, Completed, Power Mode, Relocating, DMTF Reserved, Vendor
Reserved}
ArrayType=Indexed
ModelCorrespondence={CIM_ManagedSystemElement.StatusDescriptions}
StatusDescriptions
public string[] StatusDescriptions
- General Information:
Strings describing the various
OperationalStatus array values. For example, if "Stopping" is the value
assigned to OperationalStatus, then this property may contain an explanation
as to why an object is being stopped. Note that entries in this array are
correlated with those at the same array index in
OperationalStatus.
Qualifiers:
-------------
ArrayType=Indexed
ModelCorrespondence={CIM_ManagedSystemElement.OperationalStatus}
MaxLen=256
Status
public string Status
- General Information:
A string indicating the current status of
the object. Various operational and non-operational statuses are defined. This
property is deprecated in lieu of OperationalStatus, which includes the same
semantics in its enumeration. This change is made for 3 reasons:
1) Status
is more correctly defined as an array. This definition overcomes the
limitation of describing status using a single value, when it is really a
multi-valued property (for example, an element might be OK AND Stopped.
2)
A MaxLen of 10 is too restrictive and leads to unclear enumerated values.
3) The change to a uint16 data type was discussed when CIM V2.0 was
defined. However, existing V1.0 implementations used the string property and
did not want to modify their code. Therefore, Status was grandfathered into
the Schema. Use of the deprecated qualifier allows the maintenance of the
existing property, but also permits an improved definition using
OperationalStatus.
Qualifiers:
-------------
Deprecated={CIM_ManagedSystemElement.OperationalStatus}
ValueMap={OK,
Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed,
NonRecover, No Contact, Lost Comm, Stopped}
MaxLen=10
HealthState
public uint16 HealthState
- General Information:
Indicates the current health of the
element. This attribute expresses the health of this element but not
necessarily that of its subcomponents. The possible values are 0 to 30, where
5 means the element is entirely healthy and 30 means the element is completely
non-functional. The following continuum is defined:
"Non-recoverable
Error" (30) - The element has completely failed, and recovery is not possible.
All functionality provided by this element has been lost.
"Critical
Failure" (25) - The element is non-functional and recovery might not be
possible.
"Major Failure" (20) - The element is failing. It is possible
that some or all of the functionality of this component is degraded or not
working.
"Minor Failure" (15) - All functionality is available but some
might be degraded.
"Degraded/Warning" (10) - The element is in working
order and all functionality is provided. However, the element is not working
to the best of its abilities. For example, the element might not be operating
at optimal performance or it might be reporting recoverable errors.
"OK"
(5) - The element is fully functional and is operating within normal
operational parameters and without error.
"Unknown" (0) - The
implementation cannot report on HealthState at this time.
DMTF has
reserved the unused portion of the continuum for additional HealthStates in
the future.
Qualifiers:
-------------
ValueMap={0, 5, 10,
15, 20, 25, 30, .., 32768..65535}
Values={Unknown, OK, Degraded/Warning,
Minor failure, Major failure, Critical failure, Non-recoverable error, DMTF
Reserved, Vendor Specific}
IsNegated
public boolean IsNegated
- General Information:
Boolean indicating that the match condition
described in the properties of the FilterEntryBase subclass should be negated.
This property is defined for ease of use when filtering on simple negations -
for example, to select all source ports except 162. It is not recommended that
this Boolean be set to True when filtering on multiple criteria, such as
defining an IPHeadersFilter based on source/destination addresses, ports, and
DiffServ Code Points.
Create
public Create([IN]AMT_FilterEntryBase Instance, [OUT] REF AMT_FilterEntryBase 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 AMT_FilterEntryBase:
Put
public Put([IN]AMT_FilterEntryBase 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 AMT_FilterEntryBase:
Get
public Get([OUT]AMT_FilterEntryBase 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)