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

RestoreClusterDatabase

関数
クラスター構成データベースをバックアップから復元する。
DLLCLUSAPI.dll呼出規約winapi対応OSwindowsserver2003

シグネチャ

// CLUSAPI.dll
#include <windows.h>

DWORD RestoreClusterDatabase(
    LPCWSTR lpszPathName,
    BOOL bForce,
    LPCWSTR lpszQuorumDriveLetter   // optional
);

パラメーター

名前型方向説明
lpszPathNameLPCWSTRinバックアップファイルへのパスを指定する、null で終わる Unicode 文字列。クラスターの構成情報はこの場所に格納されます。これは保護すべき機密データです。たとえば、アクセス制御リストを使用してデータの格納場所へのアクセスを制限することで、このデータを保護できます。
bForceBOOLin

FALSE の場合、次のいずれかの状況に該当すると復元操作は完了しません。

  • 他のノードが現在アクティブである。
  • 現在のクォーラムリソースのパーティションレイアウトが、バックアップ作成時のクォーラムリソースのパーティションレイアウトと一致しない。(「パーティションレイアウト」とは、ディスク上のパーティション数と各パーティションへのオフセットを指します。ディスクシグネチャとドライブ文字の割り当ては一致している必要はありません。)
bForce を TRUE に設定すると、上記の状況にかかわらず操作が続行されます。ただし、他の理由により操作が失敗する場合もあります。
lpszQuorumDriveLetterLPCWSTRinoptional

省略可能。クラスターデータベースの復元先となるクォーラムリソースのドライブ文字を指定します。このパラメーターは、バックアップ作成後にクォーラムリソースが置き換えられた場合にのみ使用してください。文字列は次の形式で指定する必要があります。

  • 1 文字目は英字、つまり 'a'-'z' または 'A'-'Z' の範囲でなければなりません。
  • 2 文字目はコロン (':') でなければなりません。
  • 3 文字目は終端の null ('\0') でなければなりません。

戻り値の型: DWORD

公式ドキュメント

クラスターデータベースを復元し、この関数を呼び出したノード上で Cluster サービスを再起動します。このノードは復元ノード (restoring node) と呼ばれます。

戻り値

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

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

戻り値 説明
ERROR_CLUSTER_NODE_UP
他のクラスターノードが現在アクティブであるため、操作が失敗しました。bForce を TRUE に設定して RestoreClusterDatabase を再度呼び出すと、クラスターは他のアクティブなノード上の Cluster サービスをシャットダウンしようとします。
ERROR_QUORUM_DISK_NOT_FOUND
バックアップに記録されているクォーラムディスクが現在のクォーラムディスクと一致しないため、操作が失敗しました。bForce を TRUE に設定して RestoreClusterDatabase を再度呼び出すと、クラスターは現在のクォーラムディスクのシグネチャとドライブ文字を、バックアップに保存されている値に変更しようとします。

解説(Remarks)

復元操作が成功すると、復元ノードは、復元されたクラスターデータベース内の構成データに従ってクラスターを形成します。他のノードがクラスターに参加すると、それらのノードは復元ノード上のデータベースから自身のクラスターデータベースを更新します。

なお、クォーラムリソース以外のクラスターディスクのうち、バックアップ作成後に追加または変更されたものは、復元されたクラスターデータベースでは認識されず、復元操作が成功した場合でもオフラインのままになります。これらのディスクに対しては、新しいリソースを作成する必要があります (物理ディスクリソースの作成を参照してください)。

