Top
ServerView Resource Orchestrator Cloud Edition V3.0.0 Setup Guide

E.1.1 Definition Files

This section explains the definition files used when creating a virtual L-Server.

When using an L-Server, configuration of a definition file may be necessary.

Overcommit Definition Files

This section explains overcommit definition files.

Storage Location of the Definition File

[Windows]
Installation_folder\Manager\etc\customize_data

[Linux]
/etc/opt/FJSVrcvmr/customize_data

Information

In the storage location above, the sample definition file (pool.sample.rcxprop) is stored. When using the sample as the definition file, place the file after deleting the ".sample" included in the file name.

Name of the Overcommit Configuration File

pool.rcxprop

Format of the Overcommit Configuration File

over_commit=pool1,pool2,...
over_commit_calculate_by_reserve_value=true|false

over_commit

Multiple VM pool names can be specified. When specifying multiple resource pools, separate them using commas (",").
If the VM pool is arranged in a hierarchy, specify the name using an absolute path.
For a VM pool directly under the orchestration tree, specify only its name.

Example

over_commit=VMPool,/folder1/VMPool

Point

When creating L-Servers that use overcommit and L-Servers that do not, both a VM pool that uses overcommit and a VM pool that does not must be created.

over_commit_calculate_by_reserve_value

Specify the calculation method for available space for a VM pool used for overcommit.
One of the following values can be specified.

  • When using a reservation value

    Specify "true".

  • When using a maximum value

    Specify "false".

"false" is specified in the following cases:

  • When specification of "over_commit_calculate_by_reserve_value" is omitted

  • When an invalid value is specified

Example

over_commit_calculate_by_reserve_value=true


VM Specific Information Definition File

This file contains the information to be specified for a virtual machine when creating an L-Server or when modifying a configured (defined) L-Server.
VM specific information definition files can be created for each user group.
Use the UTF-8 character code.
The order of the priority of the parameters is as follows:

L-Server XML file > L-Server template > Definition file (User group) > Definition file (Shared on the system)

Storage Location of the Definition File

[Windows]
Installation_folder\Manager\etc\customize_data\vm_prop

[Linux]
/etc/opt/FJSVrcvmr/customize_data/vm_prop

Point

In the storage location above, the sample definition file (vm_VMTYPE.rcxprop.sample) is stored. When using the sample as the definition file, place the file after changing "VMTYPE" to the VM type and deleting ".sample".

Definition File Name

Definition files can be divided into definitions that are available for each user group and definitions that are common on the system.

If the same key is configured in the definition file common on the system and the definition file for a specific user group, priority is given to the values indicated in the definition file for the user group.

  • User Groups

    vm_user_group_name_VM_type.rcxprop

  • Common on System

    vm_VM_type.rcxprop

Note

  • For VM_type, enter the VM type to be specified when creating an L-Server, such as VMware, Hyper-V, Oracle VM, or RHEL-KVM. This value is not case-sensitive.

  • When there are multiple files with the same VM_type specified in the filename, the VM_type of the filenames are sorted in ascending order of character code, and the one listed first will be selected.

    Example

    usergroup1_VMware
    usergroup1_VMWARE -> This file will be selected.
    usergroup1_vmware

  • Remove any blank spaces in the VM_type.

    Example

    Oracle VM -> OracleVM

Definition File Format

In the definition file, an item to define is entered on each line. Each line is entered in the following format.

Key = Value

Definition File Items

Specify the following items.

Table E.1 The List of Parameters

Key

Description

processor_reserve_spec

Specify the minimum amount of CPU resources to be allocated.

Enter a value in the range from 0 to the limit of CPU performance, using a number with up to one decimal place, in units of gigahertz.
In the XML files for L-Servers and L-Server templates, set the value for "CPUReserve".

processor_share

Specify the relative proportion of CPU resources for allocation.

Enter an integer equal to or greater than 1.
In the XML files for L-Servers and L-Server templates, set the value for "CPUShare".
Enabled when the VM type is set to "VMware".

