Chapter 6: Registered Procedures

This chapter describes the registered procedures that you can execute from the command line to perform the switching process, and to monitor and administer user activities. These procedures are provided in addition to the default registered procedures that are built into every Open Server.

Registered procedure	Description
rp_cancel	Cancels processing of a query by one or more clients.
rp_cfg	Causes a given configuration file to be reread while the server is running. Similar to sp_configure.
rp_debug	Turns on and off all debugging options available with the -t command line option.
rp_dump	Dumps connection state information.
rp_go	Resumes all suspended pools after a manual intervention has been requested, and performed by OpenSwitch.
rp_help	Displays every registered procedure in OpenSwitch.
rp_kill	Kills a group of OpenSwitch connections.
rp_msg	Queues a text message to be sent to one or more client connections.
rp_pool_addattrib	Adds an connection attribute name/value pair from a pool.
rp_pool_addserver	Adds a new server to the list of servers within a pool.
rp_pool_cache	Changes or displays the connection caching status for a pool.
rp_pool_create	Creates a new pool of servers.
rp_pool_drop	Drops an existing pool.
rp_pool_help	Displays detailed information about a pool.
rp_pool_remattrib	Removes a connection attribute=value pair to a pool.
rp_pool_remserver	Removes a server from the list of available servers within a pool.
rp_pool_server_status	Displays or sets the status of the server present in the pool. If you use rp_pool_server_status to set the server status for a pool, this value overrides the generic server status set using rp_server_status.
rp_pool_status	Changes the status of a pool.
rp_rcm_connect_primary	Run rp_rcm_connect_primary on a secondary OpenSwitch in a redundant RCM setup, after the primary OpenSwitch is shut down and restarted, to notify the secondary RCM to establish a connection to the primary OpenSwitch.
rp_rcm_list	Displays a list of RCMs known to this OpenSwitch.
rp_rcm_shutdown	Shuts down the specified RCM through OpenSwitch.
rp_rcm_startup	Starts an RCM using the specified path and RCM configuration file.
rp_replay	Replays SQL statements during failover.
rp_rmon	Displays the contents of all [LIMIT_RESOURCE] sections of the configuration file.
rp_server_help	Displays the name, status, HA-type, configuration storage definition, CMON user name and CMON password for the specified server.
rp_server_status	Displays or changes the status of a remote server. This is a generic server status across all pools, for pools that do not have a pool-specific server status defined.
rp_set	Changes a configuration value.
rp_set_srv	Sets server name for a connection that is requesting a server name from a coordination module.
rp_showquery	Displays query being executed by a *spid. rp_showquery* only works when OpenSwitch is not in FULL_PASSTHRU mode.
rp_shutdown	Shuts down an OpenSwitch server.
rp_start	Starts a group of connections that were previously stopped with rp_stop.
rp_stop	Stops a group of connections.
rp_switch	Switches one or more connections to another server.
rp_traceflag	Enables or disables SRV_TRACE flags for debugging messages.
rp_version	Displays OpenSwitch version number.
rp_who	Displays information about the current set of user connections. Similar to sp_who.

See Chapter 2, “Coordination Module Routines and Registered Procedures,” in the OpenSwitch Coordination Module Reference Manual for a list of registered procedures that you can issue from a coordination module.

View this book as PDF