クラスターの復元ルーチンでは、次の一般的な手順が推奨されます。

  1. bForce を FALSE に設定し、ドライブ文字を指定せずに RestoreClusterDatabase を呼び出します。成功した場合に構成の変更を強制する必要がないため、これが最善の方法です。
  2. 最初の呼び出しが失敗した場合は、手順を強制的に続行するか、問題を手動で修正するかをユーザーに判断させます。それぞれの判断による影響を必ず伝えてください。
    戻り値 強制した場合の動作 手動での修正
    ERROR_CLUSTER_NODE_UP 復元操作により、他のすべてのノード上の Cluster サービスが停止されます。 ユーザーが他のすべてのクラスターノード上で Cluster サービスを手動でシャットダウンします。Net Stop ClusSvc コマンドで十分であり、完全な電源オフは不要です。
    ERROR_QUORUM_DISK_NOT_FOUND ユーザーはクォーラムリソースのドライブ文字を指定する必要があります。復元操作により、ディスクのシグネチャとドライブ文字が、バックアップに保存されている値に変更されます。 ユーザーがクォーラムディスクを再パーティション化し、バックアップに保存されているレイアウトと同一のレイアウトにします。

    ユーザーが強制的な続行に同意した場合は、bForce を TRUE に設定し、該当する場合はドライブ文字を指定して RestoreClusterDatabase を呼び出します。強制しても成功が保証されるわけではありません。復元操作が再び失敗した場合は、戻り値を確認して適切に対応してください。

Examples

次の例は、上記の手順を示しています。BackupClusterDatabase を含むより完全な例については、クラスター構成のバックアップと復元を参照してください。この例では、フェールオーバークラスターのドキュメントで定義されている ClusDocEx.h ヘッダーファイルを使用しています。


