EMC Data Domain Operating

System
Version 5.4

Command Reference Guide

300-119-222
REV. 06
Copyright 2009-2014 EMC Corporation. All rights reserved. Published in USA.

Published September, 2014

EMC believes the information in this publication is accurate as of its publication date. The information is subject to change
without notice.

The information in this publication is provided as is. EMC Corporation 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. Use, copying, and distribution of any EMC software described in this publication requires an applicable
software license.

EMC, EMC, and the EMC logo are registered trademarks or trademarks of EMC Corporation in the United States and other
countries. All other trademarks used herein are the property of their respective owners.

For the most up-to-date regulatory document for your product line, go to EMC Online Support (https://support.emc.com).

EMC Corporation
Hopkinton, Massachusetts 01748-9103
1-508-435-1000 In North America 1-866-464-7381
www.EMC.com

2 EMC Data Domain Operating System 5.4 Command Reference Guide

CONTENTS

Preface 13

Chapter 1 adminaccess 17
adminaccess Change History.........................................................................18
adminaccess Guidelines and Restrictions..................................................... 18
adminaccess add.......................................................................................... 18
adminaccess authentication......................................................................... 18
adminaccess certificate.................................................................................19
adminaccess del........................................................................................... 21
adminaccess disable.................................................................................... 21
adminaccess enable..................................................................................... 21
adminaccess ftp............................................................................................21
adminaccess ftps.......................................................................................... 22
adminaccess http..........................................................................................22
adminaccess reset........................................................................................ 22
adminaccess show........................................................................................23
adminaccess ssh.......................................................................................... 23
adminaccess telnet....................................................................................... 24
adminaccess trust.........................................................................................24
adminaccess web..........................................................................................24

Chapter 2 alerts 27
alerts Change History.................................................................................... 28
alerts Guidelines and Restrictions................................................................. 28
alerts clear.................................................................................................... 28
alerts notify-list............................................................................................. 28
alerts show................................................................................................... 30

Chapter 3 alias 31
alias Change History......................................................................................32
alias Guidelines and Restrictions.................................................................. 32
alias add....................................................................................................... 32
alias del........................................................................................................ 32
alias reset..................................................................................................... 32
alias show.....................................................................................................32

Chapter 4 archive 33
archive Change History..................................................................................34
archive Guidelines and Restrictions...............................................................34
archive data-movement.................................................................................34
archive disable..............................................................................................36
archive enable.............................................................................................. 36
archive option............................................................................................... 36
archive report................................................................................................36
archive show.................................................................................................37
archive space-reclamation............................................................................ 37

EMC Data Domain Operating System 5.4 Command Reference Guide 3

CONTENTS

Chapter 5 authentication 39
authentication Change History...................................................................... 40
authentication Guidelines and Restrictions................................................... 40
authentication nis......................................................................................... 40

Chapter 6 authorization 43
authorization Change History........................................................................ 44
authorization Guidelines and Restrictions..................................................... 44
authorization policy...................................................................................... 44
authorization show....................................................................................... 44

Chapter 7 autosupport 45
autosupport Change History.......................................................................... 46
autosupport Guidelines and Restrictions.......................................................46
autosupport add........................................................................................... 46
autosupport del............................................................................................ 46
autosupport reset..........................................................................................47
autosupport send..........................................................................................47
autosupport set.............................................................................................48
autosupport show......................................................................................... 48
autosupport test........................................................................................... 49

Chapter 8 cifs 51
cifs Change History........................................................................................52
cifs Guidelines and Restrictions.................................................................... 52
cifs add......................................................................................................... 52
cifs del.......................................................................................................... 52
cifs disable................................................................................................... 53
cifs enable.................................................................................................... 53
cifs hosts...................................................................................................... 53
cifs nb-lookup............................................................................................... 53
cifs option.....................................................................................................53
cifs reset....................................................................................................... 54
cifs set.......................................................................................................... 54
cifs share...................................................................................................... 55
cifs show.......................................................................................................56
cifs status..................................................................................................... 56
cifs troubleshooting...................................................................................... 56

Chapter 9 config 59
config Change History................................................................................... 60
config Guidelines and Restrictions................................................................ 60
config reset................................................................................................... 60
config set...................................................................................................... 60
config setup.................................................................................................. 61
config show...................................................................................................61

Chapter 10 ddboost 63
ddboost Change History................................................................................ 64
ddboost Guidelines and Restrictions............................................................. 64

4 EMC Data Domain Operating System 5.4 Command Reference Guide

 CONTENTS

ddboost access.............................................................................................64
ddboost association......................................................................................65
ddboost destroy............................................................................................ 65
ddboost disable............................................................................................ 65
ddboost enable.............................................................................................65
ddboost event...............................................................................................65
ddboost fc.....................................................................................................67
ddboost file-replication................................................................................. 69
ddboost ifgroup............................................................................................ 70
ddboost option............................................................................................. 71
ddboost reset................................................................................................71
ddboost set...................................................................................................72
ddboost show............................................................................................... 72
ddboost status..............................................................................................73
ddboost storage-unit.....................................................................................73

Chapter 11 disk 75
disk Change History...................................................................................... 76
disk Guidelines and Restrictions................................................................... 76
disk beacon.................................................................................................. 76
disk fail......................................................................................................... 76
disk multipath...............................................................................................76
disk port....................................................................................................... 77
disk rescan................................................................................................... 77
disk reset...................................................................................................... 77
disk set......................................................................................................... 77
disk show......................................................................................................77
disk status.................................................................................................... 80
disk unfail..................................................................................................... 81

Chapter 12 enclosure 83
enclosure Change History..............................................................................84
enclosure Guidelines and Restrictions...........................................................84
enclosure beacon..........................................................................................84
enclosure show............................................................................................. 84
enclosure test............................................................................................... 87

Chapter 13 filesys 89
filesys Change History................................................................................... 90
filesys Guidelines and Restrictions................................................................ 90
filesys archive............................................................................................... 90
filesys clean.................................................................................................. 90
filesys create.................................................................................................92
filesys destroy............................................................................................... 93
filesys disable............................................................................................... 93
filesys enable................................................................................................93
filesys encryption.......................................................................................... 93
filesys expand............................................................................................... 97
filesys fastcopy............................................................................................. 97
filesys option................................................................................................ 98
filesys restart.............................................................................................. 100
filesys show................................................................................................ 100
filesys status...............................................................................................103

EMC Data Domain Operating System 5.4 Command Reference Guide 5

CONTENTS

filesys sync................................................................................................. 103

Chapter 14 help 105

help Change History.................................................................................... 106
help Guidelines and Restrictions................................................................. 106

Chapter 15 ipmi 107

ipmi Change History.................................................................................... 108
ipmi Guidelines and Restrictions................................................................. 108
ipmi config.................................................................................................. 108
ipmi disable................................................................................................ 108
ipmi enable.................................................................................................108
ipmi remote................................................................................................ 108
ipmi reset....................................................................................................109
ipmi show................................................................................................... 109
ipmi user.....................................................................................................109

Chapter 16 license 111

license Change History................................................................................ 112
license Guidelines and Restrictions.............................................................112
license add................................................................................................. 112
license delete..............................................................................................112
license reset................................................................................................112
license show............................................................................................... 112

Chapter 17 log 113

log Change History...................................................................................... 114
log Guidelines and Restrictions................................................................... 114
log host.......................................................................................................114
log list.........................................................................................................114
log view.......................................................................................................116
log watch.................................................................................................... 116
log Additional Topics...................................................................................116
Understanding a Log Message....................................................... 116
Archiving Log Files......................................................................... 116

Chapter 18 migration 119

migration Change History............................................................................ 120
migration Guidelines and Restrictions......................................................... 120
migration abort........................................................................................... 120
migration commit........................................................................................ 121
migration receive........................................................................................ 121
migration send............................................................................................121
migration show stats...................................................................................123
migration status.......................................................................................... 123
migration watch.......................................................................................... 123
Examples.................................................................................................... 123
Preparing for Migration.................................................................. 123
Migrating Data (Does Not Apply to Replication Contexts)................ 124
Migrating Data and a Context......................................................... 124

6 EMC Data Domain Operating System 5.4 Command Reference Guide

 CONTENTS

Chapter 19 mtree 127

mtree Change History.................................................................................. 128
mtree Guidelines and Restrictions...............................................................128
mtree create................................................................................................128
mtree delete................................................................................................129
mtree list.....................................................................................................129
mtree rename..............................................................................................130
mtree retention-lock....................................................................................130
mtree show compression............................................................................ 132
mtree undelete............................................................................................133

Chapter 20 ndmpd 135

ndmpd Change History................................................................................136
ndmpd Guidelines and Restrictions.............................................................136
ndmpd disable............................................................................................136
ndmpd enable.............................................................................................136
ndmpd option............................................................................................. 136
ndmpd show............................................................................................... 136
ndmpd status..............................................................................................137
ndmpd stop................................................................................................ 137
ndmpd user................................................................................................ 137

Chapter 21 net 139

net Change History...................................................................................... 140
net Guidelines and Restrictions...................................................................140
net aggregate.............................................................................................. 140
net config....................................................................................................143
net congestion-check.................................................................................. 144
net create....................................................................................................147
net ddns..................................................................................................... 147
net destroy..................................................................................................148
net disable..................................................................................................148
net enable...................................................................................................148
net failover..................................................................................................148
net hosts.....................................................................................................150
net iperf ..................................................................................................... 150
net lookup...................................................................................................151
net option................................................................................................... 151
net ping...................................................................................................... 151
net reset......................................................................................................152
net set.........................................................................................................152
net show..................................................................................................... 153
net tcpdump............................................................................................... 154
net troubleshooting.....................................................................................154
net Additional Topics.................................................................................. 154
DD OS Linux Equivalent Arguments for tcpdump Option................. 154
Linux DD OS Equivalent Arguments for iperf Option........................ 155
More About Ethernet Failover......................................................... 155
Interface Naming Format................................................................ 156
Number of Physical Interfaces........................................................ 157
Number of Ports............................................................................. 157
Sample Failover Workflow.............................................................. 157
Sample Aggregation Workflow........................................................158

EMC Data Domain Operating System 5.4 Command Reference Guide 7

CONTENTS

Chapter 22 nfs 159

nfs Change History...................................................................................... 160
nfs Guidelines and Restrictions................................................................... 160
nfs add........................................................................................................160
nfs del.........................................................................................................161
nfs disable.................................................................................................. 161
nfs enable................................................................................................... 161
nfs reset......................................................................................................161
nfs show .................................................................................................... 161
nfs status.................................................................................................... 162

Chapter 23 ntp 163

ntp Change History......................................................................................164
ntp Guidelines and Restrictions...................................................................164
ntp add....................................................................................................... 164
ntp del........................................................................................................ 164
ntp disable..................................................................................................165
ntp enable.................................................................................................. 165
ntp reset..................................................................................................... 165
ntp show..................................................................................................... 165
ntp status....................................................................................................165

Chapter 24 quota 167

quota Change History.................................................................................. 168
quota Guidelines and Restrictions...............................................................168
quota disable..............................................................................................168
quota enable...............................................................................................168
quota reset..................................................................................................168
quota set.....................................................................................................169
quota show................................................................................................. 170
quota status................................................................................................170

Chapter 25 replication 171

replication Change History.......................................................................... 172
replication Guidelines and Restrictions....................................................... 172
replication abort..........................................................................................172
replication add............................................................................................172
replication break......................................................................................... 173
replication disable...................................................................................... 173
replication enable....................................................................................... 173
replication initialize.................................................................................... 173
replication modify....................................................................................... 174
replication option........................................................................................175
replication reauth........................................................................................175
replication recover...................................................................................... 175
replication resync .......................................................................................176
replication show......................................................................................... 176
replication status........................................................................................ 178
replication sync...........................................................................................179
replication throttle...................................................................................... 179
replication watch........................................................................................ 180

8 EMC Data Domain Operating System 5.4 Command Reference Guide

 CONTENTS

Chapter 26 route 181

route Change History...................................................................................182
route Guidelines and Restrictions................................................................182
route add.................................................................................................... 182
route del..................................................................................................... 182
route reset.................................................................................................. 183
route set..................................................................................................... 183
route show.................................................................................................. 183
route trace.................................................................................................. 183

Chapter 27 scsitarget 185

scsitarget Change History............................................................................186
scsitarget Guidelines and Restrictions.........................................................186
scsitarget device......................................................................................... 186
scsitarget disable........................................................................................186
scsitarget enable.........................................................................................187
scsitarget endpoint..................................................................................... 187
scsitarget group.......................................................................................... 188
scsitarget initiator....................................................................................... 189
scsitarget persistent-reservation................................................................. 190
scsitarget reset........................................................................................... 191
scsitarget service........................................................................................ 191
scsitarget show........................................................................................... 191
scsitarget status..........................................................................................191
scsitarget trace........................................................................................... 191
scsitarget transport..................................................................................... 192

Chapter 28 snapshot 195

snapshot Change History............................................................................ 196
snapshot Guidelines and Restrictions......................................................... 196
snapshot create.......................................................................................... 196
snapshot expire.......................................................................................... 197
snapshot list............................................................................................... 197
snapshot rename........................................................................................ 198
snapshot schedule......................................................................................198
snapshot Additional Topics......................................................................... 199
Naming Snapshots Created by a Schedule..................................... 199

Chapter 29 snmp 201

snmp Change History.................................................................................. 202
snmp Guidelines and Restrictions............................................................... 202
snmp add....................................................................................................202
snmp del.....................................................................................................203
snmp disable.............................................................................................. 204
snmp enable............................................................................................... 204
snmp reset.................................................................................................. 204
snmp set..................................................................................................... 204
snmp show................................................................................................. 204
snmp status................................................................................................ 205
snmp user................................................................................................... 205

EMC Data Domain Operating System 5.4 Command Reference Guide 9

CONTENTS

Chapter 30 storage 207

storage Change History............................................................................... 208
storage Guidelines and Restrictions............................................................ 208
storage add.................................................................................................208
storage remove........................................................................................... 208
storage show.............................................................................................. 209

Chapter 31 support 211

support Change History...............................................................................212
support Guidelines and Restrictions............................................................212
support bundle........................................................................................... 212
support notification.....................................................................................212

Chapter 32 system 213

system Change History................................................................................ 214
system Guidelines and Restrictions.............................................................214
system headswap....................................................................................... 214
system option............................................................................................. 214
system passphrase..................................................................................... 215
system poweroff..........................................................................................215
system reboot............................................................................................. 215
system retention-lock..................................................................................215
system sanitize........................................................................................... 216
system set...................................................................................................216
system show............................................................................................... 216
system status..............................................................................................223
system upgrade.......................................................................................... 223
Additional Topics for system....................................................................... 224
Configuring a System for Retention Lock Compliance..................... 224

Chapter 33 user 225

user Change History.................................................................................... 226
user Guidelines and Restrictions................................................................. 226
user add......................................................................................................226
user change................................................................................................ 226
user del.......................................................................................................227
user disable................................................................................................ 227
user enable................................................................................................. 227
user password.............................................................................................227
user reset....................................................................................................228
user show................................................................................................... 228

Chapter 34 vtl 231

vtl Change History....................................................................................... 233
vtl Guidelines and Restrictions.................................................................... 233
vtl add.........................................................................................................234
vtl cap......................................................................................................... 234
vtl debug.....................................................................................................234
vtl del..........................................................................................................235
vtl disable................................................................................................... 236
vtl drive.......................................................................................................236

10 EMC Data Domain Operating System 5.4 Command Reference Guide

 CONTENTS

vtl enable.................................................................................................... 237

vtl export.....................................................................................................237
vtl group......................................................................................................237
vtl import.................................................................................................... 239
vtl initiator.................................................................................................. 240
vtl option.................................................................................................... 241
vtl pool........................................................................................................242
vtl port........................................................................................................ 243
vtl readahead..............................................................................................246
vtl rename...................................................................................................246
vtl reset.......................................................................................................246
vtl show...................................................................................................... 246
vtl slot.........................................................................................................247
vtl status..................................................................................................... 248
vtl tape........................................................................................................248

EMC Data Domain Operating System 5.4 Command Reference Guide 11

CONTENTS

12 EMC Data Domain Operating System 5.4 Command Reference Guide

Preface

As part of an effort to improve its product lines, EMC periodically releases revisions of its
software and hardware. Therefore, some functions described in this document might not
be supported by all versions of the software or hardware currently in use. The product
release notes provide the most up-to-date information on product features.
Contact your EMC technical support professional if a product does not function properly
or does not function as described in this document.

Note

This document was accurate at publication time. Go to EMC Online Support (https://
support.emc.com) to ensure that you are using the latest version of this document.

Purpose
This guide describes the EMC Data Domain operating system (DD OS) commands and
provides an overview of how they are used. For more specific, task-based instructions,
see the EMC Data Domain Operating System Administration Guide.
Related documentation
The following Data Domain system documents provide additional information:
l Installation and setup guide for your system, for example, EMC Data Domain DD 2500
Storage System, Installation and Setup Guide
l EMC Data Domain Operating System USB Installation Guide
l EMC Data Domain Operating System DVD Installation Guide
l EMC Data Domain Operating System Release Notes
l EMC Data Domain Operating System Initial Configuration Guide
l EMC Data Domain Product Security Guide
l EMC Data Domain Operating System Administration Guide
l EMC Data Domain Operating System MIB Quick Reference
l EMC Data Domain Operating System Offline Diagnostics Suite User's Guide
l Hardware overview guide for your system, for example, EMC Data Domain DD4200,
DD4500, and DD7200 Systems, Hardware Overview
l Field replacement guides for your system components, for example, Field Replacement
Guide, Data Domain DD4200, DD4500, and DD7200 Systems, IO Module and
Management Module Replacement or Upgrade
l EMC Data Domain, System Controller Upgrade Guide
l EMC Data Domain Expansion Shelf, Hardware Guide (for shelf model ES20 or ES30)
l EMC Data Domain Boost for OpenStorage Administration Guide
l EMC Data Domain Boost for Oracle Recovery Manager Administration Guide
l EMC Data Domain Boost SDK Programmer's Guide
l Statement of Volatility for the Data Domain DD2500 System
l Statement of Volatility for the Data Domain DD4200, DD4500, or DD7200 System
Special notice conventions used in this document
EMC uses the following conventions for special notices:

EMC Data Domain Operating System 5.4 Command Reference Guide 13

Preface

DANGER

Indicates a hazardous situation which, if not avoided, will result in death or serious
injury.

WARNING

Indicates a hazardous situation which, if not avoided, could result in death or serious
injury.

CAUTION

Indicates a hazardous situation which, if not avoided, could result in minor or moderate
injury.

NOTICE

Addresses practices not related to personal injury.

Note

Presents information that is important, but not hazard-related.

Typographical conventions
EMC uses the following type style conventions in this document:

Table 1 Typography

Bold Use for names of interface elements, such as names of windows, dialog
boxes, buttons, fields, tab names, key names, and menu paths (what
the user specifically selects or clicks)

Italic Use for full titles of publications referenced in text

Monospace Use for:
l System code
l System output, such as an error message or script
l Pathnames, filenames, prompts, and syntax
l Commands and options

Monospace italic Use for variables

Monospace bold Use for user input

[] Square brackets enclose optional values

| Vertical bar indicates alternate selections - the bar means or

{} Braces enclose content that the user must specify, such as x or y or z

... Ellipses indicate nonessential information omitted from the example

Where to get help

EMC support, product, and licensing information can be obtained as follows:
Product information
For documentation, release notes, software updates, or information about EMC
products, go to EMC Online Support at https://support.emc.com.

14 EMC Data Domain Operating System 5.4 Command Reference Guide

 Preface

EMC Data Domain product documentation

To view documentation for EMC Data Domain products, go to EMC Online Support
and click Support by Product below the Search box. Type Data Domain in the Find a
Product box, wait for those words to appear in the list of matches below the box, and
click the words. Then click >>. In the list of categories under the Search box, click
Documentation.
l The Product choices let you filter results by Data Domain system model number,
such as DD990, or by DD OS software release.
l The Content Type choices let you filter results by category. Click More under
Content Type to see all of the categories. The categories that contain end-user
and compatibility documentation are:
n Manuals and Guides, for the software and hardware manuals for your system,
and for integration guides that explain how to use EMC Data Domain systems
with backup software and other products
n Release Notes, for specific versions of the EMC Data Domain Operating
System and EMC Data Domain products
n Compatibility Document, for guides that show which EMC and third-party
components are compatible

Technical support
Go to EMC Online Support and click Service Center. You will see several options for
contacting EMC Technical Support. Note that to open a service request, you must
have a valid support agreement. Contact your EMC sales representative for details
about obtaining a valid support agreement or with questions about your account.

Your comments
Your suggestions will help us continue to improve the accuracy, organization, and overall
quality of the user publications. Send your opinions of this document to:
mailto:[email protected].

EMC Data Domain Operating System 5.4 Command Reference Guide 15

Preface

16 EMC Data Domain Operating System 5.4 Command Reference Guide

CHAPTER 1
adminaccess

The adminaccess command manages access control and enables users to import host
and CA certificates. Command options also enable remote hosts to use the FTP, FTPS,
Telnet, HTTP, HTTPS, SSH, and SCP administrative protocols on the Data Domain system.
SSH is open to the default user sysadmin and to users added by the administrator.
A Certificate Signing Request (CSR) can now be generated for a host certificate. Also, host
certificates can now be imported in PKCS12 or PEM formats. EMC Data Domain uses the
SHA1 RSA encryption algorithm for a CSR and PBE-SHA1-3DES encryption algorithm for
the PKCS12 key and certificate.
This chapter contains the following topics:

l adminaccess Change History.................................................................................18

l adminaccess Guidelines and Restrictions............................................................. 18
l adminaccess add.................................................................................................. 18
l adminaccess authentication................................................................................. 18
l adminaccess certificate.........................................................................................19
l adminaccess del................................................................................................... 21
l adminaccess disable.............................................................................................21
l adminaccess enable............................................................................................. 21
l adminaccess ftp....................................................................................................21
l adminaccess ftps.................................................................................................. 22
l adminaccess http..................................................................................................22
l adminaccess reset................................................................................................ 22
l adminaccess show................................................................................................23
l adminaccess ssh...................................................................................................23
l adminaccess telnet............................................................................................... 24
l adminaccess trust.................................................................................................24
l adminaccess web..................................................................................................24

adminaccess 17
adminaccess

adminaccess Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 2 adminaccess Change History

Version Change
5.4 No changes from previous version.

adminaccess Guidelines and Restrictions

l Unless otherwise noted, command options are available only to users with admin
role permissions.
l FTP and FTPS are mutually exclusive. Only one or the other can be enabled, not both.
l SCP can be enabled only when SSH is enabled.
l FTP and Telnet are disabled by default.

adminaccess add
adminaccess add ssh-keys [user username]
Add an SSH public key created on a UNIX-based remote machine to the SSH authorized
keys file on the Data Domain system.

adminaccess authentication
adminaccess authentication add {cifs}
Allow Windows domain users with no local account on the Data Domain system to access
the system through SSH, Telnet, and FTP using Windows domain group credentials. For
administrative access, the user must be in the standard Windows Domain Admins group
or in a group that you create named Data Domain. Users from both group names are
always accepted as administrative users. The command also gives user-level access (no
administrative operations allowed) to all other users from the domain. Users must be
from the domain that includes the Data Domain system or a related, trusted domain.
The SSH, Telnet, or FTP command that accesses the Data Domain system must include
the domain name, a backslash, and the user name in double quotation marks.

Note

CIFS must be enabled and the Data Domain system must be part of a Windows domain.
adminaccess authentication del {cifs}
Prevent authentication of a Windows domain. Allow admin role only for users with local
user accounts on the Data Domain system.
adminaccess authentication reset {cifs}
Reset the Windows user access to the default of requiring a local account for
administrative access to the Data Domain system.

18 EMC Data Domain Operating System 5.4 Command Reference Guide

 adminaccess

adminaccess authentication show

Display settings that enable a Windows administrative user to access a Data Domain
system when no local account exists. With the exception of users with data-access
permissions only, all users may run this command option.

adminaccess certificate
adminaccess certificate delete {imported-host | imported-ca |
support-bundle-ca | subject subject-name | fingerprint
fingerprint}
Delete a user imported host, trusted CA certificate, support bundle server CA certificate
(used to upload a support bundle securely), subject, or fingerprint of the imported host or
trusted CA certificate.
Because a single imported host or trusted CA certificate is maintained for HTTPS and key-
manager, you may use the arguments imported-host or imported-ca for deleting those
certificates. Arguments for subject and fingerprint may also be used.

Note

Log out from the browser session before deleting a host certificate. Otherwise HTTPS
browser sessions (using imported host certificates) will be closed. After deleting the host
certificate, refresh or restart the browser to proceed.
adminaccess certificate generate cert-signing-request [key-
strength {1024bit | 2048bit | 4096bit}] [country country-code]
[state state] [city city] [org-name organization-name] [org-
unit organization-unit] [common-name common-name]
Generates a Certificate Signing Request (CSR) under the directory /ddvar/
certificates/CertificateSigningRequest.csr. Users may retrieve the CSR
from the system using SCP, FTP or FTPS. After a CSR is signed by a CA, the public host
certificate can be imported in PEM format.
When prompted, users may choose to regenerate the CSR if a previously generated CSR
exists and the corresponding public host certificate is not imported. After the public host
certificate is imported the CSR is deleted from the system.
If the user does not specify values, default values are used.

Example 1

# adminaccess certificate generate cert-signing-request

Certificate signing request (CSR) successfully generated at /ddvar/
certificates/CertificateSigningRequest.csr
With following parameters:
Key Strength: 2048 bit
Country: US
State: California
City: Santa Clara
Organization Name: My Company Ltd
Organization Unit:
Common Name: <system host name>

Argument Definitions
key strength
Enumeration values allowed are 1024 bit, 2048 bit, or 4096 bit. Default is 2048 bit.

adminaccess certificate 19
adminaccess

country
Default is US. Abbreviation for country cannot exceed two characters. No special
characters are allowed.
state
Default is California. Maximum entry is 128 characters.
city
Default is Santa Clara. Maximum entry is 128 characters.
org-name
Default is My Company Ltd. Maximum entry is 64 characters.
org-unit
Default value is empty string. Maximum entry is 64 characters.
common name
Default value is system host name. Maximum entry is 64 characters.

adminaccess certificate import {host | ca} [file file-name]

Copy the host or CA certificate under the directory /ddvar/certificates using SCP,
FTP, or FTPS and run the import command specifying the certificate filename. Optionally,
users may copy and paste the entire PEM file of the host certificate, and then run the
import command without specifying the certificate filename. An error is generated if users
mistakenly import a mismatched certificate; for example, importing a host certificate as a
CA certificate, or vice versa.
Only one CA certificate or one host certificate may be imported. Importing an RKM auto-
registered certificate directly, or bulk importing multiple certificates is not supported.
l Users must provide the PKCS12 file and password to decrypt the PKCS12 file.
l CA certificates must be imported in PEM format.
When the system passphrase is changed, the imported host PKCS12 certificate, if present
on Data Domain system, is reencrypted using the new system passphrase.
When importing or deleting certificates on an encrypted Data Domain system on which
the system passphrase is set, the imported host PKCS12 certificate is reencrypted with
the system passphrase. If the system passphrase is not set, an error is generated during
the import.
Only one imported host certificate can be used for the HTTPS (server) and key manager
(client). The correct server or client extensions must also be set. See the sections Basic
Constraints, Key Usage, and Extended Key Usage in RFC 5280 for details (http://
www.ietf.org/rfc/rfc5280.txt). Extensions are provided for host certificates during the
certificate signing process.

Note

If the certificates are used by System Manager (server extension), running this command
closes the current browser session. Log out of the session prior to running this command.

Example 2

On the local system, enter:

# scp host.p12 <administrator_role>@<DD>:/ddvar/certificates

On the Data Domain system, enter:

# adminaccess certificate import host file host.p12

20 EMC Data Domain Operating System 5.4 Command Reference Guide

 adminaccess

Example 2 (continued)

adminaccess certificate show [detailed] [host | imported-host |

ca | imported-ca | support-bundle-ca | cert-signing-request]
Display certificates for the imported host, CA, imported CA, support bundle server trusted
CA or Certificate Signing Request (CSR). All users may run this command option.

Example 3 (CSR)

# adminaccess certificate show detailed cert-signing-request

Type: cert-signing-request
File path: /ddvar/certificates/CertificateSigningRequest.csr
Key Strength: 2048 bits
Country: US
State: California
City: Santa Clara
Organization Name: My Company Ltd
Organization Unit:
Common Name: system host name

adminaccess del
adminaccess del ssh-keys lineno [user username]
Delete an SSH key from the key file. Users may delete their own keys, and users in admin
role may delete user keys. Run the command option adminaccess show ssh-keys to view
line number values.

adminaccess disable
adminaccess disable {http | https | ftp | ftps | telnet | ssh |
scp | all}
Disable administrative access on the Data Domain system. Disabling FTP or Telnet does
not affect entries in the access lists. If all access is disabled, the Data Domain system is
available only through a serial console or keyboard and monitor.

adminaccess enable
adminaccess enable {http | https | ftp | ftps | telnet | ssh |
scp | all}
Enable a protocol on the Data Domain system. By default, the SSH, HTTP, and HTTPS
services are enabled and FTP and Telnet are disabled. HTTP and HTTPS allow users to log
in from System Manager. To use FTP and Telnet, users with admin role permissions must
add host machines to the access lists.

adminaccess ftp
adminaccess ftp add host-list
Add one or more hosts to the FTP list. Host names cannot include a space. Multiple
entries may be separated by commas, spaces, or both.
adminaccess ftp del host-list

adminaccess del 21
adminaccess

Remove one or more hosts (IP addresses, hostnames, or asterisks) from the FTP list.
Multiple entries may be separated by commas, spaces, or both.
adminaccess ftp option reset [session-timeout]
Reset the FTP options to default values.
adminaccess ftp option set session-timeout timeout-in-secs
Set the FTP client session timeout.
adminaccess ftp option show
Show the current FTP options.

adminaccess ftps
adminaccess ftps add host-list
Add one or more hosts to the FTPS list. Multiple entries may be separated by commas,
spaces, or both.
adminaccess ftps del host-list
Remove one or more hosts (IP addresses, hostnames, or asterisk) from the FTPS list. Host
entries may be separated by commas, spaces, or both.
adminaccess ftps option reset [session-timeout]
Resets the FTPS options to default values.
adminaccess ftps option set session-timeout timeout-in-secs
Sets the FTPS client session timeout.
adminaccess ftps option show
Shows the current FTPS options.

adminaccess http
adminaccess http add host-list
Add one or more hosts to the HTTP/HTTPS list. Host entries may be separated by
commas, spaces, or both.
adminaccess http del host-list
Remove one or more hosts (IP addresses, hostnames, or asterisk) from the HTTP/HTTPS
list. Host entries may be separated by commas, spaces, or both.

adminaccess reset
adminaccess reset {http | https | ftp | ftps | telnet | ssh |
scp | all}
Reset one or more protocols to their default states and clear the access lists of host
entries. Output shows the running state of each protocol.

Note

Because SCP works together with SSH, output appears the same for both. However, due
to the registry configuration, output could be misleading. For example, if SSH is disabled,
SCP also shows as disabled; however, SCP is enabled at the registry level. This is
expected behavior and does not affect functionality. When a user resets SCP, the SCP
registry entry changes to enabled and output for SSH shows as enabled.
adminaccess reset ssh-keys [user username]

22 EMC Data Domain Operating System 5.4 Command Reference Guide

 adminaccess

Remove the authorized SSH keys file for a user specified user or for the operator account
from the Data Domain system. After removing the file, every SSH connection requires
password authentication.
l Users may reset their own keys only.
l Users with admin role permissions may reset the keys of any user.
l Users with security role or data access permissions may not reset keys.

adminaccess show
adminaccess show
List the access services available on a Data Domain system and display option values for
the access services that are enabled. With the exception of users with data-access
permissions only, all users may run this command option.
l N/A means the service does not use an access list.
l A hyphen means the service can use an access list, but the access list does not
contain host names.
l An asterisk means the service allows all hosts.
adminaccess show ssh-keys [user username]
Display the authorized SSH key file with a line number for each entry. Users with admin
role permissions can view the SSH key files of any user. Users in other roles can view
their own SSH key file only.

adminaccess ssh
adminaccess ssh add host-list
Add one or more hosts to the SSH list. Host entries may be separated by commas,
spaces, or both.
adminaccess ssh del host-list
Remove one or more hosts (IP addresses, hostnames, or asterisks) from the SSH list.
Host entries may be separated by commas, spaces, or both.
adminaccess ssh option reset [server-port | session-timeout]
Reset the SSH options to default values.
adminaccess ssh option set server-port port-number
Set the SSH server port.
adminaccess ssh option set session-timeout timeout-in-secs
Set the SSH client timeout options.

Example 4

Set the SSH session timeout period to 10 minutes:

# adminaccess ssh option set session-timeout 600

adminaccess ssh option show

Display the SSH options.

adminaccess show 23
adminaccess

adminaccess telnet
adminaccess telnet add host-list
Add one or more hosts to the Telnet list. Host entries may be separated by commas,
spaces, or both.
adminaccess telnet delete host-list
Remove one or more hosts (IP addresses, hostnames, or asterisk) from the Telnet list.
Host entries may be separated by commas, spaces, or both.
adminaccess telnet option reset [session-timeout]
Reset the client session timeout period to the default value none to prevent client
sessions from timing out.
adminaccess telnet option set session-timeout timeout-in-secs
Set the client session timeout period to the specified number of seconds. If no data is
received from a Telnet client within the timeout period, and if the client does not respond
to a subsequent prompt message, the session terminates. The valid range is from 60 to
31536000 (365 days).
To configure the Data Domain system to prevent sessions from timing out, use the
adminaccess telnet option reset command option.

Example 5

To set the SSH session timeout period to 10 minutes:

# adminaccess telnet option set session-timeout 600

adminaccess telnet option show

Display the Telnet options.

adminaccess trust
adminaccess trust add host hostname [type mutual]
Establishes the (mutual) trust with the specified host.
adminaccess trust copy {source | destination} hostname
Copy all trust to or from the specified host.
adminaccess trust del host hostname [type mutual]
Remove the mutual trust from the specified host.
adminaccess trust show [hostname]
Show the list of trusted Certificate Authorities (CAs). All users may run this command
option.

adminaccess web
adminaccess web option reset [http-port | https-port | session
timeout]
Reset the Web options to default values.
adminaccess web option set http-port port-number
Set the HTTP access port for the Web client. Default is port 80.

24 EMC Data Domain Operating System 5.4 Command Reference Guide

 adminaccess

adminaccess web option set https-port port-number

Set the HTTPS access port for the Web client. Default is port 443.
adminaccess web option set session-timeout timeout-in-secs
Set the Web client session timeout. Default is 10800 seconds.
adminaccess web option show
Show the current values for Web options.

adminaccess web 25
adminaccess

26 EMC Data Domain Operating System 5.4 Command Reference Guide

CHAPTER 2
alerts

The alerts command manages current alerts, alert notification groups, and alerts
history. When a user logs in, a message is shown indicating the presence of alerts and
instructions on how to proceed.
Command options enable sending email to a designated recipient or notification group
when an event occurs within the Data Domain system. Depending on the option,
information includes alert type, date posted, and resulting action. More than three
months of alert history is retained.
The default alert notification group (default) is configured to send alerts for any event
class with severity level of Warning or above. Email notifications are sent to Data Domain
Support at [email protected]. The default alert
notification group can only be reset to default values: it cannot be destroyed.
Some event types, such as those in the environment class that pertain to temperature
sensors within the chassis, are detected repeatedly if the underlying condition is not
corrected.
This chapter contains the following topics:

l alerts Change History............................................................................................ 28

l alerts Guidelines and Restrictions......................................................................... 28
l alerts clear............................................................................................................ 28
l alerts notify-list..................................................................................................... 28
l alerts show........................................................................................................... 30

alerts 27
alerts

alerts Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 3 alerts Change History

Version Change
5.4 No changes from previous version.

alerts Guidelines and Restrictions

Unless otherwise noted, command options are available only to users with admin role
permissions.

alerts clear
alerts clear alert-id alert-id-list
Clear an active alert or list of alerts.
Command Options
alert-id-list
List of alert identification numbers.

alerts notify-list
alerts notify-list add group-name { [class class-list [severity
severity]] [emails email-addr-list] }
Modify a notification group by adding an event class, severity level, or recipient email
address.

Example 6

# alerts notify-list add eng_lab emails [email protected],

[email protected]

alerts notify-list create group-name class class-list [severity

severity]
Create an alert notification group.

Example 7

# alerts notify-list create eng_grp class hardwareFailure

alerts notify-list del group-name { [class class-list] [emails

email-addr-list]}
Modify an alert notification group by deleting event classes, email recipients, or both.

28 EMC Data Domain Operating System 5.4 Command Reference Guide

 alerts

Security officer authorization is required only if the group-name has a severity level of
Warning or above and the command is run on a Retention Lock Compliance system. See
the EMC Data Domain Operating System Administration Guide for details on alerts.

Example 8

# alerts notify-list del eng_grp class hardwareFailure

alerts notify-list destroy group-name

Delete an alert notification group. Note that the default alert notification group cannot be
destroyed.
Security officer authorization is required only if the group-name has a severity level of
Warning or above and the command is run on a Retention Lock Compliance system. See
the EMC Data Domain Operating System Administration Guide for details on alerts.
alerts notify-list reset
Remove all user-created alert notification groups and restore the default notification
group email list to [email protected].
Security officer authorization is required for systems with Retention Lock Compliance.
alerts notify-list show [group group-name | email email-addr]
Display all alert notification groups, a specific alert notification group, or alert notification
groups that subscribe to a single email address.

Example 9

# alerts notify-list show eng_lab [email protected]

alerts notify-list test {group group-name | email email-addr}

Send a test notification to an alert notification group or email address.

Example 10

# alerts notify-list test [email protected]

Command Option Arguments

class class-list
(Optional) List of event classes: cifs, storage, cluster, network, security,
filesystem, environment, replication, hardwareFailure,
systemMaintenance, and syslog.
emails email-addr-list
(Optional) Email addresses of members in an alert notification group.
group-name
Name of alert notification group.
severity severity
(Optional) Severity level of event class: emergency, alert, critical, error,
warning, notice, info, and debug. Default is warning.

alerts notify-list 29
alerts

alerts show
alerts show all [local]
Display details on all alert notification groups.
alerts show current [local]
Display information about current alerts.
alerts show current-detailed [local] [alert-id alert-id-list]
Display details on all current alerts or on a specific current alert. Output includes event
information and an Additional Information field.
alerts show daily [local]
Display daily alert report, including current alerts and 24-hour alert history.
alerts show history [local] [last n {hours | days | weeks |
months}] [start MMDDhhmm [[CC]YY] end MMDDhhmm [[CC]YY]]
Display alert history.
alerts show history-detailed [local] [last n {hours | days |
weeks | months}] [start MMDDhhmm [[CC]YY] end MMDDhhmm
[[CC]YY]]
Display details of alert history.
Command Option Arguments
alert-id-list
List of alert identification numbers.
last n {hours | days | weeks | months}
Use with show option to display alerts for most recent number of n (hours, days,
weeks, months).

30 EMC Data Domain Operating System 5.4 Command Reference Guide

CHAPTER 3
alias

The alias command creates, deletes, and displays command aliases for the Data
Domain system command set. Users can administer aliases only for commands for which
they have permission.
This chapter contains the following topics:

l alias Change History..............................................................................................32

l alias Guidelines and Restrictions.......................................................................... 32
l alias add............................................................................................................... 32
l alias del................................................................................................................ 32
l alias reset............................................................................................................. 32
l alias show.............................................................................................................32

alias 31
alias

alias Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 4 alias Change History

Version Change
5.4 No changes from previous version.

alias Guidelines and Restrictions

l All users may run this command.
l A new alias is available only to the user who created it on the Data Domain system.

alias add
alias add alias-name "command"
Add a command alias. Enter the alias name and command, and enclose the command
name in quotation marks. The new alias is available only to the user who created it.

alias del
alias del alias-name
Delete an alias by name.

alias reset
alias reset
Remove user-created aliases and restore defaults.

alias show
alias show
Display all aliases and command definitions.

32 EMC Data Domain Operating System 5.4 Command Reference Guide

CHAPTER 4
archive

The archive command is used only on systems licensed to run the EMC Data Domain
Extended Retention software option (formerly Data Domain Archiver). Extended Retention
command options enable the feature and configure policies. See the EMC Data Domain
Operating System Administration Guide for details on functionality, installation, and
configuration.
This chapter contains the following topics:

l archive Change History..........................................................................................34

l archive Guidelines and Restrictions.......................................................................34
l archive data-movement.........................................................................................34
l archive disable......................................................................................................36
l archive enable...................................................................................................... 36
l archive option....................................................................................................... 36
l archive report........................................................................................................36
l archive show......................................................................................................... 37
l archive space-reclamation.................................................................................... 37

archive 33
archive

archive Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 5 archive Change History

Version Change
5.4 No changes from previous version.

5.4.1.0 New command options:

archive data-movement schedule set on page 35

archive Guidelines and Restrictions

l Unless otherwise noted, command options are available only to users with admin
role permissions.
l Supported configurations:
n Controllers: DD860, DD990, DD4200, DD4500, DD7200.
n Storage expansion: EMC Data Domain ES20 expansion shelf and EMC Data
Domain ES30 expansion shelf. A system may contain a mix of Data Domain ES20
and ES30 shelves; however, each shelf chain must contain ES20 shelves only or
ES30 shelves only. Shelves within a chain cannot be mixed.

archive data-movement
archive data-movement policy reset age-threshold mtrees mtree-
list
Reset the age threshold for specified MTrees. Files modified only in the past (beyond the
age threshold) are moved to the retention tier during the next data movement. Role
required: admin.
archive data-movement policy reset default-age-threshold
Reset the age threshold to the default value of none. The default age threshold applies to
new MTrees and to MTrees for which the age threshold has not been set. Role required:
admin.
archive data-movement policy set age-threshold {days | none}
mtrees mtree-list
Set the age threshold for specified MTrees. Default is none. Role required: admin.
archive data-movement policy set default-age-threshold {days |
none}
Set the default age threshold. Role required: admin.
Argument Definitions
days
A number from 0 to 18250 (50 years). The number 0 means migrate when data
movement runs.

34 EMC Data Domain Operating System 5.4 Command Reference Guide

 archive

none
Never migrate. This is the default for the argument default-age-threshold.

archive data-movement policy show [mtrees mtree-list]

View the data-movement policy for the specified MTrees. Role required: admin.
archive data-movement schedule reset
Reset the data-movement schedule to default values. Role required: admin.
archive data-movement schedule set {never | days days time time
[every 2wks]} [no-clean]
Set the schedule for data movement. Unless you specify no-clean, the file system is
cleaned after data movement is completed. Note that the days argument checks two
ranges:
l Weekday (Monday-Sunday)
l Day of the month (1-31, regardless of month, plus last and first)
Any value outside of the two ranges generates an error message. Role required: admin.

Note

For days, last is converted to the value 31. If a schedule is set for the 31st of every
month at 10:00 PM, it is not executed on months with fewer than 31 days. This is a
known issue.

Example 11

To schedule data movement to occur each Tuesday at 6:00 a.m., enter:

# archive data-movement schedule set days "tue" time "06:00"

Example 12

To schedule data movement to occur on alternate Tuesdays at 6:00 a.m., enter:

# archive data-movement schedule set days "tue" time "06:00" every

2wks

archive data-movement schedule show

Display the data-movement schedule. Role required: With the exception of users
assigned to the none management role, all users may run this command option.
archive data-movement start
Start data movement from the active tier to the retention tier. All files that satisfy the age-
threshold value are moved to the retention tier. Data movement comprises five phases:
seeding, scanning, verifying, packing, and installing. Role required: admin.
archive data-movement status
Display immediate, one-time view of output from the archive data-movement start
command. Output shows the point at which data movement has progressed as of the
time the command is issued. Role required: With the exception of users assigned to the
none management role, all users may run this command option.
archive data-movement stop
Stop data movement to the retention tier. Role required: admin.
archive data-movement watch
View data movement progress while the operation is running. If the operation has
completed or is not running, output shows current status only. Role required: With the

archive data-movement 35
archive

exception of users assigned to the none management role, all users may run this
command option.

archive disable
archive disable
Disable the Extended Retention software option. Note that the file system must be
destroyed (and all data lost) before Extended Retention can be disabled. Role required:
admin.

archive enable
archive enable
Enable the Extended Retention software option. The file system must be disabled before
Extended Retention can be enabled. Required role: admin.

Note

Mtree replication from a system with Extended Retention to a system without Extended
Retention is supported for recovering previously replicated data only. Attempts to use
this feature for purposes other than recovery generates a warning message. See the EMC
Data Domain Operating System Administration Guide for details.

archive option
archive option reset local-compression-type
Reset the local compression algorithm to default value gz for subsequent data movement
to the retention tier. You must restart the file system for the change to take effect. Role
required: admin.
archive option set local-compression-type {none | lz | gzfast |
gz}
Set the local compression algorithm for subsequent data movement to the retention tier.
You must restart the file system for the change to take effect. Role required: admin.
archive option show [local-compression-type | data-movement-
packing]
Display the local compression algorithm for the retention tier or the progress of the file
migration process. Role required: With the exception of users assigned to the none
management role, all users may run this command option.

archive report
archive report generate file-location filename
Create a report showing the name and location of each file in the file system. If the
filename argument is specified, the report is saved under the fixed directory/ddr/var and
a message notifies the user that the file was created. If the argument is not specified, the
report is displayed in the standard output. The command returns before the entire report
is generated, and a footer indicates that the report is complete. Each line in the report
contains a file name and its location. The location is "Active" for an active tier or a
retention unit name. An asterisk is appended to the line if the file contents span the
active tier and retention unit. Required role: admin.

36 EMC Data Domain Operating System 5.4 Command Reference Guide

 archive

archive show
archive show config
Display the Extended Retention configuration. Role required: With the exception of users
assigned to the none management role, all users may run this command option.

Example 13

# archive show config

Enabled Yes
Data movement Schedule No schedule
Default age threshold data movement policy 0 days
Run filesys clean after archive data movement Yes
Retention Tier local compression gz
Packing data during archive data movement enabled
Space Reclamation disabled

archive space-reclamation
archive space-reclamation resume
Resumes the archive tier space reclamation process. Role required: admin.
archive space-reclamation start
Starts the archive tier space reclamation process. The space reclamation process runs
continuously until stopped or suspended explicitly, or preempted internally by a higher-
priority process such as archive data-movement or file system cleaning. Role required:
admin.
archive space-reclamation status
Shows the status of the archive tier space reclamation process. Role required: admin.

Example 14

# archive space-reclamation status

Space-reclamation was started on March 9 2013 10:25 and is currently
running.

archive space-reclamation status-detailed

Shows the detailed status of the archive tier space reclamation process. Role required:
admin.
archive space-reclamation stop
Stops the archive tier space reclamation process. Role required: admin.
archive space-reclamation suspend
Suspends the archive tier space reclamation process. Role required: admin.

archive show 37
archive

38 EMC Data Domain Operating System 5.4 Command Reference Guide

CHAPTER 5
authentication

The authentication command manages NIS users, domains, groups and servers.
Command options enable the Data Domain system to participate in an active Network
Information Service (NIS) domain, which maintains a centralized repository of users,
groups, and server names. NIS adds a global directory that authenticates users from any
host on the network.
This chapter contains the following topics:

l authentication Change History.............................................................................. 40

l authentication Guidelines and Restrictions........................................................... 40
l authentication nis................................................................................................. 40

authentication 39
authentication

authentication Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding DD OS version for details on
modifications, including arguments, output, and permissions.

Table 6 authentication Change History

Version Change
5.4 No changes from previous version.

authentication Guidelines and Restrictions

Unless otherwise noted, command options are available only to users with admin role
permissions.

authentication nis
authentication nis disable
Disable the NIS client. Role required: admin.
authentication nis domain reset
Reset the NIS domain name. Role required: admin.
authentication nis domain set domain [servers server-list]
Set the NIS domain name and optionally add NIS servers to the server-list. Role required:
admin.
authentication nis domain show
Display the NIS domain name. Role required: admin, security, user, backup-operator, or
none.
authentication nis enable
Enable the NIS client. Role required: admin.
authentication nis groups add group-list role {user | admin |
backup-operator}
Add a role-based access control (RBAC) role for NIS users in the group-list. See the EMC
Data Domain Operating System Administration Guide for role definitions. Role required:
admin.
authentication nis groups del group-list role {user | admin |
backup-operator}
Delete a role-based access control (RBAC) role for NIS users in the group-list. See the EMC
Data Domain Operating System Administration Guide for role definitions. Role required:
admin.
authentication nis groups reset
Delete all added NIS groups. Role required: admin.
authentication nis groups show
Display lists of NIS user groups and NIS admin groups. Role required: admin, security,
user, backup-operator, or none.
authentication nis reset

40 EMC Data Domain Operating System 5.4 Command Reference Guide

 authentication

Delete the NIS configuration and set it to the default. Role required: admin.
authentication nis servers add server-list
Add NIS servers to the server-list. Role required: admin.
authentication nis servers del server-list
Delete NIS servers from the server-list. Role required: admin.
authentication nis servers reset
Reset the NIS servers to their default settings. Role required: admin.
authentication nis servers show
Display a list of NIS servers. Role required: admin, security, user, backup-operator, or
none.
authentication nis show
Display the NIS configuration. Role required: admin, security, user, backup-operator, or
none.
authentication nis status
Display the NIS status. Role required: admin, security, user, backup-operator, or none.

authentication nis 41
authentication

42 EMC Data Domain Operating System 5.4 Command Reference Guide

CHAPTER 6
authorization

The authorization command, which is available only to security officers, establishes

or modifies runtime authorization policy. Command options enable security-based
functions such as managing filesystem encryption and enabling or disabling
authorization policy.
All authorization tasks are logged automatically. The log file includes a timestamp, the
identities of the security officer and administrative user, and the Data Domain system on
which the task was performed. This log file serves as the audit trail, or authorization
history, for each action.
This chapter contains the following topics:

l authorization Change History................................................................................ 44

l authorization Guidelines and Restrictions............................................................. 44
l authorization policy.............................................................................................. 44
l authorization show............................................................................................... 44

authorization 43
authorization

authorization Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 7 authorization Change History

Version Change
5.4 No changes from previous version.

authorization Guidelines and Restrictions

l Only the sysadmin user (the default user created after the DD OS installation) can
create the first security role, after which the privilege to create security officers is
removed from the sysadmin role.
l Only security officers can create other security officers.
l Separation of privilege and duty apply. Users in the role of admin cannot perform
security officer tasks, and vice versa.
l Procedures requiring authorization must be dual-authenticated by the security officer
and the user in the admin role. For example, to set encryption, the admin enables the
feature and the security officer enables runtime authorization.

authorization policy
authorization policy reset security-officer
Reset runtime authorization policy to defaults. Resetting authorization policy is not
allowed on Retention Lock Compliance systems.
authorization policy set security-officer {enabled | disabled}
Enable and disable runtime authorization policy. Disabling authorization policy is not
allowed on Retention Lock Compliance systems.

authorization show
authorization show history [last <n> { hours | days | weeks }]
View or audit past authorizations according to the interval specified.

44 EMC Data Domain Operating System 5.4 Command Reference Guide

CHAPTER 7
autosupport

The autosupport command manages system reports. Command options enable

administrative users to manage two reports that describe the state of a Data Domain
system: the autosupport report and the daily alert summary. By default, both reports
are emailed to the Support address only, but users with admin role permissions may
configure additional addresses and designate a subject tag keyword to bypass filtering
that may block email delivery. For details on configuring autosupport notifications,
see the EMC Data Domain Initial Configuration Guide.
This chapter contains the following topics:

l autosupport Change History.................................................................................. 46

l autosupport Guidelines and Restrictions...............................................................46
l autosupport add................................................................................................... 46
l autosupport del.................................................................................................... 46
l autosupport reset..................................................................................................47
l autosupport send..................................................................................................47
l autosupport set.....................................................................................................48
l autosupport show................................................................................................. 48
l autosupport test................................................................................................... 49

autosupport 45
autosupport

autosupport Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 8 autosupport Change History

Version Change
5.4 New command options:

autosupport reset subject-tag on page 47

autosupport set subject-tag tag on page 48

autosupport show subject-tag on page 49

Modified command options:

autosupport reset all on page 47

autosupport show { all | alert-summary | asup-detailed } on page 48

autosupport Guidelines and Restrictions

l Unless otherwise noted, command options are available only to users with admin
role permissions. User role may view address lists only.
l Use the up and down arrow keys to move through the log. Use the q key to exit. Enter
a forward slash and a pattern to search for dates.

autosupport add
autosupport add { alert-summary | asup-detailed } emails email-
list
Add entries to the email list for the daily alert summary or the autosupport report.

Example 15

# autosupport add asup-detailed emails [email protected]

Command Option Arguments

alert-summary
Addresses in email list for the Daily Alert Summary.
email-list
Individual email addresses to add to the specified list. Separate the items in the list
with commas, spaces, or both.

autosupport del
autosupport del { alert-summary | asup-detailed } emails email-
list

46 EMC Data Domain Operating System 5.4 Command Reference Guide

 autosupport

Delete entries from the email list for the daily alert summary or the autosupport report.
Command Option Arguments
alert-summary
Addresses in email list for the Daily Alert Summary.
email-list
Individual email addresses to add to the specified list. Separate the items in the list
with commas, spaces, or both.

autosupport reset
autosupport reset { alert-summary | asup-detailed}
Reset asup-detailed email list or alert-summary email list to the default value.
autosupport reset all
Reset all autosupport command options to the default values. Output includes details on
where alert summaries are sent via email and alert summary schedules.
autosupport reset schedule [ alert-summary | asup-detailed ]
Reset the schedules of the daily alert summary and the autosupport report to the default
values.
l By default, the schedule for the daily alert summary is configured with the daily 0600
options.
l By default, the schedule for the autosupport report is configured with the daily 0800
options.
autosupport reset subject-tag
Reset subject tag to empty for the autosupport report and Daily Alert Summary.
Command Option Arguments
alert-summary
Addresses in email list for the Daily Alert Summary.

autosupport send
autosupport send [email-addr] [cmd "cmd"]
Email a report or command description to the autosupport report email list or to the
address specified. You must enclose the command option name in double quotation
marks.

Example 16

To run the net show stats command and email the results to [email protected]:

# autosupport send [email protected] cmd "net show stats"

Command Option Arguments

cmd
Run the specified DD OS command. Enclose the command in double quotation
marks.

autosupport reset 47
autosupport

email-list
Individual email addresses to add to the specified list. Separate the items in the list
with commas, spaces, or both.

autosupport set
autosupport set schedule { alert-summary | asup-detailed }
{ [ { daily | day(s) } time ] | never }
Schedule the daily alert summary or the autosupport report. For either report, the most
recently configured schedule overrides the previously configured schedule.

Example 17

To schedule the daily alert summary for 2 p.m. Monday and Friday:

# autosupport set schedule alert-summary mon,fri 1400

Example 18

To schedule the autosupport report for Tuesday at 4 a.m:

# autosupport set schedule asup-detailed tue 0400

Example 19

To schedule the autosupport report for Tuesday at 3 p.m.:

# autosupport set schedule asup-detailed tue 1500

autosupport set subject-tag tag

Include the subject tag in the subject line of autosupport report and daily alert summary
emails to filter the emails based on tag. This enables users to bypass filtering software
that may block the emails. Default is none. Maximum number of characters is 64.
Command Option Arguments
alert-summary
Addresses in email list for the Daily Alert Summary.
daily
Default setting for daily alert summary and the autosupport report.
tag
A keyword that appends the subject line of the daily alert summary and autosupport
report emails and enables users to bypass company filtering and avoid mis-routing.

autosupport show
autosupport show { all | alert-summary | asup-detailed }
Display the autosupport configuration.

Example 20

48 EMC Data Domain Operating System 5.4 Command Reference Guide

 autosupport

Example 20 (continued)

# autosupport show all

The Admin email is:
Detailed autosupport and alert summary to Data Domain currently
enabled.
Detailed autosupport is scheduled to run "daily" at "0600".
Detailed autosupport is sent to:
[email protected]
[email protected]
[email protected]

Alert summary is scheduled to run "daily" at "0800".

Alert summary is sent to:
[email protected]
[email protected]
[email protected]

autosupport show history

Display the event history file, which includes the date for each autosupport report.
Message system logs are retained for 10 weeks.
autosupport show report
Generate an autosupport report without sending the results to the autosupport report
email list.
autosupport show schedule [ alert-summary | asup-detailed ]
Display the schedules for the daily alert summary and the autosupport report.
autosupport show subject-tag
Show the subject tag for autosupport report and daily alert summary emails.
Command Option Arguments
alert-summary
Addresses in email list for the Daily Alert Summary.
tag
A keyword that appends the subject line of the daily alert summary and autosupport
report emails and enables users to bypass company filtering and avoid mis-routing.

autosupport test
autosupport test { alert-summary | asup-detailed | support-
notify } | email email-addr }
Send a test email to all lists, or to a specific address.
Command Option Arguments
alert-summary
Addresses in email list for the Daily Alert Summary.
email-list
Individual email addresses to add to the specified list. Separate the items in the list
with commas, spaces, or both.

