1 Zabbixエージェント2
Zabbix agent 2 は、Unix および Windows の Zabbix エージェントでサポートされているすべてのアイテムキーをサポートしています。
このページでは、Zabbix agent 2 でのみ使用できる追加のアイテムキーについて、それらが属するプラグインごとにまとめて説明します。
アイテムキーは、パラメータおよび追加情報を省略した形で一覧表示されています。
詳細を確認するには、アイテムキーをクリックしてください。
| Item key | Description | Plugin |
|---|---|---|
| ceph.df.details | クラスターのデータ使用量とプール間での分布。 | Ceph |
| ceph.osd.stats | 集計済みおよび 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 |
| nvml.device.count | GPU デバイス数。 | NVIDIA GPU |
| nvml.device.decoder.utilization | GPU デバイスのデコーダー使用率。 | |
| nvml.device.ecc.mode | GPU デバイスの ECC モード。 | |
| nvml.device.encoder.stats.get | GPU デバイスのエンコーダー統計。 | |
| nvml.device.encoder.utilization | GPU デバイスのエンコーダー使用率。 | |
| nvml.device.energy.consumption | GPU デバイスのエネルギー消費量。 | |
| nvml.device.errors.memory | GPU デバイスの ECC メモリエラー情報。 | |
| nvml.device.errors.register | GPU デバイスの ECC レジスターエラー情報。 | |
| nvml.device.fan.speed.avg | GPU デバイスの平均ファン速度。 | |
| nvml.device.get | UUID と名前を含む検出済み GPU。 | |
| nvml.device.graphics.frequency | GPU デバイスのグラフィックスクロック速度。 | |
| nvml.device.memory.bar1.get | GPU デバイスの BAR1 メモリ情報。 | |
| nvml.device.memory.fb.get | GPU デバイスのフレームバッファメモリ情報。 | |
| nvml.device.memory.frequency | GPU デバイスのメモリクロック速度。 | |
| nvml.device.pci.utilization | GPU デバイスの PCI 使用率。 | |
| nvml.device.performance.state | GPU デバイスのパフォーマンス状態。 | |
| nvml.device.power.limit | GPU デバイスの電力上限。 | |
| nvml.device.power.usage | GPU デバイスの電力使用量。 | |
| nvml.device.serial | GPU デバイスのシリアル番号。 | |
| nvml.device.sm.frequency | GPU デバイスのストリーミングマルチプロセッサクロック速度。 | |
| nvml.device.temperature | GPU デバイスの温度。 | |
| nvml.device.utilization | GPU デバイスの使用率統計。 | |
| nvml.device.video.frequency | GPU デバイスのビデオクロック速度。 | |
| nvml.system.driver.version | NVIDIA ドライバーバージョン。 | |
| nvml.version | NVML ライブラリのバージョン。 | |
| oracle.diskgroups.stats | Automatic Storage Management (ASM) ディスクグループの統計を返します。 | Oracle |
| oracle.diskgroups.discovery | ASM ディスクグループの一覧を返します。 | |
| oracle.archive.info | アーカイブログの統計。 | |
| oracle.cdb.info | Container Databases (CDB) の情報。 | |
| oracle.custom.query | カスタムクエリの結果。 | |
| oracle.datafiles.stats | データファイルの統計を返します。 | |
| oracle.db.discovery | データベースの一覧を返します。 | |
| oracle.fra.stats | Fast Recovery Area (FRA) の統計を返します。 | |
| oracle.instance.info | インスタンス統計。 | |
| oracle.pdb.info | Pluggable Databases (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 の起動以降のスローログエントリ数。 | |
| 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 - 接続は切断されています(AUTH や設定の問題を含む、何らかのエラーが発生した場合)。
パラメータ:
- 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 object。
パラメータ:
- 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 object。
パラメータ:
- 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 object。
パラメータ:
- 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>]
jumboチャンクの数を返します。
戻り値: JSON object。
パラメータ:
- connString - URIまたはセッション名。
- user, password - MongoDBのログイン認証情報。
mongodb.oplog.stats[connString,<user>,<password>]
oplog から取得したデータを使用して、レプリカセットのステータスを返します。
戻り値: JSON object。
パラメータ:
- connString - URI またはセッション名。
- user, password - MongoDB のログイン認証情報。
mongodb.ping[connString,<user>,<password>]
接続が有効かどうかをテストします。
戻り値: 1 - 接続は有効です。0 - 接続は切断されています(AUTH や設定の問題を含む、何らかのエラーが発生した場合)。
パラメータ:
- connString - URI またはセッション名。
- user, password - MongoDB のログイン認証情報。
mongodb.rs.config[connString,<user>,<password>]
レプリカセットの現在の設定を返します。
戻り値: JSON object。
パラメータ:
- connString - URIまたはセッション名。
- user, password - MongoDBのログイン認証情報。
mongodb.rs.status[connString,<user>,<password>]
メソッドが実行されたメンバーの視点から、レプリカセットのステータスを返します。
戻り値: JSON object。
パラメータ:
- connString - URIまたはセッション名。
- user, password - MongoDBのログイン認証情報。
mongodb.server.status[connString,<user>,<password>]
データベースの状態を返します。
戻り値: JSON object。
パラメータ:
- connString - URIまたはセッション名。
- user, password - MongoDBのログイン認証情報。
mongodb.sh.discovery[connString,<user>,<password>]
クラスター内に存在する検出済みシャードの一覧を返します。
戻り値: JSON object。
パラメータ:
- 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 - 認証資格情報(必要な場合)。
コメント:
- このアイテムは active check(「Zabbix エージェント(アクティブ)」アイテムタイプ)として設定する必要があります。
- TLS暗号化証明書は、デフォルトの場所(例: Ubuntuでは
/etc/ssl/certs/ディレクトリ)に保存することで使用できます。 TLSには、tls://スキームを使用してください。
mssql.availability.group.get[URI,<user>,<password>]
可用性グループを返します。
戻り値: JSON object。
パラメータ:
- URI - MSSQLサーバーのURI(サポートされるスキーマは
sqlserver://のみです)。 埋め込み認証情報は無視されます。 URIの一部としてインスタンス名を指定できます。例:sqlserver://localhost/InstanceName(ポート指定なし)。 ポートが指定されている場合、インスタンス名は無視されます。 - user, password - 保護されたMSSQLサーバーに送信するユーザー名、パスワード。
詳細については、MSSQL plugin のreadmeを参照してください。
mssql.custom.query[URI,<user>,<password>,queryName,<args...>]
カスタムクエリの結果を返します。
戻り値: JSON object。
パラメータ:
- URI - MSSQLサーバーのURI(サポートされるスキーマは
sqlserver://のみです)。 埋め込み認証情報は無視されます。 URIの一部としてインスタンス名を指定できます。例:sqlserver://localhost/InstanceName(ポート指定なし)。 ポートが指定されている場合、インスタンス名は無視されます。 - user, password - 保護されたMSSQLサーバーに送信するユーザー名、パスワード。
- queryName -
Plugins.MSSQL.CustomQueriesDirで設定されたカスタムクエリの名前(.sql 拡張子を除く)。 - args - クエリに渡す、カンマ区切りの1つまたは複数の引数。
詳細については、MSSQL plugin のreadmeを参照してください。
mssql.db.get
利用可能なすべてのMSSQLデータベースを返します。
戻り値: JSONオブジェクト。
詳細については、MSSQLプラグインのreadmeを参照してください。
mssql.job.status.get
ジョブのステータスを返します。
戻り値: JSON object。
詳細については、MSSQL plugin のreadmeを参照してください。
mssql.last.backup.get
すべてのデータベースの最終バックアップ時刻を返します。
戻り値: JSONオブジェクト。
詳細については、MSSQL plugin のreadmeを参照してください。
mssql.local.db.get
Always On 可用性グループおよびレプリカ(プライマリまたはセカンダリ)に参加しており、接続先のサーバー上に存在するデータベースを返します。
戻り値: JSON object。
詳細については、MSSQL plugin のreadmeを参照してください。
mssql.mirroring.get
ミラーリング情報を返します。
戻り値: JSON object。
詳細については、MSSQL plugin の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 plugin の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>]
データベースのサイズ(バイト単位)。
戻り値: 特定のデータベースに対する "select coalesce(sum(data_length + index_length),0) as size from information_schema.tables where table_schema=?" SQLクエリの結果(バイト単位)。
パラメータ:
- 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ルックアップ(
typeを PTR に設定した場合)では、DNS名を逆順形式と非逆順形式の両方で指定できます(以下の例を参照)。 PTRレコードを要求する場合、DNS名は実際にはIPアドレスであることに注意してください。 flagsに指定可能な値は次のとおりです: cdflag または nocdflag(デフォルト)、rdflag(デフォルト)または nordflag、dnssec または nodnssec(デフォルト)、nsid または nonsid(デフォルト)、edns0(デフォルト)または noedns0、aaflag または noaaflag(デフォルト)、adflag または noadflag(デフォルト)。flagsの dnssec および 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.8.0.f.0.0.4.0.5.4.1.0.0.a.2.ip6.arpa,PTR,,,,"cdflag,rdflag,nsid"]
nvml.device.count
GPUデバイスの数。
戻り値: 整数。
詳細については、NVIDIA GPU plugin のreadmeを参照してください。
nvml.device.decoder.utilization[<deviceUUID>]
GPUデバイスのデコーダー使用率(パーセンテージ)。
戻り値: Integer。
パラメータ:
- deviceUUID - GPUデバイスUUID。
詳細については、NVIDIA GPU plugin のreadmeを参照してください。
nvml.device.ecc.mode[<deviceUUID>]
GPUデバイスのECCモード情報(現在、保留中)。
戻り値: JSON。
パラメータ:
- deviceUUID - GPUデバイスUUID。
詳細については、NVIDIA GPU plugin のreadmeを参照してください。
nvml.device.encoder.stats.get[<deviceUUID>]
GPUデバイスのエンコーダー統計情報。
戻り値: JSON。
パラメータ:
- deviceUUID - GPUデバイスのUUID。
詳細については、NVIDIA GPU plugin のreadmeを参照してください。
nvml.device.encoder.utilization[<deviceUUID>]
GPUデバイスのエンコーダー使用率(パーセンテージ)。
戻り値: 整数。
パラメータ:
- deviceUUID - GPUデバイスUUID。
詳細については、NVIDIA GPU plugin のreadmeを参照してください。
nvml.device.energy.consumption[<deviceUUID>]
ドライバーが最後に再読み込みされて以降の、GPUデバイスの総エネルギー消費量(ミリジュール(mJ))。
戻り値: Integer。
パラメータ:
- deviceUUID - GPUデバイスのUUID。
詳細については、NVIDIA GPU plugin のreadmeを参照してください。
nvml.device.errors.memory[<deviceUUID>]
GPUデバイスのECCメモリエラー情報(訂正済み、未訂正)。
戻り値: JSON。
パラメータ:
- deviceUUID - GPUデバイスUUID。
詳細については、NVIDIA GPU plugin のreadmeを参照してください。
nvml.device.errors.register[<deviceUUID>]
GPUデバイスのECCレジスターエラー情報(訂正済み、未訂正)。
戻り値: JSON。
パラメータ:
- deviceUUID - GPUデバイスUUID。
詳細については、NVIDIA GPU plugin のreadmeを参照してください。
nvml.device.fan.speed.avg[<deviceUUID>]
GPUデバイスの平均ファン速度を最大速度に対する割合(パーセンテージ)で示します。
戻り値: Integer。
パラメータ:
- deviceUUID - GPUデバイスのUUID。
詳細については、NVIDIA GPU plugin のreadmeを参照してください。
nvml.device.get
UUIDと名前を持つ検出済みGPU。
戻り値: JSON。
詳細については、NVIDIA GPU plugin のreadmeを参照してください。
nvml.device.graphics.frequency[<deviceUUID>]
GPUデバイスのグラフィックスクロック速度(MHz)。
戻り値: Integer。
パラメータ:
- deviceUUID - GPUデバイスのUUID。
詳細については、NVIDIA GPU plugin のreadmeを参照してください。
nvml.device.memory.fb.get[<deviceUUID>]
GPUデバイスのフレームバッファメモリ統計情報(合計、予約済み、空き、使用中)。
戻り値: JSON。
パラメータ:
- deviceUUID - GPUデバイスUUID。
詳細については、NVIDIA GPU plugin のreadmeを参照してください。
nvml.device.memory.bar1.get[<deviceUUID>]
GPUデバイスのBAR1メモリ統計情報(合計、空き、使用量)。
戻り値: JSON。
パラメータ:
- deviceUUID - GPUデバイスUUID。
詳細については、NVIDIA GPU plugin のreadmeを参照してください。
nvml.device.memory.frequency[<deviceUUID>]
GPUデバイスのメモリクロック速度(MHz)。
戻り値: Integer。
パラメータ:
- deviceUUID - GPUデバイスのUUID。
詳細については、NVIDIA GPU plugin のreadmeを参照してください。
nvml.device.pci.utilization[<deviceUUID>]
GPUデバイスのPCI使用率(送信/受信スループット、KBps)。
戻り値: JSON。
パラメータ:
- deviceUUID - GPUデバイスのUUID。
詳細については、NVIDIA GPU plugin のreadmeを参照してください。
nvml.device.performance.state[<deviceUUID>]
GPUデバイスのパフォーマンス状態。
戻り値: 整数。
パラメータ:
- deviceUUID - GPUデバイスのUUID。
詳細については、NVIDIA GPU plugin のreadmeを参照してください。
nvml.device.power.limit[<deviceUUID>]
GPUデバイスの電力上限(ミリワット単位)。
戻り値: 整数。
パラメータ:
- deviceUUID - GPUデバイスUUID。
詳細については、NVIDIA GPU plugin のreadmeを参照してください。
nvml.device.power.usage[<deviceUUID>]
GPUデバイスの現在の消費電力(ミリワット単位)。
戻り値: Integer。
パラメータ:
- deviceUUID - GPUデバイスのUUID。
詳細については、NVIDIA GPU plugin のreadmeを参照してください。
nvml.device.serial[<deviceUUID>]
GPUデバイスのシリアル番号。
戻り値: String。
パラメータ:
- deviceUUID - GPUデバイスのUUID。
詳細については、NVIDIA GPU plugin のreadmeを参照してください。
nvml.device.sm.frequency[<deviceUUID>]
GPUデバイスのストリーミングマルチプロセッサのクロック速度(MHz)。
戻り値: 整数。
パラメータ:
- deviceUUID - GPUデバイスのUUID。
詳細については、NVIDIA GPUプラグインのREADMEを参照してください。
nvml.device.temperature[<deviceUUID>]
GPUデバイスの温度(摂氏)。
戻り値: Integer。
パラメータ:
- deviceUUID - GPUデバイスのUUID。
詳細については、NVIDIA GPU plugin のreadmeを参照してください。
nvml.device.utilization[<deviceUUID>]
GPUデバイスの使用率統計(GPU/メモリ使用率をパーセンテージで表示)。
戻り値: JSON。
パラメータ:
- deviceUUID - GPUデバイスのUUID。
詳細については、NVIDIA GPU plugin のreadmeを参照してください。
nvml.device.video.frequency[<deviceUUID>]
GPUデバイスのビデオクロック速度(MHz)。
戻り値: 整数。
パラメータ:
- deviceUUID - GPUデバイスUUID。
詳細については、NVIDIA GPU plugin のreadmeを参照してください。
nvml.system.driver.version
NVIDIAドライバのバージョン。
戻り値: String。
詳細については、NVIDIA GPU plugin のreadmeを参照してください。
nvml.version
NVMLライブラリのバージョン。
戻り値: String。
詳細については、NVIDIA GPU plugin のreadmeを参照してください。
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.4.3 以降でサポート)- ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
- TNS 値(Zabbix 7.4.3 以降でサポート)- 開き括弧 “(” で始まる場合(先頭の空白は無視されます)。
この場合、ResolveTNS オプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、かつ
- user - Oracle のユーザー名。
user as sysdbaの形式で、ログインオプションas sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、またはas sysracのいずれかを末尾に追加できます(ログインオプションでは大文字と小文字は区別されず、末尾にスペースを含めてはいけません)。 Zabbix 7.4.2 より前では、ログインオプションとしてas sysdba、as sysoper、またはas 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.4.3 以降でサポート)- ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
- TNS値(Zabbix 7.4.3 以降でサポート)- 開き括弧 “(” で始まる場合(先頭の空白は無視されます)。
この場合、ResolveTNS オプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、かつ
- user - Oracleのユーザー名。
user as sysdbaの形式で、ログインオプションas sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、またはas sysracのいずれかを付加できます(ログインオプションでは大文字と小文字は区別されず、末尾にスペースを含めてはいけません)。 Zabbix 7.4.2 より前では、ログインオプションとしてas sysdba、as 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.4.3 以降でサポート)- ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
- TNS値(Zabbix 7.4.3 以降でサポート)- 開き括弧 “(” で始まる場合(先頭の空白は無視されます)。
この場合、ResolveTNS オプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleのユーザー名。
user as sysdbaの形式で、ログインオプションas sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、またはas sysracのいずれかを付加できます(ログインオプションは大文字・小文字を区別せず、末尾にスペースを含めてはいけません)。 Zabbix 7.4.2 より前では、as sysdba、as sysoper、またはas sysasmのログインオプションのみがサポートされる点に注意してください; - password - Oracleのパスワード;
- service - Oracleのサービス名;
- 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.4.3 以降でサポート)- ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
- TNS値(Zabbix 7.4.3 以降でサポート)- 開き括弧 “(” で始まる場合(先頭の空白は無視されます)。
この場合、ResolveTNS オプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracle のユーザー名。
user as sysdbaの形式で、ログインオプションas sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、またはas sysracのいずれかを末尾に追加できます(ログインオプションは大文字・小文字を区別せず、末尾にスペースを含めてはいけません)。 Zabbix 7.4.2 より前では、ログインオプションとしてas sysdba、as 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.4.3 以降でサポート)- ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合。
- TNS値(Zabbix 7.4.3 以降でサポート)- 開き括弧 “(” で始まる場合(先頭の空白は無視されます)。
この場合、ResolveTNS オプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracle のユーザー名。ログインオプション
as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、またはas sysracのいずれかをuser as sysdbaの形式で末尾に追加できます(ログインオプションは大文字・小文字を区別せず、末尾にスペースを含めてはいけません)。
Zabbix 7.4.2 より前では、as sysdba、as sysoper、as 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.4.3 以降でサポート) - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
- TNS値(Zabbix 7.4.3 以降でサポート) - 開き括弧 “(” で始まる場合(先頭の空白は無視されます)。
この場合、ResolveTNS オプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleユーザー名。
user as sysdbaの形式で、ログインオプションas sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、またはas sysracのいずれかを末尾に追加できます(ログインオプションでは大文字と小文字は区別されず、末尾にスペースを含めてはいけません)。 Zabbix 7.4.2 より前では、as sysdba、as sysoper、またはas sysasmのログインオプションのみがサポートされる点に注意してください; - password - Oracleパスワード;
- service - Oracleサービス名。
oracle.db.discovery[connString,<user>,<password>,<service>]
データベースの一覧を返します。
ローレベルディスカバリで使用されます。
戻り値: JSON object。
パラメータ:
- connString - 次のいずれかを指定できます:
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSが false に設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます。 - セッション名 - プラグイン設定ファイル内にその名前が存在する場合。
- TNSキー(Zabbix 7.4.3 以降でサポート)- ResolveTNS オプションが true に設定されており、上記のいずれの条件にも該当しない場合。
- TNS値(Zabbix 7.4.3 以降でサポート)- 開き括弧 “(” で始まる場合(先頭の空白は無視されます)。
この場合、ResolveTNS オプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracle のユーザー名。
user as sysdbaの形式で、ログインオプションas sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、またはas sysracのいずれかを末尾に追加できます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 Zabbix 7.4.2 より前では、as sysdba、as 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.4.3 以降でサポート)- ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
- TNS値(Zabbix 7.4.3 以降でサポート)- 開き括弧 “(” で始まる場合(先頭の空白は無視されます)。
この場合、ResolveTNS オプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracle のユーザー名。
user as sysdbaの形式で、ログインオプションas sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、またはas sysracのいずれかを末尾に追加できます(ログインオプションでは大文字と小文字は区別されず、末尾にスペースを含めてはいけません)。 Zabbix 7.4.2 より前では、as sysdba、as 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.4.3 以降でサポート)- ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
- TNS値(Zabbix 7.4.3 以降でサポート)- 開き括弧 “(” で始まる場合(先頭の空白は無視されます)。
この場合、ResolveTNS オプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracle のユーザー名。
user as sysdbaの形式で、ログインオプションas sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、またはas sysracのいずれかを末尾に追加できます(ログインオプションは大文字・小文字を区別せず、末尾にスペースを含めてはいけません)。 Zabbix 7.4.2 より前では、as sysdba、as sysoper、またはas sysasmのログインオプションのみがサポートされる点に注意してください; - password - Oracle のパスワード;
- service - Oracle のサービス名。
oracle.pdb.info[connString,<user>,<password>,<service>,<database>]
プラガブル・データベース(PDB)の情報です。
戻り値: JSON object。
パラメータ:
- connString - 次のいずれかを指定できます:
- URI - 指定された名前のセッションが見つからず、かつ
Plugins.Oracle.ResolveTNSが false に設定されている場合。
スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます。 - セッション名 - その名前がプラグイン設定ファイル内に存在する場合。
- TNSキー(Zabbix 7.4.3 以降でサポート)- ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合。
- TNS値(Zabbix 7.4.3 以降でサポート)- 開き括弧 “(” で始まる場合(先頭の空白は無視されます)。
この場合、ResolveTNS オプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、かつ
- user - Oracle のユーザー名。
user as sysdbaの形式で、ログインオプションas sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、またはas sysracのいずれかを末尾に追加できます(ログインオプションでは大文字・小文字は区別されず、末尾にスペースを含めてはいけません)。 Zabbix 7.4.2 より前では、as sysdba、as sysoper、as sysasmのログインオプションのみがサポートされる点に注意してください。 - password - Oracle のパスワード。
- service - Oracle のサービス名。
- database - 問い合わせ対象のデータベース名。
oracle.pdb.discovery[connString,<user>,<password>,<service>]
PDBのリストを返します。
ローレベルディスカバリで使用されます。
戻り値: JSON object。
パラメータ:
- connString - 次のいずれかを指定できます:
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSが false に設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます; - セッション名 - プラグイン設定ファイル内でその名前が見つかった場合;
- TNSキー(Zabbix 7.4.3 以降でサポート)- ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
- TNS値(Zabbix 7.4.3 以降でサポート)- 開き括弧 “(” で始まる場合(先頭の空白は無視されます)。
この場合、ResolveTNS オプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleユーザー名。
user as sysdbaの形式で、ログインオプションas sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、またはas sysracのいずれかを末尾に追加できます(ログインオプションは大文字・小文字を区別せず、末尾にスペースを含めてはいけません)。 Zabbix 7.4.2 より前では、as sysdba、as sysoper、as sysasmのログインオプションのみがサポートされる点に注意してください; - 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.4.3 以降でサポート)- ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合。
- TNS 値(Zabbix 7.4.3 以降でサポート)- 開き括弧 “(” で始まる場合(先頭の空白は無視されます)。
この場合、ResolveTNS オプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracle のユーザー名。
user as sysdbaの形式で、ログインオプションas sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、またはas sysracのいずれかを末尾に追加できます(ログインオプションは大文字・小文字を区別せず、末尾にスペースを含めてはいけません)。 Zabbix 7.4.2 より前では、as sysdba、as 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.4.3 以降でサポート)- ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
- TNS値(Zabbix 7.4.3 以降でサポート)- 開き括弧 “(” で始まる場合(先頭の空白は無視されます)。
この場合、ResolveTNS オプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleのユーザー名。
user as sysdbaの形式で、ログインオプションas sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、またはas sysracのいずれかを末尾に追加できます(ログインオプションは大文字・小文字を区別せず、末尾にスペースを含めてはいけません)。 Zabbix 7.4.2 より前では、ログインオプションとしてas sysdba、as 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.4.3 以降でサポート)- ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
- TNS値(Zabbix 7.4.3 以降でサポート)- 開き括弧 “(” で始まる場合(先頭の空白は無視されます)。
この場合、ResolveTNS オプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracle のユーザー名。
user as sysdbaの形式で、ログインオプションas sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、またはas sysracのいずれかを末尾に追加できます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 Zabbix 7.4.2 より前では、as sysdba、as sysoper、またはas sysasmのログインオプションのみがサポートされる点に注意してください; - password - Oracle のパスワード;
- service - Oracle のサービス名。
oracle.redolog.info[connString,<user>,<password>,<service>]
制御ファイルから取得したログファイル情報です。
戻り値: JSON object。
パラメータ:
- connString - 次のいずれかを指定できます:
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSが false に設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます; - セッション名 - プラグイン設定ファイル内にその名前が見つかった場合;
- TNSキー(Zabbix 7.4.3 以降でサポート) - ResolveTNS オプションが true に設定されており、上記のいずれの条件にも該当しない場合;
- TNS値(Zabbix 7.4.3 以降でサポート) - 開き括弧 “(” で始まる場合(先頭の空白は無視されます)。
この場合、ResolveTNS オプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleユーザー名。
user as sysdbaの形式で、ログインオプションas sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、またはas sysracのいずれかを付加できます(ログインオプションは大文字・小文字を区別せず、末尾に空白を含めてはいけません)。 Zabbix 7.4.2 より前では、as sysdba、as 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.4.3 以降でサポート) - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
- TNS 値(Zabbix 7.4.3 以降でサポート) - 開き括弧 “(” で始まる場合(先頭の空白は無視されます)。
この場合、ResolveTNS オプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracle のユーザー名。
user as sysdbaの形式で、ログインオプションas sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、またはas sysracのいずれかを末尾に追加できます(ログインオプションは大文字・小文字を区別せず、末尾にスペースを含めてはいけません)。
Zabbix 7.4.2 より前では、ログインオプションとしてas sysdba、as 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.4.3 以降でサポート)- ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
- TNS値(Zabbix 7.4.3 以降でサポート)- 開き括弧 “(” で始まる場合(先頭の空白は無視されます)。
この場合、ResolveTNS オプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracle のユーザー名。
user as sysdbaの形式で、ログインオプションas sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、またはas sysracのいずれかを末尾に追加できます(ログインオプションは大文字・小文字を区別せず、末尾にスペースを含めてはいけません)。
Zabbix 7.4.2 より前では、as sysdba、as sysoper、as 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 キー(Zabbix 7.4.3 以降でサポート) - ResolveTNS オプションが true に設定されており、上記のいずれの条件にも該当しない場合;
- TNS 値(Zabbix 7.4.3 以降でサポート) - 開き括弧 “(” で始まる場合(先頭の空白は無視されます)。
この場合、ResolveTNS オプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracle のユーザー名。
user as sysdbaの形式で、ログインオプションas sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、またはas sysracのいずれかを末尾に追加できます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 なお、Zabbix 7.4.2 より前では、as sysdba、as 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.4.3 以降でサポート)- ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
- TNS 値(Zabbix 7.4.3 以降でサポート)- 開き括弧 “(” で始まる場合(先頭の空白は無視されます)。
この場合、ResolveTNS オプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracle のユーザー名。
user as sysdbaの形式で、ログインオプションas sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、またはas sysracのいずれかを末尾に追加できます(ログインオプションは大文字・小文字を区別せず、末尾にスペースを含めてはいけません)。 Zabbix 7.4.2 より前では、ログインオプションとしてas sysdba、as sysoper、またはas sysasmのみがサポートされる点に注意してください; - password - Oracle のパスワード;
- service - Oracle のサービス名。
oracle.ts.stats[connString,<user>,<password>,<service>,<tablespace>,<type>,<conname>]
表領域の統計情報を返します。
戻り値: JSON object。
パラメータ:
- connString - 次のいずれかを指定できます:
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSが false に設定されている場合。
スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、常に URI として扱われます; - セッション名 - プラグイン設定ファイル内でその名前が見つかった場合;
- TNS キー(Zabbix 7.4.3 以降でサポート)- ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
- TNS 値(Zabbix 7.4.3 以降でサポート)- 開き括弧 “(” で始まる場合(先頭の空白は無視されます)。
この場合、ResolveTNS オプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracle のユーザー名。
user as sysdbaの形式で、ログインオプションas sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、またはas sysracのいずれかを末尾に追加できます(ログインオプションは大文字・小文字を区別せず、末尾に空白を含めてはいけません)。
Zabbix 7.4.2 より前では、as sysdba、as sysoper、as sysasmのログインオプションのみがサポートされる点に注意してください; - password - Oracle のパスワード;
- service - Oracle のサービス名;
- tablespace - 問い合わせる表領域の名前。
デフォルト(空のままでtypeが設定されている場合):- "TEMP"(
typeが "TEMPORARY" に設定されている場合); - "USERS"(
typeが "PERMANENT" に設定されている場合)。
- "TEMP"(
- type - 問い合わせる表領域のタイプ。
デフォルト(tablespaceが設定されている場合): "PERMANENT"。 - conname - 情報が必要なコンテナの名前。
tablespace、type、または conname が省略された場合、このアイテムは一致するすべてのコンテナ(PDB および CDB を含む)の表領域統計情報を返します。
oracle.ts.discovery[connString,<user>,<password>,<service>]
表領域のリストを返します。
ローレベルディスカバリで使用されます。
戻り値: JSON object。
パラメータ:
- connString - 以下のいずれかを指定できます:
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSが false に設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます; - セッション名 - プラグイン設定ファイル内にその名前が見つかった場合;
- TNSキー(Zabbix 7.4.3 以降でサポート) - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
- TNS値(Zabbix 7.4.3 以降でサポート) - 開き括弧 “(” で始まる場合(先頭の空白は無視されます)。
この場合、ResolveTNS オプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracle のユーザー名。
user as sysdbaの形式で、ログインオプションas sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、またはas sysracのいずれかを末尾に追加できます(ログインオプションは大文字・小文字を区別せず、末尾にスペースを含めてはいけません)。 Zabbix 7.4.2 より前では、as sysdba、as sysoper、as sysasmのログインオプションのみがサポートされる点に注意してください; - 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.4.3 以降でサポート) - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
- TNS値(Zabbix 7.4.3 以降でサポート) - 開き括弧 “(” で始まる場合(先頭の空白は無視されます)。
この場合、ResolveTNS オプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleユーザー名。
user as sysdbaの形式で、ログインオプションas sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、またはas sysracのいずれかを末尾に追加できます(ログインオプションは大文字・小文字を区別せず、末尾にスペースを含めてはいけません)。
Zabbix 7.4.2 より前では、as sysdba、as sysoper、as 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.4.3 以降でサポート)- ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
- TNS 値(Zabbix 7.4.3 以降でサポート)- 開き括弧 “(” で始まる場合(先頭の空白は無視されます)。
この場合、ResolveTNS オプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracle ユーザー名。
user as sysdbaの形式で、ログインオプションas sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、またはas sysracのいずれかを末尾に追加できます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。
Zabbix 7.4.2 より前では、as sysdba、as 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.conf の Plugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.archive[uri,<username>,<password>,<database name>]
アーカイブされたファイルに関する情報。
戻り値: JSON object。
パラメータ:
- uri - URIまたはセッション名。
- username, password - PostgreSQLの認証情報。
- database name - データベース名(省略した場合、postgresql.conf の Plugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.bgwriter[uri,<username>,<password>,<database name>]
データベースクラスタのチェックポイント総数を、チェックポイントの種類ごとに分類して返します。
戻り値: JSON object。
パラメータ:
- uri - URIまたはセッション名。
- username, password - PostgreSQLの認証情報。
- database name - データベース名(省略した場合、postgresql.conf の Plugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.cache.hit[uri,<username>,<password>,<database name>]
PostgreSQL バッファキャッシュのヒット率。
戻り値: Float。
パラメータ:
- uri - URI またはセッション名。
- username, password - PostgreSQL の認証情報。
- database name - データベース名(省略した場合、postgresql.conf の Plugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.connections[uri,<username>,<password>,<database name>]
タイプ別の接続数を返します。
戻り値: JSON object。
パラメータ:
- uri - URIまたはセッション名。
- username, password - PostgreSQLの認証情報。
- database name - データベース名(省略した場合、postgresql.conf の Plugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.custom.query[uri,<username>,<password>,queryName,<args...>]
カスタムクエリの結果を返します。
戻り値: JSON object。
パラメータ:
- uri - URIまたはセッション名。
- username, password - PostgreSQLの認証情報。
- queryName - カスタムクエリの名前。拡張子を除いたSQLファイル名と一致している必要があります。
- args - クエリに渡す、カンマ区切りの1つまたは複数の引数。
pgsql.db.age[uri,<username>,<password>,<database name>]
データベースの最も古い FrozenXID の経過期間。
戻り値: 整数。
パラメータ:
- uri - URI またはセッション名。
- username, password - PostgreSQL の認証情報。
- database name - データベース名(省略した場合は、postgresql.conf の Plugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.db.bloating_tables[uri,<username>,<password>,<database name>]
データベースごとの肥大化したテーブル数。
戻り値: 整数。
パラメータ:
- uri - URIまたはセッション名。
- username, password - PostgreSQLの認証情報。
- database name - データベース名(省略した場合は、postgresql.conf の Plugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.db.discovery[uri,<username>,<password>,<database name>]
PostgreSQLデータベースの一覧です。
ローレベルディスカバリで使用されます。
戻り値: JSON object。
パラメータ:
- uri - URIまたはセッション名。
- username, password - PostgreSQLの認証情報。
- database name - データベース名(省略した場合、postgresql.conf の Plugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.db.size[uri,<username>,<password>,<database name>]
データベースのサイズ(バイト単位)。
戻り値: Integer。
パラメータ:
- uri - URIまたはセッション名。
- username, password - PostgreSQLの認証情報。
- database name - データベース名(省略した場合、postgresql.conf の Plugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.dbstat[uri,<username>,<password>,<database name>]
データベースごとの統計情報を収集します。
ローレベルディスカバリで使用されます。
戻り値: JSON object。
パラメータ:
- uri - URIまたはセッション名。
- username, password - PostgreSQLの認証情報。
- database name - データベース名(省略した場合、postgresql.conf の Plugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.dbstat.sum[uri,<username>,<password>,<database name>]
クラスター内のすべてのデータベースの集計データ。
戻り値: JSON object。
パラメータ:
- uri - URIまたはセッション名。
- username, password - PostgreSQLの認証情報。
- database name - データベース名(省略した場合、postgresql.conf の Plugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.locks[uri,<username>,<password>,<database name>]
データベースごとに許可されたロックに関する情報です。
ローレベルディスカバリで使用されます。
戻り値: JSON object。
パラメータ:
- uri - URIまたはセッション名。
- username, password - PostgreSQLの認証情報。
- database name - データベース名(省略した場合、postgresql.conf の Plugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.oldest.xid[uri,<username>,<password>,<database name>]
最も古いXIDの経過時間。
戻り値: Integer。
パラメータ:
- uri - URIまたはセッション名。
- username, password - PostgreSQLの認証情報。
- database name - データベース名(省略した場合、postgresql.conf の Plugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.ping[uri,<username>,<password>,<database name>]
接続が有効かどうかをテストします。
戻り値: 1 - 接続は有効です。0 - 接続は切断されています(AUTH や設定の問題を含む、何らかのエラーが発生した場合)。
パラメータ:
- uri - URI またはセッション名。
- username, password - PostgreSQL の認証情報。
- database name - データベース名(省略した場合、postgresql.conf の Plugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.queries[uri,<username>,<password>,<database name>,time period]
実行時間ごとのクエリメトリクスを取得します。
戻り値: JSON object。
パラメータ:
- uri - URIまたはセッション名。
- username, password - PostgreSQLの認証情報。
- database name - データベース名(省略した場合、postgresql.conf の Plugins.PostgreSQL.Default.Database の値が使用されます)。
- time period - 遅いクエリ数のカウントに対する実行時間のしきい値(正の整数である必要があります)。
pgsql.replication.count[uri,<username>,<password>]
スタンバイサーバーの数。
戻り値: Integer。
パラメータ:
- uri - URIまたはセッション名。
- username, password - PostgreSQLの認証情報。
pgsql.replication.process[uri,<username>,<password>]
各送信プロセスごとの flush lag、write lag、replay lag。
戻り値: JSON object。
パラメータ:
- uri - URI またはセッション名。
- username, password - PostgreSQL の認証情報。
pgsql.replication.process.discovery[uri,<username>,<password>]
レプリケーションプロセス名のディスカバリ。
戻り値: JSON object。
パラメータ:
- 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.confのPlugins.PostgreSQL.Default.Databaseの値が使用されます)。
pgsql.version[uri,<username>,<password>,<database name>]
PostgreSQLのバージョンを返します。
戻り値: 文字列。
パラメータ:
- uri - URIまたはセッション名。
- username, password - PostgreSQLの認証情報。
- database name - データベース名(省略した場合、postgresql.conf の Plugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.wal.stat[uri,<username>,<password>,<database name>]
WALの統計情報。
戻り値: JSON object。
パラメータ:
- uri - URIまたはセッション名。
- username, password - PostgreSQLの認証情報。
- database name - データベース名(省略した場合、postgresql.conf の Plugins.PostgreSQL.Default.Database の値が使用されます)。
redis.config[connString,<password>,<pattern>]
パターンに一致するRedisインスタンスの設定パラメータを取得します。
戻り値: グロブ形式のパターンが使用された場合は JSON、パターンにワイルドカード文字が含まれない場合は単一の値。
パラメータ:
- connString - URIまたはセッション名。
- password - Redisのパスワード。
- pattern - グロブ形式のパターン(デフォルトは *)。
コメント:
- セキュリティ警告:
redis.configはRedisのCONFIG GETコマンドを実行するため、機密性の高い設定パラメータ(たとえばrequirepass、masterauth、TLS関連の設定、その他のシークレット)を返す可能性があります。
デフォルトのパターン(*)または広範なパターンを使用すると、Zabbixでアイテムの値を表示する権限を持つすべてのユーザーに、これらのシークレットが公開される可能性があります。
redis.info[connString,<password>,<section>]
INFOコマンドの出力を取得します。
戻り値: JSON - 出力はJSONとしてシリアライズされます。
パラメータ:
- connString - URIまたはセッション名。
- password - Redisのパスワード。
- section - 情報のセクション(デフォルトでは default)。
redis.ping[connString,<password>]
接続が有効かどうかをテストします。
戻り値: 1 - 接続は有効です。0 - 接続は切断されています(AUTH や設定の問題を含む、何らかのエラーが発生している場合)。
パラメータ:
- 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(デフォルト)。 id はWindowsではサポートされておらず、選択するとエラーを返します
コメント:
- 次のマクロとその値が返されます: {#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 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[ユニット名,<interface>]
systemdユニットのすべてのプロパティを返します。
戻り値: JSON object。
パラメータ:
- ユニット名 - ユニット名(名前をディスカバリするには、アイテムプロトタイプで {#UNIT.NAME} マクロを使用すると便利です);
- interface - ユニットのインターフェースタイプ。指定可能な値: Unit(デフォルト)、Service、Socket、Device、Mount、Automount、Swap、Target、Path。
コメント:
- このアイテムは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}"] #collect active state (active, reloading, inactive, failed, activating, deactivating) info on discovered systemd units
systemd.unit.info["{#UNIT.NAME}",LoadState] #collect load state info on discovered systemd units
systemd.unit.info[mysqld.service,Id] #retrieve the service technical name (mysqld.service)
systemd.unit.info[mysqld.service,Description] #retrieve the service description (MySQL Server)
systemd.unit.info[mysqld.service,ActiveEnterTimestamp] #retrieve the last time the service entered the active state (1562565036283903)
systemd.unit.info[dbus.socket,NConnections,Socket] #collect the number of connections from this socket unit
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およびホスト名検証にのみ使用されます。 - port - ポート番号(HTTPSのデフォルトは443)。
- address - IPまたはDNSのいずれかを指定できます。 指定した場合、接続にはこれが使用され、hostname(第1パラメータ)はSNIおよびホスト検証に使用されます。 第1パラメータがIPで第3パラメータがDNSである場合、第1パラメータが接続に使用され、第3パラメータがSNIおよびホスト検証に使用されます。
コメント:
- ホスト設定で指定された宛先が存在しない、利用できない、または無効な証明書以外の何らかのエラーで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。
- version: X.509のバージョン(例:
- result: 検証結果を含みます。
- value: 検証ステータス(可能な値は以下を参照)。
- message: 詳細な検証メッセージ(例:
"certificate verified successfully")。
- sha1_fingerprint: 証明書のSHA-1フィンガープリント。
- sha256_fingerprint: 証明書のSHA-256フィンガープリント。
- x509: X.509証明書の詳細を含みます。
$.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"
}