NAME

symconfigure - Allows you to modify Symmetrix devices,

ports, RDF characteristics, and host
assignments and to create or delete
Symmetrix devices, while also managing
hot spares.
Provides SAVE device (SAVEDEV) and DATA
device pool management.
Provides management and support for device
reservations.
Provides a query option to allow monitoring
the progress of a Symmetrix configuration
change.
Provides an abort option for situations
where the host connection to the
configuration server was dropped and left a
configuration change session in progress.
Provides a verify option to determine if
the Symmetrix configuration complies with
the requirements for host-based
configuration changes.
Provides a list option to display
information about the available space on
the physical disks in the Symmetrix array.
Provides support to set disk group names
and reset them back to their default names.
SYNOPSIS
symconfigure -h
symconfigure -sid <SymmID> [-h] [-v]
[-file <CmdFile> | 'redirect stdin' | -cmd "Cmd"]
[-noprompt] [-noecho] [-i <Interval>] [-c <Count>]
[-reserve_id <ResvID>[,<ResvID>[,<ResvID>]]]
[-remote_reserve_id <ResvID>[,<ResvID>[,<ResvID>]]]
preview
prepare
commit
symconfigure -sid <SymmID>
abort -session_id <SessionID>
verify
symconfigure -sid <SymmID> [-i <Interval>] [-c <Count>]
[-session_id <SessionID>] [-v]
query
 symconfigure -sid <SymmID>
<-v | -freespace [-units CYLINDERS | MB] >
list
symconfigure -version [-v] [-sid <SymmID>]
symconfigure -sid <SymmID> [-expire <ExpirationDate>]
[-f[ile] <CmdFile> | 'redirect stdin' | -cmd "Cmd"]
[-noprompt] [-v]
-owner <Owner> -comment "UserComment"
[-enforce | -advise]
reserve
symconfigure -sid <SymmID>
-reserve_id <ResvID>[,<ResvID>[,...]]
[-noprompt]
release
symconfigure -sid <SymmID> -reserved
list
symconfigure -sid <SymmID> -reserve_id <ResvID>
show
COMMAND FILE (or -cmd) SYNTAX
Adding a new device:
create dev count=<n>,
size = <n> [MB | GB | CYL],
emulation=<EmulationType>,
config=<DevConfig>
[, data_member_count=<nn>]
[, remote_config=<DevConfig>,
remote_data_member_count=<nn>,
ra_group=<n>, [remote_mvs_ssid=<nnn>],
[dynamic_capability =
[dyn_rdf | dyn_rdf1_only | dyn_rdf2_only ]]
[, mvs_ssid=<nnn>, ]
[, attribute=<ckd_meta | savedev | datadev>
[in pool=<PoolName>]
[member_state=<ENABLE | DISABLE>] ]
[meta_member_size = <n> [MB | GB | CYL]]
[meta_config = [striped | concatenated]]
[, disk_group=<nnn>| name:<DskGrpName>,
[remote_disk_group=<nnn> | name:<DskGrpName>] ],
[, binding to pool=<PoolName>
[preallocate size = <n> [ MB | GB | CYL]]
[remote_pool=<PoolName>]]],
[, [mapping to dir <DirNum>:<PortNum>
[starting] target = <scsi_target>,
lun=<scsi_lun>, vbus=<fibre_vbus>
[starting] base_address <cuu_address>]...]
[[device_attr =
 [SCSI3_persist_reserv | ACLX]]...];
