Skip Navigation Links
Exit Print View
| Oracle Solaris Cluster 4.1 Release Notes Oracle Solaris Cluster 4.1

Search Scope:

- This Document
- Entire Library

## `ORCL.otd`(5) Man Page

`ORCL.otd`, `otd` - resource type implementation for Oracle Traffic Director

### Description

The `ORCL.otd` resource type represents the Oracle Traffic Director application in an Oracle Solaris Cluster configuration.

The `ORCL.otd` resource type is a multi-master resource. It supports being configured in one of two modes. Although both modes allow the server instances to run on multiple nodes simultaneously, the difference is in the way the clients connect to the server instances. In the first mode, where logical hosts are used, the requests are received by the node that has the logical host resource online. In the second mode, where shared addresses are used, the load balancing feature of the Oracle Solaris Cluster software is used to distribute incoming client requests to the different instances. You can increase the utilization of the server instances by using multiple logical hosts.

The`ORCL.otd` resource type executes the following Oracle Traffic Director commands as the `userid` that owns the commands.

- $ORACLE_HOME/lib/parsexml

- $INSTANCE_HOME/bin/startserv

- $INSTANCE_HOME/bin/stopserv

The Oracle Traffic Director instance is started by the resource under the same `userid`. These commands are executable by the owner and are not writable by anyone except the owner.

You must set the following properties on an `ORCL.otd` resource by using `clresource`(1CL).

### Standard Properties

The standard resource properties, `Scalable`, `Network_resources_used`, `Port_list`, `Load_balancing_policy`, and `Load_balancing_weights`, are common to all scalable resource types. The properties controlling the behavior of the shared address load balancing feature, such as `Scalable`, `Network_resources_used`, `Port_list`, `Load_balancing_policy`, and `Load_balancing_weights`, are only applicable when the `ORCL.otd` resource type is configured with a shared address.

See `r_properties`(5) for a complete description of the following resource properties.

`Load_balancing_policy`
  Category

    `Optional`

  Data type

    String

  Default

    `Lb_weighted`

  Tunable

    `At creation`

`Load_balancing_weights`
  Category

    `Optional`

  Data type

    String array

  Default

    `NULL`

  Tunable

    Any time

`Network_resources_used`
  Category

    `Conditional/Optional`

  Data type

    String array

  Default

    `Null`

  Tunable

    At creation

`Resource_dependencies`
  Category

    `Optional`

  Default

    `Null`

  Data type

    String array

  Tunable

    Any time

`Port_list`
  Category

    `Required`

  Data type

    String array

  Default

    `80/tcp`

  Tunable

    When disabled

`Retry_count`
  Category

    `Conditional`

  Minimum

    `0`

  Maximum

    `10`

  Default

    `2`

  Tunable

    Any time

`Retry_interval`
  Category

    `Conditional`

  Minimum

    `0`

  Maximum

    `3600`

  Default

    `620`

  Tunable

    Any time

`Thorough_probe_interval`
  Category

    `Conditional`

  Minimum

    `0`

  Maximum

    `3600`

  Default

    `60`

  Tunable

    Any time

### Extension Properties

`Oracle_home`
  Category

    `Required`

  Data type

    String

  Default

    `---not set---`

  Tunable

    When disabled

  This property is a per-node string of the Oracle Traffic Director installation home directory path name. You must specify this property for each node at resource creation time.

`Instance_home`
  Category

    `Required`

  Data type

    String

  Default

    `---not set---`

  Tunable

    When disabled

  This property is a per-node string of the Oracle Traffic Director instance directory path name. You must specify this property for each node at resource creation time.

`Server_URL`
  Category

    `Required`

  Data type

    String

  Default

    `Null`

  Tunable

    Any time

  By default, the Oracle Traffic Director server instance is probed either through the `localhost:port` when a logical host is used, or the `shared_address:port` when a shared address is used.

  This property allows you to specify an alternate URL to monitor the Oracle Traffic Director server instance. The fault monitor periodically runs the `HTTP GET` command for the URL specified and takes action if the HTTP request returns with response code `500 "Internal Server Error"`, or if the application server does not respond within the configured timeout period.

