Set-SqlErrorLog
エラー ログ ファイルがリサイクルされる前の最大数を設定またはリセットします。
構文
Set-SqlErrorLog
[-MaxLogCount <UInt16>]
[-ErrorLogSizeKb <Int32>]
[[-Path] <String>]
[-Script]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>]
Set-SqlErrorLog
[[-ServerInstance] <String[]>]
[-Credential <PSCredential>]
[-ConnectionTimeout <Int32>]
[-MaxLogCount <UInt16>]
[-ErrorLogSizeKb <Int32>]
[-Script]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>]
Set-SqlErrorLog
[-MaxLogCount <UInt16>]
[-ErrorLogSizeKb <Int32>]
[-InputObject] <Server>
[-Script]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>]
説明
Set-SqlErrorLog コマンドレットは、エラー ログ ファイルがリサイクルされる前の最大数を設定またはリセットします。
このコマンドレットでは、ログを設定するための次の操作モードがサポートされています。
- SQL Serverのインスタンスを渡します。
- SQL Server インスタンスの Path パラメーターを指定します。
- 有効なコンテキストでコマンドレットを呼び出します。
例
例 1: 最大数またはエラー ログを設定する
PS C:\> Set-SqlErrorLog -ServerInstance "MyServer\MyInstance" -MaxLogCount 11 | Out-Null
このコマンドは、エラー ログ ファイルの最大数を に 11
設定します。
例 2: 最大数またはエラー ログを設定する TSQL スクリプト コードを返す
PS C:\> Set-SqlErrorLog -ServerInstance "MyServer\MyInstance" -MaxLogCount 11 -Script
USE [master]
GO
EXEC xp_instance_regwrite N'HKEY_LOCAL_MACHINE', N'Software\Microsoft\MSSQLServer\MSSQLServer', N'NumErrorLogs', REG_DWORD, 11
GO
このコマンドは、エラー ログ ファイルの最大数を に 11
設定するために必要な T-SQL スクリプト コードを文字列配列として返します。
パラメーター
-AccessToken
ユーザー/パスワードまたは Windows 認証の代わりに、SQL Serverに対する認証に使用されるアクセス トークン。
これは、たとえば、 または を使用して にSQL Azure DB
接続したりSQL Azure Managed Instance
、 を使用したりManaged Identity
するために使用Service Principal
できます。
使用するパラメーターには、 を実行Get-AzAccessToken -ResourceUrl https://database.windows.net
して返されるトークンまたはオブジェクトをPSAccessToken
表す文字列を指定できます。
このパラメーターは、モジュールの v22 の新機能です。
Type: | PSObject |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ConnectionTimeout
タイムアウトエラーが発生するまでのサーバー接続を待機する秒数を指定します。 タイムアウト値は、0 ~ 65534 の整数値である必要があります。 0 を指定した場合、接続の試行はタイムアウトしません。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Credential
この操作を実行する権限を持つSQL Server ログインの資格情報を指定するために使用される PSCredential オブジェクトを指定します。
Type: | PSCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Encrypt
SQL Serverに接続するときに使用する暗号化の種類。
この値は、 Encrypt
Microsoft.Data.SqlClient ドライバーの SqlConnection オブジェクトの プロパティ SqlConnectionEncryptOption
にマップされます。
モジュールの v22 では、既定値は Optional
(v21 との互換性のために) です。 モジュールの v23 以降では、既定値は "必須" になります。これにより、既存のスクリプトに破壊的変更が発生する可能性があります。
このパラメーターは、モジュールの v22 の新機能です。
Type: | String |
Accepted values: | Mandatory, Optional, Strict |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ErrorLogSizeKb
SQL インスタンス エラー ログ ファイルのサイズ制限を KB 単位で指定します。
有効な範囲は 0 から Int32.MaxValue です。
ユーザーがこのパラメーターを指定しない場合、ErrorLogSizeKb は変更されません。 SQL インスタンスの既定値は 0 です。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-HostNameInCertificate
SQL Server TLS/SSL 証明書の検証に使われるホスト名。 SQL Server インスタンスで Force Encryption が有効になっており、hostname/shortname を使用してインスタンスに接続する場合は、このパラメーターを渡す必要があります。 このパラメーターを省略した場合、強制暗号化が有効になっているSQL Server インスタンスに接続するには、完全修飾ドメイン名 (FQDN) を -ServerInstance に渡す必要があります。
このパラメーターは、モジュールの v22 の新機能です。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
ターゲット インスタンスのサーバー オブジェクトを指定します。
Type: | Server |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-MaxLogCount
エラー ログ ファイルの最大数を指定します。 値が指定されていない場合、コマンドレットは値を既定値にリセットします。
指定できる値の範囲は 6 ~ 99 です。
Type: | UInt16 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Path
このコマンドレットが操作を実行するSQL Serverのインスタンスへのパスを指定します。 このパラメーターの値を指定しない場合、コマンドレットは作業場所を使用します。
Type: | String |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Script
このコマンドレットによって、このコマンドレットが実行するタスクを実行する Transact-SQL スクリプトが返されることを示します。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ServerInstance
文字列配列として、SQL Serverのインスタンスの名前を指定します。
既定のインスタンスの場合は、コンピューター名 MyComputer のみを指定します。
名前付きインスタンスの場合は、 という形式 MyComputer\MyInstanceName
を使用します。
Type: | String[] |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TrustServerCertificate
信頼を検証するために証明書チェーンの歩き方をバイパスしながらチャネルを暗号化するかどうかを示します。
モジュールの v22 では、既定値は $true
(v21 との互換性のために) です。 モジュールの v23 以降では、既定値は "$false" になります。これにより、既存のスクリプトに破壊的変更が発生する可能性があります。
このパラメーターは、モジュールの v22 の新機能です。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
入力
System.String[]
Microsoft.SqlServer.Management.Smo.Server
メモ
サーバー上の値が既に指定された値に設定されている場合、このコマンドレットは何も行いません。