int main( void )
{
    WCHAR szPath[] = L"c:\\ClusBack\\19991215";
    WCHAR szInput[3];
    BOOL bForce = FALSE;
    DWORD dwResult = ERROR_SUCCESS;

    // 最初の試行: 強制しない
    dwResult = RestoreClusterDatabase( szPath, FALSE, NULL );
    
    // 必要に応じてユーザーが強制シャットダウンを選択できるようにする。
    if( dwResult == ERROR_CLUSTER_NODE_UP )
    {
        wprintf( L"The operation failed because other cluster nodes are currently active. " );
        wprintf( L"The Cluster service must be shut down on all other nodes in order for this operation to succeed." );
        wprintf( L"Enter 'f' to force automatic shutdown, or any other key to exit for manual shutdown:  " );
        fgetws( szInput, 2, stdin );
        if( towupper( szInput[0] ) == L'F' )
            dwResult = RestoreClusterDatabase( szPath, TRUE, NULL );
    }

    // 必要に応じてユーザーがクォーラムリソースを指定できるようにする。
    if( dwResult == ERROR_QUORUM_DISK_NOT_FOUND )
    {
        wprintf( L"\n\nERROR: QUORUM DISK NOT FOUND\n" );
        wprintf( L"The restore routine cannot find a quorum resource with the same partition layout as the quorum resource described in the backup. " );
        wprintf( L"The existing quorum resource must have a layout (number of partitions and offsets to each partition) identical to the layout stored in the backup.\n" );
        wprintf( L"Enter the drive letter of the quorum resource to force continuation, or any non-letter key to exit:  " );
        fgetws( szInput, 3, stdin );
        if( iswalpha( szInput[0] ) )
        {
            szInput[1] = L':';
            szInput[2] = L'\0';
            dwResult = RestoreClusterDatabase( szPath, TRUE, szInput );
        }
    }

    // エラーごとの強制試行は 1 回のみ。その後、成功または失敗を報告する。 
    if( dwResult == ERROR_SUCCESS )
    {
        wprintf( L"\n\nSUCCESS\n" );
        wprintf( L"The restore routine succeeded. Start the Cluster service on the other cluster nodes to complete the restore operation." );
        wprintf( L"As nodes join the cluster, they will update their cluster databases to match the restored configuration." ); 
        return 0;
    }
    else
    {
        wprintf( L"RestoreClusterDatabase failed (%d)\n", dwResult );
        return 1;
    }

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

各言語での呼び出し定義

// CLUSAPI.dll
#include <windows.h>

DWORD RestoreClusterDatabase(
    LPCWSTR lpszPathName,
    BOOL bForce,
    LPCWSTR lpszQuorumDriveLetter   // optional
);
[DllImport("CLUSAPI.dll", ExactSpelling = true)]
static extern uint RestoreClusterDatabase(
    [MarshalAs(UnmanagedType.LPWStr)] string lpszPathName,   // LPCWSTR
    bool bForce,   // BOOL
    [MarshalAs(UnmanagedType.LPWStr)] string lpszQuorumDriveLetter   // LPCWSTR optional
);
<DllImport("CLUSAPI.dll", ExactSpelling:=True)>
Public Shared Function RestoreClusterDatabase(
    <MarshalAs(UnmanagedType.LPWStr)> lpszPathName As String,   ' LPCWSTR
    bForce As Boolean,   ' BOOL
    <MarshalAs(UnmanagedType.LPWStr)> lpszQuorumDriveLetter As String   ' LPCWSTR optional
) As UInteger
End Function
' lpszPathName : LPCWSTR
' bForce : BOOL
' lpszQuorumDriveLetter : LPCWSTR optional
Declare PtrSafe Function RestoreClusterDatabase Lib "clusapi" ( _
    ByVal lpszPathName As LongPtr, _
    ByVal bForce As Long, _
    ByVal lpszQuorumDriveLetter As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RestoreClusterDatabase = ctypes.windll.clusapi.RestoreClusterDatabase
RestoreClusterDatabase.restype = wintypes.DWORD
RestoreClusterDatabase.argtypes = [
    wintypes.LPCWSTR,  # lpszPathName : LPCWSTR
    wintypes.BOOL,  # bForce : BOOL
    wintypes.LPCWSTR,  # lpszQuorumDriveLetter : LPCWSTR optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CLUSAPI.dll')
RestoreClusterDatabase = Fiddle::Function.new(
  lib['RestoreClusterDatabase'],
  [
    Fiddle::TYPE_VOIDP,  # lpszPathName : LPCWSTR
    Fiddle::TYPE_INT,  # bForce : BOOL
    Fiddle::TYPE_VOIDP,  # lpszQuorumDriveLetter : LPCWSTR optional
  ],
  -Fiddle::TYPE_INT)
#[link(name = "clusapi")]
extern "system" {
    fn RestoreClusterDatabase(
        lpszPathName: *const u16,  // LPCWSTR
        bForce: i32,  // BOOL
        lpszQuorumDriveLetter: *const u16  // LPCWSTR optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("CLUSAPI.dll")]
public static extern uint RestoreClusterDatabase([MarshalAs(UnmanagedType.LPWStr)] string lpszPathName, bool bForce, [MarshalAs(UnmanagedType.LPWStr)] string lpszQuorumDriveLetter);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CLUSAPI_RestoreClusterDatabase' -Namespace Win32 -PassThru
# $api::RestoreClusterDatabase(lpszPathName, bForce, lpszQuorumDriveLetter)
#uselib "CLUSAPI.dll"
#func global RestoreClusterDatabase "RestoreClusterDatabase" sptr, sptr, sptr
; RestoreClusterDatabase lpszPathName, bForce, lpszQuorumDriveLetter   ; 戻り値は stat
; lpszPathName : LPCWSTR -> "sptr"
; bForce : BOOL -> "sptr"
; lpszQuorumDriveLetter : LPCWSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "CLUSAPI.dll"
#cfunc global RestoreClusterDatabase "RestoreClusterDatabase" wstr, int, wstr
; res = RestoreClusterDatabase(lpszPathName, bForce, lpszQuorumDriveLetter)
; lpszPathName : LPCWSTR -> "wstr"
; bForce : BOOL -> "int"
; lpszQuorumDriveLetter : LPCWSTR optional -> "wstr"
; DWORD RestoreClusterDatabase(LPCWSTR lpszPathName, BOOL bForce, LPCWSTR lpszQuorumDriveLetter)
#uselib "CLUSAPI.dll"
#cfunc global RestoreClusterDatabase "RestoreClusterDatabase" wstr, int, wstr
; res = RestoreClusterDatabase(lpszPathName, bForce, lpszQuorumDriveLetter)
; lpszPathName : LPCWSTR -> "wstr"
; bForce : BOOL -> "int"
; lpszQuorumDriveLetter : LPCWSTR optional -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	clusapi = windows.NewLazySystemDLL("CLUSAPI.dll")
	procRestoreClusterDatabase = clusapi.NewProc("RestoreClusterDatabase")
)

// lpszPathName (LPCWSTR), bForce (BOOL), lpszQuorumDriveLetter (LPCWSTR optional)
r1, _, err := procRestoreClusterDatabase.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszPathName))),
	uintptr(bForce),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszQuorumDriveLetter))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function RestoreClusterDatabase(
  lpszPathName: PWideChar;   // LPCWSTR
  bForce: BOOL;   // BOOL
  lpszQuorumDriveLetter: PWideChar   // LPCWSTR optional
): DWORD; stdcall;
  external 'CLUSAPI.dll' name 'RestoreClusterDatabase';
