View This SNMP Agent Runtime
/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime
View this SNMP agent runtime.
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 this SNMP agent runtime.
This method can return the following links:
- rel=action title=invalidateLocalizedKeyCache uri=/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime/invalidateLocalizedKeyCache
This resource's invalidateLocalizedKeyCache action resource.
- rel=action title=outputCustomMBeansMIBModule uri=/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime/outputCustomMBeansMIBModule
This resource's outputCustomMBeansMIBModule action resource.
object
-
attributeChangeTrapCount(optional):
integer(int64)
Read Only:
true
The number of attribute change notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.
-
counterMonitorTrapCount(optional):
integer(int64)
Read Only:
true
The number of counter monitor notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.
-
failedAuthenticationCount(optional):
integer(int32)
Read Only:
true
The number of requests that this agent has rejected because of incorrect user credentials.
-
failedAuthorizationCount(optional):
integer(int32)
Read Only:
true
The number of requests that this agent has rejected because an authenticated user does not have sufficient privileges to view the requested information. You use the WebLogic Server security realm to assign privileges to users.
-
failedEncryptionCount(optional):
integer(int32)
Read Only:
true
The number of requests that this agent has rejected because of incorrect privacy (encryption) credentials
-
gaugeMonitorTrapCount(optional):
integer(int64)
Read Only:
true
The number of gauge monitor notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.
-
logMessageTrapCount(optional):
integer(int64)
Read Only:
true
The number of log message notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.
-
masterAgentXPort(optional):
integer(int32)
Read Only:
true
The port that this SNMP agent uses to communicate with subagents.
The agent uses subagents to provide access to custom MBeans (MBeans that you create and register) and to other Oracle software components. WebLogic Server SNMP agents do not enable users to register their own subagents.
-
monitorTrapCount(optional):
integer(int64)
Read Only:
true
The total number of all notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.
-
name(optional):
string
Read Only:
true
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Constraints
- unharvestable
-
running(optional):
boolean
Read Only:
true
Indicates whether this SNMP agent is running.
-
serverStartTrapCount(optional):
integer(int64)
Read Only:
true
The number of serverStart notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.
-
serverStopTrapCount(optional):
integer(int64)
Read Only:
true
The number of serverShutdown notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.
-
SNMPAgentName(optional):
string
Read Only:
true
Gets the name of the SNMPAgent MBean configuration that is currently active. Returns null if no SNMPAgent configuration is currently active on this Server.
-
stringMonitorTrapCount(optional):
integer(int64)
Read Only:
true
The number of string monitor notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.
-
type(optional):
string
Read Only:
true
Returns the type of the MBean.
Constraints
- unharvestable
-
UDPListenPort(optional):
integer(int32)
Read Only:
true
The UDP port on which this SNMP agent is listening for incoming requests from SNMP managers.
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.