`Monitor_retry_count`
  Category

    `Required`

  Data type

    Integer

  Minimum

    `-1`

  Default

    `4`

  Tunable

    Any time

  Controls the restarts of the fault monitor. This property indicates the number of times the fault monitor is restarted by the process monitor facility and corresponds to the `-n` option passed to the `pmfadm`(1M) command. The number of restarts is counted in a specified time window. See the `Monitor_retry_interval` property for more information. Note that this property refers to the restarts of the fault monitor itself, not the web server. The restarts of the web server are controlled by the system-defined properties `Thorough_probe_interval`, `Retry_interval`, and `Retry_count`, as specified in their descriptions. See the `clresource`(1CL) man page for more information. You can modify the value for this property at any time.

`Monitor_retry_interval`
  Category

    `Required`

  Data type

    Integer

  Minimum

    `-1`

  Default

    `2`

  Tunable

    Any time

  Indicates the time in minutes, over which the failures of the fault monitor are counted, and corresponds to the `-t` option passed to the `pmfadm`(1M) command. If the number of times the fault monitor fails exceeds the value of `Monitor_retry_count`, the fault monitor is not restarted by the Process Monitor Facility. You can modify the value for this property at any time.

`Probe_timeout`
  Category

    `Required`

  Data type

    Integer

  Minimum

    `15`

  Default

    `90`

  Tunable

    Any time

  This property is the time-out value, in seconds, that is used by the fault monitor to probe an Oracle Traffic Director instance. You can modify the value for this property at any time.

`Num_probes`
  Category

    `Required`

  Data type

    Integer

  Minimum

    `1`

  Default

    `2`

  Tunable

    Any time

  This property indicates the number of times that the fault monitor can timeout while probing before taking action on an Oracle Traffic Director server instance. You can modify the value for this property at any time.

### Examples

The following assumptions are made for all the examples in this section.

The Oracle Traffic Director software is installed on a clustered file system in the `/global/otd/otd-home` directory as follows:

- The clustered file system is in a separate resource, `otd-gfs-rs`.

- The resource group is `otd-hasp-rg`.

- The mount point is `/global/otd`.

The Oracle Traffic Director server `Instance_home` directories are located on the same clustered file system as the installation, but each node has its own server `Instance_home` directory. For the examples in this section, the nodes and directories are as follows:

    node1: /global/otd/otd-1/net-otd-a
    node2: /global/otd/otd-2/net-otd-a
    node3: /global/otd/otd-3/net-otd-a
    node4: /global/otd/otd-4/net-otd-a

Use the following command to register the Oracle Traffic Director resource type:

    # clresourcetype register ORCL.otd

Example A-1 Creating an Oracle Traffic Director Resource for Use With a Logical Host

This example creates an Oracle Traffic Director resource, `otd-rs`, in a resource group, `otd-rg`. It is configured to run simultaneously on all the four nodes of a four-node cluster.

In an agent configuration where a logical host is being used, the Oracle Traffic Director server instances must be configured to listen on all addresses, `INADDR_ANY`, which allows the fault monitor to connect to the `localhost` address of each node using the default `Port_List`, `80/tcp`. The clients use the IP addresses as configured in a logical host resource, `lh-rs`, which is contained in the resource group, `lh-rg`. The hostname `otd-a-lh` is configured in the naming service used by the cluster and in any of the clients that will be accessing the server instances.

To create a logical host in this example:

    # clresourcegroup create -p Nodelist="node1,node2,node3,node4"
    -p Failback=True lh-rg \
    # clreslogicalhostname create -g lh-rg -h otd-a-lh lh-rs \
    # clresourcegroup online -eM lh-rg