autosupport test 49
autosupport

50 EMC Data Domain Operating System 5.4 Command Reference Guide

CHAPTER 8
cifs

The cifs command manages CIFS data access between a Data Domain system and
Windows clients. Command options enable and disable access to a Data Domain system
from media servers and other Windows clients that use the CIFS protocol. The cifs
command sets the authentication mode, share management, and administrative access,
and displays status and statistics for CIFS clients.
This chapter contains the following topics:

l cifs Change History................................................................................................52

l cifs Guidelines and Restrictions............................................................................ 52
l cifs add................................................................................................................. 52
l cifs del.................................................................................................................. 52
l cifs disable........................................................................................................... 53
l cifs enable............................................................................................................ 53
l cifs hosts.............................................................................................................. 53
l cifs nb-lookup....................................................................................................... 53
l cifs option............................................................................................................. 53
l cifs reset............................................................................................................... 54
l cifs set.................................................................................................................. 54
l cifs share.............................................................................................................. 55
l cifs show...............................................................................................................56
l cifs status............................................................................................................. 56
l cifs troubleshooting.............................................................................................. 56

cifs 51
cifs

cifs Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 9 cifs Change History

Version Change
5.4 No changes from previous version.

cifs Guidelines and Restrictions

l Unless otherwise noted, command options are available only to users with admin
role permissions.
l After a CIFS client name has been added, it must be configured for access to the Data
Domain system. Configuration instructions are provided in the Integration
Documentation on the Data Domain Support portal. Select the vendor for the client
operating system, and then select the corresponding tuning document.
l When adding or removing clients on the Data Domain system /backup directory
separate clients in the list by a comma, a space, or both. The client-list can contain
class-C IP addresses, IP addresses with either netmasks or length, hostnames, or an
asterisk followed by a domain name.
l Enter an asterisk to add or remove all clients on the network.
l CIFS must be enabled on the Data Domain system. See cifs enable on page 53.

cifs add
cifs add /backup client-list
Specify clients that can access a Data Domain system /backup directory. The /backup
directory is the target directory for compressed backup server data.

Note

If adding multiple clients, Data Domain recommends using the cifs share add command
instead.
cifs add /ddvar client-list
Specify clients that can access a Data Domain system /ddvar directory. The /ddvar
directory contains Data Domain system core and log files.

cifs del
cifs del /backup client-list
Remove clients from the list of CIFS backup clients that can access a Data Domain
system /backup directory.

52 EMC Data Domain Operating System 5.4 Command Reference Guide

 cifs

Note

If removing multiple clients, Data Domain recommends using the cifs share destroy
command instead.
cifs del /ddvar client-list
Remove one or more clients from the list of clients that can access a Data Domain
system /ddvar directory.

cifs disable
cifs disable
Disable the CIFS service and prevent CIFS clients from connecting to the Data Domain
system. This command option stops the CIFS file service only. CIFS authentication
services continue to run.

cifs enable
cifs enable
Enable the CIFS service and allow CIFS clients to connect to the Data Domain system. This
command option starts the CIFS file service only.

cifs hosts
cifs hosts add ipaddrhost-list
Add lmhosts mapping. The lmhosts file is a local text file that maps IP addresses to
NetBIOS names. A single IP address can contain multiple hostnames.
cifs hosts del ipaddr
Remove lmhosts mapping for the specified IP address.
cifs hosts reset
Reset lmhosts mapping to the default. This option removes all IP address and NetBIOS
hostnames from the lmhosts file.
cifs hosts show
Display lmhosts mappings. All users may run this command option.

cifs nb-lookup
cifs nb-lookup netbios-name
Display the IP address for the specified NetBIOS name.

cifs option
cifs option reset name
Reset a CIFS option to default value.
cifs option set name value
Set a CIFS option.
cifs option show
Display CIFS options.

cifs disable 53
cifs

cifs reset
cifs reset authentication
Reset the CIFS authentication to the default: workgroup.
cifs reset clients
Reset the CIFS client access list for /backup and / ddvar shares to the default: no client
access.
cifs reset nb-hostname
Reset the NetBIOS hostname to the default: none.
cifs reset stats
Reset cifs statistics.
cifs reset wins-server
Set the WINS server IP address to the default: none.

cifs set
cifs set authentication active-directory realm { [dc1
[dc2 ...]] | * }
Set authentication to the Active Directory. The realm must be a fully qualified name. Use
commas, spaces, or both to separate entries in the domain controller list. Security officer
authorization is required for systems with Retention Lock Compliance enabled.

Note

Data Domain recommends using the asterisk to set all controllers instead of entering
them individually.

When prompted, enter a name for a user account. The type and format of the name
depend on if the user is inside or outside the company domain.
l For user Administrator inside the company domain, enter the name only:
administrator.
l For user Jane Doe in a trusted domain, enter the user name and domain:
[email protected]. The account in the trusted domain must have
permission to join the Data Domain system to your company domain.
The Data Domain system automatically adds a host entry to the DNS server. It is not
necessary to create the entry manually.
If you set the NetBIOS hostname using the command cifs set nb-hostname, the
entry is created for NetBIOS hostname only, not the system hostname. Otherwise, the
system hostname is used.
cifs set authentication workgroup workgroup
Set the authentication mode to workgroup for the specified workgroup name.
cifs set nb-hostname nb-hostname
Set the NetBIOS hostname.
cifs set wins-server ipaddr
Set the WINS server IP address. If CIFS clients are using NetBIOS, a WINS server may be
required to resolve NetBIOS names to IP addresses.

54 EMC Data Domain Operating System 5.4 Command Reference Guide

 cifs

cifs share
cifs share create share path path {max-connections max
connections | clients clients | browsing {enabled | disabled} |
writeable {enabled | disabled} | users users | comment comment}
Create a new share.
Argument Definitions
share
A descriptive name for the share.
path
The path to the target directory.
max-connections
The maximum number of connections to the share allowed at one time.
clients
A comma-separated list of clients allowed to access the share. Specify the clients by
hostname or IP address. No spaces or tabs allowed. If the clients argument is not
specified when creating the share, the share is not accessible by any client. To make
the share accessible for all clients, enter the clients argument and precede client
name by an ampersand.
browsing
The share is seen (enabled, default), or not (disabled) by browsers.
writeable
The share is writable (enabled, default), or not (disabled). By default, administrative
users have write privileges even if the argument writable is disabled.
users
A comma-separated list of user names. Other than the comma delimiter, spaces
(blank or tab) are treated as part of the user name because a Windows user name
can have a space in the name.
The user names list can include group names. Group names must be preceded by an
ampersand symbol.
All users in the client list can access the share unless one or more user names are
specified, in which case only the listed names can access the share. Separate group
and user names by commas only. Spaces may be included within a group name but
are not allowed as delimiters for group names.
comment
A descriptive comment about the share.

cifs share destroy share

Delete a share.
cifs share disable share
Disable a share.
cifs share enable share
Enable a share.
cifs share modify share {max-connections max connections |
clients clients | browsing {enabled | disabled} | writeable
{enabled | disabled} | users users | comment comment}

cifs share 55
cifs

Modify a share configuration with the same configuration options as the cifs share create
option, except for its path. You cannot change the path for an existing share.
Modifications apply to new connections only.
See the share create command option for a description of the command variables. To
remove a user list for the share, specify users.
cifs share show [share]
Display share configurations for all shares, or for a specified or custom share.

cifs show
cifs show active
Display all active CIFS clients.
cifs show clients
Display all allowed CIFS clients for the default /ddvar administrative share and the
default /backup data share.
cifs show config
Display the CIFS configuration.
cifs show detailed-stats
Display detailed statistics on CIFS activity and performance.
cifs show stats
Display basic statistics on CIFS activity and performance.

cifs status
cifs status
Show status of CIFS: enabled or disabled.

cifs troubleshooting
cifs troubleshooting domaininfo
Report domain information; for example, to check the connectivity between the Data
Domain system and the domain. Also to confirm if authentication issues are due to
domain connectivity.
cifs troubleshooting group groupname | gid | SID
List details for a specified group.
cifs troubleshooting list-groups
List all CIFS groups.
cifs troubleshooting list-users
List all CIFS users.
cifs troubleshooting performance
Collect tcpdump and ddfs traces for CIFS performance analysis.

Example 21

To troubleshoot performance problems:

Enter:

56 EMC Data Domain Operating System 5.4 Command Reference Guide

 cifs

Example 21 (continued)

# cifs troubleshooting performance

Enter:

# support bundle upload

cifs troubleshooting user username | uid | SID

Display details on a specified user.

cifs troubleshooting 57
cifs

58 EMC Data Domain Operating System 5.4 Command Reference Guide

CHAPTER 9
config

The config command manages Data Domain system configuration settings. Command
options include changing individual configuration parameters and viewing the
configuration setup. For information on how to configure the system, see the EMC Data
Domain Operating System Initial Configuration Guide and the EMC Data Domain Operating
System Administration Guide.
This chapter contains the following topics:

l config Change History........................................................................................... 60

l config Guidelines and Restrictions........................................................................ 60
l config reset........................................................................................................... 60
l config set.............................................................................................................. 60
l config setup.......................................................................................................... 61
l config show...........................................................................................................61

config 59
config

config Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 10 config Change History

Version Change
5.4 No changes from previous version.

config Guidelines and Restrictions

Unless otherwise noted, command options are available only to users with admin role
permissions.

config reset
config reset location
Reset the location description to the default Null.
config reset mailserver
Reset the mail server to the default mail server.
config reset timezone
Reset the time zone to the default US/Pacific. This command option requires security
officer authorization if Retention Lock Compliance is enabled on any MTrees.

config set
config set admin-email email-addr
Set recipient addresses for alerts and autosupport emails. The system requires one
administrative email address. Use the autosupport and alerts commands to add
other email addresses. To check the current setting, use config show admin-
email.
config set admin-host host
Set the machine from which you can log in to the Data Domain system to view system
logs and use system commands. The hostname can be simple, fully qualified, or an IP
address. The host is also added to the FTP and Telnet lists licensed software options only,
and to the CIFS and NFS lists for access to /ddvar and /backup. This command
provides a quick way to add authentication privileges. To check the current setting, use
config show admin-host.

Example 22

# config set admin-host admin12.yourcompany.com

config set location "location"

60 EMC Data Domain Operating System 5.4 Command Reference Guide

 config

Change the description of a Data Domain systems location. A description of a physical

location helps identify the machine when viewing alerts and autosupport emails. If the
description contains one or more spaces, the description must be in double quotation
marks. To check the current setting, use config show location.

Example 23

# config set location "row2-num4-room221"

config set mailserver host

Change the SMTP mail server used by the Data Domain system. To check the current
setting, use config show mailserver.

Example 24

# config set mailserver mail.yourcompany.com

config set timezone zonename

Set the system clock to a specific time zone. The default setting is US/Pacific. Changes to
the time zone require a system reboot. This command option requires security officer
authorization if any MTrees are enabled with Retention Lock Compliance. Enter a category
or a partial zone name to display a list of time zones from which to choose.

config setup
config setup
Change configuration settings for the system, network, filesystem, CIFS, NFS, and
licenses. Press Enter to cycle through the selections. You will be prompted to confirm any
changes. Choices include Save, Cancel, and Retry.
This command option is unavailable on Retention Lock Compliance systems. Use System
Manager to change configuration settings.

config show
config show admin-email
Display the administrative email address the Data Domain system uses for email from the
alerts and autosupport commands. All users may run this command option.
config show admin-host
Display the administrative host from which you can log into the Data Domain system to
view system logs and use system commands. All users may run this command option.
config show all
Display all config command settings. All users may run this command option.
config show location
Display the Data Domain system location description, if you set one. All users may run
this command option.
config show mailserver
Display the name of the mail server that the Data Domain system uses to send email. All
users may run this command option.
config show timezone

config setup 61
config

Display the time zone used by the system clock. All users may run this command option.

62 EMC Data Domain Operating System 5.4 Command Reference Guide

CHAPTER 10
ddboost

The ddboost command manages the integration of Data Domain systems and disk
backup devices. Command options create and delete storage units on the storage server,
and display the disk space usage of each storage unit. The EMC Data Domain Boost
software option also supports advanced load balancing and failover, distributed segment
processing, encryption, and low-bandwidth optimization.
Quotas provision Data Domain system storage among different backup applications.
Quotas restrict the logical (uncompressed and undeduplicated) storage capacity for each
storage unit. DD Boost storage unit quota limits (hard or soft) can be set or removed
dynamically. Quotas may also be used to provision various DD Boost storage units with
different sizes, enabling an administrative user to monitor the usage of a particular
storage unit over time. Note that it is possible to configure quotas on a system and run
out of storage before quota limits are reached.
Like MTree quota limits, the ddboost storage-unit create command includes
optional arguments to specify quota limits at the time the storage unit is created. Output
of the ddboost storage-unit show command indicates if a quota is defined for the
storage unit.
Fibre Channel transport is available for DD Boost via the DD Boost over Fibre Channel
service and Automatic Image Replication (AIR) is also supported. See the EMC Data
Domain Boost for OpenStorage Administration Guide and the EMC Data Domain Operating
System Administration Guide for details.
This chapter contains the following topics:

l ddboost Change History........................................................................................ 64

l ddboost Guidelines and Restrictions..................................................................... 64
l ddboost access.....................................................................................................64
l ddboost association..............................................................................................65
l ddboost destroy.................................................................................................... 65
l ddboost disable.................................................................................................... 65
l ddboost enable.....................................................................................................65
l ddboost event....................................................................................................... 65
l ddboost fc.............................................................................................................67
l ddboost file-replication......................................................................................... 69
l ddboost ifgroup.................................................................................................... 70
l ddboost option..................................................................................................... 71
l ddboost reset........................................................................................................71
l ddboost set...........................................................................................................72
l ddboost show....................................................................................................... 72
l ddboost status......................................................................................................73
l ddboost storage-unit.............................................................................................73

ddboost 63
ddboost

ddboost Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 11 ddboost Change History

Version Change
5.4 No changes from previous version.

ddboost Guidelines and Restrictions

l Unless otherwise noted, command options are available only to users with admin
role permissions.
l DD Boost is a licensed software option. If basic options do not work, verify that the
proper licensing has been implemented on your Data Domain system.
l Quota limits are enforced only if MTree quotas are enabled. A message displays in
the output notifying users if the quota feature is disabled.
l When a storage unit is created, quota limits are set to the default MTree quota size.
l If MTree quotas are enabled, backups are stopped if a hard limit is reached.
l Enabling quotas may cause OpenStorage backup applications to report non-intuitive
sizes and capacities. See Knowledge Base article 85210, available on the Support
portal, for details.
l Only one Automatic Image Replication (AIR) association is allowed for a specified
storage unit and the target Data Domain system and the target storage unit.
l Do not use DD Boost Fibre Channel server names to create AIR associations. Use IP
server names only.

ddboost access
ddboost access add clients client-list
Add one or more clients to the list of clients that can access DD Boost. Enter the client
hostname, not IP address.

Example 25

# ddboost access add clients host1 host2 host3

ddboost access del clients client-list

Remove one or more clients from the list of clients that can access DD Boost.
ddboost access reset
Reset DD Boost client list to factory default.
ddboost access show
Show list of clients that can access DD Boost.

64 EMC Data Domain Operating System 5.4 Command Reference Guide

 ddboost

ddboost association
ddboost association create local-storage-unit {replicate-to |
replicate-from} remote-hostnameremote-storage-unit
Create a storage unit association for the specified storage unit, the target Data Domain
system, and target storage unit.

Example 26

# ddboost association create TEST_LSU1 replicate-to rtp-ost-

dd670c2.datadomain.com TEST_LSU2

ddboost association destroy local-storage-unit {replicate-to |

replicate-from} remote-hostnameremote-storage-unit
Destroy the storage unit association of the specified storage unit, the target Data Domain
system, and target storage unit.

Note

This command option deletes unprocessed events in the local storage unit if the
association specified is {replicate-from}. It does not delete user data in the local storage
unit.
ddboost association show [local-storage-unit]
Show the storage unit association list for a specified local storage unit or all local storage
units with an association. All users may run this command option.

ddboost destroy
ddboost destroy
Delete all storage units from the Data Domain system. The command permanently
removes all data (files) contained in the storage units. You must also manually remove
(expire) corresponding catalog entries in the backup software.

ddboost disable
ddboost disable
Disable DD Boost. During the process of disabling DD Boost, all file replication transfers
and read/write jobs are also disabled.

ddboost enable
ddboost enable
Enable DD Boost. If the user, user ID (UID), or group ID (GID) changes, the Data Domain
system updates all files and storage units the next time this command is run.

ddboost event
ddboost event destroy local-storage-unitevent-id
Destroy the event specified by event-id on the specified storage unit.

ddboost association 65
ddboost

Note

This command should not be used routinely. Use this command option to remove events
orphaned as a result of system errors only.
ddboost event show [local-storage-unit]
Show the event list for the specified local storage unit or all local storage units with a
{replicate-from} association.
Events formatted with the suffix .event.nnnnnnn have been processed but not yet
deleted. Events formatted with the suffix .imgset have not yet been processed.

Example 27

# ddboost event show

DDBoost events:
test2: bluemedia.datadomain.com_31234_6589_1.event.0000000000000006
192:rtp-ost-sparc1.datadomain.com_rtp-ost-
dd670c2.datadomain.com_1328637954_1.imgset

Output Definitions (event.nnnnnnn)

first media server
Hostname of the media server to which the event is first delivered. In the example:
bluemedia.datadomain.com.
proc_id
Process identifier on the first media server to which the event is initially delivered. In
the example: 31234.
thread_id
Thread identifier on the first media server to which the event is first delivered. In the
example: 6589.
# images
Number of images contained in event. In the example: 1. Typically this number is 1
because only the IM image file is contained in an event.
event
Image set identifier. In the example: 0000000000000006.

Output Definitions (imgset)

job #
NetBackup duplication job identifier. In the example: 192.
source server
Hostname of the NetBackup server. In the example: rtp-ost-sparc1.datadomain.com.
source Data Domain system
Hostname of the Data Domain system from where event originated. In the example:
rtp-ost-dd670c2.datadomain.com.
image date
NetBackup image time stamp. In the example: 1328637954.
# images
Number of images contained in event. In the example: 1. Typically this number is 1
because only the IM image file is contained in an event.
imgset
Image set identifier.

66 EMC Data Domain Operating System 5.4 Command Reference Guide

 ddboost

ddboost fc
ddboost fc dfc-server-name reset
Reset DD Boost Fibre Channel server name.
Role required: admin.
ddboost fc dfc-server-name set server-name
Set DD Boost Fibre Channel server name. The default dfc-server-name is the Data Domain
system hostname.

Note

Only IP server names are valid in creating AIR associations, DFC server names should not
be used in creating AIR associations:

# ddboost fc dfc-server-name show

DDBoost dfc-server-name: not configured.

Role required: admin.

ddboost fc dfc-server-name show
Show DD Boost Fibre Channel server name.
Role required: admin, security, user, backup-operator, none.
ddboost fc dump start logfile-id logfile-id [formatted]
[snaplen bytes] [logfile-count-limit count] [logfile-size-limit
bytes] [virtual-connection virtual-connection-id] [client-
hostname hostname] [initiator initiator] [target-endpoint
endpoint] [destination-tcp-port tcp-port]
Start DD Boost Fibre Channel message tracing.
Role required: admin.
ddboost fc dump status
Show DD Boost Fibre Channel message tracing.
Role required: admin, security, user, backup-operator, none.
ddboost fc dump stop
Stop DD Boost Fibre Channel message tracing.
Role required: admin.
ddboost fc group add group-name initiator initiator-spec
Add one or more initiators to a DD Boost Fibre Channel group.
Role required: admin.
ddboost fc group add group-name device-set [count count]
[endpoint {all | none | endpoint-list}]
Add one or more DD Boost devices to a DD Boost Fibre Channel group. Valid range for
count argument is 1-64.
Role required: admin.
ddboost fc group create group-name
Create a DD Boost Fibre Channel group.
Role required: admin.
ddboost fc group del group-name initiator initiator-spec

ddboost fc 67
ddboost

Remove one or more initiators from a DD Boost Fibre Channel group.

