Name | Synopsis | Description | Options | Examples | Exit Status | See Also
create-fastcgi-handler <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--mime-type|-m type] [--uri-pattern|-t pattern] [--role|-o authorizer|responder|filter|error] [--app-path|-a path] [--app-args|-A arg1,arg2...] [--bind-path|-b path] [--min-procs|-n count] [--max-procs|-x count] [--chroot|-H directory] [--server-user|-r user-id] [--group|-g group-id] [--nice|-i value] [--listen-queue-size|-l size] [--app-env|-E 'name=value','name=value'...] [--reuse-connection|-U] [--connection-timeout|-C time-in-seconds] [--response-timeout|-T time-in-seconds] [--restart-interval|-I minutes] [--request-retry|-q retry-count] [--error-url|-L url] [--error-reason|-O string] --config|-c config-name --vs|-s vs-name
Use this command to create a FastCGI handler. FastCGI is an open extension to CGI (Common Gateway Interface), which is a standard for interfacing external applications with web servers. FastCGI applications run in separate, isolated processes. As FastCGI processes can be reused to handle multiple requests, it improves performance. FastCGI provides the ability to run applications remotely, which is useful for load distributing. FastCGI application does not crash or corrupt the core server or other applications. For more information on FastCGI, see http://www.fastcgi.com.
For connect_options description, see help(1).
Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.
If you specify this option, wadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file connect_option.
Specify this option to display a verbose output.
Specify the MIME type.
Specify the URI pattern.
Specify the role of the FastCGI Server Application Functions (SAFs). The role can be authorizer, responder, filter or error.
Note: Under a named or default object, the administration interface does not support having multiple directives for a particular role. This can be enabled by manual modification of the appropriate obj.conf file.
In the responder role, the FastCGI application receives all information associated with an HTTP request and generates a response.
In the authorizer role, the FastCGI application receives all information associated with an HTTP request and generates an authorized or unauthorized decision.
In the filter role, the FastCGI application receives all information associated with an HTTP request and additional data from a file stored on the web server, and generates a filtered version of the data stream as an HTTP response.
In the error role, the FastCGI application terminates if an error occurs. You can configure the application to display a specific page or redirect the request to a URL if an error occurs.
Specify the FastCGI application path that processes the request. The functionality is dependent on the value of the bind-path option as follows
If you specify only app-path, the plug-in creates FastCGI applications that listens to UNIX Domain Sockets created by the plug-in. This parameter, however, is accepted only on UNIX platform. On Windows, an error message is logged.
If you specify both app-path and bind-path, the plug-in starts the specified FastCGI application process and binds them to the specified bind-path.
If you specify only bind-path, the FastCGI application is considered to be running remotely. So, the plug-in will not start the FastCGI application process.
If you do not specify both app-path and bind-path, the plug-in logs an error message.
Specify the values that are passed as arguments to the FastCGI application process. You can define multiple arguments. The format to define multiple arguments is arg1,arg2....
See the app-path description. The value can be a UNIX domain socket name on the UNIX platform. On the Windows platform, bind-path must be specified as host:port. The value can also be a named pipe on both UNIX and Windows platforms.
Specify the minimum number of FastCGI application processes that can be created. The default value is 1.
Specify the maximum number of FastCGI application processes that can be created at any time. The value must be equal to or greater than the min-procs value. The default value is 1.
Specify the additional root directory that you create where the FastCGI server application runs in. The default value is the web server's root directory.
Specify the user ID of a server user. For example, root. This option is mandatory if the administration server is on UNIX. The default value is the web server's user ID.
Specify the name of the group to execute the FastCGI programs.
Specify the nice value of FastCGI server application processes. Typically, the server is run with a nice value of 0 and the nice increment would be between 0 (the FastCGI program runs at same priority as server) and 19 (the FastCGI program runs at much lower priority than server). Do not increase the priority of the FastCGI program above that of the server by specifying a nice increment of -1.
Specify the size, in bytes, of the operating system listen queue back log. The default value is 256 bytes.
Specify the name-value pairs. that are passed as environment variables to the FastCGI application process. You can define multiple environment variables. The format to define multiple arguments is "name=value","name=value"....
Specify whether the connections to the FastCGI applications are reused. The value false indicates that the connections to FastCGI applications are closed after each request and true indicates that existing connections are reused for new requests. The default value is false.
If the reuse-connection option is set to true, this value specifies the time-out value, in seconds, for the pooled connections. If a connection is idle for the specified amount period of time, then the plug-in closes the connection. The default value is 5 seconds.
Specify the FastCGI server response time-out in seconds. If there is no response from the FastCGI application within the specified period of time, the request is discarded. The default value is 5 seconds.
Specify the time interval, in minutes, after which the FastCGI application restarts. If the value for this option is 0 (zero), the FastCGI application is not forced to restart. The default value is 60 minutes.
Specify the number of times the request should be re-send when the FastCGI application rejects the request. The default value is 0 (zero).
Specify the web page, URI, or URL that FastCGI should display if an error occurs. The value of this parameter can be an absolute path, a path relative to document root, an URL, or a URI.
Specify the FastCGI protocol error. Use this option to differentiate the error URLs to be displayed in case of any plug-in errors.
Specify the name of the configuration for which you want to create the FastCGI handler.
Specify the name of the virtual server where you want to add the FastCGI handler.
wadm create-fastcgi-handler --user=admin --host=serverhost --password-file=../admin.passwd --port=8989 --ssl=true --no-prompt --rcfile=null --mime-type=magnus-internal/fastcgi --uri-pattern=/fcgi/* --role=filter --app-path=/app-path --app-args=arg1,arg2,arg3 --bind-path=localhost:1111 --min-procs=2 --max-procs=10 --chroot=/space/fastcgi --server-user=webservd --group=group1 --nice=1 --listen-queue-size=512 --app-env=name1=value1,name2=value2, --reuse-connection=true --connection-timeout=10 --response-timeout=10 --restart-interval=100 --request-retry=1 --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), delete-fastcgi-handler(1), get-fastcgi-handler-prop(1), set-fastcgi-handler-prop(1), list-fastcgi-handlers(1)
Name | Synopsis | Description | Options | Examples | Exit Status | See Also