Search
  • Manage Hosts

    PDF

    On this page

    Manage Hosts

    Manage host configurations

    Hosts are the clients or servers in your network that access storage on the system. Host configurations are logical connections through which hosts or applications can access storage resources. Before a host can access storage, you must define a configuration for it and associate it with a storage resource. Create a host configuration for each host, host subnetwork (subnet), or network group (netgroup) that will access storage resources on the system.

    You can create the following types of host configurations:

    • Individual host configurations — Enable you to define and control access to storage resources on a host-by-host basis.
    • Subnet and netgroup configurations — Enable you to define and control access to storage resources for multiple hosts or network segments.

    Each host configuration is identified by an ID.

    The following table lists the attributes for host configurations.

    Table 1. Host configuration attributes
    Attribute
    Description
    ID
    ID of the host configuration.
    Name
    Name of the host configuration.
    Description
    Brief description of the host configuration.
    Tenant
    Tenant with which the host is associated.
    Address
    Hostname or IP address associated with the host, IP address of the subnet, or name of the netgroup.
    Note:  This information is required when connecting hosts to network shares on the system.
    Netmask
    Subnet mask for the host.
    Type
    Type of host configuration. Value is one of the following:
    • host — A host defines and controls access to storage resources on a host-by-host basis.
    • subnet — A subnet is a logical grouping of connected network devices. Devices on a subnet share contiguous ranges of IP addresses. A subnet mask, or network mask, defines the boundaries of an IP subnet.

      You can associate a host configuration with a subnet mask to define and control storage access for hosts on a particular network segment.

    • netgroup — A netgroup is a named sets of hosts, users, or domains on a network. A netgroup can provide a way to reference sets of Linux/UNIX hosts collectively for accessing storage over NFS.

      You can create a host configuration for a netgroup to define and control storage access for multiple Linux/UNIX hosts or users through a single configuration.

    Note:  Typically, netgroups are accessible only through NIS. If NIS is not running, netgroups are not defined. Manage NIS server domains explains how to configure NIS server communication.
    OS type
    Type of operating system (OS) running on the host. You can enter any value you want. Here are suggestions for some of the common operating systems:
    • undefined — OS is not specified (default) or unknown.
    • other — Other.
    • win2003srv — Windows Server 2003.
    • winxp — Windows XP.
    • win2008srv — Windows Server 2008.
    • winvista — Windows Vista.
    • win2012srv — Windows Server 2012.
    • esx — VMware ESX.
    • redhat — Red Hat Enterprise Linux.
    • sles — SUSE Linux Enterprise.
    • win7 — Windows 7.
    • hyperv — Microsoft Hyper-V.
    • solaris — Solaris.
    Ignored address
    A comma-separated list of host IP addresses to exclude from data access.
    Health state
    Health state of the host. The health state code appears in parentheses. Value is one of the following:
    • Unknown (0) — Status is unknown.
    • OK (5) — Working correctly.
    • OK BUT (7) — Working correctly, but there could be a problem.
    • Degraded/Warning (10) — Working and performing all functions, but the performance may not be optimum.
    • Minor failure (15) — Working and performing all functions but overall performance is degraded. This condition has a minor impact on the system and should be remedied at some point, but does not have to be fixed immediately.
    • Major failure (20) — Failing and some or all functions may be degraded or not working. This condition has a significant impact on the system and should be remedied immediately.
    • Critical failure (25) — Failed and recovery may not be possible. This condition has resulted in data loss and should be remedied immediately.
    • Non-recoverable error (30) — Completely failed and cannot be recovered.
    Health details
    Additional health information. See Appendix A, Reference, for health information details.
    Management type
    Indicates the way the host is managed. Value is one of the following:
    • VMware — The host is managed through VMware web services.
    • Other — The host is automatically created on the storage system.
    • Manual — The host is created manually.
    Accessible LUNs
    A comma-separate list of LUNs that are accessible to the host.
    Host LUN IDs
    Comma-separated list of HLUs (Host LUN identifiers), which the corresponding hosts use to access the LUN.

    Create host configurations

    Create a host configuration to establish a connection between the system and hosts that access the system.

    Format
    /remote/host create -name <value> [-descr <value>] [-tenant <value>] -type {host [-addr <value>] [-ignoredAddr <value>] [-osType <value> ] | subnet -addr <value> [-netmask <value>] | netgroup -addr <value>}
    Action qualifier
    Qualifier
    Description
    -name
    Specifies the name of the host configuration.
    -descr
    Specifies a brief description of the host configuration.
    -type
    Specifies the type of host configuration. Value is one of the following:
    • host — A host defines and controls access to storage resources on a host-by-host basis.
    • subnet — A subnet is a logical grouping of connected network devices. Devices on a subnet share contiguous ranges of IP addresses. A subnet mask, or network mask, defines the boundaries of an IP subnet.

      You can associate a host configuration with a subnet mask to define and control storage access for hosts on a particular network segment.

    • netgroup — A netgroup is a named sets of hosts, users, or domains on a network. A netgroup can provide a way to reference sets of Linux/UNIX hosts collectively for accessing storage over NFS.

      You can create a host configuration for a netgroup to define and control storage access for multiple Linux/UNIX hosts or users through a single configuration.

    Note:  Typically, netgroups are only accessible through NIS. If NIS is not running, netgroups are not defined. Manage NIS server domains explains how to configure NIS server communication.
    -tenant
    Specifies the identifier of the tenant with which the host is to be associated.
    Note:   If not specified, the host is created in the default network namespace and the tenant attribute will be blank.
    -addr
    Specifies the hostnames or IP addresses associated with the host, IP addresses of the subnet, or the name of the netgroup. Separate each value with a comma.
    • Format: <IP address>/[<prefix length>].
    • Default prefix length for IPv4 addresses is 24 and for IPv6 addresses is 64.
    Note:  This information is required when connecting hosts to network shares on the system.
    -ignoredAddr
    Specifies a list of IP addresses associated with the host that are excluded from data access. Separate each value with a comma.
    -netmask
    Specifies the subnet mask for the host configuration.
    -osType
    Specify the type of operating system (OS) running on the host. You can enter any value you want. Here are suggestions for some of the common operating systems:
    • undefined — OS is not specified (default) or unknown.
    • other — Other.
    • win2003srv — Windows Server 2003.
    • winxp — Windows XP.
    • win2008srv — Windows Server 2008.
    • winvista — Windows Vista.
    • win2012srv — Windows Server 2012.
    • esx — VMware ESX.
    • redhat — Red Hat Enterprise Linux.
    • sles — SUSE Linux Enterprise.
    • win7 — Windows 7.
    • hyperv — Microsoft Hyper-V.
    • solaris — Solaris.
    Example 1

    The following command creates a host configuration for a host with these settings:

    • Name is MyHost.
    • Description is “accounting”.
    • IP address is 10.64.74.10.
    • OS is Windows XP.

    The host configuration receives ID Host_1014:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/host create –name MyHost –descr “accounting” -type host –addr 10.64.74.10 -osType winxp 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = Host_1014
Operation completed successfully.
    Example 2

    The following command creates a host configuration for a subnet with these settings:

    • Name is MySubnet.
    • Description is “subnet1”.
    • IP address is 192.168.10.0.
    • Subnet mask is 255.255.255.0.

    The host configuration receives ID Subnet_1015:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/host create –name MySubnet –descr “subnet1” -type subnet –addr 192.168.10.0 –netmask 255.255.255.0 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = Subnet_1015
Operation completed successfully.
    Example 3

    The following command creates a host configuration for a subnet with these settings:

    • Name is IPv6Subnet.
    • Description is “V6_HE_Subnet”.
    • IPv6 address is 2001:db8:c25:
    • Prefix length is 48.

    The host configuration receives ID NetGroup_1023:

    uemcli -d 10.0.0.1 /remote/host create -name IPv6Subnet -descr "V6_HE_Subnet" -type subnet -addr 2001:db8:c25::/48 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = NetGroup_1023
