Introduction to the DR Series System Command Line Reference Guide
About the DR Series system CLI documentation
Other information you may need
Locating your system Service Tag
Introducing the DR Series system
Understanding the DR Series system CLI
Accessing the DR Series system CLI commands
DR Series system CLI commands overview
Managing the DR Series system
Alerts Commands
Maintaining the DR Series System
Alerts Command Usage
alerts --show [--email]
alerts --show [--snmp]
alerts --show [--events] [--index <[-]number> [--count <number>] [--all]
alerts --show [--alerts] [--index <[-] number>] [--count <number>] [--all]
alerts --show [--summary]
alerts --email [--relay_host <server name>]
alerts --email [--appliance_alerts <yes | no>]
alerts --email [--software_updates <yes | no>]
alerts --email [--daily_report <yes | no>]
alerts --email [--daily_report_time <0–24 hr>]
alerts --email [--sender_email <email address>]
alerts --test_email
alerts --snmp_add --host <server name> --port <number> --community <name>
alerts --snmp_delete --host <server name>
alerts --snmp_disable --host <server name>
alerts --snmp_enable --host <server name>
alerts --snmp_trap_email [--enable] [--disable]
alerts --help
Authenticate Commands
Authenticate Command Usage
authenticate --show [--users]
authenticate --show [--domain <domain name>]
authenticate --show [--login_group]
authenticate --join --domain <domain name> [--ou <org-unit name>] --user <user name>
authenticate --leave [--user <user name>] [--force]
authenticate --update --kerberos
authenticate --add [--user <user name>]
authenticate --add [--login_group <DOMAIN\LOGIN GROUP>]
authenticate --delete--user <user name>
authenticate --delete [--login_group <DOMAIN\LOGIN GROUP>]
authenticate --set --user <user name>
authenticate --guestmode [--enable] [--disable]
authenticate --guestmode [--enable]
authenticate --guestmode [--disable]
authenticate --server_signing --mode <auto | mandatory | disabled>
authenticate --help
Network
Network Command Usage
network --show
network --delete
network --restart
network --setdhcp
network --setstatic_ip [--bondif <bondN>] [--nwif <ethN>] --ip <IPv4/IPv6 address not already in use> --netmask <netmask> [--gateway <IPv4/IPv6 address>]
network --create_bond
network --create_eth
network --add_member
network --setdns [--suffix <dns suffix>] [--primary <IPv4/IPv6 address>] [--secondary <IPv4/IPv6 address>]
network --setbonding --bondif <bondN> [--mode <ALB | 802.3ad>] [--mtu <supported MTU range 512 - 9000>]
network --update
network --factory_reset
network --host
network --route
network --nslookup --destination <ip address | hostname>
network --traceroute --destination <ip address | hostname>
network --ping --destination <ip address | hostname> [--tries <number>] [--size <number>] [--interface <bondN | ethN>]
network --blink
network --enable
network --troubleshoot [--links] [--gateway] [--ntp] [--dns] [--active_domain] [--nis] [--clients] [--port_mapper] [--network_config] [--show_active <NFS|CIFS|OST|RDS|NDMP|ISCSI|FC>] [--interface <bondN | ethN>]
network --troubleshoot --gateway --interface <bondN | ethN>
network --troubleshoot [--show_active <NFS| CIFS|OST|NDMP|ISCSI|RDS>]
network --tcpdump [--port <nfs | windows | replication | ost | rds>] [--pkt_size <128 - 32768>] [--file_size <0 - 100>] [--stop] [--host <ip address list>] [--interface <bondN | ethN>]
network --tcpdump [--pkt_size <128 - 32768>]
network --tcpdump [--file_size <0 - 100>]
network --tcpdump [--host <ip address list>]
network --tcpdump [--port <nfs | windows | replication | ost | rds>]
network --iperf_client --server <ip address | hostname> [--port <number>] [--window_size <num bytes [KB/MB]>] [--interval <num seconds>] [--time <num seconds>]
network --iperf_server [--port <number>] [--window_size <num bytes [KB/MB>]
network --help
OST
OST Command Usage
ost --show [--config] [--file_history] [--name <name>] [--active_files] [--name <name>] [--clients] [--limits]
ost --update --opdup_encryption <none | aes128 | aes256>
ost --delete_client --name <OST Client Hostname>
ost --update_client --name <OST Client Hostname> --mode <auto | passthrough | dedupe>
ost --limit --speed <<num><KBps | MBps | GBps | default> --target <ip address | hostname>
ost --partial_images --containerid <Container id> [--delete <Partial image path>] [--timeout <> 0>]
ost --help
RDA
RDA Command Usage
rda --show [--config] [--file_history] [--name <name>] [--active_files] [--name <name>] [--clients] [--limits]
rda --update --opdup_encryption <none | aes128 | aes256>
rda --delete_client --name <RDA Client Hostname>
rda --update_client --name <RDA Client Hostname> --mode <auto| passthrough| dedupe>
rda --limit --speed <<num><KBps| MBps| GBps> | default> --target <ip address | hostname>
rda --partial_images --containerid <Container id> [--delete <Partial image path>] [--timeout <> 0>]
rda --help
Stats
Stats Command Usage
stats --system
stats --cpu
stats --memory
stats --network
stats --datacheck
stats --nfs
stats --cifs
stats --ost
stats --rds
stats --ndmp
stats --ndmp_completed
stats --iscsi [--verbose]
stats --fc [--iostat] [--linkstat]
stats --container --name <name>
stats --storage_group --name <name>
stats --replication [--name <name>]
stats --cleaner
stats --clients [--type <NFS|CIFS|OST|RDS|NDMP|ISCSI|FC>]
stats --reset [--nfs] [--cifs] [--ost] [--rds] [--datacheck]
stats --reset --datacheck
stats --seed
stats --help
stats --datacheck
stats --datacheck Command Usage
stats --help datacheck
Storage Group commands
Storage Group Command Usage
storage_group --show [--name <name>] [--verbose]
storage_group --add --name <name> [--compression_mode <fast|best>]
storage_group --update --name <name> [--compression_mode <fast|best>]
storage_group --encryption --name <name> [--set <ON | OFF>] [--mode <static|internal> <--interval <7 days to 70 years>]
storage_group --setpassphrase --name <name>
storage_group --delete --name <name>
storage_group --help
System
System Command Usage
system --show [--config]
system --show [--hardware]
system --show [--storage] [--type <boot | internal | external>] [--service_tag <service tag>]
system --show [--storage]
system --show [--license] [--verbose]
system --show [--ntp]
system --show [--version]
system --show [--timezones [Region]]
system --show [--upgradefile]
system --show [--upgradehistory]
system --show [--marker]
system --show [--replication_traffic]
system --show [--opdup_traffic]
system --show [--backup_traffic]
system --show [--mgmt_traffic]
system --init
system --init --secure_erase <1–pass/3-passes/7-passes>
system --reboot
system --shutdown
system --upgrade
system --license [--validate] [--add]
system --setname --name <node_name>
system --setdate [--date <date>] [--timezone <Region/Zone>]
system --setntp [--add <server name>]
system --setntp [--delete <server name>]
system --setntp [--enable]
system --setntp [--disable]
system --setntp [--adjust_time]
system --hybrid_replication [--enable][--disable][--status]
system --rdairgap [--enable][--disable][--set_retention_period <0 days to 365 days>][--get_retention_period][--open][--close][--status]
system --rdairgap_schedule [--start_time <HH:MM>][--end_time <HH:MM>][--remove]
system --setlogin
system --telnet [--enable | --disable]
system --datacheck --enable
system --datacheck --disable
system --datacheck --throttle
system --marker [--enable] [--disable]
system --verify_on_read [--enable] [--disable]
system --add_storage --enclosure <service tag>
system --storage [--set_usage_alert <70% - 90%>]
system --storage [--blink] [--type <internal | external>] [--service_tag <service tag>] [--disk <slot num>]
system --storage [--unblink] [--type <internal | external>] [--service_tag <service tag>] [--disk <slot num>
system --mgmt_traffic
system --backup_traffic
system --replication_traffic
system --opdup_traffic
system --help
User
User Command Usage
user --show [--users] [--logins] [--verbose][--name <username>] [--roles <cifs|ost|rda|ndmp|iscsi|monitor|administrator|email_recipient>
user --enable --user <service | root>
user --disable --user <service | root>
user --add --name <user name>
user --update --name <user name> [--new_name <user name>] [--add_roles <cifs|ost|rda|ndmp|iscsi|monitor|email_recipient>] [--remove_roles <cifs|ost|rda|ndmp|iscsi|monitor|email_recipient>] [--full_name <full name>] [--phone <phone number>] [--email_addr <
user --delete --name <user name>
user --setpassword --name <user name>
user --help
Virtual Machine
Virtual Machine Command Usage
virtual_machine -- show [--service_tag <service tag>]
virtual_machine --show --summary
virtual_machine --update [--host <ip address | hostname>] [--name <administrator name>] [--email <email address>] [--company <company name>] [--comments <comments>]
virtual_machine --register [--host <ip address| hostname>] [--name <administrator name>] [--email <email address>] [--company <company name>] [--comments <comments>]
virtual_machine --unregister [--force]
virtual_machine –delete --service_tag <service tag>
Diagnostics
Managing DR Series System Storage Operations
Diagnostics Command Usage
diagnostics --start-service
diagnostics --show
diagnostics --collect
diagnostics --collect [--name <name>]
diagnostics --collect [--reason <reason>]
diagnostics --collect [--force]
diagnostics --collect [--dset]
diagnostics --collect [--logs]
diagnostics --collect [--cores]
diagnostics --collect [--tcpdump]
diagnostics --collect [--process_dump]
diagnostics --collect [--all]
diagnostics --delete [--name <name>]
diagnostics --delete [--all]
diagnostics --copy --name <name> --host <user@host | ip:>:<path>>
diagnostics --help
Maintenance
Maintenance Command Usage
maintenance --filesystem [--start_scan [verify_data | verify_rda_metadata | verify_metadata] [--storage_group <name>]
maintenance --filesystem [--stop_scan]
maintenance --filesystem [--scan_status]
maintenance --filesystem [--scan_report [verbose]]
maintenance --filesystem [--repair_status [verbose]]
maintenance --filesystem [--repair_history [verbose]]
maintenance --filesystem [--scan_restart [verify_data | verify_rda_metadata | verify_metadata]]
maintenance --filesystem [--repair_now]
maintenance --filesystem [--reclaim_space]
maintenance --filesystem [--clear_quarantine]
maintenance --filesystem [--clear_quarantine]
maintenance --filesystem --show_throughput
maintenance --configuration [--backup]
maintenance --configuration [--restore]
maintenance --configuration [--reinit_dictionary]
maintenance --configuration [--reset_web_certificate]
maintenance --configuration --enable_sha256_web_certificate
maintenance --hardware [--reinit_nvram]
maintenance --hardware [--restore_hw_db]
maintenance --hardware [--motherboard_replaced]
maintenance --disk [--make_standby [slot num]] [--type <internal | external-<num> | service tag>] --clear_foreign]
maintenance --remote_access [--show]
maintenance --remote_access [--enable]
maintenance --remote_access [--racreset]
maintenance --remote_access [--static_ip] [--ip <IPv4/IPv6 address>] [--netmask <netmask>] [--gateway <IPv4/IPv6 address>] [--device <lom1|lom2|lom3|lom4>]
maintenance --remote access [--disable]
maintenance --vdisk --check_consistency --type <boot|internal|external> [--service_tag <service tag>]
maintenance --help
System Storage Operation Commands
Connection
Data Integrity Checking
Connection Command Usage
connection --show [--name <name>]
connection --show [--name <name>] [--type <NFS|CIFS|OST|RDS|NDMP|ISCSI|FC>] [--verbose]
connection --show [--verbose]
connection --add --name <name> --type <NFS|CIFS|OST|RDS|NDMP|ISCSI|FC> [--clients <ip address>][--dma <ip address>][--initiator <IQN, ip address(es), hostname, or WWPN>][--target <WWPN>][--rootmap <nobody|root|administrator>] [--options <NFS|CIFS mount ex
connection --update --name <name> --type <NFS|CIFS|OST|RDS|NDMP|ISCSI|FC> [--clients <ip address>][--dma <ip address>][--initiator <IQN, ip address(es), hostname, or WWPN>][--target <WWPN>][--rootmap <nobody|root|administrator>] [--options <NFS|CIFS mount
connection --delete --name <name> --type <NFS|CIFS|OST|RDS|NDMP|ISCSI|FC> [--clients <ip address>]
connection --enable --name <name> --type <NFS|CIFS|OST|RDS>
connection --disable --name <name> --type <NFS|CIFS|OST|RDS>
connection --help
Container
Container Command Usage
container --show
container --show [--name <name>] [--verbose]
container --add --name <name> [--type <VTL>] [--tape_size <tape_size>][--no_of_drives <1–60>][--is_oem <yes|no>][--oem_vendor <QUEST|DELL>][--group_name <name>]
container --update --name <name> [--no_of_drives <1–60>]
container --delete --name <name>
container --delete --name <name> [--delete_files]
container --marker [--enable <Auto | CommVault | Networker | TSM | ARCserve | HP_DataProtector | Unix_Dump | BridgeHead>] [--disable <Auto | CommVault | Networker | TSM | ARCserve | HP_DataProtector | Unix_Dump | BridgeHead>] --name <name>
container --delete_files --name <name>
container --help
VTL
VTL Command Usage
vtl --show [--name <name>]
vtl --show --verbose [--name <name>]
vtl --update_carts --name <name> --add --no_of_tapes <number>
vtl --activate --name <name> [--force <yes|no>]
vtl --deactivate --name <name>
vtl --rescan --name <name> [--force <yes|no>]
vtl --set_rw --name <name> [--id <number>]
vtl --show_replstate --name <name>
vtl --help
NDMP
iSCSI
FC
FC Command Usage
fc --show [--verbose] [--target]
fc --sessions [--topology] [--condensed]
fc --help <command>
Replication
Replication Command Usage
replication --show [--name <name>] [--role <source | target>] [--verbose] [--limits]
replication --show
replication --show [--limits]
replication --add --name <name> --role <source | target> --peer <ip address | hostname> [--peer_name <name>] [--peer_group_name <name>] [--replication_traffic <ip address | hostname>] [--encryption <none | aes128 | aes256>][--username <user name>]
replication --update --name <name> --role <source | target> [--peer <ip address | hostname>] [--encryption <none | aes128 | aes256>] [--username <user name>]
replication --delete --name <name> --role <source | target> [--force]
replication --start --name <name> --role <source | target>
replication --stop --name <name> --role <source | target>
replication --limit --speed <<num><KBps | MBps | GBps> | default> --target <ip address | hostname>
replication --resync --name <name> --role <source | target>
replication --troubleshoot --peer <ip address | hostname>
replication --help
Seed
Seed Command Usage
seed --create --op <import | export> [--enc_type <aes128 | aes256>] [--storage_group_name <name>]
seed --add_container --name <container name>
seed --add_device --server <server name> --volume <volume> --username <username> --domain <domain name>
seed --cleanup
seed --remove_device
seed --show
seed --start
seed --help
Schedule
Schedule Command Usage
schedule --show [--cleaner]
schedule --show [--replication] [--name <name>]
schedule --add --day <day of the week> [--cleaner] [--replication] [--start_time <hh:mm>] [-- stop_time <hh:mm>] [--name <name>]
schedule --delete --day <day of the week> [--cleaner] [--name <name>] [--replication]
schedule --help
About Data Check
Additional Linux Commands
About us
Priority Write Verify Scans
Continuous Data Verification Scans
Data Check CLI Commands
Data Check Options
System --Datacheck
System --Datacheck Command Usage
system --datacheck
system --datacheck --disable
system --datacheck --enable
system --datacheck --throttle
system --help datacheck
stats --datacheck
ost --update_client --name <OST Client Hostname> --mode <auto | passthrough | dedupe>
Description
Updates the attributes of an OST client (OST client name and mode). The OST client modes are auto, passthrough, and dedupe. If an OST client has four or more CPU cores, it is considered to be dedupe-capable. However, the OST client operating mode depends upon how it is configured in the DR Series system.
|
• |
Auto — Sets the mode to dedupe or passthrough as determined by the media server. The mode used is based on how many cores the OST client has and whether it is 32–bit or 64–bit. If the OST client has four or more CPU cores, it will run in the dedupe mode. If the OST client has less than four CPU cores, it will run in passthrough mode. For details, see the table below. |
|
• |
Passthrough — The OST client passes all data to the DR Series system for dedupe processing. This is also known as “appliance-side dedupe”. |
|
• |
Dedupe — The OST client processes hashing on the data. This is also known as “source-side dedupe” and is the default mode. Keep in mind that the OST client must be dedupe-capable (four or more CPU cores) in order for this mode to be in effect. If the OST client is not dedupe-capable, it will run in passthrough mode regardless of its dedupe mode setting. |
Syntax
|
NOTE: You may be able to force writes for OST clients running in the Passthrough mode using the DR Series system CLI mode --dedupe command. The change in OST client mode is effective on the next backup operation when you are using Veritas NetBackup. (If you are using Veritas Backup Exec, you will need to restart this service for it to recognize that a new mode has been configured.) |
Result
ost --limit --speed <<num><KBps | MBps | GBps | default> --target <ip address | hostname>
Description
Limits the bandwidth consumed by OST (OpenStorage Technology) for a system you define by IP address or hostname (--target), by which you define the speed in kilobytes/second (KBps), megabytes/second (MBps), gigabytes/second (GBps), or an unlimited bandwidth (default).
Syntax
Result
ost --partial_images --containerid <Container id> [--delete <Partial image path>] [--timeout <> 0>]
Description
Lists or cleans up partial images.