ServerCluster

This type is a class for model objects.

A server cluster is a list of application servers that are all cooperating in a workload balanced set. While some aspects of the configuration of the servers that are members of a cluster may vary, the application configuration for all cluster members must be identical.

Package: cluster
Supertype: ManagedObject

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

Reference attributes having this type:
  ClusterMember.cluster


Attributes Summary
description : EString A string that can be used to document any piece of information about the cluster.
preferLocal : EBoolean Indicates whether a client have affinity to the local process or not.
shortName : EString @for zOS only
uniqueId : EString @for zOS only
nodeGroupName : EString The name of the node group that this cluster belongs to.
enableHA : EBoolean Enable high availability for persistent services
serverType : ServerTypeKind Specifies the type of servers that will be contained in this cluster. The default is APPLICATION_SERVER.
jsfProvider : EString The name of the JSF provider to be loaded by the members of this cluster. Valid values are: SunRI1.2 and MyFaces. Default is MyFaces.
clusterAddress : EString Use a ClusterAddress when you do not want the plug-in to perform any type of load balancing because you already have some type of load balancer in between the plug-in and the application server. If a request comes in that does not have affinity established, the plug-in routes it to the cluster address, if defined. If affinity has been established, then the plug-in routes the request directly to the clone, bypassing the cluster address entirely. If no cluster address is defined for the server cluster, then the plug-in load balances across the servers in the primary servers list.
prefetchDWLMTable : EBoolean indicate if plugin should prefetch partition table to improve performance when using M2M replication
serverIOTimeoutRetry : EInt @since 8.5.
enableClusterAddressing : EBoolean @since 8.5
jpaProvider : EString The name of the JPA provider.
jaxrsProvider : EString The JAX-RS provider: jaxrs-1.1.xml jaxrs-2.0.xml jaxrs-2.0spec.xml jaxrs-1.1spec.xml
backupClusters : BackupCluster * A list of other clusters that can act as backups for this one in case of total cluster failure.
members : ClusterMember + A list of the servers that are members of this cluster.
clusterAddressEndPoints : ClusterAddressEndPoint * * No description is available *
clusterAddressProperties : ClusterAddressProperties @ * No description is available *


Attribute Details

description  -  A string that can be used to document any piece of information about the cluster.
    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

preferLocal  -  Indicates whether a client have affinity to the local process or not.
    Data Type: EBoolean
    Default value:  true
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

shortName  -  @for zOS only
    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

uniqueId  -  @for zOS only
    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

nodeGroupName  -  The name of the node group that this cluster belongs to.
    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

enableHA  -  Enable high availability for persistent services
    Data Type: EBoolean
    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

serverType  -  Specifies the type of servers that will be contained in this cluster. The default is APPLICATION_SERVER.
    Data Type: ServerTypeKind
    Default value:  APPLICATION_SERVER
    Allowed values:
        0 - APPLICATION_SERVER
        1 - PROXY_SERVER
        2 - ONDEMAND_ROUTER
        3 - MANAGED_LIBERTY_SERVER
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

jsfProvider  -  The name of the JSF provider to be loaded by the members of this cluster. Valid values are: SunRI1.2 and MyFaces. Default is MyFaces.
    Data Type: EString
    Default value:  MyFaces
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

clusterAddress  -  Use a ClusterAddress when you do not want the plug-in to perform any type of load balancing because you already have some type of load balancer in between the plug-in and the application server. If a request comes in that does not have affinity established, the plug-in routes it to the cluster address, if defined. If affinity has been established, then the plug-in routes the request directly to the clone, bypassing the cluster address entirely. If no cluster address is defined for the server cluster, then the plug-in load balances across the servers in the primary servers list.
    Data Type: EString
    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

prefetchDWLMTable  -  indicate if plugin should prefetch partition table to improve performance when using M2M replication
    Data Type: EBoolean
    Default value:  true
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

serverIOTimeoutRetry  -  @since 8.5.
    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

enableClusterAddressing  -  @since 8.5
    Data Type: EBoolean
    Default value:  false
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

jpaProvider  -  The name of the JPA provider.
    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

jaxrsProvider  -  The JAX-RS provider: jaxrs-1.1.xml jaxrs-2.0.xml jaxrs-2.0spec.xml jaxrs-1.1spec.xml
    Data Type: EString
    Default value:  jaxrs-2.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

backupClusters  -  A list of other clusters that can act as backups for this one in case of total cluster failure.
    Reference Type: BackupCluster *
    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

members  -  A list of the servers that are members of this cluster.
    Reference Type: ClusterMember +
    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
    Opposite: ClusterMember.cluster

clusterAddressEndPoints  -  * No description is available *
    Reference Type: ClusterAddressEndPoint *
    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

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


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