corosync.conf man page on Oracle

Man page or keyword search:  
man Server   33470 pages
apropos Keyword Search (all sections)
Output format
Oracle logo
[printable version]

COROSYNC_CONF(5)  Corosync Cluster Engine Programmer's Manual COROSYNC_CONF(5)

       corosync.conf - corosync executive configuration file


       The corosync.conf instructs the corosync executive about various param‐
       eters needed to control the corosync executive.	Empty lines and	 lines
       starting with # character are ignored.  The configuration file consists
       of bracketed top level directives.  The possible directive choices are:

       totem { }
	      This top level directive contains configuration options for  the
	      totem protocol.

       logging { }
	      This top level directive contains configuration options for log‐

       quorum { }
	      This top level directive contains configuration options for quo‐

       nodelist { }
	      This  top	 level	directive  contains  configuration options for
	      nodes in cluster.

       qb { } This top level directive contains configuration options  related
	      to libqb.

       Within  the totem directive, an interface directive is required.	 There
       is also one configuration option which is required:

       Within the interface sub-directive of totem there are  four  parameters
       which are required.  There is one parameter which is optional.

	      This  specifies  the  ring number for the interface.  When using
	      the redundant ring protocol, each interface should specify sepa‐
	      rate  ring numbers to uniquely identify to the membership proto‐
	      col which	 interface  to	use  for  which	 redundant  ring.  The
	      ringnumber must start at 0.

	      This specifies the network address the corosync executive should
	      bind to.

	      bindnetaddr should be an IP address configured on the system, or
	      a network address.

	      For example, if the local interface is with netmask, you should set  bindnetaddr  to  or   If	 the local interface is with net‐
	      mask,  set  bindnetaddr	to   or, and so forth.

	      This  may also be an IPV6 address, in which case IPV6 networking
	      will be used.  In this case, the exact address must be specified
	      and  there  is  no  automatic selection of the network interface
	      within a specific subnet as with IPv4.

	      If IPv6 networking is used, the nodeid field in nodelist must be

	      This  is	optional  and can be set to yes.  If it is set to yes,
	      the broadcast address will be used for communication.   If  this
	      option is set, mcastaddr should not be set.

	      This  is	the multicast address used by corosync executive.  The
	      default should work for most networks, but the network  adminis‐
	      trator  should  be  queried  about  a  multicast address to use.
	      Avoid 224.x.x.x because this is a "config" multicast address.

	      This may also be an IPV6 multicast address, in which  case  IPV6
	      networking will be used.	If IPv6 networking is used, the nodeid
	      field in nodelist must be specified.

	      It's not needed to use this option  if  cluster_name  option  is
	      used. If both options are used, mcastaddr has higher priority.

	      This  specifies  the UDP port number.  It is possible to use the
	      same multicast address on a network with the  corosync  services
	      configured  for  different UDP ports.  Please note corosync uses
	      two UDP ports mcastport (for mcast receives) and mcastport  -  1
	      (for  mcast  sends).   If you have multiple clusters on the same
	      network using the same mcastaddr please configure the mcastports
	      with a gap.

       ttl    This  specifies  the Time To Live (TTL). If you run your cluster
	      on a routed network then the default of "1" will be  too	small.
	      This option provides a way to increase this up to 255. The valid
	      range is 0..255.	Note that this	is  only  valid	 on  multicast
	      transport types.

       Within  the  totem  directive, there are seven configuration options of
       which one is required, five are optional, and one is required when IPV6
       is  configured  in  the interface subdirective.	The required directive
       controls the version of the totem configuration.	 The  optional	option
       unless  using  IPV6 directive controls identification of the processor.
       The optional options control secrecy and authentication, the  redundant
       ring mode of operation and maximum network MTU field.

	      This specifies the version of the configuration file.  Currently
	      the only valid version for this directive is 2.

       clear_node_high_bit This configuration option is optional and  is  only
       relevant	 when no nodeid is specified.  Some corosync clients require a
       signed 32 bit nodeid that is  greater  than  zero  however  by  default
       corosync	 uses  all 32 bits of the IPv4 address space when generating a
       nodeid.	Set this option to yes to force the high bit to	 be  zero  and
       therefor ensure the nodeid is a positive signed 32 bit integer.

       WARNING:	 The  clusters behavior is undefined if this option is enabled
       on only a subset of the cluster (for example during a rolling upgrade).

	      This specifies which  HMAC  authentication  should  be  used  to
	      authenticate all messages. Valid values are none (no authentica‐
	      tion), md5, sha1, sha256, sha384 and sha512.

	      The default is sha1.

	      This specifies which cipher should be used to encrypt  all  mes‐
	      sages.   Valid  values are none (no encryption), aes256, aes192,
	      aes128 and 3des.	Enabling crypto_cipher, requires also enabling
	      of crypto_hash.

	      The default is aes256.

	      This  specifies  that HMAC/SHA1 authentication should be used to
	      authenticate all messages.  It further specifies that  all  data
	      should  be  encrypted with the nss library and aes256 encryption
	      algorithm to protect data from eavesdropping.

	      Enabling this option adds a encryption header to	every  message
	      sent  by	totem  which reduces total throughput. Also encryption
	      and authentication consume extra CPU cycles in corosync.

	      The default is on.

	      WARNING: This parameter is deprecated. It's  recomended  to  use
	      combination of crypto_cipher and crypto_hash.

	      This  specifies  the  mode of redundant ring, which may be none,
	      active, or passive.  Active replication  offers  slightly	 lower
	      latency from transmit to delivery in faulty network environments
	      but with less performance.  Passive replication may nearly  dou‐
	      ble  the	speed  of  the	totem protocol if the protocol doesn't
	      become cpu bound.	 The final option is none, in which case  only
	      one  network  interface will be used to operate the totem proto‐

	      If only one interface directive is specified, none is  automati‐
	      cally  chosen.   If multiple interface directives are specified,
	      only active or passive may be chosen.

	      The maximum number of interface directives that is  allowed  for
	      either modes (active or passive) is 2.

       netmtu This  specifies  the network maximum transmit unit.  To set this
	      value beyond 1500, the  regular  frame  MTU,  requires  ethernet
	      devices  that  support  large, or also called jumbo, frames.  If
	      any device in the network doesn't support large frames, the pro‐
	      tocol will not operate properly.	The hosts must also have their
	      mtu size set from 1500 to whatever frame size is specified here.

	      Please note while some NICs or switches claim large  frame  sup‐
	      port,  they support 9000 MTU as the maximum frame size including
	      the IP header.  Setting the netmtu and host MTUs	to  9000  will
	      cause totem to use the full 9000 bytes of the frame.  Then Linux
	      will add a 18 byte header moving the full frame  size  to	 9018.
	      As  a  result  some hardware will not operate properly with this
	      size of data.  A netmtu of 8982 seems to work for the few	 large
	      frame  devices  that have been tested.  Some manufacturers claim
	      large frame support when in fact they  support  frame  sizes  of
	      4500 bytes.

	      When sending multicast traffic, if the network frequently recon‐
	      figures, chances are that some device  in	 the  network  doesn't
	      support large frames.

	      Choose  hardware	carefully if intending to use large frame sup‐

	      The default is 1500.

	      This directive controls the virtual synchrony filter  type  used
	      to  identify  a  primary component.  The preferred choice is YKD
	      dynamic linear voting, however,  for  clusters  larger  then  32
	      nodes  YKD  consumes  alot  of memory.  For large scale clusters
	      that are created by changing the MAX_PROCESSORS_COUNT #define in
	      the  C code totem.h file, the virtual synchrony filter "none" is
	      recommended but then AMF and DLCK services (which are  currently
	      experimental) are not safe for use.

	      The default is ykd.  The vsftype can also be set to none.

	      This  directive  controls	 the transport mechanism used.	If the
	      interface to which corosync is binding is an RDMA interface such
	      as  RoCEE	 or  Infiniband, the "iba" parameter may be specified.
	      To avoid the use of  multicast  entirely,	 a  unicast  transport
	      parameter "udpu" can be specified.  This requires specifying the
	      list of members in nodelist directive,  that  could  potentially
	      make up the membership before deployment.

	      The  default is udp.  The transport type can also be set to udpu
	      or iba.

	      This specifies the name of cluster and it's used	for  automatic
	      generating of multicast address.

	      This  specifies  version	of  config  file. This is converted to
	      unsigned 64-bit int.  By default it's 0. Option is used to  pre‐
	      vent  joining  old  nodes	 with not up-to-date configuration. If
	      value is not 0, and node is going for first time (only for first
	      time,  join  after split doesn't follow this rules) from single-
	      node membership to multiple nodes membership, other  nodes  con‐
	      fig_versions  are	 collected.  If current node config_version is
	      not equal to highest of collected versions, corosync  is	termi‐

	      Specifies	 version  of IP to use for communication. Value can be
	      one of ipv4 or ipv6. Default (if unspecified) is ipv4.

	      Within the totem	directive,  there  are	several	 configuration
	      options which are used to control the operation of the protocol.
	      It is generally not recommended to change any  of	 these	values
	      without  proper  guidance and sufficient testing.	 Some networks
	      may require larger values if suffering from frequent  reconfigu‐
	      rations.	Some applications may require faster failure detection
	      times which can be achieved by reducing the token timeout.

       token  This timeout specifies in milliseconds until  a  token  loss  is
	      declared	after  not  receiving a token.	This is the time spent
	      detecting a failure of a processor in the current configuration.
	      Reforming	 a  new	 configuration	takes about 50 milliseconds in
	      addition to this timeout.

	      The default is 1000 milliseconds.

	      This timeout specifies in milliseconds  after  how  long	before
	      receiving	 a  token  the	token  is retransmitted.  This will be
	      automatically calculated if token is modified.  It is not recom‐
	      mended  to  alter	 this value without guidance from the corosync

	      The default is 238 milliseconds.

       hold   This timeout specifies in milliseconds how long the token should
	      be  held	by  the	 representative when the protocol is under low
	      utilization.   It is not recommended to alter this value without
	      guidance from the corosync community.

	      The default is 180 milliseconds.

	      This  value  identifies  how  many  token	 retransmits should be
	      attempted before forming a new configuration.  If this value  is
	      set,  retransmit	and hold will be automatically calculated from
	      retransmits_before_loss and token.

	      The default is 4 retransmissions.

       join   This timeout specifies in milliseconds how long to wait for join
	      messages in the membership protocol.

	      The default is 50 milliseconds.

	      This  timeout specifies in milliseconds an upper range between 0
	      and send_join to wait before sending a join message.   For  con‐
	      figurations  with less then 32 nodes, this parameter is not nec‐
	      essary.  For larger rings, this parameter is necessary to ensure
	      the  NIC	is not overflowed with join messages on formation of a
	      new ring.	 A reasonable value for large rings (128 nodes)	 would
	      be 80msec.  Other timer values must also change if this value is
	      changed.	Seek advice from the corosync mailing list  if	trying
	      to run larger configurations.

	      The default is 0 milliseconds.

	      This timeout specifies in milliseconds how long to wait for con‐
	      sensus to be achieved before starting a new round of  membership
	      configuration.   The  minimum  value for consensus must be 1.2 *
	      token.  This value will be automatically	calculated  at	1.2  *
	      token if the user doesn't specify a consensus value.

	      For  two node clusters, a consensus larger then the join timeout
	      but less then token is safe.  For three node or larger clusters,
	      consensus	 should	 be larger then token.	There is an increasing
	      risk of odd membership changes,  which  stil  guarantee  virtual
	      synchrony,  as node count grows if consensus is less than token.

	      The default is 1200 milliseconds.

       merge  This  timeout  specifies in milliseconds how long to wait before
	      checking for a partition when  no	 multicast  traffic  is	 being
	      sent.   If  multicast traffic is being sent, the merge detection
	      happens automatically as a function of the protocol.

	      The default is 200 milliseconds.

	      This timeout specifies in milliseconds how long to  wait	before
	      checking	that  a network interface is back up after it has been

	      The default is 1000 millseconds.

	      This constant specifies how many rotations of the token  without
	      receiving	 any  of the messages when messages should be received
	      may occur before a new configuration is formed.

	      The default is 2500 failures to receive a message.

	      This constant specifies how many rotations of the token  without
	      any  multicast  traffic  should  occur  before the hold timer is

	      The default is 30 rotations.

	      [HeartBeating mechanism] Configures  the	optional  HeartBeating
	      mechanism for faster failure detection. Keep in mind that engag‐
	      ing this mechanism in lossy networks  could  cause  faulty  loss
	      declaration  as  the  mechanism relies on the network for heart‐

	      So as a rule of thumb use this mechanism if you require improved
	      failure in low to medium utilized networks.

	      This  constant  specifies	 the  number of heartbeat failures the
	      system should tolerate before declaring heartbeat failure e.g 3.
	      Also  if this value is not set or is 0 then the heartbeat mecha‐
	      nism is not engaged in the system	 and  token  rotation  is  the
	      method of failure detection

	      The default is 0 (disabled).

	      [HeartBeating mechanism] This constant specifies in milliseconds
	      the approximate delay that your network takes to	transport  one
	      packet  from  one machine to another. This value is to be set by
	      system engineers and please dont change  if  not	sure  as  this
	      effects the failure detection mechanism using heartbeat.

	      The default is 50 milliseconds.

	      This  constant specifies the maximum number of messages that may
	      be sent on  one  token  rotation.	  If  all  processors  perform
	      equally  well,  this  value  could  be  large (300), which would
	      introduce higher latency from origination to delivery  for  very
	      large  rings.   To  reduce  latency  in  large  rings(16+),  the
	      defaults are a safe compromise.  If 1 or more slow  processor(s)
	      are  present  among  fast	 processors,  window_size should be no
	      larger then 256000 / netmtu to  avoid  overflow  of  the	kernel
	      receive buffers.	The user is notified of this by the display of
	      a retransmit list in the notification logs.  There is no loss of
	      data, but performance is reduced when these errors occur.

	      The default is 50 messages.

	      This  constant specifies the maximum number of messages that may
	      be sent by one processor on receipt of the token.	 The  max_mes‐
	      sages  parameter	is limited to 256000 / netmtu to prevent over‐
	      flow of the kernel transmit buffers.

	      The default is 17 messages.

	      This constant defines the maximum number of times on receipt  of
	      a	 token	a  message  is	checked	 for  retransmission  before a
	      retransmission occurs.  This parameter is useful to  modify  for
	      switches	that delay multicast packets compared to unicast pack‐
	      ets.  The default setting	 works	well  for  nearly  all	modern

	      The default is 5 messages.

	      This  specifies  the  time in milliseconds to wait before decre‐
	      menting the problem count by 1 for a particular ring to ensure a
	      link is not marked faulty for transient network failures.

	      The default is 2000 milliseconds.

	      This  specifies the number of times a problem is detected with a
	      link before setting the link faulty.  Once a link is set faulty,
	      no  more data is transmitted upon it.  Also, the problem counter
	      is no longer decremented when the problem count timeout expires.

	      A problem is detected whenever all tokens	 from  the  proceeding
	      processor	    have     not     been    received	 within	   the
	      rrp_token_expired_timeout.   The	rrp_problem_count_threshold  *
	      rrp_token_expired_timeout should be atleast 50 milliseconds less
	      then the token timeout, or a complete reconfiguration may occur.

	      The default is 10 problem counts.

	      This specifies the number of times a problem  is	detected  with
	      multicast	 before	 setting the link faulty for passive rrp mode.
	      This variable is unused in active rrp mode.

	      The default is 10 times rrp_problem_count_threshold.

	      This specifies the time in milliseconds to increment the problem
	      counter  for  the	 redundant  ring  protocol  after  not	having
	      received a token from all rings for a particular processor.

	      This value will automatically be calculated from the token time‐
	      out  and	problem_count_threshold	 but may be overridden.	 It is
	      not recommended to override this value without guidance from the
	      corosync community.

	      The default is 47 milliseconds.

	      This  specifies  the time in milliseconds to check if the failed
	      ring can be auto-recovered.

	      The default is 1000 milliseconds.

       Within the logging directive, there are several	configuration  options
       which are all optional.

       The following 3 options are valid only for the top level logging direc‐

	      This specifies that a timestamp is placed on all log messages.

	      The default is off.

	      This specifies that file and line should be printed.

	      The default is off.

	      This specifies that the code function name should be printed.

	      The default is off.

       The following options are valid both for top  level  logging  directive
       and they can be overriden in logger_subsys entries.



	      These specify the destination of logging output. Any combination
	      of these options may be specified. Valid options are yes and no.

	      The default is syslog and stderr.

	      Please note, if you are using to_logfile and want to rotate  the
	      file, use logrotate(8) with the option copytruncate.  eg.
	      /var/log/corosync.log {
		   rotate 7

	      If  the  to_logfile directive is set to yes , this option speci‐
	      fies the pathname of the log file.

	      No default.

	      This specifies the logfile priority for this particular  subsys‐
	      tem.  Ignored if debug is on.  Possible values are: alert, crit,
	      debug (same as debug = on), emerg, err, info, notice, warning.

	      The default is: info.

	      This specifies the syslog facility type that will	 be  used  for
	      any messages sent to syslog. options are daemon, local0, local1,
	      local2, local3, local4, local5, local6 & local7.

	      The default is daemon.

	      This specifies the syslog level for this	particular  subsystem.
	      Ignored if debug is on.  Possible values are: alert, crit, debug
	      (same as debug = on), emerg, err, info, notice, warning.

	      The default is: info.

       debug  This specifies whether debug output is logged for this  particu‐
	      lar  logger. Also can contain value trace, what is highest level
	      of debug informations.

	      The default is off.

       Within the logging directive, logger_subsys directives are optional.

       Within the logger_subsys sub-directive, all of the above	 logging  con‐
       figuration  options  are	 valid and can be used to override the default
       settings.  The subsys entry, described below, is mandatory to  identify
       the subsystem.

       subsys This  specifies  the subsystem identity (name) for which logging
	      is specified. This is the name used by a service in the log_init
	      () call. E.g. 'CPG'. This directive is required.

       Within  the quorum directive it is possible to specify the quorum algo‐
       rithm to use with the

	      directive. At the time of writing	 only  corosync_votequorum  is
	      supported.  See votequorum(5) for configuration options.

       Within the nodelist directive it is possible to specify specific infor‐
       mations about nodes in cluster. Directive can contain  only  node  sub-
       directive,  which  specifies  every node that should be a member of the
       membership, and where non-default options are needed. Every  node  must
       have at least ring0_addr field filled.

       For  UDPU, every node that should be a member of the membership must be

       Possible options are:

	      This specifies ip address of one of the nodes. X is ring number.

       nodeid This configuration  option  is  optional	when  using  IPv4  and
	      required when using IPv6.	 This is a 32 bit value specifying the
	      node identifier delivered to the cluster membership service.  If
	      this  is not specified with IPv4, the node id will be determined
	      from the 32 bit IP address the system to	which  the  system  is
	      bound  with  ring identifier of 0.  The node identifier value of
	      zero is reserved and should not be used.

       Within the qb directive it is possible to specify options for libqb.

       Possible option is:

	      This specifies type  of  IPC  to	use.  Can  be  one  of	native
	      (default),  shm  and socket.  Native means one of shm or socket,
	      depending on what is supported by OS. On	systems	 with  support
	      for  both, SHM is selected. SHM is generally faster, but need to
	      allocate ring buffer file in /dev/shm.

	      The corosync executive configuration file.

       corosync_overview(8), votequorum(5), logrotate(8)

corosync Man Page		  2012-10-10		      COROSYNC_CONF(5)

List of man pages available for Oracle

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
Vote for polarhome
Free Shell Accounts :: the biggest list on the net