ALTER CREDENTIALSTORE

このコマンドは、ユーザー名およびパスワードとともに接続の詳細が格納されたデータベース資格証明を含む資格証明ストア別名を作成するために使用します。資格証明ストアの別名は、デプロイメント内でデータベース接続を確立するために使用できます。

MA Webインタフェースからのデータベース接続を構成するには、データベース資格証明の追加と変更を参照してください。

資格証明ストアの使用は、NonStopプラットフォームではサポートされていません。

構文

ALTER CREDENTIALSTORE 
{ADD USER {userid|userid@dbhost:dbport/dbname[;connection_options]|userid@odbc-dsn
|DELETE USER userid| REPLACE USER userid}
[ALIAS alias]
[Domain domain]
[PASSWORD password|NOPASSWORD]

ADD USER {userid|userid@dbhost:dbport/dbname[;connection_options]|userid@odbc-dsn}

userid

指定したユーザーを資格証明ストアの別名に追加します。ALIASオプションを使用しない場合、別名はuseridの名前にデフォルト設定されます。DOMAINオプションを指定しない場合、ドメインはOracleGoldenGateドメインにデフォルト設定されます。CDBとPDBでユーザーが異なるマルチテナントOracleデータベースの場合、資格証明ストアにデータベース・ユーザーを追加するときに@tns_service_nameを指定する必要があります。

userid@dbhost:dbport/dbname[;connection_options]

Oracleデータベース、MySQL、SQL Server、PostgreSQL、Db2など、接続文字列をサポートするデータベースの場合、指定したユーザーおよび接続情報を資格証明ストア別名に追加します。接続文字列情報には、データベース・サーバー名、データベース・ポートおよびデータベース名が含まれている必要があります。接続文字列に追加できる追加の接続オプションを(データベースごとに)次に示します:

データベース接続の詳細を指定して別名を作成する際には、ALIASオプションが必要です

必要な接続フォーマットは次のとおりです:

userid@databasehost:databaseport/databasename;option1;option2;option3

たとえば:

ALTER CREDENTIALSTORE ADD USER ggadmin@server_west:1434/sourcedb 
PASSWORD ***** ALIAS SourceMSSQLConnection

userid @ odbc-dsn

Db2 for i Series、Db2 LUW、Db2 z/OS、SQL ServerおよびPostgreSQLなど、ODBCを介したDSN接続をサポートするデータベースの場合、DSN接続情報を資格証明ストアに追加します。DSN接続の詳細がシステムに(たとえば、Linux用のodbc.iniファイルに、またはODBCデータ・ソースの64ビット・クライアントを使用してWindowsで作成されたシステムDSNとして)存在している必要があります。

DSNを指定して別名を作成する際には、ALIASオプションが必要です。

必要な接続フォーマットは次のとおりです:

userid@odbc-dsn

たとえば:

ALTER CREDENTIALSTORE ADD USER ggadmin@sourcedsn 
PASSWORD ***** ALIAS SourceMSSQLConnection

DELETE USER userid

指定したユーザー、別名およびドメインの資格証明別名を削除します。ALIASオプションを指定しない場合、別名はuseridの名前にデフォルト設定されます。DOMAINオプションを指定しない場合、資格証明ストアはOracleGoldenGateドメインにデフォルト設定されます。

たとえば:

ALTER CREDENTIALSTORE DELETE USER ggadmin ALIAS src_user

REPLACE USER userid

指定した別名のユーザーを置換します。既存のユーザーのパスワードの変更にも使用できます。ALIASオプションを指定しない場合、別名はuseridの名前にデフォルト設定されます。DOMAINオプションを指定しない場合、資格証明ストアはOracleGoldenGateドメインにデフォルト設定されます。

PASSWORDオプションを使用しない場合、指定したユーザーのパスワードを入力するよう求められます。データベース接続情報を含むユーザーのパスワードを変更する際には、現在のuseridの完全な値を含める必要があります。そうしないと、このコマンドにより、ユーザーは指定した新しい値に置換されます。

次の例は、既存のユーザーggadmin@sourcedsn、別名SourceMSSQLConnectionのパスワードを変更する方法を示しています。

ALTER CREDENTIALSTORE REPLACE USER ggadmin@sourcedsn PASSWORD newpassword 
ALIAS SourceMSSQLConnection

この例は、pdbeast別名のユーザーggadminを新しいユーザーに変更する方法を示しています。変更の際には、パスワードの入力を求められます。

ALTER CREDENTIALSTORE REPLACE USER ggadmin ALIAS pdbeast DOMAIN Production

ALIAS alias: ユーザー名に対して別名を指定します。ユーザー名をパラメータ・ファイルまたはコマンドに指定したくない場合にはこのオプションを使用します。ALIASを指定しない場合、別名はデフォルトでUSERの名前になり、ログインが必要な場合に、これがパラメータ・ファイルおよびコマンドで使用される必要があります。ADD USERオプションをALIASとともに使用することで、ユーザーに対し、それぞれが異なる別名を含む複数のエントリを作成できます。

Connection Options

これらは、SSL属性など、資格証明別名に追加できるオプションの接続文字列設定です。これらは、セミコロンで区切られた属性のリストとして指定する必要があります。たとえば、option1=value1;option2=value2;option3=value3で、ここでのoptionは、データベース固有のプロパティとその使用可能な値です。

SSL属性など、資格証明別名に追加できるその他の接続文字列オプションのリストを次に示します。

ノート:

Oracle GoldenGate Microservices Architectureは、特定のSSLパラメータを環境変数として構成することで、SSL接続をサポートします。ただし、この構成により、ExtractおよびReplicatプロセスがデプロイメントに定義されたSSL環境変数のみを使用して接続するように制限され、他のSSL接続や非SSL接続は不可能になります。しかし、資格証明ストアの別名を使用することで、同じデプロイメント内で様々なデータベース接続用に様々なSSLパラメータや非SSLパラメータで資格証明を構成できる柔軟性も得られます。

sslCA

MySQLおよびPostgreSQL専用。PEM形式のSSL証明書の信頼性を検証するために使用される証明書。

sslCert

MySQLおよびPostgreSQL用。PEM形式のクライアントのSSL証明書ファイル。

sslCrl

MySQL用。PEM形式の証明書失効リストを含むファイルの名前。

sslKey

MySQLおよびPostgreSQL用。PEM形式のクライアントの秘密キー・ファイル。

sslMode

MySQLおよびPostgreSQL用。sslModeパラメータ値は、大文字のみで指定します。MySQLのsslModeオプションは、VERIFY_IDENTITY、VERIFY_CA, REQUIRED、PREFERREDです。PostgreSQLのsslModeオプションは、VERIFY-FULL、VERIFY-CA, REQUIRE、PREFERです。

sslMode=VERIFY_IDENTITYの場合、sslPath、sslCa、sslCertおよびsslKeyを指定する必要があります。sslMode=VERIFY_CAの場合、sslPathおよびsslCaを指定する必要があります。

sslPath

MySQL専用。PEM形式の信頼できるSSL認証局(CA)証明書ファイルが格納されるディレクトリのパス。

DOMAIN domain

指定したドメイン名に資格証明別名を保存します。

デフォルト・ドメインはOracleGoldenGateです。一意のドメイン名を選択することで、同じ資格証明ストアを使用する複数のOracle GoldenGateインストールで同じ別名を使用できます。たとえば、システム1の管理者が、システム1で使用されるのと同じ資格証明をシステム2にアクセスさせたくない場合があります。このような資格証明は、たとえばDOMAIN system1の下にALIAS pdbeastとして保存できます。一方で異なる資格証明のセットをDOMAIN system2の下のALIAS pdbeastに保存できます。

NOPASSWORD | PASSWORD password

ユーザーのパスワードは、PASSWORDオプションを使用して指定します。このオプションを使用すると、パスワードはエコーされます(不明瞭化されません)。このオプションを省略すると、コマンドはパスワードを要求しますが、入力時に不明瞭化されます(より安全な方法として推奨されます)。

Oracle GoldenGate 23aiでは、パスワードの最大長1024バイトがサポートされています。

Kerberos認証またはIDCSを使用するなどの外部認証ではパスワードは必要ないため、外部認証を使用する場合は、NOPASSWORDオプションがPASSWORDオプションのかわりになります。NOPASSWORDオプションを設定すると、パスワードを使用せずにDBLOGINコマンドを使用してデータベースにアクセスできます。

Oracle GoldenGateリファレンスのUSERIDALIASパラメータも参照してください。

例

Oracle

この例では、ggadminというユーザーが追加されますが、PASSWORDの指定は省略されているため、プラガブル・データベースpdbeastのパスワードを入力するよう求められます。

ALTER CREDENTIALSTORE ADD USER ggadmin
Password: ********

この例では、ユーザーggadminをそのパスワードtigerを使用して追加し、別名をpdbeastとして指定します。

ALTER CREDENTIALSTORE ADD USER ggadmin PASSWORD tiger ALIAS pdbeast

この例では、ユーザーggadminをOracleGoldenGateのドメインに追加します。

ALTER CREDENTIALSTORE ADD USER ggadmin@dbnorth ALIAS pdbeast DOMAIN OracleGoldenGate
Password: ********

この例では、簡易接続ネーミング・メソッドを使用してユーザーggadminを追加します。

ALTER CREDENTIALSTORE ADD USER ggadmin@dbnorth:1521/dbservice_north
ALIAS pdbnorth

この例では、2つのALTER CREDENTIALSTOREコマンドを発行し、それぞれがggadminエントリを追加しますが別名は異なります。

ALTER CREDENTIALSTORE ADD USER ggadmin@dbeast ALIAS pdbeast
Password: ********
ALTER CREDENTIALSTORE ADD USER ggadmin@dbwest ALIAS pdbwest
Password: ********

次に、DELETE USERオプションの、ALIASオプションがある場合とない場合の動作を示します。

次のコマンドは、ALIASがユーザー名と同じuser1エントリを削除します。

ALTER CREDENTIALSTORE DELETE USER ggadmin
Alias: pdbeast
Userid: ggadmin

次のコマンドは、別名pdbeastに関連付けられているユーザーggadminのエントリを削除します。

ALTER CREDENTIALSTORE DELETE USER ggadmin ALIAS pdbeast
Alias: pdbeast
Userid: ggadmin

次の例では、ユーザー値としてSQL*Net接続文字列を使用します。この場合、PASSWORDオプションは省略されます。コマンドを発行したユーザーはパスワードの入力を求められます。パスワードは非表示です。

ALTER CREDENTIALSTORE ADD USER ggadmin@pdbeast ALIAS pdbeast

この例では、ドメイン名Oracle GoldenGateをユーザーID ggadminおよび別名pdbeastでAdmin Clientに作成します。

ALTER CREDENTIALSTORE ADD USER ggadmin ALIAS pdbeast
Password:

次の例では、BEQ-Bequeath Protocolアダプタを使用している場合に接続修飾子を使用して接続します。BEQ-Bequeath Protocolアダプタを使用したセキュアな接続の確立の詳細は、セキュアなデータベース接続の構成を参照してください

ALTER CREDENTIALSTORE ADD USER ggadmin@inst1_beq

次の例(Admin Client)では、ggadminという名前のユーザーを外部認証を使用して追加するため、NOPASSWORDオプションを使用します。

ALTER CREDENTIALSTORE ADD USER ggadmin@dbeast nopassword alias pdbeast

出力には次が表示されます。

2020-06-22T21:08:33Z  INFO    OGG-15102  Credential store created.

INFO CREDENTIALSTOREコマンドを実行すると、資格証明ストアへのユーザーの追加を確認できます:

INFO CREDENTIALSTORE
Default domain: OracleGoldenGate
  Alias: pdbeast
  Userid: @ggadmin

NOPASSWORDオプションを使用するように資格証明ストアを更新すると、データベースのKerberos認証でDBLOGINコマンドを使用できます。

DBLOGIN USERIDALIAS pdbeast

出力:

Successfully logged into database pdbeast.

MySQL

MySQLの管理クライアントで資格証明を作成する例を次に示します。

この例では、接続文字列にSSL属性のないデータベース資格証明を追加します。

ALTER CREDENTIALSTORE ADD USER ggadmin@mysqlsrvr.myorg.com/my_db 
PASSWORD:******  ALIAS pdbeast

この例では、接続文字列にSSL属性を追加して、資格証明ストアにデータベース接続の詳細を追加します。

ALTER CREDENTIALSTORE ADD USER ggadmin1@192.168.254.2:3306/atssrc;
sslMode=VERIFY_IDENTITY;sslPath=/var/lib/mysql/data;
sslCert=client-cert.pem;sslCa=ca.pem;sslKey=client-key.pem 
PASSWORD ****** ALIAS pdbeast

SQL Server

次の例では、DSNを使用して資格証明ストアにデータベース接続の詳細を追加します。

ALTER CREDENTIALSTORE ADD USER ggadmin@mydsn PASSWORD ***** 
ALIAS pdbeast

次の例では、DSNlessベースの接続を使用して資格証明ストアにデータベース接続の詳細を追加します。

ALTER CREDENTIALSTORE ADD USER ggadmin@100.70.96.45:10043/qadb;Encrypt=NO; 
TrustServerCertificate=YES" PASSWORD***** ALIAS pdbwest

PostgreSQL

次の例では、接続文字列にSSL属性を追加して、資格証明ストアにデータベース接続の詳細を追加します。

ALTER CREDENTIALSTORE ADD USER ggadmin@abc.com:7432/mydb;sslmode=disable; 
sslCa=/u01/ogg/certs/root.pem  PASSWORD ***** ALIAS pdbeast

次の例では、DSNを使用して資格証明ストアにデータベース接続の詳細を追加します。

ALTER CREDENTIALSTORE ADD USER ggadmin@mydsn PASSWORD ***** 
ALIAS pdbeast

次の例では、DSNlessベースの接続を使用して資格証明ストアにデータベース接続の詳細を追加します。

ALTER CREDENTIALSTORE ADD USER ggadmin@100.70.96.45:10043/qadb;Encrypt=NO; 
TrustServerCertificate=YES" PASSWORD***** ALIAS pdbwest

Sybase

Sybaseの管理クライアントで資格証明を作成する例を次に示します。

次の例では、Sybaseデータベースへの追加属性のないホストおよびポート・ベースの接続を表示します。

ALTER CREDENTIALSTORE ADD USER ggadmin@sybdb.myorg.com:5055/qadb PASSWORD****  
ALIAS pdbeast

次の例では、追加属性があり、SSLが有効になっているSybaseデータベースへのホストおよびポート・ベースの接続を表示します。

ALTER CREDENTIALSTORE ADD USER ggadmin@sybdb.myorg.com:5055/qadb;OGG_USE_SSL; 
CS_OPT_CHARSET=UTF-8;CS_LOGIN_TIMEOUT=10 PASSWORD**** ALIAS pdbeast

DB2 for iおよびDB2 for z/OS

次の例では、DSNを使用して資格証明ストアにデータベース接続の詳細を追加します。

ALTER CREDENTIALSTORE ADD USER ggadmin@mydsn PASSWORD ***** 
ALIAS pdbeast

次の例では、DSNlessベースの接続を使用して資格証明ストアにデータベース接続の詳細を追加します。

ALTER CREDENTIALSTORE ADD USER ggadmin@100.70.96.45:10043/qadb;Encrypt=NO; 
TrustServerCertificate=YES" PASSWORD***** ALIAS pdbwest