HP

HP Systems Insight Manager 5.1 版使用指南

繁體中文
  擴充管理的工具  |  自訂工具  |  自訂工具參考資訊   

自訂工具參考資訊

目錄
索引
注意事項
簡介
產品綜覽
快速入門
探索與識別
使用者和授權
目錄服務
網路與安全性
監視系統、叢集和事件
儲存設備整合
管理作業
擴充管理的工具
叢集監視程式
命令行工具
配置或修復代理程式綜覽
自訂工具
建立新的遠端工具
建立新的 CMS 工具
建立一個新的網頁工具
管理自訂工具
編輯遠端工具
編輯 CMS 工具
編輯網頁工具
刪除自訂工具
檢視工具定義檔
移除與回復自訂工具
自訂工具的環境變數
在自訂工具中使用參數的範例
自訂工具參考資訊
配置 DMI 存取
配置 SNMP 存取
裝置 ping
磁碟臨界值
授權管理員
管理處理器工具
管理 MIB
安裝 OpenSSH
PMP 工具
複製代理程式設定
RPM Package Manager
Server Migration Pack
System Management Homepage
系統頁面
Version Control
Virtual Machine Management Pack
以 WBEM 為基礎的工具
可用的 MSA 工具
合作夥伴應用程式
報告
管理系統與事件
疑難排解
參考資訊
可列印版本
辭彙
使用輔助說明
 工具類型
 參數化字串
 工具過濾
 版本編號
 其他需求
 文件類型定義

工具類型

有三種基本的 HP Systems Insight Manager (HP SIM) 工具類型:可判別單系統 (SSA) 工具、可判別多系統 (MSA) 工具,以及可判別網頁啟動 (WLA) 工具。

SSA 工具亦可在目標系統上執行,且僅可判別目標系統環境。因此,執行 SSA 工具時分散式作業工具 (DTF) 會將工具資訊傳送到每一個 HP SIM 代理程式,以執行工具。SSA 工具的範例就像包含一般 UNIX 命令的工具,例如 lscatcp

MSA 工具執行於中央系統上 (有時在中央管理伺服器 (CMS)) 上,且知道如何處理一系列目標系統。MSA 工具的範例就像包含 HP-UX 系統上之 Ignite-UX 功能的工具。

WLA 工具通常在瀏覽器中執行,且以統一資源位址 (universal resource location,URL) 指定。

參數化字串

欲正確地建立工具,工具開發人員必須瞭解 URL 和命令行的形成方式。若使用參數化的字串,工具開發人員可以大幅強化建立定義檔 (TDEF) 可用的選項。

參數化字串是指包含替代欄位的字串,類似於標準 C 程式庫中常用之 printf() 函式所用的格式字串。可替代這些欄位的值包括使用者在執行時輸入的值 (如工具參數屬性所定義)、作業控制器提供的某些標準作業屬性、與所選系統或系統群組關聯的值,或者是從全域工具屬性檔擷取的屬性值。這可產生非常特定的 URL 或命令行。

參數化字串替換表

下列參數提供提供全域屬性的替換值:

參數說明
%t 欲執行的作業之作業 ID
%u執行此工具的使用者之名稱
%e執行此工具的使用者之名稱
%s執行工具的核心 CMS 之管理伺服器主機名稱
%#(其中 # 為正整數) 以使用者輸入的值取代數字 (#) 提供的參照參數,作為清單索引定位 (以一為基礎...... %1、%2、%3 等)。
%y簡易物件存取通訊協定 (Simple Object Access Protocol,SOAP) 登入 token,用於 SOAP 單一登入網頁應用程式

下列參數可替換目前選取的目標:

參數說明
%f目標系統 (或系統群組,若字串中有 %x 切換) 的系統名稱或 IP 位址。
%n網路名稱 (主機名稱、IP 位址,或按照此順序的系統名稱)。
%a網路位址 (IP 位址)。
%l使用系統連結配置設定 (名稱、IP 位址或完整的 DNS 名稱) 指定之格式的連結名稱。
%p此系統之 WBEM proxy 的 IP 位址 (若有的話),格式為<IP 位址>:<連接埠#></連接埠#></IP>。
%g目標系統 (或系統群組,若字串中有 %x 切換) 的資料庫 GUID。
%b目標系統的系統類型。
%c目標系統的系統子類型。
%r% (rt[.attribute]%)替換關係類型如參數 "rt" 所指定之相關系統。若指定 [.attribute],則會傳回相關系統的其中一個命名名稱屬性。此外,通用的屬性 (如網路名稱 (.a)) 亦可使用。例如,欲取得伺服器之管理處理器的 IP 位址,請使用 %r{MgmtProcToServer.a%} 來取得使用 %r{MgmtProcToServer.a%} 的聯繫。若當時省略了每個系統的相關系統屬性,則會傳回網路名稱和 IP 位址。網路名稱和 IP 位址會以「網路名稱|IP 位址」的形式傳回。若傳回多個系統,則會以逗號分隔。請注意,「MgmtProcToServer」關係類型可用來傳回所有管理處理器關聯性類型的相關系統資訊。
%(attribute]%)目標系統命名屬性的值。