Role required: admin.
ddboost fc group del group-name device-set {count count | all }
Remove one or more DD Boost devices from a DD Boost Fibre Channel group.
Role required: admin.
ddboost fc group destroy group-name
Destroy a DD Boost Fibre Channel group.
Role required: admin.
ddboost fc group modify group-name device-set [count count]
[endpoint {all | none | endpoint-list]
Modify a device set for a DD Boost Fibre Channel group.
Role required: admin.
ddboost fc group rename src-group-namedst-group-name
Rename a DD Boost Fibre Channel group.
Role required: admin.
ddboost fc group show detailed group-spec [initiator initiator-
name]
Show details of DD Boost Fibre Channel groups. Output includes information on device
names, system addresses, LUNs, and endpoints.
Role required: admin, security, user, backup-operator, none.
ddboost fc group show list [group-spec] [initiator initiator-
name]
Display a list of configured DD Boost Fibre Channel groups.
Role required: admin, security, user, backup-operator, none.
ddboost fc show detailed-stats
Show DD Boost Fibre Channel detailed statistics.
Role required: admin, security, user, backup-operator, none.
ddboost fc show stats [endpoint endpoint-spec] [initiator
initiator-spec] [interval interval] [count count]
Show DD Boost Fibre Channel detailed statistics periodically based on filter. The interval
is an optional number of seconds with a minimum of 1 and a maximum of 4294967295.
The count is an optional ordinal value with a minimum of 1 and a maximum of
4294967295.
Role required: admin, security, user, backup-operator, none.

Example 28

# ddboost fc show stats endpoint all interval 2 count 2

ddboost fc status
Show DD Boost Fibre Channel status. Output includes information on admin state and
process state.
Role required: admin, security, user, backup-operator, none.
ddboost fc trace disable [component {all | component-list}]
Disable DD Boost Fibre Channel tracing.
Role required: admin.

68 EMC Data Domain Operating System 5.4 Command Reference Guide

 ddboost

ddboost fc trace enable [component {all | component-list}]

[level {all | high | medium | low}]
Enable DD Boost Fibre Channel tracing.
Role required: admin.
ddboost fc trace show [component {all | component-list}]
Show DD Boost Fibre Channel trace status.
Role required: admin, security, user, backup-operator, none.

ddboost file-replication
ddboost file-replication option reset {low-bw-optim |
encryption}
Reset low-bandwidth optimization or encryption to the default value (disabled). Low-
bandwidth optimization is not supported on DD Extended Retention systems.
ddboost file-replication option set encryption {enabled |
disabled}
Enable or disable encrypted data transfer for DD Boost file-replication. This command
must be entered on the source system and the destination (target) system.
ddboost file-replication option set low-bw-optim {enabled |
disabled}
Enable or disable low bandwidth optimization for DD Boost. This command must be
entered on the source system and the destination (target) system. Default setting is
disabled. Low-bandwidth optimization is not supported on DD Extended Retention
systems.
ddboost file-replication option show [encryption]
Show state of encryption: enabled or disabled.
ddboost file-replication option show [low-bw-optim]
Show state of low bandwidth optimization: enabled or disabled.
ddboost file-replication reset stats
Clear file-replication statistics when DD Boost is enabled.
ddboost file-replication show active
Show the status of a DD Boost file-replication transfer to a destination Data Domain
system. Output for low-bandwidth optimization shows the function as enabled and
running, or as enabled with a configuration mismatch.
ddboost file-replication show detailed-file-history [duration
duration {day | hr}]
Show a detailed, file-based replication history. Data for each file name is organized by
date, time, and direction (outbound or inbound). In Release 5.4.1.0, a new column (Post-
synthetic-optim) is added to the command outputs to provide statistics for synthetic
replication.
ddboost file-replication show detailed-history [duration
duration {day | hr}] [interval interval {hr}]
Show a detailed, cumulative view of file-replication history. Data is organized by date,
time, and direction (outbound or inbound). In Release 5.4.1.0, a new column (Post-
synthetic-optim) is added to the command outputs to provide statistics for synthetic
replication.
ddboost file-replication show file-history [duration duration
{day | hr}]

ddboost file-replication 69
ddboost

Show the data-transfer history of inbound and outbound traffic for files in the Data
Domain system /backup directory.
ddboost file-replication show history [duration duration {day |
hr}] [interval interval {hr}]
Show the data transfer history between the source and destination Data Domain systems.
ddboost file-replication show performance [interval sec] [count
count]
Show in real time the amount of pre-compressed outbound and inbound data compared
to network throughput or post-compressed data. The count displays the number of lines
equal to the count value. Output is shown for the specified interval.
ddboost file-replication show stats
Monitor outbound and inbound traffic on a Data Domain system during replication.
Compression ratio increases when low-bandwidth optimization is enabled. In Release
5.4.1.0, a new column (Post-synthetic-optim) is added to the command outputs to
provide statistics for synthetic replication.

ddboost ifgroup
ddboost ifgroup add group_name {interface ipaddr | client host}
Add an interface, client, or both to group-name or default group. Prior to adding an
interface you must create the group_name unless the group name is the default group.

Note

The group-name default is created during an upgrade of a fresh install and is always
used if group_name is not specified.

Additionally, the IP address must be configured on the Data Domain system and its
interface must be enabled. You can add public or private IP addresses for data transfer
connections. After adding an IP address as an interface, you can enable advanced load
balancing and link failover.
See the EMC Data Domain Boost Administration Guide and theEMC Data Domain Operating
System Administration Guide for more information on interface groups.
ddboost ifgroup create group-name
Create a group with the name group-name for the interface. Group names may contain
numbers 0-9, letters a-z (uppercase and lowercase), hyphens, carets, dollar signs,
underscores, and asterisks. System hostnames, fully qualified hostnames, and wildcard
hostnames indicated by an asterisk may also be used. Reserved group names that
cannot be used are default, all, or none.
ddboost ifgroup del group_name {interface ipaddr | client host}
Remove an interface, client, or both from group_name or default group. Deleting the last
IP address interface disables the ifgroup. If this is the case, you have the option of
terminating this command option.
ddboost ifgroup destroy group-name
Destroy the group name. Only empty groups can be destroyed. Interfaces or clients
cannot be destroyed but may be removed sequentially or by running the command option
ddboost ifgroup reset group-name.

Note

The group-name default cannot be destroyed.

ddboost ifgroup disable group-name

70 EMC Data Domain Operating System 5.4 Command Reference Guide

 ddboost

Disable a specific group by entering the group-name. If group-name is not specified, the
command applies to the default group.
ddboost ifgroup enable group-name
Enable a specific group by entering the group-name. If group-name is not specified, the
command applies to the default group.
ddboost ifgroup rename source-group-namedestination-group-name
Rename the ifgroup source-group-name to destination-group-name. This command option
does not require disabling the group.
ddboost ifgroup reset group-name
Reset a specific group by entering the group-name. If group-name is not specified, the
command applies to the default group.
ddboost ifgroup show config {interfaces | clients | groups |
all} [group-name]
Display selected configuration options. If no selection is made, all information about the
specified group-name is shown.
If group-name is not specified, all information about the default group is displayed. Select
the all argument to view configuration options of all groups. All users may run this
command option.
ddboost ifgroup status group-name
Show status of link aggregation: enabled or disabled. Status is displayed for all groups
unless group-name is specified. All users may run this command option.

ddboost option
ddboost option reset {distributed-segment-processing | virtual-
synthetics | fc}
Reset distributed segment processing, virtual synthetics to the default option enabled.
Reset Fibre Channel to the default option of disabled. Virtual synthetics and Fibre
Channel features are supported on single-node configurations and systems with
Extended Retention only.
ddboost option set distributed-segment-processing {enabled |
disabled}
Enable or disable the distributed segment processing feature on the DD OS.
ddboost option set fc {enabled | disabled}
Enable or disable Fibre Channel for DD Boost.
ddboost option set virtual-synthetics {enabled | disabled}
Enable or disable the virtual synthetics feature on the DD OS. Virtual synthetics and Fibre
Channel features are supported on single-node configurations and systems with
Extended Retention.
ddboost option show [distributed-segment-processing | virtual-
synthetics | fc]
Show status of distributed segment processing, virtual synthetics, or Fibre Channel. If no
argument is specified, status for all arguments are shown. Status is enabled or disabled.
Default is disabled for distributed segment processing and virtual synthetics. Default is
enabled for Fibre Channel. All users may run this command.

ddboost reset
ddboost reset stats

ddboost option 71
ddboost

Reset statistics when DD Boost is enabled, or as a network recovery procedure to clear

job connections after the network connection is lost.
ddboost reset user-name
Delete and reset the DD Boost user name.

ddboost set
ddboost set user-name user-name
The DD Boost user name cannot be configured while DD Boost is enabled. DD Boost must
be disabled using the ddboost disable command. Then DD Boost user name can be
updated. Finally, DD Boost can be reenabled to verify the user name by using the
ddboost show user-name command.

ddboost show
ddboost show connections
Show the number of DD Boost connections. All users may run this command.
When DD Boost Fibre Channel is enabled, connections are listed in the category
Interfaces and are named DDBOOST_FC. The ifgroup Group Name category does not apply
to DD Boost Fibre Channel; therefore, the group name is listed as n/a.

Note

When an archive train restore image file spans multiple partitions, it uses multiple
concurrent RSS connections for a single job. Therefore, output may show two restore
connections and one control connection. This is expected behavior.
ddboost show histogram
Display a DD Boost histogram for the Data Domain system.
Output Definitions
mean-ms
The mathematical mean time for completion of the operations.
stddev
The standard deviation for time to complete operations, derived from the mean time.
max-s
The maximum time taken for a single operation.
<1ms
The number of operations that took less than 1 millisecond (ms).
<5ms
The number of operations that took between 1 milliseconds and 5 milliseconds.
<10ms
The number of operations that took between 5 milliseconds and 10 milliseconds
100ms
The number of operations that took between 10 ms and 100 ms.
1s
The number of operations that took between 100 ms and one second.
10s
The number of operations that took between 1 second and 10 seconds.

72 EMC Data Domain Operating System 5.4 Command Reference Guide

 ddboost

>10s
The number of operations that took more than 10 seconds.
<10s
The number of operations that took less than 10 seconds.
<1m
The number of operations that took between 10 seconds and 1 minute.
<5m
The number of operations that took between 1 minute and 5 minutes.
>5min
The number of operations that took more than 5 minutes.
<100ms
The number of operations that took between 10 milliseconds and 100 milliseconds.
<1s
The number of operations that took between 100 milliseconds and 1 second)
<10s
The number of operations that took between 1 second and 10 seconds)
>10s
The number of operations that took more than 10 seconds.

ddboost show stats [ interval seconds ] [count count]

Show DD Boost statistics. The interval is an optional number of seconds with a minimum
of 1 and a maximum of 4294967295. The count is an optional ordinal value with a
minimum of 1 and a maximum of 4294967295.
ddboost show user-name
Display current DD Boost user.

ddboost status
ddboost status
Display status of DD Boost: enabled or disabled.

ddboost storage-unit
ddboost storage-unit create storage-unit-name [quota-soft-limit
n {MiB|GiB|TiB|PiB}] [quota-hard-limit n {MiB|GiB|TiB|PiB}]
[report-physical-size n {MiB|GiB|TiB|PiB}]
Create a storage unit and set limits. Configure reported physical size. If the physical size
is configured, the logical capacity quota is still available, but its value is not reported in
the SDK to the backup application. Note that if the quota feature is not enabled, the
quota is created but a message appears stating the feature is disabled and limits are not
enforced.
Naming conventions for creating storage units include letters A-Z and a-z, numbers 0-9,
embedded spaces, exclamation points, hash marks, dollar signs, ampersands, carets,
tildes, left and right parentheses, left and right brackets, left and right braces.
Quotas may cause OpenStorage backup applications to report non-intuitive sizes and
capacities. See Knowledge Base article 85210, available on the Support portal, for
details.
ddboost storage-unit modify storage-unit-name [report-physical-
size n|none {MiB|GiB|TiB|PiB}]

ddboost status 73
ddboost

Modify reported physical size.

ddboost storage-unit delete storage-unit-name
Delete a specified storage unit and contents, and any DD Boost associations. You must
also manually remove (expire) corresponding catalog entries from the backup
application.
ddboost storage-unit show [compression] [storage-unit-name]
Display the reported physical size. Display the compression for all storage units (the
original byte size, global and local compression) or the filenames in a specified storage
unit. The list of files in a storage unit is shown in the output only if a storage unit name is
specified.

74 EMC Data Domain Operating System 5.4 Command Reference Guide

CHAPTER 11
disk

The disk command manages disks and displays disk locations, logical (RAID) layout,
usage, and reliability statistics. Each Data Domain system reports on the number of disks
in the system. For a Data Domain system with one or more Data Domain external disk
shelves, commands also include entries for enclosures and disks.
This chapter contains the following topics:

l disk Change History.............................................................................................. 76

l disk Guidelines and Restrictions........................................................................... 76
l disk beacon.......................................................................................................... 76
l disk fail................................................................................................................. 76
l disk multipath.......................................................................................................76
l disk port................................................................................................................77
l disk rescan........................................................................................................... 77
l disk reset.............................................................................................................. 77
l disk set................................................................................................................. 77
l disk show..............................................................................................................77
l disk status............................................................................................................ 80
l disk unfail............................................................................................................. 81

disk 75
disk

disk Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 12 disk Change History

Version Change
5.4 Modified command option:

disk show hardware on page 77

disk Guidelines and Restrictions

Unless otherwise noted, command options are available only to users with admin role
permissions.

disk beacon
disk beacon enclosure-id.disk-id
Cause the LED that signals normal operation to flash on the target disk. Press Ctrl-C to
stop the flash. To check all disks in an enclosure, use the enclosure beacon command
option.

disk fail
disk fail enclosure-id.disk-id
Fail a disk and force reconstruction.

disk multipath
disk multipath failback
Manually force all disks to use the primary path. This command works on gateway
models only.
disk multipath option reset {monitor | auto-failback}
Disable multipath configuration monitoring. When disabled, failures in paths to disk
devices do not generate alerts. Multipath configuration monitoring is disabled by default.
To perform auto-failback, use this command to switch over to the primary path when it
becomes available, even if the secondary path remains usable. The auto-failback option
is enabled by default and supported on gateway systems only.
disk multipath option set auto-failback {enabled | disabled}
Enable or disable auto-failback policy. Enabling auto-failback means the primary path is
used when it is available. Disabling auto-failback means the user must manually fail back
to the primary path when the path becomes available. This command is supported on
gateway models only.
disk multipath option set monitor {enabled | disabled}

76 EMC Data Domain Operating System 5.4 Command Reference Guide

 disk

Enable multipath configuration monitoring. When enabled, failures in paths to disk

devices generate alerts and log multipath events. If monitoring is disabled, multipath
event logging is not performed, meaning disk multipath show history is not updated.
Multipath configuration monitoring is disabled by default.
disk multipath option show
Show status of multipath configuration monitoring and auto-failback: disabled or
enabled. Auto-failback is supported on gateway systems only.
disk multipath reset stats
Clear statistics of all disk paths in expansion shelves.
disk multipath resume port port
Allow I/O on specified initiator port.
disk multipath show history
Show history of multipath events.
disk multipath show stats [enclosure enc-id]
Show statistics for all disk paths by default, or for the specified enclosure only.
disk multipath status [port-id]
Show multipath configurations and runtime status.
disk multipath suspend port port
Disallow I/O on specified initiator port, and stop traffic on particular ports during
scheduled maintenance of the SAN, storage array, or system. This command does not
drop the Fibre Channel link.

disk port
disk port enable port-id
Enable the specified initiator port.
disk port show {stats | summary}
Show disk port information.

disk rescan
disk rescan [enclosure-id.disk-id]
Rescan all disks to look for newly removed or inserted disks or LUNs or power on a drive.

disk reset
disk reset performance
Reset disk performance statistics to zero.

disk set
disk set dev disk-id spindle-group 1-16
Assign a LUN group to the disk. You must restart the file system after adding the LUN.

disk show
disk show failure-history
Display list of serial numbers of failed disks in the Data Domain system.

disk port 77
disk

disk show hardware

Display disk hardware information. Beginning with this release, output includes a column
for slot numbering. The number displayed in the Slot column is based on the type of
system on which the command is run:
l Slot numbering begins at 0 on DD2500 systems.
l Slot numbering begins at 0 on systems DD4200, DD4500, and DD7200, however slot
0 is unused and does not appear in output.
l Slot numbering begins at 1 on systems DD990 and earlier.
Output Definitions (Disk Information)
Disk (enc/disk)
The enclosure and disk numbers.
Slot
The slot number for the disk.
Manufacturer/Model
The manufacturer model designation.
Firmware
The firmware revision on each disk.
Serial No.
The manufacturer serial number for the disk.
Capacity
The data storage capacity of the disk when used in a Data Domain system. The Data
Domain convention for computing disk space defines one gigabyte as 230 bytes,
giving a different disk capacity than the manufacturers rating.
Type
The type of disk drive.

Output Definitions (System Information)

Disk
Each LUN accessed by the Data Domain system as a disk.
LUN
The LUN number given to a LUN on the third-party physical disk storage system.
Port WWN
The world-wide number of the port on the storage array through which data is sent to
the Data Domain system.
Manufacturer/Model
A label that identifies the manufacturer. The display may include a model ID, RAID
type, or other information depending on the vendor string sent by the storage array.
Firmware
The firmware level used by the third-party physical disk storage controller.
Serial No.
The serial number from the third-party physical disk storage system for a volume that
is sent to the Data Domain system.
Capacity
The amount of data in a volume sent to the Data Domain system. GiB = Gibibytes,
the base-2 equivalent of Gigabytes. MiB = Mebibytes, the base-2 equivalent of
Megabytes. TiB = Tebibytes, the base-2 equivalent of Terabytes.
Spindle-Group
The spindle-group for this LUN. (Available on gateway systems only.)

78 EMC Data Domain Operating System 5.4 Command Reference Guide

 disk

disk show performance

Display disk performance statistics for each disk. Each column displays statistics
averaged since the last disk reset performance command or the last system
power cycle.
Command output from a gateway Data Domain system lists each LUN accessed by the
Data Domain system as a disk.
Output Definitions
Disk (enc/disk)
The enclosure and disk numbers.
Read sects/s
The average number of sectors per second written to each disk.
Write sect/s
The average number of sectors per second written to each disk.
Cumul. MiBytes/s
The average number of megabytes per second written to each disk. MiBytes = MiB =
Mebibytes, the base-2 equivalent of Megabytes.
Busy
The average percent of time that each disk has at least one command queued.

disk show reliability-data

View details of the hardware state of each disk. Output also includes the operational
state of drives and if the drive is present or absent. Output is typically used by Data
Domain Support for troubleshooting assistance.
Output Definitions
Disk
The enclosure.disk-id disk identifier.
Slot
The disk slot number.
ATA Bus CRC Err
The uncorrected raw UDMA CRC errors.
Reallocated Sectors
The number of mapped-out defective sectors.
Temperature
The current temperature of each disk in Celsius and Fahrenheit. The allowable case
temperature range for disks is from 5 degrees centigrade to 55 degrees centigrade.

disk show state

Display state information for all disks in an enclosure (a Data Domain system or an
attached expansion shelf) or LUNs in a Data Domain gateway system using storage area
network (SAN) storage.
If a RAID disk group reconstruction is underway, columns for the disk identifier, progress,
and time remaining are included in command output.
Output includes two columns: Enclosure and Disk. The legend describes the letters under
the Disk column:
.
In Use
s
Spare

disk show 79
disk

R
Reconstruction
v
Available
K
Known
U
Unknown
O
Foreign
A
Absent
Y
System
D
Disabled
P
Powered Off
Additional legend entries include one for disks undergoing reconstruction and one
for disks in the queue:
C
Copy Recovery Disks
E
Error Disks

disk status
disk status
View details on the Data Domain system disk status. Output includes the number of disks
in use and failed, the number of spare disks available, and if a RAID disk group
reconstruction is underway.

Note

The RAID portion of the display could show one or more disks as Failed while the
Operational portion of the display could show all drives operating nominally. A disk can
be physically functional and available, but not in use by RAID, possibly because of user
intervention.

On a gateway Data Domain system, the display shows only the number and state of the
LUNs accessed by the Data Domain system. The remainder of the display is invalid for a
gateway system.
Reconstruction is done per disk. If more than one disk is to be reconstructed, the disks
queued for reconstruction show as spare or hot spare until reconstruction begins.
In the first line of output, disk status is indicated by one of the following, high-level
states.
Normal
System is operational and all disks are available and ready for use.

80 EMC Data Domain Operating System 5.4 Command Reference Guide

 disk

Error
A new head unit is in this state when Foreign storage is present. For a system
configured with some storage, Error indicates that some or all of its own storage is
missing.
Warning
A special case of a system that would have been Normal if the system had none of
the following conditions that require user action:
l RAID system degraded
l Foreign storage
l Failed or Absent disks

disk unfail
disk unfail enclosure-id.disk-id

Note

This command option makes a disk previously marked Failed or Foreign usable to the
system.

disk unfail 81
disk

82 EMC Data Domain Operating System 5.4 Command Reference Guide

CHAPTER 12
enclosure

The enclosure command identifies and displays information about Data Domain
system enclosures and attached expansion shelves. Beginning with 5.4, output from the
enclosure show command option includes device VPD information for enclosures on
newer Data Domain appliances (DD4500 and DD7200). VPD information enables users to
monitor systems more efficiently.
This chapter contains the following topics:

l enclosure Change History......................................................................................84

l enclosure Guidelines and Restrictions...................................................................84
l enclosure beacon..................................................................................................84
l enclosure show..................................................................................................... 84
l enclosure test....................................................................................................... 87

enclosure 83
enclosure

enclosure Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 13 enclosure Change History

Version Change
5.4 Modified command options:

enclosure show all [<enclosure>] on page 84

enclosure show memory [<enclosure>] on page 84

enclosure show powersupply [<enclosure>] on page 84

enclosure Guidelines and Restrictions

l Unless otherwise noted, command options are available to admin users only.
l All users may run show command options.
l Enclosure numbers are not static and may change when the system is rebooted.
(Numbers are generated according to when the shelves are detected during system
startup.)
l If a Data Domain system or a previously installed shelf, or both, require spare disks
and none are available, disks from a newly installed shelf are allocated to the
existing RAID groups (disk groups) when the new shelf is recognized by the disk
rescan command. The shelf allocating the disks must have at least 14 disks
available for its own RAID group.

enclosure beacon
enclosure beacon enclosure
Confirm that the DD OS and hardware recognize an enclosure. This command option
causes the LED on each disk in an enclosure to flash green, indicating activity. Press Ctrl-
C to halt the command.

enclosure show
enclosure show all [enclosure]
Display detailed information for all enclosures and environmentals. To view information
on a specific environmental, use the enclosure show command and include the
environmental as an argument; for example enclosure show fans. Environmentals
included in the output of enclosure show all are:
l Fans
l Temperature
l Power-supply
(For enclosure 1 [head unit] only)

84 EMC Data Domain Operating System 5.4 Command Reference Guide

 enclosure

l Chassis
l IO-Cards
l Controller
l CPUs
l Memory
l NVRAM
enclosure show chassis [enclosure]
Show detailed enclosure chassis inventory. To view information on a specific enclosure,
include the enclosure number as the keyword.
enclosure show controllers [enclosure]
Display information and status for an enclosure and shelf controller systems.
Controller Definitions (Physical Enclosure Shell)
Enclosure
The number listed here is the enclosure number assigned by the Data Domain OS.
(Enclosure 1 is the head unit.) This number is the argument passed to the command.
Model
The product name or appliance series of the enclosure.
Capacity
The number of usable drive slots in the enclosure.
Serial No.
The serial number of the physical enclosure. As with the WWN, this describes the
enclosure and does not change if components are swapped. Depending on when the
enclosure was manufactured, this may be the same value as the WWN. This value
matches the serial number printed on the label on the back of the enclosure.
Number of Controllers
The number of shelf controllers currently inserted into the enclosure.

Output Definitions (Controller Modules)

Controller 1
Identifies which shelf controller module the block of information is for. If this
enclosure has both shelf controllers installed, there are blocks for Controller 1 and
Controller 2.
Firmware
The revision level of the firmware that resides on the shelf controller. This value can
be different for each shelf controller.
Serial #
The serial number for the shelf controller. The serial number is different for each
shelf controller and differs from the enclosure Serial number.
Part #
The part number for the shelf controller.
Status
The current status of the shelf controller.
Type
The type of shelf controller.

enclosure show cpus [enclosure]

Display CPU information, such as the number of CPUs, type, and speed.
enclosure show fans [enclosure]

enclosure show 85
enclosure

Display the current status of fans in all enclosures, or in a specific enclosure.

Output Definitions
Enclosure
The enclosure number, starting from 1, for the Data Domain system.
Description
The ID for each power or cooling unit.
Level
The fan speed. This value depends on the internal temperature and amount of
cooling required.
Status
The fan status: OK or Failed.

enclosure show io-cards [enclosure]

Display information on device names, firmware revision, interface, slot and ports.
enclosure show memory [enclosure]
Show current and maximum DIMM inventory for head enclosure. Memory size is
calculated in base-2 Mib.
enclosure show nvram [enclosure]
Displays information previously displayed by the deprecated command option system
show NVRAM, including card number, component values (slot, memory size, errors,
battery charge). If output indicates one or more component errors, an alerts notification is
sent to the designated group and the Daily Alert Summary email includes an entry citing
details of problem.
enclosure show powersupply [enclosure]
Display the status of USAF power supplies in all enclosures or in a specific enclosure.
Identification corresponds to the labeled identifier on the power supply.
enclosure show summary
List enclosures, model and serial numbers, state, OEM names and values, and capacity
(number of disks in the enclosure). The serial number for an expansion shelf is the same
as the chassis serial number, which is the same as the enclosure WWN and the OPS
panel WWN.
Enclosure states may be one of the following:
Offline
No connectivity to shelf. Shelf was connected previously. Also occurs if there is no
power to the enclosure following startup).
Online
Operating as expected. No problems detected.
Fault
Applies to ES20 only. Indicates no communication with firmware.
Found
Transient state. Enclosure detected (though not seen by user) and will transition to
other states.
Error
Hardware or software error.
Software Error
Typically means busy. Try again later.

enclosure show temperature-sensors [enclosure]

86 EMC Data Domain Operating System 5.4 Command Reference Guide

 enclosure

List the internal and CPU chassis temperatures for a system, and the internal temperature
for expansion shelves. CPU temperatures may be shown in relative or ambient readings.
The CPU numbers depend on the Data Domain system model. With newer models, the
numbers are negative when the status is OK and move toward zero as CPU temperature
increases. If a CPU temperature reaches 0 degrees Celsius, the Data Domain system
shuts down. With older models, the numbers are positive. If the CPU temperature reaches
80 Celsius, the Data Domain system shuts down. A status of Critical indicates the
temperature is above the shutdown threshold.
enclosure show topology
Show the layout of the SAS enclosures attached to a system.

enclosure test
enclosure test topology port duration minutes
Test the connections in the enclosure topology.

enclosure test 87
enclosure

88 EMC Data Domain Operating System 5.4 Command Reference Guide

CHAPTER 13
filesys

The filesys command displays statistics, capacity, status, and use of the filesystem.
Command options also clear the statistics file, and start and stop filesystem processes.
The filesys clean command options reclaim physical storage within the filesystem.
Command output for disk space or the amount of data on disks is computed using base-2
calculations. See the EMC Data Domain Operating System Administration Guide for details.
The filesys archive command option is specific to a Data Domain system with
Extended Retention, and enables administrative users to provision the filesystem with
tiered storage. See the EMC Data Domain Operating System Administration Guide for details
on command usage and examples.
This chapter contains the following topics:

l filesys Change History........................................................................................... 90

l filesys Guidelines and Restrictions........................................................................ 90
l filesys archive....................................................................................................... 90
l filesys clean.......................................................................................................... 90
l filesys create.........................................................................................................92
l filesys destroy....................................................................................................... 93
l filesys disable....................................................................................................... 93
l filesys enable........................................................................................................93
l filesys encryption.................................................................................................. 93
l filesys expand....................................................................................................... 97
l filesys fastcopy..................................................................................................... 97
l filesys option........................................................................................................ 98
l filesys restart...................................................................................................... 100
l filesys show........................................................................................................ 100
l filesys status.......................................................................................................103
l filesys sync......................................................................................................... 103

filesys 89
filesys

filesys Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 14 filesys Change History

Version Change
5.4 No changes from previous version.

filesys Guidelines and Restrictions

l Unless otherwise noted, command options are available only to users with admin
role permissions.
l In addition to admin permissions, command options for encryption require security
officer authorization.

filesys archive
filesys archive unit add
Create a retention unit from the retention tier of the filesystem, change the state of disks
or LUNs from Available to In Use, and add the new retention unit to the filesystem. Also
view the list of retention unit sizes available in the retention tier.
filesys archive unit del archive-unit
Delete a specific retention unit and change the state of disks or LUNs to available. A
retention unit can be deleted from the tier only when the Data Domain system filesystem
is disabled. Disabling the filesystem stops all Data Domain system operations, including
filesys clean.
This command destroys all data in the retention unit. Files within the retention unit must
be deleted to remove them from the namespace.

Note

This command option is not available on a Retention Lock Compliance system.

filesys archive unit expand archive-unit
Expand the size of the specified retention unit. A sealed archive unit cannot be
expanded.
filesys archive unit list [archive-unit | all]
List all retention units or a specific retention unit.
filesys archive unit unseal [archive-unit-name]
Unseals the last sealed unit and only works when there is no target unit. This command
can only be run when the file system is offline. Role required: admin.

filesys clean
filesys clean reset {schedule | throttle | all}

90 EMC Data Domain Operating System 5.4 Command Reference Guide

 filesys

Reset the clean schedule to the default of Tuesday at 6 a.m. (tue 0600), the default
throttle of 50 percent, or both.
filesys clean set schedule { never | daily time | <day(s)> time
| biweekly daytime | monthly <day(s)> time }
Set schedule for the clean operation to run automatically. Data Domain recommends
running the clean operation once a week to maintain optimal availability of the
filesystem. However, if there is no shortage of disk space you may clean less often.
Argument Definitions
never
Turn off the clean schedule.
daily
Run command every day at the set time.
time
Time is 24-hour format and must be specified by four digits. The time mon 0000 is
midnight between Sunday night and Monday morning. 2400 is not a valid time. A
new set schedule command cancels the previous setting.
biweekly
Run command on alternate weeks. Bi-weekly cleaning is recommended for file
migration on systems with Extended Retention.
monthly
Starts command on the day or days specified at the set time. Days are entered as
integers from 1 to 31.
day(s)
Runs on the day or days specified. Days are entered as integers from 1 to 31.

Example 29

To run the clean operation automatically every Tuesday at 4 p.m.:

# filesys clean set schedule tue 1600

Example 30

To set filesystem cleaning to run on alternate Tuesdays at 6:00 a.m., enter:

# filesys clean set schedule biweekly "tue" "06:00"

Example 31

To run the operation more than once in a month, set multiple days in a single command.
For example, to clean the filesystem on the first and fifteenth day of the month at 4 p.m.,
enter:

# filesys clean set schedule monthly 1,15 1600

filesys clean set throttle percent

Set clean operations to use a lower level of system resources when the Data Domain
system is busy. At zero percent, cleaning runs slowly or not at all, depending on how busy
the system is.

filesys clean 91
filesys

At 100 percent, cleaning uses system resources in the standard way. Default is 50
percent. When the Data Domain system is not running backup or restore operations,
cleaning runs at 100 percent.

Example 32

To set the clean operation to run at 30 percent of its potential speed:

# filesys clean set throttle 30

filesys clean show config

Display settings for filesystem cleaning. All users may run this command option.
filesys clean show schedule
Display current date and time for the clean schedule. All users may run this command
option.
filesys clean show throttle
Display throttle setting for cleaning. All users may run this command option.
filesys clean start
Start clean process manually. When the process finishes, a message is sent to the
system log citing the percentage of available storage space.
filesys clean status
Display status of the clean process. All users may run this command option.
filesys clean stop
Stop the clean process. Stopping the process means all progress is lost. Restarting the
process means starting from the beginning.
If the clean process slows down the system, run the filesys clean set throttle
command to change the amount of system resources used by the clean process. Changes
to system resource usage take effect immediately.
filesys clean watch
Monitor the filesys clean process. Output of this command continuously updates as
the filesys clean operation progresses. For example, output of verification phase
shows the actual number of files moved to the target. Reporting concludes after the final
phase.
Press Ctrl-C to stop monitoring. Note the filesys clean process continues to run. All
users may run this command.

Note

Because some files may be dropped during verification, output of the percent completion
phase may not reach 100 percent. This is expected behavior.

filesys create
filesys create
Create a filesystem or associated RAID disk group with available and spare storage in the
active tier. Change the state from Available to In Use.

92 EMC Data Domain Operating System 5.4 Command Reference Guide

 filesys

filesys destroy
filesys destroy [and-zero]
Delete all data in the Data Domain system filesystem including data configured with
Retention Lock Governance, remove Replicator configuration settings, and return
filesystem settings to defaults. When this process is finished, NFS clients connected to
the Data Domain system may require a remount.

Note

This command option is not available on a Retention Lock Compliance system.

By default, this command only marks the filesystem data as deleted. Disks are not
overwritten with zeroes unless you specify the and-zero option. Filesystem data marked
deleted cannot be recovered, even if the disks have not been overwritten with zeroes. The
and-zero option adds several hours to the destroy operation. It is not supported on
Data Domain gateway systems.

filesys disable
filesys disable
Stop filesystem operations.

filesys enable
filesys enable
Start the filesystem operations. On systems configured with Retention Lock Compliance,
security officer authorization is required if there is time skew in the system clock. See the
section on Retention Lock Compliance in the EMC Data Domain Operating System
Administration Guide for details.

filesys encryption
filesys encryption algorithm reset
Reset the algorithm to the default: aes_256_cbc. After running this command, you must
restart the filesystem with the filesys restart command option.
filesys encryption algorithm set {aes_128_cbc | aes_256_cbc |
aes_128_gcm | aes_256_gcm}
Select the encryption algorithm. After running this command, you must restart the
filesystem with the filesys restart command option.
The aes_256_gcm option (AES in the Galois/Counter mode), is the most secure
algorithm, but is significantly slower than Cipher Block Chaining (CBC) mode.
filesys encryption algorithm show
Display encryption algorithm. Output indicates changes are pending, if applicable.
filesys encryption apply-changes
Update filesystem with current encryption configuration. Encryption changes are applied
to all data in the Data Domain system during the next cleaning cycle.
filesys encryption disable

filesys destroy 93
filesys

Deactivate encryption. Before running this command, disable the filesystem (filesys
disable). After running this command, restart the filesystem (filesys restart).
Changes take effect after the filesystem is restarted. This command requires security
officer authorization.
Log in as a security role. If necessary, create a security officer role.
Enter:
# authorization policy set security-officer enabled

filesys encryption embedded-key-manager keys create

Create a new key. An alert is raised when the new key is generated. This command
requires security officer authorization.
filesys encryption embedded-key-manager reset key-rotation-
policy
Reset key rotation policy of the embedded key manager. The reset command option
resets the key rotation policy to none, and new keys are not created automatically. The
new key takes effect after the filesystem is restarted. This command requires security
officer authorization.
filesys encryption embedded-key-manager set key-rotation-policy
{months | none}
Set the key rotation policy of the embedded key manager. The embedded key manager
supports a maximum of 254 keys. This command requires security officer authorization.
The argument months is an integer between 1 and 12, which is the key rotation period.
Each rotation creates a new key, which takes effect after the filesystem is restarted. If
specifying none, the results are the same as those of the command option filesys
encryption embedded-key-manager reset key-rotation-policy.
filesys encryption embedded-key-manager show
Show configuration of the embedded key manager.
filesys encryption enable
Activate encryption for new data written to the filesystem. After running this command,
you must restart the filesystem with the filesys restart command.
filesys encryption key-manager disable
Disable the key rotation policy. The filesystem continues to use the latest Activated-RW
key for encrypting the data. This command option requires security officer authorization.
Log in as a security role. If necessary, create a security officer role.
Enter:
# authorization policy set security-officer enabled

filesys encryption key-manager enable

Enable key management. The RSA Data Protection Manager (DPM) key manager is
available for external encryption key management. The local encryption key
administration method is also available.
As in previous releases, the local key manager provides a single encryption key for each
Data Domain system. The RSA DPM Key Manager enables the use of multiple, rotating
keys on a Data Domain system. DPM supports a maximum of 254 keys. See the EMC Data
Domain Operating System Administration Guide for additional information.
filesys encryption key-manager reset
Clear the attributes of the key-manager.
filesys encryption key-manager set {server server-name | port
port-number | fips-mode {enabled | disabled} | key-class key-

94 EMC Data Domain Operating System 5.4 Command Reference Guide

 filesys

class | server server-name port port-number fips-mode {enabled

| disabled} key-class key-class}
Specify the attributes of the key-manager. RSA Data Protection Manager (DPM) supports
three attributes of a Key Class Cipher including Algorithm, Key Size, and Mode. When
setting up a Key Class in RSA DPM for use with a Data Domain system, the key size must
be 256 bits, otherwise the DPM configuration will fail.
Additionally, Data Domain does not use the attributes Algorithm and Mode from RSA
DPM. These attributes are configured using the command option: filesys
encryption algorithm set {aes_128_cbc | aes_256_cbc |
aes_128_gcm | aes_256_gcm}.

Note

A Data Domain system retrieves a key from RSA DPM by Key Class. Choices for the RSA
DPM attribute Get Key Behavior of a Key Class are New Key Each Time or Use Current
Key. In this release, Data Domain supports the Key Class Use Current Key only. An
error message is not issued if the Key Class is incorrectly configured to generate a new
key each time; however, the Data Domain system does not receive the correct key to
encrypt the data.

Argument Definitions
server
The name of the RSA DPM key manager server or IP address.
port
The port number of the RSA server on which the key manager is listening.
fips-mode
Use the argument disabled if the imported certificate for key management is not in
FIPS mode. Default is enabled.
key-class
The Key Class configured on the key manager for the Data Domain system.

Note

Key Class name must be enclosed in single or double quotes if the name contains special
characters, such as a comma or a space.
filesys encryption key-manager show
Display details about the key manager. See the EMC Data Domain Operating System
Administration Guide for descriptions of key states.
filesys encryption keys delete keyid
Delete the key from the filesystem after the number of keys has exceeded 254. Only a
Destroyed-Compromised key or a Destroyed key can be deleted. This command option
requires security officer authorization.
Log in as a security role. If necessary, create a security officer role.
Enter:
# authorization policy set security-officer enabled

filesys encryption keys destroy keyid

Destroy the specified encryption key if all data encrypted with the key requires re-
encryption. After the key is destroyed, the key is no longer used for reading or writing.
This command option requires security officer authorization.
filesys encryption keys export

filesys encryption 95
filesys

Export encryption keys. All encryption keys in the filesystem are exported to a file that can
recover encryption keys in the system if required. The key file is passphrase encrypted
and you will be prompted for a passphrase. To protect the key file, you may enter a new
passphrase that differs from the Data Domain system passphrase. Lost or forgotten
passphrases cannot be recovered. This command option requires security officer
authorization.
EMC recommends using this command option when a new key is created or when a
change of the state occurs to any of the existing keys. EMC also recommends sending the
exported file via FTP for storage in a secure location, accessible to authorized users only.
filesys encryption keys show [keyid]
Display the details of an encryption key. This command options require security officer
authorization.
Log in as a security role. If necessary, create a security officer role.
Enter:
# authorization policy set security-officer enabled

filesys encryption keys sync

Synchronize the key manager encryption keys. An alert is generated if a new key is
detected. When the filesystem is restarted, the new key is used for reading and writing.
A key that is destroyed in RSA DPM will not be marked for destroyed on the Data Domain
system. See the EMC Data Domain Operating System Administration Guide for details on
how to destroy a key.

Note

A Data Domain system retrieves a key from RSA DPM by Key Class. Choices for the RSA
DPM attribute Get Key Behavior of a Key Class are New Key Each Time or Use Current
Key. In this release, Data Domain supports the Key Class Use Current Key only. An
error message is not issued if the Key Class is incorrectly configured to generate a new
key each time; however, the Data Domain system does not receive the correct key to
encrypt the data.
filesys encryption lock
Before locking the system, verify there are no keys in a compromised state. For security
purposes, EMC Data Domain recommends performing a filesystem clean procedure first.
Lock the system by creating a new system passphrase and destroying the cached copy of
the current passphrase. There is only one passphrase for the Data Domain system. Before
you run this command, you must disable the filesystem (filesys disable). This
command option requires security officer authorization.
Log in as a security role. If necessary, create a security officer role.
Enter:
# authorization policy set security-officer enabled

