votequorum_qdevice_master_wins.3.in 3.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. .\"/*
  2. .\" * Copyright (c) 2014 Red Hat, Inc.
  3. .\" *
  4. .\" * All rights reserved.
  5. .\" *
  6. .\" * Author: Christine Caulfield <ccaulfie@redhat.com>
  7. .\" *
  8. .\" * This software licensed under BSD license, the text of which follows:
  9. .\" *
  10. .\" * Redistribution and use in source and binary forms, with or without
  11. .\" * modification, are permitted provided that the following conditions are met:
  12. .\" *
  13. .\" * - Redistributions of source code must retain the above copyright notice,
  14. .\" * this list of conditions and the following disclaimer.
  15. .\" * - Redistributions in binary form must reproduce the above copyright notice,
  16. .\" * this list of conditions and the following disclaimer in the documentation
  17. .\" * and/or other materials provided with the distribution.
  18. .\" * - Neither the name of the MontaVista Software, Inc. nor the names of its
  19. .\" * contributors may be used to endorse or promote products derived from this
  20. .\" * software without specific prior written permission.
  21. .\" *
  22. .\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  23. .\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24. .\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25. .\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  26. .\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27. .\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28. .\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  29. .\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  30. .\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31. .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  32. .\" * THE POSSIBILITY OF SUCH DAMAGE.
  33. .\" */
  34. .TH VOTEQUORUM_QDEVICE_MASTER_WINS 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
  35. .SH NAME
  36. votequorum_qdevice_master_wins \- Sets or clears quorum device master_wins flag
  37. .SH SYNOPSIS
  38. .B #include <corosync/votequorum.h>
  39. .sp
  40. .BI "int votequorum_qdevice_master_wins(votequorum_handle_t " handle " const char " name ", unsigned int " allow ");"
  41. .SH DESCRIPTION
  42. The
  43. .B votequorum_qdevice_master_wins
  44. informs votequorum whether or not the currently registered qdevice subsystem supports 'master_wins' mode (default 0).
  45. This mode allows the qdevice to effectively take over the quorum calculations of votequorum. Any node with an active
  46. qdevice that also has master_wins set becomes quorate regardless of the node votes of the cluster. It is left up to the
  47. qdevice subsystem itself (not part of votequorum) to communicate across the nodes or otherwise provide some system of
  48. deciding which nodes will be part of the quorate cluster, if any. eg They may be the set of nodes that has access to
  49. a quorum disk.
  50. .br
  51. .B name
  52. The name of the currently registered quorum device on this node. This must match the existing name known to votequorum.
  53. .br
  54. .B allow
  55. 0 (the default) means that master_wins is not active on this node. 1 means that master_wins is active on this node.
  56. .SH RETURN VALUE
  57. This call returns the CS_OK value if successful, otherwise an error is returned.
  58. .PP
  59. .SH ERRORS
  60. @COMMONIPCERRORS@
  61. .SH "SEE ALSO"
  62. .BR votequorum_overview (3),
  63. .BR votequorum_initialize (3),
  64. .BR votequorum_finalize (3),
  65. .BR votequorum_getinfo (3),
  66. .BR votequorum_trackstart (3),
  67. .BR votequorum_trackstop (3),
  68. .BR votequorum_fd_get (3),
  69. .BR votequorum_dispatch (3),
  70. .BR votequorum_context_set (3),
  71. .BR votequorum_context_get (3),
  72. .BR votequorum_setexpected (3),
  73. .BR votequorum_setvotes (3),
  74. .BR votequorum_qdevice_register (3),
  75. .BR votequorum_qdevice_poll (3),
  76. .BR votequorum_qdevice_update (3),
  77. .PP