Difference: APPXLoginManagerForUnixLinux (9 vs. 10)

Revision 102007-07-24 - SteveFrizzell

 			 META TOPICPARENT 
			 name="APPXConnectionManager" 
		
 APPX Connection Manager For Unix/Linux 
This page describes how to install the APPX Connection Manager command and how to use it to install, configure, and manage APPX Connection Services on Unix/Linux systems.
- META TOPICPARENT
+ name="APPXConnectionManager"
 -rwsrwxr-x 1 root root    636843 Jul 11 07:31 appxdsvc
-<
<
+ Creating an APPX Connection Service
->
>
+ Creating and Configuring an APPX Connection Service
 On Unix/Linux systems, an instance of the APPX Connection Service is initially created, configured, and started by running the "appxdsvc" command with the -install option. At least one instance of the APPX Connection Service must be created, configured, and started before an APPX Client can initiate an APPX session. You may create, configure, and start as many different instances of the APPX Connection Service as you desire. However, each concurrently running instance must be configured to listen for connection requests on a different TCP/IP port. 
 Initial Configuration 
The -install option of the appxdsvc command is used to initially create, configure, and start an instance of the APPX Connection Service.  The following steps are performed:
-<
<
+ The configuration files are created(ini and env)
  The O/S service is created,
->
>
+ The APPX Connection Service configuration files are created(ini and env)
  The O/S service is created
  The service is started
 

Before clients can connect to an APPX system, at least one instance of the APPX Connection Service must be configured and started. 
 Configuration Changes
->
>
+Two methods are available for modifying an existing instance of the APPX Connection Service. 

 Method 1 - appxdsvc command 

The -modify option of the appxdsvc command is used to replace a previously configured instance of the APPX Connection Service. This option replaces the existing APPX Connection Service configuration files (ini and env) with two new files configured as specified. 
 Method 2 - Text Editor 

Instead of using the -modify option of the appxdsvc command, you may also change a previously configured instance of the APPX Connection Service by directly editing the APPX Connection Service configuration files with the text editor of your choice. The configuration files include comments to help you make the desired changes. 
 Managing an APPX Connection Service 
Two methods are available for managing an existing instance of the APPX Connection Service. 

 Method 1 - appxdsvc command
-<
<
+ Managing APPX Connection Services 
 Managing With the appxdsvc Command 
 Managing As an O/S Service
->
>
+The appxdsvc command can be used to manage an instance of the APPX Connection Service. The appxdsvc command can be used to start, stop, restart, or display the status of an instance of an APPX Connection Service. 
 Method 2 - O/S Services 

Your operating system includes commands or programs that can be used to manage services. APPX Connection Services can be managed with these tools. The actual commands and programs vary depending on your operating system.
  Usage (appxdsvc)
-<
<
+NAME
appxdsvc
-<
<
+SYNOPSIS (Configuration)
appxdsvc -install -port=PORT [options]... [VARIABLE=VALUE]...
appxdsvc -modify -serviceName=SERVICENAME [options]... [VARIABLE=VALUE]...
appxdsvc -remove {SERVICENAME | -serviceName=SERVICENAME}

SYNOPSIS (Management)
appxdsvc [-start | -stop | -restart | -status] {SERVICENAME | -serviceName=SERVICENAME}

DESCRIPTION
appxdsvc is used to configure and manage instances of the APPX Connection Service.

