Available Functions¶
List of Available Functions¶
Create Baremetal Server¶
Functions |
Description |
||
---|---|---|---|
Server Details |
Server Name |
You can set the name of the bare metal server and the OS host name of the official image template. |
|
Flavor |
You can select bare metal server from multiple specification flavor (bare metal server menu provided). |
||
Image Name |
Official image template |
You can select OS image template default by this menu and preinstall it on bare metal server. |
|
Zone/Group |
You can set the group / random (Any Zone) of the group to which the bare metal server belongs. |
||
Access and Security |
Key Pair Name |
Select Key Pair |
You can create / register the SSH key pair to access the bare metal server and select it as the SSH key pair of the bare metal server to be created.
One SSH key pair can be used as SSH key pair of multiple bare metal servers.
|
Import key pair(s) |
You can import SSH public keys. |
||
Administrator Password |
You can set the administrator password of the official image template. |
||
Network |
Select Logical Network |
You can set up a pre-created logical network as a bare metal server.
You can set at least one logical network (data plane) and up to 4 logical networks (data plane: 2 / storage plane: 2).
|
|
Set IP Address |
You can set the static IP address to the physical NIC port of the bare metal server / the port of the logical network. |
||
Disk |
Set Disk Partitioning |
Customers can configure disk partitioning in two ways as follows:
1) Automatic
Partition is automatically set as default value of this menu.
2) Manual
Customers can set detailed information such as LVM, Size, File type and Label.
*Customers are required to set the disk partitioning configuration in JSON format.
Please refer to API reference for detail.
|
|
RAID level |
RAID Level setting is set by default value in this menu.
the RAID Level will be provided in RAID1.
|
||
Post-install script | After providing the bare metal server, you can set up an executable script automatically. |
||
Meta Data |
You can set metadata of bare metal server when bare metal server is provided. |
||
Personality |
Customers can inject configuration files into Baremetal Server’s filesystem or edit them via command line with appropriate file path. |
Delete Baremetal Server¶
Functions |
Description |
---|---|
Delete Server |
You can select and delete the bare metal server. |
Erase Data on Hard Disk |
After deleting the server, customer data on the hard disk are automatically deleted. |
Manage Baremetal Server¶
Functions |
Description |
||
---|---|---|---|
Power Action |
As for the power operations of Baremetal Servers, Customers can boot, stop or reboot a server.
Following two methods are available for operation:
1)Operation via control panel on Customer Portal or API.
2)Operation via console (IPMI · iRMC)
|
||
Start Server |
Activates the Server by turning it ON to start |
||
Shutdown Server |
There are 2 modes to stop the server.
1)Soft shutdown: Stops via ACPI.
2)Hard shutdown: Power Off is executed automatically.
|
||
Restart (Reboot) Server |
There are 2 modes to reboot the server.
1)Soft Reboot Server :Reboot is executed through ACPI
2)Hard Reboot Server:This action induces Power OFF & Power ON function consecutively
|
||
Change boot mode |
Change the boot mode and start the server.
If the server is running, stop the server, change the boot mode, and start it.
5 boot modes can be selected.
· No boot mode
・ Disk boot
・ PXE boot
・ ISO boot
・ Legacy boot
|
||
Change Meta Data of Server |
Customers can change (Add/Edit/Delete) the information of meta data they have configured when creating Baremetal Server. |
||
Server Details |
Image Name |
Private ISO Image |
You can mount the private ISO image uploaded to the image storage area on the bare metal server. The mounting method is as follows.
1)You can mount a private ISO image using media connection via customer portal / API.
2)After SSL-VPN connection to NTT Com network via remote console, Customers can use remote management function of each server to mount the ISO image remotely.
|
Media connection |
You can connect to the media to mount the private ISO image stored in the image storage area on the bare metal server. |
||
Disconnecting media |
You can disconnect the connected media. |
||
Remote Console Access (RCA) |
SSL VPN | Customers can connect to IPMI · iRMC via Internet VPN (SSL).
Maximum 30 IDs are provided per tenant. By adding IDs from the portal, maximum 30 IDs can be added.
|
|
Console Access |
Customers can operate their Baremetal Server via KVM (i.e. keyboard, video & mouse) console access.
Customers can get information of URL, username, and password for console access via Customer Portal / API.
|
||
IPMI | You can check the event log / hardware status of the bare metal server using IPMI (Intelligent Platform Management Interface) or iRMC (Remote Management Controller). |
||
UEFI | You can change the UEFI (BIOS) setting of the server via the customer portal / API. |
||
Server Details |
Overview |
Information |
You can check the server name / ID / tenant ID / acceptance time / elapsed time after acceptance / status. |
Specifications |
You can check the flavor / flavor ID / CPU / memory specifications. |
||
Physical NIC Port |
You can check the information on the logical network connected to the 4 physical NIC ports of the bare metal server and each network NIC port. |
||
OS Settings |
You can check information such as disk partitioning, RAID and metadata. |
||
UEFI | You can check the setting status of the UEFI that changed the setting. |
||
Physical NIC Port |
Add Port |
You can add a logical network port to the physical NIC port of the bare metal server.
By this function, Customers can further add multiple Logical Networks.
Port name / port description / port tag / logical network / IP address / segment type (FLAT / VLAN) / segment ID can be set.
|
|
Edit Port’s Settings |
You can change the port name / port description of the logical network port / tag of the port / setting of the logical network to which it belongs. You can also add a static IP address / MAC address. |
||
Delete Port |
You can delete the port of the logical network from the physical NIC port of the bare metal server. |
||
API | API based on OpenStack Nova is provided.
(Please refer to API References for details.)
|
Descriptions of Respective Functions¶
Create Baremetal Server¶
Server Details¶
Server Name
Items |
Mode |
Rules |
||
---|---|---|---|---|
All |
Customer Portal / API |
can use only these characters a-z A-Z 0-9 + _ . -
*The first and last letters can not use “hyphen (‘-‘)”.
|
||
Entry Rules for Template |
Official image template |
RHEL/CentOS/Ubuntu | Customer Portal / API |
Length of characters: 1-63 (byte) |
Windows | Customer Portal / API |
Length of characters: 1-15 (byte) |
||
vSphere | Customer Portal / API |
Length of characters: 1-63 (byte) |
||
Private ISO Image |
Length of characters: 1-255 (byte)
*Customers need to be aware of the restrictions of their ISO Image.
|
Server ID
Items |
Mode |
Rules |
||
---|---|---|---|---|
All |
Customer Portal / API |
Available characters: a-z A-Z 0-9 Character “-” cannot be used at the beginning and the ending of a sentence. |
||
Entry Rules for Template |
Official image template |
RHEL/CentOS/Ubuntu | Customer Portal / API |
Length of characters: 1-255 (byte) |
Windows | Customer Portal / API |
Length of characters: 1-15 (byte) |
Flavor
“”<Physical Configurations of Baremetal Server>”“
Item Name |
Details |
---|---|
CPU | Differs depending upon Flavor |
Memory |
Differs depending upon Flavor |
Internal Disk |
Differs depending upon Flavor |
RAID Controller | RAID1 |
Power Source |
Dual power supplies with Active / Active |
NIC | 10G Port* 4 (DualPort 10G Network Card * 2) |
Images
Official Template
OS Settings
Zone / Group
Access and Security¶
SSH Key Pairs
Select Key Pair
Import Key Pair
Administrator Password
Network¶
Configuring network setting when provisioning Baremetal Server
<List of Logical Network Settings When Creating Baremetal Server>
Items to set |
Description |
Mandatory |
Optional |
|
---|---|---|---|---|
Static IP Address |
Customers can set static IP Address to the Logical Network Port in the range of Logical Network Subnet. |
N/A | Y |
|
No IP Address Selected |
DHCP enable / disable |
Static IP Address is set to Logical Network Port in the range of Logical Network Subnet. |
N/A | Y |
*Static route settings of Logical Network Port will not be validated. Customers are required to manually configure static route in respective OS Network configuration.
- *As for the DNS / NTP settings of Logical Network, the DNS/NTP, configuration of the 1st Logical Network of Data Plane added to Baremetal server will be reflected to the OS.Other DNS / NTP settings of Logical Network will not be reflected. When Customers need to set multiple DNS / NTP settings, they need to set manually in the OS.
<Values of Logical Network Setting When Provisioning Baremetal Server>
Logical Network ID |
Plane |
Port ID |
Port
Segment type [1]
|
Port
Segment ID [1]
|
Port
Subnet
|
Port
Port IP Address
|
Physical
Switch #
|
Physical
Physical Network Port ID
|
Physical
Physical NIC Port ID
|
Physical
NIC Port #
|
Physical
NIC Port
MAC Address
|
Network Card |
---|---|---|---|---|---|---|---|---|---|---|---|---|
Automatically assigned |
Data Plane |
Automatically assigned |
FLAT/VLAN | 0/3 | Customers |
Fixed |
#1 | Automatically assigned |
Automatically assigned |
1 | Higher Numbers |
1 |
Automatically assigned |
Storage Plane |
Automatically assigned |
FLAT/VLAN | 0/3 | Customers |
Fixed |
#2 | Automatically assigned |
Automatically assigned |
2 | Lower Numbers |
1 |
Automatically assigned |
Storage Plane |
Automatically assigned |
FLAT/VLAN | 0/3 | Customers |
Fixed |
#3 | Automatically assigned |
Automatically assigned |
3 | Lower Numbers |
2 |
Automatically assigned |
Data Plane |
Automatically assigned |
FLAT/VLAN | 0/3 | Customers |
Fixed |
#4 | Automatically assigned |
Automatically assigned |
4 | Higher Numbers |
2 |
In the case of Server flavor General Purpose 1 / General Purpose 2 / General Purpose 3 / Workload Optimized 1
Server flavor Workload Optimized 2 case
Physical NIC Port ID |
Physical NIC Port # |
MAC Address at Port |
Network Card |
Windows Server |
---|---|---|---|---|
Automatically assigned |
1 | Lower Numbers |
1 | Network 1 |
Automatically assigned |
2 | Higher Numbers |
1 | Network 0 |
Automatically assigned |
3 | Lower Numbers |
2 | Network 2 |
Automatically assigned |
4 | Higher Numbers |
2 | Network 3 |
Hard Disk Settings¶
RAID Level
- General Purpose1 / General Purpose 2 / General Purpose 3 / Workload Optimized 1It will be provided set as RAID1.
- Workload Optimized 2Only two disks are set by default value (RAID 1) of this menu. The setting will not be made to remaining 34 disks.For the implementation of RAID Level set by the customer, please refer to the tutorial “RAID setting method of Workload Optimized 2”.
Disk Partitioning”
- Automatic settingDisk partitioning setup is defined by default as part of Baremetal Server menu is made. The partitioning configuration for each OS is as follows:
Official image template
- RHEL/CentOS/UbuntuPrimary Storage Area will be set as ‘/’.GPT area, UEFI partition and boot partition are the other partition areas created other than primary storage.Following are the file systems of each OS:RHEL/CentOS : xfsUbuntu : ext4LVM will not be configured.
Disk Partitioning (RHEL/CentOS/Ubuntu)
Area Name |
GPT Area |
/boot/efi | /boot | / |
---|---|---|---|---|
File system | N/A | fat32 [2] | ext4 | xfs for RHEL / CentOS, and ext4 for Ubuntu |
Data volume | <1MB | 512MB | 512MB | <Remaining Area > |
- WindowsPrimary storage area will be set as “C:”.File system is NTFS.In the head of the primary storage, create partitions of Windows RE Tools, ESP and MSR.(For the above, please refer to the following URL: https://msdn.microsoft.com/en-us/library/hh824839.aspx)16GB of Pagefile is created in “C:”.
** Disk Partitioning (Windows)**
Area Name |
Windows RE | ESP | MSR | Windows (C:) |
---|---|---|---|---|
File system | Tools | N/A | N/A | NTFS / pagefile.sys |
Data volume | 300MB-1GB | 500MB | 128MB | <Remaining Area > / 16GB |
- VMware ESXi for BYOLPartitioning setup is based on the specification defined by VMware.Partitions and file system are created on the primary storage.
- Manual PartitioningCustomers can set detailed information such as LVM, Size, File type and Label.It is necessary to fill in the configuration parameters in JSON format (see Enterprise Cloud 2.0 Baremetal Server API Reference for details).Following disk partitioning for each OS can be set:
- RHEL / CentOS / UbuntuLVM settings are supported.Custmers can choose Partitioning type, Label, LVM group, Partitioning size, Filesystem type, Mount point and so on.Almost all file formats (incl. ext2, ext4, swap) can be supported.
- WindowsCustomers can specify the partitioning size of each disk. (Customers cannot change the drive letters. They will be assigned automatically.)Remaining capacity of each disk will be remained as “Unused”.Only NTFS format is available.Set the disk size of Windows (C:) to 100GB or more (including pagefile.sys (16GB)).
- VMware ESXi for BYOLCustomers cannot configure disk partitioning, as it is configured based on the specification of software vendor.
- Official image template
Official image template |
Enable Manual setting |
Detail of Manual LVM Settings |
---|---|---|
RHEL/CentOS | Enabled |
vg_label and lv_label can use only these characters a-z A-Z 0-9 + _ . -
1-64 characters length
fs_type : xfs, ext4, ext3, ext2, vfat, swap
mount_point allows /, /var, /usr, /home
|
Ubuntu | Enabled |
vg_label and lv_label can use only these characters a-z A-Z 0-9 + _ . -
1-64 characters length
fs_type : xfs, ext4, ext3, ext2, jfs, fat16, fat32, swap
mount_point allows /, /home, /tmp, /usr, /var, /srv, /opt, /usr/local
|
SWAP Capacity
Official image template |
Customers designating SWAP System Type(s) |
Details |
Size (GB) |
---|---|---|---|
RHEL/CentOS/Ubuntu | Customers need to specify the system type. |
SWAP area is created with the size and mount point designated by Customers. |
N/A |
Customers do not need to specify the system type. |
SWAP area is created with the default settings of this menu automatically. |
16 | |
Windows | Customers do not need to specify the system type. |
SWAP area is created with the default settings of this menu automatically. |
16 |
Post-Install Action¶
User Data/ Post-install Script
Item Name |
Methods |
Numbers |
Unit |
---|---|---|---|
Maximum Number of Script |
Customer Portal / API |
1 | Script |
Script Size |
Customer Portal |
16 | KB |
API | 64 | KB | |
Encoding Method |
Customer Portal / API |
base64 | N/A |
Official image template |
Execution File |
Execution Format |
---|---|---|
RHEL/CentOS/Ubuntu | cloud-init | https://help.ubuntu.com/community/CloudInit |
Windows | cloudbase-init | https://github.com/stackforge/cloudbase-init |
VMware ESXi for BYOL | N/A | N/A |
Personality Parameter
Item Name |
Methods |
Numbers |
Unit |
---|---|---|---|
Maximum Number of File |
Customer Portal / API |
10 | File |
Length of File Paths |
Customer Portal / API |
255 | Byte |
Script Size |
Customer Portal / API |
10 | KB |
Encoding Method |
Customer Portal / API |
Base64 | N/A |
※ If the OS is RHEL / CentOS, files can not be placed under / tmp
Meta Data
Item Name |
Methods |
Numbers |
Unit |
---|---|---|---|
Maximum Number of Configurable Key/Value Pair |
Customer Portal / API |
128 | Pairs |
Maximum Letter Size of Configurable Key and Configurable Value Respectively |
Customer Portal / API |
255 | byte |
Delete Baremetal Server¶
Select Baremetal Server to Delete¶
It is possible to delete and delete the bare metal server to be deleted from the customer portal / API.
Erase Data on Hard Disk¶
Manage Baremetal Server¶
Power Action¶
Item Name |
Details |
---|---|
Start Server |
Activates the Server by turning it ON to start
|
Shutdown Server |
There are 2 modes to stop the server.
1)Soft shutdown: Stops via ACPI.
2)Hard shutdown: Power Off is executed automatically
|
Reboot Server |
There are 2 modes to reboot the server.
1)Soft Reboot Server :Reboot is executed through ACPI
2)Hard Reboot Server :This action induces Power OFF & Power ON function consecutively
|
Change boot mode¶
Item Name |
Details |
---|---|
Change boot mode |
Change the boot mode and start the server.
If the server is running, stop the server, change the boot mode, and start it.
5 boot modes can be selected.
· No boot mode
-Disk boot [3]
-PXE boot [3]
-ISO boot [3]
-Legacy boot [4]
|
Media connection¶
Remote Console Access¶
SSL VPN
Item Name |
Details |
---|---|
Change User Password |
You can change your password.
The entry rule of the password is 8–127 characters length, with upper and lower cases / numbers / special characters ( . - _ @ / * + , ! # $ % & ( ) ~ |) as usable characters.
|
Delete User |
Customer can delete the users. |
User List |
You can check the ID list of the same tenant. |
Console Access
IPMI・iRMC
Edit UEFI (BIOS) Configuration
- General Purpose 1 v1/General Purpose 2 v1/General Purpose 3 v1/Workload Optimized 1 v1
- General Purpose 1 v2/General Purpose 2 v2/General Purpose 3 v2/Workload Optimized 1 v2
- General Purpose 2 v3/General Purpose 3 v3
- Workload Optimized 2The UEFI settings can not be changed.UEFI setting status can not be confirmed by the Customer Portal.For the setting status list please refer to the following.
Server Details
Item Name |
Details |
---|---|
Name |
Displays the server name set by Customers. |
Image Name |
Displays the name of Official Image Template or private ISO image. |
Zone/Group |
Display zone / group to which bare metal server belongs |
Time since provisioning |
Displays the elapsed time since the order for creating Baremetal Server is accepted. |
Flavor |
Display Flavor Name Value (If the pointer is overlaid, information such as Flavor ID / CPU / Memory will be displayed.) |
Status |
Displays the current status values of Baremetal Server. Values can be ACTIVE, BUILD, REBUILD, RESIZE, VERIFY_RESIZE, ERROR, DELETED. |
Power Status |
Displays the value of power state for Baremetal Server. Values can be RUNNING, SHUTDOWN, CRASHED. |
Task |
Displays the task values. the current state of progress of the tasks on the server. Values can be None, BUILDING, DELETING, STOPPING, STARTING, REBOOTING, REBUILDING, RESIZING, RESIZE_REVERTING, RESIZE_CONFIRMING. |
Action |
Delete Baremetal Server, or available operations when Customers manage Baremetal Server. Values can be Start server, Shutdown server, Edit server information, Console information,Reboot, Delete server |
Item Name |
Details |
---|---|
Server Name |
Displays the server name set by Customers. |
ID | Displays the Baremetal Server ID configured by NTT Com. |
Tenant ID |
Displays the Tenant ID where Baremetal Server is created within. |
Zone/Group |
Display zone / group to which bare metal server belongs |
Creation time |
Display time when bare metal server was created |
Time since provisioning |
Displays the elapsed time since the order for creating Baremetal Server is accepted. |
Status |
Displays the current status values of Baremetal Server. Values can be ACTIVE, BUILD, REBUILD, RESIZE, VERIFY_RESIZE, ERROR, DELETED. |
Item Name |
Details |
---|---|
Flavor |
Displays the name of their Flavor. |
Flavor ID |
Displays the Flavor ID associated with Flavor. |
CPU | Displays the number of CPU processor in Baremetal Server. |
Memory |
Displays the Baremetal Server memory size. |
Item Name |
Details |
---|---|
Image Name |
Displays the value of the Official Image Template Name. |
Item Name |
Details |
---|---|
Meta Data |
Displays the value of meta data key and value formats. |
Item Name |
Details |
---|---|
Primary Storage |
Displays the value of True/False on the PrimaryStorage attribute of RaidArrays. |
RAID Card Hardware ID |
Displays the value of raid_card_hardware_id of RaidArrays. |
Disk Hardware ID |
Displays the value of disk_hardware_ids of RaidArrays. |
Partitioning Label |
Displays the value of partition_label attributes in partitioning arrays element. |
LVM | Displays the value of True/False on the LVM Attributes in partitioning arrays element. |
Size |
Displays the value of size attributes in partitioning arrays element. |
Overview - LVM volume group
Item Name |
Details |
---|---|
VG Label |
Displays the value of vg_label attributes on the LVM Volume Groups element. |
PV Partitioning Label |
Displays the value of physical_volume_partition_labels on the LVM Volume Groups element in one line. |
LV label |
Displays the value of lv_label attributes in logical_volumes arrays elements. |
Size |
Displays the value of size attributes in logical_volumes arrays elements. |
Item Name |
Details |
---|---|
Mount Point |
Displays the value of mount_point attributes in FileSystem element. |
Label |
Displays the value of label attributes in FileSystem element. |
Filesystem Types |
Displays the value of file_system_type attributes in FileSystem element. |
Item Name |
Details |
---|---|
media |
Display the name of the media connected to the bare metal server |
Item Name |
Details |
---|---|
Physical NIC Port ID |
Displays the value of physical NIC port ID of Baremetal Server. (NTT Com sets this by default) |
Physical NIC Port MAC Address |
Displays the value of MAC Address for Baremetal Server’s Physical NIC Port. |
Physical Network Port ID |
Displays the value of physical network port ID in Logical Network, which is the counterpart of Baremetal Server’s physical NIC port. |
Network Plane |
Displays the value of the Plane type (Data Plane / Storage Plane) of Logical Network. |
Connectivity Port Network ID |
Displays the value of Logical Network ID connected to Baremetal Server’s physical NIC port. |
Connectivity Port PortID |
Displays the value of Logical Network ID connected to Baremetal Server’s physical NIC port. |
Connectivity Port Subnet ID |
Displays the value of Logical Network Subnet ID connected to Baremetal Server’s physical NIC port. |
Connectivity Port IP Address |
Displays the value of IP Address in Logical Network connected to Baremetal Server’s physical NIC port. |
Item Name |
Details |
---|---|
Flavor |
Displays the name of their Flavor. |
Status |
Show reflection status of UEFI setting |
message |
When an error occurs in the UEFI setting, a message is displayed |
Update date and time |
Display the date and time the UEFI setting was last updated |
Key |
Display changed setting items by UEFI setting |
Types |
Display type of setting value |
Values |
Display the changed setting value by UEFI setting |
Default |
Display default setting value |
Physical NIC Port
Logical Network Setting in Baremetal Server Management (after Server creation is completed)
Add Logical Network Port
Item Name |
Details |
Mandatory |
Optional |
|
---|---|---|---|---|
Port Name |
This is the name of Logical Network Port set by Customers. |
N/A | Y |
|
Port Description |
This is the description for Logical Network Port. |
N/A | Y |
|
Port Tag |
This is the tag for the Port set by Customers. They can use this tag when they would like to search or set conditions via Customer Portal / API. |
N/A | Y |
|
Select Logical Network |
Customers can select Logical Network that associated with Logical Network Port. |
Y |
N/A | |
DHCP Enabled |
When Logical Network DHCP is enabled, IP address will be assigned automatically from the IP address range of Subnet. |
N/A | N/A | |
DHCP Disabled |
When Logical Network DHCP is disabled, the smallest IP address that is not used in the Subment will be assinged automatically. |
Y |
N/A | |
Segmentation Types |
After Customers create Baremetal Server, they can assign segmentation type from following two types, and can perform this operation in the screen for adding Logical Network Port. |
Y |
N/A | |
flat | This connects Logical Network Port and Baremetal Server with untagged vLAN. |
ー |
Y |
|
VLAN | This connects Logical Network Port and Baremetal Server with tagged vLAN. |
N/A | Y |
|
Segmentation ID |
If Customers select VLAN as the segment type, the segment ID becomes VLAN ID and Customers can let other ports which are set the same segment ID, belong to the same VLAN. The values of “0”, “1”, “2”, or “4094” cannot be set as segment ID. When using a bare metal server as a dedicated hypervisor menu as vSphere ESXi, the values of “0”, “1”, “2”, “3”, or “4094” cannot be set as segment ID. |
ー |
Y |
|
IP address is automatically assigned |
IP address is automatically assigned when the port is created. If not checked, a port with no address specified will be created. |
ー |
Y |
Item Name |
Details |
Mandatory |
Optional |
---|---|---|---|
Port Name |
This is the name of Logical Network Port set by Customers. |
N/A | Y |
Port Description |
This is the description for Logical Network Port. |
N/A | Y |
Port Tag |
This is the tag for the Port set by Customers. They can use this tag when they would like to search or set conditions via Customer Portal / API. |
N/A | Y |
Item Name |
Details |
Mandatory |
Optional |
---|---|---|---|
Port ID |
Select which Port to delete. |
Y |
N/A |