Klish menu options for Replication Gateway
Following are the options available for Replication Gateway using klish menu:
Table: Options available in the main menu
Menu option | Description |
|---|---|
back | Return to the previous menu |
exit | Log out from the current CLI session |
help | Display an overview of the CLI syntax |
hotfix | Manage hotfixes |
manage | Manage appliance |
monitor | Monitor appliance activities |
network | Manage network configuration |
settings | Manage appliance settings |
support | To access logs |
utilities | Run miscellaneous utilities |
Table: Options available with hotfix command
Menu option | Description |
|---|---|
back | Return to the previous menu |
exit | Log out from the current CLI session |
help | Display an overview of the CLI syntax |
apply-hotfix | Apply the specified hotfix |
list-applied-hotfixes | List the applied hotfixes |
list-available-hotfixes | List the available hotfixes |
uninstall-hotfix | Uninstall the specified hotfix |
Table: Options available with manage command
Menu option | Description |
|---|---|
exit | Log out from the current CLI session |
help | Display an overview of the CLI syntax |
datamover | Manage Resiliency Platform Data Mover activities and objects |
services | Manage the appliance services |
staging-storage | Perform Staging Storage Operations |
cdp-storage | Manage CDP related storage |
Table: Options available with datamover command
Menu option | Description |
|---|---|
start | Start a Veritas Replication Set |
abort | Stop a Veritas Replication Set |
delete | Delete a Veritas Replication Set |
resume | Resume a Veritas Replication Set |
pause | Pause a Veritas Replication Set locally. |
suspend-force | Suspend a Veritas Replication Set |
clear-admin-wait | Clear the admin Wait status for the Veritas Replication Set |
modify-quota-size | Modify the size of the quota of a Veritas Replication Set. Modifying the quota affects the number of hosts that are protected with the gateway. You need to configure same quota size on all the peer gateways. Default quota size is 8000 MB. The minimum allowed quota size in direct mode is 2000 MB and in ObjectStore mode is 3500 MB. The maximum allowed quota size in direct and ObjectStore mode is 8000 MB. |
modify-updateset-size | Modify the size of the UpdateSet. You need to configure same UpdateSet size on all the peer gateways. Default UpdateSet size is 500 MB. The minimum allowed UpdateSet size is 500 MB and the maximum allowed UpdateSet size is 2000 MB. |
modify-replication-frequency | Modify the replication frequency. The default frequency is 120 sec. The minimum replication frequency allowed is 60 sec and maximum replication frequency allowed in 300 sec |
modify-tcpadvwin | Modify the TCP socket's send and receive size between workload and the Replication Gateway. The default tcpadvwin value is 2 MB and maximum is 4MB. After the sizes are changed, replication of the consistency group has to be suspended and resumed to reflect this change. To suspend and resume the changes, use suspend-force and resume commands. Note: This command is not applicable for in-guest Windows workloads. |
Table: Options available with fips command
Menu option | Description |
|---|---|
enable | Disable FIPS on the Replication Gateway appliance. |
disable | Enable FIPS on the Replication Gateway appliance. |
status | Show the current status of FIPs mode for the Replication Gateway appliance. |
Table: Options available with services command
Menu option | Description |
|---|---|
restart | Restart Resiliency Platform services Two options available are: restart all where, all means all the services. restart service name where, service name is the name of a particular service. You can provide multiple service names (comma separated). |
start | Start Resiliency Platform services Two options available are: start all where, all means all the services. start service name where, service name is the name of a particular service. You can provide multiple service names (comma separated). |
status | Check the status of Resiliency Platform services Two options available are: status all where, all means all the services. status service name where, service name is the name of a particular service. You can provide multiple service names (comma separated). |
stop | Stop Resiliency Platform services Two options available are: stop all where, all means all the services. stop service name where, service name is the name of a particular service. You can provide multiple service names (comma separated). |
Table: Options available with staging-storage command
Menu option | Description |
|---|---|
add-disk | Add disk to the staging-storage. You need to attach a disk before adding it. |
list-used-disk | List the disks used in staging-storage. |
remove-disk | Remove disk from the staging-storage. Remove disk operation involves migrating data from the existing disk to a new disk. You can remove a disk only after attaching a new disk with enough storage to migrate the data. The command first displays the list of disks being used and you need to select the disk that you want to remove. Then it displays the list of free disks where you want to migrate data and you need to select the disk. You can choose whether to initialize the new disk or not. It is recommended to suspend replication of all the configured Veritas Replication Sets before performing the remove disk operation. |
resize-logicalvolume | Resize the volume used in staging-storage. |
Table: Options available with cdp-storage command
Menu option | Description |
|---|---|
add-disk | To add a disk to the CDP storage |
create-cdp-storage | To create a CDP storage |
list-cdp-storage | To list all the CDP storage |
list-used-disk | To list the disk used in the CDP storage |
recover-cdp-storage | To recover the CDP storage |
remove-cdp-storage | To remove the CDP storage |
resize-logicalvolume | To resize the volume used in the CDP storage |
recover-cdp-storage | To recover the CDP storage. This is also trigger data integrity test for the recovered CDP storage. |
data-integrity-test | Perform data integrity test on data residing on respective CDP storage associated with Replication Set. Ensure that replication is not active for the opted replication set. One can perform Pause Table: Options available with datamover command before issuing this test. |
Table: Options available with monitor command
Menu option | Description |
|---|---|
back | Return to the previous menu |
exit | Log out from the current CLI session |
help | Display an overview of the CLI syntax |
top | Display the top process information |
who | Display who is currently logged into the appliance |
uptime | Display the uptime statistics for the appliance |
FSuage | Display filesystem usage See Troubleshooting: klish commands for Resiliency Manager, IMS, or Replication Gateway. |
datamover | Display VRP Datamover activities and objects |
Table: Options available with datamover command
Menu option | Description |
|---|---|
cdp-recovery-points | Display Veritas Replication Set details like recovery point ID, state, last received input /outputs, and time stamps |
cdp-usage-stats | Displays details for each Veritas Replication Set like allocated space, free space, usage, etc. |
usage-stats | Display the Resiliency Platform Data Mover usage stats |
repl-sets | Display the details about Veritas Replication Sets including RPO, connection state, replication state. Display time required to sync the data and percentage of synced or replicated data. |
update-sets | Display the list of current update sets which are in transit |
ingress-data | Display the IO statistics for the data transfer from protected virtual or physical machine to Gateway (IOReceiver statistics) |
network-data | Display the network related statistics for data transfer between production site Gateway and recovery site Gateway (Transceiver statistics) |
disk-data | Display the IO statistics for the data write on recovery site disks (Applier statistics) |
pair-status | Displays information and connectivity status of the local and the peer Gateway |
Table: More information on the command
Datamover command | More information |
|---|---|
repl-sets | Name: Veritas Replication Set name for the protected virtual machine VRS-ID: Veritas Replication Set unique ID of a protected virtual machine Role: Role of the data center for the current Veritas Replication Set Data State: Replication data state for the current VRS-ID State: Replication State for the current VRS-ID Host Connection: Connection state of the protected virtual machine with the Replication Gateway Disks: Number of replicating disks for the protected virtual machine Lag (seconds): The time difference in seconds between a write operation occurs on the protected host on source side and the same gets replicated on the target side Admin Intervention: A flag notation if replication is broken. Check Admin wait state code Peer Gateway IP: IP address of the paired gateway |
update-sets | Name: Veritas Replication Set name for the protected virtual machine VRS-ID: Veritas Replication Set unique ID of a protected virtual machine USID: Unique ID of the current update set. This is an increasing counter for each update set State: Current state of the Replication Update Set Size: Size of the data which is replicated in this update set Elapsed Time: Time of Update Set in the current state |
ingress-data | VRS-ID: Veritas Replication Set Unique ID of a protected virtual machine USID: Unique ID of the current update set #Disk: Number of replicating disk or disks for protected virtual machine State: Shows different states of the virtual machine which is attached to the Replication Gateway. (INIT/DISCONNECTED/ACTIVE/SUSPENDED/ABORTED) Rate: IO rate of data from the protected host to Replication Gateway (Example: For the current update set, 907.0MB data has been received at the rate of 403.1Mb/s) Latency: This depicts the latency between the protected host to source Replication Gateway. Latency gives information about which component is slower Local deduplication: To know how much data is sent and the old data is cancelled (Amount of data written will be cancelled / total data size) |
network-data | VRS-ID: Veritas Replication Set Unique ID of a protected virtual machine USID: Unique ID of the current update set Direction: Send: If update set is being sent from the Replication Gateway. Receive: If update set is being received by the Replication Gateway. Size: Size of the replicated data in this update set Rate: This is the rate at which the data is being written to the target disks by replication gateway Latency: Latency gives information about which component is slower Compression Ratio: Shows how much data is compressed while sending over WAN. The compression ratio is equal to actual data in update set/data sent over WAN |
disk-data | VRS-ID: Veritas Replication Set Unique ID of a protected virtual machine USID: Unique ID of the current update set #Disk: Number of replicating disk or disks for protected virtual machine Size: Size of the replicated data in this update set Rate: This is the rate at which the data is being written to the target disks by replication gateway (Example: If update is 907MB, then rate at which it is written to the disk can be 403.1Mbps Latency (Read, Write): Shows relative latency between staging area disk read and target disk write |
pair-status | Pair Name: Name of the pair created between local and peer gateway Peer Gateway IP: IP address of the paired gateway Gateway Pair ID: Unique ID of the gateway which is paired Peer Gateway ID: Unique ID of the peer gateway Config State: Configuration state of the pair Connection State: Status of the connection between the local and the peer gateway |
Table: Options available with network command
Menu option | Description |
|---|---|
back | Return to the previous menu |
exit | Log out from the current CLI session |
help | Display an overview of the CLI syntax |
dns | Show or set the DNS server or manage the options for resolv.conf file |
ip | Show the IP address |
route | View and manipulate the IP routing table |
search-domain | Show or change the domain |
traceroute | Trace packet routes to a particular host. You can also specify a port to trace the packet routes. |
ssh-enabled-nic | Show or update SSH enabled NIC |
nic-configuration | Show and configure the NIC |
nic-for-UI | Show or update NICs configured to access product user interface |
Table: Options available with dns command
Menu option | Description |
|---|---|
options | Show, add, or remove options to the /etc/resolv.conf file. Refer to the documentation of resolv.conf for a list of available options and their purpose. |
set | Configure Domain Name Server |
show | Show the current Domain Name Server |
Table: Options available with options command
Menu option | Description |
|---|---|
add | Add a resolv.conf option |
remove | Remove a resolv.conf option |
show | Show options of resolv.conf file |
Table: Options available with IP command
Menu option | Description |
|---|---|
show | Show the current IP address |
Table: Options available with route command
Menu option | Description |
|---|---|
add | Set a default route or a route for a host or a subnet |
delete | Delete the route entry from the routing table |
show | Display your current routing table |
Table: Options available with search-domain command
Menu option | Description |
|---|---|
add | Add a search-domain |
remove | Remove the search domain name |
show | Show the search domain settings |
Table: Options available with ssh-enabled-nic command
Menu option | Description |
|---|---|
show | Show the NICs on which SSH is enabled. By default, SSH is enabled on all the NICs. |
add | Add NIC to enable SSH on it |
remove | Remove NIC to disable SSH on it |
Table: Options available with nic-configuration command
Menu option | Description |
|---|---|
show | Show details of NIC configuration like hostname, IPv4 or IPv6 address, prefix, gateway etc. |
set | Configure the NICs which are not used while bootstrapping. |
Table: Options available with nic-for-UI command
Menu option | Description |
|---|---|
show | Show the NICs which are used to access product web user interface. |
set | Set a NIC to access product web user interface from existing configured NICs. |
remove | Remove one of the NICs used to access product web user interface. |
Table: Options available with settings command
Menu option | Description |
|---|---|
back | Return to the previous menu |
exit | Log out from the current CLI session |
help | Display an overview of the CLI syntax |
date | Display the current date and time for the appliance |
lvm | Perform operations related to logical volume manager on the appliance |
ntp | Perform operations related to NTP server |
change-password | Change the admin user password for the appliance |
poweroff | Shut down the appliance |
fips | Enable, disable, or view the status of FIPS mode for a Replication Gateway |
configure | Configure Resiliency Platform component or show the configured component |
reboot | Restart the appliance |
timezone | Show or change the timezone for the appliance |
password-policies | Perform operation related to password policies of administrator user for the appliance |
Table: Options available with date command
Menu option | Description |
|---|---|
show | Show the time and date |
Table: Options available with lvm command
Menu option | Description |
|---|---|
add-disk | Add disk to the OS or data volume. You need to attach a disk before adding it. |
list-free-disk | List the free disks |
initialize-free-disk | Initialize the newly attached free disk |
list-used-disk | List the disks used by the OS or data volume. |
remove-disk | Remove disk from the data volume. Remove disk operation involves migrating data from the existing disk to a new disk. You can remove a disk only after attaching a new disk with enough storage to migrate the data. The command first displays the list of disks being used and you need to select the disk that you want to remove. Then it displays the list of free disks where you want to migrate data and you need to select the disk. You can choose whether to initialize the new disk or not. It is recommended to suspend replication of all the configured Veritas Replication Sets before performing the remove disk operation. |
resize-logicalvolume | Resize the OS or data volume for resized data disk. |
Table: Options available with add-disk command
Menu options | Description |
|---|---|
data-volume | Add disk to the data volume |
os-volume | Add disk to the OS volume |
Table: Options available with list-used-disk command
Menu options | Description |
|---|---|
data-volume | Lists disks used by the data volume |
os-volume | Lists disks used by the OS volume |
Table: Options available with resize-logical-volume command
Menu options | Description |
|---|---|
data-volume | Resize the data volume |
os-volume | Resize the OS volume |
Note:
In case you initialize the newly-added disk during add-disk or remove-disk operation, the existing data on the new disk is deleted.
Table: Options available with timezone command
Menu option | Description |
|---|---|
set | Set the timezone for the appliance |
show | Show the current timezone for the appliance |
Table: Options available with password-policies command
Menu option | Description |
|---|---|
set | Modify the administrator user password policies for the appliance. |
show | Show the administrator user password-policies for the appliance. |
Table: Options available with password-policies set command
Menu option | Description |
|---|---|
max-age | Modify the maximum number of days before password change is required for administrator user. |
min-age | Modify the minimum number of days before password change is required for administrator user. |
min-length | Modify minimum password length for the administrator user. |
warning-days | Modify number of days before a warning for administrator password expiry is given. |
Table: Options available with support command
Menu option | Description |
|---|---|
back | Return to the previous menu |
exit | Log out from the current CLI session |
help | Display an overview of the CLI syntax |
reset-support-password | Reset the support user password to the default installation password. This option may typically be used by Veritas support. |
shell | Open the bash shell prompt for support user |
loggather | If the appliance has been configured as a Replication Gateway, then loggather full command will collect the logs of the Replication Gateway. |
Table: Options available with loggather command
Menu option | Description |
|---|---|
file-or-folder | Gather selected logs of Replication Gateway |
full | Gather logs of Replication Gateway with database |
cleanup | Clean up the loggather files of Replication Gateway |
show | Lists all the loggather URLs ordered by date and time of Replication Gateway |
Table: Options available with file-or-folder command
Menu option | Description |
|---|---|
--force | Gather selected logs of Replication Gateway with force option |
Table: Options available with full command
Menu option | Description |
|---|---|
Number of days | Displays the full logs from the days (1-99) mentioned |
--force | Gather logs of Replication Gateway with database with force option |
Table: Options available with utilities command
Menu option | Description |
|---|---|
back | Return to the previous menu |
exit | Log out from the current CLI session |
help | Display an overview of the CLI syntax |
clear | Clear the screen |
unmount-cd-rom | Unmount the CD-ROM from the appliance |
troubleshoot run-tool | Use the troubleshoot menu options |
vmware-tools | Perform VMware Tools operations (install, uninstall, and show-version) |
sftp-session | Use SFTP session for file transfer operation on the SFTP server |
azure-waagent-service | Perform Azure waagent service operation. Applicable only in Azure environment |
device-path-id | Show details of the attached disks to the Replication Gateway |
Table: Options available with troubleshoot run-tool command
Menu option | Description |
|---|---|
view-logs | View log files on any virtual appliance |
check-port | Verify required open ports on Veritas Resiliency Platform VSA for communication with other appliance using admin password. |
Table: Options available with vmware-tools command
Menu option | Description |
|---|---|
install | Install the VMware Tools mounted on CD-ROM of the appliance |
show-version | Show the installed version of VMware Tools on the appliance |
uninstall | Uninstall the VMware Tools from the appliance |
Table: Options available with sftp-session command
Menu option | Description |
|---|---|
start | To start the SFTP server session |
show-details | View the current SFTP user and session details |
stop | To stop the SFTP server session |
Table: Options available with device-path-id command
Menu option | Description |
|---|---|
size | Show device path, disk ID, and size of the attached disks to the Replication Gateway |
Table: Options available with start command
Menu option | Description |
|---|---|
get | View the file types that can be downloaded from the SFTP server |
put | View the file types that can be uploaded on the SFTP server |
Table: Options available with get command
Menu option | Description |
|---|---|
logs | Download the log files and directories from the SFTP server |
heap-dump | Download the heap dump files of the service available on Resiliency Manager |
Table: Options available with put command
Menu option | Description |
|---|---|
patch | Upload the private patch on the SFTP server |
Table: Options available with azure-waagent-service command
Menu option | Description |
|---|---|
start | Start Azure waagent service |
stop | Stop Azure waagent service |
status | Show current status of Azure waagent service |