Setting up the configuration profile for the Activation Engine

Learn how to set up the Activation Engine configuration file by using XML tags.

Configuration file

Use the following example of the configuration file to learn about the XML tags.

<vHMC-Configuration>
   <ConfigurationVersion>2.0</ConfigurationVersion>
   <LicenseAgreement></LicenseAgreement>
   <AcceptLicense>Yes</AcceptLicense>
   <Locale>en_US.UTF-8</Locale>
   <SetupWizard>No</SetupWizard>
   <SetupCallHomeWizard>No</SetupCallHomeWizard>
   <SetupKeyboard>No</SetupKeyboard>
   <SetupDisplay>No</SetupDisplay>
   <Ethernet Enable='Yes' DefaultGatewayDevice='Yes' PrivateInterface='No'>
      <Hostname></Hostname>
      <Domain></Domain>
      <DNSServers></DNSServers>
      <IPV4Config>
         <NetworkType></NetworkType>
         <IPAddress></IPAddress>
         <Netmask></Netmask>
         <Gateway></Gateway>
      </IPV4Config>
      <IPV6Config>
         <NetworkType></NetworkType>
         <IPAddress></IPAddress>
         <Gateway></Gateway>
      <IPV6Config>
      <Firewall>
         <PEGASUS>Enabled</PEGASUS>
         <RPD>Enabled</RPD>
         <FCS>Enabled</FCS>
         <I5250>Enabled</I5250>
         <PING>Enabled</PING>
         <L2TP>Disabled</L2TP>
         <SLP>Enabled</SLP>
         <RSCT>Enabled</RSCT>
         <SECUREREMOTEACCESS>Enabled</SECUREREMOTEACCESS>
         <SSH>Enabled</SSH>
         <NTP>Disabled</NTP>
         <SNMPTraps>Disabled</SNMPTraps>
         <SNMPAgents>Disabled</SNMPAgents>
      </Firewall>
   </Ethernet>
   <NTPServers>
      <ntpparam ntpserver="" ntpversion=""/>
   </NTPServers>
</vHMC-Configuration>

XML tags for the configuration file

XML tags are used in the Activation Engine configuration file to set specific values for various attributes. You can manually set these values in the Activation Engine configuration file. Use the following table to see a description of each tag and its allowed values:
Table 1. XML tags
Tags Description Acceptable values Notes
ConfigurationVersion Required element that defines the configuration version to use.

2.0

  
LicenseAgreement Required element that displays the HMC virtual appliance license agreement.    
AcceptLicense Required element to accept the HMC virtual appliance license agreement.
  • Yes: Accepts the HMC license agreement.
  • No: Prompts User to Accept HMC License Agreement
If an invalid value is entered, the Activation Engine uses the default setting of No.
Locale Required element to define locale settings.

en_US.UTF-8

 If an invalid value is entered, the Activation Engine uses the default setting of US.
SetupWizard Required element to enable or disable the HMC Setup wizard.
  • Yes: Displays the HMC Setup wizard.
  • No: Disables the HMC Setup wizard display.
If an invalid value is entered, the Activation Engine uses the default setting of Yes.
SetupCallHomeWizard Required element to enable or disable the HMC Call Home wizard.
  • Yes: Displays the HMC Call Home wizard.
  • No: Disables the HMC Call Home wizard display.
 If an invalid value is entered, the Activation Engine uses the default setting of Yes.
SetupKeyboard Required element to define the keyboard configuration.
  • Yes: Prompts the user for keyboard configuration.
  • No: Accepts default keyboard configuration (US).
If an invalid value is entered, the Activation Engine uses the default setting of Yes.
SetupDisplay Required element to enable or disable the display configuration.
  • Yes: Prompts the user for display configuration.
  • No: Accepts default display configuration.
If an invalid value is entered, the Activation Engine uses the default setting of Yes.
Ethernet Required element that holds values for Ethernet adapter configurations. A maximum of four Ethernet adapters can be configured.
Enable:
  • Yes: Configure this adapter.
  • No: Do not configure this adapter.
DefaultGatewayDevice:
  • Yes: Configure this adapter as the main network adapter.
  • No: Do not configure this adapter as the main network adapter.
PrivateInterface:
  • Yes: Configure this adapter as a private interface. Yes is required to configure interface as an IPv4 DHCP Server.
  • No: Do not configure this adapter as a private interface. No is required to configure interface as IPv4 static type.
 The Activation Engine runs the default configuration if any invalid values are entered within the Ethernet adapter section or if multiple Default Gateway Devices are defined. Optional elements can be omitted from the configuration. At least one IPV4 or IPV6 configuration is required. If you do not specify an IP configuration, the Activation Engine uses the default configuration.
