Class AMT_SNMPEventSubscriber
Used in features: Event Manager
& User Notification
Compatible with the following Intel AMT
Releases: 3.0, 3.2, 4.0, 5.0, 5.1, 6.0, 6.1, 6.2, 7.0, 8.0, 8.1, 9.0, 9.5,
10.0, 11.0
CIM_ManagedElement
CIM_ManagedSystemElement
CIM_LogicalElement
CIM_EnabledLogicalElement
CIM_ServiceAccessPoint
CIM_RemoteServiceAccessPoint
CIM_RemotePort
AMT_EventSubscriber
AMT_SNMPEventSubscriber
class AMT_SNMPEventSubscriber
- extends AMT_EventSubscriber
General Information:
Represents a SNMP-events subscriber in the
Intel(R) AMT system.
Product Specific Usage:
Instances of that
class can be seen only by an administrator or by the Event-Manager user that has
created
them.
Qualifiers:
-------------
Version=6.0.0
Supported Fields
Summary |
uint16
|
InfoFormat An
enumerated integer that describes the format and interpretation of the
AccessInfo property. 206'Parameterized URL'- a URL containing
${parameterName} strings . . .
|
uint16
|
RequestedState
RequestedState is an integer enumeration that indicates the
last requested or desired state for the element, irrespective of the
mechanism through which it was requested . . .
|
uint16
|
EnabledState
EnabledState is an integer enumeration that indicates the
enabled and disabled states of an element . . .
|
string
|
ElementName A
user-friendly name for the object . . .
|
string
|
SystemCreationClassName The CreationClassName of the scoping
System.
|
string
|
SystemName The Name of the scoping System.
|
string
|
CreationClassName CreationClassName indicates the name
of the class or the subclass used in the creation of an instance . .
.
|
string
|
Name The Name property uniquely identifies the
ServiceAccessPoint and provides an indication of the functionality that is
managed . . .
|
string
|
AccessInfo Access
and/or addressing information for a remote connection . . .
|
uint8
|
PolicyID Associates a
Subscription to its filter.
|
string
|
CommunityString
A community string to send with the trap
operation.
|
Methods Summary |
|
Create(Instance,
ResourceCreated) Creates a new instance of this class
|
|
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
|
InfoFormat
public uint16 InfoFormat
- General Information:
An enumerated integer that describes the
format and interpretation of the AccessInfo property.
206'Parameterized
URL'- a URL containing ${parameterName} strings. Those strings are intended to
be replaced in their entirety by the value of the named parameter. The
interpretation of such parameters is not defined by this subclass.
As an
example use: If a parameter named 'CompanyURL' has a value of 'www.DMTF.org'
and the value of AccessInfo was 'http:\${CompanyURL}', then the resultant URL
is intended to be 'http:\www.dmtf.org'.
Product Specific
Usage:
Additional Notes:
1) 'InfoFormat' is only supported in Intel
AMT Release 6.0 and later releases.
2) In Intel AMT Release 6.0 and later
releases, "Host Name" (2) value is not
supported.
Qualifiers:
-------------
ValueMap={1, 2, 3, 4,
5, 6, 7, 8, 9, 10, 11, 12, 13, 100, 101, 102, 103, 104, 200, 201, 202, 203,
204, 205, 206, .., 32768..65535}
Values={Other, Host Name, IPv4 Address,
IPv6 Address, IPX Address, DECnet Address, SNA Address, Autonomous System
Number, MPLS Label, IPv4 Subnet Address, IPv6 Subnet Address, IPv4 Address
Range, IPv6 Address Range, Dial String, Ethernet Address, Token Ring Address,
ATM Address, Frame Relay Address, URL, FQDN, User FQDN, DER ASN1 DN, DER ASN1
GN, Key ID, Parameterized URL, DMTF Reserved, Vendor
Reserved}
ModelCorrespondence={CIM_RemoteServiceAccessPoint.OtherInfoFormatDescription}
RequestedState
public uint16 RequestedState
- General Information:
RequestedState is an integer enumeration
that indicates the last requested or desired state for the element,
irrespective of the mechanism through which it was requested. The actual state
of the element is represented by EnabledState. This property is provided to
compare the last requested and current enabled or disabled states. Note that
when EnabledState is set to 5 ("Not Applicable"), then this property has no
meaning. Refer to the EnabledState property description for explanations of
the values in the RequestedState enumeration.
"Unknown" (0) indicates the
last requested state for the element is unknown.
Note that the value "No
Change" (5) has been deprecated in lieu of indicating the last requested state
is "Unknown" (0). If the last requested or desired state is unknown,
RequestedState should have the value "Unknown" (0), but may have the value "No
Change" (5).Offline (6) indicates that the element has been requested to
transition to the Enabled but Offline EnabledState.
It should be noted
that there are two new values in RequestedState that build on the statuses of
EnabledState. These are "Reboot" (10) and "Reset" (11). Reboot refers to doing
a "Shut Down" and then moving to an "Enabled" state. Reset indicates that the
element is first "Disabled" and then "Enabled". The distinction between
requesting "Shut Down" and "Disabled" should also be noted. Shut Down requests
an orderly transition to the Disabled state, and might involve removing power,
to completely erase any existing state. The Disabled state requests an
immediate disabling of the element, such that it will not execute or accept
any commands or processing requests.
This property is set as the
result of a method invocation (such as Start or StopService on CIM_Service),
or can be overridden and defined as WRITEable in a subclass. The method
approach is considered superior to a WRITEable property, because it allows an
explicit invocation of the operation and the return of a result code.
If knowledge of the last RequestedState is not supported for the
EnabledLogicalElement, the property shall be NULL or have the value 12 "Not
Applicable".
Qualifiers:
-------------
ValueMap={0, 2, 3,
4, 5, 6, 7, 8, 9, 10, 11, 12, .., 32768..65535}
Values={Unknown, Enabled,
Disabled, Shut Down, No Change, Offline, Test, Deferred, Quiesce, Reboot,
Reset, Not Applicable, DMTF Reserved, Vendor
Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.EnabledState}
EnabledState
public uint16 EnabledState
- General Information:
EnabledState is an integer enumeration that
indicates the enabled and disabled states of an element. It can also indicate
the transitions between these requested states. For example, shutting down
(value=4) and starting (value=10) are transient states between enabled and
disabled. The following text briefly summarizes the various enabled and
disabled states:
Enabled (2) indicates that the element is or could be
executing commands, will process any queued commands, and queues new requests.
Disabled (3) indicates that the element will not execute commands and will
drop any new requests.
Shutting Down (4) indicates that the element is in
the process of going to a Disabled state.
Not Applicable (5) indicates the
element does not support being enabled or disabled.
Enabled but Offline
(6) indicates that the element might be completing commands, and will drop any
new requests.
Test (7) indicates that the element is in a test state.
Deferred (8) indicates that the element might be completing commands, but
will queue any new requests.
Quiesce (9) indicates that the element is
enabled but in a restricted mode.
Starting (10) indicates that the element
is in the process of going to an Enabled state. New requests are
queued.
Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4,
5, 6, 7, 8, 9, 10, 11..32767, 32768..65535}
Values={Unknown, Other,
Enabled, Disabled, Shutting Down, Not Applicable, Enabled but Offline, In
Test, Deferred, Quiesce, Starting, DMTF Reserved, Vendor
Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.OtherEnabledState}
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.
Product Specific Usage:
In Intel AMT Release
6.0 and later releases value is "Intel(r) AMT SNMP Alert
Subscriber"
Qualifiers:
-------------
MaxLen=35
SystemCreationClassName
public string SystemCreationClassName
- General Information:
The CreationClassName of the scoping
System.
Product Specific Usage:
In Intel AMT Release 6.0 and
later releases value is
"CIM_ComputerSystem"
Qualifiers:
-------------
Key
MaxLen=18
Propagated=CIM_System.CreationClassName
SystemName
public string SystemName
- General Information:
The Name of the scoping
System.
Product Specific Usage:
In Intel AMT Release 6.0 and
later releases value is "Intel(r)
AMT"
Qualifiers:
-------------
Key
MaxLen=14
Propagated=CIM_System.Name
CreationClassName
public string CreationClassName
- General Information:
CreationClassName indicates the name of the
class or the subclass used in the creation of an instance. When used with the
other key properties of this class, this property allows all instances of this
class and its subclasses to be uniquely identified.
Product Specific
Usage:
In Intel AMT Release 6.0 and later releases value is
"AMT_SNMPEventSubscriber"
Qualifiers:
-------------
Key
MaxLen=23
Name
public string Name
- General Information:
The Name property uniquely identifies the
ServiceAccessPoint and provides an indication of the functionality that is
managed. This functionality is described in more detail in the Description
property of the object.
Product Specific Usage:
In Intel AMT
Release 6.0 and later releases value is "Intel(r) AMT PET Receiver %d" where
%d is the subscription
handle
Qualifiers:
-------------
Key
Override=Name
MaxLen=40
AccessInfo
public string AccessInfo
- General Information:
Access and/or addressing information for a
remote connection. This can be a host name, network address or similar
information.
Product Specific Usage:
Additional Notes:
1)
'GetActionEac' property is available in Intel AMT Release 4.0 and later
releases.
Qualifiers:
-------------
Required
Override=AccessInfo
MaxLen=256
PolicyID
public uint8 PolicyID
- General Information:
Associates a Subscription to its
filter.
Product Specific Usage:
Additional Notes:
1)
'PolicyID' is a required property in Intel AMT Release 3.2 and earlier
releases.
Qualifiers:
-------------
Required
CommunityString
public string CommunityString
- General Information:
A community string to send with the trap
operation.
Qualifiers:
-------------
MaxLen=21
Create
public Create([IN]AMT_SNMPEventSubscriber Instance, [OUT] REF AMT_SNMPEventSubscriber ResourceCreated)
- Permission Information:
Permitted realms:
ADMIN_SECURITY_EVENT_MANAGER_REALM
General
Information:
Creates a new instance of this class
Product
Specific Usage:
The following properties must be included in any
representation of AMT_SNMPEventSubscriber:
SystemCreationClassName
SystemName
CreationClassName
Name
AccessInfo
PolicyID
Get
public Get([OUT]AMT_SNMPEventSubscriber Instance)
- Permission Information:
Permitted realms:
ADMIN_SECURITY_EVENT_MANAGER_REALM,
ADMIN_SECURITY_GENERAL_INFO_REALM
General Information:
Gets
the representation of the instance
Product Specific Usage:
A
user with ADMIN_SECURITY_EVENT_MANAGER_REALM realm can retrieve information
only about subscriptions created by same user. (A user with admin privileges
may access all alert subscriptions).
Delete
public Delete()
- Permission Information:
Permitted realms:
ADMIN_SECURITY_EVENT_MANAGER_REALM
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