result := DllCall("CLUSAPI\RestoreClusterDatabase"
    , "WStr", lpszPathName   ; LPCWSTR
    , "Int", bForce   ; BOOL
    , "WStr", lpszQuorumDriveLetter   ; LPCWSTR optional
    , "UInt")   ; return: DWORD
●RestoreClusterDatabase(lpszPathName, bForce, lpszQuorumDriveLetter) = DLL("CLUSAPI.dll", "dword RestoreClusterDatabase(char*, bool, char*)")
# 呼び出し: RestoreClusterDatabase(lpszPathName, bForce, lpszQuorumDriveLetter)
# lpszPathName : LPCWSTR -> "char*"
# bForce : BOOL -> "bool"
# lpszQuorumDriveLetter : LPCWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "clusapi" fn RestoreClusterDatabase(
    lpszPathName: [*c]const u16, // LPCWSTR
    bForce: i32, // BOOL
    lpszQuorumDriveLetter: [*c]const u16 // LPCWSTR optional
) callconv(std.os.windows.WINAPI) u32;
proc RestoreClusterDatabase(
    lpszPathName: WideCString,  # LPCWSTR
    bForce: int32,  # BOOL
    lpszQuorumDriveLetter: WideCString  # LPCWSTR optional
): uint32 {.importc: "RestoreClusterDatabase", stdcall, dynlib: "CLUSAPI.dll".}
pragma(lib, "clusapi");
extern(Windows)
uint RestoreClusterDatabase(
    const(wchar)* lpszPathName,   // LPCWSTR
    int bForce,   // BOOL
    const(wchar)* lpszQuorumDriveLetter   // LPCWSTR optional
);
ccall((:RestoreClusterDatabase, "CLUSAPI.dll"), stdcall, UInt32,
      (Cwstring, Int32, Cwstring),
      lpszPathName, bForce, lpszQuorumDriveLetter)
# lpszPathName : LPCWSTR -> Cwstring
# bForce : BOOL -> Int32
# lpszQuorumDriveLetter : LPCWSTR optional -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t RestoreClusterDatabase(
    const uint16_t* lpszPathName,
    int32_t bForce,
    const uint16_t* lpszQuorumDriveLetter);
]]
local clusapi = ffi.load("clusapi")
-- clusapi.RestoreClusterDatabase(lpszPathName, bForce, lpszQuorumDriveLetter)
-- lpszPathName : LPCWSTR
-- bForce : BOOL
-- lpszQuorumDriveLetter : LPCWSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('CLUSAPI.dll');
const RestoreClusterDatabase = lib.func('__stdcall', 'RestoreClusterDatabase', 'uint32_t', ['str16', 'int32_t', 'str16']);
// RestoreClusterDatabase(lpszPathName, bForce, lpszQuorumDriveLetter)
// lpszPathName : LPCWSTR -> 'str16'
// bForce : BOOL -> 'int32_t'
// lpszQuorumDriveLetter : LPCWSTR optional -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("CLUSAPI.dll", {
  RestoreClusterDatabase: { parameters: ["buffer", "i32", "buffer"], result: "u32" },
});
// lib.symbols.RestoreClusterDatabase(lpszPathName, bForce, lpszQuorumDriveLetter)
// lpszPathName : LPCWSTR -> "buffer"
// bForce : BOOL -> "i32"
// lpszQuorumDriveLetter : LPCWSTR optional -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t RestoreClusterDatabase(
    const uint16_t* lpszPathName,
    int32_t bForce,
    const uint16_t* lpszQuorumDriveLetter);