Operation completed successfully.

    View host configurations

    View details about a host configuration. You can select the ID of the host configuration or the host type.

    Note:   The show action command explains how to change the output format.
    Format
    /remote/host [{{-id <value> | -name <value>} | -type {host | subnet | netgroup}}] show
    Object qualifier
    Qualifier
    Description
    -id
    Specify the host ID.
    -name
    Specify the host name.
    -type
    Specifies the host type. Valid values are:
    • host
    • subnet
    • netgroup
    Example

    The following command lists all host configurations on the system:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/host show -brief 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection
 
1:     ID              = 1014
       Name            = MyHost
       Description     = this is my host
       Tenant          = tenant_3
       Type            = host
       Address         = 10.64.74.10, 10.64.80.10
       Netmask         =
       OS type         = winxp
       Ignored address = 10.64.80.10
       Health state    = OK (5)

2:     ID              = 1015
       Name            = MySubnet
       Description     = this is my subnet
       Tenant          = 
       Type            = subnet
       Address         = 192.168.10.0
       Netmask         = 255.255.255.0
       OS type         =
       Ignored address =
       Health state    = OK (5)

    Change host configuration settings

    Change the settings for a host configuration.

    Format
    /remote/host {-id <value> | -name <value>} set [-name <value>] [-descr <value>] [-addr <value>] [-ignoredAddr <value>] [-netmask <value>] [-osType <value>] [-addLuns <value> [-hlus <value> ]] [-removeLuns <value>]
    Object qualifier
    Qualifier
    Description
    -id
    ID of the host configuration to change.
    -name
    Name of the host configuration to change.
    Action qualifier
    Qualifier
    Description
    -name
    Specifies the new name for the host configuration.
    -desc
    Specifies the new description of the host configuration.
    -addr
    Specifies the hostnames or IP addresses associated with the host, IP addresses of the subnet, or the network addresses of the netgroup. Separate each value with a comma.
    • For subnet type, specifies the new IP address of the subnet.
    • For netgroup, specifies the new netgroup's name.
    • Format: <IP address>/[<prefix length>].
    • Default prefix length for IPv4 addresses is 24 and for IPv6 addresses is 64.
    Note:  This information is required when connecting hosts to network shares on the system.
    -ignoredAddr
    Specifies a list of IP addresses associated with the host that are excluded from data access. Separate each value with a comma.
    -netmask
    Specify the subnet mask for the host configuration.
    -osType
    Specify the type of operating system (OS) running on the host. You can enter any value you want. Here are suggestions for some of the common operating systems:
    • undefined — OS is not specified or unknown.
    • other — Other.
    • win2003srv — Windows Server 2003.
    • winxp — Windows XP.
    • win2008srv — Windows Server 2008.
    • winvista — Windows Vista.
    • win2012srv — Windows Server 2012.
    • esx — VMware ESX.
    • redhat — Red Hat Enterprise Linux.
    • sles — SUSE Linux Enterprise.
    • win7 — Windows 7.
    • hyperv — Microsoft Hyper-V.
    • solaris — Solaris.
    -addLuns
    Specify a comma-separated list of LUN friendly IDs for LUNs to add to the host.
    -hlus
    Specifies the comma-separated list of Host LUN identifiers to be used by the corresponding hosts which were specified in the -lunHosts option. The number of items in the two lists must match. However, an empty string is a valid value for any element of the Host LUN identifiers list, as long as commas separate the list elements. Such an empty element signifies that the system should automatically assign the Host LUN identifier value by which the corresponding host will access the LUN.

    If not specified, the system will automatically assign the Host LUN identifier value for every host specified in the -lunHosts argument list.

    -removeLuns
    Specify a comma-separated list of LUN friendly IDs for LUNs to remove from the host.
    Example

    The following command updates the description of host configuration 1014 to indicate that it now holds the payroll database:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/host –id 1014 set -descr “Accounting” –osType winxp 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = 1014
Operation completed successfully.

    Delete host configurations

    Delete a host configuration.

    NOTICE  Deleting a host configuration breaks the block-based (Fibre Channel or iSCSI) storage connections associated with the configuration. Hosts that use the configuration for NFS-based storage connections, such as NFS shares, revert to the default access privileges for any storage resources that they can access.
    Format
    /remote/host {-id <value> | -name <value>} delete
    Object qualifier
    Qualifier
    Description
    -id
    ID of the host configuration to delete.
    -name
    Name of the host configuration to delete.
    Example

    The following command deletes host configuration 1014:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/host –id 1014 delete 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

Operation completed successfully.

    Manage host LUNs

    Host LUNs are the storage resources that belong to the hosts connected to the storage system.

    There are two types of host LUNs:

    • Production LUNs— Read/write LUNs used for data access.
    • Snapshot LUNs — Read-only and read/write snapshots of a production LUN.

    Each host LUN is identified by an ID.

    The following table lists the attributes for host LUNs.

    Table 2. Host LUN attributes
    Attribute
    Description
    ID
    Unique identifier of the host LUN (HLU).
    Host
    ID of the host that owns the LUN.
    Host name
    Name of the host that owns the LUN.
    LUN
    Friendly ID of the LUN.
    LUN name
    LUN name.
    Snapshot
    Snapshot ID of a LUN or consistency group.
    Snapshot name
    Snapshot name of a LUN or consistency group.
    LUN ID
    Logical unit number on the host, or the host LUN ID.
    Access
    Access permission for the host. Valid values are:
    • read-only
    • read/write
    LUN type
    LUN type. Valid values are:
    • snap
    • production

    View host LUN configurations

    View details about a host LUN. You can filter on the ID of the host, the ID of the LUN, or the LUN type.

    Note:   The show action command explains how to change the output format.
    Format
    /remote/host/hlu { -id <value> | -host <value> | -hostName <value> | -lun <value> | -lunName <value> | { -host <value> | -hostName <value> } { -lun <value> | -lunName <value> } } [-type { production | snap } ] show
    Object qualifier
    Qualifier
    Description
    -id
    Specifies the host LUN ID.
    -host
    Specifies the host ID.
    -hostName
    Specifies the host name.
    -lun
    Specifies the LUN ID.
    -lunName
    Specifies the LUN name.
    -type
    Specifies the LUN type.
    Example

    The following command lists all host LUNs on host Host_3:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/host/hlu -host Host_3 show -detail 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

1:    ID            = Host_3_sv_2_prod
      Host          = Host_3
      Host name     = 10.0.0.2
      LUN           = sv_2
      LUN name      = joeslun
      Snapshot      =
      Snapshot name =
      LUN ID        = 1
      Access        = Read/write
      LUN type      = Production

    Change host LUN configuration settings

    Change the host LUN ID.

    Note:  This operation will fail if you try to assign a LUN ID that is already in use.
    Format
    /remote/host/hlu {-id <value>} set –lunid <value>
    Object qualifier
    Qualifier
    Description
    -id
    Specifies the HLU.
    Action qualifier
    Qualifier
    Description
    -lunid
    Specifies the new LUN ID for the LUN on the selected host.
    Example

    The following command changes the ID Host_3_sv_2_prod to LUN 0:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/host/hlu -id Host_3_sv_2_prod set –lunid 0 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

