QXS Array Commands
Note: For a list of all the Appliance Controller commands, see the Command Index.
For dual-server node systems, the health monitor only reports RAS events on the primary node, but is active on both nodes to support fail-over.
Before you Begin
Ensure the Appliance Controller is upgraded to 2.2 or later. See Upgrade to the Current Appliance Controller Release.
Procedure: Enable RAS messages
- Configure email settings in StorNext.
- Log in to the Appliance Controller CLI.
- Display which arrays are currently assigned to the Appliance Controller. Enter:
- Do the following to assign any missing QXS arrays:
- Assign all QXS arrays using the
qxsarray assign
command. - Log out of the SSH session on this server node by entering
exit
until the SSH window closes. - If needed, for dual-server node systems, log in to the other server node as the
sysadmin
user and the sysadmin user password, and repeat the Assign the QXS Array(s) steps to assign the QXS array IP address to the other server node.
Configure an SMTP email server and enable RAS email to be generated, using the StorNext GUI. See the Configure the Email Server section on the Configuration > Email Server page of the StorNext 6 Documentation Center.
qxsarray show
If all QXS arrays attached to this system are already listed, the remaining steps are not necessary, and the QXS array RAS messages are already configured. If any QXS arrays are not currently shown that should be, continue with the next step.
Only one IP is required per array, and it can be the IP for either Controller A or B. Both controllers will be monitored for health alerts using the following syntax:
qxsarray assign <ipaddr> [<username> <password>]
Example:
Note: For systems running QXS G280 or later software, the "manage" username and "!manage" password are no longer default values on the array. Use a username and password assigned to the "manage" role on the QXS array.
> qxsarray assign 10.40.111.222 manage !manage
Stored QXS array management IP "10.40.111.222".
Once the QXS RAS ticket option is enabled and the QXS array is assigned to both this enabled will see QXS tickets show up in the StorNext GUI and QXS RAS messages about any array issues will begin to be emailed to the email address configured in Configure email settings in StorNext.
See Configure QXS iSCSI Connections for the instructions on configuring iSCSI.
The following commands are available for the QXS Array feature.
qxsarray monitor
)
While monitoring QXS arrays is enabled by default (Enable QXS Array RAS Messages), it can also be disabled, and then re-enabled using this command.
- Log in to the Appliance Controller CLI.
- Enter
qxsarray monitor
.
Command Syntax:
qxsarray monitor (enable | disable)
> qxsarray monitor enable
Set QXS array health monitor to "enabled".
> qxsarray monitor disable
Set QXS array health monitor to "disabled".
The parameters are:
enable | Enable the QXS array health monitor |
| Disable the QXS array health monitor. |
qxsarray
Commands
- Log in to the Appliance Controller CLI.
- As with other commands, enter the
qxsarray
command, and you will be shown all current qxsarray commands:
> qxsarray
Showing commands that start with 'qxsarray':
qxsarray show [all, health, iscsi, profiles, vpool] [array_ip=<ipaddr>]
qxsarray assign <ipaddr> [<username> <password>]
qxsarray remove (<ipaddr> | all)
qxsarray monitor (enable | disable)
qxsarray change network <ipaddr_A> <ipaddr_B> <gateway> <netmask>
[gateway_B=<gateway>, netmask_B=<netmask>, ping_broadcast=(yes
| No), array_ip=<ipaddr>, ...]
qxsarray change password <username> [array_ip=<ipaddr>]
qxsarray change system (name=<system_name>, contact=<contact>,
location=<location>, info=<system_info>) [array_ip=<ipaddr>]
qxsarray iscsi address <qxs_port> <ipaddr> <netmask> [gateway=<ipaddr>,
def_router=<ipaddr>, array_ip=<ipaddr>]
qxsarray iscsi set (ports_mode=(FC | FC-and-iSCSI | iSCSI ), jumbo=(yes
| No), speed=(Auto | 1gbps)) [array_ip=<ipaddr>]
qxsarray provision <profile> [num_disk_groups=(<number> | all),
total_managed_files=(<number> | max), array_ip=<ipaddr>, ...]
qxsarray vpool volume add hafs <num_managed_files | max>
[array_ip=<ipaddr>, ...]
qxsarray vpool volume add metadata <num_files | max>
[num_volumes=(<number> | max), array_ip=<ipaddr>, ...]
qxsarray rescan_luns ...
qxsarray show
)
- Log in to the Appliance Controller CLI.
- Enter
qxsarray show
.
Command Syntax:
qxsarray show [all, health, iscsi, profiles, vpool] [array_ip=<ipaddr>] [health]
> qxsarray show profiles array_ip=10.40.111.222
{ 'QXS2U12-1': { 'Errors': [],
'IPAddress-A': '10.40.111.222',
'IPAddress-B': '10.40.111.223',
'Model': '2U12',
'PerformanceTierLicense': 'Disabled',
'Product-series': 'QXS3',
'Uptime-seconds': '11229549',
'VirtualizationLicense': 'Disabled',
'enclosure_0': { 'DiskSize_1': '4000.7GB',
'DiskType_1': 'HDD',
'FreeDisks': 12,
'FreeSlots': 0,
'Model': '2U12',
'PoolCreation': False,
'ValidProfiles': [ '10+2_R6_Converged_HAFS',
'10+2_R6_Data',
'10+2_R6_Converged_Archive',
'number-of-disks': 12),
'enclosure_1': { 'DiskSize_1': '4000.7GB',
'DiskType_1': 'HDD',
'Errors': [],
'FreeDisks': 12,
'FreeSlots': 0,
'Model': '2U12',
'PoolCreation': False,
'ValidProfiles': [ '10+2_R6_Converged_HAFS',
'10+2_R6_Data',
'10+2_R6_Converged_Archive',
'number-of-disks': 12),
'system-contact': 'john doe',
'system-information': 'Uninitialized Info',
'system-location': 'Uninitialized Location'}}
The parameters are:
| View all QXS configuration information on the array. |
*health | View health status of QXS arrays assigned to the Controller. QXS arrays with good health When the QXS arrays with degraded health When the Example (unhealthy components in a degraded system) Note: ... indicates additional information which is not shown in this example. > qxsarray show health { 'QXS2U12-1': { 'Errors': [], ... 'unhealthy-components': \{ 'Disk 0.3': \{ 'architecture': 'SSD', 'basetype': 'drives', 'component-id': 'Disk 0.3', 'component-type': 'disk', 'component-type-numeric': '6', 'disk-group': None, 'fde-state': 'Not FDE Capable', 'health': 'Degraded', 'health-numeric': '1', 'health-reason': 'A user forced the disk out of the disk group.', 'health-recommendation': "- If the associated disk group is offline or quarantined, contact technical support. Otherwise, clear the disk's metadata to reuse the disk.", |
| |
<profiles> | View all existing and candidate QXS storage profiles available for the array. |
<vpool> | View the vpool configuration. This applies only to dedicated metadata configurations on QXS 24-drive arrays. |
array_ip=<ipaddr> | ( Optional). Use this argument if there are multiple QXS arrays assigned for use. This specifies the current management IP address (either controller A or B) for the array to which this command should be sent. |
qxsarray assign
)
- Log in to the Appliance Controller CLI.
- Enter
qxsarray assign
.
Command Syntax:
qxsarray assign <ipaddr> [<username> <password>]
Example:
Note: For systems running QXS G280 or later software, the "manage" username and "!manage" password are no longer default values on the array. Use a username and password assigned to the "manage" role on the QXS array.
> qxsarray assign 10.40.111.222 manage !manage
Stored QXS array management IP "10.40.111.222".
The parameters are:
<ipaddr> | The new QXS RAID chassis management IP address (for either Controller A or Controller B). |
| (Optional) If the default password for the 'manage' account has been changed, then a username is required. This can be 'manage' or another existing user with admin priviledges on the array. |
| (Optional) If a username is supplied, then a password is also required. |
qxsarray remove
)
- Log in to the Appliance Controller CLI.
- Enter
qxsarray remove
.
Command Syntax:
qxsarray remove (<ipaddr> | all)
Example:
> qxsarray remove 10.40.111.222
Removed assigned QXS array with management IP address "10.40.111.222".
The parameters are:
array_ip=<ipaddr> | The QXS RAID chassis management IP address (for either Controller A or Controller B) to remove from the configuration. |
| Remove all QXS arrays from the configuration. |
qxsarray change network
)
- Log in to the Appliance Controller CLI.
- Enter
qxsarray change
.
Command Syntax:
qxsarray change network <ipaddr_A> <ipaddr_B> <gateway> <netmask> [gateway B=<gateway>, netmask_B=<netmask>, ping_broadcast=(yes | No), array_ip=<ipaddr>, ...]
Example:
> qxsarray change network 10.40.111.222 10.40.111.223 10.40.111.1 255.255.255.0 ping_broadcast=yes
Changed QXS array to the following network configuration: ping_broadcast="on", ipaddr_b="10.40.111,223", ipaddr_a="10.40.111.222", netmask="255.255.255.0", gateway="10.40.111.1".
The parameters are:
<ipaddr_A> | The new IP address of QXS RAID chassis Controller A. |
<ipaddr_B> | The new IP address of QXS RAID chassis Controller B. |
<gateway> | The new QXS RAID chassis gateway address setting associated with the new management IP addresses. |
<netmask> | The new QXS RAID chassis netmask setting for the new management IP addresses. |
gateway_B=<gateway> | (Optional) The new QXS RAID chassis gateway address setting for the new management IP address on Controlelr B only. Use this argument only if the management IPs for controllers A and B will be configured on different subnets. |
netmask_B=<netmask> | (Optional) The new QXS RAID chassis netmask setting associated with the new management IP address on Controller B only. Use this argument only if the management IPs for controllers A and B are being configured on different subnets, with different netmasks. |
ping_broadcast=(yes | No) | (Optional) Enables the QXS array to respond when a ping to a broadcast address is issued on the array’s subnet. (Default is No) |
| (Optional) Use this argument only if there are multiple QXS arrays assigned for use. This specifies the current management IP address (either controller A or B) for the array to which this command should be sent. |
qxsarray change password
)
- Log in to the Appliance Controller CLI.
- Enter
qxsarray change password
. - Enter:
- Enter the password and press <Enter>.
Command Syntax:
qxsarray change password <username> [array_ip=<ipaddr>]
Example:
> qxsarray change password manage array_ip=10.40.111.222
You will see the following note about the password change:
The password is 8-32 characters, and can include printable UTF-8 characters
except a space or any of: " ' , < > \
A password that includes only printable ASCII characters must include at least one uppercase character, one lowercase character, and one non-alphabetic character. Please enter a new password for user manage:
You will see a prompt similar to the following when the password has been applied:
Changed password for username manage on the QXS array with IP address "10.40.111.222".
The parameters are:
| The QXS RAID chassis admin user name. Normally this is the default 'manage' account. |
array_ip=<ipaddr> | ( Optional) Use this argument if there are multiple QXS RAID chassis assigned for use. This specifies the current management IP address (either controller A or B) for the array to which this command should be sent. |
qxsarray change system
)
- Log in to the Appliance Controller CLI.
- Enter
qxsarray change system
.
Command Syntax:
qxsarray change system (name=<system_name>, contact=<contact>, location=<location>, info=<system_info>, [array_ip=<ipaddr>]
Example:
> qxsarray change system name='Xcellis_QXS424_1' contact='Jill Smith' location='Irvine Data Ctr, Row 3, Rack 12, 14-15U' info="R&D metadata storage"
Changed system information for QXS array: info="R&D metadata storage", contact="Jill Smith", name="Xcellis_QXS424_1", location="Irvine Data Ctr, Row 3, Rack 12, 14-15U".
The parameters are:
name=<system_name> | The name for the QXS RAID chassis. Normally this only needs to be set once, during initial configuration. |
contact=<contact> | The admin contact for this QXS RAID chassis. |
location=<location> | The location of the QXS RAID chassis. This is a free-form text field, as shown in the example above. |
info=<system_info> | Additional information or notes about the use of the QXS RAID Chassis. |
array_ip=<ipaddr> | (Optional) Use this argument if there are multiple QXS RAID chassis assigned for use. This specifies the current management IP address (either controller A or B) for the array to which this command should be sent. |
qxsarray iscsi address
)
- Log in to the Appliance Controller CLI.
- Enter
qxsarray iscsi address
.
Command Syntax:
qxsarray iscsi address <qxs_port> <ipaddr> <netmask> [gateway=<ipaddr>, def_router=<ipaddr>, array_ip=<ipaddr>]
Example:
> qxsarray iscsi address port A2 10.40.111.222 255.255.255.0
Changed qxsarray iscsi address for port A2 to 10.40.111.222 255.255.255.0
The parameters are:
| The iSCSI host port for which you are setting the IP address. |
<ipaddr> | The IP address to assign to the QXS port. |
<netmask> | The netmask to assign to the IP address. |
gateway=<ipaddr> | (Optional) The gateway's IP address to assign to the iSCSI host port. |
def_router=<ipaddr> | (Optional) The default router IP address to assign to the iSCSI host port. |
array_ip=<ipaddr> | The QXS RAID chassis managment IP address (for either Controller A or Controller B) . |
qxsarray iscsi set
)
- Log in to the Appliance Controller CLI.
- Enter
qxsarray iscsi set
. jumbo=yes
– (Recommended setting) Sets the QXS array's Ethernet frame size to jumbo (MTU=8900). For best performance, Quantum strongly recommends this setting.jumbo=no
– Sets the QXS array's Ethernet frame size to standard (MTU=1400).speed=auto
– (Default setting) Sets the QXS array's Ethernet speed to auto-negotiate. This setting is recommended for best performance.speed=1gbps
– Sets the QXS array's Ethernet speed to 1 GB per second for systems where the LAN connection does not support 10 GB per second.
Command Syntax:
qxsarray iscsi set (ports_mode=(FC | FC-and-iSCSI | iSCSI ), jumbo=(yes | no), speed=(auto | 1gbps)) [array_ip=<ipaddr>]
Example:
> qxsarray iscsi set ports_mode=iSCSI, speed=auto, array_ip=10.40.111.222
The array controllers must restart following a ports mode change; this will take a couple minutes...
The parameters are:
| Note: If you change the QXS RAID chassis support both Fibre Channel (FC) and iSCSI on the same ports. You can change this setting by changing the " |
jumbo=(yes | No) | Note: If you change the |
speed=(auto | 1gbps) | |
array_ip=<ipaddr> | The QXS RAID chassis managment IP address (for either Controller A or Controller B) . |
qxsarray provision
)
- Log in to the Appliance Controller CLI.
- Enter
qxsarray provision
.
Command Syntax:
qxsarray provision <profile> [num_disk_groups=(<number> | all), total_managed_files=(<number> | max), array_ip=<ipaddr>, ...]
Example:
> qxsarray provision 10+2_R6_Converged_HAFS num_disk_groups=all, array_ip=10.40.111.222
Successfully provisioned all disk-group(s) with profile 10+2_R6_Converged_HAFS for QXS array with IP address: 10.40.111.222
The parameters are:
| The QXS RAID chassis profile to use to provision array storage |
<num_disk_groups> | The number of disk groups to be assigned to the array. |
<total_managed_files> | The number of files to be managed with StorNext Storage Manager. |
array_ip=<ipaddr> | (Optional) Use this argument if there are multiple QXS RAID chassis assigned for use. This specifies the management IP address (for either controller A or B) for the array to which this command should be sent. |
qxsarray vpool volume add hafs
)
When you originally provision, it will dedicate a minimum amount of space for the HAFS. You can now vary the amount of HAFS space that you want, from the minimum that will support the system to the maximum, of 2/3 of the available space on the array, on dedicated metadata arrays. 1/3 will always be reserved for metadata storage. When this is configured to use the max, it will balance the available space across the available vpools to support the maximum number of managed files supported by the array.
- Log in to the Appliance Controller CLI.
- Enter
qxsarray vpool volume add hafs
.
Command Syntax:
qxsarray vpool volume add hafs <num_managed_files= | max>, array_ip=<ipaddr>, ...]
Example:
> qxsarray vpool volume add hafs num_managed_files=max, array_ip=10.40.111.222
Successfully added HAFS volume(s), with support for max managed files, for QXS array with IP address: 10.40.111.222.
The parameters are:
num_managed_files= | max> | The number of managed files you want to support total on your system, to increase the hafs space, even if already specified previously, so this is something you can change this setting at any time. You can specify a specific number of managed files for the system, or you can enter "max " to use the maximum space available on the system. When the "max " option is chosen, the system will allocate 2/3 of the available space for the hafs, and 1/3 for metadata. |
array_ip=<ipaddr> | The QXS RAID chassis IP address (for either Controller A or Controller B) |
qxsarray vpool volume add metadata
)
Use this function to create a metadata file system that supports a specified number of files. When you specify the number of files you need to support, this command will configure a metadata LUN that will support that number of files, as long as adequate space is available for the space needed for those files. If you enter a number larger than the number supported by the given space available, specify a smaller number of files for the file system. You can also specify the number of volumes to support those files.
- Log in to the Appliance Controller CLI.
- Enter
qxsarray vpool volume add metadata
.
Command Syntax:
qxsarray vpool volume add metadata, <num_files | max> [num_volumes=(<uint> | max), array_ip=<ipaddr>, ...]
Example:
> qxsarray vpool volume add metadata, <num_files | max> [num_volumes=(<uint> | max), array_ip=10.40.111.222
The parameters are:
| Enter the number of files to be supported on this metadata LUN, or enter max to just max out the number of files the LUN can support. |
<uint> | max | Enter the number of volumes to use on this LUN, or enter max to use the maximum number of volumes supported. |
array_ip=<ipaddr> | The QXS RAID chassis IP address (for either Controller A or Controller B) |
qxsarray rescan_luns
)
- Log in to the Appliance Controller CLI on the master node:
- Enter
qxsarray rescan_luns
.
Command Syntax:
qxsarray rescan_luns
Example:
> qxsarray rescan_luns
Starting a rescan of the SCSI bus and multipath devices, this may take a few moments...
Now waiting for the cvadmin 'disks refresh' to settle...
Successfully scanned for QXS LUNs. If this is an HA system, a rescan should also be executed on the other node.