Skip Navigation Links
Exit Print View
| Oracle Solaris Cluster Reference Manual Oracle Solaris Cluster 4.1

Search Scope:

- This Document
- Entire Library

### SUNW.Event

- resource type implementation for the Cluster Reconfiguration Notification Protocol (CRNP)

## Description

The `SUNW.Event` resource type implementation provides highly available CRNP services on Oracle Solaris Cluster. This implementation makes the notification daemon (`/usr/cluster/lib/sc/cl_apid`) highly available by managing it as a resource under the Oracle Solaris Cluster resource group manager (RGM). The resource group that contains the `SUNW.Event` resource must have a network resource configured in the same resource group. Only a single resource of type `SUNW.Event` should exist on a cluster.

You can run the CRNP only in the global zone.

### Standard Properties

This section describes key standard properties that control the behavior of the implementation. You use the `clresource` command to set these properties on a `SUNW.Event` resource. The `r_properties`(5) man page describes these resource properties in more detail.

`Network_resources_used` (`string_array`)

  A list of logical-hostname or shared-address network resources upon which this resource has a dependency. This list contains all network-address resources that appear in the properties `Resource_dependencies`, `Resource_dependencies_weak`, `Resource_dependencies_restart`, or `Resource_dependencies_offline_restart`.

  This property is updated automatically by the RGM, based on the setting of the resource-dependencies properties. You do not set this property directly. Instead, use the `Resource_dependencies` property.

  Category

    Conditional/Optional

  Default

    The empty list

  Tunable

    When disabled

`Port_list` (`string_array`)

  A comma-separated list of port numbers on which the server is listening. The `r_properties`(5) man page describes `Port_list` in more detail.

  Category

    Conditional/Required

  Default

    9444/tcp

  Tunable

    When disabled

`Resource_dependencies` (`string array`)

  A list of resources upon which a resource depends. This list includes any logical-hostname or shared-address network resources that are used by a resource. The default value for this property is null. You must specify this property if the application needs to bind to one or more specific addresses. If no network resource dependencies are specified, the application listens on all addresses.

  Before you create the event resource, a `LogicalHostname` or `SharedAddress` resource must already be configured.

  You can specify one or more resource names. Each network resource can contain one or more logical hostnames. See the `clreslogicalhostname`(1CL) and `clressharedaddress`(1CL) man pages for more information.

  You can specify an alternate kind of dependency by using the `Resource_dependencies_weak`, `Resource_dependencies_restart`, or `Resource_dependencies_offline_restart` property instead of the `Resource_dependencies` property. For more information, see the `r_properties`(5) man page.

  Category

    Optional

  Default

    The empty list

  Tunable

    Any time

`Retry_count` (`integer`)

  The number of times that a monitor attempts to restart a resource if it fails. The `r_properties`(5) man page describes `Retry_count` in more detail.

  Note - If you specify a negative value for this property, the monitor attempts to restart the resource an unlimited number of times.

  Category

    Conditional

  Default

    2

  Maximum

    10

  Tunable

    Anytime

`Retry_interval` (`integer`)

  The number of seconds over which to count attempts to restart a failed resource. The `r_properties`(5) man page describes `Retry_interval` in more detail.

  Category

    Conditional

  Default

    300

  Maximum

    3600

  Tunable

    Anytime

`Thorough_probe_interval` (`integer`)

  The number of seconds between invocations of a high overhead fault probe of the resource. The `r_properties`(5) man page describes `Thorough_probe_interval` in more detail.

  Category

    Conditional

  Default

    60

  Maximum

    3600

  Tunable

    Anytime

### Extension Properties

This section describes key extension properties that control the behavior of the implementation.

`Allow_hosts` (`string_array`)

  This property controls the set of clients that are allowed to register with the implementation to receive cluster reconfiguration events. The general form of this property is `ipaddress/masklength`, which defines a subnet from which the clients are allowed to register. For example, the setting `129.99.77.0/24` allows clients on the subnet `129.99.77` to register for events. As another example, `192.9.84.231/32` allows only the client `192.9.84.231` to register for events.

  In addition, the following special keywords are recognized:

  - `LOCAL` refers to all clients that are located in directly connected subnets of the cluster.

  - `ALL` allows all clients to register.

    Note - If a client matches an entry in both the `Allow_hosts` and the `Deny_hosts` property, that client is prevented from registering with the implementation.

  Category

    Optional

  Default

    `LOCAL`

  Tunable

    Anytime

