Installing Remote API Client Software from the command line

Note: If you want to install the SDK, you must use the Setup program, as explained in Installing Remote API Client on Windows using the Setup program. You cannot install the SDK from the command line.

After you have extracted the Remote API Client installation image into a temporary directory, you can install the Remote API Client software from the command line instead of using the Setup program through Windows. At the command line, enter the setup command with one or more options. You can enter these options in uppercase or lowercase, and can precede them with a / (slash) or - (hyphen). If a parameter, such as folder, is a string that contains a space, you must enclose the string inside double quotes.

After you enter the setup command, the Setup program prompts you for any information you have not included on the command line, and displays confirmation messages at various stages of the setup. If you do not want the Setup program to prompt you, use the -accept -s option to run the program in silent mode, accepting the terms of the Software License Agreement.

Following are the setup command options:

-accept -s
Run the installation in silent mode, accepting the terms of the Software License Agreement. This agreement can be found in the license subdirectory of the Windows installation image.

The -s option must be the last one in the command line, and you must be sure you have specified the domain name (using the -i option) and any other parameters that you want to specify. When the installation runs in silent mode, it does not prompt you for any parameters or display confirmation messages. Any command-line arguments after -s are ignored.

-f2
Specify the full pathname of the installation log file that is created during silent mode installation (using the -s option).

If you do not specify this option, the file is created as setup.log in the directory from which you run the installation program. If you are installing in silent mode from the CD drive, you must specify this option to ensure that the file is created on your computer (because it cannot be created on the CD drive).

-kfolder
Specify the Program folder.
-llanguagecode
Specify the language variant of the client that you want to use. If you do not specify this option, the default is to install the English variant.

Use one of the following codes (including the leading 0x) to indicate the language you want. For example, use -l0x000c to install the French variant of the client.

  • English (default): 0x0009
  • Chinese: 0x0804
  • French: 0x000c
  • German: 0x0007
  • Japanese: 0x0011
  • Korean: 0x0012
  • Portuguese: 0x0016
  • Spanish: 0x000a
  • Taiwanese: 0x0404
-pdirectory
Specify the install directory.
-idomain
Specify a domain name for this client. This parameter is required; there is no default.
-wdirectory
Specify the source directory containing CS/AIX client software files if the source is located on a disk or CD. Otherwise, use the -v option.
-vserver
Specify the server from which the client software files are to be downloaded. You can specify either the server name or TCP/IP address. If you are copying the source files from a disk or CD, use the -w option instead of the -v option.
-userver
Specify the name of a server to be included in the list of servers this client can access, in one of the following formats:
  • If the client uses HTTPS to access its servers, specify the name of the WebSphere server that provides HTTPS support and the name of the CS/AIX server, in the following format:

    webservername : servername1

    This assumes that WebSphere is set up to use the default port 443 for HTTPS connections. If your network administrator has configured WebSphere to use a different port number, include the port number in the following format:

    webservername : portnumber : servername1

    For more details about configuring WebSphere to support HTTPS connections, refer to Configuring WebSphere Application Server.

  • If the client does not use HTTPS to access its servers, specify the name of the server it should try to contact.
  • If the client is on the same private network as its servers, you can specify that it should find a server running CS/AIX by using a UDP broadcast message to all computers on its TCP/IP subnet (or on all subnets that it can access, if the client computer contains more than one LAN adapter card). To do this, specify * (an asterisk character) instead of the first server name.

    This option is available only if the client uses IPv4 addressing. UDP broadcasts are not supported for IPv6.

    The client retries the broadcast every 10 seconds, up to the number of attempts specified by the broadcast_attempt_count parameter, until it contacts a server. If the limit specified by broadcast_attempt_count is reached before a server has been contacted, the client then tries using directed messages to one or more named servers (specified by the following lines of the file).

Note: If you are not using UDP broadcasts, you must specify the names of all servers that this client needs to access. The client can use resources on the servers that are specified in this file, but cannot use resources on other servers.
-o
Overwrite existing .DLL files. If the Remote API Client .DLL files are already present, the Setup program overwrites these files even if they have a higher version number than the Setup program .DLL files.
-y
Save existing .DLL files. If the Remote API Client .DLL files already exist in the required directories, the Setup program copies the existing .DLL files to a subdirectory of the install directory, and then installs the Remote API Client .DLL files. The copies in the subdirectory ensure that if you uninstall the Remote API Client software, the uninstall process will be complete.
-n
Cancel the installation if existing Remote API Client .DLL files are found.
-atimeout
Specify the LAN access time-out in seconds. This is the length of time the client's connection to a server can remain idle before being closed. The value 0 indicates no time-out.
-bmax-broadcast
This option is used only if the client uses UDP broadcasts: this is indicated by * (an asterisk character) instead of the first server name.

Specify the maximum number of UDP broadcast attempts. A UDP broadcast is a client's attempt to connect to any server in the domain rather than to a specific server. The value 0 indicates no broadcast attempts are made.

-jreconnect-timeout
Specify the time in seconds that the client waits before attempting to reconnect to a server after the server has gone down.

To view summary help information about these options on the screen, use the command setup -h -llanguagecode, where languagecode is the code (as described above) for the language in which you want to view the information. For example, use the command setup -h -l0x0009 to view the help information in English. You can also replace -h with -?, for example setup -? -l0x000a to view the help information in Spanish.

The following is an example command line to install the Remote API Client:

setup -imy_domain -userver1.company.com -userver2.company.com -b0 -j30 -accept -s -f2C:\instrapi.log -y

In this example:

  • The client is installed in the domain my_domain.
  • The client has access to two servers in the same private network as the client, and does not use UDP broadcasts to contact any other servers. It waits for 30 seconds before reconnecting if it loses contact with a server.
  • The installation runs in silent mode, writing its installation log information to the file C:\instrapi.log on the client.
  • Existing copies of Remote API Client .DLL files are saved to a subdirectory before the new files are installed.
  • No language option is specified, so the default (English) is used.