Adding a new spare device:
create spare count=<n>,
[format = [512 | 520]];
Adding a meta member:
add dev <SymDevName>[:<SymDevName>]
to meta <SymDevName>
[, protect_data=[TRUE | FALSE],
bcv_meta_head=<SymDevName>];
Adding an RDF mirror:
add rdf mirror to dev <SymDevName>[:<SymDevName>]
ra_group=<n>, mirror_type = [RDF1 | RDF2],
remote_dev = <SymDevName>,
invalidate = <invalidate_opt>,
start_copy = [YES | NO]
[,rdf_mode = [sync|semi|acp_wp|acp_disk|async]];
Assigning PAV alias addresses to devices mapped to
EA/EF (mainframe) ports for Enginuity 5671:
add pav alias to dev <SymDevName>[:<SymDevName>],
starting alias=<cuu_address>;
Assigning PAV alias addresses to devices mapped to
EA/EF (mainframe) ports for Enginuity 5771+:
add pav alias to dev <SymDevName>[:<SymDevName>],
alias count=<nnn>;
Assigning a PAV alias address range to a CU image:
add pav alias_range <nnn:nnn>
to mvs_ssid=<nnn>;
Binding thin device to pool:
bind tdev <SymDevName>[:<SymDevName>]
to pool <PoolName>
preallocate size = <n> [MB | GB | CYL];
Configuring a device by copying a similar device:
configure [<n.nn> [MB | GB] | <nn> devices]
copying dev <SymDevName>
[mapping to dir <DirNum>:<PortNum>
[masking hba [awwn=<awwn> | wwn=<wwn> |
iscsi=<iscsi> |
aiscsi=<aiscsi>]
[host_lun=<lun> |
dynamic_lun]]]
[overriding
[size=<nnn> [MB | GB | CYL]]
[emulation=<EmulationType>]
[config=<DevConfig>]
 [data_member_count=<n>]
[mvs_ssid=<nn>]
[disk_group=<n>| name:<DskGrpName>]];
Converting a device's configuration:
convert dev <SymDevName>[:<SymDevName>] to
<DevConfig>
[emulation=CELERRA_FBA,]
[ ra_group=<n>, remote_dev=<SymDevName>,
invalidate=<invalidate_opt>,
[remote_mvs_ssid=<nnn>],
start_copy=<YES | NO> ]
[mvs_ssid=<nnn>] [raidset = [TRUE | FALSE]];
Converting a meta device's configuration:
convert meta <SymDevName>
config=<meta_option>
[, stripe_size=<meta_stripe_size>[cyl]],
[, protect_data=[TRUE | FALSE],
bcv_meta_head=<SymDevName>];
Converting an RDF device from static RDF to dynamic RDF:
convert rdf dev <SymDevName>[:<SymDevName>]
to dynamic;
Deleting a Symmetrix device:
delete dev <SymDevName>[:<SymDevName>]
[, raidset = [TRUE | FALSE]];
Deleting a spare:
delete spare disk =
"["<director_num>, <da_interface>, <scsi_id>"]";
Disabling RDF/A on an RA group:
disable rdfa on ra_group=<nnn>,
delete_support_devices=[TRUE | FALSE];
Dissolving a metadevice:
dissolve meta dev <SymDevName>;
Enabling RDF/A on an RA group:
enable rdfa on ra_group=<nnn>,
make_group_swappable=[TRUE | FALSE];
Forming a metadevice:
form meta from dev <SymDevName>,
config=<meta_option>
[, stripe_size=<meta_stripe_size> [cyl] ]
[, count=<member_count>];
Mapping a device to an address, or a range of devices to
consecutive addresses specifying a starting address:
map dev <SymDevName>[:<SymDevName>]
to dir <DirNum>:<PortNum>,
[starting] [target=<scsi_target>,] lun=<scsi_lun>
[, vbus=<fibre_vbus>]
[, awwn=<awwn> | wwn=<wwn> | iscsi=<iscsi> |
aiscsi=<aiscsi> ]
[, masking [host_lun=<lun> | dynamic_lun] ]
[, emulation=CELERRA_FBA];
Mapping a range of devices to EA/EF (mainframe) ports:
map dev <SymDevName>[:<SymDevName>]
to dir <DirNum>:<PortNum>,
starting base_address=<cuu_address>
[mvs_ssid=<nnn>];
Mapping a range of devices to an EA/EF (mainframe)
port, using the same addressing from a different
port for Enginuity 5671:
map dev <SymDevName>[:<SymDevName>]
to dir <DirNum>:<PortNum>,
copying dir <DirNum>:<PortNum>;
Removing a metamember:
remove dev <SymDevName>[:<SymDevName>]
from meta <SymDevName>;
Removing PAV alias addresses from devices mapped to
EA/EF (mainframe) ports for Enginuity 5671:
remove pav alias
from dev <SymDevName>[:<SymDevName>],
starting alias=<cuu_address>;
Removing PAV alias addresses from devices mapped to
EA/EF (mainframe) ports for Enginuity 5771 or higher:
remove pav alias from dev
<SymDevName>[:<SymDevName>], alias count=<nnn>;
Removing PAV alias address range from a CU image:
remove pav alias_range from mvs_ssid=<nnn>;
Removing an RDF mirror:
remove rdf mirror from
dev <SymDevName>[:<SymDevName>],
ra_group=<n>;
Setting a device's emulation type:
set dev <SymDevName>[:<SymDevName>]
emulation=<EmulationType>;
Setting a device attribute:
 set dev <SymDevName>[:<SymDevName>]