Operation completed successfully.

    Manage host initiators

    After you create a host configuration for controlling host access to storage on the system, you need to create one or more initiators for each host configuration that accesses the storage system. Each initiator represents the initiator on the host, which will connect to the storage system. There are two types of initiators, Fibre Channel (FC) and iSCSI.

    A FC initiator contains the WWN of an HBA on the host. This WWN is not the WWN of the host.

    An iSCSI initiator contains the IQN (iSCSI Qualified Name) used by the host, and optionally the CHAP authentication password associated with the host. Manage reverse CHAP for mutual CHAP authentication explains how to configure reverse (two-way) CHAP authentication on the system.

    Each initiator is identified by an ID.

    The following table lists the attributes for initiators.

    Table 3. Initiator attributes
    Attribute
    Description
    ID
    Host initiator ID.
    Host
    Name of the parent host.
    UID
    FC WWN or iSCSI IQN of the initiator.
    Initiator type
    The type of initiator. Value is one of the following:
    • FC
    • iSCSI
    Ports logged in
    Comma-separated list of array target ports that the initiator is logged into.
    Ignored
    Indicates whether the initiator is ignored for data access to the host. Value is one of the following:
    • Yes — The initiator is ignored.
    • No — The initiator is not ignored.
    Health state
    Health state of the system. The health state code appears in parentheses. Value is one of the following:
    • Unknown (0) — Status is unknown.
    • OK (5) — Working correctly.
    • OK BUT (7) — Working correctly, but there could be a problem.
    • Degraded/Warning (10) — Working and performing all functions, but the performance may not be optimum.
    • Minor failure (15) — Working and performing all functions but overall performance is degraded. This condition has a minor impact on the system and should be remedied at some point, but does not have to be fixed immediately.
    • Major failure (20) — Failing and some or all functions may be degraded or not working. This condition has a significant impact on the system and should be remedied immediately.
    • Critical failure (25) — Failed and recovery may not be possible. This condition has resulted in data loss and should be remedied immediately.
    • Non-recoverable error (30) — Completely failed and cannot be recovered.
    Health details
    Additional health information. See Appendix A, Reference, for health information details.
    CHAP users
    List of CHAP accounts configured for the initiator.
    Source type
    The source initiator type. Values are:
    • HPAutotrespass - HP with Auto-trespass
    • OpenNative (default) - Open native (such as CLARiiON Open)
    • SGI - Silicon Graphics
    • HPNoAutotrespass- HP without Auto-trespass
    • Dell
    • FujitsuSiemens
    • Tru64- Compaq Tru64
    Failover mode
    The failover mode for the initiator. Values are:
    • AutoTrespass- Any media access to the non owning SP is rejected.
    • PassiveNotReady- A command failure during I/O is sent to the non-owning SP.
    • DMP- Quiet trespass on I/O to non owning SP.
    • PassiveAlwaysReady- Some commands, e.g. Test Unit Ready, returns PAR status.
    • ALUA(default) - Initiators are permitted to send I/O to a LUN regardless of which SP actually owns the LUN.
    LUNZ enabled
    Specifies whether LUNZ is enabled. Values are:
    • yes
    • no
    Unit serial number
    Indicates the unity serial number. Values are:
    • Array (default)
    • LUN

    For SCSI-3 interfaces, the Unity Serial Number page (Vital Product Data page 0x80) reports the serial number for the array or LUN.

    Create initiators

    Create an FC or iSCSI initiator and assign it to a host configuration.

    Format
    /remote/initiator create –host <value> -uid <value> -type {iscsi|fc} [-sourceType {HPAutotrespass | OpenNative | SGI | HPNoAutotrespass | Dell | FujitsuSiemens | Tru64}] [-failoverMode {AutoTrespass | PassiveNotReady | DMP | PassiveAlwaysReady | ALUA}] [-lunzEnabled {yes | no}] [-unitSerialNumber {Array | LUN}]
    Object qualifier
    Qualifier
    Description
    -host
    Identifies the host configuration to which to assign the initiator. View host configurations explains how to view the IDs of host configurations on the system.
    -uid
    Specifies the FC WWN or the iSCSI IQN of the host to which to assign the initiator.
    -type
    Specifies the type of initiator. Value is one of the following:
    • iscsi
    • fc
    -sourceType
    Specify the source type for the initiator. Valid values are:
    • HPAutotrespass - HP with Auto-trespass
    • OpenNative (default) - Open native (such as CLARiiON Open)
    • SGI - Silicon Graphics
    • HPNoAutotrespass- HP without Auto-trespass
    • Dell
    • FujitsuSiemens
    • Tru64- Compaq Tru64
    -failoverMode
    Specify the failover mode for the initiator. Valid values are:
    • AutoTrespass- Any media access to the non owning SP is rejected.
    • PassiveNotReady- A command failure during I/O is sent to the non-owning SP.
    • DMP- Quiet trespass on I/O to non owning SP.
    • PassiveAlwaysReady- Some commands, e.g. Test Unit Ready, returns PAR status.
    • ALUA (default) - Initiators are permitted to send I/O to a LUN regardless of which SP actually owns the LUN.
    -lunzEnabled
    Set whether LUNZ will be enabled. Valid values are:
    • yes (default)
    • no
    -unitSerialNumber
    Specify the Unit Serial Number. Valid values are:
    • Array (default)
    • LUN

    For SCSI-3 interfaces, the Unity Serial Number page (Vital Product Data page 0x80) reports the serial number for the array or LUN.

    Example 1

    The following command creates an FC initiator for host configuration 1014. The FC initiator receives ID 1021:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/initiator create -host 1014 -uid "20:00:00:00:C9:29:0F:FD:10:00:00:00:C9:29:0F:FD" -type fc 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection
 
ID = 1021
Operation completed successfully.
    Example 2

    The following command creates an iSCSI initiator for host configuration Host_3. The iSCSI initiator receives ID 1022:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! -sslPolicy accept /remote/initiator create -host Host_3 iqn.1000-05.com.fancy:win-123456 -type iscsi 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection
 
ID = 1022
Operation completed successfully.
    Example 3

    The following command creates an iSCSI initiator for "Host_3" with:

    • A source type of "OpenNative"
    • A failover mode of "PassiveAlwaysReady"
    • LUNZ disabled
    • And an "Array" Unit Serial Number
    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/initiator create -host Host_3 -uid iqn.1993-08.com.microsoft:win -type iscsi -sourceType OpenNative -failoverMode PassiveAlwaysReady -lunzEnabled no -unitSerialNumber Array 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = HostInitiator_8
Operation completed successfully.

    View initiators

    View a list of initiators. You can filter on the initiator ID, host ID, or whether the initiator is registered.

    Format
    /remote/initiator [{-id <value> | -host <value> | -unregistered}] show
    Object qualifier
    Qualifier
    Description
    -id
    Identifies the initiator.
    -host
    Type the ID of a host configuration to view the initiators assigned to the host configuration.
    -unregistered
    Specifies unregistered initiators.
    Example

    The following command lists the details of all initiators on the system:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/initiator show 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

