AdminTask 对象的 CAClientCommands 命令组

可以使用 Jython 脚本语言，通过 wsadmin 工具来管理认证中心 (CA) 客户机配置。 使用 CAClientCommands 组中的命令和参数来创建、修改、查询以及移除与第三方 CA 服务器的连接。

使用以下命令来管理认证中心 (CA) 客户机配置：

createCAClient

createCAClient 命令会在配置中创建新的 CA 客户机对象。 应用程序服务器通过 WSPKIClient() 实现来连接到 CA 服务器，此实现会处理与 CA 服务器的所有连接和通信。

目标对象

无。

必需参数

-caClientName
指定用来唯一标识 CA 客户机对象的名称。 （字符串，必需）
-pkiClientImplClass
指定用来实现 WSPKIClient 接口的类路径。 用户提供的 WSPKIClient 实现用来与认证中心 (CA) 进行通信。 系统将使用 WSPKIClient 实现从 CA 请求证书。
请参阅 开发 WSPKIClient 接口以与认证中心通信。 (字符串，必需)

可选参数

-scopeName
指定 CA 客户机的管理作用域。 对于 Deployment Manager 概要文件，系统使用单元范围作为缺省值。 对于应用程序服务器概要文件，系统使用节点范围作为缺省值。 （字符串，可选）
-host
指定系统中 CA 所在的主机名。 （字符串，可选）
-port
指定服务器上 CA 所侦听的端口。 （字符串，可选）
-userName
指定要用来认证到 CA 的用户名。 （字符串，可选）
-password
指定要用来认证到 CA 的用户名的密码。 （字符串，可选）
-frequencyCheck
指定系统与 CA 通信以确定是否已创建证书的频率（以分钟计）。 （字符串，可选）
-retryCheck
指定与 CA 通信以确定是否已创建证书的次数。 （字符串，可选）
-customProperties
使用以下格式指定要添加到 CA 客户机对象的属性/值定制属性对的逗号分隔列表:attribute=value,attribute=value. （字符串，可选）

返回值

此命令会返回系统所创建的 CA 客户机的对象名。

批处理方式示例用法

  • 使用 Jython 字符串：
    AdminTask.createCAClient('[-caClientName clientObj01 -pkiClientImplClass 
com.ibm.wsspi.ssl.WSPKIClient -host machine011 -port 9022 
-userName admin -password pw4admin]')
  • 使用 Jython 列表：
    AdminTask.createCAClient(['-caClientName', 'clientObj01', '-pkiClientImplClass', 
'com.ibm.wsspi.ssl.WSPKIClient', '-host', 'machine011', '-port', '9022', 
'-userName', 'admin', '-password', 'pw4admin'])

交互方式示例用法

  • 使用 Jython：
    AdminTask.createCAClient('-interactive')

modifyCAClient

modifyCAClient 命令会修改现有 CA 客户机对象配置数据。 您可以修改特定 CA 客户机的一个或多个配置属性。

目标对象

无。

必需参数

-caClientName
指定相关 CA 客户机的名称。 （字符串，必需）

可选参数

-scopeName
指定 CA 客户机的管理作用域。 对于 Deployment Manager 概要文件，系统使用单元范围作为缺省值。 对于应用程序服务器概要文件，系统使用节点范围作为缺省值。 （字符串，可选）
-pkiClientImplClass
指定用来实现 WSPKIClient 接口的类路径。 系统使用此路径来连接到 CA 并向 CA 发出请求。 （字符串，可选）
-host
指定系统中 CA 所在的主机名。 （字符串，可选）
-port
指定服务器上 CA 所侦听的端口。 （字符串，可选）
-userName
指定要用来认证到 CA 的用户名。 （字符串，可选）
-password
指定要用来认证到 CA 的用户名的密码。 （字符串，可选）
-frequencyCheck
指定系统应该与 CA 联系以确定是否已创建证书的频率（以分钟计）。 （字符串，可选）
-retryCheck
指定与 CA 联系以确定是否已创建证书的次数。 （字符串，可选）
-customProperties
指定要在 CA 客户机对象上修改的“属性与值”(attribute=value) 定制属性对的逗号分隔列表。 您可以创建、修改或移除属性。 要除去属性，请将属性和值指定为attribute=. （字符串，可选）

返回值

批处理方式示例用法

  • 使用 Jython 字符串：
    AdminTask.modifyCAClient('[-caClientName myCAClient -port 4060 
-userName admin -password password4admin]')
  • 使用 Jython 列表：
    AdminTask.modifyCAClient(['-caClientName', 'myCAClient', '-port', '4060', 
'-userName', 'admin', '-password', 'password4admin'])

