Command Line Interface - MediaAgent - XML Files

Table of Contents

Log On to the CommServe Computer

Before you run command line operations, use the qlogin command to log on to the CommServe computer.

  1. At the command prompt, go to <software installation directory>\Base.
  2. Use the appropriate method to log on to the CommServe computer.

    Method 1:  User Name/Password

    1. Log on to CommServe server1 with user name user1.

      qlogin -cs server1 -u user1
      Password:
      User logged in successfully.

    Method 2:  Token File

    When you use the token file method, you must append the token file to your qcommand.

    1. Create a token file (record the name and location of the file). 
    2. Run the following command:

      qlogin -f <tokenFile>

    3. Enter the user name and password.

      Enter User Name:
      Password:

Disk Libraries

Type the password on the command prompt. Do not edit the XML.

Create a Disk Device

You can create a disk device and specify a name using XML.

  1. Download the create_disk_device.xml file and save it on the computer where the command is run.
  2. Open the XML file.
  3. Change the XML parameters.
    Attribute Description
    mediaAgentName The name of the MediaAgent where you want to create a disk library
    deviceName If you do not want the default name for the disk device, specify a name.
    mountPath The mount path location for the disk library
    loginName Login name to access the network location where you want to create the path for new disk device
    Password Password to access the network location where you want to create the path for the new disk device
    deviceAccessType The access type for the new disk device. By default, the value is 14.
    To change the access type, refer to the following table:
    Access type Value
    Read 4
    Read and Write 6
    Read and Write, Preferred Access 14

    Example: Use this example XML file to create a disk device with device name "Disk_Device_1", MediaAgent name "MA1", mount path "E:\Library1\Mountpath1", login username "user1" and device access type "read and write".

  4. Run the following command from the <software installation directory>\Base folder:

    qoperation execute -af <downloaded location>\create_disk_device.xml

          Click here to see sample output.

Create a Disk Library

  1. Download the create_disk_library_local_path.xml file and save it on the computer where the command is run.
  2. Open the XML file.
  3. Change the XML parameters.
    Attribute Description
    libraryName The name of the new disk library
    mediaAgentName The name of a MediaAgent where you want to create a library
    mountPath The mount path location for the disk library

    Example: Use this example XML file to create a disk library with library name "Library1", MediaAgent name "MA1" and mount path "E:\Library1\Mountpath1".

  4. Run the following command from the <software installation directory>\Base folder:

    qoperation execute -af <downloaded location>\create_disk_library_local_path.xml

    Click here to see sample output.

Create a Disk Library and a Storage Policy

You can create a disk library and a Storage Policy simultaneously with XML. The Storage Policy uses the disk library that you create as the default data path.

  1. Download the create_disk_library_storage_policy.xml file and save it on the computer where the command is run.
  2. Open the XML file.
  3. Change the XML parameters.
    Attribute Description
    mediaAgentName The name of the MediaAgent where you want to create a library
    libraryName The name of the new disk library
    mountPath The mount path location for the disk library
    createStoragePolicy When the value is set to 1, a Storage Policy is created.

    When the value is set to 0, a Storage Policy is not created.

    Example: Use this example XML file to create a disk library and storage policy simultaneously with library name "Library1", MediaAgent name "MA1" and mount path "E:\Library1\Mountpath1" .

  4. Run the following command from the <software installation directory>\Base folder:

    qoperation execute -af <downloaded location>\create_disk_library_storage_policy.xml

    Click here to see sample output.

