SNMP 関数
[SNMP は、[要件] セクションで指定したオペレーティング システムで使用できます。 今後のバージョンでは変更されるか、利用できなくなる場合もあります。 代わりに、WS-Man の Microsoft 実装である Windows リモート管理を使用します。
このトピックでは、SNMP 関数の 3 つのグループについて説明し、各グループに含まれる関数の一覧を示します。
SNMP 拡張エージェント API 関数
SNMP 拡張エージェント関数は、SNMP サービスとサードパーティの SNMP 拡張エージェント DLL の間のインターフェイスを定義します。 次の表は、アプリケーションが受信 SNMP プロトコル データ ユニット (PDU) で指定された変数バインディングを解決するために使用できる関数の一覧です。
| SNMP 拡張エージェント API 関数 | 説明 |
|---|---|
| SnmpExtensionClose | SNMP 拡張エージェントがリソースの割り当てを解除し、操作を終了することを要求します。 |
| SnmpExtensionInit | SNMP 拡張エージェント DLL を初期化します。 |
| SnmpExtensionInitEx | SNMP 拡張エージェントがサポートする追加の管理情報ベース (MIB) サブツリーを識別します。 |
| SnmpExtensionMonitor | SNMP 拡張エージェントに、サービスの内部カウンターとパラメーターに関する情報を提供します。 |
| SnmpExtensionQuery | SNMP 拡張エージェントの 1 つ以上の登録済み MIB サブツリーに変数を含む SNMP 要求を解決します。 |
| SnmpExtensionQueryEx | SNMP 拡張エージェントによって登録される 1 つ以上の MIB サブツリーに変数を指定する SNMP 要求を処理します。 |
| SnmpExtensionTrap | SNMP 拡張エージェントのトラップを生成するためにサービスに必要な情報を取得します。 |
SNMP Management API Functions
SNMP 管理機能は、サードパーティの SNMP マネージャー アプリケーションと管理機能ダイナミック リンク ライブラリ (DLL) Mgmtapi.dll間のインターフェイスを定義します。 DLL は SNMP トラップ サービス (Snmptrap.exe) と連携して動作し、1 つ以上のサードパーティ SNMP マネージャー アプリケーションと対話できます。 次の表に、サードパーティのマネージャー アプリケーションが SNMP マネージャー操作の実行に使用する管理機能を示します。
| SNMP Management API 関数 | 説明 |
|---|---|
| SnmpMgrClose | 指定したセッションに関連付けられている通信ソケットとデータ構造を閉じます。 |
| SnmpMgrCtl | SNMP セッションに関連付けられている操作パラメーターを設定します。 |
| SnmpMgrGetTrap | トラップ受信が有効になっている場合に呼び出し元が受信していない未処理のトラップ データを返します。 |
| SnmpMgrGetTrapEx | トラップ受信が有効になっている場合に呼び出し元が受信していない未処理のトラップ データを返します。 また、トランスポート ソースのアドレスと、トラップに関連付けられているコミュニティ トラップも返します。 |
| SnmpMgrOidToStr | 内部オブジェクト識別子構造体を文字列表現に変換します。 |
| SnmpMgrOpen | SNMP エージェントとの通信を確立するために必要な通信ソケットとデータ構造を初期化します。 |
| SnmpMgrRequest | 指定したエージェントが指定した操作を実行することを要求します。 |
| SnmpMgrStrToOid | オブジェクト識別子の文字列形式を、その内部オブジェクト識別子構造体に変換します。 |
| SnmpMgrTrapListen | SNMP トラップ サービスから SNMP トラップを受信する SNMP マネージャー アプリケーションの機能を登録します。 |
SNMP ユーティリティ API 関数
SNMP ユーティリティ機能は、SNMP データ構造の操作を簡略化するなど、SNMP アプリケーションの開発時に役立つ機能を提供します。 次の表に、SNMP ユーティリティの機能を示します。
| SNMP ユーティリティ API 関数 | 説明 |
|---|---|
| SnmpSvcGetUptime | SNMP サービスが実行されている時間を秒単位で取得します。 |
| SnmpSvcSetLogLevel | SNMP サービスおよび SNMP 拡張エージェントからのデバッグ出力の詳細レベルを調整します。 |
| SnmpSvcSetLogType | SNMP サービスおよび SNMP 拡張エージェントからのデバッグ出力の宛先を調整します。 |
| SnmpUtilAsnAnyCpy | 変換元 の AsnAny 構造体をコピー先の AsnAny 構造体に コピーします。 |
| SnmpUtilAsnAnyFree | 指定した AsnAny 構造体に割り当てられたメモリを解放します。 |
| SnmpUtilDbgPrint | SNMP サービスまたは SnmpUtilDbgPrint の呼び出しから受信するデバッグ情報のレベルを設定します。 |
| SnmpUtilIdsToA | オブジェクト識別子 (OID) を null で終わる文字列に変換します。 |
| SnmpUtilMemAlloc | プロセス ヒープから動的メモリを割り当てます。 |
| SnmpUtilMemFree | 指定したメモリ オブジェクトを解放します。 |
| SnmpUtilMemReAlloc | 指定したメモリ オブジェクトのサイズを変更します。 |
| SnmpUtilOctetsCmp | 2 つのオクテット文字列を比較します。 |
| SnmpUtilOctetsCpy | 変換元 の AsnOctetString 構造体をコピー先の AsnOctetString 構造体に コピーします。 |
| SnmpUtilOctetsFree | 指定したオクテット文字列に割り当てられたメモリを解放します。 |
| SnmpUtilOctetsNCmp | 指定した数のサブ識別子との 2 つのオクテット文字列の比較を実行します。 |
| SnmpUtilOidAppend | AsnObjectIdentifier 構造体に含まれるソース オブジェクト識別子をコピー先オブジェクト識別子に追加します。 |
| SnmpUtilOidCmp | AsnObjectIdentifier 構造体に含まれる 2 つのオブジェクト識別子を比較します。 |
| SnmpUtilOidCpy | 変換元の AsnObjectIdentifier 構造体をコピー先の AsnObjectIdentifier 構造体にコピーします。 |
| SnmpUtilOidFree | 指定したオブジェクト識別子に割り当てられたメモリを解放します。 |
| SnmpUtilOidNCmp | AsnObjectIdentifier 構造体に含まれる 2 つのオブジェクト識別子を、指定した数のサブ識別子と比較します。 |
| SnmpUtilOidToA | オブジェクト識別子 (OID) を null で終わる文字列に変換します。 |
| SnmpUtilPrintAsnAny | デバッグと開発のために AsnAny 構造体に含まれる値を出力します。 |
| SnmpUtilPrintOid | 指定したオブジェクト識別子 (OID) を書式設定し、標準出力デバイスに結果を出力します。 |
| SnmpUtilVarBindCpy | ソース SnmpVarBind 構造体を宛先 SnmpVarBind 構造体にコピーします。 |
| SnmpUtilVarBindListCpy | ソース SnmpVarBindList 構造体を宛先 SnmpVarBindList 構造体にコピーします。 |
| SnmpUtilVarBindFree | 指定した SnmpVarBind 構造体に割り当てられたメモリを解放します。 |
| SnmpUtilVarBindListFree | 指定した SnmpVarBindList 構造体に割り当てられたメモリを解放します。 |