1: ID                  = HostInitiator_7 
   Host                = Host_4
   UID                 = iqn.1991-05.com.microsoft:cnenfanw4l1c.corp.emc.com
   Initiator type      = iscsi
   Ports logged in     = spb_eth2,spa_eth2 
   Ignored             = no
   Health State        = OK (5)
   Health Details      = "The component is operating normally. No action is required."
   CHAP users          =
   Source type         = Open_Native
   Failover mode       = ALUA
   LUNZ                = yes
   Unit serial number  = Array

    Change initiator settings

    Modify an already created initiator.

    Format
    /remote/initiator -id <value> set [-ignored {yes | no}] [-host <value>] [-sourceType {HPAutotrespass | OpenNative | SGI | HPNoAutotrespass | Dell | FujitsuSiemens | Tru64}] [-failoverMode {AutoTrespass | PassiveNotReady | DMP | PassiveAlwaysReady | ALUA}] [-lunzEnabled {yes | no}] [-unitSerialNumber {Array | LUN}]
    Object qualifier
    Qualifier
    Description
    -id
    Specifies the ID of the initiator
    Action qualifier
    Qualifier
    Description
    -ignored
    Specifies whether the initiator is ignored for data access to the host. Valid values are:
    • yes — The initiator is ignored.
    • no — The initiator is not ignored.
    -host
    Identifies the host configuration to which the initiator is assigned. View host configurations explains how to view the IDs of host configurations on the system.
    -sourceType
    Specify the source type for the initiator. Valid values are:
    • HPAutotrespass — HP with Auto-trespass
    • OpenNative — Open native (such as CLARiiON Open)
    • SGI — Silicon Graphics
    • HPNoAutotrespass — HP without Auto-trespass
    • Dell
    • FujitsuSiemens
    • Tru64 — Compaq Tru64
    -failoverMode
    Specify the failover mode for the initiator. Valid values are:
    • AutoTrespass — Any media access to the non owning SP is rejected.
    • PassiveNotReady — A command failure during I/O is sent to the non-owning SP.
    • DMP — Quiet trespass on I/O to non owning SP.
    • PassiveAlwaysReady — Some commands, e.g. Test Unit Ready, returns PAR status.
    • ALUA — Initiators are permitted to send I/O to a LUN regardless of which SP actually owns the LUN.
    -lunzEnabled
    Set whether LUNZ will be enabled. Valid values are:
    • yes
    • no
    -unitSerialNumber
    Specify the Unit Serial Number. Valid values are:
    • Array
    • LUN

    For SCSI-3 interfaces, the Unity Serial Number page (Vital Product Data page 0x80) reports the serial number for the array or LUN.

    -force
    Specify to bypass the validation of setting a new host when there are already storage resources associated with the host and attached to the initiator.

    If you want to delete a stale initiator for which the associated host has LUN access and as such those LUNs cannot be deleted, you will need to ignore the associated host by setting the stale initiator to an empty host with this -force option.

    Example

    The following command changes the source type, failover mode, LUNZ settings, and Unit Serial Number of the initiator:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/initiator -id HostInitiator_6 set -sourceType HPAutotrespass -failoverMode PassiveNotReady -lunzEnabled yes -unitSerialNumber Array 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

Operation completed successfully.

    Manage host initiator paths

    The storage system communicates with a host initiator over a host initiator path. The storage system uses this path to identify the host initiator configuration information.

    The following table lists the attributes for a host initiator path.

    Table 4. Initiator path attributes
    Attribute
    Description
    Initiator
    Parent initiator.
    Port
    The ID of the target port.
    Logged in
    Indicates whether the initiator path is logged in. Value is one of the following:
    • Yes
    • No
    Host
    The host ID to which the initiator path is registered. No value in this field means the initiator is not registered to a host.
    Note:  This host ID may be different from that of the initiator when auto-push registration and initiator registration information are not the same. This causes the storage system to generate an alert.
    Registration method
    Indicates how the initiator path is registered. Value is one of the following:
    • Unknown — The initiator was registered by a method other than ESX push.
    • ESX — ESX pushed the initiator registration to the storage system.
    Session IDs
    Comma-separated list of the session IDs for this path.
    Health state
    Health state of the system. The health state code appears in parentheses. Value is one of the following:
    • Unknown (0) — Status is unknown.
    • OK (5) — Working correctly.
    • OK BUT (7) — Working correctly, but there could be a problem.
    • Degraded/Warning (10) — Working and performing all functions, but the performance may not be optimum.
    • Minor failure (15) — Working and performing all functions but overall performance is degraded. This condition has a minor impact on the system and should be remedied at some point, but does not have to be fixed immediately.
    • Major failure (20) — Failing and some or all functions may be degraded or not working. This condition has a significant impact on the system and should be remedied immediately.
    • Critical failure (25) — Failed and recovery may not be possible. This condition has resulted in data loss and should be remedied immediately.
    • Non-recoverable error (30) — Completely failed and cannot be recovered.
    Health details
    Additional health information. See Health details, for health information details.

    View initiator paths

    View a list of initiators. You can filter on the initiator ID.

    Note:   The show action command explains how to change the output format.
    Format
    /remote/initiator/path [–initiator <value>] show
    Object qualifier
    Qualifier
    Description
    -initiator
    Type the ID of the initiator to display the paths associated with it.
    Example

    The following command lists all initiator paths on the system:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/initiator/path show 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

1:     Initiator           = 1043
       Port                = eth1_SPB
       Logged in           = Yes
       Registration method = ESX
       Host                = 1014
       Health state        = OK (5)

    Manage iSCSI CHAP accounts for one-way CHAP authentication

    The system uses a CHAP account to authenticate a host (initiator) attempting to access an iSCSI storage resource (target). CHAP authentication can be one of the following:

    • One-way, where only the target authenticates the initiator. To set one-way CHAP authentication, create a CHAP account for a host configuration that access iSCSI storage.
    • Reverse (also called mutual or two-way), where the target and initiator authenticate each other. Compared to one-way CHAP, enabling reverse CHAP provides an extra level of security. To set reverse CHAP, specify a reverse secret password. Manage reverse CHAP for mutual CHAP authentication explains how to configure reverse CHAP authentication.

    Each CHAP account is identified by an ID.

    The following table lists the attributes for CHAP accounts.

    Table 5. CHAP Account Attributes
    Attribute
    Description
    ID
    ID of the CHAP account.
    IQN
    IQN address of the host (initiator).
    Wildcard
    Whether this is wildcard CHAP, where all initiators can be authenticated by the storage system. Valid values are:
    • yes — All initiators can be authenticated by the storage system.
    • no — Authentication is on a per initiator basis.
    Username
    CHAP username.
    Secret
    CHAP secret password.
    Secret format
    The CHAP input format. Valid values are:
    • ascii — ASCII format
    • hex — Hexadecimal format

    Create iSCSI CHAP accounts

    Create an iSCSI CHAP account for a host (initiator).

    Format
    /remote/iscsi/chap create {-iqn <value> | -wildcard} [-username <value>] {-secret <value> | -secretSecure} [ -secretFormat { ascii | hex } ]
    Object qualifier
    Qualifier
    Description
    -iqn
    Specifies the IQN address of the host (initiator).
    -wildcard
    Specifies whether this is a wildcard CHAP, where all initiators can be authenticated by the storage system.
    -username
    Specifies the CHAP username.
    -secret
    Specifies the CHAP secret password.
    -secretSecure
    Specifies the CHAP secret in secure mode - the user will be prompted to input the password.
    -secretFormat
    Specifies the CHAP input format. Valid values are:
    • ascii(default) — ASCII format
    • hex — Hexadecimal format
    Example

    The following command creates an iSCSI CHAP account for a host. It receives the ID CHAP_1:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/iscsi/chap create –iqn iqn.1991-05.com.microsoft:cpc7745 -secret opqrstuvwxyz 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = CHAP_1
Operation completed successfully.

    View iSCSI CHAP accounts

    View details about iSCSI CHAP accounts on the system.

    Note:   The show action command explains how to change the output format.
    Format
    /remote/iscsi/chap [-id <value>] show
    Object qualifier
    Qualifier
    Description
    -id
    Identifies the iSCSI CHAP account.
    Example

    The following command displays all iSCSI CHAP accounts on the system:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/iscsi/chap show 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

1:     ID       = CHAP_1
       IQN      = iqn.1991-05.com.microsoft:cpc7745
       Wildcard = no
       Username = iqn.1991-05.com.microsoft:cpc7745

2:     ID       = CHAP_2
       IQN      = 
       Wildcard = yes
       Username = globalChapUserName

    Change iSCSI CHAP account settings

    Change the settings for an iSCSI CHAP account, such as the secret password.

    Format
    /remote/iscsi/chap -id <value> set [-username <value>]{-secret <value> | -secretSecure} [ -secretFormat { ascii | hex } ]
    Object qualifier
    Qualifier
    Description
    -id
    Identifies the iSCSI CHAP account to change.
    Action qualifier
    Qualifier
    Description
    -username
    Specifies the CHAP username.
    -secret
    Specifies the CHAP secret password.
    -secretSecure
    Specifies the CHAP secret in secure mode - the user will be prompted to input the password.
    -secretFormat
    Specifies the CHAP input format. Value is one of the following:
    • ascii — ASCII format
    • hex — Hexadecimal format
    Example

    The following command updates the secret password for iSCSI CHAP account CHAP_1:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/iscsi/chap –id CHAP_1 set -secret abcdef123456 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

