Search
  • Manage VMware virtual volume datastores with CLI

    PDF

    Manage VMware virtual volume datastores with CLI

    Create a NAS server

    Create a NAS server. You can create a maximum of 24 NAS servers per system.

    Format
    /net/nas/server create -name <value> -sp <value> -pool <value> [-mpSharingEnabled {no | yes [-unixDirectoryService {ldap | nis | none}] [-defaultUnixUser <value>] [-defaultWindowsUser <value>]}] [-replDest { yes | no } ]
    Action qualifiers
    Qualifier
    Description
    -name
    Specifies the NAS server name.
    NAS server names can contain alphanumeric characters, a single dash, and a single underscore. Server names cannot contain spaces or begin or end with a dash. You can create NAS server names in four parts that are separated by periods (example: aa.bb.cc.dd). Names can contain up to 255 characters, but the first part of the name (before the first period) is limited to 15 characters.
    -sp
    Specifies the parent SP for the NAS server.
    -pool
    Specifies the ID of the storage pool for the NAS server.
    -mpSharingEnabled
    Indicates whether multiprotocol sharing mode is enabled. Value is yes or no (default).
    -unixDirectoryService
    Directory Service used for querying identity information for Unix (such as UIDs, GIDs, net groups). Valid values are:
    • nis
    • ldap
    • none (default)
    -defaultUnixUser
    Default Unix user name that grants file access in the multiprotocol sharing mode. This user name is used when the corresponding Unix/Linux user name is not found by the mapping mechanism.
    -defaultWindowsUser
    Default Windows user name that grants file access in the multiprotocol sharing mode. This user name is used when the corresponding Windows user name is not found by the mapping mechanism.
    -replDest
    Replication destination settings for the NAS server. When this option is set to yes, only mandatory parameters may be included. All other optional parameters will be inherited from the source NAS server. Valid values are:
    • yes
    • no
    Example

    The following command creates a NAS server with these settings:

    • Name is NasServer_1.
    • Associated to SP A.
    • Associated to storage pool pool_0.
    • The server receives the ID nas_1.
    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /net/nas/server create -name NasServer_1 -sp spa -pool pool_0 
                          Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = nas_1
