clientコマンド

clientキーワードを指定してコマンドを使用し、Oracle Fleet Patching and Provisioningクライアントを追加、削除および管理します。

rhpctl add client

フリート・パッチ適用およびプロビジョニング・クライアントを、フリート・パッチ適用およびプロビジョニング・サーバー構成に追加します。

構文

rhpctl add client -client cluster_name [-clusternamealias cluster_name_alias] 
[-toclientdata path] [-targetnode node_name {-sudouser sudo_user_name 
-sudopath sudo_binary_location | -root | -cred cred_name} | -auth plugin_name 
[-arg1 name1:value1...]] [-maproles role=user_name 
[,role=user_name[,...]]] [-version version]

パラメータ

表A-7 rhpctl add clientコマンドのパラメータ

パラメータ 説明
-client client_name

クライアントを作成するクラスタの名前を指定します。

ノート:

Oracleでは、クライアント・クラスタの一意の名前を指定することをお薦めします。
-clusternamealias

オプションで、クライアント・クラスタ名が一意でない場合は、クライアント・クラスタの別名を指定できます。

-toclientdata path

必要に応じて、フリート・パッチ適用およびプロビジョニング・サーバーによって作成されるXMLファイルのパスを指定できます(クライアント・クラスタ固有)。このファイルには、クライアントがサーバーとの接続を構成するために必要な情報が含まれます。

-targetnode node_name

必要に応じて、フリート・パッチ適用およびプロビジョニング・クライアントを持たないリモート・クラスタ内のノードの名前を指定できます。

-sudouser sudo_user_name -sudopath sudo_binary_location | -root | -cred cred_name

-targetnodeパラメータを使用するように選択した場合は、sudoまたはrootを選択してリモート・ノードにアクセスする必要があります。

sudoを選択した場合、–sudouserパラメータを使用して、スーパーユーザー操作を実行するユーザー名と、sudoバイナリの場所のパスを指定する必要があります。

必要に応じて、リモート・ノードにアクセスするためのユーザーおよびパスワード資格証明を関連付ける資格証明名を指定する選択ができます。

-auth plugin_name [-arg1 name1:value1...]

–sudouser–root、または–credのかわりに、–authを使用してリモート・ノードにアクセスする認証プラグインを指定することもできます。

-maproles role=user_name[,...]

組込みロールまたはユーザーが定義したロールを指定できます。また、各ロールに複数のユーザーを割り当てることができます。複数のロールおよびユーザーは、カンマを使用して区切ります。

ノート:

Oracle Grid Infrastructure 21c以降、-maprolesパラメータは非推奨になりました。このパラメータは、今後のリリースでサポートが終了する可能性があります。
-version version

オプションで、21.0などのOracle FPPクライアント・ソフトウェアのバージョンを指定できます。

ノート:

Oracle FPPクライアントのバージョンがOracle FPPサーバーのバージョンよりも低い場合は、このパラメータを指定する必要があります。たとえば、クライアント・バージョンが12.2の場合、-versionパラメータを-version 12.2として指定します。

使用上のノート

  • Oracle Grid Infrastructure 12cリリース2 (12.2)以降を実行しているクラスタのみ、フリート・パッチ適用およびプロビジョニング・クライアントとして構成し、追加できます。Oracle Grid Infrastructureの以前のバージョンを実行しているクラスタ、およびOracle Grid Infrastructureを実行していないサーバーは、フリート・パッチ適用およびプロビジョニング・サーバーで直接管理できます。

  • このコマンドは、フリート・パッチ適用およびプロビジョニング・サーバーでのみ実行できます。

フリート・パッチ適用およびプロビジョニング・サーバーにクライアントを追加するには、次のコマンドを実行します。

$ rhpctl add client -client ClientCluster3 -toclientdata Grid_home/RHPserver/info -version 12.2

rhpctl allow client

ユーザーまたはロールがOracle Fleet Patching and Provisioningクライアントまたはリモート・クラスタで操作を実行できるようにします。

構文

rhpctl allow client -client client_name 
   {-user username [-cluster  cluster_name] | -role role_name}

パラメータ

表A-8 rhpctl allow clientコマンドのパラメータ

パラメータ 説明
-client client_name

FPPクライアントまたはリモート・クラスタの名前を指定します。

-user username

オペレーティング・システム(OS)ユーザーの名前を指定します

-cluster cluster_name

必要に応じて、クラスタの名前を指定できます。

-role role_name

ロールの名前を指定します。

使用上のノート

  • Oracle Fleet Patching and Provisioningクライアントまたはリモート・クラスタの名前を指定します。

  • OSユーザーと、オプションでクラスタの名前またはロールの名前を指定します。

    ロールのリストは、rhpctl add roleを参照してください

  • このコマンドはOracle Fleet Patching and Provisioningサーバーでのみ実行できます

