Oracle Solaris Cluster リファレンスマニュアル

印刷ビューの終了

更新: 2015 年 9 月
 
 

scds_property_functions (3HA)

名前

scds_property_functions - 一般に使用されるリソースプロパティー、リソースグループプロパティー、リソースタイププロパティー、および拡張プロパティーの値を取得するための関数群

形式

cc [flags…] –I /usr/cluster/include file –L /usr/cluster/lib 
     –l dsdev#include <rgm/libdsdev.h>
     return-value-type scds-get-property-name(scds_handle_t handle);

説明

Data Service Development Library (DSDL) は、一般に使用されるリソースプロパティー、リソースグループプロパティー、リソースタイププロパティー、および拡張プロパティーの値を取得するために使用できる関数群を提供します。scds_get_ext_property(3HA) を使用して、ユーザー定義の拡張プロパティーを取得します。

すべての関数は、次の規則に従うものとします。

  • handle 引数だけを取ります。プロパティー取得関数に渡される handle 引数は、以前の scds_initialize(3HA) 呼び出しによって返されます。

  • 各関数が特定のプロパティーに対応します。

  • 関数の戻り値のタイプは取得するプロパティー値のタイプに一致します。

  • これらの関数は、戻り値が scds_initialize(3HA) で事前に計算されているため、エラーを返しません。ポインタを返す関数では、エラー条件が検出されると (たとえば、scds_initialize() が以前に呼び出されていない場合)、NULL 値が返されます。

  • プロパティーの新しい値が、呼び出し元のプログラム(argv[]) に渡されるコマンド行引数で指定されていると、この新しい値が返されます(Validate メソッドの実装の場合)。この方法で、新しいプロパティーの予想値を実際に設定する前に検証できます。それ以外の場合は、RGM から取得した値が返されます。

  • これらの関数の中には、DSDL に属するメモリーへのポインタを返すものもあります。このメモリーは変更できません。このポインタは、scds_close(3HA) 呼び出しによって無効化されます。

標準プロパティーについては、r_properties(5)rg_properties(5)、および rt_properties(5) のマニュアルページを参照してください。拡張プロパティーについては、個々のデータサービスのマニュアルページを参照してください。

これらの関数によって使用されるデータ型 (scha_prop_type_tscha_extprop_value_tscha_initnodes_flag_tscha_str_array_tscha_failover_mode_tscha_switch_tscha_rsstatus_t など) については、scha_calls(3HA) のマニュアルページおよび scha_types.h ヘッダーファイルを参照してください。

これらの関数は、次の命名規則に従うものとします。

リソースプロパティー

scds_get_rs_property-name

リソースグループプロパティー

scds_get_rg_property-name

リソースタイププロパティー

scds_get_rt_property-name

一般に使用される拡張プロパティー

scds_get_ext_property-name


注 -  プロパティー名には、大文字と小文字の区別はありません。プロパティー名を指定する際には、大文字と小文字を任意に組み合わせることができます。

リソース固有の関数

この関数は、特定のリソースプロパティーの値を返します。一部のプロパティー値は、RTR ファイル内で、または clresource(1CL) コマンドによって明示的に設定されます。その他のプロパティー値は、RGM によって動的に決定されます。関数は、要求されたプロパティーにふさわしいデータ型を返します。

次のリソースの依存関係のクエリー関数には、それぞれ対応する "Q" または "qualified" バージョンがあります。

scds_get_rs_resource_dependencies

scds_get_rs_resource_dependencies_Q

scds_get_rs_resource_dependencies_offline_restart

scds_get_rs_resource_dependencies_Q_offline_restart

scds_get_rs_resource_dependencies_restart

scds_get_rs_resource_dependencies_Q_restart

scds_get_rs_resource_dependencies_weak

scds_get_rs_resource_dependencies_Q_weak

