Jump to

• Request
• Response

GET A Create Form For This SNMP Trap Destination Collection

get

/management/weblogic/{version}/edit/SNMPAgent/SNMPTrapDestinationCreateForm

This resource returns a pre-populated SNMP trap destination model that can be customized then posted (using the POST method) to the SNMPTrapDestinations collection resource to create a new SNMP trap destination.

Request

Path Parameters

• version: string
  The version of the WebLogic REST interface.

Query Parameters

• 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.

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns this SNMP trap destination.

This method can return the following links:

• rel=create uri=/management/weblogic/{version}/edit/SNMPAgent/SNMPTrapDestinations

  The collection resource for this create form resource.

Body ()

Root Schema : SNMP Trap Destination

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "host":{
            "x-weblogic-docOnlySecureDefault":"127.0.0.1 or ::1",
            "default":"localhost",
            "type":"string",
            "description":"<p>The DNS name or IP address of the computer on which the SNMP manager is running.</p><p>The WebLogic SNMP agent sends trap notifications to the host and port that you specify.</p><p><h5>Constraints</h5></p><ul><li>doc only secure default : \"127.0.0.1 or ::1\"</li></ul>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The user-specified name of this MBean instance.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "notes":{
            "type":"string",
            "description":"<p>Optional information that you can include to describe this configuration.</p><p>WebLogic Server saves this note in the domain's configuration file (<code>config.xml</code>) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><p>Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p>"
        },
        "port":{
            "default":162,
            "minimum":1,
            "maximum":65535,
            "type":"integer",
            "format":"int32",
            "description":"<p>The UDP port on which the SNMP manager is listening.</p>"
        },
        "securityLevel":{
            "default":"authNoPriv",
            "enum":[
                "noAuthNoPriv",
                "authNoPriv",
                "authPriv"
            ],
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>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.</p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "securityName":{
            "type":"string",
            "description":"<p>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.</p><p>The credential map contains an authentication password and an optional privacy password for this user.</p><p>The user name and passwords must match the credentials required by the SNMP manager that this trap destination represents.</p>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</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":""
}

Nested Schema : Items

Type: array

Title: Items

Return all tags on this Configuration MBean

Show Source

• Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return all tags on this Configuration MBean</p>"
}

Back to Top