Operation completed successfully.

    Change NAS server settings

    Modify an existing NAS server.

    Format
    /net/nas/server -id {-id <value> | -name <value>} set [-name <value>][-mpSharingEnabled {yes | no}] [-unixDirectoryService {ldap | nis | none}] [{-defaultAccessDisabled | [-defaultUnixUser <value>] [-defaultWindowsUser <value>]}] [-replDest {yes | no }] [-preferredProductionOverride { no | yes }][-preferredProductionIPv4 { auto | <value> } ] [-preferredProductionIPv6 { auto | <value>}] [-preferredBackupIPv4 { auto | <value>} ] [-preferredBackupIP v6 { auto | <value>}
    Object qualifier
    Qualifier
    Description
    -id
    Type the ID of the NAS server to change.
    -name
    Type the NAS server name.
    Action qualifiers
    Qualifier
    Description
    -mpSharingEnabled
    Indicates whether multiprotocol sharing mode is enabled. Valid values are:
    • yes
    • no
    -unixDirectoryService
    Directory Service used for querying identity information for Unix (such as UIDs, GIDs, net groups). Valid values are:
    • nis
    • ldap
    • none
    -defaultAccessDisabled
    Disables file access when no user mapping mechanism is found.
    -defaultUnixUser
    Default Unix user name that grants file access in the multiprotocol sharing mode. This user name is used when the corresponding Unix/Linux user name is not found by the mapping mechanism.
    -defaultWindowsUser
    Default Windows user name that grants file access in the multiprotocol sharing mode. This user name is used when the corresponding Windows user -defaultWindowsUsername is not found by the mapping mechanism.
    -replDest
    Replication destination settings for the NAS server. Valid values are:
    • yes
    • no
    -preferredProductionOverride
    Override the replicated production interfaces "preferred interface" settings. Valid values are:
    • yes
    • no
    -preferredProductionIPv4
    Production IPv4 preferred interface settings. The interface must be IPv4 and belong to this server. Valid values are:
    • <interface ID>
    • auto
    -preferredProductionIPv6
    Production IPv6 preferred interface settings. The interface must be IPv6 and belong to this server. Valid values are:
    • <interface ID>
    • auto
    -preferredBackupIPv4
    Backup and DR test IPv4 preferred interface settings. The interface must be IPv4 and belong to this server. Valid values are:
    • <interface ID>
    • auto
    -preferredBackupIPv6
    Backup and DR test IPv6 preferred interface settings. The interface must be IPv6 and belong to this server. Valid values are:
    • <interface ID>
    • auto
    Example 1

    The following command updates NAS server nas_1 with these settings:

    • Enables multiprotocol sharing.
    • Uses LDAP as the Unix Directory Service.
    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /net/nas/server -id nas_1 set -mpSharingEnabled yes -unixDirectoryService ldap 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = nas_1
Operation completed successfully.
    Example 2

    The following command changes the replication settings for NAS server nas_1.

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /net/nas/server -id nas_1 set -replDest yes 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = nas_1
Operation completed successfully.

    Manage VMware NAS protocol endpoint servers

    VMware protocol endpoint servers are NFS-based NAS servers enabled to provide an I/O path from the VMware host to it's respective File VVol datastore on the storage system.

    When creating a NAS protocol endpoint server, you can choose which IP address the NAS PE will use from the list of IP interfaces already created for the NAS server. It is recommended that you enable at least two NAS servers for VVols, one on each SP, for high availability. The system will select one of these NAS PEs automatically based on which will maximize throughput.

    Table 1. Protocol endpoint server attributes
    Attribute
    Description
    ID
    VMware protocol endpoint identifier.
    NAS server
    Identifier of the associated NAS server for NAS PEs.
    NAS server interface
    Identifier of the NAS server IP interface to be used by the VMware NAS protocol endpoint server.
    Only one VMware protocol endpoint server per NAS server is supported.

    Create protocol endpoint servers

    Create VMware protocol endpoints servers for File VVols.

    Format
    /net/nas/vmwarepe create [-async] -server <value> -if <value>
    Action qualifier
    Qualifier
    Description
    -async
    Run the operation in asynchronous mode.
    -server
    Type the identifier of the NAS server.
    -if
    Type the name of the identifier for the NAS IP interface to be used by the VMware protocol endpoint server.
    Example

    The following example creates a protocol endpoint server on NAS server "nas_1" with the IP interface "if_1".

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /net/nas/vmwarepe create -server nas_1 -if if_ 1 
                              Storage system address: 10.0.0.1 
Storage system port: 443 
HTTPS connection 

ID = PES_0 
Operation completed successfully.

    View VMware protocol endpoint servers

    View VMware protocol endpoints servers for File VVols.

    Format
    /net/nas/vmwarepe [{-id <value> | -server <value>}] show
    Action qualifier
    Qualifier
    Description
    -id
    Type the identifier of the NAS protocol endpoint server.
    -server
    Type the identifier of the associated NAS server.
    Example

    The following example shows the details for all of the VMware protocol endpoint servers on the system.

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

1:     ID                   = PES_0
       NAS server           = nas_1
       NAS server interface = if_1

    Delete protocol endpoint servers

    Delete a VMware protocol endpoints server.

    Format
    /net/nas/vmwarepe -id <value> delete [-async] [-force]
    Object qualifiers
    Qualifier
    Description
    -id
    Type the identifier or the VMware protocol endpoint server to be deleted.
    Action qualifiers
    Qualifier
    Description
    -async
    Run the operation in asynchronous mode.
    -force
    Unconditionally removes all VMware NAS protocol endpoints using the VMware protocol endpoint server and unbinds all virtual volumes using the protocol endpoint server.
    Example

    The following example deletes VMware NAS protocol endpoint server "PES_0".

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /net/nas/vmwarepe –id PES_0 delete 
                              Storage system address: 10.0.0.1 
Storage system port: 443 
HTTPS connection 

Operation completed successfully.

    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 2. Host configuration attributes
    Attribute
    Description
    ID
    ID of the host configuration.
    Name
    Name of the host configuration.
    Description
    Brief description of the host configuration.
    Address
    Hostname or IP address associated with the host, IP address of the subnet, or name of the netgroup.
    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.

    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.

    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>] -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.

    -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.
    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.

    Format
    /remote/host [{-id <value>|-type {host|subnet|netgroup}}] show
    Object qualifier
    Qualifier
    Description
    -id
    Identifies the host configuration.
    -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
       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
       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> set [-name <value>] [-descr <value>] [-addr <value>] [-ignoredAddr <value>] [-netmask <value>] [-osType <value>]
    Object qualifier
    Qualifier
    Description
    -id
    Identifies 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.
    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.
    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.

    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> delete
    Object qualifier
    Qualifier
    Description
    -id
    Identifies 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 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. 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.

    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}
    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
    Example

    The following command creates an iSCSI initiator for host configuration 1014. The iSCSI initiator receives ID ISCSII_1:

    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.

    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 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              = 1058
   Host            = 1014
   UID             = iqn.1991-05.com.microsoft:nlpc20971
   Initiator type  = iscsi
   Ports logged in = eth1_SPA, eth1_SPB 
   Ignored         = false no 
   Health state    = OK (5)

    Modify initiators

    Modify an already created initiator.

    Format
    /remote/initiator -id <value> set [-ignored {yes | no}] [-host <value>]
    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
    Example

    The following command assigns initiator 1058 to host 1014:

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

