Data types and value ranges

The maximum length of any single parameter that is entered into the command line is 2176 bytes.

Note: If you do not specify a name when you are creating a new object, the cluster assigns a default name. This name is made from the object type as the prefix and the object ID as the suffix. For example, a new virtual disk (VDisk) is created with ID 5. This object is given the default name of vdisk5. Because the system assigns these names, it does not allow you to create an object and call it vdiskx where x is the integer. This is because the cluster reserves these names (for example, object_type_prefix integer) for default.
Data types Value ranges
filename_arg This is a (optionally fully qualified) file name. The maximum length is 169 characters. Valid characters consist of the following options:
  • .
  • /
  • -
  • _
  • a - z
  • A - Z
  • 0 - 9
The field must not contain two consecutive '.', or start with a '.', or end with a '.'.
directory_or_file_filter Specifies a directory and file name filter, or both, within the specified directory. Valid directory values consist of the following options:
  • /dumps
  • /dumps/audit
  • /dumps/configs
  • /dumps/elogs
  • /dumps/feature
  • /dumps/iostats
  • /dumps/iotrace
  • /dumps/software
The file name filter can be any valid file name with or without the wildcard '*'. The file name filter can be appended to the end of one of the previous directory values. The maximum length is 128 characters. Valid characters consist of the following options:
  • *
  • .
  • /
  • -
  • _
  • a - z
  • A - Z
  • 0 - 9
The field must not contain two consecutive '.', or start with a '.', or end with a '.'.
filename_prefix This is a prefix to be used when naming a file. The maximum length is 128 characters. Valid characters consist of the following options:
  • a - z
  • A - Z
  • 0 - 9
  • -
  • _
name_arg Names can be specified or changed using the create and modify functions. With the view commands you can see both the name and ID of an object.

A string of 1 - 15 characters can be used, composed of characters A - Z, a - z, 0 - 9, - (dash), and _ (underscore).

The first character of a name_arg must not be numeric. The first character of an object name cannot be a - (dash) because the CLI interprets it as being the next parameter.

When creating a name for an object, the name must not consist of the object type followed only by an integer. The exception is Metro or Global Mirror relationships, which can be named anything as long as the names are unique across the two clusters. This naming convention is used by the system to generate default names. You cannot use one of the following reserved words followed by an integer:
  • cluster
  • controller
  • fccstgrp
  • fcmap
  • host
  • io_grp
  • mdisk
  • mdiskgrp
  • node
  • rccstgrp
  • rcmap

The cluster name is set when the cluster is created.

password
This is a user-defined password. A password must meet the following requirements:
  • Can use a - z, A - Z, 0 - 9 in any sequence
  • Can use - (dash) but not as the first character
  • Can use _ (underscore)
  • Can contain a maximum of 15 characters
serial_number The format of this number conforms to IBM® standard C-S 1-1121-018 1999-06 Serial Numbering for IBM products. The serial number is 7 digits, the first two of which define the manufacturing location, leaving 5 digits for the product. The standard defines a way to extend the serial number using letters in the place of numbers in the 5-digit field.
ip_address_arg The decimal, dotted-quad-notation standard rules. The following Internet Protocol 4 (IPv4) and Internet Protocol 6 (IPv6) address formats are supported:
IPv4 (no port set, SAN Volume Controller uses default)
1.2.3.4
IPv4 with specific port
1.2.3.4:22
Full IPv6, default port
1234:1234:0001:0123:1234:1234:1234:1234
Full IPv6, default port, leading zeros suppressed
1234:1234:1:123:1234:1234:1234:1234
Full IPv6 with port
[2002:914:fc12:848:209:6bff:fe8c:4ff6]:23
Zero-compressed IPv6, default port
2002::4ff6
Zero-compressed IPv6 with port
[2002::4ff6]:23
dns_name Dotted domain name for the subnet that the cluster is in. For example, ibm.com.
hostname The host name that is assigned to the cluster. This can be different from the cluster name and you can change the host name at any time.
A combination of the host name and the dns_name that is used to access the cluster, for example:

