Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
get-fastcgi-handler-prop <connect_options> [--echo|-e] [--no-prompt|-Q] [--verbose|-v] [--mime-type|-m type] [--uri-pattern|-t pattern] [--role|-o authorizer|responder|filter|error] --config|-c name --vs|-s name (propertyname)*
Use this command to view the FastCGI handler properties. The properties that you can view are as follows:
role — Indicates the role of the FastCGI Server Application Functions (SAFs). The role can be authorizer, responder, filter or error.
mime-type — Indicates the MIME type of FastCGI handler.
app-path — Indicates the FastCGI application path that processes the request.
bind-path — Indicates the name of the UNIX domain socket 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
app-args — The name-value pairs that are passed as arguments to the FastCGI application process.
app-env — The environment variables of the FastCGI application process.
max-procs — The maximum number of FastCGI application processes that can be created. The default value is 1.
min-procs — The minimum number of FastCGI application processes that can be created. The default value is 1.
listen-queue-size — Indicates the size, in bytes, of the operating system listen queue back log. The default value is 256 bytes.
connection-timeout — Applicable if the reuse-connection option is set to true. Indicates the time-out value, in seconds, for the pooled connections. If a connection is idle for the specified amount period of time, then the connection is closed. The default value is 5 seconds.
reuse-connection — Indicates 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.
response-timeout — Indicate 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.
request-retry — Indicates the number of times the request should be re-send when the FastCGI application rejects the request. The default value is 0 (zero).
restart-interval — 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.
chroot — (UNIX only). The additional root directory that you create where the FastCGI server application runs in. The default value is the web server's root directory. This property is displayed only if the value of the role option is authorizer, responder, or filter. .
server-user — (UNIX only). Indicates the user ID of a server user, for example, root. The default value is the web server's user ID. This property is displayed only if the value of the role option is authorizer, responder, or filter.
nice — (UNIX only). 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. This property is displayed only if the value of the role option is authorizer, responder, or filter.
group — (UNIX only). Indicates the name of the group that execute the FastCGI programs. This property is displayed only if the value of the role option is authorizer, responder, or filter.
error-url — The web page, URI, or URL that FastCGI should display if an error occurs. The value of this parameter is an absolute path, a path relative to document root, an URL, or a URI. This property is displayed only if the value of the role option is error.
error-reason — Indicates any FastCGI protocol error. This property is displayed only if the value of the role option is error.
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 of the FastCGI handler.
Specify the URI pattern.
Specify the role of the FastCGI Server Application Functions (SAFs). The role can be authorizer, responder, filter or error.
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 name of the configuration.
Specify the name of the virtual server.
wadm get-fastcgi-handler-prop --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 --config=config1 --vs=vs |
The following exit values are returned:
command executed successfully
error in executing the command
help(1), create-fastcgi-handler(1), delete-fastcgi-handler(1), set-fastcgi-handler-prop(1), list-fastcgi-handlers(1)
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also