下列參數提供重複,以支援多個選取的目標系統:

參數說明
%( ... %)重複的模式 (只有在目前的選取存在時才會重複)。若目前選取的目標不存在,則會移除分隔符號之間的文字。這樣可讓您根據目標系統選項清單來選擇是否要使用文字。
%i選取索引 (以一個為基礎)。
%z不會替換成任何項目,但會將選取的索引遞增至下一個整數,並將被參照的目標系統遞增至所選目標清單中的下一個目標。
%⇚< ... >l加密文字 (替換所有其他參數後即進行加密)。
%%可讓您於替換後在命令/URL 中保留 %。

工具過濾

工具過濾工具可讓工具撰寫人員能夠控制是否應在特定系統上執行該工具。大多數工具均依賴於平台,才能根據某些平台提供的命令成功執行,而非根據其他平台。例如,bdf 工具取決於 HP-UX 平台提供的 bdf 命令,但在 Linux 平台的該名稱下則無法使用。當至少有一個探索到的系統通過過濾程式的要求時,應該只會在 工具 功能表中顯示工具。探索到的系統必須通過過濾程式的要求,且只有在通過所有過濾程式要求之後才會執行。欲達到此目的,工具會在系統過濾程式運算式中指定所有可執行該工具之系統必須擁有的系統屬性。

若特定系統無法啟動某個工具,則會顯示錯誤訊息,以及關於為何無法啟動該工具的資訊。

執行工具所必需的系統屬性由具下列形式的系統過濾程式運算式指定:

				
<節點-過濾程式名稱="屬性-名稱" operator="eq" 
value="attribute-value" />
或
<節點-過濾程式名稱="屬性-名稱" operator="ge" 
value="attribute-value" />
或
<節點-過濾程式名稱="屬性-名稱" operator="lt" 
value="attribute-value" />
或
<節點-過濾程式名稱="屬性-名稱" operator="ct" 
value="attribute-value" />
或
<節點-過濾程式名稱="屬性-名稱" operator="neq" 
value="attribute-value" />
或
<節點-過濾程式名稱="屬性-名稱" operator="nct" 
value="attribute-value" />
			

eq 運算子指定可執行工具的系統必須指定確切的屬性值。適用於系統過濾程式運算式允許的任何屬性名稱。ge 運算子指定可執行工具的系統至少必須指定的屬性值。It 和 ge 運算子僅能用於版別屬性,尤其是 OS type 過濾程式中的 OSRevision,以及 Protocol type 過濾程式的所有屬性。這些屬性的值可為數值或字元字串。ct 運算子指定可執行工具的系統必須包含指定的屬性值。neq 運算子指定可執行工具的系統不可包含指定的確切屬性值。適用於系統過濾程式運算式允許的任何屬性名稱。nct 運算子指定可執行工具的系統必須擁有不包含指定值的屬性值。在系統中,過濾程式運算式能夠指定的數值屬性包括 OSRevisionProtocol Support 屬性,這些屬性的值為版本編號。下節的版本編號中會說明允許的版本編號值和比照方式。attribute-name 是其中一個列於下個部分的表格或系統之 ProtocolSupport 屬性之通訊協定名稱的值。attribute-value 是 attribute-name 可能的系統屬性值之一。

屬性值是以分散式管理管理專門小組 (Distributed Management Task Force,DMTF) 的通用資訊模型 (Common Information Model,CIM) 為基礎。 這些值通常是在系統識別程序中定義 (識別程序使用 WBEM 和 SNMP 來判斷系統屬性)。 在此版本中,有效的 OSName 值為 HP-UX 和 Linux。作為 HP-UX 的 OSName 值時,OSRevision 屬性值開頭的字母將被移除 (例如 B.11.11 將存成 11.11)。

系統過濾程式運算式用作包含過濾程式運算式的一部分。有三種類型的包含過濾程式運算式。每種類型允許過濾不同類別的屬性名稱。

類別過濾程式類型允許的屬性名稱
作業系統osOSName、OSVendor、OS Revision
硬體硬體DeviceType、DeviceSubType、Model
通訊協定支援通訊協定HTTP 以外的任何通訊協定名稱
其他其他可為任何預先定義的系統屬性,或是任何自訂的系統屬性。

包含過濾程式包含一或多個使用允許之屬性名稱的系統過濾程式運算式。例如,os 過濾程式可包含:

				
<include-filter type="os">
	      <node-filter name="OSName"     
		    operator="eq" value="LINUX"  />
	      <node-filter name="OSVendor"   
