Sun and OracleChannel SunHow to BuyLog InEspañol

Sun Java System Application Server 9.1 Reference Manual
  Buscar sólo este libro
Buscar Ayuda
Contained Within
Find More Documentation
Featured Support Resources
 Descargar este libro en PDF (2394 KB)

create-http-lb(1)

NAME | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also

NAME

    create-http-lb – creates a load balancer

Synopsis

    create-http-lb 
[--terse={true|false}][ --echo={true|false} ] 
[ --interactive={true|false} ] [ --host  host] 
[--port port] [--secure| -s ] [ --user  admin_user]
[--passwordfile filename] [--help]
 --devicehost  device_host_or_IP_address --deviceport device_port 
[--autoapplyenabled=false] [--sslproxyhost proxy_host] 
[--sslproxyport proxy_port] [--target target] [--lbpolicy lbpolicy] [--lbpolicymodule lb_policy_module] [--healthcheckerurl url]
[--healthcheckerinterval 10] [--healthcheckertimeout 10]
[--lbenableallinstances=true] [--lbenableallapplications=true] [--lbweight instance=weight[:instance=weight]*] [--responsetimeout 60] [--httpsrouting=false] [--reloadinterval60][--monitor=false][--routecookie=true] 
[--property (name=value)[:name=value]*
] load_balancer_name

Description

    Note –

    This command is available only in domains that are configured to support clusters, such as domains that are created with the cluster profile or the enterprise profile. For information about profiles, see Usage Profiles in Sun Java System Application Server 9.1 Administration Guide.

    Use the create-http-lb command to create a load balancer, including the load balancer configuration, target reference, and health checker. A load balancer is a representation of the actual load balancer device, defined by its device host and port information. Once you've created the load balancer, you can automatically apply changes made to the load balancer configuration without running export-http-lb-config and manually copying the generated load balancer configuration file to the web server instance. Set autoapplyenabled to true to automatically apply changes.

Options

    -t --terse

    Indicates that any output data must be very concise, typically avoiding human-friendly sentences and favoring well-formatted data for consumption by a script. Default is false.

    -e --echo

    Setting to true will echo the command line statement on the standard output. Default is false.

    -I --interactive

    If set to true (default), only the required password options are prompted.

    -H --host

    The machine name where the domain administration server is running. The default value is localhost.

    -p --port

    The HTTP/S port for administration. This is the port to which you should point your browser in order to manage the domain. For example, http://localhost:4848.

    The default port number is 4848.

    -s --secure

    If set to true, uses SSL/TLS to communicate with the domain administration server.

    -u --user

    The authorized domain administration server administrative username.

    If you have authenticated to a domain using the asadmin login command, then you need not specify the --user option on subsequent operations to this particular domain.

    --passwordfile

    The --passwordfile option specifies the name, including the full path, of a file containing the password entries in a specific format. The entry for the password must have the AS_ADMIN_ prefix followed by the password name in uppercase letters.

    For example, to specify the domain administration server password, use an entry with the following format: AS_ADMIN_PASSWORD=password, where password is the actual administrator password. Other passwords that can be specified include AS_ADMIN_MAPPEDPASSWORD, AS_ADMIN_USERPASSWORD, and AS_ADMIN_ALIASPASSWORD.

    All remote commands must specify the admin password to authenticate to the domain administration server, either through --passwordfile or asadmin login, or interactively on the command prompt. The asadmin login command can be used only to specify the admin password. For other passwords, that must be specified for remote commands, use the --passwordfile or enter them at the command prompt.

    If you have authenticated to a domain using the asadmin login command, then you need not specify the admin password through the --passwordfile option on subsequent operations to this particular domain. However, this is applicable only to AS_ADMIN_PASSWORD option. You will still need to provide the other passwords, for example, AS_ADMIN_USERPASSWORD, as and when required by individual commands, such as update-file-user.

    For security reasons, passwords specified as an environment variable will not be read by asadmin.

    The default value for AS_ADMIN_MASTERPASSWORD is changeit.

    --help

    Displays the help text for the command.

    --devicehost

    The device host or the IP address of the load balancing device. This host or IP is where the physical load balancer will reside.

    --deviceport

    The port used to communicate with the load balancing device. It must be SSL enabled.

    --autoapplyenabled

    If set to true, changes to the load balancer configuration are automatically pushed to the physical load balancer. If set to false, the changes won't be automatically applied. Use the command apply-http-lb-changes to apply the changes manually. The default is false.

    --sslproxyhost

    The proxy host used for outbound HTTP.

    --sslproxyport

    The proxy port used for outbound HTTP.

    --target

    Specifies the target to which the load balancer applies.

    Valid values are:

    • cluster_name, which specifies that requests for this cluster will be handled by the load balancer.

    • stand-alone_instance_name, which specifies that requests for this stand-alone instance will be handled by the load balancer.

    --lbpolicy

    The policy the load balancer follows to distribute load to the server instances in a cluster. Valid values are round-robin, weighted-round-robin, and user-defined. If you choose user-defined, specify a load balancer policy module with the lbpolicymodule option. If you choose weighted-round-robin, assign weights to the server instances using the configure-lb-weight command. The default is round-robin.

    --lbpolicymodule

    If your target is a cluster and the load balancer policy is user-defined, use this option to specify the full path and name of the shared library of your load balancing policy module. The shared library needs to be in a location accessible by the web server.

    --healthcheckerurl

    The URL to ping to determine whether the instance is healthy.

    --healthcheckerinterval

    The interval in seconds the health checker waits between checks of an unhealthy instance to see whether it has become healthy. The default value is 10 seconds. A value of 0 disables the health checker.

    --healthcheckertimeout

    The interval in seconds the health checker waits to receive a response from an instance. If the health checker has not received a response in this interval, the instance is considered unhealthy. The default value is 10 seconds.

    --lbenableallinstances

    Enables all instances in the target cluster for load balancing. If the target is a server instance, enables that instance for load balancing.

    --lbenableallapplications

    Enables all applications deployed to the target cluster or instance for load balancing.

    --lbweight

    The name of the instance and the weight you are assigning it. The weight must be an integer. The pairs of instances and weights are separated by colons. For example instance1=1:instance2=4 means that for every five requests, one goes to instance1 and four go to instance2. A weight of 1 is the default.

    --responsetimeout

    The time in seconds within which a server instance must return a response. If no response is received within the time period, the server is considered unhealthy. If set to a positive number, and the request is idempotent, the request is retried. If the request is not idempotent, an error page is returned. If set to 0 no timeout is used. The default is 60.

    --httpsrouting

    If set to true, HTTPS requests to the load balancer result in HTTPS requests to the server instance. If set to false, HTTPS requests to the load balancer result in HTTP requests to the server instance. The default is false.

    --reloadinterval

    The time, in seconds, that the load balancer takes to check for an updated configuration. When detected, the configuration file is reloaded. The default value is 60 seconds. A value of 0 disables reloading.

    --monitor

    If set to true, monitoring of the load balancer is switched on. The default value is false.

    --routecookie

    This option is deprecated. The value is always true.

    --property

    Optional attribute name/value pairs for configuring the load balancer.

Operands

    lb_name

    The name of the new load balancer. This name must not conflict with any other load balancers in the domain.

Examples

    Example 1 Using the create-http-lb command


    asadmin> create-http-lb --user admin --passwordfile password.txt 
--autoapplyenabled=true --devicehost host1 --deviceport 5555 
mylb
Command create-http-lb executed successfully.

Exit Status

    0

    command executed successfully

    1

    error in executing the command

See Also

Java EE 5  Last Revised 13 Jul 2007

NAME | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also