Skip to main content

Port pattern attributes

The following attributes provide information about a port category pattern.

These attributes can be included in the request body for the POST /patterns method and the response body for the GET /patterns/{id}/includeSettings method.

For more information about port patterns, see Defining port settings.

AttributesTypeDescription
template_typeStringType of category pattern. This value is always Port.
templateObjectInformation about the system-information category pattern
 adapterTypeStringType of adapter to which this port pattern applies
 applyToSwitchBooleanIndicates whether to apply corresponding settings to the chassis switch internal ports, where applicable. This can be one of the following values.
  • true. Apply the settings to the chassis switch.
  • false. Do not apply the settings to the chassis switch.
 chipsetStringChipset of the adapter that is associated with this pattern
 descriptionStringCategory-pattern description
 extendedPortTemplateIdStringPattern IDs of a referenced extended-port category pattern that are used to configure additional port settings that are learned from the server
 idStringCategory pattern ID
 inUseBooleanIdentifies whether the category pattern is applied to one or more servers. This can be one of the following values.
  • true. The pattern is in use.
  • false. The pattern is not in use.
 nameStringCategory-pattern name
 portCfgModeStringTarget port operational mode. This can be one of the following values.
  • pNIC mode
  • vNIC virtual fabric mode
  • vNIC switch independent mode
  • vNIC unified fabric protocol mode
 portCfgOptionCodeStringProtocols that are enabled for this port, This can be one of the following values.
  • ethOnly. Ethernet
  • eth+fcoe. FCoE
  • eth+iscsi. iSCSI
  • NONE. The protocols are configured at the vport level (see the following row).
 referencedByArray of stringsList of pattern IDs for server patterns that reference this category pattern
 typeStringType of category pattern. This value is always Port.
 userDefinedStringIdentifies whether the category pattern is user define or learned. This can be one of the following values.
  • true. The pattern is defined by the user.
  • false. The pattern is predefined by Lenovo.
 vendorStringVendor of the adapter that is associated with this pattern
 vportsArray of stringsSettings for each of the vports, when port virtualization is enabled, for example
{
    enabled : true,
    id : 'portVirtualizationPattern:90:vport:91',
    maxSpeed : 100,
    minSpeed : 25,
    networkMode : 'TRUNK',
    portNumber : 1,
    protocol : 'ethOnly',
    vlanId : '2'
}
", ..., " {
    enabled : true,
    id : 'portVirtualizationPattern:90:vport:94',
    maxSpeed : 100,
    minSpeed : 25,
    networkMode : 'TRUNK',
    portNumber : 4,
    protocol : 'ethOnly',
    vlanId : '4'
}

Example​

{
    "template_type" : "Port",
    "template" : {
        "adapterType" : "adapter:16",
        "applyToSwitch" : false,
        "chipset" : "Skyhawk",
        "description" : "Pattern created from server: Lenovo x240 M5\n
                         Learned on: Jul 28, 2015 11:42:09 AM",
        "extendedPortTemplateId" : "*NONE",
        "id" : "portVirtualizationPattern:55",
        "inUse" : false,
        "name" : "Learned-Port-1.1.1",
        "portCfgMode" : "",
        "portCfgOptionCode" : "*NONE",
        "referencedBy" : [],
        "type" : "PortVirtualization",
        "userDefined" : true,
        "vendor" : "Emulex",
        "vports" : [
            "{id:'portVirtualizationPattern:55:vport:1',portNumber:1,enabled:true,
             maxSpeed:0,minSpeed:0,networkMode:'TRUNK',protocol:'ethOnly',vlanId:'0'}",
            "{id:'portVirtualizationPattern:55:vport:2',portNumber:2,enabled:true,
              maxSpeed:0,minSpeed:0,networkMode:'TRUNK',protocol:'',vlanId:'0'}",
            "{id:'portVirtualizationPattern:55:vport:3',portNumber:3,enabled:true,
              maxSpeed:0,minSpeed:0,networkMode:'TRUNK',protocol:'ethOnly',vlanId:'0'}",
            "{id:'portVirtualizationPattern:55:vport:4',portNumber:4,enabled:true,
              maxSpeed:0,minSpeed:0,networkMode:'TRUNK',protocol:'ethOnly',vlanId:'0'}"
        ]
    }
}