1. RESTful Edit Management Interface for Oracle WebLogic Server
  2. Tasks
  3. Server

View This Server Collection

get

/management/weblogic/{version}/edit/servers

View this server collection.

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 a list of server entities.

This method can return the following links:

  • rel=create-form uri=/management/weblogic/{version}/edit/serverCreateForm

    The create form resource for this collection resource.

Body ()
Root Schema : Items
Type: array
Title: Items
Show Source
Nested Schema : Server
Type: object
Show Source
  • Minimum Value: 0
    Default Value: 300

    The number of backlogged, new TCP connection requests that should be allowed for this server's regular and SSL ports.

    Setting the backlog to may prevent this server from accepting any incoming connection on some operating systems.

  • Enables increased efficiency of the self-tuning thread pool by aligning it with the Exalogic processor architecture threading capabilities. Use only when configuring a WebLogic domain for Oracle Exalogic.

    • Enabling this attribute increases efficiency during I/O in environments with high network throughput.

    • Disabling this attribute allows the thread pool to self-tune to match the demand of the workload at the expense of longer ramp up time.

  • Minimum Value: 0
    Maximum Value: 65535

    The secure administration port for the server. This port requires that you enable the domain's administration port and that SSL is configured and enabled.

    By default, the server uses the administration port that is specified at the domain level. To override the domain-level administration port for the current server instance, set this server's administration port.

    Constraints

    • doc only secure default : 7002
  • Allowed Values: [ "t3s", "https", "iiops", "t3", "http", "iiop" ]

    Returns the protocol to be used for administrative connections when none is specified.

  • Minimum Value: 0
    Maximum Value: 2147483647
    Default Value: 10

    The number of seconds between reconnection attempts to the admin server. When the admin server fails the managed server will periodically try to connect back to it.

  • Default Value: true

    Specifies whether self-tuning should allow shrinking of its priority based queue for pending requests after it has grown in size due to busy workload, and whether it should try to purge work requests that have already been picked up for processing due to minimum threads constraints before growing the queue. Setting this to true would help reduce memory footprint after the busy work period has ended, at the expense of the overhead of growing the request queue again at the next period of busy workload. It would also help to reduce the amount of memory allocated for the request queue, at the expense of the overhead required in purging already processed work requests from the queue.

  • Specifies whether Node Manager can automatically restart this server and its services on another machine if the server fails.

  • Default Value: true

    Specifies whether the Node Manager can automatically restart this server if it crashes or otherwise goes down unexpectedly.

  • Buzz endpoint address.

  • Default Value: false

    Enables Buzz for sending/receiving messages with peers. Enabling this attribute increases efficiency during I/O in environments with high network throughput and should be used only when configuring a WebLogic domain for Oracle Exalogic.

  • Default Value: 0

    Buzz endpoint port.

    A value of means system-allocated (dynamic) port.

  • Machine References
    Title: Machine References
    Contains the array of machine references.

    Limits the list of candidate machines that the cluster specifies. (Requires you to enable this server for automatic migration and to configure the cluster with a set of candidate machines.)

    If this server fails and if it is enabled for automatic migration, Node Manager automatically restarts it. By default, Node Manager restarts the server on any of the candidate machines that the cluster specifies (in order of preference that you configured in the cluster). To change the default, you use this server's list of candidate machines to create a subset of the cluster-wide candidates. You can also change the order of preference.

    Constraints

    • restart required
  • Default Value: false

    The ClasspathServlet will serve any class file in the classpath and is registered by default in every Web application (including management). It does not need to be turned on for many applications though, and represents a security hole if unchecked.

    WLS components such as JDBC and JMS rely on the ClasspathServlet. If the servlet can not be disabled, then set the ClassPathServletSecureModeEnabled to true.

    Constraints

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

    If secure mode is enabled, the ClasspathServlet will serve only class files from wellknown packages required for JDBC and JMS functionality. If secure mode is disabled, it represents a security hole if unchecked as the ClassPatchServlet will serve any class in the classpath and is registered by default in every Web application (including management).

    If set to true, the ClasspathServlet will not be disabled by the DefaultInternalServletsDisabled value of true.

    Constraints

    • secure default : true
  • Default Value: false

    Indicates if replication service should cleanup orphaned http and ejb sessions. Orphaned sessions are http and ejb session instances that are not referenced by the replication service.

  • Default Value: false

    Specifies whether the HttpClusterServlet proxies the client certificate in a special header.

    By default (or if you specify false), the weblogic.xml deployment descriptor for each web application that is deployed on this server determines whether the web application trusts certificates sent from the proxy server plugin. By default (or if the deployment descriptor specifies false), users cannot log in to the web application from a proxy server plugin.

    A value of true causes proxy-server plugins to pass identity certifications from clients to all web applications that are deployed on this server instance. A proxy-server plugin encodes each identify certification in the WL-Proxy-Client-Cert header and passes the header to WebLogic Server instances. A WebLogic Server instance takes the certificate information from the header, trusting that it came from a secure source, and uses that information to authenticate the user.

    If you specify true, use a weblogic.security.net.ConnectionFilter to ensure that this WebLogic Server instance accepts connections only from the machine on which the proxy-server plugin is running. Specifying true without using a connection filter creates a security vulnerability because the WL-Proxy-Client-Cert header can be spoofed.

    A cluster can also specify whether the HttpClusterServlet proxies the client certificate in a special header. The cluster-level setting overrides the setting in individual servers that are part of the cluster.

    Constraints

    • secure default : false
  • Cluster Reference
    Title: Cluster Reference
    Contains the cluster reference.

    The cluster, or group of WebLogic Server instances, to which this server belongs.

    If set, the server will listen for cluster multicast events.

    Constraints

    • restart required
  • Minimum Value: 1
    Maximum Value: 100
    Default Value: 100

    The proportion of the load that this server will bear, relative to other servers in a cluster.

    If all servers have the default weight or the same weight, each bears an equal proportion of the load. If one server has weight 50 and all other servers have weight 100, the 50-weight server will bear half as much load as any other server.

  • Coherence Cluster System Resource Reference
    Title: Coherence Cluster System Resource Reference
    Contains the coherence cluster system resource reference.

    The system-level Coherence cluster resource associated with this server.

    Constraints

    • restart required
  • Minimum Value: 0
    Maximum Value: 480
    Default Value: 60

    The maximum number of seconds that this server waits for a complete message to be received. If you configure network channels for this server, each channel can override this message timeout.

    This timeout helps guard against a denial of service attack in which a caller indicates that it will be sending a message of a certain size which it never finishes sending.

    CompleteMessageTimeout affects the HTTP Response, such that if WebLogic Server discovers sockets inactive for longer than the CompleteMessageTimeout, the server will close these sockets.

  • Minimum Value: 0

    The maximum number of seconds that this server waits for a complete HTTP response to be sent.

    A value of disables the complete write timeout. The default value is derived from the CompleteHTTPMessageTimeout. If it is -1, then the CompleteMessageTimeout value is used for the default value.

  • Minimum Value: 0
    Maximum Value: 240
    Default Value: 0

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

  • Default Value: oracle.doceng.json.BetterJsonNull@52eb12e2

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

  • Default Value: oracle.doceng.json.BetterJsonNull@601a6f96

    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 KeyStores is CUSTOM_IDENTITY_AND_JAVA_STANDARD_TRUST, CUSTOM_IDENTITY_AND_CUSTOM_TRUST or CUSTOM_IDENTITY_AND_COMMAND_LINE_TRUST

  • Default Value: oracle.doceng.json.BetterJsonNull@888f8ef

    The source of the custom trust 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 KeyStores is CUSTOM_IDENTITY_AND_CUSTOM_TRUST

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

    This attribute is only used if KeyStores is CUSTOM_IDENTITY_AND_CUSTOM_TRUST.

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

    1. Retrieves the value of the CustomTrustKeyStorePassPhraseEncrypted 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 CustomTrustKeyStorePassPhraseEncrypted attribute to the encrypted value.

    Using this attribute (CustomTrustKeyStorePassPhrase) 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 CustomTrustKeyStorePassPhraseEncrypted

  • Default Value: oracle.doceng.json.BetterJsonNull@39baec68

    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. This keystore type is only used if KeyStores is CUSTOM_IDENTITY_AND_CUSTOM_TRUST.

  • Default Value: oracle.doceng.json.BetterJsonNull@17466a28

    The password for the default IIOP user. (Requires you to enable IIOP.)

    As of 8.1 sp4, when you get the value of this attribute, WebLogic Server does the following:

    1. Retrieves the value of the DefaultIIOPPasswordEncrypted attribute.

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

    Using this attribute (DefaultIIOPPassword) 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 DefaultIIOPPasswordEncrypted

  • Default Value: oracle.doceng.json.BetterJsonNull@f6702bb

    The user name of the default IIOP user. (Requires you to enable IIOP.)

  • Default Value: false

    Specifies whether all default servlets in the servlet engine are disabled.

    This includes: weblogic.servlet.ClasspathServlet weblogic.servlet.utils.iiop.GetIORServlet weblogic.rjvm.http.TunnelSendServlet weblogic.rjvm.http.TunnelRecvServlet weblogic.rjvm.http.TunnelLoginServlet weblogic.rjvm.http.TunnelCloseServlet If set to true, this property overrides the ClasspathServletDisabled property.

    Constraints

    • secure default : true
  • Default Value: t3
    Allowed Values: [ "t3", "t3s", "http", "https", "iiop", "iiops" ]

    The protocol to use for connections when none is specified.

  • Default Value: t3s
    Allowed Values: [ "t3s", "https", "iiops" ]

    The protocol to use for secure connections when none is specified.

  • The password for the default user associated with the Tuxedo GIOP (TGIOP) protocol. (Requires you to configure WebLogic Tuxedo Connector (WTC) for this server.)

    As of 8.1 sp4, when you get the value of this attribute, WebLogic Server does the following:

    1. Retrieves the value of the DefaultTGIOPPasswordEncrypted 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 DefaultTGIOPPasswordEncrypted attribute to the encrypted value.

    Using this attribute (DefaultTGIOPPassword) is a potential security risk in because the String object (which contains the unencrypted password) remains 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 DefaultTGIOPPasswordEncrypted

  • Default Value: 5

    The number of idle periods allowed before the object is collected.

  • Read Only: true
    Default Value: false

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

  • Default Value: false

    Specifies whether to clean up all ThreadLocals storage from self-tuning thread pool threads after they have finished processing each work request. By default, the self-tuning thread pool only cleans up ThreadLocal storage in its threads after an application is undeployed to avoid ClassLoader memory leak.

  • Default Value: oracle.doceng.json.BetterJsonNull@6588663e

    The external IP address or DNS name for this server.

    This address will be sent with HTTP session cookies and with dynamic server lists to HTTP proxies. It will also be used by external application clients to enable the propagation of RMI traffic through network address translating (NAT) firewalls.

    You must specify an external DNS name for configurations in which a firewall is performing network address translation, unless clients are accessing WebLogic Server using t3 and the default channel. For example, define the external DNS name for configurations in which a firewall is performing network address translation, and clients are accessing WebLogic Server using HTTP via a proxy plug-in.

  • Default Value: oracle.doceng.json.BetterJsonNull@1d99962

    The options passed to the EJB compiler during server-side generation.

    Each EJB component can override the compiler options that you specify here. The following options are valid:

    -forcegeneration

    Forces generation of wrapper classes. Without this flag the classes may not be regenerated if it is determined to be unnecessary.

    -disableHotCodeGen

    Generate ejb stub and skel as part of ejbc. Avoid HotCodeGen to have better performance.

    -keepgenerated

    Keep the generated .java files.

    -compiler javac

    Java compiler to exec. If not specified, the -compilerclass option will be used.

    -compilerclass com.sun.tools.javac.Main

    Specifies the compiler class to invoke.

    -g

    Compile debugging info into class file.

    -normi

    Passed through to Symantec's sj.

    -classpath path

    Classpath to use.

    -source source

    Source version.

    -Joption

    Flags passed through to java runtime.

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

    The options passed to the RMIC compiler during server-side generation.

    Each EJB component can override the compiler options that you specify here.

  • Default Value: false

    Enables gathered writes over NIO socket channels. Enabling this attribute increases efficiency during I/O in environments with high network throughput and should be used only when configuring a WebLogic domain for Oracle Exalogic.

  • Minimum Value: 0
    Default Value: 0

    Number of seconds a graceful shutdown operation waits before forcing a shut down. A graceful shutdown gives WebLogic Server subsystems time to complete certain application processing currently in progress. If subsystems are unable to complete processing within the number of seconds that you specify here, then the server will force shutdown automatically.

    A value of means that the server will wait indefinitely for graceful shutdown to complete.

    The graceful shutdown timeout applies only to graceful shutdown operations.

  • Minimum Value: 1
    Maximum Value: 2147483647
    Default Value: 180

    The number of seconds that defines the frequency of this server's self-health monitoring. The server monitors the health of it's subsystems every HealthCheckIntervalSeconds and changes the Server's overall state if required.

  • Minimum Value: 0
    Maximum Value: 2147483647
    Default Value: 120

    The number of seconds the Node Manager should wait before starting to monitor the server.

  • Read Only: true
    Default Value: true

    Gets the hostsMigratableServices attribute of the ServerMBean object

  • Default Value: true

    Whether or not HTTP support is enabled on the regular port or SSL port.

  • Default Value: false

    Returns the HttpTraceSupportEnabled value

  • Read Only: true

    Return the unique id of this MBean instance

  • Minimum Value: 0
    Default Value: 65

    The maximum number of seconds that a connection is allowed to be idle before it is closed by the server. The T3 and T3S protocols ignore this attribute. If you configure network channels for this server, each channel can override this idle connection message timeout.

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

    Constraints

    • secure default : 65
  • Minimum Value: 4
    Maximum Value: 65534
    Default Value: 4

    The number of idle periods until peer is considered unreachable.

  • Default Value: false

    Indicates whether a graceful shutdown operation drops all HTTP sessions immediately.

    If this is set to false, a graceful shutdown operation waits for HTTP sessions to complete or timeout.

  • Default Value: true

    Specifies whether this server has IIOP support enabled for both the regular (non-SSL) and SSL ports.

  • Default Value: true

    Specifies whether the server returns stack traces for RMI calls that generate exceptions.

    With RMI stack tracking enabled, if a client issues an RMI call to a server subsystem or to a module running within the server, and if the subsystem or module generates an exception that includes a stack trace, the server will return the exception as well as the stack trace. With it disabled, the server will return the exception without the stack trace details.

    Constraints

    • secure default : false

  • The IP address of the NIC that this server should use for multicast traffic.

  • Default Value: false

    Specified whether the server needs to ensure that threadlocals storage from self-tuning thread pool threads must be cleaned up before the threads are used for processing work requests from a different partition. This helps ensure that no threadlocals from a different partition can be retrieved from work requests while being processed by a self-tuning thread pool thread. The different between this attribute and the eagerThreadLocalCleanup attribute is that threadlocals storage will not be cleared if the previous work request processed by the self-tuning thread pool thread was for the same partition, whereas with eagerThreadLocalCleanup set, the threadlocals storage will also be cleared in this case.

  • Default Value: javac

    The Java compiler to use for all applications hosted on this server that need to compile Java code.

    Constraints

    • secure default : "javac"
  • Default Value: oracle.doceng.json.BetterJsonNull@4b2d2bbf

    The options to append to the Java compiler classpath when compiling Java code.

    Constraints

    • secure default : null
  • Default Value: oracle.doceng.json.BetterJsonNull@50125cc4

    The options to prepend to the Java compiler classpath when compiling Java code.

    Constraints

    • secure default : null

  • The password for the Java Standard Trust keystore. This password is defined when the keystore is created.

    If empty or null, then the keystore will be opened without a passphrase.

    This attribute is only used if KeyStores is CUSTOM_IDENTITY_AND_JAVA_STANDARD_TRUST or DEMO_IDENTITY_AND_DEMO_TRUST.

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

    1. Retrieves the value of the JavaStandardTrustKeyStorePassPhraseEncrypted 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 JavaStandardTrustKeyStorePassPhraseEncrypted attribute to the encrypted value.

    Using this attribute (JavaStandardTrustKeyStorePassPhrase) 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 JavaStandardTrustKeyStorePassPhraseEncrypted

  • The table name for this server's Logging Last Resource (LLR) database table(s). WebLogic Server creates the table(s) and then uses them during transaction processing for the LLR transaction optimization. This setting must be unique for each server. The default table name is WL_LLR_SERVERNAME

    This setting only applies if this server hosts one or more LLR-enabled JDBC data sources.

    The format for the tables that WebLogic Server creates is [[[catalog.]schema.]name.] Each "." in the table name is significant, and schema generally corresponds to username in many databases.

    IMPORTANT: If this value is changed but the LLR table already exists in the database, you must preserve the existing table's data. Consequently, when changing the table name, the existing database table must be renamed by a database administrator to match the new configured table name. Otherwise, transaction records may be lost, resulting in heuristic failures that aren't logged.

    IMPORTANT: Each server's table name must be unique. Multiple LLR-enabled data sources within the same server may share the same table, but multiple servers must not share the same table. If multiple same-named servers share a table, the behavior is undefined and it is likely that transactions will not recover properly after a crash, creating heuristic hazards.

  • Minimum Value: 0
    Maximum Value: 300
    Default Value: 0

    The JDBC Login Timeout value. Specified value is passed into java.sql.DriverManager.setLoginTimeout(). Note that this DriverManager setting will impact *all* JDBC drivers loaded into this JVM. Feature is disabled by default.

  • Default Value: ReturnDefault
    Allowed Values: [ "ReturnDefault", "FailSafe" ]

    Use this unmapped resource reference mode to specify the behavior of any resource reference to a Connection Factory when the resource reference does not directly specify a JNDI name by a lookup attribute, or by a mappedName attribute, or by a jndi-name in a descriptor file. If a JNDI name is specified, the resource reference either resolves to the specified object in the JNDI tree or generates a javax.naming.NameNotFoundException.

    Following are the available unmapped resource reference modes:

    • FailSafe : In this mode, an application JMS connection factory resource reference that does not specify a JNDI name resolves to an object bound to the JNDI tree with the same name as the resource reference name if one can be found in JNDI tree. Otherwise, it throws a javax.naming.NameNotFoundException. A resource reference without a JNDI name never returns a Java EE 7 Default Connection Factory in this mode.

      This mode yields pre-12.2.1 WebLogic Server behavior. This mode is Java EE compliant, but the Java EE 7 specification disallows it from being the default mode.

    • ReturnDefault : This policy is a Java EE compliant mode and it is the default mode. It complies with Java EE 7 while doing a best effort to try delivering FailSafe behavior when it is expected.

      (a) If the resource reference name matches the local JNDI name of a configured foreign JMS provider mapping, then WebLogic Server returns the remote JNDI entry from the mapping if it can be resolved, or it throws a javax.naming.NameNotFoundException.

      (b) If the resource reference does not match with a foreign JMS provider mapping, and if the resource reference name matches the name of an object that is already bound to the JNDI tree, WebLogic Server returns the JNDI tree object.

      (c) If neither (a) nor (b) apply, then WebLogic Server returns "java:comp/DefaultJMSConnectionFactory". In addition, it adds an 'Info' message in the server log indicating that a special behavior has occurred. This log message will occur at most once per application per server boot.

  • Default Value: true

    Specifies whether this server uses JMS default connection factories.

    WebLogic Server provides the following JMS default connection factories:

    • weblogic.jms.ConnectionFactory

    • weblogic.jms.XAConnectionFactory An XA factory is required for JMS applications to use JTA user-transactions, but is not required for transacted sessions. All other preconfigured attributes for the default connection factories are set to the same default values as a user-defined connection factory. If the preconfigured settings of the default factories are appropriate for your application, you do not need to configure any additional factories for your application.

    Note: When using the default connection factories, you have no control over targeting the WebLogic Server instances where the connection factory may be deployed. However, you can disable the default connection factories on a per-server basis. To deploy a connection factory on independent servers, on specific servers within a cluster, or on an entire cluster, you need to configure a connection factory and specify the appropriate server targets. The default Java EE 7 JMS Connection Factory, java:comp/DefaultJMSConnectionFactory, will be available even when the WebLogic JMS default connection factories are disabled.

  • Items
    Title: Items

    List of factories that create transportable objects.

  • Default Value: DemoIdentityAndDemoTrust
    Allowed Values: [ "DemoIdentityAndDemoTrust", "CustomIdentityAndJavaStandardTrust", "CustomIdentityAndCustomTrust", "CustomIdentityAndCommandLineTrust" ]

    Which configuration rules should be used for finding the server's identity and trust keystores?

  • The IP address or DNS name this server uses to listen for incoming connections. For example, enter 12.34.5.67 or mymachine, respectively.

    Note that the value you specify for the listen address is not the URL to the host machine and it does not include the communication protocol, listen port, or channel.

    Servers can be reached through the following URL:

    protocol://listen-address:listen-port

    Any network channel that you configure for this server can override this listen address.

    If a server's listen address is undefined, clients can reach the server through an IP address of the computer that hosts the server, a DNS name that resolves to the host, or the localhost string. The localhost string can be used only for requests from clients that are running on the same computer as the server.

    If you want to limit the valid addresses for a server instance, specify one of the following:

    • IP address. If you provide an IP address, clients can specify either the IP address or a DNS name that maps to the IP address. Clients that specify an IP address and attempt to connect through an SSL port must disable hostname verification.

    • DNS name. If you provide a DNS name, clients can specify either the DNS name or the corresponding IP address.

    Do not leave the listen address undefined on a computer that uses multiple IP address (a multihomed computer). On such a computer, the server will bind to all available IP addresses.

    Note also that if you are using the demo certificates in a multi-server domain, Managed Server instances will fail to boot if you specify the fully-qualified DNS name. For information about this limitation and suggested workarounds, see "Limitation on CertGen Usage" in Administering Security for Oracle WebLogic Server

  • Default Value: false

    Determines whether the server should bind server sockets early.

    Early binding detects port conflicts quickly and also gives user feedback on the default listen port as to the server state.

    Constraints

    • secure default : false
  • Minimum Value: 1
    Maximum Value: 65535
    Default Value: 7001

    The default TCP port that this server uses to listen for regular (non-SSL) incoming connections.

    Administrators must have the right privileges before binding to a port or else this operation will not be successful and it will render the console un-reachable.

    If this port is disabled, the SSL port must be enabled. Additional ports can be configured using network channels. The cluster (multicast) port is configured separately.

  • Default Value: true

    Specifies whether this server can be reached through the default plain-text (non-SSL) listen port.

    If you disable this listen port, you must enable the default SSL listen port.

    You can define additional listen ports for this server by configuring network channels.

    Constraints

    • secure default : false
  • Default Value: 60

    Returns the maximum time that the server will wait for server sockets to bind before starting a listen thread.

    Properties to consider for removal

  • Minimum Value: 0
    Maximum Value: 100000
    Default Value: 5000

    The login timeout for this server's default regular (non-SSL) listen port. This is the maximum amount of time allowed for a new connection to establish.

    A value of indicates there is no maximum.

    Constraints

    • secure default : 5000
  • Default Value: false

    Specifies whether the server message log includes exceptions that are raised in remote systems.

    Constraints

    • secure default : true
  • Machine Reference
    Title: Machine Reference
    Contains the machine reference.

    The WebLogic Server host computer (machine) on which this server is meant to run.

    If you want to use Node Manager to start this server, you must assign the server to a machine and you must configure the machine for Node Manager.

    You cannot change this value if a server instance is already running.

    Constraints

    • restart required
  • Default Value: true

    Specifies whether this Managed Server can be started when the Administration Server is unavailable.

    In such a case, the Managed Server retrieves its configuration by reading a configuration file and other files directly.

    Constraints

    • secure default : true
  • Minimum Value: 0
    Maximum Value: 65534
    Default Value: 100

    The maximum number of running long-running requests that can be submitted to all the Managed Executor Services or Managed Scheduled Executor Services in the server.

  • Minimum Value: 0
    Maximum Value: 65534
    Default Value: 100

    The maximum number of running threads that can be created by all the Managed Thread Factories in the server.

  • Minimum Value: 4096
    Maximum Value: 2000000000
    Default Value: 10000000

    The maximum number of bytes allowed in messages that are received over all supported protocols, unless overridden by a protocol-specific setting or a custom channel setting.

    The order of precedence for setting message size maximums is as follows:

    1. A channel-wide maximum in a custom network channel.

    2. A protocol-specific setting in the default network channel.

      See

      • getMaxCOMMessageSize() getMaxCOMMessageSize

      • getMaxHTTPMessageSize() getMaxHTTPMessageSize

      • getMaxIIOPMessageSize() getMaxIIOPessageSize

      • getMaxT3MessageSize() getMaxT3MessageSize

    3. The message maximum in this attribute.

    This maximum message size helps guard against a denial of service attack in which 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.

    Constraints

    • secure default : 10000000
  • Minimum Value: -1
    Maximum Value: 2147483647
    Default Value: -1

    The maximum number of open sockets allowed in server at a given point of time.

    When the maximum threshold is reached, the server stops accepting new requests until the number of sockets drops below the threshold.

    A value less than indicates an unlimited size.

  • Default Value: true

    Indicates whether message IDs in logged messages will include a prefix. Message ids are 6 digit numeric strings that can be optionally presented in a log entry with a prefix. The prefix used by server messages is "BEA-".

  • Non-blocking IO is enabled by default on the server side.

    The default value is weblogic.socket.NIOSocketMuxer.

    The Certicom SSL implementation is not supported with NIOSocketMuxer. If you need to secure internet communication, Oracle recommends enabling JSSE (Java Secure Socket Extension).

  • Read Only: true

    An alphanumeric name for this server instance. (Spaces are not valid.)

    The name must be unique for all configuration objects in the domain. Within a domain, each server, machine, cluster, JDBC connection pool, virtual host, and any other resource type must be named uniquely and must not use the same name as the domain.

    For more information on server naming conventions, see Domain and Server Name Restrictions in Understanding Domain Configuration for Oracle WebLogic Server.

    The server name is not used as part of the URL for applications that are deployed on the server. It is for your identification purposes only. The server name displays in the Administration Console, and if you use WebLogic Server command-line utilities or APIs, you use this name to identify the server.

    After you have created a server, you cannot change its name. Instead, clone the server and provide a new name for the clone.

  • Default Value: true

    Specifies whether native I/O is enabled for the server.

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

  • Minimum Value: 0
    Maximum Value: 65534
    Default Value: 3

    Get the number of retries to contact admin server, before starting in Managed Server Independence Mode

  • Default Value: false

    Specifies whether new server-to-server connections may consider the default server channel when initiating a connection. This is only relevant if the connection needs to be bound to the default 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. For the default channel this is usually what is wanted for IP-routing to be effective. Note that since the default is false, other outbound channels will be considered in preference to the default channel.

    Default administration channels, created when the domain-wide administration port is turned on, are always considered and bound when initiating an administrative connection. To allow IP-routing for administration traffic create custom admin with NetworkAccessPointMBean#isOutboundEnabled isOutboundEnabled set to false instead of enabling the domain-wide ADMIN port.

  • Default Value: false

    Specifies whether the SSL identity specified by SSLMBean#getServerPrivateKeyAlias() getSSLMBean#ServerPrivateKeyAlias for this server should be used for outbound SSL connections on the default server channel. In normal circumstances the outbound identity is determined by the caller's environment.

    Constraints

    • secure default : false
  • Minimum Value: 0
    Default Value: 60000

    The time interval in milliseconds of the heartbeat period. A value of 0 indicates that heartbeats are turned off.

  • Defines secondary clustered instances considered for hosting replicas of the primary HTTP session states created on the server.

  • Default Value: false

    Specifies whether the server message log includes exception stack trace that are raised in remote systems.

    Constraints

    • secure default : false
  • WS Reliable Delivery Policy Reference
    Title: WS Reliable Delivery Policy Reference
    Contains the WS reliable delivery policy reference.

    The reliable delivery policy for web services.

    Constraints

    • restart required

  • Defines preferred clustered instances considered for hosting replicas of the primary HTTP session states created on the server.

  • When WLS is running on Exalogic machines, cluster replication traffic could go over multiple replication channels. However multiple replication channels need not be configured on each clustered server instance. Only one replication channel with explicit IP-Address needs to be configured for each server and replicationPorts range can be specified for each server. For eg. range 7001-7010 will create 10 replication channels with ports 7001 to 7010 for the given server. These channels inherits all the properties of the configured replication channel except the listen port.Names of these channels will be derived from the configured replication channel with suffic {x} added where x could be 1,2.. as per the number of ports specified. Public ports are same as the listen port for these additional channels.

  • Default Value: false

    Resolve the listen address to use for all T3 communication

  • Minimum Value: 0
    Maximum Value: 2147483647
    Default Value: 0

    The number of seconds the Node Manager should wait before restarting this server.

    After killing a server process, the system might need several seconds to release the TCP port(s) the server was using. If Node Manager attempts to restart the Managed Server while its ports are still active, the startup attempt fails.

    If AutoMigration is enabled and RestartDelaySeconds is 0, the RestartDelaySeconds is automatically set to the lease time. This prevents the server from failing to restart after migration when the previous lease is still valid.

  • Minimum Value: 300
    Maximum Value: 2147483647
    Default Value: 3600

    The number of seconds during which this server can be restarted, up to the number of times specified in RestartMax.

  • Minimum Value: 0
    Maximum Value: 2147483647
    Default Value: 2

    The number of times that the Node Manager can restart this server within the interval specified in RestartIntervalSeconds.

  • Minimum Value: 1
    Maximum Value: 65534
    Default Value: 5

    Get the number of seconds between the retries to contact admin server, before starting in Managed Server Independence Mode

  • Default Value: false

    Specifies whether the kernel is allowed to perform reverse DNS lookups.

    Constraints

    • secure default : false
  • Default Value: false

    Enables scattered reads over NIO socket channels. Enabling this attribute increases efficiency during I/O in environments with high network throughput and should be used only when configuring a WebLogic domain for Oracle Exalogic.

  • Minimum Value: 0
    Default Value: 30

    Number of seconds a force shutdown operation waits before timing out and killing itself. If the operation does not complete within the configured timeout seconds, the server will shutdown automatically if the state of the server at that time was SHUTTING_DOWN

    A value of means that the server will wait indefinitely for life cycle operation to complete.

    Constraints

    • secure default : 120
    • production mode default : 120
  • Server Template Reference
    Title: Server Template Reference
    Contains the server template reference.

    The template used to configure this server.

    Constraints

    • restart required
  • Default Value: false

    Indicates if session replication on server shutdown is enabled. During server shutdown, any active http and ejb stateful session states will be replicated to a secondary server (if available) in the cluster.

  • Minimum Value: 1
    Maximum Value: 65534
    Default Value: 5

    Returns the current polling interval for finding the situational config file in the filesystem

  • Default Value: false

    Returns whether situational config files are required and WebLogic Server should fail to boot if situational config files are not present.

  • Default Value: false

    Specifies whether the server's buffer size for sending or receiving data through a raw socket should be set to 4KB.

    Otherwise, the server does not impose a limit to the buffer size and defers to the operating system. This option is useful only on some operating systems for improving performance. It should be disabled in most environments.

  • Minimum Value: -1
    Maximum Value: 65534
    Default Value: -1

    The number of socket reader threads.

  • The directory path on the Managed Server where all staged (prepared) applications are placed.

    If an absolute directory name is not specified, the path is relative to the root directory "/". Once configured, you cannot change the staging directory name. Remove all applications from the server prior to changing this attribute. The default staging directory is "stage", relative to the server root.

  • Allowed Values: [ null, "stage", "nostage", "external_stage" ]

    The mode that specifies whether an application's files are copied from a source on the Administration Server to the Managed Server's staging area during application preparation.

    During application preparation, the application's files are copied from the source on the Administration Server to the Managed Server's staging area. If you specify nostage or external_stage, the copy will not occur. This is useful when the staging area is a shared directory, already containing the application files, or if this is a single server domain. The administrator must ensure that the Managed Server's staging directory is set appropriately. Deployment errors will result if the application is not available during the preparation or activation of the application. Each application can override the staging mode specified here.

  • Default Value: RUNNING

    The state in which this server should be started. If you specify STANDBY, you must also enable the domain-wide administration port.

    In the RUNNING state, a server offers its services to clients and can operate as a full member of a cluster. In the ADMIN state, the server is up and running, but available only for administration operations, allowing you to perform server and application-level administration tasks without risk to running applications. In the STANDBY state, a server instance does not process any request; its regular Listen Port is closed. The Administration Port is open. It only accepts life cycle commands that transition the server instance to either the RUNNING or the SHUTDOWN state. Other Administration requests are not accepted. A STANDBY server's only purpose is to resume into the RUNNING state quickly; it saves server startup time.

  • Minimum Value: 0
    Default Value: 0

    Timeout value for server start and resume operations. If the server fails to start in the timeout period, it will force shutdown.

    A value of means that the server will wait indefinitely for the operation to complete.

    Constraints

    • production mode default : 0
  • Minimum Value: 0
    Maximum Value: 2147483647
    Default Value: 60

    The number of seconds after which WebLogic Server periodically scans threads to see if they have been continually working for the configured maximum length of time.

  • Items
    Title: Items

    Return all tags on this Configuration MBean

  • Default Value: true

    Specifies whether this server supports Tuxedo GIOP (TGIOP) requests. (Requires you to configure WebLogic Tuxedo Connector (WTC) for this server.)

    Constraints

    • secure default : true
  • Minimum Value: 1
    Maximum Value: 99
    Default Value: 33

    The percentage of execute threads from the default queue that can be used as socket readers.

  • Default Value: ./

    The path prefix for the server's JTA transaction log files. If the pathname is not absolute, the path is assumed to be relative to the server's root directory.

    For a clustered server, if you plan to be able to migrate the Transaction Recovery Service from this server if it fails to another server (backup server) in the same cluster, you must store transaction log files on persistent storage, such as a Storage Area Network (SAN) device or a dual-ported disk, available to both servers.

    Do not use an NFS file system to store transaction log files. Because of the caching scheme in NFS, transaction log files on disk may not always be current. Using transaction log files stored on an NFS device for recovery may cause data corruption.

  • Default Value: Direct-Write
    Allowed Values: [ "Cache-Flush", "Direct-Write" ]

    The policy that determines how transaction log file entries are written to disk. This policy can affect transaction performance. (Note: To be transactionally safe, the Direct-Write policy may require additional OS or environment changes on some Windows systems.)

    WebLogic Server supports the following policies:

    • Cache-Flush. Flushes operating system and on-disk caches after each write.

    • Direct-Write. Tells the operating system to write directly to disk with each write. Direct-Write performs better than Cache-Flush.

    If Direct-Write is not supported on the host platform, the policy becomes Cache-Flush and a log message is printed.

    Note: On Windows, the "Direct-Write" policy may leave transaction data in the on-disk cache without writing it to disk immediately. This is not transactionally safe because a power failure can cause loss of on-disk cache data. For transactionally safe writes using "Direct-Write" on Windows, either disable all write caching for the disk (enabled by default), or use a disk with a battery-backed cache.

    The on-disk cache for a hard-drive on Windows can be disabled through system administration: Control-Panel -> System -> Hardware-tab -> Device-Manager-button -> Disk-Drives -> name-of-drive -> Policies-tab -> "Enable write caching on the disk" check-box. Some file systems do not allow this value to be changed. For example, a RAID system that has a reliable cache.

    Constraints

    • legal null

  • Returns the name of the server network channel to derive the default URL used for internal JTA communication with this server.

  • Returns the name of the server network channel to derive the public URL used for internal JTA communication with this server.

  • Returns the name of the server network channel to derive the public secure URL used for internal JTA communication with this server.

  • Returns the name of the server network channel to derive the secure URL used for internal JTA communication with this server.

  • Minimum Value: 1
    Default Value: 45

    The interval (in seconds) at which to ping a tunneled client to see if it is still alive.

    If you create network channels for this server, each channel can override this setting.

  • Minimum Value: 1
    Default Value: 40

    The amount of time (in seconds) after which a missing tunneled client is considered dead.

    If you create network channels for this server, each channel can override this setting.

  • Default Value: false

    Specifies whether tunneling for the T3, T3S, HTTP, HTTPS, IIOP, and IIOPS protocols should be enabled for this server.

    If you create network channels for this server, each channel can override this setting.

  • Read Only: true

    Returns the type of the MBean.

    Constraints

    • unharvestable

  • The directory path on the Administration Server where all uploaded applications are placed.

    If an absolute directory name is not specified, the path is relative to the root directory "/". The default staging directory is "stage", relative to the server root. On the Managed Server this returns null, and is not configurable.

    Constraints

    • doc only secure default : "An absolute directory that is outside the root directory of any WebLogic Server instance or application, and that resides on a physical disk that is separate from the WebLogic Server host's system disk."
  • Default Value: false

    Backward compatibility mode to switch to 8.1 execute queues instead of WorkManagers. Each of the WorkManagers is converted to an individual execute queue. Setting this attribute requires a server restart.

  • Reduces lock contention by using concurrent buffer queue to park incoming requests. Enabling this attribute increases throughput as requests are scheduled without acquiring any locks.

  • Default Value: false

    Specifies whether to includes detailed information in self-tuning thread pool thread names. Setting this flag as true would include additional information, such as the name of the Work Manager for which the execute thread is executing the task, but at the expense of overhead in keeping the thread name updated with such information.

  • Default Value: true

    Specifies whether self-tuning should use the enhanced IncrementAdvisor implementation that uses a different algorithm to adjust the size of the self-tuning thread pool.

  • Default Value: false

    Reduces lock contention by using the enhanced ConcurrentCalendarQueue as the priority based queue for pending requests that are waiting for a thread.

    This attribute should be enabled only in an Oracle Exalogic environment.

  • Enables the use of the ADM_DDL store procedure for LLR. The default value is false (not enabled).

    When enabled, a WLS_ prefix and _DYD suffix is is automatically added to the LLR table name at runtime so the LLR table name in server configuration is not consistent with the actual table name in database.

  • Default Value: false

    Specifies whether this server uses the proprietary WL-Proxy-Client-IP header.

    Set this attribute to true to specify that this server instance uses the proprietary WL-Proxy-Client-IP header, which is recommended if the server instance will receive requests from a proxy plug-in. If the server instance is a member of a cluster that will receive proxied requests, enable the WebLogic plug-in at the cluster level. For servers that are members of a cluster, the setting at the cluster level overrides the server's setting. When the WebLogic plug-in is enabled at the cluster level, a call to getRemoteAddr will return the address of the browser client from the proprietary WL-Proxy-Client-IP header instead of the Web server.

    Set this attrbute to false to disable the weblogic-plugin-enabled parameter, weblogic-plugin-enabled=false, in the config.xml file.

    Note: If you are using Oracle HTTP Server, the WebLogic Proxy Plug-In, or Oracle Traffic Director to distribute client requests to a Managed Server or a cluster, Oracle recommends setting this attribute to true

  • XML Entity Cache Reference
    Title: XML Entity Cache Reference
    Contains the XML entity cache reference.

    The server's XML entity cache, which is used to configure the behavior of JAXP (Java API for XML Parsing).

    Constraints

    • restart required
  • XML Registry Reference
    Title: XML Registry Reference
    Contains the XML registry reference.

    The server's XML registry, which is used to configure the behavior of JAXP (Java API for XML Parsing).

    Constraints

    • restart required