operator="eq" value="RedHat" />
	      <node-filter name="OSRevision" 
operator="ge" value="7.2"	  />
</include-filter>
			

包含過濾程式不需要包含所有允許的屬性。若包含多個屬性,則條件在邏輯上會 AND 在一起。屬性不可重複出現在包含過濾程式中,除非當一個運算子為 lt 而另一個運算子為 ge 時,擁有版本編號值的屬性才可出現兩次。例如:

				
<include-filter type="protocol">
	      <node-filter name="WBEM" 
operator="lt" value="2.6" />
<node-filter name="WBEM" 
operator="ge" value="2.4" />
</include-filter>
			

這樣將會指定任何支援 WBEM 通訊協定 2.4 版或更新版 (但不高於 2.6 版) 的系統集合應顯示該工具。

若工具包含多個不同類型的包含過濾程式,則過濾程式的條件會在邏輯上 AND 在一起。同時具有作業系統和硬體相依性的工具可使用下列過濾程式:

				
<include-filter type="os">
	      <node-filter name="OSName"     
	        operator="eq" value="LINUX"  />
</include-filter>
<include-filter type="hardware">
	      <node-filter name="DeviceSubType" 
	        operator="eq" value="HPVectra" />
</include-filter>
			

若一個工具包含多個相同類型的包含過濾程式,則過濾程式的條件會在邏輯上 OR 在一起。可在兩個不同作業系統上使用的工具可指定:

				
<include-filter type="os">
	      <node-filter name="OSName"     
	        operator="eq" value="LINUX"  />
</include-filter>
<include-filter type="os">
	      <node-filter name="OSName"     
	        operator="eq" value="HPUX"	 />
</include-filter>
			

可在使用 Linux 或 HP-UX 的任何系統集合上啟動此工具。

取決於欲過濾的屬性之工具過濾功能在所選的系統上具有定義值。若為 os 過濾程式類型,若系統未定義任何欲過濾的屬性,則會假設該系統有過濾程式所需要的值。因此,沒有工具過濾程式指定之 os 屬性的值假設有執行該工具的能力。若為 hardware 過濾程式類型,使用 Model 屬性時,以上敘述亦為真。除了 DeviceTypeDeviceSubType 屬性,工具過濾程式將僅套用所選系統上已知的屬性。protocol 過濾程式類型要求系統上必須有通訊協定,才能套用運算子。這表示 neqnct 運算子亦依賴擁有該通訊協定的系統。 其他過濾程式亦如 protocol 過濾程式般運作,因此欲過濾的屬性必須存在於系統上,才能套用運算子。 若工具使用其他 and/or protocol 過濾程式,則至少要有一個系統包含可過濾的屬性,才能在 GUI 中顯示工具。

版本編號

OSRevisionProtocol Support 系統屬性的值會盡可能解譯為版本編號。版本編號是一連串非負數的十進位數字,以句號 (.) 字元分隔。比較版本編號時會使用下列規則:

  • 序號中最左邊的數字最重要,因此 1.0 大於 0.1。

  • 數字開頭的零會被忽略,因此 003 等於 3。

  • 兩個相鄰的句號字元解釋為去掉數字零,因此 1.0.3 等於 1..3

  • 開頭的句號字元解釋為前面需加上零,因此 .9 等於 0.9。

  • 最後的數字零會被忽略,因此 1.0.0 等於 1。

其他需求

SSA 命令工具必須包含一個執行陳述式 (execStmt) 或檔案副本陳述式 (copyStmt),或者兩者兼具。若僅指定執行陳述式,則在執行命令之前不會複製任何檔案。 若僅指定一個檔案副本陳述式,則複製檔案後,不會執行任何命令。若同時指定上述兩者,則會先複製檔案再執行命令。

MSA 命令工具必須指定一個命令和將要執行該命令的系統。

工具名稱至少必須為一個字元,且長度不可多於 256 個字元。名稱第一個字元必須為英文字母,第二個字元開始可以是字母、數字、空格或 - . ( ) 或 _ 當中的任何一個字元。

可判別網頁啟動工具必須指定一個主要 URL。

指定檔案副本對組時,單一 TDEF 中每個檔案副本對組的目的地檔案路徑必須是獨一無二的。為多個來源檔案路徑指定同一個目的地檔案路徑將導致檔案剖析錯誤。

執行複製檔案的工具時,若檔案不存在或無法讀取,則會出現錯誤。建立或修改工具時並不會檢查來源檔案路徑,但執行工具時,路徑必須存在。

log 元素設為 true 時,作業執行所輸出的標準輸出和標準錯誤會登錄在 中央管理伺服器 (CMS) 日誌檔 /var/opt/mx/logs/mx.log。設為 false 時,只會登錄摘要作業資訊,例如起始與結束時間,以及作業狀況。

文件類型定義

