Sun and OracleChannel SunHow to BuyLog InEnglish

Sun Java System Application Server 9.1 Reference Manual
  Search only this book
Search Help
Contained Within
Find More Documentation
Featured Support Resources
 Download this book in PDF (2394 KB)

configure-ha-cluster(1)

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

NAME

    configure-ha-cluster – configures an existing cluster to be highly available

Synopsis

    configure-ha-cluster 
[--terse={true|false}][ --echo={true|false} ] 
[ --interactive={true|false} ] [ --host  host] 
[--port port] [--secure| -s ] [ --user  admin_user]
[--passwordfile filename] [--help]
[ --devicesize  devicesize] [--haagentport port_number] 
[--haadminpassword password] 
[--haadminpasswordfile file_name] 
--hosts hadb-host-list [--autohadb={true|false}] 
[ --portbase  port_number] 
[--property (name=value)[:name-value]*]
{clusterName}

Description

    Note –

    This command requires the HADB software. 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.

    The configure-ha-cluster command performs the following tasks:

    • Verifies that the cluster exists.

    • Verifies that the cluster is standalone (an example of this is, that the cluster doesn't share its configuration with any other cluster).

    • Checks if a database with the same name as the cluster already exists. If so, an error is logged and the command performs the next task.

    • Creates an HA database with the same name as the cluster.

    • Creates the correct tables in the database.

    • Creates and/or modifies the appropriate resources in domain.xml.

    This command is supported in remote mode only.

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.

    --devicesize

    This is the device size in MegaBytes (MB). The valid range is between 208MB and 8+ gigabytes (GB).

    --haagentport

    This is the number of the HA agent port. The default is 1862.

    --haadminpassword

    This is the HA administrator's password.

    --haadminpasswordfile

    The file containing the high-availability password associated with the administrative instance. The password is defined in the following form: HADBM_ADMINPASSWORD=password, HADBM_DBPASSWORD=password, HADBM_SYSTEMPASSWORD=password. Where password is the actual HA administrator password for the domain.

    --hosts

    This is a list of comma separated host names where the HADB instance is configured. The number of hosts must be greater than 1 and must be an even number. The same host names can be repeated. Use fully qualified hostnames when specifying the hostlist interfaces explicitly for hosts with multiple network interfaces.

    --autohadb

    If set to true, the HADB database associated with the cluster is automatically started, stopped, or deleted if you start, stop, or delete the cluster. The default is false. To override this setting, use the hadboverride option in start-cluster, stop-cluster, or delete-cluster.

    --portbase

    The starting port number for the HADB server. Default is 15000. Valid values are between 10000 and 63000.

    --property

    This is a list of property name/value pairs, which are separated by a colon.

    The readable configuration attributes are as follows:

    Variable 

    Range 

    Default 

    ConnectionTrace 

    true/false 

    false 

    CoreFile 

    true/false 

    false 

    DatabaseName 

    		 

    hadb 

    DataBufferPoolSize 

    16–2047 

    200 MB 

    DataDeviceSize 

    32–262144 

    1024 MB 

    DevicePath 

    n/a 

    n/a 

    EagerSessionThreshold 

    0–100 

    50 (% of NumberOfSessions) 

    Eager SessionTimeout 

    0–2147483647 

    120 seconds 

    EventBufferSize 

    0–2097152 

    0 MB 

    HistoryPath 

    n/a 

    n/a 

    InternalLogBufferSize 

    4–128 

    12 MB 

    JdbcUrl 

    n/a 

    n/a 

    LogBufferSize 

    4–2047 

    48 MB 

    MaxTables 

    100–1100 

    1100 

    NumberOfDataDevices 

    1–8 

    1 

    NumberOfLocks 

    20000–1073741824 

    50000 

    NumberOfSessions 

    1–10000 

    100 

    PackageName 

    n/a 

    V4.x.x.x 

    PortBase 

    10000–63000 

    15000 

    RelalgDeviceSize 

    32–262144 

    128 MB 

    SQLTraceMode 

    none/short/full 

    none 

    SessionTimeout 

    0–2147483647 

    1800 seconds 

    StartRepairDelay 

    0–100000 

    20 seconds 

    StatInterval 

    0–600 

    600 seconds 

    SyslogFacility 

    <facility> 

    local0 

    SyslogLevel 

    <level> 

    warning 

    SyslogPrefix 

    <string> 

    hadb-<db_name> 

    TakeoverTime 

    500–16000 

    10000 MS 

Operands

    clusterName

    This is the name of the cluster that will be changed to high availability.

Examples

    Example 1 Using the configure-ha-cluster command

    This is a basic example of how the command is used.


    asadmin> configure-ha-cluster --user admin --passwordfile passwordfile 
--hosts red.iplanet.com.host1,red.iplanet.com.host2 cluster1
Command configure-ha-cluster executed successfully

Exit Status

    0

    command executed successfully

    1

    error in executing the command

See Also

Java EE 5  Last Revised 24 Jul 2007

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