Mount command

Use the mount command to complete various recovery agent tasks.

The Recovery Agent CLI can be used to mount (mount add) and unmount (mount del) volumes and disks, and to view a list of mounted volumes (mount view). To use the mount command, the IBM Spectrum Protect recovery agent must be running. Use the set_connection command to connect a RecoveryAgentShell.exe to the mount application.

Snapshots are mounted or unmounted on the system where the recovery agent is running.

The mount command is supported in command mode. The following command types are available. The appropriate tags and parameters are listed alongside each command type.
add
Use this command type to mount a disk or volume of a snapshot to the system where the recovery agent is running. The following list identifies the tags and parameters for the add type:
  • -target - This tag is required.
    Use this tag to specify the following targets:
    • Windows operating systemsVirtual volume - only for a partition mount
    • Windows operating systemsReparse point - only for a partition mount
    • Windows operating systemsLinux operating systemsiSCSI target
    The following examples use the -target tag:
    • Windows operating systems In the following example V: is the virtual volume mount target:
      -target "V:"
    • In the following example a reparse point volume mount target is specified:
      -target "C:\SNOWBIRD@FASTBACK\SnowbirtK\Snowbird\K\\"
    • Windows operating systemsLinux operating systemsIn the following example an iSCSI target is specified:
      -target "ISCSI: target=<target_name> initiator=<initiator_name>"
      When you use the recovery agent in an iSCSI network, and the Recovery Agent does not use a data mover, go to the C:\ProgramData\Tivoli\TSM\RecoveryAgent\mount\RecoveryAgent.conf file and specify the [IMOUNT] tag and Target IP parameter:
      
      [IMOUNT config]
      Target IP=<IP address of the network card on the system
      that exposes the iSCSI targets.>
      For example:
      
      [General config]
      param1
      param2
      ...
      [IMount config]
      Target IP=9.11.153.39
      After you add or change the Target IP parameter, restart the Recovery Agent GUI or Recovery Agent CLI.
  • -rep - This tag is required.
    Use it to specify the IBM Spectrum® Protect server that is storing the VMware snapshots, and the IBM Spectrum Protect node that has access to the VMware backups. For example:
    tsm: ip=<ip/host_name> port=<port_number>
     node=<node_name> pass=<node_password> 
    You can also specify the as_node and from_node options. If the password field is empty, the recovery agent attempts to use the password for the stored node.
  • -type - This tag is required. Use it to specify that you want to mount a disk or a partition. The options are:
    • -type disk
    • -type partition
  • -VMname - This tag is required. Use it to specify the VMware machine name that is source of the snapshot. The specified value is case-sensitive.
  • -disk - This tag is required. Use it to specify the disk number of the source backed up VMware machine to be mounted.
  • -date - This tag is required. Use it to specify the date of the snapshot that you want to mount. The date format is yyyy-Mmm-dd hh:mm:ss. For example:
    -date "2013-Apr-12 22:42:52 AM"
    To view the active (or latest) snapshot, specify last snapshot.
  • -PartitionNumber - This tag is optional. If the -type is partition, enter the partition number to mount.
  • -ro|-fw - Use this tag to specify whether the mounted volume is read-only (-ro) or fake-write (-fw).
  • -disk - This tag is required. Use it to specify the disk number of the source backed up VMware machine to be mounted.
  • -ExpireProtect - This tag is optional. During a mount operation, the snapshot on the IBM Spectrum Protect server is locked to prevent it from expiring during the operation. Expiration might occur because another snapshot is added to the mounted snapshot sequence. This value specifies whether to disable expiration protection during the mount operation. You can specify one of the following values:
    Yes
    Specify Yes to protect the snapshot from expiration. This value is the default. The snapshot on the server is locked and the snapshot is protected from expiration during the mount operation.
    No
    Specify No to disable expiration protection. The snapshot on the server is not locked and the snapshot is not protected from expiration during the mount operation. As a result, the snapshot might expire during the mount operation. This expiration can produce unexpected results and negatively impact the mount point. For example, the mount point can become unusable or contain errors. However, expiration does not affect the current active copy. The active copy cannot expire during an operation.
    When the snapshot is on a target replication server, the snapshot cannot be locked because it is in read-only mode. A lock attempt by the server causes the mount operation to fail. To avoid the lock attempt and prevent such a failure, disable expiration protection by specifying No.
