Jump to

• Request
• Response

View This Server Start

get

/management/weblogic/{version}/serverConfig/serverTemplates/{name}/serverStart

View this server start.

Request

Path Parameters

• name: string
  The name property of the instance in the collection.
• version: string
  The version of the WebLogic REST interface.

Query Parameters

• excludeFields(optional): string
  The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
• excludeLinks(optional): string
  The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
• fields(optional): string
  The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
• links(optional): string
  The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.

Security

• Admin: basic
  Type: basic

  Description: A user in the Admin security role.
• Deployer: basic
  Type: basic

  Description: A user in the Deployer security role.
• Monitor: basic
  Type: basic

  Description: A user in the Monitor security role.
• Operator: basic
  Type: basic

  Description: A user in the Operator security role.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns this server start.

Body ()

Root Schema : Server Start

Type: object

Show Source

• arguments(optional): string

  The arguments to use when starting this server.

  These are the first arguments appended immediately after java portion of the startup command. For example, you can set Java heap memory or specify any weblogic.Server option.

  This property should not be used to specify weblogic.management.username or weblogic.management.password as these values will be ignored during server startup. Instead the username and password properties should be set. This will also enable Node Manager to properly encrypt these values on the Managed Server's machine.

  Separate arguments with a space.

  This value can also be specified conveniently in the nodemanager .properties file using the weblogic.startup.Arguments property. Node Manager will pass this value to a start script using the JAVA_OPTIONS environment variable. When issuing a Java command line to start the server, Node Manager will pass the arguments as options.

• classPath(optional): string

  The classpath (path on the machine running Node Manager) to use when starting this server.

  At a minimum you will need to specify the following values for the class path option: WL_HOME/server/lib/weblogic_sp.jar;WL_HOME/server/lib/weblogic.jar

  where WL_HOME is the directory in which you installed WebLogic Server on the Node Manager machine.

  The shell environment determines which character you use to separate path elements. On Windows, you typically use a semicolon (;). In a BASH shell, you typically use a colon (:).

  This value can also be specified conveniently in the nodemanager .properties file using the weblogic.startup.ClassPath property. Node Manager will pass this value to a start script using the CLASSPATH environment variable. When issuing a Java command line to start the server, Node Manager will pass -Djava.class.path.

• dynamicallyCreated(optional): boolean
  Read Only: true

  Default Value: false

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

• id(optional): integer(int64)
  Read Only: true

  Return the unique id of this MBean instance

• javaHome(optional): string

  The Java home directory (path on the machine running Node Manager) to use when starting this server.

  Specify the parent directory of the JDK's bin directory. For example, c:\bea\jdk141

  This value can also be specified conveniently in the nodemanager .properties file using the weblogic.startup.JavaHome or property.

  Node Manager will pass this value to a start script using the JAVA_HOME environment variable. When issuing a Java command line to start the server, Node Manager will use the Java executable from the specified location.

• javaVendor(optional): string

  The Java Vendor value to use when starting this server.

  If the server is part of a cluster and configured for automatic migration across possibly different platforms with different vendors providing the JDKs, then, both JavaVendor and JavaHome should be set in the generated configuration file instead.

  This value can also be specified conveniently in the nodemanager .properties file using the weblogic.startup.JavaVendor property.

  Node Manager does not pass this value invoking a Java command line to start the server. It does pass this value in the environment variable JAVA_VENDOR to the start script.

• MWHome(optional): string

  The MWHome directory (path on the machine running Node Manager) to use when starting this server.

  Specify the directory on the Node Manager machine under which all of Oracle's Middleware products were installed. For example, c:\bea

  This value can also be specified conveniently in the nodemanager .properties file using the weblogic.startup.MWHome property.

  Node Manager does not pass this value to start scripts. It does specify -Dbea.home when invoking a Java command line to start the server.

• name(optional): string
  Read Only: true

  The user-specified name of this MBean instance.

  This name is included as one of the key properties in the MBean's javax.management.ObjectName

  Name=user-specified-name

  Constraints

  • legal null
• notes(optional): string

  Optional information that you can include to describe this configuration.

  WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the xml entity <. Carriage returns/line feeds are preserved.

  Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

• password(optional): string(password)

  The password of the username used to boot the server and perform server health monitoring.

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

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

  Using this attribute (Password) 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 PasswordEncrypted

• rootDirectory(optional): string

  The directory that this server uses as its root directory. This directory must be on the computer that hosts Node Manager. If you do not specify a Root Directory value, the domain directory is used by default.

• securityPolicyFile(optional): string

  The security policy file (directory and filename on the machine running Node Manager) to use when starting this server.

  This value can also be specified conveniently in the nodemanager .properties file using the weblogic.startup.SecurityPolicyFile property .

  When Node Manager is using a start script, the security policy file will be defined in an environment variable, SECURITY_POLICY. Additionally, when Node Manager is launching the process directly using a Java command, the security policy file will be defined with -Djava.security.policy=

• tags(optional): array Items
  Title: Items

  Return all tags on this Configuration MBean

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable
• username(optional): string
  Default Value:

  The user name to use when booting this server.

  The Administration Console inserts the user name that you supplied when you logged in to the console. The Domain Configuration Wizard inserts the user name that you defined when you created the domain.

