Cloud vendor information refers to the information related to the vendor that is selected first when adding contracts using Cloud Services Management. Vendors and connection information with the cloud management software is managed here.
When arranging a contract with a new cloud provider or when adding a private cloud as a service, the addition of new cloud vendor information is necessary.
Files in the following storage location are loaded as cloud vendor information. It is necessary to restart the services to reflect any modifications.
%FSCSM_HOME%\conf\vendors
Point
The following sample files of cloud vendor definitions are added during the installation of this product. These files may be copied or modified as necessary.
The format of modified cloud vendor information can be confirmed using the "5.2.15 Cloud Vendor Definition File Confirmation Command".
Cloud Vendor | Sample Vendor Definition File Name |
|---|---|
AWS | default_aws.xml |
Azure | default_azure.xml |
ROR | default_ror.xml |
K5 | default_k5.xml |
VMware | default_vmware.xml |
Physical Servers | default_physical.xml |
Note
Note the following when modifying or deleting cloud vendor information after the start of operation:
When modifying cloud vendor information
For the cloud vendor information and each option, add new information or parameters rather than modifying the existing ones.
When deleting cloud vendor information
Do not delete cloud vendor information which is being used in a contract. In addition, do not delete cloud vendor information that was used to create a service during a month in which that service is being used, as the cloud vendor information is used to calculate billing.
For the cloud vendor information of the physical machine, only "vendor" and "basicMenus/basicMenu" of "Setting Items" are configured. No values are configured for other items, "optional parameter value", and "other available configuration options".
Category | Item | Description | |
|---|---|---|---|
vendor | vendorId | The ID for the individual management of connection information with cloud services and cloud management software. Specify a value which differs from other cloud vendor information items. | |
type | Specify a cloud vendor type. For the cloud services and cloud management software supported by Cloud Services Management, the following character strings can be specified: | ||
Value to Specify | Product Type | ||
aws | AWS | ||
azure | Azure | ||
ror | ROR | ||
k5 | K5 | ||
vmware | VMware | ||
physical | Physical Servers | ||
vendorName | The display name of connection information with cloud services and cloud management software. | ||
basicMenus/basicMenu | - | The item names of the basic menus supported by this menu can be managed. The value for the item can be defined during menu addition. | |
menuId | The ID for the individual management of basic menus. Specify a unique value in the basic menu of the cloud vendor information. | ||
name | The name of the basic menu displayed when creating a menu using the Cloud Management Portal. | ||
instanceOptions/serviceOption | - | It is possible to manage the options related to virtual machines in the configuration options that can be selected during the addition of services. | |
optionId | The ID for the individual management of the option definitions for virtual machines in the configuration options. Specify a unique value for the configuration options (virtual machine information) of the cloud vendor information. | ||
name | The display name of the configuration options for virtual machines. | ||
parameter | The parameter used by Cloud Services Management itself, cloud services, and cloud management software as a configuration option when this option is selected during the addition of services. Specify an appropriate parameter key for the vendor type. For a list of keys that can be specified, refer to "Optional parameter values". | ||
defaultPrice | The Unit Price of the option that is displayed by default during the addition of menus. | ||
systemDiskImageOptions/serviceOption | - | It is possible to manage the options related to the system disk in the configuration options that can be selected during the addition of services. | |
optionId | The ID for the individual management of the option definitions for the system disk in the configuration options. Specify a unique value for the configuration options (system disk information) in the cloud vendor information. | ||
name | The display name of the configuration options (system disk) for virtual machines. | ||
parameter | The parameter used by Cloud Services Management itself, cloud services, and cloud management software as a configuration option when this option is selected during the addition of services. Specify an appropriate parameter key for the vendor type. For a list of keys that can be specified, refer to "Optional parameter values". | ||
defaultPrice | The Unit Price of the option that is displayed by default during the addition of menus. | ||
diskSize | The value used by Cloud Services Management as the disk size (GB) of the system disk on a virtual machine when this option is selected during the addition of menus. This value is not reflected on the virtual machines which are deployed by cloud service and cloud management software. For the virtual machines to be deployed by cloud service and cloud management software, check the disk size (GB) of the system disk and specify that size as the value for this option. Specify an integer between 0 and 99999999. | ||
dataDiskImageOptions/serviceOption | - | It is possible to manage the options related to additional data disks in the configuration options that can be selected during the addition of services. | |
optionId | The ID for the individual management of the option definitions of additional data disks in the configuration options. Specify a unique value for the configuration options (additional data disk information) of the cloud vendor information. | ||
name | The display name of the configuration options (additional data disk) for virtual machines. | ||
parameter | The parameter used by Cloud Services Management itself, cloud services, and cloud management software as a configuration option when this option is selected during the addition of services. Specify an appropriate parameter key for the vendor type. For a list of keys that can be specified, refer to "Optional parameter values". | ||
defaultPrice | The Unit Price of the option that is displayed by default during the addition of menus. | ||
diskSize | The value used by Cloud Services Management itself, cloud services, and cloud management software as the disk size (GB) of the system disk on a virtual machine when this option is selected during the addition of menus. Specify an integer between 0 and 99999999. | ||
othersOptions/serviceOption | - | It is possible to manage the other options in the configuration options that can be selected during the addition of services. Omit the serviceOption element for cloud vendors for which no other options have been prepared. For details on specifiable values, refer to "Other Available Configuration Options". | |
optionId | The ID for the individual management of the definitions of other options for virtual machines in the configuration options. Specify a unique value for the configuration options (other configuration option information) of the cloud vendor information. | ||
name | The display name of the configuration options (other) for virtual machines. | ||
deployParameters/deployParameter | - | The specific parameter information that is passed to the cloud vendor and cloud management software, excluding configuration options, can be managed. This item can be selected during the addition of menus. | |
id | The ID for the individual management of specific parameter information. Specify a unique value for the specific parameters of the cloud vendor information. | ||
name | The display name for the individual management of specific parameter information to be passed to cloud service and cloud management software. | ||
parameter | The value of the parameter information used by Cloud Services Management itself, cloud services, and cloud management software during deployment when this parameter definition is selected during the addition of services. Specify an appropriate parameter key for the vendor type. For a list of keys that can be specified, refer to "Optional parameter values". | ||
Information
The specifiable character strings for each item are as follows:
Id (vendorId, optionId, etc.)
Any character string up to 32 characters in length containing lower-case alphanumeric characters, hyphens ("-"), underscores ("_") and periods (".") can be specified. The beginning character must be a lower-case alphanumeric character.
name, vendorName
Any character string containing 1 to 64 characters, excluding control characters such as line feeds, can be specified.
defaultPrice
Any number up to 9 digits and within 6 decimal points can be specified.
For prices which have yet to be specified (are awaiting discussion), specify "-1" or "-1.0000".
Note
Dependencies may occur for each of the following items. For details on these items, refer to the specifications of the relevant cloud vendor or cloud management software.
Category/Item | Parameter for Specifying Parameter Element | Required | Description |
|---|---|---|---|
instanceOptions/ | INSTANCE_TYPE | Yes | The type of a virtual machine to create. Any valid Amazon EC2 instance type can be specified. |
systemDiskImageOptions | IMAGE_ID | Yes | Specify the Amazon Machine Image (AMI) ID of the virtual machine to create. AMI IDs can be obtained from the AWS management console. Example: amzn-ami-minimal-pv-2013.09.0.x86_64-ebs |
OS_TYPE | Yes | Specify one of the following according to the OS type of the image specified for IMAGE_NAME: For Linux: "Linux" For Windows: "Windows" | |
BLOCK_DEVICE_NAMES | Yes | The device names of additional block devices. Specify as many device names as the number of devices that can be added in the EC2 instance, separating them using commas. Example: /dev/sdf,/dev/sdg,/dev/sdh | |
ADMIN_USER | Yes | Specify the user name of the OS administrator of the virtual machine. Specify the user name configured for the Amazon Machine Image (AMI). | |
dataDiskImageOptions/ | BLOCK_DEVICE_SIZE | Yes | Specify the size of additional block devices in GB. The same size is configured for all block devices added during the creation of the virtual machine. This does not apply to the root device. Example: 80 |
BLOCK_DEVICE_TYPE | Yes | Specify the device type of additional block devices (the volume name of AWS). The same type is configured for all block devices added during the creation of the virtual machine. When reconfiguring a virtual machine, only block devices of the same type as those already added can be specified. This does not apply to the root device. Example: gp2 | |
BLOCK_DEVICE_NUM | Yes | Specify the number of additional block devices. Specify the fixed character string "[dataDiskNum]" in the parameter value. The value specified from the Cloud Management Portal when creating or modifying a virtual machine is configured in the internal processes of Cloud Services Management. | |
deployParameters/ | SECURITY_GROUP_NAMES | Specify the names of already created security groups. Multiple security group names can be specified by separating them using commas. | |
SUBNET_ID | Specify the ID of a subnet where the EC2 instances are created. This parameter cannot be specified when AVAILABILITY_ZONE is specified. When omitted, Cloud Services Management operates as follows: When AVAILABILITY_ZONE is specified, the default subnet for AVAILABILITY_ZONE is configured. When AVAILABILITY_ZONE is not specified, the default subnet for the default VPC is configured. | ||
REGION | Yes | The region where the data center which hosts the EC2 instances is located. Any valid region for EC2 can be specified. | |
AVAILABILITY_ZONE | Specify an availability zone in which the instances are created. If omitted, the public IP address will be assigned according to the configuration of the subnet. This parameter cannot be defined if SUBNET_ID is defined. |
Category/Item | Parameter for Specifying Parameter Element | Required | Description |
|---|---|---|---|
instanceOptions/ | INSTANCE_TYPE | Yes | Specify the type of a virtual machine to create (the size of Azure). Example: Basic_A0 |
systemDiskImageOptions | IMAGE_NAME | Yes | Specify image name or disk name. Public image names of Azure can be obtained by executing Azure commands or APIs. Example: myimage.vhd |
OS_TYPE | Yes | Specify one of the following according to the OS type of the image specified for IMAGE_NAME: For Linux: "Linux" For Windows: "Windows" | |
ADMIN_USER | Yes | Specify the user name used for logging into the virtual machine to create. When the OS created using IMAGE_NAME is Linux, the fixed value "azureuser" is used regardless of what value is set here. | |
ADMIN_PASS | Yes | Specify the password of the user used for logging into the virtual machine to create. | |
dataDiskImageOptions/ | BLOCK_DEVICE_SIZE | Yes | Specify the size of additional block devices in GB. The same size is configured for all block devices added during the creation of the virtual machine. This does not apply to the root device. Example: 80 |
BLOCK_DEVICE_TYPE | Yes | Specify the device type of additional block devices (the disk cache policy for Azure). | |
BLOCK_DEVICE_NUM | Yes | Specify the number of additional block devices. Specify the fixed character string "[dataDiskNum]" in the parameter value. The value specified from the Cloud Management Portal when creating or modifying a virtual machine is configured in the internal processes of Cloud Services Management. | |
deployParameters/ | AFFINITY_GROUP | Yes | Specify the name of an existing affinity group that was created using the Azure management portal. Example: AF_GROUP1 |
SUBSCRIPTION_ID | Yes | Specify an Azure subscription ID. Example: 11111111-2222-3333-4444-555555555555 | |
STORAGE_ACCOUNT_NAME | Yes | Specify a storage account name used for volume management. Example: account100 | |
AVAILABILITY_SET | Specify an availability set name. | ||
VIRTUAL_NETWORK_NAME | Yes | Specify a virtual network name. Example: vnet2 | |
SUBNET_ID | Yes | Specify the ID of a subnet that has been created in the Azure management portal. Example: subnet2 |
Category/Item | Parameter for Specifying Parameter Element | Required | Description |
|---|---|---|---|
instanceOptions/ | COUNT_CPU | Specify the number of CPUs. When this parameter is not specified, the default value of VSERVER_TYPE is configured. | |
PROCESSORSPEED | Specify CPU performance in GHz. A value up to the first decimal place can be specified. When this parameter is not specified, the default value of VSERVER_TYPE is configured. The value specified must be equal to or greater than the value of the reserved CPU performance (CPUReserve) configured in VSERVER_TYPE. For details about the value of the reserved CPU performance (CPUReserve), refer to the manuals of ROR. | ||
MEMORYSIZE | Specify the memory size in GB. A value up to the first decimal place can be specified. When this parameter is not specified, the default value of VSERVER_TYPE is configured. The value specified must be equal to or greater than the value of the reserved memory capacity (MemoryReserve) configured in VSERVER_TYPE. For details about the value of the reserved memory capacity (CPUReserve), refer to the manuals of ROR. | ||
systemDiskImageOptions | SYSTEM_TEMPLATE_ID | Yes | Specify the ID of the L-Platform template. This template ID is used to create an L-Platform when there are no services in the platform. |
DISKIMG_ID | Yes | Specify the resource ID (disk) of the image information of the virtual machine added in the L-Platform. Depending on the server virtualization software integrated with ROR, virtual machine service operations may be limited. For details, refer to the manuals of ROR. | |
NETWORK_ID | Yes | Specify the network ID of the segment used by the virtual machine added in the L-Platform. | |
VSERVER_TYPE | Yes | Specify the character string indicating the server type of the virtual machine added in the L-Platform. This character string must indicate a server type supported by ROR. Example: sample_small | |
OS_TYPE | Yes | Specify one of the following according to the OS type of the image specified for DISKIMG_ID: For Linux: "Linux" For Windows: "Windows" | |
ADMIN_USER | Yes | Specify the user name of the OS administrator of the virtual machine. It is necessary to specify according to the image ID to be used. | |
dataDiskImageOptions/ | BLOCK_DEVICE_SIZE | Yes | Specify the size of additional block devices in GB. The same size is configured for all block devices added during the creation of the virtual machine. This does not apply to the root device. Example: 80 |
BLOCK_DEVICE_NUM | Yes | Specify the number of additional block devices. Specify the fixed character string "[dataDiskNum]" in the parameter value. The value specified from the Cloud Management Portal when creating or modifying a virtual machine is configured in the internal processes of Cloud Services Management. | |
deployParameters/ | VM_POOL | Yes | Specify a VM pool of ROR to use when creating the new virtual machine. |
STORAGE_POOL | Yes | Specify a storage pool of ROR to use when creating a new virtual machine. |
Category/Item | Parameter for Specifying Parameter Element | Required | Description |
|---|---|---|---|
instanceOptions/ | FLAVOR_ID | Yes | Specify the flavor ID indicating specifications of the virtual machine. Specify the flavor ID using K5 IaaS API. Example: 1101 |
systemDiskImageOptions | DISKIMG_ID | Yes | Specify the image ID used for creating a virtual machine. K5 public image IDs can be obtained from the K5 management console. |
OS_TYPE | Yes | Specify one of the following according to the OS type of the image specified for DISKIMG_ID: For Linux: "Linux" For Windows: "Windows" | |
VOL_SIZE | Yes | Specify the size of the root device of the virtual machine in GB. | |
ADMIN_USER | Yes | Specify the user name of the OS administrator of the virtual machine. The user name specified in this parameter is sent to platform providers by email when deployment of the virtual machine completes. It is necessary to specify according to the image ID to be used. | |
ADMIN_PASS | Yes *1 | Specify the initial OS administrator password for the virtual machine. The password specified in this parameter is sent to platform providers by email when deployment of the virtual machine completes. | |
DEDICATED_INSTANCE | Specify whether to deploy the virtual machine as a dedicated instance (dedicated virtual server). Specify "true" to deploy the virtual machine as a dedicated instance. Specify "false" to not deploy the virtual machine as a dedicated instance. The default value used when this parameter is omitted is "false". | ||
dataDiskImageOptions/ | BLOCK_DEVICE_SIZE | Yes | Specify the size of additional block devices in GB. The same size is configured for all block devices added during the creation of the virtual machine. This does not apply to the root device. Example: 80 |
BLOCK_DEVICE_TYPE | Yes | Specify the device type of additional block devices (the type of block storage for K5). The same type is configured for all block devices added during the creation of the virtual machine. When reconfiguring a virtual machine, only block devices of the same type as those already added can be specified. This does not apply to the root device. Example: F1 | |
BLOCK_DEVICE_NUM | Yes | Specify the number of additional block devices. Specify the fixed character string "[dataDiskNum]" in the parameter value. The value specified from the Cloud Management Portal when creating or modifying a virtual machine is configured in the internal processes of Cloud Services Management. | |
deployParameters/ | AVAILABILITY_ZONE | Specify an availability zone in which the instances are created. If not specified, the availability zone is configured on K5. Example: jp-east-1a | |
PROJECT_INFO | Yes | Specify the K5 project names, the network IDs created in the K5 project, and security group names, separating them using commas. Example: <K5 project name 1>,<Network ID 1>,<Security group name 1>, <K5 project name 2>,<Network ID 2>,<Security group name 2> | |
PROJECT_MAX_VM | Yes | Specify the maximum number of virtual machines available for use in a K5 project. This parameter is applied to all of the K5 projects specified in PROJECT_INFO. | |
DOMAIN | Specify the K5 domain to connect. If not specified, the K5 domain specified during setup is used as the connection destination. |
*1: Specify only when using Windows. When using Linux, this parameter is disabled even when specified.
Category/Item | Parameter for Specifying Parameter Element | Required | Description |
|---|---|---|---|
instanceOptions/ | NUMBER_OF_CPU | Yes | Specify the number of CPUs. |
AMOUNT_OF_RAM | Yes | Specify the memory size in GB. | |
systemDiskImageOptions | IMAGE_NAME | Yes | Specify the name of the VMware template to use for cloning a new instance. Example: centos6x64tpl |
DISK_SIZE | Yes | Specify the system disk size in GB. Only one virtual device is supported. If multiple virtual devices are specified, only the first device will be configured. | |
OS_TYPE | Yes | Specify one of the following according to the OS type of the image specified for IMAGE_NAME: For Linux: "Linux" For Windows: "Windows" | |
ADMIN_USER | Yes | Specify the user name of the OS administrator of the virtual machine. Specify the user name configured for the VMware template. | |
ADMIN_PASS | Yes | Specify the OS administrator password for the virtual machine. For Windows, the password specified in this parameter is configured. For Linux, specify the password for the OS specified in the template. | |
dataDiskImageOptions/ | BLOCK_DEVICE_SIZE | Yes | Specify the size of additional block devices in GB. The same size is configured for all block devices added during the creation of the virtual machine. This does not apply to the root device. Example: 40 |
BLOCK_DEVICE_NUM | Yes | Specify the number of additional block devices. Specify the fixed character string "[dataDiskNum]" in the parameter value. The value specified from the Cloud Management Portal when creating or modifying a virtual machine is configured in the internal processes of Cloud Services Management. | |
deployParameters/ | TARGET_DATACENTER | Yes | Specify the name of the data center. *The information of vCenter Server can be specified using the VMware setup command. |
TARGET_CLUSTER | Specify the cluster name. When TARGET_STORAGE is not specified, ensure that this parameter is configured. When TARGET_STORAGE is specified, the setting of this parameter is invalid. | ||
TARGET_HOST | Yes | Specify the name of the host where the virtual machine is created. When a cluster is specified, specify a host in the cluster. When a cluster is not specified, specify a host in the data center. | |
TARGET_STORAGE | Specify the datastore name. When a datastore name is not specified, the datastore defined for the host is automatically configured on the cloud. When TARGET_CLUSTER is not specified, ensure that this parameter is configured. | ||
TARGET_FOLDER | Specify the name of the folder in which the virtual machine is created. When not specified, the virtual machine is placed in the same folder as the template. Only a single level inside a folder can be specified. |
Available Option | Value of option_id Attribute |
|---|---|
Whether to use SLB | "slb" |
Whether to use RDB | "rdb" |
Whether to use snapshot | "snapshot" |
There are no other available configuration options.
There are no other available configuration options.
There are no other available configuration options.
Available Option | Value of option_id Attribute |
|---|---|
Whether to use snapshot | "snapshot" |
See
For example specifications of each parameter, refer to the sample files of cloud vendor definitions.
