Among the commands for cloud vendor operations, the following command uses XML:
fscsm_vendorcheck (Checking of cloud vendor definition files)
The format of the XML file corresponding to this command is explained below.
The elements of the XML must be specified using the following hierarchical structure:
<?xml version="1.0" encoding="UTF-8"?>
<vendor vendorId="Vendor ID" type="Vendor Type">
<vendorName>Vendor Name</vendorName>
<!-- Basic Menu -->
<basicMenus>
<basicMenu menuId="Basic Menu ID">
<name>Basic Menu Name</name>
</basicMenu>
</basicMenus>
<!-- instanceOptions -->
<instanceOptions>
<serviceOption optionId="Option ID">
<name>Display Name</name>
<parameters>
<parameter key="Key">Parameter Information</parameter>
</parameters>
<defaultPrice>Unit Price</defaultPrice>
</serviceOption>
</instanceOptions>
<!-- systemDiskImageOptions -->
<systemDiskImageOptions>
<serviceOption optionId="Option ID">
<name>Display Name</name>
<parameters>
<parameter key="Key">Parameter Information</parameter>
</parameters>
<defaultPrice>Unit Price</defaultPrice>
<diskSize>Disk Size</diskSize>
</serviceOption>
</systemDiskImageOptions>
<!-- dataDiskImageOptions -->
<dataDiskImageOptions>
<serviceOption optionId="Option ID">
<name>Display Name</name>
<parameters>
<parameter key="Key">Parameter Information</parameter>
</parameters>
<defaultPrice>Unit Price</defaultPrice>
<diskSize>Disk Size</diskSize>
</serviceOption>
</dataDiskImageOptions>
<!-- othersOptions -->
<othersOptions>
<serviceOption optionId="Option ID">
<name>Display Name</name>
</serviceOption>
</othersOptions>
<!-- deployParameters -->
<deployParameters>
<deployParameter id="Unique Parameter ID">
<name>Display Name</name>
<parameters>
<parameter key="Key">Parameter Information</parameter>
</parameters>
</deployParameter>
</deployParameters>
</vendor> |
Element (Element Name or Element Name and Attribute) | Required or Displayed | Output details | |||
|---|---|---|---|---|---|
When Checking | |||||
Vendor ID | Yes | The vendor ID must not overlap with the IDs of other vendor information. Specify a unique value. Specify a character string beginning with a lower-case alphanumeric character and containing 1 to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods ("."). | |||
Vendor Type | Yes | Specify a cloud vendor type. Specify one of the following: | |||
Value | Description | ||||
aws | AWS | ||||
azure | Azure | ||||
ror | ROR | ||||
k5 | K5 | ||||
vmware | VMware | ||||
physical | Physical Servers | ||||
Vendor Name | Yes | Specify a character string containing 1 to 64 characters. | |||
Basic Menu | Basic Menu ID | No *1 | Specify a character string beginning with a lower-case alphanumeric character and containing 1 to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods ("."). The basic menu ID must not overlap with the basic menu IDs of other basic menus. Specify a unique value. | ||
Display Name | The name of the basic menu displayed when creating a menu using the Cloud Management Portal. Specify a character string containing 1 to 64 characters, excluding control characters. | ||||
Configuration Option | Option ID | No *2 | The option ID must not overlap with the option IDs of other configuration options (virtual machine information). Specify a unique value. Specify a character string beginning with a lower-case alphanumeric character and containing 1 to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods ("."). | ||
Display Name | The display name of the configuration options for virtual machines. Specify a character string containing 1 to 64 characters. | ||||
Parameter Information | The parameter used as a configuration option by Cloud Services Management itself, cloud services, and cloud management software when this option is selected during the addition of services. Specify an appropriate parameter key for the vendor type. For specifiable values, refer to "Optional parameter values". | ||||
Unit Price | The unit price displayed as the default value when this option is selected when adding a menu using the Cloud Management Portal. Specify zero or an integer up to nine digits in length and a decimal up to six digits in length. For a currency which has a subunit, the subunit part is configured as an integer. Example When the currency is USD (subunit 2)
| ||||
Configuration Option | Option ID | No *3 | The option ID must not overlap with the option IDs of other configuration options (system disk information). Specify a unique value. Specify a character string beginning with a lower-case alphanumeric character and containing 1 to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods ("."). | ||
Display Name | The display name of the configuration options (system disk) for virtual machines. Specify a character string containing 1 to 64 characters, excluding control characters. | ||||
Parameter Information | The parameter used as a configuration option by Cloud Services Management itself, cloud services, and cloud management software when this option is selected during the addition of services. Specify an appropriate parameter key for the vendor type. For specifiable values, refer to "Optional parameter values". | ||||
Unit Price | The unit price displayed as the default value when this option is selected when adding a menu using the Cloud Management Portal. Specify zero or an integer up to nine digits in length and a decimal up to six digits in length. For a currency which has a subunit, the subunit part is configured as an integer. Example When the currency is USD (subunit 2)
| ||||
Disk Size | 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. | ||||
Configuration Option | Option ID | No *4 | The option ID must not overlap with the option IDs of other configuration options (additional data disk information). Specify a unique value. Specify a character string beginning with a lower-case alphanumeric character and containing 1 to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods ("."). | ||
Display Name | The display name of the configuration options (additional data disk) for virtual machines. Specify a character string containing 1 to 64 characters, excluding control characters. | ||||
Parameter Information | The parameter used as a configuration option by Cloud Services Management itself, cloud services, and cloud management software when this option is selected during the addition of services. Specify an appropriate parameter key for the vendor type. For specifiable values, refer to "Optional parameter values". | ||||
Unit Price | The unit price displayed as the default value when this option is selected when adding a menu using the Cloud Management Portal. Specify zero or an integer up to nine digits in length and a decimal up to six digits in length. For a currency which has a subunit, the subunit part is configured as an integer. Example When the currency is USD (subunit 2)
| ||||
Disk Size | 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. | ||||
Configuration Option | Option ID | No *5 | This element can be specified only when vendor type is aws or k5. For k5, only "snapshot" can be specified. Specify one of the following: | ||
Value | Description | ||||
slb | When using SLB | ||||
rdb | When using RDB | ||||
snapshot | When using snapshots | ||||
Display Name | The display name of the configuration options (other) for virtual machines. Specify a character string containing 1 to 64 characters, excluding control characters. | ||||
Unique Parameter Information | Unique Parameter ID | No *6 | The unique parameter ID must not overlap with the IDs of other unique parameter information. Specify a unique value. Specify a character string beginning with a lower-case alphanumeric character and containing 1 to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods ("."). | ||
Display Name | The display name for the individual management of specific parameter information to be passed to cloud service and cloud management software. Specify a character string containing 1 to 64 characters, excluding control characters. | ||||
Parameter Information | The parameter used by Cloud Services Management itself, cloud services, and cloud management software when performing deployment when this option is selected during the addition of services. Specify an appropriate parameter key for the vendor type. For specifiable values, refer to "Optional parameter values". | ||||
The meanings of the entries listed under "Required or Displayed" are as follows:
Yes: Entry is required, or element is output.
No: Can be omitted.
-: Specification is not possible, or the element is not output.
*1: The basicMenu element in the basicMenus element can be omitted. When the basicMenu element is specified, menuID and name must be specified.
*2: The serviceOption element in the instanceOptions element can be omitted. When the serviceOption element is specified, optionId, name, parameter, and defaultPrice must be specified.
*3: The serviceOption element in the systemDiskImageOptions element can be omitted. When the serviceOption element is specified, optionId, name, parameter, defaultPrice, and diskSize must be specified.
*4: The serviceOption element in the dataDiskImageOptions element can be omitted. When the serviceOption element is specified, optionId, name, parameter, defaultPrice, and diskSize must be specified.
*5: The serviceOption element in the othersOptions element can be omitted. When the serviceOption element is specified, optionId and name must be specified.
*6: The deployParameter element in the deployParameters element can be omitted. When the deployParameter element is specified, id and name must be specified.
Configuration options mentioned in *1 through *6 and unique parameter information cannot be specified when vendor type is "physical".