To create a log monitor process, include --serviceType=logmonitor on the command-line
The optional -AM argument determines the authentication method
  Acceptable values are 'OS-User', 'Appx-User', and 'HT-User(filename)'
  With 'Appx-User' authentication, passwords are validated against
  the Appx user file
  With 'OS-User' authentication, passwords are validated by Windows
  With 'HT-User(filename)' authentication, passwords are validated against
  the named file (which you can maintain the Apache's htpasswd utility
  If you choose 'Appx-User' authentication, you do not need a separate OS user
  account for each Appx user
The -displayName is optional - if you don't supply a display name
we will append the port number to the end of the service name and
use that as the display name. (The display name appears in the
Services control panel)

OPTIONS (Configuration)
   -install [options]... [VARIABLE=VALUE]...
      Configure and start a new Connection Manager service.  The options which follow are used in conjunction with the -install option:

   -remove -servicename=SERVICENAME

   -modify

      -port=PORT
         [Required] Configure the service to listen for connection requests on the specified TCP/IP PORT number.  This option is required with the -install option.  You may choose any TCP/IP PORT number that is not reserved or already being used on your system.

      -name=SERVICENAME
         [Optional] The specified SERVICENAME wiil be the name assigned to the Connection Manager service script that is created and to the related configuration files.  The configuration file will have a file extension of "ini".  If this option is omitted, the default SERVICENAME will be "appxd" followed by a "-" and the specified port number, e.g "appxd-8060".

      VARIABLE=VALUE
         [Optional] You can include a space-separated list of environment variables at the end of the command line when you use the -install option.  These environment variables will be saved in the .env file that is created and will be given to the environment of the appx sessions that are started by the Connection Manager.

OPTIONS (Management)
   -start | <blank>
      Start an instance of the Connection Manager service using the configuration information in the SERVICENAME.ini and the SERVICENAME.env files.

   -stop
      Stop the instance of the Connection Manager service that was started with the SERVICENAME.ini file.

   -restart
      Restart (stop and then start) the instance of the Connection Manager that was started with the SERVICENAME.ini file.

   -status
      Report the status of the instance of the Connection Manager that was started with the SERVICENAME.ini file.

EXAMPLES
Configure and start a new instance of the Connection Manager that will listen for connection requests on port 8060:

   uappd -install -port=8060
         Warning - the engine that you named has the setuid bit enabled,
                   you may not want that bit set for the authentication
                   method that you have chosen (OS-User)
                    To turn off the setuid bit, chmod u-s ../appx
         Configuration written to:  appxd-8060.ini
         Environment written to:    appxd-8060.env
         Service script written to: /etc/rc.d/init.d/appxd-8060
->
>
+NAME appxdsvc
-<
<
+   uappxd -install -port=8060 -name=appx8060 -displayName="Appx-Production(8060)" -engine=/usr/local/appx/appx APPXPATH=c:\appx\data APPX_KEYMAP=WINDOWS
->
>
+SYNOPSIS (Configuration) 
 appxdsvc -install -port=PORT [options]... [VARIABLE=VALUE]...
-<
<
+Display the status of an instance of the Connection Manager:
->
>
+appxdsvc -modify -serviceName=SERVICENAME [options]... [VARIABLE=VALUE]...
-<
<
+   uappxd -status appx8060
->
>
+appxdsvc -remove {SERVICENAME | -serviceName=SERVICENAME}
-<
<
+Shutdown a running instance of the Connection Manager:
->
>
+SYNOPSIS (Management) 
 appxdsvc [-start | -stop | -restart | -status] {SERVICENAME | -serviceName=SERVICENAME}
-<
<
+   uappxd -stop appx8060
->
>
+DESCRIPTION 
The appxdsvc command is used to configure and manage instances of the APPX Connection Service.
-<
<
+Start a previously configured instance of the Connection Manager:
->
>
+OPTIONS (Configuration) 
 -install -port=PORT [options]... [VARIABLE=VALUE]... 
Configure and start a new Connection Service.
-<
<
+   uappxd -start appx8060
->
>
+-modify -name=SERVICENAME [options]... [VARIABLE=VALUE]... 
Replace an existing Connection Service with a new Connection Service. 

-remove -servicename=SERVICENAME 
Remove an existing Connection Service.

options 
 -port, -SockPort [Required with -install option] 
Configure the service to listen for connection requests on the specified TCP/IP PORT number. This option is required with the -install option. You may choose any TCP/IP PORT number that is not reserved or already being used on your system. 

-name, -ServiceName [Optional] 
The specified SERVICENAME wiil be the name assigned to the Connection Manager service script that is created and to the related configuration files. The configuration file will have a file extension of "ini". If this option is omitted, the default SERVICENAME will be "appxd" followed by a "-" and the specified port number, e.g "appxd-8060". 

-displayName, -DisplayName [Optional] 
If you don't supply a display name we will append the port number to the end of the service name and use that as the display name. (The display name appears in the Services control panel) 

-engine, -AppxExecutable 

-AM, -AuthenticationMethod [Optional] 
Acceptable values are 'OS-User', 'Appx-User', and 'HT-User(filename)'. With 'Appx-User' authentication, passwords are validated against the Appx user file With 'OS-User' authentication, passwords are validated by the operating system. With 'HT-User(filename)' authentication, passwords are validated against the named file (which you can maintain the Apache's htpasswd utility. If you choose 'Appx-User' authentication, you do not need a separate OS user account for each Appx user. 

-serviceType, -ServiceType [Optional] 
The only valid value when configuring a Connection Service is "Login". 

-initScript 

VARIABLE=VALUE [Optional] 
You can include a space-separated list of environment variables at the end of the command line when you use the -install option. These environment variables will be saved in the env file that is created and will be given to the environment of the appx sessions that are started by the Connection Manager. 

OPTIONS (Management) 
 -start | < blank > 
Start an instance of the Connection Manager service using the configuration information in the SERVICENAME.ini and the SERVICENAME.env files. 

-stop 
Stop the instance of the Connection Manager service that was started with the SERVICENAME.ini file. 

-restart 
Restart (stop and then start) the instance of the Connection Manager that was started with the SERVICENAME.ini file. 

-status 
Report the status of the instance of the Connection Manager that was started with the SERVICENAME.ini file. 

EXAMPLES 

Example 1: Configure and start a new instance of the Connection Service that will listen for connection requests on port 8060: 

appxdsvc -install -port=8060
Warning - the engine that you named has the setuid bit enabled
you may not want that bit set for the authentication method that you have chosen (OS-User)
To turn off the setuid bit, chmod u-s
../appx Configuration written to: appxd-8060.ini
Environment written to: appxd-8060.env
Service script written to: /etc/rc.d/init.d/appxd-8060
appxdsvc -install -port=8060 -name=appx8060 -displayName="Appx-Production(8060)" -engine=/usr/local/appx/appx APPXPATH=c:\appx\data APPX_KEYMAP=WINDOWS 

Display the status of an instance of the Connection Service: 

appxdsvc -status appx8060 

Shutdown a running instance of the Connection Service: 

appxdsvc -stop appx8060 

Start a previously configured instance of the Connection Service: 

appxdsvc -start appx8060
-<
<
+uappxd -install -serviceName=name -displayName=name -port=port -engine=path -AM=method
  Example ini File 
# Appx connection manager configuration file

View topic | History: r68 < r67 < r66 < r65 | More topic actions...