After running this command, the system encryption keys are unrecoverable until the
system is unlocked with the system passphrase. This command is useful when preparing
a Data Domain system and its external storage devices for shipment.
A new system passphrase is not stored and can be forgotten. EMC Data Domain
recommends keeping a record of the passphrase in a safe location. Data cannot be
recovered without the new passphrase.
filesys encryption show
Check the status of the encryption feature.

96 EMC Data Domain Operating System 5.4 Command Reference Guide

 filesys

Example 33 (Encryption enabled. No key-manager configured.)

# filesys encryption show

The filesystem is unlocked
Algorithm: aes_256_cbc
Key manager in use: Embedded Key Manager
Key rotation period: not-configured
Last key rotation date: N/A
Next key rotation date: N/A

Example 34 (Key rotation policy set for embedded key manager.)

# filesys encryption show

Encryption is enabled
The filesystem is unlocked
Algorithm: aes_256_cbc
Key manager in use: Embedded Key Manager
Key rotation period: 2 months
Last key rotation date: N/A
Next key rotation date: 01:01:00 11/04 2012

Example 35 (RSA DPM Key Manager configured and enabled.)

# filesys encryption show

Encryption is enabled
The filesystem is unlocked
Algorithm: aes_256_cbc
Key manager in use: RSA Key Manager
Server: dpmsrv1.mydomain.com
Port: 443
Fips-mode: enabled
Status: Online
Key-class: TestKeyClass1

filesys encryption unlock

The filesystem is locked automatically after a headswap or chassis swap. Use this
command option to unlock the filesystem.

filesys expand
filesys expand
Increase the filesystem by using all space in the active tier.

filesys fastcopy
filesys fastcopy source src destination dest
Copy a file or directory tree from a Data Domain system source directory to another
destination on the Data Domain system.
Source names src that include spaces or special characters must be entered according to
the following conventions.
l Enclose the entire source pathname with double quotation marks:
filesys fastcopy source "/data/col1/backup/.snapshot/fast copy"
destination /data/col1/backup/dir
OR

filesys expand 97
filesys

l Enter a backslash before the space. Do not add quotation marks:

filesys fastcopy source /data/col1/backup/.snapshot/fast\ copy
destination /data/col1/backup/dir2

Argument Definitions
source src
The location of the directory or file to copy. The first part of the path must be data/
col1/.
destination dest
The destination for the directory or file being copied. The destination cannot already
exist.

filesys option
filesys option disable report-replica-as-writable
Set the reported read/write status of a replication destination filesystem to read-only.
Use the filesys disable command before changing this option and use the
filesys enable command after changing the option.
With CIFS, use the cifs disable command before changing the option and use the
cifs enable command after changing the option.
filesys option enable report-replica-as-writable
Set the reported read/write status of a replication destination filesystem to read/write.
Use the filesys disable command before changing this option and use the
filesys enable command after changing the option.
With CIFS, use the cifs disable command before changing the option and use the
cifs enable command after changing the option.
filesys option reset {local-compression-type | low-bw-optim |
marker-type | report-replica-as-writable | global-compression-
type | staging-reserve | staging-clean | staging-delete-suspend
| compute-segfeatures | app-optimized-compression}
Return filesystem compression to the default settings on the destination Data Domain
system.
Argument Definitions
local-compression-type
Reset the compression algorithm to the default of lz.
low-bw-optim
Reset low-bandwidth optimization to the default of auto.
marker-type
Return the marker setting to the default of auto.
report-replica-as-writable
Reset the filesystem to read-only.
global-compression-type
Remove a manually set global compression type. The filesystem continues to use the
current type. Only when a filesys destroy command is entered does the type
used change to the default of 9.
staging-reserve
Set staging reserve percentage from 0 to 90.

98 EMC Data Domain Operating System 5.4 Command Reference Guide

 filesys

app-optimized-compression
Reset the data-specific compression optimizations to none.

filesys option set global-compression-type {1 | 9}

Set the global compression of data to type 9 (new type) or type 1 (previous type). Enter
the filesys disable and filesys enable commands for the change to take
effect. If the filesystem is over 40 percent full, the command fails with an error message.
Compression type must be the same on each side of a directory replication pair. If not,
replication stops.

Example 36

# filesys option set global-compression-type 1

# filesys disable
# filesys enable

filesys option set local-compression-type {none | lz | gzfast |

gz}
Set compression algorithm. To enable the new setting, use the filesys disable and
filesys enable command options.
If local compression is changed from the default value of lz, the change is applied only to
new data and data accessed during subsequent clean operations. The system transitions
to the new compression type as backups expire. This behavior reduces overhead of the
cleaning process.
Argument Definitions
none
No data compression occurs.
lz
The default algorithm that gives the best throughput. Data Domain recommends the
lz option.
gzfast
A zip-style compression that uses less space for compressed data, but more CPU
cycles. gzfast is the recommended alternative for sites that want more
compression at the cost of lower performance.
gz
A zip-style compression that uses the least amount of space for data storage (10%
to 20% less than lz), but also uses the most CPU cycles (up to twice as many as
lz).

filesys option set staging-reserve percent

Reserve a percentage of total disk space for disk staging.
filesys option show [local-compression-type | low-bw-optim |
marker-type | report-replica-as-writable | global-compression-
type | staging-reserve | staging-clean | staging-delete-suspend
| compute-segfeatures | app-optimized-compression]
Show the filesystem option settings. By default, all filesystem options are displayed. To
limit the output to a single system option, specify one of the system options.
Argument Definitions
local-compression-type
Display the current compression algorithm.

filesys option 99
filesys

low-bw-optim
Display if low-bandwidth optimization is enabled.
marker-type
Display the current marker setting.
report-replica-as-writable
Display the current reported setting on the destination Data Domain system.
global-compression-type
Display the current global compression type.
staging-reserve
Set staging reserve percentage from 0 to 90.
app-optimized-compression
Display which data-specific compression optimizations are enabled.

filesys restart
filesys restart
Disable and enable the filesystem in a single operation.

filesys show
filesys show compression [filename] [last n {hours | days}]
[no-sync]
filesys show compression [tier {active | archive}] summary |
daily | daily-detailed {[last n { hours | days | weeks |
months }] | [start date [end date]]}
These two command options display the space used by, and compression achieved for,
files and directories in the filesystem. When run on a Data Domain system with Extended
Retention, information is also shown for the active or retention tiers. Values are reported
in Gigibytes (GiB). See the EMC Data Domain Operating System Administration Guide for
details.
In general, the more often a backup procedure is run on a file or filesystem, the higher the
compression. The output does not include global and local compression factors for the
Currently Used table, but uses a dash instead. Output for a busy system may not return
for several hours, depending on the number of files. Other factors may influence the
output display.
Running the command without arguments generates default output that shows a
summary of compression statistics for all files and directories in the filesystem for the
last 7 days and the last 24 hours. Output includes details on active and retention tiers for
systems with Extended Retention only.
Argument Definitions
filename (Optional)
Synchronize all modified files to disk and then display compression statistics for the
specified file or directory only. To display compression statistics for a specific file or
directory without first synchronizing all modified files to disk, include the no-sync
option.
Depending on the number of files in the filesystem, specifying a file name could
cause this command to process for several hours before completing.

100 EMC Data Domain Operating System 5.4 Command Reference Guide
 filesys

last n {hours | days | weeks | months} (Optional)

In the summary portion of the output, display filesystem compression statistics for
the specified time frame instead of the past 7 days. The statistics for the last 24
hours remain in the summary output. If you specify a file or directory name, you
cannot use this option with the weeks keyword or the months keyword.
no-sync (Optional)
Display compression statistics for a specific file or directory without first
synchronizing all modified files to disk.
summary (Optional)
Display all compression statistics, summarized in the following categories:
l Storage currently used.
l Data written in the last 7 days. By including the last n option or the start date
option, you can display statistics for a different time frame.
l Data written in the last 24 hours.

daily (Optional)
In addition to the summary output, display the following information for each day,
over the previous four full weeks, plus the current partial week. This option is not
available if you specify a file or directory name.
daily-detailed (Optional)
Display the daily output, but also include the following information for each day.
This option is not available if you specify a file or directory name.
start date (Optional)
In the summary portion of the output, display filesystem compression statistics for
the time frame that begins on the specified day instead of the past 7 days. The
statistics for the last 24 hours remain in the summary output. If you specify a time
frame less than the previous 4 weeks, plus the current full week, the daily or daily-
detailed output (if specified) is truncated to the shorter time frame.
Specify date in the format yyyy-mm-dd. By default, the last day of the time frame
specified with this argument is the most recent, full day elapsed.
end date (Optional)
Valid only if the start option is used. In the summary portion of the output, display
filesystem compression statistics for the time frame that ends on the specified day.
In general, the more often a backup is done for a particular file or filesystem, the
higher the compression. On a busy system, this process may not complete for
several hours, depending on the number of files. Other factors may also affect
results.
On a standard Data Domain system, output includes information on active tier only.

Output Definitions
Pre-Comp
Data written before compression.
Post-Comp
Storage used after compression.
Global-Comp Factor
Ratio of Pre-Comp / (size after global compression). Not applicable to the storage
currently used.
Local-Comp Factor
Ratio of (size after global compression)/Post-Comp. Not applicable to the storage
currently used.

filesys show 101

filesys

Total-Comp Factor
Ratio of Pre-Comp / Post-Comp.
Reduction %
Percentage value (Pre-Comp - Post-Comp) / Pre-Comp) * 100. This is the default
output format.

filesys show file-info filename

Display detailed information about the specified file. Specify the fully qualified path to
the file.
filesys show space
Display the space available to and used by filesystem resources. Values are reported in
Gigibytes (GiB).
Output Definitions
Size GiB
Total storage capacity of a filesystem resource.
Used GiB
Amount of data stored on a filesystem resource.
Avail GiB
Amount of free space on a filesystem resource.
Use%
Ratio of data stored to total capacity, multiplied by 100.
Cleanable GiB
Estimated amount of recoverable free space. Command output displays space
availability and usage information for the following filesystem components:
/data: pre-comp
Amount of virtual data stored on the Data Domain system. Virtual data is the amount
of data sent to the Data Domain system from backup servers.
/data: post-comp
Amount of total physical disk space available for data, actual physical space used
for compressed data, and physical space still available for data storage. Warning
messages go to the system log and an email alert is generated when the Use% figure
reaches 90%, 95%, and 100%. At 100%, the Data Domain system stops accepting
data from backup servers.
/ddvar
Approximate amount of space used by and available to the log and core files. To free
space in this area, remove old logs and core files.
The total amount of space available for data storage can change because an internal
index may expand as the Data Domain system fills with data. The index expansion
takes space from the Avail GiB amount.
If Use% is always high, use the command option filesys clean show-
schedule to see how often the cleaning operation is scheduled to run
automatically. Use filesys clean schedule to run the operation more often.

filesys show uptime

Display the amount of time passed since the filesystem was last enabled. The display is
in days, hours, and minutes.

102 EMC Data Domain Operating System 5.4 Command Reference Guide
 filesys

filesys status
filesys status
Display the state of the filesystem process. If the filesystem was shut down with a Data
Domain system command, such as filesys disable, the output display includes the
command name in square brackets.

filesys sync
filesys sync
Synchronize modified files to disk.

filesys status 103

filesys

104 EMC Data Domain Operating System 5.4 Command Reference Guide
CHAPTER 14
help

The Command Line Interface (CLI) displays two types of help, syntax-only help and
command-description help that includes the command syntax.
The following guidelines describe how to use syntax-only help.
l To list the top-level CLI commands, enter a question mark (?), or type the command
help at the prompt.
l To list all forms of a top-level command, enter the command with no options at the
prompt or enter command ?.
l To list all commands that use a specific keyword, enter help keyword or ? keyword.
For example, ? password displays all Data Domain system commands that use the
password argument.
The following guidelines describe how to use command-description help.
l To list the top-level CLI commands, enter a question mark (?), or type the command
help at the prompt.
l To list all forms of a top-level command with an introduction, enter help command
or ? command.
l The end of each help description is marked END. Press Enter to return to the CLI
prompt.
l When the complete help description does not fit in the display, the colon prompt (:)
appears at the bottom of the display. The following guidelines describe what you can
do when this prompt appears.
n To move through the help display, use the up and down arrow keys.
n To quit the current help display and return to the CLI prompt, press q.
n To display help for navigating the help display, press h.
n To search for text in the help display, enter a slash character (/) followed by a
pattern to use as search criteria and press Enter. Matches are highlighted.

l help Change History............................................................................................ 106

l help Guidelines and Restrictions......................................................................... 106

help 105
help

help Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 15 help Change History

Version Change
5.4 No changes from previous version.

help Guidelines and Restrictions

l All users may run this command option.
l Use the up and down arrow keys to move through a help page.
l Press Tab to complete an entry.
l Use the q key to exit.
l Enter a forward slash to move forward and a question mark with a pattern to search
for and highlight lines of interest.

106 EMC Data Domain Operating System 5.4 Command Reference Guide
CHAPTER 15
ipmi

The ipmi command monitors and manages a Data Domain system deployed remotely.
Command options enable administrators to monitor remote systems and to power the
systems on or off as required. The Serial-Over-LAN (SOL) feature is used to view the serial
output of a remote system boot sequence. For more information, including the list of
supported models, see the EMC Data Domain Operating System Offline Diagnostics Suite
Users Guide.
This chapter contains the following topics:

l ipmi Change History............................................................................................ 108

l ipmi Guidelines and Restrictions......................................................................... 108
l ipmi config.......................................................................................................... 108
l ipmi disable........................................................................................................ 108
l ipmi enable.........................................................................................................108
l ipmi remote.........................................................................................................108
l ipmi reset............................................................................................................109
l ipmi show........................................................................................................... 109
l ipmi user.............................................................................................................109

ipmi 107
ipmi

ipmi Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 16 help Change History

Version Change
5.4 No changes from previous version.

ipmi Guidelines and Restrictions

l Unless otherwise noted, command options are available only to users with admin
role permissions.
l Users cannot log in to IPMI via SSH. See the EMC Data Domain Operating System
Administration Guide for instructions on managing remote systems.
l IPMI (on/off/cycle/status) and SOL are not supported on models DD140, DD610,
DD630, and DD2500.

ipmi config
ipmi config port {dhcp | ipaddress ipaddr netmask mask gateway
ipaddr}
Configure the IPMI static or dynamic IP address of a BMC-capable interface. If configuring
a static IP, you must provide the BMC IP address, netmask, and gateway address.

ipmi disable
ipmi disable {port | all}
Disable IPMI remote access to a single system, or all systems.

ipmi enable
ipmi enable {port | all}
Enable IPMI remote access to a single system, or to all systems.

ipmi remote
ipmi remote console ipmi-target <ipaddr | hostname> user user
Activate SOL mode to view serial console of a remote Data Domain system.
ipmi remote power {on | off | cycle | status} ipmi-target
<ipaddr | hostname> user user
Power on, power off, or power cycle a remote target system from an initiator system.

108 EMC Data Domain Operating System 5.4 Command Reference Guide
 ipmi

ipmi reset
ipmi reset
Reset LAN and SOL configuration and clear all IPMI users.

ipmi show
ipmi show config
View the configuration of local IPMI interfaces. Output includes the dynamic or static IP
address, gateway, netmask, and MAC address.
ipmi show hardware
View the port names and firmware version of the local BMC. Output also includes the IPMI
version, manufacturer, MAC addresses. The Link Status column shows if the LAN cable is
connected to the LAN-IPMI shared port.
Link status cannot be determined on Data Domain systems with a dedicated IPMI port.
These include models DD640, DD4200, DD4500, and DD7200.

ipmi user
ipmi user add user
Add new IPMI user.
ipmi user change user
Change the password of an IPMI user.
ipmi user del user
Delete an IPMI user.
ipmi user list
View a list of IPMI users, including names, IDs, and permissions.
ipmi user reset
Clear all IPMI users. If this is the first time using IPMI, we recommend running this
command to clear IPMI users who may be out of synch between two ports, and to disable
default users.

ipmi reset 109

ipmi

110 EMC Data Domain Operating System 5.4 Command Reference Guide
CHAPTER 16
license

The license command adds, deletes, and resets keys for licensed features and storage
capacity.
This chapter contains the following topics:

l license Change History........................................................................................ 112

l license Guidelines and Restrictions.....................................................................112
l license add......................................................................................................... 112
l license delete......................................................................................................112
l license reset........................................................................................................112
l license show....................................................................................................... 112

license 111
license

license Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 17 license Change History

Version Change
5.4 Global Deduplication Arrays are deprecated as of this release.

license Guidelines and Restrictions

l Unless otherwise noted, command options are available only to users with admin
role permissions.
l License codes are case-insensitive. Include the hyphens when entering codes.

license add
license add license-code [license-code ...]
Add one or more licenses for features and storage capacity. Include dashes when
entering the license code.

license delete
license del license-feature [license-feature ...] | license-
code [license-code ...]
Delete one or more licenses for features or storage capacity. Security officer authorization
is required to delete Retention Lock Compliance licenses.

license reset
license reset
Remove all licenses. Security officer authorization is required to delete Retention Lock
Compliance licenses.

license show
license show [local]
View license keys and features. If the local argument is included in the option, output
includes details on local node only.

112 EMC Data Domain Operating System 5.4 Command Reference Guide
CHAPTER 17
log

The log command manages and displays the Data Domain system log file. Messages
from the alerts feature, the autosupport reports, and general system messages are sent
to the log directory (/ddvar/log). A log entry appears for each Data Domain system
command given on the system.
Data Domain systems can send network log messages to other systems enabled to listen.
The Data Domain system sends the log in the standard syslog format. When remote
logging is enabled, all messages in the messages and kern.info files are exported.
Message selectors include:
*.notice
Send all messages at the notice priority and higher.
*.alert
Send all messages at the alert priority and higher (alerts are included in *.notice).
kern.*
Send all kernel messages (kern.info log files).
local7.*
Send all messages from system startups (boot.log files).

See the vendor-supplied documentation for details on managing the selectors and
receiving messages on a third-party system.

This chapter contains the following topics:

l log Change History.............................................................................................. 114

l log Guidelines and Restrictions........................................................................... 114
l log host...............................................................................................................114
l log list.................................................................................................................114
l log view...............................................................................................................116
l log watch............................................................................................................ 116
l log Additional Topics...........................................................................................116

log 113
log

log Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 18 log Change History

Version Change
5.4 No changes from previous version.

log Guidelines and Restrictions

Unless otherwise noted, command options are available only to users with admin role
permissions.

log host
log host add host
Add a system (remote log host) to the list that receives Data Domain system log
messages.

Note

If using three or more remote log hosts, they must be added by entering the IP address in
the host argument instead of the host name.
log host del host
Remove a system from the list of systems that receive Data Domain system log messages.
log host disable
Disable sending log messages to other systems.
log host enable
Enable sending log messages to other systems.
log host reset
Reset the log sending feature to the defaults of disabled and an empty list.
log host show
Display the list of systems that receive log messages and are in the state of enabled or
disabled.

log list
log list [debug]
List the files in the log directory with the date each file was last modified and the size of
each file.

114 EMC Data Domain Operating System 5.4 Command Reference Guide
 log

Output Definitions (Without Debug Option)

messages
The system log, generated from Data Domain system actions and general system
operations.
space.log
Messages about disk space usage by Data Domain system components and data
storage, and messages from the clean process. A space use message is generated
every hour. Each time the clean process runs, it creates approximately 100
messages. All messages are in comma-separated-value format with tags you can use
to separate the disk space or messages from the clean process. You can use third-
party software to analyze either set of messages. The tags are:
l CLEAN for data lines from clean operations.
l CLEAN_HEADER for lines that contain headers for the clean operations data
lines.
l SPACE for disk space data lines.
l SPACE_HEADER for lines that contain headers for the disk space data lines.

audit.log
List of log messages.

Output Definitions (With Debug Option)

access
Track users of the Data Domain System Manager graphical user interface.
boot.log
Kernel diagnostic messages generated during the boot process.
ddfs.info
Debugging information created by the filesystem processes.
ddfs.memstat
Memory debugging information for filesystem processes.
destroy.id_number.log
All actions taken by an instance of the filesys destroy command. Each instance
produces a log with a unique ID number.
disk-error-log
Disk error messages.
error
List errors generated by the Data Domain System Manager operations.
kern.error
Kernel error messages.
kern.info
Kernel information messages.
network
Messages from network connection requests and operations.
perf.log
Performance statistics used by Data Domain Support for system tuning.
secure
Messages from unsuccessful logins and changes to user accounts.
ssi_request
Messages from the Data Domain System Manager when users connect with HTTPS.

log list 115

log

windows
Messages about CIFS-related activity from CIFS clients attempting to connect to the
Data Domain system.

log view
log view [filename]
View the log files. When viewing the log, use the up and down arrows to scroll through
the file. Use the q key to quit. Enter a forward slash to search forward or a question mark
to search backward for a pattern such as a date. If filename is not included, the command
displays the current messages file.

log watch
log watch [filename]
View new message entries as they occur. Use Ctrl-C to stop the display. If a filename is
not included, the command displays the current messages file.

log Additional Topics

This section provides additional information on various topics and concepts.

Understanding a Log Message

Procedure
1. View the log file by entering the command options log view message, or log
view.
2. Look for the file of log messages. Descriptions of log messages are available on the
Support portal in the Error Message Catalog.
3. In the Web page of log messages, search for the message MSG-SMTOOL-00006. The
following information displays:
ID: MSG-SMTOOL-00006 - Severity: NOTICE - Audience: customer
Message: No replication throttle schedules found: setting throttle
to unlimited.
Description: The restorer cannot find a replication throttle
schedule. Replication is running with throttle set to unlimited.
Action: To set a replication throttle schedule, run the
replication throttle add command.
4. Follow the instructions indicated by Action: to correct the error.

Archiving Log Files

To archive log files, use NFS, CIFS mount, or FTP to copy the files to another machine. If
using CIFS or NFS, mount /ddvar to your desktop and copy the files from the mount
point.
If using FTP:
Procedure
1. On the Data Domain system, use the adminaccess show command to verify that
the FTP service is enabled. If the service is not enabled, use the command
adminaccess enable ftp.

116 EMC Data Domain Operating System 5.4 Command Reference Guide
 log

2. On the Data Domain system, enter adminaccess show to see that the FTP access list
includes the IP or class-C address of your remote machine. If not in the list, enter
adminaccess add ftp ipaddr to add the address.
3. Open a Web browser on the remote machine.
4. In the Address box, use FTP to access the Data Domain system:
ftp://Data_Domain_system_name.yourcompany.com/
5. Some Web browsers do not request a login if a system does not accept anonymous
logins. In that case, add a user name and password to the FTP line:
ftp://sysadmin:your-pw@
Data_Domain_system_name.yourcompany.com/
6. Log in to the Data Domain system as sysadmin.
7. On the Data Domain system, you are in the directory just above the log directory.
Open the log directory to list the messages files.
8. Copy the file to save. Right-click on the file icon and select Copy To Folder. Choose a
location for the file copy.
9. To disable the FTP service on the Data Domain system, use SSH to log in to the Data
Domain system as sysadmin and run the command option adminaccess disable
ftp.

Archiving Log Files 117

log

118 EMC Data Domain Operating System 5.4 Command Reference Guide
CHAPTER 18
migration

The migration command copies all data from one Data Domain system to another. Use
this command when upgrading to a larger capacity Data Domain system. Migration is
typically performed in a LAN environment.
Migration may also be used to copy replication configurations, known as contexts. See
the EMC Data Domain Operating System Administration Guide for instructions.
This chapter contains the following topics:

l migration Change History.................................................................................... 120

l migration Guidelines and Restrictions................................................................. 120
l migration abort................................................................................................... 120
l migration commit................................................................................................ 121
l migration receive................................................................................................ 121
l migration send.................................................................................................... 121
l migration show stats...........................................................................................123
l migration status.................................................................................................. 123
l migration watch.................................................................................................. 123
l Examples............................................................................................................ 123

migration 119
migration

migration Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 19 migration Change History

Version Change
5.4 No changes from previous version.

migration Guidelines and Restrictions

l Unless otherwise noted, command options are available only to users with admin
role permissions.
l All data under /backup is migrated and exists on both systems after migration.
l After migrating replication contexts, the contexts remain on the source. You must
break replication contexts on the migration source after the process is completed.
l For best results, avoid backup operations to a migration source during a migration
operation.
l A migration destination does not require a replication license or encryption license
unless the source system is licensed for those software options.
l With the exception of collection replication, the migration destination must have
equal or larger capacity than the used space on the migration source.
l The migration destination must have an empty filesystem.
l Any setting of the systems replication throttle also applies to migration. If the
migration source has throttle settings, use the replication throttle set
override command to set the throttle to the maximum (unlimited) before starting
migration.
l The procedure for migrating from an encryption-enabled source requires additional
steps.

migration abort
migration abort
Stop a migration process and return the Data Domain system to its previous state. If the
migration source is part of a replication pair, replication is restarted. Run the command
option on the migration source and destination.
Using the migration abort command option on a destination system requires
running the filesys destroy command option on the destination before the
filesystem can be reenabled.
Following a migration abort procedure the password on the destination system is the
same as the password on the migration source.

120 EMC Data Domain Operating System 5.4 Command Reference Guide
 migration

migration commit
migration commit
Limit migration to data received by the source at the time the command is entered. You
can enter the command and limit the migration of new data any time after entering the
migration send command. After the commit operation, all data on the source Data
Domain system, including new data for contexts migrated to the destination, is sent only
to the destination.
Write access to the source is blocked after you enter the migration commit command and
during the time required to complete migration. After the migration process is finished,
the source is opened for write access, but new data is not migrated to the destination.

migration receive
migration receive source-host src-hostname
Prepare a Data Domain system to be a migration destination. When preparing the
destination, do not run the filesys enable command.
Run this option under the following conditions:
l On the migration destination only.
l Before entering the migration send command on the migration source.
l After running the filesys destroy and filesys create operations on the
destination.

Example 37

To prepare a destination for migration from the source hostA:

# filesys destroy
# filesys create
# migration receive source-host hostA

migration send
migration send {obj-spec-list | all} destination-host dst-
hostname
Start migration.
Use the command option under the following conditions:
l Only on the migration source.
l Only when no backup data is being sent to the migration source.
l After entering the migration receive command on the destination.
The obj-spec-list is /backup for systems that do not have a replication license. With
replication, this argument represents one or more contexts from the migration source.
After you migrate a context, all data from the context remains on the source system, but
the context configuration is moved to the migration destination.
A context in the obj-spec-list can be:
l The destination string, as defined when setting up replication. For example:

migration commit 121

migration

dir://hostB/backup/dir2col://hostBpool://hostB/pool2
l The context number, such as rctx://2, as shown in output from the
replication status command option.
l The keyword all, which migrates all contexts from the migration source to the
destination.
New data written to the source is marked for migration until you enter the migration
commit command. New data written to the source after a migration commit
command is not migrated. Note that write access to the source is blocked from the time a
migration commit command is given until the migration process concludes.
The migration send command stays open until a migration commit command is
entered. Enter the migration commit command on the migration source first, and
then on the destination.

Note

After the migration send command is entered, the migration source remains in read-
only mode until all contexts are synchronized. To avoid the time spent in this mode, EMC
recommends synchronizing the replication contexts before issuing the migration
send command. Enter replication sync to synchronize replication contexts. Enter
migration send immediately after the synchronization process concludes.

With the exception of licenses and key-manager settings, all data on the migration source
is always migrated, even when a single directory replication context is specified in the
command option.

Example 38

To start migration of data only (excluding replication contexts, even if replication contexts
are configured) to a migration destination named hostC:

# migration send /backup destination-host hostC

Example 39

To start a migration that includes a collection replication context (replication destination

string) of col://hostB:

# migration send col://hostB destination-host hostC

Example 40

To start migration with a directory replication context of dir://hostB/backup/

dir2:

# migration send dir://hostB/backup/dir2 destination-host hostC

Example 41

To start migration with two replication contexts using context numbers 2 and 3:

122 EMC Data Domain Operating System 5.4 Command Reference Guide
 migration

Example 41 (continued)

# migration send rctx://2 rctx://3 destination-host hostC

Example 42

To migrate all replication contexts:

# migration send all destination-host hostC

migration show stats

migration show stats
Display migration statistics during the migration process.
Output Definitions
Bytes Sent
The total number of bytes sent from the migration source. The value includes backup
data, overhead, and network overhead. On the destination, the value includes
overhead and network overhead. Use the value (and the next value, Bytes Received)
to estimate network traffic generated by migration.
Bytes Received
The total number of bytes received at the destination. On the destination, the value
includes data, overhead, and network overhead. On the source, the value includes
overhead and network overhead. Use the value (and the previous value) to estimate
network traffic generated by migration.
Received Time
The date and time when the most recent records were received.
Processed Time
The date and time when the most recent records were processed.

migration status
migration status
Display the status of migration at the time the command is run.

migration watch
migration watch
Track the initial phase of migration (when write access is blocked). The command output
shows the percentage of the migration process that has been completed.

Examples
Preparing for Migration
If the migration source has encryption enabled, you must perform the following tasks on
the destination before starting the migration process.

migration show stats 123

migration

Procedure
1. Add the encryption license:
# license add license-code
2. Enable encryption. This command prompts you for a passphrase. Use the same
passphrase as the migration source:
# filesys encryption enable
3. After running the encryption enable command, restart the filesystem:
# filesys restart

After you finish

If the migration source has DPM key manager configured and enabled, clear the DPM
attributes on the destination:
# filesys disable
# filesys encryption key-manager reset
# filesys restart

After migration concludes, configure the DPM attributes on the destination to be the
same as the DPM attributes on the migration source, and then enable the DPM key
manager.
See the commands filesys encryption key-manager enable on page 93 and
filesys encryption key-manager set on page 93 for more information.

Migrating Data (Does Not Apply to Replication Contexts)

To migrate data from hostA, to a destination, hostB:
Procedure
1. On hostB (the destination), enter:
# filesys disable
# filesys destroy
# filesys create
# migration receive source-host hostA
2. On hostA (the source), enter:
# migration send /backup destination-host hostB
3. On either host, enter:
# migration watch
4. At the appropriate time for your site, create a migration end point. Note that three
phases of migration may take many hours. During that time, new data sent to the
source is also marked for migration.
5. After the three migration phases are finished, enter the following command on hostA
first, and then on the destination, hostB:
# migration commit

Migrating Data and a Context

To migrate data and a context from a source, hostA, to a destination, hostC, when hostA
is also a directory replication source for hostB.
Procedure
1. On hostC (the migration destination), enter:
# filesys disable
# filesys destroy

124 EMC Data Domain Operating System 5.4 Command Reference Guide
 migration

# filesys create
# migration receive source-host hostA
2. On hostA (the migration and replication source), enter:
# migration send dir://hostB/backup/dir2 destination-host hostC
l Note that this command also disables the filesystem.
3. On the source migration host, enter:
# migration watch
4. First on hostA and then on hostC, enter:
# migration commit
l Note that this command also disables the filesystem.
5. On hostB (the replication destination), enter the following command options to
change the replication source to hostC:
# filesys disable
# replication modify dir://hostB/backup/dir2
source-host hostC
# filesys enable

Migrating Data and a Context 125

migration

126 EMC Data Domain Operating System 5.4 Command Reference Guide
CHAPTER 19
mtree

The mtree command enables operations on a single managed tree (MTree) of a

filesystem. An MTree is a logical partition of the namespace in the file system that can
group together a set of files for management purposes; for example, snapshot schedules,
replication, or retention locking.
This chapter contains the following topics:

l mtree Change History.......................................................................................... 128

l mtree Guidelines and Restrictions....................................................................... 128
l mtree create........................................................................................................128
l mtree delete........................................................................................................129
l mtree list.............................................................................................................129
l mtree rename......................................................................................................130
l mtree retention-lock............................................................................................130
l mtree show compression.................................................................................... 132
l mtree undelete....................................................................................................133

mtree 127
mtree

mtree Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 20 mtree Change History

Version Change
5.4 No changes from previous release.

mtree Guidelines and Restrictions

l Unless otherwise noted, command options are available only to users with admin
role permissions.
l A single controller supports a maximum of 100 MTrees; however, system
performance may degrade if the number of MTrees simultaneously engaged in read or
write streams exceeds 14. For best results, limit the number of active MTrees to 14,
and, when possible, consolidate operations on the same MTree into one operation.
l MTrees cannot be created if the maximum of 100 has been reached or if there is no
available space.
l MTree quotas cannot be set on the /data/col1/backup directory.
l The maximum quota value is 4096 PiB.
l Quota limits are pre-compressed values.
l The default setting for MTree quota limits is disabled.
l MTree quota limits are set for the active tier only when set on a Data Domain system
with Extended Retention.

mtree create
mtree create mtree-path [quota-soft-limit n {MiB|GiB|TiB|PiB}]
[quota-hard-limit n {MiB|GiB|TiB|PiB}]
Create an MTree under the specified path. The format of the mtree-path is /data/col1/
mtree-name. An error message notifies you to enter a different name if another MTree with
the same name exists, if the new name is formatted incorrectly, or if the destination
MTree already exists.
Naming conventions for creating MTrees include uppercase and lowercase letters A-Z, a-
z), numbers 0-9, single, non-leading embedded space, exclamation point, hash, dollar
sign, ampersand, caret, tilde, left and right parentheses, left and right brackets, left and
right braces.
If no quota option is specified, the default is unlimited for both soft and hard limits,
meaning there are no quota limits.
When setting quota limits, a warning appears if the new limit is lower than the current
space usage of the MTree. The command does not fail, but subsequent writes to the
MTree are rejected. An error message appears if you are setting a soft limit that is greater
than or equal to the hard limit. When the hard limit is reached for an MTree quota, write
operations stop and no more data can be written to the MTree. Data can be deleted.

128 EMC Data Domain Operating System 5.4 Command Reference Guide
 mtree

Example 43

To create MTree /data/col1/backup1 with no quota limits:

# mtree create /data/col1/backup1

Example 44

To set a soft limit quota of 10 GiB on MTree /data/col1/backup1:

# mtree create /data/col1/backup1 quota-soft-limit 10 GiB

Example 45 Example 3

To set a hard limit quota of 10 TiB on MTree /data/col1/backup2:

# mtree create /data/col1/backup2 quota-hard-limit 10 TiB

mtree delete
mtree delete mtree-path
Delete the specified MTree (denoted by the pathname). MTrees marked for deletion
remain in the filesystem until the filesys clean command is run. This command
option is not allowed on Retention Lock Governance or Retention Lock Compliance
MTrees unless they are empty. You can revert the marked-for-deletion state of that MTree
by running the mtree undelete command. See the EMC Data Domain Operating System
Administration Guide for details on Retention Lock Compliance and Governance.
Effects of deleting an MTree include:
l The MTree appears in the output of the mtree list command option and is
marked with the status value D.
l File service to a deleted MTree is rejected. Deleted MTrees are not visible through NFS
or CIFS clients.
l When an MTree is removed from the filesystem, snapshots associated with that
MTree are also deleted from the /data/col1/mtree-name/.snapshot/ directory.

mtree list
mtree list [mtree-path]
Display the list of MTrees.
Argument Definitions
mtree-path (Optional)
Display MTrees under the specified path only. This command supports the asterisk
(*) wildcard character in the MTree pathname. Values include:
l /data/col1/mtree1
l /data/col1/mtree*
l *mtree*

mtree delete 129

mtree

Output Definitions
Output includes the MTree pathname, precompression, and status. Status is based on
pre-defined values:
D
Marked for deletion. MTree will be removed from the filesystem by the filesys clean
command. Can be unmarked for deletion by using the mtree undelete command only
if the filesys clean command has not been run.
Q
Quota defined.
RO
Read-only access.
RW
Read/write access.
RD
Replication destination.
RLCE
Retention Lock Compliance enabled.
RLGE
Retention Lock Governance enabled.
RLGD
Retention Lock Governance disabled.

mtree rename
mtree rename mtree-pathnew-mtree-path
Rename the specified MTree. Note that /data/col1/backup cannot be renamed.
Retention Lock Governance or Retention Lock Compliance MTrees can only be renamed if
they are empty.
This command option requires security officer authorization if Retention Lock Compliance
is enabled on the specified MTree.

mtree retention-lock
mtree retention-lock disable mtree mtree-path
Disable Retention Lock for the specified MTree. This command option is allowed on
Retention Lock Governance MTrees only. It is not allowed on Retention Lock Compliance
MTrees. See the EMC Data Domain Operating System Administrators Guide for details on
Retention Lock Compliance and Governance.
mtree retention-lock enable mode {compliance | governance}
mtree mtree-path
Enable Retention Lock for the specified MTree. Use the compliance argument to meet the
strictest data permanence regulatory standards, such as those ofSEC17a-4f. Enabling
Retention Lock Compliance requires security officer authorization.
Use the governance argument to propagate the same protection provided in the previous
release of DD OS. The level of security protection is lower than Retention Lock
Compliance.
When Retention Lock is enabled on an MTree, any file in the MTree may become locked
by setting its atime to the future. Additionally, renaming a non-empty directory in the

130 EMC Data Domain Operating System 5.4 Command Reference Guide
 mtree

MTree is disabled. See the EMC Data Domain Operating System Administration Guide for
details Retention Lock Compliance and Governance, and for instructions on setting
retention time.
To enable Retention Lock Compliance on an MTree, enter:
# mtree retention-lock enable mode compliance mtree /data/col1/
mtree_name

Note that /backup cannot be configured for Retention Lock Compliance.

Example 46

To enable Retention Lock Compliance on an MTree, enter:

# mtree retention-lock enable mode compliance mtree /data/col1/

mtree_name

Note that /backup cannot be configured for Retention Lock Compliance.

mtree retention-lock reset {min-retention-period | max-

retention-period} mtree mtree-path
Reset the minimum or maximum retention period for the specified MTree to its default
value. The command option is allowed on MTrees with Retention Lock Governance
enabled.
See the EMC Data Domain Operating System Administration Guide for details on Retention
Lock Compliance and Governance and for instructions on setting retention time.
mtree retention-lock revert path
Revert all Retention Lock files in a specified path to non-Retention Lock files. Note that
directories and files within Retention Lock Compliance Mtrees cannot be reverted.
The base of the path must be /data/col1/mtree-name/ or /backup/.
Reverting Retention Lock Governance generates a Data Domain system alert (at the
Alert severity level) and logs the names of the reset files. Data Domain recommends
when a recipient receives the alert, he or she confirms the reset operation was intended.
mtree retention-lock set {min-retention-period | max-retention-
period} period mtree mtree-path
Set the minimum or maximum retention period for the specified MTree. This command
option requires security officer authorization if Retention Lock Compliance is enabled on
the MTree.
Users cannot set the minimum retention period to fewer than 12 hours. Doing so
generates a message notifying the user that the entry was invalid and stating the
minimum retention period allowed.
When setting the lock period for Retention Lock Compliance MTrees, users cannot set the
period to be less than the current minimum or maximum period allowed. Doing so
generates a message notifying the user that the entry was invalid and stating the
minimum or maximum retention period allowed.
The retention period is specified in the format [number] [unit]. Possible unit values are:
l min
l hr
l day
l mo

