Veritas Resiliency Platform 2.1

After the product configuration, whenever you log in to the Resiliency Platform appliance, you get the main menu of klish. This menu is the starting point, from which you can configure, manage, monitor, and support your application using the command line.

You can reconfigure or modify some of the appliance settings that are configured through the product bootstrap. Following are the settings that you can reconfigure using klish:

  • Network settings: You can reconfigure the subnet mask, default gateway, DNS server, and search domains using the klish menu.

    You cannot reconfigure the hostname that you had configured through the bootstrap process. In case of static DHCP, you cannot change the network settings using the klish menu. You cannot change the network settings for any component that is configured in the cloud environment.

  • System settings: You can reset the timezone and NTP server using klish menu. Changing the system settings can affect the product functionality if incorrect values are set.

You can also perform logical volume management (LVM) operations such as adding a disk or removing a disk using the klish menu.

You can press the tab or space key to display the menu options. Press ? key to display detailed help.

If a klish command is expected to perform any operation on an entity such as start or stop services, it goes into lock mode and does not allow same operation from any other session till the first operation gets completed. You can see a message similar to the following:

Warning: Try to get lock. Please wait...

Error: Can't get lock.

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

manage

Manage appliance

Table: Options available with manage command

monitor

Monitor appliance activities

Table: Options available with monitor command

network

Network configuration

Table: Options available with network command

settings

Appliance settings

Table: Options available with settings command

support

Access logs

Table: Options available with support command

updates

Manage updates and patches

Table: Options available with updates command

Table: Options available with manage command

Menu option

Description

back

Return to the previous menu

configure

Configure Resiliency Platform component or show the configured component

Table: Options available with configure command

datamover

Manage Resiliency Platform Data Mover activities and objects

This option is available only on a Replication Gateway or Storage Proxy appliance

Table: Options available with datamover command

exit

Log out from the current CLI session

help

Display an overview of the CLI syntax

infra-appliance

List or remove Replication Gateway appliance

Table: Options available with infra-appliance command

services

Manage the appliance services

Table: Options available with configure command

Menu option

Description

ims_register

Register the IMS using the registration URL obtained after initiating the Add IMS operation

See Adding an IMS

ims

Configure Infrastructure Management Server

rm

Configure Resiliency Manager

show

Show the configured component

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

clear-admin-wait

Clear the admin Wait status for the Veritas Replication Set

Table: Options available with infra-appliance command

Menu option

Description

list

List the Replication gateway appliance.

remove

Remove the Replication Gateway appliance.

You need to remove the Gateway pair before you remove the Gateway.

See Removing a Veritas Replication Gateway pair

Table: Options available with services command

Menu option

Description

show

Show Resiliency Platform services. the short service names displayed here are used while exercising other options with services command such as restart, start, status.

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 monitor command

Menu option

Description

back

Return to the previous menu

exit

Log out from the current CLI session

datamover

Display VRP Datamover activities and objects

This option is available only on a Replication Gateway or Storage Proxy appliance

Table: Options available with datamover command

FSusage

Display filesystem usage

help

Display an overview of the CLI syntax

top

Display the top process information

uptime

Display the uptime statistics for the appliance

who

Display who is currently logged into the appliance

Table: Options available with datamover command

Menu option

Description

repl-sets

Display the details about Veritas Replication Sets including RPO, connection state, replication state

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)

Table: Options available with network command

Menu option

Description

back

Return to the previous menu

dns

Show or change the DNS

Table: Options available with dns command

exit

Log out from the current CLI session

gateway

Show or change the Gateway

Table: Options available with gateway command

help

Display an overview of the CLI syntax

hostname

Show the hostname

ip

Show or change the IP address

Table: Options available with ip command

netmask

Show or change the netmask

Table: Options available with netmask command

search-domain

Show or change the domain

Table: Options available with search-domain command

Table: Options available with dns command

Menu option

Description

set

Configure Domain Name Server

show

Show the current Domain Name Server

Table: Options available with gateway command

Menu option

Description

set

Configure Gateway

show

Show the current Gateway

Table: Options available with ip command

Menu option

Description

set

Configure the IP address for additional NIC

show

Show the current IP address

Table: Options available with netmask command

Menu option

Description

set

Configure the netmask

show

Show the current netmask

Table: Options available with search-domain command

Menu option

Description

