Network Tools

Table of Contents

NetworkTestTool

The NetworkTestTool is a TCP/IP-based tool for verifying network connectivity between CommCell components. It provides a single interface to all basic network tests for troubleshooting network connectivity and data transmission issues between any two CommCell computers.

The NetworkTestTool can be used in Utility, Client and Server modes, as described below.

Notes:

  • If you are using an Apple Macintosh computer, run this command before running the NetworkTestTool:
  • export DYLD_LIBRARY_PATH=/opt/software_installation_path/Base

  • Laptop backup client installs do not include the NetworkTestTool.

Utility Mode

Utility mode provides options for verifying and troubleshooting network connectivity. In this mode, the tool supports lookup, cvping and servicecheck options.

Lookup

The utility mode's lookup option returns network interface information about a host you name, through a DNS (Domain Name Service) lookup, using a specified version of IP protocol.

To look up a host name:

  1. Change to the base installation directory:

    cd software_installation_path\Base

  2. Enter the command:

    CvNetworkTestTool -Utility –lookup –log location -HostName name -UseIPv4/UseIPv6/UseIPAny

    where:

    • Utility means to run in utility mode.
    • lookup locates the host through a DNS lookup.
    • log specifies the location of the log file. Required.
    • HostName is the host name of the destination computer.
    • UseIPv4 | UseIPv6 | UseIPAny is optional, specifying the protocol to use for network communication. If not supplied, IPv4 is used.

    Example:

    CVNetworkTestTool -Utility -lookup –log C:\lookup.log -HostName <name> -UseIPv4

  3. The command returns network-related Information about the host.

CVPing

The CVPing mode of the CVNetworkTestTool Utility mode lets you troubleshoot and test network connectivity between two clients.

CVPing performs a name lookup, then pings the IP address of the destination computer to check its network connectivity.

Follow these steps:

  1. Change to the software installation base directory for the instance to test:

    cd software_installation_path/Base

  2. Test the connectivity:
  3. CvNetworkTestTool -Utility –cvping –log location -HostName name [-UseIPv4 | -UseIPv6 | -UseIPAny] [-Port port_number]

    where:

    • Utility means to run in utility mode.
    • cvping tells the command to verify connectivity using CVPing mode.
    • log is the location of the log file.
    • HostName is the host name of the destination computer.
    • (Optional) UseIPv4 | UseIPv6 | UseIPAny, specifies the protocol to use for network communication. If not supplied, IPv4 protocol is used.
    • (Optional) Port port_number is the port number of the destination computer to be used for testing connectivity. If not supplied, port 8400 is used.

    For example:

    CVNetworkTestTool -Utility -CVPing –log C:\CVPing.log -HostName cvhost1 -UseIPv4 -Port 8400

  4. The command returns the result of network connectivity testing.

Service Check

The service check utility gathers basic network information about application-specific services. If you have more than one instance, you must specify the instance name to verify. Also, ensure that the destination computer is registered with the CommServe that you are running the tool from.

To check network connectivity:

  1. Change to the software installation base directory for the instance to test:

    cd software_installation_path/Base

  2. Run the CvNetworkTestTool command:
  3. CvNetworkTestTool -Utility –servicecheck –log location [-HostName <name> | -HostIP IPAddr] -Instance InstanceName [-UseIPv4 | -UseIPv6 | -UseIPAny] -Platform platform_type

    where:

    • Utility means to run in utility mode. Required for this operation.
    • servicecheck tells the command to verify connectivity using CVPing. Required for this operation.
    • log is the location of the log file. Required.
    • HostName is the host name of the destination computer.
    • HostIP is the destination computer's IP Address. The default IP address is localhost. If you provided the host name of the destination computer, the HostIP is not needed.
    • Instance is the instance name on the destination computer. If not specified, Instance001 is used.
    • UseIPv4 | UseIPv6 | UseIPAny specifies the protocol to use for network communication. Optional. If not supplied, IPv4 protocol is used.
    • Platform is the type of the remote platform module. Valid values are CS (CommServe), MA (MediaAgent) and CC (CommCell Console). This option supports one type. Without this option, all types are checked.

    For example:

    CVNetworkTestTool -Utility -servicecheck –log C:\service.log –HostName cvhost23 -Instance Instance001 -UseIPAny –Platform CS

  4. The command returns the status of the application services you specified.

Server Mode

When you run CvNetworkTestTool in server mode, the server listens for an incoming client connection. You can specify the port for listening and the TCP/IP protocol version to be used. Connectivity is verified by the connection being established with the client.

To check network connectivity using NetworkTestTool from a Server computer:

  1. Change to the software installation base directory for the instance to test:
  2. cd software_installation_path/Base

  3. Run the CvNetworkTestTool command (on one line):
  4. CvNetworkTestTool –Server –log location -SrvPort number [-UseIPv4 | -UseIPv6 | -UseIPAny] -BindIP IP_address -Instance instance_name

    where:

    • Server is optional for the command, but required for this server mode operation, and means you are running the network check from a server computer.
    • log is required. It supplies the location of the log file on the server.
    • SrvPort is an optional port number on the server. If not supplied, 25000 is used.
    • UseIPv4 | UseIPv6 | UseIPAny is optional, specifying the protocol to use for network communication. If not supplied, IPv4 is used.
    • BindIP is the local interface to bind to (on the server).
    • Instance is the instance name on the destination computer. If not supplied, instance001 is used.

    For example:

    CVNetworkTestTool -Server –log C:\server.log –SrvPort 25001 -UseIPv4 -BindIP 172.16.0.52 -Instance instance002

  5. The command indicates whether data successfully transferred between the server and client or vice-versa, with the given buffer size.