mtree retention-lock 131

mtree

l year
The retention period cannot exceed 70 years. Setting a value greater than 70 years
results in an error.

Example 47

To set the min-retention-period to 24 months for mtree1:

# mtree retention-lock set min-retention-period 24mo mtree /data/col1/

mtree1

mtree retention-lock show {min-retention-period | max-

retention-period} mtree mtree-path
Show the minimum or maximum retention period for the specified MTree.
mtree retention-lock status mtree mtree-path
Show Retention Lock status for the specified MTree. Possible values are enabled,
disabled, previously enabled, and MTree Retention Lock mode: Compliance or
Governance.

mtree show compression

mtree show compression mtree-path[tier {active | archive}]
[summary | daily | daily-detailed] [last n { hours | days |
weeks | months }] | [start date [end date]]}
Display compression statistics for a specific MTree. Values are reported in Gigibytes
(GiB). Running the command without arguments generates default output that displays a
summary of compression statistics for all files and directories in the filesystem for the
last 7 days and the last 24 hours.
Argument Definitions
mtree-path
The pathname of the MTree for which to display compression statistics.
tier {active | archive}
Display results for the specified tier.
summary (Optional)
Display all compression statistics, summarized as:
l Data written in the last 7 days. By including the last n option or the start date
option, you can display statistics for a time frame other than the last 7 days.
l Data written in the last 24 hours.

daily (Optional)
In addition to the summary output, display detailed information for each day, over
the previous four full weeks, plus the current partial week. This option is not
available if you specify a file or directory name.
daily-detailed (Optional)
Display the daily output and include the following information for each day. This
option is not available if you specify a file or directory name.
last n {hours | days | weeks | months}] (Optional)
In the summary portion of the output, display filesystem compression statistics for
the specified time frame instead of for the past 7 days. The statistics for the last 24
hours remain in the summary output. If you specify a file or directory name, you
cannot use this option with the weeks keyword or the months keyword.

132 EMC Data Domain Operating System 5.4 Command Reference Guide
 mtree

start date (Optional)

In the summary portion of the output, display filesystem compression statistics for
the time frame that begins on the specified day instead of the past 7 hours. The
statistics for the last 24 hours remain in the summary output. If you specify a time
frame less than the previous four weeks, plus the current full week, the daily or daily-
detailed output (if specified) is truncated to the shorter time frame.
Specify date in the format yyyy-mm-dd (for example, 2013-04-07). By default, the last
day of the time frame specified with this argument is the most recent, full day
elapsed.
end date (Optional)
Valid only if the start option is used. In the summary portion of the output, display
filesystem compression statistics for the time frame that ends on the specified day.

mtree undelete
mtree undelete mtree-path
Mark as not deleted the marked-for-deletion MTrees at the specified path. This command
reverses a previous mtree delete command.

Note

To undelete an MTree, cleaning must not have run before executing the undelete
command.

Example 48

To reverse a previous mtree delete command request that included the MTree at /
data/col1/myMTree:

# mtree undelete /data/col1/myMTree

mtree undelete 133

mtree

134 EMC Data Domain Operating System 5.4 Command Reference Guide
CHAPTER 20
ndmpd

The ndmpd command is the top-level command for the NDMP (Network Data
Management Protocol) daemon running on a Data Domain system. The NDMP daemon
provides access to VTL-created devices using the NDMP version 4 protocol. Use of this
command requires a VTL license.
This chapter contains the following topics:

l ndmpd Change History........................................................................................ 136

l ndmpd Guidelines and Restrictions.....................................................................136
l ndmpd disable....................................................................................................136
l ndmpd enable.....................................................................................................136
l ndmpd option..................................................................................................... 136
l ndmpd show....................................................................................................... 136
l ndmpd status......................................................................................................137
l ndmpd stop........................................................................................................ 137
l ndmpd user.........................................................................................................137

ndmpd 135
ndmpd

ndmpd Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 21 ndmpd Change History

Version Change
5.4 No changes from previous version.

ndmpd Guidelines and Restrictions

Unless otherwise noted, command options are available only to users with admin role
permissions.

ndmpd disable
ndmpd disable
Disable the NDMP daemon.

ndmpd enable
ndmpd enable
Enable the NDMP daemon.

ndmpd option
ndmpd option reset option-name | all
Reset all NDMP daemon options or a specific option.

ndmpd show
ndmpd option show option-namevalue
View all NDMP daemon options or a specific option.
ndmpd show devicenames
View the device name, VTL virtual name, SCSI vendor and product code, and the serial
numbers of devices controlled by the NDMP daemon. Typically, this information is
displayed during device discovery and configuration. However, you can use this
command to verify the VTL TapeServer group configuration and perform a manual
configuration, if required.
No output in the NDMP Device column indicates the VTL service is not running, or that no
devices are registered with the VTL TapeServer. A series of hyphens in the NDMP Device
column indicates the VTL service is running on the system but has not registered the
devices. Restart the VTL service to correct this behavior. If the problem persists, contact
Data Domain Support.

136 EMC Data Domain Operating System 5.4 Command Reference Guide
 ndmpd

ndmpd show sessions

View active sessions.
ndmpd show stats session-id | all
Use this command to view statistics of a a single session or all sessions. Session
numbers are obtained from the command ndmpd show sessions.

ndmpd status
ndmpd status
Display the NDMP daemon status.

ndmpd stop
ndmpd stop session session-id | all
Stop all sessions or a single session.

ndmpd user
ndmpd user add user-name
Add one (only) user name for the NDMP daemon md5 authentication.
ndmpd user del user-name
Delete the configured NDMP daemon user.
ndmpd user modify user-name
Modify the name of the NDMP daemon md5 user.
ndmpd user show
View the NDMP daemon user.

ndmpd status 137

ndmpd

138 EMC Data Domain Operating System 5.4 Command Reference Guide
CHAPTER 21
net

The net command manages the use of virtual interfaces, DHCP, DNS, and IP addresses,
and displays network information and status.
Federal certification requirements state that the DD OS must be IPv6-capable and that
interoperability with IPv4 be maintained in an heterogeneous environment. As a result,
several net command options include arguments for both versions of Internet Protocol.
Collection, directory, and MTree replication are supported over IPv6 networks, which
allows you to take advantage of the IPv6 address space. Simultaneous replication over
IPv6 and IPv4 networks is also supported, as is Managed File Replication using DD Boost.
IPv6 addresses are not supported for CIFS.
If you do not specify an IP version, the default is IPv4 to maintain compatibility with DD
OS versions prior to 5.2. The exception is show commands. If the version is not specified
in the show command option (as in route show table), both address versions are
displayed. To view the IPv4 routes only, you must specify the IPv4 argument.
For some commands, you must include the IPv6 command argument if the host is to be
accessed using its IPv6 address. This is required when a hostname is specified and the
host name format resembles an IPv4 address.
This chapter contains the following topics:

l net Change History.............................................................................................. 140

l net Guidelines and Restrictions...........................................................................140
l net aggregate...................................................................................................... 140
l net config............................................................................................................143
l net congestion-check.......................................................................................... 144
l net create............................................................................................................147
l net ddns..............................................................................................................147
l net destroy..........................................................................................................148
l net disable..........................................................................................................148
l net enable...........................................................................................................148
l net failover..........................................................................................................148
l net hosts.............................................................................................................150
l net iperf ............................................................................................................. 150
l net lookup...........................................................................................................151
l net option........................................................................................................... 151
l net ping.............................................................................................................. 151
l net reset..............................................................................................................152
l net set.................................................................................................................152
l net show............................................................................................................. 153
l net tcpdump....................................................................................................... 154
l net troubleshooting.............................................................................................154
l net Additional Topics.......................................................................................... 154

net 139
net

net Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 22 net Change History

Version Change
5.4 No changes from previous version.

net Guidelines and Restrictions

l Unless otherwise noted, command options are available only to users with admin
role permissions.
l Changes made by the net command to disabled Ethernet interfaces flush the routing
table. EMC Data Domain recommends making interface changes only during
scheduled downtime. After making changes to disabled interfaces, you must
reconfigure all routing rules and gateways.
l IPv4 is the default IP version.

