1. RESTful Server Configuration Management Interface for Oracle WebLogic Server
  2. Tasks
  3. Network Access Point
  4. Servers
  5. Network Access Points

View This Network Access Point

get

/management/weblogic/{version}/serverConfig/servers/{name}/networkAccessPoints/{name}

View this network access point.

Request

Path Parameters
Query Parameters
  • 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.
  • 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.
Security
Back to Top

Response

Supported Media Types

200 Response

Returns this network access point.

Body ()
Root Schema : Network Access Point
Type: object
Show Source
  • Minimum Value: 0

    The number of backlogged, new TCP connection requests that this network channel allows. A value of -1 indicates that the network channel obtains its backlog configuration from the server's configuration.

  • Test if the AllowUnEncryptedNullCipher is enabled

    see setAllowUnencryptedNullCipher(boolean enable) for the NullCipher feature.

  • Default Value: false

    Whether or not the channel's custom identity should be used. This setting only has an effect if the server is using a customized keystore. By default the channel's identity is inherited from the server's identity.

  • Minimum Value: 1
    Maximum Value: 100
    Default Value: 50

    A weight to give this channel when creating server-to-server connections.

  • Items
    Title: Items

    Indicates the cipher suites being used on a particular WebLogic Server channel.

    The strongest negotiated cipher suite is chosen during the SSL handshake. The set of cipher suites used by default by JSEE depends on the specific JDK version with which WebLogic Server is configured.

    For a list of possible values, see Cipher Suites

  • Default Value: false

    Specifies whether clients must present digital certificates from a trusted certificate authority to WebLogic Server on this channel.

    Constraints

    • doc only secure default : true
  • Default Value: false

    Indicate whether TLS client initiated secure renegotiation is accepted.

  • The address this network channel uses to generate EJB handles and failover addresses for use in a cluster. This value is determined according to the following order of precedence:

    1. If the cluster address is specified via the NAPMBean, then that value is used

    2. If this value is not specified, the value of PublicAddress is used.

    3. If PublicAddress is not set, this value is derive from the ClusterAddress attribute of the ClusterMbean.

    4. If ClusterMbean.clusterAddress is not set, this value is derive from the listen address of the NAPMbean.

  • Minimum Value: 0
    Maximum Value: 480

    The maximum amount of time this network channel waits for a complete message to be received. A value of disables network channel complete message timeout. A value of -1 indicates that the network channel obtains this timeout value from the ServerTemplateMBean.

    This timeout helps guard against denial of service attacks in which a caller indicates that they will be sending a message of a certain size which they never finish sending.

  • Minimum Value: 0
    Maximum Value: 240

    The amount of time that this network channel should wait to establish an outbound socket connection before timing out. A value of disables network channel connect timeout.

  • The source of the identity keystore. For a JKS keystore, the source is the path and file name. For an Oracle Key Store Service (KSS) keystore, the source is the KSS URI.

    If using a JKS keystore, the keystore path name must either be absolute or relative to where the server was booted.

    If using a KSS keystore, the keystore URI must be of the form:

    kss://system/keystorename

    where keystorename is the name of the keystore registered in KSS.

    The value in this attribute is only used if ServerMBean.KeyStores is CUSTOM_IDENTITY_AND_JAVA_STANDARD_TRUST, CUSTOM_IDENTITY_AND_CUSTOM_TRUST or CUSTOM_IDENTITY_AND_COMMAND_LINE_TRUST

  • The encrypted custom identity keystore's passphrase. If empty or null, then the keystore will be opened without a passphrase.

    This attribute is only used if ServerMBean.KeyStores is CUSTOM_IDENTITY_AND_JAVA_STANDARD_TRUST, CUSTOM_IDENTITY_AND_CUSTOM_TRUST or CUSTOM_IDENTITY_AND_COMMAND_LINE_TRUST

    When you get the value of this attribute, WebLogic Server does the following:

    1. Retrieves the value of the CustomIdentityKeyStorePassPhraseEncrypted attribute.

    2. Decrypts the value and returns the unencrypted password as a String.

    When you set the value of this attribute, WebLogic Server does the following:

    1. Encrypts the value.

    2. Sets the value of the CustomIdentityKeyStorePassPhraseEncrypted attribute to the encrypted value.

    Using this attribute (CustomIdentityKeyStorePassPhrase) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.

    Instead of using this attribute, use CustomIdentityKeyStorePassPhraseEncrypted

  • The type of the keystore. Generally, this is JKS. If using the Oracle Key Store Service, this would be KSS

    If empty or null, then the JDK's default keystore type (specified in java.security) is used. The custom identity key store type is only used if ServerMBean.KeyStores is CUSTOM_IDENTITY_AND_JAVA_STANDARD_TRUST, CUSTOM_IDENTITY_AND_CUSTOM_TRUST or CUSTOM_IDENTITY_AND_COMMAND_LINE_TRUST

  • The string alias used to store and retrieve the channel's private key in the keystore. This private key is associated with the server's digital certificate. A value of null indicates that the network channel uses the alias specified in the server's SSL configuration.

  • Default Value: oracle.doceng.json.BetterJsonNull@3f15de1f

    The passphrase used to retrieve the server's private key from the keystore. This passphrase is assigned to the private key when it is generated. A value of null indicates that the network channel uses the pass phrase specified in the server's SSL configuration.

  • Read Only: true
    Default Value: false

    Return whether the MBean was created dynamically or is persisted to config.xml

  • Default Value: true

    Specifies whether this channel should be started.

  • Specifies whether to ignore the installed implementation of the weblogic.security.SSL.HostnameVerifier interface (when this server is acting as a client to another application server).

  • The name of the class that implements the weblogic.security.SSL.HostnameVerifier interface.

    This class verifies whether the connection to the host with the hostname from URL should be allowed. The class is used to prevent man-in-the-middle attacks. The weblogic.security.SSL.HostnameVerifier has a verify() method that WebLogic Server calls on the client during the SSL handshake.

  • Default Value: true

    Specifies whether HTTP traffic should be allowed over this network channel.

    HTTP is generally required by binary protocols for downloading stubs and other resources.

  • Read Only: true

    Return the unique id of this MBean instance

  • Minimum Value: 0

    The maximum amount of time (in seconds) that a connection is allowed to be idle before it is closed by this network channel. A value of -1 indicates that the network channel obtains this timeout value from the ServerTemplateMBean.

    This timeout helps guard against server deadlock through too many open connections.

  • Allowed Values: [ "BuiltinSSLValidationOnly", "BuiltinSSLValidationAndCertPathValidators" ]

    Indicates the client certificate validation rules for inbound SSL.

    This attribute only applies to ports and network channels using 2-way SSL.

  • The IP address or DNS name this network channel uses to listen for incoming connections. A value of null indicates that the network channel should obtain this value from the server's configuration.

  • The default TCP port this network channel uses to listen for regular (non-SSL) incoming connections. A value of -1 indicates that the network channel should obtain this value from the server's configuration.

  • Minimum Value: 0
    Maximum Value: 100000

    The amount of time that this network channel should wait for a connection before timing out. A value of disables network channel login timeout. A value of -1 indicates that the network channel obtains this timeout value from the server's configuration.

  • Minimum Value: 0

    The maximum back off time between failures while accepting client connections. -1 implies that this value is inherited from the server.

  • Default Value: 2147483647

    The maximum number of clients that can be connected on this network channel.

  • Minimum Value: 4096
    Maximum Value: 100000000

    The maximum message size allowable in a message header.

    This maximum attempts to prevent a denial of service attack whereby a caller attempts to force the server to allocate more memory than is available thereby keeping the server from responding quickly to other requests.

    A client can set this value using the -Dweblogic.MaxMessageSize property.

  • Get the minimum SSL/TLS protocol version to be used in a network channel.

  • Read Only: true
    Default Value: <unknown>

    The name of this network channel.

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

  • Allowed Values: [ "BuiltinSSLValidationOnly", "BuiltinSSLValidationAndCertPathValidators" ]

    Indicates the server certificate validation rules for outbound SSL.

    This attribute always applies to outbound SSL that is part of WebLogic Server (that is, an Administration Server talking to the Node Manager). It does not apply to application code in the server that is using outbound SSL unless the application code uses a weblogic.security.SSL.ServerTrustManager that is configured to use outbound SSL validation.

  • Specifies whether new server-to-server connections may consider this network channel when initiating a connection. This is only relevant if the connection needs to be bound to the network channel's listen address. This will only work for binary protocols that support both outbound and inbound traffic.

    When this feature is not enabled, connections are initiated using a local address selected by the underlying hardware.

    The default is false.

    Outbound channels are selected at runtime either by virtue of the fact of being the only outbound-enabled channel for the required protocol, or by name in weblogic.jndi.Environment#setProviderChannel

    The HTTP protocol is implicitly enabled for all the outbound channels, but you need to use the WLS client library (HTTP client) and set the channel on the connection.

  • Read Only: true
    Default Value: oracle.doceng.json.BetterJsonNull@6402e58d

    The string alias used to store and retrieve the outbound private key in the keystore. This private key is associated with either a server or a client digital certificate. This attribute value is derived from other settings and cannot be physically set.

    The returned value is determined as follows:

    • If isOutboundPrivateKeyEnabled and isChannelIdentityCustomized return true, the value from getCustomPrivateKeyAlias is returned.

    • Otherwise, the value from SSLMBean#getOutboundPrivateKeyAlias is returned from the ServerMBean for the channel.

  • Specifies whether the identity specified by getCustomPrivateKeyAlias should be used for outbound SSL connections on this channel. In normal circumstances the outbound identity is determined by the caller's environment.

    Constraints

    • secure default : false
  • Read Only: true
    Default Value: oracle.doceng.json.BetterJsonNull@397a015e

    The passphrase used to retrieve the outbound private key from the keystore. This passphrase is assigned to the private key when it is generated. This attribute value is derived from other settings and cannot be physically set.

    The returned value is determined as follows:

    • If isOutboundPrivateKeyEnabled and isChannelIdentityCustomized return true, the value from getCustomPrivateKeyPassPhrase is returned.

    • Otherwise, the value from SSLMBean#getOutboundPrivateKeyPassPhrase is returned from the ServerMBean for the channel.

  • Read Only: true

    The string alias used to store and retrieve the channel's private key in the keystore. This private key is associated with the server's digital certificate. This value is derived from other settings on the channel and cannot be physically set.

  • Read Only: true

    The passphrase used to retrieve the server's private key from the keystore. This passphrase is assigned to the private key when it is generated. This value is derived from other settings on the channel and cannot be physically set.

  • Default Value: t3

    The protocol this network channel should use for connections.

    Constraints

    • secure default : "t3s"
  • Default Value: oracle.doceng.json.BetterJsonNull@e825a67

    The IP address or DNS name of the HTTP proxy to use for outbound connections on this channel. The HTTP proxy must support the CONNECT tunneling command.

    This option is only effective when OutboundEnabled is set on the channel.

  • Default Value: 80

    The port of the HTTP proxy to use for outbound connections on this channel. The HTTP proxy must support the CONNECT tunneling command.

    This option is only effective when OutboundEnabled and ProxyHost are set on the channel.

  • The IP address or DNS name representing the external identity of this network channel. A value of null indicates that the network channel's Listen Address is also its external address. If the Listen Address is null,the network channel obtains its external identity from the server's configuration.

    This is required for the configurations which need to cross a firewall doing Network Address Translation.

  • The externally published listen port for this network channel. A value of -1 indicates that the network channel's Listen Port is also its public listen port. If the Listen Port is -1,the network channel obtains its public listen port from the server's configuration.

  • Default Value: false

    Resolve the listen address to use for all T3 communication

  • Default Value: false

    Enables Socket Direct Protocol (SDP) on this channel. Enable this attribute when configuring session replication enhancements for Managed Servers in a WebLogic cluster for Oracle Exalogic.

  • Indicate whether SSLv2Hello is enabled in a network channel.

  • Items
    Title: Items

    Return all tags on this Configuration MBean

  • Default Value: false

    Determines if connections with pending responses are allowed to timeout. It defaults to false. If set to true, the connection will be timed out for this channel if it exceeds the idleConnectionTimeout value.

    Note: This setting only applies to IIOP connections.

  • Minimum Value: 1

    The interval (in seconds) at which this network channel should ping an HTTP-tunneled client to see if its still alive. A value of -1 indicates that the network channel obtains this interval from the ServerTemplateMBean. (Requires you to enable tunneling for the network channel.)

  • Minimum Value: 1

    The amount of time (in seconds) after which this network channel considers a missing HTTP-tunneled client to be dead. A value of -1 indicates that the network channel obtains this timeout value from the ServerTemplateMBean. (Requires you to enable tunneling for the network channel.)

  • Default Value: false

    Specifies whether tunneling via HTTP should be enabled for this network channel. This value is not inherited from the server's configuration.

  • Default Value: false

    Specifies whether this network channel uses two way SSL.

    Constraints

    • doc only secure default : true
  • Read Only: true

    Returns the type of the MBean.

    Constraints

    • unharvestable

  • Specifies whether to use non-standard object serialization for performance. This option works in different ways for different protocols. In particular under IIOP this option uses Java serialization rather than RMI-IIOP serialization. In general using non-standard serialization is not suitable for interop scenarios and may imply some feature loss.

Nested Schema : Items
Type: array
Title: Items

Indicates the cipher suites being used on a particular WebLogic Server channel.

The strongest negotiated cipher suite is chosen during the SSL handshake. The set of cipher suites used by default by JSEE depends on the specific JDK version with which WebLogic Server is configured.

For a list of possible values, see Cipher Suites

Show Source
Nested Schema : Items
Type: array
Title: Items

Return all tags on this Configuration MBean

Show Source
Back to Top