Operation completed successfully.

    Manage VMware vCenter

    Manage VMware vCenter servers.

    The following table lists the attributes for VMFS datastores.

    Table 4. 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 user account on the VMware vCenter.
    Password
    Password of the user account on the VMware vCenter.
    Description
    Description of the VMware vCenter.

    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> ]
    Action qualifier
    Qualifier
    Description
    -addr
    Domain name or IP address or domain name of the VMware vCenter.
    -username
    Specifies the username used to access the VMware vCenter.
    -passwd
    Specifies the password used to access the VMware vCenter.
    -passwdSecure
    Specifies the password in secure mode - the user will be prompted to input the password.
    -descr
    Specifies the description of the VMware vCenter server.
    Example

    The following command adds virtual center credentials:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /virt/vmw/vc create -address 10.14.12.209 -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

    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 username.
    -passwd
    Specifies the 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. In order to execute this command the user must have account on the storage system.

    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

    Refresh all vCenter servers

    Rescan details of all configured VMware vCenter servers.

    Format
    /virt/vmw/vc refresh [-scanHardware]
    Object qualifier
    Qualifier
    Description
    -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 5. 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.

    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.
    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
    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.us.dg.com
       vCenter = VC_1
       Address = 10.14.12.240

2:     ID      = ESX_2
       Name    = nlpc12241.us.dg.com
       vCenter = VC_1
       Address = 10.14.12.241

    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.

    Manage capability profiles

    A capability profile is a group of storage capabilities that are applicable for VVol datastores. You must create one or more capability profiles before creating VVol datastores.

    Capabilities are automatically derived from the underlying storage pool and are determined by the pool properties. Usage tags are assigned by the storage admin.

    There are three ways to profile storage capabilities for a pool:

    Table 6. Storage capabilities
    Service level-based provisioning (physical deployments)
    Expected service level for the pool:
    • Platinum
      • Single-tiered Flash pool
    • Gold
      • Multitiered pool with a mix of Flash and SAS drives
      • Single-tiered pools with SAS RAID 10
    • Silver
      • Single-tiered pools with SAS RAID 5 or RAID 6
      • Multitiered pools with a mix of SAS and NL-SAS
    • Bronze
      • Single-tiered pools with NL-SAS
      • Multitiered pools with a mix of Flash and NL-SAS
    Service level-based provisioning (virtual deployments)
    Expected service level for a virtual pool:
    • Gold
      • Multitiered pool with a mix of Extreme Performance and Performance tiers
      • Single-tiered Extreme Performance pool
    • Silver
      • Multitiered pool with a mix of Extreme Performance, Performance, and Capacity tiers
      • Multitiered pool with a mix of Performance and Capacity tiers
      • Single-tiered Performance pool
    • Bronze
      • Multitiered pool with a mix of Extreme Performance and Capacity tiers
      • Single-tiered Capacity pool
    Usage tags
    Usage tags can be applied to capability profiles to designate them and their associated VVol datastores for a particular use. For example, a VVol datastore may be tagged for VVols and VMs that support a particular application. The virtualization administrator and storage administrator should collaborate to define these usage tags.
    Storage properties
    Supported storage properties include:
    • Drive type:
      • Extreme Performance [Flash]
      • Performance [SAS]
      • Capacity [NL-SAS]
      • Multitier [mixed]
      • Extreme Multitier [mixed with Flash]
    • RAID type (physical deployments only):
      • RAID5
      • RAID6
      • RAID10
      • Mixed
    • FAST Cache (physical deployments only):
      • Enabled
      • Disabled
    • FAST VP tiering policy:
      • Highest Available Tier
      • Start High then Auto-Tier
      • Auto-Tier
      • Lowest Available Tier
    • Space Efficiency:
      • Thick
      • Thin
    Table 7. Capability profile attributes
    Attribute
    Description
    ID
    Capability profile identifier.
    Name
    Capability profile name.
    Description
    Capability profile description.
    VMware UUID
    VMware UUID of the capability profile.
    Storage pool
    Associated storage pool identifier.
    Service level
    Service level of the underlying storage pool. Valid values are:
    • Platinum
    • Gold
    • Silver
    • Bronze
    Usage tag
    Comma-separated list of user-defined tags. Each tag is an alphanumeric string value.
    Drive type
    Specifies the drive type of the underlying storage pool. Valid values are:
    • CapacityTier
    • PerformanceTier
    • ExtremePerformanceTier
    • MultiTier
    • ExtremeMultiTier
    RAID level (physical deployments only)
    Specifies the RAID level of the underlying storage pool. Valid values are:
    • RAID5
    • RAID10
    • RAID6
    • Mixed
    FAST Cache (physical deployments only)
    Indicates whether or not FAST Cache is enabled on the underlying storage pool. Valid values are:
    • On
    • Off
    FAST VP policy
    Comma-separated list of FAST VP storage policies for the underlying storage pool. Valid values are:
    • Start high then auto-tier
    • Auto-tier
    • Highest available tier
    • Lowest available tier
    Space efficiency
    Comma-separated list of available space efficiency policies for the underlying storage pool. Valid values are:
    • Thick
    • Thin
    Health state
    Health state.
    Health details
    Additional health information.

    Create a capability profile

    Create a capability profile for VVol datastores.

    Format
    /stor/config/cp create [-async] -name <value> [-descr <value>] -pool <value> [-usageTag <value>]
    Action qualifier
    Qualifier
    Description
    -async
    Run the operation in asynchronous mode.
    -name
    Type a name for the capability profile.
    The name may contain alphanumeric values, a hyphen, an underscore, and a period. It cannot start with hyphen or period, and cannot consist only of digits.
    -descr
    Type a description for the capability profile.
    -pool
    Specify the identifier of the storage pool the capability profile is based on.
    -usageTag
    Type a comma-separated list of user-specified usage tags. Each tag is an alphanumeric string value.
    Example

    The following command creates a capability profile with these settings:

    • Specifies a capability profile name of "CapabilityProfile1"
    • Specifies that the capability profile is based on "pool_1"
    • Specifies the usage tag as "Production"
    • Not specified to be created in asynchronous mode
    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /stor/config/cp create -name "CapabilityProfile1" -pool pool_1 -usageTag "Production" 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = cp_1
