Win32 API 日本語リファレンス
ホーム › Networking.Clustering › PCLUSAPI_SET_CLUSTER_SERVICE_ACCOUNT_PASSWORD

PCLUSAPI_SET_CLUSTER_SERVICE_ACCOUNT_PASSWORD

コールバック

シグネチャ

DWORD PCLUSAPI_SET_CLUSTER_SERVICE_ACCOUNT_PASSWORD(
    LPWSTR lpszClusterName,
    LPWSTR lpszNewPassword,
    DWORD dwFlags,
    CLUSTER_SET_PASSWORD_STATUS* lpReturnStatusBuffer,
    DWORD* lpcbReturnStatusBufferSize
);

パラメーター

フィールド型説明
lpszClusterNameLPWSTRクラスターの名前を指定する NULL 終端の Unicode 文字列です。
lpszNewPasswordLPWSTRCluster サービスのユーザーアカウントの新しいパスワードを指定する NULL 終端の Unicode 文字列です。
dwFlagsDWORD

パスワードの更新をクラスターにどのように適用するかを示すフラグを格納する、CLUSTER_SET_PASSWORD_FLAGS 列挙型の値による省略可能なビットフィールドです。

既定 (dwFlags = 0) では、すべてのクラスターノードが利用可能でない限り、この関数は処理を続行しません。

CLUSTER_SET_PASSWORD_IGNORE_DOWN_NODES (1 (0x1))

すべてのノードが利用可能でない場合でも、SetClusterServiceAccountPassword 関数の処理を続行させます。この関数は可能な限り多くのノードでパスワードの変更を試みますが、ClusterNodeUp 状態または ClusterNodePaused 状態 (GetClusterNodeState を参照) にないノードは更新されません。

lpReturnStatusBufferCLUSTER_SET_PASSWORD_STATUS*各クラスターノードでのパスワード更新の結果を示す CLUSTER_SET_PASSWORD_STATUS 構造体の配列を受け取る出力バッファーへのポインターです。このパラメーターが NULL ではなく、バッファーが結果のデータを格納するのに十分な大きさでない場合、関数は ERROR_MORE_DATA を返し、lpcbReturnStatusBufferSize に出力バッファーに必要なサイズを設定します。このパラメーターが NULL の場合、パスワードの更新は行われません。関数は lpcbReturnStatusBufferSize に必要なバッファーサイズを設定し、ERROR_SUCCESS を返します。
lpcbReturnStatusBufferSizeDWORD*入力時は、出力バッファーのサイズ (バイト単位) を指定する値へのポインターです。出力時は、結果のデータの実際のサイズ (バイト単位) を指定する値へのポインターです。lpReturnStatusBuffer が NULL であっても、出力サイズは常に設定されます。このパラメーターに NULL を指定することはできません。

公式ドキュメント

[この関数は、要件セクションに記載されているオペレーティングシステムで使用できます。この関数のサポートは Windows Server 2008 で削除されており、この関数は何も行わず ERROR_CALL_NOT_IMPLEMENTED を返します。]

利用可能なすべてのクラスターノードで、Cluster サービスのユーザーアカウントのパスワードを変更します。PCLUSAPI_SET_CLUSTER_SERVICE_ACCOUNT_PASSWORD 型は、この関数へのポインターを定義します。

戻り値

操作が成功した場合、関数は ERROR_SUCCESS (0) を返します。

操作が失敗した場合、関数は システムエラーコードを返します。返される可能性があるエラーコードは次のとおりです。

リターンコード/値 説明
ERROR_ALL_NODES_NOT_AVAILABLE
5037 (0x13AD)
 クラスター内の一部のノードが利用できず (つまり ClusterNodeStateUp 状態または ClusterNodeStatePaused 状態になく)、CLUSTER_SET_PASSWORD_IGNORE_DOWN_NODES フラグが設定されていません。
ERROR_MORE_DATA
234 (0xEA)
 lpReturnStatusBuffer が指す出力バッファーが、結果のデータを格納するのに十分な大きさではありませんでした。

解説(Remarks)

既定では、SetClusterServiceAccountPassword 関数は、クラスター内のすべてのノードが利用可能 (つまり ClusterNodeStateUp 状態または ClusterNodeStatePaused 状態) でない限り、何も行いません。CLUSTER_SET_PASSWORD_IGNORE_DOWN_NODES フラグを使用してこの動作を変更できますが、パスワードの更新に失敗したノードは、そのノードでパスワードを手動で更新するまでクラスターに参加できなくなる点に注意してください。

あるノードで新しいパスワードが古いパスワードと同じである場合、そのノードにはパスワードの更新は適用されず、ERROR_SUCCESS が返されます。

この関数は、Cluster サービスのユーザーアカウントについてドメインコントローラーが保持しているパスワードは更新しません。

リソース DLL から SetClusterServiceAccountPassword を呼び出さないでください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)