1 Zabbixエージェント2

Zabbixエージェント 2 は、Unix および Windows の Zabbixエージェント でサポートされているすべてのアイテムキーをサポートしています。 このページでは、Zabbixエージェント 2 でのみ使用できる追加のアイテムキーについて、それらが属するプラグインごとにまとめて詳しく説明します。

アイテムキーは、パラメータおよび追加情報を省略した形で一覧表示されています。 アイテムキーをクリックすると、詳細を確認できます。

アイテムキー 説明 プラグイン
ceph.df.details クラスターのデータ使用量とプール間での分布。 Ceph
ceph.osd.stats 集約された OSD 統計および OSD ごとの統計。
ceph.osd.discovery 検出された OSD の一覧。
ceph.osd.dump OSD の使用量しきい値およびステータス。
ceph.ping Ceph への接続を確立できるかどうかをテストします。
ceph.pool.discovery 検出されたプールの一覧。
ceph.status クラスター全体のステータス。
docker.container_info コンテナに関する低レベル情報。 Docker
docker.container_stats コンテナのリソース使用統計。
docker.containers コンテナの一覧を返します。
docker.containers.discovery コンテナの一覧を返します。ローレベルディスカバリに使用されます。
docker.data.usage 現在のデータ使用量に関する情報。
docker.images イメージの一覧を返します。
docker.images.discovery イメージの一覧を返します。ローレベルディスカバリに使用されます。
docker.info システム情報。
docker.ping Docker デーモンが稼働しているかどうかをテストします。
ember.get 要求されたデバイスの結果を返します。 Ember+
memcached.ping 接続が有効かどうかをテストします。 Memcached
memcached.stats STATS コマンドの出力を取得します。
mongodb.collection.stats 指定されたコレクションに対するさまざまなストレージ統計を返します。 MongoDB
mongodb.collections.discovery 検出されたコレクションの一覧を返します。
mongodb.collections.usage コレクションの使用統計を返します。
mongodb.connpool.stats 現在のデータベースインスタンスから、シャーディングクラスターまたはレプリカセットの他のメンバーへの開いている送信接続に関する情報を返します。
mongodb.db.stats 指定されたデータベースシステムの状態を反映する統計を返します。
mongodb.db.discovery 検出されたデータベースの一覧を返します。
mongodb.jumbo_chunks.count jumbo チャンク数を返します。
mongodb.oplog.stats oplog から収集したデータを使用して、レプリカセットのステータスを返します。
mongodb.ping 接続が有効かどうかをテストします。
mongodb.rs.config レプリカセットの現在の設定を返します。
mongodb.rs.status このメソッドが実行されたメンバーの視点から見たレプリカセットのステータスを返します。
mongodb.server.status データベースの状態を返します。
mongodb.sh.discovery クラスター内に存在する検出済みシャードの一覧を返します。
mongodb.version データベースサーバーのバージョンを返します。
mqtt.get 指定されたブローカーの特定のトピック、またはトピック群(ワイルドカード付き)を購読し、パブリケーションを待機します。 MQTT
mssql.availability.group.get 可用性グループを返します。 MSSQL
mssql.custom.query カスタムクエリの結果を返します。
mssql.db.get 利用可能なすべての MSSQL データベースを返します。
mssql.job.status.get ジョブのステータスを返します。
mssql.last.backup.get すべてのデータベースの最終バックアップ時刻を返します。
mssql.local.db.get Always On 可用性グループおよびレプリカ(プライマリまたはセカンダリ)に参加しており、接続先のサーバー上に存在するデータベースを返します。
mssql.mirroring.get ミラーリング情報を返します。
mssql.nonlocal.db.get Always On 可用性グループおよびレプリカ(プライマリまたはセカンダリ)に参加しており、他のサーバー上に存在するデータベースを返します(このデータベースは、接続先の SQL Server インスタンス上には存在しません)。
mssql.perfcounter.get パフォーマンスカウンターを返します。
mssql.ping 接続が有効かどうかをテストします。
mssql.quorum.get クォーラム情報を返します。
mssql.quorum.member.get クォーラムメンバーを返します。
mssql.replica.get レプリカを返します。
mssql.version MSSQL のバージョンを返します。
mysql.custom.query カスタムクエリの結果を返します。 MySQL
mysql.db.discovery MySQL データベースの一覧を返します。
mysql.db.size データベースサイズ(バイト単位)。
mysql.get_status_variables グローバルステータス変数の値。
mysql.ping 接続が有効かどうかをテストします。
mysql.replication.discovery MySQL レプリケーションの一覧を返します。
mysql.replication.get_slave_status レプリケーションのステータス。
mysql.version MySQL のバージョン。
net.dns.get DNS クエリを実行し、詳細な DNS レコード情報を返します。 Network
oracle.diskgroups.stats Automatic Storage Management (ASM) ディスクグループの統計を返します。 Oracle
oracle.diskgroups.discovery ASM ディスクグループの一覧を返します。
oracle.archive.info アーカイブログの統計。
oracle.cdb.info Container Database (CDB) の情報。
oracle.custom.query カスタムクエリの結果。
oracle.datafiles.stats データファイルの統計を返します。
oracle.db.discovery データベースの一覧を返します。
oracle.fra.stats Fast Recovery Area (FRA) の統計を返します。
oracle.instance.info インスタンス統計。
oracle.pdb.info Pluggable Database (PDB) の情報。
oracle.pdb.discovery PDB の一覧を返します。
oracle.pga.stats Program Global Area (PGA) の統計を返します。
oracle.ping Oracle への接続を確立できるかどうかをテストします。
oracle.proc.stats プロセス統計を返します。
oracle.redolog.info 制御ファイルから取得したログファイル情報。
oracle.sga.stats System Global Area (SGA) の統計を返します。
oracle.sessions.stats セッション統計を返します。
oracle.sys.metrics システムメトリクス値のセットを返します。
oracle.sys.params システムパラメータ値のセットを返します。
oracle.ts.stats 表領域の統計を返します。
oracle.ts.discovery 表領域の一覧を返します。
oracle.user.info Oracle ユーザー情報を返します。
oracle.version データベースサーバーのバージョンを返します。
pgsql.autovacuum.count autovacuum ワーカー数。 PostgreSQL
pgsql.archive アーカイブ済みファイルに関する情報。
pgsql.bgwriter データベースクラスターのチェックポイント総数を、チェックポイント種別ごとに分類して返します。
pgsql.cache.hit PostgreSQL バッファキャッシュのヒット率。
pgsql.connections 種別ごとの接続数を返します。
pgsql.custom.query カスタムクエリの結果を返します。
pgsql.db.age データベースの最も古い FrozenXID の経過期間。
pgsql.db.bloating_tables データベースごとの肥大化テーブル数。
pgsql.db.discovery PostgreSQL データベースの一覧。
pgsql.db.size データベースサイズ(バイト単位)。
pgsql.dbstat データベースごとの統計を収集します。
pgsql.dbstat.sum クラスター内のすべてのデータベースについて集計したデータ。
pgsql.locks データベースごとの許可済みロックに関する情報。
pgsql.oldest.xid 最も古い XID の経過期間。
pgsql.ping 接続が有効かどうかをテストします。
pgsql.queries 実行時間別のクエリメトリクス。
pgsql.replication.count スタンバイサーバー数。
pgsql.replication.process 各送信プロセスごとの flush lag、write lag、および replay lag。
pgsql.replication.process.discovery レプリケーションプロセス名のディスカバリ。
pgsql.replication.recovery_role リカバリステータス。
pgsql.replication.status レプリケーションのステータス。
pgsql.replication_lag.b レプリケーション遅延(バイト単位)。
pgsql.replication_lag.sec レプリケーション遅延(秒単位)。
pgsql.uptime PostgreSQL の稼働時間(ミリ秒単位)。
pgsql.version PostgreSQL のバージョンを返します。
pgsql.wal.stat WAL 統計。
redis.config パターンに一致する Redis インスタンスの設定パラメータを取得します。 Redis
redis.info INFO コマンドの出力を取得します。
redis.ping 接続が有効かどうかをテストします。
redis.slowlog.count Redis の起動以降の slow log エントリ数。
smart.attribute.discovery S.M.A.R.T. デバイス属性の一覧を返します。 S.M.A.R.T.
smart.disk.discovery S.M.A.R.T. デバイスの一覧を返します。
smart.disk.get S.M.A.R.T. デバイスの利用可能なすべてのプロパティを返します。
systemd.unit.get systemd ユニットのすべてのプロパティを返します。 Systemd
systemd.unit.info systemd ユニット情報。
systemd.unit.discovery systemd ユニットの一覧とその詳細。
web.certificate.get 証明書を検証し、証明書の詳細を返します。 Web certificates