Operation completed successfully.

    View capability profiles

    Displays a list of existing capability profiles and their characteristics.

    Format
    /stor/config/cp [-id <value>] show
    Object qualifier
    Qualifier
    Description
    -id
    Type the ID of the capability profile.
    Example

    The following command displays a list of existing capability profiles and their characteristics.

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

       ID               = cp_1
       Name             = CapabilityProfile1
       Description      =
       VMware UUID      = 550e8400-e29b-41d4-a716-446655440000
       Storage pool     = pool_1
       Service level    = Gold
       Usage tag        = Exchange, OLTP
       Drive type       = ExtremeMultiTier
       RAID level       = Mixed
       FAST Cache       = Off
       FAST VP policy   = Start high then auto-tier, Auto-tier, Highest available tier, 
                          Lowest available tier
       Space efficiency = Thin, Thick
       Health state     = OK (5)
       Health details   = "The component is operating 
                           normally. No action is required."

    Change capability profiles

    Modify an existing capability profile.

    Format
    /stor/config/cp -id <value> set [-async] [-name <value>] [-descr <value>] [{-addUsageTag <value> | -removeUsageTag <value>}]
    Object qualifier
    Qualifier
    Description
    -id
    Type the ID of the capability profile to be modified.
    Action qualifier
    Qualifier
    Description
    -async
    Run the operation in asynchronous mode.
    -name
    Type a name for the capability profile.
    The name may contain alphanumeric values, a hyphen, an underscore, and a period. It cannot start with hyphen or period, and cannot consist only of digits.
    -descr
    Type a description for the capability profile.
    -addUsageTag
    Comma-separated list of user-specified usage tags to be added to the specified capability profile. Each tag is an alphanumeric string value.
    -removeUsageTag
    Comma-separated list of user-specified usage tags to be removed from the specified capability profile. Each tag is an alphanumeric string value.
    Example

    The following command changes the name of capability profile "cp_1".

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /stor/config/cp -id cp_1 set -name "CapabilityProfile2" 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = cp_1
Operation completed successfully.

    Delete capability profiles

    Deletes specified capability profiles.

    Format
    /stor/config/cp [-id <value>] delete [-async]
    Object qualifier
    Qualifier
    Description
    -id
    Type the ID of the capability profile.
    Action qualifier
    Qualifier
    Description
    -async
    Run the operation in asynchronous mode.
    Example

    The following command deletes capability profile cp_1.

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /stor/config/cp -id cp_1 delete 
                              
Storage system address: 10.0.0.1 
Storage system port: 443 
HTTPS connection 