net aggregate
net aggregate add virtual-ifname interfaces physical-ifname-
list [mode {roundrobin | balanced hash {xor-L2 | xor-L3L4| xor-
L2L3} | lacp hash {xor-L2 | xor-L3L4 | xor-L2L3} [ rate {fast |
slow} ] [up {time | default} ] [down {time | default} ]
Add slave interfaces to an aggregate interface. Setting the mode is required on initial
configuration and when there is no default aggregate mode, but optional when adding
interfaces to an existing aggregate interface. Choose the mode compatible with the
specifications of the system to which the ports are attached. Balanced and lacp modes
require a hash.

Example 49

To enable link aggregation on virtual interface veth1 to physical interfaces eth1a and
eth2a in mode lacp hash xor-L2:

# net aggregate add veth1 interfaces eth1a eth2a mode lacp hash xor-L2

net aggregate Command Option Arguments

round robin
Packets are transmitted sequentially, beginning with the first available link and
ending with the last link in the aggregated group.
balanced
Data is sent over interfaces as determined by the hash method selected. This
requires the associated interfaces on the switch to be grouped into an Ethernet
trunk. Requires a hash.

140 EMC Data Domain Operating System 5.4 Command Reference Guide
 net

lacp
LACP is a link aggregation mode based on the Link Aggregation Control Protocol
(IEEE 802.3ad). From a switch perspective this configuration is always an active LACP
configuration. It cannot be set to passive. LACP communicates with the other end to
coordinate which links within the bond are available. When the this mode is
selected, both ends must be configured with LACP. Requires a hash.
An interface must not only have carrier up, but also must be able to communicate
with its directly attached partner. This provides a better port fail recovery than
failover bonding; however, the LACP port must reside on a single switch except for
special cases of virtual switch ports. Therefore to fail across switches, failover
bonding must be used.
rate
Specifies how often an LACP message is sent to the switch or system that is
connected to the Data Domain system. The message identifies the aggregated
interface. This acts as a type of heartbeat. Slow sends the message once every 30
seconds. It is the default. Fast sends the message every second.
The rate determines how fast the lacp will recognize when an interface cannot be
used and when it can. If 30 seconds is too long it can be set to fast (1 second), but
fast means there is more traffic comprised of small packets (about the size of a TCP
ACK packet) across all aggregated lacp interfaces. With 10 Gb speed consider the
potential for losing connections with a rate of 30 seconds.
xor-L2
Transmission of packets from a specific slave interface is based on static balanced
mode or LACP mode aggregation with an XOR based on a hash policy. An XOR of
source and destination MAC addresses is used to generate the hash.
xor-L2L3
Transmission of packets from a specific slave interface is based on static balanced
and LACP mode aggregation with an XOR based on a hash policy. An XOR of source
and destination's upper layers (L2 and L3) protocol information is used to generate
the hash.
xor-L3L4
Transmission of packets from a specific slave interface is based on static balanced
and LACP mode aggregation with an XOR based on a hash policy. An XOR of source
and destination's upper layers (L3 and L4) protocol information is used to generate
the hash.

net aggregate 141

net

up, down
The length of delay allowed before the link is considered up or down. A down
interface must be up for interval configured in time to be considered up. Conversely,
an up interface must be down for the interval configured in time to be considered
down and not available.
If a link is up, the interface carrier must be missing for the amount of time specified
by the down argument before the link is designated down. Default for up/down
times is 29.7 seconds. Up/down times are rounded down to a multiple of 0.9
seconds. For example if 10 seconds is configured, 9.9 seconds is used.
When the link is down:
l Data is no longer sent to the interface.
l For an aggregation bonding, aggregation is recalculated.
l For a failover bonding, if the affected interface is the active interface, then the
active interface is switched to another interface that is up.

The interface carrier must be present for the amount of time specified by the up
argument before the link is designated up.
When the link is up:
l Data can be sent over it.
l For an aggregation bonding, the aggregation is recalculated to include the up
link.

For a failover bonding, nothing more is done; however, if the up interface is the
primary or sole, up slave interface, then it is also marked as the active interface.

net aggregate del virtual-ifname interfaces physical-ifname-

list
Delete slave interfaces from the list of the aggregate virtual interface.

Example 50

To delete physical interfaces eth2a and eth3a from the aggregate virtual interface veth1:

# net aggregate del veth1 interfaces eth2a,eth3a

net aggregate modify virtual-ifname [mode {roundrobin |

balanced hash {xor-L2 | xor-L3L4| xor-L2L3} | lacp hash {xor-
L2| xor-L3L4 | xor-L2L3} [rate {fast | slow}]}] [up {time |
default}] [down {time | default}]
Change the configuration of an aggregate interface. You must indicate the mode the first
time. Choose the mode compatible with the specifications of the system to which the
ports are attached. Balanced and lacp modes require a hash.

Example 51

Use the following command to change link aggregation on virtual interface veth1 to mode
lacp hash xor-L2. Stating the previous condition is not required. The listed conditions
replace the previous settings except on the current slave interfaces, which remain slaves
to the virtual interface. Slaves may be added by this command, but none are removed.

142 EMC Data Domain Operating System 5.4 Command Reference Guide
 net

Example 51 (continued)

# net aggregate modify veth1 mode lacp hash xor-L2

net aggregate reset virtual-ifname

Remove all physical interfaces and IP addresses from an aggregate virtual interface.

Example 52

# net aggregate reset veth1

Note

This command option also removes the addresses on associated VLAN and alias, but
does not remove the interfaces.

net aggregate show

Display basic information on the aggregate setup. If the bonded interface has not been
brought up, output displays No interface in the aggregate mode.

Note

With the exception of net aggregate show, net aggregate commands control
link aggregation, which provides improved network performance and resilience by using
two or more network ports in parallel. Note that link aggregation and Ethernet trunking
are synonymous. The recommended and supported maximum is four ports, but there are
no restrictions on the Data Domain system for having more aggregate slaves.

net config
net config ifname {[[ipaddr] [netmask mask] [dhcp {yes | no}]]
| [ipv6addr]} {[autoneg] | [duplex {full | half} speed {10|100|
1000|10000}] [up | down] [mtu {size | default}]
Configure an Ethernet interface. Note the following guidelines:
l An IP address with netmask or DHCP with yes may be used, but not both.
l The IP address can be IPv4 or IPv6. If IPv4, it may have a netmask different from the
default netmask. The netmask can only be specified when the address is specified. If
an IPv6 address is specified there is no associated netmask. Instead, a prefix length
is used to determine the subnet. The default prefix length is 0. To use a prefix length
different from 0, it must be specified with the address by adding a forward slash
followed by a number. For example, if the prefix length is 52, the notation would be:
2026:3456:cafe::f00d:1/52.
l Anywhere a netmask can be used for IPv4, a prefix length can be used for IPv6. The
limit of the MTU size is 512 - 9000 for IPv4 and 1280 - 9000 for IPv6. To ensure
backward compatibility DD OS accepts an MTU size of 9014, but sets it to 9000 if the
MTU requested is greater than 9000 and less than or equal to 9014.
l Use the up argument to bring up an interface without an IP address. Using enable will
fail if no IP address is given.

net config 143

net

Note

If no address is given the up option may fail because there is no registry entry for an IP
address. This typically occurs after a fresh install. If this occurs, specify an address of 0 to
allow a registry address location to be created.
net config ifname type {none | management | replication |
cluster}
Configure or set the type of Ethernet interface.

net congestion-check
net congestion-check modify [sample-interval secs] [capture-
window secs] [every mins] [detailed {on | off}] [logfile
filename] [ iperf-client {none | iperf-server-host | iperf-
server-ipaddr} [nodelay <on | off>] [port {port | default} ]
[window-size bytes] [connections count] [data {random|
default}]}]
Modify options for the congestion monitor whether or not the monitor program is
activated. (The congestion monitor is activated by the net congestion-check start
command.) The modify command option sets the registry information. If the congestion
monitor is scheduled, the new registry values are used when it runs. If the monitor is not
scheduled, the values are used as defaults when it is started. Typically this command
option is used after the monitor is scheduled to run and the user does not want to stop
and restart the monitor.
Output values for rates and error numbers are added together. Values that may increase
or decrease, such as the capture-window, are averaged over time.
net congestion-check modify sample-interval secs
Specify the time that statistic information is collected. There are multiple intervals during
the capture window when data is collected and the sample-interval argument determines
how often this is. For example, the initial default capture-window is 60 seconds and the
default sample-interval is 4 seconds. Data is collected every 4 seconds for 60 seconds
and collection stops. The information is output to the screen if the run argument is
specified, or to a log file if the start argument is specified.
If the every argument is non-zero the capture window is run again after the number of
minutes specified in the every argument. The value of the sample-interval
argument must be less than the value of the capture-window argument.
The run argument default is always 4 seconds. For start and modify arguments, the
initial default is 4 seconds.
net congestion-check modify capture-window secs
Congestion data is collected only during the capture window. Outside the capture
window the program is in sleep mode or terminated depending on whether the argument
every is non-zero. During the capture window data is collected during each sample
interval. For example, if the capture window is 60 seconds and the sample value is 5
seconds, data is collected every 5 seconds for 60 seconds and collection stops. The
output concludes at the end of 60 seconds and is displayed as one line per remote IP
address.
The run argument default for the capture window is always 60 seconds. The initial value
for the start and modify arguments is 60 seconds. After that, the default for the
start argument is whatever is in the registry. The capture-window argument must be
less than the argument every and greater than the argument sample-interval.

144 EMC Data Domain Operating System 5.4 Command Reference Guide
 net

net congestion-check modify every mins

Determine how often to run the capture window. If set to zero the capture window is run
once only. The default for the run argument is zero, which means if the every argument
is not specified only one capture window is run. For the start argument, the value of the
every argument must be greater than zero because start is a monitor and must run
repeatedly. The default for the initial every argument is 60 minutes, which is put into
the registry. After that the default for the start argument is whatever is in the registry.
When set to non-zero, the value for the argument every must be greater than the value
of the capture-window argument. The default value for the run argument is always
zero. For start and modify arguments the initial default is 60 minutes.
net congestion-check modify detailed {on | off}
By default, only basic information is saved, but setting the argument to on causes more
data to be saved. The basic setting is mainly for replication on the source system and
focuses on congestion conditions between the source and destination. The detailed on
argument adds receive information and other entries useful for the general network
environments of the Data Domain system. For the run argument the default is always off.
For start and modify arguments the initial default is off.
net congestion-check modify logfile filename
Set the log file name used to save the data collected. This command option is not
available with the run argument because the output goes to the screen. For start and
modify arguments the initial default is /ddr/var/log/default/
congestion.log.
The file name should not be changed unless absolutely required. The main concern is the
default file name is on a rotation system where the file size cannot exceed 10 MB and up
to 10 files only are saved for a maximum of 100 MB of disk space. Changing the file name
voids the space restrictions, meaning there is no limit to the space that may be taken.
net congestion-check modify iperf-client none
This command option allows iperf to run during the capture window of congestion data
collection. For the run argument the default value is none. For start and modify
arguments the initial default is none, but if iperf is used when data is being collected, the
destination name or address argument must be specified.
The iperf operation is started only at the beginning for each capture window. The remote
system must have an iperf server iperf-server-host and specified port port.
The iperf function is typically used to determine the maximum throughput. It is disruptive
of the network and should not be left on for a long time, especially if there is other traffic
using the network.
Alternatives include starting iperf manually before the congestion check is performed.
The advantage of letting the congestion-check handle the iperf is that the iperf is only run
when the congestion-check requires it. Otherwise iperf is not running.
The none argument must be specified to notify the congestion monitor not to use iperf if
iperf was previously enabled and is no longer needed.
Options for modifying or starting iperf during the capture window are:
nodelay <on | off>
On means do not wait for ACK. Off means wait for each buffer to be sent before
sending the next.
<port | default>
The port number to use with iperf. Default is 5002, which is one more than the iperf
default 5001.

net congestion-check 145

net

window-size bytes
The size of the socket buffer to use. Default is 32000. For long latencies, this size
may be too small. Consider setting the size to 250000 or 10000000.
connections count
The number of connections to use. Must be greater than zero. Default is 1, which is
typically satisfactory if the window size is set appropriately.
data {random | default}
An in-memory random data generator. This would be used if a WAN accelerators was
in the path thereby preventing the generator from providing elevated bandwidth
numbers.

net congestion-check run [sample-interval secs] [capture-window

secs] [every mins] [detailed {on | off}] [logfile filename]
[{ iperf-client {none | { iperf-server-host | iperf-server-
ipaddr} [nodelay <on | off>] [port {port | default} ] [window-
size bytes] [connections count] [data {random|default}]}]
Run the congestion check program and display the results as screen output when the
capture-window time is complete. When the command option is entered without
arguments, defaults are used. When the command option includes arguments, the
arguments override the defaults during the procedure but return to the configured
defaults after the procedure concludes. Default values for the run command are always
the same and are not affected by the net congestion-check modify or the net
congestion-check start commands.
The run option default for iperf is always none. If iperf address is used, the default iperf
options are: nodelay equals off, port equals 5002, window-size equals 32000,
connections equals 1.
net congestion-check start [sample-interval secs] [capture-
window secs] [every mins] [detailed {on | off}] [logfile
filename] [{ iperf-client {none | { iperf-server-host | iperf-
server-ipaddr} [nodelay <on | off>] [port {port | default} ]
[window-size bytes] [connections count] [data {random|
default}]}]
Start the congestion monitor and schedule when it is to be run using the time arguments:
sample-interval, capture-window, and every. When the command option is run
with arguments, the arguments override the defaults and become the default by being
placed in the registry. The remaining arguments of net congestion-check start
command are used to configure in detail how the monitor is run. The start option
default for iperf is initially none.

Note

After entering the command, there is a slight delay during which the process (netmon)
actually starts the monitor. After the monitor is started the specified time arguments take
over. To get information immediately, use the net congestion-check run
command instead.

Output is one line per external destination. All connections to and from an external
address are merged into a single line of data.
Value types from the output vary. Amounts of data or packets increase. These amounts
are added together across all connections to a specific IP address to give the total value
to or from the external location. Rates are relatively constant but are also added together
to give the total flow rate to the pipe at the remote location. Other values are relatively
static across all connections, such as the mss, rtt, window scale factor, or congestion

146 EMC Data Domain Operating System 5.4 Command Reference Guide
 net

window. These are given as an average with the minimum and maximum. Errors and
loses are treated the same as rates and are added across all interfaces.
net congestion-check status
Display the state of the congestion monitor. The congestion monitor is started when the
net congestion-check start command is issued. The status argument
displays the configured timings, the level of logging, the log file, the monitored
connections, if the monitor is actually running or scheduled to run, and if iperf is
specified to run. It also shows if iperf is currently running and which connections are
being monitored.
net congestion-check stop
The congestion monitor is run when the net congestion-check start command
is issued. A message notifies the user if the configuration monitor is not scheduled and
no action is taken. If the congestion monitor is scheduled, this command option
unschedules the procedure. If the congestion monitor is running, this command option
stops the procedure and unschedules it.

net create
net create interface {physical-ifname | virtual-ifname} {vlan
vlan-id | alias alias-id}
Create a VLAN interface or an IP alias interface. The VLAN is created immediately in the
kernel, but the alias is not created in the kernel until an IP address is specified. The
number given must be between 1 and 4094 inclusive. For the VLAN there must be a
matching number on the switch or other systems to transfer packets to the interface.
There is no such requirement for the alias but the alias ID must be unique for the
interface.
net create virtual vethid
Create a virtual interface. The virtual interface name veth-id must begin with veth. The
remainder of the name is a decimal number. Interface names must be unique.
There are no restrictions except for the size and the number. The maximum size for an
interface name is 15 characters, which includes VLAN, alias names, and the associated
dot and colon. The virtual interface name must be kept at a minimum. The maximum is
9999, but EMC recommends using a number in the range of 0 to 99.
The number of virtual interfaces cannot exceed the number of physical interfaces. For
example, if there are 10 physical interfaces there can be no more than 10 virtual
interfaces.

net ddns
net ddns add <ifname-list | all>
Add interfaces to Dynamic DNS registration list.
net ddns del <ifname-list | all>
Remove interfaces from Dynamic DNS registration list.
net ddns disable
Disable Dynamic DNS updates.
net ddns enable
Enable Dynamic DNS updates.
net ddns register
Register configured interfaces with DNS.

net create 147

net

net ddns reset

Reset Dynamic DNS registration list to auto and disable registration.
net ddns show
Show interfaces in Dynamic DNS registration list.
net ddns status
Check status of dynamic DNS registration: enabled or disabled.

net destroy
net destroy {virtual-ifname | vlan-ifname | ipalias-ifname }
Remove a VLAN, IP alias, or virtual interface. If a virtual interface has associated VLANs
and aliases, or if a VLAN has associated aliases, the associated interfaces are also
destroyed when the virtual interface or VLAN interface is destroyed.

Example 53

To remove a VLAN named eth1a.35 and a virtual interface named veth23:2:

# net destroy eth1a.35

# net destroy veth23

net disable
net disable ifname
Disable an Ethernet interface on the Data Domain system and bring down the interface in
the kernel.

net enable
net enable ifname
Enable or reenable an Ethernet interface on the Data Domain system, where ifname is the
name of an interface. This includes bringing up the interface to the RUNNING state and
requires the interface to have an IP address. The address may already be saved in the
registry or may come from DHCP. If the interface does not go into the RUNNING state, the
command will fail and the interface is set to the DOWN state and set to disabled.

net failover
net failover add virtual-ifname interfaces ifname-list [primary
ifname] [up {time | default}] [down {time | default}]
Add network interfaces as slaves to a failover interface. Allow one failover slave to be set
as the primary and allow the up and down delays to be set. The slave interfaces must be
in a down (disabled) state when added to the virtual interface. Note that the network
interfaces can be aggregated interface.
net failover del virtual-ifname interfaces ifname-list
Delete slave interfaces from a failover interface. The freed interface remains disabled
after being removed from the virtual interface. Use commas, spaces, or both to separate
list entries. To delete a primary interface specify another interface as primary or set the
primary be none.

148 EMC Data Domain Operating System 5.4 Command Reference Guide
 net

Example 54

To remove eth2a from the virtual interface veth1, which has eth2a and eth3a as slaves
and eth3a as the primary interface:

# net failover del veth1 interfaces eth2a

net failover modify virtual-ifname [primary {ifname | none}]

[up {time | default}] [down {time | default}]
Modify the primary network interface, the up /down times for a failover interface, or both.
A down interface must be up for the amount of time to be designated up. An up interface
must be down for the amount of time to be designated down.
The up and down time is given in milliseconds and is adjusted internally to the largest
multiple of 900, less than or equal to the specified value. For example, if the time you
want is 10 seconds and 10000 is specified, the actual value would be 9900. The default
value is 30 seconds but the actual resulting value is 29.7 seconds.
A primary interface cannot be removed from failover. To remove a primary use primary
physical-ifname none first.

Example 55

# net failover modify veth1 up 5000 down 10000

The up time value used would be 4500 (4.5 seconds) and the down time value would be
9900 (9.9 seconds).

net failover reset virtual-ifname

Reset a failover interface by removing associated slave interfaces. This command also
removes the addresses from the virtual interfaces and the addresses of any associated
interfaces such as VLANs and aliases.

Example 56

Use the following command to remove virtual interface veth1 and release associated
physical interfaces. (The physical interfaces remain disabled and must be reenabled for
any other use than as part of another virtual interface.)

# net failover reset veth1

After the virtual interface has been reset, the physical interfaces remain disabled. Use the
net enable command to reenable the interfaces. If there are no IP addresses associated
with these interfaces these commands will fail and using the command net config
ifname up may be required.

# net enable eth2a

# net enable eth3a

net failover show

Display all failover interfaces. This command shows what is configured at the bonding
driver. To see what is in the registry, use the net show settings command.

net failover 149

net

The registry settings may be different from the bonding configuration. After creation,
when interfaces are added to the virtual interface, the information is not sent to the
bonding module until the virtual interface is brought up. Until that time the registry and
the bonding driver configuration differ.

net hosts
net hosts add {ipaddr | ipv6addr} host-list
Add a host list entry. Associate an IP address with a hostname. The address can be a IPv4
or an IPv6. The hostname is a fully qualified domain name, a hostname, or an alias. The
entry is added to the /etc/hosts file. Entries in the list can be separated by commas,
spaces, or both.

Example 57

To associate the fully qualified domain name bkup20.yourcompany.com and the

hostname of bkup20 with an IP address of 192.168.3.3:

# net hosts add 192.168.3.3 bkup20.yourcompany.com bkup20

net hosts del {ipaddr | ipv6addr}

Delete a host list entry from the //etc/hosts file.
net hosts reset
Clear the hosts list from the /etc/hosts file.
net hosts show
Display hostnames and IP addresses from the /etc/hosts file. All users may run this
command option.

net iperf
net iperf client {ipaddr | ipv6addr | hostname [ipversion {ipv4
| ipv6}]} [port port] [window-size bytes] [data {random|
default}] [interval secs] [{transmit-size bytes | duration
secs}] [connections count] [nodelay]
Run iperf in client mode. If an IPv6 address is specified for the hostname, the
ipversion argument must also be specified. The default is an IPv4 address. The port
argument can be used to change the port number from the default 5001 to another
number. Typically this is used to bypass network filters or test specific ports. The
window-size argument increases the amount of data sent at one time. If WAN
accelerators are on the network, the data random argument prevents artificial
performance numbers from being returned. The duration argument indicates how
many seconds the generator runs. The connections argument determines how many
connections to use, the number of which can improve throughput in a network
environment with high loss, high latency and low bandwidth. The nodelay argument
eliminates the wait time between sends.
net iperf server [run] [ipversion {ipv4 | ipv6}] [port {port |
congestion_check-port}] [window-size bytes]]
Run iperf in server mode. Look for the Linux DD OS Equivalent Arguments for the iperf
Option to compare Linux iperf options with DD OS options. The ipversion argument
may be used to specify the type of addressing.

150 EMC Data Domain Operating System 5.4 Command Reference Guide
 net

net iperf server start [port {port | congestion_check-port}]

[ipversion {ipv4 | ipv6}] [window-size bytes]
Run the iperf in the background in server (-s) mode. This command enables the terminal
to be used for other operations, such as a network congestion check, while the iperf is
running. The ipversion argument specifies the type of addressing.
net iperf server status
Display information about the iperf server running in the background as invoked by
net_server start. This command option provides the status on if the iperf server is
running and what connections it has.
net iperf server stop
Stop iperf invoked by net_server start.

net lookup
net lookup {ipaddr | ipv6addr | hostname}
Search DNS entries. This command may be used with IPv4 or IPv6 addresses. All users
may run this command option.

net option
net option reset option-name
Reset an option to the default values.
net option set option-namevalue(s)
Set values for the option specified.
net option show
Display settings for network options.

net ping
net ping {ipadddr | ipv6addr| hostname [ipversion {ipv4 |
ipv6}]} [broadcast] [count n] [interface ifname] [packet-size
bytes] [path-mtu {do | dont | want}] [pattern pattern]
[numeric] [verbose]
Verify the Data Domain system can communicate with a remote host.
net ping Command Option Arguments
ipaddr
An IPv4 address is specified.
ipv6addr
An IPv6 address is specified.
hostname
Can be converted into an IPv4 or IPv6 depending on the ipversion argument. If
ipversion argument is not specified, IPv4 is used.
broadcast
Enable pinging a broadcast address (available for IPv4 only).
count n
Number of pings to issue.
interface ifname
Name of interface to ping.

net lookup 151

net

packet-size
Set packet size.
path-mtu
Allow/disallow fragments.
pattern
Send packet with a pattern.
numeric
Ping IP address not hostname.
verbose
Display expanded output.

net reset
net reset {domainname | searchdomains}
Reset Data Domain system DNS servers, domain names, or host names to default
settings. Requires system reboot for changes to take effect.
net reset dns
Reset DNS list to default values. Requires system reboot for changes to take effect.
net reset hostname
Reset hostname to default values. Requires system reboot for changes to take effect.

net set
net set {domainname local-domain-name | searchdomains search-
domain-list}
Set the domainname or searchdomains used by the Data Domain system. The default for
domainname is the return from DHCP, or what is set by net set hostname command. The
default for searchdomain is the domainname name, which is always included in the
list of searchdomains.

Example 58

# net set domainname yourcompany-ny.com

# net set searchdomains yourcompany2.com, yourcompany3.com

The searchdomains list is yourcompany-ny.com, yourcompany2.com and

yourcompany3.com.

If the domain names provided cannot be resolved, a warning is displayed.

net set dns ipv4-ipv6-addr-list

Set the DNS server list using IP version 4 or IP version 6. This command overwrites the
current list of DNS servers. Only servers included in the most recently issued command
are available to a Data Domain system.
net set hostname host
Set the hostname of the Data Domain system. Note that some browsers may prevent
logins to the host if the hostname contains an underscore. Data Domain recommends
using hostnames without underscores to ensure the GUI can recognize and manage the
host.

152 EMC Data Domain Operating System 5.4 Command Reference Guide
 net

Note

If the Data Domain system is using CIFS with Active Directory authentication, changing
the hostname causes the Data Domain system to drop out of the domain. Use the cifs
set authentication command option to rejoin the Active Directory domain.

net set portnaming {slot-based | legacy}

Change the port naming scheme.

net show
net show all
Display all networking information, including IPv4 and IPv6 addresses. Some IPv6
addresses are automatically assigned to interfaces, either linklocal or router-generated
addresses. Auto-assigned addresses are displayed with the kernel information but not
with the registry settings, as in the net show settings command, because they do
not exist in the registry. This type of address cannot be changed or modified.
net show config [ifname]
Display the configuration for a specific Ethernet interface. Exclude the keyword ifname to
view the configuration for all Ethernet interfaces. This command shows auto-generated
IPv6 addresses.
In the example, the interface eth0a shows a statically assigned IPv6 address; however,
because the interface cannot come up to the RUNNING state the link local and router-
generated address are not available. Interface eth0b shows a IPv4 static address and two
auto-generated IPv6 addresses.
net show {domainname | searchdomains}
Display the domain name or search domains used for email sent by a Data Domain
system.
net show dns
Display a list of DNS servers used by the Data Domain system. The final line in the output
shows if the servers were configured manually or by DHCP.
net show hardware
Display Ethernet port hardware information from the kernel.
Output Definitions
Port
The Ethernet interfaces on the system.
Speed
The actual speed at which the port processes data.
Duplex
Full or half duplex protocol.
Supp Speeds
Lists speeds the port is capable of using.
Hardware Address
The MAC address.
Physical
Copper or fibre.

net show hostname

Display the hostname of the Data Domain system.

net show 153

net

net show settings

Display the registry settings for the network interfaces available on the system. Settings
include the interface name for the physical, virtual, VLAN, and aliases. The settings also
indicate if an interface is enabled and if the interface information is from DHCP. Settings
contain the IP address and netmask prefix length. The IPv6 addressing scheme uses
colons to separate values, and a prefix length to define the subnet. IPv4 uses periods to
separate values and includes a netmask to define the subnet. A type field and additional
settings such as bonding information are also included.
net show stats [[ipversion {ipv4 | ipv6}] [all | listening]
[detailed] |[ipversion {ipv4 | ipv6}] route | interfaces |
statistics]
Display network statistics. The ipversion argument shows information on IPv4 or IPv6
addresses only. The default shows all TCP connections, including IPv4 and IPv6
addresses. The argument all includes the LISTENING information and the open sockets.
The argument detailed adds the associated processes for each connection. The
argument interfaces provides a table of the driver statistics for each interface that is
UP. The argument route displays the route table (default is IPv4 only). The argument
statistics displays the statistics for IP, IP extended, ICMP, TCP, TCP extended, UDP,
and UDP Lite.

net tcpdump
net tcpdump capture filename [interface iface] [{host host
[ipversion {ipv4 | ipv6} ] | net {ipaddr [mask mask] |
ipv6addr[/prefixlength]}}] [port port] [snaplen bytes]
Capture data, and then copy the output file to another system for analysis. This command
converts the options from the command line to equivalent tcpdump options. Output files
are placed in /ddvar/traces where you can upload them to autosupport. A maximum
of 10 output files may be retained on the system. If this limit is reached, you are
prompted to delete some of the files.
net tcpdump del {filename | all}
Delete output files created by the net tcpdump capture command. Specify a
filename to delete files matching the pattern /ddvar/traces/tcpdump_filename *.
Specify all to remove all net tcpdump output files.

net troubleshooting
net troubleshooting duplicate-ip
Detect duplicate IP in network.

net Additional Topics

This section provides additional information on various topics and concepts.

DD OS Linux Equivalent Arguments for tcpdump Option

The DD OS tcpdump command dumps network traffic output as does the Linux
tcpdump command. Values for bytes may be followed by the K, M, or G to scale the
value. accordingly.

154 EMC Data Domain Operating System 5.4 Command Reference Guide
 net

DD OS filename
Linux -w /ddvar/traces/tcpdump_filename -C 100 -W 5
DD OS interface iface
Linux -i iface
DD OS host host
Linux host host
DD OS net net
Linux net net
DD OS mask mask
Linux mask mask
DD OS port port
Linux port port
DD OS snaplen bytes
Linux -s bytes

Linux DD OS Equivalent Arguments for iperf Option

The iperf Linux command measures the quality and bandwidth of network connections.
The DD OS net iperf command provides equivalent capabilities. Values for bytes may
be followed by the K, M, or G suffice for to scaling the value.
DD OS server-host
Linux -c server-host
DD OS port
Linux -p port
DD OS window-size bytes
Linux -w iperf-bytes
DD OS transmit-size bytes
Linux -n iperf-bytes
DD OS duration secs
Linux -t secs
DD OS interval secs
Linux -j secs
DD OS data random
Linux -R (Data Domain version of iperf)
DD OS no delay
Linux -N
DD OS connections count
Linux -p number
DD OS none
Linux -X (Data Domain version of iperf)

More About Ethernet Failover

Ethernet failover provides improved network stability and performance, and is
implemented with the net failover command. The failover-enabled virtual interface
represents a group of secondary physical interfaces, one of which can be specified as the

Linux DD OS Equivalent Arguments for iperf Option 155

net

primary. The system makes the primary interface the active interface when the primary
interface is operational. A failover from one physical interface to another can take up to
30 seconds. The delay is to guard against multiple failovers when a network is unstable.
Guidelines on Failing Over an Interface
Consider the following guidelines when planning an interface failover:
l For best results, a primary interface should be part of the failover. This provides a way
of determining which interface is active. A primary slave cannot be removed from the
bonding except in the case of net failover reset command, during which all
slaves are removed.
l A primary interface must be explicitly specified as the primary, and must also be a
slave, to the virtual interface. To designate a physical interface as the primary failover
interface, use the optional primary argument. If the primary interface goes down
and multiple interfaces are available, the next interface is selected at random.
l The virtual interface must be present on the system. Use the net show settings
command option to confirm the presence of a virtual interface.
l Enable failover on the existing virtual interface name in the form vethx, where x is a
unique string (typically one or two digits). A typical full virtual interface name with
and associated VLAN and alias is veth56.3999:199. The maximum name length is 15
characters, which typically limits the name string x to two characters. Special
characters are not supported. Use commas, spaces, or both to separate list entries.
l If a primary interface is part of the failover, it cannot be deleted from the failover
while it is the primary interface. Use the net failover modify command to
change the primary interface. To remove the slave from an interface, set another
interface to primary or none.
For example, to associate a failover virtual interface named veth1 with the physical
interfaces eth2a and eth3a, and to designate eth2a as the primary:
# net failover add veth1 interfaces eth2a eth3a primary eth2a

Interface Naming Format

The interface naming format is eth<slot #><a-d>. Letters are sequential without gaps.
For onboard NIC vertical interfaces, the top or left interface is eth0a and the bottom or
right interface is eth0b.
For onboard NIC horizontal interfaces, the left interface, as viewed from the rear, is eth0a
and the right is eth0b.
For systems with SLIC cards, port naming has changed:
l Onboard interfaces are ethMa, ethMb, ethMc, ethMd.
l Lettering follows the physical labeling of the ports on the onboard and optional card:
0 equals a, 1 equals b, 2 equals c, and 3 equals d. Therefore, if the interface is
onboard and has a label of 0, the name is ethMa. If the interface is in slot 4 and has a
label of 2, the interface name is eth4c.
Physically this means slots are numbered from left to right. Interfaces on the optional
cards are numbered from the bottom up.
In configurations of four onboard interfaces, the top left interface is eth0a, the top right
interface is eth0b, the bottom left interface is eth0c, and the bottom right interface is
eth0d. For optional cards installed vertical or horizontal, the interface at the top of the
card is ethxa, the next is ethxb, the nxt is ethxc, and so on, until the bottom of the card
where x is the slot number.
This ensures:

156 EMC Data Domain Operating System 5.4 Command Reference Guide
 net

l A method for identify the correct physical link from the logical link.
l The interface names do not change if cards are added or removed.
l The interface name is not dependent on the type of cards in the system.
When interface names prior to 4.9 are changed to the current naming structure, the
associated configuration names are also changed. For example, eth1.236 becomes
eth0b.236, eth1 and eth0 bonded to veth1 becomes eth0a and eth0b bonded to veth1.
Note that the revised naming format is not required for virtual interfaces; however, slaves
are renamed. Virtual interfaces can be removed from interface list by running the
destroy command.

Number of Physical Interfaces

The recommended number of physical interfaces for failover is two. However, you can
configure one primary interface and five failover interfaces. Exceptions are 10 Gb CX4
Ethernet cards, which are restricted to one active interface and one standby interface
(both slaves must be on same card), and 10 Gb optical, single-port Ethernet cards, which
cannot be used in failover or aggregation. Note that the SFP+ 10 Gb interfaces do not
have these restrictions.

Number of Ports
The number of ports depends on the number and type of Ethernet cards, and on the
system type. A system with two Ethernet cards has a maximum of six ports: eth0a, eth0b,
eth4a, eth4b, eth5a, eth5b. If one of the cards is a 1-port 10 GbE fiber, the maximum is
five ports. A system with two on-board interfaces and two quad-port NICs has a maximum
10 ports.
Newer systems, such as DD2500, support three Ethernet SLICs, 4 x 1 GbE onboard and 2
x 10GBaseT onboard, allowing a maximum of 18 physical ports, depending on the
Ethernet SLIC types (Quad Port 1000Base-T, 2x1000Base-T/2x1000Base-SR and Dual
Port 10G Ethernet).
Systems DD4200, DD4500 and DD7200 support six Ethernet SLICS allowing a maximum
of 24 physical ports, depending on the Ethernet SLIC types (Quad Port 1000Base-T,
2x1000Base-T/2x1000Base-SR and Dual Port 10G Ethernet).

Sample Failover Workflow

Procedure
1. Disable the interfaces eth2a, eth3a, and eth4a for use as failover interfaces:
# net disable eth2a
# net disable eth3a
# net disable eth4a
2. If virtual interface veth1 does not exist on the system, create it:
# net create virtual veth1
3. Create a failover virtual interface named veth1 using the physical interfaces eth2a and
eth3a:
# net failover add veth1 interfaces eth2a, eth3a
4. Enable virtual interface veth1:
# net config veth1 10.20.199.41 netmask 255.255.0.0
5. Show configured failover virtual interfaces:
# net failover show

To add the physical interface eth4a to failover virtual interface veth1:

Number of Physical Interfaces 157

net

# net failover add veth1 interfaces eth4a

To remove eth2a from the virtual interface veth1:

# net failover del veth1 interfaces eth2a

To clear the virtual interface veth1 of the IP address and release the associated
physical interfaces:
# net failover reset veth1

To reenable the physical interfaces:

# net enable eth2a
# net enable eth3a
# net enable eth4a

Sample Aggregation Workflow

Procedure
1. Disable the interfaces eth2a, eth3a, and eth4a to use as aggregation interfaces:
# net disable eth2a
# net disable eth3a
# net disable eth4a
2. If virtual interface veth1 does not exist on the system, create it:
# net create virtual veth1
3. Enable link aggregation on virtual interface veth1 for physical interfaces eth2a and
eth3a in xor-L2 mode:
# net aggregate add veth1 mode balanced hash xor-L2 interfaces
eth2a eth3a
4. Enable the virtual interface:
# net config veth1 192.168.45.119 netmask 255.255.248.0
5. Show the aggregate setup:
# net aggregate show

To delete physical interface eth3a from the aggregate virtual interface veth1:
# net aggregate del veth1 interfaces eth3a

To add link physical interface eth4a on virtual interface veth1:

# net aggregate add veth1 mode xor-L2 interfaces eth4a

To remove all interfaces from veth1:

# net aggregate reset veth1

To reenable the physical interfaces:

# net enable eth2a
# net enable eth3a
# net enable eth4a

158 EMC Data Domain Operating System 5.4 Command Reference Guide
CHAPTER 22
nfs

The nfs command enables you to add NFS clients and manage access to a Data Domain
system. It also enables you to display status information, such as verifying that the NFS
system is active, and the time required for specific NFS operations.
This chapter contains the following topics:

l nfs Change History.............................................................................................. 160

l nfs Guidelines and Restrictions........................................................................... 160
l nfs add................................................................................................................160
l nfs del.................................................................................................................161
l nfs disable.......................................................................................................... 161
l nfs enable........................................................................................................... 161
l nfs reset..............................................................................................................161
l nfs show ............................................................................................................ 161
l nfs status............................................................................................................ 162

nfs 159
nfs

nfs Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 23 nfs Change History

Version Change
5.4 No changes from previous version.

nfs Guidelines and Restrictions

l Unless otherwise noted, command options are available only to users with admin
role permissions.
l Separate list entries by commas, spaces, or both.

nfs add
nfs add pathclient-list [(option-list)]
Add NFS clients that can access the Data Domain system. A client can be a fully qualified
domain hostname, class-C IP addresses, IP addresses with netmasks or length, an NIS
netgroup name with the prefix @, or an asterisk wildcard for the domain name, such as
*.yourcompany.com.
An asterisk by itself means no restrictions. A client added to a subdirectory under /
backup has access only to that subdirectory.
The options-list is comma or space separated, enclosed by parentheses. If no option is
specified, the default options are rw, root_squash, no_all_squash, and secure.
NFS Options
ro
Enable read-only permission.
rw
Enable read and write permissions (default value).
root_squash
Map requests from uid or gid 0 to the anonymous uid/gid.
no_root_squash
Turn off root squashing (default value).
all_squash
Map all user requests to the anonymous uid/gid.
no_all_squash
Turn off the mapping of all user requests to the anonymous uid/gid (default value).
secure
Require that requests originate on an Internet port that is less than
IPPORT_RESERVED (1024) (default value).

160 EMC Data Domain Operating System 5.4 Command Reference Guide
 nfs

insecure
Turn off the secure option.
anonuid=id
Set an explicit user ID for the anonymous account. The ID is an integer bounded from
0 to 65635.
anongid=id
Set an explicit group ID for the anonymous account. The ID is an integer bounded
from 0 to 65635.

nfs del
nfs del pathclient-list
Delete specific directories, including a backup subdirectory, for one or more clients. The
client-list can contain IP addresses, hostnames, or an asterisk that represents all clients.

nfs disable
nfs disable
Disable all NFS clients.

nfs enable
nfs enable
Allow all NFS-defined clients to access the Data Domain system.

nfs reset
nfs reset clients
Reset client list to the factory default empty. NFS clients can access the Data Domain
system when the list is empty.
nfs reset stats
Clear the NFS statistics.

nfs show
nfs show active
List clients active in the past 15 minutes and the mount path for each.
nfs show clients
List NFS clients allowed to access the Data Domain system and the mount path and NFS
options for each.
nfs show detailed-stats
Display NFS cache entries and status to facilitate troubleshooting.
nfs show histogram
Display NFS operations in a histogram. Users with user role permissions may run this
command.

nfs del 161

nfs

Output Definitions
mean-ms
The mathematical mean time for completion of the operations.
stddev
The standard deviation for time to complete operations, derived from the mean time.
max-s
The maximum time taken for a single operation.
2ms
The number of operations that took 2 ms or less.
4ms
The number of operations that took between 2ms and 4ms.
6ms
The number of operations that took between 4ms and 6ms.
8ms
The number of operations that took between 6ms and 8ms.
10ms
The number of operations that took between 8ms and 10ms.
100ms
The number of operations that took between 10ms and 100ms.
1s
The number of operations that took between 100ms and 1 second.
10s
The number of operations that took between 1 second and 10 seconds.
>10s
The number of operations that took over 10 seconds.

nfs show port

Display NFS port information. Users with user role permissions may run this command.
nfs show stats
Display NFS statistics.

nfs status
nfs status
Enter this option to determine if the NFS system is operational. When the filesystem is
active and running, the output shows the total number of NFS requests since the
filesystem started, or since the last time that the NFS statistics were reset.

162 EMC Data Domain Operating System 5.4 Command Reference Guide
CHAPTER 23
ntp

The ntp command synchronizes a Data Domain system with an NTP time server,
manages the NTP service, or turns off the local NTP server.
A Data Domain system can use a time server supplied through the default multicast
operation, received from Dynamic Host Configuration Protocol (DHCP), or set manually
with the Data Domain system ntp add command.
This chapter contains the following topics:

l ntp Change History..............................................................................................164

l ntp Guidelines and Restrictions...........................................................................164
l ntp add............................................................................................................... 164
l ntp del................................................................................................................ 164
l ntp disable..........................................................................................................165
l ntp enable...........................................................................................................165
l ntp reset............................................................................................................. 165
l ntp show............................................................................................................. 165
l ntp status............................................................................................................165

ntp 163
ntp

ntp Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 24 ntp Change History

Version Change
5.4 No changes made from previous version.

ntp Guidelines and Restrictions

l Unless otherwise noted, command options are available only to users with admin
role permissions.
l Default system settings for NTP service are enabled and multicast.
l Time servers set with the ntp add command override time servers from DHCP and
from multicast operations.
l Time servers from DHCP override time servers from multicast operations.
l The Data Domain system ntp del and ntp reset commands act only on
manually added time servers, not on DHCP-supplied time servers. You cannot delete
DHCP time servers or reset to multicast when DHCP time servers are supplied.

ntp add
ntp add timeserver server-name
Add a remote time server to NTP list. This command option requires security officer
authorization for Retention Lock Compliance systems.

Example 59

To add an NTP time server named srvr26.yourcompany.com to the list, enter:

# ntp add timeserver srvr26.yourcompany.com

ntp del
ntp del timeserver server-name
Delete a manually added time server from the list. This command option requires security
officer authorization for Retention Lock Compliance systems.

Example 60

To delete an NTP time server named srvr26.yourcompany.com from the list, enter:

# ntp del timeserver srvr26.yourcompany.com

164 EMC Data Domain Operating System 5.4 Command Reference Guide
 ntp

Example 60 (continued)

ntp disable
ntp disable
Disable NTP service on a Data Domain system. This command option requires security
officer authorization for Retention Lock Compliance systems.

ntp enable
ntp enable
Enable NTP service on a Data Domain system. This command option requires security
officer authorization for Retention Lock Compliance systems.

ntp reset
ntp reset
Reset the NTP configuration to the default settings. This command option requires
security officer authorization for Retention Lock Compliance systems.
ntp reset timeservers
Reset the time server list from manually entered time servers to DHCP time servers (if
supplied) or to the multicast mode (if no DHCP time servers supplied). This command
option requires security officer authorization for Retention Lock Compliance systems.

ntp show
ntp show config
Display status of NTP: enabled or disabled, and show the time server list.

ntp status
ntp status
Display the local NTP service status, time, and synchronization information.

ntp disable 165

ntp

166 EMC Data Domain Operating System 5.4 Command Reference Guide
CHAPTER 24
quota

The quota command lets you modify the amount of storage space for MTrees and for VTL
and DD Boost storage units. There are two quota limits: hard and soft. The hard limit
prevents writes from exceeding the quota. An error message is issued if the hard limit is
exceeded. The soft limit allows writes to exceed the quota. However, an alert is generated
if this happens. The soft limit value must be less than the hard limit value. Quota limit
values must be specified as integers.
You can set a hard limit, a soft limit, or both, depending on your requirements. For
example, an administrator may choose to enforce only a soft limit to prevent overnight
backup jobs from failing when the quota limit is reached. Or the administrator may
choose to enforce only a hard limit to block a user from writing when the quota limit is
reached.
Snapshots capture quota information at a precise point in time. Usage tracking in the
active file system does not account for the space of a snapshot, so quota limits are not
enforced on snapshots.
This chapter contains the following topics:

l quota Change History.......................................................................................... 168

l quota Guidelines and Restrictions.......................................................................168
l quota disable......................................................................................................168
l quota enable.......................................................................................................168
l quota reset..........................................................................................................168
l quota set.............................................................................................................169
l quota show......................................................................................................... 170
l quota status........................................................................................................170

quota 167
quota

quota Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 25 quota Change History

Version Change
5.4 No changes made from previous version.

quota Guidelines and Restrictions

l MTree quotas with a hard limit cannot be set on the /data/col1/backup
directory.
l The maximum MTree quota value is 4096 PiB. See the mtree command for more
detail.

quota disable
quota disable
Disable quota support. This command option also disables MTree quota limits and
restores the limits to the default state (unlimited).

quota enable
quota enable
Enable quota support.

quota reset
quota reset { all | mtrees mtree-list | storage-units storage-
unit-list } [soft-limit] [hard-limit]
Reset quota limits. If hard or soft limits are not entered, both are reset to the default state
(unlimited).

Example 61

To reset hard and soft limits for an MTree:

# quota reset mtrees /data/col1/backup1

Example 62

To reset soft limit only for an MTree:

# quota reset mtrees /data/col1/backup1 soft-limit

168 EMC Data Domain Operating System 5.4 Command Reference Guide
 quota

Example 62 (continued)

Example 63

To reset hard limit only for an MTree:

# quota reset mtrees /data/col1/backup3 hard-limit

Example 64

To reset hard and soft limits for a storage-unit:

# quota reset storage-units /data/col1/DDBOOST_STRESS_SU

quota set
quota set {all | mtrees mtree-list | storage-units storage-
unit-list} {soft-limit n {MiB|GiB|TiB|PiB} | hard-limit n {MiB|
GiB|TiB|PiB} | soft-limit n {MiB|GiB|TiB|PiB} hard-limit n
{MiB|GiB|TiB|PiB}}
Set quota limits during runtime for multiple MTrees. When used for storage units, this
command option sets limits only after the storage unit is created. Note that the quota
feature must be enabled, otherwise limits are not enforced. Setting quotas does not
require disabling the filesystem and therefore does not affect system performance.

Example 65

To set a soft limit quota of 10 GiB on MTree /data/col1/backup1 when the quota
feature is disabled:

# quota set mtrees /data/col1/backup1 soft-limit 10 GiB

Example 66

To set a hard limit quota of 10 TiB on MTree /data/col1/backup1:

# quota set mtrees /data/col1/backup1 hard-limit 10 GiB

Example 67

To set a soft limit quota of 100GiB and a hard limit quota of 1TiB on MTree /data/
col1/backup1:

# quota set mtrees /data/col1/backup1 soft-limit 10 GiB hard-limit 10

TiB

Example 68

quota set 169

quota

Example 68 (continued)

To set a soft limit quota of 100 GiB and a hard limit quota of 1 TiB on storage-unit
DDBOOST_STRESS_SU:

# quota set storage-units DDBOOST_STRESS_SU soft-limit 100 GiB hard-

limit 1 TiB

quota show
quota show {all | mtrees mtree-list | storage-units storage-
unit-list}
List the quota limits and usage of a particular mtree or storage unit, all mtrees or storage
units, or all of both. The unit of display for usage and limits is MiB.

quota status
quota status
Display status of quota enforcement: enabled or disabled. If output includes a note
stating status as disabled, quota limits are not being enforced and are therefore
unlimited.

170 EMC Data Domain Operating System 5.4 Command Reference Guide
CHAPTER 25
replication

EMC Data Domain Replicator lets you replicate data (copy and synchronize) between two
Data Domain systems: a source and a destination. Source and destination
configurations, or pairs, are also known as contexts. Depending on your objective, you
can replicate entire sites, specific directories, MTrees, or files within a VTL (virtual tape
library). Replication is a licensed software option. See theEMC Data Domain Operating
System Administration Guide for details on replication practices and procedures.
This chapter contains the following topics:

l replication Change History.................................................................................. 172

l replication Guidelines and Restrictions............................................................... 172
l replication abort..................................................................................................172
l replication add....................................................................................................172
l replication break................................................................................................. 173
l replication disable.............................................................................................. 173
l replication enable............................................................................................... 173
l replication initialize............................................................................................ 173
l replication modify............................................................................................... 174
l replication option................................................................................................175
l replication reauth................................................................................................175
l replication recover.............................................................................................. 175
l replication resync ...............................................................................................176
l replication show..................................................................................................176
l replication status................................................................................................ 178
l replication sync...................................................................................................179
l replication throttle.............................................................................................. 179
l replication watch.................................................................................................180

replication 171
replication

replication Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 26 replication Change History

Version Change
5.4 No changes made from previous version.

replication Guidelines and Restrictions

l Unless otherwise noted, command options are available only to users with admin
role permissions.
l Ensure adequate storage is available on the source and destination. With the
exception of collection replication, the destination must have more space than the
source.
l With the exception of collection replication, the destination directory is overwritten
during replication. Before starting, verify the destination directory is empty or that its
contents are not required.
l A source subdirectory cannot be in another directory replication context. A directory
can be in only one context at a time.
l Subdirectories within an MTree cannot be replicated. The entire MTree is replicated.
l Command options may take several seconds to conclude when a Data Domain
system is at, or near, capacity.
l If the source or destination hostnames do not correspond to the Data Domain
network names, modify the name by running the command option replication
modify connection-host on the source system.
l When entering source names source that include spaces or special characters,
enclose the entire source pathname with double quotation marks, or enter a
backslash before the space. Do not use both.

replication abort
replication abort recover destination
Stop a recover process. Run this command option on the destination Data Domain
system only. Then, reconfigure replication on the source Data Domain system and restart
the recover process.
replication abort resync destination
Stop a resync operation. Run this command option on the source or destination Data
Domain system.

replication add
replication add source source destination destination [low-bw-
optim {enabled | disabled}] [encryption {enabled | disabled}]

172 EMC Data Domain Operating System 5.4 Command Reference Guide
 replication

[propagate-retention-lock {enabled | disabled}] [ipversion

{ipv4 | ipv6}]
Create a replication pair. Use low-bw-optim enabled to enable replication. Low
bandwidth optimization is active only when enabled on the source and destination and
cannot be used for collection replication.

Note

MTree replication from a system with Extended Retention to a single-node Data Domain
system is supported only for recovering previously replicated data. Enabling this feature
for purposes other than recovery generates a warning message. See the EMC Data Domain
Operating System Administration Guide for details.

replication break
replication break {destination | all}
Remove the source or destination Data Domain system from a replication pair, or remove
all Replicator configurations from a Data Domain system. This command option requires
security officer authorization for Retention Lock Compliance systems.

replication disable
replication disable {destination | all}
Run this command on the source or destination system to halt data replication
temporarily. If run on the source, the operation stops sending data to the destination. If
run on the destination, the operation stops serving the active connection from the source.
This command option requires security officer authorization for Retention Lock
Compliance systems.

replication enable
replication enable {destination | all}
Restart replication. If run on the source, the operation resumes sending data to the
destination. If run on the destination, the operation resumes serving the active
connection from the source.

replication initialize
replication initialize destination
Run this command option on the source to start replication between a source and
destination. This command option verifies the configuration and connections are correct
and returns error messages if problems appear.
The initialize operation can take several hours, or days, depending on the amount of data
in the source. As an alternative, consider placing both Data Domain systems of the
replicator pair in the same location with a direct link to reduce initialization time. The
destination variable is required.
Key-manager settings on a destination are ignored when users set up and initialize a
collection replication pair. The keys are copied to the replica, but key-manager settings
are not. If the destination is configured with key-manager settings prior to becoming the
replication destination, the settings remain on the system but are not used. If a collection

replication break 173

replication

replication breaks, you must reconfigure the destination to use the correct key-manager
settings and key class.
EMC recommends resetting the key-manager on the destination prior to collection
replication, and then configuring the destination with the correct key manager-server and
key class after a collection replication is broken.

replication modify
replication modify destination connection-host new-host-name
[port port]
Run this command option if the destination hostname does not resolve for the
connection. Use the modify connection-host option to correct the name or IP
address. An optional port number may also be used.
The connection-host option may be required when a connection passes through a
firewall, and is required when connecting to an alternate listen-port on the destination. It
may also be required after adding a new source and destination pair, or after renaming a
source or a destination.
replication modify destination {source-host | destination-host}
new-host-name
Assign a new hostname to a replacement system in a replication pair. The new-host-name
must be the name returned by the hostname command on the system receiving the new
host.
Run this command option on the destination system to change the hostname on a source
system. Do not use the command to change the hostname on the destination. Contact
Data Domain Support before changing the hostname on a destination system.
When using the replication modify command option, always run the filesys
disable command first, and conclude with the filesys enable command.

Example 69

If the local destination ca.company.com is moved from California to New York, enter the
following command options on the source and destination:

# filesys disable
# replication modify dir://ca.company.com/backup/dir2 destination-
host ny.company.com
# filesys enable

replication modify destination encryption {enabled | disabled}

Modify the destination hostname and set the state of encryption.
replication modify destination ipversion {ipv4 | ipv6}
Modify the source or destination host name, the connection host, or the context
attributes.
replication modify destination low-bw-optim {enabled |
disabled}
Enable delta replication on a replication context. This option is active only when enabled
on the source and destination. This option does not apply to collection replication.

174 EMC Data Domain Operating System 5.4 Command Reference Guide
 replication

replication option
replication option reset {bandwidth | delay | listen-port |
default-sync-alert-threshold}
Reset system bandwidth, delay, listen port, and sync-alert-threshold to default values.
Defaults are bandwidth, unlimited; delay, none; listen-port, 2051. Default for
sync-alert-threshold is 24 (hours).
When using the replication option reset command options, always run the
filesys disable command first, and conclude with the filesys enable
command.
replication option set bandwidth rate
Set the network bandwidth rate for the Data Domain system. You must set the bandwidth
and network delay on each side of the connection.
replication option set default-sync-alert-threshold value
Set the sync time to configure when an alert is generated. The sync time is set in hours.
Default value is 24.
replication option set delay value
Set the network delay in milliseconds for the Data Domain system. You must set the
bandwidth and network-delay on each side of the connection.
replication option set listen-port value
Set the listen port for the Data Domain system. On a destination Data Domain system, set
the port from which the destination receives data from replication sources (default is
2051). A destination can have only one listen port used by all sources. The connection-
host port used by a source must match the listen port used by the destination.
For DD Boost managed file replication, the listen port is used on the source Data Domain
system and on the destination Data Domain system to specify the connection-host port.
For directory replication, the replication modify connection-host command option is used
on the source Data Domain system.
replication option show
Display the current bandwidth, network-delay settings, listen port, and sync-alert-
threshold. If these settings are configured using default values, the command option
returns a command prompt with no setting information. All users may run this command.

replication reauth
replication reauth destination
Use this command on the source and the destination systems to reset authentication. A
destination variable is required.
Messages similar to Authentication keys out of sync or Key out of sync
indicate a reset is required. Reauthorization is primarily used when replacing a source
Data Domain system.

replication recover
replication recover destination
Run this command option on a new source to move data from a destination system. If
configuring collection replication, this option must be run on the new source only. A
destination argument is required. This command is not available for MTree replication.

replication option 175

replication

When using the replication recover command option, always run the filesys
disable command option first, and conclude with the filesys enable command
option.
If the replication break command was previously run, the destination cannot be
used to recover a source. If configuring directory replication, the target directory on the
source must be empty.

replication resync
replication resync destination
Synchronize replication when directory replication is broken between a source and
destination. Note that the source and the destination must be configured and the context
initialized.
This command option cannot be used with collection replication. Also, this command
fails if you try to replicate to a Retention Lock system and the destination is not empty.

replication show
replication show config [destination | all]
Show replication configuration. All users may run this command option.
replication show detailed-history {obj-spec-list | all}
[duration duration {hr | min}] [interval interval {hr | min}]
Show details of replication performance history. All users may run this command option.
Output Definitions
CTX
The context number for directory replication or a zero (0) for collection replication.
Source
The Data Domain system that receives data from backup applications.
Destination
The Data Domain system that receives data from the replication source Data Domain
system.
Connection Host and Port
A source system connects to the destination system using the name returned by the
hostname command on the destination. It may also connect using a destination
name or IP address and port designated by replication modify
connection-host command. The destination hostname may not resolve to the
correct IP address when connecting to an alternate interface on the destination, or
when passing through a firewall.
Low-bw-optim
The status of low-bw-optim: enabled, disabled, or configuration mismatch.
Enabled
The replication process is enabled and available to replicate data (yes) or disabled
and not available to replicate data (no).

replication show detailed-stats [destination | all]

Display cumulative statistics beginning from when the context was created. This
command option provides byte-count statistics related to identity filtering, delta
compression, and local compression. The ratio of the values Bytes after filtering by
destination to Bytes after low bandwidth optimization gives additional compression ratio
supplied by delta compression. All users may run this command option.

176 EMC Data Domain Operating System 5.4 Command Reference Guide
 replication

replication show history {obj-spec-list | all}

Show replication performance history. Statistics are generated hourly. All users may run
this command option.
Output Definitions
Pre-Comp (KB) Remaining
The amount of pre-compression data not replicated.
Replicated (KB) Pre-Comp
The amount of pre-compressed data replicated.
Replicated (KB) Network
The amount of compressed data sent over the network.
Synced-as-of Time
The time when the most recently replicated data on the destination was generated
on the source. A value of unknown appears during replication initialization.
Low-bw-optim
The additional compression ratio supplied by delta compression.

replication show performance {obj-spec-list | all} [interval

sec] [count count]
Display current replication activity. Default interval is two seconds. All users may run this
command option.
If a single source context is specified, four additional columns are presented. These
columns show the relative amounts of time spent working on, or waiting for, replication
sender threads for the specified context. Values are calculated by the amount of time
spent for the activity, multiplying the time by 100, and dividing the time by the duration
of the reporting interval. Values can exceed 100 due to the presence of multiple threads
working on behalf of the specified replication context.
When a replication throttle is configured, users may see a large amount of output
followed by a period of none while viewing performance or statistics. This behavior is the
result of how statistics are calculated by replication, combined with the default Data
Domain system replication configuration of using large TCP buffers. When a throttle is in
effect, data is buffered before being sent on the network.
Users may configure the replication bandwidth and delay arguments in the replication
option reset command on the source and destination to use smaller TCP socket buffers.
This reduces the total amount of data on the network, increases how often replication
writes data to its sockets and, as a result, increases the frequency of updates for
statistics counters.
Output Definitions
Pre-comp (KB/s)
The size value before compression is applied. Sometimes referred to as logical size.
Network (KB/s)
The amount of compressed data transferred over the network per second.
Streams
An internal system resource associated with reads and writes. One replication
context can use multiple streams for better performance.
Reading
The time spent reading filesystem data from the local filesystem. Typically this
number is the second highest number after Network. On a deployment with high
network bandwidth, Reading may be the largest column.

replication show 177

replication

Meta
The time spent on miscellaneous bookkeeping activities and replicating filesystem
namespace operations. Typically this value is under 50. If this value exceeds 50 on a
sustained basis, it may indicate an unusual workload (a large number of file
attribute updates, for example).
Dest
The time spent waiting due to the receiver not providing the sender enough
information on what data to send. Typically this value is low. Exceptions include
systems on high-speed networks where the sender is a more powerful Data Domain
system than the replica, or where the replica has a higher workload than the sender
because the replica is the destination for a multiple replication contexts.
Network
The time spent sending file data and metadata and waiting for replies from the
server on what data needs to be sent. Typically this is the highest of the four values.
This value exceeds 100 regularly if the sender is able to replicate multiple files in
parallel.

Note

If the Network column has the highest time values among Reading, Meta, Waiting, and
Network, and if the Network KB/sec value is lower than expected, a network problem may
be present. For example, packet loss may be causing reduced throughput.
replication show stats [destination | all]
Display statistics for all replication pairs or a specific destination pair. Output format is is
based on replication type. All users may run this command option.
Note that in collection replication, the difference in values between Post-comp Bytes Sent
and Post-comp Bytes Received is expected behavior.
Output Definitions
CTX
The context number for replication. The number zero (0) indicates collection
replication.
Destination
The replication destination.
Post-comp Bytes Sent
Network data sent by the source to the destination.
Post-comp Bytes Received
The number of bytes received by the source, including logical bytes associated with
the file being replicated.
Synced-as-of-Time
The time when the most recently replicated data on the destination was generated
on the source. A value of Unknown appears during replication initialization.
Pre-comp Bytes Remaining
Directory replication only: The sum of file sizes remaining to be replicated for the
context. Output includes the entire logical size of the current file being replicated. If
a large file is being replicated, this number may take some time to change. The
number changes only after the current file finishes.

replication status
replication status [destination | all] [detailed]

178 EMC Data Domain Operating System 5.4 Command Reference Guide
 replication

Show status replication status. All users may run this command option.

replication sync
replication sync [and-verify] [destination]
Synchronize replication between the source and destination and wait for replication to
complete. You must first configure the source and destination and initialize the context.

replication throttle
replication throttle add sched-specrate
Change the rate of network bandwidth used by replication. By default, the network
bandwidth use is unlimited, meaning it continuously runs as fast as possible.
Replication runs at the given rate until the next scheduled change, or until new throttle
commands force a change. The system enforces a minimum rate of 98,304 bits per
second (12 KiB).
Argument Definitions
sched-spec
Specifies one or more three-letter days of the week (such as mon, tue, or wed), or
the word daily (to set the schedule every day). This argument can also specify a
time of day in 24-hour format.
rate
Includes a number or the word unlimited. Rate can also be zero, disable, or
disabled (each stops replication until the next rate change). If you set rate to zero,
new contexts are also throttled to zero.
The number can include a tag for bits or bytes per second. Do not use a space
between the number and the bits or bytes specification. The default rate is bits per
second.
In the rate variable:

l bps or b equals raw bits per second

l Kibps, Kib, or K equals 1024 bits per second
l Bps or B equals bytes per second
l KiBps or KiB equals 1024 bytes per second
Kib = Kibibits, the base-2 equivalent of Kb or Kilobits. KiB = Kibibytes, the base-2
equivalent of KB or Kilobytes.

Example 70

To limit replication to 20 kibibytes per second starting on Mondays and Thursdays at

6:00 a.m., enter:

# replication throttle add mon thu 0600 20KiB

replication throttle del sched-spec

Remove one or more throttle schedule entries.
The sched-spec variable must include one or more three-letter days of the week (such as
mon, tue, or wed), or the word daily (to set the schedule every day), and a time in 24-
hour format.

replication sync 179

replication

Example 71

To remove an entry for Mondays at 1:00 p.m., enter:

# replication throttle del mon 1300

replication throttle reset {current | override | schedule |

all}
Reset a throttling schedule.
Argument Definitions
current
Remove and reset the rate designated by the command option replication throttle
set current.
override
Remove and reset the rate designated by the command option replication throttle
set override.
schedule
Remove and reset scheduled changes.
all
Remove and reset current or override settings and remove all scheduled changes.
This option returns the system to the default settings.

replication throttle set current rate

Set the throttle rate until the next scheduled change or until a system reboot. Setting the
throttle to current cannot be done if the throttle set override command option is
in effect.
replication throttle set override rate
Set the throttle rate until another override command option is run. Throttle override
cannot be set if the throttle set current command option is in effect.
replication throttle show [KiB]
Show throttle configuration. All users may run this command option.

replication watch
replication watch destination
Display the progress of a replication initialization, resynchronization process, or recovery
operation. All users may run this command option.

180 EMC Data Domain Operating System 5.4 Command Reference Guide
CHAPTER 26
route

The route command manages routing between a Data Domain system and backup
hosts. An additional routing rule in the Kernel IP routing table and in the Data Domain
system Route Config list shows a list of static routes reapplied at each system boot. Each
interface is assigned a route based on the address assigned to it. Also, depending on the
default gateway subnet, a route is added to an interface automatically if the interface is
in the subnet of the default route address.
Federal certification requirements state the DD OS must be IPv6-capable and that
interoperability with IPv4 be maintained in a heterogeneous environment. As a result,
several net command options now include arguments for both versions of Internet
Protocol. EMC Data Domain customers select which version to use, based on the type of
configuration.
This chapter contains the following topics:

l route Change History...........................................................................................182

l route Guidelines and Restrictions........................................................................182
l route add............................................................................................................ 182
l route del............................................................................................................. 182
l route reset.......................................................................................................... 183
l route set............................................................................................................. 183
l route show.......................................................................................................... 183
l route trace.......................................................................................................... 183

route 181
route

route Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 27 route Change History

Version Change
5.4 No changes made from previous version.

route Guidelines and Restrictions

l Unless otherwise noted, command options are available only to users with admin
role permissions.
l Changes to Ethernet interfaces made with net command options flush the routing
table. All routing information is lost and data movement using routing is cut off
immediately. EMC Data Domain recommends making interface changes only during
scheduled downtime. You must reconfigure routing rules and gateways after making
interface changes.

route add
route add [ipversion {ipv4 | ipv6}] route-spec
Add a routing rule.

Example 72

To add a route with a route specification of 192.168.1.x, a netmask, and a gateway of

srvr12, enter:

# route add -net 192.168.1.0 netmask 255.255.255.0 gw srvr12

Example 73

To add a route for host user24 with a gateway of srvr12, enter:

# route add -host user24 gw srvr12

route del
route del [ipversion {ipv4 | ipv6}] route-spec
Remove a routing rule from the kernel IP routing table or Route Config list.

Example 74

To delete a route; for example, 192.168.1.0 and a netmask of 255.255.255.0, enter:

182 EMC Data Domain Operating System 5.4 Command Reference Guide
 route

Example 74 (continued)

# route del -net 192.168.1.0 netmask 255.255.255.0

route reset
route reset gateway [ipversion {ipv4 | ipv6}]
Reset the default routing gateway to the default value (empty).

route set
route set gateway {ipaddr | ipv6addr}
Change the routing default gateway. When the default gateway is added or changed, the
Data Domain operating system automatically adds a route to default gateway for each
interface with the same subnet.

Example 75

To give a default gateway when no other route matches, enter:

# route set gateway 192.168.10.1

route show
route show config
Display the configured static routes that are in the Route Config list.
route show gateway [ipversion {ipv4 | ipv6}]
Display the configured or DHCP-supplied routing gateways used by a Data Domain
system.
route show table [ipversion {ipv4 | ipv6}]
Display all entries in the Kernel IP routing table.

route trace
route trace [ipversion {ipv4 | ipv6}] host
Display a route used by a Data Domain system to connect with a particular destination.

Example 76

To trace the route to srvr24, enter:

# route trace srvr24

Traceroute to srvr24.yourcompany.com (192.168.1.6), 30 hops max, 38
byte packets
1 srvr24 (192.168.1.6) 0.163 ms 0.178 ms 0.147 ms

route reset 183

route

184 EMC Data Domain Operating System 5.4 Command Reference Guide
CHAPTER 27
scsitarget

The scsitarget command manages the SCSI (Small Computer System Interface) target
subsystem configuration on single-node Data Domain systems and on systems using
Extended Retention.
The SCSI target subsystem configuration comprises several SCSI target entities:
l services (VTL and DD Boost)
l transports (Fibre Channel)
l transport endpoints (Fibre Channel port)
l endpoints (such as VTL tape drives)
l logical devices
l host initiators
l access groups
This chapter contains the following topics:

l scsitarget Change History....................................................................................186

l scsitarget Guidelines and Restrictions.................................................................186
l scsitarget device................................................................................................. 186
l scsitarget disable................................................................................................186
l scsitarget enable.................................................................................................187
l scsitarget endpoint............................................................................................. 187
l scsitarget group.................................................................................................. 188
l scsitarget initiator............................................................................................... 189
l scsitarget persistent-reservation......................................................................... 190
l scsitarget reset....................................................................................................191
l scsitarget service................................................................................................ 191
l scsitarget show................................................................................................... 191
l scsitarget status..................................................................................................191
l scsitarget trace....................................................................................................191
l scsitarget transport............................................................................................. 192

scsitarget 185
scsitarget

scsitarget Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 28 scsitarget Change History

Version Change
5.4 No change from previous version.

scsitarget Guidelines and Restrictions

l Unless otherwise noted, command options are available only to users with admin
role permissions.
l In some cases, mostly group management, individual services provide interfaces
tailored to the service, for example, vtl group. These may be more convenient for daily
use than the generic scsitarget interface.
l Names of logical devices, endpoints, and access groups are case-insensitive and
case-preserving. They cannot include colons, question marks, commas, asterisks,
forward or backward slashes, or open or closed parentheses.
l Names for logical devices and endpoints cannot include the word all.
l Names for access groups cannot include the words summary, all, or VTL.

scsitarget device
scsitarget device show detailed [device-spec] [service service-
name] [group group-spec]
Show detailed information on SCSI target devices.
scsitarget device show list [device-spec] [service service-
name] [group group-spec]
List summary information on SCSI target devices. If no arguments are selected, output
displays basic information on all device criteria.
Command Option Arguments
group-name
Name of SCSI target access group.
service-name
A SCSI Target service such as VTL or DD Boost.

scsitarget disable
scsitarget disable
Disable the SCSI target subsystem.

186 EMC Data Domain Operating System 5.4 Command Reference Guide
 scsitarget

scsitarget enable
scsitarget enable
Enable the SCSI target subsystem.

scsitarget endpoint
scsitarget endpoint connection-reset endpoint-spec
Reset one or more SCSI target endpoints.

Note

Resetting endpoint connections during a backup may disrupt the backup operation.
scsitarget endpoint del endpoint-spec
Delete one or more endpoints. This may be used to delete an endpoint if the underlying
hardware is no longer available. Note that if the underlying hardware is still present, or
becomes available, a new endpoint for the hardware is discovered automatically and
configured based on default values.
scsitarget endpoint disable endpoint-spec
Disable one or more SCSI target endpoints.
scsitarget endpoint enable endpoint-spec
Enable one or more SCSI target endpoints.
scsitarget endpoint modify endpoint-spec [fcp2-retry {disable |
enable | default}] [topology {loop-preferred | loop-only |
point-to-point | default}] [wwpn {auto | wwpn}] [wwnn {auto |
wwnn}]
Modify one or more endpoints.
scsitarget endpoint rename src-endpoint-name dst-endpoint-name
Rename an endpoint.
scsitarget endpoint show detailed [endpoint-spec]
Show detailed information about one or more endpoints.
scsitarget endpoint show list [endpoint-spec]
Show summarized list of configured endpoints. If no argument is selected, output
displays basic information on all endpoint criteria.
scsitarget endpoint show stats [endpoint-spec] [interval
interval] [count count]
Periodically list I/O statistics on one or more endpoints. If no endpoints are specified,
output displays a single-line total for each interval.
Command Option Arguments
count
The number of objects on which to perform the action, as specified by the command
option.
endpoint-spec
Specifies the endpoint on which to perform the command.
fcp2-retry
Port option.

scsitarget enable 187

scsitarget

interval secs
Time interval in seconds.
topology
Set the Fibre Channel topology for the endpoint. Values include: loop-
preferred, loop-only, point-to-point, default.
wwpn
Set the world-wide port name (WWPN) for the endpoint, or use an automatic system-
generated WWPN.
wwnn
Set the WWNN for the endpoint, or use an automatic system-generated WWNN.

scsitarget group
scsitarget group add group-name device device-spec [lun lun]
[primary-endpoint {all | none | endpoint-list}] [secondary-
endpoint {all | none | endpoint-list}]
Add devices to a group.
scsitarget group add group-name initiator initiator-spec
Add one or more initiators to a group.
scsitarget group attach group-name device device-name lun lun
primary-endpoint {all | none | endpoint-list} secondary-
endpoint {all | none | endpoint-list}
Attach an additional LUN to a device in a group. This may be used to expose a device with
different LUNs through different endpoints.
scsitarget group create group-name service service-name
Create a new group associated with a specific service.
scsitarget group del group-name initiator initiator-spec
Delete one or more initiators from a group.
scsitarget group del group-name device device-spec
Delete one or more devices from a group.
scsitarget group destroy group-name
Destroy a group.
scsitarget group detach group-name device device-name lun lun
Detach a device from a LUN in a group. There must be at least one LUN for a device in a
group.
scsitarget group modify group-name device device-spec [lun lun]
[primary-endpoint {all | none | endpoint-list}] [secondary-
endpoint {all | none | endpoint-list}]
Modify device attributes in a group. If a device is attached to multiple LUNs, the lun
argument, if specified, indicates which LUN to update.
scsitarget group rename src-group-namedst-group-name
Rename a group.
scsitarget group show detailed [group-spec] [device device-
spec] [initiator initiator-spec] [service service-name]
Show detailed information on specific groups, based on selected arguments.
scsitarget group show list [group-spec] [device device-spec]
[initiator initiator-name] [service service-name]

188 EMC Data Domain Operating System 5.4 Command Reference Guide
 scsitarget

Display a list of groups based on selected arguments. If no arguments are selected,

output displays basic information on all group criteria.
scsitarget group use group-name device device-spec {primary |
secondary}
Switch the in-use endpoint lists for one or more devices in a group between primary and
secondary endpoint lists.
scsitarget group use group-name device device-spec {primary |
secondary}
Switch the in-use endpoint lists for one or more devices in a group between primary and
secondary endpoint lists. For best results, do not run this command option during heavy
VTL usage.
Command Option Arguments
all
Show all information about the object specified by the command option.
group-name
Name of SCSI target access group.
initiator-name
Name of SCSI target host initiator.
lun
A device address to pass to the initiator. The maximum logical unit number (LUN) is
16383. A LUN must be unique within a group, but need not be unique across the
system. LUNs for VTL devices within a group must start with zero and be contiguous
numbers.
primary-endpoint
The primary endpoint on which the SCSI target devices are visible. By default, or if
you specify all, SCSI target devices are visible on all ports. Specify none if the
devices should not be visible on any ports.
secondary
The secondary endpoint on which the SCSI target devices are visible. By default, the
devices are visible on all ports. The secondary port list supports path redundancy.
service-name
A SCSI Target service such as VTL or DD Boost.

scsitarget initiator
scsitarget initiator add initiator-name system-address system-
address
Add an initiator with associated system address. An initiator may be added before it is
visible on a transport, which allows for early provisioning.
scsitarget initiator del initiator-spec
Delete an initiator. Note that if the initiator is remains visible it may be automatically
rediscovered.
scsitarget initiator modify initiator-spec [address-method
{auto | vsa | default}]
Modify one or more initiators. The argument vsa is an acronym for volume system
addressing.
scsitarget initiator rename src-initiator-name dst-initiator-
name
Rename an initiator.

scsitarget initiator 189

scsitarget

scsitarget initiator show detailed [initiator-spec] [endpoint

endpoint-spec] [group group-spec]
Show detailed information on one or more initiators, based on selected arguments.
scsitarget initiator show list [initiator-spec] [endpoint
endpoint-spec] [group group-spec]
Display a list of initiators based on selected arguments. If no arguments are selected,
output displays basic information on all initiator criteria.
Command Option Arguments
auto
The device address method chosen based on the numeric LUN range being reported:
0 - 255, peripheral device addressing is used, 256 - 16383, flat device addressing is
used (default).
endpoint-spec
Specifies the endpoint on which to perform the command.
initiator-name
Name of SCSI target host initiator.
vsa
Volume set addressing (VSA). This method is used primarily for addressing virtual
buses, targets, and LUNs. The HP-UX operating system selects the volume set
addressing method based on inquiry data and LUN information returned by the
SCSI-3 REPORT LUNS command.

scsitarget persistent-reservation
scsitarget persistent-reservation clear [device device-spec]
[initiator initiator-name]
Clear SCSI-3 persistent reservations.

Example 77

To clear all persistent reservations set by an initiator no longer visible to the system,
enter:

# scsitarget persistent-reservation clear initiator ibm-initiator-17

scsitarget persistent-reservation disable [service service-

name]
Disable SCSI persistent reservations.
scsitarget persistent-reservation enable [service service-name]
Enable SCSI persistent reservations.
scsitarget persistent-reservation show detailed [device device-
spec] [initiator initiator-name]
Show detailed information on SCSI persistent reservations.

Note

If a device does not include a reservation key, or is using a shared key, output displays a
series of zeros (0X0000000000000000) in the Reservation Key category instead of n/a.
This is expected behavior.

190 EMC Data Domain Operating System 5.4 Command Reference Guide
 scsitarget

scsitarget persistent-reservation show list [device device-

spec] [initiator initiator-name]
Show summary information on SCSI persistent reservations.
Command Option Arguments
initiator-name
Name of SCSI target host initiator.
service-name
A SCSI Target service such as VTL or DD Boost.

scsitarget reset
scsitarget reset detailed-stats
Reset detailed statistics for SCSI target subsystem.

scsitarget service
scsitarget service refresh [service]
Refresh SCSI target service configuration. The refresh command option causes all
services within the SCSI target system configuration to be re-created.
scsitarget service show list
Display a list of configured services and current state.

scsitarget show
scsitarget show config
Show SCSI target configuration.
scsitarget show detailed-stats
Show detailed statistics for SCSI target subsystem.

scsitarget status
scsitarget status
Show SCSI target status.
l The administrative state shows the overall state of the SCSI target subsystem.
l The process state shows if the SCSI target management process is currently running.
l The module state shows if required system modules have been loaded prior to
starting the management process.
If the status shows an administrative state of enabled but a process state of stopped,
the scsitarget enable command may be used to request a start of the SCSI target
subsystem.

scsitarget trace
scsitarget trace disable [component {all | user | kernel |
default | component-list}]
Disable SCSI target tracing.

scsitarget reset 191

scsitarget

scsitarget trace enable [component {all | user | kernel |

default | component-list}] [level {all | high | medium | low}]
[timeout {never | timeout-mins}] [service service-name]
Enable SCSI target tracing. If no components are specified the default components are
used. If no timeout is given a 10-minute timeout is used. Use the command option
scsitarget trace show to see which components are available for each type (all,
default, user, kernel).
scsitarget trace show [component {all | user | kernel | default
| component-list}]
Show SCSI target trace status.

scsitarget transport
scsitarget transport option reset {option-name | all}
Reset a SCSI target transport option.
scsitarget transport option set option-name value
Set a SCSI target transport option.
scsitarget transport option show {option-name | all}
Show a SCSI target transport option.

Example 78

# scsitarget transport option show loop-id transport fc

scsitarget transport show stats

Show SCSI target transport statistics.

192 EMC Data Domain Operating System 5.4 Command Reference Guide
 scsitarget

Command Option Arguments

component-list
List of tracing components. One or more may be specified.
vhba
scst
fc
ddcl
vtc
vmc
vtlprocess
group
vscsi
vtlsm
vtc_readahead
info_cache
persistent_reservations
master_client
master_server
worker_client
worker_server
vdev_thread
registry
misc

Note

Components master_client, master_server, worker_client, and

worker_server are used only for GDA, which is no longer supported as of 5.4.

level
Degree of debugging verbosity to enable (all | high | medium | low | none).
timeout
Optional argument for scsitrace command. Set how long debugging is enabled
for the specified components.

scsitarget transport 193

scsitarget

194 EMC Data Domain Operating System 5.4 Command Reference Guide
CHAPTER 28
snapshot

The snapshot command manages MTrees snapshots. MTrees add granularity to

filesystem-type operations, allowing operations to be performed on a specific MTree
instead of the entire filesystem. Snapshots are useful for avoiding version skew when
backing up volatile data sets, such as tables in a busy database, and for restoring
previous versions of a deleted directory or file.
A snapshot is a read-only copy of the Data Domain MTree from the top of each MTree: /
data/col1/mtree-name.The MTree /data/col1/backup is the default directory
created in the system during installation. It is also the MTree that is refreshed during an
upgrade procedure. The directory /backup points to the default MTree. Snapshots can
be accessed from the directories /backup/.snapshot or /data/col1/mtree-
name/.snapshot.
This chapter contains the following topics:

l snapshot Change History.................................................................................... 196

l snapshot Guidelines and Restrictions................................................................. 196
l snapshot create.................................................................................................. 196
l snapshot expire.................................................................................................. 197
l snapshot list....................................................................................................... 197
l snapshot rename................................................................................................ 198
l snapshot schedule..............................................................................................198
l snapshot Additional Topics................................................................................. 199

snapshot 195
snapshot

snapshot Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 29 snapshot Change History

Version Change
5.4 No changes from previous version.

snapshot Guidelines and Restrictions

l Unless otherwise noted, command options are available only to users with admin
role permissions.
l If the Data Domain system is a source for collection replication, snapshots are
replicated.
l If the Data Domain system is a source for directory replication, snapshots are not
replicated. Snapshots must be created separately on a directory replication
destination.
l Snapshots are replicated for MTrees.
l The .snapshot directory is a virtual directory. It can be referenced in any directory, but
it does not show up as a directory listing except at export points (for example, a CIFS
share or NFS mount point).
l The maximum number of snapshots allowed to be stored on a system is 750. If the
maximum number is reached, the system generates an alert. You can resolve this by
expiring snapshots and then running the command option filesys clean.
l When creating a snapshot schedule, the retention period must be set in days only. If
set in hours an error message appears stating your data is in danger and the
command will fail.

snapshot create
snapshot create snapshot mtree mtree-path [retention {date |
period}]
Create a snapshot. Naming conventions for creating MTrees include uppercase and
lowercase letters A-Z, a-z), numbers 0-9, single, non-leading embedded space,
exclamation point (!), hash (#), dollar sign ($), ampersand (&), caret (^), tilde (~), left and
right parentheses ( ( or ) ), left and right brackets ( [ or ] ), left and right curly braces
( { or } ).
Argument Definitions
snapshot
A name for the snapshot.
mtree mtree-path
The pathname of the MTree for which the snapshot is being created. The base of the
path must be /data/col1/mtree_name or /backup.

196 EMC Data Domain Operating System 5.4 Command Reference Guide
 snapshot

retention date
A four-digit year, two-digit month, and two-digit day separated by dots, slashes, or
hyphens. For example, 2013.03.23. The snapshot is retained until midnight (00:00,
the first minute of the day) of the designated date.
retention period
Number of days, weeks (wks), or months (mos) to retain a snapshot. Note there is no
space between the number and time period; for example, 4wks. Also, one month
equals 30 days. The snapshot is retained until the same time of day it was created.

Example 79

If a snapshot was created at 8:48 a.m. on March 1, 2013 with a retention period of one
month, it would be retained for 30 days.

# snapshot create test22 mtree /backup retention 1mos

snapshot expire
snapshot expire snapshot mtree mtree-path [retention {date |
period | forever}]
Set or reset the retention time of a snapshot. To expire a snapshot immediately, use the
snapshot expire operation with no options. An expired snapshot remains available
until the next filesystem clean operation.
Argument Definitions
snapshot
The name of the snapshot.
mtree mtree-path
The pathname of the MTree for which the snapshot is being created.
retention date
A four-digit year, two-digit month, and two-digit day separated by dots ( . ), slashes
( / ), or hyphens ( - ). With a retention date, the snapshot is retained until midnight
(00:00, the first minute of the day) of the designated date.
retention period
Number of days, weeks (wks), or months (mos) to retain snapshot. Note there is no
space between the number and time period; for example, 4wks. Also, one month
equals 30 days. The snapshot is retained until the same time of day it was created.
The retention period must be set in days only.
forever
The snapshot does not expire.

snapshot list
snapshot list mtree mtree-path
View a list of snapshots of a specific MTree. The display shows the snapshot name, the
amount of pre-compression data, the creation date, the retention date, and the status.
The status may be blank or expired.

Example 80

snapshot expire 197

snapshot

Example 80 (continued)

# snapshot list mtree /data/col1/ddmtree1

snapshot rename
snapshot rename snapshotnew-name mtree mtree-path
Rename a snapshot for a specific MTree.

Example 81

To change the name from snap1 to new-snap1 for an MTree named /newMTree, enter:

# snapshot rename snap1 new-snap1 mtree /backup

snapshot schedule
snapshot schedule add name mtrees mtree-list
Add multiple MTrees to a single snapshot schedule.
snapshot schedule create name [mtrees mtree-list] [days days]
time time [,time ...] [retention period] [snap-name-pattern
pattern]
snapshot schedule create name [mtrees mtree-list] [days days]
time time every mins [retention period] [snap-name-pattern
pattern]
snapshot schedule create name [mtrees mtree-list] [days days]
time time-time [every <hrs | mins>] [retention period] [snap-
name-pattern pattern]
Use these commands to create a snapshot schedule for multiple MTrees. Command
arguments determine the duration of the schedule. (Note the different arguments for
specifying time interval.)

CAUTION

The retention period must be set in days only. If set in hours an error message appears
stating your data is in danger and the command will fail.

Example 82

In the following example, snapshots are spaced one minute apart.

# snapshot schedule create sm1 mtrees /data/col1/m1 time

00:00-23:00 every 1mins retention 1days

snapshot schedule del name mtrees mtree-list

Remove a list of MTrees from a schedule.
snapshot schedule destroy [name | all]
Remove the name of a schedule.

198 EMC Data Domain Operating System 5.4 Command Reference Guide
 snapshot

snapshot schedule modify name [mtrees mtree-list] [days days]

time time [,time ...] [retention period] [snap-name-pattern
pattern]
snapshot schedule modify name [mtrees mtree-list] [days days]
time time every mins [retention period] [snap-name-pattern
pattern]
snapshot schedule modify name [mtrees mtree-list] [days days]
time time-time every <hrs | mins>] [retention period] [snap-
name-pattern pattern]
Use these commands to modify a snapshot schedule. Command arguments determine
the duration of the schedule. (Note the different arguments for specifying time interval.)
snapshot schedule reset
Reset a snapshot schedule and delete all snapshot schedules.

CAUTION

This command deletes the previous schedule without prompting the user.
snapshot schedule show [ {name | mtrees mtree-list} ]
Show a specific schedule and show schedules associated with a specific MTree. To show
a list of schedules, enter the command with no options.

snapshot Additional Topics

This section provides additional information on various topics and concepts.

Naming Snapshots Created by a Schedule

The naming convention for scheduled snapshots is the word scheduled followed by a
four-digit year, a two-digit month, a two-digit day, a two-digit hour, and a two-digit
minute. All elements of the name are separated by hyphens. For example,
scheduled-2013-04-28-13-41.
The name every_day_8_7 is the name of a snapshot schedule. Snapshots generated
by that schedule might have the names scheduled-2013-03-25-20-00,
scheduled-2013-03-26-20-00, and so forth.

Example 83

To schedule a snapshot every Monday and Thursday at 2:00 a.m. with a retention of two
months, enter:

# snapshot create schedule mon thu 02:00 retention 2mos

snapshot Additional Topics 199

snapshot

200 EMC Data Domain Operating System 5.4 Command Reference Guide
CHAPTER 29
snmp

The snmp command enables or disables SNMP access to a Data Domain system, adds
community strings, gives contact and location information, and displays configuration
settings.
SNMP management requires two primary elements: an SNMP manager and an SNMP
agent. An SNMP manager is software running on a workstation from which an
administrator monitors and controls the different hardware and software systems on a
network. These devices include, but are not limited to, storage systems, routers, and
switches.
An SNMP agent is software running on equipment that implements the SNMP protocol.
SNMP defines how an SNMP manager communicates with an SNMP agent. For example,
SNMP defines the format of requests that an SNMP manager sends to an agent and the
format of replies the agent returns.
From an SNMP perspective a Data Domain system is a read-only device, with one
exception: A remote machine can set the SNMP location, contact, and system name on a
Data Domain system. The snmp command enables administrative users to configure
community strings, hosts, and other SNMP MIB variables on the Data Domain system.
With one or more trap hosts defined, a Data Domain system takes the additional action of
sending alert messages as SNMP traps, even when the SNMP agent is disabled.
This chapter contains the following topics:

l snmp Change History.......................................................................................... 202

l snmp Guidelines and Restrictions....................................................................... 202
l snmp add............................................................................................................202
l snmp del.............................................................................................................203
l snmp disable...................................................................................................... 204
l snmp enable....................................................................................................... 204
l snmp reset.......................................................................................................... 204
l snmp set............................................................................................................. 204
l snmp show......................................................................................................... 204
l snmp status........................................................................................................ 205
l snmp user........................................................................................................... 205

snmp 201
snmp

snmp Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 30 snmp Change History

Version Change
5.4 Modified command options:

snmp show config [version {v2c | v3}] on page 204

snmp show trap-hosts [version {v2c | v3}] on page 204

snmp Guidelines and Restrictions

l Unless otherwise noted, command options are available only to users with admin
role permissions.
l Data Domain systems support SNMPv1, v2C, and v3.
l Default port 161 is used for inbound/outbound, read/write SNMP access. Default
port 162 is used for outbound traffic for SNMP traps.
l Spaces, tabs, colons, semicolons, U.S. dollar signs, and quotation marks cannot be
used in community strings.
l To change multiple settings quickly and avoid restarting SNMP, run the snmp
disable command, change the settings, and then run snmp enable.

snmp add
snmp add ro-community community-string-list [hosts host-list]
Add one or more community strings for read-only access to the Data Domain system. A
common string for read-only access is public. To grant access to specific hosts, enter the
names in host-list. A valid host list can include the host name or IP address, such as:
hostnameA,hostNameB 10.10.1.2,10.10.1.310.**

Example 84

To add a community string of public with read-only permissions:

# snmp add ro-community public hosts host.datadomain.com

snmp add rw-community community-string-list [hosts host-list]

Add one or more community strings for read/write access to the Data Domain system. A
common string for read/write access is private. To grant access to specific hosts, enter
the names in host-list. A valid host-list can include the host name or the host IP address,
such as:
hostnameA,hostNameB10.10.1.2,10.10.1.310.**

202 EMC Data Domain Operating System 5.4 Command Reference Guide
 snmp

Example 85

To add a community string of private with read/write permissions:

# snmp add rw-community private hosts host.datadomain.com

snmp add trap-host host-name-list[:port] [version {v2c | v3}]

[{community community | user user}]
Add one or more trap hosts (host name or IP address) to receive the SNMP traps
generated by the Data Domain system. Note that alerts are also sent as traps, even when
the local SNMP agent is disabled. By default, port 162 is used to send traps, but another
port may be assigned.
SNMP trap-host supports SNMPv2c and v3. For SNMPv1 and v2c specify the version and
the pre-existing community. For SNMPv3 specify the SNMPv3 user name. Make sure to
include trap-host in the community string hosts.

Example 86

To add a trap host admin12:

# snmp add trap-host admin12 version v2c community public

snmp del
snmp del ro-community community-string-list [hosts host-list]
Delete one or more community strings for read-only access to the Data Domain system.
snmp del rw-community community-string-list [hosts host-list]
Delete one or more community strings for read-write access to the Data Domain system.

Example 87

To delete the community string private with read/write permissions:

# snmp del rw-community private hosts myhost.datadomain.com

To delete the community private and all hosts associated with private:

# snmp del rw-community private

snmp del trap-host host-name-list

Delete one or more trap hosts from the list of hosts receiving SNMP traps generated by
the Data Domain system.

Example 88

To delete trap host admin12:

# snmp del trap-host admin12

snmp del 203

snmp

snmp disable
snmp disable
Disable SNMP and close port 161.

snmp enable
snmp enable
Enable SNMP and open port 161.

snmp reset
snmp reset
Reset SNMP agent configuration to default values.
snmp reset ro-communities
Reset list of read-only community strings to default values.
snmp reset rw-communities
Reset list of read-write community strings to default values.
snmp reset sysContact
Reset the SNMP administrative contact MIB variable to the default value or to an empty
string if the system value is empty.
snmp reset sysLocation
Reset the system location MIB variable to the default value or to an empty string if the
system value is empty or to an empty string if the system value is empty.
snmp reset trap-hosts
Reset list of SNMP trap receiver hosts to default values.

snmp set
snmp set sysContact sysContact
Set the SNMP administrative contact MIB variable. The SNMP sysContact MIB variable
differs from the value set with the config set admin-email command option.
However, if the SNMP MIB variables are not set with the SNMP commands, the variables
default to the system values given with the config set commands.
snmp set sysLocation sysLocation
Set the SNMP physical location MIB variable. The SNMP sysLocation MIB variables differs
from the value set with the config set location command option. However, if the
SNMP MIB variables are not set with the SNMP commands, the variables default to the
system values given with the config set commands.

snmp show
snmp show config [version {v2c | v3}]
Use this command to display all SNMP parameters. If SNMP version is not entered,
output displays information for both versions.
snmp show ro-communities
Show the SNMP read-only community strings.

204 EMC Data Domain Operating System 5.4 Command Reference Guide
 snmp

snmp show rw-communities

Show the SNMP read/write community strings.
snmp show sysContact
Show the SNMP administrative contact MIB variable.
snmp show sysLocation
Show the SNMP physical location MIB variable.
snmp show trap-hosts [version {v2c | v3}]
Display the trap host list on a Data Domain system. If SNMP version is not entered,
output displays information for both versions.

snmp status
snmp status
Show SNMP status.

snmp user
snmp user add user-name access {read-only | read-write}
[authentication-protocol {MD5 | SHA1} authentication-key auth-
key [privacy-protocol {AES | DES} privacy-key priv-key]]
Add an SNMPv3 user to the system specifying the access rights, authentication protocol,
and privacy protocol. The authentication key is used when calculating the digest for the
authentication protocol. The privacy key is used as input for the privacy protocol.
snmp user del user-name
Delete an SNMPv3 user.
snmp user modify user-name access {read-only | read-write}
[authentication-protocol {MD5 | SHA1} authentication-key auth-
key [privacy-protocol {AES | DES} privacy-key priv-key]]
Modify an SNMPv3 user settings such as access rights, authentication protocol, and
privacy key.
snmp user reset
Reset list of SNMPv3 users to default values.
snmp user show user-name
Display a SNMPv3 user.

snmp status 205

snmp

206 EMC Data Domain Operating System 5.4 Command Reference Guide
CHAPTER 30
storage

The storage command adds, removes, and displays disks and LUNs belonging to active
and archive storage tiers. Tiered storage enables the Data Domain system to use different
types of storage devices.
A storage tier can contain two types of storage: whole disks in an enclosure, such as a
Data Domain system or attached expansion shelf, or LUNs in a Data Domain gateway
system that uses a SAN.
System storage for a filesystem or associated RAID disk group consists of two storage
tiers: one active and one archive. The active tier has one active unit of storage, and the
archive tier has one or more retention units of storage.
This chapter contains the following topics:

l storage Change History....................................................................................... 208

l storage Guidelines and Restrictions.................................................................... 208
l storage add.........................................................................................................208
l storage remove................................................................................................... 208
l storage show.......................................................................................................209

storage 207
storage

storage Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 31 storage Change History

Version Change
5.4 No changes from previous version.

storage Guidelines and Restrictions

l Unless otherwise noted, command options are available only to users with admin
role permissions.
l After adding disks or LUNs to storage tiers, the storage must be provisioned by
creating or expanding the filesystem.
l Available LUNs may be removed from a tier to use as a RAID hot spare.

storage add
storage add [tier {active | archive}] {enclosure enclosure-id |
devdisk-id [spindle-group 1-16] | disk enclosure-id.disk-id }
Add storage devices to a tier. Device types include all disks in an enclosure, a single disk,
or a LUN in a gateway system. Disks or LUNs must be in the Unknown state to be added
to the designated tier, after which the state changes to Available. This command cannot
be used on dataless head (DLH) units. Default spindle group is 1.
Additionally:
l If adding a disk to an enclosure on the active tier and if there is already a disk group
in the enclosure, the disk becomes a spare, not available. This is because if you add
a disk and it becomes available, there is no way for the available disk to become
spare. Spares are only created when a disk group is created within the enclosure.
This rule also applies to the head unit.
l If there is not a disk group in the enclosure (other disks are available or spare), the
disk becomes available.

Note

The storage add devdisk-id command option is allowed only after running the
command option storage add enclosure enclosure-id to add the shelf.

storage remove
storage remove {enclosure enclosure-id | devdisk-id | disk
enclosure_id.disk-id}
Remove storage devices from the tier, including all disks in an enclosure, a single disk, or
a LUN in a gateway system. You can also remove a disk from a DLH unit. When a device is
removed the state changes to Unknown.

208 EMC Data Domain Operating System 5.4 Command Reference Guide
 storage

This command cannot remove an In Use disk if doing so exceeds the minimum number
allowed by the RAID scheme. This command also cannot remove a disk if the disk is a
spare or an In Use LUN.

storage show
storage show {all | summary | tier {active | archive}}
Display information about filesystem storage. All users may run this command option.
Output includes the number of disk groups working normally and the number of
degraded disk groups. Details on disk groups undergoing, or queued for, reconstruction,
are also shown when applicable. The abbreviation N/A in the column Shelf Capacity
License Needed indicates the enclosure does not require a capacity license, or that part
of the enclosure is within a tier and the capacity license for the entire enclosure has been
accounted for.
Output Definitions
absent
No disk is in the disk slot.
unknown
A blank disk inserted into the disk slot, or a disk failed by a RAID system.
available
Any of the following:
l A previously unknown disk or LUN added to a tier by the storage add
enclosure command option.
l DD Extended Retention system only: a previously In Use disk or LUN deleted
from a retention unit by the filesys archive unit del command option.
This operation reverts the disk or LUN to available storage in the archive tier.
l A previously failed disk in an expansion shelf populated with other disks
belonging to a tier that is not primarily composed of disk group disks, and whose
partition was destroyed by the disk unfail command.

In Use
Storage that is part of an active filesystem or associated RAID disk group.
Spare
A disk that can be used as a RAID hot spare through RAID reconstruction. Spare
disks can be used to create or expand the filesystem.
Spare (reconstruction)
A spare disk that is pending or undergoing RAID reconstruction, which puts
filesystem data into what the formerly spare disk and then makes the disk an
integral part of a disk group. After RAID reconstruction of a spare disk completes, the
disk is part of a RAID disk group.
Failed
Tiered storage (Available, Spare, or In Use) removed from the tier
automatically by the disk subsystem, or explicitly by an administrative user. Failed
may also indicate unknown or foreign storage explicitly changed to the Failed
state.
Foreign
A disk belonging to a third-party vendor.

storage show 209

storage

210 EMC Data Domain Operating System 5.4 Command Reference Guide
CHAPTER 31
support

The support command manages bundles (EMC Data Domain log files), traces
(performance log files, also known as perf.logs), and file lists (file names under /
ddvar) from a customer Data Domain system. The information is transported to EMC via
HTTP or HTTPS.
This chapter contains the following topics:

l support Change History....................................................................................... 212

l support Guidelines and Restrictions....................................................................212
l support bundle................................................................................................... 212
l support notification.............................................................................................212

support 211
support

support Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 32 support Change History

Version Change
5.4 No changes from previous version.

support Guidelines and Restrictions

Unless otherwise noted, command options are available only to users with admin role
permissions.

support bundle
support bundle create {files-only file-list | traces-only}
[and-upload [transport {http|https}]]
Compress listed files into bundle and upload if specified. File names in a list must be
separated by one space.
support bundle create default [with-files file-list] [and-
upload [transport {http|https}]]
Compress default and listed files into bundle and upload if specified. File names in a list
must be separated by one space.
support bundle list
List all support bundles on system.
support bundle upload bundle-name [transport {http | https}]
Upload specified bundle to support server.

support notification
support notification disable { autosupport | alerts | all }
Disable autosupport (and am-email) or alerts or all notifications.
support notification enable { autosupport | alerts | all }
Enable autosupport (and am-email) or alerts or all notifications.
support notification show { autosupport | alerts | all }
Show notification setting of autosupport (and am-email) or alerts or all.

212 EMC Data Domain Operating System 5.4 Command Reference Guide
CHAPTER 32
system

The system command enables administrative users to perform standard tasks on Data
Domain systems, configure a system for Retention Lock Compliance, and view system-
level information.
This chapter contains the following topics:

l system Change History........................................................................................ 214

l system Guidelines and Restrictions.....................................................................214
l system headswap............................................................................................... 214
l system option..................................................................................................... 214
l system passphrase............................................................................................. 215
l system poweroff..................................................................................................215
l system reboot..................................................................................................... 215
l system retention-lock..........................................................................................215
l system sanitize................................................................................................... 216
l system set...........................................................................................................216
l system show....................................................................................................... 216
l system status......................................................................................................223
l system upgrade.................................................................................................. 223
l Additional Topics for system............................................................................... 224

system 213
system

system Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 33 system Change History

Version Change
5.4 New command option:

system upgrade precheck <file>

Modified command options:

system show all

system show serialno [detailed]

5.4.1 Modified output:

system retention-lock compliance status on page 216

5.4.4 Modified output:

system show all. For newer systems, this command now displays the product serial
number as the serial number instead of the chassis serial number. The chassis serial
number is also displayed.

system show serialno [detailed]. For newer systems, this command now displays the
product serial number as the serial number instead of the chassis serial number. The
detailed argument displays both the system serial number and the chassis serial
number.

system Guidelines and Restrictions

l Unless otherwise noted, command options are available only to users with admin
role permissions.
l The battery entry for NVRAM cards should show as 100 percent charged, enabled.
Exceptions are if the system is new or the card is a replacement. In both cases the
charge may be less than100 percent initially; however, if it does not reach 100
percent within three days, or if a battery is not enabled, the card must be replaced.

system headswap
system headswap
Restore the configuration to a system after replacing the head unit. For additional
instructions, see the Chassis Replacement FRU document for the system model.

system option
system option reset {login-banner}
Reset the login banner to the default of no banner.

214 EMC Data Domain Operating System 5.4 Command Reference Guide
 system

system option set console { serial | lan | monitor }

Set the active console option. This command is required for IPMI usage.
system option set login-banner file
Set the login banner file.

Example 89

Mount the Data Domain system directory /ddvar from another system.

Create a text file with your login message as the text on the other system.

From the Data Domain system, enter system option set login-banner with the
path and file name of the text file you created. For example, to use text from a file named
banner, enter:

# system option set login-banner /ddvar/banner

system option show

View system options.

system passphrase
system passphrase change
Change the passphrase used to access the system. This command option requires
security officer authorization.
system passphrase set
For fresh installations, set the passphrase used to access the system. Passphrase length
cannot exceed 255 characters.

system poweroff
system poweroff
Shut down the Data Domain system. The command performs an orderly shutdown of
filesystem processes. This command does not power off external storage.

system reboot
system reboot
Shut down and reboot a Data Domain system. The command automatically performs an
orderly shutdown of filesystem processes.

system retention-lock
system retention-lock compliance configure
Configure Retention Lock Compliance on the Data Domain system. This command option
requires security officer authorization.
system retention-lock compliance enable
Enable Retention Lock Compliance on the Data Domain system. This command option
requires security officer authorization. See the command option system retention-

system passphrase 215

system

lock compliance configure for instructions on configuring and enabling

Retention Lock.
system retention-lock compliance status
Display status of the Retention Lock Compliance policy on the system, including system
clock skew. This command option requires security officer authorization.

system sanitize
system sanitize abort
Stop the system sanitization process.
system sanitize start
Start the system sanitization process. Note that prior to running sanitization, snapshots
created during a previous replication process by another user may continue to hold
deleted data. To ensure data is removed from replication snapshots during system
sanitization, synchronize all replication contexts prior to beginning the procedure.
system sanitize status
Check system sanitization process status.
system sanitize watch
Monitor the progress of system sanitization.

system set
system set date MMDDhhmm[[CC]YY]
Set the system date and time. Do not use this command if Network Time Protocol (NTP) is
enabled. This command option requires security officer authorization if the system is
enabled for Retention Lock Compliance.
The format for the data and time is:
Two digits for the month, MM (01 through 12).
Two digits for the day of the month, DD (01 through 31).
Two digits for the hour, hh (00 through 23).
Two digits for minutes, mm (00 through 59).
Optional: Two digits for the century CC and two digits for the year YY.
The hour hh and minute mm variables are entered in 24-hour format with no colon
between the hours and minutes. 2400 is an invalid entry. The entry 0000 equals
midnight.

Example 90

Use one of the following commands to set the date and time to April 23, 2013, at 9:24
a.m., enter one of the following commands (two- or four-digit year):

# system set date 0423152413

# system set date 042315242013

system show
system show all

216 EMC Data Domain Operating System 5.4 Command Reference Guide
 system

Show all system information. Note that newer systems, such as DD4500 and DD7200,
display the product serial number in the Serial number row and the chassis serial number
in the Chassis serial number row. On legacy systems, such as DD990 and earlier, the
Serial number row displays the chassis serial number and the Service tag row displays
the product serial number. The product serial number remains the same during many
maintenance events, including chassis upgrades. Role required: admin, security, user,
backup-operator, or none.
system show date
Display the system clock.
system show detailed-version
Show the version number and release information.
system show eula
View the End User License Agreement (EULA). Note if the user is not present during
system installation, the Data Domain Technical Consultant can temporarily bypass
license acceptance and continue with the installation by pressing Ctrl-C. Otherwise, the
user must press Enter to accept the license, which is displayed the first time he or she
logs in to the system. See the DVD Installation Guide for details.
system show hardware
Display information about slots and vendors and other hardware in a Data Domain
system.
system show managing-system
Identify on which Data Domain Management Console the Data Domain system was
added. Also display details about the Data Domain Management Console, such as the
outbound proxy host and port, the date for which the system became managed, and the
date of last contact.
system show meminfo
Display summary of system memory usage. Output differs between newer systems, such
as DD4500 and DD7200, and legacy systems, such as DD990 and earlier.
system show modelno
Display the hardware model number of a Data Domain system.
system show nvram
Display information about NVRAM cards. If output indicates one or more component
error, an alerts notification is sent to the designated group and the Daily Alert Summary
email includes an entry citing details of problem.
system show oemid [name | value]
Show details of system OEM. On systems with head units and shelves, the OEM identifier
of the head unit is displayed first. Output includes IDs for connected enclosures only.
system show performance [local] [raw | fsop] [duration {hr |
min} [interval {hr | min}]]
Display summary of system performance for a designated interval.
Argument Definitions
local
Display local statistics.
raw
Show unformatted statistics.
fsop
Display the number of each filesystem operation performed per minute.

system show 217

system

duration
The hours or minutes prior to the current time for which to show data.
interval
The time between each line in the display. To specify the interval, you must also
specify the duration.

Example 91

To show performance figures of the prior 30-minute duration only, enter:

# system show performance 30 min

Example 92

To show performance figures of the prior 30-minute duration with an interval of 5 minutes
between each set of figures, enter:

# system show performance 30 min 5 min

Output Definitions: Throughput (MB/s)

Date
The date system performance is being viewed.
Time
The time system performance is being viewed.
Read
The read throughput data from the Data Domain system.
Write
The write throughput data to the Data Domain system.

Note

Throughput Read and Write data includes NFS, CIFS, DD Boost over IP and Fibre Channel,
VTL, Replication, DD Boost-managed replication and optimized duplication.

Output Definitions: Protocol

Repl Network (in/out)
Network replication throughput into and out of the Data Domain system.
Repl Pre-comp (in/out)
Replication pre-compressed (logical) throughput into and out of the Data Domain
system. The value is always zero for collection replication.

Note

Protocol data includes NFS, CIFS, DD Boost over IP, and DD Boost-managed replication
and optimized duplication. Data does not include Replication, VTL over Fibre Channel, or
DD Boost over Fibre Channel.

ops/s
Operations per second.
load
Load percentage (pending ops/total RPC ops *100).

218 EMC Data Domain Operating System 5.4 Command Reference Guide
 system

data (MB/s in/out)

Protocol throughput. Amount of data the filesystem can read from and write to the
kernel socket buffer.
wait (ms/MB in/out)
Time taken to send and receive 1MB of data from the filesystem to kernel socket
buffer.

Output Definitions: Compression

gcomp
Global compression rate.
lcomp
Local compression rate.
thra
Percent of compression units that have been read and discarded without being
used. A high percent indicates cache thrashing.
unus
Percent of compression unit data that is unused. Because a compression unit
contains multiple segments, not all segments in a compression region may be used.
A high percent indicates poor data locality.
ovhd
Percent of a compression unit cache block that is unused. Compression regions are
stored in fixed size (128 KB) blocks. A high ovhd relative to unus indicates space is
being wasted due to cache block fragmentation. In the ideal case, ovhd should
exactly equal unus.

Output Definitions: Cache Miss

data
Percent of data segment lookups that miss in the cache. A high percent indicates
poor data prefetching.
meta
Percent of metadata segment lookups that miss in the cache. For each data access,
first perform a metadata lookup followed by a data lookup. A high percent indicates
poor metadata prefetching.

Output Definitions: Streams

rd
The number of active read streams.
wr
The number of active write streams.
r+
The number of reopened read file streams in the past 30 seconds.
w+
The number of reopened write file streams in the past 30 seconds.

Output Definitions: MTree Active

rd
The number of active read streams.
wr
The number of active write streams.

system show 219

system

Output Definitions: State

C
Cleaning
D
Disk reconstruction
B
GDA (Also known as multinode cluster [MNC] balancing. This functionality is no
longer supported as of 5.4.)
V
File verification running
M
Fingerprint merge
S
Summary vector checkpoint
F
Archive data movement
I
Container verification (scrubbing)
R
Archive space reclamation

Output Definitions: Utilization

ops/s
Operations per second.
load %
Current load in protocol layer.
data (MB/s in/out)
Data transfer throughput to and from protocol layer.
wait (ms/MB in/out)
Time taken to transfer 1MB of data to and from protocol layer.

Output Definitions: Latency

avg/sdev
The average and standard deviation of the response time for ddfs to service all
protocol requests, excluding the time to receive or send the request or reply.
SS Load Balance (user/repl)
Indicates the relative load balance across segment storage (segstore) instances.
Information under (user/repl) denotes all user-plus-Replicator traffic.
stream
The number of open streams.
prefetch
The number/percentage of prefetch requests.
rd
The number of read requests.
wr
The number of write requests.

220 EMC Data Domain Operating System 5.4 Command Reference Guide
 system

tot
The total number of requests.
SS Load Balance (gc)
Denotes type and number of expunge (gc) processes.
prefetch
Prefetch processes.
rd
Read processes.
wr
Write processes.
tot
The total number of gc processes.

system show ports

Display information about ports. VTL-related ports do not display unless VTL is enabled.
Output Definitions
Port
The port number. See the modelspecific installation and setup guide to match a slot
to a port number.
Connection Type
The type of connection, such as Ethernet, SAS, VTL, etc.
Link Speed
The speed in Gbps (Gigabits per second).
Firmware
The Data Domain system HBA firmware version.
Hardware Address
A MAC address, a WWN, or a WWPN/WWNN. An address followed by an Ethernet port
number is a MAC address. WWN is the world-wide name of the Data Domain system
SAS HBA on a system with expansion shelves. WWPN/WWNN is the world-wide port
name or node name from the Data Domain system Fibre Channel HBA on gateway
systems.

system show serialno [detailed]

Display the system serial number. On newer systems, such as DD4500 and DD7200, the
system serial number is the product serial number, which remains the same during many
maintenance events, including chassis upgrades. On legacy systems, such as DD990 and
earlier, the system serial number is the chassis serial number. When the detailed
argument is specified, the output displays both the system serial number and the chassis
serial number, which will be different on newer systems and identical on legacy systems.
Role required: admin, security, user, backup-operator, or none.

Example 93

The following example is from a newer system that displays the product serial number as
the system serial number.

# system show serialno detailed

Serial number: APM00132009750
Chassis Serial number: FCNME130300006

system show 221

system

system show stats [view {nfs | cifs | repl | net | iostat |

sysstat},...] [custom-view view-spec,...] [{local | gda-display
{row | column}}] [interval nsecs] [count count]
Display system statistics to evaluate the performance level of the Data Domain system
since the last reboot. If the system is too busy to determine a value, the column shows a
dash instead of a number. If there is a performance issue, this command option can
determine if the problem is on the server, client, or network.

Note

Global Deduplication Arrays are deprecated as of this release. Users will receive a
message if the argument gda-display is entered.

Argument Definitions
local
Displays local values on the master system. Valid on the master node of a cluster
only.
gda-display
Displays values of cluster nodes on the master system in a row or column format.
Valid on the master node of a cluster only.
row
Output for each node is in row format, displayed as a single line for each interval.
column
Displays output of for each node in column format. Column headings indicate type of
stat value.
interval
When specifying intervals for collecting statistics, the first report is for current
activity. Subsequent reports show activity performed during [interval nsecs]. The
default interval is five seconds.
count
Specifies how many times to display the results. The default count is one. If interval
is specified and count is omitted, the count is set to infinite, or until the user presses
Ctrl-C.

Example 94

# system show stats view nfs interval 2

Output Definitions: CPU

CPU
aggr busy %
Average of busy percentage of all CPUs.
aggr max %
Amount of data sent through all interfaces.
State
Indicates system state. See the description of the show system performance
command for details on what each letter represents.

CIFS
ops/s
I/O and metadata operations per second.

222 EMC Data Domain Operating System 5.4 Command Reference Guide
 system

in MB/s
Write throughput.
out MB/s
Read throughput.

NFS
ops/s
I/O operations.
load %
Load percentage (pending ops/total RPC ops *100).x.)
data in % MB/s
Protocol throughput. Amount of data the filesystem can read from and write to the
kernel socket buffer.
data out % MB/s
Protocol throughput. Amount of data the filesystem can write to the kernel socket
buffer.
wait in ms/MB
Average amount of time spent in ms to receive the amount of data.
wait out ms/MB
Average amount of time spent in ms to send the amount of data.

Net
aggr in MB/s
Amount of data received through all interfaces.
aggr out MB/s
Amount of data sent through all interfaces.

system show uptime

Display the filesystem uptime, the time since the last reboot, the number of users, and
the average load.
system show version
Display the Data Domain OS version and build identification number.

system status
system status
Display status of fans, internal temperatures, and power supplies. Information is grouped
separately for the Data Domain system and each expansion shelf connected to the
system. See the EMC Data Domain Operating System Administration Guide for details.

system upgrade
system upgrade file
Upgrade the Data Domain system software from the file specified in the /ddr/var/
releases directory. The upgrade command shuts down the filesystem and reboots the
Data Domain system. The upgrade command may require over an hour, depending on
the amount of data on the system. See the EMC Data Domain Operating System Release
Notes for instructions on upgrading Data Domain systems.
system upgrade continue

system status 223

system

If upgrading a multi-node cluster, run this command option on the master controller to
complete the second phase of the upgrade procedure. (Multi-node clusters, or Global
Deduplication Arrays, are deprecated as of this release. See the EMC Data Domain
Operating System Release Notes for details.)
system upgrade history
Display history of system upgrades.
system upgrade precheck file
Check if current Data Domain operating system can be upgraded to the specified file in
the /ddr/var/release directory.
system upgrade status
Display current status and phase of the upgrade procedure. This command option shows
only the current status and then terminates. Users cannot monitor, or watch, upgrade
progress. When the upgrade is finished, a message displays the time of completion. If
upgrading from an earlier release (pre-5.2), this command becomes available after the
system reboots.

Additional Topics for system

This section provides additional information on various topics and concepts.

Configuring a System for Retention Lock Compliance

Procedure
1. Install the Retention Lock Compliance license.
2. Set up security office authorization.
3. Log in to the system as sysadmin.
4. Enable the system for Retention Lock Compliance. Enter:
# system retention-lock compliance enable
5. Configure Retention Lock Compliance. Enter:
# system retention-lock compliance configure

If the configuration is successful, the system reboots. File access is interrupted during
this time.
6. When the reboot has concluded, log in to the system as sysadmin.

224 EMC Data Domain Operating System 5.4 Command Reference Guide
CHAPTER 33
user

The user command adds and deletes users, manages password aging and strength
policies, and displays user roles. A role determines the type of operations a user can
perform on the Data Domain system. See the EMC Data Domain Operating System
Administration Guide for details.
The default administrative account is sysadmin. You can change the sysadmin password
but cannot delete the account.
This chapter contains the following topics:

l user Change History............................................................................................ 226

l user Guidelines and Restrictions......................................................................... 226
l user add..............................................................................................................226
l user change........................................................................................................ 226
l user del...............................................................................................................227
l user disable........................................................................................................ 227
l user enable......................................................................................................... 227
l user password.....................................................................................................227
l user reset............................................................................................................228
l user show........................................................................................................... 228

user 225
user

user Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 34 user Change History

Version Change
5.4 No changes from previous version.

user Guidelines and Restrictions

Unless otherwise noted, command options are available only to users with admin role
permissions.

user add
user add user [role {admin | security | user | backup-operator
| data-access}] [min-days-between-change days] [max-days-
between-change days] [warn-days-before-expire days] [disable-
days-after-expire days] [disable-date date]
Add a new user. The default role is user. A user name must start with a number or a
letter. Special characters cannot be used. The user names root and test are default
names on each Data Domain system and are not available for general use.
Users in the sysadmin role create the first security officer role by adding a user and
designating the role security. After a user is added as the initial security officer, only
security officers can add or delete other security officers.
Argument Definitions
role
The type of user permissions allowed.
min-days-between-change
Minimum number of days allowed before the password can be changed again.
max-days-between-change
Maximum number of days before password expires.
warn-days-before-expire
Number of days of warning before a password expires.
disable-days-after-expire
Account is disabled if inactive for the specified number of days past expiration.
disable-date
Account is disabled on this date. If not specified, account never expires.

user change
user change password [user]

226 EMC Data Domain Operating System 5.4 Command Reference Guide
 user

Change the password of a user. Users in the admin role user can change any user
password. Users in the user role can change only their own passwords. Passwords must
comply with the password strength policy, which you can check with the command
option user password strength show.
user change role user {admin | user | backup-operator | data-
access}
Change the role of a user.

user del
user del user
Remove a user. Note that sysadmin cannot be deleted.

user disable
user disable user
Disable the specified user account. This prevents the user from logging on to the Data
Domain system.

user enable
user enable user [disable-date date]
Enable a specified user account with an optional disable date. The account must already
exist on the system. If not specified, the disable date previously assigned to the account
is used.

user password
user password aging option reset {all | [min-days-between-
change] [max-days-between-change] [warn-days-before-expire]
[disable-days-after-expire]}
Reset one or more rules in the default password aging policy to the current default
values. New accounts inherit the policy in effect at the time they are created, unless you
set different aging options with the user add command.
user password aging option set {[min-days-between-change days]
[max-days-between-change days] [warn-days-before-expire days]
[disable-days-after-expire days]}
Set the default values for the password aging policy. This command option does not
require security officer authorization.
user password aging option show
Display the default password aging policy.
user password aging reset user {all | [min-days-between-change]
[max-days-between-change] [warn-days-before-expire] [disable-
days-after-expire]}
Reset one or more rules in the password aging policy for the specified user to the current
default values.
user password aging set user [min-days-between-change days]
[max-days-between-change days] [warn-days-before-expire days]
[disable-days-after-expire days]
Set the password aging policy for the specified user.

user del 227

user

user password aging show [user]

Show the password aging policy for all users, or for a specified user. Users can check the
password aging policy for their own account. Users in the admin role can check the
policies for all users.
user password strength reset {all | min-length | min-char-
classes}
Reset the password strength policy to the default values.
Argument Definitions
all
Reset both the minimum length and minimum number of character classes to 1.
min-length
Reset the minimum number of characters in the password to 1.
min-char-classes
Reset the minimum number of character classes to 1.

user password strength set {[min-length length] [min-char-

classes num_classes]}
Set the password strength policy. Specify either min-length or min-char-classes, or both.
Argument Definitions
min-length
The minimum number of characters in the password.
min-char-classes
The minimum number of character classes. Specify 1, 2, 3, or 4. Valid passwords
must contain at least one character from the specified number of classes. The four
character classes are lowercase letters, uppercase letters, digits, and special
characters.
When DD OS counts the number of character classes, an uppercase letter at the
beginning of the password does not count as an uppercase letter. Similarly, a digit at
the end of the password does not count as a digit.

user password strength show

Show the current password strength policy. All users may run this command option.

user reset
user reset
Reset the user account list, password-aging options, and password-strength parameters
to default values.

Note

This command option is not allowed on Retention Lock Compliance systems.

user show
user show active
Display list of users currently logged in.
user show detailed [user]
Show detailed information for a specified user or for all users.
user show list

228 EMC Data Domain Operating System 5.4 Command Reference Guide
 user

Display list of system users.

user show 229

user

230 EMC Data Domain Operating System 5.4 Command Reference Guide
CHAPTER 34
vtl

EMC Data Domain Virtual Tape Library (VTL) is a licensed software option that enables
backup applications to connect to and manage a Data Domain system running Extended
Retention as a virtual tape library.
VTL pools are MTree-based (as of DD OS 5.2). Multiple MTrees let you more closely
configure DD OS for data management. MTree-based pools allow MTree replication to be
used instead of directory replication. Existing pools are backward compatible. You may
create additional backward-compatible pools as needed. VTL pool-based replication is
performed using MTree replication for MTree pools, and directory replication for
backward-compatible pools.
MTree-specific attributes can be applied to each VTL pool individually instead of
inheriting a common set of attributes from the default /backup MTree. These attributes
include snapshots and snapshot schedules, compression information, and migration
policies for Extended Retention.
In previous versions, user access to VTL pool data in /backup (/data/col1/backup)
was performed mainly through an NFS or CIFS mount of /backup and was relatively
unconstrained. This led to issues where VTL data was changed beneath the VTL process;
for example, when deleting a pool or copying files manually, which caused unexpected
behavior and inconsistencies.
With MTrees, users may continue to use and manage VTL with little or no difference when
compared to versions 5.1 and earlier.
This chapter contains the following topics:

l vtl Change History............................................................................................... 233

l vtl Guidelines and Restrictions............................................................................ 233
l vtl add.................................................................................................................234
l vtl cap................................................................................................................. 234
l vtl debug.............................................................................................................234
l vtl del..................................................................................................................235
l vtl disable........................................................................................................... 236
l vtl drive...............................................................................................................236
l vtl enable............................................................................................................ 237
l vtl export.............................................................................................................237
l vtl group..............................................................................................................237
l vtl import............................................................................................................ 239
l vtl initiator.......................................................................................................... 240
l vtl option............................................................................................................ 241
l vtl pool................................................................................................................242
l vtl port................................................................................................................ 243
l vtl readahead......................................................................................................246
l vtl rename...........................................................................................................246
l vtl reset...............................................................................................................246
l vtl show.............................................................................................................. 246
l vtl slot.................................................................................................................247

vtl 231
vtl

l vtl status............................................................................................................. 248

l vtl tape................................................................................................................248

232 EMC Data Domain Operating System 5.4 Command Reference Guide
 vtl

vtl Change History

Click the command option for details on usage and functionality. See the EMC Data
Domain Operating System Release Notes of the corresponding version for details on
modifications, including arguments, output, and permissions.

Table 35 vtl Change History

Version Change
5.4 No changes from previous version.

vtl Guidelines and Restrictions

l Unless otherwise noted, command options are available only to users with admin
role permissions.
l Verify that at least one Fibre Channel (FC) interface card is installed on the Data
Domain system. The VTL feature communicates between a backup server and a Data
Domain system through a Fibre Channel interface.
l The filesystem and scsitarget features must be enabled to run VTL.
l Set the minimum record (block) size for backup software on the application host. For
best results, use 64 KiB or larger. Changing block size after the initial configuration
may render data written in the original size unreadable.
l The recommended number of concurrent virtual tape drive instances is platform-
dependent, as is the recommended number of streams between a Data Domain
system and a backup server. This number is system-wide and includes streams from
all sources, such as VTL, NFS, and CIFS. For details on the number of tape drives and
data streams, see the EMC Data Domain Operating System Administration Guide.
l Data Domain VTL does not protect virtual tapes from a Data Domain system filesys
destroy command. The filesys destroy command deletes all virtual tapes.
l The number of tapes that can be imported at one time is limited by:
n The number of empty slots. You cannot import more tapes than the number of
currently empty slots.
n The number of slots that are empty and not reserved for a tape currently in a drive.
n If a tape is in a drive and the tape origin is known to be a slot, the slot is reserved.
n If a tape is in a drive and the tape origin is unknown (slot or CAP), a slot is
reserved.
n A tape that is known to have come from a CAP and that is in a drive does not get a
reserved slot. (The tape returns to the CAP when removed from the drive.)
l The number of tapes that can be imported equals:
n The total empty slots.
n The number of tapes that came from slots.
n The number of tapes of unknown origin.

vtl Change History 233

vtl

vtl add
vtl add vtl [model model] [slots num-slots] [caps num-caps]
Add a tape library. Data Domain VTL supports a maximum of 64 library instances.
Command Option Arguments
model
A tape library model name. See the Data Domain technical note for the model name
that corresponds with your backup software.
num-caps
The number of cartridge-access ports. The default is zero (0), and the maximum is
100 per library or 1000 per system.
num slots
The number of slots in the library. You cannot add more drives than the number of
configured slots. The maximum number of slots for all VTLs on a Data Domain
system is 32,000. Default is 20 slots.
vtl
Name of library.

vtl cap
vtl cap add vtl [count num-caps]
Add cartridge access ports (CAPs) to a virtual tape library. The total number of CAPs
cannot exceed 100 per library or 1000 per system.
vtl cap del vtl [count num-to-del]
Delete num-to-del CAPs from a virtual tape library. The CAPs are deleted from the end. For
example, the command option vtl cap del vtl1 count 3 run on a VTL with 10 CAPs
deletes CAPs 8-10.
Command Option Arguments
count
The number of objects on which to perform the action, as specified by the command
option.
num-to-del
The number of objects to delete.
vtl
Name of library.

vtl debug
vtl debug disable [component {all | user | default | component-
list}]
Disable debug functionality of the specified components.
vtl debug enable [component {all | user | default | component-
list}] [level {high | medium | low}] [timeout {never | timeout
mins}]
Enable debug functionality for the specified components in persistent mode or a
specified timeout period at the specified debug level. The unit of timeout is
minutes.

234 EMC Data Domain Operating System 5.4 Command Reference Guide
 vtl

vtl debug show [component {all | user | default | component-

list}]
Show specified components, or all components, running debug functionality.
Command Option Arguments
component-list
List of vtl debugging components. One or more may be specified.
vhba
scst
fc
ddcl
vtc
vmc
vtlprocess
group
vscsi
vtlsm
vtc_readahead
info_cache
persistent_reservations
master_client
master_server
worker_client
worker_server
vdev_thread
registry
misc

Note

Components master_client, master_server, worker_client, and

worker_server are used only for GDA, which is no longer supported as of 5.4.

vtl del
vtl del vtl
Remove an existing virtual tape library. Any tapes loaded into the library when the library
is deleted are not destroyed. Instead, tapes are placed back into the virtual tape vault.
Command Option Arguments
vtl
Name of library.

vtl del 235

vtl

vtl disable
vtl disable
Close all libraries and shut down the VTL process.

vtl drive
vtl drive add vtl [count num-drives] [model model]
Add drives to a virtual tape library. Drives are added by starting with drive number 1 and
scanning for logical unit address gaps left by the vtl drive del command. When the
gaps are filled, the drives are appended to the end of the library. The number of slots
within a library cannot be fewer than the number of drives in the library. If an attempt is
made to add more drives than the current number of slots, the system automatically adds
the additional slots required.

Note

You cannot mix drive models within the same library.

vtl drive del vtl drive drive-number [count num-to-del]
Delete virtual drives from a VTL. Any drive can be deleted, which means there can be gaps
in the drive list. This may cause issues with some applications.
vtl drive show {serial-number serial-number | vtl vtl [drive
{drive-list}]}
View details of VTL drives.
Output Definitions
Location
Standard format location of library or drive.
Serial #
Drive serial number.
Vendor
Drive vendor identification.
Product
Drive product identification.
Product revision
Drive product revision.
Status
Drive status.
Barcode
Barcode of loaded tape.
Pool
Pool of loaded tape.
Previous Slot
Previous slot of loaded tape.
Device
SCSI device ID.
Persistent Reservation
Persistent reservation information.

236 EMC Data Domain Operating System 5.4 Command Reference Guide
 vtl

Access Groups
Fibre Channel access groups for device.

Command Option Arguments

count
The number of objects on which to perform the action, as specified by the command
option.
drive drive-number
Number of VTL drive.
drive-list
List of drives in group.
model
A tape library model name. See the Data Domain technical note for the model name
that corresponds with your backup software.
vtl
Name of library.

vtl enable
vtl enable
Enable VTL subsystem.

vtl export
vtl export vtl {slot | drive | cap} address [count count]
Remove tapes from a slot, drive, or cartridge-access port (CAP) and send them to the
vault.
Command Option Arguments
count
The number of objects on which to perform the action, as specified by the command
option.
vtl
Name of library.

vtl group
A VTL group name must be unique, and can only contain the characters 0-9, a-z, A-Z,
underscore, and hyphen. Group names cannot exceed 256 characters. A maximum of 128
groups is allowed. Reserved group names that cannot be used are TapeServer,
default, all, and summary.

Additional information about the vtl group feature includes:

l Clients can access only selected LUNs from a Data Domain system.
l VTL group changes may require the media server to rescan the SCSI bus, or you can
use the vtl reset hba command to reset the link.
l In the event of path failure, run the command vtl group use to switch between the
primary and secondary port lists. Enter the command vtl group use primary
to return the group to the primary port list after the path is repaired.

vtl enable 237

vtl

vtl group add group-name initiator initiator-alias-or -WWPN

Add an initiator alias or World Wide Port Name to the specified VTL access group.
vtl group add group-name vtl vtl-name {all | changer | drive
drive-list} [lun lun] [primary-port {all | none | port-list}]
[secondary-port {all | none | port-list}]
Add a changer or drives to the specified VTL access group. You can add a changer or
drive, optionally starting at a given LUN. You can optionally specify primary and
secondary Data Domain system VTL port lists. By default, the port lists contain all Data
Domain system VTL ports.
vtl group create group-name
Create a VTL access group with the specified group name. After the group is created, VTL
devices (changer or drive) and initiators may then be added to the group.
vtl group del group-name initiator initiator-alias-or-WWPN
Remove an initiator alias or World Wide Port Name from the specified VTL access group.
vtl group del group-name vtl vtl-name {all | changer | drive
drive-list}
Remove one or more devices from a group. This command immediately removes access
from the specified initiator to the VTL devices within the group.
vtl group destroy group-name
Remove the specified empty VTL access group. Before you can destroy a group, use the
vtl group del command to remove the initiators and devices from the group.
vtl group modify group-name vtl vtl-name {all | changer [lun
lun] | drive drive [lun lun]} [primary-port {all | none | port-
list}] secondary-port {all | none | port-list}]
Modify a group without removing and replacing devices or initiators in the group. You can
use this command to change LUN assignments and primary and secondary port
assignments. The main purpose of this command is to change group port assignments.
vtl group rename src-group-name dst-group-name
Rename a VTL access group. The dst-group-name must not already exist. Note that this
command does not interrupt active sessions.
vtl group show [ all | vtl vtl | group-name ]
Show information about VTL access groups. All users may run this command option.
vtl group use group-name [vtl vtl-name {all | changer | drive
drive-list}] {primary | secondary}
Switch ports in use for the specified changer in a group or library to the primary or
secondary port list for the specified changer or drives. This command option immediately
changes the access path to the primary or secondary port for the selected VTL
components in an access group. When the path is restored, you can use this command to
return the group to its primary port list.
After you apply a group to new VTL ports, a rescan of media servers SCSI bus may be
necessary. Also, a backup application may need to rescan available SCSI devices.
This command interrupts any current access to the specified group and is intended to be
used during path failures.
Command Option Arguments
drive drive-number
Number of VTL drive.
dst-group-name
Name of the destination group.

