Default language.

Cluster node


A Cluster node represents a group of hosts collaborating to form a cluster. The Cluster node represents the group rather than a single physical entity. They are also used represent mainframe sysplexes. Cluster nodes are under the full control of patterns.

For detailed information about patterns, see the The-Pattern-Language-TPL and Configipedia.

Cluster node lifecycle

The following section describes the scenarios in which a Cluster node is created, updated, or removed.

Creation

The creation of a Cluster node is under the full control of patterns. Clusters are created when they are detected on a host by a pattern which is searching for them. The pattern contains the conditions which enable it to detect a cluster. Once found, the pattern creates the Cluster that it needs. A relationship link is automatically created to the Host node and the Cluster will have a key generated.

The generated key for a Cluster node is entirely dependent on the kind of Cluster.

Update

The update procedure for a Cluster node is also under full control of patterns. When the pattern has identified a cluster, it calculates a key. If a Cluster node with that key already exists, it is updated accordingly.

Removal

A Cluster node can be destroyed either manually or automatically. Cluster nodes are automatically removed when the last remaining Host node or MFPart is unlinked. In some cases, particular patterns might not create a cluster until hosts are detected. In these cases, the pattern will remove the Cluster node when there is only one host linked to it. For vCenter cluster nodes, cluster nodes are removed when a VMware cluster no longer exists.

To manually remove a Cluster node, find the necessary Cluster, select it in the list and pick Destroy from the Actions list. Aging of Clusters node are controlled by a Software Instance node. For more information about cluster aging, see Software-Instance-node.

This is a Cascade Removal type, see Cascade Removal.

Attributes of the Cluster node

The attributes of the Cluster node are described in the following table:

UI Name
Attribute Name and Type
Description 
Type
type : string 
Type of cluster
Subtype
subtype : string 
Subtype
Internal Identifier
id : string 
Internal Identifier of cluster
Internal Name
cluster_name : string 
Internal Name of cluster
Failover
failover : boolean 
Whether the cluster supports failover between members
Tags
tag_set : dictionary 
Tag set
Key
key : string 
Globally unique key
Name
name : string 
Primary name
Short Name
short_name : string 
Short name
Description
description : string 
Description of the element
URL
url : string 
URL for information about the element
Business Continuity Critical
business_continuity_critical : boolean 
If true, element is critical to operation of the business
Supported by 3rd Party
third_party_support : boolean 
True if the element is supported by a third party
Synonyms
synonyms : list:string 
Other names for the element
External Identifiers
external_ids : list:string 
Identifiers for this element in other systems
Cloud Identifier
cloud_id : string 
Unique cloud identifier

Relationships of the Cluster node

The relationships of the Cluster node are described in the following table:

UI Name Relationship Description 
Activity Records ActedUpon:
Activity:
ActivityRecord:
ActivityRecord
 
Record of model activity associated with this Cluster
Deployments Member:
Collection:
Collection:
Deployment
 
Deployments this Cluster is a member of
Namespace Member:
Collection:
Collection:
Namespace
 
Namespace this Cluster is in
Administrative Collections Member:
Collection:
Collection:
AdminCollection
 
Administrative Collections this Cluster is a member of
Collections Member:
Collection:
Collection:
Collection
 
Collections this Cluster is a member of
Subnets Member:
Collection:
Collection:
Subnet
 
Subnets this Cluster is a member of
Deployments Collection:
Collection:
Member:
Deployment
 
Deployments that are members of this Cluster
Namespaces Collection:
Collection:
Member:
Namespace
 
Namespaces defined in this Cluster
Software Pods Collection:
Collection:
Member:
SoftwarePod
 
Software Pods that are members of this Cluster
Clusters Container:
Containment:
Contained:
Cluster
 
Clusters contained in this Cluster
Cluster Contained:
Containment:
Container:
Cluster
 
Containing Cluster
Cluster Members Container:
Containment:
Contained:
ClusterMember
 
Cluster Members contained in this Cluster
Load Balancer Services Container:
Containment:
ContainedService:
LoadBalancerService
 
