Name
[Windows]
Installation_folder\Manager\bin\rcxadm lserver - L-Server operations
[Linux]
/opt/FJSVrcvmr/bin/rcxadm lserver - L-Server operations
Format
rcxadm lserver create -file file.xml [-nowait] rcxadm lserver delete -name name [-allow deldisk] [-nowait] rcxadm lserver modify -name name -file file.xml [-nowait] rcxadm lserver list rcxadm lserver show -name name [-format {text|xml}] rcxadm lserver start -name name [-nowait] rcxadm lserver stop -name name [-force] [-nowait] rcxadm lserver restart -name name [-force] [-nowait] rcxadm lserver move -name name [-to folder] [-nowait] rcxadm lserver attach -name name {-size size [-disk disk] [-from {pool|vstorage}]|-disk disk} [-exist] [-index index] [-nowait]
rcxadm lserver attach -name name -net network_name [-ip ipaddress] [-nowait] rcxadm lserver detach -name name -disk disk [-online] [-system] [-force] [-allow deldisk] [-nowait]
rcxadm lserver detach -name name [-nic nic_index] [-nowait] rcxadm lserver migrate -name name [-to vmhost] [-mode {live|cold}] [-nowait] rcxadm lserver setup -name name -type network [-dryrun] rcxadm lserver set -name name -attr attr[,attr[...]] [-net network_name] rcxadm lserver convert [-name name] -with with [-label label] [-comment comment] [-to folder] [-nowait] rcxadm lserver revert -name name [-nowait]
Description
rcxadm lserver is the command used to perform L-Server management and operations.
Subcommands
Creates an L-Server.
Deletes an L-Server. The resources allocated to the L-Server are automatically released, and the L-Server definition is also deleted.
Modifies the resources comprising an L-Server.
Displays a list of L-Servers.
The following detailed information is displayed:
For Physical L-Servers
Item Name | Description |
|---|---|
NAME | L-Server name |
TYPE | Server type |
SPEC (*1) | CPU performance, number of CPUs, and memory size |
DISKS | Disk size |
IPADDRESSES | IP address |
STATUS | L-Server operation status |
RESOURCES | Resource allocation status |
*1: Not displayed when using rack mount servers on which agents have not been registered.
For Virtual L-Servers
Item Name | Description |
|---|---|
NAME | L-Server name |
TYPE | Server type |
SPEC | CPU performance, number of CPUs, and memory size |
DISKS | Disk size When there are multiple disks, they are displayed separated by commas. |
IPADDRESSES | IP address When there are multiple IP addresses, they are displayed separated by commas. |
STATUS | L-Server operation status |
RESOURCES | Resource allocation status |
Displays the detailed information for an L-Server.
The following detailed information is displayed:
For Physical L-Servers
Item Name | Description |
|---|---|
Name | L-Server name |
Label | Label |
Comment | Comment |
ServerType | Server type |
OSType | Type of OS |
CPUArch | CPU architecture |
CPUPerf(SPEC) (*1) | CPU performance specified (the performance of the CPU allocated to the physical server) |
NumOfCPU(SPEC) (1) | Number of CPUs specified (the number of CPUs (Cores) allocated to the physical server) |
MemorySize(SPEC) (*1) | Memory size specified (the amount of memory allocated to the physical server) |
Model | Model name of the server to allocate to L-Server This is displayed when an L-Server status is one of the following:
|
PhysicalServer | Physical server name This is displayed when an L-Server status is one of the following:
|
OriginalServer | The physical server or resource pool to allocate to L-Servers |
LastServer | The physical server that last started the L-Server This is displayed when a physical L-Server status is one of the following:
|
Status | L-Server operation status |
PowerStatus | L-Server power status |
Resources | Resource allocation status |
ControlledResources | Scope of controlled resources This is displayed for L-Servers linked to configured physical servers. |
NumOfDisk | The number of disks |
Disk[num] | The disk name to allocate to L-Servers The index number of the disk element is configured in num. The number is "0" or larger. This is displayed when an L-Server status is one of the following:
|
DiskType[num] | The connection method of the disk to allocate to the L-Server The index number of the disk element is configured in num. The number is "0" or larger. |
DiskSize[num] | The disk size to allocate to L-Servers The index number of the disk element is configured in num. The number is "0" or larger. |
DiskType[num] | Virtual disk type of the disk to be allocated to the L-Server The index number of the disk element is configured in num. The number is "0" or larger. |
Shared[num] | Shared status of disks The index number of the disk element is configured in num. The number is "1" or larger. When the disk is used by multiple L-Servers, "Yes" is displayed. When the disk is not used by multiple L-Servers, "No" is displayed. |
OriginalStorage | Virtual storage or resource pool to create the disk to allocate to L-Servers |
NumOfNIC | Number of NICs |
NIC[num] | The network resource name assigned to L-Servers The network element of index number is configured in num. The number is "0" or larger. |
NIC[num][MACAddress] | MAC address of NIC |
NIC[num][PhysicalNum] | The number of the physical NIC corresponding to the NIC of an L-Server The number is "0" or larger. |
NIC[num][IPAddress] | IP address to allocate to L-Servers The network element of index number is configured in num. The number is "0" or larger. |
NIC[num][netlinknum][IpAddress] | IP address |
NIC[num][netlinknum][VlanMode] | VLAN mode |
NIC[num][netlinknum][DNSServer] | DNS server address |
NIC[num][netlinknum][DefaultGateway] | Default gateway address |
NICGroup[num][netlinknum][IpAddress] | IP address |
NICGroup[num][netlinknum][VlanMode] | VLAN mode |
NICGroup[num][netlinknum][DNSServer] | DNS server address |
NICGroup[num][netlinknum][DefaultGateway] | Default gateway address |
NICGroup[num][netlinknum][NicLinks] | NIC number to be bound |
Redundancy | Server redundancy to assign to L-Servers |
Positioning | Physical location of the server to allocate to L-Servers |
WWNN[num] | WWNN to assign to an L-Server The index number of the disk element is configured in num. The number is "0" or larger. |
WWPN[num] | WWPN to assign to an L-Server The index number of the disk element is configured in num. The number is "0" or larger. |
FCConnectionPattern | FC connection pattern file |
AliveMonitoring | Alive monitoring setting status One of the following is displayed:
|
Priority | Priority order for L-Server creation or startup |
ReserveResources | Retaining server resources |
iSCSI | Name of the disk resource to allocate to the L-Server |
iSCSI DISK Index | Index number of the disk to allocate to the L-Server |
iSCSI IQN[num][IQN] | IQN name used for the disk connected to the L-Server using iSCSI The index number of the disk element is configured in num. The number is "1" or larger. |
iSCSI IpAddress | IP address used for the disk connected to the L-Server using iSCSI |
iSCSI port | iSCSI communication port number used for the disk connected to the L-Server using iSCSI |
FCSinglePath | SAN Path Status When single-path is set, "true" is displayed. |
*1: Not displayed when using rack mount servers on which agents have not been registered.
For Virtual L-Servers
Item Name | Description |
|---|---|
Name | L-Server name |
Label | Label |
Comment | Comment |
Template | L-Server template name |
ServerImage | Image name and version When the L-Server version cannot be distinguished, it will not be displayed. |
ServerType | Server type |
VMType | VM type |
OSType | Type of OS |
CPUArch | CPU architecture |
CPUPerf | CPU performance When the limit is not set, a hyphen ("-") is displayed. |
CPUReserve (*1) | The minimum number of CPU resources to be allocated |
CPUShare (*1) | The relative proportion for allocation of CPU resources |
CPUWeight (*2) | The priority for allocation of CPU resources |
NumOfCPU | Number of CPUs |
MemorySize | Memory size |
MemoryReserve (*1) | The minimum amount of memory resources to be allocated |
MemoryShare (*1) | The relative proportion for allocation of memory resources |
StartupRAM (*2) | Initial memory capacity to be allocated at startup |
MemoryBuffer (*2) | Available memory to be reserved as a buffer |
MemoryWeight (*2) | The priority for allocation of memory resources |
DynamicMemory (*2) | Dynamic memory settings One of the following is displayed:
|
MaxDefinableMemory (*3) | Maximum memory size |
VmHost | VM host name This is displayed when an L-Server status is one of the following:
|
VmGuest | VM name for an L-Server This is displayed when an L-Server status is one of the following:
|
OriginalServer | VM host or resource pool to create a virtual machine to allocate to L-Servers |
LastServer | VM host that started the last L-Server virtual machine This is displayed when an L-Server status is one of the following:
|
Status | L-Server operation status |
PowerStatus | L-Server power status |
Resources | Resource allocation status |
ControlledResources | Scope of controlled resources This is displayed for L-Servers linked to configured virtual machines. |
NumOfDisk | The number of disks |
Disk[num] | The disk name to allocate to L-Servers The index number of the disk element is configured in num. The number is "0" or larger. This is displayed when an L-Server status is one of the following:
|
DiskSize[num] | The disk size to allocate to L-Servers The index number of the disk element is configured in num. The number is "0" or larger. |
Shared[num] | Shared status of disks The index number of the disk element is configured in num. The number is "1" or larger. The status is displayed when the disk is used by multiple L-Servers. |
DiskType[num] | Virtual disk type of the disk to be allocated to the L-Server The index number of the disk element is configured in num. The number is "0" or larger. |
DevicePath[num] | Device path of the disk to be allocated to the L-Server The index number of the disk element is configured in num. The number is "0" or larger. |
OriginalStorage | Virtual storage or resource pool to create the disk to allocate to L-Servers |
NumOfNIC | Number of NICs |
NIC[num] | The network resource name assigned to L-Servers The network element of index number is configured in num. The number is "0" or larger. |
NIC[num][IPAddress] | IP address to allocate to L-Servers The network element of index number is configured in num. The number is "0" or larger. |
NIC[num][MACAddress] | MAC address to allocate to the L-Server The network element of index number is configured in num. The number is "0" or larger. |
Redundancy | Server redundancy to assign to L-Servers One of the following is displayed:
|
SecondaryServer | VM host name on which a VMware FT secondary virtual machine operates If access to the VM host failed, a hyphen ("-") is displayed. |
Positioning | Physical location of the server to allocate to L-Servers |
AliveMonitoring | Alive monitoring setting status One of the following is displayed:
|
Exclusion | Exclusion When an operation, in which a resource set to be operated exclusively is outside the range of their user access, is performed, only the resource name is displayed. |
Priority | Priority order for L-Server creation or startup |
OverCommit | Setting for overcommit Only displayed when overcommit settings are enabled. |
ReserveResources | Retaining server resources |
Snapshot[num] | Snapshot collected from L-Servers The version, collected date, and comments are displayed. |
*1: When values are set for VMware, it is displayed.
*2: When values are set for Hyper-V, it is displayed.
*3: In RHEL-KVM, the status of allocated resources is displayed as below.
- Resources have been allocated (allocated)
- Servers have been released (preserved)
Powers on an L-Server.
Powers off an L-Server.
Restarts the L-Server.
Moves an L-Server to the specified resource folder.
Connects a disk resource to an L-Server and enables it to be accessed.
[VMware] [Hyper-V] [KVM]
Adds a NIC to an L-Server.
Note
When an L-Server is powered on, the disk to be attached to must be recognized by the L-Server. Follow the procedure provided by the OS.
When using physical L-Servers, disks cannot be attached to L-Servers that use iSCSI boot.
[Hyper-V] [KVM]
When adding a NIC, ensure that the VM guest and the L-Server is powered OFF. If the VM guest or L-Server is powered ON, NIC addition will fail.
Releases a disk resource from an L-Server and disables it from being accessed.
[VMware] [Hyper-V] [KVM]
Deletes a NIC of an L-Server.
Note
When deleting the disk while the physical L-Server is powered on, it is necessary to detach the disk to be deleted in advance.
[Hyper-V] [KVM]
When deleting a NIC, ensure that the L-Server is powered OFF. If the L-Server is powered ON, NIC deletion will fail.
Changes the location of an L-Server to a specified host.
Specify either to perform a live migration, which changes the location of the L-Server without stopping it, or a cold migration, which changes the location of the L-Server after temporarily stopping it.
For physical L-Servers, specification is not possible.
When using a physical L-Server, the network information is sent to a specified L-Server.
The information is stored as a file in the destination server.
The storage location and file are as follows:
File name
net_info.conf
Storage location of the file
[Windows]
Agent_installation_folder\Resource Orchestrator\Agent\etc\net
[Linux]
/etc/opt/FJSVrcxat/net/
Configures specific parameters, for a physical L-Server.
When the -attr option is specified, the boot mode can be set.
Links an L-Server with a configured virtual machine or physical server.
Cancels the link between an L-Server and a configured physical server or virtual machine.
Note
When the disk resource is a LUN that has been created in advance, a LUN for iSCSI boot, or a disk resource for a virtual L-Server, the data on the disk will not be deleted.
When releasing a disk using delete or detach, it is recommended to delete the data on the disk.
For details on the method for deleting the data on a disk, refer to cautionary notes in "7.5 Storage Resources" of the "User's Guide for Infrastructure Administrators (Resource Management) CE".
To prevent a disk that has been saved after detachment from virtual storage from being re-used unintentionally in an L-Server, such disks cannot be automatically selected and are not selected by create or attach when using pool specification.
To connect a disk that has been saved after separation from virtual storage when deleting the disk to an L-Server using create or attach, specify the disk explicitly.
Options
In file.xml, specify the path of the XML file that defines the resources that comprise the L-Server.
When modifying the basic information or specifications of an L-Server, only elements to be modified can be specified in the XML file.
When modifying an L-Server for which only the configuration definition has been created, unmodified information must be described also.
For details on the XML file definition, refer to "2.3 L-Servers".
[Xen]
When the VM type is "RHEL-Xen", the image name cannot be specified.
Specify the display format. You can specify text or xml format.
When -format is omitted, it is displayed in text format.
When performing the following operation, specify the XML and obtain the information.
For XML, refer to "2.2 L-Server Template" or "2.3 L-Servers".
When changing an L-Server using a command
When creating an L-Server template from an existing L-Server
When creating an L-Server with the same configuration as an existing L-Server using a command
Use this option to return directly to the command prompt without waiting for the operation of the L-Server specified in the subcommand to complete its execution.
In name, specify the name of the target L-Server to perform an operation with.
To specify an L-Server that is located in a tenant folder or a resource folder, it is necessary to also specify the tenant folder name or the resource folder name connected with a slash ("/").
When specifying the convert subcommand, specify the name for the L-Server. For the characters that can be used for L-Server names, refer to the list of items specified in XML Definitions in "2.3.1 Definition Information for Physical L-Servers (XML)" and "2.3.2 Definition Information for Virtual L-Servers (XML)".
When specifying the convert subcommand and omitting the -name option, the L-Server name is set as follows.
When linking a physical server to an L-Server
If the physical server name of the configured physical server is a possible value for the L-Server name described in "Table 2.3 List of Items Specified in XML Definitions for Physical L-Servers" in "2.3.1 Definition Information for Physical L-Servers (XML)"
The physical server name will be set as the L-Server name.
If a value other than a possible value is used for the L-Server name
An error will occur and the operation will be aborted.
When linking a configured virtual machine to an L-Server
If the VM name of the configured virtual machine is a possible value for the L-Server name described in "Table 2.5 List of Items Specified in XML Definitions for Virtual L-Servers" in "2.3.2 Definition Information for Virtual L-Servers (XML)"
The VM name will be set as the L-Server name.
If a value other than a possible value is used for the L-Server name
An error will occur and the operation will be aborted.
For virtual L-Servers, specify the name of the destination VM host in vmhost. The VM host must be registered in a VM pool.
If this option is not specified, a VM host is automatically selected from the VM pools.
Specify a destination VM host with available CPU capacity and memory. If there is insufficient CPU capacity or memory, migration between servers or starting of L-Servers may fail.
For virtual L-Servers, specify the migration method.
When performing a live migration
Specify "live".
When performing a cold migration
Specify "cold".
This may not be able to be specified, depending on the power state of the VM guest.
When omitted, the appropriate type will be chosen depending on the state of the VM guest.
For stop/restart, use this option to forcibly stop or restart an L-Server without shutting down the operating system it is running on.
For detach, also use this option to release disk resources, ignoring any errors which occur when releasing disk resources for physical L-Servers. Specify this option only for physical L-Servers.
Specify a resource folder to place an L-Server in for folder. For the hierarchized resource folder, specify the resource folder name using slashes ("/"). When omitted, the L-Server is placed in the home folder.
When executed by a user who has multiple access scopes specified, it cannot be omitted. Specify a resource folder.
In size, specify the disk capacity, in units of gigabytes. Up to one decimal place can be specified.
Specify the name of the resource pool or virtual storage resource from which to take the disk capacity to allocate to the L-Server.
For a resource pool or a virtual storage resource located in the resource folder, specify the resource folder name using slashes ("/").
When omitted, resource selection is performed automatically with priority given to storage pools.
Specify the name of the disk resource to allocate to the L-Server or release from the L-Server.
Specify the disk number of the disk resource. By default, the number of the last disk allocated plus one is used. The maximum value differs according to the server type.
Use this option only when removing the disk from the L-Server while the server is running. If you remove a disk in use while the server is running, inconsistencies may occur in the data or the OS management information. Use this option after checking the status of the OS and applications.
[Oracle VM]
The disk cannot be removed while the L-Server is running.
Specify when connecting an already created LUN or a disk resource created (and saved) from virtual storage.
Specify this option only for physical L-Servers or virtual L-Servers with RHEL-KVM or Hyper-V.
When specifying this option for virtual L-Servers with Hyper-V, the -size option cannot be specified at the same time.
The network information file is output.
NIC0_MacAddress="xx:xx:xx:xx:xx:xx" # Single NIC Information SingleNics="0" NIC0_NetworkLinks="0" NIC0_0_VlanMode="untagged" NIC0_0_IpAddress="192.168.24.124" NIC0_0_Vlanid=1 NIC0_0_Netmask="255.255.255.0" NIC0_0_DefaultGateway="192.168.24.254" |
For physical L-Servers, set the boot mode and SAN path status.
For boot mode, specify "-attr boot={default|pxe}".
When setting the boot mode to PXE
Specify "pxe".
When setting the initial boot mode.
Specify "default".
When setting SAN path status, specify "-attr fcsinglepath={true|false}".
When setting a single-path to the SAN for the physical L-Server
Specify "true".
When setting a multi-path to the SAN for the physical L-Server
Specify "false".
If the SAN path status for the physical L-Server and the value specified in this option are the same
The current settings are kept.
If the physical L-Server is powered on
If this option is specified, an error will occur.
Both boot and fcsinglepath can be specified at the same time.
In network_name, specify the network resource name to perform PXE boot.
When PXE is set for the boot mode, perform PXE boot from the network of the specified network resource.
This option can only be specified for deldisk.
Specify this option when there are no problems even if disk contents are deleted by the following operations. Omitting this option will cause an operational failure when there is the possibility that disk contents will be deleted by these operations.
Deleting an L-Server
Releasing disk resources from an L-Server
This option can only be specified for deldisk.
Specify this option when the content of the disk is to be saved rather than deleting the disk resource from virtual storage, as the following procedure describes.
Releasing disk resources from an L-Server
Specify this option only for physical L-Servers or virtual L-Servers with Hyper-V. This option and the -allow deldisk option cannot be specified at the same time.
When the disk resource is not a LUN created in advance, either -allow deldisk or -deny deldisk must be specified.
The option is only valid when detaching a disk. The disk resource cannot be saved permanently by using this option.
When this option is to be used to save the content of the disk rather than deleting the disk resource from virtual storage, the disk resource is automatically registered in the storage pool in which the virtual storage resource that is the origin of the disk resource is registered.
For physical L-Servers, specify in order to send network information to the L-Server that is specified for the -name option.
In label, specify the label for the L-Server.
In comment, specify the comments for the L-Server.
In with, specify the virtual machine or physical server linked to an L-Server.
Specify the resource folder name or the resource pool name connected with slashes ("/").
/Resource_folder_name/Resource_pool_name/VM_host_name/Virtual_machine_name /Resource_folder_name/Resource_pool_name/Physical_server name /Resource_pool_name/VM_host_name/Virtual_machine_name /Resource_pool_name/Physical_server_name |
Specify a network index to delete.
Specify the IP address to allocate to the NIC. If omitted, an address is automatically allocated.
Examples
To display the list of L-Servers:
>rcxadm lserver list <RETURN>
NAME TYPE SPEC DISKS IPADDRESSES STATUS RESOURCES
---- ---- -------------- -------------- ----------- ------ ---------
L-Server1 Virtual 1.0GHz,1,2.0GB 30.0GB,100.0GB 10.20.30.40,10.20.40.50 normal allocated
L-Server2 Virtual 1.0GHz,1,2.0GB 30.0GB,100.0GB 10.20.30.41 stop preserved
L-Server3 Virtual 1.0GHz,1,2.0GB 30.0GB,100.0GB - stop defined
L-Server11 Physical 2.3GHz,2,72.0GB 30.0GB 10.30.40.2 normal allocated
L-Server12 Physical 2.3GHz,2,72.0GB 30.0GB 10.30.40.3 stop preserved
L-Server13 Physical 2.3GHz,2,72.0GB 30.0GB - stop defined |
To display the detailed information for a virtual L-Server:
>rcxadm lserver show -name /TenantA/test4 <RETURN>
Name: test4
ServerType: Virtual
VMType: VMware
OSType: Microsoft Windows Server 2008 (32-bit)
CPUArch: IA
CPUPerf: 1GHz
CPUReserve: 0.7GHz
CPUShare: 1000
NumOfCPU: 1
MemorySize: 1GB
MemoryReserve: 0.7GB
MemoryShare: 1000
VmHost: vmhost
VmGuest: test4-62
Status: stop
PowerStatus: off
Resources: allocated
NumOfDisk: 1
Disk[0]: test4-0-disk0
DiskSize[0]: 4GB
NumOfNIC: 1
NIC[0]: vnet1
NIC[0][IPAddress]: 192.168.1.2
NIC[0][MACAddress]: 00:50:56:91:09:21
Redundancy: None
Positioning: Fixed
Priority: 128
Repurpose: true
OverCommit: true |
To display the detailed information for a physical L-Server (when created with CPU Performance, Number of CPU, and Memory Size specifications):
>rcxadm lserver show -name /TenantA/test5 <RETURN>
Name: test5
ServerType: Physical
...
CPUPerf(SPEC): 1.8GHz (2.0GHz)
NumOfCPU(SPEC): 1 (2)
MemorySize(SPEC): 8.0GB (12.0GB)
PhysicalServer: BX920-1
PhysicalServerModel: PRIMERGY BX922 S4
... |
To display the detailed information for a physical L-Server (when created with the Model Name specification):
>rcxadm lserver show -name /TenantA/test6 <RETURN>
Name: test6
ServerType: Physical
...Model: PRIMERGY BX922 S4 CPUPerf(SPEC): - (2.0GHz) NumOfCPU(SPEC): - (2) MemorySize(SPEC): -(12.0GB) PhysicalServer: BX920-1 PhysicalServerModel: PRIMERGY BX922 S4 ... |
When adding NICs [VMWare] [Hyper-V] [KVM]
>rcxadm lserver attach -name mylserver1 -net mynet1 -ip 192.168.3.2 <RETURN> |
When deleting NICs [VMWare] [Hyper-V] [KVM]
>rcxadm lserver show -name mylserver1 <RETURN> |
