Phoenix RPC12 Series Cli Reference Manual

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Before You Read This Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Typographic Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

1. Using the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Accessing the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Using the XML API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Operation Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

DTD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Keywords and Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Disk Drive Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Virtual Disk Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Volume Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Host Nickname Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Volume Mapping Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Command Completion, Editing, and History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Viewing Command Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Size of Devices and Logical Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Event Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

2. Command Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

CLI and Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Virtual Disks and Disk Drives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Volumes and Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Snapshots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Task Scheduling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Event Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Configuration and Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Service Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

3. Command Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

abort create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

abort scrub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

abort verify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

abort volumecopy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

clear cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

clear disk-metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

clear expander-status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

convert master-to-std . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

convert std-to-master . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

create host-wwn-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

create iscsi-host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

create master-volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

create schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

create snap-pool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

create snapshots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

create task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

create user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

create vdisk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

4 Phoenix RPC12 Series CLI Reference Manual • September 2008

create volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

delete all-master-volumes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

delete all-snapshots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

delete global-spare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

delete host-wwn-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

delete iscsi-host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

delete master-volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

delete schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

delete snap-pool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

delete snapshot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

delete snapshot-write-data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

delete task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

delete user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

delete vdisk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

delete vdisk-spare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

delete volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .82

expand snap-pool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

expand vdisk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

expand volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

map volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

ping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

reset host-channel-link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

reset snapshot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

restore defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

rollback master-volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

scrub vdisk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

Contents 5

set auto-write-through-trigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

set cache-parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

set cli-parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

set controller-date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

set debug-log-parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

set drive-parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

set expander-fault-isolation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

set expander-phy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

set global-spare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

set host-parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

set host-port-interconnects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

set host-wwn-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

set iscsi-host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

set job-parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

set led . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

set network-parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

set password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

set prompt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

set protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

set snap-pool-policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

set snap-pool-threshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

set snmp-parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

set system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

set user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

set vdisk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

set vdisk-spare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

set volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

show auto-write-through-trigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

6 Phoenix RPC12 Series CLI Reference Manual • September 2008

show cache-parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

show channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

show cli-parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

show configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

show controller-date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

show debug-log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

show debug-log-parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

show disks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

show drive-parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

show enclosure-status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

show events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

show expander-status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

show frus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

show host-maps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

show host-parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

show host-port-interconnects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

show host-wwn-names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

show iscsi-hosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

show job-parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

show license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

show master-volumes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

show network-parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

show port-wwn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

show protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

show redundancy-mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

show schedule-details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

show schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

show sensor-status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

Contents 7

show shutdown-status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

show snap-pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

show snapshots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

show snmp-parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

show system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

show task-details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

show tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

show users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

show vdisks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

show volumecopy-status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

show volume-maps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

show volumes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

shutdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

stty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

trust . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

unmap volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

verify vdisk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

volumecopy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

8 Phoenix RPC12 Series CLI Reference Manual • September 2008

Preface

This manual describes how to use the command-line interface (CLI) to configure and manage Phoenix™ storage systems, and applies to the following enclosures:

Q 69501 FC Controller Enclosure Q 69503 iSCSI Controller Enclosure Q SAS Expansion Enclosure

This book is written for system administrators who are familiar with Fibre Channel (FC), Internet SCSI (iSCSI), and Serial Attached SCSI (SAS) configurations, network administration, and RAID technology.

Before You Read This Book

Before you begin to follow the procedures in this book, you must have already installed the system and learned of any late-breaking information related to system operations as described in the Getting Started guide and Release Notes.

Typographic Conventions

Typeface

AaBbCc123 Book title, new term, or

AaBbCc123 Directory or file name,

AaBbCc123 Text you type, contrasted

AaBbCc123

[ ] Brackets indicate that a

[...] Brackets containing an

Meaning Examples

emphasized word.

value, command, or on-screen output.

with on-screen output.

Variable text you replace with an actual value.

Command-line variable that must be replaced with a real value.

parameter is optional.

ellipsis indicates that the preceding parameter can be entered again, with a different value.

See the Release Notes.

A virtual disk (vdisk) can ....

You must be an advanced user to ....

The default file name is store.logs. The default IP address is 10.0.0.1. Typ e exit.

# set password Enter new password:

Use the format http://

To delete a file, type rm

show disks [

set awt enable|disable [...]

disks

trigger

ip-address

filename

]

| A separator indicates that

only one of the parameters or values separated by this character can be specified.

1 The fonts used in your viewer might differ.

10 Phoenix RPC12 Series CLI Reference Manual • September 2008

base 2|10

Related Documentation

Application Title Part Number

