Default language.

Important This documentation space contains information about the on-premises version of BMC Helix Discovery. If you are using the SaaS version of BMC Helix Discovery, see BMC Helix Discovery (SaaS).

Cluster Service node



A Cluster Service node represents a service that is managed by a given cluster. This node contains the IP addresses and DNS names, which is used by clients of the service for access purposes. The Cluster Service nodes are fully owned and controlled by BMC Discovery patterns. For detailed information about patterns, see the The-Pattern-Language-TPL and Configipedia.

Cluster Service node lifecycle

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

Create

The Cluster Service node is created by patterns when it detects a host in a cluster configuration during the discovery scan, A relationship link is automatically created to the Cluster node that is managing the services. Additionally, relationships are created to the Cluster Resource node that defines and creates the service and to the Software Instance node that implements the service. The generated key for a Cluster Service node is entirely dependent on the kind of Cluster. 

Update

The update procedure for a Cluster Service node is also fully owned and managed by patterns. When the pattern has identified a cluster service, it calculates a key. If a Cluster Service node with that key already exists, the node is updated accordingly.

Remove

You can remove a Cluster Service node manually or automatically. The Cluster Service node is removed automatically when the Cluster Member node is removed through a cascade removal. Alternatively, the Cluster Service node is removed by the pattern if the Cluster Member is physically or logically removed from the configuration. For more information about cascade removal, see Cascade Removal.

To manually remove a Cluster Resource node:

  1. Search for the necessary Cluster Member.
  2. List the Services for the selected Cluster Member node.
  3. Select the Cluster Service  from the list
  4. Pick Destroy from the Actions list.

Attributes and relationships of the ClusterService node

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

UI Name
Attribute Name and Type

Description

Name
name : string

Name of the service

Instance ID
instance_id : string

Internal Identifier of member

Type
type : string

Type of service

Description
description : string

Description of the service

Status
status : string

Status of the service

IPv4 addresses
ipv4_addrs : list:string

The IPv4 addresses of this service

IPv6 addresses
ipv6_addrs : list:string

The IPv6 addresses of this service

DNS Names
dns_names : list:string

DNS names for this service

Failover
failover : boolean

Whether the service supports failover between members

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

UI Name

Relationship

Description

Cluster Resources

Container:
 Containment:
 Contained:
 ClusterResource

Cluster Resources contained in this Cluster Service

IPv4 Addresses

DeviceWithAddress:
 DeviceAddress:
 IPv4Address:
 IPAddress

IPv4 addresses of this Cluster Service

IPv6 Addresses

DeviceWithAddress:
 DeviceAddress:
 IPv6Address:
 IPAddress

IPv6 addresses of this Cluster Service

Cluster

RunningService:
 HostedService:
 ServiceHost:
 Cluster

Cluster that is managing this Cluster Service

Active Members

RunningService:
 HostedService:
 ServiceHost:
 ClusterMember

Cluster Members that this service is currently running on

Databases

Service:
 SoftwareService:
 ServiceProvider:
 Database

Databases that make up this service

Software Instances

Service:
 SoftwareService:
 ServiceProvider:
 SoftwareInstance

Software Instances that make up this service

 

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