Home Man
Search
Today's Posts
Register

Linux & Unix Commands - Search Man Pages

OpenSolaris 2009.06 - man page for rt_properties (opensolaris section 5)

rt_properties(5)		    Sun Cluster Miscellaneous			 rt_properties(5)

NAME
       rt_properties - resource-type properties

DESCRIPTION
       The  following  information describes the resource-type properties that are defined by Sun
       Cluster software. These descriptions have been developed for data service developers.  For
       information about a particular data service, see the man page for that data service.

   Resource-Type Property Values
       Required 		   The	property  requires an explicit value in the Resource Type
				   Registration (RTR) file. Otherwise, the object  to  which  the
				   property  belongs  cannot  be  created.  A  blank or the empty
				   string is not allowed as a value.

       Conditional		   To exist, the property must be declared in the RTR file.  Oth-
				   erwise, the RGM does not create the property, and the property
				   is not available to administrative utilities. A blank  or  the
				   empty  string  is  allowed. If the property is declared in the
				   RTR file but no value is specified, the RGM supplies a default
				   value.

       Conditional/Explicit	   To  exist,  the property must be declared in the RTR file with
				   an explicit value. Otherwise, the  RGM  does  not  create  the
				   property  and  the property is not available to administrative
				   utilities. A blank or the empty string is not allowed.

       Optional 		   The property can be declared in the RTR file. If the  property
				   is  not  declared in the RTR file, the RGM creates it and sup-
				   plies a default value. If the property is declared in the  RTR
				   file  but  no  value  is  specified, the RGM supplies the same
				   default value as if the property were not declared in the  RTR
				   file.

       Query-only		   The property cannot be set directly by an administrative util-
				   ity.  The property is not set in the RTR file.  The	value  of
				   the property is provided for information only.

       Note -

	 Resource-type	properties  cannot be updated by administrative utilities with the excep-
	 tion of Installed_nodes and RT_system. Installed_nodes cannot be  declared  in  the  RTR
	 file and can only be set by the cluster administrator. RT_system can be assigned an ini-
	 tial value in the RTR file, and can also be set by the cluster administrator.

   Resource-Type Properties and Descriptions
       A resource type is defined by a resource-type registration file	that  specifies  standard
       and extension property values for the resource type.

       Note -

	 resource-type	property names, such as API_version and Boot, are not case sensitive. You
	 can use any combination of uppercase and lowercase letters  when  you	specify  property
	 names.

       API_version (integer)

	   The	version  of the resource management API that is used by this resource-type imple-
	   mentation.

	   The following information summarizes the maximum API_version that is supported by each
	   release of Sun Cluster software.

	   Before and up to 3.1        2

	   3.1 10/03		       3

	   3.1 4/04		       4

	   3.1 9/04		       5

	   3.1 8/05		       6

	   3.2			       7

	   3.2 12/07		       8

	   Declaring a value for API_version that is greater than 2 in the RTR file prevents that
	   resource type from being installed on a version of Sun Cluster software that  supports
	   a  lower  maximum  version.	For  example, if you declare API_version=7 for a resource
	   type, that resource type cannot be installed on any version of  Sun	Cluster  software
	   that was released before the Sun Cluster 3.2 release.

	   Category	       Optional

	   Default	       2

	   Tunable	       Never

       Boot (string)

	   An optional callback method: the path to the program that the RGM invokes on a node or
	   a zone when the following conditions occur:

	       o      The node or zone joins or rejoins the cluster.

	       o      The resource group that contains the resource of this type is managed.
	   This method is expected to initialize resources of this type as the Init method does.

	   Category	       Conditional/Explicit

	   Default	       None

	   Tunable	       Never

       Failover (boolean)

	   If you set this property to TRUE, resources of this type cannot be configured  in  any
	   group that can be online on multiple nodes or zones at the same time.

	   You	use  this  resource-type property in combination with the Scalable resource prop-
	   erty, as follows:

	      Failover	       Scalable 	     Description
	   --------------------------------------------------------------
	   TRUE 	    TRUE	     Do not specify this illogi-
					     cal combination.
	   TRUE 	    FALSE	     Specify   this  combination
					     for a failover service.
	   FALSE	    TRUE	     Specify  this   combination
					     for a scalable service that
					     uses    a	   SharedAddress
					     resource  for  network load
					     balancing.The  Sun  Cluster
					     Concepts  Guide for Solaris
					     OS describes  SharedAddress
					     in more detail.You can con-
					     figure a scalable	resource
					     group  to	run  in  a  non-
					     global zone.  But,  do  not
					     configure	   a	scalable
					     resource to run in multiple
					     non-global   zones  on  the
					     same node.
	   FALSE	    FALSE	     Use  this	combination   to
					     select  a multi-master ser-
					     vice that does not use net-
					     work load balancing.You can
					     use a scalable  service  of
					     this type in zones.

	   The description for Scalable in r_properties(5) and Chapter 3, Key Concepts for System
	   Administrators and Application Developers, in Sun Cluster Concepts Guide  for  Solaris
	   OS contain additional information.

	   Category	       Optional

	   Default	       FALSE

	   Tunable	       Never

       Fini (string)

	   An  optional  callback  method:  the  path  to the program that the RGM invokes when a
	   resource of this type is removed from RGM management.

	   Category	       Conditional/Explicit

	   Default	       No default

	   Tunable	       Never

       Global_zone (boolean)

	   If you set this property to TRUE for a resource  type,  its	methods  execute  in  the
	   global  zone  under	all circumstances.  If you set this property to TRUE, even if the
	   resource group is running in a non-global zone, the	method	executes  in  the  global
	   zone.   Set	this property to TRUE only for services that can be managed only from the
	   global zone, such as network addresses and file systems.

	   Caution -

	     Do not register a resource type for which the Global_zone property is  set  to  TRUE
	     unless  the  resource type comes from a known and trusted source. Resource types for
	     which this property is set to TRUE circumvent zone isolation and present a risk.
	   The methods of a resource that is configured to start in a non-global zone  and  whose
	   Global_zone	property  is  set  to  TRUE  are  always  run  in the global zone. Such a
	   resource, when configured in a non-global zone, does not benefit from the  CPU  shares
	   and dedicated processor set configuration.  This resource does not benefit even if you
	   set the RG_slm_type property to AUTOMATED. Sun Cluster software treats such a resource
	   as  though it is located in a resource group whose RG_slm_type property is set to MAN-
	   UAL.

	   Because methods for resource types for which the Global_zone property is set  to  TRUE
	   run	in  the  global  zone, the RGM does not immediately consider these resource types
	   offline when a non-global zone dies.  In fact, the RGM  runs  methods  such	as  Moni-
	   tor_stop,  Stop,  and Postnet_stop on these resource types, which include LogicalHost-
	   name, SharedAddress, and HAStoragePlus. However, the RGM considers the  resources  for
	   which  the  Global_zone  property is set to FALSE to be offline when a non-global zone
	   dies. The RGM cannot run stopping methods on such resources because the methods  would
	   have to run in the non-global zone.

	   Category	       Optional

	   Default	       FALSE

	   Tunable	       Never

       Init (string)

	   An  optional  callback  method:  the  path  to the program that the RGM invokes when a
	   resource of this type becomes managed by the RGM.

	   Category	       Conditional/Explicit

	   Default	       No default

	   Tunable	       Never

       Init_nodes (enum)

	   Indicates the nodes or zones on which the RGM is to call the  Init,	Fini,  Boot,  and
	   Validate  methods.  You can set this property to RG_primaries (just the nodes or zones
	   that can master the resource) or RT_installed_nodes (all nodes or zones on  which  the
	   resource type is installed).

	   Category	       Optional

	   Default	       RG_primaries

	   Tunable	       Never

       Installed_nodes (string_array)

	   A  list  of	the names of nodes or zones on which the resource type is allowed to run.
	   The RGM automatically creates this property. The cluster  administrator  can  set  the
	   value. You cannot declare this property in the RTR file.

	   Category	       Can be configured by the cluster administrator

	   Default	       All cluster nodes or zones

	   Tunable	       Any time

       Is_logical_hostname (boolean)

	   TRUE indicates that this resource type is some version of the LogicalHostname resource
	   type that manages failover IP addresses.

	   Category	       Query-only

	   Default	       No default

	   Tunable	       Never

       Is_shared_address (boolean)

	   TRUE indicates that this resource type is some version of the  SharedAddress  resource
	   type that manages shared IP (Internet Protocol) addresses.

	   Category	       Query-only

	   Default	       No default

	   Tunable	       Never

       Monitor_check (string)

	   An optional callback method: the path to the program that the RGM invokes before doing
	   a monitor-requested failover of a resource of this type. If the monitor-check  program
	   exits with nonzero on a node or zone, any attempt to fail over to that node or zone is
	   prevented.

	   Category	       Conditional/Explicit

	   Default	       No default

	   Tunable	       Never

       Monitor_start (string)

	   An optional callback method: the path to the program that the RGM invokes to  start	a
	   fault monitor for a resource of this type.

	   Category	       Conditional/Explicit

	   Default	       No default

	   Tunable	       Never

       Monitor_stop (string)

	   A  callback	method	that is required if Monitor_start is set: the path to the program
	   that the RGM invokes to stop a fault monitor for a resource of this type.

	   Category	       Conditional/Explicit

	   Default	       No default

	   Tunable	       Never

       Pkglist (string_array)

	   An optional list of packages that are included in the resource-type installation.

	   Category	       Conditional/Explicit

	   Default	       No default

	   Tunable	       Never

       Postnet_stop (string)

	   An optional callback method: the path to the program that the RGM invokes after  call-
	   ing	the Stop method of any network-address resources on which a resource of this type
	   depends. This method is expected to perform Stop actions that must be performed  after
	   network interfaces are configured down.

	   Category	       Conditional/Explicit

	   Default	       No default

	   Tunable	       Never

       Prenet_start (string)

	   An optional callback method: the path to the program that the RGM invokes before call-
	   ing the Start method of any network-address resources on which a resource of this type
	   depends.  This  method  is  expected  to  perform Start actions that must be performed
	   before network interfaces are configured up.

	   Category	       Conditional/Explicit

	   Default	       No default

	   Tunable	       Never

       Proxy (boolean)

	   Indicates whether a resource of this type is a proxy resource.

	   A proxy resource is a Sun Cluster resource that imports the state of a  resource  from
	   another  cluster  framework	such  as Oracle Cluster Ready Services (CRS). Oracle CRS,
	   which is now known as Oracle clusterware CRS, is a platform-independent set of  system
	   services for cluster environments.

	   A proxy resource type uses the Prenet_start method to start a daemon that monitors the
	   state of the external (proxied) resource. The Postnet_stop method stops the monitoring
	   daemon.   The       monitoring   daemon  issues  the  scha_control  command	with  the
	   CHANGE_STATE_ONLINE or the CHANGE_STATE_OFFLINE tag to set the proxy resource's  state
	   to  Online or to Offline, respectively. The scha_control() function similarly uses the
	   SCHA_CHANGE_STATE_ONLINE and SCHA_CHANGE_STATE_OFFLINE tags.

	   If you set this property to TRUE, the resource is a proxy resource.

	   Category	       Optional

	   Default	       FALSE

	   Tunable	       Never

       Resource_list (string_array)

	   The list of all resources of the resource type. The administrator does  not	set  this
	   property  directly.	Rather, the RGM updates this property when the administrator adds
	   or removes a resource of this type to or from any resource group.

	   Category	       Query-only

	   Default	       Empty list

	   Tunable	       Never

       Resource_type (string)

	   The name of the resource type. To view the names of the currently registered  resource
	   types, type:

	   clresourcetype list

	   Starting  with the Sun Cluster 3.1 release, a resource-type name includes the version,
	   which is mandatory:

	   vendor_id.resource_type:version

	   The three components of the resource-type name are properties that  are  specified  in
	   the	RTR  file as Vendor_id, Resource_type, and RT_version. The clresourcetype command
	   inserts the period (.)  and	colon  (:)  delimiters.  The  RT_version  suffix  of  the
	   resource-type  name	is  the same value as the RT_version property. To ensure that the
	   Vendor_id is unique, the recommended approach is to use the stock symbol for the  com-
	   pany creating the resource type.

	   Resource-type  names  that were created before the Sun Cluster 3.1 release continue to
	   use this syntax:

	   vendor_id.resource_type

	   Category	       Required

	   Default	       Empty string

	   Tunable	       Never

       RT_basedir (string)

	   The directory path that is used to complete relative paths for callback methods.  This
	   path  is  expected  to be set to the installation location for the resource-type pack-
	   ages. The path must be a complete path, that is, the path must start  with  a  forward
	   slash (/).  This property is not required if all the method path names are absolute.

	   Category	       Required, unless all method path names are absolute

	   Default	       No default

	   Tunable	       Never

       RT_description (string)

	   A brief description of the resource type.

	   Category	       Conditional

	   Default	       Empty string

	   Tunable	       Never

       RT_system (boolean)

	   If  you  set this property to TRUE for a resource type, you cannot delete the resource
	   type (clresourcetype unregister resource_type_name). This property is intended to help
	   prevent  accidental deletion of resource types, such as LogicalHostname, that are used
	   to support the cluster infrastructure. However, you can apply the  RT_system  property
	   to any resource type.

	   To  delete a resource type whose RT_system property is set to TRUE, you must first set
	   the property to FALSE. Use care when you delete a resource type whose  resources  sup-
	   port cluster services.

	   Category	       Optional

	   Default	       FALSE

	   Tunable	       Any time

       RT_version (string)

	   Starting  with the Sun Cluster 3.1 release, a mandatory version string that identifies
	   this resource-type implementation. This property was optional in Sun Cluster 3.0 soft-
	   ware. The RT_version is the suffix component of the full resource-type name.

	   Category	       Conditional/Explicit or Required

	   Default	       No default

	   Tunable	       Never

       Single_instance (boolean)

	   If  you  set  this  property to TRUE, the RGM allows only one resource of this type to
	   exist in the cluster.

	   Category	       Optional

	   Default	       FALSE

	   Tunable	       Never

       Start (string)

	   A callback method: the path to the program that the RGM invokes to start a resource of
	   this type.

	   Category	       Required, unless the RTR file declares a Prenet_start method

	   Default	       No default

	   Tunable	       Never

       Stop (string)

	   A  callback method: the path to the program that the RGM invokes to stop a resource of
	   this type.

	   Category	       Required, unless the RTR file declares a Postnet_stop method

	   Default	       No default

	   Tunable	       Never

       Update (string)

	   An optional callback method: the path to the program that the RGM invokes when proper-
	   ties of a running resource of this type are changed.

	   Category	       Conditional/Explicit

	   Default	       No default

	   Tunable	       Never

       Validate (string)

	   An  optional  callback  method:  the path to the program that the RGM invokes to check
	   values for properties of resources of this type.

	   Category	       Conditional/Explicit

	   Default	       No default

	   Tunable	       Never

       Vendor_ID (string)

	   See the Resource_type property.

	   Category	       Conditional

	   Default	       No default

	   Tunable	       Never

SEE ALSO
       clresource(1CL),  clresourcegroup(1CL),	clresourcetype(1CL),  rt_reg(4),  SUNW.HAStorage-
       Plus(5),  property_attributes(5),  r_properties(5),  rg_properties(5),  scha_control(1HA),
       scha_control(3HA).

       Sun Cluster Concepts Guide for Solaris OS, Sun Cluster Data Services Developer's Guide for
       Solaris OS, Sun Cluster Data Services Planning and Administration Guide for Solaris OS

Sun Cluster 3.2 			   14 Sep 2007				 rt_properties(5)


All times are GMT -4. The time now is 09:53 PM.

Unix & Linux Forums Content Copyrightę1993-2018. All Rights Reserved.
UNIX.COM Login
Username:
Password:  
Show Password