Network\CIM_SecurityAssociationEndpoint.mof.mof (HTML version)

Return to index
CIM_SecurityAssociationEndpoint Superclass: CIM_ProtocolEndpoint
SecurityAssociationEndpoint (SAEndpoint) represents the endpoint of a secure connection. This is typically an IP connection, although the model allows more flexibility than just IP. The SecurityAssociationEndpoint is tied to an IPProtocolEndpoint (or possibly other endpoint) using the LogicalIdentity association. Note that an endpoint is defined at both ends of the connection.
Qualifiers:Version ( "2.8.0" )
Parameters (local in grey)
Units ( "Seconds" )
uint64 LifetimeSeconds = 0 ;
LifetimeSeconds specifies the maximum time that the SA will be considered valid after it has been created. A value of zero indicates that the default of 8 hours be used. A non-zero value indicates the seconds lifetime.
Write
boolean PacketLoggingActive ;
PacketLoggingActive causes a log to be kept of traffic processed by the SAEndpoint.
MinValue ( 0 )
Write
MaxValue ( 100 )
Units ( "Percent" )
uint8 RefreshThresholdSecondsPercentage ;
RefreshThresholdSecondsPercentage is the lifetime percentage after which a new SA should be acquired, before the existing SA expires. A random period may be added to a calculated threshold to reduce network thrashing.
Units ( "Seconds" )
uint64 IdleDurationSeconds = 0 ;
IdleDurationSeconds specifies how long the SA can be idle before it is deleted. The default value, 0, indicates that there is no idle timeout period.
Units ( "KiloBytes" )
uint64 LifetimeKilobytes = 0 ;
LifetimeKilobytes specifies the maximum number of kilobytes of data traffic to be protected by the SA. A value of zero (the default) indicates that there should be no maximum kilobyte lifetime. A non-zero value specifies the desired kilobyte lifetime. The SA is deleted when the LifetimeKilobyte value is exceeded.
MinValue ( 0 )
Write
MaxValue ( 100 )
Units ( "Percent" )
uint8 RefreshThresholdKbytesPercentage ;
RefreshThresholdKbytesPercentage is the lifetime percentage of kilobytes processed, at which a new SA should be acquired. A random value may be added to the calculated threshold to reduce network thrashing.
Override ( "InstallDate" )
datetime InstallDate ;
InstallDate records when the SA (and its endpoint) was created.
Override ( "Description" )
MappingStrings { "MIB.IETF|IF-MIB.ifDescr" }
string Description ;
MaxLen ( 64 )
ModelCorrespondence { "CIM_ProtocolEndpoint.ProtocolType" , "CIM_ProtocolEndpoint.ProtocolIFType" }
string OtherTypeDescription ;
A string describing the type of ProtocolEndpoint when the Type property of this class (or any of its subclasses) is set to 1 (i.e., 'Other'). This property should be set to NULL when the Type property is any value other than 1.
Override ( "EnabledState" )
MappingStrings { "MIB.IETF|IF-MIB.ifAdminStatus" }
uint16 EnabledState ;
Override ( "TimeOfLastStateChange" )
MappingStrings { "MIB.IETF|IF-MIB.ifLastChange" }
datetime TimeOfLastStateChange ;
Override ( "OperationalStatus" )
MappingStrings { "MIB.IETF|IF-MIB.ifOperStatus" }
uint16 OperationalStatus [ ] ;
MaxLen ( 256 )
string NameFormat ;
NameFormat contains the naming heuristic that is chosen to ensure that the value of the Name property is unique. For example, one might choose to prepend the name of the port or interface with the Type of ProtocolEndpoint that this instance is (e.g., IPv4) followed by an underscore.
MaxLen ( 256 )
Override ( "Name" )
string Name ;
A string which identifies this ProtocolEndpoint with either a port or an interface on a device. To ensure uniqueness, the Name property should be prepended or appended with information from the Type or OtherTypeDescription properties. The method chosen is described in the NameFormat property of this class.
Values { "Unknown" , "Other" , "Regular 1822" , "HDH 1822" , "DDN X.25" , "RFC877 X.25" , "Ethernet CSMA/CD" , "ISO 802.3 CSMA/CD" , "ISO 802.4 Token Bus" , "ISO 802.5 Token Ring" , "ISO 802.6 MAN" , "StarLAN" , "Proteon 10Mbit" , "Proteon 80Mbit" , "HyperChannel" , "FDDI" , "LAP-B" , "SDLC" , "DS1" , "E1" , "Basic ISDN" , "Primary ISDN" , "Proprietary Point-to-Point Serial" , "PPP" , "Software Loopback" , "EON" , "Ethernet 3Mbit" , "NSIP" , "SLIP" , "Ultra" , "DS3" , "SIP" , "Frame Relay" , "RS-232" , "Parallel" , "ARCNet" , "ARCNet Plus" , "ATM" , "MIO X.25" , "SONET" , "X.25 PLE" , "ISO 802.211c" , "LocalTalk" , "SMDS DXI" , "Frame Relay Service" , "V.35" , "HSSI" , "HIPPI" , "Modem" , "AAL5" , "SONET Path" , "SONET VT" , "SMDS ICIP" , "Proprietary Virtual/Internal" , "Proprietary Multiplexor" , "IEEE 802.12" , "Fibre Channel" , "HIPPI Interface" , "Frame Relay Interconnect" , "ATM Emulated LAN for 802.3" , "ATM Emulated LAN for 802.5" , "ATM Emulated Circuit" , "Fast Ethernet (100BaseT)" , "ISDN" , "V.11" , "V.36" , "G703 at 64K" , "G703 at 2Mb" , "QLLC" , "Fast Ethernet 100BaseFX" , "Channel" , "IEEE 802.11" , "IBM 260/370 OEMI Channel" , "ESCON" , "Data Link Switching" , "ISDN S/T Interface" , "ISDN U Interface" , "LAP-D" , "IP Switch" , "Remote Source Route Bridging" , "ATM Logical" , "DS0" , "DS0 Bundle" , "BSC" , "Async" , "Combat Net Radio" , "ISO 802.5r DTR" , "Ext Pos Loc Report System" , "AppleTalk Remote Access Protocol" , "Proprietary Connectionless" , "ITU X.29 Host PAD" , "ITU X.3 Terminal PAD" , "Frame Relay MPI" , "ITU X.213" , "ADSL" , "RADSL" , "SDSL" , "VDSL" , "ISO 802.5 CRFP" , "Myrinet" , "Voice Receive and Transmit" , "Voice Foreign Exchange Office" , "Voice Foreign Exchange Service" , "Voice Encapsulation" , "Voice over IP" , "ATM DXI" , "ATM FUNI" , "ATM IMA" , "PPP Multilink Bundle" , "IP over CDLC" , "IP over CLAW" , "Stack to Stack" , "Virtual IP Address" , "MPC" , "IP over ATM" , "ISO 802.5j Fibre Token Ring" , "TDLC" , "Gigabit Ethernet" , "HDLC" , "LAP-F" , "V.37" , "X.25 MLP" , "X.25 Hunt Group" , "Transp HDLC" , "Interleave Channel" , "FAST Channel" , "IP (for APPN HPR in IP Networks)" , "CATV MAC Layer" , "CATV Downstream" , "CATV Upstream" , "Avalon 12MPP Switch" , "Tunnel" , "Coffee" , "Circuit Emulation Service" , "ATM SubInterface" , "Layer 2 VLAN using 802.1Q" , "Layer 3 VLAN using IP" , "Layer 3 VLAN using IPX" , "Digital Power Line" , "Multimedia Mail over IP" , "DTM" , "DCN" , "IP Forwarding" , "MSDSL" , "IEEE 1394" , "IF-GSN/HIPPI-6400" , "DVB-RCC MAC Layer" , "DVB-RCC Downstream" , "DVB-RCC Upstream" , "ATM Virtual" , "MPLS Tunnel" , "SRP" , "Voice over ATM" , "Voice over Frame Relay" , "ISDL" , "Composite Link" , "SS7 Signaling Link" , "Proprietary P2P Wireless" , "Frame Forward" , "RFC1483 Multiprotocol over ATM" , "USB" , "IEEE 802.3ad Link Aggregate" , "BGP Policy Accounting" , "FRF .16 Multilink FR" , "H.323 Gatekeeper" , "H.323 Proxy" , "MPLS" , "Multi-Frequency Signaling Link" , "HDSL-2" , "S-HDSL" , "DS1 Facility Data Link" , "Packet over SONET/SDH" , "DVB-ASI Input" , "DVB-ASI Output" , "Power Line" , "Non Facility Associated Signaling" , "TR008" , "GR303 RDT" , "GR303 IDT" , "ISUP" , "Proprietary Wireless MAC Layer" , "Proprietary Wireless Downstream" , "Proprietary Wireless Upstream" , "HIPERLAN Type 2" , "Proprietary Broadband Wireless Access Point to Mulipoint" , "SONET Overhead Channel" , "Digital Wrapper Overhead Channel" , "ATM Adaptation Layer 2" , "Radio MAC" , "ATM Radio" , "Inter Machine Trunk" , "MVL DSL" , "Long Read DSL" , "Frame Relay DLCI Endpoint" , "ATM VCI Endpoint" , "Optical Channel" , "Optical Transport" , "Proprietary ATM" , "Voice over Cable" , "Infiniband" , "TE Link" , "Q.2931" , "Virtual Trunk Group" , "SIP Trunk Group" , "SIP Signaling" , "CATV Upstream Channel" , "Econet" , "FSAN 155Mb PON" , "FSAN 622Mb PON" , "Transparent Bridge" , "Line Group" , "Voice E&M Feature Group" , "Voice FGD EANA" , "Voice DID" , "MPEG Transport" , "6To4" , "GTP" , "Paradyne EtherLoop 1" , "Paradyne EtherLoop 2" , "Optical Channel Group" , "HomePNA" , "GFP" , "ciscoISLvlan" , "actelisMetaLOOP" , "Fcip" , "IANA Reserved" , "IPv4" , "IPv6" , "IPv4/v6" , "IPX" , "DECnet" , "SNA" , "CONP" , "CLNP" , "VINES" , "XNS" , "ISDN B Channel Endpoint" , "ISDN D Channel Endpoint" , "BGP" , "OSPF" , "UDP" , "TCP" , "802.11a" , "802.11b" , "802.11g" , "802.11h" , "DMTF Reserved" , "Vendor Reserved" }
ModelCorrespondence { "CIM_ProtocolEndpoint.OtherTypeDescription" }
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , "15" , "16" , "17" , "18" , "19" , "20" , "21" , "22" , "23" , "24" , "25" , "26" , "27" , "28" , "29" , "30" , "31" , "32" , "33" , "34" , "35" , "36" , "37" , "38" , "39" , "40" , "41" , "42" , "43" , "44" , "45" , "46" , "47" , "48" , "49" , "50" , "51" , "52" , "53" , "54" , "55" , "56" , "57" , "58" , "59" , "60" , "61" , "62" , "63" , "64" , "65" , "66" , "67" , "68" , "69" , "70" , "71" , "72" , "73" , "74" , "75" , "76" , "77" , "78" , "79" , "80" , "81" , "82" , "83" , "84" , "85" , "86" , "87" , "88" , "89" , "90" , "91" , "92" , "93" , "94" , "95" , "96" , "97" , "98" , "99" , "100" , "101" , "102" , "103" , "104" , "105" , "106" , "107" , "108" , "109" , "110" , "111" , "112" , "113" , "114" , "115" , "116" , "117" , "118" , "119" , "120" , "121" , "122" , "123" , "124" , "125" , "126" , "127" , "128" , "129" , "130" , "131" , "132" , "133" , "134" , "135" , "136" , "137" , "138" , "139" , "140" , "141" , "142" , "143" , "144" , "145" , "146" , "147" , "148" , "149" , "150" , "151" , "152" , "153" , "154" , "155" , "156" , "157" , "158" , "159" , "160" , "161" , "162" , "163" , "164" , "165" , "166" , "167" , "168" , "169" , "170" , "171" , "172" , "173" , "174" , "175" , "176" , "177" , "178" , "179" , "180" , "181" , "182" , "183" , "184" , "185" , "186" , "187" , "188" , "189" , "190" , "191" , "192" , "193" , "194" , "195" , "196" , "197" , "198" , "199" , "200" , "201" , "202" , "203" , "204" , "205" , "206" , "207" , "208" , "209" , "210" , "211" , "212" , "213" , "214" , "215" , "216" , "217" , "218" , "219" , "220" , "221" , "222" , "223" , "224" , "..4095" , "4096" , "4097" , "4098" , "4099" , "4100" , "4101" , "4102" , "4103" , "4104" , "4105" , "4106" , "4107" , "4108" , "4109" , "4110" , "4111" , "4112" , "4113" , "4114" , "4115" , "..32767" , "32768.." }
MappingStrings { "MIB.IETF|IF-MIB.ifType" }
uint16 ProtocolIFType ;
ProtocolIFType is an enumeration synchronized with the IANA ifType MIB, maintained at the URL, http: property is used to categorize and classify instances of the ProtocolEndpoint class. Note that if the ProtocolIFType is set to 1 ('Other'), then the type information should be provided in the OtherTypeDescription string property.
Values { "Unknown" , "Other" , "IPv4" , "IPv6" , "IPX" , "AppleTalk" , "DECnet" , "SNA" , "CONP" , "CLNP" , "VINES" , "XNS" , "ATM" , "Frame Relay" , "Ethernet" , "TokenRing" , "FDDI" , "Infiniband" , "Fibre Channel" , "ISDN BRI Endpoint" , "ISDN B Channel Endpoint" , "ISDN D Channel Endpoint" , "IPv4/v6" , "BGP" , "OSPF" , "MPLS" , "UDP" , "TCP" }
ModelCorrespondence { "CIM_ProtocolEndpoint.OtherTypeDescription" }
Deprecated { "CIM_ProtocolEndpoint.ProtocolIFType" }
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , "15" , "16" , "17" , "18" , "19" , "20" , "21" , "22" , "23" , "24" , "25" , "26" , "27" }
uint16 ProtocolType ;
ProtocolType is an enumeration providing information to categorize and classify different instances of this class. For most instances, information in this enumeration and the subclass' definition overlap. However, there are several cases where a specific subclass of ProtocolEndpoint is not required (for example, there is no Fibre Channel subclass of ProtocolEndpoint). Hence, this property is needed to define the type of Endpoint.