Operation completed successfully.

    Delete iSCSI CHAP accounts

    Delete an iSCSI CHAP account.

    Note:  If you delete an iSCSI CHAP account, the host that used it will no longer be authenticated when attempting to access iSCSI storage.
    Format
    /remote/iscsi/chap -id <value> delete
    Object qualifier
    Qualifier
    Description
    -id
    Type the ID of the CHAP account to delete.
    Example

    The following command deletes iSCSI CHAP account CHAP_1:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/iscsi/chap –id CHAP_1 delete 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

Operation completed successfully.

    Manage iSCSI connections

    Identifies iSCSI connections between destination SPs and arrays to the source system that are required to create iSCSI connection paths.

    Note:  Only one iSCSI connection can be created at a time. Therefore, only one source system can be managed for one migration operation. If a migration operation is already completed, you must create a new iSCSI connection with new paths.

    The following table lists the attributes for iSCSI connections.

    Table 6. iSCSI connection Attributes
    Attribute
    Description
    ID
    ID of the iSCSI connection.
    Name
    Name of the iSCSI connection.
    Description
    Description of the iSCSI connection.

    Create an iSCSI connection

    Create an iSCSI connection.

    Note:  Only one iSCSI connection can be created at a time. Therefore, only one source system can be managed for one migration operation. If a migration operation is already completed, you must create a new iSCSI connection with new paths.
    Format
    /remote/iscsi/connection create -name <value> [-descr <value>] [-async]
    Action qualifiers
    Qualifier
    Description
    -name
    Specifies the iSCSI connection name.
    -descr
    Specifies the iSCSI connection description.
    -async
    Run the operation in asynchronous mode.
    Example

    The following command creates an iSCSI connection.

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/iscsi/connection create –name myConn –descr "Connection for lun_1 importing" 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = iscsi_conn_1
Operation completed successfully.

    View iSCSI connection settings

    View details for existing iSCSI connections.

    Format
    /remote/iscsi/connection [{-id <value> | -name <value>}] show
    Object qualifiers
    Qualifier
    Description
    -id
    Type the ID of the iSCSI connection.
    -name
    Type the unique name of the iSCSI connection.
    Example

    This example shows all iSCSI connections.

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/iscsi/connection show -detail 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

1:    ID                          = iscsi_conn_1
      Name                        = Old Array 
      Description                 = LUN 1 import

    Change iSCSI connection settings

    Change the current iSCSI connection settings.

    Format
    /remote/iscsi/connection {–id <value> | -name <value>} set -descr <value> [-async]
    Object qualifiers
    Qualifier
    Description
    -id
    Type the ID of the iSCSI connection.
    -name
    Type the unique name of the iSCSI connection.
    Action qualifiers
    Qualifier
    Description
    -descr
    Type the iSCSI connection description.
    -async
    Run the operation in asynchronous mode.
    Example

    The following command changes the description for the iSCSI connection.

    uemcli uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/iscsi/connection –id iscsi_conn_1 set -descr copyconnection 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

Operation completed successfully.

    Delete an iSCSI connection

    Deletes an existing iSCSI connection.

    Note:  When you delete an iSCSI connection, any iSCSI connection paths associated with the iSCSI connection are also deleted.
    Format
    /remote/iscsi/connection {–id <value> | -name <value>} delete [-async]
    Object qualifiers
    Qualifier
    Description
    -id
    Type the ID of the iSCSI connection you want to delete.
    -name
    Type the unique name of the iSCSI connection you want to delete.
    Action qualifier
    Qualifier
    Description
    -async
    Run the operation in asynchronous mode.
    Example

    The following command deletes the "iscsi_conn_1" iSCSI connection.

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/iscsi/connection –id iscsi_conn_1 delete 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

Operation completed successfully.

    Manage iSCSI connection paths

    The connection iSCSI path to a remote system includes IP address, TCP port, and a list of iSCSI interfaces on the storage system from which outgoing iSCSI connections are established. An iSCSI connection can have one or more iSCSI paths configured.

    Note:  If the source system has an iSCSI address which contains CHAP credentials, you must remove the CHAP credentials from the iSCSI address before migration, and then restore the CHAP credentials once migration is complete.

    The following table lists the attributes for iSCSI connection paths.

    Table 7. iSCSI connection path Attributes
    Attribute
    Description
    Index
    Number of the iSCSI path within the iSCSI connection.
    iSCSI connection
    ID of the iSCSI connection.
    iSCSI connection name
    Name of the iSCSI connection.
    iSCSI path description
    Description of the iSCSI path.
    Remote iSCSI address
    IP address of the iSCSI destination on the remote system.
    Remote iSCSI port
    TCP port of the iSCSI destination on the remote system.
    Local iSCSI interfaces
    List of identifiers of the iSCSI interfaces on the local storage system.

    Create an iSCSI connection path

    Creates a new iSCSI path and adds it to a specified iSCSI connection.

    Format
    /remote/iscsi/connection/path create {-connection <value> | -connectionName <value>} [-descr <value>] -addr <value> [-port <value>] –if <value> [-async]
    Action qualifiers
    Qualifier
    Description
    -connection
    Type the ID of the iSCSI connection where you want to add a path.
    -connectionName
    Type the unique name of the iSCSI connection where you want to add a path.
    -descr
    Type the iSCSI path description.
    -addr
    Type the IP address of the remote system iSCSI destination.
    Note:  Do not specify an iSCSI portal address which only redirects the connection to another address. Unity does not support iSCSI redirection.
    -port
    The default TCP port is 3260. If the port number is different from the default, type the TCP port of the remote system iSCSI destination.
    -if
    Specify a comma-separated list of iSCSI interfaces on the local source system.
    Note:  You can find existing iSCSI interfaces information by using the /net/if show command. If a system has two SPs, make sure that you specify iSCSI network interfaces for both SPs.
    -async
    Run the operation in asynchronous mode.
    Example

    The following command creates an iSCSI path for the "iscsi_conn_1" iSCSI connection.

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/iscsi/connection/path create –connection iscsi_conn_1 -addr 10.0.0.4 -if if_1,if_2 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

Operation completed successfully.

    View iSCSI connection path settings

    View details for existing iSCSI connection paths.

    Format
    /remote/iscsi/connection/path [{-connection <value> | -connectionName <value>}] show
    Object qualifiers
    Qualifier
    Description
    -connection
    Type the ID of the iSCSI connection.
    -connectionName
    Type the unique name of the iSCSI connection.
    Example

    This example shows all iSCSI connection paths.

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/iscsi/connection/path –connection iscsi_conn_1 show -detail 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

1:    Index                       = 1
      iSCSI connection            = iscsi_conn_1
      iSCSI connection name       = MyConn
      iSCSI path description      = SP 2 node 1
      Remote iSCSI address        = 10.0.0.4
      Remote iSCSI port           = 3260
      Local iSCSI interfaces      = IF_1,IF_2