`Client_retry_count` (`integer`)

  This property controls the number of attempts made by the implementation while communicating with external clients. If a client fails to respond within `Client_retry_count` attempts, the client times out. The client is subsequently removed from the list of registered clients that are eligible to receive cluster reconfiguration events. The client must reregister in order to start receiving events again. The section about the `Client_retry_interval` property describes how often these retries are made by the implementation.

  Category

    Optional

  Default

    3

  Minimum

    1

  Tunable

    Anytime

`Client_retry_interval` (`integer`)

  This property defines the time period (in seconds) used by the implementation while communicating with unresponsive external clients. Up to `Client_retry_count` attempts are made during this interval to contact the client.

  The value for this property can be modified at any time.

  Category

    Optional

  Default

    1800

  Minimum

    30

  Tunable

    Anytime

`Client_timeout` (`integer`)

  This property is the timeout value (in seconds) that is used by the implementation while communicating with external clients. However, the implementation continues to attempt to contact the client for a tunable number of times. The sections about the `Client_retry_count` and `Client_retry_interval` properties describe the means of tuning this property.

  Category

    Optional

  Default

    60

  Minimum

    30

  Tunable

    Anytime

`Deny_hosts` (`string_array`)

  This property controls the set of clients that are prevented from registering to receive cluster reconfiguration events. To determine access, the settings on this property take precedence over those in the `Allow_hosts` list. The format of this property is the same as the format that is defined in the `Allow_hosts`.

  Category

    Optional

  Default

    `NULL`

  Tunable

    Any time

`Max_clients` (`integer`)

  This property controls the maximum number of clients that can register with the implementation to receive notification of cluster events. Attempts by additional clients to register for events are rejected by the implementation. Since each client registration uses resources on the cluster, tuning this property allows users to control resource usage on the cluster by external clients.

  Category

    Optional

  Default

    1000

  Minimum

    1

  Tunable

    When disabled

## Examples

Example 1 Creating a `SUNW.Event` Resource With Default Properties

This example shows how to create a failover `SUNW.Event` resource that is named `CRNP` in an existing resource group that is named `events-rg`. The `events-rg` resource group contains a `LogicalHostname` or `SharedAddress` resource, which identifies the failover hostname that is associated with the resource group.

    # clresourcetype register SUNW.Event
    # clresource create -g events-rg -t SUNW.Event CRNP

In this example, the `SUNW.Event` resource that is created is named `CRNP`. This resource listens on port 9444 and allows all clients on directly connected subnets to register for events.

Example 2 Creating a `SUNW.Event` Resource With Non-Default Properties

This example shows how to create a `SUNW.Event` resource that is named `CRNP` in a resource group that is named `events-rg`. The `CRNP` resource is configured to listen on port 7000, and a specific network resource `foo-1`, which is already configured in the `events-rg` resource group. This CRNP resource allows clients on subnet `192.9.77.0` and clients on directly connected subnets to register, but disallows the client `192.9.77.98` from using the implementation.

    # clresource create -g events-rg -t SUNW.Event \
    -p Port_list=7000/tcp -p Network_resources_used=foo-1 \
    -p Allow_hosts=LOCAL,192.9.77.0/24 \
    -p Deny_hosts=192.9.77.98/32 CRNP

## Files

`/usr/cluster/lib/sc/cl_apid`

  CRNP daemon.

`/usr/cluster/lib/sc/events/dtds`

  Directory that contains data type definitions for the CRNP protocol.

## Attributes

See `attributes`(5) for descriptions of the following attributes.

ATTRIBUTE TYPE | ATTRIBUTE VALUE
--- | ---
Availability | ha-cluster/system/core

## See Also

`clresource`(1CL), `clresourcegroup`(1CL), `clresourcetype`(1CL), `scha_resource_get`(1HA), `attributes`(5), `r_properties`(5)

Copyright © 2000, 2012, Oracle and/or its affiliates. All rights reserved. Legal Notices |