View This SNMP Proxy
/management/weblogic/{version}/edit/SNMPAgentDeployments/{name}/SNMPProxies/{name}
View this SNMP proxy.
Request
-
name: string
The name property of the instance in the collection.
-
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 this SNMP proxy.
object
-
community(optional):
string
Default Value:
public
The community name to be passed on for all SNMPv1 requests to this proxied SNMP agent.
If you specify a security name 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.
Constraints
- secure default : null
-
dynamicallyCreated(optional):
boolean
Read Only:
true
Default Value:false
Return whether the MBean was created dynamically or is persisted to config.xml
-
id(optional):
integer(int64)
Read Only:
true
Return the unique id of this MBean instance
-
listenAddress(optional):
string
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.
If not specified the Server's ListenAddress is used as the ListenAddress of the external SNMPAgent.
-
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.
-
oidRoot(optional):
string
The root of the object identifier (OID) tree that this proxied SNMP agent controls.
-
port(optional):
integer(int32)
Minimum Value:
0
Maximum Value:65535
The port number on which this proxied SNMP agent is listening.
-
securityLevel(optional):
string
Default Value:
noAuthNoPriv
Allowed Values:[ "noAuthNoPriv", "authNoPriv", "authPriv" ]
The security level that the proxied SNMP agent expects for the specified security name.
Constraints
- production mode default : "authNoPriv"
- legal null
-
securityName(optional):
string
The user name on whose behalf the WebLogic SNMP agent forwards v3 requests. If not specified, the request is forwarded as a v1 request.
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.
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.
Constraints
- legal null
-
tags(optional):
array Items
Title:
Items
Return all tags on this Configuration MBean
-
timeout(optional):
integer(int64)
Minimum Value:
0
Default Value:5000
The number of milliseconds that the WebLogic Server SNMP agent waits for a response to requests that it forwards to this proxy agent.
If the interval elapses without a response, the WebLogic SNMP agent sends an error to the requesting manager.
-
type(optional):
string
Read Only:
true
Returns the type of the MBean.
Constraints
- unharvestable