2:    Index                       = 2
      iSCSI connection            = iscsi_conn_1
      iSCSI connection name       = MyConn
      iSCSI path description      = SP 1 node 2
      Remote iSCSI address        = 10.0.0.6
      Remote iSCSI port           = 3260
      Local iSCSI interfaces      = IF_1,IF_2

    Delete an iSCSI connection path

    Deletes an existing iSCSI connection path.

    Note:  When you delete an iSCSI connection, any iSCSI connection paths associated with that iSCSI connection are also deleted. You do not need to manually the delete the paths.
    Format
    /remote/iscsi/connection/path {-connection <value> | -connectionName <value>} -index <value> delete [-async]
    Object qualifiers
    Qualifier
    Description
    -connection
    Type the ID of the iSCSI connection that has the path you want to delete.
    -connectionName
    Type the unique name of the iSCSI connection that has the path you want to delete.
    -index
    Type the number of the iSCSI path that you want to delete from the iSCSI connection.
    Action qualifier
    Qualifier
    Description
    -async
    Run the operation in asynchronous mode.
    Example

    The following command deletes the "1" path from the "iscsi_conn_1" iSCSI connection.

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/iscsi/connection/path -connection iscsi_conn_1 –index 1 delete 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

Operation completed successfully.

    Manage remote storage systems

    Configure remote storage systems that connect to the system to which you are logged in. The system uses the configuration to access and communicate with the remote system. For example, to use remote replication, create a configuration that specifies the remote system to use as the destination for the replication session.

    Each remote system configuration is identified by an ID.

    The following table lists the attributes for remote storage systems:

    Table 8. Remote system attributes
    Attribute
    Description
    ID
    ID of the remote system.
    Model
    Model number of the remote system.
    Serial number
    Serial number of the remote system.
    Address
    Network name or management IP address of the remote system.
    Alternate management address
    An alternative management IP address of the remote system.
    Health state
    Health state of the storage resource. The health state code appears in parentheses. Value is one of the following:
    • OK (5)—Resource is operating normally.
    • Degraded/Warning (10)—Working, but one or more of the following may have occurred:
      • One or more of its storage pools are degraded.
      • Its replication session is degraded.
      • Its replication session has faulted.
      • It has almost reached full capacity. Increase the primary storage size, or create additional resources to store your data, to avoid data loss.
    • Minor failure (15)—One or both of the following may have occurred:
      • One or more of its storage pools have failed.
      • The associated iSCSI node has failed.
    • Major (20)—One or both of the following may have occurred:
      • Resource is unavailable.
      • One or more of the associated storage pools have failed.
    • Critical failure (25)—One or more of the following may have occurred:
      • One or more of its storage pools are unavailable.
      • Resource is unavailable.
      • Resource has reached full capacity. Increase the primary storage size, or create additional resources to store your data, to avoid data loss.
    • Non-recoverable error (30)—One or both of the following may have occurred:
      • Resource is unavailable.
      • One or more of the associated storage pools are unavailable.
    Health details
    Additional health information.
    Source user name
    For storage systems that are the source in a replication session, the username that is used to access the system.
    Source user password
    For storage systems that are the source in a replication session, the user password that is used to access the system.
    Local interfaces
    The list of local interface identifiers used to create the interconnection between the two systems.
    Remote interfaces
    The list of remote interface identifiers used to create the interconnection between two systems.
    Destination user name
    For storage systems that are the destination in a replication session, the username that is used to access the system.
    Destination user password
    For storage systems that are the destination in a replication session, the user password that is used to access the system.
    Connection type
    The type of connection with the remote system. Valid values are:
    • sync
    • async
    • both
    Synchronous FC ports
    The fibre channel ports enabled for synchronous replication.
    Note:  For a local system (RS_0), this field will appear empty only when there are no FC ports. For remote systems, this will be empty when the connection type is asynchronous.

    Create remote system configurations

    Configures a remote system configuration for the local system to access.

    Note:   For a source VNX system with two control stations, the home directory of the sysadmin user, which is used in configuring the import connection, must exist on the primary control station of the VNX.
    Format
    /remote/sys create -addr <value> [-type VNX] -srcUsername <value> {-srcPassword <value> | -srcPasswordSecure} -dstUsername <value> {-dstPassword <value> | -dstPasswordSecure} [-connectionType {sync | async | both}]
    Action qualifiers
    Qualifier
    Description
    -addr
    Specify the network name or IP address of the remote system.
    -type
    Specify the remote system type. Valid values are:
    • VNX
    -srcUsername
    For systems that are the source in a replication, type the username that is used to access the system.
    -srcPassword
    For systems that are the source in a replication, type the user password that is used to access the system.
    -srcPasswordSecure
    Specify the password in secure mode. Once you run the command with this qualifier, you will be asked to type the password separately.
    -dstUsername
    For systems that are the destination in a replication session or VNX in an import session, specify the username that is used to access the system.
    -dstPassword
    For systems that are the destination in a replication session or VNX in an import session, specify the user password that is used to access the system.
    -dstPasswordSecure
    Specify the password in secure mode. Once you run the command with this qualifier, you will be asked to type the password separately.
    -connectionType
    Specify this qualifier to indicate the type of replication connection. Valid values are async, sync, or both.
    Example

    The following command creates a remote system configuration with these settings:

    • Network address is 10.64.75.10.
    • Includes access credentials for when the system is the source or destination.

    The configure remote system receives the ID RS_65536:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/sys create –addr 10.64.75.10 –type VNX -dstUsername admin1 -dstPassword Password789! 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = RS_65536
Operation completed successfully.

    Verify settings for remote storage systems

    Verify the configuration settings for a remote system to ensure that the source storage resource can connect to the remote storage resource.

    Format
    /remote/sys –id <value> verify
    Object qualifier
    Qualifier
    Description
    -id
    Type the ID of a remote system configuration to verify the settings.
    Example

    The following command verifies remote system configuration RS_1:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/sys –id RS_1 verify 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

Operation completed successfully.

    View settings for remote storage systems

    View the configuration for a remote system on the local system. You can filter on the configuration ID of the remote system.

    Note:   The show action command explains how to change the output format.
    Format
    /remote/sys [-id <value>] show
    Object qualifier
    Qualifier
    Description
    -id
    Type the ID of a remote system configuration.
    Example

    The following command lists all configurations for remote storage systems:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/sys show -detail 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

1:     ID                           = RS_1
       Address                      = 10.2.3.1
       Alternate Management Address =
       Model                        = Unity 300
       Serial number                = FCNC987654321
       Connection type              = async
       Local interfaces             = N/A
       Remote interfaces            = N/A
       Operational status           = OK (0x2)
       Health state                 = OK (5)
       Health details               = "Communication with the replication host is established. No action is required."
       Synchronous FC ports         = spb_fc4, spa_fc4

    Change settings for remote storage systems

    Changes the configuration settings for a remote system.

    NOTICE  If a replication connection already exists and you plan to add a different mode of file replication, do not attempt to create a new connection. Change the existing replication connection mode to Both. Also, ensure that you have the appropriate interface types configured to support both asynchronous replication (eth2, eth3) and synchronous replication (sync replication mgmt port).
    Format
    /remote/sys -id <value> set [ -addr <value> ] [ -dstUsername <value> { -dstPassword <value> | -dstPasswordSecure } ] [ -connectionType {sync | async | both}]
    Object qualifier
    Qualifier
    Description
    -id
    Type the ID of the remote system configuration to change.
    Action qualifiers
    Qualifier
    Description
    -addr
    Type the network name or management IP address of the remote system.
    -dstUsername
    Type the username that is used to access the remote system.
    -dstPassword
    Type the user password that is used to access the remote system.
    -dstPasswordSecure
    Specify the password in secure mode - the user will be prompted to input the password.
    -connectionType
    Specify this qualifier to indicate the type of replication connection. Valid values are async, sync, or both.
    Example

    The following command changes the name, IP address, and access credentials for remote system configuration RS_1:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/sys –id RS_1 set –addr “10.64.74.2” -dstUsername Local/joe -dstPassword Password456! 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = RS_1

