View This Network Access Point Collection
/management/weblogic/{version}/serverConfig/serverTemplates/{name}/networkAccessPoints
View this network access point collection.
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 a list of network access point entities.
object
-
acceptBacklog(optional):
integer(int32)
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. -
allowUnencryptedNullCipher(optional):
boolean
Test if the AllowUnEncryptedNullCipher is enabled
see
setAllowUnencryptedNullCipher(boolean enable)
for the NullCipher feature. -
channelIdentityCustomized(optional):
boolean
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.
-
channelWeight(optional):
integer(int32)
Minimum Value:
1
Maximum Value:100
Default Value:50
A weight to give this channel when creating server-to-server connections.
-
ciphersuites(optional):
array 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
-
clientCertificateEnforced(optional):
boolean
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
-
clientInitSecureRenegotiationAccepted(optional):
boolean
Default Value:
false
Indicate whether TLS client initiated secure renegotiation is accepted.
-
clusterAddress(optional):
string
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:
If the cluster address is specified via the NAPMBean, then that value is used
If this value is not specified, the value of PublicAddress is used.
If PublicAddress is not set, this value is derive from the ClusterAddress attribute of the ClusterMbean.
If ClusterMbean.clusterAddress is not set, this value is derive from the listen address of the NAPMbean.
-
completeMessageTimeout(optional):
integer(int32)
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.
-
connectTimeout(optional):
integer(int32)
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.
-
customIdentityKeyStoreFileName(optional):
string
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
isCUSTOM_IDENTITY_AND_JAVA_STANDARD_TRUST
,CUSTOM_IDENTITY_AND_CUSTOM_TRUST
orCUSTOM_IDENTITY_AND_COMMAND_LINE_TRUST
-
customIdentityKeyStorePassPhrase(optional):
string(password)
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
isCUSTOM_IDENTITY_AND_JAVA_STANDARD_TRUST
,CUSTOM_IDENTITY_AND_CUSTOM_TRUST
orCUSTOM_IDENTITY_AND_COMMAND_LINE_TRUST
When you get the value of this attribute, WebLogic Server does the following:
Retrieves the value of the
CustomIdentityKeyStorePassPhraseEncrypted
attribute.Decrypts the value and returns the unencrypted password as a String.
When you set the value of this attribute, WebLogic Server does the following:
Encrypts the value.
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
-
customIdentityKeyStoreType(optional):
string
The type of the keystore. Generally, this is
JKS
. If using the Oracle Key Store Service, this would beKSS
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 ifServerMBean.KeyStores
isCUSTOM_IDENTITY_AND_JAVA_STANDARD_TRUST
,CUSTOM_IDENTITY_AND_CUSTOM_TRUST
orCUSTOM_IDENTITY_AND_COMMAND_LINE_TRUST
-
customPrivateKeyAlias(optional):
string
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. -
customPrivateKeyPassPhrase(optional):
string(password)
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. -
dynamicallyCreated(optional):
boolean
Read Only:
true
Default Value:false
Return whether the MBean was created dynamically or is persisted to config.xml
-
enabled(optional):
boolean
Default Value:
true
Specifies whether this channel should be started.
-
hostnameVerificationIgnored(optional):
boolean
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). -
hostnameVerifier(optional):
string
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 averify()
method that WebLogic Server calls on the client during the SSL handshake. -
httpEnabledForThisProtocol(optional):
boolean
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.
-
id(optional):
integer(int64)
Read Only:
true
Return the unique id of this MBean instance
-
idleConnectionTimeout(optional):
integer(int32)
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.
-
inboundCertificateValidation(optional):
string
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.
-
listenAddress(optional):
string
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. -
listenPort(optional):
integer(int32)
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. -
loginTimeoutMillis(optional):
integer(int32)
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. -
maxBackoffBetweenFailures(optional):
integer(int32)
Minimum Value:
0
The maximum back off time between failures while accepting client connections. -1 implies that this value is inherited from the server.
-
maxConnectedClients(optional):
integer(int32)
Default Value:
2147483647
The maximum number of clients that can be connected on this network channel.
-
maxMessageSize(optional):
integer(int32)
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. -
minimumTLSProtocolVersion(optional):
string
Get the minimum SSL/TLS protocol version to be used in a network channel.
-
name(optional):
string
Read Only:
true
Default Value:<unknown>
The name of this network channel.
-
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.
-
outboundCertificateValidation(optional):
string
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. -
outboundEnabled(optional):
boolean
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.
-
outboundPrivateKeyAlias(optional):
string
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
andisChannelIdentityCustomized
return true, the value fromgetCustomPrivateKeyAlias
is returned.Otherwise, the value from
SSLMBean#getOutboundPrivateKeyAlias
is returned from theServerMBean
for the channel.
-
outboundPrivateKeyEnabled(optional):
boolean
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
-
outboundPrivateKeyPassPhrase(optional):
string
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
andisChannelIdentityCustomized
return true, the value fromgetCustomPrivateKeyPassPhrase
is returned.Otherwise, the value from
SSLMBean#getOutboundPrivateKeyPassPhrase
is returned from theServerMBean
for the channel.
-
privateKeyAlias(optional):
string
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.
-
privateKeyPassPhrase(optional):
string
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.
-
protocol(optional):
string
Default Value:
t3
The protocol this network channel should use for connections.
Constraints
- secure default : "t3s"
-
proxyAddress(optional):
string
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.
-
proxyPort(optional):
integer(int32)
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.
-
publicAddress(optional):
string
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 isnull,
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.
-
publicPort(optional):
integer(int32)
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. -
resolveDNSName(optional):
boolean
Default Value:
false
Resolve the listen address to use for all T3 communication
-
SDPEnabled(optional):
boolean
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.
-
SSLv2HelloEnabled(optional):
boolean
Indicate whether SSLv2Hello is enabled in a network channel.
-
tags(optional):
array Items
Title:
Items
Return all tags on this Configuration MBean
-
timeoutConnectionWithPendingResponses(optional):
boolean
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.
-
tunnelingClientPingSecs(optional):
integer(int32)
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.) -
tunnelingClientTimeoutSecs(optional):
integer(int32)
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.) -
tunnelingEnabled(optional):
boolean
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.
-
twoWaySSLEnabled(optional):
boolean
Default Value:
false
Specifies whether this network channel uses two way SSL.
Constraints
- doc only secure default : true
-
type(optional):
string
Read Only:
true
Returns the type of the MBean.
Constraints
- unharvestable
-
useFastSerialization(optional):
boolean
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.
array
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