接続の確立

CData Cmdlets ユーザーは、データモジュールをインストールし、接続プロパティを設定してスクリプトを開始できます。このセクションでは、CSV インポートおよびエクスポートcmdlet などのネイティブPowerShell cmdlet でSplunk Cmdlets を使用する例を示します。

Splunk API への接続

URL を、有効なSplunk サーバーに指定する必要があります。デフォルトでは、本製品はポート8089 でリクエストを行います。

デフォルトでは、本製品はサーバーとのTLS / SSL ネゴシエーションを試みます。TLS / SSL 設定について詳しくは、SSL の設定を参照してください。

Splunk への認証

Splunk データを認証する方法は2つあります。Splunk クレデンシャルでログインする方法と、Splunk 認証トークンを使用する方法です。

Splunk クレデンシャル

Splunk クレデンシャルで認証するには、User とPassword をログインクレデンシャルに設定します。

Splunk トークン

認証トークンを介してSplunk にアクセスすると、Representational State Transfer（REST）コールを使用してSplunk プラットフォームにアクセスできます。 Splunk Enterprise では、CLI を使用することも可能です。これらの方法はいずれも、クレデンシャルを介して認証することなくインスタンスにアクセスし、リクエストを行うことを可能にします。

Note： サーチヘッドクラスター（利用可能なすべてのヘッドクラスターにアクセスするために同じトークンを使用できます）にアクセスする場合を除き、アクセスするインスタンスごとに個別のトークンを持つ必要があります。

Splunk トークンで認証するには：

Splunk UI で、Users and Authentication -> Tokens に移動して割り当てられた認証トークンにアクセスします。取得していない場合は、アクセスしたいインスタンスの管理者にリクエストしてください。
AuthScheme をAccessToken に設定し、AccessToken プロパティをSplunk トークンに設定します。

接続オブジェクトの作成

Connect-Splunk cmdlet を使って、別のcmdlet に渡すことができる接続オブジェクトを作成します。

$conn = Connect-Splunk -User 'MyUserName' -Password 'MyPassword' -URL 'MyURL'

データの取得

Select-Splunk cmdlet はデータを取得するためのネイティブなPowerShell インターフェースを提供します。

$results = Select-Splunk -Connection $conn -Table "DataModels" -Columns @("Name, Owner") -Where "Id='SampleDataset'"

Invoke-Splunk cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。

cmdlet 出力のパイプ処理

cmdlet は行オブジェクトをパイプラインに一度に一行ずつ返します。以下は、結果をCSV ファイルにエクスポートします。

Select-Splunk -Connection $conn -Table DataModels -Where "Id = 'SampleDataset'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myDataModelsData.csv -NoTypeInformation

Select-Splunk からの結果をSelect-Object cmdlet にパイプして、Export-CSV cmdlet にパイプする前にいくつかのプロパティを実行していることがわかるでしょう。これをする理由は、CData Cmdlets は接続、テーブル、およびカラムの情報を結果セットの各行オブジェクトに追加しますが、必ずしもその情報がCSV ファイルに必要ではないからです。

ただし、これによってcmdlet の出力を別のcmdlet にパイプすることが容易になります。以下に、結果セットをJSON に変換する例を示します。

 
PS C:\> $conn  = Connect-Splunk -User 'MyUserName' -Password 'MyPassword' -URL 'MyURL'
PS C:\> $row = Select-Splunk -Connection $conn -Table "DataModels" -Columns (Name, Owner) -Where "Id = 'SampleDataset'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "DataModels",
  "Columns":  [

  ],
  "Name":  "MyName",
  "Owner":  "MyOwner"
}

データの削除

以下は、抽出条件に合うあらゆるレコードを削除します。

Select-Splunk -Connection $conn -Table DataModels -Where "Id = 'SampleDataset'" | Remove-Splunk

データの変更

cmdlet はデータクレンジング同様、データの変換を容易にします。次の例は、レコードがすでに存在するかどうか、挿入する前に更新が必要かどうかをチェックしてから、CSV ファイルのデータをSplunk にロードします。

Import-Csv -Path C:\MyDataModelsUpdates.csv | %{
  $record = Select-Splunk -Connection $conn -Table DataModels -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Splunk -Connection $conn -Table DataModels -Columns @("Name","Owner") -Values @($_.Name, $_.Owner) -Where "Id  = `'$_.Id`'"
  }else{
    Add-Splunk -Connection $conn -Table DataModels -Columns @("Name","Owner") -Values @($_.Name, $_.Owner)
  }
}

Cmdlets for Splunk