Skip to main content
Sign Out

Welcome to Dell

My Account
  • Place orders quickly and easily
  • View orders and track your shipping status
  • Enjoy members-only rewards and discounts
  • Create and access a list of your products
  • Manage your Dell EMC sites, products, and product-level contacts using Company Administration.
Sign In Create an Account Dell Financial Services Premier Sign In Partner Program Sign In
Contact Us

Your Dell.com Carts

PowerProtect Data Manager Appliance 5.16.0.0 File System User Guide

PDF

Self-service commands for ADGLR

This section covers the list of available command line options to perform the granular level restore.

MOUNT

Use the MOUNT section to mount the backup copy on the Agentilr server for restore operations.

Run mount in the Agentilr server to enter the MOUNT section to perform all the MOUNT operations.

The supported commands for MOUNT operations are:

  • mount
  • unmount

Enter mount or mount --help in the command line to display the syntax and the associated parameters for MOUNT operation.

mount
Run the mount command to mount the backup copy on the server for restore operations. 
MOUNT --ssid=<SSID> --dd_host=<DD_HOST> --dd_user=<DD_USER> --dd_device_path=<DEVICE_PATH> [--dd_password=<DD_PASSWORD>] [--username=<USERNAME>] [--password=<PASSWORD>] [--client_name=<Client_Name>] [--allow_upgrade=<BOOL>]
The following message appears after mounting the backup successfully: 
MOUNT successful with mount ID <mount_id>.
Table 1. mount parametersParameters for mount
Parameter Description
--ssid=<SSID> Specify the save set id of the backup.
--dd_host=<DD_HOST> Specify the name of the protection storage system server that contains the backup.
--dd_user=<DD_USER> Specify the protection storage username.
--dd_device_path=<DEVICE_PATH> Specify the name and the path of the storage unit that contains the backup.
--dd_password=<DD_PASSWORD> Specify the password of the protection storage system user. This parameter is optional.
--username=<USERNAME> Specify to create a user with privileges to perform item level recovery. This parameter is optional.
--password=<PASSWORD> Specify to create a password for the created user account. This parameter is optional.
--client_name=<Client_Name> Specify the source machine where backup was taken. This parameter is optional.
--allow_upgrade=<BOOL This parameter is not supported. Default value for this flag is false. You can pass this flag.
unmount
Run the unmount command to unmount the mounted backup copy within the MOUNT section. 
UNMOUNT --mount_id=<MOUNT_ID>
The following message appears after unmounting the backup successfully: 
Unmount operation compeleted successfully.

Browse

Use the BROWSE section to browse the contents of the mounted backup.

Run browse in the Agentilr server to enter the BROWSE section to perform all the BROWSE operations.

Enter browse or browse --help in the command line to display the syntax and the associated parameters for BROWSE operation.

browse
Run the browse command to browse the specified object in the mounted backup or a live database. 
BROWSE [--dn=<DN>] --query_state=<queryState> --page_size=<size> [--order_by=<orderby>]

The browse results are displayed with Name, type and DN details.

Table 2. browse parametersParameters for browse
Parameter Description
--query_state=<query_state> Specify the page number of browse results.
--page_size=<size> Specify the number of entries per page.
--dn=<DN> Specify the distinguished name of the container object to browse. If no dn is entered, the root dn is considered. This parameter is optional.
--order_by=<orderby> Specify the sort key and the order in which the results must display. This parameter is optional.
  • The sort key sorts the results based on the name key.
  • The order sorts the results in ascending or descending order. The allowed entries are ASC for ascending order and DESC for descending order.
For example: name ASC sorts the results as per the name of the entries in ascending order.

Search

Use the SEARCH section of the Agentilr server to search any objects based on their classes.

Run search in the Agentilr server to enter the SEARCH section to perform all the SEARCH operations.

Enter search or search --help in the command line to display the syntax and the associated parameters for SEARCH operation.

search
Run the search command to search the selected object in the mounted backup or live database. 
SEARCH [--dn=<DN>] --query_state=<queryState> --page_size=<size> ([--filter=<filter>] | [--ldap_query=<ldapQuery>]) [--order_by=<orderby>]
Table 3. search parametersParameters for search
Parameter Description
--query_state=<query_state> Specify the page number of search results.
--page_size=<size> Specify the number of entries per page.
--dn=<DN> Specify the distinguished name of the container object to browse. If no dn is enter, the root dn is considered. This parameter is optional.
--filter=<filter> Specify the objectClass filter for searching. This parameter is optional. For example 
 SEARCH --dn=<Distinguished-Name> --query_state=1 --page_size=5 --filter=(objectClass=<AD-Object-Type>) --order_by=name ASC
--ldap_query=<ldapQuery> Specify the LDAP query for searching. This parameter is optional. For example, 
SEARCH --query_state=1 --page_size=5 --ldap_query=(&(cn=name)(objectClass=<AD-Object-Type>)) --order_by=name ASC
--order_by=<orderby> Specify the sort key and the order in which the results must be display. This parameter is optional.
  • The sort key sorts the results, based on the name key.
  • The order sorts the results in ascending or descending order. The allowed entries are ASC for ascending order and DESC for descending order.
