Documentation
1 Zabbixエージェント2
Zabbix agent 2は、Zabbix agent でサポートされている全てのitem キーをUnix(/manual/config/items/itemtypes/zabbix_agent)とWindows(manual/config/items/itemtypes/zabbix_agent/win_keys)でサポートしています。 このページでは、Zabbix agent 2でのみ使用できる追加 item キーの詳細を、所属するプラグインごとにまとめています。
こちらもご参照ください。Plugins supplied out-of-the-box
角括弧のないパラメータは必須です。 角括弧 < > でマークされたパラメータはオプションです。
項目キーの詳細
山括弧のないパラメータは必須です。山括弧 < > でマークされたパラメータはオプションです。
ceph.df.details[connString,<user>,<apikey>]
クラスタのデータ使用量とプール間の配分
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user, password - Ceph のログイン認証情報
ceph.osd.stats[connString,<user>,<apikey>]
OSDごとの集計統計情報
戻り値: JSONオブジェクト
パラメーター:
- connString - URIまたはセッション名
- user, password - Cephログイン認証情報
ceph.osd.discovery[connString,<user>,<apikey>]
検出されたOSDのリスト。低レベル検出に使用されます。
戻り値: JSONオブジェクト
パラメーター:
- connString - URIまたはセッション名
- user, password - Cephログイン認証情報
ceph.osd.dump[connString,<user>,<apikey>]
OSD の使用状況のしきい値とステータス
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user, password - Ceph のログイン認証情報
ceph.ping[connString,<user>,<apikey>]
Cephへの接続を確立できるかどうかをテストします。
戻り値: 0 - 接続が切断されています(認証や設定の問題などのエラーが表示された場合); 1 - 接続が成功しています。
パラメーター:
- connString - URIまたはセッション名
- user, password - Cephのログイン認証情報
ceph.pool.discovery[connString,<user>,<apikey>]
検出されたプールのリスト低レベル検出に使用されます。
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user, password - Ceph のログイン認証情報
ceph.status[connString,<user>,<apikey>]
クラスタ全体のステータス
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user, password - Ceph のログイン認証情報
docker.container_info[<ID>,<info>]
コンテナに関する低レベル情報
戻り値: ContainerInspect API 呼び出しの出力を JSON 形式でシリアル化したもの
パラメーター:
- ID - コンテナの ID または名前
- info - 返される情報の量。サポートされる値: short (デフォルト) または full
Agent 2 ユーザー ('zabbix') に十分な権限を与えるには、'docker' グループ に追加する必要があります。追加されていない場合、チェックは失敗します。
docker.container_stats[<ID>]
コンテナリソースの使用状況統計
戻り値: ContainerStats API 呼び出しの出力と CPU 使用率 (パーセンテージ) を JSON 形式でシリアル化したもの
パラメーター:
- ID - コンテナの ID または名前
Agent 2 ユーザー ('zabbix') に十分な権限を与えるには、'docker' グループ に追加する必要があります。そうでない場合、チェックは失敗します。
docker.containers
コンテナのリスト
戻り値: ContainerList API 呼び出しの出力を JSON 形式でシリアル化したもの。
Agent 2 ユーザー ('zabbix') に十分な権限を与えるには、'docker' グループ に追加する必要があります。そうでない場合、チェックは失敗します。
docker.containers.discovery[<options>]
コンテナのリストを返します。低レベル検出に使用されます。
戻り値: JSON オブジェクト
パラメーター:
- options - すべてのコンテナを検出するか、実行中のコンテナのみを検出するかを指定します。サポートされる値: true - すべてのコンテナを返します。false - 実行中のコンテナのみを返します (デフォルト)
エージェント 2 ユーザー ('zabbix') に十分な権限を与えるには、'docker' グループ に追加する必要があります。そうでない場合、チェックは失敗します。
docker.data.usage
現在のデータ使用量に関する情報
戻り値: SystemDataUsage API 呼び出しの出力を JSON 形式でシリアル化したもの
Agent 2 ユーザー ('zabbix') に十分な権限を与えるには、'docker' グループ に追加する必要があります。そうでない場合、チェックは失敗します。
docker.images
イメージのリストを返します。
戻り値: ImageList API 呼び出しの出力を JSON としてシリアル化したもの
Agent 2 ユーザー ('zabbix') に十分な権限を与えるには、'docker' グループ に追加する必要があります。そうでない場合、チェックは失敗します。
docker.images.discovery
イメージのリストを返します。低レベル検出に使用されます。
戻り値: JSON オブジェクト
十分な権限を得るには、エージェント 2 ユーザー ('zabbix') を 'docker' グループ に追加する必要があります。追加されていない場合、チェックは失敗します。
docker.info
システム情報
戻り値: SystemInfo API 呼び出しの出力を JSON 形式でシリアル化したもの
Agent 2 ユーザー ('zabbix') に十分な権限を与えるには、'docker' グループ に追加する必要があります。そうでない場合、チェックは失敗します。
docker.ping
Dockerデーモンが稼働中かどうかをテストします。
戻り値: 1 - 接続が稼働中、0 - 接続が切断されています。
エージェント2のユーザー（'zabbix'）を'docker'グループに追加して、十分な権限を付与する必要があります。そうでない場合、チェックは失敗します。
ember.get[<uri>,<path>]
要求されたデバイスの結果を返します。
戻り値: JSON オブジェクト
パラメーター:
- uri - Ember+ デバイスの URI。デフォルト: 127.0.0.1:9998;
- path - デバイスの OID パス。デフォルトは空で、ルートコレクションデータを返します。
memcached.ping[connString,<user>,<password>]
接続が確立されているかどうかをテストします。
戻り値: 1 - 接続が確立されています。0 - 接続が切断されています（認証や設定の問題など、何らかのエラーが表示されている場合）
パラメーター:
- connString - URI またはセッション名
- user, password - Memcached のログイン認証情報
memcached.stats[connString,<user>,<password>,<type>]
STATSコマンドの出力を取得します。
戻り値: JSON - 出力はJSONとしてシリアル化されます。
パラメーター:
- connString - URIまたはセッション名
- user, password - Memcachedのログイン認証情報
- type - 返される統計情報の種類: items、sizes、slabs、またはsettings (デフォルトは空で、一般的な統計情報を返します)
mongodb.collection.stats[connString,<user>,<password>,<database>,collection]
指定されたコレクションのさまざまなストレージ統計情報を返します。
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user, password - MongoDB ログイン認証情報
- database - データベース名 (デフォルト: admin)
- collection - コレクション名
mongodb.collections.discovery[connString,<user>,<password>]
検出されたコレクションのリストを返します。低レベル検出に使用されます。
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user, password - MongoDB ログイン認証情報
mongodb.collections.usage[connString,<user>,<password>]
コレクションの使用状況統計を返します。
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user, password - MongoDB ログイン認証情報
mongodb.connpool.stats[connString,<user>,<password>]
現在のデータベースインスタンスからシャードクラスタまたはレプリカセットの他のメンバーへのオープンな送信接続に関する情報を返します。
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user, password - MongoDB ログイン認証情報
- database - データベース名 (デフォルト: admin)
- collection - コレクション名
mongodb.db.stats[connString,<user>,<password>,<database>]
指定されたデータベースシステムの状態を反映する統計情報を返します。
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user, password - MongoDB ログイン認証情報
- database - データベース名 (デフォルト: admin)
mongodb.db.discovery[connString,<user>,<password>]
検出されたデータベースのリストを返します。低レベル検出に使用されます。
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user, password - MongoDB のログイン認証情報
mongodb.jumbo_chunks.count[connString,<user>,<password>]
ジャンボチャンクの数を返します。
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user, password - MongoDB ログイン認証情報
mongodb.oplog.stats[connString,<user>,<password>]
oplog からポーリングしたデータを使用して、レプリカセットのステータスを返します。
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user, password - MongoDB のログイン認証情報
mongodb.ping[connString,<user>,<password>]
接続が確立されているかどうかをテストします。
戻り値: 1 - 接続が確立されています。0 - 接続が切断されています（認証や設定の問題など、何らかのエラーが表示されている場合）
パラメーター:
- connString - URI またはセッション名
- user, password - MongoDB のログイン認証情報
mongodb.rs.config[connString,<user>,<password>]
レプリカセットの現在の設定を返します。
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user, password - MongoDB ログイン認証情報
mongodb.rs.status[connString,<user>,<password>]
メソッドが実行されたメンバーの観点から、レプリカセットのステータスを返します。
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user, password - MongoDB ログイン認証情報
mongodb.server.status[connString,<user>,<password>]
データベースの状態を返します。
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user, password - MongoDB ログイン認証情報
mongodb.sh.discovery[connString,<user>,<password>]
クラスター内に存在する検出されたシャードのリストを返します。
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user, password - MongoDB ログイン認証情報
mongodb.version[connString,<user>,<password>]
データベースサーバーのバージョンを返します。
戻り値: String
パラメーター:
- connString - URIまたはセッション名
- user, password - MongoDBログイン認証情報
mqtt.get[<broker url>,topic,<user>,<password>]
指定されたブローカーの特定のトピック（ワイルドカード指定可能）をサブスクライブし、パブリケーションを待機します。
戻り値: トピックの内容によって異なります。ワイルドカードが使用されている場合は、トピックの内容をJSON形式で返します。
パラメーター:
- broker url - クエリパラメーターを含まない
protocol://host:port形式のMQTTブローカーURL（サポートされるプロトコル:tcp、ssl、ws）。値が指定されていない場合、エージェントはtcp://localhost:1883を使用します。プロトコルまたはポートが省略されている場合、デフォルトのプロトコル（tcp）またはポート（1883）が使用されます。 - topic - MQTTトピック（必須）。ワイルドカード (+,#) がサポートされています。
- user, password - 認証情報 (必要な場合)
コメント:
- アイテムは アクティブチェック (「Zabbix エージェント (アクティブ)」アイテムタイプ) として設定する必要があります。
- TLS 暗号化証明書は、デフォルトの場所 (Ubuntu の場合は
/etc/ssl/certs/ディレクトリなど) に保存することで使用できます。TLS の場合はtls://スキームを使用します。
mssql.availability.group.get[URI,<user>,<password>]
可用性グループを返します。
戻り値: JSON オブジェクト
パラメーター:
- URI - MSSQL サーバーの URI (サポートされているスキーマは
sqlserver://のみです)。埋め込まれた認証情報は無視されます。URI の一部としてインスタンス名を指定できます (例:sqlserver://localhost/InstanceName(ポート番号なし))。ポート番号が指定されている場合、インスタンス名は無視されます。 - user, password - 保護された MSSQL サーバーに送信するユーザー名とパスワード
詳細については、MSSQL プラグイン の Readme を参照してください。
mssql.custom.query[URI,<user>,<password>,queryName,<args...>]
カスタムクエリの結果を返します。
戻り値: JSON オブジェクト
パラメーター:
- URI - MSSQL サーバーの URI (サポートされているスキーマは
sqlserver://のみです)。埋め込まれた資格情報は無視されます。URI の一部としてインスタンス名を指定できます (例:sqlserver://localhost/InstanceName(ポート番号なし))。ポートが指定されている場合、インスタンス名は無視されます。 - user, password - 保護されたMSSQLサーバーに送信するユーザー名とパスワード
- queryName -
Plugins.MSSQL.CustomQueriesDirで設定されたカスタムクエリの名前（拡張子.sqlを除く） - args - クエリに渡す1つまたは複数のカンマ区切りの引数
詳細については、MSSQLプラグインのReadmeを参照してください。
mssql.db.get
利用可能なすべてのMSSQLデータベースを返します。
戻り値: JSONオブジェクト
詳細については、MSSQLプラグインのReadmeをご覧ください。
mssql.job.status.get
ジョブのステータスを返します。
戻り値: JSON オブジェクト
詳細については、MSSQL プラグイン の Readme を参照してください。
mssql.last.backup.get
すべてのデータベースの最終バックアップ時刻を返します。
戻り値: JSON オブジェクト
詳細については、MSSQL プラグイン の Readme を参照してください。
mssql.local.db.get
Always On 可用性グループとレプリカ（プライマリまたはセカンダリ）に参加しており、接続が確立されたサーバー上にあるデータベースを返します。
戻り値: JSON オブジェクト
詳細については、MSSQL プラグイン の Readme を参照してください。
mssql.mirroring.get
ミラーリング情報を返します。
戻り値: JSON オブジェクト
詳細については、MSSQL プラグイン の Readme を参照してください。
mssql.nonlocal.db.get
Always On 可用性グループに参加しているデータベースと、他のサーバー上にあるレプリカ（プライマリまたはセカンダリ）を返します（データベースは、接続が確立された SQL Server インスタンスのローカルではありません）
戻り値: JSON オブジェクト
詳細については、MSSQL プラグイン の Readme を参照してください。
mssql.perfcounter.get
パフォーマンスカウンターを返します。
戻り値: JSON オブジェクト
詳細については、MSSQL プラグイン の Readme を参照してください。
mssql.ping
データベースにpingを実行します。接続が正しく設定されているかどうかをテストします。
戻り値: 1 - 正常、0 - 正常ではありません。
詳細については、MSSQL プラグイン の Readme を参照してください。
mssql.quorum.get
クォーラム情報を返します。
戻り値: JSON オブジェクト
詳細については、MSSQL プラグイン の Readme を参照してください。
mssql.quorum.member.get
クォーラムメンバーを返します。
戻り値: JSON オブジェクト
詳細については、MSSQL プラグイン の Readme を参照してください。
mssql.replica.get
レプリカを返します。
戻り値: JSON オブジェクト
詳細については、MSSQL プラグイン の Readme を参照してください。
mssql.version
MSSQL のバージョンを返します。
戻り値: 文字列
詳細については、MSSQL プラグイン の Readme を参照してください。
mysql.custom.query[connString,<user>,<password>,queryName,<args...>]
Returns the result of a custom query.
Return value: JSON object.
Parameters:
- connString - URI or session name;
- user, password - MySQL login credentials;
- queryName - name of a custom query, must match SQL file name without an extension.
- args - one or several comma-separated arguments to pass to a query.
Supported since Zabbix 6.4.6.
mysql.db.discovery[connString,<user>,<password>]
MySQLデータベースのリストを返します。ローレベルディスカバリに使用されます。
戻り値: LLD JSON形式での"show databases" SQLクエリの結果
パラメーター:
- connString - URIまたはセッション名
- user, password - MySQLログイン認証情報
mysql.db.size[connString,<user>,<password>,<database name>]
データベースのサイズ（バイト単位）
戻り値: 特定のデータベースに対するSQLクエリ"select coalesce(sum(data_length + index_length),0) as size from information_schema.tables where table_schema=?"の結果（バイト単位）
パラメーター:
- connString - URIまたはセッション名
- user, password - MySQLログイン認証情報
- database name - データベース名
mysql.get_status_variables[connString,<user>,<password>]
グローバルステータス変数の値
戻り値: 「show global status」SQLクエリの結果（JSON形式）
パラメーター:
- connString - URIまたはセッション名
- user, password - MySQLログイン認証情報
mysql.ping[connString,<user>,<password>]
接続が確立されているかどうかをテストします。
戻り値: 1 - 接続が確立されています。0 - 接続が切断されています（認証や設定の問題など、何らかのエラーが表示されている場合）
パラメーター:
- connString - URI またはセッション名
- user, password - MySQL ログイン認証情報
mysql.replication.discovery[connString,<user>,<password>]
MySQLレプリケーションのリストを返します。ローレベルディスカバリに使用されます。
戻り値: LLD JSON形式での"show slave status" SQLクエリの結果
パラメーター:
- connString - URIまたはセッション名
- user, password - MySQLログイン認証情報
mysql.replication.get_slave_status[connString,<user>,<password>,<master host>]
レプリケーションのステータス
戻り値: JSON形式での「show slave status」SQLクエリの結果
パラメーター:
- connString - URIまたはセッション名
- user, password - MySQLログイン認証情報
- master host - レプリケーションマスターホスト名。見つからない場合はエラーが返されます。このパラメーターが指定されていない場合は、すべてのホストが返されます。
mysql.version[connString,<user>,<password>]
MySQLのバージョン
戻り値: String (MySQLインスタンスのバージョン)
パラメーター:
- connString - URIまたはセッション名
- user, password - MySQLログイン認証情報
net.dns.get[<ip>,name,<type>,<timeout>,<count>,<protocol>,"<flags>"]
DNSクエリを実行し、詳細なDNSレコード情報を返します。
このアイテムは、net.dns.record Zabbixエージェントアイテムの拡張版で、より多くのレコードタイプとカスタマイズ可能なフラグをサポートしています。
戻り値: JSONオブジェクト
パラメーター:
- ip - DNSサーバーのIPアドレス（デフォルトのDNSサーバーの場合は空白のままにします）
- name - クエリ対象のDNS名
- type - クエリ対象のレコードタイプ（デフォルトはSOA）
- timeout - リクエストのタイムアウト（秒数）（デフォルトは1秒）
- count - リクエストの試行回数（デフォルトは2）
- protocol - DNSクエリを実行するために使用されるプロトコル：udp（デフォルト）またはtcp
- flags - クエリに渡す1つ以上のカンマ区切りの引数
コメント:
typeに指定できる値は、A、NS、MD、MF、CNAME、SOA、MB、MG、MR、NULL、PTR、HINFO、MINFO、MX、TXT、RP、AFSDB、X25、ISDN、RT、NSAPPTR、SIG、KEY、PX、GPOS、AAAA、LOC、NXT、EID、NIMLOC、SRV、ATMA、NAPTR、KX、CERT、DNAME、OPT、APL、DS、SSHFP、IPSECKEY、RRSIG、NSEC、DNSKEY、DHCID、NSEC3 です。 NSEC3PARAM、TLSA、SMIMEA、HIP、NINFO、RKEY、TALINK、CDS、CDNSKEY、OPENPGPKEY、CSYNC、ZONEMD、SVCB、HTTPS、SPF、UINFO、UID、GID、UNSPEC、NID、L32、L64、LP、EUI48、EUI64、URI、CAA、AVC、AMTRELAY。 値は大文字のみでなければなりません。小文字または大文字と小文字が混在した値はサポートされていません。- 逆DNSルックアップ（
typeがPTRに設定されている場合）では、DNS名を逆引き形式と非逆引き形式の両方で指定できます（以下の例を参照）。 PTRレコードが要求された場合、DNS名は実際にはIPアドレスであることに注意してください。 flagsに指定できる値は、cdflagまたはnocdflag（デフォルト）、rdflag（デフォルト）またはnordflag、dnssecまたはnodnssec（デフォルト）、nsidまたはnonsid（デフォルト）、edns0（デフォルト）またはnoedns0、aaflagまたはnoaaflag（デフォルト）、adflagまたはnoadflag（デフォルト）です。flagsdnssecとnsidは、どちらもedns0を必要とするため、noedns0と一緒に使用することはできません。 値は小文字のみでなければなりません。大文字または大文字と小文字が混在した値はサポートされていません。- 国際化ドメイン名はサポートされていません。代わりにIDNAエンコードされた名前を使用してください。
- 出力は、指定されたパラメータに基づいたDNSレコード情報を含むオブジェクトです（詳細を参照してください）
例：
net.dns.get[192.0.2.0,example.com,DNSKEY,3,3,tcp,"cdflag,rdflag,nsid"]
net.dns.get[,198.51.100.1,PTR,,,,"cdflag,rdflag,nsid"]
net.dns.get[,1.100.51.198.in-addr.arpa,PTR,,,,"cdflag,rdflag,nsid"]
net.dns.get[,2a00:1450:400f:800::200e,PTR,,,,"cdflag,rdflag,nsid"]
net.dns.get[,e.0.0.2.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.0.f.0.0.4.0.5.4.1.0.0.a.2.ip6.arpa,PTR,,,,"cdflag,rdflag,nsid"]nvml.device.count
GPUデバイスの数
戻り値: Integer
詳細については、NVIDIA GPUプラグインのReadmeをご覧ください。
nvml.device.decoder.utilization[<deviceUUID>]
GPUデバイスデコーダーの使用率（パーセント）
戻り値: Integer
パラメーター:
- deviceUUID - GPUデバイスUUID
詳細については、NVIDIA GPUプラグインのReadmeをご覧ください。
nvml.device.ecc.mode[<deviceUUID>]
GPUデバイスのECCモード情報（現在、保留中）
戻り値: JSON
パラメーター:
- deviceUUID - GPUデバイスのUUID
詳細については、NVIDIA GPUプラグインのReadmeをご覧ください。
nvml.device.encoder.stats.get[<deviceUUID>]
GPUデバイスエンコーダの統計情報
戻り値: JSON
パラメーター:
- deviceUUID - GPUデバイスのUUID
詳細については、NVIDIA GPUプラグインのReadmeをご覧ください。
nvml.device.encoder.utilization[<deviceUUID>]
GPUデバイスエンコーダーの使用率（パーセント）
戻り値: Integer
パラメーター:
- deviceUUID - GPUデバイスUUID
詳細については、NVIDIA GPUプラグインのReadmeをご覧ください。
nvml.device.energy.consumption[<deviceUUID>]
ドライバーが最後にリロードされてからのGPUデバイスの総消費電力（ミリジュール（mJ）単位）
戻り値: Integer
パラメーター:
- deviceUUID - GPUデバイスのUUID
詳細については、NVIDIA GPUプラグインのReadmeをご覧ください。
nvml.device.errors.memory[<deviceUUID>]
GPUデバイスのECCメモリエラー情報（修正済み、未修正）
戻り値: JSON
パラメーター:
- deviceUUID - GPUデバイスのUUID
詳細については、NVIDIA GPUプラグインのReadmeをご覧ください。
nvml.device.errors.register[<deviceUUID>]
GPUデバイスのECCレジスタエラー情報（修正済み、未修正）
戻り値: JSON
パラメーター:
- deviceUUID - GPUデバイスのUUID
詳細については、NVIDIA GPUプラグインのReadmeをご覧ください。
nvml.device.fan.speed.avg[<deviceUUID>]
GPUデバイスの平均ファン速度（最大速度に対するパーセンテージ）
戻り値: Integer
パラメーター:
- deviceUUID - GPUデバイスのUUID
詳細については、NVIDIA GPUプラグインのReadmeをご覧ください。
nvml.device.get
UUIDと名前で検出されたGPU
戻り値: JSON
詳細については、NVIDIA GPUプラグインのReadmeをご覧ください。
nvml.device.graphics.freq[<deviceUUID>]
GPUデバイスのグラフィッククロック速度（MHz）
戻り値: Integer
パラメーター:
- deviceUUID - GPUデバイスのUUID
詳細については、NVIDIA GPUプラグインのReadmeをご覧ください。
nvml.device.memory.fb.get[<deviceUUID>]
GPUデバイスのフレームバッファメモリ統計情報（合計、予約済み、空き、使用済み）
戻り値: JSON
パラメーター:
- deviceUUID - GPUデバイスのUUID
詳細については、NVIDIA GPUプラグインのReadmeをご覧ください。
nvml.device.memory.bar1.get[<deviceUUID>]
GPUデバイスBAR1のメモリ統計情報（合計、空き、使用）
戻り値: JSON
パラメーター:
- deviceUUID - GPUデバイスのUUID
詳細については、NVIDIA GPUプラグインのReadmeをご覧ください。
nvml.device.memory.freq[<deviceUUID>]
GPUデバイスのメモリクロック速度（MHz）
戻り値: Integer
パラメーター:
- deviceUUID - GPUデバイスのUUID
詳細については、NVIDIA GPUプラグインのReadmeをご覧ください。
nvml.device.pci.utilization[<deviceUUID>]
GPUデバイスのPCI使用率（KBps単位の送受信スループット）
戻り値: JSON
パラメーター:
- deviceUUID - GPUデバイスのUUID
詳細については、NVIDIA GPUプラグインのReadmeをご覧ください。
nvml.device.pci.utilization[<deviceUUID>]
GPUデバイスのPCI使用率（KBps単位の送受信スループット）
戻り値: JSON
パラメーター:
- deviceUUID - GPUデバイスのUUID
詳細については、NVIDIA GPUプラグインのReadmeをご覧ください。
nvml.device.power.limit[<deviceUUID>]
GPUデバイスの電力制限（ミリワット単位）
戻り値: Integer
パラメーター:
- deviceUUID - GPUデバイスのUUID
詳細については、NVIDIA GPUプラグインのReadmeをご覧ください。
nvml.device.power.usage[<deviceUUID>]
GPUデバイスの現在の電力使用量（ミリワット単位）
戻り値: Integer
パラメーター:
- deviceUUID - GPUデバイスのUUID
詳細については、NVIDIA GPUプラグインのReadmeをご覧ください。
nvml.device.serial[<deviceUUID>]
GPUデバイスのシリアル番号
戻り値: 文字列
パラメーター:
- deviceUUID - GPUデバイスのUUID
詳細については、NVIDIA GPUプラグインのReadmeをご覧ください。
nvml.device.sm.freq[<deviceUUID>]
GPUデバイスのストリーミングマルチプロセッサクロック速度（MHz）
戻り値: Integer
パラメーター:
- deviceUUID - GPUデバイスのUUID
詳細については、NVIDIA GPUプラグインのReadmeをご覧ください。
nvml.device.temperature[<deviceUUID>]
GPUデバイスの温度（摂氏）
戻り値: Integer
パラメーター:
- deviceUUID - GPUデバイスのUUID
詳細については、NVIDIA GPUプラグインのReadmeをご覧ください。
nvml.device.utilization[<deviceUUID>]
GPUデバイスの使用率統計（GPU/メモリ使用率のパーセンテージ）
戻り値: JSON
パラメーター:
- deviceUUID - GPUデバイスのUUID
詳細については、NVIDIA GPUプラグインのReadmeをご覧ください。
nvml.device.video.freqnue[<deviceUUID>]
GPUデバイスのビデオクロック速度（MHz）
戻り値: Integer
パラメーター:
- deviceUUID - GPUデバイスのUUID
詳細については、NVIDIA GPUプラグインのReadmeをご覧ください。
nvml.system.driver.version
NVIDIA ドライバーのバージョン
戻り値: 文字列
詳細については、NVIDIA GPU プラグイン の Readme を参照してください。
nvml.version
NVMLライブラリのバージョン
戻り値: 文字列
詳細については、NVIDIA GPUプラグインのReadmeをご覧ください。
oracle.diskgroups.stats[connString,<user>,<password>,<service>,<diskgroup>]
自動ストレージ管理（ASM）ディスクグループの統計を返します。
戻り値：JSONオブジェクト
パラメータ:
- connString - URI またはセッション名
- user - Oracle ユーザー名。ログインオプション
as sysdba、as sysoper、as sysasmのいずれかをuser as sysdbaの形式で追加できます（ログインオプションは大文字と小文字が区別されず、末尾にスペースを含めることはできません）。 - password - Oracle パスワード
- service - Oracle サービス名
- diskgroup - クエリする ASM ディスクグループの名前
oracle.diskgroups.discovery[connString,<user>,<password>,<service>]
ASMディスクグループのリストを返します。低レベル検出に使用されます。
戻り値: JSONオブジェクト
パラメーター:
- connString - URIまたはセッション名
- user - Oracleユーザー名。ログインオプション
as sysdba、as sysoper、as sysasmのいずれかをuser as sysdbaの形式で追加できます（ログインオプションは大文字と小文字が区別されず、末尾にスペースを含めることはできません）。 - password - Oracleパスワード
- service - Oracleサービス名
oracle.archive.info[connString,<user>,<password>,<service>,<destination>]
アーカイブログの統計情報
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user - Oracle ユーザー名。ログインオプションとして、
as sysdba、as sysoper、as sysasmのいずれかをuser as sysdbaの形式で追加できます（ログインオプションは大文字と小文字が区別されず、末尾にスペースを含めることはできません）。 - password - Oracle パスワード
- service - Oracle サービス名
- destination - クエリの対象となる宛先の名前
oracle.cdb.info[connString,<user>,<password>,<service>,<database>]
コンテナ・データベース（CDB）の情報
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user - Oracle ユーザー名。ログインオプション
as sysdba、as sysoper、as sysasmのいずれかをuser as sysdbaの形式で追加できます（ログインオプションは大文字と小文字が区別されず、末尾にスペースを含めることはできません）。 - password - Oracle パスワード
- service - Oracle サービス名
- destination - クエリを実行するデータベースの名前
oracle.custom.query[connString,<user>,<password>,<service>,queryName,<args...>]
カスタムクエリの結果
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user - Oracle ユーザー名。ログインオプション'as sysdba'、'as sysoper'、'as sysasm'のいずれかを'user as sysdba'の形式で追加できます（ログインオプションは大文字と小文字が区別されず、末尾にスペースを含めることはできません）
- password - Oracle パスワード
- service - Oracle サービス名
- queryName - カスタムクエリの名前。拡張子を除いた SQL ファイル名と一致する必要があります。
- args - クエリに渡す 1 つまたは複数のカンマ区切りの引数
コメント: - 返されるデータは自動的に JSON に変換されます。 - クエリから直接 JSON を返すことは避けてください。プラグインが再度 JSON に変換しようとする際に、JSON が破損する可能性があります。
oracle.datafiles.stats[connString,<user>,<password>,<service>]
データファイルの統計情報を返します。
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user - Oracle ユーザー名。ログインオプション'as sysdba'、'as sysoper'、'as sysasm'のいずれかを'user as sysdba'の形式で追加できます（ログインオプションは大文字と小文字が区別されず、末尾にスペースを含めることはできません）。
- password - Oracle パスワード
- service - Oracle サービス名
- diskgroup - クエリする ASM ディスクグループの名前
oracle.db.discovery[connString,<user>,<password>,<service>]
データベースのリストを返します。低レベル検出に使用されます。
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user - Oracle ユーザー名。ログインオプション'as sysdba'、'as sysoper'、'as sysasm'のいずれかを'user as sysdba'の形式で追加できます（ログインオプションは大文字と小文字が区別されず、末尾にスペースを含めることはできません）。
- password - Oracle パスワード
- service - Oracle サービス名
oracle.fra.stats[connString,<user>,<password>,<service>]
高速リカバリ領域（FRA）統計情報を返します。
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user - Oracle ユーザー名。ログインオプション'as sysdba'、'as sysoper'、'as sysasm'のいずれかを'user as sysdba'の形式で追加できます（ログインオプションは大文字と小文字が区別されず、末尾にスペースを含めることはできません）。
- password - Oracle パスワード
- service - Oracle サービス名
oracle.instance.info[connString,<user>,<password>,<service>]
インスタンスの統計情報
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user - Oracle ユーザー名。ログインオプション
as sysdba、as sysoper、as sysasmのいずれかをuser as sysdbaの形式で追加できます（ログインオプションは大文字と小文字が区別されず、末尾にスペースを含めることはできません） - password - Oracle パスワード
- service - Oracle サービス名
oracle.pdb.info[connString,<user>,<password>,<service>,<database>]
プラガブル・データベース（PDB）の情報
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user - Oracle ユーザー名。ログインオプション（
as sysdba、as sysoper、as sysasmのいずれか）をuser as sysdbaの形式で追加できます（ログインオプションは大文字と小文字が区別されず、末尾にスペースを含めることはできません） - password - Oracle パスワード
- service - Oracle サービス名
- destination - クエリを実行するデータベースの名前
oracle.pdb.discovery[connString,<user>,<password>,<service>]
PDBのリストを返します。低レベル検出に使用されます。
戻り値: JSONオブジェクト
パラメーター:
- connString - URIまたはセッション名
- user - Oracleユーザー名。ログインオプション
as sysdba、as sysoper、as sysasmのいずれかをuser as sysdbaの形式で追加できます（ログインオプションは大文字と小文字が区別されず、末尾にスペースを含めることはできません） - password - Oracleパスワード
- service - Oracleサービス名
oracle.pga.stats[connString,<user>,<password>,<service>]
プログラム・グローバル領域（PGA）の統計情報を返します。
戻り値：JSONオブジェクト
パラメーター：
- connString - URIまたはセッション名
- user - Oracleユーザー名。ログインオプション
as sysdba、as sysoper、as sysasmのいずれかをuser as sysdbaの形式で追加できます（ログインオプションは大文字と小文字が区別されず、末尾にスペースを含めることはできません） - password - Oracleパスワード
- service - Oracleサービス名
oracle.ping[connString,<user>,<password>,<service>]
Oracle への接続を確立できるかどうかをテストします。
戻り値: 1 - 接続成功 0 - 接続失敗（AUTH や設定の問題など、何らかのエラーが発生した場合）
パラメーター:
- connString - URI またはセッション名
- user - Oracle ユーザー名。ログインオプションとして、
as sysdba、as sysoper、as sysasmのいずれかをuser as sysdbaという形式で追加できます（ログインオプションは大文字と小文字が区別されず、末尾にスペースを含めることはできません） - password - Oracle パスワード
- service - Oracle サービス名
oracle.proc.stats[connString,<user>,<password>,<service>]
プロセスの統計情報を返します。
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user - Oracle ユーザー名。ログインオプション
as sysdba、as sysoper、as sysasmのいずれかをuser as sysdbaの形式で追加できます（ログインオプションは大文字と小文字が区別されず、末尾にスペースを含めることはできません） - password - Oracle パスワード
- service - Oracle サービス名
oracle.redolog.info[connString,<user>,<password>,<service>]
制御ファイルからのログファイル情報
戻り値: JSON オブジェクト
パラメータ:
- connString - URI またはセッション名
- user - Oracle ユーザー名。ログインオプション
as sysdba、as sysoper、as sysasmのいずれかをuser as sysdbaの形式で追加できます（ログインオプションは大文字と小文字が区別されず、末尾にスペースを含めることはできません） - password - Oracle パスワード
- service - Oracle サービス名
oracle.sga.stats[connString,<user>,<password>,<service>]
システム・グローバル領域（SGA）の統計情報を返します。
戻り値：JSONオブジェクト
パラメーター：
- connString - URIまたはセッション名
- user - Oracleユーザー名。ログインオプション
as sysdba、as sysoper、as sysasmのいずれかをuser as sysdbaの形式で追加できます（ログインオプションは大文字と小文字が区別されず、末尾にスペースを含めることはできません） - password - Oracleパスワード
- service - Oracleサービス名
oracle.sessions.stats[connString,<user>,<password>,<service>,<lockMaxTime>]
セッション統計を返します。
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user - Oracle ユーザー名。ログインオプション
as sysdba、as sysoper、as sysasmのいずれかをuser as sysdbaの形式で追加できます（ログインオプションは大文字と小文字が区別されず、末尾にスペースを含めることはできません） - password - Oracle パスワード
- service - Oracle サービス名
- lockMaxTime - セッションを長時間ロックされたとカウントする最大セッションロック時間（秒）デフォルト: 600 秒
oracle.sys.metrics[connString,<user>,<password>,<service>,<duration>]
システムメトリック値のセットを返します。
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user - Oracle ユーザー名。ログインオプション
as sysdba、as sysoper、as sysasmのいずれかをuser as sysdbaの形式で追加できます（ログインオプションは大文字と小文字が区別されず、末尾にスペースを含めることはできません） - password - Oracle パスワード
- service - Oracle サービス名
- duration - システムメトリック値のキャプチャ間隔（秒単位）可能な値: 60 — 長い期間 (デフォルト)、15 — 短い期間
oracle.sys.params[connString,<user>,<password>,<service>]
システムパラメータ値のセットを返します。
戻り値: JSON オブジェクト
パラメータ:
- connString - URI またはセッション名
- user - Oracle ユーザー名。ログインオプション
as sysdba、as sysoper、as sysasmのいずれかをuser as sysdbaの形式で追加できます（ログインオプションは大文字と小文字が区別されず、末尾にスペースを含めることはできません） - password - Oracle パスワード
- service - Oracle サービス名
oracle.ts.stats[connString,<user>,<password>,<service>,<tablespace>,<type>,<conname>]
表領域の統計情報を返します。
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user - Oracle ユーザー名。ログインオプション
as sysdba、as sysoper、as sysasmのいずれかをuser as sysdbaの形式で追加できます（ログインオプションは大文字と小文字が区別されず、末尾にスペースを含めることはできません） - password - Oracle パスワード
- service - Oracle サービス名
- tablespace - クエリする表領域の名前。デフォルト（空のままで
typeが設定されている場合）:
-TEMP（typeがTEMPORARYに設定されている場合）;
-USERS（typeがPERMANENTに設定されている場合） - type - 問い合せる表領域のタイプ。デフォルト（
tablespaceが設定されている場合）:PERMANENT - conname - 情報が必要なコンテナの名前
tablespace、type、またはconnameが省略されている場合、この項目は一致するすべてのコンテナ（PDBとCDBを含む）の表領域統計を返します。
oracle.ts.discovery[connString,<user>,<password>,<service>]
表領域のリストを返します。低レベル検出に使用されます。
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user - Oracle ユーザー名。ログインオプション
as sysdba、as sysoper、as sysasmのいずれかをuser as sysdbaの形式で追加できます（ログインオプションは大文字と小文字が区別されず、末尾にスペースを含めることはできません） - password - Oracle パスワード
- service - Oracle サービス名
oracle.user.info[connString,<user>,<password>,<service>,<username>]
Oracle ユーザー情報を返します。
戻り値: JSON オブジェクト
パラメーター:
- connString - URI またはセッション名
- user - Oracle ユーザー名。ログインオプション
as sysdba、as sysoper、as sysasmのいずれかをuser as sysdbaの形式で追加できます（ログインオプションは大文字と小文字を区別せず、末尾にスペースを含めることはできません） - password - Oracle パスワード
- service - Oracle サービス名
- username - 情報が必要なユーザー名。小文字のユーザー名はサポートされていません。デフォルト: 現在のユーザー。
oracle.version[connString,<user>,<password>,<service>]
データベース・サーバーのバージョンを返します。
戻り値: String
パラメーター:
- connString - URIまたはセッション名
- user - Oracleユーザー名。ログイン・オプション
as sysdba、as sysoper、as sysasmのいずれかをuser as sysdbaの形式で追加できます（ログイン・オプションは大文字と小文字を区別せず、末尾にスペースを含めることはできません） - password - Oracleパスワード
- service - Oracleサービス名
pgsql.autovacuum.count[uri,<username>,<password>,<database name>]
自動バキュームワーカーの数
戻り値: Integer
パラメーター:
- uri - URIまたはセッション名
- username, password - PostgreSQLの認証情報
- database name - データベース名
pgsql.archive[uri,<username>,<password>,<database name>]
アーカイブされたファイルに関する情報
戻り値: JSON オブジェクト
パラメーター:
- uri - URI またはセッション名
- username, password - PostgreSQL の認証情報
- database name - データベース名
pgsql.bgwriter[uri,<username>,<password>,<database name>]
データベースクラスターのチェックポイントの合計数（チェックポイントの種類別）
戻り値: JSON オブジェクト
パラメーター:
- uri - URI またはセッション名
- username, password - PostgreSQL の認証情報
- database name - データベース名
pgsql.cache.hit[uri,<username>,<password>,<database name>]
PostgreSQLバッファキャッシュのヒット率
戻り値: Float
パラメーター:
- uri - URIまたはセッション名
- username, password - PostgreSQLの認証情報
- database name - データベース名
pgsql.connections[uri,<username>,<password>,<database name>]
接続の種類
戻り値: JSON オブジェクト
パラメーター:
- uri - URI またはセッション名
- username, password - PostgreSQL の認証情報
- database name - データベース名
pgsql.custom.query[uri,<username>,<password>,queryName,<args...>]
カスタムクエリの結果
戻り値: JSON オブジェクト
パラメーター:
- uri - URI またはセッション名
- username, password - PostgreSQL の認証情報
- queryName - カスタムクエリの名前。拡張子を除いた SQL ファイル名と一致する必要があります。
- args - クエリに渡す 1 つまたは複数のカンマ区切りの引数
pgsql.db.age[uri,<username>,<password>,<database name>]
データベースの最も古いFrozenXIDの経過時間
戻り値: Integer
パラメーター:
- uri - URIまたはセッション名
- username, password - PostgreSQLの認証情報
- database name - データベース名
pgsql.db.bloating_tables[uri,<username>,<password>,<database name>]
データベースあたりの肥大化テーブル数
戻り値: Integer
パラメーター:
- uri - URIまたはセッション名
- username, password - PostgreSQLの認証情報
- database name - データベース名
pgsql.db.discovery[uri,<username>,<password>,<database name>]
PostgreSQL データベースのリスト。ローレベルディスカバリ に使用されます。
戻り値: JSON オブジェクト
パラメーター:
- uri - URI またはセッション名
- username, password - PostgreSQL の認証情報
- database name - データベース名
pgsql.db.size[uri,<username>,<password>,<database name>]
データベースのサイズ（バイト単位）
戻り値: Integer
パラメーター:
- uri - URI またはセッション名
- username, password - PostgreSQL の認証情報
- database name - データベース名
pgsql.dbstat[uri,<username>,<password>,<database name>]
データベースごとの統計情報を収集します。低レベル検出に使用されます。
戻り値: JSON オブジェクト
パラメーター:
- uri - URI またはセッション名
- username, password - PostgreSQL の認証情報
- database name - データベース名
pgsql.dbstat.sum[uri,<username>,<password>,<database name>]
クラスタ内のすべてのデータベースの要約データ
戻り値: JSON オブジェクト
パラメーター:
- uri - URI またはセッション名
- username, password - PostgreSQL の認証情報
- database name - データベース名
pgsql.locks[uri,<username>,<password>,<database name>]
データベースごとに付与されたロックに関する情報。ローレベルディスカバリに使用されます。
戻り値: JSON オブジェクト
パラメーター:
- uri - URI またはセッション名
- username, password - PostgreSQL の認証情報
- database name - データベース名
pgsql.oldest.xid[uri,<username>,<password>,<database name>]
最も古いXIDの経過時間
戻り値: Integer
パラメーター:
- uri - URIまたはセッション名
- username, password - PostgreSQLの認証情報
- database name - データベース名
pgsql.ping[uri,<username>,<password>,<database name>]
接続が確立されているかどうかをテストします。
戻り値: 1 - 接続が確立されています。0 - 接続が切断されています（認証や設定の問題などのエラーが表示された場合）
パラメーター:
- uri - URI またはセッション名
- username, password - PostgreSQL の認証情報
- database name - データベース名
pgsql.queries[uri,<username>,<password>,<database name>,<time period>]
実行時間に基づいてメトリクスをクエリします。
戻り値: JSON オブジェクト
パラメーター:
- uri - URI またはセッション名
- username, password - PostgreSQL の認証情報
- database name - データベース名
- timePeriod - スロークエリの数をカウントする実行時間制限（正の整数である必要があります）
pgsql.replication.count[uri,<username>,<password>]
スタンバイサーバーの数
戻り値: Integer
パラメーター:
- uri - URIまたはセッション名
- username, password - PostgreSQLの認証情報
pgsql.replication.process[uri,<username>,<password>]
送信プロセスごとのフラッシュ遅延、書き込み遅延、および再生遅延
戻り値: JSON オブジェクト
パラメーター:
- uri - URI またはセッション名
- username, password - PostgreSQL の認証情報
pgsql.replication.process.discovery[uri,<username>,<password>]
レプリケーションプロセス名discovery
戻り値: JSONオブジェクト
パラメーター:
- uri - URIまたはセッション名
- username, password - PostgreSQLの認証情報
pgsql.replication.recovery_role[uri,<username>,<password>]
リカバリの状態
戻り値: 0 - マスターモード。1 - リカバリ進行中（スタンバイモード）
パラメーター:
- uri - URI またはセッション名
- username, password - PostgreSQL の認証情報
pgsql.replication.status[uri,<username>,<password>]
レプリケーションのステータス
戻り値: 0 - ストリーミングが停止中。1 - ストリーミングが稼働中。2 - マスターモード
パラメーター:
- uri - URI またはセッション名
- username, password - PostgreSQL の認証情報
pgsql.replication_lag.b[uri,<username>,<password>]
レプリケーション遅延（バイト単位）
戻り値: Integer
パラメーター:
- uri - URI またはセッション名
- username, password - PostgreSQL の認証情報
pgsql.replication_lag.sec[uri,<username>,<password>]
レプリケーション遅延（秒）
戻り値: Integer
パラメーター:
- uri - URI またはセッション名
- username, password - PostgreSQL の認証情報
pgsql.uptime[uri,<username>,<password>,<database name>]
PostgreSQL の稼働時間（ミリ秒）
戻り値: Float
パラメーター:
- uri - URI またはセッション名
- username, password - PostgreSQL の認証情報
- database name - データベース名
pgsql.version[uri,<username>,<password>,<database name>]
PostgreSQLのバージョン
戻り値: String
パラメーター:
- uri - URIまたはセッション名
- username, password - PostgreSQLの認証情報
- database name - データベース名
pgsql.wal.stat[uri,<username>,<password>,<database name>]
WAL統計情報
戻り値: JSONオブジェクト
パラメーター:
- uri - URIまたはセッション名
- username, password - PostgreSQL認証情報
- database name - データベース名
redis.config[connString,<password>,<pattern>]
パターンに一致するRedisインスタンスの設定パラメータを取得
戻り値: JSON - glob形式のパターンが使用された場合。単一の値 - パターンにワイルドカード文字が含まれていない場合。
パラメータ:
- connString - URIまたはセッション名
- password - Redisパスワード
- pattern - glob形式のパターン（デフォルトは*）
redis.info[connString,<password>,<section>]
INFO コマンドの出力を取得
戻り値: JSON - 出力は JSON としてシリアル化されます。
パラメーター:
- connString - URI またはセッション名
- password - Redis パスワード
- section - 情報の セクション (デフォルトでは default)
redis.ping[connString,<password>]
接続が確立されているかどうかをテストします。
戻り値: 1 - 接続が確立されています。0 - 接続が切断されています（認証や設定の問題など、何らかのエラーが発生した場合）
パラメーター:
- connString - URI またはセッション名
- password - Redis パスワード
redis.slowlog.count[connString,<password>]
Redis 起動以降のスローログエントリ数
戻り値: Integer
パラメーター:
- connString - URI またはセッション名
- password - Redis パスワード
smart.attribute.discovery
S.M.A.R.T.デバイス属性のリストを返します。
戻り値: JSONオブジェクト
コメント:
- 以下のマクロとその値が返されます: {#NAME}, {#DISKTYPE}, {#ID}, {#ATTRNAME}, {#THRESH};
- HDD、SSD、NVMEドライブタイプがサポートされています。ドライブは単独で使用することも、RAIDで組み合わせることもできます。RAIDの場合、{#NAME}にはアドオンが付きます。例: {"{#NAME}": "/dev/sda cciss,2"}
smart.disk.discovery
S.M.A.R.T.デバイスのリストを返します。
戻り値: JSONオブジェクト
コメント:
- 以下のマクロとその値が返されます: {#NAME}, {#DISKTYPE}, {#MODEL}, {#SN}, {#PATH}, {#ATTRIBUTES}, {#RAIDTYPE};
- HDD、SSD、NVMEドライブタイプがサポートされています。ドライブがRAIDに属していない場合、{#RAIDTYPE}は空になります。RAIDの場合、{#NAME}にはアドオンが付きます。例: {"{#NAME}": "/dev/sda cciss,2"}
smart.disk.get[<path>,<raid type>]
S.M.A.R.T.デバイスの利用可能なすべてのプロパティを返します。
戻り値: JSON オブジェクト
パラメーター:
- path - ディスクパス。値として {#PATH} マクロを使用できます。
- raid_type - RAID タイプ。値として {#RAID} マクロを使用できます。
コメント:
- HDD、SSD、NVME ドライブタイプがサポートされています。ドライブは単独で使用することも、RAID で組み合わせることもできます。
- データには、smartctl のバージョンと呼び出し引数、および追加フィールドが含まれます。
disk_name - RAID 検出に必要なアドオンを含むディスク名を保持します。例: {"disk_name": "/dev/sda cciss,2"br>disk_type - ディスクの種類（HDD、SSD、または NVME）を保持します。例: {"disk_type": "ssd"} - パラメータが指定されていない場合、この項目はすべてのディスクに関する情報を返します。
systemd.unit.get[ユニット名,<インターフェース>]
systemd ユニットのすべてのプロパティを返します。
戻り値: JSON オブジェクト
パラメーター:
- ユニット名 - ユニット名 (名前を確認するには、アイテムのプロトタイプで {#UNIT.NAME} マクロを使用することをお勧めします);
- インターフェース - ユニットインターフェースの種類。指定可能な値: Unit (デフォルト)、Service、Socket、Device、Mount、Automount、Swap、Target、Path
コメント:
- このアイテムは Linux プラットフォームでのみサポートされます。
- ユニットインターフェースの LoadState、ActiveState、および UnitFileState は、テキストと整数として返されます:
"ActiveState":{"state":1,"text":"active"}
systemd.unit.info[ユニット名,<プロパティ>,<インターフェース>]
systemd ユニット情報
戻り値: 文字列
パラメーター:
- ユニット名 - ユニット名 (名前を確認するには、アイテムプロトタイプで {#UNIT.NAME} マクロを使用することをお勧めします);
- プロパティ - ユニットプロパティ (例: ActiveState (デフォルト)、LoadState、Description);
- インターフェース - ユニットインターフェースタイプ (例: Unit (デフォルト)、Socket、Service)
コメント:
- このアイテムは Linux プラットフォームでのみサポートされます。
- このアイテムを使用すると、dbus API で説明されているように、特定のタイプのインターフェースから特定のプロパティを取得できます。
例:
systemd.unit.info["{#UNIT.NAME}"] #検出されたsystemdユニットのアクティブ状態（アクティブ、リロード中、非アクティブ、失敗、アクティベート中、非アクティベート中）情報を収集します。
systemd.unit.info["{#UNIT.NAME}",LoadState] #検出されたsystemdユニットのロード状態情報を収集します。
systemd.unit.info[mysqld.service,Id] #サービスの技術名を取得します（mysqld.service）
systemd.unit.info[mysqld.service,Description] #サービスの説明を取得します（MySQL Server）
systemd.unit.info[mysqld.service,ActiveEnterTimestamp] #サービスが最後にアクティブ状態になった時刻を取得します（1562565036283903）
systemd.unit.info[dbus.socket,NConnections,Socket] #このソケットユニットからの接続数を収集します。systemd.unit.discovery[<type>]
systemdユニットとその詳細のリスト。低レベル検出に使用されます。
戻り値: JSONオブジェクト
パラメーター:
- type - 可能な値: all、automount、device、mount、path、service (デフォルト)、socket、swap、target
この項目はLinuxプラットフォームでのみサポートされます。
web.certificate.get[hostname,<port>,<address>]
証明書を検証し、証明書の詳細を返します。
戻り値: JSON オブジェクト
Parameters:
- hostname - IP または DNS のいずれかです。
URL スキーム (https のみ)、パス (無視されます)、およびポート番号を含めることができます。
第 1 パラメーターと第 2 パラメーターの両方にポート番号が指定されている場合は、それらの値が一致している必要があります。
アドレス (第 3 パラメーター) が指定されている場合、ホスト名は SNI およびホスト名の検証にのみ使用されます。 - port - ポート番号 (HTTPS の場合はデフォルト 443)
- address - IP または DNS のいずれかです。指定されている場合は、接続に使用され、ホスト名 (第 1 パラメーター) は SNI およびホストの検証に使用されます。第 1 パラメータが IP で第 3 パラメータが DNS の場合、第 1 パラメータは接続に使用され、第 3 パラメータは SNI とホスト検証に使用されます。
Comments:
- ホスト構成で指定された接続先が存在しないか、利用できない場合、または TLS ハンドシェイクが無効な証明書以外のエラーで失敗した場合、この項目はサポートされません。
- Currently, AIA (Authority Information Access) X.509 extension, CRLs and OCSP (including OCSP stapling), and Certificate Transparency are not supported;
- JSON 応答フィールド: - x509: 証明書の詳細が含まれます。
- version: the X.509 バージョン (例:
3) - serial_number: : 証明書のシリアル番号
- signature_algorithm: 証明書の署名に使用されたアルゴリズム(例:
SHA256-RSA) - issuer: 証明書の発行者
- not_before: 証明書の有効期間の開始日
- not_after: 証明書の有効期限
- subject: 証明書のサブジェクト
- public_key_algorithm: 公開鍵に使用されたアルゴリズム (例:
RSA). - alternative_names: サブジェクトの別名（存在する場合）。存在しない場合は
null- result: 検証結果が含まれます。 - value: 検証ステータス（以下の有効な値を参照）
- message: 詳細な検証メッセージ (例：
"c証明書が正常に検証されました"). - sha1_fingerprint: 証明書のSHA-1フィンガープリント - sha256_fingerprint: 証明書のSHA-256フィンガープリント
- version: the X.509 バージョン (例:
- The
$.result.valueフィールドは証明書の検証結果を示します。可能な値は次のとおりです。:- valid – 証明書は有効で信頼されています。
- valid-but-self-signed – 証明書は有効ですが自己署名されています。つまり、サブジェクトが発行者と一致しています。
- invalid – ホスト名の誤り、署名機関の不明などの問題により、証明書が無効です。
例:
JSON Response:
{
"x509": {
"version": 3,
"serial_number": "0ad893bafa68b0b7fb7a404f06ecaf9a",
"signature_algorithm": "ECDSA-SHA384",
"issuer": "CN=DigiCert Global G3 TLS ECC SHA384 2020 CA1,O=DigiCert Inc,C=US",
"not_before": {
"value": "Jan 15 00:00:00 2025 GMT",
"timestamp": 1736899200
},
"not_after": {
"value": "Jan 15 23:59:59 2026 GMT",
"timestamp": 1768521599
},
"subject": "CN=*.example.com,O=Internet Corporation for Assigned Names and Numbers,L=Los Angeles,ST=California,C=US",
"public_key_algorithm": "ECDSA",
"alternative_names": [
"*.example.com",
"example.com"
]
},
"result": {
"value": "valid",
"message": "certificate verified successfully"
},
"sha1_fingerprint": "310db7af4b2bc9040c8344701aca08d0c69381e3",
"sha256_fingerprint": "455943cf819425761d1f950263ebf54755d8d684c25535943976f488bc79d23b"
}