This section describes the sybcluster interactive commands. Some commands are active before you connect to a cluster (see “Commands active before connecting to a cluster”); others are active only after you connect to a cluster (see “Commands active after connecting to a cluster”).
The sybcluster command prompt includes the current cluster and the default instance when these values have been set. The prompt is:
> – when sybcluster is not connected to a cluster.
cluster_name> – when sybcluster is connected to a cluster.
cluster_name instance_name> – when sybcluster is connected to a cluster and a default instance has been set.
These commands are active before you connect to a cluster. They are not available after you connect to a cluster.
Connect [ to cluster_name ] [ Login login_name ] [ Password [password ]] [ Agent agent_spec ] [ Discovery discovery_spec ] Create Cluster [cluster_name ] [ Login login_name ] [ Password password ] [ Agent agent_spec ] [ Discovery discovery_spec ] [ File input_file ] Deploy Plugin [ Login login_name ] [ Password password ] [ Agent agent_spec ] [ Discovery discovery_spec ] Exit Help Quit
Show agents [ login login_name ] [ password password ] [ agent “agent_spec[, agent_spec[,...]]” ] [ discovery “discovery_spec[, discovery_spec[,...]]” ] Upgrade server server_name [ login login_name ] [ password password ] [ agent agent_spec ] [ discovery discovery_spec ] [ file input_file_name ] [ checkonly ]
These commands are active only after you connect to a cluster:
Add Instance instance_name file file_name Backupserver
Create Backupserver Monitorserver Xpserver
Disconnect
Diagnose Cluster Instance instance_name Drop Backupserver Cluster Instance instance_name Monitorserver Xpserver Localize Set Cluster MaxInst max_num_instances Login [ login_name ] [ Password password ] TraceFlags trace_flag Primary Protocol protocol Secondary Protocol protocol Instance [ instance_name ] LogPath log_file_path Primary Address ip_address Port port_range_start port_range_end Secondary Address ip_address Port port_range_start port_range_end StartArgs startup_arguments BackupServer MonitorServer XPServer Port Show Cluster Config Template Log [ Errors] [ MinSeverity severity_level | [ StartDate [date_string ]] [ EndDate [date_string ]] [ Last num_of_lines ] Status Instance [instance_name] Config Log [ Errors ] [ MinSeverity severity_level ] [ StartDate [date_string ]] [ EndDate [date_string ]] [ Last num_of_lines ] Status BackupServer Config Membership mode MonitorServer Config Session XPServer Config Shutdown Cluster Instance [ instance_name ] Start Cluster Instance instance_name [ Unlock ] Use [ instance_name ] Help Add Diagnose Disconnect Drop Set Show Shutdown Start
Configures Backup Server for nodes not already configured for Backup Server.
add backupserver
Adds a Backup Server to “mycluster” on nodes “blade3” and “blade4”.
add backupserver
Finding nodes for which Backup Server is not configured... Do you want to configure Backup Server for node "blade3"? [Y] Please enter the Backup Server port number for node "blade3": 5001 Do you want to configure Backup Server for node "blade4"? [Y] Please enter the Backup Server port number for node "blade4": 50011
You can configure Backup Server for one or more nodes in the cluster.
add backupserver lets you add additional nodes when configuring for single Backup Servers. You cannot use this command to add multiple Backup Servers.
Adds one new instance to the cluster. The instance can be added interactively, with sybcluster prompting for necessary configuration information, or through an input file. add instance also creates a local system temporary database for the new instance. add instance prompts vary depending on whether configuration for the cluster is shared or private.
add instance instance_name [ file “input_file” ]
is the name of the instance.
specifies a file name that contains the configuration information for adding an instance.
add instance creates a local system temporary database for the new instance. Before executing add instance, make sure that a device with sufficient space for the local system database exists.
The input file for add instance has the same format as the cluster input file. However, the add instance input file may limit the instance definitions to the new instance in the node section.
add instance may prompt for this information:
The instance name, if you did not enter an instance name in the command statement.
The node hosting the instance
The port number of the UAF agent on the node
The query port number
The primary and secondary address of the node
The primary and secondary port specification
If you have configured single Backup Servers for the cluster, add instance asks whether Backup Server is already configured for the new instance node. If no, add instance asks if Backup Server should be configured. If yes, it prompts for the Backup Server port for the node.
If you have configured multiple Backup Servers for the cluster, add instance prompts for:
The name of the Backup Server
The Backup Server log file path
The Backup Server port for the new instance
add instance also prompts for Monitor Server and XP Server port number information for the new instance.
If the installation mode is private, add instance prompts for additional information for the new instance:
The $SYBASE home directory
The environment shell script path
The Adaptive Server home directory
The server configuration file path
The interfaces file path, if LDAP is not configured
Connects to an existing cluster.
connect [ to cluster_name ] [ login login_name ] [ password [password ]] [ agent “agent_spec [, agent_spec [,...]]” ] [ discovery “ discovery_spec [, discovery_spec [, ...]]" ]
is the name of the cluster to which you are connecting.
is the management agent login for the Sybase Common Security Infrastructure in the Unified Agent framework. The default user name after installation is “uafadmin” with no password; this is the Simple Login Module in the Agent configuration. The user name and password can be configured to use several different mechanisms for authentication and authorization, including operating system logins.
For information about Sybase Common Security, see Unified Agent and Agent Management Console Version 2.0 for Windows and UNIX.
is the management agent password for the Sybase Common Security Infrastructure in the Unified Agent framework. The default user name after installation is “uafadmin” with no password; this is the Simple Login Module in the Agent configuration. The user name and password can be configured to use several different mechanisms for authentication and authorization, including operating system logins.
is the agent specification that identifies the nodes in the cluster running a Unified Agent, and the port number that sybcluster uses to connect to the Unified Agent. The format is node_name:port_number[, node_name:port_number ][,...]. The default port number is 9999.
This is the preferred method for connecting to a cluster.
is the discovery method used to identify the agents responsible for the requested cluster. The format is method[(method_specification)][, ( method_specification )[,...]]. See Table 8-1.
Connects to “mycluster,” when “mycluster” is the default cluster specified in the sybcluster command statement.
connect
In this example, you connect to “mycluster” using the agent specification and default port numbers.
connect to mycluster agent "blade1,blade2,blade3"
A direct connection is one in which the user identifies the cluster nodes and, optionally, the port numbers for the UAF agents. Sample agent specifications are:
myhost – identifies the host node and assumes the default listening port of 9999.
myhost.mydomain.com – includes the host domain name.
myhost:9999 – identifies the host node and listening port number.
Creates a Backup Server for the cluster, or, if the cluster has been configured for multiple Backup Servers, creates a Backup Server for each instance in the cluster.
create backupserver
Creates the Backup Server “mycluster_BS” for “mycluster”:
create backupserver
Do you want to create multiple Backup Servers? [Y] N Enter the Backup Server name: [mycluster_BS] Enter the Backup Server log file path: [$SYBASE/ASE-15_0/ install/mycluster_BS.log] Do you want to create a Backup Server for node "blade1"? [Y] Enter the Backup Server port number for node "blade1": The Backup Server "mycluster_BS" was successfully defined.
Creates multiple Backup Servers for “mycluster” running on “ase1” on “blade1” and “ase2” on “blade2.”
create backupserver
Do you want to create multiple Backup Servers? [Y] Y The "dump/load" commands would be routed to appropriate Backup Server based on following policies: 1. Dedicated - Each instance associated with exactly one Backup Server. 2. Round Robin - Choose the Backup Server with least number of requests in round robin fashion starting from global cluster level counter. Enter the number corresponding to the policy to be used: [1] 1 Enter the Backup Server name for instance ase1: [ase1_BS] Enter Backup Server log file path: [/remote/var/sybase/install/ase1_BS_log] Enter the Backup Server port for node "blade1": 23001 Enter the Backup Server name for instance ase2: [ase2_BS] Enter Backup Server log file path: [/remote/var/sybase/install/ase2_BS_log] Enter the Backup Server port for node "blade2": 23002 Backup Servers successfully defined.
create backupserver prompts for the Backup Server listening port on each node. It copies other necessary configuration information from the cluster configuration file. create backupserver:
Creates directory service entries for Backup Server on each node.
Creates the Backup Server configuration and log files, and the RUN_<backup_server> script.
Adds the Backup Server name to the cluster’s sysservers table.
Enables Backup Server HA.
Creates an Adaptive Server shared-disk cluster. Enter the necessary configuration information interactively, as responses to a series of prompts, or use an input file.
create cluster [cluster_name ] [ login login_name ] [ password password ] [ agent “agent_spec [, agent_spec [, ...]]” ] [ discovery “ discovery_spec [, discovery_spec [, ...]]” ] [ file “input_file” ]
is the name of the cluster.
is the management agent login for the Sybase Common Security Infrastructure in the Unified Agent framework. The default user name after installation is “uafadmin” with no password; this is the simple login module in the agent configuration. You can configure the user name and password to use several different mechanisms for authentication and authorization, including operating system logins.
is the management agent password for the Sybase Common Security Infrastructure in the Unified Agent framework. The default user name after installation is “uafadmin” with no password; this is the Simple Login Module in the Agent configuration. You can configure the user name and password to use several different mechanisms for authentication and authorization, including operating system logins.
is the agent specification that identifies the nodes in the cluster running a Unified Agent, and the port number that sybcluster uses to connect to the Unified Agent. The format is node_name:port_number [, node_name:port_number ] [,...]. The default port number is “9999.”
is the discovery method used to identify the agents responsible for the requested cluster. The format is method[(method_specification)] [, ( method_specification ) [,...]]. See Table 8-1.
is the operating system input file for creating the cluster.
Creates a new cluster called “mycluster”; sybcluster prompts you for the information necessary to create the cluster.
create cluster mycluster
Creates a new cluster called “mycluster1” using configuration information supplied in the mycluster1.xml file.
create cluster mycluster1 file mycluster1.xml
When you create a cluster, sybcluster prompts for the:
Cluster name, if one has not been provided
Number of instances
Installation mode for the cluster (private or shared)
Complete path to the master, quorum, PCI, systemdb, sybsysprocs, and temporary database devices
Path to the interfaces file, if LDAP is not configured and this is a shared install
Trace flags (optional)
Complete path to the dataserver configuration file, if this is a shared install
Primary and secondary interconnection protocols
Instance host name, port number, private address, log file location, and start-up arguments.
If this is a private install, sybcluster also prompts for the $SYBASE installation directory, Adaptive Server home directory, dataserver configuration file location, and interfaces file location (if LDAP is not configured).
If sybcluster detects the Veritas Cluster Server (VCS) on the system, sybcluster asks if it should check whether device is managed by VCS.
After you create and confirm the cluster, create cluster prompts for an I/O fencing check, which checks whether or not each device has I/O fencing capability (see the Installation Guide for a description of I/O fencing).
Creates a Monitor Server for each instance in the cluster.
You must run the installmon isql script, located in $SYBASE.$SYBASE_ASE/scripts, before running Monitor Server.
create monitorserver
Creates a Monitor Server for each instance in “mycluster”.
create monitorserver
Enter the Monitor Server log file location for instance "ase1".[$SYBASE/ ASE-15_0/ install/mycluster_MS1.log] Enter the Monitor Server port number for instance "ase1": Enter the Monitor Server log file location for instance "ase2".[$SYBASE/ ASE-15_0/ install/mycluster_MS2.log] Enter the Monitor Server port number for instance "ase2": Enter the Monitor Server log file location for instance "ase3".[$SYBASE/ ASE-15_0/ install/mycluster_MS3.log] Enter the Monitor Server port number for instance "ase3": Enter a username: sa Enter a password: WARN — mycluster:AseCfg:411:The SQL script "INSTALLMON" must be run before the Monitor Server can be run. The Monitor Server has been successfully configured.
create monitorserver prompts for the listening port number for each instance in the cluster, and a user name and password.
Creates an XP Server for each instance in the cluster.
create xpserver
Creates an XP Server for each instance in “mycluster”.
create xpserver
Enter the XP Server port number for instance "ase1": Enter the XP Server port number for instance "ase2": Enter the XP Server port number for instance "ase3": The XP Server was successfully defined for each instance.
create xpserver prompts for the XP Server listening port for each node in the cluster. Other information necessary to create the XP Server is read from the cluster configuration file.
Adds the configuration information for a single instance of the cluster to the Unified Agent. Can be used to configure the Unified Agent to manage a cluster if you created the cluster without using the Adaptive Server plug-in or sybcluster utility, or if you need to recreate the Unified Agent configuration for a cluster. The configuration of a cluster instance is performed by deploying a Unified Agent plug-in.
deploy plugin [ login login_name ] [ password password ] [ agent agent_spec ] [ discovery discovery_spec ]
is the management agent login for the Sybase Common Security Infrastructure in the Unified Agent framework. The default user name after installation is “uafadmin” with no password; this is the Simple Login Module in the Agent configuration. The user name and password can be configured to use several different mechanisms for authentication and authorization, including operating system logins.
is the management agent password for the Sybase Common Security Infrastructure in the Unified Agent framework. The default user name after installation is “uafadmin” with no password; this is the Simple Login Module in the Agent configuration. The user name and password can be configured to use several different mechanisms for authentication and authorization, including operating system logins.
is the agent specification that identifies the nodes in the cluster running a Unified Agent, and the port number that sybcluster uses to connect to the Unified Agent. The format is “node_name:port_number [, node_name:port_number ] [,...]]”. The default port number is “9999”.
is the discovery method used to identify the agents responsible for the requested cluster. The format is “method[(method_specification)] [, ( method_specification ) [,...]]”. See Table 8-1 for more information about discovery methods.
Deploys the plug-in using the uaf agent on host “system1501”.
deploy plugin agent system1501
sybcluster prompts for the cluster name, cluster node number, installation mode, full path to the quorum device, the environment shell script path, and the Adaptive Server home directory.
Deploys the plug-in and uses discovery to identify the agent:
deploy plugin discovery udp
After you execute deploy plugin, sybcluster prompts you for the:
Path to the quorum device.
Path to the Sybase home directory.
Installation mode (private or shared). The default is shared.
The location of your Sybase environment script. This must be a shell script that can be loaded using the “.file_name” syntax such as “sh” or “bash”. An example is SYBASE.sh.
The location of your Adaptive Server software directory. The default is <sybase_home_directory>/ASE-15_0. When entering the location of the Adaptive Server software directory, include the full path. Do not use $SYBASE.
The dataserver login and password are configured using the login command, which updates all Adaptive Server plug-ins managing the cluster.
Performs a set of checks to ensure that the cluster is working correctly.
diagnose cluster
Checks that “mycluster” is working correctly.
diagnose cluster
Cluster name...................mycluster Maximum instances..............4 Cluster node count.............1 Instances defined..............4 Is cluster locked..............Yes JDBC connection available......1 ase1 Yes JDBC connection available......2 ase2 Yes JDBC connection available......3 ase3 Yes JDBC connection available......4 ase4 Yes Instance Public Network........1 ase1 on blade1 (10.22.79.39) Reachable: Yes Instance Public Network........2 ase2 on blade1 (10.22.79.39) Reachable: Yes Instance Public Network........3 ase3 on blade1 (10.22.79.39) Reachable: Yes Instance Public Network........4 ase4 on blade1 (10.22.79.39) Reachable: Yes Has private Primary network.... No Has private Secondary network.. No Network ports required/instance 20 Minimum port allowed........... 1025 Maximum port allowed............65535 Current port strategy........... Public primary and secondary unique. ...The ports are sequenced primary followed by the next instance primary. ...When the primaries are are completed the secondary ports follow the same pattern. Recommended port strategy....... Public primary and secondary unique. ...The ports are sequenced primary followed by the next instance primary. ...When the primaries are are completed the secondary ports follow the same pattern.
diagnose cluster checks that:
A Unified Agent is running on each instance in the cluster.
The number of instances in the cluster does not exceed the value set for maximum number of instances.
The quorum file exists.
All instances are defined in the interfaces file and that port numbers do not conflict.
The primary and secondary protocol specifications do not overlap.
Each of the $SYBASE directories are shared.
Performs a set of checks to ensure that the instance is configured correctly.
diagnose instance [instance_name]
is the name of an instance. If no instance name is entered, sybcluster uses the default value.
Displays and verifies configuration information for “ase1” on “mycluster”.
diagnose instance ase1
Cluster name ................. mycluster Instance id .................. 1 Instance name ................ ase1 Node name .................... blade1 Query port ................... 7101 JDBC connection available .... Yes Instance Public Network ....... 1 ase1 on blade1 (10.33.108.139) Reachable:.....Yes Minimum port allowed.......... 1025 Maximum port allowed .......... 65535 Instance port range ........... 1 Primary ase1 17100 to 17115 (16) Okay Instance port range ........... 1 Secondary ase1 17165 to 17180 (16) Okay
Use diagnose cluster to ensure the cluster is configured correctly.
Closes all connections to the current cluster and returns sybcluster to an unconnected state.
disconnect
Use connect to reconnect to an existing cluster.
Drops Backup Server from a node or from the cluster. If the cluster has been configured for multiple Backup Servers, drops all Backup Servers.
drop backupserver
Drops a single Backup Server.
drop backupserver
Do you want to drop the Backup Server from: 1. Selected nodes 2. Cluster Enter choice: 1 Do you want to drop Backup Server from node "blade1"? [N] y Do you want to drop Backup Server from node "blade2"? [N] The Backup Server has been dropped from selected nodes.
Drops the Backup Server from the cluster.
drop backupserver
Do you want to drop the Backup Server from: 1. Selected nodes 2. Cluster Enter choice: 2 Are you sure you want to drop Backup Server mycluster_BS from cluster mycluster? (Y or N): [N] y The Backup Server has been dropped.
Drops all Backup Servers when multiple Backup Servers have been configured for the cluster:
drop backupserver
Multiple Backup Server are defined for the cluster. This command will drop all of them. Are you sure you want to continue? (Y/N): [N] y The Backup Server has been dropped.
Use drop backupserver to drop a Backup Server from the cluster.
Removes each instance from a cluster and then removes the cluster definition from the cluster configuration file. Also, removes regular files associated with the cluster and the cluster agent plug-ins that manage the cluster. The cluster must be Down to use drop cluster.
drop cluster
Drops all instances from the current cluster and deletes the cluster.
drop cluster
sybcluster prompts for confirmation before dropping the cluster.
drop cluster:
Removes cluster and instance entries from the interfaces file, configuration files, and specified data devices.
Marks the quorum device as unused.
Shuts down and removes the cluster’s UAF agent plug-ins.
Due to certain file system locking, the UAF plug-ins may not be deleted after you use drop cluster. Verify that the $SYBASE_UA/nodes/*/plugins/<cluster_name> directory has been deleted. If the directory still exists, delete it.
Removes an instance from the cluster configuration file and updates the Unified Agent Framework (UAF) and discovery services. Also, notifies the cluster that an instance is to be dropped, and removes the instance and interfaces file entries.
drop instance [ instance_name ]
identifies an instance in a cluster. If an instance name is not specified, sybcluster uses the default specified in the sybcluster command line.
Removes the “ase3” instance from the current cluster.
drop instance ase3
Before you use drop instance:
Start at least one instance in the cluster other than the instance to be dropped.
Shut down the instance to be dropped.
Manually remove instance-specific information. drop instance automatically removes the local system temporary database.
sybcluster prompts for confirmation before removing the instance.
You cannot drop the last instance in the cluster. You must use drop cluster.
drop instance removes references to the instance in the interfaces file, the instance entry in the quorum device, and notifies the cluster that the instance has been dropped.
drop instance removes entries for multiple and single Backup Servers if they were configured for the instance you are dropping.
drop instance drops Monitor Server, XP Server, and single or multiple Backup Server if they have been configured for that instance.
Drops the Monitor Server for every instance in the cluster.
drop monitorserver
Drops all Monitor Servers defined for “mycluster”.
drop monitorserver
Are you sure you want to drop the Monitor Server configurations from the cluster mycluster? (Y or N): [N] y The Monitor Servers have been dropped for all instances.
Use drop monitorserver to drop a Monitor Server from the cluster.
Drops the XP Server for each instance in the cluster.
drop xpserver
Drops the XP Servers for “mycluster”.
drop xpserver
Are you sure you want to drop the XP Servers from cluster mycluster"? {Y or N): [N] y The XP Servers have been dropped for all instances.
Use drop xpserver to drop an XP Server from the cluster.
Exits the sybcluster utility.
exit
exit and quit perform the same task: they exit the sybcluster utility.
If some agents have been shut down while connected to sybcluster, error messages describing the connections may display. You can ignore these messages.
Lists the currently available sybcluster interactive commands.
help
The list of currently available interactive commands changes depending on whether or not sybcluster is connected to a cluster.
Displays the current values for default language, charset, and sort order. Allows modification of default values, and addition or removal of languages.
localize
This example displays default localization values, and then prompts for changes. The default character set changes to Chinese, the default charset to eucgb, and the default sort order to bin_eucgb.
localize
Current default locale properties are: Default Language - portuguese Default Charset - mac Default SortOrder - Binary ordering, for use with the Macintosh charcter set(mac). Options for default Language are: 1. spanish 2. portuguese 3. german 4. us_english 5. thai 6. french 7. japanese 8. chinese 9. korean 10. polish Enter the number representing the language to be set as defaults: [2] 8 Options for default charsets are: 1. gb18030 2. eucgb 3. uttf8 Enter the number representing the charset to be set as default: [1] 2 Options for sort orders are: 1. Binary ordering, for the EUC GB2312-80 character set (eucgb). Enter the number representing the sort order to be set as default [1] Do you want to install any language? [Y] n Do you want to remove any language? [N ] The cluster mycluster was successfully localized with default language chinese, charset eucgb, sortorder bin_eucgb
The current default localization value displays after each prompt. To accept the current value, enter a carriage return instead of a number.
The options for default languages include all languages present in $SYBASE_ASE. If the selected default language is not configured, use localize to configure it or remove it.
To ensure that new values are consistent for all instances in the cluster, restart the cluster after changing localization values.
Exits the sybcluster utility.
quit
exit and quit both exit the sybcluster utility.
Changes the listening port number for Backup Server on specified nodes in a cluster.
set backupserver
Changes the listening port number for Backup Server on “blade1” of “mycluster”.
set backupserver
Backup Server is configured on the following nodes: 1. blade1: 3001 2. blade2: 3002 3. blade3: 3003 Do you want to change the Backup Server port on any node? {Y} Enter the number representing the node whose port you want to change: 1 Enter the Backup Server port number for node "blade1":4001 Backup Server was successfully modified as per new properties.
When “mycluster” has been configured for multiple Backup Servers, changes the listening port number for one or more Backup Servers.
set backupserver
Multiple Backup Servers are configured for the cluster. Their configuration is as follows: Backup Server Policy: Dedicated 1. Backup Server name: ase1_BS Configured for blade1:23001 Log file location: /remote/sybase/ASE-15_0/install/ase1_BS.log 2. Backup Server name: ase2_BS Configured for blade2:23002 Log file location: /remote/sybase/ASE-15_0/install/ase2_BS.log 3. Backup Server name: ase3_BS Configured for blade3:23003 Log file location: /remote/sybase/ASE-15_0/install/ase3_BS.log Do you want to edit any Backup Server (y/n)? [Y] Enter the number representing the Backup Server you want to edit: [1] Enter the new port for Backup Server "ase1_BS":24001 Do you want to edit any more Backup Servers? [N] Backup Server "ase1_BS" successfully updated.
When you set a new listening port number, Adaptive Server first checks to see if that port number is already in use.
Changes configuration values for the cluster. The cluster must be down to execute all set cluster commands except set cluster login.
set cluster { maxinst max_num_instances | traceflags trace_flag[, trace_flag[,...]] | { primary | secondary } protocol udp | login login_name [ password password ] }
specifies the maximum number of instances that can run in the cluster.
specifies trace flags to be set when the cluster starts.
specifies a user name and password that the Unified Agent uses to log in to the cluster and perform shutdown and certain other tasks. This login must have sa_role. By default, the Unified Agent uses the “sa” login with no password. To change this password, use set cluster login. See the Clusters Users Guide.
set cluster login can only be used to change the login or password that the Unified Agent uses to log in to the cluster. To change the login or password sybcluster uses to log in to the Unified Agent, use the Agent Management Console Sybase Central plug-in.
sets the protocol for the private network for the primary or secondary interface.
Changes the maximum number of instances to 4 for “mycluster”.
set cluster maxinst 4
Adds the trace flag 15506.
set cluster traceflags 15506
Changes the password for the “sa” user name.
set cluster login sa password abcde
To check that the cluster is Down, enter show cluster status.
Sets properties of the instance. The instance must be Down.
set instance instance_name logpath path
set instance instance_name startargs values
set instance instance_name {primary | secondary} port port_range
set instance instance_name {primary | secondary} address ip_address
specifies the path for the instance log file.
specifies an instance.
specifies arguments for starting the instance.
specifies the primary or secondary IP address for the instance.
specifies the primary or secondary port range for the instance. The format for port_range is : start_num end_num.
Changes the port range for the primary interface listening port.
set instance primary port 7777
To check that the instance is Down, enter show cluster status.
Changes the Monitor Server listening port numbers for specified instances in the cluster.
set monitorserver
Changes the Monitor Server listening port number for instance “ase2” on “blade2” of “mycluster” without changing the listening port numbers for other instances in the cluster.
set monitorserver
Enter the Monitor Server Port number for instance "blade1": [5001] <CR> Enter the Monitor Server port number for instance "blade2": [5002] 5011 Enter the Monitor Server port number for instance "blade3": [5003] <CR>
set monitorserver prompts you to change the listening port number for each Monitor Server configured in the cluster. You can accept the current value, provided in square brackets, or enter a new port number.
You can change the Monitor Server listening port number for one or more instances.
Changes the listening port number for XP Server on specified nodes of the cluster.
set xpserver port
Changes the listening port for the XP Server for instance “ase1” on “blade1” of “mycluster” without changing the listening ports for “ase2” and “ase3”.
set xpserver port
Enter the XP Server port number for instance "ase1" [3002]: 4002 Enter the XP Server port number for instance "ase2" [3002]: <CR> Enter the XP Server port number for instance "ase3" [3002]: <CR>
You can change the XP Server listening port number on one or more instances.
Displays information about available UAF agents.
Show agents [ login login_name ] [ password password ] [ agent “agent_spec[, agent_spec[,...]]” ] [ discovery “discovery_spec[, discovery_spec[,...]]” ]
is the management agent login for the Sybase Common Security Infrastructure in the Unified Agent framework. The default user name after installation is “uafadmin” with no password; this is the Simple Login Module in the Agent configuration. The user name and password can be configured to use several different mechanisms for authentication and authorization, including operating system logins.
is the management agent password for the Sybase Common Security Infrastructure in the Unified Agent framework. The default user name after installation is “uafadmin” with no password; this is the Simple Login Module in the Agent configuration. The user name and password can be configured to use several different mechanisms for authentication and authorization, including operating system logins.
is the agent specification that identifies the nodes in the cluster running a Unified Agent, and the port number that sybcluster uses to connect to the Unified Agent. The format is “node_name:port_number [, node_name:port_number ] [,...]]”. The default port number is “9999.”
is the discovery method used to identify the agents responsible for the requested cluster. The format is “method[(method_specification)] [, ( method_specification ) [,...]]”. See Table 8-1 for more information about discovery methods.
Displays UAF agent information:
show agents
Agent Information: service:jmx:rmi:///jndi/rmi://blade1:9985/agent ----------------------------------------------------- Node Name: blade1 Agent Port: 9985 Agent Version: 2.5.0 Agent Build: 977 OS Name: Linux OS Version: 2.6.9-42.ELsmp OS Architecture: amd64 Agent Service Info: Agent Service (Agent) Build: 977 Status: running BootstrapService (BootstrapService) Build: <unavailable> Status: running Configuration Service (ConfigService) Build: 977 Status: running Deployment Service (DeploymentService) Build: <unavailable> Status: running Environment Service (EnvironmentDiscoveryService) Build: 977 Status: running File Transfer Service (FileTransferService) Build: 977 Status: running Plugin Registration Service (PluginRegisterService) Build: 977 Status: running RMI Service (RMIService) Build: 977 Status: running Remote Shell Service (RemoteShellService) Build: 977 Status: running Security Service (SecurityService) Build: 977 Status: running Self Discovery Service (SelfDiscoveryService) Build: 977 Status: running Service Registration Service (ServiceRegistrationService) Build: 977 Status: running Session Service (SessionService) Build: 977 Status: running Sybase Home Service (SybaseHomeService) Build: 14 Status: running Agent Plugin Info: ASE Cluster Agent Plugin (com.sybase.ase.cluster) Version: 15.1.0 Build: 85 Instance: 1 Status: running Cluster Name: marion Env Shell: /job1/miso/betaR1/SYBASE.sh Shell Type: sh Sybase Home: /job1/miso/betaR1 ASE Home: /job1/miso/betaR1/ASE-15_0 ASE Version: Adaptive Server Enterprise/15.0.1/EBF 14721 Cluster Edition/B/x86_64/Enterprise Linux/asecluster3/2360/64-bit/FBO/Fri Jul 20 10:04:16 2007 ASE Login: sa Update Time: 60 seconds Last Update: 2007-09-28 22:09:02 -0700
show agents is active before you connect to a cluster.
Displays the nodes on which Backup Server is configured, the associated listening port numbers, and the Backup Server policy.
show backupserver config
Displays configuration information for “mycluster”, which has been configured for multiple Backup Servers.
show backupserver config
Multiple Backup Servers are configured for cluster. Their configuration is as follows: Backup Server policy: Dedicated 1. Backup Server for ase1: ase1_BS Configured on (host:port) - blade1:23001 2. Backup Server for ase2: ase2_BS Configured on (host:port) - blade2:23002 3. Backup Server for ase3: ase3_BS Configured on (host:port) - blade3:23003
Use the show backupserver config command to display Backup Server configuration information.
If you are configuring multiple Backup Servers, show backupserver config includes the Backup Server policy.
Displays configuration, log, and status information about the cluster.
Show Cluster Config Template Log [Errors] [MinSeverity severity_level] [StartDate [date_string]] [EndDate [date_string]] [Last number_of_lines] Status
displays status information for the cluster. Values are:
Up
Down
Undefined
Invalid
Start
Init
Quiesce
displays logs from all instances in the cluster.
display log file entries for errors. Optionally, limit displayed error entries to a severity level and above.
Error severities_level is an attribute of Adaptive Server error messages, not sybcluster messages.
display log file entries that occur on and after the date specified. The format for date_string is: mm:dd:yy.
If you do not specify a startdate or enddate date_string, the default is the current date (today).
display log file entries that occur on or before the date specified.
Limits the number of lines displayed, counting backward from the last line in the log files.
displays configuration information for the cluster:
Maximum number of instances
Installation mode: shared or private
Primary and secondary protocols
Trace flags set
Location and name of the quorum device
LDAP information, if LDAP is configured
Location and name of the master device
displays formatted configuration information for the cluster.
Displays current configuration and other information about the default cluster.
show cluster status
Id Name Node State Heartbeat ----------------------------------------- 1 ase1 blade1 Up Yes 2 ase2 blade2 Up Yes 3 ase3 blade3 Down No
Displays configuration information (including LDAP, if it is configured) for the default cluster configured for shared installation mode.
show cluster config
**Cluster configuration for "mycluster" ** Installation Mode shared Interfaces Path "/work2/sybase/ASE-15_0/" Trace Flags: 15556 Maximum Instances "4" Quorum "/dev/raw/raw101" Master Device "/dev/raw/raw102" logfile ase1 /work2/sybase/ASE-15_0/install/ ase1.log run_parameters ase1 null logfile ase2 /work2/sybase/ASE-15_0/install/ ase2.log run_parameters ase2 null Primary Interconnect "udp" Server[1]ase1 tigger.sybase.com 26016 26031 Server[2]ase2 christopher.sybase.com 26032 26047 Secondary Interconnect "udp" Server[1]ase1 tigger.sybase.com 26081 26096 Server[2]ase2 christopher.sybase.com 26097 26112
Displays configuration information for the default cluster configured for private installation mode.
show cluster config
**Cluster configuration for "localcluster" ** Installation Mode "private" Trace Flags: There are no trace flags Maximum Instances "4" Quorum "/dev/raw/raw101" Master Device "/dev/raw/raw102" logfile ase1 /remote/work2/sybase/ASE-15_0/install/ase1.log run_parameters ase1 null logfile ase2 /work2/sybase/ASE-15_0/install/ase2.log run_parameters ase2 null Primary Interconnect "udp" Server[1]ase1 tigger.sybase.com 26016 26031 Server[2]ase2 christopher.sybase.com 26032 26047 Secondary Interconnect "udp" Server[1]ase1 tigger.sybase.com 26081 26096 Server[2]ase2 christopher.sybase.com 26097 26112 LDAP server blade1 2250
show cluster status displays the results of a show instance command on each instance in the cluster.
Displays information about an instance.
show instance [instance_name ] { config | status | log [ [ errors ] minseverity severity_level ] | [ startdate [ date_string ]] | [enddate [ date_string ]] | [ last num_lines ] ] }
specifies a unique name for an instance in the cluster.
displays status information for the instance. Values are:
Up
Down
Undefined
Invalid
Start
Init
Quiesce
displays the instance log.
displays log file entries for errors. Optionally, limit displayed error entries to a severity level and above.
Error severities_level is an attribute of Adaptive Server error messages, not sybcluster messages.
displays log file entries that occur on and after the date specified. The format for date_string is: mm:dd:yy.
If a startdate or enddate date_string is not specified, date_string defaults to the current day.
displays log file entries that occur on or before the date specified. The format is: mm:dd:yy.
Limits the number of lines displayed, counting backwards from the last line in the log file.
Displays information about “ase1.”
show instance ase1 status
Id Name State ------------------------ 1 ase1 Down
Displays configuration information for “ase1.”
show instance ase1 config
Instance: ase1 at blade6:25001 Private Primary Network Address: blade1 Port Range: 2541 - 2556 Sybase home: /sybase/sybase_sdc ASE home: /sybase/sybase_sdc/ASE-15_0 Config file: /sybase/sybase_sdc/ase1.cfg Private Secondary Network Address: blade1 Port Range: 2557 - 2572 Log Path: /blade1/sybase/ ASE-15_0/install/mycluster_ase1.log
show instance status displays one of seven different states for the named instance:
Down
Init
Invalid
Quiesce
Start
Undefined
Up
show instance config includes this information when the installation mode is private:
The $SYBASE path
The ASE path
The server configuration file path
Displays the cluster’s current membership mode. Membership mode specifies whether or not Veritas Cluster Integration is supported on the current cluster.
show membership mode
Values for show membership mode are:
vcs – VCS is supported for the current cluster.
native – VCS is not supported for the current cluster.
If the cluster is running in vcs membership mode, make sure you shut down or start up servers and the cluster using VCS shutdown and start-up mechanisms.
Displays the Monitor Server name, listening port number, node name, and instance name.
show monitorserver config
Use the sybcluster show monitorserver config command to show Monitor Server information.
Displays current discovery and agent information.
show session
Displays agent status information.
show session
Session information ------------------Sybase sybcluster Command Line Utility/15.0.1/CE GA 2/S/jdk1.4.2/sybclustermain/129/Mon Aug 13 09:59:51 PDT 2007Connected Cluster: myclusterDefault Cluster: Default Instance: Agent Specifications: [1]: oddjob:7171 Discovery Specifications: Agent Connections: 1 Connection[1] URL: rmi://oddjob:7171 Node Name: oddjob1 Agent Port: 7171 Agent Version: 2.5.0 Agent Build: 980 OS Name: Linux OS Version: 2.6.9-42.ELsmp OS Architecture: amd64 Agent Service Info: Agent Service (Agent) Build:980 Status:running BootstrapService (BootstrapService) Build: <unavailable> Status: running Configuration Service (ConfigService) Build: 980 Status: running Deployment Service (DeploymentService) Build: 19 Status: running Environment Service(EnvironmentDiscoveryService) Build: 980 Status: running File Transfer Service (FileTransferService) Build: 980 Status: running Plugin Registration Service (PluginRegisterService) Build:980 Status: running RMI Service (RMIService) Build: 980 Status: running Remote Shell Service (RemoteShellService) Build: 980 Status: running Security Service (SecurityService) Build: 980 Status: running Self Discovery Service (SelfDiscoveryService) Build: 980 Status: running Service Registration Service (ServiceRegistrationService) Build: 980 Status: running Session Service (SessionService) Build: 980 Status: running Sybase Home Service (SybaseHomeService) Build: 14 Status: running Agent Plugin Info: ASE Cluster Agent Plugin(com.sybase.ase.cluster) Version: 15.0.1 Build: 129 Instance: 1 Status: running Cluster Name: mycluster Env Shell: /oddjob1/work2/ sybase_sybclustermain_mycluster_vu/SYBASE.sh Shell Type: sh Sybase Home: /oddjob1/ work2/sybase_sybclustermain_mycluster_vu ASE Home: /oddjob1/work2/ sybase_sybclustermain_mycluster_vu/ASE-15_0 ASE Version: Adaptive Server Enterprise/ 15.0.1/EBF 14721 Cluster Edition/B/x86_64/ Enterprise Linux/asecluster3/2381/64-bit/ FBO/Mon Nov 12 07:44:23 2007 ASE Login: sa Update time: 300 seconds Last Update: 2007-11-13 15:27:39 -0800
Use the sybcluster show session command to view information about the current cluster.
Displays the XP Server name and listening port number, node name, and instance name configured on each node.
show xpserver
Displays the XP Server name, listening port number, node name, and instance name.
show xpserver config
**XP Server configuration for the cluster** ___________________________________________________ XPServer Name Port Host Node ___________________________________________________ ase1_XP 4010 blade1 ase1 ase2_XP 4011 blade2 ase2 ase3_XP 4012 blade3 ase3
Use the sybcluster show xpserver command to view information about XP Server.
Shuts down the cluster by executing a Transact-SQL shutdown command for each instance in the cluster’s instance list, in the order specified in the cluster configuration file.
shutdown cluster [ nowait ]
shuts down the cluster immediately, without waiting for transactions or statements currently executing to conclude. By default, sybcluster waits for all transactions and statements to execute before shutting down the cluster.
Shuts down the current cluster.
shutdown cluster
INFO - ... INFO - 01:00:00000:00117:2007/06/02 00:23:53.56 kernel ueshutdown: exiting INFO - 01:00:00000:00117:2007/06/02 00:23:53.56 kernel SySAM: Checked in license for 1 ASE_CORE (2007.1031/31-oct-2007/1293 6876 8FE7 E217).
sybcluster prompts for confirmation before shutting down the cluster.
If the cluster is managed by VCS, shutdown cluster fails. You must use VCS shut down mechanisms to shut down the cluster.
Shuts down the instance by executing a Transact-SQL shutdown command.
shutdown instance [ instance_name ] [ nowait ]
is the unique name of an instance in the cluster.
shuts down the instance immediately, without waiting for currently executing transactions or statements to finish.
Shuts down the instance “ase1,” after waiting for currently executing transactions or statements to finish.
shutdown instance ase1
INFO - 01:00:00000:00113:2007/06/02 00:31:24/14 kernel shutdown server ase1 INFO - 01:00:00000:00113:2007/06/02 00:31:24/14 Server SHUTDOWN by request. INFO - 01:00:00000:00113:2007/06/02 00:31:24/14 ASE is terminating this process INFO - 01:00:00000:00113:2007/06/02 00:31:24/14 shut down local cluster server. INFO - 01:00:00000:00113:2007/06/02 00:31:24/14 kernel coordinator to be shutdown, newcoo is 0. INFO - 01:00:00000:00113:2007/06/02 00:31:24/14 kernel Single server cluster. INFO - 01:00:00000:00113:2007/06/02 00:31:24/14 kernel cipcnode_down(): Node 1 down event. INFO - 01:00:00000:00113:2007/06/02 00:31:24/14 server ASE shutdown by request. INFO - 01:00:00000:00113:2007/06/02 00:31:24/14 kernel ueshutdown: exiting INFO - 01:00:00000:00113:2007/06/02 00:31:24/14 kernel SySAM: Checked in license for 1 ASE_CORE (2007.1031.31-oct-2007/1293 6876 8FE7 E 217).
Shutting down the last instance in a cluster also shuts down the cluster.
sybcluster prompts for confirmation before shutting down the instance.
If the cluster is managed by VCS, shutdown instance fails. You must use VCS shut down mechanisms to shut down the instance.
Starts all instances in the cluster.
start cluster
Starts the current cluster.
start cluster
INFO - [cluster boot log] ... INFO - 02:00:00000:00002:2007/06/02 00:21:53.56 server ’ase1’ (ID=1). INFO - 02:00:00000:00002:2007/06/02 00:21:53.56 server Master device size: 80 megabytes, or 40960 virtual pages.
You must connect to the cluster before starting it.
Starts an instance.
start instance [ instance_name ] [ unlock ]
specifies a unique name for an instance in the cluster. If you do not enter a cluster name, sybcluster uses the instance specified in the sybcluster command line or specified with the use command.
removes the lock from a cluster that has been terminated unexpectedly. The cluster must be Down before using unlock.
WARNING! Do not use the unlock parameter unless you have verified that all instances in the cluster are shutdown.
The instance must be Down to use start instance unlock.
Upgrades a non-clustered Adaptive Server to the Adaptive Server Cluster Edition, and creates a cluster with a single instance. You can perform the upgrade by answering prompts at the command line or via an input file.
You can upgrade from Adaptive Server version 12.5 and later to the Cluster Edition.
upgrade server server_name [ login login_name ] [ password password ] [ agent agent_spec ] [ discovery discovery_spec ] [ file input_file_name ] [ checkonly ]
is the name of the non-clustered Adaptive Server.
is the management agent login for the Sybase Common Security Infrastructure in the Unified Agent framework. The default user name after installation is “uafadmin” with no password; this is the Simple Login Module in the Agent configuration. The user name and password can be configured to use several different mechanisms for authentication and authorization, including operating system logins.
is the management agent password for the Sybase Common Security Infrastructure in the Unified Agent framework. The default user name after installation is “uafadmin” with no password; this is the Simple Login Module in the Agent configuration. The user name and password can be configured to use several different mechanisms for authentication and authorization, including operating system logins.
is the agent specification that identifies the node in the cluster running a Unified Agent, and the port number that sybcluster uses to connect the Unified Agent. When upgrading a non-clustered Adaptive Server, there is only one node. The format for agent_spec is “node_name:port_number”. The default port number is “9999.”
is the discovery method used to identify the agents responsible for the requested cluster. The format is “method[(method_specification)] ”. See Table 8-1 for more information about discovery methods.
is the input file containing values required for upgrading the server.
performs a check run of the non-clustered Adaptive Server to determine its readiness for upgrade.
Example Upgrades “myserver” to the Cluster Edition:
upgrade server
Enter the name of the cluster: new_cluster Enter the existing Sybase installation directory for server myserver: Enter the name of the subdirectory containing the ASE installation for server myserver: Enter the name of the subdirectory containing the OCS installation for server myserver: Enter the name of an sa login on server exit: [sa] Enter a password: Cluster new_cluster - Enter the maximum number of instances: [4] Verifying the supplied agent specifications... 1>tigger 9999 2.5.0 Linux Enter the number representing the cluster node 1 [1] Will this cluster be configured using private SYBASE installations? (Y/N) ...
The information required to upgrade a server or create a cluster are the same. See “create cluster” or the installation guide for your platform.
upgrade server prompts for these values:
The Sybase installation directory of the non-clustered Adaptive Server
The release home directory of the non-clustered Adaptive Server
The Open Client home directory of the non-clustered Adaptive Server
The installation mode, private or shared
If sybcluster detects a VCS subsystem, asks if you want to include VCS integration with the cluster
If you have not configured LDAP, the path to the interfaces file
The name of the first instance in the cluster
Other values as required to create a cluster
Use of the checkonly option does not perform any upgrade steps; it does check the server’s readiness for upgrade. Any error conditions found by checkonly must be resolved before actually performing the upgrade.
Specifies the default instance.
use instance_name
use overrides the instance name specified in the sybcluster command line.