1. RESTful Domain Configuration Management Interface for Oracle WebLogic Server
  2. Tasks
  3. SNMP Agent Deployment

View This SNMP Agent Deployment Collection

get

/management/weblogic/{version}/domainConfig/SNMPAgentDeployments

View this SNMP agent deployment collection.

Request

Path Parameters
Query Parameters
  • The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
  • The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
Security
Back to Top

Response

Supported Media Types

200 Response

Returns a list of SNMP agent deployment entities.

Body ()
Root Schema : Items
Type: array
Title: Items
Show Source
Nested Schema : SNMP Agent Deployment
Type: object
Show Source
  • Default Value: MD5
    Allowed Values: [ "noAuth", "MD5", "SHA" ]

    The protocol that this SNMP agent uses to ensure that only authorized users can request or receive information about your WebLogic Server domain. Applicable only with SNMPv3.

    The protocol also ensures message integrity and prevents masquerading and reordered, delayed, or replayed messages.

    To use this protocol when receiving requests from SNMP managers, you must configure credential mapping in the WebLogic Server security realm. To use this protocol when sending responses or notifications, you must configure the security level of your trap destinations.

    If you do not choose an authentication protocol, then the SNMP agent does not authenticate incoming SNMPv3 requests; anyone can use SNMPv3 to retrieve information about your WebLogic Server domain.

    Constraints

    • legal null
  • Minimum Value: 0
    Maximum Value: 2147483647
    Default Value: 1000

    A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.

    For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.

    Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.

  • Read Only: true
    Default Value: false

    Return whether the MBean was created dynamically or is persisted to config.xml

  • Default Value: false

    Specifies whether this SNMP agent is enabled.

    Constraints

    • secure default : false
  • Read Only: true

    Return the unique id of this MBean instance

  • Default Value: false

    Configures this SNMP agent to send notifications as an INFORM instead of a TRAP. Requires you to specify the agent's SNMPTrapVersion as SNMPv2 or SNMPv3.

    When an agent sends an INFORM notification, it waits for a confirmation response from the SNMP manager. If it does not receive a response, it resends the INFORM notification.

  • Minimum Value: 3000
    Maximum Value: 30000
    Default Value: 10000

    The number of milliseconds that this SNMP agent will wait for a response to an INFORM notification.

    If the agent does not receive a response within the specified interval, it will resend the notification.

  • The listen address on which you want this SNMP agent to listen for incoming requests from SNMP managers that use the UDP protocol.

    If not specified the Server's ListenAddress is used as the ListenAddress for the SNMPAgent.

  • Maximum Value: 86400000
    Default Value: 3600000

    The number of milliseconds after which WebLogic Server invalidates its cache of SNMP security keys. Setting a high value creates a risk that users whose credentials have been removed can still access SNMP data.

    An SNMP security key is an encrypted version of an SNMP agent's engine ID and an authentication password or privacy password. WebLogic Server generates one security key for each entry that you create in the SNMP credential map. When a WebLogic Server SNMP agent receives an SNMPv3 request, it compares the key that is in the request with its WebLogic Server keys. If it finds a match, it processes the request. The SNMP agent also encodes these keys in its responses and notifications. (You configure which keys are encoded when you create a trap destination.)

    Instead of regenerating the keys for each SNMPv3 communication, WebLogic Server caches the keys. To make sure that the cache contains the latest set of SNMP credentials, WebLogic Server periodically invalidates the cache. After the cache is invalidated, the next time an SNMP agent requests credentials, WebLogic Server regenerates the cache.

    Note that making a change to the credential map does not automatically update the cache. Instead, the cache is updated only after it has been invalidated.

    For example, if you update a privacy password in an existing entry in the SNMP credential map, the SNMP agent is not aware of the new password until the key cache is invalidated and regenerated. An SNMP user with the old security password can still access WebLogic Server data until the cache is invalidated.

    You can invalidate a key immediately instead of waiting for this invalidation interval to expire.

  • Minimum Value: 1
    Maximum Value: 65535
    Default Value: 705

    The port that this SNMP agent uses to communicate with its subagents.

    The agent uses subagents to provide access to custom MBeans (MBeans that you create and register) and to other software components. WebLogic Server SNMP agents do not enable users to register their own subagents.

  • Minimum Value: 1
    Maximum Value: 3
    Default Value: 1

    The maximum number of times that this SNMP agent will resend INFORM notifications for which it has not received a response.

  • Read Only: true

    The user-specified name of this MBean instance.

    This name is included as one of the key properties in the MBean's javax.management.ObjectName

    Name=user-specified-name

    Constraints

    • legal null

  • Optional information that you can include to describe this configuration.

    WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the xml entity <. Carriage returns/line feeds are preserved.

    Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

  • Default Value: AES_128
    Allowed Values: [ "noPriv", "DES", "AES_128" ]

    The protocol that this SNMP agent uses to encrypt and unencrypt messages. Applicable only with SNMPv3. Requires you to also use an authentication protocol.

    To use this protocol when sending responses or notifications, you must also configure the security level of your trap destinations.

    If you do not choose a privacy protocol, then communication between this agent and managers can be viewed (but not altered) by unauthorized users.

    Constraints

    • legal null
  • Default Value: true

    Specifies whether this SNMP agent sends automatically generated notifications to SNMP managers.

    The SNMP agent generates automatic notifications when any of the following events occur:

    • The WebLogic Server instance that is hosting the SNMP agent starts.

      This type of notification (coldStart) has no variable bindings.

    • A server instance starts or stops.

      An SNMP agent on a Managed Server generates these notifications only when its host Managed Server starts or stops. An SNMP agent on an Administration Server generates these notifications when any server in the domain starts or stops.

      These notification types (serverStart and serverShutdown) contain variable bindings to identify the server that started or stopped and the time at which the notification was generated.

  • Configures this SNMP agent to provide read-only access to MBean types that you have created and registered (custom MBeans).

    If you enable this access, when you register a custom MBean in a WebLogic Server MBeanServer, this SNMP agent dynamically updates a runtime MIB module that WebLogic Server maintains for custom MBeans.

    For each custom MBean type, WebLogic Server adds a table to the MIB module. For each instance of the custom MBean, it adds a table row. While WebLogic Server does not persist the MIB as a file or other data structure, the OIDs in the MIB remain constant across server sessions.

    The MIB module for custom MBeans is managed by a subAgent. Its master agent is this WebLogic Server SNMP agent and it communicates with the master agent through the AgentX port.

  • An identifier for this SNMP agent that is unique amongst all other SNMP agents in the current WebLogic Server domain.

    If you use SNMPv3 to send messages to this SNMP agent, you must specify the SNMP engine ID when you configure the SNMP manager.

    For an SNMP agent on an Administration Server, the default value is the name of the WebLogic Server domain. For an agent on a Managed Server, the default is the name of the server.

    Constraints

    • legal null
  • Minimum Value: 1
    Maximum Value: 65535
    Default Value: 161

    The port on which you want this SNMP agent to listen for incoming requests from SNMP managers that use the UDP protocol.

    SNMP managers can use this port to ping the SNMP agent and request the status of specific attributes.

    If you target this SNMP agent to multiple server instances, and if two or more servers are running on the same computer, WebLogic Server will automatically increment this UDP port value by 1 for each agent. WebLogic Server never assigns port 162 because it is the default port that an agent uses to send notifications. In addition, if any port is already in use, WebLogic Server skips the port and assigns the next available port.

    For example, if you use the default value of this attribute and then target this agent to ManagedServer1 and ManagedServer2, and if both servers are running on the same computer, then the agent on ManagedServer1 will listen on UDP port 161 and the agent on ManagedServer2 will listen on UDP port 163.

    The incremented port number is not persisted in the domain's configuration; when WebLogic Server increments port numbers, it does so in the order in which servers are started on the same computer.

    If WebLogic Server re-assigns the UDP port for an SNMP agent, look in the agent's SNMPAgentRuntimeMBean to see the agent's runtime UDP port.

    SNMP agents can also communicate through the host server's TCP listen port (7001 by default) or through a TCP port that is configured by a custom network channel.

  • Default Value: 3
    Allowed Values: [ 1, 2, 3 ]

    The SNMP notification version that this SNMP agent generates.

  • Items
    Title: Items

    Return all tags on this Configuration MBean

  • Target References
    Title: Target References
    Contains the array of target references.

    You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.

  • Read Only: true

    Returns the type of the MBean.

    Constraints

    • unharvestable
Nested Schema : Items
Type: array
Title: Items

Return all tags on this Configuration MBean

Show Source
Nested Schema : Target References
Type: array
Title: Target References
Contains the array of target references.

You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.

Show Source
Nested Schema : Target Reference
Type: object
Title: Target Reference
Contains the target reference.
Show Source
Nested Schema : Identity
Type: array
Title: Identity
DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.
Show Source
Back to Top