property_attributes(5) [opensolaris man page]
property_attributes(5) Sun Cluster Miscellaneous property_attributes(5) NAME
property_attributes - resource property attributes DESCRIPTION
The list below describes the resource property attributes that you can use to change system-defined properties or create extension proper- ties. You cannot specify NULL or the empty string ("") as the default value for Boolean, Enum, or Int types. Array_maxsize For Stringarray type, the maximum number of array elements permitted. Array_minsize For Stringarray type, the minimum number of array elements that is permitted. Default Indicates a default value for the property. Description A string annotation intended to be a brief description of the property. The description attribute cannot be set in the RTR file for system-defined properties. Enumlist For an Enum type, a set of string values permitted for the property. Extension If used, indicates that the RTR file entry declares an extension property defined by the resource type implementation. Otherwise, the entry is a system-defined property. Max For an Int type, the maximum value permitted for the property. Note that you cannot specify a maximum value for a method timeout. Maxlength For String and Stringarray types, the maximum string length that is permitted. Min For an Int type, the minimal value permitted for the property. Note that you cannot specify Min=0 for a method timeout. Minlength For String and Stringarray types, the minimum string length permitted. Per_node If used, indicates that the extension property can be set on a per-node or a per-zone basis. If you specify the Per_node property attribute in a type definition, you must specify a default value with the Default property attribute as well. Specifying a default value ensures that a value is returned when a user requests a per-node or per-zone property value on a node or zone to which an explicit value has not been assigned. Property The name of the resource property. Property Type Allowed types are: String, Boolean, Int, Enum, and Stringarray. You cannot set the type attribute in an RTR file entry for system- defined properties. The type determines acceptable property values and the type-specific attributes that are allowed in the RTR file entry. An Enum type is a set of string values. Tunable Indicates when the cluster administrator can set the value of this property in a resource. Can be set to None or False to prevent the administrator from setting the property. Values that allow administrator tuning are: True or Anytime (at any time), At_creation (only when the resource is created), or When_disabled (when the resource is offline). The default is True (Anytime). EXAMPLES
Example 1 An Int Type Definition An Int type definition might look like this: { Property = Probe_timeout; Extension; Int; Default = 30; Tunable = Anytime; Description = "Time out value for the probe (seconds)"; } Example 2 A Per_node Type Definition A Per_node type definition might look like this: { Property = LogLevel; Extension; Enum { Off, Terse, Verbose }; Default = Terse; Per_node; Tunable = At_creation; Description ="Controls the level of detail for logging"; } If you specify the PER_NODE property attribute in a type definition, you must specify a default value with the DEFAULT property attribute as well. SEE ALSO
clresource(1CL), clresourcegroup(1CL), clresourcetype(1CL), r_properties(5) rg_properties(5), rt_properties(5) Sun Cluster 3.2 31 Jul 2007 property_attributes(5)
Check Out this Related Man Page
scds_get_ext_property(3HA) Sun Cluster HA and Data Services scds_get_ext_property(3HA) NAME
scds_get_ext_property - retrieve an extension property SYNOPSIS
cc [flags...] -I /usr/cluster/include file -L /usr/cluster/lib -l dsdev #include <rgm/libdsdev.h> scha_err_t scds_get_ext_property(scds_handle_t handle, const char *property_name, scha_prop_type_t property_type, scha_extprop_value_t **property_value DESCRIPTION
The scds_get_ext_property() function retrieves the value of a given extension property. The name of the property is first looked up in the list of properties specified in the method argument list ( argv[], which was parsed by scds_initialize()). If the property name is not in the method argument list, it is retrieved using the Sun Cluster API. See scha_calls(3HA). Upon successful completion, the value of the property is placed in the appropriate variable in the union in a scha_extprop_value_t struc- ture and a pointer to this structure is passed back to the caller in property_value. You are responsible for freeing memory by using scds_free_ext_property(). You can find information about the data types scha_prop_type_t and scha_extprop_value_t in scha_calls(3HA) and in the <scha_types.h> header file. DSDL provides convenience functions to retrieve the values of some of the more commonly used resource extension properties. See the scds_property_functions(3HA) man page. PARAMETERS
The following parameters are supported: handle The handle returned from scds_initialize(3HA) property_name Name of the property being retrieved property_type Property value type. Valid types are defined in scha_calls(3HA) and property_attributes(5). property_value Pointer to a property value RETURN VALUES
The scds_get_ext_property() function returns the following values: 0 The function succeeded. nonzero The function failed. ERRORS
SCHA_ERR_PROP RTR file does not define the specified property. SCHA_ERR_NOERR The function succeeded. Other values Indicate that the function failed. See scha_calls(3HA) for the meaning of the failure codes. EXAMPLES
Example 1 Using scds_get_ext_property() #include <scha_types.h> #include <libdsdev.h> #define INT_EXT_PROP "Int_extension_property" ... int retCode; scha_extprop_value_t *intExtProp; int retrievedValue; ... retCode = scds_get_ext_property(handle, INT_EXT_PROP, SCHA_PTYPE_INT, &intExtProp); if (retCode != SCHA_ERR_NOERR) { scds_syslog(LOG_ERR, "Failed to retrieve the extension property %s: %s.", INT_EXT_PROP, scds_error_string(retCode)); ... } else { retrievedValue = intExtProp->val.val_int; ... scds_free_ext_property(intExtProp); ... } ... FILES
/usr/cluster/include/rgm/libdsdev.h Include file /usr/cluster/lib/libdsdev.so Library ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Availability |SUNWscdev | +-----------------------------+-----------------------------+ |Interface Stability |Evolving | +-----------------------------+-----------------------------+ SEE ALSO
scds_free_ext_property(3HA), scds_initialize(3HA), scds_property_functions(3HA), scha_calls(3HA), rt_reg(4), attributes(5), prop- erty_attributes(5) NOTES
Only the values of extension properties that are defined in the RTR file can be retrieved by using this function. See rt_reg(4). Sun Cluster 3.2 7 Sep 2007 scds_get_ext_property(3HA)