Operation completed successfully.

    Manage VMware protocol endpoints

    Protocol Endpoints (PEs) are access points for ESX/ESXi host communication to the storage system. These endpoints establish a datapath on-demand for virtual machines and their respective VVol datastores. I/O from VMs is communicated through the PE to the VVol datastore on the storage system. A single protocol endpoint can multiplex I/O requests from a large number of VM clients to their virtual volumes.

    NAS protocol endpoints are created and managed on the storage system and correspond to a specific NFS-based NAS server. It is recommended that you enable at least two NAS servers for VVols, one for each SP, for high availability. A File VVol will be bound to the associated NAS PE every time that VM is powered on. When the VM is powered off, VVols is unbound from the PE.

    SCSI protocol endpoints correspond to a specific iSCSI interface or Fibre Channel connection. The Block VVol will be bound to the associated SCSI PE every time that the VM is powered on. When the VM is powered off, the PE is unbound. SCSI protocol endpoints are like LUN mount points that allow I/O access to VVols from the ESXi host to the storage system.

    Table 8. Protocol endpoint attributes
    Attribute
    Description
    ID
    VMware protocol endpoint identifier.
    Name
    Protocol endpoint name.
    Type
    Type of protocol endpoint. Valid values are:
    • SCSI
    • NAS
    Description
    Protocol endpoint description.
    VMware UUID
    VMware UUID of the protocol endpoint.
    Export path (NAS PEs only)
    Export path to the PE.
    IP address
    IP address of the NAS server for File PEs.
    WWN
    The World Wide Name for Block PEs.
    Default SP
    Identifier for the preferred SP. Valid values are:
    • SPA
    • SPB
    Current SP
    Identifier for the current SP. Valid values are:
    • SPA
    • SPB
    NAS server
    Identifier of the associated NAS server for NAS PEs.
    VMware NAS PE server (NAS PEs only)
    ID of the corresponding VMware NAS PE server.
    VVol datastore (NAS PEs only)
    ID of the VVol datastore using the PE.
    Host (SCSI PEs only)
    Comma-separated list of identifiers for hosts that use the PE.
    Health state
    Health state.
    Health details
    Additional health information.

    View protocol endpoints

    Displays a list of existing protocol endpoints and their characteristics.

    Format
    /stor/prov/vmware/pe [{-id <value> | -type {nas [-vvolds <value>] | scsi [-host <value>]}}] show
    Object qualifier
    Qualifier
    Description
    -id
    Type the ID of the protocol endpoint.
    -type
    Enter the type of protocol endpoint. Valid values are:
    • nas
    • scsi
    -vvolds
    Type the ID of the associated VVol datastore. Applies only to NAS protocol endpoints.
    -host
    Type the ID of the associated host for the protocol endpoint.
    Example

    The following example shows the detail for all protocol endpoints on the system.

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /stor/prov/vmware/pe show -detail 
                              Storage system address: 10.64.75.201
Storage system port: 443
HTTPS connection

1:     ID                   = rfc4122.60060160-ca30-3c00-962b-87806445241a 
       Name                 = scsi_pe_1 
       Type                 = SCSI 
       VMware UUID          = rfc4122.60060160-ca30-3c00-962b-87806445241a 
       Export path          = 
       IP address           = 
       WWN                  = 60:06:01:60:CA:30:3C:00:96:2B:87:80:64:45:24:1A
       Default SP           = SPA 
       Current SP           = SPA 
       NAS Server           = 
       VMware NAS PE server = 
       VVol datastore       = 
       Host                 = Host_1 
       Health state         = OK (5) 
       Health details       = "The protocol endpoint is operating normally. No action is required."

    Manage VVol datastores

    VVols reside in VVol datastores, also known as storage containers, which are comprised of storage allocations from one or more capability profiles. Capability profiles are built on top of one or more underlying storage pools. You can create VVol datastores based on one or more capability profiles and then allocate a specific amount of space from the capability profile to the VVol datastore.

    Each VVol datastore has one or more capability profiles that describe its performance and capacity characteristics, such as drive type, FAST VP tiering policy, and space efficiency policy (thick or thin). These characteristics are derived based on the underlying storage pool. When a virtual volume is created in vSphere, it is assigned a storage policy profile. vSphere filters the compatible and incompatible available VVol datastores (from one or more storage systems) when the VVol is being created based on these profiles. Only VVol datastores that support the storage policy profile are considered compatible storage containers for deploying the VVol.

    Table 9. VVol datastore attributes
    Attribute
    Description
    ID
    VVol datastore identifier.
    Name
    VVol datastore name.
    Description
    VVol datastore description.
    VMware UUID
    VWware UUID of the VVol datastore.
    Health state
    Health state of the VVol datastore.
    Capability profile
    Comma-separated list of identifiers of capability profiles supported by the VVol datastore. Each identifier with a " (Not used)" suffix indicates that this profile can be removed from the VVol datastore.
    Storage pool ID
    Comma-separated list of identifiers of storage pools used for the VVol datastore.
    Total capacity
    Total capacity of the VVol datastore.
    Total current allocation
    Total current allocation of the VVol datastore in all associated storage pools.
    Total used capacity
    Total used capacity of the VVol datastore.
    Creation time
    Time when the VVol datastore was created.
    Hosts
    Hosts that have access to the datastore.
    Type
    Type of VVol datastore. Valid values are:
    • File
    • Block
    Last modified time
    Time when the VVol datastore was last modified.

    Create VVol datastores

    Create a datastore for VMware VVols.

    Format
    /stor/prov/vmware/vvolds create [-async] -name <value> [-descr <value>] -cp <value> -size <value> -type { block | file } [-hosts <value>]
    Action qualifier
    Qualifier
    Description
    -async
    Run the operation in asynchronous mode.
    -name
    Type a name for the VVol datastore.
    The name may contain alphanumeric values, a hyphen, an underscore, and a period. It cannot start with hyphen or period, and cannot consist only of digits.
    -descr
    Type a brief description for the VVol datastore.
    -cp
    Specify the list of identifiers of capability profiles supported by the VVol datastore.
    -size
    Specify the list of allocation sizes. Specify one allocation for the amount of total space available for VVol provisioning on the VVol datastore for the specified capability profile. If there are multiple capability profiles, the list should include allocation size respective to each capability profile.
    -type
    Specify the VVol datastore type. Valid values are:
    • block
    • file
    -hosts
    Specify the comma-separated list of hosts that will have access to the VVol datastore. For a list of eligible hosts, refer to View host configurations.
    Example

    The following command creates a VVol datastore with these settings:

    • A VVol datastore name of "Engineering department"
    • Associates the "cp_1" and "cp_2" capability profiles with this VVol datastore
    • Allocates 10 GBs and 12 GBs from capability profiles cp_1 and cp_2, respectively, to the VVol datastore
    • Grants access for "Host_1" and "Host_2" to the datastore
    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /stor/prov/vmware/vvolds create –name “Engineering department” –cp cp_1,cp_2 –size 10G,12G –type file –hosts “Host_1,Host_2” 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