add

Add search-domain

remove

Remove the search domain name

show

Show the search domain settings

Table: Options available with settings command

Menu option

Description

back

Return to the previous menu

change-password

Change the admin user password for the appliance

date

Display the current date and time for the appliance

Table: Options available with date command

exit

Log out from the current CLI session

help

Display an overview of the CLI syntax

lvm

Perform operations related to logical volume manager on the appliance

Table: Options available with lvm command

ntp

Perform operations related to NTP server

poweroff

Shut down the appliance

reboot

Restart the appliance

timezone

Show or change the timezone for the appliance

Table: Options available with timezone command

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 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 data volume

remove-disk

Remove disk from the data volume. Make sure that you have an extra disk to migrate the data before removing a disk.

In case you initialize the newely-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 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

loggather

  • If the appliance has been configured as a Resiliency Manager or an IMS, then various options will be available for collecting the Resiliency Manager and IMS logs.

    Table: Options available with loggather command

  • If the appliance has been configured as a Replication Gateway, then loggather command will collect the logs of the Replication gateway.

shell

Open the bash shell prompt for support user

Table: Options available with loggather command

Menu option

Description

basic

Gather logs of Resiliency Manager and IMS without database

full

Gather logs of Resiliency Manager and IMS with database

fullims

Gather logs of IMS with database

fullrm

Gather logs of Resiliency Manager with database

ims

Gather logs of IMS

rm

Gather logs of Resiliency Manager

Table: Options available with updates command

Menu option

Description

config-local-iso-repository

Configure the repository from locally mounted ISO image on CD-ROM

apply-update

Apply the specified update

back

Return to the previous menu

config-repository

Configure the repository

Table: Options available with config-repository command

exit

Log out from the current CLI session

help

Display an overview of the CLI syntax

list-updates

List the applicable updates

remove-repository

Remove current repository configuration

show-readme

Show readme for the specified update

show-repository

Show current repository configuration

show-version

Show appliance version

Table: Options available with config-repository command

Menu option

Description

hostname

hostname of the repository server

protocol

Protocol on which the repository server is configured

port

Port on which the repository server is configured

RepoPath

Path on which the repository server is configured

Veritas Resiliency Platform 2.1

After the product configuration, whenever you log in to the Resiliency Platform appliance, you get the main menu of klish. This menu is the starting point, from which you can configure, manage, monitor, and support your application using the command line.

You can reconfigure or modify some of the appliance settings that are configured through the product bootstrap. Following are the settings that you can reconfigure using klish:

  • Network settings: You can reconfigure the subnet mask, default gateway, DNS server, and search domains using the klish menu.

    You cannot reconfigure the hostname that you had configured through the bootstrap process. In case of static DHCP, you cannot change the network settings using the klish menu. You cannot change the network settings for any component that is configured in the cloud environment.

  • System settings: You can reset the timezone and NTP server using klish menu. Changing the system settings can affect the product functionality if incorrect values are set.

You can also perform logical volume management (LVM) operations such as adding a disk or removing a disk using the klish menu.

You can press the tab or space key to display the menu options. Press ? key to display detailed help.

If a klish command is expected to perform any operation on an entity such as start or stop services, it goes into lock mode and does not allow same operation from any other session till the first operation gets completed. You can see a message similar to the following:

Warning: Try to get lock. Please wait...

Error: Can't get lock.

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

manage

Manage appliance

Table: Options available with manage command

monitor

Monitor appliance activities

Table: Options available with monitor command

network

Network configuration

Table: Options available with network command

settings

Appliance settings

Table: Options available with settings command

support

Access logs

Table: Options available with support command

updates

Manage updates and patches

Table: Options available with updates command

Table: Options available with manage command

Menu option

Description

back

Return to the previous menu

configure

Configure Resiliency Platform component or show the configured component

Table: Options available with configure command

datamover

Manage Resiliency Platform Data Mover activities and objects

This option is available only on a Replication Gateway or Storage Proxy appliance

Table: Options available with datamover command

exit

Log out from the current CLI session

help

Display an overview of the CLI syntax

infra-appliance

List or remove Replication Gateway appliance

Table: Options available with infra-appliance command

services

Manage the appliance services

Table: Options available with configure command

Menu option

Description

ims_register

Register the IMS using the registration URL obtained after initiating the Add IMS operation

