RESTful Server Configuration Management Interface for Oracle WebLogic Server

View This Coherence Member Config

get

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

View this coherence member config.

Request

Path Parameters

name(required): string

The name property of the instance in the collection.
version(required): string

The version of the WebLogic REST interface.

Query Parameters

excludeFields: 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: 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: 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: 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.

Response

Supported Media Types

application/json

200 Response

Returns this coherence member config.

Root Schema : Coherence Member Config

Type: object

Show Source

coherenceWebFederatedStorageEnabled: boolean

Default Value: false

Specifies whether Federated Cache Storage is enabled for the Coherence Web cluster member
coherenceWebLocalStorageEnabled: boolean

Default Value: false

Specifies whether Local Storage is enabled for the Coherence Web cluster member
dynamicallyCreated: boolean

Read Only: true

Default Value: false

Return whether the MBean was created dynamically or is persisted to config.xml
id: integer(int64)

Read Only: true

Return the unique id of this MBean instance
localStorageEnabled: boolean

Default Value: true

Specifies whether or not this member will contribute storage to the Coherence cluster i.e. maintain partitions. This attribute is used only when the WebLogic Server is not part of a WLS Cluster.
name: 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: 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.


            
            
            rackName: 
            string
            
                
                
























Specifies the location within a geographic site where this member is hosted.




                
            
            
            
            
            roleName: 
            string
            
                
                
























Specifies a name used to logically group similar members.




                
            
            
            
            
            siteName: 
            string
            
                
                
























Specifies the name of the geographic site where this member is hosted.




                
            
            
            
            
            tags: 
            array  Items
            
            
                
                
Title: Items





















Return all tags on this Configuration MBean


                
            
            
            
            
            type: 
            string
            
                
                


Read Only: true























Returns the type of the MBean.
Constraints
unharvestable




                
            
            
            
            
            unicastListenAddress: 
            string
            
                
                
























The IP address for the Coherence unicast listener.




                
            
            
            
            
            unicastListenPort: 
            integer(int32)
            
                
                




Minimum Value: 0





Maximum Value: 65535

















The port for the Coherence unicast listener. A value of 0 indicates that the unicast listen port value will be assigned automatically to an ephemeral port.




                
            
            
            
            
            unicastPortAutoAdjustAttempts: 
            integer(int32)
            
                
                




Minimum Value: 0





Maximum Value: 65535

















 Get the upper bound of the unicast port. A positive value indicates the unicast port is automatically incremented if the specified port cannot be bound because it is already in use.


        {
    "type":"object",
    "properties":{
        "coherenceWebFederatedStorageEnabled":{
            "default":false,
            "type":"boolean",
            "description":"<p>Specifies whether Federated Cache Storage is enabled for the Coherence Web cluster member </p>"
        },
        "coherenceWebLocalStorageEnabled":{
            "default":false,
            "type":"boolean",
            "description":"<p>Specifies whether Local Storage is enabled for the Coherence Web cluster member </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>"
        },
        "localStorageEnabled":{
            "default":true,
            "type":"boolean",
            "description":"<p>Specifies whether or not this member will contribute storage to the Coherence cluster i.e. maintain partitions. This attribute is used only when the WebLogic Server is not part of a WLS Cluster.</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>"
        },
        "rackName":{
            "type":"string",
            "description":"<p>Specifies the location within a geographic site where this member is hosted.</p>"
        },
        "roleName":{
            "type":"string",
            "description":"<p>Specifies a name used to logically group similar members.</p>"
        },
        "siteName":{
            "type":"string",
            "description":"<p>Specifies the name of the geographic site where this member is hosted.</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>"
        },
        "unicastListenAddress":{
            "type":"string",
            "description":"<p>The IP address for the Coherence unicast listener.</p>"
        },
        "unicastListenPort":{
            "minimum":"0",
            "maximum":"65535",
            "type":"integer",
            "format":"int32",
            "description":"<p>The port for the Coherence unicast listener. A value of 0 indicates that the unicast listen port value will be assigned automatically to an ephemeral port.</p>"
        },
        "unicastPortAutoAdjustAttempts":{
            "minimum":"0",
            "maximum":"65535",
            "type":"integer",
            "format":"int32",
            "description":"<p> Get the upper bound of the unicast port. A positive value indicates the unicast port is automatically incremented if the specified port cannot be bound because it is already in use. </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