Load Balancer Services contained in this Cluster
Excluded from Model Definitions ExcludedItem:
DefinitionContainment:
Definition:
ModelDefinition
 
Model Definitions this Cluster has been excluded from
Included in Model Definitions IncludedItem:
DefinitionContainment:
Definition:
ModelDefinition
 
Model Definitions this Cluster is included in
Clusters This Depends On Dependant:
Dependency:
DependedUpon:
Cluster
 
Clusters that this Cluster depends on
Clusters Depending Upon This DependedUpon:
Dependency:
Dependant:
Cluster
 
Clusters that depend on this Cluster
Contained Software Instances This Depends On Dependant:
Dependency:
DependedUpon:
ContainedSoftwareInstance
 
Contained Software Instances that this Cluster depends on
Databases This Depends On Dependant:
Dependency:
DependedUpon:
Database
 
Databases that this Cluster depends on
Database Details This Depends On Dependant:
Dependency:
DependedUpon:
DatabaseDetail
 
Database Details that this Cluster depends on
Details This Depends On Dependant:
Dependency:
DependedUpon:
Detail
 
Details that this Cluster depends on
Files This Depends On Dependant:
Dependency:
DependedUpon:
File
 
Files that this Cluster depends on
Runtime Environments This Depends On Dependant:
Dependency:
DependedUpon:
RuntimeEnvironment
 
Runtime Environments that this Cluster depends on
Software Clusters This Depends On Dependant:
Dependency:
DependedUpon:
SoftwareCluster
 
Software Clusters that this Cluster depends on
Software Components This Depends On Dependant:
Dependency:
DependedUpon:
SoftwareComponent
 
Software Components that this Cluster depends on
Software Instances This Depends On Dependant:
Dependency:
DependedUpon:
SoftwareInstance
 
Software Instances that this Cluster depends on
Software Pods This Depends On Dependant:
Dependency:
DependedUpon:
SoftwarePod
 
Software Pods that this Cluster depends on
Virtual Machines This Depends On Dependant:
Dependency:
DependedUpon:
VirtualMachine
 
Virtual Machines that this Cluster depends on
Contained Software Instances Depending Upon This DependedUpon:
Dependency:
Dependant:
ContainedSoftwareInstance
 
Contained Software Instances that depend on this Cluster
Databases Depending Upon This DependedUpon:
Dependency:
Dependant:
Database
 
Databases that depend on this Cluster
Details Depending Upon This DependedUpon:
Dependency:
Dependant:
Detail
 
Details that depend on this Cluster
Software Clusters Depending Upon This DependedUpon:
Dependency:
Dependant:
SoftwareCluster
 
Software Clusters that depend on this Cluster
Software Components Depending Upon This DependedUpon:
Dependency:
Dependant:
SoftwareComponent
 
Software Components that depend on this Cluster
Software Containers Depending Upon This DependedUpon:
Dependency:
Dependant:
SoftwareContainer
 
Software Containers that depend on this Cluster
Software Instances Depending Upon This DependedUpon:
Dependency:
Dependant:
SoftwareInstance
 
Software Instances that depend on this Cluster
Software Pods Depending Upon This DependedUpon:
Dependency:
Dependant:
SoftwarePod
 
Software Pods that depend on this Cluster
Virtual Machines Depending Upon This DependedUpon:
Dependency:
Dependant:
VirtualMachine
 
Virtual Machines that depend on this Cluster
Category ElementInCategory:
ElementCategory:
Category:
Category
 
Category
HA Pair Peer:
HighAvailability:
Peer:
Cluster
 
Peer in high availability pair
Member Hosts HostContainer:
HostContainment:
ContainedHost:
Host
 
Hosts that are part of this Cluster
Member Network Devices HostContainer:
HostContainment:
ContainedHost:
NetworkDevice
 
Network Devices that are part of this Cluster
Member Virtual Machines HostContainer:
HostContainment:
ContainedHost:
VirtualMachine
 
Virtual Machines that are part of this Cluster
Member MF Parts HostContainer:
HostContainment:
ContainedHost:
MFPart
 
