Non-Interactive CLSCRS APIs

You can use non-interactive CLSCRS APIs for functions such as context initialization, preparing request payloads for interactive APIs, and post-processing output of the interactive APIs. The non-interactive CLSCRS APIs do not call the CRSD.

A callback error reporting mechanism is not available for the non-interactive CLSCRS APIs. All interactive CLSCRS APIs, except clscrs_stat2, clscrs_stat3, and all clscrs_whatif_* APIs, use this callback mechanism. Clients of these APIs also use the callback mechanism to receive error, warning, and progress messages from the CRSD.

You can also use filters to reduce the list of Oracle Clusterware entities. You can also use filters in the interactive APIs to reduce the list of Oracle Clusterware entities.

Thread Safety

The routines provided to manage API data structures cannot be used with the same API context in multiple threads concurrently; however, no thread-affinity on the part of the client is required. If a separate API context is used in each instance, then a process may invoke these routines on multiple threads.

See Also:

"Error Handling and Tracing", "Callback Mechanism", and "Filters" for more information

Table H-3 describes the non-interactive CLSCRS APIs.

Table H-3 Non-Interactive CLSCRS APIs

C API	Description
clscrs_action_getentity	Returns the entity for the action.
clscrs_action_getparams	Returns the list of parameters for the action.
clscrs_action_gettype	Returns the type for the action.
clscrs_actionlist_count	Counts the number of actions in the action list.
clscrs_actionlist_create	Creates an action list.
clscrs_actionlist_destroy	Destroys the action list.
clscrs_actionlist_first	Returns the first action in an action list.
clscrs_actionlist_next	Returns the next action in an action list.
clscrs_actionlist_print	Prints the action list.
clscrs_actionlist_seqid	Returns the sequence ID for the action lists
clscrs_compfilter_create	Constructs a simple filter that compares two values.
clscrs_crsentity_attr_count	Counts the number of attributes for an entity.
clscrs_crsentity_create	Creates a new entity (allocates memory).
clscrs_crsentity_destroy	Destroys an entity and frees up memory.
clscrs_crsentity_get_attr	Obtains the value of an entity, server pool, or server attribute.
clscrs_crsentity_get_attr_list	Obtains the attribute list for an entity, resource type, server pool, or server.
clscrs_crsentity_get_crsentitylist	Obtains the entity list for an entity.
clscrs_crsentity_get_name	Obtains the name of an entity.
clscrs_crsentity_get_node_list	Obtains a list of nodes currently hosting the entity.
clscrs_crsentity_get_op_status	Obtains the status of an operation for an entity.
clscrs_crsentity_get_registered	Obtains the registration status of an entity.
clscrs_crsentity_set_attr	Sets an attribute for an entity and a server pool.
clscrs_crsentity_set_attr_list	Sets the attribute list for an entity, resource type, server pool, or server.
clscrs_crsentity_set_crsentitylist	Sets the resource list for an entity.
clscrs_crsentitylist_append	Adds an entity to an entity list.
clscrs_crsentitylist_count	Counts the number of entities in an entity list.
clscrs_crsentitylist_create	Creates a list of entities.
clscrs_crsentitylist_delete_crsentity	Deletes an entity matching a given name from an entity list.
clscrs_crsentitylist_destroy	Destroys an entity list and frees up memory.
clscrs_crsentitylist_find	Finds an entity in an entity list matching a given name.
clscrs_crsentitylist_first	Obtains the first entity on an entity list.
clscrs_crslist_next	Obtains the current next entity from an entity list.
clscrs_entity_id_create	Creates an entity identifier that identifies an Oracle Clusterware entity such as a resource, resource type, server group, and so on.
clscrs_entity_id_destroy	Frees the memory associated with an entity identifier created from `clscrs_entity_id_create()`.
clscrs_exprfilter_create	Constructs an expression filter from comparison or expression filters, or both.
clscrs_filter_destroy	Frees the memory for a filter.
clscrs_get_entity_type	Obtains the entity type corresponding to the entity identifier provided.
clscrs_get_fixed_attrlist	Obtains the list of attributes that correspond to an attribute group identifier.
clscrs_get_resource_instance_details	Obtains the resource instance details, such as resource name, cardinality, and degree, from the resource instance identifier that is used.
clscrs_getnodename	Obtains the node name.
clscrs_init_crs	Initializes a context for communications with Oracle Clusterware.
clscrs_sp_get	Obtains the name and value components of a stringpair.
clscrs_sp_get_value	Obtains the value component of a stringpair.
clscrs_sp_set	Changes the value part of a stringpair.
clscrs_splist_append	Adds a new stringpair (`sp`) to a stringpair list (`splist`).
clscrs_splist_count	Counts the number of stringpairs (`sp`) in a stringpair list (`splist`).
clscrs_splist_create	Creates a new stringpair list.
clscrs_splist_create_and_set	Creates a new stringpair list (`splist`) and set the name and value for the first stringpair in the list.
clscrs_splist_delete_sp	Deletes a stringpair (`sp`) from a stringpair list (`splist`).
clscrs_splist_destroy	Frees the memory for a stringpair list (`splist`).
clscrs_splist_find	Finds the value for a stringpair (`sp`) in a stringpair list (`splist`).
clscrs_splist_first	Obtains the first stringpair (`sp`) from a stringpair list (`splist`).
clscrs_splist_next	Obtains the current next stringpair (`sp`) from a stringpair list (`splist`). Current next stringpair is effectively the next stringpair in the stringpair list. The list iterator is stored within the API and is not exposed.
clscrs_splist_replace	Replaces the value for a stringpair (`sp`) in a stringpair list (`splist`).
clscrs_term_crs	Releases a context for communications with Oracle Clusterware.
clscrs_type_create	Creates a new resource type.
clscrs_type_get_attr	Obtains the value/properties of a resource type attribute.
clscrs_type_set_attr	Adds an attribute to a resource type.