Hitachi

Hitachi Command Suite Configuration Manager REST API リファレンスガイド

17.7　監査ログの転送先を設定する

ストレージシステムの監査ログをSyslog サーバへ転送するよう設定します。このAPIは、プロトコルにhttpsを指定して実行してください。
メモ
  • ストレージシステムとSyslogサーバ間でSSL通信をする場合は、事前に必要な証明書ファイルをストレージシステムにアップロードしてから転送先を設定してください。

  • REST API を実行するユーザが、対象ストレージシステムのリソースをREST API でロックしている場合、このAPIは実行できません。その場合は、ロックを解除してから実行してください。

  • VSP 5000 シリーズに対して監査ログの転送先を設定する場合、リトライ回数は1回、タイムアウト時間は120秒に設定されます。

実行権限

監査ログ管理者（参照・編集）

リクエストライン

PUT ＜ベースURL＞/v1/objects/storages/＜ストレージデバイスID＞/auditlog-syslog-servers/instance

このAPIはPATCHメソッドでも実行できます。

リクエストメッセージ

オブジェクトID

instanceを指定します。

instanceは、単一のインスタンスしか持たないオブジェクトの場合に、オブジェクトIDとして指定する固定の値です。

クエリパラメータ

なし。

ボディ 
{
  "transferProtocol": "TLS",
  "locationName": "836000123456",
  "retries": true,
  "retryInterval": 30,
  "isDetailed": true,
  "primarySyslogServer": {
    "isEnabled": true,
    "ipAddress": "192.0.1.100",
    "port": 12345,
    "clientCertFileName": "primaryClientCert.crt",
    "clientCertFilePassword": "123456",
    "rootCertFileName": "primaryRootCert.crt"
  },
  "secondarySyslogServer": {
    "isEnabled": true,
    "ipAddress": "192.0.1.200",
    "port": 12345,
    "clientCertFileName": "secondaryClientCert.crt",
    "clientCertFilePassword": "123456",
    "rootCertFileName": "secondaryRootCert.crt"
  }
}

属性

型

説明

transferProtocol

string

（必須）監査ログをSyslogサーバへ転送する際に使用するプロトコル

次に示す値を指定します。
  • TLS：TLS1.2/RFC5424
  • UDP：UDP/RFC3164

locationName

string

（必須）監査ログ情報の転送元のストレージシステムを識別する名称

1～32文字の文字列を指定します。使用できる文字は次のとおりです。

  • 半角英数字
  • 次の記号

    ! " # $ % & ' ( ) * + - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~

retries

boolean

（任意）Syslog サーバとの通信に失敗した場合、リトライするかどうか

transferProtocol属性がTLSの場合に、次に示す値を指定します。
  • true：リトライする
  • false：リトライしない
省略した場合、trueが指定されたと見なされます。

retryInterval

int

（任意）Syslog サーバとの通信に失敗した場合のリトライ間隔（秒）

retries属性がtrueの場合に、1～60の値を指定します。省略した場合、1が指定されたと見なされます。

isDetailed

boolean

（任意）監査ログの詳細情報をSyslog サーバに転送するかどうか

次に示す値を指定します。
  • true：詳細情報を転送する
  • false：詳細情報を転送しない
省略した場合、trueが指定されたと見なされます。

primarySyslogServer

object

（必須）プライマリ側のSyslogサーバの設定

プライマリ側のSyslogサーバについて、次の属性を指定します。

  • isEnabled（boolean）

    （必須）Syslogサーバに監査ログを転送するかどうか

    • true：監査ログを転送する
    • false：監査ログを転送しない
  • ipAddress（string）

    （任意）IPアドレスまたはホスト名

    isEnabled属性がtrueの場合、必ず指定します。IPv4、IPv6のIPアドレス、またはホスト名の形式で指定できま す。

    1～255 文字で指定します。

    ホスト名に使用できる文字は次のとおりです。

    • 半角英数字
    • 次の記号

      ! $ % - . @ _ ` ~

  • port（int）

    （任意）ポート番号

    isEnabled属性がtrueの場合、必ず指定します。

  • clientCertFileName（string）

    （任意）クライアント証明書ファイル名

    isEnabled属性がtrueで、かつtransferProtocol属性がTLSの場合、必ず指定します。この属性を指定すると、ストレージシステムにアップロードされた証明書ファイルを使用するよう設定されます（証明書ファイル名とこの属性に指定したファイル名との整合性はチェックされません）。空文字を指定した場合は、ストレージシステムに設定済みの証明書ファイルが使用されます。

  • clientCertFilePassword（string）

    （任意）クライアント証明書のパスワード

    isEnabled属性がtrueで、かつtransferProtocol属性がTLSの場合、必ず指定します。

  • rootCertFileName（string）

    （任意）ルート証明書用ファイル名

    isEnabled属性がtrueで、かつtransferProtocol属性がTLSの場合、必ず指定します。この属性を指定すると、ストレージシステムにアップロードされた証明書ファイルを使用するよう設定されます（証明書ファイル名とこの属性に指定したファイル名との整合性はチェックされません）。空文字を指定した場合は、ストレージシステムに設定済みの証明書ファイルが使用されます。

secondarySyslogServer

object

（必須）セカンダリ側のSyslogサーバの設定

セカンダリ側のSyslogサーバについて、次の属性を指定します。

  • isEnabled（boolean）

    （必須）Syslogサーバに監査ログを転送するかどうか

    • true：監査ログを転送する
    • false：監査ログを転送しない
  • ipAddress（string）

    （任意）IPアドレスまたはホスト名

    isEnabled属性がtrueの場合、必ず指定します。IPv4、IPv6のIPアドレス、またはホスト名の形式で指定できま す。

    1～255 文字で指定します。

    ホスト名に使用できる文字は次のとおりです。

    • 半角英数字
    • 次の記号

      ! $ % - . @ _ ` ~

  • port（int）

    （任意）ポート番号

    isEnabled属性がtrueの場合、必ず指定します。

  • clientCertFileName（string）

    （任意）クライアント証明書ファイル名

    isEnabled属性がtrueで、かつtransferProtocol属性がTLSの場合、必ず指定します。この属性を指定すると、ストレージシステムにアップロードされた証明書ファイルを使用するよう設定されます（証明書ファイル名とこの属性に指定したファイル名との整合性はチェックされません）。空文字を指定した場合は、ストレージシステムに設定済みの証明書ファイルが使用されます。

  • clientCertFilePassword（string）

    isEnabled属性がtrueで、かつtransferProtocol属性がTLSの場合、必ず指定します。

  • rootCertFileName（string）

    （任意）ルート証明書用ファイル名

    isEnabled属性がtrueで、かつtransferProtocol属性がTLSの場合、必ず指定します。この属性を指定すると、ストレージシステムにアップロードされた証明書ファイルを使用するよう設定されます（証明書ファイル名とこの属性に指定したファイル名との整合性はチェックされません）。空文字を指定した場合は、ストレージシステムに設定済みの証明書ファイルが使用されます。

レスポンスメッセージ

ボディ

ジョブオブジェクトを返します。affectedResources以外の属性については、ジョブオブジェクトの説明を参照してください。

属性

説明

affectedResources

ストレージシステムに設定した監査ログの転送先情報のURL

ステータスコード

この操作のリクエストに対するステータスコードについては、HTTPステータスコードの説明を参照してください。

コード例

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X PUT --data-binary @./InputParameters.json https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/auditlog-syslog-servers/instance

関連項目

ページの先頭へ

All Rights Reserved. Copyright© 2016, 2021, Hitachi, Ltd.