MF Parts that are part of this Sysplex
Member Coupling Facilities HostContainer:
HostContainment:
CouplingFacility:
CouplingFacility
 
Coupling Facilities that are part of this Sysplex
Managed Services ServiceHost:
HostedService:
RunningService:
ClusterService
 
Services managed by this Cluster
Candidate Software Instances Host:
HostedSoftware:
RunningSoftware:
CandidateSoftwareInstance
 
Candidate Software Instances running on this Cluster
Contained Software Instances Host:
HostedSoftware:
RunningSoftware:
ContainedSoftwareInstance
 
Contained Software Instances running on this Cluster
External Elements Host:
HostedSoftware:
RunningSoftware:
ExternalElement
 
External Elements running on this Cluster
Runtime Environments Host:
HostedSoftware:
RunningSoftware:
RuntimeEnvironment
 
Runtime Environments running on this Cluster
Software Containers Host:
HostedSoftware:
RunningSoftware:
SoftwareContainer
 
Software Containers running on this Cluster
Software Instances Host:
HostedSoftware:
RunningSoftware:
SoftwareInstance
 
Software Instances running on this Cluster
Software Pods Host:
HostedSoftware:
RunningSoftware:
SoftwarePod
 
Software Pods running on this Cluster
Unassigned Connections Host:
HostedSoftware:
RunningSoftware:
UnassignedConnections
 
Unassigned Connections running on this Cluster
Virtual Machines Host:
HostedSoftware:
RunningSoftware:
VirtualMachine
 
Virtual Machines running on this Cluster
Primary Business Application InferredElement:
Inference:
Primary:
BusinessApplicationInstance
 
Business Application from which the existence of this Cluster was inferred
Primary Business Service InferredElement:
Inference:
Primary:
BusinessService
 
Business Service from which the existence of this Cluster was inferred
Primary Technical Service InferredElement:
Inference:
Primary:
TechnicalService
 
Technical Service from which the existence of this Cluster was inferred
Primary Container InferredElement:
Inference:
Primary:
ContainerInfo
 
Container from which the existence of this Cluster was inferred
Primary Contained Software Instance InferredElement:
Inference:
Primary:
ContainedSoftwareInstance
 
Contained Software Instance from which the existence of this Cluster was inferred
Primary Device Info InferredElement:
Inference:
Primary:
DeviceInfo
 
Device Info from which the existence of this Cluster was inferred
Primary Discovered Application Component InferredElement:
Inference:
Primary:
DiscoveredApplicationComponent
 
Discovered Application Component from which the existence of this Cluster was inferred
Primary Discovered Cloud API Result List InferredElement:
Inference:
Primary:
DiscoveredCloudAPIResultList
 
Discovered Cloud API Result List from which the existence of this Cluster was inferred
Primary Discovered Coupling Facility InferredElement:
Inference:
Primary:
DiscoveredCouplingFacility
 
Discovered Coupling Facility from which the existence of this Cluster was inferred
Primary Discovered Database InferredElement:
Inference:
Primary:
DiscoveredDatabase
 
Discovered Database from which the existence of this Cluster was inferred
Primary Discovered Database Detail InferredElement:
Inference:
Primary:
DiscoveredDatabaseDetail
 
Discovered Database Detail from which the existence of this Cluster was inferred
Primary Discovered Directory Entry InferredElement:
Inference:
Primary:
DiscoveredDirectoryEntry
 
Discovered Directory Entry from which the existence of this Cluster was inferred
Primary Discovered Disk Drive InferredElement:
Inference:
Primary:
DiscoveredDiskDrive
 
Discovered Disk Drive from which the existence of this Cluster was inferred
Primary Discovered File InferredElement:
Inference:
Primary:
DiscoveredFile
 
Discovered File from which the existence of this Cluster was inferred
Primary Discovered File System InferredElement:
Inference:
Primary:
DiscoveredFileSystem
 
Discovered File System from which the existence of this Cluster was inferred
Primary Discovered HBA InferredElement:
Inference:
Primary:
DiscoveredHBA
 