attribute = [NO ]<DevAttr>;
Setting a device geometry:
set dev <SymDevName>[:<SymDevName>]
geometry [= SYMM-6 | = SYMM-7 | = CLARIION]
cyls = <n>;
set dev <SymDevName>[:<SymDevName>]
geometry = <NO GEOMETRY>;
Setting a device identifier:
set dev <SymDevName>[:<SymDevName>]
[device_name='<DevName>' | NO device_name]
[[hp_identifier='<hp_id>' | NO hp_identifier] |
[vms_identifier=<vms_id> | NO vms_identifier]];
Setting port characteristics:
set port <DirNum>:<PortNum>
[ <flag_name>=<ENABLE | DISABLE> [, ...] ]
[[gige] [primary_ip_address=<IPaddress>],
[primary_netmask=<IPaddress>],
[default_gateway=<IPaddress>],
[isns_ip_address=<IPaddress>],
[primary_ipv6_address=<IPaddress>],
[primary_ipv6_prefix=<0-128>],]
[fa_loop_id=<integer>] [hostname=<HostName>];
set port <DirNum>:<PortNum>,
copying port <DirNum>:<PortNum>,
[fa_loop_id=<integer>] [hostname=<HostName>];
Setting an RA (RDF) group parameter:
set [ra | rdf] group <GroupNum>
[session_priority = <SessPriority>] |
[minimum_cycle_time = <CycleTime>] |
[rdfa_transmit_idle = <ENABLE | DISABLE>] |
[rdfa_dse_pool = <PoolName> | <NO POOL>
emulation = [fba | ckd-3390 | ckd-3380 | as400] ] |
[rdfa_dse_threshold = <% of system WP>] |
[rdfa_dse_autostart = <ENABLE | DISABLE>]
[rdfa_wpace_delay = <delay in usecs>]
[rdfa_wpace_threshold = <min % of WP cache>]
[rdfa_wpace_autostart = <ENABLE> | <DISABLE>];

Setting a Symmetrix configuration metric:

set symmetrix
<metric_name> = <metric_value>
[, <metric_name> = <metric_value>];
Swapping an RA group:
swap ra group <nnn>,
 refresh=<refresh_opt>,
start_copy=<YES | NO>;
Unbinding a thin device from a pool:
unbind tdev <SymDevName>[:<SymDevName>]
from pool <PoolName>;
Unmapping a device:
unmap dev <SymDevName>[:<SymDevName>] from dir
< ALL:ALL | ALL:<PortNum> |
<DirNum>:ALL |
<DirNum>:<PortNum> >
[, emulation=CELERRA_FBA]
[, devmask_access = <remove | retain> ];
Unmapping a range of devices from EA or EF
(mainframe) ports:
unmap dev <SymDevName>:[<SymDevName>] from dir
< ALL:ALL | ALL:<PortNum> |
<DirNum>:ALL |
<DirNum>:<PortNum> >
[new_ssid=<nnn>];
Reserving a device:
reserve dev <SymDevName>[:<SymDevName>];
Creating a SNAP or RDFA_DSE or THIN pool:
create pool <PoolName>,
type = <snap | rdfa_dse | thin>
[, max_subs_percent= <n | NONE>];
Deleting a SNAP or RDFA_DSE or THIN pool:
delete pool <PoolName>,
type = <snap | rdfa_dse | thin>;
Setting THIN pool attributes:
set pool <PoolName>,
type = <thin>,
max_subs_percent= <n | NONE>;
Adding a SAVEDEV to SNAP or RDFA_DSE pool or
Adding a DATADEV to a THIN pool:
add dev <SymDevName>[:<SymDevName>] to pool <PoolName>
type = <snap | rdfa_dse | thin>
[, member_state = <ENABLE | DISABLE> ];
Removing a SAVEDEV or DATADEV from a named pool:
(Once removed, the device is available and can be
added to any SNAP or RFDA_DSE or THIN pool.)
remove dev <SymDevName>:[<SymDevName>]
from pool <PoolName>,
 type = <snap | rdfa_dse | thin>;