238 EMC Data Domain Operating System 5.4 Command Reference Guide
 vtl

group-name
VTL access group. TapeServer is a reserved group and cannot contain initiators.
initiator-alias
Alias for an initiator.
lun
A device address to pass to the initiator. The maximum logical unit number (LUN) is
16383. A LUN must be unique within a group, but need not be unique across the
system. LUNs for VTL devices within a group must start with zero (0) and be
contiguous numbers.
port-list
A comma-separated list of Data Domain system VTL ports. You can specify port
names as a range separated by a hyphen (-). The ports must already exist.

Note

For multiple ports, separate each name with a comma and enclose the list with
double quotes.

src-group-name
Name of source group.
vtl
Name of library.

vtl import
vtl import vtl barcode barcode [count count] [pool pool]
[element {drive | cap | slot}] [address addr]
Move tapes from the vault into a slot, drive, or cartridge access port. The following two
commands are equivalent:
# vtl import VTL1 barcode TST010L1 count 5
# vtl import VTL1 barcode TST010L1 count 5 element slot
address 1

Use the command vtl tape show vtl-name to display the total number of slots for a VTL
and to view which slots are currently used. Though the vtl import command option can
move tapes into tape drives, it is more common that backup software commands from
the backup server are used to move VTL tapes to and from drives. The default address is
1, default element is slot, and the default pool is Default.
Use the vtl tape show vtl command to display the total number of slots for a VTL and to
view which slots are currently used. Use commands from the backup server to move VTL
tapes to and from drives.
If no address is specified, the first free slot available is used. For example if slots 1
through 4 are occupied or reserved, the address used will be 5. If the address you specify
is already in use, the first free slot that is larger than the address specified is used.
Command Option Arguments
addr
Abbreviation for address. Default address is 1 for importing tapes.

