SUMMARY: NESTED | FIELD | | METHOD
DETAIL: FIELD | METHOD

Class CIM_RemotePort

Used in features: General Info
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
   extended by CIM_ManagedSystemElement
      extended by CIM_LogicalElement
         extended by CIM_EnabledLogicalElement
            extended by CIM_ServiceAccessPoint
               extended by CIM_RemoteServiceAccessPoint
                  extended by CIM_RemotePort
Known Subclasses:
AMT_EventSubscriber AMT_SNMPEventSubscriber 
class CIM_RemotePort
 extends CIM_RemoteServiceAccessPoint


General Information:
RemotePort adds port information to the access 
data (such as IP Address) that is specified in and inherited from 
RemoteServiceAccessPoint. For example, using the additional properties in this 
class, you could indicate that UDP Port 123 is accessed at IP Address xyz. The 
IP Address would be specified in the inherited AccessInfo property, while the 
UDP Port number would be specified in the PortInfo property of this 
class.

Qualifiers:
-------------
Version=2.10.0
UMLPackagePath=CIM::Core::Service









  
  

    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 . . .

  

     string 
      
    AccessInfo 
Access or 
      addressing information or a combination of this information for a remote 
      connection . . .

  

     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 Key  
The CreationClassName of the scoping 
      System.

  

     string 
      
    SystemName Key  
The Name of the scoping System.

  

     string 
      
    CreationClassName Key  
CreationClassName indicates the name 
      of the class or the subclass used in the creation of an instance . . 
    .

  

     string 
      
    Name Key  
The Name property uniquely identifies the 
      ServiceAccessPoint and provides an indication of the functionality that is 
      managed . . .

  

     string 
      
    PortInfo 
Port 
      information that might further specify the remote access 
    information.

  

     uint16 
      
    PortProtocol 
An 
      enumerated integer that describes the protocol of the port that is 
      addressed by PortInformation.




  
  

    Methods Summary

  

     
    Get(Instance) 
Gets the 
      representation of the 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




  
  

    Field 
Detail


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:
In Intel AMT Release 6.0 and later releases value 'Host Name' 
  (2) 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}


  

  





AccessInfo 
public string AccessInfo



  
General Information:
Access or addressing information or a 
  combination of this information for a remote connection. This information can 
  be a host name, network address, or similar information.

Product 
  Specific Usage:
In Intel AMT Release 6.0 and later release, this 
  information can be only network 
  address.

Qualifiers:
-------------
ModelCorrespondence={CIM_RemoteServiceAccessPoint.InfoFormat}
MaxLen=256


  

  





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 Remote 
  Port'

Qualifiers:
-------------
MaxLen=25


  

  





SystemCreationClassName Key 
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=20
Propagated=CIM_System.CreationClassName


  

  





SystemName Key 
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=256
Propagated=CIM_System.Name


  

  





CreationClassName Key 
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 
  'CIM_RemotePort'

Qualifiers:
-------------
Key
MaxLen=20


  

  





Name Key 
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 Remote 
  Port'

Qualifiers:
-------------
Key
Override=Name
MaxLen=25


  

  





PortInfo 
public string PortInfo



  
General Information:
Port information that might further specify 
  the remote access 
  information.

Qualifiers:
-------------
ModelCorrespondence={CIM_RemotePort.PortProtocol}
MaxLen=256


  

  





PortProtocol 
public uint16 PortProtocol



  
General Information:
An enumerated integer that describes the 
  protocol of the port that is addressed by 
  PortInformation.

Qualifiers:
-------------
ValueMap={1, 2, 
  3, 32768..65535}
Values={Other, TCP, UDP, Vendor 
  Specific}
ModelCorrespondence={CIM_RemotePort.OtherProtocolDescription}


  

  






  
  

    Method 
Detail


Get
public  Get([OUT]CIM_RemotePort Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_GENERAL_INFO_REALM, 
  ADMIN_SECURITY_ADMINISTRATION_REALM

General Information:
Gets 
  the representation of the 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






  
  

    SUMMARY: NESTED | FIELD | METHOD
  

  

    DETAIL: FIELD | METHOD



  
  

    
      
Copyright © 2006-2022, Intel 
      Corporation. All rights 
reserved.