関連項目:

アイテムキーの詳細

山括弧のないパラメータは必須です。 山括弧 < > でマークされたパラメータはオプションです。

ceph.df.details[connString,<user>,<apikey>]


クラスタのデータ使用量とプール間の分布。
戻り値: JSON object

パラメーター:

  • connString - URI またはセッション名。
  • user, apikey - Ceph に接続するためのユーザー名と API キー。
ceph.osd.stats[connString,<user>,<apikey>]


集約およびOSDごとの統計情報。
戻り値: JSON object

パラメータ:

  • connString - URIまたはセッション名。
  • user, apikey - Cephへの接続に使用するユーザー名とAPIキー。
ceph.osd.discovery[connString,<user>,<apikey>]


検出されたOSDの一覧です。 ローレベルディスカバリで使用されます。
戻り値: JSON object

パラメータ:

  • connString - URIまたはセッション名。
  • user, apikey - Cephへの接続に使用するユーザー名とAPIキー。
ceph.osd.dump[connString,<user>,<apikey>]


OSD の使用率しきい値およびステータス。
戻り値: JSON object

パラメータ:

  • connString - URI またはセッション名。
  • user, apikey - Ceph への接続に使用するユーザー名と API キー。
ceph.ping[connString,<user>,<apikey>]


Cephへの接続を確立できるかどうかをテストします。
戻り値: 0 - 接続が切断されています(AUTHや設定の問題を含む、何らかのエラーが発生した場合);1 - 接続に成功しています。

パラメータ:

  • connString - URIまたはセッション名。
  • user, apikey - Cephへの接続に使用するユーザー名とAPIキー。
ceph.pool.discovery[connString,<user>,<apikey>]


検出されたプールの一覧です。 ローレベルディスカバリで使用されます。
戻り値: JSON object

パラメータ:

  • connString - URIまたはセッション名。
  • user, apikey - Cephへの接続に使用するユーザー名とAPIキー。
ceph.status[connString,<user>,<apikey>]


クラスター全体のステータス。
戻り値: JSON object

パラメータ:

  • connString - URIまたはセッション名。
  • user, apikey - Cephへの接続に使用するユーザー名とAPIキー。
docker.container_info[<ID>,<info>]


コンテナに関する低レベル情報です。
戻り値: ContainerInspect API呼び出しの出力をJSONとしてシリアライズしたもの。

パラメータ:

  • ID - コンテナのIDまたは名前。
  • info - 返される情報量。 サポートされる値: short(デフォルト)または full

十分な権限を得るために、Agent 2のユーザー('zabbix')を 'docker' group に追加する必要があります。 そうしないと、このチェックは失敗します。

docker.container_stats[<ID>]


コンテナのリソース使用状況の統計情報です。
戻り値: ContainerStats API呼び出しの出力とCPU使用率をJSONとしてシリアライズしたもの。

パラメータ:

  • ID - コンテナのIDまたは名前。

十分な権限を得るために、Agent 2のユーザー('zabbix')を 'docker' group に追加する必要があります。 そうしないと、このチェックは失敗します。

docker.containers


コンテナの一覧。
戻り値: ContainerList API呼び出しの出力をJSONとしてシリアライズしたもの。

十分な権限を得るために、Agent 2ユーザー('zabbix')を 'docker' group に追加する必要があります。 そうしないと、このチェックは失敗します。

docker.containers.discovery[<options>]


コンテナの一覧を返します。 ローレベルディスカバリで使用されます。
戻り値: JSON object

パラメータ:

  • options - 検出対象をすべてのコンテナにするか、実行中のコンテナのみにするかを指定します。 サポートされる値: true - すべてのコンテナを返す; false - 実行中のコンテナのみを返す(デフォルト)。

十分な権限を得るために、Agent 2 のユーザー('zabbix')を 'docker' group に追加する必要があります。 そうしないと、このチェックは失敗します。

docker.data.usage


現在のデータ使用量に関する情報。
戻り値: SystemDataUsage API呼び出しの出力をJSONとしてシリアライズしたもの。

十分な権限を得るために、Agent 2 のユーザー('zabbix')を 'docker' group に追加する必要があります。 そうしないと、このチェックは失敗します。

docker.images


イメージの一覧を返します。
戻り値: ImageList API呼び出しの出力をJSONとしてシリアライズしたもの。

十分な権限を得るために、Agent 2 のユーザー('zabbix')を 'docker' group に追加する必要があります。 そうしないと、このチェックは失敗します。

docker.images.discovery


イメージの一覧を返します。 ローレベルディスカバリで使用されます。
戻り値: JSON object

十分な権限を得るために、Agent 2 のユーザー('zabbix')を 'docker' group に追加する必要があります。 そうしないと、このチェックは失敗します。

docker.info


システム情報。
戻り値: SystemInfo API呼び出しの出力をJSONとしてシリアライズしたもの。

