15.10 Tenants

The XML definition for tenants is shown below.

XML Definition for Creating and Modifying a Tenant

<?xml version="1.0" encoding="utf-8"?>
<Tenants>
  <Tenant name ="Name of the tenant">
    <DisplayName>Display Name</DisplayName>
    <MailAddress>User's mail address</MailAddress>
    <CutOffDate>Cut off date</CutOffDate>
    <AccountingMailAddress>Accounting mail address</AccountingMailAddress>
    <Pools>
      <Pool name="Local pool name" type="Local pool type" label="Label">
        <Comment>Comment</Comment>
        <Priority>Priority</Priority>
        <Attributes>
          <OverCommit>Overcommit attributes</OverCommit>
          <CalculatedUsing>Calculation methods for free space</CalculatedUsing>
          <Thin>Thin Provisioning attributes</Thin>
        </Attributes>
      </Pool>
    </Pools>
    <GlobalPoolLinks>
      <GlobalPoolLink>Global pool name</GlobalPoolLink>
       ...
    </GlobalPoolLinks>
    <Attrs>
      <Attr name="Item name for tenant configuration information 1" value="Value for tenant configuration information 1" />
      <Attr name="Item name for tenant configuration information 2" value="Value for tenant configuration information 2" />
       ...
    </Attrs>
  </Tenant>
</Tenants>

Table 15.18 List of Items Specified in XML Definitions for Tenant
Element Name	Description	Remarks (Possible Values, Examples)
Tenant name (Tenant name)	Name of the tenant (*1)	Specify a character string beginning with an alphanumeric character and containing up to 32 alphanumeric characters, underscores ("_"), and hyphens ("-"). Creation in a resource folder and tenant is not possible.
Display Name (DisplayName)	Tenant display name	Specify a character string of up to 30 alphanumeric characters or symbols.
E-mail address (MailAddress)	Mail address of the tenant administrator	Specify a character string of up to 64 alphanumeric characters or symbols.
Cut off date (CutOffDate)	Cut off date for accounting information	2-digit number to represent the date (1 to 31)
Accounting mail address (AccountingMailAddress)	Mail address to send the usage fee information to	Specify a character string of up to 64 alphanumeric characters or symbols.
Local pool name (Pool name)	Name of the local pool to create in the tenant	Specify the resource pool name (local pool name) to create in the tenant. If the Pools element is omitted, no resource pool is created in the tenant.
Local pool type (Pool type)	Type of the local pool (optional)	Specify the type of the local pool to create in the tenant. The following types can be specified: vm (VM pool) server (Server pool) storage (Storage pool) network (Network pool) address (Address pool) image (Image pool)
Label (Pool label)	Label of the local pool (optional)	Specify a character string of up to 32 alphanumeric characters or symbols.
Comment (Pool comment)	Comment for the local pool (optional)	Specify a character string of up to 256 alphanumeric characters or symbols.
Priority (Priority)	Local pool priority (optional)	Specify the priority for the local pool as a value between 1 and 10. If omitted, "5" is set. For the priority order, "1" is the highest and "10" is the lowest.
Overcommit attributes (*2) (OverCommit)	Setting for overcommit (optional)	Set enabling/disabling of overcommit for a VM pool. If omitted, "false" is set. When enabling overcommit Specify "true". When disabling overcommit Specify "false".
Calculation methods for free space (*2) (CalculatedUsing)	Settings for calculation methods for the free space of resources (optional)	Set the calculation methods for free space for VM pools that have overcommit enabled. If omitted, "limit" is set. When calculating the free space using a reservation value Specify "reserve". When calculating the free space using the upper limit value Specify "limit".
Thin Provisioning attributes (*2) (Thin)	Settings for Thin Provisioning attributes (optional)	Set Provisioning attributes for storage pools. If omitted, "false" is set. When configuring Thin Provisioning attributes Specify "true". When configuring Thick Provisioning attributes Specify "false".
Global pool name (GlobalPoolLink)	Name of the global pool (optional)	Specify the resource pool name to be defined in a global pool of a tenant. If the GlobalPoolLinks element is omitted, no global pool is defined for the tenant. If specifying a resource pool in a resource folder, specify the resource folder name using slashes ("/").
Item name of tenant configuration information (Attr name)	Item name of tenant configuration information (optional)	Specify the item name of the tenant configuration information. For details on the item names that can be specified, refer to "Table 15.19 Items of Tenant Configuration Information". Specification of multiple items of tenant configuration information is possible.
Value of tenant configuration information (Attr value)	Value of tenant configuration information (optional)	Specify the value of the tenant configuration information. For details on the item names that can be specified, refer to "Table 15.19 Items of Tenant Configuration Information".

*1: User group of the same name as the specified name of the tenant is created.

*2: When upgrading an admin server from ROR V2.3.0 to V3.0.0, if the migration procedure is not performed according to the configuration methods for the overcommit functions, this element cannot be configured. Edit the definition files separately. For details, refer to "G.1.1 Overcommit Definition Files" in the "Setup Guide CE".

