You can use the Jacl or Jython scripting languages to manage catalog service domains in your WebSphere® Application Server configuration. With WebSphere DataPower® XC10 Appliance, you define catalog service domains to establish connections with the catalog servers that are running on the appliance. Creating this configuration is required for dynamic cache data grids only.
wsadmin>$AdminTask help XSDomainManagement
Argument | Description |
---|---|
-name (required) | Specifies the name of the catalog service domain that you want to create. |
-default | Specifies whether the catalog service domain is the default for the cell. The default value is true. (Boolean: set to true or false) |
-properties | Specifies custom properties for the catalog service domain. |
-enableXIO | Specifies whether IBM eXtreme
IO (XIO) or the Object Request Broker (ORB) is used for transport
communication in this catalog service domain.
|
Argument | Description |
---|---|
name_of_endpoint | Specifies the name of the catalog service endpoint.
|
custom_properties | Specifies custom properties for the catalog service domain endpoint. If you do not have any custom properties, use a set of double quotation marks ("") for this argument. |
endpoint_ports | Specifies the port numbers for the catalog
service domain endpoint. The ports must be specified in the following
order: <client_port>,<listener_port>
|
Return value:
Batch mode example usage
Batch mode requires correct formatting of the command entry. Consider using interactive mode to ensure the values that you enter are processed correctly. When you use batch mode, you must define the -defineDomainServers step arguments using a specific array of properties. This array of properties is in the format name_of_endpoint custom_properties endpoint_ports. The endpoint_ports value is a list of ports that must be specified in the following order: <client_port>,<listener_port>.
$AdminTask createXSDomain {-name TestDomain -default true -defineDomainServers
{{xhost1.ibm.com "" ,2809}} }}
AdminTask.createXSDomain('[-name TestDomain -default true
-defineDomainServers [[xhost1.ibm.com "" ,2809]
[xhost2.ibm.com "" ,2809]] ]')
$AdminTask createXSDomain {-name TestDomain -default true -defineDomainServers
{{cellName/nodeName/serverName "" 1109}}}
$AdminTask createXSDomain {-interactive}
AdminTask.createXSDomain ('[-interactive]')
The deleteXSDomain command deletes a catalog service domain.
Return value:
$AdminTask deleteXSDomain {-name TestDomain }
AdminTask.deleteXSDomain('[-name TestDomain ]')
$AdminTask deleteXSDomain {-interactive}
AdminTask.deleteXSDomain ('[-interactive]')
The getDefaultXSDomain command returns the default catalog service domain for the cell.
Required parameters: None
Return value: The name of the default catalog service domain.
$AdminTask getDefaultXSDomain
AdminTask.getDefaultXSDomain
$AdminTask getDefaultXSDomain {-interactive}
AdminTask.getDefaultXSDomain ('[-interactive]')
The listXSDomains command returns a list of the existing catalog service domains.
Required parameters: None
Return value: A list of all of the catalog service domains in the cell.
$AdminTask listXSDomains
AdminTask.listXSDomains
$AdminTask listXSDomains {-interactive}
AdminTask.listXSDomains ('[-interactive]')
The modifyXSDomain command modifies an existing catalog service domain.
Batch mode requires correct formatting of the command entry. Consider using interactive mode to ensure the values that you enter are processed correctly. When you use batch mode, you must define the -modifyEndpoints, -addEndpoints and -removeEndpoints step arguments using a specific array of properties. This array of properties is in the format name_of_endpoint host_name custom_properties endpoint_ports. The endpoint_ports value is a list of ports that must be specified in the following order: <client_port>,<listener_port>.
Argument | Description |
---|---|
-name (required) | Specifies the name of the catalog service domain that you want to edit. |
-default | If set to true, specifies that the selected catalog service domain is the default for the cell. (Boolean) |
-properties | Specifies custom properties for the catalog service domain. |
-enableXIO | Specifies whether IBM eXtreme
IO (XIO) or the Object Request Broker (ORB) is used for transport
communication in this catalog service domain.
|
Argument | Description |
---|---|
name_of_endpoint | Specifies the name of the catalog service endpoint.
|
endpoint_ports | Specifies the port numbers for the catalog
service domain endpoint. The endpoints must be specified in the following
order: <client_port>,<listener_port>
|
Argument | Description |
---|---|
name_of_endpoint | Specifies the name of the catalog service endpoint.
|
custom_properties | Specifies custom properties for the catalog service domain endpoint. If you do not have any custom properties, use a set of double quotation marks ("") for this argument. |
endpoint_ports | Specifies the port numbers
for the catalog service domain endpoint. The endpoints must be specified
in the following order: <client_port>,<listener_port>
|
Argument | Description |
---|---|
name_of_endpoint | Specifies the name of the catalog service endpoint to delete. |
Return value:
$AdminTask modifyXSDomain {-name TestDomain -default true -modifyEndpoints
{{xhost1.ibm.com "" ,2809}} -addEndpoints {{xhost2.ibm.com "" ,2809}}}
-removeEndpoints {{xhost3.ibm.com}}}
AdminTask.modifyXSDomain('[-name TestDomain
-default false -modifyEndpoints [[xhost1.ibm.com "" ,2809]]
-addEndpoints [[xhost3.ibm.com "" ,2809]]
-removeEndpoints [[xhost2.ibm.com]]]')
AdminTask.modifyXSDomain('[-name testDomain -enableXIO true]')
$AdminTask modifyXSDomain {-interactive}
AdminTask.modifyXSDomain ('[-interactive]')
The getTransport command displays the transport type for the catalog service domain: IBM eXtremeIO (XIO) or Object Request Broker (ORB). If you run this command on a catalog service domain that contains remote servers, or if the catalogServerName is a remote server, an error results. You must use the xscmd -c showTransport command for remote servers.
Return value: ORB or XIO
$AdminTask getTransport {-domainName TestDomain }
AdminTask.getTransport('[-domainName testDomain]')
$AdminTask getTransport {-catalogServerName myCell01\myNode01\container1 }
AdminTask.getTransport('[-catalogServerName myCell01\myNode01\container1]')
$AdminTask getTransport {-interactive}
AdminTask.getTransport ('[-interactive]')
The testXSDomainConnection command tests the connection to a catalog service domain.
Return value: If a connection can be made, returns true, otherwise, connection error information is returned.
$Admintask testXSDomainConnection
AdminTask.testXSDomainConnection
$AdminTask testXSDomainConnection {-interactive}
AdminTask.testXSDomainConnection ('[-interactive]')
The testXSServerConnection command tests the connection to a catalog server. This command works for both stand-alone servers and servers that are a part of a catalog service domain.
Return value:
$Admintask testXSServerConnection {-host xhost1.ibm.com -listenerPort 2809}
AdminTask.testXSServerConnection('[-host xshost3.ibm.com -listenerPort 2809]')
$AdminTask testXSServerConnection {-interactive}
AdminTask.testXSServerConnection ('[-interactive]')