Actifio CLI Reference

Actifio CDS and Sky 7.0

Copyright, Trademarks, and other Legal Matter
Copyright © 2010 — 2016 Actifio, Inc. All rights reserved.
Actifio® is a registered trademark of Actifio, Inc. AnyIT™, Dedup Async™, Manage Data Simply™, Virtual Data
Pipeline™, VDP™, Protection and Availability Storage Platform™, PAS™, Copy Data Storage Platform™, CDS™,
Actifio Sky™ and Actifio One™ are trademarks of Actifio, Inc. All other brands, product names, goods and/or
services mentioned herein are trademarks or property of their respective owners.
Actifio, Inc., is a provider of data protection and availability products. Actifio’s technology is used in products sold
by the company and products and services sold and offered by its commercial partners. The current list of Actifio
patents is available online at: http://www.actifio.com/patents/
Actifio believes the information in this publication is accurate as of its publication date. Actifio reserves the right to
make changes to information published in this document, including without limitation specifications and product
descriptions, at any time and without notice. This document supersedes and replaces all information supplied
prior to the publication hereof.
THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS IS.” ACTIFIO, INC. MAKES NO
REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS
PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS
FOR A PARTICULAR PURPOSE.
This software and the associated documentation are proprietary and confidential to Actifio. Use, copying, and
distribution of any Actifio software described in this publication requires an applicable software license. Any
unauthorized use or reproduction of this software and the documentation may be subject to civil and/or criminal
liability.
Actifio strives to produce quality documentation and welcomes your feedback. Please send comments and
suggestions to [email protected].

ii Actifio CLI Reference | actifio.com |

Contents

Preface .......................................................................................................... v
Actifio Appliances..............................................................................................................................................v
The Actifio Now Customer Portal.....................................................................................................................v
Actifio Support Centers ....................................................................................................................................v

Alphabetical Index of Commands............................................................................................ vii

Chapter 1 - CLI Overview ........................................................................................................... 1

Run Modes for the CLI ......................................................................................................................................2
Interactive ...........................................................................................................................................................................2
Single Shot Mode ..............................................................................................................................................................2
Command Sets Supported by the CLI .............................................................................................................2
udsinfo CLI Command Set ................................................................................................................................................3
udstask CLI Command Set ................................................................................................................................................3
Command-Line Interface Syntax Conventions ...............................................................................................4
Obtaining CLI Help ............................................................................................................................................6
Restricted Bash Shell ........................................................................................................................................7
CLI Return Codes and Error Messages ............................................................................................................7
Using the -delim, -nohdr, or -filtervalue Parameters......................................................................................7
Using the -delim Parameter ..............................................................................................................................................9
Using the -filtervalue Parameter.......................................................................................................................................9
Operational Hints and Tips ............................................................................................................................. 11
Scripted Solutions............................................................................................................................................................ 11
Quoting Commands ........................................................................................................................................................ 11
Understanding Actifio Desktop Constructs With the CLI..............................................................................12

Chapter 2 - Accessing the Actifio Appliance CLI .................................................................. 13

Defining CLI Usage and Administrative Rights.............................................................................................13
Accessing the Command-Line Interface........................................................................................................16
Generating an SSH Public/Private Key Pair ...................................................................................................................16
Uploading the SSH Public Key File to the Actifio Appliance ........................................................................................18
Configuring the SSH Session on the Host .....................................................................................................................20
Starting an SSH Client Session in a Non-Interactive Environment .............................................................................22
Identifying Actifio Appliance Software Version.............................................................................................22

| actifio.com | Actifio CLI Reference iii

Chapter 3 - User Management Commands ............................................................................ 23

Chapter 4 - Host and Appliance Management Commands .................................................. 55

Chapter 5 - License Management Commands ..................................................................... 181

Chapter 6 - Application Management Commands .............................................................. 187

Dedup Drive Seeding Commands ...............................................................................................................283

Chapter 7 - Policy and Schedule Commands ....................................................................... 307

Chapter 8 - Job Event and Notification Commands ............................................................ 353

Chapter 9 - Auto Update and Remote Support Commands ................................................ 381

Chapter 10 - Actifio Connector Support Commands .......................................................... 389

Appendix A - Advanced Protection Settings with the mkpolicyoption Command .......... 399
Advanced Settings for Out-of-Band File Systems ......................................................................................400
Advanced Settings for Oracle Database...................................................................................................... 401
Advanced Settings for VM in ESX DataStore..............................................................................................403
Overriding Script Timeout Settings for the Actifio Connector ...................................................................404

Appendix B - Managing Jobs and Job Slots......................................................................... 405

On-demand Jobs...........................................................................................................................................405
Queuing of On-Demand Backup Jobs .........................................................................................................407
Relaunching Jobs ..........................................................................................................................................408

Appendix C - Configuring Image Preservation ..................................................................... 409

Image Preservation Overview ......................................................................................................................409
Modifying Image Preservation Settings On a System-wide Application Level........................................ 411
Modifying Preserve Snapshots Settings...................................................................................................................... 411
Modifying Preserve Local Dedup Mode....................................................................................................................... 412
Disabling Image Preservation Mode On A Per Application Basis .............................................................413
Alerts and Warnings ......................................................................................................................................416
Warning Level Alert—First Time the Snapshot Expiration Window is Reached ....................................................... 416
Warning Level Alert—Snapshot Image Expired Because Threshold Limit Exceeded .............................................. 416
Daily Warning Level Event—Deferred Expirations for Snapshots ............................................................................. 416
Daily Warning Level Event—Deferred Expirations Because Threshold Limit Exceeded .......................................... 416
Warning Level Alert—All Preserved Images Have Been Processed .......................................................................... 417
Weekly Error Level Event—Images Deduplicated or Remotely Replicated After 7 Days ......................................... 417

Appendix D - List of Parameters Used With getparameter and setparameter .................. 419

Appendix E - List of Policy Options ....................................................................................... 439

Appendix F - List of Restore Options..................................................................................... 459

iv Actifio CLI Reference | actifio.com |

 Preface

This guide provides detailed descriptions and syntax for Actifio’s Command Line Interface (CLI). It also describes how
to access the command-line interface using SSH.
This guide assumes you have read Getting Started with Actifio Copy Data Management and have a grasp of the
basic concepts associated with an Actifio appliance.
Your Actifio appliance’s Documentation Library contains detailed, step-by-step, application-specific instructions on how
to protect and access your data via the Actifio Desktop. Each guide is in PDF format and may be viewed, downloaded,
and printed on demand. The following guides will be of particular interest:
• Setting Up Users and Roles With the Domain Manager
• Configuring Resources and Settings With the Domain Manager
• Connecting Hosts to Actifio Appliances
• Planning and Developing Service Level Agreements
• Virtualizing and Protecting Copy Data with the Application Manager
• Accessing and Recovering Copy Data with the Application Manager
• Replicating Data Using Actifio Appliances

Actifio Appliances
Unless otherwise specified, all features and functions described in this document apply to all Actifio appliances.

The Actifio Now Customer Portal

During the configuration and initialization of your Actifio appliance your Actifio representative provided you with a user
name and password for the Actifio Now customer portal.
From the Actifio Now customer portal you can obtain detailed reports about your Actifio appliance, access the Actifio
product documentation, including release notes, and search the knowledge base for answers to specific questions.
To log into the Actifio Now customer portal:
1. Go to: https://now.actifio.com
2. When prompted, enter the user name and password provided by your Actifio representative.

Actifio Support Centers

To contact an Actifio support representative, you can:
• Send email to: [email protected]
• Call:
From anywhere: +1.315.261.7501
US Toll-Free: +1.855.392.6810
Australia: 0011 800-16165656
Germany: 00 800-16165656
New Zealand: 00 800-16165656
UK: 0 800-0155019

| actifio.com | Actifio CLI Reference v

vi Actifio CLI Reference | actifio.com |
Alphabetical Index of Commands

abortupgradehostconnector 395 chslp 110

addcluster 123 chslt 318
addflowitemproperty 292 chsnmpconfig 354
addflowitemvalue 295 chuser 26
addflowproperty 294 chworkflow 296
addroutehost 57 cleanupdedupasync 344
addssd 124 cloneimage 247
addvm 242 configchap 97
appdiscovery 190 configdefaultdomain 66
backup 244 configdnsserver 69
certexchange 125 configemailserver 356
chappcluster 177 configeventemail 355
chapplication 192 configipfailover 67
chappstack 195 configresourcewarning 111
chappstackmember 196 configserviceemail 358
chauthservice 107 configsnmpagent 359
chbackup 246 configssl 130
chbandwidthschedule 343 configusercli 28
chcluster 127 createliveclone 252
chconsistgrp 197 deleteimage 256
chdiskpool 108 emaillogs 362
chgroup 198 expireimage 257
chhost 58 export 319
chjob 126 exportimage 270
chldapserver 64 failback 199
chmonitoreddevice 373 failover 200
chorg 24 fetchconnectorlogs 396
chpolicy 308 getauthservice 29
chpolicyoption 312 getautodiscovery 70
chproxyhost 62 getemailserverconfig 364
chrole 25 geteventemailconfig 365
chsla 314 getfingerprint 182

| actifio.com | Actifio CLI Reference vii

getgcschedule 132 lshost 82
getlicenseinfo 183 lsipfailover 68
getparameter 131 lsjob 154
getreleasenote 383 lsjobhistory 158
getremotesupport 387 lsldapgroup 87
getresourcewarning 112 lsldapgrouporg 90
getschedule 133 lsldapgrouprole 89
getserviceemailconfig 366 lsldapserver 86
getsysteminfo 134 lslicense 184
hmcdiscovery 191 lsmdlstat 217
import 320 lsmonitoreddevice 377
initializedevice 284 lsnasshare 85
installtrustedcertificate 135 lsorg 30
installupdate 384 lsorgresource 32
iscsitest 71 lspolicy 321
ivmdiscovery 73 lspolicyoption 324
joincluster 136 lsrestoreoptions 278
listrouteonhost 75 lsrights 34
lsappclass 209 lsrole 35
lsappcluster 173 lssettableoption 347
lsapplication 206 lssla 326
lsaudit 137 lsslp 115
lsavailableconnector 390 lsslt 328
lsbackup 258 lssnappoolstat 151
lsbandwidthschedule 345 lssnmpconfig 367
lscluster 140 lssnmpevent 368
lsclustermember 175 lsssd 78
lsconsistgrp 211 lsupdate 385
lsconsistgrpmember 213 lsuser 37
lsdatastore 76 lsuserrole 39
lsdedupefficiency 145 lsversion 382
lsdeduppoolstat 142 lsvm 243
lsdedupstat 146 lsworkflow 290
lsdefaultdomain 80 mkapplication 220
lsdevice 285 mkappstack 221
lsdiskpool 113 mkappstackmember 222
lsdiskpoolstat 149 mkbandwidthschedule 349
lsdnsserver 81 mkconsistgrp 223
lsgroup 204 mkconsistgrpmember 224
lsgroupmember 215 mkdiskpool 117

viii Actifio CLI Reference | actifio.com |

mkflowitem 299 rmdiskpool 121
mkgroup 225 rmemailserverconfig 380
mkgroupmember 226 rmeventemail 379
mkhost 94 rmfailovertest 282
mkldapgroup 91 rmflowitem 301
mkldapgrouporg 93 rmflowitemproperty 303
mkldapgrouprole 92 rmflowproperty 304
mkldapserver 98 rmgcschedule 172
mklicense 185 rmgroup 232
mkmonitoreddevice 375 rmgroupmember 233
mkorg 40 rmhost 100
mkorgresource 41 rmldapgroup 102
mkpolicy 330 rmldapgrouporg 103
mkpolicyoption 334 rmldapgrouprole 104
mkrole 43 rmldapserver 101
mksideband 305 rmlicense 186
mksla 336 rmmonitoreddevice 378
mkslp 119 rmorg 47
mkslt 338 rmorgresource 48
mksnmpconfig 371 rmpolicy 341
mkuser 44 rmpolicyoption 342
mkuserrole 46 rmrole 49
mkworkflow 298 rmsla 339
mountimage 263 rmslp 122
prepmount 253 rmslt 340
prepunmount 255 rmsnmpconfig 372
refreshliveclone 274 rmuser 50
removeroutefromhost 99 rmuserrole 51
replicateimage 250 rmworkflow 300
restoreimage 276 roleaddrights 52
rmappcluster 178 roledelrights 53
rmapplication 227 runworkflow 302
rmappstack 228 seedin 287
rmappstackmember 229 seedout 288
rmavailableconnector 393 setarchiveconfig 163
rmbandwidthschedule 351 setautodiscovery 105
rmcluster 162 setgcschedule 165
rmclustermember 179 setnodeip 167
rmconsistgrp 230 setparameter 168
rmconsistgrpmember 231 setremotesupport 388

| actifio.com | Actifio CLI Reference ix

setschedule 169
syncback 234
synccluster 171
testfailover 235
testldapserver 106
unexportimage 273
unmountimage 280
upgradehostconnector 394
uploadupdate 386
verifyimage 281
vmdiscovery 239

x Actifio CLI Reference | actifio.com |

1 CLI Overview

There are two ways to manage the Actifio CDS appliance or Actifio Sky appliance: using the Actifio Desktop and
through the Command Line Interface (CLI). The Actifio appliance CLI provides a collection of commands for a system
administrator, programmer, or other qualified personnel to use as a means to access, configure, and monitor an Actifio
appliance or node. You may require access to the CLI to configure the advanced features of the Actifio appliance or to
develop a series of scripts to automate its configuration. All features and functionality supported by the Actifio
Desktop are also available from the Actifio appliance CLI.
You access the Actifio appliance CLI by establishing a Secure Shell (SSH) connection between the SSH client software
on your computer and the SSH server on an Actifio appliance.

Note: See Chapter 2, Accessing the Actifio Appliance CLI for details on defining CLI usage rights and accessing the
CLI.

This chapter describes:

Run Modes for the CLI on page 2
Command Sets Supported by the CLI on page 2
Command-Line Interface Syntax Conventions on page 4
Obtaining CLI Help on page 6
Restricted Bash Shell on page 7
CLI Return Codes and Error Messages on page 7
Using the -delim, -nohdr, or -filtervalue Parameters on page 7
Operational Hints and Tips on page 11
Understanding Actifio Desktop Constructs With the CLI on page 12

| actifio.com | Actifio CLI Reference 1

 Run Modes for the CLI
The CLI can be run in two modes, Interactive and Single Shot.

Interactive
You start an interactive session by logging into Actifio appliance using an SSH client such as PuTTY or native SSH. See
Chapter 2, Accessing the Actifio Appliance CLI.

Using an SSH Client to Log In To the Actifio Appliance

Single Shot Mode

SSH commands can be sent to be run instantly in a non-interactive session. You may want to run an occasional
command on one command line. Since only one command is run, this is called single shot mode. Unix operating
systems can send single shot commands using the SSH command like this:
ssh -i ~/.ssh/id_rsa [email protected] "udsinfo lsuser"
When using the Windows operating system, an example of an application that can be used is plink. For example:
plink -i id_rsa.ppk [email protected] "udsinfo lsuser”

Command Sets Supported by the CLI

The Actifio appliance CLI supports two command sets: udsinfo and udstask. The udsinfo command set includes the
information-based commands and the udstask command set includes the commands that modify the Actifio
appliance.
These two command sets are described in this section.

Note: The Actifio appliance also provides access to the usvcinfo and usvctask CLI command sets. They are
intended primarily for trained Actifio personnel to query or make changes to the SVC components. Consult your
Actifio Services and Support team before using any of the usvcinfo and usvctask CLI commands.

2 Actifio CLI Reference | actifio.com |

udsinfo CLI Command Set
The udsinfo CLI commands are used to retrieve information from the Actifio appliance (for example, lsapplication,
lsorg, lsorgresource, and so on).
For example, to display a list of previously created organizations:
$ udsinfo lsorg
id description name
3 ALL organization, all objects be... ALL
5 PUBLIC organization, every object... PUBLIC
131684 Children QA & DEV Actifio
137346 Admin
150949 Lab1 Lab1_org

udstask CLI Command Set

The udstask CLI commands affect the Actifio appliance (for example, appdiscovery, backup, cloneimage, and so
on). You use these commands to make configuration changes to the Actifio appliance.

Note: Typically no message is returned if the command succeeds; however, helpful messages may be returned for
certain commands.

For example, to start a backup on demand job:

$ udstask backup -app 5840 -policyid 5111
Job_0012345
Once executed, the udstask backup command informs you that Job_0012345 has been initiated to perform the
backup job.

| actifio.com | Actifio CLI Reference 3

 Command-Line Interface Syntax Conventions
This section describes the CLI syntax diagram conventions used in this document. It outlines the different syntax
symbols that represent the components of a command in the CLI and the rules associated with the syntax
components.
Included below is an example of the CLI syntax used in this document. This example is for the vmdiscovery
command of the udstask command set:
>>- udstask -- -- vmdiscovery -- --+---------------------+------>
'- -discoverclusters -'
>--+----------------+-- --+-----------+-- --+-----------+------->
'- -discovervms -' '- -addall -' '- -addvms -'
>--+----------------------------+-- --+-------------------+----->
'- -cluster -- cluster_name -' '- -delim -- delim -'
>--+- -host --+- host_name -+-- --+-----------------------+----->
'- host_id ---' '- -org -+- org_id ---+-'
'- org_name -'
>--+---------------+------------+-------------------+-----------><
'- -vms -- vms -' '- -nohdr -- nohdr -'

The following table explains how to read the syntax diagrams that represent the command-line interface (CLI)
commands throughout this document.

Command-Line Interface Syntax Conventions

Notation Syntax Description

Main path line >> .....>< Begins on the left with double arrowheads and
ends on the right with arrows facing each other.
When a syntax diagram is longer than one line,
each line to be continued ends with a single >
arrowhead and the next line begins with a single
>. Read the diagrams from left–to–right and top–
to–bottom following the main path line.

Required keywords >-- -host --+ Indicates the parameters or arguments that you
must specify for the command. Required
keywords appear on the main path line. Mutually
exclusive required keywords are stacked
vertically.

Note: Keywords appear in bold throughout this

CLI Reference Guide.

4 Actifio CLI Reference | actifio.com |

 Command-Line Interface Syntax Conventions (Continued)

Notation Syntax Description

Optional keywords >-+----------------+ Indicates the optional parameters or arguments

--+- org_id ----+ that you can choose to specify for the command.
'--- org_name -' Optional keywords appear below the main path
line. Mutually exclusive optional keywords are
stacked vertically.

Note: Optional keywords appear in bold

throughout this CLI Reference Guide.

Variable >-+--------------+ Represents the value that you need to supply for
--+- org_id ----+ a parameter or argument, such as a file name,
'--- org_name -' user name, object name, object ID, or password.
If a parameter has mutually exclusive options,
those parameters are stacked below the first
parameter. Optional variables appear below the
main path line.

Note: Variables appear in italics throughout this

CLI Reference Guide.

Single quotation mark -basedn Indicates the start and end of a parameter or
delimiters 'dc=example,dc=com' argument that contains multiple values. Enclose
one or more name–value pairs in a set of single
quotation marks for a particular parameter or
argument.

| actifio.com | Actifio CLI Reference 5

 Obtaining CLI Help
You can specify either -h or -? to obtain CLI command help. You can get help on the use and syntax of a particular
command, or obtain a listing of all CLI commands associated with the udsinfo or udstask command set.
For example, entering lscluster -h provides the syntax and a listing of the actions available with lscluster command.
$ udsinfo lscluster -h
lsapplication
The lsapplication command returns a concise list of applications, or a detailed view of an
application.
Syntax
>>- udsinfo -- -- lsapplication -- ----------------------------->
>--+--------------------------------+-- --+----------+-- ------->
'- -filtervalue -- attrib=value -' '- -nohdr -'
>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+
Parameters
-delim delimiter
(Optional) By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed the
data is separated from the header by a space. The -delim parameter overrides this
behavior. Valid input for the -delim parameter is a one-byte character. If you enter -
delim: on the command line, the colon character (:) separates all items of data in a
concise view; for example, the spacing of columns does not occur. In a detailed view,
the data is separated from its header by the specified delimiter.
-filtervalue attrib=value
(Optional) Specifies that you want your report to display any or all of the list of
valid filter attributes. The valid filter attribute for the 'udsinfo lsapplication'
command are:
* appname
* apptype
...
For example, entering udstask -h lists of all CLI commands supported by the udstask command set.
$ udstask -h
abortupgradehostconnector
addcluster
addflowitemproperty
...

6 Actifio CLI Reference | actifio.com |

Restricted Bash Shell
The Actifio appliance CLI runs in a restricted shell known as an RBASH shell. This is done to ensure that the Actifio
appliance adheres to the highest levels of security and data integrity.
The main difference that a Unix administrator will find running in RBASH is that many shell commands do not work,
such as cd for change directory. There are six Unix commands that can currently be run from the CLI: cut, grep, less,
sed, sort, tail. If you attempt to enter commands that are not allowed, a message similar to the following is displayed:
rbash: cd: restricted
All standard commands delivered by the bash shell itself are usable, such as if/then loops and for/next loops.

Note: Unix commands are available only for users with 'administrator' privileges.

CLI Return Codes and Error Messages

When the command line processor finishes processing a command, it returns a return (or exit) code. Each CLI
command adheres to the following return code convention:
• A return code of 0 indicates that the CLI command succeeds. When the command succeeds, there may or
may not be an accompanying message.
• A non-0 return code indicates an error with the CLI command. In the case of an error, an error message is
returned.
Failed CLI commands contain an error message in the following format:
ACTERR-<error-code> <message>, where:
<error-code> is the Actifio error type code in decimal format, with a minimum length of 6 digits (including
possible leading “0”s).
<message> is the textual message indicating the potential problem that resulted in the error condition.
For example:
$ udsinfo verifyimage
ACTERR-010005 missing required image

Using the -delim, -nohdr, or -filtervalue Parameters

The udsinfo CLI command set includes commands that display information about the Actifio appliance and its
components. Many of the udsinfo CLI commands support the use of the -delim, -nohdr, and -filtervalue parameters
to facilitate scripting.
• The -nohdr and/or -delim parameters enable the easy retrieval of output fields through a script. -nondr
skips the display of column headings and 
-delim overrides the display of column data in separate rows.
• The -filtervalue parameter allows you to reduce amount of data returned in a report by on a series of filter
attributes.
Depending on your requirements, you can use any or all of these parameters as part of a CLI command. If required,
you can also return the details of an object by including its ID.
For example, here is the output for the udsinfo lsslt command:
$ udsinfo lsslt
id override description name
103 true Enterprise Protection Enterprise
105 true Standard Protection Standard

| actifio.com | Actifio CLI Reference 7

 You can include -delim to facilitate scripting:
$ udsinfo lsslt -delim ,
id,override,description,name
103,true,Enterprise Protection,Enterprise
105,true,Standard Protection,Standard
You can include -nohdr to skip the display of column headers for data, and include -delim to facilitate scripting:
$ udsinfo lsslt -nohdr -delim ,
103,true,Enterprise Protection,Enterprise
105,true,Standard Protection,Standard
You can include -filtervalue to select only the data you are interested in displaying:
$ udsinfo lsslt -delim , -filtervalue name="snap only"
id,override,description,name
34018,true,new description,snap only
And you can also use wild cards with -filtervalue:
$ udsinfo lsslt -delim , -filtervalue name=snap*
id,override,description,name
34018,true,new description,snap only
If an object ID is known, you can obtain the details of an SLT:
$ udsinfo lsslt -delim = 34018
id=34018
override=true
description=new description
name=snap only

8 Actifio CLI Reference | actifio.com |

Additional examples include:
• Locate a host, with name “foo”:
$ udsinfo lshost -filtervalue hostname=foo
id vcenterhostid svcname ... hostname ...
5839 4241 ... foo ...
• Locate all applications that runs on this host:
$ udsinfo lsapplication -filtervalue hostid=5839
id ... hostid ... appname ...
5840 ... 5839 ... nvm1 ...
• Locate the SLA that is used to protected the application:
$ udsinfo lssla -filtervalue appid=5840
id ... slpid ... appid ... sltid
5080 ... 51 ... 5840 ... 5008
• Locate all policies in the SLA template:
$ udsinfo lspolicy -filtervalue sltid=5008

Using the -delim Parameter

By default, all columns of data are separated by spaces in the concise view. In the detailed view, each column of data
is displayed in a separate row and if the headers are displayed, the header is separated from the data by a space. The 
-delim parameter overrides this behavior.
Valid input for the -delim parameter is a one- byte character. To display the data, the recommended delimiter is a
comma (',') for list view, and an equal sign ('=') for detail view.
The comma is typically a safe choice as a delimiter, however, there are certain commands that contain output where a
comma exists in one or more of the fields. This is routinely the description field since there are effectively no illegal
characters in that field. In this case, commands such as udsinfo lsapplication and udsinfo lsslt can be complex to
delimit. You can use multi-character delimiters such as @#@ which are less likely to appear in a field.

Using the -filtervalue Parameter

The -filtervalue parameter instructs the Actifio appliance that you want your report to display any or all of the specified
list of valid filter attributes. Valid filter attributes can vary with the different CLI commands. The filter is formed with an
attribute and a value. The CLI supports the use of special characters and wild cards with the -filtervalue parameter.

Note: The CLI shell will attempt to interpret any of the special characters if they are not escaped (preceded with a
backslash ('\') character).

For example, to locate a host with the name “foo”:

$ udsinfo lshost -filtervalue hostname=foo
id vcenterhostid svcname ... hostname ...
5839 4241 ... foo ...
You can then locate all applications that runs on this host:
$ udsinfo lsapplication -filtervalue hostid=5839
id ... hostid ... appname ...
5840 ... 5839 ... nvm1 ...

| actifio.com | Actifio CLI Reference 9

 And locate the SLA that is used to protected the application:
$ udsinfo lssla -filtervalue appid=5840
id ... slpid ... appid ... sltid
5080 ... 51 ... 5840 ... 5008
And, finally, locate all policies in the service-level template:
$ udsinfo lspolicy -filtervalue sltid=5008
Note the following guidelines when using -filtervalue:
• When you specify more than one filter, combine the multiple filters with the ampersand ('&') character (and
escaped with the backslash ('\') character as required by the shell). For string type of filters, only the equal
('=') operator is allowed.
• You can use the asterisk ('*') wild card character. For example:
o To match disk pools with a name that begins with 'foo', use '-filtervalue name=foo*'
o To list all jobs with a job name that begins with 'Job_0001', use '-filter value jobname=Job_0001*'.
• For number and date types, allowed operators include: =, >, >=, <, <=. These operators must be escaped
with the backslash ('\'), or enclosed in a single quote (') or double quote ("), as required by the CLI shell
script. For example:
o * -filtervalue warnpct\>=80
o * -filtervalue "warnpct>=80"
o * -filtervalue 'warnpct>=80'
The expiration, expirationdate, queuedate, startdate, enddate, and backupdate parameters can also
use these operators. For example:
o -filtervalue 'startdate>2014-09-28'
o -filtervalue 'expirationdate>2014-09-28 6:50:00'
• Certain filters only allow predefined constants. For example:
o The protectable attribute allows only none, fully, or partially (for example, '- filtervalue
protectable=fully').
o The status attribute allows only running, queued, paused, interrupted, or stalled, (for example, '-
filtervalue status=running').
o The characteristic attribute allows only primary, mount, unmount, vdisk, or clone (for example, '-
filtervalue characteristic=mount').
o The exclusiontype attribute allows only daily, weekly, monthly, or yearly (for example, '-filtervalue
exclusiontype=weekly').
• A job may have sub-jobs. To filter sub-jobs, you can use "- filtervalue parentid=0" to list only the top-level
jobs.

10 Actifio CLI Reference | actifio.com |

Operational Hints and Tips
This section outlines a series of hints and tips when you use the Actifio appliance CLI. It covers:
Scripted Solutions on page 11
Quoting Commands on page 11
Understanding Actifio Desktop Constructs With the CLI on page 12

Scripted Solutions
An extension of single shot mode is to issue short script-like collections of commands. Because the RBASH shell
supports only a limited set of Unix commands, these commands could be used as a short script run by the CLI.
For example, to learn the timezone for newcdsuser1, you can enter the following command since cut -d, -f5 reads the
comma delimited output and displays the fifth field.
$ ssh [email protected] "udsinfo lsuser -nohdr -delim , | grep
newcdsuser | cut -d, -f5"
EST
Single shot SSH commands can be run as part of a host side script.

Quoting Commands
When issuing a single shot command, it is important to include double quotes around the command syntax that you
want executed by the CLII.
For example, the following command will initially list all backups, grep (search) the output first for a particular host
(called hq-postgresql), and then grep (search) the output of the first search for any snapshot jobs. The two greps will
be run locally on the host server that issued the commands and not by the Actifio appliance.
$ ssh [email protected] udsinfo lsbackup | grep hq-postgresql | grep snapshot
As an alternate method, if you include double quotes around the entire command, the grep commands will be run by
the Actifio CDS CLI and the entire command will execute much faster. This increased speed occurs because no
unwanted data is sent over the network from the Actifio appliance to the issuing workstation.
$ ssh [email protected] "udsinfo lsbackup | grep hq-postgresql | grep
snapshot”

Note: Keep in mind that if you intend to include double quotes around a command this may cause a behavior issue
if you also include quotes within the command itself.

For example, the following command requires that lsjobhistory -filtervalue includes double quotes.
$ ssh [email protected] udsinfo lsjobhistory -filtervalue "jobhistory since 1
hours”
However, when run as a single shot command you would encounter this error:
$ ssh [email protected] udsinfo lsjobhistory -filtervalue "jobhistory since 1 hours"
ACTERR-010018 only one argument allowed for command
In this case, we recommend that you include backslashes (escaped with '\') for each quote to force the local shell to
send the commands as is without splitting the command when it encounters the first quote.
$ ssh [email protected] "udsinfo lsjobhistory -filtervalue \"jobhistory since
1 hours\” "

| actifio.com | Actifio CLI Reference 11

 Understanding Actifio Desktop Constructs With the CLI
When you use the Actifio Desktop from the GUI to develop your application, the flow of creating templates (including
policies) and resource profiles occurs in the SLA Architect, which are then applied to applications in the Application
Manager to create SLAs.
When you use the CLI to develop these same Actifio appliance constructs, the interaction between CLI commands
may be slightly confusing. You can track the mapping of what you see in the Actifio Desktop to what can be displayed
in the CLII through the use of the various udsinfo commands.
For example, consider the following SLA construct hierarchy. A template is a collection of policies that, when applied
to an application in combination with a resource profile, creates an SLA. You can use the udsinfo command set to
track the construct mapping between the Actifio appliance GUI and CLI:

GUI Action CLI Command

Display a list of policy templates (service level templates) or a detailed view of a lsslt
template.

Display a list of policies or the detailed view of a policy (a template (SLT) is made lspolicy
up of one or more policies).

Display a list of applications or a detailed view of an application. lsapplication

Displays a list of profiles (service level profiles), or a detailed view of a profile. lsslp

Display a list of SLAs or a detailed view of an SLA. lssla

Display a list of policy options or the detailed view of a policy option. lspolicyoption

Displaying the policy templates using the udsinfo lsslt command will not show which applications are using these
templates. However, displaying the SLAs which were created when a template is applied to an application will display
which application is using which template.

12 Actifio CLI Reference | actifio.com |

2 Accessing the Actifio Appliance
CLI

Actifio appliance users with CLI usage right can access the command-line interface of the appliance using SSH. The
SSH server software is pre-installed on the Actifio appliance. The Actifio appliance manages communication with the
SSH client software on your computer using SSH public and private keys.
This chapter describes:
Defining CLI Usage and Administrative Rights on page 13
Accessing the Command-Line Interface on page 16
Identifying Actifio Appliance Software Version on page 22

Defining CLI Usage and Administrative Rights

The Actifio appliance allows you to create and manage multiple users, roles, and organizations. A user must have CLI
usage rights as part of their user role to access to the Actifio appliance CLI. To add CLI usage rights, refer to
“Assigning Rights to a Role” in Setting Up Users and Roles in the Actifio Domain Manager in the Actifio
Documentation Library. This process must be performed from the Actifio appliance Desktop GUI.

| actifio.com | Actifio CLI Reference 13

 There are two classes of rights:
• Access to an entire Actifio Desktop service. You can un-check a service, or select it and then restrict it to
some degree through the Access Control Levels (ACLs).
• ACLs provide additional rights and permit you to restrict some of the rights available within Actifio Desktop
services. ACLs are detailed in Actifio Desktop Access Control Levels (ACLs) on page 14.

Note: Assigning a right automatically assigns all subordinate rights.

You can assign specific rights to a role, which provides the proper privileges to use certain CLI commands. For
example, for the chhost command, which allows you to make changes to the attributes of a host, you must have the
'Host Manage' right to change the attributes of a host.
From the Actifio appliance CLI, you can use the following commands to assign specific rights to a user role:
• lsrights—Displays a concise list of all rights available with the Actifio appliance or the rights of a role.
• roleaddrights —Adds rights to a role.
• roledelrights—Deletes rights from a role

Actifio Desktop Access Control Levels (ACLs)

Rights Description

CLI Usage To use Actifio appliance Command-Line Interface.

Host Manage To create/modify/delete hosts, to add virtual machines, to restore, clone,

mount, unmount, and delete backup images.

Application Manage To create/modify/delete/view groups and consistency groups, to restore,

clone, mount, unmount, and delete backup images, to run an on-demand
backup, and to export templates.

Backup Manage To perform backup management operations such as Backup Now, Expire,
and Modify Expiration.

Clone Manage To create a cloned image.

LiveClone Manage To manage LiveClone images.

Mirroring Manage To perform Failover, Syncback, Cleanup, Failback, and Delete operations for a
Dedup-Async or StreamSnap replication image.

Restore Manage To restore an image.

Test-Failover To perform Test Failover and Delete Test Failover operations for a Dedup-
Async or StreamSnap replication image.

Mount Manage To Mount Image, Unmount Image, Re-Mount Image, and Delete Image.

Join Appliance To join two Actifio appliances for copy data replication.

14 Actifio CLI Reference | actifio.com |

 Actifio Desktop Access Control Levels (ACLs)

Rights Description

SLA Manage To create/modify/delete/view and assign policy templates and resource

profiles.

SLA Assign To assign pre-configured policy templates and resource profiles to

applications.

SLA View To view policy templates and resource profiles.

Storage Manage To add/remove/view storage and to add/remove/ view disk-pools.

Note: The Storage Manage ACL is not intended for use by the Actifio Sky appliance.

Storage View To view the storage and disk pool configuration.

System Manage To manage all Actifio appliance configuration, including users, roles, and
organization.

System View To view Actifio appliance configuration information.

Workflow Manage To add/remove/view workflows. A workflow can be scheduled or initiated on-demand.

Workflow Run To allow a user to run a workflow. This ACL right does not include the right for that
user to also manage a workflow. This level of permission is required in a Test/Dev
environment.

Workflow View To view scheduled workflows.

| actifio.com | Actifio CLI Reference 15

 Accessing the Command-Line Interface
The process to install and use an SSH client to access the Actifio appliance CLI includes:
1. Installing an SSH client on the host computer that you will use to access the Actifio appliance CLI. We
recommend that use PuTTY with the default installation options.
2. Generating an SSH public/private key pair on the host using either PuTTYgen or SSH-Keygen.
3. Uploading the SSH public key file to the Actifio appliance.
4. Configuring the SSH session on the host.

Note: An SSH public/private key pair must be generated on a per user basis to access the Actifio appliance CLI.

These tasks are outlined in the following sections.

Generating an SSH Public/Private Key Pair
You can generate an SSH public/private key pair by:
• Generating an SSH Public/Private Key Pair using PuTTYgen on page 16
• Generating an SSH Public/Private Key Pair using SSH-Keygen on page 18

Generating an SSH Public/Private Key Pair using PuTTYgen

PuTTYgen is a Windows utility that generates and manages public and private key pairs to encrypt/decrypt
communication with a trusted server.
To generate the key pair using PuTTYgen:
1. Select Start > Programs > PuTTY > PuTTYgen.

2. By default, SSH2 RSA from Parameters is selected. Leave the SSH2 RSA option unchanged.
3. Retain the default value of Number of bits in a generated key value as 2048.

16 Actifio CLI Reference | actifio.com |

 4. Click Generate.

5. Move the cursor over the blank area labeled Key to generate the keys. Continue to move the mouse pointer
over this blank area until the keys are generated. This action generates random characters to create a
unique public/private key pair.

6. Copy the entire generated public key listed under Key and paste it into a text editor such as Notepad.
Browse to an appropriate location and save the generated public key. This public key will be required when
adding CLI access for a user (see Uploading the SSH Public Key File to the Actifio Appliance on page 18).
7. From PuTTYgen, click Save private key. You are prompted with a warning message.

8. Click Yes to save the private key without a passphrase.

9. Click Save private key. The Save Private Key As window appears.
10. Browse to an appropriate location, enter a name for the private key, and click Save. The PuTTY Key
Generator saves the private key with the PPK extension.
11. Select File >Exit to quit the PuTTY Key Generator.

| actifio.com | Actifio CLI Reference 17

 Generating an SSH Public/Private Key Pair using SSH-Keygen
SSH-Keygen is a Unix/Linux utility that is used to generate and manage public/private key pairs, and encrypt/ decrypt
communication with a trusted server.
To generate the key pair using SSH-Keygen:
1. Enter the following command:
$ ssh-keygen –t rsa –b 2048
2. Enter a file name and location in response to the message:
Generating public/private rsa key pair. Enter file in which to save the key:

Note: By default, on Unix/Linux systems, public and private key files are created under $HOME/.ssh with
file names id_rsa and id_rsa.pub. You can assign a different name and location to the public and private key
files.

3. Press Enter to configure an empty passphrase in response to the following message:

Enter passphrase (empty for no passphrase): Enter same passphrase again:
The following message is displayed: 
Your identification has been saved in $HOME/.ssh/id-rsa. Your public key has been saved
in $HOME/.ssh/id_rsa.pub.

Uploading the SSH Public Key File to the Actifio Appliance

The public/private key pair identifies a single user uniquely. The Actifio Desktop administrator should enter one public
key for each user with CLI access.
1. Log into Actifio Desktop and open the Domain Manager.
2. In the navigation pane, select the user from Security > Users.

18 Actifio CLI Reference | actifio.com |

 3. Right-click the username and select Add CLI Access.
4. Open the saved public key file in a text editor.
5. Copy the public key and paste it into the text area titled Public Key.

Note: Be sure to copy the entire public key from the text editor. Do not include additional spaces.

6. Click Submit.
7. Validate the user has the correct role. If the user wants to use bash utilities such as cut and grep, then they
need to be Administrator. To modify a user’s role, refer to “Assigning Roles to a User” in Configuring
Resources and Settings With the Domain Manager in the Actifio Documentation Library.
8. Validate the user’s organization. To modify a user’s organization, refer to “Assigning Roles to a User” in
Configuring Resources and Settings With the Domain Manager in the Actifio Documentation Library.

| actifio.com | Actifio CLI Reference 19

 Configuring the SSH Session on the Host
Configure the PuTTY client on the host as outlined below to manage the client session.
1. Select Start > Programs > PuTTY > PuTTY to open the PuTTY Configuration window.
2. Click Session from the Category pane. The Basic options for your PuTTY session pane appears.

3. Select SSH as the Connection type.

4. Select Only on clean exit from Close window on exit to let the host display connection errors.
5. Click Connection > SSH from the Category pane. The Options controlling SSH connections pane
appears. Select 2 as the Preferred SSH protocol version.
6. Click Connection > SSH > Auth from the Category pane. The Options controlling SSH authentication
pane appears.

7. Click Browse or type the path or directory name of the SSH private key generated earlier.
8. Click Open to connect to the Actifio appliance using SSH.

20 Actifio CLI Reference | actifio.com |

 9. Click Window from the Category pane. By default PuTTY buffers 200 lines of output. For optimal viewing,
change the Lines of scrollback setting to a higher number.

10. Click Session from the Category pane. The Basic options for your PuTTY session pane appears.
11. In Host name (or IP address), enter the appropriate information to access the Actifio appliance
12. Type 22 in the Port field to specify the standard SSH port.

13. Click Save to store this information as a saved session for subsequent Actifio appliance CLI logins.

| actifio.com | Actifio CLI Reference 21

 14. At the login in as prompt, enter your Actifio appliance user name. An SSH session launches allowing you to
run CLI commands from the Actifio appliance CLI.

Starting an SSH Client Session in a Non-Interactive Environment

If required, SSH commands can be sent to be run instantly in a non-interactive session on one command line. To start
an SSH client session on the host:
1. Depending on the location of the private key, perform one of the following actions:
o If the saved private key is in the default directory, enter:
ssh [email protected]
o If the private key is saved in any location other than the default directory such as /tmp, enter:
ssh [email protected] -i /tmp/id_rsa
2. An SSH session with the user is started. You can send single shot commands using the SSH command,
such as:
ssh -i ~/.ssh/id_rsa [email protected] "udsinfo lsuser"

Identifying Actifio Appliance Software Version

To identify the software version of your Actifio appliance, use the udsinfo -V command.
$ udsinfo -V
7.0.0

22 Actifio CLI Reference | actifio.com |

3 User Management Commands

These commands are used for user management. The GUI interface for these commands can be found in the Actifio
Desktop of your Actifio appliance under the Security section of the Domain Manager. For detailed information about
Actifio appliance user management, refer to Setting Up Users and Roles With the Domain Manager in the Actifio
Documentation Library included with your Actifio appliance.
This chapter details the following user management commands:
chorg on page 24
chrole on page 25
chuser on page 26
configusercli on page 28
getauthservice on page 29
lsorg on page 30
lsorgresource on page 32
lsrights on page 34
chrole on page 25
lsuser on page 37
lsuserrole on page 39
mkorg on page 40
mkorgresource on page 41
mkrole on page 43
mkuser on page 44
mkuserrole on page 46
rmorg on page 47
rmorgresource on page 48
rmrole on page 49
rmuser on page 50
rmuserrole on page 51
roleaddrights on page 52
roledelrights on page 53

| actifio.com | Actifio CLI Reference 23

 chorg
The chorg command changes the attributes of an organization.

Rights
You must have the 'System Manage' right to change the attributes of an organization.

Syntax
>>- udstask -- -- chorg -- --+-------------------------------+-->
'- -description -- description -'
>--+-----------------+-- -- --+- org_name -+-------------------><
'- -name -- name -' '- org_id ---'

Parameter Description

-description description Optional. Specifies a description for the organization.

-name name Optional. Specifies a unique name for the organization, name must be
unique.

org_id | org_name Required. Specifies the organization object to modify, either by ID or by

name. Use udsinfo lsorg to retrieve organization information.

Description
Use this command to change the attributes of an organization object. Use udsinfo lsorg to obtain the ID or name of
the organization.

Example
$ udstask chorg -description 'sales org' org1

24 Actifio CLI Reference | actifio.com |

chrole
The chrole command changes the attributes of a role.

Rights
You must have the 'System Manage' right to change the attributes of a role.

Syntax
>>- udstask -- -- chrole -- --+-------------------------------+->
'- -description -- description -'
>--+-----------------+-- --+- role_name -+---------------------><
'- -name -- name -' '- role_id ---'

Parameter Description

-description description Optional. Specifies new description for the role.

-name name Optional. Specifies the new name for the role, which should be unique.

role_id | role_name Required. Specifies the role object to modify, either by ID or by name.

Description
Use this command to change the attributes of a role. Use udsinfo lsrole to obtain ID or name of the role.

Example
$ udstask chrole -description 'storage admin role' storageadmin

| actifio.com | Actifio CLI Reference 25

 chuser
The chuser command modifies the details of a user.

Rights
You must have the 'System Manage' right to modify the details of a user.

Syntax
>>- udstask -- -- chuser -- --+-------------------------+------->
'- -comments -- comments -'
>--+-------------------+-- --+---------------------------+------>
'- -email -- email -' '- -firstname -- firstname -'
>--+-------------------------+-- --+-----------------+---------->
'- -lastname -- lastname -' '- -name -- name -'
>--+-------------------------+-- --+-------------------------+-->
'- -password -- password -' '- -timezone -- timezone -'
>--+-------------------------+-- --+-------------------------+-->
'- -denylogin --+- true --+-'
'- false -'
>--+- user_name -+---------------------------------------------><
'- user_id ---'

Parameter Description

-comments comments Optional. Specifies a comment.

-email email Optional. Specifies an email address.

-firstname firstname Optional. Specifies the first name.

-lastname lastname Optional. Specifies the last name.

-name name Optional. Specifies a unique name for the user.

-password password Optional. Specifies a password.

-timezone timezone Optional. Specifies a timezone.

26 Actifio CLI Reference | actifio.com |

 Parameter Description

-denylogin true | false Optional. Specifies the Actifio Desktop UI login access for a user. Options
include:
• false -This user will be allowed to login and access the Actifio CDS
or Sky Desktop. This is the default state for the udstask chuser
command.
• true - This user will be restricted from being able to login and
access the Actifio CDS or Sky Desktop. An error message appears
when this user attempts to login to the Actifio Desktop of an
appliance.

Note: We strongly recommend that you do not restrict user access to the
Actifio Desktop unless instructed to do so under the guidance of an Actifio
Support representative.

user_id | user_name Required. Specifies the ID or name of the user whose details should be
modified.

Description
Use this command to modify the details of a user. Use the udsinfo lsuser command to obtain the ID or name of the
user.

Example
$ udstask chuser -email [email protected] user1

| actifio.com | Actifio CLI Reference 27

 configusercli
The configusercli command allows or disallows user access to the command-line interface (CLI) in the Actifio
appliance.

Rights
You must have the 'System Manage' right to allow a user to access the CLI.

Syntax
>>- udstask -- -- configusercli -- ----------------------------->

>--+-----------+-- -- -keyfile -- -keyfile -- ------------------>

'- -disable '

>-- username -- username ---------------------------------------><

Parameter Description

-disable Optional. Disables the CLI access for a user.

-keyfile keyfile Required. Specifies the file path to the SSH public key.

-username username Required. Specifies the user name for whom the CLI access should be
enabled or disabled.

Description
Use this command to enable or disable CLI access for a user. Accessing the CLI on the Actifo appliance requires
authentication and authorization using an SSH key. For detailed information, see Chapter 2, Accessing the Actifio
Appliance CLI.

Example
$ udstask configusercli -username foo -keyfile /tmp/foo.pub

28 Actifio CLI Reference | actifio.com |

getauthservice
The getauthservice command returns the authentication service currently in use.

Rights
User with 'System View' right is allowed to see the service in use. Only user with 'System Manage' right can change
the authentication service.

Syntax
>>- udsinfo -- -- getauthservice -- ---------------------------->

Description
Use this command to retrieve the name of the authentication service in use. The value will be either 'database' or
'ldap'.

Example
$ udsinfo getauthservice
database

| actifio.com | Actifio CLI Reference 29

 lsorg
The lsorg command displays a concise list of organizations or the detailed view of an organization.

Rights
You must have the 'System View' or 'System Manage' right to use this command.

Syntax
>>- udsinfo -- -- lsorg -- ------------------------------------->

>--+--------------------------------+-- --+----------+-- ------->

'- -filtervalue -- attrib=value -' '- -nohdr -'

>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+
'- object_name -'

Parameter Description

-delim delimiter Optional. By default, all columns of data are separated by a tab in the concise
view. In the detailed view, each column of data is displayed in a separate row
and if the headers are displayed, the header is separated from the data by a
space. The - delim parameter overrides this behavior.
Valid input for the -delim parameter is a one- byte character. To display the
data, recommended delimiter to use is comma (',') for list view, and equal ('=')
for detail view.

-filtervalue attrib=value Optional. Specifies that you want your report to display any or the entire list of
valid filter attributes. The valid filter attribute for the udsinfo lsorg command
is: name.
A filter is formed with an attribute and a value. When you specify more than
one filter, they must be combined with the ampersand (&) character. When
specified, this character should be preceded by a backward slash '\').
For string type of filters, the only operator allowed is '='. You can also use wild
card character '*'.
For example, to list organizations with a name that begins with 'foo', use '-
filtervalue name=foo*'.

-nohdr Optional. By default, titles are displayed for each column of data in a concise
style view, and for each item of data in the detailed view. The -nohdr
parameter suppresses the display of headings. If there is no data to display,
headings are not displayed.

object_id | object_name Optional. Specifies the name or ID of an object. When you use this parameter,
a detailed view of the object is returned and any value specified by the 
-filtervalue parameter is ignored. If you do not specify the ID or name, a
concise view of all objects matching the filter criteria is displayed.

30 Actifio CLI Reference | actifio.com |

Description
Use this command to retrieve the details of organizations. There are two reserved organizations, 'all', which includes
all objects within the system; and 'public', which includes objects that is viewable by everyone. The 'all', and 'public'
organizations cannot be deleted, nor modified.

Example
$ udsinfo lsorg
id modifydate description name createdate
3 2010-08-13 00:45:47.868 All Organization all 2010-08-11 04:16:34.000
13170 2010-08-13 00:45:09.526 sales org sales_org 2010-08-13 00:43:19.146

| actifio.com | Actifio CLI Reference 31

 lsorgresource
The lsorgresource command displays a concise list of an organization and resource mappings or the detailed view of
an organization-to-resource mapping.

Rights
You must have the 'System View' or 'System Manage' right to use this command.

Syntax
>>- udsinfo -- -- lsorgresource -- ----------------------------->

>--+--------------------------------+-- --+----------+-- ------->

'- -filtervalue -- attrib=value -' '- -nohdr -'

>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' '- object_id ---'

Parameter Description

-delim delimiter Optional. By default, all columns of data are separated by a tab in the concise
view. In the detailed view, each column of data is displayed in a separate row
and if the headers are displayed, the header is separated from the data by a
space. The - delim parameter overrides this behavior.
Valid input for the -delim parameter is a one-byte character. To display the data,
recommended delimiter to use is comma (',') for list view, and equal ('=') for
detail view.

-filtervalue attrib=value Optional. Specifies that you want your report to display any or the entire list of
valid filter attributes. The valid filter attributes for the udsinfo lsorgrsource
command are:
• orgid
• resourceid
• typecode [ app | host | org | slp | slt | user ]
The filter is formed with an attribute and a value. When you specify more than
one filter, they must be combined with '&' character (which should be escaped
with '\'). Some filters allow only predefined constants. For example, typecode
allows only app, host, org, slp, slt, user, to match typecode for app, use 
'-filtervalue typecode=app'.

-nohdr Optional. By default, headings are displayed for each column of data in the
concise view, and for each item of data in the detailed view. The -nohdr
parameter suppresses the display of headings. If there is no data to display,
headings are not displayed.

object_id Optional. Specifies the ID of an object. When you use this parameter, a
detailed view of the object is returned and any value specified by the 
-filtervalue parameter is ignored. If you do not specify the object_id parameter,
a concise view of all objects matching the filter criteria is displayed.

32 Actifio CLI Reference | actifio.com |

Description
Use this command to retrieve the details of resource-to-organization mappings.
User has to have 'System Manage', or 'System View' right to display the mappings.

Example
$ udsinfo lsorgresource
id typecode orgid resourceid
4097 user 3 4096
11502 user 3 11501

| actifio.com | Actifio CLI Reference 33

 lsrights
The lsrights command displays a concise list of all rights available with the Actifio appliance or the rights of a role.

Rights
You must have the 'System View' or 'System Manage' right to use this command.

Syntax
>>- udsinfo -- -- lsrights -- ---------------------------------->

>--+-----------------------------+-----------------------------><
'- -role --+- role_name -+-- -'
'- role_id ---+

Parameter Description

-role role_name | role_id Optional. Specifies the role name or role ID. When you use this parameter, the
rights of the role are listed. Use udsinfo lsuserrole to locate the ID or name of
the role.

Description
Use this command to retrieve the details of all rights available with the Actifio appliance or the rights of a role.

Example
$ udsinfo lsrights -role myrole
Access Application Manager
Application Manage

34 Actifio CLI Reference | actifio.com |

lsrole
The lsrole command displays a concise list of roles or a detailed view of a role.

Rights
You must have the 'System View' or 'System Manage' right to use this command.

Syntax
>>- udsinfo -- -- lsrole -- ------------------------------------>

>--+--------------------------------+-- --+----------+-- ------->

'- -filtervalue -- attrib=value -' '- -nohdr -'

>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+
'- object_name -'

Parameter Description

-delim delimiter Optional. By default, all columns of data are separated by a tab in the concise
view. In the detailed view, each column of data is displayed in a separate row
and if the headers are displayed, the header is separated from the data by a
space. The - delim parameter overrides this behavior.
Valid input for the -delim parameter is a one- byte character. To display the
data, recommended delimiter to use is comma (',') for list view, and equal ('=')
for detail view.

-filtervalue attrib=value Optional. Specifies that you want your report to display any or the entire list of
valid filter attributes. The valid filter attribute for the udsinfo lsrole command
is: name
For string type of filters, the only operator allowed is '='. You can also use the
wild card character '*'. For example, to match roles with name begins with
'foo', use '-filtervalue name=foo*'.

-nohdr Optional. By default, headings are displayed for each column of data in the
concise view, and for each item of data in the detailed view. The -nohdr
parameter suppresses the display of headings. If there is no data to display,
headings are not displayed.

object_id | object_name Optional. Specifies the name or ID of an object. When you use this parameter,
a detailed view of the object is returned and any value specified by the 
-filtervalue parameter is ignored. If you do not specify the object_id or the
object_name parameter, a concise view of all objects matching the filter
criteria is displayed.

| actifio.com | Actifio CLI Reference 35

 Description
Use this command to retrieve the details of roles. A role is made up of one or more rights. The reserved role
'administrator' has all privileges. The 'administrator' role cannot be deleted or modified. To retrieve the role rights use
the udsinfo lsrights command.

Example
# udsinfo lsrole
id description name
2 System Administrator role administrator
4 Basic role Basic
Compliance Admin role Compliance Admin
Storage Admin role Storage Admin
Backup Admin role Backup Admin
App Admin role App Admin

36 Actifio CLI Reference | actifio.com |

lsuser
The lsuser command displays a concise list of users or a detailed view of a user.

Rights
You must have the 'System View' or 'System Manage' right to use this command.

Syntax
>>- udsinfo -- -- lsuser -- ------------------------------------>

>--+--------------------------------+-- --+----------+-- ------->

'- -filtervalue -- attrib=value -' '- -nohdr -'

>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+
'- object_name -'

Parameter Description

-delim delimiter Optional. By default, all columns of data are separated by a tab in the concise view.
In the detailed view, each column of data is displayed in a separate row and if the
headers are displayed, the header is separated from the data by a space. The -
delim parameter overrides this behavior.
Valid input for the -delim parameter is a one- byte character. To display the data,
recommended delimiter to use is comma (',') for list view, and equal ('=') for detail
view.

-filtervalue attrib=value Optional. Specifies that you want your report to display any or the entire list of valid
filter attributes. The valid filter attributes for the udsinfo lsuser command are:
• comments
• clienabled [true | false]
• email
• firstname
• isprotected [true | false]
• lastname
• name
• timezone
The filter is formed with an attribute and a value. When you specify more than one
filter, they must be combined with '&' character (which should be escaped with '\').
For example, to match users with the username that begins with 'foo', use 
'- filtervalue username=foo* '

| actifio.com | Actifio CLI Reference 37

 Parameter Description

-nohdr Optional. By default, a title is displayed for each column of data in a concise style
view, and for each item of data in the detailed view. The -nohdr parameter
suppresses the display of headings. If there is no data to display, headings are not
displayed.

object_id | Optional. Specifies the name or ID of an object. When you use this, a detailed
object_name view of the object is returned and any value specified by the -filtervalue parameter
is ignored. If you do not specify the ID or name, a concise view of all objects
matching the filter criteria is displayed.

Description
Use this command to retrieve details of users. There is a reserved user,' admin', which has the full privilege.The
'admin' user cannot be deleted, the name also cannot be modified.

Example
$ udsinfo lsuser
id clienabled lastname firstname timezone externalid email name isprotecteomments
1 false Admin Systemadmin true admin
11501 true User New US/Eastern rpsan false

38 Actifio CLI Reference | actifio.com |

lsuserrole
The lsuserrole command displays a concise list of user-to-role mappings or a detailed view of a user-to-role mapping.

Rights
You must have the 'System View' right is to see all role mappings. Only user with 'System Manage' right can create or
delete the mappings.

Syntax
>>- udsinfo -- -- lsuserrole -- -------------------------------->
>--+----------+-- --+-----------------------+-- ---------------->
'- -nohdr -' '- -delim -- delimiter -'
>--+---------------+-------------------------------------------><
'- user_id ---'

Parameter Description

-delim delimiter Optional. By default, all columns of data are separated by a tab in the concise
view. In the detailed view, each column of data is displayed in a separate row
and if the headers are displayed, the header is separated from the data by a
space. The - delim parameter overrides this behavior.
Valid input for the -delim parameter is a one- byte character. To display the
data, recommended delimiter to use is comma (',') for list view, and equal ('=')
for detail view.

-nohdr Optional. By default, headings are displayed for each column of data in the
concise view, and for each item of data in the detailed view. The -nohdr
parameter suppresses the display of headings. If there is no data to display,
headings are not displayed.

user_id Optional. Specifies the userid of an object. When you use this parameter, a
detailed view of the object is returned and any value that is specified by the -
filter-value parameter is ignored. If you do not specify the ID, a concise view
of all objects matching the filter criteria is displayed.

Description
Use this command to retrieve the details of user-to-role mappings.

Example
$ udsinfo lsuserrole
id username rolename roleid rights userid
1024 foo Basic 4 Access Domain Manager,Access Application
Manager,CLI Usage11501

| actifio.com | Actifio CLI Reference 39

 mkorg
The mkorg command creates a new organization object. An organization determines a user's access to organizational
resources. An organization is effective after organizational resources are added to the organization.

Rights
You must have the 'System Manage' right to create an organization.

Syntax
>>- udstask -- -- mkorg -- --+-------------------------------+-->
'- -description -- description -'

>-- -name -- name -------- --+-----------------------+---------><

'- -org -+- org_id ---+-'
'- org_name -'

Parameter Description

-description description Optional. Describes the organization.

-name name Required. Specifies a name for the organization. The name should be unique.

-org org_id | org_name Optional. Specifies the a default organization in which the organization should
be added to after creation. Use udsinfo lsorg to retrieve organization
information.

Note: To use this option user needs to have 'System Manage' right.

Description
Use this command to create a new organization object.

Example
$ udstask mkorg -name 'org1'

40 Actifio CLI Reference | actifio.com |

mkorgresource
The mkorgresource command adds a resource to an organization.

Rights
You must have the 'System Manage' right to add a resource to an organization.

Syntax
>>- udstask -- -- mkorgresource -- -------------------------->
>-- -org --+- org_name -+-- -- -resources -- resource_list -->
'- org_id ---'
>-- -type --+- user -----+----------------------------------><
+- app ------+
+- diskpool -+
+- host -----+
+- slt ------+
+- slp ------+
+- org ------+
+- cluster --+
'- group ----'

Parameter Description

-org Required. Specifies the ID or name of the organization. Use

org_id | org_name udsinfo lsorg to retrieve organization information.

-resources Required. Specifies the resource names or IDs to add to the

resource_list organization. If there is more than one resource, they should
be separated by a comma (','). Use the udsinfo lsorgresource
command to locate the ID or name of the organization
resource by displaying a list of organization-to-resource
mappings.

-type Required. Specifies the type of resource to be added to an

user | app | diskpool | host | slt | slp | org | organization.
cluster | group
Note: For information on adding an Actifio appliance to an
organization through specification of -type cluster to define
multi-tenancy access, see the Enabling Multi-Tenancy with
Actifio Organizations Tech Brief included in the Actifio
Documentation Library.

| actifio.com | Actifio CLI Reference 41

 Description
Use this command to add a resource to an organization. An organization consists of resources and users. It allows the
member users to access all its resources. An organization can contain one or more organizations as its members.

Example
$ udstask mkorgresource -org eng -resources 4111 -type host

42 Actifio CLI Reference | actifio.com |

mkrole
The mkrole command creates a new role object.

Rights
You must have the 'System Manage' right to create a role.

Syntax
>>- udstask -- -- mkrole -- --+------------------------+-------->
'- -description -- desc -'

>---- -name -- role_name --------------------------------------><

Parameter Description

-description desc Optional. Specifies a description for the role.

-name role_name Required. Specifies a name. The role name should be unique within the
Actifio appliance.

Description
Use this command to create a new role object.

Example
$ udstask mkrole -name myrole

| actifio.com | Actifio CLI Reference 43

 mkuser
The mkuser command creates a user.

Rights
You must have the 'System Manage' right to create a user.

Syntax
>>- udstask -- -- mkuser -- --+-------------------------+--->
'- -comments -- comments -'
>--+------------------------+-- --+----------------------+-->
'- -email -- email_addr -' '- -firstname -- name -'
>--+---------------------+-- -- -name -- user_name --------->
'- -lastname -- name -'
>--+-----------------------+-- -- -password -- password ---->
'- -org -+- org_id ---+-'
'- org_name -'
>--+-------------------------+------------------------------>
'- -timezone -- timezone -'
>--+-------------------------+-- --+---------------------+--><
'- -denylogin --+- true --+-'
'- false -'

Parameter Description

-comments comments Optional. Specifies the comments for the user.

-email email Optional. Specifies an email address for the user.

-firstname firstname Optional. Specifies the first name.

-lastname lastname Optional. Specifies the last name.

-name user_name Required. Specifies the name of the user, which should be unique within
Actifio appliance.

-org org_id | org_name Optional. Specifies a default organization that the user should be added to
after creation. Use udsinfo lsorg to retrieve organization information.

Note: To use this option user needs to have 'System Manage' right.

-password password Required. Specifies the password for the user.

-timezone timezone Optional. Specifies a time zone.

44 Actifio CLI Reference | actifio.com |

 Parameter Description

-denylogin true | false Optional. Specifies the Actifio Desktop UI login access for a user. Options
include:
• false -This user will be allowed to login and access the Actifio CDS
or Sky Desktop. This is the default state for the udstask mkuser
command.
• true - This user will be restricted from being able to login and
access the Actifio CDS or Sky Desktop. An error message appears
when this user attempts to login to the Actifio Desktop of an
appliance.

Note: We strongly recommend that you do not restrict user access to the
Actifio Desktop unless instructed to do so under the guidance of an Actifio
Support representative.

Description
Use this command to create a new user.

Example
$ udstask mkuser -name john -password testpassword -email [email protected]

| actifio.com | Actifio CLI Reference 45

 mkuserrole
The mkuserrole command assigns a role to a user.

Rights
You must have the 'System Manage' right to assign a role to a user.

Syntax
>>- udstask -- -- mkuserrole -- ---- -roleid -- role_id -------->

>---- -userid -- user_id --------------------------------------><

Parameter Description

-roleid role_id Required. Specifies the role ID to be assigned to a user.

-userid user_id Required. Specifies the user ID that the role will be assigned to.

Description
Use this command to add a role to the user.

Example
$ udstask mkuserrole -roleid 1020 -userid 1000

46 Actifio CLI Reference | actifio.com |

rmorg
The rmorg command deletes an organization.

Rights
You must have the 'System Manage right to delete an organization.

Syntax
>>- udstask -- -- rmorg -- --+- org_name -+--------------------><
'- org_id ---'

Parameter Description

org_id | org_name Required. Specifies the ID or name of the organization to be deleted. Use the
udsinfo lsorg command to locate the ID or name of the organization.

Description
Use this command to delete an organization.

Example
$ udstask rmorg org1

| actifio.com | Actifio CLI Reference 47

 rmorgresource
The rmorgresource command deletes a resource from an organization.

Rights
You must have the “System Manage” right to delete a resource-to-organization mapping.

Syntax
>>- udstask -- -- rmorgresource -- -- orgresource_id ----------><

Parameter Description

orgresource_id Required. Specifies the ID of the resource-to-organization mapping. Use the

udsinfo lsorgresource command to locate the ID or name of the organization
resource.

Description
Use this command to delete a resource from an organization.

Example
$ udstask rmorgresource 4111

48 Actifio CLI Reference | actifio.com |

rmrole
The rmrole command deletes a role.

Rights
You must have the "System Manage" right to delete a role.

Syntax
>>- udstask -- -- rmrole -- --+- role_name -+------------------><
'- role_id ---'

Parameter Description

role_id | role_name Required. Specifies the ID or name of the role to be removed. Use udsinfo
lsrole to locate the ID or name of the role.

Description
Use this command to delete a role.

Example
$ udstask rmrole role1

| actifio.com | Actifio CLI Reference 49

 rmuser
The rmuser command deletes a user.

Rights
You must have the "System Manage" right to delete a user.

Syntax
>>- udstask -- -- rmuser -- --+- user_name -+------------------><
'- user_id ---'

Parameter Description

user_id | user_name Required. Specifies the ID or name of the user to be removed. Use udsinfo
lsuser to locate the ID or name of the user.

Description
Use this command to delete a user.

Example
$ udstask rmuser foo

50 Actifio CLI Reference | actifio.com |

rmuserrole
The rmuserrole command deletes a user-to-role mapping.

Rights
You must have the 'System Manage' right to delete a user-to-role mapping.

Syntax
>>- udstask -- -- rmuserrole -- -- userrole_id ----------------><

Parameter Description

userrole_id Required. Specifies the ID of the user-to-role mapping to be deleted.

Description
Use this command to delete a user-to-role mapping. The user-to-role mapping ID can be obtained using the udsinfo
lsuserrole command.

Example
$ udstask rmuserrole 1002

| actifio.com | Actifio CLI Reference 51

 roleaddrights
The roleaddrights command adds rights to a role.

Rights
You must have the 'System Manage' right to add rights to a role.

Syntax
>>- udstask -- -- roleaddrights -- -+- -role -- role_name -+---->
'- -role -- role_id ---'
>--+- -rights -- rights -+-------------------------------------><

Parameter Description

-role Required. Specifies the ID or name of the role to add rights to.
role_name | role_id

-rights rights Required. Specifies the rights to be added. The list should be colon-separated
if more than one right is specified.

Description
Use this command to add rights to a role. The user-to-role mapping ID can be obtained using the udsinfo lsuserrole
command.

Example
$ udstask roleaddrights -role role1 -rights "Host View:Host Manage"

52 Actifio CLI Reference | actifio.com |

roledelrights
The roledelrights command deletes rights from a role.

Rights
You must have the 'System Manage' right to delete rights from a role.

Syntax
>>- udstask -- -- roledelrights -- -+- -role -- role_name -+---->
'- -role -- role_id ---'
>--+- -rights -- rights -+-------------------------------------><

Parameter Description

-role role_name | role_id Required. Specifies the ID or name of the role to delete the rights from.

-rights rights Required. Specifies the rights to be deleted. The list should be colon-separated
if more than one right is specified.

Description
Use this command to delete rights from a role.

Example
$ udstask roledelrights -role role1 -rights "Host View:Host Manage"

| actifio.com | Actifio CLI Reference 53

54 Actifio CLI Reference | actifio.com |
4 Host and Appliance
Management Commands

These commands are used for managing hosts and appliances. The GUI interface for these commands can be found
in the Actifio Desktop of your Actifio appliance under the Security section of the Domain Manager. For detailed
information, refer to Configuring Resources and Settings With the Domain Manager and Connecting Hosts to
Actifio Appliances in the Actifio Documentation Library included with your Actifio appliance.

Managing Hosts—These commands are used to manage hosts:

addroutehost on page 57 lshost on page 82

chhost on page 58 lsnasshare on page 85
chproxyhost on page 62 lsldapserver on page 86
chldapserver on page 64 lsldapgroup on page 87
configdefaultdomain on page 66 lsldapgrouprole on page 89
configipfailover on page 67 lsldapgrouporg on page 90
lsipfailover on page 68 mkldapgroup on page 91
configdnsserver on page 69 mkldapgrouprole on page 92
getautodiscovery on page 70 mkhost on page 94
iscsitest on page 71 mkldapserver on page 98
ivmdiscovery on page 73 removeroutefromhost on page 99
listrouteonhost on page 75 rmhost on page 100
listrouteonhost on page 75 rmldapserver on page 101
lsssd on page 78 rmldapgroup on page 102
lsdefaultdomain on page 80 rmldapgrouporg on page 103
lsdnsserver on page 81 rmldapgrouprole on page 104
setautodiscovery on page 105
testldapserver on page 106

| actifio.com | Actifio CLI Reference 55

 Managing Pools—These commands are used to manage storage
pools:

chauthservice on page 107 mkdiskpool on page 117

chdiskpool on page 108 mkslp on page 119
chslp on page 110 rmdiskpool on page 121
configresourcewarning on page 111 rmslp on page 122
getresourcewarning on page 112
lsdiskpool on page 113
lsslp on page 115

Managing Appliances—These commands are used to manage and

bridge Actifio appliances:

addcluster on page 123 lsjob on page 154

addssd on page 124 lsjobhistory on page 158
certexchange on page 125 rmcluster on page 162
chappcluster on page 177 setarchiveconfig on page 163
chjob on page 126 setgcschedule on page 165
chcluster on page 127 setnodeip on page 167
configssl on page 130 setparameter on page 168
getparameter on page 131 setschedule on page 169
getgcschedule on page 132 synccluster on page 171
getschedule on page 133 rmgcschedule on page 172
getsysteminfo on page 134 lsappcluster on page 173
installtrustedcertificate on page 135 lsclustermember on page 175
joincluster on page 136 rmappcluster on page 178
lsaudit on page 137 rmclustermember on page 179
lscluster on page 140
lsdeduppoolstat on page 142
lsdedupefficiency on page 145
lsdedupstat on page 146
lsdiskpoolstat on page 149
lssnappoolstat on page 151

56 Actifio CLI Reference | actifio.com |

addroutehost
The addroutehost command adds a network route to a host to route traffic over a specified interface.

Rights
You must have the 'Host Manage' right to add a network route to a host.

Syntax
>>- udstask -- -- addroutetohost -- ---------------------------------------------------->
>---+-------------------+-- -- --+-----------------------+-- --------------------------->
'- -route -- route -' '- -gateway -- gateway -'
>--+--------------------------+-- -- --+-----------+-- --------------------------------><
'- interface -- interface -' '- host_id -'

Parameter Description

-route route Required. The route to apply to the host. it can be a single IP address or a network
range in CIDR notation.

-gateway gateway Required. The gateway to use for this route.

-interface interface Required. The network interface on the host to which this routing should apply.

host_id Required. The host to which this route should be applied.

Description
This command will return an error if the host with the provided host ID is not a Proxy Host (BDD).
Use this command to direct network traffic over a specific interface on a host. You may want to do this based on your
network configurations and different network hardware on your host.
This command will connect to the host and update its routing table based on the given parameters.

Note: Changing network routing can have significant consequences including loss of connectivity so be sure you
understand the consequences before making changes to the host's routing tables.

Example
Adding a route to a single IP address:
$ udstask addroutetohost -route 192.168.1.150 -gateway 192.168.1.1 -interface eth2 10001
Adding a route to a network range using CIDR notation:
$ udstask addroutetohost -route 192.168.0.0/24 -gateway 192.168.1.1 -interface eth2 10001

| actifio.com | Actifio CLI Reference 57

 chhost
The chhost command changes the attributes of a host.

Rights
You must have the 'Host Manage' right to change the attributes of a host.

Syntax
>>- udstask -- -- chhost -- -+----------------------+----------->
'- -alternateip -- ip -'

>--+------------------------------+-- --+-------------------+--->
'- -chapsecret -- chap_secret -' '- -clearconnector -'

>--+-----------------+-- --+------------------------+-- -------->

'- -dataip -- ip -' '- -description -- desc -'

>--+-------------------------------------+-- ------------------->
'- -dbauthentication --+- true --+-- -'
'- false -'

>--+---------------------------------+-- ----------------------->
'- -friendlypath -- friendlypath -'

>--+--------------------------+-- --+--------------------+-- --->

'- -hostname -- host_name -' '- -ipaddress -- ip -'

>--+-----------------------+-- --+----------------------------+->
'- -iscsiname -- iscsi -' '- -mask -- port_login_mask -'

>--+-----------------------+-- --+-----------------+-- --------->

'- -maxjobs -- maxjobs -' '- -nochapsecret -'

>--+-------------------------+-- --+-----------------+-- ------->

'- -password -- password -' '- -port -- port -'

>--+---------------------------------------------+-- ----------->
> '- -properties --+- guestvmiscsi:true ---+-- -'
> '- guestvmiscsi:false --'

58 Actifio CLI Reference | actifio.com |

>--+--------------------+-- --+---------------------------+-- -->
'- -svcname -- name -' '- -type --+- asm -----+-- -'
+- generic -+
+- hmc -----+
+- hpux ----+
+- hyperv --+
+- isilon --+
+- netapp --+
+- openvms -+
+- tpgs ----+
'- vcenter -'

>--+--------------------------------+--------------------------->
'- -blockcbt --+- enabled --+-- -'
+- disabled -+

>--+---------------------+-- -- -- host_id --------------------><

'- -username -- name -'

Parameter Description

-alternateip ip Optional. Specifies the new alternate IP address of the host.

-chapsecret chap_secret Optional. Sets the Challenge Handshake Authentication Protocol (CHAP)
secret used to authenticate the host for iSCSI I/O. The CHAP secret is
shared between the host and the appliance.

-clearconnector Optional. Clears udsagent information for the host if the connector has
been already un-installed from the host. Use it cautiously.

-dataip ip Optional. Specifies an IP address to access data from an ESX host.

-dbauthentication true | false Optional. Specifies whether Oracle database running on this host should
be using DB Authentication or Host authentication.

-description desc Optional. Specifies a description of the host.

-friendlypath friendlypath Optional. Specifies a new friendly name for the host. Change of friendly
path of a VM is not allowed.

| actifio.com | Actifio CLI Reference 59

 Parameter Description

-hostname host_name Optional. Specifies the name of the host.

-ipaddress ip Optional. Specifies an IP address of the host.

-iscsiname iscsi Optional. Specifies the comma-separated list of iSCSI names to add to
the host.

-mask port_login_mask Optional. Specifies the node ports that the host can access.
The port mask has four binary bits and is made up of a combination of
zeros and ones, where 0 indicates that the corresponding target port
cannot be used and 1 indicates that it can be used. The right-most bit in
the mask corresponds to the lowest numbered target port on a node.
Valid mask values range from 0000 (no ports enabled) to 1111 (all ports
enabled). For example, a mask of 0011 enables port 1 and port 2. The
default value is 1111 (all ports enabled).

-maxjobs maxjobs Optional. Maximum number of jobs allowed, 0 to use system default.

-nochapsecret Optional. Clears any previously set CHAP secret for the host.

-password password Optional. Specifies the password to start the Actifio Connector running
on the host.

-properties guestvmiscsi:true | Optional. Enables/disables various properties of the host.

guestvmiscsi:false
• guestvmiscsi:true maps a LUN directly to VM directly, instead
of through the hypervisor host.
• guestvmiscsi:false disables mapping of the LUN to the VM.

-port port Optional. Specifies a port for the Actifio Connector running on the host.

-svcname name Optional. Specifies the SVC host name. The name should not exceed 15
characters The first character should not be a number. The name should
not contain the space (' ') or period ('.') characters.

Note: The -svcname parameter is not supported for Actifio Sky

appliances.

-type Optional. Specifies new type for the host, which replaces existing host
asm | generic | hmc | hpux | type(s). A host can be of more than one type, one of generic/tpgs/hpux/
isilon | netapp | openvms | tpgs openmvs, and one of vCenter. Separate the two types with a colon, ':', if
| vcenter the host is of more than one type.

Note: The hpux, openvms, and tpgs types are not supported for
Actifio Sky appliances.

60 Actifio CLI Reference | actifio.com |

 Parameter Description

-username name Optional. Specifies the user name to start the Connector running on the
host.

-blockcbt enabled | disabled Optional. Activates/deactivates CBT tracking for the application connector
of a Linux host

host_id Required. Specifies the ID of the host to be modified. Use the udsinfo
lshost command to retrieve the ID.

Description
Use this command to modify the attributes of a host.

Example
$ udstask chhost -ipaddress 192.168.0.12 4111

| actifio.com | Actifio CLI Reference 61

 chproxyhost
The chproxyhost command is used to configure the proxy host server.

Rights
You must have the 'Host Manage' right to configure a proxy host server.

Syntax
>>- udstask -- -- chproxyhost -- ----------------------------------->
>--+---------------------+-- --+---------------+-- ----------------->
'- -domain -- domain -' '- -joindomain -'
>--+----------------+-- --+--------------------+-- ----------------->
'- -leavedomain -' '- username -- user -'
>--+-------------------------+-- --+-----------------+-- ----------->
'- -password -- password -' '- port3ip -- ip -'
>--+-------------------------+-- --+-------------------+-- --------->
'- -port3netmask -- mask -' '- port3mtu -- mtu -'
>--+------------------+-- --+-------------------------+-- ---------->
'- -port4ip -- ip -' '- -port4netmask -- mask -'
>--+--------------------+-- --+- host_name --+-- ------------------->
'- -port4mtu -- mtu -' '- host_id ----'

Parameter Description

-domain domain Optional. Specifies the name of the domain to be joined. Required when
the -joindomain option is specified.

-joindomain Optional. If specified, adds the membership to an ADS or NT Domain.

KDC details are automatically determined by the ads net lookup
command.

-leavedomain Optional. If specified, removes the membership from an ADS or NT

Domain.

-username user Optional. Specifies the user name to authenticate to join/leave an ADS or
NT Domain. Required when either the -joindomain or -leavedomain
option is specified.

-password password Optional. Specifies the password of the user to authenticate to join/leave
an ADS or NT domain. Required when either the -joindomain or 
-leavedomain option is specified.

-port3ip ip Optional. Specifies the IP address for the port 3 interface.

-port3netmask mask Optional. Specifies the netmask for the port 3 interface.

62 Actifio CLI Reference | actifio.com |

 Parameter Description

-port3mtu mtu Optional. Specifies the MTU value for the port 3 interface. Setting an
incorrect MTU value can result in serious networking issues. If -port3ip
and -port3netmask are not being set and are not currently set, trying to
set -port3mtu will result in an error. Setting the value to an empty string
("") will remove an existing MTU setting.

-port4ip ip Optional. Specifies the IP address for the port 4 interface.

-port4netmask mask Optional. Specifies the netmask for the port 4 interface.

-port4mtu mtu Optional. Specifies the MTU value for the port 4 interface. Setting an
incorrect MTU value can result in serious networking issues. If -port4ip
and -port4netmask are not being set and are not currently set, trying to
set -port4mtu will result in an error. Setting the value to an empty string
("") will remove an existing MTU setting.

host_id | host_name Required. Specifies the object id or name of the proxy host. To see the
proxy host server details refer to udsinfo lshost command.

Description
Use this command to change the configuration of a proxy host server. It allows a proxy host server to:
• Join an ADS or NT Domain membership.
• Leave from an ADS or NT Domain membership.

Example
Joining an ADS domain:
$ udstask chproxyhost -joindomain -domain example.actifio.com
-username Administrator -password password 38660
Leaving an ADS domain:
$ udstask chproxyhost -leavedomain -username Administrator -password password 38660
Setting port3:
$ udstask chproxyhost -port3ip 192.168.1.1 -port3netmask 255.255.255.0 -port3mt
Removing the MTU from port3:
$ udstask chproxyhost -port3mtu "" 38660

| actifio.com | Actifio CLI Reference 63

 chldapserver
The chldapserver command changes the configuration of an LDAP server.

Rights
User must have 'System Manage' right to configure an LDAP server.

Syntax
>>- udstask -- -- chldapserver -- --+---------------------+----->
'- -basedn -- basedn -'
>--+-------------------------+-- --+--------------------+-- ---->
'- fallback --+- true --+-' '- -ip -- ipaddress -'
'- false -'
>--+-------------------------------+---------------------------->
'- -lookuppassword -- password -'
>--+-----------------------+-- --+-----------------+-- --------->
'- -lookupuser -- user -' '- -port -- port -'
>--+---------------------+-- --+-------------------------+-- --->
'- -ssl --+- true --+-' '- -uniqueidname -- name -'
'- false -'
>--+-------------------------------+---------------------------><
'- -userattribute -- attribute -'

Parameter Description

-basedn basedn Optional. Specifies the basedn for the LDAP lookups.

-fallback Optional. When set, cached credentials will be used if the LDAP server is
true | false unavailable.

-ip ipaddress Optional. Specifies the IP address of the server.

-lookuppassword Optional. Specifies the password for the lookup user.

password

-lookupuser user Optional. Specifies the user to perform the LDAP lookups.

-port port Optional. Specifies the port for the server.

-ssl Optional. When set, the LDAPs protocol is used instead of LDAP.
true | false

-uniqueidname name Optional. Specifies unique object attribute name to identify LDAP objects.

64 Actifio CLI Reference | actifio.com |

 Parameter Description

-userattribute attribute Optional. Specifies the attribute to use as the username.

Description
Use this command to configure an LDAP server for authentication.

Example
$ udstask chldapserver -ip 192.168.1.1 -port 629

| actifio.com | Actifio CLI Reference 65

 configdefaultdomain
The configdefaultdomain command configures default domain names. The Actifio appliance uses the domain names
when configuring hosts.

Rights
You must have the 'System Manage' right to configure the default domains.

Syntax
>>- udstask -- -- configdefaultdomain -------------------------->

>---- -domain -- domain_list -----------------------------------><

Parameter Description

-domain domain_list Required. Specifies the domain names that the Actifio appliance uses to resolve
host names. The items in the list should be separated by a colon (':'). You can use
an empty string "" to clear the domain names or configure a new list to replace the
domain names already configured.

Description
Use this command to configure the domain names that the Actifio appliance uses to resolve host names.

Example
The example below adds the 'actifio.com' and 'mydomain.com' domains:
$ udstask configdefaultdomain -domain actifio.com:mydomain.com
The example below deletes the default domain names that the Actifio appliance recognizes:
$ udstask configdefaultdomain -domain ""

66 Actifio CLI Reference | actifio.com |

configipfailover
The configipfailover command configures or removes IP fail-over interface pair.

Rights
You must have the 'System Manage' right to configure or remove IP fail-over interface pair.

Syntax
>>- udstask -- -- configipfailover -- -------------------------->
>--+----------+-- -- -interface1 -- interface1 ----------------->
'- -clear -'
>--+-----------------------------+-----------------------------><
'- -interface2 -- interface2 -'

Parameter Description

-clear Optional. Specifies that the IP fail-over interface pair to be removed.

-interface1 interface1 Required. Specifies the first interface in the pair.

-interface2 interface2 Optional, but required for configuration. Specifies the second interface in the pair.

Description
Use this command to configure or remove IP fail-over interface pair.

Example
$ udstask configipfailover -interface1 eth2 -interface2 eth3
$ udstask configipfailover -clear -interface1 eth2

| actifio.com | Actifio CLI Reference 67

 lsipfailover
The lsipfailover command returns a concise list of IP fail-over interface pairs.

Rights
You must have the 'System View' or 'System Manage' right to view IP fail-over interface pairs.

Syntax
>>- udsinfo -- -- lsipfailover -- ---------------------------->
>--+-----------------------+-- --+----------+----------------><
'- -delim -- delimiter -' '- -nohdr -'

Parameter Description

--delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim: on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur.

--nohdr Optional. By default, headings are displayed for each column of data in a concise
style view, and for each item of data in a detailed style view. The -nohdr parameter
suppresses the display of these headings.

Note: If there is no data to be displayed, headings are not displayed.

Description
Use this command to retrieve details of IP fail-over interface pairs.

Example
$ udsinfo lsipfailover
iinterface1 interface2
eth2 eth3

68 Actifio CLI Reference | actifio.com |

configdnsserver
The configdnsserver command configures/removes a DNS server.

Rights
You must have 'System Manage' right to add or remove DNS server.

Syntax
>>- udstask -- -- configdnsserver -- --------------------------->

>--+----------+-- -- -ipaddress -- ipaddress ------------------><

'- -clear -'

Parameter Description

-clear Optional. Specifies that the DNS server is to be removed.

ipaddress ipaddress Required. Specifies the IP address of the DNS server.

Description
Use this command to configure (add/clear) a DNS server

Example
$ udstask configdnsserver -ipaddress 192.168.1.1
$ udstask configdnsserver -clear -ipaddress 192.168.1.1

| actifio.com | Actifio CLI Reference 69

 getautodiscovery
The getautodiscovery command returns a concise list of hosts to perform auto-discovery on a schedule.

Rights
You must have 'System View' or 'System Manage' or ‘Application Manage’ or ‘Host Manage’ right to perform auto-
discovery on a schedule.

Syntax
>>- udsinfo -- -- getautodiscovery -- -------------------------->
>--+-----------------------+-- --+----------+------------------><
'- -delim -- delimiter -' '- -nohdr -'

Parameter Description

-delim delimiter Optional. By default, all columns of data are separated by a tab in the concise view.
In the detailed view, each column of data is displayed in a separate row and if the
headers are displayed, the header is separated from the data by a space. The -
delim parameter overrides this behavior.
Valid input for the -delim parameter is a one- byte character. To display the data,
recommended delimiter to use is comma (',') for list view, and equal ('=') for detail
view.

-nohdr Optional. By default, titles are displayed for each column of data in a concise style
view, and for each item of data in the detailed view. The -nohdr parameter
suppresses the display of headings. If there is no data to display, headings are not
displayed.

Description
This command returns a concise list of hosts to perform auto-discovery on a schedule. For a vCenter, an auto-
discovery automatically adds all discovered VMs. For non-vCenter, all discovered applications are added.
Use udsinfo getschedule -name autodiscovery to display the schedule. By default, the schedule runs once a day at
3 am.
The user must have 'System View' or 'System Manage' rights to view autodiscovery.

Example
$ udsinfo getautodiscovery
hostname
mkthost
financevcenter

70 Actifio CLI Reference | actifio.com |

iscsitest
The iscsitest command determines if the iSCSI configuration is properly set up, and notifies users with corrective
action.

Rights
You must have the 'Host Manage' rights to perform iSCSI test.

Syntax
>>- udstask -- -- iscsitest -- --------------------------------->
>-- -host --+- host_name -+------------------------------------->
'- host_id ---'
>--+-----------------+-- +-- --+----------------------------+--->
'- -port -- port -' '- -iscsiports -- iscsiport -'
>--+-----------------------+-- --+----------+------------------->
'- -delim -- delimiter -' '- -nohdr -'

Parameter Description

-host host Required. Specifies the host in which iSCSI test to be performed, either the source ID or
name of the host is required. Use udsinfo lshost to locate the ID or name of the host.

-port name Optional. Specifies the port that the Actifio Connector is running on. The default is 56789.

-iscsiports Optional. Specifies the iSCSI port on which the test needs to be performed. If you do not
isciport specify this option, the test will be run for all iSCSI ports.

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed the data
is separated from the header by a space. The -delim parameter overrides this behavior.
Valid input for the -delim parameter is a one-byte character. If you enter -delim: on the
command line, the colon character (:) separates all items of data in a concise view; for
example, the spacing of columns does not occur. In a detailed view, the data is separated
from its header by the specified delimiter.

-nohdr Optional. By default, headings are displayed for each column of data in a concise view,
and for each item of data in a detailed view. The - nohdr parameter suppresses the
display of these headings. If there is no data to be displayed, headings are not displayed.

Description
Use this command to test iSCSI configuration in the Actifio appliance and host. The iSCSI test can be performed on
the generic host and ESX hosts.

| actifio.com | Actifio CLI Reference 71

 Example
$ udstask iscsitest -host 4142
iSCSIPort Test Status Hint
iqn.1994-05.com.redhat:7c6e4c9c6ac1 Host iSCSI initiator installed and configured Passed
iqn.1994-05.com.redhat:7c6e4c9c6ac1 CDS has valid IQN Failed
CDS doesn't have IQN configured or IQN on CDS doesn't match IQNs in host. Please copy the IQN
from the host enter it into the iSCSI ports field.
iqn.1994-05.com.redhat:7c6e4c9c6ac1 Host has logged into the CDS iSCSI target Skipped
iqn.1994-05.com.redhat:7c6e4c9c6ac1 Mapping disk from CDS to host Skipped
iqn.1998-01.com.vmware:esxhyd1-6e1403ff Host iSCSI initiator installed and configured Passed
iqn.1998-01.com.vmware:esxhyd1-6e1403ff CDS has valid IQN Passed
iqn.1998-01.com.vmware:esxhyd1-6e1403ff Host has logged into the CDS iSCSI target Passed
iqn.1998-01.com.vmware:esxhyd1-6e1403ff Mapping disk from CDS to host Passed

$ udstask iscsitest -host 4142 -iscsiports iqn.1998-01.com.vmware:esxhyd1-6e1403ff

iSCSIPort Test Status Hint
iqn.1998-01.com.vmware:esxhyd1-6e1403ff Host iSCSI initiator installed and configured Passed
iqn.1998-01.com.vmware:esxhyd1-6e1403ff CDS has valid IQN Passed
iqn.1998-01.com.vmware:esxhyd1-6e1403ff Host has logged into the CDS iSCSI target Passed
iqn.1998-01.com.vmware:esxhyd1-6e1403ff Mapping disk from CDS to host Passed

72 Actifio CLI Reference | actifio.com |

ivmdiscovery

Note:

The ivmdiscovery command discovers VSP (Virtualization Services Platform) and VMs managed by an IVM (HP
Integrity Virtual Machine) Server.

Rights
You must have the 'Host Manage' rights to perform IVM discovery.

Syntax
>>- udstask -- -- ivmdiscovery -- ------------------------------>
>--+--------------------------+-- --+--------------------+-- --->
'- -host --+- host_name -+-' '- -ipaddress -- ip -'
'- host_id ---'
>--+-------------------------+-- --+-----------------------+---->
'- -password -- password -' '- -org -+- org_id ---+-'
'- org_name -'
>--+-----------------+-- --+-------------------------+---------><
'- -port -- port -' '- -username -- username -'

Parameter Description

-host Optional. Specifies the host name or the host ID to perform VSP discovery. The host must
host_name | be an VSP host. -host is used when the VSP host exists in an Actifio appliance. Use the
host_id udsinfo lshost command to locate the ID or name of the host.

-ipaddress ip Optional. Specifies the IP address of the VSP host. The IP address is required when the
VSP host does not exist in the Actifio appliance.

-org org_name | Optional. Specifies a default organization in which VSP or VMs should be added after
org_id discovery. To use this option a user must have the 'System Manage' right. If a default
organization is not specified, an organization that the user belongs to is used instead. Use
the udsinfo lsorg command to locate the ID or name of the organization.

-password Optional. Specifies the password of the VSP host. The password is equired when the VSP
password host does not exist in the Actifio appliance.

-port port Optional. Specifies the port to be used for discovery. The default is port 22.

-username Optional. Specifies the name of the VSP host. The IP address is required when the VSP
username host does not exist in the Actifio appliance.

| actifio.com | Actifio CLI Reference 73

 Description
Use this command to discover VSP and VMs managed by IVM(HP Integrity Virtual Machine) Server.

Example
$ udstask ivmdiscovery -host 4011

74 Actifio CLI Reference | actifio.com |

listrouteonhost
The listrouteonhost command lists all network routes on a host.

Rights
You must have the 'Host Manage' right to list network routes on a host.

Syntax
>>- udsinfo -- -- listroutesonhost -- --+-----------+-----------+-- --+----------+----------->
'- -delim -- delimiter -' '- -nohdr -'
>-- --+-----------+-- -- -------------------------------------------------------------------><
'- host_id -'

Parameter Description

-delim delimiter Optional. By default, all columns of data are separated by a tab in the concise view.
In the detailed view, each column of data is displayed in a separate row and if the
headers are displayed, the header is separated from the data by a space. The 
-delim parameter overrides this behavior.
Valid input for the -delim parameter is a one- byte character. To display the data,
recommended delimiter to use is comma (',') for list view, and equal ('=') for detail
view.

-nohdr Optional. By default, headings are displayed for each column of data in a concise
style view, and for each item of data in a detailed style view. The -nohdr parameter
suppresses the display of these headings.If there is no data to be displayed,
headings are not displayed.

host_id Required. The host to which this route should be applied.

Description
Use this command to list the routes configured on a host. This command connects to the host and fetches the routing
table from the host. This command is only valid when the host has the host type of Proxy Host (BDD).

Example
$ udsinfo listroutesonhost 1001
id route gateway interface
192.168.0.0/24:192.168.1.1:eth2 192.168.0.0/24 192.168.1.1 eth2
10.1.32.33:10.1.1.1: eth3 10.1.32.33 10.1.1.1 eth3

| actifio.com | Actifio CLI Reference 75

 lsdatastore
The lsdatastore command returns a concise list of data stores that the specified vCenter and ESX host can reference.

Rights
You must have 'System View' or 'System Manage' right to use this command.

Syntax
>>- udsinfo -- -- lsdatastore -- --+-----------------------+---->
'- -delim -- delimiter -'
>--+- -esxhost -- esx_host -+-- --+----------+-- --------------->
'- -nohdr -'
>--+- -vcenter -- vcenter_host -+------------------------------><

Parameter Description

-delim delimiter Optional. By default, all columns of data are separated by a tab in the concise view. In the
detailed view, each column of data is displayed in a separate row and if the headers are
displayed, the header is separated from the data by a space. The -delim parameter
overrides this behavior.
Valid input for the -delim parameter is a one- byte character. To display the data,
recommended delimiter to use is comma (',') for list view, and equal ('=') for detail view.

-esxhost Required. ESX host that data stores can reference.

esx_host

-vcenter Required. vCenter host that data stores can reference.

vcenter_host

-nohdr Optional. By default, headings are displayed for each column of data in a concise view,
and for each item of data in a detailed view. The - nohdr parameter suppresses the
display of these headings. If there is no data to be displayed, headings are not displayed.

Description
Use this command to retrieve list of data stores that resides on a vCenter.

76 Actifio CLI Reference | actifio.com |

Example
$udsinfo lsdatastore -vcenter vcenter -esxhost esxhost -delim ,
name,type,capacity,freespace
datastore3,VMFS,244544700416,32043433984
datastore4,VMFS,321854111744,255999344640

| actifio.com | Actifio CLI Reference 77

 lsssd
The lsssd command returns a concise list of SSD (Solid State Disk) devices, or a detailed view of an SSD device.

Rights
You must have 'System View', or 'System Manage' right to view SSDs.

Syntax
>>- udsinfo -- -- lsssd -- ------------------------------------->
>--+----------+-- --+-----------------------+-- ---------------->
'- -nohdr -' '- -delim -- delimiter -'
>--+-----------------+-----------------------------------------><
'- ssd_name ---'

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed the data
is separated from the header by a space. The -delim parameter overrides this behavior.
Valid input for the -delim parameter is a one-byte character. If you enter -delim: on the
command line, the colon character (:) separates all items of data in a concise view; for
example, the spacing of columns does not occur. In a detailed view, the data is separated
from its header by the specified delimiter.

-nohdr Optional. By default, headings are displayed for each column of data in a concise style
view, and for each item of data in a detailed style view. The -nohdr parameter suppresses
the display of these headings.If there is no data to be displayed, headings are not
displayed.

ssd_name Optional. Specifies the name of the SSD device to get detailed information.

Description
Use this command to retrieve details of an SSD device, or a list of SSDs.

78 Actifio CLI Reference | actifio.com |

Example
$ udsinfo lsssd
id wwid slot status
1 scsi-3600605b004fff9801c5bcf5863ff6d07 3 managed
2 scsi-3600605b004fff9801c5bcf5863fb89ba 2 managed
$ udsinfo lsssd -delim = 1
id=1
wwid=scsi-3600605b004fff9801c5bcf5863ff6d07
slot=3
status=managed
healthstatus=OK
remainingpct=100
state=in-use

| actifio.com | Actifio CLI Reference 79

 lsdefaultdomain
The lsdefaultdomain command displays a concise list of the default domain names available on an Actifio appliance.

Rights
You must have 'System View' or 'System Manage' right to use this command.

Syntax
>>- udsinfo -- -- lsdefaultdomain -- --------------------------><

Description
Use this command to retrieve a list of the default domain names available on an Actifio appliance.

Example
$ udsinfo lsdefaultdomain
actifio.com
mydomain.com

80 Actifio CLI Reference | actifio.com |

lsdnsserver
The lsdnsserver command returns a concise list of DNS servers.

Rights
You must have 'System View' or 'System Manage' right to use this command.

Syntax
>>- udsinfo -- -- lsdnsserver -- --+-----------------------+-- ->
'- -delim -- delimiter -'
>--+----------+------------------------------------------------><
'- -nohdr -'

Parameter Description

-delim delimiter Optional. By default, all columns of data are separated by a tab in the concise view. In the
detailed view, each column of data is displayed in a separate row and if the headers are
displayed, the header is separated from the data by a space. The -delim parameter
overrides this behavior.
Valid input for the -delim parameter is a one-byte character. To display the data,
recommended delimiter to use is comma (',') for list view, and equal ('=') for detail view.

-nohdr Optional. By default, headings are displayed for each column of data in a concise view, and
for each item of data in a detailed view. The - nohdr parameter suppresses the display of
these headings. If there is no data to be displayed, headings are not displayed.

Description
Use this command to list the configured DNS server(s)

Example
$ udsinfo lsdnsserver
ipaddress
192.168.0.71

| actifio.com | Actifio CLI Reference 81

 lshost
The lshost command displays a concise list of hosts or a detailed view of a host.

Syntax
>>- udsinfo -- -- lshost -- ------------------------------------>
>--+--------------------------------+-- --+----------+-- ------->
'- -filtervalue -- attrib=value -' '- -nohdr -'
>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+

Parameter Description

-delim delimiter Optional. By default, all columns of data are separated by a tab in the concise view.
In the detailed view, each column of data is displayed in a separate row and if the
headers are displayed, the header is separated from the data by a space. The -
delim parameter overrides this behavior.
Valid input for the -delim parameter is a one- byte character. To display the data,
recommended delimiter to use is comma (',') for list view, and equal ('=') for detail
view.

82 Actifio CLI Reference | actifio.com |

 Parameter Description

-filtervalue Optional. Specifies that you want your report to display any or the entire list of valid
attrib=value filter attributes. The valid filter attributes for the udsinfo lshost command are:
* alternateip
* description
* friendlypath
* hasagent
* hostname
* hosttype
* isclusterhost
* ipaddress
* isesxhost
* isvcenterhost
* isvm
* osrelease
* ostype
* osversion
* svcname
* vcenterhostid
* uniquename
The filter is formed with an attribute and a value. When you specify more than one
filter, they must be combined with '&' character (which should be escaped with '\').
For string type of filters, the only operator allowed is '='. You can also use the wild
card character '*'. For example, to list all hosts with a name that begins with 'foo',
use '-filtervalue hostname=foo*'.

-nohdr Optional. By default, headings are displayed for each column of data in the concise
view, and for each item of data in the detailed view. The -nohdr parameter
suppresses the display of headings.If there is no data to display, headings are not
displayed.

object_id Optional. Specifies the ID of an object. When you use this parameter, a detailed
view of the object is returned and any value specified by the -filtervalue parameter
is ignored. If you do not specify the object_id or the object_name parameter, a
concise view of all objects matching the filter criteria is displayed.

Description
Use this command to retrieve details of hosts. There are various types of hosts that exist within the system. They can
be divided into two types in general, Virtual Machine related hosts and non-Virtual Machine related.
Non-Virtual Machine related hosts have applications running on the host with primary storage connected.
Virtual Machine related hosts can be the vCenter type, which manages Virtual Machines. Virtual Machines are
discovered through the vCenter hosts. There are also ESX servers as well as the actual Virtual Machines.

| actifio.com | Actifio CLI Reference 83

 Example
$ udsinfo lshost -delim = 51
id=51
vcenterhostid=
friendlypath=
isesxhost=false
ostype=Win32
isvm=false
hostname=chandnichowk
uniquename=chandnichowk
ipaddress=192.168.226.164
osrelease=Microsoft Windows Server 2003
osversion=Build 3790 Service Pack 2
hasagent=true
alternateip=
timezone=GMT-0500
isvcenterhost=false
description=
isclusterhost=false
WWPNs=210000E08B12368F210100E08B32368F
iSCSIName=
type=generic
port=56789
username=

84 Actifio CLI Reference | actifio.com |

lsnasshare
The lsnasshare command returns a concise list of NAS shares.

Rights
You must have the 'System Manage', or 'System View' rights to be able to retrieve NAS share data.

Syntax
>>- udsinfo -- -- lsnasshare -- -------------------------------->
>--+--------------------------------+-- --+----------+-- ------->
'- -filtervalue -- attrib=value -' '- -nohdr -'
>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed the data
is separated from the header by a space. The -delim parameter overrides this behavior.
Valid input for the -delim parameter is a one-byte character. If you enter -delim: on the
command line, the colon character (:) separates all items of data in a concise view; for
example, the spacing of columns does not occur. In a detailed view, the data is separated
from its header by the specified delimiter.

-nohdr Optional. By default, headings are displayed for each column of data in a concise style
view, and for each item of data in a detailed style view. The -nohdr parameter suppresses
the display of these headings. If there is no data to be displayed, headings are not
displayed.

object_id Optional. Specifies the ID of an object. When you use this parameter, the detailed view of
the specific object is returned. If you do not specify the object_id parameter, the concise
view of all objects matching the filtering requirements are displayed.

Description
Use this command to retrieve details of NAS shares.

Example
$ udsinfo lsnasshare
idmodifydate sharetypefilerpath hostid sharedescfileripspace shareidexportpath snapshotpath
12345 0 /vol/testvol1 5305 172.17.130.10 12345 /vol/testvol1 testvol1
14341 0 testetest0 5305 0.0.0.0 1 test 9.0.0.9
15362 0 random/test 5305 9.0.0.9 1 random/test 9.0.0.9
19479 2 testetest0000 5305 0.0.0.0 0 test
28948 2 /vol/testshare 5305 nastest 172.17.130.10 0 /vol/testshare

| actifio.com | Actifio CLI Reference 85

 lsldapserver
The lsldapserver command returns the LDAP Server configuration.

Rights
You must have the 'System View' right is allowed to view the LDAP Server configuration.

Syntax
>>- udsinfo -- -- lsldapserver -- -------------------------------->

>--+-----------------------+-- --+----------+--------------------><
'- -delim -- delimiter -' '- -nohdr -'

Parameter Description

-delim delimiter Optional. By default, all columns of data are separated by a tab in the concise view. In the
detailed view, each column of data is displayed in a separate row and if the headers are
displayed, the header is separated from the data by a space. The -delim parameter
overrides this behavior.
Valid input for the -delim parameter is a one- byte character. To display the data,
recommended delimiter to use is comma (',') for list view, and equal ('=') for detail view.

-nohdr Optional. By default, headings are displayed for each column of data in a concise view,
and for each item of data in a detailed view. The - nohdr parameter suppresses the
display of these headings. If there is no data to be displayed, headings are not displayed.

Description
Use this command to list LDAP Server settings

Example
$ udsinfo lsldapserver
Address Port Base DN User Attribute
-ldap.example.com 389 dc=example,dc=com cn

Lookup User Lookup Password Using SSL Database Fallback Uniqueidname

False False entryGUID

86 Actifio CLI Reference | actifio.com |

lsldapgroup
The lsldapgroup command returns a concise list of LDAP groups or a detailed view of an LDAP group.

Rights
You must have the 'System View' or ‘System Manage’ right to view the LDAP server configuration.

Syntax
>>- udsinfo -- -- lsldapgroup -- ------------------------------->

>--+--------------------------------+-- --+----------+-- ------->

'- -filtervalue -- attrib=value -' '- -nohdr -'

>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+
'- object_name -'

Parameter Description

-delim delimiter Optional. By default, all columns of data are separated by a tab in the concise view. In the
detailed view, each column of data is displayed in a separate row and if the headers are
displayed, the header is separated from the data by a space. The -delim parameter
overrides this behavior.
Valid input for the -delim parameter is a one-byte character. If you enter -delim on the
command line, the colon character (:) separates all items of data in a concise view; for
example, the spacing of columns does not occur. In a detailed view, the data is separated
from its header by the specified delimiter.

-filtervalue Optional. Specifies that you want your report to display any or all of the list of valid filter
attrib=value attributes. The valid filter attributes for the udsinfo lsldapgroup command is: * name.
For string type of filters, the only operator allowed is '='. you can also use the wildcard
character '*'.
For example, to match consistency groups with name begins with 'foo', use '-filtervalue
name=foo*'.

-nohdr Optional. By default, headings are displayed for each column of data in a concise style
view, and for each item of data in a detailed style view. The -nohdr parameter
suppresses the display of these headings. If there is no data to be displayed, headings
are not displayed.

object_id | Optional. Specifies the name or ID of an object. When you use this parameter, the
object_name detailed view of the specific object is returned and any value specified by the 
-filtervalue parameter is ignored.
If you do not specify the object_id | object_name parameter, the concise view of all
objects matching the filtering requirements are displayed.

| actifio.com | Actifio CLI Reference 87

 Description
Use this command to retrieve details of LDAP groups.

Example
$ udsinfo lsldapgroup -delim = DnsAdmins
guid=fbca4882-b65b-3c2e-952f-c489d94320d9
id=12736
name=DnsAdmins
dn=CN=DnsAdmins,CN=Users,DC=actmad,DC=com

88 Actifio CLI Reference | actifio.com |

lsldapgrouprole
The lsldapgrouprole command returns a concise list of LDAP group role mappings, or a detailed view of an LDAP
group role mapping.

Rights
You must have the 'System View' or ‘System Manage’ right to view role mappings.

Syntax
>>- udsinfo -- -- lsldapgrouprole -- --------------------------->
>--+----------+-- --+-----------------------+-- ---------------->
'- -nohdr -' '- -delim -- delimiter -'
>--+---------------+------------------------------------------><
'- objectid ---'

Parameter Description

-delim delimiter Optional. By default, all columns of data are separated by a tab in the concise view. In the
detailed view, each column of data is displayed in a separate row and if the headers are
displayed, the header is separated from the data by a space. The -delim parameter
overrides this behavior. Valid input for the -delim parameter is a one- byte character. If you
enter -delim on the command line, the colon character (:) separates all items of data in a
concise view; for example, the spacing of columns does not occur. In a detailed view, the
data is separated from its header by the specified delimiter.

-nohdr Optional. By default, headings are displayed for each column of data in a concise style
view, and for each item of data in a detailed style view. The -nohdr parameter suppresses
the display of these headings. If there is no data to be displayed, headings are not
displayed.

object_id Optional. Specifies the ID of an LDAP group role object, to show the role mapping for a
particular LDAP group role.

Description
Use this command to retrieve LDAP group role mappings, for all LDAP groups or for a specific LDAP group.

Example
$ udsinfo lsldapgrouprole
id groupid roleid
1024 67324 4

| actifio.com | Actifio CLI Reference 89

 lsldapgrouporg
The lsldapgrouporg command returns a concise list of LDAP group organization mappings, or a detailed view of an
LDAP group organization mapping.

Rights
You must have 'System View' or 'System Manage' rights to view the organization mappings.

Syntax
>>- udsinfo -- -- lsldapgrouporg -- --------------------------->
>--+----------+-- --+-----------------------+-- ---------------->
'- -nohdr -' '- -delim -- delimiter -'
>--+---------------+-------------------------------------------><
'- objectid ---'

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed the data
is separated from the header by a space. The -delim parameter overrides this behavior.
Valid input for the -delim parameter is a one-byte character. If you enter -delim : on the
command line, the colon character (:) separates all items of data in a concise view; for
example, the spacing of columns does not occur. In a detailed view, the data is separated
from its header by the specified delimiter.

-nohdr Optional. By default, headings are displayed for each column of data in a concise style
view, and for each item of data in a detailed view. The -nohdr parameter suppresses the
display of these headings.

Note: If there is no data to be displayed, headings are not displayed.

object_id Optional. Specifies the ID of an LDAP group role object, to show the role mapping for a
particular LDAP group role.

Description
Use this command to retrieve LDAP group organization mappings, for all LDAP groups or for a specific LDAP group.

Example
$ udsinfo lsldapgrouporg
id groupid orgid
1024 67324 4

90 Actifio CLI Reference | actifio.com |

mkldapgroup
The mkldapgroup command creates an LDAP group that allows mapping of LDAP group to roles.

Rights
You must have the ‘System Manage’ right to create an LDAP group.

Syntax
>>- udstask -- -- mkldapgroup ---------------------------------->

>-- -dn -- name --------------------------------------------><

Parameter Description

-dn name Required. Specifies the Distinguished Name (DN) of the LDAP group.

Description
Use this command to create an LDAP group object. This group must already exist in the LDAP server. Once the LDAP
group is added with this command, use udstask mkldapgrouprole to create the mapping.

Example
$ udstask mkldapgroup -dn CN=DnsUpdateProxy,CN=Users,DC=example.com,DC=com

| actifio.com | Actifio CLI Reference 91

 mkldapgrouprole
The mkldapgrouprole command adds a new LDAP group role mapping.

Rights
You must have the ‘System Manage’ right to add new LDAP group role mapping.

Syntax
>>- udstask -- -- mkldapgrouprole -- -- -groupid -- group_id --->

>---- -roleid -- role_id -------------------------------------><

Parameter Description

-groupid Required. Specifies the LDAP group id.

group_id

-roleid role_id Required. Specifies the role ID to be assigned to the LDAP group.

Description
Use this command to add a new LDAP group role mapping, an LDAP group can map to multiple roles. User that
belongs to the LDAP group automatically has the roles specified in the mapping. Use udsinfo lsldapgroup to obtain
ID of the LDAP group. Use udsinfo lsrole to obtain ID of the role.

Example
$ udstask mkldapgrouprole -groupid 4111 -roleid 4203

92 Actifio CLI Reference | actifio.com |

mkldapgrouporg
The mkldapgrouporg command adds a new LDAP group organization mapping.

Rights
You must have 'System Manage' right to add new LDAP group organization mapping.

Syntax
>>- udstask -- -- mkldapgrouporg -- -- -groupid -- group_id --->
>---- -orgid -- org_id ---------------------------------------><

Parameter Description

--groupid Required. Specifies the LDAP group ID.

group_id

--orgid org_id Required. Specifies the organization id to be assigned to the LDAP group.

Description
Use this command to add a new LDAP group organization mapping. An LDAP group can map to multiple
organizations. User that belongs to the LDAP group automatically has the organizations specified in the mapping. Use
udsinfo lsldapgroup to obtain ID of the LDAP group. Use udsinfo lsorg to obtain ID of the organization.

Example
$ udstask mkldapgrouporg -groupid 4111 -orgid 4203

| actifio.com | Actifio CLI Reference 93

 mkhost
The mkhost command creates a new host object.

Rights
You must have the 'Host Manage' right to create a host.

Syntax
>>- udstask -- -- mkhost -- --+---------------------------+----->
'- -type --+- generic -+-- -'
+- hmc -----+
+- hpux ----+
+- hyperv --+
+- isilon --+
+- openvms -+
+- tpgs ----+
'- vcenter -'
>--+-------------------------------------+-- ------------------->
'- -dbauthentication --+- true --+-- -'
'- false -'
>--+---------------------------------+-------------------------->
+- -iscsiname -- iscsi_name_list -+
'- -hbawwpn -- wwpn_list ---------'
>--+-----------------------+-- --+---------------------------+-->
'- -iogrp-- iogrp_list -' '- -alternateip -- ip_list -'
>--+-------------------------------+-- -- -hostname -- name ---->
'- -description -- description -'
>--+---------------------------------+-- +--------------------+->
'- -friendlypath -- friendlypath -' '- -svcname -- name -'
>--+---------------------------+-- --+----------------------+--->
'- -ipaddress -- ipaddress -' '- -mask -- port_mask -'
>--+-----------------------+-- --+-------------------------+---->
'- -org -+- org_id ---+-' '- -password -- password -'
'- org_name -'
>--+-----------------+-- --+-------------------------+---------><
'- -port -- port -' '- -username -- username -'

94 Actifio CLI Reference | actifio.com |

 Parameter Description

-alternateip ip_list Optional. Specifies the alternate IP address of the host. Multiple -alternateip can be
specified in a comma-delimited list.

-description Optional. Specifies the description of the host.

description

-dbauthentication Optional. Specifies whether Oracle database running on this host should be using
true | false DB Authentication or Host authentication.

-friendlypath Optional. Specifies the friendly name for the host.

friendlypath

-hbawwpn wwn_list Required for generic/HP-UX/TPGS hosts when an iSCSI name is not specified.
Multiple -hbawwpn can be specified in a colon-delimited list. Not allowed for virtual
machine hosts. Specifies one or more host bus adapter (HBA) worldwide port
names (WWPNs) to add to the specified host. For generic/HP-UX/TPGS hosts, at
least one WWPN or iSCSI name should be specified. You cannot use this parameter
with the -iscsiname parameter.

-hostname name Required. Specifies the name of the host.

-iogrp iogrp_list Optional. Not allowed for hosts on virtual machine hosts. Specifies a set of one or
more I/O groups that the host can access the vdisks from. I/O groups are specified
using their names or IDs separated by a colon. Names and IDs can be mixed in the
list. If this parameter is not specified, the host is associated with all I/O groups.

-ipaddress ipaddress Optional. Specifies IP address of the host. A DNS lookup will be attempted if this is
not specified.

-iscsiname For generic/HP-UX/TPGS hosts, at least one WWPN or iSCSI name should be
iscsi_name_list specified. You cannot use this parameter with the hbawwpn parameter. Multiple -
iscsiname can be specified in a comma-delimited list.
Required for generic/HP-UX/TPGS hosts and hbawwpn is not specified. However,
not allowed for virtual machine hosts. Specifies one or more iSCSI names of this
host.

-mask port_mask Optional for generic/HP-UX/TPGS hosts. However, not allowed for virtual machine
hosts. Specifies which node target ports that a host can access. The port mask is
four binary bits and is made up of a combination of zeros and ones, where 0
indicates that the corresponding target port cannot be used and 1 indicates that it
can be used. The right-most bit in the mask corresponds to the lowest numbered
target port (1 not 4) on a node. Valid mask values range from 0000 (no ports
enabled) to 1111 (all ports enabled). For example, a mask of 0011 enables port 1 and
port 2. The default value is 1111 (all ports enabled).

-org org_id | org_name Optional. Specifies a default organization in which the host should be added to after
creation. To use this option user needs to have 'System Manage' right. If a default
organization is not specified, an organization that the user belongs to is used.

| actifio.com | Actifio CLI Reference 95

 Parameter Description

-password password Required for vCenter type. Specifies the password to access the Actifio Connector
of the host.

-port port Optional. Specifies the agent port number for the host. The default is 56789 for
generic/hpux/tpgs/openvms hosts, and 0 for VM related hosts.

-svcname name Optional. Specifies the SVC host name, which limits to 15 characters, first character
cannot be a number, and no space, or '.' is allowed.

-type Required for vCenter or hmc type. Specifies the type of the new host: generic,
generic | hmc | hpux | hpux, tpgs, openvms, isilon, hmc, or vcenter. The tpgs type enables extra target
hyperv | isilon | port unit attentions. With the vcenter type, discovery (see udstask vmdiscovery)
openvms | tpgs | allows Virtual Machines to be discovered. A host can be of more than one type, one
vcenter of generic/hpux/tpgs/openvms, and of vcenter. Separate the two types with a
colon, ':', if the vcenter also has access to storage configured.

-username username Required for vCenter. Specifies the username to access the Actifio Connector
running on the host.

Description
This command creates a new host. The ID is displayed when the command completes. For generic/hpux/tpgs/
openvms host, hostname must start with a letter, and can only use letter, digit or '_'. This is generally the DNS name
for a host. For vCenter host, you may also use IP address of the host as the hostname.

Example
$ udstask mkhost -hostname myhost -hbawwpn 210000E08B12368F -ipaddress 10.10.1.2

$ udstask mkhost -hostname myhost -type vcenter -ipaddress 10.10.1.2 \

-username newuser -password mypwd

96 Actifio CLI Reference | actifio.com |

configchap
The configchap command configures or removes a CHAP secret for authentication between iSCSI initiators and the
iSCSI target.

Rights
You must have the 'System Manage' right to configure or clear the CHAP secret.

Syntax
>>- udstask -- -- configchap -- --+----------+-- ---------->
'- -clear -'
>--+-------------------------+-- -------------------------->
'- -password -- password -'
>--+-------------------------+----------------------------><
'- -username -- username -'

Parameter Description

-clear Optional. Specifies that the CHAP secret to be cleared, effectively disable CHAP
authentication.

-password password Optional. Specifies the password for CHAP authentication, the value must be
between 12 and 16 characters.

-username username Optional. Specifies username for CHAP authentication. The limit is maximum of 16
characters.

Description
Use this command to configure or remove the CHAP secret for authentication.

Example
$ udstask configchap -usernam newuser -password newpwdnewpwd

| actifio.com | Actifio CLI Reference 97

 mkldapserver
The mkldapserver command configures an LDAP server.

Rights
You must have the 'System Manage' right to configure an LDAP server.

Syntax
>>- udstask -- -- mkldapserver -- -- -basedn -- basedn -- ------>
>--+------------+-- -- -- -ip -- ipaddress -- ------------------>
'- fallback -'
>--+-------------------------------+---------------------------->
'- -lookuppassword -- password -'
>--+-----------------------+-- -- -- -port -- port -- ---------->
'- -lookupuser -- user -'
>--+----------+-- --+-------------------------+-- -------------->
'- -nossl -' '- -uniqueidname -- name -'
>-- -userattribute -- attribute -------------------------------><

Parameter Description

-ip ipaddress Specifies the IP address for the server.

-port port Specifies the port for the server.

-basedn basedn Specifies the basedn for the LDAP lookups.

-userattribute name Specifies the attribute to use as the username.

-lookupuser user Optional. Specifies the user to perform the LDAP lookups.

-lookuppassword Optional. Specifies the password for the lookup user.

password

-nossl Optional. When set, SSL is not used to connect to the LDAP server.

-fallback Optional. When true, cached credentials will be used if the LDAP server is
unavailable.

-uniqueidname name Optional. Specifies unique object attribute name to identify LDAP objects.

Description
Use this command to configure an LDAP server for authentication.

Example
$ udstask mkldapserver -ip 192.168.1.1 -port 629 -basedn 'dc=example,dc=com'
-userattribute 'cn' -lookupuser admin -lookuppassword 'secret'

98 Actifio CLI Reference | actifio.com |

removeroutefromhost
The removeroutefromhost command removes a network route to a host.

Rights
You must have the 'Host Manage' right to remove a network route to a host.

Syntax
>>- udstask -- -- removeroutefromhost -- ---------------------------------------------------->
>---+-------------------+-- -- --+-----------------------+-- --------------------------->
'- -route -- route -' '- -gateway -- gateway -'
>--+--------------------------+-- -- --+-----------+-- --------------------------------><
'- interface -- interface -' '- host_id -'

Parameter Description

-route route Required. The route to apply to the host you wish to remove. It can be a single IP
address or a network range in CIDR notation.

-gateway gateway Required. The gateway to use for this route.

-interface interface Required. The network interface on the host to which this routing should be
removed.

host_id Required. The host to which this route should be removed.

Description
Use the removeroutefromhost command to remove a network route from a host. The route to be removed is based
on an exact match of the interface, route, and gateway parameters. If no matching route can be found, this command
will return an error saying that the route could not be found. This command will connect to the host and update its
routing table based on the given parameters.

Note: Changing network routing can have significant consequences including loss of connectivity so be sure you
understand the consequences before making changes to the host's routing tables.

Example
Removing a route from a single IP address:
$ udstask removeroutefromhost -route 192.168.1.150 -gateway 192.168.1.1 -interface eth2 10001
Removing a route from a network range where the route uses CIDR notation:
$ udstask removeroutefromhost -route 192.168.0.0/24 -gateway 192.168.1.1 -interface eth2 10001

| actifio.com | Actifio CLI Reference 99

 rmhost
The rmhost command deletes a host.

Rights
You must have the 'Host Manage' right to delete a host.

Syntax
>>- udstask -- -- rmhost -- -- host_id ------------------------><

Parameter Description

host_id Required. Specifies the ID of the host to be deleted.

Description
Use this command to delete a host. Use the udsinfo lshost command to retrieve the ID or name of the host.

Example
$ udstask rmhost 4111

100 Actifio CLI Reference | actifio.com |

rmldapserver
The rmldapserver command removes the LDAP server configuration.

Rights
You must have “System Manage” right to remove the LDAP configuration.

Syntax
>>- udstask -- -- rmldapserver -- --------------------------->

Description
Use this command to remove the LDAP server configuration.

Example
$ udstask rmldapserver

| actifio.com | Actifio CLI Reference 101

 rmldapgroup
The rmldapgroup command deletes an LDAP group.

Rights
You must have the 'System Manage' right to delete an LDAP group.

Syntax
>>- udstask -- -- rmldapgroup -- --+- group_name -+------------><
'- group_id ---'

Parameter Description

group_id | Required. Specifies the ID or name of the LDAP group to be removed. Use the
group_name udsinfo lsldapgroup command to locate the ID or name of the LDAP group.

Description
Use this command to delete an LDAP group, including all of the mapping to roles.

Example
$ udstask rmldapgroup 4111

102 Actifio CLI Reference | actifio.com |

rmldapgrouporg
The rmldapgrouporg command deletes an LDAP group organization mapping.

Rights
You must have “System Manage” right to delete an LDAP group org mapping.

Syntax
>>- udstask -- -- rmldapgrouporg -- -- object_id ----------><

Parameter Description

object_id Required. Specifies the ID of the LDAP group organization mapping to be removed.

Description
Use this command to delete an LDAP group organization mapping. The group organization ID can be obtained using
udsinfo lsldapgrouporg command.

Example
$ udstask rmldapgrouporg 1002

| actifio.com | Actifio CLI Reference 103

 rmldapgrouprole
The rmldapgrouprole command deletes an LDAP group role mapping.

Rights
You must have the 'System Manage' right to delete an LDAP group role mapping.

Syntax
>>- udstask -- -- rmldapgrouprole -- -- object_id ----------><

Parameter Description

object_id Required. Specifies the ID of the LDAP group role mapping to be removed. Use the
udsinfo lsldapgrouprole command to locate the ID or name of the LDAP group
role.

Description
Use this command to delete an LDAP group, including all of the mapping to roles.

Example
$ udstask rmldapgrouprole 1002

104 Actifio CLI Reference | actifio.com |

setautodiscovery
The setautodiscovery command configures/removes a host from the auto-discovery list.

Rights
You must have the “Application Manage”, “Host Manage”, or “System Manage” right to add or remove a host to the
auto-discovery host list.

Syntax
>>- udstask -- -- setautodiscovery -- -------------------------->

>--+----------+-- -- -host --+- host_name -+-------------------><

'- -clear -' '- host_id ---'

Parameter Description

-clear Optional. Specifies the host to be removed from the auto-discovery list.

-host Required. Specifies the name or ID of the host. Use the udsinfo lshost command
host_name | host_id to locate the ID or name of the host.

Description
Use this command to configure/remove a host from the auto-discovery list. For a vCenter, an auto-discovery
automatically adds all discovered VMs. For non-vCenter, all discovered applications are added.
Use udstask setschedule to set the schedule for autodiscovery. By default, autodiscovery is performed once a day at
3 am.

Example
$ udstask setautodiscovery -host myhost

$ udstask setautodiscovery -clear -host financevcenter

| actifio.com | Actifio CLI Reference 105

 testldapserver
The testldapserver command tests the LDAP configuration by attempting to connect to the server.

Rights
You must have “System Manage” right to test the LDAP configuration.

Syntax
>>- udstask -- -- testldapserver -- --------------------->

>---- -user -- user -- -- -- -password -- password -----><

Parameter Description

-user user Required. The username with which to test.

-password password Required. The password associated with the user.

Description
Use this command to test the LDAP configuration.

Example
$ udstask testldapserver -user foo -password bar
Success

106 Actifio CLI Reference | actifio.com |

chauthservice
The chauthservice command changes the authentication service in use.

Rights
You must have 'System Manage' right to change the authentication service.

Syntax
>>- udstask -- -- chauthservice -- --+------------------------+->
>--+--------------------------+--------------------------------><
'- -type --+- database -+-'
'- ldap ------'

Parameter Description

-type Specifies new authentication service to use. Either LDAP or database.

database | ldap

Description
Use this command to change the authentication service in use.

Example
$ udstask chauthservice -type ldap

| actifio.com | Actifio CLI Reference 107

 chdiskpool
The chdiskpool command changes the attributes of a disk pool.

Rights
You must have the 'Storage Manage' right to change the attributes of a disk pool.

Syntax
>>- udstask -- -- chdiskpool -- +--------------------------+---->
'- -addmdisk -- disk_list -'

>--+----------------------+-- --+-----------------------+------->
'- -name -- pool_name -' '- -safepct -- safepct -'

>--+-----------------------+-- --+- diskpool_name -+-----------><

'- -warnpct -- warnpct -' '- diskpool_id ---'

Parameter Description

-addmdisk disk_list Optional. Specifies a list of managed disks to be added to the disk pool.
The items in the list should be separated by a colon (':'). The managed
disks should be named as follows:
• Managed disks added to the performance pool should be
named as 'act_per_mdknnnn', where nnnn is 4-digit number.
• Managed disks added to the primary pool should be named as
'act_pri_mdknnnn', where nnnn is 4-digitnumber.

-name pool_name Optional. Specifies a name for the disk pool.

-safepct safepct Optional. Specifies the safe percentage for the disk pool, disk usage
exceeding this value results in some operations to be suspended. An
immediate attention is required, such as adding more storage to the pool
or expiring some backup images. The value must be between 10 and 100.
For dedup pool, the safepct is 100 and can not be modified.

-warnpct warnpct Optional. Specifies the safe percentage for the disk pool, disk usage
exceeding this value results in some operations to be suspended. An
immediate attention is required, such as adding more storage to the pool
or expiring some backup images. The value must be between 10 and 100.
For dedup pool, the safepct is 100 and can not be modified.

diskpool_id | diskpool_name Required. Specifies the ID or name of the diskpool to be modified.

108 Actifio CLI Reference | actifio.com |

Description
Use this command to change the attributes of a disk pool. Use udsinfo lsdiskpool to obtain the ID or name of the disk
pool.
When the disk usage exceeds warnpct, a warning event is generated.
When the disk usage exceeds safepct, some operations are disabled based on the type of disk pool and an error is
raised. For example, when a performance pool's safe percentage is exceeded, access to snapshots is disabled. To
change the name of a managed disk, use svctask chmdisk -name new_name oldname.

Example
$ udstask chdiskpool -warnpct 60 pool1
$ udstask chdiskpool -warnpct 60 -addmdisk mdisk1:mdisk2 act_ded_pool000
For Actifio Sky appliance:
$ udstask chdiskpool -addmdisk sdl 72

| actifio.com | Actifio CLI Reference 109

 chslp
The chslp command modifies the attributes of a profile.

Rights
You must have the 'SLA Manage' right to modify a profile.

Syntax
>>- udstask -- -- chslp -- --+------------------------+----->
'- -description -- desc -'
>--+-----------------+-- --+--------------------------+-- -->
'- -name -- name -' '- dedupasyncnode -- node -'
>--+----------------------------+-- ------------------------>
'- -performancepool -- pool -'
>--+-------------------------------------+-- --------------->
'- -primarystorage -- primarystorage -'
>--+-----------------------+-- --+- slp_name -+------------><
'- -remotenode -- node -' '- slp_id ---'

Parameter Description

-description desc Optional. Specifies new description for the SLP.

-dedupasyncnode Optional. Specifies the name of the remote dedup-async node, remote node is
used if not specified.

-name name Optional. Specifies new name for the SLP.

-performancepool Optional. Specifies new performance pool for the SLP.

pool

-primarystorage pool Optional. Specifies new primary storage for the SLP.

-remotenode node Optional. Specifies new remote appliance node for the SLP.

slp_id | slp_name Required. Specifies the ID or name of the profile (SLP) to be changed.

Description
Use this command to change the properties of a profile. Use the udsinfo lsslp command to obtain the ID or name of
the profile.

Example
$ udstask chslp -description "profile description" profile1

110 Actifio CLI Reference | actifio.com |

configresourcewarning
The configresourcewarning command sets the warning level for system resource within the Actifio appliance.

Rights
You must have the 'System Manage' right to configure the warning level for a resource.

Syntax
>>- udstask -- -- configresourcewarning -- --------------------->

>-- -name --+- vdisk ----+-- --+--------------------------+----><

'- copy -----' '- -warnpct -- percentage -'
'- snap -----'
'- remote ---'
'- mirror ---'

Parameter Description

-name Required. Specifies the name of the resource to set the warning level. The
vdisk | copy | snap | supported resources and the permitted resource levels are:
remote | mirror • vdisk: You can configure a maximum of 2048 virtual disks for one iogrp
copy: You can create a maximum of 256 copies per VDisk.
• snap: snapshot bitmap memory (pre- configured)
• remote: remote copy memory (pre-configured)
• mirror: mirror copy memory (pre-configured)

-warnpct percentage Optional. Specifies the warning percentage for the resource, between 10 and 99.
The default warning percentage is 90%.

Description
Use this command to configure the usage level, a percentage, for a resource. To view the existing configuration, use
the udsinfo getresourcewarning command.

Example
$ udstask configresourcewarning -name vdisk -warnpct 80

| actifio.com | Actifio CLI Reference 111

 getresourcewarning
The getresourcewarning command generates a warning when the resource usage crosses the pre-configured
warning threshold.

Rights
You must have ‘System View’ or 'System Manage' right to view the warning threshold of a resource.

Syntax
>>- udsinfo -- -- getresourcewarning -- ------------------------>

>-- -name --+- vdisk --+---------------------------------------><

'- copy ---'
'- snap ---'
'- remote -'
'- mirror -'

Parameter Description

-name Required. Specifies the name of the resource to configure the warning level for. You
vdisk | copy | snap | can configure a warning level for the following resources:
remote | mirror • vdisk: You can create a maximum of 2048 VDisks on an Actifio
appliance.
• copy: You can create a maximum of 256 copies per a VDisk.
• snap: Snapshot bitmap memory. This is pre- configured.
• remote: Remote copy memory. This is pre- configured.
• mirror: Mirror copy memory. This is pre- configured.

Description
Use this command to display resource warning percentage for a resource.

Example
$ udsinfo getresourcewarning -name vdisk 90

112 Actifio CLI Reference | actifio.com |

lsdiskpool
The lsdiskpool command displays a concise list of disk pools or a detailed view of a disk pool.

Rights
You must have 'Storage View', 'Storage Manage', 'SLA View', 'SLA Assign', or 'SLA Manage' rights to be able to
retrieve disk-pool data.

Syntax
>>- udsinfo -- -- lsdiskpool -- -------------------------------->

>--+--------------------------------+-- --+----------+-- ------->

'- -filtervalue -- attrib=value -' '- -nohdr -'

>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+
'- object_name -'

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim: on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

-filtervalue Optional. Specifies that you want your report to display any or the entire list of valid
attrib=value filter attributes. The valid filter attributes for the udsinfo lsdiskpool command are:
• name
• safepct
• warnpct
The filter is formed with an attribute and a value. When you specify more than one
filter, they must be combined with '&' character (which should be escaped with '\').
For string type of filters, the only operator allowed is '='. You can also use wild card
character '*'. For example, to match disk pools with name begins with 'foo', use '-
filtervalue name=foo*'.

For number types, allowed operators are: =, >, >=, <, <=. These must be escaped
with '\' or enclosed in ' or ", as required by shell. 
For example:
* -filtervalue warnpct\>=80
* -filtervalue "warnpct>=80"
* -filtervalue 'warnpct>=80'

| actifio.com | Actifio CLI Reference 113

 Parameter Description

-nohdr Optional. By default, headings are displayed for each column of data in the concise
view, and for each item of data in the detailed view. The -nohdr parameter
suppresses the display of headings. If there is no data to display, headings are not
displayed.

object_id | Optional. Specifies the name or ID of an object. When you use this parameter, a
object_name detailed view of the object is returned and any value that is specified by the -filter
value parameter is ignored. If you do not specify the object_id or the object_name
parameter, a concise view of all objects matching the filter criteria is displayed.

Description
Use this command to retrieve the details of disk pools. vDisks reside in a disk pool. Actifio maintains three reserved
diskpools, 'act_per_pool000' to store the snapshot backup images, 'act_ded_pool000' to store the dedup images, and
'act_pri_pool000' to store some Actifio internal metadata as well as the cloned images.
Each diskpool maintains two thresholds, warnpct and safepct. When the diskpool usage exceeds warnpct, more
storage can be added, or some obsolete backup images can be expired. When the usage exceeds the safepct, some
backup schedule is turned off immediately. For example, when the safepct of act_ded_pool000 is exceeded, dedup
schedule is turned off. No more dedup is allowed, until the usage dropped below the safepct.
For act_ded_pool000, perform a garbage collection to reclaim space in the dedup diskpool with udstask setschedule
-name gc -op now. Note that warnpct should be less than safepct for each diskpool. For 'act_ded_pool000', safepct
cannot be more than 75%.

Example
$ udsinfo lsdiskpool
id warnpct udscritical name safepct
71 80 true act_pri_pool000 90
72 80 true act_ded_pool000 90
73 80 true act_per_pool000 90

114 Actifio CLI Reference | actifio.com |

lsslp
The lsslp command displays a concise list of profiles (SLPs), or a detailed view of a profile (SLP).

Rights
You must have the 'SLA View', 'SLA Assign', or 'SLA Manage' right to view the details of profiles.

Syntax
>>- udsinfo -- -- lsslp -- ------------------------------------->
>--+--------------------------------+-- --+----------+-- ------->
'- -filtervalue -- attrib=value -' '- -nohdr -'
>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+
'- object_name -'

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim : on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

-filtervalue Optional. Specifies that you want your report to display any or the entire list of valid
attrib=value filter attributes. The valid filter attributes for the udsinfo lsslp command are:
• name
• localnode
• performancepool
• primarystorage
• remotenode
The filter is formed with an attribute and a value. When you specify more than one
filter, they must be combined with '&' character (which should be escaped with '\').
For string type of filters, the only operator allowed is '='. You can also use wild card
character '*'. For string type of filters, the only operator allowed is '='. You can also
use wild card character '*'. For example, to list all profiles (SLPs) with a name that
begins with 'foo', use '- filtervalue name=foo*'.

-nohdr Optional. By default, headings are displayed for each column of data in the concise
view, and for each item of data in the detailed view. The -nohdr parameter
suppresses the display of headings.If there is no data to display, headings are not
displayed.

object_id | Optional. Specifies the name or ID of an object. When you use this parameter, a
object_name detailed view of the object is returned and any value that is specified by the -filter
value parameter is ignored. If you do not specify the object ID or the object name, a
concise view of all objects matching the filter criteria is displayed.

| actifio.com | Actifio CLI Reference 115

 Description
Use this command to retrieve details of profiles (SLPs). A profile (SLP) specifies mapping of a name in a policy to an
actual resource in the Actifio appliance.

Example
$ udsinfo lsslp
id description name performancepool primarystorage remotenode localnode
4170 sales act_per_pool000 cluster4
4171 mkt act_per_pool000 cluster3 cluster4

116 Actifio CLI Reference | actifio.com |

mkdiskpool
The mkdiskpool command creates a new disk pool object.

Rights
You must have the 'Storage Manage' right to create a new disk pool.

Syntax
>>- udstask -- -- mkdiskpool -- --+-----------------------+---->
'- -ext -- extent_size -'
---- -name -- pool_name -- --+-------------------------+-- --->
'- -mdisk -- mdisk_list --'
>--+-----------------------+-- --+------------------------+-- ->
'- -org -+- org_id ---+-' '- -properties -- props -'
'- org_name -'
>--+-----------------------+-- --+-----------------------+-- -->
'- -safepct -- safepct -' '- -warnpct -- warnpct -'
>--+-- -type -+- perf ----+-----------------------------------><
+- primary -+
'- vault ---'

Parameter Description

-ext extent_size Optional. Specifies the size of the extents for this disk pool in MB. The extent_size
parameter must be one of the following values: 16, 32, 64, 128, 256, 512, 1024, or
2048 (MB). If not specified, the default size of 512 MB is used.

-mdisk Optional. Specifies a colon-separated list of managed disks to add to the disk pool.
mdisk_name_list The mdisks added to the performance pool should be named as
'act_per_mdknnnn', where nnnn is a 4-digit number. Similarly, the mdisks added to
the primary pool should be named as 'act_pri_mdknnnn', where nnnn is a 4-digit
number.

Note: To change the name of a managed disk, use usvctask chmdisk -name
new_name old_name. Use the usvctask addmdisk command to add mdisks to
a diskpool.

-name pool_name Required. Specifies the name for the disk pool.

-org org_id | org_name Optional. Specifies a default organization in which the disk pool should be added to
after creation. To use this option You must have 'System Manage' right.

| actifio.com | Actifio CLI Reference 117

 Parameter Description

-properties props Optional. Specifies properties for vault type of pools, comma (,) separated name
value pair. Use the udsinfo lsvaulttype command to view a list of available
properties for a specific type of vault pool.
For example, -properties bucket=mybucket,accessId=myid.

-safepct safepct Optional. Specifies the safe percentage for the disk pool. When the disk usage
exceeds this value, some operations are turned off. An immediate attention is
required, such as adding more storage to the pool or expiring some backup images.
The default value should be between 10 and 99%.

-type perf | primary | Required. Specifies the type of pool (performance/ primary/vault) to create.
vault
• perf - the performance pool is used to store snapshot images.
• primary - The primary pool is used for storing and cloning backup images.
• vault - The vault pool is used for selecting Amazon S3 and Google Cloud
Storage.

-warnpct warnpct Optional. Specifies the warning percentage for the disk pool. The value must be
between 10 and 99. The value of warnpct should be equal to or less than that of
safepct. When the disk usage exceeds this percentage, a warning event is raised.
For a dedup diskpool pool, the warnpct cannot be more than 75%.

Description
Use this command to create a new disk pool object.

Example

$ udstask mkdiskpool -name pool_mkt -warnpct 70 -type perf -mdisk mdisk1:mdisk2

118 Actifio CLI Reference | actifio.com |

mkslp
The mkslp command creates a new profile object.

Rights
You must have the 'SLA Manage' right to create a profile.

Syntax
>>- udstask -- -- mkslp -- --+------------------------+-- -->
'- -description -- desc -'
>-- -name -- slp_name -- --+--------------------------+-- -->
'- dedupasyncnode -- node -'
>--+-----------------------+-- -performancepool -- pool ->
'- -org -+- org_id ---+-'
'- org_name -'
>--+-------------------------------------+-- --------------->
'- -primarystorage -- primarystorage -'
>--+-----------------------+-------------------------------><
'- -remotenode -- node -'
>--+-----------------------+-------------------------------><
'- -vaultpool -+- pool_id ---+-'
'- pool_name -'

Parameter Description

-dedupasyncnode node Optional. Specifies the name of the remote dedup-async node, remote
node is used if not specified.

-description desc Optional. Specifies the description for new profile.

-name name Required. Specifies the name for new profile. The name must be unique
within the Actifio appliance.

-org org_id | org_name Optional. Specifies a default organization in which the profile should be
added after creation. To use this, You must have 'System Manage' right.

-performancepool pool_name Required. Specifies the name of the performance pool.

-primarystorage Optional. Specifies the name of the primary storage.

primarystorage

-remotenode node Optional. Specifies the name of the remote appliance node.

| actifio.com | Actifio CLI Reference 119

 Parameter Description

-vaultpool pool_id | pool_name Optional. Specifies the name or ID of the Actifio vault storage pool.

Description
Use this command to create a new server level profile (SLP).

Example
$ udstask mkslp -performancepool mktpool -name "profile1"

120 Actifio CLI Reference | actifio.com |

rmdiskpool
The rmdiskpool command deletes a disk pool.

Rights
You must have the 'Storage Manage' right to delete a disk pool.

Syntax
>>- udstask -- -- rmdiskpool -- --+- diskpool_name -+----------><
'- diskpool_id ---'

Parameter Description

diskpool_id | diskpool_name Required. Specifies the ID or name of the diskpool to be deleted. Use the
udsinfo lsdiskpool command to locate the ID or name of the disk pool.

Description
Use this command to delete a disk pool.

Example
$ udstask rmdiskpool diskpool1

| actifio.com | Actifio CLI Reference 121

 rmslp
The rmslp command deletes a profile.

Rights
You must have the 'SLA Manage' right to delete a profile.

Syntax
>>- udstask -- -- rmslp -- --+- slp_name -+--------------------><
'- slp_id ---'

Parameter Description

slp_id | slp_name Required. Specifies the ID or name of the profile to be deleted.

Description
Use this command to delete a profile.

Example
$ udstask rmslp profile1

122 Actifio CLI Reference | actifio.com |

addcluster
The addcluster command adds an Actifio appliance to another Actifio appliance, either as part of a domain or added as
a dedup-only Actifio appliance.

Rights
You must have 'System Manage' right to add two Actifio appliances.

Note: Before adding two Actifio appliances, the appliances must exchange certificates to communicate securely.
Use the Actifio Desktop on each Actifio appliance to download and upload the security certificates.

Syntax
>>- udstask -- -- addcluster ----------------------------------->

>--+--------------+-- -- -ipaddress -- ipaddress --------------><

'- -deduponly -'

Parameter Description

-ipaddress ipaddress Required. Specifies the IP address of the Actifio appliance to add.

-deduponly Optional. Specifies whether the added Actifio appliance is used for dedup-only. The
default value is false.

Description
Use this command to add an Actifio appliance, either as part of a domain (which shares all Actifio appliance specific
data, such as organizations, templates, roles, and users), or to be used as a dedup-only Actifio appliance (which allows
for remote dedup or dedup-async target).

Example
$ udstask addcluster -deduponly -ipaddress 192.168.0.70

| actifio.com | Actifio CLI Reference 123

 addssd
The addrssd command adds a list of SSD device(s) to the Actifio CDS or Sky appliance.

Rights
You must have the 'System Manage' right to add SSD devices.

Syntax
>>- udstask -- -- addssd -- ------------------------------------>
>--+---------------------------+-- -- device_list -------------><
'- -component --+- pool_name --+
+- adhd -+

Parameter Description

-component Optional. Specifies the pool name or adhd (dedup) to add the SSD device(s) to the
pool_name | adhd Actifio Sky appliance. If a component is not specified, the specified devices is
designated as an SSD device, which is used for virtual SSD device that cannot be
automatically detected.
For the Actifio CDS appliance, the SSD device is added to the dedup engine only.

-device_list Required. For the Actifio Sky appliance, this is a comma (,) separated list of devices
to be added. For the Actifio CDS appliance, only one device can be specified.

Description
Use this command to add SSD devices to the Actifio CDS or Sky appliance.

Example
$ udstask addssd -component act_ded_pool000 pci-0000:03:00.0-scsi-0:0:3:0

124 Actifio CLI Reference | actifio.com |

certexchange

The certexchange command exchanges certificates with a remote Actifio appliance to establish a trusted relationship.

Rights
You should have the 'System Manage' right to exchange certificates.

Syntax
>>- udstask -- -- certexchange -- -ipaddress -- ipaddress -- ----------->

>-- -- -password -- password -------------------------------------------><

Parameter Description

-ipaddress Required. Specifies the IP address of the remote Actifio appliance.

ipaddress

-password Optional. Specifies the password for the user on the remote Actifio
password appliance.

Description
Use this command to exchanges certificates with a remote Actifio appliance to establish a trusted relationship for SSL.

Example
$ udstask certexchange -ipaddress 192.168.16.10 -password secret

| actifio.com | Actifio CLI Reference 125

 chjob
The chjob command changes the attribute of a running job.

Rights
You should have the 'System Manage', or ‘Application Manage’ or ‘Host Manage’ right to change the attribute of a job.

Syntax
>>- udstask -- -- chjob -- --+------------------------------+--->
'- -changerequest --+- cancel --+
>--+-------------------------+-- --+- job_name -+--------------><
'- -priority --+- low ----+ '- job_id ---'
+- medium -+
'- high ---'

Parameter Description

-changerequest Optional. Specifies a change request for a job. The allowed value is cancel. .
cancel

-priority Optional. Specifies the priority of a job.

low | medium | high

job_id | job_name Required. Specifies the ID or name of the job to be modified.

Description
Use this command to change the attribute of a running job. Use udsinfo lsjob to obtain the ID or name of the job.

Example
$ udstask chjob -changerequest cancel Job_0001045

126 Actifio CLI Reference | actifio.com |

chcluster
The chcluster command changes the attributes of an Actifio appliance.

Rights
You should have the 'System Manage' right to modify the attributes of an Actifio appliance.

Syntax
>>- udstask -- -- chcluster -- --+---------------------------+-->
'- -bandwidth -- bandwidth -'
>--+----------------------------+-- ---------------------------->
'- -bwschedule --+- true --+-'
'- false -'
>--+--------------------+-- --+------------------------+-- ----->
'- -datastore -- ds -' '- -description -- desc -'
>--+----------------------------+-- --+-------------------+-- -->
'- -defaultdiskpool -- pool -' '- -esxhost -- esx -'
>--+--------------------+-- --+----------------------+-- ------->
'- -ipaddress -- ip -' '- -operativeip -- ip -'
>--+--------------------+-- --+-------------------------+-- ---->
'- -location -- loc -' '- -readyvm --+- true --+-'
'- false -'
>--+-------------------------+-- ------------------------------->
'- -streamsnapbw -- bandwidth -'
>--+-------------------------+-- --+-------------------------+-->
'- -timezone -- timezone -' '- -name -- cluster_name -'

>--+-----------------------+-- -- --+- cluster_name -+---------><

'- -vcenter -- vcenter -' '- cluster_id ---'

Parameter Description

-bandwidth Optional. Specifies out-going bandwidth limit used by dedup for the Actifio
bandwidth appliance, in Mb. Enter 0 to indicate unlimited bandwidth.

-bwschedule Optional. Specifies whether bandwidth schedule for the Actifio appliance should be
true | false enabled. Setting this to false will cause the bandwidth schedule to be suspended
for the appliance.

-datastore datastore Optional. Specifies data store to be used when replicating VM to a data store during
dedup-async operation. This applies to Virtual Machine replication if readyvm is true.

| actifio.com | Actifio CLI Reference 127

 Parameter Description

-defaultdiskpool Optional. Specifies the default disk pool name for the specified Actifio appliance.
diskpool This is the pool to be used for remote target (such as dedup-async) appliance.

-description desc Optional. Specifies the description of the Actifio appliance.

-esxhost esx Optional. Specifies ESX host to be used when replicating VM to a data store during
dedup-async operation. This applies to Virtual Machine replication if readyvm is true.

-location loc Optional. Specifies the location of the Actifio appliance.

-operativeip ip Optional. Specifies the IP address for communication with remote Actifio appliance,
typically the same as IP address.

-ipaddress ip Optional. Specifies the new IP address for the Actifio appliance.

Note: For the SVC, the cluster IP of port 1 is also changed, if applicable.

-readyvm Optional. Specifies whether a VM should be ready to fail-over for dedup-async

true | false replication. It is applied to Virtual Machine dedup-async replication only, if set to
true. And affects only subsequent first dedup-async replication.

-streamsnapbw Optional. Specifies outgoing bandwidth limit (in Mb/s) to the specified Actifio
bandwidth appliance for StreamSnap replication. Enter 0 to indicate unlimited bandwidth.

-timezone timezone Optional. Specifies a new timezone.

• For the Actifio Sky appliance, the timezone entry must be a valid
timezone path (for example, "America/Chicago").
• For the Actifio CDS appliance, the timezone must be a valid timezone
value.

Note: Use the usvcinfo lstimezones command to find the appropriate timezone
for the Actifio appliance.

-name cluster_name Optional. Specifies a new name for the Actifio appliance.

-vcenter vcenter Optional. Specifies vCenter to be used when replicating VM to a datastore during
dedup-async operation. This applies to Virtual Machine replication if readyvm is true.

cluster_id | Required. Specifies the ID or name of the Actifio appliance to be changed. Use
cluster_name udsinfo lscluster to retrieve the ID or name of the Actifio appliance.

128 Actifio CLI Reference | actifio.com |

Description
Use this command to change the properties of an Actifio appliance.

Example
$ udstask chcluster -bandwidth 2 cluster1

| actifio.com | Actifio CLI Reference 129

 configssl
The configssl command uploads a new SSL certificate for Actifio Desktop to communicate with the Actifio appliance.

Rights
You should have the 'System Manage' right to upload the certificate.

Syntax
>>- udstask -- -- configssl -- -- -certfile -- file_name ------><

Parameter Description

-certfile file_name Required. Specifies the file name of the certificate to be used.

Description
Use this command to configure a new certificate for the Actifio Desktop to communicate with the Actifio appliance.
After the successful completion of this command, all active Actifio Desktop sessions are restarted.

Example
$ udstask configssl -certfile /tmp/foo.pem

130 Actifio CLI Reference | actifio.com |

getparameter
The getparameter command retrieves parameters in the Actifio appliance. You use the setparameter command to
set system parameters for the Actifio appliance (see setparameter on page 168).

Note: Prior to changing any system parameters outlined in the table below, please consult your Actifio
representative.

Rights
You should have the 'System Manage' or 'System View' right to view the Actifio appliance parameters.

Syntax
>>- udsinfo -- -- getparameter -- --+-----------------------+--->
'- -delim -- delimiter -'
>--+-------------------+-- --+--------------------------+------><
'- -param -- param -' '- -type --+- backup -+-- -'
'- dedup --'
'- psrv ---'
'- udppm --'

Parameter Description

-delim delimiter Optional. Specifies the delimiter to be used when displaying the results. The
default value is a space (' ') character.

-param param Optional. Specifies the name of the parameter to retrieve the value. If you do not
use this option, it displays all the Actifio appliance parameters with their values.

-type Optional. Specifies the type of system parameter.

backup | dedup | psrv |
udppm

Description
Use this command to display the Actifio appliance parameters and their values. These system parameters are detailed
in Appendix D, List of Parameters Used With getparameter and setparameter.

Example
$ udsinfo getparameter -delim =
reservedrdedupslots=3
reservedldedupslots=3
unreservedslots=12
reservedexpirationslots=3
reservedondemandslots=3
reserveddarslots=3
reservedsnapslots=3

| actifio.com | Actifio CLI Reference 131

 getgcschedule
The getgcschedule command retrieves a specific garbage collection schedule.

Rights
You should have the 'System View' or 'System Manage' right to view the garbage collection schedule.

Syntax
>>- udsinfo -- -- getgcschedule -- --+-----------------------+-->
'- -delim -- delimiter -'

>-- -type --+- gc -----+---------------------------------------><

'- sweep --'
'- igc ----'
'- isweep -'

Parameter Description

-delim delimiter Optional. Specifies the delimiter to be used when displaying the results. The
default delimiter is a space (' ').

-type gc | sweep | igc | Required. Specifies the type of GC schedule.

isweep

Description
Use this command to display garbage collection schedules.

Example
$ udsinfo getgcschedule -type gc
frequency weekly
repeatinterval 2
interval 3
time 02:00

132 Actifio CLI Reference | actifio.com |

getschedule
The getschedule command retrieves specified schedule.

Rights
You should have the 'System View' or 'System Manage' right to view the schedule.

Syntax
>>- udsinfo -- -- getschedule -- --+-----------------------+---->
'- -delim -- delimiter -'
>-- -name --+- archive -------+--------------------------------><
'- storagestatus -'

Parameter Description

-delim delimiter Optional. Specifies the delimiter to be used when displaying the results. The
default delimiter is a space (' ').

-name archive | Required. Specifies the name of the schedule.

storagestatus

Description
Use this command to display a schedule.

Example
$ udsinfo getgcschedule -name archive
frequency weekly
repeatinterval 2
day 3
time 02:00

| actifio.com | Actifio CLI Reference 133

 getsysteminfo
The getsysteminfo command returns a unique fingerprint of the Actifio appliance which is used when applying an
Actifio software license. A software license is required by some Actifio products, such as the Actifio Sky appliance.

Rights
You should have the 'System View' or 'System Manage' right to view the schedule.

Syntax
>>- udsinfo -- -- getsysteminfo -- --+-----------------------+---->

Description
Use this command to return a unique fingerprint of the Actifio appliance. This fingerprint is used when applying an
Actifio software license. A software license is required by some Actifio products, such as the Actifio Sky appliance.

Example
$ udsinfo getsysteminfo
590021132492:ae8a7053-82c4-31bd-9bbe-8eecff12f6ef:8ea3a625

134 Actifio CLI Reference | actifio.com |

installtrustedcertificate
The installtrustedcertificate command installs/replaces SSL server certificate on Actifio appliance server for HTTPS
communication.

Rights
There are no specific rights associated with this operation. Admin/User with 'administrator' role can install the trusted
certificate on to the Actifio appliance server.

Syntax
>>- udstask -- -- installtrustedcertificate -- ----------------->
>-- -- -certfile -- cert_file -- -- -keyfile -- key_file ------><

Parameter Description

-certfile certfile Required. Specifies the filename of the certificate(s). The certificate(s) should be in
PEM formats. All certificates that build up the trust chain need to be concatenated
together in this file. Typically they include one SSL certificate, an intermediate CA
certificate and a root CA certificate. If any of the certificates is missing, the
command will fail.

--keyfile keyfile Required. Specifies the filename of the private key. The key should be in raw format
(not encrypted).

Description
Use this command to install a SSL server certificate on the Actifio appliance. The certificate and key files have to be in
"/home/admin/upload".
The installtrustedcertificate also restarts tomcat, resulting all active GUI sessions to be lost.
If the certificate is not a wildcard certificate, this command also updates the GUI links to have consistent hostname as
the one defined in certificate's Subject attribute. Please make sure the certificate has the right hostname resolves to
the IP address of the CDS.

Example
$ udstask installtrustedcertificate -certfile cert.pem -keyfile key.pem

| actifio.com | Actifio CLI Reference 135

 joincluster
The joincluster command joins an Actifio appliance to another Actifio appliance, forming a domain.

Rights
You must have the 'System Manage' right to join two Actifio appliances.

Syntax
>>- udstask -- -- joincluster -- -- -ipaddress -- ip ----------><

Parameter Description

-ipaddress ip Required. Specifies the IP address of the Actifio appliance to join to.

Description
Use this command to join two Actifio appliances. Prior to joining, the two Actifio appliances should exchange security
certificates to allow secure communication between them. Use Actifio Desktop to download and upload the security
certificates.
When an Actifio appliance joins another appliance, the former becomes the slave and the later, the master. The slave
appliance takes on the shared data of the master appliance. The shared data includes users, roles, organizations, and
templates. You may want to review the shared data on the slave, as it may be removed after joining the master, if it is
not present on the master already.
Example: When the joinappliance command is executed on the 'seattle' appliance to join the 'boston' appliance, the
'boston' appliance becomes the master and seattle, the slave. After the join operation, both 'seattle' and 'boston'
appliance will contain the same shared data, that is, users, roles, organizations, and templates.

Example
$ udstask joincluster -ipaddress 192.168.0.70

136 Actifio CLI Reference | actifio.com |

lsaudit
The lsaudit command returns a concise list of system audit trail data, or a detailed view of a system audit trail data

Rights
You must have 'System Manage', or 'System View' rights to be able to retrieve audit trail data.

Syntax
>>- udsinfo -- -- lsaudit -- ---------------------------------->
>--+--------------------------------+-- --+----------+-- ------->
'- -filtervalue -- attrib=value -' '- -nohdr -'
>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+
'- object_name -'

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim: on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

| actifio.com | Actifio CLI Reference 137

 Parameter Description

-filtervalue Optional. Specifies that you want your report to display any or all of the list of valid
attrib=value filter attributes. The valid filter attributes for the udsinfo lsaudit command are:
• command
• component
• ipaddress
• issuedate [usage: 'issuedate since 24 hours' for audited logs since last
24 hours, ‘issuedate before 7 days' for audited logs older than 7 days]
• status
• username
The filter will be formed with an attribute and a value. When specifying more than
one filter, the filters must be combined with '&' character (which needs to be
escaped with '\').
For string type of filters, the only operator allowed is '='. You can also use the
wildcard character '*'. For example, to match disk pools with name begins with
'foo', use '-filtervalue name=foo*'.
For numbers and date types, allowed operators are: =, >, >=, <, <=. These must
be escaped with '\' or enclosed in ' or ", as required by shell. For example:
* -filtervalue status\>0
* -filtervalue "status>0"
* -filtervalue 'status>0'
Date parameter issuedate can also use these operators, for example,
• -filtervalue 'issuedate>2010-09-28'
• -filtervalue 'issuedate>2010-09-28 6:50:00'

-nohdr Optional. By default, headings are displayed for each column of data in the concise
view, and for each item of data in the detailed view. The -nohdr parameter
suppresses the display of headings.If there is no data to display, headings are not
displayed.

object_id | Optional. Specifies the name or ID of an object. When you use this parameter, a
object_name detailed view of the object is returned and any value specified by the 
-filtervalue parameter is ignored. If you do not specify the object_id or the
object_name parameter, a concise view of all objects matching the filter criteria is
displayed.

138 Actifio CLI Reference | actifio.com |

Description
Use this command to retrieve details of audit trail data.

Example
$ udsinfo lsaudit
id username status component issuedate proxy command ipaddress
4271 admin 0 UI 2012-11-19 05:50:08.738 login admin
4270 admin 0 udstask 2012-11-19 05:47:29.720 chhost -ipaddress 172.17.4.73 51

| actifio.com | Actifio CLI Reference 139

 lscluster
The lscluster command displays a concise list of Actifio appliances or a detailed view of an Actifio appliance.

Rights
You must have the 'System View' or 'System Manage' right to retrieve details of an Actifio appliance.

Syntax
>>- udsinfo -- -- lscluster -- --------------------------------->

>--+--------------------------------+-- --+----------+-- ------->

'- -filtervalue -- attrib=value -' '- -nohdr -'

>--+-----------------------+-- --+---------------+-------------><
'- -delim -- delimiter -' +- object_id ---+
'- object_name -'

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim: on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

-filtervalue Optional. Specifies that you want your report to display any or the entire list of valid
attrib=value filter attributes. The valid filter attributes for the udsinfo lscluster command are:
• clusterid
• bandwidth
• dedupid
• defaultdiskpool
• description
• ipaddress
• masterid
• name
• streamsnapbw
• thisisme
The filter is formed with an attribute and a value. When specifying more than one
filter, the filters must be combined with the '&' character (which needs to be
escaped with '\'). For string type of filters, the only operator allowed is '='. You can
also use wild card character '*'. For example, to list all appliances with a name that
begins with 'foo', use '-filtervalue lscluster=foo*'.

140 Actifio CLI Reference | actifio.com |

 Parameter Description

-nohdr Optional. By default, headings are displayed for each column of data in the concise
view, and for each item of data in the detailed view. The -nohdr parameter
suppresses the display of headings. If there is no data to display, headings are not
displayed.

object_id | Optional. Specifies the name or ID of an object. When you use this parameter, a
object_name detailed view of the object is returned aand any value specified by the 
-filtervalue parameter is ignored. If you do not specify the object_id or the
object_name parameter, a concise view of all objects matching the filter criteria is
displayed.

Description
Use this command to retrieve details of an Actifio appliance. There is only one Actifio appliance that describes the
local appliance with the name 'thisisme'. All other Actifio appliances are added or joined from remote appliances. Use
the udstask joincluster or udstask joincluster command to add an Actifio appliance to an existing appliance.

Example
$ udsinfo lscluster
id vcenter bwschedule location dedupid clusterid defaultdiskpool ipaddress datastore
bandwidth description name thisisme esxhost masterid readyvm override disabled props
operativeip
11 true 126 590023229566 act_per_pool000 192.168.17.151 0
longoffcluster true 590023229566 false false false sharing 192.168.17.151
155225 true 124 590044201084 act_per_pool000 192.168.17.140
0 midoncluster false 590023229566 false false false sharing
192.168.17.140

| actifio.com | Actifio CLI Reference 141

 lsdeduppoolstat
The lsdeduppoolstat command returns a concise list of deduppoolstats, or a detailed view of a deduppoolstat.

Rights
You must have 'System View' or 'System Manage' rights to be able to retrieve deduppoolstat data.

Syntax
>>- udsinfo -- -- lsdeduppoolstat -- --------------------------->

>--+--------------------------------+-- --+----------+-- ------->

'- -filtervalue -- attrib=value -' '- -nohdr -'

>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim : on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

142 Actifio CLI Reference | actifio.com |

 Parameter Description

-filtervalue Optional. Specifies that you want your report to display any or all of the list of valid
attrib=value filter attributes. The valid filter attributes for the udsinfo lsdeduppoolstat
command are:
• stattime
• sourcecluster
• appid
• hostname
• appname
• dedupusage
• totalappsize
• appsize
• newsize
• dedupsize
• compresssize
• dedupcount
The filter will be formed with an attribute and a value. When specifying more than
one filter, the filters must be combined with '&' character (which needs to be
escaped with '\').
For string type of filters, the only operator allowed is '='. You can also use the
wildcard character '*'. For example, to match disk pools with name begins with
'foo', use '-filtervalue name=foo*'.
For number types, allowed operators are: =, >, >=, <, <=. These must be escaped
with '\' or enclosed in ' or ", as required by shell. For example:
• -filtervalue dedupcount\>=80
• -filtervalue "dedupcount>=80"
• -filtervalue 'dedupcount>=80'

-nohdr Optional. By default, headings are displayed for each column of data in the concise
view, and for each item of data in the detailed view. The -nohdr parameter
suppresses the display of headings. If there is no data to display, headings are not
displayed.

object_id | Optional. Specifies the name or ID of an object. When you use this parameter, a
object_name detailed view of the object is returned and any value that is specified by the -filter
value parameter is ignored. If you do not specify the object_id or the object_name
parameter, a concise view of all objects matching the filter criteria is displayed.

| actifio.com | Actifio CLI Reference 143

 Description
Use this command to retrieve statistics of deduppool usage for each protected applications. The statistics are
collected once a day.

Example
$ udsinfo lsdeduppoolstat
id appsize dedupusage appid hostname dedupcount dedupsize compresssize
sourcecluster appname newsize stattime totalappsize
14932 21474836480 892615000064 4410 archer2 150 337427021280 336327413456
590027423756 bigdedupapp 335915581440 2013-02-08 03:00:07.250 217026076672
14933 18351967232 892615000064 4283 haymarket 4 10350106592 10315705632
590021132306 T:\ 10239672320 2013-02-08 03:00:07.258 217026076672
14934 10758666240 892615000064 4359 archer5 80 5033376160 2439031440
590027423756 Archer5 10868031488 2013-02-08 03:00:07.266 217026076672
14935 53687091200 892615000064 4418 archer2 14 111673676768 111259184032
590027423756 50GB 166265618432 2013-02-08 03:00:07.275 217026076672
14936 5379333120 892615000064 4357 archer4 80 3102725248 1789986960
590027423756 Archer4 5584125952 2013-02-08 03:00:07.281 217026076672
14937 107374182400 892615000064 4361 linuxsystem 80 33474176 477600
590027423756 LinuxSystem 107363762176 2013-02-08 03:00:07.291 217026076672

144 Actifio CLI Reference | actifio.com |

lsdedupefficiency
The lsdedupefficiency command returns a dedup efficiency stats for a list of applications with successful local dedup,
direct dedup or dedup-async jobs.The average FIDI and IIDI are average value for all applications in the system.

Rights
You must have 'System View' or ‘System Manage’ rights to view the dedup efficiency data.

Syntax
>>- udsinfo -- -- lsdedupefficiency -- -------------------------------->
>--+----------+------------------+-- --+-----------------+----- -------><
'- -nohdr -' '- -delim -- delimiter -'

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim : on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

-nohdr Optional. By default, headings are displayed for each column of data in the concise
view, and for each item of data in the detailed view. The -nohdr parameter
suppresses the display of headings. If there is no data to display, headings are not
displayed.

Description
Use this command to retrieve dedup efficiency statistics for all applications with dedup jobs. The statistics are
collected once a day and are also updated when this command is run.

Example
$ udsinfo lsdedupefficiency
id appid baseappsize avgingestion avgFIDI avgIIDI lastjobenddate
1051651 26580 0.00 123.00 0.073928 0.115705 2015-02-12 20:24:39.0
1051652 26644 0.00 220.00 0.073928 0.115705 2015-02-12 20:20:09.0
1051665 987036 61440.00 0.00 0.073928 0.115705 2015-02-11 22:48:36.0
1051661 986520 40960.00 0.00 0.073928 0.115705 2015-02-12 20:25:59.0
1051660 986006 40960.00 396.00 0.073928 0.115705 2015-02-12 18:42:14.0
1051668 987471 40960.00 547.00 0.073928 0.115705 2015-02-11 22:17:29.0

| actifio.com | Actifio CLI Reference 145

 lsdedupstat
The lsdedupstat command returns a concise list of dedupstats, or a detailed view of a dedupstat.

Rights
You must have 'System View' or 'System Manage' rights to be able to view dedupstat data.

Syntax
>>- udsinfo -- -- lsdedupstat -- -------------------------------->

>--+--------------------------------+-- --+----------+-- ------->

'- -filtervalue -- attrib=value -' '- -nohdr -'

>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim: on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

146 Actifio CLI Reference | actifio.com |

 Parameter Description

-filtervalue Optional. Specifies that you want your report to display any or all of the list of valid
attrib=value filter attributes. The valid filter attributes for the udsinfo lsdedupstat command
are:
• stattime
• storage
• capacity
• used
• nobjects
• objectsizeold
• objectsizeyoung
• deletedsizeold
• deletedsizeyoung
• sweepablenext
• sweepableremain
• incsweepablenext
• incsweepableremain
• indexedhashes
• diffaddedold
• diffaddedyoung
• diffdivestedold
• diffdivestedyoung
The filter will be formed with an attribute and a value. When specifying more than
one filter, the filters must be combined with '&' character (which needs to be
escaped with '\').
For string type of filters, the only operator allowed is '='. You can also use the
wildcard character '*'. For example, to match disk pools with name begins with
'foo', use '-filtervalue name=foo*'.
For number types, allowed operators are: =, >, >=, <, <=. To use <, <=,
>, or >=, they need to be escaped with '\' or enclosed in ' or ", as
required by shell. For example:
* -filtervalue used\>=3034385612800
* -filtervalue "used>=3034385612800"
* -filtervalue 'used>=3034385612800'

-nohdr Optional. By default, headings are displayed for each column of data in the concise
view, and for each item of data in the detailed view. The -nohdr parameter
suppresses the display of headings.If there is no data to display, headings are not
displayed.

| actifio.com | Actifio CLI Reference 147

 Parameter Description

object_id Optional. Specifies the ID of an object. When you use this parameter, a detailed
view of the object is returned and any value that is specified by the -filtervalue
parameter is ignored. If you do not specify the object_id parameter, a concise view
of all objects matching the filter criteria is displayed.

Description
Use this command to retrieve statistics of dedup. The statistics are collected once a day.

Example
$ udsinfo lsdedupstat 236252
id 236252
deletedsizeyoung 3859671622656
incsweepablenext 490328555520
indexedhashes 0
objectsizeold 52736042762752
sweepablenext 1102728658944
incsweepableremain 0
nobjects 1316
used 3034385612800
sweepableremain 197375557632
diffaddedyoung 407519911936
diffdivestedold 8334501105664
diffaddedold 1088713880064
stattime 2013-02-19 12:15:00.446
capacity 139637976727552
diffdivestedyoung 127556575232
objectsizeyoung 19470735114240
deletedsizeold 20034790638592
storage 8796093022208

148 Actifio CLI Reference | actifio.com |

lsdiskpoolstat
The lsdiskpoolstat command returns a concise list of diskpoolstats, or a detailed view of a diskpoolstat.

Rights
You must have 'System View' or 'System Manage' rights to be able to retrieve diskpoolstat data.

Syntax
>>- udsinfo -- -- lsdiskpoolstat -- ---------------------------->

>--+--------------------------------+-- --+----------+-- ------->

'- -filtervalue -- attrib=value -' '- -nohdr -'

>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim : on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

-nohdr Optional. By default, headings are displayed for each column of data in the concise
view, and for each item of data in the detailed view. The -nohdr parameter
suppresses the display of headings. If there is no data to display, headings are not
displayed.

object_id Optional. Specifies the ID of an object. When you use this parameter, a detailed
view of the object is returned and any value that is specified by the -filtervalue
parameter is ignored. If you do not specify the object_id or the object_name
parameter, a concise view of all objects matching the filter criteria is displayed.

| actifio.com | Actifio CLI Reference 149

 Parameter Description

-filtervalue Optional. Specifies that you want your report to display any or all of the list of valid
attrib=value filter attributes. The valid filter attributes for the udsinfo lsdiskpoolstat command
are:
• stattime
• poolname
• pooltype
• capacity
• used
The filter will be formed with an attribute and a value. When specifying more than
one filter, the filters must be combined with '&' character (which needs to be
escaped with '\').
For string type of filters, the only operator allowed is '='. You can also use the
wildcard character '*'. For example, to match disk pools with name begins with
'foo', use '-filtervalue name=foo*'.
For number types, allowed operators are: =, >, >=, <, <=. These must be escaped
with '\' or enclosed in ' or ", as required by shell. For example:
* -filtervalue pooltype\>=1
* -filtervalue "pooltype>=1"
* -filtervalue 'pooltype>=1'

Description
Use this command to retrieve statistics of deduppool usage for each protected applications. The statistics are
collected once a day.
Use this command to retrieve statistics of an Actifio appliance's disk pools. The stats shows disk's capacity, used
space and free space by pool type. The statistics are collected once a day. To see the details on diskpools use udsinfo
diskpool command.

Example
$ udsinfo lsdiskpoolstat
id pooltype capacity stattime poolname used
14923 1 107374182400 2013-02-08 03:00:00.044 act_pri_pool000 12884901888
14924 2 8796093022208 2013-02-08 03:00:00.044 act_ded_pool000 892615000064
14925 3 1099511627776 2013-02-08 03:00:00.044 act_per_pool000 191126044672
35258 1 107374182400 2013-02-09 03:00:00.058 act_pri_pool000 12884901888
35259 2 8796093022208 2013-02-09 03:00:00.058 act_ded_pool000 1997716652032
35260 3 1099511627776 2013-02-09 03:00:00.058 act_per_pool000 163208757248

150 Actifio CLI Reference | actifio.com |

lssnappoolstat
The lssnappoolstat command returns a concise list of snap pools, or a detailed view of a snap pool.

Rights
You must have 'System View' or 'System Manage' rights to be able to retrieve snappoolstat data.

Syntax
>>- udsinfo -- -- lssnappoolstat -- ---------------------------->

>--+--------------------------------+-- --+----------+-- ------->

'- -filtervalue -- attrib=value -' '- -nohdr -'

>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim : on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

-nohdr Optional. By default, headings are displayed for each column of data in the concise
view, and for each item of data in the detailed view. The -nohdr parameter
suppresses the display of headings. If there is no data to display, headings are not
displayed.

| actifio.com | Actifio CLI Reference 151

 Parameter Description

object_id | Optional. Specifies the name or ID of an object. When you use this parameter, a
object_name detailed view of the object is returned and any value that is specified by the -filter
value parameter is ignored. If you do not specify the object_id or the object_name
parameter, a concise view of all objects matching the filter criteria is displayed.

-filtervalue Optional. Specifies that you want your report to display any or all of the list of valid
attrib=value filter attributes. The valid filter attributes for the udsinfo lssnappoolstat command
are:
• sourcecluster
• appid
• hostname
• appname
• appsize
• vdiskcount
• totalused
• totalstaging
The filter will be formed with an attribute and a value. When specifying more than
one filter, the filters must be combined with '&' character (which needs to be
escaped with '\').

For string type of filters, the only operator allowed is '='. You can also use the
wildcard character '*'. For example, to match disk pools with name begins with
'foo', use '-filtervalue name=foo*'.

For number types, allowed operators are: =, >, >=, <, <=. These must be escaped
with '\' or enclosed in ' or ", as required by shell. For example:
• -filtervalue vdiskcount\>=10
• -filtervalue "vdiskcount>=10"
• -filtervalue 'vdiskcount>=10'

152 Actifio CLI Reference | actifio.com |

Description
Use this command to retrieve statistics of snapshotpool usage for each protected applications in the appliance. The
statistics are collected once a day.

Example
$udsinfo lssnappoolstat
id appsize appname sourcecluster vdiskcount hostname appid stattime
totalused totalstaging
14926 21474836480 bigdedupapp 590027423756 19 archer2 4410 2013-02-08
03:00:07.056 35573465088 0
14927 10737418240 testapp 590027423756 1 archer3 5495 2013-02-08
03:00:07.137 2359296 0
14928 10758666240 Archer5 590027423756 10 archer5 4359 2013-02-08
03:00:07.155 10786701312 10761535488
14929 53687091200 50GB 590027423756 22 archer2 4418 2013-02-08
03:00:07.182 56952094720 0
14930 5379333120 Archer4 590027423756 10 archer4 4357 2013-02-08
03:00:07.196 5433720832 5381029888
14931 107374182400 LinuxSystem 590027423756 10 linuxsystem 4361 2013-02-08
03:00:07.224 7864320 786432

| actifio.com | Actifio CLI Reference 153

 lsjob
The lsjob command displays a concise list of jobs or a detailed view of a job.

Rights
You should have 'Storage View' or 'Storage Manage' or ‘Application Manage’ or ‘Host Manage’ right to view the details
of job.

Syntax

>>- udsinfo -- -- lsjob -- ------------------------------------->

>--+--------------------------------+-- --+----------+-- ------->

'- -filtervalue -- attrib=value -' '- -nohdr -'

>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+
'- object_name -'

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim : on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter

-nohdr Optional. By default, headings are displayed for each column of data in the concise
view, and for each item of data in the detailed view. The -nohdr parameter
suppresses the display of headings. If there is no data to display, headings are not
displayed.

object_id | Optional. Specifies the name or ID of an object. When you use this parameter, a
object_name detailed view of the object is returned and any value specified by the 
-filtervalue parameter is ignored. If you do not specify the object_id or the
object_name parameter, a concise view of all objects matching the filter criteria is
displayed.

154 Actifio CLI Reference | actifio.com |

 Parameter Description

-filtervalue Optional. Specifies that you want your report to display any or the entire list of valid
attrib=value filter attributes. The valid filter attributes for the udsinfo lsjob command are:
• appid
• appname
• component
• enddate
• errorcode
• expirationdate
• hostname
• isscheduled [true | false]
• jobclass [ [ snapshot | dedup | expiration | gc | mount | unmount | clone |
restore | delete | syncback | unmount-delete | remote-dedup | remote-
restore | remote-clone | remote-mount | liveclone | refreshliveclone |
failover | failovertest | deletetest | failback | directdedup | seedin | seedout
| verification | rollbackliveclone]
• jobname
• jobtag
• parentid
• policyname
• priority
• progress
• queuedate
• relativesize
• retrycount
• sltname
• startdate
• status [ running | queued | paused | interrupted | stalled]
• sourceid
• virtualsize

| actifio.com | Actifio CLI Reference 155

 Parameter Description

-filtervalue The filter is formed with an attribute and a value. When you specify more than one
attrib=value filter, they must be combined with '&' character (which should be escaped with '\').
(continued) For string type of filters, the only operator allowed is '='. You can also use wild card
character '*'. For example, to list all jobs with a job name that begins with
'Job_0001', use '-filter value jobname=Job_0001*'.
Some filters allow only predefined constants. For example, status allows only
running, queued, paused, interrupted, or stalled, to match job status that is running,
used '- filtervalue status=running'.
For number and date types, allowed operators are: =, >, >=, <, <=. These must be
escaped with '\' or enclosed in ''or "", as required by the shell. For example,
-filtervalue errorcode\>0
-filtervalue "errorcode>0"
-filtervalue 'errorcode>0'
The expirationdate, queuedate, startdate, and enddate parameters can also use
these operators. For example:
-filtervalue 'startdate>2010-09-28'
-filtervalue 'expirationdate>2010-09-28 6:50:00'
Note that a job may have sub-jobs. To filter out sub-jobs, it is common to use "-
filtervalue parentid=0" to list the top level jobs.

Description
Use this command to retrieve the details of jobs.

Example
$ udsinfo lsjob -delim = 13133
id=13133
progress=26
virtualsize=100
queuedate=2010-08-12 10:40:51.918
jobname=Job_0013133
expirationdate=2010-08-12 11:40:51.918
parentid=0
policyname=editpolicy
jobcount=0
component=udp
description=
changerequest=IGNORE
priority=5
isscheduled=true

156 Actifio CLI Reference | actifio.com |

jobclass=snapshot
status=running
relativesize=100
hostname=chandnichowk
pid=5093
retrycount=0
startdate=2010-08-12 10:40:51.918
sltname=editslt
appname=M:\
sourceid=
errorcode=0
enddate=

| actifio.com | Actifio CLI Reference 157

 lsjobhistory
The lsjobhistory command displays a list of jobs and their details based on a filter or the detailed view of a job.

Rights
You should have 'Storage View' or 'Storage Manage' or ‘Application Manage’ or ‘Host Manage’ right to view the details
of job.

Syntax
>>- udsinfo -- -- lsjobhistory -- ------------------------------>

>--+--------------------------------+-- --+----------+-- ------->

'- -filtervalue -- attrib=value -' '- -nohdr -'

>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+
'- object_name -'

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim : on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

-nohdr Optional. By default, headings are displayed for each column of data in the concise
view, and for each item of data in the detailed view. The -nohdr parameter
suppresses the display of headings.If there is no data to display, headings are not
displayed.

object_id | Optional. Specifies the name or ID of an object. When you use this parameter, a
object_name detailed view of the object is returned and any value specified by the 
-filtervalue parameter is ignored. If you do not specify the object_id or the
object_name parameter, a concise view of all objects matching the filter criteria is
displayed.

158 Actifio CLI Reference | actifio.com |

 Parameter Description

-filtervalue Optional. Specifies that you want your report to display any or the entire list of valid
attrib=value filter attributes. The valid filter attributes for the udsinfo lsjobhistory command are:
• appid
• appname
• enddate [ usage: 'enddate since 24 hours' for jobs started since last 24
hours, 'enddate before 7 days' for jobs started older than 7 days ]
• errorcode
• expiration
• hostname
• isscheduled [ true | false ]
• isexpired [ true | false ]
• jobclass [ snapshot | dedup | expiration | gc | mount | unmount | clone |
restore | delete | syncback | unmount-delete | remote-dedup | remote-
restore | remote-clone | remote-mount | createliveclone | refreshliveclone
| failover | failovertest | deletetest | failback | directdedup | seedin |
seedout | verification | rollbackliveclone]
• jobname
• jobtag
• policyname
• priority
• relativesize
• sltname
• sourceid
• status [ succeeded | failed | canceled ]
• startdate [ usage: 'startdate since 24 hours' for jobs started since last 24
hours, 'startdate before 7 days' for jobs started older than 7 days]
The filter is formed with an attribute and a value. When you specify more than one
filter, they must be combined with the '&' character (which should be escaped with
'\').
For string type of filters, the only operator allowed is '='. You can also use the wild
card character '*'.
For example, to list all jobs with a jobname that begins with 'Job_0001', use '-
filtervalue jobname=Job_0001*'.

| actifio.com | Actifio CLI Reference 159

 Parameter Description

-filtervalue Some filters allow only predefined constants. For example, status allows only
attrib=value running, queued, paused, interrupted, or stalled, to match job status that is running,
(continued) used '-filtervalue status=running'.
For number and date types, allowed operators are: =, >, >=, <, <=. To use <, <=, >,
or >=, they should be escaped with '\' or enclosed in ''or "", as required by the shell:
• -filtervalue errorcode\>0
• -filtervalue "errorcode>0"
• -filtervalue 'errorcode>0'
The expirationdate, queuedate, startdate, and enddate parameters can also use
these operators. For example:
• -filtervalue startdate\>"2010-01-01 00:00:00"
• -filtervalue startdate\>2010-01-01

Description
Use this command to retrieve the details of job histories.

Example
$ udsinfo lsjobhistory -delim : 4487
id 4487
virtualsize 100
jobclass expiration
jobname Job_0004485
status succeeded
expiration 2010-09-17 16:11:14.000
isexpired true
hostname tuvok
policyname Policy2
message Success
startdate 2010-09-17 16:11:15.126
sltname Stemplate1
priority 1
appname E:\
isscheduled true
errorcode 0
enddate 2010-09-17 16:11:15.808
sourceid Image_0004130
duration 0:0:0

160 Actifio CLI Reference | actifio.com |

$ udsinfo lsjobhistory -filtervalue 'startdate since 24 hours'
id jobname startdate enddate duration hostname appname jobclass status expiration
4487 Job_0004485 2010-09-17 16:11:15.126 2010-09-17 16:11:15.808 0:0:0 tuvok E:\
expiration succeeded 2010-09-17 16:11:14.0
4488 Job_0004486 2010-09-17 16:11:15.41 2010-09-17 16:11:16.247 0:0:0 tuvok E:\
expiration succeeded 2010-09-17 16:11:13.952
4491 Job_0004489 2010-09-17 16:11:36.111 2010-09-17 16:11:36.779 0:0:0 paris F:\
expiration succeeded 2010-09-17 16:11:35.0
4492 Job_0004490 2010-09-17 16:11:36.391 2010-09-17 16:11:37.235 0:0:0 paris F:\
expiration succeeded 2010-09-17 16:11:34.448

| actifio.com | Actifio CLI Reference 161

 rmcluster
The rmcluster command deletes an Actifio appliance.

Rights
You must have the 'System Manage' right to delete an Actifio appliance.

Syntax
>>- udstask -- -- rmcluster -- --+----------+------------------->
'- -force -'
>--+- cluster_id ---+------------------------------------------><
'- cluster_name -'

Parameter Description

-force force Optional. When set, this removes an appliance even if the appliance is
used in an SLP.

cluster_id | cluster_name Required. Specifies the ID or name of the Actifio appliance to be removed.
Use the udsinfo lscluster command to retrieve the Actifio appliance name
or ID to help you identify the correct appliance to remove.

Description
Use the rmcluster command to delete an Actifio appliance. Use the udsinfo lscluster command to retrieve the ID or
name of the appliance. You cannot delete a appliance when the appliance is a member of an SLP. When a appliance is
removed, the corresponding certificate for that appliance is also removed.
If the -cluster option is specified, the command runs on the target Actifio appliance and the following conditions apply.
• An Actifio appliance does not have to be included in an resource profile (SLP) before it can be deleted
unless the force flag is set.
• When an Actifio appliance is removed, the corresponding certificate for that appliance is also removed.
• In addition, an attempt is made to remove the entry for this appliance from the other appliance. An explicit
udstask rmcluster must be performed on the other Actifio appliance to completely dissolve the two
appliances.

Example
$ udstask rmcluster Appliance_C1

162 Actifio CLI Reference | actifio.com |

setarchiveconfig
The setarchiveconfig command sets the configuration details on archiving historical data.

Rights
You should have the 'System Manage' right to configure the archiving of historical data.

Syntax
>>- udstask -- -- setarchiveconfig -- -------------------------->

>--+---------------------+-- --+-----------------------+-- ----->

'- -dataage -- weeks -' '- -delim -- delimiter -'

>--+---------------------+-- --+----------------------------+--->
'- -filepath -- path -' '- -measure --+- days --+-- -'
'- weeks -'

>--+-----------------------+-- --+-----------------------+-----><
'- -outputfile -- file -' '- -retention -- weeks -'

Parameter Description

-dataage weeks Optional. Specifies the data age for job history and event data before they are
archived. The default value is set to 12 (weeks). Data older than this age is archived
to a file and removed from the Actifio appliance persistent data storage. Units for
the age depends on the 'measure' value.

--retention weeks Optional. Specifies the retention age for archived job history and event data. The
default value is set to 6 (weeks). Archives created older than this age is discarded.
Units for the age depends on the 'measure' value.

-measure Optional. Specifies the period to store data before it is archived. The default value
| days | weeks is weeks.

-filepath path Optional. Specifies the file path to store the archive files. The default file path is 
/act/pg/ archive

-outputfile file Optional. Specifies the output file name to store the archived data in. The default
name is 'archive'.

-delim delimiter Optional. By default, all columns of data are separated by a tab in the concise view.
In the detailed view, each column of data is displayed in a separate row and if the
headers are displayed, the header is separated from the data by a space. The 
- delim parameter overrides this behavior.
Valid input for the -delim parameter is a one- byte character. To display the data,
recommended delimiter to use is comma (',') for list view, and equal ('=') for detail
view.

| actifio.com | Actifio CLI Reference 163

 Description
Use this command to configure historical data archive attributes. The Actifio appliance archives historical data, job
histories, and event (traps) data into archived files. These data that are archived are removed from the persistent
storage. These archived files can then be downloaded (through UI) for future references.

Example
$ udstask setarchiveconfig -dataage 24 -retention 12 -measure weeks -filepath
/act/pg/archive -outputfile archive -delim ,

164 Actifio CLI Reference | actifio.com |

setgcschedule
The setgcschedule command configures a garbage collection schedule.

Rights
You should have the 'System Manage' right to configure the garbage collection schedule.

Syntax
>>- udstask -- -- setgcschedule -- -+---------------+-- -------->
+- -day -- day -+

>--+--------------------+-- --+-----------------------------+--->
'- -duration -- min -' '- -frequency --+- daily ---+-'
'- weekly --'
'- monthly -'

>--+---------------------+-- --+--------------------------+----->
'- -op --+- now ----+-' '- -repeatinterval -- num -'
'- delete-'

>--+-----------------+-- -- -type --+- gc -----+---------------><

'- -time -- time -' '- sweep --'
'- igc ----'
'- isweep -'

Parameter Description

-day day Optional. Specifies the day of the frequency. For weekly frequency, 0 indicates that
the schedule should run on Sunday, 1 indicates Monday, and so on. For monthly
frequency, 0 indicates that the schedule should run on the first day of a month, and
1 indicates the second day of the month, and so on.

-duration min Optional. Specifies the duration (in minutes), for the sweep or isweep phase. The
phase runs as long as necessary if duration is not specified.

-frequency daily | Optional. Specifies the frequency of the schedule.

weekly | monthly

-op Optional. Specifies whether the operation should run immediately or delete the
now | delete schedule type.
* now: runs scheduled operation right away, using saved options
* delete: deletes specified schedule type, gc cannot be deleted

-repeatinterval num Optional. Specifies the repeat interval of the schedule (default of 1), which means
every week or every month depending on the schedule frequency.

| actifio.com | Actifio CLI Reference 165

 Parameter Description

-time hh:mm Optional. Specifies the time of the schedule, in 24- hour format.

-type Required. Specifies the type of the GC schedule to be created or modified.

gc | sweep | igc |
isweep

Description
Use this command to create, modify, or run a garbage collection schedule. There are four types of garbage collection
tasks:
• gc: Performs full GC mark to mark unreferenced objects so the space can be reclaimed during the sweep
phase.
• sweep: Performs a full GC sweep to reclaim space marked in the gc phase.
• igc: Performs an incremental GC mark to mark unreferenced temporary objects. which exists when there
are dedup- async tasks. This policy has no impact when there is no dedup-async tasks.
• isweep: Performs an incremental GC sweep to reclaim space marked during the gc phase.
If a sweep/isweep schedule is not set up, a sweep is performed at the end of the corresponding gc phase.

Example
The following example runs a GC each week at Sunday 1:00 AM:
:$ udstask setgcschedule -type gc -frequency weekly -time '01:00' -day 0

166 Actifio CLI Reference | actifio.com |

setnodeip
The setnodeip command changes the node IP on the Actifio appliance node.

Rights
You must have 'System Manage' right to be able to set a new nodeip value.

Syntax
>>- udstask -- -- setnodeip -- -- -ip -- ip_address ------------>
>-- -mask -- subnet_mask -- -- -gw -- gateway ------------------>
>--+---------------+-- --+-----------------+-------------------><
'- -mtu -- mtu -' '- -port -- port -'

Parameter Description

-ip ip_address Required. Specifies the IP address of the node. To disable a particular port, set the
IP address to '0.0.0.0'.

-port port Optional. Specifies the port, 1 through 7; where 1 is for eth0, 2 is for eth1, and so
on. The default is port 1 if a port value is not specified.

-mask subnet_mask Required. Specifies the subnet mask of the node.

-mtu mtu Optional. Specifies the MTU (maximum transmission unit) of the network.

-gw gateway Required. Specifies the gateway of the node.

Description
Use this command to set a new Node IP value for the Actifio appliance node.

Example
$ udstask setnodeip -ip 192.168.1.2 -mask 255.255.255.0 -gw 192.168.1.1 -port 2

| actifio.com | Actifio CLI Reference 167

 setparameter
The setparameter command sets a system parameter for the Actifio appliance. You can set the Actifio appliance
system parameters listed under getparameter on page 131.

Note: Prior to changing any system parameters, please consult your Actifio representative.

Rights
You must have the 'System Manage' right to set a new parameter value.

Syntax
>>- udstask -- -- setparameter -- -- -param -- param ----------->

>-- -value -- value -------------------------------------------><

Parameter Description

-param param Required. Specifies the name of the parameter to be set. Use udsinfo
getparameter to retrieve the name and range of values for the parameter.
setparameter uses the parameters detailed in Appendix D, List of Parameters
Used With getparameter and setparameter.

-value value Required. Specifies the value of the parameter.

Description
Use this command to set a new system parameter value for the Actifio appliance. You can set the Actifio appliance
system parameters listed under getparameter on page 131.

Example
$ udstask setparameter -param reservedsnapslots -value 10

168 Actifio CLI Reference | actifio.com |

setschedule
The setschedule command sets various administrative scheduling properties.

Rights
You should have the 'System Manage' right to configure a schedule.

Syntax
>>- udstask -- -- setschedule -- -- -name --+- archive -------+->
+- autodiscovery -+
+- gc ------------+
'-
storagestatus -'
>--+---------------+-- --+--------------------------------+----->
'- -day -- day -' '- -frequency --+- daily ---+-- -'
+- weekly --+
'- monthly -'
>--+-------------------+-- --+-------------------------------+-->
'- -op --+- now ----+ '- -repeatinterval -- interval -'
'- delete -'
>--+-----------------+-----------------------------------------><
'- -time -- time -'

Parameter Description

-day day Optional. Specifies the day of the frequency, 0- based. For weekly frequency, 0
indicates Sunday, and 1 is Monday, etc. For monthly, 0 is first day of the month, and
1 is 2nd day of the month.

-frequency daily | Optional. Specifies the frequency of the schedule.

weekly | monthly

-name archive | Required. Specifies the name of the schedule. Use udstask setgcschedule to set
autodiscovery | gc | GC schedule, this is kept for backward compatibility.
storagestatus

-op now | delete Optional. Specifies operation for the schedule. By specifying now for the operation,
this results in the schedule being run immediately.

-repeatinterval Optional. Specifies the repeat interval of the schedule, default to 1, which means
interval every week or every month, depends on the frequency.

-time time Optional. Specifies the time of the schedule.

| actifio.com | Actifio CLI Reference 169

 Description
Use this command to change/create a schedule for Actifio appliance maintenance.

Example
$ Runs GC each week at Sunday 1:00 AM
$ udstask setschedule -name gc -frequency weekly -time '01:00' -day 0

170 Actifio CLI Reference | actifio.com |

synccluster
The syncluster command synchronizes the persistent data between joined Actifio appliances.

Rights
You should have the 'System Manage' right to synchronize the persistent data between Actifio appliances.

Syntax
>>- udstask -- -- synccluster ---------------------------------><

Description
This command triggers a synchronization between joined Actifio appliances. All of the shared data between the Actifio
appliances is resynchronized. The command triggers the sync from the master so that all joined appliances will be
synced regardless of whether a slave or the master initiates the command.

Example
$ udstask synccluster

| actifio.com | Actifio CLI Reference 171

 rmgcschedule
The rmgcschedule command deletes one type of GC schedules.

Rights
You should have the 'System Manage' right to delete a GC schedule.

Syntax
>>- udstask -- -- rmgcschedule -- -- -type --+- igc ----+------><
'- sweep --'
'- isweep -'

Parameter Description

-type igc | sweep |isweep Required. Specifies the type of GC schedule to delete.

Description
Use this command to delete GC schedules. The following GC schedule types can be deleted:
• igc: Performs an incremental GC mark to mark unreferenced temporary objects, which exists when there
are dedup-async tasks. This policy has no impact when there is no dedup-async tasks.
• sweep: Performs a full GC sweep to reclaim space marked in the gc phase.
• isweep: Performs an incremental GC sweep to reclaim space marked during the igc phase.

Example
$ udstask rmgcschedule -type sweep

172 Actifio CLI Reference | actifio.com |

lsappcluster
The lsappcluster command returns a concise list of application to node mappings, or a detailed view of the mapping.

Syntax
>>- udsinfo -- -- lsappcluster -- ------------------------------>

>--+--------------------------------+-- --+----------+-- ------->

'- -filtervalue -- attrib=value -' '- -nohdr -'

>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' '- object_id ---'

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim: on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

-filtervalue Optional. Specifies that you want your report to display any or all of the list of valid
attrib=value filter attributes. The valid filter attributes for the udsinfo lsappcluster command
are:
* nodeid
* appid
The filter will be formed with an attribute and a value. When specifying more than
one filter, the filters must be combined with '&' character (which needs to be
escaped with '\').

-nohdr Optional. By default, headings are displayed for each column of data in a concise
style view, and for each item of data in a detailed style view. The -nohdr parameter
suppresses the display of these headings. If there is no data to be displayed,
headings are not displayed.

object_id Optional. Specifies the ID of an object. When you use this parameter, the detailed
view of the specific object is returned and any value that is specified by the -filter
value parameter is ignored. If you do not specify the object_id parameter, the
concise view of all objects matching the filtering requirements are displayed.

| actifio.com | Actifio CLI Reference 173

 Description
Use this command to retrieve details of application-to-node mappings.

Example
$ udsinfo lsappcluster
id noprotection ordering active appid nodeid
282227 false 0 false 282226 282204
282228 false 0 true 282226 282208

174 Actifio CLI Reference | actifio.com |

lsclustermember
The lsclustermember command returns a concise list of node to appliance mappings, or a detailed view of node to
appliance mapping.

Syntax
>>- udsinfo -- -- lsclustermember -- --------------------------->

>--+--------------------------------+-- --+----------+-- ------->

'- -filtervalue -- attrib=value -' '- -nohdr -'

>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' '- object_id ---'

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim: on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

-filtervalue Optional. Specifies that you want your report to display any or all of the list of valid
attrib=value filter attributes. The valid filter attributes for the udsinfo lsappcluster command
are:
* nodeid
* appid
The filter will be formed with an attribute and a value. When specifying more than
one filter, the filters must be combined with '&' character (which needs to be
escaped with '\').

-nohdr Optional. By default, headings are displayed for each column of data in a concise
style view, and for each item of data in a detailed style view. The -nohdr parameter
suppresses the display of these headings. If there is no data to be displayed,
headings are not displayed.

object_id Optional. Specifies the ID of an object. When you use this parameter, the detailed
view of the specific object is returned and any value that is specified by the -filter
value parameter is ignored. If you do not specify the object_id parameter, the
concise view of all objects matching the filtering requirements are displayed.

| actifio.com | Actifio CLI Reference 175

 Description
Use this command to retrieve details of node-to-appliance mappings.

Example
$ udsinfo lsclustermember
id clusterid nodeid
116737 111616 4139
116738 111616 103462

176 Actifio CLI Reference | actifio.com |

chappcluster
The chappcluster command changes property of an application-to -node mapping.

Rights
You must have the 'Application Manage' or 'Host Manage' right to change the property of an application to node
mapping.

Syntax
>>- udstask -- -- chappcluster -- --+----------------------+--->
'- -ordering -- order -'

>--+------------------------------+- -- mapping_id -----------><

'- -noprotection --+- true --+-'
'- false -'

Parameter Description

-noprotection Optional. Specifies whether the node is used for protection for this
true | false application.

-ordering Optional. Specifies order of protection.

mapping_id Required. Specifies the ID of the application mapping to be changed. Use

udsinfo lsappgroup to locate the ID.

Description
Use this command to change property of an application-to-node mapping.

Example
$ udstask chappcluster -ordering 1 4111

| actifio.com | Actifio CLI Reference 177

 rmappcluster
The rmappcluster command removes an application-to-node mapping.

Rights
You must have 'Application Manage' or 'System Manage' right to remove an application-to-node mapping.

Syntax
>>- udstask -- -- rmappcluster -- -- mapping_id ---------------><

Parameter Description

mapping_id Required. Specifies the ID of the application to node mapping to be

removed. Use udsinfo lsappgroup to locate the ID.

Description
Use this command to remove an application-to-node mapping. Use udsinfo lsappcluster to locate the ID of the
mapping.

Example
$ udstask rmappcluster 4111

178 Actifio CLI Reference | actifio.com |

rmclustermember
The rmclustermember command removes a node from an Actifio appliance.

Rights
You must have 'System Manage' right to remove a node from an Actifio appliance.

Syntax
>>- udstask -- -- rmclustermember -- -- member_id -------------><

Parameter Description

member_id Required. Specifies the ID of the node to appliance mapping to be removed.

Description
Use this command to remove a node from an appliance. User can use udsinfo lsclustermember to locate the ID of
the node to appliance mapping.

Example
$ udstask rmclustermember 4111

| actifio.com | Actifio CLI Reference 179

180 Actifio CLI Reference | actifio.com |
5 License Management
Commands

These commands are for Actifio Sky appliance license management. The GUI interface for these commands can be
found in the Actifio Desktop of your Actifio appliance under the Domain Manager section. For information, see
Configuring Resources and Settings With the Domain Manager in the Actifio Documentation Library.

Note: The license management commands are specific only to the Actifio Sky appliance

This chapter provides information related to following commands.

getfingerprint on page 182
getlicenseinfo on page 183
lslicense on page 184
mklicense on page 185
rmlicense on page 186

| actifio.com | Actifio CLI Reference 181

 getfingerprint
The getfingerprint command returns the system's fingerprint that is associated with the license key.

Rights
You must have 'System View' or 'System Manage' role.

Syntax
>>- udsinfo -- -- getfingerprint ------------------------------>

Description
Use this command to retrieve the system's fingerprint which is required for being issued any license key.

182 Actifio CLI Reference | actifio.com |

getlicenseinfo
The getlicenseinfo command to displays license information from given license key or license file (not yet installed) or
from a given license ID (installed). If no option is supplied, a summary of all installed licenses is provided.

Rights
You must have 'System View' or 'System Manage' role.

Syntax
>>- udsinfo -- -- getlicenseinfo ------------------------------>
>--+----------------------+-- --+------------------------+-- -->
'- -licensekey -- key -' '- -licensefile -- file -'
>--+-------------+--------------------------------------------><
'- -id -- id -'

Parameter Description

-licensekey licenskey Optional. Specifies the license key.

-licensefile file Optional. Specifies the file that contains license key.

-id id Optional. Specifies the ID of the license key.

Description
Use this command to display licensing information. If no option is supplied, a summary of all installed licenses is
provided.

| actifio.com | Actifio CLI Reference 183

 lslicense
The lslicense command returns a concise list of installed license keys, or a detailed view of a installed license key.

Rights
You must have 'System View' or 'System Manage' rights to retrieve license key info.

Syntax
>>- udsinfo -- -- lslicense -- --------------------------------->
>--+--------------------------------+-- --+----------+-- ------->
'- -filtervalue -- attrib=value -' '- -nohdr -'
>--+-----------------------+-- --+---------------+-------------><
'- -delim -- delimiter -' +- object_id ---+

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated.
In a detailed view, each item of data has its own row, and if the headers are
displayed the data is separated from the header by a space. The -delim
parameter overrides this behavior. Valid input for the -delim parameter is a one-
byte character. If you enter -delim : on the command line, the colon character
(:) separates all items of data in a concise view; for example, the spacing of
columns does not occur. In a detailed view, the data is separated from its
header by the specified delimiter.

-filtervalue No filtering is supported by this command.

attrib=value

-nohdr Optional. By default, headings are displayed for each column of data in a
concise style view, and for each item of data in a detailed style view. The -
nohdr parameter suppresses the display of these headings. If there is no data
to be displayed, headings are not displayed.

object_id Optional. Specifies the ID of an object. When you use this parameter, the
detailed view of the specific object is returned and any value that is specified
by the -filtervalue parameter is ignored.If you do not specify the object_id
parameter, the concise view of all objects matching the filtering requirements
are displayed.

Description
Use this command to retrieve details of installed license keys.Use udstask mklicense to add license key. Use this
command to retrieve details of installed license keys. Use udstask mklicense to add license key.

184 Actifio CLI Reference | actifio.com |

mklicense
The mklicense command installs a license key object.

Rights
You must have 'System Manage' right to install license key.

Syntax
>>- udstask -- -- mklicense -- --+----------------------+-->
'- -licensekey -- key -'
>--+------------------------+-----------------------------><
'- -licensefile -- file -'

Parameter Description

-licensekey key Optional. Specifies the license key.

-licensefile file Optional. Specifies the file that contains license key.

Description
Use this command to install a new license key object.

| actifio.com | Actifio CLI Reference 185

 rmlicense
The rmlicense command is used to uninstall a license key.

Rights
You must have "System Manage" right to uninstall a license.

Syntax
>>- udstask -- -- rmlicense -- --+- license_id -+------------------><

Parameter Description

license_id Required. Specifies the ID of the license key to be removed.

Description
Use this command to uninstall a license key.

Note: It is not mandatory to remove an installed license key that is no longer valid. The use of the rmlicense
command is optional.

186 Actifio CLI Reference | actifio.com |

6 Application Management
Commands

These commands are for application management. The GUI interface for these commands can be found in the Actifio
Desktop under the Application Manager of your Actifio appliance. For detailed information, refer to Virtualizing and
Protecting Copy Data with the Application Manager, Accessing and Recovering Copy Data with the
Application Manager, Replicating Data Using Actifio Appliances, or Restoring Copy Data with the Application
Manager in the Actifio Documentation Library.

| actifio.com | Actifio CLI Reference 187

 Managing Applications Managing Copy Data
These commands are used in managing Use these commands to manage snapshot, dedup,
applications: and remote dedup backup images:

appdiscovery on page 190 addvm on page 242

hmcdiscovery on page 191 lsvm on page 243
chapplication on page 192 backup on page 244
chappstack on page 195 chbackup on page 246
chappstackmember on page 196 cloneimage on page 247
chconsistgrp on page 197 replicateimage on page 250
chgroup on page 198 createliveclone on page 252
failback on page 199 prepmount on page 253
failover on page 200 prepunmount on page 255
lsgroup on page 204 deleteimage on page 256
lsapplication on page 206 expireimage on page 257
lsconsistgrp on page 211 lsbackup on page 258
lsconsistgrpmember on page 213 mountimage on page 263
lsgroupmember on page 215 exportimage on page 270
lsmdlstat on page 217 unexportimage on page 273
mkapplication on page 220 refreshliveclone on page 274
mkappstack on page 221 restoreimage on page 276
mkappstackmember on page 222 lsrestoreoptions on page 278
mkconsistgrp on page 223 unmountimage on page 280
mkconsistgrpmember on page 224 verifyimage on page 281
mkgroup on page 225 rmfailovertest on page 282
mkgroupmember on page 226 Dedup Drive Seeding Commands on page 283
rmapplication on page 227 o initializedevice on page 284
rmappstack on page 228 o lsdevice on page 285
rmappstackmember on page 229 o seedin on page 287
rmconsistgrp on page 230 o seedout on page 288
rmconsistgrpmember on page 231
rmgroup on page 232
rmgroupmember on page 233
syncback on page 234
testfailover on page 235
vmdiscovery on page 239

188 Actifio CLI Reference | actifio.com |

Managing Workflow Functionality
These commands are used in managing the workflow
functionality:

lsworkflow on page 290

addflowitemproperty on page 292
addflowproperty on page 294
addflowitemvalue on page 295
chworkflow on page 296
mkworkflow on page 298
mkflowitem on page 299
rmworkflow on page 300
rmflowitem on page 301
runworkflow on page 302
rmflowitemproperty on page 303
rmflowproperty on page 304
mksideband on page 305

| actifio.com | Actifio CLI Reference 189

 appdiscovery
The appdiscovery command discovers applications on the specified host running the Actifio Connector. This is for
non-Virtual Machine applications discovery, use vmdiscovery for Virtual Machines.

Rights
You must have the 'Host Manage' or 'Application Manage' right to perform application discovery.

Syntax
>>- udstask -- -- appdiscovery --------------------------------->

>-- -host --+- host_name -+-- --+-------------------------+----->

'- host_id ---' '- -org --+- org_id ---+-'
'- org_name -'
>--+-----------------+-- --+----------------+------------------><
'- -port -- port -' '- -versiononly -'

Parameter Description

-host Required. Specifies the ID or name of the host to discover the applications running
host_name | host_id on it. Use the udsinfo lshost command to locate the ID or name of the host.

-org Optional. Specifies a default organization in which a new application should be

org_id | org_name added after discovery. To use this option user needs to have 'System Manage' right.
If a default organization is not specified, an organization that the user belongs to is
used.

-port port Optional. Specifies the port that the Actifio Connector is running on, the default
value is 56789.

versiononly Optional. Specifies if only version should be discovered for this host. By default
version only is set to false.

Description
Use this command to discover applications on a host. This applies to non Virtual Machine applications discovery. For
Virtual Machines, use vmdiscovery. Use udsinfo lshost to locate the ID or name of the host.

Example
$ udstask appdiscovery -host myhost

190 Actifio CLI Reference | actifio.com |

hmcdiscovery
The hmcdiscovery command discovers VIOs and LPARs managed by an HMC.

Rights
You must have the ‘Host Manage' rights to perform HMC discovery.

Syntax
>>- udstask -- -- hmcdiscovery -- ------------------------------>
>--+--------------------------+-- --+--------------------+-- --->
'- -host --+- host_name -+-' '- -ipaddress -- ip -'
'- host_id ---'
>--+-------------------------+-- --+-----------------------+---->
'- -password -- password -' '- -org -+- org_id ---+-'
'- org_name -'
>--+-----------------+-- --+-------------------------+---------><
'- -port -- port -' '- -username -- username -'

Parameter Description

-host host_name | Optional. Specifies the host to perform HMC discovery on. The host has to be an
host_id HMC host. This is used when the HMC host already exists in the Actifio appliance.

-ipaddress ip Optional. Specifies the IP address of the HMC host, required when the HMC host
does not exist in the Actifio appliance.

-org org_id | org_name Optional. Specifies a default organization in which VIO or LPAR hosts should be
added after discovery. To use this option user needs to have 'System Manage' right.
If a default organization is not specified, an organization that the user belongs to is
used.

-password password Optional. Specifies the password of the HMC host, required when the HMC host
does not exist in the Actifio appliance.

-port port Optional. Specifies the port to be used for discovery, default to 22.

-username username Optional. Specifies the Username of the HMC host, required when the HMC host
does not exist in the Actifio appliance.

Description
Use this command to discover VIOs and LPARs on an HMC host.

Example
$ udstask hmcdiscovery -host 4011

| actifio.com | Actifio CLI Reference 191

 chapplication
The chapplication command changes the attributes of an application.

Rights
You must have the 'Application Manage' or ‘Host Manage’ right to change an application.

Syntax
>>- udstask -- -- chapplication -- --+--------------------+----->
'- -appname -- name -'
>--+-------------------------+-- --+--------------------------+->
'- -appclass -- appclass -' '- -appversion -- version -'
>--+--------------------------+-- --+------------------------+-->
'- -appversion -- version -' '- -description -- desc -'
>--+-------------------------+-- --+------------------------+--->
'- -friendlytype -- type -' '- -ignore --+- true --+-'
'- false -'
>-+---------------------+-- --+-----------------------------+--->
'- -applysensitivity -' '- -isclustered --+- true --+-'
'- false -'
>--+-------------------------+-- ------------------------------->
'- -sensitivity --+- 0 -+-'
'- 1 -'
>--+---------------------------+-- --+------------------------+->
'- -networkip -- networkip -' '- -networkname -- name -'

>--+--------------------+-- --+-----------------------+--------->
' -pathname -- path -' '- -org -+- org_id ---+-'
'- org_name -'
>--+---------------------------+-- -- app_id ------------------><
'- -volumes -- volume_list -'

Parameter Description

-appname name Optional. Specifies a new name for the application. This cannot be changed for
discovered application.

-appclass appclass Optional. Specifies the application class for the application. An app class dictates
the type of option allowed for recovery operations.

192 Actifio CLI Reference | actifio.com |

 Parameter Description

-applysensitivity Optional. Applies the sensitivity of the application to all existing local backup
images.

-appversion version Optional. Specifies the version of the application.

-description desc Optional. Specifies the description of the application.

-friendlytype type Optional. Specifies friendly type for the application.

-ignore true | false Optional. Specifies whether an application should be ignored. A protected
application cannot be ignored.

-volumes volumes Optional. Specifies the VDisk names of the application. Multiple VDisk names
should be separated by a colon (:).
For VM applications, this can be used to designate volumes (VMDK files) to be
excluded or included during data capture, or simply the boot VMDK. The syntax for
VM volumes is:
boot
include:<VMDK file list delimited by ,>
exclude:<VMDK file list delimited by ,>
If the VMDK file contains a comma (','), it must be escaped with ",,". For example:
“exclude:[datastore_remus] tndvm1/test.vmdk”

app_id Required. Specifies the ID of the application to be modified. Use udsinfo

lsapplication to retrieve the ID.

-networkip Optional. Specifies the network IP of the application.

-isclustered Optional. Specifies if the application is part of an appliance.

-sensitivity Optional. Specifies if the application is sensitive (a backup image has restricted
access before scrubbing of sensitive data), specify 1 for sensitive application, 0 for
non-sensitive.

-networkname Optional. Specifies the network name of the application.

networkip

-org org_id | org_name Optional. Specifies a default organization in which the application should be added
after creation. Use the udsinfo lsorg command to locate the ID or name of the
organization.

Note: To use this option a user must have 'System Manage' right.

-pathname path Optional. Specifies the path name of the application.

| actifio.com | Actifio CLI Reference 193

 Description
Use this command to modify the attributes of an application. Note that the name of a discovered application cannot be
changed.

Example
$ udstask chapplication -description 'Application description' 4111

194 Actifio CLI Reference | actifio.com |

chappstack
The chappstack command changes the attributes of an appstack.

Rights
You must have the 'Application Manage' or ‘Host Manage’ right to change an appstack.

Syntax
>>- udstask -- -- chappstack -- --+------------------------+---->
'- -description -- desc -'
>--+-----------------+-- --+- appstack_name -+-----------------><
'- -name -- name -' '- appstack_id ---'

Parameter Description

-description desc Optional. Specifies the description.

-name name Optional. Specifies name of the appstack.

appstack_name | Required. Specifies the appstack object to modify, either by ID or by name.

appstack_id

Description
Use this command to change the attributes of an appstack. Use udsinfo lsappstack command to obtain the ID or
name of an appstack.

Example
$ udstask chappstack -description 'new appstack description' mktappstack

| actifio.com | Actifio CLI Reference 195

 chappstackmember
The chappstackmember command modifies properties of an appstack member.

Rights
You must have the 'Application Manage' or ‘Host Manage’ right to modify properties of an appstack.

Syntax
>>- udstask -- -- chappstackmember -- -------------------------->
>-- - -ordering -- order --------------------------------------><

Parameter Description

-ordering order Required. Order of execution, application with the same order can be executed
in parallel. Ordering of 0 indicates that the order is not set, and is executed last.
Applications with a smaller number are executed earlier.
Use udsinfo lsapplication to retrieve the application ID.

Description
Use this command to modify the properties of an appstack member.

Example
$ udstask chappstackmember -ordering 5 4111

196 Actifio CLI Reference | actifio.com |

chconsistgrp
The chconsistgrp command changes the attributes of a consistency group.

Rights
You must have the 'Application Manage' right to change the attributes of a consistency group.

Syntax
>>- udstask -- -- chconsistgrp -- --+------------------------+-->
'- -description -- desc -'

>--+----------------------+-- -- group_id ---------------------><

'- -groupname -- name -'

Parameter Description

-description description Optional. Specifies the description.

-groupname group_name Optional. Specifies new name of the consistency group.

group_id Required. Specifies the consistency group ID to be modified.

Description
Use this command to modify the attributes of a consistency group. Use udsinfo lsconsistgrp command to obtain the
ID or name of the consistency group.
A consistency group is more than a logical grouping of applications. It is used to group applications to create a crash
consistent backup image when creating a backup.

Example
$ udstask chconsistgrp -description 'new group description' 4111

Note: All applications of a consistency group must be on the same host.

| actifio.com | Actifio CLI Reference 197

 chgroup
The chgroup command changes the attributes of a group.

Rights
You must have the 'Application Manage' or ‘Host Manage’ right to modify a group.

Syntax
>>- udstask -- -- chgroup -- --+------------------------+------->
'- -description -- desc -'

>--+-----------------+-- --+- group_name -+--------------------><

'- -name -- name -' '- group_id ---'

Parameter Description

-description Optional. Specifies the description.

description

-name name Optional. Specifies the name.

group_id | Required. Specifies the ID or name of the group to be modified.

group_name

Description
Use this command to change the attributes of a group. Use the udsinfo lsgroup command to obtain a list of groups
with IDs and names.

Example
$ udstask chgroup -description 'new group description' mktgroup

198 Actifio CLI Reference | actifio.com |

failback
The failback command fails back an application, protected by an asynchronous deduplication policy, from the remote
appliance to the primary appliance. Prior to failing an application back, you should synchronize the application's data on
the remote appliance with that of the primary appliance using the syncback command.

Rights
You must have the 'Host Manage' or 'Application Manage' or ‘Dedup-Async Manage’ right to fail back an application.

Syntax
>>- udstask -- -- failback -- -- -id --+- app_id --------+-----><
'- consistgrp_id -'

Parameter Description

-id Required. Specifies the ID of the application or the consistency group to fail
app_id | consistgrp_id back. The application should be protected by an enhanced asynchronous
replication policy, and is in failed-over state. Use udsinfo lsapplication or
udsinfo lsconsistgrp for the ID .

Description
Use this command to fail back an application that is protected with an enhanced asynchronous replication policy.

Example
$ udstask failback -id 4111

| actifio.com | Actifio CLI Reference 199

 failover
The failover command fail-over a dedup-async protected application. This command is issued on the remote appliance
when the application on the primary appliance is failed.

Rights
You must have the 'Host Manage' or 'Application Manage' or ‘Dedup-Async Manage’ right to fail over an application.

Syntax
>>- udstask -- -- failover -- -- -id --+- app_id --------+-- ----------->
'- consistgrp_id -'
>--+------------------------------+-- ---------------------------------->
'- -accessmode --+- ro ---+-- -'
+- rw ---+
+- deny -+
'- root -'
>--+---------------+-- --+------------------------------+-- ------------>
'- -allvolumes -' '- -exporttype --+- cifs -+-- -'
'- nfs --'
>--+-------------------------+-- --+-------------------------+-- ------->
'- -exportedname -- name -' '- -exportedpath -- path -'
>--+--------------------------+-- --+----------------------------+-- --->
'- exportoption -- option -' '- -exporthost -- host_list -'
>--+-------------------------------+-- --+-------------------+-- ------->
'- -exportobjectid -- objectid -' '- -group -- group -'
>--+-----------------------------------+-- ----------------------------->
'- -exportobjecttype -- objecttype -'
>--+---------------------------+-- --+-----------------------------+-- ->
'- -datastore -- datastore -' '- -hypervisor -- hypervisor -'
>--+------------------------------+-- --+-------------------+-- -------->
'- -diskpool --+- pool_name -+-' '- -label -- label -'
'- pool_id ---'
>--+----------------------+-- --+-----------------+-- ------------------>
'- -host -- host_name -' '- -path -- path -'
>--+----------------------------+-- --+---------------------+-- -------->
'- -restoreoption -- option -' '- -script -- script -'
>--+--------------------------------+-- --+--------------------------+-><
'- -mgmtserver --+- host_id ---+-' '- -user -- user_password -'
'- host_name -'

200 Actifio CLI Reference | actifio.com |

 Parameter Description

-accessmode Optional, valid only for export to CIFS type. Specifies the type of
ro | rw | deny | root access that is allowed for the specified user (in -user). Allowed types
are:
• ro: read-only
• rw: read-write
• deny: no access allowed
• root: has full access to all the files in the share even if
ACLs do not.

-allvolumes Optional. The flag specifies whether to export all volumes in the
backup. Use -exportobjectid to specify a specific volume to be
exported.

-id Required. Specifies the ID or consistgrp of the application to fail over.

app_id | consistgrp_id The application or consistgrp should be protected by a dedup-async
policy.

-datastore datastore Optional for applications on hosts other than virtual machines but
required for VMWare Virtual Machine applications. Specifies the data
store to be used for fail-over.

-diskpool pool_name | Optional and required only for non-VM applications. Specifies the
pool_id disk-pool to be used for fail-over.

-esxhost esxhost Optional and valid only for a virtual machine backup image. Specifies
the ESX host on which fail-over should happen. This is the ESX host
for VMWare and Microsoft Hyper-V Server for Hyper-V.

-exportedname name Optional. Specifies the exported name of the backup image, valid
only for CIFS.

-exportedpath path Optional. Specifies sub-directory within the mount volume to be

exported.

-exporthost host_list Optional. Specifies the ID or name of host(s) to which the backup
image is to be exported. If ID is used, the host has to already exists
in the Actifio appliance. Name can contain wild characters. More than
one host can be specified, separated by a comma (,).

-exportobjectid objectid Optional. Specifies the object id of the individual volume within the
mounted image to be exported.

-exportobjecttype Optional. Specifies the object type of the individual volume within
objecttype the mounted image to be exported.

| actifio.com | Actifio CLI Reference 201

 Parameter Description

-exportoption option Optional. Specifies the export option, a name/value list, separated by
equal (=). Multiple options is separated by comma (,). An example is,
* "readonly=true,writedelay=false"
The following option is allowed for NFS:
• readonly="true | false"
• writedelay="true | false"
• rootsquash="true | false"
• allsquash="true | false"
• anonuid="0"
• anongid="1"
• insecurelocks="true | false"
The following option is allowed for CIFS,
• allowguest="true | false"

-exporttype cifs | nfs Optional. Specifies protocol, cifs for CIFS, and nfs for NFS. Default to
the protocol the backup was created.

-group group Optional, valid only for export to CIFS type. Specifies a list of domain
group that are allowed to map the share, separated by a comma (,).

-host Required. Specifies the host ID or host name or the name of the
host_name | host_id virtual machine to fail-over to. For regular host, the host has to exist
already.

-hypervisor hypervisor Optional (required for Virtual Machine applications) Specifies the
hyper visor on which to failover to. This is the ESX host for VMWare,
and Microsoft Hyper-V Server for Hyper-V.

-label label Optional. Specifies label for the fail-over image.

-mgmtserver host_id | Optional. Required for Virtual Machine applications) Specifies the
host_name management server, ID or name, to be used for test failover. This is
the vCenter host for VMWare and Microsoft System Center Virtual
Machine Manager for Hyper-V.

-nowait Optional. The flag specifies not to wait for the completion of the
command.

-path path Optional, valid only for Hyper-V Virtual Machine backup image)
Specifies the path to be used for failover to a new Hyper-V Virtual
Machine.

-restoreoption option Optional. A comma delimited list of restore options where each
restore option is a name=value pair. See Appendix F, List of Restore
Options for a summary of the supported restore options for this
command.

202 Actifio CLI Reference | actifio.com |

 Parameter Description

-script script Optional. Specifies a script during different phases of the operation.
Four phases are supported, INIT, PRE, POST, and FINAL. Each phase,
a timeout, name of the script, and argument list can be specified.
Name of the script is required, timeout and arguments are optional.

-user user_password Optional, valid only for export to CIFS type. Specifies a list of domain
users that are allowed to map the share, separated by a comma (,).
Also allowed are local user (with specified password), use colon (:) to
separate user name and password. The local user does not need to
exist in Windows Domain or the Actifio appliance, but has to be
unique.

Description
Use this command to fail over an application, which is protected by an asynchronous de-duplication policy. This
command is issued on the remote appliance when the application on the primary appliance is failed.

Example
$ udstask failover -id 4111 -host myhost -diskpool mainpool

| actifio.com | Actifio CLI Reference 203

 lsgroup
The lsgroup command displays a concise list of groups or a detailed view of a group.

Rights
You must have the 'System Manage' or 'System View’ right to list the groups.

Syntax
>>- udsinfo -- -- lsgroup -- ----------------------------------->
>--+--------------------------------+-- --+----------+-- ------->
'- -filtervalue -- attrib=value -' '- -nohdr -'
>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+
'- object_name -'

Parameter Description

-delim delimiter Optional. By default, all columns of data are separated by a tab in the concise view.
In the detailed view, each column of data is displayed in a separate row and if the
headers are displayed, the header is separated from the data by a space. The 
-delim parameter overrides this behavior. Valid input for the -delim parameter is a
one- byte character. To display the data, recommended delimiter to use is comma
(',') for list view, and equal ('=') for detail view.

-filtervalue Optional. Specifies that you want your report to display any or the entire list of valid
attrib=value filter attributes. The valid filter attributes for the udsinfo lsgroup command are:
• name
• description
The filter is formed with an attribute and a value. When you specify more than one
filter, they must be combined with '&' character (which should be escaped with '\').
For string type of filters, the only operator allowed is '='. You can also use wild card
character '*'. For example, to list all consistency groups with a name that begins
with 'foo', use '- filtervalue name=foo*

-nohdr Optional. By default, headings are displayed for each column of data in the concise
view, and for each item of data in the detailed view. The -nohdr parameter
suppresses the display of headings. If there is no data to display, headings are not
displayed.

object_id | Optional. Specifies the name or ID of an object. When you use this parameter, a
object_name detailed view of the object is returned and any value specified by the 
-filtervalue parameter is ignored. If you do not specify the object_id or the
object_name parameter, a concise view of all objects matching the filter criteria is
displayed.

204 Actifio CLI Reference | actifio.com |

Description
Use this command to retrieve the details of an application group. You can protect the members of a group using a
single policy template.

Example
$ udsinfo lsgroup -delim = mktgroup
id=13167
description=
name=mktgroup

| actifio.com | Actifio CLI Reference 205

 lsapplication
The lsapplication command displays a concise list of applications or a detailed view of an application.

Syntax
>>- udsinfo -- -- lsapplication -- ----------------------------->

>--+--------------------------------+-- --+----------+-- ------->

'- -filtervalue -- attrib=value -' '- -nohdr -'

>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+

Parameter Description

-delim delimiter Optional. By default, all columns of data are separated by a tab in the concise view.
In the detailed view, each column of data is displayed in a separate row and if the
headers are displayed, the header is separated from the data by a space. The -
delim parameter overrides this behavior.
Valid input for the -delim parameter is a one- byte character. To display the data,
recommended delimiter to use is comma (',') for list view, and equal ('=') for detail
view.

206 Actifio CLI Reference | actifio.com |

 Parameter Description

-filtervalue Optional. Specifies that you want your report to display any or the entire list of valid
attrib=value filter attributes. The valid filter attributes for the udsinfo lsapplication command
are:
* appname
* apptype
* appversion
* auxinfo
* description
* friendlytype
* hostid
* hostname
* id
* ignore
* isclustered
* networkip
* networkname
* originalappid
* pathname
* protectable [ NONE | FULLY | PARTIALLY ]
* sourcecluster
The filter is formed with an attribute and a value. When you specify more than one
filter, they must be combined with '&' character (which needs to be escaped with
'\').
For string type of filters, the only operator allowed is '='. You can also use wild card
character '*'. For example, to list applications beginning with 'foo', use '-filtervalue
appname=foo*'. Some filters allow only predefined constants. For example,
protectable allows only NONE, FULLY, or PARTIALLY. To list applications that are
protected FULLY, use '- filtervalue protectable=FULLY'.

-nohdr Optional. By default, headings are displayed for each column of data in the concise
view, and for each item of data in the detailed view. The -nohdr parameter
suppresses the display of headings. If there is no data to be displayed, headings are
not displayed.

object_id Optional. Specifies the ID of an object. When you use this parameter, a detailed
view of the object is returned and any value that is specified by the -filtervalue
parameter is ignored. If you do not specify the object_id parameter, a concise view
of all objects matching the filter criteria is shown.

| actifio.com | Actifio CLI Reference 207

 Description
Use this command to retrieve the details of applications, such as application ID. Use the udstask appdiscovery
command to discover applications on non-VMs and use the udstask vmdiscovery command to discover applications
running on the virtual machines. Generic applications (applications not supported by the Actifio Connector) can be
created using udstask mkapplication.

Example

$ udsinfo lsapplication -delim : 8202
id:8202
auxinfo:
protectable:FULLY
appversion:
morecredentials:
volumes:
username:
hostid:51
hostname:xx
description:
appname:S:\
apptype:FileSystem
friendlytype:FileSystem

$ udsinfo lsapplication

208 Actifio CLI Reference | actifio.com |

lsappclass
The lsappclass command lists all the available application classes or provides detailed information (provisioning
options) for a specific application class.

Rights
You must have the 'System Manage' or 'System View’ right to view the application class information.

Syntax
>>- udsinfo -- -- lsappclass -- --+-----------------------+-- -->
'- -delim -- delimiter -'

>--+----------+-- --+-------------------------+----------------><
'- -nohdr -' '- -name -- appclassname -'

Parameter Description

-name appclassname Optional. The Appclass name (MS-SQL Server, Oracle, EBiz, and so on). Appclass
name is case sensitive.

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim: on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

-nohdr Optional. By default, headings are displayed for each column of data in a concise
style view, and for each item of data in a detailed view. The -nohdr parameter
suppresses the display of these headings.

Note: If there is no data to be displayed, headings are not displayed.

Description
This command provides a list of application classes available. If an Appclass name is provided, it will display detailed
information about the given Appclass.

| actifio.com | Actifio CLI Reference 209

 Example
$ udsinfo lsappclass
appclass
SQLServer
SQLServerGroup
Oracle
OracleGroup
$ udsinfo lsappclass OracleGroup

$ udsinfo lsappclass SQLServerGroup

$ udsinfo lsappclass SQLServer

$ udsinfo lsappclass Oracle

210 Actifio CLI Reference | actifio.com |

lsconsistgrp
The lsconsistgrp command displays a concise list of all consistency groups created on the Actifio appliance or a
detailed view of a consistency group.

Syntax
>>- udsinfo -- -- lsconsistgrp -- ------------------------------>

>--+--------------------------------+-- --+----------+-- ------->

'- -filtervalue -- attrib=value -' '- -nohdr -'

>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+
'- object_name -'

Parameter Description

-delim delimiter Optional. By default, all columns of data are separated by a tab in the concise view.
In the detailed view, each column of data is displayed in a separate row and if the
headers are displayed, the header is separated from the data by a space. The -delim
parameter overrides this behavior.
Valid input for the -delim parameter is a one- byte character. To display the data,
recommended delimiter to use is comma (',') for list view, and equal ('=') for detail
view.

-filtervalue Optional. Specifies that you want your report to display any or the entire list of valid
attrib=value filter attributes. The valid filter attributes for the udsinfo lsconsistgrp command are:
• groupname
• originalappid
The filter is formed with an attribute and a value. When user specifies more than
one filter, they must be combined with the '&' character (which needs to be
escaped with '\'). For string type of filters, the only operator allowed is '='. You can
also use wild card character '*'. For example, to list all consistency groups with a
name that begins with 'foo', use '-filtervalue groupname=foo*'.
For number types, allowed operators are: =, >, >=, <, <=. 
To use <, <=, >, or >=, they need to be escaped with '\' or enclosed in ' or ", as
required by shell. For example,
• -filtervalue originalappid\>=80
• -filtervalue "originalappid>=80"
• -filtervalue 'originalappid>=80'

-nohdr Optional. By default, headings are displayed for each column of data in the concise
view, and for each item of data in the detailed view. The -nohdr parameter
suppresses the display of headings. If there is no data to display, headings are not
displayed.

| actifio.com | Actifio CLI Reference 211

 Parameter Description

object_id | Optional. Specifies the name or ID of an object. When you use this parameter, a
object_name detailed view of the object is returned and any value specified by the 
-filtervalue parameter is ignored. If you do not specify the object_id or the
object_name parameter, a concise view of all objects matching the filter criteria is
displayed.

Description
Use this command to retrieve details of consistency groups.

Example.
$ udsinfo lsconsistgrp group1 
id 13167
auxinfo
protectable 1
appversion
morecredentials
volumes username
hostid
description
apptype
friendlytype
groupname group1

212 Actifio CLI Reference | actifio.com |

lsconsistgrpmember
The lsconsistgrpmember command displays a concise list of applications-to-consistency-group mapping or a detailed
view of a consistency group.

Rights
You must have the ‘System View’ right to retrieve consistency group (consistgrp) mappings.

Syntax
>>- udsinfo -- -- lsconsistgrpmember -- ------------------------>
>--+--------------------------------+-- --+----------+-- ------->
'- -filtervalue -- attrib=value -' '- -nohdr -'
>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' '- object_id ---'

Parameter Description

-delim delimiter Optional. By default, all columns of data are separated by a tab in the concise view.
In the detailed view, each column of data is displayed in a separate row and if the
headers are displayed, the header is separated from the data by a space. The -
delim parameter overrides this behavior. Valid input for the -delim parameter is a
one- byte character. To display the data, recommended delimiter to use is comma
(',') for list view, and equal ('=') for detail view.

-filtervalue Optional. Specifies that you want your report to display any or the entire list of valid
attrib=value filter attributes. The valid filter attributes for the udsinfo lsconsistgrpmember
command are:
• groupid
• appid
The filter is formed with an attribute and a value. When you specify more than one
filter, they must be combined with '&' character (which should be escaped with '\').

-nohdr Optional. By default, headings are displayed for each column of data in the concise
view, and for each item of data in the detailed view. The -nohdr parameter
suppresses the display of headings. If there is no data to display, headings are not
displayed.

object_id Optional. Specifies the ID of an object. When you use this parameter, a detailed
view of the object is returned and any value that is specified by the -filtervalue
parameter is ignored. If you do not specify the object_id parameter, a concise view
of all objects matching the filter criteria is displayed.

| actifio.com | Actifio CLI Reference 213

 Description
Use this command to retrieve the details of applications-to-consistency-group mapping.

Example
$ udsinfo lsconsistgrpmember
id appid groupid
116737 4139 111616
116738 103463 111616

214 Actifio CLI Reference | actifio.com |

lsgroupmember
The lsgroupmember command displays a concise list of groups or a detailed view of the grouping of applications.

Rights
You must have the 'System Manage' or ‘System View’ or ‘SLA Assign’ right to list group members.

Syntax
>>- udsinfo -- -- lsgroupmember -- ----------------------------->
>--+--------------------------------+-- --+----------+-- ------->
'- -filtervalue -- attrib=value -' '- -nohdr -'
>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' '- object_id ---'

Parameter Description

-delim delimiter Optional. By default, all columns of data are separated by a tab in the concise view.
In the detailed view, each column of data is displayed in a separate row and if the
headers are displayed, the header is separated from the data by a space. The -delim
parameter overrides this behavior.
Valid input for the -delim parameter is a one- byte character. To display the data,
recommended delimiter to use is comma (',') for list view, and equal ('=') for detail
view.

-filtervalue Optional. Specifies that you want your report to display any or the entire list of valid
attrib=value filter attributes. The valid filter attributes for the udsinfo lsgroupmember
command are:
• groupid
• appid
The filter is formed with an attribute and a value. When you specify more than one
filter, they must be combined with '&' character (which should be escaped with '\').

-nohdr Optional. By default, headings are displayed for each column of data in the concise
view, and for each item of data in the detailed view. The -nohdr parameter
suppresses the display of headings. If there is no data to display, headings are not
displayed.

object_id Optional. Specifies the ID of an object. When you use this parameter, a detailed
view of the object is returned and any value that is specified by the -filtervalue
parameter is ignored. If you do not specify the object_id parameter, a concise view
of all objects matching the filter criteria is displayed.

| actifio.com | Actifio CLI Reference 215

 Description
Use this command to retrieve details of the group mappings of applications.

Example
$ udsinfo lsgroupmember
id appid groupid
116737 4139 111616
116738 103463 111616

216 Actifio CLI Reference | actifio.com |

lsmdlstat
The lsmdlstat command returns a concise list or a detailed view of MDL (Managed Data License) stats.

Rights
You must have 'System View' or 'System Manage' rights to be able to retrieve MDL data.

Syntax
>>- udsinfo -- -- lsmdlstat -- ---------------------------------->
>--+--------------------------------+-- --+----------+-- -------->
'- -filtervalue -- attrib=value -' '- -nohdr -'
>--+-----------------------+-- --+---------------+--------------><
'- -delim -- delimiter -' +- object_id ---+

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed the
data is separated from the header by a space. The -delim parameter overrides this
behavior. Valid input for the -delim parameter is a one-byte character. If you enter -
delim: on the command line, the colon character (:) separates all items of data in a
concise view; for example, the spacing of columns does not occur. In a detailed view,
the data is separated from its header by the specified delimiter.

| actifio.com | Actifio CLI Reference 217

 Parameter Description

-filtervalue Optional. Specifies that you want your report to display any or all of the list of valid filter
attrib=value attributes. The valid filter attributes for the udsinfo lssnappoolstat command are:
• allocated
• appid
• appname
• appreserved
• appsize
• capacity
• devsize
• hostname
• manageddata
• sourcecluster
The filter will be formed with an attribute and a value. Multiple filters must be combined
with '&' character (which must be escaped with '\').
For string type of filters, the only operator allowed is '='. You can also use the wildcard
character '*'. For example, to match an application with appname beginning with 'foo',
use '-filtervalue appname=foo*'.
For number types, allowed operators are: =, >, >=, <, <=. To use <, <=, >, or >=, they
need to be escaped with '\' or enclosed in ' or “, as required by shell. For example:
• -filtervalue vdiskcount\>=10
• -filtervalue "vdiskcount>=10"
• -filtervalue 'vdiskcount>=10'

-nohdr Optional. By default, headings are displayed for each column of data in a concise style
view, and for each item of data in a detailed style view. The -nohdr parameter
suppresses the display of these headings.If there is no data to be displayed, headings
are not displayed.

object_id Optional. Specifies the ID of an object. When you use this parameter, the detailed view
of the specific object is returned and any value that is specified by the -filtervalue
parameter is ignored.
If you do not specify the object_id parameter, the concise view of all objects matching
the filtering requirements are displayed.

218 Actifio CLI Reference | actifio.com |

Description
Use this command to retrieve statistics of MDL usage for each protected applications in the appliance. The statistics
are collected once a day.
When the appid statistic is 0, it contains the total MDL of all applications that this Actifio appliance manages.

Examples
$ udsinfo lsmdlstat
id appsize appreserved devsize appname sourcecluster capacity
manageddata hostname appid stattime allocated
6556 30064771072 30064771072 30064771072 oracle 590023229566 0
30064771072 oracle 6268 2013-09-21 03:00:00.388 30064771072
6557 30064771072 30064771072 30064771072 590023229566 0 30064771072
0 2013-09-21 03:00:00.390 30064771072
7023 30064771072 30064771072 30064771072 oracle 590023229566 0
30064771072 oracle 6268 2013-09-22 03:00:00.373 30064771072
7024 30064771072 30064771072 30064771072 590023229566 0 30064771072
0 2013-09-22 03:00:00.375 30064771072
7484 30064771072 30064771072 30064771072 oracle 590023229566 0
30064771072 oracle 6268 2013-09-23 03:00:00.373 30064771072
7485 30064771072 30064771072 30064771072 590023229566 0 30064771072
0 2013-09-23 03:00:00.375 30064771072
7944 30064771072 30064771072 30064771072 oracle 590023229566 0
30064771072 oracle 6268 2013-09-24 03:00:00.391 30064771072
7945 30064771072 30064771072 30064771072 590023229566 0 30064771072
0 2013-09-24 03:00:00.393 30064771072
8405 30064771072 30064771072 30064771072 oracle 590023229566 0
30064771072 oracle 6268 2013-09-25 03:00:00.375 30064771072
8406 30064771072 30064771072 30064771072 590023229566 0 30064771072
0 2013-09-25 03:00:00.376 30064771072

| actifio.com | Actifio CLI Reference 219

 mkapplication
The mkapplication command creates a generic application.

Rights
You must have the 'Application Manage' or ‘Host Manage’ right to create a generic application.

Syntax
>>- udstask -- -- mkapplication -- ------------------------->
>-- -appname -- name -------+--------------------------+---->
'- -appversion -- version -'
>--+------------------------+-- -hostid -- host_id --------->
'- -description -- desc -'
>--+-------------------------+-- --------------------------->
'- -apptype -- type -'
>--+-----------------------+-- -- -volumes -- vols --------><
'- -org -+- org_id ---+-'
'- org_name -'

Parameter Description

-appname name Required. Specifies the name.

-appversion version Optional. Specifies the version.

-description desc Optional. Specifies the description.

-apptype type Optional. Specifies the application type of the application. For NAS application, the
type should be 'nas'. For generic out-of-band applications, the type should be 'LVM
Volume'. Otherwise, a 'generic' in-band application is created.

-hostid host_id Required. Specifies the host ID where the application runs.

-org org Optional. Specifies a default organization in which the application should be added
after creation. If a default organization is not specified, an organization that the user
belongs to is used.

-volumes vol Required. Specifies the names of the VDisks allotted to the application. Multiple
VDisk names should be separated with a colon (:).

Description
Use this command to create a generic application object.

Example
$ udstask mkapplication -appname myapp -hostid 4111 -volumes vdisk1:vdisk2

220 Actifio CLI Reference | actifio.com |

mkappstack
The mkappstack command creates a new appstack.

Rights
You must have the 'Application Manage' or ‘Host Manage’ right to create a new appstack.

Syntax
>>- udstask -- -- mkappstack -- --+- -name -- name -+----------->
>--+-------------------------------+---------------------------><
'- -description -- description -'

Parameter Description

-name name Required. Specifies name of the appstack. The appstack name must be
unique.

-description desc Optional. Specifies the description for an appstack.

Description
Use this command to create a new appstack. Applications can be added to or deleted from the appstack by using the
udstask mkappstackmember and udstask rmappstackmember commands.

Example
$ dstask mkappstack -name mktappstack

| actifio.com | Actifio CLI Reference 221

 mkappstackmember
The mkappstackmember command adds an application to an appstack.

Rights
You must have the 'Application Manage' or ‘Host Manage’ right to add an application to an appstack.

Syntax
>>- udstask -- -- mkappstackmember -- -------------------------->
>-- -appid -- app_id -- -- -appstackid --+- appstack_id ---+-- ->
>--+----------------------+------------------------------------><
'- -ordering -- order -'

Parameter Description

-appid app_id Required. Specifies the ID of an application to be added to the appstack. Use
udsinfo lsapplication to retrieve the application ID.

-appstackid appstack_id Required. Specifies ID of the appstack to add the application to.

-ordering order Required. Order of execution, application with the same order can be executed
in parallel. Ordering of 0 indicates that the order is not set, and is executed last.
Applications with a smaller number are executed earlier.

Description
Use this command to add an application to an appstack.

Example
$ udstask mkappstackmember -appid 4020 -appstack mktappstack

222 Actifio CLI Reference | actifio.com |

mkconsistgrp
The mkconsistgrp command creates a new consistency group object.

Rights
You must have 'Application Manage' or ‘Host Manage’ or ‘SLA Assign’ right to create a consistency group.

Syntax
>>- udstask -- -- mkconsistgrp -- ------------------------------>
>--+------------------------+-- -- -hostid -- host_id -- ------->
'- -description -- desc -'

>-- -groupname -- group_name -- --+------------------------+---><

Parameter Description

-description desc Optional. Specifies the description for consistency group.

-hostid host_id Required. Specifies the host ID of the consistency group.

-groupname Required. Specifies the name of the consistency group. The name should be
group_name unique.

Description
Use this command to create a new consistency group. A consistency group is more than a logical grouping of
applications. A consistency group is used to group applications with data that should be protected together when
taking a snapshot. All applications of a consistency group should be located on the same host.

Example
$ udstask mkconsistgrp -groupname 'appgroup1'-hostid 4111

| actifio.com | Actifio CLI Reference 223

 mkconsistgrpmember
The mkconsistgrpmember command adds an application to a consistency group.

Rights
You must have the 'Application Manage' right to add an application to a consistency group.

Syntax
>>- udstask -- -- mkconsistgrpmember -- ------------------------>

>-- -appid -- app_id -- -- -groupid -- group_id ---------------><

Parameter Description

-appid appid Required. Specifies the ID of the application to be added to a consistency group.
Use udsinfo lsapplication to retrieve the application ID.

-groupid groupid Required. Specifies the ID of the consistency group to add the application to. Use
udsinfo lsconsistgrp command to obtain the ID of the consistency group

Description
Use this command to add an application to a consistency group.

Example
$ udstask mkconsistgrpmember -appid 4020 -groupid 4030

224 Actifio CLI Reference | actifio.com |

mkgroup
The mkgroup command creates a new group.

Rights
You must have the 'Application Manage' or ‘Host Manage’ right to create a group.

Syntax
>>- udstask -- -- mkgroup -- --+- -name -- name -+-------------->

>--+-------------------------------+---------------------------><
'- -description -- description -'

Parameter Description

-name name Required. Specifies the name of the group. The name should be unique.

-description Optional. Specifies the description for the group.

description

Description
Use this command to create a group. Applications can be added to or deleted from the group, using the udstask
mkgroupmember and udstask rmgroupmember commands respectively. All applications of a group should be
protected by the same template and profile. Note that when an application is removed from the group, it retains the
protection.
To protect all applications in a group, use the udstask mksla command with the -group parameter.

Example
$ udstask mkgroup -name mktgroup

| actifio.com | Actifio CLI Reference 225

 mkgroupmember
The mkgroupmember command adds an application to a group.

Rights
You must have the “Application Manage’ or 'System Manage' or ‘SLA Assign’ right to add an application to a group.

Syntax
>>- udstask -- -- mkgroupmember -- ----------------------------->
>-- -appid -- app_id -- -- -groupid -- group_id ---------------><

Parameter Description

-appid appid Required. Specifies the ID of an application to add to a group. Use udsinfo
lsapplication to retrieve the application ID.

-groupid groupid Required. Specifies the ID of the group to add the application to. Use udsinfo
lsconsistgrp command to obtain the ID of the consistency group.

Description
Use this command to add an application to a group.

Example
$ udstask mkgroupmember -appid 4020 -groupid 4030

226 Actifio CLI Reference | actifio.com |

rmapplication
The rmapplication command deletes an application.

Rights
You must have the 'Application Manage' or ‘Host Manage’ right to delete an application.

Syntax
>>- udstask -- -- rmapplication -- -- application_id ----------><

Parameter Description

application_id Required. Specifies the ID of the application to be removed. Use udsinfo

lsapplication to retrieve the application ID.

Description
Use this command to delete an application.

Example
$ udstask rmapplication 4111

| actifio.com | Actifio CLI Reference 227

 rmappstack
The rmappstack command deletes an appstack.

Rights
You must have the 'Application Manage' or ‘Host Manage’ right to delete an appstack.

Syntax
>>- udstask -- -- rmappstack -- --+- appstack_name -+----------><
'- appstack_id ---'

Parameter Description

appstack_name Required. Specifies name of the appstack to be removed.

appstack_id Required. Specifies ID of the appstack to be removed.

Description
Use this command to delete an appstack.

Example
$ udstask rmappstack mktappstack

228 Actifio CLI Reference | actifio.com |

rmappstackmember
The rmappstackmember command removes an application from a application stack.

Rights
You must have the 'Application Manage' or ‘Host Manage’ right to delete an appstack.

Syntax
>>- udstask -- -- rmgroupmember -- -- member_id ---------------><

Parameter Description

member_id Required. Specifies the ID of the application stack mapping to be removed.

Description
Use this command to remove an application from an application stack. Use udsinfo lsappstackmember to locate the
ID of the application stack mapping.

Example
$ udstask rmappstackmember 4111

| actifio.com | Actifio CLI Reference 229

 rmconsistgrp
The rmconsistgrp command deletes a consistency group.

Rights
You must have the “Application Manage” or “Host Manage” right to delete a consistency group.

Syntax
>>- udstask -- -- rmconsistgrp -- -- consistgrp_id ------------><

Parameter Description

consistgrp_id Required. Specifies the consistency group ID to be removed. Use udsinfo

lsconsistgrp command to obtain the ID or name of the consistency group.

Description
Use this command to delete a consistency group.

Example
$ udstask rmconsistgrp 1234

230 Actifio CLI Reference | actifio.com |

rmconsistgrpmember
The rmconsistgrpmember command deletes an application from a consistency group.

Rights
You must have the 'Application Manage' or ‘Host Manage’ or ‘SLA Manage’ right to delete an application from a
consistency group member.

Syntax
>>- udstask -- -- rmconsistgrpmember -- -- member_id ----------><

Parameter Description

member_id Required. Specifies the ID of the application to be deleted from a consistency

group.

Description
Use this command to delete an application from a consistency group. Use the udsinfo lsconsistgrpmember
command to locate the ID of a consistency group member.

Example
$ udstask rmconsistgrpmember 4111

| actifio.com | Actifio CLI Reference 231

 rmgroup
The rmgroup command deletes a group.

Rights
You must have the “Application Manage” or ‘Host Manage’ or ‘System Manage’ right to delete a group.

Syntax
>>- udstask -- -- rmgroup -- --+- group_name -+----------------><
'- group_id ---'

Parameter Description

group_id | Required. Specifies the ID or name of the group to be deleted. Use udsinfo
group_name lsgroup command to obtain the ID or name of a group.

Description
Use this command to delete a group.

Example
$ udstask rmgroup mktgroup

232 Actifio CLI Reference | actifio.com |

rmgroupmember
The rmgroupmember command deletes an application from a group.

Rights
You must have the ‘Application Manage” or 'System Manage' or ‘SLA Assign’ right to delete an application from a
group.

Syntax
>>- udstask -- -- rmgroupmember -- -- member_id ---------------><

Parameter Description

member_id Required. Specifies the ID of the group mapping to be removed.

Description
Use this command to delete an application from a group. Use the udsinfo lsgroupmember command to list the ID of
the application-to-group mapping.

Example
$ udstask rmgroupmember 4111

| actifio.com | Actifio CLI Reference 233

 syncback
When an application, protected with an asynchronous de-duplication policy, fails over to a remote appliance, the
application data is modified on the remote appliance. However, failing the application back to the primary appliance
requires synchronization of the application's data between the remote and primary appliances using the sync-back
command.
The syncback command synchronizes a previously failed over dedup-async protected application back to the original
Actifio appliance.

Rights
You must have the 'Host Manage' or 'Application Manage' or ‘Dedup-Async Manage’ right to sync-back a previously
failed over application.

Syntax
>>- udstask -- -- syncback -- -- -id --+- app_id --------+-- --->
'- consistgrp_id -'
>--+-------------------+---------------------------------------><
'- -label -- label -'

Parameter Description

-id app_id | consistgrp_id Required. Specifies the ID of the application or consistency group to be
synchronized back from the previously failed over application or consistency
group. Use udsinfo lsapplication or udsinfo lsconsistgrp for the ID .

-label label Optional. Specifies label for the newly created sync-back image.

Description
Use this command to synchronize a dedup-async protected application back to the original Actifio appliance. This
command can be issued only on the failed over appliance. This is to merge all changes made to the failed over
application on remote appliance back to the original appliance, in preparation for the eventual fail-back.

Example
$ udstask syncback -id 4111

234 Actifio CLI Reference | actifio.com |

testfailover
The testfailover command tests a dedup-async protected application for fail-over.

Rights
You must have the 'Host Manage' or 'Application Manage' or ‘Dedup-Async Manage’ or ‘Dedup-Async Test’ right to
right to test an application.

Syntax
>>- udstask -- -- testfailover -- -- -id --+- app_id --------+-->
'- consistgrp_id -'
>--+------------------------------+-- --------------------------------->
'- -accessmode --+- ro ---+-- -'
+- rw ---+
+- deny -+
'- root -'
>--+---------------+-- --+------------------------------+-- ----------->
'- -allvolumes -' '- -exporttype --+- cifs -+-- -'
'- nfs --'
>--+-------------------------+-- --+-------------------------+-- ------>
'- -exportedname -- name -' '- -exportedpath -- path -'
>--+--------------------------+-- --+----------------------------+-- -->
'- exportoption -- option -' '- -exporthost -- host_list -'
>--+-------------------------------+-- --+-------------------+-- ------>
'- -exportobjectid -- objectid -' '- -group -- group -'
>--+-----------------------------------+-- --+----------------+-- ----->
'- -exportobjecttype -- objecttype -' '- -poweroffvm -'
>--+---------------------------+-- --+-------------------+-- ---------->
'- -datastore -- datastore -' '- -label -- label -'
>-- -host --+- host_name -+-- --+-----------------------------+-- ----->
'- host_id ---' '- -hypervisor -- hypervisor -'
>--+--------------------------------+-- --+-----------+-- ------------->
'- -mgmtserver --+- host_id ---+-' '- -nowait -'
'- host_name -'
>--+-----------------+-- --+----------------------------+-- ----------->
'- -path -- path -' '- -restoreoption -- option -'
>--+---------------------+-- --+--------------------------+-----------><
'- -script -- script -' '- -user -- user_password -'

| actifio.com | Actifio CLI Reference 235

 Parameter Description

-id app_id | consistgrp_id Required. Specifies the ID of the application or consistency group to be
tested, the application should be protected with a dedup-async policy.

-accessmode Optional, valid only for export to CIFS type. Specifies the type of access that
ro | rw | deny | root is allowed for the specified user (in -user). Allowed types are:
- ro: read-only
- rw: read-write
- deny: no access allowed
- root: has full access to all the files in the share even if ACLs do not

-allvolumes Optional. The flag specifies whether to export all volumes in the backup. Use
-export objectid to specify a specific volume to be exported.

-datastore datastore Optional. Required for VMWare Virtual Machine applications. Specifies the
datastore to be used to test the fail-over.

-esxhost esxhost Optional and valid only for a virtual machine backup image. Specifies the ESX
host on which fail-over should happen. This is the ESX host for VMWare and
Microsoft Hyper-V Server for Hyper-V.

-host Required. Specifies the host source ID, name, or the name of the virtual
host_name | host_id machine to fail over to. For a regular host, the host should exist already.

-hypervisor hypervisor Optional. required for Virtual Machine applications) Specifies the hypervisor to
be used for the test failover.
This is the ESX host for VMWare, and Microsoft Hyper-V Server for Hyper-V.

-label label Optional.Specifies label for the test fail-over image.

-mgmtserver host_id | Optional. required for Virtual Machine applications) Specifies the
host_name management server to be used for test fail-over. This is the vCenter host for
VMWare and Microsoft System Center Virtual Machine Manager for Hyper-V.

nowait Optional. Specifies not to wait for the completion of the command.

-path path Optional. valid only for Hyper-V Virtual Machine backup image) Specifies the
path to be used for test fail-over to a new Hyper-V Virtual Machine.

-restoreoption option Optional. A comma delimited list of restore options where each restore
option is a name=value pair. See Appendix F, List of Restore Options for a
summary of the supported restore options for this command.

236 Actifio CLI Reference | actifio.com |

 Parameter Description

-script script Optional. Specifies a script during different phases of the operation. Four
phases are supported, INIT, PRE, POST, FINAL, and ABORT. Each phase, a
timeout, name of the script, and argument list can be specified. Name of the
script is required, timeout and args are optional. Syntax for each phase is:
name=<name>:phase={INIT|PRE|POST|FINAL}:[timeout=<timeout>]:[args=a
rg1,arg2]Multiple phases can be specified, separated by semi-colon (;), for
example, "name=setup.sh:phase=INIT;name=freeze.sh:phase=PRE"

-exportedname name Optional. Specifies the exported name of the backup image, valid only for
CIFS.

-exportedpath path Optional. Specifies sub-directory within the mount volume to be exported.

-exporthost host_list Optional. Specifies the ID or name of host(s) to which the backup image is to
be exported. If ID is used, the host has to already exists in the Actifio
appliance. Name can contain wild characters. More than one host can be
specified, separated by a comma (,).

-exportobjectid objectid Optional. Specifies the objectid of the individual volume within the mounted
image to be exported.

-exportobjecttype Optional. Specifies the objecttype of the individual volume within the
objecttype mounted image to be exported.

-poweroffvm Optional. By default, testfailover of VM image is powered on automatically.

By specifying '-poweroffvm' will leave the VM in the powered off state.

-exportoption option Optional. Specifies the export option, a name/value list, separated by equal
(=). Muiltiple options is separated by comma (,). An example is,
* "readonly=true,writedelay=false"
The following option is allowed for NFS,
• readonly="true | false"
• writedelay="true | false"
• rootsquash="true | false"
• allsquash="true | false"
• anonuid="0"
• anongid="1"
• insecurelocks="true | false"
The following option is allowed for CIFS,
• allowguest="true | false"

-exporttype Optional. Specifies protocol, cifs for CIFS, and nfs for NFS. Default to the
cifs | nfs protocol the backup was created.

| actifio.com | Actifio CLI Reference 237

 Parameter Description

-group group Optional, valid only for export to CIFS type. Specifies a list of domain groups
that are allowed to map the share, separated by a comma (,).

-user user_password Optional, valid only for export to CIFS type. Specifies a list of domain users
that are allowed to map the share, separated by comma (,). Also allowed are
local user (with specified password), use colon (:) to separate username and
password. The local user does not need to exist in Windows Domain or the
Actifio appliance, but it has to be unique.

Description
Use this command to test an application protected with an enhanced asynchronous deduplication (dedup-async)
policy.

Example
$ udstask testfailover -id 4111 -host myhost

238 Actifio CLI Reference | actifio.com |

vmdiscovery
The vmdiscovery command discovers virtual machines managed by a vCenter. The discovered virtual machines can
then be protected by the Actifio appliance.

Rights
You must have 'Host Manage' right to discover virtual machines.

Syntax
>>- udstask -- -- vmdiscovery -- --+---------------------+------>
'- -discoverclusters -'
>--+----------------+-- --+-----------+-- --+-----------+------->
'- -discovervms -' '- -addall -' '- -addvms -'
>--+----------------------------+-- --+-------------------+----->
'- -cluster -- cluster_name -' '- -delim -- delim -'
>--+- -host --+- host_name -+-- --+-----------------------+----->
'- host_id ---' '- -org -+- org_id ---+-'
'- org_name -'
>--+---------------+------------+-------------------+-----------><
'- -vms -- vms -' '- -nohdr -- nohdr -'

Parameter Description

-addall Optional. Specifies that all virtual machines discovered in the appliance, specified
with the -cluster parameter, should be added to the Actifio appliance. Valid only
when used with the - discovervms parameter.

-addvms Optional. Virtual machines to be added to Actifio appliance. Specify VM name,

UUID of the VM to add.

-cluster cluster_name Optional. Specifies the cluster name that the virtual machines should be
discovered on. Required when using the -discovervms and - addvms parameters.

-delim delimiter Optional. The delimiter to be used when displaying results.

-nohdr Optional. By default, headings are displayed for each column of data in a concise
style view, and for each item of data in a detailed style view. The -nohdr
parameter suppresses the display of these headings. If there is no data to be
displayed, headings are not displayed.

-discoverclusters Optional, but required to discover appliances on a vCenter.

-discovervms Optional, but required to discover virtual machines. Discover virtual machines on
the specified appliance.

| actifio.com | Actifio CLI Reference 239

 Parameter Description

-host Required. Specifies the vCenter host to perform discovery on using the ID or
host_name | host_id name of the vCenter host. Use the udsinfo lshost command to obtain the ID or
name of the vCenter host. The vCenter should have been added to the Actifio
appliance with udstask mkhost command.

-org org Optional. Specifies a default organization in which the new VM should be added
after discovery. To use this option user needs to have 'System Manage' right. If a
default organization is not specified, an organization that the user belongs to is
used.

-vms vms Optional. Virtual machines to be added to Actifio appliance. The list of virtual
machines should be separated by a colon (:). Required when using - addvms.

Description
Use this command to discover and add virtual machines to the Actifio appliance to protect them with SLAs. A typical
flow of the commands is:
udstask vmdiscovery -discoverclusters -host
Use -discoverclusters to discover appliances managed by this vCenter.
udstask vmdiscovery -discovervms -host -cluster -addall
Use -discovervms to discover virtual machines on the specified appliance.
udstask vmdiscovery -addvms -host -cluster -vms
Add Virtual Machines on the specified appliance to the Actifio appliance with -addvms.

Note: Multiple VMs must be separated with a colon (:).

Example
Discover clusters:
$ udstask vmdiscovery -discoverclusters -host vcenter1
name,type
ClusterQA,Cluster
Cluster_London,Cluster

240 Actifio CLI Reference | actifio.com |

Discover Virtual Machines in a cluster:
$ udstask vmdiscovery -discovervms -host vcenter1 -cluster ClusterQA
vmname,osname,hostname,ipaddress,status,esxhostname
Adso,Other (32-bit),,,1,esx13
QAS,Microsoft Windows Server 2003, Standard Edition,,,1,esx14
SmallWindowsOrig,Microsoft Windows Server 2003, Standard Edition,,,0,esx13

Add discovered Virtual Machines to the Actifio appliance:

$ udstask vmdiscovery -addvms -host vcenter1 -cluster ClusterQA -vms Adso:QAS

| actifio.com | Actifio CLI Reference 241

 addvm
The addvm command adds the Virtual Machines that are managed by a management server (vCenter for VMWare,
and SCVMM for Hyper-V), which then allows the added Virtual Machines to be protected by the Actifio appliance.

Syntax
>>- udstask -- -- addvm -- --+-----------+-- --------------------------->
'- -addall -'

>--+- -host --+- host_name -+-- --+-----------------------+--- --------->

'- host_id ---' '- -org -+- org_id ---+-'
'- org_name -'

>--+---------------+---------------------------------------------------><
'- -vms -- vms -'

Parameter Description

-addall Optional. Specifies that all Virtual Machines discovered in the are to be added to
the Actifio appliance.

-host host_name | Required. Specifies the management server host to perform discovery on, either
host_id id or name of host is needed. Use udsinfo lshost to locate the ID or name of the
management server host.

-org org_name | org_id Optional. Specifies a default organization in which the new VM should be added
after discovery. To use this option user needs to have 'System Manage' right. If a
default organization is not specified, an organization that the user belongs to is
used.
Use the udsinfo lsorg command to locate the ID or name of the organization.

-vms vms Optional. Virtual Machines, colon (:) separated, to be added to the Actifio
appliance.

Description
Use this command to add Virtual Machines to the Actifio appliance, so they can be protected by the appliance.

Example
To discover appliances:
$ udstask addvm -host vcenter1 -addall
To add discovered Virtual Machines to the Actifio appliance:
$ udstask addvm -host vcenter1 -vms Adso:QAS

242 Actifio CLI Reference | actifio.com |

lsvm
The lsvm command discovers Virtual Machines managed by a management server, which then allows the Virtual
Machines to be added to the Actifio appliance.

Syntax
>>- udsinfo -- -- lsvm -- --+-------------------+-- -------------------->
'- -delim -- delim -'

>--+- -host --+- host_name -+-- --+-------------------+----------------><

'- host_id ---' '- -nohdr -- nohdr -'

Parameter Description

-delim Optional. The delimiter to be used when displaying results.

-nohdr Optional. By default, headings are displayed for each column of data in a concise
style view, and for each item of data in a detailed style view. The -nohdr
parameter suppresses the display of these headings. If there is no data to be
displayed, headings are not displayed.

-host Required. Specifies the management server host to perform discovery on, either
id or name of host is needed. Use udsinfo lshost to locate the ID or name of the
management server host.

Description
Use this command to discover Virtual Machines managed by a management server, vCenter for VMWare, and
SCVMM for Hyper-V.

Example
$ udsinfo lsvm -host vcenter1
vmname,osname,hostname,ipaddress,status,esxhostname
Adso,Other (32-bit),,,1,esx13
QAS,Microsoft Windows Server 2003, Standard Edition,,,1,esx14
SmallWindowsOrig,Microsoft Windows Server 2003, Standard Edition,,,0,esx13

| actifio.com | Actifio CLI Reference 243

 backup
The backup command creates an on-demand backup of an application or a consistency group.

Rights
You must have the 'Host Manage' or 'Application Manage' or ‘Backup Manage’ right to back up an application or a
consistency group.

Syntax
>>- udstask -- -- backup -- -- -app --+- app_id --------+------->
'- consistgrp_id -'
>--+------------------------------+-- -------------------------->
'- -backuptype --+- log -----+-' '- -queue -'
+- db ------+
'- dblog ---'
>--+-------------------+-- --+----------------------------+----->
'- -label -- label -' '- -options --+- nobitmap -+-'
+- noparent -+
'- noseed ---'
>-- -policy -- policy_id -- --+---------------------+----------><
'- -script -- script -'

Parameter Description

-app app_id | Required. Specifies the ID of the application or consistency group to back up. Use
consistgrp_id udsinfo lsapplication or udsinfo lsconsistgrp to obtain the ID.

-backuptype Optional. Specifies type of backup to perform, only valid for Log Protection-enabled
log | db | dblog database applications. Supported types are:
• log - backup log data only
• db - backup db data only
• dblog - backup both db and log data

-queue Optional. Queues the backup request for an on-demand job. If there are no slots
available to run the on-demand job, the job is queued and the job name is returned.
The job will remain in the queued state until an on-demand slot opens up. When a
slot opens, the job will progress to the running state. This sequence occurs in the
order that the job was submitted.
Without the -queue argument, the backup request fails the job if there are no more
slots available. In this case, the on-demand job is not queued when there are no
slots available to run it, and an error message will be returned.
See Managing Jobs and Job Slots on page 405 for background details about on-
demand jobs and the queuing of on-demand jobs.

244 Actifio CLI Reference | actifio.com |

 Parameter Description

-label label Optional. Specifies label for the newly created backup image.

-options Optional. Specifies one or more options for the on-demand backup. If more than
nobitmap |noparent one option is specified, they should be separated by a colon (:). Supported options
|noseed are:
• nobitmap: do not use a bitmap or extent list
• noparent: no ancestor object, create a new independent object
• noseed: no hydroseeding image

-policy policy_id Required. Specifies the policy ID to be used for backup. The policy should be a part
of the service level agreement (SLA) that protects the application. Use lspolicy to
obtain the policy ID.

-script script Optional. Specifies a script during different phases of the operation. Five phases are
supported, INIT, PRE, POST, FINAL, and ABORT. Each phase, a timeout, name of
the script, and argument list can be specified. Name of the script is required,
timeout and args are optional. Syntax for each phase is:
name=<name>:phase={INIT|PRE|POST|FINAL}:[timeout=<timeout>]:[args=arg1,ar
g2] Multiple phases can be specified, separated by semi-colon (;), for example,
"name=setup.sh:phase=INIT;name=freeze.sh:phase=PRE"

Description
Use this command to back up an application or a consistency group that is running the specified policy immediately.
Use the following CLI commands to obtain the ID
• udsinfo lsapplication command to obtain application ID
• udsinfo lsconsistgrp to obtain the consistency group ID
• udsinfo lspolicy command to obtain policy ID

Example
$ udstask backup -app 4222 -policy 4111

| actifio.com | Actifio CLI Reference 245

 chbackup
The chbackup command changes a backup image.

Rights
You must have the 'Application Manage' or ‘Host Manage’ right to change the expiration time of a backup image.

Syntax
>>- udstask -- -- chbackup -- --+---------------------------+--->
'- expiration -- timestamp -'
>--+-------------------------+-- ------------------------------->
'- -sensitivity --+- 0 -+-'
'- 1 -'
>--+----------------------+-- --+- backup_name -+--------------><
'- -label -- newlabel -' '- backup_id ---'

Parameter Description

-expiration timestamp Optional. Specifies expiration time for the backup image. The format must be
'yyyy-mm-dd HH:MM:SS'.

-sensitivity 0 | 1 Optional. Specifies if the backup image is sensitive (a backup image has
restricted access before scrubbing of sensitive data). Specify 1 for a sensitive
application or 0 for a non-sensitive application.

-label label Optional. Specifies a new label for the backup image. For LiveClone, the label has
to be unique.

backup_id | Required. Specifies the backup image object to modify, either by ID or by name.
backup_name

Description
Use this command to change a backup image. Use the udsinfo lsbackup to obtain the ID or name of the backup
image.

Example
$ udstask chbackup -expiration '2010-08-15 14:59:59' 4111

246 Actifio CLI Reference | actifio.com |

cloneimage
The cloneimage command clones (makes a copy of) a backup image.

Rights
You must have the 'Host Manage' or the 'Application Manage' or ‘Clone Manage’ rights to clone a backup image.

Syntax
>>- udstask -- -- cloneimage -- -- -image --+- image_name -+---->
'- image_id ---'
>--+-----------------------------+-- --+---------------------+-->
'- -host --+- host_name -+-- -' '- -vmname -- vmname -'
'- host_id ---'
>--+---------------------------+-- --+-----------+-- ----------->
'- -datastore -- datastore -' '- -nowait -'
>--+---------------------------------+-- --+-----------------+-->
'- -diskpool --+- pool_name -+-- -' '- -path -- path -'
'- pool_id ---'
>--+-----------------------------+-- --+-------------------+---->
'- -hypervisor -- hypervisor -' '- -label -- label -'
>--+-------------------------+-- --+--------------+-- ---------->
'- -parts -- volume_list -' '- -poweronvm -'
--+----------------------------+-- --+---------------------+--->
'- -restoreoption -- option -' '- -script -- script -'
>--+-----------------------------------+-----------------------><
'- -mgmtserver --+- host_name -+-- -'
'- host_id ---'

Parameter Description

-datastore datastore Optional. (Valid only for VMWare Virtual Machine the backup images),
specifies the datastore to be used for cloning. Use this option if a different
datastore should be used for the clone.

-diskpool Optional, valid only for a non-virtual machine backup image. Specifies the
pool_name | pool_id diskpool to be used for storing the cloned image.

-hypervisor hypervisor Optional, valid only for Virtual Machine backup image) Specifies the hyper
visor on which clone should happen. Use this option if a different hyper-
visor should be used for the clone. This is the ESX host for VMWare, and
Microsoft Hyper-V Server for Hyper-V.

| actifio.com | Actifio CLI Reference 247

 Parameter Description

-esxhost esxhost Optional and valid only for a virtual machine backup image. Specifies the
hypervisor on which clone should happen. Use this option if a different
hypervisor should be used for the clone. This is the ESX host for VMWare
and Microsoft Hyper-V Server for Hyper-V.

-host host_id Optional. For non-VM backup image, host specifies the ID or name of the
host to which the backup image should be cloned. Use the udsinfo lshost
command to locate the ID or name of the host.

-image Required. Specifies the image to be cloned, either the image ID or image
image_name | image_id name is allowed, which can be retrieved from udsinfo lsbackup.

-label label Optional. Specifies label for the cloned image.

-nowait Optional. The flag specifies not to wait for the completion of the command.

-parts volume_list Optional. Specifies list of logical volumes to be cloned. Logical names of
the restorable objects can be retrieved from udsinfo lsbackup, and is one
of:
• vdisk UID name for generic applications
• file system or device name for discovered applications
• VMDK path name for Virtual Machines
For Virtual Machines, a different datastore is allowed for each VMDK, to
specify a different pool or datastore, use a colon ':', after the logical volume
name.
Special characters needs to be properly escaped:
• double quote ("): needs to be escaped with '\' (shell)
• comma (,): needs to be escaped with two commas (,,)
• colon (:): needs to be escaped with two colons (::)
Example: "myvm.vmdk:ds,,name,yourvm.vmdk:ds::name"

-path path Optional, valid only for Hyper-V Virtual Machine backup image) Specifies the
path to be used for cloning to a new Hyper-V Virtual Machine.

-restoreoption option Optional. A comma delimited list of restore options where each restore
option is a name=value pair. See Appendix F, List of Restore Options for a
summary of the supported restore options for this command.

-script script Optional. Specifies a script during different phases of the operation. Four
phases are supported, INIT, PRE, POST, and FINAL. Each phase, a timeout,
name of the script, and argument list can be specified. Name of the script
is required, timeout and args are optional. Syntax for each phase is:
name=<name>:phase={INIT|PRE|POST|FINAL}:[timeout=<timeout>]:[args
=arg1,arg2]Multiple phases can be specified, separated by semi-colon (;),
for example, "name=setup.sh:phase=INIT;name=freeze.sh:phase=PRE"

248 Actifio CLI Reference | actifio.com |

 Parameter Description

-vmname vmname Optional, valid only for a virtual machine backup image. Specifies the new
virtual machine name for the clone.

-poweronvm Optional. By default, clone of VM image is in the power off state. By

specifying '-poweronvm' will power on the VM.

-mgmtserver host_id | Optional, valid only for Virtual Machine backup image) Specifies the
host_name management server (name or ID, previously added to the Actifio appliance),
if the new clone is to be clone to a new management server. This is the
vCenter host for VMWare and Microsoft System Center Virtual Machine
Manager for Hyper-V.

Description
Use this command to clone a backup image. The cloned image is considered a fully operational application that uses
the primary storage in case of a non-virtual machine backup image.

Example
$ udstask cloneimage -image 5001 -host hudson -diskpool act_per_pool000
$ udstask cloneimage -image Image_000402 -vmname newvm -esxhost esx1

Clone of generic application or consistgrp:

$ udstask cloneimage -image Image_0056472 -parts 'vdisk:vd_6' \
-diskpool act_per_pool000 -host bouncer

Clone of a VM:
$ udstask cloneimage -image Image_0012537 \
-parts '[ds600gb] cl_vm_test1/cl_vm_test1_1.vmdk','[ds600gb] cl_vm_test1/cl_vm_test1.vmdk'
\
-vmname abcdefg -esxhost testesxhost -datastore ds600gb

$ udstask cloneimage -image Image_0036467 \

-parts 'M:\@act_per_pool000,E:\@act_per_pool000' -host bouncer \
-diskpool act_per_pool0000

| actifio.com | Actifio CLI Reference 249

 replicateimage
The replicateimage command replicates (sends a copy of) a dedup or directdedup backup image to a remote Actifio
appliance.

Rights
You must have 'Host Manage,' or 'Application Manage,' or ‘Backup Manage’ rights to replicate a dedup or directdedup
backup image.

Syntax
>>- udstask -- -- replicateimage -- -- -image --+- name -+-- --->
'- id ---'
>--+-----------+-- -- -targetcluster --+- cluster_name -+-- ---->
'- -nowait -' '- cluster_id ---'
>--+----------------------+-- ---------------------------------->
'- -inheritexpiration -'
>--+---------------------------+-- --+-------------------+-- --->
'- -retention -- retention -' '- -label -- label -'
>--+----------------------------------+------------------------><
'- -retentionm --+- hours ----+-- -'
+- days -----+
+- weeks ----+
+- months ---+
'- years ----'

Parameter Description

-image Required. Specifies the image to be replicated, either image ID or image name is
allowed, which can be retrieved from udsinfo lsbackup.

-label label Optional. Specifies label for the mounted image.

-inheritexpiration Optional. If specified, the expiration of the replicated image will be the same as the
expiration of the source image. This flag cannot be set if -retention is supplied.

-retention Optional. Specifies the retention period for the replicated dedup backup image. By
default, the replicated image will have the same expiration date as the original
image.

-retentionm Optional. Specifies the retention measurement type for the policy. Default is set to
hours | days | weeks | months.
months | years

-targetcluster Required. Target appliance to replicate the dedup backup image to. Use the
cluster_name | udsinfo lscluster command to locate the ID or name of the Actifio appliance.
cluster_id

250 Actifio CLI Reference | actifio.com |

Description
Use this command to replicate a dedup or directdedup backup image to a remote Actifio appliance. When you use this
method to replicate an image to the remote Actifio appliance the following information about the image is sent along
with the image:
• The Application ID of the application on the source appliance.
• The Application Name of the application on the source appliance.
• The Hostname of the host on the source appliance.
• The Source Appliance ID.
• The consistency date of the image (the point in time that the image is based on).
This information is sufficient to locate a particular application image and decide which image is the most appropriate
based on the consistency date.

Note: The name of the policy that originally created this dedup backup image will not be recorded on the remote
Actifio appliance. This occurs because the replicated image was not created by a policy but by manual replication.

We recommend that you use the -label parameter to add any desired additional metadata such as source policy name.

Example
$ udstask replicateimage -image 5001 -targetcluster 4011

| actifio.com | Actifio CLI Reference 251

 createliveclone
The createliveclone command creates a LiveClone.

Rights
You must have 'Host Manage' or 'Application Manage' or ‘Backup Manage’ rights to create a LiveClone.

Syntax
>>- udstask -- -- createliveclone -- -- -label -- label -------->

>-- -diskpool --+- diskpool_name -+-- --+-----------+-- -------->

'- diskpool_id ---' '- -nowait -'

>--+---------------------+-- -- -sourceimage --+- image_name --><

'- -script -- script -' '- image_id ---'

Parameter Description

-diskpool Required. Specifies thediskpool to use for the LiveClone.

diskpool_name |
diskpool_id

-label label Required. Specifies label for the LiveClone. A label needs to be unique in each
application.

-nowait Optional. The flag specifies whether to wait for the completion of the command.

-sourceimage Required. Specifies ID or name of the image to create the LiveClone from.
image_name |
image_id

Description
Use this command to create a LiveClone. A LiveClone allows subsequent refresh from a new backup image.

Example
$ udstask createliveclone -label testdb -sourceimage Image_000402 -diskpool act_per_pool000 \

252 Actifio CLI Reference | actifio.com |

prepmount
The prepmount command prep-mounts a LiveClone image to a host to allow prep operation to be performed.

Rights
You must have 'Host Manage' or 'Application Manage' rights to prep-mount a LiveClone image.

Syntax
>>- udstask -- -- prepmount -- -- -image --+- image_name -+-- --------->
'- image_id ---'
>--+-------------+-- -- -host --+- host_name -+-- --+-----------+-- --->
'- -appaware -' '- host_id ---' '- -nowait -'
>--+----------------+-- --+--------------------------------+-- -------->
'- -physicalrdm -' '- recoverytime -- recoverytime -'
>--+----------------------------+-- --+---------------------+-- ------><
'- -restoreoption -- option -' '- -script -- script -'

Parameter Description

-appaware Optional. The flag specifies whether the mount is to create an app-aware application
from the prep-mount.

-host host_name | Required. Specifies the ID or name of an existing host to which the LiveClone image
host_id is to be prep-mounted.

-image image_name | Required. Specifies the LiveClone image to be mounted, either image ID or image
image_id name is allowed, which can be retrieved from udsinfo lsbackup.

-nowait Optional. The flag specifies whether to wait for the completion of the command.

-physicalrdm Optional. Specifies physical Raw Device Mapping (RDM) should be used for VM
backup image, instead of default virtual compatibility mode.

-recoverytime Optional. Valid only for database applications. Specify the point-in-time for recovery,
recoverytime by applying log backups to roll forward to the specified time of the host. The time
should be within the range set by hostbeginpit and hostendpit when displayed
using udsinfo lsbackup xxxx for that image. The time format should be either:
yyyy-MM-dd HH:mm:ss or yyyy-MM-dd HH:mm:ss.SSS.

-restoreoption option Optional. A comma delimited list of restore options where each restore option is a
name=value pair. See Appendix F, List of Restore Options for a summary of the
supported restore options for this command.

| actifio.com | Actifio CLI Reference 253

 Parameter Description

-script script Optional. Specifies a script during different phases of the operation. Four phases are
supported, INIT, PRE, POST, FINAL, and ABORT. Each phase, a timeout, name of the
script, and argument list can be specified. Name of the script is required, timeout
and args are optional. Syntax for each phase is:
name=<name>:phase={INIT|PRE|POST|FINAL}:[timeout=<timeout>]:[args=arg1,ar
g2] Multiple phases can be specified, separated by semi-colon (;), for example,
"name=setup.sh:phase=INIT;name=freeze.sh:phase=PRE"

Description
Use this command to prep-mount a LiveClone image to a host.

Example
$ udstask prepmount -image Image_000402 -host boston

254 Actifio CLI Reference | actifio.com |

prepunmount
The prepunmount command prep-unmounts and optionally discards a prep-mounted LiveClone image.

Rights
You must have 'Host Manage' or 'Application Manage' rights to prep-unmount a prep-mounted LiveClone image.

Syntax
>>- udstask -- -- prepunmount -- -+- -image -- image_name -+---->
'- image_id ---'

>--+------------+-- --+-----------+-- -------------------------->

'- -discard -' '- -nowait -'

>--+---------------------+-------------------------------------><
'- -script -- script -'

Parameter Description

-discard Optional. The flag specifies whether to discard the prep-mounted LiveClone image,
after it is unmounted.

-image image_name | Required. Specifies the LiveClone image to be prep-unmounted, either image ID or
image_id image name is allowed, which can be retrieved from udsinfo lsbackup. The
LiveClone image has to be already prep-mounted.

-nowait Optional. The flag specifies whether to wait for the completion of the command.

-script script Optional. Specifies a script during different phases of the operation. Four phases are
supported, INIT, PRE, POST, and FINAL. Each phase, a timeout, name of the script,
and argument list can be specified. Name of the script is required, timeout and args
are optional. Syntax for each phase is:
name=<name>:phase={INIT|PRE|POST|FINAL}:[timeout=<timeout>]:[args=arg1,ar
g2] Multiple phases can be specified, separated by semi-colon (;), for example,
"name=setup.sh:phase=INIT;name=freeze.sh:phase=PRE"

Description
Use this command to prep-unmount a prep-mounted LiveClone image, optionally discards the prep-mounted
LiveClone image after it is prep-unmounted.

Example
$ udstask prepunmount -image Image_000402 -nowait

| actifio.com | Actifio CLI Reference 255

 deleteimage
The deleteimage command deletes an unmounted backup image, a LiveClone image, a fail-over image, or a test fail-
over image.

Rights
You must have the 'Host Manage' or the 'Application Manage' or ‘Mount Manage” right to delete an unmounted
backup image.

Syntax
>>- udstask -- -- deleteimage -- ------------------------------->
>-- -image --+- image_name -+-- --+-----------+----------------><
'- image_id ---' '- -nowait -'

Parameter Description

Required. Specifies the ID or name of the backup image to be deleted. Use

-image image_name | image_id
the udsinfo lsbackup command to obtain the ID or name of the backup
image.

-nowait Optional. The flag specifies not to wait for the completion of this
command.

Description
Use this command to delete a unmounted backup image, a fail-over image, or a test fail-over image. Use udsinfo
lsbackup command to locate the backup images to be deleted. Note that there are three images associated with each
fail- over execution, pick the one with name ended with 'F' to delete for fail-over images. Fail-over images can only be
deleted when the application is no longer in the fail-over state.

Example
$ udstask deleteimage -image Image_000402

256 Actifio CLI Reference | actifio.com |

expireimage
The expireimage command expires a backup image, a LiveClone or a sync back image.

Rights
You must have the 'Host Manage' or 'Application Manage' or ‘Backup Manage’ right to expire a backup image.

Syntax
>>- udstask -- -- expireimage -- -+-----------+----------------->
'- -force -'
>-- -image --+- image_name -+-- --+-----------+----------------><
'- image_id ---' '- -nowait -'

Parameter Description

-force Optional. The flag specifies whether to ignore errors when unmapping
disks from the host.

-image Required. Specifies the ID or name of the image to be expired. You can
image_name | image_id obtain the name and ID of an image using the udsinfo lsbackup
command.

-nowait Optional. The flag specifies whether to wait for the completion of this
command.

Description
Use this command to expire a backup image, a LiveClone or a syncback image.

Example
$ udstask expireimage -image Image_000402

| actifio.com | Actifio CLI Reference 257

 lsbackup
The lsbackup command displays a concise list of backup images or a detailed view of a backup image.

Rights
You must have the 'Host Manage', and 'Application Manage' right to change the expiration time of a backup image.

Syntax
>>- udsinfo -- -- lsbackup -- ---------------------------------->

>--+--------------------------------+-- --+----------+-- ------->

'- -filtervalue -- attrib=value -' '- -nohdr -'

>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+
'- object_name -'

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim: on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

258 Actifio CLI Reference | actifio.com |

 Parameter Description

-filtervalue Optional. Specifies that you want your report to display any or the entire list of valid
attrib=value filter attributes. The valid filter attributes for the udsinfo lsbackup command are:
• appid
• appname
• apptype
• backupdate [usage: 'backupdate since 24 hours' for backups started
since last 24 hours, 'backupdate before 7 days' for backups started older
than 7 days]
• backupname
• characteristic [PRIMARY | MOUNT | UNMOUNT | VDISK | CLONE]
• consistencydate
• expiration
• hostid
• hostname
• jobclass [ [ snapshot | dedup | dedupasync | clone | liveclone | syncback ]
• label
• mappedhost
• mountedhost
• policyname
• prepdate
• slpname
• sltname
• sourceimage
• sourceuds
• targetuds
• virtualsize
The filter is formed with an attribute and a value. When more than one filter is
specified, they must be delimited with the '&' symbol (which should be escaped
with '\'). For string type filters user can use the wild card character '*'. The only
operator allowed for a string type filter is '='.
For example, to match backup images with appname begins with 'foo', use '-
filtervalue appname=foo*'. Some filters allow only predefined constants. For
example, characteristic allows only PRIMARY, MOUNT,
UNMOUNT, VDISK, or clone. Therefore, to list a backup image that is mounted, use
'-filtervalue characteristic=MOUNT'. For number and date types, the permitted
operators are: =, >, >=, <, <=. The operators <, <=, >, or >= should be escaped
with '\' or enclosed in '' or "", as required by the shell.

| actifio.com | Actifio CLI Reference 259

 Parameter Description

-filtervalue Some examples:

attrib=value
• -filtervalue virtualsize\>128000000000
(continued)
• -filtervalue "virtualsize>128000000000"
• -filtervalue 'virtualsize>128000000000'
The backupdate and expiration parameters can also use these operators. For
example:
• -filtervalue 'backupdate>2010-09-28'
• -filtervalue 'expiration>2010-09-28 6:50:00’

-nohdr Optional. By default, headings are displayed for each column of data in the concise
view, and for each item of data in the detailed view. The - nohdr parameter
suppresses the display of these headings.

Note: If there is no data to be displayed, headings are not displayed.

Description
Use this command to retrieve details of backup images. The concise view of a backup image shows only a subset of
the attributes of the image. The detailed view of a backup image provides more details.
Following are details about each attribute available with this command.
• id: Index of backup object.
• appid: Application object ID.
• restore lock: Flag value if it is being used for restore.
• virtual size: Backup object application size.
• original backup id: ID of dependent backup object from which it is generated.
• policy name: Name of the policy on which this object is created.
• mounted host: ID of host where backup image is mounted.
• username: Name of the user who created backup.
• sourceimage: Actual image name which is being backed up.
• apptype: Type of the application backed up.
• mappedhost: ID of the host to which backup image is mapped.
• modifiedbytes: No of bytes modified.
• modifydate: Date when backup image is last modified.
• jobclass: Type of the job that created this backup image.
• originaljobclass: Original backup type that this backup image is based on.
• flags: Backup data flag like in-band, out of band, SAN, NBD, readyVM, etc.
• status: Status of this backup image. Status like succeeded, failed, running, etc.

260 Actifio CLI Reference | actifio.com |

 • expiration: Expiration date time when this should expire.
• sourceuds: Source appliance ID where this image is generated.
• expirytries: No of expire attempts made on this image.
• hostname: Host name of backup image where application was running.
• label: Friendly name of backup image.
• consistencydate: Application consistency time stamp.
• backupdate: Start date.
• backupname: Image name.
• targetuds: Target appliance ID to which image is replicated or remote copied.
• sltname: SLA template name used while creating this image.
• slpname: Profile name used while creating this image.
• appname: Application name.
• prepdate: Date when LiveClone image is prepped.
• transport: Transport medium used for this image (for example, SAN, NBD, and so on).
• consistency-mode: Consistency mode of image (for example, application consistent or crash consistent).
• uniquehostname: Unique host name.
• advancedoptions: Policy options that is being used to create the backup.
• componenttype: Primary or log backup of a DB/Exchange application type.

Example
$ udsinfo lsbackup -delim = 146537
appid=135601
backuplock=0
originatinguds=590031618350
policyname=Production to Snap 1
username=
sourceimage=
prepdate=
mappedhost=0
componenttype=0
jobclass=snapshot
expiration=2014-09-12 13:41:11.506
status=succeeded
hostname=192.168.18.98
label=chk
uniquehostname=192.168.18.98_7677_00097
backupname=Image_0146535
slpname=LocalProfile

| actifio.com | Actifio CLI Reference 261

 virtualsize=64424509440
restorelock=0
originalbackupid=0
id=146537
mountedhost=0
apptype=Oracle
advancedoptions=<?xml version="1.0" encoding="UTF-8"?><advancedoptions
options="donotuncatalog#true|forcelevel0#true|forceoobbackup#true|inband#true|password#DtPjgLm
HINhSVzpgfdqhRw==|fs_password#DtPjgLmHINhSVzpgfdqhRw==|restorevalidate#true|username#sys|fs_us
ername#sys|userrole#sysdba"><applications name="outdb"
options="donotuncatalog#true|forcelevel0#true|forceoobbackup#true|inband#true|password#DtPjgLm
HINhSVzpgfdqhRw==|fs_password#DtPjgLmHINhSVzpgfdqhRw==|restorevalidate#true|username#sys|fs_us
ername#sys|userrole#sysdba"/></advancedoptions>
modifiedbytes=0
modifydate=2014-09-10 14:26:23.431
flags=84
sourceuds=590031618350
expirytries=0
consistencydate=2014-09-10 13:40:49.000
backupdate=2014-09-10 13:38:24.000
targetuds=590031618350
sltname=snap
appname=outdb
transport=SAN based, out-of-band storage
consistency-mode=crash-consistent

Image Details:
nvolumes=1
logicalname=/u01
restorableobject=outdb
uniqueid=dasvol:/u01
target=vdisk:fc-541007863E00
capacity=64424509440
volumekey=0
isbootvmdk=false
sourcemountpoint=/u01
islvm=true
incarnation=5

262 Actifio CLI Reference | actifio.com |

mountimage
The mountimage command mounts a backup image to a host.

Rights
You must have the 'Host Manage' or 'Application Manage' or ‘Mount Manage’ rights to mount a backup image.

Syntax
>>- udstask -- -- mountimage -- -- -image --+- image_name -+-- -------->
>--+------------------------------+-- --+---------------+-- ----------->
'- -accessmode --+- ro ---+-- -' '- -allvolumes -'
+- rw ---+
+- deny -+
'- root -'
>--+-------------+-- --+---------------------------------+-- ---------->
'- -appaware -' '- -diskpool --+- pool_name -+-- -'
'- pool_id ---'
>--+------------------------------+-- --------------------------------->
'- -exporttype --+- cifs -+-- -'
'- nfs --'
>--+-------------------------+-- --+-------------------------+-- ------>
'- -exportedname -- name -' '- -exportedpath -- path -'
>--+--------------------------+-- --+----------------------------+-- -->
'- exportoption -- option -' '- -exporthost -- host_list -'
>--+-------------------------------+-- --+-------------------+-- ------>
'- -exportobjectid -- objectid -' '- -group -- group -'
>--+-----------------------------------+-- ---------------------------->
'- -exportobjecttype -- objecttype -' '- -appid -- appid -'
>-- -host --+- host_name -+-- --+-----------------------+-- ----------->
'- host_id ---' '- -esxhost -- esxhost -'
>--+---------------------------+-- --+-------------------+-- ---------->
'- -datastore -- datastore -' '- -label -- label -'
>--+-----------------------------------+-- --+-----------+-- ---------->
'- -mgmtserver --+- host_name -+-- -' '- -nowait -'
'- host_id ---'
>--+-------------------------+-- --+-----------------+-- -------------->
'- -parts -- volume_list -' '- -path -- path -'
>--+----------------+-- --+--------------------------------+-- -------->
'- -physicalrdm -' '- recoverytime -- recoverytime -'
>--+---------------------------+-- --+---------------------+-- -------->

| actifio.com | Actifio CLI Reference 263

 '- restoreoption -- option -' '- -script -- script -'
>--+--------------------------+-- --+---------------------+-----------><
'- -user -- user_password -' '- -vmname -- vmname -'

Parameter Description

-host host_name | Required for non-Virtual Machine applications) Specifies the ID or name of an
host_id existing host to which the backup image is to be mounted. If a new Virtual Machine
is to be created for Virtual Machine backup. Use -vmname to specify the new
Virtual Machine name.

-esxhost Optional. Specifies the ID or name of the ESX host. When mounting a Virtual
Machine backup image to a different (from the Virtual Machine that the backup is
taken) Virtual Machine, use this switch to specify a new hypervisor to use.
Otherwise, hypervisor associated with the Virtual Machine host is used. This is the
ESX host for VMWare and Microsoft Hyper-V Server for Hyper-V.

-appid appid Optional. Use the latest snapshot backup image of the application, specified by the
appid for the mount. Use udsinfo lsapplication to retrieve the application ID.

-datastore datastore Optional. Valid only for VMWare Virtual Machine backup image. Specifies the
datastore to be used for mounting the image. Use this option if a different
datastore should be used for the mount. Use of this option is not typical.

-diskpool pool_name | Optional. Specifies the disk pool to be used for mount. Use udsinfo lsdiskpool to
pool_id locate the ID or name of the diskpool.

-accessmode ro | rw Optional. Valid only for export to CIFS type. Specifies the type of access that is
| deny | root allowed for the specified user (in -user). Allowed types are:
- ro: read-only
- rw: read-write
- deny: no access allowed
- root: has full access to all the files in the share even if ACLs do not

-allvolumes Optional. The flag specifies whether to export all volumes in the backup. Use -
exportobjectid to specify a specific volume to be exported.

-appaware Optional. The flag specifies whether the mount is to create an app-aware
application from the mount.

-exportedname name Optional. Specifies the exported name of the backup image, valid only for CIFS.

-exportedpath path Optional. Specifies sub-directory within the mount volume to be exported.

-exportobjectid Optional. Specifies the object ID of the individual volume within the mounted
objectid image to be exported.

264 Actifio CLI Reference | actifio.com |

 Parameter Description

-exportobjecttype Optional. Specifies the object type of the individual volume within the mounted
objecttype image to be exported.

-exportoption option Optional. Specifies the export option, a name/value list, separated by equal (=).
Multiple options is separated by comma (,). An example is:
* "readonly=true,writedelay=false"
The following option is allowed for NFS,
• readonly="true | false"
• writedelay="true | false"
• rootsquash="true | false"
• allsquash="true | false"
• anonuid="0"
• anongid="1"
• insecurelocks="true | false"
The following option is allowed for CIFS:
• readonly="true | false"
• allowguest="true | false"

-exporttype cifs | nfs Optional. Specifies protocol, cifs for CIFS, and nfs for NFS. Default to the protocol
the backup was created.

-group group Optional, valid only for export to CIFS type. Specifies a list of domain group that are
allowed to map the share, separated by a comma (,).

-exporthost host_list Optional. Specifies the ID or name of host(s) to which the backup image is to be
exported. If ID is used, the host has to already exists in the Actifio appliance Name
can contain wild characters. More than one host can be specified separated by a
comma (,).

-hypervisor hypervisor Optional. Specifies the ID or name of the hypervisor. When mounting a Virtual
Machine backup image to a different (from the Virtual Machine that the backup is
taken) Virtual Machine, use this switch to specify a new hypervisor to use.
Otherwise, hypervisor associated with the Virtual Machine host is used.
This is the ESX host for VMWare, and Microsoft Hyper-V Server for Hyper-V.

-image image_name Required. Specifies the image ID name to be mounted. You can retrieve the name
ID using the udsinfo lsbackup command.

-appid appid Optional. Specifies the application ID to mount the latest backed-up snapshot
image of this application. Use the udsinfo lsapplication command to retrieve the
application ID.

-label label Optional. Specifies label for the mounted image.

-nowait Optional. The flag specifies not to wait for the completion of the command.

| actifio.com | Actifio CLI Reference 265

 Parameter Description

-parts Optional. Specifies list of logical volumes to be mounted. Logical names of the
restorable objects can be retrieved from udsinfo lsbackup, and is one of:
• vdisk UID name for generic applications
• file system or device name for discovered applications
• VMDK path name for Virtual Machines
A different diskpool is allowed for mounting each volume, to specify a different
diskpool, use a colon ':', after the logical volume name.
Special characters must be properly escaped:
• double quote ("): needs to be escaped with '\' (shell)
• comma (,): needs to be escaped with two commas (,,)
• colon (:): needs to be escaped with two colons (::)
Example: "my,,vm.vmdk:poolname,your::vm.vmdk".

-path path Optional, valid only for Hyper-V Virtual Machine backup image, specifies the path to
be used for mounting a new Hyper-V Virtual Machine.

-mgmtserver host_id Optional, valid only for Virtual Machine backup image) Specifies the management
| host_name server (name or ID, previously added to the Actifio appliance), if the new image is
to be mounted to a new management server. This is the vCenter host for VMWare
and Microsoft System Center Virtual Machine Manager for Hyper-V.

-physicalrdm Optional. Specifies physical Raw Device Mapping (RDM) should be used for VM
backup image, instead of default virtual compatibility mode.

-recoverytime Optional. Valid only for database applications. Specify the point-in-time for recovery,
by applying log backups to roll forward to the specified time of the host. The time
should be within the range set by hostbeginpit and hostendpit when displayed
using udsinfo lsbackup xxxx for that image. The time format should be either:
yyyy-MM-dd HH:mm:ss or yyyy-MM-dd HH:mm:ss.SSS.

266 Actifio CLI Reference | actifio.com |

 Parameter Description

-restoreoption option Optional, A comma delimited list of restore options where each restore option is a
name=value pair. For a list of the available restore options, use udsinfo
lsrestoreoptions. See Appendix F, List of Restore Options for a summary of the
supported restore options for this command.
To perform an app-aware mount to a new application, additional restore options can
be provided through the udsinfo lsappclass command. Keep in mind that these
provisioning options must adhere to the rules of the appclass of the backup. In
addition, the app-aware mounted application can also be optionally protected, with
a new, or existing SLT and SLP, if so desired.
The existence of provisioningoptions indicates that this is an app-aware mount,
regardless of the -appaware flag. For example,
-restoreoption "provisioningoptions=<provisioningoptions>
<databasesid>foodb1</databasesid>
<orahome>/u01/app/oracle/product/11.2.0/db_1</orahome>
<utlfiledirectory>/home/oracle</utlfiledirectory>
<username>oracle</username>
</provisioningoptions>,reprotect=true"
Included below is an example for SQL:
udstask mountimage -image Image_22196358 -host demo-sql-4 -
restoreoption
'mountpointperdiskddasvol:S:\=C:\Test\jsontest,provisioningoptions
=<provisioning-options><sqlinstance>DEMO-SQL-4</
sqlinstance><dbname>jsontest</dbname><recover>true</recover></
provisioning-options>'
For the available appclass, and the provisioning options for each appclass, use
udsinfo lsappclass.

-script script Optional. Specifies a script during different phases of the operation. Four phases
are supported, INIT, PRE, POST, and FINAL. Each phase, a timeout, name of the
script, and argument list can be specified. Name of the script is required, timeout
and args are optional. Syntax for each phase is:
name=<name>:phase={INIT|PRE|POST|FINAL}:[timeout=<timeout>]:[args=arg1,ar
g2] Multiple phases can be specified, separated by semi-colon (;), for example,
"name=setup.sh:phase=INIT;name=freeze.sh:phase=PRE"

user user_password Optional. Valid only for export to CIFS type) Specifies list of domain users that are
allowed to map the share, separated by comma (,). Also allowed are local user (with
specified password), use colon (:) to separate username and password. The local
user does not need to exist in Windows Domain or the Actifio appliance, but it has
to be unique.

-vcenter vcenter_id | Optional and valid only for virtual machine backup image. Specifies the vCenter
vcenter_name server (name or ID, previously added to the Actifio appliance), when the image
should be mounted to a new vCenter server.

| actifio.com | Actifio CLI Reference 267

 Parameter Description

-vmname vmname Optional. Valid only for a virtual machine backup image. Specifies the new Virtual
Machine name to be mounted as.

Description
Use this command to mount a backup image to a host.

Examples
$ udstask mountimage -image Image_000402 -host boston
Mount the most recent snapshot for appid “1234” to host “bighost”:
$ udstask mountimage -image latest -appid 1234 -host bighost
Mount of generic application or consistency group:
$ udstask mountimage -image Image_0056472 -parts 'vdisk:vd_6','vdisk:vd_7' -host bouncer
-parts 'vuid:638A95F225800001F0000000000051C0','vuid:638A95F225800001F0000000000051C1'
-host bouncer
Partial mount of VM disks to any host:
$ udstask mountimage -image Image_0012095
-parts '[ds600gb] cl_vm_test1/cl_vm_test1_1.vmdk','[ds600gb] cl_vm_test1/cl_vm_test1.vmdk'
-host smokehost
Partial mount of a VM to a new VM:
$ udstask mountimage -image Image_00120537
-parts '[ds600gb] cl_vm_test1/cl_vm_test1_1.vmdk','[ds600gb] cl_vm_test1/cl_vm_test1.vmdk'
-vmname abcdefg -esxhost testesxhost -datastore ds600gb
A partial mount:
$ udstask mountimage -image Image_0036467 -parts 'M:\@act_per_pool000,E:\@act_per_pool000' -
host bouncer
Mount with export:
$ udstask mountimage -image Image_0064549 -exportoption "allsquash=true" -exporthost Adoni -
host bouncer

Mount with different drive letters:

udstask mountimage -image 1234 -host 5678 -restoreoption 'mountdriveperdisk-
dasvol:L:\=M:\,mountdriveperdisk-dasvol:S:\=N:\'
Mount with different mount points:
udstask mountimage -image 1234 -host 5678 -restoreoption 'mountpointperdisk-
dasvol:E:\=C:\Test\Data,mountpointperdisk-dasvol:F:\=C:\Test\Logs'
Mount of all volumes under a single mount point:
udstask mountimage -image 1234 -host 5678 -restoreoption mountpointpervolume=/tmp/mnt

268 Actifio CLI Reference | actifio.com |

Mount of all volumes starting with a specified drive letter (all volumes will get consecutive drive letters starting with
this drive):
udstask mountimage -image 1234 -host 5678 -restoreoption mountdrivepervolume=F:\\

| actifio.com | Actifio CLI Reference 269

 exportimage
The exportimage command exports a backup image to hosts. The backup image has to already been mounted.
Optionally, the mounted image can also be exported for NAS/CIFS backup.

Rights
You must have 'Host Manage' or 'Application Manage' rights to export a backup image.

Syntax
>>- udstask -- -- exportimage -- -- -image --+- image_name -+-- ------->
'- image_id ---'
>--+------------------------------+-- --------------------------------->
'- -accessmode --+- ro ---+-- -'
+- rw ---+
+- deny -+
'- root -'
>--+---------------+-- --+------------------------------+-- ----------->
'- -allvolumes -' '- -exporttype --+- cifs -+-- -'
'- nfs --'
>--+-------------------------+-- --+-------------------------+-- ------>
'- -exportedname -- name -' '- -exportedpath -- path -'
>--+--------------------------+-- -- -host -- host_list -- ------------>
'- exportoption -- option -'
>--+-----------+-- --+-------------------------+-- -------------------->
'- -nowait -' '- -objectid -- objectid -'
>--+--------------------------+-- --+-------------------+-- ----------->
'- -user -- user_password -' '- -group -- group -'
>--+-----------------------------+------------------------------------><
'- -objecttype -- objecttype -'

Parameter Description

-accessmode Optional. valid only for export to CIFS type. Specifies the type of access that is
ro | rw | deny | root allowed for the specified user (in -user). Allowed types are:
• ro: read-only
• rw: read-write
• deny: no access allowed
• root: has full access to all the files in the share even if ACLs do not

-allvolumes Optional. The flag specifies whether to export all volumes in the backup.Use -
objectid to specify a specific volume to be exported.

270 Actifio CLI Reference | actifio.com |

 Parameter Description

-exportedname name Optional. Specifies the exported name of the backup image, valid only for CIFS.

-exportedpath path Optional. Specifies sub-directory within the mount volume to be exported.

-exportoption option Optional. Specifies the export option, a name/value list, separated by equal (=).
Multiple options is separated by comma (,). An example is:
* "readonly=true,writedelay=false"
The following options are allowed for NFS:
• readonly="true | false"
• writedelay="true | false"
• rootsquash="true | false"
• allsquash="true | false"
• anonuid="0"
• anongid="1"
• insecurelocks="true | false"
The following options are allowed for CIFS:
• allowguest="true | false"

-exporttype cifs | nfs Optional. Specifies protocol, cifs for CIFS, and nfs for NFS. Default to the protocol
the backup was created.

-group group Optional. valid only for export to CIFS type. Specifies the list of domain groups that
are allowed to map the share, separated by a comma (,). The group does not need
to exist in Windows Domain or the Actifio appliance, but it has to be unique.

-host Required. Specifies the ID or name of host(s) to which the backup image is to be
exported. If ID is used, the host has to already exists in the Actifio appliance. Name
can contain wild characters. More than one host can be specified, separated by a
comma (,).

-image image_name | Required. Specifies the image to be exported, either image ID or image name is
image_id allowed, which can be retrieved from udsinfo lsbackup.

-nowait Optional. The flag specifies whether to wait for the completion of the command.

-objectid Optional. Specifies the object id of the individual volume within the mounted image
to be exported.

-user user_password Optional. Valid only for export to CIFS type. Specifies the list of domain users that
are allowed to map the share, separated by a comma (,). Also allowed are local user
(with specified password), use colon (:) to separate user name and password. The
local user does not need to exist in Windows Domain or the Actifio appliance, but it
has to be unique.

| actifio.com | Actifio CLI Reference 271

 Parameter Description

-objecttype Optional. Specifies the object type of the individual volume within the mounted
objecttype image to be exported.

Description
Use this command to export a backup image to hosts. The backup image has to be mounted first. Optionally, the
mounted image can also be exported for NAS/CIFS backup.

Examples
$ udstask exportimage -image Image_000402 -host 192.168.10.* -exportedname data

272 Actifio CLI Reference | actifio.com |

unexportimage
The unexportimage command is used to un-export an exported backup image.

Rights
You must have 'Host Manage' or 'Application Manage' rights to un-export an exported backup image.

Syntax
>>- udstask -- -- unexportimage -- -+- -image -- image_name -+-->
'- -image -- image_id ---'
>--+------------------------------+-- -------------------------->
'- -exporttype --+- cifs -+-- -'
'- nfs --'
>-- -- -host -- host_list -- --+-----------+-------------------><
'- -nowait -'

Parameter Description

-exporttype cifs | nfs Optional. Specifies protocol, cifs for CIFS, and nfs for NFS. Default to the protocol
the backup was created.

-host host_list Required. Specifies list of hosts (comma separated) that the export should be
removed.

-image image_name | Required. Specifies the image to be un-exported, either image ID or image name is
image_id allowed, which can be retrieved from udsinfo lsbackup. The backup image has to
be already exported.

-nowait Optional. The flag specifies whether to wait for the completion of the command.

Description
Use this command to un-export an exported backup image.

Example
$ udstask unexportimage -image Image_0004011 -host 192.168.10.*

| actifio.com | Actifio CLI Reference 273

 refreshliveclone
The refreshliveclone command refreshes a LiveClone from a new backup image.

Rights
You must have 'Host Manage' or 'Application Manage' or ‘Backup Manage’ rights to refresh a LiveClone.

Syntax
>>- udstask -- -- refreshliveclone -- --+-----------+-- -------->
'- -nowait -'

>--+--------------------------+-- --+-------------------+------->
'- -options --+- nobitmap -+ '- -label -- label -'
+- noparent -+
'- noseed ---'

>-- -sourceimage --+- image_name -+-- -------------------------->

'- image_id ---'

>--+-----------------------------------+-----------------------><
'- -targetimage --+- image_name -+--'
'- image_id ---'

Parameter Description

-label label Optional. Required if target image is not specified. Specifies label for the LiveClone
to refresh to.

-nowait Optional. The flag specifies whether to wait for the completion of the command.

-options nobitmap | Optional. Specifies one or more options for the on-demand backup. If more than
noparent | noseed one option is specified, they should be separated by a colon (:). Supported options
are:
• nobitmap - Do not use a bitmap or extentlist
• noparent - No ancestor object, create a new independent object
• noseed - No hydroseeding image

-sourceimage Required. Specifies ID or name of the image to refresh the LiveClone.

image_name |
image_id

-targetimage Optional. Specifies ID or name of the LiveClone to refresh.

image_name |
image_id

274 Actifio CLI Reference | actifio.com |

Description
Use this command to refresh a LiveClone from a new backup image.

Example
$ udstask refreshliveclone -label testdb -sourceimage Image_000402

| actifio.com | Actifio CLI Reference 275

 restoreimage
The restoreimage command restores a backup image.

Rights
You must have the ‘Application Manage’ or ‘Dedup-Async Manage’ or Host Manage' or 'Application Manage' or
‘Restore Manage’ rights to restore a backup image.

Syntax
>>- udstask -- -- restoreimage -- -+- -image -- image_name -+--->
'- image_id ---'
>--+-----------+-- --+-------------------------+-- ------------->
'- -nowait -' '- -parts -- volume_list -'
>--+---------------+-- --+----------------------------+-- ------>
'- -poweroffvm -' '- -restoreoption -- option -'
>--+-------------------------+-- --+------------------------+--->
'- -password -- password -' '- -username -- username-'
>--+------------+-- --+---------------------------------+-- ---->
'- -recover -' '- -recoverytime -- recoverytime -'
>--+---------------------+-------------------------------------><
'- -script -- script -'

Parameter Description

-image image_name | Required. Specifies the name or ID of the image to be restored.

image_id

-nowait Optional. Specifies not to wait for the completion of the command.

-parts volume_list Optional. Specifies list of logical volumes to be restored. Logical names of the
restorable objects can be retrieved from udsinfo lsbackup, and is one of:
• vDisk UID name for generic applications
• File system or device name for discovered applications
• VMDK path name for Virtual Machines

-poweroffvm Optional. By default, restore of VM image is powered on automatically. Specify 

-poweroffvm to leave the VM in the powered off state.

-restoreoption option Optional. A comma delimited list of restore options where each restore option is a
name=value pair. See Appendix F, List of Restore Options for a summary of the
supported restore options for this command.

-password Optional. Valid only for database applications. Specify the password to use to apply
the logs from log backup.

276 Actifio CLI Reference | actifio.com |

 Parameter Description

-recover Optional. Valid only for SQL Server. If this flag is set the database will be brought
online and transaction log backups cannot be used to roll forward the database.

-recoverytime Optional. Valid only for database applications. Specify the point-in-time for recovery,
recoverytime by applying log backups to roll forward to the specified time of the host. The time
should be within the range set by hostbeginpit and hostendpit when displayed
using udsinfo lsbackup xxxx for that image. The time format should be either:
yyyy-MM-dd HH:mm:ss or yyyy-MM-dd HH:mm:ss.SSS.

-script script Optional. Specifies a script during different phases of the operation. Four phases
are supported, INIT, PRE, POST, and FINAL. Each phase, a timeout, name of the
script, and argument list can be specified. Name of the script is required, timeout
and args are optional. Syntax for each phase is:
name=<name>:phase={INIT|PRE|POST|FINAL}:[timeout=<timeout>]:[args=arg1,ar
g2] Multiple phases can be specified, separated by semi-colon (;), for example,
"name=setup.sh:phase=INIT;name=freeze.sh:phase=PRE"

-username username Optional. Valid only for database applications. Specify the username to use to apply
the logs from log backup.

Description
Use this command to restore a backup image. Before the backup image is restored to the original host, the SLA that
protects this application is disabled. The expiration of backup images for this application is also disabled. They should
be explicitly turned on using Actifio Desktop or the udstask chsla command.

Example
$ udstask restoreimage -image Image_000402
Restore of generic app or Consistency group:
$ udstask restoreimage -image Image_0056472 -parts 'vdisk:vd_6'
Restore of VM:
$ udstask restoreimage -image Image_0012537
-parts '[ds600gb] cl_vm_test1/cl_vm_test1_1.vmdk','[ds600gb] cl_vm_test1/cl_vm_test1.vmdk'

| actifio.com | Actifio CLI Reference 277

 lsrestoreoptions
The lsrestoreoptions command lists applicable restore options for a given restore action or provides detailed
information for a specific restore option.

Rights
You must have the “System View” or “System Manage” right to view the restore option information.

Syntax
>>- udsinfo -- -- lsrestoreotions -- ----------------------------------->
>---+---------------------------------------+--+---------------------+--->
'- -applicationtype -- applicationtype -' '- -action -- action -'
>--+-----------------------------+--+-----------------------+------------>
'- -targethost -- targethost -' '- -delim -- delimiter -'
>--+---------+--+---------------------+---------------------------------->
' -nohdr -' '- restoreoptionname -'

Parameter Description

-applicationtype Optional. The application type (SQL Server, Oracle, VM, and so on). See List of
applicationtype Restore Options on page 459 for a complete list of available application types.

-action action Optional. The restore action to be taken: clone, mount, restore, prepmount, failover
or failovertest. See List of Restore Options on page 459 for a complete list of
available restore options.

-targethost targethost Optional. The host ID of the target system. Use the udsinfo lshost command to
locate the ID.

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim : on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

-nohdr Optional. By default, headings are displayed for each column of data in a concise
style view, and for each item of data in a detailed style view. The -nohdr parameter
suppresses the display of these headings. If there is no data to be displayed,
headings are not displayed.

278 Actifio CLI Reference | actifio.com |

Description
This command will provide a list of restore options that are applicable for the given combination of application, restore
action and target host. If a restore option name is provided instead of the other parameters it will display detailed
information about the given restore option.

Example
$ udsinfo lsrestoreoptions -applicationtype VM -action clone -targethost 1001
$ udsinfo lsrestoreoptions vmdkprovisionformat

| actifio.com | Actifio CLI Reference 279

 unmountimage
The unmountimage command unmounts and optionally deletes a mounted backup image.

Rights
You must have the 'Host Manage' or 'Application Manage' or ‘Mount Manage’ rights to unmount and delete a backup
image.

Syntax
>>- udstask -- -- unmountimage -- -+- -image -- image_name -+--->
'- -image -- image_id ---'
>--+-----------+-- --+----------+-- --+-----------+-- ---------->
'- -delete -' '- -force -' '- -nowait -'
>--+---------------------+-------------------------------------><
'- -script -- script -'

Parameter Description

-delete Optional. The flag specifies whether to delete the backup image, after it is
unmounted.

-force Optional. The flag specifies whether to ignore errors when unmapping
disks from the host.

-image image_name | image_id Required. Specifies the ID or name of the image to be unmounted. The
image name or ID can be retrieved using the udsinfo lsbackup command.

Note: The backup image has to be already mounted.

-nowait Optional. The flag specifies not to wait for the completion of the command.

-script script Optional. Specifies a script during different phases of the operation. Four
phases are supported, INIT, PRE, POST, and FINAL. Each phase, a timeout,
name of the script, and argument list can be specified. Name of the script
is required, timeout and args are optional. Syntax for each phase is:
name=<name>:phase={INIT|PRE|POST|FINAL}:[timeout=<timeout>]:[args
=arg1,arg2] Multiple phases can be specified, separated by semi-colon (;),
for example, "name=setup.sh:phase=INIT;name=freeze.sh:phase=PRE"

Description
Use this command to unmount a mounted backup image, and optionally delete the image after it is unmounted.

Example
$ udstask unmountimage -image Image_000402 -nowait

280 Actifio CLI Reference | actifio.com |

verifyimage
The verifyimage command verifies a dedup backup image.

Rights
You must have the 'Host Manage' or 'Application Manage' or ‘Backup Manage’ rights to verify a backup image.

Syntax
>>- udsinfo -- -- verifyimage -- -- -image --+- image_name -+--->
'- image_id ---'

>--+-----------+-----------------------------------------------><
'- -nowait -'

Parameter Description

-image image_name | Required. Specifies the image to be verified, either image ID or image name is
image_id allowed, which can be retrieved using the udsinfo lsbackup command. Only dedup
image verification is supported.

-nowait Optional. The flag specifies not to wait for the completion of the command.

Description
Use this command to verify a deduplicated backup image.

Example
$ udsinfo verifyimage -image Image_000402 -nowait

| actifio.com | Actifio CLI Reference 281

 rmfailovertest
The rmfailovertest command deletes a test failover image.

Rights
You must have the 'Host Manage' or 'Application Manage' rights to delete a image.

Syntax

>>- udstask -- -- rmfailovertest -- ---------------------------->

>-- -image --+- image_name -+-- --+---------------------+------><

'- image_id ---' '- -script -- script -'

Parameter Description

-image image_name | Required. Specifies the ID or name of the backup image to be deleted. Use
image_id udsinfo lsbackup to locate the ID or name for the image.

-script script Optional. Specifies a script during different phases of the operation. Four phases
are supported, INIT, PRE, POST, FINAL, and ABORT. Each phase, a timeout, name
of the script, and argument list can be specified. Name of the script is required,
timeout and args are optional. Syntax for each phase is:
name=<name>:phase={INIT|PRE|POST|FINAL}:[timeout=<timeout>]:[args=arg1,a
rg2] Multiple phases can be specified, separated by semi-colon (;), for example,
"name=setup.sh:phase=INIT;name=freeze.sh:phase=PRE"

Description
Use this command to delete a test failover image. Use udsinfo lsbackup command to locate the backup images to be
deleted.

Example
$ udstask rmfailovertest -image Image_000402

282 Actifio CLI Reference | actifio.com |

Dedup Drive Seeding Commands
The initial replication of a larger size dedup image to a remote system over a network can take hours or days
depending on the amount of data and available bandwidth. Regardless of which transport mechanism you use,
transferring large amount of data across the network can take hours. The Actifio appliance supports an easy ‘seed-
load’ technology, which allows the initial backup done on-site through an external USB drive. This drive is physically
shipped to the remote storage location and copy the data it to the appropriate folder. This method saves lot time and
bandwidth. Once the initial replication in place, the incremental changes are made over the network or Internet.
Use the following commands to perform the seeding operations:

Command Description

initializedevice Initializes a USB device for seeding.

lsdevice Displays a list of physical USB devices to perform seed-in or seed-out operations.

seedin Imports all dedup objects on to a USB device.

seedout Exports all dedup objects from the USB device to the desired storage location.

| actifio.com | Actifio CLI Reference 283

 initializedevice
The initializedevice command initialize a USB device for seeding.

Rights
You must have the 'System Manage' right to create a bandwidth schedule.

Syntax
>>- udstask -- -- initializedevice -- --+----------+------------>
'- -force -'
>-- -name -- name -- --+-------------------------+-- ----------->
'- -password -- password -'
>--+----------------------------+-- -- device_name ------------><
'- -volume -- volume_number -'

Parameter Description

-force Optional. Required if the device is previously initialized for seeding.

-name name Required. Specifies the name of the device to be initialized with.

-password password Optional. Specifies the password of the device to be initialized with.

-volume Optional. Specifies the volume number of the device to be initialized with. Default
volume_number is 0, if not specified default value is used.

device_name Optional. Specifies the name of the device to initialize.

Description
Use this command to initialize a USB device for seeding.

Note: The Actifio appliance supports only the use of USB2 devices that are at least 16 GB in size to perform the
seedout procedure. When inserting a USB device for seedout, make sure no USB1 devices are attached to the
Actifio appliance at that time.

Example
$ udstask initializedevice -name boston sdb

284 Actifio CLI Reference | actifio.com |

lsdevice
The lsdevice command displays a concise list of physical USB devices, or a detailed view of a USB device, to be used
for seedin or seedout.

Rights
You must have the 'System View', or 'System Manage' right to view devices.

Syntax
>>- udsinfo -- -- lsdevice -- --+--------+---------------------->
'- -all -'

>--+----------+-- --+-----------------------+-- ---------------->

'- -nohdr -' '- -delim -- delimiter -'
>--+-----------------+-----------------------------------------><
'- device_name ---'

Parameter Description

-all Optional. List all devices, in addition to those USB devices for seeding.

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim: on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

-nohdr Optional. By default, headings are displayed for each column of data in a concise
style view, and for each item of data in a detailed style view.
The -nohdr parameter suppresses the display of these headings. If there is no data
to be displayed, headings are not displayed.

device_name Optional. Specifies the name of the device to GET detailed information.

| actifio.com | Actifio CLI Reference 285

 Description
Use this command to retrieve details of a USB device, or a list of USB device, to be used for seeding.

Note: The Actifio appliance supports only the use of USB2 devices that are at least 16 GB in size to perform
seedout. Also when inserting a USB device for seed out, make sure no USB1 devices are attached to the Actifio
appliance node at that time.

Example
$ udsinfo lsdevice
initialized where-is-it name volume linux-device-name
yes 002:001 barney 0 sda
no 002:002 sdb

286 Actifio CLI Reference | actifio.com |

seedin
The seedin command imports all dedup objects on a USB device.

Rights
You must have the 'System Manage' right to import the dedup objects.

Syntax
>>- udstask -- -- seedin -- --+--------------------+-- --------->
'- -expiration exp -'

>-- -name -- name -- --+-------------------------+-- ----------->

'- -password -- password -'

>--+----------------------------+-- --+----------------------+-->
'- -volume -- volume_number -' '- -unit --+- days --+-'
'- hours -'

>--+-----------+-----------------------------------------------><
'- -nowait -'

Parameter Description

-expiration exp Optional. Specify the expiration of the imported dedup object, default is 30
(days).

-name name Required. Specifies the name of the device.

-nowait Optional. Specifies whether to wait for the completion of the command.

-password password Optional. Specifies the password of the device to be read.

-volume volume_number Optional. Specifies the volume number of the device . Default is 0, if not
specified default value is used.

-unit| hours | days | Optional. Specify the unit for expiration, default is days.

Description
Use this command to import all dedup objects on a USB device.

Example
$ udstask seedin -name boston

| actifio.com | Actifio CLI Reference 287

 seedout
The seedout command exports dedup objects to a USB device.

Rights
You must have the 'System Manage' right to export the dedup objects.

Syntax
>>- udstask -- -- seedout -- --+-----------------------+-- ----->
'- -appid -- appid_list -'

>--+------------------------+-- -- -name -- name -- ------------>

'- -image -- image_list -'

>--+-----------+-- --+-------------------------+-- ------------->

'- -nowait -' '- -password -- password -'

>--+----------------------------+------------------------------><
'- -volume -- volume_number -'

Parameter Description

-appid appid_list Optional. Specify a list of appid (colon, :, separated) to export the dedup objects
to a USB device. Up to 5 appid's are supported.
This parameter is required if -image is not specified.

-image image_list Optional. Specify a list of image names or image IDs (colon,:, separated) to
export the dedup objects to a USB device. Up to 5 images are supported.
This parameter is required if -image is not specified.

-name name Required. Specifies the name of the device.

-nowait Optional. Specifies whether to wait for the completion of the command.

-password password Optional. Specifies the password of the device to be read.

-volume volume_number Optional. Specifies the volume number of the device. Default is 0, if not
specified default value is used.

288 Actifio CLI Reference | actifio.com |

Description
Use this command to export dedup objects to a USB device.

Note: The Actifio appliance supports only the use of USB2 devices that are at least 16 GB in size to perform
seedout. Also when inserting a USB device for seed out, make sure no USB1 devices are attached to the Actifio
appliance node at that time.

Example
$ udstask seedout -name boston -image Image_0004111:Image_0004441

| actifio.com | Actifio CLI Reference 289

 lsworkflow
The lsworkflow command returns a list of workflows, or a detailed view of a workflow object.

Rights
User must have 'WorkFlow Manage' or 'WorkFlow View' right to be able to view workflows.

Syntax
>>- udsinfo -- -- lsworkflow -- -------------------------------->
>--+--------------------------------+-- --+----------+-- ------->
'- -filtervalue -- attrib=value -' '- -nohdr -'
>--+-----------------------+-- --+---------------+-------------><
'- -delim -- delimiter -' +- object_id ---+
'- object_name -'

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim: on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

-filtervalue Optional. Specifies that you want your report to display any or all of the list of valid
attrib=value filter attributes.The valid filter attributes for the udsinfo lsworkflow command are:
* name
For string type of filters, the only operator allowed is '='. You can also use wildcard
character '*'. For example, to match template (SLT) with name begins with 'foo',
use '-filtervalue name=foo*'.

-nohdr Optional. By default, headings are displayed for each column of data in a concise
style view, and for each item of data in a detailed style view. The -nohdr parameter
suppresses the display of these headings. If there is no data to be displayed,
headings are not displayed.

object_id | Optional. Specifies the name or ID of an object. When you use this parameter, the
object_name detailed view of the specific object is returned and any value that is specified by the
-filtervalue parameter is ignored. If you do not specify the object_id | object_name
parameter, the concise view of all objects matching the filtering requirements are
displayed.

290 Actifio CLI Reference | actifio.com |

Description
Use this command to retrieve details of workflows. A workflow is a group of Actifio appliance commands, which can
be scheduled to automate a business process, for example, a Test and Development process by leveraging various
Actifio appliance data protection features like liveclone, prep-mount and mount operations.

Example
$ udsinfo lsworkflow
id modifydate scheduletime scheduletype name appid schedule
day workflowid disabled
203879 2013-07-19 10:26:59.968 02:00 20 tndme2 154646 6
203878 false
212027 2013-07-19 19:07:59.676 03:00 AM 20 tndme22 203358 0
212026 false
$ udsinfo lsworkflow 212027
id 212027
modifydate 2013-07-19 19:07:59.676
scheduletime 03:00 AM
scheduletype 20
name tndme22
appid 203358
tasks <workflow name="tndme22" appid="203358" policy="snap"><liveclone label="tn
dm22" diskpool="73" id="212021" /><prepmount host="203359" script="phase=PRE:na
me=pre.sh:timeout=60;phase=POST:name=post.sh:timeout=100" id="212022" /><mount p
hysicalRDM="false" id="212023"><host hostid="203363" id="212024" /><host hostid=
"203365" id="212025" /></mount></workflow>
scheduleday 0
workflowid 212026
disabled false

| actifio.com | Actifio CLI Reference 291

 addflowitemproperty
The addflowitemproperty command adds a property to a workflow item.

Rights
User must have 'WorkFlow Manage' right to be able to add property to a workflow.

Syntax
>>- udstask -- -- addflowitemproperty -------------------------->

>-- -workflow -- workflow_id -- -- -itemid -- item_id ---------->

>-- -name -- name -- -- -value -- value -----------------------><

Parameter Description

-workflow Required. Specifies the ID of the workflow object. Use udsinfo lsworkflow to
workflow_id display detailed workflow information, which includes workflow item properties as
XML attributes.

-itemid item_id Required. Specifies the ID of the workflow item to be added. Use udsinfo
lsworkflow to display detailed workflow information, which includes workflow item
properties as XML attributes.

292 Actifio CLI Reference | actifio.com |

 Parameter Description

-name Required. Specifies the name of the property.

For liveclone:
• label - The label applied to the live clone images
• diskpool - Diskpool ID used for live clone operation
For prepmount:
• host - Host ID of target prepmount host
• physicalRDM - 'true' for pRDM mode and 'false' for vRDM mode
• script - Specifies a script during pre-mount phases of the operation. Four
phases are supported, INIT, PRE, POST, FINAL, and ABORT. Each phase,
a timeout, name of the script, and argument list can be specified. Name
of the script is required, timeout and args are optional. Syntax for each
phase is:
name=<name>:phase={INIT|PRE|POST|FINAL}:[timeout=<timeout>]:[args=ar
g1,arg2] Multiple phases can be specified, separated by semi-colon (;),
for example, "name=setup.sh:phase=INIT;name=freeze.sh:phase=PRE"
For mount:
• label - The label applied to mount images
• physicalRDM - 'true' for pRDM mode and 'false' for vRDM mode
• script - Specifies a script during mount phases of the operation, which
follows the same syntax rules as that of premount
For host:
• hostid - Host ID of target mount host

-value value Required. Specifies the value of the property.

Description
Use this command to add a property to an existing workflow item. Use udsinfo lsworkflow to display detailed
workflow information, which includes workflow item properties as XML attributes.

Example
$ udstask addflowitemproperty -workflow 212027 -itemid 212030 -name physicalRDM
-value false

| actifio.com | Actifio CLI Reference 293

 addflowproperty
The addflowproperty command adds a property to a workflow.

Rights
User must have 'WorkFlow Manage' right to be able to add property to a workflow.

Syntax
>>- udstask -- -- addflowproperty ------------------------------->

>-- -name --+- name ---+-- -value -- value -- -- workflow_id ---><

+- appid --+
+- policy -+

Parameter Description

-name Required. Specifies the name of the property.

name | appid | policy Supported properties are:
• name - The name of the workflow
• appid - Application ID or application name.
• policy - Snap policy type or snap policy ID.
Supported values are:
• snap - Latest image from any snap policy
• dedup - Latest image from the dedup-async policy
• policy - Latest image from the specified snap policy

-value value Required. Specifies the value of the property.

workflow_id Required. Specifies the ID of the workflow object to add. Use udsinfolsworkflow
to obtain the ID.

Description
Use this command to add a property to an existing workflow.

Example
$ udstask addflowproperty -name policy -value snap 212027

294 Actifio CLI Reference | actifio.com |

addflowitemvalue
The addflowitemvalue command adds a value to a workflow item.

Rights
User must have 'WorkFlow Manage' right to add value to a workflow item.

Syntax
>>- udstask -- -- addflowitemvalue ------------------------------>
>-- -workflow -- workflow_id -- -- -itemid -- item_id- ---------->
>--+------------+------------------------------------------------>
'- -encrypt -'
>-- -value -- value---------------------------------------------><

Parameter Description

-workflow Required. Specifies the ID of the workflow object. Use udsinfolsworkflow to

workflow_id obtain the ID.

-itemid item_id Required. Specifies the ID of the workflow item. Use udsinfolsworkflow to obtain
the ID.

-encrypt Optional. This is useful when set encrypt the text of the value parameter.

-value value Required. Specifies the value of the workflow item.

Description
Use this command to add value to an existing workflow item. Use udsinfo lsworkflow to display the detailed
workflow information, which includes workflow item value as XML text content.

Example
$ udstask addflowitemvalue -workflow 212027 -itemid 212030 -value dbinstance

| actifio.com | Actifio CLI Reference 295

 chworkflow
The chworkflow command changes the attributes of a workflow.

Rights
User must have 'WorkFlow Manage' right to be able to change any workflow.

Syntax
>>- udstask -- -- chworkflow -- --+---------------+------------->
'- -day -- day -'
>--+-------------------------+---------------------------------->
'- -disable --+- true --+-'
'- false -'
>--+-----------------------------+-- --+----------------+------->
'- -frequency --+- daily ---+-' '- -name --name -'
+- weekly --+
'- monthly -'
>--+-----------------+-- -- workflow_id -----------------------><
'- -time -- time -'

Parameter Description

-name name Optional. Specifies new name for the workflow.

-day day Optional. Specifies the day of the frequency, 0-based. For weekly frequency, 0
indicates Sunday, and 1 is Monday, etc. For monthly, 0 is first day of the month, and
1 is 2nd day of the month.

-disable true | false Optional. Disables the workflow from being scheduled.

-frequency Optional. Specifies the frequency of the schedule.

daily | weekly |
monthly

-time time Optional. Specifies the time of the schedule.

workflow_id Required. Specifies the workflow object to modify by ID. Use udsinfolsworkflow
to obtain the ID.

Description
Use this command to modify an existing workflow. Use udsinfo lsworkflow to obtain the ID. Use "-disable" to de-
schedule and reschedule a workflow. When changing a data flow schedule, all schedule parameters, day, time and
frequency, should be specified.

296 Actifio CLI Reference | actifio.com |

Example
$ udstask chworkflow -frequency weekly -time '01:00' -day 0 212027
$ udstask chworkflow -disable true 212027

| actifio.com | Actifio CLI Reference 297

 mkworkflow
The mkworkflow command creates a new workflow object.

Rights
User must have 'WorkFlow Manage' right to be able to create any workflow.

Syntax
>>- udstask -- -- mkworkflow -- -- -name --name -- ------------->
>-- -appid --+- app_id ---+-- -- -day -- day -- ---------------->
'- app_name -'
>-- -frequency --+- daily ---+-- -- -time -- time -------------><
+- weekly --+
'- monthly -'

Parameter Description

-name name Required. Specifies the name of the workflow.

-appid app_id | Required. Specifies the workflow application ID or application name. Use udsinfo
app_name lsapplication to retrieve the application ID or name.

-day day Required. Specifies the day of the frequency, 0-based. For weekly frequency, 0
indicates Sunday, and 1 is Monday, etc. For monthly 0 is first day of the month, and
1 is 2nd day of the month.

-frequency daily | Required. Specifies the frequency of the schedule.

weekly | monthly

-time time Required. Specifies the time of the schedule.

Description
Use this command to create a new workflow, which can be used to automate, for example, a Test and Development
process by leveraging various Actifio appliance data protection features.

Example
$ udstask mkworkflow -name test -appid 4111 -frequency weekly -time '01:00' -day 1

298 Actifio CLI Reference | actifio.com |

mkflowitem
The mkflowitem command creates a new workflow item object.

Rights
User must have 'workFlow Manage' right to be able to create a workflow item.

Syntax
>>- udstask -- -- mkflowitem -- --+-------------------------+--->
'- -depends -- parent_id -'

>-- -type --+- liveclone -+-- -- -workflow -- workflow_id -----><

+- prepmount -+
+- mount -----+
'- host ------'

Parameter Description

-workflow Required. Specifies the ID of the workflow. Use udsinfolsworkflow to obtain the
workflow_id ID.

-type liveclone | Required. Specifies the workflow item type.

prepmount | mount |
host

-depends parent_id Optional. Specifies the parent workflow item ID. Currently only the host workflow
item requires this option. Both the prepmount and mount data flow items can have
host as child data flow items.

Description
Use this command to create a new workflow item object. A workflow item is an executable action, which is backed by
an Actifio appliance command. When a workflow is scheduled to run, all its child workflow items will be executed in
the order added to the workflow. Use udsinfo lsworkflow id to display a detailed view to locate parent item IDs if 
-depends is specified.

Example
$ udstask mkflowitem -workflow 212027 -type mount
$ udstask mkflowitem -workflow 212027 -type host -depends 212030

| actifio.com | Actifio CLI Reference 299

 rmworkflow
The rmworkflow command removes an existing workflow object.

Rights
User must have 'WorkFlow Manage' right to be able to remove a workflow.

Syntax
>>- udstask -- -- rmworkflow ----------------------------->
>---+----------+- -- workflow_id ------------------------><
'- -force -'

Parameter Description

workflow_id Required. Specifies the ID of the workflow object to be removed. Use

udsinfolsworkflow to obtain the ID.

force Optional. Specifies whether to ignore errors when deleting the workflow.

Description
Use this command to remove an existing workflow. Use udsinfo lsworkflow to obtain the ID. If the specified
workflow is running, it will continue until it is completed.

Example
$ udstask rmworkflow 212027

300 Actifio CLI Reference | actifio.com |

rmflowitem
The rmflowitem command removes an existing workflow item.

Rights
User must have 'WorkFlow Manage' right to be able to remove any workflow item.

Syntax
>>- udstask -- -- rmflowitem ---------------------------->
>-- -workflow -- workflow_id --- -- item_id-------------><

Parameter Description

-workflow Required. Specifies the ID of the workflow object to be removed. Use udsinfo
workflow_id lsworkflow to display detailed workflow information, which includes workflow item
properties as XML attributes.

item_id Required. Specifies the ID of the workflow item to be removed. Use udsinfo
lsworkflow to display detailed workflow information.

Description
Use this command to remove an existing workflow item. Use udsinfo lsworkflow to obtain the ID. if the specified
workflow is running, it will continue to run to finish.

Example
$ udstask rmflowitem -workflow 212027 212030

| actifio.com | Actifio CLI Reference 301

 runworkflow
The runworkflow command triggers an on-demand execution of the workflow.

Rights
User must have 'WorkFlow Run' right to be able to run a workflow.

Syntax
>>- udstask -- -- runworkflow -- -- workflow_id ---------------->
--+-----------------------+----+-------------------------+-----><
'- -norefreshliveclone -' '- -nocreatevirtualclone -'

Parameter Description

workflow_id Required. Specifies the ID workflow object to be executed. Use udsinfo

lsworkflow to display detailed workflow information.

-norefreshliveclone Optional. When set, the LiveClone workflow will skip the LiveClone refresh
operation.

-nocreatevirtualclone Optional. When set, the LiveClone workflow will skip the LiveClone mount
operation.

Description
Use this command to trigger an on-demand execution of the workflow.

Example
$ udstask runworkflow 212027

302 Actifio CLI Reference | actifio.com |

rmflowitemproperty
The rmflowitemproperty command removes a workflow item property.

Rights
User must have 'WorkFlow Manage' right to be able to create any workflow.

Syntax
>>- udstask -- -- rmflowitemproperty -- ------------------------>
>-- -itemid -- item_id -- -- -workflow -- workflow_id -- ------->
>-- -name -- name ---------------------------------------------><

Parameter Description

-itemid item_id Required. Specifies the ID of the workflow item to be removed. Use udsinfo
lsworkflow to display detailed workflow information.

-workflow Required. Specifies the ID of the workflow object to be removed. Use udsinfo
workflow_id lsworkflow to display detailed workflow information, which includes workflow
item properties as XML attributes.

-name name Required. Specifies the name of the workflow.

Description
Use this command to remove a property from a workflow item. Use udsinfo lsworkflow id to display detailed
workflow information, which includes workflow item properties as XML attributes.

Example
$ udstask rmflowitemproperty -workflow 212027 -itemid 212030 -name physicalRDM

| actifio.com | Actifio CLI Reference 303

 rmflowproperty
The rmflowproperty command removes a property from a workflow.

Rights
User must have 'WorkFlow Manage' right to be able to remove a workflow property.

Syntax
>>- udstask -- -- rmflowproperty -- ---------------------------->
>-- -name -- name -- -- workflow_id ---------------------------><

Parameter Description

-name name Required. Specifies the name of the property.

workflow_id Required. Specifies the ID of the workflow object to be modified. Use udsinfo
lsworkflow to display detailed workflow information.

Description
Use this command to remove a property from an existing workflow. Use udsinfo lsworkflow to obtain the ID. Use
udsinfo lsworkflow id to display detailed data-flow information, which includes workflow properties as XML
attributes.

Example
$ udstask rmflowproperty -name policy 212027

304 Actifio CLI Reference | actifio.com |

mksideband
The mksideband command marks MDisk to be used for sideband.

Rights
You must have 'System Manage' right to invoke this operation.

Syntax
>>- udstask -- -- mksideband -- -mdisk -- mdisk_name ---><

Parameter Description

-mdisk mdisk_name Required. Specifies the name of the MDisk.

Description
Use this command to mark an Mdisk to be used for a sideband group.

Example
$ udstask mksideband -name mdisk5

| actifio.com | Actifio CLI Reference 305

306 Actifio CLI Reference | actifio.com |
7 Policy and Schedule Commands

Use these commands for managing policies and schedules in your Service Level Agreements (SLAs). The GUI
interface for these commands can be found in the Actifio Desktop under the SLA Architect. For information, refer to
Planning and Developing Service Level Agreements in the Actifio Documentation Library.
This chapter details the commands used to manage policies, policy application, and schedules:
chpolicy on page 308
chpolicyoption on page 312
chsla on page 314
chslt on page 318
export on page 319
import on page 320
lspolicy on page 321
lspolicyoption on page 324
lssla on page 326
lsslt on page 328
mkpolicy on page 330
mkpolicyoption on page 334
mksla on page 336
mkslt on page 338
rmsla on page 339
rmslt on page 340
rmpolicy on page 341
rmpolicyoption on page 342
chbandwidthschedule on page 343
cleanupdedupasync on page 344
lsbandwidthschedule on page 345
lssettableoption on page 347
mkbandwidthschedule on page 349
rmbandwidthschedule on page 351

| actifio.com | Actifio CLI Reference 307

 chpolicy
The chpolicy command modifies the attributes of a policy.

Rights
You must have the 'SLA Manage' right to change the attributes of a policy.

Syntax
>>- udstask -- -- chpolicy -- --+------------------------------->

>--+------------------------+-- --+----------------------------+>
'- -description -- desc -' '- -encrypt --+- false -+-- -'
+- true --+

>--+--------------------+-- --+---------------------------+-- -->

'- -endtime -- time -' '- -exclusion -- exclusion -'

>--+----------------------------------+-- ---------------------->
'- -exclusioninterval -- interval -'

>--+------------------------------------+-- -------------------->
'- -exclusiontype --+- daily ---+-- -'
+- weekly --+
+- monthly -+
'- yearly --'

>--+-----------------+-- --+-------------------------------+---->
'- -name -- name -' '- -repeatinterval -- interval -'

>--+-----------------------------+-- --------------------------->
'- priority --+- low ----+-- -'
+- medium -+
'- high ---'

>--+---------------------------+-- ----------------------------->
'- -retention -- retention -'

>--+---------------------------------+-- ----------------------->
'- -retentionm --+- minutes -+-- -'
+- hours ---+

308 Actifio CLI Reference | actifio.com |

 +- days ----+
+- weeks ---+
+- months --+
'- years ---'

>--+---------------+-- --+----------------------------+-- ------>

'- -rpo -- rpo -' '- -rpom --+- minutess -+-- -'
'- hours ----'

>--+------------------------------------+-- -------------------->
'- -scheduletype --+- daily ----+-- -'
+- weekly ---+
+- monthly --+
'- yearly ---'

>--+---------------------------+-- --+----------------------+--->
'- -selection -- selection -' '- -starttime -- time -'

>--+----------------------------------+-- -- policy_id --------><

'- -verifychoice --+- newest -+-- -'
+- oldest -+
'- random -'
The following table describes the attributes of a policy.

Parameter Description

-description desc Optional. Specifies the description for the policy.

-encrypt true | false Optional. Specifies whether the deduped data should be encrypted.

-endtime time Optional. Specifies the end time for the policy. The format is "hh:mm", For
example, "17:00".

-exclusion exclusion Optional. Specifies the exclusion (calendar) for the policy.

-exclusioninterval Optional. Specifies the exclusion interval for the policy. An exclusion interval of 2
interval for weekly, means every two weeks.

-exclusiontype daily | Optional. Specifies the exclusion type for the policy.
weekly | monthly | yearly

| actifio.com | Actifio CLI Reference 309

 Parameter Description

-name name Optional. Specifies the name for the policy. Name should be unique within the
same template.

-repeatinterval interval Optional. Specifies the repeat interval for the policy. A repeat interval of 2 for
weekly, means every two weeks.

-priority Optional. Specifies a priority for the policy. Priority applies only to asynchronous
low | medium | high deduplication of data from a primary site to a remote site.

-retention retention Optional. Specifies the retention period for the policy.

-retentionm minutes | Optional. Specifies the retention period for the policy.
hours | days | weeks |
months | years

-rpo rpo Optional. Specifies the Recovery Point Objective (RPO) period for the policy.

-rpom Optional. Specifies the RPO measurement type for the policy.
minutes | hours

-scheduletype daily | Optional. Specifies the schedule type for the policy.
weekly | monthly | yearly

-selection selection Optional. Specifies the selection (calendar) for the policy.

-starttime time Optional. Specifies the start time for the policy. Starting time of the day that this
policy applies. The format is "hh:mm", For example, "09:00".

-truncatelog true | false Optional. Specifies truncate log property for the policy. The default value is false.
This property is applied to applications that support log truncation.

-verifychoice newest | Optional. Specifies selection choices of images to verify (only for verification
oldest | random policies).

policy_id Required. Specifies the ID of the policy to be changed. Use udsinfo lspolicy to
retrieve the ID.

310 Actifio CLI Reference | actifio.com |

Description
Use this command to change the attributes of a policy. Use udsinfo lspolicy command to obtain the ID of the policy.
For both selection and exclusion, they are similar to a multiple selection of a calendar.
Four different types of selection or exclusion are supported:
• Months (months): jan | feb | mar | apr | may | jun | jul | aug | sep | oct | nov | dec
• Weeks (weeks):
• Days of month (daysofmonth):
• Days of week (daysofweek): sun | mon | tue | wed | thu | fri | sat
For verification type policies, only weekly and monthly schedules are allowed, and the start time is used to specify the
time to start the verification.

Example
$ udstask chpolicy -description 'policy description' 4111

| actifio.com | Actifio CLI Reference 311

 chpolicyoption
The chpolicyoption command changes a policy option.

Rights
You must have the 'SLA Assign' or 'SLA Manage' right to change the options of a policy.

Syntax
>>- udstask -- -- chpolicyoption -- ---------------------------->
>--+--------------------+-- --+-----------------+-- ----------->
'- -appid -- app_id -' '- -name -- name -'
>--+----------------------+-- --+--------------------------+--->
'- -hostid -- host_id -' '- -policyid -- policy_id -'
>--+--------------------+-- --+--------------------+-- -------->
'- -slaid -- sla_id -' '- -sltid -- slt_id -'
>--+-------------------+-- -- policyoption_id ----------------><
'- -value -- value -'

Parameter Description

-appid app_id Optional. Specifies the Application ID for the policy option. A non-zero value
specifies that this option applies to the specific application. Use udsinfo
lsapplication to retrieve the application ID.

-name name Optional. Specifies the name of the option. See Appendix E, List of Policy Options
for a complete list of supported policy options.

-hostid host_id Required. Specifies the host, either the ID or name of the host is needed. Use
udsinfo lshost to locate the ID or name of the host.

-policyid policy_id Optional. Specifies the policy ID for the policy option. A non-zero value specifies
that this option applies to this specific policy. Use udsinfo lspolicy to retrieve the
policy ID.

-slaid sla_id Optional. Specifies the SLA ID for the policy option. A non-zero value specifies that
this option applies to this specific SLA. Use udsinfo lssla to retrieve the SLA ID.

-sltid slt_id Optional. Specifies the SLT ID for the policy option. A non-zero value specifies that
this option applies to this specific SLT. Use udsinfo lsslt to retrieve the SLT ID.

-value value Required. Specifies value of the option. If multiple values are allowed, they need to
be separated by a comma. For example, ','. Comma character, ',', needs to be
escaped with two commas, ",,".

policyoption_id Required. Specifies the ID of the policy option to be changed. If multiple values are
allowed, they need to be separated by a colon, ':'. Use udsinfo lspolicyoption
command to obtain the ID of the policy ID.

312 Actifio CLI Reference | actifio.com |

Description
Use this command to change a policy option. Use udsinfo lspolicyoption command to obtain the ID of the policy ID.

Example
$ udstask chpolicyoption -value no 4111

| actifio.com | Actifio CLI Reference 313

 chsla
The chsla command changes the attributes of an SLA.

Rights
You must have the 'SLA Assign' right to change the attributes of an SLA.

Syntax
>>- udstask -- -- chsla -- --+-----------------------------+--->
'- -dedupasyncoff --+- true --+
'- false -'
>--+------------------------+-- ------------------------------->
'- -description -- desc -'
>--+----------------------------------+-- --------------------->
'- -expirationoff --+- true --+-- -'
'- false -'
>--+---------------------------------------------+-- ---------->
'- -flags --+- ProcessLatestSnap:true ---+-- -'
+- ProcessLatestSnap:false --+
+- ProcessLatestDedup:true --+
+- ProcessLatestDedup:false -+
+- DisableSnapshot:true -----+
+- DisableSnapshot:false ----+
+- DisableLocalDedup:true ---+
+- DisableLocalDedup:false --+
+- DisableRemoteDedup:true --+
+- DisableRemoteDedup:false -+
+- DisableStreamSnap:true ---+
+- DisableStreamSnap:false ---+
+- DisableDar:true ----------+
'- DisableDar:false ---------'
>--+--------------------------------+-- ----------------------->
'- -scheduleoff --+- true --+-- -'
'- false -'
>--+--------------------+-- --+--------------------+-- -------->
'- -slpid -- slp_id -' '- -sltid -- slt_id -'
>-- -- sla_id ------------------------------------------------><

314 Actifio CLI Reference | actifio.com |

 Parameter Description

-dedupasyncoff Optional. Specifies whether asynchronous deduplication of this SLA should be

true | false turned off.

-description desc Optional. Specifies the new description for the SLA.

-expirationoff Optional. Specifies whether the expiration of this SLA should be turned off.
true | false

-scheduleoff Optional. Specifies whether scheduling of the SLA should be turned off.
true | false

-slpid slp_id Optional. Specifies the ID of the profile (SLP). Use udsinfo lsslp to display a list
of profiles (SLPs).

-sltid slt_id Optional. Specifies the ID of the SLA template. Use udsinfo lsslt to display a list
of policy templates (SLTs).

sla_id Required. Specifies the ID of the SLA to be changed. Use udsinfo lssla to
retrieve the SLA ID.

| actifio.com | Actifio CLI Reference 315

 Parameter Description

-flags setting:value Optional. Configures the -flag setting and associated value to disable/enable
specific SLA operations on a single application, such as disabling image
preservation of snapshots or dedup images on an application basis. You can also
disable individual jobs for an application (snapshot, local dedup, remote dedup,
StreamSnap, or DAR jobs).

Note: For background on image preservation, including modifying settings,

see Configuring Image Preservation on page 409.

Image preservation -flag settings on a per-application basis:

Settings include:
• ProcessLatestSnap:<true | false> — Instructs the Actifio appliance if
it should change its default behavior and resume processing the most
recent snapshot images and discard all of the preserved images for
the application. By default, the system-wide
PreserveSnapsOfPriority parameter in the setparameter command
is set to all applications (low, medium, and high priority), which means
that the ProcessLatestSnap flag is automatically disabled (set to
ProcessLatestSnap:false). You can specify ProcessLatestSnap:true
to disable catch-up mode for a specific application.
• ProcessLatestDedup:<true | false> —Instructs the Actifio appliance
if it should change its default behavior and resume processing the
most recent dedup images and discard all of the preserved images
for the application. By default, the system-wide
PreserveLdedupsOfPriority parameter in the setparameter is set to
all applications (low, medium, and high priority), which means that the
ProcessLatestDedup flag is automatically disabled (set to
ProcessLatestSnap:false). You can specify
ProcessLatestDedup:true to disable catch-up mode for a specific
application.

Note: Once you set either the -flags ProcessLatestSnap:true or

ProcessLatestDedup:true option, the -flags option will remain set to true
until you reset it back to the default state of ProcessLatestSnap:false and
ProcessLatestDedup:false.

316 Actifio CLI Reference | actifio.com |

 Parameter Description

Disable jobs -flag settings:

• DisableSnapshot:<true | false> — Disables or enables snapshot
jobs performed on an application basis. Default is false (snapshot jobs
enabled).
• DisableLocalDedup:<true | false> — Disables or enables local
dedup jobs performed on an application basis. Default is false (local
dedup jobs enabled).
• DisableRemoteDedup:<true | false> — Disables or enables remote
dedup jobs performed on an application basis. Default is false (remote
dedup jobs enabled).
• DisableStreamSnap:<true | false> — Disables or enables
StreamSnap jobs performed on an application basis. Default is false
(StreamSnap jobs enabled).
• DisableDar:<true | false>— Disables or enables Dedup-Async
Replication (DAR) jobs performed on an application basis. Default is
false (DAR jobs enabled).

Description
Use this command to change the attributes of an SLA.

Example
$ udstask chsla -expirationoff true 4111
$ udstask chsla -sltid 101 4111

| actifio.com | Actifio CLI Reference 317

 chslt
The chslt command is used to change the attributes of a template (SLT).

Rights
You must have the 'SLA Manage' right to change a template.

Syntax
>>- udstask -- -- chslt -- --+-----------------------+---------->
'- -description -- desc-'
>--+---------------------+-- --+-------------------------+------>
'- -name -- slt_name -' '- -override -+- true --+-'
'- false -'
>--+- slt_name -+----------------------------------------------><
'- slt_id ---'

Parameter Description

-description Optional. Specifies a description for the template.

description

-name slt_name Optional. Specifies a name for the template.

-override true | false Optional. Specifies whether policy option can be overridden.

slt_id | slt_name Required. Specifies the ID or name of the template to be modified.

Description
Use this command to change the attributes of a template. Use the udsinfo lsslt command to obtain the ID or name of
the template (SLT).

Example
$ udstask chslt -description "template description" template1

318 Actifio CLI Reference | actifio.com |

export
The export command exports all templates into a file. The file can be used to import templates with the udstask
import command.

Rights
You must have the 'System View,' ‘System Manage,’ or ‘SLA View’ right to export templates.

Syntax
>>- udsinfo -- -- export -- -+- -filename -- filename -+-------->

Parameter Description

-filename filename Required. Specifies the file name to export the templates to. The file path can be
relative or absolute. Filename should always be under a subdirectory of the user's
home directory, which is a subdirectory under /home.

Description
Use this command to export templates. This file can be used to import templates using the udstask import
command.

Example
$ udsinfo export -filename templates.xml

| actifio.com | Actifio CLI Reference 319

 import
The import command imports templates from a file.

Rights
You must have the 'Application Manage' or ‘Host Manage’ or ‘SLA Manage’ right to import templates.

Syntax
>>- udstask -- -- import -- -+- -filename -- filename -+-------->
>--+-----------------------------+------------------------------><
'- -dupaction --+- add -----+-'
+- ignore --+
'- replace -'

Parameter Description

-duplication Optional. Indicates the course of action when the name of an imported templates
add | ignore | replace match those of an existing templates of the Actifio appliance. The option 'ignore'
ignores the new templates, 'add' adds the templates with a new name, and
'replace' replaces the existing templates with the new templates. The default value
is 'add'.

-filename filename Required. Specifies the name of the file to be imported. The file should be under /
home or a subdirectory of /home.

Description
Use this command to import policy templates. The file should be exported using udsinfo export command.

Example
$ udstask import -filename templates.txt -duplication replace

320 Actifio CLI Reference | actifio.com |

lspolicy
The lspolicy command displays a concise list of policies or the detailed view of a policy. A template (SLT) is made up
of one or more policies.

Rights
You must have the 'SLA Manage', 'SLA View' or 'SLA Assign' right to view a list of policies.

Syntax
>>- udsinfo -- -- lspolicy -- ---------------------------------->

>--+--------------------------------+-- --+----------+-- ------->

'- -filtervalue -- attrib=value -' '- -nohdr -'

>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim : on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

| actifio.com | Actifio CLI Reference 321

 Parameter Description

-filtervalue Optional. Specifies that you want your report to display any or the entire list of valid
attrib=value filter attributes. The valid filter attributes for the udsinfo lspolicy command are:
• endtime [hh: mm]
• exclusiontype [daily | weekly | monthly | yearly ]
• exclusioninterval
• name
• op [ snap | cloud | dedup | replicate | rehydrate | mirror ]
• policytype [ sync | async | async_dedup | stream_snap ]
• repeatinterval
• retention
• retentionm [ minutes | hours | days | weeks | months | years ]
• rpo
• rpom [ minutes | hours | days | weeks | months | years ]
• scheduletype [ daily | weekly | monthly | yearly ]
• sltid
• starttime [ hh: mm ]
The filter is formed with an attribute and a value. When you specify more than one
filter, they must be combined with '&' character (which should be escaped with '\').
For string type of filters, the only operator allowed is '='. You can also use wild card
character '*'. For example, to list policies with name begins with 'foo', use '-
filtervalue name=foo*'.
Some filters allow only predefined constants. For example, exclusiontype allows
only daily, weekly, monthly, or yearly, to match policies with scheduletype of
weekly, use '-filtervalue exclusiontype=weekly'.
For number and date types, allowed operators are: =, >, >=, <, <=. To use <, <=,
>, or >=, they should be escaped with '\' or enclosed in ''or "", as required by the
shell. For example, -filtervalue rpo\>10 -filtervalue "rpo>10" -filtervalue 'rpo>10'
The starttime and endtime parameters can also use these operators. For example: -
filtervalue starttime\>"09:00"
To GET a list of all policies for a template (SLT), use 'udsinfo lspolicy -filtertype
sltid=ID'.

-nohdr Optional. By default, headings are displayed for each column of data in a concise
view, and for each item of data in a detailed view. The - nohdr parameter
suppresses the display of these headings. If there is no data to display, headings
are not displayed.

object_id Optional. Specifies the ID of an object. When you use this parameter, a detailed
view of the object is returned and any value specified by the 
-filtervalue parameter is ignored. If you do not specify the object_id parameter, a
concise view of all objects matching the filter criteria is displayed.

322 Actifio CLI Reference | actifio.com |

Description
Use this command to retrieve the details of policies.

Example
$ udsinfo lspolicy -delim = 12111
id=12111
endtime=23:55
rpo=24
scheduletype=weekly
description=
encrypt=
name=DailySnap
retention=1
starttime=18:00
exclusion=
exclusioninterval=1
policytype dedup_async
repeatinterval=1
retentionm=weeks
selection=daysofweek:mon,tue,wed,thu,fri
sltid=102
rpom=hours
exclusiontype=none
op=snap
truncatelog=true

| actifio.com | Actifio CLI Reference 323

 lspolicyoption
The lspolicyoption command displays a concise list of configured policy options or the detailed view of a policy
option.

Rights
You must have the 'SLA Manage', 'SLA View', or 'SLA Assign' right to view a list of policies.

Syntax
>>- udsinfo -- -- lspolicyoption -- ---------------------------->
>--+--------------------------------+-- --+----------+-- ------->
'- -filtervalue -- attrib=value -' '- -nohdr -'
>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' '- object_id ---'

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim : on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

-filtervalue Valid input for the -delim parameter is a one- byte character. To display the data,
attrib=value recommended delimiter to use is comma (',') for list view, and equal ('=') for detail
view.
Optional. Specifies that you want your report to display any or the entire list of valid
filter attributes. The valid filter attributes for the udsinfo lspolicy command are:
• name
• appid
• policyid
• slaid
• sltid
• value
The filter is formed with an attribute and a value. When you specify more than one
filter, they must be combined with '&' character (which should be escaped with '\').

-nohdr Optional. By default, headings are displayed for each column of data in the concise
view, and for each item of data in the detailed view. The -nohdr parameter
suppresses the display of headings. If there is no data to display, headings are not
displayed.

object_id Optional. Specifies the ID of a policy. When you use this parameter, a detailed view
of the object is returned and any value that is specified by the -filtervalue
parameter is ignored. If you do not specify the object_id parameter, a concise view
of all objects matching the filter criteria is displayed.

324 Actifio CLI Reference | actifio.com |

Description
Use this command to retrieve the details of policy options. See Appendix E, List of Policy Options for a complete list of
supported policy options.

Example
$ udsinfo lspolicyoption
id name value slaid policyid sltid
4411 appconsistency no 0 0 4111

| actifio.com | Actifio CLI Reference 325

 lssla
The lssla command displays a concise list of SLAs or a detailed view of an SLA.

Rights
You must have the 'SLA Manage', 'SLA View', or 'SLA Assign' right to view SLAs. '

Syntax
>>- udsinfo -- -- lssla -- ------------------------------------->

>--+--------------------------------+-- --+----------+-- ------->

'- -filtervalue -- attrib=value -' '- -nohdr -'

>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim : on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

-filtervalue Optional. Specifies that you want your report to display any or the entire list of valid
attrib=value filter attributes. The valid filter attributes for the udsinfo lssla command are:
• appid
• dedupasyncoff [ true | false ]
• expirationoff [ true | false ]
• scheduleoff [ true | false ]
• slpid
• sltid
The filter is formed with an attribute and a value. When you specify more than one
filter, they must be combined with '&' character (which should be escaped with '\').

-nohdr Optional. By default, headings are displayed for each column of data in the concise
view, and for each item of data in the detailed view. The -nohdr parameter
suppresses the display of headings. If there is no data to display, headings are not
displayed.

object_id Optional. Specifies the ID of an object. When you use this parameter, a detailed
view of the object is returned and any value that is specified by the -filtervalue
parameter is ignored. If you do not specify the ID or name, a concise view of all
objects matching the filters is displayed.

326 Actifio CLI Reference | actifio.com |

Description
Use this command to retrieve the details of an SLA. An SLA describes a template and a profile used to protect an
application.

Example
$ udsinfo lssla
id modifydate expirationoff slpid description createdate dedupasyncoff appid scheduleoff sltid
8998 false 8947 protect app1 2011-06-21 05:47:05.933 false 8991 false 8987

| actifio.com | Actifio CLI Reference 327

 lsslt
The lsslt command displays a concise list of policy templates (SLTs) or a detailed view of an SLT.

Rights
You must have the 'SLA Manage', 'SLA View' or 'SLA Assign' right to view a list of SLTs.

Syntax
>>- udsinfo -- -- lsslt -- ------------------------------------->
>--+--------------------------------+-- --+----------+-- ------->
'- -filtervalue -- attrib=value -' '- -nohdr -'
>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+
'- object_name -'

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim : on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

-filtervalue Optional. Specifies that you want your report to display any or all of the list of valid
attrib=value filter attributes. The valid filter attributes for the udsinfo lsslt command are: name
For string type of filters, the only operator allowed is '='. You can also use wild-card
character '*'. For example, to match template (SLT) with name begins with 'foo',
use '-filtervalue name=foo*'.

-nohdr Optional. By default, headings are displayed for each column of data in a concise
style view, and for each item of data in a detailed style view. The -nohdr parameter
suppresses the display of these headings. If there is no data to be displayed,
headings are not displayed.

object_id | Optional. Specifies the name or ID of an object. When you use this parameter, a
object_name detailed view of the object is returned and any value specified by the 
-filtervalue parameter is ignored. If you do not specify the ID or name, a concise
view of all objects matching the filters is displayed.

328 Actifio CLI Reference | actifio.com |

Description
Use this command to retrieve the details of SLTs. A template (SLT) is made up of one or more policies that describe
the data protection schedules.

Example
$ udsinfo lsslt
id override description name
101 true Basic Protection Local Basic
102 true Standard Protection Local Standard
103 true Enterprise Protection Local Enterprise
$ udsinfo lsslt 101 -delim =
id=101
override=true
description=Basic Protection
name=Local Basic

| actifio.com | Actifio CLI Reference 329

 mkpolicy
The mkpolicy command creates a new policy.

Rights
You must have the 'SLA Manage' right to create a policy.

Syntax
>>- udstask -- -- mkpolicy -- --+------------------------------->

>--+------------------------+-- --+----------------------------+>
'- -description -- desc -' '- -encrypt --+- false -+-- -'
'- true --'

>--+--------------------+-- --+---------------------------+----->
'- -endtime -- time -' '- -exclusion -- exclusion -'

>--+----------------------------------+-- ---------------------->
'- -exclusioninterval -- interval -'
>--+------------------------------------+-- -name -- name ------>
'- -exclusiontype --+- daily ---+-- -'
+- weekly --+
+- monthly -+
'- yearly --'
>--+--------------- -- --+-----------------------------+-- --->
'- -op --+- snap --------+-- -'
+- cloud -------+
+- dedup -------+
+- directdedup -+
+- replicate -+
'- remotereplicate ---'
>--+--------------------------------------+-- ---------------->
'- -policytype --+- sync ---------+-- -'
+- async --------+
+- dedup_async --+
+- stream_snap --+
+- normal -------+
'- verification -'
>--+-----------------------------+-- --+----------------------->
'- priority --+- low ----+-- -' '- predecessor -- id -'

330 Actifio CLI Reference | actifio.com |

 +- medium -+
'- high ---'
>--+-------------------------------+-- ------------------------->
'- -repeatinterval -- interval -'
>--+---------------------------+-- ----------------------------->
'- -retention -- retention -'
>--+----------------------------------+-- ---------------------->
'- -retentionm --+- minutess -+-- -'
+- hours ----+
+- days -----+
+- weeks ----+
+- months ---+
'- years ----'
>--+---------------+-- --+----------------------------+-- ------>
'- -rpo -- rpo -' '- -rpom --+- minutess -+-- -'
'- hours ----'
>--+------------------------------------+-- -------------------->
'- -scheduletype --+- daily ----+-- -'
+- weekly ---+
+- monthly --+
'- yearly ---'
>--+---------------------------+-- --+----------------------+--->
'- -selection -- selection -' '- -starttime -- time -'
>--+- -slt --+- slt_name -+-- ---------------------------------->
'- slt_id ---'
>--+--------------------------------+-- ------------------------>
'- -truncatelog --+- true --+-- -'
'- false -'
>--+----------------------------------+------------------------><
'- -verifychoice --+- newest -+-- -'
+- oldest -+
'- random -'

Parameter Description

-description desc Optional. Specifies the description of the policy.

-encrypt true | false Optional. Specifies whether the deduped data should be encrypted.

| actifio.com | Actifio CLI Reference 331

 Parameter Description

-endtime time Optional. Specifies the end time for the policy. End time of the day that this
policy applies. The format is in 24-hour format, "hh:mm", For example, "17:00".

-exclusion exclusion Optional. Specifies the exclusion (calendar) for the policy.

-exclusioninterval interval Optional. Specifies the exclusion interval for the policy. An exclusion interval of
2 for weekly, means every two weeks.

-exclusiontype daily | Optional. Specifies the exclusion type for the policy.
weekly | monthly | yearly

-name name Required. Specifies the name of the policy. Name should be unique within the
same template.

-op snap | cloud | dedup | Required. Specifies the operation type of the policy. Note that direct-dedup
directdedup | replicate | policy is conflicting with snap, cloud, dedup, sync, async, dedup_async, and
remotereplicate stream_snap policies.

-predecessor id Optional. Specifies the predecessor policy ID. For example, a stream_snap
policy requires a snap policy as a predecessor to work properly. In this case,
you would specify the snap policy ID.

-priority low| medium| Optional. Specifies new priority for the policy. This only applies to dedup,
high replicate, dedup_async, and stream_snap policies. Defaults to 'medium' if not
specified.

-repeatinterval interval Optional. Specifies the repeat interval for the policy. A repeat interval of 2 in a
week means repeating policy execution once in every two weeks.

-policytype sync | async | Optional. Specifies special type for the policy. The default value is normal,
dedup_async | which includes snap, dedup, or replicate policies.
stream_snap | normal |
verification

-retention retention Optional. Specifies the retention period for the policy.

-retentionm minutes | Optional. Specifies the retention measurement type for the policy.
hours | days | weeks |
months | years

-rpo rpo Optional. Specifies the Recovery Point Objective (RPO) period for the policy.

-rpom minutes | hours Optional. Specifies the RPO measurement type for the policy.

-scheduletype daily | Optional. Specifies the schedule type for the policy.
weekly | monthly | yearly

-selection selection Optional. Specifies the selection (calendar) for the policy.

332 Actifio CLI Reference | actifio.com |

 Parameter Description

-slt slt_name | slt_id Required. Specifies the template id or name for the policy.

-starttime time Optional. Specifies the start time for the policy. Starting time of the day that
this policy applies. The format is "hh:mm", For example, "09:00".

-truncatelog true | false Optional. Specifies that the logs should be truncated. The default value is
false. This is applied to applications that support log truncation.

-verifychoice newest | Optional. Specifies the choice of an image to verify. This is (only for verification
oldest | random policies).

Description
Use this command to create a new policy.
Both the selection and the exclusion of a schedule are similar.
Four different types of selection or exclusion are supported:
• Months (months): jan | feb | mar | apr | may | jun | jul | aug | sep | oct | nov | dec
• Weeks (weeks): 1, 2, .. last
• Days of Month (daysofmonth): 1, 2, ... last
• Days Of Week (daysofweek): sun | mon | tue | wed | thu | fri | sat
For verification policies, only weekly and monthly schedules are allowed, and the start time is used to start the
verification.

Example
$ udstask mkpolicy -endtime "18:00" -rpo 10 -scheduletype weekly \
-description 'my new policy' -name 'Jupiter Snap Policy' -retention 20 \
-starttime "08:00" -slt 101 -retentionm minutes -rpom minutes \
-selection daysofweek:mon,tue,wed,thu,fri -exclusiontype weekly \
-exclusion daysofweek:sat,sun -op snap

| actifio.com | Actifio CLI Reference 333

 mkpolicyoption
The mkpolicyoption command creates policy options to be used when backup operation is performed. Use the
udsinfo lssettableoption command to retrieve a list of policy options that are allowed.

Rights
You must have the 'SLA Assign' or 'SLA Manage' right to create the options for a policy.

Syntax
>>- udstask -- -- mkpolicyoption -- --------------------------->
>--+--------------------+-- -- -name -- name -- --------------->
'- -appid -- app_id -'
>--+--------------------------+-- --+--------------------+----->
'- -policyid -- policy_id -' '- -slaid -- sla_id -'
>--+--------------------+-- --+--------------------+-- -------->
'- -slaid -- sla_id -' '- -sltid -- slt_id -'
>-- -value -- value ------------------------------------------><

Parameter Description

-appid app_id Optional. Specifies the application or consistency group ID. A non-zero value
specifies that this option applies to this application or consistency group. Use
udsinfo lsapplication or udsinfo lsconsistgrp to retrieve the application or
consistency group ID.

-name name Required. Specifies name of the option. See Appendix E, List of Policy Options for a
complete list of supported policy options.

-policyid policy_id Optional. Specifies the policy ID of the policy option. A non-zero value specifies that
this option applies to this specific policy. Use udsinfo lspolicy to retrieve the policy
ID.

-slaid sla_id Optional. Specifies the SLA ID of the policy option. A non-zero value specifies that
this option applies to this specific SLA. Use udsinfo lssla to retrieve the SLA ID.

-sltid slt_id Optional. Specifies the SLT ID of the policy option. A non-zero value specifies that
this option applies to this specific SLT. Use udsinfo lsslt to retrieve the SLT ID.

-value value Required. Specifies value of the option. If multiple values are allowed, they need to
be separated by comma. For example, ','. (comma character), ',', needs to be
escaped with two commas, ",,".

Description
Use this command to create an option that changes the default behavior when performing backup operations. Use
udsinfo lssettableoption to retrieve a list of options that are allowed. At least one of SLA ID, SLP ID, or SLT ID has to
be a valid ID. See Appendix E, List of Policy Options for a complete list of supported policy options.

334 Actifio CLI Reference | actifio.com |

After protecting an application or a file system, you can configure certain advanced protection settings with the
mkpolicyoption command. See Appendix A, Advanced Protection Settings with the mkpolicyoption Command.

Example
In this example,
$ udstask mkpolicyoption -sltid 4111 -policyid 78456 -name appconsistency -value no

$ udstask mkpolicyoption -sltid 4222 -policyid 46756 -name truncatelog -value yes

| actifio.com | Actifio CLI Reference 335

 mksla
The mksla command creates new SLAs, which applies a protection (an SLT and an SLP) to an application, a
consistency group, or all applications/consistency groups in a group.

Rights
You must have the 'SLA Assign' right to create an SLA.

Syntax
>>- udstask -- -- mksla -- ---- -appid --+- app_id --------+--->
'- consistgrp_id -'
>--+------------------------+-- --+-----------------------+-- ->
'- -description -- desc -' '- -optionname -- name -'
>--+-------------------------+-- --+----------------------+-- ->
'- -optionvalue -- value -' '- -group --+- name -+-'
'- id ---'
>--+---------------------------+-- -- -slp --+- slp_name -+-- ->
'- -sourceuds -- sourceuds -' '- slp_id ---'
>-- -slt --+- slt_name -+-------------------------------------><
'- slt_id ---'

Parameter Description

-appid Required when protecting an application or consistency group. Specifies the

app_id | consistgrp_id application ID or the consistency group ID for the new SLA. Use udsinfo
lsapplication or udsinfo lsconsistgrp to retrieve the application or consistency
group ID.

-description desc Optional. Specifies the description for the new SLA.

-group name | id Optional, required when protecting applications in the group. Specifies the ID or
name of a group. Use udsinfo lsgroup to retrieve the group ID.

-optionname name Optional. Specifies policy option name for the SLA. For policy option that can not be
changed, it should be specified when SLA is created. See Appendix E, List of Policy
Options for a complete list of supported policy options.

-optionvalue value Optional. Specifies policy option value for the SLA.

-sourceuds sourceuds Optional. Optional source cluster ID, to apply to remote replicate policy to a remote
application.

--slp slp_name | slp_id Required. Specifies the profile (SLP) ID for the new SLA. Use udsinfo lsslp to
retrieve the SLA ID.

--slt slt_name | slt_id Required. Specifies the template (SLT) ID for the new SLA. Use udsinfo lsslt to
retrieve the SLA ID.

336 Actifio CLI Reference | actifio.com |

Description
Use this command to create new SLA objects. An SLA protects an application by combining a template (SLT) and a
profile (SLP) to an application or a consistency group. An SLA ID is returned when the command successfully
completed, in protecting an application or a consistency group. To protect multiple applications in a group, use -group
to specify the name or ID of the group. The group ID is returned when the command succeeds, as there are multiple
SLAs created.

Example
$ udstask mksla -appid 1020 -slp 1022 -slt 1024

| actifio.com | Actifio CLI Reference 337

 mkslt
The mkslt command creates a new policy template.

Rights
You must have the 'SLA Manage' right to create a policy template.

Syntax
>>- udstask -- -- mkslt -- --+------------------------+----->
'- -description -- desc -'
>-- -name -- slt_name -- --+-----------------------+-- ----->
'- -org -+- org_id ---+-'
'- org_name -'
>--+-------------------------+-----------------------------><
'- -override -+- true --+-'
'- false -'

Parameter Description

-description desc Optional. Specifies description of the SLA template.

-name name Required. Specifies name of the SLA template; the name has to be unique within
the Actifio appliance

-org org_id |org_name Optional. Specifies a default organization in which the template is to be added after
creation. Use the udsinfo lsorg command to locate the ID or name of the
organization.

Note: To use this option user needs to have 'System Manage' right.

-override true| false Optional. Specifies whether policy option can be overridden. The default is true.

Description
Use this command to create a new policy template.

Example
$ udstask mkslt -name sla_template1
4111

338 Actifio CLI Reference | actifio.com |

rmsla
The rmsla command removes application protection by removing the SLA that protects the application(s), group, or
consistency group.

Rights
You must have the 'SLA Assign' right to delete the protection applied to applications.

Syntax
>>- udstask -- -- rmsla -- --+- sla_id -----+------------------><
+- group_id ---+
'- group_name -'

Parameter Description

sla_id | group_name | group_id Required. Specifies the ID of the SLA to be removed or the ID or
name of the group to be unprotected. Use udsinfo lssla to retrieve
SLA information. Use udsinfo lsgroup to retrieve group
information.

Description
Use this command to remove protection for applications, group, or consistency group.

Example
$ udstask rmsla mygroup

| actifio.com | Actifio CLI Reference 339

 rmslt
The rmslt command deletes a template.

Rights
You must have the 'SLA Manage' right to delete a template.

Syntax
>>- udstask -- -- rmslt -- --+- slt_name -+--------------------><
'- slt_id ---'

Parameter Description

slt_id | slt_name Required. Specifies the ID or name of the template to be deleted. Use udsinfo lsslt
to retrieve the SLT information.

Description
Use this command to delete a template.

Example
$ udstask rmslt template1

340 Actifio CLI Reference | actifio.com |

rmpolicy
The rmpolicy command deletes a policy.

Rights
You must have the 'SLA Manage' right to delete a policy.

Syntax
>>- udstask -- -- rmpolicy -- -- policy_id --------------------><

Parameter Description

policy_id Required. Specifies the ID of the policy to be removed. Use udsinfo lspolicy to
retrieve the policy ID.

Description
Use this command to delete a policy.

Example
$ udstask rmpolicy policy1

| actifio.com | Actifio CLI Reference 341

 rmpolicyoption
The rmpolicyoption command removes the options associated with a policy.

Rights
You must have the 'SLA Assign' or 'SLA Manage' right to remove the options of a policy.

Syntax
>>- udstask -- -- rmpolicyoption -- -- policyoption_id ---------><

Parameter Description

policyoption_id Required. Specifies the ID of the policy option to be removed. Use udsinfo lspolicy
to retrieve the policy ID.

Description
Use this command to delete an option associated with a policy.

Example
$ udstask rmpolicyoption 4111

342 Actifio CLI Reference | actifio.com |

chbandwidthschedule
The chbandwidthschedule command changes the bandwidth value of a bandwidth schedule object.

Rights
You must have the 'System Manage' right to change a bandwidth schedule.

Syntax
>>- udstask -- -- chbandwidthschedule -- ----------------------->

>-- -bandwidth -- bandwidth -- -- bandwidthschedule_id --------><

Parameter Description

-bandwidth bandwidth Required. Specifies the bandwidth used by dedup for the Actifio appliance (in
Megabytes).

bandwidthschedule_id Required. Specifies ID of the bandwidth schedule to be modified.

Description
Use this command to change bandwidth value for a bandwidth schedule of the specified Actifio appliance.

Example
$ udstask chbandwidthschedule -bandwidth 10 4111

| actifio.com | Actifio CLI Reference 343

 cleanupdedupasync
The cleanupdedupasync command cleans up artifacts from running dedup-async related operations.

Rights
You must have the 'Host Manage' or 'Application Manage' or ‘Dedup-Async Manage’ rights to delete the objects
created on protecting an application with an enhanced asynchronous replication policy.

Syntax
>>- udstask -- -- cleanupdedupasync -- ------------------------->

>-- -id --+- app_id --------+-- --+---------+-----------------><

'- consistgrp_id -' '- -all --'

-><

Parameter Description

-id Required. Specifies the ID of the application or consistgrp that no longer has a
app_id | consistgrp_id dedup-async policy running, to cleanup any artifacts from running previously
enabled dedup-async policy. Use the udsinfo lsapplication or udsinfo
lsconsistgrp command for the SRCID.

-all Optional. Specifies whether all the images created by protecting the application
true | false with an enhanced asynchronous replication policy should be deleted. If an
application remains protected when using this command, use '-false'.
Consequently, only failover, failovertest, and sync-back images are deleted. If the
application is no longer protected with an enhanced asynchronous replication policy,
use true. The default value is false.

Description
Use this command to delete the objects created on protecting an application or a consistency group with an enhanced
asynchronous replication policy.

Example
$ udstask cleanupdedupasync -id 4111 C1

344 Actifio CLI Reference | actifio.com |

lsbandwidthschedule
The lsbandwidthschedule command displays a concise list of bandwidth schedules, or a detailed view of a specific
bandwidth schedule.

Rights
You must have the 'System View' or 'System Manage' rights to retrieve details of bandwidth schedules.

Syntax
>>- udsinfo -- -- lsbandwidthschedule -- ----------------------->

>--+--------------------------------+-- --+----------+-- ------->

'- -filtervalue -- attrib=value -' '- -nohdr -'

>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim: on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

-filtervalue Optional. Specifies that you want your report to display any or all of the list of valid
attrib=value filter attributes. The valid filter attributes for the udsinfo lsbandwidthschedule
command are: *
• clusterid The filter will be formed with an attribute and a value.
When user specifies more than one filter, they must be combined with '&'
character (escaped with '\').
For string type of filters, the only operator allowed is '='.
You can also use wild-card character '*'. For example, to match profile (SLP) with
name begins with 'foo', use '-filtervalue name=foo*'.

-nohdr Optional. By default, headings are displayed for each column of data in a concise
style view, and for each item of data in a detailed style view.
The -nohdr parameter suppresses the display of these headings. If there is no data
to be displayed, headings are not displayed.

object_id Optional. Specifies the ID of the bandwidth schedule. When you use this
parameter, the detailed view of the specific object is returned and any value that is
specified by the -filter value parameter is ignored. If you do not specify the
object_id, the concise view of all objects matching the filtering requirements are
displayed.

| actifio.com | Actifio CLI Reference 345

 Description
Use this command to retrieve details of bandwidth schedules. A bandwidth schedule schedules changing of outgoing
bandwidth value for the specified cluster, which is the maximum bandwidth (in Mb/s) allowed to that cluster.
There are two types of replications that the bandwidth schedule can be assigned to: DEDUP and SNAP.

Example
$ udsinfo lsbandwidthschedule -filtervalue clusterid=4169
id scheduletime scheduletype clusterid scheduleday bandwidth replicationtype
13314 17:00 weekly 4169 weekday 0 DEDUP
13315 08:00 weekly 4169 weekday 20 SNAP

346 Actifio CLI Reference | actifio.com |

lssettableoption
The lssettableoption command displays a concise list of policy options that are applicable to be set.

Rights
You must have the 'SLA Assign' or 'SLA Manage', or 'SLA View' right to list settable policy options.

Syntax
>>- udsinfo -- -- lssettableoption -- -------------------------->
>--+--------------------+-- --+-----------------------+-- ------>
'- -appid -- app_id -' '- -delim -- delimiter -'
>--+----------+-- --+--------------------------+-- ------------->
'- -nohdr -' '- -policyid -- policy_id -'
>--+----------------------+-- --+---------------+--------------><
'- -slt --+- slt_id ---' '- option_name -'
'- slt_name -'

Parameter Description

-appid app_id Optional. Specifies the application ID or consistency group ID that the options can
be set. Use udsinfo lsapplication or udsinfo lsconsistgrp to retrieve the ID.

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim : on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

-nohdr Optional. By default, headings are displayed for each column of data in a concise
style view, and for each item of data in a detailed style view.
The -nohdr parameter suppresses the display of these headings. If there is no data
to be displayed, headings are not displayed.

-policyid policy_id Optional. Specifies the policy ID that the options can be set. Use udsinfo lspolicy
to retrieve the policy ID.

option_name Optional. Specifies the name of the option to retrieve the specific details, including
the valid values.See Appendix E, List of Policy Options for a complete list of
supported policy options.

-slt slt_id | slt_name Optional. Specifies the SLT ID or name that the options can be set. For protected
application that has an SLA, use the SLT ID or SLT name that protects the
application to show the settable options. Use udsinfo lsslt to retrieve SLA
information.

| actifio.com | Actifio CLI Reference 347

 Description
Use this command to list settable policy options. See Appendix E, List of Policy Options for a complete list of
supported policy options.

Example
$ udsinfo lssettableoption
id name value slaid policyid sltid
4411 appconsistency no 0 0 4111
$ udsinfo lssettableoption -appid 4394

348 Actifio CLI Reference | actifio.com |

mkbandwidthschedule
The mkbandwidthschedule command creates a new bandwidth schedule object.

Rights
You must have the 'System Manage' right to create a bandwidth schedule.

Syntax
>>- udstask -- -- mkbandwidthschedule -- ----------------------->

>--+---------------------------------+-------------------------->
'- -replicationtype --+- DEDUP -+-'
'- SNAP --'
>--+---------------------------+-- -- -clusterid -- clusterid -->
'- -bandwidth -- bandwidth -'
>--+-----------------------+-- -- -scheduletype --+- monthly -+->
'- -scheduleday -- day -' +- weekly --+
+- daily ---+
'- hourly --'
>-- -scheduletime -- time -------------------------------------><

Parameter Description

-bandwidth Optional. Specifies the maximum bandwidth allowed by dedup for the specified
bandwidth cluster (as indicated by the ID of the cluster object), in Mb. Default to 0; if not
specified, bandwidth is unlimited.

-clusterid Required. Specifies the ID of the appliance for outgoing bandwidth to be enforced.
Use udsinfo lscluster to retrieve the Actifio appliance ID.

-replicationtype Optional. Specifies the type of the replication that the bandwidth schedule is
DEDUP | SNAP assigned to. Valid values are DEDUP (default) and SNAP.

-scheduleday day Optional. Specifies the day of the schedule to run. For 'monthly' schedule: valid
values are 1-31, or 'last' (last day of month). For 'weekly' schedule: valid values are
'mon', 'tue', 'wed', 'thu', 'fri', 'sat', 'sun', 'weekday', or 'weekend'. This is not
allowed for 'daily' or 'hourly' schedule.

-scheduletype Optional. Specifies the type of schedule.

monthly | weekly | daily
| hourly

-scheduletime time Optional. Specifies the time of the schedule to run. The format is 'hh:mm', for
'monthly', 'weekly', or 'daily' schedules. For 'hourly' schedule, the format is 0-59.

| actifio.com | Actifio CLI Reference 349

 Description
Use this command to create a new bandwidth schedule. Which in effect sets the bandwidth limit for the specified
cluster, at the designated scheduled time, which will limit the amount of network traffic to that cluster used by dedup.

Example
$ udstask mkbandwidthschedule -scheduletype weekly -scheduleday weekday \
-clusterid 4169 -scheduletime '08:00' -bandwidth 10-replicationtype SNAP

350 Actifio CLI Reference | actifio.com |

rmbandwidthschedule
The rmbandwidthschedule command deletes a bandwidth schedule.

Rights
You must have the 'System Manage' right to create a bandwidth schedule.

Syntax
>>- udstask -- -- rmbandwidthschedule -- id -------------------><

Parameter Description

id Required. Specifies the ID of the bandwidth schedule to be removed. Use udsinfo

lsbandwidthwschedule to retrieve a bandwidth schedules.

Description
Use this command to delete a bandwidth schedule.

Example
$ udstask rmbandwidthschedule 4441

| actifio.com | Actifio CLI Reference 351

352 Actifio CLI Reference | actifio.com |
8 Job Event and Notification
Commands

These commands are for the tools used in monitoring job events and notifications. The GUI interface for these
commands can be found in the Actifio Desktop under the System Monitor. For information, refer to Using the System
Monitor to Monitor Jobs and Events in the Actifio Documentation Library.
This chapter details the commands used to manage email and SNMP servers and perform archiving.
chsnmpconfig on page 354
configeventemail on page 355
configemailserver on page 356
configserviceemail on page 358
configsnmpagent on page 359
emaillogs on page 362
getemailserverconfig on page 364
geteventemailconfig on page 365
lssnmpconfig on page 367
lssnmpevent on page 368
mksnmpconfig on page 371
rmsnmpconfig on page 372
chmonitoreddevice on page 373
mkmonitoreddevice on page 375
lsmonitoreddevice on page 377
rmmonitoreddevice on page 378
rmeventemail on page 379
rmemailserverconfig on page 380

| actifio.com | Actifio CLI Reference 353

 chsnmpconfig
The chsnmpconfig command changes the attributes of an SNMP trap receiver configuration that receives the SNMP
traps sent by the Actifio appliance.

Rights
You must have the 'System Manage' right to modify the configuration of an SNMP server.

Syntax
>>- udstask -- -- chsnmpconfig -- --+------------------------+-->
'- -error --+- on --+-- -'
+- off -+
>--+-----------------------+-- --+---------------------------+-->
'- -info --+- on --+-- -' '- -ipaddress -- ipaddress -'
+- off -+
>--+-----------------+-- --+--------------------------+-- ------>
'- -port -- port -' '- -warning --+- on --+-- -'
+- off -+
>-- name ------------------------------------------------------><

Parameter Description

-ipaddress ipaddress Optional. Specifies new IP address for the SNMP server.

-port port Optional. Specifies the remote port number for the SNMP server, default to 162.
This should be a value from 1 through 65535.

-info on | off Optional. Specifies whether the server receives the 'information' notifications.

-warning Optional. Specifies whether the server receives the 'warning' notifications. When
on | off set to 'on', warning notifications are sent to the SNMP server. When set to 'off',
warning notifications are not sent to the SNMP server.

-error Optional. Specifies whether the server receives the 'error' notifications. When set
on | off to 'on', error notifications are sent to the SNMP server. When set to 'off', error
notifications are not sent to the SNMP server.

name Required. Specifies the SNMP configuration to be modified.

Description
Use this command to change the SNMP server configuration properties.

Note: The Actifio appliance supports SNMP v2 traps only.

Example
udstask chsnmpconfig -info on server1

354 Actifio CLI Reference | actifio.com |

configeventemail
The configeventemail command sets up an email server that forwards SNMP traps as emails.

Rights
You must have the 'System Manage' right to configure event forwarding to an email server.

Syntax
>>- udstask -- -- configeventemail -- -------------------------->

>--+----------------------+-- --+-------------------------+----->
'- -addemail -- email -' '- -deleteemail -- email -'

>--+--------------------------------------+-- ------------------>
'- -eventtype --+- error ---------+-- -'
+- warning -------+
'- warning,error -'

>--+-------------------------+---------------------------------><
'- -interval -- interval -'

Parameter Description

-addemail emailid Optional. Specifies an email address to be added to receive a notification from the
SNMP server.

-deleteemail emailid Optional. Specifies the email address that should no longer receive a notification
from the SNMP server.

-eventtype warning | Optional. Specifies the types of event (warning, error, or both) to begin event
error | warning, error forwarding to the email address specified.

-interval interval Optional. Specifies the minimum interval (minutes) before email is forwarded,
when a qualifying event (trap) occurs. This is to avoid flooding the email server.
Default to 30 (minutes). To send event immediately, set this value to 0.

Description
Use this command to configure to forward events using email. Prior to using this command, an email server should be
configured using the udstask configemailserver command.

Example
$ udstask configeventemail -eventtype warning,error -addemail [email protected] \
-interval 15

| actifio.com | Actifio CLI Reference 355

 configemailserver
The configemailserver command configures an email server to allow the Actifio appliance to send emails.

Rights
You must have the 'System Manage' right to configure the email server.

Syntax
>>- udstask -- -- configemailserver -- ------------------------->
>--+-------------------------------+-- --+-----------------+---->
'- -emailserver -- email_server-' '- -port -- port -'
>--+---------------------------+-- --+------------------------+->
'- -emailuser -- user_name -' '- -ssl --+- true --+-- -'
+- false -+
>--+---------------------------------+-- ----------------------->
'- -messagelimit -- message_limit-'
>--+-------------------------+-- --+------------------+-- ------>
'- -password -- password -' '- -test -- email -'
>--+--------------------------+-- --+-------------+------------><
'- emailfrom -- emailfrom -' '-nopassword -'

Parameter Description

-emailserver Optional. Specifies the host name or IP address of the email server.
email_server

-emailuser user_name Optional. Specifies the username to authenticate to the email server.

-messagelimit Optional. Specifies the email size allowed by the email server. The email size should
message_limit suffixed with KB or MB. The default email size is 10MB.
Note: Space between the number and units is not allowed, only KB and MB are
supported.
$ udstask configemailserver - messagelimit 5MB

-nopassword Optional. Specifies that no authentication is required to send an email. Using this
option deletes the password if it is configured already. You cannot use this option
along with the - password option.

-password password Optional. Specifies the password of the email user.

-port port Optional. Specifies the email server port. The default value is 25 for an SMTP server
and 465 for an SMTPS server.

356 Actifio CLI Reference | actifio.com |

 Parameter Description

-ssl true | false Optional. Indicates whether the email should be sent using the SSL protocol.
For the -ssl parameter value, note the following conditions:
• true must be added if the email server is smtp.gmail.com.
• false must be added if the email server is svn.actifio.com.

-test email Optional. Specifies an email address to send a test mail to.

-emailfrom email Optional. Specifies the email address to use as the FROM address.

Description
Use this command to configure the email server for which Actifio appliance can send emails.

Example
$ udstask configemailserver -emailserver smtp.gmail.com -port 465 \
-emailuser [email protected] -password test -ssl true -test [email protected]
To set the email server value to null to empty:
$ udstask configemailserver -emailserver ""

| actifio.com | Actifio CLI Reference 357

 configserviceemail
The configserviceemail command configures service email to be sent.

Rights
You must have the 'System Manage' right to be able to configure email server.

Syntax
>>- udstask -- -- configserviceemail -- ------------------------>
>--+-------------------------+-- ------------------------------->
'- -customername -- name -'
>--+----------------------------+-- ---------------------------->
'- -disable --+- true --+-- -'
+- false -+
>--+---------------------------+-------------------------------><
'- -recipient -- recipient -'

Parameter Description

-customername name Optional.Specifies customer name.

-disable true | false Optional. Specifies whether to enable or disable the service email.

-recipient email Optional. Specifies the recipient(s) for the service email. If there are more than one
recipients, use comma (,) to separate them. This will replace any existing
recipient(s) previously configured.

Description
Use this command to configure the service email.

Example
$ udstask configserviceemail -customername foo -recipient [email protected]

358 Actifio CLI Reference | actifio.com |

configsnmpagent
The configsnmpagent command enables the SNMP agent in Actifio CDS and Sky appliances and specifies a
community string for SNMPv2 authentication by the SNMP agent and the management system. The SNMP agent
integrates monitoring and management extensions into the Actifio appliance, and uses SNMP GET requests to allow
data to be pulled on-demand. You can then integrate Actifio appliance SNMP GET operations with your existing
management system.

Note: The Actifio appliance does not support SNMP SET operations.

Rights
You must have the 'System Manage' right to activate the SNMP agent on the Actifio appliance to perform SNMP GET
requests.

Syntax
>>- udstask -- -- configsnmpagent -- ----------------------------------->
>--+---------------------------+-- --+-------------------------------+-><
'- -communitystring -- key -' '- -enable --+- true --+-- -'
+- false -+

Parameter Description

-communitystring Optional. Sets the SNMPV2 community string for performing SNMP GET requests
key by the Actifio appliance. Enter an authentication pass phrase for connecting to the
SNMP agent as the key.

-enable true | false Optional. This value enables or disables the SNMP agent residing in the Actifio
appliance. Supported settings are:
• true—Enables the SNMP agent in the Actifio appliance
• false—Disables the SNMP agent in the Actifio appliance

Description
Use this command to enable the SNMP agent in the Actifio appliance and to set the community string for SNMPv2
authentication by the SNMP agent and the management system. The Actifio appliance extends SNMPv2 support to
the SNMP GET request process through the activation of an SNMP agent in the appliance to register all corresponding
Actifio MIB classes to support the PULL/GET mechanism. The management system (the client) “pulls” data from the
SNMP agent in the Actifio appliance. The SNMP agent service in the Actifio appliance is started as part of the PSRV
service on port UDP-161 for SNMP messages.
The Actifio SNMP agent runs on the Actifio appliance as part of the PSRV service, and the Actifio SNMP agent serves
all requests sent by any SNMP client or management system to monitor and manage Actifio appliance configurations,
system statistics and performance, and so on. The SNMP agent integrates monitoring and management extensions
into the Actifio appliance, and uses SNMPv2 GET requests to allow data to be pulled on-demand. You can integrate
the SNMP GET operations with your existing management system.

Note: We recommend that you check if your management system is SNMP enabled. If the SNMP service does not
exist, be sure to install SNMP.

| actifio.com | Actifio CLI Reference 359

 An SNMP GET request reads the value of SNMP objects and performs network monitoring through a set of
predefined Object Identifiers (OIDs). OIDs uniquely identify managed objects in the MIB hierarchy. By using the Actifio
MIBs, SNMP pulls specific objects to monitor and Actifio appliance configurations, system statistics and performance,
and so on.
You can use the setparameter CLI command to limit the number of records sent by the SNMP agent in the Actifio
appliance to the management system (the client). When you set the snmptablesize parameter, the SNMP agent
retrieves only the specified number of records and send those records to the respective SNMP clients. The range is
100 to 5000 records (default of 500). See setparameter on page 168.

Supported CLI commands for SNMP GET Requests

Included below is a summary of the udsinfo and usvcinfo CLI commands supported for SNMP GET requests:
• usvcinfo lssystemstats
• udsinfo lsversion
• udsinfo lscluster
• udsinfo lssnmpevent
• udsinfo lssnmpconfig
• udsinfo lsdiskpoolstat
• udsinfo lspolicy
• udsinfo lsavailableconnector
• udsinfo lsuser
• udsinfo lsjob
• udsinfo getsysteminfo
Actifio Base OID: 1.3.6.1.4.1.35795
TRAPS OID: 1.3.6.1.4.1.35795.1
CDS OID: 1.3.6.1.4.1.35795.2
UDSINFO commands: 1.3.6.1.4.1.35795.2.2
USVCINFO commands: 1.3.6.1.4.1.35795.2.1

360 Actifio CLI Reference | actifio.com |

Mapped OIDs
Included below is a summary of the mapped OID assignments the supported udsinfo and usvcinfo CLI commands:
• usvcinfo lssystemstats 1.3.6.1.4.1.35795.2.1.1
• udsinfo lsversion 1.3.6.1.4.1.35795.2.2.2
• udsinfo lscluster 1.3.6.1.4.1.35795.2.2.3
• udsinfo lssnmpevent 1.3.6.1.4.1.35795.2.2.4
• udsinfo lssnmpconfig 1.3.6.1.4.1.35795.2.2.5
• udsinfo lsdiskpoolstat 1.3.6.1.4.1.35795.2.2.6
• udsinfo lspolicy 1.3.6.1.4.1.35795.2.2.7
• udsinfo lsavailableconnector 1.3.6.1.4.1.35795.2.2.8
• udsinfo lsuser 1.3.6.1.4.1.35795.2.2.9
• udsinfo lsjob 1.3.6.1.4.1.35795.2.2.10
• udsinfo getsysteminfo 1.3.6.1.4.1.35795.2.2.11
• udsinfo lsdiskpool 1.3.6.1.4.1.35795.2.2.12

System MIB Variables

Included below is a summary of the System MIB variables and their mapped OIDs:
• sysDescr(1.3.6.1.2.1.1.1)
• sysObjectID(1.3.6.1.2.1.1.2)
• sysUpTime(1.3.6.1.2.1.1.3)
• sysContact(1.3.6.1.2.1.1.4)
• sysName(1.3.6.1.2.1.1.5)
• sysLocation(1.3.6.1.2.1.1.6)
• sysServices(1.3.6.1.2.1.1.7)
• sysORLastChange(1.3.6.1.2.1.1.8)
Values for sysDescr, sysName, sysObjectID and sysUptime system OIDs are defined by the SNMP agent.

Note: The SysUptime value will be the time at which the SNMP agent was started.

You define the system parameter values for the sysContact and sysLocation OIDs using the setparameter command.
(see setparameter on page 168).
• You set the sysContact OID value using the systemcontact parameter.
• You set the sysLocation OID value using the systemlocation parameter.
For example:
$ udstask setparameter -param systemcontact -value admin
$ udstask setparameter -param systemlocation -value Boston

Examples
$ udstask configsnmpagent -communitystring password -enable true
$ udstask configsnmpagent -enable false
$ udstask configsnmpagent -enable true

| actifio.com | Actifio CLI Reference 361

 emaillogs
The emaillogs command archives various Actifio appliance logs and sends them in one or more emails.

Rights
You must have the 'System Manage' right to email the Actifio appliance logs.

Syntax
>>- udstask -- -- emaillogs -- --------------------------------->

>--+-------------------------------+-- ------------------------->
'- -logtype --+- adhd -----+-- -'
+- database -+
+- flasher --+
+- install --+
+- omd ------+
+- patch ----+
+- psrv -----+
+- udppm ----+

>--+-----------------------+-----------------------------------><
'- -filelimit -- limit -'

Parameter Description

-logtype Optional. Specifies the types of logs to be sent in email. Multiple types can be sent
adhd | database| by separating each type with a colon, ':'. Specify 'all' if all logs should be sent. The
flasher | install | omd | following types can be sent by separating each type with a colon (':'). Specify 'all' to
patch | psrv | udppm email all types of logs.
• ADHD
• Database
• Flasher
• Install
• OMD
• Patch
• PSRV
• UDPPM

-filelimit limit Optional. Specifies the maximum number of log files to be sent for each log. '0'
indicates all of the log files.

362 Actifio CLI Reference | actifio.com |

Description
Use this command to send various types of the Actifio appliance log files for further diagnosis. To send the logs, the
email server should be configured using the udstask configemailserver.

Example
$ udstask emaillogs -logtype adhd:udppm -filelimit 3

| actifio.com | Actifio CLI Reference 363

 getemailserverconfig
The getemailserverconfig command retrieves the email server configuration.

Rights
You must have the 'System View' or ‘System Manage’ right to view the email server configuration.

Syntax
>>- udsinfo -- -- getemailserverconfig -- ---------------------->
>--+-----------------------+-----------------------------------><
'- -delim -- delimiter -'

Parameter Description

-delim delimiter Optional. Specifies the delimiter to be used when displaying the results. The default
delimiter is a space (' ').

Description
Use this command to display the email server configuration.

Example
$ udsinfo getemailserverconfig -delim =
ssl=true
emailserver=smtp.gmail.com
port=465
[email protected]
password=******

364 Actifio CLI Reference | actifio.com |

geteventemailconfig
The geteventemailconfig command retrieves configuration for event forwarding to email.

Rights
You must have the ‘System Manage’ or 'System View' right to view the email server.

Syntax
>>- udsinfo -- -- geteventemailconfig -- ----------------------->
>--+-----------------------+-----------------------------------><
'- -delim -- delimiter -'

Parameter Description

-delim delimiter Optional. Specifies the delimiter to be used when displaying the results. The default
delimiter is a space (' ').

Description
Use this command to display configuration for event (trap) forwarding to email.

Example
$ udsinfo geteventemailconfig -delim =
eventtype=warning,error
[email protected]
[email protected]
interval=15

| actifio.com | Actifio CLI Reference 365

 getserviceemailconfig
The getserviceemailconfig command retrieves service email configuration.

Rights
You must have 'System View' or 'System Manage' right to view the configuration.

Syntax
>>- udsinfo -- -- getserviceemailconfig -- ---------------------->
>--+-----------------------+------------------------------------><
'- -delim -- delimiter -'

Parameter Description

-delim delimiter Optional. Specifies the delimiter to be used when displaying the results. The
default delimiter is a space (' ').

Description
Use this command to retrieve the email sever configuration.

Example
$ udsinfo getserviceemailconfig
disable false
customername Alewife_Engineering
recipient [email protected]

366 Actifio CLI Reference | actifio.com |

lssnmpconfig
The lssnmpconfig command displays the concise view of the SNMP server configuration.

Rights
You must have the 'System View' or 'System Manage' to view the configuration of an SNMP server.

Syntax
>>- udsinfo -- -- lssnmpconfig -- ------------------------------>
>--+----------+-- --+-----------------------+-- ---------------><
'- -nohdr -' '- -delim -- delimiter -'

Parameter Description

-delim delimiter Optional. By default, all columns of data are separated by a tab in the concise view.
In the detailed view, each column of data is displayed in a separate row and if the
headers are displayed, the header is separated from the data by a space. The -
delim parameter overrides this behavior. Valid input for the -delim parameter is a
one- byte character. To display the data, recommended delimiter to use is comma
(',') for list view, and equal ('=') for detail view.

-nohdr Optional. By default, headings are displayed for each column of data in the concise
view, and for each item of data in the detailed view. The -nohdr parameter
suppresses the display of headings. If there is no data to display, headings are not
displayed.

Description
Use this command to retrieve details of SNMP server configuration.

Example
$ udsinfo lssnmpconfig
port error ipaddress servername warning info
162 on 192.168.0.70 server1 on off
162 on 192.168.0.71 server2 on off

| actifio.com | Actifio CLI Reference 367

 lssnmpevent
The lssnmpevent command displays a concise list of SNMP events or a detailed view of an SNMP event.

Rights
You must have the 'System View' or 'System Manage' to view the SNMP events.

Syntax
>>- udsinfo -- -- lssnmpevent -- ------------------------------->

>--+--------------------------------+-- --+----------+-- ------->

'- -filtervalue -- attrib=value -' '- -nohdr -'

>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+

Parameter Description

-delim delimiter Optional. By default, all columns of data are separated by a tab in the concise view.
In the detailed view, each column of data is displayed in a separate row and if the
headers are displayed, the header is separated from the data by a space. The 
- delim parameter overrides this behavior.
Valid input for the -delim parameter is a one- byte character. To display the data,
recommended delimiter to use is comma (',') for list view, and equal ('=') for detail
view.

368 Actifio CLI Reference | actifio.com |

 Parameter Description

-filtervalue Optional. Specifies that you want your report to display any or the entire list of valid
attrib=value filter attributes. The valid filter attributes for the udsinfo lssnmpevent command
are:
• clustername
• eventdate
• errorcode
• eventid
• messagetext
• notificationtype [ error | warning | info ]
• objecttype [ adhd | omd | psrv | udp ]
The filter is formed with an attribute and a value. When you specify more than one
filter, they must be combined with '&' character (which should be escaped with '\').
For string type of filters, the only operator allowed is '='. You can also use wild card
character '*'. For example, to list all appliances with appliancenames that begins
with 'foo', use '- filtervalue clustername=foo*'. Some filters allow only predefined
constants. For example, status allows only running, queued, paused, interrupted, or
stalled, to match job status that is running, used '-filtervalue status=running'.
For number and date types, allowed operators are: =, >, >=, <, <=. To use <, <=, >,
or >=, they should be escaped with '\' or enclosed in ''or "", as required by the shell.
For example,
-filtervalue errorcode\>0
-filtervalue "errorcode>0"
-filtervalue 'errorcode>0'
The eventdate parameter can also use these operators. For example:
-filtervalue 'eventdate>2010-09-28'
-filtervalue 'eventdate>2010-09-28 6:50:00'

-nohdr Optional. By default, headings are displayed for each column of data in the concise
view, and for each item of data in the detailed view. The -nohdr parameter
suppresses the display of headings. If there is no data to display, headings are not
displayed.

object_id Optional. Specifies the ID of an object. When you use this parameter, a detailed
view of the object is returned and any value that is specified by the -filtervalue
parameter is ignored. If you do not specify the object_id parameter, a concise view
of all objects matching the filter criteria is displayed.

| actifio.com | Actifio CLI Reference 369

 Description
Use this command to retrieve SNMP events.

Example
$ udsinfo lssnmpevent
id notificationtype messagetext component clustername
objecttype errorcode eventdate objectid eventid
9745 error a suitable managed disk for use as a quorum disk was not found
platform cluster9 cluster 1330 2010-08-12 02:05:43.000 0 1
0026
9780 error Remote Port excluded for a specific Managed Disk and Node
platform cluster9 cluster 1330 2010-08-12 02:12:43.000 0
10026
9892 error error WARNING (cluster9): space on /act is low
CDS cluster9 cluster 1330 2010-08-12 02:35:33.000 0
10026
11006 error remote port excluded for a specific managed disk and node
CDS cluster9 mdisk 1220 2010-08-09 06:38:19.000 7 1
0011

370 Actifio CLI Reference | actifio.com |

mksnmpconfig
The mksnmpconfig command creates a new SNMP configuration.

Rights
You must have the 'System Manage' right to view the configure an SNMP server.

Syntax
>>- udstask -- -- mksnmpconfig -- --+------------------------+-->
'- -error --+- on --+-- -'
'- off -'
>--+-----------------------+-- -- -ipaddress -- ipaddress ------>
'- -info --+- on --+-- -'
'- off -'
>-- -name -- name -- --+-----------------+---------------------->
'- -port -- port -'
>--+--------------------------+--------------------------------><
'- -warning --+- on --+-- -'
'- off -'

Parameter Description

-error on | off Optional. Enables or disables receiving 'error' traps.

-info on | off Optional. Enables or disables receiving 'info' traps.

-ipaddress ipaddress Required. Specifies the IP address of the SNMP server.

-name name Required. Specifies the name of the SNMP server.

-port port Optional. Specifies the port of the SNMP server. The default value is 162.

-warning on | off Optional. Enables or disables receiving 'warning' traps.

Description
Use this command to create a new SNMP server configuration.

Note: The Actifio appliance supports SNMP v2 traps only.

Example
$ udstask mksnmpconfig -name "server1" -ipaddress 192.168.0.70

| actifio.com | Actifio CLI Reference 371

 rmsnmpconfig
The rmsnmpconfig command deletes an SNMP server configuration.

Rights
You must have the 'System Manage' right to delete the configuration.

Syntax
>>- udstask -- -- rmsnmpconfig -- -- snmpconfig_name ----------><

Parameter Description

snmpconfig_name Required. Specifies the name of the SNMP server to be deleted.

Description
Use the rmsnmpconfig command to delete an SNMP server configuration.

Example
$ udstask rmsnmpconfig server1

372 Actifio CLI Reference | actifio.com |

chmonitoreddevice
The chmonitoreddevice is used to edit the configuration of a monitored device.

Rights
You must have the 'System Manage' right to edit the IP address of a monitored device.

Syntax
>>- udstask -- -- chmonitoreddevice -- ------------------------->

>--+--------------------+-- --+-----------------+--------------->
'- -ipaddress -- ip -' '- -name -- name -'

>--+-------------------------+-- --+-------------------------+-->
'- -username -- username -' '- -password -- password -'

>--+-------------------------+-- --+- id -+---------------------><

'- -readonly -- +- true --+-- -'
'- false -'

Parameter Description

-ipaddress ip Optional. Specifies the new IP address to use for the given device. The monitoring
process does not rely on DNS lookups so names are not allowed.

-name name Optional. Specifies a name to identify the device. If id is not specified this value is
required.

-username name Optional. The name of the user who is to connect to the given device type.

-password password Optional. The authentication password to connect to the given device type.

-readonly true | false Optional. Choices are True or False. True specifies that the device hardware is not
shipped by Actifio; False specifies that the device hardware is provided by Actifio.

-id id Required. Specifies the ID of the device. Use lsmonitoreddevice to get the ID of
the device.

Description
This command allows you to change the configured IP address or name of a device, or the username or password
used to connect the device. Once the IP address is configured, you cannot edit the device's type. An error is returned
if the IP address is not valid or a device with the given id does not exist.

| actifio.com | Actifio CLI Reference 373

 Example
Update an IP address:
$ udstask chmonitoreddevice -ipaddress 192.168.1.3 4011
Update a storage device name;
$ udstask chmonitoreddevice -name stg02 12455
Make the device read-only;
$ udstask chmonitoreddevce -readonly true 12455
Make the device read-write;
$ udstask chmonitoreddevice -readonly false 12455

374 Actifio CLI Reference | actifio.com |

mkmonitoreddevice
The mkmonitoreddevice is used to add a new device to monitor for connectivity.

Rights
You must have the 'System Manage' rights to add a new device to monitor for connectivity.

Syntax
>>- udstask -- -- mkmonitoreddevice -- ------------------------->
>--+-------------------------+-- --+-------------------------+--->
'- -username -- username -' '- -password -- password -'
>--+-------------+-- --+--------------------------+-------------><
'- -readonly -' '- type --+- switch --+-- -'
+- storage -+-- -'

Parameter Description

-ipaddress ipaddress Required. Specifies the IP address for the host. The monitoring process does not
rely on DNS lookups so names are not allowed.

-name name Required. Specifies a name to identify the device. The name must be unique within
the device type.

-password password Optional.

-readonly true | false Optional. Choices are True or False. True specifies that the device hardware is not
shipped by Actifio; False specifies that the device hardware is provided by Actifio.

-type switch | storage Required. Specifies the type of device to monitor. Either a switch or a storage
device.

-username name Optional. The name of the user who is to connect to the given device type.

Description
This command provides the information to the Actifio appliance about the new device existence for connectivity
monitoring. At regular interval, the Actifio appliance pings these IP address to make sure that they are still connected.
A trap is sent if the ping fails.

Example

Add a switch:
$ udstask mkmonitoreddevice -type switch -ipaddress 192.168.1.1 -name switch01
Add storage as readonly:
$ udstask mkmonitoreddevice -type storage -ipaddress 192.168.1.2 -name test1 -username
someuser -password supersecret -readonly

| actifio.com | Actifio CLI Reference 375

 Add Actifio storage:
$ udstask mkmonitoreddevice -type storage -ipaddress 192.168.1.2 -name test1 -username
someuser -password supersecret

376 Actifio CLI Reference | actifio.com |

lsmonitoreddevice
The lsmonitoreddevice command returns a concise list of monitored devices, or a detailed view of a monitored
device.

Rights
You must have 'System View' or 'System Manage' rights to view devices.

Syntax
>>- udsinfo -- -- lsmonitoreddevice -- ------------------------->
>--+-----------------------+-- --+----------+-- ---------------->
'- -delim -- delimiter -' '- -nohdr -'
>--+---------------------------+-- --+------+------------------><
'- -type --+- switch --+-- -' '- id -'
+- storage -+

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim : on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

-nohdr Optional. By default, headings are displayed for each column of data in a concise
view, and for each item of data in a detailed view. The - nohdr parameter
suppresses the display of these headings. If there is no data to be displayed,
headings are not displayed.

-type switch | storage Optional. Specifies the type of device to monitor. Either a switch or a storage
device, if omitted, both switches and storage devices are listed. If device is an
object id, this value is ignored.

id Optional. Specifies the ID of the device to get detailed information.

Description
This command is used to retrieve details of a monitored device.

Example
$ udsinfo lsmonitoreddevice
id name type ip address
10003 switch01 switch 192.168.1.1
10004 stg02 storage 192.168.1.2

| actifio.com | Actifio CLI Reference 377

 rmmonitoreddevice
The rmmonitoreddevice command is used to remove a device from monitoring for connectivity.

Rights
You must have the 'System Manage' rights to view devices.

Syntax
>>- udstask -- -- rmmonitoreddevice -- -- device_id -----------><

Parameter Description

device_id Required. Specifies the ID to identify the device.

Description
This command will stop monitoring for connectivity to the device. An error is returned if a device with the given ID
does not exist.

Example
$ udstask rmmonitoreddevice 10022

378 Actifio CLI Reference | actifio.com |

rmeventemail
The rmeventemail command deletes the event (trap) forwarding to email configuration.

Rights
You must have the 'System Manage' right to delete the event (trap) forwarding to email configuration.

Syntax
>>- udstask -- -- rmeventemail -- -----------------------------><
This command takes no switches.

Description
Use this command to delete the event (trap) forwarding to email configuration.

Example
$ udstask rmeventemail

| actifio.com | Actifio CLI Reference 379

 rmemailserverconfig
The rmemailserverconfig command deletes the email server configuration.

Rights
You must have the 'System Manage' right to delete the email server configuration.

Syntax
>>- udstask -- -- rmemailserverconfig -- ----------------------><
This command takes no switches.

Description
Use this command to delete the event (trap) forwarding to email configuration.

Example
$ udstask rmemailserverconfig

380 Actifio CLI Reference | actifio.com |

9 Auto Update and Remote
Support Commands

These commands are for Actifio Desktop updates and remote support. The GUI interface for these commands can be
found in the Actifio Desktop of your Actifio appliance under the Desktop Settings and System Settings. For
information, refer to Getting Started with Actifio Copy Data Management in the Actifio Documentation Library
included with your Actifio appliance.
This chapter details the commands related to installation and Actifio remote support commands.
lsversion on page 382
getreleasenote on page 383
installupdate on page 384
lsupdate on page 385
uploadupdate on page 386
getremotesupport on page 387
setremotesupport on page 388

| actifio.com | Actifio CLI Reference 381

 lsversion
The lsversion command returns installed Actifio appliance version.

Rights
There are no specific rights associated with this operation. Admin/User with 'administrator' role can retrieve the
release note.

Syntax
>>- udsinfo -- -- lsversion -- --+----------+-- ---------------->
'- -nohdr -'
>--+-----------------------+-----------------------------------><
'- -delim -- delimiter -'

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim: on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

-nohdr Optional. By default, headings are displayed for each column of data in a concise
style view, and for each item of data in a detailed style view. The -nohdr parameter
suppresses the display of these headings. If there is no data to be displayed,
headings are not displayed.

Description
Use this command to retrieve installed Actifio appliance version, including installed hot-fix.

Example
$ udsinfo lsversion
6.1.0.23116
hf5.0.3.64

382 Actifio CLI Reference | actifio.com |

getreleasenote
The getreleasenote command returns the release note for an update.

Rights
There are no specific rights associated with this operation. Admin/User with 'administrator' role can retrieve the
release note.

Syntax
>>- udsinfo -- -- getreleasenote -- -- update -----------------><

Parameter Description

update Required. Specifies the name of the update.

Description
Use this command to retrieve the release note of the update.

Example
$ udsinfo getreleasenote hf5.0.3.64

| actifio.com | Actifio CLI Reference 383

 installupdate
The installupdate command installs all available update files onto the Actifio appliance.

Rights
There are no specific rights associated with this operation. Admin/User with 'administrator' role can install all Actifio
provided update files.

Syntax
>>- udstask -- -- installupdate -- ----------------------------><

Description
Use this command to install all Actifio provided update files. Use udsinfo lsupdate to view a list of files to be
installed. Use udsinfo getreleasenote to view the release note for each update.

Example
$ udstask installupdate

384 Actifio CLI Reference | actifio.com |

lsupdate
The lsupdate command returns a concise list of updates available to be installed onto the Actifio appliance.

Rights
There are no specific rights associated with this operation. Admin/User with 'administrator' role can retrieve a list of
updates available to be installed onto the Actifio appliance.

Syntax
>>- udsinfo -- -- lsupdate -- --+----------+-- ----------------->
'- -nohdr -'
>--+-----------------------+-----------------------------------><
'- -delim -- delimiter -'

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter - delim : on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

-nohdr Optional. By default, headings are displayed for each column of data in a concise
view, and for each item of data in a detailed view. The - nohdr parameter
suppresses the display of these headings. Headings are not displayed if there is no
data.

Description
Use this command to retrieve a list of updates available to be installed onto the Actifio appliance.
Example
$ udsinfo lsupdate
hf5.0.3.64

| actifio.com | Actifio CLI Reference 385

 uploadupdate
The uploadupdate command uploads an update file to be installed into the Actifio appliance.

Rights
Admin/User with 'administrator' role can upload Actifio update file.

Syntax
>>- udstask -- -- uploadupdate -- -- filename -----------------><

Parameter Description

filename Required. Specifies the name of the file to be uploaded.

Description
Use this command to upload an Actifio-provided update file. The file must be copied (scp) to /home/admin/upload
directory previously by a valid user with CLI access.

Example
$ udstask uploadupdate hf5.0.4.64.gpg

386 Actifio CLI Reference | actifio.com |

getremotesupport
The getremotesupport command retrieves specified Actifio SecureConnect remote support information.

Rights
You must have 'System View' or 'System Manage' right to view remote support.

Syntax
>>- udsinfo -- -- getremotesupport -- --+----------+-- --------->
'- -nohdr -'
>--+-----------------------+-----------------------------------><
'- -delim -- delimiter -'

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter - delim : on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

-nohdr Optional. By default, headings are displayed for each column of data in a concise
view, and for each item of data in a detailed view.

Description
Use this command to display remote support.

Example
$ udsinfo getremotesupport
type enabled
restricted off
secureconnect on
securitycode A1-0008c-00000000

| actifio.com | Actifio CLI Reference 387

 setremotesupport
The setremotesupport command sets administrative support for Actifio SecureConnect remote support.

Rights
You must have 'System Manage' right to be able to configure SecureConnect remote support.

Syntax
>>- udstask -- -- setremotesupport -- -------------------------->
>--+-----------------------------+-- --------------------------->
'- -restricted --+- on---+-- -'
+- off -+
>--+--------------------------------+-- -----------------------><
'- -secureconnect --+- on --+-- -'
+- off -+

Parameter Description

-restricted on | off Optional. Enables/disables Actifio remote access.

-secureconnect Optional. Enables secure connect.

on | off

Description
Use this command to configure or clear remote support settings

Example
$ udstask setremotesupport -secureconnect on

388 Actifio CLI Reference | actifio.com |

10 Actifio Connector Support
Commands

These commands are for Actifio Connector, specific to finding the available connectors and upgrading Actifio
Connectors. For additional information, refer to Connecting Hosts to Actifio Appliances in the Actifio
Documentation Library located on your Actifio appliance.
This chapter provides information related to following Actifio Connector commands.
lsavailableconnector on page 390
rmavailableconnector on page 393
upgradehostconnector on page 394
abortupgradehostconnector on page 395
fetchconnectorlogs on page 396

| actifio.com | Actifio CLI Reference 389

 lsavailableconnector
The lsavailableconnector command returns a concise list of available connectors, or a detailed view of an available
connector.

Rights
You need to have “System View” or ‘System Manage’ rights to view available connectors data.

Syntax
>>- udsinfo -- -- lsavailableconnector -- ---------------------->

>--+--------------------------------+-- --+----------+-- ------->

'- -filtervalue -- attrib=value -' '- -nohdr -'

>--+-----------------------+-- -- --+---------------+----------><
'- -delim -- delimiter -' +- object_id ---+

Parameter Description

-delim delimiter Optional. By default in a concise view, all columns of data are space-separated. In a
detailed view, each item of data has its own row, and if the headers are displayed
the data is separated from the header by a space. The -delim parameter overrides
this behavior. Valid input for the -delim parameter is a one-byte character. If you
enter -delim: on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a
detailed view, the data is separated from its header by the specified delimiter.

390 Actifio CLI Reference | actifio.com |

 Parameter Description

-filtervalue Optional. Specifies that you want your report to display any or all of the list of valid
attrib=value filter attributes. The valid filter attributes for the udsinfo lsavailableconnector
command are:
* name
* componentversion
* componentname
* displayname
* installtime ['installtime since 24 hours' for installtime started since last 24 hours,
'installtime before 7 days' for installtime started older than 7 days ]
* latest
* ostype
* size
The filter will be formed with an attribute and a value. When user specifies more
than one filter, they must be combined with '&' character (which needs to be
escaped with '\').
For string type of filters, the only operator allowed is '='. You can also use wildcard
character '*'. For example, to match disk pools with name begins with 'foo', use '-
filtervalue name=foo*'.
For number and date types, allowed operators are: =, >, >=, <, <=. To use
<, <=, >, or >=, they need to be escaped with '\' or enclosed in ' or ", as
required by shell. For example,
* -filtervalue size\>128000000000
* -filtervalue "size>128000000000"
* -filtervalue 'size>128000000000'
Date parameters installtime can also use these operators, for example,
* -filtervalue 'installtime>2010-09-28'
* -filtervalue 'expiration>2010-09-28 6:50:00'
Multiple filtervalues are allowed, with an '&',
* -filtervalue "installtime>2012-09-28&size>128000000000"

-nohdr Optional. By default, headings are displayed for each column of data in a concise
style view, and for each item of data in a detailed style view. The -nohdr parameter
suppresses the display of these headings. If there is no data to be displayed,
headings are not displayed.

object_id Optional. Specifies the ID of an object. When you use this parameter, the detailed
view of the specific object is returned and any value that is specified by the -filter
value parameter is ignored. If you do not specify the object_id parameter, the
concise view of all objects matching the filtering requirements are displayed.

| actifio.com | Actifio CLI Reference 391

 Description
Use this command to retrieve available connectors.

Example
$ udsinfo lsavailableconnector
id ostype name latest size displayname
componentname componentversion installtime
44035 linux connector-Linux-6.0.2.30154.rpm true 16013029 6.0.2.30154
2013-08-14 05:00:04.000
44037 solaris_x86 connector-Solaris_x86-6.0.2.30154.pkg true 69779456 6.0.2.30154
2013-08-14 05:01:25.000

392 Actifio CLI Reference | actifio.com |

rmavailableconnector
The rmavailableconnector command deletes available connector from the Actifio appliance.

Rights
There are no specific rights associated with this operation. Admin/User with 'administrator' role canto delete a
connector.

Syntax
>>- udstask -- -- rmavailableconnector -- --+- object_name -+--><
'- object_id ---'

Parameter Description

object_id | object_name Required. Specifies the ID or name of the Actifio Connector

to be removed. Use udsinfo lsavailableconnector for
retrieving connector information.

Description
Use this command to delete an available connector.

Example
$ udstask rmavailableconnector 4111

| actifio.com | Actifio CLI Reference 393

 upgradehostconnector
The upgradehostconnector command upgrades the host with specific version of the Actifio Connector, or the latest
available connector from the Actifio appliance.

Rights
There are no specific rights associated with this operation. Admin/User with 'administrator' role can upgrade a
connector on host.

Syntax
>>- udstask -- -- upgradehostconnector -- ---------------------->

>--+----------+-- -- -hosts -- host_list -- -------------------->

'- -force -'

>--+-----------------------+-----------------------------------><
'- -version -- version -'

Parameter Description

-hosts host_list Required. Specifies a colon (:) separated list of ID or name of the
hosts for upgrade. Use udsinfo lshost to retrieve the ID or
name.

-force Optional. When set, it will cancel any running jobs on the host so
it can be upgraded.

-version version Optional. Specifies the upgrade version of the Actifio Connector.

Description
Use the upgradehostconnector command to upgrade the host with a specific version of connector or the latest
available connector from the Actifio appliance.

Example
$ udstask upgradehostconnector -hosts haymarket:svc-host -version 5.2.0.45678

394 Actifio CLI Reference | actifio.com |

abortupgradehostconnector
The abortupgradehostconnector command aborts an ongoing Actifio Connector upgrade.

Rights
There are no specific rights associated with this operation. Admin/User with 'administrator' role can abort the
connector upgrade a on host.

Syntax
>>- udstask -- -- abortupgradehostconnector -- ----------- -------------><

Description
Use the abortupgradehostconnector command to abort the ongoing connector upgrade.

Example
$ udstask abortupgradehostconnector

| actifio.com | Actifio CLI Reference 395

 fetchconnectorlogs
The fetchconnectorlogs command allows user to fetch log files from the host managed by the Actifio appliance into
the Actifio appliance log directory (/dumps/tmp). You can also use this command to help facilitate troubleshooting
issues when working with an Actifio representative by directly downloading logs from your Actifio appliance to your
computer.

Rights
You must have 'Administrator' role to run this command.

Syntax
>>- udstask -- -- fetchconnectorlogs -- --------------------------->
>--+-------+-- -- -- -host --+- host_name -+-- -------------------->
'- -all-' '- host_id ---'
>--+-------------------+-- --+--------------------------+----------<
'- -limit -- limit -' '- -type --+- syslog -+-- -'
'- core ---'
>--+---------------------------+-- --+-----------------------+------><
'- -startdate -- startdate -' '- -enddate -- enddate -+-- -'

Parameter Description

-all Optional. Specifying this flag will fetch all log types based on the
limit specified.

-host host_name | Required. Specifies the host in which logs to be retrieved, either
host_id ID or name of the host is needed. Use udsinfo lshost to locate
the ID or name of the host.

-limit limit Optional. Specifies number of log files to be downloaded from

the host. Default value is set to '1'.

-type syslog | core Optional. Specifies additional file types to be downloaded apart
from connector logs. Specifying more than one type should be
delimited with ':'.

-startdate startdate Optional. By default, the Actifio appliance downloads logs from
the past 3 days (starting with the current date).
To specify a particular date range from which you want to
download logs, use -startdate to specify the start date of the
time window to download the log files. The date format must be
in 'yyyy-MM-dd'. If -startdate is not specified, then the start
date will automatically be set to the date that is 3 days from the
current date.

396 Actifio CLI Reference | actifio.com |

 Parameter Description

-enddate enddate Optional. Specifies the end date of the time window to download
the log files. The date format must be in 'yyyy-MM-dd'. If 
-startdate is specified but not an -enddate, then the end date
will automatically be set to the current date.

Description
Use this command to fetch log files from the host managed by the Actifio appliance. This command downloads
connector logs, syslog, and core files from the host. Apart from Actifio Connector logs, for a Window host the
fetchconnectorlogs command will also fetch event logs and dump files. For a Linux host, this command downloads
syslog and core files.

Example
$ udstask fetchconnectorlogs -host 4142

| actifio.com | Actifio CLI Reference 397

398 Actifio CLI Reference | actifio.com |
A Advanced Protection Settings
with the mkpolicyoption
Command

After protecting an application, or a file system, you can configure certain advanced protection settings by using the
udstask mkpolicyoption command:
Advanced Settings for Out-of-Band File Systems on page 400
Advanced Settings for Oracle Database on page 401
Advanced Settings for VM in ESX DataStore on page 403
Overriding Script Timeout Settings for the Actifio Connector on page 404

Note: See List of Policy Options on page 439 for a complete list of supported policy options that can be used with
the mkpolicyoption command.

| actifio.com | Actifio CLI Reference 399

 Advanced Settings for Out-of-Band File Systems
To configure the advanced protection settings for out-of-band file systems, use the udstask mkpolicyoption
command as follows:
1. Provide the start paths (case-sensitive). This specifies the point in the file system where backup starts. If
this path is not specified, backup starts at the root directory of the file system to be backed-up.
Example:
$ udstask mkpolicyoption -slaid 3198 –sltid 86086 –name startpaths -
value “c:\Program Files”

2. Provide the prune paths (case-sensitive). This specifies a point in the file system where directory traversal
will stop. When protecting a Linux application, a value of /usr/local/lib will ensure that nothing below /usr/
local/lib is copied, but all other directories and files in /usr/local are copied. If this field is left blank, the
directory traversal descends into every subdirectory of the file system being backed-up.
Example:
$ udstask mkpolicyoption -slaid 3198 –sltid 86086 –name prunepaths -
value “g:\d1\d2”

3. Provide the file extension to be excluded from backup using the excludepatterns option. The Actifio
appliance offers the ability to exclude certain file types from the backup. Using this option, only the most
crucial data is backed-up leaving aside the non-critical files.
Example:
$ udstask mkpolicyoption -slaid 3198 –sltid 86086 –name excludepatterns
-value “*.sys”

Guidelines for Exclude Patterns:

o Using this option, only files are excluded, directories are not excluded.
o A pattern can include wild-card characters, For example, an asterisk (*) or a question mark (?). To
exclude all the files that contains .sys as extension, enter *.sys in EXCLUDEPATTERNS field.
o On Windows, files named pagefile.sys and hiberfil.sys that appear in the root directory of a drive are
automatically ignored.
4. Choose "nounmap" option if required. When this option is set, temporary staging disks mapped to the host
and used during data movement remain mapped to the host. LUNs are mapped during the first job and all
the subsequent jobs reuse the mapped LUN. By default, "nounmap" option is set to 'true'. You can
configure this setting only through the CLI. This does not have any effect for Windows based out-of band
applications. Use the following command to set this policy option.
$ udstask mkpolicyoption -sltid <SLTID> -name nounmap -value yes

5. If the protected application is within the appliance setup, then provide the appliance service IP Address.
$ udstask mkpolicyoption -sltid <SLTID> -name serviceip -value <IP
Address>

400 Actifio CLI Reference | actifio.com |

Advanced Settings for Oracle Database
To configure the advanced protection settings for Oracle database, use the udstask mkpolicyoption command.
1. Enter the number of RMAN channels. The number of channels should be configured based on # of cores
available on the server, taking into account of other database backups configured to run in parallel. If the
numberofchannels parameter is not defined then the default number of channels will be one.
Example:
$ udstask mkpolicyoption -sltid 31986 -slaid 32135 -name
numberofchannels -value 4

2. Enter the staging disk size. By default, the Actifio Connector calculates the max size of the database as
configured. The STAGING DISK SIZE option allows you to allocate a staging disk to hold backup and to allow
future growth of the database.
Example: adding more table space, data files while the backup still maintains incremental behavior. This
staging disk is thin provisioned. Another use case of this staging disk size, after user restored the whole
database from Actifio appliance backup and when open the database with reset log; you need to take a
level '0' back up again. In the current release this is not done automatically by the Actifio Connector. To
force a new level '0', you need to change the staging disk size and then save. Next backup will perform a
new level '0'. The unit is in GB.
Example:
$ udstask mkpolicyoption -sltid 31986 -slaid 32135 -name stagingdisksize
-value 5

3. Enter the RMAN log path in the RMAN LOG LOCATION field. This is the custom location (full path along
with RMAN filename) where RMAN writes the logs while taking the backup. By default, the log file is
located at /act/log/rman.log. If you want to change the default path, the option value must be in the form of
/act/log/test/ custom_rman.log.
Example:
$ udstask mkpolicyoption -sltid 31986 -slaid 32135 -name rmanloglocation
-value "/act/log/rmantest.log"

4. Validate each backup before restoring it. RMAN provides restore validate for the backups, when this option
is provided (true), the Actifio Connector invokes RMAN restore validate command for each backup.
Example:
$ udstask mkpolicyoption -sltid 31986 -slaid 32135 -name restorevalidate
-value true

5. Enter the Oracle catalog database name if one is used. This field is used only when you are using a catalog
database for RMAN repository. By default, a control file is used.
Example:
$ udstask mkpolicyoption -sltid 31986 -slaid 32135 -name catalogdb -
value oraprod

6. Enter the Oracle catalog database user name. This field is used only when you are using a catalog database
for RMAN repository. By default, a control file is used.
Example:
$ udstask mkpolicyoption -sltid 31986 -slaid 32135 -name cataloguser -
value catalog1

| actifio.com | Actifio CLI Reference 401

 7. Enter the Oracle catalog database login password. This field is used only when you are using a catalog
database for RMAN repository. By default, a control file is used.
Example:
$ udstask mkpolicyoption -sltid 31986 -slaid 32135 -name
catalogpassword -value ******

8. To set whether or not skip backup of off line and inaccessible table space.
Example not skip inaccessible table space:
$ udstask mkpolicyoption -sltid 31986 -slaid 32135 -name notskip -value
inaccessible

Example not skip offline table space:

$ udstask mkpolicyoption -sltid 31986 -slaid 32135 -name notskip -value
offline

9. Oracle Service Name: Provides the ability to specify a new service name in tnsnames.ora file to be used by
Actifio backup. If not specified then by default Actifio will use oracle sid name as the service name. Either
new service name or default sid name must have an entry in tnsnames.ora file for Actifio to connect:
Example:
$ udstask udstask mkpolicyoption -sltid 31986 -slaid 32135 -name
servicename -value <name of the service>

10. Specify the fail-over node choice in a Oracle RAC environment only.
Example:
$ udstask udstask mkpolicyoption -sltid 31986 -slaid 32135 -name
clusternodes -value <Failover node IP:servicename:role>

11. Choose "nounmap" option if required. When this option is set, temporary staging disks mapped to the host
and used during data movement remain mapped to the host. LUNs are mapped during the first job and all
the subsequent jobs reuse the mapped LUN. By default, "nounmap" option is set to 'true'. You can
configure this setting only through the CLI. This does not have any effect for Windows based out-of band
applications. Use the following command to set this policy option.
Example:
$ udstask mkpolicyoption -sltid 31986 -slaid 32135 -name nounmap -value
yes

12. Enter the Actifio Connector option information.

Example:
$ udstask mkpolicyoption -sltid 31986 -slaid 32135 -name
connectoroptions -value <Connector name>

402 Actifio CLI Reference | actifio.com |

Advanced Settings for VM in ESX DataStore
In previous releases, enhanced asynchronous replication is performed to 'Performance pool snapshot' and the
snapshot disks are exported to the target VM during a failover. In this release, The Actifio appliance provide an option
to perform enhanced asynchronous replication to 'VM in ESX datastore' also. 'VM in ESX datastore' is an advanced
asynchronous replication mechanism in which the data is directly replicated onto the datastore volumes that are
configured for the remote virtual machine. This process allows you to use an existing or a new virtual machine as the
replication target. When the source VM geometry is changed due to addition, deletion and resize of the VMDK
volumes, then the remote VM configuration is automatically changed.
All enhanced asynchronous replication features such as forward replication, failover, syncback, failback and further
rounds of replication POST failback are supported. When using the 'VM in ESX datastore' option to protect a VM, the
data transfer happens on the network. The 'VM in ESX datastore' feature is supported only through CLI. To enable this
feature, create a new template and add the following additional policy options:
$ udstask mkpolicyoption -sltid <sltid> -name readyvm -value yes
$ udstask mkpolicyoption -sltid <sltid> -name remotevcenter -value <vcenter hostname>
$ udstask mkpolicyoption -sltid <sltid> -name remoteesx -value <tarGET esx hostname>
$ udstask mkpolicyoption -sltid <sltid> -name remotedatastores -value <comma separated list of
datastores>,
Follow these guidelines when using the 'VM in ESX datastore' option:
• When unprotecting a VM in ESX datastore, wait for dar-delete to clean-up all the images, you need to
delete the remote VM manually from vCenter after unprotecting the application.
• Do not Power ON the remote VM manually, during the failover, the remote VM is automatically powered on
and failback automatically does a power OFF. In order to validate the data integrity of the VM in ESX
datastore at remote site without failover, you may need to perform a clone from the vCenter.
• When using the 'VM in ESX datastore' option, a remote VM named DR-<sourcevm> is created at the
remote site.
• During the initial replication and the first replication after failback, the Actifio appliance perform a full ingest
from source VM to remote VM and this can take several minutes to complete.
• Do not change the remote VM configuration after a failover, this leads to sync-back failures.

| actifio.com | Actifio CLI Reference 403

 Overriding Script Timeout Settings for the Actifio Connector
To override the default script timeout values for the Actifio Connector, use the udstask mkpolicyoption command
with these switches:

Scriptinittimeout This policy option specifies the timeout value for the init script completion.
The init script is invoked with an init parameter when the backup is about to
start.

Example:
udstask mkpolicyoption -slaid 3198 –sltid 86086 –name
scriptinittimeout – value 200

Scriptfreezetimeout This policy option specifies the timeout value for freeze script completion. The
freeze script is invoked with a freeze parameter when the backup operation is
just about to freeze the application.

Example: 
udstask mkpolicyoption -slaid 3198 –sltid 86086 –name
Scriptfreezetimeout – value 100

Scriptunfreezetimeout This policy option specifies the timeout value for thaw script completion. The
thaw script is invoked with a thaw parameter when the backup operation is
just finished unreeling the application.

Example: 
udstask mkpolicyoption -slaid 3198 –sltid 86086 –name
Scriptunfreezetimeout – value 110

Scriptfinishtimeout This policy option specifies the timeout value for finish script completion. The
fini script is invoked with a fini parameter when the backup operation is about
to complete.

Example: 
udstask mkpolicyoption -slaid 3198 –sltid 86086 –name
Scriptfinishtimeout – value 300

404 Actifio CLI Reference | actifio.com |

B Managing Jobs and Job Slots

Applying policies to applications results in the creation of jobs. These jobs are executed as per the schedules
configured when creating policies. The Actifio appliance reserves pools of slots for running the following types of jobs:
• Scheduled snapshot jobs
• Scheduled local dedup jobs
• Scheduled remote dedup jobs
• Scheduled dedup-async jobs
• Scheduled StreamSnap jobs
• Scheduled vault jobs
• Scheduled expiration of jobs
This appendix discusses:
• On-demand Jobs on page 405
• Queuing of On-Demand Backup Jobs on page 407
• Relaunching Jobs on page 408

On-demand Jobs
There may be times when you require on-demand job start functionality, such as for upcoming maintenance windows,
software upgrades, and so on, and you want to ensure that you have a successful copy of the data created before you
start your scheduled maintenance task. The on-demand jobs category includes all types of restore, clone, and mount
jobs and jobs created when policies are applied on-demand. The Actifio appliance reserves a pool of slots for all the six
categories of jobs. Also, there is an unreserved pool of slots. You can modify the number of slots allotted for each
category as well as the unreserved pool of slots using the setparameter command.
Before starting a job, the Actifio appliance checks whether a slot corresponding to the job's category is available to run
the job. When a reserved slot is not available because all the slots of that category are running jobs, the Actifio
appliance checks whether an unreserved slot is available. If an unreserved slot is available, the job is started. However,
you can reserve the maximum number of slots that the jobs of a particular category can use from the unreserved
pool. This measure limits the number of slots that jobs from a category can make use of from the unreserved pool.

Note: All restore operations such as mount, clone, failover, test failover; prep-mount and restore do not depend on
availability of job slots, though they are on-demand jobs.

| actifio.com | Actifio CLI Reference 405

 The table below indicates the default, minimum, and maximum number of slots allotted to each category of jobs and
the unreserved pool:

Parameter Default no. of Min. no. of Max. no. of slots

slots allotted slots

maxsnapslots 6 0 1000

maxstreamsnapslot 6 0 1000

maxldedupslots 8 0 1000

maxrdedupslots 3 0 1000

maxdarslots 3 0 1000

maxvaultslots 4* 0 1000

maxconcurrentvaultsubjobs 12* 4 1000

maxexpirationslots 10 0 1000

maxondemandslots 6 0 1000

unreservedslots 12 0 100

*The default for maxconcurrentvaultsubjobs is 12 and the default for maxvaultslots is 4. In this case, there can be at any time a total of 4 top-
level vault jobs running. To prevent starving vault jobs, a minimum of 1 slot each has been reserved for every vault job. Note that the first job
cannot use all 12 slots; it can only use up to 9 slots, and will reserve 3 of the remaining slots for new vault jobs to ensure that all vault jobs can
make progress.

406 Actifio CLI Reference | actifio.com |

The default, minimum, and maximum number of slots, from the unreserved pool, that can be allotted to each job
category are as follows:

Parameter Default no. of Min. no. of Max. no. of

slots allotted slots slots

reservedsnapslots 3 0 25

reservedstreamsnapslots 2 0 25

reservedldedupslots 3 0 25

reservedrdedupslots 3 0 25

reserveddarslots 3 0 25

reservedvaultslots 4 0 25

reservedexpirationslots 3 0 25

reservedondemandslots 3 0 25

The maximum slots allowed for running a snapshot job is 1000 (indicated by maxsnapslots). In addition, a maximum
of 25 slots of the unreserved pool can be used by snapshot jobs (indicated by reservedsnapslots).
You can set the value of the reservedsnapslots parameter as shown below:
$ udstask setparameter -param reservedsnapslots -value 10
With the default configuration of 3 dedup-async slots and 12 unreserved slots, up to 15 dedup-async jobs can be
started. Until these 15 jobs complete, no more than 3 jobs of any other type can be started. If, in this configuration,
maxdarslots is set to 5, no more than 5 dedup-async jobs can be started. While these 5 jobs run, 10 unreserved slots
are still available for other jobs.

Queuing of On-Demand Backup Jobs

The Actifio appliance supports queuing of on-demand jobs to provide you with the flexibility to create your backup
images without concern for the number of on-demand job slots available to start the job. The queued on-demand job
remains in the queued state until an on-demand job slot is available. When an on-demand slot opens, the job will then
progress to the running state. This sequence occurs in the order that the job was submitted. However, if a particular
on-demand job fails due to some reason and could not be completed, the Actifio appliance will attempt to run the next
job in the queue. On-demand jobs use different job slots than scheduled jobs, so scheduled jobs may run before
queued jobs.
While an on-demand job is in a queued state you can cancel the job or cancel protection for the application. The on-
demand job will then appear in the job history table as a canceled job. The start time of the job and the end time of the
job will be the time that the cancel request or the cancellation of application protection was acknowledged.
When an on-demand job is submitted from the Actifio appliance CLI, if you want the backup request queued until an
on-demand job slot opens up, include the -queue keyword in the backup command (see backup on page 244). The
CLI does not automatically queue on-demand jobs unless instructed to do so in the backup command. Without the 
-queue argument, the backup request fails the job if there are no free slots available. In this case, the on-demand job
is not queued when there are no slots available to run it, and an error message is returned.

| actifio.com | Actifio CLI Reference 407

 For example, if you attempt to initiate an on-demand backup and there are no available slots, you can add -queue to
instruct the Actifio appliance to queue on-demand backup jobs:
$ udstask backup -app 18414 -policy 201304
ACTERR-043023 No available slots to run job
$ udstask backup -app 18414 -policy 201304 -queue 
Job_0225829
Using the Actifio appliance Desktop, you can view the queued jobs from System Monitor > Jobs.
Relaunching Jobs
All scheduled jobs are automatically re-launched when they fail. The number of retries depends on the configuration
value that is set in the Actifio appliance. Use the udsinfo getparameter command to know the default parameters.
The default parameters are as follows:
• retriesonfailure: This parameter indicates the number of times the job must be retried in the event of a
failed job. Example: retriesonfailure 3, this indicates the job retires 3 times after original attempt.
• retrydelay: This parameter indicates the number of seconds that the job should wait to retry after the
original attempt. Example: retrydelay 240, this indicates, the first job retry happens after 240 seconds.
• retrydecay: This parameter indicates the % of delay to attempt further retries.
Using the Actifio appliance Desktop, you can view the relaunched jobs from System Monitor > Jobs with the job
status as 'retry'. To view the details of a relaunched job, double-click the job. See Using the System Monitor to
Monitor Jobs and Events in the Actifio Documentation Library for information about System Monitor.

408 Actifio CLI Reference | actifio.com |

C Configuring Image Preservation

Image Preservation will, when necessary, preserve snapshot and local dedup images beyond their expiration dates to
ensure that those images are properly processed by the Actifio appliance. This chapter describes the Image
Preservation function of the Actifo appliance and outlines how to modify or disable the Image Preservation settings
from the CLI for preserved snapshot and/or local dedup jobs.
This appendix includes the following topics:
• Image Preservation Overview on page 409
• Modifying Image Preservation Settings On a System-wide Application Level on page 411
• Disabling Image Preservation Mode On A Per Application Basis on page 413

Image Preservation Overview

Your Actifio CDS or Sky appliance may encounter resource challenges that result in snapshot or local dedup jobs failing
to execute in a timely manner. To enhance the success rate in which the Actifio appliance is able to complete snapshot
and local dedup jobs, the Actifio appliance operates in an Image Preservation mode. Image Preservation enhances the
scheduling features of the Actifio SLA policy manager to be able to ride through periods of high change rates, reduced
dedup or replication throughput, and other transient or abnormal situations. Image Preservation delays snapshot and
local dedup expirations in order to catch up with the transient system resource constraints. Images due for expiration
will be held until they have been processed by the Actifio appliance as long as there is capacity to do so by the
appliance.
Image Preservation operates on two types of images:
• Preserve Snapshots—When enabled, all dedupable snapshot images will be preserved until the local
dedup system can process them. Older snapshot images will be processed first until images are caught up
by the Actifio appliance. If VDisk counts or performance pool capacity thresholds are reached, then image
expiration may occur prior to processing to ensure system stability.
• Preserve Dedup Images—When enabled, all local dedup images that are eligible for remote deduplication
will be preserved until the remote deduplication system can process them. Older local dedup images will
be processed first until images are caught up by the Actifio appliance. If capacity in the local dedup pool has
reached the warning level, then image expiration may occur prior to processing to ensure system stability.

When the Actifio appliance attempts to preserve snapshot images or local dedup images, the Actifio appliance will run
snapshot and local dedup jobs (images beyond their expiration date) continuously within the allowed window in an
attempt to catchup on all image processing. In this case, the Actifio appliance will process the oldest unprocessed
snapshot or local dedup images ahead of the latest images. Once a backlogged image is processed, the image is
expired per the SLA schedule.
Preserved images will automatically be expired when pool space or VDisk count reaches the warning threshold levels.
When the Actifio appliance reaches a warning threshold level, images will be expired based on application priority and
age. Images for applications with lower priority will be expired ahead of applications with higher priority. Within a
priority level, older images will be expired ahead of newer images. However, the last snapshot (or local dedup) image
of any application will not be expired this way. Rather than expiring the most recent snapshot (or local dedup) of any
application, an older snapshot of a different application or a snapshot (or local dedup) of a higher priority application will
be expired.

| actifio.com | Actifio CLI Reference 409

 If you find that you need to limit the scope of image preservation to exclude lower priority applications, you can:
• Change preserved snapshot settings through the PreserveSnapsOfPriority parameter in the
setparameter CLI command (see Modifying Preserve Snapshots Settings on page 411).
• Change preserved local dedup settings through the PreserveLdedupsOfPriority parameter in the
setparameter CLI command (see Modifying Preserve Local Dedup Mode on page 412).
In addition, if over a period of time you find that the Actifio appliance is unable to “catch-up” with backlogged local or
remote dedup jobs, you can disable the ability to preserve snapshot and/or preserve local dedup images as follows:
• For all applications:
o You can disable the Preserve Snapshot setting through the PreserveSnapsOfPriority parameter in
the setparameter CLI command (see Modifying Preserve Snapshots Settings on page 411).
o You can disable the Preserve Local Dedup setting through the PreserveLdedupsOfPriority
parameter in the setparameter CLI command (see Modifying Preserve Local Dedup Mode on page
412).
• For a specific application, you can disable Image Preservation for a specific application using the 
-flags ProcessLatestSnap and ProcessLatestDedup options of the udstask chsla CLI command. When
you enable a flag (set it to true), the Actifio appliance processes the most recent snapshot or dedup image
for an application and allows the older images to expire.

410 Actifio CLI Reference | actifio.com |

Modifying Image Preservation Settings On a System-wide Application Level
You can modify Image Preservation priority settings for preserved snapshots jobs and/or local dedup jobs through the
system-level setparameter CLI command. Modifying the preserved snapshot and/or local dedup settings may be
necessary when you need to:
• Change the global application priority of Preserve Snapshots or Preserve Dedup Images settings to limit the
scope exclude applications of a certain priority setting. You can instruct the Actifio appliance to preserve
images for only Medium and High Priority applications or to preserve images for only High Priority
applications.
• Disable the Image Preservation function if the Actifio appliance is unable to “catch-up” with backlogged
snapshot or local dedup images.

Note: If necessary, for a specific application you can disable Image Preservation for a specific application using the
-flags ProcessLatestSnap and ProcessLatestDedup options of the udstask chsla CLI command. When you
enable a flag (set it to true), the Actifio appliance processes the most recent snapshot or dedup image for an
application and allows the older images to expire. See Disabling Image Preservation Mode On A Per Application
Basis on page 413 for details.

This section includes the following procedures:

• Modifying Preserve Snapshots Settings on page 411
• Modifying Preserve Local Dedup Mode on page 412

Modifying Preserve Snapshots Settings

A dedupable snapshot is a snapshot image that would normally be deduped by the Actifio appliance based on the
frequency, retention, start time, end time specified in the policy template for an application. At times, the Actifio
appliance may start to lag behind in the snapshot to dedup jobs due to resource constraints. When this lag occurs, the
setting of the PreserveSnapsOfPriority parameter in the setparameter CLI command defines to the Actifio appliance
how to preserve snapshot images that are due for expiration but not yet successfully deduped.
If necessary, you can change the application priority of the PreserveSnapsOfPriority parameter from low (the default
setting) to high or medium. If you find that the Actifio appliance is unable to “catch-up” with backlogged local jobs, you
can disable the function by setting the PreserveSnapsOfPriority parameter to none.
Options for the PreserveSnapsOfPriority parameter include:
• low—All applications (low, medium, and high priority) will have their snapshot images preserved. This is the
default setting.
• medium—High and medium priority applications will have their snapshot images preserved.
• high—High priority applications will have their snapshot images preserved.
• none—No local snapshot images will be preserved even if the local dedup job has not run on those images.
When the snapshot image reaches its expiration time, barring other dependencies, it will be expired.
The following example illustrates modifying the PreserveSnapsOfPriority parameter to preserve only high priority
applications:
$ udstask setparameter -param PreserveSnapsOfPriority -value high
The following example illustrates disabling the Preserve Snapshot function:
$ udstask setparameter -param PreserveSnapsOfPriority -value none

| actifio.com | Actifio CLI Reference 411

 Modifying Preserve Local Dedup Mode

Similar to dedupable snapshots, there are local dedup images that are candidates for remote deduplication based on
the remote dedup policy template. At times, the Actifio appliance may start to lag behind in the local to remote
deduplication jobs due to resource constraints. When this lag occurs, the setting of the PreserveLdedupsOfPriority
parameter in the setparameter CLI command defines to the Actifio appliance how to preserve local dedup images
that are due for expiration but not yet successfully processed.
If necessary, you can change the application priority of Preserve Dedup Images from low (the default setting) to high
or medium. If you find that the Actifio appliance is unable to “catch-up” with backlogged remote dedup jobs, you can
disable the function by setting the PreserveLdedupsOfPriority parameter to none.
Options for the PreserveLdedupsOfPriority parameter include:
• low—All applications (low, medium, and high priority) will have their local dedup images preserved. This is
the default setting.
• medium—High and medium priority applications will have their local dedup images preserved.
• high—High priority applications will have their local dedup images preserved.
• none—No local dedup images will be preserved. When the local dedup image reaches its expiration time,
barring other dependencies, it will be expired.
The following example illustrates modifying the PreserveLdedupsOfPriority parameter to preserve only high priority
applications:
$ udstask setparameter -param PreserveLdedupsOfPriority -value high
The following example illustrates disabling the Preserve Local Dedup function:
$ udstask setparameter -param PreserveLdedupsOfPriority -value none

412 Actifio CLI Reference | actifio.com |

Disabling Image Preservation Mode On A Per Application Basis
If necessary, you can disable the preservation of specific applications as part of image preservation if the Actifio
appliance is unable to “catch-up” with backlogged snapshot or dedup jobs for that application. When disabled, the
Actifio appliance resumes processing the most recent snapshot or dedup image and discards all of the preserved
images for the application.
Use the -flags ProcessLatestSnap:true and ProcessLatestDedup:true options of the udstask chsla CLI command
to modify the attributes of an SLA to disable image preservation of snapshots or dedup images on an application basis
for current in-process snapshot or dedup jobs.
Included below is the syntax for the udstask chsla CLI command.
>>- udstask -- -- chsla -- --+-----------------------------+--->
'- -dedupasyncoff --+- true --+
'- false -'
>--+------------------------+-- ------------------------------->
'- -description -- desc -'
>--+----------------------------------+-- --------------------->
'- -expirationoff --+- true --+-- -'
'- false -'
>--+---------------------------------------------+-- ---------->
'- -flags --+- ProcessLatestSnap:true ---+-- -'
+- ProcessLatestSnap:false --+
+- ProcessLatestDedup:true --+
+- ProcessLatestDedup:false -+
+- DisableSnapshot:true -----+
+- DisableSnapshot:false ----+
+- DisableLocalDedup:true ---+
+- DisableLocalDedup:false --+
+- DisableRemoteDedup:true --+
+- DisableRemoteDedup:false -+
+- DisableStreamSnap:true --+
+- DisableStreamSnap:false -+
+- DisableDar:true ----------+
'- DisableDar:false ---------'
>--+--------------------------------+-- ----------------------->
'- -scheduleoff --+- true --+-- -'
'- false -'
>--+--------------------+-- --+--------------------+-- -------->
'- -slpid -- slp_id -' '- -sltid -- slt_id -'
>-- -- sla_id ------------------------------------------------><

| actifio.com | Actifio CLI Reference 413

 The -flags keyword of the udstask chsla CLI command modifies the image preservation behavior for an application as
described below.

Note: For details on the other parameters used in udstask chsla, see the udstask chsla CLI command discussion
in this document.

Parameter Description

-flags setting:value Optional. Configures the -flag setting to disable/enable the catch-up of
snapshot or local dedup jobs for a specific application.

Note: Use udsinfo lssla to retrieve the SLA ID of the SLA to be

modified.

Settings include:
• ProcessLatestSnap:<true | false> — Instructs the Actifio
appliance if it should change its default behavior and resume
processing the most recent snapshot images and discard all of
the preserved images for the application. By default, the system-
wide PreserveSnapsOfPriority parameter in the setparameter
command is set to all applications (low, medium, and high
priority), which means that the ProcessLatestSnap flag is
automatically disabled (set to ProcessLatestSnap:false). You
can specify ProcessLatestSnap:true to disable catch-up mode
for a specific application.
• ProcessLatestDedup:<true | false> —Instructs the Actifio
appliance if it should change its default behavior and resume
processing the most recent dedup images and discard all of the
preserved images for the application. By default, the system-
wide PreserveLdedupsOfPriority parameter in the
setparameter is set to all applications (low, medium, and high
priority), which means that the ProcessLatestDedup flag is
automatically disabled (set to ProcessLatestSnap:false). You
can specify ProcessLatestDedup:true to disable catch-up mode
for a specific application.

Note: Once you set either the -flags ProcessLatestSnap:true or

ProcessLatestDedup:true option, the -flags option will remain set to
true until you reset it back to the default state of
ProcessLatestSnap:false and ProcessLatestDedup:false.

414 Actifio CLI Reference | actifio.com |

The following example illustrates resuming processing the most recent dedup images and discarding the preserved
images for SLA ID 205677:
$ udstask chsla -flags ProcessLatestDedup:true 205677

The following example illustrates resuming processing the most recent snapshot images and discarding the preserved
images for SLA ID 205677:
$ udstask chsla -flags ProcessLatestSnapshot:true 205677

This example illustrates re-enabling image preservation for local dedup jobs for SLA ID 205677 to address backlogged
local dedup jobs.
$ udstask chsla -flags ProcessLatestDedup:false 205677

| actifio.com | Actifio CLI Reference 415

 Alerts and Warnings
Use the udsinfo lssnmpevent CLI command to monitor the various SNMP events that may appear when the Actifio
appliance preserves snapshot and/or local dedup images. This section outlines the various alerts and warnings related
to image preservation.

Warning Level Alert—First Time the Snapshot Expiration Window is Reached

A Warning level alert is generated (and posted to the event log) the first time the snapshot expiration window is
reached for an application and the image is held by the Actifio appliance. A similar Warning level Alert also occurs for
remote deduplication of local dedup images.
This Warning level alert is generated for the first snapshot for each application that has its expiration deferred. When
the count of deferred expirations for an application goes to zero, the Warning alert trigger is reset. The next time there
is a dedupable snapshot image that is held by the Actifio appliance an alert will be posted again. An example of this
particular Warning alert message is shown below:
The snapshot image Image_0998496 for application mgm-win-1 hostname mgm-win-1 (appid 5577) was
not expired even though expiration was due, since it has not been deduplicated. This is the
first image that has not been expired in this manner for this application.

Warning Level Alert—Snapshot Image Expired Because Threshold Limit Exceeded

When an application has preserved snapshots, and a dedupable snapshot is expired because the Actifio appliance has
exceeded the threshold limits (such as VDisk count or pool capacity), a Warning level alert indicating this condition is
posted. This warning will be logged only for the first snapshot expired due to this situation. The same requirement
applies to local dedup images with regard to remote dedup replication.
Included below is a summary of the Warning thresholds for VDisk and storage pools as specified through the 
udstask chdiskpool, udstask configresourcewarning, udstask mkdiskpool, and udsinfo getresourcewarning
commands:
• The default Warning threshold for VDisks usage is 90%. The VDisk limit for the Actifio CDS appliance is
2048, and for the Actifio Sky appliance, the VDisk limit varies with the installed capacity license (1000,
3000, or 5000 VDisks).
• The default Warning level is 80% for the snapshot and primary pools and 75% for the deduplication pool.
You set Safe Mode to an appropriate level of usage; the default value is 90% for the snapshot and primary
pools.

Daily Warning Level Event—Deferred Expirations for Snapshots

A daily warning level event is generated when there are deferred expirations for snapshots. This daily warning includes
a count of images for which expiration was deferred because these images are all candidates for deduplication. An
example of such a daily warning level event is shown below:
The number of images not expired awaiting further processing is 2 images (2 snapshots, 0 dedups)
from 1 unique applications. 2 snapshots and 0 dedups were added in the last period of 24 hours.

Daily Warning Level Event—Deferred Expirations Because Threshold Limit Exceeded

A daily warning level event is posted when a number of images that had deferred expirations were expired because
the Actifio appliance has exceeded the threshold limits (such as VDisk count or pool capacity). The message includes
a count of images expired in this fashion. An example of such an event is shown below:
The number of images awaiting further processing that had to be discarded is 5 images (3
snapshots, 2 dedups) from 3 unique applications in the last period of 24 hours.

416 Actifio CLI Reference | actifio.com |

Warning Level Alert—All Preserved Images Have Been Processed

When the number of preserved images drops to zero, the following alert will be generated similar to the example
shown below:
All images that had been held from expiration for further processing now have been process or
expired.

Weekly Error Level Event—Images Deduplicated or Remotely Replicated After 7 Days

When there are images that have not been deduplicated or remotely replicated for a period of 7 days, a weekly error
level event of severity Error is raised. When the 7th day is reached an alert will be generated similar to the example
shown below to inform you that the Actifio appliance has been in Preserve Mode for 7 days.
Still in preserved image mode after 7 days. The number of images not expired awaiting further
processing is 486 images (486 snapshots, 0 dedups) from 1 unique applications. 0 snapshots and
0 dedups were added in the last 2555 seconds (0 hours 42 minutes).

| actifio.com | Actifio CLI Reference 417

418 Actifio CLI Reference | actifio.com |
D List of Parameters Used With
getparameter and setparameter

This appendix is a complete list of system parameters associated with the following CLI commands:
• getparameter on page 131
• setparameter on page 168
You specify these parameters using the -param keyword in these commands.

Parameter Description Default Value Range

allowigc Allow iGC to run after GC has ran false true or false
successfully.

appminshrinksizefornewstagingdisk String value for the minimum 34359738368 ---------

application shrink size threshold for
creating new staging disks
(defaults to 32GB).

auditage Number of days an audit is kept. 90 1-365

auditchanges Audit of old and new values for true true or false
privileged commands.

authentication.method Determines which authentication database database or ldap

method to use for UI login
(database or LDAP authentication).

autoconfigsanports If set to 1, sanport auto 1 0 and 1

configuration is enabled.

backupjobsperhost The maximum number of snap, 1 1 to 1000

direct-dedup and dedup-async jobs
to run at a time on a single host.

bdd.ip.test.timeout The time (in seconds) for the BDD 30 0 to 300

server to wait before restoring the
network configuration.

changeratedb Change rate for DB application for 6 0 to 100

Guardrails calculations.

| actifio.com | Actifio CLI Reference 419

 Parameter Description Default Value Range

changeratenondb Change rate for Non DB application 3 0 to 100

for Guardrails calculations.

ChildLimit Specifies the default database 5 Maximum value

descendant level limit (children and varies by
the grandchildren) for all types of environment and
child database applications. The infrastructure
application-specific level limit
(OracleChildLimit or
SQLServerChildLimit), if specified,
overrides the limit for that specific
database application.

copywarninglimit Modifies the default limit of 14 14 2 to 1000

snapshot copies that will generate
a warning if this limit is reached or
exceeded based on SLA policy
settings. The supported value
range is from 2 to 1000.

createmultiplestagingdisks Create multiple staging disks for 1 0 to 1

out of band applications:
• 0—Create a single staging
disk for each application from
now.
• 1—Create multiple staging
disks where applicable,
based on threshold
parameters and connector
capabilities.

critical.events.exclude The error level events to exclude 10011,10013, Critical event ID

from critical events. 10023,10025,
10039

critical.events.include The warning level events to include 9052, Event IDs

as critical events. 999999999

daronrampslots The number of slots reserved for 0 0 to 100

dedup-async of new applications.

datastoreutilizationpollfreqinmins The frequency at which datastore 15 1 to 7200

space utilization is checked during
VM data-movement operation.

DBAuthentication Instructs the host to use DB true true and false

Authentication for Oracle
applications.

420 Actifio CLI Reference | actifio.com |

Parameter Description Default Value Range

default.ssh.connect.timeout Default connection timeout for 60 0 to 3000

SSH connections for the Actifio
CDS appliance.

default.ssh.session.timeout Default session timeout for SSH 60 0 to 3000

connections for the Actifio CDS
appliance.

default.v3700.ssh.connect.timeout Default connection timeout for 60 0 to 3000

SSH connections for the v3700.

default.v3700.ssh.session.timeout Default session timeout for SSH 60 0 to 3000

connections for the v3700.

delegatingpoolstatecachesize Delegating service poolstate cache 30 10 to 200

size.

delegatingpoolstatecachetimeout Delegating service poolstate cache 5 1 to 20

timeout (in minutes).

disableguardrails Turns off the “guardrails” function false true and false
which is used to warn the user
about possible impact on system
resources when creating an SLA
policy in SLA Architect and when
assigning that SLA policy in
Application Manager. Valid entries
are ‘true’ and ‘false’. By default,
this value is ‘false’ (the guardrails
function is enabled).

disablenbdvmbackups Fail VM backups if SAN mode data 0 0 and 1

movement cannot be performed.

| actifio.com | Actifio CLI Reference 421

 Parameter Description Default Value Range

disable.TLSv1.0 An advanced setting that will false true and false

disable Transport Layer Security
(TLS) version 1.0 for backwards
incompatibility with older operating
systems, browsers, and Adobe Air
clients. This feature should not be
enabled without a complete
understanding of the cryptographic
capability of all management
clients.
• true disables the TLSv1.0
protocol on the tomcat server
in the Actifio appliance. This
setting automatically restarts
the tomcat server on the
Actifio appliance.
• false reenables the TLSv1.0
protocol on the tomcat server
in the Actifio appliance. This
setting automatically restarts
the tomcat server on the
Actifio appliance.

Note: We strongly recommend

that you do not disable TLSv10
unless instructed to do so under
the guidance of an Actifio
Support representative.

dontexpirededupsduringgc If 1, do not expire dedup objects if 1 0 and 1

GC or iGC job is less than 30%
complete.

dontfullingestdedupsduringgc If 1, do not perform a full ingest 1 0 and 1

into dedup if a GC or iGC job is
running.

dosnapshotonreplicationfailure Continue with snapshot processing 1 0 and 1

even if StreamSnap replication
fails.

422 Actifio CLI Reference | actifio.com |

Parameter Description Default Value Range

enablecompressedreplication If 1, implements compression for 1 0 and 1

StreamSnap replication to the
second Actifio appliance.
Compression is required to
increase efficiency of the
StreamSnap replication to the
second Actifio appliance when
transferring data over the network.
If compression is not a
requirement for StreamSnap
replication to the second Actifio
appliance (for example, when
replicating images and videos),
specify 0.
These settings may be overridden
by the compressions settings in
the StreamSnap policy option.

Note: Enabling compression

may not always provide the best
results. Compression uses
additional CPU cycles at the cost
of saving network bandwidth. If
the available network bandwidth
is better than the system
resources such as CPUs, it is
advised to disable compression.

enablededupasync If 1, scheduling of dedup-async 1 0 and 1

jobs is enabled.

| actifio.com | Actifio CLI Reference 423

 Parameter Description Default Value Range

enableencryptedreplication If 1, implements SSL encryption 1 0 and 1

for StreamSnap replication to the
second Actifio appliance.
StreamSnap encryption occurs on
an external SSL port (port 5107) for
all outward communication.
If encryption is not a requirement
(for example, you are replicating an
Oracle database that is already
encrypted) specify 0. The data
transmission then occurs in a plain-
text communication. All
unencrypted communication
occurs over an external plan-text
port 5108 and rest of the control
flow is similar to the encrypted job.

Note: Only disable the

enableencryptedreplication
system-level parameter under
strict guidance of Actifio
Support.

When running StreamSnap jobs

with encryption disabled, you will
also need to perform the following
on the remote Actifio appliance:
• Start the remote streamsnapd
in nossl mode (the
streamsnapdnossl system-
level parameter) so that it
listens on both SSL and plain-
text mode. By default, the
Actifio appliance does not start
streamsnapd in plain-text
mode.
• To let plain-text replication run
successfully, enter the
following commands:
# udstask setparameter -param
streamsnapdnossl -value 1
# monit restart streamsnapd

enableesxmount Enable mounting of generic backup false true and false

to an ESX host.

enableexpiration If 1, scheduled expirations is 1 0 and 1

enabled. Set to 0 to disable
scheduled expirations.

424 Actifio CLI Reference | actifio.com |

Parameter Description Default Value Range

EnableGenericLVM Enable the generic Logical Volume false true and false
Management (LVM) functionality in
the Desktop UI.

enableindexing Set to ‘true’ to enable the global false true and false
indexing and search.

enablelocaldedups If 1, scheduling of local dedup and 1 0 and 1

direct-to-dedup jobs is enabled. Set
to 0 to disable scheduling.

enablenasserversnapexpiration Set to 0 to disable setting the 1 0 and 1

expiration of NAS server
snapshots. This system parameter
allows the Actifio CDS appliance to
expire snapshots off the NAS
server itself.

enable.password.complexity Enforces the specification of false true and false

complex local user or admin
password that is to be used when
a user logs into an Actifio
appliance.
A complex password can be
composed of any combination of
upper and lower case letters,
numbers, and the following special
characters:
“!”, “@”, “#”, “$”, “%”, “^”, “&”, “*”,
“(“, “)”
• true enforces the requirement
to specify a complex local
user or admin password.
• false disables the requirement
to specify a complex local
user or admin password.

enableremotededups If 1, scheduling of remote dedup 1 0 and 1

jobs is enabled. Set to 0 to disable
scheduling.

enablescheduler If 1, the global scheduler is 1 0 and 1

enabled. Set to 0 to disable
scheduling.

enablesnapshots If 1, scheduling of snapshot jobs is 1 0 and 1

enabled. Set to 0 to disable
scheduling.

| actifio.com | Actifio CLI Reference 425

 Parameter Description Default Value Range

enablestreamingreplication If 1, enables parallel replication 1 0 and 1

with snapshot processing for
VMware replication jobs. Set to 0
to disable parallel replication (only
disable this function under direct
guidance of Actifio Support).

enablestreamsnap If 1, enables the scheduling of 1 0 and 1

StreamSnap jobs. Set to 0 to
disable scheduling (only disable
this function under direct guidance
of Actifio Support).

enablevaults If 1, enables the scheduling of vault 1 0 and 1

jobs. Set to 0 to disable scheduling
(only disable this function under
direct guidance of Actifio Support).

ExpirerEventLogFrequency The frequency of the event log 86400 3600 to 86400

expirer in seconds.

expirerinterval The frequency of the expiration 5 1 to 120

loop in seconds.

expirerjobspercycle The maximum number of jobs to 10 1 to 20

start in a expiration loop.

expirerloadcount Minimum number of images the 2500 100 to 10000

expirer should consider for each
pass.

expirerreloadinterval The frequency of reloading the 900 20 to 3600

expiration in seconds.

expirerrequeuefailure Retry for expiration on a failure in 3600 900 to 86400

seconds.

expirerretrydependent Retry for expiration deferred 900 60 to 3600

because of a unexpired dependent
backup in seconds.

expirerretrylocked Retry for expiration deferred 60 30 to 900

because of a lock in seconds.

firstbackupwholevmdk If 1, change block tracking is 1 0 and 1

ignored for first VM backup.

gcminthreshold Minimum usage threshold 65 1 to 100

(percentage) for dedup pool before
gc schedule is enabled.

426 Actifio CLI Reference | actifio.com |

Parameter Description Default Value Range

gcsafethreshold The safe mode threshold 85 1 to 100

(percentage) for dedup pool

GC_ZTR_PARALLEL_ACTIVE_WORK The number of active (high-priority -1 1, 2, 4, 8, and 16

ERS transaction) workers on zero-token
resolution, must be a power of 2.

GC_ZTR_PARALLEL_HI_PRIO The transaction priority to 10 1 to 10

associate with high priority for
zero-token resolution.

GC_ZTR_PARALLEL_MAX_WORKER Total number of workers on zero- -1 1, 2, 4, 8, and 16

S token resolution (both active and
inactive), must be a power of 2.

genericappfailonconnecterror Fail the backup job for a generic 0 0 or 1

application if the Connector cannot
be reached.

hostheartbeattimeoutinmins Host heartbeat timeout in minutes. 60 0 to 43,200

https.request.timeout Request timeout for https 420000 0 to 1800000

connections in milliseconds. The
default value is 7 minutes, min 0,
and max 30 minutes.

https.socket.timeout Socket timeout for https 420000 0 to 1800000

connections in milliseconds.
default 7 minutes min 0, max 30
minutes.

ignoredtraps Traps to be ignored (colon ':', 0 Trap IDs

separated).

ignore.schedule.off.violation When set to 1, specifies to ignore 0 0 and 1

SLA violations when the scheduler
is off.

ldap.referral.support This is to specify whether to false true, false

support LDAP referral.

ldap.user.autocreate Automatically create LDAP users if false true, false

they don't exist.

ldeduponrampslots The number of slots reserved for 0 0 to 100

local dedups and direct-to-dedup of
new applications.

licensedcapacity Configured licensed capacity, in 0 0 to 10240

TB.

| actifio.com | Actifio CLI Reference 427

 Parameter Description Default Value Range

limitdedupexpirations The maximum number of 2 0 to 25

scheduled dedup expirations.

liveclonerefreshcreatereference When set to 1, create a reference 0 0 and 1

object during a LiveClone refresh
to revert back to in the case of a
refresh failure.

maptoallesxincluster Map staging disk to all ESX hosts 1 0 or 1

in a cluster.

maxconcurrentvaultsubjobs Maximum number of concurrent 12 4 to 1000

vault subjobs ingested into the
vault. Subjobs are flow-controlled
such that at least one subjob per
vault job is always allowed without
throttling. Use this parameter
when you need to limit the
maximum number of vault subjobs.

Note: The default for

maxconcurrentvaultsubjobs is
12 and the default for
maxvaultslots is 4. In this case,
there can be at any time a total
of 4 top-level vault jobs running.
To prevent starving vault jobs, a
minimum of 1 slot each has
been reserved for every vault
job. Note that the first job
cannot use all 12 slots; it can
only use up to 9 slots, and will
reserve 3 of the remaining slots
for new vault jobs to ensure that
all vault jobs can make progress.

maxconnectorupgradetimeout Maximum connector upgrade Task 10 5 to 60

timeout in minutes (default to 10
minutes).

maxdarslots The maximum number of slots for 3 0 to 1000

enhanced asynchronous
deduplication.

maxexpirationslots The maximum number of 10 0 to 1000

expiration slots.

maxiscsisessionspertarget Maximum active iSCSI sesions per 15 15 to 100

target interface.

428 Actifio CLI Reference | actifio.com |

Parameter Description Default Value Range

maxldapresults The maximum number of object 50000 ----------

we will process from an LDAP
query.

maxldedupslots The maximum number of local 8 0 to 1000

dedup slots allowed.

maxondemandslots The maximum number of slots for 6 0 to 1000

all types of on demand jobs.

maxrdedupslots The maximum number of remote 6 0 to 1000

dedup slots allowed.

maxsnapslots The maximum number of 6 0 to 1000

snapshots slots.

maxstreamsnapslot The maximum number of 6 0 to 1000

scheduled StreamSnap slots.

maxskyjoins The maximum number of appliance 50 ----------

pairings allowed for an Actifio Sky
appliance.

maxvaultslots The maximum number of 4 0 to 1000

scheduled vault jobs. Use this
parameter when you need to
control the maximum slots for vault
jobs.

maxvmtaskretrycount The maximum VM task retry count. 10 1 to 100

maxvmtasktimeout Maximum VM task timeout, in 600 60

seconds.

minlaststagingdisksize String value for minimum size of 27487790694 ----------

last staging disk for an application 4
with multiple staging disks.

missed.cluster.ping.threshold Threshold value for the number of -1 -----------

missed cluster pings before raising
a trap. -1 indicates never to alert.

nasserversnapexpirationindays Expiration for NAS server 3 0 to 365

snapshots, specified in days. This
system parameter allows the
Actifio CDS appliance to expire
snapshots off the NAS server,
based on the specified number of
days.

| actifio.com | Actifio CLI Reference 429

 Parameter Description Default Value Range

netapp.enable Set to 1 to enable NetApp as a 0 0 and 1

NAS server type.

networkinterfacecheck Specifies the network interface none none, eth0, and

(Ethernet port) to monitor and eth1
sends the SNMP trap if it is down.
Multiple interfaces are allowed;
use a comma to separate them.

onejobperhostoverride Override the one-job-per-host limit none none, aix-only,

on an HPUX or AIX host. hpux-only, and 
aix-and-hpux

operatingwindowintonextday When set to 1, operating windows 0 0 and 1

extend into the next day even if
they were excluded.

OracleChildLimit Changes the app-aware mount 0 Maximum value

Oracle database descendant level varies by
limit (children and grandchildren). environment and
By default (when set to 0), the infrastructure
ChildLimit parameter specifies the
default database descendant level
limit for all types of child database
applications. The OracleChildLimit
parameter allows you to override
this default child level limit for
Oracle databases.

Note: Only change the

OracleChildLimit system-level
parameter under guidance of
Actifio Support.

password.minlength Specifies a minimum password 6 6 to 1024

length for the local user or admin
when they log into an Actifio
appliance.

prefernbdssl When set to 1, specifies to use 0 0 and 1

NBD mode VM backups over SSL
instead using plain (plaintext) NBD
mode VM backups.
The use of NBDSSL results in the
data being encrypted in flight while
performing the data transfer from
the VMDK files into the Actifio
appliance.

430 Actifio CLI Reference | actifio.com |

Parameter Description Default Value Range

preservelastimage If 1, do not expire the last image of 1 0 and 1

each type for any protected
application.

PreserveLdedupsOfPriority Defines how to preserve local low none, high,

dedup images that are due for medium, and low
expiration but not yet successfully
processed
By default, all local dedup images
are preserved until the remote
deduplication system can catch up
with the preserved local dedup
images, or until the capacity in the
local dedup pool has reached the
warning level.

Note: For background on image

preservation, including
modifying settings, see
Configuring Image Preservation
on page 409.

PreserveSnapsOfPriority Defines how to preserve snapshot low none, high,

images that are due for expiration medium, and low
but not yet successfully deduped.
By default, all applications (low,
medium, and high priority) will have
their snapshot images preserved
until the local dedup system can
catch up with the preserved
snapshot images, or until VDisk
counts or performance pool
capacity thresholds are reached.

Note: For background on image

preservation, including
modifying settings, see
Configuring Image Preservation
on page 409.

rdeduponrampslots The number of slots reserved for 0 0 to 100

remote dedups of new
applications.

removeduplicateevents Attempt to removed duplicate false true and false

events from event emails.

| actifio.com | Actifio CLI Reference 431

 Parameter Description Default Value Range

reserveddarslots The number of slots reserved for 3 0 to 25

enhanced asynchronous
deduplication.

reservedexpirationslots The number of slots reserved for 10 0 to 25

scheduled expirations.

reservedldedupslots The number of slots reserved for 4 0 to 25

scheduled remote local
deduplication jobs.

reservedondemandslots The number of slots reserved for 6 0 to 25

all types of on-demand jobs.

reservedrdedupslots The number of slots reserved for 6 0 to 25

scheduled remote dedup jobs.

reservedsnapslots The number of slots reserved for 2 0 to 25

scheduled snapshots.

reservedstreamsnapslots The number of slots reserved for 2 0 to 25

scheduled StreamSnap slots.

reservedvaultslots The number of slots reserved for 4 0 to 25

scheduled vault jobs. Use this
parameter when you need to limit
the reserved slots for vault jobs.

retriesonfailure The maximum number of times a 3 0 to 20

failed scheduled job is retried. This
parameter specifies the number of
times the job must be retried in the
event of a failed job. For example,
retriesonfailure 3 specifies that
the job retries three times after
original attempt.

retrydecay The delay for each subsequent 400 100 to 10000

retry in percent. This parameter
specifies the % of delay to attempt
further retries.

retrydelay The delay before the first retry of a 240 30 to 3600

failed job in seconds. This
parameter specifies the number of
seconds that the job should wait to
retry after the original attempt. For
example, retrydelay 240 specifies
that the first job retry happens after
240 seconds.

432 Actifio CLI Reference | actifio.com |

Parameter Description Default Value Range

rfcsnappooloverallocationpercent When doing an inband restore via 20 0 to 1000

RFC we check that the snap pool(s)
will not be overfilled via RFC. Pad
the calculated space required by
this percent to assure other
concurrently running jobs will not
exhaust the pool(s).

schedulerinterval The frequency of the scheduler in 10 1 to 120

seconds.

schedulerjobspercycle The maximum number of jobs to 4 1 to 20

start in a scheduler loop.

schedule.watchdog.interval Time interval in hours for Quartz 3 1 to 24 (0 to

hourly schedule watchdog. Set to 0 disable)
to disable.

scriptexectimeout Timeout waiting for pre and post 60 1 to 120

scripts called using the Actifio
Connector.

scriptinittimeout This policy option specifies the 300 1 to 600

timeout value for the init script
completion.

secureconnect.local Local IP address for secureconnect --------- ---------

to bind to.

secureconnect.port Port to use for secureconnect. 1194 1 to 65536

secureconnect.proto Protocol to use for secureconnect. udp udp and tcp

secureconnect.proxy_port Port for secureconnect proxy. 0 0 to 65536

secureconnect.proxy_server Proxy server for secureconnect --------- ---------

secureconnect.server Server for secureconnect. secureconnec ---------

t2.actifio.com

session-timeout-minutes UI session timeout in minutes. 60 0 to 60

sla.tolerance The maximum number of times 0 0 and 1

that the scheduler can fail to meet
the SLA criteria before considering
a failure as SLA violation.By
default, this setting is 0, indicating
a failure to meet the SLA criteria
will be considered an SLA violation.

| actifio.com | Actifio CLI Reference 433

 Parameter Description Default Value Range

slaAnalysis.enable The setting to enable/disable SLA true true and false

analysis. By default, this value is
‘true’.

slaAnalysis.notificationtype The notification type for SLA warning warning, error,

violation traps. info

snapshotonrampslots The number of slots reserved for 0 0 to 100

snapshots of new applications.

snmp.community.string The community string for sending --------- ---------

SNMP traps.

snmptablesize Limits the number of records sent 500 100 to 5000

by the SNMP agent in the Actifio
appliance to the management
system (the client). Whenever this
parameter is set, the SNMP agent
will retrieve only the specified
number of records and send those
records to the respective SNMP
clients.

SQLServerChildLimit Changes the app-aware mount 0 Maximum value

SQL server database descendant varies by
level limit (children and environment and
grandchildren). By default (when infrastructure
set to 0), the ChildLimit parameter
specifies the default database
descendant level limit for all types
of child database applications. The
SQLServerChildLimit parameter
allows you to override this default
child level limit for SQLServer
databases.

Note: Only change the

SQLServerChildLimit system-
level parameter under guidance
of Actifio Support.

stagingdiskgranularity A string value indicating the size of --------- 1099511627776

each staging disk when multiple
staging disks are used for an
application.

streamsnapdconnectiontimeout Connection timeout in seconds for 60 1 to 1200

the streamsnapd daemon.

434 Actifio CLI Reference | actifio.com |

Parameter Description Default Value Range

streamsnapdheartbeattimeout Time interval between heartbeat 60 1 to 1800

messages for the streamsnapd
daemon.

streamsnapdinternaltimeout Internal connect/disconnect 10 1 to 1800

timeout for the streamsnapd
daemon.

streamsnapdmaxmemorysize Maximum memory usage (in GB) 4 1 to 1024

for the streamsnapd daemon.

streamsnapdmaxrunningjobs Maximum number of jobs initiated 100 1 to 256

and received by the streamsnapd
daemon (both the source and
target Actifio appliance).

streamsnapdmaxserverconnections Maximum number of simultaneous 100 1 to 256

non-SSL connections for all internal
communication by the
streamsnapd daemon. The
streamsnapd daemon listens on an
internal port (7445).

streamsnapdmaxsslconnections Maximum number of simultaneous 100 1 to 256

SSL connections for all inward and
outward communication by the
streamsnapd daemon. The
streamsnapd daemon listens on an
external SSL port (5107).

streamsnapdmaxwindowsize Maximum number of outstanding 64 8 to 1024

packets in the streamsnapd pipe
for each session.

streamsnapdmillispertick Number of milliseconds per tick for 1000 100 to 10000

updating streamsnapd statistics.

streamsnapdnetalerttime Network off detection timeout for 900 1 to 10000

the streamsnapd daemon.

streamsnapdnetworkretries Maximum number of network 5 1 to 1000

retries for the streamsnapd
daemon.

streamsnapdnossl Start the streamsnapd server in 0 0 and 1

non-SSL mode (plain-text mode).
By default, the Actifio appliance
does not start streamsnapd in
plain-text mode. When the nossl
option is enabled, the target server
listens on plain-text port 5108.

| actifio.com | Actifio CLI Reference 435

 Parameter Description Default Value Range

streamsnapdprogressupdateinterval streamsnapd job progress update 5 1 to 600

interval in seconds.

streamsnapdreconnectdelay Minimum delay in milliseconds for 100 1 to 10000

reconnect in the streamsnapd
daemon

streamsnaponrampslots Number of slots reserved for 0 0 to 100

StreamSnap replication of new
applications.

sweepthreshold Determines how aggressive the 50 1 to 100

sweep process will be in
reclaiming space from expired
backups.

systemcontact A string value that sets the --------- ---------

sysContact Object Identifiers (OID)
value as part of the SNMP system
information for an Actifio appliance.

systemlocation A string value that sets the --------- ---------

sysLocation OID value as part of
the SNMP system information for
the Actifio appliance.

truepathdefaultdriveletter Assign a drive letter to mounted 1 0 and 1

volumes even if user did not
specify a drive letter.

unreservedslots The number of additional slots 9 0 to 100

available for any job type.

usegcjobqueue Queue missed gc/igc/sweep/ false true and false

isweep jobs to be rerun.

v3700.pwd The admin password for v3700 Contact your ---------

storage devices. Actifio rep for
the admin
password.

vdisklimit The maximum number of VDisks 0 ---------

supported by an Actifio Sky
appliance.

vixdisklibdebuglevel The debug level for the vixdisklib. 4 0 to 7

436 Actifio CLI Reference | actifio.com |

Parameter Description Default Value Range

vmconsolidatedisks Configure job behavior when target fail fail, yes, no

VM needs snapshot consolidation.
If the VM requires consolidation:
fail - Fail the job: backup/DAR/
direct-dedup jobs fail.
yes - Perform consolidation at the
beginning of the job: Backup/direct-
dedup/DAR jobs try to perform
consolidation at the beginning of
the job. If consolidation fails, the
job fails with an error message.
no - Run the job without
performing consolidation: All jobs
run normally even if consolidation
is pending.

vmdatastorefullcriticalthreshold Critical threshold (percentage) for 95 80 to 100

virtual machine's datastore space
usage, above which the virtual
machine backup job is aborted and
a critical event is logged.

vmdatastorefullwarnthreshold Warning threshold (percentage) for 80 50 to 100

virtual machine's datastore space
usage, above which a critical event
is logged.

vmexistingsnapshotwarrning Set to 1 to log a warning for 0 0 and 1

existing snapshots for the VM
being backed up.

vmfilesthreshold Threshold for number of files inside 32 5 to 100

a VM home directory, above which
a warning event is logged.

vmlowsplashwithcbt Uses the following parameters: never never, threshold,

• never - No low splash when and full
CBT exists
• threshold - Low splash when
CBT crosses
vmlowsplashwithcbtthreshold
percentage
• full - Always use low splash on
full vmdk when CBT exists

vmlowsplashwithcbtthreshold Percentage of bytes in CBT when 50 0 to 100

low splash is used. Applicable
when vmlowsplashwithcbt =
threshold.

| actifio.com | Actifio CLI Reference 437

 Parameter Description Default Value Range

vmnocbtdocompare Set to 1 to avoid overwriting blocks 1 0 and 1

with same data from VMware
snapshot to staging disk, when no
changed extent list exists.

vmorgenericbackupmountpvidchange Mount of VM/Generic backup to 1 0 to 2

host without connector:
• 0 - Do not change LVM PV
IDs.
• 1 - Change LVM PV IDs if
VMware believes the OS is
Linux.
• 2 - Always change the LVM
PV IDs.

vmtaskcompletiontimeout VM Task completion timeout (in 60 1 to 43200

minutes).The VM Task completion
timeout (default of 60 minutes) is
used as timeout for task
completion. All tasks except clone
and recreatedisks honor this
setting. This system parameter
would be ineffective for clone task
and recreatedisks tasks.

zpoolcompression Enables the Zpool compression on on and off

property.

438 Actifio CLI Reference | actifio.com |

E List of Policy Options

This appendix is a complete list of policy options associated with the following CLI commands:
• chpolicyoption (chpolicyoption on page 312)
• lspolicyoption (lspolicyoption on page 324)
• mkpolicyoption (mkpolicyoption on page 334)
• rmpolicyoption (rmpolicyoption on page 342)
• lssettableoption (lssettableoption on page 347)

| actifio.com | Actifio CLI Reference 439

 Policy Option Description Value Policy Type AppType

appconsistency Takes an application yes - Takes application- snap, VMBackup,

consistent snapshot consistent backup; directdedup, Microsoft Hyper-V, 
for a backup. notifies the application to dedup_async VSS Writer
prepare for a backup. This
option loses no data. It
pauses application data I/
O, completes in-flight
transactions, and flushes
memory to disk. On
recovery, data is easily
accessible.
no - Takes crash
consistent backup. Crash-
consistent backup is a fast
backup of application data
in storage as if power
were lost at that moment.
It does not pause
application data I/O. All
data on disk are saved,
and data in memory is
lost. Incomplete
transactions may be
saved.
last - Takes application
consistent backups, but
takes a crash consistent
backup if an application
consistent backup fails for
any reason. Setting
appconsistency to last is
only honored for
scheduled jobs. For
example, when
appconsistency=last for
scheduled jobs:
• Job_1234567 will be
appconsistent.
• Job_1234567a (1st
retry) will be
appconsistent.
• Job_1234567b (2st
retry) will be
appconsistent.
• Job_12345677c (last
retry) will be crash
consistent.
These values are on a per
job basis; any internal
retries inside
Job_1234567 will use
same value for
appconsistency.

440 Actifio CLI Reference | actifio.com |

Policy Option Description Value Policy Type AppType

archivebackuptime Instructs the Actifio 1 to 5 ———— Oracle,

appliance to backup ConsistGrp
the archivelog if it has
not been backed up
the specified number
of times.

archivetnsservice Specifies the TNS String ———— Oracle

service name for
archivelog backup.

asmraclist IP addresses of the String ———— Oracle

member nodes of a
RAC database for
ASM backup.

ausize Configures the ASM 1, 2. 4, 8, 16, 32, or 64 ———— Oracle,

Diskgroup AU size, in MB ConsistGrp
MB

autodiscoverrac Specifies to auto false (default) or true ———— Oracle

discover all members
of a RAC database for
ASM backup

bootvolumesnapshot Specifies to back up no - Backup all the snap, VMBackup,

only the boot volume volumes of the VM directdedup, Microsoft Hyper-V
of the VM. (default). dedup_async VSS Writer
yes - Backup only boot
Note: When volume of the VM.
protecting VMs, if
the application
binaries are spread
over multiple
VMware VMDKs or
the boot volume is
not the first drive
on the bus, then
the entire boot
volume may not be
captured.

catalogdb Specifies the Oracle String ———— Oracle,

catalog database SID ConsistGrp
name. This is for the
user environment
where RMAN
CATALOG DATABASE
is set up for RMAN
backup.

catalogpassword Specifies the Oracle String ———— Oracle,

catalog database user ConsistGrp
login password.

| actifio.com | Actifio CLI Reference 441

 Policy Option Description Value Policy Type AppType

cataloguser Specifies the Oracle String ———— Oracle,

catalog database user ConsistGrp
name for RMAN
backup.

changerate Daily change rate for 0 to 100 percent (default snap Oracle,
the database, used to is 10 percent) SqlServerWriter,
estimate staging disk ConsistGrp
size. The value must
be between 0 and 100
percent.

clusternodes Enter the IP addresses Specify the failover node ———— Oracle,
of appliance nodes for choice in a Oracle RAC Microsoft Exchange
fail-over choice in this environment in this way: Writer,
format: Failover choice:Node ConsistGrp
1:172.16.16.21:svc IP:Servicename:Role
_orarac2_act:F Failover Choice - The
[failover order of node in which
rank]:[failover user wants to try the
node failover.
ip]:[servicename
Node IP - IP address of
on failover
the node where you want
node]:[role of
member node] the backup to run.
Servicename - The name
The role of member
of the service created and
node by default should
be F (failover). It can specified in the
tnsnames.ora for Actifio
also be M
RMAN backup. This can
(maintenance). When
an appliance member be a new dedicated
service created for Actifio
role is specified as M,
backup or the SID name
then the Actifio
appliance uses it as (instance name) of the
database on that node.
the primary backup
node instead of using Role - Role can be either F
the original protected (failover node) or M
node. (Oracle, (maintenance node)
Exchange).

compressdblog Flag to enable log false (default) or true snap SqlServerWriter,

backup compression. Oracle,
If selected, the ConsistGrp
database server
performs the
compression during
the log backup.

compressedreplication Use compression for yes - Use compression for stream_snap ————
StreamSnap StreamSnap replication
replication (default)
no - Do not use
compression

442 Actifio CLI Reference | actifio.com |

Policy Option Description Value Policy Type AppType

connectoroptions Leave String ———— FileSystem,

connectoroptions SqlServerWriter,
blank unless you are Microsoft Exchange
working with Actifio Writer,
Support. SharePoint Services
Writer,
Oracle,
CIFS,
NFS,
NAS,
Microsoft Hyper-V
VSS Writer,
ConsistGrp

consolidatevmdisks Specifies the Fail the job if VM needs ———— VMBackup

appropriate job consolidation - Backup/
behavior when target DAR/direct-dedup jobs fail
VM needs snapshot (default).
disk consolidation. Run the job without
performing
consolidation - All jobs
run normally even if
consolidation is pending.
Perform consolidation at
the beginning of the job
- Backup/direct-dedup/
DAR jobs try to perform
consolidation at the
beginning of the job. If
consolidation fails, the job
fails with an error
message.

crosscheckarchivelog Performs a crosscheck false (default) or true ———— Oracle,

of the archivelog ConsistGrp
before performing a
backup.

| actifio.com | Actifio CLI Reference 443

 Policy Option Description Value Policy Type AppType

datasetsize NAS dataset size (in 1 to 256000 (default = ———— NAS

GB). enter a staging 1024)
disk size of 1.2 times
the size of the
protected dataset. An
initial size for the
staging disk that will
be used to back up
this application. The
Actifio appliance will
allocate an initial disk
(or multiple disks if
larger than the system
max staging vDisk
setting) to equal this
size. If the space in
this disk is insufficient
to backup the NAS
Dataset, the staging
disk will be expanded
to accommodate the
backup.

dbbackupfreq Performs a database 2 to 24 (hours) dedup_async ————

backup every
specified number of
hours for log
protection.

donotshowrecoveryrange Indicates that log true (default) or false ———— Oracle,

backup should not ConsistGrp
have recovery range.

donotuncatalog To keep RMAN backup false (default) or true ———— Oracle,

cataloged after each ConsistGrp
backup. By default
Actifio appliance
backup will be un-
cataloged at the end
of the backup and will
be cataloged at the
start of backup.

enableindexing Flag to control false (default) or true ———— NAS

indexing

encryptedreplication Use encryption for yes - Use encryption for stream_snap ————
StreamSnap StreamSnap replication
replication (default)
no - Do not encrypt

444 Actifio CLI Reference | actifio.com |

Policy Option Description Value Policy Type AppType

excludepatterns Enter the file name String ———— FileSystem,

pattern to be excluded CIFS,
from backup. The NFS,
Actifio appliance offers NAS
the ability to exclude
certain file types from
the backup. Using this
policy option, only the
most crucial data is
backed-up leaving a
side the non-critical
files. Guidelines for
exclude patterns:
Using
excludepatterns, only
files are excluded,
directories are not
excluded.
A pattern can include
wild-card characters,
for example, an
asterisk (*) or a
question mark (?). To
exclude all the files
that contains .sys as
extension, enter *.sys.
On Windows, files
named pagefile.sys
and hiberfil.sys that
appear in the root
directory of a drive are
automatically ignored.

failonmissingstartpath The SmartCopy job false (default) or true snap, FileSystem,

will fail if a start path directdedup, CIFS,
does not exist. dedup_async NFS,
ConsistGrp

forcelevel0 Start a new level0 false (default) or true ———— Oracle,

RMAN backup when ConsistGrp
the database is
protected out-of-band.

forceoobbackup Forces the out-of-band false (default) or true snap, FileSystem,

backup when directdedup, SqlServerWriter,
database datafiles are dedup_async Microsoft Exchange
in-band. Writer,
SharePoint Services
Writer,
Oracle,
ConsistGrp

fsfreezetimeout Timeout of a file 3 to 300 seconds  ———— FileSystem,

system freeze in (default = 30) ConsistGrp
seconds for 
in-band backup jobs.

| actifio.com | Actifio CLI Reference 445

 Policy Option Description Value Policy Type AppType

genericlvmscriptname Freeze and thaw script String ———— LVM Volume

name for Linux CBT
filter driver

includepatterns Enter the file name String ———— FileSystem,

pattern to be included CIFS,
in the backup. The NFS,
Actifio appliance offers NAS
the ability to include
certain file types in
the backup. Using this
policy option, only the
most crucial data is
backed-up leaving a
side the non-critical
files. Guidelines for
include patterns:
Using
includepatterns, only
files are included,
directories are not
included.
A pattern can include
wild-card characters,
for example, an
asterisk (*) or a
question mark (?). To
include all the files
that contains .sys as
extension, enter *.sys.
On Windows, files
named pagefile.sys
and hiberfil.sys that
appear in the root
directory of a drive are
automatically ignored.

logalterloc Customized String ———— ————

application log
location.

logbackupfreq This Log Protection 15 to 1440 snap ————

option defines the
frequency for
database transaction
log backup. Frequency
is set in minutes and
must not exceed the
database backup
interval. This value
must not exceed the
database backup
interval.

446 Actifio CLI Reference | actifio.com |

Policy Option Description Value Policy Type AppType

logbackupretention Retain database log 1 to 90 days  snap ————

backup for the (the default is 2 days)
specified period.
Retention period must
be between 1 and 90
days.

logbackupunit Log backup interval minute - Log backup in snap, ————

unit. number of minutes dedupasync
hour - Log backup in
number of hours

logpurgeretention Log retention in hours 1 to 720 (hours) ———— Oracle,

before log purging. ConsistGrp

logpurgeretentionnum Number of successful 1 to 30 ———— Oracle,

backups before log ConsistGrp
purging.

logpurgeretentunit Retention period unit day - Log retention in snap, ————

for log purging. days. dedupasync
hour - Log retention in
hours.

logretention Retention percentage 0 to 100% snap, ————

of log backup with dedup_async
regard to database
backup.

logsizebuffer Buffer space for log 1 to 10 days  snap ————

backups. The value (the default is 2 days)
must be between 1
and 10 days.

logresizepercent Grow the log staging 5 to 100 percent  snap ————

disk by a specified (the default is 50 percent)
percentage if needed.
The value must be
between 5 and 100
percent.

logsmart Flag indicating that false (default) or true snap ————

Log Protection is
enabled.

logstagingdisksize Enter a log staging 1 to 4000 ———— Oracle,

disk size (in GB) to SqlServerWriter,
override the space ConsistGrp
automatically defined
for database log
backups.

| actifio.com | Actifio CLI Reference 447

 Policy Option Description Value Policy Type AppType

maptoallesxincluster If your ESX servers no - Do not map staging snap, FileSystem,

are in a cluster, you disk to all ESX hosts directdedup, SqlServerWriter,
can select this to (default). dedup_async Microsoft Exchange
ensure that the VMs yes - Map staging disk to Writer,
are protected in case all ESX hosts. SharePoint Services
of failover during Writer,
backup. CIFS,
NFS,
ConsistGrp

maxcorrupt Maximum block 0 (default) to 1000 ———— Oracle,

corruption allowed ConsistGrp
during an RMAN
backup.

minlaststagingdisksize If an application 1 to 128000 ———— Oracle,

requires multiple FileSystem,
staging disks, enter NFS,
the minimum size to ConsistGrp
be allocated for the
staging disk used for
the last part of that
application

namedlistener Oracle named listener. String ———— Oracle,

For more then one ConsistGrp
listener running on the
database server
specify the listener
name.

notskip By default, an Oracle skip - Skip offline and ———— Oracle,

backup skips inaccessible tablespace/ ConsistGrp
inaccessible datafiles (default).
tablespace/datafiles. If inaccessible - Do not skip
you do not want to inaccessible tablespace/
skip these, then datafiles.
specify the notskip
offline - Do not skip
option.
offline tablespace/
datafiles.

nounmap Specifies if you want yes - Out of band staging snap, FileSystem,
out-of-band staging disks not unmapped after directdedup, SqlServerWriter,
disks mapped to the backup (default). dedup_async Microsoft Exchange
host and used during no - Out of band staging Writer,
data movement for disks unmapped after SharePoint Services
backup to remain backup. Writer,
mapped to the host. Oracle,
CIFS,
NFS,
NAS,
ConsistGrp

448 Actifio CLI Reference | actifio.com |

Policy Option Description Value Policy Type AppType

numberofchannels Configures RMAN 1 to 255 ———— Oracle,

channels based on ConsistGrp
specifics of the host
computing power.
Number of channels
should be configured
based on the # of
cores available on the
server, taking into
account other
database backups
configured to run in
parallel.

oraclechildbackup Indicates this is a true (default) or false ———— Oracle,

Oracle child backup ConsistGrp

password Specifies the String ———— Oracle,

authentication CIFS,
password as part of SqlServerWriter
the user credentials. VMBackup,
NAS,
Microsoft Hyper-V
VSS Writer,
ConsistGrp

primarynodeservicename Specifies the String ———— Oracle

servicename
configured on the
Data Guard node that
connects to the
primary Actifio node.
This is required only
when you are
protecting data from
Oracle Data Guard.

proxyhostid Proxy host used String ———— NAS

during NAS backup.

| actifio.com | Actifio CLI Reference 449

 Policy Option Description Value Policy Type AppType

prunepaths Specifies a point String ———— FileSystem,

where the directory CIFS,
traversal will stop. NFS,
When protecting a NAS
Windows application,
a value of
\\SERVERNAME\SHA
RENEAME\abc will
ensure that nothing
below\\SERVERNAME
\SHARENEAME\abc is
copied, but all other
directories and files in
\\<SERVERNAME\SH
ARENEAME are
copied. If prunepath
is left blank, the
directory traversal
descends into every
subdirectory of the
start paths being
backed-up.

450 Actifio CLI Reference | actifio.com |

Policy Option Description Value Policy Type AppType

readyvm VM in ESX datastore no - VM in Performance ———— VMBackup

dedup async pool snapshot (default)
replication. yes - VM in ESX datastore

remotedatastores Remote datastores String ———— VMBackup

details for VM in ESX
datastore dedup async
replication.

remoteesx Remote ESX server String ———— VMBackup

details for VM in ESX
datastore dedup async
replication.

remotemetadatastore Remote metadata String ———— VMBackup

store details for VM in
ESX datastore dedup
async replication

remotevcenter Remote vCenter String ———— VMBackup

details for VM in ESX
datastore dedup async
replication.

restorevalidate Provides restore true or  ———— Oracle,

validate for the Oracle false (default) ConsistGrp
backup,. When this
option is set to true
the Actifio Connector
will invoke RMAN
restore validate for
each backup. This
validation will add time
to the backup.

| actifio.com | Actifio CLI Reference 451

 Policy Option Description Value Policy Type AppType

rmanloglocation RMAN log path name. String ———— Oracle,

Enter the RMAN log ConsistGrp
path in the RMAN Log
Location field. This is
the custom location
(full path along with
RMAN filename)
where RMAN writes
the logs while taking
the backup.
For Linux - the default
log location is: 
/act/log/
<sid>_rman.log.
If you change the
path, the value must
be in the form /act/log/
test/custom_rman.log
For Windows - the
default log location is:
c:\act_tmp\log\<sid>_r
man.log.
If you change the
path, be sure there are
no spaces in the path.

root Root path of the NAS String ———— NAS

dataset. Browse
through the
directories of selected
NAS Share to select a
Root Path. Directories
and files outside of
this path will not be
traversed for this
dataset. You can leave
this field blank to use
the top level of the
NAS share as the
starting point.

scriptfinishtimeout Sets the script finish 1 to 86400 ———— ————

timeout setting for
Actifio Connector

scriptfreezetimeout Sets the script freeze 1 to 86400 ———— ————

timeout setting for
Actifio Connector

scriptinittimeout Sets the script 1 to 86400 ———— ————

initialization timeout
setting for Actifio
Connector

452 Actifio CLI Reference | actifio.com |

Policy Option Description Value Policy Type AppType

scriptunfreezetimeout Sets the script 1 to 86400 ———— ————

unfreeze timeout
setting for Actifio
Connector

serviceip Enter a service access String ———— FileSystem,

point IP address to SqlServerWriter,
back up from an SQL SharePoint Services
availability cluster. Writer,
Specify the IP address ConsistGrp
of the cluster node
you want the database
to be backed up from.
This option is not
required if you want
the database to be
backed up from the
active node and it is
not required for a
failover cluster.

servicename Specifies the Oracle String ———— Oracle,

database service ConsistGrp
name. This is optional
for a standalone
instance but required
for a RAC setup.
(Oracle only).

shareid ID address of the NAS String ———— NAS

share corresponding
to the NAS
application. Select one
of the shares from the
NAS server.

sharetype Select either CIFS or NFS (default) or CIFS ———— NAS

NFS for the NAS
dataset.
If CIFS is selected,
enter the username
and password of the
user that will mount
the NAS share on the
BDD and perform the
backup.

skipofflineappsincongrp Specifies how to no - Fail backup when snap, ConsistGrp

handle offline offline applications are directdedup,
applications in a found (default). dedup_async
consistency group. yes - Skip offline
applications during
backup.

| actifio.com | Actifio CLI Reference 453

 Policy Option Description Value Policy Type AppType

sqlbackuppath Defines a location for String ———— SqlServerWriter,

a temporary SQL VMBackup,
backup. If the Actifio Microsoft Hyper-V
Connector takes a full, VSS Writer,
native backup of the ConsistGrp
SQL Server database,
the backup will be
saved in this directory.
Ensure that there is
enough free space n
the volume hosting
this directory to hold a
full database backup.

stagingdiskgranularity If an application 1 to 128000 ———— Oracle,

requires multiple FileSystem,
staging disks, you can NFS,
keep a small portion of ConsistGrp
an application from
using a large staging
disk. Enter the largest
size of staging disks to
be used.

stagingdiskmountpoint Enter a staging disk String ———— Oracle,FileSystem,

mount point if you CIFS,
need the staging disk NFS,
mounted to a SharePoint Services
particular location Writer,
(Oracle, local SqlServerWriter,
filesystems, CIFS, Microsoft Exchange
NFS, SharePoint, SQL Writer,
Server, Exchange) ConsistGrp

stagingdiskoverheadalloc Staging vDisk desired 1 to 1000 ———— ————

ationpercentage size overhead
allocation percentage.
Used if the initial
staging disk is too
small to
accommodate the
data or if the amount
of data increases
beyond the staging
disk capacity.

454 Actifio CLI Reference | actifio.com |

Policy Option Description Value Policy Type AppType

stagingdisksize Staging vDisk size for 1 to 256000 ———— Oracle,FileSystem,

image copy backup (in CIFS,
GB). Enter a staging NFS,
disk size of 1.2 times SharePoint Services
the size of the Writer,
protected application. SqlServerWriter,
By default, the Actifio Microsoft Exchange
Connector uses the Writer,
size of the protected Microsoft Hyper-V
application as the size VSS Writer,
of the staging disk. ConsistGrp
This setting allows the
administrator to
override this value if
necessary, for
example to allow for
growth.

stagingdisksizeincr Enter a staging disk String ———— NAS

size of 1.2 times the
size of the protected
dataset. An initial size
for the staging disk
that will be used to
back up this
application. The Actifio
appliance will allocate
an initial disk (or
multiple disks if larger
than the system max
staging vDisk setting)
to equal this size. If
the space in this disk
is insufficient to
backup the NAS
Dataset, the staging
disk will be expanded
to accommodate the
backup.

startpaths Provides the start path String ———— FileSystem,

names. startpath CIFS,
specifies the directory NFS,
where backup starts. NAS
If startpath is left
blank, backup starts at
the root directory of
the dataset to be
backed-up. For
example, a value of
\\SERVERNAME\SHA
RENEAME\abc will
back up the abc
directory.

| actifio.com | Actifio CLI Reference 455

 Policy Option Description Value Policy Type AppType

streamingreplication Stream snapshot data yes - Stream snapshot stream_snap VMBackup

to the target Actifio data to the target Actifio
appliance in parallel to appliance (default)
data movement to the no - Do not stream
staging disks snapshot data to the
target Actifio appliance

tnsadmindir Specifies the String ———— Oracle,

TNS_ADMIN network ConsistGrp
path.

truncatelog Specifies whether to no - Do not truncate log snap, SqlServerWriter,

truncate the logs after after backup (default) directdedup, Microsoft Exchange
every backup. When yes - Truncate log after dedup_async Writer,
this is selected, backup SharePoint Services
application-related Writer,
logs are truncated VMBackup,
until the recent or Microsoft Hyper-V
current backup. The VSS Writer,
client cannot roll ConsistGrp
forward/back with logs
because SQL opens
the database in multi-
user mode.

useasm Specifies to use the false (default) or true ———— Oracle

ASM Diskgroup for
backup.

usegpfs Enables the GPFS true (default) or false ———— FileSystem,

staging disk for GPFS ConsistGrp
file system backup.

username Specifies the String ———— Oracle,

authentication user CIFS,
name as part of the SqlServerWriter
user credentials. VMBackup,
NAS,
Microsoft Hyper-V
VSS Writer,
ConsistGrp

userrole Database user sysdba - Role sysdba ———— Oracle,

account for Actifio (default) ConsistGrp
RMAN backup. By sysbackup - Role
default, userrole will sysbackup, applicable to
use sysdba. For 12c 12c
sysbackup role please
select the role using
sysbackup.

usezpool Use Zpool on the false (default) or true ———— NAS

proxy host.

456 Actifio CLI Reference | actifio.com |

Policy Option Description Value Policy Type AppType

wallet To backup any oracle String ———— Oracle,

configuration files with ConsistGrp
Oracle OOB backup
such as wallet for
encryption support.
This will need a full
path name. If the
folder name is
specified then all files
under that folder will
be backed up. If a file
name is specified then
only the specified file
will be backed up.

zfscompression Use ZFS compression off - Disable ZFS ———— NAS

on the proxy host. compression (default)
on - Enable ZFS
compression
lzjb - lzjb compression
algorithm
gzip - gzip compression
algorithm
zle - zle compression
algorithm
lz4 - lz4 compression
algorithm

zfsdedup Use in-line dedup on off - Disable in-line dedup ———— NAS
the proxy host. Enable (default)
in-line dedup for on - Enable in-line dedup
datasets where there
are large numbers of
duplicated blocks
among the files and
directories being
protected, so the
savings in storage
make up for the extra
processing required to
deduplicate.

| actifio.com | Actifio CLI Reference 457

458 Actifio CLI Reference | actifio.com |
F List of Restore Options

This appendix is a complete list of restore options that you can specify when using the following CLI commands:
• failover on page 200
• testfailover on page 235
• cloneimage on page 247
• prepmount on page 253
• mountimage on page 263
• restoreimage on page 276
• lsrestoreoptions on page 278
You specify these options using the -restoreoption keyword in these CLI commands.

Restore Option Description Value Restore AppType

Operation

asmracnodelist Colon separated list of String scrubmount, Oracle

ASM RAC node IP mount, clone,
addresses. failover,
failovertest

compressstreamsnap Use compression for true or false syncback ————

StreamSnap
replication.

enncryptstreamsnap Use encryption for true or false syncback ————

StreamSnap
replication.

Note: Only
disable the
enncryptstreams
nap restore
option under
strict guidance of
Actifio Support.

mapdiskstoallclusternodes Maps disks to all true or false scrubmount, ————

Actifio appliance mount, clone,
nodes failover,
failovertest

| actifio.com | Actifio CLI Reference 459

 Restore Option Description Value Restore AppType
Operation

mountdriveperimage Specify drive letter for String scrubmount, ————

the first mount mount, clone,
volume; consecutive failover,
free drive letters are failovertest
assigned for other
volumes

mountdriveperdisk Specifies the drive String scrubmount, ————

letter for a specific mount, clone,
volume. failover,
failovertest

mountpointperdisk Specifies a mount String scrubmount, ————

point for a specific mount, clone,
volume. failover,
failovertest

mountpointperimage Specifies the parent String scrubmount, ————

folder for all mount mount, clone,
points. failover,
failovertest

provisioningoptions Specifies a path to a String restore ————

app-aware mount
provisioning options.
provisioningoptions
indicates that this is
an app-aware mount,
regardless of the 
-appaware flag.
Use the udsinfo
lsappclass command
to retrieve the
supported appclass
and its associated
properties to include
as the defined
provisioning options.

recover Recovery option for String restore SQLServer

SQL Server to bring Writer
the database online.
The Actifio appliance
restores/copies mdf/
ldf files from the
backup image and
brings the SQL Server
database online. Once
the SQL Server
database is online,
Transaction logs can
not be applied to the
database.

460 Actifio CLI Reference | actifio.com |

Restore Option Description Value Restore AppType
Operation

reprotect Directive in the Boolean mount, ————

provisioning options mountstack
XML file to reprotect
the application.
Use the udsinfo
lsappclass command
to retrieve the
supported appclass
and its associated
properties to include
as the defined
provisioning options.

restoremacaddr Restore the MAC Boolean mount,clone, ————

address of the failover
network card.

slpid Specifies the SLP ID String mount, ————

to use for the mount mountstack
operation.

sltid Specifies the SLT ID String mount, ————

to use for the mount mountstack
operation.

vmdkprovisionformatperdisk Specifies the disk sourcevmdkformat - restore and VMBackup

provisioning format Use same data format clone
for a specific volume as the source vmdk.
thinprovisioned - Thin
provision format.
thickeagerzero
provisioned - Thick
provisioned eager zero
format.
thicklazyzero
provisioned - Thick
provisioned lazy zero
format.

vmdkprovisionformatperimage Specifies the disk sourcevmdkformat - restore and VMBackup

provisioning strategy Use same data format clone
for all volumes as the source vmdk.
thinprovisioned - Thin
provision format.
thickeagerzero
provisioned - Thick
provisioned eager zero
format.
thicklazyzero
provisioned - Thick
provisioned lazy zero
format.

| actifio.com | Actifio CLI Reference 461

 Restore Option Description Value Restore AppType
Operation

volgroupname Name of the volume String scrubmount, Oracle

group or storage pool mount, clone,
to be used for failover,
discovered disks. failovertest

462 Actifio CLI Reference | actifio.com |