To facilitate the automatic failover of the logical host to a node that has a running instance of Oracle Traffic Director:

- The logical host resource group must have a strong positive affinity with failover delegation to the Oracle Traffic Director resource group.

- The logical host resource must also have an offline-restart dependency on the Oracle Traffic Director resource with a local-node scope.

To create the Oracle Traffic Director resource group and resource, do the following:

    # clresourcegroup create -S otd-rg \
    # clresourcetype register ORCL.otd \
    # clresource create -g otd-rg -t ORCL.otd \
    -p ORACLE_HOME=/global/otd/otd-home \
    -p INSTANCE_HOME{node1}=/global/otd/otd-1/net-otd-a \
    -p INSTANCE_HOME{node2}=/global/otd/otd-2/net-otd-a \
    -p INSTANCE_HOME{node3}=/global/otd/otd-3/net-otd-a \
    -p INSTANCE_HOME{node4}=/global/otd/otd-4/net-otd-a \
    -p Resource_dependencies_offline_restart=otd-gfs-rs \
    -p Port_List=80/tcp otd-rs \
    # clresourcegroup set -p RG_affinities+=+++otd-rg lh-rg \
    # clresource set -p Resource_dependencies_offline_restart+=otd-rs{local_node} lh-rs

Example A-2 Creating an Oracle Traffic Director Resource for Use With a Shared Address

This example creates an Oracle Traffic Director `otd-rs` resource named `otd-rg` in a resource group named `web-rg`, which is configured to run simultaneously on all four nodes of a four-node cluster.

The Oracle Traffic Director server instances are configured to listen on port 80 and uses the IP addresses as configured in a `SharedAddress` resource named `sa-rs`, which is contained in the resource group `sa-rg`. The hostname `otd-a-sa`, is configured in the naming service used by the cluster and any of the clients that will be accessing the server instances.

To create the shared address resource group and resource for this example, do the following:

    # clresourcegroup create sa-rg \
    # clressharedaddress create -g sa-rg -h otd-a-sa sa-rs \
    # clresourcegroup online -eM sa-rg

To create the Oracle Traffic Director resource group and resource, do the following:

    # clresourcegroup create -S otd-rg \
    # clresourcetype register ORCL.otd \
    # clresource create -g otd-rg -t ORCL.otd \
    -p ORACLE_HOME=/global/otd/otd-home \
    -p INSTANCE_HOME{node1}=/global/otd/otd-1/net-otd-a \
    -p INSTANCE_HOME{node2}=/global/otd/otd-2/net-otd-a \
    -p INSTANCE_HOME{node3}=/global/otd/otd-3/net-otd-a \
    -p INSTANCE_HOME{node4}=/global/otd/otd-4/net-otd-a \
    -p Resource_dependencies_offline_restart=otd-gfs-rs \
    -p Resource_dependencies=sa-rs \
    -p Port_List=80/tcp \
    -p Scalable=True \
    otd-rs

Example A-3 Setting up an Alternate Monitoring `Server_URL`

To configure the agent fault monitor to probe a specific URL, specify the URL to be probed in the `Server_URL` extension property.

The following example shows how to set the Server_URL extension property. In this case, the Oracle Traffic Director server instances are configured to have the statistics monitoring enabled and set to the `http://localhost:80/stats-xml` URL.

    # clresource set -p server_url="http://localhost:80/stats-xml" \
    otd-rs

### Attributes

See `attributes`(5) for description of the following attribute:

ATTRIBUTE TYPE | ATTRIBUTE VALUE
--- | ---
Availability | `ha-cluster/data-service/ORCLscotd`

### See Also

`clresource`(1CL), `clressharedaddress`(1CL), `clreslogicalhostname`(1CL), `clresourcetype`(1CL), `clresourcegroup`(1CL), `pmfadm`(1M), `attributes`(5), `r_properties`(5), `scalable_service`(5)

Oracle Solaris Cluster Data Services Planning and Administration Guide

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