十分な権限を得るには、Agent 2のユーザー('zabbix')を 'docker' group に追加する必要があります。 そうしないと、このチェックは失敗します。

docker.ping


Dockerデーモンが稼働しているかどうかをテストします。
戻り値: 1 - 接続は有効です。0 - 接続は切断されています。

十分な権限を得るために、Agent 2 のユーザー('zabbix')を 'docker' グループ に追加する必要があります。 そうしないと、このチェックは失敗します。

ember.get[<uri>,<path>]


必要なデバイスの結果を返します。
戻り値: JSON object

パラメータ:

  • 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 - 返される統計情報の種類: itemssizesslabs、または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 object

パラメータ:

  • connString - URIまたはセッション名。
  • user, password - MongoDBのログイン認証情報。
mongodb.collections.usage[connString,<user>,<password>]


コレクションの使用状況統計を返します。
戻り値: JSON オブジェクト

パラメーター:

  • connString - URI またはセッション名
  • user, password - MongoDB ログイン認証情報
mongodb.connpool.stats[connString,<user>,<password>]


現在のデータベースインスタンスから、シャーディングクラスタまたはレプリカセットの他のメンバーへの開いている送信接続に関する情報を返します。
戻り値: JSON object

パラメータ:

  • connString - URIまたはセッション名。
  • user, password - MongoDBのログイン認証情報。
mongodb.db.stats[connString,<user>,<password>,<database>]


指定されたデータベースシステムの状態を反映する統計情報を返します。
戻り値: JSON オブジェクト

パラメーター:

  • connString - URI またはセッション名
  • user, password - MongoDB ログイン認証情報
  • database - データベース名 (デフォルト: admin)
mongodb.db.discovery[connString,<user>,<password>]


検出されたデータベースの一覧を返します。 ローレベルディスカバリで使用されます。
戻り値: JSON object

