Attributes of the -filtervalue parameters

The -filtervalue parameter filters a view that is based on specific attribute values that relate to each object type. You can combine multiple filters to create specific searches, for example, -filtervalue name=fred:status=online. The help (-filtervalue?) specifies the attributes that are available for each object type.

The -filtervalue parameter must be specified with attrib=value The -filtervalue? and -filtervalue parameters cannot be specified together.
Note: The qualifier characters left bracket (<) and right bracket (>) must be enclosed within double quotation marks (""). For example, -filtervalue vdisk_count "<"4 or port_count ">"1. It is also valid to include the entire expression within double quotation marks. For example,-filtervalue "vdisk_count<4"
When an attribute requires the -unit parameter, it is specified after the attribute. For example, -filtervalue capacity=24 -unit mb. The following input options are valid for the -unit parameter:
  • b (bytes)
  • mb (Megabytes)
  • gb (Gigabytes)
  • tb (Terabytes)
  • pb (Petabytes)

Capacity values displayed in units other than bytes might be rounded. When filtering on capacity, use a unit of bytes, -unit b, for exact filtering.

Table 1 provides a list of valid filter attributes, as well as descriptions, qualifiers and wildcards for each object type.

You can use the asterisk (*) character as a wildcard character when names are used. The asterisk character can be used either at the beginning or the end of a text string, but not both. Only one asterisk character can be used in a -filtervalue parameter.

Table 1. Valid filter attributes
Object Attribute Valid Qualifiers Wildcard Valid Description
cluster cluster_name or name = Yes The cluster name.
cluster_unique_id or id =, <, <=, >, >= No The cluster ID.
node node_name or name = Yes The node name.
id =, <, <=, >, >= No The node ID.
status = No The status of the node. The following values are valid for node status:
  • adding
  • deleting
  • online
  • offline
  • pending
IO_group_name = Yes The I/O group name.
IO_group_id =, <, <=, >, >= No The I/O group ID.
hardware = No The following values are valid for hardware type: 4F2, 8F2, 8F4, 8G4, CF8, and 8A4.
io_grp HWS_name or name = Yes The I/O group name.
HWS_unique_id or id =, <, <=, >, >= No The I/O group ID.
node_count =, <, <=, >, >= No The number of nodes in the I/O group.
host_count =, <, <=, >, >= No The number of hosts associated with the io_grp.
controller controller_id or id =, <, <=, >, >= No The controller ID.
mdisk name = Yes The name of the MDisk.
id =, <, <=, >, >= No The ID of the MDisk.
controller_name = Yes The name of the controller the MDisk belongs to.
status = No The status of the MDisk.
The following values are valid for MDisk status:
  • online
  • degraded_ports
  • degraded_paths
  • offline
  • excluded
mode = No The mode of the MDisk.
The following values are valid for MDisk mode:
  • unmanaged
  • managed
  • image
mdisk_grp_name = Yes The MDisk group name.
mdisk_grp_id =, <, <=, >, >= No The MDisk group ID.
capacity =, <, <=, >, >= No The capacity. Requires the -unit parameter.
mdiskgrp name = Yes The MDisk group name.
storage_pool_id or id =, <, <=, >, >= No The MDisk group ID.
mdisk_count =, <, <=, >, >= No The number of MDisks in the group.
vdisk_count =, <, <=, >, >= No The number of VDisks in the group.
status = No The status of the MDisk group. The valid input options are online, degraded_ports, degraded_paths, excluded, and offline.
extent_size =, <, <=, >, >= No The extent size. (MB)
vdisk vdisk_name or name = Yes The name of the VDisk.
vdisk_id or id =, <, <=, >, >= No The ID of the VDisk.
IO_group_name = Yes The name of the I/O group.
IO_group_id =, <, <=, >, >= No The ID of the I/O group.
status = No The status of the VDisk.

The valid input options for VDisk status are online, degraded, and offline.

mdisk_grp_name = Yes The MDisk group name.
mdisk_grp_id =, <, <=, >, >= No The MDisk group ID.
capacity =, <, <=, >, >= No The capacity. Requires the -unit argument.
type = No The VDisk type. The valid value options are seq, striped, and image.
FC_name = Yes The FlashCopy® mapping name.
FC_id =, <, <=, >, >= No The FlashCopy mapping ID.
fc_map_count =, <, <=, >, >= No The number of VDisk mappings (either source or target).
copy_count =, <, <=, >, >= No The number of VDisk mirrored copies.
RC_name = Yes The Metro Mirror relationship name.
RC_id =, <, <=, >, >= No The Metro Mirror relationship ID.
vdisk_copy primary = No Indicates that this copy is the primary copy. The valid values are yes and no.
  status = No The status of the MDisk group. Valid values are online, degraded, or offline.
  sync = No Indicates whether the VDisk copy is synchronized. Valid values are true or false.
  mdisk_grp_name = Yes The name of the MDisk group.
  mdisk_grp_id =, <, <=, >, >= No The ID of the MDisk group.
  type = No The type of the VDisk copy. The valid values are seq, striped, or image.