For example: name ASC sorts the results as per the name of the entries in ascending order.

Restore

Use the RESTORE section of the Agentilr server to restore a selected object from the mounted backup.

Run restore in the Agentilr server to enter the RESTORE section to perform all the RESTORE operations.

Enter restore or restore --help in the command line to display the syntax and the associated parameters for RESTORE operation.

restore
Run the restore command to restore specified objects based on a specific criteria. 
RESTORE --data_file=<FILE_PATH> [--alt_location=<ALT_LOCATION>] [--default_user_pwd=<PASSWORD>] [--disable_user=<BOOL>] [--change_pwd_next=<BOOL>]
For object level restore, create a text file that contains the distinguished names of all the objects that must be restored. The format of the text file must be dn followed by the distinguished names of the objects. For example: 
dn
CN=user test 23,OU=Test OU,DC=xxx,DC=myarvmtest16,DC=com
CN=user test 23,OU=Test OU,DC=xxx,DC=myarvmtest16,DC=com
For attribute level restores, create a text file that contains the distinguished name of the object, and all the attributes of the object. The format of the text file must be dn followed by the distinguished name of the object, and then attributes followed by the list of attributes that must be restored. For example: 
dn
CN=Test Group,CN=Computers,DC=xxx,DC=myarvmtest16,DC=com
attributes
accountNameHistory
adminCount
adminDescription
adminDisplayName
altSecurityIdentities
cn
description
desktopProfile
displayName
displayNamePrintable
distinguishedName
dSASignature
dSCorePropagationData
extensionName
flags

Enter the file name of the created text file in the --data_file parameter followed by restore keyword to initiate the restore operation.

Table 4. restore parametersParameters for restore
Parameter Description
--data_file=<FILE_PATH> Specify the path to the restore file that contains the distinguished names (DN) and names of attributes to restore. If only the DNs are available, the full object is restored. If attribute names are also available, only those attributes is restored for the specified objects (attribute level restore).
--alt_location=<ALT_LOCATION> Specify the path to the alternate location to restore specified objects. This parameter is optional.
--default_user_pwd=<PASSWORD> Specify a default password for user accounts that are being restored. This parameter is optional.
--disable_user=<BOOL> Specify True or False to enable or disable the user account after restore. The default variable is False. This parameter is optional.
--change_pwd_next=<BOOL> Specify True or False to enable or disable password reset during the next login. The default variable is False. This parameter is optional.

Enter restore --help in the command line to display the syntax and the associated parameters for RESTORE operation.

To restore specific objects to an alternate host, see Self-service granular level restore of active directory objects to an alternate host. To restore objects to original host, see Self-service granular level restore of active directory objects

Unmount

Use the UNMOUNT section of the Agentilr server to unmount the mounted backup.

Enter unmount or unmount --help in the command line to display the syntax and the associated parameters for UNMOUNT operation.

Run unmount in the Agentilr server to enter the UNMOUNT section to unmount the specified backup copy. 

UNMOUNT --mount_id=<MOUNT_ID>
Where <MOUNT_ID> is the mount id of the successfully mounted backup.
The following message appears after unmounting the backup successfully: 
Unmount operation completed successfully.

Enter unmount --help in the command line to display the syntax and the associated parameters for UNMOUNT operation.

Common commands for all the sections of the Agentilr server

The following commands are common for all the sections in the Agentilr server.

  • help
  • list
  • exit
help
Run the help command to print all the commands supported within the individual sections of the Agentilr server.
list
Run the list command to list all the mounted backups for the current session within the individual sections of the Agentilr server.
Sample output: 
MOUNT_ID: 1698946585 
SSID: 1698906896
DD_USERNAME: plc_121-e2e190-70c7d
STORAGE_UNIT: /plc_121-e2e190-70c7d/PLCTLP-06ba2865-7fea-486f-acf9-d25d862d28e9 
DD_HOST: 10.125.136.153 
HOSTNAME: ar-win16vm3.pune.myarvmtest16.com 
BACKUP: 7005:DC=pune,DC=myarvmtest16,DC=com 
LIVE: 389:DC=pune,DC=myarvmtest16,DC=com
exit
Run the exit command to exit the individual sections of the Agentilr server.
set

This command is applicable for BROWSE, SEARCH, and RESTORE sections of the Agentilr server.

Run the set command to set preference based on mount id, backup port, or live port to the current self-service session. Once configured, the set preference is applicable for all the subsequent commands in the session.
NOTE:Use the set command to perform search operation to an alternate port for active directory databases (both backup or live).
Table 5. set parametersParameters for set
Parameter Description
--mount_id=< MOUNT_ID> Specify to set a specific mounted backup in the current self-service session. All the further operations in the current session are applicable for the specified backup only.
--backup_port=< BACKUP_PORT> Specify to set the preferred backup port for the active directory database in the current self-service session.
--live_port=< LIVE_PORT> Specify to set the preferred live port for the active directory database in the current self-service session.

Rate this content

Accurate
Useful
Easy to understand
Was this article helpful?
0/3000 characters
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please select whether the article was helpful or not.
  Comments cannot contain these special characters: <>()\