Nested Schema : Machine References
Type: array
Title: Machine References
Contains the array of machine references.

Limits the list of candidate machines that the cluster specifies. (Requires you to enable this server for automatic migration and to configure the cluster with a set of candidate machines.)

If this server fails and if it is enabled for automatic migration, Node Manager automatically restarts it. By default, Node Manager restarts the server on any of the candidate machines that the cluster specifies (in order of preference that you configured in the cluster). To change the default, you use this server's list of candidate machines to create a subset of the cluster-wide candidates. You can also change the order of preference.

Constraints

  • restart required
Show Source
Nested Schema : Cluster Reference
Type: array
Title: Cluster Reference
Contains the cluster reference.

The cluster, or group of WebLogic Server instances, to which this server belongs.

If set, the server will listen for cluster multicast events.

Constraints

  • restart required
Show Source
Nested Schema : Coherence Cluster System Resource Reference
Type: array
Title: Coherence Cluster System Resource Reference
Contains the coherence cluster system resource reference.

The system-level Coherence cluster resource associated with this server.

Constraints

  • restart required
Show Source
Nested Schema : Items
Type: array
Title: Items

List of factories that create transportable objects.

Show Source
Nested Schema : Machine Reference
Type: array
Title: Machine Reference
Contains the machine reference.