memory_reserve_size

Specify the minimum amount of memory resources to be allocated.

Enter a value in the range from 0 to the limit of memory size, using a number with up to one decimal place, in units of gigabytes.
In the XML files for L-Servers and L-Server templates, set the value for "MemoryReserve".
Enabled when the VM type is set to "VMware".

memory_share

Specify the relative proportion of memory resources for allocation.

Enter an integer equal to or greater than 0.
In the XML files for L-Servers and L-Server templates, set the value for "MemoryShare".
Enabled when the VM type is set to "VMware".

processor_weight

Specify the priority for CPU allocation.

Enter an integer between 1 and 10,000.
In the XML files for L-Servers and L-Server templates, set the value for "CPUWeight".
Enabled when the VM type is set to "Hyper-V".

dynamic_memory

Specify the dynamic memory settings.

  • When dynamic memory is enabled

    Specify "true".

  • When dynamic memory is disabled

    Specify "false".

When omitted, the value varies depending on the initial memory size and memory buffer specified when creating an L-Server.

  • When the initial memory size or memory buffer is configured

    Dynamic memory is enabled

  • When neither initial memory size nor memory buffer is configured

    Dynamic memory is disabled

When dynamic memory is disabled, the values specified for memory_startup_size and memory_buffer_rate will be ignored.
Enabled when the VM type is set to "Hyper-V".

memory_startup_size

Specify the initial amount of memory to be allocated at startup.

Enter a value between 0.1 and the limit of memory size.
In the XML files for L-Servers and L-Server templates, set the value for "StartupRAM".
When setting this value for a virtual machine, enable dynamic memory in the XML file to be specified when creating an L-Server template or L-Server, or do not specify dynamic memory.
When no L-Server template is used and dynamic memory settings are not specified in the XML file specified when creating an L-Server, dynamic memory is enabled or disabled based on the existence of this setting and the setting for memory_buffer_rate.

  • When this setting or memory_buffer_rate are set

    Dynamic memory is enabled

  • When this setting and memory_buffer_rate are not set

    Dynamic memory is disabled

When dynamic memory is disabled, this setting is ignored.
Enabled when the VM type is set to "Hyper-V".

memory_buffer_rate

Specify the percentage of memory to be reserved as a buffer.

Enter an integer between 5 and 2000 in units of percent.
In the XML files for L-Servers and L-Server templates, set this value for "MemoryBuffer".
When setting this value for a virtual machine, either enable dynamic memory in the XML file to be specified when creating an L-Server template or L-Server, or do not specify dynamic memory.
When no L-Server template is used and dynamic memory is not specified in the XML file specified during L-Server creation, dynamic memory setting is enabled or disabled based on whether this setting and the setting for memory_startup_size exist.

  • When this setting or memory_startup_size exists

    Dynamic memory is enabled

  • When this setting and memory_startup_size are not set

    Dynamic memory is disabled

When dynamic memory is disabled, this setting is ignored.
Enabled when the VM type is set to "Hyper-V".

memory_weight

Specify the priority for allocation of memory.

Enter an integer between 0 and 10,000.
In the XML files for L-Servers and L-Server templates, set this value for "MemoryWeight".
Enabled when the VM type is set to "Hyper-V".

max_definable_memory_size

Specify the maximum amount of memory that can be configured for the VM guest on KVM.

Enter a value in the range from the limit of memory size to the memory size of a physical server, using a number with up to one decimal place, in units of gigabytes.
The memory amount for the VM guest can be changed up to this value setting as the upper limit.
When omitted, this memory size is the same as the amount of physical memory for the VM host.
When the amounts of memory mounted on the VM hosts registered in a VM pool are not the same, specify the memory capacity less than the value of VM host with the minimum memory capacity, when specifying this item.
When specifying the values exceeding the physical memory capacity, starting of an L-Server fails.

See

When not describing a parameter in the VM specific information definition file, refer to each element name in "2.3.2 Definition Information for Virtual L-Servers (XML)" in the "Reference Guide (Resource Management) CE".