rhpctl allow clientを使用したA-1の例

$ rhpctl add role -role SECURE_CLIENT_USER -hasRoles GH_CLIENT_ACCESS 

$ rhpctl disallow client -client secure_rhpc1 -role GH_CLIENT_ACCESS

$ rhpctl allow client -client secure_rhpc1 -role SECURE_CLIENT_USER

$ rhpctl grant role -role SECURE_CLIENT_USER -user secure_user1

rhpctl delete client

特定のフリート・パッチ適用およびプロビジョニング・クライアントを構成から削除します。

構文

rhpctl delete client –client cluster_name [-force]

使用上のノート

  • 構成から削除するクライアント・クラスタの名前を指定します。

  • このコマンドを実行する前、または-forceオプションを使用する前には、フリート・パッチ適用およびプロビジョニング・クライアントを停止する必要があります。

フリート・パッチ適用およびプロビジョニング・クライアントClientCluster3を削除するには、次のようにします。
$ rhpctl delete client -client ClientCluster3

rhpctl disallow client

ユーザーまたはロールがOracle Fleet Patching and Provisioningクライアントまたはリモート・クラスタで操作を実行できないようにします。

構文

rhpctl disallow client -client client_name 
    {-user username [-cluster  cluster_name] | -role role_name}

パラメータ

表A-9 rhpctl disallow clientコマンドのパラメータ

パラメータ 説明
-client client_name

FPPクライアントまたはリモート・クラスタの名前を指定します。

-user username

オペレーティング・システム(OS)ユーザーの名前を指定します

-cluster cluster_name

必要に応じて、クラスタの名前を指定できます。

-role role_name

ロールの名前を指定します。

使用上のノート

  • Oracle Fleet Patching and Provisioningクライアントまたはリモート・クラスタの名前を指定します。

  • OSユーザーと、オプションでクラスタの名前またはロールの名前を指定します。

    ロールのリストは、rhpctl add roleを参照してください

  • このコマンドはOracle Fleet Patching and Provisioningサーバーでのみ実行できます

rhpctl disallow clientを使用したA-2の例

$ rhpctl add role -role SECURE_CLIENT_USER -hasRoles GH_CLIENT_ACCESS 

$ rhpctl disallow client -client secure_rhpc1 -role GH_CLIENT_ACCESS

$ rhpctl allow client -client secure_rhpc1 -role SECURE_CLIENT_USER

$ rhpctl grant role -role SECURE_CLIENT_USER -user secure_user1

rhpctl discover client

入力された内容を検証して、特定のノード上のパラメータを検出し、Oracle Clusterwareの構成に使用できるレスポンス・ファイルを生成します。

このコマンドが完了した後、を使用してレスポンス・ファイルを検証し、Oracle Clusterwareデプロイメントの宛先ノードを準備します。

構文

rhpctl discover client -image image_name -generatepath response_file_path
  {-responsefile response_file_name | -clusternodes node_list -client cluster_name 
   -oraclehome oracle_home_path} {-root | -sudouser sudo_username
   -sudopath sudo_binary_path | -cred cred_name | -auth plugin_name
  [-arg1 name1:value1...]} [-user gi_user_name]
  [-scan scan_name]

パラメータ

表A-10 rhpctl discover clientコマンドのパラメータ

パラメータ 説明
-image image_name

結果のレスポンス・ファイルがサポートするOracle Grid Infrastructureのゴールド・イメージの名前を指定します。

-generatepath response_file_path

RHPCTLにより生成されたレスポンス・ファイルのコピー先のファイル・パスを指定します。RHPCTLコマンドはレスポンス・ファイルの名前を生成し、コマンドの実行中にその名前を表示します。

-responsefile response_file_name

不完全なレスポンス・ファイルがあり、宛先ノードを参照してそれを完了させる場合は、このパラメータを使用してレスポンス・ファイル名を指定します。

ノート: レスポンス・ファイルはノード・リスト、クライアント名およびOracleホーム・パスを含む必要があります。

-clusternodes node_list

(結果のレスポンス・ファイルを使用して)Oracle Clusterwareをプロビジョニングする予定の、カンマ区切りのノードのリストをnode_name:node_vip[:node_role][,node_name:node_vip[:node_role]...]の形式で指定します。

-client cluster_name

プローブするOracle FPPクライアント・クラスタの名前を指定します。

-oraclehome oracle_home_path

Oracleホームの場所を指定します。

-root | -sudouser sudo_username -sudopath sudo_binary_path | -cred cred_name | -auth plugin_name [-arg1 name1:value1...]

sudoまたはrootを選択して、リモート・ノードにアクセスする必要があります。

sudoを選択した場合、スーパーユーザー操作を実行するユーザー名と、sudoバイナリの場所のパスを指定する必要があります。

