Skip to main content

Management-information pattern attributes

The following attributes provide information about a management-information 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 management-information patterns, see Defining management interface settings.

AttributesTypeDescription
template_typeStringType of category pattern. This value is always Management.
templateObjectInformation about the system-information category pattern
 descriptionStringCategory-pattern description
 domainNameSystemObjectInformation about the domain name system (DNS)
  dynamicDNSStringIndicates whether dynamic domain name service (DDNS) is enabled or disabled
  domainNameStringDomain name (for example, company.com)
  domainNameSourceStringIndicates whether to obtain the domain name from a DHCP server. This can be one of the following values.
  • dhcp
 hostNameObjectInformation about the hostname
  autogenStringIndicates whether the hostname of the server is automatically generated. This can be one of the following values.
  • Custom. The hostname is generated based on a custom naming scheme when the pattern is deployed.
  • Disable. The hostname is not changed on each server when the pattern is deployed.
  hyphenCheckedBooleanThis value is always false.
 interfaceSettingsObjectInformation about the interface settings
  ethInterfaceIntegerNetwork interface that is used for the management network (for example, 0 for Eth0)
  maximumTransmissionUnitStringMaximum transmission unit (MTU)
 managementIPAddressObjectInformation about the management IP address
  ipV4SettingsStringIPv4 address setting. This can be one of the following values.
  • Enable
  • Disable
  • No Change
  • This can be one of the following values.
  ipV6SettingsStringIPv6 address setting. This can be one of the following values.
  • Enable
  • No Change
 nameStringCategory-pattern name
 portAssignmentsObjectInformation about the port assignments
  cimhttpPortStringPort number for CIM over HTTP
  cimhttpsPortStringPort number for CIM over secure HTTP
  httpPortStringPort number for HTTP
  httpsPortStringPort number for secure HTTP
  telnetcliPortStringPort number for the Telnet CLI
  remotecontrolPortStringPort number for the remote control console
  sshcliPortStringPort number for the SSH CLI
  snmpagentPortStringPort number for the SNMP agent
  snmptrapsPortStringPort number for SNMP traps
 typeStringType of category pattern. This value is always Management.
 uriStringURI identifier for the exported pattern
 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.

Example​

{
    "template_type" : "Management",
    "template" : {
        "description" : "Pattern created from server: Lenovo x240\n
                         Learned on: Jul 29, 2015 12:08:14 PM",
        "domainNameSystem" : {
            "domainName" : "",
            "domainNameSource" : "dhcp",
            "dynamicDNS" : "enabled"
        },
        "hostName" : {
            "autogen" : "Disable",
            "hyphenChecked" : false
        },
        "interfaceSettings" : {
            "ethInterface" : 0,
            "maximumTransmissionUnit" : "1500"
        },
        "managementIPAddress" : {
            "ipV4Settings" : "No Change",
            "ipV6Settings" : "No Change"
        },
        "name" : "Learned-Management-2",
        "portAssignments" : {
            "telnetcliPort" : "23",
            "snmptrapsPort" : "162",
            "snmpagentPort" : "161",
            "sshcliPort" : "22",
            "remotecontrolPort" : "3900",
            "httpPort" : "80",
            "httpsPort" : "443",
            "cimhttpPort" : "5988",
            "cimhttpsPort" : "5989"
        },
        "type" : "Management",
        "uri" : "\/config\/template\/62",
        "userDefined" : true
    }
}