目录服务域管理任务

可以使用 Jacl 或 Jython 脚本语言来管理 WebSphere® Application Server 配置中的目录服务域。使用 WebSphere DataPower® XC10 Appliance,您可以定义目录服务域来与设备上正在运行的目录服务器建立连接。只有动态高速缓存数据网格才需要创建此配置。

要求

必须已在 WebSphere Application Server 环境中安装 WebSphere eXtreme Scale Client

列示所有管理任务

要获取与目录服务域相关联的所有管理任务的列表,请使用 wsadmin 运行以下命令:
wsadmin>$AdminTask help XSDomainManagement 

命令

目录服务域的管理任务包括下列命令:

createXSDomain

createXSDomain 命令注册新的目录服务域。
表 1. createXSDomain 命令参数
参数 描述
-name(必需) 指定您要创建的目录服务域的名称。
-default 指定目录服务域是否是单元的缺省目录服务域。缺省值是 true。(布尔值:设置为 truefalse
-properties 指定目录服务域的定制属性。
表 2. defineDomainServers 步骤参数
参数 描述
name_of_endpoint 指定目录服务端点的名称。
  • 对于现有的应用程序服务器:端点的名称必须采用以下格式:cell_name\node_name\server_name
  • 对于远程服务器:指定远程服务器的主机名。可以让多个端点具有相同的名称,但是对于每个端点,客户机的端口值必须唯一。
custom_properties 指定目录服务域端点的定制属性。如果您没有任何定制属性,那么对此参数使用一组双引号 ("")。
endpoint_ports
指定目录服务域端点的端口号。必须按以下顺序指定端口:<client_port>,<listener_port>
客户机端口
指定用于目录服务域中的目录服务器之间进行通信的端口。只有正在 WebSphere Application Server 进程中运行的目录服务器才必须具备此值,可以将此值设置为未在其他位置使用的任何端口。
侦听器端口
指定用于与客户机进行通信的端口。远程端点必须具备此值,并且此值必须与启动目录服务时所使用的值相匹配。客户机和容器使用侦听器端口与目录服务进行通信。
对于 WebSphere DataPower XC10 Appliance 远程端点:使用值 2809 作为设备的远程端点。

返回值

批处理方式示例用法

使用批处理方式时,要求命令条目具有正确的格式。可考虑使用交互方式,以确保正确处理您所输入的值。当您使用批处理方式时,必须使用属性的特定数组来定义 -defineDomainServers 步骤参数。此属性数组采用 name_of_endpoint custom_properties endpoint_ports 格式。endpoint_ports 值是必须按以下顺序指定的端口列表:<client_port>,<listener_port>

交互方式示例用法
  • 使用 Jacl:
    $AdminTask createXSDomain {-interactive}
  • 使用 Jython 字符串:
    AdminTask.createXSDomain ('[-interactive]')

deleteXSDomain

deleteXSDomain 命令删除目录服务域。

必需参数:
-name
指定要删除的目录服务域的名称。

返回值

批处理方式示例用法
  • 使用 Jacl:
    $AdminTask deleteXSDomain {-name TestDomain }
  • 使用 Jython 字符串:
    AdminTask.deleteXSDomain('[-name TestDomain ]')
交互方式示例用法
  • 使用 Jacl:
    $AdminTask deleteXSDomain {-interactive}
  • 使用 Jython 字符串:
    AdminTask.deleteXSDomain ('[-interactive]')

getDefaultXSDomain

getDefaultXSDomain 命令返回单元的缺省目录服务域。

必需参数:

返回值:缺省目录服务域的名称。

批处理方式示例用法
  • 使用 Jacl:
    $AdminTask getDefaultXSDomain
  • 使用 Jython 字符串:
    AdminTask.getDefaultXSDomain
交互方式示例用法
  • 使用 Jacl:
    $AdminTask getDefaultXSDomain {-interactive}
  • 使用 Jython 字符串:
    AdminTask.getDefaultXSDomain ('[-interactive]')

listXSDomains

listXSDomains 命令返回现有目录服务域的列表。

必需参数:

返回值:单元中所有目录服务域的列表。

批处理方式示例用法
  • 使用 Jacl:
    $AdminTask listXSDomains
  • 使用 Jython 字符串:
    AdminTask.listXSDomains
交互方式示例用法
  • 使用 Jacl:
    $AdminTask listXSDomains {-interactive}
  • 使用 Jython 字符串:
    AdminTask.listXSDomains ('[-interactive]')

modifyXSDomain

modifyXSDomain 命令修改现有目录服务域。

使用批处理方式时,要求命令条目具有正确的格式。可考虑使用交互方式,以确保正确处理您所输入的值。当您使用批处理方式时,必须使用属性的特定数组来定义 -modifyEndpoints-addEndpoints-removeEndpoints 步骤参数。此属性数组采用 name_of_endpoint host_name custom_properties endpoint_ports 格式。endpoint_ports 值是必须按以下顺序指定的端口列表:<client_port>,<listener_port>

表 3. modifyXSDomain 命令参数
参数 描述
-name(必需) 指定要编辑的目录服务域的名称。
-default 如果设置为 true,那么它指定所选目录服务域是单元的缺省目录服务域。(布尔值)
-properties 指定目录服务域的定制属性。
表 4. modifyEndpoints 步骤参数
参数 描述
name_of_endpoint 指定目录服务端点的名称。
  • 对于现有的应用程序服务器:端点的名称必须采用以下格式:cell_name\node_name\server_name
  • 对于远程服务器:指定远程服务器的主机名。可以让多个端点具有相同的名称,但是对于每个端点,侦听器端口值必须唯一。如果您正在配置设备,那么此值必须是一个标准域名。
endpoint_ports
指定目录服务域端点的端口号。必须按以下顺序指定端点:<client_port>,<listener_port>
客户机端口
指定用于目录服务域中的目录服务器之间进行通信的端口。只有正在 WebSphere Application Server 进程中运行的目录服务器才必须具备此值,可以将此值设置为未在其他位置使用的任何端口。
侦听器端口
指定用于与客户机进行通信的端口。远程端点必须具备此值,并且此值必须与启动目录服务时所使用的值相匹配。客户机和容器使用侦听器端口与目录服务进行通信。
对于 WebSphere DataPower XC10 Appliance 远程端点:使用值 2809 作为设备的远程端点。
表 5. addEndpoints 步骤参数
参数 描述
name_of_endpoint 指定目录服务端点的名称。
  • 对于现有的应用程序服务器:端点的名称必须采用以下格式:cell_name\node_name\server_name
  • 对于远程服务器:指定远程服务器的主机名。可以让多个端点具有相同的名称,但是对于每个端点,侦听器端口值必须唯一。如果您正在配置设备,那么此值必须是一个标准域名。
custom_properties 指定目录服务域端点的定制属性。如果您没有任何定制属性,那么对此参数使用一组双引号 ("")。
endpoint_ports
指定目录服务域端点的端口号。必须按以下顺序指定端点:<client_port>,<listener_port>
客户机端口
指定用于目录服务域中的目录服务器之间进行通信的端口。只有正在 WebSphere Application Server 进程中运行的目录服务器才必须具备此值,可以将此值设置为未在其他位置使用的任何端口。
侦听器端口
指定用于与客户机进行通信的端口。远程端点必须具备此值,并且此值必须与启动目录服务时所使用的值相匹配。客户机和容器使用侦听器端口与目录服务进行通信。
对于 WebSphere DataPower XC10 Appliance 远程端点:使用值 2809 作为设备的远程端点。
表 6. removeEndpoints 步骤参数
参数 描述
name_of_endpoint 指定要删除的目录服务端点的名称。

返回值

批处理方式示例用法
  • 使用 Jacl:
    $AdminTask modifyXSDomain {-name TestDomain -default true -modifyEndpoints 
    {{xhost1.ibm.com "" ,2809}} -addEndpoints {{xhost2.ibm.com "" ,2809}}} 
    -removeEndpoints {{xhost3.ibm.com}}}
  • 使用 Jython 字符串:
    AdminTask.modifyXSDomain('[-name TestDomain  
    -default false -modifyEndpoints [[xhost1.ibm.com "" ,2809]] 
    -addEndpoints [[xhost3.ibm.com "" ,2809]] 
    -removeEndpoints [[xhost2.ibm.com]]]')
