ジャンプ先

• リクエスト
• レスポンス

このSNMPトラップ宛先コレクションの表示

get

/management/weblogic/{version}/serverConfig/SNMPAgentDeployments/{name}/SNMPTrapDestinations

このSNMPトラップ宛先コレクションを表示します。

リクエスト

パス・パラメータ

• name: string
  コレクション内のインスタンスのnameプロパティ。
• version: string
  WebLogic RESTインタフェースのバージョン。

問合せパラメータ

• excludeFields(optional): string
  'excludeFields'問合せパラメータは、レスポンスで返されるフィールドを制限するために使用します。これは、フィールド名のカンマ区切りリストです。存在する場合は、名前がリストにないフィールドのみが返されます。存在しない場合は、すべてのフィールドが返されます('fields'問合せパラメータが指定されていない場合)。注意: 'excludeFields'が指定されている場合、'fields'を指定しないでください。
• excludeLinks(optional): string
  'excludeLinks'問合せパラメータは、レスポンスで返されるリンクを制限するために使用します。これは、リンク関係名のカンマ区切りリストです。存在する場合は、関係名がリストにないリンクのみが返されます。存在しない場合は、すべてのリンクが返されます('links'問合せパラメータが指定されていない場合)。注意: 'excludeLinks'が指定されている場合、'links'を指定しないでください。
• fields(optional): string
  'fields'問合せパラメータは、レスポンスで返されるフィールドを制限するために使用します。これは、フィールド名のカンマ区切りリストです。存在する場合は、名前が一致するフィールドのみが返されます。存在しない場合は、すべてのフィールドが返されます('excludeFields'問合せパラメータが指定されていない場合)。注意: 'fields'が指定されている場合、'excludeFields'を指定しないでください。
• links(optional): string
  'links'問合せパラメータは、レスポンスで返されるリンクを制限するために使用します。これは、リンク関係名のカンマ区切りリストです。存在する場合は、関係名が一致するリンクのみが返されます。存在しない場合は、すべてのリンクが返されます('excludeLinks'問合せパラメータが指定されていない場合)。注意: 'links'が指定されている場合、'excludeLinks'を指定しないでください。

セキュリティ

• Admin: basic
  型: Basic

  説明: A user in the Admin security role.
• デプロイヤ: 基本
  型: Basic

  説明: A user in the Deployer security role.
• モニター: 基本
  型: Basic

  説明: A user in the Monitor security role.
• オペレータ: 基本
  型: Basic

  説明: A user in the Operator security role.

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200レスポンス

SNMPトラップ宛先のエンティティのリストを返します。

本文()

ルート・スキーマ: 項目

型: array

タイトル: Items

ソースの表示

• 配列: object SNMPトラップ宛先

{
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/SNMP Trap Destination"
    },
    "description":""
}

ネストされたスキーマ : SNMPトラップ宛先

型: object

ソースの表示

• dynamicallyCreated(optional): boolean
  読取り専用: true

  デフォルト値: false

  MBeanが動的に作成されたか、config.xmlに対して永続化されているかが返されます

• host(optional): string
  デフォルト値: localhost

  SNMPマネージャが動作しているコンピュータのDNS名またはIPアドレス。

  WebLogic SNMPエージェントは、指定されたホストとポートにトラップ通知を送信します。

  制約

  • ドキュメントのみのセキュア・デフォルト: "127.0.0.1 or ::1"
• id(optional): integer(int64)
  読取り専用: true

  このMBeanインスタンスの一意のIDを返します

• name(optional): string
  読取り専用: true

  このMBeanインスタンスのユーザー定義の名前。

  この名前は、MBeanのjavax.management.ObjectNameに、主要なプロパティとして含まれています

  Name=user-specified-name

  制約

  • 有効なnull
• notes(optional): string

  この構成の説明として任意に入力できる情報。

  WebLogic Serverは、ドメインの構成ファイル(config.xml)に、このメモをXML PCDATAとして保存します。すべての左山カッコ(<) are converted to the xml entity <)は、xmlエンティティに変換されます。キャリッジ・リターンとライン・フィードは維持されます。

  注意: 管理コンソールからメモを作成または編集した場合、キャリッジ・リターンとライン・フィードは維持されません。

• port(optional): integer(int32)
  最小値: 1

  最大値: 65535

  デフォルト値: 162

  SNMPマネージャがリスニングするUDPポート。

• securityLevel(optional): string
  デフォルト値: authNoPriv

  使用可能な値: [ "noAuthNoPriv", "authNoPriv", "authPriv" ]

  SNMPエージェントがSNMPv3レスポンスまたは通知を、このトラップ宛先が表すSNMPマネージャに送信する際に使用するセキュリティ・プロトコルを指定します。このトラップ宛先のセキュリティ名を指定する必要があります。

  制約

  • 有効なnull
• securityName(optional): string

  WebLogic Server SNMPエージェントがSNMPv3レスポンスまたは通知にエンコードするユーザー名を指定します。WebLogic Serverセキュリティ・レルムでこのユーザー名の資格証明マップを作成する必要があります。

  資格証明マップはこのユーザーの認証パスワード、およびプライバシ・パスワード(オプション)を格納します。

  ユーザー名とパスワードは、このトラップ宛先が表すSNMPマネージャによって要求された資格証明と一致する必要があります。

• tags(optional): array 項目
  タイトル: Items

  この構成MBeanのすべてのタグを返します

• type(optional): string
  読取り専用: true

  MBeanのタイプを戻します。

  制約

  • 収集不可

{
    "type":"object",
    "properties":{
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "host":{
            "x-weblogic-docOnlySecureDefault":"127.0.0.1 or ::1",
            "default":"localhost",
            "type":"string",
            "description":"<p>The DNS name or IP address of the computer on which the SNMP manager is running.</p><p>The WebLogic SNMP agent sends trap notifications to the host and port that you specify.</p><p><h5>Constraints</h5></p><ul><li>doc only secure default : \"127.0.0.1 or ::1\"</li></ul>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The user-specified name of this MBean instance.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "notes":{
            "type":"string",
            "description":"<p>Optional information that you can include to describe this configuration.</p><p>WebLogic Server saves this note in the domain's configuration file (<code>config.xml</code>) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><p>Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p>"
        },
        "port":{
            "default":162,
            "minimum":1,
            "maximum":65535,
            "type":"integer",
            "format":"int32",
            "description":"<p>The UDP port on which the SNMP manager is listening.</p>"
        },
        "securityLevel":{
            "default":"authNoPriv",
            "enum":[
                "noAuthNoPriv",
                "authNoPriv",
                "authPriv"
            ],
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>Specifies the security protocols that the SNMP agent uses when sending SNMPv3 responses or notifications to the SNMP manager that this trap destination represents. Requires you to specify a security name for this trap destination.</p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "securityName":{
            "type":"string",
            "description":"<p>Specifies the user name that the WebLogic Server SNMP agent encodes into SNMPv3 responses or notifications. Requires you to create a credential map for this user name in the WebLogic Server security realm.</p><p>The credential map contains an authentication password and an optional privacy password for this user.</p><p>The user name and passwords must match the credentials required by the SNMP manager that this trap destination represents.</p>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "type":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        }
    },
    "description":""
}

ネストされたスキーマ: 項目

型: array

タイトル: Items

この構成MBeanのすべてのタグを返します

ソースの表示

• 配列: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return all tags on this Configuration MBean</p>"
}

先頭に戻る