vtl import 239

vtl

barcode
An eight-character virtual tape identifier. Barcodes must start with six numbers or
uppercase letters (0-9, A-Z), and end in a two-character tag of L1, L2, L3, LA, LB, or LC
for the supported LT0-1, LT0-2, and LT0-3 tape types.
Default sizes are used if you do not specify the capacity argument when creating the
tape cartridge. Defaults are:
l L1=100 GiB capacity tape, L2 = 200 GiB, and L3 = 400 GiB
l LA =50 GiB capacity tape, LB = 30 GiB, and LC =10 GiB

Specified values override the two-character tag.

When using count and barcode together, use a wild card character in the barcode
to make the count valid. An asterisk matches any character in that position and all
other positions. A question mark matches any character in that position.

Note

L1, LA, LB and LC tapes cannot be written on LTO-3 tape drives. L2 and L3 tapes
cannot be read on LTO-1 tape drives. Also, LTO-4 will not read L2 tapes (in addition
to the LA-L1 tapes).

count
The number of objects on which to perform the action, as specified by the command
option.
element
Destination element.
vtl
Name of library.

vtl initiator
vtl initiator reset address-method initiator initiator-alias-
or-WWPN
Reset the address method used when responding to a SCSI REPORT LUNS command to
the default (auto).
vtl initiator reset alias alias-name
Remove an initiator alias. Reset (delete) the initiator alias from the system. Deleting the
alias does not affect any VTL access from the specified initiator. To remove an initiator
from a group, use the vtl group del command instead.
vtl initiator set address-method {auto | vsa} initiator
initiator-alias-or-WWPN
Set the device address method used when responding to a SCSI REPORT LUNS command
from the specified initiator. With most platforms, you do not need to change the default
device address method. Use this command to work around any platform-specific
limitations you may encounter.
vtl initiator set alias alias-name wwpn wwpn
Add an initiator alias. This command sets an alias for an initiators WWPN. An initiator is
any Data Domain system client HBAs world-wide port names (WWPN). This command
does not interrupt traffic or VTL group access.

240 EMC Data Domain Operating System 5.4 Command Reference Guide
 vtl

Use the vtl initiator show command on the Data Domain system to list the client
WWPNs detected by the Data Domain system. You must match the WWPNs in the
command output to the clients HBA WWPN, including colon delimiters.
The alias must be unique, cannot exceed 256 characters, and can contain the characters
0-9, a-z, A-Z, underscore, and hyphen only. Maximum number of aliases is 128.

Example 95

The following example uses the client name and port number as the alias to avoid
confusion with multiple clients that may have multiple ports:

# vtl initiator set alias client22_2a

vtl initiator show [initiator initiator-alias-or-WWPN | port

port-list]
Display information about one or all Fibre Channel devices. Not all devices shown are
initiators. All users may run this command option.
Output returned from this command option includes:
l Initiator
l Group
l Status
l WWNN
l WWPN
l Port
l Symbolic Port Name
l Address Method
Command Option Arguments
alias or WWPN
Initiator alias or world-wide port name (WWPN).
initiator-alias
Alias for an initiator.
port-list
A comma-separated list of Data Domain system VTL ports. You can specify port
names as a range separated by a hyphen (-). The ports must already exist.

Note

For multiple ports, separate each name with a comma and enclose the list with
double quotes.

vtl option
vtl option disable option-name
Disable a VTL option.
vtl option enable option-name
Enable a VTL option.
vtl option reset option-name

vtl option 241

vtl

Reset a VTL option to its default value.

vtl option set option-namevalue
Set an option and value. Values for option name are:
loop-id
The Fibre Channel loop ID: 1 to 126.
auto-eject
If enabled, tapes placed into CAPs are automatically ejected to the vault.
auto-offline
If enabled, tapes being moved from a drive are automatically taken offline and
unloaded unless the prevent bit is set for the drive.

Example 96

# vtl option set loop-id 5

vtl option show {option-name | all}

Show settings for a specific option or all VTL options.
Command Option Arguments
option name
Name of specific option.

vtl pool
vtl pool add pool [backwards-compatibility-mode]
A pool created with backwards compatibility mode will exist in the default directory (/
backup). Replication of backwards-compatibility-mode pools is done using directory-
based replication, as in previous releases.
EMC does not recommend creating backwards-compatibility-mode pools unless users
have specific requirements; for example, replication with a pre-5.2 DD OS system.
vtl pool del pool
Delete a tape pool. You must first use the vtl tape del command to remove all tapes from
the pool, or use the vtl tape move command to move all tapes to another pool.
vtl pool rename src-pool dst-pool
Rename a pool. Note that a pool can be renamed only if none of its tapes are in libraries.
vtl pool show {all | pool}
List all tape pools or the contents of a specific pool. If the argument all is used, a
summary of all tape pools is provided, including the state of each pool, the number of
tapes, the total usage and compression for each pool, whether or not a pool is a
replication destination, the Retention Lock status of the pool, read/write properties, and
the number of tapes in the pool.
Output Definitions
RW
Pool has normal read/write properties.
RD
Pool is a replication destination.
RO
Pool is read-only.

242 EMC Data Domain Operating System 5.4 Command Reference Guide
 vtl

RLCE
Pool is Retention Lock Compliance Enabled.
RLGE
Pool is Retention Lock Governance Enabled.
RLGD
Pool is Retention Lock Governance Disabled.
BCM
Pool is in backward-compatibility mode.

vtl pool upgrade-to-mtree {pool-list | all} [check-only]

If a pool-list is specified, those pools are candidates for upgrade. If the argument all is
specified, backward-compatibility mode pools are upgraded. If no arguments are
provided, a precheck confirms if an upgrade is necessary or possible. If so, the upgrade is
performed, which converts the specified backward-compatibility mode pools to MTree-
based pools.

Note

An upgrade may only be run when VTL is disabled.

This command option does not convert the pool to MTree under the following conditions:
l The pool is a replication source or destination.
l The filesystem is full.
l The pool collides with an MTree with same name.
l The system has reached the maximum number of MTrees (100).

Example 97

# vtl pool upgrade-to-mtree all

If the check-only argument is used, the precheck is run, but no upgrade is performed.
This allows planning for changes prior to the upgrade.

Example 98

# vtl pool upgrade-to-mtree old-pool check-only

See the EMC Data Domain Operating System Administration Guide for instructions on
upgrading VTL directory-based pools to MTree-based pools.

Command Option Arguments

dst-pool
Name of new VTL pool.
src-pool
Name of the current VTL pool.

vtl port
vtl port disable {all | port-list}
Disable a single Fibre Channel port or all Fibre Channel ports in the list.

vtl port 243

vtl

vtl port enable {all | port-list}

Enable a single Fibre Channel port or all Fibre Channel ports in the list.
vtl port option reset [{fcp2-retry | topology} [port {port-list
| all}]]
Reset options on VTL Fibre Channel ports.
vtl port option set fcp2-retry {disable | enable} [port {port-
list | all}]
Set FCP2 retry on VTL Fibre Channel ports. Use this command only if FCP2 retry
connectivity problems occur.
vtl port option set topology {loop-preferred | loop-only |
point-to-point} [port {port-list | all}]
Set topology on VTL Fibre Channel ports.
vtl port option show [{fcp2-retry | topology} [port {port-list
| all}]]
Show options on VTL Fibre Channel ports.
vtl port show detailed-stats
Show detailed information about Fibre Channel ports. All users may run this command
option.
Output returned from this command option includes:
l Control commands
l Write commands
l Read commands
l In (number of MiB written--the binary equivalent of MB)
l Out (number of MiB read)
l Link failures
l LIP count
l Sync losses
l Signal losses
l Error count in primitive sequence protocol
l Number of invalid tx words
l Number of frames received with a bad CRC
vtl port show hardware
Show Fibre Channel ports hardware. All users may run this command option.
Output returned from this command option:
l Model
l Firmware
l WWNN
l WWPN
vtl port show stats [port {port-list | all}] [interval secs]
[count count]
Show VTL I/O stats on Fibre Channel ports. All users may run this command option.
Output returned from this command option includes:
l Port
l ops/s

244 EMC Data Domain Operating System 5.4 Command Reference Guide
 vtl

l Read KiB/s
l Write KiB/s
l Soft Errors
l Hard Errors
vtl port show summary
Show summary information about Fibre Channel ports. All users may run this command
option. Output returned from this command option includes:
l Port
l HBA slot
l HBA port
l Connection type
l Link speed
l Port ID
l Enabled
l Status
Command Option Arguments
count
The number of objects on which to perform the action, as specified by the command
option.
detailed-stats
Displays details of statistics.
fcp2-retry
Port option.
interval secs
Time interval in seconds.
loop-only
Port topology option.
loop-preferred
Port topology option.
point-to-point
Port topology option.
port-list
A comma-separated list of Data Domain system VTL ports. You can specify port
names as a range separated by a hyphen (-). The ports must already exist.

Note

For multiple ports, separate each name with a comma and enclose the list with
double quotes.

summary
Show a summary of all tapes and tape usage.
topology
Port option.

vtl port 245

vtl

vtl readahead
vtl readahead reset {stats | summary}
Reset VTL readahead information. When VTL reads a tape file it improves performance by
reading ahead information from tape files and caching the information until needed.
vtl readahead show {stats | detailed-stats | summary}
Display readahead information about each open tape file that has been read.
Argument Definitions
detailed-stats
Displays details of statistics.
stats
Display statistics.
summary
Show a summary of all tapes and tape usage.

vtl rename
vtl rename src-vtl dst-vtl
Rename a virtual tape library. The source name and the destination name must differ.

vtl reset
vtl reset hba
Reset the hba. Broadcast new VTLs and VTL changes over Fibre Channel to clients. Avoid
using the vtl reset hba command during an active backup or restore job. Changes may
cause an active job to fail, depending on the backup application and host type.
vtl reset detailed-stats
Reset the VTL detailed statistics.

vtl show
vtl show config [vtl]
Show the library name and model and tape drive model for a single VTL or all VTLs. All
users may run this command option.
vtl show detailed-stats
Show a large quantity of detailed VTL statistics and information.
vtl show element-address [vtl]
Show the following information for all VTLs, or a single VTL. All users may run this
command option.
l Starting element address
l Slot count and starting address
l CAP count and starting address
l Drive count and starting address
l Changer count and starting address

246 EMC Data Domain Operating System 5.4 Command Reference Guide
 vtl

vtl show stats [port {port-list | all}] [interval secs] [count

count]
Show VTL I/O stats.
vtl show stats vtl [drive {drive-list | changer | all}] [port
{port-list | all}] [interval secs] [count count]
Show VTL I/O stats including detailed traffic statistics for devices belonging to the
specified VTL. Statistics include speed of read/writes in KiB per second, per VTL drive.
This information is available only if a vtl is specified. All users may run this command
option.
Command Option Arguments
changer
Device type.
count
The number of objects on which to perform the action, as specified by the command
option.
detailed-stats
Displays details of statistics.
drive-list
List of drives in group.
interval secs
Time interval in seconds.
port-list
A comma-separated list of Data Domain system VTL ports. You can specify port
names as a range separated by a hyphen (-). The ports must already exist.

Note

For multiple ports, separate each name with a comma and enclose the list with
double quotes.

vtl
Name of library.

vtl slot
vtl slot add vtl [count num-slots]
Add slots to a virtual tape library. Additional slots are added to the end of the list of slots
in the specified virtual tape library. The maximum is 32,000 slots per library, 64,000 slots
per system.
vtl slot del vtl [count num-to-del]
Delete one or more slots from a virtual tape library.
Command Option Arguments
count
The number of objects on which to perform the action, as specified by the command
option.
num slots
The number of slots in the library. You cannot add more drives than the number of
configured slots. The maximum number of slots for all VTLs on a Data Domain
system is 32,000. Default is 20 slots.

vtl slot 247

vtl

num-to-del
The number of objects to delete.
vtl
Name of library.

vtl status
vtl status
Show the state of the VTL process. All users may run this command option.

vtl tape
vtl tape add barcode [capacity capacity] [count count] [pool
pool]
Add one or more virtual tapes and insert them into the vault. Optionally, add the tapes to
the specified pool.
vtl tape copy barcode barcode [count count] source src-pool
[snapshot src-snapshot] destination dst-pool
Copy tapes between VTL pools. Note that an opened writable tape in a tape drive may not
be copied. Additionally, source and destination pools cannot be the same unless copying
from a snapshot. If the snapshot argument is specified in the command option, tapes are
copied from the snapshot of the source pool. In this case the destination pool can be the
same as the source pool.
A tape that is in the vault or library slot/cap, or is opened read-only in a tape drive can be
copied. A tape that is opened writable in a tape drive may not be copied.

Example 99

# vtl tape copy barcode AA0000LC count 100 source replica-dest

destination daily-restores

vtl tape del barcode [count count] [pool pool]

Delete the specified tape or one or more tapes. You cannot delete tapes that are in a VTL.

CAUTION

This command deletes all data on tapes.

vtl tape history delete
Delete all VTL tape history.
vtl tape history disable
Disable VTL tape history.
vtl tape history enable
Enable VTL tape history.
vtl tape history show barcode [pool pool] [start-time
MMDDhhmm[[CC]YY]] [end-time MMDDhhmm[[CC]YY]]
Show history of move related events for a given tape.
vtl tape history status
Show current state of VTL tape history feature.

248 EMC Data Domain Operating System 5.4 Command Reference Guide
 vtl

vtl tape modify barcode [count count] [pool pool] retention-

lock {date | period}
Modify the state of retention lock of a specified tape or tapes. Change the amount of time
to maintain the retention lock on the specified tape or tapes. If the volume is not
mounted, the change is made immediately. Otherwise, data is synchronized first. The
command fails if the filesystem is read-only.
vtl tape modify barcode [count count] [pool pool] writeprotect
{on | off}
Set the write protect state of a specified tape. If the volume is not mounted, the tape file
permission is changed immediately. Otherwise, outstanding writes are synchronized first.
vtl tape move vtl source {slot | drive | cap} {src-address-list
| all} destination {slot | drive | cap} {dst-address-list |
auto}
Move one or more tapes between elements in a VTL. Values for src-address-list include:
all, 1, 2-14, 3-5, 7-10. Values for dst-address-list include: 1, 2-14, 3-5, 7-10, and auto.
You may specify the auto keyword only if moving from tapes from drives to slots. If auto
is selected, VTL finds the previous slot the tape was in and moves it to that slot. If the slot
is not empty, it moves the next available slot.
vtl tape move barcode barcode [count count] source src-pool
destination dst-pool
Move a tape between VTL pools if it is in the vault, or in a library slot or CAP. It may not be
moved between VTL pools if the tape is open in a drive. You cannot move the following
kinds of tapes:
l Tapes open in a drive
l Tapes on a replica
l Tapes configured with Retention Lock
vtl tape show {all | pool pool | vault | vtl} [summary] [count
count] [barcode barcode] [time-display {modification | creation
| retention}] [sort-by {barcode | pool | location | state |
capacity | usage | percentfull | compression | time | modtime}
[{ascending | descending}]]
Display information about tapes, including modification, creation, or retention times. If
time-display argument is omitted, the default is modification time for backward-
compatibility-mode VTL pools.
Modification times used by the system for age-based policies may differ from the last
modified time displayed in the tape information sections of the GUI and CLI. This is
expected behavior.
If you are using Extended Retention (formerly Archiver), see the EMC Data Domain
Operating System Administration Guide for details on modification time.
Command Option Arguments
addr
Abbreviation for address. Default address is 1 for importing tapes.

vtl tape 249

vtl

250 EMC Data Domain Operating System 5.4 Command Reference Guide