必要に応じて、リモート・ノードにアクセスするためのユーザーおよびパスワード資格証明を関連付ける資格証明名を指定する選択ができます。

–sudouser–root、または–credのかわりに、–authを使用してリモート・ノードにアクセスする認証プラグインを指定することもできます。

-user gi_user_name

Oracle Grid Infrastructureインストール・ユーザーの名前を指定します。

-scan scan_name

SCAN名を指定します。

rhpctl export client

フリート・パッチ適用およびプロビジョニング・サーバー上のリポジトリからクライアント・データ・ファイルにデータをエクスポートします。

構文

rhpctl export client -client cluster_name -clientdata file_path

パラメータ

表A-11 rhpctl export clientコマンドのパラメータ

パラメータ 説明
-client cluster_name

エクスポートするクライアント・クラスタの名前を指定します。

-clientdata file_path

クライアント・データ・ファイルの場所のパスを指定します。

使用上のノート

このコマンドは、フリート・パッチ適用およびプロビジョニング・サーバーでのみ実行できます。

mjk9394というフリート・パッチ適用およびプロビジョニング・クライアントから、リポジトリ・データをクライアント・データ・ファイル/tmp/mjk9394.xmlにエクスポートするには、次のコマンドを実行します。
$ rhpctl export client -client mjk9394 -clientdata /tmp/mjk9394.xml

rhpctl modify client

Oracle Fleet Patching and Provisioningクライアントを変更します。

構文

rhpctl modify client –client cluster_name [-enabled {TRUE | FALSE}]
  [-maproles role=user_name[+user_name...][,role=user_name[+user_name...],...]]] [-password]]

パラメータ

表A-12 rhpctl modify clientコマンドのパラメータ

パラメータ 説明
-client cluster_name

変更するクライアント・クラスタの名前を指定します。

-enabled {TRUE | FALSE}

クライアントが有効かどうかを指定します。

-maproles role=user_name[+user_name...][,...]

組込みロールまたはユーザーが定義したロールを変更できます。また、各ロールに複数のユーザーを割り当てることができます。

-maprolesパラメータを使用する場合は、プラス記号(+)を使用して、複数のユーザーを特定のロールにマップします。ロールとユーザーのペアを追加する場合はカンマで区切ります。

ノート:

Oracle Grid Infrastructure 21c以降、-maprolesパラメータは非推奨になりました。このパラメータは、今後のリリースでサポートが終了する可能性があります。
-password

オプションで、Oracle Fleet Patching and Provisioningクライアント資格証明を再作成できます。

RHPClient001という名前のOracle Fleet Patching and Provisioningクライアントを無効にするには、次のようにします。

$ rhpctl modify client -client RHPClient001 -enabled FALSE

rhpctl query client

特定のフリート・パッチ適用およびプロビジョニング・クライアント・クラスタの構成情報を表示します。

構文

rhpctl query client [–client cluster_name [-detail [-node node_name] [-displayhtml]]]
  [-rhpserver rhps_regex] [-exadata]

パラメータ

表A-13 rhpctl query clientコマンドのパラメータ

パラメータ 説明
-client cluster_name

フリート・パッチ適用およびプロビジョニング・クライアントが存在するクライアント・クラスタの名前を指定します。

-detail

クラスタのクラスタ情報(HTML)を生成します。

-node node_name

リモート・クラスタ内のノードの名前を指定します。

-displayhtml

クラスタのHTMLクラスタ情報を表示します。

-rhpserver rhps_regex

操作を実行する必要があるサーバーのクラスタ名と一致する正規表現を指定します。

-exadata

Exadataデータベース・ノードを問合せるには、クライアント・タイプをExadataとして指定します。

使用上のノート

構成情報を表示するフリート・パッチ適用およびプロビジョニング・クライアントが存在しているクライアント・クラスタの名前を指定します。

-rhpserverオプションを使用してピア・サーバーに対するコマンドを発行する場合、コマンドを実行するユーザーはピア・サーバーの既存のユーザーであり、必要なロールを持っている必要があります。ピア・サーバーのユーザーがローカル・サーバーでコマンドを実行できるようにするには、rhpctl grant roleコマンドを実行して必要なロールをピア・サーバー・ユーザーに付与し、ユーザーが属しているピア・サーバーのクラスタ名を指定する必要があります。たとえば:

$ rhpctl grant role -role role_name -user user_name -client cluster_name

複数のユーザーを追加するには、次のコマンドを実行します。

$ rhpctl grant role -client cluster_name -maproles role=user_name[+user_name...][,role=user_name[+user_name...]...]

RHPCTLを使用してロールを付与する詳細は、rhpctl grant roleを参照してください