Configuring a Disk Library on a Network

  1. Download the Configure_Disklib.xml file and save it on the computer where the command is run.
  2. Open the XML file.
  3. Change the XML parameters.
    Attribute Description
    mediaAgentName The name of the MediaAgent where you want to create a library
    libraryName The name of the new disk library
    mountPath The mount path location for the disk library
    loginName Login name to access the network location where you want to create the new disk library
    password Password to access the network location where you want to create the new disk library
    createStoragePolicy When the value is set to 1, a Storage Policy is created.

    When the value is set to 0, a Storage Policy is not created.

    Example: Use this example XML file to create a disk library and storage policy simultaneously with library name "Library1", MediaAgent name "MA1", mount path "\\demo-server\E$\Library1\mountpath1" and login username "user1".

  4. Run the following command from the <software installation directory>\Base folder:

    qoperation execute -af <downloaded location>\Configure_Disklib.xml

    Click here to see sample output.

Create a Disk Library using a Device

You can use an existing disk device to configure a disk library.

  1. Download the create_disk_library_using_disk_device.xml file and save it on the computer where the command is run.
  2. Open the XML file.
  3. Change the XML parameters.
    Attribute Description
    deviceName The name of the disk device that you want to use to configure the disk library
    libraryName The name of the new disk library
    mediaAgentName The name of the MediaAgent
    baseFolder If you do not want the default name for the basefolder, specify a name.
    createStoragePolicy When the value is set to 1, a Storage Policy is created.

    When the value is set to 0, a Storage Policy is not created.

    By default, the value is 0

    Example: Use this example XML file to use an existing disk device with device name "Disk_Device_1" and MediaAgent name "MA1" to configure a new disk library with name "Library1" without creating a storage policy and using the default name for the basefolder.

  4. Run the following command from the <software installation directory>\Base folder:

    qoperation execute -af <downloaded location>\create_disk_library_using_disk_device.xml

    Click here to see sample output.

Add a Device Controller on a Disk Device

You can add additional MediaAgents on a disk device.

  1. Download the add_device_controller_on_disk_device.xml file and save it on the computer where the command is run.
  2. Open the XML file.
  3. Change the XML parameters.
    Attribute Description
    mediaAgentName The name of the new MediaAgent that you want to add on the device
    deviceName The name of the disk device
    mountPath The mount path location of the disk devic
    loginName Login name to access the network location where you want to add the device controller.
    Password Password to access the network location where you want to add the device controller
    deviceAccessType To specify the access type for the new MediaAgent, refer to the following table:
    Access type Value
    Read 4
    Read and Write 6
    Read and Write, Preferred Access 14

    Example: Use this example XML file to add an additional MediaAgent with name "MA2" on a disk device with device name "Disk_Device_1", mount path "\\demo-server\E$\Library1\mountpath1", login username "user1" and device access type "read and write".

  4. Run the following command from the <software installation directory>\Base folder:

    qoperation execute -af <downloaded location>\add_device_controller_on_disk_device.xml

    Click here to see sample output.

Adding a Mount Path to a Disk Library on a Network

  1. Download the add_network_mountpath.xml file and save it on the computer where the command is run.
  2. Open the XML file.
  3. Change the XML parameters.
    Attribute Description
    mediaAgentName The name of the MediaAgent where you want to add a mount path
    libraryName The name of the disk library on the network where you want to add the mount path
    mountPath The mount path location for the disk library
    loginName Login name to access the network location where the disk library exists
    password Password to access the network location where the disk library exists

    Example: Use this example XML file to add a mount path "\\demo-server\E$\Library1\mountpath1" to a disk library on network with library name "Library1", MediaAgent name "MA1" and login username "user1".

  4. Run the following command from the <software installation directory>\Base folder:

    qoperation execute -af <downloaded location>\add_MountPath.xml

    Click here to see sample output.

Add an Additional Mount Path

You can add additional mount paths to local drives only.

  1. Download the add_local_mountpath.xml file and save it on the computer from where the command is run.
  2. Open the XML file.
  3. Change the XML parameters.
    Attribute Description
    mediaAgentName The name of a MediaAgent
    libraryName The name of the disk library where you want to add additional mount path
    mountPath The mount path location that you want to add

    Example: Use this example XML file to add a mount path "E:\Library1\Mountpath1" to a local disk library with name "Library1" and MediaAgent name "MA1"

  4. Run the following command from the <software installation directory>\Base folder:

    qoperation execute -af <downloaded location>\add_mount_path.xml

    Click here to see sample output.