文件類型定義 (Document Type Definition,DTD) 檔案定義 XML 檔的限制。這些限制包括有效的元素標記、屬性和 XML 檔中的元素基礎。工具 DTD 檔命名為 toollist.dtd,且包含在下列段落中。請注意,由於線上援助頁的格式,DTD 的內容可能不會和檔案中所呈現的完全相同。

				
<?xml version="1.0" encoding="UTF-8"?>

<!-- The tool-list element can contain zero or more of 
ssa-command-tool elements, msa-command-tool elements,
web-launch-tool elements, automation-tool elements or
app-launch-tool elements.-->
      
<!ELEMENT tool-list ( ssa-command-tool |
msa-command-tool |
web-launch-tool  |
automation-tool  |
app-launch-tool )* >

<!-- The ssa-command-tool element specifies a single-system aware      tool.
The ssa-command-tool element can optionally specify a
category element, a description element, a comment element, an
owner element, a default-target element, an execute-as-user
element, a job-display-handler element, a toolbox-enabled
element, zero or more toolbox elements, zero or more
include-filter elements, or zero or more env-variable elements.
(NOTE:The role-enabled and role elements are deprecated
elements and should not be used with this product.These
are provided for backward compatibility with previous
products.The toolbox-enabled element and the toolbox
element should be used in their stead.)
If more than one of these elements are specified, the element
must appear in the order as listed in this definition.The
ssa-command-tool element must contain an ssa-block element.The
ssa-block element must appear after the previously described
optional elements, if any of the optional elements are
specified.Following the ssa-block element, one can specify zero
or more attribute elements.-->
	  
<!ELEMENT ssa-command-tool (category?, description?, comment?,
owner?, default-target?, execute-as-user?,
job-display-handler?,
toolbox-enabled?, toolbox*,
role-enabled?, role*,
include-filter*, env-variable*,
ssa-block, attribute* ) >

<!-- In addition to the previously described elements, the
ssa-command-tool element specifies the following attributes.The
name attribute specifies the tool name and must be specified in
the ssa-command-tool element.The visible attribute specifies
whether the tool is visible for running.By default tools are
visible.The max-targets attribute specifies the maximum number
of targets against which a tool can run.The revision attribute
allows a tool author to specify a revision for the tool.Note
that this is for information only.The job-log attribute
specifies whether the results of the command will be kept in this
system's job log.This attribute applies only to tools when they
are run as scheduled tasks, not when they are run as "run now"
tasks.When job-log="true" the job and target status for the tool
will be kept for a relatively lengthy system-defined period in
the database after the job completes.When job-log="false" only
the last completed copy of the job and target status for the task
will be kept in the cache for a much shorter period of time, and
will not be written to the database.	 Job logging is enabled by
default.The schedulable attribute specifies whether the tool can
be run as a schedulable task.When scheduled="false" the tool can
only run as a "run now" task.Tools are scheduled by default.
The GUID attribute specifies a globally unique identifier (GUID)
for the tool.Because the system generates a GUID for a tool
during the add operation, this field should only be specified
during a modify operation.The accepts-targets attribute specifies
whether the tool accepts targets for execution.The
accepts-targets attribute is true by default. -->

<!ATTLIST ssa-command-tool name	     CDATA   #REQUIRED
visible     (true | false) "true"
max-targets NMTOKEN #IMPLIED
revision    CDATA   #IMPLIED
job-log     (true | false) "true"
schedulable (true | false) "true"
guid	     NMTOKEN #IMPLIED
accepts-targets (true|false) "true" >

<!-- The ssa-block specifies the elements specific to a single-system
aware tool.The ssa-block can specify a command or copy-block or
both.Only one command should be specified but up to 16 multiple
copy-blocks can be specified.After the command and/or
copy-blocks, one can specify the parameters for the command
and/or copy-block. -->
  
<!ELEMENT ssa-block (( command | copy-block )+, parameter*) >

<!-- The copy-block specifies a source file path and a destination
file path for a copy operation. -->

<!ELEMENT copy-block ( source, destination )+ >

<!-- The source element specifies the source file path for a copy
operation. -->