交互方式示例用法
  • 使用 Jacl:
    $AdminTask modifyXSDomain {-interactive}
  • 使用 Jython 字符串:
    AdminTask.modifyXSDomain ('[-interactive]')

testXSDomainConnection

testXSDomainConnection 命令测试与目录服务域的连接。

必需参数:
-name
指定目录服务域的名称,将测试与该域的连接。
可选参数
-timeout
指定进行连接要等待的最大时间量(秒)。

返回值:如果可以建立连接,那么返回 true,否则将返回连接错误信息。

批处理方式示例用法
  • 使用 Jacl:
    $Admintask testXSDomainConnection
  • 使用 Jython 字符串:
    AdminTask.testXSDomainConnection
交互方式示例用法
  • 使用 Jacl:
    $AdminTask testXSDomainConnection {-interactive}
  • 使用 Jython 字符串:
    AdminTask.testXSDomainConnection ('[-interactive]')

testXSServerConnection

testXSServerConnection 命令测试与目录服务器的连接。此命令对独立服务器和目录服务域中包含的服务器都起作用。

必需参数:
host
指定目录服务器所在的主机。
listenerPort
指定目录服务器的侦听器端口。
可选参数
timeout
指定连接至目录服务器要等待的最大时间量(秒)。

返回值

批处理方式示例用法
  • 使用 Jacl:
    $Admintask testXSServerConnection {-host xhost1.ibm.com -listenerPort 2809}
  • 使用 Jython 字符串:
    AdminTask.testXSServerConnection('[-host xshost3.ibm.com -listenerPort 2809]')
交互方式示例用法
  • 使用 Jacl:
    $AdminTask testXSServerConnection {-interactive}
  • 使用 Jython 字符串:
    AdminTask.testXSServerConnection ('[-interactive]')