HostName Optional element to define the network host name. Any valid host name string. If the element is not defined, the Activation Engine uses the default local host HostName value.
Domain Optional element to define the network domain. Any valid domain value (for example, example.us.com). If the element is not defined, the Activation Engine uses the default empty Domain value.
DNSServers Optional element to define the network DNS servers.

It is acceptable to have one DNS Server value or up to three valid IPv4 or IPv6 addresses that are separated by a comma.

  • Example 1: IPv4: 8.3.2.1 IPv6: 2001:4860:4860::8888
  • Example 2: IPv4: 8.3.2.1,8.5.4.1 IPv6: 2001:4860:4860::8888,2001:4860:4860::8844
  • Example 3: IPv4: 8.3.2.1,8.5.4.1,8.4.3.2 IPv6: 2001:4860:4860::8888,2001:4860:4860::8844, ::ffff:903:201
 If the element is not defined, the Activation Engine uses the default empty DNSServers value.
IP4Config Optional element to define IPv4 configuration settings.
IPType: Required element to define IPv4 configuration type.
  • Static: Configure this adapter by using static configuration.
  • DHCP: Configure this adapter by using DHCP configuration.
  • DHCPServer: Configure this adapter to be IPv4 DHCP server (requires PrivateInterface to be set to Yes).
IPAddress: Optional element that is required only if Static or DHCPServer configuration is selected.
  • Static Configuration: Any valid IPv4 address value.
  • DHCPServer Configuration: Any DHCP server IP within the IP range.
Netmask: Optional element that is required only if Static configuration is selected.
  • Any valid IPv4 netmask value.
Gateway: Optional element that is required only if Static configuration is selected.
  • Any valid IPv4 netmask value.
 
IP6Config Optional element to define IPv6 configuration settings.
IPType: Required element to define IPv6 configuration type.
  • Static: Configure this adapter by using static configuration.
  • DHCP: Configure this adapter by using DHCP configuration.
IPAddress: It is acceptable to have long or short form IPv6 format and long or short form IPv6 prefix.
  • Example 1: IPv6: 2001:4860:4860:0000:0000:0000:0000:8888
  • Example 2: IPv6: 2001:4860:4860::8888
  • Example 3: IPv6: 2001:4860:4860::8888/128
If no prefix is specified, the Activation Engine uses the default setting of /64 prefix.
Gateway:
  • Any valid IPv6 address value.
 
Firewall Optional element to define firewall settings.
PEGASUS:
  • Enabled: Allows the PEGASUS ports to be open.
  • Disabled: Disables PEGASUS ports.
RPD:
  • Enabled: Allows the RMC ports to be open.
  • Disabled: Disables RMC ports.
FCS:
  • Enabled: Allows the FCS ports to be open.
  • Disabled: Disables FCS ports.
I5250:
  • Enabled: Allows the 5250 ports to be open.
  • Disabled: Disables 5250 ports.
PING:
  • Enabled: Allows the Ping port to be open.
  • Disabled: Disables Ping port.
L2TP:
  • Enabled: Allows the L2TP ports to be open.
  • Disabled: Disables L2TP ports.
SLP:
  • Enabled: Allows the SLP ports to be open.
  • Disabled: Disables SLP ports.
RSCT:
  • Enabled: Allows the RSCT ports to be open.
  • Disabled: Disables RSCT ports.
SECUREREMOTEACCESS:
  • Enabled: Allows the secure remote access ports to be open.
  • Disabled: Disables secure remote access ports.
SSH:
  • Enabled: Allows the SSH port to be open.
  • Disabled: Disables SSH port.
  
Firewall Optional element to define firewall settings.
NTP:
  • Enabled: Allows the NTP ports to be open.
  • Disabled: Disables NTP ports.
SMNPTraps:
  • Enabled: Allows the SMNP traps ports to be open.
  • Disabled: Disables SMNP traps ports.
SMNPAgents:
  • Enabled: Allows the SMNP agents ports to be open.
  • Disabled: Disables SMNP agents ports.
  
NTPServers The NTPServers tag is needed if you want to configure up to five NTP servers within a HMC virtual appliance.

NTPServers: Accepts <ntpparam ntpserver="server" ntpversion="version"/>

ntpparam:
  • ntpserver: Accepts any valid IPv4 or IPv6 values and valid host names.
  • ntpversion: Accepts 1-4 numeric value
Example:
<NTPServers>
  <ntpparam ntpserver=
"test.austin.ibm.com" ntpversion="2"/>
  <ntpparam ntpserver="192.168.34.1" 
ntpversion="4"/>
  <ntpparam ntpserver="::ffff:903:201" 
ntpversion="3"/>`
</NTPServers>
 
Parent topic: Using the Activation Engine for the HMC virtual appliance


Last updated: Mon, April 13, 2020