交互方式示例用法

  • 使用 Jython：
    AdminTask.modifyCAClient('-interactive')

getCAClient

getCAClient 命令会显示特定 CA 客户机的属性列表。

目标对象

无。

必需参数

-caClientName
指定相关 CA 客户机名称。 （字符串，必需）

可选参数

-scopeName
指定相关 CA 客户机的管理范围。 （字符串，可选）

返回值

此命令会返回属性列表（包含特定 CA 客户机的“属性与值”对），如以下示例所示：
'[ [backupCAs ] [managementScope (cells/myCell01|security.xml#ManagementSc
ope_1)] [scopeName (cell):myCell01] [name myCAClient] [baseDn ] [_Websphe
re_Config_Data_Id cells/myCell01|security.xml#CAClient_1181834566882] [por
t 2951] [CACertificate ] [pkiClientImplClass com.ibm.wsspi.ssl.WSPKIClient] [u
serId ] [_Websphere_Config_Data_Type CAClient] [retryCheck 0] [properties ] [fre
quencyCheck 0] [password ] [host ] ]'

批处理方式示例用法

  • 使用 Jython 字符串：
    print AdminTask.getCAClient('-caClientName myCAClient')
  • 使用 Jython 列表：
    print AdminTask.getCAClient('-caClientName', 'myCAClient')

交互方式示例用法

  • 使用 Jython 字符串：
    print AdminTask.getCAClient('-interactive')

deleteCAClient

deleteCAClient 命令会从配置中移除相关 CA 客户机对象。 使用 -caClientName 参数来指定要删除的 CA 客户机。 可选择性地使用 scopeName 参数来指定 CA 客户机对象的管理范围。

目标对象

无。

必需参数

-caClientName
指定相关 CA 客户机的名称。 （字符串，必需）

可选参数

-scopeName
指定相关 CA 客户机的管理范围。 （字符串，可选）

返回值

如果系统成功移除相关 CA 客户机，那么此命令不会返回输出。 如果您接收到错误消息，请验证相关 CA 客户机对象是否存在于配置中，以及未被安全性配置中的证书对象所引用。

批处理方式示例用法

  • 使用 Jython 字符串：
    AdminTask.deleteCAClient('[-caClientName myCAClient]')
  • 使用 Jython 列表：
    AdminTask.deleteCAClient(['-caClientName', 'myCAClient'])

交互方式示例用法

  • 使用 Jython：
    AdminTask.deleteCAClient('-interactive')

listCAClients

listCAClients 命令会列出配置中或特定范围内的所有 CA 客户机。 如果没有为 -scopeName 参数提供值，那么此命令会查询单元（如果您使用 Deployment Manager 概要文件）或查询节点（如果您使用应用程序服务器概要文件）。 使用 -all 参数（而不是使用特定范围）来查询环境。

目标对象

无。

可选参数

-scopeName
指定管理范围以搜索 CA 客户机。 （字符串，可选）
-all
指定系统是否在不指定特定范围的情况下查询 CA 客户机。 （布尔值，可选）

返回值

此命令会返回属性列表的数组，其中针对每个 CA 客户机显示一个属性列表，如以下示例输出所示：
'[ [backupCAs ] [managementScope (cells/myCell01|security.xml#ManagementScope_1)
] [scopeName (cell):myCell01] [name jenCAClient] [baseDn ] [_Websphere_Config_Da
ta_Id cells/myCell01|security.xml#CAClient_1181834566881] [port 2950] [CACertifi
cate ] [pkiClientImplClass com.ibm.wsspi.ssl.WSPKIClient] [userId ] [_Webspher
e_Config_Data_Type CAClient] [retryCheck 0] [properties ] [frequencyCheck 0] [pa
ssword ] [host ] ]'
'[ [backupCAs ] [managementScope (cells/myCell01|security.xml#ManagementScope_1)
] [scopeName (cell):myCell01] [name myCAClient] [baseDn ] [_Websphere_Config_Dat
a_Id cells/myCell01|security.xml#CAClient_1181834566882] [port 2951] [CACertific
ate ] [pkiClientImplClass com.ibm.wsspi.ssl.WSPKIClient] [userId ] [_Websphere
_Config_Data_Type CAClient] [retryCheck 0] [properties ] [frequencyCheck 0] [pas
sword ] [host ] ]'

批处理方式示例用法

  • 使用 Jython 字符串：
    print AdminTask.listCAClients('-all true')
  • 使用 Jython 列表：
    print AdminTask.listCAClients('-all', 'true')

交互方式示例用法

  • 使用 Jython：
    print AdminTask.listCAClients('-interactive')