View This SNMP Trap Destination Collection
/management/weblogic/{version}/serverConfig/SNMPAgent/SNMPTrapDestinations
View this SNMP trap destination collection.
Request
-
version: string
The version of the WebLogic REST interface.
-
excludeFields(optional): string
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.
-
excludeLinks(optional): string
The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
-
fields(optional): string
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.
-
links(optional): string
The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.
-
Admin: basic
Type:
basic
Description:A user in the Admin security role.
-
Deployer: basic
Type:
basic
Description:A user in the Deployer security role.
-
Monitor: basic
Type:
basic
Description:A user in the Monitor security role.
-
Operator: basic
Type:
basic
Description:A user in the Operator security role.
Response
- application/json
200 Response
Returns a list of SNMP trap destination entities.
object
-
dynamicallyCreated(optional):
boolean
Read Only:
true
Default Value:false
Return whether the MBean was created dynamically or is persisted to config.xml
-
host(optional):
string
Default Value:
localhost
The DNS name or IP address of the computer on which the SNMP manager is running.
The WebLogic SNMP agent sends trap notifications to the host and port that you specify.
Constraints
- doc only secure default : "127.0.0.1 or ::1"
-
id(optional):
integer(int64)
Read Only:
true
Return the unique id of this MBean instance
-
name(optional):
string
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
-
notes(optional):
string
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.
-
port(optional):
integer(int32)
Minimum Value:
1
Maximum Value:65535
Default Value:162
The UDP port on which the SNMP manager is listening.
-
securityLevel(optional):
string
Default Value:
authNoPriv
Allowed Values:[ "noAuthNoPriv", "authNoPriv", "authPriv" ]
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.
Constraints
- legal null
-
securityName(optional):
string
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.
The credential map contains an authentication password and an optional privacy password for this user.
The user name and passwords must match the credentials required by the SNMP manager that this trap destination represents.
-
tags(optional):
array Items
Title:
Items
Return all tags on this Configuration MBean
-
type(optional):
string
Read Only:
true
Returns the type of the MBean.
Constraints
- unharvestable