Você está na página 1de 438

DD OS 4.

9
Command Reference
Guide

Backup Recovery Systems Division


Data Domain LLC
2421 Mission College Boulevard, Santa Clara, CA 95054
866-WE-DDUPE; 408-980-4800

762-0007-0001 Revision A
March 26, 2010
Copyright 2010 EMC Corporation. All Rights Reserved.
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 and Data Domain are registered trademarks, and Global Compression is
a trademark of EMC Corporation

2
Contents

About This Guide. . . . . . . . . . . . . . . . . . . . . . . . . . .37


Chapter Summaries . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Access to Related Documents at Data Domain . . . . . . . 40
Access Data Domain Documents . . . . . . . . . . . . . . 41
Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Contacting Data Domain . . . . . . . . . . . . . . . . . . . . . . . . 42

1 About the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . .43


CLI Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Recall Commands . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Delete Characters . . . . . . . . . . . . . . . . . . . . . . . . . 44
Command Completion . . . . . . . . . . . . . . . . . . . . . . . 45
Cursor Movement . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Transpose Characters . . . . . . . . . . . . . . . . . . . . . . . 45

2 adminaccess . . . . . . . . . . . . . . . . . . . . . . . . . . .47
About the adminaccess Command. . . . . . . . . . . . . . . . . . 48
adminaccess Command Options . . . . . . . . . . . . . . . . . . . 48
add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
add host-list . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
add ssh-keys . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

DD OS 4.9 Command Reference Guide 3


authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . .49
authentication add cifs . . . . . . . . . . . . . . . . . . . .49
authentication del cifs . . . . . . . . . . . . . . . . . . . . .50
authentication reset cifs . . . . . . . . . . . . . . . . . . .50
authentication show . . . . . . . . . . . . . . . . . . . . . .50
certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50
certificate show . . . . . . . . . . . . . . . . . . . . . . . . .50
del . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51
del . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51
del ssh-keys . . . . . . . . . . . . . . . . . . . . . . . . . . . .51
disable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51
enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51
reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52
reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52
reset ssh-keys . . . . . . . . . . . . . . . . . . . . . . . . . . .52
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52
show ssh-keys . . . . . . . . . . . . . . . . . . . . . . . . . . .53
trust . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53
trust add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54
trust copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54
trust del . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54
trust show . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54

4 Contents
web . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
web option reset . . . . . . . . . . . . . . . . . . . . . . . . 54
web option set http-port . . . . . . . . . . . . . . . . . . . 54
web option set https-port . . . . . . . . . . . . . . . . . . 55
web option set session-timeout . . . . . . . . . . . . . . 55
web option show . . . . . . . . . . . . . . . . . . . . . . . . 55
adminaccess Examples . . . . . . . . . . . . . . . . . . . . . . . . . 56
Configuring adminaccess . . . . . . . . . . . . . . . . . . . . . 56
Add a Host . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Add an Authorized SSH Public Key . . . . . . . . . . . . . 56
Return Command Output to a Remote Machine . . . . . . 57

3 alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59
About the alerts Command . . . . . . . . . . . . . . . . . . . . . . 59
alerts Command Options . . . . . . . . . . . . . . . . . . . . . . . 60
add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
del. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
show alerts-list . . . . . . . . . . . . . . . . . . . . . . . . . 61
show all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
show current . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
show daily . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
show history . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
alerts Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

DD OS 4.9 Command Reference Guide 5


Configuring alerts . . . . . . . . . . . . . . . . . . . . . . . . . .63
Add to the Email List . . . . . . . . . . . . . . . . . . . . . .63
Remove from the Email List . . . . . . . . . . . . . . . . .63
Managing alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . .63
Test the Email List . . . . . . . . . . . . . . . . . . . . . . .63
Display the Email List . . . . . . . . . . . . . . . . . . . . . .63
Display the Email List and Administrator Email . . . . .64
Display Current Alerts . . . . . . . . . . . . . . . . . . . . .64
Display Current Alerts and Recent History . . . . . . . .64
Display the Alerts History . . . . . . . . . . . . . . . . . . .65
Important Notices. . . . . . . . . . . . . . . . . . . . . . . . . . . . .65

4 alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
About the alias Command . . . . . . . . . . . . . . . . . . . . . . .67
alias Command Options . . . . . . . . . . . . . . . . . . . . . . . . .68
add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68
del . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68
reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68
alias Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69
Add an Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69

5 authentication . . . . . . . . . . . . . . . . . . . . . . . . . 71
About the authentication Command. . . . . . . . . . . . . . . . .71
authentication Command Options . . . . . . . . . . . . . . . . . .71
disable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71

6 Contents
domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
domain reset . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
domain set . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
domain show . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
groups add . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
groups del . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
groups reset . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
groups show . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
servers add . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
servers del . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
servers reset . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
servers show . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

6 autosupport . . . . . . . . . . . . . . . . . . . . . . . . . . . .75
About the autosupport Command . . . . . . . . . . . . . . . . . . 75
autosupport Command Options . . . . . . . . . . . . . . . . . . . 77
add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
del. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

DD OS 4.9 Command Reference Guide 7


reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78
reset all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78
reset schedule . . . . . . . . . . . . . . . . . . . . . . . . . .78
reset support-list . . . . . . . . . . . . . . . . . . . . . . . .78
send . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79
set schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80
show all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80
show history . . . . . . . . . . . . . . . . . . . . . . . . . . . .81
show report . . . . . . . . . . . . . . . . . . . . . . . . . . . .81
show schedule . . . . . . . . . . . . . . . . . . . . . . . . . .81
show support-list . . . . . . . . . . . . . . . . . . . . . . . .81
test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .82
autosupport Examples . . . . . . . . . . . . . . . . . . . . . . . . . .82
Configuring autosupport . . . . . . . . . . . . . . . . . . . . . .82
Schedule the Autosupport Report . . . . . . . . . . . . . .82
Managing autosupport. . . . . . . . . . . . . . . . . . . . . . . .82
Run the Autosupport Report . . . . . . . . . . . . . . . . .82
Display the autosupport Email List . . . . . . . . . . . . .83
Display the autosupport History . . . . . . . . . . . . . . .83

7 cifs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
About the cifs Command . . . . . . . . . . . . . . . . . . . . . . . .86
cifs Command Options. . . . . . . . . . . . . . . . . . . . . . . . . .86
add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .86
add /backup . . . . . . . . . . . . . . . . . . . . . . . . . . . .87
add /ddvar . . . . . . . . . . . . . . . . . . . . . . . . . . . . .87

8 Contents
del. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
del /backup . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
del /ddvar . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
disable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
hosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
hosts add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
hosts del . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
hosts reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
hosts show . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
nb-lookup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
option reset . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
option set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
option show . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
reset authentication . . . . . . . . . . . . . . . . . . . . . . 94
reset clients . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
reset nb-hostname . . . . . . . . . . . . . . . . . . . . . . . 94
reset wins-server . . . . . . . . . . . . . . . . . . . . . . . . 94
set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
set authentication active-directory . . . . . . . . . . . . 95
set authentication nt4 . . . . . . . . . . . . . . . . . . . . 95
set authentication workgroup . . . . . . . . . . . . . . . 96
set nb-hostname . . . . . . . . . . . . . . . . . . . . . . . . 96
set wins-server . . . . . . . . . . . . . . . . . . . . . . . . . 96

DD OS 4.9 Command Reference Guide 9


share . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .96
share create . . . . . . . . . . . . . . . . . . . . . . . . . . . .96
share destroy . . . . . . . . . . . . . . . . . . . . . . . . . . .98
share disable . . . . . . . . . . . . . . . . . . . . . . . . . . .98
share enable . . . . . . . . . . . . . . . . . . . . . . . . . . .98
share modify . . . . . . . . . . . . . . . . . . . . . . . . . . .98
share show . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99
show active . . . . . . . . . . . . . . . . . . . . . . . . . . . .99
show clients . . . . . . . . . . . . . . . . . . . . . . . . . . . .99
show config . . . . . . . . . . . . . . . . . . . . . . . . . . . .99
show detailed-stats . . . . . . . . . . . . . . . . . . . . . . 100
show stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
troubleshooting domaininfo . . . . . . . . . . . . . . . . . 100
troubleshooting groups . . . . . . . . . . . . . . . . . . . . 101
troubleshooting list-groups . . . . . . . . . . . . . . . . . 101
troubleshooting list-users . . . . . . . . . . . . . . . . . . 101
troubleshooting performance . . . . . . . . . . . . . . . 101
troubleshooting users . . . . . . . . . . . . . . . . . . . . . 101
cifs Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Add a Share . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Allow Class C Network Access to a Share . . . . . . . . . . 103

8 cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
About the cluster Commands . . . . . . . . . . . . . . . . . . . . 106
cluster Command Options . . . . . . . . . . . . . . . . . . . . . . 106

10 Contents
add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
show config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

9 config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
About the config Command. . . . . . . . . . . . . . . . . . . . . 111
config Command Options . . . . . . . . . . . . . . . . . . . . . . 112
reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
reset location . . . . . . . . . . . . . . . . . . . . . . . . . 112
reset mailserver . . . . . . . . . . . . . . . . . . . . . . . 112
reset timezone . . . . . . . . . . . . . . . . . . . . . . . . 112
set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
set admin-email . . . . . . . . . . . . . . . . . . . . . . . 113
set admin-host . . . . . . . . . . . . . . . . . . . . . . . . 113
set location . . . . . . . . . . . . . . . . . . . . . . . . . . 114
set mailserver . . . . . . . . . . . . . . . . . . . . . . . . . 114
set timezone . . . . . . . . . . . . . . . . . . . . . . . . . . 115
setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

DD OS 4.9 Command Reference Guide 11


show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
show admin-email . . . . . . . . . . . . . . . . . . . . . . . 116
show admin-host . . . . . . . . . . . . . . . . . . . . . . . . 116
show all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
show location . . . . . . . . . . . . . . . . . . . . . . . . . . 116
show mailserver . . . . . . . . . . . . . . . . . . . . . . . . 117
show timezone . . . . . . . . . . . . . . . . . . . . . . . . . 117
config Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Configuring config . . . . . . . . . . . . . . . . . . . . . . . . . 117
Set the Timezone . . . . . . . . . . . . . . . . . . . . . . . 117

10 disk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
About the disk Command . . . . . . . . . . . . . . . . . . . . . . . 119
disk Command Options . . . . . . . . . . . . . . . . . . . . . . . . 120
add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
add dev . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
add enclosure . . . . . . . . . . . . . . . . . . . . . . . . . . 121
beacon. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
expand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
fail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

12 Contents
multipath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
multipath failback . . . . . . . . . . . . . . . . . . . . . . 123
multipath option set auto-failback . . . . . . . . . . . 123
multipath option set monitor . . . . . . . . . . . . . . . 124
multipath option reset auto-failback . . . . . . . . . . 124
multipath option reset monitor . . . . . . . . . . . . . 124
multipath option show . . . . . . . . . . . . . . . . . . . 124
multipath reset stats . . . . . . . . . . . . . . . . . . . . 125
multipath resume . . . . . . . . . . . . . . . . . . . . . . 125
multipath show history . . . . . . . . . . . . . . . . . . . 125
multipath show stats . . . . . . . . . . . . . . . . . . . . 125
multipath status . . . . . . . . . . . . . . . . . . . . . . . 125
multipath suspend . . . . . . . . . . . . . . . . . . . . . . 125
port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
port enable . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
port show stats . . . . . . . . . . . . . . . . . . . . . . . . 126
port show summary . . . . . . . . . . . . . . . . . . . . . 126
rescan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
set spindle-group . . . . . . . . . . . . . . . . . . . . . . . 127
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
show hardware . . . . . . . . . . . . . . . . . . . . . . . . 128
show detailed-raid-info . . . . . . . . . . . . . . . . . . . 129
show failure-history . . . . . . . . . . . . . . . . . . . . . 130
show performance . . . . . . . . . . . . . . . . . . . . . . 131
show raid-info . . . . . . . . . . . . . . . . . . . . . . . . . 132
show reliability-data . . . . . . . . . . . . . . . . . . . . 133
DD OS 4.9 Command Reference Guide 13
status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
unfail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
disk Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Add an Expansion Shelf . . . . . . . . . . . . . . . . . . . . . . 135
Important Notices. . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

11 enclosure . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
About the enclosure Command . . . . . . . . . . . . . . . . . . . 137
enclosure Command Options. . . . . . . . . . . . . . . . . . . . . 138
beacon. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
show all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
show controllers . . . . . . . . . . . . . . . . . . . . . . . . 138
show fans . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
show powersupply . . . . . . . . . . . . . . . . . . . . . . . 141
show summary . . . . . . . . . . . . . . . . . . . . . . . . . 142
show temperature-sensors . . . . . . . . . . . . . . . . . 142
show topology . . . . . . . . . . . . . . . . . . . . . . . . . 143
test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
test topology . . . . . . . . . . . . . . . . . . . . . . . . . . 144
enclosure Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Display the Enclosure Temperature . . . . . . . . . . . . . . 145

12 filesys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
About the filesys Command . . . . . . . . . . . . . . . . . . . . . 148
filesys Command Options . . . . . . . . . . . . . . . . . . . . . . . 148

14 Contents
clean . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
clean reset . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
clean set schedule . . . . . . . . . . . . . . . . . . . . . . 150
clean set throttle . . . . . . . . . . . . . . . . . . . . . . . 150
clean show config . . . . . . . . . . . . . . . . . . . . . . 151
clean show schedule . . . . . . . . . . . . . . . . . . . . . 151
clean show throttle . . . . . . . . . . . . . . . . . . . . . 151
clean start . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
clean status . . . . . . . . . . . . . . . . . . . . . . . . . . 152
clean stop . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
clean watch . . . . . . . . . . . . . . . . . . . . . . . . . . 153
destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
disable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
encryption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
encryption algorithm reset . . . . . . . . . . . . . . . . 155
encryption algorithm set . . . . . . . . . . . . . . . . . . 156
encryption algorithm show . . . . . . . . . . . . . . . . 156
encryption disable . . . . . . . . . . . . . . . . . . . . . . 156
encryption enable . . . . . . . . . . . . . . . . . . . . . . 156
encryption lock . . . . . . . . . . . . . . . . . . . . . . . . 157
encryption passphrase . . . . . . . . . . . . . . . . . . . 157
encryption show . . . . . . . . . . . . . . . . . . . . . . . 157
encryption unlock . . . . . . . . . . . . . . . . . . . . . . 158
fastcopy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

DD OS 4.9 Command Reference Guide 15


option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
option disable report-replica-as-writable . . . . . . . . 159
option enable report-replica-as-writable . . . . . . . . 159
option reset . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
option set global-compression-type . . . . . . . . . . . 160
option set local-compression-type . . . . . . . . . . . . 161
option set marker-type . . . . . . . . . . . . . . . . . . . 161
option set staging-reserve . . . . . . . . . . . . . . . . . . 163
option show . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
retention-lock . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Client-Side Retention Lock File Control . . . . . . . . . 165
retention-lock disable . . . . . . . . . . . . . . . . . . . . 166
retention-lock enable . . . . . . . . . . . . . . . . . . . . 167
retention-lock option reset . . . . . . . . . . . . . . . . . 167
retention-lock option set . . . . . . . . . . . . . . . . . . 167
retention-lock option show . . . . . . . . . . . . . . . . . 168
retention-lock reset . . . . . . . . . . . . . . . . . . . . . . 168
retention-lock status . . . . . . . . . . . . . . . . . . . . . 168
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
show compression . . . . . . . . . . . . . . . . . . . . . . . 168
show space . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
show uptime . . . . . . . . . . . . . . . . . . . . . . . . . . 170
status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
sync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
filesys Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

16 Contents
Retention Lock Procedure . . . . . . . . . . . . . . . . . . . 171
Performing Retention Lock File Control Commands
on the Client Operating System . . . . . . . . . . . 172
Additional Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Local Compression . . . . . . . . . . . . . . . . . . . . . . . . 173
Global Compression . . . . . . . . . . . . . . . . . . . . . . . 174
Replicator Destination Read/Write Option. . . . . . . . . 174
Tape Marker Handling . . . . . . . . . . . . . . . . . . . . . . 174
Disk Staging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Retention Lock and Replication . . . . . . . . . . . . . . . . 176
Retention Lock and Fastcopy . . . . . . . . . . . . . . . . . 176
Retention Lock and Filesys Destroy . . . . . . . . . . . . . 176

13 help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
About the help Command . . . . . . . . . . . . . . . . . . . . . . 179
help Command Options . . . . . . . . . . . . . . . . . . . . . . . 180
help Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

14 license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
About the license Command . . . . . . . . . . . . . . . . . . . . 181
license Command Options. . . . . . . . . . . . . . . . . . . . . . 183
add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
del. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
license Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Add a License . . . . . . . . . . . . . . . . . . . . . . . . . 184

DD OS 4.9 Command Reference Guide 17


15 log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
About the log Command . . . . . . . . . . . . . . . . . . . . . . . 185
log Command Options . . . . . . . . . . . . . . . . . . . . . . . . . 186
host. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
host add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
host del . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
host disable . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
host enable . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
host reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
host show . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
watch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
log Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Understand a Log Message . . . . . . . . . . . . . . . . . . . . 191
Archive Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . 192

16 migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
About the migration Command . . . . . . . . . . . . . . . . . . . 195
migration Command Options. . . . . . . . . . . . . . . . . . . . . 196
abort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
commit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
receive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
send . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
show stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
watch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
18 Contents
migration Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Migrate Between Source and Destination . . . . . . . . . 202
Migrate with Replication . . . . . . . . . . . . . . . . . . . . 202

17 net . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
About the net Command. . . . . . . . . . . . . . . . . . . . . . . 206
net Command Options . . . . . . . . . . . . . . . . . . . . . . . . 206
aggregate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
aggregate add . . . . . . . . . . . . . . . . . . . . . . . . . 206
aggregate del . . . . . . . . . . . . . . . . . . . . . . . . . 207
aggregate reset . . . . . . . . . . . . . . . . . . . . . . . . 207
aggregate show . . . . . . . . . . . . . . . . . . . . . . . . 208
config. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
config ifname 0 . . . . . . . . . . . . . . . . . . . . . . . . 208
config ifname autoneg . . . . . . . . . . . . . . . . . . . 209
config ifname dhcp . . . . . . . . . . . . . . . . . . . . . 209
config ifname duplex speed . . . . . . . . . . . . . . . . 210
config ifname ipaddr . . . . . . . . . . . . . . . . . . . . 210
config ifname mtu . . . . . . . . . . . . . . . . . . . . . . 211
config ifname netmask . . . . . . . . . . . . . . . . . . . 211
config ifname type . . . . . . . . . . . . . . . . . . . . . . 211
config ifname up | down . . . . . . . . . . . . . . . . . . 212
create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
create interface . . . . . . . . . . . . . . . . . . . . . . . 212
create virtual . . . . . . . . . . . . . . . . . . . . . . . . . 213
destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
disable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

DD OS 4.9 Command Reference Guide 19


ddns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
ddns add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
ddns del . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
ddns disable . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
ddns enable . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
ddns register . . . . . . . . . . . . . . . . . . . . . . . . . . 215
ddns reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
ddns show . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
ddns status . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
failover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
failover add . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
failover del . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
failover modify . . . . . . . . . . . . . . . . . . . . . . . . . 217
failover reset . . . . . . . . . . . . . . . . . . . . . . . . . . 217
failover show . . . . . . . . . . . . . . . . . . . . . . . . . . 218
hosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
hosts add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
hosts del . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
hosts reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
hosts show . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
iperf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
iperf client . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
iperf server . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
lookup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
ping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

20 Contents
set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
set dns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
set domainname . . . . . . . . . . . . . . . . . . . . . . . 222
set hostname . . . . . . . . . . . . . . . . . . . . . . . . . 222
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
show all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
show config . . . . . . . . . . . . . . . . . . . . . . . . . . 223
show dns . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
show domainname . . . . . . . . . . . . . . . . . . . . . . 223
show hostname . . . . . . . . . . . . . . . . . . . . . . . . 224
show hardware . . . . . . . . . . . . . . . . . . . . . . . . 224
show settings . . . . . . . . . . . . . . . . . . . . . . . . . 225
show stats . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
tcpdump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
tcpdump capture . . . . . . . . . . . . . . . . . . . . . . . 226
tcpdump del . . . . . . . . . . . . . . . . . . . . . . . . . . 227
net Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Sample Failover Workflow . . . . . . . . . . . . . . . . . . . 227
Sample Aggregation Workflow. . . . . . . . . . . . . . . . . 229
Important Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Considerations for Ethernet Failover and
Net Aggregation . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Supported Interfaces . . . . . . . . . . . . . . . . . . . . 231

18 nfs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
About the nfs Command . . . . . . . . . . . . . . . . . . . . . . . 233
nfs Command Options . . . . . . . . . . . . . . . . . . . . . . . . 234
add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

DD OS 4.9 Command Reference Guide 21


del . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
disable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
reset clients . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
reset stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
show active . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
show clients . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
show detailed-stats . . . . . . . . . . . . . . . . . . . . . . 236
show histogram . . . . . . . . . . . . . . . . . . . . . . . . . 237
show stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
nfs Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Add or Delete NFS Clients . . . . . . . . . . . . . . . . . . . . 239

19 ntp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
About the ntp Command . . . . . . . . . . . . . . . . . . . . . . . 241
ntp Command Options . . . . . . . . . . . . . . . . . . . . . . . . . 242
add timeserver . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
del timeserver. . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
disable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
reset timeservers. . . . . . . . . . . . . . . . . . . . . . . . . . 243
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

22 Contents
ntp Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Add an NTP Server . . . . . . . . . . . . . . . . . . . . . . . . 244

20 ost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
About the ost Command . . . . . . . . . . . . . . . . . . . . . . . 246
ost Command Options . . . . . . . . . . . . . . . . . . . . . . . . 247
enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
disable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
ifgroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
ifgroup add interface . . . . . . . . . . . . . . . . . . . . 248
ifgroup del interface . . . . . . . . . . . . . . . . . . . . 249
ifgroup disable . . . . . . . . . . . . . . . . . . . . . . . . 249
ifgroup enable . . . . . . . . . . . . . . . . . . . . . . . . . 249
ifgroup show config . . . . . . . . . . . . . . . . . . . . . 249
ifgroup reset . . . . . . . . . . . . . . . . . . . . . . . . . . 250
ifgroup status . . . . . . . . . . . . . . . . . . . . . . . . . 250
lsu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
lsu create . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
lsu delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
lsu show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

DD OS 4.9 Command Reference Guide 23


opt-dup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
opt-dup option reset . . . . . . . . . . . . . . . . . . . . . 251
opt-dup option set low-bw-optim . . . . . . . . . . . . . 251
opt-dup option show . . . . . . . . . . . . . . . . . . . . . 252
opt-dup reset stats . . . . . . . . . . . . . . . . . . . . . . 252
opt-dup show active . . . . . . . . . . . . . . . . . . . . . 252
opt-dup show history . . . . . . . . . . . . . . . . . . . . . 252
opt-dup show image-history . . . . . . . . . . . . . . . . 253
opt-dup show performance . . . . . . . . . . . . . . . . . 254
opt-dup show stats . . . . . . . . . . . . . . . . . . . . . . 254
option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
option set boost . . . . . . . . . . . . . . . . . . . . . . . . 255
option reset . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
option show . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
reset user-name . . . . . . . . . . . . . . . . . . . . . . . . 256
reset stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
set user-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
show connections . . . . . . . . . . . . . . . . . . . . . . . 257
show histogram . . . . . . . . . . . . . . . . . . . . . . . . . 258
show image-duplication active . . . . . . . . . . . . . . . 258
show stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
show user-name . . . . . . . . . . . . . . . . . . . . . . . . 259
status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

21 replication . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
About the replication Command . . . . . . . . . . . . . . . . . . 262

24 Contents
replication Command Options . . . . . . . . . . . . . . . . . . . 263
abort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
abort recover . . . . . . . . . . . . . . . . . . . . . . . . . 263
abort resync . . . . . . . . . . . . . . . . . . . . . . . . . . 263
add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
break . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
disable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
initialize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
modify low-bw-optim . . . . . . . . . . . . . . . . . . . . 266
modify source-host or destination-host . . . . . . . . 267
modify connection-host . . . . . . . . . . . . . . . . . . 268
modify connection-host port . . . . . . . . . . . . . . . 269
option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
option reset . . . . . . . . . . . . . . . . . . . . . . . . . . 269
option set bandwidth . . . . . . . . . . . . . . . . . . . . 269
option set delay . . . . . . . . . . . . . . . . . . . . . . . 270
option set listen-port . . . . . . . . . . . . . . . . . . . . 270
option show . . . . . . . . . . . . . . . . . . . . . . . . . . 270
reauth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
recover. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
resync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

DD OS 4.9 Command Reference Guide 25


show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
show config . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
show detailed-history . . . . . . . . . . . . . . . . . . . . . 274
show detailed-stats . . . . . . . . . . . . . . . . . . . . . . 274
show history . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
show performance . . . . . . . . . . . . . . . . . . . . . . . 275
show stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
sync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
sync status . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
throttle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
throttle add . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
throttle del . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
throttle reset . . . . . . . . . . . . . . . . . . . . . . . . . . 286
throttle set . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
throttle show . . . . . . . . . . . . . . . . . . . . . . . . . . 287
watch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
replication Examples. . . . . . . . . . . . . . . . . . . . . . . . . . 288
Configuring Replication . . . . . . . . . . . . . . . . . . . . . . 288
Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Configuring Replication Pairs . . . . . . . . . . . . . . . . 289
Create Collection Replication . . . . . . . . . . . . . . . 289
Create a Directory Replication . . . . . . . . . . . . . . . 290
Create Bi-Directional Directory Replication . . . . . . 291
Create One-to-Many Directory Replication . . . . . . . 291
Create Many-to-One Directory Replication . . . . . . . 291
Create Cascaded Directory Replication . . . . . . . . . 292
Create a Pool Replication . . . . . . . . . . . . . . . . . . 292
26 Contents
Managing Replication . . . . . . . . . . . . . . . . . . . . . . 293
Delete a Replication Pair . . . . . . . . . . . . . . . . . . . . 293
Suspend and Resume Replication . . . . . . . . . . . . . . . 294
Recover from a Full Replication Destination . . . . . . . 294
Replace a Directory SourceSame Directory Name . . . 296
Change the Destination Listen Port . . . . . . . . . . . . . 297
Set Replication Bandwidth and Network Delay . . . . . . 298
Managing Delta Replication . . . . . . . . . . . . . . . . . . 299
Determining Whether Delta Replication Increases
Compression . . . . . . . . . . . . . . . . . . . . . . . 300
Example where Delta Replication Improves
Throughput . . . . . . . . . . . . . . . . . . . . . . . . 302

22 route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
About the route Command . . . . . . . . . . . . . . . . . . . . . 305
route Command Options . . . . . . . . . . . . . . . . . . . . . . . 306
add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
del. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
show config . . . . . . . . . . . . . . . . . . . . . . . . . . 307
show gateway . . . . . . . . . . . . . . . . . . . . . . . . . 308
show table . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
trace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
route Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
Add a Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309

DD OS 4.9 Command Reference Guide 27


Delete a Route . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
Set a Default Gateway . . . . . . . . . . . . . . . . . . . . . . 309

23 snapshot . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
About the snapshot Command. . . . . . . . . . . . . . . . . . . . 311
snapshot Command Options . . . . . . . . . . . . . . . . . . . . . 312
add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Names of Snapshots Created by a Schedule . . . . . . 313
create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
del . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
expire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
rename . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
snapshot Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
Schedule a Snapshot . . . . . . . . . . . . . . . . . . . . . . . . 319

24 snmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
About the snmp Command . . . . . . . . . . . . . . . . . . . . . . 323
snmp Command Options . . . . . . . . . . . . . . . . . . . . . . . 324
add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
add ro-community . . . . . . . . . . . . . . . . . . . . . . . 324
add rw-community . . . . . . . . . . . . . . . . . . . . . . 324
add trap-host . . . . . . . . . . . . . . . . . . . . . . . . . . 325

28 Contents
del. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
del ro-community . . . . . . . . . . . . . . . . . . . . . . 325
del rw-community . . . . . . . . . . . . . . . . . . . . . . 325
del trap-host . . . . . . . . . . . . . . . . . . . . . . . . . . 326
disable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
reset ro-community . . . . . . . . . . . . . . . . . . . . . 326
reset rw-community . . . . . . . . . . . . . . . . . . . . . 326
reset sysContact . . . . . . . . . . . . . . . . . . . . . . . 327
reset sysLocation . . . . . . . . . . . . . . . . . . . . . . . 327
reset trap-hosts . . . . . . . . . . . . . . . . . . . . . . . . 327
set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
set sysContact . . . . . . . . . . . . . . . . . . . . . . . . . 327
set sysLocation . . . . . . . . . . . . . . . . . . . . . . . . 328
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
show config . . . . . . . . . . . . . . . . . . . . . . . . . . 328
show ro-communities . . . . . . . . . . . . . . . . . . . . 328
show rw-communities . . . . . . . . . . . . . . . . . . . . 329
show sysContact . . . . . . . . . . . . . . . . . . . . . . . 329
show sysLocation . . . . . . . . . . . . . . . . . . . . . . . 329
show trap-hosts . . . . . . . . . . . . . . . . . . . . . . . . 329
status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
Important Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

25 support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
About the support Command . . . . . . . . . . . . . . . . . . . . 331
support Command Options . . . . . . . . . . . . . . . . . . . . . 331
DD OS 4.9 Command Reference Guide 29
upload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

26 system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
About the system Command . . . . . . . . . . . . . . . . . . . . . 334
system Command Options . . . . . . . . . . . . . . . . . . . . . . 334
headswap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
option reset . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
option set . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
option show . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
poweroff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
reboot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
sanitize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
sanitize abort . . . . . . . . . . . . . . . . . . . . . . . . . . 337
sanitize start . . . . . . . . . . . . . . . . . . . . . . . . . . 337
sanitize status . . . . . . . . . . . . . . . . . . . . . . . . . 337
sanitize watch . . . . . . . . . . . . . . . . . . . . . . . . . 337
set date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338

30 Contents
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
show all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
show date . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
show detailed-stats . . . . . . . . . . . . . . . . . . . . . 339
show detailed-version . . . . . . . . . . . . . . . . . . . . 341
show hardware . . . . . . . . . . . . . . . . . . . . . . . . 342
show meminfo . . . . . . . . . . . . . . . . . . . . . . . . . 342
show modelno . . . . . . . . . . . . . . . . . . . . . . . . . 343
show nvram . . . . . . . . . . . . . . . . . . . . . . . . . . 343
show performance . . . . . . . . . . . . . . . . . . . . . . 344
show ports . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
show serialno . . . . . . . . . . . . . . . . . . . . . . . . . 349
show stats . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
show uptime . . . . . . . . . . . . . . . . . . . . . . . . . . 351
show version . . . . . . . . . . . . . . . . . . . . . . . . . . 351
status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
Upgrade by Using HTTP . . . . . . . . . . . . . . . . . . . 355
Examples for system . . . . . . . . . . . . . . . . . . . . . . . . . 356
Display System Statistics . . . . . . . . . . . . . . . . . . . . 356
Set the System Date and Time . . . . . . . . . . . . . . . . 356
Display System Performance . . . . . . . . . . . . . . . . . . 356
Display a Banner. . . . . . . . . . . . . . . . . . . . . . . . . . 357

27 user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
About the user Command . . . . . . . . . . . . . . . . . . . . . . 359
user Command Options . . . . . . . . . . . . . . . . . . . . . . . 360
add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
DD OS 4.9 Command Reference Guide 31
change. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
change password . . . . . . . . . . . . . . . . . . . . . . . . 361
change priv . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
del . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
disable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
password aging option reset . . . . . . . . . . . . . . . . 362
password aging option set . . . . . . . . . . . . . . . . . . 362
password aging option show . . . . . . . . . . . . . . . . 362
password aging reset . . . . . . . . . . . . . . . . . . . . . 362
password aging set . . . . . . . . . . . . . . . . . . . . . . 363
password aging show . . . . . . . . . . . . . . . . . . . . . 363
password strength show . . . . . . . . . . . . . . . . . . . 363
password strength reset . . . . . . . . . . . . . . . . . . . 364
password strength set . . . . . . . . . . . . . . . . . . . . 364
reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
show active . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
show detailed . . . . . . . . . . . . . . . . . . . . . . . . . . 365
show list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
user Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
Add a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
Remove a User . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
Change a Password. . . . . . . . . . . . . . . . . . . . . . . . . 366
Change a Privilege Level . . . . . . . . . . . . . . . . . . . . . 366
Reset to the Default User . . . . . . . . . . . . . . . . . . . . 366

32 Contents
Display Current Users . . . . . . . . . . . . . . . . . . . . . . 367
Display All Users. . . . . . . . . . . . . . . . . . . . . . . . . . 368

28 vtl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
About the vtl Command . . . . . . . . . . . . . . . . . . . . . . . 370
Options for the vtl Command . . . . . . . . . . . . . . . . . . . 371
add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
cap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
cap add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
cap del . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
del. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
disable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
drive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
drive add . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
drive del . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
group add . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
group create . . . . . . . . . . . . . . . . . . . . . . . . . . 376
group del . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
group destroy . . . . . . . . . . . . . . . . . . . . . . . . . 377
group modify . . . . . . . . . . . . . . . . . . . . . . . . . 377
group rename . . . . . . . . . . . . . . . . . . . . . . . . . 379
group show . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
group use . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

DD OS 4.9 Command Reference Guide 33


import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
Rules for the Number of Tapes Imported . . . . . . . . 381
initiator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
initiator reset address-method . . . . . . . . . . . . . . 381
initiator reset alias . . . . . . . . . . . . . . . . . . . . . . 381
initiator set address-method . . . . . . . . . . . . . . . . 382
initiator set alias . . . . . . . . . . . . . . . . . . . . . . . . 383
initiator show . . . . . . . . . . . . . . . . . . . . . . . . . . 383
option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384
option disable . . . . . . . . . . . . . . . . . . . . . . . . . . 384
option enable . . . . . . . . . . . . . . . . . . . . . . . . . . 385
option reset loop-id . . . . . . . . . . . . . . . . . . . . . . 385
option set loop-id . . . . . . . . . . . . . . . . . . . . . . . 385
option show . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
pool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
pool add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
pool del . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
pool show . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
port. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
port disable . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
port enable . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
port show detailed-stats . . . . . . . . . . . . . . . . . . . 387
port show hardware . . . . . . . . . . . . . . . . . . . . . . 388
port show stats . . . . . . . . . . . . . . . . . . . . . . . . . 388
port show summary . . . . . . . . . . . . . . . . . . . . . . 389
reset hba . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389

34 Contents
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
show config . . . . . . . . . . . . . . . . . . . . . . . . . . 389
show element-address . . . . . . . . . . . . . . . . . . . 390
show stats . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
slot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
slot add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
slot del . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
tape. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
tape add . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
tape del . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
tape modify retention-lock . . . . . . . . . . . . . . . . 394
tape modify writeprotect . . . . . . . . . . . . . . . . . 395
tape move . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
tape show . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
Add a VTL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
Move Tapes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
Manually Import and Export Tapes . . . . . . . . . . . . . . 398
Important Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
Tape Drives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401
Tape Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . 401
Data Structures . . . . . . . . . . . . . . . . . . . . . . . . . . 402
Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402

DD OS 4.9 Command Reference Guide 35


A MIB Reference . . . . . . . . . . . . . . . . . . . . . . . . 403
About the MIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
MIB Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
Top-Level Organization of the MIB . . . . . . . . . . . . . . . . . 404
The MIB in Text Format . . . . . . . . . . . . . . . . . . . . . . . . 405
Entries in the MIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
Important Areas of the MIB . . . . . . . . . . . . . . . . . . . 408
Alerts (.1.3.6.1.4.1.19746.1.4) . . . . . . . . . . . . . . . . . 408
Data Domain MIB Notifications (.1.3.6.1.4.1.19746.2) . . 409
Filesystem Space (.1.3.6.1.4.1.19746.1.3.2) . . . . . . . . 428
Replication (.1.3.6.1.4.1.19746.1.8) . . . . . . . . . . . . . 430
NFS (.1.3.6.1.4.1.19746.1.9) . . . . . . . . . . . . . . . . . . 432
CIFS (.1.3.6.1.4.1.19746.1.10) . . . . . . . . . . . . . . . . . 434
VTL (.1.3.6.1.4.1.19746.1.11) . . . . . . . . . . . . . . . . . 436

36 Contents
About This Guide

This guide explains how to manage the Data Domain system


with an emphasis on procedures using the Command Line
Interface (CLI).
This preface describes individual chapters, related documentation,
conventions, and audience, and provides contact information.

Chapter Summaries
The DD OS 4.9 Command Reference Guide includes the following
chapters:

About the CLI Gives general CLI information, including


shortcuts. See About the CLI on page 43.
adminaccess Manages the HTTP, FTP, Telnet, and SSH
services. See adminaccess on page 47.
alerts Creates alerts for system problems. Alerts are
emailed to Data Domain and to a user-
configurable list. See alerts on page 59.
alias Creates aliases for Data Domain system
commands. See alias on page 67.
authentication Manages NIS users, domains, groups and
servers. See authentication on page 71.
autosuppport Generates a system status and health report.
Reports are emailed to Data Domain and to a
user-configurable list. See autosupport on
page 75.

DD OS 4.9 Command Reference Guide 37


cifs Manages Common Internet File System access
on a Data Domain system and displays CIFS
status and statistics for a Data Domain system.
See cifs on page 85.
cluster Manages a Data Domain Global Deduplication
Array, which consists of one or two Data
Domain systems. See cluster on page 105.
config Shows, resets, copies, and saves Data Domain
system configuration settings. See config on
page 111.
disk Displays disk statistics, status, usage,
reliability indicators, and RAID layout and
usage. See disk on page 119.
enclosure Identifies and displays information about the
Data Domain system and expansion shelves.
See enclosure on page 137.
filesys Displays file system status and statistics, and
manages the clean feature that reclaims
physical disk space held by deleted data. See
filesys on page 147.
help Displays a list of all Data Domain system
commands and detailed explanations for each
command. See help on page 179.
license Displays current licensed features and allows
adding or deleting licenses. See license on
page 181.
log Displays and administers the Data Domain
system log file. See log on page 185.
migration Moves all data from one Data Domain system
to another. See migration on page 195.
net Displays the network status and sets up
failover and aggregation. See net on
page 205.
nfs Displays NFS status and statistics. See nfs on
page 233.

38 About This Guide


ntp Manages Data Domain system access to one or
more time servers. See ntp on page 241.
ost Allows a Data Domain system to be a storage
server for Symantecs NetBackup OpenStorage
feature. See ost on page 245.
replication Manages the Replicator for mirroring of
backup data from one Data Domain system to
another. See replication on page 261.
route Manages Data Domain system network
routing rules. See route on page 305.
snapshot Manages file system snapshots. A snapshot is
a read-only copy of the Data Domain system
file system from the directory /backup. See
snapshot on page 311.
snmp Enables or disables SNMP access to a Data
Domain system, adds community strings, and
gives contact and location information. See
snmp on page 323.
support Sends log files to Data Domain Technical
Support. See support on page 331.
system Displays Data Domain system status, faults,
and statistics, and enables, disables, halts, and
reboots a Data Domain system. See system
on page 333.
user Administers user accounts for the Data
Domain system. See user on page 359.
vtl Creates, manages, and deletes Virtual Tape
Libraries (VTLs) on a Data Domain system.
See vtl on page 369.
MIB Displays data about the Data Domain MIB. See
MIB Reference on page 403.

DD OS 4.9 Command Reference Guide 39


Related Documents
The Data Domain system Installation and Setup guide, which is
shipped with your Data Domain system, provides instructions for
installing your Data Domain system, connecting it to an
administrative console, and powering it on. After you have
completed installing and powering on your system, refer to the
DD OS 4.9 Initial Configuration Guide for additional information.
The following Data Domain system documentation provides
additional information about the use of the system:
Data Domain Software Release 4.9.x Release Notes
DD OS 4.9 Administration Guide
DD OS 4.9 Initial Configuration Guide
Data Domain Expansion Shelf Hardware Guide
Data Domain OpenStorage (OST) Administration Guide
The Data Domain system Installation and Setup guides for
each of the supported platforms (for example DD880, DD690g,
and so forth)
The Data Domain Hardware Overviews for each platform
family
Data Domain Hardware Guide (for older platforms)

Access to Related Documents at Data Domain


The Documentation page at
https://my.datadomain.com/documentation provides access to
three categories of documents that are related to use of Data
Domain products:
End-user documents, under Product Documentation.
Guides for how to integrate Data Domain systems with backup
applications, under Integration Documentation.
Matrices that show which components are compatible with
each other, under Compatibility Matrices. These matrices
include the following information:

40 About This Guide


Data Domain hardware product numbers
Data Domain operating system (DD OS) versions
Backup software versions
Backup software server and client operating system
versions
Hardware driver versions

Access Data Domain Documents


1. Log into the support portal at
https://my.datadomain.com/documentation.
2. To view user documents, click Product Documentation and
then perform the following steps:
a. Select the Data Domain model from the Platform list and
click View.
b. On the row for the correct Data Domain operating system
(DD OS) version, click View under Documentation.
c. Click the desired title.
3. To view integration-related documents, perform the following
steps:
a. Click Integration Documentation.
b. Select a vendor from the Vendor menu.
c. Select the desired title from the list and click View.
4. To view compatibility matrices, perform the following steps:
a. Click Compatibility Matrices.
b. Select the desired title from product menu and click View.

DD OS 4.9 Command Reference Guide 41


Conventions
The following table describes the typographical conventions used
in this guide.

Typeface or Usage Examples


Symbol
Monospace Commands, command options, Use the config command to
parameters, and computer manage the Data Domain system
output. configuration settings.
Monospace Commands the user types at the Enter:
bold command prompt (#). # config setup
Monospace Command variables the user # log view file_name
italic types at the command prompt
bold (#).
Italic Book titles and variables. Refer to theDD OS 4.9
Command Reference Guide for
complete descriptions of
DD OS commands.
Pipe (|) Choose (pipe) between a {arg1 | arg2}
and curly required argument (curly
braces ({}) braces) in the CLI.
Brackets ([]) One or more (list with [arg1, arg2, ...]
and ellipses commas and ellipses) optional
(...) (bracket) arguments in the
CLI.

Audience
This guide is for system administrators who are familiar with
standard backup software packages and general backup
administration.

Contacting Data Domain


To resolve issues with Data Domain products, contact your
contracted support provider or visit us online at
https://my.datadomain.com.
42 About This Guide
1 About the CLI

A Data Domain system can be administered through a command


line interface. Use the SSH or Telnet (if enabled) utilities to access
the command prompt.
The following are some general tips for using the CLI:
Each command also has an online help page that provides the
complete command syntax, option descriptions, and in many
cases usage examples. Help pages are available through the
help command.

To list CLI commands, enter a question mark (?) at the CLI


prompt.
To list the options for a particular command, enter the
command with no options at the prompt.
To find a keyword used in a command option, enter a question
mark (?) or the help command followed by the keyword. For
example, the question mark followed by the keyword
password displays all Data Domain system command options
that include password. If the keyword matches a command,
such as net, then the command explanation appears.
To display a detailed explanation of a particular command,
enter the help command followed by a command name.
Use the up and down arrow keys to move through a displayed
command buffer history list. Use the q key to exit. Enter a slash
character (/) and a pattern to search for to highlight lines of
particular interest.
Partial command matching is supportedonly the unique
letters of a command need be typed; for example, fi sh can be
typed for the command filesys show.

DD OS 4.9 Command Reference Guide 43


The Tab key completes a command entry when that entry is
unique. Tab completion works for the first three levels of
command components. For example, entering syst(Tab)
sh(Tab) st(Tab) displays the command system show stats.

Any Data Domain system command that accepts a list, such as


a list of IP addresses, accepts entries separated by commas,
spaces, or both.
Commands that display the use of disk space or the amount of
data on disks compute amounts using the following
definitions:

1 KiB = 210 bytes = 1024 bytes


1 MiB = 220 bytes = 1,048,576 bytes
1 GiB = 230 bytes = 1,073,741,824 bytes
1 TiB = 240 bytes = 1,099,511,627,776 bytes
Note: The one exception to displays in powers of 2 is the system
show performance command, in which the Read, Write, and
Replicate values are calculated in powers of 10 (1 KB = 1000).

CLI Shortcuts

Recall Commands
Ctrl+P or Retrieve the previous command from the
Down Arrow history buffer.
Ctrl+N or Up Retrieve the next command from the history
Arrow buffer.

Delete Characters
Ctrl+D Delete the character at the cursor.
Ctrl+H Delete the character before the cursor (same as
Delete key).
Ctrl+K Delete all characters from the cursor to the end
of the line.

44 About the CLI


Ctrl+U Delete all characters on the line.
Ctrl+W Delete all characters from the cursor to the
beginning of the line.

Command Completion
Tab or Ctrl+I Complete a partially typed keyword if enough
characters are entered to uniquely identify it.

Cursor Movement
Ctrl+A Move the cursor back to the start of the line.
Ctrl+B Move the cursor back one character.
Ctrl+E Move the cursor to the end of the line.
Ctrl+F Move the cursor forward one character.

Transpose Characters
Ctrl+T Transpose the character at the cursor with the
preceding character.

DD OS 4.9 Command Reference Guide 45


46 About the CLI
2 adminaccess

The adminaccess command creates access control lists for the use
of HTTP, FTP, Telnet, and SSH administrative protocols on the
Data Domain system.
The adminaccess command has the following options:
add Add hosts to a protocol or add an Page48
SSH public key.
authentication Manage and display authentication. Page49
certificate Display the host or CA certificate. Page50
del Remove client administrative access Page51
to the DD system through a specified
protocol, or delete an SSH key from
the key file.
disable Disable a service. Page51
enable Enable a service. Page51
reset Set the given access list to the factory Page52
defaults, or remove the authorized
SSH keys file from the Data Domain
system.
show Display hosts, status, and the SSH Page52
key file.
trust Manage trust with a given host. Page53
web Manage Web options. Page54

DD OS 4.9 Command Reference Guide 47


About the adminaccess Command
The Data Domain system adminaccess command allows remote
hosts to use the FTP, Telnet, HTTP, HTTPS, and SSH
administrative protocols on the Data Domain system. Except as
noted for specific command options, this command is available
only to Data Domain system administrative users.
The FTP, SSH, HTTP, HTTPS, and Telnet protocols have host-
machine access lists that limit access. The SSH protocol is open to
the default user sysadmin and to all Data Domain system users
added with the user add command. By default, FTP and Telnet
are disabled.

adminaccess Command Options


add
add host-list
adminaccess add {ftp | telnet | ssh | http | https} host-list
Use this command to add hosts to a protocol. For multiple hosts,
enter a list of entries separated by commas, spaces, or both. For
FTP, Telnet, and SSH, a host is a fully-qualified domain hostname,
class-C IP address, IP address with either netmasks or length, or an
asterisk (*) wildcard with a domain name, such as
*.yourcompany.com. An asterisk (*) by itself means no
restrictions.
For HTTP and HTTPS, the host-list can contain hostnames,
class-C IP addresses, an IP address range, or the word all.
For SSH, TCP wrappers are used and /etc/hosts.allow and
/etc/hosts.deny files are updated.

For HTTP/HTTPS, Apache's mod_access is used for host-


based access control and the
/usr/local/apache2/conf/httpd-ddr.conf file is updated.

48 adminaccess
add ssh-keys
adminaccess add ssh-keys [user username]
Use this command to add an SSH public key, created on a remote
machine, to the SSH authorized keys file on the Data Domain
system. The operation allows users to log in without giving a
password. On the remote machine, create a public key using the
ssh-keygen command. Use the key ~/.ssh/id_dsa.pub as
generated on the remote machine by ssh-keygen as input to the
add ssh-keys command. Refer to Add an Authorized SSH Public
Key for more information.

authentication
authentication add cifs
adminaccess authentication add cifs
Use this command to allow Windows domain users who have 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 either
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: For this command to work, CIFS must be enabled and the
Data Domain system must be part of a Windows domain.

DD OS 4.9 Command Reference Guide 49


authentication del cifs
adminaccess authentication del cifs
Use this command to prevent authentication against a Windows
domain and to allow administrative access only for those users
who have local user accounts on the Data Domain system.

authentication reset cifs


adminaccess authentication reset cifs
Use this command to reset the Windows user access to the default
of requiring a local account for administrative access to the Data
Domain system.

authentication show
adminaccess authentication show
Use this command to display the current value of the setting that
allows a Windows administrative user to access a Data Domain
system when no local account exists. For example,
# adminaccess authentication show
CIFS authentication: disabled

certificate
certificate show
adminaccess certificate show {ca | host}
Use this command to display the host or CA certificate. This
command is available to all users. For example:
# adminaccess certificate show ca
Cert Type Root CA
Subject dd120-18.datadomain.com
Valid From Tue Oct 14 13:39:35 2008
Valid Until Thu Oct 7 12:39:35 2038
Finger Print D6:E2:7B:55:F8:90:E9:27

50 adminaccess
del
del
adminaccess del {ftp | telnet | ssh | http} host-list
Use this command to remove hosts (IP addresses, hostnames, or
asterisk (*)) from the FTP, HTTP, SSH, or Telnet access lists. You
can enter a list that is separated by commas, spaces, or both. This
command is available to administrative users only.

del ssh-keys
adminaccess del ssh-keys lineno [user username]
Use this command to delete an SSH key from the key file. The
lineno is a line number as displayed by the adminaccess show
ssh-keys command. Users may delete their own keys.
Administrators may delete any users keys. Use adminaccess
show ssh-keys to get the line number value for the key to delete.

disable
adminaccess disable {http | https | ftp | telnet | ssh | all}
Use this command to disable a service on the Data Domain system.
Disabling FTP or Telnet does not affect entries in the access lists. If
all services are disabled, the Data Domain system is accessible only
through a serial console or keyboard and monitor. This command
is available to administrative users only.

enable
adminaccess enable {http | https | ftp | telnet | ssh | all}
Use this command to 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 through the Web-based graphical user interface. To
use FTP and Telnet, you must also add host machines to the access
lists. This command is available to administrative users only.

DD OS 4.9 Command Reference Guide 51


reset
reset
adminaccess reset {ftp | telnet | ssh | http | all}
Use this command to reset the FTP, HTTP, SSH, and Telnet
protocols to their default states and clear the access lists of host
entries. This command is available to administrative users only.

reset ssh-keys
adminaccess reset ssh-keys [user username]
Use this command to remove the authorized SSH keys file for a
user specified user or for the operator account from the Data
Domain system. After you remove the file, every SSH connection
needs password authentication. Administrators can reset SSH keys
for themselves (by omitting the user option) or for other users.
Regular users can only reset the SSH keys for their own account.

show
show
adminaccess show
Use this command to display every access service available on a
Data Domain system, whether or not the service is enabled, and a
list of hostnames that are allowed access through each service that
uses a list. An N/A in the Allowed Hosts column means that the
service does not use a list. A dash (-) means that the service can
have a list, but currently has no hosts in the list. An asterisk means
all hosts are allowed. For example:
# adminaccess show
Service Enabled Allowed Hosts
------- ------- -------------
ssh yes -
telnet no -
ftp no *
http yes -
https yes -
------- ------- -------------
52 adminaccess
Web options:
Option Value
--------------- -----
http-port 80
https-port 443
session-timeout 10800
--------------- -----
This command is available to administrative users only.

show ssh-keys
adminaccess show ssh-keys [user username]
Use this command to display the SSH key file with a line number
for each entry. Administrators can view the SSH key files of any
user. Regular users can only view their own SSH key file.

trust
You can add trust between Data Domain systems for group and
Global Deduplication Array management purposes. The trust
commands let administrators manage trust relationships. There
are two scenarios where trust relationships are used.
Group management in the Enterprise Manager is based on
trust relationships between nodes. You can view these trust
relationships with the trust commands. If you add the trust
relationship from the DD OS command line, when a Data
Domain system is imported into the EM for group
management, the sysadmin password is not required for
setting up the management of the external Data Domain
system (because the trust has been already established).
Global Deduplication Array management is also based on trust
relationships. As nodes are added to the Global Deduplication
Array by using the cluster add command, you can view the
trust relationships and their details by using the adminaccess
trust show command.

Note: Do not delete trusts that involve Global Deduplication


Array nodes. Doing so can cause Global Deduplication Array
management to fail.

DD OS 4.9 Command Reference Guide 53


trust add
adminaccess trust add hostname [type mutual]
Use this command to establish trust with the given host. The type
mutual option establishes mutual trust with that host.

trust copy
adminaccess trust copy {source | destination} hostname
Use this command to copy the trust to or from the given host.

trust del
adminaccess trust del hostname [type mutual]
Use this command to remove trust from the given host. The type
mutual option removes the mutual trust from that host.

trust show
adminaccess trust show hostname
Use this command to show the list of trusted Certificate
Authorities (CAs). This command is available to all users.

web
web option reset
adminaccess web option reset [http-port | https-port | session-
timeout]
Use this command to reset all Web options or the specified Web
option to their default values.

web option set http-port


adminaccess web option set http-port port-number
Use this command to set the http access port for the Web client.
Port 80 is set by default.

54 adminaccess
web option set https-port
adminaccess web option set https-port port-number
Use this command to set the https access port for the Web client.
Port 443 is set by default.

web option set session-timeout


adminaccess web option set session-timeout timeout-in-secs
Use this command to set the Web client session timeout. 10800
seconds is set by default.

web option show


adminaccess web option show
Use this command to show the current values for the Web options.
The output of this command may look like:
# adminaccess web option show
Option Value
--------------- -----
http-port 80
https-port 443
session-timeout 10800
--------------- -----

DD OS 4.9 Command Reference Guide 55


adminaccess Examples

Configuring adminaccess
Add a Host
To add the host srvr24 to the Telnet access list:
adminaccess add telnet srvr24.yourcompany.com
To add all hosts in a domain to the Telnet access list:
adminaccess add telnet *.yourcompany.com
To add a range of IP addresses to the Telnet access list:
adminaccess add telnet 10.24.20.0/24

Add an Authorized SSH Public Key


The following steps create a key on a UNIX-based system and then
write the key to a Data Domain system:
1. On the remote machine, create the public and private SSH
keys.
jsmith > ssh-keygen -d
Generating public/private dsa key pair.
Enter file in which to save the key
(/home/jsmith/.ssh/id_dsa):
.
2. Press Enter to accept the file location and other defaults. The
public key created under /home/jsmith/.ssh (in this
example) is id_dsa.pub.
3. On the remote machine, write the public key to the Data
Domain system, dd10 in this example. The Data Domain
system asks for the users password before accepting the key:
jsmith > ssh -l sysadmin dd10 adminaccess add ssh-
keys user jsmith \< ~/.ssh/id_dsa.pub

56 adminaccess
Return Command Output to a Remote Machine
Using SSH, you can have output from Data Domain system
commands return to a remote machine at login and then
automatically log out. For example, the following command
connects with the machine dd10 as user sysadmin, asks for the
password, and returns output from the command filesys
status.
ssh -l sysadmin dd10 filesys status
sysadmin@dd10s password:
The filesystem is enabled
You can create a file with a number of Data Domain system
commands, with one command on a line, and then use the file as
input to the login. Output from all the commands is returned. For
example, a file named cmds11 could contain the following
commands:
filesys status
system show uptime
nfs status
The login and the returned data look similar to the following:
ssh -l sysadmin dd10 < cmds11
sysadmin@dd10s password:
The filesystem is enabled
3:00 pm up 14 days 10 hours 15 minutes 1 user, load
average: 0.00, 0.00, 0.00
Filesystem has been up 14 days 10:13
The NFS system is currently active and running
Total number of NFS requests handled = 314576
To use scripts that return output from a Data Domain system, see
Add an Authorized SSH Public Key on page 56 to eliminate the need
for a password.

DD OS 4.9 Command Reference Guide 57


58 adminaccess
3 alerts

Use the alerts command to manage the alert email list. The
alerts command has the following options:

add Add an email address to the alert mailing list. Page60


del Delete an email address from the alert Page60
mailing list.
clear Clear one or more active alerts. Page60
reset Reset the alert mailing list to the default. Page60
show Display alert information, such as current Page61
alerts, alert history, or the alert mailing list.
test Send a test email. Page62

About the alerts Command


The alerts command manages who receives email notification for
system alerts. Alerts happen whenever the Restore Protection
Manager discovers a problem with software or a monitored
hardware component.
All alerts are sent as email (either immediately or via the Daily
Alert Summary) and a subset of alerts are also sent as SNMP traps.
The full list of traps sent are described in the snmp chapter (and are
also documented in the MIB).
Alerts are sent with either a WARNING or a CRITICAL severity.
Alerts of WARNING severity are sent to the recipients specified in
the autosupport email list (see autosupport on page 75). Alerts of
CRTICAL severity are sent to the recipients specified in the alerts
email list. To receive both WARNING and CRITICAL alerts, add
your email address to both lists.

DD OS 4.9 Command Reference Guide 59


alerts Command Options

add
alerts add email-list
Use this command to add email addresses to the list that receives
system alert emails. The email-list is a list of email addresses
that are separated by commas, spaces, or both.
By default, the list includes an address for Data Domain support
staff. After adding to the list, always use the alerts test
command to test for mailer problems. This command is available
to administrative users only.

clear
alerts clear alert-id alert-id-list
Use this command to clear a specified alert. The alert-id-list is
a list of active alert IDs separated by commas, spaces, or hyphens.
This command is available to administrative users only.

del
alerts del email-list
Use this command to delete email addresses from the list. The
email-list is a list of email addresses that are separated by
commas, spaces, or both. This command is available to
administrative users only.

reset
alerts reset
Use this command to set the email alerts list to the factory default
of autosupport-alert@autosupport.datadomain.com. This
command is available to administrative users only.

60 alerts
show
show alerts-list
alerts show alerts-list
Use this command to display the alerts email list, which includes
an address for Data Domain support. Addresses that you add to
the list appear as local or fully-qualified addresses exactly as you
enter them.

show all
alerts show all
Use this command to display the alerts email list and the
administrator email address, along with the current list of active
alerts.

show current
alerts show current
Use this command to display alerts for all situations that have not
been dealt with.
The list of current alerts includes all alerts that are not corrected.
An alert is removed from the display when the underlying
situation is corrected. For example, an alert about a fan failure is
removed when the fan is replaced with a working unit.
Each type of alert maintains only one message in the current alerts
list. For example, the display reports the most recent date of a
system reboot, not every reboot. Look in the system log files for
current and previous messages.

show daily
alerts show daily
Use this command to display current alerts and the alerts events
history for the last 24 hours. Use the up and down arrow keys to
move through the log. Use the q key to exit. Enter a slash character
(/) and a pattern to search for and highlight lines of particular
interest.
DD OS 4.9 Command Reference Guide 61
show history
alerts show history
Use this command to display the alerts events history file. The
event history file includes one line (date and reason) for every
system alert. Use the up and down arrow keys to move through
the log. Use the q key to exit. Enter a slash character (/) and a
pattern to search for and highlight lines of particular interest.
The alerts history lists alerts messages from all of the existing
messages system log files, which hold messages for up to ten
weeks.

test
alerts test [email-addr]
Use this command to send an email to all addresses on the alerts
list or to one or more specified addresses. After adding addresses
to the email list, always use this operation to test for mailer
problems.

62 alerts
alerts Examples

Configuring alerts
Add to the Email List
To add the email addresses js@yourcompany.com and
bjones@yourcompany.com to the alerts email list, use the
command:
alerts add js@yourcompany.com, bjones@yourcompany.com

Remove from the Email List


To remove an email address from the alerts list, use the command:
alerts del jsmith@yourcompany.com

Managing alerts
Test the Email List
To test for the address jsmith@yourcompany.com:
alerts test jsmith@yourcompany.com

Display the Email List


To display all email addresses in the alerts list, use the alerts
show alerts-list command.
The display is similar to the following:
# alerts show alerts-list
Alerts email:
autosupport@datadomain.com
admin12
jsmith@company.com

DD OS 4.9 Command Reference Guide 63


Display the Email List and Administrator Email
To display all email addresses on the alerts-list, use the
alerts show all command:
The administrator address appears twice:
# alerts show all
The Admin email is: admin@yourcompany.com
Alerts email
autosupport@datadomain.com
admin@yourcompany.com
admin12
jsmith@company.com
No active alerts.

Display Current Alerts


To display current alerts, use the alerts show current
command. The command returns entries similar to the following:
# alerts show current
Alert Id Alert Time Description
-------- ---------------- -------------
47 Wed Sep 23 07:46 Space in Data
Collection is 100% full (exceeds 100% threshold).
-------- ---------------- -------------
There is 1 active alert.

Display Current Alerts and Recent History


To display the current alerts and the alerts history over the last 24
hours, use the alerts show daily command. The display is
similar to the following:
# alerts show daily
Current Alert
-------------
Alert Id Alert Time Description
-------- ------------ ------------------------
42 Nov 12 18:54 Rear fan #1 failure:
Current RPM is 0, nominal is 8000
-------- ------------ ------------------------
There is 1 active alert.

64 alerts
Recent Alerts and Log Messages
------------------------------
Nov 5 20:56:43 localhost sysmon: EMS: Rear fan #2
failure: Current RPM is 960, nominal is 8000

Display the Alerts History


To display the history of alerts messages, use the alerts show
history command. Use the up and down arrow keys to move
through the display. Use the q key to exit. Enter a slash character
(/) and a pattern to search for and highlight lines of particular
interest.
The display is similar to the following:
# alerts show history
Alert Time Description
--------------- ------------------
Nov 11 18:54:51 Rear fan #1
failure: Current RPM is 0, nominal is 8000
Nov 11 18:54:53 system rebooted
Nov 12 18:54:58 Rear fan #2
failure: Current RPM is 0, nominal is 8000
--------------- ------------------

Important Notices
The alerts feature sends an email whenever a critical component
in the system fails or is known, through monitoring, to be out of
the acceptable range. Consider adding pager email addresses to
the alerts email list so that someone is informed immediately about
system problems. For example, multiple fan failures can cause a
system to begin overheating, which generates an alerts email.
Each disk, fan, and CPU in the Data Domain system is monitored.
Temperature extremes are also monitored.

DD OS 4.9 Command Reference Guide 65


66 alerts
4 alias

Use the alias command to create, delete, and display command


aliases. The alias command has the following options:
add Add a command alias. Page68
del Remove an alias. Page68
reset Reset the list of aliases to the default. Page68
show Show the list of aliases. Page68

About the alias Command


The alias command allows you to add, delete, and display
command aliases for the Data Domain system command set. Each
user can view and use aliases only for those commands that are
available at that user's permission level. The default aliases and
their corresponding Data Domain system commands are:

date system show date


df filesys show space
hostname net show hostname
ifconfig net config
iostat system show detailed-stats
netstat net show stats
nfsstat nfs show stats
passwd user change password
ping net ping
poweroff system poweroff
reboot system reboot

DD OS 4.9 Command Reference Guide 67


sysstat system show stats
traceroute route trace
uname system show version
uptime system show uptime
who user show active

alias Command Options

add
alias add
Use this command to add a command alias. Give the name for the
alias and then give the complete Data Domain system command
enclosed in double quotation marks ("..."). The new alias is
available only for the user that adds the alias.

del
alias del
Use this command to delete an alias by name.

reset
alias reset
Use this command to return to the default alias list, removing all
user-added aliases.

show
alias show
Use this command to display all aliases and their command
definitions.

68 alias
alias Examples

Add an Alias
The following command adds an alias named rely for the Data
Domain system command that displays disk reliability statistics:
# alias add rely "disk show reliability-data"

DD OS 4.9 Command Reference Guide 69


70 alias
5 authentication

Use the authentication command to manage NIS users,


domains, groups and servers. The authentication command has
the following options:
disable Disable the NIS client. Page71
domain Manage NIS domains. Page72
enable Enable the NIS client. Page72
groups Manage NIS groups. Page72
reset Reset NIS to the default settings. Page73
servers Manage NIS servers. Page73
show Display NIS information. Page74
status Display NIS status. Page74

About the authentication Command


The authentication nis command allows the Data Domain
system to participate in an active Network Information Service
(NIS) domain, which keeps a centralized repository of users,
groups, and server names. NIS adds a global directory which
authenticates users from any host on the network.

authentication Command Options

disable
authentication nis disable
Use this command to disable the NIS client. This command is
available to administrative users only.

DD OS 4.9 Command Reference Guide 71


domain
domain reset
authentication nis domain reset
Use this command to reset the NIS domain name. This command is
available to administrative users only.

domain set
authentication nis domain set domain [servers server-list]
Use this command to set the NIS domain name and optionally to
add NIS servers to the server-list. This command is available to
administrative users only.

domain show
authentication nis domain show
Use this command to display the NIS domain name. The display is
similar to the following:
# authentication nis domain show
NIS domain is "datadomain.com".

enable
authentication nis enable
Use this command to enable the NIS client. This command is
available to administrative users only.

groups
groups add
authentication nis groups add group-list priv {user | admin}
Use this command to add the privileges for NIS users in the
group-list as administrators or users. This command is
available to administrative users only.

72 authentication
groups del
authentication nis groups del group-list priv {user | admin}
Use this command to delete the privileges for NIS users in the
group-list as administrators or users. This command is available
to administrative users only.

groups reset
authentication nis groups reset
Use this command to delete all added NIS groups. This command
is available to administrative users only.

groups show
authentication nis groups show
Use this command to display lists of both NIS user groups and NIS
admin groups.

reset
authentication nis reset
Use this command to delete the NIS configuration and set it to the
default.

servers
servers add
authentication nis servers add server-list
Use this command to add NIS servers to the server-list. This
command is available to administrative users only.

servers del
authentication nis servers del server-list
Use this command to delete NIS servers from the server-list.
This command is available to administrative users only.

DD OS 4.9 Command Reference Guide 73


servers reset
authentication nis servers reset
Use this command to reset the NIS servers to their default settings.
This command is available to administrative users only.

servers show
authentication nis servers show
Use this command to display a list of NIS servers. The display is
similar to the following:
# authentication nis servers show
NIS Servers:
dd120-18

show
authentication nis show
Use this command to display the NIS configuration. The display is
similar to the following:
# authentication nis servers show
NIS Servers:
dd120-18
sysadmin@dd120-19# authentication nis show
NIS Summary:
Domain: datadomain.com
Servers: dd120-18
Admin Groups:
User Groups:
Enabled: No
Status: N/A (NIS Disabled)

status
authentication nis status
Use this command to display the NIS status.

74 authentication
6 autosupport

Use the autosupport command to manage the system report. The


autosupport command has the following options:

add Add entries to the autosupport list.a Page77

del Delete entries from the autosupport list.a Page77

reset Reset autosupport parameters.a Page78

reset all Reset all autosupport parameters.a Page78

reset schedule Reset the Autosupport Report schedule.a,b Page78

reset support- Reset the email list.a,b Page78


list
send Send autosupport messages. Page79
set schedule Schedule Autosupport Reports.a Page80

show Display autosupport information. Page80


test Test the autosupport email list. Page82
a. In a Global Deduplication Array, this command can be run on the
master controller only.
b. In a Global Deduplication Array, the autosupport email list and
schedule set on the master controller are automatically propagated to
the worker controller.

About the autosupport Command


The autosupport command automatically generates two reports
on state of the system: the Autosupport Report and the Daily Alert
Summary.
The Autosupport Report is sent daily at 6:00 a.m. (local time for
your system) to the autosupport email list. This time is
configurable.
DD OS 4.9 Command Reference Guide 75
The first section of an Autosupport Report gives system
identification and uptime information. The next sections display
output from numerous Data Domain system commands and
entries from various log files. At the end of the report, extensive
and detailed internal statistics and information are included to aid
Data Domain in debugging system problems.
Using autosupport from the master controller in a Global
Deduplication Array, two additional sections are present: cluster
information, and detailed cluster information. The first section
shows the Global Deduplication Array configuration and status
from the cluster show config and cluster status commands.
The second section shows Global Deduplication Array alerts,
licenses, and system performance. The worker controller has a
cluster information section and contains the cluster configuration.
Every morning at 8:00 a.m. (local time for your system), the Data
Domain system sends a Daily Alert Summary email to the
autosupport email list. This time is not configurable. The purpose
of this report is to highlight hardware or other failures that are not
critical, but that should be dealt with soon. An example is a fan
failure. A failed fan should be replaced as soon as is reasonably
possible, but the system can continue operation.
Non-critical hardware problems generate email messages to the
autosupport list. The Daily Alert Summary contains messages
from alerts show current (see Display Current Alerts on
page 64) about non-critical hardware situations, and some disk
space usage numbers. Specifically, it displays recent alerts and log
messages above the severity level WARNING from the
messages log file. If the situation is not fixed, the message also
appears in the Daily Alert Summary.

76 autosupport
autosupport Command Options

add
autosupport add email-list
Use this command to add email addresses to the list that receives
system reports. The email-list is a list of email addresses that are
separated by commas, spaces, or both. (The autosupport email list
contains the autosupport@autosupport.datadomain.com
address by default.) This command is available to administrative
users only.
In Global Deduplication Arrays, this command is run on the
master controller only.
To add the email address djones@yourcompany.com to the list,
use the command:
# autosupport add djones@yourcompany.com

del
autosupport del email-list
Use this command to delete email addresses from the list. The
email-list is a list of email addresses that are separated by
commas, spaces, or both. This command is available to
administrative users only.
In Global Deduplication Arrays, this command is run on the
master controller only.
For example, to remove an email address from the list, use:
# autosupport del jsmith@yourcompany.com

DD OS 4.9 Command Reference Guide 77


reset
reset all
autosupport reset all
Use this command to set all autosupport parameters to the factory
defaults. This command is available to administrative users only.
In Global Deduplication Arrays, this command is run on the
master controller only.

reset schedule
autosupport reset schedule
Use this command to set the system report schedule to the default
(daily 0600). This command is available to administrative users
only.
In Global Deduplication Arrays, this command is run on the
master controller only and the email list and schedule set on the
master controller are automatically propagated to the worker
controller.

reset support-list
autosupport reset support-list
Use this command to set the email list to the factory defaults. This
command is available to administrative users only.
In Global Deduplication Arrays, this command is run on the
master controller only and the email list and schedule set on the
master controller are automatically propagated to the worker
controller.

78 autosupport
send
autosupport send [email-addr] [cmd "cmd"]
Use this command to run the system report and email the results to
either a single address (using the email-addr option) or all
addresses on the autosupport list.
With an email address and a Data Domain system command,
autosupport sends the output of the command to the address.
Enclose the command that is to generate output in double
quotation marks.
With only a command, autosupport sends the command
output to the autosupport list.
When neither email addresses nor a command is specified,
then an autosupport message is generated and sent to all email
addresses in the autosupport list.
To send an autosupport message to djones@yourcompany.com,
use the command:
# autosupport send djones@yourcompany.com
To send the output of net stats show to
djones@yourcompany.com, use:
# autosupport send djones@yourcompany.com cmd net show stats

DD OS 4.9 Command Reference Guide 79


set schedule
autosupport set schedule [daily | never | day1[,day2,...]] time
Use this command to set the verbose system report to run at a
given frequency and a given time. The schedule operation can
specify a day (one or two numerals) or a day of the week (three
letters) at a specific time (0000). This command is available to
administrative users only.
In a Global Deduplication Array, this command is available only
on the master controller.
day Use three letters (such as mon for Monday). Use a dash (-)
between days for a range of days. For example: tue-fri.
time Use 24-hour military time. 2400 is not a valid time.
mon 0000 is midnight between Sunday night and Monday
morning.

For example, the following command runs the report


automatically every Tuesday at 4 a.m:
# autosupport set schedule tue 0400
The most recent invocation of the scheduling operation cancels the
previous setting.

show
show all
autosupport show all
Use this command to display all autosupport parameters. The
default display includes only the Data Domain support address
and the system administrator address (as given in the initial
system configuration). Any additional addresses that you add to
the list also appear. The display is similar to the following:
# autosupport show all
The Admin email is: admin@yourcompany.com
The Autosupport email list is:
autosupport@datadomain.com
admin@yourcompany.com
Autosupport is scheduled to run "Sun" at "0600"

80 autosupport
show history
autosupport show history
Use this command to display the event history file, which includes
the date for each Autosupport Report. 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 and highlight lines of
particular interest.
The command returns entries similar to the following:
# autosupport show history
Nov 10 03:00:19 scheduled autosupport
Nov 11 03:00:19 scheduled autosupport
Nov 12 03:00:19 scheduled autosupport

show report
autosupport show report
Use this command to run and display the normal system report,
but not send email. 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 and highlight lines of particular interest.

show schedule
autosupport show schedule
Use this command to display the system report schedule.
The display is similar to the following:
# autosupport show schedule
Autosupport is scheduled to run "Sun" at "0600"

show support-list
autosupport show support-list
Use this command to display the autosupport email list.

DD OS 4.9 Command Reference Guide 81


test
autosupport test [email-addr]
Use this command with no email address to test-run the system
report and email the results to all addresses on the autosupport
list. Use this command with only an email address, send the
system report to the specified address. After adding addresses to
the email list, always use this operation to test the new addresses.

autosupport Examples

Configuring autosupport
Schedule the Autosupport Report
To schedule the system report for every Tuesday at 3 p.m., use the
following command:
# autosupport set schedule tue 1500
To schedule the system report for 2 p.m. every Monday and
Friday, use:
# autosupport set schedule mon,fri 1400
To send a copy of the log file messages.1 to Data Domain
Support, use:
# autosupport send support@datadomain.com cmd "log
view messages.1"

Managing autosupport
Run the Autosupport Report
Use the autosupport show report command to manually run
and immediately display the Autosupport Report. Use the up and
down arrow keys to move through the display. Use the q key to
exit. Enter a slash character (/) and a pattern to search for and
highlight lines of particular interest.

82 autosupport
The display is similar to the following. The first section gives
system identification and uptime information:
# autosupport show report
========== GENERAL INFO ==========
GENERATED_ON=Wed Feb 11 13:17:48 UTC 2009
VERSION=Data Domain OS 4.6.0.0-62320
SYSTEM_ID=Serial number: 22BM030026
MODEL_NO=DD560
HOSTNAME=dd10.yourcompany.com
LOCATION=Bldg12 room221 rack6
ADMIN_EMAIL=admin@yourcompany.com
UPTIME= 1:17pm up 124 days, 14:31, 2 users, load
average: 0.00, 0.00, 0.00
The next sections display output from numerous Data Domain
system commands and entries from various log files. At the end of
the report, extensive and detailed internal statistics and
information appear to aid Data Domain in debugging system
problems.

Display the autosupport Email List


The autosupport email list includes an address for Data Domain
support. Addresses that you add to the list appear as local or fully-
qualified addresses exactly as you enter them.
To display all email addresses in the alerts list, use the command
autosupport show support-list.

The default display is similar to the following:


# autosupport show support-list
Autosupport Email List
autosupport@datadomain.com
admin@yourcompany.com

Display the autosupport History


To display all autosupport messages, use the autosupport show
history command. Use the J key to scroll down through the file,
the K key to scroll up, and the Q key to exit. The operation displays
entries from all of the messages system logs, which hold messages
for up to ten weeks.

DD OS 4.9 Command Reference Guide 83


The command returns entries similar to the following:
# autosupport show history
Nov 10 03:00:19 scheduled autosupport
Nov 11 03:00:19 scheduled autosupport
Nov 12 03:00:19 scheduled autosupport

84 autosupport
7 cifs

The cifs command manages CIFS (Common Internet File System)


data access between a Data Domain system and Windows clients.
The cifs command includes the following options:
add Add a CIFS backup or administrative Page86
client.
del Delete a CIFS client. Page87
disable Disable CIFS clients from connecting to a Page88
Data Domain system.
enable Enable CIFS clients to connect to a Data Page88
Domain system.
hosts Add or remove an lmhosts mapping, or Page88
reset it to the default.
nb-lookup Display the IP address for a specified Page89
NetBIOS name.
option Set various CIFS options, such as the log Page89
level, ntfs-acls support, and the
maximum number of open files; reset an
option to its default; or display the CIFS
options.
reset Reset CIFS authentication mode to Page95
workgroup, remove CIFS client access,
set the NetBIOS hostname to none, or set
the WINS server IP address to none.
set Set the authentication mode, set the Page95
NetBIOS hostname, or set the WINS
server IP address.
share Create, destroy, disable, enable, or Page96
modify a share, or display share
configurations for all shares or for a
specified share.

DD OS 4.9 Command Reference Guide 85


show Show active and allowed CIFS clients, Page96
show the CIFS configuration, or show
CIFS statistics.
status Show whether or not CIFS is enabled. Page100
troubleshooting List CIFS users and groups, or collect Page100
data for CIFS performance analysis.

About the cifs Command


The cifs command, which is for administrative use only, enables
and disables 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 and CIFS options, and
displays status and statistics for CIFS clients.

cifs Command Options

add
Note: Data Domain recommends using the cifs share create
command instead of the cifs add command, except when adding
the name of an individual client.
When entering the client list for the cifs add command:
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, such as
*.yourcompany.com.

Enter an asterisk (*) to add all clients on the network.

86 cifs
add /backup
cifs add /backup client-list
Use this command to specify the CIFS backup clients that can
access a Data Domain systems /backup directory. The /backup
directory is the target directory for compressed backup server
data.

add /ddvar
cifs add /ddvar client-list
Use this command to specify the administrative clients that can
access a Data Domain systems /ddvar directory, which contains
Data Domain system core and log files.
Note: After a CIFS client name has been added, it needs to be
configured to access the Data Domain system. If CIFS is not
enabled on the Data Domain system, it must be enabled via the
cifs enable command. Data Domain integration documents
explain how to configure the client. Go to the Documentation >
Integration Documentation page at the Data Domain Support Web
site (https://my.datadomain.com). Select the vendor for the clients
operating system and then select the appropriate tuning
document.

del
Note: Data Domain recommends using the cifs share destroy
command instead of the cifs del command, except when
deleting the name of an individual client.
When entering the client list for the cifs del command:
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, such as
*.yourcompany.com.

Enter an asterisk (*) to add all clients on the network.

DD OS 4.9 Command Reference Guide 87


del /backup
cifs del /backup client-list
Use this command to specify clients to remove from the list of CIFS
backup clients that can access a Data Domain systems /backup
directory.

del /ddvar
cifs del /ddvar client-list
Use this command to specify administrative clients to remove from
the list of clients that can access a Data Domain systems /ddvar
directory, which contains Data Domain system core and log files.

disable
cifs disable
Use this command to disable the CIFS service on the Data Domain
system, thereby preventing CIFS clients from connecting to it.

enable
cifs enable
Use this command to enable the CIFS service on the Data Domain
system and give clients CIFS access.

hosts
hosts add
cifs hosts add ipaddr host-list
Use this command to add an lmhosts mapping. The lmhosts file
is a local text file that maps IP addresses to NetBIOS names. One IP
address can have multiple hostnames.

88 cifs
hosts del
cifs hosts del ipaddr
Use this command to remove the lmhosts mapping for the
specified IP address.

hosts reset
cifs hosts reset
Use this command to reset the lmhosts mapping to the default,
which is to remove all IP address and NetBIOS hostnames from the
lmhosts file.

hosts show
cifs hosts show
Use this command to display lmhosts mappings.

nb-lookup
cifs nb-lookup nb_hostname
Use this command to display the IP address for the specified
NetBIOS name when CIFS is enabled.

option
option reset
cifs option reset name
Use this command to reset the specified option to its default value.

DD OS 4.9 Command Reference Guide 89


option set
The cifs option set commands set the following CIFS options:

option set allowtrusteddomains


cifs option set allowtrusteddomains {enabled | disabled}
Use this command to allow user access from domains that are
trusted by the domain that includes the Data Domain system. The
default value is disabled.

option set dd admin groupn


cifs option set "dd admin groupn" ["windows grp-name"]
Use this command to allow system administrative access via SSH,
Telnet, and FTP for groups that exist on a Windows domain
controller if CIFS administrative access is enabled on the Data
Domain system with the adminaccess command. Use the
windows grp-name option to add groups or to map a default
group number, such as dd admin group1, to a different Windows
group name. These default group mappings are configured on a
system:
"dd admin group1" is mapped to the Windows group
"Domain Admins."
dd admin group2 is not mapped to any group.

option set idmap-type


cifs option set idmap-type {rid | none}
Use this command to set the CIFS idmap-type.
When this option is set to rid (the default), the SAMBA idmap
rid/tdb is used.
When the option is set to none, all CIFS users are mapped to a
local UNIX user named cifsuser belonging to the local UNIX
group users.
Note: This option can be set to none only when ACL support is
enabled using the cifs option set ntfs-acls {enabled |
disabled} command.

90 cifs
option set interfaces
cifs option set interfaces value
Use this command to set the interfaces network interfaces on
which the CIFS server listens for client connections. The value
is a list of interface names. Multiple interfaces must be
separated by a space and enclosed within double quotation
marks; for example, "eth0 eth2".
By default, the CIFS server listens on all Data Domain system
NIC-active interfaces. Use this command to restrict the CIFS
server access to specified interfaces.

option set loglevel


cifs option set loglevel value
Use this command to set the level of detail in messages sent to the
CIFS log file, where value is an integer from 0 (zero) to 10. The
system default is 0, which sends the least-detailed level of
messages.
Note: A log level of 10 degrades system performance. Please reset
the log level to 1 after debugging an issue.

option set maxopenfiles


cifs option set maxopenfiles value
Use this command to set the maximum number of open files,
where value is an integer from 128 to a suggested maximum of
10000. The actual maximum is limited by the system resources. The
default value is 10000. Because each open file requires a certain
amount of memory, the server could run out of memory if value is
set too high. If value is set to less than 128, the system uses 128.

option set maxxmit


cifs option set maxxmit value
Use this command to set the maximum transmit size, where value
is an integer from 16384 to 65536. The default value is 16644.

DD OS 4.9 Command Reference Guide 91


option set ntfs-acls
cifs option set ntfs-acls {enabled | disabled}
Use this command to enable (the default) or disable ACL support.
When ACL support is disabled, the system has limited ACL
support in that you can set ACLs that can be represented in UNIX
permission bits.
Note: CIFS must be disabled to set this option. If CIFS is running,
disable CIFS services.

option set organizational-unit


cifs option set organizational-unit value
Use this command to set the organizational-unit (OU). You can
add the Data Domain system to any OU in the AD (active
directory), instead of the default OU, which is Computers. After
setting this option, use the cifs set authentication active-
directory command to join the domain. For example:
# cifs option set organizational-unit "Computers/Servers /ddsys
units"
# cifs set authentication active-directory YourCompany.com
Note: If the Data Domain systems account is already in the
default Computers or in another OU, the computer account does
not change to the newly specified organizational unit when the
domain is rejoined.

restrict-anonymous
cifs option set restrict-anonymous {enabled | disabled}
Use this command to control anonymous connections. The default
value is disabled, which allows anonymous connections.

92 cifs
option set smbd-mem-limit
cifs option set smbd-mem-limit value
Use this command to set the amount of memory available for
SMBD connections. Some backup applications open more SMBD
sessions and connections if the system does not process SMBD
operations as fast as expected, which might be the case when there
is a large number of file deletions. New connections also slow
down operations. Increase memory for SMBD to avoid looping.
The value is an integer from 52428800 to 1073741824 with a default
value of 209715200.

option set winbindd-mem-limit


cifs option set winbindd-mem-limit value
Use this command to set the memory available for user accounts
when the number of user accounts approaches 30,000. The value is
an integer from 52428800 to 1073741824 with a default value of
157286400.

option show
cifs option show
Use this command to display the CIFS options.

DD OS 4.9 Command Reference Guide 93


reset
reset authentication
cifs reset authentication
Use this command to reset the CIFs authentication to the default
mode, which is workgroup.

reset clients
cifs reset clients
Use this command to reset the CIFS client access list for the backup
and administrative clients (shared backup and ddvar) to the
default, which does not grant access to any client. In addition, the
backup and ddvar shares are also removed.

reset nb-hostname
cifs reset nb-hostname nb_hostname
Use this command to reset the NetBIOS hostname to the default,
which is none.

reset wins-server
cifs reset wins-server
Use this command to set the WINS server IP address to the default,
which is none.

94 cifs
set
set authentication active-directory
cifs set authentication active-directory realm {[dc1[dc2...]]/
| *}
Use this command to set the authentication to the active directory.:
The realm must be a fully qualified name.
Note: Data Domain does not recommend specifying a domain
controller. Instead, specify all controllers by entering an asterisk
(*).
(Optional) Specify multiple domain controllers (dc). The
entries in the domain controller list entries can be separated
by commas, spaces, or both.
When you enter this command, you are prompted for a user
account. Enter either a user on your companys domain, or a user
in a domain that is a trusted domain of your company. This user
must have permission to create accounts in your companys
domain.
The Data Domain system automatically adds a host entry to the
DNS server, so it is not necessary to manually create the DNS host
entry for the Data Domain system.
Note: If you set NetBIOS hostname using the command cifs set
nb-hostname, the entry is created for NetBIOS hostname instead
of the system hostname. Otherwise, the system hostname is used.

set authentication nt4


cifs set authentication nt4 domain{[dc1[dc2...]]/ | *}
Use this command to set the authentication mode to the NT4
domain. Only use this command to join NT4 domains. To join an
Active Directory domain (Windows 2000 and later), use set
authentication active-directory instead. If you do not know
the domain type, ask your domain administrator.

DD OS 4.9 Command Reference Guide 95


set authentication workgroup
cifs set authentication workgroup workgroup
Use this command to set the authentication mode to workgroup
for the specified workgroup name.

set nb-hostname
cifs set nb-hostname nb_hostname
Use this command to set the NetBIOS hostname.

set wins-server
cifs set wins-server ipaddr
Use this command to set the WINS server IP address. If CIFS
clients are using NetBIOS, a WINS server may be needed to resolve
NetBIOS names to IP addresses.

share
share create
cifs share create share-name path path {max-connections number
| clients "client-list" | browsing {enabled | disabled} |
writeable {enabled | disabled} | users "user-names" |comment
"comment"}
Use the share create command to add a share.
Note: /backup subdirectory is not supported in Global
Deduplication Array.
Note the command options:
share-name A descriptive name for the share.
path The path to the target directory.
max-connections The maximum number of connections to the
share that are allowed at one time.

96 cifs
client-list A comma-separated list of clients that are
allowed to access the share. You can specify the
clients by host name or IP address. No blanks or
tabs (white space) characters are allowed. The list
must be enclosed in double quotation marks. For
example, use:
"host1,host2"
"host1,10.24.160.116"
browsing The share can be seen (enabled, which is the
default), or not seen (disabled) by Web browsers.
writeable The share can be writable (enabled, the default),
or not writable (disabled).
Note: All administrative users have write
privileges, by default, even if writable is disabled
user-names A comma-separated list of user names. Other
than the comma delimiter, any white space
(blank or tab) characters are treated as part of the
user name because a Windows user name can
have a space character in the name. The list must
be enclosed in double quotation marks. For
example, "user1,user2" or
"user1,@group1"
The user names list can include group names,
which must be proceeded by the at (@)
symbol, such as @group1.
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. Group names and user names should be
separated only by commas, not by spaces.
There can be spaces inside the name of a
group, but there should not be spaces between
groups.
comment A descriptive comment about the share.

Examples of valid client lists include:


"host1,host2"
"host1,10.24.160.116"

DD OS 4.9 Command Reference Guide 97


Examples of invalid client lists include:
"host1 "
"host1 ,host2"
"host1, 10.24.160.116"
"host1 10.24.160.116"
Examples of valid user names lists include:
"user1,user2"
"user1,@group1"
" user-with-one-leading-space,user2"
"user1,user-with-two-trailing-spaces "
"user-with-a middle-space,user2,user3"
"user1,@CHAOS\Domain Admins"

share destroy
cifs share destroy share share
Use this command to delete a share.

share disable
cifs share disable share share
Use this command to disable a share.

share enable
cifs share enable share share
Use this command to enable a share.

share modify
cifs share modify share {max-connections number |clients
"client-list" | browsing {enabled | disabled} |writeable
{enabled | disabled} | users "user-names"}
Use this command to modify a share configuration with the same
configuration options as in the cifs share create command,

98 cifs
except for its path. You cannot change the path for an existing
share. Modifications apply to new connections only.
See the share create command for a description of the command
variables. To remove a user list for the share, specify "user-
names".

Note: /backup subdirectory is not supported in Global


Deduplication Array.

share show
cifs share show share
Use this command to display share configurations for all shares, or
for a specified share.

show
show active
cifs show active
Use this command to display all active CIFS clients.

show clients
cifs show clients
Use this command to display all allowed CIFS clients for the
default /ddvar administrative share and the default /backup data
share.
Note: Use the cifs share show command to show client access
information for custom shares.

show config
cifs show config
Use this command to display the CIFS configuration.

DD OS 4.9 Command Reference Guide 99


show detailed-stats
cifs show detailed-stats
Use this command to display statistics for every individual type of
SMB operation, display CIFS client statistics, and print a list of
operating systems with their client counts.
The list counts the number of different IP addresses that are
connected from each operating system. In some cases the same
client may use multiple IP addresses. The next table describes the
client statistics.
Miscellaneous clients Yes means that the displayed list of
clients is incomplete. No means that the
list is complete.
Maximum connections This value is the maximum number of
connections since the last reset.

Note: In the output display, the entry "Windows 2002 Service Pack
2 2600" is more commonly known as Windows XP.

show stats
cifs show stats
Use this command to display statistics for SMB reads, writes, and
total operations.

status
cifs status
Use this command to display whether the CIFS service is enabled
or disabled on the system.

troubleshooting
troubleshooting domaininfo
cifs troubleshooting domaininfo
Use this command to report domain information. Specifically, it
useful when you want to check the connectivity between the Data

100 cifs
Domain system and the domain or when you suspect that, due to
domain connectivity, you have authentication issues.

troubleshooting groups
cifs troubleshooting group groupname
Use this command to list details for a specified group.

troubleshooting list-groups
cifs troubleshooting list-groups
Use this command to list all CIFS groups.

troubleshooting list-users
cifs troubleshooting list-users
Use this command to list all CIFS users.

troubleshooting performance
cifs troubleshooting performance
Use this command to collect tcpdump and ddfs traces for CIFS
performance analysis. If you are having performance problems,
enter these commands in succession:
# cifs troubleshooting performance
# support upload bundle

troubleshooting users
cifs troubleshooting user username
Use this command to list details for a specified user.

DD OS 4.9 Command Reference Guide 101


cifs Examples

Add a Share
1. On the Data Domain system, add the list of clients that can
access the system. For example:
# cifs share create backup path /backup clients "10.24.160.116"
2. On a CIFS client, browse to \\dd\backup and create the share
directory, such as \\dd\backup\dir2.
3. On the CIFS client, set share directory permissions or security
options.
4. On the Data Domain system, create the share and add users,
which are the clients that were given access to the system. For
example:
# cifs share create dir2 path /backup/dir2 clients
"host1,host2" users "domain\user5,domain\user6"
5. To create a share named user5 and allow a maximum of five
client connections with client access for a client named db1,
enter:
# cifs share create user5 path /backup/user5 max-connections
5 clients "db1.domain.com" comment "user5 backups"
To create a share named share6 and limit access to the share to the
built-in CIFS user sysadmin, enter:
# cifs share create share6 path /backup/share6 clients * users
"sysadmin"
Note: When mapping share6, use the Data Domain system name
as the domain name; for example, use dd1\sysadmin.
6. To give Data Domain system administrative access to a
Windows group named backup-admin and to map the Data
Domain system "dd admin group1" to the group, enter:
# cifs option set "dd admin group1" "windows backup-admin"

102 cifs
Allow Class C Network Access to a Share
To allow class C network access to a share, use CIDR notation or
the class C network's address and subnet mask to specify the
client.
To add a subnet by using CIDR notation:
# cifs share create test path /backup clients "192.168.4.0/22"
To add a subnet by using a class C network subnet mask:
# cifs share create test path /backup clients
"192.168.4.0/255.255.252.0"
To add two class C network subnets:
# cifs share create test path /backup/test clients
"192.168.4.0/255.255.255.0,192.168.5.0/255.255.255.0"

DD OS 4.9 Command Reference Guide 103


104 cifs
8 cluster

The cluster command manages a Data Domain Global


Deduplication Array. A standard Global Deduplication Array is
comprised of two controllers. The first controller is known as the
master controller, and the second as the worker controller. The
master controller manages the worker controller.
Note: For more information, see the Data Domain Global
Deduplication Administration Guide.
The cluster command includes the following options.
add Add controllers to a Global Deduplication Page106
Array.
alerts Show active alerts in the Global Page106
Deduplication Array.
create Create a new Global Deduplication Array Page107
(master controller only).
destroy Destroy filesystem on all controllers and Page107
separate all controllers from the Global
Deduplication Array.
run Execute CLI commands locally on specific Page108
controllers, as opposed to running them for
the Global Deduplication Array.
show config Display Global Deduplication Array Page109
membership information.
status Show the status of the file system and the Page109
network connectivity of Global
Deduplication Array controllers.

DD OS 4.9 Command Reference Guide 105


About the cluster Commands
Only two of the cluster commands are allowed on the worker
controller: cluster destroy and cluster show config.
Except for cluster status and cluster show config, the
cluster commands are for administrative use only.

cluster Command Options

add
cluster add node-name [license license-code]
After creating a Global Deduplication Array, enter this
administrative command from the master controller to add the
second controller to the Global Deduplication Array. The file
system must be disabled on the master controller. The second
controller must be identical to the master controller in terms of DD
OS software, storage capacity, and hardware model. The second
controller must have a pristine file system. To add the first
controller, use the cluster create command.
All of the controllers added to the Global Deduplication Array
must have a Global-Deduplication license.

alerts
cluster alerts show
Use this administrative command to show active alerts in the
Global Deduplication Array.
Each controller reports its alert status, even if there are no active
alerts. If there is an alert for a controller, the alert time and a
description of the problem are given.
An example summary of the number of alerts for each controller
follows:
Alerts from node dd880-1.company.com (Serial No:
8DDXXXXXXX)

106 cluster
An example from a two-controller Global Deduplication Array
follows:
sysadmin@dd690-43(Master:1)# cluster alerts show
Alerts from node "dd690-43.datadomain.com" (Serial No:
8DD6927005)
No active alerts.
Alerts from node "dd690-44.datadomain.com" (Serial No:
8DD6927006)
Alert Id Alert Time Description
-------- ---------------- -------------------------
4 Thu Sep 24 11:13 Encl 2 (50050CC100100D33) Disk 15 has
failed and should be replaced
-------- ---------------- -------------------------
There is 1 active alert.

create
cluster create cluster-name
Use this administrative command to create a new Global
Deduplication Array. The name you assign is the name by which
the Global Deduplication Array is identified within the CLI and
Data Domain Enterprise Manager. This command must be
executed on the master controller. The file system must be in a
pristine state.

destroy
cluster destroy cluster-name
Use this administrative command to destroy the filesystem on all
of the arrays controllers and to separate the controllers from the
Global Deduplication Array. All of the controllers are converted to
single-controller functionality.
This command must be executed on the master controller. This
command reboots all of the controllers in the Global Deduplication
Array.

DD OS 4.9 Command Reference Guide 107


run
cluster run [host [host-list | all | worker ] cmd command
Administrators can use this command to execute CLI commands
for specific controllers locally. Global commands work for the
entire array.
command is the one of the local commands that you want to run
on one or more of the arrays controllers.
host-list is the list of hosts, represented by IP addresses or
host names. Items are separated by commas.
Below is an example of the output for the command net show
hardware:
# cluster run host all cmd net show hardware
Command output from host dd690-43.datadomain.com:
Data Domain OS 4.9.0.0-130539
Port Speed Duplex Supp Speeds Hardware Address Physical Link
Status
---- -------- ------ ----------- ----------------- -------- ---
eth0 1000Mb/s full 10/100/1000 00:15:17:65:9a:a8 Copper yes
eth1 1000Mb/s full 10/100/1000 00:15:17:65:9a:a9 Copper yes
[...]
---- -------- ------ ----------- ----------------- -------- ---
Command output from host dd690-44.datadomain.com:
Data Domain OS 4.9.0.0-130539
Port Speed Duplex Supp Speeds Hardware Address Physical Link
Status
---- -------- ------ ----------- ----------------- -------- ---
eth0 1000Mb/s full 10/100/1000 00:15:17:65:c5:cc Copper yes
eth1 1000Mb/s full 10/100/1000 00:15:17:65:c5:cd Copper yes
[...]
---- -------- ------ ----------- ----------------- -------- ---

108 cluster
show config
cluster show config
All users can run this command on any controller of the Global
Deduplication Array to display array membership information.
The following information is shown for each controller in the
Global Deduplication Array:
Name: for example, dd880-1.company.com
Serial Number
Role: Master or Worker
Management Interface: the IP address of the management
interface for the controller.
Data Interface: the IP address of the data interface.
Replication Interface: the IP address of the replication interface.
Global Deduplication Array Interface: the IP address of the
Global Deduplication Array interconnect between the arrays
controllers.
Number: the number assigned to the controller; for example, 1,
2.

status
cluster status [node node-name | all]
All users can run this command to show the status for a specific
controller or for all controllers in the Global Deduplication Array.
You can run this command on the master controller only.
If you enter cluster status without any options, a summary of
the arrays status is displayed for each controller. This summary
provides the following information:
Filesystem status, such as:
The filesystem is enabled and running.
Name: For example, dd880-1.company.com
Role: Master or Worker

DD OS 4.9 Command Reference Guide 109


Interface Status, such as:
Master: 3 up, 3 down
Worker: 3 up, 3 down
Filesystem Status, such as:
Filesystem up and running (Up)
Filesystem has encountered a problem (Down)
Alerts: the number of alerts for each controller
If you enter the cluster status command for a specified
controller, only that controllers status is displayed. To show the
status of each controller in the Global Deduplication Array
separately, enter:
# cluster status all

110 cluster
9 config

Use the config command to manage the Data Domain system


configuration settings. The config command has the following
options:
reset Reset configuration settings. Page112
set Configure configuration settings. Page113
setup Change multiple configuration settings. Page115
show Display current configuration. Page116

About the config Command


The config setup command brings up the same prompts as the
initial system configuration. You can change any of the
configuration parameters. All of the config operations, with the
exception of show, are available only to administrative users.
Note: You can also use other Data Domain system commands to
change individual configuration settings. An example of an
individual command that sets only one of the configuration
possibilities is nfs add to add NFS clients.

DD OS 4.9 Command Reference Guide 111


config Command Options

reset
reset location
config reset location
Use this command to reset the location description to the system
default of a null entry. This command is available to
administrative users only

reset mailserver
config reset mailserver
Use this command to reset the mail server used by the Data
Domain system to the system default of a mail. This command is
available to administrative users only.

reset timezone
config reset timezone
Use this command to reset the time zone used by the Data Domain
system to the system default of US/Pacific. This command is
available to administrative users only.

112 config
set
set admin-email
config set admin-email email-addr
Use this command to give the required address for alerts and
autosupport emails to other recipients. The system needs only one
administrative email address. Use the autosupport and alerts
commands to add other email addresses. This command is
available to administrative users only.
For example, use the command:
# config set admin-email jsmith@company.com
The Admin Email is: jsmith@company.com
To check the current setting, use the config show admin-email
command.

set admin-host
config set admin-host host
Use this command to set the machine from which you can log into
the Data Domain system to see system logs and use system
commands. The host name can be a simple host name, a host name
with a fully-qualified domain name, or an IP address. The host is
also added to the FTP and Telnet lists and (if the features are
licensed) to the CIFS and NFS lists for access to /ddvar and
/backup. This command provides a quick way to add
authentication privileges. This command is available to
administrative users only.
For example, to set the administrative host to
admin12.yourcompany.com, use:
# config set admin-host admin12.yourcompany.com
The System Admin host is admin12.yourcompany.com
To check the current setting, use the config show admin-host
command.

DD OS 4.9 Command Reference Guide 113


set location
config set location "location"
Use this command to 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. This command is available to
administrative users only.
For example, to set the location description to row2-num4-
room221, use :
# config set location "row2-num4-room221"
The system location is row2-num4-room221
To check the current setting, use the config show location
command.

set mailserver
config set mailserver host
Use this command to change the SMTP mail server used by the
Data Domain system. This command is available to administrative
users only.
For example, to set the mail server to mail.yourcompany.com,
use:
# config set mailserver mail.yourcompany.com
The Mail (SMTP) server is: mail.yourcompany.com
To check the current setting, use the config show mailserver
command.

114 config
set timezone
config set timezone zonename
Use this command to set the system clock to a specific time zone.
The default setting is US/Pacific. For the change to take effect for
all currently running processes, you must reboot the Data Domain
system. This command is available to administrative users only.
For example, to set the system clock to the time zone that includes
Los Angeles, California, USA, use:
# config set timezone Los_Angeles
To display time zones, enter a category or a partial zone name. The
categories are Africa, America, Asia, Atlantic, Australia,
Brazil, Canada, Chile, Europe, Indian, Mexico, Mideast,
Pacific, and US. The following examples show the use of a
category and the use of a partial zone name:
# config set timezone us
Ambiguous timezone name; matching...
US/Alaska US/Aleutian US/Arizona US/Central
US/Eastern US/East-Indiana US/Hawaii US/Indiana-Starke
US/Michigan US/Mountain US/Pacific US/Samoa

# config set timezone new


Ambiguous timezone name; matching ...
America/New_York Canada/Newfoundland

setup
config setup
Use this command to change multiple essential configuration
settings. The command displays the current value for each setting.
Press the Enter key to retain the current value for a setting. This
command is available to administrative users only.
Many other Data Domain system commands change configuration
settings. For example, the user command adds another user
account each time a user is added.

DD OS 4.9 Command Reference Guide 115


show
show admin-email
config show admin-email
Use this command to display the administrative email address that
the Data Domain system uses for email from the alerts and
autosupport commands.

The display is similar to the following:


# config show admin-email
The Admin Email is: rjones@yourcompany.com

show admin-host
config show admin-host
Use this command to display the administrative host from which
you can log into the Data Domain system to see system logs and
use system commands.
The display is similar to the following:
# config show admin-host
The Admin Host is: admin12.yourcompany.com

show all
config show all
Display all config command settings

show location
config show location
Use this command to display the Data Domain system location
description, if you gave one.
The display is similar to the following:
# config show location
The System Location is: bldg12 rm 120 rack8

116 config
show mailserver
config show mailserver
Use this command to display the name of the mail server that the
Data Domain system uses to send email.
The display is similar to the following:
# config show mailserver
The Mail (SMTP) server is: mail.yourcompany.com

show timezone
config show timezone
Use this command to display the time zone used by the system
clock.
The display is similar to the following:
# config show timezone
The Timezone name is: US/Pacific

config Examples

Configuring config
Set the Timezone
To set the time zone for the Pacific coast of the U.S.A., use:
# config set timezone Los_Angeles
To find all time zones that include a match for new, use:
# config set timezone new
Ambiguous timezone name; matching ...
America/New_York Canada/Newfoundland

DD OS 4.9 Command Reference Guide 117


118 config
10 disk

Use the disk command to manage and display disk information


The disk command has the following options:
add Add a disk, disk enclosure, or spindle- Page120
group.
beacon Flash a disk ID LED. Page122
expand Expand Data Domain system storage Page122
capacity.
fail Fail a disk and force reconstruction. Page123
multipath Manage and display multipath Page123
information.
port Show disk port information. Page126
rescan Rescan all disks to look for newly Page127
removed or inserted disks or LUNs.
reset Clear the disk performance statistics. Page127
set Assign a LUN group to the disk. Page127
show Display disk information. Page128
status Display the disk status. Page133
unfail Unfail a disk and spare it. Page135

About the disk Command


The Data Domain system disk command manages disks and
displays disk locations, logical (RAID) layout, usage, and
reliability statistics. Command output examples in this chapter
show systems with 15 disk drives. Each Data Domain system
model reports on the number of disks actually in the system. On a
Data Domain system that has one or more Data Domain external
disk shelves, commands also include entries for all enclosures,
DD OS 4.9 Command Reference Guide 119
disks, and RAID groups. See the Data Domain Expansion Shelf
Hardware Guide for details about disks in external shelves.
A Data Domain system has 3, 4, 7, 8, 9, 12, or 15 disks, depending
on the model. Each disk has two LEDs. A green or blue LED
indicates disk activity, and an amber or red LED indicates a failure
or attention condition.
Each disk in an external shelf has two LEDs at the right edge of the
disk carrier. The top LED is green and flashes when the disk is
accessed or when the disk is the target of a beacon operation. The
bottom LED is amber and glows steadily when the disk has failed.
The disk-identifying variable used in disk commands (except
gateway-specific commands) is in the format enclosure-id.disk-id.
An enclosure is a Data Domain system or an external disk shelf. A
Data Domain system is always enclosure 1 (one). For example, disk
12 in a Data Domain system is labeled as 1.12. Disk 12 in the first
external shelf is labeled as 2.12.

disk Command Options

add
add dev
disk add devdisk_id spindle-group 1-16
Use this command to add a new LUN to the current volume,
optionally assigning it to the specified spindle-group. To get the
devid#, use the disk rescan command and then use the disk
show raid-info command. The devid# format is the word dev
and the number as seen in output from the disk show raid-info
command.
If the keyword spindle-group is specified, the LUN disk-id is
assigned to the given spindle-group. The designated spindle-
group must be within the range of 1 through 16. Spindle-group 1 is
the default spindle-group. By default, the device is assigned to the
default spindle-group (1).
For example, to add a LUN with a devid# of 2 as shown by the
disk show raid-info command, use:
120 disk
# disk add dev2
To add a new LUN and assign it to a spindle-group, use:
# disk add dev2 spindle-group 7
The 'disk add' command adds a disk to the
filesystem. Once the disk is added, it cannot be
removed from the filesystem without re-installing
the restorer or destroying the filesystem.
Are you sure? (yes|no|?) [no]: yes
ok, proceeding.
Please enter sysadmin password to confirm 'disk
add':
This command may take several minutes to complete;
please wait.
disk add device............. [ - ]
disk add device............. [success]
This device has created a new spindle-group 7. When
creating new spindle-groups, the filesystem should
be re-started to load-balance correctly
Notes:
The disk add command adds a disk to the filesystem.
Once the disk is added, it cannot be removed from the
filesystem without destroying the filesystem.
Also, when creating new spindle-groups, the filesystem
should be re-started to load-balance correctly.

add enclosure
disk add enclosure enclosure-id
Use this command to add a Data Domain expansion shelf disk
storage unit. The enclosure-id is always 2 for the first added
shelf, 3 for the second, and so forth all the way up to 7 for the sixth
added shelf. The Data Domain system always has the enclosure-
id number of 1 (one).

To remove an enclosure, destroy the filesystem.

DD OS 4.9 Command Reference Guide 121


beacon
disk beacon enclosure-id.disk-id
Use this command to cause the LED on the right (that signals
normal operation) on the target disk to flash. Press Ctrl+c to turn
off the command. (To check all disks in an enclosure, use the
enclosure beacon command.) This command is available to
administrative users only.
For example, to flash the LED for disk3 in a Data Domain system,
use:
# disk beacon 1.3

expand
disk expand
Use this command to expand disk usage from eight disks plus one
spare to 14 disks plus one spare for the DD510 and DD530, or six
disks plus one to 11 disks plus one spare for the later Data Domain
systems.
Expansion can occur only when the first nine disks are not in a
degraded state, and there is at least one spare disk. (To verify this,
enter the disk status command. In the output, the in use line
must show at least eight disks as in use, and the spare line must
show at least one disk as spare.)

122 disk
fail
disk fail enclosure-id.disk-id
Use this command to set a disk to the failed state. The command
asks for a confirmation before carrying out the operation. This
command is available to administrative users only.
A failed disk is automatically removed from a RAID disk group
and is replaced by a spare disk (when a spare is available). The
disk use changes from spare to in use and the status becomes
reconstructing. See show detailed-raid-info to list the available
spares.
Up to two disks in the head unit can be failed at the same time in
most Data Domain systems, with the exception of the DD120 and
DD140, which have only three disks (and no spare) so only one
disk can be failed.
Always replace a failed disk as soon as possible. Spare disks are
supplied in a carrier for a Data Domain system or a carrier for an
expansion shelf. DO NOT move a disk from one carrier to another.

multipath
multipath failback
disk multipath failback
Use this command to manually force all disks to use the primary
path. This command works on gateway models only. This
command is available to administrative users only.

multipath option set auto-failback


disk multipath option set auto-failback {enabled | disabled}
Use this command to enable or disable auto-failback policy.
Enabling auto-failback means the primary path is used whenever
it is available. Disabling auto-failback means the user has to
manually failback to the primary path when it becomes available
again. This command works on gateway models only. This
command is available to administrative users only.

DD OS 4.9 Command Reference Guide 123


multipath option set monitor
disk multipath option set monitor {enabled | disabled}
Use this command to enable multipath configuration monitoring.
When multipath configuration monitoring is enabled, failures in
paths to disk devices trigger alerts and log multipath events. If
monitoring is disabled, logging of multipath events is not done,
which means disk multipath show history is not updated.
Multipath configuration monitoring is disabled by default. This
command is available to administrative users only.

multipath option reset auto-failback


disk multipath option reset auto-failback
Use this command to switch over to the primary path once it
becomes available, even if the secondary path is still usable. The
auto-failback option is enabled by default. The auto-failback
option is supported on gateway systems only. This command is
available to administrative users only.

multipath option reset monitor


disk multipath option reset monitor
Use this command to disable multipath configuration monitoring.
When multipath configuration monitoring is disabled, failures in
paths to disk devices do not trigger alerts. Multipath configuration
monitoring is disabled by default. This command is available to
administrative users only.

multipath option show


disk multipath option show
Use this command to show whether multipath configuration
monitoring and auto-failback are disabled or enabled. The auto-
failback option is supported on gateway systems only.

124 disk
multipath reset stats
disk multipath reset stats
Use this command to clear the statistics of all paths to all disks in
all expansion shelves. This command is available to administrative
users only.

multipath resume
disk multipath resume port port-id
Use this command to allow I/O on specified initiator port. This
command is available to administrative users only.

multipath show history


disk multipath show history
Use this command to show the history of multipath events.

multipath show stats


disk multipath show stats [enclosure enc-id]
Use this command to show statistics for all paths of all disks by
default, or optionally, for the specified enclosure only.

multipath status
disk multipath status [port-id]
Use this command to show multipath configurations and run time
status.

multipath suspend
disk multipath suspend port port-id
Use this command to disallow I/O on specified initiator port, and
to stop traffic on particular ports during scheduled maintenance of
the SAN or storage array, and so forth. This command does not
drop the FC link. This command is available to administrative
users only.

DD OS 4.9 Command Reference Guide 125


port
port enable
disk port enable port_id
Use this command to enable the specified initiator port. This
command is available to administrative users only.

port show stats


disk port show stats
Use this command to show disk port information. For each port,
the following information is shown:
Port number
Command aborts
Target resets
Bus resets
Host resets
Device additions
Device removals

port show summary


disk port show summary
Use this command to show disk port information. For each port,
the following information is shown:
Port number
Connection type
Link speed
Connected enclosure IDs
Status
Online

126 disk
Offline
Disabled
When a port is listed as disabled, the following message
appears:
Contact your contracted support provider or
visit us online at https://my.datadomain.com

rescan
disk rescan
Use this command to check for new internal or external storage of
all types. This command is available to administrative users only.

reset
disk reset performance
Use this command to reset disk performance statistics to zero. See
show detailed-raid-info for displaying disk statistics. This command
is available to administrative users only.

set
set spindle-group
disk set devdisk_id spindle-group 1-16
Use this command to assign a LUN group to the disk. This
command is available to administrative users only. For example:
# disk set dev1 spindle-group 8
The 'disk set' command assigns a lun-group to the
disk/lun. Are you sure? (yes|no|?) [no]: yes
ok, proceeding.
Please enter sysadmin password to confirm 'disk
set':
This command may take several minutes to complete;
please wait.
Disk dev1 has been added to spindle-group 8. The
result will be effective after the filesystem is
restarted.

DD OS 4.9 Command Reference Guide 127


show
show hardware
disk show hardware
Use this command to display the disks on a Data Domain system.
The display of disk information for a Data Domain system has the
columns:
Disk (enc/disk) The enclosure and disk numbers.
Manufacturer/ The manufacturers model designation.
Model
Firmware The firmware revision on each disk.
Serial No. The manufacturers 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.

The display for a Data Domain system has the columns:


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/ A label that identifies the manufacturer. The
Model 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.

128 disk
Capacity The amount of data in a volume sent to the Data
Domain system.
Spindle-Group The spindle-group for this LUN. (Present for
gateway systems only.)

The display for disks in a Data Domain system is similar to the


following:
# disk show hardware
Disk Manufacturer/Model Firmware Serial No. Capacity
(enc/disk)
---------- ----------------------- -------- -------------- ----------
1.1 Hitachi HDP725025GLA380 GM2OA52A GEL230RB0DMU8B 232.88 GiB
1.2 Hitachi HDP725025GLA380 GM2OA52A GEL230RB0DRTSB 232.88 GiB
1.3 Hitachi HDP725025GLA380 GM2OA52A GEL230RB0DTH8B 232.88 GiB
---------- ----------------------- -------- -------------- ----------
3 drives present.

Note: GiB = Gibibytes, the base-2 equivalent of Gigabytes.

show detailed-raid-info
disk show detailed-raid-info
Use this command to display RAID disk groups and disk status
within each group. On a gateway system, the display does not
include information about individual disks.
The short example below does not include a spare disk. RAID
groups usually have a spare disk.

DD OS 4.9 Command Reference Guide 129


# disk show detailed-raid-info
Disk Group (dg0)
Raid Group (ext3):(raid-0)(33.03 GiB)
Raid Group (ext3_1):(raid-5)(33.03 GiB) - Status: normal - double redundant protection
Disk State Additional Status
---- ------------ -----------------
1.1 in use (dg0)
1.2 in use (dg0)
1.3 in use (dg0)
---- ------------ -----------------
Raid Group (ppart):(raid-6)(412.92 GiB) - Status: normal - double redundant protection

Disk State Additional Status

---- ------------ -----------------


1.1 in use (dg0)
1.2 in use (dg0)
1.3 in use (dg0)
1.4 in use (dg0)
1.5 in use (dg0)
1.6 in use (dg0)
1.7 in use (dg0)
1.8 in use (dg0)
---- ------------ -----------------
Spare Disks

Disk Status

---- ------------ -----------------


1.9 Spare
Unused Disks
1 disk group present

Note: MiB = Mebibytes, the base-2 equivalent of Megabytes.


TiB = Tebibytes, the base-2 equivalent of Terabytes.

show failure-history
disk show failure-history
Use this command to display a list of serial numbers for all disks
that have ever been failed in the Data Domain system. Use the
disk show hardware command to display the serial numbers of
current disks.

130 disk
show performance
disk show performance
Use this command to display disk performance statistics for each
disk. Each column displays statistics averaged over time since the
last disk reset performance command or since the last system
power cycle. See reset for reset details.
Command output from a gateway Data Domain system lists each
LUN accessed by the Data Domain system as a disk.
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.
Busy The average percent of time that each disk has at
least one command queued.

The display is similar to the following:


# disk show performance
Disk Read Write Cumul. Busy
(enc/disk) sects/s sects/s MiBytes/s
---------- ------- ------- --------- ----
1.1 56 20 0.037 0 %
1.2 57 20 0.037 0 %
1.3 57 20 0.037 0 %
---------- ------- ------- --------- ----
Cumulative 0.111 MiB/s, 0 % busy

Note: MiBytes = MiB = Mebibytes, the base-2 equivalent of


Megabytes.

DD OS 4.9 Command Reference Guide 131


show raid-info
disk show raid-info
Use this command to display the RAID status and use of disks,
which disks have failed from a RAID point of view, spare disks
available for RAID, and the progress of a disk group
reconstruction operation.
When a spare disk is available, the Data Domain system file system
automatically replaces a failed disk with a spare and begins the
reconstruction process to integrate the spare into the RAID disk
group. The disk use changes from spare to in use and the status
becomes reconstructing.
For a gateway Data Domain system, disks and LUNs that the
system does not access show the State of unknown.
Reconstruction is done on one disk at a time. If more than one disk
is to be reconstructed, the disks waiting for reconstruction show as
spare or hot spare until reconstruction starts on the disk. During
reconstruction, the output line x drives are undergoing
reconstruction includes a percentage of reconstruction that is
completed. The percentage is the average amount completed for all
disks that are currently undergoing reconstruction.
The display for disks in a Data Domain system is similar to the
following:
# disk show raid-info
Disk State Additional Status
---- ------------ -----------------
1.1 in use (dg0)
1.2 in use (dg0)
1.3 in use (dg0)
---- ------------ -----------------
3 drives are operational
3 drives are "in use"
1 disk group total
1 disk group present

132 disk
show reliability-data
disk show reliability-data
Disk reliability information details the hardware state of each disk.
The information is generally for the use of Data Domain support
staff when troubleshooting.
Disk The enclosure.disk-id disk identifier.
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 centigrade to 55
centigrade.

The display is similar to the following:


# disk show reliability-data
Disk ATA Bus Reallocated Temperature
(enc/disk) CRC Err Sectors
---------- ------- ----------- -----------
1.1 0 0 25 C 77 F
1.2 0 0 23 C 73 F
1.3 0 0 23 C 73 F
---------- ------- ----------- -----------
3 drives operating normally.

status
disk status
Use this command to report the overall status of disks in the
system. It displays the number of disks in use and failed, the
number of spare disks available, and whether or not 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 as operating nominally. A disk can be
physically functional and available, but not currently in use by
RAID, possibly because of operator intervention.
On a gateway Data Domain system, the display shows only the
number and state of the LUNs accessed by the Data Domain
DD OS 4.9 Command Reference Guide 133
system. The remainder of the display is not valid for a gateway
system.
Reconstruction is done on one disk at a time. If more than one disk
is to be reconstructed, the disks waiting for reconstruction show as
spare or hot spare until reconstruction starts on the disk.

Note: The disks in a new expansion shelf recognized with the


disk rescan command show a status of unknown. Use the disk
add enclosure command to change the status to in use.

The output of the disk status command is as follows:


# disk status
Normal - system operational

1 disk group total


3 drives are operational
3 drives are "in use"
1 disk group total
1 disk group present

The first line can start with Normal, Error, or Warning.


Normal A brand-new Data Domain system is normal if
there is no configured storage attached, the
commands disk add or disk add
enclosure have never been used on the system,
and all disks outside of the Data Domain system
are not in any of the following states: in use,
foreign, or known.
Error A brand-new head unit is in this state when
foreign storage is present. For a system that has
been 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:
RAID system degraded
Foreign storage present
Some of the disks are failed or absent

134 disk
unfail
disk unfail enclosure-id.disk-id
Use this command to change a disk status from failed to
available. Use the command when replacing a failed disk. The
new disk in the failed slot is seen as failed until the disk is
unfailed. This command is available to administrative users only.
Caution: Use of this command repartitions the disk. Any data
residing on the disk will be difficult, if not impossible to retrieve.

disk Examples

Add an Expansion Shelf


The following high-level procedure gives the general steps needed
to add an external shelf. See the DD OS 4.9 Administration Guide for
the detailed procedure.
Refer to the Data Domain Expansion Shelf Hardware Guide for
instructions on installing hardware components to support
external shelves to the Data Domain system model. The guide also
provides directions for cabling the external shelves to the Data
Domain system.
The Data Domain system auto-discovers an expansion shelf within
a few minutes. Use the show summary command as well as the
show raid-info command to confirm that auto-discovery is
successful.
On the Data Domain system, enter the following command with
an enclosure-id of 2 for the first shelf and 3 for a second shelf:
disk add enclosure 2
The Data Domain system file system automatically expands when
the disk add enclosure command is entered. Adding the
enclosure is not reversible. An enclosure cannot be permanently
removed after the disk add enclosure command has been used
without losing the use of the file system. Contact Data Domain
Technical Support to permanently remove an enclosure.

DD OS 4.9 Command Reference Guide 135


Important Notices
On gateway Data Domain systems (that use third-party physical
storage disk arrays other than Data Domain external disk shelves),
the following command options are not valid:
disk beacon
disk expand
disk fail
disk unfail
disk show failure-history
disk show reliability-data
With gateway storage, output from all other disk commands
returns information about the LUNs and volumes accessed by the
Data Domain system.

136 disk
11 enclosure

Use the enclosure command to manage Data Domain expansion


shelves. The enclosure command has the following options:
beacon Flash all disk LEDs in an enclosure Page138
show Display enclosure information Page138
test Test the connections Page144

About the enclosure Command


Use the enclosure command to identify and display information about
expansion shelves.
An enclosure is a Data Domain system or an attached expansion
shelf. Enclosure commands do not include adding a shelf. Use the
disk add enclosure command to add a shelf.

If a Data Domain system, previously installed shelf, or both need


spare disks and have none available, disks from a newly installed
shelf are allocated to the previously existing RAID groups (disk
groups) as soon as the new shelf is recognized with the disk
rescan command. If the disk add enclosure command fails for
a new shelf, check that the shelf has at least 14 disks available for
its own RAID group.

DD OS 4.9 Command Reference Guide 137


enclosure Command Options

beacon
enclosure beacon enclosure-id
Use this command to check that the DD OS and hardware
recognize an enclosure. The command causes the green (activity)
LED on each disk in an enclosure to flash green. Press Ctrl+c to
halt the command. This command is available to administrative
users only.

show
show all
enclosure show all [enclosure-id]
Use this command to display the temperatures and the status of
fans and power supplies.
Note: The status of individual power supplies is displayed with
the exception of 4xx models (including 560), which are shown in
aggregated status. For an enclosure connected to a 560, you will
see an individual report.

show controllers
enclosure show controllers [enclosure-id]
Use this command to display information and status for the ES20
enclosure and the shelf controller systems or a specific controller
system.
# enclosure show controllers
Enclosure 1
Model ES20
Capacity 16 Slots
WWN 50050CC1001010B1
Serial # 50050CC1001010B1
Number of Controllers 2

Controller A
WWN 50050CC1010203CF
138 enclosure
Firmware 0605
Serial # IMS5846010203CF
Status OK
HOST port 12.0 Gbps
EXP'N port 12.0 Gbps
Controller B
WWN 50050CC1010371CF
Firmware 0605 R02
Serial # IMS5846010371CF
Status OK
HOST port 12.0 Gbps
EXP'N port 0.0 Gbps

The first block of information in the output describes the physical


ES20 enclosure shell:

Enclosure The number listed here is the enclosure number


assigned by DDOS. This number is the argument
that is passed to the command.
Model The product name of the enclosure. In this example,
the enclosure is an ES20.
Capacity The number of usable drive slots in the enclosure.
WWN The World Wide Name of the physical ES20
enclosure. This identifier describes the enclosure
itself and will not change when components within
the enclosure are swapped. This number matches the
label located on the enclosure OPS Panel.
Serial # The serial number of the physical ES20 enclosure. As
with the WWN, this describes the enclosure and will
not change if components are swapped. Depending
on when the ES20 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 The number of shelf controllers currently inserted in
Controllers the ES20 enclosure.

DD OS 4.9 Command Reference Guide 139


Following the enclosure information are one or two blocks that
describe the inserted shelf controller modules:

Controller A This identifies which shelf controller module the


block of information is for. If this enclosure has both
shelf controllers installed, there is a block for both
Controller A and Controller B.
WWN The World Wide Name for this shelf controller. The
WWN is different for each controller and is different
than the WWN for the enclosure.
Firmware The firmware revision level for the firmware that
resides on this shelf controller. This can be different
for each shelf controller. In the above example
Controller A and B have different versions.
Serial # The serial number or this shelf controller. The serial
number is different for each shelf controller and is
different from the Serial # for the enclosure.
Status The current status for this shelf controller.
HOST port The speed of the link on the HOST port of this shelf
controller. A controller connects to the DDR or the
shelf controller of the previous ES20 through the
HOST port.
EXP'N port The speed of the link on the EXP'N port of this shelf
controller. A controller connects to the shelf
controller of the next ES20 in the chain through the
EXP'N port.

show fans
enclosure show fans [enclosure-id]
Use this command to display the current status of fans in all
enclosures or in a specific enclosure.
To show the status of all fans for a system:
# enclosure show fans
Enclosure 1
Fans
Description Level Status
-------------- ------ ------

140 enclosure
Cooling fan #1 medium OK
Cooling fan #2 medium OK
-------------- ------ ------

Enclosure The enclosure number, starting with 1 (one) for the


Data Domain system.
Description The fan description for each power or cooling unit.
Level The fan speed, which depends on the internal
temperature and amount of cooling needed.
Status The fan status, either OK or Failed.

show powersupply
enclosure show powersupply [enclosure-id]
Use this command to display the status USAF power supplies in
all enclosures or in a specific enclosure.
Note: The status of individual power supplies is displayed with
the exception of 4xx models (including 560), which are shown in
aggregated status. For an enclosure connected to a 560, you will
see an individual report.
This report for shows the status of individual power supplies:
# enclosure show powersupply
Enclosure Description Status
--------- --------------- ------
1 Power Module #1 OK
1 Power Module #2 OK
2 Power Module #1 OK
2 Power Module #2 OK
--------- --------------- ------

This report for shows the aggregated status of all power supplies:
# enclosure show powersupply
Power Supply
Status
------
OK
------

DD OS 4.9 Command Reference Guide 141


The status can be:
OK The power supply is operating normally.
Degraded The power supply is either manifesting a fault or not
installed.
Unavailable The system is unable to determine the status of the
power supply.

show summary
enclosure show summary
Use this command to list known enclosures, model numbers, serial
numbers, 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 (world-
wide name) and the OPS panel WWN.
# enclosure show summary
Enclosure Model No. Serial No. Capacity
--------- --------- ---------- --------
1 DD560 8F41214030 15 Slots
2 ES20 50050CC100123456 16 slots
2 ES20 50050CC100123457 16 slots
--------- --------- ---------------- --------
3 enclosures present.

show temperature-sensors
enclosure show temperature-sensors [enclosure-id]
Use this command to 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 0 (zero) as CPU
temperature increases; if a CPU temperature reaches 0 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 that the temperature is above the shutdown threshold.

142 enclosure
In the following example, the temperature for CPU 0 is 97
Fahrenheit below the maximum:
# enclosure show temperature-sensors
Enclosure Description C/F Status
--------- --------------- ------- ------
1 CPU 0 Relative -54/-97 OK
Chassis Ambient 23/73 OK
--------- --------------- ------- ------

show topology
enclosure show topology
Use this command to show the layout of the SAS enclosures
attached to a system.
The output of the command looks like the following sample:
# enclosure show topology

Port enc.ctrl.port enc.ctrl.port enc.ctrl.port


---- - ------------- - ------------- - -------------
3a > 2.A.H:2.A.E > 3.A.H:3.A.E > 4.A.H:4.A.E
3b > 7.B.H:7.B.E > 6.B.H:6.B.E > 5.B.H:5.B.E
4a > 5.A.H:5.A.E > 6.A.H:6.A.E > 7.A.H:7.A.E
4b > 4.B.H:4.B.E > 3.B.H:3.B.E > 2.B.H:2.B.E
---- - ------------- - ------------- - -------------

Encl WWN Serial #


---- ---------------- ----------------
2 50050CC1001019AA 50050CC1001019AA
3 50050CC10010194D 50050CC10010194D
4 50050CC100100FD1 50050CC100100FD1
5 50050CC100101A80 50050CC100101A80
6 50050CC1001019E6 50050CC1001019E6
7 50050CC100101933 50050CC100101933
---- ---------------- ----------------

Error Message:
-----------------
No error detected

DD OS 4.9 Command Reference Guide 143


test
test topology
enclosure test topology port duration minutes
Test the connections in the enclosure topology. This command is
available to administrative users only.

144 enclosure
enclosure Examples

Display the Enclosure Temperature


The following is an example of the temperature-sensors display.
The CPU relative values show that CPU 0 is 97 Fahrenheit below
the maximum allowable temperature.
# enclosure show temperature-sensors
Enclosure Description C/F Status
--------- ---------------- -------- ------
1 CPU 0 Relative -54/-97 OK
CPU 1 Relative -57/-103 OK
Chassis Ambient 32/90 OK
2 Internal ambient 33/91 OK
3 Internal ambient 31/88 OK
--------- ---------------- -------- ------

DD OS 4.9 Command Reference Guide 145


146 enclosure
12 filesys

Use the filesys command to manage and display disk


information The filesys command has the following options:
clean Manage and show file system Page148
cleaning.
destroy Reinitialize the file system, Page153
destroying all data.
disable Disable file system operations. Page154
enable Enable file system operations. Page154
encryption Encrypt and decrypt files system Page155
data.
fastcopy Fastcopy from source to destination. Page158
option Manage and show file system Page159
options.
restart Restart the file system. Page163
retention-lock Manage the retention-lock feature. Page164
show Display file system information. Page168
status Show whether or not the file system Page171
is running.
sync Sync all modified files to disk. Page171

DD OS 4.9 Command Reference Guide 147


About the filesys Command
The filesys command allows you to display statistics, capacity,
status, and utilization of the Data Domain system file system. The
command also allows you to clear the statistics file and to start and
stop the file system processes. The clean operation of the filesys
command reclaims physical storage within the Data Domain
system file system.
Note: All Data Domain system commands that display the use of
disk space or the amount of data on disks compute and display
amounts using base-2 calculations. For example, a command that
displays 1 GiB of disk space as used is reporting a value of
230 bytes = 1,073,741,824 bytes.
1 KiB = 210 bytes = 1024 bytes.
1 MiB = 220 bytes = 1,048,576 bytes
1 GiB = 230 bytes = 1,073,741,824 bytes
1 TiB = 240 bytes = 1,099,511,627,776 bytes

filesys Command Options

clean
The filesys clean command reclaims physical storage occupied
by deleted objects in the Data Domain file system. Only a filesys
clean command reclaims the physical storage used by files that
are deleted and that are not present in a snapshot.
During the clean operation, the Data Domain file system is
available for backup (write) and restore (read) operations.
Although cleaning uses a noticeable amount of system
resources, cleaning is self-throttling and gives up system
resources in the presence of user traffic.
Data Domain recommends running a clean operation after the
first full backup to a Data Domain system. The initial local
compression on a full backup is generally a factor of 1.5 to 2.5.
An immediate clean operation gives additional compression
by another factor of 1.15 to 1.2 and reclaims a corresponding
amount of disk space.
148 filesys
When the clean operation finishes, it sends a message to the
system log giving the percentage of storage space that was
cleaned.
A default schedule runs the clean operation every Tuesday at 6
a.m. (tue 0600). You can change the schedule or you can run the
operation manually with the filesys clean commands. Data
Domain recommends running the clean operation once a week. If
you want to increase file system availability and if the Data
Domain system is not short on disk space, consider changing the
schedule to clean less often.
Notes:
Any operation that shuts down the Data Domain system file
system, such as the filesys disable command, or that shuts
down the Data Domain system, such as a system power-off or
reboot, stops the clean operation. The clean does not restart
when the system and file system restart. Either manually
restart the clean or wait until the next scheduled clean
operation.
Replication between Data Domain systems can affect filesys
clean operations. If a source Data Domain system receives
large amounts of new or changed data while replication is
disabled or disconnected, resuming replication may
significantly slow down filesys clean operations.
When there is a large replication lag, cleaning is not efficient
and does not clean up much space, because what has not been
replicated is not cleaned.

clean reset
filesys clean reset {schedule | throttle | all}
Use this command to set the clean schedule to the default of
Tuesday at 6 a.m. (tue 0600), the default throttle of 50%, or both.
The operation is available only to administrative users.

DD OS 4.9 Command Reference Guide 149


clean set schedule
filesys clean set schedule {daily time} | (monthly day-num-
1[,day-num-2,...] time} | never} | {day-num-1[,day-num-2,...]
time}
Use this command to change the date and time when clean runs
automatically. The default time is Tuesday at 6 a.m. (tue 0600).
This operation is available only to administrative users. The
command has the following options:
daily Runs the command every day at the given time.
monthly Starts the command on a given day or days (from 1
to 31) at the given time.
never Turns off the clean schedule.
day-num The command runs on the given day or days, entered
as integers from 1 to 31.
day-name The command runs on the given day(s) at the given
time. A day-name is three letters (such as mon for
Monday). Use a dash (-) between days for a range of
days. For example, use: tue-fri.

Time is 24-hour military time. 2400 is not a valid time. mon 0000 is
midnight between Sunday night and Monday morning. A new set
schedule command cancels the previous setting.

For example, the following command runs the operation


automatically every Tuesday at 4 p.m.:
# filesys clean set schedule tue 1600
To run the operation more than once in a month, set multiple days
in one command. For example, to run the operation on the first and
fifteenth of the month at 4 p.m., use:
# filesys clean set schedule monthly 1,15 1600

clean set throttle


filesys clean set throttle percent
Use this command to set clean operations to use a lower level of
system resources when the Data Domain system is busy. At a
percentage of 0 (zero), cleaning runs very slowly or not at all when

150 filesys
the system is busy. A percentage of 100 allows cleaning to use
system resources in the usual way. The default is 50. When the
Data Domain system is not busy with backup or restore
operations, cleaning runs at 100% (uses resources as does any other
process). This command is available to administrative users only.
For example, to set the clean operation to run at 30% of its
possible speed, use:
# filesys clean set throttle 30

clean show config


filesys clean show config
Use this command to display all file system cleaning settings.
The display is similar to the following:
# filesys clean show config
50 Percent Throttle
Filesystem cleaning is scheduled to run "Tue" at
"0600".

clean show schedule


filesys clean show schedule
Use this command to display the current date and time for the
clean schedule.

The display is similar to the following:


# filesys clean show schedule
Filesystem cleaning is scheduled to run "Tue" at
"0600".

clean show throttle


filesys clean show throttle
Use this command to display the throttle setting for cleaning.
The display is similar to the following:
# filesys clean show throttle
100 Percent Throttle

DD OS 4.9 Command Reference Guide 151


clean start
filesys clean start
Use this command to manually start the clean process. The
command uses the current setting for the scheduled automatic
clean operation. This command is available to administrative
users only.
For example, the following command runs the clean process and
reminds you of the monitoring command. When the command
finishes, a message is sent to the system log giving the amount of
free space available.
# filesys clean start
Cleaning started. Use 'filesys clean watch' to
monitor progress.

clean status
filesys clean status
Use this command to display the active or inactive status of the
clean process. When the clean process is running, the command
displays progress.
The display is similar to the following:
# filesys clean status
Cleaning started at 2009/02/06 10:21:51: phase 6 of
10
64.6% complete, 2496 GiB free; time: phase 1:06:32,
total 8:53:21

clean stop
filesys clean stop
Use this command to stop the clean process. Stopping the process
means that all work done so far is lost. Starting the process again
means starting over at the beginning. If the clean process is
slowing down the rest of the system, consider using the filesys
clean set throttle operation to reset the amount of system
resources used by the clean process. The change in the use of
system resources takes place immediately. This command is
available to administrative users only.
152 filesys
clean watch
filesys clean watch
Use this command to monitor an ongoing clean process,. The
output is the same as output from the filesys clean status
command, but continuously updates. Press Ctrl+c to stop
monitoring the progress of a clean process. The process continues,
but the reporting stops. Use the filesys clean start command
to restart monitoring. This command is available to administrative
users only.

destroy
filesys destroy [and-zero] [and-shrink]
Use this command to delete all data in the Data Domain system file
system and re-initialize the file system. This command also
removes Replicator configuration settings. Deleted data is not
recoverable. This command is available to administrative users
only.
and-zero This option writes zeros to all disks, which can take
many hours.
and-shrink This option removes any additional external storage
that was added to the system using the disk add
command and returns the system to the factory
default state. When this option is used in conjunction
with the and-zero option, the file system is zeroed
prior to removing any storage.

Note: The and-zero option is not supported on Data Domain


gateway systems.
The display includes a warning similar to the following:
# filesys destroy
The 'filesys destroy' command irrevocably destroys
all data in the '/backup' data collection,
including all virtual tapes, and creates a newly
initialized (empty) file system.
The 'filesys destroy' operation will take about a
minute.
File access is disabled during this process.
Are you sure? (yes|no|?) [no]:
DD OS 4.9 Command Reference Guide 153
Note: The file system in a Global Deduplication Array is treated as
a single file system so the command output differs.
Note: When filesys destroy is run on a system with
retention-lock enabled:
All data is destroyed, including retention-locked data.
All filesys options are returned to default; this means
retention-lock is not enabled and the
min-retention-period as well as
max-retention-period options are set back to default
values on the newly created file system.
After a filesys destroy, all NFS clients connected to the
system may need to be remounted.
The file system is disabled after the filesys destroy command
is run. Run filesys enable (or replication commands) to enable
the file system.

disable
filesys disable
Use this command to stop the Data Domain system file system,
which stops Data Domain system operations (including cleaning).
This command is available to administrative users only.
Note: The file system in a Global Deduplication Array is treated as
a single file system so the command output differs.

enable
filesys enable
Use this command to start the Data Domain system file system,
allowing Data Domain system operations to begin. This command
is available to administrative users only.
Note: The file system in a Global Deduplication Array is treated as
a single file system so the command output differs.

154 filesys
encryption
The optional Encryption of Data at Rest feature encrypts all
incoming data before being written to the physical storage media.
The data is physically stored in an encrypted manner and cannot
be accessed on the existing Data Domain system or in any other
environment without first decrypting it.
The Encryption at Rest feature protects stored data in these
situations:
Theft or loss of a Data Domain system or its external storage
hardware while in transit from one customer location to
another
Theft or loss of a disk drive from a Data Domain system or its
external storage hardware
Failure of a storage device in transit for replacement
The encryption feature uses a passphrase to encrypt and decrypt
the keys that, in turn, get used to encrypt and decrypt the data.
Thus, changing the passphrase does not require re-encryption of
any stored data.
The encryption feature requires a separate license.
Caution: Unencrypted data that was stored before enabling this
feature is not automatically encrypted. To protect all of the data on
the system, be sure to enable encryption before you put the system
into use.
For a description of how Encryption at Rest works, and
information about configuring and managing the feature, see
Managing Encryption of Data at Rest in the DD OS 4.9
Administration Guide.

encryption algorithm reset


filesys encryption algorithm reset
Use this command to reset the algorithm to the default:
aes_256_cbc. After running this command, you must restart the
file system with the filesys restart command.

DD OS 4.9 Command Reference Guide 155


encryption algorithm set
filesys encryption algorithm set [aes_128_cbc | aes_256_cbc |
aes_128_gcm | aes_256_gcm]
Use this command to select the encryption algorithm. The
aes_256_gcm option, which selects AES in the Galois/Counter
mode, is the most secure algorithm, but it is significantly slower
than the Cipher Block Chaining (CBC) mode. After running this
command, you must restart the file system with the filesys
restart command.

encryption algorithm show


filesys encryption algorithm show
Use this command to print the encryption algorithm.

encryption disable
filesys encryption disable
Use this command to deactivate the encryption feature.

encryption enable
filesys encryption enable
Use this command to activate the encryption feature for new data
written to the file system and specify a new passphrase. After
running this command, you must restart the file system with the
filesys restart command. Here is an example:
# filesys encryption enable
Enter new passphrase:
Re-enter new passphrase:
Passphrases matched.
The passphrase is 'mypassphrase'.
The encryption feature is now enabled.
The filesystem must be restarted to effect this
change.

156 filesys
encryption lock
filesys encryption lock
Use this command to prepare the Data Domain system and its
external storage devices for shipment. This command creates a
new passphrase and destroys the cached copy of the current
passphrase, so anyone who does not possess the new passphrase
will not be able to decrypt the data.
Before you run this command, you must run filesys disable.
To run this command, you need to know the user names and
passwords for two accounts with system administration privileges.
# filesys encryption lock
Enter a second authorized user name: sysadmin2
Enter password:
Enter the current passphrase:
Enter new passphrase:
Re-enter new passphrase:
Passphrases matched.
The filesystem is now locked.

encryption passphrase
filesys encryption passphrase change
Use this command to change the passphrase. Before running this
command, you must run filesys disable.

encryption show
filesys encryption show
Use this command to check the status of the encryption feature.
Here is an example:
# filesys encryption show
Encryption is enabled
Algorithm: aes_256_cbc
The filesystem is unlocked

DD OS 4.9 Command Reference Guide 157


encryption unlock
filesys encryption unlock
Use this command to prepare the encrypted file system for use
after it has arrived at its destination. The system prompts you to
enter the passphrase that was specified in the encryption lock
command. After running this command, enable the file system
with filesys enable. If the passphrase is incorrect, the file
system does not start and the system reports the error.

fastcopy
filesys fastcopy [force] source src-path destination dest-path
Use this command to copy a file or directory tree from a Data
Domain system source directory to another destination on the Data
Domain system. See snapshot for snapshot details.
src-path The location of the directory or file that you want to
copy. The first part of the path must be /backup.
Snapshots always reside in /backup/.snapshot.
Use the snapshot list command to list existing
snapshots.
dest-path The destination for the directory or file being copied.
The destination cannot already exist.
force Allows the fastcopy to proceed without warning
in the event the destination exists. The force option is
useful for scripting, because it is not interactive.
filesys fastcopy force causes the destination
to be an exact copy of the source even if the two
directories had nothing in common before.
Note: Users may want or need to use fastcopy
force if they are scripting fastcopy operations to
simulate cascaded replication, the major use case for
the option. It is not needed for interactive use,
because regular fastcopy warns if the destination
exists and then re-executes with the force option if
allowed to proceed.

158 filesys
Caution: If the destination has retention-locked files, fastcopy
and fastcopy force fail, aborting the moment they encounter
retention-locked files.
For example, to copy the directory /user/bsmith from the
snapshot scheduled-2007-04-27 and put the bsmith directory
into the user directory under /backup, use:
# filesys fastcopy
source /backup/.snapshot/scheduled-2007-04-
27/user/bsmith
destination /backup/user/bsmith
Like a standard UNIX copy, filesys fastcopy makes the
destination equal to the source, but not at a particular point in
time. If you change either folder while copying, there are no
guarantees that the two are or were ever equal.

option
option disable report-replica-as-writable
filesys option disable report-replica-as-writable
Use this command to set the reported read/write status of a
replication destination file system 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. This
command is available to administrative users only.

option enable report-replica-as-writable


filesys option enable report-replica-as-writable
Use this command to set the reported read/write status of a
replication destination file system 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. This
command is available to administrative users only.

DD OS 4.9 Command Reference Guide 159


option reset
filesys option reset {local-compression-type | marker-type |
report-replica-as-writable | global-compression-type}
Use this command on the destination Data Domain system to
return file system compression to the default settings. This
command is available to administrative users only.
The options are as follows:
global-compression- Remove a manually set global
type compression type. The file system
continues to use the current type. Only
when a filesys destroy command
is entered does the type used change to
the default of 9.
Caution: The filesys destroy
command irrevocably destroys all
data in the /backup data collection,
including all virtual tapes, and
creates a newly initialized (empty)
file system.
local-compression-type Reset the compression algorithm to the
default of lz.
marker-type Return the marker setting to the default
of auto.
report-replica-as- Reset the file system to read-only.
writable

option set global-compression-type


filesys option set global-compression-type {1 | 9}
Use this command to set the global compression of data to either
type 9 (new type) or type 1 (old type). Enter the filesys disable
and filesys enable commands for the change to take effect. If
the file system is over 40% full, the command fails with an error
message. Also, if the compression type is different on each side of a
directory replication pair, replication stops. This command is
available to administrative users only.

160 filesys
To change the setting (to type 1, for example) and activate the
change, use the following commands:
# filesys option set global-compression-type 1
# filesys disable
# filesys enable

option set local-compression-type


filesys option set local-compression-type {none | lz | gzfast |
gz}
Use this command to set the compression algorithm. This
command is available to administrative users only.
Changing the algorithm affects only new data and data accessed as
part of a clean operation, not current data. To enable the new
setting, use the filesys disable and filesys enable
commands.
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).
none No data compression occurs.

option set marker-type


filesys option set marker-type {auto | besr1 | cv1 | eti1 |
hpdp1 | ism1 | nw1 | ssrt1 | tsm1 | tsm2 | none}
Use this command to have a Data Domain system deal with
markers inserted into backup data by some backup software. This
command is available to administrative users only.
The setting is system-wide and applies to all data received by a
Data Domain system.

DD OS 4.9 Command Reference Guide 161


If a Data Domain system is set for a marker type and data is
received that has no markers, compression and system
performance are not affected.
If a Data Domain system is set for a marker type and data is
received with markers of a different type, compression is
degraded for the data with different markers.
The options are:
auto Attempt to automatically determine what type of
markers are in use (the default setting).
On 4.5 systems and earlier, you may need to set this
option manually.
besr1 Backup Express System Restore, used for Symantec
NetBackup family of products, which takes a sector
level dump of a Windows drive.
cv1 CommVault Galaxy with VTL and file system backups.
eti1 HP NonStop systems using ETI-NET EZX/BackBox.
hpdp1 HP DP versions 5.1, 5.5, and 6.0 with VTL and file
system backups.
ism1 Informix Onbar. Used when Informix database is
backed up using onbar and its internal storage
manager.
If an external storage manager is used, this option
should not be needed.
nw1 Legato NetWorker with VTL.
ssrt1 Synectics backup express
tsm1 IBM Tivoli Storage Manager on media servers with
small-endian processor architecture, such as x86 Intel
or AMD.
tsm2 IBM Tivoli Storage Manager on media servers with
big-endian processor architecture, such as SPARC or
IBM mainframe. PowerPC can be configured as either
big- or small-endian. Check with your system
administrator if you are not sure about the media
server architecture configuration.
none Data with no markers.

162 filesys
After changing the setting, enter the following two commands to
enable the new setting:
# filesys disable
# filesys enable

option set staging-reserve


filesys option set staging-reserve percent
Use this command to reserve a percentage of total disk space for
disk staging. This command is available to administrative users
only.

option show
filesys option show {local-compression-type | marker-type |
report-replica-as-writable | global-compression-type}
Use this command to show the file system option settings. The
options are:
global- Display the current global compression
compression-type type.
local-compression- Display the current compression algorithm.
type
marker-type Display the current marker setting.
report-replica-as- Display the current reported setting on the
writable destination Data Domain system.

restart
filesys restart
Use this command to disable and enable the Data Domain system
file system in one operation. This command is available to
administrative users only

DD OS 4.9 Command Reference Guide 163


retention-lock
The retention lock feature allows the user to keep selected files
from being modified and deleted for a specified retention period of
up to 70 years.
Once a file is committed to be a retention-locked file, it cannot be
deleted until its retention period is reached, and its contents cannot
be modified. The retention period of a retention-locked file can be
extended but not reduced. The access control information of a
retention-locked file may be updated.
The retention lock feature can be enabled only if there is a retention
lock license. Enabling the retention lock feature affects only the
ability to commit non-retention-locked files to be retention-locked
files and the ability to extend the retention period of retention-
locked files. A retention-locked file is always protected from
modification and premature deletion, regardless of a valid
retention lock license and whether or not the retention lock feature
is enabled.
Once retention lock has ever been enabled on a Data Domain
system, you cannot rename non-empty folders or directories on
that system (although you can rename empty ones).
Notes:
A file must be explicitly committed to be a retention-locked file
through client-side file commands before the file is protected
from modification and premature deletion. (See the section
Client-Side Retention Lock File Control on page 165 for details.)
Most archive applications and selected backup applications
issue these commands when appropriately configured.
Applications that do not issue these commands do not trigger
the retention lock feature.
The retention lock feature supports a maximum retention
period of 70 years and does not support the retain forever
option offered by certain archive applications. Also, certain
archiving applications may impose a different limit (such as 30
years) on retention period, so please check with the
appropriate vendor.

164 filesys
Client-Side Retention Lock File Control
This section describes how files must be processed on the client-
side interface to become retention-locked (and a UNIX interface is
described in this sectionyour interface may differ). These
changes on the client side must be implemented in addition to the
setup/configuration of the retention lock feature on the Data
Domain system.
The client-side commands are used to control the retention locking
of individual files.
Note: The commands listed in this section are to be used only on
the client-side interface, not the Data Domain system CLI.

Create Retention-Locked Files and Set Retention Dates


The user creates a file in the usual way and then sets the last access
time (atime) of the file to the desired retention date of the file. If the
atime is set to a value that is larger than the current time plus the
configured minimum retention period, then the file is committed
to be a retention-locked file. Its retention date is set to the smaller
of the atime value and the current time plus the configured
maximum retention period. Setting the atime for a non-retention-
locked file to a value less than the current time plus the configured
minimum retention period is ignored without error.
The following (Unix) command can be used to set the atime:
ClientOS# touch -a -t [atime] [filename]
The format of atime is: [[YY]YY]MMDDhhmm[.ss]
For example, suppose the current date and time is 1 p.m. on
December 18th 2009 (that is, 200912181300) and the minimum
retention period is 12 hours. Adding the minimum retention
period of 12 hours to that date/time gives 200912190100.
Therefore, if atime for a file is set to a value greater than
201112190100, the file becomes retention-locked:
ClientOS# touch -a -t 201112312230 SavedData.dat
Note: The file must be completely written to the Data Domain
system before it is committed to be a retention-locked file.

DD OS 4.9 Command Reference Guide 165


Extending the Retention Date
To extend the retention date of a retention-locked file, set the files
atime to a value greater than the current retention date. If the new
value is less than the current time plus the configured minimum
retention period, the atime update is ignored without error.
Otherwise, the retention date is set to the smaller of the new value
and the current time plus the configured maximum retention
period.

Identifying a Retention-Locked File and Listing a Retention


Date
To determine whether a file is a retention-locked file, you can set
the atime of the file to a value smaller than its current atime. The
attempt will fail with a permission denied error, if and only if, the
file is a retention-locked file. The retention date for a retention-
locked file is its atime value. This can be listed by the following
command:
ClientOS# ls -l --time=atime [filename]

Deleting an Expired Retention-Locked File


Invoke the standard file delete operation on the retention-locked
file to be deleted. The command is typically:
ClientOS# rm [filename]
or
ClientOS# del [filename]
Note: If the retention date of the retention-locked file has not
expired, the delete operation will result in a permission denied
error.
The user must have the appropriate access rights to delete the file,
independent of the retention lock feature.

retention-lock disable
filesys retention-lock disable
Use this command to disable the retention lock feature. This
command is available to administrative users only.

166 filesys
retention-lock enable
filesys retention-lock enable
Use this command to enable the retention lock feature. This
command is available to administrative users only.

retention-lock option reset


filesys retention-lock option reset {min-retention-period |
max-retention-period}
Use this command to reset both the minimum and maximum
retention periods to their default values. The default min-
retention-period is 12 hours and the default max-retention-
period is 5 years. This command is available to administrative
users only.

retention-lock option set


filesys retention-lock option set {min-retention-period | max-
retention-period} period
Use this command to set the minimum or maximum retention
period. This command is available to administrative users only.
The period is specified in a similar way as for snapshot retention,
requiring a number followed by units, with no space between. The
units are any of the following:
min
hr
day
mo
year
The period should not be more than 70 years; any period larger
than 70 years results in an error. The limit of 70 years may be
raised in a subsequent release. By default, the min-retention-
period is 12 hours and the max-retention-period is 5 years.
These default values may be subsequently revised.
For example, to set the min-retention-period to 24 months, use:

DD OS 4.9 Command Reference Guide 167


# filesys retention-lock option set min-retention-
period 24mo

retention-lock option show


filesys retention-lock option show {min-retention-period | max-
retention-period}
Use this command to show the minimum and maximum retention
periods.

retention-lock reset
filesys retention-lock reset path
Use this command to reset retention lock for all files on a specified
path, that is, allow all files on the specified path to be modified or
deleted (with the appropriate access rights). For example, to reset
the retention lock on all files in /backup/dir1, use the command:
# filesys retention-lock reset /backup/dir1
Resetting retention lock raises an alert and logs the names of the
retention-locked files that have been reset. On receiving such an
alert, the user should verify that the particular reset operation is
intended. This command is available to administrative users only.

retention-lock status
filesys retention-lock status
Use this command to show retention lock status. The possible
values of retention lock status are enabled, disabled, or
previously enabled.

show
show compression
filesys show compression [filename] [last n {hours | days}]
[no-sync]
Use this command to display the space used by and compression
achieved for files, directories, and file systems. In general, the more
often a backup is done for a particular file or file system, the higher
168 filesys
the compression. The output does not include global and local
compression factors for the Currently Used row, but uses a dash
(-) instead. Note that the display on a busy system may not return
for several hours, depending on the number of files. Other factors
may influence the display. The meta-data value is an estimate of
index data.
Note: Specifying a file name is not recommended. If there are
many files, it could take several hours.
filesys show compression [summary | daily | daily-detailed]
{[last n {hours | days | weeks | months}] | [start date [end
date]]}
show compression daily
Use this command to display the space used by and compression
achieved for files, directories, and file systems, daily over the
previous four full weeks and the current partial week.
show compression daily-detailed
Use this command to display a slightly more detailed version of
show compression daily. This command adds the rows Global-
Comp Factor and Local-Comp Factor.

show space
filesys show space
Use this command to display the space available to and used by
file system components. Values are in gigabytes to one decimal
place.
The display is similar to the following:
# filesys show space
Resource Size GiB Used GiB Avail GiB Use% Cleanable GiB*
------------------ -------- -------- --------- ---- --------------
/backup: pre-comp - 206.2 - - -
/backup: post-comp 342.2 3.1 339.0 1% 0.0
/ddvar 19.7 0.6 18.1 3% -
------------------ -------- -------- --------- ---- --------------
Note: GiB = Gibibyte, the base-2 equivalent of Gigabyte.

DD OS 4.9 Command Reference Guide 169


/backup: pre-comp Display the 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. Do not expect
the amount shown in the /backup: pre-
comp line to be the same as the amount
displayed in the Original Bytes line by
the filesys show compression
command, which includes system overhead.
/backup: post-comp Display the 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 accepts no
more data from backup servers.
/ddvar Display the approximate amount of space
used by and available to the log and core
files. Remove old logs and core files to free
space in this area.

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 filesys clean show-schedule
command to see how often the cleaning operation runs
automatically, then use filesys clean schedule to run the
operation more often. Also consider reducing the data retention
period or splitting off a portion of the backup data to another Data
Domain system.

show uptime
filesys show uptime
Use this command to display the amount of time that has passed
since the file system was last enabled. The display is in days,
hours, and minutes.

170 filesys
The display is similar to the following:
# filesys show uptime
Filesys has been up 47 days, 23:28

status
filesys status
Use this command to display the state of the file system process.
The display gives a basic status of enabled or disabled with more
detailed information for each basic status.
The display is similar to the following:
# filesys status
The filesystem is enabled and running
If the file system was shut down with a Data Domain system
command, such as filesys disable, the display includes the
command. For example:
# filesys status
The filesystem is disabled and shutdown. [filesys
disable]
Note: The file system in a Global Deduplication Array is treated as
a single file system so the command output differs.

sync
filesys sync
Use this command to sync all modified files to disk.

filesys Examples

Retention Lock Procedure


This example shows the use of the retention lock feature.
1. Add the retention lock license:
# license add ABCD-EFGH-IJKL-MNOP
2. Display the status of the retention lock license:

DD OS 4.9 Command Reference Guide 171


# license show
3. Enable the retention lock feature:
# filesys retention-lock enable
4. Display the status of the retention lock feature:
# filesys retention-lock status
5. Set the minimum retention period for the Data Domain system:
# filesys retention-lock option set min-retention-
period 96hr
6. Set the maximum retention period for the Data Domain
system:
# filesys retention-lock option set max-retention-
period 30year
7. If you want to reset both the minimum and the maximum
retention periods to their default values:
# filesys retention-lock option reset
The minimum and maximum retention periods have now been
reset to their defaults: 12 hours and 5 years, respectively.
8. To show the maximum and minimum retention periods:
# filesys retention-lock option show max-retention-
period
# filesys retention-lock option show min-retention-
period
9. Activate the retention locking for the file on the client-side:
ClientOS# touch -a -t 201112312230 SavedData.dat

Performing Retention Lock File Control Commands on the


Client Operating System
Suppose the current date/time is December 18th 2009 at 1 p.m.,
that is, 200912181300. Adding the min retention period of 12 hours
gives 200912190100. Thus, if atime for a file is set to a value greater
than 200912190100, the file becomes retention-locked.

172 filesys
1. Put a retention lock on the existing file SavedData.dat by
setting its atime to a value greater than the current time plus
the minimum retention period:
ClientOS# touch -a -t 200912312230 SavedData.dat
2. To extend the retention date of the file:
ClientOS# touch -a -t 202012121230 SavedData.dat
3. To identify retention-locked files and list retention date:
ClientOS# touch -a -t 202012121200 SavedData.dat
ClientOS# ls -l --time=atime SavedData.dat
4. To delete an expired retention-locked file:

Assuming the retention date of the retention-locked file has


expired, as determined in the previous step.
ClientOS# rm SavedData.dat

Additional Notes
A Data Domain system that has become full may need multiple
clean operations to clean 100% of the file system, especially if
there is an external shelf. Depending on the type of data stored,
such as when using markers for specific backup software, the file
system may never report 100% cleaned. The total space cleaned
may always be a few percentage points less than 100.

Local Compression
A Data Domain system uses a local compression algorithm
developed specifically to maximize throughput as data is written
to disk. The default algorithm allows shorter backup windows for
backup jobs, but uses more space. Local compression options allow
you to choose slower performance that uses less space, or you can
set the system for no local compression.
Changing the algorithm affects only new data and data that is
accessed as part of the filesys clean process. Current data
remains as is until a clean operation checks the data.

DD OS 4.9 Command Reference Guide 173


To enable the new setting, use the filesys disable and
filesys enable commands.

Global Compression
DD OS 4.0 and later releases use a global compression algorithm
called type 9 as the default. Earlier releases use an algorithm called
type 1 (one) as the default.
A Data Domain system using type 1 global compression
continues to use type 1 when upgraded to a new release. A
Data Domain system using type 9 global compression
continues to use type 9 when upgraded to a new release.
A DD OS 4.0.3.0 or later Data Domain system can be changed
from one type to another if the file system is less than 40% full.
Directory replication pairs must use the same global
compression type.

Replicator Destination Read/Write Option


The read/write setting of the file system on a Replicator
destination Data Domain system is read-only. With some backup
software, the file system must be reported as writable for restoring
or vaulting data from the destination Data Domain system. The
commands in this section change and display the reported setting
of the destination file system. The actual state of the file system
remains as read-only.
Before changing the reported setting, use the filesys
disable command. After changing the setting, use the
filesys enable command.

When using CIFS on the Data Domain system, use the cifs
disable command before changing the reported state and use
the cifs enable command after changing the reported state.

Tape Marker Handling


Backup software from some vendors inserts markers (tape
markers, tag headers, or other names are used) in all data streams
(both file system and VTL backups) sent to a Data Domain system.
Markers can significantly degrade data compression on a Data
174 filesys
Domain system. The filesys option ... marker-type
commands allow a Data Domain system to handle specific marker
types while maintaining compression at expected levels.
Note: When backing up a network-attached storage device using
NDMP (not the Data Domain system NDMP feature), the backup
application is not in control of the data stream and does not insert
tape markers. In such cases, the Data Domain system tape marker
feature is not needed for either file system or VTL backups.

Disk Staging
Disk staging enables a Data Domain system to serve as a staging
device, where the system is viewed as a basic disk via a CIFS share
or NFS mount point. You use disk staging in conjunction with your
backup software, such as Symantecs NetBackup (NBU),
OpenStorage lifecycle, or Legatos NetWorker.
The Data Domain disk staging feature does not require a license
and is disabled by default.
The reason that some backup applications use disk staging devices
is to enable tape drives to stream continuously. After the data is
copied to tape, it is retained on disk for as long as space is
available. Should a restore be needed from a recent backup, more
than likely the data is still on disk and can be restored from it more
conveniently than from tape. When the disk fills up, old backups
can be deleted to make space. This delete-on-demand policy
maximizes the use of the disk.
In normal operation, the Data Domain System does not reclaim
space from deleted files until a cleaning operation is done. This is
not compatible with backup software that operates in a staging
mode, which expects space to be reclaimed when files are deleted.
When you configure disk staging, you reserve a percentage of the
total space, typically 20 to 30 percent, to allow the system to
simulate the immediate freeing of space.
The amount of available space, which is shown by the filesys
show space command, is reduced by the amount of the staging
reserve. When the amount of data stored uses all of the available
space, the system is full. However, whenever a file is deleted, the
system estimates the amount of space that will be recovered by
cleaning and borrows from the staging reserve to increase the
DD OS 4.9 Command Reference Guide 175
available space by that amount. When cleaning runs, the space is
actually recovered and the reserve restored to its initial size. Since
the amount of space made available by deleting files is only an
estimate, the actual space reclaimed by cleaning may not match the
estimate. The goal of disk staging is to configure enough reserve so
that you do not run out before cleaning is scheduled to run.

Retention Lock and Replication


Both Directory Replication and Collection Replication replicate the
locked or unlocked state of files. That is, files that are retention-
locked in the source are retention-locked in the destination.
However:
Collection replication replicates minimum and maximum
retention periods to the destination system.
Directory replication does not replicate minimum and
maximum retention periods to the destination system.
Replication resync fails if the destination is not empty and if
retention lock is currently or was previously enabled on either
the source or destination system.

Retention Lock and Fastcopy


Fastcopy does not copy the locked or unlocked state of files. Files
that are retention-locked in the source are not retention-locked in
the destination.
If you try to fastcopy to a destination that has retention-locked
files, the fastcopy operation aborts the moment it encounters
retention-locked files on the destination.

Retention Lock and Filesys Destroy


When filesys destroy is run on a system with retention lock
enabled:
1. All data is destroyed including retention-locked data.

2. All filesys options are returned to their defaults. This means


that retention lock is not enabled and min-retention-period

176 filesys
as well as max-retention-period options are set back to their
default values on the newly created file system.

DD OS 4.9 Command Reference Guide 177


178 filesys
13 help

Use the help command to display help files for Data Domain
system commands.

About the help Command


The help command with no object displays a list of all Data
Domain system top-level commands by name. For details about
the syntax of a command, use help with a command name as the
object. All Data Domain system commands let you press the tab
key to complete a unique entry.
The search feature displays every one-line command option from
every command in the Data Domain system command set that
includes a match of a keyword. If the keyword is the same as a
command name, the complete help page for the command
displays.
For example, to find all commands that include the keyword
password:
# help password
user add <user> [ password <password> ] [ priv
{admin|user} ]
Add a new user
user change password [<user>]
Change the password for a user
Use the up and down arrow keys to move through a displayed
help page. Use the q key to exit. Enter a slash character (/) to move
forward and a question mark (?) along with a pattern to search for
and highlight lines of particular interest.

DD OS 4.9 Command Reference Guide 179


help Command Options
Any Data Domain system command or keyword can be used as an
option to the help command.

help Examples
To list all of the Data Domain system commands by name, enter:
# help
To show the help for the command adminaccess, enter:
# help adminaccess

180 help
14 license

The license command manages licenses for licensed features on a


Data Domain system.
add Add a feature license. Page183
del Delete a feature license. Page183
reset Delete all licenses. Page183
show Display the current licenses and features. Page183

About the license Command


The license command lists current licenses on the Data Domain
system and adds or deletes licenses. The licensed features are:
Feature Description
Encryption Enables the optional software that provides
on-disk encryption of data-at-rest.
Expanded Storage Allows the upgrade of capacity for the Data
Domain system. Enables either the upgrade of
a 9-disk DD510/DD530 to 15 disks, or the
upgrade of a 7-disk DD610/DD630 to 12
disks.
Gateway Expanded Enables gateway systems to support up to
Storage Level 2 71 TB of usable capacity.
Gateway Expanded Enables gateway systems to support up to
Storage Level 3 145 TB of usable capacity.
Global Deduplication Licenses the global deduplication feature.
Nearline Identifies systems that are deployed for
archive and nearline workloads.
OpenStorage (OST) Use a system with the Symantec OpenStorage
product.

DD OS 4.9 Command Reference Guide 181


Feature Description
REPLICATION Enable replicating data from one Data Domain
system to another.
Retention-Lock Prevent retention-locked files from being
deleted or modified, for up to 70 years.
VTL Enable the use of a Data Domain system as a
virtual tape library.

The addition or deletion of a license feature takes effect


immediately.
Licensing for a Global Deduplication Array works as follows:
Global Deduplication Array membership: one license key per
controller in the Global Deduplication Array.
Replication: one license key per controller in the Global
Deduplication Array.
OST protocol: one license key for the master controller.

182 license
license Command Options

add
license add license-key [...]
Use this command to add one or more licenses for the same
feature. The code for each license is a string of 16 letters with
dashes. Include the dashes when entering the license code. Specify
multiple licenses to license a feature on multiple nodes in a Global
Deduplication Array. In a Global Deduplication Array, you must
run this command on the master controller. This command is
available to administrative users only.

del
license del license-key | license-feature
Use this command to remove a current license by specifying the
key or feature name. Enter the license feature name or key (as
shown with the license show command). In a Global
Deduplication Array, you must run this command on the master
controller. This command is available to administrative users only.

reset
license reset
Use this command to remove all licenses. This command is
available to administrative users only and is not available in a
Global Deduplication Array.

show
license show [local]
Use this command to display the features licensed on the Data
Domain system. This command is available to administrative users
only.
Running this command on the master controller in a Global
Deduplication Array displays licenses for all nodes in the Global
Deduplication Array, unless you use the local keyword. For

DD OS 4.9 Command Reference Guide 183


single nodes or worker controllers in a Global Deduplication
Array, the local keyword has no effect.
The output of this command looks like the following:
# license show
## License Key Feature
-- ------------------- -----------------
1 DEFA-EFCD-FCDE-CDEF REPLICATION
2 EFCD-FCDE-CDEF-DEFA VTL
-- ------------------ ----------------

License Key The characters of a valid license key.


Feature The name of the licensed feature.

license Examples
Add a License
To add a license, use:
# license add ABCD-EFGH-IJKL-MNOP
To display current licenses, use:
# license show
## License Key Feature
-- ------------------- -----------------
1 BCDE-FGHI-JKLM-NOPQ REPLICATION
2 ABCD-EFGH-IJKL-MNOP VTL
-- ------------------- ----------------

184 license
15 log

Use the log command to display and manage the log file. The log
command has the following options:
host Manage the process of sending log Page186
messages to another system.
list List files in the log directory. Page188
view View the system log or another log file. Page190
watch Watch the system log or another log Page191
file scroll.

About the log Command


The log command allows you to view Data Domain system log file
entries and the log file contents. Messages from the alerts feature,
the autosupport reports, and general system messages go to the
log directory (/ddvar/log)and into the file messages.*. A log
entry appears for each Data Domain system command given on
the system.
The log files on the Data Domain system are rotated to provide
easier management of log files. See Archive Log Files on page 192
for instructions on saving log files.

DD OS 4.9 Command Reference Guide 185


log Command Options

host
Data Domain systems can send log messages to other systems
which must be enabled to listen for network log messages. The
Data Domain system sends the log in the standard syslog format.
When remote logging is enabled, all of the messages in the
messages and kern.info files are exported. For managing the
selectors and receiving messages on a third-party system, see your
vendor-supplied documentation for the receiving system.
*.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).

The log host commands manage the process of sending log


messages to another system.

host add
log host add host-name
Use this command to add a system to the list that receives Data
Domain system log messages. This command is available to
administrative users only.
For example, the following command adds the system log-server
to the hosts that receive log messages:
# log host add log-server

186 log
host del
log host del host-name
Use this command to remove a system from the list of systems that
receive Data Domain system log messages. This command is
available to administrative users only.
For example, the following command removes the system log-
server from the hosts that receive log messages:
# log host del log-server

host disable
log host disable
Use this command to disable sending log messages to other
systems. This command is available to administrative users only.

host enable
log host enable
Use this command to enable sending log messages to other
systems. This command is available to administrative users only.

host reset
log host reset
Use this command to reset the log sending feature to the defaults
of disabled and an empty list. This command is available to
administrative users only.

DD OS 4.9 Command Reference Guide 187


host show
log host show
Use this command to display the list of systems that receive log
messages and the state of enabled or disabled.
The output is similar to the following:
# log host show
Remote logging is enabled.
Remote logging hosts
log-server

list
log list [debug]
Use this command to list the files in the log directory with the date
each file was last modified and the size of each file.
When the command is executed without the debug option, the
following files are listed:
messages The system log, generated from Data Domain
system actions and general system operations.
space.log Messages about disk space use 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
about 100 messages. All the messages are in
comma-separated-value format with tags that
you can use to separate out the disk space or
clean messages. You can use third-party
software to analyze either set of messages. The
tags are:
CLEAN for data lines from clean
operations.
CLEAN_HEADER for lines that contain
headers for the clean operations data lines.
SPACE for disk space data lines.
SPACE_HEADER for lines that contain
headers for the disk space data lines.

188 log
When the command is executed with the debug option, the
following files are added to the list of files above:
access Track users of the Data Domain Enterprise
Manager graphical user interface.
boot.log Kernel diagnostic messages generated during
the booting up process.
ddfs.info Debugging information created by the file
system processes.
ddfs.memstat Memory debugging information for file
system processes.
destroy.id_number All of the actions taken by an instance of the
.log 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
Enterprise 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 staff for system tuning.
secure Messages from unsuccessful logins and
changes to user accounts.
ssi_request Messages from the Data Domain Enterprise
Manager when users connect with HTTPS.
windows Messages about CIFS-related activity from
CIFS clients attempting to connect to the Data
Domain system.

DD OS 4.9 Command Reference Guide 189


For example, to list all of the files in the log directory, use:
# log list
Last modified Size File
------------------------ -------- ----------
Mon Mar 16 11:10:07 2009 135 KB messages
Sun Jan 18 00:00:02 2009 1460 KB messages.9
Sun Jan 25 00:27:16 2009 177 KB messages.8
Sun Feb 1 00:00:03 2009 154 KB messages.7
Sun Feb 8 00:00:03 2009 799 KB messages.6
Sun Feb 15 00:00:03 2009 385 KB messages.5
Sun Feb 22 00:00:03 2009 247 KB messages.4
Sun Mar 1 00:00:02 2009 394 KB messages.3
Sun Mar 8 00:00:02 2009 644 KB messages.2
Sun Mar 15 00:36:23 2009 469 KB messages.1
Mon Mar 16 11:00:02 2009 10741 KB space.log
------------------------ -------- ----------
Note: KiB = Kibibytes = the binary equivalent of Kilobytes.

view
log view [filename]
Use this command to view the log files. With no filename, the
command displays the current messages file. When viewing the
log, use the up and down arrows to scroll through the file; use the
q key to quit; enter a slash character (/) to search forward or a
question mark (?) to search backward for a pattern (for example, a
date) in the file.

190 log
watch
log watch [filename]
Use this command to display a view of the messages file that adds
new entries as they occur. Use the key combination Ctrl+c to break
out of the watch operation. With no filename, the command
displays the current messages file.

log Examples

Understand a Log Message


1. View the log file. (This can be done on the Data Domain system
either by using the command log view message, or the
command log view.
2. The log file includes information like this:
Jan 31 10:28:11 syrah19 bootbin: NOTICE: MSG-
SMTOOL-00006: No replication throttle schedules
found: setting throttle to unlimited.
3. Look for the file of log messages. A detailed description of log
messages can be obtained from the Data Domain Support Web
site, https://my.datadomain.com/, by clicking Software
Downloads, then the book icon under Docs for the given
release, then Error Message Catalog.
4. In the Web page of log messages, search for the message "MSG-
SMTOOL-00006." Find the following:
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.

DD OS 4.9 Command Reference Guide 191


5. Based on the message, the user could run the replication
throttle add command to set the throttle.

Archive 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. See the CIFS add command or the NFS
add command for more information.

If using FTP:
1. On the Data Domain system, use the adminaccess show
command to see that the FTP service is enabled. If the service is
not enabled, use the command adminaccess enable ftp.
2. On the Data Domain system, use the adminaccess show
command to see that the FTP access list has the IP address of
your remote machine or a class-C address that includes your
remote machine. If the address is not in the list, use the
command adminaccess add ftp ipaddr.
3. On the remote machine, open a Web browser.

4. In the Address box at the top of the Web browser, use FTP to
access the Data Domain system. For example:
ftp://Data Domain system_name.yourcompany.com/
Note: Some Web browsers do not automatically ask for a login
if a machine does not accept anonymous logins. In that case,
add a user name and password to the FTP line. For example,
add:
ftp://sysadmin:your-pw@Data Domain
system_name.yourcompany.com/
5. At the login popup, log into the Data Domain system as user
sysadmin.

6. On the Data Domain system, you are in the directory just


above the log directory. Open the log directory to list the
messages files.

192 log
7. Copy the file that you want to save. Right-click on the file icon
and select Copy To Folder from the menu. Choose a location
for the file copy.
8. If you want the FTP service disabled on the Data Domain
system, use SSH to log into the Data Domain system as
sysadmin and give the command adminaccess disable ftp.

DD OS 4.9 Command Reference Guide 193


194 log
16 migration

Use the migration command to move all data from one Data
Domain system to another. The migration command has the
following options:
abort Add a migration or migration enclosure. Page196
commit Flash a migration ID LED. Page197
receive Expand Data Domain system storage Page197
capacity.
send Start migration. Page198
show stats Fail a migration and force reconstruction. Page200
status Manage and display migration Page201
information.
watch Show migration port information. Page201

About the migration Command


The migration command copies all data from one Data Domain
system to another and may also copy replication contexts
(configurations). Use the command when upgrading to a larger
capacity Data Domain system. Migration is usually done in a LAN
environment. See the procedures at the end of this section for using
migration with a Data Domain system that is part of a replication
pair.
Only administrative users can use the migration command.
All data under /backup is always migrated and exists on both
systems after migration.
After migrating replication contexts, the migrated contexts still
exist on the migration source. After migrating a context, break
replication for that context on the migration source.

DD OS 4.9 Command Reference Guide 195


Data Domain does not recommend running backup operations
to a migration source during a migration operation.
A migration destination does not need a replication license
unless the system uses replication.
The migration destination must have a capacity that is the
same size as or larger than the used space on the migration
source.
The migration destination must have an empty file system.
Any setting of the systems replication throttle feature 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.

migration Command Options

abort
migration abort
Use this command to kill a migration process that is in progress.
The command stops the migration process and returns the Data
Domain system to its previous state. If the migration source Data
Domain system is part of a replication pair, replication is re-
started. Run the command on the migration source and the
migration destination. This command is available to
administrative users only.
Notes:
A migration abort leaves the password on the destination
system the same as the password on the migration source.
Using the migration abort command on a migration destination
will require a filesys destroy on that machine before the file
system can be enabled on it again.

196 migration
commit
migration commit
Use this command to 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 at any time after entering the
migration send command. All data on the source Data Domain
system at the time of the commit command (including data newly
written since the migration started) is migrated to the destination
Data Domain system. Data Domain recommends entering the
commit command after all backup jobs for the context being
migrated are finished.
Write access to the source is blocked after you enter the migration
commit command and during the time needed to complete
migration. After the migration process finishes, the source is
opened for write access, but new data is no longer migrated to the
destination. After the commit, new data for the contexts migrated
to the destination should be sent only to the destination. This
command is available to administrative users only.

receive
migration receive source-host src-hostname
Use this command to prepare a Data Domain system to be a
migration destination. This command is available to
administrative users only. Use the command:
Only on the migration destination.
Before entering the migration send command on the
migration source.
After running the filesys destroy operations on the
destination.
For example, to prepare a destination for migration from a
migration source named hostA:
# filesys destroy
# migration receive source-host hostA
Caution: When preparing the destination, do not run the filesys
enable command.

DD OS 4.9 Command Reference Guide 197


send
migration send {obj-spec-list | all} destination-host dst-
hostname
Use this command to start migration. This command is available to
administrative users only.
Use the command:
Only on the migration source.
Only when no backup data is being sent to the migration
source.
After entering the migration receive command on the
migration destination.
The obj-spec-list is /backup for systems that do not have a
replication license. With replication, the obj-spec-list is one or
more contexts from the migration source. After you migrate a
context, all data from the context is still on the source system, but
the context configuration is only on the migration destination. A
context in the obj-spec-list can be:
The destination string, as defined when setting up replication.
Examples are:
dir://hostB/backup/dir2
col://hostB
pool://hostB/pool2
The context number, as shown in output from the
replication status command. For example:
rctx://2
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
finishes.

198 migration
The migration send command stays open until a migration
commit command is entered. The migration commit command
should be entered first on the migration source and then on the
destination.
In the following examples, remember that all data on the migration
source is always migrated, even when a single directory
replication context is specified in the command.
To start migration of data only (no replication contexts, even if
replication contexts are configured) to a migration destination
named hostC, use a command similar to the following:
# migration send /backup destination-host hostC
To start a migration that includes a collection replication
context (replication destination string) of col://hostB, use:
# migration send col://hostB destination-host hostC
To start migration with a directory replication context of
dir://hostB/backup/dir2, use:
# migration send dir://hostB/backup/dir2
destination-host hostC
To start migration with two replication contexts using context
numbers 2 and 3, use:
# migration send rctx://2 rctx://3 destination-host
hostC
To migrate all replication contexts, use:
# migration send all destination-host hostC

DD OS 4.9 Command Reference Guide 199


show stats
migration show stats
Use this command to display migration statistics during the
migration process. This command is available to administrative
users only.
Migration statistics have the following columns:
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.

For example:
# migration show stats
Destination Bytes Sent Bytes Received
Received Time
----------- ------------ ---------- ----------------
hostB 153687473704 1974621040 Fri Jan 13 09:37
----------- ------------ ---------- ----------------

200 migration
Processed
Time
----------------
Fri Jan 13 09:37
-------------------

status
migration status
Use this command to display the current status of migration. This
command is available to administrative users only.
For example:
migration status
CTX: 0
Mode: migration source
Destination: hostB
Enabled: yes
Local file system status enabled
Connection connected since Tue Jul 17
15:20:09
State: migrating 3/3 60%
Error: no error
Destination lag: 0
Current throttle: unlimited
Contexts under migration: dir://hostA/backup/dir2

watch
migration watch
Use this command to track the initial phase of migration (when
write access is blocked). The command output shows the percent
of the migration process that has been completed. This command
is available to administrative users only.

DD OS 4.9 Command Reference Guide 201


migration Examples
Migrate Between Source and Destination
To migrate data from a source, hostA, to a destination, hostB
(ignoring replication contexts), use the following commands.
1. On hostB (the migration destination), use:
# filesys disable
# filesys destroy
# migration receive source-host hostA
2. On hostA (the source), run the following command:
# migration send /backup destination-host hostB
3. On either host, run the following command to display
migration progress:
# migration watch
4. At the appropriate time for your site, create a migration end
point. The three phases of migration may take many hours.
During that time, new data sent to the source is also marked for
migration. To allow backups with the least disruption, use the
following command after the three migration phases finish:
# migration commit
The migration commit command should be entered first on
the migration source, hostA, and then on the destination,
hostB.

Migrate with Replication


To migrate data and a context from a source, hostA, to a
destination, hostC, when hostA is also a directory replication
source for hostB, use the following commands.
1. On hostC (the migration destination), run the following
commands.
# filesys disable
# filesys destroy
# migration receive source-host hostA

202 migration
2. On hostA (the migration and replication source), run the
following command.
# migration send dir://hostB/backup/dir2
destination-host hostC
Note that this command also disables the file system.
3. On the source migration host, run the following command to
display migration progress:
# migration watch
4. First on hostA and then on hostC, run the following command.
# migration commit
Note that this command also disables the file system.
5. On hostB (the replication destination), run commands similar
to the following to change the replication source to hostC:
# filesys disable
# replication modify dir://hostB/backup/dir2
source-host hostC
# filesys enable

DD OS 4.9 Command Reference Guide 203


204 migration
17 net

The net command sets up network parameters and Ethernet


interface addresses and displays network information. The net
command has the following options:
aggregate Configure and display aggregate Page206
interfaces.
config Configure network parameters. Page208
create Create a VLAN or virtual interface. Page212
destroy Delete a VLAN interface. Page213
disable Disable Ethernet interfaces. Page213
ddns Manage the Dynamic DNS protocol. Page214
enable Enable Ethernet interfaces. Page215
failover Configure and display interface failover. Page215
hosts Configure and display hosts. Page218
iperf Analyze network connections. Page219
lookup Look up DNS entries. Page220
ping Confirm a connection between the Data Page221
Domain system and a host.
reset Reset network parameters to the defaults. Page221
set Set network parameters. Page221
show Display network parameters. Page223
tcpdump Save packet data to a file for analysis. Page226

DD OS 4.9 Command Reference Guide 205


About the net Command
The net command manages the use of virtual interfaces, DHCP,
DNS, and IP addresses, and displays network information and
status. The route command manages routing rules.
Note: Changes to disabled Ethernet interfaces made with the net
command options flush the routing table. Data Domain
recommends making interface changes only during scheduled
maintenance downtime. After making interface changes, you must
reconfigure any routing rules and gateways.

net Command Options

aggregate
Link aggregation provides improved network performance and
resiliency by using two to four network ports in parallel, thus
increasing the link speed and reliability over that of a single port.
The net aggregate commands control this feature. (Link
aggregation and Ethernet trunking are different terms for the same
thing.)

aggregate add
net aggregate add virtual-ifname mode {xor-L2 |xor-L2L3 |
roundrobin} interfaces physical-ifname-list
See Considerations for Ethernet Failover and Net Aggregation on
page 230 before setting up aggregation.
Note: To create a virtual interface, see the net create virtual
command.
Use the net aggregate add command to enable aggregation on
an existing virtual interface by specifying the physical interfaces
and mode (the mode must be specified). Available modes are the
Layer 2 or Layer 3/Layer4 implementations of the static balanced
mode, or round-robin. Choose the mode that is compatible with
the requirements of the system to which the ports are directly
attached.

206 net
The command enables aggregation on a virtual interface virtual-
ifname in the specified mode with the physical interfaces named
in physical-ifname-list. The aggregated links transmit packets
out of the Data Domain system.
The supported aggregate modes are:

xor-L2 Transmit based on static balanced mode


aggregation with an XOR hash of Layer 2
(inbound and outbound MAC addresses).
xor-L3L4 Transmit based on static balanced mode
aggregation with an XOR hash of Layer 3
(inbound and outbound IP address) and Layer 4
(inbound and outbound port numbers).
roundrobin Transmit packets in sequential order from the
first available link through the last in the
aggregated group.

For example, to enable link aggregation on virtual interface veth1


to physical interfaces eth1 and eth2 in mode xor-L2, use the
following command:
# net aggregate add veth1 mode xor-L2 interfaces
eth2 eth3

aggregate del
net aggregate del virtual-ifname interfaces physical-ifname-
list
Use this command to delete interfaces from the physical list of the
aggregate virtual interface.
For example, to delete physical interfaces eth1 and eth2 from the
aggregate virtual interface veth1, use the following command:
# net aggregate del veth1 interfaces eth2,eth3

aggregate reset
net aggregate reset virtual-ifname
Use this command to remove all physical interfaces from an
aggregate virtual interface.

DD OS 4.9 Command Reference Guide 207


The output is similar to the following:
# net aggregate reset veth1
Interfaces "eth2, eth3" have been removed from
"veth1".

aggregate show
net aggregate show
Use this command to display basic information on the aggregate
setup.
The output is similar to the following:
# net aggregate show
Ifname Hardware Address Aggregation Mode Configured Interfaces
------ ---------------- ---------------- ---------------------
veth1 00:15:17:0f:63:fc balance hash xor-L2 eth4,eth5

------ ----------------- ---------------- -------------------

config
net config ifname [ipaddr][netmask mask][up | down] [dhcp {yes
| no}][mtu {size | default}][autoneg][duplex {full | half}]
[speed {10 | 100 | 1000}] [0]

config ifname 0
net config ifname 0
Use this command to reset a network interface card to its default
(unconfigured) mode. For example, use net config eth0 0 to
reset interface 0. This command is available to administrative users
only.

208 net
config ifname autoneg
net config ifname autoneg
Use this command to allow the network interface card to
autonegotiate the line speed and duplex setting for an interface.
This command is available to administrative users only.
Note: This command is not applicable with 10 Gb Ethernet cards.
For example, to set autonegotiation for interface eth1, use:
# net config eth1 autoneg

config ifname dhcp


net config ifname dhcp [yes | no]
Use this command to set up an Ethernet interface to expect DHCP
information. Changes take effect only after a system reboot. This
command always enables the specified interface, regardless of
whether you specify yes or no. This command is available to
administrative users only.
Note: To activate DHCP for an interface when no other interface is
using DHCP, you must reboot the Data Domain system. To
activate DHCP for an optional gigabit Ethernet card, either have a
network cable attached to the card during the reboot or, after
attaching a cable, run the net enable command for the interface.
For example, to set DHCP for the interface eth0, use the
command:
# net config eth0 dhcp yes
To check the command, use the net show configuration
command. To check that the Ethernet connection is live, use the
net show hardware command.

DD OS 4.9 Command Reference Guide 209


config ifname duplex speed
net config ifname duplex {full|half} speed {10 | 100 | 1000}
Use this command to manually set an interface to half-duplex or
full-duplex, and set the line speed. Both duplex and speed are
required keywords. Half-duplex is not available for any port set
for a speed of 1000 (Gigabit). This command disables auto-
negotiation. You can specify line speeds of 10 Base-T, 100 Base-T,
or 1000 Base-T (Gigabit). A line speed of 1000 allows only a duplex
setting of full. Setting a port to a speed of 1000 and duplex of half
leads to unpredictable results.
You cannot use this command with 10 Gb Ethernet cards. This
command is available to administrative users only.
For example, to set the line use to half-duplex for interface eth1,
use:
# net config eth1 duplex half speed 100
To set the line speed to 100 Base-T for interface eth1, use:
# net config eth1 speed 100 duplex full

config ifname ipaddr


net config ifname ipaddr
Use this command to change the IP address used by a Data
Domain system Ethernet interface. This command disables DHCP
for the interface, if it is enabled. Use the net config ifname
dhcp disable command to turn off DHCP for an interface. See
config ifname dhcp on page 209 for details. If you do not specify a
netmask with config ifname netmask, the system uses the
default netmask. The default value for netmask depends on the IP
address. For example, the default netmask for 10.x.x.x is 255.0.0.0,
and the default netmask for 192.x.x.x is 255.255.255.0. This
command is available to administrative users only.
For example, to set the interface eth0 to the IP address of
192.168.1.1, use:
# net config eth0 192.168.1.1
Use the net show config command to check the operation.

210 net
config ifname mtu
net config ifname mtu {size | default}
Use this command to change the maximum transfer unit size for an
Ethernet interface. Supported values are from 1500 to 9014. For 100
Base-T and gigabit networks, 1500 is the standard default. The
default option returns the setting to the default value. Make sure
that all of your network components support the size set with this
option. This command is available to administrative users only.
For example, to set a maximum transfer unit size of 9014 for the
interface eth2, use the command:
# net config eth2 mtu 9014

config ifname netmask


net config ifname netmask mask
Use this command to change the netmask used by an Ethernet
interface. If you specify a netmask for an interface, you must also
specify an IP address with config ifname ipaddr. This
command is available to administrative users only.
For example, to set the netmask 255.255.255.0 for the interface
eth0:
# net config eth0 192.168.99.200 netmask
255.255.255.0

config ifname type


net config ifname type
[none|management|data|replication|cluster|"data,replication"]
This command is used to tag a network interface for a specific type
of Global Deduplication Array traffic. The Global Deduplication
license must be installed. This command is available to
administrative users only.
Note: Only one physical or virtual interface can be associated with
each logical interface type.

DD OS 4.9 Command Reference Guide 211


Management interface: identifies the IP address for managing
the controller (SSH or the Data Domain Enterprise Manager,
which is a graphical-user interface (GUI) application).
Note: To use the Enterprise Manager, you must be able to
connect to the Data Domain controller via the internet. The
Data Domain controller needs an IP address so the Web
browser can locate it on the network.
Data interface: identifies the IP address for backup traffic from
the media servers to the controller. Data Domain file systems
use the network interface with type data to communicate with
the Media Server for backup data.
Replication interface: identifies the IP address for replication
traffic.
Global Deduplication interface: identifies the Global
Deduplication Array interconnect IP address on each
controller. If a Global Deduplication Array has two Data
Domain systems, the Data Domain file system will use the
network interface with type cluster to communicate with the
second system.
For example, in a Global Deduplication Array, to communicate
with a second Data Domain system, veth1, enter:
# net config veth1 type cluster

config ifname up | down


net config ifname [up | down]
See net config enable and net config disable.

create
create interface
net create interface {physical-ifname|virtual-ifname} vlan
vlan-id
Use this command to create a new VLAN interface from either a
physical port or a virtual interface. The range of vlan-id is between
1 and 4095. Use the net config commands to configure the IP

212 net
address and netmask, or to enable or disable the interface. The
maximum number of interfaces is 512. The VLAN interface is
named ifname.vlan-id.
Notes:
The total number of VLAN and virtual interfaces that can be
created is limited to 80.
A VLAN interface cannot be created on a failover interface
consisting of Chelsio 10 GbE interfaces.
For example, to create a VLAN interface named eth0.2:
# net create interface eth0 vlan 2

create virtual
net create virtual virtual-id
Use this command to create a new virtual interface. The virtual
interface name virtual-id must begin with veth. The remainder
of the name can be decimal or hexadecimal numbers
(0-9 and aA-fF are permitted). Interface names must be unique.
This command is available to administrative users only.
For example, to create a virtual interface named veth12, use:
# net create virtual veth12

destroy
net destroy {virtual-ifname|vlan-ifname}
Use this command to delete an existing VLAN or virtual interface.
For example to destroy a VLAN named eth1.35 and a virtual
interface named veth23:2, use:
# net destroy eth1.35
# net destroy veth23

disable
net disable ifname

DD OS 4.9 Command Reference Guide 213


Use this command to disable an Ethernet interface on the Data
Domain system. This command is available to administrative users
only.
For example, to disable the interface eth0, use:
# net disable eth0

ddns
DDNS (Dynamic DNS) is the protocol that allows machines on a
network to communicate with, and register their IP address on, a
DNS server.

ddns add
net ddns add (ifname-list | all)
Use this command to add interfaces to the DDNS registration list.
This command is available to administrative users only.

ddns del
net ddns del (ifname-list | all)
Use this command to remove interfaces from the DDNS
registration list. This command is available to administrative users
only.

ddns disable
net ddns disable
Use this command to disable DNS updates. This command is
available to administrative users only.

ddns enable
net ddns enable
Use this command to enable DNS updates. This command is
available to administrative users only.

214 net
ddns register
net ddns register
Use this command to manually register configured interfaces with
DNS. This command is available to administrative users only.

ddns reset
net ddns reset
Use this command to reset the DDNS registration list to its defaults
and disable registration. This command is available to
administrative users only.

ddns show
net ddns show
Use this command to display interfaces in the DDNS registration
list.

ddns status
net ddns status
Use this command to display whether DDNS registration is
enabled or not.

enable
net enable ifname
Use this command to enable a disabled Ethernet interface on the
Data Domain system, where ifname is the name of an interface.
This command is available to administrative users only.
For example, to enable the interface eth0, use:
# net enable eth0

failover
Ethernet failover provides improved network stability and
performance, and is implemented with the net failover

DD OS 4.9 Command Reference Guide 215


command. The failover enabled virtual interface represents a
group of secondary physical interfaces, one of which can be
specified as the primary. The system makes the primary interface
the active interface whenever 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.
See Considerations for Ethernet Failover and Net Aggregation on
page 230 before setting up failover.

failover add
net failover add virtual-ifname interfaces physical-ifname-list
[primary physical-ifname | none]
Use this command to enable failover on an 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 is
veth56.3999:199. The maximum length of the full name is 16
characters, which typically limits the name string x to two
characters. Using special characters in the string x other than the
period (.) and the colon (:) is allowed but not recommended.
The virtual interface must already be present on the system; to
check for the presence of a virtual interface, use the net show
settings command. To designate one of the physical interfaces as
the primary failover interface, use the optional primary
parameter. This command is available to administrative users
only.
Note: A primary interface must be part of the failover and cannot
be deleted from the failover while it is the primary interface. Use
the net failover modify command to change the primary
interface.
For example, to associate a failover virtual interface named veth1
with the physical interfaces eth2 and eth3, and with eth2 as the
primary, use:
# net failover add veth1 interfaces eth2 eth3
primary eth2
Current interfaces for veth1: eth2, eth3, primary
eth2

216 net
failover del
net failover del virtual-ifname interfaces physical-ifname-list
Use this command to remove a physical Ethernet interface from a
failover virtual interface. The physical interface remains disabled
after being removed from the virtual interface. This command is
available to administrative users only.
For example, to remove eth2 from the virtual interface veth1,
which has eth2 and eth3 as slaves and eth3 as the primary
interface, use:
# net failover del veth1 interfaces eth2
Interfaces "eth2" have been removed from "veth1".
Current interfaces for veth1: eth3, primary: eth3

failover modify
net failover modify virtual-ifname primary {physical-ifname |
none}
Use this command to modify the physical Ethernet interface
designated as primary for failover on a virtual interface. This
command is available to administrative users only.

failover reset
net failover reset virtual-ifname
Use this command to reset a virtual interface and remove all
physical interfaces that were associated with it. Resetting a virtual
interface removes all associated physical interfaces from the virtual
interface. This command is available to administrative users only.
For example, the following command removes the virtual interface
veth1 and releases all of its associated physical interfaces. (The
physical interfaces are still disabled and must be enabled for any
other use than as part of another virtual interface.)
# net failover reset veth1

DD OS 4.9 Command Reference Guide 217


After the virtual interface has been reset, the physical interfaces
remain disabled. Use the net enable command to re-enable the
interfaces.
# net enable eth2
# net enable eth3

failover show
net failover show
Use this command to display configured failover virtual interfaces.
This command shows what is configured at the bonding driver. To
see what is in the registry, use the net show settings command.
Note: The registry settings may be different from the bonding
configuration. 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 will be different.
The value in the Hardware Address column is the physical
interface currently used by the failover virtual interface.
# net failover show
Ifname Hardware Address Configured Interfaces
------ ----------------- ---------------------
veth1 00:04:23:d4:f1:27 eth3
------ ----------------- ---------------------

hosts
hosts add
net hosts add ipaddr {host | host [alias]} ...
Use this command to associate an IP address with a hostname,.
The hostname is a fully-qualified domain name or a hostname. The
entry is added to the /etc/hosts file. This command is available
to administrative users only.
For example, to associate both the fully-qualified domain name
bkup20.yourcompany.com and the hostname of bkup20 with an IP
address of 192.168.3.3, use the command:
218 net
# net hosts add 192.168.3.3 bkup20.yourcompany.com bkup20

hosts del
net hosts del ipaddr
Use this command to delete a hostname or IP address entry from
the /etc/hosts file. This command is available to administrative
users only.
For example, to remove the host entries with an IP address of
192.168.3.3, use:
# net hosts del 192.168.3.3

hosts reset
net hosts reset
Use this command to delete all hostname and IP address entries
from the /etc/hosts file. This command is available to
administrative users only.

hosts show
net hosts show
Use this command to display hostnames and IP addresses from the
/etc/hosts file. This command is available to administrative
users only.
The display looks similar to the following:
# net hosts show
Hostname Mappings:
192.168.3.3 -> bkup20 bkup20.yourcompany.com

iperf
The iperf Linux command measures the quality and bandwidth
of network connections. The net iperf command provides the
equivalent capabilities.

DD OS 4.9 Command Reference Guide 219


iperf client
net iperf client server-host [port port] [window-size bytes]
[data {random|default}] [interval secs] [{transmit-size bytes |
duration secs}]
Use this command to run the iperf command in client mode. This
command is available to administrative users only.
net iperf client Option Equivalent iperf Option
server-host -c server-host
port port -p port
window-size bytes -w iperf_bytes
transmit-size bytes -n iperf_bytes
duration secs -t secs
interval secs -i secs
data random -F /dev/urandom
data default No equivalent option (default behavior)

Values for bytes may be followed by the K, M, or G suffices to


scale the value.

iperf server
net iperf server [port port] [window-size bytes]
Use this command to run the iperf command in server (-s) mode.
This command is available to administrative users only.
net iperf server Option Equivalent iperf Option
port port -p port
window-size bytes -w iperf_bytes

lookup
net lookup {ipaddr | hostname}
Use this command to look up DNS entries.

220 net
ping
net ping host [broadcast] [count n] [interface ifname]
Use this command to check that a Data Domain system can
communicate with a remote host with a hostname or IP address.
broadcast Allow pinging a broadcast address.
count Give the number of pings to issue.
interface Give the interface to use: eth0 through eth3.

For example, to check that communication is possible with the host


srvr24, use:
# net ping srvr24

reset
net reset {hostname | domainname | dns}
Use this command to reset the hostname, domain name, and DNS
parameters to their default values (empty). The command requires
at least one parameter and accepts multiple parameters. Changes
take effect only after a system reboot. This command is available to
administrative users only.
For example, to reset the system host name, use:
# net reset hostname

set
set dns
net set dns ipaddr1[, ipaddr2[, ipaddr3]]
Use this command to add or change DNS servers for the Data
Domain system to use in resolving addresses to give DNS server IP
addresses. The command writes over the current list of DNS
servers. Only the servers given in the latest command are available
to a Data Domain system. Entries in the list can be separated by
commas, spaces, or both. This command is available to
administrative users only.

DD OS 4.9 Command Reference Guide 221


Note: To activate a DNS change, the Data Domain system must be
rebooted.
For example, to allow a Data Domain system to use a DNS server
with an IP address of 123.234.78.92, use the command:
# net set dns 123.234.78.92
To check the command, use the net ping host-name command.

set domainname
net set domainname name
Use this command to change the domain name used by the Data
Domain system. This command is available to administrative users
only.
For example, to set the domain name to yourcompany-ny.com,
use:
# net set domainname yourcompany-ny.com

set hostname
net set hostname host
Use this command to change the name other systems use to access
the Data Domain system. Because of a restriction with some
browsers, the hostname should not include an underscore
character. If the hostname contains an underscore, it can prevent
logins to that host from the GUI, and would result in the GUI not
being able to manage that host. This command is available to
administrative users only.
For example, to set the Data Domain system name to dd10:
# net set hostname dd10
To check the operation, use the net show hostname command.
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 to rejoin the active directory domain.

222 net
show
show all
net show all
Use this command to display the output from the commands net show
config, net show settings, net show domainname, net show
hostname, net show hardware, net show dns, and net show
stats.

show config
net show config [ifname]
Use this command to display the current network driver settings
for an Ethernet interface. With no ifname, the command returns
configuration information for all Ethernet interfaces.

show dns
net show dns
Use this command to display the DNS servers used by a Data
Domain system.
The display looks similar to the following. The last line indicates
whether the servers were configured manually or by DHCP.
# net show dns

# Server
- -----------
1 192.168.1.3
2 192.168.1.4
- -----------

Showing DNS servers configured manually.

show domainname
net show domainname
Use this command to display the domain name used for email sent
by a Data Domain system.
DD OS 4.9 Command Reference Guide 223
The display looks similar to the following:
# net show domainname
The Domainname is: yourcompany.com

show hostname
net show hostname
To display the current hostname used by the Data Domain system,
use the net show hostname operation. The display is similar to
the following:
# net show hostname
The Hostname is: dd10.yourcompany.co

show hardware
net show hardware
Use this command to display hardware information. The display
looks similar to the following:
# net show hardware

Port Speed Duplex Supp Speeds Hardware Address Physical Cable


---- -------- ------- ----------- ----------------- -------- -----
eth0 100Mb/s full 10/100/1000 00:02:b3:b0:8a:d2 Copper yes
eth1 unknown unknown 10/100/1000 00:02:b3:b0:80:3f Copper no
eth2 1000Mb/s full 10/100/1000 00:07:e9:0d:5a:1a Copper yes
eth3 unknown unknown 10/100/1000 00:07:e9:0d:5a:1b Copper no

The display of the status of network ports has the columns:


Port The Ethernet interfaces on the system (for example,
eth3 or eth3a, depending on the port naming
convention your system uses).
Speed The actual speed at which the port currently deals
with data.
Duplex Shows whether the port is using the full or half
duplex protocol.
Supp Speeds Lists all the speeds that the port is capable of using.

224 net
Hardware The MAC address.
Address
Physical Shows whether the port is Copper or Fiber.
Cable Shows whether or not the port currently has a cable
attached and the carrier is up.

show settings
net show settings
Use this command to display network settings.
The display of Ethernet interface settings shows what you have
configured, not the actual status of each interface. For example, if
an interface on the Data Domain System does not have a live
Ethernet connection, the interface is not actually enabled.
# net show settings
port enabled DHCP IP address netmask additional setting
----- ------- ---- ---------------- ---------------- ------------------
eth0 yes yes 192.168.9.199* 255.255.252.0*
eth1 yes yes (not specified)* (not specified)*
veth0 no n/a n/a n/a
veth1 no n/a n/a n/a
veth2 no n/a n/a n/a
veth3 no n/a n/a n/a
----- ------- ---- ---------------- ---------------- ------------------
* Value from DHCP

Port Each Ethernet interface listed by name.


Enabled Whether or not the port is configured as enabled. To
check the actual status of interfaces, use the net
show hardware command. The Cable column
entry shows a value of yes for live Ethernet
connections.
DHCP Whether or not port characteristics are supplied by
DHCP. If a port uses DHCP for configuration values,
the display does not have values for the remaining
columns.
IP Address The address used by the network to identify the port.
Netmask The standard IP network mask.

DD OS 4.9 Command Reference Guide 225


show stats
net show stats [all | interfaces | listening | route |
statistics]
Use this command to display network statistics. The information
returned from all the options is used by Data Domain support staff
for troubleshooting.
all Display summaries of the other options.
interfaces Display the kernel interface table and a table of all
network-enabled interfaces and their activity.
listening Display statistics about active internet connections
from servers.
route Display the IP routing tables showing the destination,
gateway, netmask, and other information for each
route.
statistics Display network statistics for protocols.

The display with the route option is similar to the following.


# net show stats route
Kernel IP routing table
Destination Gateway Genmask Flags MSS Window irtt Iface
192.168.8.0 * 255.255.252.0 U 0 0 0 eth0
127.0.0.0 * 255.0.0.0 U 0 0 0 lo
default router-10.datad 0.0.0.0 UG 0 0 0 eth0

tcpdump
tcpdump capture
net tcpdump capture filename [interface iface]
[{host host | net net [mask mask]}] [port port] [snaplen bytes]
Use this command to run the Linux tcpdump command and save
packet data to a file for later analysis. You can use this command to
collect 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. The output files are placed in
/ddvar/traces from where you can upload them to autosupport.
A maximum of 10 output files may be retained on the system; if

226 net
this limit is reached, the command prompts you to delete some of
the existing files. This command is available to administrative
users only.
Command options are translated as follows:
net tcpdump Option Equivalent tcpdump Options
filename -w /ddvar/traces/tcpdump_filename
-C 100M -W 5
interface iface -i iface
host host host host
net net net net
mask mask mask mask
port port port port
snaplen bytes -s bytes

tcpdump del
net tcpdump del {filename | all}
This command deletes output files created by the net tcpdump
capture command. Specify a filename to delete all files that
match the pattern /ddvar/traces/tcpdump_filename *. Specify
all to remove all net tcpdump output files. This command is
available to administrative users only.

net Examples

Sample Failover Workflow


1. Disable the interfaces eth2, eth3, and eth4 for use as failover
interfaces:
# net disable eth2
# net disable eth3
# net disable eth4
2. If virtual interface veth1 does not exist on the system, create it:

DD OS 4.9 Command Reference Guide 227


# net create virtual veth1
3. Create a failover virtual interface named veth1 using the
physical interfaces eth2 and eth3:
# net failover add veth1 interfaces eth2,eth3
Current interfaces for veth1: eth2, eth3
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
Ifname Hardware Address Configured Interfaces
------ ----------------- ---------------------
veth1 00:04:23:d4:f1:27 eth2,eth3
------ ----------------- ---------------------
To add the physical interface eth4 to failover virtual interface
veth1:
# net failover add veth1 interfaces eth4
Current interfaces for veth1: eth2,eth3,eth4
To remove eth2 from the virtual interface veth1:
# net failover del veth1 interfaces eth2
Interfaces "eth2" have been removed from "veth1".
Configuration of "veth1" is reset.
To remove the virtual interface veth1 and release all of its
associated physical interfaces:
# net failover reset veth1
Interfaces for veth1:
To re-enable the physical interfaces:
# net enable eth2
# net enable eth3
# net enable eth4

228 net
Sample Aggregation Workflow
1. Disable the interfaces eth2, eth3, and eth4 to use as
aggregation interfaces:
# net disable eth2
# net disable eth3
# net disable eth4
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 eth2 and eth3 in xor-L2 mode:
# net aggregate add veth1 mode xor-L2 interfaces eth2 eth3
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
Ifname Hardware Address Aggregation Mode Configured Interfaces
------ ---------------- ---------------- ---------------------
veth1 00:15:17:0f:63:fc xor-L2 eth2,eth3
------ ----------------- ---------------- ---------------------

To delete physical interface eth3 from the aggregate virtual


interface veth1:
# net aggregate del veth1 interfaces eth3
To add link physical interface eth4 on virtual interface veth1:
# net aggregate add veth1 mode xor-L2 interfaces
eth4
To remove all interfaces from veth1:
# net aggregate reset veth1
Interfaces "eth2, eth4" have been removed from
"veth1".
Configuration of "veth1" is reset.

DD OS 4.9 Command Reference Guide 229


To re-enable the physical interfaces:
# net enable eth2
# net enable eth3
# net enable eth4

Important Notices

Considerations for Ethernet Failover and Net


Aggregation
While planning Ethernet failover and net aggregation, consider the
following supported guidelines:
A system with two Ethernet cards can have a maximum of six
ports, eth0, eth1, eth2, eth3, eth4, and eth5, unless one of
the cards is a 1-port 10 GbE fiber, in which case the system has
a total of five ports (eth0-eth4).
The recommended number of physical interfaces for failover is
two. However, you can configure one primary interface and up
to five failover interfaces (except with 10 Gb copper Ethernet
cards, which are restricted to one primary interface and one
failover interface, and with the 10 Gb optical Ethernet cards,
which cannot be used in any failover or aggregation).
The recommended number of physical interfaces used in
aggregation is two.
Each physical interface (eth0 to eth5) can belong to at most
one virtual interface.
A system can have multiple and mixed failover and
aggregation virtual interfaces, subject to the restrictions above.
Virtual interfaces must be created from identical physical
interfaces (all copper or all optical, and all 1 Gb or all 10 Gb).

230 net
Supported Interfaces

Interface Aggregation Failover

1 Gb to 10 Gb Not supported Not supported

Motherboard to 1 Gb Supported Supported


dual-port copper (this is
the only supported
configuration)

1 Gb to 1 Gb
Dual-port copper Supported across ports on Supported across ports on a
a card, across ports on the card, across ports on the
motherboard, or across motherboard, or across
cards cards
Dual-port fiber
Supported across ports on Supported across ports on a
a card or across cards card or across cards

10 Gb to 10 Gb
Dual-port copper Not supported Supported only on the
same NIC
Single-port fiber Not supported Not supported

When you create a virtual interface:


The virtual-name must be in the form vethx where x is a
number in the format required for the net create virtual
command.
You can create as many virtual interfaces as there are physical
interfaces.
The physical-name must be in the form ethx where x is an
alphanumeric string (typically a number).
Each interface used in a virtual interface must first be disabled
with the net disable command. An interface that is part of a
virtual interface is seen as disabled by other net commands.
All interfaces in a virtual interface must be on the same subnet
and on the same LAN (or card for 10 Gb). Network switches
used by a virtual interface must be on the same subnet.

DD OS 4.9 Command Reference Guide 231


A virtual interface needs an IP address that is set manually.
Use the net config command.
If a primary interface is to be used in a failover configuration, it
must be explicitly specified with the primary option to the net
failover add command and must also be a slave to the virtual
interface. If the primary interface goes down and multiple
interfaces are still available, the next interface used is a random
choice.

232 net
18 nfs

The nfs command manages NFS clients for a Data Domain system.
This command includes the following options.
add Add NFS clients to an export. Page234
del Delete NFS clients from an export. Page235
disable Disable NFS clients from connecting. Page235
enable Enable NFS clients to connect. Page235
reset Reset the client list so that no clients can Page236
connect.
show Show active NFS clients, all allowed NFS Page236
clients, and an NFS histogram of the time
needed for NFS operations.
status Show whether or not NFS is enabled. Page238

About the nfs Command


The nfs command allows you to add NFS clients and to manage
their access to a Data Domain system. It also allows you to display
status information, such as whether or not the NFS system is
active, and the time needed for specific NFS operations.

DD OS 4.9 Command Reference Guide 233


nfs Command Options

add
nfs add {/ddvar | /backup[/sub-dir]} client-list [nfs-options]
Use this command to add NFS clients that can access the Data
Domain system. To specify multiple clients, create a list of entries
separated by commas, spaces, or both. A client can be a fully-
qualified domain hostname, class-C IP addresses, IP addresses
with either netmasks or length, an NIS netgroup name with the
prefix @, or an asterisk (*) wildcard with a 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.
This command is available to administrative users only.
Note: /backup subdirectory is not supported in Global
Deduplication Array.
The nfs-options are contained in a list, with entries separated by
commas, spaces, or both, and bounded by parentheses. With no
options specified, the default options are rw, root_squash,
no_all_squash, and secure. The following options are allowed:

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).
insecure Turn off the secure option.

234 nfs
anonuid="id" Set an explicit user ID for the anonymous
account. The ID is an integer bounded from 0 to
65635, which must be enclosed in double
quotation marks.
anongid=id Set an explicit group ID for the anonymous
account. The ID is an integer bounded from 0 to
65635, which must be enclosed in double
quotation marks.

del
nfs del {/ddvar | /backup[/subdir]} client-list
Use this command to 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. Separate items in the list by commas, spaces,
or both. This command is available to administrative users only.
Note: /backup subdirectory is not supported in Global
Deduplication Array.

disable
nfs disable
Use this command to disable all NFS clients. This command is
available to administrative users only.

enable
nfs enable
Use this command to allow all NFS-defined clients to access the
Data Domain system. This command is available to administrative
users only.

DD OS 4.9 Command Reference Guide 235


reset
reset clients
nfs reset clients
Use this command to reset the client list to the factory default,
which is an empty list. No NFS clients can access the Data Domain
system when the list is empty. This command is available to
administrative users only.

reset stats
nfs reset stats
Use this command to clear the NFS statistics. This command is
available to administrative users only.

show
show active
nfs show active
Use this command to list all of the clients that have been active in
the past 15 minutes and the mount path for each active client.

show clients
nfs show clients
Use this command to list the NFS clients allowed to access the Data
Domain system, and the mount path and NFS options for each.

show detailed-stats
nfs show detailed-stats
Use this command to display NFS cache entries and status for
purposes of troubleshooting.

236 nfs
show histogram
nfs show histogram [op]
Use this command to display NFS operations in a histogram.
Optionally, use the op argument to plot a histogram for a specific
NFS operation. This command is available to administrative users
only. The command displays the following output.
Op The name of the NFS operation.
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.

DD OS 4.9 Command Reference Guide 237


# nfs show histogram
Op mean-ms stddev max-s 2ms 4ms 6ms 8ms 10ms 100ms 1s 10s >10s
---------------------------------------------------------------------------------------------------------
NULL 0.0 0.0 0.0 1 0 0 0 0 0 0 0 0
GETATTR 0.0 0.0 0.0 3 0 0 0 0 0 0 0 0
SETATTR 0.1 0.0 0.0 1 0 0 0 0 0 0 0 0
LOOKUP 0.0 0.0 0.0 20 0 0 0 0 0 0 0 0
ACCESS 0.0 0.0 0.0 3 0 0 0 0 0 0 0 0
READLINK 0.0 0.0 0.0 0 0 0 0 0 0 0 0 0
READ 0.0 0.0 0.0 0 0 0 0 0 0 0 0 0
WRITE 0.0 0.0 0.0 0 0 0 0 0 0 0 0 0
CREATE 0.0 0.0 0.0 0 0 0 0 0 0 0 0 0
MKDIR 0.0 0.0 0.0 0 0 0 0 0 0 0 0 0
SYMLINK 0.0 0.0 0.0 0 0 0 0 0 0 0 0 0
MKNOD 0.0 0.0 0.0 0 0 0 0 0 0 0 0 0
REMOVE 0.0 0.0 0.0 0 0 0 0 0 0 0 0 0
RMDIR 0.0 0.0 0.0 0 0 0 0 0 0 0 0 0
RENAME 0.0 0.0 0.0 0 0 0 0 0 0 0 0 0
LINK 0.0 0.0 0.0 0 0 0 0 0 0 0 0 0
READDIR 0.0 0.0 0.0 1 0 0 0 0 0 0 0 0
READDIRPLUS 0.0 0.0 0.0 0 0 0 0 0 0 0 0 0
FSSTAT 0.0 0.0 0.0 0 0 0 0 0 0 0 0 0
FSINFO 0.0 0.0 0.0 1 0 0 0 0 0 0 0 0
PATHCONF 0.0 0.0 0.0 0 0 0 0 0 0 0 0 0
COMMIT 0.0 0.0 0.0 0 0 0 0 0 0 0 0 0
WRITESHM 0.0 0.0 0.0 0 0 0 0 0 0 0 0 0
READSHM 49.0 0.0 0.0 0 0 0 0 0 1 0 0 0
SYNC 0.0 0.0 0.0 0 0 0 0 0 0 0 0 0
COMPSTATS 0.0 0.0 0.0 0 0 0 0 0 0 0 0 0

show stats
nfs show stats
Use this command to display NFS statistics.

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

238 nfs
nfs Examples

Add or Delete NFS Clients


To add an NFS client with an IP address of 192.168.1.02 and
read/write access to /backup with the secure option, enter:
# nfs add /backup 192.168.1.02
You can also add NFS clients that are part of a subnet. The
following examples show how to add a client using its IP address
followed by a length and a netmask:
# nfs add /backup 192.168.1.02/24
# nfs add /backup 192.168.1.02/255.255.255.0
To delete an NFS client with an IP address of 192.168.1.02 from the
/ddvar directory, enter:
# nfs del /ddvar 192.168.1.02

DD OS 4.9 Command Reference Guide 239


240 nfs
19 ntp

Use the ntp command to synchronize a Data Domain system with


NTP time servers and manage the NTP service. The ntp command
has the following options:
add timeserver Add one or more remote time Page242
servers.
del timeserver Add one or more remote time Page242
servers.
disable Disable the NTP local server. Page242
enable Enable the NTP local server. Page243
reset Reset (to default) the NTP Page243
server configuration.
reset timeservers Reset (to default) the remote Page243
time server list.
show Show the local NTP server Page243
configuration.
status Show the local NTP server Page244
status.

About the ntp Command


The ntp command allows you to synchronize a Data Domain
system with an NTP time server, manage the NTP service, or turn
off the local (on the Data Domain system) NTP server. The default
system settings for NTP service are enabled and multicast.
A Data Domain system can use a time server supplied through the
default multicast operation, received from DHCP, or set manually
with the Data Domain system ntp add command.

DD OS 4.9 Command Reference Guide 241


Time servers set with the ntp add command override time
servers from DHCP and from multicast operations.
Time servers from DHCP override time servers from multicast
operations.
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 Command Options

add timeserver
ntp add timeserver server_name
Use this command to add a remote time server to NTP list. This
command is available to administrative users only.
For example, to add an NTP time server named
srvr26.yourcompany.com to the list, enter:
# ntp add timeserver srvr26.yourcompany.com

del timeserver
ntp del timeserver server_name
Use this command to delete a manually added time server from
the list. This command is available to administrative users only.
For example, to delete an NTP time server named
srvr26.yourcompany.com from the list, enter:
# ntp del timeserver srvr26.yourcompany.com

disable
ntp disable
Use this command to disable NTP service on a Data Domain
system. This command is available to administrative users only.

242 ntp
enable
ntp enable
Use this command to enable NTP service on a Data Domain
system. This command is available to administrative users only.

reset
ntp reset
Use this command to reset the NTP configuration to the default
settings. This command is available to administrative users only.

reset timeservers
ntp reset timeservers
Use this command to reset the time server list from manually
entered time servers to either DHCP time servers (if supplied) or to
the multicast mode (if no DHCP time servers supplied). This
command is available to administrative users only.

show
ntp show config
Use this command to display whether NTP is enabled or disabled,
and show the time server list.
The following example shows the information that is returned:
# ntp show config
NTP is currently enabled.
# Server eth0 eth1
- --------------- ---- ----
1 192.168.244.208 X
2 192.168.244.214 X
- --------------- ---- ----
Showing NTP servers configured by DHCP.

DD OS 4.9 Command Reference Guide 243


status
ntp status
Use this command to display the local NTP service status, time,
and synchronization information.
The following example shows the information that is returned:
# ntp status
Status Enabled
Current Clock Time Thu Feb 26 19:27:57.676 2009
Clock Last Synchronized Thu Feb 26 19:12:05.729 2009
Clock Last Synchronized With Time Server 192.168.244.208

Note: For Global Deduplication Array mode, the output includes


information about both the master and worker controllers.

ntp Examples

Add an NTP Server


The following command gives the time server
srvr26.company.com as a time server for the Data Domain system
to use for synchronization:
# ntp add timeserver srvr26.company.com

244 ntp
20 ost

The ost command manages OpenStorage (OST), which is a feature


of Symantecs Veritas NetBackup backup and recovery product.
OST integrates NetBackup with disk backup devices, such as Data
Domain systems. OST is a licensed feature. If basic options do not
work, verify that OST licensing has been implemented on your
Data Domain system.
The ost command includes the following options.
destroy Delete all LSUs and their contents from Page247
the Data Domain system.
disable Disable OST. Page248
enable Enable OST. Page247
ifgroup For Advanced Load Balancing and Page248
Failover: Manage interface groups (IP
addresses) on a Data Domain private
network that distributes data transfer.
lsu Create and delete an LSU, or list the LSUs Page250
and images in an LSU.
opt-dup Set, reset, or show the status of the low- Page251
bandwidth optimization option for
optimized duplication. Show or reset
statistics, history, and performance.
option Set, reset, or show the status of the Page255
Distributed Segment Processing option.
reset Delete the OST user and reset statistics. Page256
Clear all job connection counters shown in
the output of the ost show
connections command in the event that
network connection is lost.
set user-name Set an OST user. Page256

DD OS 4.9 Command Reference Guide 245


show Show the OST user name, connections, Page257
OST histogram, statistics, or OST image-
duplication status.
status Show whether OST is enabled or disabled. Page259

About the ost Command


The ost command allows you to create and delete logical storage
units (LSUs) on the storage server and to display LSUs disk space
usage. The LSUs and their contents remain in the Data Domain file
system even if you subsequently disable OST. Once you re-enable
OST, you can use these LSUs again.
OST commands also support the following major features.

Advanced Load Balancing and Failover


Configuring an interface group creates a private network within
the Data Domain system, comprised of the IP addresses
designated as a group interface. The group interface uses the
Advanced Load Balancing and Failover feature to improve data
transfer performance and increase reliability.
In the Symantec NetBackup environment, media server clients use
a single public network IP address to access the Data Domain
system. All communication with the Data Domain system is
initiated via this master IP connection, which is configured on the
NetBackup server. This public network also processes data
transfer, that is, backups and restores.
If an interface group is configured, when the Data Domain system
receives data from the media server clients, the data transfer is
load balanced and distributed as separate jobs on the private
network, providing higher input/output throughput, especially
for customers who use multiple 1 GigE connections.
The data transfer is load balanced based on the number of
connections outstanding on the interfaces. Only connections for
backup and restore jobs are load balanced.
Note: You manage Advanced Load Balancing and Failover via the
ost ifgroup commands.

246 ost
Distributed Segment Processing
The Distributed Segment Processing feature increases backup
throughput in almost all cases by eliminating duplicate data
transmission between the media server and the Data Domain
system.
Note: You manage Distributed Segment Processing via the ost
option commands.

Low-Bandwidth Optimization
NetBackup customers who utilize optimized duplication over a
low-bandwidth network (WAN) can increase image duplication
speed by using low-bandwidth optimization (low-bw-optim). This
feature provides additional compression during data transfer.
Low-bandwidth compression is available to Data Domain systems
with an installed Replication license.
Note: You manage low-bandwidth optimization via the ost
opt-dup commands.

ost Command Options

enable
ost enable
Administrators use this command to create and export the
/backup/ost directory.

Whenever the user, user ID (UID), or group ID (GID) changes, the


Data Domain system updates all images and LSUs the next time
that the ost enable command is issued.

destroy
ost destroy
Administrators use this command to delete all LSUs and their
contents from the Data Domain system. The command
permanently removes all of the data (images) contained in the
LSUs.

DD OS 4.9 Command Reference Guide 247


You must also manually remove (expire) the corresponding
NetBackup catalog entries.

disable
ost disable
Administrators use this command to disable OST for the Data
Domain system.

ifgroup
Notes:

ifgroup is an interface group.


Advanced Load Balancing and Failover is not supported for a
Global Deduplication Array.

ifgroup add interface


ost ifgroup add interface ipaddr
Administrators use this command to add an IP address to a private
network that is to process data transfer. The IP address must be
configured on the Data Domain system, and its interface enabled.
The command checks if the IP address is valid. If not, a message
reports the IP address is invalid (either because it is not configured
on the Data Domain system, or its interface is not enabled). Use the
net show settings or net show config commands to view
available IP addresses.
If the IP is valid, the message IP added to list is displayed.
After adding an IP address as an interface, you need to enable
Advanced Load Balancing and Failover using the ost ifgroup
enable command.

Failover is not an automatic process. If an interface (or a NIC that


has multiple interfaces) fails, all the in flight jobs to that interface
fail and need to be restarted by the backup administrator.
However, any jobs that are started subsequent to the failure will
get routed to the healthy interfaces.

248 ost
Notes:
1 GigE and 10GigE connections cannot be used in the same
interface group.
You can add public or private IP addresses for data transfer
connections.

ifgroup del interface


ost ifgroup del interface ipaddr
Administrators use this command to remove a valid IP address
added as an interface.
If you are attempting to delete the last IP address interface, you are
informed that the ifgroup will be disabled and are given the option
of terminating this command.

ifgroup disable
ost ifgroup disable
Administrators use this command to disable the Advanced Load
Balancing and Failover option for new jobs. Currently running jobs
are not affected.
If the OST feature is disabled, the message disabled is displayed.

ifgroup enable
ost ifgroup enable
Administrators use this command to enable Advanced Load
Balancing and Failover. At least one IP address must have already
been added.

ifgroup show config


ifgroup show config
Use this command to show the IP addresses that have been added
to the ifgroup.

DD OS 4.9 Command Reference Guide 249


ifgroup reset
ifgroup reset
Administrators use this command to reset Advanced Load
Balancing and Failover links.
For a reset to occur, the Advanced Load Balancing and Failover
feature must be disabled; and there must be no active jobs. If there
are active jobs, a message informs you that the system is busy and
that jobs need to complete. You are asked to try again later.
If the Advanced Load Balancing and Failover links are reset, a
message to this effect is displayed.

ifgroup status
ifgroup status
Use this command to show whether OST Link Aggregation is
enabled or disabled.

lsu
lsu create
ost lsu create lsu-name
Administrators use this command to create an LSU with a given
name.
Note: If you invoke the filesys destroy command, you need to
run ost disable followed by ost enable and then create an LSU
using ost lsu create. If you do not run this series of commands,
the Data Domain system reports an error.

lsu delete
ost lsu delete lsu-name
Administrators use this command to delete a specified LSU and all
of its contents. You must also manually remove (expire) the
corresponding NetBackup catalog entries.

250 ost
lsu show
ost lsu show [compression] [lsu-name]
Use this command to display the names of all LSUs or, optionally,
the names of all images in a specified LSU.
To display the compression for all LSUs (the original byte size,
global compression, and local compression for all LSUs), enter the
compression option.
Note: To interrupt the output of this command, press Ctrl+C.

opt-dup
Note: The low-bandwidth optimization option is not supported in
a Global Deduplication Array.

opt-dup option reset


ost opt-dup option reset {low-bw-optim}
Administrators can use this command to reset low-bandwidth
optimization to its default value, which is disabled.

opt-dup option set low-bw-optim


ost opt-dup option set low-bw-optim {enabled | disabled}
Low-bandwidth optimization, which is disabled by default, is
designed for use on networks with less than 6 Mbps aggregate
bandwidth. Do not use this option if maximum filesystem write
performance is required.
This command, which is available to administrators only, must be
entered on both Data Domain systemsthe source and destination
(target) systems.
After you enable low-bandwidth optimization on both systems,
both systems must undergo a full cleaning cycle to prepare the
existing data. Enter this CLI command on the source and
destination systems:
# filesys clean start
The amount of time the cleaning cycle takes depends on the
amount of data currently on the Data Domain system.
DD OS 4.9 Command Reference Guide 251
opt-dup option show
ost opt-dup option show [low-bw-optim]
Use this command to show whether low-bandwidth optimization
is enabled or disabled for optimized duplication.

opt-dup reset stats


ost opt-dup reset stats
Administrators can use this command to reset opt-dup statistics
when OST is enabled.

opt-dup show active


ost opt-dup show active
Use this command to show the status of an OST image duplication
transfer to a destination Data Domain system.
The low-bandwidth optimization status output indicates either
that it is enabled and running, or that it is enabled but there is a
configuration mismatch.
04/28 11:29:43
Outbound image name /backup/example.tar
Target host name 127.2.0.1
Low-bw-optim enabled and running
Logical bytes to transfer 436,874,240
Logical bytes already transferred 104,659,157

opt-dup show history


ost opt-dup show history [ duration duration{day | hr}]
[interval hr]
Use this command to show the data transfer history between the
source and destination (target) Data Domain systems. The
following information is shown for inbound and outbound traffic
for a given duration at a specified interval:
amount of pre-compressed data in KB
amount of post-compressed data in KB
network transfer data in KB
252 ost
low-bandwidth optimization factor
number of errors

Example of OST opt-dup show history command output:


Date Time Direction Pre-Comp Post-Comp Network Low- Errors
(KB) (KB) (KB) bw-
optim

2009/ 11:14 Inbound 47,738 26,634 27,527 1.32 0


08/31

2009/ 11:14:09 Outbound 14,327 8,638 9,034 1.21 0


08/31

opt-dup show image-history


ost opt-dup show image-history [duration duration{day | hr}]
Use this command to show the data transfer history for inbound
and outbound traffic on each image in Data Domain systems
backup directory for a given duration at a specified interval. The
following is shown for inbound and outbound traffic by date and
time:
amount of pre-compressed data in KB
amount of post-compressed data in KB
network transfer data in KB
low-bandwidth optimization factor
number of errors

Example of OST opt-dup show image history command output:


Date Time Direction Filename Pre-Comp Post-Comp Network Low- Errors
(KB) (KB) (KB) bw-
optim

2009/ 15:13:09 Inbound /backup/s 47,738 26,634 27,527 1.32 0


08/31 ource.tar

2009/ 15:13:09 Outbound /backup/d 14,327 8,638 9,034 1.21 0


08/31 estin.tar

DD OS 4.9 Command Reference Guide 253


opt-dup show performance
ost opt-dup show performance [interval sec] [count count]
Use this command to display in real time, for a given duration at a
specified interval, the amount of pre-compressed outbound and
inbound data versus the actual network throughput, or post-
compressed data.
04/30 11:14:16
Outbound Inbound
Pre-comp Network Pre-comp Network
(KB/s) (KB/s) (KB/s) (KB/s)
--------- --------- --------- ---------
0 0 1644 325
0 0 2901 470
0 0 2430 458
0 0 14390 300
0 0 0 70
0 0 2308 446
0 0 2814 552
0 0 3010 529

opt-dup show stats


ost opt-dup show stats
Use this command to monitor outbound and inbound traffic on a
Data Domain system during replication. The compression ratio
increases when low-bandwidth optimization is enabled.
Direction: Outbound
Network bytes sent: 88,383,976
Pre-compressed bytes sent: 436,874,240
Bytes after filtering: 153,080,417
Bytes after low-bw-optim: 145,547,868
Bytes after local compression: 83,628,271
Compression ratio: 4.9

Direction: Inbound
Network bytes received: 88,383,976
Pre-compressed bytes received: 436,874,240
Bytes after filtering: 153,080,417
Bytes after low-bw-optim: 145,547,868
Bytes after local compression: 83,628,271
Compression ratio: 4.9
254 ost
option
option set boost
ost option set boost {enabled | disabled}
Administrators can use this command to enable or disable the
Distributed Segment Processing feature on the DD OS. By default,
it is enabled for DD OS 4.9. If this feature presents any problem for
a media server, use this command to disable the feature on the
Data Domain system.
Distributed Segment Processing is supported only if the installed
version of the OST plug-in is version 2.0 or later, and the feature is
enabled on the DD OS.
Notes:
Distributed Segment Processing is enabled by default in DD
OS 4.8. If a system is upgraded from DD OS 4.6.x or 4.7.x to DD
OS 4.8, and the OST license is installed at the time of the
upgrade, Distributed Segment Processing is not automatically
enabled.
The Distributed Segment Processing feature is enabled in a
Global Deduplication Array, you cannot disable it.

option reset
ost option reset [boost]
Administrators use this command to reset Distributed Segment
Processing to the default option, which is enabled.

option show
ost option show [boost]
Use this command to show whether the Distributed Segment
Processing option is enabled or disabled.

DD OS 4.9 Command Reference Guide 255


reset
reset user-name
ost reset user-name ost-user
Use this command to delete the ost-user.

reset stats
ost reset stats
Administrators use this command as follows:
to reset all statistics when OST is enabled, or
as a network recovery procedure to clear job connections after
the network connection has been lost.

set user-name
ost set user-name ost-user
Administrators use this command to set the OST user name when
OST is enabled.
You must disable and then re-enable OST for OST user-name
modifications to take effect.
There can be only one OST user at a time. The username and
password must have already been set up on the Data Domain
system by using the DD OS CLI command: user add
username [password password]

The user must be configured in NetBackup to connect to the


Data Domain system.

256 ost
show
show connections
ost show connections
Use this command to show the following information:
the number of active clients, and for each active client:
the clients name
whether or not the client is idle (yes/no)
the number of installed CPUs
the amount of memory in MiB
the installed OST plug-in version number
the name and version of the operating system
the NetBackup version number.
the number of connections that a system uses for OST, and
whether these connections are spread across interfaces using
Advanced Load Balancing and Failover. (See sample output for
client connections below.)
the number of connections used for a given group, even when
the interface has been removed from the ifgroup.
an overview of interfaces available for OST.
Note: For a Global Deduplication Array, the ifgroup status is
always disabled, and the member column value is always no.
Client Connections:
Max Client Connections: 65
ifgroup status: Disabled

Interface ifgroup -------------- Connections --------------


member Backup Restore Control* Total
----------------- -------- -------- -------- -------- --------
192.168.52.193 no 0 0 10 10
----------------- -------- -------- -------- -------- --------
Total Connections 0 0 10 10
----------------- -------- -------- -------- -------- --------
* Control connections for opt-dup, image operations

DD OS 4.9 Command Reference Guide 257


show histogram
ost show histogram op
Use this command to display an OST histogram for the Data
Domain system.
op The name of the NFS operation.
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.
2,4,6,8, or The number of operations that took less than the
10ms specified number of milliseconds (ms).
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.
>10s The number of operations that took over 10
seconds.

show image-duplication active


ost show image-duplication active
Use this command to show the OST image duplication status.

show stats
ost show stats [interval seconds]
Use this command to show the output of previous show stats
command, the number of bytes written to and read from OST
images contained in LSUs, and the number of OST images created
and deleted from LSUs. The number of errors encountered for each
operation is also shown. Optionally, you can show statistics for a
specific number of seconds.

258 ost
If Distributed Segment Processing is enabled, the number of bytes
transferred and the amount of compression achieved is displayed.

show user-name
ost show ost-user
Use this command to display the current OST user.

status
ost status
Enter this command to determine whether OST is enabled or
disabled.

DD OS 4.9 Command Reference Guide 259


260 ost
21 replication

The replication command manages the mirroring of data


between Data Domain systems. Replication is a licensed feature. If
basic options do not work, check that licensing is implemented.
The replication command includes the following options.
abort Stop an ongoing resync process. Page263
add Create a replication pair. Page263
break Destroy a replication pair. Page264
disable Temporarily suspend a replication pair. Page265
enable Restart replication that was temporarily Page265
halted (with disable).
initialize Start replication between a source and a Page266
destination.
modify Modify replication host connection Page266
parameters.
option Manage replication connection options. Page269
reauth Reset authentication between a source and Page271
a destination.
recover Move data from a surviving destination to Page271
a new source.
resync Resynchronize broken directory Page272
replication.
show Display replication information. Page272
status Show replication status. Page282
sync Synchronize a replication pair. Page284
throttle Reduce the network bandwidth rate. Page284
watch View the real-time status of replication. Page287

DD OS 4.9 Command Reference Guide 261


About the replication Command
Replication can be implemented as either a collection or a
directory:
Collection replication replicates the complete /backup
directory from one Data Domain system (a source) to another
Data Domain system (a destination). Each Data Domain system
is dedicated as a source or a destination and each can be in only
one replication pair. The destination is a read-only system
except for receiving data from the source. In addition to
/backup certain system files, such as /etc/passwd, are also
replicated.
Directory replication provides replication at the level of
individual directories.
Each Data Domain system can be the source or the destination
for multiple directories and can also be a source for some
directories and a destination for others. During directory
replication, each Data Domain system can also perform normal
backup and restore operations. Replication command options
with directory replication may target a single replication pair
or may target all pairs that have a source or destination on the
Data Domain system. Each replication pair configured on a
Data Domain system is called a context.
In the command options, a specific replication pair is always
identified by the destination.
A single destination Data Domain system can receive backups
from both CIFS clients and NFS clients as long as separate
directories are used for CIFS and NFS. Do not mix CIFS and NFS
data under the same directory.
VTL pool replication is the same as directory replication when you
configure replication and when you use the replication
command (except for the destination name limitation mentioned in
the add option).

262 replication
replication Command Options

abort
abort recover
replication abort recover destination
Use this command to stop a recover process. This command can
be executed only on the destination. Once the command is
executed, reconfigure replication on the source and restart the
recover process.

abort resync
replication abort resync destination
Use this command to stop an ongoing resync operation. This
command can be invoked from either the source or the destination
directory replication systems.

add
replication add source source destination destination
[low-bw-optim {enabled | disabled}]
Use this command to create a replication pair on both the source
and destination Data Domain systems. This command is available
to administrative users only.
Note: This command is just one of the commands that are used to
create a replication pair. Refer to the entire procedure in
Configuring Replication on page 288 before using this command.

The source and destination hostnames must be the names


returned by the hostname command for the source and
destination Data Domain systems.
When a Data Domain system is at or near full capacity, the
command may take 15 to 20 seconds to finish.
Use low-bw-optim enabled to enable delta replication. The
default is disabled. This option is only active when it is
enabled on both the source and the destination.
DD OS 4.9 Command Reference Guide 263
When you configure collection replication, the source and
destination parameters must start with col://. For example,
enter a command similar to the following on the source and
destination Data Domain systems:
# replication add source col://hostA destination
col://hostB
When you configure directory replication, the source and
destination parameters must start with dir://. The source and
destination include the host and backup directory names. For
example, enter a command similar to the following on the source
and destination Data Domain systems:
# replication add source dir://hostA/backup/dir2
destination dir://hostB/backup/hostA/dir2
Note: When the hostname for a source or destination does not
correspond to the network name through which the Data Domain
systems will communicate, use replication modify connection
-host command on the other system to direct communications to
the correct network name.

break
replication break {destination | all}
Use this command to remove either the source or the destination
Data Domain system from a replication pair, or to remove all
Replicator configurations from a Data Domain system. A
destination variable or all is required.

Note: This command is just one of the commands that are used to
remove a replication pair. Refer to the entire procedure in Delete a
Replication Pair on page 293 before using this command.

264 replication
disable
replication disable {destination | all}
Use this command to temporarily halt the replication of data
between the source and the destination on either the source or the
destination. While replication is disabled, you can change the
bandwidth and delay parameters on both sides of the connection
with the replication option set command.
On the source, the operation stops the sending of data to the
destination. On the destination, the operation stops serving the
active connection from the source. If the file system is disabled on
either Data Domain system when replication is disabled,
replication remains disabled even after the file system is restarted.
This command is available to administrative users only.
Note: The replication disable command should be used as a
short-term solution. A filesys clean operation may proceed
very slowly on a replication context when that context is disabled,
and cannot reclaim space for files that are deleted but not yet
replicated. Use the replication break command to permanently
stop replication and to avoid slowing filesys clean operations.
Note: Using the command replication break on a collection
replication replica or recovering originator requires the use of
filesys destroy on that machine before the file system can be
enabled again.

enable
replication enable {destination | all}
Use this command to restart replication that is temporarily halted
on the Data Domain system that was temporarily halted. On the
source, the operation resumes the sending of data to the
destination. On the destination, the operation resumes serving the
active connection from the source. If the file system is disabled on
either Data Domain system when replication is enabled,
replication is enabled when the file system is restarted. This
command is available to administrative users only.

DD OS 4.9 Command Reference Guide 265


Note: If the source Data Domain system received large amounts of
new or changed data during the halt, resuming replication may
significantly slow down filesys clean operations.

initialize
replication initialize destination
Use this command on the source to start replication between a
source and destination. The command checks that the
configuration and connections are correct and returns error
messages if any problems appear. If the source holds a lot of data,
the initialize operation can take many hours. 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.
A destination variable is required. This command is available to
administrative users only.
Note: This command is just one of the commands that are used to
create a replication pair. Refer to the entire procedure in
Configuring Replication on page 288 before using this command.

modify
modify low-bw-optim
replication modify destination low-bw-optim {enabled |
disabled}
Use this command to enable delta replication on an existing
replication context. This option is only active when it is enabled on
both the source and the destination. This command is available to
administrative users only.

266 replication
modify source-host or destination-host
replication modify destination {source-host | destination-host}
hostname
Use this command when replacing a system in a replication pair to
assign a new name for the replacement system on the other side of
the replication pair. The hostname must be the name returned by
the hostname command on the system receiving the new
hostname.
If you are changing the hostname on an existing source Data
Domain system, use the replication modify command on the
destination. Do not use the command if you want to change the
hostname on an existing destination. Call Data Domain Technical
Support before changing the hostname on an existing destination.
When using the replication modify command, always run the
filesys disable command first and the filesys enable
command after. This command is available to administrative users
only.
For example, if the local destination dest-orig.ca.company.com
is moved from California to New York, run a command similar to
the following on both the source and destination:
# filesys disable
# replication modify
dir://ca.company.com/backup/dir2 destination-host
ny.company.com
# filesys enable

DD OS 4.9 Command Reference Guide 267


modify connection-host
replication modify destination connection-host hostname [port
port]
A source Data Domain system connects to the destination Data
Domain system using the destination name as returned by the
hostname command on the destination (either name or IP
address). If the destination hostname does not resolve correctly for
the connection, use the modify connection-host option to
correct the name (or IP address) for the connection. An optional
port number can 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.
The option may be needed after adding a new source and
destination pair or after renaming either a source or a destination.
The following example is run on the source to change the
destination host ny.company.com to ny2.company.com. Note
that the destination variable for the context does not change and is
still ny.company.com/backup/dir2.
# replication modify
dir://ny.company.com/backup/dir2 connection-host
ny2.company.com

268 replication
modify connection-host port
replication modify destination connection-host hostname [port
port]
The default listen-port for a destination Data Domain system is
2051. Use the replication modify command on a source to
change the port to which the source sends data. A destination can
have only one listen port. If multiple sources use one destination,
each source must send to the same port.
Note: See the procedure Change the Destination Listen Port on
page 297 for an example using this command.

option
option reset
replication option reset {bandwidth | delay | listen-port}
To reset system bandwidth to the default of unlimited or delay to
the default of none, or listen port to 2151, use the replication
option reset operation. Use the filesys disable command
before making changes and use the filesys enable command
after making changes.

option set bandwidth


replication option set bandwidth rate
Use this command to set the network bandwidth rate for the Data
Domain system.
Caution: If you set bandwidth or delay you MUST set both, and
they must be set on both sides of the connection.

DD OS 4.9 Command Reference Guide 269


option set delay
replication option set delay value
Use this command to set the network delay in milliseconds for the
Data Domain system.
Caution: If you set bandwidth or delay you MUST set both, and
they must be set on both sides of the connection.
Using bandwidth and network-delay settings together, replication
calculates the proper tcp buffer size for replication usage.
This should be needed only for high-latency, high-bandwidth
WANs in which the default tcp setting is not good enough to
provide best throughput.
For a destination with multiple sources, use the values with the
maximum product.
Note: This command is just one of the commands that are used to
set the replication bandwidth and delay. Refer to the entire
procedure in Set Replication Bandwidth and Network Delay on
page 298 before using this command.

option set listen-port


replication option set listen-port value
Use this command to 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 (port
2051 by default). A destination can have only one listen-port that
must be used by all sources. The connection-host port used by a
source must match the listen-port used by the destination.

option show
option show
Use this command to display the current bandwidth and delay
settings. If these settings are at the default of none, the operation
returns just a command prompt with no setting information.

270 replication
reauth
replication reauth destination
To reset authentication between a source and destination, use the
replication reauth command on both the source and the
destination. A destination variable is required. This command is
available to administrative users only.
Messages similar to Authentication keys out of sync or Key out
of sync signal the need for a reset. Reauthorization is primarily
used when replacing a source Data Domain system. See Replace a
Directory SourceSame Directory Name on page 296.

recover
replication recover destination
To move data from a surviving destination to a new source, use the
replication recover command on the new source. This
command is available to administrative users only.
A destination variable is required.
This command must be invoked only from the source.
With collection replication, first use the filesys disable and
filesys destroy commands on the new source.

If the replication break command was run earlier, the


destination cannot be used to recover a source.
With directory replication, the target directory on the source
must be empty. See Create Many-to-One Directory Replication on
page 291.
Use the replication watch command to display the progress of
the recovery process.

DD OS 4.9 Command Reference Guide 271


resync
replication resync destination
To resynchronize replication when directory replication is broken
between a source and destination, use the replication resync
command. (Both source and destination must already be
configured.)
Note: This command cannot be used with collection replication.
A replication resynchronization is useful when converting from
collection replication to directory replication or when a directory
replication destination runs out of space while the source
destination still has data to replicate. See Recover from a Full
Replication Destination on page 294 for an example of using the
command when a directory replication destination runs out of
space.
Note: If you try to replicate to a Data Domain system that has
retention-lock enabled, and the destination is not empty,
replication resync does not work.

show
show config
replication show config [destination | all]
Use this command to display configuration parameters for a
specific destination or for all destinations.
On the replica, the per-context display is modified to include an
asterisk; if at least one context was marked with an asterisk, the
footnote Used for recovery only is also displayed.
The display with a destination variable is similar to the
following. The all option returns a similar display for each
context.
# replication show config dir://host3.company.com/backup/dir2
CTX: 2
Source: dir://host2.company.com/backup/host2
Destination: dir://host3.company.com/backup/host2
Connection Host: ccm34.datadomain.com

272 replication
Connection Port: (default)
Low-bw-optim: enabled
Enabled: yes
# replication show config all
CTX: 1
Source dir://syrah22.datadomain.com/backup/syrah22
Destination dir://dd580.pr.datadomain.com/backup/syrah22
Connection Host: dd580.princeton.datadomain.com
Connection Port: (default)
Low-bw-optim: enabled
Enabled: yes
The columns in the output are:

CTX The context number for directory replication or a 0


(zero) 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 A source Data Domain system connects to the
Host and destination Data Domain system using the destination
Port name as returned by the hostname command on the
destination or by using a destination name or IP
address and port given with the replication
modify connection-host command. The
destination hostname may not resolve to the correct IP
address for the connection when connecting to an
alternate interface on the destination or when a
connection passes through a firewall.
Low-bw- The active status of low-bw-optim: enabled,
optim disabled, or configuration mismatch.
Enabled The replication process is yes (enabled and available
to replicate data) or no (disabled and not available to
replicate data).

DD OS 4.9 Command Reference Guide 273


show detailed-history
replication show detailed-history {destination | all} [duration
duration {hr | min}] [interval number {hr | min}]
Use this command to display statistics accumulated over the
specified interval. This command provides byte-count statistics
related to identity-filtering, delta-compression, and local-
compression. The ratio of the columns Replicated Post-
filtered and Replicated Post-low-bw-optim gives the
additional compression ratio supplied by delta compression.

show detailed-stats
replication show detailed-stats [destination | all]
Use this command to display cumulative stats since the context
was created. This command provides byte-count statistics related
to identity-filtering, delta-compression, and local-compression.
The ratio of the byte values Bytes after filtering by
destination to Bytes after low bandwidth optimization
gives the additional compression ratio supplied by delta
compression.

show history
replication show history {destination | all} [duration duration
{hr | min}] [interval number {hr | min}]
To display a history of replication, use the replication show
history command. Statistics are generated only once an hour, so
the smallest interval that appears is one hour.
The columns in the output are:
Pre-Comp (KB) The amount of pre-compression data that is not
Remaining replicated.
Replicated (KB) The amount of pre-compressed data that is
Pre-Comp replicated.
Replicated (KB) The amount of compressed data sent over the
Network network.

274 replication
Synced-as-of The time when the most recently replicated
Time 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.

show performance
replication show performance {obj-spec-list | all} [interval
sec] [count count]
To display current replication activity, use the replication show
performance command. The default interval is two seconds.

If only a single source context is specified, four additional columns


are presented. These columns show the relative amounts of time
spent working or waiting by replication sender threads for the
specified context. The values are calculated by taking the amount
of time spent for the given activity, multiplying by 100, and
dividing 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.
The columns and their meanings are as follows:
Pre-comp The size value before compression is applied.
(KB/s) Sometimes referred to as logical size.
Network The amount of compressed data per second
(KB/s) transferred over the network.
Streams An internal system resource associated with
reads and writes. Assuming more system
streams are actually available, one replication
context can use multiple streams for better
performance.
Reading The time reading file system data from the
local file system. Typically this number is the
second highest number (after Network, below).
On a deployment with high network
bandwidth, Reading may be the largest of the
columns.

DD OS 4.9 Command Reference Guide 275


Meta The time spent on miscellaneous bookkeeping
acclivities, as well as replicating filesystem
namespace operations. Normally 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
having given the sender more information
about what data to send. Normally 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 number of additional replication contexts.
Network The time spent sending file data and metadata,
and waiting for replies from the server about
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 unreplicated files in parallel.
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.
The following example was captured while initializing replication
over a 100Mbps network. The output shows the following:
The ratio between Pre-comp and Network is approximately 2:1.
This is because replication is having to send all of the segments
from the source to the destination. Local compression is
responsible for the 2:1 ratio.
At 100Mbps, the source spends most of its time waiting (in the
Network column) for socket send buffer space to clear. The
source has previously sent data which has not yet been
received. The other source of time waiting is file system reads
(Reading column).

276 replication
The value of 3 for Streams means that replication is sending
three files in parallel for this context.
# replication show performance rctx://1
07/31 10:09:27
rctx://1
Pre-comp Network Streams Busy Waiting
(KB/s) (KB/s) Reading Meta Dest Network
--------- --------- ------- -------------- --------------
21798 10173 3 31 0 0 264
19914 9427 3 27 0 0 269
23091 11314 3 42 0 0 253
19446 9161 3 20 0 0 276
24002 11604 3 52 0 0 242
22725 10829 3 47 0 0 248
18662 9119 3 41 0 0 254
24263 11355 3 31 0 0 264
20179 9640 3 28 0 0 267
23887 11162 3 40 0 0 255
21125 9957 3 23 0 0 272

DD OS 4.9 Command Reference Guide 277


The next example shows the command output from the same
system, this time with the replication throttle removed. In this
example, most of the time is spent in filesystem reading, as
expected.
Note: These examples use older Data Domain Systems, so the
numbers are lower than users should expect to see with newer
models.
# replication show performance rctx://1
07/31 10:20:13
rctx://1
Pre-comp Network Streams Busy Waiting
(KB/s) (KB/s) Reading Meta Dest Network
--------- --------- ------- -------------- --------------
35864 16778 3 253 0 0 12
38120 17925 3 243 0 0 12
34004 15536 3 238 0 0 11
40418 18972 3 252 0 0 11
32612 15574 3 251 0 0 12
33133 15839 3 253 0 0 13
36273 17530 3 237 0 0 18
30522 14467 3 272 0 0 9
36398 17372 3 256 0 0 16
24684 12150 3 260 0 0 12
38906 18293 3 246 0 0 17

278 replication
show stats
replication show stats [destination | all]
To display replicator statistics for all replication pairs or for a
specific destination pair, use the replication show stats
command.
The display is similar to the following:
# replication show stats

CTX Destination Post-comp Pre-comp


Bytes Sent Bytes Sent
--- ------------------------ ------------- -------------
1 dir://33.dd.com/backup/c 1,300,752,840 5,005,099,008
2 dir://r4.dd.com/backup/r 918,769,652 829,429,248
--- ------------------------ ------------- -------------

Post-comp Bytes Sync'ed-as-of Pre-comp Bytes


Received Time Remaining
--------------- ---------------- --------
2,380,674,376 Mon Mar 17 13:06 0
52,400,012 Mon Mar 17 13:06 0
--------------- ---------------- --------

To display statistics for the destination labeled as context 1, use the


following command:
# replication show stats rctx://1

CTX: 1
Destination: dir://33.company.com/backup/rig14_8
Network bytes sent: 3,904
Pre-compressed 612
bytes sent:
Compression ratio: 0.0
Sync'ed-as-of time: Tue Dec 11 18:30
Pre-compressed 0
bytes remaining:

DD OS 4.9 Command Reference Guide 279


The columns in the output are:
CTX The context number for directory replication or a 0
(zero) for collection replication
Destination The replication destination.
Network The count of bytes sent over the network. Does not
bytes sent include TCP/IP headers. Does include internal
replication control information and metadata, as
well as file system data.
Post- For the source, the actual (network) data sent by the
compressed source. For Destination, the actual (network) data
bytes sent sent by the destination to the source.
Pre- The number of pre-compressed bytes sent by the
compressed source. Note: this includes logical bytes associated
bytes sent with the current file thats being replicated.
Synced-as- The time when the most recently replicated data on
of-Time the destination was generated on the source. A
value of unknown appears during replication
initialization.
Pre- (directory replication only The sum of the size(s) of
compressed the file(s) remaining to be replicated for this context.
bytes Note: this includes the *entire* logical size of the
remaining current file being replicated, so if a very large file is
being replicated, this number may not change for a
noticeable period of time; it only changes after the
current file finishes.
Compression The ratio of pre-compressed bytes transferred to
ratio network bytes transferred.
Compressed (collection replication only) The amount of
data compressed file system data remaining to be sent.
remaining

Below is some actual output for replication show stats all.


In this example, an engineer created a file a bit larger than 1 GB by
writing some data. Then he created seven copies of it using
filesystem fastcopy. The fact that he wrote only approximately
1 GB shows up in the Pre-compressed bytes written to
source column; Network bytes sent to destination is a bit larger
than this, due to metadata exchanged as part of the replication
protocol. The Pre-compressed bytes sent to destination

280 replication
column gives the full (approximately) 8 GB, being the sum of the
sizes of the eight files involved. 7.6 is the ratio between pre-comp
bytes sent and network bytes sent.

Originator:
sym2# replication show stats all
CTX: 1
Destination:
dir://syrah33.datadomain.com/backup/example

Network bytes sent to destination: 1,134,514,576


Pre-compressed bytes written to source: 1,073,741,824
Pre-compressed bytes sent to destination: 8,590,163,968
Pre-compressed bytes remaining: 0
Files remaining: 0
Compression ratio: 7.6
Sync'ed-as-of time: Wed Apr 2 16:40

Replica:
sym3# replication show stats all
CTX: 1
Destination:
dir://syrah33.datadomain.com/backup/example

Network bytes received from source: 1,134,515,676


Pre-compressed bytes written to source: 1,073,741,824
Pre-compressed bytes sent to destination: 8,590,163,968
Pre-compressed bytes remaining: 0
Files remaining: 0
Compression ratio: 7.6
Sync'ed-as-of time: Wed Apr 2 16:40

DD OS 4.9 Command Reference Guide 281


status
replication status [destination | all]
To display replicator configuration information and the status of
replication operations, use the replication status command.
With the all option, the display is similar to the following:
# replication status all
CTX: 1
Mode: source
Destination:
dir://dd580.princeton.datadomain.com/backup/syrah22
Enabled: yes
Low bandwidth optimization: enabled
Local filesystem status: enabled
Connection: connected since Thu Sep 24 00:46:58
State: normal
Error: no error
Sync'ed-as-of time: Tue Oct 27 14:57
Current throttle: unlimited
The columns in the output for all are:
Mode The role of the local system: source or
destination.
Destination To be supplied.
Enabled The enabled state (yes or no) of replication
for each replication pair. This column will
show yes even if replication is enabled but
the rate is throttled to zero.
Low bandwidth To be supplied.
optimization
Local Filesystem The status (enabled or disabled) of the
Status local file system.
Connection Includes both the state and the date and
time of the last change in the connection
state.
State The state of the replication process.
Error A listing of any errors in the replication
process.

282 replication
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.
Current Throttle The current throttle setting.

The fields in the output for destination are:

Mode The role of the local system: source or destination.


Local The status (enabled or disabled) of the local file
Filesystem system.
Status
Connection Includes both the state and the date and time of the last
change in the connection state.
State The state of the replication process.
Error A listing of any errors in the replication process.
Current The current throttle setting.
Throttle

DD OS 4.9 Command Reference Guide 283


sync
replication sync destination
Use this command only on the source. The outputs current value
represents data on the source that is yet to be replicated to the
destination. The value represents only the data available at the
time the command is given.
Data received after the command begins is not added to the
output. When the current value is equal to or greater than the
outputs sync_target value, replication is complete for all of the
data that was available for replication at the time the command
began.
Output is updated periodically and the command line cursor does
not return until the operation is complete.
# replication sync
0 files flushed.
current=2832642 sync_target=2941532 head=2841234

sync status
replication sync status destination
To check on progress when running the sync start command,
use the replication sync status command.

throttle
throttle add
replication throttle add sched-spec rate
To change the rate of network bandwidth used by replication, use
the throttle add command. By default, the network bandwidth
use is unlimited (as fast as possible at all times). This command is
available to administrative users only.
Replication runs at the given rate until the next scheduled change
or until new throttle commands force a change.
Note: The system enforces a minimum rate of 98,304 bits per
second (12 KiB).

284 replication
The sched-spec must specify either:
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 of the
week)
A time of day in 24-hour military time
The rate includes a number or the word unlimited. Rate can also
be 0 (the zero character), disable, or disabled (each stops
replication until the next rate change). If you set rate to zero, any
new contexts also get 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
(for example, 2000 KiB). The default rate is bits per second.
In the rate variable:
bps or b equals raw bits per second

Kibps, Kib, or K equals 1024 bits per second

Bps or B equals bytes per second

KiBps or KiB equals 1024 bytes per second

Note: Kib = Kibibits, the base-2 equivalent of Kb or Kilobits.


KiB = Kibibytes, the base-2 equivalent of KB or Kilobytes.
For example, the following command limits replication to 20
kibibytes per second starting on Mondays and Thursdays at 6:00
a.m.:
# replication throttle add mon thu 0600 20KiB

DD OS 4.9 Command Reference Guide 285


throttle del
replication throttle del sched-spec
To remove one or more throttle schedule entries, use the throttle
del command. This command is available to administrative users
only.
The sched-spec 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 of the
week)
A time of day in 24-hour military time
For example, the following command removes an entry for
Mondays at 11:00 a.m.:
# replication throttle del mon 1100

throttle reset
replication throttle reset {current | override | schedule |
all}
This command can reset a throttling schedule:.
current Remove the rate set by the replication
throttle set current command.
override Remove the rate set by the replication
throttle set override command.
schedule Remove all scheduled change entries.
all Remove any current or override settings and
remove all scheduled change entries, returning
the system to the default settings.

This command is available to administrative users only.

286 replication
throttle set
replication throttle set {current | override} rate

Use this command to set a throttle override. The options are:


current Set the throttle rate until the next scheduled
change or until a system reboot. (See the rate
explanation for the replication throttle
add command above.) current cannot be set if
the replication throttle set override
command is in effect.
override Set the throttle rate until another override
command is invoked. (See the rate explanation
for the replication throttle add
command above.) override cannot be set if the
replication throttle set current
command is in effect.

This command is available to administrative users only.

throttle show
replication throttle show [KiB]
Use this command to display all scheduled throttle entries and
rates. Use the KiB option to display the rate in Kibibytes (the base-
2 equivalent of Kilobytes) per second. Without the option, the rate
is displayed in bits per second.

watch
replication watch destination
Use this command to display the progress of a replication
initialization, resync, or recovery operation. This command is
available to administrative users only.

DD OS 4.9 Command Reference Guide 287


replication Examples

Configuring Replication
Before starting the replication configuration, be sure to consider
the following:
Ensure adequate storage is available on the source and
destination. At a minimum, the destination must have more
space than the source.
Determine the type of replication configuration to use.
Ensure the destination directory is empty or its contents are not
required, as it will be overwritten.

Limitations
Before configuring directory replication, review the following
information.
Table 21-1: Maximum Contexts for Directory Replication
Model Maximum Number of Contexts
DD880 180
DD690 and DD690g 90
DD580, DD565, and DD560 45
DD630, DD565, and DD560 with 8 GB RAM 20
All other models 20

If the source holds a lot of data, the replication operation can


take many hours. Consider putting both Data Domain systems
in the Replicator pair in the same location with a direct link to
cut down on initialization time.
A subdirectory that is under a source directory in a replication
context cannot be used in another directory replication context.
A directory can be in only one context at a time. If it is, either
choose another or delete the system from the context.

288 replication
Configuring Replication Pairs
Create either a collection or directory replication pair, as described
in the following sections.

Create Collection Replication


1. Run this command on both the source and destination Data
Domain systems:
filesys disable
2. Run this command on the destination Data Domain system:
filesys destroy
3. Run this command on both the source and destination Data
Domain systems:
replication add source col://hostA destination
col://hostB
Once it is verified that both Data Domain systems in the pair can
communicate, the Replicator process starts. If a problem arises,
such as that communication between the Data Domain systems is
not possible, you do not need to re-initialize after fixing the
problem. Replication should begin as soon as the Data Domain
systems can communicate.
After replication is initialized, ownership and permissions of the
destination directory are always identical to those of the source
directory.
Test results from Data Domain returned the following guidelines
for estimating the time needed for replication initialization. Note
that the following are guidelines only and may not be accurate in
specific production environments.
Over a gibibit LAN, performance is about 70 MiB/sec of
compressed data.
Over a WAN, performance is governed by the WAN link line
speed, bandwidth, latency, and packet loss rate.

DD OS 4.9 Command Reference Guide 289


Create a Directory Replication
1. Run this command on both the source and destination Data
Domain systems:
replication add source dir://hostA/backup/dir2
destination dir://hostB/backup/dir2
2. Run this command on the source:
replication initialize
Once it is verified that both Data Domain systems in the pair can
communicate, the Replicator process starts. If a problem arises,
such as that communication between the Data Domain systems is
not possible, you do not need to re-initialize after fixing the
problem. Replication should begin as soon as the Data Domain
systems can communicate.
Note: When a new directory or pool replication pair is being
created, the source directory cannot be written to until the
replication relationship between source and destination systems
has been established. Attempts to write to the newly configured
replication source directory will fail until the replication
relationship has been established. Instead, schedule the replication
configuration at a time when backups are not occurring.
Test results from Data Domain returned the following guidelines
for estimating the time needed for replication initialization. Note
that the following are guidelines only and may not be accurate in
specific production environments.
Using a T3 connection, 100ms WAN, performance is about
40 MiB/sec of pre-compressed data, which gives data transfer
of:
40 MiB/sec = 25 seconds/GiB = 3.456 TiB/day
Using a gibibit (the base-2 equivalent of gigabit) LAN,
performance is about 80 MiB/sec of pre-compressed data,
which gives data transfer of about double the rate for a T3
WAN.

290 replication
Create Bi-Directional Directory Replication
To set up and start directory replication for dir2 from hostA to
hostB and for dir1 from hostB to hostA, follow this procedure.

1. Run this command on both the source and destination Data


Domain systems:
replication add source dir://hostA/backup/dir2
destination dir://hostB/backup/dir2
2. Run this command on both the source and destination Data
Domain systems:
replication add source dir://hostB/backup/dir1
destination dir://hostA/backup/dir1
3. Run this command on hostA:
replication initialize dir://hostB/backup/dir2
4. Run this command on hostB:
replication initialize dir://hostA/backup/dir1

Create One-to-Many Directory Replication


One source directory can be replicated to many destination
systems.
1. Run this command on both the source and destination Data
Domain systems:
replication add source dir://hostA/backup/dir2
destination dir://hostB/backup/dir2
2. Run this command on the source:
replication initialize

Create Many-to-One Directory Replication


To set up and start directory replication for directories from hostA
and hostB to hostC, follow this procedure.
1. Run this command on both hostA and hostC:
replication add source dir://hostA/backup/dir2
destination dir://hostC/backup/dir2

DD OS 4.9 Command Reference Guide 291


2. Run this command on both hostB and hostC:
replication add source dir://hostB/backup/dir1
destination dir://hostC/backup/dir1
3. Run this command on hostA:
replication initialize dir://hostC/backup/dir2
4. Run this command on hostB:
replication initialize dir://hostC/backup/dir1

Create Cascaded Directory Replication


1. When creating a cascaded directory replication, use the
procedure Create a Directory Replication on page 290 to create a
pair for dir1 from hostA to dir1 hostB.
2. Complete the cascade from dir1 hostB to dir1 hostC.

Both directory and collection replica can be part of a single


cascaded directory replication.

Create a Pool Replication


Replicating VTL tape cartridges (or pools) simply means
replicating directories that contain VTL tape cartridges (or pools).
There has been some confusion over pool replication, which is
nothing but directory replication of directories that contain pools,
and acts no differently.
All these types of directory replication are the same (except for
the destination name limitation below) when configuring
replication and when using the replication command set.
Examples in this chapter that use dir:// are also valid for
pool://. (To avoid exposing the full directory names to the
VTL cartridges, we created the UNI pool as a shorthand.
UNI stands for User to Network Interface.)
Replicating VTL pools and tape cartridges does not require the
VTL license on the destination Data Domain system.
The pool name must be unique on the destination, and the
destination cannot include levels of directories between the

292 replication
destination hostname and the pool name. For example, a
destination of pool://hostB/hostA/pool2 is not allowed.
Note: When a new directory or pool replication pair is being
created, the source directory cannot be written to until the
replication relationship between source and destination systems
has been established. Attempts to write to the newly configured
replication source directory will fail until the replication
relationship has been established. Instead, schedule the replication
configuration at a time when backups are not occurring.
1. Start the source and destination variables with pool:// and
include the pool that is the replication target. For example,
enter a command similar to the following on both Data
Domain systems:
replication add source pool://hostA/pool2
destination pool://hostB/pool2
The replication from source to destination begins.

Managing Replication

Delete a Replication Pair


1. Run the filesys disable command on the source and
destination systems.
2. Run the replication break command:
replication break {destination | all}
3. On a collection replication replica or recovering originator, use
the filesys destroy command on that machine before the
file system can be enabled again.
4. Run the filesys enable command.

With collection replication, a destination is left as a stand-


alone read/write Data Domain system that can then be
used as a source.
With collection replication, a destination cannot be brought
back into the replication pair or used as a destination for
another source until the file system is emptied with the
filesys destroy command.
DD OS 4.9 Command Reference Guide 293
With directory replication, a destination directory must be
empty to be used again (whether with the original source
or with a different source), or alternatively, replication
resync must be used.

Suspend and Resume Replication


Suspending replication temporarily pauses an active replication of
data between source and destination. On the source, the data being
sent to the destination is paused. On the destination, this operation
stops serving the active connection from the source.
1. To suspend replication from either the source or the
destination, use:
replication disable {destination | all}
2. To resume replication from either the source or the destination,
use:
replication enable {destination | all}
Replication of data is resumed.
Note: If the source Data Domain system received large amounts of
new or changed data during the halt, resuming replication may
significantly slow down filesys clean operations.

Recover from a Full Replication Destination


When using directory replication, a destination Data Domain
system can become full before a source Data Domain system
replicates all of a context to the destination.
For example, to recover a context of dir://hostA/backup/dir2,
use the following procedure:
1. On the source and destination Data Domain systems, run
commands similar to the following:
filesys disable
replication break dir://hostB/backup/dir2
filesys enable

294 replication
2. On the destination, run a file system cleaning operation:
filesys clean

DD OS 4.9 Command Reference Guide 295


3. On both the source and destination, add back the original
context:
replication add source dir://hostA/backup/dir2
destination dir://hostB/backup/dir2
4. On the source, run a replication resynchronization operation
for the target context:
replication resync dir://hostB/backup/dir2

Replace a Directory SourceSame Directory Name


If the source (hostA) for directory replication is replaced or
changed out, use the following commands to integrate (with
hostB) a new source that uses a new name (hostC).

1. If the new source has any data in the target directories, delete
all data from the directories.
2. Run the following commands on the destination:
filesys disable
replication modify dir://hostB/backup/dir2 source-
host hostC
replication reauth dir://hostB/backup/dir2
filesys enable
3. Run the following commands on the new source:
replication add source dir://hostC/backup/dir2
destination dir://hostB/backup/dir2
replication recover dir://hostB/backup/dir2
4. Use the following command to see when the recovery is
complete. Note the State entry in the output. State is normal
when recovery is done and recovering while recovery is in
progress. Also, a messages log file entry, replication
recovery completed is sent when the process is complete.
The byte count may be equal on both sides, but the recovery is
not complete until data integrity is verified. The recovering
directory is read-only until recovery finishes.

296 replication
# replication status dir://hostC/backup/dir2

CTX: 2
Mode: source
Destination: dir://hostC/backup/dir2
Enabled: yes
Local filesystem status: enabled
Connection: connected since Sat Apr8 23:38:11
State: recovering
Error: no error
Destination lag: less than 5 minutes
Current throttle: unlimited

Change the Destination Listen Port


The default IP Listen port for transmitting the data stream to the
replication destination is 2051. If a network configuration requires
a different port, it can be changed globally or per replication pair.
The following example is run on the source to inform the source
that the destination host ny.company.com has a listen-port of
2161. Then use the replication option set listen-port
command on the destination to set an alternate listen-port.
1. For example, on the source, use the command:
# replication modify
dir://ny.company.com/backup/dir2 connection-host
ny.company.com port 2161
2. On the destination, use:
# replication option set listen-port 2161
A destination can have only one listen port. If multiple sources use
one destination, each source must send to the same port.

DD OS 4.9 Command Reference Guide 297


Set Replication Bandwidth and Network Delay
Using bandwidth and network-delay settings together, replication
calculates the proper tcp buffer size for replication usage. This
should be needed only for high-latency, high-bandwidth WANs
on which the default tcp setting is sufficient to provide the best
throughput.
Caution: If you set bandwidth or delay you MUST set both.

Bandwidth and delay must be set on both sides of the connection.


For a destination with multiple sources, use the values with the
maximum product.
1. Find the actual bandwidth for each server. Find the actual
network delay values for each server (for example, by using the
ping command).
2. Disable replication on all servers:
# replication disable all
3. For each server, wait until replication status reports
disconnected:
# replication status
4. For each server, set the bandwidth to its actual value in Bytes
per second:
# replication option set bandwidth rate
Note: The replication option set of bandwidth and network
delay only needs to be executed once on any Data Domain system
even with multiple replication server contexts. The setting is global
to the box.
5. For each server, set the network delay to its actual value in
milliseconds:
# replication option set delay value
6. Re-enable replication on all servers:
# replication enable all

298 replication
Managing Delta Replication
Delta replication, also called low bandwith optimization, can
increase the virtual throughput of directory replication across links
with less than 6 Mbps of available (or throttled) bandwidth. Delta
replication incurs significant additional CPU and I/O overhead on
both the source and destination Data Domain systems. If low
bandwidth optimization is enabled across links with greater than 6
Mbps of bandwidth, it is unlikely that any gain in virtual
throughput will be realized.
Delta Replication applies more computation time to data
compression, which utilizes a low-bandwidth link more efficiently
and reduces the time required to perform replication. When a low-
bandwidth link is fully loaded, Delta Replication can cut
replication time by 50%. For high-bandwidth links (faster than T3
capacity), Delta Replication might not speed up, and could slow
down, the replication process.
Low bandwidth optimization increases the virtual throughput of
directory replication on most data sets by a factor of 2x or more.
However, low bandwidth optimization does not compress
segment metadata. If the data to be replicated is more than 96%
identical to data already existing on the destination system (that is,
the over-the-wire compression ratio reported by the replication
show stats command is 25x or more, and thus most of the
bandwidth is being consumed by segment metadata), it is unlikely
that low bandwidth optimization will increase virtual throughput
significantly.
If the data to be replicated is less than 96% identical to data already
existing on the destination system; and there is less than 6 Mbps of
available bandwidth; and both systems have spare CPU and I/O
capacity; then enable low bandwidth optimization and monitor the
output of replication show history over several weeks. The
Low-bw-optim ratio should average 2.00 or more, and the network
throughput (network bytes divided by time interval) should not be
much less than the available bandwidth.
If the Low-bw-optim ratio does not average 2.00 or more, then
delta compression is probably not effective on the data set and
should be disabled. If the network throughput is much less than
the available bandwidth, then most likely one or both Data

DD OS 4.9 Command Reference Guide 299


Domain systems do not have enough spare CPU or I/O capacity to
support delta replication, and it should be disabled.
Use the replication show command options to analyze your
replication throughput and determine whether Delta Replication is
likely to be helpful.

Determining Whether Delta Replication Increases


Compression
In some cases, Delta Replication cannot increase compression and
therefore provides no benefit. This example shows a value of 1.0
for Low-bw-optim, the low bandwidth optimization ratio. This is a
ratio of bytes before applying delta compression to bytes after
delta compression; that is, the additional compression delta has
added.
destination# replication show history all
Directory Replication:
Date Time CTX Pre-Comp (KB) Pre-Comp (KB)
Written Remaining
---------- -------- --- ------------- -------------
2009/03/12 15:19:51 1 13,618,616 13,618,616
Replicated (KB) Low-bw- Sync-as-of
Pre-Comp Network optim Time
----------------------- ------- ----------------
9,881,662 4,472,200 1.00 Thu Mar 12 14:20

300 replication
In this example, the destination system reports that Bytes after
low bandwidth optimization is not smaller than Bytes after
filtering by destination.
destination# replication show detailed-stats all
CTX: 1
Destination: dir://1.2.3.4/backup/destination
Network bytes received from 5,576,867,192
source:
Pre-compressed bytes written to 13,618,616,344
source:
Pre-compressed bytes sent to 13,618,616,344
destination:
Bytes after filtering by 8,068,500,019
destination:
Bytes after low bandwidth 8,068,500,019
optimization:
Bytes after local compression: 5,475,813,069
Pre-compressed bytes remaining: 0
Files remaining: 0
Compression ratio: 2.4
Sync'ed-as-of time: Thu Mar 12 21:14

DD OS 4.9 Command Reference Guide 301


Example where Delta Replication Improves Throughput
The actual numbers below show a situation where delta replication
improves compression/throughput. In this case, Pre-compressed
bytes sent to destination is larger than Pre-compressed
bytes written to source because of retries resulting from
network problems. Note that Bytes after low bandwidth
optimization is smaller than Bytes after filtering by
destination by about 2.88x.
destination# replication show detailed-stats all
CTX: 1
Destination: dir://1.2.3.4/backup/destination
Network bytes received from 300,919,746,737
source:
Pre-compressed bytes written 10,499,354,457,124
to source:
Pre-compressed bytes sent to 10,515,122,596,205
destination:
Bytes after filtering by 1,295,201,966,223
destination:
Bytes after low bandwidth 450,446,948,340
optimization:
Bytes after local 237,166,897,273
compression:
Pre-compressed bytes 0
remaining:
Files remaining: 0
Compression ratio: 34.9
Sync'ed-as-of time: Tue Oct 20 05:28

When Pre-compressed bytes written to source is not equal


to Pre-compressed bytes sent to destination,possible
reasons include the following:
Pre-compressed bytes written might be less than pre-
compressed bytes sent due to network-related resends. Or,
because an overwrite of even one byte to a file requires a
certain minimum amount of logical file content around that
one-byte overwrite to be re-replicated. Workloads involving
overwrites or updates to small files may see marginally higher
pre-compression bytes replicated.

302 replication
Pre-compression bytes written might be higher than pre-
compression bytes sent in cases where a large amount of file
content is written, then overwritten prior to the file being
closed on the sender. This is unusual for backup applications,
but is possible with database applications.

DD OS 4.9 Command Reference Guide 303


304 replication
22 route

Use the route command to manage Data Domain system network


routing, routing displays, and the routing gateway. The route
command has the following options:
add Add a routing table. Page306
del Remove a routing table. Page306
reset Reset the default routing gateway to an empty Page307
entry.
set Set a default gateway. Page307
show Display routing information. Page307
trace Display a traceroute to the named host. Page308

About the route Command


Use the route command to manage routing between a Data
Domain system and backup hosts. An added routing rule appears
in the Kernel IP routing table and in the Data Domain system
Route Config list, a list of static routes that are re-applied at each
system boot. Use the route show config command to display the
Route Config list. Use the route show table command to display
the Kernel IP routing table.
Note: Changes to the Ethernet interfaces made with the net
command options flush the routing table. All routing information
is lost and any data movement currently using routing is
immediately cut off. Data Domain recommends making interface
changes only during scheduled maintenance down times. After
making interface changes, you must reconfigure any routing rules
and gateways.

DD OS 4.9 Command Reference Guide 305


route Command Options

add
route add {-host host-name | -net ipaddr netmask mask} gw gw-
addr
Use this command to add a routing rule. If the target being added
is a network, use the -net option. If the target is a host, use the
-host option. The gateway (gw) can be either an IP address or a
hostname that is available to the Data Domain system and that can
be resolved to an IP address. This command is available to
administrative users only.
To add a route for the host user24 with a gateway of srvr12, use:
# route add -host user24 gw srvr12
To add a route with a route specification of 192.168.1.x, a
netmask, and a gateway of srvr12, use:
# route add -net 192.168.1.0 netmask 255.255.255.0
gw srvr12
The following example gives a default gateway of srvr14 for use
when no other route matches:
# route set gw srvr14

del
route del {-host host-name | -net ipaddr netmask mask}
Use this command to remove a routing rule. Use the same form
(-host or -net) to delete a rule as was used to create the rule. The
route show config command shows whether the entry is a host
name or a net address. If neither -host or -net is used, any
matching lines in the Route Config list are deleted. This command
is available to administrative users only.

306 route
To remove a route for host user24, use:
# route del -host user24
To remove a route with a route specification of 192.168.1.x and a
gateway of srvr12, use:
# route del -net 192.168.1.0 netmask 255.255.255.0
gw srvr12

reset
route reset gateway
Use this command to reset the default routing gateway to the
default value (empty). This command is available to
administrative users only.

set
route set gateway ipaddr
Use this command to change the routing default gateway. This
command is available to administrative users only.
For example, to set the default routing gateway to the IP address of
192.168.1.2, use:
# route set gateway 192.168.1.2

show
show config
route show config
Use this command to display the configured static routes that are
in the Route Config list.
The display looks similar to the following (each line in the example
wraps):
# route show config
The Route Config list is:
-host user24 gw srvr12
-net 192.168.1.0 netmask 255.255.255.0 gw srvr12

DD OS 4.9 Command Reference Guide 307


show gateway
route show gateway
Use this command to display the configured or DHCP-supplied
routing gateways used by a Data Domain system.
The display looks similar to the following:
# route show gateway
Default Gateways
192.168.1.2
192.168.3.4

show table
route show table
Use this command to display all entries in the Kernel IP routing
table.
The display looks similar to the following (each line in the example
wraps):
# route show table

trace
route trace host
Use this command to display a route used by a Data Domain
system to connect with a particular destination.
For example, to trace the route to srvr24, use:
# 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

308 route
route Examples

Add a Route
To add a route with a route specification of 192.168.1.x, a
netmask, and a gateway of srvr12, use:
# route add -net 192.168.1.0 netmask 255.255.255.0
gw srvr12
To add a route for host user24 with a gateway of srvr12, use:
# route add -host user24 gw srvr12

Delete a Route
To delete a route with a route specification of 192.168.1.x and a
netmask of 255.255.255.0, use:
# route del -net 192.168.1.0 netmask 255.255.255.0

Set a Default Gateway


To give a default gateway when no other route matches, use:
# route set gateway 192.168.10.1

DD OS 4.9 Command Reference Guide 309


310 route
23 snapshot

Use the snapshot command to create and manage read-only


copies of the Data Domain file system. The snapshot command
has the following options:
add Schedule when snapshots are taken. Page312
create Create a snapshot. Page314
del Delete the specified snapshot schedule. Page315
expire Set the retention period of a snapshot. Page315
list Show a list of current snapshots. Page316
modify Modify the specified snapshot schedule. Page317
rename Rename a snapshot. Page317
reset Delete all snapshot schedules. Page318
show Show the snapshot schedule. Page318

About the snapshot Command


The snapshots command manages file system snapshots. A
snapshot is a read-only copy of the Data Domain system file
system from the top directory, /backup. Snapshots are useful for
avoiding version skew when backing up volatile data sets, such as
tables in a busy data base, and for retrieving earlier versions of a
directory or file that was deleted.
If the Data Domain system is a source for collection replication,
snapshots are replicated. 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.
Snapshots are created in the system directory
/backup/.snapshot. Each directory under /backup also has a

DD OS 4.9 Command Reference Guide 311


.snapshot directory with the name of each snapshot that includes
the directory. The filesys fastcopy command can use
snapshots to copy a file or directory tree from a snapshot to the
active file system.
Note: The .snapshot directory is a virtual directory. It can be
referenced in any directory, but it does not show up in a directory
listing except at export points (for example, a CIFS share or NFS
mount point).

snapshot Command Options

add
snapshot add schedule name [days days] time time [,time...]
[retention period]
snapshot add schedule name [days days] time time every mins
[retention period]
snapshot add schedule name [days days] time time - time [every
hrs | mins] [retention period]
Use these commands to set up a series of snapshots to be taken at a
regular intervals in the future.
Notes:
It is strongly recommended that snapshot schedules always
explicitly specify a retention time. The default retention time is
14 days. If no retention time is specified, all snapshots are
retained for 14 days, consuming valuable resources.
Multiple snapshot schedules can be active at the same time.
If multiple snapshots are scheduled to occur at the same time,
only one is retained. However, which one is retained is
indeterminate, thus only one snapshot should be scheduled for
a given time.
snapshot add schedule name [days days] time time [,time...]
[retention period]

312 snapshot
The default for days is daily and the user can specify a list of
hours.
snapshot add schedule name [days days] time time
every mins [retention period]
The default for days is daily. The user can also specify the interval
in minutes.
snapshot add schedule name [days days] time time -
time [every hrs | mins] [retention period]
The default for days is daily. When every is omitted, the
command defaults to 1hr.
days Are one or more three-letter day
abbreviations, such as tue for Tuesday. Use
a hyphen ( - ) between days to denote a
range. For example, mon-fri creates a
snapshot every day, Monday through Friday.
time A 24-hour clock that starts at 00:00 and goes
to 23:59. The format in the command is a
three- or four-digit number with an optional
colon ( : ) between hours and minutes. For
example, 4:00 or 04:00 or 0400 sets the time to
4:00 a.m., and 14:00 or 1400 sets the time to
2:00 p.m.
retention period A number plus days, weeks or wks, or
months or mos with no space between the
number and the days, weeks, or months
tag. For example, 6wks. The months or mos
period is always 30 days.

Names of 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-
2009-04-27-13-41.

The name every_day_8_7 is the name of a snapshot schedule.


Snapshots generated by that schedule might have the names

DD OS 4.9 Command Reference Guide 313


scheduled-2008-03-24-20-00, scheduled-2008-03-25-20-00,
and so forth.
For example, to schedule a snapshot every Monday and Thursday
at 2:00 a.m. with a retention of two months, use:
# snapshot add schedule mon thu 02:00 retention
2mos
Snapshots are scheduled to run "Mon, Thu" at
"0200".
Snapshots are retained for "60" days.

create
snapshot create snapshot [retention {date | period]
Use this command to create a snapshot. This command is available
to administrative users only.
snapshot A descriptive name for the snapshot.
retention date A four-digit year, a two-digit month, and a two-
digit day separated by dots ( . ), slashes ( / ), or
hyphens ( - ). For example, 2009.05.22.
With a retention date, the snapshot is retained
until midnight (00:00, the first minute of the
day) of the given date. With a retention period,
the snapshot is retained until the same time of
day as the creation.
retention period A number of days, weeks or wks, or months
or mos with no space between the number and
the days, weeks, or months. For example, 6wks.
The months or mos period is always 30 days.

For example, when a snapshot is created at 8:48 a.m. on April 27,


2009, the output is similar to the following:
# snapshot create test22 retention 6wks
Snapshot "test22" created and will be retained
until Jun 8 2007 08:48.
Note: The maximum number of snapshots allowed to be stored on
a system is 800. If the maximum number is reached, the system
generates an alert. If your system becomes filled with snapshots,
you can resolve this by expiring snapshots and then running
filesys clean.

314 snapshot
del
snapshot del schedule [name | all]
Use the snapshot del schedule name command to delete a
specific snapshot schedule. Use this command to delete all
snapshot schedules with the argument all. This command is
available to administrative users only.
Note that there are two ways to delete all scheduled snapshots:
snapshot del schedule all
or
snapshot reset schedule

expire
snapshot expire snapshot [retention {date | period | forever}]
Use this command to set or reset the retention time of an existing
snapshot. This command is available to administrative users only.
snapshot The name of an existing snapshot.
retention date The four-digit year, a two-digit month, and a
two-digit day separated by dots ( . ), slashes
( / ), or hyphens ( - ). For example,
2009.05.22.
With a retention date, the snapshot is retained
until midnight (00:00, the first minute of the
day) of the given date. With a retention period,
the snapshot is retained until the same time of
day as the snapshot expire command was
entered.
retention period The number of days, weeks or wks, or
months or mos with no space between the
number and the days, weeks, or months. For
example, 6wks. The months or mos period is
always 30 days.
forever The snapshot does not expire.

DD OS 4.9 Command Reference Guide 315


For example:
# snapshot expire tester23 retention 5wks
Snapshot "tester23" will be retained until Jun 1
2007 09:26.
To immediately expire a snapshot, use the snapshot expire
operation with no options. An expired snapshot remains available
until the next file system clean operation.
snapshot expire name
See also filesys clean.

list
snapshot list
Use this command to list existing snapshots. The display gives the
snapshot name, the pre-compression amount of data in the
snapshot, the creation date, the retention date, and the status. The
status is either blank or expired. An expired snapshot remains
available until the next file system clean operation. Use the
snapshot expire command to set a future expiration date for an
expired, but still available, snapshot.
For example:
# snapshot list

Name Pre-Comp (GB) Create Date Retain Until Status


-------------------- ------------- ----------------- ---------------- -------
SS_FULL_1 948.1 Feb 1 2007 22:16
SS_INCR_1 944.4 Feb 1 2007 23:09
SS_INCR_2 938.7 Feb 2 2007 00:31 Aug 2 2007 07:33 expired

SS_FULL_2 939.9 Mar 2 2007 00:48 Aug 2 2007 11:16 expired


DAILY_1 942.8 Mar 12 2007 01:03 Aug 2 2007 13:09 expired
DAILY_2 940.7 Mar 13 2007 02:24 Aug 2 2007 09:52 expired
WEEKLY_1 937.8 Apr 12 2007 02:51 Aug 2 2007 07:33 expired
DAILY_3 937.3 Apr 13 2007 03:40 Aug 2 2007 07:33 expired
scheduled-2007-05-05 944.6 May 5 2007 13:08 Aug 1 2007 13:08 expired
scheduled-2007-07-07 944.5 Jul 7 2007 13:09 Aug 7 2007 13:09
scheduled-2007-08-02 943.9 Aug 2 2007 13:11 Sep 1 2007 13:11
-------------------- ------------- ----------------- ---------------- -------

316 snapshot
modify
snapshot modify schedule name {[days days] time time [,time...]
[retention period]}
snapshot modify schedule name {[days days] time time every mins
[retention period]}
snapshot modify schedule name {[days days] time time - time
[every hrs | mins] [retention period]
Use this command to modify an already-existing snapshot
schedule, with the same syntax as the snapshot add schedule
command. This command is available to administrative users only.
There are several possible syntaxes:
snapshot modify schedule name {[days days] time
time [,time...] [retention period]}
The default for days is daily and the user can specify a list of
hours.
snapshot modify schedule name {[days days] time
time every mins [retention period]}
The default for days is daily. The user can also specify the interval
in mins.
snapshot modify schedule name {[days days] time
time - time [every hrs | mins] [retention period]
The default for days is daily. When every is omitted, the
command defaults to every 1hr.

rename
snapshot rename snapshot new-name
Use this command to change the name of a snapshot. This
command is available to administrative users only.
For example, to change the name from snap12-20 to snap12-21,
use:
# snapshot rename snap12-20 snap12-21
Snapshot snap12-20 renamed to snap12-21.

DD OS 4.9 Command Reference Guide 317


reset
snapshot reset schedule
Use this command to reset to the default of no snapshot schedules.
This command is available to administrative users only.

show
snapshot show schedule name
Use this command to display a given snapshot schedule.
To display a list of all snapshot schedules currently in effect, use
the snapshot show schedule operation without an argument.
For example,
# snapshot show schedule
Snapshots are scheduled to run "daily" at "0700".
Snapshots are scheduled to run "daily" at "1900".
Snapshots are retained for "60" days.

318 snapshot
snapshot Examples

Schedule a Snapshot
To schedule a snapshot every day at 8:00p.m., use:
add schedule every_day_8_pm days daily time 20:00
or
add schedule every_day_8_pm days mon-sun time 20:00
Note: The name every_day_8_pm is the name of a snapshot
schedule. Snapshots generated by that schedule will have
names like scheduled-2008-03-24-20-00, scheduled-2008-03-
25-20-00, etc.
To schedule a snapshot every midnight, use:
add schedule every_midnight days daily time 00:00
retention 3days
or
add schedule every_midnight days mon-sun time 00:00
retention 3days
To schedule a snapshot every weekday at 6:00a.m., use:
add schedule wkdys_6_am days mon-fri time 06:00
retention 4days
or
add schedule wkdys_6_am days mon,tue,wed,thu,fri
time 06:00 retention 4days
To schedule a snapshot every weekend Sun at 10:00a.m., use:
add schedule every_sunday_10_am days sun time 10:00
retention 2mos
To schedule a snapshot every Sunday at midnight, use:
add schedule every_sunday_midnight days sun time
00:00 retention 2mos

DD OS 4.9 Command Reference Guide 319


To schedule a snapshot every 2 hours, use:
add schedule every_2_hours days daily every 2hrs
retention 3days
To schedule a snapshot every hour, use:
add schedule every_hour time time 00:00-23:00
retention 3days
To schedule a snapshot every 2 hours at 15 minutes past the hour,
use:
add schedule every-2h-15-past days daily time
00:15-23:15 every 2 hrs retention 3days
To schedule a snapshot every 2 hours between 8:00a.m.-5:00p.m.
on weekdays, use:
add schedule wkdys-every-2-hrs-8a_to_5p days mon-
fri time 08:00-17:00 every 2 hrs retention 3days
To schedule a snapshot on specific day of week at a specific time
(for example, every week on Mondays and Tuesdays at 8:00a.m.),
use:
add schedule ev-wk-mon-and-tu-8-am days mon,tue
time 08:00 retention 3mos
To schedule a snapshot every specific day of a month at a specific
time (for example, every second day in the month at 10:15a.m.),
use:
add schedule ev_mo_2nd_day_1015a days 2 time 10:15
retention 3mos
To schedule a snapshot every last day in a month at 11:00p.m., use:
add schedule ev_mo_last_day_11pm days last time
23:00 retention 2yrs
To schedule a snapshot for the beginning of every month, use:
add schedule ev_mo_1st_day_1st_hr days 1 time 00:00
retention 2yrs
To schedule a snapshot every 15 minutes, use:
add schedule ev_15_mins days daily time 00:00-23:00
every 15mins retention 5days

320 snapshot
To schedule a snapshot every weekday at 10:30a.m. and 3:30p.m.,
use:
add schedule ev_weekday_1030_and_1530 days mon-fri
time 10:30,15:30 retention 2mos

DD OS 4.9 Command Reference Guide 321


322 snapshot
24 snmp

The snmp command manages the use of SNMP on a Data Domain


system.
The snmp command has the following options:
add Add SNMP elements. Page324
del Delete SNMP elements. Page325
disable Disable SNMP. Page326
enable Enable SNMP. Page326
reset Restore SNMP elements to the defaults. Page326
set Configure SNMP elements. Page327
show Display SNMP information. Page328
status Display SNMP status. Page329

About the snmp Command


Simple Network Management Protocol (SNMP) is a standard
protocol used to exchange network management information. It is
part of the Transmission Control Protocol/Internet Protocol
(TCP/IP) protocol suite. SNMP provides a tool for network
administrators to monitor and manage network-attached devices
such as Data Domain systems.
The snmp command allows you to enable or disable SNMP access
to a Data Domain system, add community strings, give contact and
location information, and display configuration settings. The
default port that is open when SNMP is enabled is port 161. Traps
are sent out through port 162.

DD OS 4.9 Command Reference Guide 323


Note: The quickest way to change multiple settings is to first run
the snmp disable command, then change the settings, and finally
run snmp enable. If you change multiple settings while snmp is
enabled, each command restarts snmp, which takes longer.

snmp Command Options

add
add ro-community
snmp add ro-community community-string
Use this command to add one or more community strings to
enable read-only access to the Data Domain system. A common
string for read-only access is public. This command is available to
administrative users only.

add rw-community
snmp add rw-community community-string
Use this command to add one or more community strings to
enable read/write access to the Data Domain system. A common
string for read/write access is private. This command is available
to administrative users only.
For example, to add a community string of private with
read/write permissions, use the command:
# snmp add rw-community private

324 snmp
add trap-host
snmp add trap-host hostname[:port]
Use this command to add one or more trap hosts (hostname or IP
address) to receive SNMP traps generated by the Data Domain
system. With one or more trap hosts, alerts are also sent as traps,
even when the local SNMP agent is disabled. By default, port 162 is
used, but another port can be assigned. This command is available
to administrative users only.
For example, to add a trap host admin12, use the command:
# snmp add trap-host admin12

del
del ro-community
del ro-community community-string
Use this command to delete one or more community strings that
enable read-only access to the Data Domain system. This
command is available to administrative users only.

del rw-community
snmp del rw-community community-string
Use this command to delete one or more community strings that
enable read-only access to the Data Domain system. This
command is available to administrative users only.
For example, to delete the community string private that gives
read/write permissions, use the command:
# snmp del rw-community private

DD OS 4.9 Command Reference Guide 325


del trap-host
snmp del trap-host hostname
Use this command to delete one or more trap hosts from the list of
machines that receive SNMP traps generated by the Data Domain
system. This command is available to administrative users only.
For example, to delete a trap host admin12, use the command:
# snmp del trap-host admin12

disable
snmp disable
Use this command to disable the SNMP agent and close port 161.
This command is available to administrative users only.

enable
snmp enable
Use this command to enable the SNMP agent and open port 161.
This command is available to administrative users only.

reset
Use this command to return all SNMP values to the defaults. This
command is available to administrative users only.

reset ro-community
snmp reset ro-community
Use this command to reset the read-only community list to empty.
This command is available to administrative users only.

reset rw-community
snmp reset rw-community
Use this command to reset the read-write community list to empty.
This command is available to administrative users only.

326 snmp
reset sysContact
snmp reset sysContact
Use this command to reset the system contact to the system value
displayed by the command system show admin-email, or to an
empty string if the system value is empty. This command is
available to administrative users only.

reset sysLocation
snmp reset sysLocation
Use this command to reset the system location to the system value
displayed by the command system show location, or to an
empty string if the system value is empty. This command is
available to administrative users only.

reset trap-hosts
snmp reset trap-hosts
Use this command to return the trap hosts list to the default of
empty. This command is available to administrative users only.

set
set sysContact
snmp set sysContact contact
Use this command to set the system contact as used in the SNMP
MIB II system variable sysContact. This command is available to
administrative users only.
For example, to give a contact of bob-smith, use the command:
# snmp set sysContact bob-smith

DD OS 4.9 Command Reference Guide 327


set sysLocation
snmp set sysLocation location
Use this command to set the system location as used in the SNMP
MIB II system variable sysLocation. This command is available to
administrative users only.
For example, to give a location of bldg3-rm222, use the command:
# snmp set sysLocation bldg3-rm222

show
show config
snmp show config
Use this command to display all of the SNMP parameters. This
command is available to administrative users only. The output is
similar to the following:
# snmp show config
---------------------- -------------------
SNMP sysLocation bldg3-rm222
SNMP sysContact smith@company.com
Trap Hosts admin10 admin11
Read-only Communities public snmpadmin23
Read-write Communities private snmpadmin1
---------------------- -------------------

show ro-communities
snmp show ro-communities
Use this command to display all read-only community strings.

328 snmp
show rw-communities
snmp show rw-communities
Use this command to display all read/write community strings.
The output is similar to the following:
# snmp show rw-communities
RW Community Strings:
private
snmpadmin1

show sysContact
snmp show sysContact
Use this command to display the system contact on a Data Domain
system.

show sysLocation
snmp show sysLocation
Use this command to display the system location on a Data
Domain system.

show trap-hosts
snmp show trap-hosts
Use this command to display the trap host list on a Data Domain
system.
The output is similar to the following:
# snmp show trap-hosts
Trap Hosts:
admin10
admin11

status
snmp status
Use this command to display the status of the SNMP agent on a
Data Domain system (enabled or disabled).
DD OS 4.9 Command Reference Guide 329
Important Notices
Data Domain systems support SNMP versions V1 and V2C.
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 exactly how a
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.
The SNMP feature allows a Data Domain system to respond to a
set of SNMP get operations from a remote machine.
From an SNMP perspective, a Data Domain system is a read-only
device with the following exception: A remote machine can set the
SNMP location, contact, and system name on a Data Domain
system. To configure community strings, hosts, and other SNMP
variables on the Data Domain system, use the snmp command.
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.
Note: The SNMP sysLocation and the location set with the
config set location command are the same. If sysLocation is
not set with an SNMP command, the variable defaults to the
values specified with the config set commands. However, the
sysContact variable does not default to the value set by the
config set admin-email command.

330 snmp
25 support

The support command uploads files from a customer Data


Domain system to the Data Domain Support Web site.
The support command has the following options:
upload Upload files from a customer Data Domain Page331
system.

About the support Command


The support command sends files to Data Domain Support
personnel for troubleshooting. The bundle option sends various
log files from /ddvar/log. The traces option sends perf.log files.
The selected files are tar-gzipped together with a README file
that includes identifying autosupport headers.

support Command Options

upload
upload file-list
The file-list contains filenames available under /ddvar. If more
than one file is specified, filenames must be space-separated.
upload {bundle [file-list]|traces|file-list}
Use the bundle option to send various Data Domain system log
files that are often needed by the support staff. The optional file-
list contains filenames available under /ddvar. If more than one
file is specified, filenames must be space-separated.
Use the traces option to send multiple perf.log (performance log)
files that are often needed by the support staff.

DD OS 4.9 Command Reference Guide 331


In a Global Deduplication Array, issuing this command from the
master controller uploads bundles or traces (performance logs)
from both nodes. If more than one file is specified, filenames must
be space-separated. This command is available on a single node
and a worker controller too. The bundle/traces will be uploaded
from that node.
upload {bundle [file-list]|traces|file-list} local
In a Global Deduplication Array, issuing this command from the
master controller uploads bundles or traces (performance logs)
from that node only, and not the worker controller. There is no
change to command functionality on the worker controller. If more
than one file is specified, filenames must be space-separated.

332 support
26 system

The system command manages system-level actions on the Data


Domain system.
The system command has the following options:
headswap Restore system configuration after a head Page334
unit replacement.
option Manage system options. Page334
poweroff Shut down and turn off the power. Page336
reboot Shut down and restart the server. Page336
sanitize Manage system sanitization. Page337
set date Set the system clock. Page338
show Show system information. Page338
status Show system hardware status Page352
upgrade Upgrade the software on a single node or Page354
simultaneously upgrade Global
Deduplication Array controllers with a
specified package.

DD OS 4.9 Command Reference Guide 333


About the system Command
The system command:
Displays the Data Domain hardware configuration and serial
number, DD OS version, run-time system status, statistics, and
performance.
Upgrades the software.
Sets date and banner information.
Stops and reboots the Data Domain system.
Restores the configuration after a head unit replacement.
Sanitizes the system after files are deleted.

system Command Options

headswap
system headswap
To restore the configuration to a DD690, DD690g, DD880, or
DD880g system after a head unit replacement, use the system
headswap command.

Note: This command is available only when you swap to DD690,


DD690g, DD880, and DD880g models. For specific instructions, see
the Chassis Replacement FRU document for your system. This
command is available to administrative users only.

option
option reset
system option reset login-banner
To reset the login banner to the default of no banner, use this
command. This command is available to administrative users only.

334 system
option set
system option set login-banner filename
To select a text file to display whenever someone logs in, use this
command.
1. Mount the Data Domain system directory /ddvar from another
system.
2. Create a text file with your login message as the text on the
other system.
3. From the Data Domain system, use the system option set
login-banner command with the path and file name of the
file that you created.
This command is available to administrative users only.
For example, to use the text from a file named banner, use the
command:
# system option set login-banner /ddvar/banner

option show
system option show
To display the location of the file that contains the login banner
text, use this command. This command is available to
administrative users only. The command output shows the path
and file name:
# system option show
Option Value
----------------- -------------
Login Banner File /ddvar/banner
----------------- -------------

DD OS 4.9 Command Reference Guide 335


poweroff
system poweroff
To shut down power to the Data Domain system, use this
command. The command performs an orderly shutdown of file
system processes.
The display includes a warning similar to the following:
# system poweroff
The 'system poweroff' command shuts down the system
and turns off the power.
Are you sure? (yes|no|?) [no]:
This command is available to administrative users only.
Note: The system poweroff command does not power off
external storage.

reboot
system reboot
To shut down and reboot a Data Domain system, use this
command. The command automatically performs an orderly
shutdown of file system processes.
The display includes a warning similar to the following:
# system reboot
The 'system reboot' command reboots the system.
File access is interrupted during the reboot.
Are you sure? (yes|no|?) [no]:
This command is available to administrative users only.

336 system
sanitize
System sanitization, which is often required in government
installations, ensures that all traces of deleted files are completely
disposed of (shredded) and that the system is restored to a state as
if the deleted files never existed. Its primary use is to resolve
Classified Message Incidents (CMIs), in which classified data is
inadvertently copied into another system, particularly one not
certified to hold data of that classification. This command is
available to administrative users only.

sanitize abort
system sanitize abort
Stop the system sanitization process.

sanitize start
system sanitize start
Start the system sanitization process. While this command is
running, vtl is temporarily disabled. Therefore, running this
command during scheduled backup times might not be desirable.

sanitize status
system sanitize status
Check system sanitization process status.

sanitize watch
system sanitize watch
Monitor system sanitization progress.

DD OS 4.9 Command Reference Guide 337


set date
system set date MMDDhhmm[[CC]YY]
To set the system date and time, use this command. 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).
Optionally, two digits for the century.
Optionally, two digits for the year.
The hour (hh) and minute (mm) entries are 24-hour (military) time
with no colon between the hours and minutes. 2400 is not a valid
entry. 0000 means midnight.
For example, use either of the following commands to set the date
and time to October 22, 2009, at 9:24 a.m.:
# system set date 1022092409
# system set date 102209242009
This command is available to administrative users only.
Note: Do not use this command if Network Time Protocol (NTP)
is enabled.

show
show all
system show all
To display memory usage information together with other
available system information, use this command. The output
includes the results of the following commands:
system show detailed-version
system show meminfo
system show modelno
system show serialno

338 system
system show uptime
system show date

show date
system show date
To display the system date and time, use this command.

show detailed-stats
system show detailed-stats [start | stop | ([[interval] nsecs]
[count count])]
system show detailed-stats nsecs count
By default, the statistics cover the time period since the last reboot.
Use the command options to specify a different interval for
collecting statistics. If the system is too busy to determine a value,
the column shows a dash ( - ) instead of a number.
start Begin collecting statistics.
stop Stop collecting statistics and report the data gathered from
the time that you entered the command
system show detailed-stats start.
The results are the averages per second of the statistics
during the time between the start and stop commands.
nsecs Run the command every nsecs seconds. The first report is
for current activity. Each subsequent report is for activity in
the last nsecs. The default interval is five seconds.
count Generate count number of reports. To specify count
without interval, you must use the count keyword.
Otherwise, the keyword is optional.

The columns in this report show the following information:


CPU busy The percentage of time CPU is busy (average for all
CPUs).
CPU max The peak CPU utilization.

DD OS 4.9 Command Reference Guide 339


State A single character that shows whether any of the six
'CDVMS' following events is occurring. Each event can affect
performance.
C Cleaning
D Disk reconstruction (repair of a failed disk), or
RAID is resyncing (after an improper system
shutdown and a restart), or RAID is degraded (a
disk is missing and no reconstruction is in
progress)
B Currently unused
V Verify data (a background process that checks for
data consistency)
M Merging of the internal fingerprint index
S Summary vector internal checkpoint process
NFS ops/s The number of NFS actions per second.
NFS proc The fraction of time that the file server is busy
servicing requests.
NFS recv The proportion of NFS-busy time spent waiting for
data on the NFS socket.
NFS send The proportion of NFS-busy time spent sending data
out on the socket.
NFS idle The percentage of NFS idle time.
CIFS ops/s The number of CIFS (Common Internet File system)
operations per second.
ethx MB/s The amount of data in megabytes per second passing
through each Ethernet connection. One column
appears for each Ethernet connection.
Disk KiB/s The amount of data in kibibytes per second going to
and from all disks in the Data Domain system.
Disk busy The percentage of time that all disks in the Data
Domain system are busy.
NVRAM KiB/s The amount of data in kibibytes per second that is
read from and written to all NVRAM cards.

340 system
Repl KB/s The amount of data in kilobytes per second being
replicated between one Data Domain system and
another. For directory replication, the value is the total
of all in and out traffic for all replication contexts.

Note: KiB = kibibytes (the binary equivalent of kilobytes)


Note: The output in Global Deduplication Array mode is different
because there is more than one system.

show detailed-version
system show detailed-version
To display the versions of Data Domain system components on
your system, use this command.
The display is similar to the following:
# system show detailed-version
Data Domain OS 4.9.0.0-132588
Distribution: /auto/builds64e/distro/pinot/123033/localbld
//prod/main/app/...@132588
132588
//prod/main/platform/os/...@132387
//prod/main/platform/os/linux-2.6.12/arch/x86_64/...@61933
//prod/main/platform/os/linux-2.6.12/arch/i386/...@76935
//prod/main/platform/os/linux-2.6.12/arch/ia64/...@25442
//prod/main/platform/os/debugrpm/...@124034
//prod/main/platform/user/samba/...@132364

Version info from ddfs executable:


dd_version_timestamp=Fri Sep 25 19:56:00 2009 GMT
dd_version_checksum=1dc267628964d4029346d82038d79932
dd_version_build_level=nightly
dd_version_change_level=//prod/main/app/...@132588
dd_version_client=//ddfab:132588/app/...
dd_version_opened_files=
dd_version_release=4.9.0.0-132588

Version info from kernel:


kernel_version_release=2.6.23-ddr132588
kernel_build_level=SMP

DD OS 4.9 Command Reference Guide 341


show hardware
system show hardware
To display information about the PCI cards and other hardware in
a Data Domain system, use this command.
Here are a few sample lines from the display:
# system show hardware
Slot Vendor Device Ports
---- ------------ ------------------- ------
0 Intel 80003ES2LAN GigE 0a, 0b
1 Micro Memory MM-5425CN
2 (empty) (empty)
3 LSI Logic LSISAS3442E 3a
4 LSI Logic LSISAS3442E 4a
5 Intel PRO/1000 PT DP GigE 5a, 5b
6 QLogic QLE2462 4Gb FC 6a, 6b
---- ------------ ------------------- ------

show meminfo
system show meminfo
To display a summary of the memory in a Data Domain system,
use this command.
Here is an example:
# system show meminfo
Memory Usage Summary
Total memory: 7987 MiB
Free memory: 1102 MiB
Total swap: 12287 MiB
Free swap: 12287 MiB

342 system
show modelno
system show modelno
To display the model number of a Data Domain system, use this
command.

show nvram
system show nvram
To display information about the memory and battery status of the
NVRAM cards, use this command. The display is similar to the
following:
# system show nvram
NVRAM Card Component Value
---------- ------------------- --------------------
1 memory size 512.00 MiB
number of batteries 2
errors 0 PCI, 0 memory
battery 1 100% charged, enabled
battery 2 100% charged, enabled
---------- ------------------- --------------------
Note: MiB = Mebibytes (the binary equivalent of Megabytes)
The errors entry shows the operational state of the card. If the
card has one or more PCI or memory errors, an alerts email is sent
and the Daily Alert Summary email includes an NVRAM entry.
Each battery entry should show 100% charged, enabled. The
exceptions are for a new system or for a replacement NVRAM
card. In both cases, the charge may initially be below 100%. If the
charge does not reach 100% within three days (or if a battery is not
enabled), replace the card.

DD OS 4.9 Command Reference Guide 343


show performance
system show performance [local] [raw | fsop] [duration {hr | min
| sec}[interval {hr | min | sec}]]
To display system performance figures for data transfer for an
amount of time, use this command.
local Display the stats that are local to a Global
Deduplication Array node. By default, the system
show performance gives Global Deduplication
Array-wide statistics.
raw Show unformatted statistics.
fsop Display a table of how many of each file system
operation was performed per minute.
duration The hours, minutes, or seconds prior to the current
time for which to show data. Follow the value with
one of these keywords to show the time units: hr,
min, or sec.
interval The time between each line in the display. Follow the
value with one of these keywords to show the time
units: hr, min, or sec. If you want to specify the
interval, you must also specify the duration.

The output is too large to print here, but the fields are as follows:

344 system
Throughput
Read Read throughput from the Data Domain system.
Write Write throughput to the Data Domain system.
Repl Network Replication network throughput into and out of the
Data Domain system.
Repl Pre-comp Replication pre-compressed (logical) throughput
into and out of the Data Domain System. The value
is always zero for collection replication.

Utilization
proc Percent of time spent processing requests.
recv Percent of time spent receiving requests over the
network.
send Percent of time spent sending requests over the
network.
idle Percent of time spent idle.

Compression
gcomp Global compression rate.
lcomp Local compression rate.

DD OS 4.9 Command Reference Guide 345


Cache Miss
Note: Higher values are worse.
thra Percent of compression units that have been read and
discarded without being used. A high percent indicates
cache thrashing.
unus Percent of a compression units data that is unused.
Since 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
that a lot of space is wasted due to cache block
fragmentation. In the ideal case, ovhd should exactly
equal unus.
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.

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.

346 system
State
C Cleaning.
D Disk reconstruction.
B Currently unused.
V Verification.
M Fingerprint merge.
S Summary vector checkpoint.

Utilization
cpu The average and maximum CPU utilization. The CPU
ID of the most loaded CPU is shown in the brackets.
disk The maximum (highest) disk utilization over all disks.
The disk ID of the most loaded disk is shown in the
brackets (may not correspond to the ID used by disk
show commands).

Latency
avg/std The average and standard deviation of the response
time for ddfs to service all protocol requests excluding
the time to receive/send the request/reply.

Servicing a file system request consists of three steps: receiving the


request over the network, processing the request, and sending a
reply to the request.
A high proc value indicates that the Data Domain system is
already processing requests as quickly as it can and is the
bottleneck. A low proc value indicates that the Data Domain
system is lightly used and the performance is limited by the
network, backup server, or backup server clients.
When the recv or send value is high, the Data Domain system is
spending much of its time waiting to receive or send data from or
to the backup server. The situation indicates that either the backup
server is heavily loaded (resulting in slow network processing) or a
network-related problem is slowing down sends and receives. A
common problem is that the client may be trying to access the Data
Domain system over a 100 Mbit rather than a gigabit link.

DD OS 4.9 Command Reference Guide 347


If the proc, recv, and send values are low (that is, idle is high),
then the Data Domain system is lightly loaded. This situation
indicates that the backup server cannot keep up with the Data
Domain system. The backup server's disk may be heavily loaded,
the backup software may require tuning, or the backup server may
be waiting for data from slow backup clients.
Note: The Read, Write, and Replicate values are calculated in
powers of 10 (1 KB = 1000) instead of powers of 2 (1 KiB = 1024).

show ports
system show ports
To display information about ports, use this command. The
display is similar to the following:
# system show ports
Port Connection Link Firmware Hardware
Type Speed Address
---- ---------- ------ -------------- -----------------------
0a Enet 1 Gbps 00:15:17:0f:6e:bd (eth1)
0b Enet 1 Gbps 00:15:17:0f:6e:bc (eth0)
5a VTL 4.04.00 [IP]
[84 00:64:a1:91:00:00:00:00 WWNN
50:06:0b:00:00:64:a1:90 WWPN
5b VTL 4.04.00 [IP]
[84 00:64:a1:93:00:00:00:00 WWNN
50:06:0b:00:00:64:a1:92 WWPN
6a VTL 4.04.00 [IP]
[84 00:64:a0:75:00:00:00:00 WWNN
50:06:0b:00:00:64:a0:74 WWPN
6b VTL 4.04.00 [IP]
[84 00:64:a0:77:00:00:00:00 WWNN
50:06:0b:00:00:64:a0:76 WWPN
---- ---------- ------ -------------- -----------------------

348 system
Port The port number. See the Data Domain Hardware Guide
(for older systems) or the model-specific installation and
setup guide to match a slot to a port number. A DD580,
for example, shows port 3a as a SAS HBA in slot 3 and
port 4a as a SAS HBA in slot 4. A gateway Data Domain
system with a dual-port Fibre Channel HBA always
shows #a as the top port and #b as the bottom port,
where # is the HBA slot number, depending on the Data
Domain system model.
Link The speed in Gbps (Gigabits per second).
Speed
Firmware The Data Domain system HBA firmware version.
Hardware A MAC address, a WWN, or a WWPN/WWNN, as
Address follows:
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 FC HBA on
gateway systems.

show serialno
system show serialno
To display the system serial number, use this command. The
display is similar to the following:
# system show serialno
Serial number: 8F46942007

show stats
system show stats [start | stop | ([interval nsecs]
[count count] )]
system show stats nsecs count
To display system statistics for CPUs, disks, Ethernet ports,
replication, and NFS, use this command. By default, the statistics
cover the time period since the last reboot. Use the command
DD OS 4.9 Command Reference Guide 349
options to specify a different interval for collecting statistics. If the
system is too busy to determine a value, the column shows a dash
( - ) instead of a number.
start Begin collecting statistics.
stop Stop collecting statistics and report the data gathered from
the time that you entered the command
system show stats start.
The results are the averages per second of the statistics
during the time between the start and stop commands.
nsecs Run the command every nsecs seconds. The first report is
for current activity. Each subsequent report is for activity
in the last nsecs. The default interval is five seconds.
count Generate count number of reports. To specify count
without an interval, you must use the count keyword.
Otherwise, the keyword is optional.

The display is similar to the following:


# system show stats
04/23 16:23:10

CPU FS FS Net MB/s Disk KiB/s Disk NVRAM Repl


busy ops/s proc in out read write busy KiB/s KB/s
----- ----- ----- ----- ----- ----- ----- ----- ----- -----
5% 25 2% 4939 139 5683 0 4% 6606 0

Note: KiB = kibibytes (the binary equivalent of kilobytes)


Note: The output in Global Deduplication Array mode is different
because there is more than one system.

350 system
show uptime
system show uptime
To display the time since the last reboot and the file system uptime,
use this command. The display includes the following information:
Current time
Time since the last reboot (in days and hours)
The current number of users
The average load for file system operations, disk operations,
and the idle time over the preceding 1, 5, and 15 minute
intervals
The Filesystem line displays the time that has passed since the
file system was last started.
The output is similar to the following:
# system show uptime
12:57pm up 9 days, 18:55, 3 users, load average:
0.51, 0.42, 0.47
Filesystem has been up 9 days, 16:26

show version
system show version
To display the Data Domain OS version, use this command. The
display gives the release number and a build identification
number. The display is similar to the following:
# system show version
Data Domain OS 4.9.0.0-132588

DD OS 4.9 Command Reference Guide 351


status
system status
To display status information about fans, internal temperatures,
and power supplies, use this command.
The information is grouped separately for the Data Domain system
and each expansion shelf that is connected to the system.
The Fans section displays information about all of the cooling
fans.
The Description column tells where the fan is located in
the chassis.
The Level column gives the current operating speed range
(low, medium, or high) for each fan. The operating speed
changes depending on the temperature inside the chassis.
See the topic Replace Fans in the Data Domain Hardware
Guide (for older systems) or in the system-specific Cooling
Fan Replacement document (newer systems) to identify the
fans by name and number. All of the fans in an expansion
shelf are located inside the power supply units.
The Status column is the system view of fan operation.
The Temperature section displays the number of degrees that
each CPU is below the maximum allowable temperature and
the actual temperature for the interior of the chassis. The C/F
column displays temperature in degrees Celsius and
Fahrenheit. The Status column shows whether or not the
temperature is acceptable.
If the overall temperature for a Data Domain system
reaches 50 degrees Celsius (122 degrees Fahrenheit), a
warning message is generated. If the temperature reaches
60 degrees Celsius (140 degrees Fahrenheit), the Data
Domain system shuts down. A Status of Critical
indicates that the temperature is above the shutdown
threshold.
The CPU temperature values depend on the Data Domain
system model. With newer models, the numbers are
negative when the status is OK and move toward 0 (zero)
as CPU temperature increases. If a CPU temperature
352 system
reaches 0 Celsius, the Data Domain system shuts down.
With older models, the numbers are positive. If the CPU
temperature reaches 80 Celsius (176 degrees Fahrenheit), the
Data Domain system shuts down.
The Power Supply section reports either that all power
supplies are operating normally or that one or more are not
operating normally. The message does not identify which
power supply or supplies are not functioning (except by
enclosure). Look at the back panel of the enclosure and check
the LED for each power supply to identify those that need
replacement.
The display is similar to the following:
# system status
Enclosure 1
Fans
Description Level Status
-------------- ------ ------
Cooling fan #1 medium OK
Cooling fan #2 medium OK
-------------- ------ ------
Temperature
Description C/F Status
--------------- -------- ------
CPU 0 Relative -56/-101 OK
Chassis Ambient 24/75 OK
--------------- -------- ------
Power Supply
Description Status
--------------- ------
Power Module #1 OK

DD OS 4.9 Command Reference Guide 353


upgrade
system upgrade filename
To upgrade the Data Domain system software, use this command.
You can get updated software from the Data Domain Support Web
site.
Note: Stop any active CIFS client connections before starting an
upgrade.
1. Use the cifs show active command on the Data Domain
system to check for CIFS activity.
2. Disconnect any client that is active. On the client, enter the
command:
net use \\dd\backup /delete
Keep these points in mind when performing an upgrade:
In Global Deduplication Array mode, this command upgrades
both of the nodes.
The upgrade command shuts down the Data Domain system
file system and reboots the Data Domain system. (If an
upgrade fails, call customer support.)
The upgrade command may require over an hour, depending
on the amount of data on the system.
For systems that are already part of a replication pair:
With directory replication, first upgrade the destination
and then upgrade the source.
With collection replication, first upgrade the destination
and then upgrade the destination.
With one exception, replication is backwards compatible
within release families (all 4.6.x releases, for example) and
with the latest release of the previous family (4.7 is
compatible with release 4.6, for example). The exception is
bidirectional directory replication, which requires the
source and destination to run the same release.

354 system
Do NOT disable replication on either system in the pair.
Note: Before starting an upgrade, always read the Release Notes
for the new release. DD OS changes in a release may require new
upgrade procedures.
Issuing this command on the master controller upgrades all
controllers in a Global Deduplication Array simultaneously with
the specified filename. A progress bar monitors the upgrade.
After the first phase of the upgrade, which is installing the new
DDOS upgrade on a secondary partition, the controllers reboot.
After all of the controllers have rebooted, the master controller
checks their status and initiates the second phase of the upgrade
automatically on all controllers. If the automatic upgrade checks
fail for some reason, an alert is sent describing the cause of failure,
and the automated upgrade process exits.
Note: You can run the second phase of the upgrade manually
using the system upgrade command. If the problem is not fixable,
the command allows you to rollback the upgrade to the previous
version.

Upgrade by Using HTTP


1. Log into a Data Domain system administrative host that
mounts /ddvar from the Data Domain system.
2. On the administrative host, open a browser and navigate to the
Data Domain Support Web site. Use secure HTTP (HTTPs) to
connect to the Web site. For example, go to:
https://my.datadomain.com
3. Log in with the Data Domain login name and password that
you use for access to the support Web page.
4. Click Downloads. (If the Web site has updated instructions,
follow those instructions.)
5. Click the Download button for the latest release.

6. Download the new release file to the Data Domain system


directory /ddvar/releases.

DD OS 4.9 Command Reference Guide 355


Note: When you use Internet Explorer to download a software
upgrade image, the browser may add bracket and numeric
characters to the upgrade image name. Remove the added
characters before running the system upgrade command.
7. To start the upgrade, log into the Data Domain system as
sysadmin and enter a command similar to the following. Use
the file name, not a path.
# system upgrade 4.9.0.0-95091.rpm

Examples for system

Display System Statistics


To display system statistics every 30 seconds for 10 iterations, use
the following command:
# system show stats 30 10

Set the System Date and Time


To set the date and time to October 26, 2008, at 3:24 p.m., use either
of the following commands:
# system set date 1026152408
# system set date 102615242008

Display System Performance


To show only the last 30 minutes (duration) of performance
figures, use the following command:
# system show performance 30 min
To show the last 30 minutes (duration) of performance figures with
an interval of 5 minutes between each reported set of figures, use
the following command:
# system show performance 30 min 5 min

356 system
Display a Banner
To have a text message appear at each login, mount the Data
Domain system /ddvar directory from a third-party physical disk
system and create a text file with the message as the text. For
example, to use text from a file named banner, use the following
command on the Data Domain system:
# system option set login-banner /ddvar/banner

DD OS 4.9 Command Reference Guide 357


358 system
27 user

The user command manages the user accounts on a Data Domain


system.
The user command has the following options:
add Add a new user. Page360
change Change user parameters. Page361
del Delete a user. Page361
disable Disable a user account. Page361
enable Enable a user account. Page361
password Manage password aging options. Page362
reset Reset the user account list and password Page365
policies to their default values.
show Display user information. Page365

About the user Command


The user command adds and deletes users, changes passwords,
manages password aging and strength policies, and displays user
accounts.
The user privilege is for standard users who have access to a
limited number of commands. Most of the commands available
at the user level display information.
The admin privilege is for administrative users who have
access to all Data Domain system commands. The default
administrative account is sysadmin. You can change the
sysadmin password, but cannot delete the account.

DD OS 4.9 Command Reference Guide 359


user Command Options

add
user add user-name [password password] [priv {admin | user}]
[min-days-between-change days] [max-days-between-change days]
{warn-days-before-expire days] [disable-days-after-expire days]
[disable-date date]
Use this command to add a new user. If password is not specified,
the system prompts for one. The default privilege level is user. A
user-name must start with an alphanumeric character. Special
characters cannot be used. The user names root and test are
default existing names on every Data Domain system and are not
available for general use.
password Password must be at least 6
characters.
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- Account is disabled if inactive
expire after N days past expiration.
disable-date Account is disabled on this date.

The min-days-between-change, max-days-between-change,


warn-days-before-expire, and disable-days-after-expire
options are optional. These options control password aging. The
disable-date is an optional date for password for account
expiration. If this date is not specified, the account never expires.
This command is available to administrative users only.

360 user
change
change password
user change password [user-name]
Use this command to change a users password. The admin user
can change any users password by using the user-name option.
Users with the user privilege level can change only their own
passwords. Passwords must comply with the password strength
policy, which you can check with the command user password
strength show.

change priv
user change priv user-name {admin | user}
Use this command to change a user privilege level to either admin
or user. This command is available to users who currently have
the admin privilege.

del
user del user-name
Use this command to remove a user. This command is available to
administrative users only.

disable
user disable user-name
Use this command to disable the specified user account. This
prevents the user from logging on to the Data Domain system. This
command is available to administrative users only.

enable
user enable user [disable-date date]
Use this command to enable a specified user account with the
optionally specified account disable date. The account must
already exist on the system. If not specified, the disable-date
previously assigned to the account is used. This command is
available to administrative users only.
DD OS 4.9 Command Reference Guide 361
password
password aging option reset
user password aging option reset {all |
[min-days-between-change] [max-days-between-change]
[warn-days-before-expire] [disable-days-after-expire]}
Use this command to 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. This
command is available to administrative users only.

password aging option set


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]
Use this command to set the default values for the password aging
policy. This command is available to administrative users only.

password aging option show


user password aging option show
Use this command to display the default password aging policy.
This command is available to administrative users only.

password aging reset


user password aging reset user {all |
[min-days-between-change] [max-days-between-change]
[warn-days-before-expire] [disable-days-after-expire]}
Use this command to reset one or more rules in the password
aging policy for the specified user to the current default values.
This command is available to administrative users only.

362 user
password aging set
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]
Use this command to set the password aging policy for the
specified user. This command is available to administrative users
only.

password aging show


user password aging show [user]
Use this command to show the password aging policy for all users,
or for a specified user. Users can check the password aging policy
for their own account. Administrative users can check the policies
for all users.
The output of this command is similar to the following:
User Password Minimum Days Maximum Days Warn Days Disable Days Status
Last Changed Between Change Between Change Before Expire After Expire
------ ------------ -------------- -------------- ------------- ------------ -------
joe1 Oct 28, 2009 0 99999 7 never enabled
sysadmin Mar 16, 2006 0 99999 7 never enabled

password strength show


user password strength show
Show the current password strength policy. This command is
available to administrative users only.
# user password strength show
Minimum length of password: 7
Minimum number of character classes required in the
password: 2

DD OS 4.9 Command Reference Guide 363


password strength reset
user password strength reset {all | min-length |
min-char-classes}
Reset the password strength policy to the default values. This
command is available to administrative users only.
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.

password strength set


user password strength set {[min-length length]
[min-char-classes 1|2|3|4]}
Set the password strength policy. Specify either min-length or
min-char-classes, or both. This command is available to
administrative users only.
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
lower-case letters, upper-case letters, digits, and
special characters. When DD OS counts the
number of character classes, an upper-case letter
at the beginning of the password does not count
as an upper-case letter. Similarly, a digit at the
end of the password does not count as a digit.

# user password strength set min-length 8


Specified password policy parameters have been
enforced.

364 user
reset
user reset
Use this command to delete all users except for the sysadmin
account and the current login. The password aging and password
strength options also get reset to their default values. This
command is available to administrative users only.

show
show active
user show active
Use this command to display the currently logged-in users.

show detailed
user show detailed [user-name]
Use this command to show detailed information for a specified
user or for all users. This command is available to administrative
users only.

show list
user show list
Use this command to display a valid list of system users. This
command is available to administrative users only.

user Examples

Add a User
To add a user named fred with password barney and with admin
privileges, run this command:
user add fred password barney priv admin
user "fred" added.

DD OS 4.9 Command Reference Guide 365


Remove a User
To delete the user named fred, run this command:
user del fred
deleted user "fred".

Change a Password
To change the password for the user named wilma, run this
command:
user change password wilma
Enter new password:
Re-enter new password:
Passwords matched
Password changed for user "wilma".

Change a Privilege Level


To change the privilege level to admin for the user named wilma,
run this command:
user change wilma admin
Privilege changed for user "wilma".

Reset to the Default User


To reset the user list to the sysadmin user and the current user,
barney, run this command. The response looks similar to the
following, which lists all removed users:
user reset
This command will delete all user accounts (except
sysadmin) and reset password strength and password
aging options to factory default values.
Are you sure? (yes|no|?) [no]: yes
ok, proceeding.
Resetting user accounts.....
Deleted user "joe".
Resetting user accounts.....[DONE]
Resetting password aging options.....
Password aging options have been reset.
Resetting password aging options.....[DONE]
Resetting password strength options.....

366 user
Password strength requirements reset to defaults:
- min-length: 1
- min-character-classes: 1
Resetting password strength options.....[DONE]

Display Current Users


To display the users currently on the Data Domain system, use this
command
# user show active
User list from node "localhost".
Name Idle Login Time Login From tty Session
-------- ---- ---------------- --------------- ----- -------
sysadmin 22d Mon Dec 8 14:36 tty1 10650
fred 0s Tue Dec 30 15:39 192.168.128.154 pts/0 23404
-------- ---- ---------------- --------------- ----- -------
2 users found.

The display of users currently logged into a Data Domain system


includes the following information:
Name The users login name.
Idle The amount of time logged in with no actions
from the user.
Login Time The date and time when the user logged in.
Login From The address from which the user logged in.
tty The hardware or network port through which the
user is logged in or GUI for the users logged in
through the Data Domain Enterprise Manager
Web-based interface.
Session The users session number.

DD OS 4.9 Command Reference Guide 367


Display All Users
To display a list of valid user accounts on the Data Domain system.
# user show list
User list from node "localhost".
Name Uid Class Last Login From Last Login Time Status Disable Date
------- --- ----- --------------- ------------------------ ------- ------------
sysadmin 100 admin 192.168.128.98 Tue Oct 27 17:15:06 2009 enabled never
joe1 501 user <unknown> never enabled never
------- --- ----- --------------- ------------------------ ------- ------------
2 users found.

The display of all users known to the Data Domain system


includes the following:
Name The users login name.
Uid The users ID number.
Class The users access level.
Last Login From The address from which the user logged in.
Last Login Time The date and time when the user last logged in.
Status The user status.
Disable Date The date on which this account is to be disabled.

368 user
28 vtl

The vtl command creates, manages, and deletes Virtual Tape


Libraries (VTLs) on a Data Domain system.
The vtl command has the following options:
add Add a tape library. Page371
cap Add or delete one or more Cartridge Access Ports Page371
(CAPs) from a VTL.
del Delete an existing tape library. Page372
disable Close all libraries and shut down the VTL process. Page372
drive Add or delete virtual drives. Page372
enable Start the VTL process. Page373
export Remove tapes from a slot, drive, or cartridge- Page373
access port and send them to the vault.
group Configure, modify, delete, and show groups. Page373
import Move existing tapes from the vault into a slot, Page380
drive, or cartridge-access port.
initiator Manage and show initiator aliases. Page381
option Manage and show VTL options. Page384
pool Add, delete, and show pools. Page386
port Configure and show ports. Page387
reset hba Broadcast new VTLs and VTL changes to clients. Page389
show Display VTL information. Page389
slot Add or delete one or more slots in a VTL library. Page391
status Display the state of the VTL process. Page391
tape Configure and display tapes. Page392

DD OS 4.9 Command Reference Guide 369


About the vtl Command
Using the Data Domain VTL feature, backup applications can
connect to and manage a Data Domain system as if it were a stand-
alone tape library. All of the functionality that is supported with
tape is available with a Data Domain system. As with a physical
stand-alone tape library, data movement from a system that uses
VTL to a physical tape gets managed by backup software, not by
the Data Domain system.
The vtl command is available to administrative users only.
Virtual tape drives are accessible to backup software in the same
way as physical tape devices. After you create the devices in the
VTL, the devices appear to the backup software as SCSI tape
drives. A virtual tape library appears to the backup software as a
SCSI robotic device accessed through standard driver interfaces.
Data Domain VTL supports simultaneous use of tape library and
file system (NFS, CIFS, or OST) interfaces.
Note: VTL is a Data Domain licensed feature. Contact your Data
Domain representative for licensing information.
Virtual tape cartridges are created in one or more tape pools. Each
tape cartridge has a barcode that is unique within the tape pool.
Virtual tape cartridges that are not imported into a VTL reside in a
virtual tape vault. Tape cartridges are placed in the vault when
initially created, and can only be deleted while they are in the
vault.
Data Domain recommends single-initiator zoning when using the
VTL feature in a SAN (Storage Area Network) environment to
simplify management and avoid possible host configuration
issues. Single initiator zoning places each initiator, such as a
backup server, in a single zone. To allow additional hosts access to
Data Domain system VTL devices, use VTL access groups. Add
VTL devices and initiators into groups for access.
For example, to let two backup servers access a Data Domain
system HBA in a SAN environment:
1. Define two zones, one for each server.

2. Create one VTL access group for each server.

370 vtl
Options for the vtl Command

add
vtl add vtl [model model] [slots num-slots] [caps num-caps]
Add a tape library (up to 64 library instances). This command is
available to administrative users only.
vtl A name of your choice.
model A tape library model name. The current supported
model names are L180 and RESTORER-L180. See the
Data Domain technical note for your backup
software for the model name that you should use. If
using RESTORER-L180 as the model name, your
backup software may require an update.
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 20,000. The default is 20 slots.
num-caps The number of cartridge-access ports. The default is
0 (zero) and the maximum is 100 per library or 1000
per system.

cap
cap add
vtl cap add vtl [count num-caps]
Add num-caps CAPs to a Virtual Tape Library. The total number
of CAPs cannot exceed 100 per library or 1000 per system. This
command is available to administrative users only.

cap del
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. This command is available to
administrative users only.

DD OS 4.9 Command Reference Guide 371


del
vtl del vtl
Remove an existing virtual tape library. This command is available
to administrative users only.

disable
vtl disable
Close all libraries and shut down the VTL process. This command
is available to administrative users only.

drive
drive add
vtl drive add vtl [count num_drives] [model model]
Add virtual drives to a VTL.
vtl The virtual tape library name.
num_drives The number of drives to add. The maximum
number of drives across all VTLs is 64 to 256,
depending on the memory installed in your Data
Domain system. Systems with 4 G of memory
(DD4xx, DD510 and DD530) can have a maximum
of 64 drives. Systems with 8 GB to 38 GB (DD580,
DD660, and DD690) can have a maximum of 128
drives. Systems with 39 GB or more (DD880 and
later) can have a maximum of 256 drives.
model One of IBM-LTO-1, IBM-LTO-2, or IBM-LTO-3. The
default drive type is IBM-LTO-3.

Drives are added by starting with drive number 1 and scanning for
any holes left by the vtl drive del command. Once the holes are
filled, the drives are appended to the end of the library. The
number of slots within a library can never be less 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 will automatically add
the needed number of slots. This command is available to
administrative users only.
372 vtl
Note: You cannot mix drive models within the same library.

drive del
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 holes in the drive list. This may cause issues
with some applications. This command is available to
administrative users only.

enable
vtl enable
Start the VTL process. This command is available to administrative
users only.

export
vtl export vtl {slot | drive | cap} address [count count]
Remove tapes from a slot, drive, or cartridge-access port and send
them to the vault. Use the vtl tape show vtl-name command to
display slots and tape barcodes.
vtl The virtual tape library name.
address The number of the slot, drive, or cartridge-access port.
count The number of tapes to remove.

This command is available to administrative users only.

group
The VTL group feature allows clients to access only selected LUNs
(devices, which are virtual media changers or virtual tape drives)
from a Data Domain system. This command is available to
administrative users only.
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.

DD OS 4.9 Command Reference Guide 373


Note: Avoid using the vtl reset hba command during active
backup or restore jobs. The changes may cause an active job to fail
depending on the backup application and host type.

group add
vtl group add group_name initiator alias_or_WWPN
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 an item to the specified VTL access group. You can add an
initiator, a VTL, or devices within a VTL, 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. This command is
available to administrative users only.

group_name A VTL access group.


Note: TapeServer is a reserved group and
cannot contain initiators.
Default, all, and summary are also reserved
and cannot be used at all.
vtl_name A VTL to add.
alias_or_WWPN An initiator alias or WWPN.
all | The devices to add. The drive_list is a
changer | comma-separated list of drives. The drive
drive number can be a single number, or a range of two
drive_list numbers separated by a hyphen (-). The drive
numbers are integers starting from 1. Examples
include: 1, 2, 3-1, and 3-2.
If drive_list contains more than one drive and
you specify lun, it gets used as the starting LUN.
If drive_list includes a LUN that has already
been used, the system skips to the next free lun.

374 vtl
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 0 (zero)
and be contiguous numbers.
primary-port The primary VTL ports on which the devices are
all | none | visible. By default, or if you specify all, the VTL
port-list devices are visible on all ports. Specify none if
the devices should not be visible on any ports.
See below for a description of port-list.
This option lets you apply VTL access groups to
specific Data Domain system VTL ports. This
feature supports path flexibility for handling path
failure and load-balancing of VTL devices across
ports.
secondary-port The secondary VTL ports on which the devices
all | none | are visible to the vtl group use secondary
port-list command. By default, the devices are visible on
all ports. See below for a description of port-
list.
The secondary port list supports path
redundancy. Use the vtl group use primary
command to return the group to the primary port
list after the path gets repaired. See group use on
page 379.
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.
To list port names, use the vtl port show
summary command.
You can set an alias for the initiators with the vtl
initiator set alias command.

Related Commands
Use the vtl group use command to switch between the primary
and secondary port lists in the event of path failure.
The vtl show config command displays configuration
information for all defined VTLs.

DD OS 4.9 Command Reference Guide 375


The vtl group show command displays a list of access groups as
well as initiators and VTL devices within each group.
The vtl initiator show command displays an initiator list and
the current status (online or offline) for each Data Domain system
VTL port from which the initiator is detected. Offline means the
initiator is not currently visible from a Data Domain system VTL
port.
Note: Some initiators running HP-UX that are directly connected
to the Data Domain system show the status of the initiator as
offline in the vtl initiator show output when the device is in
fact online. If this occurs, verify whether the device is connected by
visually inspecting the Data Domain system HBA LEDs.

group create
vtl group create group_name
Use this command to create a VTL access group with a specified
group-name. Each Data Domain system device (media changer or
tape drive) as well as initiators may then be added to the VTL
access group. This command is available to administrative users
only.
group_name The name of the new group. The name must be
unique, must not be longer than 256 characters, and
can contain only the characters 0-9, a-z, A-Z,
underscore(_), and hyphen (-). You can create up to
128 groups. Do not use the reserved group names
Default, TapeServer, all and summary.
Note: VTL group names are case-insensitive.

group del
vtl group del group_name initiator alias_or_WWPN
vtl group del group_name vtl vtl_name {all | changer | drive
drive_list}
Use this command to delete an initiator from a group. Specify the
initiator by its WWPN or alias. This command immediately
removes access from the specified initiator to the VTL devices

376 vtl
within the group. This command is available to administrative
users only.
group_name The group from which to delete the item.
vtl_name The VTL to delete from the group, or the VTL
that contains the devices to delete.
drive_list A comma-separated list of drives. The drive
number can be a single number, or a range of
two numbers separated by a hyphen (-). The
drive numbers are integers starting from 1.
Examples include 1, 2, 3-1, and 3-2.
alias_or_WWPN The initiator to delete.

group destroy
vtl group destroy group_name
Use this command to delete the specified empty VTL access group.
Before you destroy a group, use the vtl group del command to
remove the initiators and devices from the group. This command
is available to administrative users only.
group_name The group to destroy.

group modify
vtl group modify group_name vtl vtl_name {all | changer [lun
lun] | drive drive_list [lun lun]} [primary-port {all | none |
port-list}] [secondary-port {all | none | port-list}]
Use this command to 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. This command is available to
administrative users only.
group_name The group from which to delete the item.
vtl_name The VTL to delete from the group, or the VTL that
contains the devices to delete.

DD OS 4.9 Command Reference Guide 377


drive_list A comma-separated list of drives. The drive
number can be a single number, or a range of two
numbers separated by a hyphen (-). The drive
numbers are integers starting from 1. Examples
include 1, 2, 3-1 and, 3-2.
lun The LUN to use for this group.
primary-port The primary VTL ports on which the devices are
all | none visible. By default, or if you specify all, the VTL
| port-list devices are visible on all ports. Specify none if the
devices should not be visible on any ports. See
below for a description of port-list.
This option lets you apply VTL access groups to
specific Data Domain system VTL ports. This
feature supports path flexibility for handling path
failure and load-balancing of VTL devices across
ports.
secondary-port The secondary VTL ports on which the devices
all | none are visible to the vtl group use secondary
| port-list command. By default, the devices are visible on
all ports. See below for a description of port-
list.
The secondary port list supports path
redundancy. Use the vtl group use primary
command to return the group to the primary port
list after the path gets repaired. See group use on
page 379.
port-list A comma-separated list of Data Domain system
VTL ports. You can specify port names as a range
separated by a '-'. The ports must already exist.
To list port names, use the vtl port show
summary command.
You can set an alias for the initiators with the vtl
initiator set alias command.

If you omit any option, the current value remains unchanged.

378 vtl
group rename
vtl group rename src_group_name dst_group_name
Use this command to rename an existing VTL access group. The
dst_group_name must not already exist. See group create on
page 376 for a description of group name rules.
This command does not interrupt any active sessions. This
command is available to administrative users only.

group show
vtl group show [all | vtl vtl-name | group_name]
Use this command to show information about VTL access groups.
This command is available to administrative users only.
all Show information about all groups (default).
vtl-name Show information about all VTL access groups that
contain any devices within the specified vtl-name.
group_name Show detailed information about the specified
group.

group use
vtl group use group_name [vtl vtl-name {all | changer | drive
drive_list}] {primary | secondary}
Use this command to immediately change the access path to the
primary or secondary port for the selected VTL components in an
access group. When the path gets restored, you can use this
command to return the group to its primary port list. This
command is available to administrative users only.
group_name The VTL access group to use.
vtl-name The VTL to use.
drive_list A comma-separated list of drives. The drive number
can be a single number, or a range of two numbers
separated by a hyphen (-). The drive numbers are
integers starting from 1. Examples include 1, 2, 3-1,and
3-2.

DD OS 4.9 Command Reference Guide 379


After you apply a group to new Data Domain system VTL ports, a
rescan of media server's SCSI bus may be necessary. Also, a
backup application may need to rescan available SCSI devices.
Note: This command interrupts any current access to the specified
group and is intended to be used during path failures.

import
vtl import vtl_name barcode barcode [count count]
[pool pool_name] [element {drive | cap | slot}] [address addr]
Use this command to move existing tapes from the vault into a
slot, drive, or cartridge access port. This command is available to
administrative users only.
vtl_name The VTL to use.
barcode The identifier for a virtual tape.
count The number of tapes to import.
pool_name The name of the pool, which is required if the tapes are
in a pool.
element The destination element. The default is slot.
addr The address. The default is 1.

Use the vtl tape show vtl-name command to display the total
number of slots for a VTL and which slots are currently used. Use
backup software commands from the backup server to move VTL
tapes to and from drives.
The following two commands are equivalent:
# vtl import VTL1 barcode TST010L1 count 5
# vtl import VTL1 barcode TST010L1 count 5 element slot
address 1

380 vtl
Rules for the Number of Tapes Imported
The number of tapes that you can import at one time is limited by:
The number of empty slots. (You cannot import more tapes
than the number of currently empty slots.)
The number of slots that are empty and that are not reserved
for a tape that is currently in a drive.
If a tape is in a drive and the tape origin is known to be a slot,
the slot is reserved.
If a tape is in a drive and the tape origin is unknown (slot or
CAP), a slot is reserved.
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.)
The number of tapes you can import equals:
(Total empty slots) - (the number of tapes that came from slots)
- (the number of tapes of unknown origin)

initiator
initiator reset address-method
vtl initiator reset address-method initiator alias_or_WWPN
Use this command to reset the address method used by REPORT
LUNS back to the default (auto). This command is available to
administrative users only.

initiator reset alias


vtl initiator reset alias alias_name
Use this command to reset (delete) the initiator alias from the
system. Deleting the alias does not affect any VTL access from the
specified initiator. This command is available to administrative
users only.
Note: To remove an initiator from a group, use the vtl group
del command instead.

DD OS 4.9 Command Reference Guide 381


initiator set address-method
vtl initiator set address-method { auto | vsa }
initiator alias_or_WWPN
This command sets the device address method used when
responding to a SCSI REPORT LUNS command from the specified
initiator. This command is available to administrative users only.
With most platforms, you do not need to specify a device address
method. Use this command to work around any platform-specific
limitations that you encounter.
auto The device address method gets chosen based on
the numeric LUN range being reported:
For 0 - 255, peripheral device addressing is
used.
For 256 - 16383, flat device addressing is used.
This is the default.
vsa The method is set to volume set addressing. 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.
alias_or_WWPN The initiator to configure.

382 vtl
initiator set alias
vtl initiator set alias alias_name wwpn wwpn
This command sets an alias for an initiator's WWPN. An initiator is
any Data Domain system client HBA's world-wide port names
(WWPN). This command does not interrupt traffic or VTL group
access. This command is available to administrative users only.
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 client's HBA WWPN, including colon delimiters.
The alias must be unique, must not be longer than 256 characters,
and can contain only the characters 0-9, a-z, A-Z, underscore(_),
and hyphen (-). You can create up to 128 aliases.
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
wwpn 21:00:00:e0:8c:11:33:04

initiator show
vtl initiator show [initiator initiator | port port]
Use this command to display the following information about one
or all initiators:
Group
Status
WWNN
WWPN
Port
Symbolic port name
Address method
This command is useful in troubleshooting and during setup. This
command is available to administrative users only.

DD OS 4.9 Command Reference Guide 383


option
option disable
vtl option disable {auto-eject | auto-offline}
Use this command to disable automatically taking tapes offline or
automatically ejecting them before a move command is issued. This
command is available to administrative users only.

auto-eject Automatically move any tape that is in a cartridge-


access port to the vault. The exception is that if the
tape came from the vault, the tape stays in the
cartridge-access port (CAP).
Note: With auto-eject enabled, a tape moved from
any element to a CAP will be ejected to the vault
unless an ALLOW_MEDIUM_REMOVAL command with
a value of 0 (false) was issued to the library to
prevent the removal of the medium from the CAP to
the outside world.
auto-offline Automatically offline a tape when a move command
is generated. Use this option when backup or other
software does not issue an offline command to the
tape drive before issuing a move command to the
media changer.

384 vtl
option enable
vtl option enable {auto-eject | auto-offline}
Use this command to enable either the auto-eject or the auto-
offline option. This command is available to administrative users
only.
auto-eject Automatically move any tape that is in a cartridge-
access port to the vault. The exception is that if the
tape came from the vault, the tape stays in the
cartridge-access port (CAP).
Note: With auto-eject enabled, a tape moved from
any element to a CAP is ejected to the vault unless an
ALLOW_MEDIUM_REMOVAL command with a value of
0 (false) was issued to the library to prevent the
removal of the medium from the CAP to the outside
world.
auto-offline Automatically move a tape offline when a move
command is generated. Use this option when backup
or other software does not issue an offline command
to the tape drive before issuing a move command to
the media changer.

option reset loop-id


vtl option reset loop-id
Use this command to reset the private-loop hard address to the
default of 1 (one). This command is available to administrative
users only.

option set loop-id


vtl option set loop-id value
Use this command to give a Data Domain system VTL HBA a
private-loop hard address. The range for value is from 0 (zero) to
125. To enable the new value, disable and then re-enable the VTL
by using the vtl disable and vtl enable commands.
This command is available to administrative users only.

DD OS 4.9 Command Reference Guide 385


option show
vtl option show {option_name | all}
Use this command to display the most recent VTL option settings.
Disable/enable vtl to make the option become active. This
command is available to administrative users only.

pool
pool add
vtl pool add pool_name
Use this command to create a tape pool to allow replication by
pools. A pool is a named vault for tapes. If you do not create a
pool, the tapes get placed in the vault named Default. Pools are
for replication commands only.
This command is available to administrative users only.

pool del
vtl pool del pool_name
Use this command to delete a tape pool. You must first use the vtl
tape del command to remove all of the tapes from the pool.

This command is available to administrative users only.

pool show
vtl pool show {all | pool_name}
Use this command to list the configured tape pools or the contents
of a specific pool_name. This command is available to
administrative users only.

386 vtl
port
port disable
vtl port disable {all | port-list}
Use this command to disable all of the Fibre-Channel ports, or the
specific ports in port-list. The port-list may contain ports that
are already disabled. All of the specified ports must exist. This
command is available to administrative users only.

port enable
vtl port enable {all | port-list}
Use this command to enable one or more Fibre-Channel ports. The
port-list may contain ports that are already enabled. All of the
specified ports must exist. This command is available to
administrative users only.

port show detailed-stats


vtl port show detailed-stats
Use this command to show the following information:
Control commands
Write commands
Read commands
In (number of MiB written--the binary equivalent of MB)
Out (number of MiB read)
Link failures
LIP count
Sync losses
Signal losses
Count of errors in primitive sequence protocol
Number of invalid tx words

DD OS 4.9 Command Reference Guide 387


Number of frames received with a bad CRC
This command is available to administrative users only.

port show hardware


vtl port show hardware
Use this command to show the following hardware information:
Model
Firmware
WWNN
WWPN
This command is available to administrative users only.

port show stats


vtl port show stats [port {port-list | all}] [interval secs]
[count count]
This command shows a summary of the VTL I/O statistics of all
the drives in all the VTLs on all of the Fibre Channel ports where
the drives are visible. This command is available to administrative
users only.
port port- Show detailed statistics for the devices that are
list accessible on the specified VTL ports.
port all Show detailed statistics for all ports. This is the default
if you omit the port option.
secs Seconds between each refresh of the display
count Maximum number of summaries to display.

388 vtl
port show summary
vtl port show summary
Use this command to show the following information:
Port
HBA slot
HBA port
Connection type
Link speed
Port ID
Enabled
Status
This command is available to administrative users only.

reset hba
vtl reset hba
Use this command to broadcast new VTLs and VTL changes to
clients. This command is available to administrative users only.
Note: Avoid using the vtl reset hba command during active
backup or restore jobs. The changes may cause an active job to fail
depending on the backup application and host type.

show
show config
vtl show config [vtl]
For all VTLs, or optionally a single VTL, this command displays
the following information:
Library name and model
Tape drive model
This command is available to administrative users only.
DD OS 4.9 Command Reference Guide 389
show element-address
vtl show element-address [vtl]
For all VTLs, or optionally a single VTL, this command displays
the following information:
Starting element address
Slot count and starting address
CAP count and starting address
Drive count and starting address
Changer count and starting address
This command is available to administrative users only.

show stats
vtl show stats vtl [drive {drive-list | all}] [port {port-list |
all}] [interval secs] [count count]
Use this command to show detailed traffic statistics for devices
that belong to the specified VTL. The statistics include the speed of
reads and writes in KiB per second, per VTL drive. If you omit
both drive and port (or specify all for both), you see the total
traffic statistics for all devices on all ports. This command is
available to administrative users only.

vtl The VTL to query.


drive Show statistics for only the drives in a comma-
drive-list separated list of drives. The drive number can be a
single number, or a range of two numbers separated by
a hyphen (-). The drive numbers are integers starting
from 1. Examples include 1, 2, 3-1, and 3-2.
drive all Show statistics for all drives. This is the default if you
omit the drive option.
port port- Show statistics for the devices that are accessible on the
list specified VTL ports.
port all Show statistics for all ports. This is the default if you
omit the port option.

390 vtl
secs The interval between repeated displays of
statistics. For example, interval 1, shows
statistics every second. The default interval is 2
seconds.
count Show statistics for count number of times. For
example, count 10 displays statistics 10 times, each
instance being interval secs apart. The default
count is infinity, that is, the statistics display forever (or
until the command is aborted with Ctrl+C).

slot
slot add
vtl slot add vtl [count num_to_add]
Use this command to add one or more slots to the end of the
specified Virtual Tape Library. The maximum is 20,000 slots,
distributed across one or more libraries. This command is available
to administrative users only.
vtl The VTL to modify.
num_to_add The number of slots to add. The default is 20 slots.

slot del
vtl slot del vtl [count num_to_del]
Use this command to delete one or more slots from the end of the
specified Virtual Tape Library. This command is available to
administrative users only.
vtl The VTL to modify.
num_to_del The number of slots to delete. The default is 20 slots.

status
vtl status
Use this command to display the state of the VTL process. This
command is available to administrative users only.

DD OS 4.9 Command Reference Guide 391


tape
tape add
vtl tape add barcode [capacity capacity] [count count] [pool
poolname]
Use this command to add one or more virtual tapes and insert
them into the vault. Optionally, associate the tapes to an existing
pool for replication. This command is available to administrative
users only.
Note: Capacities are quoted here in GiB or GibiBytes, the base-2
version of GB or GigaBytes.)
barcode An eight-character identifier that must start with six
numeric or upper-case alphabetic characters (that is, 0-9
and 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 type.
L1 represents a tape of 100 GiB capacity.
L2 represents a tape of 200 GiB capacity.
L3 represents a tape of 400 GiB capacity.
LA represents a tape of 50 GiB capacity.
LB represents a tape of 30 GiB capacity.
LC represents a tape of 10 GiB capacity.
These capacities are the default sizes that get used if you
omit the capacity option when you create the tape
cartridge. If you specify capacity , that value overrides
the two-character tag.
capacity The number of GibiBytes for each tape created. This value
overrides the barcode tag capacities. The upper limit is
800. For the efficient reuse of Data Domain system disk
space after data becomes obsolete (and the Data Domain
system cleaning process marks data for removal), Data
Domain recommends setting capacity to 100 or less.
count The number of tapes to create. The default is 1 (one).
poolname Associate the tapes with the specified pool. The pool
name is Default if you do not specify a name.
The pool that you specify must already exist. See pool
add on page 386.

392 vtl
Sample Barcodes
000000L1 Create tapes of 100 GiB capacity which can accept a
count of up to 1,000,000 tapes (from 000000 to
999999). You can create up to 100,000 tapes in a
single operation.
AA0000LA Create tapes of 50 GiB capacity which can accept a
count of up to 10,000 tapes (from 0000 to 9999).
AAA350LB Create tapes of 30 GiB capacity and can accept a
count of up to 650 tapes (from 350 to 999).
5M7Q3KLC Create one tape of 10 GiB capacity. You can create
only one tape with this name; you cannot increment
the name.

Rules for Automatic Barcode Incrementing


To automatically increment the barcode when creating more than
one tape, the system follows these steps:
1. Start at the sixth character position, just before L.

2. If the character is a digit, increment it.

3. If an overflow occurs, 9 to 0, then move one position to the left.

4. If the character is a digit, increment it.

5. If the character is alphanumeric, stop.

tape del
vtl tape del barcode [count count] [pool poolname]
Use this command to delete one or more tapes and all of the data
on those tapes. This command is available to administrative users
only.
barcode The barcode identifier for the tape (or for the first tape,
if you also specify count).
count The number of tapes to delete, in order, based on the
numeric characters in the bar code.
poolname The name of the pool that contains the specified tape.
This option is required if the tapes are in a pool.

DD OS 4.9 Command Reference Guide 393


You cannot delete tapes that are in a VTL. See export on page 373 to
remove tapes from a VTL. This command is available to
administrative users only.

tape modify retention-lock


vtl tape modify barcode [count count] [pool poolname]
retention-lock stamp
Use this command to change the amount of time to maintain the
retention-lock on a specified tape. If the volume is not mounted,
the change gets made immediately. Otherwise, the data gets
synchronized first. If the file system is read-only, the command
fails. This command is available to administrative users only.
barcode The barcode identifier for the tape.
count The number of tapes to modify, in order, based on the
numeric characters in the bar code.
poolname The name of the pool that contains the specified tape.
This option is required if the tapes are in a pool.
stamp An absolute date or a relative time after the current
time.
For an absolute date, specify a four-digit year, a two-
digit month, and a two-digit day separated by dots ( . ),
slashes ( / ), or hyphens ( - ). For example,
2009.05.22.
For a relative date, specify a number of days, weeks
or wks, or months or mos with no space between the
number and the days, weeks, or months. For example,
6wks, 1year, or 6months. The months or mos period
is always 30 days.
With an absolute date, the retention-lock is maintained
until midnight (00:00, the first minute of the day) of the
given date. With a relative time, the retention-lock is
maintained until the same time of day as you execute
this command.

To retention-lock 500 tapes starting at barcode AA0000LC for one


year:
# vtl tape modify AA0000LC count 500 retention-lock
1year

394 vtl
tape modify writeprotect
vtl tape modify barcode [count count] [pool poolname]
writeprotect {on | off}
Use this command to set the write protect state of a specified tape.
If the volume is not mounted, the tape file permission gets changed
immediately. Otherwise, any outstanding writes are synchronized
first. If the file system is read-only and you try to use this
command to turn write protection off, the command fails. This
command is available to administrative users only.
barcode The barcode identifier for the tape.
count The number of tapes to modify, in order, based on the
numeric characters in the bar code.
poolname The name of the pool that contains the specified tape.
This option is required if the tapes are in a pool.

tape move
vtl tape move barcode barcode [count count] source src-pool
destination dest-pool
Use this command to move tapes between VTL pools.
barcode The barcode identifier for the tape.
count The number of tapes to move. These tapes must have
sequential barcodes.
src-pool The current pool.
dest-pool The new pool.

You cannot move the following kinds of tapes:


Tapes that are in a VTL library
Tapes on a replica
Retention-lock controlled tapes

DD OS 4.9 Command Reference Guide 395


vtl tape move vtl source {slot | drive | cap} src-address
destination {slot | drive | cap} dest-address
Use this command to move a tape between elements in specified
Virtual Tape Library. This command is available to administrative
users only.
vtl The Virtual Tape Library that contains the tape.
src-address The current tape location. Specify whether the
address is a slot, drive, or cap with those
keywords.
dest-address The new tape location. Specify whether the address
is a slot, drive, or cap with those keywords.

tape show
vtl tape show {all | pool pool | vault | vtl} [summary] [count
count] [barcode barcode] [sort-by {barcode | pool | location |
state | capacity | usage | percentfull | compression | modtime}
[{ascending | descending}]]
Use this command to display information about tapes. This
command is available to administrative users only.
all Show information about all tapes.
pool pool Show information about the tapes in the specified
pool.
vault Show information about tapes in the vault.
vtl Show information about tapes in the specified vtl.
summary Show a summary of all tapes and tape usage.
count count Show the specified number of tapes in order, based on
the numeric characters in the bar code.
barcode Show information about tapes that match the specified
barcode barcode.
When using count and barcode together, use a wild
card character in the barcode to have the count be
valid. An asterisk (*) matches any character in that
position and all further positions. A question mark (?)
matches any character in that position.

396 vtl
sort-by Sort the report on the specified column: barcode,
pool, location, state, capacity, usage (number
of bytes used on the tape), percentfull,
compression, or modtime (modification time).
ascending | Sort the report in the specified order.
descending

The following example displays three tapes starting with barcode


ABC00.
# vtl tape show vault count 3 barcode ABC00*L1

Examples

Add a VTL
The following commands add a VTL, add tapes, and then populate
the VTL slots with tapes. The VTL is then ready for backup
commands.
1. Create a new VTL:
# vtl add libr01 model L180 slots 200 caps 2
2. Add four IBM-LTO-3 drives to the VTL:
# vtl drive add libr01 count 4 model IBM-LTO-3
3. Adds tapes to the VTL:
# vtl tape add ABC100L1 capacity 75 count 50
4. Import tapes into the VTL slots:
# vtl import libr01 barcode ABC100L1 count 10

Move Tapes
1. Move ten tapes starting at AA0000LC from pool srcpool to
pool dstpool:
# vtl tape move barcode AA0000LC count 10 source
srcpool destination dstpool

DD OS 4.9 Command Reference Guide 397


Manually Import and Export Tapes
1. Import three tapes to drives.
# vtl import lib1 barcode ABC000L1 element drive address 1
count 3
... imported 3 tape(s)...
2. Check the result.
# vtl tape show lib1
Processing tapes....
Barcode Pool Location State Size Used
(%) Comp ModTime
ABC000L1 Default lib1 drive 1 RW 100 GiB 0.0 GiB (
0.00%) 0x 2009/10/29 12:07:31
ABC001L1 Default lib1 drive 2 RW 100 GiB 0.0 GiB (
0.00%) 0x 2009/10/29 12:07:31
ABC002L1 Default lib1 drive 3 RW 100 GiB 0.0 GiB (
0.00%) 0x 2009/10/29 12:07:31
-------------------
VTL Tape Summary
Total number of tapes: 3
Total pools: 1
Total size of tapes: 300 GiB
Total space used by tapes: 0.0 GiB
Average Compression: 0.0x
3. Export three tapes from drives.
# vtl export lib1 drive 1 count 3
... exported 3 tape(s)...
4. Import two tapes to CAPs.
# vtl import lib1 barcode ABC000L1 element cap address 1 count 2
... imported 2 tape(s)...
5. Check the results of the import.
# vtl tape show lib1
Processing tapes....

398 vtl
Barcode Pool Location State Size Used
(%) Comp ModTime
ABC000L1 Default lib1 cap 1 RW 100 GiB 0.0 GiB (
0.00%) 0x 2009/10/29 12:07:31
ABC001L1 Default lib1 cap 2 RW 100 GiB 0.0 GiB (
0.00%) 0x 2009/10/29 12:07:31
VTL Tape Summary
----------------
Total number of tapes: 2
Total pools: 1
Total size of tapes: 200 GiB
Total space used by tapes: 0.0 GiB
Average Compression: 0.0x
6. Export two tapes from CAPs.
# vtl export lib1 cap 1 count 2
... exported 2 tape(s)...
7. Import three tapes to slots.
# vtl import lib1 barcode ABC000L1 count 3
... imported 3 tape(s)...
8. Check the results of the import.
# vtl tape show lib1
Processing tapes....
Barcode Pool Location State Size Used
(%) Comp ModTime
ABC000L1 Default lib1 slot 1 RW 100 GiB 0.0 GiB (
0.00%) 0x 2009/10/29 12:07:31
ABC001L1 Default lib1 slot 2 RW 100 GiB 0.0 GiB (
0.00%) 0x 2009/10/29 12:07:31
ABC002L1 Default lib1 slot 3 RW 100 GiB 0.0 GiB (
0.00%) 0x 2009/10/29 12:07:31
VTL Tape Summary
----------------
Total number of tapes: 3
Total pools: 1
Total size of tapes: 300 GiB
DD OS 4.9 Command Reference Guide 399
Total space used by tapes: 0.0 GiB
Average Compression: 0.0x
9. Export three tapes from slots.
# vtl export lib1 slot 1 count 3
... exported 3 tape(s)...

Important Notices
Before starting to use Data Domain VTL, you need to:
Obtain a license.
The VTL feature requires a license. See your Data Domain sales
representative to purchase a license.
Verify that a Fibre Channel (FC) interface card has been
installed.
Because the VTL feature communicates between a backup
server and a Data Domain system through a Fibre Channel
interface, the Data Domain system must have a Fibre Channel
interface card installed in the PCI card array.
Set the backup software minimum record (block) size.
Data Domain strongly recommends that backup software be
set up to use a minimum record (block) size of 64 KiB or larger.
Larger sizes usually give faster performance and better data
compression.
Note: If you change the size after initial configuration, data
written with the original size becomes unreadable.

Compatibility
Data Domain VTL is compatible with all DD400, DD500, DD600,
and DD800 series Data Domain systems.
For specific backup software and hardware configurations tested
and supported by Data Domain, see the VTL matrices at the Data
Domain Support Web site:
https://my.datadomain.com/documentation

400 vtl
Tape Drives
You can use tape and library drivers supplied by your backup
software vendor that support the IBM LTO-1 (the default), IBM
LTO-2, or IBM LTO- 3 drives and the StorageTek L180,
RESTORER-L180, or IBM TS3200 tape libraries. (See Compatibility
on page 400.)
Because the Data Domain system treats the IBM LTO drives as
virtual drives, you can set a maximum capacity of 800 GB for each
drive type.
The default capacities for each IBM LTO drive type are as follows:
LTO-1 drive: 100 GB
LTO-2 drive: 200 GB
LTO-3 drive: 800 GB
Note: You cannot mix drive types (LTO-1, LTO-2, and LTO-3) or
media types in the same library.

Tape Libraries
Data Domain VTL supports the StorageTek L180, RESTORER-
L180, and IBM TS3200 tape libraries with the following number of
libraries, tape drives, and tapes:
64 libraries (64 concurrently active virtual tape library
instances). Access to VTLs and tape drives can be managed
with the Access Grouping feature. See group on page 373.
Up to 256 tape drives, depending on the memory installed in
your Data Domain system.
Up to 100,000 tapes (cartridges) of up to 800 GiB for an
individual tape (Gibibytes, the base-2 equivalent of Gigabytes).

DD OS 4.9 Command Reference Guide 401


Data Structures
Data Domain VTL includes internal Data Domain system data
structures for each virtual data cartridge. The structures have a
fixed amount of space that is optimized for records of 16 KiB or
larger. Smaller records use the space at the same rate per record as
larger records, leading to virtual cartridges that get marked as
full even though the amount of data is less than the defined size
of the cartridge.

Restrictions
The number of recommended concurrent virtual tape drive
instances is platform-dependent and is the same as the number of
recommended streams between a Data Domain system and a
backup server. This number is system-wide and includes all
streams from all sources, such as VTL, NFS, and CIFS.
Caution: Data Domain VTL does not protect virtual tapes from a
Data Domain system filesys destroy command. The
command deletes all virtual tapes.

402 vtl
A MIB Reference

About the MIB


The Data Domain Management Information Base (MIB) is a hierarchy of objects
that define the status and operation of a Data Domain system. The hierarchy is in
the form of a table.

MIB Browser
The user may find it worthwhile to download a freeware MIB browser. Many can
be found by searching on Google. As an example, the iReasoning MIB browser
can be found for downloading at http://www.ireasoning.com/mibbrowser.shtml, at
the link Download Free Personal Edition.

DD OS 4.9 Command Reference Guide 403


Top-Level Organization of the MIB

404 MIB Reference


Table A-1: Top-Level Organization of the MIB
Tree/subtree Relative OID Info
and Name
The Data Domain MIB 19746 DATA- The MIB is
Description: This document describes the DOMAIN- divided into four
Management Information Base for Data MIB top-level entities:
Domain Products. dataDomainMib
The Data Domain enterprise number is 19746. Conformance
The ASN.1 prefix up to and including the dataDomainMib
Data Domain, Inc. Enterprise is Objects
1.3.6.1.4.1.19746. dataDomainMib
Notifications
Products

The MIB in Text Format


The MIB can be viewed in text form, but it is somewhat difficult to
read. The text form of the section on alerts is shown below, as an
example.
--
-- CurrentAlerts
-- =============
--
-- dataDomainMib (1.3.6.1.4.1.19746)
-- dataDomainMibObjects(1.3.6.1.4.1.19746.1)
-- alerts (1.3.6.1.4.1.19746.1.4)
-- currentAlerts(1.3.6.1.4.1.19746.1.4.1)
--
--
************************************************************

currentAlerts OBJECT IDENTIFIER ::= { alerts 1 }

currentAlertTable OBJECT-TYPE
SYNTAX SEQUENCE OF CurrentAlertEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A table containing entries of
CurrentAlertEntry."
::= { currentAlerts 1 }

currentAlertEntry OBJECT-TYPE
SYNTAX CurrentAlertEntry
MAX-ACCESS not-accessible
STATUS current

DD OS 4.9 Command Reference Guide 405


DESCRIPTION
"currentAlertTable Row Description"
INDEX { currentAlertIndex }
::= { currentAlertTable 1 }

CurrentAlertEntry ::= SEQUENCE {


currentAlertIndexAlertIndexTC,
currentAlertTimestampAlertTimestampTC,
currentAlertDescriptionAlertDescriptionTC
}

currentAlertIndex OBJECT-TYPE
SYNTAX AlertIndexTC
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Current Alert Row index"
::= { currentAlertEntry 1 }

currentAlertTimestamp OBJECT-TYPE
SYNTAX AlertTimestampTC
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Timestamp of current alert"
::= { currentAlertEntry 2 }

currentAlertDescription OBJECT-TYPE
SYNTAX AlertDescriptionTC
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Alert Description"
::= { currentAlertEntry 3 }

--
************************************************************

406 MIB Reference


Entries in the MIB
The MIB is a hierarchy stored in a table. Each entry in the table has
the following fields under it:

Name Full Name of the field. For example:


currentAlertDescription!@#.iso.org.
dod.internet.private.enterprises
.dataDomainMib.dataDomainMibObjects
.alerts.currentAlerts.currentAlertT
able.currentAlertEntry.currentAlert
Description.
This is equivalent to the OID number iso=1,
org=3, dod=6, internet=1, private=4,
enterprises=1, dataDomainMib=19746, etc.

OID Full index number of the field. For example,


.1.3.6.1.4.1.19746.1.4.1.1.1.3

MIB For this MIB, this is always DATA-DOMAIN-


MIB.

Syntax Brief description.

Access For example: read-only.

Status For example: mandatory, current.

DefVal Default value.

Indexes For tables, lists indexes into the table. (For


objects, lists the object.)

Descr Description of the field.

DD OS 4.9 Command Reference Guide 407


Important Areas of the MIB
Four areas deserve special attention and are documented
thoroughly here. The four areas documented here are in the
following order for the sake of clarity (the numbers in parentheses
are the relative numbers inside the MIB):
Alerts (.1.3.6.1.4.1.19746.1.4)
Data Domain MIB notifications (.1.3.6.1.4.1.19746.2)
File system space (.1.3.6.1.4.1.19746.1.3.2)
Replication (.1.3.6.1.4.1.19746.1.8)
A section of information on each area is given (see Alerts
(.1.3.6.1.4.1.19746.1.4) on page 408, Data Domain MIB Notifications
(.1.3.6.1.4.1.19746.2) on page 409, Filesystem Space
(.1.3.6.1.4.1.19746.1.3.2) on page 428, and Replication
(.1.3.6.1.4.1.19746.1.8) on page 430).

Alerts (.1.3.6.1.4.1.19746.1.4)
The Alerts table is a set of containers (variables or fields) that hold
the current problems happening in the system.
By contrast, the Notifications table holds a set of rules for what the
system does in response to problems whenever they happen in the
system. See also Data Domain MIB Notifications (.1.3.6.1.4.1.19746.2) on
page 409.
Alerts are the system for communicating problems, Data Domain's
version of Notifications. The table currentAlertTable holds many
current alert entries at once, with an Index, Timestamp, and
Description for each. The Data Domain Alerts are shown in
FigureA-1 and Table A-2.

Figure A-1: Alerts

408 MIB Reference


The Alerts table is indexed by the index currentAlertIndex.
Table A-2: Alerts
OID Name Description
.1.3.6.1.4.1.19746.1.4 alerts
.1.3.6.1.4.1.19746.1.4.1 currentAlerts
.1.3.6.1.4.1.19746.1.4.1.1 currentAlertTable A table containing entries of
CurrentAlertEntry
.1.3.6.1.4.1.19746.1.4.1.1.1 currentAlertEntry currentAlertTable Row
Description
.1.3.6.1.4.1.19746.1.4.1.1.1.1 currentAlertIndex Current Alert Row index
.1.3.6.1.4.1.19746.1.4.1.1.1.2 currentAlertTimestamp Timestamp of current alert
.1.3.6.1.4.1.19746.1.4.1.1.1.3 currentAlertDescription Alert Description

Data Domain MIB Notifications


(.1.3.6.1.4.1.19746.2)
The Notifications table holds a set of rules for what the system
does in response to problems whenever they happen in the system.
(Notifications are also known as traps.)
By contrast, the Alerts table is a set of containers (variables or
fields) that hold the current problems happening in the system. See
also Alerts (.1.3.6.1.4.1.19746.1.4) on page 408.]
As a user, the only thing you can do with notifications and alerts is
choose to receive them or not. Choosing to receive notifications is
called adding a trap host, that is, adding the name of a host
machine to the list of machines that receive notifications when
traps are sprung. Choosing not to receive notifications on a given
machine is called deleting a trap host. See the entries add on
page 324, del on page 325.

DD OS 4.9 Command Reference Guide 409


Notifications vary in severity level, and thus in result. This is
shown in Table A-3.
Table A-3: Notification Severity Levels and Results
Severity Level of Result
Notification
Warning An Autosupport email is sent.
Alert An Alert email is sent.
Shutdown The system shuts down.

In addition to the above results, in each case a Notification is sent if


it is supported.
The following is an example of how the user might use the MIB
Notifications table.
A user adds the hostname panther5 to the list of machines that
receive notifications, using the command:
snmp add trap-host panther5

410 MIB Reference


Later a fan module fails on the enclosure. The alarm
fanModuleFailedAlarm is sent to panther5. The user gets this
alarm, and looks it up in the MIB, in the Notifications table. The
entry looks like somewhat like this:
Table A-4: Part of the fanModuleFailedAlarm Field of the Notifications Table
in the MIB
OID Name Indexes Description
.1.3.6.1.4.1.19746.2. fanModuleFailedAlarm fanIndex Meaning: A fan
0.5 module in the
enclosure has failed.
The index of the fan
is given as the index
of the alarm. This
same index can be
looked up in the
environmentals table
fanProperties for
more information
about which fan has
failed.
What to do: Replace
the fan!

The user looks up the index in the MIB environmentals table


fanProperties, and finds that fan 1 has failed.
Back in the Notifications table, the user sees that What to do is
Replace the fan.

The user replaces the fan, removing the error condition.


More on Notifications is given in FigureA-2 and Table A-2.

DD OS 4.9 Command Reference Guide 411


Figure A-2: Notifications

412 MIB Reference


In the Notifications table, notifications are indexed into other
tables by various indexes, given in the Indexes column. The table
names can be found under Description.
Table A-5: Notifications
OID Name Indexes Description
.1.3.6. dataDomainMib
1.4.1. Notifications
19746
.2
.1.3.6. dataDomainMib
1.4.1. Traps
19746
.2.0
.1.3.6. powerSupplyFail Meaning: Power supply failed
1.4.1. edAlarm What to do: Replace the power
19746 supply.
.2.0.1
.1.3.6. systemOverheat tempSen Meaning: The temperature
1.4.1. WarningAlarm sorIndex reading of one of the
19746 thermometers in the chassis has
.2.0.2 exceeded the warning
temperature level. If it continues
to rise, it may eventually trigger
a shutdown of the Data Domain
system. The index value of the
alarm indicates the thermometer
index that may be looked up in
the environmentals table
temperatures for more
information about the actual
thermometer reading value.
What to do: Check the Fan
status, the temperatures of the
environment in which the Data
Domain system is located, and
other factors that may increase
the temperature.

DD OS 4.9 Command Reference Guide 413


Table A-5: Notifications (Continued)
OID Name Indexes Description
.1.3.6. systemOverheat tempSen Meaning: The temperature
1.4.1. AlertAlarm sorIndex reading of one of the
19746 thermometers in the chassis is
.2.0.3 more than halfway between the
warning and shutdown
temperature levels. If it
continues to rise, it may
eventually trigger a shutdown of
the Data Domain system. The
index value of the alarm
indicates the thermometer index
that may be looked up in the
environmentals table
temperatures for more
information about the actual
thermometer reading value.
What to do: Check the fan status,
the temperatures of the
environment in which the Data
Domain system is located, and
other factors that may increase
the system temperature.

414 MIB Reference


Table A-5: Notifications (Continued)
OID Name Indexes Description
.1.3.6. systemOverheatS tempSen Meaning: The temperature
1.4.1. hutdowntAlarm sorIndex reading of one of the
19746 thermometers in the chassis has
.2.0.4 reached or exceeded the
shutdown temperature level.
The Data Domain system will
shut down to prevent damage to
the system. The index value of
the alarm indicates the
thermometer index that may be
looked up in the environmentals
table temperatures for more
information about the actual
thermometer reading value.
What to do: Once the system has
been brought back up, first check
for high environment
temperatures or other factors
that may increase the system
temperature. Then check other
environmental values, such as
fan status and disk
temperatures.
.1.3.6. fanModuleFailed fanIndex Meaning: A fan module in the
1.4.1. Alarm enclosure has failed. The index
19746 of the fan is given as the index of
.2.0.5 the alarm. This same index can
be looked up in the
environmentals table
fanProperties for more
information about the fan that
has failed.
What to do: Replace the fan.

DD OS 4.9 Command Reference Guide 415


Table A-5: Notifications (Continued)
OID Name Indexes Description
.1.3.6. nvramFailingAla Meaning: The system has
1.4.1. rm detected that the NVRAM is
19746 potentially failing. There has
.2.0.6 been an excessive number of PCI
or memory errors. The NVRAM
tables nvramProperties and
nvramStats may provide for
information on why the NVRAM
is failing.
What to do: Check the status of
the NVRAM after reboot, and
replace if the errors continue.
.1.3.6. filesystemFailed Meaning: The file system
1.4.1. Alarm process on the Data Domain
19746 system has had a serious
.2.0.7 problem and has had to restart.
What to do: Check the system
logs for conditions that may be
triggering the failure. Other
alarms may also indicate why
the file system is having
problems.
.1.3.6. fileSpaceMainten Meaning: DDVAR File System
1.4.1. anceAlarm Resource Space is running low
19746 for system maintenance
.2.0.8 activities. The system may not
have enough space for the
routine system activities to run
without error.
What to do: Delete unneeded
files, such as old log files,
support bundles, core files,
upgrade rpm files stored in the
/ddvar file system.

416 MIB Reference


Table A-5: Notifications (Continued)
OID Name Indexes Description
.1.3.6. fileSpacePrewarn filesyste Meaning: /ddvar file system
1.4.1. ingAlarm mResour resource space is running low for
19746 ceIndex system maintenance activities.
.2.0.9 The system may not have
enough space for the routine
system activities to run without
error.
What to do: Delete unneeded
files, such as old log files,
support bundles, and core files,
and upgrade rpm files stored in
the /ddvar file system.
Consider upgrading the
hardware or adding shelves to
high-end units. Reducing the
retention times for backup data
can also help. When files are
deleted from outside of the
/ddvar space, invoke filesys
clean before the space is
recovered.

DD OS 4.9 Command Reference Guide 417


Table A-5: Notifications (Continued)
OID Name Indexes Description
.1.3.6. fileSpaceWarnin filesyste Meaning: A file system resource
1.4.1. gAlarm mResour space is 90% utilized. The index
19746 ceIndex value of the alarm identifies the
.2.0.1 file system index that may be
0 looked up in the file system table
filesystemSpace for more
information about the actual file
system that is getting full.
What to do: Delete unneeded
files, such as old log files,
support bundles, and core files,
and upgrade rpm files stored in
the /ddvar file system.
Consider upgrading the
hardware or adding shelves to
high-end units. Reducing the
retention times for backup data
can also help. When files are
deleted from outside of the
/ddvar space, invoke filesys
clean to recover space.

418 MIB Reference


Table A-5: Notifications (Continued)
OID Name Indexes Description
.1.3.6. fileSpaceSevereA filesyste Meaning: A file system resource
1.4.1. larm mResour space is 95% utilized. The index
19746 ceIndex value of the alarm indicates the
.2.0.1 file system index that may be
1 looked up in the file system table
filesystemSpace for more
information about the actual file
system that is getting full.
What to do: Delete unneeded
files, such as old log files,
support bundles, or core files,
and upgrade rpm files stored in
the /ddvar file system.
Consider upgrading the
hardware or adding shelves to
high-end units. Reducing the
retention times for backup data
can also help. When files are
deleted from outside of the
/ddvar space, invoke filesys
clean to recover space.

DD OS 4.9 Command Reference Guide 419


Table A-5: Notifications (Continued)
OID Name Indexes Description
.1.3.6. fileSpaceCritical filesyste Meaning: A file system resource
1.4.1. Alarm mResour space is 100% utilized. The index
19746 ceIndex value of the alarm indicates the
.2.0.1 file system index that may be
2 looked up in the file system table
filesystemSpace for more
information about the actual file
system that is full.
What to do: Delete unneeded
files, such as old log files,
support bundles, or core files,
and upgrade rpm files stored in
the /ddvar file system.
Consider upgrading the
hardware or adding shelves to
high-end units. Reducing the
retention times for backup data
can also help. When files are
deleted from outside of the
/ddvar space, invoke filesys
clean to recover space.

.1.3.6. diskFailedAlarm diskProp Meaning: Some problem has


1.4.1. Index been detected about the
19746 indicated disk. The index value
.2.0.1 of the alarm identifies the disk
4 index that may be looked up in
the disk tables
diskProperties,
diskPerformance, and
diskReliability for more
information about the actual
disk that has failed.
What to do: Replace the disk.

420 MIB Reference


Table A-5: Notifications (Continued)
OID Name Indexes Description
.1.3.6. diskOverheatWa diskErrI Meaning: The temperature
1.4.1. rningAlarm ndex reading of the indicated disk has
19746 exceeded the 'warning'
.2.15 temperature level. If it continues
to rise, it may eventually trigger
a shutdown of the Data Domain
system. The index value of the
alarm indicates the disk index
that may be looked up in the
disk tables 'diskProperties',
'diskPerformance', and
'diskReliability' for more
information about the actual
disk exhibiting the high value.
What to do: Check the disk
status, temperatures of the
environment where the Data
Domain system is located, and
other factors that may increase
the temperature.

DD OS 4.9 Command Reference Guide 421


Table A-5: Notifications (Continued)
OID Name Indexes Description
.1.3.6. diskOverheatAle diskErrI Meaning: The temperature
1.4.1. rtAlarm ndex reading of the indicated disk is
19746 more than halfway between the
.2.0.1 warning and shutdown
6 temperature levels. If it
continues to rise, it will trigger a
shutdown of the Data Domain
system. The index value of the
alarm indicates the disk index
that may be looked up in the
disk tables diskProperties,
diskPerformance, and
diskReliability for more
information about the actual
disk exhibiting the high value.
What to do: Check the disk
status, the temperatures of the
environment in which the Data
Domain system is located, and
other factors that may increase
the temperature. If the
temperature stays at this level or
rises, and no other disks are
reading this trouble, consider
failing the disk and getting a
replacement.

422 MIB Reference


Table A-5: Notifications (Continued)
OID Name Indexes Description

.1.3. diskOverheatShu diskErrI Meaning: The temperature


6.1.4 tdowntAlarm ndex reading of the indicated disk has
.1.19 surpassed the shutdown
746. temperature level. The Data
2.01 Domain system will shut down.
7 The index value of the alarm
identifies the disk index that
may be looked up in the disk
tables diskProperties,
diskPerformance, and
diskReliability for more
information about the actual
disk exhibiting the high value.
What to do: Boot the Data
Domain system and monitor the
status and temperatures. If the
same disk has continues having
problems, consider failing it and
getting a replacement disk.
.1.3.6. raidReconSevere Meaning: RAID group
1.4.1. Alarm reconstruction is currently active
19746 and has not completed after 71
.2.0.1 hours. Reconstruction occurs
8 when the RAID group falls into
degraded mode. This can
happen due to a disk failing
during runtime or boot-up.
What to do: While it is still
possible that the reconstruction
could succeed, the disk should
be replaced to ensure data safety.

DD OS 4.9 Command Reference Guide 423


Table A-5: Notifications (Continued)
OID Name Indexes Description
.1.3.6. raidReconCritica Meaning: RAID group
1.4.1. lAlarm reconstruction is currently active
19746 and has not completed after 72
.2.0.1 hours. Reconstruction occurs
9 when the RAID group falls into
degraded mode. This can
happen if a disk fails during
runtime or boot-up.
What to do: The disk should be
replaced to ensure data safety.
.1.3.6. raidReconCritica Meaning: RAID group
1.4.1. lShutdownAlar reconstruction is currently active
19746 m and has not completed after
.2.0.2 more than 72 hours.
0 Reconstruction occurs when the
RAID group falls into degraded
mode. This can happen if a disk
fails during run-time or boot-up.
What to do: The disk must be
replaced.
.1.3.6. raidGroupMissin Meaning: One or more RAID
1.4.1. gAlarm groups is missing.
19746 What to do: Disk may need to be
.2.0.2 replaced, or RAID
1 administration may be
necessary.
.1.3.6. diskNoSpareAlar Meaning: There is no spare
1.4.1. m available for the RAID group.
19746 What to do: Disk may need to be
.2.0.2 replaced, or RAID
2 administration may be
necessary.

424 MIB Reference


Table A-5: Notifications (Continued)
OID Name Indexes Description
.1.3.6. diskPathAlarm Meaning: Multipath
1.4.1. configuration is experiencing a
19746 problem. The number of paths
.2.0.2 set up is less than the required
3 number of paths. Disk index is in
the first disk in the enclosure
with multipath.
What to do: Multipath disk
administration may be
necessary.
.1.3.6. diskSASAlarm Meaning: SAS configuration
1.4.1. error. The maximum number of
19746 enclosures has been reached, or
.2.0.2 there is a topology problem.
4 What to do: SAS configuration
documentation should be
consulted. Administration may
be necessary.
.1.3.6. diskSASHBAlar Meaning: Unsupported
1.4.1. m multipath setting in the HBA
19746 firmware.
.2.0.2 What to do: Contact Data
5 Domain support.
.1.3.6. snapshotFullAlar Meaning: The maximum
1.4.1. m number of snapshots has been
19746 reached.
.2.0.2 What to do: Expire some old
6 snapshots to make room.
.1.3.6. snapshotHWMA Meaning: The number of
1.4.1. larm snapshots exceeded a predefined
19746 percentage of the maximum.
.2.0.2 What to do: Begin expiring some
7 old snapshots to make room.
.1.3.6. clusterNodeAlar Meaning: Node is not reachable
1.4.1. m on any network interface.
19746 What to do: Check the status of
.2.0.2 network and wiring. If they are
8 OK, try rebooting the node.

DD OS 4.9 Command Reference Guide 425


Table A-5: Notifications (Continued)
OID Name Indexes Description
.1.3.6. clusterInterfaceA Meaning: One interface of the
1.4.1. larm Global Deduplication Array is
19746 down.
.2.0.2 What to do: Check the status of
9 network and wiring. If they are
OK, try rebooting the node.
.1.3.6. replSyncAlarm Meaning: A replication context
1.4.1. is disabled due to NVRAM loss.
19746 What to do: Break replication on
.2.0.3 the source and destination, then
0 reconfigure and run replication
sync.
.1.3.6. replLagAlarm Meaning: The lag threshold for
1.4.1. replication has been exceeded.
19746 What to do: Check the logs and
.2.0.3 network connectivity.
1
.1.3.6. systemStartupAl Meaning: The system has
1.4.1. arm rebooted or started. This does
19746 not indicate any abnormal
.2.0.3 activity.
2 What to do: Nothing, unless the
reboot was triggered by
abnormal conditions, such as
temperature, power, or fan
problems.
.1.3.6. filesysRelaunchA Meaning: The file system has
1.4.1. larm undergone too many relaunches.
19746 It is probably unstable.
.2.0.3 What to do: Consult the system
3 logs. A software or hardware
restart may fix this malfunction.
.1.3.6. filesysDDGCFail Meaning: The DDGC cleaning
1.4.1. edAlarm process has failed.
19746 What to do: Consult the system
.2.0.3 logs. A software or hardware
4 restart may fix this malfunction.

426 MIB Reference


Table A-5: Notifications (Continued)
OID Name Indexes Description
.1.3.6. filesysGeneralPr Meaning: A general problem has
1.4.1. oblemAlarm occurred with the file system.
19746 What to do: Consult the system
.2.0.3 logs. A software or hardware
5 restart may fix this malfunction.
.1.3.6. diskUnsupporte Meaning: The disk is not
1.4.1. dAlarm supported by the Data Domain
19746 system.
.2.0.3 What to do: Replace the disk.
6

DD OS 4.9 Command Reference Guide 427


Filesystem Space (.1.3.6.1.4.1.19746.1.3.2)
The Filesystem Space MIB entries describe the allocation of file
system space in Data Domain systems. See FigureA-3 and
Table A-6.

Figure A-3: Filesystem Space

The Filesystem Space table is indexed by the index


filesystemResourceIndex.
Table A-6: Filesystem Space
OID Name Description
.1.3.6.1.4.1.19746.1.3.2.1 filesystemSpaceTable A table containing entries of
FilesystemSpaceEntry
.1.3.6.1.4.1.19746.1.3.2.1.1 filesystemSpaceIndex
.1.3.6.1.4.1.19746.1.3.2.1.1.1 filesystemResourceInde The file system resource
x index
.1.3.6.1.4.1.19746.1.3.2.1.1.2 filesystemResourceNam The file system resource
e name
.1.3.6.1.4.1.19746.1.3.2.1.1.3 filesystemSpaceSize The size of the file system
resource in gigabytes
.1.3.6.1.4.1.19746.1.3.2.1.1.4 filesystemSpaceUsed The amount of used space
within the file system
resource in gigabytes

428 MIB Reference


Table A-6: Filesystem Space (Continued)
OID Name Description
.1.3.6.1.4.1.19746.1.3.2.1.1.5 filesystemSpaceAvail The amount of available
space within the file system
resource in gigabytes
.1.3.6.1.4.1.19746.1.3.2.1.1.6 filesystemPercentUsed The percentage of used
space within the file system
resource

DD OS 4.9 Command Reference Guide 429


Replication (.1.3.6.1.4.1.19746.1.8)
Various values related to replication are contained in the
Replication table in the MIB.
Figure A-4: Replication

The Replication table is indexed by the index replContext.


Table A-7: Replication
OID Name Description
.1.3.6.1.4.1.19746.1.8 replication
.1.3.6.1.4.1.19746.1.8.1 replicationInfo
.1.3.6.1.4.1.19746.1.8.1.1 replicationInfoTable A table containing entries
of ReplicationInfoEntry
.1.3.6.1.4.1.19746.1.8.1.1.1 replicationInfoEntry The replicationInfoTable
row description.
.1.3.6.1.4.1.19746.1.8.1.1.1.2 ReplState The state of the replication
source and destination pair
.1.3.6.1.4.1.19746.1.8.1.1.1.3 replStatus The status of the
replication source and
destination pair connection

430 MIB Reference


Table A-7: Replication (Continued)
OID Name Description
.1.3.6.1.4.1.19746.1.8.1.1.1.4 replFileSysStatus The status of the file system
.1.3.6.1.4.1.19746.1.8.1.1.1.5 replConnTime The time of connection
established between the
source and destination, or
the time since disconnect if
the status is
disconnected
.1.3.6.1.4.1.19746.1.8.1.1.1.6 replSource The network path to the
replication source directory
.1.3.6.1.4.1.19746.1.8.1.1.1.7 replDestination The network path to the
replication destination
directory
.1.3.6.1.4.1.19746.1.8.1.1.1.8 replLag The time lag between the
source and destination
.1.3.6.1.4.1.19746.1.8.1.1.1.9 replPreCompBytesSent The number of pre-
compression bytes sent.
.1.3.6.1.4.1.19746.1.8.1.1.1.10 replPostCompBytesSen The number of post-
t compression bytes sent
.1.3.6.1.4.1.19746.1.8.1.1.1.11 replPreCompBytesRem The number of pre-
aining compression bytes
remaining
.1.3.6.1.4.1.19746.1.8.1.1.1.12 replPostCompBytesRec The number of post-
eived compression bytes received
.1.3.6.1.4.1.19746.1.8.1.1.1.13 replThrottle The replication throttle, in
bps
.1.3.6.1.4.1.19746.1.8.1.1.1.14 replSyncedAsOfTime The time when the source
and destination were in
sync, or 0 if the time is
unknown

DD OS 4.9 Command Reference Guide 431


NFS (.1.3.6.1.4.1.19746.1.9)
Various values related to NFS are contained in the nfsClientEntry
and nfsStatsEntry tables in the MIB. See FigureA-5 and Table A-8.
Figure A-5: NFS

The nfsClientEntry table is indexed by nfsClientIndex, and the


nfsStatsEntry table is indexed by nfsStatsIndex.
Table A-8: NFS
OID Name Description
.1.3.6.1.4.1.19746.1.9 nfs
.1.3.6.1.4.1.19746.1.9.1 nfsProperties
.1.3.6.1.4.1.19746.1.9.1.1 nfsStatus Status of the network file
system
.1.3.6.1.4.1.19746.1.9.2 nfsClient
.1.3.6.1.4.1.19746.1.9.2.1 nfsClientTable A table containing entries
of nfsClientEntry

432 MIB Reference


Table A-8: NFS (Continued)
OID Name Description
.1.3.6.1.4.1.19746.1.9.2.1.1 nfsClientEntry nfsClientTable Row
Description
.1.3.6.1.4.1.19746.1.9.2.1.1.1 nfsClientIndex NFS Client index
.1.3.6.1.4.1.19746.1.9.2.1.1.2 nfsClientPath NFS client path
.1.3.6.1.4.1.19746.1.9.2.1.1.3 nfsClientClients List of NFS clients
.1.3.6.1.4.1.19746.1.9.2.1.1.4 nfsClientOptions NFS client's options
.1.3.6.1.4.1.19746.1.9.3 nsfstats
.1.3.6.1.4.1.19746.1.9.3.1 nfsStatsTable A table containing entries
of nfsStatsEntry
.1.3.6.1.4.1.19746.1.9.3.1.1 nfsStatsEntry nfsStatsEntry table row
description
.1.3.6.1.4.1.19746.1.9.3.1.1.1 nfsStatsIndex NSF resource index
.1.3.6.1.4.1.19746.1.9.3.1.1.2 nfsStatsExportPoint NFS export point
.1.3.6.1.4.1.19746.1.9.3.1.1.3 nfsStatsFilesystemTy File system type
pe
.1.3.6.1.4.1.19746.1.9.3.1.1.4 nfsStatsCacheEntry Number of cache entries
.1.3.6.1.4.1.19746.1.9.3.1.1.5 nfsStatsFileHandleLo File handle lookup count
okup
.1.3.6.1.4.1.19746.1.9.3.1.1.6 MaxCacheSize Max cache size
.1.3.6.1.4.1.19746.1.9.3.1.1.7 CurrentOpenStreams Current open stream
count

DD OS 4.9 Command Reference Guide 433


CIFS (.1.3.6.1.4.1.19746.1.10)
Various values related to CIFS are contained in the cifsShareTable
table in the MIB. See FigureA-6 and Table A-9.
Figure A-6: CIFS

The cifsStareIndex table is indexed by the cifsShareIndex.


Table A-9: CIFS
OID Name Description
.1.3.6.1.4.1.19746.1.10 cifs
.1.3.6.1.4.1.19746.1.10.1 cifsProperties
.1.3.6.1.4.1.19746.1.10.1.1 cifsStatus CIFS status
.1.3.6.1.4.1.19746.1.10.2 cifsConfig
.1.3.6.1.4.1.19746.1.10.2.1 cifsConfigMode CIFS configuration mode
.1.3.6.1.4.1.19746.1.10.2.2 cifsConfigWINSServe CIFS WINS server
r

434 MIB Reference


Table A-9: CIFS
OID Name Description
.1.3.6.1.4.1.19746.1.10.2.3 cifsConfigNetBIOSHo CIFS Net BIOS hostname
stname
.1.3.6.1.4.1.19746.1.10.2.4 cifsConfigDomainCo CIFS domain controller
ntroller
.1.3.6.1.4.1.19746.1.10.2.5 cifsConfigDNS CIFS DNS server
.1.3.6.1.4.1.19746.1.10.2.6 cifsConfigGroupNam CIFS configuration group
e name
.1.3.6.1.4.1.19746.1.10.3 cifsShare
.1.3.6.1.4.1.19746.1.10.3.1 cifsShareTable A table containing entries
of cifsShareEntry.
.1.3.6.1.4.1.19746.1.10.3.1.1 cifsShareEntry cifsShareTable Row
Description
.1.3.6.1.4.1.19746.1.10.3.1.1.1 cifsShareIndex CIFS share index

.1.3.6.1.4.1.19746.1.10.3.1.1.2 cifsShareName CIFS share name


.1.3.6.1.4.1.19746.1.10.3.1.1.3 cifsSharePath CIFS share path
.1.3.6.1.4.1.19746.1.10.3.1.1.4 cifsShareClients CIFS share clients
.1.3.6.1.4.1.19746.1.10.3.1.1.5 cifsShareUser CIFS share user
.1.3.6.1.4.1.19746.1.10.3.1.1.6 cifsShareComment CIFS share comment
.1.3.6.1.4.1.19746.1.10.3.1.1.7 cifsShareBrowsing CIFS share browsing
.1.3.6.1.4.1.19746.1.10.3.1.1.8 cifsShareWritable CIFS share writeable
.1.3.6.1.4.1.19746.1.10.3.1.1.9 cifsShareMaxConnecti CIFS share maximum
on connection

DD OS 4.9 Command Reference Guide 435


VTL (.1.3.6.1.4.1.19746.1.11)
Various values related to VTL are contained in the vtlLibraryTable
and vtlDriveTable in the MIB. See FigureA-7 and Table A-10.
Figure A-7: VTL

436 MIB Reference


The VTLLibraryTable is indexed by the vtlLibraryIndex, and the
vtlDriveTable is indexed by vtlDriveIndex.
Table A-10: VTL
OID Name Description
.1.3.6.1.4.1.19746.1.11 vtl
.1.3.6.1.4.1.19746.1.11.1 vtlProperties
.1.3.6.1.4.1.19746.1.11.1.1 vtlAdminState State of VTL
administration
.1.3.6.1.4.1.19746.1.11.1.2 vtlProcessState State of VTL process
.1.3.6.1.4.1.19746.1.11.2 vtlConfiguration
.1.3.6.1.4.1.19746.1.11.2.1 vtlLibrary
.1.3.6.1.4.1.19746.1.11.2.1.1 vtlLibraryTable A table containing entries
of VtlLibraryEntry
.1.3.6.1.4.1.19746.1.11.2.1.1.1 vtlLibraryEntry vtlLibraryTable Row
Description
.1.3.6.1.4.1.19746.1.11.2.1.1.1.1 vtlLibraryIndex VTL Library index
.1.3.6.1.4.1.19746.1.11.2.1.1.1.2 vtlLibraryName VTL library name
.1.3.6.1.4.1.19746.1.11.2.1.1.1.3 vtlLibraryVendor VTL library vendor
.1.3.6.1.4.1.19746.1.11.2.1.1.1.4 vtlLibraryModel VTL library model
.1.3.6.1.4.1.19746.1.11.2.1.1.1.5 vtlLibraryRevision VTL library revision
.1.3.6.1.4.1.19746.1.11.2.1.1.1.6 vtlLibrarySerial VTL library serial
.1.3.6.1.4.1.19746.1.11.2.1.1.1.7 vtlLibraryTotalDrives VTL library total drives
.1.3.6.1.4.1.19746.1.11.2.1.1.1.8 vtlLibraryTotalSlots VTL library total slots
.1.3.6.1.4.1.19746.1.11.2.1.1.1.9 vtlLibraryTotalCaps VTL library total caps
.1.3.6.1.4.1.19746.1.11.2.1.1.1.10 vtlLibraryStatus VTL library status
.1.3.6.1.4.1.19746.1.11.2.2 vtlDrive
.1.3.6.1.4.1.19746.1.11.2.2.1 vtlDriveTable A table containing entries
of VtlDriveEntry
.1.3.6.1.4.1.19746.1.11.2.2.1.1 vtlDriveEntry vtlDriveTable Row
Description.
.1.3.6.1.4.1.19746.1.11.2.2.1.1.1 vtlDriveIndex VTL drive index.

DD OS 4.9 Command Reference Guide 437


Table A-10: VTL
OID Name Description
.1.3.6.1.4.1.19746.1.11.2.2.1.1.2 vtlDriveName VTL drive name
.1.3.6.1.4.1.19746.1.11.2.2.1.1.3 vtlDriveVendor VTL drive vendor
.1.3.6.1.4.1.19746.1.11.2.2.1.1.4 vtlDriveModel VTL drive model
.1.3.6.1.4.1.19746.1.11.2.2.1.1.5 vtlDriveRevision VTL drive revision
.1.3.6.1.4.1.19746.1.11.2.2.1.1.6 vtlDriveSerial VTL drive serial
.1.3.6.1.4.1.19746.1.11.2.2.1.1.7 vtlDriveLibraryName VTL drive library name
.1.3.6.1.4.1.19746.1.11.2.2.1.1.8 vtlDriveStatus VTL drive status
.1.3.6.1.4.1.19746.1.11.2.2.1.1.9 vtlDriveTapeVolume VTL drive tape volume

438 MIB Reference

Você também pode gostar