Home
Administering
In addition to administering the database server, you can tune performance, replicate data, and archive data.
System administration
These topics contain concepts, procedures, and reference information for database and database server administrators to use for managing and tuning HCL Informix® database servers.
Administrator's Reference
The Informix® Administrator's Reference includes comprehensive descriptions of HCL Informix configuration parameters, the system-monitoring interface (SMI) tables in the sysmaster database, the syntax of database server utilities such as onmode and onstat, logical-log records, disk structures, event alarms, and unnumbered error messages.
SQL Administration API
SQL Administration API Functions
These topics describe the SQL administration API admin() and task() functions.
onmode and p arguments: Add or remove virtual processors (SQL administration API)
Use the onmode and p arguments with the admin() or task() function to dynamically add or remove virtual processors for the current database server session. This function does not update the onconfig file.

Administering
In addition to administering the database server, you can tune performance, replicate data, and archive data.
- System administration
  These topics contain concepts, procedures, and reference information for database and database server administrators to use for managing and tuning HCL Informix® database servers.
  - List of utilities
    HCL Informix® includes utilities and applications that you can use to perform administrative tasks and capture information about configuration and performance.
  - Administrator's Guide
    The Informix® Administrator's Guide provides the information required to administer HCL Informix.
  - Administrator's Reference
    The Informix® Administrator's Reference includes comprehensive descriptions of HCL Informix configuration parameters, the system-monitoring interface (SMI) tables in the sysmaster database, the syntax of database server utilities such as onmode and onstat, logical-log records, disk structures, event alarms, and unnumbered error messages.
    - Configuring and monitoring Informix®
    - Administrative Utilities
    - SQL Administration API
      - SQL Administration API Functions
        These topics describe the SQL administration API admin() and task() functions.
        SQL Administration API Overview
        Use the SQL administration API to remotely administer Informix® through SQL statements.
        SQL administration API portal: Arguments by privilege groups
        You can view a list of admin() and task() function arguments, which are sorted by privilege groups, with links to information about the arguments.
        add bufferpool argument: Add a buffer pool (SQL administration API)
        Use the add bufferpool argument with the admin() or task() function to create a buffer pool.
        add chunk argument: Add a new chunk (SQL administration API)
        Use the add chunk argument with the admin() or task() function to add a chunk to a dbspace or blobspace.
        add log argument: Add a new logical log (SQL administration API)
        Use the add log argument with the admin() or task() function to add a logical log to a dbspace.
        add memory argument: Increase shared memory (SQL administration API)
        Use the add memory argument with the admin() or task() function to add to the virtual portion of shared memory.
        add mirror argument: Add a mirror chunk (SQL administration API)
        Use the add mirror argument with the admin() or task() function to add a mirror chunk to a dbspace.
        alter chunk argument: Change chunk status to online or offline (SQL administration API)
        Use the alter chunk argument with the admin() or task() function to bring a chunk online or take a chunk offline in a dbspace, blobspace, or sbspace.
        alter logmode argument: Change the database logging mode (SQL administration API)
        Use the alter logmode argument with the admin() or task() function to change the database logging mode to ANSI, buffered, non-logging, or unbuffered.
        alter plog argument: Change the physical log (SQL administration API)
        Use the alter plog argument with the admin() or task() function to change the location and size of the physical log.
        archive fake argument: Perform an unrecorded backup (SQL administration API)
        Use the archive fake argument with the admin() or task() function to perform a backup operation to clone the data in a server without creating a persistent backup that could be used to perform a restore.
        autolocate database add argument: Add a dbspace to the dbspace list (SQL administration API)
        Use the autolocate database add argument with the admin() or task() function to add a dbspace to the list of available dbspaces for the automatic location and fragmentation of tables for the specified database.
        autolocate database anywhere argument: Add all dbspaces to the dbspace list (SQL administration API)
        Use the autolocate database anywhere argument with the admin() or task() function to specify that the database server can use any non-critical dbspace for the automatic location and fragmentation of tables for the specified database.
        autolocate database argument: Specify dbspaces for automatic location and fragmentation (SQL administration API)
        Use the autolocate database argument with the admin() or task() function to specify the list of available dbspaces for the automatic location and fragmentation of tables for the specified database.
        autolocate database off argument: Disable automatic fragmentation for a database (SQL administration API)
        Use the autolocate database off argument with the admin() or task() function to disable the automatic location and fragmentation of tables for a specified database.
        autolocate database remove argument: Remove a dbspace from the dbspace list (SQL administration API)
        Use the autolocate database remove argument with the admin() or task() function to remove a dbspace from the list of available dbspaces into which the database server can automatically locate and fragment tables for the specified database.
        cdr argument: Administer Enterprise Replication (SQL administration API)
        Use the cdr argument with the admin() or task() function to administer Enterprise Replication.
        cdr add trustedhost argument: Add trusted hosts (SQL administration API)
        Use the cdr add trustedhost argument with the admin() or task() function to add trusted-host relationships for database servers in a high-availability cluster or Enterprise Replication domain. For a database to participate in a high-availability cluster or Enterprise Replication domain, its host must be listed in the trusted-host files of the other high-availability or replication servers.
        cdr autoconfig serv argument: Autoconfigure connectivity and replication (SQL administration API)
        The cdr autoconfig serv argument with the admin() or task() function can autoconfigure connectivity for servers in a high-availability cluster or Enterprise Replication domain, and can autoconfigure replication.
        cdr list trustedhost argument: List trusted hosts (SQL administration API)
        Use the cdr list trustedhost argument with the admin() or task() function to list trusted-host information from the file that is specified by the database server's REMOTE_SERVER_CFG configuration parameter.
        cdr remove trustedhost argument: Remove trusted hosts (SQL administration API)
        Use the cdr remove trustedhost argument with the admin() or task() function to remove entries from a database server's trusted-host file.
        check data argument: Check data consistency (SQL administration API)
        Use the check data argument with the admin() or task() function to check or repair all pages in the specified partition for consistency.
        check extents argument: Check extent consistency (SQL administration API)
        Use the check extents argument with the admin() or task() function to verify that the extents on disk correspond to the current control information.
        check partition argument: Check partition consistency (SQL administration API)
        Use the check partition argument with the admin() or task() function to print tblspace information for a table or fragment.
        checkpoint argument: Force a checkpoint (SQL administration API)
        Use the checkpoint argument with the admin() or task() function to force a checkpoint.
        clean sbspace argument: Release unreferenced smart large objects (SQL administration API)
        Use the clean sbspace argument with the admin() or task() function to release any unreferenced BLOB or CLOB objects from the sbspace.
        create blobspace argument: Create a blobspace (SQL administration API)
        Use the create blobspace argument with the admin() or task() function to create a blobspace.
        create blobspace from storagepool argument: Create a blobspace from the storage pool (SQL administration API)
        Use the create blobspace from storagepool argument with the admin() or task() function to create a blobspace from an entry from the storage pool.
        create chunk argument: Create a chunk (SQL administration API)
        Use the create chunk argument with the admin() or task() function to create a chunk in a dbspace or in a blobspace.
        create chunk from storagepool argument: Create a chunk from the storage pool (SQL administration API)
        Use the create chunk from storagepool argument with the admin() or task() function to manually create a chunk from an entry in the storage pool.
        create database argument: Create a database (SQL administration API)
        Use the create database argument with the admin() or task() function to create a database.
        create dbaccessdemo argument: Create the demonstration database (SQL administration API)
        Use the create dbaccessdemo argument with the admin() or task() function to create the stores_demo demonstration database.
        create dbspace argument: Create a dbspace (SQL administration API)
        Use the create dbspace argument with the admin() or task() function to create a dbspace.
        create dbspace from storagepool argument: Create a dbspace from the storage pool (SQL administration API)
        Use the create dbspace from storagepool argument with the admin() or task() function to create a permanent dbspace from an entry in the storage pool.
        create plogspace: Create a plogspace (SQL administration API)
        Use the create plogspace argument with the admin() or task() function to create a plogspace in which to store the physical log.
        create sbspace argument: Create an sbspace (SQL administration API)
        Use the create sbspace argument with the admin() or task() function to create an sbspace.
        create sbspace from storagepool argument: Create an sbspace from the storage pool (SQL administration API)
        Use the create sbspace from storagepool argument with the admin() or task() function to create an sbspace from an entry from the storage pool.
        create sbspace with accesstime argument: Create an sbspace that tracks access time (SQL administration API)
        Use the create sbspace with accesstime argument with the admin() or task() function to create an sbspace that tracks the time of access for all smart large objects stored in the sbspace.
        create sbspace with log argument: Create an sbspace with transaction logging (SQL administration API)
        Use the create sbspace with log argument with the admin() or task() function to create an sbspace with transaction logging turned on.
        create tempdbspace argument: Create a temporary dbspace (SQL administration API)
        Use the create tempdbspace argument with the admin() or task() function to create a temporary dbspace.
        create tempdbspace from storagepool argument: Create a temporary dbspace from the storage pool (SQL administration API)
        Use the create tempdbspace from storagepool argument with the admin() or task() function to create a temporary dbspace from an entry from the storage pool.
        create tempsbspace argument: Create a temporary sbspace (SQL administration API)
        Use the create sbspace argument with the admin() or task() function to create an sbspace.
        create tempsbspace from storagepool argument: Create a temporary sbspace from the storage pool (SQL administration API)
        Use the create tempsbspace from storagepool argument with the admin() or task() function to create a temporary sbspace from an entry from the storage pool.
        defragment argument: Dynamically defragment partition extents (SQL administration API)
        Use the defragment argument with the admin() or task() function to defragment tables or indexes to merge non-contiguous extents.
        drop blobspace argument: Drop a blobspace (SQL administration API)
        Use the drop blobspace argument with the admin() or task() function to drop the specified blobspace.
        drop blobspace to storagepool argument: Return space from an empty blobspace to the storage pool (SQL administration API)
        Use the drop blobspace to storagepool argument with the admin() or task() function to return the space from an empty blobspace to the storage pool.
        drop chunk argument: Drop a chunk (SQL administration API)
        Use the drop chunk argument with the admin() or task() function to drop the specified chunk from a dbspace, blobspace, or sbspace.
        drop chunk to storagepool argument: Return space from an empty chunk to the storage pool (SQL administration API)
        Use the drop chunk to storagepool argument with the admin() or task() function to return the space from an empty chunk to the storage pool.
        drop database argument: Drop a database (SQL administration API)
        Use the drop database argument with the admin() or task() function to drop a database.
        drop dbspace argument: Drop a dbspace (SQL administration API)
        Use the drop dbspace argument with the admin() or task() function to drop the specified dbspace.
        drop dbspace to storagepool argument: Return space from an empty dbspace to the storage pool (SQL administration API)
        Use the drop dbspace to storagepool argument with the admin() or task() function to return the space from an empty dbspace to the storage pool.
        drop log argument: Drop a logical log (SQL administration API)
        Use the drop log argument with the admin() or task() function to drop the specified logical log.
        drop plogspace: Drop the plogspace (SQL administration API)
        Use the drop plogspace argument with the admin() or task() function to drop the plogspace.
        drop sbspace argument: Drop an sbspace (SQL administration API)
        Use the drop sbspace argument with the admin() or task() function to drop the specified sbspace.
        drop sbspace to storagepool argument: Return space from an empty sbspace to the storage pool (SQL administration API)
        Use the drop sbspace to storagepool argument with the admin() or task() function to return the space from an empty sbspace to the storage pool.
        drop tempdbspace argument: Drop a temporary dbspace (SQL administration API)
        Use the drop tempdbspace argument with the admin() or task() function to drop the specified temporary dbspace.
        drop tempdbspace to storagepool argument: Return space from an empty temporary dbspace to the storage pool (SQL administration API)
        Use the drop tempdbspace to storagepool argument with the admin() or task() function to return the space from an empty temporary dbspace to the storage pool.
        drop tempsbspace to storagepool argument: Return space from an empty temporary sbspace to the storage pool (SQL administration API)
        Use the drop tempsbspace to storagepool argument with the admin() or task() function to return the space from an empty temporary sbspace to the storage pool.
        export config argument: Export configuration parameter values (SQL administration API)
        Use the export config argument with the admin() or task() function to export a file that contains all configuration parameters and their current values.
        file status argument: Display the status of a message log file (SQL administration API)
        Use the file status argument with the admin() or task() function to specify the status of an online, ON-Bar activity, or ON-Bar debug message log file.
        grant admin argument: Grant privileges to run SQL administration API commands
        Use the grant admin argument with the admin() or task() function to grant privileges to run SQL administration API commands.
        ha make primary argument: Change the mode of a secondary server (SQL administration API)
        Use the ha make primary argument with the admin() or task() function to change the specified secondary server to a primary or standard server.
        ha rss argument: Create an RS secondary server (SQL administration API)
        Use the ha rss argument with the admin() or task() function to create a remote standalone (RS) secondary server.
        ha rss add argument: Add an RS secondary server to a primary server (SQL administration API)
        Use the ha rss add argument with the admin() or task() function to associate a primary server with a remote standalone (RS) secondary server.
        ha rss change argument: Change the password of an RS secondary server (SQL administration API)
        Use the ha rss change argument with the admin() or task() function to change the connection password for the specified RS secondary server.
        ha rss delete argument: Delete an RS secondary server (SQL administration API)
        Use the ha rss delete argument with the admin() or task() function to stop replication and delete the RS secondary server.
        ha sds clear argument: Stop shared-disk replication (SQL administration API)
        Use the ha sds clear argument with the admin() or task() function to stop replication to shared disk (SD) secondary servers and convert the primary server to a standard server.
        ha sds primary argument: Convert an SD secondary server to a primary server (SQL administration API)
        Use the ha sds primary argument with the admin() or task() function to change a shared disk (SD) secondary server to a primary server.
        ha sds set argument: Create a shared-disk primary server (SQL administration API)
        Use the ha sds set argument with the admin() or task() function to define a primary server to replicate to shared disk (SD) secondary servers.
        ha set idxauto argument: Replicate indexes to secondary servers (SQL administration API)
        Use the ha set idxauto argument with the admin() or task() function to control whether indexes are automatically replicated to secondary servers.
        ha set ipl argument: Log index builds on the primary server (SQL administration API)
        Use the ha set ipl argument with the admin() or task() function to control whether to log index builds on the primary server.
        ha set primary argument: Define an HDR primary server (SQL administration API)
        Use the ha set primary argument with the admin() or task() function to define a High-Availability Data Replication (HDR) primary server and specify the secondary server.
        ha set secondary argument: Define an HDR secondary server (SQL administration API)
        Use the ha set secondary argument with the admin() or task() function to define a High-Availability Data Replication (HDR) secondary server and specify the primary server.
        ha set standard argument: Convert an HDR server into a standard server (SQL administration API)
        Use the ha set standard argument with the admin() or task() function to convert a High-Availability Data Replication (HDR) primary or secondary server to a standard server.
        ha set timeout argument: Change SD secondary server timeout (SQL administration API)
        Use the ha set timeout argument with the admin() or task() function to change the amount of time in seconds that the primary server waits for acknowledgments from shared disk (SD) secondary servers.
        import config argument: Import configuration parameter values (SQL administration API)
        Use the import config argument with the admin() or task() function to import a file that contains one or more dynamically updatable configuration parameters and apply the new values.
        index compress repack shrink arguments: Optimize the storage of B-tree indexes (SQL administration API)
        Use the index compress repack shrink argument with the admin() or task() function to compress detached B-tree indexes, consolidate free space (repack), and return free space (shrink) in partitions.
        index estimate_compression argument: Estimate index compression (SQL administration API)
        Use the index estimate_compression argument with the admin() or task() function to estimate if you can save disk space by compressing a B-tree index.
        master_key reset argument: Change the keystore password (SQL administration API)
        Use the master_key reset argument with the admin() or task() function to change the password for the storage space encryption keystore. The password is used to encrypt the keystore for storage space encryption.
        message log delete argument: Delete a message log file (SQL administration API)
        Use the message log delete argument or file delete argument with the admin() or task() function to specify the particular online, ON-Bar activity, or ON-Bar debug message log to delete.
        message log rotate argument: Rotate the message log file (SQL administration API)
        Use the message log rotate argument or the file rotate argument with the admin() or task() function to specify the particular online, ON-Bar activity, or ON-Bar debug message log file to rotate, and to indicate the maximum number of message logs to rotate.
        message log truncate argument: Delete the contents of a message log file (SQL administration API)
        Use the message log truncate argument or file truncate argument with the admin() or task() function to specify the particular online, ON-Bar activity, or ON-Bar debug message log file to truncate. When the database server truncates a message log file, it deletes the messages in the log file, but keeps the log file.
        modify chunk extend argument: Extend the size of a chunk (SQL administration API)
        Use the modify chunk extend argument with the admin() or task() function to extend the size of the chunk by a specified minimum amount. The chunk must be marked as extendable.
        modify chunk extendable argument: Mark a chunk as extendable (SQL administration API)
        Use the modify chunk extendable argument with the admin() or task() function to specify that a particular chunk in an unmirrored dbspace or temporary dbspace can be extended..
        modify chunk extendable off argument: Mark a chunk as not extendable (SQL administration API)
        Use the modify chunk extendable off argument with the admin() or task() function to specify that a particular chunk cannot be extended.
        modify chunk swap_mirror argument: Switch primary and mirror chunk files without any downtime(SQL administration API)
        Use the modify chunk swap_mirror argument with the admin() or task() function to easily migrate data from old disk drives to new ones without downtime.
        modify space swap_mirror argument: Switch all primary and mirror chunk files for a space without any downtime (SQL administration API)
        Use the modify space swap_mirrors argument with the admin() or task() function to easily migrate data from old disk drives to new ones without downtime.
        modify config arguments: Modify configuration parameters (SQL administration API)
        Use the modify config argument with the admin() or task() function to change the value of a configuration parameter in memory until you restart the database server. Use the modify config persistent argument to change the value of a configuration parameter in memory and preserve the value in the onconfig file after you restart the server.
        modify space expand argument: Expand the size of a space (SQL administration API)
        Use the modify space expand argument with the admin() or task() function to immediately expand the size of a space, when you do not want to wait for Informix® to automatically expand the space.
        modify space sp_sizes argument: Modify sizes of an extendable storage space (SQL administration API)
        Use the modify space sp_sizes argument with the admin() or task() function to modify the create, extend, and maximum sizes that are associated with expanding a storage space. Modify the sizes to control how Informix® uses storage pool entries for a particular storage space.
        onbar argument: Backup the storage spaces (SQL administration API)
        Use the onbar argument with the admin() or task() function to backup the storage spaces.
        onmode and a arguments: Add a shared-memory segment (SQL administration API)
        Use the onmode and a arguments with the admin() or task() function to add a shared-memory segment.
        onmode and c arguments: Force a checkpoint (SQL administration API)
        Use the onmode and c arguments with the admin() or task() function to force a checkpoint.
        onmode and C arguments: Control the B-tree scanner (SQL administration API)
        Use the onmode and C arguments with the admin() or task() function to control the B-tree scanner for cleaning indexes of deleted items.
        onmode and d arguments: Set data-replication types (SQL administration API)
        Use the onmode and d arguments with the admin() or task() function to change the mode of a server participating in high-availability data replication (HDR).
        onmode and D arguments: Set PDQ priority (SQL administration API)
        Use the onmode and D arguments with the admin() or task() function to temporarily reset the PDQ resources that the database server can allocate to any one decision-support query.
        onmode and e arguments: Change usage of the SQL statement cache (SQL administration API)
        Use the onmode and e arguments with the admin() or task() function to temporarily change the mode of the SQL statement cache.
        onmode and F arguments: Free unused memory segments (SQL administration API)
        Use the onmode and F arguments with the admin() or task() function to free unused memory segments.
        onmode and h arguments: Update sqlhosts caches (SQL administration API)
        Use the onmode and h arguments with the admin() or task() function to Update sqlhosts caches.
        onmode and j arguments: Switch the database server to administration mode (SQL administration API)
        Use the onmode and j arguments with the admin() or task() function to change the database server to administration mode.
        onmode and l arguments: Switch to the next logical log (SQL administration API)
        Use the onmode and l arguments with the admin() or task() function to switch the current logical-log file to the next logical-log file.
        onmode and m arguments: Switch to multi-user mode (SQL administration API)
        Use the onmode and m arguments with the admin() or task() function to change the database server to multi-user mode.
        onmode and M arguments: Temporarily change decision-support memory (SQL administration API)
        Use the onmode and M arguments with the admin() or task() function to temporarily change the size of memory available for parallel queries.
        onmode and n arguments: Unlock resident memory (SQL administration API)
        Use the onmode and n arguments with the admin() or task() function to end forced residency of the resident portion of shared memory.
        onmode and O arguments: Mark a disabled dbspace as down (SQL administration API)
        Use the onmode and O arguments with the admin() or task() function to mark a disabled dbspace as down so that the checkpoint that is being blocked by the disabled dbspace can continue and any blocked threads are released.
        onmode and p arguments: Add or remove virtual processors (SQL administration API)
        Use the onmode and p arguments with the admin() or task() function to dynamically add or remove virtual processors for the current database server session. This function does not update the onconfig file.
        onmode and Q arguments: Set maximum number for decision-support queries (SQL administration API)
        Use the onmode and Q arguments with the admin() or task() function to change the maximum number of concurrently executing decision-support queries.
        onmode and r arguments: Force residency of shared memory (SQL administration API)
        Use the onmode and r arguments with the admin() or task() function to start forced residency of the resident portion of shared memory.
        onmode and S arguments: Set maximum number of decision-support scans (SQL administration API)
        Use the onmode and S arguments with the admin() or task() function to change the maximum number of concurrently executing decision-support scans for the current session.
        onmode and W arguments: Reset statement cache attributes (SQL administration API)
        Use the onmode and W arguments with the admin() or task() function to change whether and when a statement can be inserted into the SQL cache.
        onmode and wf arguments: Permanently update a configuration parameter (SQL administration API)
        Use the onmode and wf arguments with the admin() or task() function to dynamically update the value of a configuration parameter in the onconfig file.
        onmode and wm arguments: Temporarily update a configuration parameter (SQL administration API)
        Use the onmode and wm arguments with the admin() or task() function to dynamically update the value of a configuration parameter in memory.
        onmode, wm, and AUTO_LRU_TUNING arguments: Change LRU tuning status (SQL administration API)
        Use the onmode, wm, and AUTO_LRU_TUNING arguments with the admin() or task() function to change the LRU tuning status without updating the onconfig file. .
        onmode and Y arguments: Change query plan measurements for a session (SQL administration API)
        Use the onmode and Y arguments with the admin() or task() function to change the output of query plan measurements for an individual session.
        onmode and z arguments: Terminate a user session (SQL administration API)
        Use the onmode and z arguments with the admin() or task() function to terminate the specified user session.
        onmode and Z arguments: Terminate a distributed transaction (SQL administration API)
        Use the onmode and Z arguments with the admin() or task() function to terminate the specified distributed transaction. Use this function only if communication between the participating database servers has been lost. If applications are performing distributed transactions, terminating one of the distributed transactions can leave your client/server database system in an inconsistent state.
        onsmsync argument: Synchronize with the storage manager catalog (SQL administration API)
        Use the onsmsync argument with the admin() or task() function to synchronize the sysutils database and emergency boot file with the storage manager catalog.
        onstat argument: Monitor the database server (SQL administration API)
        Use the onstat argument with the admin() or task() function to monitor the database server.
        ontape archive argument: Backup the data on your database (SQL administration API)
        Use the ontape archive argument with the admin() or task() function to create a backup of your database data.
        print error argument: Print an error message (SQL administration API)
        Use the print error argument with the admin() or task() function to print the message associated with the specified error number.
        print file info argument: Display directory or file information (SQL administration API)
        Use the print file info argument with the admin() or task() function to display information about a directory or a file
        print partition argument: Print partition information (SQL administration API)
        Use the print partition argument with the admin() or task() function to print the headers of a specified partition.
        rename space argument: Rename a storage space (SQL administration API)
        Use the rename space argument with the admin() or task() function to rename a dbspace, blobspace, sbspace, or extspace.
        reset config argument: Revert configuration parameter value (SQL administration API)
        Use the reset config argument with the admin() or task() function to revert the value of a dynamically updatable configuration parameter to its value in the onconfig file. Dynamically updatable configuration parameters are those parameters that you can change for a session with an onmode or SQL administration API command.
        reset config all argument: Revert all dynamically updatable configuration parameter values (SQL administration API)
        Use the reset config all argument with the admin() or task() function to revert the values of all dynamically updatable configuration parameter to their values in the onconfig file. Dynamically updatable configuration parameters are those parameters that you can change for a session with an onmode or SQL administration API command.
        reset sysadmin argument: Move the sysadmin database (SQL administration API)
        Use the reset sysadmin argument with the admin() or task() function to move the sysadmin database to the specified dbspace. Moving the sysadmin database resets the database back to the original state when it was first created; all data, command history, and results tables are lost. Only built-in tasks, sensors, and thresholds remain in the sysadmin tables.
        restart listen argument: Stop and start a listen thread dynamically (SQL administration API)
        Use the restart listen argument with the admin() or task() function to stop and then start an existing listen thread for a SOCTCP or TLITCP network protocol without interrupting existing connections.
        revoke admin argument: Revoke privileges to run SQL administration API commands
        Use the revoke admin argument with the admin() or task() function to revoke privileges to run SQL administration API commands.
        scheduler argument: Stop or start the scheduler (SQL administration API)
        Use the scheduler argument with the admin() or task() function to start or stop the scheduler.
        scheduler lmm enable argument: Specify automatic low memory management settings (SQL administration API)
        Use the scheduler lmm enable argument with the admin() or task() function to start automatic low memory management and to update low memory threshold settings.
        scheduler lmm disable argument: Stop automatic low memory management (SQL administration API)
        Use the scheduler lmm disable argument with the admin() or task() function to stop the current and subsequent invocations of automatic low memory management.
        set chunk argument: Change the status of a chunk (SQL administration API)
        Use the set chunk argument with the admin() or task() function to change the status of a blobspace, dbspace, or sbspace to online or offline.
        set dataskip argument: Start or stop skipping a dbspace (SQL administration API)
        Use the set dataskip argument with the admin() or task() function to specify whether the database server skips a dbspace that is unavailable during the processing of a transaction.
        set index compression argument: Change index page compression (SQL administration API)
        Use the set index compression argument with the admin() or task() function to modify the level at which two partially used index pages are merged.
        set onconfig memory argument: Temporarily change a configuration parameter (SQL administration API)
        Use the set onconfig memory argument with the admin() or task() function to dynamically update the value of a configuration parameter in memory.
        set onconfig permanent argument: Permanently change a configuration parameter (SQL administration API)
        Use the set onconfig permanent argument with the admin() or task() function to dynamically update the value of a configuration parameter in the onconfig file.
        set sbspace accesstime argument: Control access time tracking (SQL administration API)
        Use the set sbspace accesstime argument with the admin() or task() function to start or stop tracking the time of access for all smart large objects stored in the sbspace.
        set sbspace avg_lo_size argument: Set the average size of smart large objects (SQL administration API)
        Use the set sbspace avg_lo_size argument with the admin() or task() function to specify an expected average size of the smart large objects in the specified sbspace so that the database server can calculate the size of the metadata area.
        set sbspace logging argument: Change the logging of an sbspace (SQL administration API)
        Use the set sbspace logging argument with the admin() or task() function to specify whether the database server logs changes to the user data area of the sbspace.
        set sql tracing argument: Set global SQL tracing (SQL administration API)
        Use the set sql tracing argument with the admin() or task() function to set global SQL tracing.
        set sql tracing database argument: Change database tracing (SQL administration API)
        Use the set sql tracing database argument with the admin() or task() function to start or stop tracing for a database, or list which databases are being traced.
        set sql tracing session argument: Control tracing for a session (SQL administration API)
        Use the set sql tracing session argument with the admin() or task() function to change SQL tracing for the current session.
        set sql tracing user argument: Control tracing for users (SQL administration API)
        Use the set sql tracing user argument with the admin() or task() function to change SQL tracing for users.
        set sql user tracing argument: Set global SQL tracing for a user session (SQL administration API)
        Use the set sql user tracing argument with the admin() or task() function to set the mode of global SQL tracing for a specified user session.
        start json listener argument: Start the MongoDB API wire listener (deprecated)
        Use the start json listener argument with the admin() or task() function to start the MongoDB API wire listener.
        start listen argument: Start a listen thread dynamically (SQL administration API)
        Use the start listen argument with the admin() or task() function to start an existing listen thread for a SOCTCP or TLITCP network protocol without interrupting existing connections.
        start mirroring argument: Starts storage space mirroring (SQL administration API)
        Use the start mirroring argument with the admin() or task() function to start mirroring for a specified dbspace, blobspace, or sbspace.
        statement cache enable argument: Enable the SQL statement cache (SQL administration API)
        Use the statement cache enable argument with the admin() or task() function to enable the statement cache.
        statement cache flush argument: Flush the SQL statement cache (SQL administration API)
        Use the statement cache flush argument with the admin() or task() function to flush the statement cache.
        statement cache hits argument: Specify the number of hits in the SQL statement cache (SQL administration API)
        Use the statement cache hits argument with the admin() or task() function to specify the number of hits in the SQL statement cache.
        statement cache nolimit argument: Control whether to insert qualified statements into the SQL statement cache (SQL administration API)
        Use the statement cache nolimit argument with the admin() or task() function to control whether to insert statements into the SQL statement cache after its size is greater than the STMT_CACHE_SIZE value.
        statement cache off argument: Disable the SQL statement cache (SQL administration API)
        Use the statement cache off argument with the admin() or task() function to turn off the SQL statement cache.
        statement cache save argument: Save the SQL statement cache (SQL administration API)
        Use the statement cache save argument with the admin() or task() function to save the statement cache.
        statement cache restore argument: Restore the SQL statement cache (SQL administration API)
        Use the statement cache restore argument with the admin() or task() function to restore the statement cache.
        stop json listener: Stop the wire listener (deprecated)
        Use the stop json listener argument with the admin() or task() function to stop the wire listener.
        stop listen argument: Stop a listen thread dynamically (SQL administration API)
        Use the stop listen argument with the admin() or task() function to stop an existing listen thread for a SOCTCP or TLITCP network protocol without interrupting existing connections.
        stop mirroring argument: Stops storage space mirroring (SQL administration API)
        Use the stop mirroring argument with the admin() or task() function to stop mirroring for a specified dbspace, blobspace, or sbspace.
        storagepool add argument: Add a storage pool entry (SQL administration API)
        Use the storagepool add argument with the admin() or task() function to add an entry to the storage pool (a collection of available raw devices, cooked files, or directories that Informix® can use to automatically add space to an existing storage space).
        storagepool delete argument: Delete one storage pool entry (SQL administration API)
        Use the storagepool delete argument with the admin() or task() function to delete an entry from the storage pool.
        storagepool modify argument: Modify a storage pool entry (SQL administration API)
        Use the storagepool modify argument with the admin() or task() function to modify an entry for a directory, cooked file, or raw device that Informix® can use when additional storage space is required.
        storagepool purge argument: Delete storage pool entries (SQL administration API)
        Use the storagepool purge argument with the admin() or task() function to delete all storage pool entries, storage pool entries that have a status of Full, or storage pool entries that have a status of Error.
        Table and fragment pfsc_boost argument: Enable or disable a boosted partition free space cache (PFSC)
        You can enable and disable a boosted partition free space cache for a table or fragment using SQL administration API admin() or task() functions and arguments.
        Table and fragment compress and uncompress operations (SQL administration API)
        You can compress and uncompress the data in a table or in table fragments with SQL administration API admin() or task() functions and arguments. Compression operations apply only to the contents of data rows and the images of those data rows that appear in logical log records.
        tenant create argument: Create a tenant database (SQL Administration API)
        Use the tenant create argument with the admin() or task() function to create a tenant database.
        tenant drop argument: Drop a tenant database (SQL Administration API)
        Use the tenant drop argument with the admin() or task() function to drop a tenant database.
        tenant update argument: Modify tenant database properties (SQL Administration API)
        Use the tenant update argument with the admin() or task() function to modify the properties of a tenant database.
    - Appendixes
  - DB-Access User's Guide
    The Informix® DB-Access User's Guide describes how to use the DB-Access utility to access, modify, and retrieve information from Informix database servers.
  - High-Performance Loader User's Guide
    The describes how to use the HCL Informix® to load and unload large quantities of data efficiently to or from Informix databases.
  - Performance Guide
    The Informix® Performance Guide describes how to configure and operate your HCL Informix database server to improve overall system throughput and to improve the performance of SQL queries.
  - SNMP Subagent Guide
    The describes the Simple Network Management Protocol (SNMP) and the software that you need to use SNMP to monitor and manage HCL Informix® database servers and databases.
  - InformixHQ Guide
    InformixHQ is a modern web console for visualizing, monitoring, and managing your Informix server instances. It is purpose built for ease-of-use, scaling out, and optimizing DevOps needs. It provides critical performance management capabilities, monitoring how key performance metrics are changing over time and tracking how efficiently Informix is running your workload even when you’ve stepped away from your screen. Its monitoring system feeds directly into a customizable alerting system so you can be immediately alerted via email, Twilio, or PagerDuty whenever an issue occurs on one of your Informix database server instances. InformixHQ is designed to be scalable to efficiently manage and monitor as many Informix database server instances as you need. Moreover, it's a tool that can be shared by the DBAs, the app developers, the ops engineers, and management and accessed from any desktop, laptop, or mobile device. InformixHQ is the centralized hub for graphical monitoring, alerting, and administration of your Informix database servers.
