Jump to

• Request
• Response

View This Coherence Cluster Params

get

/management/weblogic/{version}/serverConfig/coherenceClusterSystemResources/{name}/coherenceClusterResource/coherenceClusterParams

View this coherence cluster params.

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 coherence cluster params.

This method can return the following links:

• rel=coherenceCaches uri=/management/weblogic/{version}/serverConfig/coherenceClusterSystemResources/{name}/coherenceClusterResource/coherenceClusterParams/coherenceCaches

  This resource's coherenceCaches collection resource.

• rel=coherenceClusterWellKnownAddresses uri=/management/weblogic/{version}/serverConfig/coherenceClusterSystemResources/{name}/coherenceClusterResource/coherenceClusterParams/coherenceClusterWellKnownAddresses

  This resource's coherenceClusterWellKnownAddresses singleton resource.

• rel=coherenceIdentityAsserter uri=/management/weblogic/{version}/serverConfig/coherenceClusterSystemResources/{name}/coherenceClusterResource/coherenceClusterParams/coherenceIdentityAsserter

  This resource's coherenceIdentityAsserter singleton resource.

• rel=coherenceKeystoreParams uri=/management/weblogic/{version}/serverConfig/coherenceClusterSystemResources/{name}/coherenceClusterResource/coherenceClusterParams/coherenceKeystoreParams

  This resource's coherenceKeystoreParams singleton resource.

• rel=coherenceServices uri=/management/weblogic/{version}/serverConfig/coherenceClusterSystemResources/{name}/coherenceClusterResource/coherenceClusterParams/coherenceServices

  This resource's coherenceServices collection resource.

Body ()

Root Schema : Coherence Cluster Params

Type: object

Show Source

• clusteringMode(optional): string
  Default Value: unicast

  Allowed Values: [ "multicast", "unicast" ]

  Specifies a clustering mode of either Unicast or Multicast. If multicast is undesirable or unavailable in an environment, or when an environment is not properly configured to support multicast, then setting up the Well Known Addresses (WKA) feature is required. All cluster multicast communication is disabled if WKA is enabled.

• clusterListenPort(optional): integer(int32)
  Minimum Value: 0

  Maximum Value: 65535

  Default Value: 0

  The cluster listen port used by Coherence; Coherence cluster members use this port to discover and join, or create the cluster. If unspecified, the Coherence cluster multicast listen port will be used.

• multicastListenAddress(optional): string

  The IP address for the cluster multicast listener.

• securityFrameworkEnabled(optional): boolean

  Check if security framework is enabled

• timeToLive(optional): integer(int32)
  Minimum Value: 0

  Maximum Value: 255

  Default Value: 4

  Sets the time-to-live (TTL) setting for the multicast message. The TTL setting designates how far multicast UDP/IP packets can travel on a network. The TTL is expressed in terms of how many hops a packet survives; each network interface, router, and managed switch is considered one hop. The TTL value should be set to the lowest integer value that works. Setting the value too high can use unnecessary bandwidth on other LAN segments and can even cause the operating system or network devices to disable multicast traffic.

  Typically, setting the TTL value to 1 works on a simple switched backbone. A value of 2 or more may be required on an advanced backbone with intelligent switching. A value of 0 is used for single server clusters that are used for development and testing.

• transport(optional): string
  Default Value: udp

  Allowed Values: [ "udp", "tcp", "ssl", "tmb", "sdmb", "imb" ]

  Specify the underlying transport protocol to use for cluster communication. TMB, SDMB, or IMB are only applicable to Exalogic environment.

{
    "type":"object",
    "properties":{
        "clusterListenPort":{
            "default":0,
            "minimum":0,
            "maximum":65535,
            "type":"integer",
            "format":"int32",
            "description":"<p>The cluster listen port used by Coherence; Coherence cluster members use this port to discover and join, or create the cluster. If unspecified, the Coherence cluster multicast listen port will be used.</p>"
        },
        "clusteringMode":{
            "default":"unicast",
            "enum":[
                "multicast",
                "unicast"
            ],
            "type":"string",
            "description":"<p>Specifies a clustering mode of either Unicast or Multicast. If multicast is undesirable or unavailable in an environment, or when an environment is not properly configured to support multicast, then setting up the Well Known Addresses (WKA) feature is required. All cluster multicast communication is disabled if WKA is enabled.</p>"
        },
        "multicastListenAddress":{
            "type":"string",
            "description":"<p>The IP address for the cluster multicast listener.</p>"
        },
        "securityFrameworkEnabled":{
            "type":"boolean",
            "description":"<p>Check if security framework is enabled</p>"
        },
        "timeToLive":{
            "default":4,
            "minimum":0,
            "maximum":255,
            "type":"integer",
            "format":"int32",
            "description":"<p>Sets the time-to-live (TTL) setting for the multicast message. The TTL setting designates how far multicast UDP/IP packets can travel on a network. The TTL is expressed in terms of how many hops a packet survives; each network interface, router, and managed switch is considered one hop. The TTL value should be set to the lowest integer value that works. Setting the value too high can use unnecessary bandwidth on other LAN segments and can even cause the operating system or network devices to disable multicast traffic.</p><p>Typically, setting the TTL value to 1 works on a simple switched backbone. A value of 2 or more may be required on an advanced backbone with intelligent switching. A value of 0 is used for single server clusters that are used for development and testing.</p>"
        },
        "transport":{
            "default":"udp",
            "enum":[
                "udp",
                "tcp",
                "ssl",
                "tmb",
                "sdmb",
                "imb"
            ],
            "type":"string",
            "description":"<p>Specify the underlying transport protocol to use for cluster communication. TMB, SDMB, or IMB are only applicable to Exalogic environment.</p>"
        }
    },
    "description":""
}

Back to Top