Site planning information Phoenix Storage System Site Planning Guide 83-00004283

Late-breaking information not included in the documentation set

Installing and configuring hardware Phoenix 69501 Getting Started Guide

Configuring and managing storage Phoenix RPC12 Administrator’s Guide 83-00004289

Troubleshooting Phoenix RPC12 Troubleshooting Guide 83-00004287

Recommendations for maximizing reliability, accessibility, and serviceability

Phoenix 69501 Release Notes Phoenix 69503 Release Notes

Phoenix 69503 Getting Started Guide

Phoenix RPC12 Best Practices Guide 83-00004286

83-00004282 83-00005032

83-00004284 83-00005034

Preface 11

12 Phoenix RPC12 Series CLI Reference Manual • September 2008

CHAPTER

Using the CLI

This chapter introduces the Phoenix storage system command-line interface (CLI) and includes the following topics:

Q “Accessing the CLI” on page 13 Q “Operation Modes” on page 13 Q “Command Syntax” on page 24 Q “Command Completion, Editing, and History” on page 27 Q “Viewing Command Help” on page 28 Q “Size of Devices and Logical Units” on page 28 Q “Event Log” on page 29

Accessing the CLI

The CLI software embedded in controller modules enables you to configure, monitor, and manage storage systems out of band.

You can access the CLI in two ways:

Q By using a terminal emulator on a management host that is directly connected to

a controller module’s CLI port. See the Getting Started Guide for information on setting up the terminal emulator.

Q By using telnet, an SSH application, or a terminal emulator on a management

host that is remotely connected through a LAN to a controller module’s Ethernet port.

Operation Modes

By default the CLI is an interactive application. When you are logged into the CLI, the CLI waits for a command to be entered and then responds to it. This singleoperation mode is known as interactive mode.

The following example shows interactively starting a telnet session, logging into the CLI, executing a command to show free (available) disks, and exiting the CLI:

$: telnet 172.22.5.55 Login: monitor Password: ********

RPC-69501-001 System Name: Test System Location: Lab Version: W420B22

# show disks free ID Serial# Vendor Rev. State Type Size(GB) Rate(Gb/s) SP

-----------------------------------------------------------------------------3 3KN0Z0BZ00007626NM4F SEAGATE 0003 AVAIL SAS 146 3.0 6 VDK41BT4CVLPNE ATA A9BA AVAIL SATA 250 3.0 7 3KN0Z6PD00007626NLV5 SEAGATE 0003 AVAIL SAS 146 1.5 10 3KN0Z09500007626NM28 SEAGATE 0003 AVAIL SAS 146 3.0

-----------------------------------------------------------------------------# exit

14 Phoenix RPC12 Series CLI Reference Manual • September 2008

CLI commands can also be scripted using a telnet client like Expect or a Perl library. Scripts can use interactive mode to execute single commands to emulate a single-command mode.

The following example shows the Perl Expect script

showfree.exp that starts a

telnet session, logs into the CLI, executes a command to show free disks, and

exits the CLI:

#!/usr/bin/expect set login [lindex $argv 1] set password [lindex $argv 2] set host [lindex $argv 3] set command [lindex $argv 4] spawn telnet $host

expect "Login:" send "$login\r" expect "Password:" send "$password\r" send "$command\r" send "exit" expect eof

The following shows a possible result of executing this script:

$:./showfree.exp monitor !monitor 172.22.4.245 "show disks free"

RPC-69501-001 System Name: Test System Location: Lab Version: W420B22

# show disks free ID Serial# Vendor Rev. State Type Size(GB) Rate(Gb/s) SP

-----------------------------------------------------------------------------# exit

Chapter 1 Using the CLI 15

The example below and continuing on the next page shows how to construct a script using a Perl library for

use Net::Telnet; $mVer = "v.072006"; $mLine = "=========================================================="; $mStr = "Management Controller System Cloning Utility"; $nLine = "\n"; $cliDumpFile = "get_config_dump.txt"; $space = ' '; $username = ""; $password = "";

sub cLogin { $telnet->open($_[0]); $telnet->waitfor(/(login|username)[: ]*$/i); $telnet->print("$_[1]"); $telnet->waitfor(/password[: ]*$/i); $telnet->print("$_[2]");

# either got a login or a prompt @ok = $telnet->waitfor(/(#|login:*) /i);

if ($debug_comamnds == 1) { print "-"; print @ok; print "-\n"; }

if ($ok[1] =~ m/login/gi) { return 0; } else { return 1; } } $ipAddr = $ARGV[0]; $username = $ARGV[1]; $password = $ARGV[2];

telnet communication.

