• Protect Data

    PDF

    Protect Data

    Manage snapshots

    A snapshot is a virtual point-in-time image of the data within a storage resource that has changed since the last snapshot. Snapshots provide a record of the content in the targeted storage resource at a particular date and time, but are not mirror copies of the data. Periodically creating snapshots of file systems and LUNs provides an effective technique for meeting data protection and recovery requirements. Based on the importance and volatility of data within a storage resource, you can define recurring schedules that specify times and intervals for snapshot operations.

    Use snapshots to perform the following:

    • Restore a storage resource to a previous point-in-time.
    • Access the contents of a snapshot to recover corrupted or accidentally deleted files and data.

    To routinely take snapshots automatically, associate a snapshot with a schedule. Manage snapshot protection schedules explains how to configure schedules on the system. Each snapshot is identified by an ID.

    Note:  Snapshots do not provide a substitute for storage backup operations. Snapshots are not intended for recovering from disasters or the loss of physical equipment.

    The following table lists the attributes for snapshots:

    Table 1. Snapshot attributes
    Attribute
    Description
    ID
    ID of the snapshot.
    Name
    Name of the snapshot.
    State
    State of the snapshot. Valid values are:
    • initializing
    • ready
    • faulted
    • offline
    • destroying
    Attached
    Indicates whether the snapshot is attached to a host.
    Note:  This field is blank for file system snapshots.
    Source
    ID of the storage resource of which the system created the snapshot.
    Source type
    Type of storage resource of which the system created the snapshot.
    Attach details
    Comma-separated list of export paths or WWNs for attached snapshots.
    Members
    Comma-separated list of the member LUNs of the snapshot.
    Note:  This field is blank for file system snapshots.
    Source snapshot
    For a snapshot of a snapshot, the ID of the parent snapshot.
    Description
    Snapshot description.
    Creation time
    Date and time when the snapshot was created.
    Expiration time
    Date and time when the snapshot will expire and be deleted from the system. Default is 7 days.
    Last writable time
    Last time the snapshot or its parent snapshot was detached.
    Last refresh time
    Indicates the last time that the snapshot was refreshed.
    Created by
    Name of the user, protection schedule, or backup process that created the snapshot. Valid values are:
    • For manual snapshots created by a user, the user account name.
    • For scheduled snapshots, the name of the protection schedule.
    • For snapshots created by host backup software:
      • NDMP—Indicates a snapshot created by using the Network Data Management Protocol (NDMP).
      • VSS—Indicates a snapshot created by using the Microsoft Volume Snapshot Service (VSS), also called Shadow Copy or Previous Version.
    • Snapshot Restore—Indicates a snapshot created automatically by the system when restoring a file system or VMware NFS datastore. You can use the snapshot to return the storage resource to the state it was in prior to the last restore.
    Modified
    Indicates whether the snapshot is or was previously attached to a snapshot mount point, or has shares. Valid values are:
    • yes
    • no
    Allow auto-delete
    Indicates whether or not the system can automatically delete the snapshot. Valid values are:
    • yes
    • no
    Default value is yes.
    Size
    Pool capacity consumed by the snapshot.
    Note:  This field is blank for snapshots of consistency groups and VMware block applications.
    Access
    Indicates whether a file system snapshot is a read-only checkpoint, or read/write for user access.
    IO limit
    Comma-separated IO limit policy IDs for the attached snapshots of block-based storage resources. Members of a snapshot group can have different IO limit policy IDs.
    Effective maximum IOPS
    Dependant on the policy type. For a density-based policy, this value is the product of the maximum IOPS and the size of the attached snapshot. This is a read-only attribute.
    Effective maximum KBPS
    Dependant on the policy type. For a density-based policy, this value is the product of the maximum KBPS and the size of the attached snapshot. This is a read-only attribute.
    Read/write hosts
    Comma-separated list of identifiers of hosts allowed writing data. Applies only if the snapshot is attached to a dynamic snapshot mount point.
    Read-only hosts
    Comma-separated list of identifiers of hosts allowed reading data. Applies only if the snapshot is attached to a dynamic snapshot mount point.
    Replicated
    Indicates whether the snapshot is asynchronously replicated. Valid values:
    • no—Not marked for replication
    • pending—Marked for replication, but waiting synchronization
    • yes—Successfully replicated to destination
    • failed to replicate, check System Alerts for details—Failed to replicate
    Sync replicated
    Indicates whether the snapshot participates in a synchronous replication session. Valid values:
    • no—Either the snapshot was created on the destination site and will not be replicated on the source, or the snapshot was created before a synchronous replication session was set up.
    • yes—Successfully replicated.
    • failed to replicate—Snapshot was created on the source site while a replication session was in a fractured state. The snapshot was not replicated to the destination site.
    Remote expiration time
    Time when the snapshot will be removed on the destination.
    Remote allow auto-delete
    Indicates whether this snapshot participates in auto-delete on the destination. Valid values are:
    • yes
    • no
    Default value is no.

    Create snapshots

    Create a snapshot of a storage resource.

    Note:  Snapshots of LUNs are not intended for use as mirrors, disaster recovery, or high-availability tools. Because LUN snapshots are partially derived from real-time data on the LUNs, snapshots can become inaccessible (not readable) if the primary LUN becomes inaccessible.
    Prerequisites

    Snapshots are stored in the protection capacity of the storage resource. Ensure that enough protection capacity exists to accommodate snapshots. View file systems explains how to view the current protection storage size for file systems. View LUNs explains how to view the current protection size for LUNs.

    Format
    /prot/snap create [-async] [-name <value>] [-descr <value>] [{-keepFor <value> | -allowAutoDelete {yes | no}}] [-access {ckpt | share}] [-replicate [{-keepSameAsSource | -keepRemotelyFor <value> | -allowRemoteAutoDelete {yes | no}}]]
    Action qualifiers
    Qualifier
    Description
    -async
    Run the operation in asynchronous mode.
    -name
    Type a name for the snapshot.
    -descr
    Type a description for the snapshot.
    -source
    Type the ID of the storage resource of which to take a snapshot. View file systems explains how to view the settings for file systems. View consistency groups explains how to view the settings for iSCSI storage resources
    -keepFor
    Specify the amount of time to retain a snapshot before it expires. The interval can be defined in days or hours. The system deletes expired snapshots automatically. Use the following format:

    <value><qualifier>

    where:
    • value — Type the number of hours or days:
      • For hours, the range is 1–8760.
      • For days, the range is 1–365.
    • qualifier — Type the value qualifier. Value is one of the following:
      • h – Indicates hours.
      • d – Indicates days.
    Note:  For scheduled snapshots, which are associated with a schedule, include the -keepFor qualifier in the schedule rules to specify the retention period. Manage task rules provides details about schedule rules.
    -allowAutoDelete
    Specify whether the system can automatically delete the snapshot or snapshot set. Valid values are:
    • yes (default)
    • no
    -access
    Specify whether the snapshot is a read-only checkpoint, or read/write for CIFS (SMB) shares or NFS exports. Valid values are:
    • ckpt (default)
    • share
    -replicateSnap
    Specify whether to mark this snapshot for replication. Valid values:
    • yes
    • no (default)
    -keepSameAsSource
    Indicates whether to use the same retention policy (expiration time and auto-delete) of the source for the destination. This is a one-time copy of the source snapshot retention policy and the remote retention policy does not update if the source retention policy is changed. No values are allowed.
    -keepRemotelyFor
    Specifies the retention time after which the snapshot is deleted on the destination. The interval can be defined in days or hours. The format of the value is as follows:

    <value><qualifier>

    where:
    • value - - An integer value. If the qualifier is h (hours), the valid range is from 1 to 43800. If the qualifier is d (days), the valid range is from 1 to 1825.
    • qualifier - A value qualifier. The valid values are h (hours) and d (days).
    -allowRemoteAutoDelete
    Indicates whether auto delete is allowed on the replicated copy of this snapshot or snapshot set. Valid values are:
    • yes
    • no
    Example

    The following command takes a snapshot of a file system with these settings:

    • Name is accounting.
    • Storage resource is file system FS_1.
    • Retention period is 1 day.

    The snapshot receives ID SNAP_1:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/snap create –name accounting –source FS_1 -keepFor 1d
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    ID = SNAP_1
    Operation completed successfully.
    
                            

    View snapshots

    View details about snapshots on the system. You can filter on the snapshot ID, snapshot name, or storage resource ID.

    Note:   The show action command explains how to change the output format.
    Format
    /prot/snap [{-id <value> | -name <value>} [-members] | -source <value>}] show
    Object qualifier
    Qualifier
    Description
    -id
    Identifies the ID of a snapshot.
    -name
    Identifies the name of the snapshot.
    -members
    Flag indicating that only member snapshots will be shown.
    Note:  This is applicable to snapshots of Consistency groups and VMware VMFS storage resources only.
    -source
    Identifies the ID of a storage resource to view only the snapshots related to it.
    Example

    The following command displays details about all snapshots on the system:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/snap show -detail
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    1:    ID                       = 171798691881
          Name                     = FS_Snapshot1
          State                    = Ready
          Attached                 = no
          Resource                 = res_1
          Resource Type            = File system
          Source                   = res_1
          Source Type              = File system
          Members                  =
          Attach details           =
          Source Snapshot          =
          Description              =
          Creation time            = 2016-06-27 17:02:07
          Expiration time          = Never
          Last writable time       = Never
          Last refresh time        = Never
          Created by               = admin
          Modified                 = no
          Allow auto-delete        = yes
          Size                     = 3221225472 (3.0G)
          Access                   = Protocol
          IO limit                 =
          Effective maximum IOPS   =
          Effective maximum KBPS   =
          Replicated               = pending
          Sync replicated          = no
          Remote expiration time   = Never
          Remote allow auto-delete = yes
          Read/write hosts         =
          Read-only hosts          =
                            

    Attach snapshots to hosts

    For snapshots of storage resources, attach a snapshot to make it available to hosts.

    Note:  If the default attach type is used, before a host can access an attached snapshot, it must have snapshot permissions to the appropriate storage resource. Manage LUNs explains how to configure host access permissions for LUN storage resources.
    Format
    /prot/snap {–id <value> | -name <value>} attach [-async] [–copyName <value>] [-type {default | dynamic [-roHosts <value>] [-rwHosts <value>][-force {yes | no}]}]
    Object qualifier
    Qualifier
    Description
    -id
    Type the ID of the snapshot to attach.
    -name
    Type the name of the snapshot to attach.
    Action qualifiers
    Qualifier
    Description
    -async
    Run the operation in asynchronous mode.
    -copyName
    Specify the name of the copy the system creates before attaching the selected snapshot. If this switch is specified and no name is provided, the system assigns a name to the copy.
    Note:  If this switch is not specified, no copy is created.
    -type
    Attachment type. Valid values are (case insensitive):
    • default (default)—Allows promoting only one snapshot of the parent storage resource at a time.
    • dynamic—Allows promoting several snapshots of the same parent storage resource simultaneously.
    -roHosts
    Specify the comma-separated list of hosts that have read-only access to the snapshot.
    -rwHosts
    Specify the comma-separated list of hosts that have read/write access to the snapshot.
    -force
    Specify that read-write access for the snapshot can be configured, even though the object has independent thin clones. Valid values are:
    • yes
    • no (default)
    Example

    The following command attaches snapshot SNAP_1:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/snap –id SNAP_1 attach –type dynamic –roHosts Host_1,Host_2 –rwHosts Host_3,Host_4
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    Operation completed successfully.
                            

    Refresh snapshots

    Note:  The refresh snapshots command is only valid for block snapshots.
    Format
    /prot/snap {-id <value> | -name <value>} refresh [-async] [-copyName <value>]
    Object qualifier
    Qualifier
    Description
    -id
    ID of the snapshot to refresh.
    -name
    Name of the snapshot to refresh.
    Action qualifiers
    Qualifier
    Description
    -async
    Run the operation in asynchronous mode.
    -copyName
    Specify the name of the copy the system creates before the refresh operation. If the name specified is blank (" "), a copy will be created with a date/time stamp name.
    Note:  If this switch is not specified, no copy is created.
    Example

    The following command refreshes a snapshot:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/snap –id 38654705680 refresh –copyName copy1
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    ID = 38654705680
    Operation completed successfully
                            

    Replicate snapshots

    Note:   Use to replicate snapshots after they have been created.
    Format
    /prot/snap {-id <value> | -name <value>} replicate {-keepSameAsSource | -keepRemotelyFor <value> | -allowRemoteAutoDelete {yes | no}}
    Object qualifier
    Qualifier
    Description
    -id
    Identifies the snapshot.
    -name
    Identifies the snapshot by its name.
    Action qualifier
    Qualifier
    Description
    -keepSameAsSource
    Indicates whether or not to use the same retention policy (expiration time and auto-delete) of the source for the destination. This is a one-time copy of the source snapshot retention policy and the remote retention policy does not update if the source retention policy is changed.
    -keepRemotelyFor
    Specifies the retention period after which the snapshot is deleted on the destination. The interval can be defined in days or hours. The format of the value is the following:

    <value><qualifier>

    where:
    • value—Type the number of hours or days:
      • For hours, the range is 1–43800.
      • For days, the range is 1–1825.
    • qualifier—Type the value qualifier. Value is one of the following:
      • h—Indicates hours.
      • d—Indicates days.
    -allowRemoteAutoDelete
    Indicates whether auto delete is allowed on the replicated copy of this Snapshot or Snapshot Set. Valid values are:
    • yes
    • no
    Example

    The following command replicates a snapshot:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/snap –id 38654705680 replicate -keepRemotelyFor 1d
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    Operation completed successfully.
                            

    Detach snapshots

    For snapshots of storage resources, detach an attached snapshot to block host access to the snapshot.

    Note:  Before a host can access an attached snapshot, it must have snapshot permissions to the appropriate storage resource. Manage LUNs explains how to configure host access permissions for LUN storage.
    Format
    /prot/snap {-id <value> | -name <value> } detach [-async]
    Object qualifier
    Qualifier
    Description
    -id
    Type the ID of the snapshot to detach.
    -name
    Type the name of the snapshot to detach.
    Action qualifiers
    Qualifier
    Description
    -async
    Run the operation in asynchronous mode.
    Example

    The following command detaches snapshot SNAP_1:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/snap –id SNAP_1 detach
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    Operation completed successfully.
    
                            

    Restore storage resources to snapshots

    Restore a storage resource to a snapshot to return (roll back) the storage resource to a previous state. During the restore, the entire storage resource, including all files and data stored on it, is replaced with the contents of the selected snapshot.

    When you restore a storage resource to a snapshot, before the restoration begins, the system will automatically create a snapshot of the storage resource's current state. This ensures that there is no unintentional data loss because of the restore operation. You can use this new snapshot later to restore the storage resource back to its previous state, if necessary.

    Prerequisites
    • To prevent data loss, ensure that all hosts have completed all read and write operations to the storage resource you want to restore.
    • For LUN storage:
      • If the snapshot is attached, you must first detach it or an error will appear when you attempt to restore to it.
      • If a host is connected to the LUN (seen by the host as a disk) you want to restore, perform one of the following to the LUN to disconnect it from the host:
        • On Windows, disable the LUN in the Device Manager, which might require a host reboot.
        • On Linux/UNIX, run the unmount command on the virtual.
        Once the LUN is disconnected, you can continue with the restore and then enable and mount the restored LUN on the host.
    Format
    /prot/snap {-id <value> | -name <value> } restore [-backupName <value>][-async]
    Object qualifier
    Qualifier
    Description
    -id
    Type the ID of the snapshot to which you want to restore the associated storage resource.
    -name
    Type the name of the snapshot to which you want to restore the associated storage resources.
    Action qualifiers
    Qualifier
    Description
    -async
    Run the operation in asynchronous mode.
    -backupName
    Specifies the name of the snapshot the system creates automatically as the initial step of the restoration process. The system assigns a name to this snapshot if the user does not provide one.
    Example

    The following command restores snapshot SNAP_1, which is a snapshot of iSCSI storage:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/snap –id SNAP_1 restore
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    Operation completed successfully.
    
                            

    Delete snapshots

    Delete (destroy) a snapshot of a storage resource.

    Note:  Once you delete a snapshot, you can no longer recover data from it or restore a storage resource to it.
    Format
    /prot/snap {-id <value> | -name <value>} delete [-async] [-overrideLock] [-force]
    Object qualifier
    Qualifier
    Description
    -id
    Type the ID of the snapshot to delete.
    -name
    Type the name of the snapshot.
    Action qualifiers
    Qualifier
    Description
    -async
    Run the operation in asynchronous mode.
    -overrideLock
    Override the restriction preventing the deletion of a snapshot that is locked by an application. Attempting to delete a locked snapshot without this option specified will return an error message containing the details of the application that has the snapshot locked.
    Note:  Do not use this option if applications are currently referencing the snap, to avoid a performance impact on these applications. This option will not bypass all restrictions, only the lock that certain applications may have on the snapshot.
    -force
    Unconditionally removes the snapshot on the destination site, even if it is marked as replicated by the synchronous replication session.
    Note:  This option is applicable for synchronous destination site snapshots only.
    Example

    The following command deletes snapshot SNAP_1:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/snap –id SNAP_1 delete
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    Operation completed successfully.
                            

    Copy snapshots

    Copy a snapshot.

    Format
    /prot/snap { -id <value> | -name <value> } copy [-async] [-copyName <value>]
    Object qualifier
    Qualifier
    Description
    -id
    Type the ID of the snapshot to which you want to restore the associated storage resource.
    -name
    Type the name of the snapshot to which you want to restore the associated storage resources.
    Action qualifiers
    Qualifier
    Description
    -async
    Run the operation in asynchronous mode.
    -copyName
    Type the name of the copy the system creates before attaching the selected snapshot. If this switch is specified and no name is provided, the system assigns a name to the copy.
    Note:  If this switch is not specified, no copy is created.
    Example

    The following command creates a copy of SNAP_1 named SNAP_Copy:

    • Name is accounting.

    The snapshot receives ID SNAP_1:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/snap -id SNAP_1 copy –copyName SNAP_Copy
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    ID = SNAP_1
    Operation completed successfully.
    
                            

    Modify snapshots

    Change the settings of a snapshot.

    Format
    /prot/snap {-id <value> | -name <value>} set [-async] [-newName <value>] [-descr <value>] [{-keepFor <value> | -allowAutoDelete {yes|no}}] [-roHosts <value> -rwHosts <value>] [-force]
    Object qualifier
    Qualifier
    Description
    -id
    Type the ID of the snapshot to which you want to restore the associated storage resource.
    -name
    Type the name of the snapshot to which you want to restore the associated storage resources.
    Action qualifiers
    Qualifier
    Description
    -async
    Run the operation in asynchronous mode.
    -newName
    Type a new name for the snapshot.
    -descr
    Type a description for the snapshot.
    -keepFor
    Specify the amount of time to retain a snapshot before it expires. The interval can be defined in days or hours. The system deletes expired snapshots automatically. Use the following format:

    <value><qualifier>

    where:
    • <value>—Type the number of hours or days:
      • For hours, the range is 1–8760.
      • For days, the range is 1–365.
    • <qualifier>—Type the value qualifier. Value is one of the following:
      • h—Indicates hours.
      • d—Indicates days.
    Note:  For scheduled snapshots, which are associated with a schedule, include the -keepFor qualifier in the schedule rules to specify the retention period. Manage task rules provides details about schedule rules.
    -allowAutoDelete
    Specify whether the system can automatically delete the snapshot or snapshot set. Valid values are:
    • yes
    • no
    -roHosts
    Specify a comma-separated list of hosts that will have read-only access to the snapshot. This option applies only if the snapshot is attached to a dynamic snapshot mount point.
    -rwHosts
    Specify a comma-separated list of hosts that will have read/write access to the snapshot. This option applies only if the snapshot is attached to a dynamic snapshot mount point.
    -force
    Unconditionally modifies the snapshot on the destination site, even if it is marked as replicated by the synchronous replication session.
    Note:  This option is applicable for synchronous destination site snapshots only.
    Example

    The following command changes the name of snapshot SNAP_1 to MySnap:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/snap -id SNAP_1 set -newName MySnap
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    ID = SNAP_1
    Operation completed successfully.
                            

    Manage snapshot NFS shares

    The following table lists the attributes for snapshot NFS share:

    Table 2. Snapshot NFS share attributes
    Attribute
    Description
    ID
    ID of the snapshot NFS share.
    Name
    Name of the snapshot NFS share.
    Description
    Description of the snapshot NFS share.
    Snapshot
    Parent snapshot (see Manage snapshots.)
    Local path
    Local path to be exported.
    Export path
    Export path to the share.
    Default access
    Specifies the default access level. Valid values are:
    • ro — Read-only access
    • rw — Read/write access
    • root — Root access
    • na — No access
    Read-only hosts
    Comma-separated list of identifiers of hosts allowed reading data.
    Read/write hosts
    Comma-separated list of identifiers of hosts allowed reading and writing data.
    Root hosts
    Comma-separated list of identifiers of hosts with root permissions.
    No access hosts
    Comma-separated list of identifiers of hosts without access.
    Creation time
    Creation time of the share.
    Last modified time
    Last modified time of the share.
    Role
    Role of the snapshot NFS share. Valid values are:
    • backup – Indicates that the snapshot share is operating in a backup role. Applies to snapshot shares created for the purposes of backup and disaster/recovery on a NAS server operating in a replication destination mode.
      Note:  When a NAS server fails over, and becomes the source system in a replication, the role of snapshot shares on the NAS server still reflect the backup role.
    • production – Indicates that the snapshot share is operating in a production role. On NAS servers that are not acting as a replication destination, all snapshot shares operate in a production mode.
    Minimum security
    The minimal security option that must be provided by a client for the NFS mount operation. Valid values are (from least secure to most secure):
    • sys – Also known as AUTH_SYS security. This indicates there is no server-side authentication. When secure NFS is not configured on a NAS server, this is the default value.
    • krb5 – Kerberos v5 authentication. This is the default value when secure NFS is configured on the NAS server.
    • krb5i – Kerberos v5 authentication and integrity.
    • krb5p – Kerberos v5 authentication and integrity, with encryption enabled.
    Note:   Read-only hosts, Read/write hosts, Root hosts, and No access hosts attributes are displayed as a comma-separated list of pairs of host identifiers and tokens enclosed with square brackets. The token format depends on the host type:
    • host — Comma-separated list of IP addresses.
    • subnet — Pair of IP address and netmask delimited by slash.
    • netgroup — Netgroup network address.

    Create NFS snapshots

    Create a snapshot NFS share.

    Format
    /prot/snap/nfs create [-async] -name <value> [-descr <value>] -snap <value> -path <value> [-defAccess {ro | rw | root | na}] [-roHosts <value>] [-rwHosts <value>] [-rootHosts <value>] [-naHosts <value>] [-secEnforced {sys | krb5 | krb5i | krb5p}]
    Action qualifier
    Qualifier
    Description
    -async
    Run the operation in asynchronous mode.
    -name
    Type the username of the share.
    -descr
    Type the description of the share.
    -snap
    Type the snapshot to associate the share with.
    -path
    Type the path at which to mount the file system. Default value is /.
    -defAccess
    Specifies the new user description of the share. Valid values are:
    • ro — Read-only access
    • rw — Read/Write access
    • root — Root access
    • na — No access
    -roHosts
    Specifies the comma-separated list of identifiers of hosts allowed to read. Optionally, it's allowed to select the IP addresses of the host of type host. They shall be defined as a comma-separated list of IP addresses enclosed with square brackets and following the host identifier.
    -rwHosts
    Specifies the comma-separated list of identifiers of hosts allowed to read and write. Optionally, it's allowed to select the IP addresses of the host of type host. They shall be defined as a comma-separated list of IP addresses enclosed with square brackets and following the host identifier.
    -rootHosts
    Specifies the comma-separated list of identifiers of hosts with root permissions. Optionally, it's allowed to select the IP addresses of the host of type host. They shall be defined as a comma-separated list of IP addresses enclosed with square brackets and following the host identifier.
    -naHosts
    Specifies the comma-separated list of identifiers of hosts without access. Optionally, it's allowed to select the IP addresses of the host of type host. They shall be defined as a comma-separated list of IP addresses enclosed with square brackets and following the host identifier.
    -secEnforced
    Specifies the minimal security option that must be provided by a client for the NFS mount operation. Valid values are (from least secure to most secure):
    • sys – Also known as AUTH_SYS security. This indicates there is no server-side authentication. When secure NFS is not configured on a NAS server, this is the default value.
    • krb5 – Kerberos v5 authentication. This is the default value when secure NFS is configured on the NAS server.
    • krb5i – Kerberos v5 authentication and integrity.
    • krb5p – Kerberos v5 authentication and integrity, with encryption enabled.
    Example

    The following command takes a snapshot of a file system with these settings:

    • Name is NFSshare.
    • Description is “My share.”
    • Snapshot ID is SNAP_1.
    • Path is /.
    • Read-only hosts are Host_1 and Host_2.
    • Read/write host is Host_3.
    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/snap/nfs create –name NFSshare -descr “My share” –snap SNAP_1 -path / -roHosts “Host_1, Host_2” -rwHosts “Host_3”
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    ID = nfs_1
    Operation completed successfully.
                            

    View snapshot NFS shares

    Lists the existing snapshot NFS shares.

    Format
    /prot/snap/nfs [{-id <value> | -name <value> | -snap <value> | -snapName <value>}] show
    Object qualifier
    Qualifier
    Description
    -id
    ID of the NFS share.
    -name
    Name of the NFS share.
    -snap
    ID of the parent snapshot. The list of shares associated with the identified snapshot will be displayed.
    -snapName
    Name of the parent snapshot. The list of shares associated with the identified snapshot will be displayed.
    Example
    uemcli /prot/snap/nfs show -detail
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    1:    ID                 = nfs_2
          Name               = Share_2012-08-24 16:05_00
          Description        =
          Snapshot           = app_1_sg_1
          Local path         = /group.app_1_sg_1.fs.fs_1_wckp
          Export path        = 10.64.76.120:/Share_2012-08-24 16:05_00
          Default access     = na
          No access hosts    =
          Read-only hosts    = 1014[10.192.168.5,10.192.168.6], 1015[10.192.168.9]
          Read/write hosts   = 1016[10.244.245.0/255.255.255.0]
          Root hosts         =
          Creation time      = 2012-08-24 12:18:22
          Last modified time = 2012-08-24 12:18:22
          Role               = production
          Minimum security  = krb5
    
                            

    Set snapshot NFS share

    Modifies an existing snapshot NFS share.

    Format
    /prot/snap/nfs {-id <value> | -name <value>} set [-async] [-descr <value>] [-defAccess {ro | rw | root | na}] [-roHosts <value>] [-rwHosts <value>] [-rootHosts <value>] [-naHosts <value>] [-minSecurity {sys | krb5 | krb5i | krb5p}]
    Object qualifier
    Qualifier
    Description
    -id
    ID of the snapshot NFS share.
    -name
    Name of the snapshot NFS share.
    Action qualifier
    Qualifier
    Description
    -async
    Run the operation in asynchronous mode.
    -descr
    Type the description of the share.
    -defAccess
    Specifies the new user description of the share. Valid values are:
    • ro—Read-only access
    • rw—Read/write access
    • root—Root access
    • na—No access
    -roHosts
    Specifies the comma-separated list of identifiers of hosts allowed to read. Optionally, it's allowed to select the IP addresses of the host of type host. They shall be defined as a comma-separated list of IP addresses enclosed with square brackets and following the host identifier.
    -rwHosts
    Specifies the comma-separated list of identifiers of hosts allowed to read and write. Optionally, it's allowed to select the IP addresses of the host of type host. They shall be defined as a comma-separated list of IP addresses enclosed with square brackets and following the host identifier.
    -rootHosts
    Specifies the comma-separated list of identifiers of hosts with root permissions. Optionally, it's allowed to select the IP addresses of the host of type host. They shall be defined as a comma-separated list of IP addresses enclosed with square brackets and following the host identifier.
    -naHosts
    Specifies the comma-separated list of identifiers of hosts without access. Optionally, it's allowed to select the IP addresses of the host of type host. They shall be defined as a comma-separated list of IP addresses enclosed with square brackets and following the host identifier.
    -minSecurity
    Specifies the minimal security option that must be provided by a client for the NFS mount operation. Valid values are (from least secure to most secure):
    • sys—Also known as AUTH_SYS security. This indicates there is no server-side authentication. When secure NFS is not configured on a NAS server, this is the default value.
    • krb5—Kerberos v5 authentication. This is the default value when secure NFS is configured on the NAS server.
    • krb5i—Kerberos v5 authentication and integrity.
    • krb5p—Kerberos v5 authentication and integrity, with encryption enabled.
    Example
    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/snap/nfs -id NFS_1 set -descr "My share"
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    ID = NFS_1
    Operation completed successfully.
                            

    Delete snapshot NFS shares

    Delete (destroy) a snapshot NFS share.

    Note:  Once you delete a snapshot share, you can no longer recover data from it or restore a storage resource to it.
    Format
    /prot/snap/nfs {-id <value> | -name <value>} delete [-async]
    Object qualifier
    Qualifier
    Description
    -id
    Type the ID of the snapshot to delete.
    -name
    Type the name of the snapshot to delete.
    Action qualifier
    Qualifier
    Description
    -async
    Run the operation in asynchronous mode.
    Example

    The following command deletes snapshot nfs_1:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/snap/nfs –id nfs_1 delete
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    Operation completed successfully.
                            

    Manage snapshot CIFS shares

    The following table lists the attributes for snapshot CIFS (SMB) shares.

    Table 3. Snapshot CIFS share attributes
    Attribute
    Description
    ID
    ID of the snapshot CIFS share.
    Name
    Name of the snapshot CIFS share.
    Description
    Description of the snapshot CIFS share.
    Snapshot
    Parent snapshot (see Manage snapshots.)
    Local path
    Local path to be exported.
    Export path
    Export path to the share.
    Creation time
    Creation time of the share.
    Last modified time
    Last modified time of the share.
    Availability enabled
    Continuous availability state.
    Encryption enabled
    CIFS encryption state.
    Umask
    Indicates the default Unix umask for new files created on the share. If not specified, the umask defaults to 022.
    ABE enabled
    Indicates whether an Access-Based Enumeration (ABE) filter is enabled. Valid values include:
    • yes — Filters the list of available files and folders on a share to include only those that the requesting user has access to.
    • no (default)
    DFS enabled
    Indicates whether Distributed File System (DFS) is enabled. Valid values include:
    • yes — Allows administrators to group shared folders located on different shares by transparently connecting them to one or more DFS namespaces.
    • no
    BranchCache enabled
    Indicates whether BranchCache is enabled. Valid values include:
    • yes — Copies content from the main office or hosted cloud content servers and caches the content at branch office locations. This allows client computers at branch offices to access content locally rather than over the WAN.
    • no (default)
    Offline availability
    Indicates whether Offline availability is enabled. When enabled, users can use this feature on their computers to work with shared folders stored on a server, even when they are not connected to the network. Valid values include:
    • none — Prevents clients from storing documents and programs in offline cache (default)
    • documents — All files that clients open will be available offline.
    • programs — All programs and files that clients open will be available offline. Programs and files will preferably open from offline cache, even when connected to the network.
    • manual — Only specified files will be available offline.

    Create a CIFS snapshot

    Create a snapshot CIFS (SMB) share.

    Format
    /prot/snap/cifs create [-async] -name <value> [-descr <value>] -snap <value> -path <value> [-enableContinuousAvailability {yes | no} ] [-enableCIFSEncryption {yes | no } ] [-umask <value> ] [-enableABE {yes | no} ] [-enableBranchCache {yes | no} ] [-offlineAvailability {none | documents | programs | manual} ]
    Action qualifier
    Qualifier
    Description
    -async
    Run the operation in asynchronous mode.
    -name
    Type the username of the share.
    -descr
    Type the description of the share.
    -snap
    Type the snapshot to associate the share with.
    -path
    Type the path on which to mount the shared file system.
    -enableContinuousAvailability
    Specify whether continuous availability is enabled.
    -enableCIFSEncryption
    Specify whether CIFS encryption is enabled.
    -umask
    Type the default Unix umask for new files created on the share.
    -enableABE
    Specify if Access-based Enumeration is enabled. Valid values are:
    • yes
    • no (default)
    -enableBranchCache
    Specify if BranchCache is enabled. Valid values are:
    • yes
    • no (default)
    -offlineAvailability
    Specify the type of offline availability. Valid values are:
    • none (default) — Prevents clients from storing documents and programs in offline cache.
    • documents — Allows all files that clients open to be available offline.
    • programs — Allows all programs and files that clients open to be available offline. Programs and files will open from offline cache, even when connected to the network.
    • manual — Allows only specified files to be available offline.
    Example

    The following command takes a snapshot of a file system with these settings:

    • Name is CIFSshare.
    • Description is “My share.”
    • Snapshot is "cifssnap1"
    • Path is /.
    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/snap/cifs create –name CIFSshare -descr “My share” -snap cifssnap1 -path /
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    ID = cifs_1
    Operation completed successfully.
                            

    View snapshot CIFS shares

    Lists the existing snapshot CIFS (SMB) shares.

    Format
    /prot/snap/cifs [{-id <value> | -name <value> | -snap <value> | -snapName <value>}] show
    Object qualifier
    Qualifier
    Description
    -id
    ID of the CIFS share.
    -name
    Name of the CIFS share.
    -snap
    ID of the parent snapshot. The list of shares associated with the identified snapshot will be displayed.
    -snapName
    Name of the parent snapshot. The list of shares associated with the identified snapshot will be displayed
    Example
    uemcli /prot/snap/cifs show
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    1:    ID                 = cifs_2
          Name               = Share_2012-08-24 16:05_00
          Description        =
          Snapshot           = app_1_sg_1
          Local path         = /group.app_1_sg_1.fs.fs_1_wckp
          Export path        = 10.64.76.120:/Share_2012-08-24 16:05_00
          Default access     = na
          No access hosts    =
          Read-only hosts    = 1014[10.192.168.5,10.192.168.6], 1015[10.192.168.9]
          Read/write hosts   = 1016[10.244.245.0/255.255.255.0]
          Root hosts         =
          Creation time      = 2012-08-24 12:18:22
          Last modified time = 2012-08-24 12:18:22
                            

    Set snapshot CIFS share

    Modifies an existing snapshot CIFS (SMB) share.

    Format
    /prot/snap/cifs {-id <value> | -name <value>} set [-async] [-descr <value>] [-enableContinuousAvailability {yes | no} ] [-enableCIFSEncryption {yes | no} ] [-umask <value> ] [-enableABE {yes | no} ] [-enableBranchCache {yes | no}] [-offlineAvailability {none | documents | programs | manual}]
    Object qualifier
    Qualifier
    Description
    -id
    ID of the snapshot CIFS share.
    -name
    Name of the snapshot CIFS share.
    Action qualifier
    Qualifier
    Description
    -async
    Run the operation in asynchronous mode.
    -desc
    Specifies the new user description of the share.
    -enableContinuousAvailability
    Specify whether continuous availability is enabled.
    -enableCIFSEncryption
    Specify whether CIFS encryption is enabled.
    -umask
    Type the default Unix umask for new files created on the share.
    -enableABE
    Specify if Access-Based Enumeration (ABE) is enabled. Valid values are:
    • yes
    • no
    -enableBranchCache
    Specify if BranchCache is enabled. Valid values are:
    • yes
    • no
    -offlineAvailability
    Specify the type of offline availability. Valid values are:
    • none—Prevents clients from storing documents and programs in offline cache.
    • documents—Allows all files that clients open to be available offline.
    • programs—Allows all programs and files that clients open to be available offline. Programs and files will open from offline cache, even when connected to the network.
    • manual—Allows only specified files to be available offline.
    Example
    uemcli /prot/snap/cifs -id cifs_1 set -descr "My share"
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    ID = cifs_1
    Operation completed successfully.
                            

    Delete snapshot CIFS shares

    Delete (destroy) a snapshot CIFS (SMB) share.

    Note:  Once you delete a snapshot share, you can no longer recover data from it or restore a storage resource to it.
    Format
    /prot/snap/cifs {-id <value> | -name <value>} delete [-async]
    Object qualifier
    Qualifier
    Description
    -id
    Type the ID of the snapshot to delete.
    -name
    Type the name of the snapshot to delete.
    Action qualifier
    Qualifier
    Description
    -async
    Run the operation in asynchronous mode.
    Example

    The following command deletes snapshot cif_1:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/snap/cifs –id smb_1 delete
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    Operation completed successfully.
                            

    Manage replication sessions

    Storage replication is a process in which storage data is duplicated either locally or to a remote network device. Replication produces a read-only, point-in-time copy of source storage data and periodically updates the copy, keeping it consistent with the source data. Storage replication provides an enhanced level of redundancy in case the main storage backup system fails. As a result:

    • Downtime associated cost of a system failure is minimized.
    • Recovery process from a natural or human-caused disaster is facilitated.

    Each replication session is identified by an ID. The Unisphere online help provides more details about storage replication.

    It is important to note that when replicating from a Unity system running a later OE version (for example, OE 4.1.x) to a Unity system running an older version (for example, OE 4.0.x), you cannot have new OE version features enabled on the source.

    Note:  At any given point in time, only one command is supported on a replication session. Before running a new command, ensure that you wait for the existing action on the replication session to complete.

    The following table lists the attributes for replication sessions:

    Table 4. Replication session attributes
    Attribute
    Description
    ID
    ID of the session.
    Name
    Name of the replication session.
    Session type
    Storage type of the session. Valid values are:
    • lun
    • block
    • file
    • nas server
    Synchronization type
    Type of synchronization. Valid values are:
    • auto—Data is replicated automatically in order to maintain the desired Recovery Point Objective (RPO).
    • manual—Data will only be replicated when manually initiated.
    • sync—Data is synchronously replicated with RPO=0.
    Note:  For asynchronous replication, the potential for data loss increases as the RPO increases, as well as the amount of required protection space. Lowering the RPO will reduce the amount of potential data loss, but will also increase network traffic and may negatively impact performance. The default RPO is one hour.
    RPO
    Recovery Point Objective (RPO) interval for automatic synchronization. For synchronous replication, the RPO is set to 0 automatically.
    Resource type
    Type of storage resource to which the replication session is applied. Valid values are:
    • LUN
    • LUN group
    • File System
    • VMware VMFS
    • VMware NFS
    • NAS Server
    Sync State
    Additional state of the replication session, specific to the replication mode.
    • For asynchronous replication, valid values are:
      • idle— No active syncing.
      • manual— User initiated syncing.
      • auto syncing— System initiated syncing.
    • For synchronous replication, valid values are:
      • unknown—Unknown sync state.
      • out of sync—Destination is out of sync with the source.
      • in sync—Destination is an exact copy of the source.
      • consistent—Destination is a point in time copy of the source.
      • syncing—System initiated syncing.
      • inconsistent—Destination is not a point in time copy of the source.
    Health state
    Health state of the session. Valid values are:
    • Unknown—Session health cannot be determined.
    • OK—Session is operating normally.
    • Degraded/Warning—An error has caused one or more of the following:
      • Session has been paused.
      • Session has failed over, likely due to the source storage resource becoming unavailable. The destination storage resource is now in a read/write state. Review the state of the source and check your network connections for any problems. Once the source is back online, you can fail back the session to return it to normal operation.
      • Session is syncing.
    • Minor failure—Communication with the replication host has been lost. It is likely that the system is either powered down or there is a network connectivity issue between the systems. A change in the network configuration on either side could also interrupt communication.
    • Critical failure— Session has encountered an error that has halted the session.
    Note:   If the replication session is in an error state, in addition to resolving the issue (for example, destination pool out of space), try pausing, and then resuming the replication session. If the problem persists, delete and then create the replication session again.
    Health details
    Additional health information.
    Operational status
    Operational status of the session. The operational status code appears in parentheses.
    • Unknown (0x0)
    • Non Recoverable Error (0x7)
    • Lost Communication (0xd)
    • Failed Over with Sync (0x8400)
    • Failed Over (0x8401)
    • Manual Syncing (0x8402)
    • Paused (0x8403)
    • Idle (0x8404)
    • Auto Sync Configured (0x8405)
    • Destination Extend Failed Not Syncing (0x840B)
    • Destination Extend In Progress (0x840C)
    • Active (0x840D)
    • Lost Sync Communication (0x840E)
    • Syncing (0x8411)
    Source status
    Status of the source storage resource in the session. Valid values are:
    • Unknown—Source status is unknown.
    • OK—Source is operating normally.
    • Paused—Replication session for the source is currently paused.
    • Fatal replication issue—Source has experienced a critical error and the replication session has stopped. Delete the replication session and re-create it.
    • Lost communication—Communication with the replication host has been lost. It is likely that the system is either powered down or there is a network connectivity issue between the systems. A change in the network configuration on either side could also interrupt communication.
    • Failed over—The replication session has failed over to the destination site. In a failed over state, the destination object is read/write. When communication is reestablished between the source and destination, the source is shown as Restricted Replication Access = Yes. To resume operations on the source site, the replication session needs to be failed back.
    • Switched over—The replication session has switched over to the source site. In a switched over state, the source object is read/write. When communication is reestablished between the source and destination, the destination is shown as Restricted Replication Access = Yes. To resume operations on the destination site, the replication session needs to be failed over.
    Destination status
    Status of the destination storage resource in the session. Valid values are:
    • Unknown—Status of the destination resource is unknown.
    • OK—Destination resource is operating normally.
    • Paused—Replication session for destination resource is currently paused.
    • Fatal replication issue—Destination has experienced a critical error and the replication session has stopped. Delete the replication session and re-create it.
    • Lost communication—Communication with the replication host has been lost. It is likely that the system is either powered down or there is a network connectivity issue between the systems. A change in the network configuration on either side could also interrupt communication.
    • Failed over—The replication session has failed over to the destination site. In a failed over state, the destination object is read/write. When communication is reestablished between the source and destination, the source is shown as Restricted Replication Access = Yes. To resume operations on the source site, the replication session needs to be failed back.
    • Switched over—The replication session has switched over to the source site. In a switched over state, the source object is read/write. When communication is reestablished between the source and destination, the destination is shown as Restricted Replication Access = Yes. To resume operations on the destination site, the replication session needs to be failed over.
    Network status
    Status of the network connection. Valid values are:
    • Unknown—Network status is currently unknown. If you continue to see this value, check the network connections.
    • OK—Network connection is operating normally.
    • Lost Communication—Communication with the replication host has been lost. It is likely that the system is either powered down or there is a network connectivity issue (lost IP) between the systems. A change in the network configuration on either side could also interrupt communication.
    • Lost Sync Communication—Fiber Channel communication with the synchronous replication remote system has been lost. It is likely that the Fiber Channel connection has encountered issues.
    Destination type
    Type of destination used in the session. Valid values are:
    • local—Maintain a full copy of the storage resource on the local system. This has advantages over snapshots in that a full copy, not just a copy of changes, is retained.
    • remote—Maintain a full copy of the storage resource on a remote system by transferring the data over the network. Remote replication is often used to ensure that a copy is available at a remote site in case of catastrophic data loss, for example, due to natural disaster at the local site.
    Destination system
    For remote sessions, the ID of the remote system on which the data is replicated.
    Local role
    The local system role. Valid values are:
    • Unknown—Status of the local system is unknown.
    • Source—Resource on the local system is replicated to the remote system.
    • Destination—Resource on the local system is the replication destination of the resource on the remote system.
    • Loopback—Resources participating in the replication session are located on the same storage system.
    • Local—Resources participating in the replication session are located on the different storage processors of the local system.
    Source resource
    ID of the storage resource that is the source of the session. The source can be local or remote.
    Source SP A interface
    ID of the interface on the SPA of the source system for the replication.
    Source SP B interface
    ID of the interface on the SPB of the source system for the replication.
    Destination resource
    ID of the storage resource on which the data is replicated.
    Destination SP A interface
    ID of the interface on the SPA of the destination system for the replication.
    Destination SP B interface
    ID of the interface on the SPB of the destination system for the replication.
    Time of last sync
    Date and time of the last replication synchronization.
    Sync status
    Percentage of the replication synchronization that has completed and the amount of time remaining.
    Note:  For synchronous replication, the percentage is reported when the replication is in the Syncing state.
    Sync transfer rate
    Synchronization transfer rate when the session is in the syncing state. For multi-LUN applications there is a comma-separated list of values.
    Note:  This attribute is valid for asynchronous replications only.
    Sync transfer size remaining
    Remaining size to be transferred during synchronization. For multi-LUN applications there is a comma-separated list of values.
    Note:  This attribute is valid for asynchronous replications only.
    Previous transfer rate
    Previous average transfer rate for the replication session.
    Note:  This attribute is valid for asynchronous replications only.
    Average transfer rate
    Average transfer rate for the replication session.
    Note:  This attribute is valid for asynchronous replications only.
    Element pairs
    For consistency group and VMware VMFS datastore replications, the LUN element pairs within the replication.
    Hourly snapshot keep for
    Amount of time to keep replicated hourly snapshots on the destination. Output can be:
    • Blank when scheduled snapshots are not replicated.
    • <value><qualifier>—When a retention duration is specified, where:
      • value—An integer value. If the qualifier is h (hours), the valid range is from 1 to 42840. If the qualifier is d (days), the valid range is from 1 to 1785.
      • qualifier—A value qualifier. The valid values are:
        • h (hours)
        • d (days)
    • Forever—When -keepFor value is not specified and allow auto-delete is requested
    • Same as source—Keep the destination retention policy the same as the source retention policy
    Note:  This attribute is valid for asynchronous replications only.
    Hourly snapshot allow auto-delete
    Whether or not the destination pool's auto-delete policy allows replicated hourly snapshots on the destination to be deleted. Output can be:
    • Blank when scheduled snapshots are not replicated.
    • Same as source—Keep the destination retention policy the same as the source retention policy
    • yes—When -allowAutoDelete is set
    • no—When -keepFor is set
    Note:  This attribute is valid for asynchronous replications only.
    Daily snapshot keep for
    Amount of time to keep replicated daily snapshots on the destination. Output can be:
    • Blank when scheduled snapshots are not replicated.
    • value—An integer value. If the qualifier is h (hours), the valid range is from 1 to 42840. If the qualifier is d (days), the valid range is from 1 to 1785.
    • qualifier—A value qualifier. The valid values are:
      • h (hours)
      • d (days)
    • Same as source—Keep the destination retention policy the same as the source retention policy
    Note:  This attribute is valid for asynchronous replications only.
    Daily snapshot allow auto-delete
    Whether or not the destination pool's auto-delete policy allows the replicated daily snapshots on the destination to be deleted. Output can be:
    • Blank when scheduled snapshots are not replicated.
    • Same as source—Keep the destination retention policy the same as the source retention policy
    • yes—When -allowAutoDelete is set
    • no—When -keepFor is set
    Note:  This attribute is valid for asynchronous replications only.
    Allow Async Snap Replication (file system asynchronous replication sessions only)
    Indicates whether or not to allow snap replication in asynchronous replication sessions. Values are:
    • yes--Allow snap replication in asynchronous sessions.
    • no--Disallow snap replication in asynchronous sessions.

    Create replication sessions

    Create a replication session.

    Note:  Snapshots that have been created and attached as well as read/write (share) snapshots (as opposed to read-only checkpoint snapshots) are not eligible for replication. Only unattached (read-only) snapshots are eligible for replication. For asynchronous replication, you can replicate existing snapshots and snapshots created from snapshot schedules. For synchronous file replication, you cannot replicate existing snapshots or snapshots created from snapshot schedules. You can only replicate those snapshots and snapshots created from snapshot schedules after you have established the synchronous replication session and it is Active.
    Note:   On a NAS server protected by replication, you must create a replication session for each file system on it. Otherwise, file system related configurations like shares and exports may be lost after a NAS server replication session failover.
    Note:  To do snapshot replication from a source system running OE version 4.0, 4.1, 4.2, 4.3, or 4.4 to a destination system running OE version 5.x, requires upgrading the source system to OE version 4.5 first. Upgrading to OE version 4.5 is not required but recommended if you want to do LUN or file system replication from OE version 4.0, 4.1, 4.2, 4.3, or 4.4 to OE version 5.x without any snapshot replication.
    Prerequisites

    Before creating a replication session, complete the following configuration tasks:

    • Create the storage resource that provides the replication source.
    • For local replication, create a replication destination on a local system.
    • For remote replication, create a replication connection to a remote system, and create a replication destination on that remote system.
    • For asynchronous replication in a coexisting asynchronous and synchronous replication with one source resource topology, create the asynchronous replication destination NAS server with both the -replDest and the -backupOnly attributes set to yes. These attributes must be set to yes on the asynchronous replication destination NAS server when the source NAS server is synchronous replicated; otherwise, the asynchronous replication session cannot be created.
    Format
    /prot/rep/session create [-async] -srcRes <value> [-srcSPAInterface <value>] [-srcSPBInterface <value>] –dstType {local | remote –dstSys <value>} -dstRes <value> [-dstSPAInterface <value>] [-dstSPBInterface <value>] [-name <value>] [-elementPairs <value>] [-syncType {manual [–autoInitiate {yes | no}] | auto [–rpo <value>]}[-replicateHourlySnaps {yes [{-keepSameAsSource | -keepFor <value> | -allowAutoDelete}] | no}] [-replicateDailySnaps {yes [{-keepSameAsSource | -keepFor <value> | -allowAutoDelete}] | no}] [-replicateExistingSnaps] [-allowAsyncSnapReplication {yes | no}]
    Action qualifiers
    Qualifier
    Description
    -async
    Run an action in asynchronous mode.
    -srcRes
    Type the ID of the storage resource to use as the source.
    -srcSPAInterface
    Type the ID of the interface on the SPA of the source system for the replication.
    Note:  This qualifier is used for asynchronous replications on remote systems only. If the qualifier is not specified, the system identifies the interface automatically.
    -srcSPBInterface
    Type the ID of the interface on the SPB of the source system for the replication.
    Note:  This qualifier is used for asynchronous replications on remote systems only. If the qualifier is not specified, the system identifies the interface automatically.
    -dstType
    Specify the type of destination. Valid values are:
    • local—Maintain a full copy of the storage resource on the local system. This has advantages over snapshots in that a full copy, not just a copy of changes, is retained.
    • remote—Maintain a full copy of the storage resource on a remote system by transferring the data over the network.
    Remote replication is often used to ensure that a copy is available at a remote site in case of catastrophic data loss, for example, due to natural disaster at the local site.
    -dstSys
    For remote replication, type the ID of the destination system. View settings for remote storage systems explains how to view the IDs of the remote system configuration on the local system.
    -dstRes
    Type the ID of the destination storage resource.
    Note:  To get the proper ID in the case of remote replication, you should use a command that list resources on a local machine with the -remSys qualifier. For example:
    • uemcli /stor/prov/sf/res -remSys <value> show
    • uemcli /stor/prov/iscsi/res -remSys <value> show
    • uemcli /stor/prov/vmware/nfs -remSys <value> show
    -dstSPAInterface
    Type the ID of the interface on the SPA of the destination system for the replication.
    Note:  This qualifier is used for asynchronous replications on remote systems only. If the qualifier is not specified, the system identifies the interface automatically.
    -dstSPBInterface
    Type the ID of the interface on the SPB of the destination system for the replication.
    Note:  This qualifier is used for asynchronous replications on remote systems only. If the qualifier is not specified, the system identifies the interface automatically.
    -syncType
    Specify how the source and destination will synchronize. Valid values are:
    • auto—Data is replicated automatically in order to maintain the desired Recovery Point Objective (RPO).
    • manual—Data will only be replicated when manually initiated.
    Note:  

    This qualifier is used for asynchronous replications only.

    As the RPO increases, the potential for data loss also increases, as well as the amount of required protection space. Lowering the RPO will reduce the amount of potential data loss, but will also increase network traffic and may negatively impact performance. The default RPO is one hour.

    -autoInitiate
    Specify whether the system will perform the first replication synchronization automatically. Valid values are:
    • yes
    • no
    Note:  This qualifier is used for asynchronous replications only.
    -rpo
    Type the time interval for when the synchronization will run. Use the following format:

    <HH>[:MM]

    where:
    • HH—Type the number of hours. Range is 00-24 hours (1 day).
    • MM—Type the number of minutes, in 5 minute increments. Range is 05 to 55.
    For synchronous replication, specify the value 0. Once set, the value cannot be reset from zero to non-zero or from non-zero to zero.
    -replicateHourlySnaps
    Specify whether or not to mark hourly scheduled snapshots for replication. Valid values are:
    • yes
    • no
    Note:  This qualifier is used for asynchronous replications only.
    -replicateDailySnaps
    Specify whether or not to mark daily scheduled snapshots for replication. Valid values are:
    • yes
    • no
    Note:  This qualifier is used for asynchronous replications only.
    -keepSameAsSource
    Indicates whether or not to use the same retention policy (expiration time and auto-delete) of the source for the destination. This option propagates changes made to the source retention policy to the destination retention policy (from that point forward for newly created scheduled snapshots, old snapshots are left as is). No values are allowed.

    This option is enabled by default if -keepFor or -allowAutoDelete are not set.

    Note:  This qualifier is used for asynchronous replications only.
    -keepFor
    Specifies the retention time after which the snapshot is deleted on the destination. The interval can be defined in days or hours. Use the following format:

    <value><qualifier>

    where:
    • value—An integer value. If the qualifier is h (hours), the valid range is from 1 to 42840. If the qualifier is d (days), the valid range is from 1 to 1785.
    • qualifier—A value qualifier. The valid values are:
      • h (hours)
      • d (days)
    Note:  This qualifier is used for asynchronous replications only.
    -allowAutoDelete
    Specify whether auto delete is allowed on the replicated copy of this snapshot or snapshot set. Valid values:
    • yes
    • no
    Note:  This qualifier is used for asynchronous replications only.
    -replicateExistingSnaps
    Indicates whether or not to replicate snapshots already existing on the source resource. This is a one-time option available during session creation that will replicate snapshots existing on the source at that moment in time. All eligible snapshots are replicated and have the source retention policy applied for the destination retention policy. For a snapshot to be eligible for this option, it must meet these 3 criteria:
    • The snapshot is created by either the user or a snapshot schedule.
    • The snapshot is read-only (file resource snapshot must be a checkpoint snapshot; block resource snapshot must not be attached).
    • The snapshot is not currently undergoing deletion.
    Note:  This qualifier is used for asynchronous replications only.
    -allowAsyncSnapReplication
    Indicates whether or not to allow snapshot replication in asynchronous session. Restriction: For a storage resource, snap replication is allowed only in one of its asynchronous replication sessions. Valid values are:
    • yes
    • no
    Note:   This qualifier is used for file system asynchronous replications only.
    Example

    The following command creates a replication session with these settings:

    • Source storage resource is file system RS_1.
    • Destination system type is remote.
    • Remote destination system is RS_2.
    • Remote storage resource is file system LUN_2.
    • Synchronization type is automatic.
    • RPO is 2 hours and 30 minutes.
    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/rep/session create -name REP1 -srcRes RS_1 –dstType remote -dstSys RS_2 –dstRes LUN_2 –syncType auto –rpo 02h30m
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    ID = 81604378625_FCNCH097274B3A_0000_81604378627_FCNCH097274B37_0000
    Operation completed successfully.
                            

    View replication sessions

    View details about replication sessions. You can filter on the session ID.

    Note:  The show action command explains how to change the output format.
    Format
    /prot/rep/session [{-id <value> | -name <value> | -res <value>}] show
    Object qualifiers
    Qualifier
    Description
    -id
    Type the ID of the replication session.
    -name
    Type the name of the replication session.
    -res
    Type the ID of a local storage resource on the system to view the sessions associated with it.
    Example 1

    The following command displays all replication sessions on the system:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/rep/session show
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    1:    ID                   = 42949672967_FNM00134400082_0000_42949672967_FNM00131800278_0000
          Name                 = REP1
          Session type         = nas server 
          Synchronization type = auto 
          Resource type        = NAS Server 
          Destination type     = remote 
                            
    Example 2

    The following command displays all replication sessions on the system and their details:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/rep/session show -detail
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    1:    ID                                = 42949672967_FNM00134400082_0000_42949672967_FNM00131800278_0000
          Name                              = REP1
          Session type                      = nas server 
          Synchronization type              = auto 
          RPO                               =
          Resource type                     = LUN
          Sync State                        = idle
          Health state                      = OK (5)
          Health details                    = "This replication session is operating normally. No action is required."
          Operational status                = Idle (0x8404)
          Source status                     = OK
          Destination status                = OK
          Network status                    = OK
          Destination type                  = local
          Destination system                = local
          Local role                        = Local
          Source resource                   = sv_1
          Source SP-A interface             = N/A
          Source SP-B interface             = N/A
          Destination resource              = sv_2
          Destination SP-A interface        = N/A
          Destination SP-B interface        = N/A
          Time of last sync                 = N/A
          Sync status                       =
          Sync transfer rate                = N/A
          Sync transfer size remaining      = 0
          Previous transfer rate            = N/A
          Average transfer rate             = N/A
          Element pairs                     = N/A
          Hourly snapshot keep for          = 3h 
          Hourly snapshot allow auto-delete = no
          Daily snapshot keep for           = same as source
          Daily snapshot allow auto-delete  = same as source
                            

    Change replication session settings

    Change the settings for a replication session.

    Format
    /prot/rep/session {–id <value> | -name <value>} set [-async] [-newName <value>] [-srcSPAInterface <value>] [-dstSPAInterface <value>] [-srcSPBInterface <value>] [-dstSPBInterface <value>] [-syncType {manual | auto -rpo <value>}] [-replicateHourlySnaps {yes [{-keepSameAsSource | -keepFor <value> | -allowAutoDelete}] | no}] [-replicateDailySnaps {yes [{-keepSameAsSource | -keepFor <value> | -allowAutoDelete}] | no}] [-allowAsyncSnapReplication {yes | no}]
    Object qualifiers
    Qualifier
    Description
    -id
    Type the ID of the replication session to change.
    -name
    Type the name of the replication session to change.
    Action qualifiers
    Qualifier
    Description
    -async
    Run an action in asynchronous mode.
    -newName
    Type the new name of the replication session.
    -srcSPAInterface
    Type the ID of the interface on the SPA of the source system for the replication.
    Note:  This qualifier is used for asynchronous replications on remote systems only. If the qualifier is not specified, the system identifies the interface automatically.
    -srcSPBInterface
    Type the ID of the interface on the SPB of the source system for the replication.
    Note:  This qualifier is used for asynchronous replications on remote systems only. If the qualifier is not specified, the system identifies the interface automatically.
    -dstSPAInterface
    Type the ID of the interface on the SPA of the destination system for the replication.
    Note:  This qualifier is used for asynchronous replications on remote systems only. If the qualifier is not specified, the system identifies the interface automatically.
    -dstSPBInterface
    Type the ID of the interface on the SPB of the destination system for the replication.
    Note:  This qualifier is used for asynchronous replications on remote systems only. If the qualifier is not specified, the system identifies the interface automatically.
    -syncType
    Specify how the source and destination will synchronize. Valid values are:
    • auto—Data is replicated automatically in order to maintain the desired Recovery Point Objective (RPO).
    • manual—Data will only be replicated when manually initiated.
    Note:  

    This qualifier is used for asynchronous replications only.

    As the RPO increases, the potential for data loss also increases, as well as the amount of required protection space. Lowering the RPO will reduce the amount of potential data loss, but will also increase network traffic and may negatively impact performance. The default RPO is one hour.

    -rpo
    For automatic synchronization, type the time interval for when the synchronization will run. Use the following format:

    <HH>[:MM]

    where:
    • HH—Type the number of hours. Range is 00-24 hours (1 day).
    • MM—Type the number of minutes, in 5 minute increments. Range is 05 to 55.
    Note:  For synchronous replication, specify the value 0. The value cannot be reset from zero to non-zero or from non-zero to zero.
    -replicateHourlySnaps
    Specify whether or not to mark hourly scheduled snapshots for replication. Valid values are:
    • yes
    • no
    Note:  This qualifier is used for asynchronous replications only.
    -replicateDailySnaps
    Specify whether or not to mark daily scheduled snapshots for replication. Valid values are:
    • yes
    • no
    Note:  This qualifier is used for asynchronous replications only.
    -keepSameAsSource
    Specify whether or not to use the same retention policy (expiration time and auto-delete) of the source for the destination. This option propagates changes made to the source retention policy to the destination retention policy (from that point forward for newly created scheduled snapshots, old snapshots are left as is). No values are allowed.
    Note:  This qualifier is used for asynchronous replications only.
    -keepFor
    Specify the retention time after which the snapshot is deleted on the destination. The interval can be defined in days or hours. Use the following format:

    <value><qualifier>

    where:
    • value—An integer value. If the qualifier is h (hours), the valid range is from 1 to 42840. If the qualifier is d (days), the valid range is from 1 to 1785.
    • qualifier—A value qualifier. The valid values are:
      • h (hours)
      • d (days)
    Note:  This qualifier is used for asynchronous replications only.
    -allowAutoDelete
    Note:  Only valid when -replicateHourlySnaps yes or -replicateDailySnaps yes.
    Specify whether auto delete is allowed on the replicated copy of this snapshot or snapshot set. Valid values are:
    • yes
    • no
    Note:  This qualifier is used for asynchronous replications only.
    -allowAsyncSnapReplication
    Indicates whether or not to allow snapshot replication in asynchronous session. Restriction: For a storage resource, snapshot replication is allowed only in one of its asynchronous replication sessions. Valid values are:
    • yes
    • no
    Note:  This qualifier is used for file system asynchronous replications only and can only be modified when the session is paused.
    Example

    The following command changes the source interface and destination interface for replication session 81604378625_FCNCH097274B3A_0000_81604378627_FCNCH097274B37_0000:

    uemcli /prot/rep/session –id 81604378625_FCNCH097274B3A_0000_81604378627_FCNCH097274B37_0000 set –srcSPAInterface if_1 –srcSPBInterface if_2 –dstSPAInterface if_3 –dstSPBInterface if_4
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    ID = 81604378625_FCNCH097274B3A_0000_81604378627_FCNCH097274B37_0000
    Operation completed successfully.
                            

    Pause replication sessions

    Pause a replication session.

    Format
    /prot/rep/session {-id <value> | -name <value>} pause [-async]
    Object qualifiers
    Qualifier
    Description
    -id
    Type the ID of the replication session to be paused.
    -name
    Type the name of the replication session to be paused.
    Action qualifiers
    Qualifier
    Description
    -async
    Run an action in asynchronous mode.
    Example

    The following command pauses replication session 81604378625_FCNCH097274B3A_0000_81604378627_FCNCH097274B37_0000:

    uemcli /prot/rep/session –id 81604378625_FCNCH097274B3A_0000_81604378627_FCNCH097274B37_0000 pause
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    Operation completed successfully.
                            

    Resume replication sessions

    Resumes an existing replication session.

    Format
    /prot/rep/session {–id <value> | -name <value>} resume [-async] [-forceFullCopy] [-srcSPAInterface <value>] [-dstSPAInterface <value>] [-srcSPBInterface value>] [-dstSPBInterface <value>] [-forceSyncData]
    Object qualifiers
    Qualifier
    Description
    -id
    Type the ID of the replication session to be resumed.
    -name
    Type the name of the replication session to be resumed.
    Action qualifiers
    Qualifier
    Description
    -async
    Run an action in asynchronous mode.
    -forceFullCopy
    Specifies to force a full synchronization during the resume operation.
    Note:  
    • If there is no longer a common base for the source storage resource, a full synchronization is required. For such cases, ensure that you specify this qualifier. However, if the resume operation does find the common base, it uses the common base to do the delta synchronization rather than the full synchronization, regardless of this qualifier.
    • This qualifier is used for asynchronous replications only.
    -srcSPAInterface
    Type the ID of the interface on the SPA of the source system for the replication.
    Note:  This qualifier is used for asynchronous replications on remote systems only. If the qualifier is not specified, the system identifies the interface automatically.
    -dstSPAInterface
    Type the ID of the interface on the SPA of the destination system for the replication.
    Note:  This qualifier is used for asynchronous replications on remote systems only. If the qualifier is not specified, the system identifies the interface automatically.
    -srcSPBInterface
    Type the ID of the interface on the SPB of the source system for the replication.
    Note:  This qualifier is used for asynchronous replications on remote systems only. If the qualifier is not specified, the system identifies the interface automatically.
    -dstSPBInterface
    Type the ID of the interface on the SPB of the destination system for the replication.
    Note:  This qualifier is used for asynchronous replications on remote systems only. If the qualifier is not specified, the system identifies the interface automatically.
    -forceSyncData
    Specifies to force data transfer from the source system to the remote system even if the remote system has data not replicated from the source system.
    Note:   This qualifier is used for asynchronous replications only.
    Example

    The following command resumes replication session 81604378625_FCNCH097274B3A_0000_81604378627_FCNCH097274B37_0000:

    uemcli /prot/rep/session –id 81604378625_FCNCH097274B3A_0000_81604378627_FCNCH097274B37_0000 resume
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    ID = 81604378625_FCNCH097274B3A_0000_81604378627_FCNCH097274B37_0000
    Operation completed successfully.
                            

    Manually synchronize replication sessions

    Manually synchronize a replication session.

    Format
    /prot/rep/session{–id <value> | -name <value>} sync [-async]
    Object qualifiers
    Qualifier
    Description
    -id
    Type the ID of the replication session to synchronize.
    -name
    Type the name of the replication session to synchronize.
    Action qualifiers
    Qualifier
    Description
    -async
    Run an action in asynchronous mode.
    Example

    The following command initiates a manual resynchronization of replication session REPS_1:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/rep/session –id REPS_1 sync
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    Operation completed successfully.
                            

    Delete replication sessions

    Delete a replication session. The deletion process automatically synchronizes the source storage resource with the destination storage resource, makes both read/write, and then deletes the session. You can then connect a host to either storage resource. Deleting the session from the source system automatically removes the destination and source replication sessions. This ensures that you do not have to manually delete the associated storage resources or NAS servers from the destination system.

    Note:  Once you delete a replication session, data from the source storage resource will no longer be replicated on the destination, leaving the data unprotected. When deleting a file system synchronous replication session, though the session is deleted, if the initial synchronization does not complete, the destination file system will run into an unrecoverable error. In this case, delete the destination file system.
    Format
    /prot/rep/session {–id <value> | -name <value>} delete [-async]
    Object qualifiers
    Qualifier
    Description
    -id
    Type the ID of the replication session to delete.
    -name
    Type the name of the replication session to delete.
    Action qualifiers
    Qualifier
    Description
    -async
    Run an action in asynchronous mode.
    Example

    The following command deletes replication session 81604378625_FCNCH097274B3A_0000_81604378627_FCNCH097274B37_0000:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/rep/session –id 81604378625_FCNCH097274B3A_0000_81604378627_FCNCH097274B37_0000 delete
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    Operation completed successfully.
                            

    Fail over replication sessions

    Run this command on the destination system to perform a failover of a replication session, with possible data loss, in response to an emergency scenario in which the source becomes unavailable.

    After the failover, the destination system is read/write. To reestablish communication between the source and destination, fail back the session that has failed over. Fail back replication sessions explains how to fail back a replication session that has failed over.

    Note:  Failover operations terminate the transfer of data if there is a transfer in progress, causing a potential loss of data. If the source site is still available when you perform a failover, the system attempts to change the source storage resource from read/write to read-only.
    Initiate a planned downtime

    To initiate a planned downtime, run this command on the source system by specifying the -sync option with the value yes. When you fail over a replication session from the source system, the destination system is fully synchronized with the source to ensure that there is no data loss. The destination storage resource can be used for providing access to the host.

    Format
    /prot/rep/session {-id <value> | -name <value>} failover [-async] [-sync {yes | no}] [-force]
    Object qualifiers
    Qualifier
    Description
    -id
    Type the ID of the replication session to fail over.
    -name
    Type the name of the replication session to fail over.
    Action qualifiers
    Qualifier
    Description
    -async
    Run an action in asynchronous mode.
    -sync
    For an asynchronous replication session, specifies whether a synchronization needs to be performed before failing over the replication session. For a synchronous replication session, specifies whether to keep synchronization on the reversed direction after failing over the session. Valid values are:
    • yes—For a planned failover. Can only be issued from the source system. Where –sync is not specified, this is the default value for a local replication session or session where role=source.
    • no—For an unplanned failover. Can only be issued from the destination system. Where –sync is not specified, this is the default value for a remote replication session or session where role=destination.
      Note:  If the Network status=OK, the source system is probably OK. The command issued from the destination system without this option will fail. It is recommended to rerun the command using the yes option from the source system. However, in that case, the command issued from the destination system using the no option is still allowed.
    -force
    Specifies whether to skip a pre-check operation on file systems of a NAS server when a replication failover operation is issued from the source NAS server. No values are allowed.
    Example

    The following command performs a fail over of replication session 81604378625_FCNCH097274B3A_0000_81604378627_FCNCH097274B37_0000:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/rep/session –id 81604378625_FCNCH097274B3A_0000_81604378627_FCNCH097274B37_0000 failover
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    Operation completed successfully.
                            

    Fail back replication sessions

    Fail back a replication session that has failed over. A failback results in the following:

    • Synchronizes the destination and source storage resources.
    • Makes the destination storage resource read-only.
    • Makes the source storage resource read/write.

    When the failback operation is complete, the replication session will resume and you may connect your hosts to the source storage resource.

    Note:  Ensure that hosts do not write to the destination storage resource, which will become read-only.
    Format
    /prot/rep/session {–id <value> | -name <value>} failback [-async] [-forceFullCopy] [-force] [-syncData {force | ignore}]
    Object qualifiers
    Qualifier
    Description
    -id
    Type the ID of the replication session to fail back.
    -name
    Type the name of the replication session to fail back.
    Action qualifiers
    Qualifier
    Description
    -async
    Run an action in asynchronous mode.
    -forceFullCopy
    Specifies to force a full synchronization before the failback operation occurs.
    Note:  
    • You may lose the common base on the source storage resource as a result of the event that caused the original failover. If there is no longer a common base for the source storage resource, a full synchronization is required. For such cases, ensure that you specify this qualifier. However, if the failback operation does find the common base, it uses the common base to do the delta synchronization rather than the full synchronization, regardless of this qualifier.
    • This qualifier is used for asynchronous replications only.
    -force
    Before failing back a NAS server synchronous replication session, it is checked whether its associated asynchronous file system replication sessions are all preserved when coexisting. When this qualifier is specified, that check is skipped.
    -syncData
    Specifies the behavior of transferring data from the source system to the remote system. If the qualifier is not specified, the command will fail if the remote system has data not replicated from the source system. Valid values are:
    • force – Force data transfer from the source system to the remote system, even if the remote system has out-of-sync data.
    • ignore – Skip data transfer from the source system to the remote system. Just trigger the replication session reverse from the remote system to the source system.
    Note:   This qualifier is used for asynchronous replications only.
    Example

    The following command performs a fail back of replication session 81604378625_FCNCH097274B3A_0000_81604378627_FCNCH097274B37_0000:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/rep/session –id 81604378625_FCNCH097274B3A_0000_81604378627_FCNCH097274B37_0000 failback
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    Operation completed successfully.
                            

    Preserve asynchronous replication sessions

    Initiates a preserve asynchronous replication sessions operation on a NAS server synchronous replication session. After a NAS server synchronous replication session fails over or fails back with its file system synchronous replication sessions, the asynchronous replication sessions will be switched to the new production site by the preserve asynchronous replication sessions operation.

    Format
    /prot/rep/session {-id <value> | -name <value>} preserveAsync
    Object qualifiers
    Qualifier
    Description
    -id
    Identifies the NAS server synchronous replication session.
    -name
    Identifies the NAS server synchronous replication session by name.
    Example

    The following command preserves asynchronous replication sessions for 81604378625_FCNCH097274B3A_0000_81604378627_FCNCH097274B37_0000:

    uemcli /prot/rep/session –id 81604378625_FCNCH097274B3A_0000_81604378627_FCNCH097274B37_0000 preserveAsync
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    Operation completed successfully.
                            

    Manage virtual RecoverPoint appliance CHAP accounts

    When configuring a virtural RecoverPoint appliance (RPA) to work with the storage system, you can optionally set up iSCSI interface authentication using the Challenge Handshake Authentication Protocol (CHAP). Two type of CHAP are supported:

    • Incoming Forward CHAP – This is used by the storage system to authenticate the RPA. This CHAP is similar to the iSCSI CHAP account. For more information on configuring this CHAP, see Manage iSCSI CHAP accounts for one-way CHAP authentication.
    • Outgoing Forward CHAP - This is used by the RPA to authenticate the storage system.

    This section describes the attributes and commands that enable you to manage RPA CHAP accounts.

    The following table lists the attributes for RPA CHAP accounts:

    Table 5. RPA CHAP attributes
    Attribute
    Description
    Out username
    The outgoing CHAP user name.
    Out secret
    The outgoing CHAP secret (password).
    Out secret format
    The outgoing CHAP secret input format. Valid values are:
    • ascii — Secret in the ASCII format (default).
    • hex — Secret in hexadecimal format.

    View the RPA CHAP account

    View the RPA CHAP account.

    Format
    /remote/rpa/chap show
    Example
    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/rpa/chap show
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    1:     Out username  = admin
    
                            

    Change RPA CHAP account

    Modify the RPA CHAP account.

    Format
    /remote/rpa/chap set [ -outUsername <value>] [ { -outSecret <value> | -outSecretSecure } [-outSecretFormat {ascii|hex}]]
    Action qualifier
    Qualifier
    Description
    -outUsername
    Type the outgoing CHAP user name.
    -outSecret
    Type the outgoing CHAP secret (password). By default, the CHAP secret is an ASCII string that is 12 to 16 characters. Hexadecimal secrets are 12 to 16 pairs of data (24 to 32 characters).
    -outSecretSecure
    Type the outgoing CHAP secret in secure mode. You will be prompted separately to type the password.
    -outSecretFormat
    The outgoing CHAP secret input format. Valid values are:
    • ascii - Secret in the ASCII format.
    • hex - Secret in hexadecimal format.
    Example
    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /remote/rpa/chap set -outUsername admin -outSecret abcdef123456
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    Operation completed successfully.
    
                            

    Manage Data at Rest Encryption (physical deployments only)

    Note:   This feature may not be available in your implementation.
    Table 6. Data at Rest Encryption attributes
    Attribute
    Description
    Encryption mode
    Encryption mode. Valid values are:
    • Unencrypted
    • Controller Based Encryption
    Encryption status
    Status of the encryption process. Valid values are:
    • Not encrypting
    • In progress
    • Encrypted
    • Scrubbing
    Note:  This attribute is not applicable, and is blank, when the license for the feature is not installed.
    Percent encrypted
    Percent of user data encrypted.
    Backup keystore status
    Status of the keystore backup. Valid values are:
    • No operation required
    • Keystore is inaccessible
    • Backup keystore operation required
    • Backup keystore operation in progress
    • Backup keystore operation complete
    The keystore must be backed up, using the uemcli -download command, and stored off the storage system.
    Note:  This attribute is not applicable, and is blank, when the license for the feature is not installed.
    KMIP status
    Status of KMIP support. Valid values are:
    • Enabled—KMIP feature is enabled.
    • Disabled—KMIP feature is disabled.
    • Unsupported—KMIP feature is not supported.
    • Unknown—KMIP feature status cannot be determined.
    Note:  Once enabled, allows the storage system to interact with external key management servers that are KMIP compliant for key management associated with Data at Rest Encryption.

    View Data at Rest Encryption settings (physical deployments only)

    View Data at Rest Encryption settings.

    Format
    /prot/encrypt show
    Example

    The following command lists the Data at Rest Encryption settings on the system:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/encrypt show -detail
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    1:     Encryption mode        = Controller Based Encryption
           Encryption status      = Encrypted
           Percent encrypted      = 100.00%
           Backup keystore status = Backup keystore operation complete
           KMIP status            = Enabled
                            

    Change encryption setting for KMIP support (physical deployments only)

    When encryption and KMIP support are enabled, the storage system interacts with external key management servers that are KMIP compliant for key management associated with the Data at Rest Encryption feature. When encryption is enabled and KMIP support is disabled, the storage system interacts with an internal key management server for key management.

    Format
    /prot/encrypt set -kmipEnabled {yes | no}
    Action qualifiers
    Qualifier
    Description
    -kmipEnabled
    Specifies whether to enable or disable KMIP support. Valid values are:
    • yes
    • no
    Example

    The following command changes the encryption setting for KMIP support to enabled:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/encrypt set -kmipEnabled yes
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    Operation completed successfully.
                            

    Manage KMIP support (physical deployments only)

    KMIP server configuration of the storage system.

    Table 7. KMIP attributes
    Attribute
    Description
    ID
    KMIP server identifier.
    Username
    Username for accessing the KMIP server.
    Password
    Password for accessing the KMIP server.
    Port
    Port number used to establish a connection to a KMIP server.
    Timeout
    Period to establish a connection to a KMIP server. If the system does not receive a reply from the KMIP server before the specified period expires, it stops sending requests.
    Address
    A list of KMIP server addresses separated with comma. The system uses the addresses in the order from left to right.
    State
    A list of KMIP server states (Up, Down, Unknown) separated with comma.

    View KMIP settings (physical deployments only)

    View settings for KMIP support.

    Format
    /prot/encrypt/kmip show
    Example

    The following command lists the Data at Rest Encryption settings on the system:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/encrypt/kmip show
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    1:    ID          = kmip_0
          Username    = admin
          Address     = 10.245.95.125
          Port        = 5696
          Timeout     = 300
          State       = Up
                            

    Change KMIP support settings (physical deployments only)

    Change the key management server parameters related to KMIP support.

    Format
    /prot/encrypt/kmip set -username <value> {-passwd <value> | -passwdSecure} [-port <value>] [-timeout <value>] -addr <value>
    Action qualifiers
    Qualifier
    Description
    -username
    Specify the username to use to access the KMIP server.
    -passwd
    Specify the password to use to access the KMIP server.
    -passwdSecure
    Specify the password in secure mode - the user will be prompted to input the password and the password confirmation.
    -port
    Specify the port number used by the KMIP server for KMIP communications. Default value is 5696.
    -timeout
    Specify the timeout for the KMIP server in seconds. If the system does not receive a reply from the KMIP server after the specified timeout, it stops sending requests. Default is 30 seconds.
    -addr
    Specify a list of KMIP server addresses to designate as default addresses. Separate the addresses with a comma. The system uses the addresses in the order in which they are typed.
    Example

    The following command changes the KMIP transport settings:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/encrypt/kmip set -username skoobee -passwd doobee -port 5696 -timeout 20 -addr 10.245.95.125
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    Operation completed successfully.
                            

    Verify KMIP settings (physical deployments only)

    Verify the current connection to the KMIP server.

    Format
    /prot/encrypt/kmip verify
    Example

    The following command verifies the connection to the KMIP server:

    uemcli -d 10.0.0.1 -u Local/joe -p MyPassword456! /prot/encrypt/kmip verify
                              Storage system address: 10.0.0.1
    Storage system port: 443
    HTTPS connection
    
    Operation completed successfully.