パラメータ:

  • 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 - MQTT ブローカーの URL。形式は protocol://host:port で、クエリパラメータは含めません(サポートされるプロトコル: tcp, ssl, ws)。 値が指定されていない場合、エージェントは tcp://localhost:1883 を使用します。 プロトコルまたはポートが省略された場合は、デフォルトのプロトコル (tcp) またはポート (1883) が使用されます;
  • topic - MQTT トピック(必須)。 ワイルドカード(+,#)がサポートされています;
  • user, password - 認証情報(必要な場合)。

コメント:

  • アイテムは active check('Zabbix agent (active)' アイテムタイプ)として設定する必要があります;
  • TLS 暗号化証明書は、デフォルトの保存先(例: Ubuntu の /etc/ssl/certs/ ディレクトリ)に保存することで使用できます。 TLS では tls:// スキームを使用します。
mssql.availability.group.get[URI,<user>,<password>]


可用性グループを返します。
戻り値: JSON object

パラメータ:

  • URI - MSSQLサーバーのURI(サポートされるスキーマは sqlserver:// のみです)。 埋め込み認証情報は無視されます。 Zabbix 7.0.6以降では、URIの一部としてインスタンス名を指定できます。例: sqlserver://localhost/InstanceName(ポートなし)。 ポートが指定されている場合、インスタンス名は無視されます。
  • user, password - 保護されたMSSQLサーバーに送信するユーザー名、パスワード。

詳細については、MSSQL plugin のreadmeを参照してください。

mssql.custom.query[URI,<user>,<password>,queryName,<args...>]


カスタムクエリの結果を返します。
戻り値: JSON object

パラメータ:

  • URI - MSSQLサーバーのURI(サポートされるスキーマは sqlserver:// のみです)。 埋め込み認証情報は無視されます。 Zabbix 7.0.6以降では、URIの一部としてインスタンス名を指定できます。例: sqlserver://localhost/InstanceName(ポート指定なし)。 ポートが指定されている場合、インスタンス名は無視されます。
  • user, password - 保護されたMSSQLサーバーに送信するユーザー名、パスワード。
  • queryName - Plugins.MSSQL.CustomQueriesDir で設定されたカスタムクエリの名前(.sql拡張子を除く)。
  • args - クエリに渡す、カンマ区切りの1つまたは複数の引数。

詳細については、MSSQL plugin のreadmeを参照してください。

mssql.db.get


利用可能なすべてのMSSQLデータベースを返します。
戻り値: JSON object

詳細については、MSSQL plugin のreadmeを参照してください。

mssql.job.status.get


ジョブのステータスを返します。
戻り値: JSON object

詳細については、MSSQL plugin のreadmeを参照してください。

mssql.last.backup.get


すべてのデータベースの最終バックアップ時刻を返します。
戻り値: JSON object

詳細については、MSSQL plugin のreadmeを参照してください。

mssql.local.db.get


接続先のサーバー上に存在し、Always On 可用性グループおよびレプリカ(プライマリまたはセカンダリ)に参加しているデータベースを返します。
戻り値: JSON object

詳細については、MSSQL plugin のreadmeを参照してください。

mssql.mirroring.get


ミラーリング情報を返します。
戻り値: JSON object

詳細については、MSSQLプラグイン のreadmeを参照してください。

mssql.nonlocal.db.get


Always On 可用性グループに参加しており、かつ他のサーバー上にあるレプリカ(プライマリまたはセカンダリ)に存在するデータベースを返します(このデータベースは、接続先として確立された SQL Server インスタンスのローカルには存在しません)。
戻り値: JSON object

詳細については、MSSQL plugin の readme を参照してください。

mssql.perfcounter.get


パフォーマンスカウンターを返します。
戻り値: JSON object

詳細については、MSSQLプラグイン のreadmeを参照してください。

mssql.ping


データベースに ping を実行します。
接続が正しく設定されているかをテストします。
戻り値: 1 - 稼働中、0 - 停止中。

詳細については、MSSQL plugin の readme を参照してください。

mssql.quorum.get


クォーラム情報を返します。
戻り値: JSON object

詳細については、MSSQL plugin のreadmeを参照してください。

mssql.quorum.member.get


クォーラムメンバーを返します。
戻り値: JSON object

詳細については、MSSQL plugin のreadmeを参照してください。

mssql.replica.get


レプリカを返します。
戻り値: JSON object

詳細については、MSSQLプラグイン のreadmeを参照してください。

mssql.version


MSSQLのバージョンを返します。
戻り値: String

詳細については、MSSQL plugin のreadmeを参照してください。

mysql.custom.query[connString,<user>,<password>,queryName,<args...>]


カスタムクエリの結果を返します。
戻り値: JSON object

パラメータ:

  • connString - URIまたはセッション名;
  • user, password - MySQLのログイン認証情報;
  • queryName - カスタムクエリの名前。拡張子を除いたSQLファイル名と一致している必要があります;
  • args - クエリに渡す、カンマ区切りの1つまたは複数の引数。

詳細については、MySQL plugin のreadmeの Custom queries セクションを参照してください。

mysql.db.discovery[connString,<user>,<password>]


MySQLデータベースの一覧を返します。 ローレベルディスカバリで使用されます。
戻り値: 「show databases」SQLクエリの結果をLLD JSON形式で返します。

パラメータ:

  • 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レプリケーションの一覧を返します。 ローレベルディスカバリで使用されます。
戻り値: SHOW SLAVE STATUS または SHOW REPLICA STATUS SQLクエリの結果を、LLD JSON形式で返します。

パラメータ:

  • connString - URIまたはセッション名。
  • user, password - MySQLのログイン認証情報。
mysql.replication.get_slave_status[connString,<user>,<password>,<master host>]


レプリケーションのステータス。
戻り値: SHOW SLAVE STATUS または SHOW REPLICA STATUS SQLクエリの結果をJSON形式で返します。

パラメータ:

  • 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 object

パラメーター:

  • 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 ルックアップ(typePTR に設定されている場合)では、DNS 名を逆順形式と非逆順形式の両方で指定できます(以下の例を参照してください)。 なお、PTR レコードが要求される場合、DNS 名は実際には IP アドレスです。
  • flags に指定できる値は次のとおりです:
    • cdflag または nocdflag(デフォルト);
    • rdflag(デフォルト)または nordflag;
    • dnssec または nodnssec(デフォルト);
    • nsid または nonsid(デフォルト);
    • edns0(デフォルト)または noedns0;
    • aaflag または noaaflag(デフォルト);
    • adflag または noadflag(デフォルト)。 flagsdnssecnsid は、どちらも edns0 を必要とするため、noedns0 と組み合わせて使用することはできません。 値は小文字のみで指定する必要があります。大文字または大文字小文字が混在した値はサポートされません。
  • 国際化ドメイン名はサポートされていません。代わりに IDNA エンコードされた名前を使用してください。
  • 出力は、指定されたパラメーターに基づく DNS レコード情報を含むオブジェクトです(詳細はこちらを参照してください)。

例:

net.dns.get[192.0.2.1,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.8.0.f.0.0.4.0.5.4.1.0.0.a.2.ip6.arpa,PTR,,,,"cdflag,rdflag,nsid"]
oracle.diskgroups.stats[connString,<user>,<password>,<service>,<diskgroup>]


Automatic Storage Management (ASM) のディスクグループ統計を返します。
戻り値: JSON object

パラメーター:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ (例: "tcp://")、ポート (例: 1521)、またはその両方が含まれている場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - プラグイン設定ファイル内にその名前が見つかる場合;
    • TNS キー (Zabbix 7.0.19 以降でサポート) - ResolveTNS オプションが true に設定され、かつ上記の条件のいずれにも該当しない場合;
    • TNS 値 (Zabbix 7.0.19 以降でサポート) - 先頭が開き括弧 "(" の場合 (先頭のスペースは無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。user as sysdba の形式で、as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskmas sysrac のいずれかのログインオプションを末尾に追加できます (ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 Zabbix 7.0.18 より前では、as sysdbaas sysoperas sysasm のログインオプションのみサポートされます;
  • password - Oracle のパスワード;
  • service - Oracle のサービス名;
  • diskgroup - クエリ対象の ASM ディスクグループ名。
oracle.diskgroups.discovery[connString,<user>,<password>,<service>]


ASMディスクグループの一覧を返します。 低レベルディスカバリで使用されます。
戻り値: JSON object

パラメータ:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - プラグイン設定ファイル内にその名前が見つかる場合;
    • TNSキー (Zabbix 7.0.19 以降でサポート) - ResolveTNS オプションが true に設定されており、上記のいずれの条件にも該当しない場合;
    • TNS値 (Zabbix 7.0.19 以降でサポート) - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかのログインオプションを user as sysdba の形式で末尾に追加できます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 なお、Zabbix 7.0.18 より前では as sysdbaas sysoper、または as sysasm のログインオプションのみがサポートされます;
  • password - Oracle のパスワード;
  • service - Oracle のサービス名。
oracle.archive.info[connString,<user>,<password>,<service>,<destination>]


アーカイブログの統計情報です。
戻り値: JSON object

パラメーター:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - プラグイン設定ファイル内にその名前が見つかる場合;
    • TNS キー(Zabbix 7.0.19 以降でサポート) - ResolveTNS オプションが true に設定されており、上記のいずれの条件にも該当しない場合;
    • TNS 値(Zabbix 7.0.19 以降でサポート) - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskmas sysrac のいずれかのログインオプションを user as sysdba の形式で末尾に追加できます(ログインオプションは大文字小文字を区別せず、末尾に空白を含めてはいけません)。 なお、Zabbix 7.0.18 より前では、as sysdbaas sysoperas sysasm のログインオプションのみサポートされます;
  • password - Oracle のパスワード;
  • service - Oracle のサービス名;
  • destination - 照会する destination の名前。
oracle.cdb.info[connString,<user>,<password>,<service>,<database>]


コンテナデータベース (CDB) の情報。
戻り値: JSON object

パラメーター:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ (例: "tcp://")、ポート (例: 1521)、またはその両方が含まれている場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - プラグイン設定ファイル内にその名前が見つかる場合;
    • TNS キー (Zabbix 7.0.19 以降でサポート) - ResolveTNS オプションが true に設定され、上記のいずれの条件にも該当しない場合;
    • TNS 値 (Zabbix 7.0.19 以降でサポート) - 開き括弧 "(" で始まる場合 (先頭のスペースは無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかのログインオプションを user as sysdba の形式で末尾に追加できます (ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 Zabbix 7.0.18 より前では、as sysdbaas sysoper、または as sysasm のログインオプションのみがサポートされます;
  • password - Oracle のパスワード;
  • service - Oracle のサービス名;
  • database - 照会するデータベース名。
oracle.custom.query[connString,<user>,<password>,<service>,queryName,<args...>]


カスタムクエリの結果。
戻り値: JSON object

パラメーター:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - プラグイン設定ファイル内にその名前が見つかる場合;
    • TNSキー (Zabbix 7.0.19 以降でサポート) - ResolveTNS オプションが true に設定されており、上記のいずれの条件にも該当しない場合;
    • TNS値 (Zabbix 7.0.19 以降でサポート) - 開き括弧 "(" で始まる場合(先頭のスペースは無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。ログインオプション as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskmas sysrac のいずれかを user as sysdba の形式で末尾に追加できます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 Zabbix 7.0.18 より前では、as sysdbaas sysoperas sysasm のログインオプションのみサポートされることに注意してください;
  • password - Oracle のパスワード;
  • service - Oracle のサービス名;
  • queryName - カスタムクエリの名前。拡張子を除いた SQL ファイル名と一致している必要があります;
  • args - クエリに渡す、1つ以上のカンマ区切りの引数。

コメント:

  • 返されたデータは自動的に JSON に変換されます。
  • クエリから JSON を直接返さないでください。プラグインがそれを再度 JSON に変換しようとすると、破損してしまいます。
oracle.datafiles.stats[connString,<user>,<password>,<service>]


データファイルの統計情報を返します。
戻り値: JSON object

パラメーター:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。
      スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます。
    • セッション名 - プラグイン設定ファイル内にその名前が見つかる場合。
    • TNSキー (Zabbix 7.0.19 以降でサポート) - ResolveTNS オプションが true に設定されており、上記のいずれの条件にも該当しない場合。
    • TNS値 (Zabbix 7.0.19 以降でサポート) - 先頭が開き括弧 "(" の場合(先頭のスペースは無視されます)。
      この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかのログインオプションを user as sysdba の形式で追加できます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。
    Zabbix 7.0.18 より前では、as sysdbaas sysoper、または as sysasm のログインオプションのみサポートされます。
  • password - Oracle のパスワード。
  • service - Oracle のサービス名。
oracle.db.discovery[connString,<user>,<password>,<service>]


データベースの一覧を返します。 low-level discovery に使用されます。
戻り値: JSON object

パラメータ:

  • connString - 次のいずれかです:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ (例: "tcp://")、ポート (例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - プラグイン設定ファイル内にその名前が見つかる場合;
    • TNS キー (Zabbix 7.0.19 以降でサポート) - ResolveTNS オプションが true に設定され、上記の条件のいずれにも該当しない場合;
    • TNS 値 (Zabbix 7.0.19 以降でサポート) - 先頭が開き括弧 "(" の場合 (先頭の空白は無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。user as sysdba の形式で、as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかのログインオプションを末尾に追加できます (ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 なお、Zabbix 7.0.18 より前では、as sysdbaas sysoper、または as sysasm のログインオプションのみサポートされます;
  • password - Oracle のパスワード;
  • service - Oracle のサービス名。
oracle.fra.stats[connString,<user>,<password>,<service>]


Fast Recovery Area (FRA) の統計情報を返します。
戻り値: JSON object

パラメーター:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - プラグイン設定ファイル内にその名前が見つかる場合;
    • TNS キー (Zabbix 7.0.19 以降でサポート) - ResolveTNS オプションが true に設定され、上記のいずれの条件にも該当しない場合;
    • TNS 値 (Zabbix 7.0.19 以降でサポート) - 開き括弧 "(" で始まる場合(先頭のスペースは無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかのログインオプションを user as sysdba の形式で末尾に追加できます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 Zabbix 7.0.18 より前では、as sysdbaas sysoper、または as sysasm のログインオプションのみがサポートされます;
  • password - Oracle のパスワード;
  • service - Oracle のサービス名。
oracle.instance.info[connString,<user>,<password>,<service>]


インスタンスの統計情報。
戻り値: JSON object

パラメーター:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - プラグイン設定ファイル内にその名前が見つかる場合;
    • TNSキー(Zabbix 7.0.19 以降でサポート) - ResolveTNS オプションが true に設定されており、上記のいずれの条件にも該当しない場合;
    • TNS値(Zabbix 7.0.19 以降でサポート) - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。user as sysdba の形式で、as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskmas sysrac のいずれかのログインオプションを末尾に追加できます(ログインオプションは大文字小文字を区別せず、末尾に空白を含めてはいけません)。 Zabbix 7.0.18 より前では、as sysdbaas sysoperas sysasm のログインオプションのみサポートされます;
  • password - Oracle のパスワード;
  • service - Oracle のサービス名。
oracle.pdb.info[connString,<user>,<password>,<service>,<database>]


Pluggable Database (PDB) の情報。
戻り値: JSON object

パラメータ:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ (例: "tcp://")、ポート (例: 1521)、またはその両方が含まれている場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - プラグイン設定ファイル内にその名前が見つかる場合;
    • TNS キー (Zabbix 7.0.19 以降でサポート) - ResolveTNS オプションが true に設定され、上記のいずれの条件にも該当しない場合;
    • TNS 値 (Zabbix 7.0.19 以降でサポート) - 先頭が開き括弧 "(" の場合 (先頭のスペースは無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。user as sysdba の形式で、as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかのログインオプションを末尾に付けることができます (ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 Zabbix 7.0.18 より前では、as sysdbaas sysoper、または as sysasm のログインオプションのみサポートされます;
  • password - Oracle のパスワード;
  • service - Oracle のサービス名;
  • database - クエリ対象のデータベース名。
oracle.pdb.discovery[connString,<user>,<password>,<service>]


PDB の一覧を返します。 low-level discovery に使用されます。
戻り値: JSON object

パラメータ:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ (例: "tcp://")、ポート (例: 1521)、またはその両方が含まれている場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - プラグイン設定ファイル内にその名前が見つかる場合;
    • TNS キー (Zabbix 7.0.19 以降でサポート) - ResolveTNS オプションが true に設定され、上記のいずれの条件にも該当しない場合;
    • TNS 値 (Zabbix 7.0.19 以降でサポート) - 開き括弧 "(" で始まる場合 (先頭のスペースは無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskmas sysrac のいずれかのログインオプションを user as sysdba の形式で追加できます (ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 as sysdbaas sysoperas sysasm のログインオプションのみが Zabbix 7.0.18 より前でサポートされていることに注意してください;
  • password - Oracle のパスワード;
  • service - Oracle のサービス名。
oracle.pga.stats[connString,<user>,<password>,<service>]


Program Global Area (PGA) の統計情報を返します。
戻り値: JSON object

パラメーター:

  • connString - 次のいずれかです:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - プラグイン設定ファイル内にその名前が見つかる場合;
    • TNSキー(Zabbix 7.0.19 以降でサポート) - ResolveTNS オプションが true に設定され、かつ上記のいずれの条件にも該当しない場合;
    • TNS値(Zabbix 7.0.19 以降でサポート) - 先頭が開き括弧 "(" の場合(先頭の空白は無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかのログインオプションを user as sysdba の形式で付加できます(ログインオプションは大文字小文字を区別せず、末尾に空白を含めてはいけません)。 Zabbix 7.0.18 より前では、as sysdbaas sysoper、または as sysasm のログインオプションのみがサポートされます;
  • password - Oracle のパスワード;
  • service - Oracle のサービス名。
oracle.ping[connString,<user>,<password>,<service>]


Oracle への接続を確立できるかどうかをテストします。
戻り値: 1 - 接続成功; 0 - 接続断(AUTH や設定の問題を含む、何らかのエラーが発生した場合)。

パラメーター:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNS オプションは考慮されず、URI として扱われます;
    • セッション名 - プラグイン設定ファイル内にその名前が見つかる場合;
    • TNS キー(Zabbix 7.0.19 以降でサポート) - ResolveTNS オプションが true に設定され、上記のいずれの条件にも該当しない場合;
    • TNS 値(Zabbix 7.0.19 以降でサポート) - 先頭が開き括弧 "(" の場合(先頭の空白は無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。user as sysdba の形式で、as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかのログインオプションを末尾に付けることができます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 なお、Zabbix 7.0.18 より前では、as sysdbaas sysoper、または as sysasm のログインオプションのみサポートされます;
  • password - Oracle のパスワード;
  • service - Oracle のサービス名。

例:

oracle.ping[tcp://127.0.0.1:1521,ZABBIX_MON,zabbix,xe]
oracle.ping[localhost,ZABBIX_MON,zabbix,xe]
oracle.ping[zbx_tns_example,ZABBIX_MON,zabbix,xe]
oracle.ping["(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=xe)))",ZABBIX_MON,zabbix]
oracle.proc.stats[connString,<user>,<password>,<service>]


プロセス統計を返します。
戻り値: JSON object

パラメータ:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - プラグイン設定ファイル内にその名前が見つかる場合;
    • TNSキー (Zabbix 7.0.19 以降でサポート) - ResolveTNS オプションが true に設定されており、上記のいずれの条件にも該当しない場合;
    • TNS値 (Zabbix 7.0.19 以降でサポート) - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかのログインオプションを user as sysdba の形式で追加できます(ログインオプションは大文字小文字を区別せず、末尾に空白を含めることはできません)。 なお、Zabbix 7.0.18 より前では、as sysdbaas sysoper、または as sysasm のログインオプションのみがサポートされます;
  • password - Oracle のパスワード;
  • service - Oracle のサービス名。
oracle.redolog.info[connString,<user>,<password>,<service>]


制御ファイルからログファイル情報を取得します。
戻り値: JSON object

パラメータ:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 schema(例: "tcp://")、port(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - プラグイン設定ファイル内にその名前が見つかる場合;
    • TNS key(Zabbix 7.0.19 以降でサポート) - ResolveTNS オプションが true に設定されており、上記のいずれの条件にも該当しない場合;
    • TNS value(Zabbix 7.0.19 以降でサポート) - 開き括弧 "(" で始まる場合(先頭のスペースは無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。user as sysdba の形式で、as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかのログインオプションを末尾に追加できます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 Zabbix 7.0.18 より前では、as sysdbaas sysoper、または as sysasm のログインオプションのみがサポートされることに注意してください;
  • password - Oracle のパスワード;
  • service - Oracle のサービス名。
oracle.sga.stats[connString,<user>,<password>,<service>]


System Global Area (SGA) の統計情報を返します。
戻り値: JSON object

パラメーター:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます。
    • セッション名 - プラグイン設定ファイル内にその名前が見つかる場合。
    • TNS キー(Zabbix 7.0.19 以降でサポート) - ResolveTNS オプションが true に設定され、かつ上記のいずれの条件にも該当しない場合。
    • TNS 値(Zabbix 7.0.19 以降でサポート) - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。user as sysdba の形式で、as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかのログインオプションを末尾に付けることができます(ログインオプションは大文字小文字を区別せず、末尾に空白を含めてはいけません)。 なお、Zabbix 7.0.18 より前では、as sysdbaas sysoper、または as sysasm のログインオプションのみサポートされます。
  • password - Oracle のパスワード。
  • service - Oracle のサービス名。
oracle.sessions.stats[connString,<user>,<password>,<service>,<lockMaxTime>]


セッション統計を返します。
戻り値: JSON object

パラメーター:

  • connString - 次のいずれかを指定できます:
    • URI - 指定した名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます。
    • セッション名 - プラグイン設定ファイルにその名前が見つかる場合。
    • TNSキー(Zabbix 7.0.19 以降でサポート) - ResolveTNS オプションが true に設定されており、上記のいずれの条件にも該当しない場合。
    • TNS値(Zabbix 7.0.19 以降でサポート) - 先頭が開き括弧 "(" の場合(先頭のスペースは無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskmas sysrac のいずれかのログインオプションを user as sysdba の形式で末尾に追加できます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 なお、Zabbix 7.0.18 より前では as sysdbaas sysoperas sysasm のログインオプションのみサポートされます。
  • password - Oracle のパスワード;
  • service - Oracle のサービス名;
  • lockMaxTime - セッションを長時間ロックされているものとしてカウントするための、セッションロックの最大継続時間(秒)。 デフォルト: 600 秒。
oracle.sys.metrics[connString,<user>,<password>,<service>,<duration>]


システムメトリック値のセットを返します。
戻り値: JSON object

パラメーター:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ (例: "tcp://")、ポート (例: 1521)、またはその両方が含まれている場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - プラグイン設定ファイル内にその名前が見つかる場合;
    • TNS key (Zabbix 7.0.19 以降でサポート) - ResolveTNS オプションが true に設定され、かつ上記のいずれの条件にも該当しない場合;
    • TNS value (Zabbix 7.0.19 以降でサポート) - 開き括弧 "(" で始まる場合 (先頭のスペースは無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかのログインオプションを user as sysdba の形式で末尾に追加できます (ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 Zabbix 7.0.18 より前では、as sysdbaas sysoper、または as sysasm のログインオプションのみがサポートされます;
  • password - Oracle のパスワード;
  • service - Oracle のサービス名;
  • duration - システムメトリック値の取得間隔 (秒)。 指定可能な値: 60 — 長い間隔 (デフォルト)、15 — 短い間隔。
oracle.sys.params[connString,<user>,<password>,<service>]


システムパラメータ値のセットを返します。
戻り値: JSON object

パラメータ:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - プラグイン設定ファイル内にその名前が見つかる場合;
    • TNS キー(Zabbix 7.0.19 以降でサポート) - ResolveTNS オプションが true に設定され、かつ上記のいずれの条件にも該当しない場合;
    • TNS 値(Zabbix 7.0.19 以降でサポート) - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかのログインオプションを user as sysdba の形式で末尾に追加できます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 Zabbix 7.0.18 より前では、as sysdbaas sysoper、または as sysasm のログインオプションのみがサポートされます;
  • password - Oracle のパスワード;
  • service - Oracle のサービス名。
oracle.ts.stats[connString,<user>,<password>,<service>,<tablespace>,<type>,<conname>]


tablespace の統計情報を返します。
戻り値: JSON object

パラメータ:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - プラグイン設定ファイル内にその名前が見つかった場合;
    • TNS キー (Zabbix 7.0.19 以降でサポート) - ResolveTNS オプションが true に設定され、上記のいずれの条件にも該当しない場合;
    • TNS 値 (Zabbix 7.0.19 以降でサポート) - 先頭が開き括弧 "(" の場合(先頭のスペースは無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。ログインオプション as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかを user as sysdba の形式で末尾に追加できます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 なお、Zabbix 7.0.18 より前では、as sysdbaas sysoperas sysasm のログインオプションのみがサポートされます;
  • password - Oracle のパスワード;
  • service - Oracle のサービス名;
  • tablespace - 問い合わせ対象の tablespace 名。 デフォルト(空欄のままで type が設定されている場合):
    • "TEMP" (type が "TEMPORARY" に設定されている場合);
    • "USERS" (type が "PERMANENT" に設定されている場合)。
  • type - 問い合わせ対象の tablespace の種類。 デフォルト(tablespace が設定されている場合): "PERMANENT"。
  • conname - 情報が必要なコンテナの名前。

tablespacetype、または conname が省略された場合、アイテムは一致するすべてのコンテナ(PDB と CDB を含む)の tablespace 統計情報を返します。

oracle.ts.discovery[connString,<user>,<password>,<service>]


tablespace の一覧を返します。 low-level discovery に使用されます。
戻り値: JSON object

パラメータ:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ (例: "tcp://")、ポート (例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - プラグイン設定ファイル内にその名前が見つかる場合;
    • TNS キー (Zabbix 7.0.19 以降でサポート) - ResolveTNS オプションが true に設定され、かつ上記のいずれの条件にも該当しない場合;
    • TNS 値 (Zabbix 7.0.19 以降でサポート) - 先頭が開き括弧 "(" の場合 (先頭の空白は無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。user as sysdba の形式で、as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかのログインオプションを末尾に付けることができます (ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 as sysdbaas sysoperas sysasm のログインオプションのみが Zabbix 7.0.18 より前でサポートされていることに注意してください;
  • password - Oracle のパスワード;
  • service - Oracle のサービス名。
oracle.user.info[connString,<user>,<password>,<service>,<username>]


Oracleユーザー情報を返します。
戻り値: JSON object

パラメーター:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - プラグイン設定ファイル内にその名前が見つかる場合;
    • TNSキー(Zabbix 7.0.19 以降でサポート) - ResolveTNS オプションが true に設定され、上記の条件のいずれにも該当しない場合;
    • TNS値(Zabbix 7.0.19 以降でサポート) - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracleのユーザー名。as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかのログインオプションを user as sysdba の形式で末尾に追加できます(ログインオプションは大文字小文字を区別せず、末尾に空白を含めてはいけません)。 Zabbix 7.0.18 より前では、as sysdbaas sysoperas sysasm のログインオプションのみサポートされます;
  • password - Oracleのパスワード;
  • service - Oracleのサービス名;
  • username - 情報が必要なユーザー名。 小文字のユーザー名はサポートされません。 デフォルト: 現在のユーザー。
oracle.version[connString,<user>,<password>,<service>]


データベースサーバーのバージョンを返します。
戻り値: String

パラメーター:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます。
    • セッション名 - プラグイン設定ファイル内にその名前が見つかる場合。
    • TNSキー(Zabbix 7.0.19 以降でサポート) - ResolveTNS オプションが true に設定されており、上記のいずれの条件にも該当しない場合。
    • TNS値(Zabbix 7.0.19 以降でサポート) - 開き括弧 "(" で始まる場合(先頭のスペースは無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかを user as sysdba の形式で末尾に付加できます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 なお、Zabbix 7.0.18 より前では、as sysdbaas sysoper、または as sysasm のログインオプションのみがサポートされます。
  • password - Oracle のパスワード。
  • service - Oracle のサービス名。
pgsql.autovacuum.count[uri,<username>,<password>,<database name>]


autovacuum ワーカーの数。
戻り値: Integer

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名 (省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.archive[uri,<username>,<password>,<database name>]


アーカイブされたファイルに関する情報。
戻り値: JSON object

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.bgwriter[uri,<username>,<password>,<database name>]


データベースクラスタのチェックポイント総数を、チェックポイントの種類別に分類したものです。
戻り値: JSONオブジェクト

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.cache.hit[uri,<username>,<password>,<database name>]


PostgreSQL のバッファキャッシュヒット率。
戻り値: Float

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.connections[uri,<username>,<password>,<database name>]


種類ごとの接続を返します。
戻り値: JSON object

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
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 - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.db.bloating_tables[uri,<username>,<password>,<database name>]


データベースごとの bloating table の数。
戻り値: Integer

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名 (省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.db.discovery[uri,<username>,<password>,<database name>]


PostgreSQLデータベースの一覧。 low-level discovery に使用されます。
戻り値: JSON object

パラメータ:

  • uri - URIまたはセッション名;
  • username, password - PostgreSQLの認証情報;
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.db.size[uri,<username>,<password>,<database name>]


データベースサイズをバイト単位で返します。
戻り値: Integer

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名 (省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.dbstat[uri,<username>,<password>,<database name>]


データベースごとの統計情報を収集します。 低レベルディスカバリに使用されます。
戻り値: JSON object

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.dbstat.sum[uri,<username>,<password>,<database name>]


クラスター内のすべてのデータベースの集計データ。
戻り値: JSON object

パラメーター:

  • uri - URIまたはセッション名。
  • username, password - PostgreSQLの認証情報。
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.locks[uri,<username>,<password>,<database name>]


データベースごとの付与済みロックに関する情報です。 low-level discovery に使用されます。
戻り値: JSON object

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.oldest.xid[uri,<username>,<password>,<database name>]


最も古い XID の経過時間(トランザクション数)。
戻り値: Integer

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.ping[uri,<username>,<password>,<database name>]


接続が生きているかどうかをテストします。
戻り値: 1 - 接続は生きています; 0 - 接続は切断されています (AUTH や設定の問題を含む、いずれかのエラーが発生した場合)。

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名 (省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.queries[uri,<username>,<password>,<database name>,time period]


実行時間に基づいてクエリのメトリクスを取得します。
戻り値: JSON object

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます);
  • time period - スロークエリ数の集計対象となる実行時間の上限(正の整数である必要があります)。
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 - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.version[uri,<username>,<password>,<database name>]


PostgreSQLのバージョンを返します。
戻り値: String

パラメーター:

  • uri - URIまたはセッション名;
  • username, password - PostgreSQLの認証情報;
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.wal.stat[uri,<username>,<password>,<database name>]


WAL統計情報。
戻り値: JSON object

パラメーター:

  • uri - URIまたはセッション名;
  • username, password - PostgreSQLの認証情報;
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
redis.config[connString,<password>,<pattern>]


パターンに一致するRedisインスタンスの設定パラメータを取得します。
戻り値: グロブ形式のパターンが使用された場合は JSON、パターンにワイルドカード文字が含まれていない場合は単一の値。

パラメータ:

  • connString - URIまたはセッション名;
  • password - Redisのパスワード;
  • pattern - グロブ形式のパターン(デフォルトは *)。

コメント:

  • セキュリティ警告: redis.config はRedisの CONFIG GET コマンドを実行し、機密性の高い設定パラメータ(たとえば requirepassmasterauth、TLS関連の設定、その他のシークレット)を返す可能性があります。 デフォルトのパターン (*) または広範なパターンを使用すると、Zabbixでアイテムの値を表示する権限を持つすべてのユーザーに、これらのシークレットが公開される可能性があります。
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 object

コメント:

  • 次のマクロとその値が返されます: {#NAME}{#DISKTYPE}{#ID}{#ATTRNAME}{#THRESH};
  • HDD、SSD、NVME のドライブタイプがサポートされています。 ドライブは単体でも RAID でまとめても使用できます。 RAID の場合、{#NAME} には追加情報が付与されます。例: {"{#NAME}": "/dev/sda cciss,2"}
smart.disk.discovery[<type>]


S.M.A.R.T.デバイスの一覧を返します。
戻り値: JSON object

パラメーター:

  • type - ディスクをスキャンするための値を指定します。 可能な値: id, name (default)。 id は Windows ではサポートされておらず、選択するとエラーを返します

コメント:

  • 次のマクロとその値が返されます: {#NAME}, {#DISKTYPE}, {#MODEL}, {#SN}, {#PATH}, {#ATTRIBUTES}, {#RAIDTYPE};
  • HDD、SSD、NVME ドライブタイプがサポートされています。 ドライブが RAID に属していない場合、{#RAIDTYPE} は空になります。 {#NAME} には RAID の場合に追加情報が付きます。例: {"{#NAME}": "/dev/sda cciss,2"}
smart.disk.get[<path>,<raid type>]


S.M.A.R.T.デバイスで利用可能なすべてのプロパティを返します。
戻り値: JSON object

パラメーター:

  • path - ディスクのパス。値として {#PATH} マクロを使用できます;
  • raid_type - RAIDタイプ。値として {#RAID} マクロを使用できます

コメント:

  • HDD、SSD、NVME ドライブタイプがサポートされています。 ドライブは単独でも RAID に組み合わせてもかまいません;
  • データには smartctl のバージョンと呼び出し引数、および追加フィールドが含まれます:
    disk_name - RAID 検出に必要な追加情報を含む名前を保持します。例: {"disk_name": "/dev/sda cciss,2"}
    disk_type - HDD、SSD、または NVME のディスクタイプを保持します。例: {"disk_type": "ssd"};
  • パラメーターが指定されていない場合、アイテムはすべてのディスクに関する情報を返します。
systemd.unit.get[unit name,<interface>]


systemd ユニットのすべてのプロパティを返します。
戻り値: JSON object

パラメーター:

  • unit name - ユニット名です(名前を検出するには、アイテムプロトタイプで {#UNIT.NAME} マクロを使用するとよいでしょう)。
  • interface - ユニットのインターフェース種別です。指定可能な値: Unit(デフォルト)、ServiceSocketDeviceMountAutomountSwapTargetPath

コメント:

  • このアイテムは Linux プラットフォームでのみサポートされます。
  • Unit インターフェースの LoadState、ActiveState、UnitFileState は、テキストと整数の両方で返されます: "ActiveState":{"state":1,"text":"active"}
systemd.unit.info[unit name,<property>,<interface>]


systemdユニットの情報。
戻り値: String

パラメーター:

  • unit name - ユニット名(ユニットプロトタイプで {#UNIT.NAME} マクロを使用して名前を取得するとよいでしょう);
  • property - ユニットのプロパティ(例: ActiveState(デフォルト)、LoadState、Description);
  • interface - ユニットのインターフェース種別(例: Unit(デフォルト)、Socket、Service)。

コメント:

  • このアイテムは Linux プラットフォームでのみサポートされます;
  • このアイテムを使用すると、dbus API に記載されているように、特定の種類のインターフェースから特定のプロパティを取得できます。

例:

systemd.unit.info["{#UNIT.NAME}"] #検出された systemd ユニットの active state(active, reloading, inactive, failed, activating, deactivating)情報を収集
systemd.unit.info["{#UNIT.NAME}",LoadState] #検出された systemd ユニットの load state 情報を収集
systemd.unit.info[mysqld.service,Id] #サービスの技術名(mysqld.service)を取得
systemd.unit.info[mysqld.service,Description] #サービスの説明(MySQL Server)を取得
systemd.unit.info[mysqld.service,ActiveEnterTimestamp] #サービスが最後に active state に入った時刻を取得(1562565036283903)
systemd.unit.info[dbus.socket,NConnections,Socket] #この socket ユニットからの接続数を収集
systemd.unit.discovery[<type>]


systemdユニットとその詳細の一覧です。 ローレベルディスカバリで使用されます。
戻り値: JSON object

パラメータ:

  • type - 指定可能な値: all, automount, device, mount, path, service(デフォルト), socket, swap, target

このアイテムはLinuxプラットフォームでのみサポートされています。

web.certificate.get[hostname,<port>,<address>]


証明書を検証し、証明書の詳細を返します。
戻り値: JSON object

パラメーター:

  • hostname - IP または DNS のいずれかを指定できます。
    URL スキーム(https のみ)、パス(無視されます)、およびポートを含めることができます。
    1つ目と2つ目のパラメーターの両方でポートが指定されている場合、それらの値は一致している必要があります。
    address(3つ目のパラメーター)が指定されている場合、hostname は SNI と hostname 検証にのみ使用されます。
  • port - ポート番号(HTTPS のデフォルトは 443);
  • address - IP または DNS のいずれかを指定できます。 指定されている場合、接続にはこれが使用され、hostname(1つ目のパラメーター)は SNI と host 検証に使用されます。 1つ目のパラメーターが IP で、3つ目のパラメーターが DNS の場合、接続には1つ目のパラメーターが使用され、SNI と host 検証には3つ目のパラメーターが使用されます。

コメント:

  • このアイテムは、ホスト設定で指定された接続先が存在しない、利用できない、または TLS ハンドシェイクが無効な証明書以外のエラーで失敗した場合、サポート対象外になります。
  • 現時点では、AIA(Authority Information Access)X.509 拡張、CRL および OCSP(OCSP stapling を含む)、Certificate Transparency はサポートされていません;
  • JSON 応答フィールド:
    • x509: X.509 証明書の詳細を含みます。
      • version: 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: 詳細な検証メッセージ(例: "certificate verified successfully")。
    • sha1_fingerprint: 証明書の SHA-1 フィンガープリント。
    • sha256_fingerprint: 証明書の SHA-256 フィンガープリント。
  • $.result.value フィールドは証明書の検証結果を示します。 可能な値は次のとおりです:
    • valid - 証明書は有効で、信頼されています。
    • valid-but-self-signed - 証明書は有効ですが自己署名です。つまり、サブジェクトと発行者が一致しています。
    • invalid - 有効期限切れ、ホスト名の不一致、または不明な署名機関などの問題により、証明書は無効です。

例:

web.certificate.get[example.com,443]

JSON 応答:

{
  "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"
}