Index for Section 3

Alphabetical listing for C

Bottom of page

clu_get_ase_enabled(3)
NAME
  clu_get_ase_enabled, clu_get_aseinfo_byname, clu_get_ase_id_byname,
  clu_get_ase_nodes_byname, clu_get_drdsvcs_byname - Obtains information
  about the available server environment (ASE) in which the local member
  system participates (provided on Production Server configurations only)

LIBRARY
  Connection Manager Library (libcnx.a)

SYNOPSIS
  #include <sys/param.h>

  #include <sys/cluster_defs.h>

  int clu_get_ase_enabled (
	  char *name );

  int clu_get_aseinfo_byname (
	  char *name,
	  clu_ase_t *ase_info_p );

  int clu_get_ase_id_byname (
	  char *name,
	  char *bufp,
	  int buf_size );

  int clu_get_ase_nodes_byname (
	  char *name,
	  char *bufp,
	  int buf_size );

  int clu_get_ase_drdsvcs_byname (
	  char *name,
	  char *bufp,
	  int buf_size );

PARAMETERS
  name	    Specifies the host name of the remote node for which the
	    information is requested.  Setting the name parameter to NULL
	    indicates that the information is requested from the local node.

  ase_info_p
	    Specifies the address of a clu_ase_t structure to which
	    clu_get_aseinfo_byname returns information from the indicated
	    node.

  bufp	    Specifies the address of the buffer to receive information from
	    the indicated node.

  buf_size  Specifies the size of the buffer identified by bufp.

DESCRIPTION
  The clu_get_ase_enabled function returns a value of 1 if available server
  environment (ASE) functionality is enabled on the indicated node.  If ASE
  is not enabled, or if it detected an error, it returns a value of zero (0).

  The clu_get_aseinfo_byname function obtains ASE-specific information about
  the indicated node and returns it in a clu_ase_t structure.  The structure
  is defined as follows:

       typedef struct {
	    int ase_domain_id;
       } clu_ase_t;

  The single member of the clu_ase_t structure is the ase_domain_id.  This
  member contains the ASE ID assigned to the cluster node when the cluster
  was configured.  If the node is not participating in an ASE, this field
  contains a -1.

  The clu_get_ase_id_byname, clu_get_ase_nodes_byname, and
  clu_get_ase_drdsvcs_byname functions return the ASE_ID, ASE member list,
  and distributed raw disk (DRD) services list, respectively, from the
  indicated node.

RETURN VALUES
  The clu_get_ase_enabled function returns a value of 1 if ASE is enabled on
  the indicated node.  If ASE is not enabled, or if the function detects an
  error, the function returns a value of zero (0).

  Upon completion, the other functions return one of the following values:

  CLU_SUCCESS
	    The requested information was successfully returned.

  CLU_BADPARAM
	    A required parameter was not specified or was invalid.

  CLU_ERROR The function was unable to return the requested information.

  CLU_IVBUFSIZE
	    The specified buffer is too small to hold the requested data.

  CLU_NOTASE
	    ASE is not enabled on the node indicated by name.

  CLU_NOTMEMBER
	    The node indicated by name is not a cluster member.

  CLU_TRUNCATED
	    The requested data was truncated during collection.

FILES
  /usr/include/sys/cluster_defs.h
	    Cluster information services header file.

  /usr/examples/cluster/cluinfo.c
	    Source file for example demonstrating cluster information
	    services.

  /usr/examples/cluster/cludo.c
	    Source file for example demonstrating cluster information
	    services.

RELATED INFORMATION
  Functions: clu_get_cluster(3), clu_get_clock(3)

  TruCluster Production Server Software Application Programming Interfaces

Index for Section 3

Alphabetical listing for C

Top of page