資格を備えたバージョンは、各リソースの依存関係に宣言された有効範囲または修飾子 (ある場合) を返します。{LOCAL_NODE}{ANY_NODE}、および {FROM_RG_AFFINITIES} 修飾子は、r_properties(5) のマニュアルページで説明されています。

Cheap_probe_interval

int scds_get_rs_cheap_probe_interval(scds_handle_t handle)

Failover_mode

scha_failover_mode_t scds_get_rs_failover_mode(scds_handle_t handle)

Monitor_stop_timeout

int scds_get_rs_monitor_stop_timeout(scds_handle_t handle)

Monitored_switch

scha_switch_t scds_get_rs_monitored_switch(scds_handle_t handle)

Network_resources_used

scha_str_array_t * scds_get_rs_network_resources_used(scds_handle_t handle)

On_off_switch

scha_switch_t scds_get_rs_on_off_switch(scds_handle_t handle)

Resource_dependencies

const scha_str_array_t * scds_get_rs_resource_dependencies(scds_handle_t handle)

Resource_dependencies_Q(qualified)

const scha_str_array_t * scds_get_rs_resource_dependencies_Q(scds_handle_t handle)

Resource_dependencies_offline_restart

const scha_str_array_t * scds_get_rs_resource_dependencies_offline_restart(scds_handle_t handle)

Resource_dependencies_Q_offline_restart (qualified)

const scha_str_array_t * scds_get_rs_resource_dependencies_Q_offline_restart(scds_handle_t handle)

Resource_dependencies_restart

const scha_str_array_t * scds_get_rs_resource_dependencies_restart(scds_handle_t handle)

Resource_dependencies_Q_restart (qualified)

const scha_str_array_t * scds_get_rs_resource_dependencies_Q_restart(scds_handle_t handle)

Resource_dependencies_weak

const scha_str_array_t * scds_get_rs_resource_dependencies_weak(scds_handle_t handle)

Resource_dependencies_Q_weak (qualified)

const scha_str_array_t * scds_get_rs_resource_dependencies_Q_weak(scds_handle_t handle)

Resource_project_name

const char * scds_get_rs_resource_project_name(scds_handle_t handle)

Retry_count

int scds_get_rs_retry_count(scds_handle_t handle)

Retry_interval

int scds_get_rs_retry_interval(scds_handle_t handle)

Scalable

boolean scds_get_rs_scalable(scds_handle_t handle)

Start_timeout

int scds_get_rs_start_timeout(scds_handle_t handle)

Stop_timeout

int scds_get_rs_stop_timeout(scds_handle_t handle)

Thorough_probe_interval

int scds_get_rs_thorough_probe_interval(scds_handle_t handle)

リソースグループ固有の関数

この関数は、特定のリソースグループプロパティーの値を返します。一部のプロパティー値は、clresourcegroup(1CL) コマンドによって明示的に設定されます。その他のプロパティー値は、RGM によって動的に決定されます。関数は、要求されたプロパティーにふさわしいデータ型を返します。

Desired_primaries

int scds_get_rg_desired_primaries(scds_handle_t handle)

Global_resources_used

const scha_str_array_t * scds_get_rg_global_resources_used(scds_handle_t handle)

Implicit_network_dependencies

boolean_t scds_get_rg_implicit_network_dependencies(scds_handle_t handle)

Maximum_primaries

int scds_get_rg_maximum_primaries(scds_handle_t handle)

Nodelist

const scha_str_array_t * scds_get_rg_nodelist (scds_handle_t handle)

Pathprefix

const char * scds_get_rg_pathprefix(scds_handle_t handle)

Pingpong_interval

int scds_get_rg_pingpong_interval(scds_handle_t handle)

Resource_list

const scha_str_array_t * scds_get_rg_resource_list(scds_handle_t handle)

RG_affinities

const scha_str_array_t * scds_get_rg_rg_affinities(scds_handle_t handle)

RG_mode

scha_rgmode_t scds_get_rg_rg_mode(scds_handle_t handle)

RG_project_name