Note

When modifying specifications of an L-Server to which resources have been allocated, the settings in this definition file are not reflected because priority is given to the values already configured for the L-Server. In this case, enter new values in the XML file and then execute the appropriate commands to reflect the changes.

When individual parameters are specified when creating an L-Server template or L-Server, priority is given to those settings over those in this definition file.


Configuration of Priority for Resource Selection on Thin Provisioning

When setting to automatic selection for resource selection while creating L-Server or attaching a disk under the condition that both storage pools with and without the configuration of thin provisioning attributes remain the same priority, either of their resources can be given higher priority.

When the definition file has been edited, restart the manager.

Location of the Definition File

[Windows]
Installation_folder\Manager\etc\customize_data

[Linux]
/etc/opt/FJSVrcvmr/customize_data

Definition File Name

storage.rcxprop

Definition File Format

In the definition file, the items to set are entered on individual lines. Each line is entered in the following format.

Item_specified = Value_specified

Definition File Items
  • SELECT_THIN_PROVISIONING_POOL_FIRST

    When both storage pools with and without the configuration of thin provisioning attributes remain the same priority, either of their resources can be given higher priority for automatic selection of storage resource.

    • If "true" is specified

      A storage pool with thin provisioning attributes will be given priority.

    • If "false" is specified

      A storage pool without thin provisioning attributes will be given priority.

    • If nothing is specified

      "false" is set.

Example

An example definition file is indicated below.

SELECT_THIN_PROVISIONING_POOL_FIRST = true


Configuration when Creating a Virtual L-Server Using a Server which cannot Use ServerView Agents

As ServerView Agents cannot be used for the following servers, the hardware configuration information (CPU core count, CPU clock speed, memory capacity, etc.) cannot be acquired.

When creating a virtual L-Server after installing VM management software on the servers above, it is necessary to register a managed server, after creating a definition file first, and defining the configuration information.

In the following cases, create the definition file first, and then register the hardware information with Resource Orchestrator again.

For details, refer to "Chapter 7 Hardware Maintenance" in the "Operation Guide CE".

Note

When there are differences between the values in the definition file and the actual configuration information of the server, creation or starting of the virtual L-Server may fail, or the virtual machine may be deployed using incorrect CPU and memory information.

Be sure to confirm that the values entered in the definition file and the actual configuration information of the server are the same.

Storage Location of the Definition File

[Windows]
Installation_folder\Manager\etc\customize_data

[Linux]
/etc/opt/FJSVrcvmr/customize_data

Definition File Name

server_spec.rcxprop

Character Code

[Windows/Linux]
UTF-8

Line Break Code

[Windows]
CR/LF

[Linux]
LF

Definition File Format
  • The following line must be entered in the first line of definition files.

    ServerSpec,V1.0

  • In the definition file, enter the configuration information (CPU core count, CPU clock speed, memory capacity, etc.), separated by commas (",").

    When defining two or more servers, use line breaks.
    Each line is entered in the following format.

    physical_server, cpu_core_count, cpu_clock, memory_size[, cpu_type]

  • Blank spaces between data and commas (",") are ignored.

    If there is duplicated configuration information (CPU core count, CPU clock speed, memory capacity, etc.) for the same physical server, the values that appear first will be used.

  • When adding comments, start the line with a number sign ("#").

Definition File Items
physical_server

Enter the same physical server name as the one entered when registering a managed server.

cpu_core_count

Enter the total number of physical CPU cores.
Enter an integer between 0 and 999.
If "0" is entered, a hyphen ("-") will be displayed in the General information of the Resource Details window, indicating that no virtual L-Server will be created.

cpu_clock

Enter the CPU clock speed.
Enter an integer between 0 and 999,999.
Use megahertz for the unit. Enter 1,000 MHz for 1 GHz, for example.
If "0" is entered, a hyphen ("-") will be displayed in the General information of the Resource Details window, indicating that no virtual L-Server will be created.

