You can use the Jacl or Jython scripting languages to manage catalog service domains in your WebSphere® Application Server configuration.
wsadmin>$AdminTask help XSDomainManagement
wsadmin>print AdminTask.help ('XSDomainManagement')
wsadmin>$AdminTask help <command>
wsadmin>$AdminTask help <command> <commandStep>
Example: wsadmin>$AdminTask help createXSDomain defineDomainServers
wsadmin>print AdminTask.help ('<command>')
Example: wsadmin>print AdminTask.help ('createXSDomain')
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) |
![]() |
![]()
|
![]() |
Specifies custom properties for the catalog service domain. |
Argument | Description |
---|---|
name_of_endpoint | Specifies the name of the catalog service domain
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> For
existing application servers where only a client port is required,
enter the client port value as either "2809" or "2809,".
For remote servers where only a listener port is required, enter the
listener port value as: ”,9810”
|
Argument | Description |
---|---|
-securityEnabled | Specifies that client security is enabled for the catalog server. The server properties file that is associated with the selected catalog server must have a matching securityEnabled setting in the server properties file. If these settings do not match, an exception results. (Boolean: set to true or false) |
-credentialAuthentication (optional) | Indicates if credential authentication is enforced
or supported.
|
-authenticationRetryCount (optional) | Specifies the number of times that authentication
gets tried again if the credential is expired. If you do not want to try authentication again, set the value to 0. The default value is 0. |
-credentialGeneratorClass | Indicates the com.ibm.websphere.objectgrid.security.plugins.builtins. WSTokenCredentialGenerator implementation class, so the client retrieves the security tokens from the thread. |
-credentialGeneratorProps | Specifies the properties for the CredentialGenerator implementation
class. The properties are sent to the object with the setProperties(String) method.
The credential generator properties value is used only when a value
is specified for the Credential generator class field. Properties
for
includes userid_password which
can be defined as “userid password”. Note: Because
parsing of the userid_password property depends upon
the space character as the value separator, userids and passwords
which contain spaces must use the “\20” escape
character to represent a space. For example: If the userid is “Test
User Id” and the password is “Test Password”,
the userid_password property should be entered as:
“Test\20User\20Id Test\20Password”.
Properties
for
includes the property subject_type,
which can be defined as either“runAs” or “caller”. |
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}} -configureClientSecurity {-securityEnabled false
-credentialAuthentication Required -authenticationRetryCount 0 -credentialGeneratorClass
com.ibm.websphere.objectgrid.security.plugins.builtins.UserPasswordCredentialGenerator
-credentialGeneratorProps "manager manager1"}}
AdminTask.createXSDomain('[-name TestDomain -default true
-defineDomainServers [[xhost1.ibm.com "" ,2809]
[xhost2.ibm.com "" ,2809]] -configureClientSecurity [-securityEnabled false
-credentialAuthentication Required -authenticationRetryCount 0 -credentialGeneratorClass
com.ibm.websphere.objectgrid.security.plugins.builtins.UserPasswordCredentialGenerator
-credentialGeneratorProps "manager manager1"] ]')
$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) |
![]() |
![]()
|
![]() |
Specifies custom properties for the catalog service domain. |
Argument | Description |
---|---|
name_of_endpoint | Specifies the name of the catalog service domain
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> For
existing application servers where only a client port is required,
enter the client port value as either: ”2809” or “2809,”.
For remote servers where only a listener port is required, enter the
listener port value as: ”,9810”.
|
Argument | Description |
---|---|
name_of_endpoint | Specifies the name of the catalog service domain
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> For
existing application servers where only a client port is required,
enter the client port value as either: ”2809” or “2809,”.
For remote servers where only a listener port is required, enter the
listener port value as : ”,9810”.
|
Argument | Description |
---|---|
name_of_endpoint | Specifies the name of the catalog service endpoint to delete. |
Argument | Description |
---|---|
-securityEnabled | Specifies that client security is enabled for the catalog server. The server properties file that is associated with the selected catalog server must have a matching securityEnabled setting in the server properties file. If these settings do not match, an exception results. (Boolean: set to true or false) |
-credentialAuthentication (optional) | Indicates whether credential authentication
is enforced or supported.
|
-authenticationRetryCount (optional) | Specifies the number of times that authentication
gets tried again if the credential is expired. If you do not want to try authentication again, set the value to 0. The default value is 0. |
-credentialGeneratorClass | Indicates the com.ibm.websphere.objectgrid.security.plugins.builtins. WSTokenCredentialGenerator implementation class, so the client retrieves the security tokens from the thread. |
-credentialGeneratorProps | Specifies the properties for the CredentialGenerator implementation
class. The properties are sent to the object with the setProperties(String) method.
The credential generator properties value is used only when a value
is specified for the Credential generator class field. Properties
for
includes userid_password which
can be defined as “userid password”. Note: Because
parsing of the userid_password property depends upon
the space character as the value separator, userids and passwords
which contain spaces must use the “\20” escape
character to represent a space. For example: If the userid is “Test
User Id” and the password is “Test Password”,
the userid_password property should be entered as:
“Test\20User\20Id Test\20Password”.
Properties
for
includes
the property subject_type, which can be defined as
either“runAs” or “caller”. |
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 myDomain -default false
-configureClientSecurity {-securityEnabled true -
Supported -authenticationRetryCount 1 -credentialGeneratorClass
com.ibm.websphere.objectgrid.security.plugins.builtins.UserPasswordCredentialGenerator
-credentialGeneratorProps "manager manager1"}}
AdminTask.modifyXSDomain('[-name testDomain -enableXIO true]')
$AdminTask modifyXSDomain {-interactive}
AdminTask.modifyXSDomain ('[-interactive]')
The getTransport command displays the transport type for the catalog service domain or the existing catalog server. The transport type will be either 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 started, otherwise, returns stopped.
$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: If a connection can be made, returns started, otherwise returns stopped.
$Admintask testXSServerConnection {-host xhost1.ibm.com -listenerPort 2809}
AdminTask.testXSServerConnection('[-host xshost3.ibm.com -listenerPort 2809]')
$AdminTask testXSServerConnection {-interactive}
AdminTask.testXSServerConnection ('[-interactive]')