The following example shows how to specify the add type to mount a disk:
mount add -rep "tsm: ip=10.10.10.01 port=1500 node=tsm-ba pass=password"
-target "iscsi: target=test1 initiator=initiator_name" -type disk 
-vmname VM-03ENT -disk 1 -date "2014-Jan-21 10:46:57 AM -ExpireProtect=Yes"
In this example, a snapshot of VMware named VM-03ent is located on a server with IP 10.10.10.01. Disk number 1 of this snapshot is mounted to the system where the recovery agent is running.
del
Use this command type to dismount one or all mounted backups from the system where the recovery agent is running. The following list identifies the tags and parameters for the del type:
  • -target - This tag is required. Use this tag to specify the target for dismounting. The target for dismounting can be a virtual volume, reparse point, or iSCSI target created using the mount command. Use the everything variable to dismount all mounted backups.
  • -force - Use this tag to force an unmount. The default option is not to force an unmount if the target is currently in use.
For example, to force an unmount of a snapshot that is currently mounted at the directory, c:\gever, use the following command:
mount del -target "c:\gever" -force
To dismount a snapshot currently mounted as volume V:, use the following command:
mount del -target V:
To dismount a snapshot currently mounted as an iSCSI target, use the following command:
mount del -target "ISCSI:<target_name>"
dump
Use this command type to get a list of all the available backups to mount.
  • -rep - This tag is required. Use this tag to specify the IBM Spectrum Protect server storing the VMware snapshots, and to specify the IBM Spectrum Protect node that has access to the VMware backups. For example:
    tsm: ip=<IP/host name> port=<PortNumber>
    node=<NodeName> pass=<NodePassword>
  • -file - This tag is optional. Use this tag to identify a file name to store the dump text. If this tag is not specified, the dump text is printed only to stdout.
The following examples show how to specify the dump type:
  • List all the available backed up VMs.
    mount dump –type TSM –for TSMVE -rep P -request 
    ListVM [–file <FileNameAndPath>]
  • List all the available disk snapshots of a VMware.
    mount dump –type TSM –for TSMVE -rep P -request 
    ListSnapshots -VMName P [-file <FileNameAndPath>]
  • List all the available partitions of a disk snapshot.
    mount dump –type TSM –for TSMVE -rep P -request 
    ListPartitions -VMName P -disk P -date P [-file <FileNameAndPath>]
remove
Use this type to remove the connection to the IBM Spectrum Protect server. A connection cannot be removed when it is in use, such as when mounted volumes exist. There is only one tag for the remove type:
  • -rep - This tag is required. Use this tag to specify the IBM Spectrum Protect server connection to be removed.
In the following example, remove the connection to a server (10.10.10.01) using node NodeName:
mount remove -rep "tsm: NodeName@ip"
view
Use this type to view a list of all mounted snapshots. This type has no tags. The following example uses the view type:
mount view

Mounting a disk

The following syntax diagram is for the command for mounting a disk:
Read syntax diagramSkip visual syntax diagramRecoveryAgentShell.exe -cmountadd -rep "tsm: ip= IP host_name port=portNumbernode=nodeName-as_node=nodeNamepass=NodePassword" -vmnamevmname-typedisk-disk disk_number datedate_format-target "ISCSI:target=target_nameinitiator=initiator_name"

Mounting a partition

The following syntax diagram is for the command for mounting a partition:
Read syntax diagramSkip visual syntax diagramRecoveryAgentShell.exe -cmountadd -rep "tsm: ip= IP host_name port=portNumbernode=nodeName-as_node=nodeNamepass=NodePassword" -vmnamevmname-disk disk_numbervmdk datedate_format-type partition-PartitionNumberpartNum -target volume_letter"ISCSI:target=target_nameinitiator=initiator_name"