Discovered HBA from which the existence of this Cluster was inferred
Primary Discovered IP Address InferredElement:
Inference:
Primary:
DiscoveredIPAddress
 
Discovered IP Address from which the existence of this Cluster was inferred
Primary Listening Port InferredElement:
Inference:
Primary:
DiscoveredListeningPort
 
Listening Port from which the existence of this Cluster was inferred
Primary Discovered MFPart InferredElement:
Inference:
Primary:
DiscoveredMFPart
 
Discovered MFPart from which the existence of this Cluster was inferred
Primary Discovered MQ Detail InferredElement:
Inference:
Primary:
DiscoveredMQDetail
 
Discovered MQ Detail from which the existence of this Cluster was inferred
Primary Discovered Mainframe InferredElement:
Inference:
Primary:
DiscoveredMainframe
 
Discovered Mainframe from which the existence of this Cluster was inferred
Primary Discovered Mainframe View Result InferredElement:
Inference:
Primary:
DiscoveredMainframeViewResult
 
Discovered Mainframe View Result from which the existence of this Cluster was inferred
Primary Discovered Network Interface InferredElement:
Inference:
Primary:
DiscoveredNetworkInterface
 
Discovered Network Interface from which the existence of this Cluster was inferred
Primary Discovered Process InferredElement:
Inference:
Primary:
DiscoveredProcess
 
Discovered Process from which the existence of this Cluster was inferred
Primary Discovered Program InferredElement:
Inference:
Primary:
DiscoveredProgram
 
Discovered Program from which the existence of this Cluster was inferred
Primary Discovered Registry Entry InferredElement:
Inference:
Primary:
DiscoveredRegistryEntry
 
Discovered Registry Entry from which the existence of this Cluster was inferred
Primary Discovered Service InferredElement:
Inference:
Primary:
DiscoveredService
 
Discovered Service from which the existence of this Cluster was inferred
Primary Discovered Software InferredElement:
Inference:
Primary:
DiscoveredSoftware
 
Discovered Software from which the existence of this Cluster was inferred
Primary Discovered Storage Subsystem InferredElement:
Inference:
Primary:
DiscoveredStorageSubsystem
 
Discovered Storage Subsystem from which the existence of this Cluster was inferred
Primary Discovered Sysplex InferredElement:
Inference:
Primary:
DiscoveredSysplex
 
Discovered Sysplex from which the existence of this Cluster was inferred
Primary Discovered Tape Drive InferredElement:
Inference:
Primary:
DiscoveredTapeDrive
 
Discovered Tape Drive from which the existence of this Cluster was inferred
Primary Discovered Transaction InferredElement:
Inference:
Primary:
DiscoveredTransaction
 
Discovered Transaction from which the existence of this Cluster was inferred
Primary Discovered Virtual Machine InferredElement:
Inference:
Primary:
DiscoveredVirtualMachine
 
Discovered Virtual Machine from which the existence of this Cluster was inferred
Primary Host Info InferredElement:
Inference:
Primary:
HostInfo
 
Host Info from which the existence of this Cluster was inferred
Primary MF Part InferredElement:
Inference:
Primary:
MFPart
 
MF Part from which the existence of this Cluster was inferred
Primary Network Connection List InferredElement:
Inference:
Primary:
NetworkConnectionList
 
Network Connection List from which the existence of this Cluster was inferred
Primary Software Component InferredElement:
Inference:
Primary:
SoftwareComponent
 
Software Component from which the existence of this Cluster was inferred
Primary Software Container InferredElement:
Inference:
Primary:
SoftwareContainer
 
Software Container from which the existence of this Cluster was inferred
Primary Software Instance InferredElement:
Inference:
Primary:
SoftwareInstance
 
Software Instance from which the existence of this Cluster was inferred
Location ElementInLocation:
Location:
Location:
Location
 
Location of this Cluster
Maintaining Pattern Element:
Maintainer:
Pattern:
Pattern
 
Pattern maintaining this Cluster
Managed by Cluster ManagedElement:
Management:
Manager:
Cluster
 