memory_size

Enter the total memory size.
Enter an integer between 0 and 999,999,999.
Use megabytes for the unit. Enter 1,024 MB for 1 GB, for example.
If "0" is entered, a hyphen ("-") will be displayed in the General information of the Resource Details window, indicating that no virtual L-Server will be created.

cpu_type

Enter the CPU type.
The string must be composed of alphanumeric characters and symbols (ASCII characters 0x20 to 0x7e), except for commas (","), and can be up to 64 characters long.
When omitted, a hyphen ("-") is displayed.

Example

An example definition file is indicated below.

ServerSpec,V1.0

###########################################################################
# server_spec.rcxprop
#
#All Rights Reserved, Copyright(C) FUJITSU LIMITED 2011
###########################################################################
#
# physical_server, cpu_core_count, cpu_clock, memory_size, cpu_type
#

server001, 8, 3160, 4096, Intel(R) Xeon(R)
server002, 8, 2660, 12288, Intel(R) Xeon(R)
server003, 2, 2000, 65536
server004, 4, 4000, 4096, Intel(R) Xeon(R) Processor E5501


Configuration when Creating a Virtual L-Server Using VMware ESXi on Other Vendor's Servers

It is necessary to define that the server can be used as a VM software agent without using an agent for Resource Orchestrator, by creating the definition files before registering a server. When registering the server, select the "Register agent" checkbox, and register the server as VM host. In VM hosts registered using these definitions, obtain the server status or hardware configuration information (CPU core count, CPU clock speed, memory capacity, etc.) from VM software.

When the definition file is changed after registration, the modification is not valid.

Note

  • The server cannot be used for anything other than a VM host (spare server or Windows/Linux server).

  • Even the following settings are configured, priority is given to the information obtained from VM software.

    • Configuration when Creating a Virtual L-Server Using a Server which cannot Use ServerView Agents

    • Configurations to specify "Enable" for server management software (ServerView) when creating a server

  • On VM hosts registered using this definition, the following functions cannot be used.

    • Server switchover

  • In the configuration definition file for pre-configuration, do not describe the values in the following section header parameter for section name [Server]: If the values are described, registration fails.

    • snmp_community_name

Storage Location of the Definition File

[Windows]
Installation_folder\Manager\etc\customize_data

[Linux]
/etc/opt/FJSVrcvmr/customize_data

Point

In the storage location above, the sample definition file (server_control.sample.rcxprop) is stored. When using the sample as the definition file, place the file after deleting the ".sample" included in the file name.

Definition File Name

server_control.rcxprop

Character Code

[Windows/Linux]
UTF-8

Line Break Code

[Windows]
CR/LF

[Linux]
LF

Definition File Format
  • The following line must be entered in the first line of definition files.

    ServerControl,V1.0

  • In the definition file, the name of each server is described on an individual line.

    When defining two or more servers, use line breaks.
    Each line is entered in the following format.

    physical_server

    Even if there are multiple same physical server names in the individual lines, no errors occur.

  • When adding comments, start the line with a number sign ("#").

Definition File Items
physical_server

Enter the same physical server name as the one entered when registering a managed server.

Enter a character string beginning with an alphabetical character and containing up to 15 alphanumeric characters and hyphens ("-"). The following physical server names are ignored.

  • Blade Servers

  • PRIMEQUEST Servers

  • SPARC Enterprise Servers

  • Unregistered Servers

Information

When there are no definition files when registering a server, or when the physical server name to register is not described, the server is regarded as being a Fujitsu server.

Example

An example definition file is indicated below.

ServerControl,V1.0

###########################################################################
# server_control.rcxprop
#
#All Rights Reserved, Copyright(C) FUJITSU LIMITED 2012
###########################################################################
#
# physical_server
#

server1
server2


Definition File for Alive Monitoring

When using alive monitoring, create the definition file and specify the parameters for alive monitoring. The configuration of this parameter must be unique in the system.