Operation completed successfully.

    Delete remote system configurations

    Deletes the configuration for a remote system.

    Note:  Before deleting a remote system configuration, ensure that all I/O operations on the system, such as active replication sessions, have completed to avoid data loss.
    Format
    /remote/sys –id <value> delete
    Object qualifier
    Qualifier
    Description
    -id
    Type the ID of the remote system configuration to delete.
    Example

    The following command deletes remote system configuration RS_1:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/sys –id RS_1 delete 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

Operation completed successfully.

    Cabinet level unplanned failover of replication sessions

    Execute a failover of all NAS server synchronous replication sessions from the remote system to the local system (unplanned failover). Replication sessions of file systems created on the affected NAS servers will also fail over automatically.
    Format
    /remote/sys -id <value> failover [-force]
    Object qualifiers
    Qualifier
    Description
    -id
    Type the ID of the remote system from which to failover its NAS server synchronous replication sessions.
    Action qualifiers
    Qualifier
    Description
    -force
    Specifies whether to skip checking the network connection to the remote system. Required when the network connection is healthy. No values are allowed.
    Example

    The following command executes a cabinet level unplanned failover replication operation issued for a Unity system:

    uemcli /remote/sys -id RS_1 failover 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = RS_1
Operation completed successfully.
    Note:  After an unplanned failover, the NAS servers and file systems on the original source system must be updated to reflect the new status. If there is a large number of NAS servers and file systems, this change may take several minutes to complete. During this period, resume and failback operations of the synchronous replication sessions will not work. It is recommended to wait for all of the updates to complete before running a resume or failback operation. There is no impact to data access while this update is occurring.

    Manage VMware vCenter

    Manage VMware vCenter servers.

    The following table lists the attributes for VMware vCenter.

    Table 9. VMware vCenter attributes
    Attribute
    Description
    ID
    ID of the VMware virtual center
    Address
    Domain name or IP address of VMware vCenter.
    User name
    Name of the administrator account on the VMware vCenter.
    Password
    Password of the administrator account on the VMware vCenter.
    Description
    Description of the VMware vCenter.
    VASA provider state
    Indicates whether the system is registered as a VASA provider in vCenter. Values are:
    • Registered
    • Not registered
    • Not supported
    Note:  Automatic VASA registration is not supported on vSphere versions earlier than 6.0. The storage system can be registered as a VASA provider with only one vCenter at a time.
    Local username
    The username of the local account that vSphere will use to register the system as a VASA provider.
    Note:  It is recommended that you create a new user with the /user/account command and set the role to vmadmin.
    Local password
    The password of the local account that vSphere will use to register the system as a VASA provider.

    Create VMware vCenter

    Adds the vCenter credentials and discovers any ESXi host managed by that vCenter. The vCenter credentials are stored in the storage system. In order to execute this command, the user must have account on the storage system.

    Format
    /virt/vmw/vc create -addr <value> -username <value> {-passwd <value> | -passwdSecure} [-descr <value>] [-registerVasaProvider {yes -localUsername <value> {-localPasswd <value> | -localPasswdSecure} | no}]
    Action qualifier
    Qualifier
    Description
    -addr
    Domain name or IP address or domain name of the VMware vCenter.
    -username
    Specify the VMware administrator username used to access the VMware vCenter.
    -passwd
    Specify the VMware administrator password used to access the VMware vCenter.
    -passwdSecure
    Specify the password in secure mode. The user will be prompted to input the password.
    -descr
    Specify the description of the VMware vCenter server.
    -registerVasaProvider
    Specify to register the system as a VASA provider with this vCenter server. Valid values are:
    • yes
    • no
    -localUsername
    Specify the username of the system account that will be used by vCenter to register the system as a VASA provider.
    Note:  It is recommended that you create a new user with the /user/account command and set the role to vmadmin. The storage system can be registered as a VASA provider with only one vCenter at a time.
    -localPasswd
    Specify the password of the system account that will be used by vCenter to register the system as a VASA provider.
    -localPasswdSecure
    Specify the VASA password in secure mode, which requires the user to input the password when prompted.
    Example 1

    The following command adds virtual center credentials:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /virt/vmw/vc create -addr 10.11.11.111 -username administrator@vsphere.local -passwd xxx -descr "Add vCenter" 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = VC_1
Operation completed successfully
    Example 2

    The following command adds a vCenter and registers the storage system as a VASA provider.

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /virt/vmw/vc create –address 10.11.11.111 –username root –passwd xxx –descr "Add virtual center" –registerVasaProvider yes –localUsername admin –localPasswd Password321 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = VC_1
Operation completed successfully

    Set the credentials or description of an existing vCenter server

    Modifies the credentials or description of the existing vCenter server. In order to execute this command the user must have an account on the storage system.

    Format
    /virt/vmw/vc -id <value> set [-addr <value>] [-username <value> {-passwd <value> | -passwdSecure} ] [-descr <value>]
    Object qualifier
    Qualifier
    Description
    -id
    Identifies the VMware vCenter server.
    Action qualifier
    Qualifier
    Description
    -addr
    Specifies the new IP address or domain name of the VMware vCenter server.
    -username
    Specifies the VMware administrator username.
    -passwd
    Specifies the VMware administrator password.
    -passwdSecure
    Specifies the password in secure mode - the user will be prompted to input the password.
    -descr
    Specifies the new description of the VMware vCenter server.
    Example

    The following command specifies the new description of the VMware vCenter server:

    uemcli /virt/vmw/vc -id VC_1 set -descr "This vCenter manages 2 ESXi hosts" 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = VC_1
Operation completed successfully.

    Delete an existing vCenter server

    Removes an existing VMware vCenter server and its associated ESXi hosts.

    Note:  If the Unity system is registered as a VASA provider in vCenter and you delete the vCenter from Unity, the Unity system will be unregistered as a VASA provider from vCenter.
    Format
    /virt/vmw/vc -id <value> delete
    Object qualifier
    Qualifier
    Description
    -id
    Identifies the VMware vCenter server.
    Example

    The following example deletes an existing vCenter server and any of its associated ESXi hosts.

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /virt/vmw/vc -id VC_1 delete 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

Operation completed successfully

    View all vCenter servers

    Displays a list of configured VMware vCenter servers.

    Format
    /virt/vmw/vc [-id <value>] show
    Object qualifier
    Qualifier
    Description
    -id
    Identifies the VMware vCenter server.
    Example

    The following example shows a list of all vCenter servers.

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /virt/vmw/vc show 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

1:     ID                       = VC_1
       Address                  = 10.1.1.1
       Description              = This vCenter manages 2 ESXi hosts
       VASA provider state      = yes

    Refresh all vCenter servers

    Rescan details of all configured VMware vCenter servers.

    Format
    /virt/vmw/vc refresh [-scanHardware]
    Object qualifier
    Qualifier
    Description
    -id
    Specify the ID of the vCenter. If not specified, all attached vCenters are refreshed.
    -scanHardware
    Specify to rescan hardware changes (this takes additional time).
    Example

    The following example rescans all vCenters.

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /virt/vmw/vc refresh -scanHardware 
                              
Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