The WebLogic Server host computer (machine) on which this server is meant to run.

If you want to use Node Manager to start this server, you must assign the server to a machine and you must configure the machine for Node Manager.

You cannot change this value if a server instance is already running.

Constraints

  • restart required
Show Source
Nested Schema : WS Reliable Delivery Policy Reference
Type: array
Title: WS Reliable Delivery Policy Reference
Contains the WS reliable delivery policy reference.

The reliable delivery policy for web services.

Constraints

  • restart required
Show Source
Nested Schema : Server Template Reference
Type: array
Title: Server Template Reference
Contains the server template reference.

The template used to configure this server.

Constraints

  • restart required
Show Source
Nested Schema : Items
Type: array
Title: Items

Return all tags on this Configuration MBean

Show Source
Nested Schema : XML Entity Cache Reference
Type: array
Title: XML Entity Cache Reference
Contains the XML entity cache reference.

The server's XML entity cache, which is used to configure the behavior of JAXP (Java API for XML Parsing).

Constraints

  • restart required
Show Source
Nested Schema : XML Registry Reference
Type: array
Title: XML Registry Reference
Contains the XML registry reference.

The server's XML registry, which is used to configure the behavior of JAXP (Java API for XML Parsing).

Constraints

  • restart required
Show Source
Nested Schema : Machine Reference
Type: object
Title: Machine Reference
Contains the machine reference.
Show Source
Nested Schema : Identity
Type: array
Title: Identity
DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.
Show Source
Back to Top