Cluster that manages this Cluster
Managed Clusters Manager:
Management:
ManagedElement:
Cluster
 
Clusters that this Cluster manages
Managed by Contained Software Instance ManagedElement:
Management:
Manager:
ContainedSoftwareInstance
 
Contained Software Instance that manages this Cluster
Managed by Network Device ManagedElement:
Management:
Manager:
NetworkDevice
 
Network Device that manages this Cluster
Managed by Software Cluster ManagedElement:
Management:
Manager:
SoftwareCluster
 
Software Cluster that manages this Cluster
Managed by Software Instance ManagedElement:
Management:
Manager:
SoftwareInstance
 
Software Instance that manages this Cluster
Managed Collections Manager:
Management:
ManagedElement:
Collection
 
Collections that this Cluster manages
Managed Administrative Collections Manager:
Management:
ManagedElement:
AdminCollection
 
Administrative Collections that this Cluster manages
Managed Storage Systems Manager:
Management:
ManagedElement:
StorageSystem
 
Storage Systems that this Cluster manages
Managed Storage System Groups Manager:
Management:
ManagedElement:
StorageSystemGroup
 
Storage System Groups that this Cluster manages
Business Owner OwnedItem:
Ownership:
BusinessOwner:
Person
 
The person or owner responsible for this element from a business perspective
IT Owner OwnedItem:
Ownership:
ITOwner:
Person
 
The person or owner responsible for this element from an IT perspective
Support Manager OwnedItem:
Ownership:
SupportOwner:
Person
 
The person or owner responsible for the support of this element
Owner OwnedItem:
Ownership:
Owner:
Person
 
The owner of this element
Containing Business Application ContainedSoftware:
SoftwareContainment:
SoftwareContainer:
BusinessApplicationInstance
 
Containing Business Application
Containing Business Service ContainedSoftware:
SoftwareContainment:
SoftwareContainer:
BusinessService
 
Containing Business Service
Containing Technical Service ContainedSoftware:
SoftwareContainment:
SoftwareContainer:
TechnicalService
 
Containing Technical Service
Cloud Service Service:
SoftwareService:
ServiceProvider:
CloudService
 
Cloud Service that provides this logical cluster
Service Software Cluster Service:
SoftwareService:
ServiceProvider:
SoftwareCluster
 
Software Clusters that provide this logical cluster
Service Software Service:
SoftwareService:
ServiceProvider:
SoftwareInstance
 
Software Instances that provide this logical cluster
Software Support Details ElementWithDetail:
SupportDetail:
SoftwareDetail:
SupportDetail
 
Software Support Details for this Cluster
Attachments AttachmentContainer:
Attachment:
Attachment:
Attachment
 
A file attached to this element
Category ElementInCategory:
ElementCategory:
Category:
Category
 
Category
Family ElementInCategory:
ElementCategory:
Category:
Family
 
Family
Lifecycle Status ElementInCategory:
ElementCategory:
Category:
LifecycleStatus
 
Lifecycle Status
Recovery Time ElementInCategory:
ElementCategory:
Category:
RecoveryTime
 
Recovery Time
Location ElementInLocation:
Location:
Location:
Location
 
Location of this Managed Element
Business Owner OwnedItem:
Ownership:
BusinessOwner:
Person
 
The person or owner responsible for this element from a business perspective
IT Owner OwnedItem:
Ownership:
ITOwner:
Person
 
The person or owner responsible for this element from an IT perspective
Support Manager OwnedItem:
Ownership:
SupportOwner:
Person
 
The person or owner responsible for the support of this element
Owner OwnedItem:
Ownership:
Owner:
Person
 
The owner of this element
Organizational Unit OwnedItem:
Ownership:
Owner:
OrganisationalUnit
 
Organizational Unit that this Managed Element belongs to

Expressions of the Cluster node

The expressions of the Cluster node are described in the following table: {anchor:exprs}

UI Name Expression Description
Number of Members num_members : nodecount(traverse HostContainer:HostContainment:ContainedHost:) Number of members

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*