//---------------------------------------------------------------------------- // // Copyright (c) Intel Corporation, 2003 - 2012 All Rights Reserved. // // File: CIM_AlertIndication.cs // // Contents: A concrete superclass for CIM Alert notifications. An AlertIndication is a specialized type of CIM_Indication that contains information about the severity, cause, recommended actions and other data of a real world event. This event and its data may or may not be modeled in the CIM class hierarchy. // This file was automatically generated from CIM_AlertIndication.mof // //---------------------------------------------------------------------------- using System; using System.Collections.Generic; using System.Collections.ObjectModel; using System.Text; using System.Globalization; using System.Xml.Serialization; using System.IO; using Intel.Manageability.WSManagement; using Intel.Manageability.Cim.Untyped; namespace Intel.Manageability.Cim.Typed { /// ///A concrete superclass for CIM Alert notifications. An AlertIndication is a specialized type of CIM_Indication that contains information about the severity, cause, recommended actions and other data of a real world event. This event and its data may or may not be modeled in the CIM class hierarchy. /// [System.SerializableAttribute()] [System.Xml.Serialization.XmlTypeAttribute(Namespace="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_AlertIndication")] [System.Xml.Serialization.XmlRootAttribute("CIM_AlertIndication", Namespace="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_AlertIndication", IsNullable=false)] public class CIM_AlertIndication : CIM_ProcessIndication { /// /// Default constructor. /// public CIM_AlertIndication() :base() { } /// /// Constructor that recieves an xml string for deserialization. /// /// xml string to deserialize public CIM_AlertIndication(string xml): base((IWSManClient)null) { this.Deserialize(xml); } /// /// Constructor which recieves a Ws-Management client object. /// /// Ws-Management client public CIM_AlertIndication(IWSManClient client): base(client) { } /// /// Required, Primary classification of the Indication. The following values are defined: /// 1 - Other. The Indication's OtherAlertType property conveys its classification. Use of "Other" in an enumeration is a standard CIM convention. It means that the current Indication does not fit into the categories described by this enumeration. /// 2 - Communications Alert. An Indication of this type is principally associated with the procedures and/or processes required to convey information from one point to another. /// 3 - Quality of Service Alert. An Indication of this type is principally associated with a degradation or errors in the performance or function of an entity. /// 4 - Processing Error. An Indication of this type is principally associated with a software or processing fault. /// 5 - Device Alert. An Indication of this type is principally associated with an equipment or hardware fault. /// 6 - Environmental Alert. An Indication of this type is principally associated with a condition relating to an enclosure in which the hardware resides, or other environmental considerations. /// 7 - Model Change. The Indication addresses changes in the Information Model. For example, it may embed a Lifecycle Indication to convey the specific model change being alerted. /// 8 - Security Alert. An Indication of this type is associated with security violations, detection of viruses, and similar issues. /// [CimField(false, true)] public virtual ushort AlertType { get { return ushort.Parse(this["AlertType"][0], CultureInfo.InvariantCulture); } set { this.SetOrAddField("AlertType",value.ToString(CultureInfo.InvariantCulture)); } } /// /// Remove AlertingElementFormat field. /// Note: This method will succeed only if this field is optional in the concrete object. /// public virtual void RemoveAlertingElementFormat() { RemoveField("AlertingElementFormat"); } /// /// Is true if the field AlertingElementFormat exists in the current object, /// otherwise is false. /// public virtual bool AlertingElementFormatExist { get { return ContainsField("AlertingElementFormat"); } } /// /// Optional, The format of the AlertingManagedElement property is interpretable based upon the value of this property. Values are defined as: /// 0 - Unknown. The format is unknown or not meaningfully interpretable by a CIM client application. /// 1 - Other. The format is defined by the value of the OtherAlertingElementFormat property. /// 2 - CIMObjectPath. The format is a CIMObjectPath, with format <NamespacePath>:<ClassName>.<Prop1>="<Value1>", <Prop2>="<Value2>", . . . specifying an instance in the CIM Schema. /// [CimField(false, false)] public virtual ushort AlertingElementFormat { get { return ushort.Parse(this["AlertingElementFormat"][0], CultureInfo.InvariantCulture); } set { this.SetOrAddField("AlertingElementFormat",value.ToString(CultureInfo.InvariantCulture)); } } /// /// Remove AlertingManagedElement field. /// Note: This method will succeed only if this field is optional in the concrete object. /// public virtual void RemoveAlertingManagedElement() { RemoveField("AlertingManagedElement"); } /// /// Is true if the field AlertingManagedElement exists in the current object, /// otherwise is false. /// public virtual bool AlertingManagedElementExist { get { return ContainsField("AlertingManagedElement"); } } /// /// Optional, The identifying information of the entity (ie, the instance) for which this Indication is generated. The property contains the path of an instance, encoded as a string parameter - if the instance is modeled in the CIM Schema. If not a CIM instance, the property contains some identifying string that names the entity for which the Alert is generated. The path or identifying string is formatted per the AlertingElementFormat property. /// [CimField(false, false)] public virtual string AlertingManagedElement { get { return this.GetField("AlertingManagedElement")[0]; } set { this.SetOrAddField("AlertingManagedElement",value); } } /// /// Remove Description field. /// Note: This method will succeed only if this field is optional in the concrete object. /// public virtual void RemoveDescription() { RemoveField("Description"); } /// /// Is true if the field Description exists in the current object, /// otherwise is false. /// public virtual bool DescriptionExist { get { return ContainsField("Description"); } } /// /// Optional, A short description of the Indication. /// [CimField(false, false)] public virtual string Description { get { return this.GetField("Description")[0]; } set { this.SetOrAddField("Description",value); } } /// /// Remove EventID field. /// Note: This method will succeed only if this field is optional in the concrete object. /// public virtual void RemoveEventID() { RemoveField("EventID"); } /// /// Is true if the field EventID exists in the current object, /// otherwise is false. /// public virtual bool EventIDExist { get { return ContainsField("EventID"); } } /// /// Optional, An instrumentation or provider specific value that describes the underlying "real-world" event represented by the Indication. Two Indications with the same, non NULL EventID value are considered, by the creating entity, to represent the same event. The comparison of two EventID values is only defined for Alert Indications with identical, non NULL values of SystemCreateClassName, SystemName and ProviderName. /// [CimField(false, false)] public virtual string EventID { get { return this.GetField("EventID")[0]; } set { this.SetOrAddField("EventID",value); } } /// /// Remove EventTime field. /// Note: This method will succeed only if this field is optional in the concrete object. /// public virtual void RemoveEventTime() { RemoveField("EventTime"); } /// /// Is true if the field EventTime exists in the current object, /// otherwise is false. /// public virtual bool EventTimeExist { get { return ContainsField("EventTime"); } } /// /// Optional, The time and date the underlying event was first detected. If specified, this property MUST be set to NULL if the creating entity is not capable of providing this information. This value is based on the notion of local date and time of the Managed System Element generating the Indication. /// [CimField(false, false)] public virtual CimDateTime EventTime { get { return CimDateTime.Parse(this["EventTime"][0]); } set { this.SetOrAddField("EventTime",value.ToString()); } } /// /// Remove Message field. /// Note: This method will succeed only if this field is optional in the concrete object. /// public virtual void RemoveMessage() { RemoveField("Message"); } /// /// Is true if the field Message exists in the current object, /// otherwise is false. /// public virtual bool MessageExist { get { return ContainsField("Message"); } } /// /// Optional, The formatted message. This message is constructed by combining some or all of the dynamic elements specified in the MessageArguments property with the static elements uniquely identified by the MessageID in a message registry or other catalog associated with the OwningEntity. /// [CimField(false, false)] public virtual string Message { get { return this.GetField("Message")[0]; } set { this.SetOrAddField("Message",value); } } /// /// Remove MessageArguments field. /// Note: This method will succeed only if this field is optional in the concrete object. /// public virtual void RemoveMessageArguments() { RemoveField("MessageArguments"); } /// /// Is true if the field MessageArguments exists in the current object, /// otherwise is false. /// public virtual bool MessageArgumentsExist { get { return ContainsField("MessageArguments"); } } /// /// Optional, An array containing the dynamic content of the message. /// [CimField(false, false)] public virtual string[] MessageArguments { get { return CimTypesUtils.StringArrayToArray(this["MessageArguments"]); } set { string[] arr = CimTypesUtils.ArrayToStringArray(value); this.SetOrAddField("MessageArguments", arr); } } /// /// Remove MessageID field. /// Note: This method will succeed only if this field is optional in the concrete object. /// public virtual void RemoveMessageID() { RemoveField("MessageID"); } /// /// Is true if the field MessageID exists in the current object, /// otherwise is false. /// public virtual bool MessageIDExist { get { return ContainsField("MessageID"); } } /// /// Optional, A string that uniquely identifies, within the scope of the OwningEntity, the format of the Message. /// [CimField(false, false)] public virtual string MessageID { get { return this.GetField("MessageID")[0]; } set { this.SetOrAddField("MessageID",value); } } /// /// Remove OtherAlertType field. /// Note: This method will succeed only if this field is optional in the concrete object. /// public virtual void RemoveOtherAlertType() { RemoveField("OtherAlertType"); } /// /// Is true if the field OtherAlertType exists in the current object, /// otherwise is false. /// public virtual bool OtherAlertTypeExist { get { return ContainsField("OtherAlertType"); } } /// /// Optional, A string describing the Alert type - used when the AlertType property is set to 1, "Other State Change". /// [CimField(false, false)] public virtual string OtherAlertType { get { return this.GetField("OtherAlertType")[0]; } set { this.SetOrAddField("OtherAlertType",value); } } /// /// Remove OtherAlertingElementFormat field. /// Note: This method will succeed only if this field is optional in the concrete object. /// public virtual void RemoveOtherAlertingElementFormat() { RemoveField("OtherAlertingElementFormat"); } /// /// Is true if the field OtherAlertingElementFormat exists in the current object, /// otherwise is false. /// public virtual bool OtherAlertingElementFormatExist { get { return ContainsField("OtherAlertingElementFormat"); } } /// /// Optional, A string defining "Other" values for AlertingElementFormat. This value MUST be set to a non NULL value when AlertingElementFormat is set to a value of 1 ("Other"). For all other values of AlertingElementFormat, the value of this string must be set to NULL. /// [CimField(false, false)] public virtual string OtherAlertingElementFormat { get { return this.GetField("OtherAlertingElementFormat")[0]; } set { this.SetOrAddField("OtherAlertingElementFormat",value); } } /// /// Remove OwningEntity field. /// Note: This method will succeed only if this field is optional in the concrete object. /// public virtual void RemoveOwningEntity() { RemoveField("OwningEntity"); } /// /// Is true if the field OwningEntity exists in the current object, /// otherwise is false. /// public virtual bool OwningEntityExist { get { return ContainsField("OwningEntity"); } } /// /// Optional, A string that uniquely identifies the entity that owns the definition of the format of the Message described in this instance. OwningEntity MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity or standards body defining the format. /// [CimField(false, false)] public virtual string OwningEntity { get { return this.GetField("OwningEntity")[0]; } set { this.SetOrAddField("OwningEntity",value); } } /// /// Required, An enumerated value that describes the severity of the Alert Indication from the notifier's point of view: /// 1 - Other, by CIM convention, is used to indicate that the Severity's value can be found in the OtherSeverity property. /// 3 - Degraded/Warning should be used when its appropriate to let the user decide if action is needed. /// 4 - Minor should be used to indicate action is needed, but the situation is not serious at this time. /// 5 - Major should be used to indicate action is needed NOW. /// 6 - Critical should be used to indicate action is needed NOW and the scope is broad (perhaps an imminent outage to a critical resource will result). /// 7 - Fatal/NonRecoverable should be used to indicate an error occurred, but it's too late to take remedial action. /// 2 and 0 - Information and Unknown (respectively) follow common usage. Literally, the AlertIndication is purely informational or its severity is simply unknown. /// [CimField(false, true)] public override ushort PerceivedSeverity { get { return ushort.Parse(this["PerceivedSeverity"][0], CultureInfo.InvariantCulture); } set { this.SetOrAddField("PerceivedSeverity",value.ToString(CultureInfo.InvariantCulture)); } } /// /// Required, An enumerated value that describes the probable cause of the situation which resulted in the AlertIndication. /// [CimField(false, true)] public virtual ushort ProbableCause { get { return ushort.Parse(this["ProbableCause"][0], CultureInfo.InvariantCulture); } set { this.SetOrAddField("ProbableCause",value.ToString(CultureInfo.InvariantCulture)); } } /// /// Remove ProbableCauseDescription field. /// Note: This method will succeed only if this field is optional in the concrete object. /// public virtual void RemoveProbableCauseDescription() { RemoveField("ProbableCauseDescription"); } /// /// Is true if the field ProbableCauseDescription exists in the current object, /// otherwise is false. /// public virtual bool ProbableCauseDescriptionExist { get { return ContainsField("ProbableCauseDescription"); } } /// /// Optional, Provides additional information related to the ProbableCause. /// [CimField(false, false)] public virtual string ProbableCauseDescription { get { return this.GetField("ProbableCauseDescription")[0]; } set { this.SetOrAddField("ProbableCauseDescription",value); } } /// /// Remove ProviderName field. /// Note: This method will succeed only if this field is optional in the concrete object. /// public virtual void RemoveProviderName() { RemoveField("ProviderName"); } /// /// Is true if the field ProviderName exists in the current object, /// otherwise is false. /// public virtual bool ProviderNameExist { get { return ContainsField("ProviderName"); } } /// /// Optional, The name of the Provider generating this Indication. /// [CimField(false, false)] public virtual string ProviderName { get { return this.GetField("ProviderName")[0]; } set { this.SetOrAddField("ProviderName",value); } } /// /// Remove RecommendedActions field. /// Note: This method will succeed only if this field is optional in the concrete object. /// public virtual void RemoveRecommendedActions() { RemoveField("RecommendedActions"); } /// /// Is true if the field RecommendedActions exists in the current object, /// otherwise is false. /// public virtual bool RecommendedActionsExist { get { return ContainsField("RecommendedActions"); } } /// /// Optional, Free form descriptions of the recommended actions to take to resolve the cause of the notification. /// [CimField(false, false)] public virtual string[] RecommendedActions { get { return CimTypesUtils.StringArrayToArray(this["RecommendedActions"]); } set { string[] arr = CimTypesUtils.ArrayToStringArray(value); this.SetOrAddField("RecommendedActions", arr); } } /// /// Remove SystemCreationClassName field. /// Note: This method will succeed only if this field is optional in the concrete object. /// public virtual void RemoveSystemCreationClassName() { RemoveField("SystemCreationClassName"); } /// /// Is true if the field SystemCreationClassName exists in the current object, /// otherwise is false. /// public virtual bool SystemCreationClassNameExist { get { return ContainsField("SystemCreationClassName"); } } /// /// Optional, The scoping System's CreationClassName for the Provider generating this Indication. /// [CimField(false, false)] public virtual string SystemCreationClassName { get { return this.GetField("SystemCreationClassName")[0]; } set { this.SetOrAddField("SystemCreationClassName",value); } } /// /// Remove SystemName field. /// Note: This method will succeed only if this field is optional in the concrete object. /// public virtual void RemoveSystemName() { RemoveField("SystemName"); } /// /// Is true if the field SystemName exists in the current object, /// otherwise is false. /// public virtual bool SystemNameExist { get { return ContainsField("SystemName"); } } /// /// Optional, The scoping System's Name for the Provider generating this Indication. /// [CimField(false, false)] public virtual string SystemName { get { return this.GetField("SystemName")[0]; } set { this.SetOrAddField("SystemName",value); } } /// /// Remove Trending field. /// Note: This method will succeed only if this field is optional in the concrete object. /// public virtual void RemoveTrending() { RemoveField("Trending"); } /// /// Is true if the field Trending exists in the current object, /// otherwise is false. /// public virtual bool TrendingExist { get { return ContainsField("Trending"); } } /// /// Optional, Provides information on trending - trending up, down or no change. /// [CimField(false, false)] public virtual ushort Trending { get { return ushort.Parse(this["Trending"][0], CultureInfo.InvariantCulture); } set { this.SetOrAddField("Trending",value.ToString(CultureInfo.InvariantCulture)); } } /// /// Enumerate instances of CIM_AlertIndication class at an endpoint. /// /// WS-Management client /// Keys for selecting the instances /// Collection of CIM_AlertIndication objects public static new Collection Enumerate(IWSManClient client, CimBase.CimKeys cimKeys) { List ret = CimBase.Enumerate(client, cimKeys); return new Collection(ret); } /// /// Enumerate instances of CIM_AlertIndication class at an endpoint. /// /// WS-Management client /// Collection of CIM_AlertIndication objects public static new Collection Enumerate(IWSManClient client) { List ret = CimBase.Enumerate(client); return new Collection(ret); } /// /// Delete the instance of CIM_AlertIndication if it is singular. /// Note: This method will succeed only if a single instance of the class exists. /// /// WS-Management client public static new void Delete(IWSManClient client) { CimBase.Delete(client); } /// /// Represents the keys of the CIM_AlertIndication class. /// public new class CimKeys : CIM_ProcessIndication.CimKeys { } } }