This property is deprecated in lieu of the ProtocolIFType enumeration. This is done to have better alignment between the IETF's IF-MIB and this CIM class.
Propagated ( "CIM_System.Name" )
MaxLen ( 256 )
Key
string SystemName ;
The Name of the scoping System.
Propagated ( "CIM_System.CreationClassName" )
MaxLen ( 256 )
Key
string SystemCreationClassName ;
The CreationClassName of the scoping System.
MaxLen ( 256 )
Key
string CreationClassName ;
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.
ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" }
string OtherEnabledState ;
A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ('Other'). This property must be set to null when EnabledState is any value other than 1.
Values { "Completed with No Error" , "Not Supported" , "Unknown or Unspecified Error" , "Cannot complete within Timeout Period" , "Failed" , "Invalid Parameter" , "In Use" , "DMTF Reserved" , "Method Parameters Checked - Job Started" , "Invalid State Transition" , "Use of Timeout Parameter Not Supported" , "Busy" , "Method Reserved" , "Vendor Specific" }
ModelCorrespondence { "CIM_EnabledLogicalElement.RequestedState" }
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "4096" , "4097" , "4098" , "4099" , "4100..32767" , "32768..65535" }
uint32RequestStateChange(
The state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 ('Completed with No Error'), 3 ('Timeout'), or 4096 (0x1000) ('Job Started'). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values.
Qualifiers:Values { "Enabled" , "Disabled" , "Shut Down" , "Offline" , "Test" , "Defer" , "Quiesce" , "Reboot" , "Reset" , "DMTF Reserved" , "Vendor Reserved" } IN ModelCorrespondence { "CIM_EnabledLogicalElement.RequestedState" } ValueMap { "2" , "3" , "4" , "6" , "7" , "8" , "9" , "10" , "11" , ".." , "32768..65535" }
uint16 RequestedState
Reference to the job (can be null if the task is completed).
Qualifiers:OUT IN ( false )
CIM_ConcreteJob REF Job
A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition.
If this property does not contain 0 or null and the implementation does not support this parameter, a return code of 'Use Of Timeout Parameter Not Supported' must be returned.

Qualifiers:IN
datetime TimeoutPeriod
)
Requests that the state of the element be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the EnabledState and RequestedState of the element will be the same. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten or lost.
If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If 4096 (0x1000) is returned, then the task will take some time to complete, ConcreteJob will be created, and its reference returned in the output parameter Job. Any other return code indicates an error condition.
Values { "Enabled" , "Disabled" , "Shut Down" , "No Change" , "Offline" , "Test" , "Deferred" , "Quiesce" , "Reboot" , "Reset" , "Not Applicable" , "DMTF Reserved" , "Vendor Reserved" }
ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" }
ValueMap { "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , ".." , "32768..65535" }
uint16 RequestedState = 12 ;
RequestedState is an integer enumeration that indicates the last requested or desired state for the element. 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. By default, the RequestedState of the element is 5 ('No Change'). Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration.

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.

A particular instance of EnabledLogicalElement might not support RequestedStateChange. If this occurs, the value 12 ('Not Applicable') is used.
Values { "Enabled" , "Disabled" , "Not Applicable" , "Enabled but Offline" , "No Default" , "DMTF Reserved" , "Vendor Reserved" }
Write
ValueMap { "2" , "3" , "5" , "6" , "7" , "8..32767" , "32768..65535" }
uint16 EnabledDefault = 2 ;
An enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element. By default, the element is 'Enabled' (value=2).
ModelCorrespondence { "CIM_ManagedSystemElement.OperationalStatus" }
ArrayType ( "Indexed" )
string StatusDescriptions [ ] ;
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.
MaxLen ( 10 )
Deprecated { "CIM_ManagedSystemElement.OperationalStatus" }
ValueMap { "OK" , "Error" , "Degraded" , "Unknown" , "Pred Fail" , "Starting" , "Stopping" , "Service" , "Stressed" , "NonRecover" , "No Contact" , "Lost Comm" , "Stopped" }
string Status ;
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 overcomes the limitation of describing status via a single value, when it is really a multi-valued property (for example, an element may be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. And, 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.
MaxLen ( 64 )
string Caption ;
The Caption property is a short textual description (one- line string) of the object.
string ElementName ;
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.