Table 15.19 Items of Tenant Configuration Information
name	value
workflow.policy	Specify whether to enable the application process settings for each tenant. Specify one of following items. default (by default when creating it) Configure the settings based on the overall settings. custom Configure the settings according to the application process for each tenant.
workflow.subscribe	Specify the administrator to approve or evaluate L-Platform usage application. Specify one of following items. infra Evaluation by the infrastructure administrator tenant Approval by the tenant administrator infra_tenant (by default when creating it) Evaluation by the infrastructure administrator and approval by the tenant administrator none Neither evaluation by the infrastructure administrator nor approval by the tenant administrator
workflow.reconfigure	Specify the administrator to approve or evaluate L-Platform configuration changes. Specify one of following items. infra Evaluation by the infrastructure administrator tenant Approval by the tenant administrator infra_tenant (by default when creating it) Evaluation by the infrastructure administrator and approval by the tenant administrator none Neither evaluation by the infrastructure administrator nor approval by the tenant administrator
workflow.unsubscribe	Specify the administrator to approve or evaluate L-Platform cancellation. Specify one of following items. infra Evaluation by the infrastructure administrator tenant Approval by the tenant administrator infra_tenant (by default when creating it) Evaluation by the infrastructure administrator and approval by the tenant administrator none Neither evaluation by the infrastructure administrator nor approval by the tenant administrator

Tenant Creation Default Definition File

When creating a tenant using the ROR console, the default values can be changed.

To change the default values in tenant creation, modify the tenant creation default definition file.

Location of the Definition File

[Windows]
Installation_folder\Manager\etc\customize_data

[Linux]
/etc/opt/FJSVrcvmr/customize_data

Definition File Name: tenant_config.xml

Definition File Format

<?xml version='1.0' encoding='utf-8'?>
<Tenant>
  <Pools>
    <Pool name="Local pool name" type="Local pool type">
      <Priority>Priority</Priority>
    </Pool>
  </Pools>
  <GlobalPoolLinks>
    <GlobalPoolLink>Global pool name</GlobalPoolLink>
  </GlobalPoolLinks>
</Tenant>

Table 15.20 List of Items Specified in Initial Values of Definition File for Tenant Creation
Element Name	Description	Remarks (Possible Values, Examples)
Local pool name (Pool name)	Name of the local pool to create in the tenant	Specify the name of the local pool to create in the tenant. For the local pool name, enter a character string beginning with an alphanumeric character, and containing up to 32 alphanumeric characters, underscores ("_"), and hyphens ("-"). If other values are configured, an error occurs when <OK> is clicked in the tenant creation window.
Local pool type (Pool type)	Type of the local pool	Specify the type of the local pool to create in the tenant. The following types can be specified: vm (VM pool) server (Server pool) storage (Storage pool) network (Network pool) address (Address pool) image (Image pool) If other values are configured, "undefined" is displayed on the tenant creation window, and an error occurs when <OK> is clicked.
Priority (Priority)	Local pool priority	Specify the priority for the local pool. For the priority order, specify a number between 1 and 10. If other values are configured, an error occurs when <OK> is clicked in the tenant creation window.
Global pool name (GlobalPoolLink)	Name of the global pool	Specify the resource pool name to be defined in a global pool of a tenant, using the hierarchy described as follows: /Resource_folder_name/Global_pool_name The global pool names are not displayed in the tenant creation window, in the following cases: When a resource pool which does not exist is specified When something other than a resource pool is specified

Example Definition File

An example definition file is indicated below.

<?xml version='1.0' encoding='utf-8'?>
<Tenant>
  <Pools>
    <Pool name="TenantVMHostPool" type="vm">
      <Priority>5</Priority>
    </Pool>
    <Pool name="TenantServerPool" type="server">
      <Priority>5</Priority>
    </Pool>
    <Pool name="TenantStoragePool" type="storage">
      <Priority>5</Priority>
    </Pool>
    <Pool name="TenantNetworkPool" type="network">
      <Priority>5</Priority>
    </Pool>
    <Pool name="TenantAddressPool" type="address">
      <Priority>5</Priority>
    </Pool>
    <Pool name="TenantImagePool" type="image">
      <Priority>5</Priority>
    </Pool>
  </Pools>
  <GlobalPoolLinks>
    <GlobalPoolLink>/VMHostPool</GlobalPoolLink>
    <GlobalPoolLink>/ServerPool</GlobalPoolLink>
    <GlobalPoolLink>/StoragePool</GlobalPoolLink>
    <GlobalPoolLink>/NetworkPool</GlobalPoolLink>
    <GlobalPoolLink>/AddressPool</GlobalPoolLink>
    <GlobalPoolLink>/ImagePool</GlobalPoolLink>
  </GlobalPoolLinks>
</Tenant>

Sample Definition File

Sample definition files that have appropriate resource pools configured for each operation form are provided.

Copy the sample definition files relevant to the tenant operations, to the storage location for the definition files.

Installation Directories
[Windows]
Installation_folder\Manager\etc\files\tenant_config_samples
[Linux]
/etc/opt/FJSVrcvmr/files/tenant_config_samples
Sample Definition File
- Tenants where combinations of virtual and physical L-Servers are operated
  lserver_multi/tenant_config.xml
- Tenants on which physical L-Servers are operated
  lserver_physical/tenant_config.xml
- Tenants on which virtual L-Servers are operated
  lserver_vm/tenant_config.xml
- Tenants which do not use local pools
  pool_nothing/tenant_config.xml