CoreGroup


This type is a class for model objects.

A CoreGroup is a set of WebSphere servers having a Group Communications System (GCS) fabric, which can be used for Virtually Synchronous messaging. Websphere environment allows mulitcasts among the members of a core group. During both WebSphere Express and ND installations, a coregroup.xml file gets created. The initial coregroup.xml file contains only the 'DefaultCoreGroup" having only one server- 'server1' (by default) for Express and 'dmgr' for ND. At any point in time, the coregroup.xml file can be altered through the Integrated Solutions Console, or by executing appropriate wsadmin scripts. The class also consists of a set of parameter values for the GCS layer underlying a core group.

Package: coregroup

Classifier ID:  -1
Instance class name:  * Unspecified *
Instance class:  * Unspecified *



Attributes Summary
name : EString A mandatory String-valued attribute specifying the core group name. The name must be unique within the scope of a WebSphere cell.
description : EString An optional String-valued field.
coreGroupUID : EString Unique Id for this core group.
numCoordinators : EInt An integer-type field with the default value of 1. The field specifies the number of coordinators for the containing core group. If explicitly specified, the relationship: 1 <= numCoordinators <= number of CoreGroupServers should be satisfied. However, the HAManager component is resilient regarding the specification of this pariticular attribute: HAManager may use the default value of 1, if numCoordinators is specified to be < 1, and may use the value of 'number of CoreGroupServers' if numCoordinators is specified to be > 'number of CoreGroupServers'.
multiCastPort : EInt The designated port number for mulicast. The attribute is for the underlying Group Communications Systems and assumes significance only if the 'transportType' attribute is set to 'MULTICAST'.
multiCastGroupIPStart : EString The lower limit for the range of Host's IP addresses to be used for multicast. The attribute is for the underlying Group Communications Systems and assumes significance only if the 'transportType' attribute is set to 'MULTICAST'.
multiCastGroupIPEnd : EString The upper limit for the range of Host's IP addresses to be used for multicast. The attribute is for the underlying Group Communications Systems and assumes significance only if the 'transportType' attribute is set to 'MULTICAST'.
channelChainName : EString The name of the Channel Chain to be used by the Channel Framework transport. The attribute assumes significance only if the 'TransportType' attribute is set to 'CHANNEL_FRAMEWORK'.
transportType : TransportType Specifies the transport type to be used by the Group Communications System for communicating among the members of the core group under concern. Values can only be: CHANNEL_FRAMEWORK, UNICAST, or MULTICAST. The CHANNEL_FRAMEWORK is the default.
protocolVersion : EString Specifies the version of the wire protocol being used for this coregroup. @since 6.0.2
transportMemorySize : EInt The maximum size of heap memory, in megabytes, that the transport can hold.
policies : HAManagerPolicy * * No description is available *
preferredCoordinatorServers : CoreGroupServer * * No description is available *
customProperties : Property * * No description is available *
coreGroupServers : CoreGroupServer + * No description is available *
liveness : Liveness @ * No description is available *



Attribute Details

name  -  A mandatory String-valued attribute specifying the core group name. The name must be unique within the scope of a WebSphere cell.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

description  -  An optional String-valued field.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

coreGroupUID  -  Unique Id for this core group.
    Data Type: EString
    Default value:  0
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

numCoordinators  -  An integer-type field with the default value of 1. The field specifies the number of coordinators for the containing core group. If explicitly specified, the relationship: 1 <= numCoordinators <= number of CoreGroupServers should be satisfied. However, the HAManager component is resilient regarding the specification of this pariticular attribute: HAManager may use the default value of 1, if numCoordinators is specified to be < 1, and may use the value of 'number of CoreGroupServers' if numCoordinators is specified to be > 'number of CoreGroupServers'.
    Data Type: EInt
    Default value:  1
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

multiCastPort  -  The designated port number for mulicast. The attribute is for the underlying Group Communications Systems and assumes significance only if the 'transportType' attribute is set to 'MULTICAST'.
    Data Type: EInt
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

multiCastGroupIPStart  -  The lower limit for the range of Host's IP addresses to be used for multicast. The attribute is for the underlying Group Communications Systems and assumes significance only if the 'transportType' attribute is set to 'MULTICAST'.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

multiCastGroupIPEnd  -  The upper limit for the range of Host's IP addresses to be used for multicast. The attribute is for the underlying Group Communications Systems and assumes significance only if the 'transportType' attribute is set to 'MULTICAST'.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

channelChainName  -  The name of the Channel Chain to be used by the Channel Framework transport. The attribute assumes significance only if the 'TransportType' attribute is set to 'CHANNEL_FRAMEWORK'.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

transportType  -  Specifies the transport type to be used by the Group Communications System for communicating among the members of the core group under concern. Values can only be: CHANNEL_FRAMEWORK, UNICAST, or MULTICAST. The CHANNEL_FRAMEWORK is the default.
    Data Type: TransportType
    Default value:  CHANNEL_FRAMEWORK
    Allowed values:
        0 - CHANNEL_FRAMEWORK
        1 - UNICAST
        2 - MULTICAST
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

protocolVersion  -  Specifies the version of the wire protocol being used for this coregroup. @since 6.0.2
    Data Type: EString
    Default value:  6.0.0
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

transportMemorySize  -  The maximum size of heap memory, in megabytes, that the transport can hold.
    Data Type: EInt
    Default value:  100
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

policies  -  * No description is available *
    Reference Type: HAManagerPolicy *
    Containment:  true
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  true
    Ordered:  true
    Lower bound:  0
    Upper bound:  Unbounded
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

preferredCoordinatorServers  -  * No description is available *
    Reference Type: CoreGroupServer *
    Containment:  false
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  true
    Ordered:  true
    Lower bound:  0
    Upper bound:  Unbounded
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

customProperties  -  * No description is available *
    Reference Type: Property *
    Containment:  true
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  true
    Ordered:  true
    Lower bound:  0
    Upper bound:  Unbounded
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

coreGroupServers  -  * No description is available *
    Reference Type: CoreGroupServer +
    Containment:  true
    Container:  false
    Required:  true
    Changeable:  true
    Unsettable:  false
    Many:  true
    Ordered:  true
    Lower bound:  1
    Upper bound:  Unbounded
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

liveness  -  * No description is available *
    Reference Type: Liveness @
    Containment:  true
    Container:  false
    Required:  true
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  1
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false



(C) COPYRIGHT International Business Machines Corp. 1996-2006