- Backup and Restore Guide
  The Informix® Backup and Restore Guide describes how to use the Informix ON-Bar and ontape utilities to back up and restore database server data. These utilities enable you to recover your databases after data is lost or becomes corrupted due to hardware or software failure or accident.
- Enterprise Replication
  The HCL® Informix® Enterprise Replication Guide describes the concepts of data replication using Informix Enterprise Replication, including how to design your replication system, as well as administer and manage data replication throughout your enterprise.

onmode and p arguments: Add or remove virtual processors (SQL administration API)

Use the onmode and p arguments with the admin() or task() function to dynamically add or remove virtual processors for the current database server session. This function does not update the onconfig file.

Syntax

Notes:

¹ UNIX™ only


Element	Description	Key Considerations
`number`	The number of virtual processors to add or to remove.	A positive number adds virtual processors. The maximum number of virtual processors you can add depends on the operating system. UNIX™: A negative number removes virtual processors. The number of virtual processors to drop cannot exceed the actual number of processors of the specified type.
`vpclass`	The name of a user-defined virtual processor class.	Windows™: The `number` argument must be set to `1` because you can only create one instance of a user-defined virtual processor.

Usage

You can use this function only when the database server is in online mode.

The number of CPU VPs should not exceed the number of physical processors on your system, but no error is issued if they do. The database server uses the number of CPU VPs to allocate resources for parallel database queries (PDQ). If you drop CPU VPs, your queries might run significantly slower. After you change the number of CPU VPs, the Reinit field in the output from the onstat -g mgm command shows how many queries are waiting for other queries to complete.

See the Informix® Performance Guide for more information about performance implications of the CPU VP class.

For a description of each virtual processor class, see the Informix® Administrator's Guide.

This function is equivalent to the onmode -p command.

Example

The following example adds one CPU virtual processor:

EXECUTE FUNCTION task("onmode","p","1","cpu");

The following example removes one Java™ virtual processor:

EXECUTE FUNCTION task("onmode","p","-1","jvp");