Enabling a SAVEDEV or DATADEV for use:
enable dev <SymDevName>:[<SymDevName>] in pool
<PoolName>, type = <snap | rdfa_dse | thin>;
Disabling a SAVEDEV or DATADEV from use:
disable dev <SymDevName>:[<SymDevName>] in pool
<PoolName>, type = <snap | rdfa_dse | thin>;
Activating a DATADEV for use:
activate dev <SymDevName>:[<SymDevName>] in pool
<PoolName>, type = <thin>;
Deactivating a DATADEV for use:
deactivate dev <SymDevName>:[<SymDevName>] in pool
<PoolName>, type = <thin>;
Starting allocation on a THIN device:
start allocate on tdev <SymDevName>[:<SymDevName>]
start_cyl = <n>
<end_cyl = <n | last_cyl> |
size = <mmm> MB|GB|CYL>;
Stopping allocation on a THIN device:
stop allocate on tdev <SymDevName>[:<SymDevName>];
Starting free on a THIN device:
start free on tdev <SymDevName>[:<SymDevName>]
start_cyl = <n>
<end_cyl = <n | last_cyl> |
size = <nnn> MB | GB | CYL>
[type = reclaim | unwritten];
Stopping free on a THIN device:
stop free on tdev <SymDevName>[:<SymDevName>]
type = reclaim | unwritten;
Starting drain operation on a DATADEV:
start drain on dev <SymDevName>[:<SymDevName>]
in pool <PoolName> type = <thin>;
Stop drain operation on a DATADEV:
stop drain on dev <SymDevName>[:<SymDevName>]
in pool <PoolName> type = <thin>;
Starting pool balancing operation on a THIN pool:
start balancing on pool <PoolName>;
Stopping pool balancing operation on a THIN pool:
stop balancing on pool <PoolName>
Setting a disk group name:
set disk_group <DiskGrpNumber>,
disk_group_name = <DskGrpName>;
Resetting a disk group name to its default name:
set disk_group <DiskGrpNumber>,
disk_group_name = DEFAULT NAME;
ARGUMENTS
abort Attempts to gain control of an existing
session to abort it and free the
configuration lock. On Enginuity 5874 and
later, if there is more than one session
running, a user can use the -session_id
option to abort a particular session.
commit Activates the changes defined in the
command file into the specified Symmetrix
array.
list Lists the relevant details, depending on
the option:
- When used with -freespace, shows the free
physical disk space within the Symmetrix
array as it can be used to create new
Symmetrix devices for different emulation
modes. Free disk space on unformatted disks
is shown as available for all emulation
modes. If a physical disk has been
partially used to create a device, that
device is considered formatted and the rest
of the available space can only be used for
devices of the same emulation mode.
- When used with -v, displays configuration
information that is not stored in the
SYMAPI database and that needs to be
retrieved directly from the configuration
server.
prepare Verifies the validity of the command file
changes and their appropriateness for the
specified Symmetrix array. The prepare
action has no function for pool sessions.
preview Verifies the validity of the command file
changes.
query Returns information about the status of a
configuration change session. On Enginuity
5874 and higher, if there is more than one
session running, a user can use the
 -session_id option to query a particular
session.
release Releases the specified device reservation.
reserve Processes the command file to reserve
the indicated devices and displays
the resulting reserve ID.
show Shows the details of the specified device
reservation.
verify Verifies that the configuration currently
running in the specified Symmetrix array
complies with the requirements for
host-based configuration changes.
OPTIONS
-advise Marks a device reservation as being an
advisory to all users that the included
devices have been scheduled for a pending
configuration change or device masking
change. Applications may allow the user
to proceed with using these devices.
-c Number (count) of times to attempt the
requested action. If this option is not
specified and an interval (-i) is
specified, the process will loop querying
for status until the session for the
specified Symmetrix array completes. When
used with the preview/prepare/commit
actions, the process will attempt -c number
of times waiting for the database or
configuration locks.
-cmd Specifies the list of commands containing
the configuration change definitions. Each
command must be terminated by a semicolon.
-comment Provides additional details about a device
reservation request.
-enforce Marks a device reservation for enforcement,
by requiring you to supply the device
reservation ID to use the devices. This
is the default behavior when reserving
devices. Older applications may not be
able to process reservation ids.
-expire Sets the date and time for a reservation
to expire, which will cause it to be
removed from the reservation database
automatically.
-f[ile] Specifies the command file containing the
configuration change definitions.
-h Provides brief, online help information.
 -i Specifies the repeat interval for retrying
the requested action. For a query, this
option indicates how often to display the
session's status. For a
preview/prepare/commit, this option
indicates how often to attempt to get the
needed resources to start a new session.
The default interval is 10 seconds. The
minimum interval is 5 seconds.
-noecho Blocks the printing of session status and
progress messages during the configuration
change session. For use with PREVIEW,
PREPARE, and COMMIT actions. Cannot be used
with the -v option.
-noprompt Bypasses the confirmation requests issued
to the output terminal - intended for use
in script files.
-owner Specifies the individual or organization
that owns the devices being reserved. This
is a required field.
-remote_reserve_id
Specifies the identification number assigned
to a reservation on a remote Symmetrix array.
-reserve_id Specifies the identification number assigned
to a reservation.
-sid Identifies the Symmetrix (Symmetrix ID)
configuration to change.
-v Echoes the contents of the command file to
the output terminal. Cannot be used with
the -noecho option.
-version Lists the SYMCLI, SYMAPI, and configuration
server version information. Also connects
to the configuration server managing the
the Symmetrix configuration to request its
version. If a host is connected to more
than one Symmetrix array, the -sid option
is required.
PARAMETERS
CmdFile The name of an ASCII text file containing
the set of commands to process.
ExpirationDate
Date and time for a device reservation
to be expired. Optional - default is no
expiration. Format is:
[mm/dd[/yy]:][hh:mm[:ss]]
If only the hh:mm is provided, the current
 day will be assumed. If only mm/dd is
provided, the current year is assumed. A
four-digit year can also be specified.
ResvID The device reservation ID.
SymmID The 12-character ID of the Symmetrix array.
Owner The name of the owner of the reservation.
UserComment The user comment detailing the device
reservation.