C, "CLUSAPI.dll");
// $ffi->RestoreClusterDatabase(lpszPathName, bForce, lpszQuorumDriveLetter);
// lpszPathName : LPCWSTR
// bForce : BOOL
// lpszQuorumDriveLetter : LPCWSTR optional
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Clusapi extends StdCallLibrary {
    Clusapi INSTANCE = Native.load("clusapi", Clusapi.class);
    int RestoreClusterDatabase(
        WString lpszPathName,   // LPCWSTR
        boolean bForce,   // BOOL
        WString lpszQuorumDriveLetter   // LPCWSTR optional
    );
}
@[Link("clusapi")]
lib LibCLUSAPI
  fun RestoreClusterDatabase = RestoreClusterDatabase(
    lpszPathName : UInt16*,   # LPCWSTR
    bForce : Int32,   # BOOL
    lpszQuorumDriveLetter : UInt16*   # LPCWSTR optional
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef RestoreClusterDatabaseNative = Uint32 Function(Pointer<Utf16>, Int32, Pointer<Utf16>);
typedef RestoreClusterDatabaseDart = int Function(Pointer<Utf16>, int, Pointer<Utf16>);
final RestoreClusterDatabase = DynamicLibrary.open('CLUSAPI.dll')
    .lookupFunction<RestoreClusterDatabaseNative, RestoreClusterDatabaseDart>('RestoreClusterDatabase');
// lpszPathName : LPCWSTR -> Pointer<Utf16>
// bForce : BOOL -> Int32
// lpszQuorumDriveLetter : LPCWSTR optional -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RestoreClusterDatabase(
  lpszPathName: PWideChar;   // LPCWSTR
  bForce: BOOL;   // BOOL
  lpszQuorumDriveLetter: PWideChar   // LPCWSTR optional
): DWORD; stdcall;
  external 'CLUSAPI.dll' name 'RestoreClusterDatabase';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RestoreClusterDatabase"
  c_RestoreClusterDatabase :: CWString -> CInt -> CWString -> IO Word32
-- lpszPathName : LPCWSTR -> CWString
-- bForce : BOOL -> CInt
-- lpszQuorumDriveLetter : LPCWSTR optional -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let restoreclusterdatabase =
  foreign "RestoreClusterDatabase"
    ((ptr uint16_t) @-> int32_t @-> (ptr uint16_t) @-> returning uint32_t)
(* lpszPathName : LPCWSTR -> (ptr uint16_t) *)
(* bForce : BOOL -> int32_t *)
(* lpszQuorumDriveLetter : LPCWSTR optional -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library clusapi (t "CLUSAPI.dll"))
(cffi:use-foreign-library clusapi)

(cffi:defcfun ("RestoreClusterDatabase" restore-cluster-database :convention :stdcall) :uint32
  (lpsz-path-name (:string :encoding :utf-16le))   ; LPCWSTR
  (b-force :int32)   ; BOOL
  (lpsz-quorum-drive-letter (:string :encoding :utf-16le)))   ; LPCWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RestoreClusterDatabase = Win32::API::More->new('CLUSAPI',
    'DWORD RestoreClusterDatabase(LPCWSTR lpszPathName, BOOL bForce, LPCWSTR lpszQuorumDriveLetter)');
# my $ret = $RestoreClusterDatabase->Call($lpszPathName, $bForce, $lpszQuorumDriveLetter);
# lpszPathName : LPCWSTR -> LPCWSTR
# bForce : BOOL -> BOOL
# lpszQuorumDriveLetter : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目