IBM Support

IC64472: DOCUMENTATION FOR THE ONCONFIG PARAMETER FAILOVER_CALLBACK IS INCOMPLETE

Subscribe

You can track all active APARs for this component.

 

APAR status

  • Closed as documentation error.

Error description

  • When accessing the following page in the Information Center
    regarding the use of FAILOVER_CALLBACK, the exact
    calling of the script is not clear.
    
    http://publib.boulder.ibm.com/infocenter/idshelp/v115/topic/com.
    ibm.admin.doc/ids_admin_0885.htm
    
    Futhermore, we added a boilerplate script,
    ifx_failover_callback.sh in 11.50.xC1 (idsdb00155837) and this
    is not documented.
    
    On the page referenced above we have this paragraph:
    
    Use the FAILOVER_CALLBACK configuration parameter to specify the
    name of the script to run when a database server transitions
    from a secondary server to a primary server, or from a secondary
    server to a standard server. When configured, the script
    specified by FAILOVER_CALLBACK is executed before the secondary
    server is switched to the primary server. See FAILOVER_CALLBACK
    in the IBM Informix Administrator's Reference.
    
    Replace it with the following:
    
    Use the FAILOVER_CALLBACK configuration parameter to specify the
    name of the script to run when a database server transitions
    from a secondary server to a primary server, or from a secondary
    server to a standard server. A boilerplate
    script named ifx_failover_callback.sh is available in
    $INFORMIXDIR/etc. When configured, the script specified by
    FAILOVER_CALLBACK is executed before the secondary server is
    switched to the primary server. Commands in these
    three examples prompt execution of the script:
    
      -SDS with secondary in read-only or updatable state.
    
           Execute onmode -d make primary <secondary name> on the
    secondary.
    
      -HDR with DRAUTO set to zero and the secondary in read-only or
    updatable state.
    
           1. Take the primary offline with onmode -ky.
           2. Execute onmode -d standard on the secondary.
    
      -HDR with DRAUTO set to 1 and the secondary in read-only or
    updatable state.
    
           Take the primary offline with onmode -ky. No commands are
    necessary on the secondary.
    
    
    This message appears in the online.log with script execution
    (here ifx_failover_callback.sh):
    
        Invoking Failover Callback <path>/ifx_failover_callback.sh
    
    
    See FAILOVER_CALLBACK in the IBM Informix Administrator's
    Reference.
    

Local fix

Problem summary

  • ****************************************************************
    * USERS AFFECTED:                                              *
    * All users of IDS documentation v11.50.xC5 and earlier.       *
    ****************************************************************
    * PROBLEM DESCRIPTION:                                         *
    * Documentation on how to use the FAILOVER_CALLBACK            *
    * configuration parameter                                      *
    * is incomplete.                                               *
    ****************************************************************
    * RECOMMENDATION:                                              *
    * Upgrade to IDS documentation v11.50.xC6 when available.      *
    ****************************************************************
    

Problem conclusion

  • This information should be added to the Failover with ISV
    Cluster Management
    Software topic of the Administrator's Guide:
    
    Use the FAILOVER_CALLBACK configuration parameter to specify the
    name
    of the script to run when a database server transitions from a
    secondary server
    to a primary server, or from a secondary server to a standard
    server. A
    template script named ifx_failover_callback.sh (UNIX) or
    ifx_failover_callback.bat
    (Windows) is provided in the $INFORMIXDIR/etc directory. When
    configured, the
    script specified by FAILOVER_CALLBACK is executed before the
    secondary
    server is switched to a primary or standard server.
    
    You can test the failover script by performing one of the
    following actions,
    depending on your type of high-availability cluster:
    
    * Converting an SD secondary server into a primary server.
    * If the DRAUTO configuration parameter is set to 0, shutting
    down the primary
    server and convert the HDR secondary server to standard mode.
    * If the DRAUTO configuration parameter is set to 1, shutting
    down the primary
    server in an HDR pair.
    * Shutting down the primary server in a remote stand-alone
    cluster and
    converting the RS secondary server to standard mode.
    * An Invoking Failover Callback message appears in the
    online.log listing the path
    and file name of the failover script after it is run.
    
    See the information about the FAILOVER_CALLBACK configuration
    parameter
    in the IBM Informix Administrator's Reference.
    
    If the script specified by FAILOVER_CALLBACK fails (that is, if
    it returns a
    non-zero exit code), the failover of the secondary to the
    primary (or standard)
    server also fails. In this case, the DBA must manually perform
    the failover.
    

Temporary fix

Comments

APAR Information

  • APAR number

    IC64472

  • Reported component name

    IBM IDS ENTRP E

  • Reported component ID

    5724L2304

  • Reported release

    B15

  • Status

    CLOSED DOC

  • PE

    NoPE

  • HIPER

    NoHIPER

  • Special Attention

    NoSpecatt

  • Submitted date

    2009-11-10

  • Closed date

    2010-10-01

  • Last modified date

    2010-10-01

  • APAR is sysrouted FROM one or more of the following:

  • APAR is sysrouted TO one or more of the following:

Fix information

Applicable component levels

[{"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Product":{"code":"SSGU8G","label":"Informix Servers"},"Component":"","ARM Category":[],"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"B15","Edition":"","Line of Business":{"code":"","label":""}}]

Document Information

Modified date:
01 October 2010