{
    "type":"object",
    "properties":{
        "MWHome":{
            "type":"string",
            "description":"<p></p><p>The MWHome directory (path on the machine running Node Manager) to use when starting this server.</p><p>Specify the directory on the Node Manager machine under which all of Oracle's Middleware products were installed. For example, <code>c:\\bea</code></p><p>This value can also be specified conveniently in the nodemanager .properties file using the weblogic.startup.MWHome property.</p><p> Node Manager does not pass this value to start scripts. It does specify -Dbea.home when invoking a Java command line to start the server.</p>"
        },
        "arguments":{
            "type":"string",
            "description":"<p>The arguments to use when starting this server.</p><p>These are the first arguments appended immediately after <code>java</code> portion of the startup command. For example, you can set Java heap memory or specify any <code>weblogic.Server</code> option.</p><p>This property should not be used to specify weblogic.management.username or weblogic.management.password as these values will be ignored during server startup.  Instead the username and password properties should be set. This will also enable Node Manager to properly encrypt these values on the Managed Server's machine.</p><p>Separate arguments with a space.</p><p>This value can also be specified conveniently in the nodemanager .properties file using the weblogic.startup.Arguments property. Node Manager will pass this value to a start script using the JAVA_OPTIONS environment variable.  When issuing a Java command line to start the server, Node Manager will pass the arguments as options.</p>"
        },
        "classPath":{
            "type":"string",
            "description":"<p>The classpath (path on the machine running Node Manager) to use when starting this server.</p><p>At a minimum you will need to specify the following values for the class path option: <code>WL_HOME/server/lib/weblogic_sp.jar;WL_HOME/server/lib/weblogic.jar</code></p><p>where <code>WL_HOME</code> is the directory in which you installed WebLogic Server on the Node Manager machine.</p><p>The shell environment determines which character you use to separate path elements. On Windows, you typically use a semicolon (;). In a BASH shell, you typically use a colon (:).</p><p>This value can also be specified conveniently in the nodemanager .properties file using the weblogic.startup.ClassPath property. Node Manager will pass this value to a start script using the CLASSPATH environment variable.  When issuing a Java command line to start the server, Node Manager will pass -Djava.class.path.</p>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "javaHome":{
            "type":"string",
            "description":"<p>The Java home directory (path on the machine running Node Manager) to use when starting this server.</p><p>Specify the parent directory of the JDK's <code>bin</code> directory. For example, <code>c:\\bea\\jdk141</code></p><p>This value can also be specified conveniently in the nodemanager .properties file using the weblogic.startup.JavaHome or property.</p><p>Node Manager will pass this value to a start script using the JAVA_HOME environment variable.  When issuing a Java command line to start the server, Node Manager will use the Java executable from the specified location. </p>"
        },
        "javaVendor":{
            "type":"string",
            "description":"<p>The Java Vendor value to use when starting this server. </p><p> If the server is part of a cluster and configured for automatic migration across possibly different platforms with different vendors providing the JDKs, then, both JavaVendor and JavaHome should be set in the generated configuration file instead.</p><p>This value can also be specified conveniently in the nodemanager .properties file using the weblogic.startup.JavaVendor property.</p><p>Node Manager does not pass this value invoking a Java command line to start the server.  It does pass this value in the environment variable JAVA_VENDOR to the start script. </p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The user-specified name of this MBean instance.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "notes":{
            "type":"string",
            "description":"<p>Optional information that you can include to describe this configuration.</p><p>WebLogic Server saves this note in the domain's configuration file (<code>config.xml</code>) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><p>Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p>"
        },
        "password":{
            "type":"string",
            "format":"password",
            "description":"<p>The password of the username used to boot the server and perform server health monitoring.</p><p>As of 8.1 sp4, when you get the value of this attribute, WebLogic Server does the following:</p><ol><li><p>Retrieves the value of the <code>PasswordEncrypted</code> attribute.</p></li><li><p>Decrypts the value and returns the unencrypted password as a String.</p></li></ol><p>When you set the value of this attribute, WebLogic Server does the following:</p><ol><li><p>Encrypts the value.</p></li><li><p>Sets the value of the <code>PasswordEncrypted</code> attribute to the encrypted value.</p></li></ol><p>Using this attribute (<code>Password</code>) 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.</p><p>Instead of using this attribute, use <code>PasswordEncrypted</code></p>"
        },
        "rootDirectory":{
            "type":"string",
            "description":"<p>The directory that this server uses as its root directory. This directory must be on the computer that hosts Node Manager. If you do not specify a Root Directory value, the domain directory is used by default. </p>"
        },
        "securityPolicyFile":{
            "type":"string",
            "description":"<p>The security policy file (directory and filename on the machine running Node Manager) to use when starting this server.</p><p>This value can also be specified conveniently in the nodemanager .properties file using the weblogic.startup.SecurityPolicyFile property .</p><p>When Node Manager is using a start script, the security policy file will be defined in an environment variable, SECURITY_POLICY.  Additionally, when Node Manager is launching the process directly using a Java command, the security policy file will be defined with -Djava.security.policy= </p>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "type":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "username":{
            "default":"",
            "type":"string",
            "description":"<p>The user name to use when booting this server.</p><p>The Administration Console inserts the user name that you supplied when you logged in to the console. The Domain Configuration Wizard inserts the user name that you defined when you created the domain.</p>"
        }
    },
    "description":""
}

Nested Schema : Items

Type: array

Title: Items

Return all tags on this Configuration MBean

Show Source

• Array of: string

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

Back to Top