RESTful Domain Runtime Management Interface for Oracle WebLogic Server

View This SNMP Agent Runtime

get

/management/weblogic/{version}/domainRuntime/SNMPAgentRuntime

View this SNMP agent runtime.

Request

Path Parameters

version(required): string

The version of the WebLogic REST interface.

Query Parameters

excludeFields: 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: 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: 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: 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.

Security

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

Supported Media Types

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.

Root Schema : SNMP Agent Runtime

Type: object

Show Source

attributeChangeTrapCount: 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: 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: integer(int32)

Read Only: true

The number of requests that this agent has rejected because of incorrect user credentials.
failedAuthorizationCount: 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: integer(int32)

Read Only: true

The number of requests that this agent has rejected because of incorrect privacy (encryption) credentials
gaugeMonitorTrapCount: 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: 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: 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: 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: string
Read Only: true
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
Constraints
- unharvestable
running: boolean

Read Only: true

Indicates whether this SNMP agent is running.
serverStartTrapCount: 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: 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: 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: 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: string
Read Only: true
Returns the type of the MBean.
Constraints
- unharvestable
UDPListenPort: 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.

{
    "type":"object",
    "properties":{
        "SNMPAgentName":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Gets the name of the SNMPAgent MBean configuration that is currently active. Returns null if no SNMPAgent configuration is currently active on this Server.</p>"
        },
        "UDPListenPort":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The UDP port on which this SNMP agent is listening for incoming requests from SNMP managers.</p><p>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.</p>"
        },
        "attributeChangeTrapCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of attribute change notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.</p>"
        },
        "counterMonitorTrapCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of counter monitor notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.</p>"
        },
        "failedAuthenticationCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The number of requests that this agent has rejected because of incorrect user credentials.</p>"
        },
        "failedAuthorizationCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>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.</p>"
        },
        "failedEncryptionCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The number of requests that this agent has rejected because of incorrect privacy (encryption) credentials</p>"
        },
        "gaugeMonitorTrapCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of gauge monitor notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.</p>"
        },
        "logMessageTrapCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of log message notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.</p>"
        },
        "masterAgentXPort":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The port that this SNMP agent uses to communicate with subagents.</p><p>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.</p>"
        },
        "monitorTrapCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The total number of all notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "running":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether this SNMP agent is running.</p>"
        },
        "serverStartTrapCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of serverStart notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.</p>"
        },
        "serverStopTrapCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of serverShutdown notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.</p>"
        },
        "stringMonitorTrapCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The number of string monitor notifications that this SNMP agent has sent to all trap destinations since the agent's host server was started.</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":""
}