Add a Mount Path using a Disk Device

You can add a mount path using a disk device.

  1. Download the add_mount_path_using_disk_device.xml file and save it on the computer from where the command is run.
  2. Open the XML file.
  3. Change the XML parameters.
    Attribute Description
    libraryName The name of the disk library where you want to add a mount path
    deviceName The name of the disk device
    mediaAgentName The name of the MediaAgent
    baseFolder If you do not want the default name for the basefolder, specify a name.

    Example: Use this example XML file to add a mount path using a disk device with name "Disk_Device_1", MediaAgent name "MA1" and library name "Library1" using the default name for the basefolder.

  4. Run the following command from the <software installation directory>\Base folder:

    qoperation execute -af <downloaded location>\add_mount_path_using_disk_device.xml

    Click here to see sample output.

Editing a Mount Path

You can modify the mount path of the MediaAgent.

  1. Download the Edit_MP_Prop.xml file and save it on the computer where the command is run.
  2. Open the XML file.
  3. Change the XML parameters.
    Attribute Description
    libraryName The name of the library on which mount path will be updated
    library/mountPath The old mount path that will be edited
    libNewProp/mountPath The new mount path of the MediaAgent
    mediaAgentName The name of the MediaAgent
    loginName Login name to access the network location in case of a network path
    Password Password to access the network location in case of a network path
    proxyPassword Password to access the proxy server if a proxy server is present

    Example: Use this example XML file to modify the mount path in a library with name "Library1" and MediaAgent name "MA1" from the current path "E:\Library1\Mountpath1" to a new path "\\demo-server\E$\Library1\mountpath1" that can be accessed with the login username "user1".

  4. Run the following command from the <software installation directory>\Base folder:

    qoperation execute -af <downloaded location>\Edit_MP_Prop.xml

    Click here to see sample output.

What to do next

On successfully editing the mount path, copy content from the older location to the new location.

Edit Disk Library Properties

You can modify the properties of a disk library using XML.

  1. Download the edit_disk_library_properties.xml file save it on the computer where the command is run.
  2. Open the XML file.
  3. Change the XML parameters.
    Attribute Description
    libraryName The name of the disk library whose property needs to be updated
    mountPathUsage When the value is set to 1, Spill and fill mount paths usage is selected.
    When the value is set to 2, Fill and Spill mount paths usage is selected.
    numOfWritersForLibrary Specify the number of writers to be allocated for the disk library.
    To allocate the maximum number of writers, set the value to -1.
    lowWaterMark Value (%) for low watermark warning

    This value should be less than or equal to the warning watermark value (%).

    warningWaterMark Value (%) for warning watermark

    This value should be greater than or equal to the low watermark value (%).

    Example:

    • Use this example XML file to set the mount path usage as "Spill and fill mount paths" for a library with name "Library1".
    • Use this example XML file to set the number of writers as "5" for a library with name "Library1".
    • Use this example XML file to set the low watermark as "20" and warning watermark as "40" for a library with name "Library1".
  4. Run the following command from the <software installation directory>\Base folder:

    qoperation execute -af <downloaded location>\edit_disk_library_properties.xml

    Click here to see sample output.

Edit Mount Path Properties