See Adding an IMS

ims

Configure Infrastructure Management Server

rm

Configure Resiliency Manager

show

Show the configured component

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

clear-admin-wait

Clear the admin Wait status for the Veritas Replication Set

Table: Options available with infra-appliance command

Menu option

Description

list

List the Replication gateway appliance.

remove

Remove the Replication Gateway appliance.

You need to remove the Gateway pair before you remove the Gateway.

See Removing a Veritas Replication Gateway pair

Table: Options available with services command

Menu option

Description

show

Show Resiliency Platform services. the short service names displayed here are used while exercising other options with services command such as restart, start, status.

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 monitor command

Menu option

Description

back

Return to the previous menu

exit

Log out from the current CLI session

datamover

Display VRP Datamover activities and objects

This option is available only on a Replication Gateway or Storage Proxy appliance

Table: Options available with datamover command

FSusage

Display filesystem usage

help

Display an overview of the CLI syntax

top

Display the top process information

uptime

Display the uptime statistics for the appliance

who

Display who is currently logged into the appliance

Table: Options available with datamover command

Menu option

Description

repl-sets

Display the details about Veritas Replication Sets including RPO, connection state, replication state

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)

Table: Options available with network command

Menu option

Description

back

Return to the previous menu

dns

Show or change the DNS

Table: Options available with dns command

exit

Log out from the current CLI session

gateway

Show or change the Gateway

Table: Options available with gateway command

help

Display an overview of the CLI syntax

hostname

Show the hostname

ip

Show or change the IP address

Table: Options available with ip command

netmask

Show or change the netmask

Table: Options available with netmask command

search-domain

Show or change the domain

Table: Options available with search-domain command

Table: Options available with dns command

Menu option

Description

set

Configure Domain Name Server

show

Show the current Domain Name Server

Table: Options available with gateway command

Menu option

Description

set

Configure Gateway

show

Show the current Gateway

Table: Options available with ip command

Menu option

Description

set

Configure the IP address for additional NIC

show

Show the current IP address

Table: Options available with netmask command

Menu option

Description

set

Configure the netmask

show

Show the current netmask

Table: Options available with search-domain command

Menu option

Description

add

Add search-domain

remove

Remove the search domain name

show

Show the search domain settings

Table: Options available with settings command

Menu option

Description

back

Return to the previous menu

change-password

Change the admin user password for the appliance

date

Display the current date and time for the appliance

Table: Options available with date command

exit

Log out from the current CLI session

help

Display an overview of the CLI syntax

lvm

Perform operations related to logical volume manager on the appliance

Table: Options available with lvm command

ntp

Perform operations related to NTP server

poweroff

Shut down the appliance

reboot

Restart the appliance

timezone

Show or change the timezone for the appliance

Table: Options available with timezone command

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 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 data volume

remove-disk

Remove disk from the data volume. Make sure that you have an extra disk to migrate the data before removing a disk.

In case you initialize the newely-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 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

loggather

  • If the appliance has been configured as a Resiliency Manager or an IMS, then various options will be available for collecting the Resiliency Manager and IMS logs.

    Table: Options available with loggather command

  • If the appliance has been configured as a Replication Gateway, then loggather command will collect the logs of the Replication gateway.

shell

Open the bash shell prompt for support user

Table: Options available with loggather command

Menu option

Description

basic

Gather logs of Resiliency Manager and IMS without database

full

Gather logs of Resiliency Manager and IMS with database

fullims

Gather logs of IMS with database

fullrm

Gather logs of Resiliency Manager with database

ims

Gather logs of IMS

rm

Gather logs of Resiliency Manager

Table: Options available with updates command

Menu option

Description

config-local-iso-repository

Configure the repository from locally mounted ISO image on CD-ROM

apply-update

Apply the specified update

back

Return to the previous menu

config-repository

Configure the repository

Table: Options available with config-repository command

exit

Log out from the current CLI session

help

Display an overview of the CLI syntax

list-updates

List the applicable updates

remove-repository

Remove current repository configuration

show-readme

Show readme for the specified update

show-repository

Show current repository configuration

show-version

Show appliance version

Table: Options available with config-repository command

Menu option

Description

hostname

hostname of the repository server

protocol

Protocol on which the repository server is configured

port

Port on which the repository server is configured

RepoPath

Path on which the repository server is configured