このコマンドでは、次のような出力が表示されます。
/rhpctl query client -client mbcluster-13
Site: mbcluster-13
Fleet Patching and Provisioning Client Version: 12.2.0.1.0
Enabled: true
Host from which RHPC last registered: rhpserver01.example.com
Port number last registered by RHPC: 8896
RHP Enabled: true
Standalone: false
Managed: true
Oracle Exadataデータベース・サーバー・ノードを問い合せ、ライブ・アップデートのステータスを確認するには:
rhpctl query client -client client1 -exadata

Audit ID: 90
Site: client1
Rapid Home Provisioning Client Version: 23.0.0.0.0
Rapid Home Provisioning Client Full Version: 23.6.0.0.0
Enabled: true
Host from which RHPC last registered: client1vm01.example.com
Port number last registered by RHPC: 8896
...
...
Image status: success
Exadata software version: 23.1.7.0.0.231012
Exadata Live Update Type: full
Exadata Live Update Version: 23.1.90.0.0.240226 (Live Update applied. Reboot at any time to finalize outstanding items.)
Node type: GUEST
...
...

rhpctl update client

フリート・パッチ適用およびプロビジョニング・クライアントのイメージを更新します。

構文

rhpctl update client -image image_name {-targetnode node_name 
  | -batches '(node_name)'} -root

パラメータ

表A-14 rhpctl update clientコマンドのパラメータ

パラメータ 説明
-image image_name

更新するイメージの名前を指定します。

-targetnode node_name

フリート・パッチ適用およびプロビジョニング・クライアントを更新するノードの名前を指定します。

-batches '(node_name)'

ノード名を指定するかわりに、ノードのバッチを指定できます。

ノート: Oracle Database Applianceノードでこのパラメータを使用する場合は、コマンドを2回連続で実行し、1回目の実行で1つのOracle Database Applianceノードを指定し、2回目の実行で別のOracle Database Applianceノードを指定します。

–root –targetnodeまたは–batchesパラメータを使用する場合は、このパラメータを指定する必要があります。

使用上のノート

このコマンドは、フリート・パッチ適用およびプロビジョニング・サーバーからのみ実行できます。

次の例では、–targetnodeパラメータを使用します。

$ rhpctl update client -image ODA1 -targetnode rac07box1 -root

次の2つの例では、–batchesパラメータを使用します。

$ rhpctl update client -image ODA1 -batches '(rac07box1)' -root
$ rhpctl update client -image ODA1 -batches '(rac07box2)' -root

rhpctl verify client

入力された内容を検証し、Oracle Clusterwareの構成に使用できるレスポンス・ファイルを作成するか完成させ、その値を検証します。

構文

rhpctl verify client -image image_name -responsefile response_file_name
  [-clusternodes node_list] {-root | -sudouser sudo_username -sudopath
   sudo_binary_path | -cred cred_name} | -auth plugin_name [-arg1 name1:value1...]
  [-user gi_user_name] [-client cluster_name] [-scan scan_name]
  [-oraclehome oracle_home_path] [-ignorewarn] [-fixup [-setupSSH]]

パラメータ

表A-15 rhpctl verify clientコマンドのパラメータ

パラメータ 説明
-image image_name

イメージの名前を指定します。

-responsefile response_file_name

Oracle Grid Infrastructureのプロビジョニングに使用されるレスポンス・ファイルを指定します。

-clusternodes node_list

Oracle Clusterwareをプロビジョニングするノードのカンマ区切りリストを、node_name:node_vip[:node_role][,node_name:node_vip[:node_role]...]の形式で指定します。

-root | -sudouser sudo_username -sudopath sudo_binary_path | -cred cred_name | -auth plugin_name [-arg1 name1:value1...]

sudoまたはrootを選択して、リモート・ノードにアクセスする必要があります。

sudoを選択した場合、スーパーユーザー操作を実行するユーザー名と、sudoバイナリの場所のパスを指定する必要があります。

必要に応じて、リモート・ノードにアクセスするためのユーザーおよびパスワード資格証明を関連付ける資格証明名を指定する選択ができます。

–sudouser–root、または–credのかわりに、–authを使用してリモート・ノードにアクセスする認証プラグインを指定することもできます。

-user gi_user_name

Oracle Grid Infrastructureインストール・ユーザーの名前を指定します。

-client cluster_name

検証するクラスタの名前を指定します。

-scan scan_name

SCAN名を指定します。

-oraclehome oracle_home_path

Oracleホームの場所を指定します。

-ignorewarn

検証中の警告を無視する場合は、このパラメータを使用します。

–fixup [-setupSSH]

このパラメータを使用して、CVUによって推奨される変更を満たすように、変更をノードに自動的に適用する修正スクリプトを実行します。

必要に応じて、プロビジョニング・ユーザーのためにリモート・ノード上にパスワードなしのSSHユーザー等価を設定する場合は、-setupSSHパラメータを使用できます。