Administration guide > Configure the deployment environment > Configuring catalog and container servers > Configuring WebSphere eXtreme Scale with WAS > Configuring the catalog service in WAS > Create catalog service domains in WAS



Catalog service domain administrative tasks

Use the Jacl or Jython scripting languages to manage catalog service domains in the WebSphere Application Server configuration.


Requirements

You must have the WebSphere eXtreme Scale Client installed in the WebSphere Application Server environment.


List all administrative tasks

To get a list of all of the administrative tasks that are associated with catalog service domains, run the following command with wsadmin:

wsadmin>$AdminTask help XSDomainManagement 


Commands

The administrative tasks for catalog service domains include the following commands:


createXSDomain

The createXSDomain command registers a new catalog service domain.

Table 1. createXSDomain command arguments
Argument Description
-name (required) Specifies the name of the catalog service domain that to create.
-default Specifies if 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.

Table 2. defineDomainServers step arguments
Argument Description
name_of_endpoint Specifies the name of the catalog service endpoint.

  • For existing application servers: The name of the endpoint must be in the following format: cell_name\node_name\server_name

  • For remote servers: Specifies the host name of the remote server. You can have the same name for multiple endpoints, but the client port values must be unique for each 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 quotes ("") 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>

Client Port

Specifies the port that is used for communication between the catalog servers in the catalog service domain. This value is required for catalog servers that are running in WAS processes only and can be set to any port that is not being used elsewhere.

Listener Port

Specifies the port that is used for communication with clients. This value is required for remote endpoints and must match the value used when the catalog service was started. The listener port is used by clients and containers to communicate with the catalog service.

For WebSphere eXtreme Scale remote endpoints: Defines the Object Request Broker (ORB) listener port for containers and clients to communicate with the catalog service through the ORB. For WAS endpoints, the listener port value is optional because the value is inherited from the BOOTSTRAP_ADDRESS port configuration.


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, 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>.


Interactive mode example usage


deleteXSDomain

The deleteXSDomain command deletes a catalog service domain.


Required parameters:

-name

Name of the catalog service domain to delete.


Return value:


Batch mode example usage


Interactive mode example usage


getDefaultXSDomain

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.


Batch mode example usage


Interactive mode example usage


listXSDomains

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.


Batch mode example usage


Interactive mode example usage


modifyXSDomain

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, 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>.

Table 3. modifyXSDomain command arguments
Argument Description
-name (required) Specifies the name of the catalog service domain that 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.

Table 4. modifyEndpoints step arguments
Argument Description
name_of_endpoint Specifies the name of the catalog service endpoint.

  • For existing application servers: The name of the endpoint must be in the following format: cell_name\node_name\server_name

  • For remote servers: Specifies the host name of the remote server. You can have the same name for multiple endpoints, but the listener port values must be unique for each 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>

Client Port

Specifies the port that is used for communication between the catalog servers in the catalog service domain. This value is required for catalog servers that are running in WAS processes only and can be set to any port that is not being used elsewhere.

Listener Port

Specifies the port that is used for communication with clients. This value is required for remote endpoints and must match the value used when the catalog service was started. The listener port is used by clients and containers to communicate with the catalog service.

For WebSphere eXtreme Scale remote endpoints: Defines the Object Request Broker (ORB) listener port for containers and clients to communicate with the catalog service through the ORB. For WAS endpoints, specifying the listener port value is optional because the value is inherited from the BOOTSTRAP_ADDRESS port configuration.

Table 5. addEndpoints step arguments
Argument Description
name_of_endpoint Specifies the name of the catalog service endpoint.

  • For existing application servers: The name of the endpoint must be in the following format: cell_name\node_name\server_name

  • For remote servers: Specifies the host name of the remote server. You can have the same name for multiple endpoints, but the listener port values must be unique for each 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 quotes ("") 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>

Client Port

Specifies the port that is used for communication between the catalog servers in the catalog service domain. This value is required for catalog servers that are running in WAS processes only and can be set to any port that is not being used elsewhere.

Listener Port

Specifies the port that is used for communication with clients. This value is required for remote endpoints and must match the value used when the catalog service was started. The listener port is used by clients and containers to communicate with the catalog service.

For WebSphere eXtreme Scale remote endpoints: Defines the Object Request Broker (ORB) listener port for containers and clients to communicate with the catalog service through the ORB. For WAS endpoints, specifying the listener port value is optional because the value is inherited from the BOOTSTRAP_ADDRESS port configuration.

Table 6. removeEndpoints step arguments
Argument Description
name_of_endpoint Specifies the name of the catalog service endpoint to delete.


Return value:


Batch mode example usage


Interactive mode example usage


testXSDomainConnection

The testXSDomainConnection command tests the connection to a catalog service domain.


Required parameters:

-name

Name of the catalog service domain to which to test the connection.


Optional parameters

-timeout

Specifies the maximum amount of time to wait for the connection, in seconds.


Return value: If a connection can be made, returns true, otherwise, connection error information is returned.


Batch mode example usage


Interactive mode example usage


testXSServerConnection

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.


Required parameters:

host

Specifies the host on which the catalog server resides.

listenerPort

Specifies the listener port for the catalog server.


Optional parameters

timeout

Specifies the maximum amount of time to wait for a connection to the catalog server, in seconds.


Return value:


Batch mode example usage


Interactive mode example usage


Parent topic:

Create catalog service domains in WAS


Related concepts

Best practice: Clustering the catalog service


Related tasks

Start and stop servers in a WAS environment

Create catalog service domains in WAS