Client Mode

When you run CvNetworkTestTool in client mode, the client attempts to connect to a server. Once the connection is established, after the initial handshake, the client sends buffers to the server to verify data transmission. You can specify parameters such as the port and TCP/IP protocol to be used for the connection. You can also specify parameters for the data transmission, such as the buffer count and the delay between transmitting them.

The server and client modes work in conjunction.

To check the network connectivity using NetworkTestTool from a Client computer:

  1. Change to the software installation base directory for the instance to test:
  2. cd software_installation_path/Base

  3. Run the CvNetworkTestTool command (on one line):
  4. CvNetworkTestTool –Client –log location [-SrvHostName host_name | -SrvHostIP ip_address] -SrvPort port_number [-UseIPv4 | -UseIPv6 | -UseIPAny] -FirstBufferDelay delay -InterBufferDelay delay -BuffsizeClientToServer bytes -BuffsizeServerToClient bytes -BufferCount count -PortServer port_number -PortClient port_number -BindIP ip_address -Instance instance_name

    where:

    • Client tells the command it is running the network check from a client computer.
    • log supplies the location of the log file. Required.
    • SrvHostName is the hostname of the server. If you provide SrvHostIP, SrvHostName is not needed.
    • SrvHostIP is the IP address of the server. The default IP address is localhost. If you provide SrvHostName, SrvHostIP is not needed.
    • SrvPort is the port number on server. If not supplied, port number 25000 is used.
    • UseIPv4 | UseIPv6 | UseIPAny is the protocol used for network communication. If not supplied, IPv4 is used.
    • FirstBufferDelay is the number of seconds to wait before sending/receiving first buffer. Default delay is 0 seconds.
    • InterBufferDelay is the number of milliseconds to wait before sending/receiving each buffer. Default delay is 0 milliseconds.
    • BuffsizeClientToServer is the number of bytes to transmit from the client to the server. Default client-to-server buffer size is 16 KB.
    • BuffsizeServerToClient is the number of bytes to transmit from the server to the client. Default server-to-client buffer size is 16 KB.
    • BufferCount is the number of buffers of random data to send/receive to/from the server. Default buffer count is 0.
    • PortServer is the server-side port to test. Default server-side port is 25001.
    • PortClient is the client-side port to test. Default client-side port is 25002.
    • BindIP is the local interface to bind to (on the server).
    • Instance is the instance name on the destination computer. If not supplied, instance001 is used.

    For example:

    CVNetworkTestTool -Client –log C:\client.log –SrvHostName CVHost23 –SrvPort 25025 -UseIPv4 -FirstBufferDelay 5 -InterBufferDelay 1000 -BuffSizeClientToServer 15000 -BuffSizeServerToClient 5000 -BufferCount 10 -PortServer 25026 -PortClient 25027 -BindIP 172.12.0.35 -Instance instance003

  5. The command returns the result of the data transfer attempt between the client and server with the given buffer size.

ChangeNetworkPwd Tool

The ChangeNetworkPwd tool allows you to change the network password of one or more clients with a stronger password in order to increase the security of your network.

Follow the steps below to update the network password:

  1. On the CommServe computer, change to the software installation base directory for the instance to test:

    cd software_installation_path/Base

  2. Run the ChangeNetworkPwd command:

    ChangeNetworkPwd [-listAllWeak | -updateAllWeak | clientName] -vm instance_name

    where:

    • listAllWeak is the option to list all the clients that need a stronger password.
    • updateAllWeak is the option to update all the clients in the CommServe instance that need a stronger password.
    • clientName is the name of one client on which the password will be updated.
    • vm is the name of the instance where the CommServe software is running. If not specified, Instance001 is used.

    For example, this command will update the password for client1:

    ChangeNetworkPwd client1 -vm instance002

  3. The password is updated for the client.
  4. To verify the operation, change to the software_installation_path\Log Files folder and review the ChangeNetworkPwd.log file.

Firewall Connectivity Test Tool

If you are logged into a Unix platform, you can use the cvfwc_ping command. cvfwc_ping attempts to establish a connection to a remote client computer through the remote client's firewall.

  1. Change to the base installation directory:

    cd software_installation_path\Base

  2. Run the cvfwc_ping command:
  3. cvfwc_ping [-inst instance_name] [-cn client_name] [-timeout secs] remote_cname remote_host [remote_port]

    Where:

    • inst, together with cn, specifies the local context (the instance name) of the CommCell program to run. Optional. If omitted, the first available instance in the registry, or the content of GALAXY_INST variable (if set), is used.
    • cn, together with inst, specifies the local context (the client name) of the CommCell program to run. Optional. If omitted, the first available virtual client in the registry, or the content of GALAXY_CNAME variable (if set), is used.
    • timeout is the number of seconds after which the command stops trying to establish a connection with the remote computer. Optional.
    • remote_cname is the remote computer's short (or client) name. Required.
    • remote_host is the remote computer's hostname. Required.
    • remote_port gives the port to send the request to. Optional; if not specified, request is sent to port 8400.

Example:

cvfwc_ping -inst Instance001 -cn qm10v-ora1 qm10v-cs qm10v-cs.qm.lab 8402

Command return:

  • If a connection to the remote host is successful, the command returns "Successfully connected", and a return code of 0.
  • If the connection fails, the command returns an error message, and a return code of 1.