You can modify the following properties of a mount path using XML:

  • Number of  writers
  • Amount of free space that must be available on a mount path
  1. Download the edit_mount_path_properties.xml file save it on the computer where the command is run.
  2. Open the XML file.
  3. Change the XML parameters.
    Attribute Description
    libraryName The name of the disk library whose mount path property needs to be edited
    mediaAgentName The name of the MediaAgent
    mountpath The location of the mount path whose property needs to be modified
    numofWritersForMountpath Specify the number of writers to be allocated for the mount path.
    To allocate the maximum number of writers, set the value to -1.
    reserveSpaceInMB The total amount of free space that must be available at all times when the system writes data to the mount path. You can change this value to modify the amount of free space. The minimum allowed reserve space is 2048 MB.

    Example:

    • Use this example XML file to set the number of writers to "maximum" for a mount path "E:\Library1\Mountpath1", library name "Library1" and MediaAgent name "MA1".
    • Use this example XML file to set the reserve space to "3000 MB" for a mount path "E:\Library1\Mountpath1", library name "Library1" and MediaAgent name "MA1".
  4. Run the following command from the <software installation directory>\Base folder:

    qoperation execute -af <downloaded location>\edit_mount_path_properties.xml

    Click here to see sample output.

Delete a Mount Path

You can delete mount paths from local drives only.

The mount path is not deleted and you receive an error message if the mount path:

  • contains valid data
  • is used by a deduplication database (DDB)
  • is associated with a Storage Policy that is used as an Incremental Storage Policy for another Storage Policy
  1. Download the delete_mount_path.xml file and save it on the computer where the command is run.
  2. Open the XML file.
  3. Change the XML parameters.
    Attribute Description
    mediaAgentName The name of the MediaAgent
    libraryName The name of the disk library from which you want to delete the mount path
    mountPath The mount path location that you want to delete

    Example: Use this example XML file to delete a mount path "E:\Library1\Mountpath1" from a local disk library with name "Library1" and MediaAgent name "MA1".

  4. Run the following command from the <software installation directory>\Base folder.

    qoperation execute -af <downloaded location>\delete_mount_path.xml

    Click here to see sample output.

Create a PnP Library

  1. Download the create_pnp_library.xml file and save it on the computer where the command is run.
  2. Open the XML file.
  3. Change the XML parameters.
    Attribute Description
    mediaAgentName The name of the MediaAgent
    libraryName The value must be the name or serial number of a configured tape library.
    libSerialNumber The value must be PnP in order to create a PnP library.

    Example: Use this example XML file to create a PnP library with PnP serial number "00000001" in a library with name "Library1" and MediaAgent name "MA1".

  4. Run the following command from the <software installation directory>\Base folder.

    qoperation execute -af <downloaded location>\create_pnp_library.xml

    Click here to see sample output.

Edit PnP Library Property

  1. Download the edit_pnp_library_property.xml file and save it on the computer where the command is run.
  2. Open the XML file.
  3. Change the XML parameters.
    Attribute Description
    libraryName The name of the PnP library whose property needs to be modified
    lowWaterMark Value must be in MB. The Use disk only when the size is greater than (n) MB option under Media Usage tab is updated.

    Example: Use this example XML file to set the low watermark to "500MB" for a PnP library with name "Library1".

  4. Run the following command from the <software installation directory>\Base folder.

    qoperation execute -af <downloaded location>\edit_pnp_library_property.xml

    Click here to see sample output.

Tape Libraries

Create a Tape Library

This procedure detects and configures the tape library.

  1. Download the create_tape_library.xml file and save it on the computer where the command is run.
  2. Open the XML file.
  3. Change the XML parameters.
    Attribute Description
    mediaAgentName The name of the MediaAgent
    libraryName The name of the new tape library
    libSerialNumber The serial number of the tape library

    This value is case-sensitive and must match the actual serial number.

    Example: Use this example XML file to create a tape library with serial number "00000001", library name "Library1" and MediaAgent name "MA1".

  4. Run the following command from the <software installation directory>\Base folder.

    qoperation execute -af <downloaded location>\create_tape_library.xml

    Click here to see sample output.

Cloud Libraries

Create a Cloud Library