$telnet = new Net::Telnet ( Timeout=>10, Errmode=>'die', Prompt => '/\# $/i');

16 Phoenix RPC12 Series CLI Reference Manual • September 2008

if ( !cLogin($ipAddr, $username, $password) == 1 ) { print("Error: $username user failed to log in. Exiting.\n"); $telnet->close; exit(0); }

The example shows a Perl script for logging in. cLogin is called at the start of the script to log a user into the CLI. The script uses the command-line parameters specified as the IP address, username, and password. Once the user has been logged in, other commands can be sent to the CLI.

The command below provides better scripting support. The first argument sets the output format to XML, which allows easier parsing. The second argument disables the paging mode that pauses for each full screen of command output.

$telnet->cmd("set cli-parameters api pager disabled");

The following code segment shows how to get the entire configuration information from the CLI and print the output. The output can easily be redirected to a file for archiving.

@sV = $telnet->cmd("show configuration");

for ($i=0; $i<scalar(@sV); $i++) {

print (“@sV[ $i ]”);

}

Using the XML API

You can set the CLI output to either console or api using the set cli-

parameters

use an XML parser such store this information as objects.

An updated Document Type Definition (DTD) is available with each update of the firmware. The DTD is located on the Customer Resource Center web site. Go to:

http://crc.dothill.com > R/Evolution Products > Software Downloads search

for the DTD in the article list.

command. When set to api, the output is returned in XML. You can

XML::Parser in Perl to process the XML output and

Chapter 1 Using the CLI 17

The XML parser should use the DTD version that corresponds to the firmware level to ensure that the DTD is validated. By obtaining the latest DTD for validation, the parser will be forward compatible.

DTD

The following is Revision 1 of the DTD. Elements and attributes are described in the table on the following page.

<!ATTLIST OBJECT oid ID #REQUIRED name CDATA #IMPLIED basetype CDATA #IMPLIED >

<!ELEMENT COMP EMPTY> <!ATTLIST COMP P IDREF #REQUIRED G IDREF #REQUIRED >

<!ELEMENT ASC EMPTY> <!ATTLIST ASC A IDREF #REQUIRED B IDREF #REQUIRED >

18 Phoenix RPC12 Series CLI Reference Manual • September 2008

Elements and attributes of the DTD are described in the following table.

Element Description and Attributes

RESPONSE The RESPONSE is the top level XML object. The request attributes

contain the details of the request that was sent. The RESPONSE is a container for objects that are returned as part of the request. All commands have a status object as part of the RESPONSE which provides a message and return code. A return code of 0 indicates that the command was successful. Any other return code is an error code.

OBJECT The OBJECT element is a container for properties. Each OBJECT also

has attributes which describe the OBJECT characteristics.

• oid (Object Identifier) - A unique number per request which identifies the OBJECT within a response. This number is used as a reference in associations that the response may contain.

• name - The class name of the object.

• basetype - The generic class name of the object. This is used to distinguish between differing types of objects within a response. A response can contain a number of volumes all of which may be of different classes (standard volumes, snap-pools, snapshots, etc.). The response also contains a status object. The basetype indicates which object is a volume and which object is a status object.

Chapter 1 Using the CLI 19

Element Description and Attributes

PROPERTY The PROPERTY element provides the detailed information for each

OBJECT. The element value is the actual data content to be used. The

attributes provide further details on how to interpret the data.

• display-name - The suggested label to use in a user interface for

the data value.

• raw - Indicates whether or not a value should be displayed to a user. If this value is false, the value might apply only to a programmatic interface which can use the value for calculations.

• size - The number of columns to use to display the value.

• type - The type that the data should be interpreted as.

• key - Indicates whether or not this values can be used as a key to other commands.

• name - The name of the property. The name attribute is used for unique identification within an object.

COMP The composition element gives the association between a grouping object

and a part of object. This provides a description of the hierarchy of the objects that are part of the response.

• P - The part component oid.

• G - The grouping component oid.

ASC The association element provides a simple association description

between two objects in the response.

•A

•B

20 Phoenix RPC12 Series CLI Reference Manual • September 2008

Example

The following example shows the output of the show schedule-details command with the output first set to

# set cli-parameters console Success: CLI parameter changed successfully

show schedule-details Sched1

Schedule Details

---------------Schedule Name: Sched1 Schedule Specification: Start 5/01/2007 00:01:00, Only 1st Weekday Of Month Schedule Status: Ready Next Time: 5/01/2007 00:01:00 Task To Run: task1 Error Message: none

Task Details

