AdminTask 物件的 CAClientCommands 指令群組

您可以利用 wsadmin 工具，以 Jython Scripting 語言來管理您的憑證管理中心 (CA) 用戶端配置。 使用 CAClientCommands 群組中的指令及參數來建立、修改、查詢及移除與協力廠商 CA 伺服器的連線。

使用下列指令來管理憑證管理中心 (CA) 用戶端配置:

createCAClient

createCAClient 指令會在您的配置中建立新的 CA 用戶端物件。 應用程式伺服器會透過 WSPKIClient () 實作來連接 CA 伺服器，以處理與 CA 伺服器的所有連線及通訊。

目標物件

無。

必要參數

-caClientName
指定用來唯一識別 CA 用戶端物件的名稱。 （字串，必要）
-pkiClientImplClass
指定實作 WSPKIClient 介面的類別路徑。 使用者提供的 WSPKIClient 實作用來與「憑證管理中心 (CA)」進行通訊。 系統將使用 WSPKIClient 實作來向 CA 要求憑證。
請參閱 開發 WSPKIClient 介面以與憑證管理中心通訊。 (字串，必要)

選用參數

-scopeName
指定 CA 用戶端的管理範圍。 對於部署管理程式設定檔，系統會使用 Cell 範圍作為預設值。 對於應用程式伺服器設定檔，系統會使用節點範圍作為預設值。 （字串，選用）
-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 用戶端的管理範圍。 對於部署管理程式設定檔，系統會使用 Cell 範圍作為預設值。 對於應用程式伺服器設定檔，系統會使用節點範圍作為預設值。 （字串，選用）
-pkiClientImplClass
指定實作 WSPKIClient 介面的類別路徑。 系統會使用此路徑來連接至 CA ，並向 CA 發出要求。 （字串，選用）
-host
指定 CA 所在系統中的主機名稱。 （字串，選用）
-port
指定 CA 接聽所在伺服器上的埠。 （字串，選用）
-userName
指定用來向 CA 鑑別的使用者名稱。 （字串，選用）
-password
指定向 CA 鑑別之使用者名稱的密碼。 （字串，選用）
-frequencyCheck
指定系統應該檢查 CA 以判斷是否已建立憑證的頻率 (分鐘)。 （字串，選用）
-retryCheck
指定向 CA 檢查以判斷是否已建立憑證的次數。 （字串，選用）
-customProperties
指定要在 CA Client 物件上修改的屬性和值 (屬性 = 值) 自訂內容配對清單 (以逗點區隔)。 您可以建立、修改或移除內容。 如果要移除內容，請將屬性和值指定為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 參數值，如果您使用部署管理程式設定檔，指令會查詢 Cell ，如果您使用應用程式伺服器設定檔，則會查詢節點。 請使用 -all 參數來查詢您的環境，而不使用特定的範圍。

目標物件

無。

選用參數

-scopeName
指定要搜尋 CA 用戶端的管理範圍。 （字串，選用）
-all
指定系統是否查詢沒有特定範圍的 CA 用戶端。 （Boolean，選用）

回覆值

該指令會傳回屬性清單的陣列，每個 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')