<!ELEMENT source (#PCDATA) >

<!-- The destination element specifies the destination file path for a
copy operation. -->
     
<!ELEMENT destination (#PCDATA) >

<!-- The msa-command-tool element specifies a multiple-system aware
tool.The msa-command-tool element can optionally specify a
category element, a description element, a comment element, an
owner element, a default-target element, an execute-as-user
element, a job-display-handler element, a toolbox-enabled
element, zero or more toolbox elements, zero or more
include-filter elements, or zero or more env-variable elements.
(NOTE:The role-enabled and role elements are deprecated
elements and should not be used with this product.These
are provided for backward compatibility with previous
products.The toolbox-enabled element and the toolbox
element should be used in their stead.)
If more than one of these elements are specified, the element
must appear in the order as listed in this definition.The
msa-command-tool element must contain an msa-block element.The
msa-block element must appear after the previously described
optional elements, if any of the optional elements are
specified.Following the msa-block element, one can specify zero
or more attribute elements.-->
      
<!ELEMENT msa-command-tool (category?, description?, comment?, owner?,
default-target?, execute-as-user?,
job-display-handler?,
toolbox-enabled?, toolbox*,
role-enabled?, role*,
include-filter*, env-variable*,
msa-block, attribute* ) >

<!-- In addition to the previously described elements, the
msa-command-tool element specifies the following attributes.The
name attribute specifies the tool name and must be specified in
the msa-command-tool element.The visible attribute specifies
whether the tool is visible for running.By default tools are
visible.The max-targets attribute specifies the maximum number
of targets against which a tool can run.The revision attribute
allows a tool author to specify a revision for the tool.Note
that this is for information only.The job-log attribute
specifies whether the results of the command will be kept in this
systems job log.When job-log="true" the job and target status
for the tool will be kept for a relatively lengthy system-defined
period in the database after the job completes.When
job-log="false" only the last completed copy of the job and
target status for the tool will be kept in the cache for a much
shorter period of time, and will not be written to the database.
Job logging is enabled by default.The schedulable attribute
specifies whether the tool can be run as a scheduled task.When
schedulable="false" the tool can only run as a "run now" task.
Tools are schedulable by default.The guid attribute specifies a
globally unique identifier (GUID) for the tool.Because the
system generates a GUID for a tool during the add operation, this
field should only be specified during a modify operation.The
accepts-targets attribute specifies whether the tool
accepts targets for execution.The accepts-targets attribute is
true by default. -->

<!ATTLIST msa-command-tool name	     CDATA   #REQUIRED
visible     (true | false) "true"
max-targets NMTOKEN #IMPLIED
revision    CDATA   #IMPLIED
job-log     (true | false) "true"
schedulable (true | false) "true"
guid	     NMTOKEN #IMPLIED
accepts-targets (true|false) "true" >

<!-- The msa-block specifies the elements specific to a
multiple-system aware (MSA) tool.The msa-block can specify an
MSA command, the parameters for the command and an execution system
on which the command executes. -->
      
<!ELEMENT msa-block ( command, parameter*, execution-system ) >

<!-- The command element specifies the command for an SSA or an MSA
tool.If the command accepts parameters, it must be specified as
a parameterized string. -->
     
<!ELEMENT command ( #PCDATA ) >

<!-- The command element can have two attributes.The command-type
attribute specifies whether the command is an x-window, stdout,
restart, launch, or an unknown command type.The default command
type is stdout.The log attribute specifies whether the results
of the command will be output to this system's audit log.When
log="true" the stdout and stderr results of the command will be
output to the system's audit log.Command output is not logged
by default. -->
      
<!ATTLIST command command-type (x-window |
stdout   |
restart  |
launch   |
unknown) "stdout"
log (true | false) "false" >

<!-- The execution-system element specifies the system on which an MSA
tool will execute. -->
      
<!ELEMENT execution-system ( #PCDATA ) >

<!-- The web-launch-tool element specifies a web launch tool.The
web-launch-tool element can optionally specify a category
element, a description element, a comment element, an owner
element, a default-target element, an execute-as-user element, a
job-display-handler element, a toolbox-enabled element, zero or
more toolbox elements,  zero or more include-filter elements, or
zero or more env-variable elements.
(NOTE:The role-enabled and role elements are deprecated
elements and should not be used with this product.These
are provided for backward compatibility with previous
products.The toolbox-enabled element and the toolbox
element should be used in their stead.)
If more than one of these elements are specified, the element
must appear in the order as listed in this definition.The
web-launch-tool element must contain a web-block element.The
web-block element must appear after the previously described
optional elements, if any of the optional elements are
specified.Following the web-block element, one can specify zero
or more attribute elements.-->
      
<!ELEMENT web-launch-tool (category?, description?, comment?, owner?,
default-target?, execute-as-user?,
job-display-handler?,
toolbox-enabled?, toolbox*,
role-enabled?, role*,
include-filter*, web-block, attribute* ) >

<!-- In addition to the previously described elements, the
web-launch-tool element specifies the following attributes.The
name attribute specifies the tool name and must be specified in
the web-launch-tool element.The visible attribute specifies
whether the tool is visible for running.By default tools are
visible.The max-targets attribute specifies the maximum number
of targets against which a tool can run.The revision attribute
allows a tool author to specified a revision for the tool.Note
that this is for information only.The job-log attribute
specifies whether the results of the command will be kept in this
systems job log.When job-log="true" the job and target status
for the tool will be kept for a relatively lengthy system-defined
period in the database after the job completes.When
job-log="false" only the last completed copy of the job and
target status for the tool will be kept in the cache for a much
shorter period of time, and will not be written to the database.
Job logging is enabled by default.The schedulable attribute
specifies whether the tool can be run as a scheduled task.When
schedulable="false" the tool can only run as a "run now" task.
Tools are schedulable by default.The guid attribute specifies a
globally unique identifier (GUID) for the tool.Because the
system generates a GUID for a tool during the add operation, this
field should only be specified during a modify operation. -->

<!ATTLIST web-launch-tool name	    CDATA   #REQUIRED
visible	    (true | false) "true"
max-targets NMTOKEN #IMPLIED
revision    NMTOKEN #IMPLIED
job-log	    (true | false) "true"
schedulable (true | false) "true"
guid	    NMTOKEN #IMPLIED >

<!-- The web-block specifies the elements specific to a web launch
tool.The web-block must specify a main-url element.Optionally,
the web-block can specify a side-url element, a status-url
element, and a current-url element.Additionally, the web-block
can specify the parameters for the URLs.Finally, the web-block
can optionally specify a target format to describe how targets
are passed to a Web-launch aware tool. -->
      
<!ELEMENT web-block (main-url, (side-url?, status-url?, current-url?),
parameter*, target-format? ) >

<!-- In addition to the above elements, the web-block element has one
attribute.The accepts-targets attribute specifies whether the
web launch tool accepts targets for execution.The
accepts-targets attribute is true by default. -->
      
<!ATTLIST web-block accepts-targets (true|false) "true">

<!-- The main-url specifies the URL to launch the tool.If the URL
accepts parameters, the URL must be specified as a parameterized
string. -->
      
<!ELEMENT main-url ( #PCDATA ) >

<!-- The status-url specifies a URL at which one might find the status
of this web launch tool during execution. -->
      
<!ELEMENT status-url ( #PCDATA ) >

<!-- The current-url specifies the current URL. -->

<!ELEMENT current-url ( #PCDATA ) >

<!-- The side-url specifies a set-aside URL. -->

<!ELEMENT side-url ( #PCDATA ) >

<!-- The target-format defines the format of targets in a web launch
tool and is specified as a parameterized string.-->
      
<!ELEMENT target-format ( #PCDATA ) >

<!-- The automation tool performs an action on the CMS which
involves accessing the target systems.The automation-tool element
can optionally specify a category element, a menu-category
element, a description element, a comment element, an owner
element, a default-target element, an execute-as-user element, a
job-display-handler element, a default-parameter element, a
role-enabled element, zero or more  role elements,  zero or more
include-filter elements, or zero or more env-variable elements.
If more than one of these elements are specified, the element
must appear in the order as listed in this definition.The
automation-tool element must contain an automation-block element.
The automation-block element must appear after the previously
described optional elements, if any of the optional elements are
specified.Following the automation-block element, one can
specify zero or more attribute elements. -->
      
<!ELEMENT automation-tool (category?, description?, comment?, owner?,
default-target?, execute-as-user?,
job-display-handler?,
toolbox-enabled?, toolbox*,
role-enabled?, role*,
include-filter*, automation-block,
attribute* ) >

<!-- In addition to the previously described elements, the
automation-tool element specifies the following attributes.The
name attribute specifies the tool name and must be specified in
the automation-tool element.The visible attribute specifies
whether the tool is visible for running.By default tools are
visible.The max-targets attribute specifies the maximum number
of targets against which a tool can run.The revision attribute
allows a tool author to specify a revision for the tool.Note
that this is for information only.The job-log attribute
specifies whether the results of the command will be kept in this
systems job log.When job-log="true" the job and target status
for the tool will be kept for a relatively lengthy system-defined
period in the database after the job completes.When
job-log="false" only the last completed copy of the job and
target status for the tool will be kept in the cache for a much
shorter period of time, and will not be written to the database.
Job logging is enabled by default.The schedulable attribute
specifies whether the tool can be run as a scheduled task.When
schedulable="false" the tool can only run as a "run now" task.
Tools are schedulable by default.The guid attribute specifies a
globally unique identifier (GUID) for the tool.Because the
system generates a GUID for a tool during the add operation, this
field should only be specified during a modify operation.The
accepts-targets attribute specifies whether the tool
accepts targets for execution.The accepts-targets attribute is
true by default. -->
      
!ATTLIST automation-tool	 name	     CDATA   #REQUIRED
visible     (true | false) "true"
max-targets NMTOKEN #IMPLIED
revision    CDATA   #IMPLIED
job-log     (true | false) "true"
schedulable (true | false) "true"
guid	     NMTOKEN #IMPLIED
accepts-targets (true|false) "true" >

<!-- The automation-block specifies the elements specific to an
automation tool.The automation-block must specify a
message-id. -->
      
<!ELEMENT automation-block (message-id) >

<!-- The message-id is the internal string representation of the message
sent by the Automation engine to cause the tool to run. -->
      
<!ELEMENT message-id ( #PCDATA ) >

<!-- The app-launch-tool element specifies an application launch
tool.The app-launch-tool element can optionally specify a
category element, a menu-category element, a description element,
a comment element, an owner element, a default-target element, an
execute-as-user element, a job-display-handler element, a
default-parameter element, a role-enabled element, zero or more
role elements,  zero or more include-filter elements, or zero or
more env-variable elements.If more than one of these elements
are specified, the element must appear in the order as listed in
this definition.The app-launch-tool element must contain an
app-launch-block element.The app-launch-block element must
appear after the previously described optional elements, if any
of the optional elements are specified.Following the
app-launch-block element, one can specify zero or more attribute
elements. -->

<!ELEMENT app-launch-tool (category?, description?, comment?, owner?,
default-target?, execute-as-user?,
job-display-handler?,
role-enabled?, role*,
toolbox-enabled?, toolbox*,
include-filter*, env-variable*,
app-launch-block, attribute* ) >

<!-- In addition to the previously described elements, the
app-launch-tool element specifies the following attributes.The
name attribute specifies the tool name and must be specified in
the app-launch-tool element.The visible attribute specifies
whether the tool is visible for running.By default tools are
visible.The max-targets attribute specifies the maximum number
of targets against which a tool can run.The revision attribute
allows a tool author to specify a revision for the tool.Note
that this is for information only.The job-log attribute
specifies whether the results of the command will be kept in this
systems job log.When job-log="true" the job and target status
for the tool will be kept for a relatively lengthy system-defined
period in the database after the job completes.When
job-log="false" only the last completed copy of the job and
target status for the tool will be kept in the cache for a much
shorter period of time, and will not be written to the database.
Job logging is enabled by default.The schedulable attribute
specifies whether the tool can be run as a scheduled task.When
schedulable="false" the tool can only run as a "run now" task.
Tools are schedulable by default.The guid attribute specifies a
globally unique identifier (GUID) for the tool.Because the
system generates a GUID for a tool during the add operation, this
field should only be specified during a modify operation.The
accepts-targets attribute specifies whether the tool
accepts targets for execution.The accepts-targets attribute is
true by default. -->

<!ATTLIST app-launch-tool	 name	     CDATA   #REQUIRED
visible     (true | false) "true"
max-targets NMTOKEN #IMPLIED
revision    CDATA   #IMPLIED
job-log     (true | false) "true"
schedulable (true | false) "true"
guid	     NMTOKEN #IMPLIED
accepts-targets (true|false) "true" >

<!-- The app-launch-block specifies the elements specific to an
application launch tool.The app-launch-block specifies a
required command element. -->
      
<!ELEMENT app-launch-block (command, app-parameters?) >

<!-- In addition to the previously described elements, the
app-launch-block element specifies the following attribute.The
alert-driven attribute specifies whether the alert list or the
system list is used to determine the target systems to run the tool
on. -->

<!ATTLIST app-launch-block alert-driven (true | false) "false" >

<!-- The app-parameters element is an application parameters
definition string whose value is a string -->
      
<!ELEMENT app-parameters ( #PCDATA ) >

<!-- The env-variable element is an environment variable definition
string whose value is a string -->
      
<!ELEMENT env-variable ( #PCDATA ) >

<!-- In addition to the previously described elements, the
env-variable element specifies the following attribute.The
name attribute specifies the name of the environment variable.-->
      
<!ATTLIST env-variable name CDATA #REQUIRED >

<!-- The owner element specifies the tool owner.When the owner field
is specified, the tool is only associated with the All Tools toolbox.
When the owner field is not specified, tool is enabled in all
of its associated toolboxes.When a limited-rights user adds or
modifies a tool, the owner field contains the name of the
limited-rights user.Only a full-rights user can add or modify a
tool without the owner specified. -->
      
<!ELEMENT owner ( #PCDATA ) >

!-- The comment field specifies additional information about the
tool.It is usually more verbose that the description. -->

<!ELEMENT comment ( #PCDATA ) >

<!-- The parameter element specifies the first to the tenth parameter
of a tool. -->
     
<!ELEMENT parameter EMPTY >

<!-- The parameter element has three attributes.The index attributes
specifies which argument in a parameterized string this parameter
substitutes.Parameters can be indexed from 1 to 10 with a
default index of 1. Tools cannot contain parameters with
duplicate indexes.If more than one parameter in a tool
definition contains the same index, only the first parameter added
to the tool with the duplicate index remains in the tool.The
prompt attribute provides information about the parameter that
can be displayed in a GUI for assistance.The required attribute
specifies whether this parameter must be specified when the tool
is executed.By default, parameters are not required.The private
attribute specifies whether this parameter is encoded and stored
securely.By default, parameters are not private. -->
<!ATTLIST parameter index	 (1|2|3|4|5|6|7|8|9|10) "1"
prompt CDATA #REQUIRED
required (true|false) "false"
private (true|false) "false" >

<!-- The toolbox-enabled element specifies whether the toolboxes
associated with a tool are enabled. -->

<!ELEMENT parameter EMPTY >

<!-- The toolbox-enabled element has one attribute.The value
attribute specifies whether the tool within the toolboxes is enabled.
This allows a full-rights user to explicitly disable the tools in
a toolbox though the tool is always enabled in the All Tools
toolbox.By default, the tool is enabled in all the toolboxes that
it is in.  If a tool is disabled within a toolbox, it cannot be
executed. -->
      
<!ATTLIST toolbox-enabled value (true|false) "true">

<!-- The role-enabled element specifies whether the roles associated
with a tool are enabled.This is an obsolete element.The
toolbox-enabled element should be used instead.-->
      
<!ELEMENT role-enabled EMPTY >

<!-- See description of toolbox-enabled element attributes. -->

<!ATTLIST role-enabled value (true|false) "true">

<!-- The default-target element specifies a target on which the tool
can run if no targets are specified at run time.One can specify
a system, &amp;cms2; to run on the &amp;cms2; by default, or ALL to run on all
authorized systems by default. -->
      
<!ELEMENT default-target ( #PCDATA ) >

<!-- The category element specifies the category with which to
associate the tool.By default, tools are associated with the
"Local Tools" category. -->

<!ELEMENT category ( #PCDATA ) >

<!-- The description element specifies a simple description of the
tool.To specify more verbose information such as how to run the
tool, use the comment element. -->

<!ELEMENT description ( #PCDATA ) >

<!-- For SSA and MSA command tools, the execute-as-user element
specifies the user name that the tool runs as or under whose
account the tool runs on the target systems.For Web-launch
tools the execute-as-user is passed to the URL for its use. -->

<!ELEMENT execute-as-user ( #PCDATA ) >

<!-- The job display hander element specifies the fully-qualified
name of a class implementing the JobDisplayHander interface,
used to display the results of a job created by running this
tool. -->

<!ELEMENT job-display-handler ( #PCDATA ) >

<!-- The toolbox element specifies a toolbox to associate with the
tool.To run a tool the user must be authorized with one of the
specified toolboxes. -->

<!ELEMENT toolbox EMPTY >

<!-- The toolbox element has one attribute to specify the toolbox
name. -->

<!ATTLIST toolbox toolbox-name CDATA #REQUIRED >

<!-- The role element specifies a role to associate with the tool.To
run a tool the user must be authorized with one of the specified
roles.This element is obsolete.The toolbox element should be
used instead. -->

<!ELEMENT role EMPTY >

<!-- See the toolbox element attribute description. -->

<!ATTLIST role role-name CDATA #REQUIRED >

<!-- The include-filter element specifies system attributes against
which to filter a tool for execution.A specified include-filter
element must contain one or more system-filter elements.When
filtering a tool each include-filter block is OR'd together to
get the final filter result.Each system-filter element within an
include-filter block is AND'd together. -->
      
<!ELEMENT include-filter (system-filter)+ >

<!-- The include-filter elements has one attribute.The type attribute
specifies the type of include filter to execute.Four types are
currently recognized.Three of them are os (operating system), 
hardware, protocol filtering.The fourth type is called other which 
will allow all other system attributes to be filtered upon.-->

<!ATTLIST include-filter type (os | hardware | protocol | other) "os" >

<!-- The system-filter element is an empty element that contains
attributes used to specify the system attributes against which to
filter a tool for execution. -->
      
<!ELEMENT system-filter EMPTY >

<!-- The system-filter element is specified with three attributes.The
name attribute specifies the system attribute name to filter
against.The operator attribute specifies whether to filter
against an equal value, a less than value, a greater than or
equal value, a contains value, a not equals value or a not
contains value.The operator name is case-insensitive.The
value attribute specifies the value of the system attribute to
filter against. -->
      
<!ATTLIST node-filter name CDATA #REQUIRED
operator (EQ | GE | LT | CT | NEQ | NCT |
eq | ge | lt | ct | neq | nct |
Eq | Ge | Lt | Ct | Neq | Nct |
eQ | gE | lT | cT | nEQ | nCT ) "EQ"
value CDATA #REQUIRED >

<!-- The attribute element specifies the name value pairs that
comprise client attributes.The client attribute name is
specified using the name attribute and the client attribute value
is specified as the PCDATA of the element. -->

<!ELEMENT attribute ( #PCDATA ) >

<!ATTLIST attribute name CDATA #REQUIRED >
			

相關程序

 自訂工具 - 移除與回復自訂工具
 自訂工具 - 編輯 CMS 工具
 自訂工具 - 編輯遠端工具
 自訂工具 - 編輯網頁工具

相關主題

 擴充管理的工具 - 命令行工具