https://hostname.ibm.com/

capacity_value A value with a range of 512 bytes up to 2 petabytes (PB).
Note: The capacity can be specified as megabytes (MB), kilobytes (KB), gigabytes (GB), or PB. When MB is used, the value is specified in multiples of 512 bytes. A capacity of 0 is valid for a striped or sequential VDisk. The smallest number of supported bytes is 512.
node_id A node ID differs from other IDs; a node ID is a unique ID that is assigned when a node is used to create a cluster, or when a node is added to a cluster. A node_id value is never reused in a cluster. Node IDs are internally represented as 64-bit numbers.

Node IDs, like other IDs, cannot be modified by user commands.

xxx_id All objects are referred to by unique integer IDs that are assigned by the system when the objects are created. All IDs are represented internally as 32-bit integers. Node IDs are an exception.
IDs in the following ranges are used to identify the various types of objects:
  • node_id: A positive decimal integer greater than or equal to 1
  • mdisk_grp_id: 0 - 127
  • io_grp_id: 0 - 3 (See Note.)
  • mdisk_id: 0 - 4095
  • vdisk_id: 0 - 8191
  • copy_id: 0 - 1
  • host_id: 0 - 1023
  • flash_const_grp_id: 0 - 255
  • remote_const_grp_id: 0 - 255
  • fcmap_id: 0 - 4095
  • rcrel_id: 0 - 8191
  • controller_id: 0 - 63
Note: The io_group 4 exists but is used only in certain error recovery procedures.
These IDs, like node IDs, cannot be modified by user commands.
Note: IDs are assigned at run time by the system and cannot be relied upon to be the same after, for example, the configuration restoration. Use object names in preference to IDs when you are working with objects.
xxx_list A colon-delimited list of values of type xxx.
wwpn_arg The fibre-channel worldwide port name (WWPN). This is expressed as a 64-bit hexadecimal number, for example:

1A2B30C67AFFE47B

These numbers must consist of the characters 0 - 9, a - f, and A - F. A command fails if you enter WWPN 0 in the command string.
panel_name A string of up to six characters that correspond to the number on the printed label below the display on the front panel of a node in the cluster.
sequence_number A 32-bit unsigned integer, expressed in decimal format.
csi_num_arg A 32-bit unsigned integer, expressed in decimal format.
percentage_arg An 8-bit unsigned integer, expressed in decimal 0 - 100 format.
extent_arg A 32-bit unsigned integer, expressed in decimal format.
num_extents_arg A 32-bit unsigned integer, expressed in decimal format.
threads_arg An 8-bit unsigned integer, expressed in decimal format. Valid values are 1, 2, 3, or 4.
velocity_arg The fabric speed in gigabytes per second (GBps). Valid values are 1 or 2.
timezone_arg The ID as detailed in the output of the svcinfo lstimezones command.
timeout_arg The command timeout period. An integer from 0 to 600 (seconds).
stats_time_arg The frequency at which statistics are gathered. Valid values are 1 to 60 minutes in increments of 1 minute.
directory_arg Specifies a directory and or file name filter within the specified directory. The following directory values are valid:
  • /dumps
  • /dumps/audit
  • /dumps/cimom
  • /dumps/configs
  • /dumps/elogs
  • /dumps/feature
  • /dumps/iostats
  • /dumps/iotrace
  • /home/admin/upgrade

The file name filter can be any valid file name with or without the wildcard '*'.

The file name filter can be appended to the end of one of the previous directory values.

locale_arg The cluster locale setting. Valid values are 0 and 3.
  • 0 US English (default)
  • 3 Japanese
key_arg

A user-defined identifier for an SSH key. It consists of a string of up to 30 characters.

user_arg

Specifies the user: either admin or service.

copy_rate

A numeric value of 0 - 100.

copy_type

Specifies the Mirror copy type: Metro or Global.

The maximum number of values that can be entered into a colon-separated list is 128. If more than 128 items are entered into a list, an error is returned.

Library | Support | Terms of use | Feedback
© Copyright IBM Corporation 2003, 2009. All Rights Reserved.