se_vdiskcopy mdisk_grp_id =, <, <=, >, >= No The ID of the MDisk group.
  mdisk_grp_name = Yes The name of the MDisk group.
  overallocation = No The percentage of overallocation, which is displayed as a number.
  autoexpand = No Autoexpand flags. The valid values are on and off.
  grainsize =, <, <=, >, >= No Space-efficient grain size.

The valid values are 32, 64, 128, or 256.

host host_name or name = Yes The host name.
  host_id or id =, <, <=, >, >= No The host ID.
  port_count =, <, <=, >, >= No The number of ports.
  iogrp_count =, <, <=, >, >= No The number of I/O groups that are associated with the host.
fcmap FC_mapping_name or name = Yes The FlashCopy mapping name.
FC_id or id =, <, <=, >, >= No The FlashCopy mapping ID.
source_vdisk_name = Yes The source VDisk name.
source_vdisk_id =, <, <=, >, >= No The source VDisk ID.
target_vdisk_name = Yes The target VDisk name.
target_vdisk_id =, <, <=, >, >= No The target VDisk ID.
group_name = Yes The consistency group name.
group_id =, <, <=, >, >= No The consistency group ID.
status = No The mapping status.
The following values are valid for fcmap status:
  • idle_or_copied
  • preparing
  • prepared
  • copying
  • stopped
  • suspended
  • stopping
  • empty
copy_rate =, <, <=, >, >= No The background copy rate.
fcconsistgrp name = Yes The consistency group name.
FC_group_id or id =, <, <=, >, >= No The consistency group ID.
status = No The consistency group status. The following values are valid for fcconsistgrp status:
  • idle_or_copied
  • preparing
  • prepared
  • copying
  • stopped
  • suspended
  • stopping
  • empty
rcrelationship RC_rel_id or id =, <, <=, >, >= No The Metro Mirror relationship ID.
RC_rel_name or name = Yes The Metro Mirror relationship name.
master_cluster_id =, <, <=, >, >= No The master cluster ID.
master_cluster_name = Yes The master cluster name.
master_vdisk_id =, <, <=, >, >= No The master VDisk ID.
master_vdisk_name = Yes The master VDisk name.
aux_cluster_id =, <, <=, >, >= No The aux cluster ID.
aux_cluster_name = Yes The aux cluster name.
aux_vdisk_id =, <, <=, >, >= No The aux VDisk ID.
aux_vdisk_name = Yes The aux VDisk name.
primary = No The relationship primary. The following values are valid for primary:
  • master
  • aux
consistency_group_id =, <, <=, >, >= No The Metro Mirror consistency group ID.
consistency_group_name = Yes The Metro Mirror consistency group name.
state = Yes The relationship state. The following values are valid for state:
  • inconsistent_stopped
  • inconsistent_copying
  • consistent_stopped
  • consistent_synchronized
  • idling
  • idling_disconnected
  • inconsistent_disconnected
  • consistent_disconnected
progress =, <, <=, >, >= No The progress of the initial background copy (synchronization) for the relationship.
rcconsistgrp group_id or id =, <, <=, >, >= No The consistency group ID.
name = Yes The consistency group name.
master_cluster_id =, <, <=, >, >= No The master cluster ID.
master_cluster_name = Yes The master cluster name.
aux_cluster_id =, <, <=, >, >= No The aux cluster ID.
aux_cluster_name = Yes The aux cluster name.
primary = No The consistency group primary. The following values are valid for primary:
  • master
  • aux
state = No The consistency group state. The following values are valid for state:
  • inconsistent_stopped
  • inconsistent_copying
  • consistent_stopped
  • consistent_synchronized
  • idling
  • idling_disconnected
  • inconsistent_disconnected
  • consistent_disconnected
  • empty
relationship_count =, <, <=, >, >= No The relationship count.
user password = No Specifies if a password is associated with the user. The valid values are yes or no.
ssh_key = No Specifies if a Secure Shell (SSH) public key is associated with the user. The valid values are yes or no.
remote = No Specifies if the user authenticates to the cluster using a remote authentication service. The valid values are yes or no.
usergrp_id =, <, <=, >, >= No The ID of the user group.
usergrp_name = Yes The name of the user group.
usergrp role = No The role associated with all users that belong to this user group. The valid values are Monitor, CopyOperator, Service, Administrator, or SecurityAdmin.
remote = No Specifies if the user group is used to set the role of remote users. The valid values are yes or no.
clusterip port_id =, <, <=, >, >= No The port ID. The valid values are 1 or 2.
cluster_name = Yes The cluster name.
cluster_id =, <, <=, >, >= No The cluster ID.
Library | Support | Terms of use | Feedback
© Copyright IBM Corporation 2003, 2009. All Rights Reserved.