ID = res_1
Operation completed successfully.

    View VVol datastores

    Display a list of existing VVol datastores and their characteristics.

    Format
    /stor/prov/vmware/vvolds [-id <value>] show
    Object qualifiers
    Qualifier
    Description
    -id
    Type the ID of the VVol datastore.
    Example

    The following command displays a list of VVol datastores and their characteristics.

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /stor/prov/vmware/vvolds show -detail 
                              Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

1:     ID                       = res_1
       Name                     = Performance
       Description              =
       VMware UUID              = 550e8400-e29b-41d4-a716-446655440000
       Type                     = Block
       Health state             = OK (5)
       Health details           = "The component is operating 
                                   normally. No action is required."
       Capability profile       = cp_1, cp_2 (Not used)
       Storage pool             = pool_1,pool_3
       Total capacity           = 128849018880 (120G)
       Total current allocation = 12884901888 (12G)
       Total used capacity      = 1073741824 (1G)
       Hosts                    = Host_1
       Creation time            = 2015-12-21 12:55:32            
       Last modified time       = 2016-01-15 10:31:56

2:     ID                       = res_2 
       Name                     = engineering 
       Description              = 
       VMware UUID              = rfc4122.534e0655-f5a3-41d7-8124-9d53be5d0c0d 
       Health state             = OK (5) 
       Health details           = "The component is operating 
                                   normally. No action is required." 
       Capability profile       = cp_1, cp_2 
       Storage pool             = pool_1, pool_2 
       Total capacity           = 644245094400 (600.0G) 
       Total current allocation = 0 
       Total used capacity      = 0 
       Creation time            = 2015-06-20 01:48:54 
       Last modified time       = 2015-06-20 01:48:54

    Manage VVol datastore allocation

    Manage the allocation of storage to VVol datastores.

    Table 10. VVol datastore allocation attributes
    Attribute
    Description
    ID
    VVol datastore allocation identifier.
    VVol datastore
    VVol datastore identifier.
    Capability profile
    Identifier of the associated capability profile.
    Storage pool
    Comma-separated list of identifiers of storage pools associated with the capability profile.
    Size
    Amount of total space available for VVol provisioning for a particular capability profile on the VVol datastore.
    Current allocation
    Quantity of primary storage currently allocated for the VVol datastore for VVols provisioned with a particular capability profile on the VVol datastore.
    Size used
    Amount of space used by virtual volumes provisioned with a particular capability profile on the VVol datastore.
    Health state
    Health state of the VVol datastore allocation.
    Health details
    Additional health information.

    View VVol datastore allocation details

    Displays existing VVol datastore allocations.

    Format
    /stor/prov/vmware/vvolds/alloc -vvolds {-id <value> | -vvolds <value> [{-pool <value> | -cp <value>}]} show
    Object qualifier
    Qualifier
    Description
    -id
    Type the allocation identifier of the VVol datastore.
    -vvolds
    Type the ID of the VVol datastore.
    -pool
    Type the ID of the storage pool.
    -cp
    Type the ID of the capability profile.
    To obtain the ID of the VVol datastore and it's associated pool and capability profile IDs, refer to View VVol datastores.
    Example

    The following command shows the allocation details for the VVol datastore "vvol_1" from pool "pool_1", including associated capability profile IDs, current size of the storage pool, and current size allocated to the VVol datastore from the storage pool.

    uemcli /stor/prov/vmware/vvolds/alloc -vvolds vvolds_1 -pool pool_1 show -detail 
                                  Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