This procedure creates a cloud library with the specified vendor.

  1. Download the Config-CloudLib.xml file and save it on the computer where the command is run.
  2. Open the XML file.
  3. Change the XML parameters.
    Attribute Description
    mediaAgentName The name of the MediaAgent
    libraryName The name of the new cloud library
    baseFolder This is an optional attribute. You can specify the name of the base folder or else standard naming convention will be used to name the base folder.

    Vendor specific parameters

    AmazonS3

    Attribute Description
    mountPath <bucket>
    serverType 2
    loginName s3.amazonaws.com//<Access Key ID>
    password <Secret Access Key>

    AT&T

    Attribute Description
    mountPath <root folder>
    serverType 10
    loginName storage.synaptic.att.com//<Token ID>
    password <Shared Secret>

    Carnigo

    Attribute Description
    mountPath N/A
    serverType 51
    loginName <Service Host>
    password N/A

    DDN WOS

    Attribute Description
    mountPath <Policy>
    serverType 54
    loginName <Service Host>
    password N/A

    DELL

    Attribute Description
    mountPath N/A
    serverType 52
    loginName <Service Host>
    password N/A

    EMC Atoms

    Attribute Description
    mountPath <Root Folder>
    serverType 9
    loginName accesspoint.atmosonline.com//<Token ID>
    password <Shared Secret>

    Google

    Attribute Description
    mountPath <bucket>
    serverType 19
    loginName storage.googleapis.com//<Access Key ID>
    password <Secret Access Key>

    HDS Hitachi

    Attribute Description
    mountPath <Namespace>
    serverType 12
    loginName <Service Host>//<Username>
    password <Password>

    Azure

    Attribute Description
    mountPath <container>
    serverType 3
    loginName blob.core.windows.net//<Account Name>
    password <Access Key>

    Openstack

    Attribute Description
    mountPath <Container>
    serverType 14
    loginName <Service Host>//<Username>
    password <API Key>

    RackSpace

    Attribute Description
    mountPath <Container>
    serverType 5
    loginName api.mosso.com//<Username>
    password <API Key>

    Example: Use this example XML file to create an Amazon S3 cloud library with name "Library1", MediaAgent name "MA1", bucket "examplebucket", server type "2", Access Key ID "AKIAIOSFODNN7EXAMPLE" and Secret Access Key "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY".

  4. Run the following command from the <software installation directory>\Base folder.

    qoperation execute -af <downloaded location>\Config-CloudLib.xml

Enable or Disable Client Side Deduplication

  1. Download the client_deduplication.xml file and save it on the computer where the command is run.
  2. Open the XML file.
  3. Change the XML parameters.
    Attribute Description
    clientName The name of the client computer as it appears in the CommCell Browser

    For example: If you want to enable source-side deduplication to client1 and client2, then you must add the following:

    <entity>
    <clientName>client1</clientName>
    </entity>
    <entity>
    <clientName>client2</clientName>
    </entity>

    enableClientSideDiskCache Option to enable or disable source-side disk cache

    Valid values are true or false.

    maxCacheDb Specifies the maximum size in MB for source-side disk cache

    Valid values are 1024 - 131072 MB.

    enableVariableContentAlignment Option to enable or disable the variable content alignment

    Valid values are true or false.

    clientSideDeduplication Option to enable or disable client side deduplication

    Valid values are:

    OFF: Disable client side deduplication

    ON_CLIENT: Enable client side deduplication

    USE_SPSETTINGS: Use storage policy settings

    Example: Use this example XML file to enable client side deduplication, disable source-side disk cache, disable variable content alignment and set the maximum size of source-side disk cache to "2048MB" for a client with name "Client1".

  4. Run the following command from the <software installation directory>\Base folder.

    qoperation execute –af client_deduplication.xml

    Click here to see sample output.

Delete a Library

  1. Download the delete_library.xml file and save it on the computer where the command is run.
  2. Open the XML file.
  3. Change the XML parameter.
    Attribute Description
    libraryName The name of the tape library that you want to delete

    Example: Use this example XML file to delete a tape library with name "Library1".

  4. Run the following command from the <software installation directory>\Base folder.

    qoperation execute -af <downloaded location>\delete_library.xml

    Click here to see sample output.