----------- Task Name: task1 Task Type: TakeSnapshot Task Status: Ready Task State: Init Master Volume Name: mv1 Master Volume Serial: 00c0ff0a43010048f9ca2d4601000000 Snapshot Prefix: ss Retention Count: 3 Last Snapshot Created: none Error Message: none

console and second set to api.

Snapshot Name Snapshot Serial

----------------------------------------------------- ss_S0003 00c0ff0a43010048f9ca2d4601000000

Chapter 1 Using the CLI 21

# set cli-parameters api <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <RESPONSE request="cli-parameters"> <OBJECT name="status" oid="1"> <PROPERTY name="success" type="string" size="77" draw="true" display-name= "Success">CL I parameter changed successfully</PROPERTY> <PROPERTY name="return-code" type="int32" size="5" draw="false" displayname="Return C ode">0</PROPERTY> </OBJECT> </RESPONSE>

#show schedule-details Sched1

<?xml version="1.0"?> <!DOCTYPE RESPONSE SYSTEM "DHXML.dtd"> <RESPONSE> <OBJECT basetype="schedule" name="schedule" oid="1">

<PROPERTY name="name" key="true" type="string" size="32" draw="true"

display-name="Schedule Name">Sched1</PROPERTY>

<PROPERTY name="schedule-specification" type="string" size="170" draw= "true" display-name="Schedule Specification">Start 5/01/2007 00:01:00, Only 1st Weekday Of Month</PROPERTY>

<PROPERTY name="status" type="string" size="20" draw="true" display-

name="Schedule Status">Ready</PROPERTY>

<PROPERTY name="next-time" type="string" size="32" draw="true" display-

name="Next Time">5/01/2007 00:01:00</PROPERTY>

<PROPERTY name="task-to-run" type="string" size="32" draw="true"

display-name="Task To Run">task1</PROPERTY>

<PROPERTY name="type" type="string" size="32" draw="true" display-name= "Task Type">TakeSnapshot</PROPERTY>

<PROPERTY name="status" type="string" size="10" draw="true" displayname="Task Status">Ready</PROPERTY>

<PROPERTY name="state" type="string" size="15" draw="true" display-name=

"Task State">Init</PROPERTY>

22 Phoenix RPC12 Series CLI Reference Manual • September 2008

<PROPERTY name="snapshot-prefix" type="string" size="14" draw="true"

display-name="Snapshot Prefix">ss</PROPERTY>

<PROPERTY name="retention-count" type="string" size="5" draw="true"

display-name="Retention Count">3</PROPERTY>

<PROPERTY name="last-created" type="string" size="32" draw="true" display-

name="Last Snapshot Created">none</PROPERTY>

Chapter 1 Using the CLI 23

Command Syntax

This section describes syntax rules for CLI commands.

Q “Keywords and Parameters” on page 24 Q “Disk Drive Syntax” on page 24 Q “Virtual Disk Syntax” on page 25 Q “Volume Syntax” on page 25 Q “Volume Mapping Syntax” on page 26 Q “Host Nickname Syntax” on page 26

Keywords and Parameters

Command keywords must be entered in lowercase. Parameter values can be entered in uppercase and lowercase.