1:     ID                 = cpa_1 
       VVol datastore     = res_1 
       Capability profile = cp_1 
       Storage pool       = pool_1 
       Size               = 128849018880 (120G) 
       Current allocation = 12884901888 (12G) 
       Size used          = 1073741824 (1G) 
       Health state       = OK (5) 
       Health details     = "The component is operating 
                             normally. No action is required."

    Change VVol datastores

    Modify an existing VVol datastore.

    Format
    /stor/prov/vmware/vvolds -id <value> set [-async] [-name <value>] [-descr <value>] [{-addCp <value> -size <value> | -modifyCp <value> -size <value> | -removeCp <value>}] [-hosts <value> [-force]]
    Object qualifier
    Qualifier
    Description
    -id
    Type the ID of the VVol datastore to be modified.
    Action qualifier
    Qualifier
    Description
    -async
    Run the operation in asynchronous mode.
    -name
    Type a name for the VVol datastore.
    The name may contain alphanumeric values, a hyphen, an underscore, and a period. It cannot start with hyphen or period, and cannot consist only of digits.
    -descr
    Type a new description for the VVol datastore.
    -addCp
    Type the list of identifiers of new capability profiles the VVol datastore will support.
    -modifyCp
    Type the list of identifiers of capability profiles already supported by the VVol datastore and specify the new allocated sizes for each.
    -size
    Specify the list of allocation sizes. Specify one allocation for the amount of total space available for VVol provisioning on the VVol datastore for the specified capability profile. If there are multiple capability profiles, the list should include allocation size respective to each capability profile.
    -removeCp
    Type the list of identifiers of capability profiles you would like to remove from the VVol datastore.
    This command can only used on capability profiles that are not currently in use by existing virtual volumes.
    -hosts
    Type the list of comma-separated hosts that will have access to the VVol datastore.
    -force
    Type to unconditionally unbind all virtual volumes that are currently bound to a protocol endpoint associated with a particular host.
    If host access is changed or removed for a VVol datastore, the associated protocol endpoints are automatically unbound.
    Example

    The following command modifies the following settings of a VVol datastore:

    • Changes the description of the VVol datastore to "My new description"
    • Changes the name of the VVol datastore to "MyNewName"
    • Associates the capability profile "cp_1" with VVol datastore "res_1"
    • Allocates 10 GBs of space from the pool to capability profile "cp_1"
    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /stor/prov/vmware/vvolds -id res_1 set -name MyNewName -descr "My new description" -addCp cp_1 -size 10G 
                              
Storage system address: 10.0.0.1 
Storage system port: 443 
HTTPS connection

ID = res_1 
Operation completed successfully.

    Delete VVol datastores

    Deletes specified VVol datastores and their associated virtual volumes.

    Format
    /stor/prov/vmware/vvolds [-id <value>] delete [-async] [-force { yes | no}]
    Object qualifier
    Qualifier
    Description
    -id
    Type the ID of the VVol datastore.
    Action qualifier
    Qualifier
    Description
    -force
    Delete the VVol datastore and any of its associated VVols. Valid values are:
    • yes
    • no
    -async
    Run the operation in asynchronous mode.
    Example

    The following command deletes VVol datastore res_1 as well as its virtual volumes.

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /stor/prov/vmware/vvolds -id res_1 delete -force yes 
                              
Storage system address: 10.0.0.1 
Storage system port: 443 
HTTPS connection 

