Introduction to the QoreStor Command Line Reference Guide
Introducing QoreStor
Managing QoreStor
Alerts Commands
Authenticate Commands
Managing QoreStor Storage Operations
Authenticate Command Usage
Email_alerts Commands
OST
authenticate --show [--users]
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 --delete--user <user name>
authenticate --set --user <user name>
authenticate --guestmode [--enable]
authenticate --server_signing --mode <auto | mandatory | disabled>
authenticate --help
OST Command Usage
RDA
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 Command Usage
Sc_manager command
Stats
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 Command Usage
Storage Group commands
stats --system
stats --cpu
stats --memory
stats --nfs
stats --cifs
stats --ost
stats --rds
stats --iscsi [--verbose]
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 --seed
stats --peformance_tier
stats --cloud_tier
stats --object_direct
stats --archive_tier
stats --object_container
stats --help
Storage Group Command Usage
System
User
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 --delete --name <name>
storage_group --setpassphrase --name <name>
storage_group --help
User Command Usage
user --show [--users] [--logins] [--verbose][--name <username>] [--roles <cifs|ost|rda|ndmp|iscsi|monitor|administrator|email_recipient>
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
Cloud_tier
Connection
Maintaining QoreStor
Connection Command Usage
Container
connection --show [--name <name>] [--type <NFS|CIFS|OST|RDS|NDMP|ISCSI|FC>] [--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
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|CI
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 Command Usage
iSCSI
NDMP
Object_container
Object_direct
Performance_tier
Replication
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> [--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 --cloud_policy
container --delete_files --name <name>
container --add_uac
container --delete_uac
container --update_uac
container --show_uac
container --help
Replication Command Usage
Seed
replication --show
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 Command Usage
Schedule
VTL
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
VTL Command Usage
vtl --show [--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 --restore
vtl --set_rw --name <name> [--id <number>]
vtl --show_replstate --name <name>
vtl --help
Maintenance
About us
Maintenance command
maintenance --filesystem [--scan_status]
maintenance --filesystem [--scan_report [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 [--stop_reclaim_space]
maintenance --filesystem [--clear_quarantine]
maintenance --filesystem [--start_scan [verify_data | verify_rda_metadata | verify_metadata] [--storage_group <name>]
maintenance --filesystem [--stop_scan]
maintenance --diags --collect
maintenance --diags --show
maintenance --diags --delete <name>
maintenance --diags --delete_all
maintenance --disaster_recovery
maintenance --help
Connection Command Usage
This topic introduces the connection command usage:
- connection --show [options]
- connection --add --name [options]
- connection --update [options]
- connection --delete [options]
- connection --enable [options]
- connection --disable [options]
- connection --help
|
|
NOTE: If you specify a command without supplying the expected value or option, you are prompted to provide the correct value or option. |
connection --show [--name <name>] [--type <NFS|CIFS|OST|RDS|NDMP|ISCSI|FC>] [--verbose]
Managing QoreStor Storage Operations > Connection > Connection Command Usage > connection --show [--name <name>] [--type <NFS||||||FC>] [--verbose]
Description
Displays the current connections on a container.
|
|
NOTE: In addition to displaying the current status of an existing container connection, this command also verifies if an existing container connection is disabled (by listing its status as offline). |
Syntax
connection --show [--name <name>] [--type <NFS|||||>][--verbose]
Where
--name Name of container. ABC --type Type of sharing (NFS|||||). --verbose Show further details.
Result
Container Name Connection Type Target avc
Other Examples
Display the complete status of all existing container connections by using the --verbose command on a QoreStor (this example only shows a partial display of the total output):
Container Entry ID : 1 Container Name : NV_QS1 connection Entry ID : 1 connection Quota : Unlimited connection Used Capacity : 257.0 GiB connection Enabled : Yes connection status : Available
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
Managing QoreStor Storage Operations > Connection > Connection Command Usage > connection --add --name <name> --type <NFS||||||FC> [--clients <ip address>][--dma <ip address>][--initiator <IQN, ip address(es), hname, or WWPN>][--target <WWPN>][--map <nobody||administrator>] [--options <NFS| mount export options>] [--capacity <positive decimal number>]
Description
Adds a new connection to a container.
Syntax
connection --add --name <name> --type <NFS|||||> [--clients <ip address>] [--dma <ip address>] [--initiator <IQN, ip address, hname, or WWPN>] [--map <nobody | | administrator>] [--options <NFS | mount export options>] [--capacity <Positive decimal number>]
Where
--name Name of container. --type Type of sharing required (NFS|||||). --clients Restrict NFS/ access to this list of comma separated hs. --dma Restrict access to this DMA h. --initiator Restrict /FC access to this /FC initiator. --map How to map for NFS. --options mount options NFS (rw,ro,insecure), (hide,unhide, sync always=<yes/no>,valid users). --capacity usable capacity in Gigabytes.
Result
Successfully added connection entry. connection Quota : 10 connection Enabled : Yes
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|CI
Managing QoreStor Storage Operations > Connection > Connection Command Usage > connection --update --name <name> --type <NFS||||||FC> [--clients <ip address>][--dma <ip address>][--initiator <IQN, ip address(es), hname, or WWPN>][--target <WWPN>][--map <nobody||administrator>] [--options <NFS| mount export options>] [--capacity <positive decimal number>]
Description
Updates or modifies the connection values on an existing container connection on a QoreStor. The --capacity command option lets you specify a positive decimal number to represent the capacity size (in Gigabytes (GB)) of an container.
|
|
NOTE: container connections are unlimited by default, and type container connections only support unlimited capacity. |
Syntax
connection --update --name <name> --type <NFS|||||> [--clients <ip address>] [--dma <ip address>] [--initiator <IQN, ip address, hname, or WWPN>] [--map <nobody | | administrator>] [--options <NFS | mount export options>] [--capacity <Positive decimal number>]
Where
--name Name of container. --type Type of sharing required (NFS|||||). --clients Restrict NFS/ access to this list of comma separated hs. --dma Restrict access to this DMA h. --initiator Restrict /FC access to this /FC initiator. --map How to map for NFS. --options mount options NFS (rw,ro,insecure), (hide,unhide). --capacity usable capacity in Gigabytes.
Result
Successfully updated connection entry. connection Quota : 200 GiB connection Used Capacity : 0.0 GiB connection Enabled : Yes