Parameter values that contain non-alphanumeric characters, such as spaces, must be enclosed in quotation marks (

Disk Drive Syntax

You can specify disk drives by using either:

Q A disk drive ID. For example, 4.

Q A hyphenated range of disk drive IDs from

Q A list of disk drive IDs, ranges, or both, separated by commas; do not include

spaces before or after commas. For example,

"), which the CLI parses and removes.

to z. For example, 5-7.

4,6-9.

24 Phoenix RPC12 Series CLI Reference Manual • September 2008

Virtual Disk Syntax

You can specify virtual disks by using either:

Q Virtual disk serial number. A unique 32-digit number that is automatically

assigned when a virtual disk is created, and does not change for the life of the virtual disk.

Q Virtual disk name. A user-defined, case-sensitive name that can include 20

characters. Allowed characters include letters, numbers, hyphens, underscores, and spaces. A name that includes a space must be enclosed in quotation marks.

Some commands accept a comma-separated list of virtual disk serial numbers and names. Do not include spaces before or after commas. The following virtual disk list specifies a serial number and two names:

00c0ff0a43180048e6dd1c4500000000,Sales/Mktg,”Vdisk #1”

Volume Syntax

You can specify volumes by using either:

Q Volume serial number. A unique 32-digit number that is automatically assigned

when a volume is created, and does not change for the life of the volume.

Q Vol u me nam e . A user-defined name that can include a maximum of 17 printable

ASCII characters. A name cannot include a comma, backslash (\), or quotation

"); however, a name that includes a space must be enclosed in quotation

mark ( marks. Names are case sensitive.

Note – Volumes on different virtual disks can have the same name.

Some commands accept a comma-separated list of volume serial numbers and names. Do not include spaces before or after commas. The following volume list specifies a serial number and two names:

AA43BF501234560987654321FEDCBA,Image-Data,”Vol #1”

Chapter 1 Using the CLI 25

Host Nickname Syntax

You can specify a nickname for a data host’s bus adapter or switch port. A nickname is a user-defined string that can include a maximum of 16 printable ASCII characters. For example, quotation mark (

"); however, a name that includes a space must be enclosed in

MyHBA. A name cannot include a comma, backslash (\), or

quotation marks. Names are case sensitive.

Volume Mapping Syntax

You specify the mapping of a host to a volume by using the syntax

channels.LUN

channels

ranges, or both. For example,

LUN

is a logical unit number (LUN) from 0–127 to assign to the mapping. For

example,

The following example maps channels 0 and 1 using LUN 8:

0-1.8

, where:

is a single host channel number or a list of host channel numbers,

0,1,3-5.

26 Phoenix RPC12 Series CLI Reference Manual • September 2008

Command Completion, Editing, and History

The CLI supports command completion, command editing, and command history.

When using command completion, if you enter too few letters to uniquely identify a keyword, the CLI lists keywords that match the entered string and redisplays the string so you can complete it.

The history contains all commands entered in the active CLI session. You can recall a command from the history, edit it, and run it.

To Press

Complete a partially entered keyword Tab

Get previous command from history Up Arrow or Ctrl-P

Get next command from history Down Arrow or Ctrl-N

Move cursor left Left Arrow or Ctrl-B

Move cursor right Right Arrow or Ctrl-F

Move back one word Esc-B

Move forward one word Esc-F

Move cursor to start of line Ctrl-A

Move cursor to end of line Ctrl-E

Transpose current and previous character Ctrl-T

Delete current character Delete or Ctrl-D

Delete previous character Backspace

Delete word up to cursor Ctrl-W

Delete rest of word Esc-D

Delete text up to cursor Ctrl-U

Delete rest of line Ctrl-K

Convert rest of word to uppercase Esc-C

Convert rest of word to lowercase Esc-L

Enter command and redisplay prompt Ctrl-Z

Refresh input line Ctrl-L

Chapter 1 Using the CLI 27

Viewing Command Help

To view brief descriptions of all commands that are available to the user level you logged in as, type:

# help

To view help for a specific command, type either:

# help #

command

To view information about the syntax to use for specifying disk drives, virtual disks, volumes, and volume mapping, type:

# help syntax

Size of Devices and Logical Units

The size of disk drives and logical units such as virtual disks and volumes are presented in base 2 (binary) format, not base 10 (decimal) format. Table 1-1 shows how sizes are presented in each format.

Table 1-1 Sizes in Binary and Decimal

Unit Size in Binary Size in Decimal

Kbyte 1024 bytes 1000 bytes

Mbyte 1024 Kbyte

1,048,576 bytes

1000 Kbyte 1 million bytes

Gbyte 1024 Mbyte

1,073,741,824 bytes

Tbyte 1024 Gbyte

1,099,511,627,776 bytes

1000 Mbyte 1 billion bytes

1000 Gbyte 1 trillion bytes

To check which format is being used, use “show cli-parameters” on page 146. To change the output format, use “set cli-parameters” on page 106.

28 Phoenix RPC12 Series CLI Reference Manual • September 2008

Event Log

A controller enclosure’s event log records all events that have occurred in or been detected by the controller modules and encompasses all field-replaceable units (FRUs) in the enclosure.

Each event has one of the following levels, in decreasing severity:

Q Critical. Events that might affect data integrity or system stability. Q War ning. Events that do not affect data integrity. Q Informational. Events that show the change of state or configuration changes.

For information about viewing events, see “show events” on page 162.

Chapter 1 Using the CLI 29

30 Phoenix RPC12 Series CLI Reference Manual • September 2008

CHAPTER

Command Categories

Commands in this manual are organized alphabetically to make it easy to find a command by name. This chapter helps you find a command within a logical grouping, based on the command’s function. A command might be listed in more than one category.

Q “CLI and Users” on page 32 Q “Virtual Disks and Disk Drives” on page 32 Q “Volumes and Mapping” on page 33 Q “Snapshots” on page 33 Q “Task Scheduling” on page 34 Q “Event Notification” on page 34 Q “Configuration and Utilities” on page 34 Q “Service Utilities” on page 35

+ 215 hidden pages

Phoenix RPC12 Series Cli Reference Manual

Specifications and Main Features

Frequently Asked Questions

User Manual