Operation completed successfully.

    Manage VVol objects

    Virtual volumes are encapsulations of virtual machine files, virtual disks, and their derivatives. There are several types of VVol objects that correspond to an individual virtual volume, including a VMDK VVol (data VVol), Config VVol, Memory VVol, and Swap VVol.

    Table 11. Types of VVols
    VMDK (Data) VVol
    The VMDK VVol, displayed as Data VVol in Unisphere, contains the vDisk file, or the hard disk drive, for the VM.
    Config VVol
    The Config VVol contains settings, configuration, and state information for the VM. This includes .vmx, nvram, and log files.
    Memory VVol
    The Memory VVol contains a complete copy of the VM memory as part of a with-memory VM snapshot.
    Swap VVol
    The Swap VVol is created when VMs are powered on and contain copies of the VM memory pages that are not retained in memory.
    Table 12. VVol attributes
    Attribute
    Description
    ID
    Virtual volume identifier.
    Name
    Virtual volume name. Valid values are:
    • Data
    • Config
    • Memory
    • Swap
    • Other
    Replica type
    Virtual volume replica type. Valid values are:
    • Base
    • Prepared Snap
    • Ready Snap
    • Fast-Clone
    Parent
    Identifier of the base/parent virtual volume for the snap, prepared snap, or fast-clone.
    Health state
    Health state of the virtual volume.
    Health details
    Additional health information for the virtual volume.
    Datastore
    Identifier of the datastore associated with the virtual volume.
    Capability profile
    Identifier of the capability profile associated with the virtual volume.
    Storage pool
    Identifier of the storage pool that contains the virtual volume.
    Policy profile
    Name of the VMware vSphere policy profile.
    Compliant
    Indicates whether the virtual volume is compliant with the VMware vSphere policy profile.
    Current allocation
    Total current allocation of the virtual volume.
    Bound to
    Comma-separated list of protocol endpoint identifiers to which the virtual volume is bound. An empty value indicates an unbound virtual volume.
    Binding details
    Binding details of the protocol endpoint to which the virtual volume is bound.
    • For virtual volumes bound to NFS protocol endpoints, this displays the full NFS paths.
    • For virtual volumes bound to iSCSI protocol endpoints, this displays the virtual volume iSCSI secondary ID.
    • For unbound virtual volumes, this value is empty.
    Virtual machine
    Identifier of the virtual machine.
    VM hard disk
    Name of the associated VM hard disk.

    View VVol objects

    Display a list of existing VVol datastores and their characteristics.

    Format
    /stor/prov/vmware/vvol {[-id <value> | [-vm <value>] [-cp <value>] [-pool <value>] [-datastore <value>] [-pe <value>] [-parent <value>] [-bound] [-noncompliant] } show
    Object qualifier
    Qualifier
    Description
    -id
    Type the ID of the virtual volume.
    -vm
    Type the ID of the associated VM for the virtual volume.
    -cp
    Type the ID of the capability profile associated with the virtual volume.
    -pool
    Type the ID of the storage pool that contains the virtual volume.
    -datastore
    Type the ID of the associated VVol datastore.
    -pe
    Type the ID of the protocol endpoint for which you want to see bound virtual volumes.
    -parent
    Type the ID of the parent virtual volume.
    -bound
    Specify in order to display a list of only bound virtual volumes.
    -noncompliant
    Specify in order to display only a list of virtual volumes not compliant with their respective VMware policy profiles.
    Example

    The following example displays the details of all VVols for the VM with the ID VM_1.

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /stor/prov/vmware/vvol –vm VM_1 show -detail 
                              Storage system address: 10.64.75.201
Storage system port: 443
HTTPS connection

1:     ID                 = rfc4122.de305d54-75b4-431b-adb2-eb6b9e546014  
       Name               = Hard disk 1
       Type               = Data
       Replica type       = Base
       Parent             =
       Health state       = OK (5)
       Health details     = "The component is operating normally. No action is required."
       Datastore          = res_1
       Storage pool       = pool_1
       Capability profile = cp_1
       Policy profile     = VMware policy profile
       Compliant          = yes
       Size               = 1073741824 (1G)
       Thin               = yes
       Current allocation = 107374182 (100M)
       Bound to           = NASPE_1
       Binding details    = 192.168.3.3:/vvol1
       Virtual machine    = VM_1
       VM hard disk       = VM Hard Disk 1

    Delete VVol objects

    Deletes the specified existing VVol objects.

    Deletion of VVol objects must be exclusively confirmed by the user. The following confirmation message will display: 
                                  Virtual volume deletion will also unbind and delete associated snapshots and fast-clones. Do you want to delete the virtual volume? 
yes / no:
    The default in silent mode is yes.
    Format
    /stor/prov/vmware/vvol -id <value> delete [-async]
    Object qualifier
    Qualifier
    Description
    -id
    Type the ID of the virtual volume.
    Action qualifier
    Qualifier
    Description
    -async
    Run the operation in asynchronous mode.
    Example

    The following command deletes the virtual volume with the ID naa.6006016005603c009370093e194fca3f.

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /stor/prov/vmware/vvol –id naa.6006016005603c009370093e194fca3f delete 
                              
Virtual volume deletion will also unbind and delete associated snapshots and fast-clones. Do you want to delete the virtual volume? 
yes / no: 
yes

Storage system address: 10.0.0.1
Storage system port: 443
HTTPS connection

Operation completed successfully.