The alive monitoring of virtual L-Server monitors the heartbeat of VM guests corresponding to the virtual L-Server by using the heartbeat monitoring functions of server virtualization software.

For details on heartbeat monitoring functions, refer to the server virtualization software manual.

[VMware]
For Resource Orchestrator alive monitoring functions, configure the heartbeat monitoring settings in "VMMonitoring" for VMware HA on each VM guest.

[Hyper-V]
For Resource Orchestrator alive monitoring functions, configure the heartbeat monitoring settings in "Heartbeat setting" for MSFC on each VM guest.

Note

When changing configuration of alive monitoring on server virtualization software, the modification is not reflected on Resource Orchestrator.
Therefore, do not change alive monitoring configurations on server virtualization software.

Storage Location of the Definition File

The file in which the default values are described is located during installation.

[Windows]
Installation_folder\Manager\etc\customize_data\alive_monitoring

[Linux]
/etc/opt/FJSVrcvmr/customize_data/alive_monitoring

Definition File Name
  • vm_VMware.rcxprop

  • vm_Hyper-V.rcxprop

    The file name is not case sensitive.

Definition File Format

In the definition file, the items to set are entered on individual lines. Each line is entered in the following format.

Item_specified=Value_specified

When adding comments, start the line with a number sign ("#").

Specified Items for vm_VMware.rcxprop
min_uptime

Specify "Minimum uptime" in the heartbeat monitoring settings for VMware.

Enter an integer between 0 and 100000. The unit is seconds.
"120" is specified as the default.

failure_interval

Specify "Failure interval" in the heartbeat monitoring settings for VMware.

Enter an integer between 1 and 100000. The unit is seconds.
"30" is specified as the default.

max_failures

Specify "Maximum per-VM resets" in the heartbeat monitoring settings for VMware.

Enter an integer between 1 and 1000.
"3" is specified as the default.

max_failure_window

Specify "Maximum resets time window" in the heartbeat monitoring settings for VMware.

Enter -1, and an integer between 1 and 1000. The unit is hours.
When -1 is specified, "None" is configured.
"1" is specified as the default.

off_override_cluster

When configuring to disable alive monitoring in Resource Orchestrator, overwrite the heartbeat monitoring settings for VMware clusters, and specify if disabling the heartbeat monitoring settings of VM guests.

To disable heartbeat monitoring configuration of VM guests, specify "true".
To configure the same settings of VM guest heartbeat monitoring as the settings of VMware cluster, specify "false".
"false" is specified as the default.

Note

When applying the modified details to an already created L-Server, execute the rcxadm lserver modify command after changing the definition files.

For details on the following parameters, refer to the VMware manual.

  • Minimum uptime

  • Failure interval

  • Maximum per-VM resets

  • Maximum resets time window

Specified items for vm_Hyper-V.rcxprop
restart_period

Specify "Period for restarts [mm:ss]" in the heartbeat monitoring settings for MSFC.

Enter an integer between 0 and 3599. The unit is seconds.
Specify a smaller value of time than that specified in "retry_period_on_failure".
"900" is specified as the default.

restart_threshold

Specify "Maximum restarts in the specified period" in the heartbeat monitoring settings for MSFC.

Enter an integer between 0 and 4294967295.
"1" is specified as the default.

failover

Specify "If restart is unsuccessful, fail over all resources in this service or application" in the heartbeat monitoring settings for MSFC.

When performing failover, specify "true".
When not performing failover, specify "false".
"true" is specified as the default.

retry_period_on_failure

Specify "If all the restart attempts fail, begin restarting again after the specified period [hh:mm]" in the heartbeat monitoring settings for MSFC.
Enter -1, and an integer between 0 and 1439. The unit is minutes.
When -1 is specified, it is disabled.
When specifying 0 to 1,439, specify a larger value of time than that specified in "restart_period".
"60" is specified as the default.

Note

When applying the modified details to an already created L-Server, execute the rcxadm lserver modify command after changing the definition files.

Refer to the MSFC manual for details on each parameter.