Jump to

• Request
• Response

View This Lifecycle Manager Config

get

/management/weblogic/{version}/domainConfig/lifecycleManagerConfig

View this lifecycle manager config.

Request

Path Parameters

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

Query Parameters

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

Security

• Admin: basic
  Type: basic

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

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

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

  Description: A user in the Operator security role.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns this lifecycle manager config.

This method can return the following links:

• rel=configuredEndPoints uri=/management/weblogic/{version}/domainConfig/lifecycleManagerConfig/configuredEndPoints

  This resource's configuredEndPoints collection resource.

• rel=target

  This resource's target reference to a target resource.

Body ()

Root Schema : Lifecycle Manager Config

Type: object

Show Source

• configFileLockTimeout(optional): integer(int64)
  Default Value: 120000

  Returns the Lifecycle configuration lock timeout. This is used when the persistence type is LifecycleManagerConfigMBean.PERSISTENCE_TYPE_XML, while attempting to lock the configuration file to persist configuration changes.

• dataSourceName(optional): string

  Returns the name of the DataSource that should be used when LifecycleManager is configured to maintain its configuration in a database.

• deploymentType(optional): string
  Default Value: none

  Allowed Values: [ "none", "admin", "cluster" ]

  The deployment model for LifecycleManager services in this domain.

• 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
  Read Only: true

  Determine if LifeycleManager features are available, either locally on this admin server or remotely via a configured endpoint.

• endPoints(optional): array Lifecycle Manager End Point References
  Title: Lifecycle Manager End Point References

  Read Only: true

  Contains the array of lifecycle manager end point references.

  Returns the REST endpoints for each LifecycleManager that is participating in the management of this domain.

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

  Return the unique id of this MBean instance

• LCMInitiatedConnectTimeout(optional): integer(int32)
  Default Value: 0

  Returns setting for connect timeout for LCM initiated REST requests which may have been triggered by OOB, sync, patching. 0 return implies that the option is disabled (i.e., timeout of infinity).

• LCMInitiatedConnectTimeoutForElasticity(optional): integer(int32)
  Default Value: 0

  Returns setting for connect timeout for LCM initiated REST requests triggered by Elasticity 0 return implies that the option is disabled (i.e., timeout of infinity).

• LCMInitiatedReadTimeout(optional): integer(int32)
  Default Value: 0
• LCMInitiatedReadTimeoutForElasticity(optional): integer(int32)
  Default Value: 0
• 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.

• outOfBandEnabled(optional): boolean
  Default Value: false

  Determine if LifecycleManager should listen for configuration changes on this server.

• periodicSyncInterval(optional): integer(int32)
  Default Value: 2

  Get periodic interval for lifecycle configuration synchronization in hours. When synchronizing configuration, Lifecycle contacts the different runtimes that are registered with it, gets the list of partitions from those runtimes, and ensure that its configuration is synchronized with those runtimes.

• persistenceType(optional): string
  Default Value: XML

  Allowed Values: [ "XML", "database" ]

  The persistence model that is used by this LifecycleManager service. Either database or a local XML file may be used for an admin server deployment, but a database configuration model is required for a cluster deployment.

• propagationActivateTimeout(optional): integer(int64)
  Default Value: 180000

  Returns the activation timeout in milliseconds for Lifecycle configuration propagation to managed server.

• serverReadyTimeout(optional): integer(int64)
  Default Value: 60000

  The timeout in milliseconds for waiting for a server to be ready to receive requests.

• serverRuntimeTimeout(optional): integer(int64)
  Default Value: 600000

  Returns the timeout in milliseconds for accessing server runtime mbeans.

• tags(optional): array Items
  Title: Items

  Return all tags on this Configuration MBean

• target(optional): array Target Reference
  Title: Target Reference

  Contains the target reference.

  The cluster target defined in the current domain that should host the LifecycleManager service when running deployed in Cluster mode.

  Constraints

  • restart required
• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable

{
    "type":"object",
    "properties":{
        "LCMInitiatedConnectTimeout":{
            "default":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>Returns setting for connect timeout for LCM initiated REST requests which may have been triggered by OOB, sync, patching. 0 return implies that the option is disabled (i.e., timeout of infinity).</p>"
        },
        "LCMInitiatedConnectTimeoutForElasticity":{
            "default":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>Returns setting for connect timeout for LCM initiated REST requests triggered by Elasticity 0 return implies that the option is disabled (i.e., timeout of infinity).</p>"
        },
        "LCMInitiatedReadTimeout":{
            "default":0,
            "type":"integer",
            "format":"int32",
            "description":""
        },
        "LCMInitiatedReadTimeoutForElasticity":{
            "default":0,
            "type":"integer",
            "format":"int32",
            "description":""
        },
        "configFileLockTimeout":{
            "default":120000,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the Lifecycle configuration lock timeout. This is used when the persistence type is LifecycleManagerConfigMBean.PERSISTENCE_TYPE_XML, while attempting to lock the configuration file to persist configuration changes. </p>"
        },
        "dataSourceName":{
            "type":"string",
            "description":"<p>Returns the name of the DataSource that should be used when LifecycleManager is configured to maintain its configuration in a database.</p>"
        },
        "deploymentType":{
            "default":"none",
            "enum":[
                "none",
                "admin",
                "cluster"
            ],
            "type":"string",
            "description":"<p>The deployment model for LifecycleManager services in this domain.</p>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "enabled":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Determine if LifeycleManager features are available, either locally on this admin server or remotely via a configured endpoint.</p>"
        },
        "endPoints":{
            "readOnly":true,
            "title":"Lifecycle Manager End Point References",
            "type":"array",
            "items":{
                "title":"Lifecycle Manager End Point Reference",
                "type":"object",
                "properties":{
                    "identity":{
                        "title":"Identity",
                        "type":"array",
                        "items":{
                            "type":"string",
                            "description":""
                        },
                        "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
                    }
                },
                "description":"Contains the lifecycle manager end point reference."
            },
            "description":"Contains the array of lifecycle manager end point references. <p>Returns the REST endpoints for each LifecycleManager that is participating in the management of this domain.</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The user-specified name of this MBean instance.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "notes":{
            "type":"string",
            "description":"<p>Optional information that you can include to describe this configuration.</p><p>WebLogic Server saves this note in the domain's configuration file (<code>config.xml</code>) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><p>Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p>"
        },
        "outOfBandEnabled":{
            "default":false,
            "type":"boolean",
            "description":"<p>Determine if LifecycleManager should listen for configuration changes on this server.</p>"
        },
        "periodicSyncInterval":{
            "default":2,
            "type":"integer",
            "format":"int32",
            "description":"<p>Get periodic interval for lifecycle configuration synchronization in hours. When synchronizing configuration, Lifecycle contacts the different runtimes that are registered with it, gets the list of partitions from those runtimes, and ensure that its configuration is synchronized with those runtimes. </p>"
        },
        "persistenceType":{
            "default":"XML",
            "enum":[
                "XML",
                "database"
            ],
            "type":"string",
            "description":"<p>The persistence model that is used by this LifecycleManager service. Either database or a local XML file may be used for an admin server deployment, but a database configuration model is required for a cluster deployment.</p>"
        },
        "propagationActivateTimeout":{
            "default":180000,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the activation timeout in milliseconds for Lifecycle configuration propagation to managed server. </p>"
        },
        "serverReadyTimeout":{
            "default":60000,
            "type":"integer",
            "format":"int64",
            "description":"<p>The timeout in milliseconds for waiting for a server to be ready to receive requests.</p>"
        },
        "serverRuntimeTimeout":{
            "default":600000,
            "type":"integer",
            "format":"int64",
            "description":"<p>Returns the timeout in milliseconds for accessing server runtime mbeans. </p>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "target":{
            "x-weblogic-restartRequired":true,
            "title":"Target Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the target reference. <p>The cluster target defined in the current domain that should host the LifecycleManager service when running deployed in Cluster mode.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
        },
        "type":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        }
    },
    "description":""
}

Nested Schema : Lifecycle Manager End Point References

Type: array

Title: Lifecycle Manager End Point References

Read Only: true

Contains the array of lifecycle manager end point references.

Returns the REST endpoints for each LifecycleManager that is participating in the management of this domain.

Show Source

• Array of: object Lifecycle Manager End Point Reference
  Title: Lifecycle Manager End Point Reference

  Contains the lifecycle manager end point reference.

{
    "readOnly":true,
    "title":"Lifecycle Manager End Point References",
    "type":"array",
    "items":{
        "title":"Lifecycle Manager End Point Reference",
        "type":"object",
        "properties":{
            "identity":{
                "title":"Identity",
                "type":"array",
                "items":{
                    "type":"string",
                    "description":""
                },
                "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
            }
        },
        "description":"Contains the lifecycle manager end point reference."
    },
    "description":"Contains the array of lifecycle manager end point references. <p>Returns the REST endpoints for each LifecycleManager that is participating in the management of this domain.</p>"
}

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

Nested Schema : Target Reference

Type: array

Title: Target Reference

Contains the target reference.

The cluster target defined in the current domain that should host the LifecycleManager service when running deployed in Cluster mode.

Constraints

• restart required

Show Source

• Array of: string

{
    "x-weblogic-restartRequired":true,
    "title":"Target Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the target reference. <p>The cluster target defined in the current domain that should host the LifecycleManager service when running deployed in Cluster mode.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
}

Nested Schema : Lifecycle Manager End Point Reference

Type: object

Title: Lifecycle Manager End Point Reference

Contains the lifecycle manager end point reference.

Show Source

• identity(optional): array Identity
  Title: Identity

  DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.

{
    "title":"Lifecycle Manager End Point Reference",
    "type":"object",
    "properties":{
        "identity":{
            "title":"Identity",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
        }
    },
    "description":"Contains the lifecycle manager end point reference."
}

Nested Schema : Identity

Type: array

Title: Identity

DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.

Show Source

• Array of: string

{
    "title":"Identity",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
}

Back to Top