const char * scds_get_rg_rg_project_name(scds_handle_t handle)

RG_slm_cpu_shares

int scds_get_rg_rg_slm_cpu_shares(scds_handle_t handle)

RG_slm_pset_min

int scds_get_rg_rg_slm_pset_min(scds_handle_t handle)

RG_slm_pset_type

const char * scds_get_rg_rg_slm_pset_type(scds_handle_t handle)

RG_slm_type

const char * scds_get_rg_rg_slm_type(scds_handle_t handle)

リソースタイプ固有の関数

この関数は、特定のリソースタイププロパティーの値を返します。一部のプロパティー値は、RTR ファイル内で、または clresourcetype(1CL) コマンドによって明示的に設定されます。その他のプロパティー値は、RGM によって動的に決定されます。関数は、要求されたプロパティーにふさわしいデータ型を返します。

API_version

int scds_get_rt_api_version(scds_handle_t handle)

Failover

boolean_t scds_get_rt_failover(scds_handle_t handle)

Init_nodes

scha_initnodes_flag_t scds_get_rt_init_nodes(scds_handle_t handle)

Installed_nodes

const scha_str_array_t * scds_get_rt_installed_nodes(scds_handle_t handle)

RT_basedir

const char * scds_get_rt_rt_basedir(scds_handle_t handle)

RT_version

const char * scds_get_rt_rt_version(scds_handle_t handle)

Single_instance

boolean_t scds_get_rt_single_instance(scds_handle_t handle)

Start_method

const char * scds_get_rt_start_method(scds_handle_t handle)

Stop_method

const char * scds_get_rt_stop_method(scds_handle_t handle)

拡張プロパティー固有の関数

この関数は、特定のリソース拡張プロパティーの値を返します。これらのプロパティー値は、RTR ファイル内で、または clresource(1CL) コマンドによって明示的に設定されます。関数は、要求されたプロパティーにふさわしいデータ型を返します。

リソースタイプでは、ここに記載されている 4 つの拡張プロパティー以外の拡張プロパティーも定義できますが、この 4 つのプロパティーには有用な関数が定義されています。これらのプロパティーは、これらの有用な関数または scds_get_ext_property(3HA) 関数を使用して取得します。その他の拡張プロパティーを取得する場合は、scds_get_ext_property() を使用する必要があります。

Confdir_list

scha_str_array_t * scds_get_ext_confdir_list(scds_handle_t handle)

Monitor_retry_count

int scds_get_ext_monitor_retry_count(scds_handle_t handle)

Monitor_retry_interval

int scds_get_ext_monitor_retry_interval(scds_handle_t handle)

Probe_timeout

int scds_get_ext_probe_timeout(scds_handle_t handle)

パラメータ

すべての有用な関数について、次のパラメータがサポートされています。

handle

scds_initialize(3HA) から返されるハンドルです。

戻り値

関数の戻り値のタイプは取得するプロパティー値のタイプに一致します。

これらの関数は、戻り値が scds_initialize(3HA) で事前に計算されているため、エラーを返しません。ポインタを返す関数では、エラー条件が検出されると (たとえば、scds_initialize() が以前に呼び出されていない場合)、NULL 値が返されます。

ファイル

/usr/cluster/include/rgm/libdsdev.h

インクルードファイル

/usr/cluster/lib/libdsdev.so

ライブラリ

属性

次の属性については、attributes(5) を参照してください。

属性タイプ
属性値
使用条件
ha-cluster/developer/api
インタフェースの安定性
発展中

関連項目

clresource(1CL), clresourcegroup(1CL), clresourcetype(1CL), scds_close(3HA), scds_get_ext_property(3HA), scds_get_port_list(3HA), scds_get_resource_group_name(3HA ), scds_get_resource_name(3HA), scds_get_resource_type_name(3HA ), scds_initialize(3HA), scha_calls(3HA), attributes(5), r_properties(5), rg_properties(5), および rt_properties(5)