Examples

View this server collection.

This example uses the GET method to view this server collection.

Example Request
curl -v \
--user admin:admin123 \
-H X-Requested-By:MyClient \
-H Accept:application/json \
-X GET http://localhost:7001/management/weblogic/latest/edit/servers?fields=name,listenPort,listenAddress,listenPortEnabled,machine,candidateMachines&links=self
Example Response
HTTP/1.1 200 OK

Response Body:
{
    "links": [{
        "rel": "self",
        "href": "http:\//localhost:7001/management/weblogic/latest/edit/servers"
    }],
    "items": [
        {
            "links": [{
                "rel": "self",
                "href": "http:\//localhost:7001/management/weblogic/latest/edit/servers/AdminServer"
            }],
            "listenAddress": "localhost",
            "listenPortEnabled": true,
            "name": "AdminServer",
            "listenPort": 7001,
            "machine": null,
            "candidateMachines": []
        },
        {
            "links": [{
                "rel": "self",
                "href": "http:\//localhost:7001/management/weblogic/latest/edit/servers/server1"
            }],
            "listenAddress": "lhost",
            "listenPortEnabled": true,
            "name": "server1",
            "listenPort": 7777,
            "machine": [
                "machines",
                "machine1"
            ],
            "candidateMachines": [
                {"identity": [
                    "machines",
                    "machine1"
                ]},
                {"identity": [
                    "machines",
                    "machine2"
                ]}
            ]
        }
    ]
}
Back to Top