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

印刷ビューの終了

更新: 2014 年 7 月、E51742-01
 
 

clpstring (1CL)

名前

clpstring, clps - Oracle Solaris Cluster プライベート文字列の管理

形式

/usr/cluster/bin/clpstring -V
/usr/cluster/bin/clpstring subcommand -?
/usr/cluster/bin/clpstring subcommand [options] -v [pstring-name[...]
/usr/cluster/bin/clpstring create -b object-instance [-f 
     stringvalue-file] [-t object-type] [-Z {zoneclustername | global}] 
     pstring-name
/usr/cluster/bin/clpstring delete [-F] [-Z {zoneclustername[,...] | 
     global | all}] + | pstring-name ...
/usr/cluster/bin/clpstring list [-b object-instance[,...]] [-t 
     type[,...]] [-Z {zoneclustername[,...] | global | all}] [+ | 
     pstring-name[...]]
/usr/cluster/bin/clpstring set [-f stringvalue-file] [-Z 
     {zoneclustername | global}] pstring-name
/usr/cluster/bin/clpstring show [-b object-instance[,...]] [-t 
     type[,...]] [-Z {zoneclustername[,...] | global | all}] [+ | 
     pstring-name[...]]

説明

clpstring コマンドは、Oracle Solaris Cluster プライベート文字列を管理します。プライベート文字列は一意の名前で識別され、scha_cluster_get(1HA) コマンドを使用してのみ取得可能なエンコードされた値が含まれます。

プライベート文字列は、リソースなどのクラスタオブジェクトで使用され、非公開の値をセキュアに保管および取得します。一般的な用途には、エージェントで使用される内部パスワードがあります。

clps コマンドは clpstring コマンドの短い形式です。clpstring コマンドと clps コマンドは同じものです。どちらの形式のコマンドも使用できます。

このコマンドの一般的な形式は次のとおりです。

clpstring [subcommand] [options] [operands]

options–? または –V オプションを指定する場合だけは、subcommand を省略できます。

このコマンドの各オプションには、長い形式と短い形式があります。各オプションの両方の形式は、このマニュアルページの「オプション」セクションのオプションの説明で紹介されています。

    clpstring コマンドは、次の管理タスクに使用します:

  • 存在またはまだ存在しない可能性のあるクラスタオブジェクトインスタンスで使用するためのプライベート文字列を作成する

  • プライベート文字列の値を更新する

  • プライベート文字列をクラスタ構成から削除する

  • プライベート文字列の仕様を表示する

clpstring コマンドは、アクティブなクラスタノードのみで実行できます。コマンドの実行結果は、実行するノードに関係なく常に同じです。

clpstring コマンドのすべてのサブコマンドは、大域ゾーンとゾーンクラスタの両方で実行できます。大域ゾーンで実行する場合、–Z オプションを使用すると、操作を制限する特定のゾーンクラスタの名前を指定できます。

グローバルクラスタノードからすべてのゾーンクラスタ情報にアクセスできますが、個別のゾーンクラスタはほかのゾーンクラスタを認識しません。特定のゾーンクラスタに操作を制限できない場合、使用するサブコマンドは現在のクラスタでのみ機能します。

サブコマンド

サポートされるサブコマンドには次のものがあります。

create

Oracle Solaris Cluster オブジェクトインスタンスで使用するためのプライベート文字列を作成します。

このプライベート文字列を使用するクラスタオブジェクトインスタンスを指定するには、-b オプションを使用します。オブジェクトインスタンスがクラスタ構成に存在しなくても、そのインスタンスのプライベート文字列を作成できます。クラスタオブジェクトインスタンスのタイプを指定するには、-t オプションを使用します。デフォルトのオブジェクト型は resource です。

プライベート文字列の値を含むファイルを指定するには、-f オプションを使用します。-f が指定されていない場合は、コマンドによって、プライベート文字列の値を指定するように求められます。詳細は オプション セクションで確認できます。

スーパーユーザー以外のユーザーが create サブコマンドを使用するには、solaris.cluster.modify 役割に基づくアクセス制御 (RBAC) の承認が必要です。詳細は、rbac(5) のマニュアルページを参照してください。

delete サブコマンドの説明も参照してください。

delete

Oracle Solaris Cluster 構成の指定したプライベート文字列を削除します。

force オプションの -F を指定しない場合は、プライベート文字列が作成されたクラスタオブジェクトインスタンスをすでに削除している必要があります。-F オプションを指定すると、関連付けられたオブジェクトインスタンスがクラスタ構成にまだ存在し、プライベート文字列を使用している場合でも、コマンドによってプライベート文字列が削除されます。詳細は、オプション の -F を参照してください。

スーパーユーザー以外のユーザーが delete サブコマンドを使用するには、solaris.cluster.modify RBAC の承認が必要です。

create サブコマンドの説明も参照してください。

list

クラスタに作成されたすべてのプライベート文字列を表示しますが、その値は表示しません。

スーパーユーザー以外のユーザーがこのサブコマンドを使用するには、solaris.cluster.read RBAC の承認が必要です。

set

指定したプライベート文字列の値を設定します。-f オプションを使用すると、プライベート文字列の値のソースを指定できます。-f が指定されていない場合は、コマンドによって値が求められます。プライベート文字列の値については、オプション セクションの -f の説明を参照してください。

スーパーユーザー以外のユーザーがこのサブコマンドを使用するには、solaris.cluster.modify RBAC の承認が必要です。

show

プライベート文字列の仕様を表示しますが、その値は表示しません。仕様には、プライベート文字列の名前、それに関連するオブジェクトインスタンス、およびインスタンスのオブジェクト型が含まれます。

スーパーユーザー以外のユーザーがこのサブコマンドを使用するには、solaris.cluster.read RBAC の承認が必要です。

オプション

次のオプションがサポートされています。

–?
–-help

ヘルプ情報を表示します。このオプションを使用する場合、ほかの処理は実行されません。

このオプションを指定するとき、サブコマンドは指定してもしなくてもかまいません。

サブコマンドなしでこのオプションを指定すると、このコマンドのサブコマンドのリストが表示されます。

サブコマンド付きでこのオプションを指定すると、サブコマンドの使用方法が表示されます。

–b object-instance
–-object-instance=object-instance
–-object-instance object-instance

プライベート文字列を使用または使用を目的とするオブジェクトインスタンスの名前を指定します。オブジェクト型が resource のオブジェクトインスタンスのみが現在サポートされています。

–F
–-force

指定したプライベート文字列を強制的に削除します。このオプションは、delete サブコマンドの場合にだけ指定できます。

このオプションを delete サブコマンドとともに使用する場合、指定したプライベート文字列を使用するオブジェクトインスタンスがクラスタにまだ存在する場合でも、このプライベート文字列を削除します。プライベート文字列を削除する前に、クラスタからオブジェクトインスタンスを通常どおりに削除します。

–f stringvalue-file
–-stringvalue-file=stringvalue-file
–-stringvalue-file stringvalue-file

プライベート文字列の値を含むファイルを指定します。ファイル名は、コマンドを実行するノードからアクセスできるフルパスである必要があります。

セキュリティー上の理由により、プライベート文字列の値はコマンド行オプションには指定できません。値のセキュリティーを維持するには、値をテキストファイルに格納し、–f オプションを使用して、このファイルのフルパスを指定します。文字列値のファイルの所有者を root にし、ファイルの読み取り可能アクセス権を root のみに設定して、グループからも一般ユーザーからもアクセスできないようにします。セキュリティーをさらに強化するために、コマンドを実行して値をプライベート文字列に設定したら、ファイルを削除できます。

–f オプションを指定しない場合は、同じ値が入力されたことを確認するために、コマンドによって、プライベート文字列の値を 2 回入力するように求められます。エコーを無効にした制御端末から値を読み取ります。

–f - (–f の後に空白とダッシュ) を指定すると、プライベート文字列の値を標準入力から 1 回のみ直接読み取ることができます。プライベート文字列の値は、入力時に画面でエコーされるか、コマンドがスクリプト化されている場合はスクリプトに表示されるため、プライベート文字列の値をこのように設定する場合は注意してください。

    プライベート文字列の値の入力には次の要件があります:

  • 文字列の長さは 257 文字以下にする必要があります。

  • この文字列に NULL 文字を含めることはできません。

–t object-type
–-object-type=object-type
–-object-type object-type

オブジェクトインスタンスのタイプを指定します。デフォルトタイプは resource で、現在はプライベート文字列を使用できる唯一のオブジェクト型であるため、–t オプションは必要ありません。

–V
–-version

コマンドのバージョンを表示します。

このオプションには、サブコマンドやオペランドなどのオプションは指定しないでください。サブコマンドやオペランドなどのオプションは無視されます。–V オプションは、コマンドのバージョンだけを表示します。その他の処理は行いません。

–v
–-verbose

詳細メッセージを標準出力に表示します。

このオプションは、このコマンドの任意の形式とともに指定できます。

–Z {zoneclustername | global | all}
–-zoneclustername={zoneclustername | global | all}

プライベート文字列を作成するクラスタまたはプライベート文字列が存在するクラスタを指定します。

このオプションは、すべてのサブコマンドでサポートされています。

このオプションを指定する場合は、次のいずれかの引数も指定する必要があります。

zoneclustername

このオプションを使用するコマンドが、zoneclustername という名前のゾーンクラスタ内でのみ、指定されたすべてのプライベート文字列で機能するように指定します。

global

このオプションを使用するコマンドが、グローバルクラスタでのみ、指定されたすべてのプライベート文字列で機能するように指定します。

all

広域クラスタでこの引数を使用する場合、それを使用するコマンドが広域クラスタとすべてのゾーンクラスタを含め、すべてのクラスタで指定されたすべてのリソースで機能するように指定します。

オペランド

次のオペランドだけがサポートされています。

pstring-name

プライベート文字列の名前を指定します。プライベート文字列を作成する場合は、指定する名前がクラスタ全体で一意である必要があります。サブコマンドで複数のプライベート文字列を受け入れる場合、すべてのプライベート文字列を指定するには、pstring-name の代わりに、プラス記号 (+) を使用できます。

終了ステータス

指定したすべてのオペランドでコマンドが成功すると、コマンドはゼロ (CL_NOERR) を返します。あるオペランドでエラーが発生すると、コマンドはオペランドリストの次のオペランドを処理します。戻り値は常に、最初に発生したエラーを反映します。

次の終了コードが返されます。

0 CL_NOERR

エラーなし

実行したコマンドは正常に終了しました。

1 CL_ENOMEM

十分なスワップ空間がありません。

クラスタノードがスワップメモリーまたはその他のオペレーティングシステムリソースを使い果たしました。

3 CL_EINVAL

無効な引数

コマンドを間違って入力したか、–i オプションで指定したクラスタ構成情報の構文が間違っていました。

6 CL_EACCESS

アクセス権がありません

指定したオブジェクトにアクセスできません。このコマンドを実行するには、スーパーユーザーまたは RBAC アクセスが必要である可能性があります。詳細は、su(1M)、および rbac(5) のマニュアルページを参照してください。

18 CL_EINTERNAL

内部エラーが発生しました

内部エラーは、ソフトウェアの欠陥またはその他の欠陥を示しています。

36 CL_ENOENT

そのようなオブジェクトはありません。

次のいずれかの理由のために、指定したオブジェクトを見つけることができません。

  • オブジェクトが存在しません。

  • –o オプションで作成しようとした構成ファイルへのパスのディレクトリが存在しません。

  • –i オプションでアクセスしようとした構成ファイルにエラーが含まれています。

37 CL_EOP

操作が許可されていません

サポートされていない構成に対する操作を実行しようとしたか、サポートされていない操作を実行しました。

39 CL_EEXIST

オブジェクトは存在します。

指定したデバイス、デバイスグループ、クラスタインターコネクトコンポーネント、ノード、クラスタ、リソース、リソースタイプ、リソースグループ、またはプライベート文字列はすでに存在します。

41 CL_ETYPE

無効なタイプです

–t または –p オプションで指定したタイプは存在しません。

これらの終了値は、scha_calls(3HA) のマニュアルページで説明されているリターンコードと互換性があります。

使用例 1 グローバルクラスタまたはゾーンクラスタのリソースにプライベート文字列を作成する

次のコマンドは、リソースインスタンスのプライベート文字列をグローバルクラスタに作成します。

# clpstring create -b resource1 -t resource -v pstring1
Enter string value: 
Enter string value again: 
Private string "pstring1" is created for the global cluster.

次のコマンドは大域ゾーンで実行され、zc1 という名前のゾーンクラスタにプライベート文字列を作成します。プライベート文字列の値は、/pvalue.file ファイルで指定されます。

# clpstring create -Z zc1 -b resource2 -f /pvalue.file pstring2
使用例 2 グローバルクラスタまたはゾーンクラスタの構成からのプライベート文字列の削除

次のコマンドは、オブジェクトインスタンスがクラスタにまだ存在するかどうかに関係なく、クラスタ構成からすべてのプライベート文字列を削除します。

# clpstring delete -F +

次のコマンドは、zc1 という名前のゾーンクラスタから、指定したプライベート文字列を削除します。

# clpstring delete -Z zc1 pstring1
使用例 3 クラスタに作成されたプライベート文字列の仕様の表示

次のコマンドは、クラスタ内のプライベート文字列を表示します。

# clpstring show
=== Private Strings ===                        

Pstring Name:                                   pstring1
  Object Instance:                                 resource1
  Object Type:                                     resource

Pstring Name:                                   pstring2
  Object Instance:                                 object2
  Object Type:                                     resource

使用例 4 グローバルクラスタとゾーンクラスタのプライベート文字列の一覧表示

次のコマンドは、グローバルクラスタおよびすべてのゾーンクラスタ内のプライベート文字列の名前を表示します。

# clpstring list -Z all
global:pstring1
global:pstring2
zc1:pstring1
zc1:pstring2
zc2:pstring

属性

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

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

関連項目

Intro(1CL), cluster(1CL), scha_calls(3HA), attributes(5), rbac(5)

スーパーユーザーはこのコマンドのすべての形式を実行できます。

任意のユーザーは次のオプションを指定してこのコマンドを実行できます。

  • –? オプション

  • –V オプション

サブコマンドを指定してこのコマンドを実行する場合、スーパーユーザー以外のユーザーは RBAC の承認が必要です。次の表を参照してください。

サブコマンド
RBAC の承認
create
solaris.cluster.modify
delete
solaris.cluster.modify
list
solaris.cluster.read
set
solaris.cluster.modify
show
solaris.cluster.read