Operation completed successfully.

    Manage ESXi hosts

    Manage VMware ESXi hosts.

    The following table lists the attributes for ESXi hosts.

    Table 10. ESXi host attributes
    Attribute
    Description
    ID
    ID of the ESXi host.
    Name
    Name of the ESXi host.
    Address
    Domain name or IP address of ESXi host.
    Virtual center
    Identifier of the VMware VCenter server managing the ESXi host.
    Username
    Name of the user account on the ESXi host.
    Password
    Password of the user account on the ESXi host.
    Description
    Description of the ESXi host.
    NFSv4 supported
    Indicates if the NFSv4 protocol is supported for the host. Valid values are:
    • yes
    • no
    NFS username
    Displays the NFS user authentication information configured for the ESXi host. The same username should be configured on the VMware NFS datastore in order to enable secure NFS access with Kerberos for that datastore.

    Create an ESXi host

    Adds a VMware ESXi host.

    Format
    /virt/vmw/esx create -addr <value> { -vc <value> | -username <value> {-passwd <value> | -passwdSecure} } [ -descr <value> ] ] [ -resolveConflicts { yes | no } ]
    Action qualifier
    Qualifier
    Description
    -addr
    Domain name or IP address of the ESXi host.
    -vc
    Identifies the VMware vCenter server.
    -username
    Specifies the username used to access the VMware ESXi host.
    -passwd
    Specifies the password used to access the VMware ESXi host.
    -passwdSecure
    Specifies the password in secure mode - the user will be prompted to input the password.
    -descr
    Specifies the description of the VMware ESXi host.
    -resolveConflicts
    Specifies the option to resolve IP address or initiator conflicts interactively. Valid values are yes or no (default).
    Example 1
    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /virt/vmw/esx create -addr 10.1.1.1 -username root -passwd xxx -descr "My ESXi host" 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = ESX_1
Operation completed successfully
    Example 2
    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /virt/vmw/esx create -addr 10.1.1.1 -vc VMwareVC_12 -resolveConflicts yes 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

The ESX host to be created has IP addresses and/or Initiators already present in an existing host.
The ID of the existing host is: Host_12
The IP addresses in conflict are: 10.14.12.219, 10.14.12.220
The Initiators in conflicts are: iqn.1998-01.com.vmware:test1-1, iqn.1998-01.com.vmware:test1-2

WARNING, the existing host has IP addresses and/or Initiators not found in the ESX host to be created. If you continue with the ESX host creation, those IP addresses and/or Initiators will be removed and can no longer be used for storage access.
The IP address not in the ESX host are: 10.14.12.217, 10.14.12.218
The Initiators not in the ESX host are: iqn.1998-01.com.vmware:test1-3

Do you want to convert the existing host to the ESX host?
Yes / no:yes

ID = ESX_1
Operation completed successfully

    Change ESXi host credentials

    Changes ESXi host credentials and/or description. In order to execute this command the user must have account on the storage system.

    Format
    /virt/vmw/esx -id <value> set [ -descr <value> ] [ -username <value> { -passwd <value> | -passwdSecure } ] [ -addr <value> ]
    Object qualifier
    Qualifier
    Description
    -id
    Identifies the VMware ESXi host.
    Action qualifier
    Qualifier
    Description
    -descr
    Specifies the comment or description.
    -username
    Specifies the username used to access the VMware ESXi host.
    -passwd
    Specifies the password used to access the VMware ESXi host.
    -passwdSecure
    Specifies the new password in secure mode - the user will be prompted to input the password.
    -addr
    Specifies the domain name or IP address of the ESXi host in order for Unisphere to contact the ESXi host directly.
    Note:  This is only applicable for standalone ESXi hosts.
    Example
    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /virt/vmw/esx -id ESX_1 set -descr "Changing ESXi host description" 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = ESX_1
Operation completed successfully.

    Delete ESXi host credentials

    Deletes ESXi host credentials. This will also remove access from the specified host to any VMware datastores or protocol endpoints that are associated with it.

    Format
    /virt/vmw/esx -id <value> delete
    Object qualifier
    Qualifier
    Description
    -id
    Identifies the ESXi host.
    Example
    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /virt/vmw/esx -id ESX_1 delete 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

Operation completed successfully.

    View all existing ESXi hosts

    Displays a list of all configured VMware ESXi hosts.

    Format
    /virt/vmw/esx [{-id <value> | -vc <value>}] show
    Object qualifier
    Qualifier
    Description
    -id
    Identifies the VMware ESXi host.
    -vc
    Identifies the VMware vCenter server.
    Example

    The following example shows how to display all of the ESXi hosts on the vCenter connected to the system.

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /virt/vmw/esx -vc VC_1 show 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

1:     ID              = ESX_1
       Name            = nlpc12240.aa.bb.com
       vCenter         = VC_1
       Address         = 10.10.10.100
       Description     = 	
       NFSv4 supported = yes
       NFS username    = root


2:     ID              = ESX_2
       Name            = nlpc12241.xx.yy.com
       vCenter         = VC_1
       Address         = 10.10.10.101
       NFSv4 supported = no
       NFS username    =

    Discover all ESXi hosts

    Lists all VMware ESXi hosts on the specified VMware vCenter server.

    Format
    /virt/vmw/esx discover { -vc <value> | -vcAddr <value> -username <value> {-passwd <value> | -passwdSecure} } [ -createAll ]
    Action qualifier
    Qualifier
    Description
    -vc
    Identifies the existing VMware vCenter.
    -vcAddr
    IP address or domain name of the VMware vCenter.
    -username
    Specifies the name of the VMware vCenter.
    -passwd
    Specifies the password of the VMware vCenter
    -passwdSecure
    Specifies the password in secure mode - the user will be prompted to input the password.
    -createAll
    Adds all discovered ESXi hosts automatically.
    Example
    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /virt/vmw/esx discover -vc VC_1 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

1:     Name    = nlpc12240.us.dg.com

2:     Name    = nlpc12241.us.dg.com

Operation completed successfully

    Refresh an ESXi host

    Rescans details of a VMware ESXi host.

    Format
    /virt/vmw/esx [-id <value>] refresh [-scanHardware]
    Object qualifier
    Qualifier
    Description
    -id
    Identifies the ESXi host. If an ID is not specified, all virtualization objects are rescanned.
    Action qualifier
    Qualifier
    Description
    -scanHardware
    Specify to rescan hardware changes also (takes additional time).
    Example

    The following command rescans the hardware to discover additional ESXi hosts.

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /virt/vmw/esx refresh -scanHardware 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection


Operation completed successfully.

    Virtual machine

    Manage VMware virtual machines.

    The following table lists the attributes for Virtual machine.

    Table 11. Virtual machine attributes
    Attribute
    Description
    ID
    ID of the virtual machine.
    Name
    Name of the virtual machine
    Description
    Description of the virtual machine.
    ESX server
    ESXi hosts containing the virtual machine.
    OS
    Guest operating system.
    State
    Virtual machine power state. Valid values are:
    • Powered on
    • Powered off
    • Suspended

    View all existing virtual machines

    Displays a list of all existing virtual machines on existing ESXi hosts on the Unity system.

    Format
    /virt/vmw/vm [{-id <value> | -esx <value>}] show
    Object qualifier
    Qualifier
    Description
    -id
    Identifies the virtual machine.
    -esx
    Identifies the ESXi host.
    Example
    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /virt/vmw/vm -esx ESX_1 show 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

1:     ID         = VM_1
       Name       = WinVM1
       vCenter    = VC_1
       ESX server = ESX_1
       State      = Powered On

2:     ID         = VM_2
       Name       = LinVM3
       vCenter    = VC_1
       ESX server = ESX_1
       State      = Suspended

    VM hard disk

    Manage hard disk properties for VMware virtual machines stored on the Unity system.

    The following table lists the attributes for VM hard disks.

    Table 12. VM hard disk attributes
    Attribute
    Description
    Name
    Name of the hard disk.
    Type
    Type of the VM hard disk.
    Capacity
    VM hard disk capacity.
    Datastore
    Associated datastore.

    View all hard disks

    Displays hard disk properties for a specified virtual machine stored on the Unity system.

    Format
    /virt/vmw/vmdevice -vm <value> show
    Object qualifier
    Qualifier
    Description
    -vmId
    Identifies the virtual machine.
    Example
    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /virt/vmw/vmdevice -vm VM_1 show 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

1:     Name      = Hard disk 1
       Type      = VM Hard Disk
       Capacity  = 107374182400 (100GB)
       Datastore = Storage1

2:     Name      = Hard disk 2
       Type      = VM Hard Disk
       Capacity  = 107374182400 (100GB)
       Datastore = Storage1