ジャンプ先

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

このSNMPプロキシ・コレクションの表示

get

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

この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 Proxy"
    },
    "description":""
}

ネストされたスキーマ : SNMPプロキシ

型: object

ソースの表示

• community(optional): string
  デフォルト値: public

  このプロキシされるSNMPエージェントへのすべてのSNMPv1リクエストに渡されるコミュニティ名。

  プロキシされるエージェントに対してセキュリティ名を指定した場合、WebLogic SNMPエージェントはこのコミュニティ名を無視します。かわりに、エージェントはSNMPv3要求内のセキュリティ名をエンコードして、SNMPv3要求をこのプロキシされるエージェントに転送します。

  制約

  • セキュア・デフォルト: null
• dynamicallyCreated(optional): boolean
  読取り専用: true

  デフォルト値: false

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

• id(optional): integer(int64)
  読取り専用: true

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

• listenAddress(optional): string

  WebLogic SNMPエージェントがプロキシとして動作している外部SNMPエージェントのアドレスは、UDPプロトコルを使用するSNMPマネージャからの受信リクエストをリスニングしています。

  指定されていない場合、サーバーのListenAddressが外部SNMPAgentのListenAddressとして使用されます。

• 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エンティティに変換されます。キャリッジ・リターンとライン・フィードは維持されます。

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

• oidRoot(optional): string

  このプロキシされるSNMPエージェントが管理するオブジェクト識別子(OID)ツリーのルート。

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

  最大値: 65535

  このプロキシされるSNMPエージェントがリスニングするポート番号。

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

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

  プロキシされるSNMPエージェントが、指定されたセキュリティ名に対して想定するセキュリティ・レベル。

  制約

  • 本番モード・デフォルト : "authNoPriv"
  • 有効なnull
• securityName(optional): string

  WebLogic SNMPエージェントがv3リクエストを転送する際のユーザー名。指定しない場合、リクエストはv1リクエストとして転送されます。

  また、セキュリティ名を指定する場合は、WebLogic SNMPエージェントとSNMPマネージャ間の通信に構成されているレベル次のセキュリティ・レベルを指定する必要があります。たとえば、WebLogic SNMPエージェントが受信するSNMPv3リクエストにプライバシ・プロトコルではなく認証プロトコルの使用を求める場合、このプロキシのセキュリティ・レベルは、「認証のみ」または「なし」のいずれかでなければなりません。認可またはプライバシ・プロトコルを使用する場合は、WebLogic Serverセキュリティ・レルムで資格証明マッピングを構成する必要があります。

  WebLogic SNMPエージェントは、SNMPマネージャからのSNMP v3要求に含まれている資格証明を転送する(渡す)ことはできません。かわりに、エージェントは受信要求を認証して、その要求に対して他のセキュリティ操作を実行し、プロキシ対象のエージェントに転送する新しいリクエストを作成します。

  制約

  • 有効なnull
• tags(optional): array 項目
  タイトル: Items

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

• timeout(optional): integer(int64)
  最小値: 0

  デフォルト値: 5000

  WebLogic Server SNMPエージェントが、このプロキシ・エージェントに転送したリクエストへのレスポンスを待機するミリ秒数。

  指定された時間が経過してもレスポンスがなかった場合、WebLogic SNMPエージェントはリクエスト元のマネージャにエラーを送信します。

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

  MBeanのタイプを戻します。

  制約

  • 収集不可

{
    "type":"object",
    "properties":{
        "community":{
            "x-weblogic-secureDefault":null,
            "default":"public",
            "type":"string",
            "description":"<p>The community name to be passed on for all SNMPv1 requests to this proxied SNMP agent.</p><p>If you specify a <i>security name</i> for this proxied agent, the WebLogic SNMP agent ignores this community name. Instead, the agent encodes the security name in an SNMPv3 request and forwards the SNMPv3 request to this proxied agent.</p><p><h5>Constraints</h5></p><ul><li>secure default : null</li></ul>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "listenAddress":{
            "type":"string",
            "description":"<p>The address on which the external SNMP agent for which the WebLogic SNMP Agent is acting as a proxy is listening for incoming requests from SNMP managers that use the UDP protocol.</p><p>If not specified the Server's ListenAddress is used as the ListenAddress of the external SNMPAgent.</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>"
        },
        "oidRoot":{
            "type":"string",
            "description":"<p>The root of the object identifier (OID) tree that this proxied SNMP agent controls.</p>"
        },
        "port":{
            "minimum":0,
            "maximum":65535,
            "type":"integer",
            "format":"int32",
            "description":"<p>The port number on which this proxied SNMP agent is listening.</p>"
        },
        "securityLevel":{
            "default":"noAuthNoPriv",
            "x-weblogic-productionDefault":"authNoPriv",
            "enum":[
                "noAuthNoPriv",
                "authNoPriv",
                "authPriv"
            ],
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The security level that the proxied SNMP agent expects for the specified security name.</p><p><h5>Constraints</h5></p><ul><li>production mode default : \"authNoPriv\"</li><li>legal null</li></ul>"
        },
        "securityName":{
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The user name on whose behalf the WebLogic SNMP agent forwards v3 requests.  If not specified, the request is forwarded as a v1 request.</p><p>If you specify a security name, you must also specify a security level that is equal to or lower than the security level that is configured for communication between the WebLogic SNMP agent and SNMP managers. For example, if the WebLogic SNMP agent requires incoming SNMPv3 requests to use the authentication protocol but no privacy protocol, the security level for this proxy must be either Authentication Only or None.  Note that if you want to use the authorization  or privacy protocols, you must configure credential mapping in the WebLogic Server security realm.</p><p>The WebLogic SNMP agent cannot forward or pass through the credentials that are contained in SNMPv3 requests from SNMP managers. Instead, the agent authenticates and performs other security operations on incoming requests, and then constructs a new request to forward to a proxied agent.</p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "timeout":{
            "default":5000,
            "minimum":0,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of milliseconds that the WebLogic Server SNMP agent waits for a response to requests that it forwards to this proxy agent.</p><p>If the interval elapses without a response, the WebLogic SNMP agent sends an error to the requesting manager.</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>"
}

先頭に戻る