JP1 Version 12　JP1/Automatic Operation サービステンプレートリファレンス

3021-3-D07-40

前書き

対象製品

P-2A2C-E1CL JP1/Automatic Operation 12-60（適用OS：Windows Server 2012，Windows Server 2012 R2，Windows Server 2016，Windows Server 2019，Windows Server 2022）

製品構成一覧および内訳形名

・P-CC2A2C-EACL JP1/Automatic Operation - Server 12-60（適用OS：Windows Server 2012，Windows Server 2012 R2，Windows Server 2016，Windows Server 2019，Windows Server 2022）

・P-CC2A2C-EBCL JP1/Automatic Operation - Contents 12-60（適用OS：Windows Server 2012，Windows Server 2012 R2，Windows Server 2016，Windows Server 2019，Windows Server 2022）

P-2A2C-E3CL JP1/Automatic Operation Content Pack 12-60（適用OS：Windows Server 2012，Windows Server 2012 R2，Windows Server 2016，Windows Server 2019，Windows Server 2022）

P-822C-E1CL JP1/Automatic Operation 12-60（適用OS：Red Hat Enterprise Linux 6 (x64)，Red Hat Enterprise Linux 7，Oracle Linux 6 (x64)，Oracle Linux 7，CentOS 6 (x64)，CentOS 7，SUSE Linux 12）

製品構成一覧および内訳形名

・P-CC822C-EACL JP1/Automatic Operation - Server 12-60（適用OS：Red Hat Enterprise Linux 6 (x64)，Red Hat Enterprise Linux 7，Oracle Linux 6 (x64)，Oracle Linux 7，CentOS 6 (x64)，CentOS 7，SUSE Linux 12）

・P-CC822C-EBCL JP1/Automatic Operation - Contents 12-60（適用OS：Red Hat Enterprise Linux 6 (x64)，Red Hat Enterprise Linux 7，Oracle Linux 6 (x64)，Oracle Linux 7，CentOS 6 (x64)，CentOS 7，SUSE Linux 12）

P-862C-E1CL JP1/Automatic Operation 12-60（適用OS：Red Hat Enterprise Linux 8，Oracle Linux 8，CentOS 8）

製品構成一覧および内訳形名

・P-CC862C-EACL JP1/Automatic Operation - Server 12-60（適用OS：Red Hat Enterprise Linux 8，Oracle Linux 8，CentOS 8）

・P-CC822C-EBCL JP1/Automatic Operation - Contents 12-60（適用OS：Red Hat Enterprise Linux 8，Oracle Linux 8，CentOS 8）

P-822C-E3CL JP1/Automatic Operation Content Pack 12-60（適用OS：Red Hat Enterprise Linux 6 (x64)，Red Hat Enterprise Linux 7，Red Hat Enterprise Linux 8，Oracle Linux 6 (x64)，Oracle Linux 7，Oracle Linux 8，CentOS 6 (x64)，CentOS 7，CentOS 8，SUSE Linux 12）

輸出時の注意

本製品を輸出される場合には、外国為替及び外国貿易法の規制並びに米国輸出管理規則など外国の輸出関連法規をご確認の上、必要な手続きをお取りください。

なお、不明な場合は、弊社担当営業にお問い合わせください。

商標類

HITACHI，JP1は，株式会社 日立製作所の商標または登録商標です。

Accessは，マイクロソフト 企業グループの商標です。

Active Directoryは，マイクロソフト 企業グループの商標です。

AIXは，世界の多くの国で登録されたInternational Business Machines Corporationの商標です。

Amazon Web Services，『Powered by Amazon Web Services』ロゴ，Amazon EC2は，米国および/またはその他の諸国における，Amazon.com, Inc.またはその関連会社の商標です。

Amazon Web Services，『Powered by Amazon Web Services』ロゴ，AWSは，米国および/またはその他の諸国における，Amazon.com, Inc.またはその関連会社の商標です。

Excelは，マイクロソフト 企業グループの商標です。

Hyper-Vは，マイクロソフト 企業グループの商標です。

Intelは，Intel Corporation またはその子会社の商標です。

Internet Explorerは，マイクロソフト 企業グループの商標です。

Linuxは，Linus Torvalds氏の日本およびその他の国における登録商標または商標です。

Microsoft は，マイクロソフト企業グループの商標です。

OpenStackの文字表記とOpenStackのロゴは，米国とその他の国におけるOpenStack Foundationの登録商標/サービスマークまたは商標/サービスマークのいずれかであり，OpenStack Foundationの許諾を得て使用しています。日立製作所は，OpenStack FoundationやOpenStackコミュニティの関連企業ではなく，また支援や出資を受けていません。

PowerShellは，マイクロソフト 企業グループの商標です。

Red Hat is a registered trademark of Red Hat, Inc. in the United States and other countries.

Red Hatは，米国およびその他の国におけるRed Hat, Inc.の登録商標です。

Red Hat Enterprise Linux is a registered trademark of Red Hat, Inc. in the United States and other countries.

Red Hat Enterprise Linuxは，米国およびその他の国におけるRed Hat, Inc.の登録商標です。

すべてのSPARC商標は，米国SPARC International, Inc. のライセンスを受けて使用している同社の米国およびその他の国における商標または登録商標です。SPARC商標がついた製品は，米国Sun Microsystems, Inc. が開発したアーキテクチャに基づくものです。

UNIXは，The Open Groupの商標です。

VeritasおよびVeritasロゴは，米国およびその他の国におけるVeritas Technologies LLCまたはその関連会社の商標または登録商標です。

Windowsは，マイクロソフト 企業グループの商標です。

Windows Serverは，マイクロソフト 企業グループの商標です。

RSAおよびBSAFEは，米国EMC コーポレーションの米国およびその他の国における商標または登録商標です。

JP1/Automatic Operationは，米国EMC コーポレーションのRSA BSAFE(R)ソフトウェアを搭載しています。

This product includes software developed by Ben Laurie for use in the Apache-SSL HTTP server project.

Portions of this software were developed at the National Center for Supercomputing Applications (NCSA) at the University of Illinois at Urbana-Champaign.

This product includes software developed by the University of California, Berkeley and its contributors.

This software contains code derived from the RSA Data Security Inc. MD5 Message-Digest Algorithm, including various modifications by Spyglass Inc., Carnegie Mellon University, and Bell Communications Research, Inc (Bellcore).

Regular expression support is provided by the PCRE library package, which is open source software, written by Philip Hazel, and copyright by the University of Cambridge, England. The original software is available from ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/

This product includes software developed by Ralf S. Engelschall <rse@engelschall.com> for use in the mod_ssl project (http://www.modssl.org/).

1. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. (http://www.openssl.org/)

2. This product includes cryptographic software written by Eric Young (eay@cryptsoft.com)

3. This product includes software written by Tim Hudson (tjh@cryptsoft.com)

4. 本製品にはOpenSSL ToolkitソフトウェアをOpenSSL LicenseおよびOriginal SSLeay Licenseに従い使用しています。OpenSSL LicenseおよびOriginal SSLeay Licenseは以下のとおりです。

LICENSE ISSUES

==============

The OpenSSL toolkit stays under a dual license, i.e. both the conditions of

the OpenSSL License and the original SSLeay license apply to the toolkit.

See below for the actual license texts. Actually both licenses are BSD-style

Open Source licenses. In case of any license issues related to OpenSSL

please contact openssl-core@openssl.org.

OpenSSL License

---------------

/* ====================================================================

* Copyright (c) 1998-2016 The OpenSSL Project. All rights reserved.

*

* Redistribution and use in source and binary forms, with or without

* modification, are permitted provided that the following conditions

* are met:

*

* 1. Redistributions of source code must retain the above copyright

* notice, this list of conditions and the following disclaimer.

*

* 2. Redistributions in binary form must reproduce the above copyright

* notice, this list of conditions and the following disclaimer in

* the documentation and/or other materials provided with the

* distribution.

*

* 3. All advertising materials mentioning features or use of this

* software must display the following acknowledgment:

* "This product includes software developed by the OpenSSL Project

* for use in the OpenSSL Toolkit. (http://www.openssl.org/)"

*

* 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to

* endorse or promote products derived from this software without

* prior written permission. For written permission, please contact

* openssl-core@openssl.org.

*

* 5. Products derived from this software may not be called "OpenSSL"

* nor may "OpenSSL" appear in their names without prior written

* permission of the OpenSSL Project.

*

* 6. Redistributions of any form whatsoever must retain the following

* acknowledgment:

* "This product includes software developed by the OpenSSL Project

* for use in the OpenSSL Toolkit (http://www.openssl.org/)"

*

* THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY

* EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR

* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT

* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,

* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED

* OF THE POSSIBILITY OF SUCH DAMAGE.

* ====================================================================

*

* This product includes cryptographic software written by Eric Young

* (eay@cryptsoft.com). This product includes software written by Tim

* Hudson (tjh@cryptsoft.com).

*

*/

Original SSLeay License

-----------------------

/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)

* All rights reserved.

*

* This package is an SSL implementation written

* by Eric Young (eay@cryptsoft.com).

* The implementation was written so as to conform with Netscapes SSL.

*

* This library is free for commercial and non-commercial use as long as

* the following conditions are aheared to. The following conditions

* apply to all code found in this distribution, be it the RC4, RSA,

* lhash, DES, etc., code; not just the SSL code. The SSL documentation

* included with this distribution is covered by the same copyright terms

* except that the holder is Tim Hudson (tjh@cryptsoft.com).

*

* Copyright remains Eric Young's, and as such any Copyright notices in

* the code are not to be removed.

* If this package is used in a product, Eric Young should be given attribution

* as the author of the parts of the library used.

* This can be in the form of a textual message at program startup or

* in documentation (online or textual) provided with the package.

*

* Redistribution and use in source and binary forms, with or without

* modification, are permitted provided that the following conditions

* are met:

* 1. Redistributions of source code must retain the copyright

* notice, this list of conditions and the following disclaimer.

* 2. Redistributions in binary form must reproduce the above copyright

* notice, this list of conditions and the following disclaimer in the

* documentation and/or other materials provided with the distribution.

* 3. All advertising materials mentioning features or use of this software

* must display the following acknowledgement:

* "This product includes cryptographic software written by

* Eric Young (eay@cryptsoft.com)"

* The word 'cryptographic' can be left out if the rouines from the library

* being used are not cryptographic related :-).

* 4. If you include any Windows specific code (or a derivative thereof) from

* the apps directory (application code) you must include an acknowledgement:

* "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"

*

* THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND

* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE

* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS

* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY

* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

* SUCH DAMAGE.

*

* The licence and distribution terms for any publically available version or

* derivative of this code cannot be changed. i.e. this code cannot simply be

* copied and put under another distribution licence

* [including the GNU Public Licence.]

*/

OracleとJavaは，Oracle Corporation 及びその子会社，関連会社の米国及びその他の国における登録商標です。

This product includes software developed by the Apache Software Foundation (http://www.apache.org/).

This product includes software developed by IAIK of Graz University of Technology.

This product includes software developed by Daisuke Okajima and Kohsuke Kawaguchi (http://relaxngcc.sf.net/).

This product includes software developed by the Java Apache Project for use in the Apache JServ servlet engine project (http://java.apache.org/).

This product includes software developed by Andy Clark.

Java is a registered trademark of Oracle and/or its affiliates.

その他記載の会社名，製品名などは，それぞれの会社の商標もしくは登録商標です。

発行

2022年3月 3021-3-D07-40

著作権

All Rights Reserved. Copyright (C) 2019, 2022, Hitachi, Ltd.

奥付

マニュアル発行元

株式会社 日立製作所

〒100‒8280　東京都千代田区丸の内一丁目6番6号

変更内容

変更内容（3021-3-D07-40）JP1/Automatic Operation 12-60, JP1/Automatic Operation Content Pack 12-60

追加・変更内容

変更個所

次のサービステンプレートおよび部品において，前提製品としてJP1/VERITAS NetBackup 8.2，8.3，9.0，および9.1を追加した。

JP1（構築）用のサービステンプレート

JP1（運用）用のサービステンプレート

JP1/VERITAS関連の部品

2.4，2.5，4.12

次のサービステンプレートの稼働OSとしてWindows Server 2016 Standard/DatacenterおよびWindows Server 2019 Standard/Datacenterを追加した。

JP1（構築）用のサービステンプレート

JP1（運用）用のサービステンプレート

JP1/VERITAS関連の部品

2.4，2.5，4.12

次のサービステンプレートおよび部品において，前提製品としてJP1/Network Node Manager i 12-10，12-50，および12-60を追加した。

JP1/Cm2の監視対象ノード削除

JP1/Cm2の監視対象ノード追加

監視設定削除

監視設定追加

JP1/Cm2の監視対象ノード一覧取得

NNMiトポロジデータベース内容の出力

監視対象ノード削除

監視対象ノード追加

2.4.3，2.4.5，2.4.10，2.4.12，2.5.12，4.9.1，4.9.2，4.9.3

次のサービステンプレートまたは部品において，監視対象ノード追加における注意事項を変更した。

JP1/Cm2の監視対象ノード追加

監視設定追加

監視対象ノード追加

2.4.5，2.4.12，4.9.3

次のサービステンプレートおよび部品において，稼働OSとしてRed Hat Enterprise Linux Server 8 (64-bit x86_64)を追加した。

JP1/VERITASのインスタントリカバリ実行

JP1/VERITASのインスタントリカバリ終了

JP1/VERITASのバックアップ実行

インスタントリカバリ実行(JP1/VERITAS)

インスタントリカバリ終了(JP1/VERITAS)

バックアップ実行(JP1/VERITAS)

2.5.18，2.5.19，2.5.20，4.12.1，4.12.2，4.12.10

JP1/VERITASのインスタントリカバリ終了サービステンプレートにおいて，次の前提製品およびその稼働OSを追加した。

VMware vCenter Server 7.0

VMware vSphere ESXi 7.0

VMware PowerCLI 11.3.0，12.0.0，12.1.0

Windows Server 2016 Standard/Datacenter

Windows Server 2019 Standard/Datacenter

Red Hat Enterprise Linux Server 7 (64-bit x86_64)

Red Hat Enterprise Linux Server 8 (64-bit x86_64)

2.5.19

次のサービステンプレートおよび部品において，前提製品の稼働OSとしてWindows Server 2012 R2 Standard/Datacenterを追加した。

JP1/VERITASのバックアップ実行

バックアップ実行(JP1/VERITAS)

2.5.20，4.12.10

次のサービステンプレートおよび部品において，インスタンスの前提OSとしてRed Hat Enterprise Linux Server 8 (64-bit x86_64)を追加した。

AWS（構築）用のサービステンプレート

AWS（運用）用のサービステンプレート

AWS関連の部品

3.4，3.5，5.2

次のサービステンプレートおよび部品において，インスタンスの前提OSとしてRed Hat Enterprise Linux Server 8 (64-bit x86_64)およびCentOS 8 (64-bit x86_64)を追加した。

vSphere（構築）用のサービステンプレート

vSphere（運用）用のサービステンプレート

vSphere関連の部品

3.15，3.16，5.11

次の部品の実行対象サーバの使用条件において，プロパティキーcommon.osUserPasswordおよびcommon.osUserPasswordReEnterの必須区分を変更した。

OSユーザーの追加(Windows)

OSユーザーの追加(Windows)(SYSTEM)

4.16.7，4.16.8

次の部品の実行対象サーバの使用条件において，プロパティキーWindows.accountCommentおよびWindows.userCommentの説明を変更した。

OSユーザーの追加(Windows)

OSユーザーの追加(Windows)(SYSTEM)

4.16.7，4.16.8

仮想サーバのスナップショット移動サービステンプレートにおいて，次の仮想サーバの前提OSを追加した。

CentOS 6 (64-bit x86_64)

CentOS 7 (64-bit x86_64)

5.11.34

単なる誤字・脱字などはお断りなく訂正しました。

はじめに

このマニュアルは，JP1/Automatic Operationが提供するサービステンプレートおよび部品について説明したものです。なお，このマニュアルでは，JP1/Automatic OperationをJP1/AOと表記します。

JP1/AOマニュアルの参考情報および用語解説については，マニュアル「JP1/AO 導入・設計ガイド」を参照してください。

対象読者

このマニュアルは，次の方にお読みいただくことを前提に説明しています。

JP1/AOシステムにサービステンプレートを追加する方

サービステンプレートまたは部品の詳細を知りたい方

マイクロソフト製品の表記

このマニュアルでは，マイクロソフト製品の名称を次のように表記しています。

表記

製品名

.NET Framework 3.5

Microsoft(R) .NET Framework 3.5

Active Directory

Microsoft(R) Active Directory

Hyper-V

Windows Server 2008 R2 Hyper-V

Microsoft(R) Windows Server(R) 2008 R2 Hyper-V(R)

Windows Server 2012 Hyper-V

Microsoft(R) Windows Server(R) 2012 Hyper-V(R)

Windows Server 2012 R2 Hyper-V

Microsoft(R) Windows Server(R) 2012 R2 Hyper-V(R)

Windows Server 2016 Hyper-V

Microsoft(R) Windows Server(R) 2016 Hyper-V(R)

Internet Explorer

Windows(R) Internet Explorer(R)

Windows Server 2008 R2

Windows Server 2008 R2 Datacenter

Microsoft(R) Windows Server(R) 2008 R2 Datacenter

Windows Server 2008 R2 Enterprise

Microsoft(R) Windows Server(R) 2008 R2 Enterprise

Windows Server 2008 R2 Standard

Microsoft(R) Windows Server(R) 2008 R2 Standard

Windows Server 2012

Windows Server 2012 Datacenter

Microsoft(R) Windows Server(R) 2012 Datacenter

Windows Server 2012 Standard

Microsoft(R) Windows Server(R) 2012 Standard

Windows Server 2012 R2

Windows Server 2012 R2 Datacenter

Microsoft(R) Windows Server(R) 2012 R2 Datacenter

Windows Server 2012 R2 Standard

Microsoft(R) Windows Server(R) 2012 R2 Standard

Windows Server 2016

Windows Server 2016 Datacenter

Microsoft(R) Windows Server(R) 2016 Datacenter

Windows Server 2016 Standard

Microsoft(R) Windows Server(R) 2016 Standard

Windows Server 2019

Windows Server 2019 Datacenter

Microsoft(R) Windows Server(R) 2019 Datacenter

Windows Server 2019 Standard

Microsoft(R) Windows Server(R) 2019 Standard

Windows Server 2022

Windows Server 2022 Datacenter

Microsoft(R) Windows Server(R) 2022 Datacenter

Windows Server 2022 Standard

Microsoft(R) Windows Server(R) 2022 Standard

Windows Server 2022，Windows Server 2019，Windows Server 2016，Windows Server 2012 R2，Windows Server 2012，およびWindows Server 2008 R2を総称してWindowsと表記することがあります。

マニュアルで使用している書式

このマニュアルで使用する書式について説明します。

書式

説明

文字列

可変の値を示します。

（例）日付はYYYYMMDDの形式で指定します。

［ ］

ウィンドウ，ダイアログボックス，タブ，パネル，メニュー，ボタンなどの画面上の要素名を示します。

［ ］−［ ］

メニューを連続して選択することを示します。

（例） ［ファイル］−［新規作成］を選択します。

上記の例では，［ファイル］メニュー内の［新規作成］を選択することを示します。

「 」

画面などに入力する文字列を示します。

インストール先フォルダの表記

このマニュアルでは，Windows版 JP1/AOのデフォルトのインストール先フォルダを次のように表記しています。

JP1/AOのインストール先フォルダ

システムドライブ¥Program Files¥Hitachi¥JP1AO

共通コンポーネントのインストール先フォルダ

システムドライブ¥Program Files¥Hitachi¥HiCommand¥Base64

なお，Linux版 JP1/AOのインストール先フォルダは次のとおりです。

JP1/AO のインストール先フォルダ

/opt/jp1ao

/var/opt/jp1ao

共通コンポーネントのインストール先フォルダ

/opt/HiCommand/Base64

マニュアルで掲載している画面図

製品の改良などによって，このマニュアルに掲載されている画面はご使用の製品画面と一部異なることがあります。あらかじめご了承ください。

1　サービステンプレートの概要

運用手順を自動化するために必要なサービステンプレートおよび部品について説明します。

この章では，サービステンプレートおよび部品のリファレンスの読み方や，共通の注意事項を説明します。そのため，2章以降を読む前に，この章を参照することをお勧めします。サービステンプレートおよび部品の詳細については，2章以降を参照してください。

1.1　サービステンプレートと部品の種類

JP1/AOが提供するサービステンプレートおよび部品には，次の2つの種類があります。

JP1/AOへの同梱

JP1/AO Content Packでの販売

サービステンプレートおよび部品は，機能ごとに分類されています。

表1‒1　JP1/AOに同梱されるサービステンプレートおよび部品の概要

種類

分類

説明

サービステンプレート

JP1（構築）用のサービステンプレート

JP1製品を設定するためのサービステンプレートです。

JP1（運用）用のサービステンプレート

JP1製品を運用するためのサービステンプレートです。

JP1（レポート）用のサービステンプレート

JP1製品を使用してレポートを作成するためのサービステンプレートです。

JP1（トラブルシューティング）用のサービステンプレート

JP1製品を使用して障害対策するためのサービステンプレートです。

OS（汎用的な処理）用のサービステンプレート

WindowsおよびUNIXと連携し，汎用的な処理をするためのサービステンプレートです。

OS（構築）用のサービステンプレート

WindowsおよびUNIXと連携し，構築するためのサービステンプレートです。

OS（運用）用のサービステンプレート

WindowsおよびUNIXと連携し，運用するためのサービステンプレートです。

部品提供用のサービステンプレート

JP1/AO同梱版コンテンツ部品をインポートするためのサービステンプレートです。インポートされる部品については，「付録A.5　部品提供用のサービステンプレートに含まれる部品一覧」を参照してください。

なお，このサービステンプレートをサービスとして実行することはできません。サービステンプレート開発に使用してください。

基本部品

メールの通知やフローの繰り返し処理など，汎用的な処理の部品です。

コンテンツ部品

Active Directory関連の部品

Active Directoryを操作対象にした部品です。

JP1関連の部品

JP1を操作対象にした部品です。

JP1/AJS関連の部品

JP1/AJS3を操作対象にした部品です。

JP1/Base関連の部品

JP1/Baseを操作対象にした部品です。

JP1/IM関連の部品

JP1/IMを操作対象にした部品です。

JP1/NNMi関連の部品

JP1/Cm2/NNMまたはJP1/Cm2/NNMiを操作対象にした部品です。

JP1/PFM関連の部品

JP1/PFMを操作対象にした部品です。

JP1/SS関連の部品

JP1/IM-SSを操作対象にした部品です。

JP1/VERITAS関連の部品

JP1/VERITASを操作対象にした部品です。

OS関連の部品

WindowsおよびUNIXを操作対象にした部品です。

TELstaff関連の部品

TELstaffを操作対象にした部品です。

UNIX関連の部品

UNIXを操作対象にした部品です。

Windows関連の部品

Windowsを操作対象にした部品です。

表1‒2　JP1/AO Content Packで販売されるサービステンプレートおよび部品の概要

種類

分類

説明

サービステンプレート

AWS（構築）用のサービステンプレート

AWSで仮想サーバを設定するためのサービステンプレートです。

AWS（運用）用のサービステンプレート

AWSで仮想サーバを運用するためのサービステンプレートです。

Hyper-V 2008（構築）用のサービステンプレート

Hyper-V環境（Windows Server 2008 R2）で仮想サーバを設定するためのサービステンプレートです。

Hyper-V 2008（運用）用のサービステンプレート

Hyper-V環境（Windows Server 2008 R2）で仮想サーバを運用するためのサービステンプレートです。

Hyper-V 2012（構築）用のサービステンプレート

Hyper-V環境（Windows Server 2012およびWindows Server 2012 R2）で仮想サーバを設定するためのサービステンプレートです。

Hyper-V 2012（運用）用のサービステンプレート

Hyper-V環境（Windows Server 2012およびWindows Server 2012 R2）で仮想サーバを運用するためのサービステンプレートです。

Hyper-V 2016（構築）用のサービステンプレート

Hyper-V環境（Windows Server 2016）で仮想サーバを設定するためのサービステンプレートです。

Hyper-V 2016（運用）用のサービステンプレート

Hyper-V環境（Windows Server 2016）で仮想サーバを運用するためのサービステンプレートです。

OpenStack（構築）用のサービステンプレート

OpenStack環境で仮想サーバを設定するためのサービステンプレートです。

OpenStack（運用）用のサービステンプレート

OpenStack環境で仮想サーバを運用するためのサービステンプレートです。

OS（構築）用のサービステンプレート

OSの情報を設定するためのサービステンプレートです。

vSphere（構築）用のサービステンプレート

vSphere環境で仮想サーバを設定するためのサービステンプレートです。

vSphere（運用）用のサービステンプレート

vSphere環境で仮想サーバを運用するためのサービステンプレートです。

部品提供用のサービステンプレート

JP1/AO Content Pack版部品をインポートするためのサービステンプレートです。インポートされる部品については，「付録A.5　部品提供用のサービステンプレートに含まれる部品一覧」を参照してください。

なお，このサービステンプレートをサービスとして実行することはできません。サービステンプレート開発に使用してください。

コンテンツ部品

AWS関連の部品

AWSを操作対象にした部品です。

HCS関連の部品

HCSを操作対象にした部品です。

Hyper-V 2008関連の部品

Hyper-V（Windows Server 2008 R2）を操作対象にした部品です。

Hyper-V 2012関連の部品

Hyper-V（Windows Server 2012およびWindows Server 2012 R2）を操作対象にした部品です。

Hyper-V 2016関連の部品

Hyper-V（Windows Server 2016）を操作対象にした部品です。

Linux関連の部品

Linuxを操作対象にした部品です。

OpenStack関連の部品

Openstackを操作対象にした部品です。

Oracle関連の部品

Oracleを操作対象にした部品です。

OS関連の部品

WindowsおよびLinuxを操作対象にした部品です。

vSphere関連の部品

vSphereを操作対象にした部品です。

Windows関連の部品

Windowsを操作対象にした部品です。

関連トピック

2.　JP1/AO同梱版サービステンプレート

3.　JP1/AO Content Pack版サービステンプレート

4.　JP1/AO同梱版部品

5.　JP1/AO Content Pack版部品

1.2　サービステンプレートリファレンスの読み方

2章および3章のサービステンプレートリファレンスの読み方について説明します。

機能

サービステンプレートが提供する機能を説明します。

前提条件

サービスを実行する上で，前提条件がある場合に説明します。

注意事項

サービス実行時の注意事項がある場合に説明します。

実行権限

サービスを実行するために必要な権限を示します。

バージョン

サービステンプレートのバージョンを示します。

タグ

サービステンプレートに設定されているタグを示します。

プロパティ一覧

サービステンプレートのプロパティを示します。次の内容について説明しています。

プロパティグループ

プロパティを分類するグループを示します。プロパティグループが設定されているサービステンプレートの場合だけ説明します。

表1‒3　プロパティ一覧（プロパティグループ）での説明項目

項目

説明

プロパティグループ

プロパティグループの名称を示します。

説明

プロパティグループの説明を示します。

初期表示

プロパティグループに所属するプロパティの一覧が初期表示されるかどうかを示します。

プロパティの概要

JP1/AOの画面で表示される内容や，プロパティの種別などを示します。

表1‒4　プロパティ一覧（プロパティの概要）での説明項目（サービステンプレート）

項目

説明

プロパティキー

サービステンプレートに設定するプロパティのプロパティキーを示します。

プロパティ名

［サービス設定］画面および［サービス実行］画面に表示されるプロパティ名を示します。

説明

［サービス設定］画面および［サービス実行］画面に表示される説明を示します。

入出力種別

プロパティの入出力種別を示します。

入力：入力プロパティ

出力：出力プロパティ

変数：変数

共有設定

プロパティのスコープを示します。

有効：［サービスの入力プロパティ作成］ダイアログボックスまたは［サービスの入力プロパティ編集］ダイアログボックスの「スコープ」で「サービス共有プロパティ」をチェックした状態です。

無効：「サービス共有プロパティ」をチェックしない状態です。

必須区分

プロパティの指定の要否を示します。

○：指定が必須です。

△：省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になる場合があります。各プロパティの「説明」を確認してください。

プロパティグループ

各プロパティが分類されているプロパティグループを示します。

プロパティに指定できる値

入力プロパティに指定できる文字や，リストから選択できる値を示します。

表1‒5　プロパティ一覧（プロパティに指定できる値）での説明項目（サービステンプレート）

項目

説明

プロパティキー

サービステンプレートに設定するプロパティのプロパティキーを示します。

入力可能文字

プロパティに入力できる文字を示します。または，リストから選択できる値を示します。

フロー仕様詳細

サービステンプレートのフロー仕様詳細を示します。

次の内容について説明しています。

表1‒6　フロー仕様詳細での説明項目

項目

説明

階層

フローの階層を示します。

［タスク詳細］画面での表示名※

［タスク詳細］画面での表示名を示します。

ステップ名

［Service Builder Edit］画面の［フロー］タブで表示される各階層のステップ名を示します。

部品

部品名

サービステンプレートで使用している部品名を示します。

説明

その部品の説明を示します。

エラー時の回復方法

その部品でエラーが発生したときの回復方法を示します。

注※

繰り返しフローの場合，［Service Builder Edit］画面の［フロー］タブで表示されないため，「［タスク詳細］画面での表示名」を「処理内容」と表記します。

関連トピック

2.　JP1/AO同梱版サービステンプレート

3.　JP1/AO Content Pack版サービステンプレート

1.4　サービステンプレート共通の注意事項

マニュアル「JP1/AO サービステンプレート開発ガイド」−「サービスプロパティとは」のトピック

1.3　部品リファレンスの読み方

4章および5章の部品リファレンスの読み方について説明します。

機能

部品が提供する機能を説明します。

利用場面

部品を利用する場面の例を説明します。

前提条件

部品を含めたサービスを実行する上で，前提条件がある場合に説明します。

注意事項

部品を含めたサービス実行時の注意事項がある場合に説明します。

実行権限

部品を含めたサービスを実行するために必要な権限を示します。

バージョン

部品のバージョンを示します。

タグ

部品に設定されているタグを示します。

タスクログに表示される部品の名称

タスクログに表示される部品の名称を示します。

戻り値

部品の戻り値を示します。

プロパティ一覧

部品のプロパティを示します。 次の内容について説明しています。

表1‒7　プロパティ一覧での説明項目（部品）

項目

説明

プロパティキー

［部品編集］ダイアログボックスに表示されるプロパティキーを示します。

プロパティ名

［部品編集］ダイアログボックスに表示されるプロパティ名を示します。

説明

プロパティの説明を示します。

デフォルト値

プロパティのデフォルト値を示します。

−：値は設定されていません。

入出力種別

プロパティの入出力種別を示します。

入力：入力プロパティ

出力：出力プロパティ

必須区分

プロパティの指定の要否を示します。

○：指定が必須です。

△：省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になることがあります。各プロパティの「説明」を確認してください。

関連トピック

4.　JP1/AO同梱版部品

5.　JP1/AO Content Pack版部品

1.4　サービステンプレート共通の注意事項

JP1/AOが提供するサービステンプレートについて，共通の注意事項を次に示します。

部品実行時のロケールは，操作対象の機器のOSによって異なります。

Windowsの場合

OSの設定に依存したロケールで実行されます。

UNIXの場合

「LANG=C」のロケールで実行されるサービスを次に示します。また，マルチバイト文字を使用すると文字化けが発生するおそれがあります。

表1‒8　「LANG=C」のロケールで実行されるサービス一覧

分類

サービス

JP1（構築）用のサービステンプレート

監視設定追加

監視設定削除

JP1/Base監視設定追加

JP1/Cm2の監視対象ノード追加

JP1/Cm2の監視対象ノード削除

JP1（運用）用のサービステンプレート

運用ユーザー追加

運用ユーザー変更

運用ユーザー削除

JP1/AJSジョブネット実行登録

JP1/AJSのルートジョブネット移行

JP1イベント取得

JP1/PFM - RMの監視対象一覧取得

JP1/PFMのアラーム情報一覧取得

JP1/PFMのプロセス監視設定一覧取得

JP1/Cm2の監視対象ノード一覧取得

JP1ユーザーの一覧取得

JP1ユーザーマッピング定義取得

JP1/VERITASのバックアップ実行

運用ユーザー一括変更

JP1（レポート）用のサービステンプレート

JP1/PFMのレポート取得

JP1（トラブルシューティング）用のサービステンプレート

JP1/AJS・JP1/Baseログ取得

JP1/IM・JP1/Baseログ取得

JP1イベントの対処状況変更

OS（運用）用のサービステンプレート

OSユーザーの一覧取得

OSユーザーの一覧一括取得

これらのサービス以外は，接続ユーザーのデフォルトのロケールで実行されます。

部品を実行する際に，操作対象機器のOSに，あらかじめインストールされている必要のあるコマンドがあります。詳細はリリースノートを参照してください。

操作対象の機器のOSがUNIXの場合，操作対象の機器からJP1/AOサーバにファイルを転送すると，ファイルはbinary形式で転送されます。そのため，テキストファイルを転送した場合，改行コードはWindows用に変換されません。また，JP1/AOサーバから操作対象の機器にファイルを転送する場合，転送するファイルの改行コードは，操作対象の機器のOSの仕様に合わせてください。

操作対象の機器のOSがWindowsの場合，サービステンプレートのプロパティで出力ファイルを指定するとき，次のファイル名はOSの予約語のため指定しないでください。

CON，PRN，AUX，CLOCK$，NUL，COM0，COM1，COM2，COM3，COM4，COM5， COM6，COM7，COM8，COM9，LPT0，LPT1，LPT2，LPT3，LPT4，LPT5，LPT6， LPT7，LPT8，LPT9

プロパティ名に「（ローカル）」と記載されている場合，JP1/AOサーバのファイルまたはフォルダを指します。また，プロパティ名に「（リモート）」と記載されている場合，操作対象の機器のファイルまたはフォルダを指します。

「メール通知部品」「ユーザー応答待ち部品」を使用してメールを送信するサービスではメールタイトルや本文について，JP1/AOサーバと操作対象の機器で設定している文字セットに互換性がない文字および機種依存文字を使用すると，文字が「?」などに置き換わります。必要に応じて，使用する文字を変更するか，メールのエンコード種別を変更して使用してください。

変換できないおそれのある文字の例

「~」，「¥」，「＼」，「〜」，「‖」，「−」，「¢」，「£」，「¬」

操作対象の機器に接続するには，エージェントレス接続先の定義が必要です。操作対象の機器のOSがWindowsの場合，プロトコルに「Windows」を指定してください。操作対象の機器のOSがUNIXの場合，プロトコルに「SSH」を指定してください。

同じHyper-Vサーバに対して，サービスを同時実行した場合，JP1/AOが実行したコマンドがエラーとなり，タスクが異常終了することがあります。この場合，タスクログに"CommandExitCode:False"が出力され，部品の戻り値が27となります。

JP1/AOが提供しているコンテンツ部品は，root権限に昇格して実行されるよう設定されています。ただし，次の部品はroot権限に昇格しないで，操作対象の機器に接続したユーザーの権限で実行されるよう設定されています。

CSV・Excelのセルデータ更新

CSV・Excelのセルデータ取得

CSV・Excelのデータ分割

OS種別の出力

日時計算

OracleDBインスタンスの起動

OracleDBインスタンスの停止

OracleDBユーザーの削除

OracleDBユーザーの追加(UNIX)

JP1/AOが提供しているサービステンプレートでは，root権限で実行されるコンテンツ部品を使用しています。root権限で実行されるコンテンツ部品は，suコマンドを実行してroot（スーパーユーザー）に昇格しています（root（スーパーユーザー）以外のユーザーには，昇格できません）。

このとき，OSから返されるパスワードプロンプトに，スーパーユーザーのパスワードを入力しています。

そのため，操作対象の機器のOSがUNIXの場合は，以下を行ってください。

操作対象機器で，root昇格を有効にする。

操作対象機器で，root（スーパーユーザー）を有効にする。

操作対象機器で，root（スーパーユーザー）のパスワードを設定する。

エージェントレス接続先定義で，「ユーザーID」にUIDがroot（スーパーユーザー）と同じでないユーザーIDを設定する。

なお，root（スーパーユーザー）自身は設定できます。

エージェントレス接続先定義で，「スーパーユーザーのパスワード」を設定する。

コンテンツ部品の戻り値として，0〜63の範囲外の値が返されることがあります。 0〜63の範囲外の戻り値については，マニュアル「JP1/AO サービステンプレート開発ガイド」−「コンテンツ部品の戻り値について」のトピックを参照してください。

サービステンプレートおよび部品のプロパティに，次の全角記号は入力しないでください。

「—」，「‘」，「’」，「“」，「”」

また，プロパティに改行は入力しないでください。

サービステンプレートのプロパティに指定できる値は，データ型によって異なります。データ型による指定できる値の範囲を次に示します。

なお，プロパティに指定できる値を制限している場合は，その範囲内で指定してください。

stringの場合

1,024文字

integerの場合

-2147483648〜2147483647

doubleの場合

約±4.9×10⁻³²⁴〜±1.7×10³⁰⁸の数値

ただし，指数形式では入力できません。なお，指定する値の有効桁数は15桁までを推奨します。

passwordの場合

1,024文字

compositeの場合

30MB

プロパティの入力値や入力ファイルに外字およびサロゲートペア文字を使用した場合，文字化けが発生したり，正しい文字として処理されなかったりすることがあります。

操作対象の機器とJP1/AOサーバとの間でファイルを転送するサービステンプレートでは， 転送時にエンコードを変換しません。そのため，操作対象の機器とJP1/AOサーバでエンコードが異なる場合，操作対象の機器のエンコードでファイルを参照してください。

VMware vSphere環境における仮想サーバが Red Hat Enterprise Linux Server 7 (64-bit x86_64)の場合，仮想サーバに インストールするVMware Toolsは，open-vm-tools 9.10以降を使用してください。

実行対象サーバのPowerCLIのバージョンがV6.3以降の場合，部品で実行したコマンドレットでタイムアウトが発生し，部品が異常終了する場合があります。回避するには，PowerCLIのSet-PowerCLIConfigurationコマンドレットを実行して，タイムアウト時間を変更してください。コマンドレットの詳細はvSphere PowerCLI Documentationの「Cmdlets Reference」を参照してください。なお，タイムアウトが発生しても，部品の提供する機能はVMware環境では成功している場合があります。そのため，タイムアウト時間を変更してサービステンプレートを再実行した場合，サービステンプレートが異常終了する場合がありますので，再実行する前にVMware環境を確認してください。

発生条件：

次の条件がすべて重なった場合に発生します。

実行対象サーバで稼働するPowerCLIのバージョンがV6.3以降である。

タスクログに以下のメッセージが出力される。

PowerCLI V6.3の場合の出力メッセージ：

操作はタイムアウトになりました。

PowerCLI V6.5の場合の出力メッセージ：

要求チャネルは，応答を待機してから00:05:00後にタイムアウトしました。Requestの呼び出しに渡すタイムアウト値を増やすか，BindingのSendTimeout値を増やしてください。この操作に割り当てられた時間は，より長いタイムアウト時間の一部であった可能性があります。

回避策：

以下を実行します。

PowerShellのプロンプトを起動する。

［スタート］-［VMware］-［VMware vSphere PowerCLI］を実行する。

PowerCLIの設定を確認する。

PowerCLIのプロンプトで以下のコマンドレットを実行する。

PowerCLI C:¥Program Files (x86)¥VMware¥Infrastructure¥vSphere PowerCLI>Get-PowerCLIConfiguration

PowerCLIの設定を変更する。

PowerCLIのプロンプトで以下のコマンドレットを実行する。

PowerCLI C:¥Program Files (x86)¥VMware¥Infrastructure¥vSphere PowerCLI>Set-PowerCLIConfiguration -WebOperationTimeoutSeconds タイムアウト値

注：タイムアウト値の単位は秒。例えば，10分の場合は600を指定します。

JP1/AOにて対象のサービスを実行する。

スクリプトを設定したコンテンツ部品，またはファイル転送部品を実行する場合，SCPにて操作対象機器にファイルを転送します。操作対象の機器は，SCPでファイル転送可能な環境にしてください。なお，操作対象の機器がLinuxで，接続するユーザーの.bashrcで文字列を出力している場合は，SCPに失敗するおそれがあります。

なお，スクリプトを設定したコンテンツ部品は，以下の部品が該当します。

JP1/AO同梱版コンテンツ部品およびJP1/AO Content Pack版コンテンツ部品のうち，以下の部品以外の部品

- サーバのシャットダウン（osShutdownServer）

- サーバの再起動 （osRebootServer）

ユーザーが作成した部品（部品作成時に実行モードにスクリプトを指定した場合）

vSphere関連の部品およびサービステンプレートについて，実行対象サーバ内前提製品の稼働OSがWindows Server 2019の場合，システム内前提製品のJP1/Automatic Operationは12-10-01以降を使用してください。

エージェントレス接続先にSSHやTelnetで接続する場合，接続ユーザーのログインスクリプトに，対話環境が前提であるstty，tty，tset，scriptコマンドなどを記載しないでください。記載されている場合は，ログインスクリプトを変更するか，これらのコマンドを実行しないログインスクリプトを使用するユーザーを新たに作成してください。

2　JP1/AO同梱版サービステンプレート

この章では，JP1/AO同梱版サービステンプレートについて説明します。

2.1　JP1/AO同梱版サービステンプレート一覧

2.1.1　JP1（構築）用のサービステンプレート一覧

項番

サービステンプレート名

機能

システム構成

1

JP1/Base監視設定追加

JP1/Baseのセットアップと監視設定の追加を行います。

−　

2

JP1/Cm2の監視対象ノード削除

JP1/Cm2/NNMiの監視対象から複数のノードを削除します。

−　

3

JP1/Cm2の監視対象ノード追加

JP1/Cm2/NNM(またはJP1/Cm2/NNMi)の監視対象に複数のノードを追加します。

−　

4

JP1/PFMアラーム定義の複製

JP1/PFMのアラーム定義を複製し，バインドします。

−　

5

JP1/VERITASのバックアップポリシー作成

JP1/VERITAS NetBackup環境で，パラメーターシートからVMware形式のバックアップポリシーを作成します。

−　

6

JP1/VERITASのバックアップポリシー作成(SYSTEM)

JP1/VERITAS NetBackup環境で，パラメーターシートからVMware形式のバックアップポリシーを作成します。

−　

7

監視設定削除

JP1/Cm2/NNMiおよびJP1/PFMの監視設定を削除します。

2.3.2　監視設定削除のシステム構成

8

監視設定追加

JP1/Cm2/NNM(またはJP1/Cm2/NNMi)およびJP1/PFMに複数の監視対象サーバを追加します。

2.3.1　監視設定追加のシステム構成

（凡例）

−：ありません。

2.1.2　JP1（運用）用のサービステンプレート一覧

項番

サービステンプレート名

機能

システム構成

1

JP1/AJSジョブネット実行登録

JP1/AJSのジョブネットを実行登録します。

−　

2

JP1/AJSのジョブネット計画確定実行登録

JP1/AJSのジョブネットを計画実行登録，または確定実行登録します。

−　

3

JP1/AJSのジョブネット実行予実績出力

JP1/AJSのジョブネットの実行予実績をファイルに出力します。

−　

4

JP1/AJSのルートジョブネット移行

JP1/AJSのルートジョブネットを移行します。

−　

5

JP1/AJSのルートジョブネット移行(SYSTEM)

JP1/AJSのルートジョブネットを移行します。

−　

6

JP1/AJSのルートジョブネット削除

JP1/AJSのルートジョブネットを削除します。

−　

7

JP1/AJSのルートジョブネット削除(SYSTEM)

JP1/AJSのルートジョブネットを削除します。

−　

8

JP1/Cm2の監視対象ノード一覧取得

JP1/Cm2の監視対象ノード一覧を取得します。

−　

9

JP1/IM-SSの案件情報更新

JP1/IM-SSに登録した案件の案件情報を更新します。

−　

10

JP1/IM-SSの案件登録

JP1/IM-SSに新規案件を登録します。

−　

11

JP1/PFM - RMの監視対象一覧取得

JP1/PFM - RM for Platformの監視対象一覧を取得します。

−　

12

JP1/PFMのアラーム情報一覧取得

JP1/PFM - RMのアラームテーブルの一覧を取得します。

−　

13

JP1/PFMのプロセス監視設定一覧取得

JP1/PFM - Managerに設定しているプロセス監視設定一覧を取得します。

−　

14

JP1/VERITASのインスタントリカバリ実行

JP1/VERITAS NetBackupサーバで仮想サーバのインスタントリカバリジョブを実行し，実行中のインスタントリカバリジョブの詳細リストを出力ファイル(ローカル)に出力します。

−　

15

JP1/VERITASのインスタントリカバリ終了

JP1/VERITAS NetBackupサーバでインスタントリカバリ中の仮想サーバのリストアを行います。

−　

16

JP1/VERITASのバックアップ実行

JP1/VERITAS NetBackupによるバックアップを実行します。

−　

17

JP1/VERITASの仮想マシンリストア実行

JP1/VERITAS NetBackup環境で，仮想マシンのリストアを実行します。

−　

18

JP1イベント取得

JP1/IM - Managerの統合監視DBからJP1イベントを取得します。

−　

19

JP1ユーザーの一覧取得

JP1ユーザーの一覧を取得します。

−　

20

JP1ユーザーマッピング定義取得

JP1ユーザーとOSユーザーマッピング定義を取得します。

−　

21

運用ユーザー一括変更

OSユーザーまたはJP1ユーザーのパスワード変更と，JP1/Baseのパスワード管理情報変更を一括で行います。

−　

22

運用ユーザー一括変更(SYSTEM)

OSユーザーまたはJP1ユーザーのパスワード変更と，JP1/Baseのパスワード管理情報変更を一括で行います。

−　

23

運用ユーザー削除

OSユーザーとJP1ユーザーの登録情報，マッピング情報を削除します。

2.3.5　運用ユーザー削除のシステム構成

24

運用ユーザー削除(SYSTEM)

OSユーザーとJP1ユーザーの登録情報，マッピング情報を削除します。

−　

25

運用ユーザー追加

OSユーザーおよびJP1ユーザーをそれぞれ追加し，マッピング情報を追加します。

2.3.3　運用ユーザー追加のシステム構成

26

運用ユーザー追加(SYSTEM)

OSユーザーおよびJP1ユーザーをそれぞれ追加し，マッピング情報を追加します。

−　

27

運用ユーザー変更

OSユーザーまたはJP1ユーザーのパスワード変更と，JP1/Baseのパスワード管理情報変更を行います。

2.3.4　運用ユーザー変更のシステム構成

28

運用ユーザー変更(SYSTEM)

OSユーザーまたはJP1ユーザーのパスワード変更と，JP1/Baseのパスワード管理情報変更を行います。

−　

（凡例）

−：ありません。

2.1.3　JP1（レポート）用のサービステンプレート一覧

項番

サービステンプレート名

機能

システム構成

1

JP1/PFMのレポート取得

JP1/PFM - Managerで収集したJP1/PFM - RMのレポートを取得します。

−　

（凡例）

−：ありません。

2.1.4　JP1（トラブルシューティング）用のサービステンプレート一覧

項番

サービステンプレート名

機能

システム構成

1

JP1/AJS・JP1/Baseログ取得

JP1/AJSとJP1/Baseのログを取得します。

−　

2

JP1/IM・JP1/Baseログ取得

JP1/IMとJP1/Baseのログを取得します。

−　

3

JP1イベントの対処状況変更

JP1/IM - ManagerのイベントDBに登録されているJP1イベントの対処状況を変更します。

−　

4

JP1イベントの登録

エージェントサーバにJP1イベントを登録します。

−　

（凡例）

−：ありません。

2.1.5　OS（汎用的な処理）用のサービステンプレート一覧

項番

サービステンプレート名

機能

システム構成

1

リモートコマンド実行

リモートの実行対象サーバ上のコマンドを実行します。

−　

（凡例）

−：ありません。

2.1.6　OS（構築）用のサービステンプレート一覧

項番

サービステンプレート名

機能

システム構成

1

Chef Clientの登録

Chef ClientサーバをChef Serverに登録します。

−　

2

Puppet Enterprise Agentの登録

Puppet Enterprise AgentサーバをPuppet Enterprise Masterに登録します。

−　

（凡例）

−：ありません。

2.1.7　OS（運用）用のサービステンプレート一覧

項番

サービステンプレート名

機能

システム構成

1

OSユーザーの一覧一括取得

Windows/UNIXのOSユーザーの一覧を複数のサーバから取得します。

−　

2

OSユーザーの一覧一括取得(SYSTEM)

Windows/UNIXのOSユーザーの一覧を複数のサーバから取得します。

−　

3

OSユーザーの一覧取得

Windows/UNIXのOSユーザーの一覧を取得します。

−　

（凡例）

−：ありません。

2.1.8　部品提供用のサービステンプレート一覧

項番

サービステンプレート名

機能

システム構成

1

Utility Components

サービスの作成およびサービスの実行をしないでください。このサービステンプレートは，サービステンプレート開発者向けの部品を格納したものです。

−　

（凡例）

−：ありません。

2.2　運用・監視用サービステンプレートの使用例

JP1/AO同梱版サービステンプレートでは，JP1製品の運用および監視をするために必要なサービステンプレートを提供しています。

ここでは，次のサービステンプレートを使用した場合の，想定するシステム構成および指定するプロパティの例について説明します。

監視設定追加

運用ユーザー追加

運用ユーザー一括変更

2.2.1　サービステンプレート「監視設定追加」の使用例

サービステンプレート「監視設定追加」を使用した場合の，想定するシステム構成および指定するプロパティの例について説明します。

このサービステンプレートを使用すると，JP1/Cm2/NNMおよびJP1/PFMに，監視対象の追加，および監視設定ができます。

想定するシステム構成

このサービステンプレートでは，次のシステム構成を想定しています。

Webブラウザー

JP1/AOを操作する端末です。ユーザーは，この端末でサービステンプレートのプロパティ値を設定します。

IT運用自動化サーバ

JP1/AO，およびJP1/Baseがインストールされているサーバです。IT運用自動化サーバのローカルディスク（C:¥temp）に，次の監視用定義ファイルを事前に用意してください。

監視対象の定義ファイル（agent.conf）

エージェント階層定義ファイル（tree.xml）

アプリケーション定義ファイル（process.xml）

記録方法の定義ファイル（parameter.xml）

保存条件の定義ファイル（store.xml）

NNMサーバ

JP1/Cm2/NNMまたはJP1/Cm2/NNMiがインストールされているサーバです。

PFM-RMサーバ

JP1/PFM-RM，およびJP1/PFM - Baseがインストールされているサーバです。

PFM管理サーバ

JP1/PFM - Manager，およびJP1/PFM - Web Consoleがインストールされているサーバです。

ESXサーバ

VMware vSphere ESXi（またはVMware ESX Server）がインストールされているサーバです。監視対象サーバを管理しています。

監視対象サーバ

NNMサーバおよびPFM-RMサーバの監視対象として設定するサーバです。

図2‒1　サービステンプレート「監視設定追加」の想定するシステム構成

処理の流れ

Webブラウザーから，ユーザーがプロパティ値を入力し，サービスを実行します。

IT運用自動化サーバから，PFM管理サーバ，PFM-RMサーバ，およびNNMサーバに自動処理が実行されます。

NNMサーバに，監視対象ノードが追加されます。

PFM-RMサーバに，リモートエージェントが追加されます。

PFM管理サーバに，エージェント階層が設定されます。

追加したリモートエージェントに，次の監視設定が追加されます。

パフォーマンスデータの記録方法

パフォーマンスデータの保存条件

プロセス監視設定

アラームテーブル設定

プロパティ値の指定例

サービステンプレート「監視設定追加」を使用するためには，ユーザーの環境に合わせて，プロパティ値を指定する必要があります。プロパティ値は，［サービス設定］画面および［サービス実行］画面で指定します。

表2‒1　［サービス設定］画面で指定するプロパティ値の例（監視設定追加）

プロパティグループ

プロパティ名

プロパティキー

説明

指定例

監視システム環境情報

NNMサーバのホスト名

jp1cm2nnm.nnmHostName

JP1/Cm2/NNM(またはJP1/Cm2/NNMi)がインストールされているサーバのホスト名を指定します。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

cm2host

PFM管理サーバのホスト名

jp1pfm.pfmHostName

JP1/PFM - ManagerおよびJP1/PFM - Web Consoleがインストールされたサーバのホスト名を指定します。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

pfmhost

PFM-RMサーバのホスト名

jp1pfm.pfmRMHostName

JP1/PFM - RM for Platformがインストールされたサーバのホスト名を指定します。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

pfmrmhost

監視情報

JP1/PFM - RMのインスタンス名

jp1pfm.instance

監視対象サーバのリモートエージェントが属するJP1/PFM - RM for Platformのインスタンス名を指定します。

INST1

監視対象の定義ファイル(ローカル)

jp1pfm.agentDefFileLocal

JP1/AOサーバから転送する監視対象の定義ファイルをフルパスで指定します。

C:¥temp¥agent.txt

監視対象の定義ファイル(リモート)

jp1pfm.agentDefFileRemote

PFM-RMサーバへ監視対象の定義ファイルを転送する際の転送先ファイルパスをフルパスで指定します。

D:¥temp¥agent.txt

オプション監視情報

エージェント階層定義ファイル(ローカル)

jp1pfm.agentLevelDefFileNameLocal

JP1/AOサーバから転送するエージェント階層定義ファイルをフルパスで指定します。指定しなかった場合，転送および設定は実行されません。

C:¥temp¥tree.xml

エージェント階層定義ファイル(リモート)

jp1pfm.agentLevelDefFileNameRemote

PFM管理サーバへエージェント階層定義ファイルを転送する際の転送先ファイルパスをフルパスで指定します。

D:¥temp¥tree.xml

記録方法の定義ファイル(ローカル)

jp1pfm.paramDefFileLocal

JP1/AOサーバから転送する記録方法の定義ファイルをフルパスで指定します。指定しなかった場合，転送および設定は実行されません。

C:¥temp¥param.xml

記録方法の定義ファイル(リモート)

jp1pfm.paramDefFileRemote

PFM管理サーバへ記録方法の定義ファイルを転送する際の転送先ファイルパスをフルパスで指定します。

D:¥temp¥param.xml

保存条件の定義ファイル(ローカル)

jp1pfm.saveConditionDefFileNameLocal

JP1/AOサーバから転送する保存条件の定義ファイル名をフルパスで指定します。指定しなかった場合，転送および設定は実行されません。

C:¥temp¥store.xml

保存条件の定義ファイル(リモート)

jp1pfm.saveConditionDefFileNameRemote

PFM管理サーバに保存条件の定義ファイルを転送する際の転送先ファイルパスをフルパスで指定します。

D:¥temp¥store.xml

アプリケーション定義ファイル(ローカル)

jp1pfm.procMonDefFileLocal

JP1/AOサーバから転送するアプリケーション定義ファイルをフルパスで指定します。指定しなかった場合，転送および設定は実行されません。

C:¥temp¥process.txt

アプリケーション定義ファイル(リモート)

jp1pfm.procMonDefFileRemote

PFM管理サーバへアプリケーション定義ファイルを転送する際の転送先ファイルパスをフルパスで指定します。

D:¥temp¥process.txt

表2‒2　［サービス実行］画面で指定するプロパティ値の例（監視設定追加）

プロパティグループ

プロパティ名

プロパティキー

説明

指定例

監視情報

監視対象サーバのIPアドレス

common.foreachIPaddress

監視対象サーバのIPアドレスを指定します。複数指定する場合はコンマで区切ってください。IPv6アドレスには対応していません。

192.168.1.xx,192.168.1.yy

2.2.2　サービステンプレート「運用ユーザー追加」の使用例

サービステンプレート「運用ユーザー追加」を使用した場合の，想定するシステム構成および指定するプロパティの例について説明します。

このサービステンプレートを使用すると，特定のサーバにOSユーザー，およびそのOSユーザーに関連したJP1ユーザーを追加できます。

想定するシステム構成

このサービステンプレートでは，次のシステム構成を想定しています。

Webブラウザー

JP1/AOを操作する端末です。ユーザーは，この端末でサービステンプレートのプロパティ値を設定します。

IT運用自動化サーバ

JP1/AO，およびJP1/Baseがインストールされているサーバです。IT運用自動化サーバのローカルディスクには，ユーザー権限レベルファイルが格納されています。

認証サーバ

JP1/Baseがインストールされているサーバです。

エージェントサーバ

JP1/Baseがインストールされているサーバです。

想定するシステム構成

図2‒2　サービステンプレート「運用ユーザー追加」の想定するシステム構成

処理の流れ

Webブラウザーから，ユーザーがプロパティ値を入力し，サービスを実行します。

IT運用自動化サーバから，認証サーバ，およびエージェントサーバに自動処理が実行されます。

エージェントサーバに，OSユーザーが追加されます。

JP1認証サーバに，JP1ユーザーとユーザー権限レベルが設定されます。

エージェントサーバに，ユーザーマッピングが設定されます。

プロパティ値の指定例

サービステンプレート「運用ユーザー追加」を使用するためには，ユーザーの環境に合わせて，プロパティ値を指定する必要があります。プロパティ値は，［サービス設定］画面および［サービス実行］画面で指定します。

表2‒3　［サービス設定］画面で指定するプロパティ値の例（運用ユーザー追加）

プロパティグループ

プロパティ名

プロパティキー

説明

指定例

JP1認証サーバ情報

JP1認証サーバのホスト名

jp1base.certHost

JP1認証サーバのホスト名を指定します。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

mgrhost

システム環境情報

JP1/AOサーバの定義ファイル格納フォルダのパス

ao.confPath

JP1認証サーバに転送(設定)する定義ファイルが格納されている，JP1/AOサーバのフォルダをフルパスで指定します。

C:¥ao¥conf

表2‒4　［サービス実行］画面で指定するプロパティ値の例（運用ユーザー追加）

プロパティグループ

プロパティ名

プロパティキー

説明

指定例

システム環境情報

エージェントサーバのホスト名

common.targetHost

エージェントサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

agthost

OSユーザー情報

OSユーザー名

OS.osUserName

エージェントサーバに作成するOSのユーザー名を指定します。

user01

OSユーザーパスワード

OS.osUserPassword

OSユーザーのパスワードを指定します。

*******

OSユーザーのパスワード再入力

OS.osUserPasswordReEnter

OSユーザーのパスワードを再度指定します。

*******

OSユーザーのグループ名

OS.osGroupName

OSユーザーが所属する既存のグループ名を指定します。

Administrators

JP1ユーザー情報

JP1ユーザー名

jp1base.jp1UserName

JP1認証サーバに作成するJP1ユーザー名を指定します。

jp1user01

JP1ユーザーパスワード

jp1base.jp1UserPassword

JP1ユーザーのパスワードを指定します。

*******

JP1ユーザーのパスワード再入力

jp1base.jp1UserPasswordReEnter

JP1ユーザーのパスワードを再度指定します。

*******

マッピング定義のホスト名

jp1base.serverHostName

エージェントサーバのユーザーマッピングに定義する実行ホスト名または「*」を指定します。IPアドレスは指定しないでください。IPアドレスを指定した場合でも，タスクは成功しますのでご注意ください。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

*

2.2.3　サービステンプレート「運用ユーザー一括変更」の使用例

サービステンプレート「運用ユーザー一括変更」を使用した場合の，想定するシステム構成および指定するプロパティの例について説明します。

このサービステンプレートを使用すると，CSV(Comma Separated Values)ファイル，またはMicrosoft Excelによって作成されたユーザーの一覧情報を使用して，OSユーザーのパスワード変更，JP1/Baseのパスワード管理情報の変更，およびJP1ユーザーのパスワード変更を一括で行います。

想定するシステム構成

このサービステンプレートでは，次のシステム構成を想定しています。

Webブラウザー

JP1/AOを操作する端末です。ユーザーは，この端末でサービステンプレートのプロパティ値を設定します。

IT運用自動化サーバ

JP1/AO，およびJP1/Baseがインストールされているサーバです。IT運用自動化サーバのローカルディスクには，ユーザー権限レベルファイルが格納されています。

認証サーバ

JP1/Baseがインストールされているサーバです。

エージェントサーバ

JP1/Baseがインストールされているサーバです。

図2‒3　サービステンプレート「運用ユーザー一括変更」の想定するシステム構成

処理の流れ

Webブラウザーから，ユーザーがプロパティ値を入力し，サービスを実行します。

IT運用自動化サーバは，指定されたプロパティ値のOSユーザー情報ファイル，およびJP1ユーザー情報ファイルを読み込みます。

読み込んだ項目を基に，IT運用自動化サーバからエージェントサーバ，および認証サーバに自動処理が実行されます。

OSユーザー情報ファイルの設定値を基に，エージェントサーバのOSユーザーのパスワードが変更されます。

OSユーザー情報ファイルに「JP1/Baseパスワード管理情報の更新要否」を設定した場合，エージェントサーバのJP1/Baseのパスワード管理情報が変更されます。

JP1ユーザー情報ファイルの設定値を基に，JP1認証サーバのJP1ユーザーのパスワードが変更されます。

プロパティ値の指定例

サービステンプレート「運用ユーザー一括変更」を使用するためには，ユーザーの環境に合わせて，プロパティ値を指定する必要があります。プロパティ値は，［サービス設定］画面および［サービス実行］画面で指定します。

表2‒5　［サービス実行］画面で指定するプロパティ値の例（運用ユーザー一括変更）

プロパティグループ

プロパティ名

プロパティキー

説明

指定例

ユーザー情報ファイルの情報

OSユーザー情報ファイルのパス

OS.osUserInfoFilePath

JP1/AOサーバ上に格納した，OSユーザー情報を記入したファイルのパスをフルパスで指定します。ファイルの拡張子はcsv，xls，xlsx，xlsmのどれかである必要があります。

C:¥ao¥os_user.xls

OSユーザー情報ファイルのシート名

OS.osUserInfoSheetName

OSユーザー情報ファイルがExcelファイルの場合，ユーザー情報が記載されたシート名を必ず指定してください。

Sheet2

JP1ユーザー情報ファイルのパス

jp1base.jp1UserInfoFilePath

JP1/AOサーバ上に格納した，JP1ユーザー情報を記入したファイルのパスをフルパスで指定します。ファイルの拡張子はcsv，xls，xlsx，xlsmのどれかである必要があります。

C:¥ao¥jp1_user.xls

JP1ユーザー情報ファイルのシート名

jp1base.jp1UserInfoSheetName

JP1ユーザー情報ファイルがExcelファイルの場合，ユーザー情報が記載されたシート名を指定してください。JP1ユーザー情報ファイルがExcelファイルの場合には必ず指定してください。

Sheet1

OSユーザー情報ファイルの詳細

OSユーザー情報ファイルのキー情報の列番号

OS.osUserInfoKeyColumn

OSユーザー情報ファイル内の「キー情報」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

7

エージェントサーバのホスト名の列番号

common.targetHostNameColumn

OSユーザー情報ファイル内の「エージェントサーバのホスト名」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

1

エージェントサーバのJP1/Baseの論理ホスト名の列番号

jp1base.jp1BaseLHostNameColumn

OSユーザー情報ファイル内の「エージェントサーバのJP1/Baseの論理ホスト名」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

5

OSユーザー名の列番号

OS.osUserNameColumn

OSユーザー情報ファイル内の「OSユーザー名」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

2

OSユーザーの新パスワードの列番号

OS.osUserNewPasswordColumn

OSユーザー情報ファイル内の「OSユーザーの新パスワード」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

3

OSユーザー種別の列番号

OS.osUserTypeColumn

OSユーザー情報ファイル内の「OSユーザー種別」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

4

JP1/Baseパスワード管理情報の更新要否の列番号

jp1base.updatePasswordInfoColumn

OSユーザー情報ファイル内の「JP1/Baseパスワード管理情報の更新要否」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

6

JP1ユーザー情報ファイルの詳細

JP1ユーザー情報ファイルのキー情報の列番号

jp1base.jp1UserInfoKeyColumn

JP1ユーザー情報ファイル内の「キー情報」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

6

JP1認証サーバのホスト名の列番号

jp1base.certHostNameColumn

JP1ユーザー情報ファイル内の「JP1認証サーバのホスト名」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

1

JP1認証サーバの論理ホスト名の列番号

jp1base.certHostLHostNameColumn

JP1ユーザー情報ファイル内の「JP1認証サーバの論理ホスト名」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

5

JP1ユーザー名の列番号

jp1base.jp1UserNameColumn

JP1ユーザー情報ファイル内の「JP1ユーザー名」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

2

JP1ユーザーの旧パスワードの列番号

jp1base.jp1UserOldPasswordColumn

JP1ユーザー情報ファイル内の「JP1ユーザーの旧パスワード」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

4

JP1ユーザーの新パスワードの列番号

jp1base.jp1UserNewPasswordColumn

JP1ユーザー情報ファイル内の「JP1ユーザーの新パスワード」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

3

プロパティ値とユーザーの一覧情報との関係

プロパティの各項目の列番号を使用して，ユーザーの一覧情報（OSユーザー情報ファイル，およびJP1ユーザー情報ファイル）で読み込む列を指定します。ユーザーの一覧情報には，キー情報の列を必ず作成してください。例えば，既存のユーザー管理台帳などにキー情報の列を追加して記述することで，ユーザーの一覧情報として使用できます。OSユーザー情報ファイルを使用して，OSユーザーのパスワード変更およびJP1/Baseのパスワード管理情報の変更を行う場合を例に説明します。

図2‒4　OSユーザー情報ファイルのマッピング例

ユーザーがプロパティ値を入力し，サービスを実行します。

プロパティ「OSユーザー情報ファイルのパス」，およびプロパティ「OSユーザー情報ファイルのシート名」で指定したファイルのシートが読み込まれます。

プロパティで指定した各項目の列番号が，OSユーザー情報ファイルの読み込む列にマッピングされます。

プロパティ「OSユーザー情報ファイルのキー情報の列番号」に指定された列が参照されます。キー情報が記述されている行を対象に，OSユーザーのパスワード変更，およびJP1/Baseのパスワード管理情報が変更されます。

2.3　JP1/AO同梱版サービステンプレートのシステム構成

次に示すJP1（構築）用のサービステンプレート，およびJP1（運用）用のサービステンプレートのシステム構成について説明します。

JP1（構築）用のサービステンプレート

監視設定追加

監視設定削除

JP1（運用）用のサービステンプレート

運用ユーザー追加

運用ユーザー変更

運用ユーザー削除

2.3.1　監視設定追加のシステム構成

図2‒5　監視設定追加のシステム構成

2.3.2　監視設定削除のシステム構成

図2‒6　監視設定削除のシステム構成

2.3.3　運用ユーザー追加のシステム構成

図2‒7　運用ユーザー追加のシステム構成

2.3.4　運用ユーザー変更のシステム構成

図2‒8　運用ユーザー変更のシステム構成

2.3.5　運用ユーザー削除のシステム構成

図2‒9　運用ユーザー削除のシステム構成

2.4　JP1（構築）用のサービステンプレート

2.4.1　JP1/Base監視設定追加

機能

このサービステンプレートは，JP1/Baseの基本的なセットアップと監視設定を行います。

次の内容の監視を実施する監視システムを想定しています。

・監視対象サーバのJP1/Baseによってイベントログ監視(Windowsだけ)およびアプリケーションログのトラップを実施し，監視結果をJP1/IM – Managerサーバに転送する。

・JP1/IM - Managerサーバからの自動アクションは実施しない。

このサービステンプレートが前提とするサーバを次に示します。

・監視対象サーバ

　イベントログ監視やアプリケーションログ監視を行い，発生したJP1イベントをJP1/IM - Managerへ転送します。

上記監視システムへの監視対象サーバの追加を行った場合に必要となる，次のセットアップを実施します。

(1)Windowsの場合，起動順序定義ファイル(JP1SVPRM.DAT)を設定します。UNIXの場合，自動起動および自動停止スクリプトの設定します。

(2)Windowsファイアウォールへ，次のJP1/Baseプロセスを登録します。

　JP1/BaseのV8.0より後に追加されたプログラム(※)のWindowsファイアウォールへの登録に失敗した場合は，処理をスキップします。

　・jbssessionmgr

　・jbsroute

　・jcocmd

　・jcocmdapi

　・jevservice

　・jbsplugind

　・jbscomd_snd(※)

　・jbscomd_rcv(※)

(3)共通定義情報を設定します。

　JP1/Baseの共通定義情報をjbssetcnfコマンドを使用して設定します。

　jbssetcnfコマンドの引数にはプロパティjp1base.commonDefInfoPathLocalに指定したJP1/AOサーバにあるファイルを，プロパティjp1base.targetCommonDefInfoPathに指定したファイルとして監視対象サーバに転送して使用します。

　プロパティjp1base.targetCommonDefInfoPathとjp1base.commonDefInfoPathLocalの両方を指定した場合に設定します。

(4)転送設定ファイル(forward)を設定します。

(5)イベントログトラップ動作定義ファイル(ntevent.conf)，ログファイルトラップ動作定義ファイル(ファイル名任意)，ログファイルトラップ起動定義ファイル(jevlog_start.conf)，ログ情報定義ファイル(jevlogd.conf)を設定します。

JP1/AOの設定対象とする監視対象サーバは複数指定できます。複数の監視対象サーバを指定する場合は，プロパティcommon.targetHostListに，監視対象サーバのホスト名をコンマで区切って指定してください。99台まで指定できます。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)監視対象サーバに次のJP1/Baseが稼働していること。

JP1/Base 09-00以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【サービステンプレート実行システム内前提製品の使用条件】

(1)監視対象サーバの環境(OS，JP1/Baseのバージョン)に応じて各定義ファイルを用意し，それぞれに対応するサービスを作成してください。

(2)起動順序定義(Windows版JP1/Baseだけ)およびイベント転送設定を行う場合

　JP1/AOサーバに，監視対象サーバに転送する次のファイルを格納し，これらのファイルのパスを，各プロパティに指定してください。

　- 起動順序定義ファイル(jp1svprm.dat) (Windows版だけ) (任意)

　- 転送設定ファイル(forward) (必須)

(3)イベントログトラップの設定を行う場合(Windows版JP1/Baseだけ)

　(2)に示したファイルに加え，JP1/AOサーバに，監視対象サーバに転送する次のファイルを格納し，これらのファイルのパスを，各プロパティに指定してください。

　- イベントログトラップ動作定義ファイル(ntevent.conf) (Windows版だけ) (任意)

(4)ログファイルトラップの設定を行う場合

　(2)に示したファイルに加え，JP1/AOサーバに，監視対象サーバに転送する次のファイルを格納し，これらのファイルのパスを，各プロパティに指定してください。

　- ログファイルトラップ動作定義ファイル(jevlog.conf) (任意)

　- ログファイルトラップ起動定義ファイル(jevlog_start.conf) (任意)

　- ログ情報定義ファイル(jevlogd.conf) (任意)

(5)共通定義情報の設定を行う場合

　(2)に示したファイルに加え，JP1/AOサーバに，監視対象サーバに設定する次のファイルを格納し，これらのファイルのパスを，各プロパティに指定してください。

　- 共通定義設定用ファイル (任意)

　共通定義設定用ファイルは，JP1/Baseのマニュアルに記載されている各設定の形式もしくはモデルファイルを使用して作成してください。

　なお，JP1/Baseではモデルファイルが機能ごとに複数用意されていますが，これを1つのファイルにまとめて作成する必要があります。

(6)すべての設定を行う場合

　JP1/AOサーバに，(2)〜(5)に示したファイルを格納し，これらのファイルのパスを，各プロパティに指定してください。

(7)上記のうち，任意と記載したファイルに対応するプロパティの指定がない場合は，該当ファイルの転送を実施しません。また，プロパティに指定したパスにファイルが存在しない場合は，タスクが異常終了します。

(8)JP1/Baseがクラスタ構成の場合，プロパティcommon.targetHostListに実行系サーバの物理ホストまたは論理ホストを指定してください。

注意事項

(1)このサービスで設定された内容を反映するため，このサービスを実行したあとに，監視対象サーバのリブートを実施してください。

(2)操作対象がJP1/Baseバージョン09-00以前の場合，ログファイルトラップ起動定義ファイル(jevlog_start.conf)の設定はできません。

　必要に応じてJP1/Baseのマニュアルを参照し，ログファイルトラップの自動起動設定を行ってください。

(3)共通定義情報を設定する場合，共通定義設定用ファイルの記述が誤っていても，タスクが正常終了する場合があります。共通定義設定用ファイルに誤りがないか，十分に確認してください。

　誤った共通定義情報を設定した場合，再度正しい共通定義情報を設定しても不要な設定が残る場合は，手動で訂正してください。

(4)JP1/Baseがクラスタ構成の場合，実行系の環境へのサービス実行だけ可能です。待機系のWindowsファイアウォールにはJP1/Baseプロセスが登録されません。手動で設定してください。

(5)JP1/Baseがクラスタ構成の場合，共通定義情報の設定は実行系の環境へのサービス実行だけ可能です。待機系の共通定義情報は設定されません。手動で設定してください。

(6)JP1/Baseがクラスタ構成の場合，共通定義設定用ファイル内に指定した論理ホストと一致する環境へのサービス実行だけ可能です。一致しない環境へサービス実行した場合，タスクは正常終了しますが，監視対象サーバは正しく動作しません。

(7)UNIX環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

(8)監視対象サーバのOSがWindowsでマルチバイト文字を指定する場合は，ファイルのパスの長さは255バイト以内となるよう指定してください。confフォルダのパスの長さは231バイト以内となるように指定してください。

(9)リモートに指定するファイル/フォルダ名がすでに存在する場合，リモートのファイル/フォルダを上書きします。そのため，指定したファイル/フォルダ名に誤りがないか，十分に確認してください。

バージョン

03.01.01

タグ

Configure JP1,Base

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

監視対象サーバ情報

追加する監視対象サーバの環境情報を指定してください。

表示されます。

JP1/Base定義情報

JP1/AOサーバからJP1/Baseに転送する各種定義ファイルを指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1base.jp1svprmPathLocal

JP1/Base起動順序定義ファイルのパス(ローカル)

JP1/AOサーバから転送(設定)するJP1/Baseの起動順序定義ファイル(jp1svprm.dat)のパスをフルパスで指定します。

入力

無効

△　

JP1/Base定義情報

jp1base.forwardPathLocal

JP1/Base転送設定ファイルのパス(ローカル)

JP1/AOサーバから転送(設定)するJP1/Baseの転送設定ファイル(forward)のパスをフルパスで指定します。

入力

無効

○　

JP1/Base定義情報

jp1base.nteventPathLocal

JP1/Baseイベントログトラップ動作定義ファイルのパス(ローカル)

JP1/AOサーバから転送(設定)するJP1/Baseのイベントログトラップ動作定義ファイル(ntevent.conf)のパスをフルパスで指定します。指定しなかった場合，転送は実行されません。

入力

無効

△　

JP1/Base定義情報

jp1base.jevlogPathLocal

JP1/Baseログファイルトラップ動作定義ファイルのパス(ローカル)

JP1/AOサーバから転送(設定)するJP1/Baseのログファイルトラップ動作定義ファイル(jevlog.conf)のパスをフルパスで指定します。指定しなかった場合，転送は実行されません。

入力

無効

△　

JP1/Base定義情報

jp1base.jevlogstartLocal

JP1/Baseログファイルトラップ起動定義ファイルのパス(ローカル)

JP1/AOサーバから転送(設定)するJP1/Baseのログファイルトラップ起動定義ファイル(jevlog_start.conf)のパスをフルパスで指定します。指定しなかった場合，転送は実行されません。

入力

無効

△　

JP1/Base定義情報

jp1base.jevlogdLocal

JP1/Baseログ情報定義ファイルのパス(ローカル)

JP1/AOサーバから転送(設定)するJP1/Baseのログ情報定義ファイル(jevlogd.conf)のパスをフルパスで指定します。指定しなかった場合，転送は実行されません。

入力

無効

△　

JP1/Base定義情報

jp1base.commonDefInfoPathLocal

JP1/Base共通定義設定用ファイルのパス(ローカル)

JP1/AOサーバから転送(設定)するJP1/Baseの共通定義設定用ファイルのパスをフルパスで指定します。指定しなかった場合，転送は実行されません。

入力

無効

△　

JP1/Base定義情報

jp1base.targetBasePath_Windows

JP1/Baseインストールパス(Windows)

監視対象サーバのJP1/Base(Windows)のインストール先フォルダをフルパスで指定します。監視対象サーバがWindowsの場合，必ず設定してください。

入力

無効

△　

監視対象サーバ情報

jp1base.targetForwardPath_Windows

JP1/Base(Windows)のforwardファイルのパス

監視対象サーバ(Windows)のJP1/Baseのforwardファイルのパスをフルパスで指定します。監視対象サーバがWindowsの場合，必ず設定してください。

入力

無効

△　

監視対象サーバ情報

jp1base.targetConfPath_Windows

JP1/Base(Windows)のconfフォルダのパス

監視対象サーバ(Windows)のJP1/Baseのconfフォルダのフルパスを指定します。監視対象サーバがWindowsの場合，必ず設定してください。

入力

無効

△　

監視対象サーバ情報

jp1base.targetForwardPath_Linux

JP1/Base(UNIX)のforwardファイルのパス

監視対象サーバ(UNIX)のJP1/Baseのforwardファイルのパスをフルパスで指定します。監視対象サーバがUNIXの場合，必ず設定してください。

入力

無効

△　

監視対象サーバ情報

jp1base.targetConfPath_Linux

JP1/Base(UNIX)のconfディレクトリのパス

監視対象サーバ(UNIX)のJP1/Baseのconfディレクトリのフルパスを指定します。監視対象サーバがUNIXの場合，必ず設定してください。

入力

無効

△　

監視対象サーバ情報

jp1base.targetCommonDefInfoPath

JP1/Baseの共通定義設定用ファイルのパス

監視対象サーバへJP1/Baseの共通定義設定用ファイルを転送する際の転送先ファイルのパスをフルパスで指定します。JP1/Baseの共通定義情報の設定を行う場合，必ず設定してください。

入力

無効

△　

監視対象サーバ情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

common.targetHostList

監視対象サーバのホスト名のリスト

JP1/Baseの設定を行う監視対象サーバのホスト名を指定します。複数指定する場合は，コンマで区切って指定します。99台まで指定できます。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

監視対象サーバ情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1base.jp1svprmPathLocal

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1base.forwardPathLocal

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1base.nteventPathLocal

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1base.jevlogPathLocal

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1base.jevlogstartLocal

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1base.jevlogdLocal

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1base.commonDefInfoPathLocal

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1base.targetBasePath_Windows

232文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」および末尾の「¥」を除く。

jp1base.targetForwardPath_Windows

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」および末尾の「¥」を除く。

jp1base.targetConfPath_Windows

231文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」および末尾の「¥」を除く。

jp1base.targetForwardPath_Linux

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」，「/」を除く。

jp1base.targetConfPath_Linux

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」，「/」を除く。

jp1base.targetCommonDefInfoPath

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」，「/」を除く。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

common.targetHostList

1024文字以内の半角英数字および「.」，「-」，「,」。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

JP1/Baseセットアップ

JP1/Baseセットアップ

繰り返し実行部品

指定されたホスト名に対して，繰り返しJP1/Baseのセットアップと監視設定追加を行います。

エラー原因を取り除いたあと，サービスを再実行してください。

2.4.2　JP1/Base監視設定追加(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

OS判定

checkOS

階層フロー部品

OS種別を判定します。

−　

1-1

OS種別の出力

OS種別を判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

2

JP1/Baseセットアップ

jp1baseSetup

階層フロー部品

指定したサーバにJP1/Baseのセットアップを行います。

−　

2-3

値判定分岐部品

Windowsかどうか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

2-4

階層フロー部品

WindowsサーバにJP1/Baseのセットアップを行います。

−　

2-4-3

値判定分岐部品

起動順序定義ファイルが指定されているかチェックします。

エラー原因を取り除いたあと，サービスを再実行してください。

2-4-4

ファイル転送部品

監視対象サーバに起動順序定義ファイルを転送します。

エラー原因を取り除いたあと，サービスを再実行してください。

2-4-5

Windowsファイアウォールの設定

jbssessionmgrプロセスを登録します。

エラー原因を取り除いたあと，サービスを再実行してください。

2-4-6

Windowsファイアウォールの設定

jbsrouteプロセスを登録します。

エラー原因を取り除いたあと，サービスを再実行してください。

2-4-7

Windowsファイアウォールの設定

jcocmdプロセスを登録します。

エラー原因を取り除いたあと，サービスを再実行してください。

2-4-8

Windowsファイアウォールの設定

jcocmdapiプロセスを登録します。

エラー原因を取り除いたあと，サービスを再実行してください。

2-4-9

Windowsファイアウォールの設定

jevserviceプロセスを登録します。

エラー原因を取り除いたあと，サービスを再実行してください。

2-4-10

Windowsファイアウォールの設定

jbsplugindプロセスを登録します。

エラー原因を取り除いたあと，サービスを再実行してください。

2-4-11

Windowsファイアウォールの設定

jbscomd_sndプロセスを登録します。

エラー原因を取り除いたあと，サービスを再実行してください。

2-4-12

Windowsファイアウォールの設定

jbscomd_rcvプロセスを登録します。

エラー原因を取り除いたあと，サービスを再実行してください。

2-4-15

値判定分岐部品

転送元の共通定義設定用ファイルが指定されているかチェックします。

エラー原因を取り除いたあと，サービスを再実行してください。

2-4-16

階層フロー部品

監視対象サーバに共通定義情報を設定します。

−　

2-4-16-3

値判定分岐部品

転送先の共通定義設定用ファイルが指定されているかチェックします。

エラー原因を取り除いたあと，サービスを再実行してください。

2-4-16-4

階層フロー部品

監視対象サーバに共通定義情報を設定します。

−　

2-4-16-4-1

ファイル転送部品

監視対象サーバに共通定義設定用ファイルを転送します。

エラー原因を取り除いたあと，サービスを再実行してください。

2-4-16-4-2

JP1/Base共通定義情報設定

監視対象サーバに共通定義情報を設定します。

エラー原因を取り除いたあと，サービスを再実行してください。

2-4-16-4-3

ファイル削除

指定されたファイルを削除します。

エラー原因を取り除いたあと，サービスを再実行してください。

2-5

値判定分岐部品

UNIXかどうか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

2-6

階層フロー部品

UNIXサーバにJP1/Baseのセットアップを行います。

−　

2-6-1

ファイルのコピー

自動起動スクリプトをコピーします。

エラー原因を取り除いたあと，サービスを再実行してください。

2-6-2

ファイルのコピー

自動停止スクリプトをコピーします。

エラー原因を取り除いたあと，サービスを再実行してください。

2-6-5

値判定分岐部品

転送元の共通定義設定用ファイルが指定されているかチェックします。

エラー原因を取り除いたあと，サービスを再実行してください。

2-6-6

階層フロー部品

監視対象サーバに共通定義情報を設定します。

−　

2-6-6-3

値判定分岐部品

転送先の共通定義設定用ファイルが指定されているかチェックします。

エラー原因を取り除いたあと，サービスを再実行してください。

2-6-6-4

階層フロー部品

監視対象サーバに共通定義情報を設定します。

−　

2-6-6-4-1

ファイル転送部品

監視対象サーバに共通定義設定用ファイルを転送します。

エラー原因を取り除いたあと，サービスを再実行してください。

2-6-6-4-2

JP1/Base共通定義情報設定

監視対象サーバに共通定義情報を設定します。

エラー原因を取り除いたあと，サービスを再実行してください。

2-6-6-4-3

ファイル削除

指定されたファイルを削除します。

エラー原因を取り除いたあと，サービスを再実行してください。

3

JP1/Base監視設定の追加

jp1baseAddmonitoringConfiguration

階層フロー部品

JP1/Base監視設定の追加を行います。

エラー原因を取り除いたあと，サービスを再実行してください。

3-7

値判定分岐部品

Windowsかどうか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-8

階層フロー部品

WindowsサーバにJP1/Base監視設定ファイルの転送を行います。

−　

3-8-1

ファイル転送部品

監視対象サーバにforwardファイルを転送します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-8-2

値判定分岐部品

イベントログトラップ動作定義ファイルが指定されているかチェックします。

エラー原因を取り除いたあと，サービスを再実行してください。

3-8-3

ファイル転送部品

監視対象サーバにntevent.confファイルを転送します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-8-4

値判定分岐部品

ログファイルトラップ動作定義ファイルが指定されているかチェックします。

エラー原因を取り除いたあと，サービスを再実行してください。

3-8-5

ファイル転送部品

監視対象サーバにjevlog.confファイルを転送します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-8-6

値判定分岐部品

ログファイルトラップ起動定義ファイルが指定されているかチェックします。

エラー原因を取り除いたあと，サービスを再実行してください。

3-8-7

ファイル転送部品

監視対象サーバにjevlog_start.confファイルを転送します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-8-8

値判定分岐部品

ログ情報定義ファイルが指定されているかチェックします。

エラー原因を取り除いたあと，サービスを再実行してください。

3-8-9

ファイル転送部品

監視対象サーバにjevlogd.confファイルを転送します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-9

値判定分岐部品

UNIXかどうか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-10

階層フロー部品

UNIXサーバにJP1/Base監視設定ファイルの転送を行います。

−　

3-10-1

ファイル転送部品

監視対象サーバにforwardファイルを転送します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-10-2

値判定分岐部品

ログファイルトラップ動作定義ファイルが指定されているかチェックします。

エラー原因を取り除いたあと，サービスを再実行してください。

3-10-3

ファイル転送部品

監視対象サーバにjevlog.confファイルを転送します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-10-4

値判定分岐部品

ログファイルトラップ起動定義ファイルが指定されているかチェックします。

エラー原因を取り除いたあと，サービスを再実行してください。

3-10-5

ファイル転送部品

監視対象サーバにjevlog_start.confファイルを転送します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-10-6

値判定分岐部品

ログ情報定義ファイルが指定されているかチェックします。

エラー原因を取り除いたあと，サービスを再実行してください。

3-10-7

ファイル転送部品

監視対象サーバにjevlogd.confファイルを転送します。

エラー原因を取り除いたあと，サービスを再実行してください。

2.4.3　JP1/Cm2の監視対象ノード削除

機能

JP1/Cm2/NNMiの監視対象から複数のノードを削除します。

このサービステンプレートが前提とするサーバを次に示します。

・NNMiサーバ

　JP1/Cm2/NNMiがインストールされているサーバです。

・監視対象ノード

　JP1/Cm2/NNMiの監視対象から削除するサーバまたは機器です。

処理の概要を次に示します。

1.NNMiサーバのJP1/Cm2/NNMiのシードから指定した監視対象ノードのIPアドレスを削除します。

2.NNMiサーバのJP1/Cm2/NNMiから監視対象ノードを削除します。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1) JP1/Cm2/Network Node Manager i 09-10〜10-50

(2) JP1/Network Node Manager i 11-00〜12-60

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・bind-utilsパッケージがインストールされていること。

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・bind-utilsパッケージがインストールされていること。

【サービステンプレート実行システム内前提製品の使用条件】

(1) JP1/AOサーバ上で，削除する監視対象ノードの名前解決ができること。

(2) このサービスを実行する場合，エージェントレス接続先としてJP1/AOサーバ("localhost"で解決されるループバックアドレス)およびNNMiサーバを設定する必要があります。

(3) JP1/Cm2/NNMi 09-10を使用する場合，NNMiサーバにおいて，アカウントクレデンシャル(JP1/Cm2/NNMiのスクリプトを実行するときのユーザー名とパスワードに使用される値)が設定済みであること。

注意事項

(1)このサービスを同一のNNMiサーバに複数同時に実行しないでください。

(2)このサービスから監視ノードを削除する場合は，次のどれかの名称が，JP1/Cm2/NNMiに登録されている監視対象ノードの[ホスト名]属性または[管理アドレス]属性と一致する必要があります。

　・監視対象ノードのIPアドレスプロパティ(common.foreachIPaddress)に指定したIPアドレス

　・監視対象ノードのIPアドレスプロパティ(common.foreachIPaddress)に指定したIPアドレスから，JP1/AOサーバ上で名前解決したホスト名

JP1/Cm2/NNMiに登録されている監視対象ノードの各種属性は，ノードとの通信結果や名前解決の結果によって変更されることがありますので，上記の条件を満たすようにしてサービスを実行してください。なお，監視対象ノードの削除に失敗した場合，サービスは異常終了します。サービスが異常終了した場合は手動でJP1/Cm2/NNMiから監視対象ノードを削除してください。

バージョン

02.12.00

タグ

Configure JP1,NNMi

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

監視システム環境情報

NNMiサーバの環境情報を指定してください。

表示されます。

監視対象ノード情報

削除する監視対象ノードの情報を設定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1cm2nnm.nnmHostName

NNMiサーバのホスト名

JP1/Cm2/NNMiがインストールされているサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

監視システム環境情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

common.foreachIPaddress

監視対象ノードのIPアドレス

削除する監視対象ノードのIPアドレスを指定します。複数指定する場合はコンマで区切ってください。99個まで指定できます。IPv6アドレスには対応していません。

入力

無効

○　

監視対象ノード情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1cm2nnm.nnmHostName

255文字以内の半角英数字および「.」，「-」。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

common.foreachIPaddress

1024文字以内の半角数字および「.」，「,」。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

監視対象ノード削除

監視対象ノード削除

繰り返し実行部品

JP1/Cm2/NNMiの監視対象から複数のノードを削除します。

繰り返されるジョブネット内の指示に従ってください。

2.4.4　JP1/Cm2の監視対象ノード削除(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

ホスト名取得

osGetHostName

ホスト名取得

IPアドレスからホスト名を取得します。

エラー原因を取り除いたあと，サービスを再実行してください。

2

監視対象ノード削除

jp1nnmDeleteHost

監視対象ノード削除

JP1/Cm2/NNMiの監視対象からノードを削除します。

手動で監視対象ノードをJP1/Cm2/NNMiから削除してください。

2.4.5　JP1/Cm2の監視対象ノード追加

機能

JP1/Cm2/NNM(またはJP1/Cm2/NNMi)の監視対象に複数のノードを追加します。

このサービステンプレートが前提とするサーバを次に示します。

・NNMサーバ

　JP1/Cm2/NNM(またはJP1/Cm2/NNMi)がインストールされているサーバです。

・監視対象ノード

　JP1/Cm2/NNM(またはJP1/Cm2/NNMi)へ監視対象として追加するサーバまたは機器です。

処理の概要を次に示します。

1.NNMサーバのJP1/Cm2/NNM(またはJP1/Cm2/NNMi)に対し監視対象ノードを追加します。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1) JP1/Cm2/Network Node Manager i 09-10〜10-50

(2) JP1/Network Node Manager i 11-00〜12-60

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・bind-utilsパッケージがインストールされていること。

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・bind-utilsパッケージがインストールされていること。

【サービステンプレート実行システム内前提製品の使用条件】

(1) JP1/AOサーバ上で，追加する監視対象ノードの名前解決ができること。

(2) JP1/Cm2/NNMを使用する場合，ovspmd，ovwdb，pmd，ovtopmd，netmonの5つのプロセスが起動していること。

(3) JP1/Cm2/NNMに複数の監視対象ノードの追加を行う場合，各監視対象ノードは同一のサブネット上に存在する必要があります(指定できるサブネットマスクは1つだけです)。

(4) このサービスを実行する場合，エージェントレス接続先としてJP1/AOサーバ("localhost"で解決されるループバックアドレス)およびNNMサーバを設定する必要があります。

注意事項

(1)このサービスを同一のNNMサーバに複数同時に実行しないでください。

(2)JP1/Cm2/NNMiのマルチテナントには対応していないため，テナントを使用している場合は，監視対象ノードを追加したあとに手動で監視対象ノードをテナントに移動してください。

(3)JP1/Cm2/NNMiの場合，監視対象ノードを追加するためにシードを登録します。そのシードをJP1/Cm2/NNMiでは監視対象ノードを追加したあとに削除することを推奨しています。

　このサービスではシードを追加したあとにいつ監視対象ノードが追加されるか不定のため，自動でシードを削除していません。

　シードについての詳細はJP1/Cm2/NNMiのリリースノートを参照願います。

バージョン

02.12.00

タグ

Configure JP1,NNMi

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

監視システム環境情報

NNMサーバの環境情報を指定してください。

表示されます。

監視対象ノード情報

追加する監視対象ノードの情報を設定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1cm2nnm.nnmHostName

NNMサーバのホスト名

JP1/Cm2/NNM(またはJP1/Cm2/NNMi)がインストールされているサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

監視システム環境情報

jp1cm2nnm.targetSubnetMask

監視対象ノードのサブネットマスク

追加する監視対象ノードのサブネットマスクを指定します(複数指定不可)。JP1/Cm2/NNMを使用する場合は必ず指定してください。

入力

無効

△　

監視対象ノード情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

common.foreachIPaddress

監視対象ノードのIPアドレス

追加する監視対象ノードのIPアドレスを指定します。複数指定する場合はコンマで区切ってください。99個まで指定できます。IPv6アドレスには対応していません。

入力

無効

○　

監視対象ノード情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1cm2nnm.nnmHostName

255文字以内の半角英数字および「.」，「-」。

jp1cm2nnm.targetSubnetMask

15文字以内の半角数字および「.」。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

common.foreachIPaddress

1024文字以内の半角数字および「.」，「,」。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

監視対象ノード追加

監視対象ノード追加

繰り返し実行部品

JP1/Cm2/NNM(またはJP1/Cm2/NNMi)の監視対象に複数のノードを追加します。

エラー原因を取り除いたあと，サービスを再実行してください。

2.4.6　JP1/Cm2の監視対象ノード追加(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

ホスト名取得

osGetHostName

ホスト名取得

IPアドレスからホスト名を取得します。

エラー原因を取り除いたあと，サービスを再実行してください。

2

監視対象ノード追加

jp1nnmAddHost

監視対象ノード追加

NNMサーバのJP1/Cm2/NNM(またはJP1/Cm2/NNMi)の監視対象にノードを追加します。

エラー原因を取り除いたあと，サービスを再実行してください。

2.4.7　JP1/PFMアラーム定義の複製

機能

このサービステンプレートは，JP1/PFMによって監視を行うシステムで，アラーム定義のコピーと定義内容の変更を行い，指定したエージェントにバインドします。

JP1/PFM - RM for Platformの監視対象サーバの監視条件を追加・変更する場合に，事前に用意したアラームテーブルのひな型を流用して，監視条件を変更したアラームテーブルをバインドすることができます。

このサービステンプレートが前提とするサーバを次に示します。

・PFM管理サーバ

　JP1/PFM - Managerがインストールされているサーバです。

・監視対象サーバ

　JP1/PFMの監視対象として設定するサーバです。

処理の概要を次に示します。

(1)PFM管理サーバで既存のアラームテーブルをコピーし，新しいアラームテーブルを作成します。

(2)新しく作成したアラームテーブルのアラームをコピーし，新しいアラームを作成します。

(3)アラーム定義ファイルをエクスポートします。

(4)エクスポートしたアラーム定義ファイルを編集します。アラーム定義ファイルの内容を指定した内容に変更します。

(5)編集したアラーム定義ファイルをインポートします。

(6)コピー元のアラームを削除します(削除要否は選択可能)。

(7)アラームテーブルを監視対象サーバのエージェントにバインドします。

(8)アラームテーブルやアラームの定義情報またはバインド情報を出力します(以降，このファイルをアラーム情報ファイルと表記します)。

(9)編集したアラーム定義ファイルおよびアラーム情報ファイルをPFM管理サーバからJP1/AOサーバに転送します。

(10)PFM管理サーバからアラーム定義ファイルとアラーム情報ファイルを削除します。

PFM管理サーバのJP1/PFM - Managerにおいてアラームテーブル複数バインド機能が有効な環境では，jp1pfm.bindMultipleAlarmTableプロパティにtrueを指定することで，このサービスで変更・インポートしたアラームテーブルを指定したエージェントに追加でバインドできます。アラームテーブル複数バインド機能が無効な環境では，該当プロパティにfalseを設定してください。該当プロパティにfalseを設定した場合は，指定したエージェントにバインドされているアラームテーブルがすべてアンバインドされ，このサービスで変更・インポートしたアラームテーブルだけがバインドされます。

common.targetStrプロパティの指定について

・正規表現の使用はサポートしていません。

・PFM管理サーバのOSがWindowsの場合に，｢¥｣，｢[｣，｢]｣，｢*｣，｢.｣，｢@｣を指定する場合は，｢¥｣(円記号)でエスケープする必要があります。また，｢#｣，｢,｣，｢`｣，｢<｣，｢>｣およびスペースを含む文字列を指定する場合は，｢`｣(バッククォート)でエスケープする必要があります。｢(｣，｢)｣，｢$｣を指定する場合は，｢¥`｣(円記号とバッククォート)でエスケープしてください。

・PFM管理サーバのOSがUNIXの場合に，｢¥｣を指定する場合は，｢¥¥｣と指定してください。｢[｣，｢]｣，｢/｣，｢.｣，｢*｣，｢$｣を指定する場合は，｢¥｣(円記号)でエスケープする必要があります。

・WindowsおよびUNIXに関係なく｢"｣は入力しないでください。｢"｣を指定する場合は，｢¥0x22｣と入力してください。

common.destinationStrプロパティの指定について

・PFM管理サーバのOSがWindowsの場合に，｢`t｣(タブ)および｢`r`n｣(改行)のメタ文字を使用できます。また，文字列内に｢`｣，｢#｣，｢,｣，｢@｣，｢(｣，｢)｣，｢<｣，｢>｣，｢$｣およびスペースを含む文字列を指定する場合は，｢`｣(バッククォート)でエスケープする必要があります。

・PFM管理サーバのOSがUNIXの場合，｢¥t｣(タブ)および｢¥n｣(改行)のメタ文字を使用できます。文字列内に｢¥｣(円記号)を指定する場合は，｢¥¥｣と入力してください。また，文字列内に｢/｣，｢$｣を指定する場合は，｢¥｣(円記号)でエスケープする必要があります。

・またWindowsおよびUNIXに関係なく｢"」は入力しないでください。「"」を指定する場合は，「¥0x22」と入力してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1) JP1/Performance Management - Manager 09-10-11以降

(2) JP1/Performance Management - Manager 10-00以降

(3) JP1/Performance Management - Remote Monitor for Platform 09-10以降

(4) JP1/Performance Management - Remote Monitor for Platform 10-00以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【サービステンプレート実行システム内前提製品の使用条件】

(1)JP1/PFM - Managerの次のサービスが起動していること。

　・Name Serverサービス

　・Master Managerサービス

　・View Serverサービス

(2)コピー対象のアラームテーブルおよびアラームがJP1/PFMシステムに登録されていること。

(3)JP1/PFMのjpctool alarmコマンドの次に示すサブコマンドの使用条件を満たしていること。

　・jpctool alarm bind

　・jpctool alarm copy

　・jpctool alarm delete

　・jpctool alarm export

　・jpctool alarm import

　・jpctool alarm list

注意事項

(1)このサービスは，同一サーバに対してこのサービスまたは他のJP1/PFMと連携するサービスと同時に実行した場合，タスクが異常終了する場合があります。

(2)実行対象サーバのJP1/PFM - Managerがクラスタ構成の場合は，実行系ノードでサービスを実行してください。

(3)リモートおよびローカルに指定したファイルパス上のフォルダに暗号化属性が設定されている場合，指定したファイルの転送に失敗しタスクが異常終了します。詳細はファイル転送部品の注意事項を参照してください。

(4)PFM管理サーバのOSがUNIXの場合，リモートに指定するファイルパスにマルチバイト文字を使用しないでください。

(5)リモートおよびローカルに指定するファイル名が既に存在する場合，既存のファイルを上書きします。また，リモート側のファイルは削除します。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(6)リモートに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

(7)PFM管理サーバのOSがUNIXの場合は，エージェントレス接続先に定義された接続ユーザーのデフォルトロケールでコマンドが実行されます。接続ユーザーのデフォルトロケールには，JP1/PFMがサポートするロケールを設定してください。詳細については，JP1/AOマニュアルの「部品実行時に設定される操作対象の機器のロケールについて」，「部品実行時に設定されるJP1/AOが通信で使用する文字セットについて」およびJP1/PFMマニュアルを参照してください。

バージョン

03.01.00

タグ

Configure JP1,PFM

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

監視システム情報

PFM管理サーバおよび監視対象サーバに関する情報を指定してください。

表示されます。

アラーム編集情報

アラーム編集に関する情報を指定してください。

表示されます。

出力ファイル情報

出力ファイルに関する情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1pfm.pfmHostName

PFM管理サーバのホスト名

JP1/PFM - Managerがインストールされたサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

監視システム情報

jp1pfm.serviceKey

サービスキー

JP1/PFM - RM for Platformのサービスキーを指定します。プロダクト名表示機能が有効の場合，プロダクト名も指定できます。

入力

無効

○　

監視システム情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1pfm.agentServiceId

エージェントのサービスID

アラームのバインド対象となるJP1/PFM - RMのリモートエージェントまたはグループエージェントのサービスIDを指定してください。

入力

無効

○　

監視システム情報

jp1pfm.sourceAlarmTableName

コピー元のアラームテーブル名

コピー元のアラームテーブル名を指定します。

入力

無効

○　

アラーム編集情報

jp1pfm.destinationAlarmTableName

コピー先のアラームテーブル名

コピー先のアラームテーブル名を指定します。

入力

無効

○　

アラーム編集情報

jp1pfm.sourceAlarmName

コピー元のアラーム名

コピー元のアラーム名を指定します。

入力

無効

○　

アラーム編集情報

jp1pfm.destinationAlarmName

コピー先のアラーム名

コピー先のアラーム名を指定します。

入力

無効

○　

アラーム編集情報

common.targetStr

アラーム定義ファイルの変更対象文字列

ファイル内の変更対象文字列を指定します。

入力

無効

○　

アラーム編集情報

common.destinationStr

アラーム定義ファイルの変更後の文字列

変更後の文字列を指定します。

入力

無効

○　

アラーム編集情報

jp1pfm.deleteSourceAlarm

コピー元アラームの削除要否

コピー元のアラームを削除する場合はtrue，しない場合はfalseを指定します。

入力

無効

○　

アラーム編集情報

jp1pfm.bindMultipleAlarmTable

アラームテーブル追加バインドの要否

アラームテーブル複数バインド機能が有効であり，複製したアラームテーブルを追加でバインドする場合はtrueを指定します。

入力

無効

○　

アラーム編集情報

jp1pfm.alarmDefinitionFilePathRemote

アラーム定義ファイルパス(リモート)

アラーム定義ファイルのエクスポート先(PFM管理サーバ側)をフルパスで指定します。

入力

無効

○　

出力ファイル情報

jp1pfm.alarmDefinitionFilePathLocal

アラーム定義ファイルパス(ローカル)

編集したアラーム定義ファイルの格納先(JP1/AOサーバ側)をフルパスで指定します。

入力

無効

○　

出力ファイル情報

jp1pfm.alarmInfoFilePathRemote

アラーム情報ファイルパス(リモート)

アラーム情報ファイルのエクスポート先(PFM管理サーバ側)をフルパスで指定します。

入力

無効

○　

出力ファイル情報

jp1pfm.alarmInfoFilePathLocal

アラーム情報ファイルパス(ローカル)

アラーム情報ファイルの格納先(JP1/AOサーバ側)をフルパスで指定します。

入力

無効

○　

出力ファイル情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1pfm.pfmHostName

255文字以内の半角英数字および「.」，「-」。

jp1pfm.serviceKey

2文字以上16文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「"」，「`」を除く。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1pfm.agentServiceId

258文字以内の半角英数字および「-」，「.」，「@」，「[」，「]」。

jp1pfm.sourceAlarmTableName

64文字以内の文字列。ただし，「¥」，「!」，「"」，「#」，「$」，「&」，「'」，「*」，「+」，「:」，「;」，「,」，「<」，「>」，「=」，「?」，「^」，「~」，「`」，「{」，「}」，「|」を除く。

jp1pfm.destinationAlarmTableName

64文字以内の文字列。ただし，「¥」，「!」，「"」，「#」，「$」，「&」，「'」，「*」，「+」，「:」，「;」，「,」，「<」，「>」，「=」，「?」，「^」，「~」，「`」，「{」，「}」，「|」を除く。

jp1pfm.sourceAlarmName

64文字以内の文字列。ただし，「¥」，「!」，「"」，「#」，「$」，「&」，「'」，「*」，「+」，「:」，「;」，「,」，「<」，「>」，「=」，「?」，「^」，「~」，「`」，「{」，「}」，「|」を除く。

jp1pfm.destinationAlarmName

64文字以内の文字列。ただし，「¥」，「!」，「"」，「#」，「$」，「&」，「'」，「*」，「+」，「:」，「;」，「,」，「<」，「>」，「=」，「?」，「^」，「~」，「`」，「{」，「}」，「|」を除く。

common.targetStr

1024文字以内の文字列。ただし，「|」，「;」，「&」，「'」，「"」，「?」，「{」，「}」，「~」，「!」，「+」，「^」および末尾の「¥」を除く。

common.destinationStr

1024文字以内の文字列。ただし，「|」，「;」，「&」，「'」，「"」，「?」，「{」，「}」，「~」，「!」，「+」，「^」および末尾の「¥」を除く。

jp1pfm.deleteSourceAlarm

次の値のどれかを選択する。

true,false

jp1pfm.bindMultipleAlarmTable

次の値のどれかを選択する。

true,false

jp1pfm.alarmDefinitionFilePathRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」を除く。

jp1pfm.alarmDefinitionFilePathLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」を除く。

jp1pfm.alarmInfoFilePathRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」を除く。

jp1pfm.alarmInfoFilePathLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

アラームテーブルのコピー

アラームテーブルのコピー

アラームテーブルのコピー(JP1/PFM)

既存のアラームテーブルをコピーして新しいアラームテーブルを作成します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

アラームのコピー

アラームのコピー

アラームテーブルのコピー(JP1/PFM)

アラームをコピーし，新しいアラームを作成します。

エラーの原因を取り除いたあと，作成したアラームテーブルを消去し，サービスを再実行してください。

3

アラーム定義ファイルエクスポート

アラーム定義ファイルエクスポート

アラーム定義ファイルのエクスポート(JP1/PFM)

アラーム定義ファイルをエクスポートします。

エラーの原因を取り除いたあと，作成したアラームテーブルを消去し，サービスを再実行してください。

4

アラーム定義ファイル編集

アラーム定義ファイル編集

文字列の置換

文字列を置換します。

エラーの原因を取り除いたあと，作成したアラームテーブルを消去し，サービスを再実行してください。

5

アラーム定義ファイルインポート

アラーム定義ファイルインポート

アラーム定義ファイルのインポート(JP1/PFM)

アラーム定義ファイルをインポートします。

エラーの原因を取り除いたあと，作成したアラームテーブルを消去し，サービスを再実行してください。

6

アラーム削除

アラーム削除

階層フロー部品

アラームを削除します。

−　

6-1

値判定分岐部品

コピー元のアラームの削除要否を判定します。

エラーの原因を取り除いたあと，作成したアラームテーブルを消去し，サービスを再実行してください。

6-2

アラームテーブルの削除(JP1/PFM)

コピー元のアラームを削除します。

エラーの原因を取り除いたあと，作成したアラームテーブルを消去し，サービスを再実行してください。

7

アラームのバインド

アラームのバインド

アラームのバインド(JP1/PFM - RM)

監視対象サーバにアラームテーブルをバインドします。

エラーの原因を取り除いたあと，作成したアラームテーブルを消去し，サービスを再実行してください。

8

アラーム情報の取得

アラーム情報の取得

アラームテーブルの情報取得(JP1/PFM)

アラーム情報ファイルを取得します。

必要に応じてアラーム定義ファイルとアラーム情報ファイルを取得してください。

9

ファイル転送

ファイル転送

階層フロー部品

アラーム定義ファイルとアラーム情報ファイルをJP1/AOサーバに転送します。

−　

9-1

ファイル転送部品

アラーム定義ファイルをJP1/AOサーバに転送します。

出力したアラーム定義ファイルとアラーム情報ファイルを必要に応じて取得してください。

9-2

ファイル転送部品

アラーム情報ファイルをJP1/AOサーバに転送します。

出力したアラーム情報ファイルを必要に応じて取得してください。

10

ファイル削除

ファイル削除

階層フロー部品

アラーム定義ファイルとアラーム情報ファイルをPFM管理サーバから削除します。

−　

10-1

ファイル削除

アラーム定義ファイルをPFM管理サーバから削除します。

PFM管理サーバ上のアラーム定義ファイルとアラーム情報ファイルを削除してください。

10-2

ファイル削除

アラーム情報ファイルをPFM管理サーバから削除します。

PFM管理サーバ上のアラーム情報ファイルを削除してください。

2.4.8　JP1/VERITASのバックアップポリシー作成

機能

このサービステンプレートは，JP1/VERITAS NetBackupと連携し，同梱したパラメーターシートの設計値を元にバックアップポリシーを作成します。

このサービステンプレートが前提とするサーバを次に示します。

・JP1/AOサーバ

　JP1/AOが動作するサーバです。このサーバの任意のフォルダに記入済みのパラメーターシートを配置してください。

・バックアップ実行サーバ

　JP1/VERITAS NetBackup(マスターサーバ)が動作するサーバです。本製品によってこのサーバに部品が転送され，実行されます。

処理の概要を次に示します。

(1)パラメーターシートから値を読み出します。

(2)パラメーターシートの指定値に従い，JP1/VERITAS NetBackup上にバックアップポリシーを新規作成/初期化します。

(3)作成したバックアップポリシーの属性を設定します。

(4)バックアップポリシーにスケジュールを(3件まで)追加し，スケジュールの属性を設定します。

(5)バックアップポリシーにクライアントを追加します。

(6)バックアップポリシーにファイルリストを追加します。

JP1/AOサーバのOSによって，次の形式のパラメーターシートが利用可能です。

・Windows環境の場合，Excel形式またはCSV形式のパラメーターシートを利用することができます。

・UNIX環境の場合，CSV形式のパラメーターシートを利用することができます。

次の手順でパラメーターシートに設定値を記入し，JP1/AOサーバに配置してください。

【Excel形式の場合】

(1)パラメーターシートの「ポリシー」タブに設定値を記入します。

(2)変更したパラメーターシートをJP1/AOサーバに配置します。

【CSV形式の場合】

(1)パラメーターシートの「ポリシー」シートに設定値を記入します。

(2)「AOインプット」シートを「CSV(コンマ区切り)」形式で保存します。

(3)保存したCSVファイルをJP1/AOサーバに配置します。このとき，JP1/AOサーバがWindows環境の場合は改行コードがCR+LFであることを，UNIX環境の場合は改行コードがLFであることを確認してください。

プロパティ設定の留意点を次に示します。

・JP1/AOサーバに配置したパラメーターシートのフルパスをjp1veritas.paramSheetPathに指定してください。

JP1/AOサーバ，実行対象サーバのOSがWindowsの場合，このサービステンプレートの実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。各サーバにadministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行うサービス「JP1/VERITASのバックアップポリシー作成(SYSTEM)」を実行してください。

前提条件

【システム内前提製品】/【サービステンプレート実行対象サーバ内前提製品】/【サービステンプレート実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行対象サーバ内前提製品】

　・JP1/VERITAS NetBackup 7.6，7.7

　・JP1/VERITAS NetBackup 8.0，8.1，8.2，8.3

　・JP1/VERITAS NetBackup 9.0，9.1

【サービステンプレート実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

【サービステンプレート実行対象システム内前提製品の使用条件】

　特になし。

実行権限

ビルトイン Administrator

バージョン

03.01.02

タグ

Control JP1,VERITAS

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

JP1/VERITAS NetBackup構成情報

JP1/VERITAS NetBackupの構成情報を設定してください。

表示されます。

パラメーターシート情報

バックアップポリシーのパラメーターシート情報を設定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1veritas.targetHost

バックアップ実行サーバのホスト名

JP1/VERITAS NetBackup マスターサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

JP1/VERITAS NetBackup構成情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1veritas.paramSheetPath

パラメーターシートのパス

JP1/AOサーバに格納されたバックアップポリシーのパラメーターシートのフルパスを指定してください。

入力

無効

○　

パラメーターシート情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1veritas.targetHost

256文字以内の半角英数字および「.」，「-」。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1veritas.paramSheetPath

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

パラメーターシート読み込み1

パラメーターシート読み込み1

CSV・Excelの行データ取得

パラメーターシートから基本情報と1件目のスケジュールを読み出します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

バックアップポリシーの作成

バックアップポリシーの作成

バックアップポリシーの作成

バックアップポリシーを作成します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

バックアップポリシー(VMware)の初期化

バックアップポリシー(VMware)の初期化

バックアップポリシー(VMware)の初期化

バックアップポリシーを初期化します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

4

バックアップポリシー(VMware)の属性設定

バックアップポリシー(VMware)の属性設定

バックアップポリシー(VMware)の属性変更

バックアップポリシーに属性を設定します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

5

スケジュール作成判定1

スケジュール作成判定1

値判定分岐部品

1件目のスケジュールラベルが設定されているか確認します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

6

階層フロー部品

1件目のスケジュールを追加します。

−　

7

バックアップポリシーへのスケジュール追加

スケジュールを追加します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

8

バックアップポリシーへのスケジュール属性変更

スケジュールの属性を設定します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

9

パラメーターシート読み込み2

パラメーターシート読み込み2

CSV・Excelの行データ取得

パラメーターシートから2件目のスケジュールを読み出します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

10

スケジュール作成判定2

スケジュール作成判定2

値判定分岐部品

2件目のスケジュールラベルが設定されているか確認します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

11

階層フロー部品

2件目のスケジュールを追加します。

−　

12

バックアップポリシーへのスケジュール追加

スケジュールを追加します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

13

バックアップポリシーへのスケジュール属性変更

スケジュールの属性を設定します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

14

パラメーターシート読み込み3

パラメーターシート読み込み3

CSV・Excelの行データ取得

パラメーターシートから3件目のスケジュールを読み出します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

15

スケジュール作成判定3

スケジュール作成判定3

値判定分岐部品

3件目のスケジュールラベルが設定されているか確認します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

16

階層フロー部品

3件目のスケジュールを追加します。

−　

17

バックアップポリシーへのスケジュール追加

スケジュールを追加します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

18

バックアップポリシーへのスケジュール属性変更

スケジュールの属性を設定します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

19

クライアントの追加

クライアントの追加

バックアップポリシーへのクライアント追加

バックアップポリシーにクライアントを追加します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

20

ファイルの追加

ファイルの追加

バックアップポリシーへのファイルリスト追加

バックアップポリシーにファイルリストを追加します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

2.4.9　JP1/VERITASのバックアップポリシー作成(SYSTEM)

機能

このサービステンプレートは，JP1/VERITAS NetBackupと連携し，同梱したパラメーターシートの設計値を元にバックアップポリシーを作成します。

このサービステンプレートが前提とするサーバを次に示します。

・JP1/AOサーバ

　JP1/AOが動作するサーバです。このサーバの任意のフォルダに記入済みのパラメーターシートを配置してください。

・バックアップ実行サーバ

　JP1/VERITAS NetBackup(マスターサーバ)が動作するサーバです。本製品によってこのサーバに部品が転送され，実行されます。

処理の概要を次に示します。

(1)パラメーターシートから値を読み出します。

(2)パラメーターシートの指定値に従い，JP1/VERITAS NetBackup上にバックアップポリシーを新規作成/初期化します。

(3)作成したバックアップポリシーの属性を設定します。

(4)バックアップポリシーにスケジュールを(3件まで)追加し，スケジュールの属性を設定します。

(5)バックアップポリシーにクライアントを追加します。

(6)バックアップポリシーにファイルリストを追加します。

JP1/AOサーバのOSによって，次の形式のパラメーターシートが利用可能です。

・Windows環境の場合，Excel形式またはCSV形式のパラメーターシートを利用することができます。

・UNIX環境の場合，CSV形式のパラメーターシートを利用することができます。

次の手順でパラメーターシートに設定値を記入し，JP1/AOサーバに配置してください。

【Excel形式の場合】

(1)パラメーターシートの「ポリシー」タブに設定値を記入します。

(2)変更したパラメーターシートをJP1/AOサーバに配置します。

【CSV形式の場合】

(1)パラメーターシートの「ポリシー」シートに設定値を記入します。

(2)「AOインプット」シートを「CSV(コンマ区切り)」形式で保存します。

(3)保存したCSVファイルをJP1/AOサーバに配置します。このとき，JP1/AOサーバがWindows環境の場合は改行コードがCR+LFであることを，UNIX環境の場合は改行コードがLFであることを確認してください。

プロパティ設定の留意点を次に示します。

・JP1/AOサーバに配置したパラメーターシートのフルパスをjp1veritas.paramSheetPathに指定してください。

前提条件

【システム内前提製品】/【サービステンプレート実行対象サーバ内前提製品】/【サービステンプレート実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行対象サーバ内前提製品】

　・JP1/VERITAS NetBackup 7.6，7.7

　・JP1/VERITAS NetBackup 8.0，8.1，8.2，8.3

　・JP1/VERITAS NetBackup 9.0，9.1

【サービステンプレート実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

【サービステンプレート実行対象システム内前提製品の使用条件】

　特になし。

実行権限

Administratorsグループに所属するユーザー

バージョン

03.10.02

タグ

Control JP1,VERITAS

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

JP1/VERITAS NetBackup構成情報

JP1/VERITAS NetBackupの構成情報を設定してください。

表示されます。

パラメーターシート情報

バックアップポリシーのパラメーターシート情報を設定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1veritas.targetHost

バックアップ実行サーバのホスト名

JP1/VERITAS NetBackup マスターサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

JP1/VERITAS NetBackup構成情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1veritas.paramSheetPath

パラメーターシートのパス

JP1/AOサーバに格納されたバックアップポリシーのパラメーターシートのフルパスを指定してください。

入力

無効

○　

パラメーターシート情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1veritas.targetHost

256文字以内の半角英数字および「.」，「-」。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1veritas.paramSheetPath

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

パラメーターシート読み込み(SYSTEM)1

パラメーターシート読み込み(SYSTEM)1

CSV・Excelの行データ取得(SYSTEM)

パラメーターシートから基本情報と1件目のスケジュールを読み出します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

バックアップポリシーの作成

バックアップポリシーの作成

バックアップポリシーの作成

バックアップポリシーを作成します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

バックアップポリシー(VMware)の初期化

バックアップポリシー(VMware)の初期化

バックアップポリシー(VMware)の初期化

バックアップポリシーを初期化します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

4

バックアップポリシー(VMware)の属性設定

バックアップポリシー(VMware)の属性設定

バックアップポリシー(VMware)の属性変更

バックアップポリシーに属性を設定します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

5

スケジュール作成判定1

スケジュール作成判定1

値判定分岐部品

1件目のスケジュールラベルが設定されているか確認します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

6

階層フロー部品

1件目のスケジュールを追加します。

−　

7

バックアップポリシーへのスケジュール追加

スケジュールを追加します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

8

バックアップポリシーへのスケジュール属性変更

スケジュールの属性を設定します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

9

パラメーターシート読み込み(SYSTEM)2

パラメーターシート読み込み(SYSTEM)2

CSV・Excelの行データ取得(SYSTEM)

パラメーターシートから2件目のスケジュールを読み出します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

10

スケジュール作成判定2

スケジュール作成判定2

値判定分岐部品

2件目のスケジュールラベルが設定されているか確認します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

11

階層フロー部品

2件目のスケジュールを追加します。

−　

12

バックアップポリシーへのスケジュール追加

スケジュールを追加します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

13

バックアップポリシーへのスケジュール属性変更

スケジュールの属性を設定します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

14

パラメーターシート読み込み(SYSTEM)3

パラメーターシート読み込み(SYSTEM)3

CSV・Excelの行データ取得(SYSTEM)

パラメーターシートから3件目のスケジュールを読み出します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

15

スケジュール作成判定3

スケジュール作成判定3

値判定分岐部品

3件目のスケジュールラベルが設定されているか確認します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

16

階層フロー部品

3件目のスケジュールを追加します。

−　

17

バックアップポリシーへのスケジュール追加

スケジュールを追加します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

18

バックアップポリシーへのスケジュール属性変更

スケジュールの属性を設定します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

19

クライアントの追加

クライアントの追加

バックアップポリシーへのクライアント追加

バックアップポリシーにクライアントを追加します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

20

ファイルの追加

ファイルの追加

バックアップポリシーへのファイルリスト追加

バックアップポリシーにファイルリストを追加します。

エラーの原因を取り除き，作成されたバックアップポリシーを削除したあと，サービスを再実行してください。

2.4.10　監視設定削除

機能

JP1/Cm2/NNMiおよびJP1/PFMから複数の監視対象ノードを削除します。

このサービステンプレートが前提とするサーバを次に示します。

・NNMiサーバ

　JP1/Cm2/NNMiがインストールされているサーバです。

・PFM管理サーバ

　JP1/PFM - ManagerおよびJP1/PFM - Web Consoleがインストールされているサーバです。

・PFM-RMサーバ

　JP1/PFM - RM for Platformがインストールされているサーバです。

・監視対象サーバ

　JP1/Cm2/NNMiおよびJP1/PFMの監視対象として設定するサーバです。

処理の概要を次に示します。

1.NNMiサーバのJP1/Cm2/NNMiから監視対象サーバを削除します。

2.JP1/PFMから監視対象サーバを削除します。次の処理を実施します。

(1)PFM管理サーバにおいてアラームテーブルのアンバインドを行います。

(2)PFM-RMサーバに対してJP1/PFM - RM for Platformのリモートエージェントの削除を行います。

(3)PFM管理サーバのJP1/PFM - Web Consoleに対してエージェント階層を設定します。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1) JP1/Cm2/Network Node Manager i 09-10〜10-50

　　JP1/Network Node Manager i 11-00〜12-60

(2) JP1/Performance Management - Manager 09-10-11以降

　　JP1/Performance Management - Web Console 09-10-05以降

　　JP1/Performance Management - Remote Monitor for Platform 09-10以降

　　JP1/Performance Management - Base 09-10以降

(3) JP1/PFM - Manager，JP1/PFM - Web Consoleが同一のサーバにインストールされていること。

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・bind-utilsパッケージがインストールされていること。

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・bind-utilsパッケージがインストールされていること。

(8) AIX V6 (ただし，NNMiサーバおよびPFM-RMサーバは除く)

(9) AIX V7 (ただし，NNMiサーバおよびPFM-RMサーバは除く)

【サービステンプレート実行システム内前提製品の使用条件】

(1) PFM-RMサーバがクラスタ構成の場合，プロパティjp1pfm.pfmRMHostNameには論理ホストが動作している物理ホスト名を，プロパティjp1pfm.jp1pfmRMLHostNameには論理ホスト名を指定してください。

(2) JP1/PFMのエージェント階層の設定を行う場合，JP1/AOサーバ上に，PFM管理サーバに転送する次のファイルが格納されていること。

　・エージェント階層定義ファイル(jpcconf agttree importで指定するファイル名) (任意)

　　このファイル名の指定がない場合，エージェント階層を設定しません。

　・上記ファイルをプロパティに指定するときは必ず転送元と転送先の両方をあわせて指定してください。

(3) JP1/AOサーバ上で，監視対象サーバの名前解決ができること。

(4) このサービスを実行する場合，エージェントレス接続先としてJP1/AOサーバ(""localhost""で解決されるループバックアドレス)および接続先となるサーバを設定する必要があります。

(5) アラームテーブル名の欄が空欄の場合は，このサービステンプレートがデフォルトとするアラームテーブル(PFM RM Platform Template Alarms 09.00)をアンバインドします。

(6) JP1/PFMでプロダクト名表示機能が有効になっていること。

(7) JP1/Cm2/NNMi 09-10を使用する場合，NNMiサーバにおいて，アカウントクレデンシャル(JP1/Cm2/NNMiのスクリプトを実行するときのユーザー名とパスワードに使用される値)が設定済みであること。

注意事項

(1)このサービスを同一のNNMiサーバ，PFM管理サーバおよびPFM-RMサーバに複数同時に実行しないでください。

(2)監視対象サーバのIPアドレスにはIPv6は指定できません。

(3)JP1/PFMの監視対象に含まれていないIPアドレスを指定すると，サービスは異常終了します。

(4)このサービスでアンバインドするアラームテーブルは1つだけです。2つ以上のアラームテーブルがバインドされている監視対象サーバに対して，このサービスを実行しないでください。

(5)監視対象サーバのIPアドレスには，最大50台指定できます。

(6)JP1/Cm2/NNMiにノードとして登録されている監視対象サーバが，次のどれかの名称と異なる場合は，JP1/Cm2/NNMiから監視対象サーバは削除できません。

　・指定したIPアドレス

　・指定したIPアドレスからJP1/AOサーバ上で名前解決したホスト名

　監視対象サーバの削除に失敗した場合，サービスは異常終了します。

　また，サービスが異常終了した場合は手動でJP1/Cm2/NNMiおよびJP1/PFMから監視対象サーバの設定を削除してください。

(7)UNIX環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

(8)リモートに指定するファイル名が既に存在する場合，リモートのファイルを上書きおよび削除します。指定したファイル名に誤りがないか，十分に確認してください。

(9)リモートに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

バージョン

03.00.00

タグ

Configure JP1,NNMi,PFM

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

監視システム環境情報

NNMiサーバ，PFM管理サーバおよびPFM-RMサーバの環境情報を指定してください。

表示されます。

監視情報

削除する監視対象サーバの監視情報を設定してください。

表示されます。

オプション監視情報

PFM管理サーバに対するエージェント階層定義およびアラームテーブルの設定(アンバインド)を指定してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1cm2nnm.nnmHostName

NNMiサーバのホスト名

JP1/Cm2/NNMiがインストールされているサーバのホスト名を指定します。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

監視システム環境情報

jp1pfm.pfmHostName

PFM管理サーバのホスト名

JP1/PFM - ManagerおよびJP1/PFM - Web Consoleがインストールされたサーバのホスト名を指定します。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

監視システム環境情報

jp1pfm.pfmRMHostName

PFM-RMサーバのホスト名

JP1/PFM - RM for Platformがインストールされたサーバのホスト名を指定します。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

監視システム環境情報

jp1pfm.instance

JP1/PFM - RMのインスタンス名

監視対象サーバのリモートエージェントが属するJP1/PFM - RM for Platformのインスタンス名を指定します。

入力

無効

○　

監視情報

jp1pfm.agentLevelDefFileNameLocal

エージェント階層定義ファイル(ローカル)

JP1/AOサーバから転送するエージェント階層定義ファイルをフルパスで指定します。指定しなかった場合，転送および設定は実行されません。

入力

無効

△　

オプション監視情報

jp1pfm.agentLevelDefFileNameRemote

エージェント階層定義ファイル(リモート)

PFM管理サーバへエージェント階層定義ファイルを転送する際の転送先ファイルパスをフルパスで指定します。

入力

無効

△　

オプション監視情報

jp1pfm.alarmTableName

アラームテーブル名

PFM-RMサーバのリモートエージェントからアンバインドするアラームテーブル名を指定します。

入力

無効

△　

オプション監視情報

jp1pfm.jp1pfmLHostName

JP1/PFM - Managerの論理ホスト名

JP1/PFM - Managerがクラスタ構成の場合に，JP1/PFM - Managerの論理ホスト名を指定します。

入力

無効

△　

監視システム環境情報

jp1pfm.jp1pfmRMLHostName

JP1/PFM - RMの論理ホスト名

JP1/PFM - RM for Platformがクラスタ構成の場合に，JP1/PFM - RM for Platformの論理ホスト名を指定します。

入力

無効

△　

監視システム環境情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

common.foreachIPaddress

監視対象サーバのIPアドレス

監視対象サーバのIPアドレスを指定します。複数指定する場合はコンマで区切ってください。IPv6アドレスには対応していません。

入力

無効

○　

監視情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1cm2nnm.nnmHostName

255文字以内の半角英数字および「.」，「-」。

jp1pfm.pfmHostName

255文字以内の半角英数字および「.」，「-」。

jp1pfm.pfmRMHostName

255文字以内の半角英数字および「.」，「-」。

jp1pfm.instance

32文字以内の半角英数字。

jp1pfm.agentLevelDefFileNameLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「"」，「?」，「!」を除く。

jp1pfm.agentLevelDefFileNameRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「"」，「!」，「`」を除く。

jp1pfm.alarmTableName

64文字以内の文字列。ただし，「¥」，「!」，「"」，「#」，「$」，「&」，「'」，「*」，「+」，「:」，「;」，「,」，「<」，「>」，「=」，「?」，「^」，「~」，「`」，「{」，「}」，「|」を除く。

jp1pfm.jp1pfmLHostName

255文字以内の半角英数字および「.」，「-」。

jp1pfm.jp1pfmRMLHostName

255文字以内の半角英数字および「.」，「-」。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

common.foreachIPaddress

1024文字以内の半角数字および「.」，「,」。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

監視設定削除

監視設定削除

繰り返し実行部品

JP1/Cm2/NNMiおよびJP1/PFMから複数の監視対象サーバを削除します。

繰り返されるジョブネット内の指示に従ってください。

2

エージェント階層設定

エージェント階層設定

階層フロー部品

JP1/PFMのエージェント階層を設定します。

−　

2-3

値判定分岐部品

エージェント階層定義ファイルが指定されているか判定します。

エージェント階層を設定する場合は，手動で行ってください。

2-4

階層フロー部品

JP1/PFMのエージェント階層を設定します。

−　

2-4-1

ファイル転送部品

PFM管理サーバにエージェント階層定義ファイルを転送します。

エージェント階層を設定する場合は，手動で行ってください。

2-4-2

エージェント階層設定

JP1/PFMのエージェント階層を設定します。

エージェント階層を設定する場合は，手動で行ってください。

2-4-3

ファイル削除

指定されたファイルを削除します。

手動でファイルを削除してください。

2-5

サービス情報同期

JP1/PFM - Managerのサービス情報をJP1/PFM - Web Consoleに同期させます。

サービス情報を同期させる場合は，PFM管理サーバでjpctool service syncコマンドを実行してください。

2.4.11　監視設定削除(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

ホスト名取得

osGetHostName

ホスト名取得

IPアドレスからホスト名を取得します。

エラー原因を取り除いたあと，サービスを再実行してください。

2

監視対象サーバの削除

jp1nnmDeleteHost

監視対象ノード削除

JP1/Cm2/NNMiから監視対象サーバを削除します。

手動で監視対象サーバをJP1/Cm2/NNMiから削除してください。また手動で監視対象サーバからアラームをアンバインドしたあと，JP1/PFM - RM for Platformから監視対象サーバを削除してください。

5

入力プロパティ判定

CheckMacroValue

値判定分岐部品

JP1/PFM - RM for Platformの論理ホスト名が指定されているか判定します。

手動で監視対象サーバからアラームをアンバインドしたあと，JP1/PFM - RM for Platformから監視対象サーバを削除してください。

6

アラームのアンバインド

jp1pfmReleaseAlarm

アラームのアンバインド(JP1/PFM - RM)

JP1/PFMのリモートエージェントからアラームをアンバインドします。

手動で監視対象サーバからアラームをアンバインドしたあと，JP1/PFM - RM for Platformから監視対象サーバを削除してください。

7

入力プロパティ判定

CheckMacroValue2

値判定分岐部品

JP1/PFM - RM for Platformの論理ホスト名が指定されているか判定します。

手動で監視対象サーバからアラームをアンバインドしたあと，JP1/PFM - RM for Platformから監視対象サーバを削除してください。

8

アラームのアンバインド

jp1pfmReleaseAlarm2

アラームのアンバインド(JP1/PFM - RM)

JP1/PFMのリモートエージェントからアラームをアンバインドします。

手動で監視対象サーバからアラームをアンバインドしたあと，JP1/PFM - RM for Platformから監視対象サーバを削除してください。

9

リモートエージェント削除

jp1pfmDeleteRemoteAgent

監視対象削除(JP1/PFM - RM)

JP1/PFMのリモートエージェントを削除します。

手動でJP1/PFM - RM for Platformから削除してください。

2.4.12　監視設定追加

機能

JP1/Cm2/NNM(またはJP1/Cm2/NNMi)およびJP1/PFMに複数の監視対象サーバを追加します。

このサービステンプレートが前提とするサーバを次に示します。

・NNMサーバ

　JP1/Cm2/NNMまたはJP1/Cm2/NNMiがインストールされているサーバです。

・PFM管理サーバ

　JP1/PFM - ManagerおよびJP1/PFM - Web Consoleがインストールされているサーバです。

・PFM-RMサーバ

　JP1/PFM - RM for Platformがインストールされているサーバです。

・監視対象サーバ

　JP1/Cm2/NNM(またはJP1/Cm2/NNMi)およびJP1/PFMの監視対象として設定するサーバです。

処理の概要を次に示します。

1.NNMサーバのJP1/Cm2/NNMまたはJP1/Cm2/NNMiに対し監視対象ノードを追加します。

2.JP1/PFMに次の監視条件を設定します。

(1)PFM-RMサーバにリモートエージェントを追加します。

　監視対象名には，プロパティcommon.foreachIPaddressで指定したIPアドレスから名前解決されたホスト名を設定します。

(2)追加したリモートエージェントに対してパフォーマンスデータの記録方法を変更します。

(3)追加したリモートエージェントに対してパフォーマンスデータの保存条件を設定します。

(4)追加したリモートエージェントに対してプロセス監視設定を行います。

(5)追加したリモートエージェントに対してアラームテーブルを設定(バインド)します。

(6)PFM管理サーバのJP1/PFM - Web Consoleに対してエージェント階層を設定します。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1) JP1/Cm2/Network Node Manager i 09-10〜10-50

　　JP1/Network Node Manager i 11-00〜12-60

(2) JP1/Performance Management - Manager 09-10-11以降

　　JP1/Performance Management - Web Console 09-10-05以降

　　JP1/Performance Management - Remote Monitor for Platform 09-10以降

　　JP1/Performance Management - Base 09-10以降

(3) JP1/PFM - Manager，JP1/PFM - Web Consoleが同一のサーバにインストールされていること。

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・bind-utilsパッケージがインストールされていること。

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・bind-utilsパッケージがインストールされていること。

(8) AIX V6 (ただし，NNMサーバおよびPFM-RMサーバは除く)

(9) AIX V7 (ただし，NNMサーバおよびPFM-RMサーバは除く)

【サービステンプレート実行システム内前提製品の使用条件】

(1) JP1/AOサーバ上に，JP1/PFMサーバに転送する次のファイルが格納されていること。

　・監視対象の定義ファイル(jpcconf target setupコマンドで指定するファイル名) (必須)

　　ただし，監視対象の定義ファイル中の「Target Host」には次の値を指定してください。

　　「#AGENTNAME#」

　　なお，複数の監視対象サーバに設定する場合でも，接続先のユーザー名，パスワードは監視対象の定義ファイルに指定された同一の情報を設定します。

　・エージェント階層定義ファイル(jpcconf agttree importで指定するファイル名) (任意)

　　このファイル名の指定がない場合，エージェント階層を設定しません。

・記録方法の定義ファイル(jpcasrec updateコマンドで指定するファイル名) (任意)

　　このファイル名の指定がない場合，パフォーマンスデータの記録方法を設定しません。

　　ファイル内のserviceタグのid欄は次の値を指定してください。

　　<service id="7A1#INSTANCENAME#[#AGENTNAME#@#REMOTEMONITORHOST#]">

　　<service id="7A1#INSTANCENAME#[#REMOTEMONITORHOST#]">

　・保存条件の定義ファイル(jpcaspsv updateコマンドで指定するファイル名) (任意)

　　このファイル名の指定がない場合，パフォーマンスデータの保存条件を設定しません。

　　ファイル内のserviceタグのid欄を次のように指定すると指定したプロパティで値を置き換えます。

　　<service id="7S1#INSTANCENAME#[#REMOTEMONITORHOST#]">

　・アプリケーション定義ファイル(jpcprocdef createコマンドで指定するファイル名) (任意)

　　このファイル名の指定がない場合，アプリケーション定義を設定しません。

　※上記ファイルをプロパティに指定するときは必ず転送元と転送先の両方をあわせて指定してください。

(2) JP1/AOサーバ上で，監視対象サーバの名前解決ができること。

(3) JP1/PFM - Managerが起動していること。

(4) JP1/PFMでプロダクト名表示機能が有効になっていること。

(5) JP1/PFMでバインドするアラームテーブルは作成済みであること(空欄の場合はこのサービステンプレートがデフォルトとするアラームテーブル(PFM RM Platform Template Alarms 09.00)がバインドされます)。

(6) JP1/PFM - RM for Platformのインスタンスは作成済みであること。

(7) JP1/Cm2/NNMを使用する場合，ovspmd，ovwdb，pmd，ovtopmd，netmonの5つのプロセスが起動していること。

(8) 複数の監視対象サーバの設定を行う場合，各監視対象サーバは同一のサブネット上に存在する必要があります(指定できるサブネットマスクは1つだけです)。

(9) PFM管理サーバがクラスタ構成の場合，プロパティjp1pfm.pfmHostNameには論理ホストが動作している物理ホスト名を，プロパティjp1pfm.jp1pfmLHostNameには論理ホスト名を指定してください。

(10) PFM-RMサーバがクラスタ構成の場合，プロパティjp1pfm.pfmRMHostNameには論理ホストが動作している物理ホスト名を，プロパティjp1pfm.jp1pfmRMLHostNameには論理ホスト名を指定してください。

(11) PFM管理サーバにおいて，JP1/PFMの認証キーが作成済みであること。

(12) このサービスを実行する場合，エージェントレス接続先としてJP1/AOサーバ("localhost"で解決されるループバックアドレス)および接続先となるサーバを設定する必要があります。

注意事項

(1)このサービスを同一のNNMサーバ，PFM管理サーバおよびPFM-RMサーバに複数同時に実行しないでください。

(2)監視対象のIPアドレスにはIPv6は指定できません。

(3)JP1/Cm2/NNMiのマルチテナントには対応していないため，テナントを使用している場合は，ノードを追加したあとに手動でノードをテナントに移動してください。

(4)JP1/Cm2/NNMiの場合，ノードを追加するためにシードを登録します。そのシードをJP1/Cm2/NNMiではノードを追加したあとに削除することを推奨しています。

このサービスではシードを追加したあとにいつノードが追加されるか不定のため，自動でシードを削除していません。

シードについての詳細はJP1/Cm2/NNMiのリリースノートを参照願います。

(5)JP1/PFM - RM for Platformの稼働OSによって監視可能なOSが異なります。

　 JP1/PFM - RM for Platform(Linux版)の場合は「UNIX/Linux」だけ監視可能です。

　 JP1/PFM - RM for Platform(Windows版)は次の通りです。

　・09-10以前：「Windows」だけ監視可能

　・09-50以降：「Windows/UNIX/Linux」が監視可能

(6)PFM-RMサーバと監視対象サーバの組み合わせによっては，ssh認証やwmi認証の設定が別途必要です。

(7)JP1/PFM - RM for Platformの1インスタンスに登録可能なリモートエージェント数は50個です。監視対象サーバのIPアドレスには，最大でも50個より多く指定しないでください。

(8)UNIX環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

(9)PFM-RMサーバのOSがWindowsでマルチバイト文字を指定する場合は，監視対象定義ファイル(リモート)のパスの長さは250バイト以内となるよう指定してください。

(10)リモートに指定するファイル名が既に存在する場合，リモートのファイルを上書きおよび削除します。指定したファイル名に誤りがないか，十分に確認してください。

(11)リモートに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

(12)監視設定追加(JP1/PFM - RM)またはStoreデータベース保存条件設定の部品でサービスが異常終了し，かつタスクログに"KNAE08132-E コマンドの標準出力のサイズが上限値を超えたため，処理を中断しました（上限値：100キロバイト）。"と表示された場合は，記録方法の定義ファイル(ローカル)プロパティまたは保存条件の定義ファイル(ローカル)プロパティで指定するファイルに記載されているサービスID(<Service>タグ)の数を減らして，再度実行してください。

(13)ジョブエラー時の回復方法としてサービスを再実行する場合以外では，既に追加されている監視対象サーバに対して，このサービスを実行しないでください。

バージョン

03.00.00

タグ

Configure JP1,NNMi,PFM

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

監視システム環境情報

NNMサーバ，PFM管理サーバおよびPFM-RMサーバの環境情報を指定してください。

表示されます。

監視情報

追加する監視対象サーバの監視情報を設定してください。

表示されます。

オプション監視情報

PFM管理サーバに対するエージェント階層の定義，Storeデータベースの記録方法に関する定義情報，Storeデータベースの保存条件に関する定義情報，プロセス監視設定のアプリケーション定義およびアラームテーブルの設定(バインド)情報を指定してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1cm2nnm.nnmHostName

NNMサーバのホスト名

JP1/Cm2/NNM(またはJP1/Cm2/NNMi)がインストールされているサーバのホスト名を指定します。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

監視システム環境情報

jp1pfm.pfmHostName

PFM管理サーバのホスト名

JP1/PFM - ManagerおよびJP1/PFM - Web Consoleがインストールされたサーバのホスト名を指定します。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

監視システム環境情報

jp1pfm.pfmRMHostName

PFM-RMサーバのホスト名

JP1/PFM - RM for Platformがインストールされたサーバのホスト名を指定します。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

監視システム環境情報

jp1cm2nnm.targetSubnetMask

監視対象サーバのサブネットマスク

監視対象サーバのサブネットマスクを指定します(複数指定不可)。JP1/Cm2/NNMを使用する場合は必ず指定してください。

入力

無効

△　

監視情報

jp1pfm.instance

JP1/PFM - RMのインスタンス名

監視対象サーバのリモートエージェントが属するJP1/PFM - RM for Platformのインスタンス名を指定します。

入力

無効

○　

監視情報

jp1pfm.agentDefFileLocal

監視対象の定義ファイル(ローカル)

JP1/AOサーバから転送する監視対象の定義ファイルをフルパスで指定します。

入力

無効

○　

監視情報

jp1pfm.agentDefFileRemote

監視対象の定義ファイル(リモート)

PFM-RMサーバへ監視対象の定義ファイルを転送する際の転送先ファイルパスをフルパスで指定します。

入力

無効

○　

監視情報

jp1pfm.jp1pfmLHostName

JP1/PFM - Managerの論理ホスト名

JP1/PFM - Managerがクラスタ構成の場合に，JP1/PFM - Managerの論理ホスト名を指定します。

入力

無効

△　

監視システム環境情報

jp1pfm.jp1pfmRMLHostName

JP1/PFM - RMの論理ホスト名

JP1/PFM - RM for Platformがクラスタ構成の場合に，JP1/PFM - RM for Platformの論理ホスト名を指定します。

入力

無効

△　

監視システム環境情報

jp1pfm.agentLevelDefFileNameLocal

エージェント階層定義ファイル(ローカル)

JP1/AOサーバから転送するエージェント階層定義ファイルをフルパスで指定します。指定しなかった場合，転送および設定は実行されません。

入力

無効

△　

オプション監視情報

jp1pfm.agentLevelDefFileNameRemote

エージェント階層定義ファイル(リモート)

PFM管理サーバへエージェント階層定義ファイルを転送する際の転送先ファイルパスをフルパスで指定します。

入力

無効

△　

オプション監視情報

jp1pfm.paramDefFileLocal

記録方法の定義ファイル(ローカル)

JP1/AOサーバから転送する記録方法の定義ファイルをフルパスで指定します。指定しなかった場合，転送および設定は実行されません。

入力

無効

△　

オプション監視情報

jp1pfm.paramDefFileRemote

記録方法の定義ファイル(リモート)

PFM管理サーバへ記録方法の定義ファイルを転送する際の転送先ファイルパスをフルパスで指定します。

入力

無効

△　

オプション監視情報

jp1pfm.saveConditionDefFileNameLocal

保存条件の定義ファイル(ローカル)

JP1/AOサーバから転送する保存条件の定義ファイル名をフルパスで指定します。指定しなかった場合，転送および設定は実行されません。

入力

無効

△　

オプション監視情報

jp1pfm.saveConditionDefFileNameRemote

保存条件の定義ファイル(リモート)

PFM管理サーバに保存条件の定義ファイルを転送する際の転送先ファイルパスをフルパスで指定します。

入力

無効

△　

オプション監視情報

jp1pfm.procMonDefFileLocal

アプリケーション定義ファイル(ローカル)

JP1/AOサーバから転送するアプリケーション定義ファイルをフルパスで指定します。指定しなかった場合，転送および設定は実行されません。

入力

無効

△　

オプション監視情報

jp1pfm.procMonDefFileRemote

アプリケーション定義ファイル(リモート)

PFM管理サーバへアプリケーション定義ファイルを転送する際の転送先ファイルパスをフルパスで指定します。

入力

無効

△　

オプション監視情報

jp1pfm.alarmTableName

アラームテーブル名

PFM-RMサーバのリモートエージェントにバインドするアラームテーブル名を指定します。

入力

無効

△　

オプション監視情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

common.foreachIPaddress

監視対象サーバのIPアドレス

監視対象サーバのIPアドレスを指定します。複数指定する場合はコンマで区切ってください。IPv6アドレスには対応していません。

入力

無効

○　

監視情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1cm2nnm.nnmHostName

255文字以内の半角英数字および「.」，「-」。

jp1pfm.pfmHostName

255文字以内の半角英数字および「.」，「-」。

jp1pfm.pfmRMHostName

255文字以内の半角英数字および「.」，「-」。

jp1cm2nnm.targetSubnetMask

15文字以内の半角数字および「.」。

jp1pfm.instance

32文字以内の半角英数字。

jp1pfm.agentDefFileLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「"」，「?」，「!」を除く。

jp1pfm.agentDefFileRemote

250文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「"」，「!」，「`」を除く。

jp1pfm.jp1pfmLHostName

255文字以内の半角英数字および「.」，「-」。

jp1pfm.jp1pfmRMLHostName

255文字以内の半角英数字および「.」，「-」。

jp1pfm.agentLevelDefFileNameLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「"」，「?」，「!」を除く。

jp1pfm.agentLevelDefFileNameRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「"」，「!」，「`」を除く。

jp1pfm.paramDefFileLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「"」，「?」，「!」を除く。

jp1pfm.paramDefFileRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「"」，「!」，「`」を除く。

jp1pfm.saveConditionDefFileNameLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「"」，「?」，「!」を除く。

jp1pfm.saveConditionDefFileNameRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「"」，「!」，「`」を除く。

jp1pfm.procMonDefFileLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「"」，「?」，「!」を除く。

jp1pfm.procMonDefFileRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「"」，「!」，「`」を除く。

jp1pfm.alarmTableName

64文字以内の文字列。ただし，「¥」，「!」，「"」，「#」，「$」，「&」，「'」，「*」，「+」，「:」，「;」，「,」，「<」，「>」，「=」，「?」，「^」，「~」，「`」，「{」，「}」，「|」を除く。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

common.foreachIPaddress

1024文字以内の半角数字および「.」，「,」。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

監視設定追加

監視設定追加

繰り返し実行部品

JP1/Cm2/NNM(またはJP1/Cm2/NNMi)およびJP1/PFMに複数の監視対象サーバを追加します。

エラー原因を取り除いたあと，サービスを再実行してください。

2

エージェント階層設定追加

エージェント階層設定追加

階層フロー部品

JP1/PFMのエージェント階層を設定します。

−　

2-3

値判定分岐部品

エージェント階層定義ファイルが指定されているか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

2-4

階層フロー部品

JP1/PFMのエージェント階層を設定します。

−　

2-4-1

ファイル転送部品

PFM管理サーバにエージェント階層定義ファイルを転送します。

エラー原因を取り除いたあと，サービスを再実行してください。

2-4-2

エージェント階層設定

JP1/PFMのエージェント階層を設定します。

エラー原因を取り除いたあと，サービスを再実行してください。

2-4-3

ファイル削除

指定されたファイルを削除します。

エラー原因を取り除いたあと，サービスを再実行してください。

2.4.13　監視設定追加(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

ホスト名取得

getIPaddrByHost

ホスト名取得

IPアドレスからホスト名を取得します。

エラー原因を取り除いたあと，サービスを再実行してください。

2

ノード監視の監視対象サーバ追加

addNodeMonitoringNodeConf

階層フロー部品

NNMサーバに監視対象サーバを追加します。

−　

2-1

監視対象ノード追加

NNMサーバのJP1/Cm2/NNM(またはJP1/Cm2/NNMi)に監視対象サーバを追加します。

エラー原因を取り除いたあと，サービスを再実行してください。

3

リソース監視設定追加

addMonitoringResourceConf

階層フロー部品

JP1/PFMにリモートエージェントを追加します。

−　

3-3

ファイル転送部品

PFM-RMサーバに監視対象の定義ファイルを転送します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-4

監視対象追加(JP1/PFM - RM)

JP1/PFMにリモートエージェントを追加します。

部品の戻り値が「15」の場合は指定されたインスタンスには既に50個の監視エージェントが追加済みのため，監視エージェントを追加できません。サービス編集画面で別のインスタンスを指定してサービスを再実行してください。

戻り値が「15」以外の場合は，エラー原因を取り除いたあと，サービスを再実行してください。

3-5

ファイル削除

指定されたファイルを削除します。

エラー原因を取り除いたあと，サービスを再実行してください。

4

パフォーマンスデータの格納設定変更

addStoreRecordUpdateConf

階層フロー部品

リモートエージェントの記録方法の定義を変更します。

−　

4-3

値判定分岐部品

プロパティファイルが指定されているか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

4-4

階層フロー部品

リモートエージェントの記録方法の定義を変更します。

−　

4-4-1

ファイル転送部品

PFM管理サーバに記録方法の定義ファイルを転送します。

エラー原因を取り除いたあと，サービスを再実行してください。

4-4-2

値判定分岐部品

JP1/PFM - RM for Platformの論理ホスト名が指定されているか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

4-4-3

監視設定追加(JP1/PFM - RM)

リモートエージェントの記録方法の定義を変更します。

エラー原因を取り除いたあと，サービスを再実行してください。

4-4-4

値判定分岐部品

JP1/PFM - RM for Platformの論理ホスト名が指定されているか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

4-4-5

監視設定追加(JP1/PFM - RM)

リモートエージェントの記録方法の定義を変更します。

エラー原因を取り除いたあと，サービスを再実行してください。

4-4-6

ファイル削除

指定されたファイルを削除します。

エラー原因を取り除いたあと，サービスを再実行してください。

4-7

値判定分岐部品

保存条件の定義ファイルが指定されているか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

4-8

階層フロー部品

Storeデータベースに保存条件を設定します。

−　

4-8-1

ファイル転送部品

PFM管理サーバに保存条件の定義ファイルを転送します。

エラー原因を取り除いたあと，サービスを再実行してください。

4-8-2

値判定分岐部品

JP1/PFM - RM for Platformの論理ホスト名が指定されているか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

4-8-3

Storeデータベース保存条件設定

Storeデータベースに保存条件を設定します。

エラー原因を取り除いたあと，サービスを再実行してください。

4-8-4

値判定分岐部品

JP1/PFM - RM for Platformの論理ホスト名が指定されているか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

4-8-5

Storeデータベース保存条件設定

Storeデータベースに保存条件を設定します。

エラー原因を取り除いたあと，サービスを再実行してください。

4-8-6

ファイル削除

指定されたファイルを削除します。

エラー原因を取り除いたあと，サービスを再実行してください。

5

プロセス監視設定追加

addProcessMonitoringConf

階層フロー部品

リモートエージェントにアプリケーション定義を追加します。

−　

5-3

値判定分岐部品

アプリケーション定義ファイルが指定されているか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

5-4

階層フロー部品

リモートエージェントにアプリケーション定義を追加します。

−　

5-4-1

ファイル転送部品

PFM管理サーバにアプリケーション定義ファイルを転送します。

エラー原因を取り除いたあと，サービスを再実行してください。

5-4-2

値判定分岐部品

JP1/PFM - RM for Platformの論理ホスト名が指定されているか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

5-4-3

プロセス監視設定追加

リモートエージェントにアプリケーション定義を追加します。

エラー原因を取り除いたあと，サービスを再実行してください。

5-4-4

値判定分岐部品

JP1/PFM - RM for Platformの論理ホスト名が指定されているか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

5-4-5

プロセス監視設定追加

リモートエージェントにアプリケーション定義を追加します。

エラー原因を取り除いたあと，サービスを再実行してください。

5-4-6

ファイル削除

指定されたファイルを削除します。

エラー原因を取り除いたあと，サービスを再実行してください。

6

アラーム設定追加

addAlarmConf

階層フロー部品

リモートエージェントにアラームテーブルをバインドします。

−　

6-1

値判定分岐部品

JP1/PFM - RM for Platformの論理ホスト名が指定されているか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

6-2

アラームのバインド(JP1/PFM - RM)

リモートエージェントにアラームテーブルをバインドします。

エラー原因を取り除いたあと，サービスを再実行してください。

6-3

値判定分岐部品

JP1/PFM - RM for Platformの論理ホスト名が指定されているか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

6-4

アラームのバインド(JP1/PFM - RM)

リモートエージェントにアラームテーブルをバインドします。

エラー原因を取り除いたあと，サービスを再実行してください。

2.5　JP1（運用）用のサービステンプレート

2.5.1　JP1/AJSジョブネット実行登録

機能

JP1/AJS3 - Manager(またはJP1/AJS2 - Manager)に定義されたルートジョブネットを実行します。実行時に必要となるJP1/AJS3(JP1/AJS2)のマクロ変数を指定することができます。

このサービステンプレートが前提とするサーバを次に示します。

・業務サーバ

　JP1/AJS3 - Manager(またはJP1/AJS2 - Manager)が動作するサーバです。実行対象のジョブネットが登録されている必要があります。

処理の流れを次に示します。

(1) 業務サーバのJP1/AJS3 - Manager(またはJP1/AJS2 - Manager)に対してジョブネットの実行を指示し，完了を待ちます。

(2) 業務サーバでジョブネットの実行結果を確認し，表示します。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)業務サーバに次の製品が稼働していること。

　JP1/Automatic Job Management System 3 - Manager 09-00以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【サービステンプレート実行システム内前提製品の使用条件】

(1)業務サーバ上に実行対象のジョブネットが作成されている必要があります。

(2)このサービステンプレートはルートジョブネットの実行登録だけサポートしています。ジョブグループの一括実行はサポートしていません。

(3)このサービステンプレートはジョブネットの即時実行登録だけ可能です。また，起動条件が付与されたジョブネットは起動条件が無効になります。

(4)プロパティjp1ajs.executeJP1UserNameには，業務サーバでジョブネットの実行登録を行うJP1ユーザー名を指定してください。JP1/AOから接続するOSユーザーと同一の名前のJP1ユーザーで実行登録を行う場合は，このプロパティに値を指定する必要はありません。

(5)クラスタ構成の論理ホスト上に定義されているジョブネットを登録する場合は，

プロパティcommon.targetHostに実行系サーバの物理ホスト名または論理ホスト名を，

プロパティjp1ajs.ajsServiceNameに論理ホストで動作しているスケジューラーサービス名を,

プロパティjp1ajs.jp1ajsLHostNameにスケジューラーサービスが動作している論理ホスト名を指定してください。

注意事項

(1)このサービステンプレートはジョブネットの即時実行登録だけを行います。完了までに長時間を要するなどのジョブネットの実行状況は，適宜JP1/AJS3 - View(またはJP1/AJS2 - View)を使用して確認してください。

(2)JP1/AOでタスクを停止した場合でも，連携先JP1/AJS3(またはJP1/AJS2)においてジョブネットの実行は継続されます。必要に応じてJP1/AJS3 - View(またはJP1/AJS2 - View)を使用して実行状況を確認し，異常終了であればエラー原因を取り除いてタスクを再実行してください。

(3)プロパティjp1ajs.ajsMacroParameterに指定可能なマクロパラメーターは全体で1024文字までです。

(4)ジョブネットに使用できる文字は半角英数字と記号(!#$%+@-._)および全角文字です。全角文字は，業務サーバ側がWindowsでJP1/AJSのマネージャー文字コード種別がSJISの時に使えます。

(5)UNIX環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

(6)業務サーバのOSがWindowsでマルチバイト文字を指定する場合は，ジョブネット名の長さは930バイト以内となるよう指定してください。サービス名の長さは255バイト以内となるよう指定してください。

実行権限

JP1/AOから業務サーバに接続する際のOSユーザーに，次の設定が必要です。

接続するOSユーザーと同名のJP1ユーザーが存在しない場合，プロパティjp1ajs.executeJP1UserNameを必ず指定してください。

[Windows，UNIX共通]

JP1_AJS_Operator権限，JP1_AJS_Manager権限，JP1_AJS_Admin権限のどれかの権限を付与されたJP1ユーザーと同名であること。

バージョン

02.00.00

タグ

Configure JP1,AJS

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

業務システム環境情報

業務サーバの環境情報を指定してください。

表示されます。

業務情報

実行するジョブネットの情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1ajs.ajsServiceName

ジョブネット実行先のJP1/AJSのサービス名

ジョブネット実行先のJP1/AJSのスケジューラーのサービス名を指定します。クラスタ構成の場合は論理ホストのスケジューラーサービス名を指定します。

入力

無効

△　

業務情報

jp1ajs.ajsJobnetName

実行登録するジョブネット名

実行するジョブネットの名称を完全名で指定します。マネージャージョブグループ名とマネージャージョブネット名は指定できません。

入力

無効

○　

業務情報

jp1ajs.executeJP1UserName

ジョブネット実行時のJP1ユーザー名

ジョブネットを実行する際のJP1ユーザー名を指定します。業務サーバに接続する際のOSユーザー名と同一のJP1ユーザーで実行する場合，指定する必要はありません。

入力

無効

△　

業務情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

common.targetHost

業務サーバのホスト名

業務サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

業務システム環境情報

jp1ajs.ajsMacroParameter

ジョブネット実行時のマクロ変数

実行するジョブネットで必要となるマクロ変数の値を"変数名:値,…"の形式で指定します。

入力

無効

△　

業務情報

jp1ajs.jp1ajsLHostName

JP1/AJSの論理ホスト名

JP1/AJSがクラスタ構成の場合，JP1/AJSの論理ホスト名を指定します。

入力

無効

△　

業務システム環境情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

jp1ajs.jobnetResult

ジョブネットの実行結果

ジョブネットの実行結果を格納します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1ajs.ajsServiceName

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。

jp1ajs.ajsJobnetName

930バイト以内の文字列。使用できる文字列は半角英数字と記号(!#$%+@-._/)と全角文字。

jp1ajs.executeJP1UserName

31文字以内の半角英数字，および「!」，「#」，「$」，「%」，「'」，「-」，「@」，「_」，「~」。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

common.targetHost

255文字以内の半角英数字および「.」，「-」。

jp1ajs.ajsMacroParameter

1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。

jp1ajs.jp1ajsLHostName

255文字以内の半角英数字および「.」，「-」。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

ジョブネット起動

ジョブネット起動

JP1/AJSジョブネット実行登録

業務サーバにジョブネットの実行登録を行います。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

ジョブネット実行結果取得

ジョブネット実行結果取得

JP1/AJSのジョブネット実行結果取得

指定されたジョブネットの実行結果を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2.5.2　JP1/AJSのジョブネット計画確定実行登録

機能

このサービステンプレートは，JP1/AJS3 - Manager (またはJP1/AJS2 - Manager，以降まとめてJP1/AJSと呼びます)に定義されたルートジョブネットの計画実行登録，または確定実行登録を実施します。

実行時に必要となるJP1/AJSのマクロ変数を指定することができます。

このサービステンプレートが前提とするサーバを次に示します。

・業務サーバ

　JP1/AJSが動作するサーバです。実行対象のジョブネットが作成されている必要があります。

　ジョブネットはJP1/AJSのajsentryコマンドで実行登録可能なジョブネットである必要があります。マネージャージョブグループ名とマネージャージョブネット名は指定できません。

処理の流れを次に示します。

(1) 実行登録種別から，計画実行登録か確定実行登録かを判定します。

　　次のどちらかの処理を実行します。

　(a) 計画実行登録が指定された場合，業務サーバのJP1/AJSに対して指定されたジョブネットの計画登録実行を行います。

　(b) 確定実行登録が指定された場合，業務サーバのJP1/AJSに対して指定されたジョブネットの確定登録実行を行います。

　　・ジョブネットを特定の日時に実行(日時指定)する場合

　　　jp1ajs.executeDateプロパティとjp1ajs.executeTimeプロパティを指定します。

　　・ジョブネットの実行予定世代数を指定して実行(未来世代数指定)する場合

　　　jp1ajs.executeGenerationプロパティを指定します。

　　どちらかを必ず指定してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1) 業務サーバに次の製品が稼働していること。

　JP1/Automatic Job Management System 3 - Manager 09-00以降

　JP1/Automatic Job Management System 3 - Manager 10-00以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【サービステンプレート実行システム内前提製品の使用条件】

(1) jp1ajs.entryJP1UserNameプロパティには，実行対象サーバでジョブネットの実行登録を行うためのJP1ユーザー名を指定してください。JP1/AOから接続するOSユーザーと同一名のJP1ユーザーで実行登録を行う場合は，このプロパティに値を指定する必要はありません。

(2) クラスタ構成の論理ホスト上に定義されているジョブネットを登録する場合は，

・common.targetHostプロパティに実行系サーバの物理ホスト名または論理ホスト名を，

・jp1ajs.ajsServiceNameプロパティに論理ホストで動作しているスケジューラーサービス名を，

・jp1ajs.jp1ajsLHostNameプロパティにスケジューラーサービスが動作している論理ホスト名を指定してください。

注意事項

(1) 業務サーバのOSがUNIXの場合，業務サーバのJP1/AJSの環境設定パラメタの文字コード設定と業務サーバへの接続に使用するOSユーザーのデフォルトロケールの設定を一致させてください。

(2) jp1ajs.ajsserviceNameプロパティに設定するスケジューラーサービス名は30バイト以内となるよう指定してください。

(3) jp1ajs.entryJobnetNameプロパティにジョブグループは指定できません。

(4) その他の注意事項については，JP1/AJSのマニュアル「コマンドリファレンス１」のajsentryコマンドの注意事項を参照してください。

実行権限

(1) 業務サーバに接続する際のOSユーザーにマッピングされているJP1ユーザーが，実行登録対象のジョブネットに対して操作権限を持っていること。

(2) 業務サーバに接続する際のOSユーザーにマッピングされているJP1ユーザーが存在しない場合，jp1ajs.entryJP1UserNameプロパティに実行登録対象のジョブネットに対して操作権限を持つJP1ユーザーを指定してください。

バージョン

03.00.00

タグ

Configure JP1,AJS

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

業務システム環境情報

業務サーバの環境情報を指定してください。

表示されます。

ジョブネット登録情報

実行するジョブネットの情報を指定してください。

表示されます。

確定実行情報

確定実行登録の情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

common.targetHost

業務サーバのホスト名

業務サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

業務システム環境情報

jp1ajs.ajsServiceName

ジョブネット実行先のJP1/AJSのサービス名

ジョブネット実行先のJP1/AJSのスケジューラーのサービス名を指定します。クラスタ構成の場合は論理ホストのスケジューラーサービス名を指定します。

入力

無効

△　

業務システム環境情報

jp1ajs.jp1ajsLHostName

JP1/AJSの論理ホスト名

JP1/AJSがクラスタ構成の場合，JP1/AJSの論理ホスト名を指定します。

入力

無効

△　

業務システム環境情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1ajs.entryJobnetName

実行登録するジョブネット名

実行登録するジョブネットの名称を完全名で指定します。マネージャージョブグループ名とマネージャージョブネット名は指定できません。

入力

無効

○　

ジョブネット登録情報

jp1ajs.entryType

ジョブネットの実行登録方法

ジョブネットを計画実行登録するか，確定実行登録するかを指定します。Fixed:確定実行登録，Planned:計画実行登録。

入力

無効

○　

ジョブネット登録情報

jp1ajs.executePrior

スケジューラーサービス停止中の予定実行要否

スケジューラーサービス停止中に実行予定の日時が経過した場合，スケジューラーサービスが再起動した時に，実行予定を実行するか，次の実行予定から実行するかを指定します。true:経過した実行予定を実行する，false:次の実行予定から実行する。

入力

無効

○　

ジョブネット登録情報

jp1ajs.ajsMacroParameter

ジョブネット実行時のマクロ変数

実行するジョブネットで必要となるマクロ変数の値を"変数名:値,…"の形式で指定します。マクロ変数は32個まで指定できます。

入力

無効

△　

ジョブネット登録情報

jp1ajs.entryJP1UserName

ジョブネット実行登録JP1ユーザー名

ジョブネットを実行登録する時のJP1ユーザー名を指定します。業務サーバに接続する際のOSユーザー名と同一名称のJP1ユーザーで実行登録する場合，指定する必要はありません。

入力

無効

△　

ジョブネット登録情報

jp1ajs.executeDate

ジョブネットの確定実行日付

ジョブネットを確定実行登録するときの確定実行日付をカレンダーから選択します。

入力

無効

△　

確定実行情報

jp1ajs.executeTime

ジョブネットの確定実行時間(hh:mm)

ジョブネットを確定実行登録するときの確定実行時刻を：で区切って，hh:mmの形式で指定します。:mmは省略できます。省略時は0分が仮定されます。

入力

無効

△　

確定実行情報

jp1ajs.executeGeneration

ジョブネットの未来予定世代数

ジョブネットを確定実行登録するときに，次回以降の実行予定世代数を指定します。

入力

無効

△　

確定実行情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

common.targetHost

255文字以内の半角英数字および「.」，「-」。

jp1ajs.ajsServiceName

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。

jp1ajs.jp1ajsLHostName

255文字以内の半角英数字および「.」，「-」。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1ajs.entryJobnetName

930バイト以内の文字列。使用できる文字列は半角英数字と記号(!#$%+@-._/)と全角文字。

jp1ajs.entryType

次の値のどれかを選択する。

Fixed,Planned

jp1ajs.executePrior

次の値のどれかを選択する。

false,true

jp1ajs.ajsMacroParameter

1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。

jp1ajs.entryJP1UserName

31文字以内の半角英数字，および「!」，「#」，「$」，「%」，「'」，「-」，「@」，「_」，「~」。

jp1ajs.executeDate

10文字以内の半角数字と「/」。

jp1ajs.executeTime

5文字以内の半角英数字と「:」。

jp1ajs.executeGeneration

1〜99までの数値。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

JP1/AJSジョブネット計画実行登録

JP1/AJSジョブネット計画実行登録

階層フロー部品

JP1/AJSのジョブネットを計画実行登録します

−　

1-1

値判定分岐部品

計画実行登録か判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

1-2

JP1/AJSジョブネット計画実行登録

JP1/AJSのジョブネットを計画実行登録します

エラーの原因を取り除いたあと，サービスを再実行してください。

2

JP1/AJSジョブネット確定実行登録

JP1/AJSジョブネット確定実行登録

階層フロー部品

JP1/AJSのジョブネットを確定実行登録します

−　

2-1

値判定分岐部品

確定実行登録か判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

2-2

JP1/AJSジョブネット確定実行登録

JP1/AJSのジョブネットを確定実行登録します

エラーの原因を取り除いたあと，サービスを再実行してください。

2.5.3　JP1/AJSのジョブネット実行予実績出力

機能

このサービステンプレートは，JP1/AJS3 - Manager (またはJP1/AJS2 - Manager，以降まとめてJP1/AJSと呼びます)に対して実行登録済みのジョブネットと配下のジョブの，前回までの実行結果，現在の状態，および次回の実行予定などの情報を指定されたファイルにCSV形式で出力します。

このサービステンプレートが前提とするサーバを次に示します。

・業務サーバ

　JP1/AJSが動作するサーバです。実行対象のジョブネットが登録されている必要があります。

処理の流れを次に示します。

(1) 業務サーバのJP1/AJSに対して，指定されたジョブネットと配下のジョブの，実行予実績出力開始日と実行予実績出力終了日の間の，前回までの実行結果，現在の状態，および次回の実行予定などの情報を指定されたファイル(実行予実績ファイルと呼びます)に出力します。

(2) 出力した業務サーバ上の実行予実績ファイル(リモート)をJP1/AOサーバ上の転送先ファイル(ローカル)に転送します。

(3) 業務サーバ上の実行予実績ファイル(リモート)を削除します。

スケジュールにしたがって実行登録されたジョブネットの予定を出力した場合，次回実行予定を確認できます。それ以降の実行予定を確認したい場合，必要に応じてJP1/AJS3 - View(またはJP1/AJS2 - View)のマンスリースケジュール画面を確認してください。

○予実績ファイルの出力形式

次の情報をCSV形式で出力します。

・実行予定出力のジョブネット/ジョブ名完全名

・ユニットの種別

・ジョブネットの状態

・次回実行予定日時

・ジョブネットの実行登録日時

・実行登録方法種別

・ジョブネットの実行登録ユーザー名

・未来世代数

・ジョブネット/ジョブの実行開始日時

・ジョブネット/ジョブの実行終了日時

・ジョブの終了コード

・エージェントホスト名

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1) 業務サーバに次の製品が稼働していること。

　JP1/Automatic Job Management System 3 - Manager 09-00以降

　JP1/Automatic Job Management System 3 - Manager 10-00以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【サービステンプレート実行システム内前提製品の使用条件】

(1) 参照するジョブネットが作成されていること。

(2) 参照するジョブネットのカレンダー，スケジュールルールを定義されていること。

(3) jp1ajs.readJP1UserNameプロパティには，実行対象サーバでジョブネットの実行予実績を出力するためのJP1ユーザー名を指定してください。JP1/AOから接続するOSユーザーと同一名のJP1ユーザーで実行登録を行う場合は，このプロパティに値を指定する必要はありません。

(4) クラスタ構成の論理ホスト上に定義されているジョブネットを参照する場合は，

・common.targetHostプロパティに実行系サーバの物理ホスト名または論理ホスト名を，

・jp1ajs.ajsServiceNameプロパティに論理ホストで動作しているスケジューラーサービス名を，

・jp1ajs.jp1ajsLHostNameプロパティにスケジューラーサービスが動作している論理ホスト名を指定してください。

注意事項

(1) 業務サーバのOSがUNIXの場合，業務サーバのJP1/AJSの環境設定パラメタの文字コード設定と業務サーバへの接続に使用するOSユーザーのデフォルトロケールの設定を一致させてください。

(2) jp1ajs.ajsServiceNameプロパティに設定するスケジューラーサービス名は30バイト以内となるよう指定してください。

(3) 業務サーバのOSがWindowsでマルチバイト文字を指定する場合は，jp1ajs.jobnetOutputFileNameRemoteプロパティに設定する実行予実績ファイルは256バイト以内となるよう指定してください。

(4) マルチバイト文字を指定する場合は，jp1ajs.jobnetOutputFileNameLocalプロパティに設定する転送先ファイルは256バイト以内となるよう指定してください。

(5) jp1ajs.jobnetOutputFileNameRemoteプロパティ，jp1ajs.jobnetOutputFileNameLocalプロパティに設定したファイルがすでに存在する場合，既存のファイルを上書きします。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(6) jp1ajs.jobnetOutputFileNameRemoteプロパティ，jp1ajs.jobnetOutputFileNameLocalプロパティに設定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

(7) jp1ajs.outputStartDateプロパティとjp1ajs.outputEndDateプロパティに設定する年月日の間隔は狭く設定してください。

(8) 指定されたジョブネット名と配下のジョブ名に「"」が含まれている場合，実行予実績ファイルにそのまま出力されます。ODBCドライバで読み込む際に不具合が生じることがあります。必要に応じて実行予実績ファイルを取得したあとに，文字の置換などを行ってください。

(9) その他の注意事項については，JP1/AJSのマニュアル「コマンドリファレンス１」のajsshowコマンドの注意事項を参照してください。

実行権限

(1) 業務サーバに接続する際のOSユーザーにマッピングされているJP1ユーザーが，実行登録対象のジョブネットに対して参照権限を持っていること。

(2) 業務サーバに接続する際のOSユーザーにマッピングされているJP1ユーザーが存在しない場合，jp1ajs.readJP1UserNameプロパティに対象のジョブネットに対して参照権限を持つJP1ユーザーを指定してください。

バージョン

03.00.00

タグ

Configure JP1,AJS

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

業務システム環境情報

業務サーバの環境情報を指定してください。

表示されます。

ジョブネット出力情報

実行予実績を出力するジョブネットの情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

common.targetHost

業務サーバのホスト名

業務サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

業務システム環境情報

jp1ajs.ajsServiceName

ジョブネット実行先のJP1/AJSのサービス名

ジョブネット実行先のJP1/AJSのスケジューラーのサービス名を指定します。クラスタ構成の場合は論理ホストのスケジューラーサービス名を指定します。

入力

無効

△　

業務システム環境情報

jp1ajs.jp1ajsLHostName

JP1/AJSの論理ホスト名

JP1/AJSがクラスタ構成の場合，JP1/AJSの論理ホスト名を指定します。

入力

無効

△　

業務システム環境情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1ajs.targetJobnetName

実行予実績を出力するジョブネット名

実行予実績を出力するジョブネットの名称を完全名で指定します。マネージャージョブグループ名とマネージャージョブネット名は指定できません。

入力

無効

○　

ジョブネット出力情報

jp1ajs.outputStartDate

ジョブネットの実行予実績出力開始日

ジョブネットの実行予実績の出力開始日をカレンダーから選択します。

入力

無効

○　

ジョブネット出力情報

jp1ajs.outputEndDate

ジョブネットの実行予実績出力終了日

ジョブネットの実行予実績の出力終了日をカレンダーから選択します。

入力

無効

○　

ジョブネット出力情報

jp1ajs.readJP1UserName

ジョブネット実行予実績参照時のJP1ユーザー名

ジョブネット実行予実績参照時のJP1ユーザー名を指定します。業務サーバに接続する際のOSユーザー名と同一名称のJP1ユーザーで参照する場合，指定する必要はありません。

入力

無効

△　

ジョブネット出力情報

jp1ajs.jobnetOutputFileNameRemote

出力ファイル名(リモート)

ジョブネットの実行予実績ファイルを業務サーバに出力する際の一時ファイル名をフルパスで指定します。転送後にリモートのファイルは削除されます。

入力

無効

○　

ジョブネット出力情報

jp1ajs.jobnetOutputFileNameLocal

出力ファイル名(ローカル)

ジョブネットの実行予実績ファイルを取得するJP1/AOサーバのファイル名をフルパスで指定します。

入力

無効

○　

ジョブネット出力情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

common.targetHost

255文字以内の半角英数字および「.」，「-」。

jp1ajs.ajsServiceName

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。

jp1ajs.jp1ajsLHostName

255文字以内の半角英数字および「.」，「-」。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1ajs.targetJobnetName

930バイト以内の文字列。使用できる文字列は半角英数字と記号(!#$%+@-._/)と全角文字。

jp1ajs.outputStartDate

10文字以内の半角数字と「/」。

jp1ajs.outputEndDate

10文字以内の半角数字と「/」。

jp1ajs.readJP1UserName

31文字以内の半角英数字，および「!」，「#」，「$」，「%」，「'」，「-」，「@」，「_」，「~」。

jp1ajs.jobnetOutputFileNameRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」を除く。

jp1ajs.jobnetOutputFileNameLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

JP1/AJSジョブネット実行予実績出力

JP1/AJSジョブネット実行予実績出力

JP1/AJSジョブネット実行予実績出力

JP1/AJSのジョブネットの実行予実績をファイルに出力します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

ファイル転送

ファイル転送

階層フロー部品

ファイルを転送します。

−　

2-1

ファイル転送部品

実行予実績ファイル(リモート)を実行予実績ファイル(ローカル)へ転送します。

実行予実績ファイル(リモート)を実行予実績ファイル(ローカル)へ転送してください。

転送したあとに，実行予実績ファイル(リモート)を削除してください。

2-2

ファイル削除

実行予実績ファイル(リモート)を削除します。

実行予実績ファイル(リモート)を削除してください。

2.5.4　JP1/AJSのルートジョブネット移行

機能

このサービステンプレートは，CSV(Comma Separated Values)ファイルまたはMicrosoft Excelによって作成されたルートジョブネットの一覧情報(これ以降，ルートジョブネット定義ファイルと呼びます)を使用して，JP1/AJS3 - Manager (以降JP1/AJSと呼びます)のルートジョブネットを開発サーバから一括して取得し，業務サーバへ移行します。

JP1/AOサーバがWindows環境の場合はCSVファイルまたはExcelファイル，UNIX環境の場合はCSVファイルを使用します。

このサービステンプレートが前提とするサーバを次に示します。

・開発サーバ

　JP1/AJSが動作するサーバです。取得対象のルートジョブネットが登録されている必要があります。

・業務サーバ

　JP1/AJSが動作するサーバです。取得したルートジョブネットを登録します。

jp1ajs.jobnetListFilePathプロパティで指定するルートジョブネット定義ファイルからキー値を記載した列を取り出し，すべてのキー値に対して次の処理を実行します。

(1) キー値に合致する行の，ルートジョブネット名，ジョブ実行エージェントホスト名，実行ユーザー名を読み取ります。

(2) 処理(1)で読み取った情報を使用して，開発サーバでajsprintコマンドを実行し，ルートジョブネットの情報をユニット定義ファイルとして出力します。

(3) JP1/AOサーバをいったん経由して(2)で出力されたユニット定義ファイルを業務サーバへ転送します。

(4) 業務サーバでajsdefineコマンドを実行し，ルートジョブネットを登録します。

(5) ジョブ実行エージェントホスト名が指定されている場合，業務サーバでajschangeコマンドを実行し，ルートジョブネット配下すべてのジョブのジョブ実行エージェントホスト名を変更します。

(6) 実行ユーザー名が指定されている場合，業務サーバでajschangeコマンドを実行し，ルートジョブネット配下すべてのジョブの実行ユーザー名を変更します。

ルートジョブネット定義ファイルには，ルートジョブネット情報を99件(99行)まで記載できます。

各変更処理は，繰り返し部品で逐次的に実行します。繰り返しの中で処理が失敗した場合は，処理が失敗した時点でタスクが異常終了します。

ルートジョブネット定義ファイル読み込みに失敗した場合は，OS.fileOpenRetryIntervalプロパティに指定した秒数待ってファイル読み込みをリトライする処理を，OS.fileOpenRetryCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

JP1/AOサーバ，実行対象サーバのOSがWindowsの場合，このサービステンプレートの実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。各サーバにadministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行うサービス「JP1/AJSのルートジョブネット移行(SYSTEM)」を実行してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1) JP1/AOサーバがWindows環境の場合，次に示すMicrosoft社のプログラムがJP1/AOサーバにインストールされていること。

　2007 Office system ドライバ，または

　Microsoft Access データベース エンジン 2010（32bit版），または

　Microsoft Access Database Engine 2016（32bit版）

(2) 開発サーバ，および業務サーバに次の製品が稼働していること。

　JP1/Automatic Job Management System 3 - Manager 09-00以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【サービステンプレート実行システム内前提製品の使用条件】

(1) JP1/AJSのスケジューラーサービスが起動されていること。

(2) jp1ajs.jp1UserNameプロパティに指定したJP1ユーザーが，開発サーバと業務サーバに登録されていること。

(3) 移行対象となっているルートジョブネットが，業務サーバに登録されていないこと。

　ルートジョブネットが既に登録されている場合，「JP1/AJSのルートジョブネット削除」サービスを使用することで一括して削除できます。

(4) このサービステンプレートはルートジョブネットの移行だけサポートします。ジョブグループの一括移行はサポートしません。

(5) 開発サーバと業務サーバのOS種別(Windows/UNIX)が同一であること。

(6) JP1/AOサーバ上に，次に示す内容を記載したルートジョブネット定義ファイルを格納していること。

・列数

　データの読み取り開始列から数えた列数が255列以内となるようにしてください。

・列名

　・CSVファイルの場合

　　・列名が必要な場合は，ファイルの1行目に記載してください。

　　　列名が不要の場合は，列名の記載は必要ありません。

　　・列名の記載有無に関わらず，データの読み取り開始行は2行目からとなります。

　・Excelファイルの場合

　　・列名は必ず記載してください。1行目以降で最初に記述がある行が列名となります。

　　・データの読み取り開始行は列名が記載されている行の次の行からとなります。

　列名の指定の際は(8)を参照してください。

・キー情報

　ルートジョブネット定義ファイルの各行でユニークなキーとなる値を格納した列です。キー情報の内容は任意ですが，1から始まる整数値など，短い値を指定することを推奨します。また，キー情報には「"」および「'」以外の文字を使用してください。(すべてのキー情報の合計バイト数＋データの行数)が1017バイト以下になるようにしてください。各行への値の指定は任意です。省略した場合，該当する行の処理は行なわれません。

・上位ユニット名

　ルートジョブネットの上位ユニット名を指定します。開発サーバと業務サーバで同じ名称を使用します。ルートジョブグループを指定する場合は空文字を指定してください。

・ルートジョブネット名

　ルートジョブネット名を指定します。ジョブ名やジョブグループ名，ルートジョブネットを除くジョブネット名は指定できません。開発サーバと業務サーバで同じ名称を使用します。各行への値の指定は必須です。

・ジョブ実行エージェントホスト名

　業務サーバに登録したルートジョブネットで使用するジョブ実行エージェントホスト名を指定します。ルートジョブネット配下のジョブすべてを変更します。値を指定しない場合，開発サーバ上のジョブネットで定義された実行ホストが業務サーバへ引き継がれます。ジョブ実行エージェントホスト名を開発サーバの定義より変更する場合は値を指定してください。各行への値の指定は任意です。

・実行ユーザー名

　業務サーバに登録したルートジョブネットで使用する実行ユーザー名を指定します。ルートジョブネット配下のジョブすべてを変更します。値を指定しない場合，開発サーバ上のジョブネットで定義された実行ユーザー名が業務サーバへ引き継がれます。実行ユーザー名を開発サーバの定義より変更する場合は値を指定してください。各行への値の指定は任意です。

(例)

キー情報,上位ユニット名,ルートジョブネット名,実行ホスト名,実行ユーザー名

1,/parent1,jobnet1,host1,jp1user1

2,/parent2,jobnet2,host2,jp1user2

3,/parent3,jobnet3,,jp1user3

4,/parent4,jobnet4,host4,

5,/parent5,jobnet5,,

(7) このサービスを実行する場合，エージェントレス接続先としてJP1/AOサーバ("localhost"で解決されるループバックアドレス)，開発サーバ，および業務サーバを設定すること。

(8) ルートジョブネット定義ファイルの列名には次に示す内容を指定すること。

・必ず文字列で指定すること。数値データは指定しないこと。

・次の文字は列名に使用できない。

　・キー情報の列名の先頭には次の文字を使用できない。

　「!」「"」「#」「$」「%」「&」「'」「(」「)」「-」「=」「^」「~」「¥」「|」「`」「;」「+」「*」「[」「]」「{」「}」「,」「.」「<」「>」「?」「_」「/」「0」「1」「2」「3」「4」「5」「6」「7」「8」「9」「０」「１」「２」「３」「４」「５」「６」「７」「８」「９」

　・キー情報の列名の2文字目以降には次の文字を使用できない。

　「"」「#」「%」「&」「'」「(」「)」「-」「=」「^」「~」「¥」「|」「@」「;」「:」「+」「*」「[」「]」「{」「}」「,」「.」「<」「>」「?」「/」

　・キー情報以外の列名には次の文字を使用できない。

　「!」「[」「]」「`」「,」「.」

・文字数は半角全角混合で64文字まで指定できる。

(9) ルートジョブネット定義ファイルから読み込んだフィールドには次のチェックを行います。どれかの条件に当てはまると，タスクは異常終了します。

　・フィールドに次の特殊記号を含む

　「,」(JP1/AOサーバがWindows環境の場合)，「<」，「>」，「|」，「;」，「&」，両端以外の「"」および末尾の「¥」

　なおフィールドのデータが空の場合，無視して次の行を読み取ります。

　・フィールドに制御文字(0x00〜0x1f)を含む

注意事項

【ルートジョブネット定義ファイルに関する注意事項】

・JP1/AOサーバがWindows環境の場合

(1) Excelファイルのセルが結合されている場合，数式がエラーとなっている場合は取得される値が空になります。また，書き込みパスワードが設定されている場合はタスクが異常終了します。ルートジョブネット定義ファイルからはこれらの状態を取り除いてください。

(2) 読み取る列は，文字列型データと数値型データを混在させないでください。混在していると，ODBCドライバの仕様によって，正常に値を取得できない場合があります。

　(a) 数値型データとは次の形式の文字列のことです。

　　符号付き整数値(10 進数) 例：-12345

　　固定小数点数(10 進数) 　例：3.1415

　　浮動小数点数(10 進数) 　例：6.543E+10

　(b) 文字列型データとは上の数値型以外の形式の文字列のことです。

(3) 異なるデータ型が混在する列を取得する場合は，次の対処が必要です。

　・Excel ファイルの場合は数値型データの先頭に「'」を付けてください。

　・CSV ファイルの場合は数値型データを「"」で囲んでください。

(4) データの途中に空白行がある場合，空白行も行数としてカウントされます。データが記述された行が99行以内であっても，途中の空白行を含めた行数が100以上となる場合，タスクが異常終了するのでご注意ください。

・JP1/AOサーバがUNIX環境の場合

(1) データの途中に空白行がある場合，空白行も行数としてカウントされます。データが記述された行が99行以内であっても，途中の空白行を含めた行数が100以上となる場合，タスクが異常終了するのでご注意ください。

(2) データには「,」は使用できません。使用した場合，列を正しく区切ることができないため，データを取得できません。

(3) ルートジョブネット定義ファイルの行の先頭または末尾に存在する半角スペースおよびタブ記号は，その個数に関係なく，存在しないものとみなします。

【ルートジョブネット定義ファイル以外の注意事項】

(1) 次のプロパティ，および，ジョブネット定義ファイルに指定する文字列長は，記載の長さ以下で指定してください。

　・jp1ajs.logicalHostNameRemoteプロパティ：64文字

　・jp1ajs.logicalHostNameDevelopプロパティ：64文字

　・jp1ajs.workDirectoryRemoteプロパティ：128文字

　・jp1ajs.workDirectoryDevelopプロパティ：128文字

　・ジョブネット定義ファイルの上位ユニット名：512文字

　・ジョブネット定義ファイルの実行ホスト名：64文字

　これらの文字列長を超えると，タスクで実行するコマンドラインの最大長を超過し，長さが切りつめられた不当な形式でコマンドが実行される場合があります。最大長を超過した場合はタスクログにKNAE08015-Wメッセージが出力されます。

(2) 開発サーバと業務サーバのOS種別がWindowsのときは，次の値に「%」を指定する場合，「%」でエスケープした文字「%%」を指定してください。

　・jp1ajs.jp1UserNameプロパティ

　・jp1ajs.serviceNameRemoteプロパティ

　・jp1ajs.serviceNameDevelopプロパティ

　・ルートジョブネット定義ファイル内の値。ただし，ルートジョブネット名には「%」を指定できません。

(3) 開発サーバと業務サーバのOS種別がWindowsのときは，次の値に「"」を指定できません。

　・jp1ajs.serviceNameRemoteプロパティ

　・jp1ajs.serviceNameDevelopプロパティ

(4) 開発サーバと業務サーバのOS種別がUNIXのときは，次の値に「'」を指定できません。

　・jp1ajs.jp1UserNameプロパティ

　・jp1ajs.serviceNameRemoteプロパティ

　・jp1ajs.serviceNameDevelopプロパティ

　・jp1ajs.workDirectoryRemoteプロパティ

　・jp1ajs.workDirectoryDevelopプロパティ

　・ルートジョブネット定義ファイル内の値

(5) 上記以外の注意事項は，JP1/AJSのマニュアル「コマンドリファレンス1」のajsprintコマンド，ajschangeコマンド，ajsdefineコマンドの注意事項を参照してください。

実行権限

ビルトイン Administrator

また，jp1ajs.jp1UserNameで指定されるユーザーであり，JP1/AJS3共通情報の環境設定パラメーター"ADMACLIMIT"に"yes"が設定されている場合，次の権限が必要です。

[Windows，UNIX共通]

・開発サーバに対する権限

JP1_AJS_Guest権限，JP1_AJS_Operator権限，JP1_AJS_Editor権限，JP1_AJS_Manager権限，JP1_AJS_Admin権限のどれかの権限

・業務サーバに対する権限

JP1_AJS_Editor権限，JP1_AJS_Manager権限，JP1_AJS_Admin権限のどれかの権限

バージョン

03.01.02

タグ

Configure JP1,AJS

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

ルートジョブネット情報

ルートジョブネットの情報です。

表示されます。

業務サーバ/開発サーバ情報

業務サーバ/開発サーバの情報です。

表示されます。

JP1/AOサーバ情報

JP1/AOサーバの情報です。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1ajs.hostNameRemote

ホスト名(業務サーバ)

業務サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

業務サーバ/開発サーバ情報

jp1ajs.hostNameDevelop

ホスト名(開発サーバ)

開発サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

業務サーバ/開発サーバ情報

jp1ajs.logicalHostNameRemote

論理ホスト名(業務サーバ)

業務サーバのJP1/AJSがクラスタ構成の場合，JP1/AJSの論理ホスト名を指定します。

入力

無効

△　

業務サーバ/開発サーバ情報

jp1ajs.logicalHostNameDevelop

論理ホスト名(開発サーバ)

開発サーバのJP1/AJSがクラスタ構成の場合，JP1/AJSの論理ホスト名を指定します。

入力

無効

△　

業務サーバ/開発サーバ情報

OS.osKind

OSの種類

OSの種類(Windows/UNIX)を指定します。

入力

無効

○　

業務サーバ/開発サーバ情報

OS.fileOpenRetryCount

ファイル読み込み時のリトライ回数:Windows固有

ルートジョブネット定義ファイルファイルの読み込みに失敗した場合のリトライ回数を指定します(Windowsの場合だけ)。ファイル読み込み時のリトライ間隔と組み合わせて最大待ち時間となります。"0"を指定した場合はリトライしません。

入力

無効

○　

ルートジョブネット情報

OS.fileOpenRetryInterval

ファイル読み込み時のリトライ間隔:Windows固有

ルートジョブネット定義ファイルの読み込みに失敗した場合のリトライ間隔を秒単位で指定します(Windowsの場合だけ)。

入力

無効

○　

ルートジョブネット情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1ajs.jobnetListFilePath

ルートジョブネット定義ファイルのパス

JP1/AOサーバ上に格納した，ルートジョブネット定義ファイルのパスをフルパスで指定します。ファイルの拡張子はcsv，xls，xlsx，xlsmのどれかである必要があります。

入力

無効

○　

ルートジョブネット情報

jp1ajs.jobnetInfoSheetName

ルートジョブネット定義ファイルのシート名

ルートジョブネットの情報が記載されたシート名を指定します。ルートジョブネット定義ファイルがExcelファイルの場合には必ず指定してください。CSVファイルの場合，指定しても無視されます。

入力

無効

○　

ルートジョブネット情報

jp1ajs.serviceNameRemote

JP1/AJSのスケジューラーサービス名(業務サーバ)

業務サーバのスケジューラーサービス名を指定します。

入力

無効

○　

業務サーバ/開発サーバ情報

jp1ajs.serviceNameDevelop

JP1/AJSのスケジューラーサービス名(開発サーバ)

開発サーバのスケジューラーサービス名を指定します。

入力

無効

○　

業務サーバ/開発サーバ情報

jp1ajs.workDirectoryLocal

作業フォルダ(ローカル)

JP1/AOサーバの作業フォルダのパスをフルパスで指定します。

入力

無効

○　

JP1/AOサーバ情報

jp1ajs.workDirectoryRemote

作業フォルダ(業務サーバ)

業務サーバの作業フォルダのパスをフルパスで指定します。UNIX環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

入力

無効

○　

業務サーバ/開発サーバ情報

jp1ajs.workDirectoryDevelop

作業フォルダ(開発サーバ)

開発サーバの作業フォルダのパスをフルパスで指定します。UNIX環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

入力

無効

○　

業務サーバ/開発サーバ情報

jp1ajs.jp1UserName

JP1ユーザー名

JP1/AJSコマンドを実行するJP1ユーザー名を指定します。サーバに接続する際のOSユーザー名と同一名称のJP1ユーザーで実行する場合，指定する必要はありません。

入力

無効

△　

業務サーバ/開発サーバ情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1ajs.hostNameRemote

255文字以内の半角英数字および「.」，「-」。

jp1ajs.hostNameDevelop

255文字以内の半角英数字および「.」，「-」。

jp1ajs.logicalHostNameRemote

255文字以内の半角英数字および「.」，「-」。

jp1ajs.logicalHostNameDevelop

255文字以内の半角英数字および「.」，「-」。

OS.osKind

次の値のどれかを選択する。

Windows,UNIX

OS.fileOpenRetryCount

0〜32767の整数値。

OS.fileOpenRetryInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1ajs.jobnetListFilePath

8文字以上255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「[」，「]」，「!」および末尾の「¥」，「/」を除く。

jp1ajs.jobnetInfoSheetName

1文字以上31文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「:」，「&」，「*」，「?」，「"」，「%」，「/」，「¥」，「!」，「`」，「{」，「[」，「]」および全角記号「：」，「￥」，「？」，「［」，「］」，「／」，「＊」を除く。

jp1ajs.serviceNameRemote

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。

jp1ajs.serviceNameDevelop

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。

jp1ajs.workDirectoryLocal

200文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」，「/」を除く。

jp1ajs.workDirectoryRemote

200文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」，「/」を除く。

jp1ajs.workDirectoryDevelop

200文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」，「/」を除く。

jp1ajs.jp1UserName

31文字以内の半角英数字，および「!」，「#」，「$」，「%」，「'」，「-」，「@」，「_」，「~」。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

OS種別の出力

OS種別の出力

OS種別の出力

JP1/AOサーバのOSを出力します。

エラー原因を取り除いたあと，サービスを再実行してください。

2

ルートジョブネット情報キー値リスト取得

ルートジョブネット情報キー値リスト取得

CSV・Excelの列データ取得

ルートジョブネット定義ファイルからルートジョブネットのキー値のリストを取得します。

エラー原因を取り除いたあと，サービスを再実行してください。

3

データ分繰り返し処理

データ分繰り返し処理

繰り返し実行部品

読み出したキー情報を元に，繰り返しルートジョブネットの移行を実行します。

エラー原因を取り除いたあと，サービスを再実行してください。

2.5.5　JP1/AJSのルートジョブネット移行(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

ルートジョブネット情報読み込み

readRootJobnet

CSV・Excelの行データ取得

ルートジョブネット定義ファイルからルートジョブネットの情報を読み出します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

2

OS判定(Windows)

judgeOsWindows

値判定分岐部品

開発サーバと業務サーバのOSがWindowsか判定します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3

Windows用フロー

flowWindows

階層フロー部品

Windows用フローです。

−　

3-1

値判定分岐部品

接続しているホストが論理ホスト(開発サーバ)か判定をします。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-2

汎用コマンド実行部品

論理ホスト(開発サーバ)の場合，コマンドラインで使用する環境変数をワーク変数に代入します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-3

値判定分岐部品

接続しているホストが論理ホスト(業務サーバ)か判定をします。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-4

汎用コマンド実行部品

論理ホスト(業務サーバ)の場合，コマンドラインで使用する環境変数をワーク変数に代入します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-5

汎用コマンド実行部品

開発サーバのルートジョブネットの定義情報(これ以後，ルートジョブネット定義情報)を出力します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-6

値判定分岐部品

JP1/AOサーバのOSがWindowsか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-7

ファイル転送部品

開発サーバからJP1/AOサーバへルートジョブネット定義情報を転送します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-8

値判定分岐部品

JP1/AOサーバのOSがUNIXか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-9

ファイル転送部品

開発サーバからJP1/AOサーバへルートジョブネット定義情報を転送します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-10

ファイル削除

開発サーバのルートジョブネット定義情報を削除します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-11

値判定分岐部品

JP1/AOサーバのOSがWindowsか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-12

ファイル転送部品

JP1/AOサーバから業務サーバへルートジョブネット定義情報を転送します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-13

値判定分岐部品

JP1/AOサーバのOSがUNIXか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-14

ファイル転送部品

JP1/AOサーバから業務サーバへルートジョブネット定義情報を転送します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-15

汎用コマンド実行部品

業務サーバに転送されたルートジョブネット定義情報を用いて，業務サーバへルートジョブネットの登録を行います。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-16

ファイル削除

業務サーバのルートジョブネット定義情報を削除します。

エラー原因を取り除き，エラーとなったルートジョブネットを業務サーバのJP1/AJSのジョブネット定義より削除してください。そのあと，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除き，サービスを再実行してください。

3-17

値判定分岐部品

ルートジョブネット定義ファイルに実行ユーザーが指定されていることを確認します。

エラー原因を取り除き，エラーとなったルートジョブネットを業務サーバのJP1/AJSのジョブネット定義より削除してください。そのあと，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除き，サービスを再実行してください。

3-18

汎用コマンド実行部品

業務サーバの実行ユーザー名を変更します。

エラー原因を取り除き，エラーとなったルートジョブネットを業務サーバのJP1/AJSのジョブネット定義より削除してください。そのあと，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除き，サービスを再実行してください。

3-19

値判定分岐部品

ルートジョブネット定義ファイルにジョブ実行エージェントホスト名が指定されていることを確認します。

エラー原因を取り除き，エラーとなったルートジョブネットを業務サーバのJP1/AJSのジョブネット定義より削除してください。そのあと，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除き，サービスを再実行してください。

3-20

汎用コマンド実行部品

業務サーバのジョブ実行エージェントホスト名を変更します。

エラー原因を取り除き，エラーとなったルートジョブネットを業務サーバのJP1/AJSのジョブネット定義より削除してください。そのあと，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除き，サービスを再実行してください。

4

OS判定(UNIX)

judgeOsUNIX

値判定分岐部品

開発サーバと業務サーバのOSがUNIXか判定します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5

UNIX用フロー

flowUNIX

階層フロー部品

UNIX用フローです。

−　

5-1

値判定分岐部品

接続しているホストが論理ホスト(開発サーバ)か判定をします。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-2

汎用コマンド実行部品

論理ホスト(開発サーバ)の場合，コマンドラインで使用する環境変数をワーク変数に代入します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-3

値判定分岐部品

接続しているホストが論理ホスト(業務サーバ)か判定をします。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-4

汎用コマンド実行部品

論理ホスト(業務サーバ)の場合，コマンドラインで使用する環境変数をワーク変数に代入します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-5

汎用コマンド実行部品

開発サーバのルートジョブネットの定義情報(これ以後，ルートジョブネット定義情報)を出力します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-6

値判定分岐部品

JP1/AOサーバのOSがWindowsか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

5-7

ファイル転送部品

開発サーバからJP1/AOサーバへルートジョブネット定義情報を転送します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-8

値判定分岐部品

JP1/AOサーバのOSがUNIXか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

5-9

ファイル転送部品

開発サーバからJP1/AOサーバへルートジョブネット定義情報を転送します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-10

ファイル削除

開発サーバのルートジョブネット定義情報を削除します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-11

値判定分岐部品

JP1/AOサーバのOSがWindowsか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

5-12

ファイル転送部品

JP1/AOサーバから業務サーバへルートジョブネット定義情報を転送します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-13

値判定分岐部品

JP1/AOサーバのOSがUNIXか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

5-14

ファイル転送部品

JP1/AOサーバから業務サーバへルートジョブネット定義情報を転送します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-15

汎用コマンド実行部品

業務サーバに転送されたルートジョブネット定義情報を用いて，業務サーバへルートジョブネットの登録を行います。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-16

ファイル削除

業務サーバのルートジョブネット定義情報を削除します。

エラー原因を取り除き，エラーとなったルートジョブネットを業務サーバのJP1/AJSのジョブネット定義より削除してください。そのあと，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除き，サービスを再実行してください。

5-17

値判定分岐部品

ルートジョブネット定義ファイルに実行ユーザーが指定されていることを確認します。

エラー原因を取り除き，エラーとなったルートジョブネットを業務サーバのJP1/AJSのジョブネット定義より削除してください。そのあと，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除き，サービスを再実行してください。

5-18

汎用コマンド実行部品

業務サーバの実行ユーザー名を変更します。

エラー原因を取り除き，エラーとなったルートジョブネットを業務サーバのJP1/AJSのジョブネット定義より削除してください。そのあと，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除き，サービスを再実行してください。

5-19

値判定分岐部品

ルートジョブネット定義ファイルにジョブ実行エージェントホスト名が指定されていることを確認します。

エラー原因を取り除き，エラーとなったルートジョブネットを業務サーバのJP1/AJSのジョブネット定義より削除してください。そのあと，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除き，サービスを再実行してください。

5-20

汎用コマンド実行部品

業務サーバのジョブ実行エージェントホスト名を変更します。

エラー原因を取り除き，エラーとなったルートジョブネットを業務サーバのJP1/AJSのジョブネット定義より削除してください。そのあと，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除き，サービスを再実行してください。

6

OS判定(Windows)_2

judgeOsWindows_2

値判定分岐部品

JP1/AOサーバのOSがWindowsか判定します。

jp1ajs.workDirectoryLocalプロパティで指定したJP1/AOサーバの作業フォルダに作成されたファイルを削除してください。

7

ファイル削除処理

delRootJobnetDefFileLocal

ファイル削除

ルートジョブネット定義情報(ローカル)を削除します。

jp1ajs.workDirectoryLocalプロパティで指定したJP1/AOサーバの作業フォルダに作成されたファイルを削除してください。

8

OS判定(UNIX)_2

judgeOsUNIX_2

値判定分岐部品

JP1/AOサーバのOSがUNIXか判定します。

jp1ajs.workDirectoryLocalプロパティで指定したJP1/AOサーバの作業フォルダに作成されたファイルを削除してください。

9

ファイル削除処理_2

delRootJobnetDefFileLocal_2

ファイル削除

ルートジョブネット定義情報(ローカル)を削除します。

jp1ajs.workDirectoryLocalプロパティで指定したJP1/AOサーバの作業フォルダに作成されたファイルを削除してください。

2.5.6　JP1/AJSのルートジョブネット移行(SYSTEM)

機能

このサービステンプレートは，CSV(Comma Separated Values)ファイルまたはMicrosoft Excelによって作成されたルートジョブネットの一覧情報(これ以降，ルートジョブネット定義ファイルと呼びます)を使用して，JP1/AJS3 - Manager (以降JP1/AJSと呼びます)のルートジョブネットを開発サーバから一括して取得し，業務サーバへ移行します。

JP1/AOサーバがWindows環境の場合はCSVファイルまたはExcelファイル，UNIX環境の場合はCSVファイルを使用します。

このサービステンプレートが前提とするサーバを次に示します。

・開発サーバ

　JP1/AJSが動作するサーバです。取得対象のルートジョブネットが登録されている必要があります。

・業務サーバ

　JP1/AJSが動作するサーバです。取得したルートジョブネットを登録します。

jp1ajs.jobnetListFilePathプロパティで指定するルートジョブネット定義ファイルからキー値を記載した列を取り出し，すべてのキー値に対して次の処理を実行します。

(1) キー値に合致する行の，ルートジョブネット名，ジョブ実行エージェントホスト名，実行ユーザー名を読み取ります。

(2) 処理(1)で読み取った情報を使用して，開発サーバでajsprintコマンドを実行し，ルートジョブネットの情報をユニット定義ファイルとして出力します。

(3) JP1/AOサーバをいったん経由して(2)で出力されたユニット定義ファイルを業務サーバへ転送します。

(4) 業務サーバでajsdefineコマンドを実行し，ルートジョブネットを登録します。

(5) ジョブ実行エージェントホスト名が指定されている場合，業務サーバでajschangeコマンドを実行し，ルートジョブネット配下すべてのジョブのジョブ実行エージェントホスト名を変更します。

(6) 実行ユーザー名が指定されている場合，業務サーバでajschangeコマンドを実行し，ルートジョブネット配下すべてのジョブの実行ユーザー名を変更します。

ルートジョブネット定義ファイルには，ルートジョブネット情報を99件(99行)まで記載できます。

各変更処理は，繰り返し部品で逐次的に実行します。繰り返しの中で処理が失敗した場合は，処理が失敗した時点でタスクが異常終了します。

ルートジョブネット定義ファイル読み込みに失敗した場合は，OS.fileOpenRetryIntervalプロパティに指定した秒数待ってファイル読み込みをリトライする処理を，OS.fileOpenRetryCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)JP1/AOサーバがWindows環境の場合，次に示すMicrosoft社のプログラムがJP1/AOサーバにインストールされていること。

　2007 Office system ドライバ，または

　Microsoft Access データベース エンジン 2010（32bit版），または

　Microsoft Access Database Engine 2016（32bit版）

(2)開発サーバ，および業務サーバに次の製品が稼働していること。

　JP1/Automatic Job Management System 3 - Manager 09-00以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【サービステンプレート実行システム内前提製品の使用条件】

(1)JP1/AJSのスケジューラーサービスが起動されていること。

(2)jp1ajs.jp1UserNameプロパティに指定したJP1ユーザーが，開発サーバと業務サーバに登録されていること。

(3)移行対象となっているルートジョブネットが，業務サーバに登録されていないこと。

　ルートジョブネットが既に登録されている場合，「JP1/AJSのルートジョブネット削除」サービスを使用することで一括して削除できます。

(4)このサービステンプレートはルートジョブネットの移行だけサポートします。ジョブグループの一括移行はサポートしません。

(5)開発サーバと業務サーバのOS種別(Windows/UNIX)が同一であること。

(6)JP1/AOサーバ上に，次に示す内容を記載したルートジョブネット定義ファイルを格納していること。

・列数

　データの読み取り開始列から数えた列数が255列以内となるようにしてください。

・列名

　・CSVファイルの場合

　　・列名が必要な場合は，ファイルの1行目に記載してください。

　　　列名が不要の場合は，列名の記載は必要ありません。

　　・列名の記載有無に関わらず，データの読み取り開始行は2行目からとなります。

　・Excelファイルの場合

　　・列名は必ず記載してください。1行目以降で最初に記述がある行が列名となります。

　　・データの読み取り開始行は列名が記載されている行の次の行からとなります。

　列名の指定の際は(8)を参照してください。

・キー情報

　ルートジョブネット定義ファイルの各行でユニークなキーとなる値を格納した列です。キー情報の内容は任意ですが，1から始まる整数値など，短い値を指定することを推奨します。また，キー情報には「"」および「'」以外の文字を使用してください。(すべてのキー情報の合計バイト数＋データの行数)が1017バイト以下になるようにしてください。各行への値の指定は任意です。省略した場合，該当する行の処理は行なわれません。

・上位ユニット名

　ルートジョブネットの上位ユニット名を指定します。開発サーバと業務サーバで同じ名称を使用します。ルートジョブグループを指定する場合は空文字を指定してください。

・ルートジョブネット名

　ルートジョブネット名を指定します。ジョブ名やジョブグループ名，ルートジョブネットを除くジョブネット名は指定できません。開発サーバと業務サーバで同じ名称を使用します。各行への値の指定は必須です。

・ジョブ実行エージェントホスト名

　業務サーバに登録したルートジョブネットで使用するジョブ実行エージェントホスト名を指定します。ルートジョブネット配下のジョブすべてを変更します。値を指定しない場合，開発サーバ上のジョブネットで定義された実行ホストが業務サーバへ引き継がれます。ジョブ実行エージェントホスト名を開発サーバの定義より変更する場合は値を指定してください。各行への値の指定は任意です。

・実行ユーザー名

　業務サーバに登録したルートジョブネットで使用する実行ユーザー名を指定します。ルートジョブネット配下のジョブすべてを変更します。値を指定しない場合，開発サーバ上のジョブネットで定義された実行ユーザー名が業務サーバへ引き継がれます。実行ユーザー名を開発サーバの定義より変更する場合は値を指定してください。各行への値の指定は任意です。

(例)

キー情報,上位ユニット名,ルートジョブネット名,実行ホスト名,実行ユーザー名

1,/parent1,jobnet1,host1,jp1user1

2,/parent2,jobnet2,host2,jp1user2

3,/parent3,jobnet3,,jp1user3

4,/parent4,jobnet4,host4,

5,/parent5,jobnet5,,

(7)このサービスを実行する場合，エージェントレス接続先としてJP1/AOサーバ("localhost"で解決されるループバックアドレス)，開発サーバ，および業務サーバを設定すること。

(8)ルートジョブネット定義ファイルの列名には次に示す内容を指定すること。

・必ず文字列で指定すること。数値データは指定しないこと。

・次の文字は列名に使用できない。

　・キー情報の列名の先頭には次の文字を使用できない。

　「!」「"」「#」「$」「%」「&」「'」「(」「)」「-」「=」「^」「~」「¥」「|」「`」「;」「+」「*」「[」「]」「{」「}」「,」「.」「<」「>」「?」「_」「/」「0」「1」「2」「3」「4」「5」「6」「7」「8」「9」「０」「１」「２」「３」「４」「５」「６」「７」「８」「９」

　・キー情報の列名の2文字目以降には次の文字を使用できない。

　「"」「#」「%」「&」「'」「(」「)」「-」「=」「^」「~」「¥」「|」「@」「;」「:」「+」「*」「[」「]」「{」「}」「,」「.」「<」「>」「?」「/」

　・キー情報以外の列名には次の文字を使用できない。

　「!」「[」「]」「`」「,」「.」

・文字数は半角全角混合で64文字まで指定できる。

(9)ルートジョブネット定義ファイルから読み込んだフィールドには次のチェックを行います。どれかの条件に当てはまると，タスクは異常終了します。

　・フィールドに次の特殊記号を含む

　「,」(JP1/AOサーバがWindows環境の場合)，「<」，「>」，「|」，「;」，「&」，両端以外の「"」および末尾の「¥」

　なおフィールドのデータが空の場合，無視して次の行を読み取ります。

　・フィールドに制御文字(0x00〜0x1f)を含む

注意事項

【ルートジョブネット定義ファイルに関する注意事項】

・JP1/AOサーバがWindows環境の場合

(1) Excelファイルのセルが結合されている場合，数式がエラーとなっている場合は取得される値が空になります。また，書き込みパスワードが設定されている場合はタスクが異常終了します。ルートジョブネット定義ファイルからはこれらの状態を取り除いてください。

(2) 読み取る列は，文字列型データと数値型データを混在させないでください。混在していると，ODBCドライバの仕様によって，正常に値を取得できない場合があります。

　(a) 数値型データとは次の形式の文字列のことです。

　　符号付き整数値(10 進数) 例：-12345

　　固定小数点数(10 進数) 　例：3.1415

　　浮動小数点数(10 進数) 　例：6.543E+10

　(b) 文字列型データとは上の数値型以外の形式の文字列のことです。

(3) 異なるデータ型が混在する列を取得する場合は，次の対処が必要です。

　・Excel ファイルの場合は数値型データの先頭に「'」を付けてください。

　・CSV ファイルの場合は数値型データを「"」で囲んでください。

(4) データの途中に空白行がある場合，空白行も行数としてカウントされます。データが記述された行が99行以内であっても，途中の空白行を含めた行数が100以上となる場合，タスクが異常終了するのでご注意ください。

・JP1/AOサーバがUNIX環境の場合

(1) データの途中に空白行がある場合，空白行も行数としてカウントされます。データが記述された行が99行以内であっても，途中の空白行を含めた行数が100以上となる場合，タスクが異常終了するのでご注意ください。

(2) データには「,」は使用できません。使用した場合，列を正しく区切ることができないため，データを取得できません。

(3) ルートジョブネット定義ファイルの行の先頭または末尾に存在する半角スペースおよびタブ記号は，その個数に関係なく，存在しないものとみなします。

【ルートジョブネット定義ファイル以外の注意事項】

(1) 次のプロパティ，および，ジョブネット定義ファイルに指定する文字列長は，記載の長さ以下で指定してください。

　・jp1ajs.logicalHostNameRemoteプロパティ：64文字

　・jp1ajs.logicalHostNameDevelopプロパティ：64文字

　・jp1ajs.workDirectoryRemoteプロパティ：128文字

　・jp1ajs.workDirectoryDevelopプロパティ：128文字

　・ジョブネット定義ファイルの上位ユニット名：512文字

　・ジョブネット定義ファイルの実行ホスト名：64文字

　これらの文字列長を超えると，タスクで実行するコマンドラインの最大長を超過し，長さが切りつめられた不当な形式でコマンドが実行される場合があります。最大長を超過した場合はタスクログにKNAE08015-Wメッセージが出力されます。

(2) 開発サーバと業務サーバのOS種別がWindowsのときは，次の値に「%」を指定する場合，「%」でエスケープした文字「%%」を指定してください。

　・jp1ajs.jp1UserNameプロパティ

　・jp1ajs.serviceNameRemoteプロパティ

　・jp1ajs.serviceNameDevelopプロパティ

　・ルートジョブネット定義ファイル内の値。ただし，ルートジョブネット名には「%」を指定できません。

(3) 開発サーバと業務サーバのOS種別がWindowsのときは，次の値に「"」を指定できません。

　・jp1ajs.serviceNameRemoteプロパティ

　・jp1ajs.serviceNameDevelopプロパティ

(4) 開発サーバと業務サーバのOS種別がUNIXのときは，次の値に「'」を指定できません。

　・jp1ajs.jp1UserNameプロパティ

　・jp1ajs.serviceNameRemoteプロパティ

　・jp1ajs.serviceNameDevelopプロパティ

　・jp1ajs.workDirectoryRemoteプロパティ

　・jp1ajs.workDirectoryDevelopプロパティ

　・ルートジョブネット定義ファイル内の値

(5) 上記以外の注意事項は，JP1/AJSのマニュアル「コマンドリファレンス1」のajsprintコマンド，ajschangeコマンド，ajsdefineコマンドの注意事項を参照してください。

実行権限

Administratorsグループに所属するユーザー

また，jp1ajs.jp1UserNameで指定されるユーザーであり，JP1/AJS3共通情報の環境設定パラメーター"ADMACLIMIT"に"yes"が設定されている場合，次の権限が必要です。

[Windows，UNIX共通]

・開発サーバに対する権限

JP1_AJS_Guest権限，JP1_AJS_Operator権限，JP1_AJS_Editor権限，JP1_AJS_Manager権限，JP1_AJS_Admin権限のどれかの権限

・業務サーバに対する権限

JP1_AJS_Editor権限，JP1_AJS_Manager権限，JP1_AJS_Admin権限のどれかの権限

バージョン

03.10.02

タグ

Configure JP1,AJS

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

ルートジョブネット情報

ルートジョブネットの情報です。

表示されます。

業務サーバ/開発サーバ情報

業務サーバ/開発サーバの情報です。

表示されます。

JP1/AOサーバ情報

JP1/AOサーバの情報です。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1ajs.hostNameRemote

ホスト名(業務サーバ)

業務サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

業務サーバ/開発サーバ情報

jp1ajs.hostNameDevelop

ホスト名(開発サーバ)

開発サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

業務サーバ/開発サーバ情報

jp1ajs.logicalHostNameRemote

論理ホスト名(業務サーバ)

業務サーバのJP1/AJSがクラスタ構成の場合，JP1/AJSの論理ホスト名を指定します。

入力

無効

△　

業務サーバ/開発サーバ情報

jp1ajs.logicalHostNameDevelop

論理ホスト名(開発サーバ)

開発サーバのJP1/AJSがクラスタ構成の場合，JP1/AJSの論理ホスト名を指定します。

入力

無効

△　

業務サーバ/開発サーバ情報

OS.osKind

OSの種類

OSの種類(Windows/UNIX)を指定します。

入力

無効

○　

業務サーバ/開発サーバ情報

OS.fileOpenRetryCount

ファイル読み込み時のリトライ回数:Windows固有

ルートジョブネット定義ファイルファイルの読み込みに失敗した場合のリトライ回数を指定します(Windowsの場合だけ)。ファイル読み込み時のリトライ間隔と組み合わせて最大待ち時間となります。"0"を指定した場合はリトライしません。

入力

無効

○　

ルートジョブネット情報

OS.fileOpenRetryInterval

ファイル読み込み時のリトライ間隔:Windows固有

ルートジョブネット定義ファイルの読み込みに失敗した場合のリトライ間隔を秒単位で指定します(Windowsの場合だけ)。

入力

無効

○　

ルートジョブネット情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1ajs.jobnetListFilePath

ルートジョブネット定義ファイルのパス

JP1/AOサーバ上に格納した，ルートジョブネット定義ファイルのパスをフルパスで指定します。ファイルの拡張子はcsv，xls，xlsx，xlsmのどれかである必要があります。

入力

無効

○　

ルートジョブネット情報

jp1ajs.jobnetInfoSheetName

ルートジョブネット定義ファイルのシート名

ルートジョブネットの情報が記載されたシート名を指定します。ルートジョブネット定義ファイルがExcelファイルの場合には必ず指定してください。CSVファイルの場合，指定しても無視されます。

入力

無効

○　

ルートジョブネット情報

jp1ajs.serviceNameRemote

JP1/AJSのスケジューラーサービス名(業務サーバ)

業務サーバのスケジューラーサービス名を指定します。

入力

無効

○　

業務サーバ/開発サーバ情報

jp1ajs.serviceNameDevelop

JP1/AJSのスケジューラーサービス名(開発サーバ)

開発サーバのスケジューラーサービス名を指定します。

入力

無効

○　

業務サーバ/開発サーバ情報

jp1ajs.workDirectoryLocal

作業フォルダ(ローカル)

JP1/AOサーバの作業フォルダのパスをフルパスで指定します。

入力

無効

○　

JP1/AOサーバ情報

jp1ajs.workDirectoryRemote

作業フォルダ(業務サーバ)

業務サーバの作業フォルダのパスをフルパスで指定します。UNIX環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

入力

無効

○　

業務サーバ/開発サーバ情報

jp1ajs.workDirectoryDevelop

作業フォルダ(開発サーバ)

開発サーバの作業フォルダのパスをフルパスで指定します。UNIX環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

入力

無効

○　

業務サーバ/開発サーバ情報

jp1ajs.jp1UserName

JP1ユーザー名

JP1/AJSコマンドを実行するJP1ユーザー名を指定します。サーバに接続する際のOSユーザー名と同一名称のJP1ユーザーで実行する場合，指定する必要はありません。

入力

無効

△　

業務サーバ/開発サーバ情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1ajs.hostNameRemote

255文字以内の半角英数字および「.」，「-」。

jp1ajs.hostNameDevelop

255文字以内の半角英数字および「.」，「-」。

jp1ajs.logicalHostNameRemote

255文字以内の半角英数字および「.」，「-」。

jp1ajs.logicalHostNameDevelop

255文字以内の半角英数字および「.」，「-」。

OS.osKind

次の値のどれかを選択する。

Windows,UNIX

OS.fileOpenRetryCount

0〜32767の整数値。

OS.fileOpenRetryInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1ajs.jobnetListFilePath

8文字以上255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「[」，「]」，「!」および末尾の「¥」，「/」を除く。

jp1ajs.jobnetInfoSheetName

1文字以上31文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「:」，「&」，「*」，「?」，「"」，「%」，「/」，「¥」，「!」，「`」，「{」，「[」，「]」および全角記号「：」，「￥」，「？」，「［」，「］」，「／」，「＊」を除く。

jp1ajs.serviceNameRemote

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。

jp1ajs.serviceNameDevelop

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。

jp1ajs.workDirectoryLocal

200文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」，「/」を除く。

jp1ajs.workDirectoryRemote

200文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」，「/」を除く。

jp1ajs.workDirectoryDevelop

200文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」，「/」を除く。

jp1ajs.jp1UserName

31文字以内の半角英数字，および「!」，「#」，「$」，「%」，「'」，「-」，「@」，「_」，「~」。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

OS種別の出力

OS種別の出力

OS種別の出力

JP1/AOサーバのOSを出力します。

エラー原因を取り除いたあと，サービスを再実行してください。

2

ルートジョブネット情報キー値リスト取得(SYSTEM)

ルートジョブネット情報キー値リスト取得(SYSTEM)

CSV・Excelの列データ取得(SYSTEM)

ルートジョブネット定義ファイルからルートジョブネットのキー値のリストを取得します。

エラー原因を取り除いたあと，サービスを再実行してください。

3

データ分繰り返し処理

データ分繰り返し処理

繰り返し実行部品

読み出したキー情報を元に，繰り返しルートジョブネットの移行を実行します。

エラー原因を取り除いたあと，サービスを再実行してください。

2.5.7　JP1/AJSのルートジョブネット移行(SYSTEM)(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

ルートジョブネット情報読み込み(SYSTEM)

readRootJobnet_System

CSV・Excelの行データ取得(SYSTEM)

ルートジョブネット定義ファイルからルートジョブネットの情報を読み出します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

2

OS判定(Windows)

judgeOsWindows

値判定分岐部品

開発サーバと業務サーバのOSがWindowsか判定します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3

Windows用フロー

flowWindows

階層フロー部品

Windows用フローです。

−　

3-1

値判定分岐部品

接続しているホストが論理ホスト(開発サーバ)か判定をします。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-2

汎用コマンド実行部品

論理ホスト(開発サーバ)の場合，コマンドラインで使用する環境変数をワーク変数に代入します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-3

値判定分岐部品

接続しているホストが論理ホスト(業務サーバ)か判定をします。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-4

汎用コマンド実行部品

論理ホスト(業務サーバ)の場合，コマンドラインで使用する環境変数をワーク変数に代入します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-5

汎用コマンド実行部品

開発サーバのルートジョブネットの定義情報(これ以後，ルートジョブネット定義情報)を出力します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-6

値判定分岐部品

JP1/AOサーバのOSがWindowsか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-7

ファイル転送部品

開発サーバからJP1/AOサーバへルートジョブネット定義情報を転送します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-8

値判定分岐部品

JP1/AOサーバのOSがUNIXか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-9

ファイル転送部品

開発サーバからJP1/AOサーバへルートジョブネット定義情報を転送します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-10

ファイル削除

開発サーバのルートジョブネット定義情報を削除します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-11

値判定分岐部品

JP1/AOサーバのOSがWindowsか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-12

ファイル転送部品

JP1/AOサーバから業務サーバへルートジョブネット定義情報を転送します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-13

値判定分岐部品

JP1/AOサーバのOSがUNIXか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-14

ファイル転送部品

JP1/AOサーバから業務サーバへルートジョブネット定義情報を転送します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-15

汎用コマンド実行部品

業務サーバに転送されたルートジョブネット定義情報を用いて，業務サーバへルートジョブネットの登録を行います。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-16

ファイル削除

業務サーバのルートジョブネット定義情報を削除します。

エラー原因を取り除き，エラーとなったルートジョブネットを業務サーバのJP1/AJSのジョブネット定義より削除してください。そのあと，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除き，サービスを再実行してください。

3-17

値判定分岐部品

ルートジョブネット定義ファイルに実行ユーザーが指定されていることを確認します。

エラー原因を取り除き，エラーとなったルートジョブネットを業務サーバのJP1/AJSのジョブネット定義より削除してください。そのあと，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除き，サービスを再実行してください。

3-18

汎用コマンド実行部品

業務サーバの実行ユーザー名を変更します。

エラー原因を取り除き，エラーとなったルートジョブネットを業務サーバのJP1/AJSのジョブネット定義より削除してください。そのあと，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除き，サービスを再実行してください。

3-19

値判定分岐部品

ルートジョブネット定義ファイルにジョブ実行エージェントホスト名が指定されていることを確認します。

エラー原因を取り除き，エラーとなったルートジョブネットを業務サーバのJP1/AJSのジョブネット定義より削除してください。そのあと，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除き，サービスを再実行してください。

3-20

汎用コマンド実行部品

業務サーバのジョブ実行エージェントホスト名を変更します。

エラー原因を取り除き，エラーとなったルートジョブネットを業務サーバのJP1/AJSのジョブネット定義より削除してください。そのあと，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除き，サービスを再実行してください。

4

OS判定(UNIX)

judgeOsUNIX

値判定分岐部品

開発サーバと業務サーバのOSがUNIXか判定します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5

UNIX用フロー

flowUNIX

階層フロー部品

UNIX用フローです。

−　

5-1

値判定分岐部品

接続しているホストが論理ホスト(開発サーバ)か判定をします。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-2

汎用コマンド実行部品

論理ホスト(開発サーバ)の場合，コマンドラインで使用する環境変数をワーク変数に代入します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-3

値判定分岐部品

接続しているホストが論理ホスト(業務サーバ)か判定をします。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-4

汎用コマンド実行部品

論理ホスト(業務サーバ)の場合，コマンドラインで使用する環境変数をワーク変数に代入します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-5

汎用コマンド実行部品

開発サーバのルートジョブネットの定義情報(これ以後，ルートジョブネット定義情報)を出力します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-6

値判定分岐部品

JP1/AOサーバのOSがWindowsか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

5-7

ファイル転送部品

開発サーバからJP1/AOサーバへルートジョブネット定義情報を転送します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-8

値判定分岐部品

JP1/AOサーバのOSがUNIXか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

5-9

ファイル転送部品

開発サーバからJP1/AOサーバへルートジョブネット定義情報を転送します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-10

ファイル削除

開発サーバのルートジョブネット定義情報を削除します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-11

値判定分岐部品

JP1/AOサーバのOSがWindowsか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

5-12

ファイル転送部品

JP1/AOサーバから業務サーバへルートジョブネット定義情報を転送します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-13

値判定分岐部品

JP1/AOサーバのOSがUNIXか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

5-14

ファイル転送部品

JP1/AOサーバから業務サーバへルートジョブネット定義情報を転送します。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-15

汎用コマンド実行部品

業務サーバに転送されたルートジョブネット定義情報を用いて，業務サーバへルートジョブネットの登録を行います。

エラー原因を取り除き，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-16

ファイル削除

業務サーバのルートジョブネット定義情報を削除します。

エラー原因を取り除き，エラーとなったルートジョブネットを業務サーバのJP1/AJSのジョブネット定義より削除してください。そのあと，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除き，サービスを再実行してください。

5-17

値判定分岐部品

ルートジョブネット定義ファイルに実行ユーザーが指定されていることを確認します。

エラー原因を取り除き，エラーとなったルートジョブネットを業務サーバのJP1/AJSのジョブネット定義より削除してください。そのあと，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除き，サービスを再実行してください。

5-18

汎用コマンド実行部品

業務サーバの実行ユーザー名を変更します。

エラー原因を取り除き，エラーとなったルートジョブネットを業務サーバのJP1/AJSのジョブネット定義より削除してください。そのあと，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除き，サービスを再実行してください。

5-19

値判定分岐部品

ルートジョブネット定義ファイルにジョブ実行エージェントホスト名が指定されていることを確認します。

エラー原因を取り除き，エラーとなったルートジョブネットを業務サーバのJP1/AJSのジョブネット定義より削除してください。そのあと，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除き，サービスを再実行してください。

5-20

汎用コマンド実行部品

業務サーバのジョブ実行エージェントホスト名を変更します。

エラー原因を取り除き，エラーとなったルートジョブネットを業務サーバのJP1/AJSのジョブネット定義より削除してください。そのあと，ルートジョブネット定義ファイルから移行に成功したルートジョブネットの記載を取り除き，サービスを再実行してください。

6

OS判定(Windows)_2

judgeOsWindows_2

値判定分岐部品

JP1/AOサーバのOSがWindowsか判定します。

jp1ajs.workDirectoryLocalプロパティで指定したJP1/AOサーバの作業フォルダに作成されたファイルを削除してください。

7

ファイル削除処理

delRootJobnetDefFileLocal

ファイル削除

ルートジョブネット定義情報(ローカル)を削除します。

jp1ajs.workDirectoryLocalプロパティで指定したJP1/AOサーバの作業フォルダに作成されたファイルを削除してください。

8

OS判定(UNIX)_2

judgeOsUNIX_2

値判定分岐部品

JP1/AOサーバのOSがUNIXか判定します。

jp1ajs.workDirectoryLocalプロパティで指定したJP1/AOサーバの作業フォルダに作成されたファイルを削除してください。

9

ファイル削除処理_2

delRootJobnetDefFileLocal_2

ファイル削除

ルートジョブネット定義情報(ローカル)を削除します。

jp1ajs.workDirectoryLocalプロパティで指定したJP1/AOサーバの作業フォルダに作成されたファイルを削除してください。

2.5.8　JP1/AJSのルートジョブネット削除

機能

このサービステンプレートは，CSV(Comma Separated Values)ファイルまたはMicrosoft Excelによって作成されたルートジョブネットの一覧情報(これ以降，ルートジョブネット定義ファイルと呼びます)を使用して，JP1/AJS3 - Manager (以降JP1/AJSと呼びます)に定義されたルートジョブネットを削除します。

JP1/AOサーバがWindows環境の場合はCSVファイルまたはExcelファイル，UNIX環境の場合はCSVファイルを使用します。

このサービステンプレートが前提とするサーバを次に示します。

・業務サーバ

　JP1/AJSが動作するサーバです。削除対象のルートジョブネットが登録されている必要があります。

jp1ajs.jobnetListFilePathプロパティで指定するルートジョブネット定義ファイルからキー値を記載した列を取り出し，すべてのキー値に対して次の処理を実行します。

(1) キー値に合致する行のルートジョブネット名を読み取ります。

(2) 処理(1)で読み取った情報を使用して，業務サーバでajsleaveコマンドを実行し，ルートジョブネットの実行登録を解除します。ルートジョブネットの実行登録の解除に失敗した場合もエラーとはしないで処理を継続します。

(3) 処理(1)で読み取った情報を使用して，業務サーバでajsdeleteコマンドを実行し，ルートジョブネット定義を削除します。削除の対象は，実行登録されていないルートジョブネットになります。ルートジョブネット定義の削除に失敗した場合，タスクが異常終了します。

ルートジョブネット定義ファイルには，ルートジョブネット情報を99件(99行)まで記載できます。

各変更処理は，繰り返し部品で逐次的に実行します。

ルートジョブネット定義ファイル読み込みに失敗した場合は，OS.fileOpenRetryIntervalプロパティに指定した秒数待ってファイル読み込みをリトライする処理を，OS.fileOpenRetryCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

JP1/AOサーバ，実行対象サーバのOSがWindowsの場合，このサービステンプレートの実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。各サーバにadministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行うサービス「JP1/AJSのルートジョブネット削除(SYSTEM)」を実行してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1) JP1/AOサーバがWindows環境の場合，次に示すMicrosoft社のプログラムがJP1/AOサーバにインストールされていること。

　2007 Office system ドライバ，または

　Microsoft Access データベース エンジン 2010（32bit版），または

　Microsoft Access Database Engine 2016（32bit版）

(2) 業務サーバに次の製品が稼働していること。

　JP1/Automatic Job Management System 3 - Manager 09-00以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【サービステンプレート実行システム内前提製品の使用条件】

(1) JP1/AJSのスケジューラーサービスが起動されていること。

(2) jp1ajs.jp1UserNameプロパティに指定したJP1ユーザーが，業務サーバに登録されていること。

(3) 業務サーバ上に削除対象のルートジョブネットが登録されていて，かつ実行中でないこと。

(4) このサービステンプレートはルートジョブネットの削除だけサポートする。ジョブグループの一括削除はサポートしない。

(5) JP1/AOサーバ上に，次に示す内容を記載したルートジョブネット定義ファイルを格納していること。

・列数

　データの読み取り開始列から数えた列数が255列以内となるようにしてください。

・列名

　・CSVファイルの場合

　　・列名が必要な場合は，ファイルの1行目に記載してください。

　　　列名が不要の場合は，列名の記載は必要ありません。

　　・列名の記載有無に関わらず，データの読み取り開始行は2行目からとなります。

　・Excelファイルの場合

　　・列名は必ず記載してください。1行目以降で最初に記述がある行が列名となります。

　　・データの読み取り開始行は列名が記載されている行の次の行からとなります。

　列名の指定の際は(6)を参照してください。

・キー情報

　ルートジョブネット定義ファイルの各行でユニークなキーとなる値を格納した列です。キー情報の内容は任意ですが，1から始まる整数値など，短い値を指定することを推奨します。また，キー情報には「"」および「'」以外の文字を使用してください。(すべてのキー情報の合計バイト数＋データの行数)が1017バイト以下になるようにしてください。各行への値の指定は任意です。省略した場合，該当する行の処理は行なわれません。

・上位ユニット名

　ルートジョブネットの上位ユニット名を指定します。ルートジョブグループを指定する場合は空文字を指定してください。

・ルートジョブネット名

　ルートジョブネット名を指定します。ジョブ名やジョブグループ名，ルートジョブネットを除くジョブネット名は指定できません。各行への値の指定は必須です。

(例)

キー情報,上位ユニット名,ルートジョブネット名

1,/parent1,jobnet1

2,/parent2,jobnet2

3,/parent3,jobnet3

(6) このサービスを実行する場合，エージェントレス接続先としてJP1/AOサーバ("localhost"で解決されるループバックアドレス)および業務サーバを設定すること。

(7) ルートジョブネット定義ファイルの列名には次に示す内容を指定すること。

・必ず文字列で指定すること。数値データは指定しないこと。

・次の文字は列名に使用できない。

　・キー情報の列名の先頭には次の文字を使用できない。

　「!」「"」「#」「$」「%」「&」「'」「(」「)」「-」「=」「^」「~」「¥」「|」「`」「;」「+」「*」「[」「]」「{」「}」「,」「.」「<」「>」「?」「_」「/」「0」「1」「2」「3」「4」「5」「6」「7」「8」「9」「０」「１」「２」「３」「４」「５」「６」「７」「８」「９」

　・キー情報の列名の2文字目以降には次の文字を使用できない。

　「"」「#」「%」「&」「'」「(」「)」「-」「=」「^」「~」「¥」「|」「@」「;」「:」「+」「*」「[」「]」「{」「}」「,」「.」「<」「>」「?」「/」

　・キー情報以外の列名には次の文字を使用できない。

　「!」「[」「]」「`」「,」「.」

・文字数は半角全角混合で64文字まで指定できる。

(8) ルートジョブネット定義ファイルから読み込んだフィールドには次のチェックを行います。どれかの条件に当てはまると，タスクは異常終了します。

　・フィールドに次の特殊記号を含む

　「,」(JP1/AOサーバがWindows環境の場合)，「<」，「>」，「|」，「;」，「&」，両端以外の「"」および末尾の「¥」

　なおフィールドのデータが空の場合，無視して次の行を読み取ります。

　・フィールドに制御文字(0x00〜0x1f)を含む

注意事項

【ルートジョブネット定義ファイルに関する注意事項】

・JP1/AOサーバがWindows環境の場合の注意事項

(1) Excelファイルのセルが結合されている場合，数式がエラーとなっている場合は取得される値が空になります。また，書き込みパスワードが設定されている場合はタスクが異常終了します。ルートジョブネット定義ファイルからはこれらの状態を取り除いてください。

(2) 読み取る列は，文字列型データと数値型データを混在させないでください。混在していると，ODBCドライバの仕様によって，正常に値を取得できない場合があります。

　(a) 数値型データとは次の形式の文字列のことです。

　　符号付き整数値(10 進数) 例：-12345

　　固定小数点数(10 進数) 　例：3.1415

　　浮動小数点数(10 進数) 　例：6.543E+10

　(b) 文字列型データとは上の数値型以外の形式の文字列のことです。

(3) 異なるデータ型が混在する列を取得する場合は，次の対処が必要です。

　・Excel ファイルの場合は数値型データの先頭に「'」を付けてください。

　・CSV ファイルの場合は数値型データを「"」で囲んでください。

(4) データの途中に空白行がある場合，空白行も行数としてカウントされます。データが記述された行が99行以内であっても，途中の空白行を含めた行数が100以上となる場合，タスクが異常終了するのでご注意ください。

・JP1/AOサーバがUNIX環境の場合の注意事項

(1) データの途中に空白行がある場合，空白行も行数としてカウントされます。データが記述された行が99行以内であっても，途中の空白行を含めた行数が100以上となる場合，タスクが異常終了するのでご注意ください。

(2) データには「,」は使用できません。使用した場合，列を正しく区切ることができないため，データを取得できません。

(3) ルートジョブネット定義ファイルの行の先頭または末尾に存在する半角スペースおよびタブ記号は，その個数に関係なく，存在しないものとみなします。

【ルートジョブネット定義ファイル以外の注意事項】

(1) 次のプロパティ，および，ジョブネット定義ファイルに指定する文字列長は，記載の長さ以下で指定してください。

　・jp1ajs.logicalHostNameRemoteプロパティ：64文字

　・ジョブネット定義ファイルの上位ユニット名：512文字

　これらの文字列長を超えると，タスクで実行するコマンドラインの最大長を超過し，長さが切りつめられた不当な形式でコマンドが実行される場合があります。最大長を超過した場合はタスクログにKNAE08015-Wメッセージが出力されます。

(2) 業務サーバのOS種別がWindowsのときは，次の値に「%」を指定する場合，「%」でエスケープした文字「%%」を指定してください。

　・jp1ajs.jp1UserNameプロパティ

　・jp1ajs.serviceNameRemoteプロパティ

　・ルートジョブネット定義ファイル内の値。ただし，ルートジョブネット名には「%」を指定できません。

(3) 業務サーバのOS種別がWindowsのときは，次の値に「"」を指定できません。

　・jp1ajs.serviceNameRemoteプロパティ

(4) 業務サーバのOS種別がUNIXのときは，次の値に「'」を指定できません。

　・jp1ajs.jp1UserNameプロパティ

　・jp1ajs.serviceNameRemoteプロパティ

　・ルートジョブネット定義ファイル内の値

(5) 上記以外の注意事項は，JP1/AJSのマニュアル「コマンドリファレンス1」のajsleaveコマンド，ajsdeleteコマンドの注意事項を参照してください。

実行権限

ビルトイン Administrator

また，jp1ajs.jp1UserNameで指定されるユーザーであり，JP1/AJS3共通情報の環境設定パラメーター"ADMACLIMIT"に"yes"が設定されている場合，次の権限が必要です。

[Windows，UNIX共通]

・業務サーバに対する権限

JP1_AJS_Manager権限，JP1_AJS_Admin権限のうちの，どちらかの権限

なお，実行登録解除が不要な場合は，JP1_AJS_Editor権限でも実行できます。

バージョン

03.01.02

タグ

Configure JP1,AJS

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

ルートジョブネット情報

ルートジョブネットの情報です。

表示されます。

業務サーバ情報

業務サーバの情報です。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1ajs.hostNameRemote

ホスト名(業務サーバ)

業務サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

業務サーバ情報

jp1ajs.logicalHostNameRemote

論理ホスト名(業務サーバ)

業務サーバのJP1/AJSがクラスタ構成の場合，JP1/AJSの論理ホスト名を指定します。

入力

無効

△　

業務サーバ情報

OS.osKind

OSの種類

OSの種類(Windows/UNIX)を指定します。

入力

無効

○　

業務サーバ情報

OS.fileOpenRetryCount

ファイル読み込み時のリトライ回数:Windows固有

ルートジョブネット定義ファイルファイルの読み込みに失敗した場合のリトライ回数を指定します(Windowsの場合だけ)。ファイル読み込み時のリトライ間隔と組み合わせて最大待ち時間となります。"0"を指定した場合はリトライしません。

入力

無効

○　

ルートジョブネット情報

OS.fileOpenRetryInterval

ファイル読み込み時のリトライ間隔:Windows固有

ルートジョブネット定義ファイルの読み込みに失敗した場合のリトライ間隔を秒単位で指定します(Windowsの場合だけ)。

入力

無効

○　

ルートジョブネット情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1ajs.jobnetListFilePath

ルートジョブネット定義ファイルのパス

JP1/AOサーバ上に格納した，ルートジョブネット定義ファイルのパスをフルパスで指定します。ファイルの拡張子はcsv，xls，xlsx，xlsmのどれかである必要があります。

入力

無効

○　

ルートジョブネット情報

jp1ajs.jobnetInfoSheetName

ルートジョブネット定義ファイルのシート名

ルートジョブネットの情報が記載されたシート名を指定します。ルートジョブネット定義ファイルがExcelファイルの場合には必ず指定してください。CSVファイルの場合，指定しても無視されます。

入力

無効

○　

ルートジョブネット情報

jp1ajs.serviceNameRemote

JP1/AJSのスケジューラーサービス名(業務サーバ)

業務サーバのスケジューラーサービス名を指定します。

入力

無効

○　

業務サーバ情報

jp1ajs.jp1UserName

JP1ユーザー名

JP1/AJSコマンドを実行するJP1ユーザー名を指定します。サーバに接続する際のOSユーザー名と同一名称のJP1ユーザーで実行する場合，指定する必要はありません。

入力

無効

△　

業務サーバ情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1ajs.hostNameRemote

255文字以内の半角英数字および「.」，「-」。

jp1ajs.logicalHostNameRemote

255文字以内の半角英数字および「.」，「-」。

OS.osKind

次の値のどれかを選択する。

Windows,UNIX

OS.fileOpenRetryCount

0〜32767の整数値。

OS.fileOpenRetryInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1ajs.jobnetListFilePath

8文字以上255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「[」，「]」，「!」および末尾の「¥」，「/」を除く。

jp1ajs.jobnetInfoSheetName

1文字以上31文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「:」，「&」，「*」，「?」，「"」，「%」，「/」，「¥」，「!」，「`」，「{」，「[」，「]」および全角記号「：」，「￥」，「？」，「［」，「］」，「／」，「＊」を除く。

jp1ajs.serviceNameRemote

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。

jp1ajs.jp1UserName

31文字以内の半角英数字，および「!」，「#」，「$」，「%」，「'」，「-」，「@」，「_」，「~」。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

ルートジョブネット情報キー値リスト取得

ルートジョブネット情報キー値リスト取得

CSV・Excelの列データ取得

ルートジョブネット定義ファイルからルートジョブネットのキー値のリストを取得します。

エラー原因を取り除いたあと，サービスを再実行してください。

2

データ分繰り返し処理

データ分繰り返し処理

繰り返し実行部品

読み出したキー情報を元に，繰り返しルートジョブネットの削除を実行します。

エラー原因を取り除いたあと，サービスを再実行してください。

2.5.9　JP1/AJSのルートジョブネット削除(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

ルートジョブネット情報読み込み

readRootJobnet

CSV・Excelの行データ取得

ルートジョブネット定義ファイルからルートジョブネットの情報を読み出します。

エラー原因を取り除き，ルートジョブネット定義ファイルから削除に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

2

OS判定(Windows)

judgeOsWindows

値判定分岐部品

OSがWindowsか判定します。

エラー原因を取り除き，ルートジョブネット定義ファイルから削除に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3

Windows用フロー

flowWindows

階層フロー部品

Windows用フローです。

−　

3-1

値判定分岐部品

接続しているホストが論理ホストか判定をします。

エラー原因を取り除き，ルートジョブネット定義ファイルから削除に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-2

汎用コマンド実行部品

論理ホストの場合，コマンドラインで使用する環境変数をワーク変数に代入します。

エラー原因を取り除き，ルートジョブネット定義ファイルから削除に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-3

汎用コマンド実行部品

ルートジョブネットの実行登録を解除します。

エラー原因を取り除き，ルートジョブネット定義ファイルから削除に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-4

汎用コマンド実行部品

ルートジョブネット定義を削除します。

エラー原因を取り除き，ルートジョブネット定義ファイルから削除に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

4

OS判定(UNIX)

judgeOsUNIX

値判定分岐部品

OSがUNIXか判定します。

エラー原因を取り除き，ルートジョブネット定義ファイルから削除に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5

UNIX用フロー

flowUNIX

階層フロー部品

UNIX用フローです。

−　

5-1

値判定分岐部品

接続しているホストが論理ホストか判定をします。

エラー原因を取り除き，ルートジョブネット定義ファイルから削除に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-2

汎用コマンド実行部品

論理ホストの場合，コマンドラインで使用する環境変数をワーク変数に代入します。

エラー原因を取り除き，ルートジョブネット定義ファイルから削除に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-3

汎用コマンド実行部品

ルートジョブネットの実行登録を解除します。

エラー原因を取り除き，ルートジョブネット定義ファイルから削除に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-4

汎用コマンド実行部品

ルートジョブネット定義を削除します。

エラー原因を取り除き，ルートジョブネット定義ファイルから削除に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

2.5.10　JP1/AJSのルートジョブネット削除(SYSTEM)

機能

このサービステンプレートは，CSV(Comma Separated Values)ファイルまたはMicrosoft Excelによって作成されたルートジョブネットの一覧情報(これ以降，ルートジョブネット定義ファイルと呼びます)を使用して，JP1/AJS3 - Manager (以降JP1/AJSと呼びます)に定義されたルートジョブネットを削除します。

JP1/AOサーバがWindows環境の場合はCSVファイルまたはExcelファイル，UNIX環境の場合はCSVファイルを使用します。

このサービステンプレートが前提とするサーバを次に示します。

・業務サーバ

　JP1/AJSが動作するサーバです。削除対象のルートジョブネットが登録されている必要があります。

jp1ajs.jobnetListFilePathプロパティで指定するルートジョブネット定義ファイルからキー値を記載した列を取り出し，すべてのキー値に対して次の処理を実行します。

(1) キー値に合致する行のルートジョブネット名を読み取ります。

(2) 処理(1)で読み取った情報を使用して，業務サーバでajsleaveコマンドを実行し，ルートジョブネットの実行登録を解除します。ルートジョブネットの実行登録の解除に失敗した場合もエラーとはしないで処理を継続します。

(3) 処理(1)で読み取った情報を使用して，業務サーバでajsdeleteコマンドを実行し，ルートジョブネット定義を削除します。削除の対象は，実行登録されていないルートジョブネットになります。ルートジョブネット定義の削除に失敗した場合，タスクが異常終了します。

ルートジョブネット定義ファイルには，ルートジョブネット情報を99件(99行)まで記載できます。

各変更処理は，繰り返し部品で逐次的に実行します。

ルートジョブネット定義ファイル読み込みに失敗した場合は，OS.fileOpenRetryIntervalプロパティに指定した秒数待ってファイル読み込みをリトライする処理を，OS.fileOpenRetryCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)JP1/AOサーバがWindows環境の場合，次に示すMicrosoft社のプログラムがJP1/AOサーバにインストールされていること。

　2007 Office system ドライバ，または

　Microsoft Access データベース エンジン 2010（32bit版），または

　Microsoft Access Database Engine 2016（32bit版）

(2)業務サーバに次の製品が稼働していること。

　JP1/Automatic Job Management System 3 - Manager 09-00以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【サービステンプレート実行システム内前提製品の使用条件】

(1)JP1/AJSのスケジューラーサービスが起動されていること。

(2)jp1ajs.jp1UserNameプロパティに指定したJP1ユーザーが，業務サーバに登録されていること。

(3)業務サーバ上に削除対象のルートジョブネットが登録されていて，かつ実行中でないこと。

(4)このサービステンプレートはルートジョブネットの削除だけサポートする。ジョブグループの一括削除はサポートしない。

(5)JP1/AOサーバ上に，次に示す内容を記載したルートジョブネット定義ファイルを格納していること。

・列数

　データの読み取り開始列から数えた列数が255列以内となるようにしてください。

・列名

　・CSVファイルの場合

　　・列名が必要な場合は，ファイルの1行目に記載してください。

　　　列名が不要の場合は，列名の記載は必要ありません。

　　・列名の記載有無に関わらず，データの読み取り開始行は2行目からとなります。

　・Excelファイルの場合

　　・列名は必ず記載してください。1行目以降で最初に記述がある行が列名となります。

　　・データの読み取り開始行は列名が記載されている行の次の行からとなります。

　列名の指定の際は(6)を参照してください。

・キー情報

　ルートジョブネット定義ファイルの各行でユニークなキーとなる値を格納した列です。キー情報の内容は任意ですが，1から始まる整数値など，短い値を指定することを推奨します。また，キー情報には「"」および「'」以外の文字を使用してください。(すべてのキー情報の合計バイト数＋データの行数)が1017バイト以下になるようにしてください。各行への値の指定は任意です。省略した場合，該当する行の処理は行なわれません。

・上位ユニット名

　ルートジョブネットの上位ユニット名を指定します。ルートジョブグループを指定する場合は空文字を指定してください。

・ルートジョブネット名

　ルートジョブネット名を指定します。ジョブ名やジョブグループ名，ルートジョブネットを除くジョブネット名は指定できません。各行への値の指定は必須です。

(例)

キー情報,上位ユニット名,ルートジョブネット名

1,/parent1,jobnet1

2,/parent2,jobnet2

3,/parent3,jobnet3

(6)このサービスを実行する場合，エージェントレス接続先としてJP1/AOサーバ("localhost"で解決されるループバックアドレス)および業務サーバを設定すること。

(7)ルートジョブネット定義ファイルの列名には次に示す内容を指定すること。

・必ず文字列で指定すること。数値データは指定しないこと。

・次の文字は列名に使用できない。

　・キー情報の列名の先頭には次の文字を使用できない。

　「!」「"」「#」「$」「%」「&」「'」「(」「)」「-」「=」「^」「~」「¥」「|」「`」「;」「+」「*」「[」「]」「{」「}」「,」「.」「<」「>」「?」「_」「/」「0」「1」「2」「3」「4」「5」「6」「7」「8」「9」「０」「１」「２」「３」「４」「５」「６」「７」「８」「９」

　・キー情報の列名の2文字目以降には次の文字を使用できない。

　「"」「#」「%」「&」「'」「(」「)」「-」「=」「^」「~」「¥」「|」「@」「;」「:」「+」「*」「[」「]」「{」「}」「,」「.」「<」「>」「?」「/」

　・キー情報以外の列名には次の文字を使用できない。

　「!」「[」「]」「`」「,」「.」

・文字数は半角全角混合で64文字まで指定できる。

(8)ルートジョブネット定義ファイルから読み込んだフィールドには次のチェックを行います。どれかの条件に当てはまると，タスクは異常終了します。

　・フィールドに次の特殊記号を含む

　「,」(JP1/AOサーバがWindows環境の場合)，「<」，「>」，「|」，「;」，「&」，両端以外の「"」および末尾の「¥」

　なおフィールドのデータが空の場合，無視して次の行を読み取ります。

　・フィールドに制御文字(0x00〜0x1f)を含む

注意事項

【ルートジョブネット定義ファイルに関する注意事項】

・JP1/AOサーバがWindows環境の場合の注意事項

(1) Excelファイルのセルが結合されている場合，数式がエラーとなっている場合は取得される値が空になります。また，書き込みパスワードが設定されている場合はタスクが異常終了します。ルートジョブネット定義ファイルからはこれらの状態を取り除いてください。

(2) 読み取る列は，文字列型データと数値型データを混在させないでください。混在していると，ODBCドライバの仕様によって，正常に値を取得できない場合があります。

　(a) 数値型データとは次の形式の文字列のことです。

　　符号付き整数値(10 進数) 例：-12345

　　固定小数点数(10 進数) 　例：3.1415

　　浮動小数点数(10 進数) 　例：6.543E+10

　(b) 文字列型データとは上の数値型以外の形式の文字列のことです。

(3) 異なるデータ型が混在する列を取得する場合は，次の対処が必要です。

　・Excel ファイルの場合は数値型データの先頭に「'」を付けてください。

　・CSV ファイルの場合は数値型データを「"」で囲んでください。

(4) データの途中に空白行がある場合，空白行も行数としてカウントされます。データが記述された行が99行以内であっても，途中の空白行を含めた行数が100以上となる場合，タスクが異常終了するのでご注意ください。

・JP1/AOサーバがUNIX環境の場合の注意事項

(1) データの途中に空白行がある場合，空白行も行数としてカウントされます。データが記述された行が99行以内であっても，途中の空白行を含めた行数が100以上となる場合，タスクが異常終了するのでご注意ください。

(2) データには「,」は使用できません。使用した場合，列を正しく区切ることができないため，データを取得できません。

(3) ルートジョブネット定義ファイルの行の先頭または末尾に存在する半角スペースおよびタブ記号は，その個数に関係なく，存在しないものとみなします。

【ルートジョブネット定義ファイル以外の注意事項】

(1) 次のプロパティ，および，ジョブネット定義ファイルに指定する文字列長は，記載の長さ以下で指定してください。

　・jp1ajs.logicalHostNameRemoteプロパティ：64文字

　・ジョブネット定義ファイルの上位ユニット名：512文字

　これらの文字列長を超えると，タスクで実行するコマンドラインの最大長を超過し，長さが切りつめられた不当な形式でコマンドが実行される場合があります。最大長を超過した場合はタスクログにKNAE08015-Wメッセージが出力されます。

(2) 業務サーバのOS種別がWindowsのときは，次の値に「%」を指定する場合，「%」でエスケープした文字「%%」を指定してください。

　・jp1ajs.jp1UserNameプロパティ

　・jp1ajs.serviceNameRemoteプロパティ

　・ルートジョブネット定義ファイル内の値。ただし，ルートジョブネット名には「%」を指定できません。

(3) 業務サーバのOS種別がWindowsのときは，次の値に「"」を指定できません。

　・jp1ajs.serviceNameRemoteプロパティ

(4) 業務サーバのOS種別がUNIXのときは，次の値に「'」を指定できません。

　・jp1ajs.jp1UserNameプロパティ

　・jp1ajs.serviceNameRemoteプロパティ

　・ルートジョブネット定義ファイル内の値

(5) 上記以外の注意事項は，JP1/AJSのマニュアル「コマンドリファレンス1」のajsleaveコマンド，ajsdeleteコマンドの注意事項を参照してください。

実行権限

Administratorsグループに所属するユーザー

また，jp1ajs.jp1UserNameで指定されるユーザーであり，JP1/AJS3共通情報の環境設定パラメーター"ADMACLIMIT"に"yes"が設定されている場合，次の権限が必要です。

[Windows，UNIX共通]

・業務サーバに対する権限

JP1_AJS_Manager権限，JP1_AJS_Admin権限のうちの，どちらかの権限

なお，実行登録解除が不要な場合は，JP1_AJS_Editor権限でも実行できます。

バージョン

03.10.02

タグ

Configure JP1,AJS

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

ルートジョブネット情報

ルートジョブネットの情報です。

表示されます。

業務サーバ情報

業務サーバの情報です。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1ajs.hostNameRemote

ホスト名(業務サーバ)

業務サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

業務サーバ情報

jp1ajs.logicalHostNameRemote

論理ホスト名(業務サーバ)

業務サーバのJP1/AJSがクラスタ構成の場合，JP1/AJSの論理ホスト名を指定します。

入力

無効

△　

業務サーバ情報

OS.osKind

OSの種類

OSの種類(Windows/UNIX)を指定します。

入力

無効

○　

業務サーバ情報

OS.fileOpenRetryCount

ファイル読み込み時のリトライ回数:Windows固有

ルートジョブネット定義ファイルファイルの読み込みに失敗した場合のリトライ回数を指定します(Windowsの場合だけ)。ファイル読み込み時のリトライ間隔と組み合わせて最大待ち時間となります。"0"を指定した場合はリトライしません。

入力

無効

○　

ルートジョブネット情報

OS.fileOpenRetryInterval

ファイル読み込み時のリトライ間隔:Windows固有

ルートジョブネット定義ファイルの読み込みに失敗した場合のリトライ間隔を秒単位で指定します(Windowsの場合だけ)。

入力

無効

○　

ルートジョブネット情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1ajs.jobnetListFilePath

ルートジョブネット定義ファイルのパス

JP1/AOサーバ上に格納した，ルートジョブネット定義ファイルのパスをフルパスで指定します。ファイルの拡張子はcsv，xls，xlsx，xlsmのどれかである必要があります。

入力

無効

○　

ルートジョブネット情報

jp1ajs.jobnetInfoSheetName

ルートジョブネット定義ファイルのシート名

ルートジョブネットの情報が記載されたシート名を指定します。ルートジョブネット定義ファイルがExcelファイルの場合には必ず指定してください。CSVファイルの場合，指定しても無視されます。

入力

無効

○　

ルートジョブネット情報

jp1ajs.serviceNameRemote

JP1/AJSのスケジューラーサービス名(業務サーバ)

業務サーバのスケジューラーサービス名を指定します。

入力

無効

○　

業務サーバ情報

jp1ajs.jp1UserName

JP1ユーザー名

JP1/AJSコマンドを実行するJP1ユーザー名を指定します。サーバに接続する際のOSユーザー名と同一名称のJP1ユーザーで実行する場合，指定する必要はありません。

入力

無効

△　

業務サーバ情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1ajs.hostNameRemote

255文字以内の半角英数字および「.」，「-」。

jp1ajs.logicalHostNameRemote

255文字以内の半角英数字および「.」，「-」。

OS.osKind

次の値のどれかを選択する。

Windows,UNIX

OS.fileOpenRetryCount

0〜32767の整数値。

OS.fileOpenRetryInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1ajs.jobnetListFilePath

8文字以上255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「[」，「]」，「!」および末尾の「¥」，「/」を除く。

jp1ajs.jobnetInfoSheetName

1文字以上31文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「:」，「&」，「*」，「?」，「"」，「%」，「/」，「¥」，「!」，「`」，「{」，「[」，「]」および全角記号「：」，「￥」，「？」，「［」，「］」，「／」，「＊」を除く。

jp1ajs.serviceNameRemote

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。

jp1ajs.jp1UserName

31文字以内の半角英数字，および「!」，「#」，「$」，「%」，「'」，「-」，「@」，「_」，「~」。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

ルートジョブネット情報キー値リスト取得(SYSTEM)

ルートジョブネット情報キー値リスト取得(SYSTEM)

CSV・Excelの列データ取得(SYSTEM)

ルートジョブネット定義ファイルからルートジョブネットのキー値のリストを取得します。

エラー原因を取り除いたあと，サービスを再実行してください。

2

データ分繰り返し処理

データ分繰り返し処理

繰り返し実行部品

読み出したキー情報を元に，繰り返しルートジョブネットの削除を実行します。

エラー原因を取り除いたあと，サービスを再実行してください。

2.5.11　JP1/AJSのルートジョブネット削除(SYSTEM)(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

ルートジョブネット情報読み込み(SYSTEM)

readRootJobnet_System

CSV・Excelの行データ取得(SYSTEM)

ルートジョブネット定義ファイルからルートジョブネットの情報を読み出します。

エラー原因を取り除き，ルートジョブネット定義ファイルから削除に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

2

OS判定(Windows)

judgeOsWindows

値判定分岐部品

OSがWindowsか判定します。

エラー原因を取り除き，ルートジョブネット定義ファイルから削除に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3

Windows用フロー

flowWindows

階層フロー部品

Windows用フローです。

−　

3-1

値判定分岐部品

接続しているホストが論理ホストか判定をします。

エラー原因を取り除き，ルートジョブネット定義ファイルから削除に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-2

汎用コマンド実行部品

論理ホストの場合，コマンドラインで使用する環境変数をワーク変数に代入します。

エラー原因を取り除き，ルートジョブネット定義ファイルから削除に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-3

汎用コマンド実行部品

ルートジョブネットの実行登録を解除します。

エラー原因を取り除き，ルートジョブネット定義ファイルから削除に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

3-4

汎用コマンド実行部品

ルートジョブネット定義を削除します。

エラー原因を取り除き，ルートジョブネット定義ファイルから削除に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

4

OS判定(UNIX)

judgeOsUNIX

値判定分岐部品

OSがUNIXか判定します。

エラー原因を取り除き，ルートジョブネット定義ファイルから削除に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5

UNIX用フロー

flowUNIX

階層フロー部品

UNIX用フローです。

−　

5-1

値判定分岐部品

接続しているホストが論理ホストか判定をします。

エラー原因を取り除き，ルートジョブネット定義ファイルから削除に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-2

汎用コマンド実行部品

論理ホストの場合，コマンドラインで使用する環境変数をワーク変数に代入します。

エラー原因を取り除き，ルートジョブネット定義ファイルから削除に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-3

汎用コマンド実行部品

ルートジョブネットの実行登録を解除します。

エラー原因を取り除き，ルートジョブネット定義ファイルから削除に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

5-4

汎用コマンド実行部品

ルートジョブネット定義を削除します。

エラー原因を取り除き，ルートジョブネット定義ファイルから削除に成功したルートジョブネットの記載を取り除いたあと，サービスを再実行してください。

2.5.12　JP1/Cm2の監視対象ノード一覧取得

機能

JP1/Cm2/NNMiの監視対象ノード一覧を取得します。

このサービステンプレートが前提とするサーバを次に示します。

・NNMiサーバ

　JP1/Cm2/NNMiがインストールされているサーバです。

・監視対象ノード

　JP1/Cm2/NNMiが監視するサーバまたは機器です。

処理の概要を次に示します。

1.NNMiサーバの監視対象ノード一覧を取得し，指定されたファイルにXML形式で出力します。ファイルの出力フォーマットは，JP1/Cm2/NNMiのnnmtopodumpコマンドの出力結果と同じ形式です。

2.出力したファイルをNNMiサーバからJP1/AOサーバに転送し，NNMiサーバ上の転送元ファイルを削除します。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1) JP1/Cm2/Network Node Manager i 09-10〜10-50

(2) JP1/Network Node Manager i 11-00〜12-60

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter (x64)

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【サービステンプレート実行システム内前提製品の使用条件】

(1)このサービスを実行する場合，エージェントレス接続先としてJP1/AOサーバ("localhost"で解決されるループバックアドレス)およびNNMiサーバを設定する必要があります。

(2)JP1/Cm2/NNMi 09-10を使用する場合，NNMiサーバで，アカウントクレデンシャル(JP1/Cm2/NNMiのスクリプトを実行するときのユーザー名とパスワードに使用される値)が設定済みであること。

注意事項

(1)このサービスを同一のNNMiサーバに複数同時に実行しないでください。

(2)このサービスでは，NNMiサーバ上でnnmtopodumpコマンドを実行します。そのため，サービス実行中にNNMiサーバ上でnnmtopodumpコマンドを実行しないでください。同様に，NNMiサーバ上で，nnmtopodumpコマンドを実行中の場合は，このサービスを実行しないでください。

(3)実行対象サーバの稼働OSがLinuxの場合は，エージェントレス接続先に定義された接続ユーザーのデフォルトロケールでコマンドが実行されます。接続ユーザーのデフォルトロケールには，JP1/Cm2/NNMiがサポートするロケールを設定してください。詳細については，JP1/AOマニュアルの「部品実行時に設定される操作対象の機器のロケールについて」，「部品実行時に設定されるJP1/AOが通信で使用する文字セットについて」およびJP1/Cm2/NNMiリリースノートを参照してください。

(4)リモートおよびローカルに指定するファイル名がすでに存在する場合，既存のファイルを上書きします。また，リモート側のファイルは削除します。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(5)リモートに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除されないで残ります。定期的に使用しない場合は削除してください。

バージョン

02.00.00

タグ

Gather JP1 information,NNMi

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

監視システム環境情報

NNMiサーバの環境情報を指定してください。

表示されます。

出力ファイル格納情報

出力ファイルの格納先を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1cm2nnm.nnmHostName

NNMiサーバのホスト名

JP1/Cm2/NNMiがインストールされているサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

監視システム環境情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1cm2nnm.nodeListFileNameRemote

出力ファイルパス(リモート)

監視対象ノード一覧ファイルをNNMiサーバに出力する際の一時ファイル名をフルパスで指定します。転送後にリモートのファイルは削除されます。

入力

無効

○　

出力ファイル格納情報

jp1cm2nnm.nodeListFileNameLocal

出力ファイルパス(ローカル)

監視対象ノード一覧ファイルを取得するJP1/AOサーバのファイル名をフルパスで指定します。

入力

無効

○　

出力ファイル格納情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1cm2nnm.nnmHostName

255文字以内の半角英数字および「.」，「-」。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1cm2nnm.nodeListFileNameRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」，「/」を除く。

jp1cm2nnm.nodeListFileNameLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

NNMi監視対象ノード一覧取得

NNMi監視対象ノード一覧取得

NNMiトポロジデータベース内容の出力

NNMiの監視対象ノード一覧を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

ファイル転送

ファイル転送

ファイル転送部品

監視対象ノード一覧ファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

一時ファイル削除

一時ファイル削除

ファイル削除

一時ファイルを削除します。

対象サーバにファイルが残っています。手動で削除してください。

2.5.13　JP1/IM-SSの案件情報更新

機能

このサービステンプレートは，JP1/IM-SSのjssitemedit(案件編集)コマンドを使って，登録案件のステータスの更新を行うサービステンプレートです。

前提とするサーバを次に示します。

・JP1/IM-SSサーバ

　JP1/IM-SSが動作するサーバです。

・JP1/AOサーバ

　JP1/AOが動作するサーバです。

機能の概要を次に示します。

(1)JP1/IM-SSサーバの案件の案件情報を更新します。

　１．JP1/IM-SSのjssitemeditコマンドを発行して，案件情報を指定値で更新します。

　　ユーザーが更新できるプロパティは基本的なものに限り，プロパティグループ「案件基本情報」のプロパティで指定します。

　２．ステータス (jp1imss.statusTypeCodeプロパティ)の指定値は，デフォルトではJP1/IM-SSのコードマッピングファイル(jp1imss_itemedit_codemap.conf)に設定されているキーで指定する必要があります。

　　デフォルトでは次のキーを指定できます。

　　[キー]

　　　受付

　　　調査中

　　　計画中

　　　審議中

　　　対応依頼中

　　　レビュー中

　　　承認済み

　　　クローズ

　　　拡張ステータス01〜拡張ステータス40

　　デフォルト以外のキーを指定する場合は，コードマッピングファイルを作成して，コードマッピングファイルパス(リモート)(jp1imss.codeMappingFile)に，作成したコードマッピングファイル名を指定してください。

　　コードマッピングファイルについては「JP1/Service Support 構築・運用ガイド」を参照してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)JP1/IM-SSサーバに次の製品が稼働していること。

JP1/Integrated Management - Service Support 10-10以降，または

JP1/Service Support 11-00以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

【サービステンプレート実行システム内前提製品の使用条件】

(1)案件IDの案件がJP1/IM-SSサーバ上に存在していること。

(2)プロパティに指定するユーザーIDがJP1/IM-SSサーバに定義されていること。

(3)プロパティに指定するロールIDがJP1/IM-SSサーバに定義されていること。

注意事項

(1)指定しなかったプロパティは更新されません。指定しなかったプロパティを更新する場合は，JP1/IM-SSのGUIかコマンドを使用して更新してください。

実行権限

ビルトイン Administrator

バージョン

02.00.00

タグ

Configure JP1,SS

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

JP1/IM-SS環境情報

JP1/IM-SSサーバの情報を指定してください。

表示されます。

案件基本情報

編集する案件の基本情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1imss.imssServerName

JP1/IM-SSサーバのホスト名

案件を管理するJP1/IM-SSサーバのホスト名，またはIPアドレスを指定します。IPv6には対応していません。

入力

無効

○　

JP1/IM-SS環境情報

jp1imss.entryUserID

登録者ID

案件の登録者となるユーザーのIDを指定します。

入力

無効

○　

案件基本情報

jp1imss.ownerUserType

担当者種別

案件の担当者の種別として，「USER」または「ROLE」のどちらかを指定します。

入力

無効

○　

案件基本情報

jp1imss.ownerUserID

担当者ID

案件の担当者となるユーザーのID，またはロールのIDを指定します。

入力

無効

○　

案件基本情報

jp1imss.codeMappingFile

コードマッピングファイルパス(リモート)

ユーザーが定義したコードマッピングファイルを使用する場合，JP1/IM-SSサーバ上のコードマッピングファイル名をフルパスで指定します。

入力

無効

△　

案件基本情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1imss.itemID

案件ID

案件を一意に識別するためのIDを指定します。JP1/IM-SSの案件IDを指定してください。

入力

無効

○　

案件基本情報

jp1imss.statusTypeCode

ステータス

案件に設定するステータスを指定します。

入力

無効

○　

案件基本情報

jp1imss.forceWrite

編集中の更新の可否

案件が編集中の状態でも更新する場合にtrueを指定します。falseを指定すると，案件が編集中のときは更新できません。指定しない場合は，falseとなります。

入力

無効

△　

案件基本情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1imss.imssServerName

255文字以内の半角英数字および「.」，「-」。

jp1imss.entryUserID

64文字以内の半角英数字。

jp1imss.ownerUserType

次の値のどれかを選択する。

USER,ROLE

jp1imss.ownerUserID

64文字以内の半角英数字と下線。

jp1imss.codeMappingFile

4文字以上255文字以内の文字列。ただし「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「`」，および末尾の「¥」を除く。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1imss.itemID

75文字以内の半角英数字および「-」。

jp1imss.statusTypeCode

255文字以内の半角英数字と全角文字。

jp1imss.forceWrite

次の値のどれかを選択する。

true,false

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

JP1/IM-SS案件更新

JP1/IM-SS案件更新

JP1/IM-SSの案件情報更新

JP1/IM-SSサーバに登録されている案件を更新します。

エラー原因を取り除いたあと，サービスを再実行してください。

2.5.14　JP1/IM-SSの案件登録

機能

このサービステンプレートは，JP1/IM-SSのjssitementry(案件登録)コマンドを使って，案件登録を行うサービステンプレートです。

前提とするサーバを次に示します。

・JP1/IM-SSサーバ

　JP1/IM-SSが動作するサーバです。

・JP1/AOサーバ

　JP1/AOが動作するサーバです。

機能の概要を次に示します。

(1)JP1/IM-SSサーバに案件を登録します

　１．JP1/IM-SSのjssitementryコマンドを発行して，JP1/IM-SSのプロセスワークボードに新規案件を登録します。指定できる案件データは基本的なものに限り，プロパティグループ「案件基本情報」のプロパティで指定します。

　２．JP1/IM-SSに，JP1/AOと連携するための環境設定を実施済みである場合，プロパティグループ「JP1/IM-SSのJP1/AOとの連携機能の関連情報」のプロパティをすべて指定することで，登録する案件の「関連情報」にJP1/AOのサービス実行ダイアログを呼ぶための設定がされます。

　　案件の「関連情報」の表示名には，jp1imss.relatedInformationNameプロパティの値が設定されます。案件の「関連情報」のURL文字列には，プロパティの指定値から作成された次の形式のURLが設定されます。

　　関連情報に設定するURL：

　　<JP1/AOサーバのプロトコル>://<JP1/AOサーバのホスト名>:<JP1/AOサーバのコマンドを実行するポート番号>/Automation/launcher/SubmitTask

　なお，上記プロパティに指定する値は，JP1/IM-SSのシステムプロパティファイル(hptl_jp1_imss_main_setting.properties)のhptl_jp1_imss_add_item_info_url_$nを参照してください。

　３．重大度 (jp1imss.severity)の指定値は，デフォルトではJP1/IM-SSのコードマッピングファイル(jp1imss_itementry_codemap.conf)に設定されているキーで指定する必要があります。

　　デフォルトでは次のキーを指定できます。

　　[キー(デフォルトの案件フォームでの名称)］

　　　Emergency(緊急)

　　　Alert(警戒)

　　　Critical(致命的)

　　　Error(エラー)

　　　Warning(警告)

　　　Notice(通知)

　　　Information(情報)

　　　Debug(デバッグ)

　　デフォルト以外のキーを指定する場合は，コードマッピングファイルを作成して，コードマッピングファイルパス(リモート)(jp1imss.codeMappingFile)に，作成したコードマッピングファイル名を指定してください。

　　コードマッピングファイルについては「JP1/Integrated Management - Service Support構築・運用ガイド」を参照してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)JP1/IM-SSサーバに次の製品が稼働していること。

JP1/Integrated Management - Service Support 10-10以降，または

JP1/Service Support 11-00以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

【サービステンプレート実行システム内前提製品の使用条件】

(1)登録先のプロセスワークボードがJP1/IM-SSサーバに定義されていること。

(2)プロパティに指定するユーザーIDがJP1/IM-SSサーバに定義されていること。

(3)プロパティに指定するロールIDがJP1/IM-SSサーバに定義されていること。

【JP1/IM-SSのJP1/AOとの連携機能を使用する場合の使用条件】

(1)JP1/IM-SSサーバとJP1/AOサーバがシングルサインオンで連携していること。

　シングルサインオンの設定方法は「JP1/Service Support構築・運用ガイド」のJP1/AO との連携機能について記述されている箇所を参照してください。

(2)案件フォームに拡張テキストデータを追加していること。

　JP1/IM-SSのJP1/AOとの連携機能で呼び出すサービスの所属するサービスグループ名と，呼び出すサービス名に対応する拡張テキストデータをJP1/IM-SSの案件フォームに追加していること。

　案件フォームの設定方法は「JP1/Service Support構築・運用ガイド」の案件フォームのカスタマイズについて記述されている箇所を参照してください。

(3)システムプロパティファイルに拡張テキストデータの項目IDを設定していること。

案件フォームに追加した拡張テキストデータの項目IDをJP1/IM-SSのシステムプロパティファイル(hptl_jp1_imss_main_setting.properties)の，JP1/AOに引き継がれる情報(サービスのサービスグループ名，サービス名)に設定してください。　

　システムプロパティファイルの設定方法は「JP1/Integrated Management - Service Support構築・運用ガイド」のJP1/AO との連携機能について記述されている箇所を参照してください。

(4)JP1/IM-SSのJP1/AOとの連携機能で呼び出すサービスが，ローカルサーバにサービスとして存在していること。

注意事項

(1)指定しなかったプロパティは登録されません。指定しなかったプロパティを登録する場合は，JP1/IM-SSのGUIかコマンドを使用して案件情報を更新してください。

(2)次のプロパティを指定する場合は４つすべてを指定してください。

　・jp1imss.relatedResourceGroupNameプロパティ

　・jp1imss.relatedResourceGroupNumberプロパティ

　・jp1imss.relatedServiceNameプロパティ

　・jp1imss.relatedServiceNumberプロパティ

(3)次のプロパティには，「//」ではじまる値を指定しないでください。

　・jp1imss.titleNameプロパティ

　・jp1imss.summaryプロパティ

　・jp1imss.relatedInformationNameプロパティ

　・jp1imss.relatedServiceNameプロパティ

実行権限

ビルトイン Administrator

バージョン

02.00.00

タグ

Configure JP1,SS

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

JP1/IM-SS環境情報

JP1/IM-SSサーバの情報を指定してください。

表示されます。

案件基本情報

登録する案件の基本情報を指定してください。

表示されます。

JP1/IM-SSのJP1/AOとの連携機能の関連情報

JP1/IM-SSから連携機能でJP1/AOのサービスを呼び出すリンクを設定するための情報を指定してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1imss.imssServerName

JP1/IM-SSサーバのホスト名

案件を管理するJP1/IM-SSサーバのホスト名，またはIPアドレスを指定します。IPv6には対応していません。

入力

無効

○　

JP1/IM-SS環境情報

jp1imss.processWorkBoardID

プロセスワークボードID

案件を登録するプロセスワークボードのIDを指定します。

入力

無効

○　

案件基本情報

jp1imss.entryUserID

登録者ID

案件の登録者となるユーザーのIDを指定します。

入力

無効

○　

案件基本情報

jp1imss.ownerUserType

担当者種別

案件の担当者の種別として，「USER」または「ROLE」のどちらかを指定します。

入力

無効

○　

案件基本情報

jp1imss.ownerUserID

担当者ID

案件の担当者となるユーザーのID，またはロールのIDを指定します。

入力

無効

○　

案件基本情報

jp1imss.codeMappingFile

コードマッピングファイルパス(リモート)

ユーザーが定義したコードマッピングファイルを使用する場合，JP1/IM-SSサーバ上のコードマッピングファイル名をフルパスで指定します。

入力

無効

△　

案件基本情報

jp1imss.relatedIP

JP1/AOサーバのホスト名

登録した案件の関連情報からJP1/IM-SSのJP1/AOとの連携機能を用いて，JP1/AOのサービス実行画面を呼び出す時に指定します。JP1/AOサーバのホスト名または，IPアドレスを指定します。IPv6には対応していません。

入力

無効

△　

JP1/IM-SSのJP1/AOとの連携機能の関連情報

jp1imss.relatedPortNumber

JP1/AOサーバのコマンドを実行するhttpポート

登録した案件の関連情報からJP1/IM-SSのJP1/AOとの連携機能を用いて，JP1/AOのサービス実行画面を呼び出す時に指定します。JP1/AOサーバのコマンドを実行するhttpポートを指定します。

入力

無効

△　

JP1/IM-SSのJP1/AOとの連携機能の関連情報

jp1imss.relatedProtocol

JP1/AOサーバのプロトコル

登録した案件の関連情報からJP1/IM-SSのJP1/AOとの連携機能を用いて，JP1/AOのサービス実行画面を呼び出す時に指定します。プロトコルとして通常は「http」を指定します。

入力

無効

△　

JP1/IM-SSのJP1/AOとの連携機能の関連情報

jp1imss.relatedResourceGroupNumber

呼び出すサービスのサービスグループ名に割り当てる拡張テキストデータ番号

登録した案件の関連情報からJP1/IM-SSのJP1/AOとの連携機能を用いて，JP1/AOのサービス実行画面を呼び出す時に，拡張テキストデータ番号を指定します。拡張テキストデータ番号は，呼び出すサービスのサービスグループ名に割り当てる項目としてJP1/IM-SSのシステムプロパティファイル(hptl_jp1_imss_main_setting.properties)に指定しておきます。

入力

無効

△　

JP1/IM-SSのJP1/AOとの連携機能の関連情報

jp1imss.relatedServiceNumber

呼び出すサービス名に割り当てる拡張テキストデータ番号

登録した案件の関連情報からJP1/IM-SSのJP1/AOとの連携機能を用いて，JP1/AOのサービス実行画面を呼び出す時に，拡張テキストデータ番号を指定します。拡張テキストデータ番号は，呼び出すサービスのサービス名に割り当てる項目としてJP1/IM-SSのシステムプロパティファイル(hptl_jp1_imss_main_setting.properties)に指定しておきます。

入力

無効

△　

JP1/IM-SSのJP1/AOとの連携機能の関連情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1imss.titleName

タイトル

案件のタイトルを指定します。

入力

無効

○　

案件基本情報

jp1imss.severity

重大度

案件に設定する重大度を指定します。

入力

無効

△　

案件基本情報

jp1imss.summary

概要

案件の概要を指定します。

入力

無効

△　

案件基本情報

jp1imss.relatedInformationName

関連情報の表示名

登録した案件の関連情報からJP1/IM-SSのJP1/AOとの連携機能を用いて，JP1/AOのサービス実行画面を呼び出す時に指定します。案件の関連情報の表示名を指定します。

入力

無効

△　

JP1/IM-SSのJP1/AOとの連携機能の関連情報

jp1imss.relatedResourceGroupName

呼び出すサービスのサービスグループ名

登録した案件の関連情報からJP1/IM-SSのJP1/AOとの連携機能を用いて，JP1/AOのサービス実行画面を呼び出す時に指定します。呼び出すサービスのサービスグループ名を指定します。

入力

無効

△　

JP1/IM-SSのJP1/AOとの連携機能の関連情報

jp1imss.relatedServiceName

呼び出すサービス名

登録した案件の関連情報からJP1/IM-SSのJP1/AOとの連携機能を用いて，JP1/AOのサービス実行画面を呼び出す時に指定します。呼び出すサービス名を指定します。

入力

無効

△　

JP1/IM-SSのJP1/AOとの連携機能の関連情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1imss.imssServerName

255文字以内の半角英数字および「.」，「-」。

jp1imss.processWorkBoardID

64文字以内の半角英数字。

jp1imss.entryUserID

64文字以内の半角英数字。

jp1imss.ownerUserType

次の値のどれかを選択する。

USER,ROLE

jp1imss.ownerUserID

64文字以内の半角英数字と下線。

jp1imss.codeMappingFile

4文字以上255文字以内の文字列。ただし「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「`」，および末尾の「¥」を除く。

jp1imss.relatedIP

255 文字以内の半角英数字および「.」，「-」。

jp1imss.relatedPortNumber

1-65535の整数値。

jp1imss.relatedProtocol

5文字以内の半角英字。

jp1imss.relatedResourceGroupNumber

1-20の整数値。

jp1imss.relatedServiceNumber

1-20の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1imss.titleName

512文字以内の任意の文字。ただし「"」，「$」，「&」，「;」，「<」，「>」，「`」，「{」，「|」，「}」，および先頭の「//」，「-」を除く。

jp1imss.severity

255文字以内の半角英数字と全角文字。

jp1imss.summary

1024文字以内の任意の文字。ただし「"」，「$」，「&」，「;」，「<」，「>」，「`」，「{」，「|」，「}」，および先頭の「//」，「-」を除く。

jp1imss.relatedInformationName

255文字以内の任意の文字。ただし「"」，「$」，「&」，「;」，「<」，「>」，「`」，「{」，「|」，「}」，および先頭の「//」，「-」を除く。

jp1imss.relatedResourceGroupName

63文字以内の半角英数字および「_」と空白。

jp1imss.relatedServiceName

64文字以内の任意の文字。ただし「"」，「$」，「&」，「;」，「<」，「>」，「`」，「{」，「|」，「}」，および先頭の「//」，「-」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

JP1/IM-SS案件登録

JP1/IM-SS案件登録

JP1/IM-SSの案件登録

JP1/IM-SSサーバに案件を登録します。

エラー原因を取り除いたあと，サービスを再実行してください。

2.5.15　JP1/PFM - RMの監視対象一覧取得

機能

このサービステンプレートは，JP1/PFM - RM for Platformの監視対象一覧を取得します。

JP1/PFM - RM for Platformの監視対象を確認します。

このサービステンプレートが前提とするサーバを次に示します。

・PFM-RMサーバ

　JP1/PFM - RM for Platformがインストールされているサーバです。

次の作業を実施します。

(1)PFM-RMサーバ上のJP1/PFM - RM for Platformがインスタンス内で監視する監視対象サーバの一覧を指定されたファイルにテキスト形式で出力します。ファイルの出力フォーマットは，JP1/PFMのjpcconf target listコマンドの出力結果と同じ形式です。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)JP1/PFM - Remote Monitor for Platform 09-10以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【サービステンプレート実行システム内前提製品の使用条件】

(1)JP1/PFMでプロダクト名表示機能が有効になっていること。

(2)JP1/PFMのjpcconfコマンドの使用条件を満たしていること。

注意事項

(1)このサービスは，同一サーバに対して複数同時に実行できません。

(2)このサービスでは，PFM-RMサーバ上でjpcconfコマンドを実行します。そのため，サービス実行中にPFM-RMサーバ上でjpcconfコマンドを実行しないでください。

同様に，PFM-RMサーバ上で，jpcconfコマンドを実行中の場合は，このサービスを実行しないでください。

(3)Linux環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

(4)リモートおよびローカルに指定するファイル名が既に存在する場合，既存のファイルを上書きします。また，リモート側のファイルは削除します。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(5)リモートに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

バージョン

02.00.00

タグ

Gather JP1 information,PFM

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

監視システム環境情報

PFM-RMサーバの環境情報を指定してください。

表示されます。

監視対象取得情報

取得する監視対象サーバに関する情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1pfm.pfmRMHostName

JP1/PFM - RMのホスト名

JP1/PFM - RM for Platformがインストールされているサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

監視システム環境情報

jp1pfm.jp1pfmRMLHostName

JP1/PFM - RMの論理ホスト名

JP1/PFM - RM for Platformがクラスタ構成の場合に，JP1/PFM - RM for Platformの論理ホスト名を指定します。

入力

無効

△　

監視システム環境情報

jp1pfm.reportOutputFileNameRemote

出力ファイル名(リモート)

JP1/PFM - RM for Platformの監視対象サーバの一覧をPFM-RMサーバに出力する際の一時ファイル名をフルパスで指定します。

入力

無効

○　

監視対象取得情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1pfm.instance

JP1/PFM - RMのインスタンス名

JP1/PFM - RM for Platformのインスタンス名を指定します。

入力

無効

○　

監視対象取得情報

jp1pfm.reportOutputFileNameLocal

出力ファイル名(ローカル)

JP1/PFM - RM for Platformの監視対象サーバの一覧を取得するファイル名をフルパスで指定します。

入力

無効

○　

監視対象取得情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1pfm.pfmRMHostName

255文字以内の半角英数字および「.」，「-」。

jp1pfm.jp1pfmRMLHostName

255文字以内の半角英数字および「.」，「-」。

jp1pfm.reportOutputFileNameRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」，「/」を除く。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1pfm.instance

32文字以内の半角英数字。

jp1pfm.reportOutputFileNameLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

監視対象一覧取得

監視対象一覧取得

監視対象表示(JP1/PFM - RM)

監視対象一覧を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

ファイル転送

ファイル転送

ファイル転送部品

監視対象一覧を転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

一時ファイル削除

一時ファイル削除

ファイル削除

一時ファイルを削除します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2.5.16　JP1/PFMのアラーム情報一覧取得

機能

このサービステンプレートは，JP1/PFM - Managerに定義されているJP1/PFM - RMのアラーム情報一覧を取得します。

このサービステンプレートが前提とするサーバを次に示します。

・PFM管理サーバ

　JP1/PFM - Managerがインストールされているサーバです。

次の作業を実施します。

(1)PFM管理サーバで定義されたアラームテーブルのうち，サービスキーで指定したJP1/PFM - Managerに定義されているJP1/PFM - RMのアラームテーブル名の一覧を指定されたファイルにテキスト形式で出力します。ファイルの出力フォーマットは，JP1/PFMのjpctool alarm listコマンドの出力結果と同じ形式です。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1) JP1/PFM - Manager 09-10-11以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【サービステンプレート実行システム内前提製品の使用条件】

(1) JP1/PFM - Managerが起動していること。

(2) JP1/PFMでプロダクト名表示機能が有効になっていること。

(3) JP1/PFMのjpctoolコマンドの使用条件を満たしていること。

注意事項

(1) このサービスは，同一サーバに対して複数同時に実行できません。

(2) このサービスでは，PFM管理サーバ上でjpctoolコマンドを実行します。そのため，サービス実行中にPFM管理サーバ上でjpctoolコマンドを実行しないでください。同様に，PFM管理サーバ上で，jpctoolコマンドを実行中の場合は，このサービスを実行しないでください。

(3) UNIX環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

(4) リモートおよびローカルに指定するファイル名が既に存在する場合，既存のファイルを上書きします。また，リモート側のファイルは削除します。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(5) リモートに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

バージョン

02.00.00

タグ

Gather JP1 information,PFM

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

監視システム環境情報

PFM管理サーバの環境情報を指定してください。

表示されます。

アラーム一覧取得情報

取得するアラーム一覧に関する情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1pfm.pfmHostName

PFM管理サーバのホスト名

JP1/PFM - Managerがインストールされたサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

監視システム環境情報

jp1pfm.reportOutputFileNameRemote

出力ファイル名(リモート)

アラーム情報一覧をPFM管理サーバに出力する際の一時ファイル名をフルパスで指定します。

入力

無効

○　

アラーム一覧取得情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1pfm.serviceKey

サービスキー

アラーム情報一覧を取得するサービスキーを指定します。

入力

無効

○　

アラーム一覧取得情報

jp1pfm.reportOutputFileNameLocal

出力ファイル名(ローカル)

アラーム情報一覧を取得するファイル名をフルパスで指定します。

入力

無効

○　

アラーム一覧取得情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1pfm.pfmHostName

255文字以内の半角英数字および「.」，「-」。

jp1pfm.reportOutputFileNameRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」，「/」を除く。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1pfm.serviceKey

2文字以上16文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「"」，「`」を除く。

jp1pfm.reportOutputFileNameLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

アラームテーブル一覧取得

アラームテーブル一覧取得

アラームテーブル名一覧取得(JP1/PFM - RM)

アラームテーブルの一覧を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

ファイル転送

ファイル転送

ファイル転送部品

一覧を転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

一時ファイル削除

一時ファイル削除

ファイル削除

一時ファイルを削除します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2.5.17　JP1/PFMのプロセス監視設定一覧取得

機能

このサービステンプレートは，JP1/PFM - Managerに設定しているJP1/PFM - RMのプロセス監視設定一覧を取得します。

このサービステンプレートが前提とするサーバを次に示します。

・PFM管理サーバ

　JP1/PFM - Web Consoleがインストールされているサーバです。

次の作業を実施します。

(1)PFM管理サーバから，サービスIDで指定したJP1/PFM - RMに定義されているアプリケーション定義名の一覧を指定されたファイルにテキスト形式で出力します。ファイルの出力フォーマットは，JP1/PFMのjpcprocdef listコマンドの出力結果と同じ形式です。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)JP1/PFM - Web Console 09-10-05以降

(2)JP1/PFM - Manager 09-10-11以降

(3)JP1/PFM - Remote Monitor for Platform 09-10以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【サービステンプレート実行システム内前提製品の使用条件】

(1)JP1/PFM - Managerおよび，対象とするJP1/PFM - RMが起動していること。

(2)JP1/PFMのjpcprocdefコマンドの使用条件を満たしていること。

(3)実行時にJP1/PFM - Managerに対する認証が必要です。

　 認証用のキーファイルを作成していない場合は，コマンドを実行する前に，jpcmkkeyコマンドでJP1/PFMの管理ユーザー権限のユーザーアカウント認証用のキーファイルを作成してください。

注意事項

(1)Linux環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

(2)リモートおよびローカルに指定するファイル名が既に存在する場合，既存のファイルを上書きします。また，リモート側のファイルは削除します。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(3)リモートに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

バージョン

02.00.00

タグ

Gather JP1 information,PFM

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

監視システム環境情報

PFM管理サーバの環境情報を指定してください。

表示されます。

プロセス監視設定一覧取得情報

取得するプロセス監視設定に関する情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1pfm.jp1pfmWebconHostName

JP1/PFM - Web Consoleのホスト名

JP1/PFM - Web Consoleがインストールされているサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

監視システム環境情報

jp1pfm.reportOutputFileNameRemote

出力ファイル名(リモート)

プロセス監視設定一覧をPFM管理サーバに出力する際の一時ファイル名をフルパスで指定します。

入力

無効

○　

プロセス監視設定一覧取得情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1pfm.serviceId

サービスID

プロセス監視設定一覧を取得するサービスIDを指定します。

入力

無効

○　

プロセス監視設定一覧取得情報

jp1pfm.reportOutputFileNameLocal

出力ファイル名(ローカル)

プロセス監視設定一覧を取得するファイル名をフルパスで指定します。

入力

無効

○　

プロセス監視設定一覧取得情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1pfm.jp1pfmWebconHostName

255文字以内の半角英数字および「.」，「-」。

jp1pfm.reportOutputFileNameRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」，「/」を除く。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1pfm.serviceId

258文字以内の半角英数字および「@」，「[」，「]」，「.」，「-」。

jp1pfm.reportOutputFileNameLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

プロセス監視設定一覧取得

プロセス監視設定一覧取得

プロセス監視設定一覧取得

プロセス監視設定一覧を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

ファイル転送

ファイル転送

ファイル転送部品

一覧を転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

一時ファイル削除

一時ファイル削除

ファイル削除

一時ファイルを削除します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2.5.18　JP1/VERITASのインスタントリカバリ実行

機能

このサービステンプレートは，JP1/VERITAS NetBackupサーバで仮想サーバのインスタントリカバリジョブを実行し，実行中のインスタントリカバリジョブの詳細リストを出力ファイル(ローカル)(jp1veritas.listFileLocalプロパティ)に出力します。

このサービステンプレートが前提とするサーバを次に示します。

・JP1/VERITAS NetBackupサーバ*

　JP1/VERITAS NetBackup(マスターサーバ)が動作するサーバです。

　バックアップが作成されている必要があります。

*：エージェントレス接続先

処理の概要を次に示します。

(1)JP1/VERITAS NetBackupでインスタントリカバリジョブを実行(nbrestorevm -ir_activateコマンド)します。

　インスタントリカバリで指定する仮想サーバはVMware vCenter Serverにおける仮想サーバの表示名称で指定します。

　指定した仮想サーバが，バックアップされた際に管理されているESXサーバにインスタントリカバリされます。

(2)インスタントリカバリジョブが正常に起動したことを確認(nbrestorevm -ir_listvmコマンドの出力結果に指定した仮想サーバ名のインスタントリカバリジョブが存在することを確認)し，実行中のインスタントリカバリジョブの詳細リスト(nbrestorevm -ir_listvmコマンドの出力結果)を出力ファイル(リモート)(jp1veritas.listFileRemoteプロパティ)に出力します。

(3)(2)で作成した，リモートの一時ファイルを指定されたローカルの出力ファイルに転送します。

(4)リモートの一時ファイルを削除します。

プロパティ設定の留意点を次に示します。

(1)JP1/VERITAS NetBackupのマスターサーバとメディアサーバが異なるサーバ上に存在する場合はメディアサーバのホスト名(jp1veritas.mediaServerHostプロパティ)にメディアサーバのホスト名を指定してください。

(2)インスタントリカバリを実行する際には，インスタントリカバリジョブ起動待ち合わせ間隔(jp1veritas.waitJobActIntervalプロパティ)に指定した秒数待ち合わせ，インスタンスの状態を確認する動作を，インスタントリカバリジョブ起動待ち合わせ回数(jp1veritas.waitJobActCountプロパティ)に指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

(3)スナップショット作成データストア(jp1veritas.dataStoreNameプロパティ)にはインスタントリカバリ先のESXサーバが管理するデータストアの名前を指定してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)JP1/VERITAS NetBackupサーバの前提製品

　・JP1/VERITAS NetBackup 7.6，7.7

　・JP1/VERITAS NetBackup 8.0，8.1，8.2，8.3

　・JP1/VERITAS NetBackup 9.0，9.1

【サービステンプレート実行システム内前提製品の稼働OS】

(1)JP1/VERITAS NetBackupサーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter

　・Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【サービステンプレート実行システム内前提製品の使用条件】

(1)JP1/VERITAS NetBackupサーバで仮想サーバ名(vmware.vmNameプロパティ)に指定した仮想サーバのバックアップが作成されていること。バックアップは次の条件で作成してください。

　・バックアップポリシーでPrimary VM identifierとしてVM display Nameを指定していること。

　・バックアップポリシーでバックアップホストとしてWindowsサーバを指定していること。

(2)仮想サーバに関する条件

　・同一のvCenterの管理下において，仮想サーバ名が重複しないこと。

　・同一のvCenterの管理下において，仮想サーバ名(vmware.vmNameプロパティ)に指定した仮想サーバが存在しないこと。

注意事項

(1)JP1/Automatic Operation側で実行中のタスクをキャンセル(強制終了)しても，JP1/VERITAS NetBackupのジョブはキャンセルされません。JP1/VERITAS NetBackup側で実行中のインスタントリカバリをキャンセルする際には，JP1/VERITAS NetBackup側でジョブをキャンセル(nbrestorevm -ir_deactivateコマンド)する必要があります。

(2)同一の仮想サーバ名(vmware.vmNameプロパティ)を指定してこのサービス，およびこのサービスとnbrestorevm -ir_activateコマンドは同時実行しないでください。同時実行した場合，サービスが正常終了してもインスタントリカバリジョブが正常に起動していないおそれがあるため，実行中のインスタントリカバリジョブの詳細リストで仮想サーバ名(VM Display Name)，一時データストア名(Temporary datastore name for writes)，メディアサーバ名(Media Server Name)(メディアサーバのホスト名(common.mediaServerHostプロパティ)を指定している場合だけ)がこの部品で指定した値になっていることを確認してください。

(3)リモートおよびローカルに指定するファイル名が既に存在する場合，既存のファイルを上書きします。また，リモート側のファイルは削除します。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(4)指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。使用しない場合は削除してください。

実行権限

(1)JP1/VERITAS NetBackupサーバに接続するユーザーに，次の権限が必要です。

　・Windowsの場合は，Administrator権限を持つユーザーであること。

　・UNIXの場合は，root権限を持つユーザーであること。

バージョン

02.00.00

タグ

Control JP1,VERITAS

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

インスタントリカバリ実行サーバ環境情報

JP1/VERITAS NetBackupサーバの環境情報を指定してください。

表示されます。

仮想サーバ情報

仮想サーバの情報を指定してください。

表示されます。

インスタントリカバリ情報

インスタントリカバリに必要な情報を指定してください。

表示されます。

出力ファイル格納情報

出力ファイルの格納先を指定してください。

表示されます。

実行時オプション

インスタントリカバリ実行の際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1veritas.targetHost

JP1/VERITAS NetBackupサーバのホスト名

JP1/VERITAS NetBackup マスターサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

インスタントリカバリ実行サーバ環境情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.vmName

仮想サーバ名

インスタントリカバリ対象の仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

仮想サーバ情報

jp1veritas.mediaServerHost

メディアサーバのホスト名

JP1/VERITAS NetBackUpのメディアサーバのホスト名を指定します。マスターサーバとメディアサーバが異なるサーバ上に存在する場合は指定してください。

入力

無効

△　

インスタントリカバリ情報

jp1veritas.dataStoreName

スナップショット作成データストア

仮想サーバがリストアされるまで，スナップショットの書き込みが行われるESXサーバ上の一時データストアを指定します。作成済みのデータストアを指定してください。

入力

無効

○　

インスタントリカバリ情報

jp1veritas.startVM

仮想サーバの起動要否

インスタントリカバリ後に仮想サーバを起動する場合は"true"を選択します。"false"を選択した場合は，仮想サーバを起動せずに終了します。

入力

無効

○　

インスタントリカバリ情報

jp1veritas.listFileRemote

出力ファイル(リモート)

実行中のインスタントリカバリジョブの詳細リストをJP1/VERITAS NetBackupサーバに出力する際の一時ファイル名をフルパスで指定します。

入力

無効

○　

出力ファイル格納情報

jp1veritas.listFileLocal

出力ファイル(ローカル)

実行中のインスタントリカバリジョブの詳細リストを取得するJP1/AOサーバのファイル名をフルパスで指定します。

入力

無効

○　

出力ファイル格納情報

jp1veritas.waitJobActCount

インスタントリカバリジョブ起動待ち合わせ回数

インスタントリカバリのジョブ起動を確認する回数を1〜3600で指定します。

入力

無効

○　

実行時オプション

jp1veritas.waitJobActInterval

インスタントリカバリジョブ起動待ち合わせ間隔

インスタントリカバリのジョブ起動を確認する間隔(秒)を1〜60で指定します。

入力

無効

○　

実行時オプション

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1veritas.targetHost

256文字以内の半角英数字および「.」，「-」。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.vmName

60文字以内の半角英数字および半角スペース，「+」，「-」，「_」，「(」，「)」，「.」。ただし「.」は末尾を除く。

jp1veritas.mediaServerHost

256文字以内の半角英数字および「.」，「-」。

jp1veritas.dataStoreName

42文字以内の半角英数字および半角スペース，「+」，「-」，「_」，「(」，「)」，「.」。ただし「.」は末尾を除く。

jp1veritas.startVM

次の値のどれかを選択する。

true,false

jp1veritas.listFileRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」，「/」を除く。

jp1veritas.listFileLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1veritas.waitJobActCount

1〜3600の整数値。

jp1veritas.waitJobActInterval

1〜60の整数値。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

インスタントリカバリ実行

インスタントリカバリ実行

インスタントリカバリ実行(JP1/VERITAS)

インスタントリカバリを実行します。

NetBackup Administration ConsoleでジョブのStatusを確認し，JP1/VERITAS Symantec NetBackup(TM) 状態 コードリファレンスガイドに記載されている推奨処置を実行してください。NetBackup Administration ConsoleでジョブのStatusを確認できない場合は，システム管理者に連絡してください。

2

ファイル転送

ファイル転送

ファイル転送部品

リモートの一時ファイルをローカルの指定された出力ファイルに転送します。

エラーの原因を取り除いたあと，このステップから実行してください。

3

一時ファイル削除

一時ファイル削除

ファイル削除

リモートの一時ファイルを削除します。

一時ファイルの存在を確認し，削除されていない場合は一時ファイルを削除してください。

2.5.19　JP1/VERITASのインスタントリカバリ終了

機能

このサービステンプレートは，JP1/VERITAS NetBackupサーバでインスタントリカバリ中の仮想サーバのリストアを行います。具体的には，インスタントリカバリで使用する一時データストアからリストア後に使用するデータストアへのマイグレーション，インスタントリカバリ実行時に作成されるスナップショットの削除，およびインスタントリカバリジョブの終了処理を行います。

このサービステンプレートが前提とするサーバを次に示します。

・JP1/VERITAS NetBackupサーバ*

　JP1/VERITAS NetBackup(マスターサーバ)が動作するサーバです。

　インスタントリカバリジョブが起動している必要があります。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ*

　VMware vSphere PowerCLIがインストールされているサーバです。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです。

*：エージェントレス接続先

処理の概要を次に示します。

(1)マイグレーションを実行します。

　一時データストアからリストア後に使用するデータストアへマイグレーションします。移行先のデータストアをデータストア名で指定してください。

(2)スナップショットの削除を実行します。

　インスタントリカバリ実行時に作成されるスナップショット(スナップショット名「NBU_IR_SNAPSHOT」)を削除します。

(3)インスタントリカバリジョブの終了(nbrestorevm -ir_doneコマンド)を実行します。

　インスタントリカバリジョブをインスタントリカバリIDで指定し終了します。

プロパティ設定の留意点を次に示します。

(1)インスタントリカバリID(jp1veritas.instantRecoveryIDプロパティ)に入力する値は実行中のインスタントリカバリジョブの詳細リスト(nbrestorevm -ir_listvmコマンドの出力結果)を参照して下さい。

(2)仮想サーバ名(vmware.vmNameプロパティ)に指定する仮想サーバ名はインスタントリカバリジョブの詳細リストを参照しインスタントリカバリIDと対応する値を入力してください。

(3)データストア名(vmware.dataStoreNameプロパティ)に一時データストアは指定しないでください。

(4)インスタントリカバリジョブを終了する際には，インスタントリカバリジョブ終了待ち合わせ間隔(jp1veritas.waitJobFinIntervalプロパティ)に指定した秒数待ち合わせ，インスタントリカバリジョブの終了を確認する動作を，インスタントリカバリジョブ終了待ち合わせ回数(jp1veritas.waitJobFinCountプロパティ)に指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)JP1/VERITAS NetBackupサーバの前提製品

　・JP1/VERITAS NetBackup 7.6，7.7

　・JP1/VERITAS NetBackup 8.0，8.1，8.2，8.3

　・JP1/VERITAS NetBackup 9.0，9.1

(2)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(3)仮想サーバを管理するVMware vSphere ESXi

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(4)vCenter操作サーバの前提製品

　・VMware vSphere PowerCLI 6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

ただし，vCenterサーバの前提製品，仮想サーバを管理するVMware vSphere ESXiはJP1/VERITAS NetBackupがサポートする範囲のバージョンをサポートします。

【サービステンプレート実行システム内前提製品の稼働OS】

(1)JP1/VERITAS NetBackupサーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter

　・Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(2)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(3)vCenter操作サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

【サービステンプレート実行システム内前提製品の使用条件】

(1)JP1/VERITAS NetBackupサーバでインスタントリカバリID(common.instantRecoveryIDプロパティ)で指定したインスタントリカバリジョブが起動していること。

(2)VMware vSphere ESXiがVMware vCenter Serverで管理されていること。

(3)仮想サーバに関する条件

　・同一のvCenterの管理下において，仮想サーバ名が重複しないこと。

　・仮想サーバに，VMwareToolsがインストールされていること。

　・同一のvCenterの管理下において，データストア名が重複していないこと。

　・同一の仮想サーバ上において，スナップショット名が重複しないこと。　

(4)対象となる仮想サーバの環境が，vMotionの前提条件を満たしていること。

(5)対象となる仮想サーバの環境が，Storage vMotionの前提条件を満たしていること。

注意事項

(1)JP1/Automatic Operation側で実行中のタスクをキャンセル(強制終了)しても，JP1/VERITAS NetBackupのジョブはキャンセルされません。JP1/VERITAS NetBackup側で実行中のインスタントリカバリジョブの終了をキャンセルする際には，JP1/VERITAS NetBackup側でジョブをキャンセルする必要があります。　

(2)同一の仮想サーバ名(common.vmNameプロパティ)を指定して，このサービスの同時実行はできません。同時実行した場合，マイグレーションやスナップショットの削除に失敗するおそれがあります。

(3)同一のインスタンスリカバリID(common.instantRecoveryIDプロパティ)を指定して，このサービスとnbrestorevm -ir_doneコマンドの同時実行はしないでください。同時実行した場合，インスタントリカバリジョブが終了していてもサービスが異常終了するおそれがあるため，NetBackup Administration ConsoleでインスタントリカバリジョブのStatusを確認してください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　・対象とする仮想サーバに対して「vMotionのクエリ」と「移行」「再配置」の権限を持つロール，またはシステム管理者ロール

(2)JP1/VERITAS NetBackupサーバに接続するユーザーに，次の権限が必要です。

　・Windowsの場合は，Administrator権限を持つユーザーであること。

　・UNIXの場合は，root権限を持つユーザーであること。

バージョン

02.11.00

タグ

Control JP1,VERITAS

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

インスタントリカバリ実行サーバ環境情報

JP1/VERITAS NetBackupサーバの環境情報を指定してください。

表示されます。

仮想システム環境情報

VMware vCenter Serverの情報を指定してください。

表示されます。

仮想サーバ情報

仮想サーバの情報を指定してください。

表示されます。

インスタントリカバリ情報

インスタントリカバリに必要な情報を指定してください。

表示されます。

実行時オプション

インスタントリカバリ終了の際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1veritas.targetHost

JP1/VERITAS NetBackupサーバのホスト名

JP1/VERITAS NetBackup マスターサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

インスタントリカバリ実行サーバ環境情報

vmware.powerCLIHost

vCenter操作サーバのホスト名

VMware vSphere PowerCLIがインストールされているサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

入力

無効

○　

仮想システム環境情報

vmware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

入力

無効

○　

仮想システム環境情報

vmware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

入力

無効

○　

仮想システム環境情報

vmware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

入力

無効

○　

仮想システム環境情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.vmName

仮想サーバ名

仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

仮想サーバ情報

vmware.dataStoreName

データストア名

インスタントリカバリ実行時に作成される一時データストアから移行するデータストアを指定します。作成済みのデータストアを指定してください。

入力

無効

○　

仮想サーバ情報

jp1veritas.instantRecoveryID

インスタントリカバリID

終了させるインスタントリカバリジョブのIDを指定します。

入力

無効

○　

インスタントリカバリ情報

jp1veritas.waitJobFinCount

インスタントリカバリジョブ終了待ち合わせ回数

インスタントリカバリジョブの終了を確認する回数を1〜3600で指定します。

入力

無効

○　

実行時オプション

jp1veritas.waitJobFinInterval

インスタントリカバリジョブ終了待ち合わせ間隔

インスタントリカバリジョブの終了を確認する間隔(秒)を1〜60で指定します。

入力

無効

○　

実行時オプション

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1veritas.targetHost

256文字以内の半角英数字および「.」，「-」。

vmware.powerCLIHost

256文字以内の半角英数字および「.」，「-」。

vmware.vCenterServerName

256文字以内の半角英数字および「.」，「-」。

vmware.userName

512文字以内の半角英数字および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「%」を除く。

vmware.password

127文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.portNumber

1〜65535の整数値。

vmware.protocol

次の値のどれかを選択する。

http,https

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.vmName

60文字以内の半角英数字および半角スペース，「+」，「-」，「_」，「(」，「)」，「.」。ただし「.」は末尾を除く。

vmware.dataStoreName

42文字以内の半角英数記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

jp1veritas.instantRecoveryID

1〜2147483647の整数値。

jp1veritas.waitJobFinCount

1〜3600の整数値。

jp1veritas.waitJobFinInterval

1〜60の整数値。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバのマイグレーション

仮想サーバのマイグレーション

仮想サーバのマイグレーション

インスタントリカバリで使用する一時データストアからリストア後に使用するデータストアへデータを移行します。

タスクログを確認し，エラーの原因を取り除いたあと，このサービスを再実行してください。

2

仮想サーバのスナップショット削除

仮想サーバのスナップショット削除

仮想サーバのスナップショット削除

インスタントリカバリ時に作成したスナップショットを削除します。

仮想サーバのスナップショット(スナップショット名「NBU_IR_SNAPSHOT」)を削除したあと，次のステップから実行してください。

3

インスタントリカバリ終了

インスタントリカバリ終了

インスタントリカバリ終了(JP1/VERITAS)

インスタントリカバリジョブを終了させます。

NetBackup Administration ConsoleでジョブのStatusを確認し，JP1/VERITAS Symantec NetBackup(TM) 状態 コードリファレンスガイドに記載されている推奨処置を実行してください。NetBackup Administration ConsoleでジョブのStatusを確認できない場合は，システム管理者に連絡してください。

2.5.20　JP1/VERITASのバックアップ実行

機能

このサービステンプレートは，JP1/VERITAS NetBackupでバックアップを実行します。

このサービステンプレートが前提とするサーバを次に示します。

・バックアップ実行サーバ

　JP1/VERITAS NetBackup(マスターサーバ)が動作するサーバです。

　実行対象のバックアップポリシーが作成されている必要があります。

次の作業を実施します。

(1)JP1/VERITAS NetBackupでバックアップを実行し，バックアップの実行終了後にタスクが終了します。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1) JP1/VERITAS NetBackupが稼働していること。

　・JP1/VERITAS NetBackup 7.0，7.1，7.5，7.6，7.7

　・JP1/VERITAS NetBackup 8.0，8.1，8.2，8.3

　・JP1/VERITAS NetBackup 9.0，9.1

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【サービステンプレート実行システム内前提製品の使用条件】

(1) 実行対象のバックアップポリシーが設定されていること。

(2) JP1/VERITAS NetBackupでバックアップポリシーを定義する際に次のように設定してください。

　・スケジュールのStart Windowを設定しないでください。

　　スケジュール実行はJP1/Automatic Operationで設定してください。

　・"Bare Metal Restore"のチェックを外してください。JP1/VERITAS NetBackup 7.0，7.1の場合，この機能をサポートしておりません。

　　JP1/VERITAS NetBackup 7.0では，デフォルトでチェックが付いているため，サービス実行前に必ず確認してください。

その他のJP1/VERITAS NetBackupの未サポート機能については，JP1/VERITAS NetBackupのソフトウェア添付資料の未サポート機能に記載があります。

これらの機能も設定しないでください。

注意事項

(1) 実行中のバックアップをキャンセルする際には，JP1/VERITAS NetBackup側でジョブをキャンセルする必要があります。

　JP1/Automatic Operation側で実行中のタスクをキャンセル(強制終了)しても，JP1/VERITAS NetBackupのジョブはキャンセルされません。

(2) 次の機能を使用した場合に，タスクの実行に失敗しますので，使用しないでください。

　・1バックアップポリシーに複数クライアントを定義したバックアップ

　・Disk Stagingを使った場合の二次バックアップ

(3) 次の機能を使用した場合に，JP1/VERITAS NetBackupのジョブが複数実行されます。すべてのジョブが正常の場合だけタスクが正常終了となり，それ以外は，異常終了となります。

　・マルチデータストリームを使ったバックアップ

　・マルチコピーを使ったバックアップ

　・カタログバックアップ

実行権限

Windowsの場合：Administrator権限

UNIXの場合：root権限

バージョン

02.00.00

タグ

Control JP1,VERITAS

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

バックアップ実行サーバ環境情報

JP1/VERITAS NetBackupサーバの環境情報を指定してください。

表示されます。

バックアップ情報

バックアップするポリシー情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1veritas.targetHost

バックアップ実行サーバのホスト名

JP1/VERITAS NetBackup マスターサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

バックアップ実行サーバ環境情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1veritas.jp1nbuPolicyName

バックアップポリシー名

JP1/VERITAS NetBackupに登録されているバックアップポリシー名を指定します。

入力

無効

○　

バックアップ情報

jp1veritas.jp1nbuScheduleName

スケジュール名

指定したバックアップポリシー内で定義されているスケジュール名を指定します。

入力

無効

○　

バックアップ情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1veritas.targetHost

256文字以内の半角英数字および「.」，「-」。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1veritas.jp1nbuPolicyName

127文字以内の半角英数字および「.」，「-」，「+」，「_」。ただし，先頭および末尾の「.」，「-」を除く。

jp1veritas.jp1nbuScheduleName

127文字以内の半角英数字および「.」，「-」，「+」，「_」。ただし，先頭および末尾の「.」，「-」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

バックアップ実行

バックアップ実行

バックアップ実行(JP1/VERITAS)

バックアップを実行します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2.5.21　JP1/VERITASの仮想マシンリストア実行

機能

このサービステンプレートは，JP1/VERITAS NetBackupと連携し，vSphere環境の仮想マシンのリストアを実行します。

このサービステンプレートが前提とするサーバを次に示します。

・バックアップ実行サーバ

　JP1/VERITAS NetBackup(マスターサーバ)が動作するサーバです。本製品によってこのサーバに部品が転送され，実行されます。

・ESXサーバ

　リストア対象の仮想マシンが稼働する，VMware vSphere ESXiが動作するサーバです。

処理の概要を次に示します。

(1)リストア先の情報を定義した名前変更ファイルを，バックアップ実行サーバに出力します。

(2)仮想マシンを指定したvSphere環境へリストアします。

(3)名前変更ファイルを削除します。

仮想マシンをバックアップ元とは異なるESXサーバにリストアする場合や，仮想マシンの表示名やデータストアといった設定を変更する場合には名前変更ファイルを作成します。

このサービステンプレートは，バックアップ実行サーバのjp1veritas.renameFilePathプロパティで指定されたパスに，以下の内容の名前変更ファイルを出力します。

[change vmname to 仮想マシン表示名(jp1veritas.newDisplayNameプロパティ)]

[change esxhost to リストア先ESXサーバ(jp1veritas.newEsxHostプロパティ)]

[change datacenter to リストア先データセンタ(jp1veritas.newDatacenterプロパティ)]

[change folder to リストア先フォルダ(jp1veritas.newFolderプロパティ)]

[change resourcepool to リストア先リソースプール(jp1veritas.newResourcePoolプロパティ)]

[change datastore to リストア先データストアjp1veritas.newVmxDatastoreプロパティ)]

[change 変更前vmdkファイルのパス1(jp1veritas.originalVmdkPath1プロパティ) to リストア先vmdkファイルのパス1(jp1veritas.newVmdkPath1プロパティ)]

[change 変更前vmdkファイルのパス2(jp1veritas.originalVmdkPath2プロパティ) to リストア先vmdkファイルのパス2(jp1veritas.newVmdkPath2プロパティ)]

[change 変更前vmdkファイルのパス3(jp1veritas.originalVmdkPath3プロパティ) to リストア先vmdkファイルのパス3(jp1veritas.newVmdkPath3プロパティ)]

[change 変更前vmdkファイルのパス4(jp1veritas.originalVmdkPath4プロパティ) to リストア先vmdkファイルのパス4(jp1veritas.newVmdkPath4プロパティ)]

[change 変更前vmdkファイルのパス5(jp1veritas.originalVmdkPath5プロパティ) to リストア先vmdkファイルのパス5(jp1veritas.newVmdkPath5プロパティ)]

[change 変更前vmdkファイルのパス6(jp1veritas.originalVmdkPath6プロパティ) to リストア先vmdkファイルのパス6(jp1veritas.newVmdkPath6プロパティ)]

[change 変更前vmdkファイルのパス7(jp1veritas.originalVmdkPath7プロパティ) to リストア先vmdkファイルのパス7(jp1veritas.newVmdkPath7プロパティ)]

[change 変更前vmdkファイルのパス8(jp1veritas.originalVmdkPath8プロパティ) to リストア先vmdkファイルのパス8(jp1veritas.newVmdkPath8プロパティ)]

[change 変更前vmdkファイルのパス9(jp1veritas.originalVmdkPath9プロパティ) to リストア先vmdkファイルのパス9(jp1veritas.newVmdkPath9プロパティ)]

[change 変更前vmdkファイルのパス10(jp1veritas.originalVmdkPath10プロパティ) to リストア先vmdkファイルのパス10(jp1veritas.newVmdkPath10プロパティ)]

[change network ネットワーク名(jp1veritas.newNetworkプロパティ)]

名前変更ファイルの詳細については，JP1/VERITAS NetBackupマニュアルのnbrestorevmコマンドを参照してください。

前提条件

【システム内前提製品】/【サービステンプレート実行対象サーバ内前提製品】/【サービステンプレート実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行対象サーバ内前提製品】

　・JP1/VERITAS NetBackup 7.6，7.7

　・JP1/VERITAS NetBackup 8.0，8.1，8.2，8.3

　・JP1/VERITAS NetBackup 9.0，9.1

【サービステンプレート実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

【サービステンプレート実行対象システム内前提製品の使用条件】

　特になし。

注意事項

(1)名前変更ファイルのパス(JP1VERITAS.renameFilePathプロパティ)に指定したファイルが既に存在する場合，既存のファイルを上書きします。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(2)作成するファイルのパスに含まれるフォルダが存在しない場合は，そのフォルダを作成します。

実行権限

Administratorsグループに属するユーザーであること。

バージョン

03.00.00

タグ

Control JP1,VERITAS

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

JP1/VERITAS NetBackup構成情報

JP1/VERITAS NetBackupの構成情報を設定してください。

表示されます。

リストア対象仮想マシン情報

リストア対象となる仮想マシンの情報を設定してください。

表示されます。

名前変更ファイル情報

名前変更ファイルに出力する情報を設定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1veritas.targetHost

バックアップ実行サーバのホスト名

JP1/VERITAS NetBackup マスターサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

JP1/VERITAS NetBackup構成情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1veritas.restoreVmName

リストア対象仮想マシン名

リストア対象の仮想マシン名を指定します。バックアップポリシーの「プライマリVM識別子(Primary VM identifier)」で選択された名前の種類と一致する必要があります。

入力

無効

○　

リストア対象仮想マシン情報

jp1veritas.restorevCenterServer

リストア対象のvCenterサーバ名

リストア対象のvCenterサーバ名を指定します。バックアップ元と異なるvCenterサーバにリストアする場合は指定してください。

入力

無効

△　

リストア対象仮想マシン情報

jp1veritas.recoveryHost

バックアップサーバ名

リストアを実行するバックアップサーバー名を指定します。バックアップ実行時と異なるバックアップサーバーを使用する場合は指定してください。

入力

無効

△　

リストア対象仮想マシン情報

jp1veritas.renameFilePath

名前変更ファイルのパス

名前変更ファイルのパスを絶対パスで指定します。仮想マシンを元の設定で元の場所へリストアする場合，本プロパティを指定する必要はありません。

入力

無効

△　

名前変更ファイル情報

jp1veritas.newDisplayName

仮想マシン表示名

リストアする仮想マシンの表示名を指定します。省略した場合は元の表示名が使用されます。

入力

無効

△　

名前変更ファイル情報

jp1veritas.newEsxHost

リストア先ESXサーバ

リストア先のESXサーバを指定します。バックアップ元と異なるESXサーバにリストアする場合は指定してください。

入力

無効

△　

名前変更ファイル情報

jp1veritas.newDatacenter

リストア先データセンタ

リストア先のデータセンタを指定します。次の形式で指定してください「/データセンタ名」。リストア先にデータセンタが無い場合はNoneを指定してください。

入力

無効

△　

名前変更ファイル情報

jp1veritas.newFolder

リストア先フォルダ

リストア先のフォルダを指定します。次の形式で指定してください「/データセンタ名/フォルダ名」。リストア先にフォルダが無い場合はNoneを指定してください。

入力

無効

△　

名前変更ファイル情報

jp1veritas.newResourcePool

リストア先リソースプール

リストア先のリソースプールを指定します。次の形式で指定してください「/データセンタ名/host/ESXサーバ名/resources/リソースプール名」

入力

無効

△　

名前変更ファイル情報

jp1veritas.newVmxDatastore

リストア先データストア

リストア先のデータストアを指定します。

入力

無効

△　

名前変更ファイル情報

jp1veritas.originalVmdkPath1

変更前vmdkファイルのパス1

vmdkファイルの変更前のパスを指定します。異なるデータストアへリストアする場合は指定してください。

入力

無効

△　

名前変更ファイル情報

jp1veritas.newVmdkPath1

リストア先vmdkファイルのパス1

リストア先のvmdkファイルのパスを指定します。異なるデータストアへリストアする場合は指定してください。

入力

無効

△　

名前変更ファイル情報

jp1veritas.originalVmdkPath2

変更前vmdkファイルのパス2

vmdkファイルの変更前のパスを指定します。異なるデータストアへリストアする場合は指定してください。

入力

無効

△　

名前変更ファイル情報

jp1veritas.newVmdkPath2

リストア先vmdkファイルのパス2

リストア先のvmdkファイルのパスを指定します。異なるデータストアへリストアする場合は指定してください。

入力

無効

△　

名前変更ファイル情報

jp1veritas.originalVmdkPath3

変更前vmdkファイルのパス3

vmdkファイルの変更前のパスを指定します。異なるデータストアへリストアする場合は指定してください。

入力

無効

△　

名前変更ファイル情報

jp1veritas.newVmdkPath3

リストア先vmdkファイルのパス3

リストア先のvmdkファイルのパスを指定します。異なるデータストアへリストアする場合は指定してください。

入力

無効

△　

名前変更ファイル情報

jp1veritas.originalVmdkPath4

変更前vmdkファイルのパス4

vmdkファイルの変更前のパスを指定します。異なるデータストアへリストアする場合は指定してください。

入力

無効

△　

名前変更ファイル情報

jp1veritas.newVmdkPath4

リストア先vmdkファイルのパス4

リストア先のvmdkファイルのパスを指定します。異なるデータストアへリストアする場合は指定してください。

入力

無効

△　

名前変更ファイル情報

jp1veritas.originalVmdkPath5

変更前vmdkファイルのパス5

vmdkファイルの変更前のパスを指定します。異なるデータストアへリストアする場合は指定してください。

入力

無効

△　

名前変更ファイル情報

jp1veritas.newVmdkPath5

リストア先vmdkファイルのパス5

リストア先のvmdkファイルのパスを指定します。異なるデータストアへリストアする場合は指定してください。

入力

無効

△　

名前変更ファイル情報

jp1veritas.originalVmdkPath6

変更前vmdkファイルのパス6

vmdkファイルの変更前のパスを指定します。異なるデータストアへリストアする場合は指定してください。

入力

無効

△　

名前変更ファイル情報

jp1veritas.newVmdkPath6

リストア先vmdkファイルのパス6

リストア先のvmdkファイルのパスを指定します。異なるデータストアへリストアする場合は指定してください。

入力

無効

△　

名前変更ファイル情報

jp1veritas.originalVmdkPath7

変更前vmdkファイルのパス7

vmdkファイルの変更前のパスを指定します。異なるデータストアへリストアする場合は指定してください。

入力

無効

△　

名前変更ファイル情報

jp1veritas.newVmdkPath7

リストア先vmdkファイルのパス7

リストア先のvmdkファイルのパスを指定します。異なるデータストアへリストアする場合は指定してください。

入力

無効

△　

名前変更ファイル情報

jp1veritas.originalVmdkPath8

変更前vmdkファイルのパス8

vmdkファイルの変更前のパスを指定します。異なるデータストアへリストアする場合は指定してください。

入力

無効

△　

名前変更ファイル情報

jp1veritas.newVmdkPath8

リストア先vmdkファイルのパス8

リストア先のvmdkファイルのパスを指定します。異なるデータストアへリストアする場合は指定してください。

入力

無効

△　

名前変更ファイル情報

jp1veritas.originalVmdkPath9

変更前vmdkファイルのパス9

vmdkファイルの変更前のパスを指定します。異なるデータストアへリストアする場合は指定してください。

入力

無効

△　

名前変更ファイル情報

jp1veritas.newVmdkPath9

リストア先vmdkファイルのパス9

リストア先のvmdkファイルのパスを指定します。異なるデータストアへリストアする場合は指定してください。

入力

無効

△　

名前変更ファイル情報

jp1veritas.originalVmdkPath10

変更前vmdkファイルのパス10

vmdkファイルの変更前のパスを指定します。異なるデータストアへリストアする場合は指定してください。

入力

無効

△　

名前変更ファイル情報

jp1veritas.newVmdkPath10

リストア先vmdkファイルのパス10

リストア先のvmdkファイルのパスを指定します。異なるデータストアへリストアする場合は指定してください。

入力

無効

△　

名前変更ファイル情報

jp1veritas.newNetwork

ネットワーク名

リストアする仮想マシンの新しいネットワーク名を指定します。複数のネットワークを指定する場合は，コンマ(,)で区切って列挙してください。

入力

無効

△　

名前変更ファイル情報

jp1veritas.deleteRenameFile

名前変更ファイルの削除要否

実行対象サーバで処理が正常に完了したのちに，名前変更ファイルを削除する場合はtrue，しない場合はfalseを指定します。

入力

無効

○　

名前変更ファイル情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1veritas.targetHost

256文字以内の半角英数字および「.」，「-」。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1veritas.restoreVmName

60文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」を除く。

jp1veritas.restorevCenterServer

256文字以内の半角英数字および「.」，「-」。

jp1veritas.recoveryHost

256文字以内の半角英数字および「.」，「-」。

jp1veritas.renameFilePath

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1veritas.newDisplayName

60文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」を除く。

jp1veritas.newEsxHost

256文字以内の半角英数字および「.」，「-」。

jp1veritas.newDatacenter

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

jp1veritas.newFolder

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

jp1veritas.newResourcePool

1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

jp1veritas.newVmxDatastore

42文字以内の半角英数記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

jp1veritas.originalVmdkPath1

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1veritas.newVmdkPath1

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1veritas.originalVmdkPath2

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1veritas.newVmdkPath2

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1veritas.originalVmdkPath3

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1veritas.newVmdkPath3

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1veritas.originalVmdkPath4

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1veritas.newVmdkPath4

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1veritas.originalVmdkPath5

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1veritas.newVmdkPath5

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1veritas.originalVmdkPath6

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1veritas.newVmdkPath6

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1veritas.originalVmdkPath7

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1veritas.newVmdkPath7

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1veritas.originalVmdkPath8

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1veritas.newVmdkPath8

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1veritas.originalVmdkPath9

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1veritas.newVmdkPath9

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1veritas.originalVmdkPath10

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1veritas.newVmdkPath10

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1veritas.newNetwork

1000文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」を除く。

jp1veritas.deleteRenameFile

次の値のどれかを選択する。

true,false

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

名前変更ファイル作成判定

名前変更ファイル作成判定

値判定分岐部品

名前変更ファイルの出力が必要か判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

名前変更ファイルの作成

リストア先の情報を定義した名前変更ファイルを出力します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

仮想マシンリストア実行

仮想マシンリストア実行

仮想マシンリストア実行

仮想マシンのリストアを実行します。

JP1/VERITAS NetBackupのアクティビティモニタを確認し，エラーの原因を取り除いたあと，サービスを再実行してください。

4

名前変更ファイル削除判定1

名前変更ファイル削除判定1

値判定分岐部品

名前変更ファイルの削除が必要か判定します。

エラーの原因を取り除いたあと，手動で名前変更ファイルを削除してください。

5

階層フロー部品

名前変更ファイルを削除します。

−　

6

値判定分岐部品

名前変更ファイルの削除が必要か判定します。

エラーの原因を取り除いたあと，手動で名前変更ファイルを削除してください。

7

ファイル削除

名前変更ファイルを削除します。

エラーの原因を取り除いたあと，手動で名前変更ファイルを削除してください。

2.5.22　JP1イベント取得

機能

JP1/IM - Managerの統合監視DBからJP1イベントの情報を取得します。

JP1イベントを取得し，システム障害状況などの分析を行う場合に使用します。

このサービステンプレートが前提とするサーバを次に示します。

・監視サーバ

　JP1/IM - Managerが動作するサーバです。

処理の概要を次に示します。

(1)統合監視DBに登録されているJP1イベントの情報を，指定されたファイルにCSV形式で出力します。ファイルの出力フォーマットは，JP1/IMのjcoevtreportコマンドの出力結果と同じ形式です。登録時刻，到着時刻，および開始時刻と終了時刻の形式はYYYYMMDDhhmmss形式で，ヘッダーの出力形式はDISPで出力します。

(2)生成されたファイルをJP1/AOサーバに転送する場合，監視サーバからJP1/AOサーバにJP1イベントの情報を転送し，監視サーバに作成した一時フォルダを削除します。その場合は，イベント情報転送の要否(プロパティjp1im.transferJP1EventFile)をyesに設定してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1) JP1/IM - Managerが稼働していること。

　 JP1/IM - Manager 09-00以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【サービステンプレート実行システム内前提製品の使用条件】

(1) JP1/IM - Manager統合監視DBを運用していること。

(2) JP1イベントの情報をJP1/AOサーバに転送する場合，エージェントレス接続先としてJP1/AOサーバ("localhost"で解決されるループバックアドレス)および接続先となるサーバを設定する必要があります。

(3) 稼働OSがUNIXの場合は，エージェントレス接続先に定義された接続ユーザーのデフォルトロケールがJP1/IM - Managerの動作する言語コードに設定されている必要があります。

注意事項

(1) このサービスを同一の監視サーバに複数同時に実行しないでください。

(2) このサービスでは，監視サーバ上でjcoevtreportコマンドを実行します。そのため，サービス実行中に監視サーバ上でjcoevtreportコマンドを同時に実行しないでください。同様に，監視サーバ上でjcoevtreportコマンドを実行中は，このサービスを実行しないでください。

(3) JP1イベントの情報が大量に出力されると，JP1イベント取得やファイル転送によって，システムに影響を与えることがあります。出力対象始点日(プロパティjp1im.jp1imStartTime)と出力対象終点日(プロパティjp1im.jp1imEndTime)の間隔やフィルターファイル内のイベント条件などの設定を調整して，JP1イベントの情報の出力量を抑えてください。

(4) このサービスを実行しJP1イベントの情報が保管されている状態の監視サーバに対して，再度サービスを実行する場合は出力フォルダ名(リモート)(プロパティjp1im.jp1imOutputFolderPathRemote)の値を変更して実行してください。同じ値の場合，保管されていたJP1イベントの情報も同時に転送されます。

(5) UNIX環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

(6) マルチバイト文字を指定する場合は，出力フォルダ(リモート)のパスの長さは226バイト以内となるよう指定してください。

(7) ローカルに指定するフォルダ名が既に存在する場合，ローカルのフォルダを上書きします。また，フォルダの下に同名のファイルが存在する場合も上書きします。そのため，指定したフォルダ名に誤りがないか，十分に確認してください。

(8) リモートに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

バージョン

03.00.00

タグ

Gather JP1 information,IM

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

監視システム環境情報

監視サーバの環境情報を指定してください。

表示されます。

JP1イベント取得情報

取得するJP1イベントの情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1im.jp1imHostName

JP1/IMのホスト名

JP1/IMがインストールされているホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

監視システム環境情報

jp1im.jp1imLHostName

JP1/IMの論理ホスト名

JP1/IMがクラスタ構成の場合，JP1/IMの論理ホスト名を指定します。

入力

無効

△　

監視システム環境情報

jp1im.jp1imFilterFileName

フィルターファイル名(ローカル)

JP1/AOサーバにあるイベントレポート出力のフィルターファイル名をフルパスで指定します。

入力

無効

△　

JP1イベント取得情報

jp1im.jp1imOutputFolderPathRemote

出力フォルダ名(リモート)

JP1イベントの情報を取得するフォルダ名をフルパスで指定します。指定されたフォルダの下にjp1imtempフォルダを作成し，JP1イベントの情報を格納します。

入力

無効

○　

JP1イベント取得情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1im.transferJP1EventFile

イベント情報転送の要否

JP1イベントの情報をJP1/AOサーバに転送するかどうかを指定します。転送する場合だけ，出力フォルダ名(リモート)に作成したjp1imtempフォルダを削除します。

入力

無効

○　

JP1イベント取得情報

jp1im.jp1imOutputFolderPathLocal

出力フォルダ名(ローカル)

JP1イベントの情報を取得するJP1/AOサーバのフォルダ名をフルパスで指定します。JP1イベントの情報をJP1/AOサーバに転送する場合は必ず指定してください。

入力

無効

△　

JP1イベント取得情報

jp1im.jp1imStartTime

出力対象始点日

出力するイベントの始点日を指定します。時刻は，00:00:00になります。

入力

無効

○　

JP1イベント取得情報

jp1im.jp1imEndTime

出力対象終点日

出力するイベントの終点日を指定します。時刻は，00:00:00になります。

入力

無効

○　

JP1イベント取得情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1im.jp1imHostName

255文字以内の半角英数字および「.」，「-」。

jp1im.jp1imLHostName

255文字以内の半角英数字および「.」，「-」。

jp1im.jp1imFilterFileName

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1im.jp1imOutputFolderPathRemote

226文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」，「/」を除く。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1im.transferJP1EventFile

次の値のどれかを選択する。

yes,no

jp1im.jp1imOutputFolderPathLocal

239文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1im.jp1imStartTime

0

jp1im.jp1imEndTime

0

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

JP1イベント取得

JP1イベント取得

階層フロー部品

JP1イベントの情報を取得します。

−　

1-3

階層フロー部品

JP1イベントの情報を取得します。

−　

1-3-1

階層フロー部品

OS種別を判定します。

−　

1-3-1-1

OS種別の出力

OSの情報を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-3-2

値判定分岐部品

OSがWindowsかどうかチェックします。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-3-3

階層フロー部品

OSがWindowsの場合にJP1イベントの情報を取得します。

−　

1-3-3-1

フォルダ作成

フォルダを作成します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-3-3-2

値判定分岐部品

フィルターファイルが指定されているかチェックします。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-3-3-3

階層フロー部品

フィルターファイルが指定してある場合にJP1イベントの情報を取得します。

−　

1-3-3-3-1

ファイル転送部品

フィルターファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-3-3-3-2

JP1イベント取得

JP1イベントの情報を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-3-3-3-3

ファイル削除

フィルターファイルを削除します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-3-3-4

値判定分岐部品

フィルターファイルが指定されていないかチェックします。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-3-3-5

階層フロー部品

フィルターファイルが指定していない場合にJP1イベントの情報を取得します。

−　

1-3-3-5-1

JP1イベント取得

JP1イベントの情報を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-3-4

値判定分岐部品

OSがUNIXか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-3-5

階層フロー部品

OSがUNIXの場合にJP1イベントの情報を取得します。

−　

1-3-5-1

フォルダ作成

フォルダを作成します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-3-5-2

値判定分岐部品

フィルターファイルが指定されているかチェックします。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-3-5-3

階層フロー部品

フィルターファイルが指定されている場合にJP1イベントの情報を取得します。

−　

1-3-5-3-1

ファイル転送部品

フィルターファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-3-5-3-2

JP1イベント取得

JP1イベントの情報を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-3-5-3-3

ファイル削除

フィルターファイルを削除します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-3-5-4

値判定分岐部品

フィルターファイルが指定されていないかチェックします。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-3-5-5

階層フロー部品

フィルターファイルが指定されていない場合にJP1イベントの情報を取得します。

−　

1-3-5-5-1

JP1イベント取得

JP1イベントの情報を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

ファイル転送

ファイル転送

階層フロー部品

JP1イベントの情報を転送します。

−　

2-3

値判定分岐部品

ファイル転送にyesが指定されているかチェックします。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4

階層フロー部品

JP1イベントの情報を転送します。

−　

2-4-1

値判定分岐部品

OSがWindowsかどうかチェックします。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4-2

階層フロー部品

OSがWindowsの場合にJP1イベント情報を転送します。

−　

2-4-2-1

ファイル転送部品

JP1イベント情報を転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4-2-2

フォルダ削除

一時フォルダを削除します。

対象サーバにファイルが残っています。手動で削除してください。

2-4-3

値判定分岐部品

OSがUNIXかどうかチェックします。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4-4

階層フロー部品

OSがUNIXの場合にJP1イベント情報を転送します。

−　

2-4-4-1

ファイル転送部品

JP1イベント情報を転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4-4-2

フォルダ削除

一時ディレクトリを削除します。

対象サーバにファイルが残っています。手動で削除してください。

2.5.23　JP1ユーザーの一覧取得

機能

このサービステンプレートは，JP1/Baseの認証サーバに登録されているJP1ユーザー一覧を取得します。

次の作業を実施します。

(1)設定されているJP1/Base認証サーバから指定されたファイルにJP1ユーザー一覧をテキスト形式で出力します。ファイルの出力形式は，JP1/Baseのjbslistuserコマンドの出力結果と同じ形式です。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1) JP1/Baseが稼働していること。

　JP1/Base 09-00以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【サービステンプレート実行システム内前提製品の使用条件】

(1) 認証サーバの設定がされていること。

(2) JP1/Baseのjbslistuserコマンドの使用条件を満たしていること。

注意事項

(1) UNIX環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

(2) リモートおよびローカルに指定するファイル名が既に存在する場合，既存のファイルを上書きします。また，リモート側のファイルは削除します。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(3) リモートに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

バージョン

02.00.00

タグ

Gather JP1 information,Base

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

監視システム環境情報

JP1/Baseの環境情報を指定してください。

表示されます。

JP1ユーザー取得情報

取得するJP1ユーザーに関する情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1base.listJP1UserOutputFileNameRemote

JP1ユーザー一覧出力ファイル名(リモート)

認証サーバとして動作しているJP1/Baseのホスト上にJP1ユーザー一覧を出力するファイル名をフルパスで指定します。

入力

無効

○　

JP1ユーザー取得情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1base.jp1BaseHostName

JP1/Baseのホスト名

JP1/Baseがインストールされているサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

監視システム環境情報

jp1base.jp1BaseLHostName

JP1/Baseの論理ホスト名

エージェントサーバのJP1/Baseがクラスタ構成の場合，JP1/Baseの論理ホスト名を指定します。

入力

無効

△　

監視システム環境情報

jp1base.listJP1UserOutputFileNameLocal

JP1ユーザー一覧出力ファイル名(ローカル)

JP1ユーザー一覧を取得するJP1/AOサーバのファイル名をフルパスで指定します。

入力

無効

○　

JP1ユーザー取得情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1base.listJP1UserOutputFileNameRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」，「/」を除く。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1base.jp1BaseHostName

255文字以内の半角英数字および「.」，「-」。

jp1base.jp1BaseLHostName

255文字以内の半角英数字および「.」，「-」。

jp1base.listJP1UserOutputFileNameLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

JP1ユーザー一覧取得

JP1ユーザー一覧取得

JP1ユーザー一覧取得

JP1ユーザー一覧を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

ファイル転送

ファイル転送

ファイル転送部品

JP1ユーザーの一覧を転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

一時ファイル削除

一時ファイル削除

ファイル削除

一時ファイルを削除します。

対象サーバにファイルが残っています。手動で削除してください。

2.5.24　JP1ユーザーマッピング定義取得

機能

このサービステンプレートは，JP1/BaseのJP1ユーザーとOSマッピング情報をユーザーマッピング定義ファイル(jp1BsUmap.conf)の形式で取得します。

次の作業を実施します。

(1)指定されたファイルにJP1ユーザーとOSマッピング情報をテキスト形式(ユーザーマッピング定義ファイル(jp1BsUmap.conf)と同じ形式)で出力します。ファイルの出力形式は，JP1/Baseのjbsgetumapコマンドの出力結果と同じ形式です。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1) JP1/Baseが稼働していること。

　JP1/Base 09-00以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【サービステンプレート実行システム内前提製品の使用条件】

(1) 認証サーバの設定がされていること。

(2) JP1/Baseのjbsgetumapコマンドの使用条件を満たしていること。

注意事項

(1) UNIX環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

(2) リモートおよびローカルに指定するファイル名が既に存在する場合，既存のファイルを上書きします。また，リモート側のファイルは削除します。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(3) リモートに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

バージョン

02.00.00

タグ

Gather JP1 information,Base

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

監視システム環境情報

JP1/Baseの環境情報を指定してください。

表示されます。

JP1ユーザーマッピング取得情報

取得するJP1ユーザーマッピングに関する情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1base.listJP1UserMappingOutputFileNameRemote

JP1ユーザーマッピング定義出力ファイル名(リモート)

JP1/Baseのホスト上にJP1ユーザーマッピング定義を出力するファイル名をフルパスで指定します。

入力

無効

○　

JP1ユーザーマッピング取得情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1base.jp1BaseHostName

JP1/Baseのホスト名

JP1/Baseがインストールされているサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

監視システム環境情報

jp1base.jp1BaseLHostName

JP1/Baseの論理ホスト名

エージェントサーバのJP1/Baseがクラスタ構成の場合，JP1/Baseの論理ホスト名を指定します。

入力

無効

△　

監視システム環境情報

jp1base.listJP1UserMappingOutputFileNameLocal

JP1ユーザーマッピング定義出力ファイル名(ローカル)

JP1ユーザーマッピング定義を取得するJP1/AOサーバのファイル名をフルパスで指定します。

入力

無効

○　

JP1ユーザーマッピング取得情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1base.listJP1UserMappingOutputFileNameRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」，「/」を除く。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1base.jp1BaseHostName

255文字以内の半角英数字および「.」，「-」。

jp1base.jp1BaseLHostName

255文字以内の半角英数字および「.」，「-」。

jp1base.listJP1UserMappingOutputFileNameLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

JP1ユーザーとOSユーザーマッピング定義取得

JP1ユーザーとOSユーザーマッピング定義取得

マッピング情報の確認

JP1ユーザーとOSユーザーマッピング定義を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

ファイル転送

ファイル転送

ファイル転送部品

JP1ユーザーマッピング定義を転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

一時ファイル削除

一時ファイル削除

ファイル削除

一時ファイルを削除します。

対象サーバにファイルが残っています。手動で削除してください。

2.5.25　運用ユーザー一括変更

機能

このサービステンプレートは，CSV(Comma Separated Values)ファイルまたはMicrosoft Excelによって作成されたユーザーの一覧情報(これ以降，ユーザー情報ファイルと呼びます)を使用して，JP1ユーザーのパスワード変更，OSユーザーのパスワード変更，それに伴うWindows版JP1/Baseのパスワード管理情報に登録された内容の変更を一括で行います。なお，CentOS環境では，OSユーザーのパスワード変更処理だけ実行できます。

JP1/AOサーバがWindows環境の場合はCSVファイルまたはExcelファイル，UNIX環境の場合はCSVファイルを使用します。

次のような構成のシステムを管理する場合に有効です。

・JP1/AJS3によるジョブ実行環境で，複数のエージェントサーバでジョブを実行している。

・JP1/IMによる監視環境で，複数のエージェントサーバに対して自動アクションやコマンド実行を行う。

・JP1/Baseで認証を行うシステムで，多数のJP1ユーザーやOSユーザーを管理している。

このサービステンプレートが前提とするサーバを次に示します。

・JP1認証サーバ

　JP1/Baseの認証サーバが動作するサーバです。JP1ユーザー情報の管理を行います。

・エージェントサーバ

　JP1/Baseが導入され，ジョブの実行や自動アクションが行われるサーバです。

上記システムでの運用ユーザー情報の更新のため，次の処理を実行します。

【OSユーザーのパスワード変更処理】

　OSユーザー情報ファイルからキー値を記載した列を取り出し，すべてのキー値に対して次の処理を実行します。

　(1) キー値に合致する行の，エージェントサーバのホスト名，エージェントサーバの論理ホスト名，OSユーザー名，OSユーザーの新パスワードを読み取ります。

　(2) 処理(1)で読み取った情報を使用して，エージェントサーバのOSユーザーのパスワードを変更します。

　(3) 処理(1)で読み取った情報を使用して，必要に応じてエージェントサーバのJP1/Baseに登録されているパスワード管理情報を更新します。

【JP1ユーザーのパスワード変更処理】

　JP1ユーザー情報ファイルからキー値を記載した列を取り出し，すべてのキー値に対して次の処理を実行します。

　(1) キー値に合致する行の，JP1認証サーバのホスト名，JP1認証サーバの論理ホスト名，JP1ユーザー名，JP1ユーザーの旧パスワード，JP1ユーザーの新パスワードを読み取ります。

　(2) 処理(1)で読み取った情報を使用して，認証サーバのJP1ユーザーのパスワードを変更します。

サービス実行時にOS.osUserInfoFilePath(OSユーザー情報ファイルのパス)を指定した場合，OSユーザーのパスワード変更を実行します。jp1base.jp1UserInfoFilePath(JP1ユーザー情報ファイルのパス)を指定した場合，JP1ユーザーのパスワード変更処理を実行します。列番号を指定するプロパティには，CSVファイルの左から数えた列の番号またはExcelファイルの左から見て最初にデータが記述されている列から数えた列の番号を1〜255の値で指定します。

それぞれのユーザー情報ファイルには，ユーザー情報を99件(99行)まで記載することができます。各変更処理は，繰り返し部品で逐次的に実行します。

それぞれのユーザー情報ファイル読み込みに失敗した場合は，OS.fileOpenRetryIntervalプロパティに指定した秒数待ってファイル読み込みをリトライする処理を，OS.fileOpenRetryCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

JP1/AOサーバ，JP1認証サーバ，エージェントサーバのどれかのOSがWindowsの場合，このサービステンプレートの実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。各サーバにadministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行うサービス「運用ユーザー一括変更(SYSTEM)」を実行してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1) JP1認証サーバ，エージェントサーバに次のJP1/Baseが稼働していること。

JP1/Base 09-00以降

(2) JP1/AOサーバがWindows環境の場合，次に示すMicrosoft社のプログラムがJP1/AOサーバにインストールされていること。

・2007 Office system ドライバ，または

　Microsoft Access データベース エンジン 2010（32bit版），または

　Microsoft Access Database Engine 2016（32bit版）

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

　ただし，OSユーザーのパスワード変更処理だけ実行可能。

(9) CentOS 7 (64-bit x86_64)

　ただし，OSユーザーのパスワード変更処理だけ実行可能。

(10) CentOS 8 (64-bit x86_64)

　ただし，OSユーザーのパスワード変更処理だけ実行可能。

(11) Oracle Linux 8 (64-bit x86_64)

(12) AIX V6

(13) AIX V7

【サービステンプレート実行システム内前提製品の使用条件】

(1) OSユーザーのパスワード変更(およびWindowsの場合はJP1/Baseのパスワード管理情報の更新)を行う場合，OS.osUserInfoFilePath，OS.osUserInfoSheetName(Excelファイルの場合だけ)，OS.osUserInfoKeyColumn，common.targetHostNameColumn，jp1base.jp1BaseLHostNameColumn，OS.osUserNameColumn，OS.osUserNewPasswordColumn，OS.osUserTypeColumn，jp1base.updatePasswordInfoColumnを必ず指定してください。

(2) JP1ユーザーのパスワード変更を行う場合，jp1base.jp1UserInfoFilePath，jp1base.jp1UserInfoSheetName(Excelファイルの場合だけ)，jp1base.jp1UserInfoKeyColumn，jp1base.certHostNameColumn，jp1base.certHostLHostNameColumn，jp1base.jp1UserNameColumn，jp1base.jp1UserOldPasswordColumn，jp1base.jp1UserNewPasswordColumnを必ず指定してください。

(3) 認証サーバのJP1/Baseがクラスタ構成で，論理ホスト環境のJP1ユーザーのパスワードを更新する場合，jp1base.certHostNameColumnで指定した列の値に，物理ホスト名または論理ホスト名を，jp1base.certHostLHostNameColumnで指定した列の値に，論理ホスト名を記入してください。物理ホスト環境のJP1ユーザーのパスワードを更新する場合は，jp1base.certHostLHostNameColumnで指定した列には空白を指定してください。

(4) エージェントサーバのJP1/Baseがクラスタ構成で，論理ホスト環境のOSユーザーのパスワード管理情報を更新する場合，実行系の環境のOSユーザー情報を記述したOSユーザー情報ファイルを使用してサービスを実行してください。実行系(JP1/Baseが動作している)のエージェントサーバの情報では，jp1base.updatePasswordInfoColumnで指定した列の値を"TRUE"にしてください。実行系の環境へ一度サービスを実行したあとに，系を切り替えたあとの実行系の環境へサービスを実行する際は，システム環境設定情報，OSユーザー情報のパラメーターに値を入力し，JP1ユーザー情報のパラメーターはすべて空欄にしてサービスを実行してください。

(5) OSユーザー変更処理を行う場合，JP1/AOサーバ上に，次に示す内容を記載したOSユーザー情報ファイルを格納していること。

・列数

　データの読み取り開始列から数えた列数が255列以内となるようにしてください。

・列名

　・CSVファイルの場合

　　・列名が必要な場合は，ファイルの1行目に記載してください。なお，列名が不要の場合は，列名の記載は必要ありません。

　　・列名の記載有無に関わらず，データの読み取り開始行は2行目からとなります。

　・Excelファイルの場合

　　・列名は必ず記載してください。1行目以降で最初に記述がある行が列名となります。

　　・データの読み取り開始行は列名が記載されている行の次の行からとなります。

　列名の指定の際は(8)を参照してください。

・キー情報

　ユーザー情報ファイルの各行でユニークなキーとなる値を格納した列です。キー情報の内容は任意ですが，1から始まる整数値など，短い値を指定することを推奨します。また，キー情報には「"」および「'」以外の文字を使用してください。(すべてのキー情報の合計バイト数＋データの行数)が1017バイト以下になるようにしてください。各行への値の指定は任意です。省略した場合，該当する行の処理は行なわれません。

・エージェントサーバのホスト名

　OSユーザーのパスワードを変更するエージェントサーバのホスト名を格納した列です。各行への値の指定は必須です。

・エージェントサーバのJP1/Baseの論理ホスト名

　エージェントサーバのJP1/Baseがクラスタ構成の場合の，JP1/Baseの論理ホスト名を格納した列です。各行への値の指定は任意です。この列への値の指定を省略した場合，エージェントサーバを物理サーバと仮定して処理します。

・OSユーザー名

　パスワード変更の対象とするOSユーザー名を格納した列です。各行への値の指定は必須です。

・OSユーザーの新パスワード

　パスワード変更の対象とするOSユーザーの新しいパスワードを格納した列です。各行への値の指定は必須です。

・OSユーザー種別

　パスワード変更の対象とするOSユーザーの種別(ドメインユーザー(domain)またはローカルユーザー(local))を格納した列です。エージェントサーバのOSがWindowsの場合は各行への値の指定は必須です。

・JP1/Baseパスワード管理情報の更新要否

　記載した行の情報でJP1/Baseのパスワード管理情報を更新する場合に，"True"(大文字小文字を区別します)を指定してください。各行への値の指定は任意です。"True"を指定した場合だけ，JP1/Baseパスワード管理情報の更新を行います。

(6) JP1ユーザー変更処理を行う場合，JP1/AOサーバ上に，次に示す内容を記載したJP1ユーザー情報ファイルを格納していること。

・列数

　(5)の列数の説明を参照してください。

・列名

　(5)の列名の説明を参照してください。

・キー情報

　ユーザー情報ファイルの各行でユニークなキーとなる値を格納した列です。キー情報の内容は任意ですが，1から始まる整数値など，短い値を指定することを推奨します。また，キー情報には「"」および「'」以外の文字を使用してください。(すべてのキー情報の合計バイト数＋データの行数)が1017バイト以下になるようにしてください。各行への値の指定は任意です。省略した場合，該当する行の処理は行なわれません。

・JP1認証サーバのホスト名

　JP1ユーザーのパスワードを変更するJP1認証サーバのホスト名を格納した列です。各行への値の指定は必須です。

・JP1認証サーバのJP1/Baseの論理ホスト名

　JP1認証サーバのJP1/Baseがクラスタ構成の場合の，JP1/Baseの論理ホスト名を格納した列です。各行への値の指定は任意です。この列への値の指定を省略した場合，JP1認証サーバを物理サーバと仮定して処理します。

・JP1ユーザー名

　パスワード変更の対象とするJP1ユーザー名を格納した列です。各行への値の指定は必須です。

・JP1ユーザーの旧パスワード

　パスワード変更の対象とするJP1ユーザーの現在のパスワードを格納した列です。各行への値の指定は必須です。

・JP1ユーザーの新パスワード

　パスワード変更の対象とするJP1ユーザーの新しいパスワードを格納した列です。各行への値の指定は必須です。

(7) このサービスを実行する場合，エージェントレス接続先としてJP1/AOサーバ("localhost"で解決されるループバックアドレス)，JP1認証サーバ，およびエージェントサーバを設定する必要があります。

(8) 列名には次に示す内容を指定してください。

・必ず文字列で指定してください。数値データは指定しないでください。

・次の文字は列名に使用できません。

　・キー情報の列名の先頭には次の文字を使用できません。

　「!」「"」「#」「$」「%」「&」「'」「(」「)」「-」「=」「^」「~」「¥」「|」「`」「;」「+」「*」「[」「]」「{」「}」「,」「.」「<」「>」「?」「_」「/」「0」「1」「2」「3」「4」「5」「6」「7」「8」「9」「０」「１」「２」「３」「４」「５」「６」「７」「８」「９」

　・キー情報の列名の2文字目以降には次の文字を使用できません。

　「"」「#」「%」「&」「'」「(」「)」「-」「=」「^」「~」「¥」「|」「@」「;」「:」「+」「*」「[」「]」「{」「}」「,」「.」「<」「>」「?」「/」

　・キー情報以外の列名には次の文字を使用できません。

　「!」「[」「]」「`」「,」「.」

・文字数は半角全角混合で64文字まで指定できます。

注意事項

【ユーザー情報ファイルに関する注意事項】

・JP1/AOサーバがWindows環境の場合の注意事項

(1) エージェントサーバのOSがUNIXの場合は，ユーザー情報ファイルの内容にマルチバイト文字を使用しないでください。

(2) エージェントサーバのOSがWindowsの場合は，OSユーザー名だけマルチバイト文字を指定できます。指定する場合はOSユーザー名の長さは20バイト以内となるようにしてください。

(3) パスワード変更対象となるOSユーザー/JP1ユーザーの仕様を確認の上，OSユーザー情報ファイル，およびJP1ユーザー情報ファイルを作成してください。なお，ユーザー情報ファイルの各フィールドには，次の文字を指定できません。

　「<」，「>」，「|」，「;」，「&」，制御文字(0x00〜0x1f)，両端以外の「"」および末尾の「¥」

(4) Excelファイルのセルが結合されている場合，数式がエラーとなっている場合は取得される値が空になります。また，書き込みパスワードが設定されている場合はタスクが異常終了します。ユーザー情報ファイルからはこれらの状態を取り除いてください。

(5) 読み取る列は，文字列型データと数値型データを混在させないでください。混在していると，ODBCドライバの仕様によって，正常に値を取得できない場合があります。

　(a)数値型データとは次の形式の文字列のことです。

　　符号付き整数値(10進数) 例：-12345

　　固定小数点数(10進数) 　例：3.1415

　　浮動小数点数(10進数) 　例：6.543E+10

　(b)文字列型データとは上の数値型以外の形式の文字列のことです。

(6) 異なるデータ型が混在する列を取得する場合は，次の対処が必要です。

・Excelファイルの場合は数値型データの先頭に「'」を付けてください。

・CSVファイルの場合は数値型データを「"」で囲んでください。

(7) ユーザー情報ファイルがCSVファイルである場合，IPアドレスは「"」で囲んでください。「"」で囲まない場合，数値型データとして誤認識され，正常に値を取得できないことがあります。

(8) データの途中に空白行がある場合，空白行も行数としてカウントされます。データが記述された行が99行以内であっても，途中の空白行を含めた行数が100以上となる場合，タスクが異常終了するのでご注意ください。

(9) ユーザー情報ファイルがExcelファイルの場合，セルに記述されたデータのデータ型によっては，表示されている値と実際に取得される値が異なる場合があります。次のデータ型のデータを記述している場合はご注意ください。

　(a)Boolean型(True/False)

　　表示される値：TRUE/FALSE

　　セルに記述されている値：TRUE/FALSE

　　実際に取得される値：True/False

　(b)日付データ

　　表示される値：mm月dd日

　　セルに記述されている値：yyyy/mm/dd

　　実際に取得される値：yyyy/mm/dd

　(c)時刻データ

　　表示される値：hh:mm

　　セルに記述されている値：hh:mm:ss

　　実際に取得される値：hh:mm:ss

　(d)パーセント

　　表示される値：〜%(例：10%)

　　セルに記述されている値：〜%(例：10%)

　　実際に取得される値：0.〜(例：0.1)

　(e)数式

　　表示される値：(数式の結果)

　　セルに記述されている値：(数式)

　　実際に取得される値：(数式の結果)

(a)(d)(e)のデータをセルに記述されている値のまま取得したい場合は先頭に「'」を付けてください。

なお，ユーザー情報ファイルがCSVファイルの場合は記述した値をそのまま取得することができます。

(10) (9)の型のデータを記述する場合，その列の列名を除いたデータが1種類の型のデータだけになるように記述してください。複数の型のデータが1列に混在している場合，取得されるデータが空になる場合があります。

・JP1/AOサーバがUNIX環境の場合の注意事項

(1) エージェントサーバのOSがUNIXの場合は，ユーザー情報ファイルの内容にマルチバイト文字を使用しないでください。

(2) エージェントサーバのOSがWindowsの場合は，OSユーザー名だけマルチバイト文字を指定できます。指定する場合はOSユーザー名の長さは20バイト以内となるようにしてください。

(3) パスワード変更対象となるOSユーザー/JP1ユーザーの仕様を確認の上，OSユーザー情報ファイル，およびJP1ユーザー情報ファイルを作成してください。なお，ユーザー情報ファイルの各フィールドには，次の文字を指定できません。

　「<」，「>」，「|」，「;」，「&」，制御文字(0x00〜0x1f)，両端以外の「"」および末尾の「¥」

(4) データの途中に空白行がある場合，空白行も行数としてカウントされます。データが記述された行が99行以内であっても，途中の空白行を含めた行数が100以上となる場合，タスクが異常終了するのでご注意ください。

(5) データには「,」は使用できません。使用した場合，列を正しく区切ることができないため，データを取得できません。

(6) ユーザー情報ファイルの行の先頭または末尾に存在する半角スペースおよびタブ記号は，その個数に関係なく，存在しないものとみなします。

【ユーザー情報ファイル以外の注意事項】

(1) UNIX環境に対してこのサービスを実行する場合，事前に変更対象のOSユーザーが存在することを確認してください。

(2) 列番号プロパティには255以内の整数値を指定してください。途中の空白列も列数に含まれますのでご注意ください。

実行権限

ビルトイン Administrator

バージョン

03.01.02

タグ

Configure JP1,Base

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

ユーザー情報ファイルの情報

OSユーザー情報ファイルまたはJP1ユーザー情報ファイルの情報を指定してください。

表示されます。

OSユーザー情報ファイルの詳細

OSユーザー情報ファイルの詳細情報を指定してください。OSユーザー情報を変更する場合は必ずすべてのプロパティを指定してください。

表示されます。

JP1ユーザー情報ファイルの詳細

JP1ユーザー情報ファイルの詳細情報を指定してください。JP1ユーザー情報を変更する場合は必ずすべてのプロパティを指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

OS.fileOpenRetryCount

ファイル読み込み時のリトライ回数:Windows固有

それぞれのユーザー情報ファイルの読み込みに失敗した場合のリトライ回数を指定します(Windowsの場合だけ)。ファイル読み込み時のリトライ間隔と組み合わせて最大待ち時間となります。"0"を指定した場合はリトライしません。

入力

無効

○　

ユーザー情報ファイルの情報

OS.fileOpenRetryInterval

ファイル読み込み時のリトライ間隔:Windows固有

それぞれのユーザー情報ファイルの読み込みに失敗した場合のリトライ間隔を秒単位で指定します(Windowsの場合だけ)。

入力

無効

○　

ユーザー情報ファイルの情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

OS.osUserInfoFilePath

OSユーザー情報ファイルのパス

JP1/AOサーバ上に格納した，OSユーザー情報を記入したファイルのパスをフルパスで指定します。ファイルの拡張子はcsv，xls，xlsx，xlsmのどれかである必要があります。

入力

無効

△　

ユーザー情報ファイルの情報

OS.osUserInfoSheetName

OSユーザー情報ファイルのシート名

OSユーザー情報ファイルがExcelファイルの場合，ユーザー情報が記載されたシート名を必ず指定してください。

入力

無効

△　

ユーザー情報ファイルの情報

OS.osUserInfoKeyColumn

OSユーザー情報ファイルのキー情報の列番号

OSユーザー情報ファイル内の「キー情報」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

OSユーザー情報ファイルの詳細

common.targetHostNameColumn

エージェントサーバのホスト名の列番号

OSユーザー情報ファイル内の「エージェントサーバのホスト名」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

OSユーザー情報ファイルの詳細

jp1base.jp1BaseLHostNameColumn

エージェントサーバのJP1/Baseの論理ホスト名の列番号

OSユーザー情報ファイル内の「エージェントサーバのJP1/Baseの論理ホスト名」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

OSユーザー情報ファイルの詳細

OS.osUserNameColumn

OSユーザー名の列番号

OSユーザー情報ファイル内の「OSユーザー名」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

OSユーザー情報ファイルの詳細

OS.osUserNewPasswordColumn

OSユーザーの新パスワードの列番号

OSユーザー情報ファイル内の「OSユーザーの新パスワード」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

OSユーザー情報ファイルの詳細

OS.osUserTypeColumn

OSユーザー種別の列番号

OSユーザー情報ファイル内の「OSユーザー種別」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

OSユーザー情報ファイルの詳細

jp1base.updatePasswordInfoColumn

JP1/Baseパスワード管理情報の更新要否の列番号

OSユーザー情報ファイル内の「JP1/Baseパスワード管理情報の更新要否」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

OSユーザー情報ファイルの詳細

jp1base.jp1UserInfoFilePath

JP1ユーザー情報ファイルのパス

JP1/AOサーバ上に格納した，JP1ユーザー情報を記入したファイルのパスをフルパスで指定します。ファイルの拡張子はcsv，xls，xlsx，xlsmのどれかである必要があります。

入力

無効

△　

ユーザー情報ファイルの情報

jp1base.jp1UserInfoSheetName

JP1ユーザー情報ファイルのシート名

JP1ユーザー情報ファイルがExcelファイルの場合，ユーザー情報が記載されたシート名を指定してください。JP1ユーザー情報ファイルがExcelファイルの場合には必ず指定してください。

入力

無効

△　

ユーザー情報ファイルの情報

jp1base.jp1UserInfoKeyColumn

JP1ユーザー情報ファイルのキー情報の列番号

JP1ユーザー情報ファイル内の「キー情報」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

JP1ユーザー情報ファイルの詳細

jp1base.certHostNameColumn

JP1認証サーバのホスト名の列番号

JP1ユーザー情報ファイル内の「JP1認証サーバのホスト名」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

JP1ユーザー情報ファイルの詳細

jp1base.certHostLHostNameColumn

JP1認証サーバの論理ホスト名の列番号

JP1ユーザー情報ファイル内の「JP1認証サーバの論理ホスト名」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

JP1ユーザー情報ファイルの詳細

jp1base.jp1UserNameColumn

JP1ユーザー名の列番号

JP1ユーザー情報ファイル内の「JP1ユーザー名」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

JP1ユーザー情報ファイルの詳細

jp1base.jp1UserOldPasswordColumn

JP1ユーザーの旧パスワードの列番号

JP1ユーザー情報ファイル内の「JP1ユーザーの旧パスワード」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

JP1ユーザー情報ファイルの詳細

jp1base.jp1UserNewPasswordColumn

JP1ユーザーの新パスワードの列番号

JP1ユーザー情報ファイル内の「JP1ユーザーの新パスワード」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

JP1ユーザー情報ファイルの詳細

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.osUserChangeResult

繰り返しタスクの実行結果(OSユーザーのパスワード変更処理)

OSユーザーのパスワード変更処理のタスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

common.jp1UserChangeResult

繰り返しタスクの実行結果(JP1ユーザーのパスワード変更処理)

JP1ユーザーのパスワード変更処理のタスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

OS.fileOpenRetryCount

0〜32767の整数値。

OS.fileOpenRetryInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

OS.osUserInfoFilePath

8文字以上255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「[」，「]」，「!」および末尾の「¥」，「/」を除く。

OS.osUserInfoSheetName

1文字以上31文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「:」，「&」，「*」，「?」，「"」，「%」，「/」，「¥」，「!」，「`」，「{」，「[」，「]」および全角記号「：」，「￥」，「？」，「［」，「］」，「／」，「＊」を除く。

OS.osUserInfoKeyColumn

1〜255の整数値。

common.targetHostNameColumn

1〜255の整数値。

jp1base.jp1BaseLHostNameColumn

1〜255の整数値。

OS.osUserNameColumn

1〜255の整数値。

OS.osUserNewPasswordColumn

1〜255の整数値。

OS.osUserTypeColumn

1〜255の整数値。

jp1base.updatePasswordInfoColumn

1〜255の整数値。

jp1base.jp1UserInfoFilePath

8文字以上255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「[」，「]」，「!」および末尾の「¥」，「/」を除く。

jp1base.jp1UserInfoSheetName

1文字以上31文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「:」，「&」，「*」，「?」，「"」，「%」，「/」，「¥」，「!」，「`」，「{」，「[」，「]」および全角記号「：」，「￥」，「？」，「［」，「］」，「／」，「＊」を除く。

jp1base.jp1UserInfoKeyColumn

1〜255の整数値。

jp1base.certHostNameColumn

1〜255の整数値。

jp1base.certHostLHostNameColumn

1〜255の整数値。

jp1base.jp1UserNameColumn

1〜255の整数値。

jp1base.jp1UserOldPasswordColumn

1〜255の整数値。

jp1base.jp1UserNewPasswordColumn

1〜255の整数値。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

OS種別の出力

OS種別の出力

OS種別の出力

JP1/AOサーバのOSを出力します。

エラー原因を取り除いたあと，サービスを再実行してください。

2

OSユーザーのパスワード変更

OSユーザーのパスワード変更

階層フロー部品

OSユーザーのパスワードを変更します。

−　

2-3

値判定分岐部品

OSユーザー情報ファイルのパスが指定されているか判定します。

エラーの原因を取り除き，サービスを再実行してください。

2-4

階層フロー部品

OSユーザーのパスワード変更のメイン処理を実行します。

−　

2-4-1

CSV・Excelの列データ取得

ファイルからキー情報を読み出します。

エラーの原因を取り除き，サービスを再実行してください。

2-4-2

繰り返し部品

読み出したキー情報を元に，繰り返しOSユーザーのパスワード変更を実行します。

エラーの原因を取り除き，サービスを再実行してください。

3

JP1ユーザーのパスワード変更

JP1ユーザーのパスワード変更

階層フロー部品

JP1/Baseに登録されているJP1ユーザーのパスワードを変更します。

−　

3-3

値判定分岐部品

JP1ユーザー情報ファイルのパスが指定されているか判定します。

エラーの原因を取り除き，サービスを再実行してください。

3-4

階層フロー部品

JP1ユーザーのパスワード変更のメイン処理を実行します。

エラーの原因を取り除き，サービスを再実行してください。

3-4-1

CSV・Excelの列データ取得

ファイルからキー情報を読み出します。

エラーの原因を取り除き，JP1ユーザー情報ファイルだけを指定してサービスを再実行してください。(OSユーザーの処理は正常終了しています)

3-4-2

繰り返し部品

読み出したキー情報を元に，繰り返しJP1ユーザーのパスワード変更を実行します。

エラーの原因を取り除き，common.jp1UserChangeResultで失敗(false)と表示された順番を確認します。失敗した順番と同一の行(n番目であればn行目の行)以降を抜き出したファイルを用いてサービスを実行してください。

2.5.26　運用ユーザー一括変更(繰り返しフロー1)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

OSユーザーの情報読み取り

readOsUserInfo

CSV・Excelの行データ取得

ファイルからOSユーザー情報を読み出します。

エラーの原因を取り除き，サービスを再実行してください。

2

OS種別の出力

osGetOsInfo

OS種別の出力

エージェントサーバのOSを判定します。

エラー原因を取り除いて，サービスを再実行してください。

3

OSユーザーのパスワード変更

osChangePassword

階層フロー部品

OSユーザーのパスワードを変更します。

−　

3-1

OSユーザーのパスワード変更

エージェントサーバ(またはサーバのドメイン)でユーザーのパスワードを変更します。

エラーの原因を取り除き，サービスを再実行してください。

4

OS種別の判定

CheckMacroValue

値判定分岐部品

Windowsかどうか判定します。

JP1ユーザーの新旧パスワードに変更したあとの値を設定し，サービスを再実行してください。

5

JP1/Baseに登録されているOSユーザー情報の変更

jp1baseChangeUserInfo

階層フロー部品

JP1/Baseに登録されているOSユーザー情報を更新します。

−　

5-3

値判定分岐部品

JP1/Baseのパスワード管理情報を更新するかどうか判定します。

JP1ユーザーの新旧パスワードに変更したあとの値を設定し，サービスを再実行してください。

5-4

JP1/Baseのパスワード管理情報変更

指定されたサーバのJP1/Baseのマッピングユーザーのパスワードを変更します。

JP1ユーザーの新旧パスワードに変更したあとの値を設定し，サービスを再実行してください。

2.5.27　運用ユーザー一括変更(繰り返しフロー2)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

JP1ユーザーの情報読み取り

readJp1UserInfo

CSV・Excelの行データ取得

ファイルからJP1ユーザー情報を読み出します。

エラーの原因を取り除き，サービスを再実行してください。

2

JP1ユーザーのパスワード変更

jp1baseChangePassword

階層フロー部品

JP1ユーザーのパスワードを変更します。

−　

2-1

JP1ユーザーパスワード変更

指定された認証サーバでJP1ユーザーのパスワードを変更します。

エラーの原因を取り除き，common.jp1UserChangeResultで失敗(false)と表示された順番を確認します。失敗した順番と同一の行(n番目であればn行目の行)以降を抜き出したファイルを用いてサービスを実行してください。

2.5.28　運用ユーザー一括変更(SYSTEM)

機能

このサービステンプレートは，CSV(Comma Separated Values)ファイルまたはMicrosoft Excelによって作成されたユーザーの一覧情報(これ以降，ユーザー情報ファイルと呼びます)を使用して，JP1ユーザーのパスワード変更，OSユーザーのパスワード変更，それに伴うWindows版JP1/Baseのパスワード管理情報に登録された内容の変更を一括で行います。なお，CentOS環境では，OSユーザーのパスワード変更処理だけ実行できます。

JP1/AOサーバがWindows環境の場合はCSVファイルまたはExcelファイル，UNIX環境の場合はCSVファイルを使用します。

次のような構成のシステムを管理する場合に有効です。

・JP1/AJS3によるジョブ実行環境で，複数のエージェントサーバでジョブを実行している。

・JP1/IMによる監視環境で，複数のエージェントサーバに対して自動アクションやコマンド実行を行う。

・JP1/Baseで認証を行うシステムで，多数のJP1ユーザーやOSユーザーを管理している。

このサービステンプレートが前提とするサーバを次に示します。

・JP1認証サーバ

　JP1/Baseの認証サーバが動作するサーバです。JP1ユーザー情報の管理を行います。

・エージェントサーバ

　JP1/Baseが導入され，ジョブの実行や自動アクションが行われるサーバです。

上記システムでの運用ユーザー情報の更新のため，次の処理を実行します。

【OSユーザーのパスワード変更処理】

　OSユーザー情報ファイルからキー値を記載した列を取り出し，すべてのキー値に対して次の処理を実行します。

　(1) キー値に合致する行の，エージェントサーバのホスト名，エージェントサーバの論理ホスト名，OSユーザー名，OSユーザーの新パスワードを読み取ります。

　(2) 処理(1)で読み取った情報を使用して，エージェントサーバのOSユーザーのパスワードを変更します。

　(3) 処理(1)で読み取った情報を使用して，必要に応じてエージェントサーバのJP1/Baseに登録されているパスワード管理情報を更新します。

【JP1ユーザーのパスワード変更処理】

　JP1ユーザー情報ファイルからキー値を記載した列を取り出し，すべてのキー値に対して次の処理を実行します。

　(1) キー値に合致する行の，JP1認証サーバのホスト名，JP1認証サーバの論理ホスト名，JP1ユーザー名，JP1ユーザーの旧パスワード，JP1ユーザーの新パスワードを読み取ります。

　(2) 処理(1)で読み取った情報を使用して，認証サーバのJP1ユーザーのパスワードを変更します。

サービス実行時にOS.osUserInfoFilePath(OSユーザー情報ファイルのパス)を指定した場合，OSユーザーのパスワード変更を実行します。jp1base.jp1UserInfoFilePath(JP1ユーザー情報ファイルのパス)を指定した場合，JP1ユーザーのパスワード変更処理を実行します。列番号を指定するプロパティには，CSVファイルの左から数えた列の番号またはExcelファイルの左から見て最初にデータが記述されている列から数えた列の番号を1〜255の値で指定します。

それぞれのユーザー情報ファイルには，ユーザー情報を99件(99行)まで記載することができます。各変更処理は，繰り返し部品で逐次的に実行します。

それぞれのユーザー情報ファイル読み込みに失敗した場合は，OS.fileOpenRetryIntervalプロパティに指定した秒数待ってファイル読み込みをリトライする処理を，OS.fileOpenRetryCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1) JP1認証サーバ，エージェントサーバに次のJP1/Baseが稼働していること。

JP1/Base 09-00以降

(2) JP1/AOサーバがWindows環境の場合，次に示すMicrosoft社のプログラムがJP1/AOサーバにインストールされていること。

・2007 Office system ドライバ，または

　Microsoft Access データベース エンジン 2010（32bit版），または

　Microsoft Access Database Engine 2016（32bit版）

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

　ただし，OSユーザーのパスワード変更処理だけ実行可能。

(9) CentOS 7 (64-bit x86_64)

　ただし，OSユーザーのパスワード変更処理だけ実行可能。

(10) CentOS 8 (64-bit x86_64)

　ただし，OSユーザーのパスワード変更処理だけ実行可能。

(11) Oracle Linux 8 (64-bit x86_64)

(12) AIX V6

(13) AIX V7

【サービステンプレート実行システム内前提製品の使用条件】

(1) OSユーザーのパスワード変更(およびWindowsの場合はJP1/Baseのパスワード管理情報の更新)を行う場合，OS.osUserInfoFilePath，OS.osUserInfoSheetName(Excelファイルの場合だけ)，OS.osUserInfoKeyColumn，common.targetHostNameColumn，jp1base.jp1BaseLHostNameColumn，OS.osUserNameColumn，OS.osUserNewPasswordColumn，OS.osUserTypeColumn，jp1base.updatePasswordInfoColumnを必ず指定してください。

(2) JP1ユーザーのパスワード変更を行う場合，jp1base.jp1UserInfoFilePath，jp1base.jp1UserInfoSheetName(Excelファイルの場合だけ)，jp1base.jp1UserInfoKeyColumn，jp1base.certHostNameColumn，jp1base.certHostLHostNameColumn，jp1base.jp1UserNameColumn，jp1base.jp1UserOldPasswordColumn，jp1base.jp1UserNewPasswordColumnを必ず指定してください。

(3) 認証サーバのJP1/Baseがクラスタ構成で，論理ホスト環境のJP1ユーザーのパスワードを更新する場合，jp1base.certHostNameColumnで指定した列の値に，物理ホスト名または論理ホスト名を，jp1base.certHostLHostNameColumnで指定した列の値に，論理ホスト名を記入してください。物理ホスト環境のJP1ユーザーのパスワードを更新する場合は，jp1base.certHostLHostNameColumnで指定した列には空白を指定してください。

(4) エージェントサーバのJP1/Baseがクラスタ構成で，論理ホスト環境のOSユーザーのパスワード管理情報を更新する場合，実行系の環境のOSユーザー情報を記述したOSユーザー情報ファイルを使用してサービスを実行してください。実行系(JP1/Baseが動作している)のエージェントサーバの情報では，jp1base.updatePasswordInfoColumnで指定した列の値を"TRUE"にしてください。実行系の環境へ一度サービスを実行したあとに，系を切り替えたあとの実行系の環境へサービスを実行する際は，システム環境設定情報，OSユーザー情報のパラメーターに値を入力し，JP1ユーザー情報のパラメーターはすべて空欄にしてサービスを実行してください。

(5) OSユーザー変更処理を行う場合，JP1/AOサーバ上に，次に示す内容を記載したOSユーザー情報ファイルを格納していること。

・列数

　データの読み取り開始列から数えた列数が255列以内となるようにしてください。

・列名

　・CSVファイルの場合

　　・列名が必要な場合は，ファイルの1行目に記載してください。なお，列名が不要の場合は，列名の記載は必要ありません。

　　・列名の記載有無に関わらず，データの読み取り開始行は2行目からとなります。

　・Excelファイルの場合

　　・列名は必ず記載してください。1行目以降で最初に記述がある行が列名となります。

　　・データの読み取り開始行は列名が記載されている行の次の行からとなります。

　列名の指定の際は(8)を参照してください。

・キー情報

　ユーザー情報ファイルの各行でユニークなキーとなる値を格納した列です。キー情報の内容は任意ですが，1から始まる整数値など，短い値を指定することを推奨します。また，キー情報には「"」および「'」以外の文字を使用してください。(すべてのキー情報の合計バイト数＋データの行数)が1017バイト以下になるようにしてください。各行への値の指定は任意です。省略した場合，該当する行の処理は行なわれません。

・エージェントサーバのホスト名

　OSユーザーのパスワードを変更するエージェントサーバのホスト名を格納した列です。各行への値の指定は必須です。

・エージェントサーバのJP1/Baseの論理ホスト名

　エージェントサーバのJP1/Baseがクラスタ構成の場合の，JP1/Baseの論理ホスト名を格納した列です。各行への値の指定は任意です。この列への値の指定を省略した場合，エージェントサーバを物理サーバと仮定して処理します。

・OSユーザー名

　パスワード変更の対象とするOSユーザー名を格納した列です。各行への値の指定は必須です。

・OSユーザーの新パスワード

　パスワード変更の対象とするOSユーザーの新しいパスワードを格納した列です。各行への値の指定は必須です。

・OSユーザー種別

　パスワード変更の対象とするOSユーザーの種別(ドメインユーザー(domain)またはローカルユーザー(local))を格納した列です。エージェントサーバのOSがWindowsの場合は各行への値の指定は必須です。

・JP1/Baseパスワード管理情報の更新要否

　記載した行の情報でJP1/Baseのパスワード管理情報を更新する場合に，"True"(大文字小文字を区別します)を指定してください。各行への値の指定は任意です。"True"を指定した場合だけ，JP1/Baseパスワード管理情報の更新を行います。

(6) JP1ユーザー変更処理を行う場合，JP1/AOサーバ上に，次に示す内容を記載したJP1ユーザー情報ファイルを格納していること。

・列数

　(5)の列数の説明を参照してください。

・列名

　(5)の列名の説明を参照してください。

・キー情報

　ユーザー情報ファイルの各行でユニークなキーとなる値を格納した列です。キー情報の内容は任意ですが，1から始まる整数値など，短い値を指定することを推奨します。また，キー情報には「"」および「'」以外の文字を使用してください。(すべてのキー情報の合計バイト数＋データの行数)が1017バイト以下になるようにしてください。各行への値の指定は任意です。省略した場合，該当する行の処理は行なわれません。

・JP1認証サーバのホスト名

　JP1ユーザーのパスワードを変更するJP1認証サーバのホスト名を格納した列です。各行への値の指定は必須です。

・JP1認証サーバのJP1/Baseの論理ホスト名

　JP1認証サーバのJP1/Baseがクラスタ構成の場合の，JP1/Baseの論理ホスト名を格納した列です。各行への値の指定は任意です。この列への値の指定を省略した場合，JP1認証サーバを物理サーバと仮定して処理します。

・JP1ユーザー名

　パスワード変更の対象とするJP1ユーザー名を格納した列です。各行への値の指定は必須です。

・JP1ユーザーの旧パスワード

　パスワード変更の対象とするJP1ユーザーの現在のパスワードを格納した列です。各行への値の指定は必須です。

・JP1ユーザーの新パスワード

　パスワード変更の対象とするJP1ユーザーの新しいパスワードを格納した列です。各行への値の指定は必須です。

(7) このサービスを実行する場合，エージェントレス接続先としてJP1/AOサーバ("localhost"で解決されるループバックアドレス)，JP1認証サーバ，およびエージェントサーバを設定する必要があります。

(8) 列名には次に示す内容を指定してください。

・必ず文字列で指定してください。数値データは指定しないでください。

・次の文字は列名に使用できません。

　・キー情報の列名の先頭には次の文字を使用できません。

　「!」「"」「#」「$」「%」「&」「'」「(」「)」「-」「=」「^」「~」「¥」「|」「`」「;」「+」「*」「[」「]」「{」「}」「,」「.」「<」「>」「?」「_」「/」「0」「1」「2」「3」「4」「5」「6」「7」「8」「9」「０」「１」「２」「３」「４」「５」「６」「７」「８」「９」

　・キー情報の列名の2文字目以降には次の文字を使用できません。

　「"」「#」「%」「&」「'」「(」「)」「-」「=」「^」「~」「¥」「|」「@」「;」「:」「+」「*」「[」「]」「{」「}」「,」「.」「<」「>」「?」「/」

　・キー情報以外の列名には次の文字を使用できません。

　「!」「[」「]」「`」「,」「.」

・文字数は半角全角混合で64文字まで指定できます。

注意事項

【ユーザー情報ファイルに関する注意事項】

・JP1/AOサーバがWindows環境の場合の注意事項

(1) エージェントサーバのOSがUNIXの場合は，ユーザー情報ファイルの内容にマルチバイト文字を使用しないでください。

(2) エージェントサーバのOSがWindowsの場合は，OSユーザー名だけマルチバイト文字を指定できます。指定する場合はOSユーザー名の長さは20バイト以内となるようにしてください。

(3) パスワード変更対象となるOSユーザー/JP1ユーザーの仕様を確認の上，OSユーザー情報ファイル，およびJP1ユーザー情報ファイルを作成してください。なお，ユーザー情報ファイルの各フィールドには，次の文字を指定できません。

　「<」，「>」，「|」，「;」，「&」，制御文字(0x00〜0x1f)，両端以外の「"」および末尾の「¥」

(4) Excelファイルのセルが結合されている場合，数式がエラーとなっている場合は取得される値が空になります。また，書き込みパスワードが設定されている場合はタスクが異常終了します。ユーザー情報ファイルからはこれらの状態を取り除いてください。

(5) 読み取る列は，文字列型データと数値型データを混在させないでください。混在していると，ODBCドライバの仕様によって，正常に値を取得できない場合があります。

　(a)数値型データとは次の形式の文字列のことです。

　　符号付き整数値(10進数) 例：-12345

　　固定小数点数(10進数) 　例：3.1415

　　浮動小数点数(10進数) 　例：6.543E+10

　(b)文字列型データとは上の数値型以外の形式の文字列のことです。

(6) 異なるデータ型が混在する列を取得する場合は，次の対処が必要です。

・Excelファイルの場合は数値型データの先頭に「'」を付けてください。

・CSVファイルの場合は数値型データを「"」で囲んでください。

(7) ユーザー情報ファイルがCSVファイルである場合，IPアドレスは「"」で囲んでください。「"」で囲まない場合，数値型データとして誤認識され，正常に値を取得できないことがあります。

(8) データの途中に空白行がある場合，空白行も行数としてカウントされます。データが記述された行が99行以内であっても，途中の空白行を含めた行数が100以上となる場合，タスクが異常終了するのでご注意ください。

(9) ユーザー情報ファイルがExcelファイルの場合，セルに記述されたデータのデータ型によっては，表示されている値と実際に取得される値が異なる場合があります。次のデータ型のデータを記述している場合はご注意ください。

　(a)Boolean型(True/False)

　　表示される値：TRUE/FALSE

　　セルに記述されている値：TRUE/FALSE

　　実際に取得される値：True/False

　(b)日付データ

　　表示される値：mm月dd日

　　セルに記述されている値：yyyy/mm/dd

　　実際に取得される値：yyyy/mm/dd

　(c)時刻データ

　　表示される値：hh:mm

　　セルに記述されている値：hh:mm:ss

　　実際に取得される値：hh:mm:ss

　(d)パーセント

　　表示される値：〜%(例：10%)

　　セルに記述されている値：〜%(例：10%)

　　実際に取得される値：0.〜(例：0.1)

　(e)数式

　　表示される値：(数式の結果)

　　セルに記述されている値：(数式)

　　実際に取得される値：(数式の結果)

(a)(d)(e)のデータをセルに記述されている値のまま取得したい場合は先頭に「'」を付けてください。

なお，ユーザー情報ファイルがCSVファイルの場合は記述した値をそのまま取得することができます。

(10) (9)の型のデータを記述する場合，その列の列名を除いたデータが1種類の型のデータだけになるように記述してください。複数の型のデータが1列に混在している場合，取得されるデータが空になる場合があります。

・JP1/AOサーバがUNIX環境の場合の注意事項

(1) エージェントサーバのOSがUNIXの場合は，ユーザー情報ファイルの内容にマルチバイト文字を使用しないでください。

(2) エージェントサーバのOSがWindowsの場合は，OSユーザー名だけマルチバイト文字を指定できます。指定する場合はOSユーザー名の長さは20バイト以内となるようにしてください。

(3) パスワード変更対象となるOSユーザー/JP1ユーザーの仕様を確認の上，OSユーザー情報ファイル，およびJP1ユーザー情報ファイルを作成してください。なお，ユーザー情報ファイルの各フィールドには，次の文字を指定できません。

　「<」，「>」，「|」，「;」，「&」，制御文字(0x00〜0x1f)，両端以外の「"」および末尾の「¥」

(4) データの途中に空白行がある場合，空白行も行数としてカウントされます。データが記述された行が99行以内であっても，途中の空白行を含めた行数が100以上となる場合，タスクが異常終了するのでご注意ください。

(5) データには「,」は使用できません。使用した場合，列を正しく区切ることができないため，データを取得できません。

(6) ユーザー情報ファイルの行の先頭または末尾に存在する半角スペースおよびタブ記号は，その個数に関係なく，存在しないものとみなします。

【ユーザー情報ファイル以外の注意事項】

(1) UNIX環境に対してこのサービスを実行する場合，事前に変更対象のOSユーザーが存在することを確認してください。

(2) 列番号プロパティには255以内の整数値を指定してください。途中の空白列も列数に含まれますのでご注意ください。

実行権限

Administratorsグループに所属するユーザー

バージョン

03.10.02

タグ

Configure JP1,Base

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

ユーザー情報ファイルの情報

OSユーザー情報ファイルまたはJP1ユーザー情報ファイルの情報を指定してください。

表示されます。

OSユーザー情報ファイルの詳細

OSユーザー情報ファイルの詳細情報を指定してください。OSユーザー情報を変更する場合は必ずすべてのプロパティを指定してください。

表示されます。

JP1ユーザー情報ファイルの詳細

JP1ユーザー情報ファイルの詳細情報を指定してください。JP1ユーザー情報を変更する場合は必ずすべてのプロパティを指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

OS.fileOpenRetryCount

ファイル読み込み時のリトライ回数:Windows固有

それぞれのユーザー情報ファイルの読み込みに失敗した場合のリトライ回数を指定します(Windowsの場合だけ)。ファイル読み込み時のリトライ間隔と組み合わせて最大待ち時間となります。"0"を指定した場合はリトライしません。

入力

無効

○　

ユーザー情報ファイルの情報

OS.fileOpenRetryInterval

ファイル読み込み時のリトライ間隔:Windows固有

それぞれのユーザー情報ファイルの読み込みに失敗した場合のリトライ間隔を秒単位で指定します(Windowsの場合だけ)。

入力

無効

○　

ユーザー情報ファイルの情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

OS.osUserInfoFilePath

OSユーザー情報ファイルのパス

JP1/AOサーバ上に格納した，OSユーザー情報を記入したファイルのパスをフルパスで指定します。ファイルの拡張子はcsv，xls，xlsx，xlsmのどれかである必要があります。

入力

無効

△　

ユーザー情報ファイルの情報

OS.osUserInfoSheetName

OSユーザー情報ファイルのシート名

OSユーザー情報ファイルがExcelファイルの場合，ユーザー情報が記載されたシート名を必ず指定してください。

入力

無効

△　

ユーザー情報ファイルの情報

OS.osUserInfoKeyColumn

OSユーザー情報ファイルのキー情報の列番号

OSユーザー情報ファイル内の「キー情報」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

OSユーザー情報ファイルの詳細

common.targetHostNameColumn

エージェントサーバのホスト名の列番号

OSユーザー情報ファイル内の「エージェントサーバのホスト名」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

OSユーザー情報ファイルの詳細

jp1base.jp1BaseLHostNameColumn

エージェントサーバのJP1/Baseの論理ホスト名の列番号

OSユーザー情報ファイル内の「エージェントサーバのJP1/Baseの論理ホスト名」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

OSユーザー情報ファイルの詳細

OS.osUserNameColumn

OSユーザー名の列番号

OSユーザー情報ファイル内の「OSユーザー名」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

OSユーザー情報ファイルの詳細

OS.osUserNewPasswordColumn

OSユーザーの新パスワードの列番号

OSユーザー情報ファイル内の「OSユーザーの新パスワード」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

OSユーザー情報ファイルの詳細

OS.osUserTypeColumn

OSユーザー種別の列番号

OSユーザー情報ファイル内の「OSユーザー種別」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

OSユーザー情報ファイルの詳細

jp1base.updatePasswordInfoColumn

JP1/Baseパスワード管理情報の更新要否の列番号

OSユーザー情報ファイル内の「JP1/Baseパスワード管理情報の更新要否」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

OSユーザー情報ファイルの詳細

jp1base.jp1UserInfoFilePath

JP1ユーザー情報ファイルのパス

JP1/AOサーバ上に格納した，JP1ユーザー情報を記入したファイルのパスをフルパスで指定します。ファイルの拡張子はcsv，xls，xlsx，xlsmのどれかである必要があります。

入力

無効

△　

ユーザー情報ファイルの情報

jp1base.jp1UserInfoSheetName

JP1ユーザー情報ファイルのシート名

JP1ユーザー情報ファイルがExcelファイルの場合，ユーザー情報が記載されたシート名を指定してください。JP1ユーザー情報ファイルがExcelファイルの場合には必ず指定してください。

入力

無効

△　

ユーザー情報ファイルの情報

jp1base.jp1UserInfoKeyColumn

JP1ユーザー情報ファイルのキー情報の列番号

JP1ユーザー情報ファイル内の「キー情報」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

JP1ユーザー情報ファイルの詳細

jp1base.certHostNameColumn

JP1認証サーバのホスト名の列番号

JP1ユーザー情報ファイル内の「JP1認証サーバのホスト名」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

JP1ユーザー情報ファイルの詳細

jp1base.certHostLHostNameColumn

JP1認証サーバの論理ホスト名の列番号

JP1ユーザー情報ファイル内の「JP1認証サーバの論理ホスト名」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

JP1ユーザー情報ファイルの詳細

jp1base.jp1UserNameColumn

JP1ユーザー名の列番号

JP1ユーザー情報ファイル内の「JP1ユーザー名」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

JP1ユーザー情報ファイルの詳細

jp1base.jp1UserOldPasswordColumn

JP1ユーザーの旧パスワードの列番号

JP1ユーザー情報ファイル内の「JP1ユーザーの旧パスワード」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

JP1ユーザー情報ファイルの詳細

jp1base.jp1UserNewPasswordColumn

JP1ユーザーの新パスワードの列番号

JP1ユーザー情報ファイル内の「JP1ユーザーの新パスワード」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

△　

JP1ユーザー情報ファイルの詳細

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.osUserChangeResult

繰り返しタスクの実行結果(OSユーザーのパスワード変更処理)

OSユーザーのパスワード変更処理のタスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

common.jp1UserChangeResult

繰り返しタスクの実行結果(JP1ユーザーのパスワード変更処理)

JP1ユーザーのパスワード変更処理のタスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

OS.fileOpenRetryCount

0〜32767の整数値。

OS.fileOpenRetryInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

OS.osUserInfoFilePath

8文字以上255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「[」，「]」，「!」および末尾の「¥」，「/」を除く。

OS.osUserInfoSheetName

1文字以上31文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「:」，「&」，「*」，「?」，「"」，「%」，「/」，「¥」，「!」，「`」，「{」，「[」，「]」および全角記号「：」，「￥」，「？」，「［」，「］」，「／」，「＊」を除く。

OS.osUserInfoKeyColumn

1〜255の整数値。

common.targetHostNameColumn

1〜255の整数値。

jp1base.jp1BaseLHostNameColumn

1〜255の整数値。

OS.osUserNameColumn

1〜255の整数値。

OS.osUserNewPasswordColumn

1〜255の整数値。

OS.osUserTypeColumn

1〜255の整数値。

jp1base.updatePasswordInfoColumn

1〜255の整数値。

jp1base.jp1UserInfoFilePath

8文字以上255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「[」，「]」，「!」および末尾の「¥」，「/」を除く。

jp1base.jp1UserInfoSheetName

1文字以上31文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「:」，「&」，「*」，「?」，「"」，「%」，「/」，「¥」，「!」，「`」，「{」，「[」，「]」および全角記号「：」，「￥」，「？」，「［」，「］」，「／」，「＊」を除く。

jp1base.jp1UserInfoKeyColumn

1〜255の整数値。

jp1base.certHostNameColumn

1〜255の整数値。

jp1base.certHostLHostNameColumn

1〜255の整数値。

jp1base.jp1UserNameColumn

1〜255の整数値。

jp1base.jp1UserOldPasswordColumn

1〜255の整数値。

jp1base.jp1UserNewPasswordColumn

1〜255の整数値。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

OS種別の出力

OS種別の出力

OS種別の出力

JP1/AOサーバのOSを出力します。

エラー原因を取り除いたあと，サービスを再実行してください。

2

OSユーザーのパスワード変更

OSユーザーのパスワード変更

階層フロー部品

OSユーザーのパスワードを変更します。

−　

2-3

値判定分岐部品

OSユーザー情報ファイルのパスが指定されているか判定します。

エラーの原因を取り除き，サービスを再実行してください。

2-4

階層フロー部品

OSユーザーのパスワード変更のメイン処理を実行します。

−　

2-4-1

CSV・Excelの列データ取得(SYSTEM)

ファイルからキー情報を読み出します。

エラーの原因を取り除き，サービスを再実行してください。

2-4-2

繰り返し部品

読み出したキー情報を元に，繰り返しOSユーザーのパスワード変更を実行します。

エラーの原因を取り除き，サービスを再実行してください。

3

JP1ユーザーのパスワード変更

JP1ユーザーのパスワード変更

階層フロー部品

JP1/Baseに登録されているJP1ユーザーのパスワードを変更します。

−　

3-3

値判定分岐部品

JP1ユーザー情報ファイルのパスが指定されているか判定します。

エラーの原因を取り除き，サービスを再実行してください。

3-4

階層フロー部品

JP1ユーザーのパスワード変更のメイン処理を実行します。

エラーの原因を取り除き，サービスを再実行してください。

3-4-1

CSV・Excelの列データ取得(SYSTEM)

ファイルからキー情報を読み出します。

エラーの原因を取り除き，JP1ユーザー情報ファイルだけを指定してサービスを再実行してください。(OSユーザーの処理は正常終了しています)

3-4-2

繰り返し部品

読み出したキー情報を元に，繰り返しJP1ユーザーのパスワード変更を実行します。

エラーの原因を取り除き，common.jp1UserChangeResultで失敗(false)と表示された順番を確認します。失敗した順番と同一の行(n番目であればn行目の行)以降を抜き出したファイルを用いてサービスを実行してください。

2.5.29　運用ユーザー一括変更(SYSTEM)(繰り返しフロー1)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

OSユーザーの情報読み取り

readOsUserInfo(SYSTEM)

CSV・Excelの行データ取得(SYSTEM)

ファイルからOSユーザー情報を読み出します。

エラーの原因を取り除き，サービスを再実行してください。

2

OS種別の出力

osGetOsInfo

OS種別の出力

エージェントサーバのOSを判定します。

エラー原因を取り除いて，サービスを再実行してください。

3

OSユーザーのパスワード変更

osChangePassword

階層フロー部品

OSユーザーのパスワードを変更します。

−　

3-1

OSユーザーのパスワード変更

エージェントサーバ(またはサーバのドメイン)でユーザーのパスワードを変更します。

エラーの原因を取り除き，サービスを再実行してください。

4

OS種別の判定

CheckMacroValue

値判定分岐部品

Windowsかどうか判定します。

JP1ユーザーの新旧パスワードに変更したあとの値を設定し，サービスを再実行してください。

5

JP1/Baseに登録されているOSユーザー情報の変更

jp1baseChangeUserInfo

階層フロー部品

JP1/Baseに登録されているOSユーザー情報を更新します。

−　

5-3

値判定分岐部品

JP1/Baseのパスワード管理情報を更新するかどうか判定します。

JP1ユーザーの新旧パスワードに変更したあとの値を設定し，サービスを再実行してください。

5-4

JP1/Baseのパスワード管理情報変更

指定されたサーバのJP1/Baseのマッピングユーザーのパスワードを変更します。

JP1ユーザーの新旧パスワードに変更したあとの値を設定し，サービスを再実行してください。

2.5.30　運用ユーザー一括変更(SYSTEM)(繰り返しフロー2)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

JP1ユーザーの情報読み取り

readJp1UserInfo(SYSTEM)

CSV・Excelの行データ取得(SYSTEM)

ファイルからJP1ユーザー情報を読み出します。

エラーの原因を取り除き，サービスを再実行してください。

2

JP1ユーザーのパスワード変更

jp1baseChangePassword

階層フロー部品

JP1ユーザーのパスワードを変更します。

−　

2-1

JP1ユーザーパスワード変更

指定された認証サーバでJP1ユーザーのパスワードを変更します。

エラーの原因を取り除き，common.jp1UserChangeResultで失敗(false)と表示された順番を確認します。失敗した順番と同一の行(n番目であればn行目の行)以降を抜き出したファイルを用いてサービスを実行してください。

2.5.31　運用ユーザー削除

機能

このサービステンプレートは，OSユーザーおよびJP1ユーザーの削除と，周辺設定を行います。

ジョブ実行環境でのサーバ滅却などの際の，運用ユーザーの削除時に発生する作業を省力化する目的で使用します。

次のシステムの場合に有効です。

・JP1/AJS3によるジョブ実行環境で，エージェントサーバでジョブを実行する場合。

・JP1/IMによる監視環境で，エージェントサーバに自動アクションやコマンド実行を行う場合。

このサービステンプレートが前提とするサーバを次に示します。

・JP1認証サーバ

　JP1/Baseの認証サーバが動作するサーバです。JP1ユーザー情報の管理を行います。

・エージェントサーバ

　JP1/Baseが導入され，ジョブの実行や自動アクションが行われるサーバです。

次の作業を実行します。

(1)JP1ユーザーおよび操作権限の削除 (JP1認証サーバ)

(2)ユーザーマッピング情報の削除(エージェントサーバ)

(3)JP1/Baseに登録されているパスワード管理情報の削除 (エージェントサーバ)

(4)OSユーザーの削除 (エージェントサーバ)

ただし，上記の作業は権限レベルが付加されているJP1ユーザーに対してのみ実行されます。

JP1/AOサーバ，JP1認証サーバ，エージェントサーバのどれかのOSがWindowsの場合，このサービステンプレートの実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。各サーバにAdministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行うサービス「運用ユーザー削除(SYSTEM)」を実行してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1) JP1認証サーバ，エージェントサーバに次のJP1/Baseが稼働していること。

JP1/Base 09-00以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【サービステンプレート実行システム内前提製品の使用条件】

(1)エージェントサーバのJP1/Baseに，接続先の認証サーバが設定されていること。

(2)OSユーザーとJP1ユーザーが1対1に対応付けられている必要があります。

(3)このサービスでは，次の情報を削除します。

　・指定したOSユーザー

　・(Windows環境だけ)指定したOSユーザーのパスワード管理情報

　・指定したJP1ユーザーの権限

　・指定したJP1ユーザーと指定したサーバホストとのマッピング情報

　・指定したJP1ユーザー

　これ以外の定義情報を削除する場合は，手動で削除してください。

(4)エージェントサーバのJP1/Baseがクラスタ構成の場合，実行系の環境へのサービス実行だけ可能です。待機系の環境へのOSユーザー削除，パスワード管理情報削除，マッピング定義削除は，手動で実施してください。JP1認証サーバがクラスタ構成の場合は，実行系に設定することで，待機系にも設定が反映されます。

注意事項

(1) エージェントサーバがUNIXの場合，このサービスはユーザーのホームディレクトリも削除します。必要に応じて，ホームディレクトリに格納されたデータを退避してください。

(2) ドメイン環境のOSユーザーを操作する場合は，プロパティ"OS.userType"にdomainを設定してください。

(3) UNIX環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

(4) エージェントサーバのOSがWindowsでマルチバイト文字を指定する場合は，OSユーザー名の長さは20バイト以内となるよう指定してください。

バージョン

03.00.00

タグ

Configure JP1,Base

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

システム環境情報

エージェントサーバの環境情報を指定してください。

表示されます。

OSユーザー情報

削除するOSユーザーの情報を指定してください。

表示されます。

JP1認証サーバ情報

削除するJP1ユーザーのJP1認証サーバの情報を指定してください。

表示されます。

JP1ユーザー情報

削除するJP1ユーザーの情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1base.certHost

JP1認証サーバのホスト名

JP1認証サーバのホスト名を指定します。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

JP1認証サーバ情報

jp1base.certHostLHostName

JP1認証サーバの論理ホスト名

JP1認証サーバがクラスタ構成の場合，JP1認証サーバの論理ホスト名を指定します。

入力

無効

△　

JP1認証サーバ情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

common.targetHost

エージェントサーバのホスト名

エージェントサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

システム環境情報

jp1base.jp1BaseLHostName

JP1/Baseの論理ホスト名

エージェントサーバのJP1/Baseがクラスタ構成の場合，JP1/Baseの論理ホスト名を指定します。

入力

無効

△　

システム環境情報

OS.osUserName

OSユーザー名

エージェントサーバから削除するOSユーザー名を指定します。

入力

無効

○　

OSユーザー情報

OS.userType

OSユーザー種別

操作対象のOSユーザー種別をlocal(ローカル)またはdomain(ドメイン)で指定します。このプロパティはエージェントサーバのOSがWindowsの場合だけ有効です。

入力

無効

△　

OSユーザー情報

OS.homeDirectoryDelete

ホームディレクトリの削除可否

OSユーザーを削除したあとにユーザーのホームディレクトリを削除するかどうかを，yes(削除する)またはno(削除しない)で指定します。このプロパティはエージェントサーバのOSがUNIXの場合だけ有効です。

入力

無効

△　

OSユーザー情報

jp1base.jp1UserName

JP1ユーザー名

JP1認証サーバから削除するJP1ユーザー名を指定します。

入力

無効

○　

JP1ユーザー情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1base.certHost

255文字以内の半角英数字および「.」，「-」。

jp1base.certHostLHostName

255文字以内の半角英数字および「.」，「-」。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

common.targetHost

255文字以内の半角英数字および「.」，「-」。

jp1base.jp1BaseLHostName

255文字以内の半角英数字および「.」，「-」。

OS.osUserName

20文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.userType

次の値のどれかを選択する。

local,domain

OS.homeDirectoryDelete

次の値のどれかを選択する。

yes,no

jp1base.jp1UserName

31文字以内の半角英数字，および「!」，「#」，「$」，「%」，「'」，「-」，「@」，「_」，「~」。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

JP1ユーザー削除

JP1ユーザー削除

階層フロー部品

JP1ユーザーと関連する情報を削除します。

−　

1-1

JP1ユーザー操作権限削除

JP1認証サーバでJP1/Baseの操作権限を削除します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-2

JP1ユーザー削除

JP1認証サーバからJP1ユーザーを削除します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-3

JP1/Baseユーザーマッピング削除

エージェントサーバでJP1ユーザーとOSユーザーのマッピングを削除します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-4

OS種別の出力

OSを判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-7

値判定分岐部品

Windowsかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-8

OSユーザー情報の削除

OSユーザーのパスワードをJP1/Baseから削除します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

OSユーザー削除

OSユーザー削除

階層フロー部品

OSユーザーを削除します。

−　

2-1

OSユーザーの削除

エージェントサーバ(またはエージェントサーバのドメイン)からユーザーを削除します。

エラーの原因を取り除いたあと，net user deleteコマンド(Windows)またはuserdelコマンド(UNIX)で手動でOSユーザーを削除してください。

2.5.32　運用ユーザー削除(SYSTEM)

機能

このサービステンプレートは，OSユーザーおよびJP1ユーザーの削除と，周辺設定を行います。

ジョブ実行環境でのサーバ滅却などの際の，運用ユーザーの削除時に発生する作業を省力化する目的で使用します。

次のシステムの場合に有効です。

・JP1/AJS3によるジョブ実行環境で，エージェントサーバでジョブを実行する場合。

・JP1/IMによる監視環境で，エージェントサーバに自動アクションやコマンド実行を行う場合。

このサービステンプレートが前提とするサーバを次に示します。

・JP1認証サーバ

　JP1/Baseの認証サーバが動作するサーバです。JP1ユーザー情報の管理を行います。

・エージェントサーバ

　JP1/Baseが導入され，ジョブの実行や自動アクションが行われるサーバです。

次の作業を実行します。

(1)JP1ユーザーおよび操作権限の削除 (JP1認証サーバ)

(2)ユーザーマッピング情報の削除(エージェントサーバ)

(3)JP1/Baseに登録されているパスワード管理情報の削除 (エージェントサーバ)

(4)OSユーザーの削除 (エージェントサーバ)

ただし，上記の作業は権限レベルが付加されているJP1ユーザーに対してのみ実行されます。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1) JP1認証サーバ，エージェントサーバに次のJP1/Baseが稼働していること。

JP1/Base 09-00以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【サービステンプレート実行システム内前提製品の使用条件】

(1)エージェントサーバのJP1/Baseに，接続先の認証サーバが設定されていること。

(2)OSユーザーとJP1ユーザーが1対1に対応付けられている必要があります。

(3)このサービスでは，次の情報を削除します。

　・指定したOSユーザー

　・(Windows環境だけ)指定したOSユーザーのパスワード管理情報

　・指定したJP1ユーザーの権限

　・指定したJP1ユーザーと指定したサーバホストとのマッピング情報

　・指定したJP1ユーザー

　これ以外の定義情報を削除する場合は，手動で削除してください。

(4)エージェントサーバのJP1/Baseがクラスタ構成の場合，実行系の環境へのサービス実行だけ可能です。待機系の環境へのOSユーザー削除，パスワード管理情報削除，マッピング定義削除は，手動で実施してください。JP1認証サーバがクラスタ構成の場合は，実行系に設定することで，待機系にも設定が反映されます。

注意事項

(1) エージェントサーバがUNIXの場合，このサービスはユーザーのホームディレクトリも削除します。必要に応じて，ホームディレクトリに格納されたデータを退避してください。

(2) ドメイン環境のOSユーザーを操作する場合は，プロパティ"OS.userType"にdomainを設定してください。

(3) UNIX環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

(4) エージェントサーバのOSがWindowsでマルチバイト文字を指定する場合は，OSユーザー名の長さは20バイト以内となるよう指定してください。

バージョン

03.00.00

タグ

Configure JP1,Base

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

システム環境情報

エージェントサーバの環境情報を指定してください。

表示されます。

OSユーザー情報

削除するOSユーザーの情報を指定してください。

表示されます。

JP1認証サーバ情報

削除するJP1ユーザーのJP1認証サーバの情報を指定してください。

表示されます。

JP1ユーザー情報

削除するJP1ユーザーの情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1base.certHost

JP1認証サーバのホスト名

JP1認証サーバのホスト名を指定します。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

JP1認証サーバ情報

jp1base.certHostLHostName

JP1認証サーバの論理ホスト名

JP1認証サーバがクラスタ構成の場合，JP1認証サーバの論理ホスト名を指定します。

入力

無効

△　

JP1認証サーバ情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

common.targetHost

エージェントサーバのホスト名

エージェントサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

システム環境情報

jp1base.jp1BaseLHostName

JP1/Baseの論理ホスト名

エージェントサーバのJP1/Baseがクラスタ構成の場合，JP1/Baseの論理ホスト名を指定します。

入力

無効

△　

システム環境情報

OS.osUserName

OSユーザー名

エージェントサーバから削除するOSユーザー名を指定します。

入力

無効

○　

OSユーザー情報

OS.userType

OSユーザー種別

操作対象のOSユーザー種別をlocal(ローカル)またはdomain(ドメイン)で指定します。このプロパティはエージェントサーバのOSがWindowsの場合だけ有効です。

入力

無効

△　

OSユーザー情報

OS.homeDirectoryDelete

ホームディレクトリの削除可否

OSユーザーを削除したあとにユーザーのホームディレクトリを削除するかどうかを，yes(削除する)またはno(削除しない)で指定します。このプロパティはエージェントサーバのOSがUNIXの場合だけ有効です。

入力

無効

△　

OSユーザー情報

jp1base.jp1UserName

JP1ユーザー名

JP1認証サーバから削除するJP1ユーザー名を指定します。

入力

無効

○　

JP1ユーザー情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1base.certHost

255文字以内の半角英数字および「.」，「-」。

jp1base.certHostLHostName

255文字以内の半角英数字および「.」，「-」。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

common.targetHost

255文字以内の半角英数字および「.」，「-」。

jp1base.jp1BaseLHostName

255文字以内の半角英数字および「.」，「-」。

OS.osUserName

20文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.userType

次の値のどれかを選択する。

local,domain

OS.homeDirectoryDelete

次の値のどれかを選択する。

yes,no

jp1base.jp1UserName

31文字以内の半角英数字，および「!」，「#」，「$」，「%」，「'」，「-」，「@」，「_」，「~」。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

JP1ユーザー削除

JP1ユーザー削除

階層フロー部品

JP1ユーザーと関連する情報を削除します。

−　

1-1

JP1ユーザー操作権限削除

JP1認証サーバでJP1/Baseの操作権限を削除します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-2

JP1ユーザー削除

JP1認証サーバからJP1ユーザーを削除します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-3

JP1/Baseユーザーマッピング削除

エージェントサーバでJP1ユーザーとOSユーザーのマッピングを削除します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-4

OS種別の出力

OSを判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-7

値判定分岐部品

Windowsかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-8

OSユーザー情報の削除

OSユーザーのパスワードをJP1/Baseから削除します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

OSユーザー削除

OSユーザー削除

階層フロー部品

OSユーザーを削除します。

−　

2-1

OSユーザーの削除

エージェントサーバ(またはエージェントサーバのドメイン)からユーザーを削除します。

エラーの原因を取り除いたあと，net user deleteコマンド(Windows)またはuserdelコマンド(UNIX)で手動でOSユーザーを削除してください。

2.5.33　運用ユーザー追加

機能

このサービステンプレートは，OSユーザーおよびJP1ユーザーの追加と周辺設定を行います。

ジョブ実行環境でジョブ実行サーバを追加する際などの，運用ユーザー追加時に発生する作業を省力化する目的で使用します。

次のシステムの場合に有効です。

・JP1/AJS3によるジョブ実行環境で，エージェントサーバでジョブを実行する場合。

・JP1/IMによる監視環境で，エージェントサーバに自動アクションやコマンド実行を行う場合。

このサービステンプレートが前提とするサーバを次に示します。

・JP1認証サーバ

　JP1/Baseの認証サーバが動作するサーバです。JP1ユーザー情報の管理を行います。

・エージェントサーバ

　JP1/Baseが導入され，ジョブの実行や自動アクションが行われるサーバです。

上記システムへ運用ユーザー(OSユーザーおよびJP1ユーザー)を追加するため，次の作業を実行します。

(1)OSユーザーの追加 (エージェントサーバ)

(2)JP1ユーザーと操作権限の設定 (JP1認証サーバ)

(3)ユーザーマッピングの設定(エージェントサーバ)

JP1/AOサーバ，JP1認証サーバ，エージェントサーバのどれかのOSがWindowsの場合，このサービステンプレートの実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。各サーバにAdministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行うサービス「運用ユーザー追加(SYSTEM)」を実行してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1) JP1認証サーバ，エージェントサーバに次のJP1/Baseが稼働していること。

JP1/Base 09-00以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【システム内前提製品の使用条件】

(1) JP1/AOサーバの任意のフォルダ配下に，JP1認証サーバに転送する下記のファイルが格納されていること。このファイルを格納したフォルダのパスを，プロパティ「ao.confPath」に指定してください。格納するファイルの改行コードは，JP1認証サーバのOS仕様に合わせてください。

　・ユーザー権限レベルファイル (JP1_UserLevel)

【サービステンプレート実行システム内前提製品の使用条件】

(1) エージェントサーバのJP1/Baseに，接続先の認証サーバが設定されていること。

(2) プロパティ「Windows.targetTmpPath」「Linux.targetTmpPath」に指定したフォルダに，ユーザー権限レベルファイルを転送します。指定したパスにフォルダが存在しない場合はフォルダを作成してファイルを転送します。指定したフォルダの削除は行いません。

(3) エージェントサーバのJP1/Baseがクラスタ構成の場合，実行系の環境へのサービス実行だけ可能です。JP1認証サーバがクラスタ構成の場合は，実行系に設定することで，待機系にも設定が反映されます。

注意事項

(1) ドメイン環境のOSユーザーを操作する場合は，プロパティ"OS.userType"をdomainに設定してください。

(2) UNIX環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

(3) エージェントサーバのOSがWindowsでマルチバイト文字を指定する場合は，パラメーターの長さは次のように指定してください。

　JP1/AOサーバの定義ファイル格納フォルダのパス：242バイト

　エージェントサーバの一時フォルダ(Windows) ：242バイト

　OSユーザー名：20バイト

　OSユーザーパスワード：64バイト

　OSユーザーのパスワード再入力：64バイト

　OSユーザーのフルネーム：256バイト

　OSユーザーのコメント：256バイト

　OSユーザーのグループ名：256バイト

(4) リモートに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

(5) このサービスを実行する場合，エージェントレス接続先としてJP1/AOサーバ("localhost"で解決されるループバックアドレス)および接続先となるサーバを設定する必要があります。

(6) Windows環境に対してこのサービスを実行し，指定したOSユーザーが既に存在する場合，既存のOSユーザーを使用します。なお，OSユーザーのグループ設定は実施しますが，OSユーザーのパスワードは変更されません。

(7) UNIX環境に対してこのサービスを実行し，指定したOSユーザーが既に存在する場合，既存のOSユーザーを使用します。なお，OSユーザーのパスワードは変更しますが，OSユーザーのグループ設定とホームディレクトリは変更されません。

バージョン

03.00.00

タグ

Configure JP1,Base

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

システム環境情報

エージェントサーバの環境情報及び，JP1ユーザーの追加に必要な定義ファイルの情報を指定してください。

表示されます。

OSユーザー情報

追加するOSユーザーの情報を指定してください。

表示されます。

JP1認証サーバ情報

追加するJP1ユーザーのJP1認証サーバ情報を指定してください。

表示されます。

JP1ユーザー情報

追加するJP1ユーザーの情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1base.certHost

JP1認証サーバのホスト名

JP1認証サーバのホスト名を指定します。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

JP1認証サーバ情報

jp1base.certHostLHostName

JP1認証サーバの論理ホスト名

JP1認証サーバがクラスタ構成の場合，JP1認証サーバの論理ホスト名を指定します。

入力

無効

△　

JP1認証サーバ情報

ao.confPath

JP1/AOサーバの定義ファイル格納フォルダのパス

JP1認証サーバに転送(設定)する定義ファイルが格納されている，JP1/AOサーバのフォルダをフルパスで指定します。

入力

無効

○　

システム環境情報

windows.targetTmpPath

エージェントサーバの一時フォルダ(Windows)

定義ファイルの転送先に使用するエージェントサーバの一時フォルダのパスをフルパスで指定します。エージェントサーバがWindowsの場合，必ず指定します。

入力

無効

△　

システム環境情報

Linux.targetTmpPath

エージェントサーバの一時ディレクトリ(UNIX)

定義ファイルの転送先に使用するエージェントサーバの一時ディレクトリのパスをフルパスで指定します。エージェントサーバがUNIXの場合，必ず指定します。

入力

無効

△　

システム環境情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

common.targetHost

エージェントサーバのホスト名

エージェントサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

システム環境情報

jp1base.jp1BaseLHostName

JP1/Baseの論理ホスト名

エージェントサーバのJP1/Baseがクラスタ構成の場合，JP1/Baseの論理ホスト名を指定します。

入力

無効

△　

システム環境情報

OS.osUserName

OSユーザー名

エージェントサーバに作成するOSのユーザー名を指定します。

入力

無効

○　

OSユーザー情報

OS.osUserPassword

OSユーザーパスワード

OSユーザーのパスワードを指定します。

入力

無効

○　

OSユーザー情報

OS.osUserPasswordReEnter

OSユーザーのパスワード再入力

OSユーザーのパスワードを再度指定します。

入力

無効

○　

OSユーザー情報

OS.userFullName

OSユーザーのフルネーム

OSユーザーに設定するフルネームを指定します。このプロパティはエージェントサーバのOSがWindowsの場合だけ有効です。

入力

無効

△　

OSユーザー情報

OS.homeDirectory

OSユーザーのホームディレクトリ

OSユーザーのホームディレクトリをフルパスで指定します。このプロパティはエージェントサーバのOSがUNIXの場合だけ有効です。

入力

無効

△　

OSユーザー情報

OS.userComment

OSユーザーのコメント

OSユーザーに設定するコメント情報を指定します。

入力

無効

△　

OSユーザー情報

OS.osGroupName

OSユーザーのグループ名

OSユーザーが所属する既存のグループ名を指定します。

入力

無効

○　

OSユーザー情報

OS.userType

OSユーザー種別

操作対象のOSユーザー種別をlocal(ローカル)またはdomain(ドメイン)で指定します。このプロパティはエージェントサーバのOSがWindowsの場合だけ有効です。

入力

無効

△　

OSユーザー情報

jp1base.jp1UserName

JP1ユーザー名

JP1認証サーバに作成するJP1ユーザー名を指定します。

入力

無効

○　

JP1ユーザー情報

jp1base.jp1UserPassword

JP1ユーザーパスワード

JP1ユーザーのパスワードを指定します。

入力

無効

○　

JP1ユーザー情報

jp1base.jp1UserPasswordReEnter

JP1ユーザーのパスワード再入力

JP1ユーザーのパスワードを再度指定します。

入力

無効

○　

JP1ユーザー情報

jp1base.serverHostName

マッピング定義のホスト名

エージェントサーバのユーザーマッピングに定義する実行ホスト名または「*」を指定します。 IPアドレスは指定しないでください。 IPアドレスを指定した場合でも，タスクは成功しますのでご注意ください。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

JP1ユーザー情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1base.certHost

255文字以内の半角英数字および「.」，「-」。

jp1base.certHostLHostName

255文字以内の半角英数字および「.」，「-」。

ao.confPath

2文字以上242文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

windows.targetTmpPath

2文字以上242文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

Linux.targetTmpPath

32文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」，「/」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

common.targetHost

255文字以内の半角英数字および「.」，「-」。

jp1base.jp1BaseLHostName

255文字以内の半角英数字および「.」，「-」。

OS.osUserName

20文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.osUserPassword

64文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.osUserPasswordReEnter

64文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.userFullName

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.homeDirectory

7文字以上255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」，「/」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.userComment

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.osGroupName

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.userType

次の値のどれかを選択する。

local,domain

jp1base.jp1UserName

31文字以内の半角英数字，および「!」，「#」，「$」，「%」，「'」，「-」，「@」，「_」，「~」。

jp1base.jp1UserPassword

6文字以上32文字以内の半角英数字，および「!」，「#」，「$」，「%」，「'」，「-」，「/」，「=」，「?」，「@」，「[」，「]」，「^」，「_」，「{」，「}」，「~」。

jp1base.jp1UserPasswordReEnter

6文字以上32文字以内の半角英数字，および「!」，「#」，「$」，「%」，「'」，「-」，「/」，「=」，「?」，「@」，「[」，「]」，「^」，「_」，「{」，「}」，「~」。

jp1base.serverHostName

255文字以内の半角英数字および「.」，「-」。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

OS判定

OS判定

階層フロー部品

JP1認証サーバ，エージェントサーバのOS種別を判定します。

−　

1-1

OS種別の出力

JP1認証サーバのOSを判定します。

エラー原因を取り除いて，サービスを再実行してください。

1-2

OS種別の出力

エージェントサーバのOSを判定します。

エラー原因を取り除いて，サービスを再実行してください。

1-3

OS種別の出力

JP1/AOサーバのOSを出力します。

エラー原因を取り除いたあと，サービスを再実行してください。

2

OSユーザーの追加

OSユーザーの追加

階層フロー部品

OSユーザーを追加し，グループを設定します。

−　

2-3

値判定分岐部品

エージェントサーバのOSがWindowsかどうか判定します。

エラー原因を取り除いて，サービスを再実行してください。

2-4

階層フロー部品

エージェントサーバ(またはエージェントサーバのドメイン)にユーザーを追加します。

−　

2-4-1

OSユーザーの追加 (Windows)

エージェントサーバ(またはエージェントサーバのドメイン)にユーザーを追加します。追加されたユーザーはコンピュータの管理の[システムツール]-[ローカルユーザーとグループ]-[ユーザー]に表示されます。また，OSユーザーのフルネームは同画面の[フルネーム]に，OSユーザーのコメントは同画面の[説明]に表示されます。

エラー原因を取り除いて，サービスを再実行してください。

2-4-2

OSユーザーのグループ設定 (Windows)

エージェントサーバ(またはエージェントサーバのドメイン)のグループに作成したユーザーを追加します。追加されたグループはコンピュータの管理の[システムツール]-[ローカルユーザーとグループ]-[ユーザー]から追加したユーザーをダブルクリックし，プロパティの[所属するグループ]に表示されます。

エラー原因を取り除いて，サービスを再実行してください。

2-5

値判定分岐部品

エージェントサーバのOSがUNIXかどうか判定します。

エラー原因を取り除いて，サービスを再実行してください。

2-6

階層フロー部品

指定されたサーバ(またはサーバのドメイン)にユーザーを追加します。

−　

2-6-1

OSユーザーの追加 (UNIX)

指定されたサーバ(またはサーバのドメイン)にユーザーを追加します。追加されたユーザーは/etc/passwdファイルに行が追加されます。また，OSユーザーのホームディレクトリは同ファイルの追加したユーザーの行の6カラム目に，OSユーザーのコメントは同ファイル同行の5カラム目に，OSユーザーのグループは同ファイル同行の4カラム目に指定したグループのグループIDを参照することができます。/etc/groupファイルにて該当するグループIDのグループ名を参照することができます。

エラー原因を取り除いて，サービスを再実行してください。

2-6-2

OSユーザーのパスワード変更

追加されたユーザーのパスワードを設定します。

エラー原因を取り除いて，サービスを再実行してください。

3

JP1ユーザー追加

JP1ユーザー追加

階層フロー部品

JP1ユーザー名を追加し，マッピング情報を設定します。

−　

3-3

値判定分岐部品

JP1認証サーバのOSがWindowsかどうか判定します。

エラー原因を取り除いて，サービスを再実行してください。

3-4

階層フロー部品

JP1ユーザー名を追加します。

−　

3-4-1

JP1ユーザー追加

認証サーバにJP1ユーザーを追加します。追加されたユーザーはJP1/Base環境設定画面の[認証サーバ]タブの[JP1ユーザー]の一覧に表示されます。

エラー原因を取り除いて，サービスを再実行してください。

3-4-2

値判定分岐部品

JP1/AOサーバのOSがWindowsか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-4-3

ファイル転送部品

認証サーバにユーザー権限レベルファイルを転送します。JP1/AOサーバの定義ファイル格納フォルダのパスにあるJP1_UserLevelファイルをエージェントサーバの一時フォルダへ転送します。

エラー原因を取り除いて，サービスを再実行してください。

3-4-4

値判定分岐部品

JP1/AOサーバのOSがUNIXか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-4-5

ファイル転送部品

認証サーバにユーザー権限レベルファイルを転送します。JP1/AOサーバの定義ファイル格納フォルダのパスにあるJP1_UserLevelファイルをエージェントサーバの一時フォルダへ転送します。

エラー原因を取り除いて，サービスを再実行してください。

3-4-6

JP1/Base操作権限設定

JP1認証サーバでJP1/Baseの操作権限を設定します。設定した権限はJP1/Base環境設定画面の[認証サーバ]タブの[JP1ユーザー]にあるユーザー名をクリックすると，[JP1資源グループ別権限レベル]の一覧に表示されます。

エラー原因を取り除いて，サービスを再実行してください。

3-4-7

ファイル削除

転送したファイルを削除します。エージェントサーバの一時フォルダにあるJP1_UserLevelファイルを削除します。

エラー原因を取り除いて，サービスを再実行してください。

3-5

値判定分岐部品

エージェントサーバのOSがWindowsかどうか判定します。

エラー原因を取り除いて，サービスを再実行してください。

3-6

階層フロー部品

JP1ユーザーマッピング情報を設定します。

−　

3-6-1

JP1/Baseのパスワード管理情報変更

OSユーザーのパスワードをJP1/Baseに登録します。パスワード管理に登録したユーザーはJP1/Base環境設定画面の[ユーザーマッピング]タブの[パスワード管理]にある[設定]ボタンをクリックすると一覧に表示されます。

エラー原因を取り除いて，サービスを再実行してください。

3-6-2

JP1/Baseのユーザーマッピング追加

新規追加するJP1ユーザーと新規追加するOSユーザーのマッピングを設定します。設定したJP1ユーザー名とマッピング定義のホスト名はJP1/Base環境設定画面の[ユーザーマッピング]タブの[JP1ユーザー]に表示され，これをクリックすると[マッピングOSユーザー一覧]に設定したOSユーザー名が表示されます。

エラー原因を取り除いて，サービスを再実行してください。

3-7

値判定分岐部品

JP1認証サーバのOSがUNIXかどうか判定します。

エラー原因を取り除いて，サービスを再実行してください。

3-8

階層フロー部品

JP1ユーザー名を追加します。

−　

3-8-1

JP1ユーザー追加

JP1認証サーバにJP1ユーザーを追加します。追加したJP1ユーザーは「jbslistuser」コマンドで確認することができます。

エラー原因を取り除いて，サービスを再実行してください。

3-8-2

ファイル転送部品

JP1認証サーバにユーザー権限レベルファイルを転送します。JP1/AOサーバの定義ファイル格納フォルダのパスにあるJP1_UserLevelファイルをエージェントサーバの一時フォルダへ転送します。

エラー原因を取り除いて，サービスを再実行してください。

3-8-3

JP1/Base操作権限設定

JP1認証サーバでJP1/Baseの操作権限を設定します。設定した権限は「jbslistacl」コマンドで確認することができます。

エラー原因を取り除いて，サービスを再実行してください。

3-8-4

ファイル削除

転送したファイルを削除します。エージェントサーバの一時フォルダにあるJP1_UserLevelファイルを削除します。

エラー原因を取り除いて，サービスを再実行してください。

3-9

値判定分岐部品

エージェントサーバのOSがUNIXかどうか判定します。

エラー原因を取り除いて，サービスを再実行してください。

3-10

階層フロー部品

JP1ユーザーマッピング情報を設定します。

−　

3-10-1

JP1/Baseのユーザーマッピング追加

新規追加するJP1ユーザーと新規追加するOSユーザーのマッピングを設定します。設定したJP1ユーザー名，マッピング定義のホスト名，設定したOSユーザー名は「jbsgetumap」コマンド結果のそれぞれ1カラム目，2カラム目，3カラム目に表示されます。

エラー原因を取り除いて，サービスを再実行してください。

2.5.34　運用ユーザー追加(SYSTEM)

機能

このサービステンプレートは，OSユーザーおよびJP1ユーザーの追加と周辺設定を行います。

ジョブ実行環境でジョブ実行サーバを追加する際などの，運用ユーザー追加時に発生する作業を省力化する目的で使用します。

次のシステムの場合に有効です。

・JP1/AJS3によるジョブ実行環境で，エージェントサーバでジョブを実行する場合。

・JP1/IMによる監視環境で，エージェントサーバに自動アクションやコマンド実行を行う場合。

このサービステンプレートが前提とするサーバを次に示します。

・JP1認証サーバ

　JP1/Baseの認証サーバが動作するサーバです。JP1ユーザー情報の管理を行います。

・エージェントサーバ

　JP1/Baseが導入され，ジョブの実行や自動アクションが行われるサーバです。

上記システムへ運用ユーザー(OSユーザーおよびJP1ユーザー)を追加するため，次の作業を実行します。

(1)OSユーザーの追加 (エージェントサーバ)

(2)JP1ユーザーと操作権限の設定 (JP1認証サーバ)

(3)ユーザーマッピングの設定(エージェントサーバ)

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1) JP1認証サーバ，エージェントサーバに次のJP1/Baseが稼働していること。

JP1/Base 09-00以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【システム内前提製品の使用条件】

(1) JP1/AOサーバの任意のフォルダ配下に，JP1認証サーバに転送する下記のファイルが格納されていること。このファイルを格納したフォルダのパスを，プロパティ「ao.confPath」に指定してください。格納するファイルの改行コードは，JP1認証サーバのOS仕様に合わせてください。

　・ユーザー権限レベルファイル (JP1_UserLevel)

【サービステンプレート実行システム内前提製品の使用条件】

(1) エージェントサーバのJP1/Baseに，接続先の認証サーバが設定されていること。

(2) プロパティ「Windows.targetTmpPath」「Linux.targetTmpPath」に指定したフォルダに，ユーザー権限レベルファイルを転送します。指定したパスにフォルダが存在しない場合はフォルダを作成してファイルを転送します。指定したフォルダの削除は行いません。

(3) エージェントサーバのJP1/Baseがクラスタ構成の場合，実行系の環境へのサービス実行だけ可能です。JP1認証サーバがクラスタ構成の場合は，実行系に設定することで，待機系にも設定が反映されます。

注意事項

(1) ドメイン環境のOSユーザーを操作する場合は，プロパティ"OS.userType"をdomainに設定してください。

(2) UNIX環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

(3) エージェントサーバのOSがWindowsでマルチバイト文字を指定する場合は，パラメーターの長さは次のように指定してください。

　JP1/AOサーバの定義ファイル格納フォルダのパス：242バイト

　エージェントサーバの一時フォルダ(Windows) ：242バイト

　OSユーザー名：20バイト

　OSユーザーパスワード：64バイト

　OSユーザーのパスワード再入力：64バイト

　OSユーザーのフルネーム：256バイト

　OSユーザーのコメント：256バイト

　OSユーザーのグループ名：256バイト

(4) リモートに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

(5) このサービスを実行する場合，エージェントレス接続先としてJP1/AOサーバ("localhost"で解決されるループバックアドレス)および接続先となるサーバを設定する必要があります。

(6) Windows環境に対してこのサービスを実行し，指定したOSユーザーが既に存在する場合，既存のOSユーザーを使用します。なお，OSユーザーのグループ設定は実施しますが，OSユーザーのパスワードは変更されません。

(7) UNIX環境に対してこのサービスを実行し，指定したOSユーザーが既に存在する場合，既存のOSユーザーを使用します。なお，OSユーザーのパスワードは変更しますが，OSユーザーのグループ設定とホームディレクトリは変更されません。

バージョン

03.00.00

タグ

Configure JP1,Base

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

システム環境情報

エージェントサーバの環境情報及び，JP1ユーザーの追加に必要な定義ファイルの情報を指定してください。

表示されます。

OSユーザー情報

追加するOSユーザーの情報を指定してください。

表示されます。

JP1認証サーバ情報

追加するJP1ユーザーのJP1認証サーバ情報を指定してください。

表示されます。

JP1ユーザー情報

追加するJP1ユーザーの情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1base.certHost

JP1認証サーバのホスト名

JP1認証サーバのホスト名を指定します。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

JP1認証サーバ情報

jp1base.certHostLHostName

JP1認証サーバの論理ホスト名

JP1認証サーバがクラスタ構成の場合，JP1認証サーバの論理ホスト名を指定します。

入力

無効

△　

JP1認証サーバ情報

ao.confPath

JP1/AOサーバの定義ファイル格納フォルダのパス

JP1認証サーバに転送(設定)する定義ファイルが格納されている，JP1/AOサーバのフォルダをフルパスで指定します。

入力

無効

○　

システム環境情報

windows.targetTmpPath

エージェントサーバの一時フォルダ(Windows)

定義ファイルの転送先に使用するエージェントサーバの一時フォルダのパスをフルパスで指定します。エージェントサーバがWindowsの場合，必ず指定します。

入力

無効

△　

システム環境情報

Linux.targetTmpPath

エージェントサーバの一時ディレクトリ(UNIX)

定義ファイルの転送先に使用するエージェントサーバの一時ディレクトリのパスをフルパスで指定します。エージェントサーバがUNIXの場合，必ず指定します。

入力

無効

△　

システム環境情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

common.targetHost

エージェントサーバのホスト名

エージェントサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

システム環境情報

jp1base.jp1BaseLHostName

JP1/Baseの論理ホスト名

エージェントサーバのJP1/Baseがクラスタ構成の場合，JP1/Baseの論理ホスト名を指定します。

入力

無効

△　

システム環境情報

OS.osUserName

OSユーザー名

エージェントサーバに作成するOSのユーザー名を指定します。

入力

無効

○　

OSユーザー情報

OS.osUserPassword

OSユーザーパスワード

OSユーザーのパスワードを指定します。

入力

無効

○　

OSユーザー情報

OS.osUserPasswordReEnter

OSユーザーのパスワード再入力

OSユーザーのパスワードを再度指定します。

入力

無効

○　

OSユーザー情報

OS.userFullName

OSユーザーのフルネーム

OSユーザーに設定するフルネームを指定します。このプロパティはエージェントサーバのOSがWindowsの場合だけ有効です。

入力

無効

△　

OSユーザー情報

OS.homeDirectory

OSユーザーのホームディレクトリ

OSユーザーのホームディレクトリをフルパスで指定します。このプロパティはエージェントサーバのOSがUNIXの場合だけ有効です。

入力

無効

△　

OSユーザー情報

OS.userComment

OSユーザーのコメント

OSユーザーに設定するコメント情報を指定します。

入力

無効

△　

OSユーザー情報

OS.osGroupName

OSユーザーのグループ名

OSユーザーが所属する既存のグループ名を指定します。

入力

無効

○　

OSユーザー情報

OS.userType

OSユーザー種別

操作対象のOSユーザー種別をlocal(ローカル)またはdomain(ドメイン)で指定します。このプロパティはエージェントサーバのOSがWindowsの場合だけ有効です。

入力

無効

△　

OSユーザー情報

jp1base.jp1UserName

JP1ユーザー名

JP1認証サーバに作成するJP1ユーザー名を指定します。

入力

無効

○　

JP1ユーザー情報

jp1base.jp1UserPassword

JP1ユーザーパスワード

JP1ユーザーのパスワードを指定します。

入力

無効

○　

JP1ユーザー情報

jp1base.jp1UserPasswordReEnter

JP1ユーザーのパスワード再入力

JP1ユーザーのパスワードを再度指定します。

入力

無効

○　

JP1ユーザー情報

jp1base.serverHostName

マッピング定義のホスト名

エージェントサーバのユーザーマッピングに定義する実行ホスト名または「*」を指定します。 IPアドレスは指定しないでください。 IPアドレスを指定した場合でも，タスクは成功しますのでご注意ください。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

JP1ユーザー情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1base.certHost

255文字以内の半角英数字および「.」，「-」。

jp1base.certHostLHostName

255文字以内の半角英数字および「.」，「-」。

ao.confPath

2文字以上242文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

windows.targetTmpPath

2文字以上242文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

Linux.targetTmpPath

32文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」，「/」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

common.targetHost

255文字以内の半角英数字および「.」，「-」。

jp1base.jp1BaseLHostName

255文字以内の半角英数字および「.」，「-」。

OS.osUserName

20文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.osUserPassword

64文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.osUserPasswordReEnter

64文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.userFullName

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.homeDirectory

7文字以上255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」，「/」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.userComment

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.osGroupName

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.userType

次の値のどれかを選択する。

local,domain

jp1base.jp1UserName

31文字以内の半角英数字，および「!」，「#」，「$」，「%」，「'」，「-」，「@」，「_」，「~」。

jp1base.jp1UserPassword

6文字以上32文字以内の半角英数字，および「!」，「#」，「$」，「%」，「'」，「-」，「/」，「=」，「?」，「@」，「[」，「]」，「^」，「_」，「{」，「}」，「~」。

jp1base.jp1UserPasswordReEnter

6文字以上32文字以内の半角英数字，および「!」，「#」，「$」，「%」，「'」，「-」，「/」，「=」，「?」，「@」，「[」，「]」，「^」，「_」，「{」，「}」，「~」。

jp1base.serverHostName

255文字以内の半角英数字および「.」，「-」。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

OS判定

OS判定

階層フロー部品

JP1認証サーバ，エージェントサーバのOS種別を判定します。

−　

1-1

OS種別の出力

JP1認証サーバのOSを判定します。

エラー原因を取り除いて，サービスを再実行してください。

1-2

OS種別の出力

エージェントサーバのOSを判定します。

エラー原因を取り除いて，サービスを再実行してください。

1-3

OS種別の出力

JP1/AOサーバのOSを出力します。

エラー原因を取り除いたあと，サービスを再実行してください。

2

OSユーザーの追加

OSユーザーの追加

階層フロー部品

OSユーザーを追加し，グループを設定します。

−　

2-3

値判定分岐部品

エージェントサーバのOSがWindowsかどうか判定します。

エラー原因を取り除いて，サービスを再実行してください。

2-4

階層フロー部品

エージェントサーバ(またはエージェントサーバのドメイン)にユーザーを追加します。

−　

2-4-1

OSユーザーの追加 (Windows)

エージェントサーバ(またはエージェントサーバのドメイン)にユーザーを追加します。追加されたユーザーはコンピュータの管理の[システムツール]-[ローカルユーザーとグループ]-[ユーザー]に表示されます。また，OSユーザーのフルネームは同画面の[フルネーム]に，OSユーザーのコメントは同画面の[説明]に表示されます。

エラー原因を取り除いて，サービスを再実行してください。

2-4-2

OSユーザーのグループ設定 (Windows)

エージェントサーバ(またはエージェントサーバのドメイン)のグループに作成したユーザーを追加します。追加されたグループはコンピュータの管理の[システムツール]-[ローカルユーザーとグループ]-[ユーザー]から追加したユーザーをダブルクリックし，プロパティの[所属するグループ]に表示されます。

エラー原因を取り除いて，サービスを再実行してください。

2-5

値判定分岐部品

エージェントサーバのOSがUNIXかどうか判定します。

エラー原因を取り除いて，サービスを再実行してください。

2-6

階層フロー部品

指定されたサーバ(またはサーバのドメイン)にユーザーを追加します。

−　

2-6-1

OSユーザーの追加 (UNIX)

指定されたサーバ(またはサーバのドメイン)にユーザーを追加します。追加されたユーザーは/etc/passwdファイルに行が追加されます。また，OSユーザーのホームディレクトリは同ファイルの追加したユーザーの行の6カラム目に，OSユーザーのコメントは同ファイル同行の5カラム目に，OSユーザーのグループは同ファイル同行の4カラム目に指定したグループのグループIDを参照することができます。/etc/groupファイルにて該当するグループIDのグループ名を参照することができます。

エラー原因を取り除いて，サービスを再実行してください。

2-6-2

OSユーザーのパスワード変更

追加されたユーザーのパスワードを設定します。

エラー原因を取り除いて，サービスを再実行してください。

3

JP1ユーザー追加

JP1ユーザー追加

階層フロー部品

JP1ユーザー名を追加し，マッピング情報を設定します。

−　

3-3

値判定分岐部品

JP1認証サーバのOSがWindowsかどうか判定します。

エラー原因を取り除いて，サービスを再実行してください。

3-4

階層フロー部品

JP1ユーザー名を追加します。

−　

3-4-1

JP1ユーザー追加

認証サーバにJP1ユーザーを追加します。追加されたユーザーはJP1/Base環境設定画面の[認証サーバ]タブの[JP1ユーザー]の一覧に表示されます。

エラー原因を取り除いて，サービスを再実行してください。

3-4-2

値判定分岐部品

JP1/AOサーバのOSがWindowsか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-4-3

ファイル転送部品

認証サーバにユーザー権限レベルファイルを転送します。JP1/AOサーバの定義ファイル格納フォルダのパスにあるJP1_UserLevelファイルをエージェントサーバの一時フォルダへ転送します。

エラー原因を取り除いて，サービスを再実行してください。

3-4-4

値判定分岐部品

JP1/AOサーバのOSがUNIXか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-4-5

ファイル転送部品

認証サーバにユーザー権限レベルファイルを転送します。JP1/AOサーバの定義ファイル格納フォルダのパスにあるJP1_UserLevelファイルをエージェントサーバの一時フォルダへ転送します。

エラー原因を取り除いて，サービスを再実行してください。

3-4-6

JP1/Base操作権限設定

JP1認証サーバでJP1/Baseの操作権限を設定します。設定した権限はJP1/Base環境設定画面の[認証サーバ]タブの[JP1ユーザー]にあるユーザー名をクリックすると，[JP1資源グループ別権限レベル]の一覧に表示されます。

エラー原因を取り除いて，サービスを再実行してください。

3-4-7

ファイル削除

転送したファイルを削除します。エージェントサーバの一時フォルダにあるJP1_UserLevelファイルを削除します。

エラー原因を取り除いて，サービスを再実行してください。

3-5

値判定分岐部品

エージェントサーバのOSがWindowsかどうか判定します。

エラー原因を取り除いて，サービスを再実行してください。

3-6

階層フロー部品

JP1ユーザーマッピング情報を設定します。

−　

3-6-1

JP1/Baseのパスワード管理情報変更

OSユーザーのパスワードをJP1/Baseに登録します。パスワード管理に登録したユーザーはJP1/Base環境設定画面の[ユーザーマッピング]タブの[パスワード管理]にある[設定]ボタンをクリックすると一覧に表示されます。

エラー原因を取り除いて，サービスを再実行してください。

3-6-2

JP1/Baseのユーザーマッピング追加

新規追加するJP1ユーザーと新規追加するOSユーザーのマッピングを設定します。設定したJP1ユーザー名とマッピング定義のホスト名はJP1/Base環境設定画面の[ユーザーマッピング]タブの[JP1ユーザー]に表示され，これをクリックすると[マッピングOSユーザー一覧]に設定したOSユーザー名が表示されます。

エラー原因を取り除いて，サービスを再実行してください。

3-7

値判定分岐部品

JP1認証サーバのOSがUNIXかどうか判定します。

エラー原因を取り除いて，サービスを再実行してください。

3-8

階層フロー部品

JP1ユーザー名を追加します。

−　

3-8-1

JP1ユーザー追加

JP1認証サーバにJP1ユーザーを追加します。追加したJP1ユーザーは「jbslistuser」コマンドで確認することができます。

エラー原因を取り除いて，サービスを再実行してください。

3-8-2

ファイル転送部品

JP1認証サーバにユーザー権限レベルファイルを転送します。JP1/AOサーバの定義ファイル格納フォルダのパスにあるJP1_UserLevelファイルをエージェントサーバの一時フォルダへ転送します。

エラー原因を取り除いて，サービスを再実行してください。

3-8-3

JP1/Base操作権限設定

JP1認証サーバでJP1/Baseの操作権限を設定します。設定した権限は「jbslistacl」コマンドで確認することができます。

エラー原因を取り除いて，サービスを再実行してください。

3-8-4

ファイル削除

転送したファイルを削除します。エージェントサーバの一時フォルダにあるJP1_UserLevelファイルを削除します。

エラー原因を取り除いて，サービスを再実行してください。

3-9

値判定分岐部品

エージェントサーバのOSがUNIXかどうか判定します。

エラー原因を取り除いて，サービスを再実行してください。

3-10

階層フロー部品

JP1ユーザーマッピング情報を設定します。

−　

3-10-1

JP1/Baseのユーザーマッピング追加

新規追加するJP1ユーザーと新規追加するOSユーザーのマッピングを設定します。設定したJP1ユーザー名，マッピング定義のホスト名，設定したOSユーザー名は「jbsgetumap」コマンド結果のそれぞれ1カラム目，2カラム目，3カラム目に表示されます。

エラー原因を取り除いて，サービスを再実行してください。

2.5.35　運用ユーザー変更

機能

このサービステンプレートは，OSユーザーのパスワード変更，JP1ユーザーのパスワード変更，それに伴うWindows版JP1/Baseのパスワード管理情報に登録された内容の変更を行ないます。なお，CentOS環境では，OSユーザーのパスワード変更処理だけ実行できます。

次のシステムの場合に有効です。

・JP1/AJS3によるジョブ実行環境で，エージェントサーバでジョブを実行する場合。

・JP1/IMによる監視環境で，エージェントサーバに自動アクションやコマンド実行を行う場合。

このサービステンプレートが前提とするサーバを次に示します。

・JP1認証サーバ

　JP1/Baseの認証サーバが動作するサーバです。JP1ユーザー情報の管理を行います。

・エージェントサーバ

　JP1/Baseが導入され，ジョブの実行や自動アクションが行われるサーバです。

上記システムでの運用ユーザー情報の更新のため，次の作業を実行します。

(1)OSユーザーのパスワード変更 (エージェントサーバ)

(2)JP1/Baseに登録されているパスワード管理情報の更新 (エージェントサーバ)

(3)JP1ユーザーのパスワード変更(JP1認証サーバ)

なお，OSユーザー名を入力した場合，(1)および(2)を実行します。JP1ユーザー名を入力した場合，(3)を実行します。

OSユーザー名およびJP1ユーザー名を入力した場合は，(1)〜(3)すべてを実行します。

JP1/AOサーバ，JP1認証サーバ，エージェントサーバのどれかのOSがWindowsの場合，このサービステンプレートの実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。各サーバにAdministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行うサービス「運用ユーザー変更(SYSTEM)」を実行してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1) JP1認証サーバ，エージェントサーバに次のJP1/Baseが稼働していること。

JP1/Base 09-00以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

　ただし，OSユーザーのパスワード変更処理だけ実行可能。

(9) CentOS 7 (64-bit x86_64)

　ただし，OSユーザーのパスワード変更処理だけ実行可能。

(10) CentOS 8 (64-bit x86_64)

　ただし，OSユーザーのパスワード変更処理だけ実行可能。

(11) Oracle Linux 8 (64-bit x86_64)

(12) AIX V6

(13) AIX V7

【サービステンプレート実行システム内前提製品の使用条件】

(1) エージェントサーバのJP1/Baseに，接続先の認証サーバが設定されていること。

(2) OSユーザーのパスワード変更(およびWindowsの場合はJP1/Baseのパスワード管理情報の更新)を行う場合，common.targetHost，OS.osUserName，OS.osUserPassword，OS.osUserPasswordReEnter，OS.userType(Windowsの場合だけ)の各プロパティを必ず指定してください。

(3) JP1ユーザーのパスワード変更を行う場合，jp1base.certHost，jp1base.jp1UserName，jp1base.jp1UserPassword，jp1base.jp1UserPasswordNew，jp1base.jp1UserPasswordReEnterの各プロパティを必ず指定してください。

(4) エージェントサーバのJP1/Baseがクラスタ構成の場合，実行系の環境へのサービス実行だけ可能です。実行系の環境へ一度サービスを実行したあとに，系を切り替えたあとの実行系の環境へサービスを実行する際は，システム環境設定情報，OSユーザー情報のパラメーターに値を入力し，JP1ユーザー情報のパラメーターはすべて空欄にしてサービスを実行してください。

注意事項

(1) ドメイン環境のOSユーザーを操作する場合は，プロパティ"OS.userType"にdomainを設定してください。

(2) UNIX環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

(3) エージェントサーバのOSがWindowsでマルチバイト文字を指定する場合は，OSユーザー名の長さは20バイト以内，OSユーザー新パスワードおよびOSユーザー新パスワード再入力の長さは64バイト以内となるよう指定してください。

(4) このサービスを実行する場合，エージェントレス接続先としてJP1/AOサーバ("localhost"で解決されるループバックアドレス)および接続先となるサーバを設定する必要があります。

(5) UNIX環境に対してこのサービスを実行する場合，事前にOSユーザーが存在することを確認してください。

バージョン

03.00.00

タグ

Configure JP1,Base

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

システム環境情報

エージェントサーバの環境情報を指定してください。

表示されます。

OSユーザー情報

パスワードを変更するOSユーザーの情報を指定してください。

表示されます。

JP1認証サーバ情報

パスワードを変更するJP1ユーザーのJP1認証サーバの情報を指定してください。

表示されます。

JP1ユーザー情報

パスワードを変更するJP1ユーザーの情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1base.certHost

JP1認証サーバのホスト名

JP1認証サーバのホスト名を指定します。JP1ユーザーのパスワードを変更する場合，必ず設定してください。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

△　

JP1認証サーバ情報

jp1base.certHostLHostName

JP1認証サーバの論理ホスト名

JP1認証サーバがクラスタ構成の場合，JP1認証サーバの論理ホスト名を指定します。

入力

無効

△　

JP1認証サーバ情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

common.targetHost

エージェントサーバのホスト名

エージェントサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。OSユーザーのパスワードを変更する場合，必ず設定してください。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

△　

システム環境情報

jp1base.jp1BaseLHostName

JP1/Baseの論理ホスト名

エージェントサーバのJP1/Baseがクラスタ構成の場合，JP1/Baseの論理ホスト名を指定します。

入力

無効

△　

システム環境情報

OS.osUserName

OSユーザー名

エージェントサーバのOSのユーザー名を指定します。OSユーザーのパスワードを変更する場合，必ず設定してください。

入力

無効

△　

OSユーザー情報

OS.osUserPassword

OSユーザー新パスワード

OSユーザーの新パスワードを指定します。

入力

無効

△　

OSユーザー情報

OS.osUserPasswordReEnter

OSユーザー新パスワード再入力

OSユーザーの新パスワードを再度指定します。

入力

無効

△　

OSユーザー情報

OS.userType

OSユーザー種別

操作対象のOSユーザー種別をlocal(ローカル)またはdomain(ドメイン)で指定します。このプロパティはエージェントサーバのOSがWindowsの場合だけ有効です。

入力

無効

△　

OSユーザー情報

jp1base.jp1UserName

JP1ユーザー名

JP1認証サーバのJP1ユーザー名を指定します。JP1ユーザーのパスワードを変更する場合，必ず設定してください。

入力

無効

△　

JP1ユーザー情報

jp1base.jp1UserPassword

JP1ユーザーパスワード

JP1ユーザーのパスワードを指定します。

入力

無効

△　

JP1ユーザー情報

jp1base.jp1UserPasswordNew

JP1ユーザー新パスワード

設定するJP1ユーザーの新パスワードを指定します。

入力

無効

△　

JP1ユーザー情報

jp1base.jp1UserPasswordReEnter

JP1ユーザー新パスワード再入力

JP1ユーザーの新パスワードを再度指定します。

入力

無効

△　

JP1ユーザー情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1base.certHost

255文字以内の半角英数字および「.」，「-」。

jp1base.certHostLHostName

255文字以内の半角英数字および「.」，「-」。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

common.targetHost

255文字以内の半角英数字および「.」，「-」。

jp1base.jp1BaseLHostName

255文字以内の半角英数字および「.」，「-」。

OS.osUserName

20文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.osUserPassword

64文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.osUserPasswordReEnter

64文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.userType

次の値のどれかを選択する。

local,domain

jp1base.jp1UserName

31文字以内の半角英数字，および「!」，「#」，「$」，「%」，「'」，「-」，「@」，「_」，「~」。

jp1base.jp1UserPassword

6文字以上32文字以内の半角英数字，および「!」，「#」，「$」，「%」，「'」，「-」，「/」，「=」，「?」，「@」，「[」，「]」，「^」，「_」，「{」，「}」，「~」。

jp1base.jp1UserPasswordNew

6文字以上32文字以内の半角英数字，および「!」，「#」，「$」，「%」，「'」，「-」，「/」，「=」，「?」，「@」，「[」，「]」，「^」，「_」，「{」，「}」，「~」。

jp1base.jp1UserPasswordReEnter

6文字以上32文字以内の半角英数字，および「!」，「#」，「$」，「%」，「'」，「-」，「/」，「=」，「?」，「@」，「[」，「]」，「^」，「_」，「{」，「}」，「~」。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

OS判定

OS判定

階層フロー部品

JP1認証サーバ，エージェントサーバのOS種別を判定します。

−　

1-1

OS種別の出力

JP1認証サーバのOSを判定します。

エラー原因を取り除いて，サービスを再実行してください。

1-2

OS種別の出力

エージェントサーバのOSを判定します。

エラー原因を取り除いて，サービスを再実行してください。

1-3

OS種別の出力

JP1/AOサーバのOSを出力します。

エラー原因を取り除いたあと，サービスを再実行してください。

2

OSユーザーのパスワード変更

OSユーザーのパスワード変更

階層フロー部品

OSユーザーのパスワードを変更します。

−　

2-3

値判定分岐部品

OSユーザー名が指定されているか判定します。

エラーの原因を取り除き，サービスを再実行してください。

2-3-1

OSユーザーのパスワード変更

エージェントサーバ(またはサーバのドメイン)でユーザーのパスワードを変更します。

エラーの原因を取り除き，サービスを再実行してください。

3

JP1/Baseに登録されているOSユーザー情報の変更

JP1/Baseに登録されているOSユーザー情報の変更

階層フロー部品

JP1/Baseに登録されているOSユーザー情報を更新します。

−　

3-1

値判定分岐部品

OSユーザー名が指定されているか判定します。

エラーの原因を取り除き，サービスを再実行してください。

3-2

階層フロー部品

JP1/Baseに登録されているOSユーザー情報を更新します。

−　

3-2-3

値判定分岐部品

Windowsかどうか判定します。

JP1ユーザーの新旧パスワードに変更後の値を設定し，サービスを再実行してください。

3-2-4

JP1/Baseのパスワード管理情報変更

指定されたサーバのJP1/Baseのマッピングユーザーのパスワードを変更します。

JP1ユーザーの新旧パスワードに変更後の値を設定し，サービスを再実行してください。

4

JP1ユーザーのパスワード変更

JP1ユーザーのパスワード変更

階層フロー部品

JP1ユーザーのパスワードを変更します。

−　

4-3

値判定分岐部品

JP1ユーザー名が指定されているか判定します。

エラーの原因を取り除き，サービスを再実行してください。

4-3-1

JP1ユーザーパスワード変更

指定された認証サーバでJP1ユーザーのパスワードを変更します。

エラーの原因を取り除き，サービスを再実行してください。

2.5.36　運用ユーザー変更(SYSTEM)

機能

このサービステンプレートは，OSユーザーのパスワード変更，JP1ユーザーのパスワード変更，それに伴うWindows版JP1/Baseのパスワード管理情報に登録された内容の変更を行ないます。なお，CentOS環境では，OSユーザーのパスワード変更処理だけ実行できます。

次のシステムの場合に有効です。

・JP1/AJS3によるジョブ実行環境で，エージェントサーバでジョブを実行する場合。

・JP1/IMによる監視環境で，エージェントサーバに自動アクションやコマンド実行を行う場合。

このサービステンプレートが前提とするサーバを次に示します。

・JP1認証サーバ

　JP1/Baseの認証サーバが動作するサーバです。JP1ユーザー情報の管理を行います。

・エージェントサーバ

　JP1/Baseが導入され，ジョブの実行や自動アクションが行われるサーバです。

上記システムでの運用ユーザー情報の更新のため，次の作業を実行します。

(1)OSユーザーのパスワード変更 (エージェントサーバ)

(2)JP1/Baseに登録されているパスワード管理情報の更新 (エージェントサーバ)

(3)JP1ユーザーのパスワード変更(JP1認証サーバ)

なお，OSユーザー名を入力した場合，(1)および(2)を実行します。JP1ユーザー名を入力した場合，(3)を実行します。

OSユーザー名およびJP1ユーザー名を入力した場合は，(1)〜(3)すべてを実行します。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1) JP1認証サーバ，エージェントサーバに次のJP1/Baseが稼働していること。

JP1/Base 09-00以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

　ただし，OSユーザーのパスワード変更処理だけ実行可能。

(9) CentOS 7 (64-bit x86_64)

　ただし，OSユーザーのパスワード変更処理だけ実行可能。

(10) CentOS 8 (64-bit x86_64)

　ただし，OSユーザーのパスワード変更処理だけ実行可能。

(11) Oracle Linux 8 (64-bit x86_64)

(12) AIX V6

(13) AIX V7

【サービステンプレート実行システム内前提製品の使用条件】

(1) エージェントサーバのJP1/Baseに，接続先の認証サーバが設定されていること。

(2) OSユーザーのパスワード変更(およびWindowsの場合はJP1/Baseのパスワード管理情報の更新)を行う場合，common.targetHost，OS.osUserName，OS.osUserPassword，OS.osUserPasswordReEnter，OS.userType(Windowsの場合だけ)の各プロパティを必ず指定してください。

(3) JP1ユーザーのパスワード変更を行う場合，jp1base.certHost，jp1base.jp1UserName，jp1base.jp1UserPassword，jp1base.jp1UserPasswordNew，jp1base.jp1UserPasswordReEnterの各プロパティを必ず指定してください。

(4) エージェントサーバのJP1/Baseがクラスタ構成の場合，実行系の環境へのサービス実行だけ可能です。実行系の環境へ一度サービスを実行したあとに，系を切り替えたあとの実行系の環境へサービスを実行する際は，システム環境設定情報，OSユーザー情報のパラメーターに値を入力し，JP1ユーザー情報のパラメーターはすべて空欄にしてサービスを実行してください。

注意事項

(1) ドメイン環境のOSユーザーを操作する場合は，プロパティ"OS.userType"にdomainを設定してください。

(2) UNIX環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

(3) エージェントサーバのOSがWindowsでマルチバイト文字を指定する場合は，OSユーザー名の長さは20バイト以内，OSユーザー新パスワードおよびOSユーザー新パスワード再入力の長さは64バイト以内となるよう指定してください。

(4) このサービスを実行する場合，エージェントレス接続先としてJP1/AOサーバ("localhost"で解決されるループバックアドレス)および接続先となるサーバを設定する必要があります。

(5) UNIX環境に対してこのサービスを実行する場合，事前にOSユーザーが存在することを確認してください。

バージョン

03.00.00

タグ

Configure JP1,Base

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

システム環境情報

エージェントサーバの環境情報を指定してください。

表示されます。

OSユーザー情報

パスワードを変更するOSユーザーの情報を指定してください。

表示されます。

JP1認証サーバ情報

パスワードを変更するJP1ユーザーのJP1認証サーバの情報を指定してください。

表示されます。

JP1ユーザー情報

パスワードを変更するJP1ユーザーの情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1base.certHost

JP1認証サーバのホスト名

JP1認証サーバのホスト名を指定します。JP1ユーザーのパスワードを変更する場合，必ず設定してください。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

△　

JP1認証サーバ情報

jp1base.certHostLHostName

JP1認証サーバの論理ホスト名

JP1認証サーバがクラスタ構成の場合，JP1認証サーバの論理ホスト名を指定します。

入力

無効

△　

JP1認証サーバ情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

common.targetHost

エージェントサーバのホスト名

エージェントサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。OSユーザーのパスワードを変更する場合，必ず設定してください。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

△　

システム環境情報

jp1base.jp1BaseLHostName

JP1/Baseの論理ホスト名

エージェントサーバのJP1/Baseがクラスタ構成の場合，JP1/Baseの論理ホスト名を指定します。

入力

無効

△　

システム環境情報

OS.osUserName

OSユーザー名

エージェントサーバのOSのユーザー名を指定します。OSユーザーのパスワードを変更する場合，必ず設定してください。

入力

無効

△　

OSユーザー情報

OS.osUserPassword

OSユーザー新パスワード

OSユーザーの新パスワードを指定します。

入力

無効

△　

OSユーザー情報

OS.osUserPasswordReEnter

OSユーザー新パスワード再入力

OSユーザーの新パスワードを再度指定します。

入力

無効

△　

OSユーザー情報

OS.userType

OSユーザー種別

操作対象のOSユーザー種別をlocal(ローカル)またはdomain(ドメイン)で指定します。このプロパティはエージェントサーバのOSがWindowsの場合だけ有効です。

入力

無効

△　

OSユーザー情報

jp1base.jp1UserName

JP1ユーザー名

JP1認証サーバのJP1ユーザー名を指定します。JP1ユーザーのパスワードを変更する場合，必ず設定してください。

入力

無効

△　

JP1ユーザー情報

jp1base.jp1UserPassword

JP1ユーザーパスワード

JP1ユーザーのパスワードを指定します。

入力

無効

△　

JP1ユーザー情報

jp1base.jp1UserPasswordNew

JP1ユーザー新パスワード

設定するJP1ユーザーの新パスワードを指定します。

入力

無効

△　

JP1ユーザー情報

jp1base.jp1UserPasswordReEnter

JP1ユーザー新パスワード再入力

JP1ユーザーの新パスワードを再度指定します。

入力

無効

△　

JP1ユーザー情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1base.certHost

255文字以内の半角英数字および「.」，「-」。

jp1base.certHostLHostName

255文字以内の半角英数字および「.」，「-」。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

common.targetHost

255文字以内の半角英数字および「.」，「-」。

jp1base.jp1BaseLHostName

255文字以内の半角英数字および「.」，「-」。

OS.osUserName

20文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.osUserPassword

64文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.osUserPasswordReEnter

64文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.userType

次の値のどれかを選択する。

local,domain

jp1base.jp1UserName

31文字以内の半角英数字，および「!」，「#」，「$」，「%」，「'」，「-」，「@」，「_」，「~」。

jp1base.jp1UserPassword

6文字以上32文字以内の半角英数字，および「!」，「#」，「$」，「%」，「'」，「-」，「/」，「=」，「?」，「@」，「[」，「]」，「^」，「_」，「{」，「}」，「~」。

jp1base.jp1UserPasswordNew

6文字以上32文字以内の半角英数字，および「!」，「#」，「$」，「%」，「'」，「-」，「/」，「=」，「?」，「@」，「[」，「]」，「^」，「_」，「{」，「}」，「~」。

jp1base.jp1UserPasswordReEnter

6文字以上32文字以内の半角英数字，および「!」，「#」，「$」，「%」，「'」，「-」，「/」，「=」，「?」，「@」，「[」，「]」，「^」，「_」，「{」，「}」，「~」。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

OS判定

OS判定

階層フロー部品

JP1認証サーバ，エージェントサーバのOS種別を判定します。

−　

1-1

OS種別の出力

JP1認証サーバのOSを判定します。

エラー原因を取り除いて，サービスを再実行してください。

1-2

OS種別の出力

エージェントサーバのOSを判定します。

エラー原因を取り除いて，サービスを再実行してください。

1-3

OS種別の出力

JP1/AOサーバのOSを出力します。

エラー原因を取り除いたあと，サービスを再実行してください。

2

OSユーザーのパスワード変更

OSユーザーのパスワード変更

階層フロー部品

OSユーザーのパスワードを変更します。

−　

2-3

値判定分岐部品

OSユーザー名が指定されているか判定します。

エラーの原因を取り除き，サービスを再実行してください。

2-3-1

OSユーザーのパスワード変更

エージェントサーバ(またはサーバのドメイン)でユーザーのパスワードを変更します。

エラーの原因を取り除き，サービスを再実行してください。

3

JP1/Baseに登録されているOSユーザー情報の変更

JP1/Baseに登録されているOSユーザー情報の変更

階層フロー部品

JP1/Baseに登録されているOSユーザー情報を更新します。

−　

3-1

値判定分岐部品

OSユーザー名が指定されているか判定します。

エラーの原因を取り除き，サービスを再実行してください。

3-2

階層フロー部品

JP1/Baseに登録されているOSユーザー情報を更新します。

−　

3-2-3

値判定分岐部品

Windowsかどうか判定します。

JP1ユーザーの新旧パスワードに変更後の値を設定し，サービスを再実行してください。

3-2-4

JP1/Baseのパスワード管理情報変更

指定されたサーバのJP1/Baseのマッピングユーザーのパスワードを変更します。

JP1ユーザーの新旧パスワードに変更後の値を設定し，サービスを再実行してください。

4

JP1ユーザーのパスワード変更

JP1ユーザーのパスワード変更

階層フロー部品

JP1ユーザーのパスワードを変更します。

−　

4-3

値判定分岐部品

JP1ユーザー名が指定されているか判定します。

エラーの原因を取り除き，サービスを再実行してください。

4-3-1

JP1ユーザーパスワード変更

指定された認証サーバでJP1ユーザーのパスワードを変更します。

エラーの原因を取り除き，サービスを再実行してください。

2.6　JP1（レポート）用のサービステンプレート

2.6.1　JP1/PFMのレポート取得

機能

このサービステンプレートは，JP1/PFM - Managerで収集したJP1/PFM - RMのレポートを取得します。

このサービステンプレートが前提とするサーバを次に示します。

・PFM管理サーバ

　JP1/PFM - Web Consoleがインストールされているサーバです。

次の作業を実施します。

(1)PFM管理サーバから，サービスIDで指定したJP1/PFM - RMのレポートを指定されたファイルにCSV形式で出力します。ファイルの出力フォーマットは，JP1/PFMのjpcrptコマンドの出力結果と同じ形式です。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)JP1/PFM - Web Console 09-10-05以降

(2)JP1/PFM - Manager 09-10-11以降

(3)JP1/PFM - Remote Monitor for Platform 09-10以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【サービステンプレート実行システム内前提製品の使用条件】

(1)JP1/PFM - Managerおよび，対象とするJP1/PFM - RMが起動していること。

(2)JP1/PFMのjpcrptコマンドの使用条件を満たしていること。

(3)このサービス実行時にJP1/PFM - Managerに対する認証が必要です。

　 認証用のキーファイルを作成していない場合は，コマンドを実行する前に，jpcmkkeyコマンドで認証用のキーファイルを作成してください。

注意事項

(1)レポート出力量が多い場合，システムに影響を与えることがあります。

　 入力ファイルのレポート間隔や表示期間(開始日時，終了日時)などの設定を調整して，レポート出力量を抑えてください。

(2)HTML形式のレポート出力はできません。入力ファイルの定義内容に<html-output>を指定しないでください。

(3)Linux環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。また，レポート出力対象のJP1/PFMのレポート名，および，レポートフォルダ名にもマルチバイト文字を使用しないでください。

(4)リモートおよびローカルに指定するファイル名が既に存在する場合，既存のファイルを上書きします。またレポートの転送をする場合，リモート側のファイルは削除します。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(5)リモートに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

バージョン

03.00.00

タグ

Gather JP1 information,PFM

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

監視システム環境情報

PFM管理サーバの環境情報を指定してください。

表示されます。

レポート取得情報

取得するレポート情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1pfm.jp1pfmWebconHostName

JP1/PFM - Web Consoleのホスト名

JP1/PFM - Web Consoleがインストールされているサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

監視システム環境情報

jp1pfm.inputFileNameLocal

入力ファイル名(ローカル)

PFM管理サーバへ転送する際の転送元の入力ファイル名をフルパスで指定します。

入力

無効

○　

レポート取得情報

jp1pfm.inputFileNameRemote

入力ファイル名(リモート)

PFM管理サーバへ転送する際の転送先の入力ファイル名をフルパスで指定します。

入力

無効

○　

レポート取得情報

jp1pfm.reportOutputFileNameRemote

出力ファイル名(リモート)

レポートを取得するPFM管理サーバのファイル名をフルパスで指定します。

入力

無効

○　

レポート取得情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1pfm.serviceId

サービスID

レポート出力対象のエージェントをサービスIDで指定します。

入力

無効

○　

レポート取得情報

common.transferLogFile

レポートファイル転送の要否

レポートの転送要否を指定します。転送する場合だけ，出力ファイル名(リモート)のファイルを削除します。

入力

無効

○　

レポート取得情報

jp1pfm.reportOutputFileNameLocal

出力ファイル名(ローカル)

レポートを取得するJP1/AOサーバのファイル名をフルパスで指定します。レポートをJP1/AOサーバに転送する場合は必ず指定してください。

入力

無効

△　

レポート取得情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1pfm.jp1pfmWebconHostName

255文字以内の半角英数字および「.」，「-」。

jp1pfm.inputFileNameLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

jp1pfm.inputFileNameRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」を除く。

jp1pfm.reportOutputFileNameRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」，「/」を除く。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1pfm.serviceId

258文字以内の半角英数字および「@」，「[」，「]」，「.」，「-」。

common.transferLogFile

次の値のどれかを選択する。

yes,no

jp1pfm.reportOutputFileNameLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

入力ファイル転送

入力ファイル転送

階層フロー部品

入力ファイルを転送します。

−　

1-3

値判定分岐部品

入力ファイルか指定されているかチェックします。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-4

ファイル転送部品

入力ファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

レポート取得

レポート取得

階層フロー部品

レポートを取得します。

−　

2-1

レポート取得

レポートを取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

レポート転送

レポート転送

階層フロー部品

レポートを転送します。

−　

3-1

値判定分岐部品

ファイル転送有無をチェックします。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-2

ファイル転送部品

転送要の場合，レポートを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4

ファイル削除

ファイル削除

階層フロー部品

転送要の場合，レポートを削除します。

−　

4-1

ファイル削除

入力ファイルを削除します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-2

値判定分岐部品

ファイル転送有無をチェックします。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-3

ファイル削除

出力ファイルを削除します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2.7　JP1（トラブルシューティング）用のサービステンプレート

2.7.1　JP1/AJS・JP1/Baseログ取得

機能

指定したサーバのJP1/BaseとJP1/AJS3 - Manager(またはJP1/AJS2 - Manager)の資料採取ツールを実行します。オプションで生成されたファイルをJP1/AOのサーバに転送することができます。

このサービステンプレートが前提とするサーバを次に示します。

・業務サーバ

　JP1/AJS3 - Manager(またはJP1/AJS2 - Manager)が動作するサーバです。

処理の概要を次に示します。

(1)生成するファイルを配置するためのフォルダ(プロパティOS.folderPathRemote)を業務サーバ(リモート)に作成します。

(2)リモートでJP1/Base，JP1/AJS3 - Manager(またはJP1/AJS2 - Manager)の資料採取ツールを実行します。業務サーバに作成したフォルダ内に資料採取ツールの結果が格納されます。

(3)JP1/AOサーバ(ローカル)に生成されたファイルを転送する場合，生成されたファイルを配置するためのフォルダ(プロパティOS.folderPathLocal¥ajstemp)をJP1/AOサーバ(ローカル)に作成し，リモートからローカルに転送します。生成されたファイルをJP1/AOサーバに転送する場合，プロパティcommon.transferLogFileをyesに設定してください。作成したフォルダおよび生成されたファイルを転送する・しないに関わらず業務サーバに作成したフォルダは削除しません。

取得する情報は次のとおりです。なお，プロパティjp1.informationLevelに"1st"を指定した場合，1次資料(資料採取ツールで作成する"1st"のフォルダまたはファイル)の情報をJP1/AOサーバに転送します。また，"2nd"を指定した場合，1次資料および2次資料(同"2nd"のフォルダまたはファイル)の情報をJP1/AOサーバに転送します。また，"3rd"を指定した場合，1次資料および2次資料(同"2nd"のフォルダまたはファイル)および3次資料(同"3rd"のフォルダまたはファイル)の情報をJP1/AOサーバに転送します。

・JP1/AJS3 - Manager(またはJP1/AJS2 - Manager)の資料採取ツール(オプション指定なし)で取得できるすべての情報

・JP1/Baseの資料採取ツール(オプション指定なし)で取得できるすべての情報

JP1/AJS3 - Manager(またはJP1/AJS2 - Manager)の資料採取ツールおよびJP1/Baseの資料採取ツールの出力メッセージは，業務サーバに作成したフォルダ直下に次の名称で格納します。

・JP1/AJS3 - Manager(またはJP1/AJS2 - Manager)の資料採取ツールの出力メッセージ→jp1ajsGetLog_result.log

・JP1/Baseの資料採取ツールの出力メッセージ→jp1baseGetLog_result.log

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1) 業務サーバに次の製品が稼働していること。

　JP1/Automatic Job Management System 3 - Manager 09-00以降 または，

　JP1/Automatic Job Management System 2 - Manager 08-00以降

　JP1/Base 08-50以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【サービステンプレート実行システム内前提製品の使用条件】

(1) JP1/AJS3 - Manager(またはJP1/AJS2 - Manager)のOSがWindowsの場合，資料採取コマンドの出力先がデフォルト(%TEMP%¥jp1ajs2¥backlog)である必要があります。

(2) このサービスでは，プロパティOS.folderPathLocalに指定されたパス配下にajstempという名称で，収集したファイルのJP1/AOサーバ側の格納用フォルダを，プロパティOS.folderPathRemoteに，収集したファイルの業務サーバ側の格納フォルダを作成します。

(3) 業務サーバのJP1/AJS3 - Manager(またはJP1/AJS2 - Manager)がクラスタ構成の場合，プロパティcommon.targetHostには論理ホストが動作している物理ホスト名を，プロパティjp1ajs.jp1ajsLHostNameには論理ホスト名を指定してください。

(4) 資料採取ツールの結果をJP1/AOサーバに転送する場合，エージェントレス接続先としてJP1/AOサーバ("localhost"で解決されるループバックアドレス)および接続先となるサーバを設定する必要があります。

注意事項

(1) このサービスを同一のサーバに複数同時に実行しないでください。

(2) プロパティOS.folderPathLocalに指定されたパス配下にajstempというフォルダが存在する場合は，ajstempフォルダを削除したあと再生成します。

(3) プロパティOS.folderPathLocalまたはOS.folderPathRemoteに指定したフォルダと同名のファイルが存在する場合，サービスは異常終了します。

(4) 資料採取ツールで採取する資料の総容量はご使用の環境によって大きく変化します。実行する前に容量を見積もり，ご使用のマシンの空き容量を確認してください。採取する資料サイズについては，各製品のリリースノートを参照してください。

(5) JP1/AOサーバにファイルを転送する場合，ファイルの総容量が大きいとサービス(ファイル転送(ユニット))の実行に時間がかかることがあります。

(6) 論理ホスト名を指定する場合は，フォルダのパスの長さは次の条件を満たすように指定してください。

　・フォルダパス(リモート)の長さ≦218-{(論理ホスト名の長さ)-11}*2

　・フォルダパス(ローカル)の長さ≦208-{(論理ホスト名の長さ)-11}*2

(7) プロパティOS.folderPathRemote，プロパティOS.folderPathLocalに環境変数は使用しないでください。

(8) プロパティcommon.transferLogFileの値に"yes"を指定した際に，プロパティOS.folderPathLocalとプロパティjp1.informationLevelの値に空白を指定しないでください。指定した場合はサービスが異常終了します。

(9) UNIX環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

(10) JP1/AJSのトラブルシュート情報取得またはJP1/Baseのトラブルシュート情報取得の部品でサービスが異常終了し，かつタスクログに"KNAE08132-E コマンドの標準出力のサイズが上限値を超えたため，処理を中断しました（上限値：100キロバイト）。"と表示された場合は，次のファイルの内容を確認してください。

　・JP1/AJS3 - Manager(またはJP1/AJS2 - Manager)の資料採取ツールの出力メッセージ→jp1ajsGetLog_result.log

　・JP1/Baseの資料採取ツールの出力メッセージ→jp1baseGetLog_result.log

バージョン

03.00.00

タグ

Troubleshoot JP1,AJS,Base

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

業務システム環境情報

業務サーバの環境情報を指定してください。

表示されます。

採取資料格納情報

生成された資料の格納先やJP1/AOサーバに転送する資料のレベルを指定してください。

表示されます。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

common.targetHost

業務サーバのホスト名

業務サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

業務システム環境情報

OS.folderPathRemote

フォルダパス(リモート)

資料採取ツールの結果を保存するリモートのフォルダをフルパスで指定します。

入力

無効

○　

採取資料格納情報

jp1ajs.jp1ajsLHostName

JP1/AJSの論理ホスト名

JP1/AJSがクラスタ構成の場合，JP1/AJSの論理ホスト名を指定します。

入力

無効

△　

業務システム環境情報

common.transferLogFile

ログファイル転送の要否

資料採取ツールの結果をJP1/AOサーバに転送するかどうかを指定します。

入力

無効

○　

採取資料格納情報

OS.folderPathLocal

フォルダパス(ローカル)

資料採取ツールの結果を保存するJP1/AOサーバのフォルダをフルパスで指定します。資料採取ツールの結果をJP1/AOサーバに転送する場合は必ず指定してください。

入力

無効

△　

採取資料格納情報

jp1.informationLevel

採取する資料のレベル

JP1/AOサーバに転送する資料のレベルを指定します。1次資料(1st)，2次資料(2nd)，3次資料(3rd)のどれかを選択してください。資料採取ツールの結果をJP1/AOサーバに転送する場合は必ず指定してください。

入力

無効

△　

採取資料格納情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

common.targetHost

255文字以内の半角英数字および「.」，「-」。

OS.folderPathRemote

228文字以内の文字列。ただし「<」，「>」，「|」，「;」，「&」，「%」，「"」，「*」，「)」，「`」および末尾の「¥」，「/」を除く。

jp1ajs.jp1ajsLHostName

255文字以内の半角英数字および「.」，「-」。

common.transferLogFile

次の値のどれかを選択する。

yes,no

OS.folderPathLocal

208文字以内の文字列。ただし「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，末尾の「¥」，「/」を除く。

jp1.informationLevel

次の値のどれかを選択する。

1st,2nd,3rd

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

OS種別の出力

OS種別の出力

階層フロー部品

OS種別を出力します。

−　

1-1

OS種別の出力

業務サーバのOSを出力します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-2

OS種別の出力

JP1/AOサーバのOSを出力します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

フォルダ作成

フォルダ作成

階層フロー部品

フォルダを作成します。

−　

2-1

フォルダ作成

フォルダを監視サーバに作成します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

ログ取得

ログ取得

階層フロー部品

ログを取得します。

−　

3-1

JP1/Baseのトラブルシュート情報取得

JP1/Baseのログを取得し，指定したフォルダに格納します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-2

JP1/AJSのトラブルシュート情報取得

JP1/AJSのログを取得し，指定したフォルダに格納します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4

ファイル転送

ファイル転送

階層フロー部品

ファイルを転送します。

−　

4-3

値判定分岐部品

ログファイル転送の要否が指定した値と一致するかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4

階層フロー部品

ファイルを転送します。

−　

4-4-1

値判定分岐部品

JP1/AOサーバのOSがWindowsか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2

階層フロー部品

JP1/AOサーバのOSがWindowsの場合の，ファイル転送処理を行います。

−　

4-4-2-1

フォルダ削除

JP1/AOサーバのフォルダを削除します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-2

階層フロー部品

フォルダを作成します。

−　

4-4-2-2-1

フォルダ作成

フォルダをJP1/AOサーバに作成します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-2-2

フォルダ作成

フォルダをJP1/AOサーバに作成します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-2-5

値判定分岐部品

論理ホスト名が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-2-6

フォルダ作成

フォルダをJP1/AOサーバに作成します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3

階層フロー部品

ファイルを転送します。

−　

4-4-2-3-1

値判定分岐部品

業務サーバがWindowsかどうか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2

階層フロー部品

Windowsの場合の，ファイル転送処理を行います。

−　

4-4-2-3-2-1

値判定分岐部品

3次が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-2

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-2-2-1

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-2-2-1-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-2-1-2

値判定分岐部品

論理ホスト名が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-2-1-3

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-2-2

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-2-2-2-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-2-2-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-2-2-3

値判定分岐部品

論理ホスト名が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-2-2-4

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-2-2-2-4-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-2-2-4-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-3

値判定分岐部品

2次が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-4

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-2-4-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-4-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-4-3

値判定分岐部品

論理ホスト名が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-4-4

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-2-4-4-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-4-4-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-5

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-2-5-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-5-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-5-3

値判定分岐部品

論理ホスト名が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-5-4

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-2-5-4-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-5-4-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-3

値判定分岐部品

業務サーバがUNIXかどうか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4

階層フロー部品

UNIXの場合の，ファイル転送処理を行います。

−　

4-4-2-3-4-1

値判定分岐部品

業務サーバがLinuxかどうか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2

階層フロー部品

Linuxの場合の，ファイル転送処理を行います。

−　

4-4-2-3-4-2-1

値判定分岐部品

3次が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-2

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-4-2-2-1

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-4-2-2-1-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-2-1-2

値判定分岐部品

論理ホスト名が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-2-1-3

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-2-2

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-4-2-2-2-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-2-2-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-2-2-3

値判定分岐部品

論理ホスト名が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-2-2-4

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-4-2-2-2-4-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-2-2-4-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-3

値判定分岐部品

2次が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-4

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-4-2-4-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-4-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-4-3

値判定分岐部品

論理ホスト名が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-4-4

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-4-2-4-4-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-4-4-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-5

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-4-2-5-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-5-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-5-3

値判定分岐部品

論理ホスト名が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-5-4

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-4-2-5-4-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-5-4-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-3

値判定分岐部品

業務サーバがLinux以外かどうか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4

階層フロー部品

Linux以外の場合の，ファイル転送処理を行います。

−　

4-4-2-3-4-4-1

値判定分岐部品

3次が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-2

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-4-4-2-1

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-4-4-2-1-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-2-1-2

値判定分岐部品

論理ホスト名が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-2-1-3

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-2-2

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-4-4-2-2-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-2-2-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-2-2-3

値判定分岐部品

論理ホスト名が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-2-2-4

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-4-4-2-2-4-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-2-2-4-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-3

値判定分岐部品

2次が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-4

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-4-4-4-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-4-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-4-3

値判定分岐部品

論理ホスト名が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-4-4

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-4-4-4-4-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-4-4-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-5

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-4-4-5-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-5-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-5-3

値判定分岐部品

論理ホスト名が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-5-4

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-4-4-5-4-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-5-4-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-3

値判定分岐部品

JP1/AOサーバのOSがUNIXか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-4

階層フロー部品

JP1/AOサーバのOSがUNIXの場合の，ファイル転送処理を行います。

−　

2.7.2　JP1/IM・JP1/Baseログ取得

機能

指定したサーバのJP1/BaseとJP1/IM - Managerの資料採取ツールを実行します。オプションで生成されたファイルをJP1/AOのサーバに転送することができます。

このサービステンプレートが前提とするサーバを次に示します。

・監視サーバ

　JP1/IM - Managerが動作するサーバです。

処理の概要を次に示します。

(1)生成するファイルを配置するためのフォルダ(プロパティOS.folderPathRemote)を監視サーバ(リモート)に作成します。

(2)リモートでJP1/Base，JP1/IM - Managerの資料採取ツールを実行します。監視サーバに作成したフォルダ内に資料採取ツールの結果が格納されます。

(3)JP1/AOサーバ(ローカル)に生成されたファイルを転送する場合，生成されたファイルを配置するためのフォルダ(プロパティOS.folderPathLocal¥immtemp)をJP1/AOサーバ(ローカル)に作成し，リモートからローカルに転送します。生成されたファイルをJP1/AOサーバに転送する場合，プロパティcommon.transferLogFileをyesに設定してください。作成したフォルダおよび生成されたファイルを転送する・しないに関わらず監視サーバに作成したフォルダは削除しません。

取得する情報は次のとおりです。なお，プロパティjp1.informationLevelに"1st"を指定した場合，1次資料(資料採取ツールで作成する"1st"のフォルダまたはファイル)の情報をJP1/AOサーバに転送します。また，"2nd"を指定した場合，1次資料および2次資料(同"2nd"のフォルダまたはファイル)の情報をJP1/AOサーバに転送します。

・JP1/IM - Managerの資料採取ツール(オプション指定なし)で取得できるすべての情報

・JP1/Baseの資料採取ツール(オプション指定なし)で取得できるすべての情報

JP1/IM - Managerの資料採取ツールおよびJP1/Baseの資料採取ツールの出力メッセージは，監視サーバに作成したフォルダ直下に次の名称で格納します。

・JP1/IM - Managerの資料採取ツールの出力メッセージ→jp1imGetLog_result.log

・JP1/Baseの資料採取ツールの出力メッセージ→jp1baseGetLog_result.log

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1) 監視サーバに次の製品が稼働していること。

　JP1/Integrated Management - Manager 08-00以降

　JP1/Base 08-50以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【サービステンプレート実行システム内前提製品の使用条件】

(1) このサービスでは，プロパティOS.folderPathLocalに指定されたパス配下にimmtempという名称で，収集したファイルのJP1/AOサーバ側の格納用フォルダを，プロパティOS.folderPathRemoteに，収集したファイルの監視サーバ側の格納フォルダを作成します。

(2) 監視サーバのJP1/IM - Managerがクラスタ構成の場合，プロパティcommon.targetHostには論理ホストが動作している物理ホスト名を，プロパティjp1im.jp1imLHostNameには論理ホスト名を指定してください。

(3) 資料採取ツールの結果をJP1/AOサーバに転送する場合，エージェントレス接続先としてJP1/AOサーバ("localhost"で解決されるループバックアドレス)および接続先となるサーバを設定する必要があります。

注意事項

(1) このサービスを同一のサーバに複数同時に実行しないでください。

(2) プロパティOS.folderPathLocalに指定されたパス配下にimmtempというフォルダが存在する場合は，immtempフォルダを削除したあと再生成します。

(3) プロパティOS.folderPathLocalまたはOS.folderPathRemoteに指定したフォルダと同名のファイルが存在する場合，サービスは異常終了します。

(4) 資料採取ツールで採取する資料の総容量はご使用の環境によって大きく変化します。実行する前に容量を見積もり，ご使用のマシンの空き容量を確認してください。採取する資料サイズについては，各製品のリリースノートを参照してください。

(5) JP1/AOサーバにファイルを転送する場合，ファイルの総容量が大きいとサービス(ファイル転送(ユニット))の実行に時間がかかることがあります。

(6) 論理ホスト名を指定する場合は，フォルダのパスの長さは次の条件を満たすように指定してください。

　・フォルダパス(リモート)の長さ≦218-{(論理ホスト名の長さ)-11}*2

　・フォルダパス(ローカル)の長さ≦208-{(論理ホスト名の長さ)-11}*2

(7) プロパティOS.folderPathRemote，プロパティOS.folderPathLocalに環境変数は使用しないでください。

(8) プロパティcommon.transferLogFileの値に"yes"を指定した場合に，プロパティOS.folderPathLocalとプロパティjp1.informationLevelの値に空白を指定しないでください。指定した場合はサービスが異常終了します。

(9) UNIX環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

(10) JP1/IMトラブルシュート情報の収集またはJP1/Baseのトラブルシュート情報取得の部品でサービスが異常終了し，かつタスクログに"KNAE08132-E コマンドの標準出力のサイズが上限値を超えたため，処理を中断しました（上限値：100キロバイト）。"と表示された場合は，次のファイルの内容を確認してください。

　・JP1/IM - Managerの資料採取ツールの出力メッセージ→jp1imGetLog_result.log

　・JP1/Baseの資料採取ツールの出力メッセージ→jp1baseGetLog_result.log

バージョン

03.00.00

タグ

Troubleshoot JP1,IM,Base

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

監視システム環境情報

監視サーバの環境情報を指定してください。

表示されます。

採取資料格納情報

生成された資料の格納先やJP1/AOサーバに転送する資料のレベルを指定してください。

表示されます。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

common.targetHost

監視サーバのホスト名

監視サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

監視システム環境情報

OS.folderPathRemote

フォルダパス(リモート)

資料採取ツールの結果を保存するリモートのフォルダをフルパスで指定します。

入力

無効

○　

採取資料格納情報

jp1im.jp1imLHostName

JP1/IMの論理ホスト名

JP1/IMがクラスタ構成の場合，JP1/IMの論理ホスト名を指定します。

入力

無効

△　

監視システム環境情報

common.transferLogFile

ログファイル転送の要否

資料採取ツールの結果をJP1/AOサーバに転送するかどうかを指定します。

入力

無効

○　

採取資料格納情報

OS.folderPathLocal

フォルダパス(ローカル)

資料採取ツールの結果を保存するJP1/AOサーバのフォルダをフルパスで指定します。資料採取ツールの結果をJP1/AOサーバに転送する場合は必ず指定してください。

入力

無効

△　

採取資料格納情報

jp1.informationLevel

採取する資料のレベル

JP1/AOサーバに転送する資料のレベルを指定します。1次資料(1st)，2次資料(2nd)のどれかを選択してください。資料採取ツールの結果をJP1/AOサーバに転送する場合は必ず指定してください。

入力

無効

△　

採取資料格納情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

common.targetHost

255文字以内の半角英数字および「.」，「-」。

OS.folderPathRemote

228文字以内の文字列。ただし「<」，「>」，「|」，「;」，「&」，「%」，「"」，「*」，「)」，「`」および末尾の「¥」，「/」を除く。

jp1im.jp1imLHostName

255文字以内の半角英数字および「.」，「-」。

common.transferLogFile

次の値のどれかを選択する。

yes,no

OS.folderPathLocal

208文字以内の文字列。ただし「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，末尾の「¥」，「/」を除く。

jp1.informationLevel

次の値のどれかを選択する。

1st,2nd

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

OS種別の出力

OS種別の出力

階層フロー部品

OS種別を出力します。

−　

1-1

OS種別の出力

監視サーバのOSを出力します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-2

OS種別の出力

JP1/AOサーバのOSを出力します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

フォルダ作成

フォルダ作成

階層フロー部品

フォルダを作成します。

−　

2-1

フォルダ作成

フォルダを監視サーバに作成します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

ログ取得

ログ取得

階層フロー部品

ログを取得します。

−　

3-1

JP1/Baseのトラブルシュート情報取得

JP1/Baseのログを取得し，指定したフォルダに格納します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-2

JP1/IMトラブルシュート情報の収集

JP1/IMのログを取得し，指定したフォルダに格納します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4

ファイル転送

ファイル転送

階層フロー部品

ファイルを転送します。

−　

4-3

値判定分岐部品

ログファイル転送の要否が指定した値と一致するかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4

階層フロー部品

ファイルを転送します。

−　

4-4-1

値判定分岐部品

JP1/AOサーバのOSがWindowsか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2

階層フロー部品

JP1/AOサーバのOSがWindowsの場合の，ファイル転送処理を行います。

−　

4-4-2-1

フォルダ削除

JP1/AOサーバのフォルダを削除します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-2

階層フロー部品

フォルダを作成します。

−　

4-4-2-2-1

フォルダ作成

フォルダをJP1/AOサーバに作成します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-2-2

フォルダ作成

フォルダをJP1/AOサーバに作成します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-2-5

値判定分岐部品

論理ホスト名が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-2-6

フォルダ作成

フォルダをJP1/AOサーバに作成します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3

階層フロー部品

ファイルを転送します。

−　

4-4-2-3-1

値判定分岐部品

監視サーバがWindowsかどうか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2

階層フロー部品

Windowsの場合の，ファイル転送処理を行います。

−　

4-4-2-3-2-1

値判定分岐部品

2次が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-2

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-2-2-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-2-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-2-3

値判定分岐部品

論理ホスト名が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-2-4

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-2-2-4-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-2-4-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-3

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-2-3-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-3-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-3-3

値判定分岐部品

論理ホスト名が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-3-4

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-2-3-4-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-2-3-4-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-3

値判定分岐部品

監視サーバがUNIXかどうか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4

階層フロー部品

UNIXの場合の，ファイル転送処理を行います。

−　

4-4-2-3-4-1

値判定分岐部品

監視サーバがLinuxかどうか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2

階層フロー部品

Linuxの場合の，ファイル転送処理を行います。

−　

4-4-2-3-4-2-1

値判定分岐部品

2次が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-2

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-4-2-2-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-2-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-2-3

値判定分岐部品

論理ホスト名が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-2-4

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-4-2-2-4-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-2-4-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-3

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-4-2-3-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-3-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-3-3

値判定分岐部品

論理ホスト名が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-3-4

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-4-2-3-4-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-2-3-4-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-3

値判定分岐部品

監視サーバがLinux以外かどうか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4

階層フロー部品

Linux以外の場合の，ファイル転送処理を行います。

−　

4-4-2-3-4-4-2-1

値判定分岐部品

2次が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-2-2

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-4-4-2-2-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-2-2-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-2-2-3

値判定分岐部品

論理ホスト名が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-2-2-4

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-4-4-2-2-4-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-2-2-4-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-2-3

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-4-4-2-3-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-2-3-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-2-3-3

値判定分岐部品

論理ホスト名が指定されたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-2-3-4

階層フロー部品

JP1/AOサーバに収集したファイルを転送します。

−　

4-4-2-3-4-4-2-3-4-1

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-2-3-4-4-2-3-4-2

ファイル転送部品

JP1/AOサーバに収集したファイルを転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-3

値判定分岐部品

JP1/AOサーバのOSがUNIXか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4-4-4

階層フロー部品

JP1/AOサーバのOSがUNIXの場合の，ファイル転送処理を行います。

−　

2.7.3　JP1イベントの対処状況変更

機能

JP1/IM - ManagerのイベントDBに登録されているJP1イベントの対処状況を変更します。

また，JP1/IM - Viewの[重要イベント]ページからJP1イベントを削除します。

障害回復時に発行済みのJP1イベントを対処済みに変更し，JP1/IM - Viewから削除する場合などに使用します。

このサービステンプレートが前提とするサーバを次に示します。

・監視サーバ

　JP1/IM - Managerが動作するサーバです。

処理の概要を次に示します。

(1)JP1/IM - ManagerのイベントDBに登録されているJP1イベントの対処状況を変更します。

JP1/IM - Viewの[重要イベント]ページからJP1イベントを削除する場合は，JP1/IM-Viewからの重要イベント削除の要否プロパティ(jp1im.deleteSevereEventFromIMView)をyesに設定してください。

次に示す重要イベント対処状況キーの指定によって，対処状況を変更します。

(凡例)キー：変更後の対処状況

PROCESSED：対処済

PROCESSING：処理中

HELD：保留

UNPROCESSED：未対処

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)JP1/Integrated Management - Manager 09-00以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【サービステンプレート実行システム内前提製品の使用条件】

(1)JP1/IM - Managerが稼働していること。

バージョン

02.00.00

タグ

Configure JP1,IM

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

監視システム環境情報

監視サーバの環境情報を指定してください。

表示されます。

JP1の重要イベントの情報

対処状況を変更するJP1イベントの情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1im.jp1imHostName

JP1/IMのホスト名

JP1/IMがインストールされているホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

監視システム環境情報

jp1im.jp1imLHostName

JP1/IMの論理ホスト名

JP1/IMがクラスタ構成の場合，JP1/IMの論理ホスト名を指定します。

入力

無効

△　

監視システム環境情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1im.serialNumber

イベントDB内通し番号

対処状況を変更する重要イベントのイベントDB内通し番号を指定します。イベントDB内通し番号は，最大10個指定できます。複数指定する場合は，通し番号と通し番号の間をコンマで区切ります。

入力

無効

○　

JP1の重要イベントの情報

jp1im.severeEventResponseStatusKey

重要イベント対処状況キー

重要イベントの対処状況を表すキー値を指定します。

入力

無効

○　

JP1の重要イベントの情報

jp1im.deleteSevereEventFromIMView

JP1/IM-Viewからの重要イベント削除の要否

指定した重要イベントをJP1/IM - Viewの画面から削除するかどうか指定します。

入力

無効

○　

JP1の重要イベントの情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1im.jp1imHostName

255文字以内の半角英数字および「.」，「-」。

jp1im.jp1imLHostName

255文字以内の半角英数字および「.」，「-」。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1im.serialNumber

109文字以内の半角数字および「,」。

jp1im.severeEventResponseStatusKey

次の値のどれかを選択する。

PROCESSED,PROCESSING,HELD,UNPROCESSED

jp1im.deleteSevereEventFromIMView

次の値のどれかを選択する。

yes,no

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

JP1イベントの対処状況変更

JP1イベントの対処状況変更

JP1イベントの対処状況変更

JP1イベントの対処状況を変更します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2.7.4　JP1イベントの登録

機能

このサービステンプレートは，エージェントサーバにJP1イベントを登録します。

また，送信先イベントサーバ名を指定した場合は，JP1イベントの到達確認を行います。

JP1/AOの作業で発生した障害をJP1イベントとしてJP1/IMに登録する場合などに使用します。

このサービステンプレートが前提とするサーバを次に示します。

・エージェントサーバ

　JP1/Baseが動作するサーバです。

処理の概要を次に示します。

(1)エージェントサーバにJP1イベントを登録します。

なお，送信先イベントサーバ名が指定されている場合は，JP1イベントの到達確認を行います。

登録するJP1イベントの重大度はJP1イベントの緊急性を表します。それぞれ次の緊急性を意味します。

Emergency：緊急

Alert：警戒

Critical：致命的

Error：エラー

Warning：警告

Notice：通知

Information：情報

Debug：デバッグ

送信先イベントサーバ名が指定されている場合は，最初に3秒後にJP1イベントの到達確認を行います。そのあとは，確認間隔に指定した秒数ごとに，確認回数に指定した回数JP1イベントの到達確認を繰り返します。最大確認時間は，3+(確認間隔)*(確認回数)秒となります。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)JP1/Base 09-00以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【サービステンプレート実行システム内前提製品の使用条件】

(1)JP1/Baseのイベントサービスが起動していること。

注意事項

(1)エージェントサーバの稼働OSがUNIXである環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

(2)エージェントサーバの稼働OSがWindowsである環境に対してマルチバイト文字を指定する場合は，メッセージプロパティ(jp1base.message)の長さは1023バイト以内となるよう指定してください。

(3)送信先イベントサーバ名を指定し，"KAJP1741-W 送信先イベントサーバへイベントは到達していません"のメッセージがタスクログに出力された場合は，JP1イベントの送信は続行中です。その場合はJP1イベントを送信したホストのJP1/IM - ViewからJP1イベントが到達したか確認してください。

(4)このサービスをJP1/AOサーバに対して実行する場合，エージェントレス接続先としてJP1/AOサーバ("localhost"で解決されるループバックアドレス)を設定する必要があります。

バージョン

02.00.00

タグ

Configure JP1,Base

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

システム環境情報

JP1/Baseの環境情報を指定してください。

表示されます。

JP1イベント情報

登録するJP1イベントの情報を指定してください。

表示されます。

イベント送信時指定情報

登録するJP1イベントの送信先を指定する場合のプロパティです。必要に応じて指定してください。

表示されます。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

jp1base.jp1BaseHostName

JP1/Baseのホスト名

JP1/Baseがインストールされているサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。クラスタ構成の場合は，実行系サーバの物理ホストまたは論理ホストを指定してください。

入力

無効

○　

システム環境情報

jp1base.sourceEventServerName

送信元イベントサーバ名

クラスタ構成の場合に，論理ホストのイベントサーバを指定します。送信先イベントサーバ名を指定しない場合は，このイベントサーバにJP1イベントを登録します。送信先イベントサーバ名を指定する場合は，このイベントサーバはJP1イベントの転送のために使用します。

入力

無効

△　

システム環境情報

jp1base.eventID

イベントID

登録するJP1イベントのイベントIDを指定します。16進数で入力してください。省略した場合は0が仮定されます。

入力

無効

△　

JP1イベント情報

jp1base.message

メッセージ

登録するJP1イベントのメッセージを指定します。

入力

無効

△　

JP1イベント情報

jp1base.eventLevel

重大度

登録するJP1イベントの重大度を指定します。

入力

無効

○　

JP1イベント情報

jp1base.extendedAttributeName1

拡張属性名1

登録するJP1イベントの拡張属性名を指定します。

入力

無効

△　

JP1イベント情報

jp1base.extendedAttributeValue1

拡張属性値1

登録するJP1イベントの拡張属性値を指定します。この値を指定する場合は拡張属性名1も必ず指定してください。

入力

無効

△　

JP1イベント情報

jp1base.extendedAttributeName2

拡張属性名2

登録するJP1イベントの拡張属性名を指定します。

入力

無効

△　

JP1イベント情報

jp1base.extendedAttributeValue2

拡張属性値2

登録するJP1イベントの拡張属性値を指定します。この値を指定する場合は拡張属性名2も必ず指定してください。

入力

無効

△　

JP1イベント情報

jp1base.destinationEventServerName

送信先イベントサーバ名

登録するJP1イベントを任意のイベントサーバに送信する場合は，送信先のイベントサーバ名を指定します。

入力

無効

△　

イベント送信時指定情報

jp1base.checkInterval

確認間隔

登録したJP1イベントが指定した送信先イベントサーバに到達したか確認する間隔(秒)を指定します。確認回数と組み合わせて最大確認時間となります。送信先イベントサーバ名を指定した場合は必ず指定してください。

入力

無効

△　

イベント送信時指定情報

jp1base.checkCount

確認回数

登録したJP1イベントが指定した送信先イベントサーバに到達したか確認する回数を指定します。送信先イベントサーバ名を指定した場合は必ず指定してください。

入力

無効

△　

イベント送信時指定情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

jp1base.jp1BaseHostName

255文字以内の半角英数字および「.」，「-」。

jp1base.sourceEventServerName

255文字以内の半角英数字および「.」，「-」。

jp1base.eventID

8文字以内の16進数。0〜1FFFまたは7FFF8000〜7FFFFFFFの範囲を指定してください。

jp1base.message

1023文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「"」，「`」を除く。

jp1base.eventLevel

次の値のどれかを選択する。

Emergency,Alert,Critical,Error,Warning,Notice,Information,Debug

jp1base.extendedAttributeName1

32文字以内の半角英数字(大文字)および「_」。

jp1base.extendedAttributeValue1

1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「"」，を除く。

jp1base.extendedAttributeName2

32文字以内の半角英数字(大文字)および「_」。

jp1base.extendedAttributeValue2

1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「"」，を除く。

jp1base.destinationEventServerName

255文字以内の半角英数字および「.」，「-」。

jp1base.checkInterval

3〜600の整数値。

jp1base.checkCount

0〜999の整数値。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

JP1イベントの登録

JP1イベントの登録

JP1イベントの登録

JP1イベントを登録します。

送信先イベントサーバ名を指定し，イベントの到達が確認できない場合は，指定した送信先イベントサーバのJP1/IM - ViewからJP1イベントが到達したか確認してください。その他の場合はエラーの原因を取り除いたあと，サービスを再実行してください。

2.8　OS（汎用的な処理）用のサービステンプレート

2.8.1　リモートコマンド実行

機能

指定したサーバに格納済みのコマンドを実行して結果を出力します。

このサービステンプレートが前提とするサーバを次に示します。

・実行対象サーバ

　前提条件に記載されたバージョンのWindowsまたはUNIXがインストールされたサーバです。実行対象のコマンドが格納されている必要があります。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

なし。

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

(12) HP-UX 11i V3 (IPF)

(13) Solaris 10 (SPARC)，Solaris 11 (SPARC)

(14) AIX V6

(15) AIX V7

注意事項

(1)実行したコマンドの標準出力結果が100キロバイトを超える場合，サービスは異常終了します。

(2)実行したコマンドの標準出力結果はプロパティcommon.stdoutPropertyに1024文字まで格納し，それ以上の出力内容は切り捨てとなります。

(3)ユーザーに入力を求める対話式コマンドおよびスクリプト，GUI表示などにより自動的に終了しないコマンドは実行できません。

(4)実行対象サーバの稼働OSがUNIXの場合は，エージェントレス接続先に定義された接続ユーザーのデフォルトロケールでコマンドが実行されます。詳細については，本製品マニュアルの「部品実行時に設定される操作対象の機器のロケールについて」および「部品実行時に本製品が通信で使用する文字セットについて」を参照してください。

(5)Linux以外のUNIXでは，プロパティcommon.remoteCommandとプロパティcommon.remoteCommandParameterにASCII文字以外を使用する場合は，本製品 サービステンプレートリファレンスに記載されている，UNIXでASCII文字以外の文字を含むコマンドラインを実行するための前提条件を満たす必要があります。

(6)その他の注意事項については本製品 サービステンプレートリファレンスの汎用コマンド実行部品の注意事項を参照してください。

バージョン

02.50.00

タグ

Execute Script,Linux,Windows,AIX,Solaris,HP-UX

プロパティ一覧

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

common.targetHost

実行対象サーバのホスト名

実行対象サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

common.remoteCommand

実行するコマンド

実行対象サーバで実行するコマンドのパスをフルパスで指定します。パス内に空白が含まれている場合は""で囲んでください。

入力

無効

○　

common.remoteCommandParameter

コマンドのパラメーター

実行対象サーバで実行するコマンドのパラメーターを指定します。空白を含む文字列を1つのパラメーターとして認識させたい場合は，""で囲んでください。

入力

無効

△　

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.stdoutProperty

コマンドの標準出力文字列

コマンドが出力した標準出力の文字列を格納するサービスプロパティです。

出力

無効

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

common.targetHost

255文字以内の半角英数字および「.」，「-」。

common.remoteCommand

256文字以内の文字列。

common.remoteCommandParameter

1024文字以内の文字列。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

リモートコマンド実行

リモートコマンド実行

汎用コマンド実行部品

リモートの実行対象サーバ上のコマンドを実行して結果を表示します。

エラー要因を取り除いたあと，サービスを再実行してください。

2.9　OS（構築）用のサービステンプレート

2.9.1　Chef Clientの登録

機能

このサービステンプレートは，Chef ClientサーバをChef Serverに登録します。

Chef Serverに登録する前に，ローカルサーバからChef-Clientサーバに，client.rbファイル，validation.pemファイル，crtファイルを転送します。

このサービステンプレートが前提とするサーバを次に示します。

・Chef Clientサーバ

　Chef Clientがインストールされいているサーバです。

処理の概要を次に示します。

(1) client.rbファイルをChef Clientサーバに転送します。

　"/etc/chef/"ディレクトリ直下にclient.rbファイルを転送します。

(2) validation.pemファイルをChef Clientサーバに転送します。

　"/etc/chef/"ディレクトリ直下にvalidation.pemファイルを転送します。

(3) crtファイルのフォルダパス(ローカル)(chef.crtDirPathプロパティ)を指定した場合，crtファイルのフォルダパス(ローカル)にあるcrtファイルのファイル名(chef.crtFileNameプロパティ)に指定したcrtファイルをChef Clientサーバに転送します。

　"/etc/chef/trusted_certs"ディレクトリ直下にcrtファイルを転送します。

(4) Chef ClientサーバをChef Serverに登録します。

　Chef Clientサーバ上で"chef-client"コマンドを実行し，Chef ClientサーバをChef Serverに登録します。

プロパティ設定の留意点を次に示します。

(1) crtファイルのフォルダパス(ローカル)(chef.crtDirPathプロパティ)に，Windowsのフォルダを指定する場合は，末尾の"¥"まで指定してください。Linuxのディレクトリを指定する場合は，末尾の"/"まで指定してください。

前提条件

【システム内前提製品】/【サービステンプレート実行対象サーバ内前提製品】/【サービステンプレート実行対象サーバ内前提製品の稼働OS】/【サービステンプレート実行対象システム内前提製品】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行対象サーバ内前提製品】

　・Chef Client 12.0

【サービステンプレート実行対象サーバ内前提製品の稼働OS】

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

注意事項

(1)"chef-client"コマンドを実行するChef Clientサーバ登録ステップにおいて，レシピに記述した設定内容によっては，タスクログへの出力サイズが100KBを超え，このサービスの戻り値が"72"で異常終了します。その場合，レシピの実行結果はChefの"Management Console"などからご確認ください。

バージョン

02.50.00

タグ

Configure OS,Chef

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

Chef Clinet情報

Chef Clientサーバの情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

chef.clientFilePath

client.rbファイルのパス(ローカル)

ローカルサーバから転送するclient.rbファイルをフルパスで指定します。

入力

無効

○　

Chef Clinet情報

chef.validationFilePath

validation.pemファイルのパス(ローカル)

ローカルサーバから転送するvalidation.pemファイルをフルパスで指定します。

入力

無効

○　

Chef Clinet情報

chef.crtDirPath

crtファイルのフォルダパス(ローカル)

ローカルサーバから転送するcrtファイルの格納元フォルダをフルパスで指定します。

入力

無効

△　

Chef Clinet情報

chef.crtFileName

crtファイルのファイル名

ローカルサーバから転送するcrtファイルのファイル名を指定します。

入力

無効

△　

Chef Clinet情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

chef.chefClient

Chef Clientサーバのホスト名

Chef Serverに登録するChef Clientサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

Chef Clinet情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

chef.clientFilePath

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」および末尾の「¥」を除く。

chef.validationFilePath

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」および末尾の「¥」を除く。

chef.crtDirPath

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」を除く。

chef.crtFileName

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「¥」を除く。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

chef.chefClient

256文字以内の半角英数字および「.」，「-」。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

client.rbファイルの転送

client.rbファイルの転送

ファイル転送部品

client.rbファイルをChef Clientサーバに転送します。

エラーの原因を取り除いたあと，このステップから実行してください。

2

validation.pemファイルの転送

validation.pemファイルの転送

ファイル転送部品

validation.pemファイルをChef Clientサーバに転送します。

エラーの原因を取り除いたあと，このステップから実行してください。

3

crtファイルの転送要否判定

crtファイルの転送要否判定

値判定分岐部品

crtファイルをChef Clientサーバに転送するか判定します。

エラーの原因を取り除いたあと，このステップから実行してください。

4

crtファイルの転送

crtファイルの転送

ファイル転送部品

crtファイルをChef Clientサーバに転送します。

エラーの原因を取り除いたあと，このステップから実行してください。

5

Chef Clientサーバ登録

Chef Clientサーバ登録

汎用コマンド実行部品

"chef-client"コマンドを実行し，Chef ClientサーバをChef Serverに登録します。

エラーの原因を取り除いたあと，このステップから実行してください。

2.9.2　Puppet Enterprise Agentの登録

機能

このサービステンプレートは，Puppet Enterprise AgentサーバをPuppet Enterprise Masterに登録します。

このサービステンプレートが前提とするサーバを次に示します。

・Puppet Enterprise Masterサーバ

　Puppet Enterprise Masterがインストールされいているサーバです。

・Puppet Enterprise Agentサーバ

　Puppet Enterprise Agentがインストールされいているサーバです。

処理の概要を次に示します。

(1) Puppet Enterprise AgentサーバからPuppet Enterprise MasterサーバにSSL証明書を送付します。

　Puppet Enterprise Agentサーバ上で"puppet agent -t"コマンドを実行し，Puppet Enterprise MasterにSSL証明書を送付します。

(2) Puppet Enterprise MasterサーバでPuppet Enterprise AgentのSSL証明書を承認します。

　Puppet Enterprise Masterサーバ上で"puppet cert sign <SSL証明書名>"コマンドを実行し，Puppet Enterprise AgentのSSL証明書を承認します。

　承認するSSL証明書の名称は，AgentのSSL証明書名(puppet.puppetAgentCertNameプロパティ)に指定した名称を使用します。SSL証明書の名称は，通常Puppet Enterprise Agentサーバのホスト名です。

(3) Puppet Enterprise AgentサーバでPuppet Enterprise Masterへの登録確認をします。

　Puppet Enterprise Agentサーバ上で"puppet agent -t"コマンドを実行し，Puppet Enterprise Masterへの登録確認をします。

(4) (3)の実行結果を確認します。

　(3)の戻り値が"0"の場合は正常終了します。

　(3)の戻り値が"2"の場合，Puppet Enterprise Agentサーバ内でPuppet Enterprise Agentの設定に関するディレクト，ファイルの再構成が行われた可能性があるため，"puppet agent -t"コマンドを再実行しPuppet Enterprise Materと通信できるか確認します。

　(3)の戻り値が"0"，"2"以外の場合，異常終了します。

前提条件

【システム内前提製品】/【サービステンプレート実行対象サーバ内前提製品】/【サービステンプレート実行対象サーバ内前提製品の稼働OS】/【サービステンプレート実行対象システム内前提製品】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行対象サーバ内前提製品】

　・Puppet Enterprise Master 3.8

　・Puppet Enterprise Agent 3.8

【サービステンプレート実行対象サーバ内前提製品の稼働OS】

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

注意事項

(1)"puppet agent -t"コマンドを実行するSSL証明書の送付，Agentの登録確認，Agentの通信確認の各ステップにおいて，"puppet agent -t"コマンドの標準出力をタスクログに出力しません。マニュフェストの実行結果はPuppetのWebコンソールなどからレポートをご確認ください。

バージョン

02.50.00

タグ

Configure OS,Puppet

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

Puppet Enterprise Agent情報

Puppet Enterprise Agentサーバの情報を指定してください。

表示されます。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

puppet.puppetMasterServer

Masterサーバのホスト名

Puppet Enterprise Agentを登録するPuppet Enterprise Masterサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

Puppet Enterprise Agent情報

puppet.puppetAgentServer

Agentサーバのホスト名

Puppet Enterprise Masterに登録するPuppet Enterprise Agentサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

Puppet Enterprise Agent情報

puppet.puppetAgentCertName

AgentのSSL証明書名

Puppet Enterprise Masterが承認するSSL証明書の名称を指定します。

入力

無効

○　

Puppet Enterprise Agent情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

puppet.puppetMasterServer

256文字以内の半角英数字および「.」，「-」。

puppet.puppetAgentServer

256文字以内の半角英数字および「.」，「-」。

puppet.puppetAgentCertName

63文字以内の半角英数字および「-」「.」「_」。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

SSL証明書の送付

SSL証明書の送付

汎用コマンド実行部品

Puppet Enterprise AgentサーバからPuppet Enterprise MasterサーバにSSL証明書を送付します。

エラーの原因を取り除いたあと，このステップから実行してください。

2

SSL証明書の承認

SSL証明書の承認

汎用コマンド実行部品

Puppet Enterprise MasterサーバでPuppet Enterprise AgentのSSL証明書を承認します。

エラーの原因を取り除いたあと，SSL証明書が承認済みの場合は次のステップから実行してください。SSL証明書が未承認の場合はこのステップから実行してください。SSL証明書の承認状況は，"puppet cert list"コマンドで確認することができます。

3

Agentの登録確認

Agentの登録確認

汎用コマンド実行部品

Puppet Enterprise AgentサーバでPuppet Enterprise Masterへの登録確認をします。

エラーの原因を取り除いたあと，このステップから実行してください。

4

Agentの登録結果確認

Agentの登録結果確認

値判定分岐部品

Puppet Enterprise AgentサーバをPuppet Enterprise Masterへの登録結果を確認します。

エラーの原因を取り除いたあと，このステップから実行してください。

5

異常終了部品

異常終了部品

異常終了部品

Puppet Enterprise AgentサーバをPuppet Enterprise Masterへの登録に失敗したため，異常終了します。

エラーの原因を取り除いたあと，このステップから実行してください。

6

Agentの登録結果確認2

Agentの登録結果確認2

値判定分岐部品

Puppet Enterprise AgentサーバをPuppet Enterprise Masterへの登録結果を確認します。

エラーの原因を取り除いたあと，このステップから実行してください。

7

異常終了部品2

異常終了部品2

異常終了部品

Puppet Enterprise AgentサーバをPuppet Enterprise Masterへの登録に失敗したため，異常終了します。

エラーの原因を取り除いたあと，このステップから実行してください。

8

Agentの登録結果確認3

Agentの登録結果確認3

値判定分岐部品

Puppet Enterprise AgentサーバをPuppet Enterprise Masterへの登録結果を確認します。

エラーの原因を取り除いたあと，このステップから実行してください。

9

Agentの通信確認

Agentの通信確認

汎用コマンド実行部品

Puppet Enterprise AgentサーバでPuppet Enterprise Masterへの通信確認をします。

エラーの原因を取り除いたあと，このステップから実行してください。

2.10　OS（運用）用のサービステンプレート

2.10.1　OSユーザーの一覧一括取得

機能

このサービステンプレートは，Windows/UNIXのOSユーザーの一覧を，CSVファイルからサーバ一覧を取得して一括取得します。

このサービステンプレートが前提とするサーバを次に示します。

・Windowsサーバ

・UNIXサーバ

次の作業を実施します。

(1) CSVファイルの指定した列から，Windows/UNIXサーバの一覧を取得します。CSVファイルの1行目は列名を記述してください。2行目から100行目までデータを記述してください。ホスト名またはIPアドレスを記述してある列が最低一つ必要です。

(例1)

ホスト名

hostVM001

hostVM002

(例2)

ホスト名,コメント

hostVM001,#Comment1

hostVM002,#Comment2

"172.16.254.7",#Comment3

(2) CSVファイルに記述できるホスト名またはIPアドレスの件数は99件以下で，かつ

（ホスト名またはIPアドレスの文字列長の合計値）+ホスト件数　

が1017文字以下です。

(3) 読み込んだフィールドには次のチェックを行います。どれかの条件に当てはまると，タスクが失敗します。

　(a)フィールドの文字列長が1024文字より大きい

　(b)フィールドに次の特殊記号を含む

　「,」(ローカルサーバがWindows環境の場合)，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「`」，「%」，両端以外の「"」および末尾の「¥」

　(c)フィールドに制御文字(0x00〜0x1f)を含む

(4) Windows/UNIXサーバごとにOSユーザーの一覧を，指定されたファイルにテキスト形式で出力します。ファイルの名称は「OS_Users_XXXX」です。XXXXにはCSVファイルの指定した列の記述内容に応じてホスト名またはIPアドレスが指定されます。Windowsの場合，ファイルの出力フォーマットは，net userコマンドの出力結果と同じ形式です。

(5) OSユーザー一覧ファイルをローカルサーバの指定されたフォルダに転送します。Windows/UNIXサーバ上の転送元ファイルは削除します。

CSVファイル読み込みに失敗した場合は，OS.fileOpenRetryIntervalプロパティに指定した秒数待ってファイル読み込みをリトライする処理を，OS.fileOpenRetryCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

JP1/AOサーバ，実行対象サーバのOSがWindowsの場合，このサービステンプレートの実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。各サーバにadministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行うサービス「OSユーザーの一覧一括取得(SYSTEM)」を実行してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内Windows/UNIXサーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

なし。

【サービステンプレート実行システム内Windows/UNIXサーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

(12) AIX V6

(13) AIX V7

【システム内前提製品の使用条件】

なし。

【サービステンプレート実行システム内前提製品の使用条件】

なし。

注意事項

【CSVファイルに関する注意事項】

・ローカルサーバがWindows環境の場合の注意事項

(1) CSVファイル中のIPアドレスは二重引用符号(")で囲んでおく必要があります。

(2) ODBCドライバの制限のため，CSVファイル名には「[」，「]」，「!」，「`」は使用できません。

(3) データの途中に空白行がある場合，空白行も行数としてカウントされます。データが記述された行が99行以内であっても，途中の空白行を含めた行数が100以上となる場合，タスクが異常終了するのでご注意ください。

・ローカルサーバがUNIX環境の場合の注意事項

(1) データの途中に空白行がある場合，空白行も行数としてカウントされます。データが記述された行が99行以内であっても，途中の空白行を含めた行数が100以上となる場合，タスクが異常終了するのでご注意ください。

(2) データには「,」は使用できません。使用した場合，列を正しく区切ることができないため，データを取得できません。

(3) CSVファイルの行の先頭または末尾に存在する半角スペースおよびタブ記号は，その個数に関係なく，存在しないものとみなします。

【CSVファイル以外の注意事項】

(1) このサービスを実行する場合，エージェントレス接続先としてローカルサーバ("localhost"で解決されるループバックアドレス)およびOSユーザーの一覧を取得するサーバを設定する必要があります。

(2) OSユーザーの一覧を取得するサーバのOSがUNIXの場合は，プロパティにマルチバイト文字を使用しないでください。

(3) OSユーザーの一覧を取得するサーバのOSがWindowsでマルチバイト文字を指定する場合は，Windows用出力フォルダ(リモート)プロパティの指定値は248バイト以内となるよう指定してください。

(4) マルチバイト文字を指定する場合は，出力フォルダ名(ローカル)プロパティの指定値は256バイト以内となるよう指定してください。

(5) 「サーバ名の列番号」プロパティには255以内の整数値を指定してください。途中の空白列も列数に含まれますのでご注意ください。

(6) リモートおよびローカルに指定するフォルダ名が既に存在する場合，既存のフォルダを上書きします。また，フォルダの下に同名のファイルが存在する場合も上書きします。そのため，指定したフォルダ名に誤りがないか，十分に確認してください。

(7) リモートに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

実行権限

ビルトイン Administrator

バージョン

03.00.00

タグ

Gather OS information,Linux,Windows,AIX

プロパティ一覧

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

OS.fileOpenRetryCount

ファイル読み込み時のリトライ回数:Windows固有

ファイルの読み込みに失敗した場合のリトライ回数を指定します(Windowsの場合だけ)。ファイル読み込み時のリトライ間隔と組み合わせて最大待ち時間となります。"0"を指定した場合はリトライしません。

入力

無効

○　

OS.fileOpenRetryInterval

ファイル読み込み時のリトライ間隔:Windows固有

ファイルの読み込みに失敗した場合のリトライ間隔を秒単位で指定します(Windowsの場合だけ)。

入力

無効

○　

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

OS.excelFileName

CSVファイル名(ローカル)

サーバ一覧を管理するCSVファイル名をフルパスで指定します。

入力

無効

○　

OS.Column1

サーバ名の列番号

CSVファイルの列番号を1〜255で指定します。

入力

無効

○　

OS.userType

OSユーザー種別

操作対象のOSユーザー種別をlocal(ローカル)またはdomain(ドメイン)で指定します。このプロパティはOSユーザーの一覧を取得するサーバのOSがWindowsの場合だけ有効です。

入力

無効

△　

OS.listOutputFolderNameRemote_Windows

Windows用出力フォルダ(リモート)

OSユーザーの一覧を出力するWindowsサーバのフォルダ名をフルパスで指定します。転送後にリモートのファイルは削除されます。 ユーザー一覧の取得先にWindowsサーバが含まれる場合には必ず指定してください。

入力

無効

△　

OS.listOutputDirectoryNameRemote_Linux

UNIX用出力ディレクトリ名(リモート)

OSユーザーの一覧を出力するUNIXサーバのディレクトリ名をフルパスで指定します。転送後にリモートのファイルは削除されます。ユーザー一覧の取得先にUNIXサーバが含まれる場合には必ず指定してください。

入力

無効

△　

OS.listOutputFolderNameLocal

出力フォルダ名(ローカル)

OSユーザーの一覧を出力するフォルダ名をフルパスで指定します。

入力

無効

○　

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

OS.fileOpenRetryCount

0〜32767の整数値。

OS.fileOpenRetryInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

OS.excelFileName

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」を除く。

OS.Column1

数字だけ。

OS.userType

次の値のどれかを選択する。

local,domain

OS.listOutputFolderNameRemote_Windows

248文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」を除く。

OS.listOutputDirectoryNameRemote_Linux

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」を除く。

OS.listOutputFolderNameLocal

248文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

OS種別の出力

OS種別の出力

OS種別の出力

ローカルサーバのOSを出力します。

エラー原因を取り除いたあと，サービスを再実行してください。

2

サーバ名一覧ファイル読み取り

サーバ名一覧ファイル読み取り

CSV・Excelの列データ取得

CSVファイルからWindows/UNIXサーバのホスト名またはIPアドレスのリストを取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

一括取得

一括取得

繰り返し実行部品

取得したホスト名に対して，繰り返しOSユーザーの一覧取得を行います。

エラーの原因を取り除いたあと，サービスを再実行してください。

2.10.2　OSユーザーの一覧一括取得(繰り返しフロー）

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

OS判定

osGetOsInfo

OS種別の出力

OSを判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

2

入力プロパティ判定

CheckMacroValue1

値判定分岐部品

OSユーザーの一覧を取得するサーバのOSがWindowsかどうか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

3

WindowsのOSユーザー一覧の取得

osGetUsersWindows

階層フロー部品

WindowsサーバのOSユーザー一覧を取得します。

−　

3-1

OSユーザーの一覧取得

OSユーザーを取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-2

値判定分岐部品

ローカルサーバのOSがWindowsか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-3

ファイル転送部品

OSユーザーの一覧を転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-4

値判定分岐部品

ローカルサーバのOSがUNIXか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-5

ファイル転送部品

OSユーザーの一覧を転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-6

ファイル削除

一時ファイルを削除します。

対象サーバにファイルが残っています。手動で削除してください。

4

OS判定(UNIX)

judgeOsUNIX

値判定分岐部品

OSユーザーの一覧を取得するサーバのOSがUNIXかどうか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

5

UNIXのOSユーザー一覧の取得

osGetUsersUNIX

階層フロー部品

UNIXサーバのOSユーザー一覧を取得します。

−　

5-1

OSユーザーの一覧取得

OSユーザーを取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

5-2

値判定分岐部品

ローカルサーバのOSがWindowsか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

5-3

ファイル転送部品

OSユーザーの一覧を転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

5-4

値判定分岐部品

ローカルサーバのOSがUNIXか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

5-5

ファイル転送部品

OSユーザーの一覧を転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

5-6

ファイル削除

一時ファイルを削除します。

対象サーバにファイルが残っています。手動で削除してください。

2.10.3　OSユーザーの一覧一括取得(SYSTEM)

機能

このサービステンプレートは，Windows/UNIXのOSユーザーの一覧を，CSVファイルからサーバ一覧を取得して一括取得します。

このサービステンプレートが前提とするサーバを次に示します。

・Windowsサーバ

・UNIXサーバ

次の作業を実施します。

(1) CSVファイルの指定した列から，Windows/UNIXサーバの一覧を取得します。CSVファイルの1行目は列名を記述してください。2行目から100行目までデータを記述してください。ホスト名またはIPアドレスを記述してある列が最低一つ必要です。

(例1)

ホスト名

hostVM001

hostVM002

(例2)

ホスト名,コメント

hostVM001,#Comment1

hostVM002,#Comment2

"172.16.254.7",#Comment3

(2) CSVファイルに記述できるホスト名またはIPアドレスの件数は99件以下で，かつ

（ホスト名またはIPアドレスの文字列長の合計値）+ホスト件数　

が1017文字以下です。

(3) 読み込んだフィールドには次のチェックを行います。どれかの条件に当てはまると，タスクが失敗します。

　(a)フィールドの文字列長が1024文字より大きい

　(b)フィールドに次の特殊記号を含む

　「,」(ローカルサーバがWindows環境の場合)，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「`」，「%」，両端以外の「"」および末尾の「¥」

　(c)フィールドに制御文字(0x00〜0x1f)を含む

(4) Windows/UNIXサーバごとにOSユーザーの一覧を，指定されたファイルにテキスト形式で出力します。ファイルの名称は「OS_Users_XXXX」です。XXXXにはCSVファイルの指定した列の記述内容に応じてホスト名またはIPアドレスが指定されます。Windowsの場合，ファイルの出力フォーマットは，net userコマンドの出力結果と同じ形式です。

(5) OSユーザー一覧ファイルをローカルサーバの指定されたフォルダに転送します。Windows/UNIXサーバ上の転送元ファイルは削除します。

CSVファイル読み込みに失敗した場合は，OS.fileOpenRetryIntervalプロパティに指定した秒数待ってファイル読み込みをリトライする処理を，OS.fileOpenRetryCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内Windows/UNIXサーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

なし。

【サービステンプレート実行システム内Windows/UNIXサーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

(12) AIX V6

(13) AIX V7

【システム内前提製品の使用条件】

なし。

【サービステンプレート実行システム内前提製品の使用条件】

なし。

注意事項

【CSVファイルに関する注意事項】

・ローカルサーバがWindows環境の場合の注意事項

(1) CSVファイル中のIPアドレスは二重引用符号(")で囲んでおく必要があります。

(2) ODBCドライバの制限のため，CSVファイル名には「[」，「]」，「!」，「`」は使用できません。

(3) データの途中に空白行がある場合，空白行も行数としてカウントされます。データが記述された行が99行以内であっても，途中の空白行を含めた行数が100以上となる場合，タスクが異常終了するのでご注意ください。

・ローカルサーバがUNIX環境の場合の注意事項

(1) データの途中に空白行がある場合，空白行も行数としてカウントされます。データが記述された行が99行以内であっても，途中の空白行を含めた行数が100以上となる場合，タスクが異常終了するのでご注意ください。

(2) データには「,」は使用できません。使用した場合，列を正しく区切ることができないため，データを取得できません。

(3) CSVファイルの行の先頭または末尾に存在する半角スペースおよびタブ記号は，その個数に関係なく，存在しないものとみなします。

【CSVファイル以外の注意事項】

(1) このサービスを実行する場合，エージェントレス接続先としてローカルサーバ("localhost"で解決されるループバックアドレス)およびOSユーザーの一覧を取得するサーバを設定する必要があります。

(2) OSユーザーの一覧を取得するサーバのOSがUNIXの場合は，プロパティにマルチバイト文字を使用しないでください。

(3) OSユーザーの一覧を取得するサーバのOSがWindowsでマルチバイト文字を指定する場合は，Windows用出力フォルダ(リモート)プロパティの指定値は248バイト以内となるよう指定してください。

(4) マルチバイト文字を指定する場合は，出力フォルダ名(ローカル)プロパティの指定値は256バイト以内となるよう指定してください。

(5) 「サーバ名の列番号」プロパティには255以内の整数値を指定してください。途中の空白列も列数に含まれますのでご注意ください。

(6) リモートおよびローカルに指定するフォルダ名が既に存在する場合，既存のフォルダを上書きします。また，フォルダの下に同名のファイルが存在する場合も上書きします。そのため，指定したフォルダ名に誤りがないか，十分に確認してください。

(7) リモートに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

実行権限

Administratorsグループに所属するユーザー

バージョン

03.10.00

タグ

Gather OS information,Linux,Windows,AIX

プロパティ一覧

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

OS.fileOpenRetryCount

ファイル読み込み時のリトライ回数:Windows固有

ファイルの読み込みに失敗した場合のリトライ回数を指定します(Windowsの場合だけ)。ファイル読み込み時のリトライ間隔と組み合わせて最大待ち時間となります。"0"を指定した場合はリトライしません。

入力

無効

○　

OS.fileOpenRetryInterval

ファイル読み込み時のリトライ間隔:Windows固有

ファイルの読み込みに失敗した場合のリトライ間隔を秒単位で指定します(Windowsの場合だけ)。

入力

無効

○　

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

OS.excelFileName

CSVファイル名(ローカル)

サーバ一覧を管理するCSVファイル名をフルパスで指定します。

入力

無効

○　

OS.Column1

サーバ名の列番号

CSVファイルの列番号を1〜255で指定します。

入力

無効

○　

OS.userType

OSユーザー種別

操作対象のOSユーザー種別をlocal(ローカル)またはdomain(ドメイン)で指定します。このプロパティはOSユーザーの一覧を取得するサーバのOSがWindowsの場合だけ有効です。

入力

無効

△　

OS.listOutputFolderNameRemote_Windows

Windows用出力フォルダ(リモート)

OSユーザーの一覧を出力するWindowsサーバのフォルダ名をフルパスで指定します。転送後にリモートのファイルは削除されます。 ユーザー一覧の取得先にWindowsサーバが含まれる場合には必ず指定してください。

入力

無効

△　

OS.listOutputDirectoryNameRemote_Linux

UNIX用出力ディレクトリ名(リモート)

OSユーザーの一覧を出力するUNIXサーバのディレクトリ名をフルパスで指定します。転送後にリモートのファイルは削除されます。ユーザー一覧の取得先にUNIXサーバが含まれる場合には必ず指定してください。

入力

無効

△　

OS.listOutputFolderNameLocal

出力フォルダ名(ローカル)

OSユーザーの一覧を出力するフォルダ名をフルパスで指定します。

入力

無効

○　

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

OS.fileOpenRetryCount

0〜32767の整数値。

OS.fileOpenRetryInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

OS.excelFileName

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」を除く。

OS.Column1

数字だけ。

OS.userType

次の値のどれかを選択する。

local,domain

OS.listOutputFolderNameRemote_Windows

248文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」を除く。

OS.listOutputDirectoryNameRemote_Linux

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」を除く。

OS.listOutputFolderNameLocal

248文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

OS種別の出力

OS種別の出力

OS種別の出力

ローカルサーバのOSを出力します。

エラー原因を取り除いたあと，サービスを再実行してください。

2

サーバ名一覧ファイル読み取り(SYSTEM)

サーバ名一覧ファイル読み取り(SYSTEM)

CSV・Excelの列データ取得(SYSTEM)

CSVファイルからWindows/UNIXサーバのホスト名またはIPアドレスのリストを取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

一括取得

一括取得

繰り返し実行部品

取得したホスト名に対して，繰り返しOSユーザーの一覧取得を行います。

エラーの原因を取り除いたあと，サービスを再実行してください。

2.10.4　OSユーザーの一覧一括取得(SYSTEM)(繰り返しフロー）

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

OS判定

osGetOsInfo

OS種別の出力

OSを判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

2

入力プロパティ判定

CheckMacroValue1

値判定分岐部品

OSユーザーの一覧を取得するサーバのOSがWindowsかどうか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

3

WindowsのOSユーザー一覧の取得

osGetUsersWindows

階層フロー部品

WindowsサーバのOSユーザー一覧を取得します。

−　

3-1

OSユーザーの一覧取得

OSユーザーを取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-2

値判定分岐部品

ローカルサーバのOSがWindowsか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-3

ファイル転送部品

OSユーザーの一覧を転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-4

値判定分岐部品

ローカルサーバのOSがUNIXか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

3-5

ファイル転送部品

OSユーザーの一覧を転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-6

ファイル削除

一時ファイルを削除します。

対象サーバにファイルが残っています。手動で削除してください。

4

OS判定(UNIX)

judgeOsUNIX

値判定分岐部品

OSユーザーの一覧を取得するサーバのOSがUNIXかどうか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

5

UNIXのOSユーザー一覧の取得

osGetUsersUNIX

階層フロー部品

UNIXサーバのOSユーザー一覧を取得します。

−　

5-1

OSユーザーの一覧取得

OSユーザーを取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

5-2

値判定分岐部品

ローカルサーバのOSがWindowsか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

5-3

ファイル転送部品

OSユーザーの一覧を転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

5-4

値判定分岐部品

ローカルサーバのOSがUNIXか判定します。

エラー原因を取り除いたあと，サービスを再実行してください。

5-5

ファイル転送部品

OSユーザーの一覧を転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

5-6

ファイル削除

一時ファイルを削除します。

対象サーバにファイルが残っています。手動で削除してください。

2.10.5　OSユーザーの一覧取得

機能

このサービステンプレートは，Windows/UNIXのOSユーザーの一覧を取得します。

このサービステンプレートが前提とするサーバを次に示します。

・Windowsサーバ

・UNIXサーバ

次の作業を実施します。

(1)OSユーザーの一覧を取得し，指定されたファイルにテキスト形式で出力します。Windowsの場合，ファイルの出力フォーマットは，net userコマンドの出力結果と同じ形式です。

(2)ファイルをローカルサーバの指定されたフォルダに転送します。Windows/UNIXサーバ上の転送元ファイルは削除します。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

なし。

【サービステンプレート実行システム内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

(12) AIX V6

(13) AIX V7

【システム内前提製品の使用条件】

なし。

【サービステンプレート実行システム内前提製品の使用条件】

なし。

注意事項

(1)UNIX環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

(2)OSユーザーの一覧を取得するサーバのOSがWindowsでマルチバイト文字を指定する場合は，出力ファイル名(リモート)プロパティの指定値は256バイト以内となるよう指定してください。

(3)マルチバイト文字を指定する場合は，出力ファイル名(ローカル)プロパティの指定値は256バイト以内となるよう指定してください。

(4)リモートおよびローカルに指定するファイル名が既に存在する場合，既存のファイルを上書きします。また，リモート側のファイルは削除します。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(5)リモートに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

バージョン

02.00.00

タグ

Gather OS information,Linux,Windows,AIX

プロパティ一覧

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

OS.targetHost

Windows/UNIXサーバのホスト名

OSのユーザーの一覧を取得するWindowsサーバまたはUNIXサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

OS.userType

OSユーザー種別

操作対象のOSユーザー種別をlocal(ローカル)またはdomain(ドメイン)で指定します。このプロパティはエージェントサーバのOSがWindowsの場合だけ有効です。

入力

無効

△　

OS.listOutputFileNameRemote

出力ファイル名(リモート)

OSユーザーの一覧を出力するWindowsサーバまたはUNIXサーバのファイル名をフルパスで指定します。転送後にリモートのファイルは削除されます。

入力

無効

○　

OS.listOutputFileNameLocal

出力ファイル名(ローカル)

OSユーザーの一覧を出力するローカルのファイル名を指定します。

入力

無効

○　

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

OS.targetHost

255文字以内の半角英数字および「.」，「-」。

OS.userType

次の値のどれかを選択する。

local,domain

OS.listOutputFileNameRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「`」および末尾の「¥」を除く。

OS.listOutputFileNameLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

OSユーザーの一覧取得

OSユーザーの一覧取得

OSユーザーの一覧取得

Windows/UNIXのOSユーザーの一覧を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

ファイル転送

ファイル転送

ファイル転送部品

OSユーザーの一覧を転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

一時ファイル削除

一時ファイル削除

ファイル削除

一時ファイルを削除します。

対象サーバにファイルが残っています。手動で削除してください。

2.11　部品提供用のサービステンプレート

2.11.1　Utility Components

機能

このサービステンプレートは，サービステンプレート開発者向けの部品を格納したものです。サービステンプレートを開発する場合にインポートしてください。

前提条件

【システム内前提製品】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

注意事項

(1)このサービステンプレートからサービスの作成およびサービスの実行をしないでください。

バージョン

03.10.02

タグ

−　

3　JP1/AO Content Pack版サービステンプレート

この章では，JP1/AO Content Pack版サービステンプレートについて説明します。

3.1　JP1/AO Content Pack版サービステンプレート一覧

3.1.1　AWS（構築）用のサービステンプレート一覧

項番

サービステンプレート名

機能

システム構成

1

仮想サーバの削除

Amazon EC2環境で，インスタンスを削除します。また，インスタンスに接続しているすべてのネットワークインターフェイスも削除します。

−　

2

仮想サーバの追加(デプロイ)

Amazon EC2環境で，仮想サーバを作成(Amazon EC2では，インスタンスの起動という)します。

−　

（凡例）

−：ありません。

3.1.2　AWS（運用）用のサービステンプレート一覧

項番

サービステンプレート名

機能

システム構成

1

仮想サーバの起動

Amazon EC2環境で，複数のインスタンスを起動します。

−　

2

仮想サーバの停止

Amazon EC2環境で，複数のインスタンスを停止します。

−　

（凡例）

−：ありません。

3.1.3　Hyper-V 2008（構築）用のサービステンプレート一覧

項番

サービステンプレート名

機能

システム構成

1

仮想サーバの削除

Hyper-V環境で，仮想サーバを削除します。

−　

2

仮想サーバの追加(デプロイ/OS初期設定)

Hyper-V環境で，仮想サーバを作成します。

−　

3

仮想サーバの追加(仮想ディスク)

Hyper-V環境で，仮想サーバにディスクを追加します。

−　

（凡例）

−：ありません。

3.1.4　Hyper-V 2008（運用）用のサービステンプレート一覧

項番

サービステンプレート名

機能

システム構成

1

仮想サーバの起動

Hyper-V環境で，複数の仮想サーバを起動します。

−　

2

仮想サーバの再起動

Hyper-V環境で，複数の仮想サーバを再起動します。

−　

3

仮想サーバの情報一覧取得

Hyper-V環境で，仮想サーバの情報一覧を取得します。

−　

4

仮想サーバの停止

Hyper-V環境で，複数の仮想サーバのOSを強制的にシャットダウンします。

−　

（凡例）

−：ありません。

3.1.5　Hyper-V 2012（構築）用のサービステンプレート一覧

項番

サービステンプレート名

機能

システム構成

1

仮想サーバのスペック変更(CPU，メモリ)

Hyper-V 2012環境で，仮想サーバのスペック(CPU，メモリ)の設定を変更します。

−　

2

仮想サーバの削除

Hyper-V 2012環境で，仮想サーバを削除します。

−　

3

仮想サーバの追加(デプロイ/OS初期設定)

Hyper-V 2012環境で，仮想サーバを作成します。

−　

4

仮想サーバの追加(仮想ディスク)

Hyper-V 2012環境で，仮想サーバに仮想ディスクを追加します。

−　

（凡例）

−：ありません。

3.1.6　Hyper-V 2012（運用）用のサービステンプレート一覧

項番

サービステンプレート名

機能

システム構成

1

仮想サーバの起動

Hyper-V 2012環境で，複数の仮想サーバを起動します。

−　

2

仮想サーバの再起動

Hyper-V 2012環境で，複数の仮想サーバを再起動します。

−　

3

仮想サーバの情報一覧取得

Hyper-V 2012環境で，仮想サーバの情報一覧を取得します。

−　

4

仮想サーバの停止

Hyper-V 2012環境で，複数の仮想サーバのOSをシャットダウンします。

−　

（凡例）

−：ありません。

3.1.7　Hyper-V 2016（構築）用のサービステンプレート一覧

項番

サービステンプレート名

機能

システム構成

1

仮想サーバのスペック変更(CPU，メモリ)

Hyper-V 2016環境で，仮想サーバのスペック(CPU，メモリ)の設定を変更します。

−　

2

仮想サーバの削除

Hyper-V 2016環境で，仮想サーバを削除します。

−　

3

仮想サーバの追加(デプロイ/OS初期設定)

Hyper-V 2016環境で，仮想サーバを作成します。

−　

4

仮想サーバの追加(仮想ディスク)

Hyper-V 2016環境で，仮想サーバに仮想ディスクを追加します。

−　

（凡例）

−：ありません。

3.1.8　Hyper-V 2016（運用）用のサービステンプレート一覧

項番

サービステンプレート名

機能

システム構成

1

仮想サーバの起動

Hyper-V 2016環境で，複数の仮想サーバを起動します。

−　

2

仮想サーバの再起動

Hyper-V 2016環境で，複数の仮想サーバを再起動します。

−　

3

仮想サーバの情報一覧取得

Hyper-V 2016環境で，仮想サーバの情報一覧を取得します。

−　

4

仮想サーバの停止

Hyper-V 2016環境で，複数の仮想サーバのOSをシャットダウンします。

−　

（凡例）

−：ありません。

3.1.9　OpenStack（構築）用のサービステンプレート一覧

項番

サービステンプレート名

機能

システム構成

1

仮想サーバの削除

OpenStack管理下のKVM環境で，インスタンスを削除します。また，インスタンスにFloating IPアドレスが設定されている場合，Floating IPアドレスの割り当てを解除します。

−　

2

仮想サーバの削除(仮想ディスク)

OpenStack管理下のKVM環境で，インスタンスに接続されているボリュームを切断します。

−　

3

仮想サーバの追加(デプロイ/OS初期設定)

OpenStack管理下のKVM環境で，仮想サーバを作成(OpenStackでは，インスタンスの起動という)します。

−　

4

仮想サーバの追加(仮想ディスク)

OpenStack管理下のKVM環境で，インスタンスにボリュームを追加します。

−　

（凡例）

−：ありません。

3.1.10　OpenStack（運用）用のサービステンプレート一覧

項番

サービステンプレート名

機能

システム構成

1

ボリュームのバックアップ

OpenStack管理下のKVM環境で，ボリュームのバックアップを取得します。

−　

2

仮想サーバの起動

OpenStack管理下のKVMにおいてインスタンスを起動します。

−　

3

仮想サーバの情報一覧取得

OpenStack管理下のKVM環境の，指定したプロジェクトに含まれるインスタンス情報一覧を取得します。

−　

（凡例）

−：ありません。

3.1.11　OS（構築）用のサービステンプレート一覧

項番

サービステンプレート名

機能

システム構成

1

Windows更新プログラムのインストール

Windows Update機能による更新プログラムの自動インストールを行います。

−　

2

Windows更新プログラムのインストール(SYSTEM)

Windows Update機能による更新プログラムの自動インストールを行います。

−　

（凡例）

−：ありません。

3.1.12　vSphere（構築）用のサービステンプレート一覧

項番

サービステンプレート名

機能

システム構成

1

vCenterサーバ経由でのスクリプト実行

VMware vSphere環境で，指定した非対話型のスクリプトファイルを実行対象サーバから仮想サーバのゲストOSに送信し，ゲストOS上でスクリプトファイルを実行します。その後，不要な場合はスクリプトを削除できます。

−　

2

仮想サーバスペック変更(CPU，メモリ)

VMware vSphere環境で，仮想サーバのスペックを変更します。

3.3.7　仮想サーバスペック変更(CPU，メモリ)のシステム構成

3

仮想サーバのスナップショット

VMware vSphere環境で，仮想サーバの状態をスナップショットを用いて更新できます。

3.3.8　仮想サーバのスナップショットのシステム構成

4

仮想サーバ削除

VMware vSphere環境で，仮想サーバを削除します。

3.3.4　仮想サーバ削除のシステム構成

5

仮想サーバ削除(データストア削除/LU削除)

VMware vSphereおよびHDvMで構成される環境で，データストアおよびLUを削除します。

3.3.6　仮想サーバ削除(データストア削除/LU削除)のシステム構成

6

仮想サーバ削除(仮想ディスク)

VMware vSphere環境で，仮想サーバのディスクを削除します。

3.3.5　仮想サーバ削除(仮想ディスク)のシステム構成

7

仮想サーバ追加(LU作成/データストア作成)

VMware vSphereおよびHDvMで構成される環境で，LUおよびデータストアを作成します。

3.3.1　仮想サーバ追加(LU作成/データストア作成)のシステム構成

8

仮想サーバ追加(デプロイ/OS初期設定)

VMware vSphere環境で，仮想サーバを作成します。

3.3.2　仮想サーバ追加(デプロイ/OS初期設定)のシステム構成

9

仮想サーバ追加(仮想ディスク)

VMware vSphere環境で，仮想サーバにディスクを追加します。

3.3.3　仮想サーバ追加(仮想ディスク)のシステム構成

（凡例）

−：ありません。

3.1.13　vSphere（運用）用のサービステンプレート一覧

項番

サービステンプレート名

機能

システム構成

1

ストレージ情報一覧取得

HDvMに登録されているストレージ一覧を取得します。

3.3.16　ストレージ情報一覧取得のシステム構成

2

仮想サーバのクローン作成

VMware vSphere環境で，仮想サーバのクローンを作成します。

3.3.17　仮想サーバのクローン作成のシステム構成

3

仮想サーバのクローン削除

VMware vSphere環境で，仮想サーバのクローンを削除します。

3.3.18　仮想サーバのクローン削除のシステム構成

4

仮想サーバマイグレーション

VMware vSphere環境で，複数の仮想サーバをマイグレーションします。

3.3.12　仮想サーバマイグレーションのシステム構成

5

仮想サーバ起動

VMware vSphere環境で，複数の仮想サーバを起動します。

3.3.9　仮想サーバ起動のシステム構成

6

仮想サーバ再起動

VMware vSphere環境で，複数の仮想サーバを再起動します。

3.3.11　仮想サーバ再起動のシステム構成

7

仮想サーバ情報一覧取得

VMware vSphereの仮想サーバ一覧を取得します。

3.3.15　仮想サーバ情報一覧取得のシステム構成

8

仮想サーバ追加(LU作成/データストア作成)環境確認

仮想サーバ追加(LU作成/データストア作成)サービスの前提環境を確認します。

3.3.13　仮想サーバ追加(LU作成/データストア作成)環境確認のシステム構成

9

仮想サーバ追加(デプロイ/OS初期設定)環境確認

仮想サーバ追加(デプロイ/OS初期化)サービスの前提環境を確認します。

3.3.14　仮想サーバ追加(デプロイ/OS初期設定)環境確認のシステム構成

10

仮想サーバ停止

VMware vSphere環境で，複数の仮想サーバを停止します。

3.3.10　仮想サーバ停止のシステム構成

3.1.14　部品提供用のサービステンプレート一覧

項番

サービステンプレート名

機能

システム構成

1

AWS Components

サービスの作成およびサービスの実行をしないでください。このサービステンプレートは，サービステンプレート開発者向けの部品を格納したものです。

−　

2

HCS Components

サービスの作成およびサービスの実行をしないでください。このサービステンプレートは，サービステンプレート開発者向けの部品を格納したものです。

−　

3

Hyper-V2008 Components

サービスの作成およびサービスの実行をしないでください。このサービステンプレートは，サービステンプレート開発者向けの部品を格納したものです。

−　

4

Hyper-V2012 Components

サービスの作成およびサービスの実行をしないでください。このサービステンプレートは，サービステンプレート開発者向けの部品を格納したものです。

−　

5

Hyper-V2016 Components

サービスの作成およびサービスの実行をしないでください。このサービステンプレートは，サービステンプレート開発者向けの部品を格納したものです。

−　

6

OpenStack Components

サービスの作成およびサービスの実行をしないでください。このサービステンプレートは，サービステンプレート開発者向けの部品を格納したものです。

−　

7

Oracle Components

サービスの作成およびサービスの実行をしないでください。このサービステンプレートは，サービステンプレート開発者向けの部品を格納したものです。

−　

8

vSphere Components

サービスの作成およびサービスの実行をしないでください。このサービステンプレートは，サービステンプレート開発者向けの部品を格納したものです。

−　

（凡例）

−：ありません。

3.2　仮想サーバ用サービステンプレートの使用例

JP1/AO Content Pack版サービステンプレートでは，仮想サーバ環境を構築するために必要なサービステンプレートを提供しています。

ここでは，次のサービステンプレートを使用した場合の，想定するシステム構成および指定するプロパティの例について説明します。

仮想サーバ追加（LU作成/データストア作成）

仮想サーバマイグレーション

3.2.1　サービステンプレート「仮想サーバ追加（LU作成/データストア作成）」の使用例

サービステンプレート「仮想サーバ追加（LU作成/データストア作成）」を使用した場合の，想定するシステム構成および指定するプロパティの例について説明します。

このサービステンプレートを使用すると，ストレージシステム上にDPボリュームを作成し，VMware vSphere ESXi（またはVMware ESX Server）にデータストアを作成できます。

想定するシステム構成

このサービステンプレートでは，次のシステム構成を想定しています。

Webブラウザー

JP1/AOを操作する端末です。ユーザーは，この端末でサービステンプレートのプロパティ値を設定します。

IT運用自動化サーバ

JP1/AO，およびJP1/Baseがインストールされているサーバです。

vCenter操作サーバ

VMware vSphere Power CLIがインストールされているサーバです。

vCenterサーバ

VMware vCenter Serverがインストールされているサーバです。

HDvM CLIサーバ

Hitachi Device Manager Software CLIがインストールされているサーバです。

HDvMサーバ

Hitachi Device Managerがインストールされているサーバです。

ストレージシステム

Hitachi Device Managerが管理しているストレージシステムです。

ESXサーバ

VMware vSphere ESXi（またはVMware ESX Server）がインストールされているサーバです。仮想化サーバを管理しています。

図3‒1　サービステンプレート「仮想サーバ追加（LU作成/データストア作成）」の想定するシステム構成

処理の流れ

Webブラウザーから，ユーザーがプロパティ値を入力し，サービスを実行します。

IT運用自動化サーバから，HDvM CLIサーバやvCenter操作サーバに自動処理が実行されます。

HDvM CLIサーバから，DPボリュームがストレージシステム上に1つ作成されます。

HDvM CLIサーバから，作成したボリュームがESXサーバのホストグループに登録されます。

vCenter操作サーバから，追加したH-LUNがESXサーバに認識されます。

vCenter操作サーバから，データストアがESXサーバに追加されます。

vCenter操作サーバから，追加したデータストアに対するFCパスを優先に設定されます。

プロパティ値の指定例

サービステンプレート「仮想サーバ追加（LU作成/データストア作成）」を使用するためには，ユーザーの環境に合わせて，プロパティ値を指定する必要があります。プロパティ値は，［サービス設定］画面および［サービス実行］画面で指定します。

表3‒1　［サービス設定］画面で指定するプロパティ値の例（仮想サーバ追加（LU作成/データストア作成））

プロパティグループ

プロパティ名

プロパティキー

説明

指定例

仮想システム環境情報

HDvM CLIサーバのホスト名

hdvm.targetHost

Device Manager CLIがインストールされているサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

storagehostCL

HDvM CLIのインストールパス

hdvm.cliInstallPath

Device Manager CLIのインストールパスを指定します。

C:¥HDVM

HDvMとの通信プロトコル

hdvm.hdvmProtocol

HDvMサーバに接続するためのプロトコルをhttpまたはhttpsで指定します。

http

HDvMサーバのホスト名

hdvm.hdvmHostName

HDvMサーバのホスト名またはIPアドレスを指定します。

storagehostM

HDvMとの接続ポート番号

hdvm.hdvmPortNumber

HDvMサーバに接続するためのポート番号を指定します。

2001

HDvMに接続するためのユーザーID

hdvm.hdvmUserName

HDvMサーバに接続するためのユーザーIDを指定します。

System

HDvMに接続するためのパスワード

hdvm.hdvmPassword

HDvMサーバに接続するためのパスワードを指定します。

password

VMware vCenter操作サーバのホスト名

vmware.targetHost

VMware vCenter Serverを操作するサーバ(vSphere PowerCLIインストール済みサーバ)のホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

Vspcli

vCenterサーバ名

vmware.vCenterServerName

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

Vcenterhost

VMware vCenter Serverに接続するためのユーザー名

vmware.userName

VMware vCenter Serverに接続するためのユーザー名を指定します。

User01

VMware vCenter Serverに接続するためのパスワード

vmware.password

VMware vCenter Serverに接続するためのパスワードを指定します。

password

VMware vCenter Server接続用プロトコル

vmware.protocol

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

ストレージ情報

ストレージシステムのシリアル番号

hdvm.hdvmSerialNumber

実行対象のストレージシステムのシリアル番号を指定します。

123456789

ストレージシステムのファミリー名

hdvm.hdvmArrayFamily

ストレージシステムのファミリー名を指定します。指定可能な値はAMS，USP_V，USP_VM，VSP，HUS，HUS VM，VSP G1000のどれかです。

AMS

表3‒2　［サービス実行］画面で指定するプロパティ値の例（仮想サーバ追加（LU作成/データストア作成））

プロパティグループ

プロパティ名

プロパティキー

説明

指定例

ストレージ情報

DPボリューム(LU)の容量 (GB)

hdvm.hdvmCapacity

作成するDPボリューム(LU)の容量をGB単位で指定します。

100

DPボリューム(LU)のデバイス番号

hdvm.hdvmDevNumber

DPボリューム(LU)のデバイス番号を10進数で指定します。

1001

DPプールのプールID

hdvm.hdvmPoolId

作成したDPボリューム(LU)を関連づけるDPプールのプールIDを指定します。

10

パスのポート名

hdvm.hdvmPathPortName

DPボリューム(LU)へのパスのポート名を指定します。

CLT0-A

ホストグループのID

hdvm.hdvmDomainId

DPボリューム(LU)を追加するホストグループのIDを10進数または16進数で指定します。16進数の場合は"0x"をプレフィックスとして付与してください。

123

LU Number(LUN)

hdvm.hdvmLun

LU Number(LUN)を指定します。

127

仮想環境情報

ESXサーバ名

vmware.vmHostName

VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。

ESXhost

データストア名

vmware.dataStoreName

データストアの名称を指定します。

datastore

HBA名

vmware.hbaName

優先するHBA名を，VMware vCenter Serverのストレージアダプタのランタイム名に表示される形式で指定します(例：vmhba0)。

hba

3.2.2　サービステンプレート「仮想サーバマイグレーション」の使用例

サービステンプレート「仮想サーバマイグレーション」を使用した場合の，想定するシステム構成および指定するプロパティの例について説明します。

このサービステンプレートを使用すると，vMotionで，仮想サーバをほかのVMware vSphere ESXi（またはVMware ESX Server）に移動できます。

想定するシステム構成

このサービステンプレートでは，次のシステム構成を前提としています。

Webブラウザー

JP1/AOを操作する端末です。ユーザーは，この端末でサービステンプレートのプロパティ値を設定します。

IT運用自動化サーバ

JP1/AO，およびJP1/Baseがインストールされているサーバです。

vCenter 操作サーバ

VMware vSphere Power CLIがインストールされているサーバです。

vCenterサーバ

VMware vCenter Server がインストールされているサーバです。

ESXサーバ

VMware vSphere ESXi（またはVMware ESX Server）がインストールされているサーバです。仮想化サーバを管理しています。

仮想サーバ

ESXサーバが管理する仮想サーバです。サービステンプレート「仮想サーバマイグレーション」では，この仮想サーバを移動します。

図3‒2　サービステンプレート「仮想サーバマイグレーション」の想定するシステム構成

処理の流れ

Webブラウザーから，ユーザーがプロパティ値を入力し，サービスを実行します。

IT運用自動化サーバから，vCenter操作サーバに自動処理が実行されます。

対象の仮想サーバがESX01サーバから，ESX02サーバにマイグレーションされます。

対象の仮想サーバの電源が，ONのときはホットマイグレーション（電源ONのまま移動）されます。対象の仮想サーバの電源が，OFFのときはコールドマイグレーション（電源OFFのまま移動）されます。

プロパティ値の指定例

サービステンプレート「仮想サーバマイグレーション」を使用するためには，ユーザーの環境に合わせて，プロパティ値を指定する必要があります。プロパティ値は，［サービス設定］画面および［サービス実行］画面で指定します。

表3‒3　［サービス設定］画面で指定するプロパティ値の例（仮想サーバマイグレーション）

プロパティグループ

プロパティ名

プロパティキー

説明

指定例

仮想システム環境情報

VMware vCenter操作サーバのホスト名

vmware.targetHost

VMware vCenter Serverを操作するサーバ(vSphere PowerCLIインストール済みサーバ)のホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

VCenterhostpcli

vCenterサーバ名

vmware.vCenterServerName

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

Vcenterhost

VMware vCenter Serverに接続するためのユーザー名

vmware.userName

VMware vCenter Serverに接続するためのユーザー名を指定します。

user01

VMware vCenter Serverに接続するためのパスワード

vmware.password

VMware vCenter Serverに接続するためのパスワードを指定します。

password

VMware vCenter Server接続用プロトコル

vmware.protocol

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

表3‒4　［サービス実行］画面で指定するプロパティ値の例（仮想サーバマイグレーション）

プロパティグループ

プロパティ名

プロパティキー

説明

指定例

仮想サーバ情報

仮想サーバ名(複数指定可)

vmware.foreachVmName

仮想サーバの名称(VMware vCenter Serverにおける仮想サーバ名。ホスト名ではありません。)を指定します。複数指定する場合はコンマで区切ってください。99個まで指定できます。

host01

仮想サーバの移動先

vmware.destinationName

移動先のVMware vSphere ESXi(またはVMware ESX Server)またはリソースプール，クラスタ，フォルダの名称を指定します。

ESX02

3.3　JP1/AO Content Pack版サービステンプレートのシステム構成

次に示すvSphere（構築）用のサービステンプレート，およびvSphere（運用）用のサービステンプレートのシステム構成について説明します。

vSphere（構築）用のサービステンプレート

仮想サーバ追加(LU作成/データストア作成)

仮想サーバ追加(デプロイ/OS初期設定)

仮想サーバ追加(仮想ディスク)

仮想サーバ削除

仮想サーバ削除(仮想ディスク)

仮想サーバ削除(データストア削除/LU削除)

仮想サーバスペック変更(CPU，メモリ)

仮想サーバのスナップショット

vSphere（運用）用のサービステンプレート

仮想サーバ起動

仮想サーバ停止

仮想サーバ再起動

仮想サーバマイグレーション

仮想サーバ追加(LU作成/データストア作成)環境確認

仮想サーバ追加(デプロイ/OS初期設定)環境確認

仮想サーバ情報一覧取得

ストレージ情報一覧取得

仮想サーバのクローン作成

仮想サーバのクローン削除

3.3.1　仮想サーバ追加(LU作成/データストア作成)のシステム構成

図3‒3　仮想サーバ追加(LU作成/データストア作成)のシステム構成

3.3.2　仮想サーバ追加(デプロイ/OS初期設定)のシステム構成

図3‒4　仮想サーバ追加(デプロイ/OS初期設定) のシステム構成

3.3.3　仮想サーバ追加(仮想ディスク)のシステム構成

図3‒5　仮想サーバ追加(仮想ディスク) のシステム構成

3.3.4　仮想サーバ削除のシステム構成

図3‒6　仮想サーバ削除のシステム構成

3.3.5　仮想サーバ削除(仮想ディスク)のシステム構成

図3‒7　仮想サーバ削除(仮想ディスク)のシステム構成

3.3.6　仮想サーバ削除(データストア削除/LU削除)のシステム構成

図3‒8　仮想サーバ削除(データストア削除/LU削除) のシステム構成

3.3.7　仮想サーバスペック変更(CPU，メモリ)のシステム構成

図3‒9　仮想サーバスペック変更(CPU，メモリ)のシステム構成

3.3.8　仮想サーバのスナップショットのシステム構成

図3‒10　仮想サーバのスナップショットのシステム構成

3.3.9　仮想サーバ起動のシステム構成

図3‒11　仮想サーバ起動のシステム構成

3.3.10　仮想サーバ停止のシステム構成

図3‒12　仮想サーバ停止のシステム構成

3.3.11　仮想サーバ再起動のシステム構成

図3‒13　仮想サーバ再起動のシステム構成

3.3.12　仮想サーバマイグレーションのシステム構成

図3‒14　仮想サーバマイグレーションのシステム構成

3.3.13　仮想サーバ追加(LU作成/データストア作成)環境確認のシステム構成

図3‒15　仮想サーバ追加(LU作成/データストア作成)環境確認のシステム構成

3.3.14　仮想サーバ追加(デプロイ/OS初期設定)環境確認のシステム構成

図3‒16　仮想サーバ追加(デプロイ/OS初期設定)環境確認のシステム構成

3.3.15　仮想サーバ情報一覧取得のシステム構成

図3‒17　仮想サーバ情報一覧取得のシステム構成

3.3.16　ストレージ情報一覧取得のシステム構成

図3‒18　ストレージ情報一覧取得のシステム構成

3.3.17　仮想サーバのクローン作成のシステム構成

図3‒19　仮想サーバのクローン作成のシステム構成

3.3.18　仮想サーバのクローン削除のシステム構成

図3‒20　仮想サーバのクローン削除のシステム構成

3.4　AWS（構築）用のサービステンプレート

3.4.1　仮想サーバの削除

機能

このサービステンプレートは，Amazon EC2環境でインスタンスを削除します。また，インスタンスに接続しているすべてのネットワークインターフェイスも削除します。

このサービステンプレートが前提とするサーバを次に示します。

・AWS操作サーバ(実行対象サーバ)

　AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によってこのサーバに部品が転送され，実行されます。

・インスタンス

　Amazon EC2環境の仮想ホストのことで，一般的な仮想サーバのことです。

処理の概要を次に示します。

(1) インスタンスID(aws.instanceIdプロパティ)に指定したインスタンスを削除します。

(2) インスタンスに接続しているすべてのネットワークインターフェイスを削除します。

プロパティ設定の留意点を次に示します。

(1) インスタンスを削除する際には，インスタンスの削除完了の確認間隔(aws.checkInstanceDeletionIntervalプロパティ)に指定した秒数待ってインスタンスの状態を確認する動作を，インスタンスの削除完了の確認回数(aws.checkInstanceDeletionCountプロパティ)に指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

前提条件

【システム内前提製品】/【サービステンプレート実行対象サーバ内前提製品】/【サービステンプレート実行対象サーバ内前提製品の稼働OS】/【サービステンプレート実行対象システム内前提製品】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行対象サーバ内前提製品】

　・AWS Tools for Windows PowerShell

　・Microsoft .Net Framework 3.5以降

【サービステンプレート実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【サービステンプレート実行対象システム内前提製品】

(1) インスタンスの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【サービステンプレート実行対象システム内前提製品の使用条件】

(1) 本製品に関する条件

　・このサービスを実行する場合，エージェントレス接続先として実行対象サーバを設定する必要があります。実行対象サーバとしてローカルサーバを使用する場合，"localhost"で解決されるループバックアドレスを設定する必要があります。

注意事項

(1) インスタンスにユーザーがログインしていても，インスタンスは削除されます。

(2) 削除されたインスタンスはしばらくの間コンソールに表示されたままで状態取得もできますが，起動はできません。

(3) インスタンスの削除(/awsDeleteVMステップ)が戻り値1で異常終了した場合，削除できなかったネットワークインターフェイスが残ります。

実行権限

(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。

　・インスタンスの削除および状態取得

　・ネットワークインターフェイスの削除および状態取得

バージョン

02.00.01

タグ

Delete VM,AWS

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

AWSの情報を指定してください。

表示されます。

インスタンス情報

削除するインスタンスの情報を指定してください。

表示されます。

実行時オプション

インスタンスの削除を行う際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

aws.targetHost

AWS操作サーバのホスト名

AWS操作サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

aws.accessKeyId

アクセスキーID

AWSに接続するためのアクセスキーIDを指定します。

入力

無効

○　

仮想システム環境情報

aws.secretAccessKey

シークレットアクセスキー

AWSに接続するためのシークレットアクセスキーを指定します。

入力

無効

○　

仮想システム環境情報

aws.region

リージョン

接続先となるAWSのリージョンを指定します。

入力

無効

○　

仮想システム環境情報

aws.checkInstanceDeletionCount

インスタンスの削除完了の確認回数

インスタンスが削除されたことを確認する際の確認回数を指定します。インスタンスの削除完了の確認間隔と組み合わせて最大待ち時間となります。このプロパティは，ネットワークインターフェイスの削除が完了したか確認する際も使用します。

入力

無効

○　

実行時オプション

aws.checkInstanceDeletionInterval

インスタンスの削除完了の確認間隔

インスタンスが削除されたことを確認する際の確認間隔を秒単位で指定します。このプロパティは，ネットワークインターフェイスの削除が完了したか確認する際も使用します。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

aws.instanceId

インスタンスID

インスタンスのIDを指定します。

入力

無効

○　

インスタンス情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

aws.targetHost

256文字以内の半角英数字および「.」，「-」。

aws.accessKeyId

64文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「"」，「'」，「;」，「&」を除く。

aws.secretAccessKey

128文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「"」，「'」，「;」，「&」を除く。

aws.region

32文字以内の半角英数字および「-」。

aws.checkInstanceDeletionCount

1〜2147483647の整数値。

aws.checkInstanceDeletionInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

aws.instanceId

32文字以内の半角英数字および「-」。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

インスタンスの削除

インスタンスの削除

仮想サーバの削除

Amazon EC2環境で，インスタンスを削除します。

エラーの原因を取り除いたあと，サービスを再実行して下さい。なお，戻り値1でエラーになった場合は，サービスを再実行する必要はありませんが，残ったネットワークインターフェイスを必要に応じて削除してください。

3.4.2　仮想サーバの追加(デプロイ)

機能

このサービステンプレートは，Amazon EC2環境でインスタンスを起動します。オプションとして，起動したインスタンスを停止することができます。

このサービステンプレートが前提とするサーバを次に示します。

・AWS操作サーバ(実行対象サーバ)

　AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によってこのサーバに部品が転送され，実行されます。

・インスタンス

　Amazon EC2環境の仮想ホストのことで，一般的な仮想サーバのことです。

処理の概要を次に示します。

(1) インスタンスを起動します。

　AMI ID(aws.amiIdプロパティ)，インスタンスタイプ(aws.instanceTypeプロパティ)を設定します。また，オプションとしてキーペア名(aws.keyPairNameプロパティ)，セキュリティグループID(aws.securityGroupIdプロパティ)，サブネットID(1個目用)(aws.subnetId1プロパティ)，プライベートIPアドレス(1個目用)(aws.privateIpAddress1プロパティ)を設定できます。

(2) サブネットID(2個目用)(aws.subnetId2プロパティ)を指定した場合，起動したインスタンスに対してネットワークインターフェイスが追加され，2個目のプライベートIPアドレスが割り当てられます。

　2個目のプライベートIPアドレスはサブネットID(2個目用)に指定したサブネットの範囲内で自動的に割り当てられますが，プライベートIPアドレス(2個目用)(aws.privateIpAddress2プロパティ)を指定した場合は指定した値が割り当てられます。

(3) インスタンス停止の要否(aws.stopInstanceEnabledプロパティ)に"yes"を指定した場合，起動したインスタンスを停止します。

プロパティ設定の留意点を次に示します。

(1) キーペア名(aws.keyPairNameプロパティ)を省略した場合，インスタンスにキーペアが設定されません。

(2) セキュリティグループID(aws.securityGroupIdプロパティ)を省略した場合，デフォルトのセキュリティグループIDが設定されます。

(3) サブネットID(1個目用)(aws.subnetId1プロパティ)を省略した場合，デフォルトのサブネットIDが設定されます。

(4) プライベートIPアドレス(1個目用)(aws.privateIpAddress1プロパティ)を省略した場合，サブネットID(1個目用)に指定したサブネットの範囲内で自動的にIPアドレスが割り当てられます。

(5) サブネットID(2個目用)(aws.subnetId2プロパティ)を指定して，かつプライベートIPアドレス(2個目用)(aws.privateIpAddress2プロパティ)を省略した場合，サブネットID(2個目用)に指定したサブネットの範囲内で自動的にIPアドレスが割り当てられます。

前提条件

【システム内前提製品】/【サービステンプレート実行対象サーバ内前提製品】/【サービステンプレート実行対象サーバ内前提製品の稼働OS】/【サービステンプレート実行対象システム内前提製品】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行対象サーバ内前提製品】

　・AWS Tools for Windows PowerShell

　・Microsoft .Net Framework 3.5以降

【サービステンプレート実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【サービステンプレート実行対象システム内前提製品】

(1) インスタンスの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【サービステンプレート実行対象システム内前提製品の使用条件】

(1) Amazon EC2環境の設定に関する条件

　・インスタンスの起動に使用するAMIが作成済みであること。

(2) 本製品に関する条件

　・このサービスを実行する場合，エージェントレス接続先として実行対象サーバを設定する必要があります。実行対象サーバとしてローカルサーバを使用する場合，"localhost"で解決されるループバックアドレスを設定する必要があります。

注意事項

(1) 次に示すIPアドレスには，使用中や範囲外のIPアドレスを指定しないでください。指定した場合，タスクが異常終了します。

　・プライベートIPアドレス(1個目用)(aws.privateIpAddress1プロパティ)

　・プライベートIPアドレス(2個目用)(aws.privateIpAddress2プロパティ)

(2) インスタンスの起動(/awsCreateVMステップ)が戻り値1で異常終了した場合，起動したインスタンスは削除されずに残ります。また，戻り値2で異常終了した場合は，起動したインスタンスに加えて，作成したネットワークインターフェイスも残ります。

実行権限

(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。

　・インスタンスの作成，停止および状態取得

　・ネットワークインターフェイスの作成，接続および状態取得

バージョン

02.00.00

タグ

Add VM,AWS

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

AWSの情報を指定してください。

表示されます。

インスタンス情報

起動するインスタンスの情報を指定してください。

表示されます。

実行時オプション

インスタンスの起動および停止を行う際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

aws.targetHost

AWS操作サーバのホスト名

AWS操作サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

aws.accessKeyId

アクセスキーID

AWSに接続するためのアクセスキーIDを指定します。

入力

無効

○　

仮想システム環境情報

aws.secretAccessKey

シークレットアクセスキー

AWSに接続するためのシークレットアクセスキーを指定します。

入力

無効

○　

仮想システム環境情報

aws.region

リージョン

接続先となるAWSのリージョンを指定します。

入力

無効

○　

仮想システム環境情報

aws.checkInstanceEnabledCount

インスタンスの起動完了の確認回数

インスタンスが起動されたことを確認する際の確認回数を指定します。インスタンスの起動完了の確認間隔と組み合わせて最大待ち時間となります。このプロパティは，ネットワークインターフェイスの追加が完了したか確認する際も使用します。

入力

無効

○　

実行時オプション

aws.checkInstanceEnabledInterval

インスタンスの起動完了の確認間隔

インスタンスが起動されたことを確認する際の確認間隔を秒単位で指定します。このプロパティは，ネットワークインターフェイスの追加が完了したか確認する際も使用します。

入力

無効

○　

実行時オプション

aws.stopInstanceEnabled

インスタンス停止の要否

起動したインスタンスを停止するかどうかを指定します。「yes」を選択した場合，起動したインスタンスを停止します。

入力

無効

○　

インスタンス情報

aws.checkInstanceDisabledCount

インスタンスの停止完了の確認回数

インスタンスが停止されたことを確認する際の確認回数を指定します。インスタンスの停止完了の確認間隔と組み合わせて最大待ち時間となります。インスタンス停止の要否に「yes」を指定した場合は必ず指定してください。

入力

無効

△　

実行時オプション

aws.checkInstanceDisabledInterval

インスタンスの停止完了の確認間隔

インスタンスが停止されたことを確認する際の確認間隔を秒単位で指定します。インスタンス停止の要否に「yes」を指定した場合は必ず指定してください。

入力

無効

△　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

aws.amiId

AMI ID

インスタンスの起動に使用するAMIのIDを指定します。

入力

無効

○　

インスタンス情報

aws.instanceType

インスタンスタイプ

インスタンスの起動に使用するインスタンスタイプを指定します。

入力

無効

○　

インスタンス情報

aws.keyPairName

キーペア名

インスタンスで使用するキーペアの名称を指定します。省略した場合は，インスタンスにキーペア名は設定されません。

入力

無効

△　

インスタンス情報

aws.securityGroupId

セキュリティグループID

インスタンスを関連付けるセキュリティグループのIDを指定します。省略した場合は，デフォルトのセキュリティグループに関連付けられます。複数のセキュリティグループを指定する場合は，コンマ区切りで指定してください。

入力

無効

△　

インスタンス情報

aws.subnetId1

サブネットID(1個目用)

インスタンスに割り当てるプライベートIPアドレス(1個目)の範囲を示すサブネットのIDを指定します。省略した場合は，デフォルトのサブネットが割り当てられます。

入力

無効

△　

インスタンス情報

aws.privateIpAddress1

プライベートIPアドレス(1個目用)

インスタンスに割り当てるプライベートIPアドレス(1個目)を指定します。IPv6アドレスには対応していません。省略した場合は，サブネットID(1個目用)に指定したサブネットの範囲内で自動的にIPアドレスが割り当てられます。

入力

無効

△　

インスタンス情報

aws.subnetId2

サブネットID(2個目用)

インスタンスに割り当てるプライベートIPアドレス(2個目)の範囲を示すサブネットのIDを指定します。2個目のIPアドレスを設定する場合は必ず指定してください。省略した場合は，2個目のIPアドレスは設定されません。

入力

無効

△　

インスタンス情報

aws.privateIpAddress2

プライベートIPアドレス(2個目用)

インスタンスに割り当てるプライベートIPアドレス(2個目)を指定します。IPv6アドレスには対応していません。サブネットID(2個目用)を指定した場合に有効になります。サブネットID(2個目用)を指定した時にこのプロパティを省略した場合は，サブネットID(2個目用)に指定したサブネットの範囲内で自動的にIPアドレスが割り当てられます。

入力

無効

△　

インスタンス情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

aws.instanceIdOutput

インスタンスID

インスタンスのIDが格納されます。

出力

無効

aws.instanceIPaddress

インスタンスのIPアドレス

インスタンスのIPアドレスが格納されます。インスタンスに複数のIPアドレスが設定されている場合には，コンマ区切りで出力されます。

出力

無効

aws.networkInterfaceId

ネットワークインターフェイスID

サブネットID(2個目用)を指定した場合に，インスタンスに追加したネットワークインターフェイスのIDが格納されます。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

aws.targetHost

256文字以内の半角英数字および「.」，「-」。

aws.accessKeyId

64文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「"」，「'」，「;」，「&」を除く。

aws.secretAccessKey

128文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「"」，「'」，「;」，「&」を除く。

aws.region

32文字以内の半角英数字および「-」。

aws.checkInstanceEnabledCount

1〜2147483647の整数値。

aws.checkInstanceEnabledInterval

1〜60の整数値。

aws.stopInstanceEnabled

次の値のどれかを選択する。

yes,no

aws.checkInstanceDisabledCount

1〜2147483647の整数値。

aws.checkInstanceDisabledInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

aws.amiId

32文字以内の半角英数字および「-」。

aws.instanceType

32文字以内の半角英数字および「.」。

aws.keyPairName

255文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「"」，「'」，「;」，「&」を除く。

aws.securityGroupId

256文字以内の半角英数字および「-」，「,」。

aws.subnetId1

32文字以内の半角英数字および「-」。

aws.privateIpAddress1

15文字以内の半角数字および「.」。

aws.subnetId2

32文字以内の半角英数字および「-」。

aws.privateIpAddress2

15文字以内の半角数字および「.」。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

インスタンスの起動

インスタンスの起動

仮想サーバの作成

Amazon EC2環境で，仮想サーバを作成(Amazon EC2では，インスタンスの起動という)します。

エラーの原因を取り除いたあと，サービスを再実行して下さい。

2

インスタンス停止の要否確認

インスタンス停止の要否確認

値判定分岐部品

起動したインスタンスを停止するかを判定します。

−　

3

インスタンスの停止

インスタンスの停止

仮想サーバのシャットダウン

Amazon EC2環境で，仮想サーバをシャットダウン(Amazon EC2では，インスタンスの停止という)します。

エラーの原因を取り除いたあと，このステップから実行してください。

3.5　AWS（運用）用のサービステンプレート

3.5.1　仮想サーバの起動

機能

このサービステンプレートは，Amazon EC2環境でインスタンスを起動します。

このサービステンプレートが前提とするサーバを次に示します。

・AWS操作サーバ(実行対象サーバ)

　AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によってこのサーバに部品が転送され，実行されます。

・インスタンス

　Amazon EC2環境の仮想ホストのことで，一般的な仮想サーバのことです。

処理の概要を次に示します。

(1) インスタンスの状態を取得します。

(2) インスタンスが停止している場合に，インスタンスを起動します。インスタンスが既に起動している場合は，インスタンスを起動する処理をスキップします。

上記の処理を，インスタンスID(複数指定可)(aws.foreachInstanceIdプロパティ)に指定したインスタンス群に対して並列に実行します。

プロパティ設定の留意点を次に示します。

(1) インスタンスを起動する際には，インスタンスの起動完了の確認間隔(aws.checkInstanceEnabledIntervalプロパティ)に指定した秒数待ってインスタンスの状態を確認する動作を，インスタンスの起動完了の確認回数(aws.checkInstanceEnabledCountプロパティ)に指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

前提条件

【システム内前提製品】/【サービステンプレート実行対象サーバ内前提製品】/【サービステンプレート実行対象サーバ内前提製品の稼働OS】/【サービステンプレート実行対象システム内前提製品】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行対象サーバ内前提製品】

　・AWS Tools for Windows PowerShell

　・Microsoft .Net Framework 3.5以降

【サービステンプレート実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【サービステンプレート実行対象システム内前提製品】

(1) インスタンスの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【サービステンプレート実行対象システム内前提製品の使用条件】

(1) 本製品に関する条件

　・このサービスを実行する場合，エージェントレス接続先として実行対象サーバを設定する必要があります。実行対象サーバとしてローカルサーバを使用する場合，"localhost"で解決されるループバックアドレスを設定する必要があります。

実行権限

(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。

　・インスタンスの開始および状態取得

バージョン

02.00.00

タグ

Control VM,AWS

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

AWSの情報を指定してください。

表示されます。

インスタンス情報

起動するインスタンスの情報を指定してください。

表示されます。

実行時オプション

インスタンスの起動を行う際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

aws.targetHost

AWS操作サーバのホスト名

AWS操作サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

aws.accessKeyId

アクセスキーID

AWSに接続するためのアクセスキーIDを指定します。

入力

無効

○　

仮想システム環境情報

aws.secretAccessKey

シークレットアクセスキー

AWSに接続するためのシークレットアクセスキーを指定します。

入力

無効

○　

仮想システム環境情報

aws.region

リージョン

接続先となるAWSのリージョンを指定します。

入力

無効

○　

仮想システム環境情報

aws.checkInstanceEnabledCount

インスタンスの起動完了の確認回数

インスタンスが起動されたことを確認する際の確認回数を指定します。インスタンスの起動完了の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

aws.checkInstanceEnabledInterval

インスタンスの起動完了の確認間隔

インスタンスが起動されたことを確認する際の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

aws.foreachInstanceId

インスタンスID(複数指定可)

インスタンスのIDを指定します。複数指定する場合はコンマで区切ってください。99個まで指定できます。

入力

無効

○　

インスタンス情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

aws.targetHost

256文字以内の半角英数字および「.」，「-」。

aws.accessKeyId

64文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「"」，「'」，「;」，「&」を除く。

aws.secretAccessKey

128文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「"」，「'」，「;」，「&」を除く。

aws.region

32文字以内の半角英数字および「-」。

aws.checkInstanceEnabledCount

1〜2147483647の整数値。

aws.checkInstanceEnabledInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

aws.foreachInstanceId

1024文字以内の半角英数字および「-」，「,」。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

インスタンス数分繰り返し処理

インスタンス数分繰り返し処理

繰り返し実行部品

指定されたインスタンスの数だけ起動処理を繰り返します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.5.2　仮想サーバの起動(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

インスタンスの状態取得

awsGetVMState

仮想サーバの状態取得

Amazon EC2環境で，インスタンスの状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行して下さい。

2

インスタンスの起動の要否判定

JudgeValuePlugin

値判定分岐部品

インスタンスが"running"状態であるかを判定します。

−　

3

インスタンスの起動

awsPowerOnVM

仮想サーバの起動

Amazon EC2環境で，インスタンスを起動します。

エラーの原因を取り除いたあと，サービスを再実行して下さい。

3.5.3　仮想サーバの停止

機能

このサービステンプレートは，Amazon EC2環境でインスタンスを停止します。

このサービステンプレートが前提とするサーバを次に示します。

・AWS操作サーバ(実行対象サーバ)

　AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によってこのサーバに部品が転送され，実行されます。

・インスタンス

　Amazon EC2環境の仮想ホストのことで，一般的な仮想サーバのことです。

処理の概要を次に示します。

(1) インスタンスの状態を取得します。

(2) インスタンスが起動している場合に，インスタンスを停止します。インスタンスが既に停止している場合は，インスタンスを停止する処理をスキップします。

上記の処理を，インスタンスID(複数指定可)(aws.foreachInstanceIdプロパティ)に指定したインスタンス群に対して並列に実行します。

プロパティ設定の留意点を次に示します。

(1) インスタンスを停止する際には，インスタンスの停止完了の確認間隔(aws.checkInstanceDisabledIntervalプロパティ)に指定した秒数待ってインスタンスの状態を確認する動作を，インスタンスの停止完了の確認回数(aws.checkInstanceDisabledCountプロパティ)に指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

前提条件

【システム内前提製品】/【サービステンプレート実行対象サーバ内前提製品】/【サービステンプレート実行対象サーバ内前提製品の稼働OS】/【サービステンプレート実行対象システム内前提製品】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行対象サーバ内前提製品】

　・AWS Tools for Windows PowerShell

　・Microsoft .Net Framework 3.5以降

【サービステンプレート実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【サービステンプレート実行対象システム内前提製品】

(1) インスタンスの前提OS

　・Windows Server 2012 R2 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【サービステンプレート実行対象システム内前提製品の使用条件】

(1) 本製品に関する条件

　・このサービスを実行する場合，エージェントレス接続先として実行対象サーバを設定する必要があります。実行対象サーバとしてローカルサーバを使用する場合，"localhost"で解決されるループバックアドレスを設定する必要があります。

注意事項

(1) このサービスを実行した場合，インスタンスで編集中のデータは保存されません。

(2) インスタンスにユーザーがログインしていても，インスタンスは停止されます。

実行権限

(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。

　・インスタンスの停止および状態取得

バージョン

02.00.00

タグ

Control VM,AWS

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

AWSの情報を指定してください。

表示されます。

インスタンス情報

停止するインスタンスの情報を指定してください。

表示されます。

実行時オプション

インスタンスの停止を行う際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

aws.targetHost

AWS操作サーバのホスト名

AWS操作サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

aws.accessKeyId

アクセスキーID

AWSに接続するためのアクセスキーIDを指定します。

入力

無効

○　

仮想システム環境情報

aws.secretAccessKey

シークレットアクセスキー

AWSに接続するためのシークレットアクセスキーを指定します。

入力

無効

○　

仮想システム環境情報

aws.region

リージョン

接続先となるAWSのリージョンを指定します。

入力

無効

○　

仮想システム環境情報

aws.checkInstanceDisabledCount

インスタンスの停止完了の確認回数

インスタンスが停止されたことを確認する際の確認回数を指定します。インスタンスの停止完了の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

aws.checkInstanceDisabledInterval

インスタンスの停止完了の確認間隔

インスタンスが停止されたことを確認する際の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

aws.foreachInstanceId

インスタンスID(複数指定可)

インスタンスのIDを指定します。複数指定する場合はコンマで区切ってください。99個まで指定できます。

入力

無効

○　

インスタンス情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

aws.targetHost

256文字以内の半角英数字および「.」，「-」。

aws.accessKeyId

64文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「"」，「'」，「;」，「&」を除く。

aws.secretAccessKey

128文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「"」，「'」，「;」，「&」を除く。

aws.region

32文字以内の半角英数字および「-」。

aws.checkInstanceDisabledCount

1〜2147483647の整数値。

aws.checkInstanceDisabledInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

aws.foreachInstanceId

1024文字以内の半角英数字および「-」，「,」。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

インスタンス数分繰り返し処理

インスタンス数分繰り返し処理

繰り返し実行部品

指定されたインスタンスの数だけ停止処理を繰り返します。

エラーの原因を取り除いたあと，サービスを再実行して下さい。

3.5.4　仮想サーバの停止(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

インスタンスの状態取得

awsGetVMState

仮想サーバの状態取得

Amazon EC2環境で，インスタンスの状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行して下さい。

2

インスタンスの停止の要否判定

JudgeValuePlugin

値判定分岐部品

インスタンスが"stopped"状態であるかを判定します。

−　

3

インスタンスの停止

awsShutdownVM

仮想サーバのシャットダウン

Amazon EC2環境で，仮想サーバをシャットダウン(Amazon EC2では，インスタンスの停止という)します。

エラーの原因を取り除いたあと，サービスを再実行して下さい。

3.6　Hyper-V 2008（構築）用のサービステンプレート

3.6.1　仮想サーバの削除

機能

このサービステンプレートは，Hyper-V環境の仮想サーバを削除します。

このサービステンプレートが前提とするサーバを次に示します。

・Hyper-Vサーバ

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

処理の概要を次に示します。

(1) 仮想サーバの状態を取得します。

(2) 仮想サーバの状態が停止完了になっていることを確認します。

　　仮想サーバの状態が起動完了または停止完了の場合は，処理を継続しますが，それ以外(起動中，停止中，一時停止やスナップショット取得中など)の場合は，仮想サーバには操作を行わずにタスクが異常終了します。

　　仮想サーバの状態が起動完了の場合は，ユーザー応答待ち部品を実行して，シャットダウンするか・しないかを確認します。

　　ユーザー応答待ちのGUIで"Shutdown"を選択した場合は，仮想サーバをシャットダウンします。

　　"Cancel"を選択するか，応答待ちがタイムアウトになった場合は，仮想サーバには操作を行わずにタスクが異常終了します。

　　仮想サーバのOSをシャットダウンする際には，hyperv.checkVmStateDisabledIntervalプロパティに指定した秒数待ち合わせ，仮想サーバの状態を確認する動作を，hyperv.checkVmStateDisabledCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

(3) 仮想サーバを削除します。

　　Hyper-Vサーバから仮想サーバを削除します。このとき，スナップショットも併せて削除します。

　　hyperv.vHardDiskDeletePermanentlyプロパティの選択リストで，"yes"を選択した場合，削除する仮想サーバに割り当てられているすべての仮想ディスクファイル(容量可変/容量固定/差分)を削除します。パススルー(物理)ディスク，フロッピーディスクまたはCD/DVDなどに割り当てられているディスクやファイルは削除しません。仮想ディスク(差分)が割り当てられている場合，仮想ディスク(差分)の親として使用する仮想ディスクは削除しません。

　　仮想サーバの仮想ディスクファイルの削除に失敗した場合，ファイル削除処理を中断し，タスクは異常終了します。

(4) 仮想サーバの仮想ディスクファイルの一覧を出力します。

　　hyperv.vhdListOutputFileNameRemoteプロパティとhyperv.vhdListOutputFileNameLocalプロパティを指定した場合，Hyper-Vサーバから削除する仮想サーバに割り当てられている仮想ディスクファイルのパス一覧をCSV形式で出力，ファイルをローカルに転送し，リモート側のファイルは削除します。仮想ディスク(差分)が割り当てられている場合，仮想ディスク(差分)の親として使用する仮想ディスクは含まれません。

　　hyperv.vhdListOutputFileNameRemoteプロパティだけを指定した場合，仮想ディスクファイルのパス一覧をCSV形式で出力しますが，ファイルをローカルに転送しません。

　　出力するCSVファイルの項目を次に示します。

　　項目はコンマ区切りで出力します。

　　(a) 仮想ディスクファイルの有無 (ヘッダー名：Existence)

　　　　仮想サーバの削除実行時に割り当てられている仮想ディスクファイルが存在するかどうかを出力します。項目の値を次に示します。

　　　　　Found：ファイルの存在を確認

　　　　　NotFound：ファイルが設定されているが，存在を確認できない

　　(b) ファイルの削除結果 (ヘッダー名：DeleteResult)

　　　　hyperv.vHardDiskDeletePermanentlyプロパティの選択リストで"yes"を選択した場合，仮想ディスクファイルの削除の実行結果を出力します。"no"を選択した場合でも"Skipped"を出力します。項目の値を次に示します。

　　　　　Completed：ファイルの削除が成功

　　　　　Failed：ファイルの削除が失敗

　　　　　Skipped：ファイルの削除が未実施

　　(c) ファイルのパス (ヘッダー名：FilePath)

　　　　(a)(b)の内容に関わらず，Hyper-Vサーバで設定されている仮想ディスクファイルのパスを出力します。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2008 R2 Hyper-V

【サービステンプレート実行システム内前提製品の稼働OS】

(1)Hyper-Vサーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。

　・オペレーティングシステムのシャットダウン

(3)仮想サーバが停止完了の状態であること。

注意事項

(1)同一の仮想サーバに対して，このサービスを複数同時に実行しないでください。

(2)仮想ディスクファイルのパスを仮想サーバの設定情報から参照できなくなるような操作(スナップショット操作など)を行った場合，その仮想ディスクファイルは削除されません。この場合は手動で削除してください。

(3)UserResponseplugin.dialogTextプロパティにHTMLタグを指定する場合，指定できるタグおよび属性はユーザー応答待ち部品と同じです。詳細については，本製品マニュアルの「ユーザー応答待ち部品」について説明しているトピックを参照してください。

(4)hyperv.vhdListOutputFileNameRemoteプロパティおよびhyperv.vhdListOutputFileNameLocalプロパティに指定するファイル名がすでに存在する場合，既存のファイルを上書きします。また，リモート側のファイルは削除します。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(5)hyperv.vhdListOutputFileNameRemoteプロパティに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

(6)hyperv.vhdListOutputFileNameRemoteプロパティを指定した場合，hyperv.vhdListOutputFileNameLocalプロパティを指定しない場合や，仮想サーバまたは仮想ディスクファイルの削除時にエラーが発生しても，リモート側にファイルを出力します。出力したファイルは削除せずに残ります。そのため，使用しない場合は削除してください。

(7)このサービスは，フェールオーバークラスターマネージャーのサービスとアプリケーションから仮想サーバの登録情報を削除しません。ユーザーの運用に合わせて手動で削除してください。

(8)ユーザー応答待ちのGUIで"Shutdown"を選択した場合は，仮想サーバのOSを強制的にシャットダウンします。仮想サーバで編集中のファイルデータは保存されません。

バージョン

03.00.00

タグ

Delete VM,Hyper-V 2008

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

Hyper-Vサーバの情報を指定してください。

表示されます。

仮想サーバ情報

削除する仮想サーバの情報を指定してください。

表示されます。

ユーザー応答待ちオプション

仮想サーバが起動していた場合のユーザー応答のためのオプションです。必要に応じて変更してください。

表示されません。

実行時オプション

仮想サーバの状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.targetHost

Hyper-Vサーバのホスト名

Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

UserResponsePlugin.toAddress

TOメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(TO)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.ccAddress

CCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(CC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.bccAddress

BCCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(BCC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailSubject

メール件名

ユーザー応答待ちになった場合のメール通知のメールの件名を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailBody

メール本文

ユーザー応答待ちになった場合のメール通知のメール本文を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.encodeType

エンコード種別

ユーザー応答待ちになった場合のメール通知のエンコード種別を指定します。指定可能なエンコード名は次のとおりです。us-ascii，iso-2022-jp，shift_jis，euc-jp，utf-8。指定しなかった場合には，utf-8で送信されます。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.dialogText

応答入力画面の補足情報

ユーザー応答待ちになった場合の応答入力ダイアログに表示する補足情報を指定します。テキスト形式，またはHTML形式で指定できます。指定可能なHTMLタグは，アンカータグ，ボールドタグ，ブレークタグ，フォントタグ，イタリックタグ，下線タグです。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.responseTimeOut

応答タイムアウト時間(分)

ユーザー応答待ちになった場合の応答がタイムアウトする時間を分単位で指定します。応答タイムアウト時間が過ぎると，サービスが異常終了します。

入力

無効

○　

ユーザー応答待ちオプション

hyperv.checkVmStateDisabledCount

仮想サーバの状態(停止完了)の確認回数

仮想サーバの停止が完了したか確認する際の確認回数を指定します。仮想サーバの状態(停止完了)の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

hyperv.checkVmStateDisabledInterval

仮想サーバの状態(停止完了)の確認間隔

仮想サーバの停止が完了したか確認する際の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

hyperv.checkJobShutdownCount

ジョブ監視回数(InitiateShutdownメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(InitiateShutdownメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobShutdownInterval

ジョブ監視間隔(InitiateShutdownメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(InitiateShutdownメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobDelVMCount

ジョブ監視回数(DestroyVirtualSystemメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(DestroyVirtualSystemメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobDelVMInterval

ジョブ監視間隔(DestroyVirtualSystemメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(DestroyVirtualSystemメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobDelSnapshotCount

ジョブ監視回数(RemoveVirtualSystemSnapshotTreeメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(RemoveVirtualSystemSnapshotTreeメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobDelSnapshotInterval

ジョブ監視間隔(RemoveVirtualSystemSnapshotTreeメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(RemoveVirtualSystemSnapshotTreeメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

仮想サーバ情報

hyperv.vHardDiskDeletePermanently

仮想ディスクファイルの削除の要否

仮想サーバで使用している仮想ディスクファイルを削除するかどうか指定します。

入力

無効

○　

仮想サーバ情報

hyperv.vhdListOutputFileNameRemote

出力ファイル名(リモート)

仮想サーバが使用している仮想ディスクファイル一覧をHyper-Vサーバに出力する際の一時ファイル名をフルパスで指定します。

入力

無効

△　

仮想サーバ情報

hyperv.vhdListOutputFileNameLocal

出力ファイル名(ローカル)

仮想ディスクファイル一覧を取得するローカルサーバのファイル名をフルパスで指定します。

入力

無効

△　

仮想サーバ情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.targetHost

256文字以内の半角英数字および「.」，「-」。

UserResponsePlugin.toAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.ccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.bccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.mailSubject

256文字以内の文字列。

UserResponsePlugin.mailBody

1024文字以内の文字列。

UserResponsePlugin.encodeType

次の値のどれかを選択する。

us-ascii,iso-2022-jp,shift_jis,euc-jp,utf-8

UserResponsePlugin.dialogText

512文字以内の文字列。

UserResponsePlugin.responseTimeOut

1〜9999の整数値。

hyperv.checkVmStateDisabledCount

1〜2147483647の整数値。

hyperv.checkVmStateDisabledInterval

1〜60の整数値。

hyperv.checkJobShutdownCount

1〜2147483647の整数値。

hyperv.checkJobShutdownInterval

1〜60の整数値。

hyperv.checkJobDelVMCount

1〜2147483647の整数値。

hyperv.checkJobDelVMInterval

1〜60の整数値。

hyperv.checkJobDelSnapshotCount

1〜2147483647の整数値。

hyperv.checkJobDelSnapshotInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.vmName

100文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」，「¥」，「/」，「:」，先頭の「 (スペース)」および末尾の「 (スペース)」，「.」を除く。

hyperv.vHardDiskDeletePermanently

次の値のどれかを選択する。

yes,no

hyperv.vhdListOutputFileNameRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「'」，「[」，「]」，「`」および末尾の「¥」を除く。

hyperv.vhdListOutputFileNameLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの状態取得

仮想サーバの状態取得

仮想サーバの状態取得

Hyper-V環境において，仮想サーバの状態を取得します。

仮想サーバの状態を確認してください。

2

仮想サーバの状態確認

仮想サーバの状態確認

階層フロー部品

仮想サーバの状態を調べ，起動完了の状態であれば，ユーザーに確認します。

−　

2-3

値判定分岐部品

仮想サーバが「起動完了」の状態かどうかを判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4

階層フロー部品

仮想サーバをシャットダウンします。

−　

2-4-1

ユーザー応答待ち部品

仮想サーバのシャットダウンを行うかを確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4-2

戻り値判定分岐部品

ユーザー応答待ち部品の戻り値が1か判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4-3

異常終了部品

ジョブネットをエラーにします。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4-4

仮想サーバのシャットダウン

Hyper-V環境において，仮想サーバをシャットダウンします。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

仮想サーバの削除

仮想サーバの削除

階層フロー部品

仮想サーバを削除します。

−　

3-1

仮想サーバの削除

Hyper-V環境において，仮想サーバを削除します。

仮想サーバが削除されていない場合は，エラーの原因を取り除いたあと，サービスを再実行してください。

仮想サーバが削除されている場合は，仮想ディスクファイルの有無を確認，または仮想ディスクファイル一覧を出力していればHyper-Vサーバでファイルを参照し，必要に応じ手動で仮想ディスクファイルを削除してください。

4

ファイル転送

ファイル転送

階層フロー部品

仮想ディスクファイル一覧を転送します。

−　

4-3

値判定分岐部品

仮想ディスクファイル一覧の出力ファイル名(リモート)が指定されているかチェックします。

仮想ディスクファイル一覧を出力していれば，Hyper-Vサーバに仮想ディスクファイル一覧が残っています。手動で削除してください。

4-4

階層フロー部品

仮想ディスクファイル一覧を転送します。

−　

4-4-3

値判定分岐部品

仮想ディスクファイル一覧の出力ファイル名(ローカル)が指定されているかチェックします。

Hyper-Vサーバに仮想ディスクファイル一覧が残っています。手動で削除してください。

4-4-4

階層フロー部品

仮想ディスクファイル一覧を転送します。

−　

4-4-4-1

ファイル転送部品

リモートの一時ファイルをローカルの指定された出力ファイルに転送します。

Hyper-Vサーバに仮想ディスクファイル一覧が残っています。手動で削除してください。

4-4-4-2

ファイル削除

リモートの一時ファイルを削除します。

Hyper-Vサーバに仮想ディスクファイル一覧が残っています。手動で削除してください。

3.6.2　仮想サーバの追加(デプロイ/OS初期設定)

機能

このサービステンプレートは，Hyper-V環境に，エクスポート済みの仮想サーバを用いて仮想サーバを追加します。

このサービステンプレートが前提とするサーバを次に示します。

・Hyper-Vサーバ

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

・エクスポート済みの仮想サーバ

　Hyper-Vからエクスポートされた仮想サーバ，およびその仮想サーバの構成ファイル一式です。

・格納サーバ

　複製元となる，エクスポート済みの仮想サーバを格納してあるサーバです。

処理の概要を次に示します。

(1) Hyper-Vサーバに仮想サーバを作成します。

　1. インポート先に，エクスポート済みの仮想サーバを複製します。

　2. Hyper-Vサーバに，インポート機能を用いて仮想サーバを作成します。

　　新規に作成する仮想サーバには，新しい一意なIDを作成します。

　　インポート先に指定したパスのフォルダが既に存在する場合，そのフォルダを使用します。

(2) 仮想サーバの接続先仮想スイッチ(管理用)を設定します。

　ローカルサーバとの通信を確立するために，NICに仮想スイッチ(管理用)を設定します。

　エクスポート済みの仮想サーバに，既に設定されている接続先仮想スイッチは，指定された仮想スイッチに上書きされます。

　1個目のNICには，ローカルサーバと通信可能な管理用の仮想スイッチを設定してください。2〜4個目のNICには管理用・業務用仮想スイッチをユーザーの運用に合わせて設定してください。

　指定した仮想スイッチの数が，仮想サーバが持つNICの数より多い場合，NICに割り当てられなかった仮想スイッチの設定は無効になります。

(3) OSカスタマイズ用の応答ファイルを作成し，配置します。

　1. 仮想サーバの仮想ディスクをHyper-Vサーバにマウントします。

　2. マウントした仮想ディスクにOSカスタマイズ用の応答ファイルを作成します。

　3. Hyper-Vサーバから仮想ディスクをアンマウントします。

(4) 仮想サーバを起動し，仮想サーバの初期情報を設定します。

　1. OSの初期情報を設定します(コンピュータ名，会社名など)。

　　OSの初期設定として，コンピュータ名，会社名，組織名，タイムゾーンを設定します。

　2. 仮想サーバのIPアドレスを設定します。

　　仮想サーバは最大4個までIPアドレスを設定することができます。1個目のIPアドレス(管理用)には，デプロイした仮想サーバを管理するためのIPアドレスを設定してください。2〜4個目のIPアドレス(2個目用)・IPアドレス(3個目用)・IPアドレス(4個目用)については，管理用・業務用IPアドレスをユーザーの運用に合わせて設定してください。一部の設定は管理用IPアドレスを使用してOSに接続し設定をします。仮想サーバが持つNICの数によってIPアドレスの設定順序は次のようになります。

　　・仮想サーバがNICを1個持つ場合

　　　NICには，IPアドレス(管理用)>IPアドレス(2個目用)>IPアドレス(3個目用)>IPアドレス(4個目用)の順で最初に指定されていたIPアドレスを設定します。その他のIPアドレスは破棄されますのでご注意ください。

　　・仮想サーバがNICを2個以上持つ場合

　　　NICには，IPアドレス(管理用)>IPアドレス(2個目用)>IPアドレス(3個目用)>IPアドレス(4個目用)の順でIPアドレスを設定します。IPアドレスの指定に空きがある場合，詰めて設定します。例えば，指定するIPアドレスがIPアドレス(管理用)，IPアドレス(2個目用)，IPアドレス(4個目用)の場合(IPアドレス(3個目用)がない場合)，IPアドレス(4個目用)は仮想マシンの3つ目のNICに設定します。入力したIPアドレスの数が，仮想サーバが持つNICの数より多い場合，超えた分のIPアドレスは破棄されますのでご注意ください。

(5) 仮想サーバの接続先仮想スイッチ(2〜4個目用)を設定します。

　エクスポート済みの仮想サーバに，既に設定されている接続先仮想スイッチは，指定された仮想スイッチに上書きされます。

　1個目のNICには，ローカルサーバと通信可能な管理用の仮想スイッチを設定してください。2〜4個目のNICには管理用・業務用仮想スイッチをユーザーの運用に合わせて設定してください。

　指定した仮想スイッチの数が，仮想サーバが持つNICの数より多い場合，NICに割り当てられなかった仮想スイッチの設定は無効になります。

(6) 仮想サーバのOSに設定するIPアドレス(管理用)が指定され，かつ仮想サーバのIPアドレスが複数設定された場合に，スタティックルートを設定します。

(7) OS.selectWorkgroupDomainの選択リストで，DOMAINが選択され，かつドメイン名，ドメイン ユーザー名，ドメイン パスワードが指定されていた場合，ドメインへの参加処理を行います。

プロパティ設定の留意点を次に示します。

(1) OSユーザーパスワードとOSユーザーパスワード再入力は必須となります。どちらかの指定がない場合，"Password123"がパスワードに設定されます。また，2つの値が合致しない場合も"Password123"がパスワードに設定されます。

(2) OS.selectWorkgroupDomainの選択リストで，WORKGROUPを選択した場合，指定できるワークグループ名は最大15byteまでとなります。16byteを超えると"WORKGROUP"が設定されます。

(3) OS.selectWorkgroupDomainの選択リストで，DOMAINを選択した場合，ドメイン名，ドメイン ユーザー名，ドメイン パスワードが必須となります。どれかの指定がない場合，もしくはドメイン参加に失敗した場合，ワークグループとして"WORKGROUP"が設定されます。

(4) IPアドレス，サブネットマスクは，2つの情報をすべて指定してください。どれかの指定がない場合，IPアドレス，サブネットマスク，およびデフォルトゲートウェイの設定は行われません。

(5) 仮想スイッチの指定がない場合，仮想スイッチとの接続が切断された状態になります。

(6) スタティックルートの宛先IPアドレス，サブネットマスク，デフォルトゲートウェイは同時に指定してください。どれかの指定がない場合，スタティックルートの設定は行われません。

(7) 指定可能なタイムゾーンは次のとおりです。

　Tokyo Standard Time

　China Standard Time

　GMT Standard Time

　Pacific Standard Time

　Eastern Standard Time

　US Eastern Standard Time

　Central Standard Time

　Central America Standard Time

　US Mountain Standard Time

　Mountain Standard Time

　Alaskan Standard Time

　Hawaiian Standard Time

　Singapore Standard Time

　India Standard Time

指定がない場合，エクスポート済みの仮想サーバに設定されているタイムゾーンが引き継がれます。

(8) 指定可能なロケールは次のとおりです。

　ja-JP

　en-US

　zh-CN

(9) 指定可能なOS名は次のとおりです。

　Windows Server 2008 R2

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2008 R2 Hyper-V

【サービステンプレート実行システム内前提製品の稼働OS】

(1)Hyper-Vサーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)Hyper-Vサーバ上の設定に関する条件

　・仮想スイッチが設定済みであること。

　・仮想スイッチ名はHyper-Vサーバ内で一意であること。

　・デプロイに使用するエクスポート済みの仮想サーバが作成済みであること。

(2)デプロイに使用するエクスポート済みの仮想サーバに関する条件

　・Hyper-V 統合サービスの次のサービスが有効なこと。

　　①データ交換

　・Hyper-Vサーバからエクスポートする前に仮想サーバに次の設定が行われていること。

　　①Administratorユーザーのパスワードを空にしていること。

　　②ネットワーク設定を削除していること。

　　　仮想ホストのネットワークアダプタの情報を設定している場合は，次の設定個所を空にしてから，

　　　[IPアドレスを自動的に取得する]および[DNSサーバのアドレスを自動的に取得する]に設定すること。

　　　・IPアドレス

　　　・サブネットマスク

　　　・デフォルトゲートウェイ

　　　・優先DNSサーバ

　　　・代替DNSサーバ

　　③Sysprepを用いてOS情報が初期化されていること。

　　　その際，次のオプションを選択すること。

　　　[システム クリーンアップ アクション]プルダウンメニューから[システムのOOBE(Out-of-Box Experience)に入る]を選択する。

　　　[一般化する］チェックボックスをチェックする。

　・エージェントレス接続が可能な設定であること。

　・NICが設定してあること(最大4個まで)。

　・ファイアーウォールがICMP(ECHO)応答を許可していること。

　・格納サーバとHyper-Vサーバが別サーバの場合，Hyper-Vサーバからエクスポート済みの仮想サーバが格納されているフォルダに共有設定がされていること。

　・レガシーネットワークアダプターが設定されていないこと。

　・スナップショットおよび差分ディスクが作成されていないこと。

(3)仮想サーバに関する条件

　・仮想サーバ名はHyper-Vサーバ内で一意であること。

(4)本製品に関する条件

　・ローカルサーバ("localhost"で解決されるループバックアドレス)，Hyper-Vサーバおよびデプロイする仮想サーバのIPアドレス(管理用)を，「管理タブ」のエージェントレス接続定義に，事前に認証情報を登録してあること。

注意事項

(1)仮想スイッチの指定を省略すると，そのNICの接続先仮想スイッチ情報が削除され，接続されていない状態になります。仮想スイッチを設定する場合は，必ず指定してください。

(2)仮想サーバのOSに設定するIPアドレスについて，IPアドレスとして設定できない値は入力しないでください。例えば，ネットワークアドレスやブロードキャストアドレス，「0.0.0.0」や「255.255.255.255」などの特殊なアドレスは指定できません。入力した場合，仮想サーバのデプロイはエラーとなります。また，IPアドレス(管理用)には，ローカルサーバと通信できるIPアドレスを入力してください。正しいアドレスであっても，デプロイに失敗するおそれがあります。

(3)仮想サーバのデプロイ中は，ほかのサービスによって当該仮想サーバの操作を行わないでください。仮想サーバのデプロイに失敗するおそれがあります。Hyper-Vサーバからも直接操作を行わないでください。

(4)IPアドレスは「機能」に記載のとおり設定されますが，仮想サーバのOSにNICを設定した順番によっては，意図どおりIPアドレスが設定されない場合があるため，仮想サーバ作成後はIPアドレスが意図どおり設定されているか確認してください。もし設定されていない場合は，手動で変更してください。

(5)仮想サーバに設定するIPアドレスは，他のサーバと重複しないようにしてください。他のサーバとIPアドレスが重複していると，仮想サーバのNICが無効状態となり，タスクが異常終了する場合があります。

(6)エクスポート済みの仮想サーバには，仮想サーバ作成時に設定する情報をあらかじめ設定しないでください。コンピュータ名/ホスト名やIPアドレスがエクスポート済みの仮想サーバに設定されている場合，仮想サーバの作成に失敗する場合があります。失敗した場合(失敗の例としては，スタティックルートの処理でエラーが発生します。)，一度仮想サーバを削除し，コンピュータ名/ホスト名とIPアドレスが設定されていないエクスポート済みの仮想サーバを再作成のあと，このサービスを再実行してください。

(7)Windows Server 2008 R2 SP1 Hyper-Vで作成した仮想サーバを基に，Windows Server 2008 R2 Hyper-Vにデプロイを行う場合は，Microsoft RemoteFX およびダイナミックメモリのどちらも無効にしてください。

(8)デプロイに失敗した場合，仮想サーバのOS初期設定およびIPアドレス設定に使用した応答ファイルが，仮想サーバのシステムドライブ内に削除されずに残る場合があります。タスクログを確認し応答ファイルを削除するか，仮想サーバを削除してください。

(9)インポート先に指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。

(10)インポート先に指定したパスのフォルダ内に仮想ディスクファイルが残っている場合は，タスクが異常終了します。インポート先に指定したパスのフォルダを確認し，仮想ディスクを削除するか，別のパスを指定してください。

(11)このサービスは，フェールオーバークラスターマネージャーのサービスとアプリケーションにデプロイした仮想サーバを登録しません。ユーザーの運用に合わせて手動で登録してください。

(12)仮想サーバの仮想ディスクをHyper-Vサーバへマウントする際に，Hyper-Vサーバ上の空きドライブ文字を一時的に占有します。そのため，Hyper-Vサーバ上に空きドライブ文字が存在しない場合は，仮想ディスクのマウント処理でエラーが発生し，タスクが異常終了します。エクスポート済みの仮想サーバの仮想ディスクが使用するドライブ分，Hyper-Vサーバ上にドライブ文字が空いていることを確認の上，このサービスを実行してください。

実行権限

ビルトイン Administrator

バージョン

03.00.00

タグ

Add VM,Hyper-V 2008

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

Hyper-Vの情報を指定してください。

表示されます。

仮想サーバ情報

追加する仮想サーバの情報を指定してください。

表示されます。

OS情報

仮想サーバに設定するOS情報を指定してください。

表示されます。

ネットワーク情報

仮想サーバのネットワーク情報を指定してください。

表示されます。

実行時オプション

仮想サーバのOS初期設定を行う際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.targetHost

Hyper-Vサーバのホスト名

Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

hyperv.userName

格納サーバに接続するためのユーザー名

格納サーバに接続するためのユーザー名を指定します。格納サーバがHyper-Vサーバと別サーバの場合は指定してください。

入力

無効

△　

仮想サーバ情報

hyperv.password

格納サーバに接続するためのパスワード

格納サーバに接続するためのパスワードを指定します。格納サーバがHyper-Vサーバと別サーバの場合は指定してください。

入力

無効

△　

仮想サーバ情報

windows.orgName

組織名(会社名)

仮想サーバのOSに設定する組織名を指定します。

入力

無効

○　

OS情報

windows.ownerName

名前(所有者名)

仮想サーバのOSに設定する名前(所有者名)を指定します。

入力

無効

○　

OS情報

OS.selectWorkgroupDomain

ワークグループ/ドメインの選択

仮想サーバがワークグループまたはドメインのどちらに所属するかを指定します。

入力

無効

○　

OS情報

OS.workgroupNameDomainName

ワークグループ名/ドメイン名

仮想サーバが所属するワークグループ名/ドメイン名を指定します。ワークグループ名は，最大15文字まで指定します。ドメイン名は，最大63文字まで指定します。

入力

無効

○　

OS情報

OS.domainUserName

ドメインのユーザー名

仮想サーバが所属するドメインのユーザー名を指定します。ワークグループ/ドメインの選択で「DOMAIN」を選択した場合，入力する必要があります。

入力

無効

△　

OS情報

OS.domainUserPassword

ドメインのパスワード

仮想サーバが所属するドメインのパスワードを指定します。ワークグループ/ドメインの選択で「DOMAIN」を選択した場合，入力する必要があります。

入力

無効

△　

OS情報

OS.subnetMaskMan

サブネットマスク(管理用)

仮想サーバに設定する管理用LANのサブネットマスクを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.defaultGWMan

デフォルトゲートウェイ(管理用)

仮想サーバに設定する管理用LANのデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.dnsMan

DNSサーバのIPアドレス(管理用)

仮想サーバに設定する管理用LANのDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

hyperv.virtualSwitchMan

仮想スイッチ名(管理用)

仮想サーバに設定されているNIC(管理用)に設定する仮想スイッチ名(管理用)を指定します。

入力

無効

△　

ネットワーク情報

OS.subnetMask2

サブネットマスク(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.defaultGW2

デフォルトゲートウェイ(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.dns2

DNSサーバのIPアドレス(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

hyperv.virtualSwitch2

仮想スイッチ名(2個目用)

仮想サーバに設定されているNIC(2個目用)に設定する仮想スイッチ名(2個目用)を指定します。

入力

無効

△　

ネットワーク情報

OS.subnetMask3

サブネットマスク(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.defaultGW3

デフォルトゲートウェイ(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.dns3

DNSサーバのIPアドレス(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

hyperv.virtualSwitch3

仮想スイッチ名(3個目用)

仮想サーバに設定されているNIC(3個目用)に設定する仮想スイッチ名(3個目用)を指定します。

入力

無効

△　

ネットワーク情報

OS.subnetMask4

サブネットマスク(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.defaultGW4

デフォルトゲートウェイ(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.dns4

DNSサーバのIPアドレス(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

hyperv.virtualSwitch4

仮想スイッチ名(4個目用)

仮想サーバに設定されているNIC(4個目用)に設定する仮想スイッチ名(4個目用)を指定します。

入力

無効

△　

ネットワーク情報

OS.destIPAddress

スタティックルートの宛先IPアドレス

スタティックルートの宛先IPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.subnetMaskStaticRoute

サブネットマスク(スタティックルート用)

スタティックルート用のサブネットマスクを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.defaultGWStaticRoute

デフォルトゲートウェイ(スタティックルート用)

スタティックルート用のデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

hyperv.checkVmStateEnabledCount

仮想サーバの状態(起動完了)の確認回数

仮想サーバの起動が完了したか確認する際の確認回数を指定します。仮想サーバの状態(起動完了)の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

hyperv.checkVmStateEnabledInterval

仮想サーバの状態(起動完了)の確認間隔

仮想サーバの起動が完了したか確認する際の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

hyperv.checkVmStateDisabledCount

仮想サーバの状態(停止完了)の確認回数

仮想サーバの停止が完了したか確認する際の確認回数を指定します。仮想サーバの状態(停止完了)の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

hyperv.checkVmStateDisabledInterval

仮想サーバの状態(停止完了)の確認間隔

仮想サーバの停止が完了したか確認する際の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

common.icmpEchoTimeout

ICMPエコー要求のタイムアウト時間

ネットワーク接続確認を実行する場合，仮想サーバの起動後に実行する，ICMPエコー要求に対する応答を待つ時間をミリ秒単位で指定します。

入力

無効

○　

実行時オプション

hyperv.checkJobStateCountNewSw

ジョブ監視回数(ModifyVirtualSystemResourcesメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(ModifyVirtualSystemResourcesメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobStateIntervalNewSw

ジョブ監視間隔(ModifyVirtualSystemResourcesメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(ModifyVirtualSystemResourcesメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobStateCountGetVm

ジョブ監視回数(GetVirtualSystemImportSettingDataメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(GetVirtualSystemImportSettingDataメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobStateIntervalGetVm

ジョブ監視間隔(GetVirtualSystemImportSettingDataメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(GetVirtualSystemImportSettingDataメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobStateCountNewVm

ジョブ監視回数(ImportVirtualSystemExメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(ImportVirtualSystemExメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobStateIntervalNewVm

ジョブ監視間隔(ImportVirtualSystemExメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(ImportVirtualSystemExメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobPowerOnCount

ジョブ監視回数(RequestStateChangeメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(RequestStateChangeメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobPowerOnInterval

ジョブ監視間隔(RequestStateChangeメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(RequestStateChangeメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobShutdownCount

ジョブ監視回数(InitiateShutdownメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(InitiateShutdownメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobShutdownInterval

ジョブ監視間隔(InitiateShutdownメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(InitiateShutdownメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobStateCountGetDriveList

ジョブ監視回数(Win32_LogicalDiskメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(Win32_LogicalDiskメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobStateIntervalGetDriveList

ジョブ監視間隔(Win32_LogicalDiskメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(Win32_LogicalDiskメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

仮想サーバ情報

hyperv.exportedVmName

エクスポート済みの仮想サーバのフォルダのパス

仮想サーバの複製元となるエクスポート済みの仮想サーバのフォルダ名をフルパスで指定します。格納サーバがHyper-Vサーバと別サーバの場合，UNCを指定してください。

入力

無効

○　

仮想サーバ情報

hyperv.importFolderPath

インポート先

仮想サーバを格納するフォルダをフルパスで指定します。

入力

無効

○　

仮想サーバ情報

windows.operatingSystem

OS名

仮想サーバのOS名を指定します。

入力

無効

○　

仮想サーバ情報

OS.computerName

コンピュータ名/ホスト名

OSのコンピュータ名(ホスト名)を指定します。

入力

無効

○　

OS情報

OS.osUserPassword

Administratorのパスワード

OSに設定するAdministratorのパスワードを指定します。入力がない場合は，"Password123"が設定されます。

入力

無効

△　

OS情報

OS.osUserPasswordReEnter

Administratorのパスワード再入力

OSに設定するAdministratorのパスワードを再入力してください。入力がない場合は，"Password123"が設定されます。

入力

無効

△　

OS情報

OS.productKey

OSのプロダクトキー

OSのプロダクトキーを指定します。入力の形式は「XXXXX-XXXXX-XXXXX-XXXXX-XXXXX」です。

入力

無効

△　

OS情報

OS.ipAddressMan

IPアドレス(管理用)

仮想サーバに設定する管理用LANのIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.ipAddress2

IPアドレス(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.ipAddress3

IPアドレス(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.ipAddress4

IPアドレス(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.timeZoneWin

タイムゾーン

仮想サーバのOSに設定するタイムゾーンを指定します。

入力

無効

△　

OS情報

OS.systemLocale

システムロケール

仮想サーバのOSに設定されているシステムロケールを指定します。

入力

無効

○　

OS情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.targetHost

256文字以内の半角英数字および「.」，「-」。

hyperv.userName

20文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「¥」，「@」，「%」を除く。

hyperv.password

127文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

windows.orgName

256文字以内の文字列。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

windows.ownerName

256文字以内の文字列。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

OS.selectWorkgroupDomain

次の値のどれかを選択する。

WORKGROUP,DOMAIN

OS.workgroupNameDomainName

63文字以内の半角英数字。および「-」，「.」。

OS.domainUserName

20文字以内の半角英数字。および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「¥」，「@」，「%」を除く。

OS.domainUserPassword

127文字以内の半角英数字。および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

OS.subnetMaskMan

15文字以内の半角数字および「.」。

OS.defaultGWMan

15文字以内の半角数字および「.」。

OS.dnsMan

15文字以内の半角数字および「.」。

hyperv.virtualSwitchMan

63文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

OS.subnetMask2

15文字以内の半角数字および「.」。

OS.defaultGW2

15文字以内の半角数字および「.」。

OS.dns2

15文字以内の半角数字および「.」。

hyperv.virtualSwitch2

63文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

OS.subnetMask3

15文字以内の半角数字および「.」。

OS.defaultGW3

15文字以内の半角数字および「.」。

OS.dns3

15文字以内の半角数字および「.」。

hyperv.virtualSwitch3

63文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

OS.subnetMask4

15文字以内の半角数字および「.」。

OS.defaultGW4

15文字以内の半角数字および「.」。

OS.dns4

15文字以内の半角数字および「.」。

hyperv.virtualSwitch4

63文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

OS.destIPAddress

15文字以内の半角数字および「.」。

OS.subnetMaskStaticRoute

15文字以内の半角数字および「.」。

OS.defaultGWStaticRoute

15文字以内の半角数字および「.」。

hyperv.checkVmStateEnabledCount

1〜2147483647の整数値。

hyperv.checkVmStateEnabledInterval

1〜60の整数値。

hyperv.checkVmStateDisabledCount

1〜2147483647の整数値。

hyperv.checkVmStateDisabledInterval

1〜60の整数値。

common.icmpEchoTimeout

1〜214783647の整数値。

hyperv.checkJobStateCountNewSw

1〜2147483647の整数値。

hyperv.checkJobStateIntervalNewSw

1〜60の整数値。

hyperv.checkJobStateCountGetVm

1〜2147483647の整数値。

hyperv.checkJobStateIntervalGetVm

1〜60の整数値。

hyperv.checkJobStateCountNewVm

1〜2147483647の整数値。

hyperv.checkJobStateIntervalNewVm

1〜60の整数値。

hyperv.checkJobPowerOnCount

1〜2147483647の整数値。

hyperv.checkJobPowerOnInterval

1〜60の整数値。

hyperv.checkJobShutdownCount

1〜2147483647の整数値。

hyperv.checkJobShutdownInterval

1〜60の整数値。

hyperv.checkJobStateCountGetDriveList

1〜2147483647の整数値。

hyperv.checkJobStateIntervalGetDriveList

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.vmName

100文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」，「¥」，「/」，「:」，先頭の「 (スペース)」および末尾の「 (スペース)」，「.」を除く。

hyperv.exportedVmName

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「'」，「[」，「]」，「`」および末尾の「¥」を除く。

hyperv.importFolderPath

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「'」，「[」，「]」，「`」および末尾の「¥」を除く。

windows.operatingSystem

次の値のどれかを選択する。

Windows Server 2008 R2

OS.computerName

15文字以内の半角英数字および「-」。

OS.osUserPassword

64文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。

OS.osUserPasswordReEnter

64文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。

OS.productKey

29文字以内の半角英数字，および「-」。

OS.ipAddressMan

15文字以内の半角数字および「.」。

OS.ipAddress2

15文字以内の半角数字および「.」。

OS.ipAddress3

15文字以内の半角数字および「.」。

OS.ipAddress4

15文字以内の半角数字および「.」。

OS.timeZoneWin

次の値のどれかを選択する。

Tokyo Standard Time, China Standard Time, GMT Standard Time, Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Central Standard Time, Central America Standard Time, US Mountain Standard Time, Mountain Standard Time, Alaskan Standard Time, Hawaiian Standard Time, Singapore Standard Time, India Standard Time

OS.systemLocale

次の値のどれかを選択する。

ja-JP,en-US,zh-CN

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの作成

仮想サーバの作成

仮想サーバの作成

Hyper-V環境において，エクスポート済みの仮想サーバから仮想サーバを作成します。

エラーの原因を取り除いたあと，サービスを再実行してください。

Hyper-Vサーバに仮想サーバが作成されている場合は，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

2

仮想サーバの仮想スイッチ設定(管理用)

仮想サーバの仮想スイッチ設定(管理用)

仮想サーバの仮想スイッチ設定

ローカルサーバとの通信を確立するために，仮想スイッチを設定します。

タスクログを確認し，エラーの原因を取り除いたあと，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

3

応答ファイルの配置

応答ファイルの配置

階層フロー部品

仮想サーバに応答ファイルを配置します。

−　

3-1

仮想ディスクのマウント

Hyper-Vサーバに仮想ディスクをマウントします。

エラーの原因を取り除いたあと，Hyper-Vサーバに仮想ディスクがマウントされている場合は，手動でアンマウントしてください。その後，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

3-2

応答ファイル作成

Hyper-V環境の仮想サーバに対してOSの初期設定，およびIPアドレス設定を行うための応答ファイルを作成します。

エラーの原因を取り除いたあと，Hyper-Vサーバに仮想ディスクがマウントされている場合は，手動でアンマウントしてください。その後，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

3-3

仮想ディスクのアンマウント

Hyper-Vサーバから仮想ディスクをアンマウントします。

エラーの原因を取り除いたあと，Hyper-Vサーバに仮想ディスクがマウントされている場合は，手動でアンマウントしてください。その後，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

4

OS初期設定&IPアドレス設定

OS初期設定&IPアドレス設定

階層フロー部品

仮想サーバのOS初期設定(コンピュータ名，会社名，組織名)とIPアドレス設定を行い，仮想サーバを起動します。

−　

4-1

仮想サーバの起動

Hyper-V環境において，仮想サーバを起動します。

エラーの原因を取り除いたあと，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

4-4

値判定分岐部品

NICにIPアドレスが設定されているか判定します。

タスクログを確認し，エラーの原因を取り除いたあと，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

4-5

階層フロー部品

ローカルサーバと仮想サーバのネットワーク接続を確認し，2〜4個目のNICにIPアドレスを設定します。

−　

4-5-1

ICMPエコー要求メッセージの送信

電源状態がONになった仮想サーバにICMPエコー要求を発行します。

タスクログを確認し，エラーの原因を取り除いたあと，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

4-5-4

値判定分岐部品

2〜4個目のNICの設定が必要か判定します。

タスクログを確認し，エラーの原因を取り除いたあと，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

4-5-5

階層フロー部品

2〜4個目のNICの設定を行います。

−　

4-5-5-1

NICのMACアドレス取得

管理用NICのMACアドレスを取得します。

タスクログを確認し，エラーの原因を取り除いたあと，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

4-5-5-2

仮想サーバの仮想スイッチ設定

2〜4個目のNICと仮想スイッチの接続を切断します。

タスクログを確認し，エラーの原因を取り除いたあと，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

4-5-5-3

Windowsネットワークの設定

2〜4個目のNICにIPアドレスを設定します。

Hyper-Vサーバにログインし，仮想サーバの設定を確認してください。その後，仮想サーバにログインし，仮想サーバの設定を確認してください。必要に応じて仮想サーバの設定を手動で行ってください。もしくは，タスクログを確認し，エラーの要因を取り除いたあと，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

5

仮想サーバの仮想スイッチ設定(2〜4個目用)

仮想サーバの仮想スイッチ設定(2〜4個目用)

階層フロー部品

2〜4個目のNICに仮想スイッチを設定します。

−　

5-1

値判定分岐部品

NICにIPアドレスが設定されているか判定します。

Hyper-Vサーバにログインし，仮想サーバの設定を確認してください。その後，仮想サーバにログインし，仮想サーバの設定を確認してください。必要に応じて仮想サーバの設定を手動で行ってください。もしくは，タスクログを確認し，エラーの要因を取り除いたあと，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

5-2

階層フロー部品

2〜4個目のNICに仮想スイッチを設定します。

−　

5-2-1

値判定分岐部品

2〜4個目のNICの設定が必要か判定します。

Hyper-Vサーバにログインし，仮想サーバの設定を確認してください。その後，仮想サーバにログインし，仮想サーバの設定を確認してください。必要に応じて仮想サーバの設定を手動で行ってください。もしくは，タスクログを確認し，エラーの要因を取り除いたあと，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

5-2-2

階層フロー部品

2〜4個目のNICに仮想スイッチを設定します。

−　

5-2-2-1

NICのMACアドレス取得

2〜4個目のNICのMACアドレスを取得します。

Hyper-Vサーバにログインし，仮想サーバの設定を確認してください。その後，仮想サーバにログインし，仮想サーバの設定を確認してください。必要に応じて仮想サーバの設定を手動で行ってください。もしくは，タスクログを確認し，エラーの要因を取り除いたあと，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

5-2-2-2

仮想サーバの仮想スイッチ設定

2〜4個目のNICに仮想スイッチを設定します。

Hyper-Vサーバにログインし，仮想サーバの設定を確認してください。その後，仮想サーバにログインし，仮想サーバの設定を確認してください。必要に応じて仮想サーバの設定を手動で行ってください。もしくは，タスクログを確認し，エラーの要因を取り除いたあと，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

5-3

値判定分岐部品

NICにIPアドレスが設定されているか判定します。

Hyper-Vサーバにログインし，仮想サーバの設定を確認してください。その後，仮想サーバにログインし，仮想サーバの設定を確認してください。必要に応じて仮想サーバの設定を手動で行ってください。もしくは，タスクログを確認し，エラーの要因を取り除いたあと，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

5-4

仮想サーバの仮想スイッチ設定

2〜4個目のNICに仮想スイッチを設定します。

Hyper-Vサーバにログインし，仮想サーバの設定を確認してください。その後，仮想サーバにログインし，仮想サーバの設定を確認してください。必要に応じて仮想サーバの設定を手動で行ってください。もしくは，タスクログを確認し，エラーの要因を取り除いたあと，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

6

OSスタティックルート設定

OSスタティックルート設定

階層フロー部品

仮想サーバのOSで，スタティックルートを設定します。

−　

6-3

値判定分岐部品

スタティックルートの設定が必要か判定します。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

6-4

階層フロー部品

仮想サーバのOSで，管理用IPアドレスが設定されていることを確認します。

−　

6-4-3

値判定分岐部品

仮想サーバのOSで，管理用IPアドレスが設定されているか判定します。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

6-4-4

OSスタティックルート設定

仮想サーバのOSで，スタティックルートを設定します。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

7

ドメインへの参加

ドメインへの参加

階層フロー部品

ドメインへの参加処理を行います。

−　

7-1

値判定分岐部品

仮想サーバのOSで，管理用IPアドレスが設定されているか判定します。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

7-2

階層フロー部品

ドメインへの参加処理を行います。

−　

7-2-3

値判定分岐部品

ドメインへの参加処理が必要か判定します。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

7-2-4

階層フロー部品

ドメインへの参加処理の成否を確認する。

−　

7-2-4-1

Windowsネットワークの設定

ドメインへの参加処理を行います。

−　

7-2-4-4

値判定分岐部品

ドメインへの参加処理の成否を判定します。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

7-2-4-5

階層フロー部品

Hyper-V環境において，仮想サーバを再起動します。

−　

7-2-4-5-1

仮想サーバのシャットダウン

Hyper-V環境において，仮想サーバをシャットダウンします。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

7-2-4-5-2

仮想サーバの起動

Hyper-V環境において，仮想サーバを起動します。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

3.6.3　仮想サーバの追加(仮想ディスク)

機能

このサービステンプレートは，Hyper-V環境の仮想サーバにディスクを追加します。

このサービステンプレートが前提とするサーバを次に示します。

・Hyper-Vサーバ

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

処理の概要を次に示します。

(1) 仮想サーバの状態を取得します。

(2) 仮想サーバの状態が停止完了になっていることを確認します。

　　仮想サーバの状態が起動完了または停止完了の場合は，処理を継続しますが，それ以外(起動中，停止中，一時停止やスナップショット取得中など)の場合は，仮想サーバには操作を行わずにタスクが異常終了します。

　　仮想サーバの状態が起動完了の場合は，ユーザー応答待ち部品を実行して，シャットダウンするか・しないかを確認します。

　　ユーザー応答待ちのGUIで"Shutdown"を選択した場合は，仮想サーバをシャットダウンします。

　　"Cancel"を選択するか，応答待ちがタイムアウトになった場合は，仮想サーバには操作を行わずにタスクが異常終了します。

　　仮想サーバのOSをシャットダウンする際には，hyperv.checkVmStateDisabledIntervalプロパティに指定した秒数待ち合わせ，仮想サーバの状態を確認する動作を，hyperv.checkVmStateDisabledCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

(3) 仮想サーバに仮想ディスクを追加します。

　　仮想サーバに仮想ディスク(容量可変/容量固定)を追加できますが，仮想ディスク(差分)およびパススルー(物理)ディスクは追加できません。

　　hyperv.vhdPathプロパティに指定したパスに，仮想ディスクファイルを新規に作成します。

　　仮想ディスクは，SCSIコントローラーに追加できますが，IDEコントローラーには追加できません。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2008 R2 Hyper-V

【サービステンプレート実行システム内前提製品の稼働OS】

(1)Hyper-Vサーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。

　・オペレーティングシステムのシャットダウン

(3)仮想サーバが停止完了の状態であること。

(4)仮想サーバにSCSIコントローラーが存在すること。

注意事項

(1)このサービステンプレートでは仮想サーバに追加した仮想ディスクの初期化は行いません。必要に応じて仮想サーバのOSにログインし，ディスクの初期化を実施してください。

(2)同一の仮想サーバに対して，このサービスを複数同時に実行しないでください。

(3)UserResponseplugin.dialogTextプロパティにHTMLタグを指定する場合，指定できるタグおよび属性はユーザー応答待ち部品と同じです。詳細については，本製品マニュアルの「ユーザー応答待ち部品」について説明しているトピックを参照してください。

(4)Hyper-Vサーバに作成済みの仮想ディスクファイルは追加できません。

(5)ユーザー応答待ちのGUIで"Shutdown"を選択した場合は，仮想サーバのOSを強制的にシャットダウンします。仮想サーバで編集中のファイルデータは保存されません。

バージョン

03.00.00

タグ

Modify VM,Hyper-V 2008

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

Hyper-Vサーバの情報を指定してください。

表示されます。

仮想ディスク情報

追加する仮想ディスクの情報を指定してください。

表示されます。

ユーザー応答待ちオプション

仮想サーバが起動していた場合のユーザー応答のためのオプションです。必要に応じて変更してください。

表示されません。

実行時オプション

仮想サーバの状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.targetHost

Hyper-Vサーバのホスト名

Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

UserResponsePlugin.toAddress

TOメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(TO)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.ccAddress

CCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(CC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.bccAddress

BCCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(BCC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailSubject

メール件名

ユーザー応答待ちになった場合のメール通知のメールの件名を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailBody

メール本文

ユーザー応答待ちになった場合のメール通知のメール本文を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.encodeType

エンコード種別

ユーザー応答待ちになった場合のメール通知のエンコード種別を指定します。指定可能なエンコード名は次のとおりです。us-ascii，iso-2022-jp，shift_jis，euc-jp，utf-8。指定しなかった場合には，utf-8で送信されます。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.dialogText

応答入力画面の補足情報

ユーザー応答待ちになった場合の応答入力ダイアログに表示する補足情報を指定します。テキスト形式，またはHTML形式で指定できます。指定可能なHTMLタグは，アンカータグ，ボールドタグ，ブレークタグ，フォントタグ，イタリックタグ，下線タグです。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.responseTimeOut

応答タイムアウト時間(分)

ユーザー応答待ちになった場合の応答がタイムアウトする時間を分単位で指定します。応答タイムアウト時間が過ぎると，サービスが異常終了します。

入力

無効

○　

ユーザー応答待ちオプション

hyperv.checkVmStateDisabledCount

仮想サーバの状態(停止完了)の確認回数

仮想サーバの停止が完了したか確認する際の確認回数を指定します。仮想サーバの状態(停止完了)の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

hyperv.checkVmStateDisabledInterval

仮想サーバの状態(停止完了)の確認間隔

仮想サーバの停止が完了したか確認する際の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

hyperv.checkJobShutdownCount

ジョブ監視回数(InitiateShutdownメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(InitiateShutdownメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobShutdownInterval

ジョブ監視間隔(InitiateShutdownメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(InitiateShutdownメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobNewVhdCount

ジョブ監視回数(CreateDynamicVirtualHardDisk/CreateFixedVirtualHardDiskメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(CreateDynamicVirtualHardDisk/CreateFixedVirtualHardDiskメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobNewVhdInterval

ジョブ監視間隔(CreateDynamicVirtualHardDisk/CreateFixedVirtualHardDiskメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(CreateDynamicVirtualHardDisk/CreateFixedVirtualHardDiskメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobAssignSCSICount

ジョブ監視回数(AddVirtualSystemResourcesメソッド，ハード ドライブの追加)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(AddVirtualSystemResourcesメソッド，ハード ドライブの追加)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobAssignSCSIInterval

ジョブ監視間隔(AddVirtualSystemResourcesメソッド，ハード ドライブの追加)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(AddVirtualSystemResourcesメソッド，ハード ドライブの追加)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobJoinCount

ジョブ監視回数(AddVirtualSystemResourcesメソッド，ディスクとの接続)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(AddVirtualSystemResourcesメソッド，ディスクとの接続)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobJoinInterval

ジョブ監視間隔(AddVirtualSystemResourcesメソッド，ディスクとの接続)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(AddVirtualSystemResourcesメソッド，ディスクとの接続)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

仮想ディスク情報

hyperv.vHardDiskType

仮想ディスクのタイプ

仮想ディスクのタイプを指定します。次のどちらかを指定します。Dynamic:容量可変の仮想ディスクを作成します。Fixed:容量固定の仮想ディスクを作成します。

入力

無効

○　

仮想ディスク情報

hyperv.scsiControllerNumber

SCSIコントローラーの番号

仮想ディスクを追加する仮想サーバのSCSIコントローラーの番号を指定します。SCSIコントローラーの番号は，仮想サーバにSCSIコントローラーを追加した(Hyper-V マネージャーで表示する)順番を0から相対する整数値で指定してください。

入力

無効

○　

仮想ディスク情報

hyperv.scsiLocationNumber

SCSIコントローラーの場所番号

仮想ディスクを追加する仮想サーバのSCSIコントローラーの場所番号を指定します。SCSIコントローラーの場所番号は，仮想サーバに追加したSCSIコントローラーの未使用の場所を整数値で指定してください。

入力

無効

○　

仮想ディスク情報

hyperv.vhdPath

仮想ディスクファイルのパス

作成する仮想ディスクファイルのパスをフルパスで指定します。仮想ディスクファイルの拡張子はvhdを指定してください。作成済みの仮想ディスクファイルは指定できません。

入力

無効

○　

仮想ディスク情報

hyperv.capacity

容量 (GB)

仮想ディスクの容量をGB単位で指定します。

入力

無効

○　

仮想ディスク情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.targetHost

256文字以内の半角英数字および「.」，「-」。

UserResponsePlugin.toAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.ccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.bccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.mailSubject

256文字以内の文字列。

UserResponsePlugin.mailBody

1024文字以内の文字列。

UserResponsePlugin.encodeType

次の値のどれかを選択する。

us-ascii,iso-2022-jp,shift_jis,euc-jp,utf-8

UserResponsePlugin.dialogText

512文字以内の文字列。

UserResponsePlugin.responseTimeOut

1〜9999の整数値。

hyperv.checkVmStateDisabledCount

1〜2147483647の整数値。

hyperv.checkVmStateDisabledInterval

1〜60の整数値。

hyperv.checkJobShutdownCount

1〜2147483647の整数値。

hyperv.checkJobShutdownInterval

1〜60の整数値。

hyperv.checkJobNewVhdCount

1〜2147483647の整数値。

hyperv.checkJobNewVhdInterval

1〜60の整数値。

hyperv.checkJobAssignSCSICount

1〜2147483647の整数値。

hyperv.checkJobAssignSCSIInterval

1〜60の整数値。

hyperv.checkJobJoinCount

1〜2147483647の整数値。

hyperv.checkJobJoinInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.vmName

100文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」，「¥」，「/」，「:」，先頭の「 (スペース)」および末尾の「 (スペース)」，「.」を除く。

hyperv.vHardDiskType

次の値のどれかを選択する。

Dynamic,Fixed

hyperv.scsiControllerNumber

0以上3以下の整数値。

hyperv.scsiLocationNumber

0以上63以下の整数値。

hyperv.vhdPath

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「'」，「[」，「]」，「`」および末尾の「¥」を除く。

hyperv.capacity

1以上2040以下の整数値。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの状態取得

仮想サーバの状態取得

仮想サーバの状態取得

Hyper-V環境において，仮想サーバの状態を取得します。

仮想サーバの状態を確認してください。

2

仮想サーバの状態確認

仮想サーバの状態確認

階層フロー部品

仮想サーバの状態を調べ，起動完了の状態であれば，ユーザーに確認します。

−　

2-3

値判定分岐部品

仮想サーバが「起動完了」の状態かどうかを判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4

階層フロー部品

仮想サーバをシャットダウンします。

−　

2-4-1

ユーザー応答待ち部品

仮想サーバのシャットダウンを行うかを確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4-2

戻り値判定分岐部品

ユーザー応答待ち部品の戻り値が1か判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4-3

異常終了部品

ジョブネットをエラーにします。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4-4

仮想サーバのシャットダウン

Hyper-V環境において，仮想サーバをシャットダウンします。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

仮想ディスクの追加

仮想ディスクの追加

階層フロー部品

仮想サーバにディスクを追加します。

−　

3-1

仮想サーバへのディスク追加

Hyper-V環境において，仮想サーバにディスクを追加します。

エラーの原因を取り除いてください。

仮想ディスクファイルが作成されている場合は手動で削除してください。

仮想サーバのSCSIコントローラーの場所が，使用中で仮想ディスクファイルのパスの指定がない場合は，SCSIコントローラーからハードドライブを削除する操作で，SCSIコントローラーの場所の使用中を解除してください。

そのあと，サービスを再実行してください。

3.7　Hyper-V 2008（運用）用のサービステンプレート

3.7.1　仮想サーバの起動

機能

このサービステンプレートは，Hyper-V環境の複数の仮想サーバを起動します。

このサービステンプレートが前提とするサーバを次に示します。

・Hyper-Vサーバ

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

処理の概要を次に示します。

(1) 仮想サーバの状態を取得します。詳細については，本製品マニュアルの「Hyper-Vが管理している仮想サーバの状態一覧」を参照してください。

(2) 仮想サーバが停止完了の状態である場合に，仮想サーバを起動します。状態が起動完了の場合は，仮想サーバを起動する処理をスキップし，状態が起動完了と停止完了以外の場合は，該当する仮想サーバの処理がエラーとなります

(3) ネットワーク接続確認を実施する場合は，起動した仮想サーバに設定されているIPアドレス(IPv4)を取得したのち，ローカルサーバから起動した仮想サーバに対してICMPエコー要求を送信し，ネットワーク接続を確認します。

上記の処理を，指定された仮想サーバ群に対して並列に実行します。

仮想サーバを起動する際には，hyperv.checkVmStateEnabledIntervalプロパティに指定した秒数待ち合わせ，仮想サーバの状態を確認する動作を，hyperv.checkVmStateEnabledCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2008 R2 Hyper-V

【サービステンプレート実行システム内前提製品の稼働OS】

(1)Hyper-Vサーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。

・データ交換

(3)ネットワーク接続確認を実行する場合，エージェントレス接続先としてローカルサーバ("localhost"で解決されるループバックアドレス)を設定する必要があります。

(4)ネットワーク接続確認を実行する場合，対象となる仮想サーバのファイアーウォールがICMP(ECHO)応答を許可していること。

注意事項

(1)ネットワーク接続確認を実施する場合は，システム環境によって，仮想サーバの起動直後にすべてのIPアドレスが取得できない場合があります。そのため，仮想サーバが起動しているにも関わらず，osSendIcmp部品で仮想サーバに設定されたすべてのIPアドレス(IPv4)でネットワークの接続確認が出来ずにタスクが異常終了する場合があります。仮想サーバの起動からIPアドレス取得開始までの待機時間を指定するhyperv.waitTimeプロパティの秒数を指定して，すべてのIPアドレスが取得できるように調節してください。

(2)ネットワーク接続確認を実施する場合は，仮想サーバのすべてのNICに設定されているIPアドレス(IPv4)の長さの合計を1024文字以内(※1)にして設定してください。IPアドレス(IPv4)の長さの合計が1024文字を超えると，osSendIcmp部品でエラーが発生し，タスクが異常終了する場合があります。

※IPアドレス(IPv4)１つの最大の長さは16文字(IPアドレス連結用の「,(コンマ)」を含む)。

(3)ネットワーク接続確認を実行する場合，common.icmpEchoTimeoutプロパティは利用している環境に応じて調整してください。

実行権限

ビルトイン Administrator

バージョン

03.00.00

タグ

Control VM,Hyper-V 2008

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

Hyper-Vの情報を指定してください。

表示されます。

仮想サーバ情報

起動する仮想サーバの情報を指定してください。

表示されます。

ネットワーク接続確認

仮想サーバを起動したあとのネットワーク接続確認に関するプロパティです。必要に応じて変更してください。

表示されません。

実行時オプション

仮想サーバを起動する際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.targetHost

Hyper-Vサーバのホスト名

Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

hyperv.waitTime

IPアドレス取得開始までの待機時間

ネットワーク接続確認を実行する場合，仮想サーバの起動が完了してからIPアドレス取得を開始するまでの待機時間を秒単位で指定します。

入力

無効

○　

ネットワーク接続確認

common.icmpEchoTimeout

ICMPエコー要求のタイムアウト時間

ネットワーク接続確認を実行する場合，仮想サーバの起動後に実行する，ICMPエコー要求に対する応答を待つ時間をミリ秒単位で指定します。

入力

無効

○　

ネットワーク接続確認

hyperv.checkVmStateEnabledCount

仮想サーバの状態(起動完了)の確認回数

仮想サーバの起動が完了したか確認する際の確認回数を指定します。仮想サーバの状態(起動完了)の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

hyperv.checkVmStateEnabledInterval

仮想サーバの状態(起動完了)の確認間隔

仮想サーバの起動が完了したか確認する際の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

hyperv.checkJobPowerOnCount

ジョブ監視回数(RequestStateChangeメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(RequestStateChangeメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobPowerOnInterval

ジョブ監視間隔(RequestStateChangeメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(RequestStateChangeメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.foreachVmName

仮想サーバ名(複数指定可)

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。複数指定する場合はコンマで区切ってください。99個まで指定できます。

入力

無効

○　

仮想サーバ情報

hyperv.checkNetworkConnection

ネットワーク接続確認の実行

仮想サーバの起動後にネットワーク接続確認を実行するかどうかを指定します。

入力

無効

○　

ネットワーク接続確認

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.targetHost

256文字以内の半角英数字および「.」，「-」。

hyperv.waitTime

0〜3600の整数値。

common.icmpEchoTimeout

1〜214783647の整数値。

hyperv.checkVmStateEnabledCount

1〜2147483647の整数値。

hyperv.checkVmStateEnabledInterval

1〜60の整数値。

hyperv.checkJobPowerOnCount

1〜2147483647の整数値。

hyperv.checkJobPowerOnInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.foreachVmName

1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」，「/」，「:」を除く。

hyperv.checkNetworkConnection

次の値のどれかを選択する。

yes,no

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの起動

仮想サーバの起動

繰り返し部品

複数の仮想サーバを起動します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.7.2　仮想サーバの起動(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの状態取得

hypervGetVMState

仮想サーバの状態取得

Hyper-V環境において，仮想サーバの状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

仮想サーバの起動

hypervPowerOnVM

階層フロー部品

Hyper-V環境において，仮想サーバを起動します。

−　

2-3

値判定分岐部品

仮想サーバが「起動完了」以外の状態であるかを判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4

仮想サーバの起動

仮想サーバが「起動完了」以外の状態である場合，仮想サーバを起動します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

ネットワーク接続確認

hypervCheckNetwork

階層フロー部品

ネットワークが接続されているかを確認します。

−　

3-3

値判定分岐部品

ネットワーク接続確認にyesが指定されているかを判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-4

階層フロー部品

ネットワーク接続確認にyesが指定されている場合，ネットワーク接続確認を実施します。

−　

3-4-1

仮想サーバのIPアドレス取得

起動完了した仮想サーバのIPアドレスを取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-4-2

ICMPエコー要求メッセージの送信

起動完了した仮想サーバにICMPエコー要求を発行します。

システム環境の状態によっては，仮想サーバの起動には成功するが，ネットワークの接続確認に失敗し，タスクが異常終了する場合があります。仮想サーバが起動しているか確認してください。サービスを再実行する場合は，注意事項を確認し，エラー原因を取り除いたあとで実行してください。

3.7.3　仮想サーバの再起動

機能

このサービステンプレートは，Hyper-V環境の複数の仮想サーバを再起動します。

このサービステンプレートが前提とするサーバを次に示します。

・Hyper-Vサーバ

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

処理の概要を次に示します。

(1) 仮想サーバが起動完了の状態※1である場合に，仮想サーバを再起動します。状態が起動完了以外の場合は，該当する仮想サーバの処理がエラーとなります。

(2) ネットワーク接続確認を実施する場合は，再起動した仮想サーバに設定されているIPアドレス(IPv4)を取得したのち，ローカルサーバから再起動した仮想サーバに対してICMPエコー要求を送信し，ネットワーク接続を確認します。

上記の処理を，指定された仮想サーバ群に対して並列に実行します。

仮想サーバを再起動する際には，まずhyperv.checkVmStateDisabledIntervalプロパティに指定した秒数待ち合わせ，仮想サーバが停止完了状態になることを確認する動作を，hyperv.checkVmStateDisabledCountプロパティに指定した回数繰り返します。次に，hyperv.checkVmStateEnabledIntervalプロパティに指定した秒数待ち合わせ，仮想サーバが起動完了状態になったことを確認する動作を，hyperv.checkVmStateEnabledCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

※1：仮想サーバの状態の詳細については，本製品マニュアルの「Hyper-Vが管理している仮想サーバの状態一覧」を参照してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2008 R2 Hyper-V

【サービステンプレート実行システム内前提製品の稼働OS】

(1)Hyper-Vサーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

ただし，Server Coreインストール環境は除く。

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

ただし，Server Coreインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。

　・オペレーティングシステムのシャットダウン

　・データ交換

(3)ネットワーク接続確認を実行する場合，エージェントレス接続先としてローカルサーバ("localhost"で解決されるループバックアドレス)を設定する必要があります。

(4)ネットワーク接続確認を実行する場合，対象となる仮想サーバのファイアーウォールがICMP(ECHO)応答を許可していること。

注意事項

(1)このサービスは指定した仮想サーバのOSを強制的にシャットダウンします。このサービスを実行した場合，仮想サーバで編集中のファイルデータは保存されません。

(2)ネットワーク接続確認を実施する場合は，システム環境によって，仮想サーバの起動直後にすべてのIPアドレスが取得できない場合があります。そのため，仮想サーバが起動しているにも関わらず，osSendIcmp部品で仮想サーバに設定されたすべてのIPアドレス(IPv4)でネットワークの接続確認が出来ずにタスクが異常終了する場合があります。仮想サーバの起動からIPアドレス取得開始までの待機時間を指定するhyperv.waitTimeプロパティの秒数を指定して，すべてのIPアドレスが取得できるように調節してください。

(3)ネットワーク接続確認を実施する場合は，仮想サーバのすべてのNICに設定されているIPアドレス(IPv4)の長さの合計を1024文字以内(※1)にして設定してください。IPアドレス(IPv4)の長さの合計が1024文字を超えると，osSendIcmp部品でエラーが発生し，タスクが異常終了する場合があります。

※IPアドレス(IPv4)１つの最大の長さは16文字(IPアドレス連結用の「,(コンマ)」を含む)。

(4)ネットワーク接続確認を実行する場合，common.icmpEchoTimeoutプロパティは利用している環境に応じて調整してください。

実行権限

ビルトイン Administrator

バージョン

03.00.00

タグ

Control VM,Hyper-V 2008

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

Hyper-Vの情報を指定してください。

表示されます。

仮想サーバ情報

再起動する仮想サーバの情報を指定してください。

表示されます。

ネットワーク接続確認

仮想サーバを再起動したあとのネットワーク接続確認に関するプロパティです。必要に応じて変更してください。

表示されません。

実行時オプション

仮想サーバを再起動する際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.targetHost

Hyper-Vサーバのホスト名

Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

hyperv.waitTime

IPアドレス取得開始までの待機時間

ネットワーク接続確認を実行する場合，仮想サーバの再起動が完了してからIPアドレス取得を開始するまでの待機時間を秒単位で指定します。

入力

無効

○　

ネットワーク接続確認

common.icmpEchoTimeout

ICMPエコー要求のタイムアウト時間

ネットワーク接続確認を実行する場合，仮想サーバの再起動後に実行する，ICMPエコー要求に対する応答を待つ時間をミリ秒単位で指定します。

入力

無効

○　

ネットワーク接続確認

hyperv.checkVmStateDisabledCount

仮想サーバの状態(停止完了)の確認回数

仮想サーバの停止が完了したか確認する際の確認回数を指定します。仮想サーバの状態(停止完了)の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

hyperv.checkVmStateDisabledInterval

仮想サーバの状態(停止完了)の確認間隔

仮想サーバの停止が完了したか確認する際の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

hyperv.checkVmStateEnabledCount

仮想サーバの状態(起動完了)の確認回数

仮想サーバの起動が完了したか確認する際の確認回数を指定します。仮想サーバの状態(起動完了)の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

hyperv.checkVmStateEnabledInterval

仮想サーバの状態(起動完了)の確認間隔

仮想サーバの起動が完了したか確認する際の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

hyperv.checkJobShutdownCount

ジョブ監視回数(InitiateShutdownメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(InitiateShutdownメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobShutdownInterval

ジョブ監視間隔(InitiateShutdownメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(InitiateShutdownメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobPowerOnCount

ジョブ監視回数(RequestStateChangeメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(RequestStateChangeメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobPowerOnInterval

ジョブ監視間隔(RequestStateChangeメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(RequestStateChangeメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.foreachVmName

仮想サーバ名(複数指定可)

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。複数指定する場合はコンマで区切ってください。99個まで指定できます。

入力

無効

○　

仮想サーバ情報

hyperv.checkNetworkConnection

ネットワーク接続確認の実行

仮想サーバの再起動後にネットワーク接続確認を実行するかどうかを指定します。

入力

無効

○　

ネットワーク接続確認

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.targetHost

256文字以内の半角英数字および「.」，「-」。

hyperv.waitTime

0〜3600の整数値。

common.icmpEchoTimeout

1〜214783647の整数値。

hyperv.checkVmStateDisabledCount

1〜2147483647の整数値。

hyperv.checkVmStateDisabledInterval

1〜60の整数値。

hyperv.checkVmStateEnabledCount

1〜2147483647の整数値。

hyperv.checkVmStateEnabledInterval

1〜60の整数値。

hyperv.checkJobShutdownCount

1〜2147483647の整数値。

hyperv.checkJobShutdownInterval

1〜60の整数値。

hyperv.checkJobPowerOnCount

1〜2147483647の整数値。

hyperv.checkJobPowerOnInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.foreachVmName

1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」，「/」，「:」を除く。

hyperv.checkNetworkConnection

次の値のどれかを選択する。

yes,no

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの再起動

仮想サーバの再起動

繰り返し部品

複数の仮想サーバを再起動します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.7.4　仮想サーバの再起動(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバのシャットダウン

hypervShutdownVM

仮想サーバのシャットダウン

Hyper-V環境において，仮想サーバをシャットダウンします。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

仮想サーバの起動

hypervPowerOnVM

仮想サーバの起動

Hyper-V環境において，仮想サーバを起動します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

ネットワーク接続確認

hypervCheckNetwork

階層フロー部品

ネットワークが接続されているかを確認します。

−　

3-3

値判定分岐部品

ネットワーク接続確認にyesが指定されているかを判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-4

階層フロー部品

ネットワーク接続確認にyesが指定されている場合，ネットワーク接続確認を実施します。

−　

3-4-1

仮想サーバのIPアドレス取得

起動完了した仮想サーバのIPアドレスを取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-4-2

ICMPエコー要求メッセージの送信

起動完了した仮想サーバにICMPエコー要求を発行します。

システム環境の状態によっては，仮想サーバの起動には成功するが，ネットワークの接続確認に失敗し，タスクが異常終了する場合があります。仮想サーバが起動しているか確認してください。サービスを再実行する場合は，注意事項を確認し，エラー原因を取り除いたあとで実行してください。

3.7.5　仮想サーバの情報一覧取得

機能

このサービステンプレートは，Hyper-V環境の仮想サーバの情報一覧を取得します。

このサービステンプレートが前提とするサーバを次に示します。

・Hyper-Vサーバ

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

処理の概要を次に示します。

(1) 仮想サーバの情報一覧をCSV形式で指定されたリモートの一時ファイルに出力します。出力ファイルのエンコード形式は，Hyper-Vサーバのシステムのデフォルトエンコーディングです。

(2) リモートの一時ファイルを指定されたローカルの出力ファイルに転送します。

(3) リモートの一時ファイルを削除します。

出力するCSVファイルの項目を次に示します。

項目はコンマ区切りで出力します。

(a) Hyper-Vサーバ名 (ヘッダー名：HostName)

(b) 仮想サーバ名 (ヘッダー名：VmName)

(c) 仮想サーバの状態※1 (ヘッダー名：VmState)

(d) 仮想サーバのCPU数※2 (ヘッダー名：NumCpu)

(e) 仮想サーバのメモリ容量(MB)※3 (ヘッダー名：MemoryMB)

※1：仮想サーバの状態の詳細については，本製品マニュアルの「Hyper-Vが管理している仮想サーバの状態一覧」を参照してください。

※2：CPU数の値は，仮想サーバに割り当てられている仮想プロセッサの数です。

※3：仮想サーバに動的メモリを設定している場合は，スタートアップRAMの値です。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2008 R2 Hyper-V

【サービステンプレート実行システム内前提製品の稼働OS】

(1)Hyper-Vサーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

ただし，Server Coreインストール環境は除く。

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

ただし，Server Coreインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

注意事項

(1)リモートおよびローカルに指定するファイル名が既に存在する場合，既存のファイルを上書きします。また，リモート側のファイルは削除します。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(2)リモートに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

バージョン

02.00.00

タグ

Gather VM information,Hyper-V 2008

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

Hyper-Vの情報を指定してください。

表示されます。

出力ファイル格納情報

出力ファイルの格納先を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.targetHost

Hyper-Vサーバのホスト名

Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.listOutputFileNameRemote

出力ファイル名(リモート)

仮想サーバ情報をHyper-Vサーバに出力する際の一時ファイル名をフルパスで指定します。

入力

無効

○　

出力ファイル格納情報

hyperv.listOutputFileNameLocal

出力ファイル名(ローカル)

仮想サーバ情報を取得するローカルサーバのファイル名をフルパスで指定します。

入力

無効

○　

出力ファイル格納情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.targetHost

256文字以内の半角英数字および「.」，「-」。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.listOutputFileNameRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「'」，「[」，「]」，「`」および末尾の「¥」を除く。

hyperv.listOutputFileNameLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの情報一覧取得

仮想サーバの情報一覧取得

仮想サーバの情報一覧取得

仮想サーバの情報一覧をHyper-Vサーバの一時ファイルに出力します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

ファイル転送

ファイル転送

ファイル転送部品

リモートの一時ファイルをローカルの指定された出力ファイルに転送します。

ファイルの転送に失敗しました。hyperv.listOutputFileNameRemoteプロパティで指定したHyper-Vサーバ上の一時ファイルを転送し，削除してください。

3

一時ファイル削除

一時ファイル削除

ファイル削除

リモートの一時ファイルを削除します。

Hyper-Vサーバ上にhyperv.listOutputFileNameRemoteプロパティで指定したファイルが残っています。手動で削除してください。

3.7.6　仮想サーバの停止

機能

このサービステンプレートは，Hyper-V環境の複数の仮想サーバのOSを強制的にシャットダウンします。

このサービステンプレートが前提とするサーバを次に示します。

・Hyper-Vサーバ

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

処理の概要を次に示します。

(1) 仮想サーバの状態を取得します。詳細については，本製品マニュアルの「Hyper-Vが管理している仮想サーバの状態一覧」を参照してください。

(2) 仮想サーバが起動完了の状態である場合に，仮想サーバのOSをシャットダウンします。状態が停止完了の場合は，仮想サーバのOSをシャットダウンする処理をスキップし，状態が起動完了と停止完了以外の場合は，該当する仮想サーバの処理がエラーとなります。

上記の処理を，指定された仮想サーバ群に対して並列に実行します。

仮想サーバのOSをシャットダウンする際には，hyperv.checkVmStateDisabledIntervalプロパティに指定した秒数待ち合わせ，仮想サーバの状態を確認する動作を，hyperv.checkVmStateDisabledCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2008 R2 Hyper-V

【サービステンプレート実行システム内前提製品の稼働OS】

(1)Hyper-Vサーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

ただし，Server Coreインストール環境は除く。

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

ただし，Server Coreインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。

　・オペレーティングシステムのシャットダウン

注意事項

(1)このサービスは指定した仮想サーバのOSを強制的にシャットダウンします。このサービスを実行した場合，仮想サーバで編集中のファイルデータは保存されません。

バージョン

03.00.00

タグ

Control VM,Hyper-V 2008

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

Hyper-Vの情報を指定してください。

表示されます。

仮想サーバ情報

停止する仮想サーバの情報を指定してください。

表示されます。

実行時オプション

仮想サーバを停止する際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.targetHost

Hyper-Vサーバのホスト名

Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

hyperv.checkVmStateDisabledCount

仮想サーバの状態(停止完了)の確認回数

仮想サーバの停止が完了したか確認する際の確認回数を指定します。仮想サーバの状態(停止完了)の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

hyperv.checkVmStateDisabledInterval

仮想サーバの状態(停止完了)の確認間隔

仮想サーバの停止が完了したか確認する際の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

hyperv.checkJobShutdownCount

ジョブ監視回数(InitiateShutdownメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(InitiateShutdownメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobShutdownInterval

ジョブ監視間隔(InitiateShutdownメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(InitiateShutdownメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.foreachVmName

仮想サーバ名(複数指定可)

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。複数指定する場合はコンマで区切ってください。99個まで指定できます。

入力

無効

○　

仮想サーバ情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.targetHost

256文字以内の半角英数字および「.」，「-」。

hyperv.checkVmStateDisabledCount

1〜2147483647の整数値。

hyperv.checkVmStateDisabledInterval

1〜60の整数値。

hyperv.checkJobShutdownCount

1〜2147483647の整数値。

hyperv.checkJobShutdownInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.foreachVmName

1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」，「/」，「:」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの停止

仮想サーバの停止

繰り返し部品

複数の仮想サーバのOSを強制的にシャットダウンします。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.7.7　仮想サーバの停止(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの状態取得

hypervGetVMState

仮想サーバの状態取得

Hyper-V環境において，仮想サーバの状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

仮想サーバのシャットダウン

hypervShutdownVM

階層フロー部品

Hyper-V環境において，仮想サーバをシャットダウンします。

−　

2-1

値判定分岐部品

仮想サーバが「停止完了」以外の状態であるかを判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-2

仮想サーバのシャットダウン

仮想サーバが「停止完了」以外の状態である場合，仮想サーバをシャットダウンします。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.8　Hyper-V 2012（構築）用のサービステンプレート

3.8.1　仮想サーバのスペック変更(CPU，メモリ)

機能

このサービステンプレートは，Hyper-V環境の仮想サーバのリソース(CPU，メモリ)に関して，指定があった項目の設定を変更します。

このサービステンプレートが前提とするサーバを次に示します。

・Hyper-Vサーバ

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

処理の概要を次に示します。

(1) CPU変更およびメモリ変更を実施するか確認します。どちらの変更も実施しない場合，サービスが異常終了します。

(2) 仮想サーバが停止していることを確認します。

　　仮想サーバが停止していない場合は，ユーザー応答待ち部品を実行して，仮想サーバをシャットダウンするか・しないかを確認します。

　　ユーザー応答待ち部品のメール送信先/送信内容，タイムアウト，画面表示内容はModify権限のユーザーが設定できます。

　　ユーザー応答待ちのGUIで"Shutdown"を選択した場合は，仮想サーバをシャットダウンします。

　　"Cancel"を選択するか，応答待ちがタイムアウトになった場合は，仮想サーバのスペックを変更しないでサービスが異常終了します。

(3) 仮想サーバに対して変更を実施するリソース(CPU，メモリ)を変更します。変更できる設定項目は次の通りです。

　　[CPUの設定変更の項目]

　　　・仮想プロセッサの数

　　　・仮想プロセッサリソースの予約

　　　・仮想プロセッサリソースの限度

　　　・仮想プロセッサリソースの相対的な重み

　　　・プロセッサの互換性

　　　・NUMAノードで使用できるプロセッサの最大数

　　　・ソケットで使用できるNUMAノードの最大数

　　[メモリの設定変更の項目]

　　　・スタートアップRAM (MB)

　　　・動的メモリの有効

　　　・動的メモリの最小RAM (MB)

　　　・動的メモリの最大RAM (MB)

　　　・動的メモリのメモリバッファー

　　　・メモリの重み

　　　・NUMAノードで使用できるメモリの最大容量 (MB)

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2012 Hyper-V，Windows Server 2012 R2 Hyper-V

【サービステンプレート実行システム内前提製品の稼働OS】

(1)Hyper-Vサーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

ただし，Server Coreインストール環境は除く。

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

注意事項

(1)同一の仮想サーバに対して，このサービスを複数同時に実行しないでください。

(2)UserResponseplugin.dialogTextにHTMLタグを指定する場合，指定できるタグおよび属性はユーザー応答待ち部品と同じです。詳細については，本製品マニュアルの「ユーザー応答待ち部品」について説明しているトピックを参照してください。

(3)仮想サーバに設定できる仮想プロセッサの最大数は，Hyper-Vサーバによって指定できる値が異なります。

(4)仮想サーバに設定できる各項目のメモリ容量は，Hyper-Vサーバによって指定できる値が異なります。

(5)サービスが異常終了した場合，CPUおよびメモリの一部の設定項目が変更されている場合があります。

(6)hyperv.selectVmCpuChangeプロパティに「yes」を選択し，CPUの設定変更のすべての項目が未入力の状態でサービスを実行した場合，サービスが異常終了します。また，hyperv.selectVmMemoryChangeプロパティに「yes」を選択し，メモリの設定変更のすべての項目が未入力の状態でサービスを実行した場合，サービスが異常終了します。

(7)ユーザー応答待ちのGUIで"Shutdown"を選択した場合は，仮想サーバのOSをシャットダウンします。仮想サーバで編集中のファイルデータは保存されません。

バージョン

03.00.00

タグ

Modify VM,Hyper-V 2012

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

Hyper-V 2012の情報を指定してください。

表示されます。

仮想サーバ情報

スペックを変更する仮想サーバの情報と変更項目の有無を指定してください。

表示されます。

仮想サーバのCPU変更情報

仮想サーバのCPUの設定項目で変更できる情報です。変更する場合は少なくとも1つのプロパティに値を指定してください。

表示されません。

仮想サーバのメモリ変更情報

仮想サーバのメモリの設定項目で変更できる情報です。変更する場合は少なくとも1つのプロパティに値を指定してください。

表示されません。

ユーザー応答待ちオプション

仮想サーバが起動していた場合のユーザー応答のためのオプションです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.targetHost

Hyper-Vサーバのホスト名

Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

UserResponsePlugin.toAddress

TOメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(TO)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.ccAddress

CCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(CC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.bccAddress

BCCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(BCC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailSubject

メール件名

ユーザー応答待ちになった場合のメール通知のメールの件名を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailBody

メール本文

ユーザー応答待ちになった場合のメール通知のメール本文を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.encodeType

エンコード種別

ユーザー応答待ちになった場合のメール通知のエンコード種別を指定します。指定可能なエンコード名は次のとおりです。us-ascii，iso-2022-jp，shift_jis，euc-jp，utf-8。指定しなかった場合には，utf-8で送信されます。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.dialogText

応答入力画面の補足情報

ユーザー応答待ちになった場合の応答入力ダイアログに表示する補足情報を指定します。テキスト形式，またはHTML形式で指定できます。指定可能なHTMLタグは，アンカータグ，ボールドタグ，ブレークタグ，フォントタグ，イタリックタグ，下線タグです。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.responseTimeOut

応答タイムアウト時間(分)

ユーザー応答待ちになった場合の応答がタイムアウトする時間を分単位で指定します。応答タイムアウト時間が過ぎると，サービスが異常終了します。

入力

無効

○　

ユーザー応答待ちオプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

仮想サーバ情報

hyperv.selectVmCpuChange

仮想サーバのCPU設定の変更有無

仮想サーバのCPU設定を変更する場合は「yes」，変更しない場合は「no」を選択してください。

入力

無効

○　

仮想サーバ情報

hyperv.selectVmMemoryChange

仮想サーバのメモリ設定の変更有無

仮想サーバのメモリ設定を変更する場合は「yes」，変更しない場合は「no」を選択してください。

入力

無効

○　

仮想サーバ情報

hyperv.cpuCount

仮想プロセッサの数

仮想サーバに設定する仮想プロセッサの数を指定します。仮想プロセッサの数は1以上の整数値で指定してください。

入力

無効

△　

仮想サーバのCPU変更情報

hyperv.cpuReserve

仮想プロセッサリソースの予約

仮想サーバが予約する仮想サーバ間の仮想プロセッサリソースの配分を指定します。仮想プロセッサリソースの予約は仮想プロセッサリソースの限度の値以下で，0から100の整数値で指定してください。

入力

無効

△　

仮想サーバのCPU変更情報

hyperv.cpuMaximum

仮想プロセッサリソースの限度

仮想サーバが使用する仮想サーバ間の仮想プロセッサリソースの配分の上限値を指定します。仮想プロセッサリソースの限度は仮想プロセッサリソースの予約の値以上で，0から100の整数値で指定してください。

入力

無効

△　

仮想サーバのCPU変更情報

hyperv.cpuRelativeWeight

仮想プロセッサリソースの相対的な重み

仮想サーバ間における仮想プロセッサリソースの相対的な重みを指定します。仮想プロセッサリソースの相対的な重みは0から10000までの整数値で指定してください。

入力

無効

△　

仮想サーバのCPU変更情報

hyperv.cpuCompatibilityForMigrationEnabled

プロセッサの互換性

プロセッサの互換性を有効にする場合は「true」，無効にする場合は「false」を指定してください。未入力の場合はプロセッサの互換性の設定を変更しません。

入力

無効

△　

仮想サーバのCPU変更情報

hyperv.cpuMaximumCountPerNumaNode

NUMAノードで使用できるプロセッサの最大数

1つの仮想NUMA(Non-Uniform Memory Architecture)ノードで使用できるプロセッサの最大数を指定します。NUMAノードのプロセッサの最大数は1以上の整数値で指定してください。

入力

無効

△　

仮想サーバのCPU変更情報

hyperv.nodeMaximumCountPerNumaSocket

ソケットで使用できるNUMAノードの最大数

1つのソケットで使用できる仮想NUMA(Non-Uniform Memory Architecture)ノードの最大数を指定します。ソケットで使用できるNUMAノードの最大数は1以上の整数値で指定してください。

入力

無効

△　

仮想サーバのCPU変更情報

hyperv.memoryStartupMegaBytes

スタートアップRAM (MB)

仮想サーバの起動時に使用するメモリの量をMB単位で指定します。仮想サーバの起動時に使用するメモリの量は8以上の2の倍数の整数値で指定してください。

入力

無効

△　

仮想サーバのメモリ変更情報

hyperv.dynamicMemoryEnabled

動的メモリの有効

仮想サーバの動的メモリを有効にする場合は「true」，無効にする場合は「false」を指定してください。未入力の場合は動的メモリの有効の設定を変更しません。

入力

無効

△　

仮想サーバのメモリ変更情報

hyperv.dynamicMemoryMinimumMegaBytes

動的メモリの最小RAM (MB)

動的メモリにおける最小メモリ量をMB単位で指定します。最小メモリ量はスタートアップRAMの値以下で，8以上の2の倍数の整数値で指定してください。動的メモリが有効な場合だけ指定してください。

入力

無効

△　

仮想サーバのメモリ変更情報

hyperv.dynamicMemoryMaximumMegaBytes

動的メモリの最大RAM (MB)

動的メモリにおける最大メモリ量をMB単位で指定します。最大メモリ量はスタートアップRAMの値以上で，8以上の2の倍数の整数値で指定してください。動的メモリが有効な場合だけ指定してください。

入力

無効

△　

仮想サーバのメモリ変更情報

hyperv.dynamicMemoryBuffer

動的メモリのメモリバッファー

Hyper-Vでバッファーとして予約しておくべきメモリの割合を指定してください。動的メモリのメモリバッファーは5から2000の整数値で指定してください。動的メモリが有効な場合だけ指定してください。

入力

無効

△　

仮想サーバのメモリ変更情報

hyperv.memoryPriority

メモリの重み

仮想サーバ間における使用可能なメモリを割り当てるときの優先度を指定します。メモリの重みは0から100の整数値で指定してください。

入力

無効

△　

仮想サーバのメモリ変更情報

hyperv.memoryMaximumAmountMegaBytesPerNumaNode

NUMAノードで使用できるメモリの最大容量 (MB)

1つの仮想NUMA(Non-Uniform Memory Architecture)ノードで使用できるメモリの最大容量をMB単位で指定します。NUMAノードのメモリの最大容量は8以上の整数値で指定してください。

入力

無効

△　

仮想サーバのメモリ変更情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.targetHost

256文字以内の半角英数字および「.」，「-」。

UserResponsePlugin.toAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.ccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.bccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.mailSubject

256文字以内の文字列。

UserResponsePlugin.mailBody

1024文字以内の文字列。

UserResponsePlugin.encodeType

次の値のどれかを選択する。

us-ascii,iso-2022-jp,shift_jis,euc-jp,utf-8

UserResponsePlugin.dialogText

512文字以内の文字列。

UserResponsePlugin.responseTimeOut

1〜9999の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.vmName

100文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」，「¥」，「/」，「:」，先頭の「 (スペース)」および末尾の「 (スペース)」，「.」を除く。

hyperv.selectVmCpuChange

次の値のどれかを選択する。

yes,no

hyperv.selectVmMemoryChange

次の値のどれかを選択する。

yes,no

hyperv.cpuCount

1以上の整数値。

hyperv.cpuReserve

0〜100の整数値。

hyperv.cpuMaximum

0〜100の整数値。

hyperv.cpuRelativeWeight

0〜10000の整数値。

hyperv.cpuCompatibilityForMigrationEnabled

次の値のどれかを選択する。

true,false

hyperv.cpuMaximumCountPerNumaNode

1以上の整数値。

hyperv.nodeMaximumCountPerNumaSocket

1以上の整数値。

hyperv.memoryStartupMegaBytes

8以上の整数値。

hyperv.dynamicMemoryEnabled

次の値のどれかを選択する。

true,false

hyperv.dynamicMemoryMinimumMegaBytes

8以上の整数値。

hyperv.dynamicMemoryMaximumMegaBytes

8以上の整数値。

hyperv.dynamicMemoryBuffer

5〜2000の整数値。

hyperv.memoryPriority

0〜100の整数値。

hyperv.memoryMaximumAmountMegaBytesPerNumaNode

8以上の整数値。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの変更必要確認

仮想サーバの変更必要確認

階層フロー部品

仮想サーバのスペック変更(CPU，メモリ)が必要であるか確認します。hyperv.selectVmCpuChangeプロパティおよびhyperv.selectVmMemoryChangeプロパティのどちらにも「no」が設定されている場合はサービスが異常終了します。

−　

1-1

値判定分岐部品

hyperv.selectVmCpuChangeプロパティに「no」が設定されているか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-2

階層フロー部品

仮想サーバのスペック変更(CPU，メモリ)が必要であるか確認します。

−　

1-2-1

戻り値判定分岐部品

hyperv.selectVmMemoryChangeプロパティに「no」が設定されているか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-2-2

異常終了部品

仮想サーバのスペック変更(CPU，メモリ)が必要で無い場合，サービスを異常終了します。

hyperv.selectVmCpuChangeプロパティおよびhyperv.selectVmMemoryChangeプロパティの設定を確認してください。サービスを実行するためには，どちらかに「yes」が選択されている必要があります。

2

仮想サーバの状態確認

仮想サーバの状態確認

階層フロー部品

仮想サーバの状態を調べ，仮想サーバが停止していなければユーザーに確認します。

−　

2-1

仮想サーバの状態取得

指定された仮想サーバの状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-2

値判定分岐部品

指定された仮想サーバが停止しているか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-3

階層フロー部品

ユーザーに仮想サーバを停止するか確認し，停止する場合は仮想サーバをシャットダウンします。

−　

2-3-1

ユーザー応答待ち部品

ユーザーに仮想サーバを停止するかユーザー応答待ちで確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-3-2

仮想サーバの状態取得

指定された仮想サーバの状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-3-3

値判定分岐部品

仮想サーバをシャットダウンする必要があるか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-3-4

仮想サーバのシャットダウン

仮想サーバをシャットダウンします。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

仮想サーバのスペック変更

仮想サーバのスペック変更

階層フロー部品

仮想サーバのスペックを変更します。

−　

3-1

値判定分岐部品

仮想サーバのメモリ設定の変更を実施するか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-2

仮想サーバのメモリ設定変更

仮想サーバのメモリ設定を変更します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-3

値判定分岐部品

仮想サーバのCPU設定の変更を実施するか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-4

仮想サーバのCPU設定変更

仮想サーバのCPU設定を変更します。

仮想サーバのCPUおよびメモリの設定が一部変更されている場合があります。タスクログを確認し，エラーの原因を取り除いたあと，サービスを再実行してください。

3.8.2　仮想サーバの削除

機能

このサービステンプレートは，Hyper-V環境の仮想サーバを削除します。

このサービステンプレートが前提とするサーバを次に示します。

・Hyper-Vサーバ

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

処理の概要を次に示します。

(1) 仮想サーバの状態を取得します。

(2) 仮想サーバが停止していることを確認します。

　仮想サーバが停止している場合は処理を継続しますが，それ以外の場合は，ユーザー応答待ち部品を実行して，シャットダウンするか・しないかを確認します。

　ユーザー応答待ちのGUIで"Shutdown"を選択した場合は，起動している仮想サーバをシャットダウンします。起動以外の仮想サーバに対して"Shutdown"を選択した場合は，仮想サーバには操作を行わずにタスクが異常終了します。

　"Cancel"を選択するか，応答待ちがタイムアウトになった場合は，仮想サーバには操作を行わずにタスクが異常終了します。

(3) 仮想サーバを削除します。

　Hyper-Vサーバから仮想サーバを削除します。このとき，スナップショットも併せて削除します。

　hyperv.vHardDiskDeletePermanentlyプロパティの選択リストで，"yes"を選択した場合，削除する仮想サーバに割り当てられているすべての仮想ディスクファイル(容量可変/容量固定/差分)を削除します。パススルー(物理)ディスク，フロッピーディスクまたはCD/DVDなどに割り当てられているディスクやファイルは削除しません。仮想ディスク(差分)が割り当てられている場合，仮想ディスク(差分)の親として使用する仮想ディスクは削除しません。

　仮想サーバの仮想ディスクファイルの削除に失敗した場合，ファイル削除処理を中断し，タスクは異常終了します。

(4) 仮想サーバの仮想ディスクファイルの一覧を出力します。

　hyperv.vhdListOutputFileNameRemoteプロパティとhyperv.vhdListOutputFileNameLocalプロパティを指定した場合，Hyper-Vサーバから削除する仮想サーバに割り当てられている仮想ディスクファイルのパス一覧をCSV形式で出力，ファイルをローカルに転送し，リモートのファイルは削除します。仮想ディスク(差分)が割り当てられている場合，仮想ディスク(差分)の親として使用する仮想ディスクは含まれません。

　hyperv.vhdListOutputFileNameRemoteプロパティだけを指定した場合，仮想ディスクファイルのパス一覧をCSV形式で出力しますが，ファイルをローカルに転送しません。

　出力するCSVファイルの項目を次に示します。

　項目はコンマ区切りで出力します。

　(a) 仮想ディスクファイルの有無 (ヘッダー名：Existence)

　　　仮想サーバの削除実行時に割り当てられている仮想ディスクファイルが存在するかどうかを出力します。項目の値を次に示します。

　　　　Found：ファイルの存在を確認

　　　　NotFound：ファイルが設定されているが，存在を確認できない

　(b) ファイルの削除結果 (ヘッダー名：DeleteResult)

　　　hyperv.vHardDiskDeletePermanentlyプロパティの選択リストで，"yes"を選択した場合，仮想ディスクファイルの削除の実行結果を出力します。hyperv.vHardDiskDeletePermanentlyプロパティの選択リストで，"no"を選択した場合でも"Skipped"を出力します。項目の値を次に示します。

　　　　Completed：ファイルの削除が成功

　　　　Failed：ファイルの削除が失敗

　　　　Skipped：ファイルの削除が未実施

　(c) ファイルのパス (ヘッダー名：FilePath)

　　　(a)(b)の内容に関わらず，Hyper-Vサーバで設定されている仮想ディスクファイルのパスを出力します。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2012 Hyper-V，Windows Server 2012 R2 Hyper-V

【サービステンプレート実行システム内前提製品の稼働OS】

(1)Hyper-Vサーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。

　・オペレーティングシステムのシャットダウン

注意事項

(1)同一の仮想サーバに対して，このサービスを複数同時に実行しないでください。

(2)仮想ディスクファイルのパスを仮想サーバの設定情報から参照できなくなるような操作(スナップショット操作など)を行った場合，その仮想ディスクファイルは削除されません。この場合は手動で削除してください。

(3)UserResponseplugin.dialogTextプロパティにHTMLタグを指定する場合，指定できるタグおよび属性はユーザー応答待ち部品と同じです。詳細については，本製品マニュアルの「ユーザー応答待ち部品」について説明しているトピックを参照してください。

(4)hyperv.vhdListOutputFileNameRemoteプロパティおよびhyperv.vhdListOutputFileNameLocalプロパティに指定するファイル名がすでに存在する場合，既存のファイルを上書きします。また，リモート側のファイルは削除します。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(5)hyperv.vhdListOutputFileNameRemoteプロパティに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

(6)hyperv.vhdListOutputFileNameRemoteプロパティを指定した場合，hyperv.vhdListOutputFileNameLocalプロパティを指定しない場合や，仮想サーバまたは仮想ディスクファイルの削除時にエラーが発生しても，リモート側にファイルを出力します。出力したファイルは削除せずに残ります。そのため，使用しない場合は削除してください。

(7)このサービスは，フェールオーバークラスターマネージャーのサービスとアプリケーションから仮想サーバの登録情報を削除しません。ユーザーの運用に合わせて手動で削除してください。

(8)ユーザー応答待ちのGUIで"Shutdown"を選択した場合は，仮想サーバのOSを強制的にシャットダウンします。仮想サーバで編集中のファイルデータは保存されません。

バージョン

03.00.00

タグ

Delete VM,Hyper-V 2012

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

Hyper-Vサーバの情報を指定してください。

表示されます。

仮想サーバ情報

削除する仮想サーバの情報を指定してください。

表示されます。

出力ファイル格納情報

出力ファイルの格納先を必要に応じて指定してください。

表示されません。

ユーザー応答待ちオプション

仮想サーバが起動していた場合のユーザー応答のためのオプションです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.targetHost

Hyper-Vサーバのホスト名

Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

UserResponsePlugin.toAddress

TOメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(TO)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.ccAddress

CCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(CC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.bccAddress

BCCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(BCC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailSubject

メール件名

ユーザー応答待ちになった場合のメール通知のメールの件名を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailBody

メール本文

ユーザー応答待ちになった場合のメール通知のメール本文を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.encodeType

エンコード種別

ユーザー応答待ちになった場合のメール通知のエンコード種別を指定します。指定可能なエンコード名は次のとおりです。us-ascii，iso-2022-jp，shift_jis，euc-jp，utf-8。指定しなかった場合には，utf-8で送信されます。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.dialogText

応答入力画面の補足情報

ユーザー応答待ちになった場合の応答入力ダイアログに表示する補足情報を指定します。テキスト形式，またはHTML形式で指定できます。指定可能なHTMLタグは，アンカータグ，ボールドタグ，ブレークタグ，フォントタグ，イタリックタグ，下線タグです。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.responseTimeOut

応答タイムアウト時間(分)

ユーザー応答待ちになった場合の応答がタイムアウトする時間を分単位で指定します。応答タイムアウト時間が過ぎると，サービスが異常終了します。

入力

無効

○　

ユーザー応答待ちオプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

仮想サーバ情報

hyperv.vHardDiskDeletePermanently

仮想ディスクファイルの削除の要否

仮想サーバで使用している仮想ディスクファイルを削除するかどうか指定します。

入力

無効

○　

仮想サーバ情報

hyperv.vhdListOutputFileNameRemote

出力ファイル名(リモート)

仮想サーバが使用している仮想ディスクファイル一覧をHyper-Vサーバに出力する際の一時ファイル名をフルパスで指定します。

入力

無効

△　

出力ファイル格納情報

hyperv.vhdListOutputFileNameLocal

出力ファイル名(ローカル)

仮想ディスクファイル一覧をローカルサーバに格納する際のファイル名をフルパスで指定します。

入力

無効

△　

出力ファイル格納情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.targetHost

256文字以内の半角英数字および「.」，「-」。

UserResponsePlugin.toAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.ccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.bccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.mailSubject

256文字以内の文字列。

UserResponsePlugin.mailBody

1024文字以内の文字列。

UserResponsePlugin.encodeType

次の値のどれかを選択する。

us-ascii,iso-2022-jp,shift_jis,euc-jp,utf-8

UserResponsePlugin.dialogText

512文字以内の文字列。

UserResponsePlugin.responseTimeOut

1〜9999の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.vmName

100文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」，「¥」，「/」，「:」，先頭の「 (スペース)」および末尾の「 (スペース)」，「.」を除く。

hyperv.vHardDiskDeletePermanently

次の値のどれかを選択する。

yes,no

hyperv.vhdListOutputFileNameRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「'」，「[」，「]」，「`」および末尾の「¥」を除く。

hyperv.vhdListOutputFileNameLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの状態確認

仮想サーバの状態確認

階層フロー部品

仮想サーバの状態を調べ，仮想サーバが起動している場合はユーザーに確認します。

−　

1-2

仮想サーバの状態取得

指定した仮想サーバの状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-3

値判定分岐部品

仮想サーバが停止しているか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-4

階層フロー部品

ユーザーに仮想サーバを停止するか確認し，停止する場合は仮想サーバをシャットダウンします。

−　

1-4-1

ユーザー応答待ち部品

ユーザーに仮想サーバを停止するかユーザー応答待ちで確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-4-2

仮想サーバの状態取得

指定した仮想サーバの状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-4-3

値判定分岐部品

仮想サーバが停止しているか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-4-4

仮想サーバのシャットダウン

仮想サーバをシャットダウンします。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

仮想サーバの削除

仮想サーバの削除

仮想サーバの削除

仮想サーバを削除します。

仮想サーバが削除されていない場合は，エラーの原因を取り除いたあと，サービスを再実行してください。

仮想サーバが削除されている場合は，仮想ディスクファイルの有無を確認，または仮想ディスクファイル一覧を出力していればHyper-Vサーバでファイルを参照し，必要に応じ手動で仮想ディスクファイルを削除してください。

3

ファイル転送

ファイル転送

階層フロー部品

仮想ディスクファイル一覧を転送します。

−　

3-1

値判定分岐部品

仮想ディスクファイル一覧の出力ファイル名(リモート)が指定されているかチェックします。

仮想ディスクファイル一覧を出力していれば，Hyper-Vサーバに仮想ディスクファイル一覧が残っています。手動で削除してください。

3-2

階層フロー部品

仮想ディスクファイル一覧を転送します。

−　

3-2-1

値判定分岐部品

仮想ディスクファイル一覧の出力ファイル名(ローカル)が指定されているかチェックします。

仮想ディスクファイル一覧を出力していれば，Hyper-Vサーバに仮想ディスクファイル一覧が残っています。手動で削除してください。

3-2-2

階層フロー部品

仮想ディスクファイル一覧を転送します。

−　

3-2-2-1

ファイル転送部品

リモートの一時ファイルをローカルの指定された出力ファイルに転送します。

Hyper-Vサーバに仮想ディスクファイル一覧が残っています。手動で削除してください。

3-2-2-2

ファイル削除

リモートの一時ファイルを削除します。

Hyper-Vサーバに仮想ディスクファイル一覧が残っています。手動で削除してください。

3.8.3　仮想サーバの追加(デプロイ/OS初期設定)

機能

このサービステンプレートは，Hyper-V環境に，エクスポート済みの仮想サーバを用いて仮想サーバを追加します。

このサービステンプレートが前提とするサーバを次に示します。

・Hyper-Vサーバ

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

・エクスポート済みの仮想サーバ

　Hyper-Vからエクスポートされた仮想サーバ，およびその仮想サーバの構成ファイル一式です。

・格納サーバ

　複製元となる，エクスポート済みの仮想サーバを格納してあるサーバです。

処理の概要を次に示します。

(1) Hyper-Vサーバに仮想サーバを作成します。

　1. インポート先に，エクスポート済みの仮想サーバを複製します。

　2. Hyper-Vサーバに，インポート機能を用いて仮想サーバを作成します。

　　新規に作成する仮想サーバには，新しい一意なIDを作成します。

　　インポート先に指定したパスのフォルダがすでに存在する場合，そのフォルダを使用します。

(2) 仮想サーバの接続先仮想スイッチ(管理用)を設定します。

　ローカルサーバとの通信を確立するために，NICに仮想スイッチ(管理用)を設定します。

　エクスポート済みの仮想サーバに，すでに設定されている接続先仮想スイッチは，指定された仮想スイッチに上書きされます。

　1個目のNICには，ローカルサーバと通信可能な管理用の仮想スイッチを設定してください。2〜4個目のNICには管理用・業務用仮想スイッチをユーザーの運用に合わせて設定してください。

　指定した仮想スイッチの数が，仮想サーバが持つNICの数より多い場合，NICに割り当てられなかった仮想スイッチの設定は無効になります。

(3) OSカスタマイズ用の応答ファイルを作成し，配置します。

　1. 仮想サーバの仮想ディスクをHyper-Vサーバにマウントします。

　2. マウントした仮想ディスクにOSカスタマイズ用の応答ファイルを作成します。

　3. Hyper-Vサーバから仮想ディスクをアンマウントします。

(4) 仮想サーバを起動し，仮想サーバの初期情報を設定します。

　1. OSの初期情報を設定します(コンピュータ名，会社名など)。

　　OSの初期設定として，コンピュータ名，会社名，組織名，タイムゾーンを設定します。

　2. 仮想サーバのIPアドレスを設定します。

　　仮想サーバは最大4個までIPアドレスを設定することができます。1個目のIPアドレス(管理用)には，デプロイした仮想サーバを管理するためのIPアドレスを設定してください。2〜4個目のIPアドレス(2個目用)・IPアドレス(3個目用)・IPアドレス(4個目用)については，管理用・業務用IPアドレスをユーザーの運用に合わせて設定してください。一部の設定は管理用IPアドレスを使用してOSに接続し設定をします。仮想サーバが持つNICの数によってIPアドレスの設定順序は次のようになります。

　　・仮想サーバがNICを1個持つ場合

　　　NICには，IPアドレス(管理用)>IPアドレス(2個目用)>IPアドレス(3個目用)>IPアドレス(4個目用)の順で最初に指定されていたIPアドレスを設定します。その他のIPアドレスは破棄されますのでご注意ください。

　　・仮想サーバがNICを2個以上持つ場合

　　　NICには，IPアドレス(管理用)>IPアドレス(2個目用)>IPアドレス(3個目用)>IPアドレス(4個目用)の順でIPアドレスを設定します。IPアドレスの指定に空きがある場合，詰めて設定します。例えば，指定するIPアドレスがIPアドレス(管理用)，IPアドレス(2個目用)，IPアドレス(4個目用)の場合(IPアドレス(3個目用)がない場合)，IPアドレス(4個目用)は仮想マシンの3つ目のNICに設定します。入力したIPアドレスの数が，仮想サーバが持つNICの数より多い場合，超えた分のIPアドレスは破棄されますのでご注意ください。

(5) 仮想サーバの接続先仮想スイッチ(2〜4個目用)を設定します。

　エクスポート済みの仮想サーバに，すでに設定されている接続先仮想スイッチは，指定された仮想スイッチに上書きされます。

　1個目のNICには，ローカルサーバと通信可能な管理用の仮想スイッチを設定してください。2〜4個目のNICには管理用・業務用仮想スイッチをユーザーの運用に合わせて設定してください。

　指定した仮想スイッチの数が，仮想サーバが持つNICの数より多い場合，NICに割り当てられなかった仮想スイッチの設定は無効になります。

(6) 仮想サーバのOSに設定するIPアドレス(管理用)が指定され，かつ仮想サーバのIPアドレスが複数設定された場合に，スタティックルートを設定します。

(7) OS.selectWorkgroupDomainの選択リストで，DOMAINが選択され，かつドメイン名，ドメイン ユーザー名，ドメイン パスワードが指定されていた場合，ドメインへの参加処理を行います。

プロパティ設定の留意点を次に示します。

(1) OSユーザーパスワードとOSユーザーパスワード再入力は必須となります。どちらかの指定がない場合，"Password123"がパスワードに設定されます。また，2つの値が合致しない場合も"Password123"がパスワードに設定されます。

(2) OS.selectWorkgroupDomainの選択リストで，WORKGROUPを選択した場合，指定できるワークグループ名は最大15byteまでとなります。16byteを超えると"WORKGROUP"が設定されます。

(3) OS.selectWorkgroupDomainの選択リストで，DOMAINを選択した場合，ドメイン名，ドメイン ユーザー名，ドメイン パスワードが必須となります。どれかの指定がない場合，もしくはドメイン参加に失敗した場合，ワークグループとして"WORKGROUP"が設定されます。

(4) IPアドレス，サブネットマスクは，2つの情報をすべて指定してください。どれかの指定がない場合，IPアドレス，サブネットマスク，およびデフォルトゲートウェイの設定は行われません。

(5) 仮想スイッチの指定がない場合，仮想スイッチとの接続が切断された状態になります。

(6) スタティックルートの宛先IPアドレス，サブネットマスク，デフォルトゲートウェイは同時に指定してください。どれかの指定がない場合，スタティックルートの設定は行われません。

(7) 指定可能なタイムゾーンは次のとおりです。

　Tokyo Standard Time

　China Standard Time

　GMT Standard Time

　Pacific Standard Time

　Eastern Standard Time

　US Eastern Standard Time

　Central Standard Time

　Central America Standard Time

　US Mountain Standard Time

　Mountain Standard Time

　Alaskan Standard Time

　Hawaiian Standard Time

　Singapore Standard Time

　India Standard Time

指定がない場合，エクスポート済みの仮想サーバに設定されているタイムゾーンが引き継がれます。

(8) 指定可能なロケールは次のとおりです。

　ja-JP

　en-US

　zh-CN

(9) 指定可能なOS名は次のとおりです。

　Windows Server 2008 R2

　Windows Server 2012

　Windows Server 2012 R2

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2012 Hyper-V，Windows Server 2012 R2 Hyper-V

【サービステンプレート実行システム内前提製品の稼働OS】

(1)Hyper-Vサーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)Hyper-Vサーバ上の設定に関する条件

　・仮想スイッチが設定済みであること。

　・仮想スイッチ名はHyper-Vサーバ内で一意であること。

　・デプロイに使用するエクスポート済みの仮想サーバが作成済みであること。

(2)デプロイに使用するエクスポート済みの仮想サーバに関する条件

　・Hyper-V 統合サービスの次のサービスが有効なこと。

　　①データ交換

　・Hyper-Vサーバからエクスポートする前に仮想サーバに次の設定が行われていること。

　　①Administratorユーザーのパスワードを空にしていること。

　　②ネットワーク設定を削除していること。

　　　仮想ホストのネットワークアダプタの情報を設定している場合は，次の設定個所を空にしてから，

　　　[IPアドレスを自動的に取得する]および[DNSサーバのアドレスを自動的に取得する]に設定すること。

　　　・IPアドレス

　　　・サブネットマスク

　　　・デフォルトゲートウェイ

　　　・優先DNSサーバ

　　　・代替DNSサーバ

　　③Sysprepを用いてOS情報が初期化されていること。

　　　その際，次のオプションを選択すること。

　　　[システム クリーンアップ アクション]プルダウンメニューから[システムのOOBE(Out-of-Box Experience)に入る]を選択する。

　　　[一般化する］チェックボックスをチェックする。

　・エージェントレス接続が可能な設定であること。

　・NICが設定してあること(最大4個まで)。

　　①仮想スイッチとの接続が切断された状態になっていること。

　・ファイアーウォールがICMP(ECHO)応答を許可していること。

　・格納サーバとHyper-Vサーバが別サーバの場合，Hyper-Vサーバからエクスポート済みの仮想サーバが格納されているフォルダに共有設定がされていること。

　・レガシーネットワークアダプターが設定されていないこと。

　・スナップショットおよび差分ディスクが作成されていないこと。

(3)仮想サーバに関する条件

　・仮想サーバ名はHyper-Vサーバ内で一意であること。

(4)本製品に関する条件

　・ローカルサーバ("localhost"で解決されるループバックアドレス)，Hyper-Vサーバおよびデプロイする仮想サーバのIPアドレス(管理用)を，「管理タブ」のエージェントレス接続定義に，事前に認証情報を登録してあること。

注意事項

(1)仮想スイッチの指定を省略すると，そのNICの接続先仮想スイッチ情報が削除され，接続されていない状態になります。仮想スイッチを設定する場合は，必ず指定してください。

(2)仮想サーバのOSに設定するIPアドレスについて，IPアドレスとして設定できない値は入力しないでください。例えば，ネットワークアドレスやブロードキャストアドレス，「0.0.0.0」や「255.255.255.255」などの特殊なアドレスは指定できません。入力した場合，仮想サーバのデプロイはエラーとなります。また，IPアドレス(管理用)には，ローカルサーバと通信できるIPアドレスを入力してください。正しいアドレスであっても，デプロイに失敗するおそれがあります。

(3)仮想サーバのデプロイ中は，ほかのサービスによって当該仮想サーバの操作を行わないでください。仮想サーバのデプロイに失敗するおそれがあります。Hyper-Vサーバからも直接操作を行わないでください。

(4)IPアドレスは「機能」に記載のとおり設定されますが，仮想サーバのOSにNICを設定した順番によっては，意図どおりIPアドレスが設定されない場合があるため，仮想サーバ作成後はIPアドレスが意図どおり設定されているか確認してください。もし設定されていない場合は，手動で変更してください。

(5)仮想サーバに設定するIPアドレスは，他のサーバと重複しないようにしてください。他のサーバとIPアドレスが重複していると，仮想サーバのNICが無効状態となり，タスクが異常終了する場合があります。

(6)エクスポート済みの仮想サーバには，仮想サーバ作成時に設定する情報をあらかじめ設定しないでください。コンピュータ名/ホスト名やIPアドレスがエクスポート済みの仮想サーバに設定されている場合，仮想サーバの作成に失敗する場合があります。失敗した場合(失敗の例としては，スタティックルートの処理でエラーが発生します。)，一度仮想サーバを削除し，コンピュータ名/ホスト名とIPアドレスが設定されていないエクスポート済みの仮想サーバを再作成のあと，このサービスを再実行してください。

(7)デプロイに失敗した場合，仮想サーバのOS初期設定およびIPアドレス設定に使用した応答ファイルが，仮想サーバのシステムドライブ内に削除されずに残る場合があります。タスクログを確認し応答ファイルを削除するか，仮想サーバを削除してください。

(8)インポート先に指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。

(9)インポート先に指定したパスのフォルダ内に仮想ディスクファイルが残っている場合は，タスクが異常終了します。インポート先に指定したパスのフォルダを確認し，仮想ディスクを削除するか，別のパスを指定してください。

(10)このサービスは，フェールオーバークラスターマネージャーのサービスとアプリケーションにデプロイした仮想サーバを登録しません。ユーザーの運用に合わせて手動で登録してください。

(11)仮想サーバの仮想ディスクをHyper-Vサーバへマウントする際に，Hyper-Vサーバ上の空きドライブ文字を一時的に占有します。そのため，Hyper-Vサーバ上に空きドライブ文字が存在しない場合は，仮想ディスクのマウント処理でエラーが発生し，タスクが異常終了します。エクスポート済みの仮想サーバの仮想ディスクが使用するドライブ分，Hyper-Vサーバ上にドライブ文字が空いていることを確認の上，このサービスを実行してください。

(12)エクスポート済みの仮想サーバの世代が第2世代の場合は，仮想サーバのシステムディスクが設定されているSCSIコントローラーの場所をhyperv.scsiDiskLocationに指定してください。hyperv.scsiDiskLocationとシステムディスクの場所が異なる場合，システムディスクの検索に時間がかかるため，デプロイの実行終了までの時間が長くなる場合があります。

(13)仮想サーバのOSがWindows Server 2012またはWindows Server 2012 R2の場合は，OSの初期設定が完了するまで待機処理を実施するため，他のOSと比べてタスクの実行時間が数分間長くなります。プロパティhyperv.osSettingWaitTimeの値はデフォルトを推奨します。ただし，プロパティに指定した待機処理時間が短いと，OS初期設定の完了前に次のステップが実行されて，タスクが異常終了する場合があります。

実行権限

ビルトイン Administrator

バージョン

03.00.00

タグ

Add VM,Hyper-V 2012

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

Hyper-Vの情報を指定してください。

表示されます。

仮想サーバ情報

追加する仮想サーバの情報を指定してください。

表示されます。

OS情報

仮想サーバに設定するOS情報を指定してください。

表示されます。

ネットワーク情報

仮想サーバのネットワーク情報を指定してください。

表示されます。

実行時オプション

仮想サーバのOS初期設定を行う際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.targetHost

Hyper-Vサーバのホスト名

Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

hyperv.userName

格納サーバに接続するためのユーザー名

格納サーバに接続するためのユーザー名を指定します。格納サーバがHyper-Vサーバと別サーバの場合は指定してください。

入力

無効

△　

仮想サーバ情報

hyperv.password

格納サーバに接続するためのパスワード

格納サーバに接続するためのパスワードを指定します。格納サーバがHyper-Vサーバと別サーバの場合は指定してください。

入力

無効

△　

仮想サーバ情報

windows.orgName

組織名(会社名)

仮想サーバのOSに設定する組織名を指定します。

入力

無効

○　

OS情報

windows.ownerName

名前(所有者名)

仮想サーバのOSに設定する名前(所有者名)を指定します。

入力

無効

○　

OS情報

OS.selectWorkgroupDomain

ワークグループ/ドメインの選択

仮想サーバがワークグループまたはドメインのどちらに所属するかを指定します。

入力

無効

○　

OS情報

OS.workgroupNameDomainName

ワークグループ名/ドメイン名

仮想サーバが所属するワークグループ名/ドメイン名を指定します。ワークグループ名は，最大15文字まで指定します。ドメイン名は，最大63文字まで指定します。

入力

無効

○　

OS情報

OS.domainUserName

ドメインのユーザー名

仮想サーバが所属するドメインのユーザー名を指定します。ワークグループ/ドメインの選択で「DOMAIN」を選択した場合，入力する必要があります。

入力

無効

△　

OS情報

OS.domainUserPassword

ドメインのパスワード

仮想サーバが所属するドメインのパスワードを指定します。ワークグループ/ドメインの選択で「DOMAIN」を選択した場合，入力する必要があります。

入力

無効

△　

OS情報

OS.subnetMaskMan

サブネットマスク(管理用)

仮想サーバに設定する管理用LANのサブネットマスクを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.defaultGWMan

デフォルトゲートウェイ(管理用)

仮想サーバに設定する管理用LANのデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.dnsMan

DNSサーバのIPアドレス(管理用)

仮想サーバに設定する管理用LANのDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

hyperv.virtualSwitchMan

仮想スイッチ名(管理用)

仮想サーバに設定されているNIC(管理用)に設定する仮想スイッチ名(管理用)を指定します。

入力

無効

△　

ネットワーク情報

OS.subnetMask2

サブネットマスク(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.defaultGW2

デフォルトゲートウェイ(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.dns2

DNSサーバのIPアドレス(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

hyperv.virtualSwitch2

仮想スイッチ名(2個目用)

仮想サーバに設定されているNIC(2個目用)に設定する仮想スイッチ名(2個目用)を指定します。

入力

無効

△　

ネットワーク情報

OS.subnetMask3

サブネットマスク(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.defaultGW3

デフォルトゲートウェイ(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.dns3

DNSサーバのIPアドレス(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

hyperv.virtualSwitch3

仮想スイッチ名(3個目用)

仮想サーバに設定されているNIC(3個目用)に設定する仮想スイッチ名(3個目用)を指定します。

入力

無効

△　

ネットワーク情報

OS.subnetMask4

サブネットマスク(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.defaultGW4

デフォルトゲートウェイ(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.dns4

DNSサーバのIPアドレス(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

hyperv.virtualSwitch4

仮想スイッチ名(4個目用)

仮想サーバに設定されているNIC(4個目用)に設定する仮想スイッチ名(4個目用)を指定します。

入力

無効

△　

ネットワーク情報

OS.destIPAddress

スタティックルートの宛先IPアドレス

スタティックルートの宛先IPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.subnetMaskStaticRoute

サブネットマスク(スタティックルート用)

スタティックルート用のサブネットマスクを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.defaultGWStaticRoute

デフォルトゲートウェイ(スタティックルート用)

スタティックルート用のデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

hyperv.scsiDiskLocation

SCSIコントローラーの場所

システムディスクを設定しているSCSIコントローラーの場所を指定します。このプロパティはエクスポート済みの仮想サーバの世代が第2世代の場合だけ有効です。

入力

無効

○　

実行時オプション

hyperv.osSettingWaitTime

OS初期設定の待機処理時間

OSの初期設定が完了するまでの待機時間を秒単位で指定します。

入力

無効

○　

実行時オプション

common.icmpEchoTimeout

ICMPエコー要求のタイムアウト時間

ネットワーク接続確認を実行する場合，仮想サーバの起動後に実行する，ICMPエコー要求に対する応答を待つ時間をミリ秒単位で指定します。

入力

無効

○　

実行時オプション

hyperv.checkVmStateEnabledCount

仮想サーバの状態(起動完了)の確認回数

仮想サーバの起動が完了したか確認する際の確認回数を指定します。仮想サーバの状態(起動完了)の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

hyperv.checkVmStateEnabledInterval

仮想サーバの状態(起動完了)の確認間隔

仮想サーバの起動が完了したか確認する際の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

hyperv.checkJobStateCountGetDriveList

ジョブ監視回数(Win32_LogicalDiskメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(Win32_LogicalDiskメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobStateIntervalGetDriveList

ジョブ監視間隔(Win32_LogicalDiskメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(Win32_LogicalDiskメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

仮想サーバ情報

hyperv.exportedVmName

エクスポート済みの仮想サーバのフォルダのパス

仮想サーバの複製元となるエクスポート済みの仮想サーバのフォルダ名をフルパスで指定します。格納サーバがHyper-Vサーバと別サーバの場合，UNCを指定してください。

入力

無効

○　

仮想サーバ情報

hyperv.importFolderPath

インポート先

仮想サーバを格納するフォルダをフルパスで指定します。

入力

無効

○　

仮想サーバ情報

windows.operatingSystem

OS名

仮想サーバのOS名を指定します。

入力

無効

○　

仮想サーバ情報

OS.computerName

コンピュータ名/ホスト名

OSのコンピュータ名(ホスト名)を指定します。

入力

無効

○　

OS情報

OS.osUserPassword

Administratorのパスワード

OSに設定するAdministratorのパスワードを指定します。入力がない場合は，"Password123"が設定されます。

入力

無効

△　

OS情報

OS.osUserPasswordReEnter

Administratorのパスワード再入力

OSに設定するAdministratorのパスワードを再入力してください。入力がない場合は，"Password123"が設定されます。

入力

無効

△　

OS情報

OS.productKey

OSのプロダクトキー

OSのプロダクトキーを指定します。入力の形式は「XXXXX-XXXXX-XXXXX-XXXXX-XXXXX」です。

入力

無効

△　

OS情報

OS.ipAddressMan

IPアドレス(管理用)

仮想サーバに設定する管理用LANのIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.ipAddress2

IPアドレス(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.ipAddress3

IPアドレス(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.ipAddress4

IPアドレス(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.timeZoneWin

タイムゾーン

仮想サーバのOSに設定するタイムゾーンを指定します。

入力

無効

△　

OS情報

OS.systemLocale

システムロケール

仮想サーバのOSに設定されているシステムロケールを指定します。

入力

無効

○　

OS情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.targetHost

256文字以内の半角英数字および「.」，「-」。

hyperv.userName

20文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「¥」，「@」，「%」を除く。

hyperv.password

127文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

windows.orgName

256文字以内の文字列。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

windows.ownerName

256文字以内の文字列。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

OS.selectWorkgroupDomain

次の値のどれかを選択する。

WORKGROUP,DOMAIN

OS.workgroupNameDomainName

63文字以内の半角英数字。および「-」，「.」。

OS.domainUserName

20文字以内の半角英数字。および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「¥」，「@」，「%」を除く。

OS.domainUserPassword

127文字以内の半角英数字。および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

OS.subnetMaskMan

15文字以内の半角数字および「.」。

OS.defaultGWMan

15文字以内の半角数字および「.」。

OS.dnsMan

15文字以内の半角数字および「.」。

hyperv.virtualSwitchMan

63文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

OS.subnetMask2

15文字以内の半角数字および「.」。

OS.defaultGW2

15文字以内の半角数字および「.」。

OS.dns2

15文字以内の半角数字および「.」。

hyperv.virtualSwitch2

63文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

OS.subnetMask3

15文字以内の半角数字および「.」。

OS.defaultGW3

15文字以内の半角数字および「.」。

OS.dns3

15文字以内の半角数字および「.」。

hyperv.virtualSwitch3

63文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

OS.subnetMask4

15文字以内の半角数字および「.」。

OS.defaultGW4

15文字以内の半角数字および「.」。

OS.dns4

15文字以内の半角数字および「.」。

hyperv.virtualSwitch4

63文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

OS.destIPAddress

15文字以内の半角数字および「.」。

OS.subnetMaskStaticRoute

15文字以内の半角数字および「.」。

OS.defaultGWStaticRoute

15文字以内の半角数字および「.」。

hyperv.scsiDiskLocation

0〜63の整数値。

hyperv.osSettingWaitTime

0〜2147483647の整数値。

common.icmpEchoTimeout

1〜2147483647の整数値。

hyperv.checkVmStateEnabledCount

1〜2147483647の整数値。

hyperv.checkVmStateEnabledInterval

1〜60の整数値。

hyperv.checkJobStateCountGetDriveList

1〜2147483647の整数値。

hyperv.checkJobStateIntervalGetDriveList

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.vmName

100文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」，「¥」，「/」，「:」，先頭の「 (スペース)」および末尾の「 (スペース)」，「.」を除く。

hyperv.exportedVmName

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「'」，「[」，「]」，「`」および末尾の「¥」を除く。

hyperv.importFolderPath

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「'」，「[」，「]」，「`」および末尾の「¥」を除く。

windows.operatingSystem

次の値のどれかを選択する。

Windows Server 2008 R2,Windows Server 2012,Windows Server 2012 R2

OS.computerName

15文字以内の半角英数字および「-」。

OS.osUserPassword

64文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.osUserPasswordReEnter

64文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.productKey

29文字以内の半角英数字，および「-」。

OS.ipAddressMan

15文字以内の半角数字および「.」。

OS.ipAddress2

15文字以内の半角数字および「.」。

OS.ipAddress3

15文字以内の半角数字および「.」。

OS.ipAddress4

15文字以内の半角数字および「.」。

OS.timeZoneWin

次の値のどれかを選択する。

Tokyo Standard Time, China Standard Time, GMT Standard Time, Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Central Standard Time, Central America Standard Time, US Mountain Standard Time, Mountain Standard Time, Alaskan Standard Time, Hawaiian Standard Time, Singapore Standard Time, India Standard Time

OS.systemLocale

次の値のどれかを選択する。

ja-JP,en-US,zh-CN

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの作成

仮想サーバの作成

仮想サーバの作成

Hyper-V環境において，エクスポート済みの仮想サーバから仮想サーバを作成します。

タスクログを確認し，エラーの原因を取り除いたあと，サービスを再実行してください。

Hyper-Vサーバに仮想サーバが作成されている場合は，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

2

仮想サーバの仮想スイッチ設定(管理用)

仮想サーバの仮想スイッチ設定(管理用)

仮想サーバの仮想スイッチ設定

ローカルサーバとの通信を確立するために，仮想スイッチを設定します。

タスクログを確認し，エラーの原因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

3

応答ファイルの配置

応答ファイルの配置

階層フロー部品

仮想サーバに応答ファイルを配置します。

−　

3-1

仮想ディスクのマウント

Hyper-Vサーバに仮想ディスクをマウントします。

タスクログを確認し，エラーの原因を取り除いたあと，Hyper-Vサーバに仮想ディスクがマウントされている場合は，手動でアンマウントしてください。その後，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

3-2

応答ファイル作成

Hyper-V環境の仮想サーバに対してOSの初期設定，およびIPアドレス設定を行うための応答ファイルを作成します。

タスクログを確認し，エラーの原因を取り除いたあと，Hyper-Vサーバに仮想ディスクがマウントされている場合は，手動でアンマウントしてください。その後，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

3-3

仮想ディスクのアンマウント

Hyper-Vサーバから仮想ディスクをアンマウントします。

タスクログを確認し，エラーの原因を取り除いたあと，Hyper-Vサーバに仮想ディスクがマウントされている場合は，手動でアンマウントしてください。その後，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

4

OS初期設定&IPアドレス設定

OS初期設定&IPアドレス設定

階層フロー部品

仮想サーバのOS初期設定(コンピュータ名，会社名，組織名)とIPアドレス設定を行い，仮想サーバを起動します。

−　

4-1

仮想サーバの起動

Hyper-V環境において，仮想サーバを起動します。

タスクログを確認し，エラーの原因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

4-2

値判定分岐部品

OS初期設定の待機時間が必要であるか判定します。

タスクログを確認し，エラーの原因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

4-3

実行待機

OS初期設定の待機時間が必要である場合に待機処理を実施します。

タスクログを確認し，エラーの原因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

4-4

値判定分岐部品

NICにIPアドレスが設定されているか判定します。

タスクログを確認し，エラーの原因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

4-5

階層フロー部品

ローカルサーバと仮想サーバのネットワーク接続を確認し，2〜4個目のNICにIPアドレスを設定します。

−　

4-5-1

ICMPエコー要求メッセージの送信

電源状態がONになった仮想サーバにICMPエコー要求を発行します。

タスクログを確認し，エラーの原因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

4-5-2

値判定分岐部品

2〜4個目のNICの設定が必要か判定します。

タスクログを確認し，エラーの原因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

4-5-3

階層フロー部品

2〜4個目のNICの設定を行います。

−　

4-5-3-1

NICのMACアドレス取得

管理用NICのMACアドレスを取得します。

タスクログを確認し，エラーの原因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

4-5-3-2

仮想サーバの仮想スイッチ設定

2〜4個目のNICと仮想スイッチの接続を切断します。

タスクログを確認し，エラーの原因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

4-5-3-3

Windowsネットワークの設定

2〜4個目のNICにIPアドレスを設定します。

Hyper-Vサーバにログインし，仮想サーバの設定を確認してください。その後，仮想サーバにログインし，仮想サーバの設定を確認してください。必要に応じて仮想サーバの設定を手動で行ってください。もしくは，タスクログを確認し，エラーの要因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

5

仮想サーバの仮想スイッチ設定(2〜4個目用)

仮想サーバの仮想スイッチ設定(2〜4個目用)

階層フロー部品

2〜4個目のNICに仮想スイッチを設定します。

−　

5-1

値判定分岐部品

NICにIPアドレスが設定されているか判定します。

Hyper-Vサーバにログインし，仮想サーバの設定を確認してください。その後，仮想サーバにログインし，仮想サーバの設定を確認してください。必要に応じて仮想サーバの設定を手動で行ってください。もしくは，タスクログを確認し，エラーの要因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

5-2

階層フロー部品

2〜4個目のNICに仮想スイッチを設定します。

−　

5-2-1

値判定分岐部品

2〜4個目のNICの設定が必要か判定します。

Hyper-Vサーバにログインし，仮想サーバの設定を確認してください。その後，仮想サーバにログインし，仮想サーバの設定を確認してください。必要に応じて仮想サーバの設定を手動で行ってください。もしくは，タスクログを確認し，エラーの要因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

5-2-2

階層フロー部品

2〜4個目のNICに仮想スイッチを設定します。

−　

5-2-2-1

NICのMACアドレス取得

2〜4個目のNICのMACアドレスを取得します。

Hyper-Vサーバにログインし，仮想サーバの設定を確認してください。その後，仮想サーバにログインし，仮想サーバの設定を確認してください。必要に応じて仮想サーバの設定を手動で行ってください。もしくは，タスクログを確認し，エラーの要因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

5-2-2-2

仮想サーバの仮想スイッチ設定

2〜4個目のNICに仮想スイッチを設定します。

Hyper-Vサーバにログインし，仮想サーバの設定を確認してください。その後，仮想サーバにログインし，仮想サーバの設定を確認してください。必要に応じて仮想サーバの設定を手動で行ってください。もしくは，タスクログを確認し，エラーの要因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

5-3

値判定分岐部品

NICにIPアドレスが設定されているか判定します。

Hyper-Vサーバにログインし，仮想サーバの設定を確認してください。その後，仮想サーバにログインし，仮想サーバの設定を確認してください。必要に応じて仮想サーバの設定を手動で行ってください。もしくは，タスクログを確認し，エラーの要因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

5-4

仮想サーバの仮想スイッチ設定

2〜4個目のNICに仮想スイッチを設定します。

Hyper-Vサーバにログインし，仮想サーバの設定を確認してください。その後，仮想サーバにログインし，仮想サーバの設定を確認してください。必要に応じて仮想サーバの設定を手動で行ってください。もしくは，タスクログを確認し，エラーの要因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

6

OSスタティックルート設定

OSスタティックルート設定

階層フロー部品

仮想サーバのOSで，スタティックルートを設定します。

−　

6-1

値判定分岐部品

仮想サーバに複数のNICが設定されているか判定します。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

6-2

階層フロー部品

仮想サーバのOSで，複数のIPアドレスが設定されていることを確認します。

−　

6-2-1

値判定分岐部品

仮想サーバのOSで，複数のIPアドレスが設定されているか判定します。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

6-2-2

階層フロー部品

仮想サーバのOSで，管理用IPアドレスが設定されていることを確認します。

−　

6-2-2-1

値判定分岐部品

仮想サーバのOSで，管理用IPアドレスが設定されているか判定します。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

6-2-2-2

スタティックルートの設定

仮想サーバのOSで，スタティックルートを設定します。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

7

ドメインへの参加

ドメインへの参加

階層フロー部品

ドメインへの参加処理を行います。

−　

7-1

値判定分岐部品

仮想サーバのOSで，管理用IPアドレスが設定されているか判定します。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

7-2

階層フロー部品

ドメインへの参加処理を行います。

−　

7-2-1

値判定分岐部品

ドメインへの参加処理が必要か判定します。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

7-2-2

階層フロー部品

ドメインへの参加処理の成否を確認します。

−　

7-2-2-1

Windowsネットワークの設定

ドメインへの参加処理を行います。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

7-2-2-2

値判定分岐部品

ドメインへの参加処理の成否を判定します。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

7-2-2-3

階層フロー部品

Hyper-V環境において，仮想サーバを再起動します。

−　

7-2-2-3-1

仮想サーバのシャットダウン

Hyper-V環境において，仮想サーバをシャットダウンします。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

7-2-2-3-2

仮想サーバの起動

Hyper-V環境において，仮想サーバを起動します。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

3.8.4　仮想サーバの追加(仮想ディスク)

機能

このサービステンプレートは，Hyper-V環境に仮想ディスクを作成し，仮想サーバに作成した仮想ディスクを追加します。

このサービステンプレートが前提とするサーバを次に示します。

・Hyper-Vサーバ

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

処理の概要を次に示します。

(1) 仮想サーバの状態を取得します。

(2) 仮想サーバが停止していることを確認します。

　仮想サーバが停止している場合は処理を継続しますが，それ以外の場合は，ユーザー応答待ち部品を実行して，シャットダウンするか・しないかを確認します。

　ユーザー応答待ちのGUIで"Shutdown"を選択した場合は，起動している仮想サーバをシャットダウンします。起動以外の仮想サーバに対して"Shutdown"を選択した場合は，仮想サーバには操作を行わずにタスクが異常終了します。

　"Cancel"を選択するか，応答待ちがタイムアウトになった場合は，仮想サーバには操作を行わずにタスクが異常終了します。

(3) Hyper-V環境に仮想ディスクファイルを作成します。

　作成できる仮想ディスクは「Dynamic(容量可変)」または「Fixed(容量固定)」です。仮想ディスク(差分)およびパススルー(物理)ディスクは作成できません。

　hyperv.vHardDiskFolderPathプロパティを指定した場合に，指定したフォルダパスに仮想ディスクファイルを新規に作成します。指定が無い場合は，Hyper-Vサーバに設定されている仮想ディスクを保存する既定のフォルダに仮想ディスクを保存します。

　新規に作成する仮想ディスクを保存するフォルダパスが存在しない場合はフォルダを作成します。

(4) 仮想サーバに仮想ディスクを接続します。

　仮想ディスクは，SCSIコントローラーに追加できますが，IDEコントローラーには追加できません。

　SCSIコントローラーの番号(hyperv.scsiControllerNumberプロパティ)とSCSIコントローラーの場所番号(hyperv.scsiLocationNumberプロパティ)の指定の有無により，SCSIコントローラーへの仮想ディスクの接続方法が異なります。

　・SCSIコントローラーの番号とSCSIコントローラーの場所番号が両方指定されていない場合

　　接続可能なSCSIコントローラーにHyper-Vサーバが自動的に仮想ディスクを接続します。

　・SCSIコントローラーの番号だけ指定されている場合

　　指定したSCSIコントローラーの番号で接続可能なSCSIコントローラーの場所番号(0〜63)のどれかにHyper-Vサーバが自動的に仮想ディスクを接続します。

　・SCSIコントローラーの場所番号だけ指定されている場合

　　指定したSCSIコントローラーの場所番号で接続可能なSCSIコントローラーの番号(0〜3)のどれかにHyper-Vサーバが自動的に仮想ディスクを接続します。

　・SCSIコントローラーの番号とSCSIコントローラーの場所番号が両方指定されている場合

　　指定したSCSIコントローラーの番号とSCSIコントローラーの場所番号に仮想ディスクを接続します。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2012 Hyper-V，Windows Server 2012 R2 Hyper-V

【サービステンプレート実行システム内前提製品の稼働OS】

(1)Hyper-Vサーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。

　・オペレーティングシステムのシャットダウン

(3)仮想サーバに接続可能なSCSIコントローラーが存在すること。

注意事項

(1)このサービステンプレートでは仮想サーバに追加した仮想ディスクの初期化は行いません。必要に応じて仮想サーバのOSにログインし，ディスクの初期化を実行してください。

(2)同一の仮想サーバに対して，このサービスを複数同時に実行しないでください。

(3)UserResponseplugin.dialogTextプロパティにHTMLタグを指定する場合，指定できるタグおよび属性はユーザー応答待ち部品と同じです。詳細については，本製品マニュアルの「ユーザー応答待ち部品」について説明しているトピックを参照してください。

(4)Hyper-Vサーバに作成済みの仮想ディスクファイルは追加できません。

(5)ユーザー応答待ちのGUIで"Shutdown"を選択した場合は，仮想サーバのOSを強制的にシャットダウンします。仮想サーバで編集中のファイルデータは保存されません。

(6)指定したSCSIコントローラーの番号とSCSIコントローラーの場所番号が既に他の仮想ディスクの接続先として使用されている場合は，タスクが異常終了します。

(7)第2世代の仮想サーバにはVHDXファイルの仮想ディスクだけ追加できます。作成したVHDファイルを第2世代の仮想サーバに接続する場合，タスクが異常終了します。

バージョン

03.00.00

タグ

Modify VM,Hyper-V 2012

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

Hyper-Vサーバの情報を指定してください。

表示されます。

仮想サーバ情報

仮想ディスクを追加する仮想サーバの情報を指定してください。

表示されます。

仮想ディスク情報

作成する仮想ディスクの情報を指定してください。

表示されます。

仮想ディスク接続情報

仮想ディスクを接続するSCSIコントローラーの情報を指定してください。接続するSCSIコントローラーを指定したい場合だけ指定してください。

表示されません。

ユーザー応答待ちオプション

仮想サーバが起動していた場合のユーザー応答のためのオプションです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.targetHost

Hyper-Vサーバのホスト名

Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

UserResponsePlugin.toAddress

TOメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(TO)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.ccAddress

CCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(CC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.bccAddress

BCCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(BCC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailSubject

メール件名

ユーザー応答待ちになった場合のメール通知のメールの件名を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailBody

メール本文

ユーザー応答待ちになった場合のメール通知のメール本文を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.encodeType

エンコード種別

ユーザー応答待ちになった場合のメール通知のエンコード種別を指定します。指定可能なエンコード名は次のとおりです。us-ascii，iso-2022-jp，shift_jis，euc-jp，utf-8。指定しなかった場合には，utf-8で送信されます。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.dialogText

応答入力画面の補足情報

ユーザー応答待ちになった場合の応答入力ダイアログに表示する補足情報を指定します。テキスト形式，またはHTML形式で指定できます。指定可能なHTMLタグは，アンカータグ，ボールドタグ，ブレークタグ，フォントタグ，イタリックタグ，下線タグです。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.responseTimeOut

応答タイムアウト時間(分)

ユーザー応答待ちになった場合の応答がタイムアウトする時間を分単位で指定します。応答タイムアウト時間が過ぎると，サービスが異常終了します。

入力

無効

○　

ユーザー応答待ちオプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

仮想サーバ情報

hyperv.vHardDiskName

仮想ディスクファイル名

作成する仮想ディスクのファイル名を指定してください。ファイルの拡張子には「vhd」または「vhdx」を指定してください。

入力

無効

○　

仮想ディスク情報

hyperv.vHardDiskFolderPath

仮想ディスク保存フォルダパス

作成する仮想ディスクを保存するフォルダのフルパスを指定してください。指定を省略した場合は，Hyper-Vサーバに設定されている仮想ディスクを保存する既定のフォルダに仮想ディスクを保存します。

入力

無効

△　

仮想ディスク情報

hyperv.vHardDiskType

仮想ディスクのタイプ

仮想ディスクのタイプを指定します。次のどちらかを指定します。Dynamic:容量可変の仮想ディスクを作成します。Fixed:容量固定の仮想ディスクを作成します。

入力

無効

○　

仮想ディスク情報

hyperv.capacity

容量 (GB)

仮想ディスクの容量をGB単位で指定します。

入力

無効

○　

仮想ディスク情報

hyperv.scsiControllerNumber

SCSIコントローラーの番号

仮想ディスクを追加する仮想サーバのSCSIコントローラーの番号を指定します。SCSIコントローラーの番号は，仮想サーバにSCSIコントローラーを追加した(Hyper-V マネージャーで表示する)順番を0から相対する整数値で指定してください。

入力

無効

△　

仮想ディスク接続情報

hyperv.scsiLocationNumber

SCSIコントローラーの場所番号

仮想ディスクを追加する仮想サーバのSCSIコントローラーの場所番号を指定します。SCSIコントローラーの場所番号は，仮想サーバに追加したSCSIコントローラーの未使用の場所を整数値で指定してください。

入力

無効

△　

仮想ディスク接続情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

hyperv.attachScsiControllerNumber

接続済みSCSIコントローラーの番号

仮想ディスクファイルを接続したSCSIコントローラーの番号を出力します。

出力

無効

hyperv.attachScsiLocationNumber

接続済みSCSIコントローラーの場所番号

仮想ディスクファイルを接続したSCSIコントローラーの場所番号を出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.targetHost

256文字以内の半角英数字および「.」，「-」。

UserResponsePlugin.toAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.ccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.bccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.mailSubject

256文字以内の文字列。

UserResponsePlugin.mailBody

1024文字以内の文字列。

UserResponsePlugin.encodeType

次の値のどれかを選択する。

us-ascii,iso-2022-jp,shift_jis,euc-jp,utf-8

UserResponsePlugin.dialogText

512文字以内の文字列。

UserResponsePlugin.responseTimeOut

1〜9999の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.vmName

100文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」，「¥」，「/」，「:」，先頭の「 (スペース)」および末尾の「 (スペース)」，「.」を除く。

hyperv.vHardDiskName

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「'」，「[」，「]」，「`」，「:」，「¥」を除く。

hyperv.vHardDiskFolderPath

247文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「'」，「[」，「]」，「`」および末尾の「¥」を除く。

hyperv.vHardDiskType

次の値のどれかを選択する。

Dynamic,Fixed

hyperv.capacity

1以上の整数値。

hyperv.scsiControllerNumber

次の値のどれかを選択する。

0,1,2,3

hyperv.scsiLocationNumber

0以上63以下の整数値。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの状態確認

仮想サーバの状態確認

階層フロー部品

仮想サーバの状態を調べ，仮想サーバが起動している場合はユーザーに確認します。

−　

1-2

仮想サーバの状態取得

指定した仮想サーバの状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-3

値判定分岐部品

仮想サーバが停止しているか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-4

階層フロー部品

ユーザーに仮想サーバを停止するか確認し，停止する場合は仮想サーバをシャットダウンします。

−　

1-4-1

ユーザー応答待ち部品

ユーザーに仮想サーバを停止するかユーザー応答待ちで確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-4-2

仮想サーバの状態取得

指定した仮想サーバの状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-4-3

値判定分岐部品

仮想サーバが停止しているか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-4-4

仮想サーバのシャットダウン

仮想サーバをシャットダウンします。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

仮想ディスクの作成

仮想ディスクの作成

仮想ディスクの作成

仮想ディスクを作成します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

仮想ディスクの接続

仮想ディスクの接続

仮想ディスクの接続

仮想サーバに仮想ディスクを接続します。

エラーが発生した場合は，作成した仮想ディスクをHyper-Vサーバ上で直接接続するか，仮想ディスクを削除したあと，エラー原因を取り除いて，サービスを再実行してください。

3.9　Hyper-V 2012（運用）用のサービステンプレート

3.9.1　仮想サーバの起動

機能

このサービステンプレートは，Hyper-V環境の複数の仮想サーバを起動します。

このサービステンプレートが前提とするサーバを次に示します。

・Hyper-Vサーバ

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

処理の概要を次に示します。

(1) 仮想サーバの状態を取得します。

(2) 仮想サーバが停止している場合に，仮想サーバを起動します。仮想サーバが起動している場合は，仮想サーバを起動する処理をスキップします。仮想サーバが起動および停止している以外の場合は，該当する仮想サーバの処理がエラーとなります。

(3) ネットワーク接続確認を実施する場合は，起動した仮想サーバに設定されているIPアドレス(IPv4)を取得したのち，ローカルサーバから起動した仮想サーバに対してICMPエコー要求を送信し，ネットワーク接続を確認します。

上記の処理を，指定された仮想サーバ群に対して並列に実行します。

仮想サーバを起動する際には，hyperv.checkVmStateEnabledIntervalプロパティに指定した秒数待ち合わせ，仮想サーバの状態を確認する動作を，hyperv.checkVmStateEnabledCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2012 Hyper-V，Windows Server 2012 R2 Hyper-V

【サービステンプレート実行システム内前提製品の稼働OS】

(1)Hyper-Vサーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。

　・データ交換

(3)ネットワーク接続確認を実行する場合，エージェントレス接続先としてローカルサーバ("localhost"で解決されるループバックアドレス)を設定する必要があります。

(4)ネットワーク接続確認を実行する場合，対象となる仮想サーバのファイアーウォールがICMP(ECHO)応答を許可していること。

注意事項

(1)ネットワーク接続確認を実施する場合は，システム環境によって，仮想サーバの起動直後にすべてのIPアドレスが取得できない場合があります。そのため，仮想サーバが起動しているにも関わらず，osSendIcmp部品で仮想サーバに設定されたすべてのIPアドレス(IPv4)でネットワークの接続確認が出来ずにタスクが異常終了する場合があります。仮想サーバの起動からIPアドレス取得開始までの待機時間を指定するhyperv.waitTimeプロパティの秒数を指定して，すべてのIPアドレスが取得できるように調節してください。

(2)ネットワーク接続確認を実施する場合は，仮想サーバのすべてのNICに設定されているIPアドレス(IPv4)の長さの合計を1024文字以内(※1)にして設定してください。IPアドレス(IPv4)の長さの合計が1024文字を超えると，osSendIcmp部品でエラーが発生し，タスクが異常終了する場合があります。

※IPアドレス(IPv4)1つの最大の長さは16文字(IPアドレス連結用の「,(コンマ)」を含む)。

(3)ネットワーク接続確認を実行する場合，common.icmpEchoTimeoutプロパティは利用している環境に応じて調整してください。

実行権限

ビルトイン Administrator

バージョン

03.00.00

タグ

Control VM,Hyper-V 2012

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

Hyper-V 2012の情報を指定してください。

表示されます。

仮想サーバ情報

起動する仮想サーバの情報を指定してください。

表示されます。

ネットワーク接続確認

仮想サーバを起動したあとのネットワーク接続確認に関するプロパティです。必要に応じて変更してください。

表示されません。

実行時オプション

仮想サーバを起動する際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.targetHost

Hyper-Vサーバのホスト名

Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

hyperv.waitTime

IPアドレス取得開始までの待機時間

ネットワーク接続確認を実行する場合，仮想サーバの起動が完了してからIPアドレス取得を開始するまでの待機時間を秒単位で指定します。

入力

無効

○　

ネットワーク接続確認

common.icmpEchoTimeout

ICMPエコー要求のタイムアウト時間

仮想サーバの起動確認で実施する，ICMPエコー要求に対する応答を待つ時間をミリ秒単位で指定します。

入力

無効

○　

ネットワーク接続確認

hyperv.checkVmStateEnabledCount

仮想サーバの状態(起動完了)の確認回数

仮想サーバの起動が完了したか確認する際の確認回数を指定します。仮想サーバの状態(起動完了)の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

hyperv.checkVmStateEnabledInterval

仮想サーバの状態(起動完了)の確認間隔

仮想サーバの起動が完了したか確認する際の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.foreachVmName

仮想サーバ名(複数指定可)

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。複数指定する場合はコンマで区切ってください。99個まで指定できます。

入力

無効

○　

仮想サーバ情報

hyperv.checkNetworkConnection

ネットワーク接続確認の実行

仮想サーバの起動後にネットワーク接続確認を実行するかどうかを指定します。

入力

無効

○　

ネットワーク接続確認

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.targetHost

256文字以内の半角英数字および「.」，「-」。

hyperv.waitTime

0〜3600の整数値。

common.icmpEchoTimeout

1〜2147483647の整数値。

hyperv.checkVmStateEnabledCount

1〜2147483647の整数値。

hyperv.checkVmStateEnabledInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.foreachVmName

1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」，「/」，「:」を除く。

hyperv.checkNetworkConnection

次の値のどれかを選択する。

yes,no

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの起動

仮想サーバの起動

繰り返し実行部品

複数の仮想サーバを起動します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.9.2　仮想サーバの起動(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの状態取得

hyperv2012GetVMState

仮想サーバの状態取得

Hyper-V環境において，仮想サーバの状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

仮想サーバの起動

hyperv2012PowerOnVM

階層フロー部品

Hyper-V環境において，仮想サーバを起動します。

−　

2-1

値判定分岐部品

仮想サーバが起動しているか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-2

仮想サーバの起動

仮想サーバが起動以外の状態である場合，仮想サーバを起動します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

ネットワーク接続確認

hyperv2012CheckNetwork

階層フロー部品

ネットワークが接続されているかを確認します。

−　

3-1

値判定分岐部品

ネットワーク接続確認にyesが指定されているかを判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-2

階層フロー部品

ネットワーク接続確認にyesが指定されている場合，ネットワーク接続確認を実施します。

−　

3-2-1

値判定分岐部品

IPアドレス取得開始までの待機時間に0より大きい値が指定されているか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-2-2

実行待機

IPアドレス取得開始までの待機時間に0より大きい値が指定されている場合，待機処理を実施します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-2-3

仮想サーバのIPアドレス取得

起動完了した仮想サーバのIPアドレスを取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-2-4

ICMPエコー要求メッセージの送信

起動完了した仮想サーバにICMPエコー要求を発行します。

システム環境の状態によっては，仮想サーバの起動には成功するが，ネットワークの接続確認に失敗し，タスクが異常終了する場合があります。仮想サーバが起動しているか確認してください。サービスを再実行する場合は，注意事項を確認し，エラー原因を取り除いたあとで実行してください。

3.9.3　仮想サーバの再起動

機能

このサービステンプレートは，Hyper-V環境の複数の仮想サーバを再起動します。

このサービステンプレートが前提とするサーバを次に示します。

・Hyper-Vサーバ

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

処理の概要を次に示します。

(1) 仮想サーバが起動している場合に，仮想サーバを再起動します。仮想サーバの状態が起動以外の場合は，該当する仮想サーバの処理がエラーになります。

(2) ネットワーク接続確認を実行する場合は，再起動した仮想サーバに設定されているIPアドレス(IPv4)を取得したのち，ローカルサーバから再起動した仮想サーバに対してICMPエコー要求を送信し，ネットワーク接続を確認します。

上記の処理を，指定された仮想サーバ群に対して並列に実行します。

仮想サーバを起動する際には，hyperv.checkVmStateEnabledIntervalプロパティに指定した秒数待ち合わせ，仮想サーバの状態を確認する動作を，hyperv.checkVmStateEnabledCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2012 Hyper-V，Windows Server 2012 R2 Hyper-V

【サービステンプレート実行システム内前提製品の稼働OS】

(1)Hyper-Vサーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。

　・オペレーティングシステムのシャットダウン

　・データ交換

(3)ネットワーク接続確認を実行する場合，エージェントレス接続先としてローカルサーバ("localhost"で解決されるループバックアドレス)を設定する必要があります。

(4)ネットワーク接続確認を実行する場合，対象となる仮想サーバのファイアーウォールがICMP(ECHO)応答を許可していること。

(5)仮想サーバが起動していること。

注意事項

(1)このサービスは指定した仮想サーバのOSを強制的にシャットダウンします。このサービスを実行した場合，仮想サーバで編集中のファイルデータは保存されません。

(2)ネットワーク接続確認を実行する場合は，システム環境によって，仮想サーバの起動直後にすべてのIPアドレスが取得できない場合があります。そのため，仮想サーバが起動しているにも関わらず，osSendIcmp部品で仮想サーバに設定されたすべてのIPアドレス(IPv4)でネットワークの接続確認が出来ずにタスクが異常終了する場合があります。仮想サーバの起動からIPアドレス取得開始までの待機時間を指定するhyperv.waitTimeプロパティの秒数を指定して，すべてのIPアドレスが取得できるように調節してください。

(3)ネットワーク接続確認を実行する場合は，仮想サーバのすべてのNICに設定されているIPアドレス(IPv4)の長さの合計を1024文字以内(※)にして設定してください。IPアドレス(IPv4)の長さの合計が1024文字を超えると，osSendIcmp部品でエラーが発生し，タスクが異常終了する場合があります。

　※IPアドレス(IPv4)1つの最大の長さは16文字(IPアドレス連結用の「,(コンマ)」を含む)。

(4)ネットワーク接続確認を実行する場合，common.icmpEchoTimeoutプロパティは利用している環境に応じて調整してください。

実行権限

ビルトイン Administrator

バージョン

03.00.00

タグ

Control VM,Hyper-V 2012

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

Hyper-Vの情報を指定してください。

表示されます。

仮想サーバ情報

再起動する仮想サーバの情報を指定してください。

表示されます。

ネットワーク接続確認

仮想サーバを再起動したあとのネットワーク接続確認に関するプロパティです。必要に応じて変更してください。

表示されません。

実行時オプション

仮想サーバを再起動する際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.targetHost

Hyper-Vサーバのホスト名

Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

hyperv.waitTime

IPアドレス取得開始までの待機時間

ネットワーク接続確認を実行する場合，仮想サーバの再起動が完了してからIPアドレス取得を開始するまでの待機時間を秒単位で指定します。

入力

無効

○　

ネットワーク接続確認

common.icmpEchoTimeout

ICMPエコー要求のタイムアウト時間

ネットワーク接続確認を実行する場合，仮想サーバの再起動後に実行する，ICMPエコー要求に対する応答を待つ時間をミリ秒単位で指定します。

入力

無効

○　

ネットワーク接続確認

hyperv.checkVmStateEnabledCount

仮想サーバの状態(起動完了)の確認回数

仮想サーバの起動が完了したか確認する際の確認回数を指定します。仮想サーバの状態(起動完了)の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

hyperv.checkVmStateEnabledInterval

仮想サーバの状態(起動完了)の確認間隔

仮想サーバの起動が完了したか確認する際の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.foreachVmName

仮想サーバ名(複数指定可)

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。複数指定する場合はコンマで区切ってください。99個まで指定できます。

入力

無効

○　

仮想サーバ情報

hyperv.checkNetworkConnection

ネットワーク接続確認の実行

仮想サーバの再起動後にネットワーク接続確認を実行するかどうかを指定します。

入力

無効

○　

ネットワーク接続確認

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.targetHost

256文字以内の半角英数字および「.」，「-」。

hyperv.waitTime

0〜3600の整数値。

common.icmpEchoTimeout

1〜2147483647の整数値。

hyperv.checkVmStateEnabledCount

1〜2147483647の整数値。

hyperv.checkVmStateEnabledInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.foreachVmName

1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」，「/」，「:」を除く。

hyperv.checkNetworkConnection

次の値のどれかを選択する。

yes,no

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの再起動

仮想サーバの再起動

繰り返し部品

複数の仮想サーバを再起動します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.9.4　仮想サーバの再起動(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバのシャットダウン

hyperv2012ShutdownVM

仮想サーバのシャットダウン

仮想サーバが起動している場合，仮想サーバをシャットダウンします。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

仮想サーバの起動

hyperv2012PowerOnVM

仮想サーバの起動

仮想サーバが停止している場合，仮想サーバを起動します。

エラーの原因を取り除いて，仮想サーバを起動したあと，サービスを再実行してください。

3

ネットワーク接続確認

hyperv2012CheckNetwork

階層フロー部品

ネットワークが接続されているかを確認します。

−　

3-1

値判定分岐部品

ネットワーク接続確認にyesが指定されているかを判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-2

階層フロー部品

ネットワーク接続確認にyesが指定されている場合，ネットワーク接続確認を実行します。

−　

3-2-1

値判定分岐部品

IPアドレス取得開始までの待機時間に0より大きい値が指定されているか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-2-2

実行待機

IPアドレス取得開始までの待機時間に0より大きい値が指定されている場合，待機処理を実行します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-2-3

仮想サーバのIPアドレス取得

起動完了した仮想サーバのIPアドレスを取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-2-4

ICMPエコー要求メッセージの送信

起動完了した仮想サーバにICMPエコー要求を発行します。

システム環境の状態によっては，仮想サーバの起動には成功するが，ネットワークの接続確認に失敗し，タスクが異常終了する場合があります。仮想サーバが起動しているか確認してください。サービスを再実行する場合は，注意事項を確認し，エラー原因を取り除いたあとで実行してください。

3.9.5　仮想サーバの情報一覧取得

機能

このサービステンプレートは，Hyper-V環境の仮想サーバの情報一覧を取得します。

このサービステンプレートが前提とするサーバを次に示します。

・Hyper-Vサーバ

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

処理の概要を次に示します。

(1) 仮想サーバの情報一覧をCSV形式で指定されたリモートの一時ファイルに出力します。出力ファイルのエンコード形式は，Hyper-Vサーバのシステムのデフォルトエンコーディングです。

(2) リモートの一時ファイルを指定されたローカルの出力ファイルに転送します。

(3) リモートの一時ファイルを削除します。

出力するCSVファイルの項目を次に示します。

項目はコンマ区切りで出力します。

(a) Hyper-Vサーバ名 (ヘッダー名：ComputerName)

(b) 仮想サーバ名 (ヘッダー名：VMName)

(c) 仮想サーバの状態 (ヘッダー名：State)

(d) 仮想サーバのCPU使用率(%) (ヘッダー名：CPUUsage)

(e) 仮想サーバのメモリ割り当て(MB)※1 (ヘッダー名：MemoryAssigned)

(f) 仮想サーバの稼働時間 (ヘッダー名：Uptime)

(g) 仮想サーバの状況 (ヘッダー名：Status)

(h) 仮想サーバの仮想プロセッサ数 (ヘッダー名：ProcessorCount)

(i) 仮想サーバのスタートアップRAM(MB) (ヘッダー名：MemoryStartup)

(j) 仮想サーバの動的メモリの有効 (ヘッダー名：DynamicMemoryEnabled)

※1：仮想サーバが実際に使用しているメモリの容量(MB)です。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2012 Hyper-V，Windows Server 2012 R2 Hyper-V

【サービステンプレート実行システム内前提製品の稼働OS】

(1)Hyper-Vサーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

なし。

注意事項

(1)リモートおよびローカルに指定するファイル名が既に存在する場合，既存のファイルを上書きします。また，リモート側のファイルは削除します。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(2)リモートに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

(3)同名の仮想サーバが2つ以上ある場合，出力するCSVファイルでは仮想サーバを特定できません。

バージョン

02.00.00

タグ

Gather VM information,Hyper-V 2012

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

Hyper-Vの情報を指定してください。

表示されます。

出力ファイル格納情報

出力ファイルの格納先を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.targetHost

Hyper-Vサーバのホスト名

Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.listOutputFileNameRemote

出力ファイル名(リモート)

仮想サーバ情報をHyper-Vサーバに出力する際の一時ファイル名をフルパスで指定します。

入力

無効

○　

出力ファイル格納情報

hyperv.listOutputFileNameLocal

出力ファイル名(ローカル)

仮想サーバ情報をローカルサーバに格納する際のファイル名をフルパスで指定します。

入力

無効

○　

出力ファイル格納情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.targetHost

256文字以内の半角英数字および「.」，「-」。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.listOutputFileNameRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「'」，「[」，「]」，「`」および末尾の「¥」を除く。

hyperv.listOutputFileNameLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの情報一覧取得

仮想サーバの情報一覧取得

仮想サーバの情報一覧取得

仮想サーバの情報一覧をHyper-Vサーバの一時ファイルに出力します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

ファイル転送

ファイル転送

ファイル転送部品

リモートの一時ファイルをローカルの指定された出力ファイルに転送します。

Hyper-Vサーバ上の一時ファイルをローカルサーバに転送し，そのあとHyper-Vサーバ上の一時ファイルを手動で削除してください。

3

一時ファイル削除

一時ファイル削除

ファイル削除

リモートの一時ファイルを削除します。

Hyper-Vサーバ上の一時ファイルを手動で削除してください。

3.9.6　仮想サーバの停止

機能

このサービステンプレートは，Hyper-V環境の複数の仮想サーバのOSをシャットダウンします。

このサービステンプレートが前提とするサーバを次に示します。

・Hyper-Vサーバ

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

処理の概要を次に示します。

(1) 仮想サーバの状態を取得します。

(2) 仮想サーバが起動している場合に，仮想サーバのOSをシャットダウンします。仮想サーバが停止している場合は，仮想サーバのOSをシャットダウンする処理をスキップします。仮想サーバが起動および停止している以外の場合は，該当する仮想サーバの処理がエラーとなります。

上記の処理を，指定された仮想サーバ群に対して並列に実行します。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2012 Hyper-V，Windows Server 2012 R2 Hyper-V

【サービステンプレート実行システム内前提製品の稼働OS】

(1)Hyper-Vサーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

ただし，Server Coreインストール環境は除く。

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。

　・オペレーティングシステムのシャットダウン

注意事項

(1)このサービスを実行した場合，仮想サーバで編集中のファイルデータは保存されません。

バージョン

03.00.00

タグ

Control VM,Hyper-V 2012

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

Hyper-V 2012の情報を指定してください。

表示されます。

仮想サーバ情報

停止する仮想サーバの情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.targetHost

Hyper-Vサーバのホスト名

Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.foreachVmName

仮想サーバ名(複数指定可)

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。複数指定する場合はコンマで区切ってください。99個まで指定できます。

入力

無効

○　

仮想サーバ情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.targetHost

256文字以内の半角英数字および「.」，「-」。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.foreachVmName

1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」，「/」，「:」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの停止

仮想サーバの停止

繰り返し実行部品

複数の仮想サーバのOSをシャットダウンします。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.9.7　仮想サーバの停止(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの状態取得

hyperv2012GetVMState

仮想サーバの状態取得

Hyper-V環境において，仮想サーバの状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

仮想サーバのシャットダウン

hyperv2012ShutdownVM

階層フロー部品

Hyper-V環境において，仮想サーバをシャットダウンします。

−　

2-1

値判定分岐部品

仮想サーバが停止しているか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-2

仮想サーバのシャットダウン

仮想サーバが停止以外の状態の場合，仮想サーバをシャットダウンします。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.10　Hyper-V 2016（構築）用のサービステンプレート

3.10.1　仮想サーバのスペック変更(CPU，メモリ)

機能

このサービステンプレートは，Hyper-V環境の仮想サーバのリソース(CPU，メモリ)に関して，指定があった項目の設定を変更します。

このサービステンプレートが前提とするサーバを次に示します。

・Hyper-Vサーバ

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

処理の概要を次に示します。

(1) CPU変更およびメモリ変更を実施するか確認します。どちらの変更も実施しない場合，サービスが異常終了します。

(2) 仮想サーバが停止していることを確認します。

　　仮想サーバが停止していない場合は，ユーザー応答待ち部品を実行して，仮想サーバをシャットダウンするか・しないかを確認します。

　　ユーザー応答待ち部品のメール送信先/送信内容，タイムアウト，画面表示内容はModify権限のユーザーが設定できます。

　　ユーザー応答待ちのGUIで"Shutdown"を選択した場合は，仮想サーバをシャットダウンします。

　　"Cancel"を選択するか，応答待ちがタイムアウトになった場合は，仮想サーバのスペックを変更しないでサービスが異常終了します。

(3) 仮想サーバに対して変更を実施するリソース(CPU，メモリ)を変更します。変更できる設定項目は次の通りです。

　　[CPUの設定変更の項目]

　　　・仮想プロセッサの数

　　　・仮想プロセッサリソースの予約

　　　・仮想プロセッサリソースの限度

　　　・仮想プロセッサリソースの相対的な重み

　　　・プロセッサの互換性

　　　・NUMAノードで使用できるプロセッサの最大数

　　　・ソケットで使用できるNUMAノードの最大数

　　[メモリの設定変更の項目]

　　　・スタートアップRAM (MB)

　　　・動的メモリの有効

　　　・動的メモリの最小RAM (MB)

　　　・動的メモリの最大RAM (MB)

　　　・動的メモリのメモリバッファー

　　　・メモリの重み

　　　・NUMAノードで使用できるメモリの最大容量 (MB)

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2016 Hyper-V

【サービステンプレート実行システム内前提製品の稼働OS】

(1)Hyper-Vサーバの前提OS

　・Windows Server 2016 Standard/Datacenter

ただし，Server Core/Nano Serverインストール環境は除く。

(2)仮想サーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

注意事項

(1)同一の仮想サーバに対して，このサービスを複数同時に実行しないでください。

(2)UserResponseplugin.dialogTextにHTMLタグを指定する場合，指定できるタグおよび属性はユーザー応答待ち部品と同じです。詳細については，本製品マニュアルの「ユーザー応答待ち部品」について説明しているトピックを参照してください。

(3)仮想サーバに設定できる仮想プロセッサの最大数は，Hyper-Vサーバによって指定できる値が異なります。

(4)仮想サーバに設定できる各項目のメモリ容量は，Hyper-Vサーバによって指定できる値が異なります。

(5)サービスが異常終了した場合，CPUおよびメモリの一部の設定項目が変更されている場合があります。

(6)hyperv.selectVmCpuChangeプロパティに「yes」を選択し，CPUの設定変更のすべての項目が未入力の状態でサービスを実行した場合，サービスが異常終了します。また，hyperv.selectVmMemoryChangeプロパティに「yes」を選択し，メモリの設定変更のすべての項目が未入力の状態でサービスを実行した場合，サービスが異常終了します。

(7)ユーザー応答待ちのGUIで"Shutdown"を選択した場合は，仮想サーバのOSをシャットダウンします。仮想サーバで編集中のファイルデータは保存されません。

バージョン

03.00.00

タグ

Modify VM,Hyper-V 2016

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

Hyper-Vの情報を指定してください。

表示されます。

仮想サーバ情報

スペックを変更する仮想サーバの情報と変更項目の有無を指定してください。

表示されます。

仮想サーバのCPU変更情報

仮想サーバのCPUの設定項目で変更できる情報です。変更する場合は少なくとも1つのプロパティに値を指定してください。

表示されません。

仮想サーバのメモリ変更情報

仮想サーバのメモリの設定項目で変更できる情報です。変更する場合は少なくとも1つのプロパティに値を指定してください。

表示されません。

ユーザー応答待ちオプション

仮想サーバが起動していた場合のユーザー応答のためのオプションです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.targetHost

Hyper-Vサーバのホスト名

Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

UserResponsePlugin.toAddress

TOメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(TO)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.ccAddress

CCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(CC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.bccAddress

BCCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(BCC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailSubject

メール件名

ユーザー応答待ちになった場合のメール通知のメールの件名を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailBody

メール本文

ユーザー応答待ちになった場合のメール通知のメール本文を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.encodeType

エンコード種別

ユーザー応答待ちになった場合のメール通知のエンコード種別を指定します。指定可能なエンコード名は次のとおりです。us-ascii，iso-2022-jp，shift_jis，euc-jp，utf-8。指定しなかった場合には，utf-8で送信されます。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.dialogText

応答入力画面の補足情報

ユーザー応答待ちになった場合の応答入力ダイアログに表示する補足情報を指定します。テキスト形式，またはHTML形式で指定できます。指定可能なHTMLタグは，アンカータグ，ボールドタグ，ブレークタグ，フォントタグ，イタリックタグ，下線タグです。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.responseTimeOut

応答タイムアウト時間(分)

ユーザー応答待ちになった場合の応答がタイムアウトする時間を分単位で指定します。応答タイムアウト時間が過ぎると，サービスが異常終了します。

入力

無効

○　

ユーザー応答待ちオプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

仮想サーバ情報

hyperv.selectVmCpuChange

仮想サーバのCPU設定の変更有無

仮想サーバのCPU設定を変更する場合は「yes」，変更しない場合は「no」を選択してください。

入力

無効

○　

仮想サーバ情報

hyperv.selectVmMemoryChange

仮想サーバのメモリ設定の変更有無

仮想サーバのメモリ設定を変更する場合は「yes」，変更しない場合は「no」を選択してください。

入力

無効

○　

仮想サーバ情報

hyperv.cpuCount

仮想プロセッサの数

仮想サーバに設定する仮想プロセッサの数を指定します。仮想プロセッサの数は1以上の整数値で指定してください。

入力

無効

△　

仮想サーバのCPU変更情報

hyperv.cpuReserve

仮想プロセッサリソースの予約

仮想サーバが予約する仮想サーバ間の仮想プロセッサリソースの配分を指定します。仮想プロセッサリソースの予約は仮想プロセッサリソースの限度の値以下で，0から100の整数値で指定してください。

入力

無効

△　

仮想サーバのCPU変更情報

hyperv.cpuMaximum

仮想プロセッサリソースの限度

仮想サーバが使用する仮想サーバ間の仮想プロセッサリソースの配分の上限値を指定します。仮想プロセッサリソースの限度は仮想プロセッサリソースの予約の値以上で，0から100の整数値で指定してください。

入力

無効

△　

仮想サーバのCPU変更情報

hyperv.cpuRelativeWeight

仮想プロセッサリソースの相対的な重み

仮想サーバ間における仮想プロセッサリソースの相対的な重みを指定します。仮想プロセッサリソースの相対的な重みは0から10000までの整数値で指定してください。

入力

無効

△　

仮想サーバのCPU変更情報

hyperv.cpuCompatibilityForMigrationEnabled

プロセッサの互換性

プロセッサの互換性を有効にする場合は「true」，無効にする場合は「false」を指定してください。未入力の場合はプロセッサの互換性の設定を変更しません。

入力

無効

△　

仮想サーバのCPU変更情報

hyperv.cpuMaximumCountPerNumaNode

NUMAノードで使用できるプロセッサの最大数

1つの仮想NUMA(Non-Uniform Memory Architecture)ノードで使用できるプロセッサの最大数を指定します。NUMAノードのプロセッサの最大数は1以上の整数値で指定してください。

入力

無効

△　

仮想サーバのCPU変更情報

hyperv.nodeMaximumCountPerNumaSocket

ソケットで使用できるNUMAノードの最大数

1つのソケットで使用できる仮想NUMA(Non-Uniform Memory Architecture)ノードの最大数を指定します。ソケットで使用できるNUMAノードの最大数は1以上の整数値で指定してください。

入力

無効

△　

仮想サーバのCPU変更情報

hyperv.memoryStartupMegaBytes

スタートアップRAM (MB)

仮想サーバの起動時に使用するメモリの量をMB単位で指定します。仮想サーバの起動時に使用するメモリの量は8以上の2の倍数の整数値で指定してください。

入力

無効

△　

仮想サーバのメモリ変更情報

hyperv.dynamicMemoryEnabled

動的メモリの有効

仮想サーバの動的メモリを有効にする場合は「true」，無効にする場合は「false」を指定してください。未入力の場合は動的メモリの有効の設定を変更しません。

入力

無効

△　

仮想サーバのメモリ変更情報

hyperv.dynamicMemoryMinimumMegaBytes

動的メモリの最小RAM (MB)

動的メモリにおける最小メモリ量をMB単位で指定します。最小メモリ量はスタートアップRAMの値以下で，8以上の2の倍数の整数値で指定してください。動的メモリが有効な場合だけ指定してください。

入力

無効

△　

仮想サーバのメモリ変更情報

hyperv.dynamicMemoryMaximumMegaBytes

動的メモリの最大RAM (MB)

動的メモリにおける最大メモリ量をMB単位で指定します。最大メモリ量はスタートアップRAMの値以上で，8以上の2の倍数の整数値で指定してください。動的メモリが有効な場合だけ指定してください。

入力

無効

△　

仮想サーバのメモリ変更情報

hyperv.dynamicMemoryBuffer

動的メモリのメモリバッファー

Hyper-Vでバッファーとして予約しておくべきメモリの割合を指定してください。動的メモリのメモリバッファーは5から2000の整数値で指定してください。動的メモリが有効な場合だけ指定してください。

入力

無効

△　

仮想サーバのメモリ変更情報

hyperv.memoryPriority

メモリの重み

仮想サーバ間における使用可能なメモリを割り当てるときの優先度を指定します。メモリの重みは0から100の整数値で指定してください。

入力

無効

△　

仮想サーバのメモリ変更情報

hyperv.memoryMaximumAmountMegaBytesPerNumaNode

NUMAノードで使用できるメモリの最大容量 (MB)

1つの仮想NUMA(Non-Uniform Memory Architecture)ノードで使用できるメモリの最大容量をMB単位で指定します。NUMAノードのメモリの最大容量は8以上の整数値で指定してください。

入力

無効

△　

仮想サーバのメモリ変更情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.targetHost

256文字以内の半角英数字および「.」，「-」。

UserResponsePlugin.toAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.ccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.bccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.mailSubject

256文字以内の文字列。

UserResponsePlugin.mailBody

1024文字以内の文字列。

UserResponsePlugin.encodeType

次の値のどれかを選択する。

us-ascii,iso-2022-jp,shift_jis,euc-jp,utf-8

UserResponsePlugin.dialogText

512文字以内の文字列。

UserResponsePlugin.responseTimeOut

1〜9999の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.vmName

100文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」，「¥」，「/」，「:」，先頭の「 (スペース)」および末尾の「 (スペース)」，「.」を除く。

hyperv.selectVmCpuChange

次の値のどれかを選択する。

yes,no

hyperv.selectVmMemoryChange

次の値のどれかを選択する。

yes,no

hyperv.cpuCount

1以上の整数値。

hyperv.cpuReserve

0〜100の整数値。

hyperv.cpuMaximum

0〜100の整数値。

hyperv.cpuRelativeWeight

0〜10000の整数値。

hyperv.cpuCompatibilityForMigrationEnabled

次の値のどれかを選択する。

true,false

hyperv.cpuMaximumCountPerNumaNode

1以上の整数値。

hyperv.nodeMaximumCountPerNumaSocket

1以上の整数値。

hyperv.memoryStartupMegaBytes

8以上の整数値。

hyperv.dynamicMemoryEnabled

次の値のどれかを選択する。

true,false

hyperv.dynamicMemoryMinimumMegaBytes

8以上の整数値。

hyperv.dynamicMemoryMaximumMegaBytes

8以上の整数値。

hyperv.dynamicMemoryBuffer

5〜2000の整数値。

hyperv.memoryPriority

0〜100の整数値。

hyperv.memoryMaximumAmountMegaBytesPerNumaNode

8以上の整数値。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの変更必要確認

仮想サーバの変更必要確認

階層フロー部品

仮想サーバのスペック変更(CPU，メモリ)が必要であるか確認します。hyperv.selectVmCpuChangeプロパティおよびhyperv.selectVmMemoryChangeプロパティのどちらにも「no」が設定されている場合はサービスが異常終了します。

−　

1-1

値判定分岐部品

hyperv.selectVmCpuChangeプロパティに「no」が設定されているか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-2

階層フロー部品

仮想サーバのスペック変更(CPU，メモリ)が必要であるか確認します。

−　

1-2-1

戻り値判定分岐部品

hyperv.selectVmMemoryChangeプロパティに「no」が設定されているか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-2-2

異常終了部品

仮想サーバのスペック変更(CPU，メモリ)が必要で無い場合，サービスを異常終了します。

hyperv.selectVmCpuChangeプロパティおよびhyperv.selectVmMemoryChangeプロパティの設定を確認してください。サービスを実行するためには，どちらかに「yes」が選択されている必要があります。

2

仮想サーバの状態確認

仮想サーバの状態確認

階層フロー部品

仮想サーバの状態を調べ，仮想サーバが停止していなければユーザーに確認します。

−　

2-1

仮想サーバの状態取得

指定された仮想サーバの状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-2

値判定分岐部品

指定された仮想サーバが停止しているか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-3

階層フロー部品

ユーザーに仮想サーバを停止するか確認し，停止する場合は仮想サーバをシャットダウンします。

−　

2-3-1

ユーザー応答待ち部品

ユーザーに仮想サーバを停止するかユーザー応答待ちで確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-3-2

仮想サーバの状態取得

指定された仮想サーバの状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-3-3

値判定分岐部品

仮想サーバをシャットダウンする必要があるか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-3-4

仮想サーバのシャットダウン

仮想サーバをシャットダウンします。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

仮想サーバのスペック変更

仮想サーバのスペック変更

階層フロー部品

仮想サーバのスペックを変更します。

−　

3-1

値判定分岐部品

仮想サーバのメモリ設定の変更を実施するか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-2

仮想サーバのメモリ設定変更

仮想サーバのメモリ設定を変更します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-3

値判定分岐部品

仮想サーバのCPU設定の変更を実施するか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-4

仮想サーバのCPU設定変更

仮想サーバのCPU設定を変更します。

仮想サーバのCPUおよびメモリの設定が一部変更されている場合があります。タスクログを確認し，エラーの原因を取り除いたあと，サービスを再実行してください。

3.10.2　仮想サーバの削除

機能

このサービステンプレートは，Hyper-V環境の仮想サーバを削除します。

このサービステンプレートが前提とするサーバを次に示します。

・Hyper-Vサーバ

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

処理の概要を次に示します。

(1) 仮想サーバの状態を取得します。

(2) 仮想サーバが停止していることを確認します。

　仮想サーバが停止している場合は処理を継続しますが，それ以外の場合は，ユーザー応答待ち部品を実行して，シャットダウンするか・しないかを確認します。

　ユーザー応答待ちのGUIで"Shutdown"を選択した場合は，起動している仮想サーバをシャットダウンします。起動以外の仮想サーバに対して"Shutdown"を選択した場合は，仮想サーバには操作を行わずにタスクが異常終了します。

　"Cancel"を選択するか，応答待ちがタイムアウトになった場合は，仮想サーバには操作を行わずにタスクが異常終了します。

(3) 仮想サーバを削除します。

　Hyper-Vサーバから仮想サーバを削除します。このとき，スナップショットも併せて削除します。

　hyperv.vHardDiskDeletePermanentlyプロパティの選択リストで，"yes"を選択した場合，削除する仮想サーバに割り当てられているすべての仮想ディスクファイル(容量可変/容量固定/差分)を削除します。パススルー(物理)ディスク，フロッピーディスクまたはCD/DVDなどに割り当てられているディスクやファイルは削除しません。仮想ディスク(差分)が割り当てられている場合，仮想ディスク(差分)の親として使用する仮想ディスクは削除しません。

　仮想サーバの仮想ディスクファイルの削除に失敗した場合，ファイル削除処理を中断し，タスクは異常終了します。

(4) 仮想サーバの仮想ディスクファイルの一覧を出力します。

　hyperv.vhdListOutputFileNameRemoteプロパティとhyperv.vhdListOutputFileNameLocalプロパティを指定した場合，Hyper-Vサーバから削除する仮想サーバに割り当てられている仮想ディスクファイルのパス一覧をCSV形式で出力，ファイルをローカルに転送し，リモートのファイルは削除します。仮想ディスク(差分)が割り当てられている場合，仮想ディスク(差分)の親として使用する仮想ディスクは含まれません。

　hyperv.vhdListOutputFileNameRemoteプロパティだけを指定した場合，仮想ディスクファイルのパス一覧をCSV形式で出力しますが，ファイルをローカルに転送しません。

　出力するCSVファイルの項目を次に示します。

　項目はコンマ区切りで出力します。

　(a) 仮想ディスクファイルの有無 (ヘッダー名：Existence)

　　　仮想サーバの削除実行時に割り当てられている仮想ディスクファイルが存在するかどうかを出力します。項目の値を次に示します。

　　　　Found：ファイルの存在を確認

　　　　NotFound：ファイルが設定されているが，存在を確認できない

　(b) ファイルの削除結果 (ヘッダー名：DeleteResult)

　　　hyperv.vHardDiskDeletePermanentlyプロパティの選択リストで，"yes"を選択した場合，仮想ディスクファイルの削除の実行結果を出力します。hyperv.vHardDiskDeletePermanentlyプロパティの選択リストで，"no"を選択した場合でも"Skipped"を出力します。項目の値を次に示します。

　　　　Completed：ファイルの削除が成功

　　　　Failed：ファイルの削除が失敗

　　　　Skipped：ファイルの削除が未実施

　(c) ファイルのパス (ヘッダー名：FilePath)

　　　(a)(b)の内容に関わらず，Hyper-Vサーバで設定されている仮想ディスクファイルのパスを出力します。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2016 Hyper-V

【サービステンプレート実行システム内前提製品の稼働OS】

(1)Hyper-Vサーバの前提OS

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

(2)仮想サーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。

　・オペレーティングシステムのシャットダウン

注意事項

(1)同一の仮想サーバに対して，このサービスを複数同時に実行しないでください。

(2)仮想ディスクファイルのパスを仮想サーバの設定情報から参照できなくなるような操作(スナップショット操作など)を行った場合，その仮想ディスクファイルは削除されません。この場合は手動で削除してください。

(3)UserResponseplugin.dialogTextプロパティにHTMLタグを指定する場合，指定できるタグおよび属性はユーザー応答待ち部品と同じです。詳細については，本製品マニュアルの「ユーザー応答待ち部品」について説明しているトピックを参照してください。

(4)hyperv.vhdListOutputFileNameRemoteプロパティおよびhyperv.vhdListOutputFileNameLocalプロパティに指定するファイル名がすでに存在する場合，既存のファイルを上書きします。また，リモート側のファイルは削除します。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(5)hyperv.vhdListOutputFileNameRemoteプロパティに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

(6)hyperv.vhdListOutputFileNameRemoteプロパティを指定した場合，hyperv.vhdListOutputFileNameLocalプロパティを指定しない場合や，仮想サーバまたは仮想ディスクファイルの削除時にエラーが発生しても，リモート側にファイルを出力します。出力したファイルは削除せずに残ります。そのため，使用しない場合は削除してください。

(7)このサービスは，フェールオーバークラスターマネージャーのサービスとアプリケーションから仮想サーバの登録情報を削除しません。ユーザーの運用に合わせて手動で削除してください。

(8)ユーザー応答待ちのGUIで"Shutdown"を選択した場合は，仮想サーバのOSを強制的にシャットダウンします。仮想サーバで編集中のファイルデータは保存されません。

バージョン

03.00.00

タグ

Delete VM,Hyper-V 2016

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

Hyper-Vの情報を指定してください。

表示されます。

仮想サーバ情報

削除する仮想サーバの情報を指定してください。

表示されます。

出力ファイル格納情報

出力ファイルの格納先を必要に応じて指定してください。

表示されません。

ユーザー応答待ちオプション

仮想サーバが起動していた場合のユーザー応答のためのオプションです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.targetHost

Hyper-Vサーバのホスト名

Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

UserResponsePlugin.toAddress

TOメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(TO)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.ccAddress

CCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(CC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.bccAddress

BCCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(BCC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailSubject

メール件名

ユーザー応答待ちになった場合のメール通知のメールの件名を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailBody

メール本文

ユーザー応答待ちになった場合のメール通知のメール本文を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.encodeType

エンコード種別

ユーザー応答待ちになった場合のメール通知のエンコード種別を指定します。指定可能なエンコード名は次のとおりです。us-ascii，iso-2022-jp，shift_jis，euc-jp，utf-8。指定しなかった場合には，utf-8で送信されます。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.dialogText

応答入力画面の補足情報

ユーザー応答待ちになった場合の応答入力ダイアログに表示する補足情報を指定します。テキスト形式，またはHTML形式で指定できます。指定可能なHTMLタグは，アンカータグ，ボールドタグ，ブレークタグ，フォントタグ，イタリックタグ，下線タグです。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.responseTimeOut

応答タイムアウト時間(分)

ユーザー応答待ちになった場合の応答がタイムアウトする時間を分単位で指定します。応答タイムアウト時間が過ぎると，サービスが異常終了します。

入力

無効

○　

ユーザー応答待ちオプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

仮想サーバ情報

hyperv.vHardDiskDeletePermanently

仮想ディスクファイルの削除の要否

仮想サーバで使用している仮想ディスクファイルを削除するかどうか指定します。

入力

無効

○　

仮想サーバ情報

hyperv.vhdListOutputFileNameRemote

出力ファイル名(リモート)

仮想サーバが使用している仮想ディスクファイル一覧をHyper-Vサーバに出力する際の一時ファイル名をフルパスで指定します。

入力

無効

△　

出力ファイル格納情報

hyperv.vhdListOutputFileNameLocal

出力ファイル名(ローカル)

仮想ディスクファイル一覧をローカルサーバに格納する際のファイル名をフルパスで指定します。

入力

無効

△　

出力ファイル格納情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.targetHost

256文字以内の半角英数字および「.」，「-」。

UserResponsePlugin.toAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.ccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.bccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.mailSubject

256文字以内の文字列。

UserResponsePlugin.mailBody

1024文字以内の文字列。

UserResponsePlugin.encodeType

次の値のどれかを選択する。

us-ascii,iso-2022-jp,shift_jis,euc-jp,utf-8

UserResponsePlugin.dialogText

512文字以内の文字列。

UserResponsePlugin.responseTimeOut

1〜9999の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.vmName

100文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」，「¥」，「/」，「:」，先頭の「 (スペース)」および末尾の「 (スペース)」，「.」を除く。

hyperv.vHardDiskDeletePermanently

次の値のどれかを選択する。

yes,no

hyperv.vhdListOutputFileNameRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「'」，「[」，「]」，「`」および末尾の「¥」を除く。

hyperv.vhdListOutputFileNameLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの状態確認

仮想サーバの状態確認

階層フロー部品

仮想サーバの状態を調べ，仮想サーバが起動している場合はユーザーに確認します。

−　

1-2

仮想サーバの状態取得

指定した仮想サーバの状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-3

値判定分岐部品

仮想サーバが停止しているか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-4

階層フロー部品

ユーザーに仮想サーバを停止するか確認し，停止する場合は仮想サーバをシャットダウンします。

−　

1-4-1

ユーザー応答待ち部品

ユーザーに仮想サーバを停止するかユーザー応答待ちで確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-4-2

仮想サーバの状態取得

指定した仮想サーバの状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-4-3

値判定分岐部品

仮想サーバが停止しているか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-4-4

仮想サーバのシャットダウン

仮想サーバをシャットダウンします。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

仮想サーバの削除

仮想サーバの削除

仮想サーバの削除

仮想サーバを削除します。

仮想サーバが削除されていない場合は，エラーの原因を取り除いたあと，サービスを再実行してください。

仮想サーバが削除されている場合は，仮想ディスクファイルの有無を確認，または仮想ディスクファイル一覧を出力していればHyper-Vサーバでファイルを参照し，必要に応じ手動で仮想ディスクファイルを削除してください。

3

ファイル転送

ファイル転送

階層フロー部品

仮想ディスクファイル一覧を転送します。

−　

3-1

値判定分岐部品

仮想ディスクファイル一覧の出力ファイル名(リモート)が指定されているかチェックします。

仮想ディスクファイル一覧を出力していれば，Hyper-Vサーバに仮想ディスクファイル一覧が残っています。手動で削除してください。

3-2

階層フロー部品

仮想ディスクファイル一覧を転送します。

−　

3-2-1

値判定分岐部品

仮想ディスクファイル一覧の出力ファイル名(ローカル)が指定されているかチェックします。

仮想ディスクファイル一覧を出力していれば，Hyper-Vサーバに仮想ディスクファイル一覧が残っています。手動で削除してください。

3-2-2

階層フロー部品

仮想ディスクファイル一覧を転送します。

−　

3-2-2-1

ファイル転送部品

リモートの一時ファイルをローカルの指定された出力ファイルに転送します。

Hyper-Vサーバに仮想ディスクファイル一覧が残っています。手動で削除してください。

3-2-2-2

ファイル削除

リモートの一時ファイルを削除します。

Hyper-Vサーバに仮想ディスクファイル一覧が残っています。手動で削除してください。

3.10.3　仮想サーバの追加(デプロイ/OS初期設定)

機能

このサービステンプレートは，Hyper-V環境に，エクスポート済みの仮想サーバを用いて仮想サーバを追加します。

このサービステンプレートが前提とするサーバを次に示します。

・Hyper-Vサーバ

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

・エクスポート済みの仮想サーバ

　Hyper-Vからエクスポートされた仮想サーバ，およびその仮想サーバの構成ファイル一式です。

・格納サーバ

　複製元となる，エクスポート済みの仮想サーバを格納してあるサーバです。

処理の概要を次に示します。

(1) Hyper-Vサーバに仮想サーバを作成します。

　1. インポート先に，エクスポート済みの仮想サーバを複製します。

　2. Hyper-Vサーバに，インポート機能を用いて仮想サーバを作成します。

　　新規に作成する仮想サーバには，新しい一意なIDを作成します。

　　インポート先に指定したパスのフォルダがすでに存在する場合，そのフォルダを使用します。

(2) 仮想サーバの接続先仮想スイッチ(管理用)を設定します。

　ローカルサーバとの通信を確立するために，NICに仮想スイッチ(管理用)を設定します。

　エクスポート済みの仮想サーバに，すでに設定されている接続先仮想スイッチは，指定された仮想スイッチに上書きされます。

　1個目のNICには，ローカルサーバと通信可能な管理用の仮想スイッチを設定してください。2〜4個目のNICには管理用・業務用仮想スイッチをユーザーの運用に合わせて設定してください。

　指定した仮想スイッチの数が，仮想サーバが持つNICの数より多い場合，NICに割り当てられなかった仮想スイッチの設定は無効になります。

(3) OSカスタマイズ用の応答ファイルを作成し，配置します。

　1. 仮想サーバの仮想ディスクをHyper-Vサーバにマウントします。

　2. マウントした仮想ディスクにOSカスタマイズ用の応答ファイルを作成します。

　3. Hyper-Vサーバから仮想ディスクをアンマウントします。

(4) 仮想サーバを起動し，仮想サーバの初期情報を設定します。

　1. OSの初期情報を設定します(コンピュータ名，会社名など)。

　　OSの初期設定として，コンピュータ名，会社名，組織名，タイムゾーンを設定します。

　2. 仮想サーバのIPアドレスを設定します。

　　仮想サーバは最大4個までIPアドレスを設定することができます。1個目のIPアドレス(管理用)には，デプロイした仮想サーバを管理するためのIPアドレスを設定してください。2〜4個目のIPアドレス(2個目用)・IPアドレス(3個目用)・IPアドレス(4個目用)については，管理用・業務用IPアドレスをユーザーの運用に合わせて設定してください。一部の設定は管理用IPアドレスを使用してOSに接続し設定をします。仮想サーバが持つNICの数によってIPアドレスの設定順序は次のようになります。

　　・仮想サーバがNICを1個持つ場合

　　　NICには，IPアドレス(管理用)>IPアドレス(2個目用)>IPアドレス(3個目用)>IPアドレス(4個目用)の順で最初に指定されていたIPアドレスを設定します。その他のIPアドレスは破棄されますのでご注意ください。

　　・仮想サーバがNICを2個以上持つ場合

　　　NICには，IPアドレス(管理用)>IPアドレス(2個目用)>IPアドレス(3個目用)>IPアドレス(4個目用)の順でIPアドレスを設定します。IPアドレスの指定に空きがある場合，詰めて設定します。例えば，指定するIPアドレスがIPアドレス(管理用)，IPアドレス(2個目用)，IPアドレス(4個目用)の場合(IPアドレス(3個目用)がない場合)，IPアドレス(4個目用)は仮想マシンの3つ目のNICに設定します。入力したIPアドレスの数が，仮想サーバが持つNICの数より多い場合，超えた分のIPアドレスは破棄されますのでご注意ください。

(5) 仮想サーバの接続先仮想スイッチ(2〜4個目用)を設定します。

　エクスポート済みの仮想サーバに，すでに設定されている接続先仮想スイッチは，指定された仮想スイッチに上書きされます。

　1個目のNICには，ローカルサーバと通信可能な管理用の仮想スイッチを設定してください。2〜4個目のNICには管理用・業務用仮想スイッチをユーザーの運用に合わせて設定してください。

　指定した仮想スイッチの数が，仮想サーバが持つNICの数より多い場合，NICに割り当てられなかった仮想スイッチの設定は無効になります。

(6) 仮想サーバのOSに設定するIPアドレス(管理用)が指定され，かつ仮想サーバのIPアドレスが複数設定された場合に，スタティックルートを設定します。

(7) OS.selectWorkgroupDomainの選択リストで，DOMAINが選択され，かつドメイン名，ドメイン ユーザー名，ドメイン パスワードが指定されていた場合，ドメインへの参加処理を行います。

プロパティ設定の留意点を次に示します。

(1) OSユーザーパスワードとOSユーザーパスワード再入力は必須となります。どちらかの指定がない場合，"Password123"がパスワードに設定されます。また，2つの値が合致しない場合も"Password123"がパスワードに設定されます。

(2) OS.selectWorkgroupDomainの選択リストで，WORKGROUPを選択した場合，指定できるワークグループ名は最大15byteまでとなります。16byteを超えると"WORKGROUP"が設定されます。

(3) OS.selectWorkgroupDomainの選択リストで，DOMAINを選択した場合，ドメイン名，ドメイン ユーザー名，ドメイン パスワードが必須となります。どれかの指定がない場合，もしくはドメイン参加に失敗した場合，ワークグループとして"WORKGROUP"が設定されます。

(4) IPアドレス，サブネットマスクは，2つの情報をすべて指定してください。どれかの指定がない場合，IPアドレス，サブネットマスク，およびデフォルトゲートウェイの設定は行われません。

(5) 仮想スイッチの指定がない場合，仮想スイッチとの接続が切断された状態になります。

(6) スタティックルートの宛先IPアドレス，サブネットマスク，デフォルトゲートウェイは同時に指定してください。どれかの指定がない場合，スタティックルートの設定は行われません。

(7) 指定可能なタイムゾーンは次のとおりです。

　Tokyo Standard Time

　China Standard Time

　GMT Standard Time

　Pacific Standard Time

　Eastern Standard Time

　US Eastern Standard Time

　Central Standard Time

　Central America Standard Time

　US Mountain Standard Time

　Mountain Standard Time

　Alaskan Standard Time

　Hawaiian Standard Time

　Singapore Standard Time

　India Standard Time

指定がない場合，エクスポート済みの仮想サーバに設定されているタイムゾーンが引き継がれます。

(8) 指定可能なロケールは次のとおりです。

　ja-JP

　en-US

　zh-CN

(9) 指定可能なOS名は次のとおりです。

　Windows Server 2012

　Windows Server 2012 R2

　Windows Server 2016

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2016 Hyper-V

【サービステンプレート実行システム内前提製品の稼働OS】

(1)Hyper-Vサーバの前提OS

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

(2)仮想サーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)Hyper-Vサーバ上の設定に関する条件

　・仮想スイッチが設定済みであること。

　・仮想スイッチ名はHyper-Vサーバ内で一意であること。

　・デプロイに使用するエクスポート済みの仮想サーバが作成済みであること。

(2)デプロイに使用するエクスポート済みの仮想サーバに関する条件

　・Hyper-V 統合サービスの次のサービスが有効なこと。

　　①データ交換

　・Hyper-Vサーバからエクスポートする前に仮想サーバに次の設定が行われていること。

　　①Administratorユーザーのパスワードを空にしていること。

　　②ネットワーク設定を削除していること。

　　　仮想ホストのネットワークアダプタの情報を設定している場合は，次の設定個所を空にしてから，

　　　[IPアドレスを自動的に取得する]および[DNSサーバのアドレスを自動的に取得する]に設定すること。

　　　・IPアドレス

　　　・サブネットマスク

　　　・デフォルトゲートウェイ

　　　・優先DNSサーバ

　　　・代替DNSサーバ

　　③Sysprepを用いてOS情報が初期化されていること。

　　　その際，次のオプションを選択すること。

　　　[システム クリーンアップ アクション]プルダウンメニューから[システムのOOBE(Out-of-Box Experience)に入る]を選択する。

　　　[一般化する］チェックボックスをチェックする。

　・エージェントレス接続が可能な設定であること。

　・NICが設定してあること(最大4個まで)。

　　①仮想スイッチとの接続が切断された状態になっていること。

　・ファイアーウォールがICMP(ECHO)応答を許可していること。

　・格納サーバとHyper-Vサーバが別サーバの場合，Hyper-Vサーバからエクスポート済みの仮想サーバが格納されているフォルダに共有設定がされていること。

　・レガシーネットワークアダプターが設定されていないこと。

　・スナップショットおよび差分ディスクが作成されていないこと。

(3)仮想サーバに関する条件

　・仮想サーバ名はHyper-Vサーバ内で一意であること。

(4)本製品に関する条件

　・ローカルサーバ("localhost"で解決されるループバックアドレス)，Hyper-Vサーバおよびデプロイする仮想サーバのIPアドレス(管理用)を，「管理タブ」のエージェントレス接続定義に，事前に認証情報を登録してあること。

注意事項

(1)仮想スイッチの指定を省略すると，そのNICの接続先仮想スイッチ情報が削除され，接続されていない状態になります。仮想スイッチを設定する場合は，必ず指定してください。

(2)仮想サーバのOSに設定するIPアドレスについて，IPアドレスとして設定できない値は入力しないでください。例えば，ネットワークアドレスやブロードキャストアドレス，「0.0.0.0」や「255.255.255.255」などの特殊なアドレスは指定できません。入力した場合，仮想サーバのデプロイはエラーとなります。また，IPアドレス(管理用)には，ローカルサーバと通信できるIPアドレスを入力してください。正しいアドレスであっても，デプロイに失敗するおそれがあります。

(3)仮想サーバのデプロイ中は，ほかのサービスによって当該仮想サーバの操作を行わないでください。仮想サーバのデプロイに失敗するおそれがあります。Hyper-Vサーバからも直接操作を行わないでください。

(4)IPアドレスは「機能」に記載のとおり設定されますが，仮想サーバのOSにNICを設定した順番によっては，意図どおりIPアドレスが設定されない場合があるため，仮想サーバ作成後はIPアドレスが意図どおり設定されているか確認してください。もし設定されていない場合は，手動で変更してください。

(5)仮想サーバに設定するIPアドレスは，他のサーバと重複しないようにしてください。他のサーバとIPアドレスが重複していると，仮想サーバのNICが無効状態となり，タスクが異常終了する場合があります。

(6)エクスポート済みの仮想サーバには，仮想サーバ作成時に設定する情報をあらかじめ設定しないでください。コンピュータ名/ホスト名やIPアドレスがエクスポート済みの仮想サーバに設定されている場合，仮想サーバの作成に失敗する場合があります。失敗した場合(失敗の例としては，スタティックルートの処理でエラーが発生します。)，一度仮想サーバを削除し，コンピュータ名/ホスト名とIPアドレスが設定されていないエクスポート済みの仮想サーバを再作成のあと，このサービスを再実行してください。

(7)デプロイに失敗した場合，仮想サーバのOS初期設定およびIPアドレス設定に使用した応答ファイルが，仮想サーバのシステムドライブ内に削除されずに残る場合があります。タスクログを確認し応答ファイルを削除するか，仮想サーバを削除してください。

(8)インポート先に指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。

(9)インポート先に指定したパスのフォルダ内に仮想ディスクファイルが残っている場合は，タスクが異常終了します。インポート先に指定したパスのフォルダを確認し，仮想ディスクを削除するか，別のパスを指定してください。

(10)このサービスは，フェールオーバークラスターマネージャーのサービスとアプリケーションにデプロイした仮想サーバを登録しません。ユーザーの運用に合わせて手動で登録してください。

(11)仮想サーバの仮想ディスクをHyper-Vサーバへマウントする際に，Hyper-Vサーバ上の空きドライブ文字を一時的に占有します。そのため，Hyper-Vサーバ上に空きドライブ文字が存在しない場合は，仮想ディスクのマウント処理でエラーが発生し，タスクが異常終了します。エクスポート済みの仮想サーバの仮想ディスクが使用するドライブ分，Hyper-Vサーバ上にドライブ文字が空いていることを確認の上，このサービスを実行してください。

(12)エクスポート済みの仮想サーバの世代が第2世代の場合は，仮想サーバのシステムディスクが設定されているSCSIコントローラーの場所をhyperv.scsiDiskLocationに指定してください。hyperv.scsiDiskLocationとシステムディスクの場所が異なる場合，システムディスクの検索に時間がかかるため，デプロイの実行終了までの時間が長くなる場合があります。

(13)プロパティhyperv.osSettingWaitTimeの値はデフォルトを推奨します。ただし，プロパティに指定した待機処理時間が短いと，OS初期設定の完了前に次のステップが実行されて，タスクが異常終了する場合があります。

(14)sysprepでOSのシステム情報を初期化した仮想サーバを対象とした場合，仮想サーバに接続されているドライブのドライブ文字が変更される場合があります。そのため，デプロイした仮想サーバとテンプレートでは，接続されているドライブのドライブ文字が一致しない場合があります。また，ドライブ文字が変更されたドライブにアプリケーションがインストールされていた場合に，アプリケーションが正常に動作しなくなるおそれがあります。

実行権限

ビルトイン Administrator

バージョン

03.00.00

タグ

Add VM,Hyper-V 2016

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

Hyper-Vの情報を指定してください。

表示されます。

仮想サーバ情報

追加する仮想サーバの情報を指定してください。

表示されます。

OS情報

仮想サーバに設定するOS情報を指定してください。

表示されます。

ネットワーク情報

仮想サーバのネットワーク情報を指定してください。

表示されます。

実行時オプション

仮想サーバのOS初期設定を行う際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.targetHost

Hyper-Vサーバのホスト名

Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

hyperv.userName

格納サーバに接続するためのユーザー名

格納サーバに接続するためのユーザー名を指定します。格納サーバがHyper-Vサーバと別サーバの場合は指定してください。

入力

無効

△　

仮想サーバ情報

hyperv.password

格納サーバに接続するためのパスワード

格納サーバに接続するためのパスワードを指定します。格納サーバがHyper-Vサーバと別サーバの場合は指定してください。

入力

無効

△　

仮想サーバ情報

windows.orgName

組織名(会社名)

仮想サーバのOSに設定する組織名を指定します。

入力

無効

○　

OS情報

windows.ownerName

名前(所有者名)

仮想サーバのOSに設定する名前(所有者名)を指定します。

入力

無効

○　

OS情報

OS.selectWorkgroupDomain

ワークグループ/ドメインの選択

仮想サーバがワークグループまたはドメインのどちらに所属するかを指定します。

入力

無効

○　

OS情報

OS.workgroupNameDomainName

ワークグループ名/ドメイン名

仮想サーバが所属するワークグループ名/ドメイン名を指定します。ワークグループ名は，最大15文字まで指定します。ドメイン名は，最大63文字まで指定します。

入力

無効

○　

OS情報

OS.domainUserName

ドメインのユーザー名

仮想サーバが所属するドメインのユーザー名を指定します。ワークグループ/ドメインの選択で「DOMAIN」を選択した場合，入力する必要があります。

入力

無効

△　

OS情報

OS.domainUserPassword

ドメインのパスワード

仮想サーバが所属するドメインのパスワードを指定します。ワークグループ/ドメインの選択で「DOMAIN」を選択した場合，入力する必要があります。

入力

無効

△　

OS情報

OS.subnetMaskMan

サブネットマスク(管理用)

仮想サーバに設定する管理用LANのサブネットマスクを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.defaultGWMan

デフォルトゲートウェイ(管理用)

仮想サーバに設定する管理用LANのデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.dnsMan

DNSサーバのIPアドレス(管理用)

仮想サーバに設定する管理用LANのDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

hyperv.virtualSwitchMan

仮想スイッチ名(管理用)

仮想サーバに設定されているNIC(管理用)に設定する仮想スイッチ名(管理用)を指定します。

入力

無効

△　

ネットワーク情報

OS.subnetMask2

サブネットマスク(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.defaultGW2

デフォルトゲートウェイ(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.dns2

DNSサーバのIPアドレス(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

hyperv.virtualSwitch2

仮想スイッチ名(2個目用)

仮想サーバに設定されているNIC(2個目用)に設定する仮想スイッチ名(2個目用)を指定します。

入力

無効

△　

ネットワーク情報

OS.subnetMask3

サブネットマスク(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.defaultGW3

デフォルトゲートウェイ(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.dns3

DNSサーバのIPアドレス(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

hyperv.virtualSwitch3

仮想スイッチ名(3個目用)

仮想サーバに設定されているNIC(3個目用)に設定する仮想スイッチ名(3個目用)を指定します。

入力

無効

△　

ネットワーク情報

OS.subnetMask4

サブネットマスク(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.defaultGW4

デフォルトゲートウェイ(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.dns4

DNSサーバのIPアドレス(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

hyperv.virtualSwitch4

仮想スイッチ名(4個目用)

仮想サーバに設定されているNIC(4個目用)に設定する仮想スイッチ名(4個目用)を指定します。

入力

無効

△　

ネットワーク情報

OS.destIPAddress

スタティックルートの宛先IPアドレス

スタティックルートの宛先IPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.subnetMaskStaticRoute

サブネットマスク(スタティックルート用)

スタティックルート用のサブネットマスクを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.defaultGWStaticRoute

デフォルトゲートウェイ(スタティックルート用)

スタティックルート用のデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

hyperv.scsiDiskLocation

SCSIコントローラーの場所

システムディスクを設定しているSCSIコントローラーの場所を指定します。このプロパティはエクスポート済みの仮想サーバの世代が第2世代の場合だけ有効です。

入力

無効

○　

実行時オプション

hyperv.osSettingWaitTime

OS初期設定の待機処理時間

OSの初期設定が完了するまでの待機時間を秒単位で指定します。

入力

無効

○　

実行時オプション

common.icmpEchoTimeout

ICMPエコー要求のタイムアウト時間

ネットワーク接続確認を実行する場合，仮想サーバの起動後に実行する，ICMPエコー要求に対する応答を待つ時間をミリ秒単位で指定します。

入力

無効

○　

実行時オプション

hyperv.checkVmStateEnabledCount

仮想サーバの状態(起動完了)の確認回数

仮想サーバの起動が完了したか確認する際の確認回数を指定します。仮想サーバの状態(起動完了)の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

hyperv.checkVmStateEnabledInterval

仮想サーバの状態(起動完了)の確認間隔

仮想サーバの起動が完了したか確認する際の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

hyperv.checkJobStateCountGetDriveList

ジョブ監視回数(Win32_LogicalDiskメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(Win32_LogicalDiskメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

hyperv.checkJobStateIntervalGetDriveList

ジョブ監視間隔(Win32_LogicalDiskメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(Win32_LogicalDiskメソッド)調整用のプロパティです。変更の必要はありません。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

仮想サーバ情報

hyperv.exportedVmName

エクスポート済みの仮想サーバのフォルダのパス

仮想サーバの複製元となるエクスポート済みの仮想サーバのフォルダ名をフルパスで指定します。格納サーバがHyper-Vサーバと別サーバの場合，UNCを指定してください。

入力

無効

○　

仮想サーバ情報

hyperv.importFolderPath

インポート先

仮想サーバを格納するフォルダをフルパスで指定します。

入力

無効

○　

仮想サーバ情報

windows.operatingSystem

OS名

仮想サーバのOS名を指定します。

入力

無効

○　

仮想サーバ情報

OS.computerName

コンピュータ名/ホスト名

OSのコンピュータ名(ホスト名)を指定します。

入力

無効

○　

OS情報

OS.osUserPassword

Administratorのパスワード

OSに設定するAdministratorのパスワードを指定します。入力がない場合は，"Password123"が設定されます。

入力

無効

△　

OS情報

OS.osUserPasswordReEnter

Administratorのパスワード再入力

OSに設定するAdministratorのパスワードを再入力してください。入力がない場合は，"Password123"が設定されます。

入力

無効

△　

OS情報

OS.productKey

OSのプロダクトキー

OSのプロダクトキーを指定します。入力の形式は「XXXXX-XXXXX-XXXXX-XXXXX-XXXXX」です。

入力

無効

△　

OS情報

OS.ipAddressMan

IPアドレス(管理用)

仮想サーバに設定する管理用LANのIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.ipAddress2

IPアドレス(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.ipAddress3

IPアドレス(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.ipAddress4

IPアドレス(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.timeZoneWin

タイムゾーン

仮想サーバのOSに設定するタイムゾーンを指定します。

入力

無効

△　

OS情報

OS.systemLocale

システムロケール

仮想サーバのOSに設定されているシステムロケールを指定します。

入力

無効

○　

OS情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.targetHost

256文字以内の半角英数字および「.」，「-」。

hyperv.userName

20文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「¥」，「@」，「%」を除く。

hyperv.password

127文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

windows.orgName

256文字以内の文字列。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

windows.ownerName

256文字以内の文字列。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

OS.selectWorkgroupDomain

次の値のどれかを選択する。

WORKGROUP,DOMAIN

OS.workgroupNameDomainName

63文字以内の半角英数字。および「-」，「.」。

OS.domainUserName

20文字以内の半角英数字。および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「¥」，「@」，「%」を除く。

OS.domainUserPassword

127文字以内の半角英数字。および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

OS.subnetMaskMan

15文字以内の半角数字および「.」。

OS.defaultGWMan

15文字以内の半角数字および「.」。

OS.dnsMan

15文字以内の半角数字および「.」。

hyperv.virtualSwitchMan

63文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

OS.subnetMask2

15文字以内の半角数字および「.」。

OS.defaultGW2

15文字以内の半角数字および「.」。

OS.dns2

15文字以内の半角数字および「.」。

hyperv.virtualSwitch2

63文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

OS.subnetMask3

15文字以内の半角数字および「.」。

OS.defaultGW3

15文字以内の半角数字および「.」。

OS.dns3

15文字以内の半角数字および「.」。

hyperv.virtualSwitch3

63文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

OS.subnetMask4

15文字以内の半角数字および「.」。

OS.defaultGW4

15文字以内の半角数字および「.」。

OS.dns4

15文字以内の半角数字および「.」。

hyperv.virtualSwitch4

63文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

OS.destIPAddress

15文字以内の半角数字および「.」。

OS.subnetMaskStaticRoute

15文字以内の半角数字および「.」。

OS.defaultGWStaticRoute

15文字以内の半角数字および「.」。

hyperv.scsiDiskLocation

0〜63の整数値。

hyperv.osSettingWaitTime

0〜2147483647の整数値。

common.icmpEchoTimeout

1〜2147483647の整数値。

hyperv.checkVmStateEnabledCount

1〜2147483647の整数値。

hyperv.checkVmStateEnabledInterval

1〜60の整数値。

hyperv.checkJobStateCountGetDriveList

1〜2147483647の整数値。

hyperv.checkJobStateIntervalGetDriveList

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.vmName

100文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」，「¥」，「/」，「:」，先頭の「 (スペース)」および末尾の「 (スペース)」，「.」を除く。

hyperv.exportedVmName

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「'」，「[」，「]」，「`」および末尾の「¥」を除く。

hyperv.importFolderPath

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「'」，「[」，「]」，「`」および末尾の「¥」を除く。

windows.operatingSystem

次の値のどれかを選択する。

Windows Server 2012,Windows Server 2012 R2,Windows Server 2016

OS.computerName

15文字以内の半角英数字および「-」。

OS.osUserPassword

64文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.osUserPasswordReEnter

64文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「`」および末尾の「¥」を除く。UNIX環境に対してこのサービスを実行する場合はマルチバイト文字も除く。

OS.productKey

29文字以内の半角英数字，および「-」。

OS.ipAddressMan

15文字以内の半角数字および「.」。

OS.ipAddress2

15文字以内の半角数字および「.」。

OS.ipAddress3

15文字以内の半角数字および「.」。

OS.ipAddress4

15文字以内の半角数字および「.」。

OS.timeZoneWin

次の値のどれかを選択する。

Tokyo Standard Time, China Standard Time, GMT Standard Time, Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Central Standard Time, Central America Standard Time, US Mountain Standard Time, Mountain Standard Time, Alaskan Standard Time, Hawaiian Standard Time, Singapore Standard Time, India Standard Time

OS.systemLocale

次の値のどれかを選択する。

ja-JP,en-US,zh-CN

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの作成

仮想サーバの作成

仮想サーバの作成

Hyper-V環境において，エクスポート済みの仮想サーバから仮想サーバを作成します。

タスクログを確認し，エラーの原因を取り除いたあと，サービスを再実行してください。

Hyper-Vサーバに仮想サーバが作成されている場合は，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

2

仮想サーバの仮想スイッチ設定(管理用)

仮想サーバの仮想スイッチ設定(管理用)

仮想サーバの仮想スイッチ設定

ローカルサーバとの通信を確立するために，仮想スイッチを設定します。

タスクログを確認し，エラーの原因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

3

応答ファイルの配置

応答ファイルの配置

階層フロー部品

仮想サーバに応答ファイルを配置します。

−　

3-1

仮想ディスクのマウント

Hyper-Vサーバに仮想ディスクをマウントします。

タスクログを確認し，エラーの原因を取り除いたあと，Hyper-Vサーバに仮想ディスクがマウントされている場合は，手動でアンマウントしてください。その後，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

3-2

応答ファイル作成

Hyper-V環境の仮想サーバに対してOSの初期設定，およびIPアドレス設定を行うための応答ファイルを作成します。

タスクログを確認し，エラーの原因を取り除いたあと，Hyper-Vサーバに仮想ディスクがマウントされている場合は，手動でアンマウントしてください。その後，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

3-3

仮想ディスクのアンマウント

Hyper-Vサーバから仮想ディスクをアンマウントします。

タスクログを確認し，エラーの原因を取り除いたあと，Hyper-Vサーバに仮想ディスクがマウントされている場合は，手動でアンマウントしてください。その後，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

4

OS初期設定&IPアドレス設定

OS初期設定&IPアドレス設定

階層フロー部品

仮想サーバのOS初期設定(コンピュータ名，会社名，組織名)とIPアドレス設定を行い，仮想サーバを起動します。

−　

4-1

仮想サーバの起動

Hyper-V環境において，仮想サーバを起動します。

タスクログを確認し，エラーの原因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

4-2

実行待機

OS初期設定の待機時間が必要である場合に待機処理を実施します。

タスクログを確認し，エラーの原因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

4-3

値判定分岐部品

NICにIPアドレスが設定されているか判定します。

タスクログを確認し，エラーの原因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

4-4

階層フロー部品

ローカルサーバと仮想サーバのネットワーク接続を確認し，2〜4個目のNICにIPアドレスを設定します。

−　

4-4-1

ICMPエコー要求メッセージの送信

電源状態がONになった仮想サーバにICMPエコー要求を発行します。

タスクログを確認し，エラーの原因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

4-4-2

値判定分岐部品

2〜4個目のNICの設定が必要か判定します。

タスクログを確認し，エラーの原因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

4-4-3

階層フロー部品

2〜4個目のNICの設定を行います。

−　

4-4-3-1

NICのMACアドレス取得

管理用NICのMACアドレスを取得します。

タスクログを確認し，エラーの原因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

4-4-3-2

仮想サーバの仮想スイッチ設定

2〜4個目のNICと仮想スイッチの接続を切断します。

タスクログを確認し，エラーの原因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

4-4-3-3

Windowsネットワークの設定

2〜4個目のNICにIPアドレスを設定します。

Hyper-Vサーバにログインし，仮想サーバの設定を確認してください。その後，仮想サーバにログインし，仮想サーバの設定を確認してください。必要に応じて仮想サーバの設定を手動で行ってください。もしくは，タスクログを確認し，エラーの要因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

5

仮想サーバの仮想スイッチ設定(2〜4個目用)

仮想サーバの仮想スイッチ設定(2〜4個目用)

階層フロー部品

2〜4個目のNICに仮想スイッチを設定します。

−　

5-1

値判定分岐部品

NICにIPアドレスが設定されているか判定します。

Hyper-Vサーバにログインし，仮想サーバの設定を確認してください。その後，仮想サーバにログインし，仮想サーバの設定を確認してください。必要に応じて仮想サーバの設定を手動で行ってください。もしくは，タスクログを確認し，エラーの要因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

5-2

階層フロー部品

2〜4個目のNICに仮想スイッチを設定します。

−　

5-2-1

値判定分岐部品

2〜4個目のNICの設定が必要か判定します。

Hyper-Vサーバにログインし，仮想サーバの設定を確認してください。その後，仮想サーバにログインし，仮想サーバの設定を確認してください。必要に応じて仮想サーバの設定を手動で行ってください。もしくは，タスクログを確認し，エラーの要因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

5-2-2

階層フロー部品

2〜4個目のNICに仮想スイッチを設定します。

−　

5-2-2-1

NICのMACアドレス取得

2〜4個目のNICのMACアドレスを取得します。

Hyper-Vサーバにログインし，仮想サーバの設定を確認してください。その後，仮想サーバにログインし，仮想サーバの設定を確認してください。必要に応じて仮想サーバの設定を手動で行ってください。もしくは，タスクログを確認し，エラーの要因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

5-2-2-2

仮想サーバの仮想スイッチ設定

2〜4個目のNICに仮想スイッチを設定します。

Hyper-Vサーバにログインし，仮想サーバの設定を確認してください。その後，仮想サーバにログインし，仮想サーバの設定を確認してください。必要に応じて仮想サーバの設定を手動で行ってください。もしくは，タスクログを確認し，エラーの要因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

5-3

値判定分岐部品

NICにIPアドレスが設定されているか判定します。

Hyper-Vサーバにログインし，仮想サーバの設定を確認してください。その後，仮想サーバにログインし，仮想サーバの設定を確認してください。必要に応じて仮想サーバの設定を手動で行ってください。もしくは，タスクログを確認し，エラーの要因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

5-4

仮想サーバの仮想スイッチ設定

2〜4個目のNICに仮想スイッチを設定します。

Hyper-Vサーバにログインし，仮想サーバの設定を確認してください。その後，仮想サーバにログインし，仮想サーバの設定を確認してください。必要に応じて仮想サーバの設定を手動で行ってください。もしくは，タスクログを確認し，エラーの要因を取り除いたあと，仮想サーバおよび仮想サーバに設定されている仮想ディスクを削除し，このサービスを再実行してください。

6

OSスタティックルート設定

OSスタティックルート設定

階層フロー部品

仮想サーバのOSで，スタティックルートを設定します。

−　

6-1

値判定分岐部品

仮想サーバに複数のNICが設定されているか判定します。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

6-2

階層フロー部品

仮想サーバのOSで，複数のIPアドレスが設定されていることを確認します。

−　

6-2-1

値判定分岐部品

仮想サーバのOSで，複数のIPアドレスが設定されているか判定します。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

6-2-2

階層フロー部品

仮想サーバのOSで，管理用IPアドレスが設定されていることを確認します。

−　

6-2-2-1

値判定分岐部品

仮想サーバのOSで，管理用IPアドレスが設定されているか判定します。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

6-2-2-2

スタティックルートの設定

仮想サーバのOSで，スタティックルートを設定します。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

7

ドメインへの参加

ドメインへの参加

階層フロー部品

ドメインへの参加処理を行います。

−　

7-1

値判定分岐部品

仮想サーバのOSで，管理用IPアドレスが設定されているか判定します。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

7-2

階層フロー部品

ドメインへの参加処理を行います。

−　

7-2-1

値判定分岐部品

ドメインへの参加処理が必要か判定します。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

7-2-2

階層フロー部品

ドメインへの参加処理の成否を確認します。

−　

7-2-2-1

Windowsネットワークの設定

ドメインへの参加処理を行います。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

7-2-2-2

値判定分岐部品

ドメインへの参加処理の成否を判定します。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

7-2-2-3

階層フロー部品

Hyper-V環境において，仮想サーバを再起動します。

−　

7-2-2-3-1

仮想サーバのシャットダウン

Hyper-V環境において，仮想サーバをシャットダウンします。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

7-2-2-3-2

仮想サーバの起動

Hyper-V環境において，仮想サーバを起動します。

タスクログを確認し，仮想サーバにログインしてエラーの要因を取り除いてください。必要に応じて仮想サーバの設定を手動で行ってください。

3.10.4　仮想サーバの追加(仮想ディスク)

機能

このサービステンプレートは，Hyper-V環境に仮想ディスクを作成し，仮想サーバに作成した仮想ディスクを追加します。

このサービステンプレートが前提とするサーバを次に示します。

・Hyper-Vサーバ

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

処理の概要を次に示します。

(1) 仮想サーバの状態を取得します。

(2) 仮想サーバが停止していることを確認します。

　仮想サーバが停止している場合は処理を継続しますが，それ以外の場合は，ユーザー応答待ち部品を実行して，シャットダウンするか・しないかを確認します。

　ユーザー応答待ちのGUIで"Shutdown"を選択した場合は，起動している仮想サーバをシャットダウンします。起動以外の仮想サーバに対して"Shutdown"を選択した場合は，仮想サーバには操作を行わずにタスクが異常終了します。

　"Cancel"を選択するか，応答待ちがタイムアウトになった場合は，仮想サーバには操作を行わずにタスクが異常終了します。

(3) Hyper-V環境に仮想ディスクファイルを作成します。

　作成できる仮想ディスクは「Dynamic(容量可変)」または「Fixed(容量固定)」です。仮想ディスク(差分)およびパススルー(物理)ディスクは作成できません。

　hyperv.vHardDiskFolderPathプロパティを指定した場合に，指定したフォルダパスに仮想ディスクファイルを新規に作成します。指定が無い場合は，Hyper-Vサーバに設定されている仮想ディスクを保存する既定のフォルダに仮想ディスクを保存します。

　新規に作成する仮想ディスクを保存するフォルダパスが存在しない場合はフォルダを作成します。

(4) 仮想サーバに仮想ディスクを接続します。

　仮想ディスクは，SCSIコントローラーに追加できますが，IDEコントローラーには追加できません。

　SCSIコントローラーの番号(hyperv.scsiControllerNumberプロパティ)とSCSIコントローラーの場所番号(hyperv.scsiLocationNumberプロパティ)の指定の有無により，SCSIコントローラーへの仮想ディスクの接続方法が異なります。

　・SCSIコントローラーの番号とSCSIコントローラーの場所番号が両方指定されていない場合

　　接続可能なSCSIコントローラーにHyper-Vサーバが自動的に仮想ディスクを接続します。

　・SCSIコントローラーの番号だけ指定されている場合

　　指定したSCSIコントローラーの番号で接続可能なSCSIコントローラーの場所番号(0〜63)のどれかにHyper-Vサーバが自動的に仮想ディスクを接続します。

　・SCSIコントローラーの場所番号だけ指定されている場合

　　指定したSCSIコントローラーの場所番号で接続可能なSCSIコントローラーの番号(0〜3)のどれかにHyper-Vサーバが自動的に仮想ディスクを接続します。

　・SCSIコントローラーの番号とSCSIコントローラーの場所番号が両方指定されている場合

　　指定したSCSIコントローラーの番号とSCSIコントローラーの場所番号に仮想ディスクを接続します。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2016 Hyper-V

【サービステンプレート実行システム内前提製品の稼働OS】

(1)Hyper-Vサーバの前提OS

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

(2)仮想サーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。

　・オペレーティングシステムのシャットダウン

(3)仮想サーバに接続可能なSCSIコントローラーが存在すること。

注意事項

(1)このサービステンプレートでは仮想サーバに追加した仮想ディスクの初期化は行いません。必要に応じて仮想サーバのOSにログインし，ディスクの初期化を実行してください。

(2)同一の仮想サーバに対して，このサービスを複数同時に実行しないでください。

(3)UserResponseplugin.dialogTextプロパティにHTMLタグを指定する場合，指定できるタグおよび属性はユーザー応答待ち部品と同じです。詳細については，本製品マニュアルの「ユーザー応答待ち部品」について説明しているトピックを参照してください。

(4)Hyper-Vサーバに作成済みの仮想ディスクファイルは追加できません。

(5)ユーザー応答待ちのGUIで"Shutdown"を選択した場合は，仮想サーバのOSを強制的にシャットダウンします。仮想サーバで編集中のファイルデータは保存されません。

(6)指定したSCSIコントローラーの番号とSCSIコントローラーの場所番号が既に他の仮想ディスクの接続先として使用されている場合は，タスクが異常終了します。

(7)第2世代の仮想サーバにはVHDXファイルの仮想ディスクだけ追加できます。作成したVHDファイルを第2世代の仮想サーバに接続する場合，タスクが異常終了します。

バージョン

03.00.00

タグ

Modify VM,Hyper-V 2016

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

Hyper-Vの情報を指定してください。

表示されます。

仮想サーバ情報

仮想ディスクを追加する仮想サーバの情報を指定してください。

表示されます。

仮想ディスク情報

作成する仮想ディスクの情報を指定してください。

表示されます。

仮想ディスク接続情報

仮想ディスクを接続するSCSIコントローラーの情報を指定してください。接続するSCSIコントローラーを指定したい場合だけ指定してください。

表示されません。

ユーザー応答待ちオプション

仮想サーバが起動していた場合のユーザー応答のためのオプションです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.targetHost

Hyper-Vサーバのホスト名

Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

UserResponsePlugin.toAddress

TOメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(TO)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.ccAddress

CCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(CC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.bccAddress

BCCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(BCC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailSubject

メール件名

ユーザー応答待ちになった場合のメール通知のメールの件名を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailBody

メール本文

ユーザー応答待ちになった場合のメール通知のメール本文を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.encodeType

エンコード種別

ユーザー応答待ちになった場合のメール通知のエンコード種別を指定します。指定可能なエンコード名は次のとおりです。us-ascii，iso-2022-jp，shift_jis，euc-jp，utf-8。指定しなかった場合には，utf-8で送信されます。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.dialogText

応答入力画面の補足情報

ユーザー応答待ちになった場合の応答入力ダイアログに表示する補足情報を指定します。テキスト形式，またはHTML形式で指定できます。指定可能なHTMLタグは，アンカータグ，ボールドタグ，ブレークタグ，フォントタグ，イタリックタグ，下線タグです。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.responseTimeOut

応答タイムアウト時間(分)

ユーザー応答待ちになった場合の応答がタイムアウトする時間を分単位で指定します。応答タイムアウト時間が過ぎると，サービスが異常終了します。

入力

無効

○　

ユーザー応答待ちオプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

仮想サーバ情報

hyperv.vHardDiskName

仮想ディスクファイル名

作成する仮想ディスクのファイル名を指定してください。ファイルの拡張子には「vhd」または「vhdx」を指定してください。

入力

無効

○　

仮想ディスク情報

hyperv.vHardDiskFolderPath

仮想ディスク保存フォルダパス

作成する仮想ディスクを保存するフォルダのフルパスを指定してください。指定を省略した場合は，Hyper-Vサーバに設定されている仮想ディスクを保存する既定のフォルダに仮想ディスクを保存します。

入力

無効

△　

仮想ディスク情報

hyperv.vHardDiskType

仮想ディスクのタイプ

仮想ディスクのタイプを指定します。次のどちらかを指定します。Dynamic:容量可変の仮想ディスクを作成します。Fixed:容量固定の仮想ディスクを作成します。

入力

無効

○　

仮想ディスク情報

hyperv.capacity

容量 (GB)

仮想ディスクの容量をGB単位で指定します。

入力

無効

○　

仮想ディスク情報

hyperv.scsiControllerNumber

SCSIコントローラーの番号

仮想ディスクを追加する仮想サーバのSCSIコントローラーの番号を指定します。SCSIコントローラーの番号は，仮想サーバにSCSIコントローラーを追加した(Hyper-V マネージャーで表示する)順番を0から相対する整数値で指定してください。

入力

無効

△　

仮想ディスク接続情報

hyperv.scsiLocationNumber

SCSIコントローラーの場所番号

仮想ディスクを追加する仮想サーバのSCSIコントローラーの場所番号を指定します。SCSIコントローラーの場所番号は，仮想サーバに追加したSCSIコントローラーの未使用の場所を整数値で指定してください。

入力

無効

△　

仮想ディスク接続情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

hyperv.attachScsiControllerNumber

接続済みSCSIコントローラーの番号

仮想ディスクファイルを接続したSCSIコントローラーの番号を出力します。

出力

無効

hyperv.attachScsiLocationNumber

接続済みSCSIコントローラーの場所番号

仮想ディスクファイルを接続したSCSIコントローラーの場所番号を出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.targetHost

256文字以内の半角英数字および「.」，「-」。

UserResponsePlugin.toAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.ccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.bccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.mailSubject

256文字以内の文字列。

UserResponsePlugin.mailBody

1024文字以内の文字列。

UserResponsePlugin.encodeType

次の値のどれかを選択する。

us-ascii,iso-2022-jp,shift_jis,euc-jp,utf-8

UserResponsePlugin.dialogText

512文字以内の文字列。

UserResponsePlugin.responseTimeOut

1〜9999の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.vmName

100文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」，「¥」，「/」，「:」，先頭の「 (スペース)」および末尾の「 (スペース)」，「.」を除く。

hyperv.vHardDiskName

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「'」，「[」，「]」，「`」，「:」，「¥」を除く。

hyperv.vHardDiskFolderPath

247文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「'」，「[」，「]」，「`」および末尾の「¥」を除く。

hyperv.vHardDiskType

次の値のどれかを選択する。

Dynamic,Fixed

hyperv.capacity

1以上の整数値。

hyperv.scsiControllerNumber

次の値のどれかを選択する。

0,1,2,3

hyperv.scsiLocationNumber

0以上63以下の整数値。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの状態確認

仮想サーバの状態確認

階層フロー部品

仮想サーバの状態を調べ，仮想サーバが起動している場合はユーザーに確認します。

−　

1-2

仮想サーバの状態取得

指定した仮想サーバの状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-3

値判定分岐部品

仮想サーバが停止しているか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-4

階層フロー部品

ユーザーに仮想サーバを停止するか確認し，停止する場合は仮想サーバをシャットダウンします。

−　

1-4-1

ユーザー応答待ち部品

ユーザーに仮想サーバを停止するかユーザー応答待ちで確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-4-2

仮想サーバの状態取得

指定した仮想サーバの状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-4-3

値判定分岐部品

仮想サーバが停止しているか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

1-4-4

仮想サーバのシャットダウン

仮想サーバをシャットダウンします。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

仮想ディスクの作成

仮想ディスクの作成

仮想ディスクの作成

仮想ディスクを作成します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

仮想ディスクの接続

仮想ディスクの接続

仮想ディスクの接続

仮想サーバに仮想ディスクを接続します。

エラーが発生した場合は，作成した仮想ディスクをHyper-Vサーバ上で直接接続するか，仮想ディスクを削除したあと，エラー原因を取り除いて，サービスを再実行してください。

3.11　Hyper-V 2016（運用）用のサービステンプレート

3.11.1　仮想サーバの起動

機能

このサービステンプレートは，Hyper-V環境の複数の仮想サーバを起動します。

このサービステンプレートが前提とするサーバを次に示します。

・Hyper-Vサーバ

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

処理の概要を次に示します。

(1) 仮想サーバの状態を取得します。

(2) 仮想サーバが停止している場合に，仮想サーバを起動します。仮想サーバが起動している場合は，仮想サーバを起動する処理をスキップします。仮想サーバが起動および停止している以外の場合は，該当する仮想サーバの処理がエラーとなります。

(3) ネットワーク接続確認を実施する場合は，起動した仮想サーバに設定されているIPアドレス(IPv4)を取得したのち，ローカルサーバから起動した仮想サーバに対してICMPエコー要求を送信し，ネットワーク接続を確認します。

上記の処理を，指定された仮想サーバ群に対して並列に実行します。

仮想サーバを起動する際には，hyperv.checkVmStateEnabledIntervalプロパティに指定した秒数待ち合わせ，仮想サーバの状態を確認する動作を，hyperv.checkVmStateEnabledCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2016 Hyper-V

【サービステンプレート実行システム内前提製品の稼働OS】

(1)Hyper-Vサーバの前提OS

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

(2)仮想サーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。

　・データ交換

(3)ネットワーク接続確認を実行する場合，エージェントレス接続先としてローカルサーバ("localhost"で解決されるループバックアドレス)を設定する必要があります。

(4)ネットワーク接続確認を実行する場合，対象となる仮想サーバのファイアーウォールがICMP(ECHO)応答を許可していること。

注意事項

(1)ネットワーク接続確認を実施する場合は，システム環境によって，仮想サーバの起動直後にすべてのIPアドレスが取得できない場合があります。そのため，仮想サーバが起動しているにも関わらず，osSendIcmp部品で仮想サーバに設定されたすべてのIPアドレス(IPv4)でネットワークの接続確認が出来ずにタスクが異常終了する場合があります。仮想サーバの起動からIPアドレス取得開始までの待機時間を指定するhyperv.waitTimeプロパティの秒数を指定して，すべてのIPアドレスが取得できるように調節してください。

(2)ネットワーク接続確認を実施する場合は，仮想サーバのすべてのNICに設定されているIPアドレス(IPv4)の長さの合計を1024文字以内(※1)にして設定してください。IPアドレス(IPv4)の長さの合計が1024文字を超えると，osSendIcmp部品でエラーが発生し，タスクが異常終了する場合があります。

※IPアドレス(IPv4)1つの最大の長さは16文字(IPアドレス連結用の「,(コンマ)」を含む)。

(3)ネットワーク接続確認を実行する場合，common.icmpEchoTimeoutプロパティは利用している環境に応じて調整してください。

実行権限

ビルトイン Administrator

バージョン

03.00.00

タグ

Control VM,Hyper-V 2016

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

Hyper-Vの情報を指定してください。

表示されます。

仮想サーバ情報

起動する仮想サーバの情報を指定してください。

表示されます。

ネットワーク接続確認

仮想サーバを起動したあとのネットワーク接続確認に関するプロパティです。必要に応じて変更してください。

表示されません。

実行時オプション

仮想サーバを起動する際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.targetHost

Hyper-Vサーバのホスト名

Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

hyperv.waitTime

IPアドレス取得開始までの待機時間

ネットワーク接続確認を実行する場合，仮想サーバの起動が完了してからIPアドレス取得を開始するまでの待機時間を秒単位で指定します。

入力

無効

○　

ネットワーク接続確認

common.icmpEchoTimeout

ICMPエコー要求のタイムアウト時間

仮想サーバの起動確認で実施する，ICMPエコー要求に対する応答を待つ時間をミリ秒単位で指定します。

入力

無効

○　

ネットワーク接続確認

hyperv.checkVmStateEnabledCount

仮想サーバの状態(起動完了)の確認回数

仮想サーバの起動が完了したか確認する際の確認回数を指定します。仮想サーバの状態(起動完了)の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

hyperv.checkVmStateEnabledInterval

仮想サーバの状態(起動完了)の確認間隔

仮想サーバの起動が完了したか確認する際の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.foreachVmName

仮想サーバ名(複数指定可)

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。複数指定する場合はコンマで区切ってください。99個まで指定できます。

入力

無効

○　

仮想サーバ情報

hyperv.checkNetworkConnection

ネットワーク接続確認の実行

仮想サーバの起動後にネットワーク接続確認を実行するかどうかを指定します。

入力

無効

○　

ネットワーク接続確認

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.targetHost

256文字以内の半角英数字および「.」，「-」。

hyperv.waitTime

0〜3600の整数値。

common.icmpEchoTimeout

1〜2147483647の整数値。

hyperv.checkVmStateEnabledCount

1〜2147483647の整数値。

hyperv.checkVmStateEnabledInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.foreachVmName

1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」，「/」，「:」を除く。

hyperv.checkNetworkConnection

次の値のどれかを選択する。

yes,no

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの起動

仮想サーバの起動

繰り返し実行部品

複数の仮想サーバを起動します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.11.2　仮想サーバの起動(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの状態取得

hyperv2016GetVMState

仮想サーバの状態取得

Hyper-V環境において，仮想サーバの状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

仮想サーバの起動

hyperv2016PowerOnVM

階層フロー部品

Hyper-V環境において，仮想サーバを起動します。

−　

2-1

値判定分岐部品

仮想サーバが起動しているか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-2

仮想サーバの起動

仮想サーバが起動以外の状態である場合，仮想サーバを起動します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

ネットワーク接続確認

hyperv2016CheckNetwork

階層フロー部品

ネットワークが接続されているかを確認します。

−　

3-1

値判定分岐部品

ネットワーク接続確認にyesが指定されているかを判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-2

階層フロー部品

ネットワーク接続確認にyesが指定されている場合，ネットワーク接続確認を実施します。

−　

3-2-1

値判定分岐部品

IPアドレス取得開始までの待機時間に0より大きい値が指定されているか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-2-2

実行待機

IPアドレス取得開始までの待機時間に0より大きい値が指定されている場合，待機処理を実施します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-2-3

仮想サーバのIPアドレス取得

起動完了した仮想サーバのIPアドレスを取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-2-4

ICMPエコー要求メッセージの送信

起動完了した仮想サーバにICMPエコー要求を発行します。

システム環境の状態によっては，仮想サーバの起動には成功するが，ネットワークの接続確認に失敗し，タスクが異常終了する場合があります。仮想サーバが起動しているか確認してください。サービスを再実行する場合は，注意事項を確認し，エラー原因を取り除いたあとで実行してください。

3.11.3　仮想サーバの再起動

機能

このサービステンプレートは，Hyper-V環境の複数の仮想サーバを再起動します。

このサービステンプレートが前提とするサーバを次に示します。

・Hyper-Vサーバ

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

処理の概要を次に示します。

(1) 仮想サーバが起動している場合に，仮想サーバを再起動します。仮想サーバの状態が起動以外の場合は，該当する仮想サーバの処理がエラーになります。

(2) ネットワーク接続確認を実行する場合は，再起動した仮想サーバに設定されているIPアドレス(IPv4)を取得したのち，ローカルサーバから再起動した仮想サーバに対してICMPエコー要求を送信し，ネットワーク接続を確認します。

上記の処理を，指定された仮想サーバ群に対して並列に実行します。

仮想サーバを起動する際には，hyperv.checkVmStateEnabledIntervalプロパティに指定した秒数待ち合わせ，仮想サーバの状態を確認する動作を，hyperv.checkVmStateEnabledCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2016 Hyper-V

【サービステンプレート実行システム内前提製品の稼働OS】

(1)Hyper-Vサーバの前提OS

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

(2)仮想サーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。

　・オペレーティングシステムのシャットダウン

　・データ交換

(3)ネットワーク接続確認を実行する場合，エージェントレス接続先としてローカルサーバ("localhost"で解決されるループバックアドレス)を設定する必要があります。

(4)ネットワーク接続確認を実行する場合，対象となる仮想サーバのファイアーウォールがICMP(ECHO)応答を許可していること。

(5)仮想サーバが起動していること。

注意事項

(1)このサービスは指定した仮想サーバのOSを強制的にシャットダウンします。このサービスを実行した場合，仮想サーバで編集中のファイルデータは保存されません。

(2)ネットワーク接続確認を実行する場合は，システム環境によって，仮想サーバの起動直後にすべてのIPアドレスが取得できない場合があります。そのため，仮想サーバが起動しているにも関わらず，osSendIcmp部品で仮想サーバに設定されたすべてのIPアドレス(IPv4)でネットワークの接続確認が出来ずにタスクが異常終了する場合があります。仮想サーバの起動からIPアドレス取得開始までの待機時間を指定するhyperv.waitTimeプロパティの秒数を指定して，すべてのIPアドレスが取得できるように調節してください。

(3)ネットワーク接続確認を実行する場合は，仮想サーバのすべてのNICに設定されているIPアドレス(IPv4)の長さの合計を1024文字以内(※)にして設定してください。IPアドレス(IPv4)の長さの合計が1024文字を超えると，osSendIcmp部品でエラーが発生し，タスクが異常終了する場合があります。

　※IPアドレス(IPv4)1つの最大の長さは16文字(IPアドレス連結用の「,(コンマ)」を含む)。

(4)ネットワーク接続確認を実行する場合，common.icmpEchoTimeoutプロパティは利用している環境に応じて調整してください。

実行権限

ビルトイン Administrator

バージョン

03.00.00

タグ

Control VM,Hyper-V 2016

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

Hyper-Vの情報を指定してください。

表示されます。

仮想サーバ情報

再起動する仮想サーバの情報を指定してください。

表示されます。

ネットワーク接続確認

仮想サーバを再起動したあとのネットワーク接続確認に関するプロパティです。必要に応じて変更してください。

表示されません。

実行時オプション

仮想サーバを再起動する際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.targetHost

Hyper-Vサーバのホスト名

Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

hyperv.waitTime

IPアドレス取得開始までの待機時間

ネットワーク接続確認を実行する場合，仮想サーバの再起動が完了してからIPアドレス取得を開始するまでの待機時間を秒単位で指定します。

入力

無効

○　

ネットワーク接続確認

common.icmpEchoTimeout

ICMPエコー要求のタイムアウト時間

ネットワーク接続確認を実行する場合，仮想サーバの再起動後に実行する，ICMPエコー要求に対する応答を待つ時間をミリ秒単位で指定します。

入力

無効

○　

ネットワーク接続確認

hyperv.checkVmStateEnabledCount

仮想サーバの状態(起動完了)の確認回数

仮想サーバの起動が完了したか確認する際の確認回数を指定します。仮想サーバの状態(起動完了)の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

hyperv.checkVmStateEnabledInterval

仮想サーバの状態(起動完了)の確認間隔

仮想サーバの起動が完了したか確認する際の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.foreachVmName

仮想サーバ名(複数指定可)

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。複数指定する場合はコンマで区切ってください。99個まで指定できます。

入力

無効

○　

仮想サーバ情報

hyperv.checkNetworkConnection

ネットワーク接続確認の実行

仮想サーバの再起動後にネットワーク接続確認を実行するかどうかを指定します。

入力

無効

○　

ネットワーク接続確認

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.targetHost

256文字以内の半角英数字および「.」，「-」。

hyperv.waitTime

0〜3600の整数値。

common.icmpEchoTimeout

1〜2147483647の整数値。

hyperv.checkVmStateEnabledCount

1〜2147483647の整数値。

hyperv.checkVmStateEnabledInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.foreachVmName

1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」，「/」，「:」を除く。

hyperv.checkNetworkConnection

次の値のどれかを選択する。

yes,no

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの再起動

仮想サーバの再起動

繰り返し部品

複数の仮想サーバを再起動します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.11.4　仮想サーバの再起動(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバのシャットダウン

hyperv2016ShutdownVM

仮想サーバのシャットダウン

仮想サーバが起動している場合，仮想サーバをシャットダウンします。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

仮想サーバの起動

hyperv2016PowerOnVM

仮想サーバの起動

仮想サーバが停止している場合，仮想サーバを起動します。

エラーの原因を取り除いて，仮想サーバを起動したあと，サービスを再実行してください。

3

ネットワーク接続確認

hyperv2016CheckNetwork

階層フロー部品

ネットワークが接続されているかを確認します。

−　

3-1

値判定分岐部品

ネットワーク接続確認にyesが指定されているかを判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-2

階層フロー部品

ネットワーク接続確認にyesが指定されている場合，ネットワーク接続確認を実行します。

−　

3-2-1

値判定分岐部品

IPアドレス取得開始までの待機時間に0より大きい値が指定されているか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-2-2

実行待機

IPアドレス取得開始までの待機時間に0より大きい値が指定されている場合，待機処理を実行します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-2-3

仮想サーバのIPアドレス取得

起動完了した仮想サーバのIPアドレスを取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-2-4

ICMPエコー要求メッセージの送信

起動完了した仮想サーバにICMPエコー要求を発行します。

システム環境の状態によっては，仮想サーバの起動には成功するが，ネットワークの接続確認に失敗し，タスクが異常終了する場合があります。仮想サーバが起動しているか確認してください。サービスを再実行する場合は，注意事項を確認し，エラー原因を取り除いたあとで実行してください。

3.11.5　仮想サーバの情報一覧取得

機能

このサービステンプレートは，Hyper-V環境の仮想サーバの情報一覧を取得します。

このサービステンプレートが前提とするサーバを次に示します。

・Hyper-Vサーバ

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

処理の概要を次に示します。

(1) 仮想サーバの情報一覧をCSV形式で指定されたリモートの一時ファイルに出力します。出力ファイルのエンコード形式は，Hyper-Vサーバのシステムのデフォルトエンコーディングです。

(2) リモートの一時ファイルを指定されたローカルの出力ファイルに転送します。

(3) リモートの一時ファイルを削除します。

出力するCSVファイルの項目を次に示します。

項目はコンマ区切りで出力します。

(a) Hyper-Vサーバ名 (ヘッダー名：ComputerName)

(b) 仮想サーバ名 (ヘッダー名：VMName)

(c) 仮想サーバの状態 (ヘッダー名：State)

(d) 仮想サーバのCPU使用率(%) (ヘッダー名：CPUUsage)

(e) 仮想サーバのメモリ割り当て(MB)※1 (ヘッダー名：MemoryAssigned)

(f) 仮想サーバの稼働時間 (ヘッダー名：Uptime)

(g) 仮想サーバの状況 (ヘッダー名：Status)

(h) 仮想サーバの仮想プロセッサ数 (ヘッダー名：ProcessorCount)

(i) 仮想サーバのスタートアップRAM(MB) (ヘッダー名：MemoryStartup)

(j) 仮想サーバの動的メモリの有効 (ヘッダー名：DynamicMemoryEnabled)

※1：仮想サーバが実際に使用しているメモリの容量(MB)です。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2016 Hyper-V

【サービステンプレート実行システム内前提製品の稼働OS】

(1)Hyper-Vサーバの前提OS

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

(2)仮想サーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

なし。

注意事項

(1)リモートおよびローカルに指定するファイル名が既に存在する場合，既存のファイルを上書きします。また，リモート側のファイルは削除します。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(2)リモートに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

(3)同名の仮想サーバが2つ以上ある場合，出力するCSVファイルでは仮想サーバを特定できません。

バージョン

02.12.00

タグ

Gather VM information,Hyper-V 2016

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

Hyper-Vの情報を指定してください。

表示されます。

出力ファイル格納情報

出力ファイルの格納先を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.targetHost

Hyper-Vサーバのホスト名

Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.listOutputFileNameRemote

出力ファイル名(リモート)

仮想サーバ情報をHyper-Vサーバに出力する際の一時ファイル名をフルパスで指定します。

入力

無効

○　

出力ファイル格納情報

hyperv.listOutputFileNameLocal

出力ファイル名(ローカル)

仮想サーバ情報をローカルサーバに格納する際のファイル名をフルパスで指定します。

入力

無効

○　

出力ファイル格納情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.targetHost

256文字以内の半角英数字および「.」，「-」。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.listOutputFileNameRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「'」，「[」，「]」，「`」および末尾の「¥」を除く。

hyperv.listOutputFileNameLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの情報一覧取得

仮想サーバの情報一覧取得

仮想サーバの情報一覧取得

仮想サーバの情報一覧をHyper-Vサーバの一時ファイルに出力します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

ファイル転送

ファイル転送

ファイル転送部品

リモートの一時ファイルをローカルの指定された出力ファイルに転送します。

Hyper-Vサーバ上の一時ファイルをローカルサーバに転送し，そのあとHyper-Vサーバ上の一時ファイルを手動で削除してください。

3

一時ファイル削除

一時ファイル削除

ファイル削除

リモートの一時ファイルを削除します。

Hyper-Vサーバ上の一時ファイルを手動で削除してください。

3.11.6　仮想サーバの停止

機能

このサービステンプレートは，Hyper-V環境の複数の仮想サーバのOSをシャットダウンします。

このサービステンプレートが前提とするサーバを次に示します。

・Hyper-Vサーバ

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

処理の概要を次に示します。

(1) 仮想サーバの状態を取得します。

(2) 仮想サーバが起動している場合に，仮想サーバのOSをシャットダウンします。仮想サーバが停止している場合は，仮想サーバのOSをシャットダウンする処理をスキップします。仮想サーバが起動および停止している以外の場合は，該当する仮想サーバの処理がエラーとなります。

上記の処理を，指定された仮想サーバ群に対して並列に実行します。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2016 Hyper-V

【サービステンプレート実行システム内前提製品の稼働OS】

(1)Hyper-Vサーバの前提OS

　・Windows Server 2016 Standard/Datacenter

ただし，Server Core/Nano Serverインストール環境は除く。

(2)仮想サーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。

　・オペレーティングシステムのシャットダウン

注意事項

(1)このサービスを実行した場合，仮想サーバで編集中のファイルデータは保存されません。

バージョン

03.00.00

タグ

Control VM,Hyper-V 2016

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

Hyper-Vの情報を指定してください。

表示されます。

仮想サーバ情報

停止する仮想サーバの情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.targetHost

Hyper-Vサーバのホスト名

Hyper-Vサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hyperv.foreachVmName

仮想サーバ名(複数指定可)

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。複数指定する場合はコンマで区切ってください。99個まで指定できます。

入力

無効

○　

仮想サーバ情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.targetHost

256文字以内の半角英数字および「.」，「-」。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hyperv.foreachVmName

1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」，「/」，「:」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの停止

仮想サーバの停止

繰り返し実行部品

複数の仮想サーバのOSをシャットダウンします。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.11.7　仮想サーバの停止(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの状態取得

hyperv2016GetVMState

仮想サーバの状態取得

Hyper-V環境において，仮想サーバの状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

仮想サーバのシャットダウン

hyperv2016ShutdownVM

階層フロー部品

Hyper-V環境において，仮想サーバをシャットダウンします。

−　

2-1

値判定分岐部品

仮想サーバが停止しているか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-2

仮想サーバのシャットダウン

仮想サーバが停止以外の状態の場合，仮想サーバをシャットダウンします。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.12　OpenStack（構築）用のサービステンプレート

3.12.1　仮想サーバの削除

機能

このサービステンプレートは，OpenStack管理下のKVM環境で，インスタンスを削除します。また，インスタンスにFloating IPアドレスが設定されている場合，Floating IPアドレスの割り当てを解除します。

このドキュメント内で使用しているOpenStackに関する用語は，OpenStackのDashboardで使用されている表示名です。OpenStackに関する用語を次に示します。

・Identity

　OpenStackではIdentityまたはKeyStoneと記載されています。

・プロジェクト

　OpenStackではプロジェクトまたはテナントと記載されています。

・ボリューム

　OpenStackではボリュームまたはブロックストレージと記載されています。

このサービステンプレートが前提とするサーバを次に示します。

・OpenStackサーバ

　OpenStackがインストールされているサーバです。

・KVMサーバ

　Kernel-based Virtual Machineがインストールされているサーバです。

・OpenStack操作サーバ

　OpenStackサーバにREST-APIを実行するサーバです。

・インスタンス

　OpenStackサーバおよびKVMによって管理されているインスタンスです。一般的な仮想サーバのことです。

処理の概要を次に示します。

(1)インスタンスを削除します。

　ユーザーが指定したインスタンス名を用います。

プロパティ設定の留意点を次に示します。

(1) インスタンスを削除する際には，openstack.checkInstanceDeletionIntervalプロパティに指定した秒数待ち合わせ，インスタンスの状態を確認する動作を，openstack.checkInstanceDeletionCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)OpenStackサーバの前提製品

　・OpenStack

(2)インスタンスを管理する仮想化環境

　・Kernel-based Virtual Machine

　・VMware vCenter Server

　・VMware vSphere ESXi

(3)OpenStack操作サーバ

　・Microsoft .Net Framework 3.5以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1)インスタンスの前提OS

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(2)OpenStack操作サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter

　・Windows Server 2012 R2 Standard/Datacenter

　ただし，Server Coreインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)インスタンスに関する条件

　・同一プロジェクト内でインスタンス名が重複しないこと。

注意事項

(1)インスタンスにボリュームが接続されている場合，接続されているボリュームは削除しません。

(2)インスタンスにボリュームが接続されている場合，インスタンス削除の際に接続されているボリュームがアンマウントされていることを確認してください。ボリュームがマウントされている状態でインスタンスの削除を行った場合，ファイルシステム破損が起きるおそれがあります。

実行権限

admin権限

バージョン

02.00.00

タグ

Delete VM,OpenStack

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

クラウド基盤環境情報

OpenStackの情報を指定してください。

表示されます。

インスタンス情報

インスタンスの情報を指定してください。

表示されます。

実行時オプション

インスタンスを削除する際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

openstack.targetHost

OpenStack操作サーバのホスト名

OpenStack操作サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

クラウド基盤環境情報

openstack.identityServerHostName

Identityサーバのホスト名

Identityサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

クラウド基盤環境情報

openstack.userName

Identityサーバにログインするためのユーザー名

Identityサーバにログインするためのユーザー名を指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.password

Identityサーバにログインするためのパスワード

Identityサーバにログインするためのパスワードを指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.protocol

Identityサーバ接続用プロトコル

Identityサーバに接続するためのプロトコルを指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.portNumber

Identityサーバ接続用ポート番号

Identityサーバに接続するためのポート番号を指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.projectName

プロジェクト名

プロジェクトの名称を指定します。

入力

無効

○　

インスタンス情報

openstack.checkInstanceDeletionCount

インスタンスの削除完了の確認回数

インスタンスが削除されたことを確認する際の，確認回数を指定します。インスタンスの削除完了の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

openstack.checkInstanceDeletionInterval

インスタンスの削除完了の確認間隔

インスタンスが削除されたことを確認する際の，確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

openstack.instanceName

インスタンス名

インスタンスの名称を指定します(OpenStackにおけるインスタンスの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

インスタンス情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

openstack.targetHost

256文字以内の半角英数字および「.」，「-」。

openstack.identityServerHostName

256文字以内の半角英数字および「.」，「-」。

openstack.userName

64文字以内の半角英数字。

openstack.password

256文字以内の半角英数字。

openstack.protocol

次の値のどれかを選択する。

http,https

openstack.portNumber

1〜65535の整数値。

openstack.projectName

80文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

openstack.checkInstanceDeletionCount

1〜2147483647の整数値。

openstack.checkInstanceDeletionInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

openstack.instanceName

80文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの削除

仮想サーバの削除

仮想サーバの削除

インスタンスを削除します。

タスクログを確認し，エラーの原因を取り除いたあと，インスタンスが残っていた場合はこのサービスを再実行してください。

3.12.2　仮想サーバの削除(仮想ディスク)

機能

このサービステンプレートは，OpenStack管理下のKVM環境で，インスタンスに接続されているボリュームを切断します。

このドキュメント内で使用しているOpenStackに関する用語は，OpenStackのDashboardで使用されている表示名です。OpenStackに関する用語を次に示します。

・Identity

　OpenStackではIdentityまたはKeyStoneと記載されています。

・プロジェクト

　OpenStackではプロジェクトまたはテナントと記載されています。

・ボリューム

　OpenStackではボリュームまたはブロックストレージと記載されています。

このサービステンプレートが前提とするサーバを次に示します。

・OpenStackサーバ

　OpenStackがインストールされているサーバです。

・KVMサーバ

　Kernel-based Virtual Machineがインストールされているサーバです。

・OpenStack操作サーバ

　OpenStackサーバにREST-APIを実行するサーバです。

・インスタンス

　OpenStackサーバおよびKVMによって管理されているインスタンスです。一般的な仮想サーバのことです。

処理の概要を次に示します。

(1)インスタンスに接続されているボリュームを切断します。

　ユーザーが指定したインスタンス名とボリューム名を用います。

(2)オプションとしてボリュームを削除できます。

　ボリュームを削除する場合，ユーザーが指定したボリューム名を用います。

プロパティ設定の留意点を次に示します。

(1) ボリュームを切断する際には，openstack.checkVolumeDetachmentIntervalプロパティに指定した秒数待ち合わせ，ボリュームの状態を確認する動作を，openstack.checkVolumeDetachmentCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

(2) ボリュームを削除する際には，openstack.checkVolumeDeletionIntervalプロパティに指定した秒数待ち合わせ，ボリュームの状態を確認する動作を，openstack.checkVolumeDeletionCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)OpenStackサーバの前提製品

　・OpenStack

(2)インスタンスを管理する仮想化環境

　・Kernel-based Virtual Machine

　・VMware vCenter Server

　・VMware vSphere ESXi

(3)OpenStack操作サーバ

　・Microsoft .Net Framework 3.5以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1)インスタンスの前提OS

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(2)OpenStack操作サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter

　・Windows Server 2012 R2 Standard/Datacenter

　ただし，Server Coreインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)インスタンスに関する条件

　・同一プロジェクト内でインスタンス名が重複しないこと。

(2)ボリュームに関する条件

　・同一プロジェクト内でボリューム名が重複しないこと。

注意事項

(1)ボリュームを切断する際に，ボリュームがアンマウントされていることを確認してください。ボリュームがマウントされている状態でボリュームの切断を行った場合，ファイルシステム破損が起きるおそれがあります。

(2)指定したインスタンス，ボリュームが共に存在している場合，インスタンスとボリュームの間に接続関係が無くてもボリュームの削除を行います。そのため，指定したボリューム名に誤りが無いか，十分に確認してください。

実行権限

admin権限

バージョン

02.00.00

タグ

Modify VM,OpenStack

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

クラウド基盤環境情報

OpenStackの情報を指定してください。

表示されます。

インスタンス情報

インスタンスの情報を指定してください。

表示されます。

ボリューム情報

インスタンスから切断するボリュームの情報を指定してください。

表示されます。

実行時オプション

ボリュームを切断および削除する際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

openstack.targetHost

OpenStack操作サーバのホスト名

OpenStack操作サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

クラウド基盤環境情報

openstack.identityServerHostName

Identityサーバのホスト名

Identityサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

クラウド基盤環境情報

openstack.userName

Identityサーバにログインするためのユーザー名

Identityサーバにログインするためのユーザー名を指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.password

Identityサーバにログインするためのパスワード

Identityサーバにログインするためのパスワードを指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.protocol

Identityサーバ接続用プロトコル

Identityサーバに接続するためのプロトコルを指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.portNumber

Identityサーバ接続用ポート番号

Identityサーバに接続するためのポート番号を指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.projectName

プロジェクト名

プロジェクトの名称を指定します。

入力

無効

○　

インスタンス情報

openstack.deleteVolumeEnabled

ボリューム削除の要否

切断後に，ボリュームを削除するかどうかを指定します。「yes」を選択した場合，ボリュームを削除します。

入力

無効

○　

ボリューム情報

openstack.checkVolumeDetachmentCount

ボリュームの切断完了の確認回数

ボリュームが切断されたことを確認する際の，確認回数を指定します。ボリュームの切断完了の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

openstack.checkVolumeDetachmentInterval

ボリュームの切断完了の確認間隔

ボリュームが切断されたことを確認する際の，確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

openstack.checkVolumeDeletionCount

ボリュームの削除完了の確認回数

ボリュームが削除されたことを確認する際の，確認回数を指定します。ボリュームの削除完了の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

openstack.checkVolumeDeletionInterval

ボリュームの削除完了の確認間隔

ボリュームが削除されたことを確認する際の，確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

openstack.instanceName

インスタンス名

インスタンスの名称を指定します(OpenStackにおけるインスタンスの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

インスタンス情報

openstack.volumeName

ボリューム名

インスタンスから切断するボリュームの名称を指定します。

入力

無効

○　

ボリューム情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

openstack.targetHost

256文字以内の半角英数字および「.」，「-」。

openstack.identityServerHostName

256文字以内の半角英数字および「.」，「-」。

openstack.userName

64文字以内の半角英数字。

openstack.password

256文字以内の半角英数字。

openstack.protocol

次の値のどれかを選択する。

http,https

openstack.portNumber

1〜65535の整数値。

openstack.projectName

80文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

openstack.deleteVolumeEnabled

次の値のどれかを選択する。

yes,no

openstack.checkVolumeDetachmentCount

1〜2147483647の整数値。

openstack.checkVolumeDetachmentInterval

1〜60の整数値。

openstack.checkVolumeDeletionCount

1〜2147483647の整数値。

openstack.checkVolumeDeletionInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

openstack.instanceName

80文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

openstack.volumeName

255文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

ボリュームの切断

ボリュームの切断

ボリュームの切断

インスタンスからボリュームを切断します。

タスクログを確認し，エラーの原因を取り除いたあと，このサービスを再実行してください。

2

値判定分岐部品

値判定分岐部品

値判定分岐部品

ボリュームを削除するかを判定します。

−　

3

ボリュームの削除

ボリュームの削除

ボリュームの削除

ボリュームを削除します。

タスクログを確認し，エラーの原因を取り除いください。

ボリュームが削除されていない場合は，手動で，ボリュームを削除してください。

3.12.3　仮想サーバの追加(デプロイ/OS初期設定)

機能

このサービステンプレートは，OpenStack管理下のKVM環境に，イメージからインスタンスの起動をします。

このドキュメント内で使用しているOpenStackに関する用語は，OpenStackのDashboardで使用されている表示名です。OpenStackに関する用語を次に示します。

・Identity

　IdentityまたはKeyStoneと記載されています。

・インスタンスタイプ

　インスタンスタイプまたはフレーバーと記載されています。

・プロジェクト

　プロジェクトまたはテナントと記載されています。

このサービステンプレートが前提とするサーバを次に示します。

・OpenStackサーバ

　OpenStackがインストールされているサーバです。

・KVMサーバ

　Kernel-based Virtual Machineがインストールされているサーバです。

・OpenStack操作サーバ

　OpenStackサーバにREST-APIを実行するサーバです。

・インスタンス

　OpenStackサーバおよびKVMによって管理されているインスタンスです。一般的な仮想サーバのことです。

処理の概要を次に示します。

(1) イメージからインスタンスを起動します。

　1. イメージ，インスタンス名，インスタンスタイプ，ネットワーク(管理用・業務用)を設定します。また，オプションとしてキーペア，セキュリティグループを設定できます。

　2. OpenStackのDHCP機能を使用しOS起動時にIP設定を動的に割り当てます。

　3. openstack.floatingIpOptionプロパティが指定されている場合は，Floating IPを割り当てます。

(2) OSの初期情報を設定します。

　1. コンピュータ名を設定します。また，オプションとしてタイムゾーン，DNSサフィックスを設定できます。

プロパティ設定の留意点を次に示します。

(1)インスタンスに対してFloating IPアドレスを設定したい場合は，openstack.floatingIpOptionプロパティの選択リストで"yes"を選択し，openstack.floatingIpAddressプロパティにFloating IPアドレスを指定してください。openstack.floatingIpOptionプロパティの選択リストで"yes"を選択し，openstack.floatingIpAddressプロパティにFloating IPアドレスの指定が無い場合，openstack.networkNameExtプロパティで指定したネットワークのFloating IPアドレスプールから最初に取得できたFloating IPアドレスを設定します。

(2)openstack.securityGroupNameプロパティを省略した場合，セキュリティグループ"default"が設定されます。

(3) OS.destIPAddressプロパティ，OS.subnetMaskStaticRouteプロパティ，OS.defaultGWStaticRouteプロパティは同時に指定してください。どれかの指定がない場合，スタティックルートは設定されません。

(4)指定可能なタイムゾーンは次のとおりです。

　　America/Adak

　　America/Anchorage

　　America/Boise

　　America/Chicago

　　America/Denver

　　America/Detroit

　　America/Indiana/Indianapolis

　　America/Indiana/Knox

　　America/Indiana/Marengo

　　America/Indiana/Petersburg

　　America/Indiana/Tell_City

　　America/Indiana/Vevay

　　America/Indiana/Vincennes

　　America/Indiana/Winamac

　　America/Juneau

　　America/Kentucky/Monticello

　　America/Los_Angeles

　　America/Louisville

　　America/Menominee

　　America/Monterrey

　　America/Montevideo

　　America/New_York

　　America/Nome

　　America/North_Dakota/Beulah

　　America/North_Dakota/Center

　　America/North_Dakota/New_Salem

　　America/Phoenix

　　America/Shiprock

　　America/Tijuana

　　America/Vancouver

　　America/Yakutat

　　Asia/Chongqing

　　Asia/Hong_Kong

　　Asia/Kolkata

　　Asia/Macau

　　Asia/Shanghai

　　Asia/Singapore

　　Asia/Tokyo

　　Etc/UTC

　　Europe/London

　　Pacific/Honolulu

指定がない場合，イメージに設定されているタイムゾーンを引き継ぎます。

(5)OS.dnsSuffixプロパティ指定時は，/etc/resolv.confファイルにDNSサフィックスを追記します。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)OpenStackサーバの前提製品

・OpenStack

(2)インスタンスを管理する仮想化環境

　・Kernel-based Virtual Machine

　・VMware vCenter Server

　・VMware vSphere ESXi

(3)OpenStack操作サーバ

　・Microsoft .Net Framework 3.5以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1)インスタンスの前提OS

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　　・net-toolsパッケージがインストールされていること。

(2)OpenStack操作サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

ただし，Server Coreインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)OpenStackサーバ上の設定に関する条件

　・インスタンスが接続するネットワークのサブネットの設定がDHCP有効で，IPアドレスが動的に割り当てられるようになっていること。

　・インスタンスの起動に使用するイメージが作成済みであること。

　・インスタンスの起動に使用するインスタンスタイプが作成済みであること。

　・インスタンスの起動に使用するネットワークが作成済みであること。

　・イメージ名がプロジェクト内で一意であること。

　・インスタンスタイプ名がプロジェクト内で一意であること。

　・ネットワーク名がプロジェクト内で一意であること。

(2)インスタンスの起動に使用するイメージに関する条件

　・エージェントレス接続が可能な設定であること。

　・ファイアーウォールがICMP(ECHO)応答を許可していること。

(3)インスタンスに関する条件

　・同一プロジェクト内でインスタンス名が重複しないこと。

(4)本製品に関する条件

　・ローカルサーバとインスタンス間の通信に内部ネットワークを使用する場合は，インスタンスに割り当てるIPプールのIPアドレスを，「管理」タブのエージェントレス接続先定義に，事前に認証情報を登録してあること。

　・ローカルサーバとインスタンス間の通信に外部ネットワークを使用する場合は，インスタンスに割り当てるFloating IPアドレスプールのIPアドレスを，「管理」タブのエージェントレス接続先定義に，事前に認証情報を登録してあること。

注意事項

(1)インスタンスの起動中は，当該インスタンスを操作しないでください。インスタンスの起動に失敗するおそれがあります。OpenStackサーバからも直接操作をしないでください。

(2)ローカルサーバとの通信に外部ネットワークを使用する場合は，openstack.floatingIpOptionプロパティの選択リストで"yes"を選択してください。"no"を選択した場合，ローカルサーバからインスタンスにアクセスできないで，タスクが異常終了します。

(3)openstack.floatingIpOptionプロパティの選択リストで"yes"を選択した場合は，openstack.networkNameExtプロパティを設定してください。openstack.networkNameExtプロパティが省略された場合は，Floating IPアドレスを取得する外部ネットワークが特定できないで，タスクが異常終了します。

(4)openstack.protocolプロパティの選択リストで"https"を選択した場合に，OpenStackサーバの証明書がパブリック証明書でない場合，証明書の信頼性が確認できないため，タスクが異常終了します。

(5)インスタンスのOSがRed Hat Enterprise Linux 5の場合は，タイムゾーンにAmerica/North_Dakota/Beulahを設定できない場合があります。インスタンスのOSでAmerica/North_Dakota/Beulahが設定可能か事前に確認してください。

実行権限

(1)OpenStackサーバにログインするユーザーに次の権限が必要です。

admin権限

バージョン

03.00.00

タグ

Add VM,OpenStack

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

クラウド基盤環境情報

OpenStackの情報を指定してください。

表示されます。

インスタンス情報

起動するインスタンスの情報を指定してください。

表示されます。

OS情報

インスタンスに設定するOS情報を指定してください。

表示されます。

Floating IPアドレス情報

インスタンスに割り当てるFloating IPアドレスの情報を指定してください。

表示されます。

実行時オプション

インスタンスの起動を行う際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

openstack.targetHost

OpenStack操作サーバのホスト名

OpenStack操作サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

クラウド基盤環境情報

openstack.identityServerHostName

Identityサーバのホスト名

Identityサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

クラウド基盤環境情報

openstack.userName

Identityサーバにログインするためのユーザー名

Identityサーバにログインするためのユーザー名を指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.password

Identityサーバにログインするためのパスワード

Identityサーバにログインするためのパスワードを指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.protocol

Identityサーバ接続用プロトコル

Identityサーバに接続するためのプロトコルを指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.portNumber

Identityサーバ接続用ポート番号

Identityサーバに接続するためのポート番号を指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.projectName

プロジェクト名

インスタンスを起動させるプロジェクトの名称を指定します。

入力

無効

○　

インスタンス情報

OS.destIPAddress

スタティックルートの宛先IPアドレス

スタティックルートの宛先IPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

OS情報

OS.subnetMaskStaticRoute

サブネットマスク(スタティックルート用)

スタティックルート用のサブネットマスクを指定します。IPv6アドレスには対応していません。

入力

無効

△　

OS情報

OS.defaultGWStaticRoute

デフォルトゲートウェイ(スタティックルート用)

スタティックルート用のデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

入力

無効

△　

OS情報

openstack.checkInstanceStateCount

インスタンスの起動完了の確認回数

インスタンスの起動を確認する際の，インスタンスの起動状態の確認回数を指定します。インスタンスの起動状態の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

openstack.checkInstanceStateInterval

インスタンスの起動完了の確認間隔

インスタンスの起動を確認する際の，インスタンスの起動状態の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

openstack.checkOSStateWaittime

OS起動待ち時間

OSの起動を確認する際の，起動待ち時間を秒単位で指定します。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

openstack.instanceName

インスタンス名

インスタンスの名称を指定します(OpenStackにおけるインスタンスの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

インスタンス情報

openstack.imageName

イメージ名

イメージの名称を指定します。

入力

無効

○　

インスタンス情報

openstack.instanceTypeName

インスタンスタイプ名

インスタンスタイプの名称を指定します。

入力

無効

○　

インスタンス情報

openstack.keyPairName

キーペア名

キーペアの名称を指定します。

入力

無効

△　

インスタンス情報

openstack.securityGroupName

セキュリティグループ名

セキュリティグループの名称を指定します。

入力

無効

△　

インスタンス情報

openstack.networkNameMng

ネットワーク名(管理用)

インスタンスに設定する管理用のネットワークの名称を指定します。

入力

無効

○　

インスタンス情報

openstack.networkNameBiz

ネットワーク名(業務用)

インスタンスに設定する業務用のネットワークの名称を指定します。

入力

無効

△　

インスタンス情報

OS.computerName

ホスト名

OSのホスト名を指定します。

入力

無効

○　

OS情報

OS.timeZoneLin

タイムゾーン

インスタンスのOSに設定するタイムゾーンを指定します。入力がない場合，イメージのタイムゾーンが使用されます。

入力

無効

△　

OS情報

OS.dnsSuffix

DNS サフィックス名

DNSサフィックス名を指定します。

入力

無効

△　

OS情報

openstack.floatingIpOption

Floating IPアドレス設定の有無

インスタンスにFloating IPアドレスの割り当てを行うかを指定します。Floating IPアドレスを割り当てる場合はyes，割り当てない場合はnoを選択します。

入力

無効

○　

Floating IPアドレス情報

openstack.networkNameExt

ネットワーク名(外部接続用)

Floating IPアドレスを取得する外部ネットワークの名称を指定します。

入力

無効

△　

Floating IPアドレス情報

openstack.floatingIpAddress

Floating IPアドレス

インスタンスに割り当てるFloating IPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

Floating IPアドレス情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

openstack.ipAddressMng

IPアドレス(管理用)

インスタンスの管理用ネットワークに割り当てられたIPアドレスを格納します。

出力

無効

openstack.ipAddressBiz

IPアドレス(業務用)

インスタンスの業務用ネットワークに割り当てられたIPアドレスを格納します。

出力

無効

openstack.floatingIpAddressWork

Floating IPアドレス

インスタンスに割り当てられたFloating IPアドレスを格納します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

openstack.targetHost

256文字以内の半角英数字および「.」，「-」。

openstack.identityServerHostName

256文字以内の半角英数字および「.」，「-」。

openstack.userName

64文字以内の半角英数字。

openstack.password

256文字以内の半角英数字。

openstack.protocol

次の値のどれかを選択する。

http,https

openstack.portNumber

1〜65535の整数値。

openstack.projectName

80文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

OS.destIPAddress

15文字以内の半角数字および「.」。

OS.subnetMaskStaticRoute

15文字以内の半角数字および「.」。

OS.defaultGWStaticRoute

15文字以内の半角数字および「.」。

openstack.checkInstanceStateCount

1〜2147483647の整数値。

openstack.checkInstanceStateInterval

1〜60の整数値。

openstack.checkOSStateWaittime

1〜2147483647の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

openstack.instanceName

80文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

openstack.imageName

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

openstack.instanceTypeName

25文字以内の半角英数字および「.」「_」，「-」。

openstack.keyPairName

20文字以内の半角英数字および「_」，「-」。

openstack.securityGroupName

255文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

openstack.networkNameMng

255文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

openstack.networkNameBiz

255文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

OS.computerName

63文字以内の半角英数字および「-」。

OS.timeZoneLin

次の値のどれかを選択する。

Asia/Tokyo, Asia/Hong_Kong, Asia/Chongqing, Asia/Shanghai, Etc/UTC, America/Tijuana, America/Vancouver, America/Los_Angeles, America/Detroit, America/New_York, America/Montevideo, America/Louisville, America/Indiana/Indianapolis, America/Indiana/Vevay, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Vincennes, America/Indiana/Winamac, America/Indiana/Tell_City, America/Indiana/Knox, America/Chicago, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Kentucky/Monticello, America/Juneau, America/Menominee, America/Monterrey, America/Denver, America/Boise, America/Shiprock, America/Phoenix, America/Yakutat, America/Anchorage, America/Nome, America/Adak, Pacific/Honolulu, Asia/Singapore, Europe/London, Asia/Kolkata, America/North_Dakota/Beulah, Asia/Macau

OS.dnsSuffix

63文字以内の半角英数字。および「-」，「.」。

openstack.floatingIpOption

次の値のどれかを選択する。

yes,no

openstack.networkNameExt

255文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

openstack.floatingIpAddress

15文字以内の半角数字および「.」。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの作成

仮想サーバの作成

仮想サーバの作成

イメージから仮想サーバを作成(OpenStackでは，インスタンスの起動という)します。

タスクログを確認し，エラーの原因を取り除いたあと，このサービスを再実行してください。

プロジェクトに仮想サーバが作成されている場合は，仮想サーバの削除を行ったあと，このサービスを再実行してください。

2

インスタンスのOS初期設定

インスタンスのOS初期設定

OS初期設定(Linux)

インスタンスのOS初期設定(コンピュータ名，タイムゾーン，DNSサフィックス)を行います。

OpenStackサーバにログインし，インスタンスの設定を確認してください。その後，インスタンスにログインし，インスタンスの設定を確認してください。必要に応じてインスタンスの設定を手動で設定してください。もしくは，タスクログを確認し，エラーの原因を取り除いたあと，インスタンスの削除をしてください。そのあと，このサービスを再実行してください。

3

OSスタティックルートの設定

OSスタティックルートの設定

階層フロー部品

インスタンスのOSで，スタティックルートを設定します。

−　

3-1

値判定分岐部品

−　

OpenStackサーバにログインし，インスタンスの設定を確認してください。その後，インスタンスにログインし，インスタンスの設定を確認してください。必要に応じてインスタンスの設定を手動で設定してください。もしくは，タスクログを確認し，エラーの原因を取り除いたあと，インスタンスの削除をしてください。そのあと，このサービスを再実行してください。

3-2

スタティックルートの設定

−　

OpenStackサーバにログインし，インスタンスの設定を確認してください。その後，インスタンスにログインし，インスタンスの設定を確認してください。必要に応じてインスタンスの設定を手動で設定してください。もしくは，タスクログを確認し，エラーの原因を取り除いたあと，インスタンスの削除をしてください。そのあと，このサービスを再実行してください。

3.12.4　仮想サーバの追加(仮想ディスク)

機能

このサービステンプレートは，OpenStack管理下のKVM環境で，インスタンスにボリュームを追加します。

このドキュメント内で使用しているOpenStackに関する用語は，OpenStackのDashboardで使用されている表示名です。OpenStackに関する用語を次に示します。

・Identity

　IdentityまたはKeyStoneと記載されています。

・プロジェクト

　プロジェクトまたはテナントと記載されています。

・ボリューム

　ボリュームまたはブロックストレージと記載されています。

このサービステンプレートが前提とするサーバを次に示します。

・OpenStackサーバ

　OpenStackがインストールされているサーバです。

・KVMサーバ

　Kernel-based Virtual Machineがインストールされているサーバです。

・OpenStack操作サーバ

　OpenStackサーバにREST-APIを実行するサーバです。

・インスタンス

　OpenStackサーバおよびKVMによって管理されているインスタンスです。一般的な仮想サーバのことです。

・ボリューム

　Cinderによって管理されているボリュームです。

処理の概要を次に示します。

(1)オプションとしてボリュームを作成できます。

　ボリュームを作成する場合，ボリューム名，容量を設定します。また，オプションとして説明，種別を設定できます。

(2)インスタンスにボリュームを接続します。

　インスタンス名，ボリューム名を設定します。オプションとしてデバイス名を設定できます。

プロパティ設定の留意点を次に示します。

(1)ボリュームを新規作成する際には，openstack.checkVolumeCreationIntervalプロパティに指定した秒数待ってボリュームの状態を確認する動作を，openstack.checkVolumeCreationCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

(2)ボリュームをインスタンスに接続する際には，openstack.checkVolumeAttachmentIntervalプロパティに指定した秒数待ってボリュームの状態を確認する動作を，openstack.checkVolumeAttachmentCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)OpenStackサーバの前提製品

　・OpenStack

(2)インスタンスを管理する仮想化環境

　・Kernel-based Virtual Machine

　・VMware vCenter Server

　・VMware vSphere ESXi

(3)OpenStack操作サーバ

　・Microsoft .Net Framework 3.5以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1)インスタンスの前提OS

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(2)OpenStack操作サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)インスタンスに関する条件

　・同一プロジェクト内でインスタンス名が重複しないこと。

(2)ボリュームに関する条件

　・同一プロジェクト内でボリューム名が重複しないこと。

(3)ボリューム種別に関する条件

　・ボリューム種別がOpenStack環境に設定済みであること。

注意事項

(1)openstack.createVolumeEnabledプロパティに"yes"を設定した場合，openstack.volumeCapacityプロパティもあわせて設定してください。openstack.volumeCapacityプロパティを省略すると，タスクが異常終了します。

(2)入力プロパティで指定する文字列の最大長は，OpenStackに登録できる最大長と異なる場合があります。OpenStackに登録できる最大長を超える長さの文字列を指定した場合，OpenStackには登録できる最大長までの文字列が登録されます。

(3)openstack.deviceNameプロパティを省略した場合，インスタンスのゲストOSのデフォルトデバイスにマッピングします。

実行権限

(1)OpenStackサーバにログインするユーザーに次の権限が必要です。

admin権限

バージョン

02.00.00

タグ

Modify VM,OpenStack

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

クラウド基盤環境情報

OpenStackの情報を指定してください。

表示されます。

インスタンス情報

インスタンスの情報を指定してください。

表示されます。

ボリューム情報

インスタンスに追加するボリュームの情報を指定してください。

表示されます。

実行時オプション

ボリュームを追加する際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

openstack.targetHost

OpenStack操作サーバのホスト名

OpenStack操作サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

クラウド基盤環境情報

openstack.identityServerHostName

Identityサーバのホスト名

Identityサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

クラウド基盤環境情報

openstack.userName

Identityサーバにログインするためのユーザー名

Identityサーバにログインするためのユーザー名を指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.password

Identityサーバにログインするためのパスワード

Identityサーバにログインするためのパスワードを指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.protocol

Identityサーバ接続用プロトコル

Identityサーバに接続するためのプロトコルを指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.portNumber

Identityサーバ接続用ポート番号

Identityサーバに接続するためのポート番号を指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.projectName

プロジェクト名

プロジェクトの名称を指定します。

入力

無効

○　

インスタンス情報

openstack.createVolumeEnabled

ボリューム作成の要否

ボリュームを新規に作成するかどうかを指定します。「no」を選択した場合，既存のボリュームを使用します。

入力

無効

○　

ボリューム情報

openstack.checkVolumeCreationCount

ボリュームの作成完了の確認回数

ボリュームが作成されたことを確認する際の，確認回数を指定します。ボリュームの作成完了の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

openstack.checkVolumeCreationInterval

ボリュームの作成完了の確認間隔

ボリュームが作成されたことを確認する際の，確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

openstack.checkVolumeAttachmentCount

ボリュームの接続完了の確認回数

ボリュームが接続されたことを確認する際の，確認回数を指定します。ボリュームの接続完了の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

openstack.checkVolumeAttachmentInterval

ボリュームの接続完了の確認間隔

ボリュームが接続されたことを確認する際の，確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

openstack.instanceName

インスタンス名

インスタンスの名称を指定します(OpenStackにおけるインスタンスの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

インスタンス情報

openstack.volumeName

ボリューム名

インスタンスに接続するボリュームの名称を指定します。

入力

無効

○　

ボリューム情報

openstack.volumeDescription

ボリューム説明

ボリュームの説明を指定します。ボリュームを作成しない場合は指定しても無視されます。

入力

無効

△　

ボリューム情報

openstack.volumeType

ボリューム種別

ボリュームの種別を指定します。OpenStack環境に設定されている種別を指定してください。ボリュームを作成しない場合は指定しても無視されます。

入力

無効

△　

ボリューム情報

openstack.volumeCapacity

ボリューム容量 (GB)

ボリュームの容量(単位:GB)を指定します。ボリュームを作成する場合は必須です。ボリュームを作成しない場合は指定しても無視されます。

入力

無効

△　

ボリューム情報

openstack.deviceName

デバイス名

インスタンスに接続するボリュームをマッピングするデバイスを指定します。デバイスはゲストOSのdevディレクトリ配下が相当し，例えば"vda"にマッピングする場合は"/dev/vda"と指定します。

入力

無効

△　

ボリューム情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

openstack.attachedDeviceName

接続デバイス名

ボリュームを接続したデバイス名が格納されます。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

openstack.targetHost

256文字以内の半角英数字および「.」，「-」。

openstack.identityServerHostName

256文字以内の半角英数字および「.」，「-」。

openstack.userName

64文字以内の半角英数字。

openstack.password

256文字以内の半角英数字。

openstack.protocol

次の値のどれかを選択する。

http,https

openstack.portNumber

1〜65535の整数値。

openstack.projectName

80文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

openstack.createVolumeEnabled

次の値のどれかを選択する。

yes,no

openstack.checkVolumeCreationCount

1〜2147483647の整数値。

openstack.checkVolumeCreationInterval

1〜60の整数値。

openstack.checkVolumeAttachmentCount

1〜2147483647の整数値。

openstack.checkVolumeAttachmentInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

openstack.instanceName

80文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

openstack.volumeName

255文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

openstack.volumeDescription

1024文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

openstack.volumeType

255文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

openstack.volumeCapacity

1〜2147483647の整数値。

openstack.deviceName

255文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

ボリューム作成の要否判定

ボリューム作成の要否判定

値判定分岐部品

ボリュームを作成するかを判定します。

−　

2

ボリュームの作成

ボリュームの作成

ボリュームの作成

ボリュームを作成します。

タスクログを確認し，エラーの原因を取り除いたあと，このサービスを再実行してください。

指定したボリュームが作成されている場合は，ボリュームを削除したあと，このサービスを再実行してください。

3

ボリュームの接続

ボリュームの接続

ボリュームの接続

インスタンスにボリュームを接続します。

タスクログを確認し，エラーの原因を取り除いてください。もしこのサービスでボリュームを作成した場合は，作成されたボリュームを削除してください。そのあと，このサービスを再実行してください。

3.13　OpenStack（運用）用のサービステンプレート

3.13.1　ボリュームのバックアップ

機能

このサービステンプレートは，OpenStack管理下のKVM環境で，ボリュームのバックアップを取得します。

このドキュメント内で使用しているOpenStackに関する用語は，OpenStackのDashboardで使用されている表示名です。OpenStackに関する用語を次に示します。

・Identity

　IdentityまたはKeyStoneと記載されています。

・プロジェクト

　プロジェクトまたはテナントと記載されています。

・ボリューム

　ボリュームまたはブロックストレージと記載されています。

このサービステンプレートが前提とするサーバを次に示します。

・OpenStackサーバ

　OpenStackがインストールされているサーバです。

・KVMサーバ

　Kernel-based Virtual Machineがインストールされているサーバです。

・OpenStack操作サーバ

　OpenStackサーバにREST-APIを実行するサーバです。

・インスタンス

　OpenStackサーバおよびKVMによって管理されているインスタンスです。一般的な仮想サーバのことです。

処理の概要を次に示します。

(1)ボリュームから一時ボリュームを作成します。

　1.一時ボリューム名を設定します。オプションとして，インスタンス名，ボリューム名を設定できます。

　　・次の条件のどれか，または両方を満たすCinderによって管理されているボリュームを一時ボリューム作成対象とします。インスタンスおよびイメージは対象にできません。

　　　①openstack.instanceNameプロパティに指定されたインスタンスに割り当たっているボリューム

　　　②openstack.volumeNamesプロパティに指定されたボリューム

　2.一時ボリュームはバックアップ元のボリュームと同一ボリューム種別に作成されます。

　3.TOメールアドレスが指定されている場合に，一時ボリュームの作成完了をメール通知します。オプションとして，CCメールアドレス，BCCメールアドレス，メール件名，メール本文，エンコード種別を設定できます。

(2)一時ボリュームのバックアップを取得します。

　1.格納先コンテナー，一時ボリューム名，一時ボリュームIDを設定します。

　2.バックアップの情報をCSV形式で指定されたリモートのファイルに出力します。出力ファイルのエンコード形式は，OpenStack操作サーバのデフォルトエンコーディングです。

　　・バックアップの情報はopenstack.backupOutputFilePathプロパティに指定されたCSVファイルに追記します。

　　・openstack.backupOutputFilePathプロパティに指定したファイルが存在しない場合は新規にファイルを作成します。

(3)一時ボリュームを削除します。

　1.一時ボリューム名，一時ボリュームIDを設定します。

プロパティ設定の留意点を次に示します。

(1)出力するCSVファイルの項目を次に示します。

項目はコンマ区切りで出力します。

(a) バックアップ取得日時 (ヘッダー名：Backup time)(出力形式：yyyy/MM/dd HH:mm:ss)

(b) プロジェクト名 (ヘッダー名：Project name)

(c) インスタンス名 (ヘッダー名：Instance name)

(d) ボリュームID (ヘッダー名：Volume ID)

(e) ボリューム名 (ヘッダー名：Volume name)

(f) バックアップID (ヘッダー名：Backup ID)

(2)一時ボリュームを作成する際には，openstack.checkVolumeCreationIntervalプロパティに指定した秒数待ち合わせ，ボリュームの状態を確認する動作を，openstack.checkVolumeCreationCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

(3)ボリュームのバックアップを取得する際には，openstack.checkVolumeBackupStateIntervalプロパティに指定した秒数待ち合わせ，バックアップの状態を確認する動作を，openstack.checkVolumeBackupStateCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

(4)一時ボリュームを削除する際には，openstack.checkVolumeDeletionIntervalプロパティに指定した秒数待ち合わせ，ボリュームの状態を確認する動作を，openstack.checkVolumeDeletionCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)OpenStackサーバの前提製品

　・OpenStack

(2)インスタンスを管理する仮想化環境

　・Kernel-based Virtual Machine

　・VMware vCenter Server

　・VMware vSphere ESXi

(3)OpenStack操作サーバ

　・Microsoft .Net Framework 3.5以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1)インスタンスの前提OS

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(2)OpenStack操作サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)Openstackサーバに関する条件

　・cinder-backupが起動していること。

(2)インスタンスに関する条件

　・同一プロジェクト内でインスタンス名が重複しないこと。

(3)ボリュームに関する条件

　・同一プロジェクト内でボリューム名が重複しないこと。

(4)コンテナーに関する条件

　・同一プロジェクト内でコンテナー名が重複しないこと。

注意事項

(1)インスタンス名，ボリューム名はどちらかもしくは両方を指定してください。どちらの指定も無い場合，タスクが異常終了します。

(2)このサービスは稼働中のインスタンスに対しても実行できます。その際，ゲストOS上でI/Oが発生していると，ゲストOSとバックアップ間に不整合が発生する場合があります。そのため，ゲストOS上のI/Oを停止しておくかゲストOS自体を事前に停止してください。一時ボリューム作成終了後は，インスタンスのI/Oを再開できます。一時ボリューム作成終了の通知が必要な場合は，メール通知を行ってください。

(3)一度にバックアップ取得可能なボリュームの最大数は，27ボリュームまでです。28ボリューム以上指定された場合は，タスクが異常終了します。

(4)一時ボリューム作成先および格納先コンテナーには，バックアップ元ボリュームと同じ容量またはそれ以上の空き容量を確保してください。一時ボリューム作成先または格納先コンテナーに十分な空き容量が無い場合，タスクが異常終了します。

(5)ボリュームの状態や種別によっては，一時ボリュームの作成やバックアップの取得ができずタスクが異常終了します。事前に，ボリュームの状態や種別，および使用しているCinderドライバのマニュアルを確認してください。

(6)複数ボリュームのバックアップを取得した場合に，いくつかのバックアップの状態がErrorになりKNAE06389-Eのメッセージを出力して，タスクが異常終了する場合があります。OpenStackサーバの設定を確認しジョブエラー時の回復方法を確認したのち，このサービスを再実行してください。同じエラーが何度も発生する場合，資料採取ツールで資料を採取し，システム管理者に連絡してください。

実行権限

(1)OpenStackサーバにログインするユーザーに次の権限が必要です。

admin権限

バージョン

03.00.00

タグ

Control VM,OpenStack

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

クラウド基盤環境情報

OpenStackの情報を指定してください。

表示されます。

バックアップ情報

バックアップの情報を指定してください。

表示されます。

メール通知情報

メールを通知する場合に通知情報を指定してください。

表示されません。

実行時オプション

バックアップを取得する際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

openstack.targetHost

OpenStack操作サーバのホスト名

OpenStack操作サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

クラウド基盤環境情報

openstack.identityServerHostName

Identityサーバのホスト名

Identityサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

クラウド基盤環境情報

openstack.userName

Identityサーバにログインするためのユーザー名

Identityサーバにログインするためのユーザー名を指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.password

Identityサーバにログインするためのパスワード

Identityサーバにログインするためのパスワードを指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.protocol

Identityサーバ接続用プロトコル

Identityサーバに接続するためのプロトコルを指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.portNumber

Identityサーバ接続用ポート番号

Identityサーバに接続するためのポート番号を指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.projectName

プロジェクト名

プロジェクトの名称を指定します。

入力

無効

○　

バックアップ情報

openstack.tempVolumeName

一時ボリューム名

バックアップを取得する際の一時ボリューム名を指定します。

入力

無効

○　

バックアップ情報

common.toAddress

TOメールアドレス

メール通知の宛先メールアドレス(TO)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

メール通知情報

common.ccAddress

CCメールアドレス

メール通知の宛先メールアドレス(CC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

メール通知情報

common.bccAddress

BCCメールアドレス

メール通知の宛先メールアドレス(BCC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

メール通知情報

common.mailSubject

メール件名

メール通知のメールの件名を指定します。

入力

無効

△　

メール通知情報

common.mailBody

メール本文

メール通知のメール本文を指定します。例えば，メッセージ内にバックアップ対象としたボリューム名を指定すると，一時ボリュームの作成が完了したボリュームが識別しやすくなります。

入力

無効

△　

メール通知情報

common.encodeType

エンコード種別

メール通知のエンコード種別を指定します。指定可能なエンコード名は次のとおりです。us-ascii，iso-2022-jp，shift_jis，euc-jp，utf-8。指定しなかった場合には，utf-8で送信されます。

入力

無効

△　

メール通知情報

openstack.checkVolumeCreationCount

一時ボリュームの作成完了の確認回数

一時ボリュームが作成されたことを確認する際の，確認回数を指定します。一時ボリュームの作成完了の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

openstack.checkVolumeCreationInterval

一時ボリュームの作成完了の確認間隔

一時ボリュームが作成されたことを確認する際の，確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

openstack.checkVolumeBackupStateCount

ボリュームのバックアップ完了の確認回数

ボリュームのバックアップ完了を確認する際の，バックアップの確認回数を指定します。ボリュームのバックアップ完了の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

openstack.checkVolumeBackupStateInterval

ボリュームのバックアップ完了の確認間隔

ボリュームのバックアップ完了を確認する際の，バックアップの確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

openstack.checkVolumeDeletionCount

一時ボリュームの削除完了の確認回数

一時ボリュームが削除されたことを確認する際の，確認回数を指定します。一時ボリュームの削除完了の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

openstack.checkVolumeDeletionInterval

一時ボリュームの削除完了の確認間隔

一時ボリュームが削除されたことを確認する際の，確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

openstack.containerName

格納先コンテナー名

バックアップ格納先のコンテナーの名称を指定します。

入力

無効

○　

バックアップ情報

openstack.instanceName

インスタンス名

インスタンスの名称を指定します(OpenStackにおけるインスタンスの表示名称です。OS上のホスト名ではありません)。

入力

無効

△　

バックアップ情報

openstack.volumeNames

ボリューム名

ボリュームの名称を指定します。複数指定する場合はコンマで区切ってください。27個まで指定できます。

入力

無効

△　

バックアップ情報

openstack.backupOutputFilePath

バックアップ情報出力ファイルパス(リモート)

OpenStack操作サーバへバックアップ情報出力ファイルを出力するファイルパスをフルパスで指定します。

入力

無効

○　

バックアップ情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

openstack.targetHost

256文字以内の半角英数字および「.」，「-」。

openstack.identityServerHostName

256文字以内の半角英数字および「.」，「-」。

openstack.userName

64文字以内の半角英数字。

openstack.password

256文字以内の半角英数字。

openstack.protocol

次の値のどれかを選択する。

http,https

openstack.portNumber

1〜65535の整数値。

openstack.projectName

80文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

openstack.tempVolumeName

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

common.toAddress

1024文字以内の半角英数字および半角記号。

common.ccAddress

1024文字以内の半角英数字および半角記号。

common.bccAddress

1024文字以内の半角英数字および半角記号。

common.mailSubject

256文字以内の文字列。

common.mailBody

1024文字以内の文字列。

common.encodeType

次の値のどれかを選択する。

us-ascii,iso-2022-jp,shift_jis,euc-jp,utf-8

openstack.checkVolumeCreationCount

1〜2147483647の整数値。

openstack.checkVolumeCreationInterval

1〜60の整数値。

openstack.checkVolumeBackupStateCount

1〜2147483647の整数値。

openstack.checkVolumeBackupStateInterval

1〜60の整数値。

openstack.checkVolumeDeletionCount

1〜2147483647の整数値。

openstack.checkVolumeDeletionInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

openstack.containerName

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

openstack.instanceName

80文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

openstack.volumeNames

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

openstack.backupOutputFilePath

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」および末尾の「¥」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

一時ボリュームの作成

一時ボリュームの作成

階層フロー部品

一時ボリュームを作成します。

タスクログを確認し，エラーの原因を取り除いたあと，注意事項を確認し，このサービスを再実行してください。

一時ボリュームが作成されている場合は，一時ボリュームを削除したあと，このサービスを再実行してください。

1-1

一時ボリュームの作成

ボリュームを元にボリュームを作成します。

タスクログを確認し，エラーの原因を取り除いたあと，注意事項を確認し，このサービスを再実行してください。

一時ボリュームが作成されている場合は，一時ボリュームを削除したあと，このサービスを再実行してください。

1-2

値判定分岐部品

TOメールアドレスが設定されているか判定します。

タスクログを確認し，エラーの原因を取り除いたあと，注意事項を確認し，このサービスを再実行してください。

一時ボリュームを削除したあと，このサービスを再実行してください。

1-3

メール通知部品

メール通知をします。

タスクログを確認し，エラーの原因を取り除いたあと，注意事項を確認し，このサービスを再実行してください。

一時ボリュームを削除したあと，このサービスを再実行してください。

2

ボリュームのバックアップ

ボリュームのバックアップ

ボリュームのバックアップ

ボリュームのバックアップを取得します。

タスクログを確認し，エラーの原因を取り除いたあと，注意事項を確認し，このサービスを再実行してください。

一時ボリュームを削除し，バックアップが作成されている場合は，バックアップを削除したあと，このサービスを再実行してください。

3

一時ボリュームの削除

一時ボリュームの削除

一時ボリュームの削除

一時ボリュームを削除します。

タスクログを確認し，エラーの原因を取り除いたあと，注意事項を確認し，このサービスを再実行してください。

一時ボリュームが作成されている場合は，一時ボリュームを削除してください。

3.13.2　仮想サーバの起動

機能

このサービステンプレートは，OpenStack管理下のKVMにおいてインスタンスを起動します。

このドキュメント内で使用しているOpenStackに関する用語は，OpenStackのDashboardで使用されている表示名です。OpenStackに関する用語を次に示します。

・Identity

　IdentityまたはKeyStoneと記載されています。

・プロジェクト

　プロジェクトまたはテナントと記載されています。

このサービステンプレートが前提とするサーバを次に示します。

・OpenStackサーバ

　OpenStackがインストールされているサーバです。

・KVMサーバ

　Kernel-based Virtual Machineがインストールされているサーバです。

・OpenStack操作サーバ

　OpenStackサーバにREST-APIを実行するサーバです。

・インスタンス

　OpenStackサーバおよびKVMによって管理されているインスタンスです。一般的な仮想サーバのことです。

処理の概要を次に示します。

(1) インスタンスの状態を取得します。

(2) インスタンスが停止している場合に，インスタンスを起動します。インスタンスが起動している場合は，インスタンスを起動する処理をスキップします。インスタンスが起動および停止している場合以外は，該当するインスタンスの処理がエラーとなります。

(3) ネットワーク接続確認を実施する場合は，起動したインスタンスに設定されているIPアドレス(IPv4)を取得したのち，起動したインスタンスに対してローカルサーバからICMPエコー要求を送信し，ネットワーク接続を確認します。

上記の処理を，指定されたインスタンス群に対して並列に実行します。

仮想サーバを起動する際には，openstack.checkInstanceStateEnabledIntervalプロパティに指定した秒数待ってインスタンスの状態を確認する動作を，openstack.checkInstanceStateEnabledCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)OpenStackサーバの前提製品

　・OpenStack

(2)インスタンスを管理する仮想化環境

　・Kernel-based Virtual Machine

　・VMware vCenter Server

　・VMware vSphere ESXi

(3)OpenStack操作サーバ

　・Microsoft .Net Framework 3.5以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1)インスタンスの前提OS

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(2)OpenStack操作サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

(1)インスタンスに関する条件

　・同一プロジェクト内でインスタンス名が重複しないこと。

　・インスタンスが停止していること。

　・ネットワーク接続確認を実行する場合，対象となる仮想サーバのファイアーウォールがICMP(ECHO)応答を許可していること。

(2)ローカルサーバに関する条件

　・ネットワーク接続確認を実行する場合，エージェントレス接続先としてローカルサーバ("localhost"で解決されるループバックアドレス)を設定する必要があります。

注意事項

(1)ネットワーク接続確認を実施する場合は，インスタンスのすべてのNICに設定されているIPアドレス(IPv4)の長さの合計を1024文字以内(※1)にして設定してください。IPアドレス(IPv4)の長さの合計が1024文字を超えると，osSendIcmp部品でエラーが発生し，タスクが異常終了する場合があります。

※IPアドレス(IPv4)1つの最大の長さは16文字(IPアドレス連結用の「,(コンマ)」を含む)。

(2)ネットワーク接続確認を実行する場合，common.icmpEchoTimeoutプロパティは利用している環境に応じて調整してください。

(3)openstack.waitTimeプロパティの値はデフォルトを推奨します。ただし，プロパティに指定した待機処理時間が短いと，OS起動の完了前に次のステップが実行されて，タスクが異常終了する場合があります。

実行権限

(1)OpenStackサーバにログインするユーザーに次の権限が必要です。

admin権限

(2)ローカルホストで部品を実行するユーザーに次の権限が必要です。

ビルトイン Administrator

バージョン

03.00.00

タグ

Control VM,OpenStack

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

クラウド基盤環境情報

OpenStackの情報を指定してください。

表示されます。

インスタンス情報

インスタンスの情報を指定してください。

表示されます。

ネットワーク接続確認

インスタンスを起動したあとのネットワーク接続確認に関するプロパティです。必要に応じて変更してください。

表示されません。

実行時オプション

インスタンスを起動する際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

openstack.targetHost

OpenStack操作サーバのホスト名

OpenStack操作サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

クラウド基盤環境情報

openstack.identityServerHostName

Identityサーバのホスト名

Identityサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

クラウド基盤環境情報

openstack.userName

Identityサーバにログインするためのユーザー名

Identityサーバにログインするためのユーザー名を指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.password

Identityサーバにログインするためのパスワード

Identityサーバにログインするためのパスワードを指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.protocol

Identityサーバ接続用プロトコル

Identityサーバに接続するためのプロトコルを指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.portNumber

Identityサーバ接続用ポート番号

Identityサーバに接続するためのポート番号を指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.projectName

プロジェクト名

プロジェクトの名称を指定します。

入力

無効

○　

インスタンス情報

openstack.waitTime

IPアドレス取得開始までの待機時間

ネットワーク接続確認を実行する場合，インスタンスの起動が完了してからIPアドレス取得を開始するまでの待機時間を秒単位で指定します。

入力

無効

○　

ネットワーク接続確認

common.icmpEchoTimeout

ICMPエコー要求のタイムアウト時間

仮想サーバの起動確認で実施する，ICMPエコー要求に対する応答を待つ時間をミリ秒単位で指定します。

入力

無効

○　

ネットワーク接続確認

openstack.checkInstanceStateEnabledCount

インスタンスの状態(起動完了)の確認回数

インスタンスの起動が完了したか確認する際の確認回数を指定します。インスタンスの状態(起動完了)の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

openstack.checkInstanceStateEnabledInterval

インスタンスの状態(起動完了)の確認間隔

インスタンスの起動が完了したか確認する際の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

openstack.foreachInstanceName

インスタンス名(複数指定可)

インスタンスの名称を指定します(OpenStackにおけるインスタンスの表示名称です。OS上のホスト名ではありません)。複数指定する場合はコンマで区切ってください。99個まで指定できます。

入力

無効

○　

インスタンス情報

openstack.checkNetworkConnection

ネットワーク接続確認の実行

インスタンスの起動後にネットワーク接続確認を実行するかどうかを指定します。

入力

無効

○　

ネットワーク接続確認

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

openstack.targetHost

256文字以内の半角英数字および「.」，「-」。

openstack.identityServerHostName

256文字以内の半角英数字および「.」，「-」。

openstack.userName

64文字以内の半角英数字。

openstack.password

256文字以内の半角英数字。

openstack.protocol

次の値のどれかを選択する。

http,https

openstack.portNumber

1〜65535の整数値。

openstack.projectName

80文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

openstack.waitTime

0〜2147483647の整数値。

common.icmpEchoTimeout

1〜2147483647の整数値。

openstack.checkInstanceStateEnabledCount

1〜2147483647の整数値。

openstack.checkInstanceStateEnabledInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

openstack.foreachInstanceName

1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

openstack.checkNetworkConnection

次の値のどれかを選択する。

yes,no

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

インスタンス数分繰り返し処理

インスタンス数分繰り返し処理

繰り返し実行部品

指定されたインスタンスの数だけ起動処理を繰り返します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.13.3　仮想サーバの起動(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

インスタンスの状態取得

openstackGetVMState

仮想サーバの状態取得

OpenStack環境において，インスタンスの状態を取得します。

タスクログを確認し，エラーの原因を取り除いたあと，このサービスを再実行してください。

2

インスタンスの起動

openstackPowerOnVM

階層フロー部品

OpenStack環境において，インスタンスを起動します。

−　

2-1

値判定分岐部品

インスタンスが「ACTIVE」状態であるかを判定します。

タスクログを確認し，エラーの原因を取り除いたあと，このサービスを再実行してください。

2-2

仮想サーバの起動

インスタンスが「SHUTOFF」状態である場合，インスタンスを起動します。

タスクログを確認し，エラーの原因を取り除いたあと，このサービスを再実行してください。

3

ネットワーク接続確認

openstackCheckNetwork

階層フロー部品

ネットワークが接続されているかを確認します。

−　

3-1

値判定分岐部品

ネットワーク接続確認にyesが指定されているかを判定します。

タスクログを確認し，エラーの原因を取り除いたあと，このサービスを再実行してください。

3-2

階層フロー部品

ネットワーク接続確認にyesが指定されている場合，ネットワーク接続確認を実施します。

−　

3-2-1

実行待機

IPアドレス取得開始までの待機処理を実施します。

−　

3-2-2

仮想サーバのIPアドレス取得

起動完了したインスタンスのIPアドレスを取得します。

タスクログを確認し，エラーの原因を取り除いたあと，このサービスを再実行してください。

3-2-3

ICMPエコー要求メッセージの送信

起動完了したインスタンスにICMPエコー要求を発行します。

システム環境の状態によっては，インスタンスの起動には成功するが，ネットワークの接続確認に失敗し，タスクが異常終了する場合があります。インスタンスが起動しているか確認してください。サービスを再実行する場合は，注意事項を確認し，エラー原因を取り除いたあとで実行してください。

3.13.4　仮想サーバの情報一覧取得

機能

このサービステンプレートは，OpenStack管理下のKVM環境の，指定したプロジェクトに含まれるインスタンス情報一覧を取得します。

このドキュメント内で使用しているOpenStackに関する用語は，OpenStackのDashboardで使用されている表示名です。OpenStackに関する用語を次に示します。

・Identity

　OpenStackではIdentityまたはKeyStoneと記載されています。

・プロジェクト

　OpenStackではプロジェクトまたはテナントと記載されています。

このサービステンプレートが前提とするサーバを次に示します。

・OpenStackサーバ

　OpenStackがインストールされているサーバです。

・KVMサーバ

　Kernel-based Virtual Machineがインストールされているサーバです。

・OpenStack操作サーバ

　OpenStackサーバにREST-APIを実行するサーバです。

・インスタンス

　OpenStackサーバおよびKVMによって管理されているインスタンスです。一般的な仮想サーバのことです。

処理の概要を次に示します。

(1) インスタンスの情報一覧を取得します。

　1. インスタンスの情報一覧をCSV形式で指定されたリモートのファイルに出力します。出力ファイルのエンコード形式は，OpenStack操作サーバのデフォルトエンコーディングです。

(2) リモートの一時ファイルを指定されたローカルの出力ファイルに転送します。

(3) リモートの一時ファイルを削除します。

出力するCSVファイルの項目を次に示します。

項目はコンマ区切りで出力します。

(a) Hypervisorのホスト名 (ヘッダー名：HostName)

(b) インスタンス名 (ヘッダー名：InstanceName)

(c) イメージ名 (ヘッダー名：ImageName)

(d) インスタンスの状態 (ヘッダー名：Status)

(e) インスタンスのCPU数※ (ヘッダー名：NumCpu)

(f) インスタンスのメモリ容量(MB)※ (ヘッダー名：MemoryMB)

(g) インスタンスのディスクサイズ(GB)※ (ヘッダー名：TotalDiskOfFlavorGB)

(h) フレーバー名 (ヘッダー名：FlavorName)

注※：「インスタンスのCPU数」「インスタンスのメモリ容量(MB)」「インスタンスのディスクサイズ(GB)」はインスタンスの起動時に指定したフレーバーの情報です。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)OpenStackサーバの前提製品

　・OpenStack

(2)インスタンスを管理する仮想化環境

　・Kernel-based Virtual Machine

　・VMware vCenter Server

　・VMware vSphere ESXi

(3)OpenStack操作サーバ

　・Microsoft .Net Framework 3.5以降

【サービステンプレート実行システム内前提製品の稼働OS】

(1)インスタンスの前提OS

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(2)OpenStack操作サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter

　・Windows Server 2012 R2 Standard/Datacenter

　ただし，Server Coreインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

なし。

注意事項

(1)リモートおよびローカルに指定するファイル名が既に存在する場合，既存のファイルを上書きします。また，リモート側のファイルは削除します。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(2)リモートに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

(3)同名のインスタンスが2つ以上ある場合，出力するCSVファイルではインスタンスを特定できません。

実行権限

admin権限

バージョン

02.00.00

タグ

Gather VM information,OpenStack

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

クラウド基盤環境情報

OpenStackの情報を指定してください。

表示されます。

出力ファイル格納情報

出力ファイルの格納先を指定してください。

表示されます。

インスタンス情報

インスタンスの情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

openstack.targetHost

OpenStack操作サーバのホスト名

OpenStack操作サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

クラウド基盤環境情報

openstack.identityServerHostName

Identityサーバのホスト名

Identityサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

クラウド基盤環境情報

openstack.userName

Identityサーバにログインするためのユーザー名

Identityサーバにログインするためのユーザー名を指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.password

Identityサーバにログインするためのパスワード

Identityサーバにログインするためのパスワードを指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.protocol

Identityサーバ接続用プロトコル

Identityサーバに接続するためのプロトコルを指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.portNumber

Identityサーバ接続用ポート番号

Identityサーバに接続するためのポート番号を指定します。

入力

無効

○　

クラウド基盤環境情報

openstack.projectName

プロジェクト名

プロジェクトの名称を指定します。

入力

無効

○　

インスタンス情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

openstack.listOutputFileNameRemote

出力ファイル名(リモート)

インスタンス情報をOpenStack操作サーバに出力する際の一時ファイル名をフルパスで指定します。

入力

無効

○　

出力ファイル格納情報

openstack.listOutputFileNameLocal

出力ファイル名(ローカル)

インスタンス情報を取得するローカルサーバのファイル名をフルパスで指定します。

入力

無効

○　

出力ファイル格納情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

openstack.targetHost

256文字以内の半角英数字および「.」，「-」。

openstack.identityServerHostName

256文字以内の半角英数字および「.」，「-」。

openstack.userName

64文字以内の半角英数字。

openstack.password

256文字以内の半角英数字。

openstack.protocol

次の値のどれかを選択する。

http,https

openstack.portNumber

1〜65535の整数値。

openstack.projectName

80文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」，「¥」を除く。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

openstack.listOutputFileNameRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「'」，「[」，「]」，「`」および末尾の「¥」を除く。

openstack.listOutputFileNameLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの情報一覧取得

仮想サーバの情報一覧取得

仮想サーバの情報一覧取得

仮想サーバの情報一覧をOpenStack操作サーバの一時ファイルに出力します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

ファイル転送

ファイル転送

ファイル転送部品

リモートの一時ファイルをローカルの指定された出力ファイルに転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

一時ファイル削除

一時ファイル削除

ファイル削除

リモートの一時ファイルを削除します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.14　OS（構築）用のサービステンプレート

3.14.1　Windows更新プログラムのインストール

機能

このサービステンプレートは，CSV(Comma Separated Values)ファイルまたはMicrosoft Excelによって作成されたOSを更新するマシンの一覧情報(これ以降，OS更新情報ファイルと呼びます)を使用して，Windows Update機能による更新プログラムの自動インストールを行います。

更新プログラムの自動インストール実行したあとは，除外リスト，更新プログラムの検索結果，インストールした更新プログラム，インストールできなかった更新プログラムの結果情報をファイル(これ以降，結果情報ファイルと呼びます)に出力します。

このサービステンプレートが前提とするサーバを次に示します。

・更新情報ファイルサーバ

　OS更新情報ファイルが格納されたWindowsサーバです。

・実行対象サーバ

　前提条件に記載されたバージョンのWindowsがインストールされたサーバです。

処理の概要を次に示します。

(1) OS更新情報ファイルから，更新を行う実行対象サーバの情報を取得します。

　以降の処理は取得した対象数分繰り返します。

(2) 実行対象サーバに対し，次の条件をすべて満たす更新プログラムを検索します。

　・Microsoftが自動更新の対象としている更新プログラム

　・未インストールの更新プログラム

　・インストール済みソフトウェアの更新プログラム

(3) 検索した結果から次の対象を除外します。

　・除外リストに該当(完全一致)する更新プログラム番号を持つ更新プログラム

　・ユーザー入力が必要な更新プログラム(例:サービスパック等)

(4) (2)と(3)の結果よりWindows Updateから必要な更新プログラムをダウンロードします。

(5) (4)でダウンロードした更新プログラムをインストールします。

　また，OS.updateResultOutputFolderNameRemoteプロパティに指定する実行対象サーバ上のフォルダに，結果情報ファイルをテキストファイルとして出力します。ファイル名は「<年月日時分>.txt」です。

　例:201312312345.txt

このサービステンプレートで使用するファイルの留意点を次に示します。

・OS.updateInfoFilePathプロパティに指定するOS更新情報ファイルの指定方法を次に示します。

　指定する項目は次の通りです。

　・N列目

　　実行対象サーバ：IPアドレス，もしくはホスト名を記載します。IPv6アドレスには対応していません。

　　OS.updateServerInfoColumnプロパティに列番号Nを指定します。

　・M列目

　　除外リスト：インストールしない更新プログラム番号(完全一致)を記載します。更新プログラム番号が複数ある場合は，コンマ区切りで記載します。コンマも含めて1024バイト以下で記載してください。

　　OS.updateExcludeListColumnプロパティに列番号Mを指定します。

　NおよびMは，CSVファイルの左から数えた列の番号またはExcelファイルの左から見て最初にデータが記述されている列から数えた列の番号を1〜255の値で指定します。

　例：(N=1，M=2の場合)

　　"実行対象サーバ","除外リスト"

　　"host001","KB000001,KB000002"

　　"host002",""

・OS.updateResultOutputFolderNameRemoteプロパティに指定した実行対象サーバ上のフォルダに出力されるファイルの内容について，次に示します。

　(a)ホスト名

　(b)除外リスト

　(c)検索結果の更新プログラムタイトル一覧

　　検索結果は，1更新プログラムごとに1行記述されます。

　　各プログラムごとに，その更新プログラムがadding(インストール対象)なのか，skipping(インストール非対象)なのかが記述されています。

　　skippingの場合は，ユーザー入力が必要なためなのか，除外リストによって除外されたためなのか，その理由が記述されています。

　(d)更新プログラムインストール全体のResultCode

　　ResultCodeの意味は次のとおりです。

　　　0:インストール処理未実行 1:インストール処理中 2:正常終了 3:処理は完了したが一部エラー 4:インストール処理エラー 5:インストール処理キャンセル

　(e)インストールした更新プログラムタイトル一覧

　　各プログラムごとに，更新プログラムのResultCodeが記述されています。

　(f)再起動要否

　　再起動について必要(Necessary)か不必要(Unnecessary)かが記述されています。

　(g)スクリプト自体の終了コード

　　スクリプト自体の終了コードが出力されます。

　　終了コードの意味は次のとおりです。

　　　0:正常　27:異常(エラー内容はタスクログで確認)　41:異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

　(h)検索したが除外された，もしくはインストール処理がエラーになったためインストールできなかった更新プログラムのタイトル

OS更新情報ファイル読み込みに失敗した場合は，OS.fileOpenRetryIntervalプロパティに指定した秒数待ってファイル読み込みをリトライする処理を，OS.fileOpenRetryCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

JP1/AOサーバ，実行対象サーバのOSがWindowsの場合，このサービステンプレートの実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。各サーバにadministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行うサービス「Windows更新プログラムのインストール(SYSTEM)」を実行してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

　更新情報ファイルサーバに，次に示すMicrosoft社のプログラムがインストールされていること。

　　・2007 Office system ドライバ，または

　　　Microsoft Access データベース エンジン 2010（32bit版），または

　　　Microsoft Access Database Engine 2016（32bit版）

【サービステンプレート実行システム内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

　(1)実行対象サーバが起動していること。

　(2)実行対象サーバがプロキシサーバーを使用せずにWindows Update機能を行うためのWebサイトにアクセス可能であること。

　(3)実行対象サーバがInternet Explorer(ブラウザー)からWindows Update機能を行うためのWebサイトにアクセス可能であること。

　(4)次に示すサービスが起動していること。

　　・Windows Update

　(5)更新情報ファイルサーバ上に，次に示す内容を記載したOS更新情報ファイルを格納していること。

　　・列数

　　　最初に列名またはデータが記述されている列から数えた列数が255列以内となるようにしてください。

　　・列名

　　　・CSVファイルの場合

　　　　・列名が必要な場合は，ファイルの1行目に記載してください。なお，列名が不要の場合は，列名の記載は必要ありません。

　　　　・列名の記載有無に関わらず，データの読み取り開始行は2行目からとなります。

　　　・Excelファイルの場合

　　　　・列名は必ず記載してください。1行目以降で最初に記述がある行が列名となります。

　　　　・データの読み取り開始行は列名が記載されている行の次の行からとなります。

　　　列名の指定の際は(7)を参照してください。

　　・実行対象サーバ情報

　　　OS更新情報ファイルの各行でユニークなキー情報を格納した列です。キー情報の内容はホスト名またはIPアドレスです。キー情報には「"」および「'」以外の文字を使用してください。「すべてのキー情報の合計バイト数＋データの行数」が1017バイト以下になるようにしてください。各行への値の指定は任意です。省略した場合，該当する行は処理されません。

　　・除外リスト情報

　　　インストールしない更新プログラムの更新プログラム番号(例:KB9999999)を格納した列です。更新プログラム番号が完全一致した更新プログラムを除外します。複数ある場合はコンマ「,」区切りで記述します。各行への値の指定は任意です。

　(6)このサービスを実行する場合，エージェントレス接続先として更新情報ファイルサーバおよび実行対象サーバを設定する必要があります。更新情報ファイルサーバとしてローカルサーバを使用する場合，"localhost"で解決されるループバックアドレスを設定する必要があります。

　(7)OS更新情報ファイルに列名を指定する際は次に示す内容を指定してください。

　　・必ず文字列で指定してください。数値データは指定しないでください。

　　・次の文字は列名に使用できません。

　　　・キー情報の列名の先頭には次の文字を使用できません。

　　　　「!」「"」「#」「$」「%」「&」「'」「(」「)」「-」「=」「^」「~」「¥」「|」「`」「;」「+」「*」「[」「]」「{」

　　　　「}」「,」「.」「<」「>」「?」「_」「/」「0」「1」「2」「3」「4」「5」「6」「7」「8」「9」「０」「１」「２」

　　　　「３」「４」「５」「６」「７」「８」「９」

　　　・キー情報の列名の2文字目以降には次の文字を使用できません。

　　　　「"」「#」「%」「&」「'」「(」「)」「-」「=」「^」「~」「¥」「|」「@」「;」「:」「+」「*」「[」「]」「{」「}」

　　　　「,」「.」「<」「>」「?」「/」

　　　・キー情報以外の列名には次の文字を使用できません。

　　　　「!」「[」「]」「`」「,」「.」

　　　・文字数は半角全角混合で64文字まで指定できます。

注意事項

【OS更新情報ファイルに関する注意事項】

(1)Excelファイルのセルが結合されている場合，数式がエラーとなっているときは取得される値が空になります。また，書き込みパスワードが設定されているときはタスクが異常終了します。OS更新情報ファイルからはこれらの状態を取り除いてください。

(2)読み取る列は，文字列型データと数値型データを混在させないでください。混在していると，ODBCドライバの仕様によって，正常に値を取得できない場合があります。

　(a)数値型データとは次の形式の文字列のことです。

　　　符号付き整数値(10 進数) 例：-12345

　　　固定小数点数(10 進数) 　例：3.1415

　　　浮動小数点数(10 進数) 　例：6.543E+10

　(b)文字列型データとは上の数値型以外の形式の文字列のことです。

(3)異なるデータ型が混在する列を取得する場合は，次の対処が必要です。

　・Excelファイルの場合は数値型データの先頭に「'」を付けてください。

　・CSVファイルの場合は数値型データを「""」で囲んでください。

(4)OS更新情報ファイルがCSVファイルである場合，IPアドレスは「""」で囲んでください。「""」で囲まない場合，数値型データとして誤認識され，正常に値を取得できないことがあります。

(5)データの途中に空白行がある場合，空白行も行数としてカウントされます。データが記述された行が99行以内であっても，途中の空白行を含めた行数が100以上となる場合，タスクが異常終了するのでご注意ください。

(6)OS更新情報ファイルがExcelファイルの場合，セルに記述されたデータのデータ型によっては，表示されている値と実際に取得される値が異なる場合があります。次のデータ型のデータを記述している場合はご注意ください。

　(a)Boolean 型(True/False)

　　　表示される値：TRUE/FALSE

　　　セルに記述されている値：TRUE/FALSE

　　　実際に取得される値：True/False

　(b)日付データ

　　　表示される値：mm 月dd 日

　　　セルに記述されている値：yyyy/mm/dd

　　　実際に取得される値：yyyy/mm/dd

　(c)時刻データ

　　　表示される値：hh:mm

　　　セルに記述されている値：hh:mm:ss

　　　実際に取得される値：hh:mm:ss

　(d)パーセント

　　　表示される値：〜%(例：10%)

　　　セルに記述されている値：〜%(例：10%)

　　　実際に取得される値：0.〜(例：0.1)

　(e)数式

　　　表示される値：(数式の結果)

　　　セルに記述されている値：(数式)

　　　実際に取得される値：(数式の結果)

【OS更新情報ファイル以外の注意事項】

(1)自動的に再起動する更新プログラムをインストールした場合，Windowsによって実行対象サーバが自動で再起動します。

(2)このサービスを同一の実行対象サーバに対して多重実行しないでください。

(3)「実行対象サーバの列番号」プロパティには255以内の整数値を指定してください。256以上の値を指定するとタスクが異常終了します。途中の空白列も列数に含まれますのでご注意ください。

実行権限

ビルトイン Administrator

バージョン

03.00.02

タグ

Configure OS,Windows

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

OS更新情報ファイルの情報

OS更新情報ファイルの情報を指定してください。

表示されます。

OS更新情報ファイルの詳細

OS更新情報ファイルの詳細情報を指定してください。

表示されます。

結果情報ファイル出力先フォルダの情報

結果情報ファイルを出力するフォルダ名を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

windows.targetHost

更新情報ファイルサーバのホスト名

OS更新情報ファイルを格納したWindowsサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

OS更新情報ファイルの情報

OS.fileOpenRetryCount

ファイル読み込み時のリトライ回数

OS更新情報ファイルの読み込みに失敗した場合のリトライ回数を指定します。ファイル読み込み時のリトライ間隔と組み合わせて最大待ち時間となります。"0"を指定した場合はリトライしません。

入力

無効

○　

OS更新情報ファイルの詳細

OS.fileOpenRetryInterval

ファイル読み込み時のリトライ間隔

OS更新情報ファイルの読み込みに失敗した場合のリトライ間隔を秒単位で指定します。

入力

無効

○　

OS更新情報ファイルの詳細

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

OS.updateInfoFilePath

OS更新情報ファイルのパス

更新情報ファイルサーバ上に格納した，OS更新情報を記入したファイルのパスをフルパスで指定します。ファイルの拡張子はcsv，xls，xlsx，xlsmのどれかである必要があります。

入力

無効

○　

OS更新情報ファイルの情報

OS.updateInfoSheetName

OS更新情報ファイルのシート名

OS更新情報が記載されたシート名を指定します。OS更新情報ファイルがExcelファイルの場合には必ず指定してください。CSVファイルの場合，指定しても無視されます。

入力

無効

○　

OS更新情報ファイルの情報

OS.updateServerInfoColumn

実行対象サーバの列番号

OS更新情報ファイル内の「実行対象サーバ」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

○　

OS更新情報ファイルの詳細

OS.updateExcludeListColumn

除外リストの列番号

OS更新情報ファイル内の「除外リスト」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

○　

OS更新情報ファイルの詳細

OS.updateResultOutputFolderNameRemote

結果情報ファイル出力フォルダ名(リモート)

更新プログラムの自動インストール処理結果を出力する，実行対象サーバ上のフォルダ名をフルパスで指定します。

入力

無効

○　

結果情報ファイル出力先フォルダの情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

windows.targetHost

256文字以内の半角英数字および「.」，「-」。

OS.fileOpenRetryCount

0〜32767の整数値。

OS.fileOpenRetryInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

OS.updateInfoFilePath

8文字以上255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「[」，「]」，「!」および末尾の「¥」を除く。

OS.updateInfoSheetName

1文字以上31文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「:」，「&」，「*」，「?」，「"」，「%」，「/」，「¥」，「!」，「`」，「{」，「[」，「]」および全角記号「：」，「￥」，「？」，「［」，「］」，「／」，「＊」を除く。

OS.updateServerInfoColumn

1〜255の整数値。

OS.updateExcludeListColumn

1〜255の整数値。

OS.updateResultOutputFolderNameRemote

200文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

OS更新情報ファイルの列読み取り

OS更新情報ファイルの列読み取り

CSV・Excelの列データ取得

OS更新情報ファイルから行を特定するための情報を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

ホスト数分繰り返し処理

ホスト数分繰り返し処理

繰り返し実行部品

指定されたホストの数だけ更新処理を繰り返します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.14.2　Windows更新プログラムのインストール(繰り返しフロー）

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

OS更新情報ファイルの行読み取り

osReadCSVExcelFileRow

CSV・Excelの行データ取得

OS更新情報ファイルから実行対象サーバの情報を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

Windows更新プログラムのインストール

osWindowsUpdate

Windows更新プログラムのインストール

Windows Updateを実行します。

エラーの原因を取り除いてください。結果情報ファイルを参照し，必要に応じてサービスを再実行してください。

3.14.3　Windows更新プログラムのインストール(SYSTEM)

機能

このサービステンプレートは，CSV(Comma Separated Values)ファイルまたはMicrosoft Excelによって作成されたOSを更新するマシンの一覧情報(これ以降，OS更新情報ファイルと呼びます)を使用して，Windows Update機能による更新プログラムの自動インストールを行います。

更新プログラムの自動インストール実行したあとは，除外リスト，更新プログラムの検索結果，インストールした更新プログラム，インストールできなかった更新プログラムの結果情報をファイル(これ以降，結果情報ファイルと呼びます)に出力します。

このサービステンプレートが前提とするサーバを次に示します。

・更新情報ファイルサーバ

　OS更新情報ファイルが格納されたWindowsサーバです。

・実行対象サーバ

　前提条件に記載されたバージョンのWindowsがインストールされたサーバです。

処理の概要を次に示します。

(1) OS更新情報ファイルから，更新を行う実行対象サーバの情報を取得します。

　以降の処理は取得した対象数分繰り返します。

(2) 実行対象サーバに対し，次の条件をすべて満たす更新プログラムを検索します。

　・Microsoftが自動更新の対象としている更新プログラム

　・未インストールの更新プログラム

　・インストール済みソフトウェアの更新プログラム

(3) 検索した結果から次の対象を除外します。

　・除外リストに該当(完全一致)する更新プログラム番号を持つ更新プログラム

　・ユーザー入力が必要な更新プログラム(例:サービスパック等)

(4) (2)と(3)の結果よりWindows Updateから必要な更新プログラムをダウンロードします。

(5) (4)でダウンロードした更新プログラムをインストールします。

　また，OS.updateResultOutputFolderNameRemoteプロパティに指定する実行対象サーバ上のフォルダに，結果情報ファイルをテキストファイルとして出力します。ファイル名は「<年月日時分>.txt」です。

　例:201312312345.txt

このサービステンプレートで使用するファイルの留意点を次に示します。

・OS.updateInfoFilePathプロパティに指定するOS更新情報ファイルの指定方法を次に示します。

　指定する項目は次の通りです。

　・N列目

　　実行対象サーバ：IPアドレス，もしくはホスト名を記載します。IPv6アドレスには対応していません。

　　OS.updateServerInfoColumnプロパティに列番号Nを指定します。

　・M列目

　　除外リスト：インストールしない更新プログラム番号(完全一致)を記載します。更新プログラム番号が複数ある場合は，コンマ区切りで記載します。コンマも含めて1024バイト以下で記載してください。

　　OS.updateExcludeListColumnプロパティに列番号Mを指定します。

　NおよびMは，CSVファイルの左から数えた列の番号またはExcelファイルの左から見て最初にデータが記述されている列から数えた列の番号を1〜255の値で指定します。

　例：(N=1，M=2の場合)

　　"実行対象サーバ","除外リスト"

　　"host001","KB000001,KB000002"

　　"host002",""

・OS.updateResultOutputFolderNameRemoteプロパティに指定した実行対象サーバ上のフォルダに出力されるファイルの内容について，次に示します。

　(a)ホスト名

　(b)除外リスト

　(c)検索結果の更新プログラムタイトル一覧

　　検索結果は，1更新プログラムごとに1行記述されます。

　　各プログラムごとに，その更新プログラムがadding(インストール対象)なのか，skipping(インストール非対象)なのかが記述されています。

　　skippingの場合は，ユーザー入力が必要なためなのか，除外リストによって除外されたためなのか，その理由が記述されています。

　(d)更新プログラムインストール全体のResultCode

　　ResultCodeの意味は次のとおりです。

　　　0:インストール処理未実行 1:インストール処理中 2:正常終了 3:処理は完了したが一部エラー 4:インストール処理エラー 5:インストール処理キャンセル

　(e)インストールした更新プログラムタイトル一覧

　　各プログラムごとに，更新プログラムのResultCodeが記述されています。

　(f)再起動要否

　　再起動について必要(Necessary)か不必要(Unnecessary)かが記述されています。

　(g)スクリプト自体の終了コード

　　スクリプト自体の終了コードが出力されます。

　　終了コードの意味は次のとおりです。

　　　0:正常　27:異常(エラー内容はタスクログで確認)　41:異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

　(h)検索したが除外された，もしくはインストール処理がエラーになったためインストールできなかった更新プログラムのタイトル

OS更新情報ファイル読み込みに失敗した場合は，OS.fileOpenRetryIntervalプロパティに指定した秒数待ってファイル読み込みをリトライする処理を，OS.fileOpenRetryCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

　更新情報ファイルサーバに，次に示すMicrosoft社のプログラムがインストールされていること。

　　・2007 Office system ドライバ，または

　　　Microsoft Access データベース エンジン 2010（32bit版），または

　　　Microsoft Access Database Engine 2016（32bit版）

【サービステンプレート実行システム内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【サービステンプレート実行システム内前提製品の使用条件】

　(1)実行対象サーバが起動していること。

　(2)実行対象サーバがプロキシサーバーを使用せずにWindows Update機能を行うためのWebサイトにアクセス可能であること。

　(3)実行対象サーバがInternet Explorer(ブラウザー)からWindows Update機能を行うためのWebサイトにアクセス可能であること。

　(4)次に示すサービスが起動していること。

　　・Windows Update

　(5)更新情報ファイルサーバ上に，次に示す内容を記載したOS更新情報ファイルを格納していること。

　　・列数

　　　最初に列名またはデータが記述されている列から数えた列数が255列以内となるようにしてください。

　　・列名

　　　・CSVファイルの場合

　　　　・列名が必要な場合は，ファイルの1行目に記載してください。なお，列名が不要の場合は，列名の記載は必要ありません。

　　　　・列名の記載有無に関わらず，データの読み取り開始行は2行目からとなります。

　　　・Excelファイルの場合

　　　　・列名は必ず記載してください。1行目以降で最初に記述がある行が列名となります。

　　　　・データの読み取り開始行は列名が記載されている行の次の行からとなります。

　　　列名の指定の際は(7)を参照してください。

　　・実行対象サーバ情報

　　　OS更新情報ファイルの各行でユニークなキー情報を格納した列です。キー情報の内容はホスト名またはIPアドレスです。キー情報には「"」および「'」以外の文字を使用してください。「すべてのキー情報の合計バイト数＋データの行数」が1017バイト以下になるようにしてください。各行への値の指定は任意です。省略した場合，該当する行は処理されません。

　　・除外リスト情報

　　　インストールしない更新プログラムの更新プログラム番号(例:KB9999999)を格納した列です。更新プログラム番号が完全一致した更新プログラムを除外します。複数ある場合はコンマ「,」区切りで記述します。各行への値の指定は任意です。

　(6)このサービスを実行する場合，エージェントレス接続先として更新情報ファイルサーバおよび実行対象サーバを設定する必要があります。更新情報ファイルサーバとしてローカルサーバを使用する場合，"localhost"で解決されるループバックアドレスを設定する必要があります。

　(7)OS更新情報ファイルに列名を指定する際は次に示す内容を指定してください。

　　・必ず文字列で指定してください。数値データは指定しないでください。

　　・次の文字は列名に使用できません。

　　　・キー情報の列名の先頭には次の文字を使用できません。

　　　　「!」「"」「#」「$」「%」「&」「'」「(」「)」「-」「=」「^」「~」「¥」「|」「`」「;」「+」「*」「[」「]」「{」

　　　　「}」「,」「.」「<」「>」「?」「_」「/」「0」「1」「2」「3」「4」「5」「6」「7」「8」「9」「０」「１」「２」

　　　　「３」「４」「５」「６」「７」「８」「９」

　　　・キー情報の列名の2文字目以降には次の文字を使用できません。

　　　　「"」「#」「%」「&」「'」「(」「)」「-」「=」「^」「~」「¥」「|」「@」「;」「:」「+」「*」「[」「]」「{」「}」

　　　　「,」「.」「<」「>」「?」「/」

　　　・キー情報以外の列名には次の文字を使用できません。

　　　　「!」「[」「]」「`」「,」「.」

　　　・文字数は半角全角混合で64文字まで指定できます。

注意事項

【OS更新情報ファイルに関する注意事項】

(1)Excelファイルのセルが結合されている場合，数式がエラーとなっているときは取得される値が空になります。また，書き込みパスワードが設定されているときはタスクが異常終了します。OS更新情報ファイルからはこれらの状態を取り除いてください。

(2)読み取る列は，文字列型データと数値型データを混在させないでください。混在していると，ODBCドライバの仕様によって，正常に値を取得できない場合があります。

　(a)数値型データとは次の形式の文字列のことです。

　　　符号付き整数値(10 進数) 例：-12345

　　　固定小数点数(10 進数) 　例：3.1415

　　　浮動小数点数(10 進数) 　例：6.543E+10

　(b)文字列型データとは上の数値型以外の形式の文字列のことです。

(3)異なるデータ型が混在する列を取得する場合は，次の対処が必要です。

　・Excelファイルの場合は数値型データの先頭に「'」を付けてください。

　・CSVファイルの場合は数値型データを「""」で囲んでください。

(4)OS更新情報ファイルがCSVファイルである場合，IPアドレスは「""」で囲んでください。「""」で囲まない場合，数値型データとして誤認識され，正常に値を取得できないことがあります。

(5)データの途中に空白行がある場合，空白行も行数としてカウントされます。データが記述された行が99行以内であっても，途中の空白行を含めた行数が100以上となる場合，タスクが異常終了するのでご注意ください。

(6)OS更新情報ファイルがExcelファイルの場合，セルに記述されたデータのデータ型によっては，表示されている値と実際に取得される値が異なる場合があります。次のデータ型のデータを記述している場合はご注意ください。

　(a)Boolean 型(True/False)

　　　表示される値：TRUE/FALSE

　　　セルに記述されている値：TRUE/FALSE

　　　実際に取得される値：True/False

　(b)日付データ

　　　表示される値：mm 月dd 日

　　　セルに記述されている値：yyyy/mm/dd

　　　実際に取得される値：yyyy/mm/dd

　(c)時刻データ

　　　表示される値：hh:mm

　　　セルに記述されている値：hh:mm:ss

　　　実際に取得される値：hh:mm:ss

　(d)パーセント

　　　表示される値：〜%(例：10%)

　　　セルに記述されている値：〜%(例：10%)

　　　実際に取得される値：0.〜(例：0.1)

　(e)数式

　　　表示される値：(数式の結果)

　　　セルに記述されている値：(数式)

　　　実際に取得される値：(数式の結果)

【OS更新情報ファイル以外の注意事項】

(1)自動的に再起動する更新プログラムをインストールした場合，Windowsによって実行対象サーバが自動で再起動します。

(2)このサービスを同一の実行対象サーバに対して多重実行しないでください。

(3)「実行対象サーバの列番号」プロパティには255以内の整数値を指定してください。256以上の値を指定するとタスクが異常終了します。途中の空白列も列数に含まれますのでご注意ください。

実行権限

Administratorsグループに所属するユーザー

バージョン

03.10.02

タグ

Configure OS,Windows

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

OS更新情報ファイルの情報

OS更新情報ファイルの情報を指定してください。

表示されます。

OS更新情報ファイルの詳細

OS更新情報ファイルの詳細情報を指定してください。

表示されます。

結果情報ファイル出力先フォルダの情報

結果情報ファイルを出力するフォルダ名を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

windows.targetHost

更新情報ファイルサーバのホスト名

OS更新情報ファイルを格納したWindowsサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

OS更新情報ファイルの情報

OS.fileOpenRetryCount

ファイル読み込み時のリトライ回数

OS更新情報ファイルの読み込みに失敗した場合のリトライ回数を指定します。ファイル読み込み時のリトライ間隔と組み合わせて最大待ち時間となります。"0"を指定した場合はリトライしません。

入力

無効

○　

OS更新情報ファイルの詳細

OS.fileOpenRetryInterval

ファイル読み込み時のリトライ間隔

OS更新情報ファイルの読み込みに失敗した場合のリトライ間隔を秒単位で指定します。

入力

無効

○　

OS更新情報ファイルの詳細

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

OS.updateInfoFilePath

OS更新情報ファイルのパス

更新情報ファイルサーバ上に格納した，OS更新情報を記入したファイルのパスをフルパスで指定します。ファイルの拡張子はcsv，xls，xlsx，xlsmのどれかである必要があります。

入力

無効

○　

OS更新情報ファイルの情報

OS.updateInfoSheetName

OS更新情報ファイルのシート名

OS更新情報が記載されたシート名を指定します。OS更新情報ファイルがExcelファイルの場合には必ず指定してください。CSVファイルの場合，指定しても無視されます。

入力

無効

○　

OS更新情報ファイルの情報

OS.updateServerInfoColumn

実行対象サーバの列番号

OS更新情報ファイル内の「実行対象サーバ」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

○　

OS更新情報ファイルの詳細

OS.updateExcludeListColumn

除外リストの列番号

OS更新情報ファイル内の「除外リスト」を記述した列番号を指定します。列番号は1から255の整数値で指定してください。

入力

無効

○　

OS更新情報ファイルの詳細

OS.updateResultOutputFolderNameRemote

結果情報ファイル出力フォルダ名(リモート)

更新プログラムの自動インストール処理結果を出力する，実行対象サーバ上のフォルダ名をフルパスで指定します。

入力

無効

○　

結果情報ファイル出力先フォルダの情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

windows.targetHost

256文字以内の半角英数字および「.」，「-」。

OS.fileOpenRetryCount

0〜32767の整数値。

OS.fileOpenRetryInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

OS.updateInfoFilePath

8文字以上255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「[」，「]」，「!」および末尾の「¥」を除く。

OS.updateInfoSheetName

1文字以上31文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「:」，「&」，「*」，「?」，「"」，「%」，「/」，「¥」，「!」，「`」，「{」，「[」，「]」および全角記号「：」，「￥」，「？」，「［」，「］」，「／」，「＊」を除く。

OS.updateServerInfoColumn

1〜255の整数値。

OS.updateExcludeListColumn

1〜255の整数値。

OS.updateResultOutputFolderNameRemote

200文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

OS更新情報ファイルの列読み取り(SYSTEM)

OS更新情報ファイルの列読み取り(SYSTEM)

CSV・Excelの列データ取得(SYSTEM)

OS更新情報ファイルから行を特定するための情報を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

ホスト数分繰り返し処理

ホスト数分繰り返し処理

繰り返し実行部品

指定されたホストの数だけ更新処理を繰り返します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.14.4　Windows更新プログラムのインストール(SYSTEM)(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

OS更新情報ファイルの行読み取り(SYSTEM)

osReadCSVExcelFileRow_System

CSV・Excelの行データ取得(SYSTEM)

OS更新情報ファイルから実行対象サーバの情報を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

Windows更新プログラムのインストール(SYSTEM)

osWindowsUpdate_System

Windows更新プログラムのインストール(SYSTEM)

Windows Updateを実行します。

エラーの原因を取り除いてください。結果情報ファイルを参照し，必要に応じてサービスを再実行してください。

3.15　vSphere（構築）用のサービステンプレート

3.15.1　vCenterサーバ経由でのスクリプト実行

機能

このサービステンプレートは，VMware vSphere環境で，指定した非対話型のスクリプトファイルを実行対象サーバからvCenterサーバ経由で仮想サーバのゲストOSに送信し，ゲストOS上でスクリプトファイルを実行します。その後，不要な場合はスクリプトファイルを削除できます。

このサービステンプレートが前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXiがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。本製品によってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXによって管理されている仮想サーバです。

処理の概要を次に示します。

(1)実行対象サーバでPowerCLIのコマンドレット"Copy-VMGuestFile"を実行して，指定したスクリプトを実行対象サーバから仮想サーバのゲストOSに送信する。

(2)実行対象サーバでPowerCLIのコマンドレット"Invoke-VMScript"を実行して，(1)で送信したスクリプトを実行します。その際，仮想サーバで次に示す実行形式でスクリプトを実行を行います。

・Windows バッチ ファイル(拡張子bat)

　"& 'ゲストOS上のスクリプトファイルパス(vmware.scriptFileOnGuestプロパティ)' 'スクリプトの引数(vmware.scriptParameterプロパティ)' ; exit $LASTEXITCODE"

・Windows PowerShell スクリプト(拡張子ps1)

　"Set-ExecutionPolicy RemoteSigned -Scope Process ; & 'ゲストOS上のスクリプトファイルパス(vmware.scriptFileOnGuestプロパティ)' 'スクリプトの引数(vmware.scriptParameterプロパティ)' ; exit $LASTEXITCODE"

・シェルスクリプト(拡張子sh)

　"/bin/bash 'ゲストOS上のスクリプトファイルパス(vmware.scriptFileOnGuestプロパティ)' 'スクリプトの引数(vmware.scriptParameterプロパティ)' "

仮想サーバで実行したスクリプトの標準出力および標準エラー出力は，スクリプトの出力ファイルパス(vmware.scriptOutputFilePathプロパティ)に指定した，実行対象サーバのファイルパスに出力されます。

(3)スクリプト削除の要否(vmware.deleteScriptEnabledプロパティ)にyesを指定した場合，実行対象サーバから仮想サーバのゲストOSに送信したスクリプトを削除できます。削除する場合，仮想サーバの環境ごとに次に示す形式で削除を行います。

・Windows

　"Remove-Item -LiteralPath 'ゲストOS上のスクリプトファイルパス(vmware.scriptFileOnGuestプロパティ)' -Force "

・UNIX

　"/bin/rm -f 'ゲストOS上のスクリプトファイルパス(vmware.scriptFileOnGuestプロパティ)' "

プロパティ設定の留意点を次に示します。

(1)ゲストOS上のスクリプトファイルパス(vmware.scriptFileOnGuestプロパティ)に指定できるスクリプトファイルは，Windows バッチ ファイル(拡張子bat)，Windows PowerShell スクリプト(拡張子ps1)，シェルスクリプト(拡張子sh)です。

(2)スクリプトの引数(vmware.scriptParameterプロパティ)に複数の引数を使用する場合は，引数と引数の間を","(半角コンマ)か"-"(半角ハイフン)のどちらかで区切ることができます。

詳細については，各部品の仕様を参照してください。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【サービステンプレート実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(2)仮想サーバを管理するVMware vSphere ESXi

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(3)仮想サーバの前提OS

　vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【サービステンプレート実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

【サービステンプレート実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXiがVMware vCenter Serverで管理されていること。

(2)VMware vCenter Server上の設定に関する条件

　・仮想サーバの名称が一意であること。

　・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，この部品が実行するvSphere PowerCLIからは，指定した名称の英字の大文字・小文字を区別できません。

　　- 仮想サーバ名

(3)仮想サーバに関する条件

　・仮想サーバが起動していること。

　・仮想サーバがWindowsの場合，Windows PowerShell 2.0以降がインストールされいること。

　・仮想サーバに，VMwareToolsがインストールされていること。

注意事項

(1)ゲストOS上のスクリプトファイルパス(vmware.scriptFileOnGuestプロパティ)，スクリプトの出力ファイルパス(vmware.scriptOutputFilePathプロパティ)にすでに同名のファイルが存在する場合にはファイルを上書きします。また，ファイルパスに存在しないフォルダが含まれる場合，フォルダを作成してファイルを送信します。これらのフォルダが不要な場合は，削除して下さい。

(2)ゲストOS上のスクリプトファイルパス(vmware.scriptFileOnGuestプロパティ)に同名なフォルダが存在した場合，同名なフォルダの配下に送信元のスクリプトファイル名で格納されます。その場合，スクリプトの実行に失敗し，サービスは異常終了します。

(3)ファイル送信中にエラーが発生した場合，仮想サーバへ送信途中だったファイルは削除されませんので，不要な場合は削除してください。

(4)ユーザーに入力を求める対話式スクリプト，GUI表示などによって自動的に終了しないスクリプトは実行しないでください。

(5)このサービステンプレートを同一の仮想サーバに対して同時に実行しないでください。

(6)VMware vCenter操作サーバ上のスクリプトファイル(vmware.scriptFileOnHostプロパティ)に指定したスクリプトはバイナリ形式でゲストOSに転送されます。そのため，あらかじめゲストOSで実行可能な改行コード・文字コードでスクリプトを作成してください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　システム管理者ロール

バージョン

02.50.00

タグ

Execute Script,VMware vSphere

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

VMware vCenter Serverの情報を指定してください。

表示されます。

仮想サーバ情報

スクリプトを実行する仮想サーバの情報を指定してください。

表示されます。

スクリプト情報

スクリプト実行のための情報を指定してください。

表示されます。

出力ファイル格納情報

出力ファイルの格納先を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.targetHost

VMware vCenter操作サーバのホスト名

VMware vCenter Serverを操作するサーバ(vSphere PowerCLIインストール済みサーバ)のホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

入力

無効

○　

仮想システム環境情報

vmware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

入力

無効

○　

仮想システム環境情報

vmware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

入力

無効

△　

仮想システム環境情報

vmware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

入力

無効

○　

仮想システム環境情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.vmName

仮想サーバ名

仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

仮想サーバ情報

vmware.guestOSUserName

ゲストOSにログインするためのユーザー名

ゲストOSにログインするためのユーザー名を指定します。

入力

無効

○　

仮想サーバ情報

vmware.guestOSUserPassword

ゲストOSにログインするためのパスワード

ゲストOSにログインするためのパスワードを指定します。

入力

無効

○　

仮想サーバ情報

vmware.scriptFileOnHost

VMware vCenter操作サーバ上のスクリプトファイル

送信元となるVMware vCenter操作サーバ上のスクリプトファイルをフルパスで指定します。

入力

無効

○　

スクリプト情報

vmware.scriptFileOnGuest

ゲストOS上のスクリプトファイル

送信先となるゲストOS上のスクリプトファイルをフルパスで指定します。送信後このプロパティに指定したスクリプトファイルを実行します。

入力

無効

○　

スクリプト情報

vmware.scriptParameter

スクリプトの引数

スクリプトの引数を指定します。複数の引数を指定する場合は，スクリプト引数の区切り文字に指定した値(半角コンマまたは半角ハイフン)を引数の間に挿入してください。

入力

無効

△　

スクリプト情報

vmware.scriptParamDelimiter

スクリプト引数の区切り文字

スクリプトの引数の区切り文字を指定します。指定可能な値は","(半角コンマ)または"-"(半角ハイフン)です。省略した場合は，スクリプトの引数に指定した値を1つの引数として扱います。

入力

無効

△　

スクリプト情報

vmware.scriptOutputFilePath

スクリプトの出力ファイルパス

スクリプトの標準出力および標準エラー出力を出力するVMware vCenter操作サーバ上のファイルパスをフルパスで指定します。

入力

無効

○　

出力ファイル格納情報

vmware.deleteScriptEnabled

スクリプト削除の要否

実行後に，スクリプトを削除するかどうかを指定します。「yes」を選択した場合，スクリプトを削除します。「no」を選択した場合，スクリプトを削除しません。

入力

無効

○　

スクリプト情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.scriptReturnCode

スクリプトの戻り値

仮想サーバで実行したスクリプトの戻り値が格納されます。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.targetHost

256文字以内の半角英数字および「.」，「-」。

vmware.vCenterServerName

256文字以内の半角英数字および「.」，「-」。

vmware.userName

512文字以内の半角英数字および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「%」を除く。

vmware.password

127文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.portNumber

1〜65535の整数値。

vmware.protocol

次の値のどれかを選択する。

http,https

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.vmName

60文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」を除く。

vmware.guestOSUserName

32文字以内の半角英数字。および「!」，「#」，「$」，「(」，「)」，「-」，「.」，「^」，「_」，「`」，「{」，「}」，「~」。

vmware.guestOSUserPassword

255文字以内の文字列。ただし「<」，「>」，「|」，「"」，「'」，「;」，「&」を除く。

vmware.scriptFileOnHost

256文字以内の半角英数字。および「.」，「¥」，「:」。ただし，末尾の「¥」を除く。

vmware.scriptFileOnGuest

256文字以内の半角英数字。および「.」，「/」，「¥」，「:」。ただし，末尾の「¥」，「/」を除く。

vmware.scriptParameter

1024文字以内の半角英数字。および「.」，「/」，「¥」，「:」，「,」，「-」。

vmware.scriptParamDelimiter

次の値のどれかを選択する。

,,-

vmware.scriptOutputFilePath

256文字以内の半角英数字。および「.」，「¥」，「:」。ただし，末尾の「¥」を除く。

vmware.deleteScriptEnabled

次の値のどれかを選択する。

yes,no

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

vCenterサーバ経由でのスクリプト送信

vCenterサーバ経由でのスクリプト送信

vCenterサーバ経由でのファイル送信

指定したファイルを実行対象サーバから仮想サーバのゲストOSに送信します。

エラーの原因を取り除いたあと，サービスを再実行して下さい。

2

vCenterサーバ経由でのスクリプト実行

vCenterサーバ経由でのスクリプト実行

vCenterサーバ経由でのスクリプト実行

仮想サーバのゲストOS上に送信された非対話型のスクリプトファイルを実行します。

エラーの原因を取り除いたあと，このステップから実行するかサービスを再実行して下さい。

3

スクリプト削除要否確認

スクリプト削除要否確認

値判定分岐部品

仮想サーバのゲストOS上に送信されたスクリプトファイルを削除するかを判定します。

−　

4

vCenterサーバ経由でのスクリプト削除

vCenterサーバ経由でのスクリプト削除

vCenterサーバ経由でのファイル削除

仮想サーバのゲストOS上に送信されたスクリプトファイルを削除します。

エラーの原因を取り除いたあと，このステップから実行するかサービスを再実行して下さい。

3.15.2　仮想サーバスペック変更(CPU，メモリ)

機能

VMware vSphere環境の仮想サーバのリソース(CPU，メモリ，ディスクI/O)に関して，指定のあった項目の設定を変更します。

CPU数とは，VMware vCenter Server 4.1以前では仮想プロセッサ数，VMware vCenter Server 5.0以降では仮想ソケット数×ソケット当たりのコア数を指します。11-11以前では「ソケット当たりのコア数」は1固定のため，CPU数は仮想ソケット数と同じ値でしたが，11-12以降では「ソケット当たりのコア数」を変更可能です。変更する場合は，コア数設定オプション(vmware.setCoresOptionプロパティ)に"true"を指定してください。

また，上記の理由によって，vmware.cpuNumプロパティの表示名を変更しています。11-11以前では「CPU数」でしたが，11-12以降では「CPUソケット数」としています。

このサービステンプレートが前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ

　VMware vSphere PowerCLIがインストールされているサーバです。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXi(またはVMware ESX Server)によって管理されている仮想サーバです。

処理の概要を次に示します。

(1) 仮想サーバの電源状態を取得します。

(2) 仮想サーバの電源状態がOFFになっていることを確認します。

　電源状態がOFFでない場合は，ユーザー応答待ち部品を実行して，電源をOFFにするか・しないかを確認します。

　ユーザー応答待ち部品のメール送信先/送信内容，タイムアウト，画面表示内容はModify権限のユーザーが設定できます。

　ユーザー応答待ちのGUIで"Shutdown"を選択した場合は，仮想サーバのシャットダウンを行います。

　"Cancel"を選択するか，応答待ちがタイムアウトになった場合は，仮想サーバには操作を行なわずにサービスが異常終了します。

　仮想サーバを停止する際には，vmware.checkPowerStateIntervalプロパティに指定した秒数待ち合わせ，電源状態がOFFになることを確認する動作を，vmware.checkPowerStateCountプロパティに指定した回数繰り返します。デフォルトの値で不都合がある場合，利用している環境に合わせて調整してください。

(3) 仮想サーバのリソース(CPU数，メモリ容量)を変更します。

(4) 仮想サーバのCPU，メモリについて「制限」「予約」「シェアレベル」を，ディスクについて「シェアレベル」を設定します。

　制限を解除する場合は，-1を指定してください。

　制限についてCPUは100MHz未満，メモリは100MB未満を指定するとタスクの実行が異常終了します。制限が低すぎると，OSの起動や業務の実行に影響が考えられます。OSのシステム要件や用途にあわせてリソースの制限を設定してください。

　メモリの予約では仮想サーバに割り当てられているメモリ容量以内の値を指定してください。割り当てられているより多くのメモリ容量を指定するとタスクの実行が異常終了します。

　ディスクのシェアレベルを指定する場合，仮想ディスク名を省略すると仮想サーバに接続されているすべてのディスクのシェアレベルを変更します。仮想ディスク名を指定することで，指定した仮想ディスクのシェアレベルを変更することができます。

なお，仮想サーバ名プロパティ(vmware.vmName)に指定できる最大の文字数は60文字です。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)vCenter操作サーバの前提製品

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【サービステンプレート実行システム内前提製品の稼働OS】

(1)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)(vCenter4.1以降。vCenter4.0では未サポート)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

(2)vCenter操作サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

【サービステンプレート実行システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)仮想サーバ名はvCenterサーバ内で一意になるようにしてください。

(3)対象となる仮想サーバに，VMwareToolsがインストールされていること。

注意事項

(1)同一の仮想サーバに対して，このサービスを複数同時に実行しないでください。

(2)UserResponseplugin.dialogTextにHTMLタグを指定する場合，指定できるタグおよび属性はユーザー応答待ち部品と同じです。詳細については，本製品マニュアルの「ユーザー応答待ち部品」について説明しているトピックを参照してください。

(3)コア数設定オプション(vmware.setCoresOptionプロパティ)に"true"以外を指定した場合，対象となる仮想サーバの，ソケット当たりのコア数を1に設定しておいてください。ソケット当たりのコア数を1以外に設定した仮想サーバに対してCPUソケット数を変更した場合，次の現象が発生する場合があります。

・CPU数がコア数の倍数にならないため，仮想サーバが起動しない。

・仮想サーバは起動したが，期待するリソース値になっていない。

(4)CPUソケット数(vmware.cpuNumプロパティ)，CPUのソケット当たりのコア数(vmware.cpuCoresPerSocketプロパティ)およびメモリ容量(vmware.memoryMBプロパティ)は，前提製品のバージョンによって指定できる値が異なります。前提製品における制限を確認して指定してください。

(5)メモリの予約では，仮想サーバに割り当てられているメモリ容量以内の値を指定してください。割り当てられているより多くのメモリ容量を指定するとタスクの実行が異常終了します。

(6)CPU，メモリの制限はOSの要件や用途にあわせて指定してください。

(7)CPUおよびメモリについて，制限より多くのリソースを予約することはできません。

(8)vmware.vHardDiskNameプロパティに複数の仮想ディスクを指定した場合，1台でもディスクシェアレベルの変更処理が失敗するとタスクが異常終了します。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　システム管理者ロール

バージョン

03.00.01

タグ

Modify VM,VMware vSphere

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

VMware vCenter Serverの情報を指定してください。

表示されます。

仮想サーバ情報

仮想サーバのスペックを指定してください。

表示されます。

仮想サーバのリソース構成情報

仮想サーバのリソースの構成を指定してください。

表示されます。

ユーザー応答待ちオプション

仮想サーバが起動していた場合のユーザー応答のためのオプションです。必要に応じて変更してください。

表示されません。

実行時オプション

仮想サーバの停止を行う場合の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.targetHost

VMware vCenter操作サーバのホスト名

VMware vCenter Serverを操作するサーバ(vSphere PowerCLIインストール済みサーバ)のホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

入力

無効

○　

仮想システム環境情報

vmware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

入力

無効

○　

仮想システム環境情報

vmware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

入力

無効

△　

仮想システム環境情報

vmware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

入力

無効

○　

仮想システム環境情報

UserResponsePlugin.toAddress

TOメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(TO)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.ccAddress

CCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(CC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.bccAddress

BCCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(BCC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailSubject

メール件名

ユーザー応答待ちになった場合のメール通知のメールの件名を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailBody

メール本文

ユーザー応答待ちになった場合のメール通知のメール本文を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.encodeType

エンコード種別

ユーザー応答待ちになった場合のメール通知のエンコード種別を指定します。指定可能なエンコード名は次のとおりです。us-ascii，iso-2022-jp，shift_jis，euc-jp，utf-8。指定しなかった場合には，utf-8で送信されます。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.dialogText

応答入力画面の補足情報

ユーザー応答待ちになった場合の応答入力ダイアログに表示する補足情報を指定します。テキスト形式，またはHTML形式で指定できます。指定可能なHTMLタグは，アンカータグ，ボールドタグ，ブレークタグ，フォントタグ，イタリックタグ，下線タグです。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.responseTimeOut

応答タイムアウト時間(分)

ユーザー応答待ちになった場合の応答がタイムアウトする時間を分単位で指定します。応答タイムアウト時間が過ぎると，サービスが異常終了します。

入力

無効

○　

ユーザー応答待ちオプション

vmware.checkPowerStateCount

電源状態の確認回数

仮想サーバの停止を確認する際の，電源状態の確認回数を指定します。電源状態の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

vmware.checkPowerStateInterval

電源状態の確認間隔

仮想サーバの停止を確認する際の，電源状態の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.vmName

仮想サーバ名

仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

仮想サーバ情報

vmware.cpuNum

CPUソケット数

仮想サーバに設定するCPUの仮想ソケット数を指定します。CPUソケット数・メモリ容量は，少なくともどちらか一つは指定してください。CPUソケット数とソケット当たりのコア数を掛けた値が仮想サーバのCPU数となります。

入力

無効

△　

仮想サーバ情報

vmware.setCoresOption

コア数設定オプション

仮想サーバのCPUのソケット当たりのコア数を設定する場合に"true"を指定します。"true"以外の場合はコア数を設定しません。サービス詳細説明の注意事項を参照してください。

入力

無効

△　

仮想サーバ情報

vmware.numCoresPerSocket

ソケット当たりのコア数

コア数設定オプションに"true"を指定した場合に，仮想サーバに設定するCPUのソケット当たりのコア数を指定します。このプロパティを指定する場合は，CPUソケット数も指定してください。CPUソケット数とソケット当たりのコア数を掛けた値が仮想サーバのCPU数となります。

入力

無効

△　

仮想サーバ情報

vmware.memoryMB

メモリ容量(MB)

仮想サーバに設定するメモリ容量をMB単位で指定します。CPUソケット数・メモリ容量は，少なくともどちらか一つは指定してください。

入力

無効

△　

仮想サーバ情報

vmware.cpuSharesLevel

CPUのシェアレベル

同一の親を持つ仮想サーバ間における相対的なCPUリソースの優先度を指定します。

入力

無効

△　

仮想サーバのリソース構成情報

vmware.cpuReservationMHz

CPUの予約 (MHz)

仮想サーバが予約するCPUリソースをMHz単位で指定します。

入力

無効

△　

仮想サーバのリソース構成情報

vmware.cpuLimitMHz

CPUの制限 (MHz)

仮想サーバが使用するCPUリソースの上限値をMHz単位で指定します。100MHz未満の値を指定するとタスクの実行が異常終了します。ただし，-1を指定すると制限を解除します。

入力

無効

△　

仮想サーバのリソース構成情報

vmware.memSharesLevel

メモリのシェアレベル

同一の親を持つ仮想サーバ間における相対的なメモリリソースの優先度を指定します。

入力

無効

△　

仮想サーバのリソース構成情報

vmware.memReservationMB

メモリの予約 (MB)

仮想サーバが予約するメモリリソースをMB単位で指定します。

入力

無効

△　

仮想サーバのリソース構成情報

vmware.memLimitMB

メモリの制限 (MB)

仮想サーバが使用するメモリリソースの上限値をMB単位で指定します。100MB未満の値を指定するとタスクの実行が異常終了します。ただし，-1を指定すると制限を解除します。

入力

無効

△　

仮想サーバのリソース構成情報

vmware.diskSharesLevel

ディスクのシェアレベル

ストレージのI/Oリソースに対する仮想サーバの相対的な優先度を指定します。

入力

無効

△　

仮想サーバのリソース構成情報

vmware.vHardDiskName

仮想ディスク名

シェアレベルを変更する仮想ディスクを指定します。仮想ディスクはVMware vCenter Serverでの表示名です。複数の仮想ディスクを指定する場合は，","区切りで指定してください。このプロパティを省略した場合，仮想サーバに接続されているすべての仮想ディスクを指定されたシェアレベルに設定します。このプロパティを指定する場合は，必ずディスクのシェアレベルも指定してください。

入力

無効

△　

仮想サーバのリソース構成情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.targetHost

256文字以内の半角英数字および「.」，「-」。

vmware.vCenterServerName

256文字以内の半角英数字および「.」，「-」。

vmware.userName

512文字以内の半角英数字および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「%」を除く。

vmware.password

127文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.portNumber

1〜65535の整数値。

vmware.protocol

次の値のどれかを選択する。

http,https

UserResponsePlugin.toAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.ccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.bccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.mailSubject

256文字以内の文字列。

UserResponsePlugin.mailBody

1024文字以内の文字列。

UserResponsePlugin.encodeType

次の値のどれかを選択する。

us-ascii,iso-2022-jp,shift_jis,euc-jp,utf-8

UserResponsePlugin.dialogText

512文字以内の文字列。

UserResponsePlugin.responseTimeOut

1〜9999の整数値。

vmware.checkPowerStateCount

1〜3600の整数値。

vmware.checkPowerStateInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.vmName

60文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」を除く。

vmware.cpuNum

1〜128の整数値。

vmware.setCoresOption

次の値のどれかを選択する。

true,false

vmware.numCoresPerSocket

1〜128の整数値。

vmware.memoryMB

4〜2147483647の整数値。

vmware.cpuSharesLevel

次の値のどれかを選択する。

High,Normal,Low

vmware.cpuReservationMHz

0〜65535の整数値。

vmware.cpuLimitMHz

-1〜65535の整数値。

vmware.memSharesLevel

次の値のどれかを選択する。

High,Normal,Low

vmware.memReservationMB

0〜2147483647の整数値。

vmware.memLimitMB

-1〜2147483647の整数値。

vmware.diskSharesLevel

次の値のどれかを選択する。

High,Normal,Low

vmware.vHardDiskName

1文字以上の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバのリソース変更の事前判定

仮想サーバのリソース変更の事前判定

仮想サーバのリソース変更の事前判定

VMware vCenter Serverで管理される仮想サーバについてCPU，メモリのリソース変更時の事前判定を行います。

次の点を確認して再実行してください。

・接続先と認証情報が正しいか。

2

仮想サーバのリソース構成変更の事前判定

仮想サーバのリソース構成変更の事前判定

仮想サーバのリソース構成変更の事前判定

VMware vCenter Serverで管理される仮想サーバについてCPU，メモリ，ディスクI/Oのリソース構成変更時の事前判定を行います。

次の点を確認して再実行してください。

・接続先と認証情報が正しいか。

・仮想サーバのリソースの制限が低すぎないか。

・制限より多くリソースを予約していないか。

・ディスクI/Oのシェアレベルの指定を忘れていないか。

3

電源状態確認

電源状態確認

階層フロー部品

電源状態を調べ，電源状態がOFFでなければ，ユーザーに確認します。

−　

3-1

仮想サーバの電源状態取得

指定された仮想サーバの電源状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-4

値判定分岐部品

出力文字列がPoweredOnを含むか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-5

階層フロー部品

ユーザーに仮想サーバの電源をOFFにするか確認します。

−　

3-5-1

ユーザー応答待ち部品

ユーザーに電源をOFFにするか・しないかを確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-5-2

戻り値判定分岐部品

ユーザー応答待ち部品の戻り値が1か判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-5-3

異常終了部品

ジョブネットをエラーにします。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-5-4

仮想サーバのシャットダウン

指定された仮想サーバの電源状態をOFFに設定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4

リソース変更要否判定

リソース変更要否判定

値判定分岐部品

仮想サーバのリソース変更の要否を判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

5

仮想サーバのリソース変更

仮想サーバのリソース変更

仮想サーバのリソース設定

仮想サーバのリソース(CPU，メモリ)を変更します。

次の点を確認してください。

・接続先と認証情報が正しいか。

6

リソース構成変更要否判定

リソース構成変更要否判定

値判定分岐部品

仮想サーバのリソース構成変更の要否を判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

7

仮想サーバのリソース構成の変更

仮想サーバのリソース構成の変更

仮想サーバのリソース構成の設定

仮想サーバのリソース(CPU，メモリ，ディスクI/O)の構成を変更します。

次の点を確認してください。

・接続先と認証情報が正しいか。

・VMware vSphere ESXi(またはVMware ESX Server)に割り当てられている以上に，メモリ容量を予約しようとしていないか。

また，CPUまたはメモリを変更した場合，すでに変更している場合があります。

3.15.3　仮想サーバのスナップショット

機能

VMware vSphere環境で，仮想サーバの状態をスナップショットを用いて更新できます。

VMware vSphere環境の仮想サーバの状態およびデータを変更する場合に，変更前のスナップショットを作成します。

変更結果を採用する場合，変更を確定後，スナップショットを削除します。変更結果を採用しない場合，変更を破棄後，スナップショットを削除します。

このサービステンプレートが前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ

　VMware vSphere PowerCLIがインストールされているサーバです。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXi(またはVMware ESX Server)によって管理されている仮想サーバです。

処理の概要を次に示します。

(1)仮想サーバのスナップショットを作成します。

(2)スナップショットの作成後，ユーザーが仮想サーバの状態およびデータを変更する間，応答待ち部品を実行して変更完了を待ちます。

応答待ちのGUIでは，"Commit"(変更結果の採用)か"Roll back"(変更結果の不採用)を選択できます。

(3)仮想サーバのスナップショットを削除します。

ユーザーが応答待ちのGUIで"Commit"を選択した場合は，スナップショット作成後の変更を確定後，スナップショットを削除します。

ユーザーが応答待ちのGUIで"Roll back"を選択した場合は，スナップショット作成後の変更を破棄後，スナップショットを削除します。

なお，仮想サーバ名プロパティ(vmware.vmName)に指定できる最大の文字数は60文字です。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)vCenter操作サーバの前提製品

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【サービステンプレート実行システム内前提製品の稼働OS】

(1)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

(2)vCenter操作サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

【サービステンプレート実行システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)同一のvCenterの管理下において，仮想サーバ名が重複しないこと。

(3)同一の仮想サーバ内で，スナップショット名が重複していないこと。

(4)対象となる仮想サーバに，VMware Toolsがインストールされていること。

(5)対象となる仮想サーバの設定変更前は仮想サーバの電源がOFFになっていること。

注意事項

(1)同一の仮想サーバに対して，このサービスを複数同時に実行しないでください。

(2)Rawディスク，RDM物理モードディスク，および独立ディスクが設定されている仮想サーバを対象にしないでください。

(3)応答入力画面の補足情報プロパティ(UserResponseplugin.dialogText)にHTMLタグを指定する場合，指定できるタグおよび属性はユーザー応答待ち部品と同じです。詳細については，本製品マニュアルの「ユーザー応答待ち部品」について説明しているトピックを参照してください。

(4)このサービスを実行中にエラーが発生した場合は，タスクログからスナップショット名を確認し，該当するスナップショットの有無を確認してください。もし，該当するスナップショットが残っていた場合は，スナップショットの確定または破棄を行ってください。このサービスで作成したスナップショットを長期間放置，または対処を行わずに，このサービスを再実行しないください。データストアの容量の過剰使用の原因になります。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

システム管理者ロール

バージョン

03.00.00

タグ

Snapshot VM,VMware vSphere

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

VMware vCenter Serverの情報を指定してください。

表示されます。

仮想サーバ情報

スナップショットを作成する仮想サーバの情報を指定してください。

表示されます。

ユーザー応答待ちオプション

スナップショットの採用または不採用の応答をする場合のユーザー応答のためのオプションです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.targetHost

VMware vCenter操作サーバのホスト名

VMware vCenter Serverを操作するサーバ(vSphere PowerCLIインストール済みサーバ)のホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

入力

無効

○　

仮想システム環境情報

vmware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

入力

無効

○　

仮想システム環境情報

vmware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

入力

無効

△　

仮想システム環境情報

vmware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

入力

無効

○　

仮想システム環境情報

vmware.snapshotName

スナップショット名

スナップショットの名称を指定します。

入力

無効

○　

仮想サーバ情報

UserResponsePlugin.toAddress

TOメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(TO)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.ccAddress

CCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(CC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.bccAddress

BCCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(BCC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailSubject

メール件名

ユーザー応答待ちになった場合のメール通知のメールの件名を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailBody

メール本文

ユーザー応答待ちになった場合のメール通知のメール本文を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.encodeType

エンコード種別

ユーザー応答待ちになった場合のメール通知のエンコード種別を指定します。指定可能なエンコード名は次のとおりです。us-ascii，iso-2022-jp，shift_jis，euc-jp，utf-8。指定しなかった場合には，utf-8で送信されます。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.dialogText

応答入力画面の補足情報

ユーザー応答待ちになった場合の応答入力ダイアログに表示する補足情報を指定します。テキスト形式，またはHTML形式で指定できます。指定可能なHTMLタグは，アンカータグ，ボールドタグ，ブレークタグ，フォントタグ，イタリックタグ，下線タグです。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.responseTimeOut

応答タイムアウト時間(分)

ユーザー応答待ちになった場合の応答がタイムアウトする時間を分単位で指定します。応答タイムアウト時間が過ぎると，サービスが異常終了します。

入力

無効

○　

ユーザー応答待ちオプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.vmName

仮想サーバ名

仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

仮想サーバ情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.targetHost

256文字以内の半角英数字および「.」，「-」。

vmware.vCenterServerName

256文字以内の半角英数字および「.」，「-」。

vmware.userName

512文字以内の半角英数字および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「%」を除く。

vmware.password

127文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.portNumber

1〜65535の整数値。

vmware.protocol

次の値のどれかを選択する。

http,https

vmware.snapshotName

80文字以内の半角英数字。

UserResponsePlugin.toAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.ccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.bccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.mailSubject

256文字以内の文字列。

UserResponsePlugin.mailBody

1024文字以内の文字列。

UserResponsePlugin.encodeType

次の値のどれかを選択する。

us-ascii,iso-2022-jp,shift_jis,euc-jp,utf-8

UserResponsePlugin.dialogText

512文字以内の文字列。

UserResponsePlugin.responseTimeOut

1〜9999の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.vmName

60文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバのスナップショット作成

仮想サーバのスナップショット作成

仮想サーバのスナップショット作成

VMware vSphere環境において，指定された仮想サーバにスナップショットを作成します。

エラーの原因を取り除いたあと，サービスを再実行してください。また，エラー原因への対処を行う場合に，このサービスの注意事項を確認してください。

2

変更結果確認

変更結果確認

階層フロー部品

仮想サーバの状態およびデータの変更を確定または破棄をします。

−　

2-1

ユーザー応答待ち部品

変更結果の採用・不採用を確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。また，エラー原因への対処を行う場合に，このサービスの注意事項を確認してください。

2-2

戻り値判定分岐部品

ユーザー応答待ち部品がタイムアウトしたかどうか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。また，エラー原因への対処を行う場合に，このサービスの注意事項を確認してください。

2-3

異常終了部品

ジョブネットをエラーにします。

エラーの原因を取り除いたあと，サービスを再実行してください。また，エラー原因への対処を行う場合に，このサービスの注意事項を確認してください。

2-4

戻り値判定分岐部品

ユーザー応答待ち部品の戻り値が1か判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。また，エラー原因への対処を行う場合に，このサービスの注意事項を確認してください。

2-5

仮想サーバのスナップショット移動

VMware vSphere環境において，仮想サーバで使用しているスナップショットを，仮想サーバ上の指定されたスナップショットに移動します。

エラーの原因を取り除いたあと，サービスを再実行してください。また，エラー原因への対処を行う場合に，このサービスの注意事項を確認してください。

3

仮想サーバのスナップショット削除

仮想サーバのスナップショット削除

仮想サーバのスナップショット削除

VMware vSphere環境において，指定された仮想サーバのスナップショットを削除します。削除するスナップショットが現在使用中の場合は，スナップショットの変更を確定します。

エラーの原因を取り除いたあと，サービスを再実行してください。また，エラー原因への対処を行う場合に，このサービスの注意事項を確認してください。

3.15.4　仮想サーバ削除

機能

VMware vSphere環境の仮想サーバを削除します。

このサービステンプレートが前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ

　VMware vSphere PowerCLIがインストールされているサーバです。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXによって管理されている仮想サーバです。

処理の概要を以下に示します。

(1) 仮想サーバの電源状態を取得します。

(2) 仮想サーバの電源状態がOFFになっていることを確認します。

　　電源状態がOFFでない場合は，ユーザー応答待ち部品を実行して，電源をOFFにするか・しないかを確認します。

　　ユーザー応答待ち部品のメール送信先/送信内容，タイムアウト，画面表示内容はModify権限のユーザーが設定できます。

　　ユーザー応答待ちのGUIで"Shutdown"を選択した場合は，仮想サーバのシャットダウンを行います。

　　"Cancel"を選択するか，応答待ちがタイムアウトになった場合は，仮想サーバには操作を行わずにサービスが異常終了します。

　　仮想サーバを停止する際には，vmware.checkPowerStateIntervalプロパティに指定した秒数待ち合わせ，電源状態がOFFになることを確認する動作を，vmware.checkPowerStateCountプロパティに指定した回数繰り返します。デフォルトの値で不都合がある場合，利用している環境に合わせて調整してください。

(3) 仮想サーバを削除します。

なお，仮想サーバ名プロパティ(vmware.vmName)に指定できる最大の文字数は60文字です。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)vCenter操作サーバの前提製品

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【サービステンプレート実行システム内前提製品の稼働OS】

(1)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86),Red Hat Enterprise Linux Server 6 (64-bit x86_64)(vCenter4.1以降。vCenter4.0では未サポート)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

(2)vCenter操作サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

【サービステンプレート実行システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)仮想サーバ名はvCenterサーバ内で一意になるようにしてください。

(3)対象となる仮想サーバに，VMwareToolsがインストールされていること。

注意事項

(1)同一の仮想サーバに対して，このサービスを複数同時に実行しないでください。

(2)UserResponseplugin.dialogTextにHTMLタグを指定する場合，指定できるタグおよび属性はユーザー応答待ち部品と同じです。詳細については，本製品マニュアルの「ユーザー応答待ち部品」について説明しているトピックを参照してください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　システム管理者ロール

バージョン

03.00.00

タグ

Delete VM,VMware vSphere

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

VMware vCenter Serverの情報を指定してください。

表示されます。

仮想サーバ情報

削除する仮想サーバの情報を指定してください。

表示されます。

ユーザー応答待ちオプション

仮想サーバが起動していた場合のユーザー応答のためのオプションです。必要に応じて変更してください。

表示されません。

実行時オプション

仮想サーバの停止を行う際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.targetHost

VMware vCenter操作サーバのホスト名

VMware vCenter Serverを操作するサーバ(vSphere PowerCLIインストール済みサーバ)のホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

入力

無効

○　

仮想システム環境情報

vmware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

入力

無効

○　

仮想システム環境情報

vmware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

入力

無効

△　

仮想システム環境情報

vmware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

入力

無効

○　

仮想システム環境情報

UserResponsePlugin.toAddress

TOメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(TO)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.ccAddress

CCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(CC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.bccAddress

BCCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(BCC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailSubject

メール件名

ユーザー応答待ちになった場合のメール通知のメールの件名を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailBody

メール本文

ユーザー応答待ちになった場合のメール通知のメール本文を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.encodeType

エンコード種別

ユーザー応答待ちになった場合のメール通知のエンコード種別を指定します。指定可能なエンコード名は次のとおりです。us-ascii，iso-2022-jp，shift_jis，euc-jp，utf-8。指定しなかった場合には，utf-8で送信されます。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.dialogText

応答入力画面の補足情報

ユーザー応答待ちになった場合の応答入力ダイアログに表示する補足情報を指定します。テキスト形式，またはHTML形式で指定できます。指定可能なHTMLタグは，アンカータグ，ボールドタグ，ブレークタグ，フォントタグ，イタリックタグ，下線タグです。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.responseTimeOut

応答タイムアウト時間(分)

ユーザー応答待ちになった場合の応答がタイムアウトする時間を分単位で指定します。応答タイムアウト時間が過ぎると，サービスが異常終了します。

入力

無効

○　

ユーザー応答待ちオプション

vmware.checkPowerStateCount

電源状態の確認回数

仮想サーバの停止を確認する際の，電源状態の確認回数を指定します。電源状態の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

vmware.checkPowerStateInterval

電源状態の確認間隔

仮想サーバの停止を確認する際の，電源状態の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.vmName

仮想サーバ名

仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

仮想サーバ情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.targetHost

256文字以内の半角英数字および「.」，「-」。

vmware.vCenterServerName

256文字以内の半角英数字および「.」，「-」。

vmware.userName

512文字以内の半角英数字および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「%」を除く。

vmware.password

127文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.portNumber

1〜65535の整数値。

vmware.protocol

次の値のどれかを選択する。

http,https

UserResponsePlugin.toAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.ccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.bccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.mailSubject

256文字以内の文字列。

UserResponsePlugin.mailBody

1024文字以内の文字列。

UserResponsePlugin.encodeType

次の値のどれかを選択する。

us-ascii,iso-2022-jp,shift_jis,euc-jp,utf-8

UserResponsePlugin.dialogText

512文字以内の文字列。

UserResponsePlugin.responseTimeOut

1〜9999の整数値。

vmware.checkPowerStateCount

1〜3600の整数値。

vmware.checkPowerStateInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.vmName

60文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

電源状態取得

電源状態取得

仮想サーバの電源状態取得

VMware vSphere環境において，仮想サーバの電源状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

電源状態確認

電源状態確認

階層フロー部品

電源状態を調べ，電源状態がOFFでなければ，ユーザーに確認します。

−　

2-3

値判定分岐部品

出力文字列がPoweredOnを含むか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4

階層フロー部品

−　

−　

2-4-1

ユーザー応答待ち部品

電源をOFFにするか・しないかを確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4-2

戻り値判定分岐部品

ユーザー応答待ち部品の戻り値が1か判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4-3

異常終了部品

ジョブネットをエラーにします。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4-4

仮想サーバのシャットダウン

VMware vSphere環境において，仮想サーバのシャットダウンを行い，電源状態をOFFに設定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

仮想サーバ削除

仮想サーバ削除

階層フロー部品

仮想サーバを削除します。

−　

3-1

仮想サーバの削除

VMware vSphere環境において，指定された仮想サーバを削除します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.15.5　仮想サーバ削除(データストア削除/LU削除)

機能

VMware vSphere ESXi(またはVMware ESX Server)のデータストアを削除し，ストレージシステム上のLUを削除します。

このサービステンプレートが前提とするサーバを以下に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ

　VMware vSphere PowerCLIがインストールされているサーバです。

・ESXサーバ

　ESXがインストールされているサーバです。

・HDvMサーバ

　Hitachi Device Manager Softwareがインストールされているサーバです。

・HDvM CLIサーバ

　Hitachi Device Manager Software CLIがインストールされているサーバです。

以下の処理を行います。

(1) vCenter操作サーバから，ESXサーバに対してデータストアの削除を実行します。

(2) HDvM CLIサーバから，ホストグループからのLU削除を実行します。

(3) HDvM CLIサーバから，指定された仮想ボリューム(DPボリューム)のフォーマットおよび削除を実行します。

操作するストレージシステムの種類によって，ストレージシステムのファミリー名を指定するプロパティが異なります。次のストレージシステムを操作する場合は，「ストレージシステムのファミリー名(カスタムオプション)」(hdvm.familyTextプロパティ)に指定します。その他のストレージシステムを操作する場合は，「ストレージシステムのファミリー名」(hdvm.familyプロパティ)に指定します。

・Hitachi Virtual Storage Platform G1500の場合，「VSP G1500」を指定します。

・Hitachi Virtual Storage Platform F1500の場合，「VSP F1500」を指定します。

・Hitachi Virtual Storage Platform G100/G200/G400/G600/G800の場合，「VSP Gx00」を指定します。

・Hitachi Virtual Storage Platform F400/F600/F800の場合，「VSP Fx00」を指定します。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)vCenter操作サーバの前提製品

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

(4)システム内のサーバに次の製品がセットアップされていること。また，HDvM CLIサーバに，Hitachi Device Manager Software CLIがセットアップされていること。

　・Hitachi Device Manager Software 07-00以降

(5)システム内のストレージシステムとして次のどれかがセットアップされていること。かつ，FC-SANストレージであること。

　・Hitachi Adaptable Modular Storage 2100/2300/2500/2010

　・Hitachi Unified Storage 110/130/150

　・Hitachi Unified Storage VM

　・Hitachi Universal Storage Platform V/VM

　・Hitachi Virtual Storage Platform

　・Hitachi Virtual Storage Platform G1000/G1500/F1500

　・Hitachi Virtual Storage Platform G100/G200/G400/G600/G800

　・Hitachi Virtual Storage Platform F400/F600/F800

【サービステンプレート実行システム内前提製品の稼働OS】

(1)vCenter操作サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

(2)HDvM CLIサーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

【サービステンプレート実行システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がvCenterで管理されていること。

(2)ストレージシステムがHitachi Device Manager Softwareで管理されていること。

(3)VMware ESX Serverのバージョンが4.xの場合，以下の問題が対策されていること。

　・Unpresenting a LUN containing a datastore from ESX 4.x and ESXi 4.x

　　　http://kb.vmware.com/kb/1015084

注意事項

(1)使用中の仮想サーバが削除対象のデータストアに格納されていないことを確認してください。

(2)hdvm.hdvmArrayFamilyTextプロパティにはサポート対象外のストレージシステムを指定しないでください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　システム管理者ロール

(2)Hitachi Device Manager Softwareに接続するユーザーに，次の権限が必要です。

　リソースグループとして「All Resources」を割り当てられていること。

　AdminロールまたはModifyロールであること。

バージョン

02.11.00

タグ

Delete VM,VMware vSphere

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

HDvMとVMware vCenter Serverの情報を指定してください。

表示されます。

ストレージ情報

削除するDPボリュームに関連するストレージの情報を指定してください。

表示されます。

仮想環境情報

削除するデータストアに関連する仮想環境の情報を指定してください。

表示されます。

カスタムオプション

hdvm.hdvmArrayFamilyプロパティの選択リストにないストレージシステムの情報を指定してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hdvm.targetHost

HDvM CLIサーバのホスト名

Device Manager CLIがインストールされているサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

hdvm.cliInstallPath

HDvM CLIのインストールパス

Device Manager CLIのインストールパスを指定します。

入力

無効

○　

仮想システム環境情報

hdvm.hdvmProtocol

HDvMとの通信プロトコル

HDvMサーバに接続するためのプロトコルをhttpまたはhttpsで指定します。

入力

無効

○　

仮想システム環境情報

hdvm.hdvmHostName

HDvMサーバのホスト名

HDvMサーバのホスト名またはIPアドレスを指定します。

入力

無効

○　

仮想システム環境情報

hdvm.hdvmPortNumber

HDvMとの接続ポート番号

HDvMサーバに接続するためのポート番号を指定します。

入力

無効

○　

仮想システム環境情報

hdvm.hdvmUserName

HDvMに接続するためのユーザーID

HDvMサーバに接続するためのユーザーIDを指定します。

入力

無効

○　

仮想システム環境情報

hdvm.hdvmPassword

HDvMに接続するためのパスワード

HDvMサーバに接続するためのパスワードを指定します。

入力

無効

○　

仮想システム環境情報

vmware.targetHost

VMware vCenter操作サーバのホスト名

VMware vCenter Serverを操作するサーバ(vSphere PowerCLIインストール済みサーバ)のホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

入力

無効

○　

仮想システム環境情報

vmware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

入力

無効

○　

仮想システム環境情報

vmware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

入力

無効

△　

仮想システム環境情報

vmware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

入力

無効

○　

仮想システム環境情報

hdvm.hdvmSerialNumber

ストレージシステムのシリアル番号

実行対象のストレージシステムのシリアル番号を指定します。

入力

無効

○　

ストレージ情報

hdvm.hdvmArrayFamily

ストレージシステムのファミリー名

ストレージシステムのファミリー名を指定します。指定可能な値はAMS，USP_V，USP_VM，VSP，HUS，HUS VM，VSP G1000のどれかです。

入力

無効

○　

ストレージ情報

hdvm.hdvmArrayFamilyText

ストレージシステムのファミリー名(カスタムオプション)

hdvm.hdvmArrayFamilyプロパティの選択リストにないストレージシステムのファミリー名を指定します。このプロパティを指定した場合，hdvm.hdvmArrayFamilyプロパティに指定した値は無視されます。

入力

無効

△　

カスタムオプション

hdvm.luFormatOption

LUフォーマットの要否(カスタムオプション)

LUを削除する前にフォーマットするかどうかを指定します。フォーマットする場合はyes，フォーマットしない場合はnoを選択してください。このプロパティは，hdvm.hdvmArrayFamilyTextプロパティにhdvm.hdvmArrayFamilyプロパティの選択リストに存在しないファミリー名を指定した場合だけ有効になります。

入力

無効

○　

カスタムオプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hdvm.hdvmPathPortName

パスのポート名

DPボリューム(LU)へのパスのポート名を指定します。

入力

無効

○　

ストレージ情報

hdvm.hdvmDomainId

ホストグループのID

DPボリューム(LU)を削除するホストグループのIDを10進数または16進数で指定します。16進数の場合は"0x"をプレフィックスとして付与してください。

入力

無効

○　

ストレージ情報

hdvm.hdvmDevNumber

DPボリューム(LU)のデバイス番号

DPボリューム(LU)のデバイス番号を10進数で指定します。

入力

無効

○　

ストレージ情報

vmware.vmHostName

ESXサーバ名

VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。

入力

無効

○　

仮想環境情報

vmware.dataStoreName

データストア名

データストアの名称を指定します。

入力

無効

○　

仮想環境情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hdvm.targetHost

255文字以内の半角英数字および「.」，「-」。

hdvm.cliInstallPath

1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「^」を除く。

hdvm.hdvmProtocol

次の値のどれかを選択する。

http,https

hdvm.hdvmHostName

255文字以内の半角英数字および「.」，「-」。

hdvm.hdvmPortNumber

1〜65535の整数値。

hdvm.hdvmUserName

1文字以上256文字以内の文字列。使用できるのは次の文字だけ。半角英数字，「!」，「#」，「$」，「%」，「'」，「(」，「)」，「*」，「+」，「-」，「.」，「=」，「@」，「¥」，「^」，「_」。ただし，末尾に「¥」は使用できない。

hdvm.hdvmPassword

4文字以上256文字以内の文字列。使用できるのは次の文字だけ。半角英数字，「!」，「#」，「$」，「%」，「'」，「(」，「)」，「*」，「+」，「-」，「.」，「=」，「@」，「¥」，「^」，「_」。ただし，末尾に「¥」は使用できない。

vmware.targetHost

256文字以内の半角英数字および「.」，「-」。

vmware.vCenterServerName

256文字以内の半角英数字および「.」，「-」。

vmware.userName

512文字以内の半角英数字および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「%」を除く。

vmware.password

127文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.portNumber

1〜65535の整数値。

vmware.protocol

次の値のどれかを選択する。

http,https

hdvm.hdvmSerialNumber

1文字以上20文字以内の半角英数字。

hdvm.hdvmArrayFamily

次の値のどれかを選択する。

AMS,USP_V,USP_VM,VSP,HUS,HUS VM,VSP G1000

hdvm.hdvmArrayFamilyText

255文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

hdvm.luFormatOption

次の値のどれかを選択する。

yes,no

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hdvm.hdvmPathPortName

1文字以上の文字列。ただし，「<」，「>」，「|」，「;」，「&」および末尾の「¥」を除く。

hdvm.hdvmDomainId

1文字以上の半角数字，および半角英字a〜f，A〜F，x。

hdvm.hdvmDevNumber

0〜524287の整数値。

vmware.vmHostName

256文字以内の半角英数字および「.」，「-」。

vmware.dataStoreName

42文字以内の半角英数記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

データストア削除

データストア削除

データストア削除

VMware vSphere ESXi(またはVMware ESX Server)からデータストアを削除します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

ホストグループからLU削除

ホストグループからLU削除

ホストグループからLUを削除

Device Managerで管理されたストレージシステムで，指定されたLUをホストグループから削除します。

エラーの原因を取り除いたあと，手動でLUを削除してください。

3

LU削除

LU削除

DPボリュームの削除

Device Managerで管理されたストレージシステムで，指定されたDPボリュームを削除します。

エラーの原因を取り除いたあと，手動でLUを削除してください。

3.15.6　仮想サーバ削除(仮想ディスク)

機能

VMware vSphere環境において，仮想サーバのディスクを削除します。

このサービステンプレートが前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ

　VMware vSphere PowerCLIがインストールされているサーバです。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXによって管理されている仮想サーバです。

処理の概要を以下に示します。

(1) 仮想サーバの電源状態を取得します。

(2) 仮想サーバの電源状態がOFFになっていることを確認します。

　　電源状態がOFFでない場合は，ユーザー応答待ち部品を実行して，電源をOFFにするか・しないかを確認します。

　　ユーザー応答待ち部品のメール送信先/送信内容，タイムアウト，画面表示内容はModify権限のユーザーが設定できます。

　　ユーザー応答待ちのGUIで"Shutdown"を選択した場合は，仮想サーバのシャットダウンを行います。

　　"Cancel"を選択するか，応答待ちがタイムアウトになった場合は，仮想サーバには操作を行わずにサービスが異常終了します。

　　仮想サーバを停止する際には，vmware.checkPowerStateIntervalプロパティに指定した秒数待ち合わせ，電源状態がOFFになることを確認する動作を，vmware.checkPowerStateCountプロパティに指定した回数繰り返します。デフォルトの値で不都合がある場合，利用している環境に合わせて調整してください。

(3) 仮想サーバから仮想ディスクを削除します。

なお，仮想サーバ名プロパティ(vmware.vmName)に指定できる最大の文字数は60文字です。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)vCenter操作サーバの前提製品

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【サービステンプレート実行システム内前提製品の稼働OS】

(1)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86),Red Hat Enterprise Linux Server 6 (64-bit x86_64)(vCenter4.1以降。vCenter4.0では未サポート)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

(2)vCenter操作サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

【サービステンプレート実行システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)仮想サーバ名はvCenterサーバ内で一意になるようにしてください。

(3)対象となる仮想サーバに，VMwareToolsがインストールされていること。

注意事項

(1)削除する仮想ディスクに必要なデータがある場合は，あらかじめバックアップを取得してください。

(2)仮想ディスクはデータストアからも削除します。

(3)同一の仮想サーバに対して，このサービスを複数同時に実行しないでください。

(4)UserResponseplugin.dialogTextにHTMLタグを指定する場合，指定できるタグおよび属性はユーザー応答待ち部品と同じです。詳細については，本製品マニュアルの「ユーザー応答待ち部品」について説明しているトピックを参照してください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　システム管理者ロール

バージョン

03.00.00

タグ

Modify VM,VMware vSphere

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

VMware vCenter Serverの情報を指定してください。

表示されます。

仮想ディスク情報

削除する仮想ディスクの情報を指定してください。

表示されます。

ユーザー応答待ちオプション

仮想サーバが起動していた場合のユーザー応答のためのオプションです。必要に応じて変更してください。

表示されません。

実行時オプション

仮想サーバの停止を行う際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.targetHost

VMware vCenter操作サーバのホスト名

VMware vCenter Serverを操作するサーバ(vSphere PowerCLIインストール済みサーバ)のホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

入力

無効

○　

仮想システム環境情報

vmware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

入力

無効

○　

仮想システム環境情報

vmware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

入力

無効

△　

仮想システム環境情報

vmware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

入力

無効

○　

仮想システム環境情報

UserResponsePlugin.toAddress

TOメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(TO)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.ccAddress

CCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(CC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.bccAddress

BCCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(BCC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailSubject

メール件名

ユーザー応答待ちになった場合のメール通知のメールの件名を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailBody

メール本文

ユーザー応答待ちになった場合のメール通知のメール本文を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.encodeType

エンコード種別

ユーザー応答待ちになった場合のメール通知のエンコード種別を指定します。指定可能なエンコード名は次のとおりです。us-ascii，iso-2022-jp，shift_jis，euc-jp，utf-8。指定しなかった場合には，utf-8で送信されます。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.dialogText

応答入力画面の補足情報

ユーザー応答待ちになった場合の応答入力ダイアログに表示する補足情報を指定します。テキスト形式，またはHTML形式で指定できます。指定可能なHTMLタグは，アンカータグ，ボールドタグ，ブレークタグ，フォントタグ，イタリックタグ，下線タグです。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.responseTimeOut

応答タイムアウト時間(分)

ユーザー応答待ちになった場合の応答がタイムアウトする時間を分単位で指定します。応答タイムアウト時間が過ぎると，サービスが異常終了します。

入力

無効

○　

ユーザー応答待ちオプション

vmware.checkPowerStateCount

電源状態の確認回数

仮想サーバの停止を確認する際の，電源状態の確認回数を指定します。電源状態の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

vmware.checkPowerStateInterval

電源状態の確認間隔

仮想サーバの停止を確認する際の，電源状態の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.vmName

仮想サーバ名

仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

仮想ディスク情報

vmware.vHardDiskName

仮想ディスク名

VMware vCenter Serverでの仮想ディスクの表示名を指定します。

入力

無効

○　

仮想ディスク情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.targetHost

256文字以内の半角英数字および「.」，「-」。

vmware.vCenterServerName

256文字以内の半角英数字および「.」，「-」。

vmware.userName

512文字以内の半角英数字および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「%」を除く。

vmware.password

127文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.portNumber

1〜65535の整数値。

vmware.protocol

次の値のどれかを選択する。

http,https

UserResponsePlugin.toAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.ccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.bccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.mailSubject

256文字以内の文字列。

UserResponsePlugin.mailBody

1024文字以内の文字列。

UserResponsePlugin.encodeType

次の値のどれかを選択する。

us-ascii,iso-2022-jp,shift_jis,euc-jp,utf-8

UserResponsePlugin.dialogText

512文字以内の文字列。

UserResponsePlugin.responseTimeOut

1〜9999の整数値。

vmware.checkPowerStateCount

1〜3600の整数値。

vmware.checkPowerStateInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.vmName

60文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」を除く。

vmware.vHardDiskName

1文字以上の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

電源状態取得

電源状態取得

仮想サーバの電源状態取得

VMware vSphere環境において，仮想サーバの電源状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

電源状態確認

電源状態確認

階層フロー部品

電源状態を調べ，電源状態がOFFでなければ，ユーザーに確認します。

−　

2-3

値判定分岐部品

出力文字列がPoweredOnを含むか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4

階層フロー部品

−　

−　

2-4-1

ユーザー応答待ち部品

電源をOFFにするか・しないかを確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4-2

戻り値判定分岐部品

ユーザー応答待ち部品の戻り値が1か判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4-3

異常終了部品

ジョブネットをエラーにします。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4-4

仮想サーバのシャットダウン

VMware vSphere環境において，仮想サーバのシャットダウンを行い，電源状態をOFFに設定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

ディスク削除

ディスク削除

階層フロー部品

仮想サーバで使用しているディスクを削除します。

−　

3-1

仮想ディスクの削除

VMware vSphere環境において，仮想サーバから仮想ディスクを削除します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.15.7　仮想サーバ追加(LU作成/データストア作成)

機能

ストレージシステム上にLUを作成し，VMware vSphere ESXi(またはVMware ESX Server)にデータストアを作成します。

このサービステンプレートが前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ

　VMware vSphere PowerCLIがインストールされているサーバです。

・ESXサーバ

　ESXがインストールされているサーバです。

・HDvMサーバ

　Hitachi Device Manager Softwareがインストールされているサーバです。

・HDvM CLIサーバ

　Hitachi Device Manager Software CLIがインストールされているサーバです。

次の処理を行います。

(1) HDvM CLIサーバから，ストレージシステム上に仮想ボリューム(DPボリューム)を1つ作成します。

(2) HDvM CLIサーバから，作成したボリュームをESXのホストグループに登録します。

(3) vCenter操作サーバから，追加したH-LUNをESXに認識させます。

(4) vCenter操作サーバから，ESXにデータストアを追加します。

(5) vCenter操作サーバから，追加したデータストアに対するFCパスを優先に設定します。

・DPプールの使用率が警告しきい値以上の場合はDPボリュームを作成できません。

・DPボリュームの容量はGB単位で指定してください。

操作するストレージシステムの種類によって，ストレージシステムのファミリー名を指定するプロパティが異なります。次のストレージシステムを操作する場合は，「ストレージシステムのファミリー名(カスタムオプション)」(hdvm.familyTextプロパティ)に指定します。その他のストレージシステムを操作する場合は，「ストレージシステムのファミリー名」(hdvm.familyプロパティ)に指定します。

・Hitachi Virtual Storage Platform G1500の場合，「VSP G1500」を指定します。

・Hitachi Virtual Storage Platform F1500の場合，「VSP F1500」を指定します。

・Hitachi Virtual Storage Platform G100/G200/G400/G600/G800の場合，「VSP Gx00」を指定します。

・Hitachi Virtual Storage Platform F400/F600/F800の場合，「VSP Fx00」を指定します。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)vCenter操作サーバの前提製品

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

(4)システム内のサーバに次の製品がセットアップされていること。また，HDvM CLIサーバに，Hitachi Device Manager Software CLIがセットアップされていること。

　・Hitachi Device Manager Software 07-00以降

(5)システム内のストレージシステムとして次のどれかがセットアップされていること。かつ，FC-SANストレージであること。

　・Hitachi Adaptable Modular Storage 2100/2300/2500/2010

　・Hitachi Unified Storage 110/130/150

　・Hitachi Unified Storage VM

　・Hitachi Universal Storage Platform V/VM

　・Hitachi Virtual Storage Platform

　・Hitachi Virtual Storage Platform G1000/G1500/F1500

　・Hitachi Virtual Storage Platform G100/G200/G400/G600/G800

　・Hitachi Virtual Storage Platform F400/F600/F800

【サービステンプレート実行システム内前提製品の稼働OS】

(1)vCenter操作サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

(2)HDvM CLIサーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

【サービステンプレート実行システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がvCenterで管理されていること。

(2)ストレージシステムがHitachi Device Manager Softwareで管理されていること。

(3)ストレージシステムにDPプール，ホストグループが作成済みであること。

(4)VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，このサービスが実行するvSphere Power CLIからは，指定した名称の英字の大文字・小文字を区別できません。そのため，英字の大文字・小文字が異なる同名の名称を使用している環境に対して，このサービスを使用することはできません。

　・データストア名

　・リソースプール名

　・vApp名

注意事項

(1)データストア名に次の文字は指定できません。

　スラッシュ(/)，バックスラッシュ(¥)，パーセント(%)

(2)VMware vSphere ESXi(またはVMware ESX Server)のバージョンが5以上の場合は，VMFSはバージョン5で作成されます。

(3)VMware vSphere ESXi(またはVMware ESX Server)のバージョンが5未満の場合は，VMFSはバージョン3で作成されます。

(4)作成可能なデータストアの最大容量はVMware vSphere ESXiのバージョンによって異なります。VMware vSphere ESXiの仕様にしたがって，hdvm.hdvmCapacityプロパティを指定してください。

(5)hdvm.hdvmArrayFamilyTextプロパティにはサポート対象外のストレージシステムを指定しないでください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　システム管理者ロール

(2)HDvMに接続するユーザーに，次の権限が必要です。

　リソースグループとして「All Resources」を割り当てられ，Admin権限またはModify権限を持つユーザー

(3)vCenter操作サーバに接続するユーザーに、次の権限が必要です。

　ビルトイン Administrator

バージョン

02.11.00

タグ

Add VM,VMware vSphere

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

HDvMとVMware vCenter Serverの情報を指定してください。

表示されます。

ストレージ情報

作成するDPボリュームに関連するストレージの情報を指定してください。

表示されます。

仮想環境情報

作成するデータストアに関連する仮想環境の情報を指定してください。

表示されます。

カスタムオプション

hdvm.hdvmArrayFamilyプロパティの選択リストにないストレージシステムの情報を指定してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hdvm.targetHost

HDvM CLIサーバのホスト名

Device Manager CLIがインストールされているサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

hdvm.cliInstallPath

HDvM CLIのインストールパス

Device Manager CLIのインストールパスを指定します。

入力

無効

○　

仮想システム環境情報

hdvm.hdvmProtocol

HDvMとの通信プロトコル

HDvMサーバに接続するためのプロトコルをhttpまたはhttpsで指定します。

入力

無効

○　

仮想システム環境情報

hdvm.hdvmHostName

HDvMサーバのホスト名

HDvMサーバのホスト名またはIPアドレスを指定します。

入力

無効

○　

仮想システム環境情報

hdvm.hdvmPortNumber

HDvMとの接続ポート番号

HDvMサーバに接続するためのポート番号を指定します。

入力

無効

○　

仮想システム環境情報

hdvm.hdvmUserName

HDvMに接続するためのユーザーID

HDvMサーバに接続するためのユーザーIDを指定します。

入力

無効

○　

仮想システム環境情報

hdvm.hdvmPassword

HDvMに接続するためのパスワード

HDvMサーバに接続するためのパスワードを指定します。

入力

無効

○　

仮想システム環境情報

vmware.targetHost

VMware vCenter操作サーバのホスト名

VMware vCenter Serverを操作するサーバ(vSphere PowerCLIインストール済みサーバ)のホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

入力

無効

○　

仮想システム環境情報

vmware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

入力

無効

○　

仮想システム環境情報

vmware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

入力

無効

△　

仮想システム環境情報

vmware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

入力

無効

○　

仮想システム環境情報

hdvm.hdvmSerialNumber

ストレージシステムのシリアル番号

実行対象のストレージシステムのシリアル番号を指定します。

入力

無効

○　

ストレージ情報

hdvm.hdvmArrayFamily

ストレージシステムのファミリー名

ストレージシステムのファミリー名を指定します。指定可能な値はAMS，USP_V，USP_VM，VSP，HUS，HUS VM，VSP G1000のどれかです。

入力

無効

○　

ストレージ情報

vmware.blockSizeMB

ブロックサイズ (MB)

ブロックサイズを指定します。ブロックサイズに応じてそのVMFS上に作成するファイルの単一ファイル当たりのサイズの上限値が決まります。ブロックサイズと最大ファイルサイズの対応を次に示します。1MB - 256GB，2MB - 512GB， 4MB - 1024GB，8MB - 2048GB。未指定時はVMware vCenter Serverのデフォルト値が設定されます。

入力

無効

△　

仮想環境情報

vmware.storageIOControlEnabled

ストレージI/Oのコントロール

データストアにおいてストレージI/Oのコントロールを有効にする場合，trueを指定します。それ以外の場合はfalseを指定します。

入力

無効

△　

仮想環境情報

vmware.congestionThresholdMillisecond

輻輳しきい値 (msec)

VMware vCenter ServerにストレージI/Oコントロールのデータストアの輻輳しきい値をミリ秒単位で指定します。輻輳しきい値未指定時は，VMware vCenter Serverのデフォルト値が設定されます。

入力

無効

△　

仮想環境情報

hdvm.hdvmArrayFamilyText

ストレージシステムのファミリー名(カスタムオプション)

hdvm.hdvmArrayFamilyプロパティの選択リストにないストレージシステムのファミリー名を指定します。このプロパティを指定した場合，hdvm.hdvmArrayFamilyプロパティに指定した値は無視されます。

入力

無効

△　

カスタムオプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hdvm.hdvmCapacity

DPボリューム(LU)の容量 (GB)

作成するDPボリューム(LU)の容量をGB単位で指定します。

入力

無効

○　

ストレージ情報

hdvm.hdvmDevNumber

DPボリューム(LU)のデバイス番号

DPボリューム(LU)のデバイス番号を10進数で指定します。

入力

無効

○　

ストレージ情報

hdvm.hdvmPoolId

DPプールのプールID

作成したDPボリューム(LU)を関連づけるDPプールのプールIDを指定します。

入力

無効

○　

ストレージ情報

hdvm.hdvmPathPortName

パスのポート名

DPボリューム(LU)へのパスのポート名を指定します。

入力

無効

○　

ストレージ情報

hdvm.hdvmDomainId

ホストグループのID

DPボリューム(LU)を追加するホストグループのIDを10進数または16進数で指定します。16進数の場合は"0x"をプレフィックスとして付与してください。

入力

無効

○　

ストレージ情報

hdvm.hdvmLun

LU Number(LUN)

LU Number(LUN)を指定します。

入力

無効

○　

ストレージ情報

vmware.vmHostName

ESXサーバ名

VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。

入力

無効

○　

仮想環境情報

vmware.dataStoreName

データストア名

データストアの名称を指定します。

入力

無効

○　

仮想環境情報

vmware.hbaName

HBA名

優先するHBA名を，VMware vCenter Serverのストレージアダプタのランタイム名に表示される形式で指定します(例：vmhba0)。

入力

無効

○　

仮想環境情報

vmware.controllerNumber

コントローラ番号

SCSI LUNのランタイム名のコントローラ番号を指定します。

入力

無効

○　

仮想環境情報

vmware.targetNumber

ターゲット番号

SCSI LUNのランタイム名のターゲット番号を指定します。

入力

無効

○　

仮想環境情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hdvm.targetHost

255文字以内の半角英数字および「.」，「-」。

hdvm.cliInstallPath

1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「^」を除く。

hdvm.hdvmProtocol

次の値のどれかを選択する。

http,https

hdvm.hdvmHostName

255文字以内の半角英数字および「.」，「-」。

hdvm.hdvmPortNumber

1〜65535の整数値。

hdvm.hdvmUserName

1文字以上256文字以内の文字列。使用できるのは次の文字だけ。半角英数字，「!」，「#」，「$」，「%」，「'」，「(」，「)」，「*」，「+」，「-」，「.」，「=」，「@」，「¥」，「^」，「_」。ただし，末尾に「¥」は使用できない。

hdvm.hdvmPassword

4文字以上256文字以内の文字列。使用できるのは次の文字だけ。半角英数字，「!」，「#」，「$」，「%」，「'」，「(」，「)」，「*」，「+」，「-」，「.」，「=」，「@」，「¥」，「^」，「_」。ただし，末尾に「¥」は使用できない。

vmware.targetHost

256文字以内の半角英数字および「.」，「-」。

vmware.vCenterServerName

256文字以内の半角英数字および「.」，「-」。

vmware.userName

512文字以内の半角英数字および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「%」を除く。

vmware.password

127文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.portNumber

1〜65535の整数値。

vmware.protocol

次の値のどれかを選択する。

http,https

hdvm.hdvmSerialNumber

1文字以上20文字以内の半角英数字。

hdvm.hdvmArrayFamily

次の値のどれかを選択する。

AMS,USP_V,USP_VM,VSP,HUS,HUS VM,VSP G1000

vmware.blockSizeMB

次の値のどれかを選択する。

1,2,4,8

vmware.storageIOControlEnabled

次の値のどれかを選択する。

true,false

vmware.congestionThresholdMillisecond

5〜100の整数値。

hdvm.hdvmArrayFamilyText

255文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hdvm.hdvmCapacity

1〜65536の整数値。

hdvm.hdvmDevNumber

0〜524287の整数値。

hdvm.hdvmPoolId

0〜2147483647の整数値。

hdvm.hdvmPathPortName

1文字以上の文字列。ただし，「<」，「>」，「|」，「;」，「&」および末尾の「¥」を除く。

hdvm.hdvmDomainId

1文字以上の半角数字，および半角英字a〜f，A〜F，x。

hdvm.hdvmLun

0〜255の整数値。

vmware.vmHostName

256文字以内の半角英数字および「.」，「-」。

vmware.dataStoreName

42文字以内の半角英数記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.hbaName

1文字以上の半角英数字。

vmware.controllerNumber

0以上の整数値。

vmware.targetNumber

0以上の整数値。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

LU作成

LU作成

DPボリュームの作成

Device Managerで管理されたストレージシステムで，指定されたDPボリュームを作成します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

ホストグループ登録

ホストグループ登録

ホストグループにLUを登録

Device Managerで管理されたストレージシステムで，指定されたLUをホストグループに登録します。

エラーの原因を取り除いたあと，HDvMでLUを削除してから，

サービスを再実行してください。

3

LUの再認識

LUの再認識

LUNの再認識

追加または削除したLUNをVMware vSphere ESXi(またはVMware ESX Server)に認識させます。

エラーの原因を取り除いたあと，HDvMでLUを削除してから，

サービスを再実行してください。

4

SCSI LUNのパス名を取得

SCSI LUNのパス名を取得

SCSI LUNのCanonical名を取得

VMware vSphere ESXi(またはVMware ESX Server)が認識しているSCSI LUNのCanonical名を取得します。

エラーの原因を取り除いたあと，HDvMでLUを削除してから，

サービスを再実行してください。

5

データストア作成

データストア作成

データストア作成

VMware vSphere ESXi(またはVMware ESX Server)にデータストアを追加します。

エラーの原因を取り除いたあと，手動でデータストアを作成してください。

6

FC優先制御設定

FC優先制御設定

FCパスの優先設定

VMware vSphere ESXi(またはVMware ESX Server)の指定されたデータストアに対するFCパスを「優先」に設定します。

エラーの原因を取り除いたあと，手動で優先パスを設定してください。

3.15.8　仮想サーバ追加(デプロイ/OS初期設定)

機能

VMware vSphere環境にテンプレートを用いて仮想サーバを追加します。

このサービステンプレートが前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ

　VMware vSphere PowerCLIがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXi(またはVMware ESX Server)がインストールされているサーバです。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXによって管理されている仮想サーバです。

次の処理を行います。

(1) 既存のテンプレートを用いて仮想サーバを新規に作成します。

(2) 仮想サーバの初期情報を設定します。

　1. OSの初期情報を設定します(コンピュータ名，会社名など)。仮想サーバのOSに応じて次の設定を実施します。

　　(a) Windowsの場合

　　・OSの初期設定として，コンピュータ名，会社名，組織名，タイムゾーンを設定します。

　　　sysprepを使用して仮想サーバのシステム情報をいったんクリアし，そのあとOS情報を設定します。

　　(b) Linuxの場合

　　・OSの初期設定として，コンピュータ名，タイムゾーンを設定します。

　2. 仮想サーバのIPアドレスを設定します。

　　仮想サーバは最大4個までIPアドレスを設定することができます。1個目のIPアドレス(管理用)には，デプロイした仮想サーバを管理するためのIPアドレスを設定してください。2〜4個目のIPアドレス(2個目用)・IPアドレス(3個目用)・IPアドレス(4個目用)については，管理用・業務用IPアドレスをユーザーの運用に合わせて設定してください。仮想サーバが持つNICの数によってIPアドレスの設定順序は次のようになります。

　　・仮想サーバがNICを1個持つ場合

　　　NICには，IPアドレス(管理用)>IPアドレス(2個目用)>IPアドレス(3個目用)>IPアドレス(4個目用)の順で最初に指定されていたIPアドレスを設定します。その他のIPアドレスは破棄されますのでご注意ください。

　　・仮想サーバがNICを2個以上持つ場合

　　　NICには，IPアドレス(管理用)>IPアドレス(2個目用)>IPアドレス(3個目用)>IPアドレス(4個目用)の順でIPアドレスを設定します。IPアドレスの指定に空きがある場合，詰めて設定します。例えば，指定するIPアドレスがIPアドレス(管理用)，IPアドレス(2個目用)，IPアドレス(4個目用)の場合(IPアドレス(3個目用)がない場合)，IPアドレス(4個目用)は仮想マシンの3つ目のNICに設定します。入力したIPアドレスの数が仮想サーバが持つNICの数より多い場合，超えた分のIPアドレスは破棄されますのでご注意ください。

　　作成する仮想サーバがLinuxの場合，NICごとではなく，仮想サーバに対してDNSサーバのIPアドレスを設定します。仮想サーバには，DNSサーバのIPアドレス(管理用)>DNSサーバのIPアドレス(2個目用)>DNSサーバのIPアドレス(3個目用)>DNSサーバのIPアドレス(4個目用)の順で最初に指定されていたDNSサーバのIPアドレスを設定します。

(3) 仮想サーバのIPアドレスが複数設定された場合に，仮想サーバのOSに対して，スタティックルートを設定します。

　仮想サーバのOSに設定するIPアドレス(管理用)が指定されていない場合，スタティックルートの設定処理は実行されません。

(4) 仮想サーバのポートグループを設定します。

プロパティ設定の留意点を次に示します。

(1)作成する仮想サーバがWindowsの場合，組織名と所有者名は必須となります。組織名の指定がない場合は，"Organization"が設定されます。所有者名の指定がない場合は，"Owner"が設定されます。

(2)作成する仮想サーバがWindowsの場合，OSユーザーパスワードとOSユーザーパスワード再入力は必須となります。どちらかの指定がない場合，"Password123"がパスワードに設定されます。また，2つの値が合致しない場合も"Password123"がパスワードに設定されます。

(3)作成する仮想サーバがWindowsの場合，OS.selectWorkgroupDomainの選択リストで，WORKGROUPかDOMAINの指定が必須となります。どちらの指定もない場合，ワークグループとして"WORKGROUP"が設定されます。また，ワークグループ名/ドメイン名の入力がない場合も，ワークグループとして"WORKGROUP"が設定されます。

(4)作成する仮想サーバがWindowsの場合，OS.selectWorkgroupDomainの選択リストで，WORKGROUPを選択した場合，指定できるワークグループ名は最大15byteまでとなります。16byteを超えると"WORKGROUP"が設定されます。

(5)作成する仮想サーバがWindowsの場合，OS.selectWorkgroupDomainの選択リストで，DOMAINを選択した場合，ドメイン名，ドメイン ユーザー名，ドメイン パスワードが必須となります。どれかの指定がない場合，もしくは値が誤っている場合，ワークグループとして"WORKGROUP"が設定されます。

(6)作成する仮想サーバがLinuxの場合，ドメイン名，DNSサフィックスが必須となります。指定がない場合，"localdomain"が設定されます。

(7)作成する仮想サーバがWindowsの場合，IPアドレス，サブネットマスク，デフォルトゲートウェイ，DNSサーバは，4つの情報をすべて指定してください。どれかの指定がない場合，4つとも設定は行われません。

(8)作成する仮想サーバがLinuxの場合，IPアドレス，サブネットマスク，デフォルトゲートウェイは，3つの情報をすべて指定してください。どれかの指定がない場合，3つとも設定は行われません。

(9)OS情報取得の繰り返し回数の指定がない場合，"72"が設定されます。

(10)OS情報取得の繰り返し実行間隔の指定がない場合，"5"が設定されます。

(11)ポートグループ名，ポートグループ名(変更後)は同時に指定してください。どちらかの指定がない場合，ポートグループの変更は行われません。また，同じ名前のポートグループを複数持つ場合，変更されるポートグループ名は1つだけです。

(12)宛先IPアドレス，サブネットマスク，デフォルトゲートウェイは同時に指定してください。どれかの指定がない場合，スタティックルートの設定は行われません。

(13)仮想サーバ名プロパティ(vmware.vmName)に指定できる最大の文字数は60文字です。

(14)指定可能なタイムゾーンは次のとおりです。

　(a) Windowsの場合

　　Alaskan

　　Central (U.S. and Canada)

　　Central America+B28

　　China

　　Eastern (U.S. and Canada)

　　GMT (Greenwich Mean Time)

　　Hawaii

　　India

　　Mountain (U.S. and Canada)

　　Pacific

　　Singapore

　　Tokyo

　　U.S. Eastern: Indiana (East)

　　U.S. Mountain: Arizona

　(b) Linuxの場合

　　America/Adak

　　America/Anchorage

　　America/Boise

　　America/Chicago

　　America/Denver

　　America/Detroit

　　America/Indiana/Indianapolis

　　America/Indiana/Knox

　　America/Indiana/Marengo

　　America/Indiana/Petersburg

　　America/Indiana/Tell_City

　　America/Indiana/Vevay

　　America/Indiana/Vincennes

　　America/Indiana/Winamac

　　America/Juneau

　　America/Kentucky/Monticello

　　America/Los_Angeles

　　America/LouisVille

　　America/Menominee

　　America/Monterrey

　　America/Montevideo

　　America/New_York

　　America/Nome

　　America/North_Dakota/Beulah

　　America/North_Dakota/Center

　　America/North_Dakota/New_Salem

　　America/Phoenix

　　America/Shiprock

　　America/Tijuana

　　America/Vancouver

　　America/Yakutat

　　Asia/Chongqing

　　Asia/Hong_Kong

　　Asia/Kolkata

　　Asia/Macau

　　Asia/Shanghai

　　Asia/Singapore

　　Asia/Tokyo

　　Etc/UTC

　　Europe/London

　　Pacific/Honolulu

(15)Windows用のタイムゾーンプロパティ(OS.timeZoneWin)に指定がない場合，「国際日付変更線 西側」のタイムゾーンが設定されます。

(16)Linux用のタイムゾーンプロパティ(OS.timeZoneLin)に指定がない場合，テンプレートのタイムゾーンが使用されます。このため，タイムゾーンプロパティのリストに設定したい値が存在しない場合は，事前にテンプレートにタイムゾーンを設定してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)vCenter操作サーバの前提製品

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【サービステンプレート実行システム内前提製品の稼働OS】

(1)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)(vCenter4.1以降。vCenter4.0では未サポート)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　　・bind-utilsパッケージがインストールされていること。

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　　・bind-utilsパッケージがインストールされていること。

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　　・bind-utilsパッケージがインストールされていること。

　・CentOS 8 (64-bit x86_64)

　　・bind-utilsパッケージがインストールされていること。

(2)vCenter操作サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

【サービステンプレート実行システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)上の設定に関する条件

　・データストアが登録済みであること。

　・テンプレートに設定しているポートグループが，デプロイ先のESXサーバに設定済みで，ローカルサーバと通信可能であること。

　・仮想サーバに設定するポートグループが，デプロイ先のESXサーバに設定済みで，ローカルサーバと通信可能であること。

　・ポートグループは，標準仮想スイッチ(vNetwork 標準スイッチ/vSphere 標準スイッチ)を使ったネットワーク上のポートグループを指定してください。

　・デプロイ時に使用するデータストア名，ポートグループ名はASCII文字であること。

　・デプロイに使用するテンプレートが作成済みであること。

　・仮想サーバをリソースプールに格納する場合，リソースプール，クラスタ，vAppの名称が一意であること。

　　クラスタとvApp，クラスタとリソースプールの組み合わせなど，種別が異なっていても，同じ名前にすることはできません。

　・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，このサービスが実行するvSphere Power CLIからは，指定した名称の英字の大文字・小文字を区別できません。

　　そのため，英字の大文字・小文字が異なる同名の名称を使用している環境に対して，このサービスを使用することはできません。

　　　・データストア名

　　　・リソースプール名

　　　・vApp名

(2)デプロイに使用するテンプレートに関する条件

　・VMware Toolsがインストール済みであること

　・リモートコマンドが実行可能な設定であること。Windowsの場合は管理共有，Linuxの場合はSSHが有効になっていること。

　・NICが設定してあること(最大4個まで)。

　・ポートグループには，標準仮想スイッチ(vNetwork 標準スイッチ/vSphere 標準スイッチ)を使ったネットワーク上のポートグループを設定してください。

　・pingの受付，応答を許可していること。

　・Windowsの場合，Administrator のパスワードを空にしておくこと。

　・Windowsの場合，sysprepを実行する。そのため，Windows初期化の実行回数が限度回数(3回)に達していないこと。

　・仮想サーバのテンプレート化を実施する際には，仮想サーバが停止した状態でテンプレート化を行ってください。

(3)仮想サーバに関する条件

　・同一のvCenterの管理下で，仮想サーバ名が重複しないこと。

(4)本製品に関する条件

　・デプロイする仮想サーバは，「管理タブ」のエージェントレス接続先定義に，事前に認証情報を登録してあること。

注意事項

(1)指定するポートグループは，ローカルサーバと通信可能なポートグループを指定する必要があります。仮想サーバに複数のポートグループを設定する場合，仮想サーバのテンプレートの1つ目のNICに設定するポートグループは，ローカルサーバと通信可能なポートグループにしてください。

(2)OSの初期設定処理で，OSに設定した情報を取得できるかどうかによって初期設定が完了したかどうかを確認します。この初期設定完了の確認時間は，OS情報取得の繰り返し時間(vmware.checkOSInitCountIntervalプロパティ)に指定した時間と，OS情報取得の繰り返し回数(vmware.checkOSInitCountプロパティ)に指定した回数によって決定します。この値が小さすぎますと，OS初期設定中にもかかわらず，タイムアウトとなる場合があります。ご使用の仮想化環境の性能に合わせて調整してください。初めは，OS情報取得の実行間隔と組み合わせて数時間となるように設定してください。

(3)仮想サーバのOSに設定するIPアドレスについて，IPアドレスとして設定できない値は入力しないでください。例えば，ネットワークアドレスやブロードキャストアドレス，「0.0.0.0」や「255.255.255.255」などの特殊なアドレスは指定できません。入力した場合，仮想サーバのデプロイはエラーとなります。また，IPアドレス(管理用)には，ローカルサーバと通信できるIPアドレスを入力してください。正しいアドレスであっても，デプロイに失敗するおそれがあります。

(4)仮想サーバのデプロイ中は，ほかのサービスによって当該仮想サーバの操作を行わないでください。仮想サーバのデプロイに失敗するおそれがあります。vCenterサーバからも直接操作を行わないでください。

(5)Linuxのデプロイを行う場合，テンプレートOSのrootパスワードはLinux.adminPasswordプロパティで指定可能な文字で設定してください。

(6)仮想サーバのテンプレートには，仮想サーバ作成時に設定する情報をあらかじめ設定しないでください。コンピュータ名/ホスト名やIPアドレスがテンプレートに設定されている場合，仮想サーバの作成に失敗する場合があります。失敗した場合(失敗の例としては，スタティックルートの処理でエラーが発生します。)，一度仮想サーバを削除し，コンピュータ名/ホスト名とIPアドレスが設定されていないテンプレートを再作成のあと，このサービスを再実行してください。

(7)IPアドレスは「機能」に記載のとおり設定されますが，仮想サーバのOSにNICを設定した順番によっては，意図どおりIPアドレスが設定されない場合があるため，仮想サーバ作成後はIPアドレスが意図どおり設定されているか確認してください。もし設定されていない場合は，手動で変更してください。

(8)仮想サーバに設定するIPアドレスは，他のサーバと重複しないようにしてください。他のサーバとIPアドレスが重複していると，仮想サーバのNICが無効状態となり，タスクが異常終了します。

(9)仮想サーバのOSがRed Hat Enterprise Linux Server 7 (64-bit x86_64)の場合，VMware Toolsはopen-vm-tools 9.10以降のものを使用してください。open-vm-tools 9.10より前のバージョンの場合，ホスト名が変更されず，初期設定完了の確認時間までサービスが終了しません。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　システム管理者ロール

(2)vCenter操作サーバに接続するユーザーに、次の権限が必要です。

　ビルトイン Administrator

バージョン

03.00.00

タグ

Add VM,VMware vSphere

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

VMware vCenter Serverの情報を指定してください。

表示されます。

仮想サーバ情報

追加する仮想サーバの情報を指定してください。

表示されます。

OS情報

仮想サーバに作成するWindowsまたはLinuxのOS情報を指定してください。

表示されます。

ネットワーク情報

仮想サーバのネットワーク情報を指定してください。

表示されます。

実行時オプション

仮想サーバのOS初期設定を行う際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.targetHost

VMware vCenter操作サーバのホスト名

VMware vCenter Serverを操作するサーバ(vSphere PowerCLIインストール済みサーバ)のホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

入力

無効

○　

仮想システム環境情報

vmware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

入力

無効

○　

仮想システム環境情報

vmware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

入力

無効

△　

仮想システム環境情報

vmware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

入力

無効

○　

仮想システム環境情報

windows.orgName

組織名(会社名) :Windows固有

仮想サーバのOSに設定する組織名を指定します(Windowsの場合だけ)。入力がない場合，"Organization"が設定されます。

入力

無効

△　

OS情報

windows.ownerName

名前(所有者名) :Windows固有

仮想サーバのOSに設定する名前(所有者名)を指定します(Windowsの場合だけ)。入力がない場合，"Owner"が設定されます。

入力

無効

△　

OS情報

OS.selectWorkgroupDomain

ワークグループ/ドメインの選択 :Windows固有

仮想サーバがワークグループまたはドメインのどちらに所属するかを指定します(Windowsの場合だけ)。

入力

無効

△　

OS情報

OS.workgroupNameDomainName

ワークグループ名/ドメイン名

仮想サーバが所属するワークグループ名/ドメイン名を指定します。ワークグループ名は，最大15文字まで指定します。ドメイン名は，Windowsの場合，最大63文字まで，Linuxの場合，最大256文字まで指定します。

入力

無効

△　

OS情報

OS.domainUserName

ドメインのユーザー名 :Windows固有

仮想サーバが所属するドメインのユーザー名を指定します(Windowsの場合だけ)。ワークグループ/ドメインの選択で「DOMAIN」を選択した場合，入力する必要があります。

入力

無効

△　

OS情報

OS.domainUserPassword

ドメインのパスワード :Windows固有

仮想サーバが所属するドメインのパスワードを指定します(Windowsの場合だけ)。ワークグループ/ドメインの選択で「DOMAIN」を選択した場合，入力する必要があります。

入力

無効

△　

OS情報

OS.dnsSuffix

DNS サフィックス名 :Linux固有

DNSサフィックス名を指定します(Linuxの場合だけ)。入力がない場合，"localdomain"が設定されます。

入力

無効

△　

OS情報

OS.subnetMaskMan

サブネットマスク(管理用)

仮想サーバに設定する管理用LANのサブネットマスクを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.defaultGWMan

デフォルトゲートウェイ(管理用)

仮想サーバに設定する管理用LANのデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.dnsMan

DNSサーバのIPアドレス(管理用)

仮想サーバに設定するDNSサーバのIPアドレスを指定します。Windowsの場合，管理用LANに設定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.subnetMask2

サブネットマスク(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.defaultGW2

デフォルトゲートウェイ(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.dns2

DNSサーバのIPアドレス(2個目用)

仮想サーバに設定するDNSサーバのIPアドレスを指定します。Windowsの場合，OSが認識する2個目のNICに設定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.subnetMask3

サブネットマスク(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.defaultGW3

デフォルトゲートウェイ(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.dns3

DNSサーバのIPアドレス(3個目用)

仮想サーバに設定するDNSサーバのIPアドレスを指定します。Windowsの場合，OSが認識する3個目のNICに設定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.subnetMask4

サブネットマスク(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.defaultGW4

デフォルトゲートウェイ(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.dns4

DNSサーバのIPアドレス(4個目用)

仮想サーバに設定するDNSサーバのIPアドレスを指定します。Windowsの場合，OSが認識する4個目のNICに設定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.destIPAddress

スタティックルートの宛先IPアドレス

スタティックルートの宛先IPアドレスを指定します。

入力

無効

△　

ネットワーク情報

OS.subnetMaskStaticRoute

サブネットマスク(スタティックルート用)

スタティックルート用のサブネットマスクを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.defaultGWStaticRoute

デフォルトゲートウェイ(スタティックルート用)

スタティックルート用のデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

vmware.checkOSInitCount

OS情報取得の繰り返し回数

OS初期設定の完了確認のため，OS情報を取得する際の繰り返し回数を指定します。OS情報取得の実行間隔と組み合わせて最大待ち時間となります。

入力

無効

△　

実行時オプション

vmware.checkOSInitCountInterval

OS情報取得の実行間隔(分)

OS初期設定の完了確認のため，OS情報を取得する際の実行間隔を指定します。

入力

無効

△　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.vmName

仮想サーバ名

仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

仮想サーバ情報

vmware.templateName

テンプレート名

仮想サーバの基となるテンプレート名を指定します。

入力

無効

○　

仮想サーバ情報

vmware.vmHostName

ESXサーバ名

VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。

入力

無効

○　

仮想サーバ情報

vmware.dataStoreName

データストア名

データストアの名称を指定します。

入力

無効

○　

仮想サーバ情報

vmware.resourcePoolName

リソースプール名

仮想サーバを格納するリソースプール，vApp，クラスタを指定します。

入力

無効

△　

仮想サーバ情報

vmware.portGroupName

ポートグループ名

仮想サーバに現在設定されているポートグループ名(変更前)を指定します。

入力

無効

△　

仮想サーバ情報

vmware.portGroupNameNew

ポートグループ名(更新時)

仮想サーバに新しく設定するポートグループ名を指定します。

入力

無効

△　

仮想サーバ情報

OS.computerName

コンピュータ名/ホスト名

OSのコンピュータ名(ホスト名)を指定します。Windowsの場合，最大15文字まで，Linuxの場合，最大63文字まで指定します。

入力

無効

○　

OS情報

OS.osUserPassword

Administratorのパスワード :Windows固有

OSに設定するAdministratorのパスワードを指定します(Windowsの場合だけ)。入力がない場合は，"Password123"が設定されます。

入力

無効

△　

OS情報

OS.osUserPasswordReEnter

Administratorのパスワード再入力 :Windows固有

OSに設定するAdministratorのパスワードを再入力してください(Windowsの場合だけ)。入力がない場合は，"Password123"が設定されます。

入力

無効

△　

OS情報

OS.productKey

OSのプロダクトキー :Windows固有

OSのプロダクトキーを指定します。Windowsの場合だけ指定します。入力の形式は「XXXXX-XXXXX-XXXXX-XXXXX-XXXXX」です(Windowsの場合だけ)。

入力

無効

△　

OS情報

Linux.adminPassword

OSのrootユーザーのパスワード :Linux固有

OS設定の確認をするためのOSのrootユーザーのパスワードを設定します。作成するOSがLinuxの場合に必ず指定します。

入力

無効

△　

OS情報

OS.ipAddressMan

IPアドレス(管理用)

仮想サーバに設定する管理用LANのIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.ipAddress2

IPアドレス(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.ipAddress3

IPアドレス(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.ipAddress4

IPアドレス(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

ネットワーク情報

OS.timeZoneWin

タイムゾーン :Windows固有

仮想サーバのOSに設定するタイムゾーンを指定します(Windowsの場合だけ)。入力がない場合，「国際日付変更線 西側」のタイムゾーンが設定されます。

入力

無効

△　

OS情報

OS.timeZoneLin

タイムゾーン :Linux固有

仮想サーバのOSに設定するタイムゾーンを指定します(Linuxの場合だけ)。入力がない場合，テンプレートのタイムゾーンが使用されます。

入力

無効

△　

OS情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.targetHost

256文字以内の半角英数字および「.」，「-」。

vmware.vCenterServerName

256文字以内の半角英数字および「.」，「-」。

vmware.userName

512文字以内の半角英数字および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「%」を除く。

vmware.password

127文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.portNumber

1〜65535の整数値。

vmware.protocol

次の値のどれかを選択する。

http,https

windows.orgName

256文字以内の文字列。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

windows.ownerName

256文字以内の文字列。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

OS.selectWorkgroupDomain

次の値のどれかを選択する。

WORKGROUP,DOMAIN

OS.workgroupNameDomainName

256文字以内の半角英数字。および「-」，「.」。

OS.domainUserName

20文字以内の半角英数字。および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「¥」，「@」，「%」を除く。

OS.domainUserPassword

127文字以内の半角英数字。および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

OS.dnsSuffix

63文字以内の半角英数字。および「-」，「.」。

OS.subnetMaskMan

15文字以内の半角数字および「.」。

OS.defaultGWMan

15文字以内の半角数字および「.」。

OS.dnsMan

15文字以内の半角数字および「.」。

OS.subnetMask2

15文字以内の半角数字および「.」。

OS.defaultGW2

15文字以内の半角数字および「.」。

OS.dns2

15文字以内の半角数字および「.」。

OS.subnetMask3

15文字以内の半角数字および「.」。

OS.defaultGW3

15文字以内の半角数字および「.」。

OS.dns3

15文字以内の半角数字および「.」。

OS.subnetMask4

15文字以内の半角数字および「.」。

OS.defaultGW4

15文字以内の半角数字および「.」。

OS.dns4

15文字以内の半角数字および「.」。

OS.destIPAddress

15文字以内の半角数字および「.」。

OS.subnetMaskStaticRoute

15文字以内の半角数字および「.」。

OS.defaultGWStaticRoute

15文字以内の半角数字および「.」。

vmware.checkOSInitCount

1〜1024の整数値。

vmware.checkOSInitCountInterval

1〜1024の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.vmName

60文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」を除く。

vmware.templateName

60文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.vmHostName

256文字以内の半角英数字および「.」，「-」。

vmware.dataStoreName

42文字以内の半角英数記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.resourcePoolName

60文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.portGroupName

49文字以内の半角英数字。 および，「 (スペース)」，「-」，「.」，「/」，「_」。

vmware.portGroupNameNew

49文字以内の半角英数字。 および，「 (スペース)」，「-」，「.」，「/」，「_」。

OS.computerName

63文字以内の半角英数字および「-」。

OS.osUserPassword

64文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

OS.osUserPasswordReEnter

64文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

OS.productKey

29文字以内の半角英数字，および「-」。

Linux.adminPassword

255文字以内の半角英数字。 および「.」。

OS.ipAddressMan

15文字以内の半角数字および「.」。

OS.ipAddress2

15文字以内の半角数字および「.」。

OS.ipAddress3

15文字以内の半角数字および「.」。

OS.ipAddress4

15文字以内の半角数字および「.」。

OS.timeZoneWin

次の値のどれかを選択する。

Tokyo, China, GMT (Greenwich Mean Time), Pacific, Eastern (U.S. and Canada), U.S. Eastern: Indiana (East), Central (U.S. and Canada), Central America, U.S. Mountain: Arizona, Mountain (U.S. and Canada), Alaskan, Hawaii, Singapore, India

OS.timeZoneLin

次の値のどれかを選択する。

Asia/Tokyo, Asia/Hong_Kong, Asia/Chongqing, Asia/Shanghai, Etc/UTC, America/Tijuana, America/Vancouver, America/Los_Angeles, America/Detroit, America/New_York, America/Montevideo, America/LouisVille, America/Indiana/Indianapolis, America/Indiana/Vevay, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Vincennes, America/Indiana/Winamac, America/Indiana/Tell_City, America/Indiana/Knox, America/Chicago, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Kentucky/Monticello, America/Juneau, America/Menominee, America/Monterrey, America/Denver, America/Boise, America/Shiprock, America/Phoenix, America/Yakutat, America/Anchorage, America/Nome, America/Adak, Pacific/Honolulu, Asia/Singapore, Europe/London, Asia/Kolkata, America/North_Dakota/Beulah, Asia/Macau

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの作成

仮想サーバの作成

仮想サーバの作成

テンプレートから仮想サーバを作成します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

OS初期設定&IPアドレス設定

OS初期設定&IPアドレス設定

階層フロー部品

仮想サーバのOS初期設定(コンピュータ名，会社名，組織名)とIPアドレス設定を行い，仮想サーバを起動します。

(Windowsの場合，内部でsysprepを実行します)

−　

2-3

値判定分岐部品

OSがWindowsか判定します。

エラーの原因を取り除いたあと，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

2-4

仮想サーバのOS初期設定&IPアドレス設定(Windows)

仮想サーバのOS初期設定とIPアドレス設定を行います(Windows用)。

エラーの原因を取り除いたあと，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

2-5

値判定分岐部品

OSがLinuxか判定します。

エラーの原因を取り除いたあと，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

2-6

仮想サーバのOS初期設定&IPアドレス設定(Linux)

仮想サーバのOS初期設定とIPアドレス設定を行います(Linux用)。

エラーの原因を取り除いたあと，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

3

OSスタティックルートの設定

OSスタティックルートの設定

階層フロー部品

仮想サーバのOSで，スタティックルートを設定します。

−　

3-3

値判定分岐部品

スタティックルートの設定が必要か判定します。

エラーの原因を取り除いたあと，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

3-4

階層フロー部品

仮想サーバのOSで，管理用IPアドレスが設定されていることを確認します。

−　

3-4-3

値判定分岐部品

仮想サーバのOSで，管理用IPアドレスが設定されているか判定します。

エラーの原因を取り除いたあと，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

3-4-4

階層フロー部品

OS上でスタティックルートを設定します。

−　

3-4-4-3

値判定分岐部品

OSがWindowsか判定します。

エラーの原因を取り除いたあと，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

3-4-4-4

スタティックルートの設定

スタティックルートを設定します(Windows用)。

エラーの原因を取り除いたあと，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

3-4-4-5

値判定分岐部品

OSがLinuxか判定します。

エラーの原因を取り除いたあと，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

3-4-4-6

スタティックルートの設定

スタティックルートを設定します(Linux用)。

エラーの原因を取り除いたあと，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

4

仮想サーバのポートグループ変更

仮想サーバのポートグループ変更

仮想マシンのポートグループ変更

仮想サーバのポートグループを設定します。

エラーの原因を取り除いたあと，仮想サーバ削除のサービスを実行し，このサービスを再実行してください。

3.15.9　仮想サーバ追加(仮想ディスク)

機能

複数の仮想サーバにディスクを追加します。

このサービステンプレートが前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ

　VMware vSphere PowerCLIがインストールされているサーバです。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXによって管理されている仮想サーバです。

処理の概要を以下に示します。

(1) 仮想サーバの電源状態を取得します。

(2) 仮想サーバの電源状態がOFFになっていることを確認します。

　　電源状態がOFFでない場合は，ユーザー応答待ち部品を実行して，電源をOFFにするか・しないかを確認します。

　　ユーザー応答待ち部品のメール送信先/送信内容，タイムアウト，画面表示内容はModify権限のユーザーが設定できます。

　　ユーザー応答待ちのGUIで"Shutdown"を選択した場合は，仮想サーバのシャットダウンを行います。

　　"Cancel"を選択するか，応答待ちがタイムアウトになった場合は，仮想サーバには操作を行わずにサービスが異常終了します。

　　仮想サーバを停止する際には，vmware.checkPowerStateIntervalプロパティに指定した秒数待ち合わせ，電源状態がOFFになることを確認する動作を，vmware.checkPowerStateCountプロパティに指定した回数繰り返します。デフォルトの値で不都合がある場合，利用している環境に合わせて調整してください。

(3) 仮想サーバに仮想ディスクを追加します。

仮想サーバが複数の場合，指定した条件の仮想ディスクを各仮想サーバに追加します。この処理は並列に実行されます。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)vCenter操作サーバの前提製品

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【サービステンプレート実行システム内前提製品の稼働OS】

(1)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86),Red Hat Enterprise Linux Server 6 (64-bit x86_64)(vCenter4.1以降。vCenter4.0では未サポート)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

(2)vCenter操作サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

【サービステンプレート実行システム内前提製品の使用条件】

(1)仮想ディスクの追加対象となる仮想サーバの電源がOFFになっていること。

(2)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(3)仮想マシン名はvCenterサーバ内で一意になるようにしてください。

(4)対象となる仮想サーバに，VMwareToolsがインストールされていること。

注意事項

(1)このサービステンプレートでは仮想サーバに追加した仮想ディスクの初期化は行いません。必要に応じて仮想サーバのOSにログインし，ディスクの初期化を実施してください。

(2)同一の仮想サーバに対して，このサービスを複数同時に実行しないでください。

(3)UserResponseplugin.dialogTextにHTMLタグを指定する場合，指定できるタグおよび属性はユーザー応答待ち部品と同じです。詳細については，本製品マニュアルの「ユーザー応答待ち部品」について説明しているトピックを参照してください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　システム管理者ロール

バージョン

03.00.00

タグ

Modify VM,VMware vSphere

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

VMware vCenter Serverの情報を指定してください。

表示されます。

仮想ディスク情報

追加する仮想ディスクの情報を指定してください。

表示されます。

ユーザー応答待ちオプション

仮想サーバが起動していた場合のユーザー応答のためのオプションです。必要に応じて変更してください。

表示されません。

実行時オプション

仮想サーバの停止を行う際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.targetHost

VMware vCenter操作サーバのホスト名

VMware vCenter Serverを操作するサーバ(vSphere PowerCLIインストール済みサーバ)のホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

入力

無効

○　

仮想システム環境情報

vmware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

入力

無効

○　

仮想システム環境情報

vmware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

入力

無効

△　

仮想システム環境情報

vmware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

入力

無効

○　

仮想システム環境情報

UserResponsePlugin.toAddress

TOメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(TO)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.ccAddress

CCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(CC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.bccAddress

BCCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(BCC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailSubject

メール件名

ユーザー応答待ちになった場合のメール通知のメールの件名を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailBody

メール本文

ユーザー応答待ちになった場合のメール通知のメール本文を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.encodeType

エンコード種別

ユーザー応答待ちになった場合のメール通知のエンコード種別を指定します。指定可能なエンコード名は次のとおりです。us-ascii，iso-2022-jp，shift_jis，euc-jp，utf-8。指定しなかった場合には，utf-8で送信されます。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.dialogText

応答入力画面の補足情報

ユーザー応答待ちになった場合の応答入力ダイアログに表示する補足情報を指定します。テキスト形式，またはHTML形式で指定できます。指定可能なHTMLタグは，アンカータグ，ボールドタグ，ブレークタグ，フォントタグ，イタリックタグ，下線タグです。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.responseTimeOut

応答タイムアウト時間(分)

ユーザー応答待ちになった場合の応答がタイムアウトする時間を分単位で指定します。応答タイムアウト時間が過ぎると，サービスが異常終了します。

入力

無効

○　

ユーザー応答待ちオプション

vmware.checkPowerStateCount

電源状態の確認回数

仮想サーバの停止を確認する際の，電源状態の確認回数を指定します。電源状態の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

vmware.checkPowerStateInterval

電源状態の確認間隔

仮想サーバの停止を確認する際の，電源状態の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.foreachVmName

仮想サーバ名(複数指定可)

仮想サーバの名称(VMware vCenter Serverにおける仮想サーバ名。ホスト名ではありません。)を指定します。複数指定する場合はコンマで区切ってください。99個まで指定できます。

入力

無効

○　

仮想ディスク情報

vmware.dataStoreName

データストア名

仮想ディスクのタイプでFlatを選択する場合は，仮想ディスクの作成先とするデータストアの名称を指定します。仮想ディスクのタイプでRawVirtualまたはRawPhysicalを選択する場合は，LUNマッピングの保存先とするデータストアの名称を指定します。

入力

無効

○　

仮想ディスク情報

vmware.capacity

容量 (GB)

ディスクの容量をGB単位で指定します。仮想ディスクのタイプにFlatを指定する場合は必須です。仮想ディスクのタイプにRawVirtualまたはRawPhysicalを指定した場合は無視されます。

入力

無効

△　

仮想ディスク情報

vmware.vHardDiskType

仮想ディスクのタイプ

仮想ディスクのタイプを指定します。次のどれかを選択します。Flat:仮想ディスクをVMFS上に作成します。RawPhysical:Rawデバイスのマッピング(物理)を設定します。RawVirtual:Rawデバイスのマッピング(仮想)を設定します。

入力

無効

△　

仮想ディスク情報

vmware.deviceName

LUNのデバイス名

仮想ディスクを作成するLUNのデバイス名を指定します。仮想ディスクのタイプでRawVirtualまたはRawPhysicalを選択した場合だけ指定します。vSphere Clientの新しいRawハードディスク追加ウィザードで表示されるLUNの名称を指定してください(例:/vmfs/devices/disks/naa.XXX)。

入力

無効

△　

仮想ディスク情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.targetHost

256文字以内の半角英数字および「.」，「-」。

vmware.vCenterServerName

256文字以内の半角英数字および「.」，「-」。

vmware.userName

512文字以内の半角英数字および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「%」を除く。

vmware.password

127文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.portNumber

1〜65535の整数値。

vmware.protocol

次の値のどれかを選択する。

http,https

UserResponsePlugin.toAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.ccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.bccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.mailSubject

256文字以内の文字列。

UserResponsePlugin.mailBody

1024文字以内の文字列。

UserResponsePlugin.encodeType

次の値のどれかを選択する。

us-ascii,iso-2022-jp,shift_jis,euc-jp,utf-8

UserResponsePlugin.dialogText

512文字以内の文字列。

UserResponsePlugin.responseTimeOut

1〜9999の整数値。

vmware.checkPowerStateCount

1〜3600の整数値。

vmware.checkPowerStateInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.foreachVmName

1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.dataStoreName

42文字以内の半角英数記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.capacity

1以上の整数値。

vmware.vHardDiskType

次の値のどれかを選択する。

RawVirtual,RawPhysical,Flat

vmware.deviceName

255文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想ディスク追加

仮想ディスク追加

繰り返し実行部品

複数の仮想サーバに仮想ディスクを追加します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.15.10　仮想サーバ追加(仮想ディスク)(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

電源状態取得

vsphereGetPower

仮想サーバの電源状態取得

VMware vSphere環境において，仮想サーバの電源状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

電源状態確認

vsphereCheckPower

階層フロー部品

電源状態を調べ，電源状態がOFFでなければ，ユーザーに確認します。

−　

2-3

値判定分岐部品

出力文字列がPoweredOnを含むか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4

階層フロー部品

−　

−　

2-4-1

ユーザー応答待ち部品

電源をOFFにするか・しないかを確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4-2

戻り値判定分岐部品

ユーザー応答待ち部品の戻り値が1か判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4-3

異常終了部品

ジョブネットをエラーにします。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4-4

仮想サーバのシャットダウン

VMware vSphere環境において，仮想サーバのシャットダウンを行い，電源状態をOFFに設定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

ディスク作成

CreateDisk

階層フロー部品

仮想サーバで使用するディスクを作成します。

−　

3-1

仮想サーバへの仮想ディスク追加

VMware vSphere環境において，仮想サーバに仮想ディスクを追加します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.16　vSphere（運用）用のサービステンプレート

3.16.1　ストレージ情報一覧取得

機能

ストレージ情報の一覧を取得します。

・シリアル番号を指定しなかった場合は，指定されたHDvMサーバで管理しているすべてのストレージシステムの情報を取得します。

・シリアル番号を指定した場合は，指定されたシリアル番号を持つストレージシステムの情報だけ取得します。

このサービステンプレートが前提とするサーバを次に示します。

・HDvMサーバ

　Hitachi Device Manager Softwareがインストールされているサーバです。

・HDvM CLIサーバ

　Hitachi Device Manager Software CLIがインストールされているサーバです。

処理の概要を次に示します。

(1) ストレージ情報の一覧をCSV形式で指定されたリモートの一時ファイルに出力します。

(2) リモートの一時ファイルを指定されたローカルの出力ファイルに転送します。

(3) リモートの一時ファイルを削除します。

出力するCSVファイルの項目を次に示します。

項目はコンマ区切りで出力します。

(a) シリアル番号 (ヘッダー名：serialnum)

(b) ファミリー名 (ヘッダー名：family)

(c) DPプールのプールID (ヘッダー名：poolID)

(d) DPプールの容量(KB) (ヘッダー名：capacityKB)

(e) DPプールの空き容量(KB) (ヘッダー名：freeCapacityKB)

(f) DPプールの使用率 (ヘッダー名：usageRate)

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)システム内のサーバに次の製品がセットアップされていること。また，HDvM CLIサーバに，Hitachi Device Manager Software CLIがセットアップされていること。

　・Hitachi Device Manager Software 07-00以降

(2)システム内のストレージシステムとして次のどれかがセットアップされていること。かつ，FC-SANストレージであること。

　・Hitachi Adaptable Modular Storage 2100/2300/2500/2010

　・Hitachi Unified Storage 110/130/150

　・Hitachi Unified Storage VM

　・Hitachi Universal Storage Platform V/VM

　・Hitachi Virtual Storage Platform

　・Hitachi Virtual Storage Platform G1000/G1500/F1500

　・Hitachi Virtual Storage Platform G100/G200/G400/G600/G800

　・Hitachi Virtual Storage Platform F400/F600/F800

【サービステンプレート実行システム内前提製品の稼働OS】

(1)HDvM CLIサーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

【サービステンプレート実行システム内前提製品の使用条件】

(1)ストレージシステムがHitachi Device Manager Softwareで管理されていること。

(2)ストレージシステムにDPプール，ホストグループが作成済みであること。

注意事項

(1)更新中のストレージシステムは一覧ファイルに反映されません。

(2)一覧ファイルの内容はソートしません。必要であれば，一覧ファイルを参照するときにソートしてください。

(3)リモートおよびローカルに指定するファイル名が既に存在する場合，既存のファイルを上書きします。また，リモート側のファイルは削除します。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(4)リモートに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

実行権限

(1)Device Managerに接続するユーザーは，次の権限を持つユーザーグループに所属している必要があります。

　リソースグループとして「All Resources」を割り当てられ，Admin権限，Modify権限またはView権限を持つユーザーグループ

バージョン

02.00.00

タグ

Gather Storage information,Device Manager

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

HDvM環境情報

HDvMの情報を指定してください。

表示されます。

ストレージ情報

一覧を取得するストレージ情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hdvm.targetHost

HDvM CLIサーバのホスト名

Device Manager CLIがインストールされているサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

HDvM環境情報

hdvm.cliInstallPath

HDvM CLIのインストールパス

Device Manager CLIのインストールパスを指定します。

入力

無効

○　

HDvM環境情報

hdvm.hdvmProtocol

HDvMとの通信プロトコル

HDvMサーバに接続するためのプロトコルをhttpまたはhttpsで指定します。

入力

無効

○　

HDvM環境情報

hdvm.hdvmHostName

HDvMサーバのホスト名

HDvMサーバのホスト名またはIPアドレスを指定します。

入力

無効

○　

HDvM環境情報

hdvm.hdvmPortNumber

HDvMとの接続ポート番号

HDvMサーバに接続するためのポート番号を指定します。

入力

無効

○　

HDvM環境情報

hdvm.hdvmUserName

HDvMに接続するためのユーザーID

HDvMサーバに接続するためのユーザーIDを指定します。

入力

無効

○　

HDvM環境情報

hdvm.hdvmPassword

HDvMに接続するためのパスワード

HDvMサーバに接続するためのパスワードを指定します。

入力

無効

○　

HDvM環境情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hdvm.hdvmSerialNumber

ストレージシステムのシリアル番号

取得対象のストレージシステムのシリアル番号を指定します。

入力

無効

△　

ストレージ情報

hdvm.listOutputFileNameRemote

出力ファイル名(リモート)

ストレージ情報をHDvM CLIサーバに出力する際の一時ファイル名をフルパスで指定します。

入力

無効

○　

ストレージ情報

hdvm.listOutputFileNameLocal

出力ファイル名(ローカル)

ストレージ情報を取得するローカルサーバのファイル名をフルパスで指定します。

入力

無効

○　

ストレージ情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hdvm.targetHost

255文字以内の半角英数字および「.」，「-」。

hdvm.cliInstallPath

1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「^」を除く。

hdvm.hdvmProtocol

次の値のどれかを選択する。

http,https

hdvm.hdvmHostName

255文字以内の半角英数字および「.」，「-」。

hdvm.hdvmPortNumber

1〜65535の整数値。

hdvm.hdvmUserName

1文字以上256文字以内の文字列。使用できるのは次の文字だけ。半角英数字，「!」，「#」，「$」，「%」，「'」，「(」，「)」，「*」，「+」，「-」，「.」，「=」，「@」，「¥」，「^」，「_」。ただし，末尾に「¥」は使用できない。

hdvm.hdvmPassword

4文字以上256文字以内の文字列。使用できるのは次の文字だけ。半角英数字，「!」，「#」，「$」，「%」，「'」，「(」，「)」，「*」，「+」，「-」，「.」，「=」，「@」，「¥」，「^」，「_」。ただし，末尾に「¥」は使用できない。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hdvm.hdvmSerialNumber

1文字以上20文字以内の半角英数字。

hdvm.listOutputFileNameRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「^」および末尾の「¥」を除く。

hdvm.listOutputFileNameLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

ストレージ情報一覧取得

ストレージ情報一覧取得

ストレージ情報一覧取得

ストレージ情報の一覧をHDvM CLIサーバの一時ファイルに出力します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

ファイル転送

ファイル転送

ファイル転送部品

リモートの一時ファイルを指定されたローカルの出力ファイルに転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

一時ファイル削除

一時ファイル削除

ファイル削除

リモートの一時ファイルを削除します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.16.2　仮想サーバのクローン作成

機能

VMware vSphere環境の仮想サーバのクローンを作成します。

このサービステンプレートが前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ

　VMware vSphere PowerCLIがインストールされているサーバです。

・クローン対象となる仮想サーバ

　vCenterサーバおよびVMware vSphere ESXi(またはVMware ESX Server)によって管理されている仮想サーバです。

・クローン

　クローン対象となる仮想サーバの複製です。クローン名は仮想サーバの複製の名称です。

処理の概要を次に示します。

(1) クローン対象となる仮想サーバの電源状態を取得します。

(2) 仮想サーバの電源状態がOFFになっていることを確認します。

　　電源状態がOFFでない場合は，ユーザー応答待ち部品を実行して，電源をOFFにするか・しないかを確認します。

　　ユーザー応答待ち部品のメール送信先/送信内容，タイムアウト，画面表示内容はModify権限のユーザーが設定できます。

　　ユーザー応答待ちのGUIで"Shutdown"を選択した場合は，仮想サーバのシャットダウンを行います。

　　"Cancel"を選択するか，ユーザー応答待ちがタイムアウトになった場合は，仮想サーバには操作を行なわずにサービスが異常終了します。

　　仮想サーバを停止する際には，電源状態の確認間隔プロパティ(vmware.checkPowerStateInterval)に指定した秒数待ち合わせ，電源状態がOFFになることを確認する動作を，電源状態の確認回数プロパティ(vmware.checkPowerStateCount)に指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

(3) クローン対象となる仮想サーバを用いてクローンを作成します。

　クローンを作成するとき，パラメタ（ESXサーバ，リソースプール，データストア，仮想ディスクのフォーマット）を指定できます。

　なお，リソースプールを省略すると，クローン作成先のESXサーバの直下にクローンが作成されます。

なお，仮想サーバ名プロパティ(vmware.vmName)およびクローン名プロパティ(vmware.cloneName)に指定できる最大の文字数は60文字です。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)vCenter操作サーバの前提製品

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【サービステンプレート実行システム内前提製品の稼働OS】

(1)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

(2)vCenter操作サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

【サービステンプレート実行システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)同一のvCenterの管理下において，クローン名が重複しないこと。既存の仮想サーバ名とも重複しないこと。

(3)同一のvCenterの管理下において，データストア名は重複しないこと。

(4)クローン対象となる仮想サーバに，VMware Toolsがインストールされていること。

(5)クローン対象となる仮想サーバを管理しているVMware vSphere ESXi(またはVMware ESX Server）と，クローン作成先のVMware vSphere ESXi(またはVMware ESX Server）のバージョンは同一であること。

注意事項

(1)同一の仮想サーバに対して，このサービスを複数同時に実行しないでください。

(2)クローン作成中は，他のサービスからクローン対象の仮想サーバ，および作成先クローンの操作を行わないでください。vCenterサーバからも直接操作を行わないでください。サービスが失敗するおそれがあります。

(3)応答入力画面の補足情報プロパティ(UserResponseplugin.dialogText)にHTMLタグを指定する場合，指定できるタグおよび属性はユーザー応答待ち部品と同じです。詳細については，本製品マニュアルの「ユーザー応答待ち部品」について説明しているトピックを参照してください。

(4)クローンの作成先にvAppは指定できません。

(5)作成したクローンは起動しないでください。起動する場合は，クローン対象となった仮想サーバの削除またはリストアが必要です。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。

バージョン

03.00.00

タグ

Clone VM,VMware vSphere

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

VMware vCenter Serverの情報を指定してください。

表示されます。

クローン作成元の仮想サーバの情報

クローン作成元の仮想サーバの情報を指定してください。

表示されます。

クローン作成先の仮想サーバの情報

クローン作成先の情報を指定してください。

表示されます。

ユーザー応答待ちオプション

仮想サーバが起動していた場合のユーザー応答のためのオプションです。必要に応じて変更してください。

表示されません。

実行時オプション

仮想サーバの停止を行う際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.targetHost

VMware vCenter操作サーバのホスト名

VMware vCenter Serverを操作するサーバ(vSphere PowerCLIインストール済みサーバ)のホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

入力

無効

○　

仮想システム環境情報

vmware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

入力

無効

○　

仮想システム環境情報

vmware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

入力

無効

△　

仮想システム環境情報

vmware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

入力

無効

○　

仮想システム環境情報

UserResponsePlugin.toAddress

TOメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(TO)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.ccAddress

CCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(CC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.bccAddress

BCCメールアドレス

ユーザー応答待ちになった場合のメール通知の宛先メールアドレス(BCC)を指定します。複数のアドレスを指定する場合は，「,」で区切って指定してください。例：mailA,mailB

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailSubject

メール件名

ユーザー応答待ちになった場合のメール通知のメールの件名を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.mailBody

メール本文

ユーザー応答待ちになった場合のメール通知のメール本文を指定します。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.encodeType

エンコード種別

ユーザー応答待ちになった場合のメール通知のエンコード種別を指定します。指定可能なエンコード名は次のとおりです。us-ascii，iso-2022-jp，shift_jis，euc-jp，utf-8。指定しなかった場合には，utf-8で送信されます。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.dialogText

応答入力画面の補足情報

ユーザー応答待ちになった場合の応答入力ダイアログに表示する補足情報を指定します。テキスト形式，またはHTML形式で指定できます。指定可能なHTMLタグは，アンカータグ，ボールドタグ，ブレークタグ，フォントタグ，イタリックタグ，下線タグです。

入力

無効

△　

ユーザー応答待ちオプション

UserResponsePlugin.responseTimeOut

応答タイムアウト時間(分)

ユーザー応答待ちになった場合の応答がタイムアウトする時間を分単位で指定します。応答タイムアウト時間が過ぎると，サービスが異常終了します。

入力

無効

○　

ユーザー応答待ちオプション

vmware.checkPowerStateCount

電源状態の確認回数

仮想サーバの起動を確認する際の，電源状態の確認回数を指定します。電源状態の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

vmware.checkPowerStateInterval

電源状態の確認間隔

仮想サーバの起動を確認する際の，電源状態の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.cloneName

クローン名

クローンの名称を指定します(VMware vCenter Serverにおけるクローンの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

クローン作成先の仮想サーバの情報

vmware.vmName

仮想サーバ名

クローン作成元になる仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

クローン作成元の仮想サーバの情報

vmware.vmHostName

ESXサーバ名

クローン作成先のVMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。

入力

無効

○　

クローン作成先の仮想サーバの情報

vmware.dataStoreName

データストア名

クローン作成先のデータストアの名称を指定します。

入力

無効

○　

クローン作成先の仮想サーバの情報

vmware.resourcePoolName

リソースプール名

クローン作成先のリソースプール，クラスタを指定します。

入力

無効

△　

クローン作成先の仮想サーバの情報

vmware.diskFormat

仮想ディスクのフォーマット

クローン作成先の仮想ディスクのフォーマットを指定します。 クローン作成元の仮想サーバの仮想ディスクと同じフォーマットの場合は「Default」，仮想ディスクをオンデマンドでコミットする場合は「Thin」，仮想ディスクをフルサイズでコミットする場合は「Thick」を指定します。

入力

無効

○　

クローン作成先の仮想サーバの情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.targetHost

256文字以内の半角英数字および「.」，「-」。

vmware.vCenterServerName

256文字以内の半角英数字および「.」，「-」。

vmware.userName

512文字以内の半角英数字および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「%」を除く。

vmware.password

127文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.portNumber

1〜65535の整数値。

vmware.protocol

次の値のどれかを選択する。

http,https

UserResponsePlugin.toAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.ccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.bccAddress

1024文字以内の半角英数字および半角記号。

UserResponsePlugin.mailSubject

256文字以内の文字列。

UserResponsePlugin.mailBody

1024文字以内の文字列。

UserResponsePlugin.encodeType

次の値のどれかを選択する。

us-ascii,iso-2022-jp,shift_jis,euc-jp,utf-8

UserResponsePlugin.dialogText

512文字以内の文字列。

UserResponsePlugin.responseTimeOut

1〜9999の整数値。

vmware.checkPowerStateCount

1〜3600の整数値。

vmware.checkPowerStateInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.cloneName

60文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」を除く。

vmware.vmName

60文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」を除く。

vmware.vmHostName

256文字以内の半角英数字および「.」，「-」。

vmware.dataStoreName

42文字以内の半角英数記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.resourcePoolName

60文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.diskFormat

次の値のどれかを選択する。

Default,Thin,Thick

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

電源状態取得

電源状態取得

仮想サーバの電源状態取得

VMware vSphere環境において，仮想サーバの電源状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

電源状態確認

電源状態確認

階層フロー部品

電源状態を調べ，電源状態がOFFでなければ，ユーザーに確認します。

−　

2-3

値判定分岐部品

出力文字列がPoweredOnと等しいか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4

階層フロー部品

電源をOFFにするか・しないかを確認します。

−　

2-4-1

ユーザー応答待ち部品

電源をOFFにするか・しないかを確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4-2

戻り値判定分岐部品

Cancelが選択された，またはユーザー応答待ち部品でタイムアウトが発生したかを判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4-3

異常終了部品

ジョブネットをエラーにします。

仮想サーバの電源状態を確認して，サービスを再実行してください。

2-4-4

仮想サーバのシャットダウン

VMware vSphere環境において，仮想サーバのシャットダウンを行い，電源状態をOFFに設定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

クローン対象となる仮想サーバのクローン作成

クローン対象となる仮想サーバのクローン作成

仮想サーバのクローン作成

VMware vSphere環境において，クローン対象となる仮想サーバのクローンの作成を行います。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.16.3　仮想サーバのクローン削除

機能

VMware vSphere環境のクローンを削除します。

このサービステンプレートが前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ

　VMware vSphere PowerCLIがインストールされているサーバです。

・クローン対象となった仮想サーバ

　vCenterサーバおよびVMware vSphere ESXi(またはVMware ESX Server)によって管理されている仮想サーバです。

・クローン

　　クローン対象となった仮想サーバの複製です。クローン名は仮想サーバの複製の名称です。

処理の概要を次に示します。

(1) クローンの電源状態を取得します。

(2) クローンの電源状態がOFFになっていることを確認します。

　　電源状態がOFFでない場合は，異常終了します。

　　電源状態がOFFである場合は，次の処理に進みます。

(3) クローンを削除します。

なお，仮想サーバ名プロパティ(vmware.vmName)およびクローン名プロパティ(vmware.cloneName)に指定できる最大の文字数は60文字です。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)vCenter操作サーバの前提製品

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【サービステンプレート実行システム内前提製品の稼働OS】

(1)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

(2)vCenter操作サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

【サービステンプレート実行システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)同一のvCenterの管理下において，削除対象となるクローン名が重複していないこと。仮想サーバとも重複していないこと。

(3)操作の対象となる仮想サーバに，VMware Toolsがインストールされていること。

注意事項

(1)同一のクローンに対して，このサービスを複数同時に実行しないでください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。

バージョン

03.00.00

タグ

Delete Cloned VM,VMware vSphere

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

VMware vCenter Serverの情報を指定してください。

表示されます。

クローン作成元の仮想サーバの情報

クローン作成元の仮想サーバの情報を指定してください。

表示されます。

削除するクローンの情報

削除するクローンの情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.targetHost

VMware vCenter操作サーバのホスト名

VMware vCenter Serverを操作するサーバ(vSphere PowerCLIインストール済みサーバ)のホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

入力

無効

○　

仮想システム環境情報

vmware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

入力

無効

○　

仮想システム環境情報

vmware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

入力

無効

△　

仮想システム環境情報

vmware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

入力

無効

○　

仮想システム環境情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.vmName

クローン作成元の仮想サーバ名

クローン作成元の仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。誤ってクローン作成元を削除しないため確認用として指定してください。この仮想サーバは削除されません。クローン作成元の仮想サーバが既に削除されているか，名称が不明の場合は，仮想サーバ削除サービスを使用してクローンを削除して下さい。

入力

無効

○　

クローン作成元の仮想サーバの情報

vmware.cloneName

削除するクローン名

削除するクローンの名称を指定します(VMware vCenter Serverにおけるクローンの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

削除するクローンの情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.targetHost

256文字以内の半角英数字および「.」，「-」。

vmware.vCenterServerName

256文字以内の半角英数字および「.」，「-」。

vmware.userName

512文字以内の半角英数字および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「%」を除く。

vmware.password

127文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.portNumber

1〜65535の整数値。

vmware.protocol

次の値のどれかを選択する。

http,https

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.vmName

60文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」を除く。

vmware.cloneName

60文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

電源状態取得

電源状態取得

仮想サーバの電源状態取得

VMware vSphere環境において，クローンの電源状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

電源状態確認

電源状態確認

階層フロー部品

電源状態を調べ，電源状態がOFFでなければ，エラー終了します。

−　

2-3

値判定分岐部品

出力文字列がPoweredOnと等しいか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4

異常終了部品

ジョブネットをエラーにします。

クローンの電源状態を確認して，サービスを再実行してください。

3

クローン削除

クローン削除

仮想サーバのクローン削除

VMware vSphere環境において，仮想サーバのクローンの削除を行います。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.16.4　仮想サーバマイグレーション

機能

VMware vSphere環境の複数の仮想サーバをマイグレーションします。

このサービステンプレートが前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ

　VMware vSphere PowerCLIがインストールされているサーバです。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXにより管理されている仮想サーバです。

対象の仮想サーバの電源がONであればホットマイグレーション(電源ONのまま移動する)を実施し，OFFであればコールドマイグレーション(電源OFFのまま移動する)を実施します。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)vCenter操作サーバの前提製品

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【サービステンプレート実行システム内前提製品の稼働OS】

(1)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)(vCenter4.1以降。vCenter4.0では未サポート)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

(2)vCenter操作サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

【サービステンプレート実行システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)仮想サーバ名はvCenterサーバ内で一意になっていること。

(3)対象となる仮想サーバの環境が，vMotionの前提条件を満たしていること。

(4)対象となる仮想サーバに，VMwareToolsがインストールされていること。

注意事項

(1)複数の仮想サーバを移動させる場合，移動先のVMware vSphere ESXi(またはVMware ESX Server)が高負荷になる可能性があるため，注意してください。

(2)移動元と移動先の仮想化ソフトウェアは同一製品である必要があります。

(3)仮想サーバが動作する仮想化ソフトウェアが起動している必要があります。

(4)仮想サーバ名，クラスタ名，vApp名，リソースプール名は，vCenter Server内で一意である必要があります。

　クラスタとvApp，クラスタとリソースプールの組み合わせなど，種別が異なっていても同じ名前にすることはできません。

(5)仮想サーバの移行先にクラスタを指定する場合，移行する仮想サーバが移行先として指定するクラスタ配下のリソースプールに存在している必要があります。

(6)仮想サーバの移行先にフォルダを指定する場合，移行先として指定するフォルダの配下に1つ以上の仮想サーバが存在している必要があります。

(7)VMware vCenter Server 4.1 U2より前のバージョンの環境では，停止状態の仮想マシンを異なるデータセンターのESXに対してマイグレーションした場合に，エラーとなるおそれがあり，タスクの実行に失敗します。対処方法は，VMware Knowledge Baseの" Migrating a powered off virtual machine across hosts in different datacenters fails with the error: A specified parameter was not correct. host"をご確認ください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　対象とする仮想サーバに対して「vMotionのクエリ」と「移行」「再配置」の権限を持つロール，またはシステム管理者ロール

バージョン

02.12.00

タグ

Migrate VM,VMware vSphere

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

VMware vCenter Serverの情報を指定してください。

表示されます。

仮想サーバ情報

マイグレーションする仮想サーバの情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.targetHost

VMware vCenter操作サーバのホスト名

VMware vCenter Serverを操作するサーバ(vSphere PowerCLIインストール済みサーバ)のホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

入力

無効

○　

仮想システム環境情報

vmware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

入力

無効

○　

仮想システム環境情報

vmware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

入力

無効

△　

仮想システム環境情報

vmware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

入力

無効

○　

仮想システム環境情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.foreachVmName

仮想サーバ名(複数指定可)

仮想サーバの名称(VMware vCenter Serverにおける仮想サーバ名。ホスト名ではありません。)を指定します。複数指定する場合はコンマで区切ってください。99個まで指定できます。

入力

無効

○　

仮想サーバ情報

vmware.destinationName

仮想サーバの移動先

移動先のVMware vSphere ESXi(またはVMware ESX Server)またはリソースプール，クラスタ，フォルダの名称を指定します。

入力

無効

○　

仮想サーバ情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.targetHost

256文字以内の半角英数字および「.」，「-」。

vmware.vCenterServerName

256文字以内の半角英数字および「.」，「-」。

vmware.userName

512文字以内の半角英数字および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「%」を除く。

vmware.password

127文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.portNumber

1〜65535の整数値。

vmware.protocol

次の値のどれかを選択する。

http,https

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.foreachVmName

1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.destinationName

256文字以内の文字列。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

マイグレーションを行う

マイグレーションを行う

繰り返し実行部品

指定された移動先へ複数の仮想サーバをマイグレーションします。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.16.5　仮想サーバマイグレーション(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

マイグレーションを行う

vsphereMigration

仮想サーバのマイグレーション

仮想サーバをマイグレーションします。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.16.6　仮想サーバ起動

機能

VMware vSphere環境の複数の仮想サーバの電源状態をONに設定します。

このサービステンプレートが前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ

　VMware vSphere PowerCLIがインストールされているサーバです。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXにより管理されている仮想サーバです。

処理の概要を次に示します。

(1) 仮想サーバの電源状態を取得します。

(2) 仮想サーバの電源状態がOFFになっている場合に，仮想サーバの電源状態をONに設定します。

(3) ICMPエコー要求を送信し，仮想サーバが起動したことを確認します。

上記の処理を，指定された仮想サーバ群に対して並列に実行します。

仮想サーバを起動する際には，vmware.checkPowerStateIntervalプロパティに指定した秒数待ち合わせ，仮想サーバの起動状態を確認する動作を，vmware.checkPowerStateCountプロパティに指定した回数繰り返します。デフォルトの値で不都合がある場合，利用している環境に合わせて調整してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)vCenter操作サーバの前提製品

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【サービステンプレート実行システム内前提製品の稼働OS】

(1)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)(vCenter4.1以降。vCenter4.0では未サポート)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

(2)vCenter操作サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

【サービステンプレート実行システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)仮想サーバ名はvCenterサーバ内で一意になっていること。

(3)対象となる仮想サーバのファイアーウォールがICMP(ECHO)応答を許可していること。

(4)対象となる仮想サーバに，VMwareToolsがインストールされていること。

注意事項

(1)起動するVMware vSphere ESXi(またはVMware ESX Server)を指定することはできません。仮想サーバが存在するVMware vSphere ESXi(またはVMware ESX Server)上で起動します。

(2)ICMPエコーのタイムアウト時間(common.icmpEchoTimeoutプロパティ)は利用している環境に応じて調整してください。

(3)システム環境の状態によっては，仮想サーバの起動には成功するが，ネットワークの接続確認に失敗し，タスクが異常終了する場合があります。

タスクログから，ネットワーク接続確認(部品「仮想サーバのIPアドレス取得」(vsphereGetVMIPaddress)もしくは部品「ICMPエコー要求メッセージの送信」(osSendIcmp))でエラーが発生しているか確認してください。

これらの部品でエラーが発生している場合，仮想サーバが起動しているか確認してください。

(4)仮想サーバのNICにIPアドレスが大量に設定されている(※1)と，部品「ICMPエコー要求メッセージの送信」でエラーが発生し，タスクが異常終了する場合があります。NICに設定されているIPアドレスの長さの合計が，1024文字以内であることを確認してください。

※1)次のIPアドレスが対象です。例えば，IPv4だけの場合は64個までの範囲で設定されていれば問題ありません。

・IPv4(最大長16文字)

・IPv6(最大長36文字)

・DHCPによって設定されるIPv4とIPv6

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　対象とする仮想サーバに対して「読み取り専用」と「パワーオン」の権限を持つロール，またはシステム管理者ロール

(2)vCenter操作サーバに接続するユーザーに、次の権限が必要です。

　ビルトイン Administrator

バージョン

03.00.00

タグ

Control VM,VMware vSphere

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

VMware vCenter Serverの情報を指定してください。

表示されます。

仮想サーバ情報

起動する仮想サーバの情報を指定してください。

表示されます。

実行時オプション

仮想サーバの起動を行う際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.targetHost

VMware vCenter操作サーバのホスト名

VMware vCenter Serverを操作するサーバ(vSphere PowerCLIインストール済みサーバ)のホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

入力

無効

○　

仮想システム環境情報

vmware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

入力

無効

○　

仮想システム環境情報

vmware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

入力

無効

△　

仮想システム環境情報

vmware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

入力

無効

○　

仮想システム環境情報

vmware.checkPowerStateCount

電源状態の確認回数

仮想サーバの起動を確認する際の，電源状態の確認回数を指定します。電源状態の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

vmware.checkPowerStateInterval

電源状態の確認間隔

仮想サーバの起動を確認する際の，電源状態の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

common.icmpEchoTimeout

ICMPエコー要求のタイムアウト時間

仮想サーバの起動確認で実施する，ICMPエコー要求に対する応答を待つ時間をミリ秒単位で指定します。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.foreachVmName

仮想サーバ名(複数指定可)

仮想サーバの名称(VMware vCenter Serverにおける仮想サーバ名。ホスト名ではありません。)を指定します。複数指定する場合はコンマで区切ってください。99個まで指定できます。

入力

無効

○　

仮想サーバ情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.targetHost

256文字以内の半角英数字および「.」，「-」。

vmware.vCenterServerName

256文字以内の半角英数字および「.」，「-」。

vmware.userName

512文字以内の半角英数字および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「%」を除く。

vmware.password

127文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.portNumber

1〜65535の整数値。

vmware.protocol

次の値のどれかを選択する。

http,https

vmware.checkPowerStateCount

1〜3600の整数値。

vmware.checkPowerStateInterval

1〜60の整数値。

common.icmpEchoTimeout

1〜214783647の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.foreachVmName

1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの電源をONに設定

仮想サーバの電源をONに設定

繰り返し実行部品

複数の仮想サーバの電源状態をONに設定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.16.7　仮想サーバ起動(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

電源状態取得

vsphereGetPower

仮想サーバの電源状態取得

指定された仮想サーバの電源状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

電源ON設定

vsphereSetPowerOn

階層フロー部品

電源状態がOFFの場合，電源状態をONに設定します。

−　

2-3

値判定分岐部品

出力文字列がPoweredOffを含むか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4

仮想サーバの起動

指定された仮想サーバの電源状態をONに設定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

ネットワーク接続確認

vsphereCheckNetwork

階層フロー部品

ネットワークが接続されているかを確認します。

−　

3-1

仮想サーバのIPアドレス取得

仮想サーバのIPアドレスを取得します。

システム環境の状態によっては，仮想サーバの起動には成功するが，エラーが発生することがあります。

仮想サーバが起動しているか確認してください。

3-2

ICMPエコー要求メッセージの送信

電源状態がONになった仮想サーバにICMPエコー要求を発行します。

システム環境の状態によっては，仮想サーバの起動には成功するが，エラーが発生することがあります。

仮想サーバが起動しているか確認してください。

3.16.8　仮想サーバ再起動

機能

VMware vSphere環境の複数の仮想サーバを再起動します。

このサービステンプレートが前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ

　VMware vSphere PowerCLIがインストールされているサーバです。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXにより管理されている仮想サーバです。

処理の概要を次に示します。

(1) 仮想サーバの電源状態を取得します。

(2) 仮想サーバの電源状態がONの場合に，仮想サーバを再起動します。

　　仮想サーバがOFFの場合は，該当する仮想サーバの処理がエラーとなります。

(3) ICMPエコー要求を送信し，仮想サーバが起動したことを確認します。

上記の処理を，指定された仮想サーバ群に対して並列に実行します。

仮想サーバを再起動する際には，まずvmware.checkPowerStateIntervalプロパティに指定した秒数待ち合わせ，仮想サーバが停止状態になることを確認する動作を，vmware.checkPowerStateCountプロパティに指定した回数繰り返します。次に，vmware.checkPowerStateIntervalプロパティに指定した秒数待ち合わせ，仮想サーバが起動状態になったことを確認する動作を，vmware.checkPowerStateCountプロパティに指定した回数繰り返します。したがって，最大でこれらのプロパティを掛け合わせた秒数の2倍の時間待ち合わせることになります。

デフォルトの値で不都合がある場合，利用している環境に合わせて調整してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)vCenter操作サーバの前提製品

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【サービステンプレート実行システム内前提製品の稼働OS】

(1)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)(vCenter4.1以降。vCenter4.0では未サポート)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

(2)vCenter操作サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

【サービステンプレート実行システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)仮想サーバ名はvCenterサーバ内で一意になっていること。

(3)対象となる仮想サーバのファイアーウォールがICMP(ECHO)応答を許可していること。

(4)対象となる仮想サーバに，VMwareToolsがインストールされていること。

注意事項

(1)ICMPエコーのタイムアウト時間(common.icmpEchoTimeoutプロパティ)は利用している環境に応じて調整してください。

(2)システム環境の状態によっては，仮想サーバの起動には成功するが，ネットワークの接続確認に失敗し，タスクが異常終了する場合があります。

タスクログから，ネットワーク接続確認(部品「仮想サーバのIPアドレス取得」(vsphereGetVMIPaddress)もしくは部品「ICMPエコー要求メッセージの送信」(osSendIcmp))でエラーが発生しているか確認してください。

これらの部品でエラーが発生している場合，仮想サーバが起動しているか確認してください。

(3)仮想サーバのNICにIPアドレスが大量に設定されている(※1)と，部品「ICMPエコー要求メッセージの送信」でエラーが発生し，タスクが異常終了する場合があります。NICに設定されているIPアドレスの長さの合計が，1024文字以内であることを確認してください。

※1)次のIPアドレスが対象です。例えば，IPv4だけの場合は64個までの範囲で設定されていれば問題ありません。

・IPv4(最大長16文字)

・IPv6(最大長36文字)

・DHCPによって設定されるIPv4とIPv6

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　対象とする仮想サーバに対して「読み取り専用」と「パワーオン」「パワーオフ」の権限を持つロール，またはシステム管理者ロール

(2)vCenter操作サーバに接続するユーザーに、次の権限が必要です。

　ビルトイン Administrator

バージョン

03.00.00

タグ

Control VM,VMware vSphere

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

VMware vCenter Serverの情報を指定してください。

表示されます。

仮想サーバ情報

再起動する仮想サーバの情報を指定してください。

表示されます。

実行時オプション

仮想サーバの再起動を行う際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.targetHost

VMware vCenter操作サーバのホスト名

VMware vCenter Serverを操作するサーバ(vSphere PowerCLIインストール済みサーバ)のホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

入力

無効

○　

仮想システム環境情報

vmware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

入力

無効

○　

仮想システム環境情報

vmware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

入力

無効

△　

仮想システム環境情報

vmware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

入力

無効

○　

仮想システム環境情報

vmware.checkPowerStateCount

電源状態の確認回数

仮想サーバの停止および起動を確認する際の，電源状態の確認回数を指定します。電源状態の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

vmware.checkPowerStateInterval

電源状態の確認間隔

仮想サーバの停止および起動を確認する際の，電源状態の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

common.icmpEchoTimeout

ICMPエコー要求のタイムアウト時間

仮想サーバの起動確認で実施する，ICMPエコー要求に対する応答を待つ時間をミリ秒単位で指定します。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.foreachVmName

仮想サーバ名(複数指定可)

仮想サーバの名称(VMware vCenter Serverにおける仮想サーバ名。ホスト名ではありません。)を指定します。複数指定する場合はコンマで区切ってください。99個まで指定できます。

入力

無効

○　

仮想サーバ情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.targetHost

256文字以内の半角英数字および「.」，「-」。

vmware.vCenterServerName

256文字以内の半角英数字および「.」，「-」。

vmware.userName

512文字以内の半角英数字および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「%」を除く。

vmware.password

127文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.portNumber

1〜65535の整数値。

vmware.protocol

次の値のどれかを選択する。

http,https

vmware.checkPowerStateCount

1〜3600の整数値。

vmware.checkPowerStateInterval

1〜60の整数値。

common.icmpEchoTimeout

1〜214783647の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.foreachVmName

1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバを再起動

仮想サーバを再起動

繰り返し実行部品

複数の仮想サーバを再起動します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.16.9　仮想サーバ再起動(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

電源状態取得

vsphereGetPower

仮想サーバの電源状態取得

指定された仮想サーバの電源状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

電源状態確認

vsphereCheckPower

階層フロー部品

電源状態を調べ，電源状態がOFFであれば，ジョブネットをエラーにします。

−　

2-3

値判定分岐部品

出力文字列がPoweredOffを含むか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4

異常終了部品

ジョブネットをエラーにします。

−　

3

仮想サーバ停止

vsphereSetPowerOff

仮想サーバのシャットダウン

指定された仮想サーバの電源状態をOFFに設定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4

仮想サーバ起動

vsphereSetPowerOn

仮想サーバの起動

指定された仮想サーバの電源状態をONに設定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

5

ネットワーク接続確認

vsphereCheckNetwork

階層フロー部品

ネットワークが接続されているかを確認します。

−　

5-1

仮想サーバのIPアドレス取得

仮想サーバのIPアドレスを取得します。

システム環境の状態によっては，仮想サーバの起動には成功するが，エラーが発生することがあります。

仮想サーバが起動しているか確認してください。

5-2

ICMPエコー要求メッセージの送信

電源状態がONになった仮想サーバにICMPエコー要求を発行します。

システム環境の状態によっては，仮想サーバの起動には成功するが，エラーが発生することがあります。

仮想サーバが起動しているか確認してください。

3.16.10　仮想サーバ情報一覧取得

機能

仮想サーバ情報の一覧を取得します。

・ESXサーバ名を指定しなかった場合は，指定されたvCenterサーバ内のすべてのESXサーバに存在する仮想サーバの情報を取得します。

・ESXサーバ名を指定した場合は，指定されたESXサーバに存在する仮想サーバの情報だけ取得します。

このサービステンプレートが前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ

　VMware vSphere PowerCLIがインストールされているサーバです。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXによって管理されている仮想サーバです。

処理の概要を次に示します。

(1) 仮想サーバ情報の一覧をCSV形式で指定されたリモートの一時ファイルに出力します。

(2) リモートの一時ファイルを指定されたローカルの出力ファイルに転送します。

(3) リモートの一時ファイルを削除します。

出力するCSVファイルの項目を次に示します。

項目はコンマ区切りで出力します。

(a) ESXサーバ名 (ヘッダー名：HostName)

(b) 仮想サーバ名 (ヘッダー名：VMName)

(c) 仮想サーバの電源状態 (ヘッダー名：PowerState)

(d) 仮想サーバのCPU数※1 (ヘッダー名：NumCpu)

(e) 仮想サーバのメモリ容量(MB) (ヘッダー名：MemoryMB)

※1：CPU数の値はVMware vCenter Serverのバージョンによって異なります。

・VMware vCenter Serverのバージョンが4.1以前の場合，仮想プロセッサ数の値です。

・VMware vCenter Serverのバージョンが5.0以降の場合，コアの合計数(仮想ソケット数×ソケットあたりのコアの数)の値です。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)vCenter操作サーバの前提製品

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【サービステンプレート実行システム内前提製品の稼働OS】

(1)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)(vCenter4.1以降。vCenter4.0では未サポート)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

(2)vCenter操作サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

【サービステンプレート実行システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)仮想マシン名はvCenterサーバ内で一意になっていること。

(3)対象となる仮想サーバに，VMware Toolsがインストールされていること。

注意事項

(1)リモートおよびローカルに指定するファイル名が既に存在する場合，既存のファイルを上書きします。また，リモート側のファイルは削除します。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(2)リモートに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　読み取り専用ロール

バージョン

02.11.00

タグ

Gather VM information,VMware vSphere

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

VMware vCenter Serverの情報を指定してください。

表示されます。

仮想環境情報

一覧を取得する仮想環境の情報を指定してください。

表示されます。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.targetHost

VMware vCenter操作サーバのホスト名

VMware vCenter Serverを操作するサーバ(vSphere PowerCLIインストール済みサーバ)のホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

入力

無効

○　

仮想システム環境情報

vmware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

入力

無効

○　

仮想システム環境情報

vmware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

入力

無効

△　

仮想システム環境情報

vmware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

入力

無効

○　

仮想システム環境情報

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.vmHostName

ESXサーバ名

VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。

入力

無効

△　

仮想環境情報

vmware.listOutputFileNameRemote

出力ファイル名(リモート)

仮想サーバ情報をVMware vCenter操作サーバに出力する際の一時ファイル名をフルパスで指定します。

入力

無効

○　

仮想環境情報

vmware.listOutputFileNameLocal

出力ファイル名(ローカル)

仮想サーバ情報を取得するローカルサーバのファイル名をフルパスで指定します。

入力

無効

○　

仮想環境情報

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.targetHost

256文字以内の半角英数字および「.」，「-」。

vmware.vCenterServerName

256文字以内の半角英数字および「.」，「-」。

vmware.userName

512文字以内の半角英数字および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「%」を除く。

vmware.password

127文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.portNumber

1〜65535の整数値。

vmware.protocol

次の値のどれかを選択する。

http,https

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.vmHostName

256文字以内の半角英数字および「.」，「-」。

vmware.listOutputFileNameRemote

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「/」，「'」，「[」，「]」，「`」および末尾の「¥」を除く。

vmware.listOutputFileNameLocal

256文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」および末尾の「¥」，「/」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバ情報一覧取得

仮想サーバ情報一覧取得

仮想サーバ情報一覧取得

仮想サーバ情報の一覧をVMware vCenter操作サーバの一時ファイルに出力します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

ファイル転送

ファイル転送

ファイル転送部品

リモートの一時ファイルを指定されたローカルの出力ファイルに転送します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

一時ファイル削除

一時ファイル削除

ファイル削除

リモートの一時ファイルを削除します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.16.11　仮想サーバ追加(LU作成/データストア作成)環境確認

機能

仮想サーバ追加(LU作成/データストア作成)サービスの前提環境を確認します。

このサービステンプレートが前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ

　VMware vSphere PowerCLIがインストールされているサーバです。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXによって管理されている仮想サーバです。

・HDvMサーバ

　Hitachi Device Manager Softwareがインストールされているサーバです。

・HDvM CLIサーバ

　Hitachi Device Manager Software CLIがインストールされているサーバです。

処理の概要を次に示します。

(1) HDvM CLIサーバからHDvMサーバに接続できるかどうか確認します。

(2) vCenter操作サーバからvCenterサーバに接続できるかどうか確認します。

(3) ストレージシステム上に仮想ボリューム(DPボリューム)を作成できるかどうか確認します。

　このサービスで確認している項目を次に示します。

　・指定されたシリアル番号，およびファミリー名のストレージシステムがHDvMに登録されているかを確認します。

　　ストレージシステムがHDvM上に登録されていない場合はNGとなります。

　・指定されたDPボリュームのデバイス番号がストレージシステム内で使用されていないかを確認します。

　　デバイス番号がストレージシステム内で既に使用されている場合はNGとなります。

　・指定されたDPプールのID，およびホストグループのIDを持つDPプールがストレージシステムに登録されているか，指定されたLU番号がストレージシステム内で使用されていないかを確認します。

　　DPプールのID，ホストグループのIDのどちらかが存在しない，またはLU番号が既に使用されている場合はNGとなります。

　・指定されたストレージシステム上のDPプールに，DPボリュームを作成できる容量が空いているかを確認します。

　　DPボリュームの容量が，DPプールの空き容量を超過している場合はNGとなります。

(4) ESXに指定されたデータストアを追加できるかどうか確認します。

　このサービスで確認している項目を次に示します。

　・指定されたESXサーバがvCenterサーバ上に登録されているかを確認します。

　　ESXサーバがvCenterサーバ上に登録されていない場合はNGとなります。

　・指定されたデータストア名が，データストア追加先のESXサーバが所属しているデータセンター内で，使用されていないかを確認します。

　　データストア名がデータセンター内で既に使用されている場合はNGとなります。

　・指定されたブロックサイズとデータストア容量を比較し，対応が正しいかを確認します。

　　ブロックサイズとデータストア容量を比較し，対応が正しくない場合はNGとなります。

　　ブロックサイズとデータストア容量の対応は「ブロックサイズ(MB)」プロパティの説明を参照してください。

　・指定されたHBAがESXサーバ上に登録されているかを確認します。

　　HBAがESXサーバ上に登録されていない場合はNGとなります。

操作するストレージシステムの種類によって，ストレージシステムのファミリー名を指定するプロパティが異なります。次のストレージシステムを操作する場合は，「ストレージシステムのファミリー名(カスタムオプション)」(hdvm.familyTextプロパティ)に指定します。その他のストレージシステムを操作する場合は，「ストレージシステムのファミリー名」(hdvm.familyプロパティ)に指定します。

・Hitachi Virtual Storage Platform G1500の場合，「VSP G1500」を指定します。

・Hitachi Virtual Storage Platform F1500の場合，「VSP F1500」を指定します。

・Hitachi Virtual Storage Platform G100/G200/G400/G600/G800の場合，「VSP Gx00」を指定します。

・Hitachi Virtual Storage Platform F400/F600/F800の場合，「VSP Fx00」を指定します。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)vCenter操作サーバの前提製品

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

(4)システム内のサーバに次の製品がセットアップされていること。また，HDvM CLIサーバに，Hitachi Device Manager Software CLIがセットアップされていること。

　・Hitachi Device Manager Software 07-00以降

(5)システム内のストレージシステムとして次のどれかがセットアップされていること。かつ，FC-SANストレージであること。

　・Hitachi Adaptable Modular Storage 2100/2300/2500/2010

　・Hitachi Unified Storage 110/130/150

　・Hitachi Unified Storage VM

　・Hitachi Universal Storage Platform V/VM

　・Hitachi Virtual Storage Platform

　・Hitachi Virtual Storage Platform G1000/G1500/F1500

　・Hitachi Virtual Storage Platform G100/G200/G400/G600/G800

　・Hitachi Virtual Storage Platform F400/F600/F800

【サービステンプレート実行システム内前提製品の稼働OS】

(1)vCenter操作サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

(2)HDvM CLIサーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

【サービステンプレート実行システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)ストレージシステムがHitachi Device Manager Softwareで管理されていること。

(3)VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，このサービスが実行するvSphere Power CLIからは，指定した名称の英字の大文字・小文字を区別できません。

　そのため，英字の大文字・小文字が異なる同名の名称を使用している環境に対して，このサービスを使用することはできません。

　・データストア名

　・リソースプール名

　・vApp名

注意事項

(1)VMware vSphere ESXi(またはVMware ESX Server)のバージョンが5の場合は，ブロックサイズに1を指定してください。

(2)hdvm.hdvmArrayFamilyTextプロパティにはサポート対象外のストレージシステムを指定しないでください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　読み取り専用ロール

(2)Device Managerに接続するユーザーは，次の権限を持つユーザーグループに所属している必要があります。

　リソースグループとして「All Resources」を割り当てられ，Admin権限，Modify権限またはView権限を持つユーザーグループ

バージョン

02.11.00

タグ

Gather VM information,VMware vSphere

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

HDvMとVMware vCenter Serverの情報を指定してください。

表示されます。

確認用ストレージ環境情報

確認するDPボリュームに関連するストレージの情報を指定してください。

表示されます。

確認用仮想環境情報

確認するデータストアに関連する仮想環境の情報を指定してください。

表示されます。

カスタムオプション

hdvm.hdvmArrayFamilyプロパティの選択リストにないストレージシステムの情報を指定してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hdvm.targetHost

HDvM CLIサーバのホスト名

Device Manager CLIがインストールされているサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

hdvm.cliInstallPath

HDvM CLIのインストールパス

Device Manager CLIのインストールパスを指定します。

入力

無効

○　

仮想システム環境情報

hdvm.hdvmProtocol

HDvMとの通信プロトコル

HDvMサーバに接続するためのプロトコルをhttpまたはhttpsで指定します。

入力

無効

○　

仮想システム環境情報

hdvm.hdvmHostName

HDvMサーバのホスト名

HDvMサーバのホスト名またはIPアドレスを指定します。

入力

無効

○　

仮想システム環境情報

hdvm.hdvmPortNumber

HDvMとの接続ポート番号

HDvMサーバに接続するためのポート番号を指定します。

入力

無効

○　

仮想システム環境情報

hdvm.hdvmUserName

HDvMに接続するためのユーザーID

HDvMサーバに接続するためのユーザーIDを指定します。

入力

無効

○　

仮想システム環境情報

hdvm.hdvmPassword

HDvMに接続するためのパスワード

HDvMサーバに接続するためのパスワードを指定します。

入力

無効

○　

仮想システム環境情報

vmware.targetHost

VMware vCenter操作サーバのホスト名

VMware vCenter Serverを操作するサーバ(vSphere PowerCLIインストール済みサーバ)のホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

入力

無効

○　

仮想システム環境情報

vmware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

入力

無効

○　

仮想システム環境情報

vmware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

入力

無効

△　

仮想システム環境情報

vmware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

入力

無効

○　

仮想システム環境情報

hdvm.hdvmSerialNumber

ストレージシステムのシリアル番号

確認対象のストレージシステムのシリアル番号を指定します。

入力

無効

○　

確認用ストレージ環境情報

hdvm.hdvmArrayFamily

ストレージシステムのファミリー名

ストレージシステムのファミリー名を指定します。指定可能な値はAMS，USP_V，USP_VM，VSP，HUS，HUS VM，VSP G1000のどれかです。

入力

無効

○　

確認用ストレージ環境情報

vmware.blockSizeMB

ブロックサイズ (MB)

データストアを作成できるか確認するブロックサイズを指定します。ブロックサイズに応じてそのVMFS上に作成するファイルの単一ファイル当たりのサイズの上限値が決まります。ブロックサイズと最大ファイルサイズの対応を次に示します。1MB - 256GB，2MB - 512GB， 4MB - 1024GB，8MB - 2048GB。未指定時はVMware vCenter Serverのデフォルト値で確認します。

入力

無効

△　

確認用仮想環境情報

hdvm.hdvmArrayFamilyText

ストレージシステムのファミリー名(カスタムオプション)

hdvm.hdvmArrayFamilyプロパティの選択リストにないストレージシステムのファミリー名を指定します。このプロパティを指定した場合，hdvm.hdvmArrayFamilyプロパティに指定した値は無視されます。

入力

無効

△　

カスタムオプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

hdvm.hdvmCapacity

DPボリューム(LU)の容量 (GB)

作成できるか確認するDPボリューム(LU)の容量をGB単位で指定します。

入力

無効

○　

確認用ストレージ環境情報

hdvm.hdvmDevNumber

DPボリューム(LU)のデバイス番号

使用できるか確認するDPボリューム(LU)のデバイス番号を10進数で指定します。

入力

無効

○　

確認用ストレージ環境情報

hdvm.hdvmPoolId

DPプールのプールID

DPボリューム(LU)を作成できるか確認するDPプールのプールIDを指定します。

入力

無効

○　

確認用ストレージ環境情報

hdvm.hdvmPathPortName

パスのポート名

DPボリューム(LU)へのパスのポート名を指定します。

入力

無効

○　

確認用ストレージ環境情報

hdvm.hdvmDomainId

ホストグループのID

DPボリューム(LU)を追加できるか確認するホストグループのIDを10進数または16進数で指定します。16進数の場合は"0x"をプレフィックスとして付与してください。

入力

無効

○　

確認用ストレージ環境情報

hdvm.hdvmLun

LU Number(LUN)

LU Number(LUN)を指定します。

入力

無効

○　

確認用ストレージ環境情報

vmware.vmHostName

ESXサーバ名

VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。

入力

無効

○　

確認用仮想環境情報

vmware.dataStoreName

データストア名

データストアの名称を指定します。

入力

無効

○　

確認用仮想環境情報

vmware.hbaName

HBA名

存在するか確認するHBA名を，VMware vCenter Serverのストレージアダプタのランタイム名に表示される形式で指定します(例：vmhba0)。

入力

無効

○　

確認用仮想環境情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

hdvm.checkConnectResult

HDvM接続確認のチェック結果

HDvMサーバに接続できるかどうか確認した結果を格納します。

出力

無効

vmware.checkConnectResult

vSphere接続確認のチェック結果

VMware vCenter Serverに接続できるかどうか確認した結果を格納します。

出力

無効

hdvm.checkLUResult

LU作成確認のチェック結果

DPボリューム(LU)を作成できるかどうか確認した結果を格納します。

出力

無効

vmware.checkDatastoreResult

データストア作成確認のチェック結果

データストアを追加できるかどうか確認した結果を格納します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hdvm.targetHost

255文字以内の半角英数字および「.」，「-」。

hdvm.cliInstallPath

1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「^」を除く。

hdvm.hdvmProtocol

次の値のどれかを選択する。

http,https

hdvm.hdvmHostName

255文字以内の半角英数字および「.」，「-」。

hdvm.hdvmPortNumber

1〜65535の整数値。

hdvm.hdvmUserName

1文字以上256文字以内の文字列。使用できるのは次の文字だけ。半角英数字，「!」，「#」，「$」，「%」，「'」，「(」，「)」，「*」，「+」，「-」，「.」，「=」，「@」，「¥」，「^」，「_」。ただし，末尾に「¥」は使用できない。

hdvm.hdvmPassword

4文字以上256文字以内の文字列。使用できるのは次の文字だけ。半角英数字，「!」，「#」，「$」，「%」，「'」，「(」，「)」，「*」，「+」，「-」，「.」，「=」，「@」，「¥」，「^」，「_」。ただし，末尾に「¥」は使用できない。

vmware.targetHost

256文字以内の半角英数字および「.」，「-」。

vmware.vCenterServerName

256文字以内の半角英数字および「.」，「-」。

vmware.userName

512文字以内の半角英数字および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「%」を除く。

vmware.password

127文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.portNumber

1〜65535の整数値。

vmware.protocol

次の値のどれかを選択する。

http,https

hdvm.hdvmSerialNumber

1文字以上20文字以内の半角英数字。

hdvm.hdvmArrayFamily

次の値のどれかを選択する。

AMS,USP_V,USP_VM,VSP,HUS,HUS VM,VSP G1000

vmware.blockSizeMB

次の値のどれかを選択する。

1,2,4,8

hdvm.hdvmArrayFamilyText

255文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

hdvm.hdvmCapacity

1〜65536の整数値。

hdvm.hdvmDevNumber

0〜524287の整数値。

hdvm.hdvmPoolId

0〜2147483647の整数値。

hdvm.hdvmPathPortName

1文字以上の文字列。ただし，「<」，「>」，「|」，「;」，「&」および末尾の「¥」を除く。

hdvm.hdvmDomainId

1文字以上の半角数字，および半角英字a〜f，A〜F，x。

hdvm.hdvmLun

0〜255の整数値。

vmware.vmHostName

256文字以内の半角英数字および「.」，「-」。

vmware.dataStoreName

42文字以内の半角英数記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.hbaName

1文字以上の半角英数字。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

HDvM接続確認

HDvM接続確認

HDvM接続確認

HDvMサーバに接続できるかどうか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

VMware vCenter Server接続確認

VMware vCenter Server接続確認

vCenter接続確認

vCenterサーバに接続できるかどうか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

LU作成確認

LU作成確認

LU作成確認

DPボリューム(LU)を作成できるかどうか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

4

データストア作成確認

データストア作成確認

データストア作成確認

データストアを追加できるかどうか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.16.12　仮想サーバ追加(デプロイ/OS初期設定)環境確認

機能

仮想サーバ追加(デプロイ/OS初期化)サービスの前提環境を確認します。

このサービステンプレートが前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ

　VMware vSphere PowerCLIがインストールされているサーバです。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXによって管理されている仮想サーバです。

処理の概要を次に示します。

(1) vCenter操作サーバからvCenterサーバに接続できるかどうか確認します。

(2) 指定されたテンプレートから仮想サーバを作成できるかどうか確認します。

　このサービスで確認している項目を次に示します。

　・指定されたテンプレートがvCenterサーバ上に登録されているかを確認します。

　　テンプレートがvCenterサーバ上に登録されていない場合はNGとなります。

　・指定されたESXサーバがvCenterサーバ上に登録されているかを確認します。

　　ESXサーバがvCenterサーバ上に登録されていない場合はNGとなります。

　・指定されたデータストアがESXサーバ上に登録されているかを確認します。

　　データストアがESXサーバ上に登録されていない場合はNGとなります。

　・指定されたESXサーバ上のデータストアに，テンプレートを展開できる容量が空いているかを確認します。

　　テンプレートの容量が，データストアの空き容量を超過している場合はNGとなります。

　　比較に使用するテンプレートの容量は，テンプレートに設定している仮想ディスクの「プロビジョニングしたストレージ」の容量です。

　・指定されたリソースプール(リソースプール，クラスタ，vApp)がvCenterサーバ上に登録されているかを確認します。

　　リソースプールがvCenterサーバ上に登録されていない場合はNGとなります。

　・指定された仮想サーバ名がvCenterサーバ内で使用されていないかを確認します。

　　仮想サーバ名がvCenterサーバ内で既に使用されている場合はNGとなります。

(3) 指定されたIPアドレスに対してICMPエコー要求を送信し，応答があるかどうか確認します。

　　応答がなかった場合，IPアドレスはOK(未使用中)とします。

　　応答があった場合，IPアドレスはNG(使用中)とします。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)vCenter操作サーバの前提製品

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【サービステンプレート実行システム内前提製品の稼働OS】

(1)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)(vCenter4.1以降。vCenter4.0では未サポート)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

(2)vCenter操作サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

【サービステンプレート実行システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)上の設定に関する条件

　・ポートグループが設定済みであること。仮想サーバに設定するポートグループは，標準仮想スイッチ(vNetwork 標準スイッチ/vSphere 標準スイッチ)を使ったネットワーク上のポートグループを指定してください。

　・デプロイに使用するテンプレートが作成済みであること。

　・仮想サーバをリソースプールに格納する場合，リソースプール，クラスタ，vAppの名称が一意であること。

　　クラスタとvApp，クラスタとリソースプールの組み合わせなど，種別が異なっていても，同じ名前にすることはできません。

　・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，このサービスが実行するvSphere Power CLIからは，指定した名称の英字の大文字・小文字を区別できません。

　　そのため，英字の大文字・小文字が異なる同名の名称を使用している環境に対して，このサービスを使用することはできません。

　　・データストア名

　　・リソースプール名

　　・vApp名

(2)デプロイに使用するテンプレートに関する条件

　・VMware Toolsがインストール済みであること。

　・リモートコマンドが実行可能な設定であること。Windowsの場合は管理共有，Linuxの場合はSSHが有効になっていること。

　・NICが設定してあること(最大2個まで)。

　・pingの受付，応答を許可していること。

　・仮想サーバのテンプレート化を実施する際には，仮想サーバが停止した状態でテンプレート化を行ってください。

(3)仮想サーバに関する条件

　・同一のVMware vCenter Serverの管理下で，仮想サーバ名が重複しないこと。

(4)本製品に関する条件

　・デプロイする仮想サーバは，「管理」タブのエージェントレス接続先定義に，事前に認証情報を登録してあること。

注意事項

(1)指定するポートグループは，ローカルサーバと通信可能なポートグループを指定する必要があります。仮想サーバのNICが複数ある場合は，どれかのNICをローカルサーバと通信可能なポートグループに設定してください。

(2)IPアドレス(管理用)には，仮想サーバのOSにIPアドレスとして設定できない値は入力しないでください。例えば，ネットワークアドレスやブロードキャストアドレス，「0.0.0.0」や「255.255.255.255」などの特殊なアドレスは指定できません。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　システム管理者ロール

(2)vCenter操作サーバに接続するユーザーに、次の権限が必要です。

　ビルトイン Administrator

バージョン

03.00.00

タグ

Gather VM information,VMware vSphere

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

VMware vCenter Serverの情報を指定してください。

表示されます。

確認用仮想環境情報

確認する仮想サーバ情報を指定してください。

表示されます。

実行時オプション

仮想サーバ情報の確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.targetHost

VMware vCenter操作サーバのホスト名

VMware vCenter Serverを操作するサーバ(vSphere PowerCLIインストール済みサーバ)のホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

入力

無効

○　

仮想システム環境情報

vmware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

入力

無効

○　

仮想システム環境情報

vmware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

入力

無効

△　

仮想システム環境情報

vmware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

入力

無効

○　

仮想システム環境情報

common.icmpEchoTimeout

ICMPエコー要求のタイムアウト時間

IPアドレスの空き確認で実施する，ICMPエコー要求に対する応答を待つ時間をミリ秒単位で指定します。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.vmName

仮想サーバ名

仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

入力

無効

○　

確認用仮想環境情報

vmware.templateName

テンプレート名

仮想サーバの基となるテンプレート名を指定します。

入力

無効

○　

確認用仮想環境情報

vmware.vmHostName

ESXサーバ名

VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。

入力

無効

○　

確認用仮想環境情報

vmware.dataStoreName

データストア名

データストアの名称を指定します。

入力

無効

○　

確認用仮想環境情報

vmware.resourcePoolName

リソースプール名

仮想サーバを格納するリソースプール，vApp，クラスタを指定します。

入力

無効

△　

確認用仮想環境情報

vmware.portGroupName

ポートグループ名

仮想サーバに現在設定されているポートグループ名(変更前)を指定します。

入力

無効

△　

確認用仮想環境情報

vmware.portGroupNameNew

ポートグループ名(更新時)

仮想サーバに新しく設定するポートグループ名を指定します。

入力

無効

△　

確認用仮想環境情報

OS.ipAddressMan

IPアドレス(管理用)

仮想サーバに設定する管理用LANのIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

△　

確認用仮想環境情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

vmware.checkConnectResult

vSphere接続確認のチェック結果

VMware vCenter Serverに接続できるかどうか確認した結果を格納します。

出力

無効

vmware.checkTemplateResult

仮想サーバ作成確認のチェック結果

仮想サーバを作成できるかどうか確認した結果を格納します。

出力

無効

os.checkICMPResult

ICMP確認のチェック結果

指定されたIPアドレスが使用されていないかどうか確認した結果を格納します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.targetHost

256文字以内の半角英数字および「.」，「-」。

vmware.vCenterServerName

256文字以内の半角英数字および「.」，「-」。

vmware.userName

512文字以内の半角英数字および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「%」を除く。

vmware.password

127文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.portNumber

1〜65535の整数値。

vmware.protocol

次の値のどれかを選択する。

http,https

common.icmpEchoTimeout

1〜214783647の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.vmName

60文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「,」，「%」を除く。

vmware.templateName

60文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.vmHostName

256文字以内の半角英数字および「.」，「-」。

vmware.dataStoreName

42文字以内の半角英数記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.resourcePoolName

60文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.portGroupName

49文字以内の半角英数字。 および，「 (スペース)」，「-」，「.」，「/」，「_」。

vmware.portGroupNameNew

49文字以内の半角英数字。 および，「 (スペース)」，「-」，「.」，「/」，「_」。

OS.ipAddressMan

15文字以内の半角数字および「.」。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

vSphere接続確認

vSphere接続確認

VMware vCenter Server接続確認

vCenterサーバに接続できるかどうか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

仮想サーバ作成確認

仮想サーバ作成確認

仮想サーバ作成確認

指定されたテンプレートから仮想サーバを作成できるかどうか確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3

IPアドレス確認

IPアドレス確認

階層フロー部品

IPアドレスが使用されていないことを確認します。

−　

3-3

値判定分岐部品

出力文字列が存在するか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3-4

ICMPエコー要求メッセージの送信 (無応答確認)

指定されたIPアドレスにICMPエコー要求を発行します。応答が無いことを確認します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.16.13　仮想サーバ停止

機能

VMware vSphere環境の複数の仮想サーバの電源状態をOFFに設定します。

このサービステンプレートが前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ

　VMware vSphere PowerCLIがインストールされているサーバです。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXにより管理されている仮想サーバです。

処理の概要を次に示します。

(1) 仮想サーバの電源状態を取得します。

(2) 仮想サーバの電源状態がONになっている場合に，仮想サーバの電源状態をOFFに設定します。

上記の処理を，指定された仮想サーバ群に対して並列に実行します。

仮想サーバを停止する際には，vmware.checkPowerStateIntervalプロパティに指定した秒数待ち合わせ，電源状態がOFFになることを確認する動作を，vmware.checkPowerStateCountプロパティに指定した回数繰り返します。デフォルトの値で不都合がある場合，利用している環境に合わせて調整してください。

前提条件

【システム内前提製品】/【サービステンプレート実行システム内前提製品】/【サービステンプレート実行システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【サービステンプレート実行システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)vCenter操作サーバの前提製品

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【サービステンプレート実行システム内前提製品の稼働OS】

(1)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)(vCenter4.1以降。vCenter4.0では未サポート)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

(2)vCenter操作サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

【サービステンプレート実行システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)仮想サーバ名はvCenterサーバ内で一意になっていること。

(3)対象となる仮想サーバに，VMwareToolsがインストールされていること。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　対象とする仮想サーバに対して「読み取り専用」と「パワーオフ」の権限を持つロール，またはシステム管理者ロール

バージョン

03.00.00

タグ

Control VM,VMware vSphere

プロパティ一覧

プロパティに設定されているプロパティグループの一覧を次に示します。

プロパティグループ

説明

初期表示

仮想システム環境情報

VMware vCenter Serverの情報を指定してください。

表示されます。

仮想サーバ情報

停止する仮想サーバの情報を指定してください。

表示されます。

実行時オプション

仮想サーバの停止を行う際の状態確認に関するプロパティです。必要に応じて変更してください。

表示されません。

［サービス設定］画面に表示されるプロパティの一覧を次に示します。

（凡例）

○：プロパティの指定は必須です。

△：プロパティの指定は省略可能です。ただし，ほかのプロパティの指定内容によっては，指定が必須になります。各プロパティの「説明」を確認してください。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.targetHost

VMware vCenter操作サーバのホスト名

VMware vCenter Serverを操作するサーバ(vSphere PowerCLIインストール済みサーバ)のホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

入力

無効

○　

仮想システム環境情報

vmware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

入力

無効

○　

仮想システム環境情報

vmware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

入力

無効

○　

仮想システム環境情報

vmware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

入力

無効

△　

仮想システム環境情報

vmware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

入力

無効

○　

仮想システム環境情報

vmware.checkPowerStateCount

電源状態の確認回数

仮想サーバの停止を確認する際の，電源状態の確認回数を指定します。電源状態の確認間隔と組み合わせて最大待ち時間となります。

入力

無効

○　

実行時オプション

vmware.checkPowerStateInterval

電源状態の確認間隔

仮想サーバの停止を確認する際の，電源状態の確認間隔を秒単位で指定します。

入力

無効

○　

実行時オプション

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

必須区分

プロパティグループ

vmware.foreachVmName

仮想サーバ名(複数指定可)

仮想サーバの名称(VMware vCenter Serverにおける仮想サーバ名。ホスト名ではありません。)を指定します。複数指定する場合はコンマで区切ってください。99個まで指定できます。

入力

無効

○　

仮想サーバ情報

［タスク詳細］画面にだけ表示されるプロパティの一覧を次に示します。

プロパティキー

プロパティ名

説明

入出力種別

共有設定

common.taskResult

繰り返しタスクの実行結果

タスクごとの成功(true)，失敗(false)をコンマ区切りで出力します。

出力

無効

［サービス設定］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.targetHost

256文字以内の半角英数字および「.」，「-」。

vmware.vCenterServerName

256文字以内の半角英数字および「.」，「-」。

vmware.userName

512文字以内の半角英数字および半角記号。 ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「/」，「:」，「=」，「,」，「+」，「%」を除く。

vmware.password

127文字以内の半角英数字および半角記号。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

vmware.portNumber

1〜65535の整数値。

vmware.protocol

次の値のどれかを選択する。

http,https

vmware.checkPowerStateCount

1〜3600の整数値。

vmware.checkPowerStateInterval

1〜60の整数値。

［サービス設定］画面および［サービス実行］画面に表示されるプロパティの入力制限を次に示します。

プロパティキー

入力可能文字

vmware.foreachVmName

1024文字以内の文字列。ただし，「<」，「>」，「|」，「;」，「&」，「'」，「"」，「*」，「?」，「[」，「]」，「`」，「%」を除く。

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

[タスク詳細]画面での表示名

ステップ名

部品

部品名

説明

エラー時の回復方法

1

仮想サーバの電源をOFFに設定

仮想サーバの電源をOFFに設定

繰り返し実行部品

複数の仮想サーバの電源状態をOFFに設定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.16.14　仮想サーバ停止(繰り返しフロー)

フロー仕様詳細

フロー仕様詳細を次の表に示します。

階層

処理内容

ステップ名

部品

部品名

説明

エラー時の回復方法

1

電源状態取得

vsphereGetPower

仮想サーバの電源状態取得

指定された仮想サーバの電源状態を取得します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2

電源OFF設定

vsphereSetPowerOff

階層フロー部品

電源状態がONの場合，電源状態をOFFに設定します。

−　

2-3

値判定分岐部品

出力文字列がPoweredOnを含むか判定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

2-4

仮想サーバのシャットダウン

指定された仮想サーバの電源状態をOFFに設定します。

エラーの原因を取り除いたあと，サービスを再実行してください。

3.17　部品提供用のサービステンプレート

3.17.1　AWS Components

機能

このサービステンプレートは，サービステンプレート開発者向けの部品を格納したものです。サービステンプレートを開発する場合にインポートしてください。

前提条件

【システム内前提製品】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

注意事項

(1)このサービステンプレートからサービスの作成およびサービスの実行をしないでください。

バージョン

03.00.00

タグ

−　

3.17.2　HCS Components

機能

このサービステンプレートは，サービステンプレート開発者向けの部品を格納したものです。サービステンプレートを開発する場合にインポートしてください。

前提条件

【システム内前提製品】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

注意事項

(1)このサービステンプレートからサービスの作成およびサービスの実行をしないでください。

バージョン

03.00.00

タグ

−　

3.17.3　Hyper-V2008 Components

機能

このサービステンプレートは，サービステンプレート開発者向けの部品を格納したものです。サービステンプレートを開発する場合にインポートしてください。

前提条件

【システム内前提製品】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

注意事項

(1)このサービステンプレートからサービスの作成およびサービスの実行をしないでください。

バージョン

03.00.00

タグ

−　

3.17.4　Hyper-V2012 Components

機能

このサービステンプレートは，サービステンプレート開発者向けの部品を格納したものです。サービステンプレートを開発する場合にインポートしてください。

前提条件

【システム内前提製品】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

注意事項

(1)このサービステンプレートからサービスの作成およびサービスの実行をしないでください。

バージョン

03.00.00

タグ

−　

3.17.5　Hyper-V2016 Components

機能

このサービステンプレートは，サービステンプレート開発者向けの部品を格納したものです。サービステンプレートを開発する場合にインポートしてください。

前提条件

【システム内前提製品】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

注意事項

(1)このサービステンプレートからサービスの作成およびサービスの実行をしないでください。

バージョン

03.00.00

タグ

−　

3.17.6　OpenStack Components

機能

このサービステンプレートは，サービステンプレート開発者向けの部品を格納したものです。サービステンプレートを開発する場合にインポートしてください。

前提条件

【システム内前提製品】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

注意事項

(1)このサービステンプレートからサービスの作成およびサービスの実行をしないでください。

バージョン

03.00.00

タグ

−　

3.17.7　Oracle Components

機能

このサービステンプレートは，サービステンプレート開発者向けの部品を格納したものです。サービステンプレートを開発する場合にインポートしてください。

前提条件

【システム内前提製品】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

注意事項

(1)このサービステンプレートからサービスの作成およびサービスの実行をしないでください。

バージョン

03.00.00

タグ

−　

3.17.8　vSphere Components

機能

このサービステンプレートは，サービステンプレート開発者向けの部品を格納したものです。サービステンプレートを開発する場合にインポートしてください。

前提条件

【システム内前提製品】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

注意事項

(1)このサービステンプレートからサービスの作成およびサービスの実行をしないでください。

バージョン

03.00.01

タグ

−　

4　JP1/AO同梱版部品

この章では，JP1/AO同梱版部品について説明します。JP1/AO同梱版部品には，基本部品とコンテンツ部品があります。

4.1　基本部品一覧

基本部品一覧を次に示します。

項番

部品名

説明

1

汎用コマンド実行部品

指定したコマンドを操作対象の機器で実行できます。

2

ファイル転送部品

ファイルまたはフォルダを，JP1/AOサーバから操作対象の機器に転送したり，操作対象の機器からJP1/AOサーバに転送したりできます。

3

繰り返し実行部品

フローを繰り返し実行できます。

4

メール通知部品

SMTPサーバに接続し，指定したメールアドレス，件名，および本文でメールを送信できます。

5

ユーザー応答待ち部品

サービス実行中に，後続ステップの処理をオペレーターに選択させることができます。

6

標準出力部品

指定したプロパティの値を，標準出力に出力できます。

7

ターミナル接続部品※

操作対象の機器にTelnetまたはSSHで接続し，認証できます。

8

ターミナルコマンド実行部品※

ターミナル接続部品で接続した操作対象の機器で，コマンドを実行できます。

9

ターミナル切断部品※

ターミナル接続部品で接続した操作対象の機器との接続を切断できます。

10

階層フロー部品

フロー中に別のフローを定義して，フローを階層化できます。

11

実行間隔制御部品

ステップ間の実行間隔を制御できます。

12

戻り値判定分岐部品

直前のステップの戻り値を判定して，次に実行する処理を振り分けられます。

13

値判定部品

サービスプロパティなどの値を比較して，戻り値を判定できます。

14

異常終了部品

実行中のフロー，タスク，階層フローまたは繰り返しフローを異常終了させることができます。

15

値判定分岐部品

サービスプロパティなどの値を比較して，次に実行する処理を振り分けられます。

16

JavaScript実行部品

JSON形式の文字列を変換するためのJavaScriptコードを実行できます。

17

ファイルエクスポート部品

指定した値を任意のフォーマットで出力できます。

18

Webクライアント部品

HTTPメッセージの送受信ができます。

19

Python実行部品

Pythonスクリプトを実行できます。

注※ これらの部品は次に示す順番で使用してください。

ターミナル接続部品

ターミナルコマンド実行部品

ターミナル切断部品

4.2　基本部品

4.2.1　基本部品共通の注意事項

JP1/AO が提供する基本部品について，共通の注意事項を次に示します。

部品の実行中にタスクを実行停止した場合，原則的に，実行中のステップの完了を待ってからタスクが停止します。ただし，停止したタイミングによっては，実行中のステップの戻り値に80が設定され，ステップが失敗することがあります。

4.2.2　汎用コマンド実行部品

機能

操作対象の機器で，指定したコマンドを実行できます。

事前に認証情報を［エージェントレス接続先定義］エリアで設定している場合は，汎用コマンド実行部品に次の情報を指定して実行できます。

コマンドを実行する操作対象の機器（プロパティ「destinationHost」）

実行するコマンド（プロパティ「commandLine」）

コマンドの引数（プロパティ「commandLineParameter」）

操作対象の機器で実行するコマンドには，JP1/AOサーバのOSと操作対象の機器のOSの両方のコマンドに入力できる文字を指定してください。例えば，JP1/AOサーバのOSと操作対象の機器のOSが両方とも日本語版のWindowsの場合，MS932の文字セットの範囲の文字が指定できます。

操作対象の機器のOSがWindowsの場合は，プロパティ「runAsSystem」に「true」を指定することで，Systemアカウントの権限でコマンドが実行されます。操作対象の機器のOSがUNIXの場合は，プロパティ「elevatePrivileges」の指定によって，rootユーザーまたは接続ユーザーの権限でコマンドが実行されます。

また，ローカル実行機能が有効の場合，ローカルホストのOSがWindowsのときは，Systemアカウントの権限でコマンドが実行されます。ローカルホストのOSがLinuxのときは，rootユーザーの権限でコマンドが実行されます。

なお，コマンドを実行する際の実行ディレクトリについては，次のとおりです。

接続先がWindowsの場合は，Admin$¥Hitachi¥CMALib¥JP1AO¥home

Admin$は，環境変数「windir」と同一のディレクトリを指します。

接続先がUNIXの場合でプロパティ「elevatePrivileges」に「true」を指定したときは，rootユーザーのホームディレクトリ

接続先がUNIXの場合でプロパティ「elevatePrivileges」に「false」を指定したときは，接続ユーザーのホームディレクトリ

部品のバージョンが02.01.00より前の部品との機能差異については，「付録A.1　基本部品のバージョン間の機能差異」を参照してください。

実行時の前提条件

エージェントレス接続先として使用できる操作対象の機器については，「付録A.1(3)　エージェントレス接続先として使用できる操作対象の機器」を参照してください。

汎用コマンド実行部品を実行する際に，操作対象機器のOSに，あらかじめインストールされている必要のあるコマンドがあります。詳細は，リリースノートを参照してください。

操作対象の機器のOSがWindowsで汎用コマンド実行部品を実行する場合，管理共有の設定を有効にする必要があります。詳細については，マニュアル「JP1/AO 導入・設計ガイド」を参照してください。

注意事項

コマンド実行時のロケールおよび文字セットは，操作対象の機器のOSによって異なります。詳細については，マニュアル「JP1/AO サービステンプレート開発ガイド」−「部品実行時に設定される操作対象の機器のロケールについて」のトピックおよび「部品実行時にJP1/AO が通信で使用する文字セットについて」のトピックを参照してください。

部品の実行中にタスクを実行停止した場合は，汎用コマンド実行部品の処理が完了してからタスクの状態が「失敗」または「正常終了」になります。部品の実行が終了したときのステップおよびタスクの状態は，ステップの戻り値および後続ステップ実行条件によって決まります。後続ステップ実行条件は，［ステップ作成］ダイアログボックスまたは［ステップ編集］ダイアログボックスで設定できます。

部品の実行中にタスクを強制停止した場合は，操作対象の機器で実行中のプロセスツリーは直ちに強制終了され，タスクの状態が「失敗」または「正常終了」になります。なお，［タスク］画面の［フロー］エリアに表示されるステップの戻り値は，80になります。タスクログに出力される戻り値は，強制停止したタイミングによって異なります。

部品の実行中にタスクを強制停止した場合，プロパティ「commandLine」で指定したコマンドまたはスクリプトの実行結果については製品サポートの対象外となります。

操作対象の機器のOSによって，実行方式が異なります。Windowsの場合はSMBおよびRPC，UNIXの場合はSSHを使用します。そのため，UNIXの場合はSSHサーバを操作対象の機器に構築する必要があります。

SSHで使用するポート番号は，接続先プロパティファイル（接続先名.properties）またはユーザー設定プロパティファイル（config_user.properties）で設定できます。

JP1/AOサーバのOSがLinuxで，かつ操作対象の機器のOSがWindowsの場合は，接続先にIPv6アドレスを指定できません。

操作対象の機器のOSがWindowsの場合，ユーザーのプロファイルは引き継がれません。そのため，部品の実行結果と，デスクトップ上で実行したコマンドまたはスクリプトの実行結果は異なることがあります。

よって，部品を実行する際に，ユーザーのプロファイルは参照させないでください。ユーザーのプロファイルとは，ユーザー環境変数，レジストリ，Internet Explorerの設定などです。これらを参照させた場合，コマンドまたはスクリプトが期待する動作をしないことがあります。例えば，Internet Explorerのプロキシの設定を参照するコマンドまたはスクリプトを実行すると，通信エラーで失敗することがあります。これには，Windows Updateをスクリプトで実行する場合などが該当します。

操作対象の機器のOSがUNIXで，プロパティ「commandLine」および「commandLineParameter」にASCII文字以外を指定したい場合は，「付録A.4　UNIXでASCII文字以外の文字を含むコマンドラインを実行するための前提条件」を参照してください。

ユーザーに入力を求める対話式コマンドおよびスクリプト，GUI表示などにより自動的に終了しないコマンドは実行できません。

バージョン

02.01.00

タグ

Execute Script

戻り値

戻り値

説明

0〜63

指定したコマンドまたはスクリプトの戻り値（0〜63）を，そのまま部品の戻り値として返す。そのため，戻り値の意味は，実行したコマンドまたはスクリプトによって異なる。

64

指定したコマンドまたはスクリプトの戻り値が64以上で終了した場合，部品の戻り値を64で返す。

65

JP1/AOサーバとの接続に失敗した。例えば，部品実行中にJP1/AOサーバが停止された場合が該当する。

66

次のユーザーがJP1ユーザーにマッピングされている。

Administrators グループに所属しないユーザーである。

Administrators グループに所属するビルトイン Administrator以外のユーザーで，UACが有効である。

68

対象のジョブ実行IDに関する情報がない。

69

タスク処理エンジンの環境変数の取得に失敗した。

70

操作対象の機器との接続に失敗した。

71

コマンドの実行に失敗した。

72

コマンドの実行状態の取得に失敗した。

標準出力および標準エラー出力の合計が100KBを超えた。

76

接続タイムアウトが発生した。

77

操作対象の機器のホスト名解決に失敗した。

78

次のどれかの理由で，操作対象の機器との認証に失敗した。

パスワード認証に失敗した。

操作対象の機器に公開鍵認証機能が設定されていない。

公開鍵認証で，秘密鍵とパスフレーズが一致していない。

公開鍵認証で，秘密鍵と操作対象の機器に登録されている公開鍵が対になっていない。

公開鍵認証で，不正な秘密鍵が使用されている。

キーボードインタラクティブ認証に失敗した。

80

タスクの実行を停止した。

81

部品が不正な状態で呼び出された。

82

タスク処理エンジンからの要求メッセージを正しくパースできない。

83

JP1/AOサーバの環境が壊れている。

84

指定された部品の情報が取得できない。

86

指定したプロパティ値に誤りがある。

127

そのほかのエラーが発生した。

プロパティ一覧

プロパティを次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

destinationHost

対象ホスト

操作対象の機器のIPv4アドレス，IPv6アドレスまたはホスト名を1,024文字以内で指定します。なお，JP1/AOサーバと操作対象の機器は，ネットワークで接続されている必要があります。

なお，複数のIPアドレスまたはホスト名は指定できません。

−

入力

○

credentialType※1

認証種別

コマンドまたはスクリプト実行時の認証種別について，次のどちらかを指定します。

destination

［エージェントレス接続先定義］エリアに設定されている認証情報を使用する場合に指定します。「destination」を指定すると，JP1/AOのログインユーザーのIPアドレスに応じて，WindowsまたはSSHのエージェントレス接続先定義に設定済みの認証情報が適用されます。また，認証情報に関するプロパティ（「account」，「password」，「suPassword」，「publicKeyAuthentication」および「keyboardInteractiveAuthentication」）の指定を省略できます。

property

認証情報として，次のプロパティに入力した値を使用する場合に指定します。

account

password

suPassword

publicKeyAuthentication

keyboardInteractiveAuthentication

−

入力

○

account※1

ユーザーID

操作対象の機器にログインするためのユーザーIDを256文字以内で指定します。

また，次のどちらかの形式でドメインユーザーを指定できます。

ドメイン名¥ユーザー名

ユーザー名@ドメイン名

−

入力

△

password※1

パスワード

操作対象の機器にログインするためのパスワードを256文字以内で指定します。操作対象の機器のOSがUNIXで，プロパティ「publicKeyAuthentication」に「true」を指定した場合は，指定不要です。

−

入力

△

suPassword※1

rootのパスワード

操作対象の機器のOSがUNIXの場合，rootパスワードを256文字以内で指定します。操作対象の機器のOSがWindowsの場合，またはプロパティ「elevatePrivileges」で「false」を指定した場合は，指定不要です。

−

入力

△

runAsSystem

システムアカウントで実行

操作対象の機器のOSがWindowsの場合，Systemアカウントの権限でコマンドを実行するかどうかを指定します。操作対象の機器のOSがUNIXの場合，このプロパティに指定した値は無視されます。

true

Systemアカウントの権限でコマンドを実行する場合に指定します。

false

Systemアカウントの権限でコマンドを実行しない場合に指定します。認証情報に設定したユーザーの権限でコマンドを実行します。

false

入力

△

publicKeyAuthentication※1

SSH公開鍵認証設定

操作対象の機器のOSがUNIXの場合，接続に公開鍵認証を使用するかどうかについて次のどちらかを指定します。大文字と小文字は区別しません。このプロパティに値を指定しない場合は，「false」として扱われます。操作対象の機器のOSがWindowsの場合は，指定不要です。

true

公開鍵認証を使用する場合に指定します。

false

公開鍵認証を使用しない場合に指定します。※2

false

入力

△

keyboardInteractiveAuthentication※1

SSHキーボードインタラクティブ認証設定

操作対象の機器のOSがUNIXの場合，接続にキーボードインタラクティブ認証を使用するかどうかについて次のどちらかを指定します。大文字と小文字は区別しません。このプロパティに値を指定しない場合は，「false」として扱われます。操作対象の機器のOSがWindowsの場合は，指定不要です。

ただし，プロパティ「keyboardInteractiveAuthentication」の値が有効になるのは，「publicKeyAuthentication」に「false」を指定した場合です。「publicKeyAuthentication」に「true」を指定した場合，「keyboardInteractiveAuthentication」に「true」を指定しても，公開鍵認証が設定されます。

true

キーボードインタラクティブ認証を使用する場合に指定します。

false

キーボードインタラクティブ認証を使用しない場合に指定します。※2

false

入力

△

elevatePrivileges※1

権限昇格

操作対象の機器のOSがUNIXの場合，rootユーザーに昇格するかどうかについて，次のどちらかを指定します。大文字と小文字は区別しません。このプロパティに値を指定しない場合は，「true」として扱われます。操作対象の機器のOSがWindowsの場合は，指定不要です。

true

rootユーザーに昇格してコマンドを実行する場合に指定します。

false

rootユーザーに昇格しないでコマンドを実行する場合に指定します。接続ユーザーの権限でコマンドを実行します。

false

入力

△

commandLine※3

コマンドライン

操作対象の機器で実行したいコマンドまたはスクリプトの絶対パスを256文字以内で指定します。

コマンドラインには，JP1/AOサーバのOSと操作対象の機器のOSの両方のコマンドに入力できる文字を指定してください。

コマンドラインに環境変数を表す特殊文字などが含まれる場合でも，エスケープされません。例えば，エージェントレス接続先がUNIXの環境においてコマンドライン：「echo abc¥def」を実行すると，「abc¥def」とは出力されず，「abcdef」と出力されます。特殊文字を文字列として扱いたい場合，操作対象の機器のOSがWindowsのときは「%」で，操作対象の機器のOSがUNIXのときは「¥」でエスケープした文字を設定してください。

また，コマンドまたはスクリプトは，次のユーザーの権限で実行されます。

操作対象の機器のOSがWindowsの場合

プロパティ「credentialType」で「destination」を指定している場合，［エージェントレス接続先定義］エリアで設定したユーザーの権限で実行されます。

プロパティ「credentialType」で「property」を指定している場合，プロパティ「account」で指定したユーザーの権限で実行されます。

操作対象の機器のOSがUNIXの場合

プロパティ「credentialType」で「destination」を指定している場合，プロパティ「elevatePrivileges」の指定によって，rootユーザーまたは［エージェントレス接続先定義］エリアで設定したユーザーの権限で実行されます。

プロパティ「credentialType」で「property」を指定している場合，プロパティ「elevatePrivileges」の指定によって，rootユーザーまたはプロパティ「account」で指定したユーザーの権限で実行されます。

−

入力

○

commandLineParameter※3

コマンドラインパラメータ

コマンドまたはスクリプトの引数を1,024文字以内で指定します。

コマンドラインパラメータには，JP1/AOサーバのOSと操作対象の機器のOSの両方のコマンドに入力できる文字を指定してください。

コマンドラインパラメータに環境変数を表す特殊文字などが含まれる場合でも，エスケープされません。例えば，エージェントレス接続先がWindowsの環境においてコマンドライン：「echo」，コマンドラインパラメータ：「abc%def」を実行すると，「abc%def」とは出力されず，「abcdef」と出力されます。特殊文字を文字列として扱いたい場合，操作対象の機器のOSがWindowsのときは「%」で，操作対象の機器のOSがUNIXのときは「¥」でエスケープした文字を設定してください。

コマンドラインパラメータに環境変数を表す特殊文字などが含まれる場合でも ，エスケープされません。特殊文字を文字列として扱いたい場合，操作対象の機器のOSがWindowsのときは「%」で，操作対象の機器のOSがUNIXのときは「¥」でエスケープした文字を設定してください。

また，コマンドラインパラメータの値として環境変数も指定できます。操作対象の機器のOSによって指定形式が異なります。

操作対象の機器のOSがWindowsの場合

「%環境変数%」

操作対象の機器のOSがUNIXの場合

「$環境変数」

−

入力

△

outputCondition

標準出力プロパティ出力条件

プロパティ「stdoutProperty1〜3」に値を出力する条件を指定します。

指定できる値を次に示します。

always

常に「stdoutProperty1〜3」に値を出力します。プロパティ「stdoutPattern1〜3」に合致しなかった場合は空文字を出力します。

patternMatch

プロパティ「stdoutPattern1〜3」に合致した場合にプロパティ「stdoutProperty1〜3」に値を出力します。合致しなかった場合は値を出力しません。この場合，プロパティ「stdoutProperty1〜3」にサービスプロパティがマッピングされているときでも値は更新されません。

always

入力

○

stdoutProperty1

標準出力プロパティ1

プロパティ「stdoutPattern1」で切り出した文字列が出力されます。

−

出力

△

stdoutPattern1

標準出力パターン1

プロパティ「stdoutProperty1」に出力する標準出力の正規表現パターンを1,024文字以内で指定します。正規表現パターンはPCREに従って指定してください。※4

プロパティ「stdoutProperty1」にサービスプロパティのキーが指定されている場合，プロパティ「stdoutPattern1」の指定を省略すると，プロパティ「commandLine」で指定したコマンドまたはスクリプトの標準出力および標準エラー出力の内容全体がサービスプロパティに設定されます。

−

入力

△

stdoutProperty2

標準出力プロパティ2

プロパティ「stdoutPattern2」で切り出した文字列が出力されます。

−

出力

△

stdoutPattern2

標準出力パターン2

プロパティ「stdoutProperty2」に出力する標準出力の正規表現パターンを1,024文字以内で指定します。正規表現パターンはPCREに従って指定してください。※4

プロパティ「stdoutProperty2」にサービスプロパティのキーが指定されている場合，プロパティ「stdoutPattern2」の指定を省略すると，プロパティ「commandLine」で指定したコマンドまたはスクリプトの標準出力および標準エラー出力の内容全体がサービスプロパティに設定されます。

−

入力

△

stdoutProperty3

標準出力プロパティ3

プロパティ「stdoutPattern3」で切り出した文字列が出力されます。

−

出力

△

stdoutPattern3

標準出力パターン3

プロパティ「stdoutProperty3」に出力する標準出力の正規表現パターンを1,024文字以内で指定します。正規表現パターンはPCREに従って指定してください。※4

プロパティ「stdoutProperty3」にサービスプロパティのキーが指定されている場合，プロパティ「stdoutPattern3」の指定を省略すると，プロパティ「commandLine」で指定したコマンドまたはスクリプトの標準出力および標準エラー出力の内容全体がサービスプロパティに設定されます。

−

入力

△

注※1

ローカル実行機能が有効で，操作対象がローカルホストの場合，設定内容は無視されます。

注※2

プロパティ「publicKeyAuthentication」および「keyboardInteractiveAuthentication」の両方に「false」を指定した場合，パスワード認証が設定されます。

注※3

これらのプロパティに指定されたコマンドまたはスクリプトの，標準出力および標準エラー出力は，JP1/AOのステップの標準出力として出力されます。ただし，コマンドまたはスクリプトの，標準出力および標準エラー出力の合計が100KBを超えた場合の処理の実行結果については，製品サポートの対象外となります。事前に，コマンドまたはスクリプトを実行して，標準出力および標準エラー出力の合計が100KBを超えていないことを確認してください。

操作対象の機器のOSがWindowsの場合，プロパティ「commandLine」および「commandLineParameter」で指定した内容は，バッチファイル化され操作対象の機器で実行されます。そのため，対象のコマンドまたはスクリプトをコマンドプロンプトで実行した結果と異なることがあります。

操作対象の機器のOSがUNIXの場合，標準出力および標準エラー出力の改行コードは，次のとおり変更されます。

「CR(0x0d)」が「LF(0x0a)」に変更される。

「CR+LF(0x0d0a)」が「LF+LF(0x0a0a)」に変更される。

また，標準出力および標準エラー出力の最後の文字列が改行コード（「CR」，「LF」または「CR+LF」）以外の場合は，末尾に「LF(0x0a)」が付加されます。

注※4

正規表現により抽出されるのは，括弧でグループ化された部分です。

正規表現に複数のグループを指定した場合，最初のグループに該当する範囲だけが部品の出力プロパティに格納されます。

正規表現に複数の範囲が該当する場合，最初に該当する範囲だけが部品の出力プロパティに格納されます。複数の範囲を格納することはできません。

任意のコマンドの実行結果など改行を含む文字列から抽出する場合，改行までの文字列を抽出するには，「(.*)」と指定してください。

プロパティ「stdoutPattern1〜3」および「stdoutProperty1〜3」の使用例

標準出力および標準エラー出力をプロパティ「stdoutPattern1〜3」の値と照合した結果を，プロパティ「stdoutProperty1〜3」にそれぞれ格納できるようになります。次の図に，「stdoutPattern1」に「aaabbb(.*)」を指定した場合のデータの流れを示します。

図4‒1　プロパティ「stdoutPattern」および「stdoutProperty」の使用例

標準出力「aaabbbccc」に対して，「stdoutPattern1」で定義しているように，標準出力の「aaabbb」より後ろの値（ccc）が抽出されます。抽出された値は，プロパティ「stdoutProperty1」に格納されます。

プロパティ「stdoutPattern1〜3」で指定した正規表現が標準出力と合致せず値を抽出できなかった場合に，プロパティ「stdoutProperty1〜3」に値を格納するかどうかは，プロパティ「outputCondition」で指定できます。

SSHで使用するポート番号の指定

操作対象の機器にSSHを使用して接続する場合は，ポート番号を指定できます。ポート番号を指定する方法と優先順位は，次のとおりです。

表4‒1　SSHのポート番号の優先順位

優先順位

設定個所

プロパティキー

デフォルト値

1

接続先プロパティファイル（接続先名.properties）

ssh.port

−

2

ユーザー設定プロパティファイル（config_user.properties）

ssh.port.number

22

（凡例）

−：値は設定されていません。

関連トピック

マニュアル「JP1/AO 導入・設計ガイド」−「エージェントレス接続先の前提条件」のトピック

マニュアル「JP1/AO 構築ガイド」−「ユーザー設定プロパティファイル（config_user.properties）」および「接続先プロパティファイル（接続先名.properties）」のトピック

付録A.2　各部品で使用できるプロトコル一覧

4.2.3　ファイル転送部品

機能

ファイルまたはフォルダを，JP1/AOサーバから操作対象の機器に転送したり，操作対象の機器からJP1/AOサーバに転送したりできます。ファイルはbinary形式で転送されます。

事前に認証情報を［エージェントレス接続先定義］エリアで設定している場合は，ファイル転送部品に次の情報を指定して実行できます。

操作対象の機器（プロパティ「remoteHost」）

転送モード（プロパティ「transferMode」）

JP1/AOサーバのファイルまたはフォルダのパス（プロパティ「localFilePath」）

操作対象の機器のファイルまたはフォルダのパス（プロパティ「remoteFilePath」）

エージェントレス接続先に転送するファイルパスには，JP1/AOサーバのOSと操作対象の機器のOSの両方のコマンドに入力できる文字を指定してください。例えば，JP1/AOサーバのOSと操作対象の機器のOSが両方とも日本語版のWindowsの場合，MS932の文字セットの範囲の文字が指定できます。

操作対象の機器のOSがWindowsの場合は，認証情報に設定したユーザーでファイルが転送されます。操作対象の機器のOSがUNIXの場合は，プロパティ「elevatePrivileges」の指定によって，rootユーザーまたは接続ユーザーの権限でファイルが転送されます。

なお，ローカル実行機能が有効の場合は，ファイルは転送されません。ローカルホストのOSがWindowsのときは，Systemアカウントの権限でローカルホストにコピーされます。ローカルホストのOSがLinuxのときは，rootユーザーの権限でローカルホストにコピーされます。

部品のバージョンが01.52.01より前の部品との機能差異については，「付録A.1　基本部品のバージョン間の機能差異」を参照してください。

実行時の前提条件

エージェントレス接続先として使用できる操作対象の機器については，「付録A.1(3)　エージェントレス接続先として使用できる操作対象の機器」を参照してください。

操作対象の機器のOSによって，次のとおり設定してください。

Windowsの場合

JP1/AOサーバおよび操作対象の機器で，通信に使用するポートを通過できるよう設定してください。通信で使用するポート番号については，マニュアル「JP1/AO 導入・設計ガイド」を参照してください。

ファイル転送部品を実行する場合，操作対象の機器の管理共有の設定を有効にしてください。詳細については，マニュアル「JP1/AO 導入・設計ガイド」を参照してください。

UNIXの場合

SSHで使用するポート番号は，接続先プロパティファイル（接続先名.properties）またはユーザー設定プロパティファイル（config_user.properties）で設定できます。

操作対象の機器に，SCPに対応したSSHサーバを構築してください。

ファイル転送部品を実行する際に，操作対象機器のOSに，あらかじめインストールされている必要のあるコマンドがあります。詳細は，リリースノートを参照してください。

注意事項

操作対象の機器のOSによって，実行方式が異なります。Windows の場合はSMBとRPC，UNIX の場合はSSHとSCPを使用します。エージェントレス接続先定義のプロトコルを選択する際にはWindowsの場合はWindows，UNIXの場合はSSHを選択してください。

JP1/AOサーバのOSがLinuxで，かつ操作対象の機器のOSがWindowsの場合は，接続先にIPv6アドレスを指定できません。

ファイル転送可能な合計ファイルサイズの上限は4GBです。

一度に転送可能なファイル/フォルダの数の上限は10000です。

ファイル受信時にすでにローカル側に同名のファイルがあり，上書きする場合は，上書きされるファイルの属性に「読み取り専用」，「隠しファイル」，「システムファイル」のどれかの属性が付いていると上書きができないため，ファイル転送に失敗します。

WindowsのUNCパスとネットワークドライブを転送元または転送先に指定できません。

JP1/AOがインストールされたマシンと接続先ホストのディスク空き容量として，指定した転送先以外に，一時的な作業領域として最大で転送対象のファイルまたはフォルダの2倍の容量の空き容量が必要となります。一時的な作業領域については，それぞれ次のとおりです。

JP1/AOがインストールされたマシン(非クラスタ環境)については，JP1/AO がインストールされているドライブ

JP1/AOがインストールされたマシン(クラスタ環境)については，共有ディスク

接続先がWindowsの場合は，システムドライブ

接続先がUNIXの場合は，ユーザー設定プロパティファイル（config_user.properties）のキー「plugin.remoteCommand.workDirectory.ssh」で指定したフォルダ

制限値（ファイルシステムによる1ファイルのサイズ上限，1フォルダあたりのファイル数，ファイル名またはフォルダ名の長さの制限，ユーザーが使用できる資源のOSによる制限など）は，JP1/AOの制限値よりも，OSの制限値が優先されます。OSの制限値を超えるファイル転送は，製品サポートの対象外です。制限値が影響するOSは，JP1/AOサーバおよび操作対象機器のOSです。ユーザーが使用できる資源のOSによる制限は，接続ユーザーとrootの権限に設定された制限に依存します。rootの権限に設定された制限に依存するのは，UNIXの場合です。

接続先がUNIXの場合，転送対象としてフォルダを指定すると，フォルダ配下のファイルサイズの合計が，1ファイルのサイズの上限を超えるとき，ファイル転送がエラーで終了することがあります。1ファイルのサイズ上限とは，ファイルシステムによる制限や，ユーザーが使用できる資源のOSによる制限を指します。 JP1/AOでは，ファイル転送時に，転送対象のファイルまたはフォルダを圧縮ファイルにするため，フォルダ配下の個々のファイルが接続先ホストの制限値未満であっても，圧縮したファイルが接続先ホストの制限値を超えてしまうことがあります。この場合は，転送対象のフォルダ配下にあるファイルの合計サイズを小さくするか，制限値を大きくする必要があります。

部品の実行中にタスクを実行停止した場合は，ファイル転送部品の処理が完了してからタスクの状態が「失敗」または「正常終了」になります。部品の実行が終了したときのステップおよびタスクの状態は，ステップの戻り値および後続ステップ実行条件によって決まります。後続ステップ実行条件は，［ステップ作成］ダイアログボックスまたは［ステップ編集］ダイアログボックスで設定できます。

部品の実行中にタスクを強制停止した場合は，実行中の処理が直ちに終了され，タスクの状態が「失敗」になります。なお，［タスク］画面の［フロー］エリアに表示されるステップの戻り値は，80になります。タスクログに出力される戻り値は，強制停止したタイミングによって異なります。

部品の実行中にタスクを強制停止した場合，ファイル転送の実行結果については製品サポートの対象外となります。

バージョン

01.52.01

タグ

File Operations

戻り値

戻り値

説明

0

正常に終了した。

65

JP1/AOサーバとの接続に失敗した。例えば，部品実行中にJP1/AOサーバが停止された場合が該当する。

66

次のユーザーがJP1ユーザーにマッピングされている。

Administrators グループに所属しないユーザーである。

Administrators グループに所属するビルトイン Administrator以外のユーザーで，UACが有効である。

68

対象のジョブ実行IDに関する情報がない。

69

タスク処理エンジンの環境変数の取得に失敗した。

70

操作対象の機器と接続に失敗した。

71

操作対象の機器で実行するコマンドの呼び出しに失敗した。

72

操作対象の機器で実行するコマンドの実行状態の取得に失敗した。

73

ファイルまたはフォルダの転送に失敗した。

76

接続タイムアウトが発生した。

77

操作対象の機器のホスト名解決に失敗した。

78

次のどれかの理由で，操作対象の機器との認証に失敗した。

パスワード認証に失敗した。

操作対象の機器に公開鍵認証機能が設定されていない。

公開鍵認証で，秘密鍵とパスフレーズが一致していない。

公開鍵認証で，秘密鍵と操作対象の機器に登録されている公開鍵が対になっていない。

公開鍵認証で，不正な秘密鍵が使用されている。

キーボードインタラクティブ認証に失敗した。

80

タスクの実行を停止した。

81

部品が不正な状態で呼び出された。

82

タスク処理エンジンからの要求メッセージを正しくパースできない。

83

JP1/AOサーバの環境が壊れている。

84

指定された部品の情報が取得できない。

86

指定したプロパティ値に誤りがある。

127

そのほかのエラーが発生した。

プロパティ一覧

プロパティを次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

remoteHost

リモートホスト

操作対象の機器のIPv4アドレス，IPv6アドレスまたはホスト名を1,024文字以内で指定します。なお，JP1/AOサーバと操作対象の機器は，ネットワークで接続されている必要があります。

なお，複数のIPアドレスまたはホスト名は指定できません。

−

入力

○

credentialType※1

認証種別

ファイル転送時の認証種別について，次のどちらかを指定します。

destination

［エージェントレス接続先定義］エリアに設定されている認証情報を使用する場合に指定します。「destination」を指定すると，JP1/AOのログインユーザーのIPアドレスに応じて，WindowsまたはSSHのエージェントレス接続先定義に設定済みの認証情報が適用されます。また，認証情報に関するプロパティ（「account」，「password」，「suPassword」，「publicKeyAuthentication」および「keyboardInteractiveAuthentication」）の指定を省略できます。

property

認証情報として，次のプロパティに入力した値を使用する場合に指定します。

account

password

suPassword

publicKeyAuthentication

keyboardInteractiveAuthentication

destination

入力

○

account※1

ユーザーID

操作対象の機器にログインするためのユーザーIDを256文字以内で指定します。

また，ドメインユーザーを指定する場合は，次のどちらかの形式で指定してください。

ドメイン名¥ユーザー名

ユーザー名@ドメイン名

−

入力

△

password※1

パスワード

操作対象の機器にログインするためのパスワードを256文字以内で指定します。操作対象の機器のOSがUNIXで，プロパティ「publicKeyAuthentication」に「true」を指定した場合は，指定不要です。

−

入力

△

suPassword※1

rootのパスワード

操作対象の機器のOSがUNIXの場合，rootパスワードを256文字以内で指定します。操作対象の機器のOSがWindowsの場合，またはプロパティ「elevatePrivileges」で「false」を指定した場合は，指定不要です。

−

入力

△

publicKeyAuthentication※1

SSH公開鍵認証設定

操作対象の機器のOSがUNIXの場合，接続に公開鍵認証を使用するかどうかについて次のどちらかを指定します。大文字と小文字は区別しません。このプロパティに値を指定しない場合は，「false」として扱われます。操作対象の機器のOSがWindowsの場合は，指定不要です。

true

公開鍵認証を使用する場合に指定します。

false

公開鍵認証を使用しない場合に指定します。※2

false

入力

△

keyboardInteractiveAuthentication※1

SSHキーボードインタラクティブ認証設定

操作対象の機器のOSがUNIXの場合，接続にキーボードインタラクティブ認証を使用するかどうかについて次のどちらかを指定します。大文字と小文字は区別しません。このプロパティに値を指定しない場合は，「false」として扱われます。操作対象の機器のOSがWindowsの場合は，指定不要です。

ただし，プロパティ「keyboardInteractiveAuthentication」の値が有効になるのは，「publicKeyAuthentication」に「false」を指定した場合です。「publicKeyAuthentication」に「true」を指定した場合，「keyboardInteractiveAuthentication」に「true」を指定しても，公開鍵認証が設定されます。

true

キーボードインタラクティブ認証を使用する場合に指定します。

false

キーボードインタラクティブ認証を使用しない場合に指定します。※2

false

入力

△

elevatePrivileges※1

権限昇格

操作対象の機器のOSがUNIXの場合，rootユーザーに昇格するかどうかについて，次のどちらかを指定します。大文字と小文字は区別しません。このプロパティに値を指定しない場合は，「true」として扱われます。操作対象の機器のOSがWindowsの場合は，指定不要です。

true

rootユーザーに昇格してファイルまたはフォルダを転送する場合に指定します。

false

rootユーザーに昇格しないでファイルまたはフォルダを転送する場合に指定します。接続ユーザーの権限でファイルまたはフォルダを転送します。

false

入力

△

transferMode

転送モード

転送モードとして，次のどちらかを指定します。

send

JP1/AOサーバから操作対象の機器に，ファイルまたはフォルダを転送する場合に指定します。

プロパティ「localFilePath」にファイルのパスを指定した場合，プロパティ「remoteFilePath」にもファイルのパスを指定してください。また，単一のファイルを転送する際に，プロパティ「localFilePath」と「remoteFilePath」で異なるファイル名を指定した場合は，プロパティ「remoteFilePath」に指定したファイル名で転送されます。

receive

操作対象の機器からJP1/AOサーバに，ファイルまたはフォルダを転送する場合に指定します。

プロパティ「remoteFilePath」にファイルのパスを指定した場合，プロパティ「localFilePath」にもファイルのパスを指定してください。また，単一のファイルを転送する際に，プロパティ「remoteFilePath」と「localFilePath」で異なるファイル名を指定した場合は，プロパティ「localFilePath」に指定したファイル名で転送されます。

send

入力

○

localFilePath※3

ローカルファイルパス

JP1/AOサーバのファイルまたはフォルダの絶対パスを256文字以内で指定します。

プロパティ「localFilePath」には，JP1/AOサーバのOSと操作対象の機器のOSの両方のコマンドに入力できる文字を指定してください。

転送先フォルダに同じ名称のファイルやフォルダがある場合，上書き保存されます。そのため，ユニークな名称を指定することをお勧めします。また，転送先フォルダがない場合は，転送先フォルダとして指定されたフォルダ構成を作成します。

−

入力

○

remoteFilePath※3

リモートファイルパス

操作対象の機器のファイルまたはフォルダの絶対パスを256文字以内で指定します。

プロパティ「remoteFilePath」には，JP1/AOサーバのOSと操作対象の機器のOSの両方のコマンドに入力できる文字を指定してください。

操作対象の機器のOSがUNIXの場合，転送したいファイルおよびフォルダ名の文字セットは，接続ユーザーの文字セットと一致させてください。

転送先フォルダに同じ名称のファイルやフォルダがある場合，上書き保存されます。そのため，ユニークな名称を指定することをお勧めします。 また，転送先フォルダがない場合は，転送先フォルダとして指定されたフォルダ構成を作成します。

−

入力

○

注※1

ローカル実行機能が有効で，操作対象がローカルホストの場合，設定内容は無視されます。

注※2

プロパティ「publicKeyAuthentication」および「keyboardInteractiveAuthentication」の両方に「false」を指定した場合，パスワード認証が設定されます。

注※3

パスを指定する場合は，JP1/AOサーバのOSと操作対象の機器のOSの両方のコマンドに入力できる文字を指定してください。また，プロパティ「localFilePath」にファイル名を指定した場合はプロパティ「remoteFilePath」でもファイル名を，プロパティ「localFilePath」にフォルダ名を指定した場合はプロパティ「remoteFilePath」でもフォルダ名を指定してください。

localFilePathおよびremoteFilePathで指定する転送対象のファイルまたはフォルダについて， 制限があります。詳細については，「表4‒2　転送対象のファイル名またはフォルダ名の制限値(接続先のOSがWindows，LinuxまたはSolarisの場合）」，「表4‒3　転送対象のファイル名またはフォルダ名の制限値(接続先のOSがAIXまたはHP-UXの場合）」を参照してください。

操作対象の機器のOSがWindowsの場合，Windowsのファイル属性［内容を暗号化してデータをセキュリティで保護する］がチェックされているファイルが含まれると，ファイルの転送に失敗し，部品の処理はエラーになります。

操作対象の機器のOSがUNIXで，プロパティ「remoteFilePath」にASCII文字以外を使いたい場合は，「付録A.4　UNIXでASCII文字以外の文字を含むコマンドラインを実行するための前提条件」を参照してください。

転送対象のファイル名またはフォルダ名の制限値

転送対象のファイル名またはフォルダ名に関する制限値を次の表に示します。

表4‒2　転送対象のファイル名またはフォルダ名の制限値(接続先のOSがWindows，LinuxまたはSolarisの場合）

送受信種別

転送対象

JP1/AO側または接続先ホスト側

プロパティ名

制限値

送信

ファイル

JP1/AO側

localFilePath

ファイル名が127文字以下※1

接続先ホスト側

remoteFilePath

ファイル名が127文字以下※1

フォルダ

JP1/AO側

localFilePath

フォルダ配下にあるファイルまたはフォルダのうち，最長パスのファイルまたはフォルダが絶対パスで256文字以下※2

フォルダから配下にあるファイルまたはフォルダの，最長パスのファイルまたはフォルダまでの長さが127文字以下※3

接続先ホスト側

remoteFilePath

フォルダ配下にあるファイルまたはフォルダのうち，最長パスのファイルまたはフォルダが絶対パスで256文字以下※2

フォルダから配下にあるファイルまたはフォルダの，最長パスのファイルまたはフォルダまでの長さが127文字以下※3

受信

ファイル

JP1/AO側

localFilePath

ファイル名が127文字以下※1

接続先ホスト側

remoteFilePath

ファイル名が127文字以下※1

フォルダ

JP1/AO側

localFilePath

フォルダ配下にあるファイルまたはフォルダのうち，最長パスのファイルまたはフォルダが絶対パスで256文字以下※2

フォルダから配下にあるファイルまたはフォルダの，最長パスのファイルまたはフォルダまでの長さが127文字以下※3

接続先ホスト側

remoteFilePath

フォルダ配下にあるファイルまたはフォルダのうち，最長パスのファイルまたはフォルダが絶対パスで256文字以下※2

フォルダから配下にあるファイルまたはフォルダの，最長パスのファイルまたはフォルダまでの長さが127文字以下※3

注※1

"C:¥フォルダ1¥フォルダ2¥ファイル1"が入力値である場合，ファイル1についての制限。

注※2

"C:¥フォルダ1¥フォルダ2¥フォルダ3"が入力値である場合，フォルダ3配下の最長パスを含めて「C:¥」からの長さの制限。

注※3

"C:¥フォルダ1¥フォルダ2¥フォルダ3"が入力値である場合，フォルダ3配下の最長パスを含めてフォルダ3からの長さの制限。

表4‒3　転送対象のファイル名またはフォルダ名の制限値(接続先のOSがAIXまたはHP-UXの場合）

送受信種別

転送対象

JP1/AO側または接続先ホスト側

プロパティ名

制限値

送信

ファイル

JP1/AO側

localFilePath

ファイル名が127文字以下※1

接続先ホスト側

remoteFilePath

ファイル名が96バイト以下※1

フォルダ

JP1/AO側

localFilePath

フォルダ配下にあるファイルまたはフォルダのうち，最長パスのファイルまたはフォルダが絶対パスで256文字以下※2

フォルダから配下にあるファイルまたはフォルダの，最長パスのファイルまたはフォルダまでの長さが127文字以下※3

接続先ホスト側

remoteFilePath

フォルダ配下にあるファイルまたはフォルダのうち，最長パスのファイルまたはフォルダが絶対パスで256文字以下※2

フォルダから配下にあるファイルまたはフォルダの，最長パスのファイルまたはフォルダまでの長さが96バイト以下※3

受信

ファイル

JP1/AO側

localFilePath

ファイル名が127文字以下※1

接続先ホスト側

remoteFilePath

ファイル名が96バイト以下※1

フォルダ

JP1/AO側

localFilePath

フォルダ配下にあるファイルまたはフォルダのうち，最長パスのファイルまたはフォルダが絶対パスで256文字以下※2

フォルダから配下にあるファイルまたはフォルダの，最長パスのファイルまたはフォルダまでの長さが127文字以下※3

接続先ホスト側

remoteFilePath

フォルダ配下にあるファイルまたはフォルダのうち，最長パスのファイルまたはフォルダが絶対パスで256文字以下※2

フォルダから配下にあるファイルまたはフォルダの，最長パスのファイルまたはフォルダまでの長さが96バイト以下※3

注※1

"C:¥フォルダ1¥フォルダ2¥ファイル1"が入力値である場合，ファイル1についての制限。

注※2

"C:¥フォルダ1¥フォルダ2¥フォルダ3"が入力値である場合，フォルダ3配下の最長パスを含めて「C:¥」からの長さの制限。

注※3

"C:¥フォルダ1¥フォルダ2¥フォルダ3"が入力値である場合，フォルダ3配下の最長パスを含めてフォルダ3からの長さの制限。

SSHで使用するポート番号の指定

操作対象の機器にSSHを使用して接続する場合は，ポート番号を指定できます。ポート番号を指定する方法と優先順位は，次のとおりです。

表4‒4　SSHのポート番号の優先順位

優先順位

設定個所

プロパティキー

デフォルト値

1

接続先プロパティファイル（接続先名.properties）

ssh.port

−

2

ユーザー設定プロパティファイル（config_user.properties）

ssh.port.number

22

（凡例）

−：値は設定されていません。

転送対象のファイルの扱い

操作対象の機器のOSおよびプロパティ「transferMode」に指定した値によって，転送対象のファイルの扱いが異なります。転送対象のファイルの扱いを次の表に示します。

表4‒5　転送対象のファイルの扱い

項目

Windows

UNIX

send

receive

send

receive

転送後のファイルのタイムスタンプ

ファイルを新規作成した場合

作成日時

転送した日時

転送した日時

転送した日時

転送した日時

更新日時

送信元ファイルの更新日時

送信元ファイルの更新日時

転送した日時

転送した日時

アクセス日時

転送した日時

転送した日時

転送した日時

転送した日時

ファイルを上書きした場合

作成日時

上書きされるファイルの作成日時

上書きされるファイルの作成日時

転送した日時

上書きされるファイルの作成日時

更新日時

送信元ファイルの更新日時

送信元ファイルの更新日時

転送した日時

転送した日時

アクセス日時

上書きされるファイルのアクセス日時

上書きされるファイルのアクセス日時

上書きされるファイルのアクセス日時※1

上書きされるファイルのアクセス日時

転送元ファイルに必要なアクセス権限

Systemアカウントの読み取り権限

Systemアカウントの読み取り権限

Systemアカウントの読み取り権限

接続ユーザーの読み取り権限※2

転送先ファイルの親フォルダに必要なアクセス権限

認証情報に設定したユーザーの書き込み権限

Systemアカウントの書き込み権限

接続ユーザーの書き込み権限※2

Systemアカウントの書き込み権限

転送先ファイルを上書きする場合に上書きされるファイルに必要なアクセス権限

認証情報に設定したユーザーの書き込み権限

Systemアカウントの書き込み権限

接続ユーザーの書き込み権限※2

Systemアカウントの書き込み権限

送信先ファイルに設定されるアクセス権限

ファイルを新規作成した場合

親フォルダの権限を引き継ぐ

親フォルダの権限を引き継ぐ

rootユーザー，または接続ユーザーのumask値に従う

親フォルダの権限を引き継ぐ

ファイルを上書きした場合

上書きされるファイルの権限を引き継ぐ

上書きされるファイルの権限を引き継ぐ

上書きされるファイルの権限を引き継ぐ※3

上書きされるファイルの権限を引き継ぐ

注※1

操作対象機器のOSがHP-UXの場合は，転送した日時が設定されます。

注※2

rootユーザーでファイルを転送する場合は，権限の指定は不要です。

注※3

操作対象機器のOSがHP-UXの場合は，rootユーザー，または接続ユーザーのumask値に従います。

関連トピック

マニュアル「JP1/AO 導入・設計ガイド」−「エージェントレス接続先の前提条件」のトピック

マニュアル「JP1/AO 構築ガイド」−「ユーザー設定プロパティファイル（config_user.properties）」および「接続先プロパティファイル（接続先名.properties）」のトピック

付録A.2　各部品で使用できるプロトコル一覧

4.2.4　繰り返し実行部品

機能

フローを繰り返し実行できます。繰り返し入力プロパティ（inputProperties）に指定した値を，1 回の繰り返しごとにフローに設定し，サービスを実行できます。例えば，同じ処理を異なるサーバに実行したい場合などに便利です。繰り返し実行部品は，最大で3段までの入れ子定義ができます。

なお，フローの実行方法には，フローを並行で実行する「並行実行」と，フローの実行が完了したら次のフローを順番に実行する「逐次実行」があります。

注意事項

部品の実行中にタスクを実行停止した場合は，実行中の繰り返しフローは実行中の部品が完了次第停止されます。ただし，ユーザー応答待ち部品の場合は，部品の完了を待たないで停止されます。未実行の繰り返しフローは実行されないため，プロパティ「outputResult」には「false」が格納されます。

部品の実行中にタスクを強制停止した場合は，実行中の処理が直ちに終了され，タスクの状態が「失敗」になります。なお，［タスク］画面の［フロー］エリアに表示されるステップの戻り値は，80になります。タスクログに出力される戻り値は，強制停止したタイミングによって異なります。

プロパティ「foreachMode」で「parallel」を指定している繰り返し実行部品が上位の階層に存在する場合，繰り返し実行タスク内で参照・更新するプロパティ（サービスプロパティ，部品の出力プロパティ，または変数）の値は，同じ繰り返し実行タスク（n回目のフロー）でだけ有効です。同時に処理している繰り返し実行タスク（n回目以外のフロー）とは，プロパティ（サービスプロパティ，部品の出力プロパティ，または変数）の値を共有できません。

下位の階層の繰り返し実行タスクとも，プロパティの値を共有できません。次の図に「部品Z」が更新した出力プロパティを，各階層の部品から参照した場合の参照可否について示します。

繰り返し実行部品の配下に置けるフロー数は，1サービスあたり最大で10,000個です。 繰り返し実行部品配下のフロー数の合計が10,000個を超えないように，各繰り返し部品のプロパティ「inputProperties」を設定してください。なお，フロー数には最上位のフロー，および階層フロー部品によるフローは含みません。

例えば，次の図のようにNを2 回，Mを2 回，Zを10回繰り返すように，それぞれ繰り返し実行部品の「inputProperties」に設定した場合，フロー数の合計は「N + N × M + Z（2 + 2 × 2 + 10）」で「16」となります。

繰り返し実行部品を入れ子で定義している場合，サービスビルダーのデバッグ実行時にWebブラウザーの応答が遅くなる，またはWebブラウザーが応答しないことを示すダイアログが表示される場合があります。この場合，各繰り返し実行部品のプロパティ「inputProperties」に設定する値を少なくしたあとで，デバッグを再実行してください。

繰り返し実行部品から［失敗したステップからリトライ］でリトライすると，繰り返し実行部品の配下のステップが最初から実行されます。また，繰り返し実行部品の配下のステップの状態が「失敗」で，ステップ作成時に［ステップ作成］ダイアログボックスで設定した［後続ステップ実行条件］でステップの状態が「正常終了」になる条件を指定している場合は，タスクをリトライできません。

繰り返し実行部品から［失敗した次のステップからリトライ］でリトライすると，繰り返し実行部品の次のステップから実行されます。この場合，繰り返し実行部品のステップの状態は「正常終了」になります。なお，繰り返し実行部品の配下のステップの状態は，以下のようになります。

繰り返し実行部品が階層フロー部品，またはサービス部品の配下に存在する場合

「正常終了」していたステップの状態は，変更されません。「失敗」または「未実行」のステップの状態は，一度「待機中」に変更された後，階層フロー部品，またはサービス部品のステップの実行が完了した後に，「未実行」になります。

上記以外の場合

「正常終了」していたステップの状態は，変更されません。「失敗」または「未実行」のステップの状態は，「待機中」になります。タスクの実行が完了した後も「待機中」のままです。

バージョン

01.00.01

タグ

Control Flow

戻り値

戻り値

説明

0

正常に終了した。

1

一部の繰り返し処理が失敗した。

2

すべての繰り返し処理が失敗した。

3

サービス内の繰り返し部品配下のフロー数の合計が上限を超えた。

65

JP1/AOサーバとの接続に失敗した。例えば，部品実行中にJP1/AOサーバが停止された場合が該当する。

66

次のユーザーがJP1ユーザーにマッピングされている。

Administrators グループに所属しないユーザーである。

Administrators グループに所属するビルトイン Administrator以外のユーザーで，UACが有効である。

68

対象のジョブ実行IDに関する情報がない。

69

タスク処理エンジンの環境変数の取得に失敗した。

80

タスクの実行を停止した。

81

部品が不正な状態で呼び出された。

82

タスク処理エンジンからの要求メッセージを正しくパースできない。

83

JP1/AOサーバの環境が壊れている。

84

指定された部品の情報が取得できない。

86

指定したプロパティ値に誤りがある。

127

そのほかのエラーが発生した。

プロパティ一覧

プロパティを次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

inputProperties※1

繰り返し入力プロパティ

繰り返す回数分の入力プロパティの値を1,024文字以内で指定します。

1回の繰り返しごとに，異なるプロパティを指定できます。プロパティは，コンマ区切りで指定してください。なお，コンマは区切り文字としてだけ使用してください。

また，繰り返す回数の上限は99回です。そのため，100個以上の値をコンマ区切りで指定できません。

−

入力

○

outputProperties※2

繰り返し出力プロパティ

繰り返した回数分の出力プロパティの値が1,024文字以内で出力されます。

1回の繰り返しごとに，1つのプロパティ値がプロパティ「inputProperties」の指定順にコンマ区切りで出力されます。なお，コンマは区切り文字として使用してください。

−

出力

△

outputResult

繰り返し実行結果

フローごとの実行結果がコンマ区切りで出力されます。

true

フローの実行に成功した場合に出力されます。

false

フローの実行に失敗した場合に出力されます。

−

出力

△

foreachMode

繰り返し実行方式

繰り返し実行するフローの実行方式を指定します。

parallel

繰り返すフローが並行して実行されます。

並行して実行できるフローの上限数は99です。上限数を超えた場合は，並行して実行できるフロー数に空きができるまで待機し，空きができ次第，フローの実行が再開されます。ユーザー設定プロパティファイル（config_user.properties）のキー「foreach.max_value」で，並行して実行できるフロー数を1〜99 で変更できます。

エラーが発生した場合でも，未実行の繰り返しフローはすべて実行されます。

serial

繰り返すフローが逐次実行されます。

エラーが発生した場合は，未実行の繰り返しフローは実行されません。

parallel

入力

○

注※1

プロパティ「inputProperties」に指定した値は，繰り返し実行するフロー内で使用される予約プロパティ「reserved.loop.input」に格納されます。予約プロパティ「reserved.loop.input」および「reserved.loop.index」は，繰り返しごとに異なる値が格納されます。予約プロパティ「reserved.loop.input」および「reserved.loop.index」は，繰り返しごとに異なる値が格納されるため，参照指定「?dna_reserved.loop.input?, ?dna_reserved.loop.input?」の形式で指定してください。

注※2

プロパティ「outputProperties」には，繰り返し実行するフロー内で使用される予約プロパティ「reserved.loop.output」の値が格納されます。

関連トピック

マニュアル「JP1/AO 構築ガイド」−「ユーザー設定プロパティファイル（config_user.properties）」のトピック

マニュアル「JP1/AO サービステンプレート開発ガイド」−「予約プロパティ一覧」のトピック

4.2.5　メール通知部品

機能

SMTPサーバに接続し，指定したメールアドレス，件名，および本文でメールを送信できます。また，ユーザー設定プロパティファイル（config_user.properties）のキー「mail.plugin.retry.interval」を編集することで，メール送信に失敗した場合にリトライできます。

実行時の前提条件

次の情報は，ビルトインサービス共有プロパティから取得されます。そのため，事前に［管理］画面の［システム設定］エリアで値を設定してください。

SMTPサーバのアドレス

ポート番号

ユーザーID

パスワード

通知メールの送信元

注意事項

プロパティ「toAddress」，「ccAddress」，および「bccAddress」を指定しなかった場合でも，戻り値は0になります。

指定するメールアドレスは，ビルトインサービス共有プロパティの値とは異なります。そのため，プロパティ「toAddress」，「ccAddress」，または「bccAddress」のどれかを必ず指定してください。

プロパティ「toAddress」，「ccAddress」，および「bccAddress」にメールアドレスとして有効ではない値を1つでも指定した場合，すべてのメールアドレスへのメール送信が失敗します。

プロパティ「mailSubject」「mailBody」では文字セット間に互換性のない文字および 機種依存文字を使用すると，文字が 「?」などに置き換わります。 必要に応じて，使用する文字を変更するか，メールのエンコード種別を変更して使用してください。

変換できないおそれのある文字の例

「~」，「¥」，「＼」，「〜」，「‖」，「−」，「¢」，「£」，「¬」

部品の実行中にタスクを実行停止した場合は，メール通知部品の処理が完了してからタスクの状態が「失敗」または「正常終了」になります。部品の実行が終了したときのステップおよびタスクの状態は，ステップの戻り値および後続ステップ実行条件によって決まります。後続ステップ実行条件は，［ステップ作成］ダイアログボックスまたは［ステップ編集］ダイアログボックスで設定できます。

部品の実行中にタスクを強制停止した場合は，実行中の処理が直ちに終了され，タスクの状態が「失敗」になります。なお，［タスク］画面の［フロー］エリアに表示されるステップの戻り値は，80になります。タスクログに出力される戻り値は，強制停止したタイミングによって異なります。

バージョン

01.00.01

タグ

Mail，Notification

戻り値

戻り値

説明

0

正常に終了した。

65

JP1/AOサーバとの接続に失敗した。例えば，部品実行中にJP1/AOサーバが停止された場合が該当する。

66

次のユーザーがJP1ユーザーにマッピングされている。

Administrators グループに所属しないユーザーである。

Administrators グループに所属するビルトイン Administrator以外のユーザーで，UACが有効である。

68

対象のジョブ実行IDに関する情報がない。

69

タスク処理エンジンの環境変数の取得に失敗した。

70

SMTPサーバとの接続に失敗した。

78

認証に失敗した。

79

メールの送信に失敗した。

80

タスクの実行を停止した。

81

部品が不正な状態で呼び出された。

82

タスク処理エンジンからの要求メッセージを正しくパースできない。

83

JP1/AOサーバの環境が壊れている。

84

指定された部品の情報が取得できない。

86

指定したプロパティ値に誤りがある。

127

そのほかのエラーが発生した。

プロパティ一覧

プロパティを次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

toAddress

TOメールアドレス

TO属性で送信するメールアドレスを1,024文字以内で指定します。複数のメールアドレスを指定する場合は，コンマ区切りで指定してください。

−

入力

△

ccAddress

CCメールアドレス

CC属性で送信するメールアドレスを1,024文字以内で指定します。複数のメールアドレスを指定する場合は，コンマ区切りで指定してください。

−

入力

△

bccAddress

BCCメールアドレス

BCC属性で送信するメールアドレスを1,024文字以内で指定します。複数のメールアドレスを指定する場合は，コンマ区切りで指定してください。

−

入力

△

encodeType

エンコード種別

メールのエンコード種別を次から指定します。

us-ascii

iso-2022-jp

shift_jis

euc-jp

utf-8

utf-8

入力

○

mailSubject

メール件名

メールの件名を256文字以内で指定します。

−

入力

△

mailBody

メール本文

メールの本文を1,024文字以内で指定します。

−

入力

△

関連トピック

マニュアル「JP1/AO 構築ガイド」−「ユーザー設定プロパティファイル（config_user.properties）」のトピック

4.2.6　ユーザー応答待ち部品

機能

サービス実行中に，後続ステップの処理をオペレーターに選択させることができます。後続ステップの処理を選択するには，［応答入力］画面を使用します。また，メール通知の設定をすることで，タスクの状態がユーザー応答待ちになっていることをオペレーターにメール通知できるようになります。

［応答入力］画面にアクセスする方法は次のとおりです。

応答待ち通知メールに記載されているURLからリンクする方法

［タスク］画面の［タスク］タブまたは［デバッグ］タブのタスク一覧からアクセスする方法

［タスク詳細］画面からアクセスする方法

実行時の前提条件

次の情報は，ビルトインサービス共有プロパティから取得されます。そのため，タスクの状態がユーザー応答待ちになっていることをメール通知したい場合は，事前に［管理］画面の［システム設定］エリアで値を設定してください。

SMTPサーバのアドレス

ポート番号

ユーザーID

パスワード

通知メールの送信元

注意事項

タスクの状態がユーザー応答待ちになっていることをメール通知したい場合，次のどれかに該当するとメールは送信されません。

ビルトインサービス共有プロパティで値を設定していない場合

SMTPの設定がされていない場合

プロパティ「toAddress」，「ccAddress」，および「bccAddress」を指定していない場合

プロパティ「toAddress」，「ccAddress」，および「bccAddress」に1つでもメールアドレスとして有効でない値を指定した場合

指定するメールアドレスは，ビルトインサービス共有プロパティの値とは異なります。そのため，タスクの状態がユーザー応答待ちになっていることをメール通知したい場合は，プロパティ「toAddress」，「ccAddress」，または「bccAddress」のどれかを必ず指定してください。

オペレーターが［応答入力］画面を表示中に，ユーザー応答待ち部品を実行停止しないでください。実行停止すると，後続ステップへの処理を選択してもエラーになります。

通知されるメールの本文には，［応答入力］画面にリンクするためのURLが自動的に記載されます。同じタスク内で複数のステップが応答待ち中になった場合，ユーザー応答待ち部品を実行したステップごとに記載されるURLが異なります。そのため，各URLからは，各ステップに対応した［応答入力］画面が表示されます。

部品の実行中にタスクを実行停止した場合は，実行中の処理が直ちに終了され，タスクの状態が「失敗」になります。

部品の実行中にタスクを強制停止した場合は，実行中の処理が直ちに終了され，タスクの状態が「失敗」になります。なお，［タスク］画面の［フロー］エリアに表示されるステップの戻り値は，80になります。タスクログに出力される戻り値は，強制停止したタイミングによって異なります。

［応答入力］画面のレイアウトは変更できません。

プロパティ「labelButton1」〜「labelButton9」の戻り値は異常終了と見なされるため，障害情報がタスクログに出力されます。また，プロパティ「labelButton0」と「labelButton1」〜「labelButton9」について，出力ログレベルが10または20の場合は，応答された結果，タスクログに出力される内容が異なります。

プロパティ「mailSubject」「mailBody」では文字セット間に互換性のない文字または機種依存文字を使用すると，文字が 「?」などに置き換わります。 必要に応じて，使用する文字を変更するか，メールのエンコード種別を変更して使用 してください。

変換できないおそれのある文字の例

「~」，「¥」，「＼」，「〜」，「‖」，「−」，「¢」，「£」，「¬」

繰り返し実行部品のプロパティ「foreachMode」で「parallel」を指定している場合，繰り返し実行部品配下のユーザー応答待ち部品でサービスプロパティのパラメーターを変更すると，予期せぬ値を更新する場合があるため，サービスプロパティの内容を変更しない（インプットタグ（<input>）を指定しない）ようにしてください。

バージョン

01.01.00

タグ

User Interaction

戻り値

戻り値

説明

0〜9

プロパティ「labelButton1」〜「labelButton9」に対応した戻り値を返す。ただし，応答がタイムアウトした場合，プロパティ「timeOutDefault」に指定した値を戻り値として返す。そのため，戻り値の意味は，この部品を使用するサービステンプレートごとに異なる。

10〜63

応答がタイムアウトした場合，プロパティ「timeOutDefault」に指定した値を戻り値として返す。

65

JP1/AOサーバとの接続に失敗した。例えば，部品実行中にJP1/AOサーバが停止された場合が該当する。

66

次のユーザーがJP1ユーザーにマッピングされている。

Administrators グループに所属しないユーザーである。

Administrators グループに所属するビルトイン Administrator以外のユーザーで，UACが有効である。

68

対象のジョブ実行IDに関する情報がない。

69

タスク処理エンジンの環境変数の取得に失敗した。

80

タスクの実行を停止した。

81

部品が不正な状態で呼び出された。

82

タスク処理エンジンからの要求メッセージを正しくパースできない。

83

JP1/AOサーバの環境が壊れている。

84

指定された部品の情報が取得できない。

86

応答入力ダイアログでマッピングパラメーターに設定した値がプロパティの入力規則に違反している。

127

そのほかのエラーが発生した。

プロパティ一覧

プロパティを次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

toAddress

TOメールアドレス

TO属性で送信するメールアドレスを1,024文字以内で指定します。複数のメールアドレスを指定する場合は，コンマ区切りで指定してください。

−

入力

△

ccAddress

CCメールアドレス

CC属性で送信するメールアドレスを1,024文字以内で指定します。複数のメールアドレスを指定する場合は，コンマ区切りで指定してください。

−

入力

△

bccAddress

BCCメールアドレス

BCC属性で送信するメールアドレスを1,024文字以内で指定します。複数のメールアドレスを指定する場合は，コンマ区切りで指定してください。

−

入力

△

mailSubject

メール件名

メールの件名を256文字以内で指定します。

−

入力

△

mailBody

メール本文

メールの本文を1,024文字以内で指定します。

−

入力

△

encodeType

エンコード種別

メールのエンコード種別を次から指定します。なお，このプロパティに値を指定しない場合は，「utf-8」として扱われます。

us-ascii

iso-2022-jp

shift_jis

euc-jp

utf-8

utf-8

入力

△

dialogText

応答入力画面

［応答入力］画面での表示内容を1,024文字以内で指定します。テキスト形式またはHTML形式で指定できます。

−

入力

△

responseTimeOut

応答タイムアウト時間

応答がタイムアウトする時間を1〜9,999（分単位）で指定します。

1440

入力

○

timeOutDefault

タイムアウトデフォルト値

応答がタイムアウトした場合の戻り値を指定します。応答タイムアウト時間を経過すると，タイムアウトデフォルト値を戻り値として返します。例えば，「0」を指定した場合，応答タイムアウト時間を経過すると，プロパティ「labelButton0」に対応した処理を実行します。

戻り値は，0〜63の範囲で指定してください。

0

入力

○

labelButton0

ボタン0表示ラベル

戻り値0を返す応答のボタンラベルを256文字以内で指定します。［応答入力］画面にユーザーの運用に合ったボタンを表示できます。

OK

入力

○

labelButton1

ボタン1表示レベル

戻り値1を返す応答のボタンラベルを256文字以内で指定します。［応答入力］画面にユーザーの運用に合ったボタンを表示できます。

指定を省略すると，ボタンは表示されません。

−

入力

△

labelButton2

ボタン2表示ラベル

戻り値2を返す応答のボタンラベルを256文字以内で指定します。［応答入力］画面にユーザーの運用に合ったボタンを表示できます。

指定を省略すると，ボタンは表示されません。

−

入力

△

labelButton3

ボタン3表示ラベル

戻り値3を返す応答のボタンラベルを256文字以内で指定します。［応答入力］画面にユーザーの運用に合ったボタンを表示できます。

指定を省略すると，ボタンは表示されません。

−

入力

△

labelButton4

ボタン4表示ラベル

戻り値4を返す応答のボタンラベルを256文字以内で指定します。［応答入力］画面にユーザーの運用に合ったボタンを表示できます。

指定を省略すると，ボタンは表示されません。

−

入力

△

labelButton5

ボタン5表示ラベル

戻り値5を返す応答のボタンラベルを256文字以内で指定します。［応答入力］画面にユーザーの運用に合ったボタンを表示できます。

指定を省略すると，ボタンは表示されません。

−

入力

△

labelButton6

ボタン6表示ラベル

戻り値6を返す応答のボタンラベルを256文字以内で指定します。［応答入力］画面にユーザーの運用に合ったボタンを表示できます。

指定を省略すると，ボタンは表示されません。

−

入力

△

labelButton7

ボタン7表示ラベル

戻り値7を返す応答のボタンラベルを256文字以内で指定します。［応答入力］画面にユーザーの運用に合ったボタンを表示できます。

指定を省略すると，ボタンは表示されません。

−

入力

△

labelButton8

ボタン8表示ラベル

戻り値8を返す応答のボタンラベルを256文字以内で指定します。［応答入力］画面にユーザーの運用に合ったボタンを表示できます。

指定を省略すると，ボタンは表示されません。

−

入力

△

labelButton9

ボタン9表示ラベル

戻り値9を返す応答のボタンラベルを256文字以内で指定します。［応答入力］画面にユーザーの運用に合ったボタンを表示できます。

指定を省略すると，ボタンは表示されません。

−

入力

△

プロパティ「dialogText」に指定できるHTMLタグおよび属性

プロパティ「dialogText」にHTML形式で表示内容を指定する場合，次の表に示すタグを使用してください。

表4‒6　プロパティ「dialogText」に指定できるHTMLタグおよび属性一覧

指定できるタグ名

指定できる属性名

注意事項

アンカータグ（<a>）※1

href

「http://」または「https://」で始まる絶対URLを指定してください。

［応答入力］画面から，JP1/IM - NPの画面をシングルサインオンで起動できます。シングルサインオンで起動できるようにするためには，href属性にJP1/IM - NPの画面へのリンクを指定し，リンクの中でJP1トークン置き換え文字列を指定してください。

JP1トークン置き換え文字列は「[JP1TOKEN]」です（大文字と小文字は区別しません）。［応答入力］画面が表示されるときに，文字列「[JP1TOKEN]」がJP1トークンに置き換わります。

ただし，次の2つの条件を満たしていることが前提です。

href属性の値を「"」で囲んで指定する。

外部認証連携（JP1/Baseの認証機能との連携）の機能を利用している。

1つのアンカータグの中で，「[JP1TOKEN]」の文字列を置き換えるのは1回だけです。「[JP1TOKEN]」の文字列は，2つ以上指定しないでください。

部品プロパティ「dialogText」の指定例を次に示します。

以下のリンクを参照して手動セキュリティパッチの適用を行ってください。手動セキュリティパッチの適用が完了したら「OK」ボタンを押してください。<br>

<a href="http://localhost:9999/ucnpBase/portal/screen/Home/action/PLoginUser?jp1token=[JP1TOKEN]" target="_blank">手動セキュリティパッチ適用手順</a>

target

−

ボールドタグ（<b>）

−

−

ブレークタグ（<br>）

−

−

フォントタグ（<font>）

color

16進数のカラー値（#000000〜#FFFFFF）を指定してください。

face

−

size

−

イタリックタグ（<i>）

−

−

下線タグ（<u>）

−

−

フォームタグ（<form>）

−

−

インプットタグ（<input>）※2

name

サービスプロパティキーを指定すると，応答待ち中に応答入力ダイアログで指定したサービスプロパティのマッピングパラメーターを変更できます。type属性にpasswordを指定した場合，マッピングするサービスプロパティのデータ型はpasswordを指定してください。タスクログに出力するKNAE08352-Iメッセージの「入力された値」に出力される文字列は，データ型によって次のとおりです。

password型：「********」

password型以外：入力された値

type

指定できる値は次のとおりです。

text

checkbox

radio

password

value

type属性にcheckboxまたはradioを指定した場合，value属性を必ず指定してください。

チェックボックスまたはラジオボタンでチェックを入れた項目のvalue属性で設定した値が，name属性で指定したサービスプロパティのマッピングパラメーターとなります。

セレクトタグ（<select>）

name

サービスプロパティキーを指定すると，応答待ち中に応答入力ダイアログで指定したサービスプロパティのマッピングパラメーターを変更できます。

オプションタグ（<option>）※3

value

セレクトメニューまたはリストボックスで選択した項目のvalue属性で設定した値が，name属性で指定したサービスプロパティのマッピングパラメーターとなります。

（凡例）

−：対象外です。

注※1

リンクテキストは青字で表示されません。また，target属性には「_blank」を指定してください。

注※2

繰り返し実行部品（parallel）配下の応答待ち部品でサービスプロパティのパラメーターを変更すると，予期せぬ値を更新する場合があります。繰り返し部品（parallel）配下のユーザー応答待ち部品では，サービスプロパティの内容を変更しない（インプットタグを指定しない）ようにしてください。

注※3

セレクトタグで囲んで指定してください。

関連トピック

マニュアル「JP1/AO 構築ガイド」−「JP1/Baseの認証機能との連携」のトピック

マニュアル「JP1/AO 運用ガイド」−「JP1/Baseの認証機能との連携」のトピック

マニュアル「JP1/AO 運用ガイド」−「JP1/IM - NPの業務コンテンツとの連携」のトピック

4.2.7　標準出力部品

機能

この部品は，バージョンが10-02以前のJP1/AO同梱版サービステンプレートおよびJP1/AO Content Pack版サービステンプレートとの互換用部品です。

次の値を組み合わせて，標準出力に出力できます。

サービスプロパティの値

予約プロパティの値

リテラル文字列

これによって，JP1/AOのステップが標準出力ファイルに出力した値を，JP1/AJS3の引き継ぎ情報設定ジョブでマクロ変数に反映できるようになります。なお，標準出力ファイルに出力した値をマクロ変数に反映するには，事前に設定が必要です。

図4‒2　標準出力部品の概要

注意事項

部品の実行中にタスクを実行停止した場合は，標準出力部品の処理が完了してからタスクの状態が「失敗」または「正常終了」になります。部品の実行が終了したときのステップおよびタスクの状態は，ステップの戻り値および後続ステップ実行条件によって決まります。後続ステップ実行条件は，［ステップ作成］ダイアログボックスまたは［ステップ編集］ダイアログボックスで設定できます。

部品の実行中にタスクを強制停止した場合は，実行中の処理が直ちに終了され，タスクの状態が「失敗」になります。なお，［タスク］画面の［フロー］エリアに表示されるステップの戻り値は，80になります。タスクログに出力される戻り値は，強制停止したタイミングによって異なります。

バージョン

01.00.01

タグ

なし

戻り値

戻り値

説明

0

正常に終了した。

65

JP1/AOサーバとの接続に失敗した。例えば，部品実行中にJP1/AOサーバが停止された場合が該当する。

66

次のユーザーがJP1ユーザーにマッピングされている。

Administrators グループに所属しないユーザーである。

Administrators グループに所属するビルトイン Administrator以外のユーザーで，UACが有効である。

68

対象のジョブ実行IDに関する情報がない。

69

タスク処理エンジンの環境変数の取得に失敗した。

80

タスクの実行を停止した。

81

部品が不正な状態で呼び出された。

82

タスク処理エンジンからの要求メッセージを正しくパースできない。

83

JP1/AOサーバの環境が壊れている。

84

指定された部品の情報が取得できない。

86

指定したプロパティ値に誤りがある。

127

そのほかのエラーが発生した。

プロパティ一覧

プロパティを次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

stdoutProperty

標準出力値

標準出力に出力したい値を指定します。次の形式で指定できます。また，これらを組み合わせることも可能です。

?dna_サービスプロパティのプロパティキー?（サービスプロパティに入力された値を参照する場合）

?dna_予約プロパティのプロパティキー?（予約プロパティに入力された値を参照する場合）

リテラル文字列

−

入力

○

出力できる予約プロパティ

標準出力部品で出力できる予約プロパティを次に示します。

表4‒7　出力できる予約プロパティ一覧

予約プロパティ

出力可否

reserved.loop.index

○

reserved.loop.input

○

reserved.loop.output

○

reserved.service.name

○

reserved.service.serviceGroupName

○

reserved.step.path

○

reserved.step.prevReturnCode

○

reserved.task.description

○

reserved.task.dir

○

reserved.task.id

○

reserved.task.name

○

reserved.task.submitter

○

reserved.task.tags

○

reserved.task.url

○

reserved.terminal.account

×

reserved.terminal.password

×

reserved.terminal.suPassword

×

（凡例）

○：出力できます。 ×：出力できません。

関連トピック

マニュアル「JP1/AO サービステンプレート開発ガイド」−「予約プロパティ一覧」のトピック

4.2.8　ターミナル接続部品

機能

操作対象の機器にTelnetまたはSSHで接続し，認証できます。

Telnetで接続する場合は，必要に応じ，ユーザーIDおよびパスワードを設定してください。また，SSHで接続する場合は，認証方式としてパスワード認証，公開鍵認証またはキーボードインタラクティブ認証が選択できます。次の情報は，部品のプロパティに設定するか，［エージェントレス接続先定義］エリアで設定する必要があります。

認証方式（パスワード認証，公開鍵認証またはキーボードインタラクティブ認証）

パスワード認証およびキーボードインタラクティブ認証に必要な情報（ユーザーID，パスワード）

公開鍵認証に必要な情報（ユーザーID）

ターミナルコマンド実行部品に指定したコマンドは，ターミナル接続部品で認証したユーザーの権限で実行されます。コマンドを管理者権限で実行したい場合は，ターミナルコマンド実行部品で管理者権限に昇格するコマンドを実行してください。

実行時の前提条件

JP1/AOサーバとの通信に使用できるプロトコルは，プロパティ「protocol」で指定されたプロトコルとなります。

エージェントレス接続先として使用できる操作対象の機器については，「付録A.1(3)　エージェントレス接続先として使用できる操作対象の機器」を参照してください。

Telnetで接続する場合は，ユーザーIDおよびパスワードが入力待ち状態であることを検知するため，次のどちらかのファイルを，必要に応じて設定してください。なお，両方のファイルを設定した場合は，接続先プロパティファイル（接続先名.properties）に設定した値が適用されます。

接続先プロパティファイル（接続先名.properties）のtelnet.prompt.accountおよびtelnet.prompt.password

ユーザー設定プロパティファイル（config_user.properties）のplugin.terminal.prompt.accountおよびplugin.terminal.prompt.password

注意事項

プロパティ「readWaitTime」に指定した時間だけ，標準出力が出力されるまで待ちます。標準出力の出力が中断してから，プロパティ「readWaitTime」に指定した時間を経過すると，部品の実行がエラー終了します。そのため，プロパティ「readWaitTime」の値は，事前に確認してから指定してください。

標準出力の値が，プロパティ「promptPattern」に指定した正規表現パターンと合致した場合は，その時点で部品は終了します。

Telnetを使用して操作対象の機器に接続する場合，接続後，ユーザー設定プロパティファイル（config_user.properties）のtelnet.connect.waitに設定された時間，標準出力および標準エラー出力が返されるまで待ちます。接続するサービスがWebサーバなど，標準出力および標準エラー出力を返さない場合は，接続するサービスのポート番号を，接続先プロパティファイル（接続先名.properties）のtelnet.noStdout.port.listに設定してください。設定した場合，接続後，標準出力および標準エラー出力が返されるのを待たないで，部品の実行が終了します。

部品の実行中にタスクを実行停止した場合は，ターミナル接続部品の処理が完了してからタスクの状態が「失敗」または「正常終了」になります。その後，セッションおよびトークンは破棄されます。部品の実行が終了したときのステップおよびタスクの状態は，ステップの戻り値および後続ステップ実行条件によって決まります。後続ステップ実行条件は，［ステップ作成］ダイアログボックスまたは［ステップ編集］ダイアログボックスで設定できます。

部品の実行中にタスクを強制停止した場合は，標準出力の読み込みおよびプロンプトの検出処理が中断され，タスクの状態が「失敗」になります。その後，セッションおよびトークンは破棄されます。なお，［タスク］画面の［フロー］エリアに表示されるステップの戻り値は，80になります。タスクログに出力される戻り値は，強制停止したタイミングによって異なります。

ターミナル接続部品の後続ステップの状態が「失敗」の場合，Telnet接続またはSSH接続が切断されます。そのため，［失敗したステップからリトライ］または［失敗した次のステップからリトライ］でタスクをリトライすると，ターミナルコマンド実行部品の処理は失敗します。ただし，繰り返し実行部品の配下に部品がある場合で，繰り返し実行部品からリトライするときは対象外です。

Telnetで認証に失敗した場合でも接続は維持されます。接続を切断するには，ターミナル切断部品を実行してください。ただし，タスクの状態が「失敗」または「正常終了」になった場合は，自動的に切断されるため，ターミナル切断部品の実行は不要です。

ターミナル接続部品の標準出力および標準エラー出力は，JP1/AOのステップの標準出力として出力されます。標準出力および標準エラー出力のサイズは，JP1/AOが受信したバイト数の合計になります。TelnetサーバまたはSSHサーバの設定によって，改行文字LFがCR+LFに置き換わる場合は，改行文字を2バイトとして計算してください。標準出力および標準エラー出力の合計が100KBを超えた場合の処理の実行結果については，製品サポートの対象外となります。事前に，標準出力および標準エラー出力の合計が100KBを超えていないことを確認してください。

Telnetでは認証エラーを検出できません。そのため，プロパティ「stdoutPattern1〜3」に，標準出力や標準エラー出力の内容から認証エラーを検出するための正規表現パターンを指定してください。

バージョン

02.00.00

タグ

Terminal

戻り値

戻り値

説明

0〜63

標準出力および標準エラー出力がプロパティ「returnCodePattern」に指定した正規表現パターンと合致した場合は，プロパティ「returnCode」に指定した戻り値を返す。ただし，標準出力および標準エラー出力がプロパティ「returnCodePattern」に指定した正規表現パターンと合致しなかった場合は，プロパティ「defaultReturnCode」に指定した戻り値を返す。そのため，戻り値の意味は，この部品を使用するサービステンプレートごとに異なる。

65

JP1/AOサーバとの接続に失敗した。例えば，部品実行中にJP1/AOサーバが停止された場合が該当する。

66

次のユーザーがJP1ユーザーにマッピングされている。

Administrators グループに所属しないユーザーである。

Administrators グループに所属するビルトイン Administrator以外のユーザーで，UACが有効である。

68

対象のジョブ実行IDに関する情報がない。

69

タスク処理エンジンの環境変数の取得に失敗した。

70

操作対象の機器への接続に失敗した。

76

接続タイムアウトが発生した。

77

操作対象の機器のホスト名解決に失敗した。

78

プロトコルがSSHの場合に，次のどれかの理由で操作対象の機器との認証に失敗した。

パスワード認証に失敗した。

操作対象の機器に公開鍵認証機能が設定されていない。

公開鍵認証で，秘密鍵とパスフレーズが一致していない。

公開鍵認証で，秘密鍵と操作対象の機器に登録されている公開鍵が対になっていない。

公開鍵認証で，不正な秘密鍵が使用されている。

キーボードインタラクティブ認証に失敗した。

80

タスクの実行を停止した。

81

部品が不正な状態で呼び出された。

82

タスク処理エンジンからの要求メッセージを正しくパースできない。

83

JP1/AOサーバの環境が壊れている。

84

指定された部品の情報が取得できない。

86

指定したプロパティ値に誤りがある。

87

標準出力および標準エラー出力のタイムアウトが発生した。

88

トークンの数が上限値（1タスク当たり99個）に達している。

標準出力および標準エラー出力の合計が100KBを超えた。

127

そのほかのエラーが発生した。

プロパティ一覧

プロパティを次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

destinationHost

対象機器

操作対象の機器のIPv4アドレス，IPv6アドレスまたはホスト名を1,024文字 以内で指定します。なお，複数のIP アドレスまたはホスト名は指定できません。

−

入力

○

protocol

プロトコル

操作対象の機器との接続に使用するプロトコルを指定します。指定できるプロトコルを次に示します。

Telnet

SSH

Telnet

入力

△

credentialType

認証種別

コマンドまたはスクリプト実行時の認証種別について，次のどちらかを指定します。

destination

［エージェントレス接続先定義］エリアに設定されている認証情報（ユーザーID，パスワード，管理者のパスワード）を使用する場合に指定します。「destination」を指定すると，JP1/AOのログインユーザーのIPアドレスに応じて，TelnetまたはSSHのエージェントレス接続先定義に設定済みの認証情報が適用されます。また，認証情報に関するプロパティ（「account」，「password」，「suPassword」，「publicKeyAuthentication」または「keyboardInteractiveAuthentication」）の指定を省略できます。

property

認証情報として，次のプロパティに入力した値を使用する場合に指定します。

account

password

suPassword

publicKeyAuthentication

keyboardInteractiveAuthentication

−

入力

○

account

ユーザーID

操作対象の機器にログインするためのユーザーIDを256文字以内で指定します。

次の値をどちらも指定している場合は，指定が必須です。

プロパティ「protocol」に「SSH」を指定している。

プロパティ「credentialType」に「property」を指定している。

−

入力

△

password

パスワード

操作対象の機器にログインするためのパスワードを256文字以内で指定します。

次の条件をすべて満たしている場合は，指定が必須です。

プロパティ「protocol」に「SSH」を指定している。

プロパティ「credentialType」に「property」を指定している。

プロパティ「publicKeyAuthentication」に「false」を指定している。

操作対象の機器のOSがUNIXで，プロパティ「publicKeyAuthentication」に「true」を指定している場合は，値を指定しても無視されます。ただし，予約プロパティ「reserved.terminal.password」の参照先としては指定できます。

−

入力

△

suPassword

管理者のパスワード

管理者権限に昇格する場合に必要なパスワードを256文字以内で指定します。 ターミナルコマンド実行部品のコマンドラインに，予約プロパティ「reserved.terminal.suPassword」を指定すると，プロパティ「suPassword」の値が設定されます。

−

入力

△

publicKeyAuthentication

SSH公開鍵認証設定

操作対象の機器のOSがUNIXで，プロトコルがSSHの場合，公開鍵認証を使用するかどうかについて次のどちらかを指定します。大文字と小文字は区別しません。このプロパティに値を指定しない場合は，「false」として扱われます。操作対象の機器のOSがWindowsの場合は，指定不要です。

true

公開鍵認証を使用する場合に指定します。

false

公開鍵認証を使用しない場合に指定します。※1

false

入力

△

keyboardInteractiveAuthentication

SSHキーボードインタラクティブ認証設定

操作対象の機器のOSがUNIXの場合，接続にキーボードインタラクティブ認証を使用するかどうかについて次のどちらかを指定します。大文字と小文字は区別しません。このプロパティに値を指定しない場合は，「false」として扱われます。操作対象の機器のOSがWindowsの場合は，指定不要です。

ただし，プロパティ「keyboardInteractiveAuthentication」の値が有効になるのは，「publicKeyAuthentication」に「false」を指定した場合です。「publicKeyAuthentication」に「true」を指定した場合，「keyboardInteractiveAuthentication」に「true」を指定しても，公開鍵認証が設定されます。

true

キーボードインタラクティブ認証を使用する場合に指定します。

false

キーボードインタラクティブ認証を使用しない場合に指定します。※

false

入力

△

port

ポート番号

操作対象の機器との接続に使用するポート番号を指定します。

−

入力

△

charset

文字セット

操作対象の機器への標準入力の書き込みと，標準出力および標準エラー出力の読み込みに使用する文字セットを指定します。操作対象の機器にログインするユーザーに設定されている文字セットと，同一の文字セットを指定してください。大文字と小文字は区別されません。指定できる文字セットを次に示します。

EUC-JP

eucjp

ibm-943C

ISO-8859-1

MS932

PCK

Shift_JIS

UTF-8

windows-31j

−

入力

△

lineEnd

行端文字

ターミナル接続部品のプロパティ「protocol」で「Telnet」を指定した場合，プロパティ「account」および「password」で設定した値に付加する行端文字を指定します。指定できる行端文字を次に示します。

CR

LF

CRLF

付加する行端文字が，0x0Dの場合は「CR」，0x0Aの場合は「LF」，0x0D0Aの場合は「CRLF」を指定します。

CR

入力

△

promptPattern

プロンプトパターン

標準出力および標準エラー出力に，プロンプト文字列が出力されたことを検出するための正規表現パターンを1,024文字以内で指定します。このプロパティは，操作対象の機器に接続したあと，コマンドが実行できる状態であることを判定するために使用します。正規表現パターンはPCREに従って指定してください。指定した正規表現と合致した場合は，その時点で終了します。正規表現パターンと合致しない場合，標準出力および標準エラー出力の出力後，プロパティ「readWaitTime」に設定した時間が経過すると，部品実行がエラー終了します。

−

入力

○

readWaitTime

標準出力待ち時間

操作対象の機器にログインする際に，実行時の標準出力または標準エラー出力が出力されてから，次の標準出力または標準エラー出力が出力されるまでのタイムアウト時間を，1〜86,400,000の範囲で指定します。値はミリ秒単位で指定してください。

60000

入力

△

token

トークン文字列

セッションを識別するためのトークン文字列が出力されます。ターミナルコマンド実行部品と，ターミナル切断部品のプロパティ「token」には，このプロパティに出力される文字列を指定します。

−

出力

△

outputCondition※2

標準出力プロパティ出力条件

プロパティ「stdoutProperty1〜3」に値を出力する条件を指定します。

指定できる値を次に示します。

always

常に「stdoutProperty1〜3」に値を出力します。プロパティ「stdoutPattern1〜3」に合致しなかった場合は空文字を出力します。

patternMatch

プロパティ「stdoutPattern1〜3」に合致した場合にプロパティ「stdoutProperty1〜3」に値を出力します。合致しなかった場合は値を出力しません。この場合，プロパティ「stdoutProperty1〜3」にサービスプロパティがマッピングされているときでも値は更新されません。

always

入力

○

stdoutPattern1

標準出力パターン1

プロパティ「stdoutProperty1」に出力する標準出力および標準エラー出力の正規表現パターンを1,024 文字以内で指定します。正規表現パターンはPCRE に従って指定してください。※3

設定できる文字列は1,024 文字までです。1,025 文字以降は切り捨てられます。

−

入力

△

stdoutProperty1

標準出力プロパティ1

プロパティ「stdoutPattern1」で切り出した文字列が出力されます。

−

出力

△

stdoutPattern2

標準出力パターン2

プロパティ「stdoutProperty2」に出力する標準出力および標準エラー出力の正規表現パターンを1,024 文字以内で指定します。正規表現パターンはPCRE に従って指定してください。※3

設定できる文字列は1,024 文字までです。1,025 文字以降は切り捨てられます。

−

入力

△

stdoutProperty2

標準出力プロパティ2

プロパティ「stdoutPattern2」で切り出した文字列が出力されます。

−

出力

△

stdoutPattern3

標準出力パターン3

プロパティ「stdoutProperty3」に出力する標準出力および標準エラー出力の正規表現パターンを1,024 文字以内で指定します。正規表現パターンはPCRE に従って指定してください。※3

設定できる文字列は1,024 文字までです。1,025 文字以降は切り捨てられます。

−

入力

△

stdoutProperty3

標準出力プロパティ3

プロパティ「stdoutPattern3」で切り出した文字列が出力されます。

−

出力

△

defaultReturnCode

デフォルト戻り値

標準出力および標準エラー出力がプロパティ「returnCodePattern」に指定した正規表現パターンと合致しなかった場合に，部品の戻り値として返される値を指定します。0〜63の範囲で指定します。

0

入力

△

returnCodePattern

戻り値判定パターン

標準出力および標準エラー出力の正規表現パターンを1,024 文字以内で指定します。正規表現パ ターンはPCRE に従って指定してください。指定した正規表現パターンが標準出力および標準エラー出力に合致した場合は，プロパティ「returnCode」に指定した値が返されます。

−

入力

△

returnCode

戻り値

標準出力および標準エラー出力がプロパティ「returnCodePattern」で設定した標準出力パターンと合致した場合の，部品の戻り値を指定します。0〜63の範囲で指定します。このプロパティを指定しない場合は，プロパティ「defaultReturnCode」に指定した値が返されます。

−

入力

△

注※1

プロパティ「publicKeyAuthentication」および「keyboardInteractiveAuthentication」の両方に「false」を指定した場合，パスワード認証が設定されます。

注※2

部品のバージョンが02.00.00未満の場合，このプロパティは実装されていませんが，「patternMatch」を指定した場合と同じ動作になります。最新の部品にバージョンアップした場合，このプロパティのデフォルト値に「always」が指定されて動作が変わるので，必要に応じて値を設定し直してください。

注※3

正規表現により抽出されるのは，括弧でグループ化された部分です。

正規表現に複数のグループを指定した場合，最初のグループに該当する範囲だけが部品の出力プロパティに格納されます。

正規表現に複数の範囲が該当する場合，最初に該当する範囲だけが部品の出力プロパティに格納されます。複数の範囲を格納することはできません。

任意のコマンドの実行結果など改行を含む文字列から抽出する場合，改行までの文字列を抽出するには，「(.*)」と指定してください。

プロパティ「stdoutPattern1〜3」および「stdoutProperty1〜3」の使用例

標準出力および標準エラー出力をプロパティ「stdoutPattern1〜3」の値と照合した結果を，プロパティ「stdoutProperty1〜3」にそれぞれ格納できるようになります。次の図に，「stdoutPattern1」に「aaabbb(.*)」を指定した場合のデータの流れを示します。

図4‒3　プロパティ「stdoutPattern」および「stdoutProperty」の使用例

標準出力「aaabbbccc」に対して，「stdoutPattern1」で定義しているように，標準出力の「aaabbb」より後ろの値（ccc）が抽出されます。抽出された値は，プロパティ「stdoutProperty1」に格納されます。

プロパティ「stdoutPattern1〜3」で指定した正規表現が標準出力と合致せず値を抽出できなかった場合に，プロパティ「stdoutProperty1〜3」に値を格納するかどうかは，プロパティ「outputCondition」で指定できます。

部品プロパティに関連する情報を複数個所で指定した場合の優先順位

部品プロパティに関連する情報は，接続先プロパティファイル（接続先名.properties）やユーザー設定プロパティファイル（config_user.properties）でも設定できます。複数個所で値が設定されている場合は，次の優先順位の設定値が適用されます。

表4‒8　部品プロパティの関連する情報が設定される優先順位

設定内容

設定個所

プロパティキー

優先順位

デフォルト値

Telnetポート番号

部品プロパティ

port

1

−

接続先プロパティファイル（接続先名.properties）

telnet.port

2

−

ユーザー設定プロパティファイル（config_user.properties）

telnet.port.number

3

23

SSHポート番号

部品プロパティ

port

1

−

接続先プロパティファイル（接続先名.properties）

ssh.port

2

−

ユーザー設定プロパティファイル（config_user.properties）

ssh.port.number

3

22

文字セット名※

部品プロパティ

charset

1

−

接続先プロパティファイル（接続先名.properties）

terminal.charset

2

−

（凡例）

−：デフォルト値は空です。

注※

部品プロパティおよび接続先プロパティファイル（接続先名.properties）に値が指定されていない場合は，「UTF-8」が設定されます。

関連トピック

マニュアル「JP1/AO 構築ガイド」−「ユーザー設定プロパティファイル（config_user.properties）」および「接続先プロパティファイル（接続先名.properties）」のトピック

4.2.9　ターミナルコマンド実行部品

4.2.10　ターミナル切断部品

付録A.2　各部品で使用できるプロトコル一覧

マニュアル「JP1/AO 構築ガイド」−「SSH接続で公開鍵認証を設定する手順」のトピック

(1)　ターミナル接続部品の使用例

Telnetでの認証エラーを判定する場合の例

部品のプロパティを使用して，次の処理をしたい場合を例に説明します。

ログインに成功した場合は，戻り値を0で返す。

ログインに失敗した場合は，戻り値を1で返す。

ログインに成功した場合，最終ログイン日時と接続元の情報をプロパティ「stdoutProperty1」に格納する。

これらの処理をしたい場合は，部品のプロパティに次のような値を指定してください。

プロパティキー

指定値の例

指定値の意味

promptPattern

^¥[prompt¥]|^Login incorrect

標準出力の内容が，「[prompt]」または「Login incorrect」と合致した場合に部品を終了し，戻り値を判定する。

stdoutPattern1

^Last login:(.*)

標準出力の内容で，「Last login:」より後ろの文字列をプロパティ「stdoutProperty1」に格納する。

defaultReturnCode

0

標準出力の内容が，プロパティ「returnCodePattern」に指定した値と合致しなかった場合に，戻り値0を返す。

returnCodePattern

^ Login incorrect

標準出力の内容が，「Login incorrect」と合致した場合，プロパティ「returnCode」で指定した戻り値を返す。

returnCode

1

標準出力の内容が，プロパティ「returnCodePattern」に指定した値と合致した場合に，戻り値1を返す。

このように部品のプロパティを指定している場合，標準出力が次に示す内容だったときの動作について説明します。

ログインに成功した場合の例

標準出力の内容がプロパティ「promptPattern」に指定した値と合致するため，ターミナル接続部品の戻り値を判定します。このとき，プロパティ「returnCodePattern」に指定した値とは合致しないため，部品の戻り値は，プロパティ「defaultReturnCode」に指定した値（0）になります。

また，プロパティ「stdoutPattern1」で切り出された文字列（Mon Mar 18 13:21:13 2013 from ServerA）が，プロパティ「stdoutProperty1」に格納されます。

ログインに失敗した場合の例

標準出力の内容がプロパティ「promptPattern」に指定した値と合致するため，ターミナル接続部品の戻り値を判定します。このとき，プロパティ「returnCodePattern」に指定した値と合致するため，部品の戻り値は，プロパティ「returnCode」に指定した値（1）になります。

SSHでの認証エラーが発生したかどうかを確認する場合

プロトコルに「SSH」を指定した場合，ターミナル接続部品の戻り値で認証エラーを確認できます。

認証エラーは，［エージェントレス接続先定義］エリアで設定した認証情報，またはターミナル接続部品の認証情報に関するプロパティ（「account」，「password」，「publicKeyAuthentication」，および「keyboardInteractiveAuthentication」）を使用して検出されます。このとき，［エージェントレス接続先定義］エリアで設定したスーパーユーザーのパスワード，またはターミナル接続部品のプロパティ「suPassword」は使用しません。

なお，認証エラーの場合は，部品の戻り値は78になります。ただし，プロパティ「credentialType」に「destination」を指定している場合で，［エージェントレス接続先定義］エリアの認証情報が正しく設定されていないとき，部品の戻り値は70になります。

HTTPサーバなど標準出力を返さないサービスに接続する場合の例

標準出力を返さないサービスに接続する場合を例に説明します。なお，接続先プロパティファイルのtelnet.noStdout.port.list（接続先名.properties）に「80」を指定しているものとします。

このとき，次に示す部品のプロパティに指定した値は無視され，部品の戻り値は0になります。

credentialType

account

password

suPassword

publicKeyAuthentication

keyboardInteractiveAuthentication

charset

lineEnd

promptPattern

readWaitTime

stdoutPattern1〜3

defaultReturnCode

returnCodePattern

returnCode

4.2.9　ターミナルコマンド実行部品

機能

ターミナル接続部品で接続した操作対象の機器で，指定したコマンドを実行できます。

ターミナルコマンド実行部品に指定したコマンドは，ターミナル接続部品で認証したユーザーの権限で実行されます。コマンドを管理者権限で実行したい場合は，ターミナルコマンド実行部品で管理者権限に昇格するコマンドを実行してください。

実行時の前提条件

JP1/AOサーバとの通信に使用できるプロトコルは，ターミナル接続部品のプロパティ「protocol」で指定されたプロトコルとなります。詳細については，「4.2.8　ターミナル接続部品」のプロパティ「protocol」の説明を参照してください。

エージェントレス接続先として使用できる操作対象の機器については，「付録A.1(3)　エージェントレス接続先として使用できる操作対象の機器」を参照してください。

ターミナル接続部品を実行して，操作対象の機器と接続している必要があります。

注意事項

プロパティ「readWaitTime」に指定した時間だけ，標準出力が出力されるのを待ちます。標準出力の出力が中断してから，プロパティ「readWaitTime」に指定した時間を経過すると，部品の実行がエラー終了します。そのため，プロパティ「readWaitTime」の値は，事前に確認してから設定してください。また，標準出力の出力が中断してから，プロパティ「readWaitTime」に指定した時間を経過した場合，それ以降に出力された内容は破棄されます。

標準出力の値が，プロパティ「promptPattern」に指定した正規表現パターンと合致した場合は，その時点で部品は終了します。

コマンドの出力結果がページ単位で表示されると，標準出力が中断したと見なされます。そのため，プロパティ「readWaitTime」に指定した時間を経過すると，部品の実行がエラー終了します。ターミナルコマンド実行部品を使用して実行するコマンドについて，事前にコマンドの出力結果がページ単位で表示されないよう設定してください。

エコーバックされるコマンドラインも標準出力として出力されます。そのため，必要に応じてエコーバックされない設定にしてください。

部品の実行中にタスクを実行停止した場合は，ターミナルコマンド実行部品の処理が完了してからタスクの状態が「失敗」または「正常終了」になります。その後，セッションおよびトークンは破棄されます。部品の実行が終了したときのステップおよびタスクの状態は，ステップの戻り値および後続ステップ実行条件によって決まります。後続ステップ実行条件は，［ステップ作成］ダイアログボックスまたは［ステップ編集］ダイアログボックスで設定できます。

部品の実行中にタスクを強制停止した場合は，標準出力の読み込みおよびプロンプトの検出処理が中断され，タスクの状態が「失敗」になります。その後，セッションおよびトークンは破棄されます。なお，［タスク］画面の［フロー］エリアに表示されるステップの戻り値は，80になります。タスクログに出力される戻り値は，強制停止したタイミングによって異なります。

部品の実行中にタスクを強制停止した場合，プロパティ「commandLine」で指定したコマンドまたはスクリプトの実行結果については製品サポートの対象外となります。

ターミナル接続部品の後続ステップの状態が「失敗」の場合，Telnet接続またはSSH接続が切断されます。そのため，［失敗したステップからリトライ］または［失敗した次のステップからリトライ］でタスクをリトライすると，ターミナルコマンド実行部品の処理は失敗します。ただし，繰り返し実行部品の配下に部品がある場合で，繰り返し実行部品からリトライするときは対象外です。

ターミナルコマンド実行部品の標準出力および標準エラー出力は，JP1/AOのステップの標準出力として出力されます。標準出力および標準エラー出力のサイズは，JP1/AOが受信したバイト数の合計になります。TelnetサーバまたはSSHサーバの設定によって，改行文字LFがCR+LFに置き換わる場合は，改行文字を2バイトとして計算してください。標準出力および標準エラー出力の合計が100KBを超えた場合の処理の実行結果については，製品サポートの対象外となります。事前に，標準出力および標準エラー出力の合計が100KBを超えていないことを確認してください。

操作対象の機器のOSがUNIXで，プロパティ「commandLine」にASCII文字以外を指定したい場合は，「付録A.4　UNIXでASCII文字以外の文字を含むコマンドラインを実行するための前提条件」を参照してください。

ユーザーに入力を求める対話式コマンドおよびスクリプト，GUI表示などにより自動的に終了しないコマンドは実行できません。

操作対象の機器のOS仕様により，プロパティ「commandLine」にコンソールの幅を超えるようなコマンドラインを指定した場合，コマンドラインの文字列を分割して入力する場合があります。このとき，コマンドの実行が完了する前にプロンプトが表示されるため，部品が正しく終了しない場合があります。この場合，コンソールの幅を拡張することで回避することができます。操作対象の機器がLinuxの場合は，以下のコマンドを実行することで，コンソールの幅を拡張することができます。

stty cols [コンソール幅]

[コンソール幅]には，「プロンプト文字数＋コマンドライン文字数＋10」以上の値を目安として指定してください。拡張したコンソールの幅は，ターミナル切断部品で操作対象の機器との接続を切断 するか，セッションおよびトークンが破棄されるまで有効となります。

バージョン

02.00.00

タグ

Terminal

戻り値

戻り値

説明

0〜63

標準出力および標準エラー出力がプロパティ「returnCodePattern」に指定した正規表現パターンと合致した場合は，プロパティ「returnCode」に指定した戻り値を返す。ただし，標準出力および標準エラー出力がプロパティ「returnCodePattern」に指定した正規表現パターンと合致しなかった場合は，プロパティ「defaultReturnCode」に指定した戻り値を返す。そのため，戻り値の意味は，この部品を使用するサービステンプレートごとに異なる。

65

JP1/AOサーバとの接続に失敗した。例えば，部品実行中にJP1/AOサーバが停止された場合が該当する。

66

次のユーザーがJP1ユーザーにマッピングされている。

Administrators グループに所属しないユーザーである。

Administrators グループに所属するビルトイン Administrator以外のユーザーで，UACが有効である。

68

対象のジョブ実行IDに関する情報がない。

69

タスク処理エンジンの環境変数の取得に失敗した。

70

操作対象の機器との接続が切断した。

80

タスクの実行を停止した。

81

部品が不正な状態で呼び出された。

82

タスク処理エンジンからの要求メッセージを正しくパースできない。

83

JP1/AOサーバの環境が壊れている。

84

指定された部品の情報が取得できない。

86

指定したプロパティ値に誤りがある。

または，入力プロパティのトークンが不正である。

87

標準出力および標準エラー出力のタイムアウトが発生した。

88

標準出力および標準エラー出力の合計が100KBを超えた。

127

そのほかのエラーが発生した。

プロパティ一覧

プロパティを次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

token

トークン

ターミナル接続部品のプロパティ「token」の値を指定します。

−

入力

○

commandLine

コマンドライン

操作対象の機器で実行したいコマンドまたはスクリプトの絶対パスを1,024文字以内で指定します。

コマンドラインには，JP1/AOサーバのOSと操作対象の機器のOSの両方のコマンドに入力できる文字を指定してください。

コマンドラインに環境変数を表す特殊文字などが含まれる場合でも ，エスケープされません。特殊文字を文字列として扱いたい場合，操作対象の機器のOSがWindowsのときは「%」で，操作対象の機器のOSがUNIXのときは「¥」でエスケープした文字を設定してください。

管理者に昇格する場合など，コマンドラインにスーパーユーザーのパスワードを入力する場合は，予約プロパティ 「reserved.terminal.suPassword」を指定します。予約プロパティ「reserved.terminal.account」，「reserved.terminal.password」，および「reserved.terminal.suPassword」は，トークンに関連した認証情報を参照します。トークンに関連した認証情報は，ターミナル接続部品に設定された情報です。認証情報の参照先は，ターミナル接続部品のプロパティ「credentialType」の設定値によって変わります。

プロパティ「credentialType」で「destination」を指定している場合

予約プロパティの参照先は，エージェントレス接続先に定義された認証情報です。

プロパティ「credentialType」で「property」を指定している場合

ターミナル接続部品のプロパティ「credentialType」で指定された認証情報です。

−

入力

△

charSet※1

文字セット

操作対象の機器への標準入力の書き込みと，標準出力および標準エラー出力の読み込みに使用する文字セットを指定します。操作対象の機器にログインするユーザーに設定されている文字セットと，同一の文字セットを指定してください。大文字と小文字は区別されません。指定できる文字セットを次に示します。

EUC-JP

eucjp

ibm-943C

ISO-8859-1

MS932

PCK

Shift_JIS

UTF-8

windows-31j

−

入力

△

lineEnd

行端文字

プロパティ「commandLine」で設定した値に付加する行端文字を指定します。指定できる行端文字を次に示します。

CR

LF

CRLF

付加する行端文字が，0x0Dの場合は「CR」，0x0Aの場合は「LF」，0x0D0Aの場合は「CRLF」を指定します。

CR

入力

△

promptPattern

プロンプトパターン

標準出力および標準エラー出力に，プロンプト文字列が出力されたことを検出するための正規表現パターンを1,024文字以内で指定します。このプロパティは，操作対象の機器でコマンドを実行したあと，次のコマンドが実行できる状態であることを判定するために使用します。正規表現パターンはPCREに従って指定してください。指定した正規表現と合致した場合は，その時点で終了します。正規表現パターンと合致しない場合，標準出力および標準エラー出力の出力後，プロパティ「readWaitTime」に設定した時間が経過すると，部品実行がエラー終了します。

−

入力

○

readWaitTime

標準出力待ち時間

コマンドを実行する際に，実行時の標準出力または標準エラー出力が出力されたあとから，次の標準出力または標準エラー出力が出力されるまでのタイムアウト時間を，1〜86,400,000の範囲で指定します。値はミリ秒単位で指定してください。

60000

入力

△

stdoutPattern1

標準出力パターン1

プロパティ「stdoutProperty1」に出力する標準出力および標準エラー出力の正規表現パターンを1,024 文字以内で指定します。正規表現パターンはPCRE に従って指定してください。※3

設定できる文字列は1,024 文字までです。1,025 文字以降は切り捨てられます。

−

入力

△

stdoutProperty1

標準出力プロパティ1

プロパティ「stdoutPattern1」で切り出した文字列が出力されます。

−

出力

△

stdoutPattern2

標準出力パターン2

プロパティ「stdoutProperty2」に出力する標準出力および標準エラー出力の正規表現パターンを1,024 文字以内で指定します。正規表現パターンはPCRE に従って指定してください。※3

設定できる文字列は1,024 文字までです。1,025 文字以降は切り捨てられます。

−

入力

△

stdoutProperty2

標準出力プロパティ2

プロパティ「stdoutPattern2」で切り出した文字列が出力されます。

−

出力

△

stdoutPattern3

標準出力パターン3

プロパティ「stdoutProperty3」に出力する標準出力および標準エラー出力の正規表現パターンを1,024 文字以内で指定します。正規表現パターンはPCRE に従って指定してください。※3

設定できる文字列は1,024 文字までです。1,025 文字以降は切り捨てられます。

−

入力

△

stdoutProperty3

標準出力プロパティ3

プロパティ「stdoutPattern3」で切り出した文字列が出力されます。

−

出力

△

defaultReturnCode

デフォルト戻り値

標準出力および標準エラー出力がプロパティ「returnCodePattern」に指定した正規表現パターンに合致しなかった場合に，部品の戻り値として返される値を指定します。 0〜63の範囲で指定します。

0

入力

△

outputCondition※2

標準出力プロパティ出力条件

プロパティ「stdoutProperty1〜3」に値を出力する条件を指定します。

指定できる値を次に示します。

always

常に「stdoutProperty1〜3」に値を出力します。プロパティ「stdoutPattern1〜3」に合致しなかった場合は空文字を出力します。

patternMatch

プロパティ「stdoutPattern1〜3」に合致した場合にプロパティ「stdoutProperty1〜3」に値を出力します。合致しなかった場合は値を出力しません。この場合，プロパティ「stdoutProperty1〜3」にサービスプロパティがマッピングされているときでも値は更新されません。

always

入力

○

returnCodePattern

戻り値判定パターン

標準出力および標準エラー出力の正規表現パターンを1,024 文字以内で指定します。正規表現パターンはPCRE に従って指定してください。指定した値が標準出力および標準エラー出力と合致した場合は，プロパティ「returnCode」に指定した戻り値が返されます。

−

入力

△

returnCode

戻り値

標準出力および標準エラー出力がプロパティ「returnCodePattern」に指定した正規表現パターンに合致した場合に，部品の戻り値として返される値を指定します。0〜63の範囲で指定します。このプロパティを指定しない場合は，プロパティ「defaultReturnCode」に指定した値が返されます。

−

入力

△

注※1

文字セットは，接続先プロパティファイル（接続先名.properties）のterminal.charsetでも設定できます。プロパティ「charSet」および接続先プロパティファイル（接続先名.properties）のterminal.charsetの両方で設定した場合は，プロパティ「charSet」に設定した値が適用されます。どちらにも値が設定されていない場合は，「UTF-8」が設定されます。

注※2

部品のバージョンが02.00.00未満の場合，このプロパティは実装されていませんが，「patternMatch」を指定した場合と同じ動作になります。最新の部品にバージョンアップした場合，このプロパティのデフォルト値に「always」が指定されて動作が変わるので，必要に応じて値を設定し直してください。

注※3

正規表現により抽出されるのは，括弧でグループ化された部分です。

正規表現に複数のグループを指定した場合，最初のグループに該当する範囲だけが部品の出力プロパティに格納されます。

正規表現に複数の範囲が該当する場合，最初に該当する範囲だけが部品の出力プロパティに格納されます。複数の範囲を格納することはできません。

任意のコマンドの実行結果など改行を含む文字列から抽出する場合，改行までの文字列を抽出するには，「(.*)」と指定してください。

プロパティ「stdoutPattern1〜3」および「stdoutProperty1〜3」の使用例

標準出力および標準エラー出力をプロパティ「stdoutPattern1〜3」の値と照合した結果を，プロパティ「stdoutProperty1〜3」にそれぞれ格納できるようになります。次の図に，「stdoutPattern1」に「aaabbb(.*)」を指定した場合のデータの流れを示します。

図4‒4　プロパティ「stdoutPattern」および「stdoutProperty」の使用例

標準出力「aaabbbccc」に対して，「stdoutPattern1」で定義しているように，標準出力の「aaabbb」より後ろの値（ccc）が抽出されます。抽出された値は，プロパティ「stdoutProperty1」に格納されます。

プロパティ「stdoutPattern1〜3」で指定した正規表現が標準出力と合致せず値を抽出できなかった場合に，プロパティ「stdoutProperty1〜3」に値を格納するかどうかは，プロパティ「outputCondition」で指定できます。

関連トピック

4.2.8　ターミナル接続部品

4.2.10　ターミナル切断部品

(1)　ターミナルコマンド実行部品の使用例

標準出力にエラーが出力された場合，ターミナルコマンド実行部品をエラー終了とするときの例

標準出力の内容について，エラーを示す内容を取得し，ターミナルコマンド実行部品をエラー終了したい場合を例に説明します。部品のプロパティに次のような値を設定してください。

プロパティキー

指定値の例

指定値の意味

commandLine

configServer arg0 arg1 arg2

指定したコマンドまたはスクリプトを実行する。

promptPattern

^¥[prompt¥]

標準出力の内容が，「[prompt]」と合致した場合に部品を終了し，戻り値を判定する。

stdoutPattern1

^Message:(.*)

標準出力の内容で，「Message:」より後ろの文字列をプロパティ「stdoutProperty1」に格納する。

stdoutPattern2

^Error:(.*)

標準出力の内容で，「Error:」より後ろの文字列をプロパティ「stdoutProperty2」に格納する。

stdoutPattern3

^ReturnCode:(.*)

標準出力の内容で，「ReturnCode:」より後ろの文字列をプロパティ「stdoutProperty3」に格納する。

defaultReturnCode

0

標準出力の内容が，プロパティ「returnCodePattern」に指定した値と合致しなかった場合に，戻り値0を返す。

returnCodePattern

^Error:

標準出力の内容が，「Error:」と合致した場合，プロパティ「returnCode」で指定した値を返す。

returnCode

1

標準出力の内容が，プロパティ「returnCodePattern」に指定した値と合致した場合に，戻り値1を返す。

このように部品のプロパティを指定している場合，標準出力が次に示す内容だったときの動作について説明します。

標準出力の内容がプロパティ「promptPattern」に指定した値と合致するため，ターミナルコマンド実行部品の戻り値を判定します。このとき，プロパティ「returnCodePattern」に指定した値と合致するため，部品の戻り値は，プロパティ「returnCode」に指定した値（1）になります。

また，プロパティ「stdoutPattern1〜3」で切り出された文字列は，次のとおり，プロパティ「stdoutProperty1〜3」に格納されます。

stdoutProperty1：command failed

stdoutProperty2：Permission Denied

stdoutProperty3：128

HTTPサーバにGetリクエストする場合の例

次のようなリクエストをして，HTTPサーバのレスポンスを確認する場合を例に説明します。

HTTPサーバにGetリクエストする場合，リクエストメソッドとリクエストヘッダーを1行ごとに，ターミナルコマンド実行部品のプロパティ「commandLine」を指定して実行してください。

また，最後に空行を挿入する必要があるため，ターミナルコマンド実行部品を5回実行する必要があります。実行回数ごとにプロパティに設定する値の例を，次の表に示します。

実行回数

commandLineの指定値

lineEndの指定値※1

promptPatternの指定値

1回目

GET /index.html HTTP/1.1

CRLF

.*※2

2回目

Host: ServerA

CRLF

.*※2

3回目

User-Agent: JP1/AO

CRLF

.*※2

4回目

Accept-Charset: UTF-8

CRLF

.*※2

5回目

−

CRLF

</HTML>※3

（凡例）

−：空行を挿入するため，値を指定しない。

注※1

HTTPサーバのリクエストは，[CR]+[LF]を区切り文字とするため，「CRLF」を指定する。

注※2

1回目〜4回目のターミナルコマンド実行部品のプロパティ「promptPattern」には，空文字でも合致するような正規表現パターンを指定する。

注※3

ターミナルコマンド実行部品の実行後は，標準出力が出力されるため，標準出力の末尾を検出するための正規表現パターンをプロパティ「promptPattern」に指定する。

標準出力の内容が次の場合の動作を説明します。

標準出力の内容がプロパティ「promptPattern」に指定した値と合致するため，ターミナルコマンド実行部品の戻り値を判定します。

プロパティ「returnCodePattern」に指定した値と合致する場合は，プロパティ「returnCode」に指定した値が，部品の戻り値として返されます。

プロパティ「returnCodePattern」に指定した値と合致しない場合は，プロパティ「defaultReturnCode」に指定した値が，部品の戻り値として返されます。

4.2.10　ターミナル切断部品

機能

ターミナル接続部品で接続した操作対象の機器との接続を切断できます。

実行時の前提条件

JP1/AOサーバとの通信に使用できるプロトコルは，ターミナル接続部品のプロパティ「protocol」で指定されたプロトコルとなります。詳細については，「4.2.8　ターミナル接続部品」のプロパティ「protocol」の説明を参照してください。

エージェントレス接続先として使用できる操作対象の機器については，「付録A.1(3)　エージェントレス接続先として使用できる操作対象の機器」を参照してください。

注意事項

部品の実行中にタスクを実行停止した場合は，ターミナル切断部品の処理が完了してからタスクの状態が「失敗」または「正常終了」になります。部品の実行が終了したときのステップおよびタスクの状態は，ステップの戻り値および後続ステップ実行条件によって決まります。後続ステップ実行条件は，［ステップ作成］ダイアログボックスまたは［ステップ編集］ダイアログボックスで設定できます。

部品の実行中にタスクを強制停止した場合は，標準出力の読み込みおよびプロンプトの検出処理が中断され，タスクの状態が「失敗」になります。その後，セッションおよびトークンは破棄されます。なお，［タスク］画面の［フロー］エリアに表示されるステップの戻り値は，80になります。タスクログに出力される戻り値は，強制停止したタイミングによって異なります。

バージョン

01.02.01

タグ

Terminal

戻り値

戻り値

説明

0

正常に終了した。すでに切断されていた場合も，正常終了となる。

65

JP1/AOサーバとの接続に失敗した。例えば，部品実行中にJP1/AOサーバが停止された場合が該当する。

66

次のユーザーがJP1ユーザーにマッピングされている。

Administrators グループに所属しないユーザーである。

Administrators グループに所属するビルトイン Administrator以外のユーザーで，UACが有効である。

68

対象のジョブ実行IDに関する情報がない。

69

タスク処理エンジンの環境変数の取得に失敗した。

80

タスクの実行を停止した。

81

部品が不正な状態で呼び出された。

82

タスク処理エンジンからの要求メッセージを正しくパースできない。

83

JP1/AOサーバの環境が壊れている。

84

指定された部品の情報が取得できない。

86

指定したプロパティ値に誤りがある。

入力プロパティのトークンが不正な場合も含まれる。

127

そのほかのエラーが発生した。

プロパティ一覧

プロパティを次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

token

トークン

ターミナル接続部品のプロパティ「token」の値を指定します。

−

入力

○

関連トピック

4.2.8　ターミナル接続部品

4.2.9　ターミナルコマンド実行部品

4.2.11　階層フロー部品

機能

フロー中に別のフローを定義できます。階層フロー部品を使用すると，フローを階層化できます。フローの階層化は，最上位のフローを第1階層として最大25階層まで定義できます。

図4‒5　階層フロー部品の概要

注意事項

部品の実行中にタスクを実行停止した場合は，階層フロー部品内の実行中のステップが完了してからタスクの状態が「失敗」または「正常終了」になります。

部品の実行中にタスクを強制停止した場合は，階層フロー部品内で実行中の部品も直ちに終了され，タスクの状態が「失敗」または「正常終了」になります。

階層フロー内のステップの戻り値は，階層フロー部品の戻り値に反映されません。

バージョン

01.11.00

タグ

Control Flow

戻り値

戻り値

説明

0

階層フロー部品内（一階層配下）のステップが正常に終了した。

1

階層フロー部品内（一階層配下）のステップが警告終了した。異常終了したステップはなし。

2

階層フロー部品内（一階層配下）のステップが異常終了した。

プロパティ一覧

プロパティを次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

errorStep

失敗したステップ

階層フロー部品内（一階層配下）で失敗したステップのステップIDが半角コンマ区切りで出力されます。

−

出力

△

returnValueOfErrorStep

失敗したステップの戻り値

階層フロー部品内（一階層配下）で失敗したステップの戻り値が半角コンマ区切りで出力されます。

−

出力

△

関連トピック

マニュアル「JP1/AO サービステンプレート開発ガイド」−「フローの階層化について」のトピック

4.2.12　実行間隔制御部品

機能

ステップ間の実行間隔を制御できます。

実行間隔にはプロセスの待ち時間を指定します。指定した待ち時間が経過したあとで，後続のステップを実行します。実行間隔制御部品を使用すると，一定間隔でステップを実行できます。

図4‒6　実行間隔制御部品の概要

注意事項

通信の状態などによって，指定した待ち時間と誤差が生じる場合があります。

プロパティの値は，サービス実行時に変更できません。フロー作成時に設定してください。

入力プロパティには，リテラル文字列だけを指定できます。サービスプロパティの値および予約プロパティの値はマッピングができません。

部品の実行中にタスクを実行停止または強制停止した場合は，実行中の処理が直ちに終了され，タスクの状態が「失敗」になります。

バージョン

01.10.01

タグ

Control Flow

戻り値

戻り値

説明

0

正常に終了した。

1以上（80を除く）

異常終了した。hcmds64getlogsコマンドでログ情報を採取してトラブルの内容を確認する。

80

タスクの実行を停止した。

プロパティ一覧

プロパティを次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

interval

待ち時間

次のステップを実行するまでの待ち時間を，1〜1,440（分単位）で指定します。プロセスの待ち時間を指定してください。

10

入力

○

関連トピック

マニュアル「JP1/AO コマンド・APIリファレンス」−「hcmds64getlogs（ログ情報の採取）」のトピック

4.2.13　戻り値判定分岐部品

機能

直前のステップの戻り値を判定して，次に実行するステップを振り分けます。

戻り値判定分岐部品は，「後続するステップ」と「判定条件が一致した場合にだけ実行するステップ」の2つを分岐先として接続します。戻り値が判定条件と一致した場合，「分岐先ステップ」，「後続するステップ」の順番で実行します。戻り値が判定条件と一致しなかった場合，「後続するステップ」だけ実行します。

また，値判定部品と組み合わせて使用することで，文字列を判定してステップを振り分けることができます。

図4‒7　戻り値判定分岐部品の概要

注意事項

部品の実行中にタスクを実行停止または強制停止した場合は，戻り値判定分岐部品の処理が完了してからタスクの状態が「正常終了」になります。

プロパティの値は，サービス実行時に変更できません。フロー作成時に設定してください。

入力プロパティには，リテラル文字列だけを指定できます。サービスプロパティの値および予約プロパティの値はマッピングできません。

戻り値判定分岐部品の処理が停止した場合，hcmds64getlogsコマンドでログ情報を採取してトラブルの内容を確認します。

バージョン

01.10.01

タグ

Control Flow

戻り値

戻り値

説明

0以上

正常に終了した。戻り値判定分岐部品の直前のステップの戻り値が設定される。

プロパティ一覧

プロパティを次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

condition

判定条件

直前のステップの戻り値の判定条件を指定します。判定条件を次から選択します。

ReturnCode=value1

戻り値と判定条件値1が等しい場合に指定します。

ReturnCode!=value1

戻り値と判定条件値1が等しくない場合に指定します。

ReturnCode<value1

戻り値が判定条件値1未満の場合に指定します。

ReturnCode>value1

戻り値が判定条件値1を超える場合に指定します。

ReturnCode<=value1

戻り値が判定条件値1以下の場合に指定します。

ReturnCode>=value1

戻り値が判定条件値1以上の場合に指定します。

ReturnCode>value1 AND ReturnCode<value2

戻り値が判定条件値1を超える，かつ戻り値が判定条件値2未満の場合に指定します。

ReturnCode>=value1 AND ReturnCode<value2

戻り値が判定条件値1以上，かつ戻り値が判定条件値2未満の場合に指定します。

ReturnCode>value1 AND ReturnCode<=value2

戻り値が判定条件値1を超える，かつ戻り値が判定条件値2以下の場合に指定します。

ReturnCode>=value1 AND ReturnCode<=value2

戻り値が判定条件値1以上，かつ戻り値が判定条件値2以下の場合に指定します。

ReturnCode<value1 OR ReturnCode>value2

戻り値が判定条件値1未満，または戻り値が判定条件値2を超える場合に指定します。

ReturnCode<=value1 OR ReturnCode>value2

戻り値が判定条件値1以下，または戻り値が判定条件値2を超える場合に指定します。

ReturnCode<value1 OR ReturnCode>=value2

戻り値が判定条件値1未満，または戻り値が判定条件値2以上の場合に指定します。

ReturnCode<=value1 OR ReturnCode>=value2

戻り値が判定条件値1以下，または戻り値が判定条件値2以上の場合に指定します。

ReturnCode=value1

入力

○

value1

判定条件値1

戻り値を判定する数値を，0〜999の範囲で指定します。

プロパティ「condition」で指定する「value1」とマッピングします。

0

入力

○

value2

判定条件値2

戻り値を判定する数値を，0〜999の範囲で指定します。

プロパティ「condition」で指定する「value2」とマッピングします。プロパティ「condition」で「value2」が含まれる場合に有効となります。

0

入力

△

プロパティの指定例

戻り値判定分岐部品は，戻り値が，指定した判定条件値の範囲内かどうかを判定します。

プロパティ「condition」，「value1」，「value2」に次のとおり値を指定した場合を例に，判定条件値の範囲について説明します。

A.戻り値が25以上，かつ75未満を指定する場合

condition（判定条件）：ReturnCode>=value1 AND ReturnCode<value2

value1（判定条件値1）：25

value2（判定条件値2）：75

B.戻り値が25未満，または75以上を指定する場合

condition（判定条件）：ReturnCode<value1 OR ReturnCode>=value2

value1（判定条件値1）：25

value2（判定条件値2）：75

戻り値と判定条件値の範囲について，次の図に示します。

図4‒8　戻り値と判定条件値の範囲

関連トピック

マニュアル「JP1/AO コマンド・APIリファレンス」−「hcmds64getlogs（ログ情報の採取）」のトピック

マニュアル「JP1/AO サービステンプレート開発ガイド」−「処理が分岐する部品を使用する場合の関連線接続」のトピック

4.2.14　値判定部品

機能

サービスプロパティの値，予約プロパティの値，リテラル文字列，またはこれらを組み合わせた文字列と，指定した条件値を比較します。比較した結果が一致した場合，戻り値を0で返します。

また，戻り値判定分岐部品と組み合わせて使用することで，サービスプロパティの値などを判定してステップを振り分けることができます。

図4‒9　値判定部品の概要

注意事項

部品の実行中にタスクを実行停止した場合は，値判定部品の処理が完了してからタスクの状態が「正常終了」になります。

部品の実行中にタスクを強制停止した場合は，実行中の処理が直ちに終了され，タスクの状態が「失敗」になります。なお，［タスク］画面の［フロー］エリアに表示されるステップの戻り値は，80になります。タスクログに出力される戻り値は，強制停止したタイミングによって異なります。

バージョン

01.10.01

タグ

Test Value Plug-in

戻り値

戻り値

説明

0

判定条件と一致した。

または，プロパティ「defaultReturnCode」で0を指定した。※

1

判定条件と一致しなかった。

または，プロパティ「defaultReturnCode」で1を指定した。※

63

判定に失敗した。

プロパティ「defaultReturnCode」で63を指定した。※

65

JP1/AOサーバとの接続に失敗した。例えば，部品実行中にJP1/AOサーバが停止された場合が該当する。

66

次のユーザーがJP1ユーザーにマッピングされている。

Administrators グループに所属しないユーザーである。

Administrators グループに所属するビルトイン Administrator以外のユーザーで，UACが有効である。

68

対象のジョブ実行IDに関する情報がない。

69

タスク処理エンジンの環境変数の取得に失敗した。

80

タスクの実行を停止した。

81

部品が不正な状態で呼び出された。

82

タスク処理エンジンからの要求メッセージを正しくパースできない。

83

JP1/AOサーバの環境が壊れている。

84

指定された部品の情報が取得できない。

86

指定したプロパティ値に誤りがある。

127

そのほかのエラーが発生した。

注※

プロパティ「condition」で数値比較が指定された場合で，プロパティ「valueX」，「value1」,または「value2」のどれかで数値変換できない値が指定された場合に，プロパティ「defaultReturnCode」に指定した値を戻り値として返します。

プロパティ一覧

プロパティを次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

condition

判定条件

プロパティ「valueX」の判定条件を指定します。判定条件を次から選択します。

valueX=value1

入力値と判定条件値1が等しい場合に指定します。（数値比較）

valueX!=value1

入力値と判定条件値1が等しくない場合に指定します。（数値比較）

valueX<value1

入力値が判定条件値1未満の場合に指定します。（数値比較）

valueX>value1

入力値が判定条件値1を超える場合に指定します。（数値比較）

valueX<=value1

入力値が判定条件値1以下の場合に指定します。（数値比較）

valueX>=value1

入力値が判定条件値1以上の場合に指定します。（数値比較）

valueX>value1 AND valueX<value2

入力値が判定条件値1を超える，かつ入力値が判定条件値2未満の場合に指定します。（数値比較）

valueX>=value1 AND valueX<value2

入力値が判定条件値1以上，かつ入力値が判定条件値2未満の場合に指定します。（数値比較）

valueX>value1 AND valueX<=value2

入力値が判定条件値1を超える，かつ入力値が判定条件値2以下の場合に指定します。（数値比較）

valueX>=value1 AND valueX<=value2

入力値が判定条件値1以上，かつ入力値が判定条件値2以下の場合に指定します。（数値比較）

valueX<value1 OR valueX>value2

入力値が判定条件値1より小さい，または入力値が判定条件値2より大きい条件の場合に指定します。（数値比較）

valueX<=value1 OR valueX>value2

入力値が判定条件値1以下，または入力値が判定条件値2より大きい条件の場合に指定します。（数値比較）

valueX<value1 OR valueX>=value2

入力値が判定条件値1より小さい，または入力値が判定条件値2以上の場合に指定します。（数値比較）

valueX<=value1 OR valueX>=value2

入力値が判定条件値1以下，または入力値が判定条件値2以上の場合に指定します。（数値比較）

valueX equals value1

入力値と判定条件値1が等しい場合に指定します。大文字と小文字は区別されます。（文字列比較）

valueX not equals value1

入力値と判定条件値1が等しくない場合に指定します。大文字と小文字は区別されます。（文字列比較）

valueX contains value1

入力値が判定条件値1を含む場合に指定します。大文字と小文字は区別されます。（文字列比較）

valueX not contains value1

入力値が判定条件値1を含まない場合に指定します。大文字と小文字は区別されます。（文字列比較）

valueX=value1

入力

○

valueX

入力値

判定する対象の値を1,024文字以内で指定します。次の形式で指定できます。また，これらを組み合わせることも可能です。

?dna_サービスプロパティのプロパティキー?（サービスプロパティに入力された値を参照する場合）

?dna_予約プロパティのプロパティキー?（予約プロパティに入力された値を参照する場合）

リテラル文字列

−

入力

○

value1

判定条件値1

プロパティ「valueX」を判定する値を1,024文字以内で指定します。次の形式で指定できます。また，これらを組み合わせることも可能です。

?dna_サービスプロパティのプロパティキー?（サービスプロパティに入力された値を参照する場合）

?dna_予約プロパティのプロパティキー?（予約プロパティに入力された値を参照する場合）

リテラル文字列

プロパティ「condition」で指定する「value1」とマッピングします。

−

入力

△

value2

判定条件値2

プロパティ「valueX」を判定する値を1,024文字以内で指定します。次の形式で指定できます。また，これらを組み合わせることも可能です。

?dna_サービスプロパティのプロパティキー?（サービスプロパティに入力された値を参照する場合）

?dna_予約プロパティのプロパティキー?（予約プロパティに入力された値を参照する場合）

リテラル文字列

プロパティ「condition」で指定する「value2」とマッピングします。プロパティ「condition」で「value2」が含まれる場合に有効となります。

−

入力

△

defaultReturnCode

判定失敗時の戻り値

プロパティ「condition」で数値比較が指定された場合で，プロパティ「valueX」，「value1」,または「value2」のどれかで数値変換できない値が指定された場合に，部品の戻り値として返される値を指定します。

0

判定結果を「判定条件と一致した。」とする場合に指定します。

1

判定結果を「判定条件と一致しなかった。」とする場合に指定します。

63

判定結果を判定失敗として，ステップを異常終了させる場合に指定します。

63

入力

○

プロパティの指定例

値判定部品は，入力値が，指定した判定条件値の範囲内かどうかを判定します。

プロパティ「condition」，「value1」，「value2」に次のとおり値を指定した場合を例に，判定条件値の範囲について説明します。

A.入力値が25以上，かつ75未満を指定する場合

condition（判定条件）：ReturnCode>=value1 AND ReturnCode<value2

value1（判定条件値1）：25

value2（判定条件値2）：75

B.入力値が25未満，または75以上を指定する場合

condition（判定条件）：ReturnCode<value1 OR ReturnCode>=value2

value1（判定条件値1）：25

value2（判定条件値2）：75

入力値と判定条件値の範囲について，次の図に示します。

図4‒10　入力値と判定条件値の範囲

関連トピック

4.2.13　戻り値判定分岐部品

4.2.15　異常終了部品

機能

実行中のタスクを異常終了させます。

また，戻り値判定分岐部品と組み合わせて使用することで，判定条件が一致した場合にフローを異常終了させることができます。

図4‒11　異常終了部品の使用例

注意事項

部品の実行中にタスクを実行停止した場合は，異常終了部品の処理が完了してからタスクの状態が「異常終了」になります。

部品の実行中にタスクを強制停止した場合は，実行中の処理が直ちに終了され，タスクの状態が「失敗」になります。なお，［タスク］画面の［フロー］エリアに表示されるステップの戻り値は，80になります。

階層フロー部品内で異常終了部品を使用した場合，階層化されたフローおよび，階層フロー部品を持つ上位フローも異常終了となります。また，実行中のタスクは異常終了し，階層フロー部品の戻り値は0になります。

繰り返し実行部品内で異常終了部品を使用した場合，1度でも繰り返し処理が異常終了した場合は，繰り返し実行部品の戻り値は1になります。なお，すべての繰り返し処理が異常終了した場合は，繰り返し実行部品の戻り値は2になります。

バージョン

01.10.01

タグ

Control Flow

戻り値

戻り値

説明

0

正常に終了した。（ステップが異常終了された。）

80

タスクの実行を停止した。

関連トピック

4.2.4　繰り返し実行部品

4.2.11　階層フロー部品

4.2.13　戻り値判定分岐部品

4.2.16　値判定分岐部品

機能

サービスプロパティの値，予約プロパティの値，リテラル文字列，またはこれらを組み合わせた文字列と，指定した条件値を比較します。比較した結果を判定して，次に実行するステップを振り分けます。

値判定分岐部品は，「後続するステップ」と「判定条件が一致した場合にだけ実行するステップ」の2つを分岐先として接続します。入力値が判定条件と一致した場合，「分岐先ステップ」，「後続するステップ」の順番で実行します。入力値が判定条件と一致しなかった場合，「後続するステップ」だけ実行します。

値判定分岐部品は，値判定部品と戻り値判定分岐部品を統合した部品です。

図4‒12　値判定分岐部品の概要

注意事項

この部品を実行すると，値判定部品を実行したタスクログが出力されます。値判定分岐部品としてタスクログは出力されません。

部品の実行中にタスクを実行停止した場合は，値判定分岐部品の処理が完了してからタスクの状態が「正常終了」になります。

部品の実行中にタスクを強制停止した場合は，値判定部品と戻り値判定分岐部品の実行状態でタスクの状態，戻り値およびステップの状態が異なります。

値判定部品の実行が完了していない場合

実行中の処理が終了します。値判定部品の処理完了を待ちません。タスクの状態が「失敗」になります。なお，［タスク］画面の［フロー］エリアに表示される戻り値は，80になります。タスクログに出力される戻り値は，強制停止したタイミングにより異なります。

値判定部品の実行が完了したあとで，戻り値判定分岐部品の実行が完了していない場合

戻り値判定分岐部品の処理が完了してからタスクの状態が「正常終了」になります。ただし，［タスク］画面の［フロー］エリアに表示される戻り値およびステップの状態は，値判定部品を実行したときの戻り値およびステップの状態が表示されます。

バージョン

01.10.01

タグ

Control Flow

戻り値

戻り値

説明

0

次のどちらかの場合，戻り値を0で返す。

判定結果が真の場合。

プロパティ「condition」で数値比較を指定したが，プロパティ「valueX」，「value1」および「value2」のどれかのプロパティに対して，数値に変換できない値が指定され，プロパティ「defaultReturnCode」に指定した値が0の場合。

1

次のどちらかの場合，戻り値を1で返す。

判定結果が偽の場合。

プロパティ「condition」で数値比較を指定したが，プロパティ「valueX」，「value1」および「value2」のどれかのプロパティに対して，数値に変換できない値が指定され，プロパティ「defaultReturnCode」に指定した値が1の場合。

プロパティ一覧

プロパティを次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

condition

判定条件

プロパティ「valueX」の判定条件を指定します。判定条件を次から選択します。

valueX=value1

入力値と判定条件値1が等しい場合に指定します。（数値比較）

valueX!=value1

入力値と判定条件値1が等しくない場合に指定します。（数値比較）

valueX<value1

入力値が判定条件値1未満の場合に指定します。（数値比較）

valueX>value1

入力値が判定条件値1を超える場合に指定します。（数値比較）

valueX<=value1

入力値が判定条件値1以下の場合に指定します。（数値比較）

valueX>=value1

入力値が判定条件値1以上の場合に指定します。（数値比較）

valueX>value1 AND valueX<value2

入力値が判定条件値1を超える，かつ入力値が判定条件値2未満の場合に指定します。（数値比較）

valueX>=value1 AND valueX<value2

入力値が判定条件値1以上，かつ入力値が判定条件値2未満の場合に指定します。（数値比較）

valueX>value1 AND valueX<=value2

入力値が判定条件値1を超える，かつ入力値が判定条件値2以下の場合に指定します。（数値比較）

valueX>=value1 AND valueX<=value2

入力値が判定条件値1以上，かつ入力値が判定条件値2以下の場合に指定します。（数値比較）

valueX<value1 OR valueX>value2

入力値が判定条件値1より小さい，または入力値が判定条件値2より大きい条件の場合に指定します。（数値比較）

valueX<=value1 OR valueX>value2

入力値が判定条件値1以下，または入力値が判定条件値2より大きい条件の場合に指定します。（数値比較）

valueX<value1 OR valueX>=value2

入力値が判定条件値1より小さい，または入力値が判定条件値2以上の場合に指定します。（数値比較）

valueX<=value1 OR valueX>=value2

入力値が判定条件値1以下，または入力値が判定条件値2以上の場合に指定します。（数値比較）

valueX equals value1

入力値と判定条件値1が等しい場合に指定します。大文字と小文字は区別されます。（文字列比較）

valueX not equals value1

入力値と判定条件値1が等しくない場合に指定します。大文字と小文字は区別されます。（文字列比較）

valueX contains value1

入力値が判定条件値1を含む場合に指定します。大文字と小文字は区別されます。（文字列比較）

valueX not contains value1

入力値が判定条件値1を含まない場合に指定します。大文字と小文字は区別されます。（文字列比較）

valueX=value1

入力

○

valueX

入力値

判定する対象の値を1,024文字以内で指定します。次の形式で指定できます。また，これらを組み合わせることも可能です。

?dna_サービスプロパティのプロパティキー?（サービスプロパティに入力された値を参照する場合）

?dna_予約プロパティのプロパティキー?（予約プロパティに入力された値を参照する場合）

リテラル文字列

−

入力

○

value1

判定条件値1

プロパティ「valueX」を判定する値を1,024文字以内で指定します。次の形式で指定できます。また，これらを組み合わせることも可能です。

?dna_サービスプロパティのプロパティキー?（サービスプロパティに入力された値を参照する場合）

?dna_予約プロパティのプロパティキー?（予約プロパティに入力された値を参照する場合）

リテラル文字列

プロパティ「condition」で指定する「value1」とマッピングします。

−

入力

△

value2

判定条件値2

プロパティ「valueX」を判定する値を1,024文字以内で指定します。次の形式で指定できます。また，これらを組み合わせることも可能です。

?dna_サービスプロパティのプロパティキー?（サービスプロパティに入力された値を参照する場合）

?dna_予約プロパティのプロパティキー?（予約プロパティに入力された値を参照する場合）

リテラル文字列

プロパティ「condition」で指定する「value2」とマッピングします。プロパティ「condition」で「value2」が含まれる場合に有効となります。

−

入力

△

defaultReturnCode

判定失敗時の戻り値

プロパティ「condition」で数値比較が指定された場合で，プロパティ「valueX」，「value1」,または「value2」のどれかで数値変換できない値が指定された場合に，部品の戻り値として返される値を指定します。

0

判定結果を「判定条件と一致した。」とする場合に指定します。

1

判定結果を「判定条件と一致しなかった。」とする場合に指定します。

63

判定結果を判定失敗として，ステップを異常終了させる場合に指定します。

「分岐先ステップ」，「後続するステップ」のどちらのステップも実行しないで異常終了します。

63

入力

○

関連トピック

4.2.13　戻り値判定分岐部品

4.2.14　値判定部品

4.2.17　JavaScript実行部品

機能

JSON形式の文字列を変換するためのJavaScriptコードを実行できます。指定したJavaScriptコードでは，サービスプロパティと部品プロパティの値を参照できます。また，「underscore.js 1.8.3」の関数が使用できます。

なお，JavaScriptコードで「print関数」を使用すると，JavaScriptコード内の任意の文字列をタスクログに出力できます。このとき，次の接頭語を付加することで，ログレベルを指定できます。例えば，「print("[Debug]xxxx")」のように指定します。接頭語の大文字と小文字は区別します。

[Severe]

print関数で指定した文字列は，ログレベルが0以上のときに出力されます。

[Information]

print関数で指定した文字列は，ログレベルが10以上のときに出力されます。

[Fine]

print関数で指定した文字列は，ログレベルが20以上のときに出力されます。

[Finer]

print関数で指定した文字列は，ログレベルが30以上のときに出力されます。

[Debug]

print関数で指定した文字列は，ログレベルが40のときに出力されます。

指定なし

print関数で指定した文字列は，ログレベルが10以上のときに出力されます。

注意事項

スクリプトはUTF-8で指定してください。また，無名関数を指定してください。

スクリプト内で例外をスローした場合，または例外が発生した場合は，部品は異常終了となります。また，例外が発生した場合，ログレベルが30以上のときは，スタックトレースがタスクログに出力されます。

スクリプトが正常終了し，次の値に「null」や「undefined」が含まれていた場合，「null」や「undefined」が文字列として出力プロパティに格納されます。

スクリプトからリターンされた値

スクリプト内で部品の出力プロパティに設定した値

部品の実行中にタスクを実行停止した場合は，JavaScript実行部品の処理が完了してからタスクの状態が「失敗」または「正常終了」になります。部品の実行が終了したときのステップおよびタスクの状態は，ステップの戻り値および後続ステップ実行条件によって決まります。後続ステップ実行条件は，［ステップ作成］ダイアログボックスまたは［ステップ編集］ダイアログボックスで設定できます。

部品の実行中にタスクを強制停止した場合は，実行中の処理が直ちに終了され，タスクの状態が「失敗」になります。なお，［タスク］画面の［フロー］エリアに表示されるステップの戻り値は，80になります。タスクログに出力される戻り値は，強制停止したタイミングによって異なります。

バージョン

01.00.03

タグ

Execute Script

戻り値

戻り値

説明

0

正常に終了した。

1

JavaScriptコードが，出力プロパティ「notify」に空文字以外を指定して終了した。

60

JavaScriptライブラリの読み込みに失敗した。

61

JavaScriptコードのコンパイルに失敗した。

62

JavaScriptコードが関数型ではない。

63

内部エラーが発生した。

80

タスクの実行を停止した。

プロパティ一覧

プロパティを次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

scriptBody

スクリプト本体

JavaScriptコードを指定します。

−

入力

○

importedScript

インポートスクリプト

同一サービステンプレート上に配置したほかのJavaScript実行部品と共通で使用するメソッドや定数（JavaScriptのコード文字列）を指定します。

−

入力

△

arg0

スクリプト引数(0)

JavaScriptコードに渡す引数を指定します。JavaScriptコードに「arg0」を指定すると，プロパティに指定した値が代入されます。

−

入力

△

arg1

スクリプト引数(1)

JavaScriptコードに渡す引数を指定します。JavaScriptコードに「arg1」を指定すると，プロパティに指定した値が代入されます。

−

入力

△

arg2

スクリプト引数(2)

JavaScriptコードに渡す引数を指定します。JavaScriptコードに「arg2」を指定すると，プロパティに指定した値が代入されます。

−

入力

△

arg3

スクリプト引数(3)

JavaScriptコードに渡す引数を指定します。JavaScriptコードに「arg3」を指定すると，プロパティに指定した値が代入されます。

−

入力

△

arg4

スクリプト引数(4)

JavaScriptコードに渡す引数を指定します。JavaScriptコードに「arg4」を指定すると，プロパティに指定した値が代入されます。

−

入力

△

arg5

スクリプト引数(5)

JavaScriptコードに渡す引数を指定します。JavaScriptコードに「arg5」を指定すると，プロパティに指定した値が代入されます。

−

入力

△

arg6

スクリプト引数(6)

JavaScriptコードに渡す引数を指定します。JavaScriptコードに「arg6」を指定すると，プロパティに指定した値が代入されます。

−

入力

△

arg7

スクリプト引数(7)

JavaScriptコードに渡す引数を指定します。JavaScriptコードに「arg7」を指定すると，プロパティに指定した値が代入されます。

−

入力

△

arg8

スクリプト引数(8)

JavaScriptコードに渡す引数を指定します。JavaScriptコードに「arg8」を指定すると，プロパティに指定した値が代入されます。

−

入力

△

arg9

スクリプト引数(9)

JavaScriptコードに渡す引数を指定します。JavaScriptコードに「arg9」を指定すると，プロパティに指定した値が代入されます。

−

入力

△

notify

通知フラグ

指定したJavaScriptコードで異常を検知した場合，部品を異常終了させたいときは空文字以外を指定します。

スクリプトの実行後にこの値が空文字以外であれば，部品の戻り値に1を返却します。

−

出力

△

returnValue

スクリプト戻り値

指定したスクリプトの関数内で，返却されたオブジェクトの内容が出力されます。

−

出力

△

out0

スクリプト出力(0)

指定したスクリプト内で，第2引数のMapに「out0」として設定された値が出力されます。

−

出力

△

out1

スクリプト出力(1)

指定したスクリプト内で，第2引数のMapに「out1」として設定された値が出力されます。

−

出力

△

out2

スクリプト出力(2)

指定したスクリプト内で，第2引数のMapに「out2」として設定された値が出力されます。

−

出力

△

out3

スクリプト出力(3)

指定したスクリプト内で，第2引数のMapに「out3」として設定された値が出力されます。

−

出力

△

out4

スクリプト出力(4)

指定したスクリプト内で，第2引数のMapに「out4」として設定された値が出力されます。

−

出力

△

out5

スクリプト出力(5)

指定したスクリプト内で，第2引数のMapに「out5」として設定された値が出力されます。

−

出力

△

out6

スクリプト出力(6)

指定したスクリプト内で，第2引数のMapに「out6」として設定された値が出力されます。

−

出力

△

out7

スクリプト出力(7)

指定したスクリプト内で，第2引数のMapに「out7」として設定された値が出力されます。

−

出力

△

out8

スクリプト出力(8)

指定したスクリプト内で，第2引数のMapに「out8」として設定された値が出力されます。

−

出力

△

out9

スクリプト出力(9)

指定したスクリプト内で，第2引数のMapに「out9」として設定された値が出力されます。

−

出力

△

スクリプト本体で指定できるJavaScriptコードの引数

JavaScriptコードとして次の引数を指定できます。

serviceProperties（object型）

サービスの入力プロパティの値をマッピングできます。なお，スクリプトがこの引数の値を変更しても，サービスプロパティには反映されません。

pluginProperties（object型）

JavaScript実行部品のプロパティの値をマッピングできます。

arg0〜arg9

部品プロパティに指定した値がマッピングされます。このとき，オブジェクトではなく文字列として取得されます。

notify

スクリプト内でこのメンバに空文字以外の値を設定すると，部品は戻り値1を返却します。

out0〜out9

スクリプト内でこのメンバに値を設定すると，部品プロパティ「out0」〜「out9」に値が反映されます。

arg0〜arg9

部品プロパティ「arg0」〜「arg9」に指定した値がマッピングされます。このとき，JSON型の文字列を指定すると，オブジェクトとして取得されます。

引数は，「serviceProperties（object型）」，「pluginProperties（object型）」，「arg0〜arg9」の順で指定してください。

JavaScriptコードのサンプル

(function(serviceProperties, pluginProperties, arg0, arg1, arg2) {
    var obj = new Object();
    print("[Debug] Function begin.");

    obj.mem1 = arg0;
    obj.mem2 = arg1;

    if (arg2 == "") {
        pluginProperties["notify"] = 999;
        pluginProperties["out1"] = "NOTE!: The arg2 is EMPTY.";
    } else {
        obj.mem3 = arg2;
        obj.status = "success";
        pluginProperties["out1"] = "Finished successfully.";
    }

    print("[Debug] Function end.");

    return obj;
})

インポートスクリプトについて

同一サービステンプレート上に配置したほかのJavaScript実行部品と共通で使用したいメソッドや定数がある場合，プロパティ「importedScript」に定義します。

プロパティ「importedScript」をサービス入力プロパティにマッピングし，ほかのJavaScript実行部品のプロパティ「importedScript」を同じサービス入力プロパティにマッピングすることにより，インポートスクリプトに定義したメソッドや定数を各JavaScript実行部品のスクリプト本体で共通に使用することができます。

スクリプト本体からの参照

インポートスクリプトに定義したメソッドや定数は，スクリプト本体でメソッドや定数を直接呼び出すことで利用できます。

インポートスクリプト内で利用可能な関数

スクリプト本体で利用可能な関数がインポートスクリプトでも利用可能です。

インポートスクリプトのサンプル

スクリプト本体

function fn(serviceProperties, pluginProperties, arg0, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9) {

    hoge(CNST);

}

インポートスクリプト

var CNST = "hoge";

function hoge(a){
    print(a + " from common js!");

}

4.2.18　ファイルエクスポート部品

機能

指定した値を任意の形式で，ファイルに出力できます。

指定した値のフォーマット処理には，Apache Velocity Engineが使用されます。

注意事項

部品の実行中にタスクを実行停止した場合は，ファイルエクスポート部品の処理が完了してからタスクの状態が「失敗」または「正常終了」になります。部品の実行が終了したときのステップおよびタスクの状態は，ステップの戻り値および後続ステップ実行条件によって決まります。後続ステップ実行条件は，［ステップ作成］ダイアログボックスまたは［ステップ編集］ダイアログボックスで設定できます。

部品の実行中にタスクを強制停止した場合は，実行中の処理が直ちに終了され，タスクの状態が「失敗」になります。なお，［タスク］画面の［フロー］エリアに表示されるステップの戻り値は，80になります。タスクログに出力される戻り値は，強制停止したタイミングによって異なります。

バージョン

01.00.00

タグ

File Operations

戻り値

戻り値

説明

0

正常に終了した。

1

出力先ファイルパスに指定された値のパス長が最大値を超えている。

2

VTL（Velocity Template Language）記述に文法エラーがあった。

3

内部エラーが発生した。

4

内部エラーが発生した。

5

出力ファイルへの書き込み中にエラーが発生した。

63

内部エラーが発生した。

80

タスクの実行を停止した。

プロパティ一覧

プロパティを次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

content

エクスポートコンテンツ

ファイルに出力する内容の基となる文字列を指定します。

−

入力

○

fileName※1

出力ファイル名

出力ファイル名を指定します。

−

入力

○

directoryPath※1

出力先ディレクトリパス

出力ファイルの格納先フォルダを，絶対パスまたは相対パスで指定します。

指定を省略した場合は，次のフォルダが設定されます。また，相対パスを指定した場合は，このフォルダが起点となります。

OSがWindowsの場合

JP1/AOのインストール先フォルダ¥data¥task¥タスクID

クラスタ環境の場合，「JP1/AO のインストール先フォルダ」を「共有フォルダ名¥jp1ao」に置き換えてください。

OSがLinuxの場合

/var/opt/jp1ao/data/task/タスクID

クラスタ環境の場合，「/var/opt/jp1ao」を「共有フォルダ名/jp1ao」に置き換えてください。

−

入力

△

template

出力用テンプレート

値の出力形式を指定します。値の出力形式は，VTLで指定してください。指定を省略した場合は，入力値がそのまま出力されます。

−

入力

△

charset

文字セット

出力されるファイルの文字セットを指定します。指定できる文字セットを次に示します。大文字と小文字は区別しません。

EUC-JP

eucjp

ibm-943C

ISO-8859-1

MS932

PCK

Shift_JIS

UTF-8

windows-31j

−

入力

△

exportFilePath

出力ファイルパス

出力ファイルのフルパスが出力されます。

−

出力

△

Message

メッセージ

部品の実行中に発生したエラーメッセージが出力されます。

−

出力

△

注※1

プロパティ「fileName」および「directoryPath」に指定した値は，合計で256文字以内で指定してください。これを超えた場合はエラーになります。

同じ名称のファイルがある場合，上書き保存されます。

同じ名称のフォルダがある場合はエラーになります。このとき，戻り値5が返却されます。

プロパティ「template」に指定できる予約変数

プロパティ「template」は，VTLに準拠して指定してください。ファイルエクスポート部品では，このときに使用できる予約済み変数を提供しています。

$root

プロパティ「content」に指定した文字列がJSON形式の場合，JSONデコードしたオブジェクトとして出力されます。また，プロパティ「content」に指定した文字列がJSON形式でない場合は，文字列として出力されます。

$csv.value(String)

単一の文字列を引数に指定すると，指定した文字列がCSV形式の1セルに相当する形式で出力されます。例えば，文字列中にCSVでエスケープが必要な文字が含まれる場合，値は「"」で囲まれます。また，文字列中に「"」が含まれる場合は，エスケープされます。

$csv.values(String…)

複数の文字列を引数に指定すると，CSV形式の1行に相当する形式で出力されます。

$csv.values(Collection<String>)

配列の文字列を引数に指定すると，CSV形式の1行に相当する形式で出力されます。

プロパティ「content」およびプロパティ「template」の指定例

プロパティ「content」にJSON形式でない文字列を指定し，プロパティ「template」の指定を省略した場合

「content」の値

「template」の値

出力される内容

Hello!

指定なし

Hello!

プロパティ「content」にJSON形式の文字列を指定し，プロパティ「template」の指定を省略した場合

「content」の値

「template」の値

出力される内容

{
    "task": "Daily batch",
    "result": "success"
}

指定なし

{
    "task": "Daily batch",
    "result": "success"
}

プロパティ「content」にJSON形式でない文字列を指定し，プロパティ「template」に予約変数「$root」を指定した場合

「content」の値

「template」の値

出力される内容

success

The result is $root!

The result is success!

プロパティ「content」にJSON形式（オブジェクト）を指定し，プロパティ「template」に予約変数「$root」を指定した場合

「content」の値

「template」の値

出力される内容

{
    "task": "Daily batch",
    "result": "success"
}

The result of
$root["task"]
was
$root["result"]!

The result of
Daily batch
was
success!

プロパティ「content」にJSON形式（配列）を指定し，プロパティ「template」に予約変数「$root」を指定した場合

「content」の値

「template」の値

出力される内容

[
    "success",
    "fail",
    "success"
]

The results are
#foreach ($result in $root)
$result
#end

The results are
success
fail
success

プロパティ「content」にJSON形式を指定し，プロパティ「template」に予約変数「$csv.values(String…) 」を指定した場合

「content」の値

「template」の値

出力される内容

[
    {
        "task": "Daily batch",
        "result": "success"
    },
    {
        "task": "Weekly batch",
        "result": "fail"
    }
]

$csv.values("task", "result")
#foreach($row in $root)
$csv.values($row["task"], $row["result"])
#end

task,result
Daily batch,success
Weekly batch,fail

プロパティ「content」にJSON形式を指定し，プロパティ「template」に予約変数「$csv.values(Collection<String>) 」を指定した場合

「content」の値

「template」の値

出力される内容

[
    ["task", "result"],
    ["Daily batch", "success"],
    ["Weekly batch", "fail"]
]

#foreach($row in $root)
$csv.values($row)
#end

task,result
Daily batch,success
Weekly batch,fail

プロパティ「content」にCSVでエスケープが必要な文字（「"」，「,」）が含まれ，プロパティ「template」に予約変数「$csv.values(Collection<String>) 」を指定した場合

「content」の値

「template」の値

出力される内容

[
    "normal",
    "¥"quoted¥"",
    "Hello, World",
    "double ¥" quote"
]

$csv.values($root)

normal,"""quoted""", "Hello, World","double "" quote"

プロパティ「content」にCSVでエスケープが必要な文字（改行）が含まれ，プロパティ「template」に予約変数「$csv.values(Collection<String>) 」を指定した場合

「content」の値

「template」の値

出力される内容

line1
line2
line3

$csv.value($root)

"line1
line2
line3"

4.2.19　Webクライアント部品

機能

部品の入力プロパティからHTTPリクエストメッセージを生成し，送信します。また，受信したHTTPレスポンスメッセージを出力プロパティとして出力します。

定義済みのWebサービス接続先の設定項目を入力値として参照することもできます。

プロトコルバージョンはHTTP/1.1またはHTTPS/1.1です。

また，HTTPSでサポートしているTLSバージョンはTLSv1.2です。

HTTPメッセージの要素と部品プロパティの対応を次に示します。

表4‒9　HTTPリクエストメッセージに対応する入力プロパティ

メッセージの要素

入力プロパティ

リクエスト行

メソッド

requestMethod

URI

requestUrl

HTTP/バージョン

−

ヘッダー

requestHeaders

ボディー

requestBody

（凡例）

−：HTTP/1.1またはHTTPS/1.1で固定のため，対応するプロパティはありません。

なお，Webクライアント部品は，入力プロパティに指定された値を変換しません。そのため，入力プロパティには，変換が不要な形式で値を指定してください。

表4‒10　HTTPレスポンスメッセージに対応する出力プロパティ

メッセージの要素

出力プロパティ

ステータス行

HTTP/バージョン

−

ステータスコード

responseStatusCode

ステータスメッセージ

responseStatusMessage

ヘッダー

responseHeaders

ボディー

responseBody※

（凡例）

−：HTTP/1.1またはHTTPS/1.1で固定のため，対応するプロパティはありません。

注※

出力されるボディーのサイズは，30MB以下になるようにしてください。30MBを超える場合，超えた分の値が切り捨てられます。

注意事項

部品の実行中にタスクを実行停止した場合は，Webクライアント部品の処理が完了してからタスクの状態が「失敗」または「正常終了」になります。部品の実行が終了したときのステップおよびタスクの状態は，ステップの戻り値および後続ステップ実行条件によって決まります。後続ステップ実行条件は，［ステップ作成］ダイアログボックスまたは［ステップ編集］ダイアログボックスで設定できます。

部品の実行中にタスクを強制停止した場合は，実行中の処理が直ちに終了され，タスクの状態が「失敗」になります。なお，［タスク］画面の［フロー］エリアに表示されるステップの戻り値は，80になります。タスクログに出力される戻り値は，強制停止したタイミングによって異なります。

バージョン

01.01.00

タグ

HTTP

戻り値

戻り値

説明

0

正常に終了した。

1

HTTPレスポンスメッセージのステータスコードとして，200番台（成功）以外が返却された。

70

Webサーバまたはプロキシサーバとの接続に失敗した。

77

Webサーバまたはプロキシサーバのホスト名解決に失敗した。

80

タスクの実行を停止した。

86

指定したプロパティ値に誤りがあるか，Webサービス接続先定義の設定値が見つからなかった。

90

接続後のデータ転送に失敗した。

91

HTTPレスポンスメッセージのボディーのサイズが30MBを超えている。

127

そのほかのエラーが発生した。

プロパティ一覧

プロパティを次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

webServiceConnectionCategory

Webサービス接続カテゴリ

Webサービス接続定義の設定項目を入力値として参照する場合に指定します。

Webサービス接続定義のカテゴリを指定します。

このプロパティを指定する場合は，プロパティ「webServiceConnectionName」も必ず指定してください。

−

入力

△

webServiceConnectionName

Webサービス接続名

Webサービス接続定義の設定項目を入力値として参照する場合に指定します。

Webサービス接続の接続先名を指定します。

このプロパティを指定する場合は，プロパティ「webServiceConnectionCategory」も必ず指定してください。

−

入力

△

requestMethod

メソッド

HTTPメソッドとして，次のどれかを指定します。

GET

POST

PUT

DELETE

GET

入力

○

requestUrl

リクエストURL

HTTPリクエストを送信するリソースのURLと，クエリパラメータを指定します。URLエンコード済みの値を指定してください。

なお，300番台（リダイレクト）のステータスコードが返却される場合で，あらかじめリダイレクト先のURLが分かる場合は，リダイレクト先のURLを指定することをお勧めします。

プロパティ「webServiceConnectionCategory」およびプロパティ「webServiceConnectionName」に値を指定する場合は，URLのホスト名以降の"/"から先を指定してください。

−

入力

○

requestHeaders

リクエストヘッダ

HTTPリクエストヘッダーを指定します。RFC 7230の規則に従って記述してください。

なお，Content-Typeヘッダーでリクエストボディーのフォーマットを指定し，Content-Typeヘッダーのcharsetパラメータで文字セットを指定することをお勧めします。

−

入力

△

requestBody

リクエストボディ

HTTPリクエストボディーを指定します。Content-Typeヘッダーに指定したフォーマットで記述してください。

−

入力

△

webAuth

サーバ認証スキーム

サーバ認証の種類として，次のどれかを指定します。

none

サーバ認証を使用しない場合に指定します。

basic

Basic認証を使用する場合に指定します。

digest

Digest認証を使用する場合に指定します。

negotiate

Negotiate認証を使用する場合に指定します。なお，Negotiate認証が使用できるのは，JP1/AOのOSがWindowsの場合です。

プロパティ「requestHeaders」に認証ヘッダーを指定する場合は，「none」を指定してください。プロパティ「requestHeaders」に認証ヘッダーが指定されていて，プロパティ「webAuth」に「none」以外が指定されている場合，通信エラーになることがあります。

none

入力

○

webUsername

サーバ認証ユーザー名

サーバ認証に使用するユーザー名を256文字以内で指定します。

次の場合は指定不要です。

プロパティ「webServiceConnectionCategory」およびプロパティ「webServiceConnectionName」に値を指定した場合

プロパティ「webAuth」に「none」を指定した場合

−

入力

△

webPassword

サーバ認証パスワード

サーバ認証に使用するパスワードを256文字以内で指定します。

次の場合は指定不要です。

プロパティ「webServiceConnectionCategory」およびプロパティ「webServiceConnectionName」に値を指定した場合

プロパティ「webAuth」に「none」を指定した場合

−

入力

△

useProxy

プロキシの使用

リクエスト時，プロキシ接続をするかどうかについて次のどちらかを指定します。

true

リクエスト時，プロキシ接続を使用する場合に指定します。

false

リクエスト時，プロキシ接続を使用しない場合に指定します。

プロパティ「webServiceConnectionCategory」およびプロパティ「webServiceConnectionName」に値を指定した場合は，指定不要です。

false

入力

○

proxyHostname

プロキシホスト名

プロキシのホスト名またはIPアドレスを256文字以内で指定します。

次の場合は指定不要です。

プロパティ「webServiceConnectionCategory」およびプロパティ「webServiceConnectionName」に値を指定した場合

プロパティ「useProxy」に「false」を指定した場合

−

入力

△

proxyPort

プロキシポート番号

プロキシのポート番号を1〜65535で指定します。

次の場合は指定不要です。

プロパティ「webServiceConnectionCategory」およびプロパティ「webServiceConnectionName」に値を指定した場合

プロパティ「useProxy」に「false」を指定した場合

8080

入力

△

proxyAuth

プロキシサーバ認証スキーム

プロキシ認証の種類を指定します。

次の場合は指定不要です。

プロパティ「webServiceConnectionCategory」およびプロパティ「webServiceConnectionName」に値を指定した場合

プロパティ「useProxy」に「false」を指定した場合

次のどれかを指定します。

none

プロキシ認証を使用しない場合に指定します。

basic

Basic認証を使用する場合に指定します。

digest

Digest認証を使用する場合に指定します。

プロパティ「requestHeaders」に認証ヘッダーを指定する場合は，「none」を指定してください。プロパティ「requestHeaders」に認証ヘッダーが指定されていて，プロパティ「proxyAuth」に「none」以外が指定されている場合，通信エラーになることがあります。

none

入力

○

proxyUsername

プロキシユーザー名

プロキシ認証に使用するユーザー名を256文字以内で指定します。

次の場合は指定不要です。

プロパティ「webServiceConnectionCategory」およびプロパティ「webServiceConnectionName」に値を指定した場合

プロパティ「useProxy」に「false」を指定した場合

プロパティ「proxyAuth」に「none」を指定した場合

−

入力

△

proxyPassword

プロキシパスワード

プロキシ認証に使用するパスワードを256文字以内で指定します。

次の場合は指定不要です。

プロパティ「webServiceConnectionCategory」およびプロパティ「webServiceConnectionName」に値を指定した場合

プロパティ「useProxy」に「false」を指定した場合

プロパティ「proxyAuth」に「none」を指定した場合

−

入力

△

responseStatusCode

ステータスコード

HTTPレスポンスメッセージのステータスコードが出力されます。

なお，300番台（リダイレクト）のステータスコードが返却された場合は，自動でリダイレクトします。

−

出力

−

responseStatusMessage

ステータスメッセージ

HTTPレスポンスメッセージのステータスメッセージが出力されます。

−

出力

−

responseHeaders

レスポンスヘッダ

HTTPレスポンスメッセージのヘッダー情報が出力されます。

−

出力

−

responseBody

レスポンスボディ

HTTPレスポンスメッセージのボディー情報が出力されます。

−

出力

−

ヘッダーの送受信について

次のヘッダーについては，リクエスト時に値を指定しない場合，デフォルト値が設定されます。

表4‒11　デフォルト値が設定されるヘッダー

ヘッダー

デフォルト値

Accept

application/json

Accept-language

en

Content-Type※

application/json

Cache-Control

no-cache

Pragma

no-cache

User-Agent

クライアントソフトウェアの名称およびバージョン

Host

リクエスト先のホスト名およびポート番号

Connection

keep-alive

注※

デフォルト値が設定されるのは，メソッドにPOSTまたはPUTを指定した場合です。

また，次のヘッダーは送受信の際に特殊な動作をします。

表4‒12　特殊な動作をするヘッダー

ヘッダー

動作

Content-Typeのcharsetパラメータ

リクエスト時

charsetパラメータに指定した値で，ボディーの文字セットを変換します。指定がない場合は，UTF-8で変換します。

レスポンス時

返却されたcharsetパラメータで，ボディーの文字セットを解釈します。charsetパラメータが返却されない場合は，UTF-8として解釈します。

Content-Encoding

gzip形式またはdeflate形式で返却された場合，ファイルを展開します。

接続タイムアウト値の設定について

Webサーバまたはプロキシサーバとの接続でトラブルが発生して，HTTP/HTTPS通信が終了しない場合に，異常を検知するための接続タイムアウト値を設定できます。接続タイムアウト値は，ユーザー設定プロパティファイル（config_user.properties）のプロパティ「plugin.http.connect.timeout」および「plugin.http.read.timeout」で設定します。

WebサーバとのNegotiate認証で使用するための準備

WebサーバとのNegotiate認証では，Kerberos v5認証を使用します。Kerberos v5認証を使用するためには，構成ファイルの編集および参照設定が必要です。

認証で使用する構成ファイルと，格納場所を次に示します。

Kerberos構成ファイル

JP1/AOのインストール先フォルダ¥conf¥plugin¥krb5.conf

Login構成ファイル

JP1/AOのインストール先フォルダ¥conf¥plugin¥login.conf

Kerberos v5認証を使用する手順を次に示します。

Kerberos構成ファイルを編集して保存します。

認証で構成ファイルを参照するため，「共通コンポーネントのインストール先フォルダ¥Base64¥uCPSB¥CC¥web¥containers¥AutomationWebService¥usrconf¥usrconf.cfg」に，次の記述を追加して保存します。

add.jvm.arg=-Djava.security.krb5.conf=JP1/AOのインストール先フォルダ/conf/plugin/krb5.conf
add.jvm.arg=-Djava.security.auth.login.config=JP1/AOのインストール先フォルダ/conf/plugin/login.conf
add.jvm.arg=-Djavax.security.auth.useSubjectCredsOnly=false

JP1/AOのサービスを停止します。

非クラスタシステムの場合

hcmds64srvコマンドにstopオプションを指定して実行します。

クラスタシステムの場合

クラスタソフトを使用してサービスをオフラインにします。

JP1/AOのサービスを開始します。

非クラスタシステムの場合

hcmds64srvコマンドにstartオプションを指定して実行します。

クラスタシステムの場合

クラスタソフトを使用してサービスをオンラインにします。

Webサービス接続先定義の参照について

プロパティ「webServiceConnectionCategory」およびプロパティ「webServiceConnectionName」にWebサービス接続先定義のカテゴリと接続先名を指定することで，Webサービス接続先定義の設定項目をWebクライアント部品の入力プロパティとして参照することができます。対応する入力プロパティに値が設定されているときは，Webサービス接続先定義の設定項目で上書きされます。

Webクライアント部品の入力プロパティとWebサービス接続先定義の設定項目の対応関係を次の表に示します。

表4‒13　Webクライアント部品の入力プロパティとWebサービス接続先定義の設定項目

Webクライアント部品の入力プロパティ

Webサービス接続先定義の設定項目

requestUrl※

IPアドレス/ホスト名

プロトコル

ポート番号

webUsername

ユーザーID

webPassword

パスワード

useProxy

プロキシ設定

proxyHostname

プロキシサーバのIPアドレス/ホスト名

proxyPort

プロキシサーバのポート番号

proxyAuth

プロキシサーバの認証方式

proxyUsername

プロキシサーバのユーザーID

proxyPassword

プロキシサーバのパスワード

注※ Webサービス接続先定義の設定項目とプロパティ「requestUrl」に指定した値を組み合わせてリクエストURLを生成します。そのあと，生成したリクエストURLでプロパティ「requestUrl」を上書きします。

Webクライアント部品とJavaScript実行部品との連携例

Webクライアント部品は，実行時に，プロパティに指定された値を変換しないでそのまま使用します。そのため，プロパティの値を変換する必要があるときは，JavaScript実行部品と連携して使用することをお勧めします。URLエンコードおよびサーバのレスポンスからSSO時の認証トークンを抜き出す処理をする場合の，Webクライアント部品とJavaScript実行部品との連携例を次に示します。

図4‒13　Webクライアント部品とJavaScript実行部品との連携例

関連トピック

4.2.17　JavaScript実行部品

マニュアル「JP1/AO 構築ガイド」−「ユーザー設定プロパティファイル（config_user.properties）」のトピック

4.2.20　Python実行部品

機能

任意のPythonスクリプトを実行できます。

注意事項

サポートするPythonのバージョンは3.xシリーズです。また，Pythonの仮想環境はサポートしていません。

Pythonスクリプトを実行するには，JP1/AOサーバにPythonインタプリタを事前にインストールする必要があります。クラスタ環境で使用するには，実行系および待機系ホストの両方にPythonインタプリタをインストールする必要があります。

バージョン

01.00.01

タグ

Execute Script

戻り値

戻り値

説明

0

正常に終了した。

1

Pythonインタプリタの実行に失敗した。

2

Pythonスクリプトの実行に失敗した。

3

Pythonスクリプトがタイムアウトした。

80

タスクの実行を停止した。

127

そのほかのエラーが発生した。

プロパティ一覧

プロパティを次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

pythonInterpreterPath

Pythonインタプリタパス

スクリプトを実行するPythonインタプリタへのパスを指定します。

python

入力

○

scriptBody

スクリプト本体

Pythonコードを指定します。

−

入力

○

importedScript

インポートスクリプト

同一サービステンプレート上に配置したほかのPython実行部品と共通で使用するメソッドや定数（Pythonのコード文字列）を指定します。

−

入力

△

webServiceConnectionCategory

Webサービス接続カテゴリ

Webサービス接続カテゴリを指定します。

−

入力

△

webServiceConnectionName

Webサービス接続名

Webサービス接続名を指定します。

−

入力

△

timeout

タイムアウト

指定したスクリプトに対するタイムアウト時間（秒単位）を指定します。

300

入力

△

inN※

スクリプト入力 (N※)

スクリプトに渡す引数を指定します。

−

入力

△

standardOutput

標準出力

指定したスクリプトの標準出力を文字列として出力します。

−

出力

△

standardErrorOutput

標準エラー出力

指定したスクリプトの標準エラー出力を文字列として出力します。

−

出力

△

outN※

スクリプト出力 (N※)

指定したスクリプトのoutN※関数の引数に，指定した値を出力します。

−

出力

△

注※

Nは0から9の整数を示します。

プロパティリストで部品の入力／出力プロパティを指定します。入力プロパティには，サービスプロパティの値，予約プロパティの値，およびリテラル文字の組み合わせを使用できます。

スクリプト本体で使用できる変数および関数

次の変数および関数をスクリプト本体で使用できます。

表4‒14　スクリプト本体で使用できる変数および関数

カテゴリ

名前

説明

変数

inN※

入力プロパティ（inN※）に指定した値が設定されます。値が配列型やJSON形式で指定されていた場合も文字列型として解釈されます。

関数

outN※（文字列値）

関数の引数に渡された値が部品の出力プロパティ（outN※）に出力されます。

関数

log（文字列値）

任意の文字列をタスクログに出力できます。特定のプレフィックスを文字列の先頭に追加することで，ログレベルを選択できます。

プレフィックス

[Severe]

ログレベル0として出力します。

[Information]

ログレベル10として出力します。

[Fine]

ログレベル20として出力します。

[Finer]

ログレベル30として出力します。

[Debug]

ログレベル40として出力します。

（プレフィックスなし）

ログレベル10として出力します（[Information]と同じ）。

注※

Nは0から9の整数を示します。

ただし，デフォルトで定義された次のimport文をスクリプトから削除すると，これらの変数および関数を使用できません。

from dnaplugin import in0, in1, in2, in3, in4, in5, in6, in7, in8, in9
from dnaplugin import out0, out1, out2, out3, out4, out5, out6, out7, out8, out9
from dnaplugin import log

スクリプト本体から参照できる環境変数

スクリプト実行時に環境変数に値を設定します。os.environ[キー名]またはos.environ.get(キー名)の形式で，次の環境変数の値を取得できます。

表4‒15　スクリプト本体から参照できる環境変数

環境変数

説明

フォーマット

PLUGIN_PROPERTIES

Python実行部品のプロパティ

JSON形式

{プロパティ名:値...}

SERVICE_TEMPLATE_ID

Python実行部品が属するサービステンプレートのID

数値

SERVICE_ID

Python実行部品を実行するサービスのID

数値

SERVICE_TEMPLATE

Python実行部品が属するサービステンプレートの情報

JSON形式

{サービステンプレート属性:値... }

SERVICE

Python実行部品を実行するサービスの情報

JSON形式

{サービス属性:値...}

WEB_SERVICE_CONNECTIONS

Webサービス接続の設定情報※

JSON形式

[{Web サービス接続属性:値...}, ...]

注※

入力プロパティに指定された「Webサービス接続カテゴリ」および「Webサービス接続名」に対応した情報が取得されます。入力プロパティの指定状況に応じて取得される情報を次の表に示します。

入力プロパティの指定状況

取得情報

Webサービス接続カテゴリ

Webサービス接続名

指定あり

指定あり

指定したカテゴリと名前に一致するWebサービス接続情報

指定あり

指定なし

指定したカテゴリに一致するWebサービス接続情報

指定なし

指定あり

なし

指定なし

指定なし

なし

インポートスクリプトについて

同一サービステンプレート上に配置したほかのPython実行部品と共通で使用したいメソッドや定数がある場合，プロパティ「importedScript」に定義します。

プロパティ「importedScript」をサービス入力プロパティにマッピングし，ほかのPython実行部品のプロパティ「importedScript」を同じサービス入力プロパティにマッピングすることにより，インポートスクリプトに定義したメソッドや定数を各Python実行部品のスクリプト本体で共通に使用することができます。

スクリプト本体からの参照

インポートスクリプトに定義したメソッドや定数は，スクリプト本体からは，モジュール名「dnaplugin_imported_script」で参照できます。

import文をスクリプト本体にデフォルトで記述しています。

インポートスクリプトで利用可能な関数と環境変数

関数：log()関数が利用可能です。詳細はスクリプト本体で使用できる変数および関数の表のlog()関数を参照してください。

環境変数：スクリプト本体で利用可能な環境変数と同じです。詳細はスクリプト本体から参照できる環境変数の表を参照してください。

インポートスクリプトのサンプル

スクリプト本体

# -*- coding: utf-8 -*-
import os
from dnaplugin import in0, in1, in2, in3, in4, in5, in6, in7, in8, in9
from dnaplugin import out0, out1, out2, out3, out4, out5, out6, out7, out8, out9
from dnaplugin import log
from dnaplugin_imported_script import *

hoge(CNST)

インポートスクリプト

from dnaplugin import log

def hoge(a):
    log(a + ' from common py!')

CNST = 'hoge'

4.3　JP1/AO同梱版コンテンツ部品一覧

4.3.1　Active Directory関連の部品一覧

項番

部品名

機能

1

Active Directoryオブジェクト移動

Active Directoryでオブジェクトを指定したOUに移動します。

2

Active Directoryオブジェクト検索

Active Directoryでオブジェクトを検索します。

3

Active Directoryオブジェクト削除

Active Directoryでオブジェクトを削除します。

4

Active Directoryグループメンバー一覧取得

Active Directoryの指定したグループに所属しているメンバーの一覧を取得します。

5

Active Directoryグループ属性変更

Active Directoryでグループ属性を変更します。

6

Active Directoryグループ追加

Active Directoryでグループを追加します。

7

Active DirectoryのOU属性変更

Active DirectoryでOUの属性を変更します。

8

Active DirectoryのUPN一覧取得

Active Directoryでユーザープリンシパル名の一覧を取得します。

9

Active DirectoryへのOU追加

Active DirectoryにOUを追加します。

10

Active Directoryユーザーアカウントロック解除

Active Directoryでユーザーアカウントのロックを解除します。

11

Active Directoryユーザーのパスワード変更

Active Directoryでユーザーのパスワードを変更します。

12

Active Directoryユーザー属性変更

Active Directoryでユーザー属性を変更します。

13

Active Directoryユーザー追加

Active Directoryでユーザーを追加します。

14

Active Directory既存グループからのメンバー削除

Active Directoryで既存グループからメンバーを削除します。

15

Active Directory既存グループへのメンバー追加

Active Directoryで既存グループにメンバーを追加します。

16

Active Directory連絡先属性変更

Active Directoryで連絡先属性を変更します。

17

Active Directory連絡先追加

Active Directoryで連絡先を追加します。

4.3.2　JP1関連の部品一覧

項番

部品名

機能

1

JP1サイレントインストール(UNIX)

UNIXの実行対象サーバで，Hitachi PP Installerの媒体に格納されているJP1製品をサイレントインストールします。

2

JP1サイレントインストール(Windows)

Windowsの実行対象サーバで，日立総合インストーラーの媒体に格納されているJP1製品をサイレントインストールします。

3

JP1修正パッチ適用(UNIX)

UNIXの実行対象サーバで，インストールされているJP1製品の修正パッチを適用します。

4

JP1修正パッチ適用(Windows)

Windowsの実行対象サーバで，インストールされているJP1製品の修正パッチを適用します。

4.3.3　JP1/AJS関連の部品一覧

項番

部品名

機能

1

JP1/AJSジョブネット確定実行登録

ジョブネットの確定実行登録を行います。

2

JP1/AJSジョブネット強制終了

ジョブネットまたはジョブを強制終了します。

3

JP1/AJSジョブネット計画実行登録

ジョブネットの計画実行登録を行います。

4

JP1/AJSジョブネット再実行

ジョブネットまたはジョブを再実行します。

5

JP1/AJSジョブネット実行スケジュール変更

ジョブネットの実行開始日時を一時的に変更するか，ジョブネットを即時実行します。

6

JP1/AJSジョブネット実行中止

ジョブネットまたはジョブの実行を一時的に中止します。

7

JP1/AJSジョブネット実行登録

JP1/AJS3(またはJP1/AJS2)に対してジョブネット実行登録を行います。

8

JP1/AJSジョブネット実行予実績出力

ジョブネットの実行予実績をファイルに出力します。

9

JP1/AJSジョブネット中断

ジョブネットを中断します。

10

JP1/AJSジョブネット保留属性変更

ジョブネットまたはジョブの保留属性を一時的に変更します。

11

JP1/AJSジョブ状態変更

ジョブの状態を変更します。

12

JP1/AJSのジョブネット実行結果取得

JP1/AJS3(またはJP1/AJS2)のジョブネット実行結果を取得します。

13

JP1/AJSのトラブルシュート情報取得

JP1/AJS3(またはJP1/AJS2)のトラブルシュート情報を取得し，指定したフォルダに格納します。

14

JP1/AJSの起動(UNIX)

UNIXの実行対象サーバで，JP1/AJSを起動します。

15

JP1/AJSの状態取得

WindowsまたはUNIXの実行対象サーバで，JP1/AJSの状態を取得します。

16

JP1/AJSの停止(UNIX)

UNIXの実行対象サーバで，JP1/AJSを停止します。

17

JP1/AJSユニット存在確認

ユニットの存在確認を行います。

4.3.4　JP1/Base関連の部品一覧

項番

部品名

機能

1

JP1/Baseイベントサービスの起動(UNIX)

UNIXの実行対象サーバで，JP1/Baseのイベントサービスを起動します。

2

JP1/Baseイベントサービスの状態取得

WindowsまたはUNIXの実行対象サーバで，JP1/Baseのイベントサービスの状態を取得します。

3

JP1/Baseイベントサービスの停止(UNIX)

UNIXの実行対象サーバで，JP1/Baseのイベントサービスを停止します。

4

JP1/Baseのトラブルシュート情報取得

JP1/Baseのトラブルシュート情報を取得し，指定したフォルダに格納します。

5

JP1/Baseのパスワード管理情報変更

JP1/Baseのパスワード管理情報のOSユーザー情報を更新します。

6

JP1/Baseのパスワード管理情報変更(SYSTEM)

JP1/Baseのパスワード管理情報のOSユーザー情報を更新します。

7

JP1/Baseのユーザーマッピング追加

JP1/Baseにユーザーマッピング定義を追加します。

8

JP1/Baseのユーザーマッピング追加(SYSTEM)

JP1/Baseにユーザーマッピング定義を追加します。

9

JP1/Baseの起動(UNIX)

UNIXの実行対象サーバで，JP1/Baseを起動します。

10

JP1/Baseの状態取得

WindowsまたはUNIXの実行対象サーバで，JP1/Baseの状態を取得します。

11

JP1/Baseの停止(UNIX)

UNIXの実行対象サーバで，JP1/Baseを停止します。

12

JP1/Baseユーザーマッピング削除

JP1/Baseのユーザーマッピング情報を削除します。

13

JP1/Baseユーザーマッピング削除(SYSTEM)

JP1/Baseのユーザーマッピング情報を削除します。

14

JP1/Base共通定義情報設定

JP1/Baseに共通定義情報を設定します。

15

JP1/Base操作権限設定

JP1/Baseに登録されたJP1ユーザーの操作権限を設定します。

16

JP1/Base操作権限設定(SYSTEM)

JP1/Baseに登録されたJP1ユーザーの操作権限を設定します。

17

JP1イベントの登録

JP1イベントを登録します。

18

JP1ユーザーパスワード変更

JP1/Baseに登録されたJP1ユーザーのパスワードを変更します。

19

JP1ユーザーパスワード変更(SYSTEM)

JP1/Baseに登録されたJP1ユーザーのパスワードを変更します。

20

JP1ユーザー一覧取得

JP1ユーザーの一覧を取得します。

21

JP1ユーザー削除

JP1/BaseからJP1ユーザーを削除します。

22

JP1ユーザー削除(SYSTEM)

JP1/BaseからJP1ユーザーを削除します。

23

JP1ユーザー操作権限削除

JP1/Baseに登録されたJP1ユーザーの操作権限を削除します。

24

JP1ユーザー操作権限削除(SYSTEM)

JP1/Baseに登録されたJP1ユーザーの操作権限を削除します。

25

JP1ユーザー追加

JP1/BaseにJP1ユーザーを新規に追加します。

26

JP1ユーザー追加(SYSTEM)

JP1/BaseにJP1ユーザーを新規に追加します。

27

OSユーザー情報の削除

JP1/Baseのパスワード管理情報のOSユーザー情報を削除します。

28

OSユーザー情報の削除(SYSTEM)

JP1/Baseのパスワード管理情報のOSユーザー情報を削除します。

29

マッピング情報の確認

JP1ユーザーマッピング情報を取得します。

4.3.5　JP1/IM関連の部品一覧

項番

部品名

機能

1

JP1/IMトラブルシュート情報の収集

JP1/IMのトラブルシュート情報を取得し，指定したフォルダに格納します。

2

JP1イベントの対処状況変更

JP1の重要イベントの対処状況を変更します。

3

JP1イベント取得

指定された期間のイベント情報を取得します。

4.3.6　JP1/NNMi関連の部品一覧

項番

部品名

機能

1

NNMiトポロジデータベース内容の出力

JP1/Cm2/NNMiのトポロジデータベースの内容を取得し，指定したファイルに出力します。

2

監視対象ノード削除

指定されたJP1/Cm2/NNMiの監視対象ノードを削除します。

3

監視対象ノード追加

指定された監視対象ノードをJP1/Cm2/NNM(またはJP1/Cm2/NNMi)の監視対象に追加します。

4.3.7　JP1/PFM関連の部品一覧

項番

部品名

機能

1

Storeデータベース保存条件設定

JP1/PFM - RMのリモートエージェントにStoreデータベースの保存条件を設定します。

2

アラームテーブルのコピー(JP1/PFM)

JP1/PFMのアラームテーブル(またはアラーム)をコピーします。

3

アラームテーブルの削除(JP1/PFM)

JP1/PFMのアラームテーブル(またはアラーム)を削除します。

4

アラームテーブルの情報取得(JP1/PFM)

JP1/PFMのアラームテーブルの情報を取得します。

5

アラームテーブル名一覧取得(JP1/PFM - RM)

JP1/PFM - RMのアラームテーブル名一覧を取得します。

6

アラームのアンバインド(JP1/PFM - RM)

JP1/PFM - RMのエージェントから，アラームテーブルのバインドを解除します。

7

アラームのバインド(JP1/PFM - RM)

JP1/PFM - RMのエージェントに，アラームテーブルをバインドします。

8

アラーム定義ファイルのインポート(JP1/PFM)

JP1/PFMのアラーム定義ファイルをインポートします。

9

アラーム定義ファイルのエクスポート(JP1/PFM)

JP1/PFMのアラーム定義ファイルをエクスポートします。

10

エージェント階層設定

JP1/PFMのエージェント階層の定義情報をインポートし，エージェント階層を作成・更新します。

11

サービス情報同期

JP1/PFM - Managerに登録されているサービス情報をJP1/PFM - Web Consoleに同期します。

12

プロセス監視設定一覧取得

プロセス監視設定一覧を取得します。

13

プロセス監視設定追加

JP1/PFMのエージェントに対するプロセス監視設定(アプリケーション定義)を追加します。

14

レポート取得

レポートを取得します。

15

監視設定追加(JP1/PFM - RM)

JP1/PFM - RMのリモートエージェントにパフォーマンス情報の記録方法の設定を行います。

16

監視対象削除(JP1/PFM - RM)

JP1/PFM - RMから監視対象サーバを削除します。

17

監視対象追加(JP1/PFM - RM)

JP1/PFM - RMに監視対象サーバを追加します。

18

監視対象表示(JP1/PFM - RM)

JP1/PFM - RM for Platformにおいて，監視対象を取得します。

4.3.8　JP1/SS関連の部品一覧

項番

部品名

機能

1

JP1/IM-SSの案件情報更新

JP1/IM-SSの案件情報を更新します。

2

JP1/IM-SSの案件登録

JP1/IM-SSに新規案件を登録します。

4.3.9　JP1/VERITAS関連の部品一覧

項番

部品名

機能

1

インスタントリカバリ実行(JP1/VERITAS)

WindowsまたはUNIX環境の実行対象サーバにおいて，仮想サーバの最新のバックアップを用いて，仮想サーバのインスタントリカバリを実行します。インスタントリカバリジョブが正常に起動したことを確認したあと，実行中のインスタントリカバリジョブの詳細リストをファイルに出力します。

2

インスタントリカバリ終了(JP1/VERITAS)

WindowsまたはUNIX環境の実行対象サーバにおいて，起動中のインスタントリカバリジョブの終了処理を実行し，その後インスタントリカバリジョブが正常に終了したことを確認します。

3

バックアップポリシー(VMware)の初期化

JP1/VERITAS NetBackup環境でバックアップポリシーをVMware形式で初期化します。

4

バックアップポリシー(VMware)の属性変更

JP1/VERITAS NetBackup環境でVMware形式のバックアップポリシーの属性を変更します。

5

バックアップポリシーの作成

JP1/VERITAS NetBackup環境でバックアップポリシーを作成します。

6

バックアップポリシーへのクライアント追加

JP1/VERITAS NetBackup環境でバックアップポリシーへクライアントを追加します。

7

バックアップポリシーへのスケジュール属性変更

JP1/VERITAS NetBackup環境でバックアップポリシーのスケジュール属性を変更します。

8

バックアップポリシーへのスケジュール追加

JP1/VERITAS NetBackup環境でバックアップポリシーへスケジュールを追加します。

9

バックアップポリシーへのファイルリスト追加

JP1/VERITAS NetBackup環境でバックアップポリシーへファイルリストを追加します。

10

バックアップ実行(JP1/VERITAS)

JP1/VERITAS NetBackupによるバックアップを実行します。

11

仮想マシンリストア実行

JP1/VERITAS NetBackup環境で仮想マシンをリストアします。

12

名前変更ファイルの作成

JP1/VERITAS NetBackup環境で仮想マシンのリストアに使用する名前変更ファイルを作成します。

4.3.10　OS関連の部品一覧

項番

部品名

機能

1

CSV・Excelのセルデータ更新

CSVまたはExcelファイルのセルを，指定したデータで更新します。

2

CSV・Excelのセルデータ取得

CSVまたはExcelファイルから，指定したセルのデータを取得します。

3

CSV・Excelのデータ分割

CSVまたはExcelファイルを，指定した行数のファイルに分割します。また，列データのフィルタ条件を指定して，特定の行だけを抽出することができます。

4

CSV・Excelの行データ取得

CSVまたはExcelファイルから，指定したキー値に一致する行のデータを取得します。

5

CSV・Excelの行データ取得(SYSTEM)

CSVまたはExcelファイルから，指定したキー値に一致する行のデータを取得します。

6

CSV・Excelの列データ取得

CSVまたはExcelファイルから，指定した列のデータを取得します。

7

CSV・Excelの列データ取得(SYSTEM)

CSVまたはExcelファイルから，指定した列のデータを取得します。

8

ICMPエコー要求メッセージの送信

WindowsまたはUNIXの実行対象サーバで，指定されたIPアドレスにICMPエコー要求メッセージを送信します。

9

IPアドレスの設定

WindowsまたはUNIXの実行対象サーバにおいて，指定したNICにIPアドレスを設定します。

10

OSサービスの操作

WindowsまたはLinuxの実行対象サーバにおいて，指定されたOSサービスを操作します。

11

OSユーザーのパスワード変更

WindowsまたはUNIXの実行対象サーバで，OSユーザーのパスワードを変更します。

12

OSユーザーのパスワード変更(SYSTEM)

WindowsまたはUNIXの実行対象サーバで，OSユーザーのパスワードを変更します。

13

OSユーザーの一覧取得

Windows/UNIXのOSユーザーの一覧を取得します。

14

OSユーザーの削除

WindowsまたはUNIXの実行対象サーバで，OSユーザーを削除します。

15

OSユーザーの削除(SYSTEM)

WindowsまたはUNIXの実行対象サーバで，OSユーザーを削除します。

16

OS種別の出力

指定したWindowsまたはUNIXの実行対象サーバのOS種別を標準出力に出力します。

17

サーバのシャットダウン

WindowsまたはLinuxの実行対象サーバにおいて，サーバのシャットダウンを実行します。

18

サーバの再起動

WindowsまたはLinuxの実行対象サーバにおいて，サーバの再起動を実行します。

19

テキストファイルの文字列抽出

指定したテキストファイルの指定した1行を出力プロパティに設定します。

20

ファイルのコピー

WindowsまたはUNIXの実行対象サーバで，指定したファイルまたはフォルダをコピーします。

21

ファイルのサイズ取得

WindowsまたはUNIX環境の実行対象サーバにおいて，指定したパスのサブフォルダを含めたすべてのファイルの合計のファイルサイズを出力します。

22

ファイルの圧縮

WindowsまたはUNIX環境の実行対象サーバにおいて，指定したファイルおよびフォルダを圧縮します。実行対象サーバがWindowsの場合はzip，実行対象サーバがUNIXの場合はtarでアーカイブしたあとにgzipで圧縮します。

23

ファイルの解凍

WindowsまたはUNIX環境の実行対象サーバにおいて，指定した圧縮ファイルを解凍します。実行対象サーバがWindowsの場合はzipファイル，実行対象サーバがUNIXの場合はtarでアーカイブしたあとにgzipで圧縮されたファイルを解凍します。

24

ファイルの最終更新日時取得

WindowsまたはUNIX環境の実行対象サーバにおいて，指定したファイルまたはフォルダの最終更新日時を出力します。

25

ファイルの文字エンコード変換

WindowsまたはUNIX環境の実行対象サーバにおいて，指定したテキストファイルの文字エンコード種別を変換し別ファイルに出力します。

26

ファイルまたはフォルダのアクセス権限取得

指定したファイルの権限情報をファイルに出力します。フォルダを指定した場合は,指定したフォルダの権限情報を出力します。

27

ファイルまたはフォルダの存在確認

WindowsまたはUNIXの実行対象サーバにおいて，指定したファイルまたはフォルダが存在するか確認します。

28

ファイル移動

WindowsまたはUNIX環境の実行対象サーバにおいて，指定したファイルまたはフォルダを移動します。

29

ファイル一覧の取得

WindowsまたはUNIX環境の実行対象サーバにおいて，指定したパスのファイルまたはフォルダ配下のファイルおよびフォルダの一覧情報をテキストファイルとして出力します。

30

ファイル削除

WindowsまたはUNIXの実行対象サーバで，指定されたファイルを削除します。

31

ファイル削除(SYSTEM)

WindowsまたはUNIXの実行対象サーバで，指定されたファイルを削除します。

32

フォルダ作成

WindowsまたはUNIXの実行対象サーバで，指定されたフォルダを作成します。

33

フォルダ削除

WindowsまたはUNIXの実行対象サーバで，指定されたフォルダを削除します。

34

プロセスの情報取得

WindowsまたはUNIXの実行対象サーバにおいて，指定したプロセスの情報を出力プロパティに設定します。

35

ホスト名取得

WindowsまたはUNIXの実行対象サーバで，指定されたIPアドレスから名前解決を行い，ホスト名を取得します。

36

実行待機

プロパティに指定した秒数の待機処理を実施し，ステップ間の実行間隔を制御します。

37

日時計算

WindowsまたはUNIX環境の実行対象サーバにおいて，指定した日時に対して指定した時間を加減算します。

38

日時取得

実行対象サーバ上の現在日時を，指定したフォーマットにしたがって取得します。

39

日時比較

WindowsまたはUNIX環境の実行対象サーバにおいて，ユーザーが入力した2つの日時を比較します。

40

文字列のソート処理

WindowsまたはUNIX環境の実行対象サーバにおいて，指定された文字列をソートします。

41

文字列のフィルタリング

WindowsまたはLinuxの実行対象サーバで，文字列のフィルタリングを行います。

42

文字列の検索

WindowsまたはUNIXの実行対象サーバにおいて，文字列の検索を行います。

43

文字列の置換

WindowsまたはUNIXの実行対象サーバにおいて，指定したファイルの特定文字列を指定した文字列に置換します。

44

文字列の追加

WindowsまたはUNIX環境の実行対象サーバにおいて，指定したファイルの末尾に文字列を追加します。

4.3.11　TELstaff関連の部品一覧

項番

部品名

機能

1

TELstaffによる通知

TELstaffで通知を行います。

4.3.12　UNIX関連の部品一覧

項番

部品名

機能

1

OSユーザーの追加 (UNIX)

UNIXの実行対象サーバで，OSユーザーを作成します。

2

ファイルまたはディレクトリのアクセス権限変更

UNIXの実行対象サーバにおいて，指定したファイルまたはディレクトリに対して，アクセス権限を変更することができます。

4.3.13　Windows関連の部品一覧

項番

部品名

機能

1

CSVデータ取得

CSVファイルのデータを取得します。

2

ICMPエコー要求メッセージの送信 (無応答確認)

Windowsの実行対象サーバで，指定されたIPアドレスにICMPエコー要求メッセージを送信します。応答が無いことを確認します。

3

OSサービスのアカウント変更

Windowsの実行対象サーバにおいて，指定されたOSサービスのアカウントを変更します。

4

OSサービスのスタートアップ設定

Windowsの実行対象サーバにおいて，指定した起動方法でOSサービスのスタートアップの種類を設定します。

5

OSユーザーのグループ設定 (Windows)

Windowsの実行対象サーバで，OSユーザーの所属するグループを設定します。

6

OSユーザーのグループ設定 (Windows)(SYSTEM)

Windowsの実行対象サーバで，OSユーザーの所属するグループを設定します。

7

OSユーザーの追加 (Windows)

Windowsの実行対象サーバで，OSユーザーを作成します。

8

OSユーザーの追加 (Windows)(SYSTEM)

Windowsの実行対象サーバで，OSユーザーを作成します。

9

SQLクエリーの実行

32bit版のODBCドライバで接続されたDBサーバに対して，指定されたSQLを発行します。

10

Windowsファイアウォールの設定

Windowsの実行対象サーバで，プログラムやポートをWindowsファイアウォールの例外に登録します。

11

イベントログのイベント一覧取得

Windowsのイベントログにあるイベント一覧をCSV形式でファイルに出力します。

12

イベントログへのイベント作成

Windowsのイベントログにイベントを作成します。

13

ファイルの印刷(Windows)

Windows環境の実行対象サーバにおいて，指定したファイルを印刷キューに投入します。

14

ファイルまたはフォルダのアクセス権限変更

Windowsの実行対象サーバにおいて，指定したファイルまたはフォルダに対して，アクセス権限を変更することができます。

15

時刻判定

指定した判定対象の時刻が，指定した条件に一致するか判定します。

4.4　Active Directory関連の部品

4.4.1　Active Directoryオブジェクト移動

機能

この部品は，指定したサーバのActive Directoryに対して，オブジェクトを指定したOU(Organizational Unit)に移動します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。前提条件に記載のActive Directoryがセットアップされている必要があります。

この部品では，次に示すオブジェクトを移動することができます。

　・グループ

　・ユーザー

　・連絡先

　・OU

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

　dsmove

　　"オブジェクトの識別名(Windows.objectNameプロパティ)の値"

　　-newparent "移動先OUの識別名(Windows.parentNameプロパティ)の値"

　dsmoveコマンドの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。

利用場面

Active Directoryでオブジェクトを指定したOUに移動する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) Active Directory ドメイン サービス

　(2) DNS サーバー

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバ内前提製品の使用条件】

　なし。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

実行権限

(1) 実行サーバに接続する際のユーザーは，Active Directory ドメイン サービスのAccount Operators グループ，Domain Admins グループ，または Enterprise Admins グループのメンバーであるか，適切な権限を持っている必要があります。

バージョン

02.00.00

部品のタグ

Configure Active Directory,Windows,Active Directory

タスクログに表示される部品の名称

adMoveObject

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

Windows.objectName

オブジェクトの識別名

移動するオブジェクトの識別名をCN=またはOU=で始まる形式で指定します。

−　

入力

○　

Windows.parentName

移動先OUの識別名

移動先OUの識別名をOU=で始まる形式で指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.4.2　Active Directoryオブジェクト検索

機能

この部品は，指定したサーバのActive Directoryに対して，オブジェクトを検索します。検索結果は，出力ファイルのパス(common.outputFilePathプロパティ)に指定したファイルに出力されます。指定したファイルの親フォルダが存在しない場合は，この部品でフォルダを作成します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。前提条件に記載のActive Directoryがセットアップされている必要があります。

この部品では，次に示すオブジェクトを検索することができます。

　・グループ

　・ユーザー

　・連絡先

　・OU(Organizational Unit)

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

　dsquery

　　"オブジェクトの種類(Windows.objectTypeプロパティ)の値"

　　"検索開始ノード(Windows.startNodeプロパティ)の値"

　　[-name "オブジェクト名(Windows.objectNameプロパティ)の値"]

　　[-desc "説明(Windows.descriptionプロパティ)の値"]

　　[-upn "ユーザープリンシパル名(Windows.userPrincipalNameプロパティ)の値"]

　　-limit "0"

　dsqueryコマンドの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。

この部品のファイル出力例を次に示します。

・出力例

"OU=SampleOU1,OU=testOU,DC=example,DC=co,DC=jp"

"OU=SampleOU2,OU=testOU,DC=example,DC=co,DC=jp"

利用場面

Active Directoryでオブジェクトを検索する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) Active Directory ドメイン サービス

　(2) DNS サーバー

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバ内前提製品の使用条件】

　なし。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) 出力ファイルのパス(common.outputFilePathプロパティ)に出力ファイル名と同名のファイルが既に存在する場合は上書きします。

バージョン

02.00.01

部品のタグ

Gather Active Directory information,Windows,Active Directory

タスクログに表示される部品の名称

adSearchObject

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

Windows.objectType

オブジェクトの種類

検索するオブジェクトの種類を指定します。指定可能な値は，"group"，"user"，"contact"，"ou"です。

−　

入力

○　

Windows.startNode

検索開始ノード

検索を開始するノードを指定します。検索開始ノードには，"forestroot"，"domainroot"，またはドメインの識別名をDC=で始まる形式で指定できます。

domainroot

入力

○　

Windows.objectName

オブジェクト名

検索するオブジェクトの名前を指定します。ワイルドカードとして，"*"を使用できます。

−　

入力

△　

Windows.description

説明

検索するオブジェクトの説明を指定します。ワイルドカードとして，"*"を使用できます。

−　

入力

△　

Windows.userPrincipalName

ユーザープリンシパル名

検索するオブジェクトのユーザープリンシパル名を指定します。検索するオブジェクトの種類が"user"の場合に指定できます。

−　

入力

△　

common.outputFilePath

出力ファイルのパス

出力するファイルをフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.4.3　Active Directoryオブジェクト削除

機能

この部品は，指定したサーバのActive Directoryに対して，オブジェクトを削除します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。前提条件に記載のActive Directoryがセットアップされている必要があります。

この部品では，次に示すオブジェクトを削除することができます。

　・グループ

　・ユーザー

　・連絡先

　・OU

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

　dsrm

　　"オブジェクトの識別名(Windows.objectNameプロパティ)の値"

　　-noprompt

　dsrmコマンドの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。

利用場面

Active Directoryでオブジェクトを削除する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) Active Directory ドメイン サービス

　(2) DNS サーバー

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバ内前提製品の使用条件】

　なし。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

実行権限

(1) 実行サーバに接続する際のユーザーは，Active Directory ドメイン サービスのAccount Operators グループ，Domain Admins グループ，または Enterprise Admins グループのメンバーであるか，適切な権限を持っている必要があります。

バージョン

02.00.00

部品のタグ

Configure Active Directory,Windows,Active Directory

タスクログに表示される部品の名称

adDeleteObject

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

Windows.objectName

オブジェクトの識別名

削除するオブジェクトの識別名をCN=で始まる形式で指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.4.4　Active Directoryグループメンバー一覧取得

機能

この部品は，指定したサーバのActive Directoryに対して，指定したグループに所属しているメンバーの一覧を取得します。取得結果は，出力ファイルのパス(common.outputFilePathプロパティ)に指定したファイルに出力されます。指定したファイルの親フォルダが存在しない場合は，この部品でフォルダを作成します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。前提条件に記載のActive Directoryがセットアップされている必要があります。

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

　dsget group

　　"グループの識別名(Windows.groupNameプロパティ)の値"

　　-members

　dsget groupコマンドの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。

この部品のファイル出力例を次に示します。

・出力例

"CN=SampleUser,OU=testOU,DC=example,DC=co,DC=jp"

"CN=SampleContact,OU=testOU,DC=example,DC=co,DC=jp"

利用場面

Active Directoryの指定したグループに所属しているメンバーの一覧を取得する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) Active Directory ドメイン サービス

　(2) DNS サーバー

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバ内前提製品の使用条件】

　なし。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) 出力ファイルのパス(common.outputFilePathプロパティ)に出力ファイル名と同名のファイルが既に存在する場合は上書きします。

バージョン

02.00.00

部品のタグ

Gather Active Directory information,Windows,Active Directory

タスクログに表示される部品の名称

adGetMembersOfGroup

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

Windows.groupName

グループの識別名

メンバー一覧を取得するグループの識別名をCN=で始まる形式で指定します。

−　

入力

○　

common.outputFilePath

出力ファイルのパス

出力するファイルをフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.4.5　Active Directoryグループ属性変更

機能

この部品は，指定したサーバのActive Directoryに対して，グループ属性を変更します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。前提条件に記載のActive Directoryがセットアップされている必要があります。

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

　dsmod group

　　"グループの識別名(Windows.groupNameプロパティ)の値"

　　[-secgrp {yes|no}] ※1

　　[-scope {l|g|u}] ※2

　　[-desc "説明(Windows.descriptionプロパティ)の値"]

　※1 セキュリティグループ設定要否(Windows.isSecurityGroupプロパティ)の値に"true"を指定した場合に"yes"，"false"を指定した場合に"no"が設定されます。"true"または"false"以外の値を指定した場合，このオプションは省略されます。

　※2 スコープ(Windows.scopeプロパティ)の値に対応したオプション値が設定されます。

　　　"local"の場合： "l"

　　　"global"の場合： "g"

　　　"universal"の場合: "u"

　dsmod groupコマンドの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。

利用場面

Active Directoryでグループ属性を変更する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) Active Directory ドメイン サービス

　(2) DNS サーバー

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバ内前提製品の使用条件】

　なし。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) 部品のプロパティに値を指定しなかった場合，その部品のプロパティに対応する属性値は変更されません。

実行権限

(1) 実行サーバに接続する際のユーザーは，Active Directory ドメイン サービスのAccount Operators グループ，Domain Admins グループ，または Enterprise Admins グループのメンバーであるか，適切な権限を持っている必要があります。

バージョン

02.00.01

部品のタグ

Configure Active Directory,Windows,Active Directory

タスクログに表示される部品の名称

adChangeGroupAttribute

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

Windows.groupName

グループの識別名

属性変更するグループの識別名をCN=で始まる形式で指定します。

−　

入力

○　

Windows.isSecurityGroup

セキュリティグループ設定要否

グループをセキュリティグループにする場合は"true"を，配布グループにする場合は"false"を指定します。

−　

入力

△　

Windows.scope

スコープ

グループのスコープを指定します。指定可能な値は，"local"，"global"，"universal"です。

−　

入力

△　

Windows.description

説明

変更後のグループの説明を指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.4.6　Active Directoryグループ追加

機能

この部品は，指定したサーバのActive Directoryに対して，グループを追加します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。前提条件に記載のActive Directoryがセットアップされている必要があります。

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

　dsadd group

　　"グループの識別名(Windows.groupNameプロパティ)の値"

　　[-secgrp "no"] ※1

　　-scope {l|g|u} ※2

　　[-desc "説明(Windows.descriptionプロパティ)の値"]

　　[-memberof "所属先グループの識別名(Windows.memberOfプロパティ)の値"]

　※1 配布グループ設定要否(Windows.isDistributionGroupプロパティ)の値に"true"を指定した場合に設定されます。

　※2 スコープ(Windows.scopeプロパティ)の値に対応したオプション値が設定されます。

　　　"local"の場合： "l"

　　　"global"の場合： "g"

　　　"universal"の場合: "u"

　dsadd groupコマンドの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。

利用場面

Active Directoryでグループを追加する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) Active Directory ドメイン サービス

　(2) DNS サーバー

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバ内前提製品の使用条件】

　なし。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

実行権限

(1) 実行サーバに接続する際のユーザーは，Active Directory ドメイン サービスのAccount Operators グループ，Domain Admins グループ，または Enterprise Admins グループのメンバーであるか，適切な権限を持っている必要があります。

バージョン

02.00.01

部品のタグ

Configure Active Directory,Windows,Active Directory

タスクログに表示される部品の名称

adAddGroup

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

Windows.groupName

グループの識別名

追加するグループの識別名をCN=で始まる形式で指定します。

−　

入力

○　

Windows.isDistributionGroup

配布グループ設定要否

追加するグループを配布グループにする場合は"true"を指定します。"true"以外の場合は，セキュリティグループが仮定されます。

−　

入力

△　

Windows.scope

スコープ

追加するグループのスコープを指定します。指定可能な値は，"local"，"global"，"universal"です。省略した場合は，"global"が仮定されます。

−　

入力

△　

Windows.description

説明

追加するグループの説明を指定します。

−　

入力

△　

Windows.memberOf

所属先グループの識別名

追加するグループが所属するグループの識別名をCN=で始まる形式で指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.4.7　Active DirectoryのOU属性変更

機能

この部品は，指定したサーバのActive Directoryに対して，OU(Organizational Unit)の説明を変更します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。前提条件に記載のActive Directoryがセットアップされている必要があります。

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

　dsmod ou

　　"OUの識別名(Windows.OUNameプロパティ)の値"

　　-desc "説明(Windows.descriptionプロパティ)の値"

　dsmod ouコマンドの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。

利用場面

Active DirectoryでOUの説明を変更する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) Active Directory ドメイン サービス

　(2) DNS サーバー

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバ内前提製品の使用条件】

　なし。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) 説明(Windows.descriptionプロパティ)に空文字を指定することはできません。

実行権限

(1) 実行サーバに接続する際のユーザーは，Active Directory ドメイン サービスのAccount Operators グループ，Domain Admins グループ，または Enterprise Admins グループのメンバーであるか，適切な権限を持っている必要があります。

バージョン

02.00.00

部品のタグ

Configure Active Directory,Windows,Active Directory

タスクログに表示される部品の名称

adChangeOUAttribute

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

Windows.OUName

OUの識別名

属性変更するOUの識別名をOU=で始まる形式で指定します。

−　

入力

○　

Windows.description

説明

変更後のOUの説明を指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.4.8　Active DirectoryのUPN一覧取得

機能

この部品は，指定したサーバのActive Directoryに対して，指定したドメイン内に登録されているユーザーのユーザープリンシパル名の一覧を取得します。取得結果は，出力ファイルのパス(common.outputFilePathプロパティ)に指定したファイルに出力されます。指定したファイルの親フォルダが存在しない場合は，この部品でフォルダを作成します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。前提条件に記載のActive Directoryがセットアップされている必要があります。

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

　csvde

　　-d "ドメインの識別名(Windows.domainNameプロパティ)の値"

　　[-t "Active Directory接続用ポート番号(Windows.portNumberプロパティ)の値"]

　　-f "出力ファイルのパス(common.outputFilePathプロパティ)の値"

　　-l "DN,userPrincipalName"

　　-r "objectclass=user"

　csvdeコマンドの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。

この部品のファイル出力例を次に示します。

・出力例

DN,userPrincipalName

"CN=Administrator,CN=Users,DC=example,DC=co,DC=jp",

"CN=Guest,CN=Users,DC=example,DC=co,DC=jp",guest@example.co.jp

利用場面

Active Directoryで指定したドメイン内に登録されているユーザーのユーザープリンシパル名の一覧を取得する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) Active Directory ドメイン サービス

　(2) DNS サーバー

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバ内前提製品の使用条件】

　なし。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) 出力ファイルのパス(common.outputFilePathプロパティ)に出力ファイル名と同名のファイルが既に存在する場合は上書きします。

実行権限

(1) 実行サーバに接続する際のユーザーは，管理者特権を持っている必要があります。

バージョン

02.00.00

部品のタグ

Gather Active Directory information,Windows,Active Directory

タスクログに表示される部品の名称

adGetUPN

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

Windows.domainName

ドメインの識別名

ユーザープリンシパル名の一覧を取得するドメインの識別名をDC=で始まる形式で指定します。

−　

入力

○　

Windows.portNumber

Active Directory接続用ポート番号

Active Directoryに接続するためのポート番号を指定します。指定がない場合は，LDAPのポート番号で接続します。

389

入力

△　

common.outputFilePath

出力ファイルのパス

出力するファイルをフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.4.9　Active DirectoryへのOU追加

機能

この部品は，指定したサーバのActive Directoryに対して，OU(Organizational Unit)を追加します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。前提条件に記載のActive Directoryがセットアップされている必要があります。

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

　dsadd ou

　　"OUの識別名(Windows.OUNameプロパティ)の値"

　　[-desc "説明(Windows.descriptionプロパティ)の値"]

　dsadd ouコマンドの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。

利用場面

Active DirectoryにOUを追加する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) Active Directory ドメイン サービス

　(2) DNS サーバー

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバ内前提製品の使用条件】

　なし。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

実行権限

(1) 実行サーバに接続する際のユーザーは，Active Directory ドメイン サービスのAccount Operators グループ，Domain Admins グループ，または Enterprise Admins グループのメンバーであるか，適切な権限を持っている必要があります。

バージョン

02.00.00

部品のタグ

Configure Active Directory,Windows,Active Directory

タスクログに表示される部品の名称

adAddOU

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

Windows.OUName

OUの識別名

追加するOUの識別名をOU=で始まる形式で指定します。

−　

入力

○　

Windows.description

説明

追加するOUの説明を指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.4.10　Active Directoryユーザーアカウントロック解除

機能

この部品は，指定したサーバのActive Directoryに対して，ドメインコントローラーが管理するユーザーアカウントのロックを解除してログオン可能な状態にします。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。前提条件に記載のActive Directoryがセットアップされている必要があります。

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

　net user "ユーザーアカウント名(Windows.userAccountNameプロパティ)の値"

　　　　　　/active

　　　　　　/domain

　net userコマンドの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。

利用場面

Active Directoryで，パスワード入力ミスなどでロックアウトされたユーザーアカウントのロック解除を行う場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) Active Directory ドメイン サービス

　(2) DNS サーバー

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバ内前提製品の使用条件】

　なし。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) この部品が異常終了してタスクログに「このコマンドの構文は次のとおりです:」と出力された場合，ユーザーアカウント名が誤っている可能性があります。ユーザーアカウント名を確認してください。

実行権限

(1) 実行サーバに接続する際のユーザーは，管理者特権を持っている必要があります。

バージョン

02.10.00

部品のタグ

Active Directory,Control Active Directory,Windows

タスクログに表示される部品の名称

adUnlockUserAccount

戻り値

戻り値

説明

0

正常

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

Windows.userAccountName

ユーザーアカウント名

ユーザーアカウント名を指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.4.11　Active Directoryユーザーのパスワード変更

機能

この部品は，指定したサーバのActive Directoryに対して，ユーザーのパスワードを変更します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。前提条件に記載のActive Directoryがセットアップされている必要があります。

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

　dsmod user

　　"ユーザーの識別名(Windows.userNameプロパティ)の値"

　　-pwd "パスワード(Windows.accountPasswordプロパティ)の値"

　dsmod userコマンドの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。

利用場面

Active Directoryでユーザーのパスワードを変更する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) Active Directory ドメイン サービス

　(2) DNS サーバー

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバ内前提製品の使用条件】

　なし。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) パスワード(Windows.accountPasswordプロパティ)およびパスワードの再入力(Windows.accountPasswordReEnterプロパティ)に空文字を指定することはできません。

(3) パスワード(Windows.accountPasswordプロパティ)に「*」(アスタリスク)だけを指定しないでください。

実行権限

(1) 実行サーバに接続する際のユーザーは，Active Directory ドメイン サービスのAccount Operators グループ，Domain Admins グループ，または Enterprise Admins グループのメンバーであるか，適切な権限を持っている必要があります。

バージョン

02.00.00

部品のタグ

Configure Active Directory,Windows,Active Directory

タスクログに表示される部品の名称

adChangePassword

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

Windows.userName

ユーザーの識別名

パスワードを変更するユーザーの識別名をCN=で始まる形式で指定します。

−　

入力

○　

Windows.accountPassword

パスワード

ユーザーの変更後のパスワードを指定します。

−　

入力

○　

Windows.accountPasswordReEnter

パスワードの再入力

ユーザーの変更後のパスワードを再入力します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.4.12　Active Directoryユーザー属性変更

機能

この部品は，指定したサーバのActive Directoryに対して，ユーザー属性を変更します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。前提条件に記載のActive Directoryがセットアップされている必要があります。

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

　dsmod user

　　"ユーザーの識別名(Windows.userNameプロパティ)の値"

　　[-upn "ユーザープリンシパル名(Windows.userPrincipalNameプロパティ)の値"]

　　[-fn "名(Windows.firstNameプロパティ)の値"]

　　[-mi "イニシャル(Windows.initialプロパティ)の値"]

　　[-ln "姓(Windows.lastNameプロパティ)の値"]

　　[-display "表示名(Windows.displayNameプロパティ)の値"]

　　[-empid "社員ID(Windows.employeeIDプロパティ)の値"]

　　[-desc "説明(Windows.descriptionプロパティ)の値"]

　　[-office "事業所(Windows.officeプロパティ)の値"]

　　[-tel "電話番号(Windows.officePhoneプロパティ)の値"]

　　[-email "電子メールアドレス(Windows.emailAddressプロパティ)の値"]

　　[-hometel "自宅電話番号(Windows.homePhoneプロパティ)の値"]

　　[-pager "ポケットベル番号(Windows.pagerNumberプロパティ)の値"]

　　[-mobile "携帯電話番号(Windows.mobilePhoneプロパティ)の値"]

　　[-fax "FAX番号(Windows.faxNumberプロパティ)の値"]

　　[-iptel "IP電話番号(Windows.ipPhoneプロパティ)の値"]

　　[-webpg "WebページURL(Windows.webURLプロパティ)の値"]

　　[-title "役職(Windows.titleプロパティ)の値"]

　　[-dept "所属部署(Windows.departmentプロパティ)の値"]

　　[-company "会社名(Windows.companyプロパティ)の値"]

　　[-mgr "上司の識別名(Windows.managerNameプロパティ)の値"]

　　[-hmdir "ホームフォルダー(Windows.homeFolderプロパティ)の値"]

　　[-hmdrv "ドライブレター(Windows.driveLetterプロパティ)の値"]

　　[-profile "プロファイルパス(Windows.profilePathプロパティ)の値"]

　　[-loscr "ログオンスクリプトパス(Windows.scriptPathプロパティ)の値"]

　　[-mustchpwd {yes|no}] ※1

　　[-canchpwd {yes|no}] ※2

　　[-reversiblepwd {yes|no}] ※3

　　[-pwdneverexpires {yes|no}] ※4

　　[-acctexpires "アカウント有効期限日数(Windows.expirationDateValueプロパティ)の値"]

　　[-disabled {yes|no}] ※5

　※1 次回ログオン時パスワード変更要否(Windows.nextPasswordChangeRequiredプロパティ)の値に"true"を指定した場合に"yes"，"false"を指定した場合に"no"が設定されます。"true"または"false"以外の値を指定した場合，このオプションは省略されます。

　※2 パスワード変更可否(Windows.enableChangePasswordプロパティ)の値に"true"を指定した場合に"yes"，"false"を指定した場合に"no"が設定されます。"true"または"false"以外の値を指定した場合，このオプションは省略されます。

　※3 暗号化復元可否(Windows.reversiblePasswordプロパティ)の値に"true"を指定した場合に"yes"，"false"を指定した場合に"no"が設定されます。"true"または"false"以外の値を指定した場合，このオプションは省略されます。

　※4 パスワード無期限化(Windows.indefinitePasswordプロパティ)の値に"true"を指定した場合に"yes"，"false"を指定した場合に"no"が設定されます。"true"または"false"以外の値を指定した場合，このオプションは省略されます。

　※5 アカウント無効化(Windows.disabledAccountプロパティ)の値"true"を指定した場合に"yes"，"false"を指定した場合に"no"が設定されます。"true"または"false"以外の値を指定した場合，このオプションは省略されます。

　dsmod userコマンドの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。

利用場面

Active Directoryでユーザー属性を変更する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) Active Directory ドメイン サービス

　(2) DNS サーバー

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバ内前提製品の使用条件】

　なし。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) 部品のプロパティに値を指定しなかった場合，その部品のプロパティに対応する属性値は変更されません。

(3) 部品で実行するスクリプトのコマンドラインの合計文字数が8191文字を超えた以降の文字は切り捨てられます。

実行権限

(1) 実行サーバに接続する際のユーザーは，Active Directory ドメイン サービスのAccount Operators グループ，Domain Admins グループ，または Enterprise Admins グループのメンバーであるか，適切な権限を持っている必要があります。

バージョン

02.00.00

部品のタグ

Configure Active Directory,Windows,Active Directory

タスクログに表示される部品の名称

adChangeUserAttribute

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

Windows.userName

ユーザーの識別名

属性変更するユーザーの識別名をCN=で始まる形式で指定します。

−　

入力

○　

Windows.userPrincipalName

ユーザープリンシパル名

ユーザーのユーザープリンシパル名を指定します。

−　

入力

△　

Windows.firstName

名

ユーザーの名前を指定します。

−　

入力

△　

Windows.initial

イニシャル

ユーザーのイニシャルを指定します。

−　

入力

△　

Windows.lastName

姓

ユーザーの姓を指定します。

−　

入力

△　

Windows.displayName

表示名

ユーザーの表示名を指定します。

−　

入力

△　

Windows.employeeID

社員ID

ユーザーの社員IDを指定します。

−　

入力

△　

Windows.description

説明

ユーザーの説明を指定します。

−　

入力

△　

Windows.office

事業所

ユーザーの事業所を指定します。

−　

入力

△　

Windows.officePhone

電話番号

ユーザーの電話番号を指定します。

−　

入力

△　

Windows.emailAddress

電子メールアドレス

ユーザーの電子メールアドレスを指定します。

−　

入力

△　

Windows.homePhone

自宅電話番号

ユーザーの自宅電話番号を指定します。

−　

入力

△　

Windows.pagerNumber

ポケットベル番号

ユーザーのポケットベル番号を指定します。

−　

入力

△　

Windows.mobilePhone

携帯電話番号

ユーザーの携帯電話番号を指定します。

−　

入力

△　

Windows.faxNumber

FAX番号

ユーザーのFAX番号を指定します。

−　

入力

△　

Windows.ipPhone

IP電話番号

ユーザーのIP電話番号を指定します。

−　

入力

△　

Windows.webURL

WebページURL

ユーザーのWebページのURLを指定します。

−　

入力

△　

Windows.title

役職

ユーザーの役職を指定します。

−　

入力

△　

Windows.department

所属部署

ユーザーの所属部署を指定します。

−　

入力

△　

Windows.company

会社名

ユーザーの会社名を指定します。

−　

入力

△　

Windows.managerName

上司の識別名

ユーザーの上司の識別名をCN=で始まる形式で指定します。

−　

入力

△　

Windows.homeFolder

ホームフォルダー

ユーザーのホームフォルダーのパスを指定します。

−　

入力

△　

Windows.driveLetter

ドライブレター

ホームフォルダーをUNCで指定した場合に，割り当てるドライブレターを「X:」の形式で指定します。

−　

入力

△　

Windows.profilePath

プロファイルパス

ユーザーのプロファイルパスを指定します。

−　

入力

△　

Windows.scriptPath

ログオンスクリプトパス

ユーザーのログオンスクリプトパスを指定します。

−　

入力

△　

Windows.nextPasswordChangeRequired

次回ログオン時パスワード変更要否

ユーザーが次にログオンするときにパスワードを変更する必要がある場合は"true"を，変更する必要がない場合は"false"を指定します。

−　

入力

△　

Windows.enableChangePassword

パスワード変更可否

ユーザーがパスワードを変更できるようにする場合は"true"を，変更できないようにする場合は"false"を指定します。

−　

入力

△　

Windows.reversiblePassword

暗号化を元に戻せる状態でパスワード保存

暗号化を元に戻せる状態でパスワードを保存する場合は"true"を，元に戻せない状態でパスワードを保存する場合は"false"を指定します。

−　

入力

△　

Windows.indefinitePassword

パスワード無期限化

パスワードを無期限にする場合は"true"を，期限を設定する場合は"false"を指定します。

−　

入力

△　

Windows.expirationDateValue

アカウント有効期限日数

アカウントの有効期限を部品を実行する日からの日数で指定します。"0"指定した場合，部品を実行した日の終わりに期限が切れます。

−　

入力

△　

Windows.disabledAccount

アカウント無効化

アカウントを無効化する場合は"true"を指定します。有効化する場合は，"false"を指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.4.13　Active Directoryユーザー追加

機能

この部品は，指定したサーバのActive Directoryに対して，ユーザーを追加します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。前提条件に記載のActive Directoryがセットアップされている必要があります。

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

　dsadd user

　　"ユーザーの識別名(Windows.userNameプロパティ)の値"

　　[-upn "ユーザープリンシパル名(Windows.userPrincipalNameプロパティ)の値"]

　　[-fn "名(Windows.firstNameプロパティ)の値"]

　　[-mi "イニシャル(Windows.initialプロパティ)の値"]

　　[-ln "姓(Windows.lastNameプロパティ)の値"]

　　[-display "表示名(Windows.displayNameプロパティ)の値"]

　　[-empid "社員ID(Windows.employeeIDプロパティ)の値"]

　　-pwd "パスワード(Windows.accountPasswordプロパティ)の値"

　　[-desc "説明(Windows.descriptionプロパティ)の値"]

　　[-memberof "所属先グループの識別名(Windows.memberOfプロパティ)の値"]

　　[-office "事業所(Windows.officeプロパティ)の値"]

　　[-tel "電話番号(Windows.officePhoneプロパティ)の値"]

　　[-email "電子メールアドレス(Windows.emailAddressプロパティ)の値"]

　　[-hometel "自宅電話番号(Windows.homePhoneプロパティ)の値"]

　　[-pager "ポケットベル番号(Windows.pagerNumberプロパティ)の値"]

　　[-mobile "携帯電話番号(Windows.mobilePhoneプロパティ)の値"]

　　[-fax "FAX番号(Windows.faxNumberプロパティ)の値"]

　　[-iptel "IP電話番号(Windows.ipPhoneプロパティ)の値"]

　　[-webpg "WebページURL(Windows.webURLプロパティ)の値"]

　　[-title "役職(Windows.titleプロパティ)の値"]

　　[-dept "所属部署(Windows.departmentプロパティ)の値"]

　　[-company "会社名(Windows.companyプロパティ)の値"]

　　[-mgr "上司の識別名(Windows.managerNameプロパティ)の値"]

　　[-hmdir "ホームフォルダー(Windows.homeFolderプロパティ)の値"]

　　[-hmdrv "ドライブレター(Windows.driveLetterプロパティ)の値"]

　　[-profile "プロファイルパス(Windows.profilePathプロパティ)の値"]

　　[-loscr "ログオンスクリプトパス(Windows.scriptPathプロパティ)の値"]

　　[-mustchpwd yes] ※1

　　[-canchpwd no] ※2

　　[-reversiblepwd yes] ※3

　　[-pwdneverexpires yes] ※4

　　[-acctexpires "アカウント有効期限日数(Windows.expirationDateValueプロパティ)の値"]

　　[-disabled yes] ※5

　※1 次回ログオン時パスワード変更要否(Windows.nextPasswordChangeRequiredプロパティ)の値に"true"を指定した場合に設定されます。

　※2 パスワード変更可否(Windows.enableChangePasswordプロパティ)の値に"true"以外を指定した場合に設定されます。

　※3 暗号化復元可否(Windows.reversiblePasswordプロパティ)の値に"true"を指定した場合に設定されます。

　※4 パスワード無期限化(Windows.indefinitePasswordプロパティ)の値に"true"を指定した場合に設定されます。

　※5 アカウント無効化(Windows.disabledAccountプロパティ)の値に"true"を指定した場合に設定されます。

　dsadd userコマンドの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。

利用場面

Active Directoryでユーザーを追加する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) Active Directory ドメイン サービス

　(2) DNS サーバー

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバ内前提製品の使用条件】

　なし。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) パスワード(Windows.accountPasswordプロパティ)に「*」(アスタリスク)だけを指定しないでください。

(3) 部品で実行するスクリプトのコマンドラインの合計文字数が8191文字を超えた以降の文字は切り捨てられます。

実行権限

(1) 実行サーバに接続する際のユーザーは，Active Directory ドメイン サービスのAccount Operators グループ，Domain Admins グループ，または Enterprise Admins グループのメンバーであるか，適切な権限を持っている必要があります。

バージョン

02.00.00

部品のタグ

Configure Active Directory,Windows,Active Directory

タスクログに表示される部品の名称

adAddUser

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

Windows.userName

ユーザーの識別名

追加するユーザーの識別名をCN=で始まる形式で指定します。

−　

入力

○　

Windows.userPrincipalName

ユーザープリンシパル名

ユーザーのユーザープリンシパル名を指定します。

−　

入力

△　

Windows.firstName

名

ユーザーの名前を指定します。

−　

入力

△　

Windows.initial

イニシャル

ユーザーのイニシャルを指定します。

−　

入力

△　

Windows.lastName

姓

ユーザーの姓を指定します。

−　

入力

△　

Windows.displayName

表示名

ユーザーの表示名を指定します。

−　

入力

△　

Windows.employeeID

社員ID

ユーザーの社員IDを指定します。

−　

入力

△　

Windows.accountPassword

パスワード

ユーザーのパスワードを指定します。

−　

入力

○　

Windows.description

説明

ユーザーの説明を指定します。

−　

入力

△　

Windows.memberOf

所属先グループの識別名

ユーザーが所属するグループの識別名をCN=で始まる形式で指定します。

−　

入力

△　

Windows.office

事業所

ユーザーの事業所を指定します。

−　

入力

△　

Windows.officePhone

電話番号

ユーザーの電話番号を指定します。

−　

入力

△　

Windows.emailAddress

電子メールアドレス

ユーザーの電子メールアドレスを指定します。

−　

入力

△　

Windows.homePhone

自宅電話番号

ユーザーの自宅電話番号を指定します。

−　

入力

△　

Windows.pagerNumber

ポケットベル番号

ユーザーのポケットベル番号を指定します。

−　

入力

△　

Windows.mobilePhone

携帯電話番号

ユーザーの携帯電話番号を指定します。

−　

入力

△　

Windows.faxNumber

FAX番号

ユーザーのFAX番号を指定します。

−　

入力

△　

Windows.ipPhone

IP電話番号

ユーザーのIP電話番号を指定します。

−　

入力

△　

Windows.webURL

WebページURL

ユーザーのWebページのURLを指定します。

−　

入力

△　

Windows.title

役職

ユーザーの役職を指定します。

−　

入力

△　

Windows.department

所属部署

ユーザーの所属部署を指定します。

−　

入力

△　

Windows.company

会社名

ユーザーの会社名を指定します。

−　

入力

△　

Windows.managerName

上司の識別名

ユーザーの上司の識別名をCN=で始まる形式で指定します。

−　

入力

△　

Windows.homeFolder

ホームフォルダー

ユーザーのホームフォルダーのパスを指定します。

−　

入力

△　

Windows.driveLetter

ドライブレター

ホームフォルダーをUNCで指定した場合に，割り当てるドライブレターを「X:」の形式で指定します。

−　

入力

△　

Windows.profilePath

プロファイルパス

ユーザーのプロファイルパスを指定します。

−　

入力

△　

Windows.scriptPath

ログオンスクリプトパス

ユーザーのログオンスクリプトパスを指定します。

−　

入力

△　

Windows.nextPasswordChangeRequired

次回ログオン時パスワード変更要否

ユーザーが次にログオンするときにパスワードを変更する必要がある場合は"true"を指定します。"true"以外の場合は，次回ログイン時にパスワードを変更する必要がありません。

−　

入力

△　

Windows.enableChangePassword

パスワード変更可否

ユーザーがパスワードを変更できるようにする場合は"true"を指定します。"true"以外の場合は，ユーザーがパスワードを変更できないようにします。

true

入力

△　

Windows.reversiblePassword

暗号化を元に戻せる状態でパスワード保存

暗号化を元に戻せる状態でパスワードを保存する場合は"true"を指定します。"true"以外の場合は，暗号化を元に戻せない状態でパスワードを保存します。

−　

入力

△　

Windows.indefinitePassword

パスワード無期限化

パスワードを無期限にする場合は"true"を指定します。"true"以外の場合は，パスワードに期限が設定されます。

−　

入力

△　

Windows.expirationDateValue

アカウント有効期限日数

アカウントの有効期限を部品を実行する日からの日数で指定します。"0"指定した場合，部品を実行した日の終わりに期限が切れます。

−　

入力

△　

Windows.disabledAccount

アカウント無効化

アカウントを無効化する場合は"true"を指定します。"true"以外の場合は，ユーザーアカウントは有効化されます。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.4.14　Active Directory既存グループからのメンバー削除

機能

この部品は，指定したサーバのActive Directoryに対して，既存グループからメンバーを削除します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。前提条件に記載のActive Directoryがセットアップされている必要があります。

この部品では，次に示すオブジェクトを削除するメンバーとして指定することができます。

　・グループ

　・ユーザー

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

　dsmod group

　　"グループの識別名(Windows.groupNameプロパティ)の値"

　　-rmmbr "メンバーの識別名(Windows.memberプロパティ)の値"

　dsmod groupコマンドの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。

利用場面

Active Directoryで既存グループからメンバーを削除する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) Active Directory ドメイン サービス

　(2) DNS サーバー

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバ内前提製品の使用条件】

　なし。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

実行権限

(1) 実行サーバに接続する際のユーザーは，Active Directory ドメイン サービスのAccount Operators グループ，Domain Admins グループ，または Enterprise Admins グループのメンバーであるか，適切な権限を持っている必要があります。

バージョン

02.00.00

部品のタグ

Configure Active Directory,Windows,Active Directory

タスクログに表示される部品の名称

adDeleteGroupMember

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

Windows.groupName

グループの識別名

メンバーを削除するグループの識別名をCN=で始まる形式で指定します。

−　

入力

○　

Windows.member

メンバーの識別名

グループから削除するメンバーの識別名をCN=で始まる形式で指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.4.15　Active Directory既存グループへのメンバー追加

機能

この部品は，指定したサーバのActive Directoryに対して，既存グループにメンバーを追加します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。前提条件に記載のActive Directoryがセットアップされている必要があります。

この部品では，次に示すオブジェクトを追加するメンバーとして指定することができます。

　・グループ

　・ユーザー

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

　dsmod group

　　"グループの識別名(Windows.groupNameプロパティ)の値"

　　-addmbr "メンバーの識別名(Windows.memberプロパティ)の値"

　dsmod groupコマンドの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。

利用場面

Active Directoryで既存グループにメンバーを追加する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) Active Directory ドメイン サービス

　(2) DNS サーバー

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバ内前提製品の使用条件】

　なし。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

実行権限

(1) 実行サーバに接続する際のユーザーは，Active Directory ドメイン サービスのAccount Operators グループ，Domain Admins グループ，または Enterprise Admins グループのメンバーであるか，適切な権限を持っている必要があります。

バージョン

02.00.00

部品のタグ

Configure Active Directory,Windows,Active Directory

タスクログに表示される部品の名称

adAddGroupMember

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

Windows.groupName

グループの識別名

メンバーを追加するグループの識別名をCN=で始まる形式で指定します。

−　

入力

○　

Windows.member

メンバーの識別名

グループへ追加するメンバーの識別名をCN=で始まる形式で指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.4.16　Active Directory連絡先属性変更

機能

この部品は，指定したサーバのActive Directoryに対して，連絡先属性を変更します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。前提条件に記載のActive Directoryがセットアップされている必要があります。

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

　dsmod contact

　　"連絡先の識別名(Windows.contactNameプロパティ)の値"

　　[-fn "名(Windows.firstNameプロパティ)の値"]

　　[-mi "イニシャル(Windows.initialプロパティ)の値"]

　　[-ln "姓(Windows.lastNameプロパティ)の値"]

　　[-display "表示名(Windows.displayNameプロパティ)の値"]

　　[-desc "説明(Windows.descriptionプロパティ)の値"]

　　[-office "事業所(Windows.officeプロパティ)の値"]

　　[-tel "電話番号(Windows.officePhoneプロパティ)の値"]

　　[-email "電子メールアドレス(Windows.emailAddressプロパティ)の値"]

　　[-hometel "自宅電話番号(Windows.homePhoneプロパティ)の値"]

　　[-pager "ポケットベル番号(Windows.pagerNumberプロパティ)の値"]

　　[-mobile "携帯電話番号(Windows.mobilePhoneプロパティ)の値"]

　　[-fax "FAX番号(Windows.faxNumberプロパティ)の値"]

　　[-iptel "IP電話番号(Windows.ipPhoneプロパティ)の値"]

　　[-title "役職(Windows.titleプロパティ)の値"]

　　[-dept "所属部署(Windows.departmentプロパティ)の値"]

　　[-company "会社名(Windows.companyプロパティ)の値"]

　dsmod contactコマンドの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。

利用場面

Active Directoryで連絡先属性を変更する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) Active Directory ドメイン サービス

　(2) DNS サーバー

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバ内前提製品の使用条件】

　なし。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) 部品のプロパティに値を指定しなかった場合，その部品のプロパティに対応する属性値は変更されません。

実行権限

(1) 実行サーバに接続する際のユーザーは，Active Directory ドメイン サービスのAccount Operators グループ，Domain Admins グループ，または Enterprise Admins グループのメンバーであるか，適切な権限を持っている必要があります。

バージョン

02.00.00

部品のタグ

Configure Active Directory,Windows,Active Directory

タスクログに表示される部品の名称

adChangeContactAttribute

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

Windows.contactName

連絡先の識別名

属性変更する連絡先の識別名をCN=で始まる形式で指定します。

−　

入力

○　

Windows.firstName

名

連絡先の名前を指定します。

−　

入力

△　

Windows.initial

イニシャル

連絡先のイニシャルを指定します。

−　

入力

△　

Windows.lastName

姓

連絡先の姓を指定します。

−　

入力

△　

Windows.displayName

表示名

連絡先の表示名を指定します。

−　

入力

△　

Windows.description

説明

連絡先の説明を指定します。

−　

入力

△　

Windows.office

事業所

連絡先の事業所を指定します。

−　

入力

△　

Windows.officePhone

電話番号

連絡先の電話番号を指定します。

−　

入力

△　

Windows.emailAddress

電子メールアドレス

連絡先の電子メールアドレスを指定します。

−　

入力

△　

Windows.homePhone

自宅電話番号

連絡先の自宅電話番号を指定します。

−　

入力

△　

Windows.pagerNumber

ポケットベル番号

連絡先のポケットベル番号を指定します。

−　

入力

△　

Windows.mobilePhone

携帯電話番号

連絡先の携帯電話番号を指定します。

−　

入力

△　

Windows.faxNumber

FAX番号

連絡先のFAX番号を指定します。

−　

入力

△　

Windows.ipPhone

IP電話番号

連絡先のIP電話番号を指定します。

−　

入力

△　

Windows.title

役職

連絡先の役職を指定します。

−　

入力

△　

Windows.department

所属部署

連絡先の所属部署を指定します。

−　

入力

△　

Windows.company

会社名

連絡先の会社名を指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.4.17　Active Directory連絡先追加

機能

この部品は，指定したサーバのActive Directoryに対して，連絡先を追加します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。前提条件に記載のActive Directoryがセットアップされている必要があります。

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

　dsadd contact

　　"連絡先の識別名(Windows.contactNameプロパティ)の値"

　　[-fn "名(Windows.firstNameプロパティ)の値"]

　　[-mi "イニシャル(Windows.initialプロパティ)の値"]

　　[-ln "姓(Windows.lastNameプロパティ)の値"]

　　[-display "表示名(Windows.displayNameプロパティ)の値"]

　　[-desc "説明(Windows.descriptionプロパティ)の値"]

　　[-office "事業所(Windows.officeプロパティ)の値"]

　　[-tel "電話番号(Windows.officePhoneプロパティ)の値"]

　　[-email "電子メールアドレス(Windows.emailAddressプロパティ)の値"]

　　[-hometel "自宅電話番号(Windows.homePhoneプロパティ)の値"]

　　[-pager "ポケットベル番号(Windows.pagerNumberプロパティ)の値"]

　　[-mobile "携帯電話番号(Windows.mobilePhoneプロパティ)の値"]

　　[-fax "FAX番号(Windows.faxNumberプロパティ)の値"]

　　[-iptel "IP電話番号(Windows.ipPhoneプロパティ)の値"]

　　[-title "役職(Windows.titleプロパティ)の値"]

　　[-dept "所属部署(Windows.departmentプロパティ)の値"]

　　[-company "会社名(Windows.companyプロパティ)の値"]

　dsadd contactコマンドの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。

利用場面

Active Directoryで連絡先を追加する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) Active Directory ドメイン サービス

　(2) DNS サーバー

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバ内前提製品の使用条件】

　なし。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

実行権限

(1) 実行サーバに接続する際のユーザーは，Active Directory ドメイン サービスのAccount Operators グループ，Domain Admins グループ，または Enterprise Admins グループのメンバーであるか，適切な権限を持っている必要があります。

バージョン

02.00.00

部品のタグ

Configure Active Directory,Windows,Active Directory

タスクログに表示される部品の名称

adAddContact

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

Windows.contactName

連絡先の識別名

追加する連絡先の識別名をCN=で始まる形式で指定します。

−　

入力

○　

Windows.firstName

名

連絡先の名前を指定します。

−　

入力

△　

Windows.initial

イニシャル

連絡先のイニシャルを指定します。

−　

入力

△　

Windows.lastName

姓

連絡先の姓を指定します。

−　

入力

△　

Windows.displayName

表示名

連絡先の表示名を指定します。

−　

入力

△　

Windows.description

説明

連絡先の説明を指定します。

−　

入力

△　

Windows.office

事業所

連絡先の事業所を指定します。

−　

入力

△　

Windows.officePhone

電話番号

連絡先の電話番号を指定します。

−　

入力

△　

Windows.emailAddress

電子メールアドレス

連絡先の電子メールアドレスを指定します。

−　

入力

△　

Windows.homePhone

自宅電話番号

連絡先の自宅電話番号を指定します。

−　

入力

△　

Windows.pagerNumber

ポケットベル番号

連絡先のポケットベル番号を指定します。

−　

入力

△　

Windows.mobilePhone

携帯電話番号

連絡先の携帯電話番号を指定します。

−　

入力

△　

Windows.faxNumber

FAX番号

連絡先のFAX番号を指定します。

−　

入力

△　

Windows.ipPhone

IP電話番号

連絡先のIP電話番号を指定します。

−　

入力

△　

Windows.title

役職

連絡先の役職を指定します。

−　

入力

△　

Windows.department

所属部署

連絡先の所属部署を指定します。

−　

入力

△　

Windows.company

会社名

連絡先の会社名を指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.5　JP1関連の部品

4.5.1　JP1サイレントインストール(UNIX)

機能

この部品は，UNIXの実行対象サーバで，Hitachi PP Installerの媒体に格納されているJP1製品をサイレントインストールします。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

この部品の適用範囲は「JP1 Version 11 以降」です。

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

　"インストーラーの媒体配置パス(JP1.mediaStoredPathプロパティ)の値/製品のプラットフォーム区分(JP1.productPlatformTypeプロパティ)の値/setup"

　　-f

　　-k "製品の型名(JP1.productModelプロパティ)の値"

　　"インストーラーの媒体配置パス(JP1.mediaStoredPathプロパティ)の値"

　setupコマンドの引数に指定する値については，インストールするJP1製品のリリースノート内でサイレントインストール機能によるインストール方法について記載している箇所を参照してください。

利用場面

Hitachi PP Installerの媒体に格納されているJP1製品をサイレントインストールする場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　インストールするJP1製品のリリースノートを参照してください。

【実行対象サーバの稼働OS】

　(1) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(2) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(3) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

　インストールするJP1製品のリリースノートを参照してください。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) パスを指定するプロパティに「 」(半角スペース)，「!」，「$」，「¥」，「`」を含む文字列は指定しないでください。

実行権限

(1) 実行サーバに接続する際のユーザーは，JP1製品をインストールするために必要な権限を持っている必要があります。

バージョン

02.01.00

部品のタグ

Configure JP1,Linux

タスクログに表示される部品の名称

jp1commonSilentInstall_Unix

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1.mediaStoredPath

インストーラーの媒体配置パス

日立総合インストーラーの媒体が配置されているパスをフルパスで指定します。

−　

入力

○　

JP1.productPlatformType

製品のプラットフォーム区分

インストールする製品のプラットフォーム区分を指定します。

−　

入力

○　

JP1.productModel

製品の形名

インストールする製品の形名を指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.5.2　JP1サイレントインストール(Windows)

機能

この部品は，Windowsの実行対象サーバで，日立総合インストーラーの媒体に格納されているJP1製品をサイレントインストールします。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

この部品の適用範囲は「JP1 Version 11 以降」です。

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

　"インストーラーの媒体配置パス(JP1.mediaStoredPathプロパティ)の値¥_OWNEXE¥HPPSINST.BAT"

　　/"製品のDISK1フォルダパス(JP1.productDisk1Pathプロパティ)の値"

　　/"製品のインストール先パス(JP1.productInstallPathプロパティ)の値"

　HPPSINST.BATの引数に指定する値については，インストールするJP1製品のリリースノート内でサイレントインストール機能によるインストール方法について記載している箇所を参照してください。

利用場面

日立総合インストーラーの媒体に格納されているJP1製品をサイレントインストールする場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　インストールするJP1製品のリリースノートを参照してください。

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバ内前提製品の使用条件】

　インストールするJP1製品のリリースノートを参照してください。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) パスを指定するプロパティに「!」，「%」を含む文字列は指定しないでください。

実行権限

(1) 実行サーバに接続する際のユーザーは，JP1製品をインストールするために必要な権限を持っている必要があります。

バージョン

02.01.00

部品のタグ

Configure JP1,Windows

タスクログに表示される部品の名称

jp1commonSilentInstall_Win

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1.mediaStoredPath

インストーラーの媒体配置パス

日立総合インストーラーの媒体が配置されているパスをフルパスで指定します。

−　

入力

○　

JP1.productDisk1Path

製品のDISK1フォルダパス

製品の媒体が格納されているDISK1のフォルダパスをフルパスで指定します。

−　

入力

○　

JP1.productInstallPath

製品のインストール先パス

製品のインストール先パスをフルパスで指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.5.3　JP1修正パッチ適用(UNIX)

機能

この部品は，UNIXの実行対象サーバで，インストールされているJP1製品の修正パッチを適用します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

この部品の適用範囲は「JP1 Version 11 以降」です。

この部品内のスクリプトでは次のコマンドを実行します。

　・mkdir

　　-p 修正パッチの展開先ディレクトリパス(JP1.patchDestDirPathプロパティ)

　・tar

　　zxf 修正パッチのファイルパス(JP1.patchSourceFilePathプロパティ)

　　-C 修正パッチの展開先ディレクトリパス(JP1.patchDestDirPathプロパティ)

　・UPDATE

　　-f

　　-D 出力ファイルのパス(common.outputLogFileプロパティ)

修正パッチによってはパッチ適用時に，OS再起動などの操作が別途必要となる場合があります。修正パッチ同梱のドキュメントRELEASE.TXT「適用手順および操作方法」を確認してください。

修正パッチの展開先ディレクトリパス(JP1.patchDestDirPathプロパティ)で指定したパス先のファイルおよびディレクトリについては，削除されません。

利用場面

JP1製品の修正パッチを適用する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　修正パッチ同梱のドキュメント，および修正パッチを適用するJP1製品のリリースノートを参照してください。

【実行対象サーバの稼働OS】

　(1) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(2) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(3) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

　修正パッチ同梱のドキュメント，および修正パッチを適用するJP1製品のリリースノートを参照してください。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) パスを指定するプロパティに「 」(半角スペース)，「!」，「$」，「¥」，「`」を含む文字列は指定しないでください。

実行権限

(1) 実行サーバに接続する際のユーザーは，修正パッチを適用するために必要な権限を持っている必要があります。

バージョン

02.01.00

部品のタグ

Configure JP1,Linux

タスクログに表示される部品の名称

jp1commonApplyPatch_Unix

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

14

異常(ユーザーミス) ファイルアクセス不可

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1.patchSourceFilePath

修正パッチのファイルパス

修正パッチのファイルパスをフルパスで指定します。

−　

入力

○　

JP1.patchDestDirPath

修正パッチの展開先ディレクトリパス

修正パッチの展開先ディレクトリパスをフルパスで指定します。

−　

入力

○　

common.outputLogFile

出力ファイルのパス

出力するログファイルをフルパスで指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.5.4　JP1修正パッチ適用(Windows)

機能

この部品は，Windowsの実行対象サーバで，インストールされているJP1製品の修正パッチを適用します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

この部品の適用範囲は「JP1 Version 11 以降」です。

この部品内のスクリプトでは次のコマンドを実行します。

　・MKDIR

　　修正パッチの展開先フォルダパス(JP1.patchDestFolderPathプロパティ)

　・修正パッチのファイルパス(JP1.patchSourceFilePathプロパティ)に記述したEXEファイル

　　-D修正パッチの展開先フォルダパス(JP1.patchDestFolderPathプロパティ)

　・SETUP.EXE

　　/s

　　/D 出力ファイルのパス(common.outputLogFileプロパティ)

修正パッチによってはパッチ適用時に，OS再起動などの操作が別途必要となる場合があります。修正パッチ同梱のドキュメントRELEASE.TXT「適用手順および操作方法」を確認してください

修正パッチの展開先フォルダパス(JP1.patchDestFolderPathプロパティ)で指定したパス先のファイルおよびフォルダについては，削除されません。

利用場面

JP1製品の修正パッチを適用する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　修正パッチ同梱のドキュメント，および修正パッチを適用するJP1製品のリリースノートを参照してください。

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバ内前提製品の使用条件】

　修正パッチ同梱のドキュメント，および修正パッチを適用するJP1製品のリリースノートを参照してください。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) パスを指定するプロパティに「!」，「%」を含む文字列は指定しないでください。

実行権限

(1) 実行サーバに接続する際のユーザーは，修正パッチを適用するために必要な権限を持っている必要があります。

バージョン

02.01.00

部品のタグ

Configure JP1,Windows

タスクログに表示される部品の名称

jp1commonApplyPatch_Win

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

14

異常(ユーザーミス) ファイルアクセス不可

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1.patchSourceFilePath

修正パッチのファイルパス

修正パッチのファイルパスをフルパスで指定します。

−　

入力

○　

JP1.patchDestFolderPath

修正パッチの展開先フォルダパス

修正パッチの展開先フォルダパスをフルパスで指定します。

−　

入力

○　

common.outputLogFile

出力ファイルのパス

出力するログファイルをフルパスで指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.6　JP1/AJS関連の部品

4.6.1　JP1/AJSジョブネット確定実行登録

機能

この部品は，指定したサーバのJP1/AJS3 - Manager (またはJP1/AJS2 - Manager，以降まとめてJP1/AJSと呼びます)に対してジョブネットを確定実行登録します。

この部品が前提とするサーバを次に示します。

・業務サーバ(実行対象サーバ)

　JP1/AJSのジョブネットを実行するサーバです。前提条件に記載のJP1/AJSがセットアップされている必要があります。

この部品ではジョブネットの確定実行登録だけを行えます。

・ジョブネットを特定の日時に実行(日時指定)する場合

　　確定実行日付と確定実行時間を指定します。

・ジョブネットの実行予定世代数を指定して実行(未来世代数指定)する場合

　　未来予定世代数を指定します。

どちらかを必ず指定してください。

実行前に確定実行日付と確定実行時間の様式をチェックします。

利用場面

作成済みのジョブネットに対して次の方法で確定実行登録を行えます。

　・確定実行日付と確定実行時間を指定(日時指定)して，確定実行登録を行う。

　・未来予定世代数を指定(未来世代数指定)して，確定実行登録を行う。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Automatic Job Management System 3 - Manager 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) AIX V6

　(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

　(1) 実行登録対象のジョブネットが作成されていること。

　(2) 実行登録するジョブネットのカレンダー，スケジュールルールが定義されていること。

　(3) JP1AJS.executeJP1UserNameプロパティには，実行対象サーバでジョブネットの実行登録を行うためのJP1ユーザー名を指定してください。JP1/AOから接続するOSユーザーと同一名称のJP1ユーザーで実行登録を行う場合は，このプロパティに値を指定する必要はありません。

　(4) クラスタ構成の論理ホスト上に定義されているジョブネットを登録する場合は，

　・plugin.destinationHostプロパティに実行系サーバの物理ホスト名または論理ホスト名を指定してください。

　・JP1AJS.serviceNameプロパティに論理ホストで動作しているスケジューラーサービス名を指定してください。

　・JP1.logicalHostNameプロパティにスケジューラーサービスが動作している論理ホスト名を指定してください。

　(5) 業務サーバのOSがUNIXの場合，業務サーバのJP1/AJSの環境設定パラメタの文字コード設定と業務サーバへの接続ユーザーのデフォルトロケールの設定を一致させてください。

注意事項

(1) JP1AJS.serviceNameプロパティに設定するスケジューラーサービス名は30バイト以内となるよう指定してください。

(2) 特定の日時を指定(日時指定)するときは，JP1AJS.executeDateプロパティとJP1AJS.executeTimeプロパティを共に指定します。

(3) その他の注意事項については，JP1/AJSのマニュアル「コマンドリファレンス1」のajsentryコマンドの注意事項を参照してください。

実行権限

・業務サーバに接続するOSユーザーにマッピングされているJP1ユーザーが，実行登録対象のジョブネットに対して操作権限を持っていること。

・業務サーバに接続する際のOSユーザーにマッピングされているJP1ユーザーが存在しない場合，jp1ajs.executeJP1UserNameプロパティに実行登録対象のジョブネットに対して操作権限を持つJP1ユーザーを指定してください。

バージョン

02.00.00

部品のタグ

Configure JP1,AJS,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1ajsRegisterFixedExecution

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認) 識別できないエラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1AJS.serviceName

JP1/AJSサービス名

スケジューラーのサービス名を指定します。

−　

入力

△　

JP1AJS.entryJobnetName

ジョブネット名

実行登録，または実行予実績を出力するジョブネットの名称を完全名で指定します。マネージャージョブグループ名とマネージャージョブネット名は指定できません。

−　

入力

○　

JP1AJS.macroParameter

JP1/AJSマクロ変数

JP1/AJSのマクロ変数と値を":"で結合して指定します。

コンマ区切りで複数指定可能です。32個まで指定できます。

(例)AJS2AA:5,AJS2BB:test

−　

入力

△　

JP1AJS.executeJP1UserName

ジョブネットを確定実行登録するためのAJSコマンドを実行するJP1ユーザー名

ジョブネットを確定実行登録するためにAJSコマンドを実行する際のJP1ユーザー名を指定します。実行対象サーバに接続する際のOSユーザー名と同一のJP1ユーザーで実行する場合，指定する必要はありません。

−　

入力

△　

JP1AJS.executeDate

ジョブネットの確定実行日付

ジョブネットを確定実行登録するときの確定実行日付を-または/で区切って，YYYY-MM-DDまたはYYYY/MM/DDの形式で指定します。

−　

入力

△　

JP1AJS.executeTime

ジョブネットの確定実行時間(hh:mm)

ジョブネットを確定実行登録するときの確定実行時刻を：で区切って，hh:mmの形式で指定します。:分は省略できます。省略時は0分が仮定されます。

−　

入力

△　

JP1AJS.executeGenerattion

ジョブネットの未来予定世代数

ジョブネットを確定実行登録するときの，次回以降の実行予定世代数を指定します。

−　

入力

△　

JP1AJS.executePrior

スケジューラーサービス停止中の予定実行要否

スケジューラーサービス停止中に実行予定の日時が経過した時，スケジューラーサービスが再起動した時に経過した実行予定を実行するか，次の実行予定から実行するかを指定します。

(true:経過した実行予定を実行する，false:次の実行予定から実行する)

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.6.2　JP1/AJSジョブネット強制終了

機能

この部品は，指定したサーバのJP1/AJS3 - Manager (またはJP1/AJS2 - Manager，以降まとめてJP1/AJSと呼びます)に対して，ジョブネットまたはジョブの強制終了を行います。

この部品が前提とするサーバを次に示します。

・業務サーバ(実行対象サーバ)

　JP1/AJSのジョブネットを実行するサーバです。前提条件に記載のJP1/AJSがセットアップされている必要があります。

この部品ではジョブネットまたはジョブを強制終了する指示だけを行えます。

この部品を実行したあとのジョブネットの状態を確認する場合は，JP1/AJSのジョブネット実行結果取得(jp1ajsCheck部品)を使用して結果を取得する必要があります。

この部品内のスクリプトでは次に示す処理を行います。

・業務サーバの論理ホスト名(JP1.logicalHostNameプロパティ)に値が指定されていた場合，その値をJP1_HOSTNAME環境変数に設定します。

・JP1ユーザー名(JP1AJS.jp1UserNameプロパティ)に値が指定されていた場合，その値をJP1_USERNAME環境変数に設定します。

・次のコマンドを実行します。

　ajskill [-F "JP1/AJSサービス名(JP1AJS.serviceNameプロパティ)の値"]

　　　　　[-B "実行登録番号(JP1AJS.execRegistrationNumberプロパティ)の値"]

　　　　　"ユニット名(JP1AJS.unitNameプロパティ)の値" ※

　※ [[スケジューラーサービス名]:]ユニット名[:@実行ID]の形式で指定してください。

　ajskillコマンドの詳細については，JP1/AJSのマニュアル「コマンドリファレンス１」を参照してください。

利用場面

JP1/AJSのジョブネットまたはジョブの実行を強制終了する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) JP1/Automatic Job Management System 3 - Manager 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

　(1) JP1ユーザー名(JP1AJS.jp1UserNameプロパティ)には，実行対象サーバでジョブネットの強制終了を行うためのJP1ユーザー名を指定してください。本製品から接続するOSユーザーと同一名のJP1ユーザーで強制終了を行う場合は，このプロパティに値を指定する必要はありません。

　(2) クラスタ構成の論理ホスト上に定義されているジョブネットの強制終了を行う場合は，

　・実行対象サーバのホスト名(plugin.destinationHostプロパティ)に実行系サーバの物理ホスト名または論理ホスト名を指定してください。

　・実行対象サーバの論理ホスト名(JP1.logicalHostNameプロパティ)にスケジューラーサービスが動作している論理ホスト名を指定してください。

　・JP1/AJSサービス名(JP1AJS.serviceNameプロパティ)に論理ホストで動作しているスケジューラーサービス名を指定してください。

　(3) 業務サーバのOSがUNIXの場合，業務サーバのJP1/AJSの環境設定パラメタの文字コード設定と業務サーバへの接続ユーザーのデフォルトロケールの設定を一致させてください。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) ユニット名(JP1AJS.unitNameプロパティ)に「¥」(円記号)でキャストした記号文字(「&」「*」「<」「>」「?」「[」「¥」「]」「^」「'」「{」「｜」「}」「~」)を含む文字列を指定した場合でも，プロパティの両端を「"」(ダブルクォーテーション)で囲む必要はありません。

(3) ユニット名(JP1AJS.unitNameプロパティ)には強制終了するジョブネット名またはジョブ名を明示的に指定してください。総称名を表す記号(「*」「?」「[」「]」)を含む文字列は指定しないでください。

(4) その他の注意事項については，JP1/AJSのマニュアル「操作ガイド」の「実行中のジョブネットやジョブを強制終了する」の注意事項，およびJP1/AJSのマニュアル「コマンドリファレンス１」のajskillコマンドの注意事項を参照してください。

実行権限

(1) 業務サーバに接続するOSユーザーにマッピングされているJP1ユーザーが，操作対象のジョブネットに対して操作権限を持っている必要があります。

(2) 業務サーバに接続する際のOSユーザーにマッピングされているJP1ユーザーが存在しない場合，JP1ユーザー名(JP1AJS.jp1UserNameプロパティ)に操作対象のジョブネットに対して操作権限を持つJP1ユーザーを指定してください。

バージョン

02.00.00

部品のタグ

Control JP1,AJS,Windows,Linux

タスクログに表示される部品の名称

jp1ajsKillExecution

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1AJS.jp1UserName

JP1ユーザー名

JP1ユーザー名を指定します。実行対象サーバに接続する際のOSユーザー名と同一のJP1ユーザーで実行する場合，指定する必要はありません。

−　

入力

△　

JP1AJS.serviceName

JP1/AJSサービス名

スケジューラーのサービス名を指定します。

−　

入力

△　

JP1AJS.unitName

ユニット名

強制終了するジョブネット名またはジョブ名を指定します。

−　

入力

○　

JP1AJS.execRegistrationNumber

実行登録番号

強制終了するジョブネットまたはジョブの実行登録番号を「YYYYMMDDNNN」の形式で指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.6.3　JP1/AJSジョブネット計画実行登録

機能

この部品は，指定したサーバのJP1/AJS3 - Manager (またはJP1/AJS2 - Manager，以降まとめてJP1/AJSと呼びます)に対してジョブネットを計画実行登録します。

この部品が前提とするサーバを次に示します。

・業務サーバ(実行対象サーバ)

　JP1/AJSのジョブネットを実行するサーバです。前提条件に記載のJP1/AJSがセットアップされている必要があります。

　事前に実行登録するジョブネットのカレンダー，スケジュールルールを定義しておく必要があります。

この部品ではジョブネットの計画実行登録だけを行えます。

利用場面

作成済みのジョブネットに対して計画実行登録を行います。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Automatic Job Management System 3 - Manager 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) AIX V6

　(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

　(1) 実行登録対象のジョブネットが作成されていること。

　(2) 実行登録するジョブネットのカレンダー，スケジュールルールが定義されていること。

　(3) JP1AJS.executeJP1UserNameプロパティには，実行対象サーバでジョブネットの実行登録を行うためのJP1ユーザー名を指定してください。JP1/AOから接続するOSユーザーと同一名のJP1ユーザーで実行登録を行う場合は，このプロパティに値を指定する必要はありません。

　(4) クラスタ構成の論理ホスト上に定義されているジョブネットを登録する場合は，

　・plugin.destinationHostプロパティに実行系サーバの物理ホスト名または論理ホスト名を指定してください。

　・JP1AJS.serviceNameプロパティに論理ホストで動作しているスケジューラーサービス名を指定してください。

　・JP1.logicalHostNameプロパティにスケジューラーサービスが動作している論理ホスト名を指定してください。

　(5) 業務サーバのOSがUNIXの場合，業務サーバのJP1/AJSの環境設定パラメタの文字コード設定と業務サーバへの接続ユーザーのデフォルトロケールの設定を一致させてください。

注意事項

(1) JP1AJS.serviceNameプロパティに設定するスケジューラーサービス名は30バイト以内となるよう指定してください。

(2) その他の注意事項については，JP1/AJSのマニュアル「コマンドリファレンス１」のajsentryコマンドの注意事項を参照してください。

実行権限

・業務サーバに接続するOSユーザーにマッピングされているJP1ユーザーが，実行登録対象のジョブネットに対して操作権限を持っていること。

・業務サーバに接続する際のOSユーザーにマッピングされているJP1ユーザーが存在しない場合，jp1ajs.executeJP1UserNameプロパティに実行登録対象のジョブネットに対して操作権限を持つJP1ユーザーを指定してください。

バージョン

02.00.00

部品のタグ

Configure JP1,AJS,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1ajsRegisterPlannedExecution

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認) 識別できないエラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1AJS.serviceName

JP1/AJSサービス名

スケジューラーのサービス名を指定します。

−　

入力

△　

JP1AJS.entryJobnetName

ジョブネット名

実行登録，または実行予実績を出力するジョブネットの名称を完全名で指定します。マネージャージョブグループ名とマネージャージョブネット名は指定できません。

−　

入力

○　

JP1AJS.macroParameter

JP1/AJSマクロ変数

JP1/AJSのマクロ変数と値を":"で結合して指定します。

コンマ区切りで複数指定可能です。32個まで指定できます。

(例)AJS2AA:5,AJS2BB:test

−　

入力

△　

JP1AJS.executeJP1UserName

ジョブネットを計画実行登録するためのAJSコマンドを実行するJP1ユーザー名

ジョブネットを計画実行登録するためにAJSコマンドを実行する際のJP1ユーザー名を指定します。実行対象サーバに接続する際のOSユーザー名と同一のJP1ユーザーで実行する場合，指定する必要はありません。

−　

入力

△　

JP1AJS.executePrior

スケジューラーサービス停止中の予定実行要否

スケジューラーサービス停止中に実行予定の日時が経過した時，スケジューラーサービスが再起動した時に経過した実行予定を実行するか，次の実行予定から実行するかを指定します。

(true:経過した実行予定を実行する，false:次の実行予定から実行する)

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.6.4　JP1/AJSジョブネット再実行

機能

この部品は，指定したサーバのJP1/AJS3 - Manager (またはJP1/AJS2 - Manager，以降まとめてJP1/AJSと呼びます)に対して，ジョブネットまたはジョブの再実行を行います。

この部品が前提とするサーバを次に示します。

・業務サーバ(実行対象サーバ)

　JP1/AJSのジョブネットを実行するサーバです。前提条件に記載のJP1/AJSがセットアップされている必要があります。

この部品ではジョブネットまたはジョブを再実行する指示だけを行えます。

この部品を実行したあとのジョブネットの状態を確認する場合は，JP1/AJSのジョブネット実行結果取得(jp1ajsCheck部品)を使用して結果を取得する必要があります。

この部品内のスクリプトでは次に示す処理を行います。

・業務サーバの論理ホスト名(JP1.logicalHostNameプロパティ)に値が指定されていた場合，その値をJP1_HOSTNAME環境変数に設定します。

・JP1ユーザー名(JP1AJS.jp1UserNameプロパティ)に値が指定されていた場合，その値をJP1_USERNAME環境変数に設定します。

・次のコマンドを実行します。

　ajsrerun [-F "JP1/AJSサービス名(JP1AJS.serviceNameプロパティ)の値"]

　　　　　 [-B "実行登録番号(JP1AJS.execRegistrationNumberプロパティ)の値"]

　　　　　 {-t|-s|-n|-a|-w|-f|-p|-e} ※1

　　　　　 [-h] ※2

　　　　　 [-c] ※3

　　　　　 "ユニット名(JP1AJS.unitNameプロパティ)の値" ※4

　※1 再実行方法(JP1AJS.rerunMethodプロパティ)の値に対応したオプションが設定されます。

　　　"FromTop"の場合: -t (ジョブネットを先頭から再実行)

　　　"FromAbnormallyJobnet"の場合: -s (異常終了したジョブが含まれるジョブネットを先頭から再実行)

　　　"FromAfterAbnormallyJob"の場合: -n (異常終了したジョブの次のジョブから再実行)

　　　"FromAbnormallyJob"の場合: -a (異常終了したジョブから再実行)

　　　"OnlyWarningJob"の場合: -w (警告検出終了しているジョブを再実行)

　　　"FromSpecifiedUnit"の場合: -f (指定したジョブネット，またはジョブから再実行)

　　　"OnlySpecifiedUnit"の場合: -p (指定したジョブネット，またはジョブを再実行)

　　　"FromAfterSpecifiedUnit"の場合: -e (指定したジョブネット，またはジョブの次から再実行)

　※2 保留状態の設定要否(JP1AJS.rerunWithHoldプロパティ)に"true"を指定した場合に設定されます。

　※3 警告検出終了への変更要否(JP1AJS.setSkippedJobsToWarningプロパティ)に"true"を指定した場合に設定されます。

　※4 [[スケジューラーサービス名]:]ユニット名[:@実行ID]の形式で指定してください。

　ajsrerunコマンドの詳細については，JP1/AJSのマニュアル「コマンドリファレンス１」を参照してください。

利用場面

JP1/AJSのジョブネットまたはジョブを再実行する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) JP1/Automatic Job Management System 3 - Manager 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

　(1) JP1ユーザー名(JP1AJS.jp1UserNameプロパティ)には，実行対象サーバでジョブネットの再実行を行うためのJP1ユーザー名を指定してください。本製品から接続するOSユーザーと同一名のJP1ユーザーで再実行を行う場合は，このプロパティに値を指定する必要はありません。

　(2) クラスタ構成の論理ホスト上に定義されているジョブネットの再実行を行う場合は，

　・実行対象サーバのホスト名(plugin.destinationHostプロパティ)に実行系サーバの物理ホスト名または論理ホスト名を指定してください。

　・実行対象サーバの論理ホスト名(JP1.logicalHostNameプロパティ)にスケジューラーサービスが動作している論理ホスト名を指定してください。

　・JP1/AJSサービス名(JP1AJS.serviceNameプロパティ)に論理ホストで動作しているスケジューラーサービス名を指定してください。

　(3) 業務サーバのOSがUNIXの場合，業務サーバのJP1/AJSの環境設定パラメタの文字コード設定と業務サーバへの接続ユーザーのデフォルトロケールの設定を一致させてください。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) ユニット名(JP1AJS.unitNameプロパティ)に「¥」(円記号)でキャストした記号文字(「&」「*」「<」「>」「?」「[」「¥」「]」「^」「'」「{」「｜」「}」「~」)を含む文字列を指定した場合でも，プロパティの両端を「"」(ダブルクォーテーション)で囲む必要はありません。

(3) ユニット名(JP1AJS.unitNameプロパティ)には再実行するジョブネット名またはジョブ名を明示的に指定してください。総称名を表す記号(「*」「?」「[」「]」)を含む文字列は指定しないでください。

(4) その他の注意事項については，JP1/AJSのマニュアル「コマンドリファレンス１」のajsrerunコマンドの注意事項を参照してください。

実行権限

(1) 業務サーバに接続するOSユーザーにマッピングされているJP1ユーザーが，操作対象のジョブネットに対して操作権限を持っている必要があります。

(2) 業務サーバに接続する際のOSユーザーにマッピングされているJP1ユーザーが存在しない場合，JP1ユーザー名(JP1AJS.jp1UserNameプロパティ)に操作対象のジョブネットに対して操作権限を持つJP1ユーザーを指定してください。

バージョン

02.00.01

部品のタグ

Control JP1,AJS,Windows,Linux

タスクログに表示される部品の名称

jp1ajsRerun

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1AJS.jp1UserName

JP1ユーザー名

JP1ユーザー名を指定します。実行対象サーバに接続する際のOSユーザー名と同一のJP1ユーザーで実行する場合，指定する必要はありません。

−　

入力

△　

JP1AJS.serviceName

JP1/AJSサービス名

スケジューラーのサービス名を指定します。

−　

入力

△　

JP1AJS.unitName

ユニット名

再実行するジョブネット名またはジョブ名を指定します。

−　

入力

○　

JP1AJS.execRegistrationNumber

実行登録番号

再実行するジョブネットまたはジョブの実行登録番号を「YYYYMMDDNNN」の形式で指定します。

−　

入力

△　

JP1AJS.rerunMethod

再実行方法

ジョブネットまたはジョブの再実行方法を指定します。指定可能な値は，"FromTop"，"FromAbnormallyJobnet"，"FromAfterAbnormallyJob"，"FromAbnormallyJob"，"OnlyWarningJob"，"FromSpecifiedUnit"，"OnlySpecifiedUnit"，"FromAfterSpecifiedUnit"です。省略した場合，"FromAbnormallyJob"が仮定されます。

−　

入力

△　

JP1AJS.rerunWithHold

保留状態の設定要否

再実行するジョブネットまたはジョブを保留状態にする場合は"true"を指定します。"true"以外の場合は，保留状態にせずに処理を継続します。

−　

入力

△　

JP1AJS.setSkippedJobsToWarning

警告検出終了への変更要否

異常状態の先行ジョブネットまたは先行ジョブの終了状態を警告検出終了にする場合は"true"を指定します。"true"以外の場合は，警告検出終了にせずに処理を継続します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.6.5　JP1/AJSジョブネット実行スケジュール変更

機能

この部品は，指定したサーバのJP1/AJS3 - Manager (またはJP1/AJS2 - Manager，以降まとめてJP1/AJSと呼びます)に対して，ジョブネットの実行開始日時を一時的に変更するか，またはジョブネットの即時実行を行います。

ジョブネットの実行開始日時を一時的に変更したい場合は，スケジュール変更操作(JP1AJS.scheduleChangeOperationプロパティ)に"ChangeTime"を指定します。

ジョブネットを即時実行したい場合は，スケジュール変更操作(JP1AJS.scheduleChangeOperationプロパティ)に"ExecuteImmediately"を指定します。

この部品が前提とするサーバを次に示します。

・業務サーバ(実行対象サーバ)

　JP1/AJSのジョブネットを実行するサーバです。前提条件に記載のJP1/AJSがセットアップされている必要があります。

ジョブネットの即時実行を行う場合，この部品ではジョブネットを即時実行する指示だけを行えます。

この部品を実行したあとのジョブネットの状態を確認する場合は，JP1/AJSのジョブネット実行結果取得(jp1ajsCheck部品)を使用して結果を取得する必要があります。

この部品内のスクリプトでは次に示す処理を行います。

・業務サーバの論理ホスト名(JP1.logicalHostNameプロパティ)に値が指定されていた場合，その値をJP1_HOSTNAME環境変数に設定します。

・JP1ユーザー名(JP1AJS.jp1UserNameプロパティ)に値が指定されていた場合，その値をJP1_USERNAME環境変数に設定します。

・次のコマンドを実行します。

　(a) スケジュール変更操作(JP1AJS.scheduleChangeOperationプロパティ)に"ChangeTime"を指定した場合

　　　ajsplan [-F "JP1/AJSサービス名(JP1AJS.serviceNameプロパティ)の値"]

　　　　　　　[-B "実行登録番号(JP1AJS.execRegistrationNumberプロパティ)の値"]

　　　　　　　[-d "実行開始日(JP1AJS.nextExecutionDateプロパティ)の値"]

　　　　　　　[-t "実行開始時刻(JP1AJS.nextExecutionTimeプロパティ)の値"]

　　　　　　　[-p] ※1

　　　　　　　[-i] ※2

　　　　　　　"ジョブネット名(JP1AJS.jobnetNameプロパティ)の値" ※3

　(b) スケジュール変更操作(JP1AJS.scheduleChangeOperationプロパティ)に"ExecuteImmediately"を指定した場合

　　　ajsplan [-F "JP1/AJSサービス名(JP1AJS.serviceNameプロパティ)の値"]

　　　　　　　[-B "実行登録番号(JP1AJS.execRegistrationNumberプロパティ)の値"]

　　　　　　　-q

　　　　　　　[-p] ※1

　　　　　　　[-i] ※2

　　　　　　　"ジョブネット名(JP1AJS.jobnetNameプロパティ)の値" ※3

　※1 次回実行予定の取り消し要否(JP1AJS.cancelNextExecutionプロパティ)に"true"を指定した場合に設定されます。

　※2 配下の開始日時の変更要否(JP1AJS.changeLowerJobnetsプロパティ)に"true"を指定した場合に設定されます。

　※3 [[スケジューラーサービス名]:]ジョブネット名[:@実行ID]の形式で指定してください。

　ajsplanコマンドの詳細については，JP1/AJSのマニュアル「コマンドリファレンス１」を参照してください。

利用場面

JP1/AJSのジョブネットの実行スケジュールを一時的に変更する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) JP1/Automatic Job Management System 3 - Manager 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

　(1) JP1ユーザー名(JP1AJS.jp1UserNameプロパティ)には，実行対象サーバでジョブネットの実行スケジュール変更を行うためのJP1ユーザー名を指定してください。本製品から接続するOSユーザーと同一名のJP1ユーザーで実行スケジュール変更を行う場合は，このプロパティに値を指定する必要はありません。

　(2) クラスタ構成の論理ホスト上に定義されているジョブネットの実行スケジュール変更を行う場合は，

　・実行対象サーバのホスト名(plugin.destinationHostプロパティ)に実行系サーバの物理ホスト名または論理ホスト名を指定してください。

　・実行対象サーバの論理ホスト名(JP1.logicalHostNameプロパティ)にスケジューラーサービスが動作している論理ホスト名を指定してください。

　・JP1/AJSサービス名(JP1AJS.serviceNameプロパティ)に論理ホストで動作しているスケジューラーサービス名を指定してください。

　(3) 業務サーバのOSがUNIXの場合，業務サーバのJP1/AJSの環境設定パラメタの文字コード設定と業務サーバへの接続ユーザーのデフォルトロケールの設定を一致させてください。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) ジョブネット名(JP1AJS.jobnetNameプロパティ)に「¥」(円記号)でキャストした記号文字(「&」「*」「<」「>」「?」「[」「¥」「]」「^」「'」「{」「｜」「}」「~」)を含む文字列を指定した場合でも，プロパティの両端を「"」(ダブルクォーテーション)で囲む必要はありません。

(3) ジョブネット名(JP1AJS.jobnetNameプロパティ)には実行スケジュールを変更するジョブネット名を明示的に指定してください。総称名を表す記号(「*」「?」「[」「]」)を含む文字列は指定しないでください。

(4) スケジュール変更操作(JP1AJS.scheduleChangeOperationプロパティ)に"ChangeTime"を指定した場合は，次に示す2つのプロパティのどちらか一方，または両方に値を指定してください。

・実行開始日(JP1AJS.nextExecutionDateプロパティ)

・実行開始時刻(JP1AJS.nextExecutionTimeプロパティ)

(5) その他の注意事項については，JP1/AJSのマニュアル「操作ガイド」の「ジョブネットの実行開始日時を変更する」および「実行予定があるジョブネットをすぐに実行する」の注意事項，ならびにJP1/AJSのマニュアル「コマンドリファレンス１」のajsplanコマンドの注意事項を参照してください。

実行権限

(1) 業務サーバに接続するOSユーザーにマッピングされているJP1ユーザーが，操作対象のジョブネットに対して操作権限を持っている必要があります。

(2) 業務サーバに接続する際のOSユーザーにマッピングされているJP1ユーザーが存在しない場合，JP1ユーザー名(JP1AJS.jp1UserNameプロパティ)に操作対象のジョブネットに対して操作権限を持つJP1ユーザーを指定してください。

バージョン

02.00.01

部品のタグ

Control JP1,AJS,Windows,Linux

タスクログに表示される部品の名称

jp1ajsChangeSchedule

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1AJS.jp1UserName

JP1ユーザー名

JP1ユーザー名を指定します。実行対象サーバに接続する際のOSユーザー名と同一のJP1ユーザーで実行する場合，指定する必要はありません。

−　

入力

△　

JP1AJS.serviceName

JP1/AJSサービス名

スケジューラーのサービス名を指定します。

−　

入力

△　

JP1AJS.jobnetName

ジョブネット名

実行スケジュールを一時的に変更するジョブネット名を指定します。

−　

入力

○　

JP1AJS.execRegistrationNumber

実行登録番号

実行スケジュールを一時的に変更するジョブネットの実行登録番号を「YYYYMMDDNNN」の形式で指定します。

−　

入力

△　

JP1AJS.scheduleChangeOperation

スケジュール変更操作

ジョブネットの実行開始日時を変更する場合は"ChangeTime"，ジョブネットを即時実行する場合は"ExecuteImmediately"を指定します。

−　

入力

○　

JP1AJS.nextExecutionDate

実行開始日

スケジュール変更操作に"ChangeTime"を指定した場合に，一時的に変更する次回の実行開始日を[[年/]月/]日の形式で指定します。

−　

入力

△　

JP1AJS.nextExecutionTime

実行開始時刻

スケジュール変更操作に"ChangeTime"を指定した場合に，一時的に変更する次回の実行開始時刻を，絶対時刻（時[:分]の形式）で指定します。

−　

入力

△　

JP1AJS.cancelNextExecution

次回実行予定の取り消し要否

次回スケジュールを前倒しに変更した場合に，変更前の次回実行予定を取り消す場合は"true"を指定します。"true"以外の場合は，変更前の次回実行予定を取り消さずに処理を継続します。

−　

入力

△　

JP1AJS.changeLowerJobnets

配下の開始日時の変更要否

ジョブネットの下にあるすべてのジョブネットの開始時間も相対的に変更する場合は"true"を指定します。"true"以外の場合は，指定されたジョブネットだけ開始時間を変更します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.6.6　JP1/AJSジョブネット実行中止

機能

この部品は，指定したサーバのJP1/AJS3 - Manager (またはJP1/AJS2 - Manager，以降まとめてJP1/AJSと呼びます)に対して，ジョブネットまたはジョブの実行を一時的に中止します。

この部品が前提とするサーバを次に示します。

・業務サーバ(実行対象サーバ)

　JP1/AJSのジョブネットを実行するサーバです。前提条件に記載のJP1/AJSがセットアップされている必要があります。

この部品内のスクリプトでは次に示す処理を行います。

・業務サーバの論理ホスト名(JP1.logicalHostNameプロパティ)に値が指定されていた場合，その値をJP1_HOSTNAME環境変数に設定します。

・JP1ユーザー名(JP1AJS.jp1UserNameプロパティ)に値が指定されていた場合，その値をJP1_USERNAME環境変数に設定します。

・次のコマンドを実行します。

　ajsplan [-F "JP1/AJSサービス名(JP1AJS.serviceNameプロパティ)の値"]

　　　　　[-B "実行登録番号(JP1AJS.execRegistrationNumberプロパティ)の値"]

　　　　　-p

　　　　　"ユニット名(JP1AJS.unitNameプロパティ)の値" ※

　※ [[スケジューラーサービス名]:]ユニット名[:@実行ID]の形式で指定してください。

　ajsplanコマンドの詳細については，JP1/AJSのマニュアル「コマンドリファレンス１」を参照してください。

利用場面

JP1/AJSのジョブネットまたはジョブの実行を一時的に中止する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) JP1/Automatic Job Management System 3 - Manager 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

　(1) JP1ユーザー名(JP1AJS.jp1UserNameプロパティ)には，実行対象サーバでジョブネットの実行中止を行うためのJP1ユーザー名を指定してください。本製品から接続するOSユーザーと同一名のJP1ユーザーで実行中止を行う場合は，このプロパティに値を指定する必要はありません。

　(2) クラスタ構成の論理ホスト上に定義されているジョブネットの実行中止を行う場合は，

　・実行対象サーバのホスト名(plugin.destinationHostプロパティ)に実行系サーバの物理ホスト名または論理ホスト名を指定してください。

　・実行対象サーバの論理ホスト名(JP1.logicalHostNameプロパティ)にスケジューラーサービスが動作している論理ホスト名を指定してください。

　・JP1/AJSサービス名(JP1AJS.serviceNameプロパティ)に論理ホストで動作しているスケジューラーサービス名を指定してください。

　(3) 業務サーバのOSがUNIXの場合，業務サーバのJP1/AJSの環境設定パラメタの文字コード設定と業務サーバへの接続ユーザーのデフォルトロケールの設定を一致させてください。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) ユニット名(JP1AJS.unitNameプロパティ)に「¥」(円記号)でキャストした記号文字(「&」「*」「<」「>」「?」「[」「¥」「]」「^」「'」「{」「｜」「}」「~」)を含む文字列を指定した場合でも，プロパティの両端を「"」(ダブルクォーテーション)で囲む必要はありません。

(3) ユニット名(JP1AJS.unitNameプロパティ)には実行中止するジョブネット名またはジョブ名を明示的に指定してください。総称名を表す記号(「*」「?」「[」「]」)を含む文字列は指定しないでください。

(4) その他の注意事項については，JP1/AJSのマニュアル「操作ガイド」の「ジョブネットやジョブの実行を一時的に中止する」の注意事項，およびJP1/AJSのマニュアル「コマンドリファレンス１」のajsplanコマンドの注意事項を参照してください。

実行権限

(1) 業務サーバに接続するOSユーザーにマッピングされているJP1ユーザーが，操作対象のジョブネットに対して操作権限を持っている必要があります。

(2) 業務サーバに接続する際のOSユーザーにマッピングされているJP1ユーザーが存在しない場合，JP1ユーザー名(JP1AJS.jp1UserNameプロパティ)に操作対象のジョブネットに対して操作権限を持つJP1ユーザーを指定してください。

バージョン

02.00.00

部品のタグ

Control JP1,AJS,Windows,Linux

タスクログに表示される部品の名称

jp1ajsProhibitExecution

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1AJS.jp1UserName

JP1ユーザー名

JP1ユーザー名を指定します。実行対象サーバに接続する際のOSユーザー名と同一のJP1ユーザーで実行する場合，指定する必要はありません。

−　

入力

△　

JP1AJS.serviceName

JP1/AJSサービス名

スケジューラーのサービス名を指定します。

−　

入力

△　

JP1AJS.unitName

ユニット名

実行を一時的に中止するジョブネット名またはジョブ名を指定します。

−　

入力

○　

JP1AJS.execRegistrationNumber

実行登録番号

実行を一時的に中止するジョブネットまたはジョブの実行登録番号を「YYYYMMDDNNN」の形式で指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.6.7　JP1/AJSジョブネット実行登録

機能

指定したサーバのJP1/AJS3 - Manager (またはJP1/AJS2 - Manager，以降まとめてJP1/AJSと呼びます)に対してジョブネットの実行登録を行います。

この部品では，次のサーバを前提とします。

・業務サーバ(実行対象サーバ)

　JP1/AJSのジョブネットを実行するサーバです。前提条件に記載のJP1/AJSがセットアップされている必要があります。

この部品ではジョブネットの即時実行だけを行えます。

ジョブネットの実行結果を確認する場合は，この部品を使用してジョブネットを実行登録したあと，jp1ajsCheck部品を使用して結果を取得する必要があります。

利用場面

運用手順内の定型作業が既存のジョブネットとして存在する場合などに，サービスからジョブネットを実行することができます。次の部品を使用することでジョブネットの実行結果を参照できます。

・jp1ajsCheck

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Automatic Job Management System 3 - Manager 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) AIX V6

　(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

　(1)実行登録対象のジョブネットが作成されていること。

　(2)ルートジョブネットの実行登録だけサポートしています。ジョブグループの一括実行はサポートしていません。

　(3)ジョブネットの即時実行登録だけ可能です。また，起動条件が付与されたジョブネットは起動条件が無効になります。

　(4)プロパティJP1AJS.executeJP1UserNameには，実行対象サーバでジョブネットの実行登録を行うためのJP1ユーザー名を指定してください。JP1/AOから接続するOSユーザーと同一名のJP1ユーザーで実行登録を行う場合は，このプロパティに値を指定する必要はありません。

　(5)クラスタ構成の論理ホスト上に定義されているジョブネットを登録する場合は,

　・プロパティplugin.destinationHostに実行系サーバの物理ホスト名または論理ホスト名を指定してください。

　・プロパティJP1AJS.serviceName に論理ホストで動作しているスケジューラーサービス名を指定してください。

　・プロパティJP1.logicalHostName にスケジューラーサービスが動作している論理ホスト名を指定してください。

注意事項

(1)この部品はジョブネットの即時実行登録だけを行います。長時間を要するなどのジョブネットの実行状況は，適宜JP1/AJS3 - Viewを使用して確認してください。

実行権限

JP1/AOから業務サーバに接続する際のOSユーザーに，次の設定が必要です。

接続するOSユーザーと同名のJP1ユーザーが存在しない場合，プロパティjp1ajs.executeJP1UserNameを必ず指定してください。

[Windows, UNIX共通]

JP1_AJS_Operator権限，JP1_AJS_Manager権限，JP1_AJS_Admin権限のどれかの権限を付与されたJP1ユーザーと同名であること。

バージョン

02.00.00

部品のタグ

Configure JP1,AJS,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1ajsExecute

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1AJS.serviceName

JP1/AJSサービス名

スケジューラーのサービス名を指定します。クラスタ構成の場合は論理ホストのスケジューラサービス名を指定します。

−　

入力

△　

JP1AJS.jobnetName

ジョブネット名

実行登録するジョブネット名を指定します。

−　

入力

○　

JP1AJS.macroParameter

JP1/AJSマクロ変数

JP1/AJSのマクロ変数と値を":"で結合して指定します。

コンマ区切りで複数指定可能です。

(例)AJS2AA:5,AJS2BB:test

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1AJS.executeJP1UserName

ジョブネット実行時のJP1ユーザー名

ジョブネットを実行する際のJP1ユーザー名を指定します。実行対象サーバに接続する際のOSユーザー名と同一のJP1ユーザーで実行する場合，指定する必要はありません。

−　

入力

△　

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.6.8　JP1/AJSジョブネット実行予実績出力

機能

この部品は，指定したサーバのJP1/AJS3 - Manager (またはJP1/AJS2 - Manager，以降まとめてJP1/AJSと呼びます)に対して実行登録済みのジョブネットの，前回までの実行結果，現在の状態，および次回の実行予定などの情報を業務サーバ上の指定された実行予実績ファイルに出力します。

この部品が前提とするサーバを次に示します。

・業務サーバ(実行対象サーバ)

　JP1/AJSのジョブネットを実行するサーバです。前提条件に記載のJP1/AJSがセットアップされている必要があります。

実行前にジョブネットの実行予実績出力開始日と実行予実績出力終了日の様式と順序関係をチェックします。

利用場面

実行登録済みのジョブネットの指定された期間の，次回の実行予定を指定された業務サーバ上のファイルに出力します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Automatic Job Management System 3 - Manager 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) AIX V6

　(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

　(1) 参照するジョブネットが作成されていること。

　(2) 参照するジョブネットのカレンダー，スケジュールルールが定義されていること。

　(3) JP1AJS.executeJP1UserNameプロパティには，実行対象サーバでジョブネットの実行予実績を出力するためのJP1ユーザー名を指定してください。JP1/AOから接続するOSユーザーと同一名のJP1ユーザーで実行予実績を出力する場合は，このプロパティに値を指定する必要はありません。

　(4) クラスタ構成の論理ホスト上に定義されているジョブネットを参照する場合は，

　・plugin.destinationHostプロパティに実行系サーバの物理ホスト名または論理ホスト名を指定してください。

　・JP1AJS.serviceNameプロパティに論理ホストで動作しているスケジューラーサービス名を指定してください。

　・JP1.logicalHostNameプロパティにスケジューラーサービスが動作している論理ホスト名を指定してください。

　(5) 業務サーバのOSがUNIXの場合，業務サーバのJP1/AJSの環境設定パラメタの文字コード設定と業務サーバへの接続ユーザーのデフォルトロケールの設定を一致させてください。

注意事項

(1) JP1AJS.serviceNameプロパティに設定するスケジューラーサービス名は30バイト以内となるよう指定してください。

(2) JP1AJS.outputFormatプロパティに設定する値については，JP1/AJSのマニュアル「コマンドリファレンス1」のajsshowコマンドの-iオプションの説明を参照してください。

(3) 業務サーバのOSがWindowsでマルチバイト文字を指定する場合は，common.outputFileNameプロパティに設定する実行予実績ファイルは256バイト以内となるよう指定してください。

(4) 実行予実績ファイルがすでに存在する場合，既存のファイルを上書きします。

(5) 実行予実績ファイルに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

(6) JP1AJS.outputFormatプロパティに設定したフォーマット指示子のとおり，ファイルに出力されます。ジョブネット名に「"」が含まれている場合は，ODBCドライバで読み込む場合に不具合が生じることがあるので，必要に応じて文字の置換などを行ってください。

(7) その他の注意事項については，JP1/AJSのマニュアル「コマンドリファレンス1」のajsshowコマンドの注意事項を参照してください。

実行権限

・業務サーバに接続するOSユーザーにマッピングされているJP1ユーザーが，実行登録対象のジョブネットに対して参照権限を持っていること。

・業務サーバに接続する際のOSユーザーにマッピングされているJP1ユーザーが存在しない場合，jp1ajs.executeJP1UserNameプロパティに対象のジョブネットに対して参照権限を持つJP1ユーザーを指定してください。

バージョン

02.00.00

部品のタグ

Gather JP1 information,AJS,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1ajsOutputSchedule

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

14

異常(ユーザーミス) ファイルアクセス不可

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認) 識別できないエラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1AJS.serviceName

JP1/AJSサービス名

スケジューラーのサービス名を指定します。

−　

入力

△　

JP1AJS.entryJobnetName

ジョブネット名

実行登録，または実行予実績を出力するジョブネットの名称を完全名で指定します。マネージャージョブグループ名とマネージャージョブネット名は指定できません。

−　

入力

○　

JP1AJS.executeJP1UserName

ジョブネットの実行予実績を出力するAJSコマンドを実行するためのJP1ユーザー名

ジョブネットの実行予実績を出力するためにAJSコマンドを実行する際のJP1ユーザー名を指定します。実行対象サーバに接続する際のOSユーザー名と同一名称のJP1ユーザーで実行する場合，指定する必要はありません。

−　

入力

△　

JP1AJS.outputStartDate

ジョブネットの実行予実績出力開始日

ジョブネットの実行予実績の出力開始日を-または/で区切って，YYYY-MM-DDまたはYYYY/MM/DDの形式で指定します。

−　

入力

○　

JP1AJS.outputEndDate

ジョブネットの実行予実績出力終了日

ジョブネットの実行予実績の出力終了日を-または/で区切って，YYYY-MM-DDまたはYYYY/MM/DDの形式で指定します。

−　

入力

○　

JP1AJS.outputFormat

実行予実績ファイルのフォーマット

ajsshowコマンドの-iオプションのフォーマット指示子を指定します。

−　

入力

○　

common.outputFileName

実行予実績ファイル

ジョブネットの実行予定の予実績を出力するファイルを指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.6.9　JP1/AJSジョブネット中断

機能

この部品は，指定したサーバのJP1/AJS3 - Manager (またはJP1/AJS2 - Manager，以降まとめてJP1/AJSと呼びます)に対して，ジョブネットの中断を行います。

この部品が前提とするサーバを次に示します。

・業務サーバ(実行対象サーバ)

　JP1/AJSのジョブネットを実行するサーバです。前提条件に記載のJP1/AJSがセットアップされている必要があります。

この部品ではジョブネットを中断する指示だけを行えます。

この部品を実行したあとのジョブネットの状態を確認する場合は，JP1/AJSのジョブネット実行結果取得(jp1ajsCheck部品)を使用して結果を取得する必要があります。

この部品内のスクリプトでは次に示す処理を行います。

・業務サーバの論理ホスト名(JP1.logicalHostNameプロパティ)に値が指定されていた場合，その値をJP1_HOSTNAME環境変数に設定します。

・JP1ユーザー名(JP1AJS.jp1UserNameプロパティ)に値が指定されていた場合，その値をJP1_USERNAME環境変数に設定します。

・次のコマンドを実行します。

　ajsintrpt [-F "JP1/AJSサービス名(JP1AJS.serviceNameプロパティ)の値"]

　　　　　　[-B "実行登録番号(JP1AJS.execRegistrationNumberプロパティ)の値"]

　　　　　　"ジョブネット名(JP1AJS.jobnetNameプロパティ)の値" ※

　※ [[スケジューラーサービス名]:]ジョブネット名[:@実行ID]の形式で指定してください。

　ajsintrptコマンドの詳細については，JP1/AJSのマニュアル「コマンドリファレンス１」を参照してください。

利用場面

JP1/AJSのジョブネットの実行を中断する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) JP1/Automatic Job Management System 3 - Manager 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

　(1) JP1ユーザー名(JP1AJS.jp1UserNameプロパティ)には，実行対象サーバでジョブネットの中断を行うためのJP1ユーザー名を指定してください。本製品から接続するOSユーザーと同一名のJP1ユーザーで中断を行う場合は，このプロパティに値を指定する必要はありません。

　(2) クラスタ構成の論理ホスト上に定義されているジョブネットの中断を行う場合は，

　・実行対象サーバのホスト名(plugin.destinationHostプロパティ)に実行系サーバの物理ホスト名または論理ホスト名を指定してください。

　・実行対象サーバの論理ホスト名(JP1.logicalHostNameプロパティ)にスケジューラーサービスが動作している論理ホスト名を指定してください。

　・JP1/AJSサービス名(JP1AJS.serviceNameプロパティ)に論理ホストで動作しているスケジューラーサービス名を指定してください。

　(3) 業務サーバのOSがUNIXの場合，業務サーバのJP1/AJSの環境設定パラメタの文字コード設定と業務サーバへの接続ユーザーのデフォルトロケールの設定を一致させてください。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) ジョブネット名(JP1AJS.jobnetNameプロパティ)に「¥」(円記号)でキャストした記号文字(「&」「*」「<」「>」「?」「[」「¥」「]」「^」「'」「{」「｜」「}」「~」)を含む文字列を指定した場合でも，プロパティの両端を「"」(ダブルクォーテーション)で囲む必要はありません。

(3) ジョブネット名(JP1AJS.jobnetNameプロパティ)には実行を中断するジョブネット名を明示的に指定してください。総称名を表す記号(「*」「?」「[」「]」)を含む文字列は指定しないでください。

(4) その他の注意事項については，JP1/AJSのマニュアル「操作ガイド」の「実行中のジョブネットを中断する」の注意事項，およびJP1/AJSのマニュアル「コマンドリファレンス１」のajsintrptコマンドの注意事項を参照してください。

実行権限

(1) 業務サーバに接続するOSユーザーにマッピングされているJP1ユーザーが，操作対象のジョブネットに対して操作権限を持っている必要があります。

(2) 業務サーバに接続する際のOSユーザーにマッピングされているJP1ユーザーが存在しない場合，JP1ユーザー名(JP1AJS.jp1UserNameプロパティ)に操作対象のジョブネットに対して操作権限を持つJP1ユーザーを指定してください。

バージョン

02.00.00

部品のタグ

Control JP1,AJS,Windows,Linux

タスクログに表示される部品の名称

jp1ajsStopExecution

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1AJS.jp1UserName

JP1ユーザー名

JP1ユーザー名を指定します。実行対象サーバに接続する際のOSユーザー名と同一のJP1ユーザーで実行する場合，指定する必要はありません。

−　

入力

△　

JP1AJS.serviceName

JP1/AJSサービス名

スケジューラーのサービス名を指定します。

−　

入力

△　

JP1AJS.jobnetName

ジョブネット名

実行を中断するジョブネット名を指定します。

−　

入力

○　

JP1AJS.execRegistrationNumber

実行登録番号

実行を中断するジョブネットの実行登録番号を「YYYYMMDDNNN」の形式で指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.6.10　JP1/AJSジョブネット保留属性変更

機能

この部品は，指定したサーバのJP1/AJS3 - Manager (またはJP1/AJS2 - Manager，以降まとめてJP1/AJSと呼びます)に対して，ジョブネットまたはジョブの保留属性を一時的に変更します。

ジョブネットまたはジョブを保留にしたい場合は，保留属性変更(JP1AJS.changeHoldAttributeプロパティ)に"hold"を指定します。

ジョブネットまたはジョブを保留解除したい場合は，保留属性変更(JP1AJS.changeHoldAttributeプロパティ)に"release"を指定します。

この部品が前提とするサーバを次に示します。

・業務サーバ(実行対象サーバ)

　JP1/AJSのジョブネットを実行するサーバです。前提条件に記載のJP1/AJSがセットアップされている必要があります。

この部品内のスクリプトでは次に示す処理を行います。

・業務サーバの論理ホスト名(JP1.logicalHostNameプロパティ)に値が指定されていた場合，その値をJP1_HOSTNAME環境変数に設定します。

・JP1ユーザー名(JP1AJS.jp1UserNameプロパティ)に値が指定されていた場合，その値をJP1_USERNAME環境変数に設定します。

・次のコマンドを実行します。

　(a) 保留属性変更(JP1AJS.changeHoldAttributeプロパティ)に"hold"を指定した場合

　　　ajsplan [-F "JP1/AJSサービス名(JP1AJS.serviceNameプロパティ)の値"]

　　　　　　　[-B "実行登録番号(JP1AJS.execRegistrationNumberプロパティ)の値"]

　　　　　　　-h

　　　　　　　"ユニット名(JP1AJS.unitNameプロパティ)の値" ※

　(b) 保留属性変更(JP1AJS.changeHoldAttributeプロパティ)に"release"を指定した場合

　　　ajsplan [-F "JP1/AJSサービス名(JP1AJS.serviceNameプロパティ)の値"]

　　　　　　　[-B "実行登録番号(JP1AJS.execRegistrationNumberプロパティ)の値"]

　　　　　　　-r

　　　　　　　"ユニット名(JP1AJS.unitNameプロパティ)の値" ※

　※ [[スケジューラーサービス名]:]ユニット名[:@実行ID]の形式で指定してください。

　ajsplanコマンドの詳細については，JP1/AJSのマニュアル「コマンドリファレンス１」を参照してください。

利用場面

JP1/AJSのジョブネットまたはジョブの保留属性を一時的に変更する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) JP1/Automatic Job Management System 3 - Manager 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

　(1) JP1ユーザー名(JP1AJS.jp1UserNameプロパティ)には，実行対象サーバでジョブネットの保留状態変更を行うためのJP1ユーザー名を指定してください。本製品から接続するOSユーザーと同一名のJP1ユーザーで保留状態変更を行う場合は，このプロパティに値を指定する必要はありません。

　(2) クラスタ構成の論理ホスト上に定義されているジョブネットの保留状態変更を行う場合は，

　・実行対象サーバのホスト名(plugin.destinationHostプロパティ)に実行系サーバの物理ホスト名または論理ホスト名を指定してください。

　・実行対象サーバの論理ホスト名(JP1.logicalHostNameプロパティ)にスケジューラーサービスが動作している論理ホスト名を指定してください。

　・JP1/AJSサービス名(JP1AJS.serviceNameプロパティ)に論理ホストで動作しているスケジューラーサービス名を指定してください。

　(3) 業務サーバのOSがUNIXの場合，業務サーバのJP1/AJSの環境設定パラメタの文字コード設定と業務サーバへの接続ユーザーのデフォルトロケールの設定を一致させてください。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) ユニット名(JP1AJS.unitNameプロパティ)に「¥」(円記号)でキャストした記号文字(「&」「*」「<」「>」「?」「[」「¥」「]」「^」「'」「{」「｜」「}」「~」)を含む文字列を指定した場合でも，プロパティの両端を「"」(ダブルクォーテーション)で囲む必要はありません。

(3) ユニット名(JP1AJS.unitNameプロパティ)には保留属性変更するジョブネット名またはジョブ名を明示的に指定してください。総称名を表す記号(「*」「?」「[」「]」)を含む文字列は指定しないでください。

(4) その他の注意事項については，JP1/AJSのマニュアル「コマンドリファレンス１」のajsplanコマンドの注意事項を参照してください。

実行権限

(1) 業務サーバに接続するOSユーザーにマッピングされているJP1ユーザーが，操作対象のジョブネットに対して操作権限を持っている必要があります。

(2) 業務サーバに接続する際のOSユーザーにマッピングされているJP1ユーザーが存在しない場合，JP1ユーザー名(JP1AJS.jp1UserNameプロパティ)に操作対象のジョブネットに対して操作権限を持つJP1ユーザーを指定してください。

バージョン

02.00.01

部品のタグ

Control JP1,AJS,Windows,Linux

タスクログに表示される部品の名称

jp1ajsChangeHoldAttribute

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1AJS.jp1UserName

JP1ユーザー名

JP1ユーザー名を指定します。実行対象サーバに接続する際のOSユーザー名と同一のJP1ユーザーで実行する場合，指定する必要はありません。

−　

入力

△　

JP1AJS.serviceName

JP1/AJSサービス名

スケジューラーのサービス名を指定します。

−　

入力

△　

JP1AJS.unitName

ユニット名

保留属性を一時的に変更するジョブネット名またはジョブ名を指定します。

−　

入力

○　

JP1AJS.execRegistrationNumber

実行登録番号

保留属性を一時的に変更するジョブネットまたはジョブの実行登録番号を「YYYYMMDDNNN」の形式で指定します。

−　

入力

△　

JP1AJS.newHoldAttribute

変更後の保留属性

ジョブネットやジョブの実行を保留設定する場合は"hold"，保留解除する場合は"release"を指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.6.11　JP1/AJSジョブ状態変更

機能

この部品は，指定したサーバのJP1/AJS3 - Manager (またはJP1/AJS2 - Manager，以降まとめてJP1/AJSと呼びます)に対して，ジョブの状態変更を行います。

この部品が前提とするサーバを次に示します。

・業務サーバ(実行対象サーバ)

　JP1/AJSのジョブネットを実行するサーバです。前提条件に記載のJP1/AJSがセットアップされている必要があります。

この部品ではジョブの状態変更だけを行えます。ジョブの状態変更に伴って，そのジョブが含まれるジョブネットの状態も変更されます。

この部品内のスクリプトでは次に示す処理を行います。

・業務サーバの論理ホスト名(JP1.logicalHostNameプロパティ)に値が指定されていた場合，その値をJP1_HOSTNAME環境変数に設定します。

・JP1ユーザー名(JP1AJS.jp1UserNameプロパティ)に値が指定されていた場合，その値をJP1_USERNAME環境変数に設定します。

・次のコマンドを実行します。

　ajschgstat [-F "JP1/AJSサービス名(JP1AJS.serviceNameプロパティ)の値"]

　　　　　　 [-B "実行登録番号(JP1AJS.execRegistrationNumberプロパティ)の値"]

　　　　　　 -t "変更後の状態(JP1AJS.newStatusプロパティ)の値"

　　　　　　 [-c "終了コード(JP1AJS.returnCodeプロパティ)の値"]

　　　　　　 "ジョブ名(JP1AJS.jobNameプロパティ)の値" ※

　※ [[スケジューラーサービス名]:]ジョブ名[:@実行ID]の形式で指定してください。

　ajschgstatコマンドの詳細については，JP1/AJSのマニュアル「コマンドリファレンス１」を参照してください。

利用場面

JP1/AJSのジョブの状態を変更する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) JP1/Automatic Job Management System 3 - Manager 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

　(1) JP1ユーザー名(JP1AJS.jp1UserNameプロパティ)には，実行対象サーバでジョブの状態変更を行うためのJP1ユーザー名を指定してください。本製品から接続するOSユーザーと同一名のJP1ユーザーで状態変更を行う場合は，このプロパティに値を指定する必要はありません。

　(2) クラスタ構成の論理ホスト上に定義されているジョブの状態変更を行う場合は，

　・実行対象サーバのホスト名(plugin.destinationHostプロパティ)に実行系サーバの物理ホスト名または論理ホスト名を指定してください。

　・実行対象サーバの論理ホスト名(JP1.logicalHostNameプロパティ)にスケジューラーサービスが動作している論理ホスト名を指定してください。

　・JP1/AJSサービス名(JP1AJS.serviceNameプロパティ)に論理ホストで動作しているスケジューラーサービス名を指定してください。

　(3) 業務サーバのOSがUNIXの場合，業務サーバのJP1/AJSの環境設定パラメタの文字コード設定と業務サーバへの接続ユーザーのデフォルトロケールの設定を一致させてください。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) ジョブ名(JP1AJS.jobNameプロパティ)に「¥」(円記号)でキャストした記号文字(「&」「*」「<」「>」「?」「[」「¥」「]」「^」「'」「{」「｜」「}」「~」)を含む文字列を指定した場合でも，プロパティの両端を「"」(ダブルクォーテーション)で囲む必要はありません。

(3) ジョブ名(JP1AJS.jobNameプロパティ)には状態を変更するジョブ名を明示的に指定してください。総称名を表す記号(「*」「?」「[」「]」)を含む文字列は指定しないでください。

(4) その他の注意事項については，JP1/AJSのマニュアル「操作ガイド」の「ジョブの状態を変更する」の注意事項，およびJP1/AJSのマニュアル「コマンドリファレンス１」のajschgstatコマンドの注意事項を参照してください。

実行権限

(1) 業務サーバに接続するOSユーザーにマッピングされているJP1ユーザーが，操作対象のジョブに対して操作権限を持っている必要があります。

(2) 業務サーバに接続する際のOSユーザーにマッピングされているJP1ユーザーが存在しない場合，JP1ユーザー名(JP1AJS.jp1UserNameプロパティ)に操作対象のジョブに対して操作権限を持つJP1ユーザーを指定してください。

バージョン

02.00.00

部品のタグ

Control JP1,AJS,Windows,Linux

タスクログに表示される部品の名称

jp1ajsChangeStatus

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1AJS.jp1UserName

JP1ユーザー名

JP1ユーザー名を指定します。実行対象サーバに接続する際のOSユーザー名と同一のJP1ユーザーで実行する場合，指定する必要はありません。

−　

入力

△　

JP1AJS.serviceName

JP1/AJSサービス名

スケジューラーのサービス名を指定します。

−　

入力

△　

JP1AJS.jobName

ジョブ名

状態を変更したいジョブ名を指定します。

−　

入力

○　

JP1AJS.execRegistrationNumber

実行登録番号

状態を変更したいジョブを含むジョブネットの実行登録番号を「YYYYMMDDNNN」の形式で指定します。

−　

入力

△　

JP1AJS.newStatus

変更後の状態

ジョブをどの状態に変更するかを指定します。指定可能な値は，"normal"，"fail"，"warning"，"abnormal"，"bypass"，"exit"です。

−　

入力

○　

JP1AJS.returnCode

終了コード

ジョブの終了コードを指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.6.12　JP1/AJSのジョブネット実行結果取得

機能

指定したサーバのJP1/AJS3 - Manager(またはJP1/AJS2 - Manager，以降まとめてJP1/AJSと呼びます)に対して，ジョブネットの実行結果取得を行います。

この部品では，次のサーバを前提とします。

・業務サーバ(実行対象サーバ)

　JP1/AJSのジョブネット実行結果を取得するサーバです。前提条件に記載のJP1/AJSがセットアップされている必要があります。

利用場面

jp1ajsExecute部品でジョブネットを実行した際に，ジョブネットの実行結果を取得することができます。

プロパティjobnetStateに実行結果が格納されるので，結果に応じてサービステンプレートの動作を変更できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Automatic Job Management System 3 - Manager 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) AIX V6

　(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

　(1)実行結果を取得するジョブネットが作成されていること。

　(2)プロパティJP1AJS.executeJP1UserNameには，実行対象サーバでジョブネットの実行結果の取得を行うためのJP1ユーザー名を指定してください。JP1/AOから接続するOSユーザーと同一名のJP1ユーザーで実行結果の取得を行う場合は，このプロパティに値を指定する必要はありません。

　(3)クラスタ構成の論理ホスト上に定義されているジョブネットの実行結果を取得する場合は,

　・プロパティplugin.destinationHostに実行系サーバの物理ホスト名または論理ホスト名を指定してください。

　・プロパティJP1AJS.serviceName に論理ホストで動作しているスケジューラーサービス名を指定してください。

　・プロパティJP1.logicalHostName にスケジューラーサービスが動作している論理ホスト名を指定してください。

注意事項

(1)同一スケジューラーの同一ジョブネットに対してjp1ajsExecute部品を並列に実行した場合，直前に実行されたジョブネットの結果を取得します。

実行権限

JP1/AOから業務サーバに接続する際のOSユーザーに，次の設定が必要です。

接続するOSユーザーと同名のJP1ユーザーが存在しない場合，プロパティjp1ajs.executeJP1UserNameを必ず指定してください。

[Windows，UNIX共通]

JP1_AJS_Guest権限，JP1_AJS_Operator権限，JP1_AJS_Editor権限，JP1_AJS_Manager権限，JP1_AJS_Admin権限のどれかの権限を付与されたJP1ユーザーと同名であること。

バージョン

02.00.00

部品のタグ

Gather JP1 information,AJS,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1ajsCheck

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1AJS.serviceName

JP1/AJSサービス名

スケジューラーのサービス名を指定します。クラスタ構成の場合は論理ホストのスケジューラサービス名を指定します。

−　

入力

△　

JP1AJS.jobnetName

ジョブネット名

実行結果を取得するジョブネット名を指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1AJS.executeJP1UserName

ジョブネットの結果を参照するJP1ユーザー名

ジョブネットの結果を参照する際のJP1ユーザー名を指定します。実行対象サーバに接続する際のOSユーザー名と同一のJP1ユーザーで実行する場合，指定する必要はありません。

−　

入力

△　

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1AJS.jobnetResult

ジョブネットの結果

ジョブネットの結果が格納されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.6.13　JP1/AJSのトラブルシュート情報取得

機能

指定したサーバのJP1/AJS3 - Manager(またはJP1/AJS2 - Manager，以降まとめてJP1/AJSと呼びます)に対し，トラブルシュート情報の収集を実行します。

この部品では，次のサーバを前提とします。

・業務サーバ(実行対象サーバ)

　JP1/AJSのトラブルシュート情報収集を実行するサーバです。前提条件に記載のJP1/AJSがセットアップされている必要があります。

プロパティJP1AJS.logFolderに指定したフォルダにトラブルシュート情報を収集します。

取得する情報は次のとおりです。なお，取得する情報の詳細や格納形式はJP1/AJSのマニュアルを参照してください。

・JP1/AJSの資料採取ツール(オプション指定なし)で取得できるすべての情報

JP1/AJSの資料採取ツールの出力メッセージは，プロパティJP1AJS.logFolderに指定したフォルダ直下にjp1ajsGetLog_result.logとして格納します。

利用場面

JP1/AJSの問題調査のため，JP1/AJSのトラブルシュート情報を収集する際に利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1) JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) JP1/Automatic Job Management System 3 - Manager 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) AIX V6

　(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

　(1) JP1/AJS2 - ManagerまたはJP1/AJS3 - ManagerのOSがWindowsの場合，資料採取ツールの出力先がデフォルト(%TEMP%¥jp1ajs2¥backlog)であること。

　(2) 実行対象サーバのJP1/AJSがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/AJSの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/AJSの論理ホスト名を指定してください。

注意事項

(1)この部品を同一の実行対象サーバに対して複数同時に実行しないでください。

バージョン

02.00.00

部品のタグ

Troubleshoot JP1,AJS,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1ajsGetLog

戻り値

戻り値

説明

0

正常

13

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1AJS.logFolder

資料格納フォルダ

JP1/AJSの資料採取ツールで収集されるファイルを格納するフォルダをフルパスで指定します。

−　

入力

○　

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.6.14　JP1/AJSの起動(UNIX)

機能

この部品は，UNIXの実行対象サーバで，JP1/AJSを起動します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

この部品内のスクリプトでは次のコマンドを実行します。

・jajs_spmd

　　　[-h "実行対象サーバの論理ホスト名(JP1.logicalHostNameプロパティ)の値"]

　　　[-n "プロセス名(n)オプション(JP1AJS.processNameOptionプロパティ)の値"]

　　　[-F "スケジューラーサービス名(F)オプション(JP1AJS.schedulerServiceNameOptionプロパティ)の値"]

　　　[-id "組み込みDBセットアップ識別子(id)オプション(JP1AJS.embeddedDatabaseSetupIDOptionプロパティ)の値"]

　　　["起動モードオプション(JP1AJS.startupModeOptionプロパティ)の値"]

　　　[-q "ジョブ情報初期化(q)オプション(JP1AJS.initializeJobInformationOptionプロパティ)の値"]

　　　[-HA]※1

※1 HAオプション(JP1.haOptionプロパティ)の値に"true"を指定した場合に設定されます。

JP1/AJSのjajs_spmdコマンドの詳細については，JP1/AJSマニュアルの同コマンドを参照してください。

利用場面

JP1/AJSの設定変更後，変更を反映するためにJP1/AJSを再起動する場合に使用します。

なお，この部品は起動の完了を待たずに非同期で終了しますが，この部品実行後に「JP1/AJSの状態取得」部品を使用することで起動の完了を待つことができます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Automatic Job Management System 3 - Manager 09-00 以降

(2)JP1/Automatic Job Management System 3 - Agent 09-00 以降

【実行対象サーバ内前提製品の稼働OS】

(1) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(2) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(3) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

(1)JP1/AJSが停止していること。(ただし，プロセス名(n)オプション(JP1AJS.processNameOptionプロパティ)を指定する場合を除く。)

(2)実行対象サーバのJP1/AJSがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/AJSの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/AJSの論理ホスト名を指定してください。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) その他の注意事項については，JP1/AJSマニュアルの同コマンドの注意事項を参照してください。

実行権限

root権限

バージョン

02.02.00

部品のタグ

Control JP1,AJS,Linux

タスクログに表示される部品の名称

jp1ajsStart

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1AJS.processNameOption

プロセス名(n)オプション

実行するコマンドにプロセス名(n)オプションを設定する場合にjajs_schd/jajs_agtd/jajs_dbmdを指定します。省略した場合はプロセス名(n)オプションを設定しません。

−　

入力

△　

JP1AJS.schedulerServiceNameOption

スケジューラーサービス名(F)オプション

実行するコマンドにスケジューラーサービス名(F)オプションを設定する場合にスケジューラーサービス名を指定します。省略した場合はスケジューラーサービス名(F)オプションを設定しません。

−　

入力

△　

JP1AJS.embeddedDatabaseSetupIDOption

組み込みDBセットアップ識別子(id)オプション

実行するコマンドに組み込みDBセットアップ識別子(id)オプションを設定する場合に組み込みDBセットアップ識別子を指定します。省略した場合は組み込みDBセットアップ識別子(id)オプションを設定しません。

−　

入力

△　

JP1AJS.startupModeOption

起動モードオプション

実行するコマンドに起動モードオプションを設定する場合にhot/warm/cold/disasterを指定します。省略した場合は起動モードオプションを設定しません。

−　

入力

△　

JP1AJS.initializeJobInformationOption

ジョブ情報初期化(q)オプション

実行するコマンドにジョブ情報初期化(q)オプションを設定する場合にclear/noclearを指定します。省略した場合はジョブ情報初期化(q)オプションを設定しません。

−　

入力

△　

JP1.haOption

HAオプション

実行するコマンドにHAオプションを設定する場合は"true"を指定します。"true"以外の場合は，HAオプションを設定しません。

false

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.6.15　JP1/AJSの状態取得

機能

この部品は，WindowsまたはUNIXの実行対象サーバで，JP1/AJSの状態を取得します。

また，JP1/AJSが特定の状態になるまで部品の完了を待たせることができます。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

　jajs_spmd_status [-h "論理ホスト名(JP1.logicalHostNameプロパティ)の値"]

　　　　　　　　　 ["状態表示オプション(JP1.statusDisplayOptionプロパティ)の値"]

　　　　　　　　　 [-t "時間オプション(JP1.timeOptionプロパティ)の値"]

・待ち状態の戻り値(JP1.waitStatusReturnCodeプロパティ)を指定した場合，指定した状態になるか，待ち状態の確認リトライ回数(JP1.waitStatusRetryCountプロパティ)を超過するまで，待ち状態の確認リトライ間隔(JP1.waitStatusRetryIntervalプロパティ)ごとにjajs_spmd_statusコマンドの実行を繰り返します。

JP1/AJSのjajs_spmd_statusコマンドの詳細については，JP1/AJSマニュアルの同コマンドを参照してください。

利用場面

JP1/AJSの設定変更後，変更を反映するためにJP1/AJSを再起動する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Automatic Job Management System 3 - Manager 09-00 以降

(2)JP1/Automatic Job Management System 3 - Agent 09-00 以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

(1)実行対象サーバのJP1/AJSがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/AJSの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/AJSの論理ホスト名を指定してください。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) その他の注意事項については，JP1/AJSマニュアルの同コマンドの注意事項を参照してください。

実行権限

Windowsの場合：Administrator権限

UNIXの場合：root権限

バージョン

02.02.00

部品のタグ

Gather JP1 information,AJS,Windows,Linux

タスクログに表示される部品の名称

jp1ajsGetStatus

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1.statusDisplayOption

状態表示オプション

実行するコマンドに状態表示オプションを設定する場合に-s/-aを指定します。省略した場合は状態表示オプションを設定しません。

−　

入力

△　

JP1.timeOption

時間(t)オプション

実行するコマンドに時間(t)オプションを設定する場合に時間を指定します。省略した場合は時間(t)オプションを設定しません。

−　

入力

△　

JP1.waitStatusReturnCode

待ち状態の戻り値

状態取得コマンドの戻り値が指定した値になるまで繰り返し状態確認コマンドを実行します。省略した場合は繰り返し処理を行いません。

−　

入力

△　

JP1.waitStatusRetryCount

待ち状態の確認リトライ回数

状態取得コマンドを実行するリトライ回数を指定します。

60

入力

△　

JP1.waitStatusRetryInterval

待ち状態の確認リトライ間隔

状態取得コマンドを実行するリトライ間隔を秒単位で指定します。

10

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

common.commandExitCode

実行コマンドの戻り値

実行コマンドの戻り値が格納されます。

−　

出力

△　

common.commandOutput

実行コマンドの出力情報

実行コマンドの標準出力と標準エラー出力が格納されます。

−　

出力

△　

4.6.16　JP1/AJSの停止(UNIX)

機能

この部品は，UNIXの実行対象サーバで，JP1/AJSを停止します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

この部品内のスクリプトでは次のコマンドを実行します。

・jajs_spmd_stop

　　　[-h "実行対象サーバの論理ホスト名(JP1.logicalHostNameプロパティ)の値"]

　　　[-n "プロセス名(n)オプション(JP1AJS.processNameOptionプロパティ)の値"]

　　　[-F "スケジューラーサービス名(F)オプション(JP1AJS.schedulerServiceNameOptionプロパティ)の値"]

　　　[-id "組み込みDBセットアップ識別子(id)オプション(JP1AJS.embeddedDatabaseSetupIDOptionプロパティ)の値"]

　　　["終了モードオプション(JP1AJS.terminationModeOptionプロパティ)の値"]

JP1/AJSのjajs_spmd_stopコマンドの詳細については，JP1/AJSマニュアルの同コマンドを参照してください。

利用場面

JP1/AJSの設定変更後，変更を反映するためにJP1/AJSを再起動する場合に使用します。

なお，この部品は停止の完了を待たずに非同期で終了しますが，この部品実行後に「JP1/AJSの状態取得」部品を使用することで停止の完了を待つことができます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Automatic Job Management System 3 - Manager 09-00 以降

(2)JP1/Automatic Job Management System 3 - Agent 09-00 以降

【実行対象サーバ内前提製品の稼働OS】

(1) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(2) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(3) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

(1)JP1/AJSが起動していること。

(2)実行対象サーバのJP1/AJSがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/AJSの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/AJSの論理ホスト名を指定してください。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) その他の注意事項については，JP1/AJSマニュアルの同コマンドの注意事項を参照してください。

実行権限

root権限

バージョン

02.02.00

部品のタグ

Control JP1,AJS,Linux

タスクログに表示される部品の名称

jp1ajsStop

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1AJS.processNameOption

プロセス名(n)オプション

実行するコマンドにプロセス名(n)オプションを設定する場合にjajs_schd/jajs_agtd/jajs_dbmdを指定します。省略した場合はプロセス名(n)オプションを設定しません。

−　

入力

△　

JP1AJS.schedulerServiceNameOption

スケジューラーサービス名(F)オプション

実行するコマンドにスケジューラーサービス名(F)オプションを設定する場合にスケジューラーサービス名を指定します。省略した場合はスケジューラーサービス名(F)オプションを設定しません。

−　

入力

△　

JP1AJS.embeddedDatabaseSetupIDOption

組み込みDBセットアップ識別子(id)オプション

実行するコマンドに組み込みDBセットアップ識別子(id)オプションを設定する場合に組み込みDBセットアップ識別子を指定します。省略した場合は組み込みDBセットアップ識別子(id)オプションを設定しません。

−　

入力

△　

JP1AJS.terminationModeOption

終了モードオプション

実行するコマンドに終了モードオプションを設定する場合に-job/-killを指定します。省略した場合は終了モードオプションを設定しません。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.6.17　JP1/AJSユニット存在確認

機能

この部品は，指定したサーバのJP1/AJS3 - Manager (またはJP1/AJS2 - Manager，以降まとめてJP1/AJSと呼びます)に対して，ユニットの存在確認を行います。

この部品が前提とするサーバを次に示します。

・業務サーバ(実行対象サーバ)

　JP1/AJSのジョブネットを実行するサーバです。前提条件に記載のJP1/AJSがセットアップされている必要があります。

この部品は，ユニット名(unitNameプロパティ)に指定されたユニットが存在した場合に戻り値0を返します。

存在しなかった場合または存在確認に失敗した場合には戻り値0以外を返します。

この部品内のスクリプトでは次に示す処理を行います。

・業務サーバの論理ホスト名(JP1.logicalHostNameプロパティ)に値が指定されていた場合，その値をJP1_HOSTNAME環境変数に設定します。

・JP1ユーザー名(JP1AJS.jp1UserNameプロパティ)に値が指定されていた場合，その値をJP1_USERNAME環境変数に設定します。

・次のコマンドを実行します。

　ajsname [-F "JP1/AJSサービス名(JP1AJS.serviceNameプロパティ)の値"]

　　　　　"ユニット名(JP1AJS.unitNameプロパティ)の値" ※

　※ [[スケジューラーサービス名]:]ユニット名の形式で指定してください。

　ajsnameコマンドの詳細については，JP1/AJSのマニュアル「コマンドリファレンス１」を参照してください。

利用場面

他の部品でJP1/AJSのユニットを操作する前にそのユニットの存在確認を行う場合などに使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) JP1/Automatic Job Management System 3 - Manager 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

　(1) JP1ユーザー名(JP1AJS.jp1UserNameプロパティ)には，実行対象サーバでユニットの存在確認を行うためのJP1ユーザー名を指定してください。本製品から接続するOSユーザーと同一名のJP1ユーザーで存在確認を行う場合は，このプロパティに値を指定する必要はありません。

　(2) クラスタ構成の論理ホスト上に定義されているユニットの存在確認を行う場合は，

　・実行対象サーバのホスト名(plugin.destinationHostプロパティ)に実行系サーバの物理ホスト名または論理ホスト名を指定してください。

　・実行対象サーバの論理ホスト名(JP1.logicalHostNameプロパティ)にスケジューラーサービスが動作している論理ホスト名を指定してください。

　・JP1/AJSサービス名(JP1AJS.serviceNameプロパティ)に論理ホストで動作しているスケジューラーサービス名を指定してください。

　(3) 業務サーバのOSがUNIXの場合，業務サーバのJP1/AJSの環境設定パラメタの文字コード設定と業務サーバへの接続ユーザーのデフォルトロケールの設定を一致させてください。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) ユニット名(JP1AJS.unitNameプロパティ)に「¥」(円記号)でキャストした記号文字(「&」「*」「<」「>」「?」「[」「¥」「]」「^」「'」「{」「｜」「}」「~」)を含む文字列を指定した場合でも，プロパティの両端を「"」(ダブルクォーテーション)で囲む必要はありません。

(3) ユニット名(JP1AJS.unitNameプロパティ)には存在確認するユニット名を明示的に指定してください。総称名を表す記号(「*」「?」「[」「]」)を含む文字列は指定しないでください。

(4) その他の注意事項については，JP1/AJSのマニュアル「コマンドリファレンス１」のajsnameコマンドの注意事項を参照してください。

実行権限

(1) 業務サーバに接続するOSユーザーにマッピングされているJP1ユーザーが，確認対象のユニットに対して参照権限を持っている必要があります。

(2) 業務サーバに接続する際のOSユーザーにマッピングされているJP1ユーザーが存在しない場合，JP1ユーザー名(JP1AJS.jp1UserNameプロパティ)に確認対象のユニットに対して参照権限を持つJP1ユーザーを指定してください。

バージョン

02.00.00

部品のタグ

Gather JP1 information, AJS,Windows,Linux

タスクログに表示される部品の名称

jp1ajsExists

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1AJS.jp1UserName

JP1ユーザー名

JP1ユーザー名を指定します。実行対象サーバに接続する際のOSユーザー名と同一のJP1ユーザーで実行する場合，指定する必要はありません。

−　

入力

△　

JP1AJS.serviceName

JP1/AJSサービス名

スケジューラーのサービス名を指定します。

−　

入力

△　

JP1AJS.unitName

ユニット名

存在確認するユニット名を指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7　JP1/Base関連の部品

4.7.1　JP1/Baseイベントサービスの起動(UNIX)

機能

この部品は，UNIXの実行対象サーバで，JP1/Baseのイベントサービスを起動します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

この部品内のスクリプトでは次のコマンドを実行します。

・jevstart ["イベントサーバ名(JP1Base.eventServerNameプロパティ)の値"]

JP1/Baseのjevstartコマンドの詳細については，JP1/Baseマニュアルの同コマンドを参照してください。

利用場面

JP1/Baseの設定変更後，変更を反映するためにJP1/Baseのイベントサービスを再起動する場合に使用します。

なお，この部品は起動の完了を待たずに非同期で終了しますが，この部品実行後に「JP1/Baseイベントサービスの状態取得」部品を使用することで起動の完了を待つことができます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(2) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(3) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

(1)JP1/Baseのイベントサービスが停止していること。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) その他の注意事項については，JP1/Baseマニュアルの同コマンドの注意事項を参照してください。

実行権限

root権限

バージョン

02.02.00

部品のタグ

Control JP1,Base,Linux

タスクログに表示される部品の名称

jp1baseEventStart

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1Base.eventServerName

イベントサーバ名

イベントサーバ名を指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.2　JP1/Baseイベントサービスの状態取得

機能

この部品は，WindowsまたはUNIXの実行対象サーバで，JP1/Baseのイベントサービスの状態を取得します。

また，JP1/Baseのイベントサービスが特定の状態になるまで部品の完了を待たせることができます。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

　jevstat ["イベントサーバ名(JP1Base.eventServerNameプロパティ)の値"]

　　　　　[-t "時間オプション(JP1.timeOptionプロパティ)の値"]

・待ち状態の戻り値(JP1.waitStatusReturnCodeプロパティ)を指定した場合，指定した状態になるか，待ち状態の確認リトライ回数(JP1.waitStatusRetryCountプロパティ)を超過するまで，待ち状態の確認リトライ間隔(JP1.waitStatusRetryIntervalプロパティ)ごとにjevstatコマンドの実行を繰り返します。

JP1/Baseのjevstatコマンドの詳細については，JP1/Baseマニュアルの同コマンドを参照してください。

利用場面

JP1/Baseの設定変更後，変更を反映するためにJP1/Baseのイベントサービスを再起動する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

なし。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) その他の注意事項については，JP1/Baseマニュアルの同コマンドの注意事項を参照してください。

実行権限

Windowsの場合：Administrator権限

UNIXの場合：root権限

バージョン

02.02.00

部品のタグ

Gather JP1 information,Base,Windows,Linux

タスクログに表示される部品の名称

jp1baseEventGetStatus

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1Base.eventServerName

イベントサーバ名

イベントサーバ名を指定します。

−　

入力

△　

JP1.timeOption

時間(t)オプション

実行するコマンドに時間(t)オプションを設定する場合に時間を指定します。省略した場合は時間(t)オプションを設定しません。

−　

入力

△　

JP1.waitStatusReturnCode

待ち状態の戻り値

状態取得コマンドの戻り値が指定した値になるまで繰り返し状態確認コマンドを実行します。省略した場合は繰り返し処理を行いません。

−　

入力

△　

JP1.waitStatusRetryCount

待ち状態の確認リトライ回数

状態取得コマンドを実行するリトライ回数を指定します。

60

入力

△　

JP1.waitStatusRetryInterval

待ち状態の確認リトライ間隔

状態取得コマンドを実行するリトライ間隔を秒単位で指定します。

10

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

common.commandExitCode

実行コマンドの戻り値

実行コマンドの戻り値が格納されます。

−　

出力

△　

common.commandOutput

実行コマンドの出力情報

実行コマンドの標準出力と標準エラー出力が格納されます。

−　

出力

△　

4.7.3　JP1/Baseイベントサービスの停止(UNIX)

機能

この部品は，UNIXの実行対象サーバで，JP1/Baseのイベントサービスを停止します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

この部品内のスクリプトでは次のコマンドを実行します。

・jevstop ["イベントサーバ名(JP1Base.eventServerNameプロパティ)の値"]

JP1/Baseのjevstopコマンドの詳細については，JP1/Baseマニュアルの同コマンドを参照してください。

利用場面

JP1/Baseの設定変更後，変更を反映するためにJP1/Baseのイベントサービスを再起動する場合に使用します。

なお，この部品は停止の完了を待たずに非同期で終了しますが，この部品実行後に「JP1/Baseイベントサービスの状態取得」部品を使用することで停止の完了を待つことができます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(2) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(3) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

(1)JP1/Baseのイベントサービスが起動していること。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) その他の注意事項については，JP1/Baseマニュアルの同コマンドの注意事項を参照してください。

実行権限

root権限

バージョン

02.02.00

部品のタグ

Control JP1,Base,Linux

タスクログに表示される部品の名称

jp1baseEventStop

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1Base.eventServerName

イベントサーバ名

イベントサーバ名を指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.4　JP1/Baseのトラブルシュート情報取得

機能

指定したサーバのJP1/Baseに対し，トラブルシュート情報の収集を実行します。

この部品では，次のサーバを前提とします。

・実行対象サーバ

　JP1/Baseのトラブルシュート情報収集を実行するサーバです。JP1/Baseがセットアップされている必要があります。

プロパティJP1Base.logFolderに指定したフォルダにトラブルシュート情報を収集します。

取得する情報は次のとおりです。なお，取得する情報の詳細や格納形式はJP1/Baseのマニュアルを参照してください。

・JP1/Baseの資料採取ツール(オプション指定なし)で取得できるすべての情報

JP1/Baseの資料採取ツールの出力メッセージは，プロパティJP1Base.logFolderに指定したフォルダ直下にjp1baseGetLog_result.logとして格納します。

利用場面

JP1/Baseの問題調査のため，JP1/Baseのトラブルシュート情報を収集する際に利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

(1)実行対象サーバのJP1/Baseがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/Baseの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/Baseの論理ホスト名を指定してください。

注意事項

(1)実行対象サーバのOSがWindowsの場合，JP1Base.logFolderにすでに存在するフォルダを指定した場合は，いったんフォルダを削除してから再度作成します。削除したくないファイルが格納されているフォルダと同じフォルダ名は指定しないでください。

バージョン

02.00.00

部品のタグ

Troubleshoot JP1,Base,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1baseGetLog

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1Base.logFolder

資料格納フォルダ

JP1/Baseの資料採取ツールで収集されるファイルを格納するフォルダをフルパスで指定します。

−　

入力

○　

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.5　JP1/Baseのパスワード管理情報変更

機能

指定したサーバのJP1/Baseに対して，パスワード管理情報へのOSユーザーの登録・登録済みOSユーザーのパスワード変更を行います(Windows限定)。

この部品では，次のサーバを前提とします。

・エージェントサーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/Baseがセットアップされている必要があります。

この部品の実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。実行対象サーバにAdministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行う部品「JP1/Baseのパスワード管理情報変更(SYSTEM)」を実行してください。

利用場面

JP1ユーザーを登録する際に，あわせてマッピングするOSユーザー情報をJP1/Baseに登録する場合に使用します。

次の部品をあわせて実行することで，JP1ユーザーに関連する設定を効率化することができます。

・jp1baseAddJp1User

・jp1baseSetPermission

・jp1baseAddMapping

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバ内前提製品の使用条件】

(1)実行対象サーバのJP1/Baseがクラスタ構成の場合，プロパティcommon.targetHostnameにはJP1/Baseの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/Baseの論理ホスト名を指定してください。

注意事項

(1)指定したOSユーザー名が，JP1/Baseのパスワード管理情報に登録されているOSユーザー名と一致しない場合は，新規登録となります。

バージョン

02.00.00

部品のタグ

Configure JP1,Base,Windows

タスクログに表示される部品の名称

jp1baseChangeUserInfo

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

common.osUserName

OSユーザー名

JP1/Baseのパスワード管理情報に対し登録または更新するOSユーザー名を指定します。

−　

入力

○　

common.osUserPassword

OSユーザーのパスワード

JP1/Baseのパスワード管理情報に対し登録または更新するOSユーザーのパスワードを指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.6　JP1/Baseのパスワード管理情報変更(SYSTEM)

機能

指定したサーバのJP1/Baseに対して，パスワード管理情報へのOSユーザーの登録・登録済みOSユーザーのパスワード変更を行います(Windows限定)。

この部品では，次のサーバを前提とします。

・エージェントサーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/Baseがセットアップされている必要があります。

利用場面

JP1ユーザーを登録する際に，あわせてマッピングするOSユーザー情報をJP1/Baseに登録する場合に使用します。

次の部品をあわせて実行することで，JP1ユーザーに関連する設定を効率化することができます。

・jp1baseAddJp1User

・jp1baseSetPermission

・jp1baseAddMapping

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバ内前提製品の使用条件】

(1)実行対象サーバのJP1/Baseがクラスタ構成の場合，プロパティcommon.targetHostnameにはJP1/Baseの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/Baseの論理ホスト名を指定してください。

注意事項

(1)指定したOSユーザー名が，JP1/Baseのパスワード管理情報に登録されているOSユーザー名と一致しない場合は，新規登録となります。

バージョン

02.50.01

部品のタグ

Configure JP1,Base,Windows

タスクログに表示される部品の名称

jp1baseChangeUserInfo_System

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

common.osUserName

OSユーザー名

JP1/Baseのパスワード管理情報に対し登録または更新するOSユーザー名を指定します。

−　

入力

○　

common.osUserPassword

OSユーザーのパスワード

JP1/Baseのパスワード管理情報に対し登録または更新するOSユーザーのパスワードを指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.7　JP1/Baseのユーザーマッピング追加

機能

指定したサーバのJP1/Baseに対してユーザーマッピング定義を追加します。

この部品では，次のサーバを前提とします。

・エージェントサーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/Baseがセットアップされている必要があります。

実行対象サーバのOSがWindowsの場合，この部品の実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。実行対象サーバにAdministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行う部品「JP1/Baseのユーザーマッピング追加(SYSTEM)」を実行してください。

利用場面

JP1/Automatic Job Management System 3のジョブ実行環境や，JP1/Integrated Managementによる監視システムにおいて，JP1ユーザーやOSユーザーを登録したあとに，ユーザーマッピング定義を追加する場合に使用できます。

次の部品をあわせて実行することで，JP1ユーザーに関連する設定を効率化することができます。

・jp1baseAddUser

・jp1baseSetPermission

・jp1baseChangeUserInfo

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

(1)実行対象サーバのJP1/Baseがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/Baseの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/Baseの論理ホスト名を指定してください。

注意事項

(1) UNIX環境に対してこの部品を実行する場合は，プロパティにマルチバイト文字を使用しないでください。

バージョン

02.00.00

部品のタグ

Configure JP1,Base,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1baseAddMapping

戻り値

戻り値

説明

0

正常

11

異常(ユーザーミス) 定義ファイル内容の不正

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

14

異常(ユーザーミス) ファイルアクセス不可

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1Base.jp1UserName

JP1ユーザー名

ユーザーマッピングを作成するJP1ユーザー名を指定します。

−　

入力

○　

JP1Base.serverHostName

サーバホスト名

指定したJP1ユーザーによる操作を有効にするサーバのホスト名を指定します。

−　

入力

○　

common.osUserName

OSユーザー名

JP1ユーザーにマッピングするOSユーザーのユーザー名を指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.8　JP1/Baseのユーザーマッピング追加(SYSTEM)

機能

指定したサーバのJP1/Baseに対してユーザーマッピング定義を追加します。

この部品では，次のサーバを前提とします。

・エージェントサーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/Baseがセットアップされている必要があります。

利用場面

JP1/Automatic Job Management System 3のジョブ実行環境や，JP1/Integrated Managementによる監視システムにおいて，JP1ユーザーやOSユーザーを登録したあとに，ユーザーマッピング定義を追加する場合に使用できます。

次の部品をあわせて実行することで，JP1ユーザーに関連する設定を効率化することができます。

・jp1baseAddUser

・jp1baseSetPermission

・jp1baseChangeUserInfo

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

(1)実行対象サーバのJP1/Baseがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/Baseの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/Baseの論理ホスト名を指定してください。

注意事項

(1) UNIX環境に対してこの部品を実行する場合は，プロパティにマルチバイト文字を使用しないでください。

バージョン

02.50.01

部品のタグ

Configure JP1,Base,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1baseAddMapping_System

戻り値

戻り値

説明

0

正常

11

異常(ユーザーミス) 定義ファイル内容の不正

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

14

異常(ユーザーミス) ファイルアクセス不可

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1Base.jp1UserName

JP1ユーザー名

ユーザーマッピングを作成するJP1ユーザー名を指定します。

−　

入力

○　

JP1Base.serverHostName

サーバホスト名

指定したJP1ユーザーによる操作を有効にするサーバのホスト名を指定します。

−　

入力

○　

common.osUserName

OSユーザー名

JP1ユーザーにマッピングするOSユーザーのユーザー名を指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.9　JP1/Baseの起動(UNIX)

機能

この部品は，UNIXの実行対象サーバで，JP1/Baseを起動します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

この部品内のスクリプトでは次のコマンドを実行します。

・jbs_spmd [-h "実行対象サーバの論理ホスト名(JP1.logicalHostNameプロパティ)の値"]

　　　　　 [-HA]※1

※1 HAオプション(JP1.haOptionプロパティ)の値に"true"を指定した場合に設定されます。

JP1/Baseのjbs_spmdコマンドの詳細については，JP1/Baseマニュアルの同コマンドを参照してください。

利用場面

JP1/Baseの設定変更後，変更を反映するためにJP1/Baseを再起動する場合に使用します。

なお，この部品は起動の完了を待たずに非同期で終了しますが，この部品実行後に「JP1/Baseの状態取得」部品を使用することで起動の完了を待つことができます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(2) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(3) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

(1)JP1/Baseが停止していること。

(2)実行対象サーバのJP1/Baseがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/Baseの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/Baseの論理ホスト名を指定してください。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) その他の注意事項については，JP1/Baseマニュアルの同コマンドの注意事項を参照してください。

実行権限

root権限

バージョン

02.02.00

部品のタグ

Control JP1,Base,Linux

タスクログに表示される部品の名称

jp1baseStart

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1.haOption

HAオプション

実行するコマンドにHAオプションを設定する場合は"true"を指定します。"true"以外の場合は，HAオプションを設定しません。

false

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.10　JP1/Baseの状態取得

機能

この部品は，WindowsまたはUNIXの実行対象サーバで，JP1/Baseの状態を取得します。

また，JP1/Baseが特定の状態になるまで部品の完了を待たせることができます。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

　jbs_spmd_status [-h "論理ホスト名(JP1.logicalHostNameプロパティ)の値"]

　　　　　　　　　[-t "時間オプション(JP1.timeOptionプロパティ)の値"]

・待ち状態の戻り値(JP1.waitStatusReturnCodeプロパティ)を指定した場合，指定した状態になるか，待ち状態の確認リトライ回数(JP1.waitStatusRetryCountプロパティ)を超過するまで，待ち状態の確認リトライ間隔(JP1.waitStatusRetryIntervalプロパティ)ごとにjbs_spmd_statusコマンドの実行を繰り返します。

JP1/Baseのjbs_spmd_statusコマンドの詳細については，JP1/Baseマニュアルの同コマンドを参照してください。

利用場面

JP1/Baseの設定変更後，変更を反映するためにJP1/Baseを再起動する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

(1)実行対象サーバのJP1/Baseがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/Baseの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/Baseの論理ホスト名を指定してください。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) その他の注意事項については，JP1/Baseマニュアルの同コマンドの注意事項を参照してください。

実行権限

Windowsの場合：Administrator権限

UNIXの場合：root権限

バージョン

02.02.00

部品のタグ

Gather JP1 information,Base,Windows,Linux

タスクログに表示される部品の名称

jp1baseGetStatus

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1.timeOption

時間(t)オプション

実行するコマンドに時間(t)オプションを設定する場合に時間を指定します。省略した場合は時間(t)オプションを設定しません。

−　

入力

△　

JP1.waitStatusReturnCode

待ち状態の戻り値

状態取得コマンドの戻り値が指定した値になるまで繰り返し状態確認コマンドを実行します。省略した場合は繰り返し処理を行いません。

−　

入力

△　

JP1.waitStatusRetryCount

待ち状態の確認リトライ回数

状態取得コマンドを実行するリトライ回数を指定します。

60

入力

△　

JP1.waitStatusRetryInterval

待ち状態の確認リトライ間隔

状態取得コマンドを実行するリトライ間隔を秒単位で指定します。

10

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

common.commandExitCode

実行コマンドの戻り値

実行コマンドの戻り値が格納されます。

−　

出力

△　

common.commandOutput

実行コマンドの出力情報

実行コマンドの標準出力と標準エラー出力が格納されます。

−　

出力

△　

4.7.11　JP1/Baseの停止(UNIX)

機能

この部品は，UNIXの実行対象サーバで，JP1/Baseを停止します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

この部品内のスクリプトでは次のコマンドを実行します。

・jbs_spmd_stop [-h "論理ホスト名(JP1.logicalHostNameプロパティ)の値"]

　　　　　　　　[-kill]※1

※1 killオプション(JP1.killOptionプロパティ)の値に"true"を指定した場合に設定されます。

JP1/Baseのjbs_spmd_stopコマンドの詳細については，JP1/Baseマニュアルの同コマンドを参照してください。

利用場面

JP1/Baseの設定変更後，変更を反映するためにJP1/Baseを再起動する場合に使用します。

なお，この部品は停止の完了を待たずに非同期で終了しますが，この部品実行後に「JP1/Baseの状態取得」部品を使用することで停止の完了を待つことができます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(2) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(3) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

(1)JP1/Baseが起動していること。

(2)実行対象サーバのJP1/Baseがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/Baseの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/Baseの論理ホスト名を指定してください。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) その他の注意事項については，JP1/Baseマニュアルの同コマンドの注意事項を参照してください。

実行権限

root権限

バージョン

02.02.00

部品のタグ

Control JP1,Base,Linux

タスクログに表示される部品の名称

jp1baseStop

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1.killOption

killオプション

実行するコマンドにkillオプションを設定する場合は"true"を指定します。"true"以外の場合は，killオプションを設定しません。

false

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.12　JP1/Baseユーザーマッピング削除

機能

指定したサーバのJP1/Baseに対し，ユーザーマッピング情報を削除します。

この部品では，次のサーバを前提とします。

・エージェントサーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/Baseがセットアップされている必要があります。

実行対象サーバのOSがWindowsの場合，この部品の実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。実行対象サーバにAdministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行う部品「JP1/Baseユーザーマッピング削除(SYSTEM)」を実行してください。

利用場面

運用に使用するOSユーザーの削除の際に，ユーザーマッピング情報の削除をあわせて実行する場合などに利用できます。また，下記部品と組みあわせて，JP1ユーザーを削除する際に必要となるユーザーマッピング情報，パスワード管理情報および操作権限の削除を行うことで，JP1ユーザーの削除作業を効率化できます。

・jp1baseDeleteJp1User

・jp1baseDeletePermission

・jp1baseDeleteUserInfo

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

(1)実行対象サーバのJP1/Baseがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/Baseの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/Baseの論理ホスト名を指定してください。

(2)JP1ユーザーに定義されたすべてのマッピング情報を削除する場合は，プロパティJP1Base.serverHostNameを指定せずに実行してください。

注意事項

(1) UNIX環境に対してこの部品を実行する場合は，プロパティにマルチバイト文字を使用しないでください。

バージョン

02.00.00

部品のタグ

Configure JP1,Base,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1baseDeleteMapping

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1Base.jp1UserName

JP1ユーザー名

マッピング情報を削除するJP1ユーザー名を指定します。

−　

入力

○　

JP1Base.serverHostName

サーバホスト名

指定したJP1ユーザーに設定されているサーバのホスト名を指定します。このプロパティを省略した場合，指定したJP1ユーザーのすべてのマッピング情報が削除されます。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.13　JP1/Baseユーザーマッピング削除(SYSTEM)

機能

指定したサーバのJP1/Baseに対し，ユーザーマッピング情報を削除します。

この部品では，次のサーバを前提とします。

・エージェントサーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/Baseがセットアップされている必要があります。

利用場面

運用に使用するOSユーザーの削除の際に，ユーザーマッピング情報の削除をあわせて実行する場合などに利用できます。また，下記部品と組みあわせて，JP1ユーザーを削除する際に必要となるユーザーマッピング情報，パスワード管理情報および操作権限の削除を行うことで，JP1ユーザーの削除作業を効率化できます。

・jp1baseDeleteJp1User

・jp1baseDeletePermission

・jp1baseDeleteUserInfo

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

(1)実行対象サーバのJP1/Baseがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/Baseの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/Baseの論理ホスト名を指定してください。

(2)JP1ユーザーに定義されたすべてのマッピング情報を削除する場合は，プロパティJP1Base.serverHostNameを指定せずに実行してください。

注意事項

(1) UNIX環境に対してこの部品を実行する場合は，プロパティにマルチバイト文字を使用しないでください。

バージョン

02.50.01

部品のタグ

Configure JP1,Base,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1baseDeleteMapping_System

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1Base.jp1UserName

JP1ユーザー名

マッピング情報を削除するJP1ユーザー名を指定します。

−　

入力

○　

JP1Base.serverHostName

サーバホスト名

指定したJP1ユーザーに設定されているサーバのホスト名を指定します。このプロパティを省略した場合，指定したJP1ユーザーのすべてのマッピング情報が削除されます。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.14　JP1/Base共通定義情報設定

機能

この部品は，指定したサーバのJP1/Baseに対して共通定義情報を設定します。

この部品では，次のサーバを前提とします。

・実行対象サーバ

　この部品を実行する対象です。

利用場面

管理するサーバの増加などによって，インストールされているJP1/Baseに共通定義情報を設定する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Base 08-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) AIX V6

　(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

　なし。

注意事項

(1) UNIX環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

(2) この部品は，共通定義設定用ファイルの記述が誤っていても，正常終了する場合があります。共通定義設定用ファイルに誤りがないか，十分に確認してください。

　誤った共通定義情報を設定した場合，再度正しい共通定義情報を設定しても不要な設定が残る場合は，手動で訂正してください。

(3) JP1/Baseがクラスタ構成の場合，共通定義設定用ファイル内に指定した論理ホストと一致する環境にだけ実行可能です。一致しない環境へ実行した場合，部品は正常終了しますが，実行対象サーバは正しく動作しません。

実行権限

Windowsの場合：Administrator権限

UNIXの場合：root権限

バージョン

02.00.00

部品のタグ

Configure JP1,Base,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1baseSetCommonDefinitionInfo

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1Base.commonDefinitionFileName

JP1/Base共通定義設定用ファイル名

JP1/Baseの共通定義設定用ファイル名をフルパスで指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.15　JP1/Base操作権限設定

機能

指定したサーバのJP1/Baseに対して，JP1ユーザーの操作権限(JP1資源グループ，アクセスレベル)を設定します。

この部品では，次のサーバを前提とします。

・JP1認証サーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/Baseがセットアップされ，認証サーバが起動している必要があります。

実行対象サーバのOSがWindowsの場合，この部品の実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。実行対象サーバにAdministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行う部品「JP1/Base操作権限設定(SYSTEM)」を実行してください。

利用場面

JP1/Automatic Job Management System 3のジョブ実行環境や，JP1/Integrated Managementによる監視システムにおいて，新規にJP1ユーザーを登録したあとに，操作権限を設定する場合に使用できます。

次の部品をあわせて実行することで，JP1ユーザーに関連する設定を効率化することができます。

・jp1baseAddJp1User（Windowsの場合のみ）

・jp1baseAddMapping

・jp1baseChangeUserInfo

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

(1)JP1/Baseの認証サーバが起動していること。

(2)実行対象サーバのJP1/Baseがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/Baseの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/Baseの論理ホスト名を指定してください。

(3)ユーザー権限レベルファイル(JP1_UserLevel)が用意されていること。

注意事項

(1) UNIX環境に対してこの部品を実行する場合は，プロパティにマルチバイト文字を使用しないでください。

バージョン

02.00.00

部品のタグ

Configure JP1,Base,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1baseSetPermission

戻り値

戻り値

説明

0

正常

11

異常(ユーザーミス) 定義ファイル内容の不正

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

24

異常(環境不正) 起動状態不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1Base.authenticationServerName

認証サーバ名

JP1/Baseの認証サーバのホスト名を指定します。

−　

入力

△　

JP1Base.definitionFileName

ユーザー権限レベルファイルのパス

JP1/Baseのユーザー権限レベルファイルのパスをフルパスで指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.16　JP1/Base操作権限設定(SYSTEM)

機能

指定したサーバのJP1/Baseに対して，JP1ユーザーの操作権限(JP1資源グループ，アクセスレベル)を設定します。

この部品では，次のサーバを前提とします。

・JP1認証サーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/Baseがセットアップされ，認証サーバが起動している必要があります。

利用場面

JP1/Automatic Job Management System 3のジョブ実行環境や，JP1/Integrated Managementによる監視システムにおいて，新規にJP1ユーザーを登録したあとに，操作権限を設定する場合に使用できます。

次の部品をあわせて実行することで，JP1ユーザーに関連する設定を効率化することができます。

・jp1baseAddJp1User（Windowsの場合のみ）

・jp1baseAddMapping

・jp1baseChangeUserInfo

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

(1)JP1/Baseの認証サーバが起動していること。

(2)実行対象サーバのJP1/Baseがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/Baseの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/Baseの論理ホスト名を指定してください。

(3)ユーザー権限レベルファイル(JP1_UserLevel)が用意されていること。

注意事項

(1) UNIX環境に対してこの部品を実行する場合は，プロパティにマルチバイト文字を使用しないでください。

バージョン

02.50.01

部品のタグ

Configure JP1,Base,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1baseSetPermission_System

戻り値

戻り値

説明

0

正常

11

異常(ユーザーミス) 定義ファイル内容の不正

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

24

異常(環境不正) 起動状態不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1Base.authenticationServerName

認証サーバ名

JP1/Baseの認証サーバのホスト名を指定します。

−　

入力

△　

JP1Base.definitionFileName

ユーザー権限レベルファイルのパス

JP1/Baseのユーザー権限レベルファイルのパスをフルパスで指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.17　JP1イベントの登録

機能

この部品は，指定したサーバのJP1/Baseに対してJP1イベントを登録します。

また，送信先イベントサーバ名を指定した場合は，JP1イベントの到達確認を行います。

この部品では，次のサーバを前提とします。

・エージェントサーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/Baseがセットアップされ，イベントサーバが起動している必要があります。

送信先イベントサーバ名が指定されている場合は，最初は3秒後にJP1イベントの到達確認を行います。そのあとは，確認間隔に指定した秒数ごとに，確認回数に指定した回数JP1イベントの到達確認を繰り返します。最大確認時間は，3+(確認間隔)*(確認回数)秒となります。

利用場面

JP1/AOの作業で発生した障害をJP1イベントとしてJP1/IM - Managerに登録します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) AIX V6

　(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

　(1)JP1/Baseのイベントサービスが起動していること。

注意事項

(1)エージェントサーバの稼働OSがUNIXである環境に対してこの部品を実行する場合は，プロパティにマルチバイト文字を使用しないでください。

(2)送信先イベントサーバ名を指定し，"KAJP1743-E 送信先イベントサーバへのイベントの到達を確認できませんでした"のメッセージが部品の標準出力として出力された場合，JP1イベントの送信は続行中です。その場合はJP1イベントを送信したホストのJP1/IM - ViewからJP1イベントが到達したか確認してください。

(3)拡張属性プロパティ(jp1base.extendedAttribute1〜jp1base.extendedAttribute20)に「=」で始まる値を指定した場合，そのプロパティは無視されます。

バージョン

02.00.00

部品のタグ

Control JP1,Base,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1baseSendEvent

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1Base.eventID

イベントID

登録するJP1イベントのイベントIDを指定します。

−　

入力

△　

JP1Base.message

メッセージ

登録するJP1イベントのメッセージを指定します。

−　

入力

△　

JP1Base.destinationEventServerName

送信先イベントサーバ名

登録するJP1イベントを任意のイベントサーバに送信する場合は，送信先のイベントサーバ名を指定します。

−　

入力

△　

JP1Base.sourceEventServerName

送信元イベントサーバ名

クラスタ構成の場合に，論理ホストのイベントサーバを指定します。送信先イベントサーバ名を指定しない場合は，このイベントサーバにJP1イベントを登録します。送信先イベントサーバ名を指定する場合は，このイベントサーバはJP1イベントの転送のために使用します。

−　

入力

△　

JP1Base.checkInterval

確認間隔

登録したJP1イベントが指定した送信先イベントサーバに到達したか確認する間隔(秒)を指定します。確認回数と組み合わせて最大確認時間となります。送信先イベントサーバ名を指定した場合は必ず指定してください。

−　

入力

△　

JP1Base.checkCount

確認回数

登録したJP1イベントが指定した送信先イベントサーバに到達したか確認する回数を指定します。送信先イベントサーバ名を指定した場合は必ず指定してください。

−　

入力

△　

JP1Base.extendedAttribute1

拡張属性1

登録するJP1イベントの拡張属性を指定します。「拡張属性名=拡張属性値」の形式で指定してください。

−　

入力

△　

JP1Base.extendedAttribute2

拡張属性2

登録するJP1イベントの拡張属性を指定します。「拡張属性名=拡張属性値」の形式で指定してください。

−　

入力

△　

JP1Base.extendedAttribute3

拡張属性3

登録するJP1イベントの拡張属性を指定します。「拡張属性名=拡張属性値」の形式で指定してください。

−　

入力

△　

JP1Base.extendedAttribute4

拡張属性4

登録するJP1イベントの拡張属性を指定します。「拡張属性名=拡張属性値」の形式で指定してください。

−　

入力

△　

JP1Base.extendedAttribute5

拡張属性5

登録するJP1イベントの拡張属性を指定します。「拡張属性名=拡張属性値」の形式で指定してください。

−　

入力

△　

JP1Base.extendedAttribute6

拡張属性6

登録するJP1イベントの拡張属性を指定します。「拡張属性名=拡張属性値」の形式で指定してください。

−　

入力

△　

JP1Base.extendedAttribute7

拡張属性7

登録するJP1イベントの拡張属性を指定します。「拡張属性名=拡張属性値」の形式で指定してください。

−　

入力

△　

JP1Base.extendedAttribute8

拡張属性8

発行するJP1イベントの拡張属性を指定します。「拡張属性名=拡張属性値」の形式で指定してください。

−　

入力

△　

JP1Base.extendedAttribute9

拡張属性9

登録するJP1イベントの拡張属性を指定します。「拡張属性名=拡張属性値」の形式で指定してください。

−　

入力

△　

JP1Base.extendedAttribute10

拡張属性10

登録するJP1イベントの拡張属性を指定します。「拡張属性名=拡張属性値」の形式で指定してください。

−　

入力

△　

JP1Base.extendedAttribute11

拡張属性11

登録するJP1イベントの拡張属性を指定します。「拡張属性名=拡張属性値」の形式で指定してください。

−　

入力

△　

JP1Base.extendedAttribute12

拡張属性12

登録するJP1イベントの拡張属性を指定します。「拡張属性名=拡張属性値」の形式で指定してください。

−　

入力

△　

JP1Base.extendedAttribute13

拡張属性13

登録するJP1イベントの拡張属性を指定します。「拡張属性名=拡張属性値」の形式で指定してください。

−　

入力

△　

JP1Base.extendedAttribute14

拡張属性14

登録するJP1イベントの拡張属性を指定します。「拡張属性名=拡張属性値」の形式で指定してください。

−　

入力

△　

JP1Base.extendedAttribute15

拡張属性15

登録するJP1イベントの拡張属性を指定します。「拡張属性名=拡張属性値」の形式で指定してください。

−　

入力

△　

JP1Base.extendedAttribute16

拡張属性16

登録するJP1イベントの拡張属性を指定します。「拡張属性名=拡張属性値」の形式で指定してください。

−　

入力

△　

JP1Base.extendedAttribute17

拡張属性17

登録するJP1イベントの拡張属性を指定します。「拡張属性名=拡張属性値」の形式で指定してください。

−　

入力

△　

JP1Base.extendedAttribute18

拡張属性18

登録するJP1イベントの拡張属性を指定します。「拡張属性名=拡張属性値」の形式で指定してください。

−　

入力

△　

JP1Base.extendedAttribute19

拡張属性19

登録するJP1イベントの拡張属性を指定します。「拡張属性名=拡張属性値」の形式で指定してください。

−　

入力

△　

JP1Base.extendedAttribute20

拡張属性20

登録するJP1イベントの拡張属性を指定します。「拡張属性名=拡張属性値」の形式で指定してください。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.18　JP1ユーザーパスワード変更

機能

指定したサーバのJP1/Baseに対してJP1ユーザーのパスワード変更を実行します。

UNIX環境で使用する場合は「運用ユーザー変更」または「運用ユーザー一括変更」サービステンプレートで使用してください。それ以外のサービステンプレートで使用することをサポートしていません。

この部品では，次のサーバを前提とします。

・JP1認証サーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/Baseがセットアップされ，認証サーバが起動している必要があります。

実行対象サーバのOSがWindowsの場合，この部品の実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。実行対象サーバにAdministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行う部品「JP1ユーザーパスワード変更(SYSTEM)」を実行してください。

利用場面

JP1/Automatic Job Management System 3のジョブ実行環境や，JP1/Integrated Managementによる監視システムで，JP1/Baseの認証サーバに登録されたJP1ユーザーのパスワード変更に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

(1)JP1/Baseの認証サーバが起動していること。

(2)実行対象サーバのJP1/Baseがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/Baseの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/Baseの論理ホスト名を指定してください。

注意事項

(1) UNIX環境に対してこの部品を実行する場合は，プロパティにマルチバイト文字を使用しないでください。

バージョン

02.00.00

部品のタグ

Configure JP1,Base,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1baseChangePassword

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

24

異常(環境不正) 起動状態不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1Base.authenticationServerName

認証サーバ名

JP1/Baseの認証サーバのホスト名を指定します。

−　

入力

△　

JP1Base.password

JP1ユーザーのパスワード

JP1ユーザーのパスワードを指定します。

−　

入力

△　

JP1Base.newPassword

JP1ユーザーの新パスワード

JP1ユーザーの新しいパスワードを指定します。

−　

入力

△　

JP1Base.newpasswordReEnter

JP1ユーザーの新パスワード再入力

JP1ユーザーの新しいパスワードを再度指定します。

−　

入力

△　

JP1Base.jp1UserName

JP1ユーザー名

パスワードを変更するJP1ユーザー名を指定します。

−　

入力

○　

common.tmpFileID

一時ファイル識別ID

UNIX環境の場合に，一時ファイルを識別するIDを指定します。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.19　JP1ユーザーパスワード変更(SYSTEM)

機能

指定したサーバのJP1/Baseに対してJP1ユーザーのパスワード変更を実行します。

UNIX環境で使用する場合は「運用ユーザー変更」または「運用ユーザー一括変更」サービステンプレートで使用してください。それ以外のサービステンプレートで使用することをサポートしていません。

この部品では，次のサーバを前提とします。

・JP1認証サーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/Baseがセットアップされ，認証サーバが起動している必要があります。

利用場面

JP1/Automatic Job Management System 3のジョブ実行環境や，JP1/Integrated Managementによる監視システムで，JP1/Baseの認証サーバに登録されたJP1ユーザーのパスワード変更に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

(1)JP1/Baseの認証サーバが起動していること。

(2)実行対象サーバのJP1/Baseがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/Baseの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/Baseの論理ホスト名を指定してください。

注意事項

(1) UNIX環境に対してこの部品を実行する場合は，プロパティにマルチバイト文字を使用しないでください。

バージョン

02.50.01

部品のタグ

Configure JP1,Base,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1baseChangePassword_System

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

24

異常(環境不正) 起動状態不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1Base.authenticationServerName

認証サーバ名

JP1/Baseの認証サーバのホスト名を指定します。

−　

入力

△　

JP1Base.password

JP1ユーザーのパスワード

JP1ユーザーのパスワードを指定します。

−　

入力

△　

JP1Base.newPassword

JP1ユーザーの新パスワード

JP1ユーザーの新しいパスワードを指定します。

−　

入力

△　

JP1Base.newpasswordReEnter

JP1ユーザーの新パスワード再入力

JP1ユーザーの新しいパスワードを再度指定します。

−　

入力

△　

JP1Base.jp1UserName

JP1ユーザー名

パスワードを変更するJP1ユーザー名を指定します。

−　

入力

○　

common.tmpFileID

一時ファイル識別ID

UNIX環境の場合に，一時ファイルを識別するIDを指定します。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.20　JP1ユーザー一覧取得

機能

この部品は，指定されたファイルにJP1ユーザーの一覧をテキスト形式で出力します。ファイルの出力形式は，JP1/Baseのjbslistuserコマンドの出力結果と同じ形式です。

利用場面

JP1で運用している場合，定義してあるJP1ユーザーを確認します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) AIX V6

　(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

　(1)JP1/Baseの認証サーバが起動していること。

注意事項

(1) UNIX環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

実行権限

Windowsの場合：Administrator権限

UNIXの場合：root権限

バージョン

02.00.00

部品のタグ

Gather JP1 information,Base,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1baseShowUsers

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

24

異常(環境不正) 起動状態不正

25

異常(環境不正) 通信エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1Base.jp1BaseLHostName

JP1/Baseの論理ホスト名

JP1/Baseの論理ホスト名を指定します。

−　

入力

△　

JP1Base.listJP1UserOutputFileName

JP1ユーザー一覧出力ファイル名

JP1ユーザー一覧を出力するファイル名をフルパスで指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.21　JP1ユーザー削除

機能

指定したサーバのJP1/BaseでJP1ユーザーを削除します。

この部品では，次のサーバを前提とします。

・JP1認証サーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/Baseがセットアップされ，認証サーバが起動している必要があります。

実行対象サーバのOSがWindowsの場合，この部品の実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。実行対象サーバにAdministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行う部品「JP1ユーザー削除(SYSTEM)」を実行してください。

利用場面

運用に使用するOSユーザーの削除の際に，JP1ユーザーの削除をあわせて実行する場合などに利用できます。下記部品と組みあわせて，JP1ユーザーを削除する際に必要となるユーザーマッピング情報，パスワード管理情報および操作権限の削除を行うことで，JP1ユーザーの削除作業を効率化できます。

・jp1baseDeletePermission

・jp1baseDeleteMapping

・jp1baseDeleteUserInfo

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

(1)JP1/Baseの認証サーバが起動していること。

(2)実行対象サーバのJP1/Baseがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/Baseの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/Baseの論理ホスト名を指定してください。

注意事項

(1) UNIX環境に対してこの部品を実行する場合は，プロパティにマルチバイト文字を使用しないでください。

バージョン

02.00.00

部品のタグ

Configure JP1,Base,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1baseDeleteJp1user

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

24

異常(環境不正) 起動状態不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1Base.authenticationServerName

認証サーバ名

JP1/Baseの認証サーバのホスト名を指定します。

−　

入力

△　

JP1Base.jp1UserName

JP1ユーザー名

削除するJP1ユーザー名を指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.22　JP1ユーザー削除(SYSTEM)

機能

指定したサーバのJP1/BaseでJP1ユーザーを削除します。

この部品では，次のサーバを前提とします。

・JP1認証サーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/Baseがセットアップされ，認証サーバが起動している必要があります。

利用場面

運用に使用するOSユーザーの削除の際に，JP1ユーザーの削除をあわせて実行する場合などに利用できます。下記部品と組みあわせて，JP1ユーザーを削除する際に必要となるユーザーマッピング情報，パスワード管理情報および操作権限の削除を行うことで，JP1ユーザーの削除作業を効率化できます。

・jp1baseDeletePermission

・jp1baseDeleteMapping

・jp1baseDeleteUserInfo

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

(1)JP1/Baseの認証サーバが起動していること。

(2)実行対象サーバのJP1/Baseがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/Baseの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/Baseの論理ホスト名を指定してください。

注意事項

(1) UNIX環境に対してこの部品を実行する場合は，プロパティにマルチバイト文字を使用しないでください。

バージョン

02.50.01

部品のタグ

Configure JP1,Base,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1baseDeleteJp1user_System

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

24

異常(環境不正) 起動状態不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1Base.authenticationServerName

認証サーバ名

JP1/Baseの認証サーバのホスト名を指定します。

−　

入力

△　

JP1Base.jp1UserName

JP1ユーザー名

削除するJP1ユーザー名を指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.23　JP1ユーザー操作権限削除

機能

指定したサーバのJP1/Baseに対して，JP1ユーザーのすべての操作権限(JP1資源グループ，アクセスレベル)を削除します。

この部品では，次のサーバを前提とします。

・JP1認証サーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/Baseがセットアップされ，認証サーバが起動している必要があります。

実行対象サーバのOSがWindowsの場合，この部品の実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。実行対象サーバにAdministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行う部品「JP1ユーザー操作権限削除(SYSTEM)」を実行してください。

利用場面

JP1ユーザーを削除する際に必要となる，ユーザーマッピング情報，パスワード管理情報および操作権限の情報を削除する場合に利用することで，JP1ユーザーの削除作業を効率化できます。

次の部品とあわせて利用できます。

・jp1baseDeleteMapping

・jp1baseDeleteUserInfo

・jp1baseDeleteJP1User

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

(1)JP1/Baseの認証サーバが起動していること。

(2)実行対象サーバのJP1/Baseがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/Baseの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/Baseの論理ホスト名を指定してください。

注意事項

(1) UNIX環境に対してこの部品を実行する場合は，プロパティにマルチバイト文字を使用しないでください。

バージョン

02.00.00

部品のタグ

Configure JP1,Base,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1baseDeletePermission

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

14

異常(ユーザーミス) ファイルアクセス不可

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

24

異常(環境不正) 起動状態不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1Base.authenticationServerName

認証サーバ名

JP1/Baseの認証サーバのホスト名を指定します。

−　

入力

△　

JP1Base.jp1UserName

JP1ユーザー名

操作権限を削除するJP1ユーザー名を指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.24　JP1ユーザー操作権限削除(SYSTEM)

機能

指定したサーバのJP1/Baseに対して，JP1ユーザーのすべての操作権限(JP1資源グループ，アクセスレベル)を削除します。

この部品では，次のサーバを前提とします。

・JP1認証サーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/Baseがセットアップされ，認証サーバが起動している必要があります。

利用場面

JP1ユーザーを削除する際に必要となる，ユーザーマッピング情報，パスワード管理情報および操作権限の情報を削除する場合に利用することで，JP1ユーザーの削除作業を効率化できます。

次の部品とあわせて利用できます。

・jp1baseDeleteMapping

・jp1baseDeleteUserInfo

・jp1baseDeleteJP1User

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

(1)JP1/Baseの認証サーバが起動していること。

(2)実行対象サーバのJP1/Baseがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/Baseの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/Baseの論理ホスト名を指定してください。

注意事項

(1) UNIX環境に対してこの部品を実行する場合は，プロパティにマルチバイト文字を使用しないでください。

バージョン

02.50.01

部品のタグ

Configure JP1,Base,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1baseDeletePermission_System

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

14

異常(ユーザーミス) ファイルアクセス不可

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

24

異常(環境不正) 起動状態不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1Base.authenticationServerName

認証サーバ名

JP1/Baseの認証サーバのホスト名を指定します。

−　

入力

△　

JP1Base.jp1UserName

JP1ユーザー名

操作権限を削除するJP1ユーザー名を指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.25　JP1ユーザー追加

機能

指定したサーバのJP1/Baseに対してJP1ユーザーを追加します。

UNIX環境で使用する場合は「運用ユーザー追加」サービステンプレートで使用してください。それ以外のサービステンプレートで使用することをサポートしていません。

この部品では，次のサーバを前提とします。

・JP1認証サーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/Baseがセットアップされ，認証サーバが起動している必要があります。

実行対象サーバのOSがWindowsの場合，この部品の実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。実行対象サーバにAdministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行う部品「JP1ユーザー追加(SYSTEM)」を実行してください。

利用場面

JP1/Automatic Job Management System 3のジョブ実行環境や，JP1/Integrated Managementによる監視システムにおいて，新規にJP1ユーザーを登録する場合に使用できます。

次の部品をあわせて実行することで，JP1ユーザーに関連する設定を効率化することができます。

・jp1baseSetPermission

・jp1baseAddMapping

・jp1baseChangeUserInfo

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

(1)JP1/Baseの認証サーバが起動していること。

(2)実行対象サーバのJP1/Baseがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/Baseの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/Baseの論理ホスト名を指定してください。

注意事項

(1) Active Directoryと認証連携した環境には対応していません。

(2) UNIX環境に対してこの部品を実行する場合は，プロパティにマルチバイト文字を使用しないでください。

バージョン

02.00.00

部品のタグ

Configure JP1,Base,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1baseAddJp1user

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

24

異常(環境不正) 起動状態不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1Base.authenticationServerName

認証サーバ名

JP1/Baseの認証サーバのホスト名を指定します。

−　

入力

△　

JP1Base.password

JP1ユーザーのパスワード

JP1ユーザーのパスワードを指定します。

−　

入力

△　

JP1Base.newpasswordReEnter

JP1ユーザーの新パスワード再入力

JP1ユーザーの新しいパスワードを再度指定します。

−　

入力

△　

JP1Base.jp1UserName

JP1ユーザー名

作成するJP1ユーザー名を指定します。

−　

入力

○　

common.tmpFileID

一時ファイル識別ID

UNIX環境の場合に，一時ファイルを識別するIDを指定します。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.26　JP1ユーザー追加(SYSTEM)

機能

指定したサーバのJP1/Baseに対してJP1ユーザーを追加します。

UNIX環境で使用する場合は「運用ユーザー追加」サービステンプレートで使用してください。それ以外のサービステンプレートで使用することをサポートしていません。

この部品では，次のサーバを前提とします。

・JP1認証サーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/Baseがセットアップされ，認証サーバが起動している必要があります。

利用場面

JP1/Automatic Job Management System 3のジョブ実行環境や，JP1/Integrated Managementによる監視システムにおいて，新規にJP1ユーザーを登録する場合に使用できます。

次の部品をあわせて実行することで，JP1ユーザーに関連する設定を効率化することができます。

・jp1baseSetPermission

・jp1baseAddMapping

・jp1baseChangeUserInfo

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

(1)JP1/Baseの認証サーバが起動していること。

(2)実行対象サーバのJP1/Baseがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/Baseの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/Baseの論理ホスト名を指定してください。

注意事項

(1) Active Directoryと認証連携した環境には対応していません。

(2) UNIX環境に対してこの部品を実行する場合は，プロパティにマルチバイト文字を使用しないでください。

バージョン

02.50.01

部品のタグ

Configure JP1,Base,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1baseAddJp1user_System

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

24

異常(環境不正) 起動状態不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

JP1Base.authenticationServerName

認証サーバ名

JP1/Baseの認証サーバのホスト名を指定します。

−　

入力

△　

JP1Base.password

JP1ユーザーのパスワード

JP1ユーザーのパスワードを指定します。

−　

入力

△　

JP1Base.newpasswordReEnter

JP1ユーザーの新パスワード再入力

JP1ユーザーの新しいパスワードを再度指定します。

−　

入力

△　

JP1Base.jp1UserName

JP1ユーザー名

作成するJP1ユーザー名を指定します。

−　

入力

○　

common.tmpFileID

一時ファイル識別ID

UNIX環境の場合に，一時ファイルを識別するIDを指定します。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.27　OSユーザー情報の削除

機能

指定されたサーバのJP1/Baseに対し，パスワード管理情報に登録されているOSユーザー情報の削除を行います(Windows限定)。

この部品では，次のサーバを前提とします。

・エージェントサーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/Baseがセットアップされている必要があります。

この部品の実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。実行対象サーバにAdministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行う部品「OSユーザー情報の削除(SYSTEM)」を実行してください。

利用場面

運用に使用するOSユーザーの削除の際に，パスワード管理情報からOSユーザー情報を削除する場合などに利用できます。また，下記部品と組みあわせて，JP1ユーザーを削除する際に必要となるユーザーマッピング情報，パスワード管理情報および操作権限の削除を行うことで，JP1ユーザーの削除作業を効率化できます。

・jp1baseDeleteJp1User

・jp1baseDeleteMapping

・jp1baseDeletePermission

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバ内前提製品の使用条件】

(1)JP1/Baseの認証サーバが起動していること。

(2)実行対象サーバのJP1/Baseがクラスタ構成の場合，プロパティcommon.targetHostnameにはJP1/Baseの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/Baseの論理ホスト名を指定してください。

バージョン

02.00.00

部品のタグ

Configure JP1,Base,Windows

タスクログに表示される部品の名称

jp1baseDeleteUserInfo

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

common.osUserName

OSユーザー名

JP1/Baseのパスワード管理情報から削除するOSユーザーのユーザー名を指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.28　OSユーザー情報の削除(SYSTEM)

機能

指定されたサーバのJP1/Baseに対し，パスワード管理情報に登録されているOSユーザー情報の削除を行います(Windows限定)。

この部品では，次のサーバを前提とします。

・エージェントサーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/Baseがセットアップされている必要があります。

利用場面

運用に使用するOSユーザーの削除の際に，パスワード管理情報からOSユーザー情報を削除する場合などに利用できます。また，下記部品と組みあわせて，JP1ユーザーを削除する際に必要となるユーザーマッピング情報，パスワード管理情報および操作権限の削除を行うことで，JP1ユーザーの削除作業を効率化できます。

・jp1baseDeleteJp1User_System

・jp1baseDeleteMapping_System

・jp1baseDeletePermission_System

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバ内前提製品の使用条件】

(1)JP1/Baseの認証サーバが起動していること。

(2)実行対象サーバのJP1/Baseがクラスタ構成の場合，プロパティcommon.targetHostnameにはJP1/Baseの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/Baseの論理ホスト名を指定してください。

バージョン

02.50.01

部品のタグ

Configure JP1,Base,Windows

タスクログに表示される部品の名称

jp1baseDeleteUserInfo_System

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

common.osUserName

OSユーザー名

JP1/Baseのパスワード管理情報から削除するOSユーザーのユーザー名を指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.7.29　マッピング情報の確認

機能

この部品は，指定されたファイルにJP1ユーザーとOSユーザーのマッピング情報をテキスト形式(ユーザーマッピング定義ファイル(jp1BsUmap.conf)と同じ形式)で出力します。ファイルの出力形式は，JP1/Baseのjbsgetumapコマンドの出力結果と同じ形式です。

利用場面

JP1/AJS3 - ManagerやJP1/IM - Managerで運用している場合，実行エージェントのJP1ユーザーとOSユーザーのマッピング情報を確認します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Base 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) AIX V6

　(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

(1)JP1/Baseの認証サーバが起動していること。

注意事項

(1) UNIX環境に対してこのサービスを実行する場合は，プロパティにマルチバイト文字を使用しないでください。

実行権限

Windowsの場合：Administrator権限

UNIXの場合：root権限

バージョン

02.00.00

部品のタグ

Gather JP1 information,Base,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1baseConfirmMapping

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1Base.jp1BaseLHostName

JP1/Baseの論理ホスト名

JP1/Baseの論理ホスト名を指定します。

−　

入力

△　

JP1Base.listJP1UserMappingOutputFileName

JP1ユーザーマッピング定義出力ファイル名

JP1ユーザーマッピング定義を出力するファイル名をフルパスで指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.8　JP1/IM関連の部品

4.8.1　JP1/IMトラブルシュート情報の収集

機能

指定したサーバのJP1/Integrated Management - Manager(以降，JP1/IMと呼びます)に対し，トラブルシュート情報の収集を実行します。

この部品では，次のサーバを前提とします。

・監視サーバ(実行対象サーバ)

　JP1/IMのトラブルシュート情報収集を実行するサーバです。前提条件に記載のJP1/IMがセットアップされている必要があります。

プロパティJP1IM.logFolderに指定したフォルダにトラブルシュート情報を収集します。

取得する情報は次のとおりです。なお，取得する情報の詳細や格納形式はJP1/IMのマニュアルを参照してください。

・JP1/IMの資料採取ツール(オプション指定なし)で取得できるすべての情報

JP1/IMの資料採取ツールの出力メッセージは，プロパティJP1IM.logFolderに指定したフォルダ直下にjp1imGetLog_result.logとして格納します。

利用場面

JP1/IMの問題調査のため，JP1/IMのトラブルシュート情報を収集する際に利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Integrated Management - Manager 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) AIX V6

　(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

　(1)実行対象サーバのJP1/IMがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/IMの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/IMの論理ホスト名を指定してください。

注意事項

(1)この部品を同一の実行対象サーバに対して複数同時に実行しないでください。

(2)実行対象サーバのOSがWindowsの場合，JP1IM.logFolderにすでに存在するフォルダを指定した場合は，いったんフォルダを削除してから再度作成します。削除したくないファイルが格納されているフォルダと同じフォルダ名は指定しないでください。

バージョン

02.00.00

部品のタグ

Troubleshoot JP1,IM,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1imGetLog

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1IM.logFolder

資料格納フォルダ

JP1/IMの資料採取ツールで収集されるファイルを格納するフォルダをフルパスで指定します。

−　

入力

○　

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1論理ホスト名を指定します。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.8.2　JP1イベントの対処状況変更

機能

指定したサーバのJP1/IM - Manager(以降，JP1/IMと呼びます)に対し，発生している重要なJP1イベントの対処状況の変更を行います。

また，JP1/IM - Viewの[重要イベント]ページからJP1イベントを削除します。

次に示す重要イベント対処状況キーの指定によって，対処状況を変更します。

(凡例)キー：変更後の対処状況

PROCESSED：対処済

PROCESSING：処理中

HELD：保留

UNPROCESSED：未対処

この部品では，次のサーバを前提とします。

・監視サーバ(実行対象サーバ)

　JP1/IM - Managerがインストールされているサーバです。

利用場面

障害回復時に発行済みのJP1イベントを対処済みに変更し，JP1/IM - Viewから削除する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Integrated Management - Manager 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) AIX V6

　(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

　(1)JP1/IMが稼働していること。

実行権限

Windows の場合：Administrators権限

UNIXの場合：なし

バージョン

02.00.00

部品のタグ

Control JP1,IM,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1imChangeEventStatus

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

20

異常(ユーザーミス) その他ユーザーエラー

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1IM.jp1imLHostName

JP1/IMの論理ホスト名

JP1/IMの論理ホスト名を指定します。

−　

入力

△　

JP1IM.severeEventResponseStatusKey

重要イベント対処状況キー

重要イベントの対処状況を表すキー値を指定します。PROCESSED，PROCESSING，HELD，UNPROCESSEDのどれかのキーを指定してください。

−　

入力

○　

JP1IM.deleteSevereEventFromIMView

JP1/IM-Viewからの重要イベント削除の要否

指定した重要イベントをJP1/IM - Viewの画面から削除するかどうか指定します。削除する場合は必ず"yes"を入力してください。それ以外の値または空欄の場合，JP1/IM - Viewから削除しません。なお，イベントDBからは削除されません。

−　

入力

△　

JP1IM.serialNumber

イベントDB内通し番号

対処状況を変更する重要イベントのイベントDB内通し番号を指定します。イベントDB内通し番号は，最大10個指定できます。複数指定する場合は，通し番号と通し番号の間をコンマで区切ります。コンマの前後に空白を指定できません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.8.3　JP1イベント取得

機能

指定したサーバのJP1/IM - Managerに対して，指定した期間，統合監視DBに登録されているJP1イベントの情報を，指定されたファイルにCSV形式で出力します。ファイルの出力フォーマットは，JP1/IMのjcoevtreportコマンドの出力結果と同じ形式です。登録時刻，到着時刻，および開始時刻と終了時刻の形式はYYYYMMDDhhmmss形式で，ヘッダーの出力形式はDISPで出力します。

この部品では，次のサーバを前提とします。

・監視サーバ(実行対象サーバ)

　JP1/IM - Managerのイベント件数を取得するサーバです。

利用場面

JP1/IM - Managerに到着したイベントを調査するために利用することができます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Integrated Management - Manager 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) AIX V6

　(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

　(1)実行対象サーバのJP1/IM - Managerがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/IM - Managerの論理ホストが動作している物理ホスト名を，プロパティJP1IM.jp1imLHostNameにはJP1/IM - Managerの論理ホスト名を指定してください。

　(2)統合監視DBで運用している必要があります。

　(3)指定可能な日時の範囲は，(GMT) 1970/01/01 00:00:00 〜 2038/01/19 03:14:07です。コマンド実行ホストのタイムゾーンが日本時間の場合，(GMT+9:00) 1970/01/01 09:00:00 〜 2038/01/19 12:14:07となります。

(4)稼働OSがUNIXの場合は，エージェントレス接続先に定義された接続ユーザーのデフォルトロケールがJP1/IM - Managerの動作する言語コードに設定されている必要があります。

注意事項

(1)この部品を同一の実行対象サーバに対して複数同時に実行しないでください。

(2)この部品を実行すると同時にjcoevtreportを実行しないでください。

バージョン

02.00.00

部品のタグ

Gather JP1 information,IM,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1imRetrieveEvent

戻り値

戻り値

説明

0

正常

11

異常(ユーザーミス) 定義ファイル内容の不正

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

20

異常(ユーザーミス) その他ユーザーエラー

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

24

異常(環境不正) 起動状態不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1IM.outputFileName

出力ファイル名

JP1イベントの情報をCSV形式にして出力するファイル名を指定します。

−　

入力

○　

JP1IM.jp1imStartTime

出力対象始点日

出力するイベントの始点日を指定します。指定形式はYYYY-MM-DDです。時刻は，00:00:00になります。

−　

入力

○　

JP1IM.jp1imEndtime

出力対象終点日

出力するイベントの終点日を指定します。指定形式はYYYY-MM-DDです。時刻は，00:00:00になります。

−　

入力

○　

JP1IM.jp1imFilterName

フィルターファイル名

イベントレポート出力のフィルターファイル名をフルパスで指定します。

−　

入力

△　

JP1IM.jp1imLHostName

JP1/IMの論理ホスト名

JP1/IMの論理ホスト名を指定します。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.9　JP1/NNMi関連の部品

4.9.1　NNMiトポロジデータベース内容の出力

機能

JP1/Cm2/NNMiのトポロジデータベースの内容を取得し，指定した出力タイプでファイルに出力します。

この部品では，次のサーバを前提とします。

・NNMiサーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/Cm2/NNMiがセットアップされている必要があります。

出力タイプに指定する内容は，JP1/Cm2/NNMiのマニュアルを参照してください。

利用場面

JP1/Cm2/NNMiに監視対象追加や削除を行ったあとに，トポロジデータベースの内容を確認する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) JP1/Cm2/Network Node Manager i 09-10〜10-50

　(2) JP1/Network Node Manager i 11-00〜12-60

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter (x64)

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

　(1)JP1/Cm2/NNMi 09-10を使用する場合，NNMiサーバにおいて，アカウントクレデンシャル(JP1/Cm2/NNMiのスクリプトを実行するときのユーザー名とパスワードに使用される値)が設定済みであること。

注意事項

(1)この部品を同一のNNMiサーバに複数同時に実行しないでください。

(2)この部品では，NNMiサーバ上でnnmtopodumpコマンドを実行します。そのため，部品実行中にNNMiサーバ上でnnmtopodumpコマンドを実行しないでください。同様に，NNMiサーバ上で，nnmtopodumpコマンドを実行中の場合は，この部品を実行しないでください。

(3)NNMiサーバの稼働OSがLinuxの場合は，エージェントレス接続先に定義された接続ユーザーのデフォルトロケールでコマンドが実行されます。接続ユーザーのデフォルトロケールには，JP1/Cm2/NNMiがサポートするロケールを設定してください。詳細については，JP1/AOマニュアルの「部品実行時に設定される操作対象の機器のロケールについて」，「部品実行時に設定されるJP1/AOが通信で使用する文字セットについて」およびJP1/Cm2/NNMiマニュアルを参照してください。

バージョン

02.00.00

部品のタグ

Gather JP1 information,NNMi,Windows,Linux

タスクログに表示される部品の名称

jp1nnmGetTopoDump

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

14

異常(ユーザーミス) ファイルアクセス不可

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

localhost

入力

○　

JP1CM2NNM.dumpType

トポロジデータベース内容の出力タイプ

JP1/Cm2/NNMiトポロジデータベース内容の出力タイプを指定します。

node

入力

○　

common.outputFilePath

出力ファイルのパス

出力するファイルをフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.9.2　監視対象ノード削除

機能

指定されたノードをJP1/Cm2/NNMiの監視対象から削除します。

この部品では，次のサーバを前提とします。

・NNMiサーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/Cm2/NNMiがセットアップされている必要があります。

・監視対象ノード

　JP1/Cm2/NNMiの監視対象から削除するサーバまたは機器です。

利用場面

管理するサーバの滅却などによって，ノード監視の監視対象ノードを削除する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) JP1/Cm2/Network Node Manager i 09-10〜10-50

　(2) JP1/Network Node Manager i 11-00〜12-60

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

　(1)JP1/Cm2/NNMi 09-10を使用する場合，NNMiサーバで，アカウントクレデンシャル(JP1/Cm2/NNMiのスクリプトを実行するときのユーザ名とパスワードに使用される値)が設定済みであること。

注意事項

(1)監視対象ノードのIPアドレスに，IPv6アドレスは指定できません。

バージョン

02.00.00

部品のタグ

Configure JP1,NNMi,Windows,Linux

タスクログに表示される部品の名称

jp1nnmDeleteHost

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1CM2NNM.monitoringNodeIPaddress

監視対象ノードのIPアドレス

監視対象ノードのIPアドレスを指定します。IPv6アドレスは指定できません。

−　

入力

○　

JP1CM2NNM.monitoringNodeHostname

監視対象ノードのホスト名

監視対象ノードのホスト名を指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.9.3　監視対象ノード追加

機能

指定されたノードをJP1/Cm2/NNM(またはJP1/Cm2/NNMi)の監視対象に追加します。

この部品では，次のサーバを前提とします。

・NNMサーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/Cm2/NNM(またはJP1/Cm2/NNMi)がセットアップされている必要があります。

・監視対象ノード

　JP1/Cm2/NNM(またはJP1/Cm2/NNMi)へ監視対象として追加するサーバまたは機器です。

利用場面

管理するサーバの増加などによって，ノード監視の監視対象ノードを追加する際に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) JP1/Cm2/Network Node Manager i 09-10〜10-50

　(2) JP1/Network Node Manager i 11-00〜12-60

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

　(1)JP1/Cm2/Network Node Manager Starter Editionを使用する場合，ovspmd，ovwdb，pmd，ovtopmd，netmonの5つのプロセスが起動していること。

注意事項

(1)監視対象ノードのIPアドレスに，IPv6アドレスは指定できません。

(2)マルチテナントに対応させる場合，JP1/Cm2/NNMiはノード追加後にノードを移動する必要があります。

(3)JP1/Cm2/NNMiではノードを追加したあとにシードを削除することを推奨しています(詳細はJP1/Cm2/NNMiのリリースノートを参照してください)。

バージョン

02.00.00

部品のタグ

Configure JP1,NNMi,Windows,Linux

タスクログに表示される部品の名称

jp1nnmAddHost

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1CM2NNM.monitoringNodeIPaddress

監視対象ノードのIPアドレス

監視対象ノードのIPアドレスを指定します。IPv6アドレスは指定できません。

−　

入力

○　

JP1CM2NNM.monitoringNodeHostname

監視対象ノードのホスト名

監視対象ノードのホスト名を指定します。

−　

入力

△　

JP1CM2NNM.targetSubnetMask

監視対象ノードのサブネットマスク

監視対象ノードのサブネットマスクを指定します。JP1/Cm2/NNMを使用する場合は必ず指定してください。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.10　JP1/PFM関連の部品

4.10.1　Storeデータベース保存条件設定

機能

この部品は，JP1/PFMで管理するエージェントに対して，パフォーマンスデータの保存条件を設定します。

この部品では，次のサーバを前提とします。

・PFM管理サーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/PFM - Web Consoleがセットアップされている必要があります。

利用場面

JP1/PFM - RMを使用して性能監視を行っているシステムで，追加したリモートエージェントの初期設定を行う場合などに使用できます。

次の部品もあわせて使用することで，JP1/PFM - RMの監視設定作業を効率化できます。

・jp1pfmSetRemoteAgent

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Performance Management - Web Console 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) AIX V6

　(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

　(1)実行対象サーバ上に，次のファイルが格納されていること。

　・保存条件の定義ファイル(jpcaspsv updateコマンドで指定するファイル)

　　ただし，保存条件の定義ファイル中の「service」には次の値を指定してください。

　　「7S1#INSTANCENAME#[#REMOTEMONITORHOST#]」

　(2)実行対象サーバで，JP1/PFMの管理ユーザー権限のユーザーアカウントで認証用キーファイルが作成済みであること。

バージョン

02.00.00

部品のタグ

Configure JP1,PFM,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1pfmAddStoreDataDef

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

14

異常(ユーザーミス) ファイルアクセス不可

20

異常(ユーザーミス) その他ユーザーエラー

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1PFM.storageConditionDefinitionFileName

保存条件の定義ファイル名

実行対象サーバ上のJP1/PFMの保存条件の定義ファイルのフルパスを指定します。

−　

入力

○　

JP1PFM.instanceName

JP1/PFM - RMのインスタンス名

監視対象サーバのリモートエージェントが属するJP1/PFM - RMのインスタンス名を指定します。

−　

入力

△　

JP1PFM.remoteMonitorHost

Remote Monitor Collectorサービス稼働ホスト名

Remote Monitor Collectorサービス稼働ホスト名を指定します。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.10.2　アラームテーブルのコピー(JP1/PFM)

機能

この部品は，JP1/PFMのアラームテーブルおよびアラームをコピーし，新しいアラームテーブルまたはアラームを作成します。

この部品では，次のサーバを前提とします。

・PFM管理サーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/PFM - Managerがセットアップされている必要があります。

この部品は，コピー対象によって指定が必要なプロパティが異なります。

(1)既存のアラームテーブルをコピーして新しいアラームテーブルを作成する場合

JP1PFM.serviceKeyプロパティ，JP1PFM.sourceAlarmTableNameプロパティ，JP1PFM.destinationAlarmTableNameプロパティを指定してください。

(2)既存のアラームテーブル内で，指定したアラームをコピーし新しいアラームを作成する場合

JP1PFM.serviceKeyプロパティ，JP1PFM.sourceAlarmTableNameプロパティ，JP1PFM.sourceAlarmNameプロパティ，JP1PFM.destinationAlarmTableNameプロパティを指定してください。

アラームをコピーする場合，コピー先に別のアラームテーブルを指定することはできません。

利用場面

JP1/PFM - Managerにより性能を監視しているシステムにおいて，既存のアラームテーブルをコピーしてアラームテーブルを作成したり，アラームをコピーし，監視条件を追加することができます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Performance Management - Manager 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) AIX V6

　(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

　(1) JP1/Performance Management - Managerの次のサービスが起動していること。

　　・Name Serverサービス

　　・Master Managerサービス

　　・View Serverサービス

　(2) JP1/PFMのjpctool alarm copyコマンド(JP1/PFM - Managerのバージョンが08-00以降の場合はjpcalarm copyコマンド)の使用条件を満たしていること。

注意事項

(1)この部品を同一の実行対象サーバに対して多重実行しないでください。

(2)実行対象サーバのJP1/PFM - Managerがクラスタ構成の場合は，実行系ノードで部品を実行してください。

バージョン

02.00.00

部品のタグ

Configure JP1,PFM,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1pfmCopyAlarm

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

20

異常(ユーザーミス) その他ユーザーエラー

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

24

異常(環境不正) 起動状態不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1PFM.serviceKey

JP1/PFMプロダクトのサービスキー

JP1/PFM - Agent(またはJP1/PFM - RM)のサービスキーを指定します。プロダクト名表示機能が有効の場合，プロダクト名も指定できます。

−　

入力

○　

JP1PFM.sourceAlarmTableName

コピー元のアラームテーブル名

コピー元のアラームテーブル名を指定します。

−　

入力

○　

JP1PFM.sourceAlarmName

コピー元のアラーム名

コピー元のアラーム名を指定します。

−　

入力

△　

JP1PFM.destinationAlarmTableName

コピー先のアラームテーブルまたはアラーム名

コピー先のアラームテーブル名またはアラーム名を指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.10.3　アラームテーブルの削除(JP1/PFM)

機能

この部品は，JP1/PFMのアラームテーブルまたはアラームを削除します。

この部品では，次のサーバを前提とします。

・PFM管理サーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/PFM - Managerがセットアップされている必要があります。

この部品は，削除対象によって指定が必要なプロパティが異なります。

(1)アラームテーブルを削除する場合

　JP1PFM.serviceKeyプロパティ，JP1PFM.targetAlarmTableNameプロパティを指定してください。

(2)既存のアラームテーブル内の，指定したアラームを削除する場合

JP1PFM.serviceKeyプロパティ，JP1PFM.targetAlarmTableNameプロパティ，JP1PFM.targetAlarmNameプロパティを指定してください。

利用場面

JP1/PFM - Managerにより性能を監視しているシステムにおいて，アラームテーブルやアラームの削除が可能になります。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Performance Management - Manager 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) AIX V6

　(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

　(1) JP1/Performance Management - Managerの次のサービスが起動していること。

　　・Name Serverサービス

　　・Master Managerサービス

　　・View Serverサービス

　(2) JP1/PFMのjpctool alarm deleteコマンド(JP1/PFM - Managerのバージョンが08-00以降の場合はjpcalarm deleteコマンド)の使用条件を満たしていること。

注意事項

(1)この部品を同一の実行対象サーバに対して多重実行しないでください。

(2)実行対象サーバのJP1/PFM - Managerがクラスタ構成の場合は，実行系ノードで部品を実行してください。

バージョン

02.00.00

部品のタグ

Configure JP1,PFM,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1pfmDeleteAlarm

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

14

異常(ユーザーミス) ファイルアクセス不可

20

異常(ユーザーミス) その他ユーザーエラー

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

24

異常(環境不正) 起動状態不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1PFM.serviceKey

JP1/PFMプロダクトのサービスキー

JP1/PFM - Agent(またはJP1/PFM - RM)のサービスキーを指定します。プロダクト名表示機能が有効の場合，プロダクト名も指定できます。

−　

入力

○　

JP1PFM.targetAlarmTableName

削除対象のアラームテーブル名

削除対象のアラームテーブル名を指定します。

−　

入力

○　

JP1PFM.targetAlarmName

削除対象のアラーム名

削除対象のアラーム名を指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.10.4　アラームテーブルの情報取得(JP1/PFM)

機能

この部品は，JP1/PFM - Managerで定義されているアラームテーブルの一覧，およびアラームテーブルのバインド情報を取得します。

この部品では，次のサーバを前提とします。

・PFM管理サーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/PFM - Managerがセットアップされている必要があります。

この部品は，取得する内容によって指定が必要なプロパティが異なります。

(1) 該当するJP1/PFM - Agent(またはJP1/PFM - RM)用として定義したアラームテーブルの一覧を取得する場合

　　JP1PFM.serviceKeyプロパティだけ指定してください。

(2) 指定したアラームテーブルに含まれるアラーム名，アラームの有効/無効状態，バインドしているエージェントの一覧を取得する場合

　　JP1PFM.serviceKeyプロパティ，JP1PFM.alarmTableNameプロパティを指定してください。

(3) 指定したエージェントがバインドしているアラームテーブルの一覧を取得する場合

　　JP1PFM.agentServiceIDプロパティだけ指定してください。このプロパティは，PFM管理サーバのJP1/PFM - Managerのバージョンが08-50以降の場合だけ指定できます(08-50より前のバージョンの場合に指定すると，この部品は戻り値12で異常終了します)。

利用場面

JP1/PFM - Managerによって性能を監視しているシステムで，定義されているアラームテーブル名を確認する場合に使用できます。また，特定のJP1/PFM - Agent(またはJP1/PFM - RM)にバインドされているアラームテーブル名を確認する場合にも使用することができます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Performance Management - Manager 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) AIX V6

　(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

　(1) JP1/Performance Management - Managerの次のサービスが起動していること。

　　・Name Serverサービス

　　・Master Managerサービス

　　・View Serverサービス

　(2) JP1/PFMのjpctool alarm listコマンド(JP1/PFM - Managerのバージョンが08-00以降の場合はjpcalarm listコマンド)の使用条件を満たしていること。

注意事項

(1)この部品を同一の実行対象サーバに対して多重実行しないでください。

(2)実行対象サーバのJP1/PFM - Managerがクラスタ構成の場合は，実行系ノードで部品を実行してください。

バージョン

02.00.00

部品のタグ

Gather JP1 information,PFM,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1pfmShowAlarmBindList

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

14

異常(ユーザーミス) ファイルアクセス不可

20

異常(ユーザーミス) その他ユーザーエラー

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

24

異常(環境不正) 起動状態不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1PFM.reportOutputFileName

出力ファイル名

JP1/PFMのアラーム情報を出力するファイルのパスをフルパスで指定します。

−　

入力

○　

JP1PFM.serviceKey

JP1/PFMプロダクトのサービスキー

JP1/PFM - Agent(またはJP1/PFM - RM)のサービスキーを指定します。プロダクト名表示機能が有効の場合，プロダクト名も指定できます。このプロパティはJP1PFM.agentServiceIDと同時に指定できません。

−　

入力

△　

JP1PFM.alarmTableName

アラームテーブル名

JP1/PFMのアラームテーブル名を指定します。このプロパティは，JP1PFM.serviceKeyと同時に指定します。

−　

入力

△　

JP1PFM.agentServiceID

エージェントのサービスID

JP1/PFMのAgent Collectorサービス，Remote Monitor Collectorサービス，リモートエージェントまたはグループエージェントのサービスIDを指定します。JP1PFM.serviceKey，JP1PFM.alarmTableNameと同時に指定できません。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.10.5　アラームテーブル名一覧取得(JP1/PFM - RM)

機能

この部品は，JP1/PFM - Managerで定義されているアラームテーブル名の一覧を取得します。

この部品では，次のサーバを前提とします。

・PFM管理サーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/PFM - Managerがセットアップされている必要があります。

利用場面

JP1/PFM - Managerを使用して性能を監視しているシステムで，定義されているアラームテーブル名を確認する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Performance Management - Manager 09-10-11以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) AIX V6

　(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

　(1)JP1/PFM - Managerが起動していること。

注意事項

(1)この部品を同一の実行対象サーバで複数同時に実行しないでください。

実行権限

Windowsの場合：Administrator権限

UNIXの場合：root権限

バージョン

02.00.00

部品のタグ

Gather JP1 information,PFM,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1pfmShowAlarm

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

14

異常(ユーザーミス) ファイルアクセス不可

20

異常(ユーザーミス) その他ユーザーエラー

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

24

異常(環境不正) 起動状態不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1PFM.reportOutputFileName

出力ファイル名

レポートを出力するファイル名称を指定します。

−　

入力

○　

JP1PFM.serviceKey

JP1/PFMプロダクトのサービスキー

JP1/PFM - RMのサービスキーを指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.10.6　アラームのアンバインド(JP1/PFM - RM)

機能

この部品は，JP1/PFMで管理するエージェントに対して，アラームテーブルのバインド解除を実行します。

この部品では，次のサーバを前提とします。

・PFM管理サーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/PFM - Managerがセットアップされている必要があります。

JP1PFM.serviceIDに指定したエージェントから，プロパティJP1PFM.alarmTableNameに指定したアラームテーブルのバインドを解除します。ただし，JP1PFM.alarmTableNameにアラームテーブル名を指定しない場合，次のアラームテーブルをアンバインドします。

JP1/PFM - ManagerがV8の場合：(JP1/PFM - ManagerホストがWindows)「PFM Windows Solution Alarms 8.00」または(JP1/PFM - ManagerホストがUNIX)「PFM UNIX Solution Alarms 8.00」

JP1/PFM - ManagerがV9またはV9より新しいバージョンの場合：「PFM RM Platform Template Alarms 09.00」

利用場面

JP1/PFM - RMを使用して性能監視を行っているシステムで，リモートエージェントのしきい値監視を取りやめる場合などに使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Performance Management - Manager 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

(1) JP1/Performance Management - Managerの次のサービスが起動していること。

　・Name Serverサービス

　・Master Managerサービス

　・View Serverサービス

注意事項

(1)この部品を同一の実行対象サーバに対して多重実行しないでください。

(2)実行対象サーバのJP1/PFM - Managerがクラスタ構成の場合は，実行系ノードで部品を実行してください。

バージョン

02.00.00

部品のタグ

Configure JP1,PFM,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1pfmReleaseAlarm

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

14

異常(ユーザーミス) ファイルアクセス不可

20

異常(ユーザーミス) その他ユーザーエラー

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

24

異常(環境不正) 起動状態不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1PFM.serviceKey

JP1/PFMプロダクトのサービスキー

アラームのバインド解除を行うJP1/PFM - RMのサービスキーを指定します。

−　

入力

○　

JP1PFM.serviceID

JP1/PFM - RMのエージェントのサービスID

アラームのバインド解除を行うJP1/PFM - RMのエージェントのサービスIDを指定します。

−　

入力

○　

JP1PFM.alarmTableName

アラームテーブル名

バインド解除するJP1/PFMのアラームテーブル名を指定します。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.10.7　アラームのバインド(JP1/PFM - RM)

機能

この部品は，JP1/PFMで管理するエージェントに対して，アラームテーブルをバインドします。

この部品では，次のサーバを前提とします。

・PFM管理サーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/PFM - Managerがセットアップされている必要があります。

JP1PFM.alarmTableNameプロパティに指定したアラームテーブルを，JP1PFM.serviceIDプロパティに指定したエージェントに対してバインドします。ただし，JP1PFM.alarmTableNameプロパティにアラームテーブル名を指定しない場合，次のアラームテーブルをバインドします。

JP1/PFM - ManagerがV8の場合：(JP1/PFM - ManagerホストがWindows)「PFM Windows Solution Alarms 8.00」または(JP1/PFM - ManagerホストがUNIX)「PFM UNIX Solution Alarms 8.00」

JP1/PFM - ManagerがV9またはV9より新しいバージョンの場合：「PFM RM Platform Template Alarms 09.00」

PFM管理サーバのJP1/PFM - Managerでアラームテーブル複数バインド機能が有効な環境では，JP1PFM.bindMultipleAlarmTableプロパティにtrueを指定することで，指定したアラームテーブルを追加でバインドできます。アラームテーブル複数バインド機能が無効な環境では，該当プロパティにfalseを指定してください。該当プロパティにfalseを指定した場合は，指定したエージェントにバインドされているアラームテーブルがすべてアンバインドされ，この部品で指定したアラームテーブルだけがバインドされます。

利用場面

JP1/PFM - RMを使用して性能監視を行っているシステムで，追加したリモートエージェントによってしきい値監視を行う場合などに使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Performance Management - Manager 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) AIX V6

　(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

　(1) JP1/Performance Management - Managerの次のサービスが起動していること。

　　・Name Serverサービス

　　・Master Managerサービス

　　・View Serverサービス

　(2) JP1/PFMのjpctool alarm bindコマンド(JP1/PFM - Managerのバージョンが08-00以降の場合はjpcalarm bindコマンド)の使用条件を満たしていること。

注意事項

(1)この部品を同一の実行対象サーバに対して多重実行しないでください。

(2)実行対象サーバのJP1/PFM - Managerがクラスタ構成の場合は，実行系ノードで部品を実行してください。

バージョン

02.00.00

部品のタグ

Configure JP1,PFM,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1pfmBindAlarm

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

14

異常(ユーザーミス) ファイルアクセス不可

20

異常(ユーザーミス) その他ユーザーエラー

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

24

異常(環境不正) 起動状態不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1PFM.serviceKey

JP1/PFMプロダクトのサービスキー

アラームのバインド対象とするJP1/PFM - RMのサービスキーを指定します。

−　

入力

○　

JP1PFM.serviceID

JP1/PFM - RMのエージェントのサービスID

アラームのバインド対象とするJP1/PFM - RMのエージェントのサービスIDを指定します。

−　

入力

○　

JP1PFM.alarmTableName

アラームテーブル名

バインドするJP1/PFMのアラームテーブル名を指定します。

−　

入力

△　

JP1PFM.bindMultipleAlarmTable

アラームテーブルの追加バインド要否

アラームテーブルを追加でバインドする場合はtrue，追加しない場合はfalseを指定します。

true

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.10.8　アラーム定義ファイルのインポート(JP1/PFM)

機能

この部品は，JP1/PFMのアラーム定義をインポートします。

この部品では，次のサーバを前提とします。

・PFM管理サーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/PFM - Managerがセットアップされている必要があります。

JP1PFM.overwriteAlarmプロパティにtrueを指定することで，アラーム定義ファイルの情報を強制的に登録できます。

利用場面

JP1/PFMによって性能監視を行っているシステムで，アラーム定義の情報を更新する場合に使用できます。

次の部品もあわせて使用することで，JP1/PFMの監視条件を自動的に変更できます。

・jp1pfmExportAlarmDef

・osReplaceString

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Performance Management - Manager 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) AIX V6

　(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

　(1) JP1/Performance Management - Managerの次のサービスが起動していること。

　　・Name Serverサービス

　　・Master Managerサービス

　　・View Serverサービス

　(2) JP1/PFMのjpctool alarm importコマンド(JP1/PFM - Managerのバージョンが08-00以降の場合はjpcalarm importコマンド)の使用条件を満たしていること。

注意事項

(1)この部品を同一の実行対象サーバに対して多重実行しないでください。

(2)実行対象サーバのJP1/PFM - Managerがクラスタ構成の場合は，実行系ノードで部品を実行してください。

(3)JP1PFM.overwriteAlarmプロパティにfalseを指定した場合，すでにJP1/PFMシステムに登録済みのアラーム定義のインポート処理を行わずに，戻り値0を返します。その場合，common.commandExitCodeプロパティの値が11になります。ただし，PFM管理サーバのOSがUNIXかつPFM - Managerのバージョンが09-50〜09-50-05の場合は，common.commandExitCodeプロパティの値は0になります。出力される戻り値の詳細は，JP1/PFMのマニュアルのjpctool alarm importコマンド(JP1/PFM - Managerのバージョンが08-00以降の場合はjpcalarm importコマンド)を説明している個所を確認してください。

バージョン

02.00.00

部品のタグ

Configure JP1,PFM,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1pfmImportAlarmDef

戻り値

戻り値

説明

0

正常

11

異常(ユーザーミス) 定義ファイル内容の不正

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

14

異常(ユーザーミス) ファイルアクセス不可

20

異常(ユーザーミス) その他ユーザーエラー

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

24

異常(環境不正) 起動状態不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1PFM.alarmDefinitionFileName

アラーム定義ファイル名

JP1/PFM - Managerにインポート可能な形式のアラーム定義ファイルをフルパスで指定します。

−　

入力

○　

JP1PFM.overwriteAlarm

アラーム定義の上書き要否

アラーム定義を上書きする場合はtrue，上書きしない場合はfalseを指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

common.commandExitCode

実行コマンドの戻り値

実行コマンドの戻り値が格納されます。

−　

出力

△　

4.10.9　アラーム定義ファイルのエクスポート(JP1/PFM)

機能

この部品は，JP1/PFMのアラーム定義をエクスポートします。

この部品では，次のサーバを前提とします。

・PFM管理サーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/PFM - Managerがセットアップされている必要があります。

この部品は，出力する内容によって指定が必要なプロパティが異なります。指定したプロパティに応じた次のいずれかのアラーム定義ファイルの内容を，JP1PFM.alarmDefinitionFileNameプロパティに指定したファイルに出力します。

(1) アラーム定義ファイルのテンプレートを出力する場合

　　JP1PFM.exportTemplateプロパティにtrueを指定してください。

(2) 実行対象サーバのJP1/PFM - Managerに登録されているアラームのうち，指定したサービスキーに合致するJP1/PFM - Agent(またはJP1/PFM - RM)のアラーム定義情報を出力する場合

　　JP1PFM.serviceKeyプロパティを指定してください。

(3) 指定したアラームテーブルに含まれる，すべてのアラームの定義情報をアラーム定義ファイルに出力する場合

　　JP1PFM.serviceKeyプロパティ，JP1PFM.alarmTableNameプロパティを指定してください。

(4) 特定のアラームテーブル内の，指定したアラームの定義情報だけをアラーム定義ファイルに出力する場合

　　JP1PFM.serviceKeyプロパティ，JP1PFM.alarmTableNameプロパティ，JP1PFM.alarmNameプロパティを指定してください。

JP1PFM.exportTemplateプロパティとJP1PFM.serviceKeyプロパティの両方を指定した場合，JP1PFM.exportTemplateプロパティを無視します。どちらのプロパティも指定しない場合，この部品は戻り値41を返し異常終了します。

なおJP1PFM.alarmDefinitionFileNameプロパティに指定したパスにすでにファイルが存在する場合は，ファイルを上書きします。

利用場面

JP1/PFMにより性能監視を行っているシステムで，アラーム定義の情報を更新する場合に使用できます。

次の部品もあわせて使用することで，JP1/PFMの監視条件を自動的に変更できます。

・jp1pfmImportAlarmDef

・osReplaceString

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Performance Management - Manager 09-00以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) AIX V6

　(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

　(1) プロパティ「JP1/PFMプロダクトのサービスキー」を指定する場合，JP1/Performance Management - Managerの次のサービスが起動している必要があります。

　　・Name Serverサービス

　　・Master Managerサービス

　　・View Serverサービス

　(2) JP1/PFMのjpctool alarm exportコマンド(JP1/PFM - Managerのバージョンが08-00以降の場合はjpcalarm exportコマンド)の使用条件を満たしていること。

注意事項

(1)この部品を同一の実行対象サーバに対して多重実行しないでください。

(2)実行対象サーバのJP1/PFM - Managerがクラスタ構成の場合は，実行系ノードで部品を実行してください。

バージョン

02.00.00

部品のタグ

Configure JP1,PFM,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1pfmExportAlarmDef

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

14

異常(ユーザーミス) ファイルアクセス不可

20

異常(ユーザーミス) その他ユーザーエラー

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

24

異常(環境不正) 起動状態不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1PFM.alarmDefinitionFileName

アラーム定義ファイル名

JP1/PFMのアラーム定義情報をエクスポートするファイルのパスをフルパスで指定します。

−　

入力

○　

JP1PFM.serviceKey

JP1/PFMプロダクトのサービスキー

JP1/PFM - Agent(またはJP1/PFM - RM)のサービスキーを指定します。プロダクト名表示機能が有効の場合，プロダクト名も指定できます。このプロパティはJP1PFM.exportTemplateと同時に指定できません。

−　

入力

△　

JP1PFM.alarmTableName

アラームテーブル名

JP1/PFMのアラームテーブル名を指定します。このプロパティは，JP1PFM.serviceKeyと同時に指定します。

−　

入力

△　

JP1PFM.alarmName

アラーム名

アラーム名を指定します。このプロパティは，JP1PFM.serviceKeyおよびJP1PFM.alarmTableNameと同時に指定します。

−　

入力

△　

JP1PFM.exportTemplate

テンプレートの出力要否

アラーム定義ファイルのテンプレートを出力する場合にtrueを指定します。このプロパティはJP1PFM.serviceKeyと同時に指定できません。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.10.10　エージェント階層設定

機能

この部品は，JP1/PFMのエージェント階層の定義情報をインポートし，JP1/PFMのGUIに表示されるエージェント階層を作成・更新します。

この部品では，次のサーバを前提とします。

・実行対象サーバ

　部品を実行し，エージェント階層定義ファイルのインポートを行うサーバです。JP1/PFM - Managerがセットアップされている必要があります。

利用場面

jp1pfmAddRemoteAgent部品を使用してJP1/PFM - RMにリモートエージェントを追加したあと，追加したリモートエージェントをエージェント階層「User Agents」に表示する場合などに使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Performance Management - Manager 09-10以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) AIX V6

　(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

　(1)実行対象サーバ上に，次のファイルが格納されていること。

　　・エージェント階層定義ファイル(jpcconf agttree importで指定するファイル)

　(2)実行対象サーバがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/PFM - Managerの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/PFM - Managerの論理ホスト名を指定してください。

注意事項

(1)実行対象サーバでJP1/PFM - ManagerのView Serverサービスが停止している場合，このコマンドは実行できません。

バージョン

02.00.00

部品のタグ

Configure JP1,PFM,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1pfmAddAgentTreeDef

戻り値

戻り値

説明

0

正常

11

異常(ユーザーミス) 定義ファイル内容の不正

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

14

異常(ユーザーミス) ファイルアクセス不可

20

異常(ユーザーミス) その他ユーザーエラー

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

24

異常(環境不正) 起動状態不正

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1PFM.agentLevelDefinitionFileName

エージェント階層定義ファイル名

実行対象サーバ上のJP1/PFMのエージェント階層定義ファイルのフルパスを指定します。

−　

入力

○　

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1/PFM - Managerの論理ホスト名を指定します。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.10.11　サービス情報同期

機能

この部品は，JP1/PFM - Managerに登録されているサービス情報をJP1/PFM - Web Consoleに同期します。

この部品では，次のサーバを前提とします。

・実行対象サーバ

　部品を実行し，JP1/PFM - ManagerとJP1/PFM - Web Consoleに登録されているサービス情報を同期させるサーバです。JP1/PFM - Managerがセットアップされている必要があります。

利用場面

jp1pfmDeleteRemoteAgent部品を使用してJP1/PFM - RMからリモートエージェントを削除したあと，削除したリモートエージェントをエージェント階層「Products」から削除する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Performance Management - Manager 09-10-11以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) AIX V6

　(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

　(1)JP1/Performance Management - Managerが起動していること。

　(2)実行対象サーバがクラスタ構成の場合，プロパティplugin.destinationHostにはJP1/PFM - Managerの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/PFM - Managerの論理ホスト名を指定してください。

注意事項

(1)JP1/PFM - Web Consoleのエージェント階層で「User Agents」のツリーに追加したエージェントは，この部品を実行しても削除されません。

バージョン

02.00.00

部品のタグ

Configure JP1,PFM,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1pfmSyncServiceInfo

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

14

異常(ユーザーミス) ファイルアクセス不可

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

24

異常(環境不正) 起動状態不正

26

異常(連携製品トラブル) 内部エラー

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1/PFM - Managerの論理ホスト名を指定します。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.10.12　プロセス監視設定一覧取得

機能

この部品は，監視対象ホストのプロセス監視設定一覧を取得します。

この部品では，次のサーバを前提とします。

・PFM管理サーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/PFM - Web Consoleがセットアップされている必要があります。

利用場面

監視対象ホストに定義されているアプリケーション定義名の一覧を確認できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Performance Management - Web Console 09-10-05以降

　(2)JP1/Performance Management - Manager 09-10-11以降

　(3)JP1/Performance Management - Remote Monitor for Platform 09-10以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

なし。

【その他の使用条件】

(1)実行対象サーバ内前提製品のJP1/PFM - Web Consoleが接続しているJP1/PFM - ManagerとサービスIDに対応するJP1/PFM - RMが起動されていること。

実行権限

Windowsの場合：Administrator権限

Linuxの場合：root権限

バージョン

02.00.00

部品のタグ

Gather JP1 information,PFM,Windows,Linux

タスクログに表示される部品の名称

jp1pfmShowProcessDef

戻り値

戻り値

説明

0

正常

11

異常(ユーザーミス) 定義ファイル内容の不正

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

14

異常(ユーザーミス) ファイルアクセス不可

15

異常(ユーザーミス) 指定されたインスタンスにはすでに50エージェント追加済みのためエージェントを追加できない(部品スクリプトでエラーを検知)

20

異常(ユーザーミス) その他ユーザーエラー

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1PFM.processMonitorListOutputFileName

出力ファイル名

プロセス監視設定一覧を出力するファイル名称を指定します。

−　

入力

○　

JP1PFM.serviceID

JP1/PFM - RMのエージェントのサービスID

定義の対象とするJP1/PFM - RMのリモートエージェントのサービスIDを指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.10.13　プロセス監視設定追加

機能

この部品は，JP1/PFMで管理するエージェントに対して，新規にアプリケーション定義(JP1/PFMでプロセス監視を行うための定義情報)を追加します。

この部品では，次のサーバを前提とします。

・PFM管理サーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/PFM - Web Consoleがセットアップされている必要があります。

利用場面

JP1/PFM - RMを使用して性能監視を行っているシステムで，追加したリモートエージェントの初期設定を行う場合などに使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Performance Management - Web Console 09-10-05以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) AIX V6

　(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

　(1)実行対象サーバ上に，次のファイルが格納されていること。

・アプリケーション定義ファイル(jpcprocdef createコマンドで指定するファイル)

　(2)実行対象サーバで，JP1/PFMの管理ユーザー権限のユーザーアカウントで認証用キーファイルが作成済みであること。

バージョン

02.00.00

部品のタグ

Configure JP1,PFM,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1pfmAddProcessDef

戻り値

戻り値

説明

0

正常

11

異常(ユーザーミス) 定義ファイル内容の不正

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

14

異常(ユーザーミス) ファイルアクセス不可

20

異常(ユーザーミス) その他ユーザーエラー

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1PFM.serviceID

JP1/PFM - RMのエージェントのサービスID

定義の対象とするJP1/PFM - RMのリモートエージェントのサービスIDを指定します。

−　

入力

○　

JP1PFM.applicationDefinitionFileName

アプリケーション定義ファイル名

JP1/PFMのプロセス監視に必要となる，アプリケーション定義のファイルをフルパスで指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.10.14　レポート取得

機能

この部品は，監視対象エージェントの性能情報を収集します。

この部品では，次のサーバを前提とします。

・PFM管理サーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/PFM - Web Consoleがセットアップされている必要があります。

利用場面

性能を監視しているシステムで，レポートを作成する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Performance Management - Web Console 09-10-05以降

　(2)JP1/Performance Management - Manager 09-10-11以降

　(3)JP1/Performance Management - Remote Monitor for Platform 09-10以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

なし。

【その他の使用条件】

　(1)実行対象サーバ内前提製品のJP1/PFM - Web Consoleが接続しているJP1/PFM - ManagerとサービスIDに対応するJP1/PFM - RMが起動されていること。

注意事項

(1)HTML形式のレポート出力はできません。入力ファイルの定義内容に<html-output>を指定しないでください。

実行権限

Windowsの場合：Administrator権限

Linuxの場合：root権限

バージョン

02.00.00

部品のタグ

Gather JP1 information,PFM,Windows,Linux

タスクログに表示される部品の名称

jp1pfmReportRemoteAgent

戻り値

戻り値

説明

0

正常

11

異常(ユーザーミス) 定義ファイル内容の不正

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

14

異常(ユーザーミス) ファイルアクセス不可

15

異常(ユーザーミス) 指定されたインスタンスにはすでに50エージェント追加済みのためエージェントを追加できない(部品スクリプトでエラーを検知)

16

異常(ユーザーミス) 入力ファイルの定義内容に<html-output>が指定された

20

異常(ユーザーミス) その他ユーザーエラー

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1PFM.inputFileName

入力ファイル名

レポートを出力するための定義を記述した入力ファイル名を指定します。

−　

入力

○　

JP1PFM.serviceID

JP1/PFM - RMのエージェントのサービスID

定義の対象とするJP1/PFM - RMのリモートエージェントのサービスIDを指定します。

−　

入力

○　

JP1PFM.reportOutputFileName

出力ファイル名

レポートを出力するファイル名称を指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.10.15　監視設定追加(JP1/PFM - RM)

機能

この部品は，JP1/PFMで管理するエージェントに対して，パフォーマンスデータの記録方法を設定します。

この部品では，次のサーバを前提とします。

・PFM管理サーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/PFM - Web Consoleがセットアップされている必要があります。

利用場面

JP1/PFM - RMを使用して性能監視を行っているシステムで，追加したリモートエージェントの初期設定を行う場合などに使用できます。

次の部品もあわせて使用することで，JP1/PFM - RMの監視設定作業を効率化できます。

・jp1pfmAddStoreDataDef

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Performance Management - Web Console 09-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

(1)実行対象サーバ上に，次のファイルが格納されていること。

　・記録方法の定義ファイル(jpcasrec updateコマンドで指定するファイル)

　　ファイル内のserviceタグで次の文字列を記載すると，指定したプロパティで値を次のように置き換えます。

　　　#INSTANCENAME#：JP1PFM - RMのインスタンス名

　　　#AGENTNAME#：監視対象サーバのホスト名

　　　#REMOTEMONITORHOST#：Remote Monitor Collectorサービス稼働ホスト名

　(serviceタグ記載例)

　　<service id="7A1#INSTANCENAME#[#REMOTEMONITORHOST#]">

　　<service id="7A1#INSTANCENAME#[#AGENTNAME#@#REMOTEMONITORHOST#]">

(2)実行対象サーバで，JP1/PFMの管理ユーザー権限のユーザーアカウントで認証用キーファイルが作成済みであること。

バージョン

02.00.00

部品のタグ

Configure JP1,PFM,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1pfmSetRemoteAgent

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

14

異常(ユーザーミス) ファイルアクセス不可

20

異常(ユーザーミス) その他ユーザーエラー

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1PFM.recordingMethodDefinitionFileName

記録方法の定義ファイル名

実行対象サーバ上のJP1/PFMの記録方法の定義ファイルのフルパスを指定します。

−　

入力

○　

JP1PFM.instanceName

JP1/PFM - RMのインスタンス名

監視対象サーバのリモートエージェントが属するJP1/PFM - RMのインスタンス名を指定します。

−　

入力

△　

JP1PFM.targetName

監視対象サーバのホスト名

監視対象サーバのホスト名を指定します。

−　

入力

△　

JP1PFM.remoteMonitorHost

Remote Monitor Collectorサービス稼働ホスト名

Remote Monitor Collectorサービス稼働ホスト名を指定します。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.10.16　監視対象削除(JP1/PFM - RM)

機能

この部品は，JP1/PFM - RM for Platform(以降，JP1/PFM - RM)から監視対象(リモートエージェント)を削除します。

この部品では，次のサーバを前提とします。

・PFM-RMサーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/PFM - RMがセットアップされている必要があります。

・監視対象サーバ

　JP1/PFM - RMへ監視対象として追加するサーバです。

利用場面

JP1/PFM - RMにより性能監視を行っているシステムから，監視対象のサーバを削除する場合などに使用できます。

次の部品もあわせて使用することで，JP1/PFM - RMの監視設定作業を効率化できます。

・jp1pfmReleaseAlarm

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Performance Management - Remote Monitor for Platform 09-10以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

(1)監視対象サーバを追加するJP1/PFM - RMの監視インスタンスが起動していること。

(2)実行対象サーバがクラスタ構成の場合，プロパティcommon.targetHostNameにはJP1/PFM - RMの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/PFM - RMの論理ホスト名を指定してください。

(3)実行対象サーバのJP1/PFM - RMでプロダクト名表示機能が有効になっていること。

注意事項

(1)この部品を同一の実行対象サーバにおいて複数同時に実行しないでください。

(2)この部品の実行後は，JP1/PFM - Web Consoleのエージェント階層で「User Agents」を選択して表示されるツリーから，不要になったエージェントを必要に応じて削除してください。

(3)アラームテーブルがバインドされている監視対象サーバを削除する場合，監視対象サーバのエージェントにバインドされているアラームテーブルを削除前にすべてバインド解除してください。

(4)プロパティJP1PFM.serviceKeyには"RMPlatform"を指定してください。その他の値を入れた場合の動作はサポートしていません。

バージョン

02.00.00

部品のタグ

Configure JP1,PFM,Windows,Linux

タスクログに表示される部品の名称

jp1pfmDeleteRemoteAgent

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

14

異常(ユーザーミス) ファイルアクセス不可

20

異常(ユーザーミス) その他ユーザーエラー

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1PFM.serviceKey

JP1/PFMプロダクトのサービスキー

JP1/PFM - RMのサービスキーを指定します。

−　

入力

○　

JP1PFM.instanceName

JP1/PFM - RMのインスタンス名

監視対象サーバのリモートエージェントが属するJP1/PFM - RMのインスタンス名を指定します。

−　

入力

○　

JP1PFM.targetName

監視対象サーバのホスト名

監視対象サーバのホスト名を指定します。

−　

入力

○　

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1/PFM - RMの論理ホスト名を指定します。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.10.17　監視対象追加(JP1/PFM - RM)

機能

この部品は，JP1/PFM - RM for Platform(以降，JP1/PFM - RM)に監視対象(リモートエージェント)を追加します。

この部品では，次のサーバを前提とします。

・PFM-RMサーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/PFM - RMがセットアップされている必要があります。

・監視対象サーバ

　JP1/PFM - RMへ監視対象として追加するサーバです。

利用場面

JP1/PFM - RMにより性能監視を行っているシステムに，新規構築したサーバを監視対象として追加する場合などに使用できます。

次の部品もあわせて使用することで，JP1/PFM - RMの監視設定作業を効率化できます。

・jp1pfmSetRemoteAgent

・jp1pfmAddStoreDataDef

・jp1pfmBindAlarm

・jp1pfmAddProcessDef

・jp1pfmAddAgentTreeDef

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/Performance Management - Remote Monitor for Platform 09-10以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

(1)監視対象サーバを追加するJP1/PFM - RMの監視インスタンスが起動していること。

(2)実行対象サーバ上に，次のファイルが格納されていること。

　・監視対象の定義ファイル(jpcconf target setupコマンドで指定するファイル名)

　　ただし，監視対象の定義ファイル中の「Target Host」には次の値を指定してください。

　　「#AGENTNAME#」

(3)実行対象サーバがクラスタ構成の場合，プロパティcommon.targetHostNameにはJP1/PFM - RMの論理ホストが動作している物理ホスト名を，プロパティJP1.logicalHostNameにはJP1/PFM - RMの論理ホスト名を指定してください。

(4)実行対象サーバのJP1/PFM - RMでプロダクト名表示機能が有効になっていること。

注意事項

(1)この部品を同一の実行対象サーバにおいて複数同時に実行しないでください。

(2)JP1/PFM - RMの稼働OSによって監視可能なOSが異なります。

　 JP1/PFM - RM(Linux版)の場合は「UNIX/Linux」だけ監視可能です。

　 JP1/PFM - RM(Windows版)は次のとおりです。

　・09-10以前：「Windows」だけ監視可能

　・09-50以降：「Windows/UNIX/Linux」が監視可能

(3)JP1/PFM - RMの1つの監視インスタンスに追加可能なリモートエージェントの数は合計で50までです。50を超えた場合はこの部品はエラーとなります。

(4)プロパティJP1PFM.serviceKeyには"RMPlatform"を指定してください。その他の値を入れた場合の動作はサポートしていません。

バージョン

02.00.00

部品のタグ

Configure JP1,PFM,Windows,Linux

タスクログに表示される部品の名称

jp1pfmAddRemoteAgent

戻り値

戻り値

説明

0

正常

11

異常(ユーザーミス) 定義ファイル内容の不正

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

14

異常(ユーザーミス) ファイルアクセス不可

15

異常(ユーザーミス) 指定されたインスタンスにはすでに50エージェント追加済みのためエージェントを追加できない(部品スクリプトでエラーを検知)。

20

異常(ユーザーミス) その他ユーザーエラー

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

25

異常(環境不正) 通信エラー

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1PFM.serviceKey

JP1/PFMプロダクトのサービスキー

JP1/PFM - RMのサービスキーを指定します。

−　

入力

○　

JP1PFM.instanceName

JP1/PFM - RMのインスタンス名

監視対象サーバのリモートエージェントが属するJP1/PFM - RMのインスタンス名を指定します。

−　

入力

○　

JP1PFM.targetName

監視対象サーバのホスト名

監視対象サーバのホスト名を指定します。

−　

入力

○　

JP1PFM.targetDefinitionFileName

監視対象の定義ファイル名

実行対象サーバに配置したJP1/PFM - RMの監視対象の定義ファイル名をフルパスで指定します。

−　

入力

○　

JP1.logicalHostName

実行対象サーバの論理ホスト名

実行対象サーバのJP1/PFM - RMの論理ホスト名を指定します。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.10.18　監視対象表示(JP1/PFM - RM)

機能

この部品は，JP1/PFM - RM for Platformの監視対象(リモートエージェント)を表示します。

この部品では，次のサーバを前提とします。

・PFM-RMサーバ(実行対象サーバ)

　この部品を実行する対象です。JP1/PFM - RM for Platformがセットアップされている必要があります。

利用場面

JP1/PFM - RM for Platformにより性能を監視しているシステムで，監視対象を追加する前後で，監視対象としているサーバを確認する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/Performance Management - Remote Monitor for Platform 09-10以降

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

なし。

注意事項

(1)この部品を同一の実行対象サーバで複数同時に実行しないでください。

(2)プロパティJP1PFM.serviceKeyには"RMPlatform"を指定してください。その他の値を入れた場合の動作はサポートしていません。

実行権限

Windowsの場合：Administrator権限

Linuxの場合：root権限

バージョン

02.00.00

部品のタグ

Gather JP1 information,PFM,Windows,Linux

タスクログに表示される部品の名称

jp1pfmShowRemoteAgent

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

13

異常(ユーザーミス) 認証不可

14

異常(ユーザーミス) ファイルアクセス不可

20

異常(ユーザーミス) その他ユーザーエラー

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

22

異常(環境不正) メモリ/ディスク容量不足

23

異常(環境不正) 前提環境不正

26

異常(連携製品トラブル) 内部エラー

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

JP1PFM.reportOutputFileName

出力ファイル名

レポートを出力するファイル名称を指定します。

−　

入力

○　

JP1PFM.serviceKey

JP1/PFMプロダクトのサービスキー

JP1/PFM - RMのサービスキーを指定します。

−　

入力

○　

JP1PFM.instanceName

JP1/PFM - RMのインスタンス名

監視対象サーバのリモートエージェントが属するJP1/PFM - RMのインスタンス名を指定します。

−　

入力

○　

JP1PFM.remoteMonitorHost

Remote Monitor Collectorサービス稼働ホスト名

Remote Monitor Collectorサービス稼働ホスト名を指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.11　JP1/SS関連の部品

4.11.1　JP1/IM-SSの案件情報更新

機能

この部品は，JP1/IM-SSのjssitemeditコマンドを発行して，JP1/IM-SSのプロセスワークボードに登録されている案件の情報を更新します。

この部品が前提とするサーバを次に示します。

・JP1/IM-SSサーバ

　JP1/IM-SSが動作するサーバです。

処理の流れを次に示します。

(1)JP1/IM-SSサーバの指定された案件を指定された値で変更します。指定しなかったプロパティは更新されません。

(2)次のプロパティの指定値は，デフォルトではコードマッピングファイル(jp1imss_itemedit_codemap.conf)に設定されているキーで指定する必要があります。

　・ステータス(JP1IMSS.statusTypeCode)

　・要因コード(JP1IMSS.causeTypeCode)

　・結果コード(JP1IMSS.resultTypeCode)

　・回避策種別コード(JP1IMSS.avoidTypeCode)

　・解決区分コード(JP1IMSS.solvedTypeCode)

デフォルトでは次のキーを指定できます。

・ステータス(JP1IMSS.statusTypeCode)

［キー］

　受付

　調査中

　計画中

　審議中

　対応依頼中

　レビュー中

　承認済み

　クローズ

　拡張ステータス01〜拡張ステータス40

・要因コード(JP1IMSS.causeTypeCode)

［キー］

　空白

　新規ソフトウェア不良

　既知ソフトウェア不良

　新規ハードウェア不良

　既知ハードウェア不良

　ドキュメント不良

　資料不足

　ユーザーミス

　仕様

　他社問題

　プロセス不良

　顧客要望

　機能拡張

　業務要件

　インシデント・問題修正

　プロセス改善

・結果コード(JP1IMSS.resultTypeCode)

［キー］

　空白

　完了

　打ち切り

　未確認

　変更完了

　既知の問題

　原因不明

　成功

　失敗(計画ミス)

　失敗(人的ミス)

　失敗(その他)

・回避策種別コード(JP1IMSS.avoidTypeCode)

［キー］

　空白

　なし

　運用回避

　縮退運転

　再起動

　ファイル回復

　変更の戻し

　その他

・解決区分コード(JP1IMSS.solvedTypeCode)

［キー］

　空白

　ナレッジ

　ドキュメント

　ユーザー解決

　二次サポート

　問題管理

　他社調査

デフォルト以外のキーを指定する場合は，コードマッピングファイルを作成して，コードマッピングファイルパス(リモート)(jp1imss.codeMappingFile)に，作成したコードマッピングファイル名を指定してください。

コードマッピングファイルについては「JP1/Service Support構築・運用ガイド」を参照してください。

利用場面

問題リカバリー処理の延長でJP1/IM-SSの案件のステータスを更新する。

例えば，JP1/IM-SSオペレータが登録された案件を確認後，JP1/IM-SSの画面からシングルサインオンでJP1/Automatic Operation(以降，JP1/AOと呼びます)のサービス実行画面を開き，問題リカバリー用のサービステンプレートを実行し，サービステンプレートに含まれる部品で障害回復を行ったり，JP1/IM-SSサーバの案件のステータスを更新したりという運用の中で，JP1/IM-SSの案件のステータスを更新する部分に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)JP1/IM-SSサーバに次の製品が稼働していること。

　・JP1/Integrated Management - Service Support 10-10以降，または

JP1/Service Support 11-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバ内前提製品の使用条件】

(1)更新対象の案件がJP1/IM-SSサーバ上に存在していること。

(2)プロパティに指定するユーザーIDがJP1/IM-SSサーバに定義されていること。

(3)プロパティに指定するロールIDがJP1/IM-SSサーバに定義されていること。

注意事項

(1)指定しなかったプロパティは更新されません。指定しなかったプロパティを更新する場合は，JP1/IM-SSのGUIかコマンドを使用して更新してください。

(2)JP1/IM-SSで1024文字以上設定可能なフリー記入欄は，JP1/AOでは1024文字までしか入力できません。

(3)プロパティには「//」で始まる値は指定しないでください。

(4)エージェントレス接続先設定の認証情報に設定したユーザーがビルトインAdministratorではない場合，以下のいずれかの条件を満たす必要があります。

・WindowsのUAC機能が完全に無効化されている。

・エージェントレス接続先の機器にて，エージェントレス接続先設定の認証情報に設定されたユーザーに対するRDPセッションが確立されている。

実行権限

Administrators 権限

バージョン

02.00.00

部品のタグ

Configure JP1,SS,Windows

タスクログに表示される部品の名称

jp1IMSSeditItem

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

25

異常(環境不正) 通信エラー

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

案件を編集するJP1/IM-SSサーバのホスト名，またはIPアドレスを指定します。IPv6には対応していません。

−　

入力

○　

JP1IMSS.itemID

案件ID

更新するJP1/IM-SSの案件IDを指定してください。

−　

入力

○　

JP1IMSS.registerID

登録者ID

案件の登録者となるユーザーのIDを指定します。

−　

入力

○　

JP1IMSS.staffType

担当者種別

担当者種別("USER"または"ROLE")を指定します。

−　

入力

○　

JP1IMSS.staffID

担当者ID

案件の担当者となるユーザーのIDまたはロールのIDを指定します。

−　

入力

○　

JP1IMSS.statusTypeCode

ステータス

案件に設定するステータスを指定します。

−　

入力

○　

JP1IMSS.closeDateTime

完了日時(YYYY/MM/DD hh:mm[:ss])

案件の完了日時を「YYYY/MM/DD hh:mm:ss」または「YYYY/MM/DD hh:mm」形式で指定します。

−　

入力

△　

JP1IMSS.causeTypeCode

要因コード

案件に設定する要因コードを指定します。

−　

入力

△　

JP1IMSS.resultTypeCode

結果コード

案件に設定する結果コードを指定します。

−　

入力

△　

JP1IMSS.avoidTypeCode

回避策種別コード

案件に設定する回避策種別コードを指定します。

−　

入力

△　

JP1IMSS.solvedTypeCode

解決区分コード

案件に設定する解決区分コードを指定します。

−　

入力

△　

JP1IMSS.freeText

フリー記入欄

案件のフリー記入欄に設定する文字列を指定します。

−　

入力

△　

JP1IMSS.codeMappingFile

コードマッピングファイルパス(リモート)

ユーザーが定義したコードマッピングファイルを使用する場合，JP1/IM-SSサーバ上のコードマッピングファイル名をフルパスで指定します。

−　

入力

△　

JP1IMSS.forceWrite

編集中の案件の更新

案件が編集中の状態でも更新する場合にtrueを指定します。falseを指定すると，案件が編集中のときは更新できません。指定しない場合は，falseとなります。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.11.2　JP1/IM-SSの案件登録

機能

この部品は，JP1/IM-SSのjssitementryコマンドを発行して，JP1/IM-SSのプロセスワークボードに新規案件を登録します。

JP1/IM-SSに，JP1/AOと連携するための環境設定を実施済みである場合，JP1/IM-SSの画面からJP1/AOのサービス実行ダイアログを呼びだすための関連情報を登録する用途にも使用することができます。

この部品が前提とするサーバを次に示します。

・JP1/IM-SSサーバ

　JP1/IM-SSが動作するサーバです。

処理の流れを次に示します。

(1)JP1/IM-SSサーバの指定されたプロセスワークボードに案件を指定された値で登録します。指定しなかったプロパティは登録されません。

(2)次のプロパティの指定値は，デフォルトではコードマッピングファイル(jp1imss_itementry_codemap.conf)に設定されているキーで指定する必要があります。

・重大度(JP1IMSS.severity)

・影響度(JP1IMSS.influence)

・優先度(JP1IMSS.priority)

・案件種別(JP1IMSS.incidentType)

・問題分野(JP1IMSS.filedType)

デフォルトでは次のキーを指定できます。

・重大度(JP1IMSS.severity)

［キー(デフォルトの案件フォームでの名称)］

　Emergency(緊急)

　Alert(警戒)

　Critical(致命的)

　Error(エラー)

　Warning(警告)

　Notice(通知

　Information(情報)

　Debug(デバッグ)

・影響度(JP1IMSS.influence)

［キー(デフォルトの案件フォームでの名称)］

　S(小)

　M(中)

　B(大)

・優先度(JP1IMSS.priority)

［キー(デフォルトの案件フォームでの名称)］

　N(標準)

　M(至急)

　H(大至急)

・案件種別(JP1IMSS.incidentType)。

［キー(デフォルトの案件フォームでの名称)］

　QUE(問い合わせ)

　FAL(障害)

　CR(顧客要望)

・問題分野(JP1IMSS.filedType)。

［キー(デフォルトの案件フォームでの名称)］

　APP(アプリケーション)

　MID(ミドルウェア)

　OS(OS)

　HRD(ハードウェア)

　NET(ネットワーク

　PRO(プロセス)

デフォルト以外のキーを指定する場合は，コードマッピングファイルを作成して，コードマッピングファイルパス(リモート)(jp1imss.codeMappingFile)に，作成したコードマッピングファイル名を指定してください。

コードマッピングファイルについては「JP1/Service Support 構築・運用ガイド」を参照してください。

(3)拡張コードデータ(JP1IMSS.extendData)の指定値は，必ずコードマッピングファイルを作成して定義する必要があります。

(4)JP1/IM-SSのJP1/AOとの連携機能を使用する場合に，呼び出すJP1/AOのサービスのサービス名とサービスグループ名の指定に使用する項目をJP1/IM-SSのシステムプロパティファイル(hptl_jp1_imss_main_setting.properties)で記述する必要があります。項目に拡張テキストデータを使用した場合，次のプロパティを指定することで，拡張テキストデータの何番目を利用する場合でも，ユーザーの設定の変更に応じてプロパティの値の変更で対応することができます。

・JP1/IM-SSのJP1/AOとの連携機能で呼び出すサービスの所属するサービスグループ名(JP1IMSS.relatedResourceGroupName)

・JP1/IM-SSのJP1/AOとの連携機能で呼び出すサービスの所属するサービスグループ名に割り当てる拡張テキストデータ番号(JP1IMSS.relatedResourceGroupNumber)

・JP1/IM-SSのJP1/AOとの連携機能で呼び出すサービスのサービス名(JP1IMSS.relatedServiceName)

・JP1/IM-SSのJP1/AOとの連携機能で呼び出すサービスのサービス名に割り当てる拡張テキストデータ番号(JP1IMSS.relatedServiceNumber)

利用場面

JP1/Integrated Management - Manager(以降，JP1/IMと呼びます)の自動アクションの延長でJP1/IM-SSに案件を登録する。

例えば，JP1/IMに障害情報が登録されるとJP1/IMの自動アクションでJP1/Automatic Operation(以降，JP1/AOと呼びます)のサービステンプレートが呼び出され，サービステンプレートに含まれる部品で既知の障害であるかを判定したり，障害情報を取得したり，JP1/IM-SSサーバに案件を登録したりするという運用において，JP1/IM-SSサーバに案件を登録する部分に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)業務サーバに次の製品が稼働していること。

　・JP1/Integrated Management - Service Support 10-10以降，または

JP1/Service Support 11-00以降

【実行対象サーバ内前提製品の稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバ内前提製品の使用条件】

(1)登録先のプロセスワークボードがJP1/IM-SSサーバに定義されていること。

(2)プロパティに指定するユーザーIDがJP1/IM-SSサーバに定義されていること。

(3)プロパティに指定するロールIDがJP1/IM-SSサーバに定義されていること。

【JP1/IM-SSのJP1/AOとの連携機能を使用する場合の使用条件】

(1)JP1/IM-SSサーバとJP1/AOサーバがシングルサインオンで連携していること。

　シングルサインオンの設定方法は「JP1/Service Support 構築・運用ガイド」のJP1/AO との連携機能について記述されている箇所を参照してください。

(2)案件フォームに拡張テキストデータを追加していること。

　JP1/IM-SSのJP1/AOとの連携機能で呼び出すサービスの所属するサービスグループ名と，呼び出すサービス名に対応する拡張テキストデータをJP1/IM-SSの案件フォームに追加していること。

案件フォームの設定方法は「JP1/Integrated Management - Service Support構築・運用ガイド」の案件フォームのカスタマイズについて記述されている箇所を参照してください。

(3)システムプロパティファイルに拡張テキストデータの項目IDを設定していること。

案件フォームに追加した拡張テキストデータの項目IDをJP1/IM-SSのシステムプロパティファイル(hptl_jp1_imss_main_setting.properties)の，JP1/AOに引き継がれる情報(サービスのサービスグループ名，サービス名)に設定してください。

　システムプロパティファイルの設定方法は「JP1/Service Support 構築・運用ガイド」のJP1/AOとの連携機能について記述されている箇所を参照してください。

(4)JP1/IM-SSのJP1/AOとの連携機能で呼び出すサービスが，JP/AOサーバにサービスとして存在していること。

注意事項

(1)指定しなかったプロパティは登録されません。指定しなかったプロパティを登録する場合は，JP1/IM-SSのGUIかコマンドを使用して案件情報を更新してください。

(2)JP1/IM-SSの画面からJP1/AOのサービス実行ダイアログを呼びだすための関連情報を登録する場合，次のプロパティをすべて指定してください。

　・JP1IMSS.relatedInformationNameプロパティ

　・JP1IMSS.referURLプロパティ

　・JP1IMSS.relatedResourceGroupNameプロパティ

　・JP1IMSS.relatedResourceGroupNumberプロパティ

　・JP1IMSS.relatedServiceNameプロパティ

　・JP1IMSS.relatedServiceNumberプロパティ

(3)次に示す4つのプロパティがすべて設定されたとき，(b)(d)に指定した番号の拡張テキストデータについては，JP1IMSS.extendText1〜20プロパティの指定値より(a)(c)の値が優先されます。

　(a)JP1IMSS.relatedResourceGroupNameプロパティ

　(b)JP1IMSS.relatedResourceGroupNumberプロパティ

　(c)JP1IMSS.relatedServiceNameプロパティ

　(d)JP1IMSS.relatedServiceNumberプロパティ

(4)プロパティには「//」で始まる値は指定しないでください。

(5)エージェントレス接続先設定の認証情報に設定したユーザーがビルトインAdministratorではない場合，以下のいずれかの条件を満たす必要があります。

・WindowsのUAC機能が完全に無効化されている。

・エージェントレス接続先の機器にて，エージェントレス接続先設定の認証情報に設定されたユーザーに対するRDPセッションが確立されている。

実行権限

Administrators 権限

バージョン

02.00.00

部品のタグ

Configure JP1,SS,Windows

タスクログに表示される部品の名称

jp1IMSSentryItem

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

25

異常(環境不正) 通信エラー

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

案件を登録するJP1/IM-SSサーバのホスト名，またはIPアドレスを指定します。IPv6には対応していません。

−　

入力

○　

JP1IMSS.processWorkBoardID

プロセスワークボードID

JP1/IMサーバのプロセスワークボードのIDを指定します。

−　

入力

○　

JP1IMSS.subjectTitle

案件のタイトル

案件のタイトルを指定します。

−　

入力

○　

JP1IMSS.registerID

登録者ID

案件の登録者となるユーザーのIDを指定します。

−　

入力

○　

JP1IMSS.staffType

担当者種別

担当者種別("USER"または"ROLE")を指定します。

−　

入力

○　

JP1IMSS.staffID

担当者ID

案件の担当者となるユーザーのIDまたはロールのIDを指定します。

−　

入力

○　

JP1IMSS.severity

重大度

案件に設定する重大度を指定します。

−　

入力

△　

JP1IMSS.influence

影響度

案件に設定する影響度を指定します。

−　

入力

△　

JP1IMSS.priority

優先度

案件に設定する優先度を指定します。案件自動入力設定が有効な場合，コマンド用の案件自動入力プロパティファイルに指定されている値が設定されます。

−　

入力

△　

JP1IMSS.incidentType

案件種別

案件種別を指定します。

−　

入力

△　

JP1IMSS.filedType

問題分野

案件の問題分野を指定します。

−　

入力

△　

JP1IMSS.customerName

顧客名

案件に設定する顧客名を指定します。

−　

入力

△　

JP1IMSS.reqName

問い合わせ者

案件に設定する問い合わせ者を指定します。

−　

入力

△　

JP1IMSS.impacts

影響業務

案件に設定する影響業務を指定します。文字列置換設定ファイルを設定することで，任意の文字列を改行に置換して登録することができます。

−　

入力

△　

JP1IMSS.summary

概要

案件の概要を指定します。文字列置換設定ファイルを設定することで，任意の文字列を改行に置換して登録することができます。

−　

入力

△　

JP1IMSS.relatedInformationName

案件の関連情報の表示名

案件の関連情報の表示名を指定します。

−　

入力

△　

JP1IMSS.referURL

関連情報

関連情報のURLを指定します。

−　

入力

△　

JP1IMSS.linkItemID

関連する案件ID(複数入力可)

関連する案件へリンクさせるため，関連する案件のID を指定します。IDは128 バイトまでの文字列で指定してください。複数指定する場合はコンマで区切ってください。10個まで入力できます。

−　

入力

△　

JP1IMSS.occurenceDateTime

発生日時

案件の発生日時を「YYYY/MM/DD hh:mm:ss」または「YYYY/MM/DD hh:mm」形式で指定します。プロセスワークボードの案件自動入力設定が有効な場合は，省略するとコマンド実行時刻が設定されます。

−　

入力

△　

JP1IMSS.startDateTime

開始日時

案件の開始日時を「YYYY/MM/DD hh:mm:ss」または「YYYY/MM/DD hh:mm」形式で指定します。プロセスワークボードの案件自動入力設定が有効な場合は，省略するとコマンド実行時刻が設定されます。

−　

入力

△　

JP1IMSS.deadLine

作業期限

案件の作業期限を「YYYY/MM/DD hh:mm:ss」または「YYYY/MM/DD hh:mm」形式で指定します。プロセスワークボードの案件自動入力設定が有効な場合は，省略するとコマンド実行時刻に，設定時間が加算された値が設定されます。

−　

入力

△　

JP1IMSS.extendText1

拡張テキストデータ1

ユーザーがカスタマイズした文字列型の項目を指定します。

−　

入力

△　

JP1IMSS.extendText2

拡張テキストデータ2

ユーザーがカスタマイズした文字列型の項目を指定します。

−　

入力

△　

JP1IMSS.extendText3

拡張テキストデータ3

ユーザーがカスタマイズした文字列型の項目を指定します。

−　

入力

△　

JP1IMSS.extendText4

拡張テキストデータ4

ユーザーがカスタマイズした文字列型の項目を指定します。

−　

入力

△　

JP1IMSS.extendText5

拡張テキストデータ5

ユーザーがカスタマイズした文字列型の項目を指定します。

−　

入力

△　

JP1IMSS.extendText6

拡張テキストデータ6

ユーザーがカスタマイズした文字列型の項目を指定します。

−　

入力

△　

JP1IMSS.extendText7

拡張テキストデータ7

ユーザーがカスタマイズした文字列型の項目を指定します。

−　

入力

△　

JP1IMSS.extendText8

拡張テキストデータ8

ユーザーがカスタマイズした文字列型の項目を指定します。

−　

入力

△　

JP1IMSS.extendText9

拡張テキストデータ9

ユーザーがカスタマイズした文字列型の項目を指定します。

−　

入力

△　

JP1IMSS.extendText10

拡張テキストデータ10

ユーザーがカスタマイズした文字列型の項目を指定します。

−　

入力

△　

JP1IMSS.extendText11

拡張テキストデータ11

ユーザーがカスタマイズした文字列型の項目を指定します。

−　

入力

△　

JP1IMSS.extendText12

拡張テキストデータ12

ユーザーがカスタマイズした文字列型の項目を指定します。

−　

入力

△　

JP1IMSS.extendText13

拡張テキストデータ13

ユーザーがカスタマイズした文字列型の項目を指定します。

−　

入力

△　

JP1IMSS.extendText14

拡張テキストデータ14

ユーザーがカスタマイズした文字列型の項目を指定します。

−　

入力

△　

JP1IMSS.extendText15

拡張テキストデータ15

ユーザーがカスタマイズした文字列型の項目を指定します。

−　

入力

△　

JP1IMSS.extendText16

拡張テキストデータ16

ユーザーがカスタマイズした文字列型の項目を指定します。

−　

入力

△　

JP1IMSS.extendText17

拡張テキストデータ17

ユーザーがカスタマイズした文字列型の項目を指定します。

−　

入力

△　

JP1IMSS.extendText18

拡張テキストデータ18

ユーザーがカスタマイズした文字列型の項目を指定します。

−　

入力

△　

JP1IMSS.extendText19

拡張テキストデータ19

ユーザーがカスタマイズした文字列型の項目を指定します。

−　

入力

△　

JP1IMSS.extendText20

拡張テキストデータ20

ユーザーがカスタマイズした文字列型の項目を指定します。

−　

入力

△　

JP1IMSS.extendDateTime

拡張時刻データ(複数入力可)

ユーザーがカスタマイズしたDATE 型の項目を指定します。項目は「YYYY/MM/DD hh:mm:ss 」または「YYYY/MM/DD hh:mm」の形式で入力します。複数指定する場合はコンマで区切ってください。5個まで入力できます。

−　

入力

△　

JP1IMSS.extendData

拡張コードデータ(複数入力可)

ユーザーがカスタマイズしたコード型の項目を指定します。複数指定する場合はコンマで区切ってください。5個まで入力できます。拡張コードデータを使用する場合は，必ずコードマッピングファイルを指定してください。

−　

入力

△　

JP1IMSS.extendNumericValue

拡張数値データ(複数入力可)

ユーザーがカスタマイズした数値型の項目を指定します。項目は0〜2147483647 の10進整数値で入力します。複数指定する場合はコンマで区切ってください。5個まで入力できます。

−　

入力

△　

JP1IMSS.extendUserID

ユーザーIDまたはロールID(複数入力可)

ユーザーがカスタマイズしたユーザー/ロール型項目を指定します。項目は｢USER ユーザーID」または「ROLE ロールID」の形式で入力します。複数指定する場合はコンマで区切ってください。5個まで入力できます。

−　

入力

△　

JP1IMSS.codeMappingFile

コードマッピングファイルパス(リモート)

ユーザーが定義したコードマッピングファイルを使用する場合，JP1/IM-SSサーバ上のコードマッピングファイル名をフルパスで指定します。

−　

入力

△　

JP1IMSS.relatedResourceGroupName

JP1/IM-SSのJP1/AOとの連携機能で呼び出すサービスのサービスグループ名

JP1/IM-SSのJP1/AOとの連携機能で呼び出すサービスのサービスグループ名を指定します。

−　

入力

△　

JP1IMSS.relatedResourceGroupNumber

JP1/IM-SSのJP1/AOとの連携機能で呼び出すサービスのサービスグループ名に割り当てる拡張テキストデータ番号

サービスグループ名を格納する拡張テキストデータ番号を指定します。拡張テキストデータ番号の項目IDをJP1/IM-SSのシステムプロパティファイル(hptl_jp1_imss_main_setting.properties)に指定しておきます。

−　

入力

△　

JP1IMSS.relatedServiceName

JP1/IM-SSのJP1/AOとの連携機能で呼び出すサービスのサービス名

JP1/IM-SSのJP1/AOとの連携機能で呼び出すサービスのサービス名を指定します。

−　

入力

△　

JP1IMSS.relatedServiceNumber

JP1/IM-SSのJP1/AOとの連携機能で呼び出すサービスのサービス名に割り当てる拡張テキストデータ番号

サービス名を格納する拡張テキストデータ番号を指定します。拡張テキストデータ番号の項目IDをJP1/IM-SSのシステムプロパティファイル(hptl_jp1_imss_main_setting.properties)に指定しておきます。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.12　JP1/VERITAS関連の部品

4.12.1　インスタントリカバリ実行(JP1/VERITAS)

機能

この部品は，JP1/VERITAS NetBackupサーバで作成した仮想サーバの最新のバックアップを用いて，バックアップ元と同じJP1/VERITAS NetBackupサーバで仮想サーバのインスタントリカバリ(nbrestorevm -ir_activateコマンド)を実行します。インスタントリカバリジョブが正常に起動したことを確認(nbrestorevm -ir_listvmコマンドの出力結果に指定した仮想サーバ名のインスタントリカバリジョブが存在することを確認)したあと，実行中のインスタントリカバリジョブの詳細リスト(nbrestorevm -ir_listvmコマンドの出力結果)を実行中のインスタントリカバリジョブの詳細リスト出力ファイル名(JP1VERITAS.jobListOutputFileName)に出力します。指定した仮想サーバが，バックアップされた際に管理されているESXサーバにインスタントリカバリされます。

プロパティ設定の留意点を次に示します。

・仮想サーバの起動要否(JP1VERITAS.startVMプロパティ)に"true"を指定した場合，インスタントリカバリジョブ実行後に仮想サーバを起動します。"true"以外を指定した場合は，仮想サーバを起動しません。

・一時データストア名(JP1VERITAS.dataStoreNameプロパティ)には作成済みのデータストアを指定してください。

・JP1/VERITAS NetBackupのマスターサーバとメディアサーバが異なるサーバ上に存在する場合はメディアサーバのホスト名(JP1VERITAS.mediaServerHostプロパティ)にメディアサーバのホスト名を指定してください。

・仮想サーバ名(JP1VERITAS.vmNameプロパティ)は大文字小文字を区別しません。

・インスタントリカバリが正常に起動したことを確認するために，インスタントリカバリジョブ起動待ち合わせ間隔(JP1VERITAS.waitJobActIntervalプロパティ)に指定した秒数待ち，ジョブが起動したか確認する動作をインスタントリカバリジョブ起動待ち合わせ回数(JP1VERITAS.waitJobActCountプロパティ)に指定した回数実行します。指定した回数の実行までにジョブが起動した場合は部品が正常終了し，ジョブが起動しなかった場合は部品が異常終了します。

・一時データストア名(JP1VERITAS.dataStoreNameプロパティ)にはインスタントリカバリ先のESXサーバが管理するデータストアの名前を指定してください。

この部品では，次のサーバを前提とします。

・JP1/VERITAS NetBackupサーバ(実行対象サーバ)

　JP1/VERITAS NetBackup(マスターサーバ)が動作するサーバです。

利用場面

JP1/VERITAS NetBackupサーバでバックアップされたVMWare仮想サーバを迅速に回復するため，インスタンスリカバリを開始する際に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/VERITAS NetBackup 7.6，7.7

　(2)JP1/VERITAS NetBackup 8.0，8.1，8.2，8.3

　(3)JP1/VERITAS NetBackup 9.0，9.1

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバの使用条件】

(1) JP1/VERITAS NetBackupサーバで仮想サーバ名(JP1VERITAS.vmNameプロパティ)に指定した仮想サーバのバックアップが作成されていること。バックアップは次の条件で作成してください。

　・バックアップポリシーでPrimary VM identifierとしてVM display Nameを指定していること。

　・バックアップポリシーでバックアップホストとしてWindowsサーバを指定していること。

(2) 仮想サーバに関する条件

　・同一のvCenterの管理下において，仮想サーバ名が重複しないこと。

　・同一のvCenterの管理下において，仮想サーバ名(JP1VERITAS.vmNameプロパティ)に指定した仮想サーバが存在しないこと。

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)同一の仮想サーバ名(JP1VERITAS.vmNameプロパティ)を指定してこの部品，およびこの部品とnbrestorevm -ir_activateコマンドは同時実行しないでください。同時実行した場合，部品が正常終了してもインスタントリカバリジョブが正常に起動していないおそれがあるため，実行中のインスタントリカバリジョブの詳細リストで仮想サーバ名(VM Display Name)，一時データストア名(Temporary datastore name for writes)，メディアサーバ名(Media Server Name)(メディアサーバのホスト名(JP1VERITAS.mediaServerHostプロパティ)を指定している場合だけ)がこの部品で指定した値になっていることを確認してください。

(3)仮想サーバ名(JP1VERITAS.vmNameプロパティ)にインスタントリカバリジョブが実行中の仮想サーバを指定した場合，部品が異常終了します。

(4)実行中のインスタントリカバリジョブの詳細リスト出力ファイル名(JP1VERITAS.jobListOutputFileNameプロパティ)に指定したファイルが既に存在する場合，既存のファイルを上書きします。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(5)作成するファイルのパスに含まれるフォルダが存在しない場合は，そのフォルダを作成します。

実行権限

・Windowsの場合は，Administratorsグループに属するユーザーであること。

・UNIXの場合は，root権限を持つユーザーであること。

バージョン

02.00.00

部品のタグ

Control JP1,VERITAS,Windows,Linux

タスクログに表示される部品の名称

jp1veritasStartInstantRecovery

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1VERITAS.mediaServerHost

メディアサーバのホスト名

JP1/VERITAS NetBackUpのメディアサーバのホスト名を指定します。マスターサーバとメディアサーバが異なるサーバ上に存在する場合は指定してください。

−　

入力

△　

JP1VERITAS.dataStoreName

一時データストア名

仮想サーバがリストアされるまで，スナップショットの書き込みが行われるESXサーバ上の一時データストアを指定します。作成済みのデータストアを指定してください。

−　

入力

○　

JP1VERITAS.vmName

仮想サーバ名

仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

JP1VERITAS.startVM

仮想サーバの起動要否

インスタントリカバリ後に仮想サーバを起動する場合は"true"を指定します。"true"以外の場合は，仮想サーバを起動せずに終了します。

true

入力

○　

JP1VERITAS.jobListOutputFileName

実行中のインスタントリカバリジョブの詳細リスト出力ファイル名

実行中のインスタントリカバリジョブの詳細リストを出力するファイル名をフルパスで指定します。

−　

入力

○　

JP1VERITAS.waitJobActCount

インスタントリカバリジョブ起動待ち合わせ回数

インスタントリカバリジョブの起動を確認する回数を1〜3600で指定します。

60

入力

○　

JP1VERITAS.waitJobActInterval

インスタントリカバリジョブ起動待ち合わせ間隔

インスタントリカバリジョブの起動を確認する間隔(秒)を1〜60で指定します。

10

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.12.2　インスタントリカバリ終了(JP1/VERITAS)

機能

この部品は，JP1/VERITAS NetBackupサーバで起動中のインスタントリカバリジョブの終了処理(nbrestorevm -ir_doneコマンド)を実行し，その後インスタントリカバリジョブが正常に終了したことを確認(nbrestorevm -ir_listvmコマンドの出力結果に指定したインスタントリカバリIDのインスタントリカバリジョブが存在しないことを確認)します。

プロパティ設定の留意点を次に示します。

・インスタントリカバリID(JP1VERITAS.instantRecoveryIDプロパティ)に入力する値は実行中のインスタントリカバリジョブの詳細リスト(nbrestorevm -ir_listvmコマンドの出力結果)を参照して下さい。

・インスタントリカバリジョブが正常に終了したことを確認するために，インスタントリカバリジョブの終了待ち合わせ間隔(JP1VERITAS.waitJobFinIntervalプロパティ)に指定した秒数待ち，ジョブが終了したか確認する動作をインスタントリカバリジョブの終了待ち合わせ回数(JP1VERITAS.waitJobFinCountプロパティ)に指定した回数実行します。指定した回数の実行までにジョブが終了した場合は部品が正常終了し，ジョブが終了しなかった場合は部品が異常終了します。

この部品では，次のサーバを前提とします。

・JP1/VERITAS NetBackupサーバ(実行対象サーバ)

　JP1/VERITAS NetBackup(マスターサーバ)が動作するサーバです。

利用場面

JP1/VERITAS NetBackupサーバでVMWare仮想サーバを迅速に回復する際，インスタントリカバリを終了するために使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/VERITAS NetBackup 7.6，7.7

　(2)JP1/VERITAS NetBackup 8.0，8.1，8.2，8.3

　(3)JP1/VERITAS NetBackup 9.0，9.1

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象サーバの使用条件】

(1) JP1/VERITAS NetBackupサーバでインスタントリカバリID(JP1VERITAS.instantRecoveryIDプロパティ)で指定したインスタントリカバリジョブが起動していること。

(2) 仮想サーバに関する条件

　・同一のvCenterの管理下において，仮想サーバ名が重複しないこと。

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)インスタントリカバリID(JP1VERITAS.instantRecoveryIDプロパティ)に起動していないインスタントリカバリジョブのインスタントリカバリIDを指定した場合，部品が異常終了します。

実行権限

・Windowsの場合は，Administratorsグループに属するユーザーであること。

・UNIXの場合は，root権限を持つユーザーであること。

バージョン

02.00.00

部品のタグ

Control JP1,VERITAS,Windows,Linux

タスクログに表示される部品の名称

jp1veritasFinishInstantRecovery

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1VERITAS.instantRecoveryID

インスタントリカバリID

終了させるインスタントリカバリジョブのIDを指定します。

−　

入力

○　

JP1VERITAS.waitJobFinCount

インスタントリカバリジョブ終了待ち合わせ回数

インスタントリカバリジョブの終了を確認する回数を1〜3600で指定します。

60

入力

○　

JP1VERITAS.waitJobFinInterval

インスタントリカバリジョブ終了待ち合わせ間隔

インスタントリカバリジョブの終了を確認する間隔(秒)を1〜60で指定します。

10

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.12.3　バックアップポリシー(VMware)の初期化

機能

この部品は，JP1/VERITAS NetBackupと連携し，ポリシー形式を「VMware」として，指定したバックアップポリシーを初期化します。

この部品が前提とするサーバを次に示します。

・JP1/VERITAS NetBackup(実行対象サーバ)

　JP1/VERITAS NetBackup(マスターサーバ)が動作するサーバです。本製品によってこのサーバに部品が転送され，実行されます。

この部品内のスクリプトでは，次に示すコマンドを実行します。

・bpplinfo "バックアップポリシー名(JP1VERITAS.backupPolicyNameプロパティ)の値"

　　　　　　-pt "VMware"(固定)

　　　　　　[-residence "ストレージユニット名(JP1VERITAS.residenceプロパティ)の値"]

　　　　　　[-blkincr "BLIバックアップ可否(JP1VERITAS.blockLevelIncrementalプロパティ)の値"]

　　　　　　[-use_accelerator "アクセラレータ使用可否(JP1VERITAS.useAcceleratorプロパティ)の値"]

JP1/VERITAS NetBackupのbpplinfoコマンドの詳細については，JP1/VERITAS NetBackupマニュアルの同コマンドを参照してください。

利用場面

バックアップポリシーを作成・設定は，次の部品を使って使用できます。

・バックアップポリシーの作成

・バックアップポリシーの初期化

・バックアップポリシーの属性変更

・バックアップポリシーへのスケジュール追加

・バックアップポリシーへのスケジュール属性変更

・バックアップポリシーへのクライアント追加

・バックアップポリシーへのファイルリスト追加

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) JP1/VERITAS NetBackup 7.6，7.7

　(2) JP1/VERITAS NetBackup 8.0，8.1，8.2，8.3

　(3) JP1/VERITAS NetBackup 9.0，9.1

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象システム内前提製品の使用条件】

　特になし。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) バックアップポリシー名(JP1VERITAS.backupPolicyNameプロパティ)には，半角英数字および「.」，「-」，「+」，「_」は指定可能です。但し，先頭および末尾に「.」，「-」を指定した場合および指定可能文字以外を指定した場合，タスクが異常終了します。

(3) その他の注意事項については，JP1/VERITAS NetBackupマニュアルの同コマンドの注意事項を参照してください。

実行権限

Administratorsグループに属するユーザーであること。

バージョン

02.01.00

部品のタグ

Control JP1,VERITAS,Windows

タスクログに表示される部品の名称

jp1veritasInitializePolicy_VMware

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1VERITAS.backupPolicyName

バックアップポリシー名

バックアップポリシー名を指定します。

−　

入力

○　

JP1VERITAS.residence

バックアップ先ストレージユニットのラベル

バックアップの格納先に使用されるストレージユニットのラベルを指定します。

−　

入力

△　

JP1VERITAS.blockLevelIncremental

BLIバックアップの有効化要否

BLI(Block Level Incremental)バックアップを有効化する場合は1を，無効化する場合は0を指定します。

−　

入力

△　

JP1VERITAS.useAccelerator

アクセラレータ使用要否

アクセラレータを有効にする場合は1を，無効化する場合は0を指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.12.4　バックアップポリシー(VMware)の属性変更

機能

この部品は，JP1/VERITAS NetBackupと連携し，ポリシー形式を「VMware」として，指定したバックアップポリシーの属性を変更します。

この部品が前提とするサーバを次に示します。

・JP1/VERITAS NetBackup(実行対象サーバ)

　JP1/VERITAS NetBackup(マスターサーバ)が動作するサーバです。本製品によってこのサーバに部品が転送され，実行されます。

この部品内のスクリプトでは，次に示すコマンドを実行します。

・bpplinfo "バックアップポリシー名(JP1VERITAS.backupPolicyNameプロパティ)の値"

　　　　　　-modify

　　　　　　-use_virtual_machine 1(固定)

　　　　　　-alt_client_name "代替クライアント名(JP1VERITAS.altClientNameプロパティ)の値"

　　　　　　-snapshot_method_args "[file_system_optimaization="削除されたブロックの除外有効化(JP1VERITAS.fileSystemOptプロパティ)の値"]

　　　　　　，[snapact="孤立スナップショットの処理(JP1VERITAS.snapActプロパティ)の値"]

　　　　　　，[Virtual_machine_backup="VMバックアップからのリカバリ有効化(JP1VERITAS.vmBackupプロパティ)の値"]

　　　　　　，[nameuse="プライマリVM識別子(JP1VERITAS.nameUseプロパティ)の値"]

　　　　　　，[exclude_swap="スワップおよびページングファイルの除外(JP1VERITAS.excludeSwapプロパティ)の値"]

　　　　　　，[trantype="トランスポートモード(JP1VERITAS.tranTypeプロパティ)の値"]

　　　　　　，drive_selection=0(固定)

　　　　　　，enable_vCloud=0(固定)

　　　　　　，multi_org=0(固定)

　　　　　　，disable_quiesce=0(固定)

　　　　　　，skipnodisk=0(固定)

　　　　　　，post_events=1(固定)

　　　　　　，ignore_irvm=0(固定)

　　　　　　，rLim=10(固定)

　　　　　　，rTO=0(固定)

　　　　　　，rHz=10(固定)"

JP1/VERITAS NetBackupのbpplinfoコマンドの詳細については，JP1/VERITAS NetBackupマニュアルの同コマンドを参照してください。

利用場面

バックアップポリシーを作成・設定は，次の部品を使って使用できます。

・バックアップポリシーの作成

・バックアップポリシーの初期化

・バックアップポリシーの属性変更

・バックアップポリシーへのスケジュール追加

・バックアップポリシーへのスケジュール属性変更

・バックアップポリシーへのクライアント追加

・バックアップポリシーへのファイルリスト追加

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) JP1/VERITAS NetBackup 7.6，7.7

　(2) JP1/VERITAS NetBackup 8.0，8.1，8.2，8.3

　(3) JP1/VERITAS NetBackup 9.0，9.1

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象システム内前提製品の使用条件】

　特になし。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) バックアップポリシー名(JP1VERITAS.backupPolicyNameプロパティ)には，半角英数字および「.」，「-」，「+」，「_」は指定可能です。但し，先頭および末尾に「.」，「-」を指定した場合および指定可能文字以外を指定した場合，タスクが異常終了します。

(3) その他の注意事項については，JP1/VERITAS NetBackupマニュアルの同コマンドの注意事項を参照してください。

実行権限

Administratorsグループに属するユーザーであること。

バージョン

02.01.00

部品のタグ

Control JP1,VERITAS,Windows

タスクログに表示される部品の名称

jp1veritasUppdatePolicy_VMware

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1VERITAS.backupPolicyName

バックアップポリシー名

バックアップポリシー名を指定します。

−　

入力

○　

JP1VERITAS.altClientName

代替クライアント名

VMware バックアップホスト(NetBackup アクセスホスト)を指定します。特定のバックアップホストまたはMEDIA_SERVERを指定できます。

−　

入力

○　

JP1VERITAS.fileSystemOpt

削除されたブロックの除外有効化

ポリシーGUIの[VMware]での「削除されたブロックのエクスクルード (Exclude deleted blocks)」オプションを有効にする場合は1，無効にする場合は0を指定します。

−　

入力

△　

JP1VERITAS.snapAct

孤立スナップショットの処理

ポリシーGUIの[VMware]での「孤立スナップショットの処理 (Orphaned snapshot handling)」オプションの値を0(無視)，1(中止)，2(NetBackup削除)で指定します。

−　

入力

△　

JP1VERITAS.vmBackup

VMバックアップからのリカバリ有効化

ポリシーGUIの[VMware]での「VM バックアップからのファイルリカバリを有効にする (Enable file recovery from VM backup)」オプションの値を1(無効)，2(有効)で指定します。

−　

入力

△　

JP1VERITAS.nameUse

プライマリVM識別子

ポリシーGUIの[VMware]での「プライマリ VM 識別子(Primary VM identifier)」オプションの値を0(VMホスト名)，1 (VM表示名)，2(VM BIOS UUID)，3(VM DNS名)，4(VMのインスタンスUUID)で指定します。

−　

入力

△　

JP1VERITAS.excludeSwap

スワップおよびページングファイルの除外

ポリシーGUIの[VMware]での「スワップおよびページングファイルのエクスクルード (Exclude swapand paging files)」オプションを有効にする場合は1，無効にする場合は0を指定します。

−　

入力

△　

JP1VERITAS.tranType

トランスポートモード

ポリシーGUIの[VMware]での「トランスポートモード(Transport modes)」オプションの値をsan，hotadd，nbdまたはnbdsslで指定します。複数指定する場合は":"(コロン)で区切ります。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.12.5　バックアップポリシーの作成

機能

この部品は，JP1/VERITAS NetBackupと連携し，バックアップポリシーを1つ作成します。

この部品が前提とするサーバを次に示します。

・JP1/VERITAS NetBackup(実行対象サーバ)

　JP1/VERITAS NetBackup(マスターサーバ)が動作するサーバです。本製品によってこのサーバに部品が転送され，実行されます。

この部品内のスクリプトでは，次に示すコマンドを実行します。

・bppolicynew "バックアップポリシー名(JP1VERITAS.backupPolicyNameプロパティ)の値"

JP1/VERITAS NetBackupのbppolicynewコマンドの詳細については，JP1/VERITAS NetBackupマニュアルの同コマンドを参照してください。

利用場面

バックアップポリシーを作成・設定は，次の部品を使って使用できます。

・バックアップポリシーの作成

・バックアップポリシーの初期化

・バックアップポリシーの属性変更

・バックアップポリシーへのスケジュール追加

・バックアップポリシーへのスケジュール属性変更

・バックアップポリシーへのクライアント追加

・バックアップポリシーへのファイルリスト追加

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) JP1/VERITAS NetBackup 7.6，7.7

　(2) JP1/VERITAS NetBackup 8.0，8.1，8.2，8.3

　(3) JP1/VERITAS NetBackup 9.0，9.1

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象システム内前提製品の使用条件】

　特になし。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) バックアップポリシー名(JP1VERITAS.backupPolicyNameプロパティ)には，半角英数字および「.」，「-」，「+」，「_」は指定可能です。但し，先頭および末尾に「.」，「-」を指定した場合および指定可能文字以外を指定した場合，タスクが異常終了します。

(3) その他の注意事項については，JP1/VERITAS NetBackupマニュアルの同コマンドの注意事項を参照してください。

実行権限

Administratorsグループに属するユーザーであること。

バージョン

02.01.00

部品のタグ

Control JP1,VERITAS,Windows

タスクログに表示される部品の名称

jp1veritasCreatePolicy

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1VERITAS.backupPolicyName

バックアップポリシー名

バックアップポリシー名を指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.12.6　バックアップポリシーへのクライアント追加

機能

この部品は，JP1/VERITAS NetBackupと連携し，指定したバックアップポリシーにクライアントを追加します。

この部品が前提とするサーバを次に示します。

・JP1/VERITAS NetBackup(実行対象サーバ)

　JP1/VERITAS NetBackup(マスターサーバ)が動作するサーバです。本製品によってこのサーバに部品が転送され，実行されます。

この部品内のスクリプトでは，次に示すコマンドを実行します。

・bpplclients "バックアップポリシー名(JP1VERITAS.backupPolicyNameプロパティ)の値"

　　　　　　　-add "クライアントのホスト名(JP1VERITAS.clientHostNameプロパティ)の値"

　　　　　　　　　"ハードウェア名(JP1VERITAS.hardwareNameプロパティ)の値"

　　　　　　　　　"OS名(JP1VERITAS.osNameプロパティ)の値"

JP1/VERITAS NetBackupのbpplclientsコマンドの詳細については，JP1/VERITAS NetBackupマニュアルの同コマンドを参照してください。

利用場面

バックアップポリシーを作成・設定は，次の部品を使って使用できます。

・バックアップポリシーの作成

・バックアップポリシーの初期化

・バックアップポリシーの属性変更

・バックアップポリシーへのスケジュール追加

・バックアップポリシーへのスケジュール属性変更

・バックアップポリシーへのクライアント追加

・バックアップポリシーへのファイルリスト追加

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) JP1/VERITAS NetBackup 7.6，7.7

　(2) JP1/VERITAS NetBackup 8.0，8.1，8.2，8.3

　(3) JP1/VERITAS NetBackup 9.0，9.1

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象システム内前提製品の使用条件】

　特になし。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) バックアップポリシー名(JP1VERITAS.backupPolicyNameプロパティ)には，半角英数字および「.」，「-」，「+」，「_」は指定可能です。但し，先頭および末尾に「.」，「-」を指定した場合および指定可能文字以外を指定した場合，タスクが異常終了します。

(3) その他の注意事項については，JP1/VERITAS NetBackupマニュアルの同コマンドの注意事項を参照してください。

実行権限

Administratorsグループに属するユーザーであること。

バージョン

02.01.00

部品のタグ

Control JP1,VERITAS,Windows

タスクログに表示される部品の名称

jp1veritasAddClient

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1VERITAS.backupPolicyName

バックアップポリシー名

バックアップポリシー名を指定します。

−　

入力

○　

JP1VERITAS.clientHostName

クライアントのホスト名

バックアップポリシーに追加するクライアントのホスト名を指定します。

−　

入力

○　

JP1VERITAS.hardwareName

ハードウェア名

バックアップポリシーに追加するクライアントのハードウェア名を指定します。現在指定可能な値はポリシー形式が「VMware」の場合の指定値"VMware"だけです。

−　

入力

○　

JP1VERITAS.osName

OS名

バックアップポリシーに追加するクライアントのOS名を指定します。現在指定可能な値はポリシー形式が「VMware」の場合の指定値"Virtual_Machine"だけです。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.12.7　バックアップポリシーへのスケジュール属性変更

機能

この部品は，JP1/VERITAS NetBackupと連携し，指定したバックアップポリシーのスケジュール属性を変更します。

この部品が前提とするサーバを次に示します。

・JP1/VERITAS NetBackup(実行対象サーバ)

　JP1/VERITAS NetBackup(マスターサーバ)が動作するサーバです。本製品によってこのサーバに部品が転送され，実行されます。

この部品内のスクリプトでは，次に示すコマンドを実行します。

・bpplschedrep "ポリシー名(JP1VERITAS.backupPolicyNameプロパティ)" "スケジュールラベル(JP1VERITAS.scheduleLabelプロパティ)"

　　　　　　　[-freq "自動バックアップの間隔(JP1VERITAS.backupFrequencyプロパティ)"]

　　　　　　　[-checksum_change_detection "アクセラレータ強制再スキャン(JP1VERITAS.accelForceRescanプロパティ)"]

　　　　　　　[-0 "バックアップ時間帯の開始時刻(日曜日)(JP1VERITAS.sunStartプロパティ)" "バックアップ時間帯の長さ(日曜日)(JP1VERITAS.sunDurationプロパティ)"]

　　　　　　　[-1 "バックアップ時間帯の開始時刻(月曜日)(JP1VERITAS.monStartプロパティ)" "バックアップ時間帯の長さ(月曜日)(JP1VERITAS.monDurationプロパティ)"]

　　　　　　　[-2 "バックアップ時間帯の開始時刻(火曜日)(JP1VERITAS.tueStartプロパティ)" "バックアップ時間帯の長さ(火曜日)(JP1VERITAS.tueDurationプロパティ)"]

　　　　　　　[-3 "バックアップ時間帯の開始時刻(水曜日)(JP1VERITAS.wedStartプロパティ)" "バックアップ時間帯の長さ(水曜日)(JP1VERITAS.wedDurationプロパティ)"]

　　　　　　　[-4 "バックアップ時間帯の開始時刻(木曜日)(JP1VERITAS.thuStartプロパティ)" "バックアップ時間帯の長さ(木曜日)(JP1VERITAS.thuDurationプロパティ)"]

　　　　　　　[-5 "バックアップ時間帯の開始時刻(金曜日)(JP1VERITAS.friStartプロパティ)" "バックアップ時間帯の長さ(金曜日)(JP1VERITAS.friDurationプロパティ)"]

　　　　　　　[-6 "バックアップ時間帯の開始時刻(土曜日)(JP1VERITAS.satStartプロパティ)" "バックアップ時間帯の長さ(土曜日)(JP1VERITAS.satDurationプロパティ)"]

　　　　　　　[-rl "バックアップ保持期間(JP1VERITAS.retentionプロパティ)"]

JP1/VERITAS NetBackupのbpplschedrepコマンドの詳細については，JP1/VERITAS NetBackupマニュアルの同コマンドを参照してください。

【プロパティ指定に関して】

・各曜日のバックアップ時間帯の開始時刻と長さ(JP1VERITAS.xxxStartプロパティとJP1VERITAS.xxxDurationプロパティ)は両方指定してください。どちらか片方だけが指定されている場合は指定値が無視され，その曜日にはバックアップ時間帯が設定されません。

利用場面

バックアップポリシーを作成・設定は，次の部品を使って使用できます。

・バックアップポリシーの作成

・バックアップポリシーの初期化

・バックアップポリシーの属性変更

・バックアップポリシーへのスケジュール追加

・バックアップポリシーへのスケジュール属性変更

・バックアップポリシーへのクライアント追加

・バックアップポリシーへのファイルリスト追加

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) JP1/VERITAS NetBackup 7.6，7.7

　(2) JP1/VERITAS NetBackup 8.0，8.1，8.2，8.3

　(3) JP1/VERITAS NetBackup 9.0，9.1

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象システム内前提製品の使用条件】

　特になし。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) バックアップポリシー名(JP1VERITAS.backupPolicyNameプロパティ)には，半角英数字および「.」，「-」，「+」，「_」は指定可能です。但し，先頭および末尾に「.」，「-」を指定した場合および指定可能文字以外を指定した場合，タスクが異常終了します。

(3) その他の注意事項については，JP1/VERITAS NetBackupマニュアルの同コマンドの注意事項を参照してください。

実行権限

Administratorsグループに属するユーザーであること。

バージョン

02.01.00

部品のタグ

Control JP1,VERITAS,Windows

タスクログに表示される部品の名称

jp1veritasModifySchedule

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1VERITAS.backupPolicyName

バックアップポリシー名

バックアップポリシー名を指定します。

−　

入力

○　

JP1VERITAS.scheduleLabel

スケジュールラベル

スケジュールのラベルを指定します。

−　

入力

○　

JP1VERITAS.backupFrequency

自動バックアップの間隔

自動バックアップの間隔を秒数で指定します。

−　

入力

△　

JP1VERITAS.accelForceRescan

アクセラレータ強制再スキャン

アクセラレータ強制再スキャンを有効にする場合は1，無効にする場合は0を指定します。

−　

入力

△　

JP1VERITAS.sunStart

バックアップ時間帯の開始時刻(日曜日)

日曜日のバックアップ時間帯の開始時刻を，0時からの通算秒で指定します。

−　

入力

△　

JP1VERITAS.sunDuration

バックアップ時間帯の長さ(日曜日)

日曜日のバックアップ時間帯の長さを，秒数で指定します。

−　

入力

△　

JP1VERITAS.monStart

バックアップ時間帯の開始時刻(月曜日)

月曜日のバックアップ時間帯の開始時刻を，0時からの通算秒で指定します。

−　

入力

△　

JP1VERITAS.monDuration

バックアップ時間帯の長さ(月曜日)

月曜日のバックアップ時間帯の長さを，秒数で指定します。

−　

入力

△　

JP1VERITAS.tueStart

バックアップ時間帯の開始時刻(火曜日)

火曜日のバックアップ時間帯の開始時刻を，0時からの通算秒で指定します。

−　

入力

△　

JP1VERITAS.tueDuration

バックアップ時間帯の長さ(火曜日)

火曜日のバックアップ時間帯の長さを，秒数で指定します。

−　

入力

△　

JP1VERITAS.wedStart

バックアップ時間帯の開始時刻(水曜日)

水曜日のバックアップ時間帯の開始時刻を，0時からの通算秒で指定します。

−　

入力

△　

JP1VERITAS.wedDuration

バックアップ時間帯の長さ(水曜日)

水曜日のバックアップ時間帯の長さを，秒数で指定します。

−　

入力

△　

JP1VERITAS.thuStart

バックアップ時間帯の開始時刻(木曜日)

木曜日のバックアップ時間帯の開始時刻を，0時からの通算秒で指定します。

−　

入力

△　

JP1VERITAS.thuDuration

バックアップ時間帯の長さ(木曜日)

木曜日のバックアップ時間帯の長さを，秒数で指定します。

−　

入力

△　

JP1VERITAS.friStart

バックアップ時間帯の開始時刻(金曜日)

金曜日のバックアップ時間帯の開始時刻を，0時からの通算秒で指定します。

−　

入力

△　

JP1VERITAS.friDuration

バックアップ時間帯の長さ(金曜日)

金曜日のバックアップ時間帯の長さを，秒数で指定します。

−　

入力

△　

JP1VERITAS.satStart

バックアップ時間帯の開始時刻(土曜日)

土曜日のバックアップ時間帯の開始時刻を，0時からの通算秒で指定します。

−　

入力

△　

JP1VERITAS.satDuration

バックアップ時間帯の長さ(土曜日)

土曜日のバックアップ時間帯の長さを，秒数で指定します。

−　

入力

△　

JP1VERITAS.retention

バックアップ保持期間

取得したバックアップが保持される期間を0〜24の整数値で指定します。0:1週間，1:2週間，2:3週間，3:1か月，4:2か月，5:3か月，6:6か月，7:9か月，8:1年，9-24:無制限を表します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.12.8　バックアップポリシーへのスケジュール追加

機能

この部品は，JP1/VERITAS NetBackupと連携し，指定したバックアップポリシーにスケジュールを追加します。

この部品が前提とするサーバを次に示します。

・JP1/VERITAS NetBackup(実行対象サーバ)

　JP1/VERITAS NetBackup(マスターサーバ)が動作するサーバです。本製品によってこのサーバに部品が転送され，実行されます。

この部品内のスクリプトでは，次に示すコマンドを実行します。

・bpplsched "バックアップポリシー名(JP1VERITAS.backupPolicyNameプロパティ)"

　　　　　　-add "スケジュールラベル(JP1VERITAS.scheduleLabelプロパティ)"

　　　　　　-st "スケジュールタイプ(JP1VERITAS.scheduleTypeプロパティ)"

JP1/VERITAS NetBackupのbpplschedコマンドの詳細については，JP1/VERITAS NetBackupマニュアルの同コマンドを参照してください。

利用場面

バックアップポリシーを作成・設定は，次の部品を使って使用できます。

・バックアップポリシーの作成

・バックアップポリシーの初期化

・バックアップポリシーの属性変更

・バックアップポリシーへのスケジュール追加

・バックアップポリシーへのスケジュール属性変更

・バックアップポリシーへのクライアント追加

・バックアップポリシーへのファイルリスト追加

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) JP1/VERITAS NetBackup 7.6，7.7

　(2) JP1/VERITAS NetBackup 8.0，8.1，8.2，8.3

　(3) JP1/VERITAS NetBackup 9.0，9.1

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象システム内前提製品の使用条件】

　特になし。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) バックアップポリシー名(JP1VERITAS.backupPolicyNameプロパティ)には，半角英数字および「.」，「-」，「+」，「_」は指定可能です。但し，先頭および末尾に「.」，「-」を指定した場合および指定可能文字以外を指定した場合，タスクが異常終了します。

(3) その他の注意事項については，JP1/VERITAS NetBackupマニュアルの同コマンドの注意事項を参照してください。

実行権限

Administratorsグループに属するユーザーであること。

バージョン

02.01.00

部品のタグ

Control JP1,VERITAS,Windows

タスクログに表示される部品の名称

jp1veritasAddSchedule

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1VERITAS.backupPolicyName

バックアップポリシー名

バックアップポリシー名を指定します。

−　

入力

○　

JP1VERITAS.scheduleLabel

スケジュールラベル

スケジュールのラベルを指定します。

−　

入力

○　

JP1VERITAS.scheduleType

スケジュールタイプ

スケジュール形式として次のどれかを指定します。FULL(完全バックアップ)，INCR(差分増分バックアップ)，CINC(累積増分バックアップ)，UBAK(ユーザーバックアップ)，UARC(ユーザーアーカイブ)

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.12.9　バックアップポリシーへのファイルリスト追加

機能

この部品は，JP1/VERITAS NetBackupと連携し，指定したバックアップポリシーにファイルリストを追加します。

この部品が前提とするサーバを次に示します。

・JP1/VERITAS NetBackup(実行対象サーバ)

　JP1/VERITAS NetBackup(マスターサーバ)が動作するサーバです。本製品によってこのサーバに部品が転送され，実行されます。

この部品内のスクリプトでは，次に示すコマンドを実行します。

・bpplinclude "バックアップポリシー名(JP1VERITAS.backupPolicyNameプロパティ)の値"

　　　　　　　-add "ファイルリストパス(JP1VERITAS.fileListPathプロパティ)の値"

JP1/VERITAS NetBackupのbpplincludeコマンドの詳細については，JP1/VERITAS NetBackupマニュアルの同コマンドを参照してください。

利用場面

バックアップポリシーを作成・設定は，次の部品を使って使用できます。

・バックアップポリシーの作成

・バックアップポリシーの初期化

・バックアップポリシーの属性変更

・バックアップポリシーへのスケジュール追加

・バックアップポリシーへのスケジュール属性変更

・バックアップポリシーへのクライアント追加

・バックアップポリシーへのファイルリスト追加

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) JP1/VERITAS NetBackup 7.6，7.7

　(2) JP1/VERITAS NetBackup 8.0，8.1，8.2，8.3

　(3) JP1/VERITAS NetBackup 9.0，9.1

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象システム内前提製品の使用条件】

　特になし。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) バックアップポリシー名(JP1VERITAS.backupPolicyNameプロパティ)には，半角英数字および「.」，「-」，「+」，「_」は指定可能です。但し，先頭および末尾に「.」，「-」を指定した場合および指定可能文字以外を指定した場合，タスクが異常終了します。

(3) ファイルリストパス(JP1VERITAS.fileListPathプロパティ)には「!」，「%」を含む文字列は指定しないでください。

(4) その他の注意事項については，JP1/VERITAS NetBackupマニュアルの同コマンドの注意事項を参照してください。

実行権限

Administratorsグループに属するユーザーであること。

バージョン

02.01.01

部品のタグ

Control JP1,VERITAS,Windows

タスクログに表示される部品の名称

jp1veritasAddFileList

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1VERITAS.backupPolicyName

バックアップポリシー名

バックアップポリシー名を指定します。

−　

入力

○　

JP1VERITAS.fileListPath

ファイルリストパス

バックアップポリシーに追加するファイルリストのフルパスを指定します。複数のファイルパスを指定する場合は，半角コンマで区切ってください。現在指定可能な値はポリシー形式が「VMware」の場合の指定値"ALL_LOCAL_DRIVES"だけです。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.12.10　バックアップ実行(JP1/VERITAS)

機能

この部品は，JP1/VERITAS NetBackupでバックアップを実行し，バックアップの実行終了後に部品が終了します。

この部品では，次のサーバを前提とします。

・バックアップ実行サーバ(実行対象サーバ)

　JP1/VERITAS NetBackupが動作するサーバです。

　実行対象のバックアップポリシーが作成されている必要があります。

利用場面

定期的または必要なタイミングで対象サーバのバックアップを取得します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)JP1/VERITAS NetBackup 7.0，7.1，7.5，7.6，7.7

　(2)JP1/VERITAS NetBackup 8.0，8.1，8.2，8.3

　(3)JP1/VERITAS NetBackup 9.0，9.1

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) AIX V6

　(9) AIX V7

【実行対象サーバ内前提製品の使用条件】

　(1)JP1/VERITAS NetBackupが起動していること。

　(2)実行対象のバックアップポリシーが設定されていること。

　(3)JP1/VERITAS NetBackupでバックアップポリシーを定義する際に次のように設定してください。

　・スケジュールのStart Windowを設定しないでください。

　　スケジュール実行はJP1/Automatic Operationで設定してください。

　・"Bare Metal Restore"のチェックを外してください。JP1/VERITAS NetBackup 7.0，7.1の場合，この機能をサポートしておりません。

　　JP1/VERITAS NetBackup 7.0では，デフォルトでチェックが付いているため，部品実行前に必ず確認してください。

その他のJP1/VERITAS NetBackupの未サポート機能については，JP1/VERITAS NetBackupのソフトウェア添付資料の未サポート機能に記載があります。

これらの機能も設定しないでください。

注意事項

(1)実行中のバックアップをキャンセルする際には，JP1/VERITAS NetBackup側でジョブをキャンセルする必要があります。

　JP1/Automatic Operation側で実行中のタスクをキャンセル(強制終了)しても，JP1/VERITAS NetBackupのジョブはキャンセルされません。

(2)次の機能を使用した場合に，部品の実行に失敗しますので，使用しないでください。

　・1バックアップポリシーに複数クライアントを定義したバックアップ

　・Disk Stagingを使った場合の二次バックアップ

(3)次の機能を使用した場合に，JP1/VERITAS NetBackupのジョブが複数実行されます。すべてのジョブが正常の場合だけ部品が正常終了となり，それ以外は，異常終了となります。

　・マルチデータストリームを使ったバックアップ

　・マルチコピーを使ったバックアップ

　・カタログバックアップ

実行権限

Windowsの場合：Administrator権限

UNIXの場合：root権限

バージョン

02.00.00

部品のタグ

Control JP1,VERITAS,Windows,Linux,AIX

タスクログに表示される部品の名称

jp1veritasBackup

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1VERITAS.jp1nbuPolicyName

バックアップポリシー名

JP1/VERITAS NetBackupに登録されているバックアップポリシー名を指定します。

−　

入力

○　

JP1VERITAS.jp1nbuScheduleName

スケジュール名

指定したバックアップポリシー内で定義されているスケジュール名を指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.12.11　仮想マシンリストア実行

機能

この部品は，JP1/VERITAS NetBackupと連携し，vSphere環境の仮想マシンを指定したESXサーバ上にリストアします。

この部品が前提とするサーバを以下に示します。

・実行対象サーバ

　JP1/VERITAS NetBackup(マスターサーバ)が動作するサーバです。本製品によってこのサーバに部品が転送され，実行されます。

・ESXサーバ

　リストア対象の仮想マシンが稼働する，VMware vSphere ESXiが動作するサーバです。

リストア先のESXサーバに同名の仮想マシンが存在する場合，仮想マシンを上書きします。

バックアップ時と異なるESXサーバーに仮想マシンをリストアする場合や，仮想マシンの表示名やデータストアといった設定を変更する場合には，実行対象サーバ上に名前変更ファイルを配置しておく必要があります。「名前変更ファイルの作成」部品を使用して出力してください。

この部品内のスクリプトでは，次に示すコマンドを実行します。

・nbrestorevm -vmw -C "リストア対象仮想マシン名(JP1VERITAS.restoreVmNameプロパティ)"

　　　　　　　[-R "名前変更ファイルのパス(JP1VERITAS.renameFilePathプロパティ)"]

　　　　　　　[-vmproxy "バックアップサーバ名(JP1VERITAS.recoveryHostプロパティ)"]

　　　　　　　[-vmserver リストア対象のvCenterサーバ名(JP1VERITAS.restorevCenterServerプロパティ)"]

　　　　　　　-O -vmtm nbd -vmkeephv -w

JP1/VERITAS NetBackupのnbrestorevmコマンドの詳細については，JP1/VERITAS NetBackupマニュアルの同コマンドを参照してください。

利用場面

JP1/VERITAS NetBackupでバックアップされた仮想マシンを復元する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) JP1/VERITAS NetBackup 7.6，7.7

　(2) JP1/VERITAS NetBackup 8.0，8.1，8.2，8.3

　(3) JP1/VERITAS NetBackup 9.0，9.1

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象システム内前提製品の使用条件】

　特になし。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) 名前変更ファイルのパス(JP1VERITAS.renameFilePathプロパティ)には「!」，「%」を含む文字列は指定しないでください。

(3) その他の注意事項については，JP1/VERITAS NetBackupマニュアルの同コマンドの注意事項を参照してください。

実行権限

Administratorsグループに属するユーザーであること。

バージョン

02.01.00

部品のタグ

Control JP1,VERITAS,Windows

タスクログに表示される部品の名称

jp1veritasRestoreVm

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1VERITAS.restoreVmName

リストア対象仮想マシン名

リストア対象の仮想マシン名を指定します。バックアップポリシーの「プライマリVM識別子(Primary VM identifier)」で選択された名前の種類と一致する必要があります。

−　

入力

○　

JP1VERITAS.restorevCenterServer

リストア対象のvCenterサーバ名

リストア対象のvCenterサーバ名を指定します。バックアップ元と異なるvCenterサーバにリストアする場合は指定してください。

−　

入力

△　

JP1VERITAS.recoveryHost

バックアップサーバ名

リストアを実行するバックアップサーバー名を指定します。バックアップ実行時と異なるバックアップサーバーを使用する場合は指定してください。

−　

入力

△　

JP1VERITAS.renameFilePathOption

名前変更ファイルのパス

名前変更ファイルのパスを絶対パスで指定します。仮想マシンの場所や設定を変更する場合は指定してください。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.12.12　名前変更ファイルの作成

機能

この部品は，JP1/VERITAS NetBackupと連携し，vSphere環境の仮想マシンをリストアする場合に使用する名前変更ファイルを作成します。この部品で作成した名前変更ファイルのパスを，「仮想マシンリストア実行」部品のJP1VERITAS.renameFilePathプロパティに指定します。

この部品が前提とするサーバを以下に示します。

・実行対象サーバ

　JP1/VERITAS NetBackup(マスターサーバ)が動作するサーバです。このサーバーの指定したパスに名前変更ファイルを出力します。

この部品内のスクリプトでは，指定されたパスに以下の内容の名前変更ファイルを出力します。

[change vmname to 仮想マシン表示名(JP1VERITAS.newDisplayNameプロパティ)]

[change esxhost to リストア先ESXサーバ(JP1VERITAS.newEsxHostプロパティ)]

[change datacenter to リストア先データセンタ(JP1VERITAS.newDatacenterプロパティ)]

[change folder to リストア先フォルダ(JP1VERITAS.newFolderプロパティ)]

[change resourcepool to リストア先リソースプール(JP1VERITAS.newResourcePoolプロパティ)]

[change datastore to リストア先データストア(JP1VERITAS.newVmxDatastoreプロパティ)]

[change 変更前vmdkファイルのパス1(JP1VERITAS.originalVmdkPath1プロパティ) to リストア先vmdkファイルのパス1(JP1VERITAS.newVmdkPath1プロパティ)]

[change 変更前vmdkファイルのパス2(JP1VERITAS.originalVmdkPath2プロパティ) to リストア先vmdkファイルのパス2(JP1VERITAS.newVmdkPath2プロパティ)]

[change 変更前vmdkファイルのパス3(JP1VERITAS.originalVmdkPath3プロパティ) to リストア先vmdkファイルのパス3(JP1VERITAS.newVmdkPath3プロパティ)]

[change 変更前vmdkファイルのパス4(JP1VERITAS.originalVmdkPath4プロパティ) to リストア先vmdkファイルのパス4(JP1VERITAS.newVmdkPath4プロパティ)]

[change 変更前vmdkファイルのパス5(JP1VERITAS.originalVmdkPath5プロパティ) to リストア先vmdkファイルのパス5(JP1VERITAS.newVmdkPath5プロパティ)]

[change 変更前vmdkファイルのパス6(JP1VERITAS.originalVmdkPath6プロパティ) to リストア先vmdkファイルのパス6(JP1VERITAS.newVmdkPath6プロパティ)]

[change 変更前vmdkファイルのパス7(JP1VERITAS.originalVmdkPath7プロパティ) to リストア先vmdkファイルのパス7(JP1VERITAS.newVmdkPath7プロパティ)]

[change 変更前vmdkファイルのパス8(JP1VERITAS.originalVmdkPath8プロパティ) to リストア先vmdkファイルのパス8(JP1VERITAS.newVmdkPath8プロパティ)]

[change 変更前vmdkファイルのパス9(JP1VERITAS.originalVmdkPath9プロパティ) to リストア先vmdkファイルのパス9(JP1VERITAS.newVmdkPath9プロパティ)]

[change 変更前vmdkファイルのパス10(JP1VERITAS.originalVmdkPath10プロパティ) to リストア先vmdkファイルのパス10(JP1VERITAS.newVmdkPath10プロパティ)]

[change network ネットワーク名(JP1VERITAS.newNetworkプロパティ)]

名前変更ファイルの詳細については，JP1/VERITAS NetBackupマニュアルのnbrestorevmコマンドを参照してください。

利用場面

JP1/VERITAS NetBackupでバックアップされた仮想マシンを復元する場合に「仮想マシンリストア実行」部品と組み合わせて使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1) JP1/VERITAS NetBackup 7.6，7.7

　(2) JP1/VERITAS NetBackup 8.0，8.1，8.2，8.3

　(3) JP1/VERITAS NetBackup 9.0，9.1

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象システム内前提製品の使用条件】

　特になし。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) 名前変更ファイルのパス(JP1VERITAS.renameFilePathプロパティ)には「!」，「%」を含む文字列は指定しないでください。

(3)名前変更ファイルのパス(JP1VERITAS.renameFilePathプロパティ)に指定したファイルが既に存在する場合，既存のファイルを上書きします。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(4)作成するファイルのパスに含まれるフォルダが存在しない場合は，そのフォルダを作成します。

実行権限

Administratorsグループに属するユーザーであること。

バージョン

02.01.01

部品のタグ

Control JP1,VERITAS,Windows

タスクログに表示される部品の名称

jp1veritasCreateRenameFile

戻り値

戻り値

説明

0

正常

14

異常(ユーザーミス) ファイルアクセス不可

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

JP1VERITAS.renameFilePath

名前変更ファイルのパス

名前変更ファイルのパスを絶対パスで指定します。

−　

入力

○　

JP1VERITAS.newDisplayName

仮想マシン表示名

リストアする仮想マシンの表示名を指定します。省略した場合は元の表示名が使用されます。

−　

入力

△　

JP1VERITAS.newEsxHost

リストア先ESXサーバ

リストア先のESXサーバを指定します。バックアップ元と異なるESXサーバにリストアする場合は指定してください。

−　

入力

△　

JP1VERITAS.newDatacenter

リストア先データセンタ

リストア先のデータセンタを指定します。次の形式で指定してください「/データセンタ名」。リストア先にデータセンタが無い場合はNoneを指定してください。

−　

入力

△　

JP1VERITAS.newFolder

リストア先フォルダ

リストア先のフォルダを指定します。次の形式で指定してください「/データセンタ名/フォルダ名」。リストア先にフォルダが無い場合はNoneを指定してください。

−　

入力

△　

JP1VERITAS.newResourcePool

リストア先リソースプール

リストア先のリソースプールを指定します。次の形式で指定してください「/データセンタ名/host/ESXサーバ名/resources/リソースプール名」

−　

入力

△　

JP1VERITAS.newVmxDatastore

リストア先データストア

リストア先のデータストアを指定します。

−　

入力

△　

JP1VERITAS.originalVmdkPath1

変更前vmdkファイルのパス1

vmdkファイルの変更前のパスを指定します。異なるデータストアへリストアする場合は指定してください。

−　

入力

△　

JP1VERITAS.newVmdkPath1

リストア先vmdkファイルのパス1

リストア先のvmdkファイルのパスを指定します。異なるデータストアへリストアする場合は指定してください。

−　

入力

△　

JP1VERITAS.originalVmdkPath2

変更前vmdkファイルのパス2

vmdkファイルの変更前のパスを指定します。異なるデータストアへリストアする場合は指定してください。

−　

入力

△　

JP1VERITAS.newVmdkPath2

リストア先vmdkファイルのパス2

リストア先のvmdkファイルのパスを指定します。異なるデータストアへリストアする場合は指定してください。

−　

入力

△　

JP1VERITAS.originalVmdkPath3

変更前vmdkファイルのパス3

vmdkファイルの変更前のパスを指定します。異なるデータストアへリストアする場合は指定してください。

−　

入力

△　

JP1VERITAS.newVmdkPath3

リストア先vmdkファイルのパス3

リストア先のvmdkファイルのパスを指定します。異なるデータストアへリストアする場合は指定してください。

−　

入力

△　

JP1VERITAS.originalVmdkPath4

変更前vmdkファイルのパス4

vmdkファイルの変更前のパスを指定します。異なるデータストアへリストアする場合は指定してください。

−　

入力

△　

JP1VERITAS.newVmdkPath4

リストア先vmdkファイルのパス4

リストア先のvmdkファイルのパスを指定します。異なるデータストアへリストアする場合は指定してください。

−　

入力

△　

JP1VERITAS.originalVmdkPath5

変更前vmdkファイルのパス5

vmdkファイルの変更前のパスを指定します。異なるデータストアへリストアする場合は指定してください。

−　

入力

△　

JP1VERITAS.newVmdkPath5

リストア先vmdkファイルのパス5

リストア先のvmdkファイルのパスを指定します。異なるデータストアへリストアする場合は指定してください。

−　

入力

△　

JP1VERITAS.originalVmdkPath6

変更前vmdkファイルのパス6

vmdkファイルの変更前のパスを指定します。異なるデータストアへリストアする場合は指定してください。

−　

入力

△　

JP1VERITAS.newVmdkPath6

リストア先vmdkファイルのパス6

リストア先のvmdkファイルのパスを指定します。異なるデータストアへリストアする場合は指定してください。

−　

入力

△　

JP1VERITAS.originalVmdkPath7

変更前vmdkファイルのパス7

vmdkファイルの変更前のパスを指定します。異なるデータストアへリストアする場合は指定してください。

−　

入力

△　

JP1VERITAS.newVmdkPath7

リストア先vmdkファイルのパス7

リストア先のvmdkファイルのパスを指定します。異なるデータストアへリストアする場合は指定してください。

−　

入力

△　

JP1VERITAS.originalVmdkPath8

変更前vmdkファイルのパス8

vmdkファイルの変更前のパスを指定します。異なるデータストアへリストアする場合は指定してください。

−　

入力

△　

JP1VERITAS.newVmdkPath8

リストア先vmdkファイルのパス8

リストア先のvmdkファイルのパスを指定します。異なるデータストアへリストアする場合は指定してください。

−　

入力

△　

JP1VERITAS.originalVmdkPath9

変更前vmdkファイルのパス9

vmdkファイルの変更前のパスを指定します。異なるデータストアへリストアする場合は指定してください。

−　

入力

△　

JP1VERITAS.newVmdkPath9

リストア先vmdkファイルのパス9

リストア先のvmdkファイルのパスを指定します。異なるデータストアへリストアする場合は指定してください。

−　

入力

△　

JP1VERITAS.originalVmdkPath10

変更前vmdkファイルのパス10

vmdkファイルの変更前のパスを指定します。異なるデータストアへリストアする場合は指定してください。

−　

入力

△　

JP1VERITAS.newVmdkPath10

リストア先vmdkファイルのパス10

リストア先のvmdkファイルのパスを指定します。異なるデータストアへリストアする場合は指定してください。

−　

入力

△　

JP1VERITAS.newNetwork

ネットワーク名

リストアする仮想マシンの新しいネットワーク名を指定します。複数のネットワークを指定する場合は，コンマ(,)で区切って列挙してください。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13　OS関連の部品

4.13.1　CSV・Excelのセルデータ更新

機能

この部品は，CSV(Comma Separated Values)ファイルまたはMicrosoft社のExcelで作成したExcelシートのセルを，指定した入力データで更新します。Windows環境の場合はCSVファイルまたはExcelファイルの，UNIX環境の場合はCSVファイルの，データを更新します。

更新したデータは，セルの表示形式に従って表示されます。

入力データはタスクログに出力するため，パスワードなどの機密情報は指定しないでください。

次の条件を満たすファイルに対して，セルの更新をサポートします。

・Windows環境の場合，Microsoft Excelで編集可能なファイルであること。

・CSVファイルの場合，拡張子が"csv"のテキストファイルであること。

・UNIX環境の場合，ユーザーの環境変数[LANG]で指定している文字コードで記述され，改行コードがLFであること。

・UNIX環境の場合，CSVファイルのファイル名は，パス名部分を含まない長さが225バイト以内で指定してください。

・Excelファイルの場合，拡張子が"xls"のファイル(「Excel 97〜2003ブック」として保存されたExcelフォーマット)，または"xlsx"，"xlsm"(Excel 2007以降のExcelブック，Excelマクロ有効ブック)のファイルであること。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。Windows環境の場合，前提条件に記載のMicrosoft Excelがインストールされている必要があります。

この部品内のスクリプトでは次に示す処理を行います。

・ファイル名(common.fileNameプロパティ)に指定されたファイル内の，セルのリスト(excel.cellListプロパティ)に指定されたセルを，入力データ(excel.inputValue1〜50プロパティ)に指定されたデータで更新します。

入力データに指定できる文字数の合計は5120文字までです。

UNIX環境の場合，入力データで更新したあとの一行の長さが127Kバイトを超えないようにしてください。

UNIX環境の場合，存在する行や列に対して更新します。存在しない行や列を更新しようとするとエラーになります。

指定されたCSVファイルまたはExcelファイルが存在しない場合でも，この部品ではファイルは作成しません。

Windows環境の場合，ビルトインAdministratorが既に対象ファイルを開いている場合，この部品は異常終了します。

32bit版のMicrosoft Excelを使用する時は，次に示すフォルダが存在しない場合にフォルダを作成します。

　%SystemRoot%¥SysWOW64¥config¥systemprofile¥Desktop

64bit版のMicrosoft Excelを使用する時は，次に示すフォルダを事前に作成しておく必要があります。

　%SystemRoot%¥System32¥config¥systemprofile¥Desktop

上記の%SystemRoot%は環境変数「SystemRoot」と同一のフォルダを指します。

UNIX環境の場合，指定したCSVファイル名に「-tmp-yyyymmdd_hhmmss-pid」(yyyymmdd_hhmmssは実行日時，pidは部品のPID)を付加した名称の一時ファイルを作成します。同じ名称のファイルが存在すると上書きするため，指定したCSVファイル名と同じ名称で始まるファイルは作成しないでください。例えば，CSVファイルに「/tmp/data.csv」というファイルを指定した場合は，「/tmp/data.csv-tmp-yyyymmdd_hhmmss-pid」(yyyymmdd_hhmmssは実行日時，pidは部品のPID)という一時ファイルが作成されます。なお，この一時ファイルは，部品が終了した際には削除されます。

UNIX環境の場合，CSVファイルが存在するディレクトリに，CSVファイルのサイズ以上の空き容量が必要です。

UNIX環境の場合，部品の実行ユーザーがCSVファイルの所有者ユーザー以外の一般ユーザーの場合，部品を実行したあとのCSVファイルの所有者とグループが実行ユーザーの情報に変更されます。

利用場面

事前に実行したサービスの実行結果や出力情報をCSV/Excelファイルに書き込む場合に利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象サーバ内前提製品】

　Windows環境の場合

　(1) Microsoft Excel 2007

　(2) Microsoft Excel 2010

　(3) Microsoft Excel 2013

　(4) Microsoft Excel 2016

　(5) Microsoft Excel 2019

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) CentOS 6 (64-bit x86_64)

　(9) CentOS 7 (64-bit x86_64)

　(10) CentOS 8 (64-bit x86_64)

　(11) Oracle Linux 8 (64-bit x86_64)

【実行対象サーバの使用条件】

　なし。

注意事項

・Windows環境の場合の注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)この部品では読み取りパスワード，書き込みパスワードを設定したExcelファイルを使用できません。

(3)この部品を同一ファイルに対して同時に実行しないでください。

(4)連結したセルに対して入力する場合，セルのリスト(excel.cellListプロパティ)には左上に位置するセルだけ指定してください。それ以外のセルを指定した場合，部品は正常終了しますが，データは入力されません。

(5)この部品が異常終了してタスクログに「80080005 サーバーの実行に失敗しました」と出力された場合，実行対象サーバ上でExcelファイルを開いている可能性があります。Excelファイルの状態を確認してください。このとき，「OfficeC2RClient.exe」というプロセスが起動する場合があります。このプロセスを終了させる場合はタスクマネージャーなどで操作してください。

(6)部品が異常終了した場合，ファイルは更新されませんので，途中まで入力済みのデータも保存されません。

・UNIX環境の場合の注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)LC_ALLやLC_MESSAGESなどLANGより上位のロケール環境変数が設定されている時，上位のロケール環境変数が優先されてしまうため部品を実行する際に，LC_ALLやLC_MESSAGESなどの上位のロケール環境変数を解除するか，LANG環境変数と同一の値に変更してください。

(3)この部品を同一ファイルに対して同時に実行しないでください。

(4)部品が異常終了した場合，ファイルは更新されませんので，途中まで入力済みのデータも保存されません。

(5)CSVファイルのセルのデータには「,」(コンマ)および改行文字は使用できません。使用した場合，列を正しく区切ることができません。

実行権限

Windows環境の場合，Administrator権限

UNIX環境の場合，rootユーザーまたはCSVファイルの所有者ユーザーで，CSVファイルの読み込み権限とCSVファイルの親ディレクトリの書き込み権限が必要

バージョン

02.51.00

部品のタグ

Control OS,File Operations,Windows,Linux

タスクログに表示される部品の名称

osUpdateCSVExcelFileCell

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.fileName

ファイル名

更新対象となるCSVまたはExcelファイルをフルパスで指定します。

−　

入力

○　

common.sheetName

EXCELファイルのシート名

EXCELファイルのシート名を指定します。CSVファイルの場合は，指定不要です。

Sheet1

入力

△　

excel.cellList

セルのリスト

Windows環境の場合，データを入力するセルの位置を，A1形式のセル参照文字列またはセルの名前で指定します。複数指定する場合は，コンマ区切りで50件まで指定できます。UNIX環境の場合，データを入力するセルの位置を「行番号;列番号」の形式で指定します。複数指定する場合は，コンマ区切りで50件まで指定できます。

−　

入力

○　

excel.inputValue1

入力データ1

excel.cellListに指定した1番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue2

入力データ2

excel.cellListに指定した2番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue3

入力データ3

excel.cellListに指定した3番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue4

入力データ4

excel.cellListに指定した4番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue5

入力データ5

excel.cellListに指定した5番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue6

入力データ6

excel.cellListに指定した6番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue7

入力データ7

excel.cellListに指定した7番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue8

入力データ8

excel.cellListに指定した8番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue9

入力データ9

excel.cellListに指定した9番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue10

入力データ10

excel.cellListに指定した10番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue11

入力データ11

excel.cellListに指定した11番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue12

入力データ12

excel.cellListに指定した12番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue13

入力データ13

excel.cellListに指定した13番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue14

入力データ14

excel.cellListに指定した14番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue15

入力データ15

excel.cellListに指定した15番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue16

入力データ16

excel.cellListに指定した16番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue17

入力データ17

excel.cellListに指定した17番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue18

入力データ18

excel.cellListに指定した18番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue19

入力データ19

excel.cellListに指定した19番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue20

入力データ20

excel.cellListに指定した20番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue21

入力データ21

excel.cellListに指定した21番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue22

入力データ22

excel.cellListに指定した22番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue23

入力データ23

excel.cellListに指定した23番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue24

入力データ24

excel.cellListに指定した24番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue25

入力データ25

excel.cellListに指定した25番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue26

入力データ26

excel.cellListに指定した26番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue27

入力データ27

excel.cellListに指定した27番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue28

入力データ28

excel.cellListに指定した28番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue29

入力データ29

excel.cellListに指定した29番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue30

入力データ30

excel.cellListに指定した30番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue31

入力データ31

excel.cellListに指定した31番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue32

入力データ32

excel.cellListに指定した32番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue33

入力データ33

excel.cellListに指定した33番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue34

入力データ34

excel.cellListに指定した34番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue35

入力データ35

excel.cellListに指定した35番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue36

入力データ36

excel.cellListに指定した36番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue37

入力データ37

excel.cellListに指定した37番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue38

入力データ38

excel.cellListに指定した38番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue39

入力データ39

excel.cellListに指定した39番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue40

入力データ40

excel.cellListに指定した40番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue41

入力データ41

excel.cellListに指定した41番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue42

入力データ42

excel.cellListに指定した42番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue43

入力データ43

excel.cellListに指定した43番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue44

入力データ44

excel.cellListに指定した44番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue45

入力データ45

excel.cellListに指定した45番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue46

入力データ46

excel.cellListに指定した46番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue47

入力データ47

excel.cellListに指定した47番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue48

入力データ48

excel.cellListに指定した48番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue49

入力データ49

excel.cellListに指定した49番目のセルに入力するデータを指定します。

−　

入力

△　

excel.inputValue50

入力データ50

excel.cellListに指定した50番目のセルに入力するデータを指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.2　CSV・Excelのセルデータ取得

機能

この部品は，CSV(Comma Separated Values)ファイルまたは，Microsoft社のExcelで作成したExcelシートから指定したセルのデータを取得し出力プロパティに設定します。Windows環境の場合はCSVファイルまたはExcelファイルから，UNIX環境の場合はCSVファイルから，データを取得します。

出力プロパティに設定する際，セルのデータをタスクログに出力します。ただし，ログ出力レベルの設定がデフォルト(10)，かつタスクが正常終了する場合は出力されません。

次を満たすファイルのデータの取得をサポートします。

・Windows環境の場合，Microsoft Excelで編集可能なファイルであること。

・CSVファイルの場合，拡張子が"csv"のテキストファイルであること。

・UNIX環境の場合，ユーザーの環境変数[LANG]で指定している文字コードで記述され，改行コードがLFであること。

・Excelファイルの場合，拡張子が"xls"のファイル(「Excel 97〜2003ブック」として保存されたExcelフォーマット)，または"xlsx"，"xlsm"(Excel 2007以降のExcelブック，Excelマクロ有効ブック)のファイルであること。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。Windows環境の場合，前提条件に記載のMicrosoft Excelがインストールされている必要があります。

この部品内のスクリプトでは次に示す処理を行います。

・ファイル名(common.fileNameプロパティ)に指定された入力ファイルから，セルのリスト(excel.cellListプロパティ)に指定されたセルのデータを出力プロパティ(excel.OutputValue1〜50プロパティ)に出力します。

32bit版のMicrosoft Excelを使用する時は，次に示すフォルダが存在しない場合にフォルダを作成します。

　%SystemRoot%¥SysWOW64¥config¥systemprofile¥Desktop

64bit版のMicrosoft Excelを使用する時は，次に示すフォルダを事前に作成しておく必要があります。

　%SystemRoot%¥System32¥config¥systemprofile¥Desktop

上記の%SystemRoot%は環境変数「SystemRoot」と同一のフォルダを指します。

UNIX環境の場合，取得したセルのデータには次のチェックを行います。条件に当てはまると，部品は異常終了します。

　(a)セルのデータの文字列長が1024バイトより大きい

利用場面

管理情報を記載したCSV/Excelファイルからデータを取得し，サービスの入力値として利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象サーバ内前提製品】

Windows環境の場合

　(1) Microsoft Excel 2007

　(2) Microsoft Excel 2010

　(3) Microsoft Excel 2013

　(4) Microsoft Excel 2016

　(5) Microsoft Excel 2019

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) CentOS 6 (64-bit x86_64)

　(9) CentOS 7 (64-bit x86_64)

　(10) CentOS 8 (64-bit x86_64)

　(11) Oracle Linux 8 (64-bit x86_64)

【実行対象サーバの使用条件】

　なし。

注意事項

・Windows環境の場合の注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)この部品では読み取りパスワード，書き込みパスワードを設定したExcelファイルを使用できません。

(3)この部品では基本的にExcelのセルに表示された形式で文字列を取得できますが，次の内容に注意してください。

・OSやExcelのバージョンによっては，セルに表示される形式と異なる形式でデータが取得されることがあります。

　(例)Windows Server 2008 R2やWindows Server 2012 R2環境のExcel 2007の場合，形式が"yyyy/mm/dd"であっても，"2017/04/01"ではなく"2017/4/1"として取得されます。

・この部品で取得するセルのデータ長はWindows PowerShellで取得可能な最大文字数までです。

　(例)Windows Server 2008 R2やWindows Server 2012 R2環境のExcel 2007の場合，最大文字数は8221文字です。

(4)この部品が異常終了してタスクログに「80080005 サーバーの実行に失敗しました」と出力された場合，実行対象サーバ上でExcelファイルを開いている可能性があります。Excelファイルの状態を確認してください。このとき，「OfficeC2RClient.exe」というプロセスが起動する場合があります。このプロセスを終了させる場合はタスクマネージャーなどで操作してください。

・UNIX環境の場合の注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)CSVファイルのセルのデータには「,」(コンマ)および改行文字は使用できません。使用した場合，列を正しく区切ることができません。

(3)LC_ALLやLC_MESSAGESなどLANGより上位のロケール環境変数が設定されている時，上位のロケール環境変数が優先されてしまうため部品を実行する際に，LC_ALLやLC_MESSAGESなどの上位のロケール環境変数を解除するか，LANG環境変数と同一の値に変更してください。

実行権限

Windows環境の場合，Administrator権限

UNIX環境の場合，CSVファイルの読み込み権限

バージョン

02.51.00

部品のタグ

File Operations,Gather OS information,Windows,Linux

タスクログに表示される部品の名称

osReadCSVExcelFileCell

戻り値

戻り値

説明

0

正常

11

異常(ユーザーミス) 定義ファイル内容の不正

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.fileName

ファイル名

データ取得対象のCSVまたはExcelファイルをフルパスで指定します。

−　

入力

○　

common.sheetName

EXCELファイルのシート名

EXCELファイルのシート名を指定します。CSVファイルの場合は，指定不要です。

Sheet1

入力

△　

excel.cellList

セルのリスト

Windows環境の場合，データを取得するセルの位置を，A1形式のセル参照文字列またはセルの名前で指定します。複数指定する場合は，コンマ区切りで50件まで指定できます。UNIX環境の場合，データを取得するセルの位置を「行番号;列番号」の形式で指定します。複数指定する場合は，コンマ区切りで50件まで指定できます。

−　

入力

○　

excel.OutputValue1

データ1

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue2

データ2

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue3

データ3

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue4

データ4

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue5

データ5

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue6

データ6

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue7

データ7

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue8

データ8

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue9

データ9

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue10

データ10

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue11

データ11

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue12

データ12

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue13

データ13

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue14

データ14

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue15

データ15

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue16

データ16

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue17

データ17

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue18

データ18

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue19

データ19

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue20

データ20

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue21

データ21

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue22

データ22

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue23

データ23

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue24

データ24

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue25

データ25

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue26

データ26

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue27

データ27

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue28

データ28

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue29

データ29

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue30

データ30

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue31

データ31

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue32

データ32

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue33

データ33

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue34

データ34

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue35

データ35

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue36

データ36

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue37

データ37

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue38

データ38

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue39

データ39

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue40

データ40

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue41

データ41

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue42

データ42

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue43

データ43

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue44

データ44

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue45

データ45

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue46

データ46

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue47

データ47

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue48

データ48

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue49

データ49

取得したデータが格納されます。

−　

出力

△　

excel.OutputValue50

データ50

取得したデータが格納されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.3　CSV・Excelのデータ分割

機能

この部品は，CSV(Comma Separated Values)ファイルまたは，Microsoft社のExcelで作成したExcelシートを，指定した行数のファイルに分割します。Windows環境の場合はCSVファイルまたはExcelファイルを，UNIX環境の場合はCSVファイルを分割します。

また，列のフィルタ条件を指定することで，条件に一致する行だけを分割後のファイルへ出力することができます。

次の条件を満たすファイルの分割をサポートします。

・Windows環境の場合，Microsoft Excelで編集可能なファイルであること。

・1行目に必ず列名が記載されていること。分割後のそれぞれのファイルには1行目を列名としてコピーします。

・CSVファイルの場合，拡張子が"csv"のテキストファイルであること。

・Excelファイルの場合，拡張子が"xls"のファイル(「Excel 97〜2003ブック」として保存されたExcelフォーマット)，または"xlsx"，"xlsm"(Excel 2007以降のExcelブック，Excelマクロ有効ブック)のファイルであること。

・UNIX環境の場合，ユーザーの環境変数[LANG]で指定している文字コードで記述され，改行コードがLFであること。

・UNIX環境の内，Red Hat Enterprise Linux Server 6，CentOS 6の場合，分割後のファイル数が100以下であること。100を超える場合，部品は異常終了します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。Windows環境の場合，前提条件に記載のMicrosoft Excelがインストールされている必要があります。

Windows環境の場合，この部品内のスクリプトでは次に示す処理を行います。

(1)ファイル名(common.fileNameプロパティ)に指定された入力ファイルから一時ファイル(通番0)※へコピーします。

(2)フィルタ処理する列のリスト(excel.filterColumnListプロパティ)が指定されている場合，一時ファイル(通番0)※から，列データのフィルタ条件(excel.filterColumnString1〜10プロパティ)に一致しない行を削除します。複数の条件が指定されている場合，すべての条件に一致する行だけ抽出し，それ以外の行を削除します。

(3)一時ファイル(通番0)※から分割後のファイル(通番1以降)※へ，分割する行数(common.divideLineCountプロパティ)に指定された行数ずつコピーします。また，一時ファイル(通番0)※の1行目を列名として，分割後のファイル(通番1以降)※の1行目へコピーします。Excelファイルを分割する場合，分割後のファイルのシート名は「Sheet1」になります。

UNIX環境の場合，この部品内のスクリプトでは次に示す処理を行います。

(1)分割後のファイルと同じ命名規則のファイル(※(a)(b)(c)が一致するファイル)を削除します。

(2)ファイル名(common.fileNameプロパティ)に指定された入力ファイルをコピーし，ファイル出力先フォルダパス(common.outputFolderPathプロパティ)に一時ファイル(通番0)※を生成します。

(3)フィルタ処理する列のリスト(excel.filterColumnListプロパティ)が指定されている場合，一時ファイル(通番0)※から，列データのフィルタ条件(excel.filterColumnString1〜10プロパティ)に一致しない行を削除します。複数の条件が指定されている場合，すべての条件に一致する行だけ抽出し，それ以外の行を削除します。

(4)一時ファイル(通番0)※から分割後のファイル(通番00以降)※へ，分割する行数(common.divideLineCountプロパティ)に指定された行数ずつコピーします。また，一時ファイル(通番0)※の1行目を列名として，分割後のファイル(通番00以降)※の1行目へコピーします。

※一時ファイル，および，分割後のファイルは下記を連結した名称になります。

　・(a)ファイル出力先フォルダパス(common.outputFolderPathプロパティ)の値 (例：C:¥temp)

　・(b)フォルダの区切り文字「¥」，または「/」

　・(c)ファイルの接頭辞(common.filePrefixプロパティ)の値 (例：result)

　・(d)繰り返し実行部品用の文字列(分割後のファイル名の通番)(common.loopInputPropertiesプロパティ)の各数字 (例：0，1)

　・(e)ファイルの拡張子(common.fileExtensionプロパティ)の値 (例：.csv)

　上記の例の場合，分割後の名称は「C:¥temp¥result0.csv」「C:¥temp¥result1.csv」になります。

ファイル出力先フォルダパス(common.outputFolderPathプロパティ)に指定したフォルダが存在しない場合はフォルダを作成し，その配下に分割後のファイルを出力します。なお，分割後のファイルと同名のファイルが既に存在する場合は上書きします。

また，32bit版のMicrosoft Excelを使用する時は，次に示すフォルダが存在しない場合にフォルダを作成します。

　%SystemRoot%¥SysWOW64¥config¥systemprofile¥Desktop

64bit版のMicrosoft Excelを使用する時は，次に示すフォルダを事前に作成しておく必要があります。

　%SystemRoot%¥System32¥config¥systemprofile¥Desktop

上記の%SystemRoot%は環境変数「SystemRoot」と同一のフォルダを指します。

UNIX環境の場合，この部品による分割後のファイルの属性は，分割対象のファイルの属性に依存しません。

・ローカル実行機能が無効の場合

　分割後のファイルの属性は部品の実行ユーザー，およびumaskに基づいて設定されます。umaskを変更する場合は実行ユーザーの「.bashrc」で設定してください。

・ローカル実行機能が有効の場合

　実行ユーザーはrootユーザーになり，umaskは0066で固定となります。

利用場面

繰り返し実行部品を使用してCSV/Excelファイルの各行に入力された値を処理する際に，この部品を使ってCSV/Excelファイルを分割することで，繰り返し実行部品の繰り返し上限を超える行数を処理することができます。

また，任意の列のフィルタ条件を指定することによって，特定の条件に一致した行だけを抽出して処理することができます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象サーバ内前提製品】

Windows環境の場合

　(1) Microsoft Excel 2007

　(2) Microsoft Excel 2010

　(3) Microsoft Excel 2013

　(4) Microsoft Excel 2016

　(5) Microsoft Excel 2019

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) CentOS 6 (64-bit x86_64)

　(9) CentOS 7 (64-bit x86_64)

　(10) CentOS 8 (64-bit x86_64)

　(11) Oracle Linux 8 (64-bit x86_64)

【実行対象サーバの使用条件】

　なし。

注意事項

・Windows環境の場合の注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)ファイル名(common.fileNameプロパティ)に257以上の列数があるファイルを指定した場合，この部品が異常終了します。

(3)分割する行数(common.divideLineCountプロパティ)には65535以内の整数値を指定してください。65536以上の値を指定した場合，この部品が異常終了します。

(4)フィルタ条件に一致する行が存在しないなどの理由によって分割後のファイルが作成されなかった場合，繰り返し実行部品用の文字列(分割後のファイル名の通番)(common.loopInputPropertiesプロパティ)は空白になります。そのため，このプロパティをそのまま繰り返し実行部品に渡した場合，繰り返し実行部品が異常終了します。

(5)この部品ではフィルタ処理する列の番号には，最初に列名またはデータが記述されている列より左側の空列も含めますが，CSV・Excelの列データ取得部品およびCSV・Excelの行データ取得部品では含めません。そのため，CSV・Excelの列データ取得部品およびCSV・Excelの行データ取得部品と組み合わせて使用する場合は，ご注意ください。

(6)この部品が異常終了してタスクログに「80080005 サーバーの実行に失敗しました」と出力された場合，実行対象サーバ上でExcelファイルを開いている可能性があります。Excelファイルの状態を確認してください。このとき，「OfficeC2RClient.exe」というプロセスが起動する場合があります。このプロセスを終了させる場合はタスクマネージャーなどで操作してください。

(7)一時ファイル，または，分割後のファイル名が同一となる場合，この部品を同時に実行しないでください。

(8)ファイルの接頭辞(common.filePrefixプロパティ)には次の文字を使用できません。

「<」「>」「?」「[」「]」「:」「|」「*」

・UNIX環境の場合の注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) CSVファイルのセルのデータには「,」および改行文字は使用できません。使用した場合，列を正しく区切ることができません。

(3) CSVファイルの行の先頭または末尾に存在する半角スペースおよびタブ記号は，存在するものとみなします。CSV・Excelの行データ取得部品では存在しないものとみなします。そのため，CSV・Excelの行データ取得部品と組み合わせて使用する場合は，ご注意ください。

(4)フィルタ条件に一致する行が存在しないなどの理由によって分割後のファイルが作成されなかった場合，繰り返し実行部品用の文字列(分割後のファイル名の通番)(common.loopInputPropertiesプロパティ)は空白になります。そのため，このプロパティをそのまま繰り返し実行部品に渡した場合，繰り返し実行部品が異常終了します。

(5) LC_ALLやLC_MESSAGESなどLANGより上位のロケール環境変数が設定されている時，上位のロケール環境変数が優先されてしまうため部品を実行する際に，LC_ALLやLC_MESSAGESなどの上位のロケール環境変数を解除するか，LANG環境変数と同一の値に変更してください。

(6)一時ファイル，または，分割後のファイル名が同一となる場合，この部品を同時に実行しないでください。

(7)ファイルの接頭辞(common.filePrefixプロパティ)の先頭には次の文字を使用できません。

「-」「.」

実行権限

Windows環境の場合，Administrator権限

UNIX環境の場合，CSVファイルの読み込み権限，および出力先ディレクトリの書き込み権限が必要。なお，出力先ディレクトリが存在しない場合は，出力先ディレクトリの親ディレクトリの書き込み権限が必要。

バージョン

02.51.00

部品のタグ

Control OS,File Operations,Windows,Linux

タスクログに表示される部品の名称

osDivideCSVExcelFile

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.fileName

ファイル名

分割対象のCSVまたはExcelファイルをフルパスで指定します。

−　

入力

○　

common.sheetName

EXCELファイルのシート名

EXCELファイルのシート名を指定します。CSVファイルの場合は，指定不要です。

Sheet1

入力

△　

common.outputFolderPath

ファイル出力先フォルダパス

分割後のファイルを出力するフォルダをフルパスで指定します。

−　

入力

○　

common.filePrefix

ファイルの接頭辞

分割後のファイルの接頭辞を指定します。

−　

入力

○　

common.divideLineCount

分割する行数

分割後のファイルの行数(ヘッダを除く)を半角数字で指定します。

−　

入力

○　

excel.isNumericHeader

ヘッダの指定種別

フィルタ処理する列を番号で指定する場合，TRUEを指定します。列名(文字列)で指定する場合，FALSEを指定します。

True

入力

△　

excel.filterColumnList

フィルタ処理する列のリスト

Windows環境の場合，フィルタ処理する列の番号，または列名(文字列)をコンマ区切りで指定します。列の番号(または列名)は10件まで指定できます。UNIX環境の場合，列の番号をコンマ区切りで指定します。列の番号は10件まで指定できます。

−　

入力

△　

excel.filterColumnString1

列データのフィルタ条件1

excel.filterColumnListに指定した1番目の列に適用するフィルタの正規表現を指定します。

−　

入力

△　

excel.filterColumnString2

列データのフィルタ条件2

excel.filterColumnListに指定した2番目の列に適用するフィルタの正規表現を指定します。

−　

入力

△　

excel.filterColumnString3

列データのフィルタ条件3

excel.filterColumnListに指定した3番目の列に適用するフィルタの正規表現を指定します。

−　

入力

△　

excel.filterColumnString4

列データのフィルタ条件4

excel.filterColumnListに指定した4番目の列に適用するフィルタの正規表現を指定します。

−　

入力

△　

excel.filterColumnString5

列データのフィルタ条件5

excel.filterColumnListに指定した5番目の列に適用するフィルタの正規表現を指定します。

−　

入力

△　

excel.filterColumnString6

列データのフィルタ条件6

excel.filterColumnListに指定した6番目の列に適用するフィルタの正規表現を指定します。

−　

入力

△　

excel.filterColumnString7

列データのフィルタ条件7

excel.filterColumnListに指定した7番目の列に適用するフィルタの正規表現を指定します。

−　

入力

△　

excel.filterColumnString8

列データのフィルタ条件8

excel.filterColumnListに指定した8番目の列に適用するフィルタの正規表現を指定します。

−　

入力

△　

excel.filterColumnString9

列データのフィルタ条件9

excel.filterColumnListに指定した9番目の列に適用するフィルタの正規表現を指定します。

−　

入力

△　

excel.filterColumnString10

列データのフィルタ条件10

excel.filterColumnListに指定した10番目の列に適用するフィルタの正規表現を指定します。

−　

入力

△　

common.loopInputProperties

繰り返し実行部品用の文字列(分割後のファイル名の通番)

分割後のファイル名の通番が，1以降のコンマ区切りの数字で格納されます。このプロパティを繰り返し実行部品に渡すことで，分割されたそれぞれのファイルを処理できます。

−　

出力

△　

common.fileExtension

ファイルの拡張子

分割後のファイルの拡張子(先頭に「.」を含む)が格納されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.4　CSV・Excelの行データ取得

機能

この部品は，WindowsまたはUNIX環境で，CSV(Comma Separated Values)ファイルまたは，Microsoft社のExcelで作成したExcelシートから指定した行のデータを取得し出力プロパティに設定します。

Windows環境の場合はCSVファイルまたはExcelファイルから，UNIX環境の場合はCSVファイルから，データを取得します。

次を満たすファイルのデータの取得をサポートします。

【CSVファイルの場合】

・拡張子がcsvのテキストファイルであること。

・ファイルの1行目には半角コンマ区切りで列名が記載されていること。

・列名指定でデータを読み出す場合，ファイルの1行目に必ず列名を指定すること。

・列番号を指定してデータを読み出す場合は，列名を記載する必要はありません。

・ファイルの2行目以降には読み取り対象のデータが半角コンマ(,)で区切られて記載されていること。なお，列名の記載有無に関わらず，データの読み取り開始行は2行目からとなります。

・Windows環境の場合は，文字コードがMS932で記述され，改行コードがCR+LFであること。UNIX環境の場合は，ユーザーの環境変数[LANG]で指定している文字コードで記述され，改行コードがLFであること。

【Excelファイルの場合】

・拡張子がxlsのファイル(「Excel97〜2003ブック」として保存されたExcelフォーマット)，またはxlsx，xlsm(Excel2007以降のExcelブック，Excelマクロ有効ブック)のファイルであること。

・必ず列名が記載されていること。1行目以降で最初に記述がある行が列名となる。

・列名が記載されている行の次の行以降に列名に対応する値が記載されていること。

ファイルの記述例を次に記載します。

【ファイルの記述例】

シート名: ServerInfo (Excelファイルの場合だけ)

1行目: ホスト名， CPUコア数， メモリ， ディスク容量， ライセンスキー

2行目: hostVM001， 2， 2048， 30， key1

3行目: hostVM002， 1， 1024， 10， key2

…

データを取得するシート名，キー情報が記載された列名(または列番号)，取得したい行のキー値，データを取得する列名(または列番号)を指定することで，該当する行の列データを最大90件まで取得できます。

読み込んだフィールドには次のチェックを行います。どれかの条件に当てはまると，部品は異常終了します。

(a)フィールドの文字列長が1024バイトより大きい

(b)フィールドに次の特殊記号を含む

　「<」，「>」，「|」，「;」，「&」，両端以外の「"」および末尾の「¥」

(c)フィールドに制御文字(0x00〜0x1f)を含む

出力情報は，キー値に合致した行の，odbc.ColumnListプロパティに指定した列の値を，文字列としてodbc.OutputValue1〜odbc.OutputValue90プロパティに格納し，指定した列ごとに出力します。どれかの列でフィールドの文字列が1011文字を超えると，部品は異常終了します。

【部品の使用例】

前述の【ファイルの記述例】に記載したファイルから，hostVM002のCPUコア数，ディスク容量を取得する場合の入力プロパティは次のように指定します。

[入力プロパティ例1(odbc.ColumnListプロパティに列名を指定する場合)]

odbc.SheetName：ServerInfo (Excelファイルの場合だけ)

odbc.KeyColumnName：ホスト名

odbc.KeyValue：hostVM002

odbc.ColumnList：CPUコア数，ディスク容量

odbc.ColumnsAreNumeric：FALSE

[入力プロパティ例2(odbc.ColumnListプロパティに列番号を指定する場合)]

odbc.SheetName：ServerInfo (Excelファイルの場合だけ)

odbc.KeyColumnName：1

odbc.KeyValue：hostVM002

odbc.ColumnList：2，4

odbc.ColumnsAreNumeric：TRUE

上記入力プロパティ例1または2のように指定した場合，部品の出力プロパティは次のようになります。

[出力プロパティ]

odbc.ColumnValue1：1

odbc.ColumnValue2：10

odbc.ColumnValue3〜90：値なし。

実行対象サーバのOSがWindowsの場合，この部品の実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。実行対象サーバにAdministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行う部品「CSV・Excelの行データ取得(SYSTEM)」を実行してください。

利用場面

管理情報を記載したCSVファイル，Excelファイルからデータを取得し，サービス内の他の部品の入力プロパティとして利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-10以降

【実行対象サーバ内前提製品】

　(1)データ取得対象にExcel2007以降のExcelブック，Excelマクロ有効ブックを指定する場合，次に示すMicrosoft社のプログラムのインストールが必要です。(Windows環境の場合)

　　・2007 Office system ドライバ，または

　　　Microsoft Access データベース エンジン 2010（32bit版），または

　　　Microsoft Access Database Engine 2016（32bit版）

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) CentOS 6 (64-bit x86_64)

　(9) CentOS 7 (64-bit x86_64)

　(10) CentOS 8 (64-bit x86_64)

　(11) Oracle Linux 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

なし。

注意事項

・Windows環境の場合の注意事項

(1) ODBCドライバの制限によって，ファイル名には「[」，「]」，「!」は使用できません。

(2) Excelファイルのセルが結合されている場合，数式がエラーとなっている場合は取得される値が空になります。また，書き込みパスワードが設定されている場合は，部品は異常終了します。読み取り対象のファイルからはこれらの状態を取り除いてください。

(3) 読み取る列は，文字列型データと数値型データを混在させないでください。混在していると，ODBCドライバの仕様によって，正常に値を取得できない場合があります。

　(a) 数値型データとは次の形式の文字列のことです。

　　符号付き整数値(10進数) 例：-12345

　　固定小数点数(10進数) 　例：3.1415

　　浮動小数点数(10進数) 　例：6.543E+10

　(b) 文字列型データとは上の数値型以外の形式の文字列のことです。

(4) 読み取り対象のファイルから異なるデータ型が混在する列を取得する場合は，次の対処が必要です。

　・Excelファイルの場合は数値型データの先頭に「'」を付けてください。

　・CSVファイルの場合は数値型データを「"」で囲んでください。

(5) 読み取り対象がCSVファイルである場合，IPアドレスは「"」で囲んでください。「"」で囲まない場合，数値型データとして誤認識され，正常に値を取得できないことがあります。

(6) 列名には次に示す内容を指定してください。

　・必ず文字列で指定してください。数値データは指定しないでください。

　・次の文字は列名に使用できません。

　　・キーとなる列名の先頭には次の文字を使用できません。

　　「!」「"」「#」「$」「%」「&」「'」「(」「)」「-」「=」「^」「~」「¥」「|」「`」「;」「+」「*」「[」「]」「{」「}」「,」「.」「<」「>」「?」「_」「/」「0」「1」「2」「3」「4」「5」「6」「7」「8」「9」「０」「１」「２」「３」「４」「５」「６」「７」「８」「９」

　　・キーとなる列名の2文字目以降には次の文字を使用できません。

　　「"」「#」「%」「&」「'」「(」「)」「-」「=」「^」「~」「¥」「|」「@」「;」「:」「+」「*」「[」「]」「{」「}」「,」「.」「<」「>」「?」「/」

　　・キーとなる列名以外の列名には次の文字を使用できません。

　　「!」「[」「]」「`」「,」「.」

　・文字数は半角全角混合で64文字まで指定できます。

(7) 読み取り対象ファイルがExcelファイルの場合，セルに記述されたデータのデータ型によっては，表示されている値と実際に取得される値が異なる場合があります。次のデータ型のデータを記述している場合はご注意ください。

　(a) Boolean型(True/False)

　　表示される値：TRUE/FALSE

　　セルに記述されている値：TRUE/FALSE

　　実際に取得される値：True/False

　(b) 日付データ

　　表示される値：mm月dd日

　　セルに記述されている値：yyyy/mm/dd

　　実際に取得される値：yyyy/mm/dd

　(c) 時刻データ

　　表示される値：hh:mm

　　セルに記述されている値：hh:mm:ss

　　実際に取得される値：hh:mm:ss

　(d) パーセント

　　表示される値：〜%(例：10%)

　　セルに記述されている値：〜%(例：10%)

　　実際に取得される値：0.〜(例：0.1)

　(e) 数式

　　表示される値：(数式の結果)

　　セルに記述されている値：(数式)

　　実際に取得される値：(数式の結果)

(a)(d)(e)のデータをセルに記述されている値のまま取得したい場合は先頭に「'」を付けてください。

なお，読み取り対象ファイルがCSVファイルの場合は記述した値をそのまま取得することができます。

(8) (7)の型のデータを記述する場合，その列の列名を除いたデータが1種類の型のデータだけになるように記述してください。複数の型のデータが1列に混在している場合，データを取得できない場合があります。

(9) キーとなる列名(odbc.KeyColumnNameプロパティ)，およびデータを取得する列のリスト(odbc.ColumnListプロパティ)に列番号を指定する場合は，255以下の整数値を指定してください。256以上の値を指定すると部品は異常終了します。途中の空白列も列数に含まれますのでご注意ください。

(10) キーとなる列名(odbc.KeyColumnNameプロパティ)，およびデータを取得する列のリスト(odbc.ColumnListプロパティ)に列名を指定する場合は，255列目以内の列名を指定してください。256列目以降の列名を指定すると部品は異常終了します。途中の空白列も列数に含まれますのでご注意ください。

(11) ファイル読み込み時のリトライ回数には0以上32767以下の整数値を指定してください。範囲外の値を指定すると部品は異常終了します。

(12) ファイル読み込み時のリトライ間隔には1以上60以下の整数値を指定してください。範囲外の値を指定すると部品は異常終了します。

(13) キーとなる値には「"」および「'」以外の文字を使用してください。

(14) CSVファイルの場合，フィールドの文字列長は255バイト以内にしてください。256バイト以上だった場合，ODBCドライバが正常に値を取得できずに，部品が異常終了する場合があります。

(15) この部品を同一ファイルに対して同時に実行した場合，ファイルのアクセスに失敗する場合があります。この場合，リトライ回数とリトライ間隔を調整して，エラーを回避できるまでリトライを実施してください。

(16) Excelファイルから取得したデータ内のMS932で表示できない文字は，「?」に置換します。

・UNIX環境の場合の注意事項

(1) 列名には次に示す内容を指定してください。

　・次の文字は列名に使用できません。

　　・キーとなる列名の先頭には次の文字を使用できません。

　　「!」「"」「#」「$」「%」「&」「'」「(」「)」「-」「=」「^」「~」「¥」「|」「`」「;」「+」「*」「[」「]」「{」「}」「,」「.」「<」「>」「?」「_」「/」「0」「1」「2」「3」「4」「5」「6」「7」「8」「9」

　　・キーとなる列名の2文字目以降には次の文字を使用できません。

　　「"」「#」「%」「&」「'」「(」「)」「-」「=」「^」「~」「¥」「|」「@」「;」「:」「+」「*」「[」「]」「{」「}」「,」「.」「<」「>」「?」「/」

　　・キーとなる列名以外の列名には次の文字を使用できません。

　　「!」「[」「]」「`」「,」「.」

　・文字数は64文字まで指定できます。

(2) 読み取り対象の列番号には255以内の整数値を指定してください。256以上の値を指定すると部品は異常終了します。途中の空白列も列数に含まれますのでご注意ください。

(3) キーとなる値には「"」および「'」以外の文字を使用してください。

(4) CSVファイルのデータには「,」は使用できません。使用した場合，列を正しく区切ることができないため，データを取得できません。

(5) CSVファイルの行の先頭または末尾に存在する半角スペースおよびタブ記号は，その個数に関係なく，存在しないものとみなします。

(6) LC_ALLやLC_MESSAGESなどLANGより上位のロケール環境変数が設定されている時，上位のロケール環境変数が優先されてしまうため部品を実行する際に，LC_ALLやLC_MESSAGESなどの上位のロケール環境変数を解除するか，LANG環境変数と同一の値に変更してください。

実行権限

ビルトイン Administrator

バージョン

03.00.02

部品のタグ

Gather OS information,Windows,Linux

タスクログに表示される部品の名称

osReadCSVExcelFileRow

戻り値

戻り値

説明

0

正常

11

異常(ユーザーミス) 定義ファイル内容の不正

12

異常(ユーザーミス) プロパティ不正

14

異常(ユーザーミス) ファイルアクセス不可

15

異常(ユーザーミス) 指定したキー値に合致する行がない

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.fileName

ファイル名

ファイル名を指定します。

−　

入力

○　

common.sheetName

EXCELファイルのシート名

EXCELファイルのシート名を指定します。CSVファイルの場合は，指定不要です。

Sheet1

入力

△　

odbc.KeyColumnName

キーとなる列名

キー情報が格納される列の見出し文字列，または列の番号を指定します。

−　

入力

○　

odbc.KeyValue

キーとなる値

データを取得する行を特定するための文字列を指定します。

−　

入力

○　

odbc.ColumnList

データを取得する列のリスト

データを取得する列の見出し文字列，または列の番号をコンマ区切りで指定します。列名(または列の番号)は90件まで指定できます。

−　

入力

○　

odbc.ColumnsAreNumeric

列のリストの列番号指定

キー情報が格納される列，およびデータを取得する列を番号で指定する場合，TRUEを指定します。列名(文字列)で指定する場合，FALSEを指定します。

−　

入力

○　

odbc.fileOpenRetryCount

ファイル読み込み時のリトライ回数:Windows固有

ファイルの読み込みに失敗した場合のリトライ回数を指定します(Windowsの場合だけ)。ファイル読み込み時のリトライ間隔と組み合わせて最大待ち時間となります。"0"を指定した場合はリトライしません。

20

入力

○　

odbc.fileOpenRetryInterval

ファイル読み込み時のリトライ間隔:Windows固有

ファイルの読み込みに失敗した場合のリトライ間隔を秒単位で指定します(Windowsの場合だけ)。

5

入力

○　

odbc.OutputValue1

データ1

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue2

データ2

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue3

データ3

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue4

データ4

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue5

データ5

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue6

データ6

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue7

データ7

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue8

データ8

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue9

データ9

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue10

データ10

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue11

データ11

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue12

データ12

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue13

データ13

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue14

データ14

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue15

データ15

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue16

データ16

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue17

データ17

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue18

データ18

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue19

データ19

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue20

データ20

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue21

データ21

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue22

データ22

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue23

データ23

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue24

データ24

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue25

データ25

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue26

データ26

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue27

データ27

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue28

データ28

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue29

データ29

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue30

データ30

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue31

データ31

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue32

データ32

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue33

データ33

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue34

データ34

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue35

データ35

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue36

データ36

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue37

データ37

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue38

データ38

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue39

データ39

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue40

データ40

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue41

データ41

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue42

データ42

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue43

データ43

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue44

データ44

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue45

データ45

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue46

データ46

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue47

データ47

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue48

データ48

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue49

データ49

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue50

データ50

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue51

データ51

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue52

データ52

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue53

データ53

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue54

データ54

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue55

データ55

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue56

データ56

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue57

データ57

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue58

データ58

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue59

データ59

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue60

データ60

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue61

データ61

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue62

データ62

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue63

データ63

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue64

データ64

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue65

データ65

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue66

データ66

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue67

データ67

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue68

データ68

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue69

データ69

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue70

データ70

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue71

データ71

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue72

データ72

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue73

データ73

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue74

データ74

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue75

データ75

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue76

データ76

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue77

データ77

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue78

データ78

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue79

データ79

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue80

データ80

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue81

データ81

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue82

データ82

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue83

データ83

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue84

データ84

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue85

データ85

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue86

データ86

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue87

データ87

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue88

データ88

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue89

データ89

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue90

データ90

取得したデータを設定します。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.5　CSV・Excelの行データ取得(SYSTEM)

機能

この部品は，WindowsまたはUNIX環境で，CSV(Comma Separated Values)ファイルまたは，Microsoft社のExcelで作成したExcelシートから指定した行のデータを取得し出力プロパティに設定します。

Windows環境の場合はCSVファイルまたはExcelファイルから，UNIX環境の場合はCSVファイルから，データを取得します。

次を満たすファイルのデータの取得をサポートします。

【CSVファイルの場合】

・拡張子がcsvのテキストファイルであること。

・ファイルの1行目には半角コンマ区切りで列名が記載されていること。

・列名指定でデータを読み出す場合，ファイルの1行目に必ず列名を指定すること。

・列番号を指定してデータを読み出す場合は，列名を記載する必要はありません。

・ファイルの2行目以降には読み取り対象のデータが半角コンマ(,)で区切られて記載されていること。なお，列名の記載有無に関わらず，データの読み取り開始行は2行目からとなります。

・Windows環境の場合は，文字コードがMS932で記述され，改行コードがCR+LFであること。UNIX環境の場合は，ユーザーの環境変数[LANG]で指定している文字コードで記述され，改行コードがLFであること。

【Excelファイルの場合】

・拡張子がxlsのファイル(「Excel97〜2003ブック」として保存されたExcelフォーマット)，またはxlsx，xlsm(Excel2007以降のExcelブック，Excelマクロ有効ブック)のファイルであること。

・必ず列名が記載されていること。1行目以降で最初に記述がある行が列名となる。

・列名が記載されている行の次の行以降に列名に対応する値が記載されていること。

ファイルの記述例を次に記載します。

【ファイルの記述例】

シート名: ServerInfo (Excelファイルの場合だけ)

1行目: ホスト名， CPUコア数， メモリ， ディスク容量， ライセンスキー

2行目: hostVM001， 2， 2048， 30， key1

3行目: hostVM002， 1， 1024， 10， key2

…

データを取得するシート名，キー情報が記載された列名(または列番号)，取得したい行のキー値，データを取得する列名(または列番号)を指定することで，該当する行の列データを最大90件まで取得できます。

読み込んだフィールドには次のチェックを行います。どれかの条件に当てはまると，部品は異常終了します。

(a)フィールドの文字列長が1024バイトより大きい

(b)フィールドに次の特殊記号を含む

　「<」，「>」，「|」，「;」，「&」，両端以外の「"」および末尾の「¥」

(c)フィールドに制御文字(0x00〜0x1f)を含む

出力情報は，キー値に合致した行の，odbc.ColumnListプロパティに指定した列の値を，文字列としてodbc.OutputValue1〜odbc.OutputValue90プロパティに格納し，指定した列ごとに出力します。どれかの列でフィールドの文字列が1011文字を超えると，部品は異常終了します。

【部品の使用例】

前述の【ファイルの記述例】に記載したファイルから，hostVM002のCPUコア数，ディスク容量を取得する場合の入力プロパティは次のように指定します。

[入力プロパティ例1(odbc.ColumnListプロパティに列名を指定する場合)]

odbc.SheetName：ServerInfo (Excelファイルの場合だけ)

odbc.KeyColumnName：ホスト名

odbc.KeyValue：hostVM002

odbc.ColumnList：CPUコア数，ディスク容量

odbc.ColumnsAreNumeric：FALSE

[入力プロパティ例2(odbc.ColumnListプロパティに列番号を指定する場合)]

odbc.SheetName：ServerInfo (Excelファイルの場合だけ)

odbc.KeyColumnName：1

odbc.KeyValue：hostVM002

odbc.ColumnList：2，4

odbc.ColumnsAreNumeric：TRUE

上記入力プロパティ例1または2のように指定した場合，部品の出力プロパティは次のようになります。

[出力プロパティ]

odbc.ColumnValue1：1

odbc.ColumnValue2：10

odbc.ColumnValue3〜90：値なし。

利用場面

管理情報を記載したCSVファイル，Excelファイルからデータを取得し，サービス内の他の部品の入力プロパティとして利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-10以降

【実行対象サーバ内前提製品】

　(1)データ取得対象にExcel2007以降のExcelブック，Excelマクロ有効ブックを指定する場合，次に示すMicrosoft社のプログラムのインストールが必要です。(Windows環境の場合)

　　・2007 Office system ドライバ，または

　　　Microsoft Access データベース エンジン 2010（32bit版），または

　　　Microsoft Access Database Engine 2016（32bit版）

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) CentOS 6 (64-bit x86_64)

　(9) CentOS 7 (64-bit x86_64)

　(10) CentOS 8 (64-bit x86_64)

　(11) Oracle Linux 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

なし。

注意事項

・Windows環境の場合の注意事項

(1) ODBCドライバの制限によって，ファイル名には「[」，「]」，「!」は使用できません。

(2) Excelファイルのセルが結合されている場合，数式がエラーとなっている場合は取得される値が空になります。また，書き込みパスワードが設定されている場合は，部品は異常終了します。読み取り対象のファイルからはこれらの状態を取り除いてください。

(3) 読み取る列は，文字列型データと数値型データを混在させないでください。混在していると，ODBCドライバの仕様によって，正常に値を取得できない場合があります。

　(a) 数値型データとは次の形式の文字列のことです。

　　符号付き整数値(10進数) 例：-12345

　　固定小数点数(10進数) 　例：3.1415

　　浮動小数点数(10進数) 　例：6.543E+10

　(b) 文字列型データとは上の数値型以外の形式の文字列のことです。

(4) 読み取り対象のファイルから異なるデータ型が混在する列を取得する場合は，次の対処が必要です。

　・Excelファイルの場合は数値型データの先頭に「'」を付けてください。

　・CSVファイルの場合は数値型データを「"」で囲んでください。

(5) 読み取り対象がCSVファイルである場合，IPアドレスは「"」で囲んでください。「"」で囲まない場合，数値型データとして誤認識され，正常に値を取得できないことがあります。

(6) 列名には次に示す内容を指定してください。

　・必ず文字列で指定してください。数値データは指定しないでください。

　・次の文字は列名に使用できません。

　　・キーとなる列名の先頭には次の文字を使用できません。

　　「!」「"」「#」「$」「%」「&」「'」「(」「)」「-」「=」「^」「~」「¥」「|」「`」「;」「+」「*」「[」「]」「{」「}」「,」「.」「<」「>」「?」「_」「/」「0」「1」「2」「3」「4」「5」「6」「7」「8」「9」「０」「１」「２」「３」「４」「５」「６」「７」「８」「９」

　　・キーとなる列名の2文字目以降には次の文字を使用できません。

　　「"」「#」「%」「&」「'」「(」「)」「-」「=」「^」「~」「¥」「|」「@」「;」「:」「+」「*」「[」「]」「{」「}」「,」「.」「<」「>」「?」「/」

　　・キーとなる列名以外の列名には次の文字を使用できません。

　　「!」「[」「]」「`」「,」「.」

　・文字数は半角全角混合で64文字まで指定できます。

(7) 読み取り対象ファイルがExcelファイルの場合，セルに記述されたデータのデータ型によっては，表示されている値と実際に取得される値が異なる場合があります。次のデータ型のデータを記述している場合はご注意ください。

　(a) Boolean型(True/False)

　　表示される値：TRUE/FALSE

　　セルに記述されている値：TRUE/FALSE

　　実際に取得される値：True/False

　(b) 日付データ

　　表示される値：mm月dd日

　　セルに記述されている値：yyyy/mm/dd

　　実際に取得される値：yyyy/mm/dd

　(c) 時刻データ

　　表示される値：hh:mm

　　セルに記述されている値：hh:mm:ss

　　実際に取得される値：hh:mm:ss

　(d) パーセント

　　表示される値：〜%(例：10%)

　　セルに記述されている値：〜%(例：10%)

　　実際に取得される値：0.〜(例：0.1)

　(e) 数式

　　表示される値：(数式の結果)

　　セルに記述されている値：(数式)

　　実際に取得される値：(数式の結果)

(a)(d)(e)のデータをセルに記述されている値のまま取得したい場合は先頭に「'」を付けてください。

なお，読み取り対象ファイルがCSVファイルの場合は記述した値をそのまま取得することができます。

(8) (7)の型のデータを記述する場合，その列の列名を除いたデータが1種類の型のデータだけになるように記述してください。複数の型のデータが1列に混在している場合，データを取得できない場合があります。

(9) キーとなる列名(odbc.KeyColumnNameプロパティ)，およびデータを取得する列のリスト(odbc.ColumnListプロパティ)に列番号を指定する場合は，255以下の整数値を指定してください。256以上の値を指定すると部品は異常終了します。途中の空白列も列数に含まれますのでご注意ください。

(10) キーとなる列名(odbc.KeyColumnNameプロパティ)，およびデータを取得する列のリスト(odbc.ColumnListプロパティ)に列名を指定する場合は，255列目以内の列名を指定してください。256列目以降の列名を指定すると部品は異常終了します。途中の空白列も列数に含まれますのでご注意ください。

(11) ファイル読み込み時のリトライ回数には0以上32767以下の整数値を指定してください。範囲外の値を指定すると部品は異常終了します。

(12) ファイル読み込み時のリトライ間隔には1以上60以下の整数値を指定してください。範囲外の値を指定すると部品は異常終了します。

(13) キーとなる値には「"」および「'」以外の文字を使用してください。

(14) CSVファイルの場合，フィールドの文字列長は255バイト以内にしてください。256バイト以上だった場合，ODBCドライバが正常に値を取得できずに，部品が異常終了する場合があります。

(15) この部品を同一ファイルに対して同時に実行した場合，ファイルのアクセスに失敗する場合があります。この場合，リトライ回数とリトライ間隔を調整して，エラーを回避できるまでリトライを実施してください。

(16) Excelファイルから取得したデータ内のMS932で表示できない文字は，「?」に置換します。

・UNIX環境の場合の注意事項

(1) 列名には次に示す内容を指定してください。

　・次の文字は列名に使用できません。

　　・キーとなる列名の先頭には次の文字を使用できません。

　　「!」「"」「#」「$」「%」「&」「'」「(」「)」「-」「=」「^」「~」「¥」「|」「`」「;」「+」「*」「[」「]」「{」「}」「,」「.」「<」「>」「?」「_」「/」「0」「1」「2」「3」「4」「5」「6」「7」「8」「9」

　　・キーとなる列名の2文字目以降には次の文字を使用できません。

　　「"」「#」「%」「&」「'」「(」「)」「-」「=」「^」「~」「¥」「|」「@」「;」「:」「+」「*」「[」「]」「{」「}」「,」「.」「<」「>」「?」「/」

　　・キーとなる列名以外の列名には次の文字を使用できません。

　　「!」「[」「]」「`」「,」「.」

　・文字数は64文字まで指定できます。

(2) 読み取り対象の列番号には255以内の整数値を指定してください。256以上の値を指定すると部品は異常終了します。途中の空白列も列数に含まれますのでご注意ください。

(3) キーとなる値には「"」および「'」以外の文字を使用してください。

(4) CSVファイルのデータには「,」は使用できません。使用した場合，列を正しく区切ることができないため，データを取得できません。

(5) CSVファイルの行の先頭または末尾に存在する半角スペースおよびタブ記号は，その個数に関係なく，存在しないものとみなします。

(6) LC_ALLやLC_MESSAGESなどLANGより上位のロケール環境変数が設定されている時，上位のロケール環境変数が優先されてしまうため部品を実行する際に，LC_ALLやLC_MESSAGESなどの上位のロケール環境変数を解除するか，LANG環境変数と同一の値に変更してください。

実行権限

Administratorsグループに所属するユーザー

バージョン

03.10.02

部品のタグ

Gather OS information,Windows,Linux

タスクログに表示される部品の名称

osReadCSVExcelFileRow_System

戻り値

戻り値

説明

0

正常

11

異常(ユーザーミス) 定義ファイル内容の不正

12

異常(ユーザーミス) プロパティ不正

14

異常(ユーザーミス) ファイルアクセス不可

15

異常(ユーザーミス) 指定したキー値に合致する行がない

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.fileName

ファイル名

ファイル名を指定します。

−　

入力

○　

common.sheetName

EXCELファイルのシート名

EXCELファイルのシート名を指定します。CSVファイルの場合は，指定不要です。

Sheet1

入力

△　

odbc.KeyColumnName

キーとなる列名

キー情報が格納される列の見出し文字列，または列の番号を指定します。

−　

入力

○　

odbc.KeyValue

キーとなる値

データを取得する行を特定するための文字列を指定します。

−　

入力

○　

odbc.ColumnList

データを取得する列のリスト

データを取得する列の見出し文字列，または列の番号をコンマ区切りで指定します。列名(または列の番号)は90件まで指定できます。

−　

入力

○　

odbc.ColumnsAreNumeric

列のリストの列番号指定

キー情報が格納される列，およびデータを取得する列を番号で指定する場合，TRUEを指定します。列名(文字列)で指定する場合，FALSEを指定します。

−　

入力

○　

odbc.fileOpenRetryCount

ファイル読み込み時のリトライ回数:Windows固有

ファイルの読み込みに失敗した場合のリトライ回数を指定します(Windowsの場合だけ)。ファイル読み込み時のリトライ間隔と組み合わせて最大待ち時間となります。"0"を指定した場合はリトライしません。

20

入力

○　

odbc.fileOpenRetryInterval

ファイル読み込み時のリトライ間隔:Windows固有

ファイルの読み込みに失敗した場合のリトライ間隔を秒単位で指定します(Windowsの場合だけ)。

5

入力

○　

odbc.OutputValue1

データ1

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue2

データ2

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue3

データ3

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue4

データ4

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue5

データ5

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue6

データ6

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue7

データ7

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue8

データ8

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue9

データ9

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue10

データ10

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue11

データ11

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue12

データ12

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue13

データ13

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue14

データ14

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue15

データ15

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue16

データ16

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue17

データ17

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue18

データ18

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue19

データ19

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue20

データ20

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue21

データ21

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue22

データ22

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue23

データ23

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue24

データ24

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue25

データ25

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue26

データ26

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue27

データ27

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue28

データ28

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue29

データ29

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue30

データ30

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue31

データ31

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue32

データ32

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue33

データ33

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue34

データ34

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue35

データ35

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue36

データ36

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue37

データ37

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue38

データ38

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue39

データ39

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue40

データ40

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue41

データ41

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue42

データ42

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue43

データ43

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue44

データ44

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue45

データ45

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue46

データ46

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue47

データ47

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue48

データ48

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue49

データ49

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue50

データ50

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue51

データ51

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue52

データ52

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue53

データ53

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue54

データ54

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue55

データ55

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue56

データ56

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue57

データ57

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue58

データ58

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue59

データ59

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue60

データ60

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue61

データ61

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue62

データ62

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue63

データ63

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue64

データ64

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue65

データ65

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue66

データ66

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue67

データ67

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue68

データ68

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue69

データ69

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue70

データ70

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue71

データ71

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue72

データ72

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue73

データ73

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue74

データ74

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue75

データ75

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue76

データ76

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue77

データ77

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue78

データ78

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue79

データ79

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue80

データ80

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue81

データ81

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue82

データ82

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue83

データ83

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue84

データ84

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue85

データ85

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue86

データ86

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue87

データ87

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue88

データ88

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue89

データ89

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue90

データ90

取得したデータを設定します。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.6　CSV・Excelの列データ取得

機能

この部品は，WindowsまたはUNIX環境で，CSV(Comma Separated Values)ファイルまたは，Microsoft社のExcelで作成したExcelシートから指定した列のデータをすべて取得し出力プロパティに設定します。

Windows環境の場合はCSVファイルまたはExcelファイルから，UNIX環境の場合はCSVファイルから，データを取得します。

次を満たすファイルのデータの取得をサポートします。

【CSVファイルの場合】

・拡張子がcsvのテキストファイルであること。

・列名が必要な場合は，ファイルの1行目には半角コンマ区切りで列名が記載されていること。列名が不要の場合は列名の記載は必要ありません。

・ファイルの2行目以降には読み取り対象のデータが半角コンマ(,)で区切られて記載されていること。なお，列名の記載有無に関わらず，データの読み取り開始行は2行目からとなります。

・Windows環境の場合は，文字コードがMS932で記述され，改行コードがCR+LFであること。UNIX環境の場合は，ユーザーの環境変数[LANG]で指定している文字コードで記述され，改行コードがLFであること。

【Excelファイルの場合】

・拡張子がxlsのファイル(「Excel97〜2003ブック」として保存されたExcelフォーマット)，またはxlsx，xlsm(Excel2007以降のExcelブック，Excelマクロ有効ブック)のファイルであること。

・必ず列名が記載されていること。1行目以降で最初に記述がある行が列名となる。

・列名が記載されている行の次の行以降に列名に対応する値が記載されていること。

ファイルの記述例を次に記載します。

【記述例1】

ホスト名

hostVM001

hostVM002

【記述例2】

ホスト名，コメント

hostVM001，#Comment1

hostVM002，#Comment2

読み込んだフィールドには次のチェックを行います。どれかの条件に当てはまると，部品は異常終了します。

(a)フィールドの文字列長が1024文字より大きい

(b)フィールドに次の特殊記号を含む

　「,」(Windows環境の場合)，「<」，「>」，「|」，「;」，「&」，両端以外の「"」および末尾の「¥」

　なおフィールドのデータが空の場合，無視して次の行を読み取ります。

(c)フィールドに制御文字(0x00〜0x1f)を含む

出力情報は指定した列ごとに出力します。どれかの列でデータ行数が99件を超えるか，「(フィールドの文字数の合計値)+ データ行数」が1017文字を超えると，部品は異常終了します。

実行対象サーバのOSがWindowsの場合，この部品の実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。実行対象サーバにAdministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行う部品「CSV・Excelの列データ取得(SYSTEM)」を実行してください。

利用場面

・管理情報を記載したCSV/Excelファイルからデータを取得し，サービスの入力値として利用できます。

・CSV/Excelファイルのキー情報となる列をこの部品で取得し，繰り返し部品，CSV・Excelの行データ取得部品への入力とすることで，ファイルに記載されたすべての行について特定の処理を実行できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)データ取得対象にExcel2007以降のExcelブック，Excelマクロ有効ブックを指定する場合，次に示すMicrosoft社のプログラムのインストールが必要です。(Windows環境の場合)

　　・2007 Office system ドライバ，または

　　　Microsoft Access データベース エンジン 2010（32bit版），または

　　　Microsoft Access Database Engine 2016（32bit版）

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) CentOS 6 (64-bit x86_64)

　(9) CentOS 7 (64-bit x86_64)

　(10) CentOS 8 (64-bit x86_64)

　(11) Oracle Linux 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

なし。

注意事項

・Windows環境の場合の注意事項

(1) ODBCドライバの制限によって，ファイル名には「[」，「]」，「!」は使用できません。

(2) Excelファイルのセルが結合されている場合，数式がエラーとなっている場合は取得される値が空になります。また，書き込みパスワードが設定されている場合は，部品は異常終了します。読み取り対象のファイルからはこれらの状態を取り除いてください。

(3) 読み取る列は，文字列型データと数値型データを混在させないでください。混在していると，ODBCドライバの仕様によって，正常に値を取得できない場合があります。

　(a)数値型データとは次の形式の文字列のことです。

　　符号付き整数値(10進数) 例：-12345

　　固定小数点数(10進数) 　例：3.1415

　　浮動小数点数(10進数) 　例：6.543E+10

　(b)文字列型データとは上の数値型以外の形式の文字列のことです。

(4) 読み取り対象のファイルから異なるデータ型が混在する列を取得する場合は，次の対処が必要です。

　・Excelファイルの場合は数値型データの先頭に「'」を付けてください。

　・CSVファイルの場合は数値型データを「"」で囲んでください。

(5) 読み取り対象がCSVファイルである場合，IPアドレスは「"」で囲んでください。「"」で囲まない場合，数値型データとして誤認識され，正常に値を取得できないことがあります。

(6) 読み取り対象ファイルがExcelファイルの場合，セルに記述されたデータのデータ型によっては，表示されている値と実際に取得される値が異なる場合があります。次のデータ型のデータを記述している場合はご注意ください。

　(a) Boolean型(True/False)

　　表示される値：TRUE/FALSE

　　セルに記述されている値：TRUE/FALSE

　　実際に取得される値：True/False

　(b) 日付データ

　　表示される値：mm月dd日

　　セルに記述されている値：yyyy/mm/dd

　　実際に取得される値：yyyy/mm/dd

　(c) 時刻データ

　　表示される値：hh:mm

　　セルに記述されている値：hh:mm:ss

　　実際に取得される値：hh:mm:ss

　(d) パーセント

　　表示される値：〜%(例：10%)

　　セルに記述されている値：〜%(例：10%)

　　実際に取得される値：0.〜(例：0.1)

　(e) 数式

　　表示される値：(数式の結果)

　　セルに記述されている値：(数式)

　　実際に取得される値：(数式の結果)

(a)(d)(e)のデータをセルに記述されている値のまま取得したい場合は先頭に「'」を付けてください。

なお，読み取り対象ファイルがCSVファイルの場合は記述した値をそのまま取得することができます。

(7) (6)の型のデータを記述する場合，その列の列名を除いたデータが1種類の型のデータだけになるように記述してください。複数の型のデータが1列に混在している場合，データを取得できない場合があります。

(8) 読み取り対象の列番号には255以内の整数値を指定してください。256以上の値を指定すると部品は異常終了します。途中の空白列も列数に含まれますのでご注意ください。

(9) ファイル読み込み時のリトライ回数には0以上32767以下の整数値を指定してください。範囲外の値を指定すると部品は異常終了します。

(10) ファイル読み込み時のリトライ間隔には1以上60以下の整数値を指定してください。範囲外の値を指定すると部品は異常終了します。

(11) 読み取り対象ファイルのデータの途中に空白行がある場合，空白行も行数としてカウントされます。データが記述された行が99行以内であっても，途中の空白行を含めた行数が100以上となる場合，部品は異常終了するのでご注意ください。

(12) CSVファイルの場合，フィールドの文字列長は255バイト以内にしてください。256バイト以上だった場合，ODBCドライバが正常に値を取得できずに，部品が異常終了する場合があります。

(13) この部品を同一ファイルに対して同時に実行した場合，ファイルのアクセスに失敗する場合があります。この場合，リトライ回数とリトライ間隔を調整して，エラーを回避できるまでリトライを実施してください。

(14) Excelファイルから取得したデータ内のMS932で表示できない文字は，「?」に置換します。

・UNIX環境の場合の注意事項

(1) 読み取り対象の列番号には255以内の整数値を指定してください。256以上の値を指定すると部品は異常終了します。途中の空白列も列数に含まれますのでご注意ください。

(2) 読み取り対象ファイルのデータの途中に空白行がある場合，空白行も行数としてカウントされます。データが記述された行が99行以内であっても，途中の空白行を含めた行数が100以上となる場合，部品は異常終了するのでご注意ください。

(3) CSVファイルのデータには「,」は使用できません。使用した場合，列を正しく区切ることができないため，データを取得できません。

(4) LC_ALLやLC_MESSAGESなどLANGより上位のロケール環境変数が設定されている時，上位のロケール環境変数が優先されてしまうため部品を実行する際に，LC_ALLやLC_MESSAGESなどの上位のロケール環境変数を解除するか，LANG環境変数と同一の値に変更してください。

実行権限

ビルトイン Administrator

バージョン

02.00.01

部品のタグ

Gather OS information,Windows,Linux

タスクログに表示される部品の名称

osReadCSVExcelFileColumn

戻り値

戻り値

説明

0

正常

11

異常(ユーザーミス) 定義ファイル内容の不正

12

異常(ユーザーミス) プロパティ不正

14

異常(ユーザーミス) ファイルアクセス不可

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.fileName

ファイル名

ファイル名を指定します。

−　

入力

○　

common.sheetName

EXCELファイルのシート名

EXCELファイルのシート名を指定します。CSVファイルの場合は，指定不要です。

Sheet1

入力

△　

odbc.Column1

列番号1

取得するデータの列番号を指定します。

−　

入力

○　

odbc.Column2

列番号2

取得するデータの列番号を指定します。

−　

入力

△　

odbc.Column3

列番号3

取得するデータの列番号を指定します。

−　

入力

△　

odbc.Column4

列番号4

取得するデータの列番号を指定します。

−　

入力

△　

odbc.Column5

列番号5

取得するデータの列番号を指定します。

−　

入力

△　

odbc.fileOpenRetryCount

ファイル読み込み時のリトライ回数:Windows固有

ファイルの読み込みに失敗した場合のリトライ回数を指定します(Windowsの場合だけ)。ファイル読み込み時のリトライ間隔と組み合わせて最大待ち時間となります。"0"を指定した場合はリトライしません。

20

入力

○　

odbc.fileOpenRetryInterval

ファイル読み込み時のリトライ間隔:Windows固有

ファイルの読み込みに失敗した場合のリトライ間隔を秒単位で指定します(Windowsの場合だけ)。

5

入力

○　

odbc.OutputValue1

データ1

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue2

データ2

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue3

データ3

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue4

データ4

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue5

データ5

取得したデータを設定します。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.7　CSV・Excelの列データ取得(SYSTEM)

機能

この部品は，WindowsまたはUNIX環境で，CSV(Comma Separated Values)ファイルまたは，Microsoft社のExcelで作成したExcelシートから指定した列のデータをすべて取得し出力プロパティに設定します。

Windows環境の場合はCSVファイルまたはExcelファイルから，UNIX環境の場合はCSVファイルから，データを取得します。

次を満たすファイルのデータの取得をサポートします。

【CSVファイルの場合】

・拡張子がcsvのテキストファイルであること。

・列名が必要な場合は，ファイルの1行目には半角コンマ区切りで列名が記載されていること。列名が不要の場合は列名の記載は必要ありません。

・ファイルの2行目以降には読み取り対象のデータが半角コンマ(,)で区切られて記載されていること。なお，列名の記載有無に関わらず，データの読み取り開始行は2行目からとなります。

・Windows環境の場合は，文字コードがMS932で記述され，改行コードがCR+LFであること。UNIX環境の場合は，ユーザーの環境変数[LANG]で指定している文字コードで記述され，改行コードがLFであること。

【Excelファイルの場合】

・拡張子がxlsのファイル(「Excel97〜2003ブック」として保存されたExcelフォーマット)，またはxlsx，xlsm(Excel2007以降のExcelブック，Excelマクロ有効ブック)のファイルであること。

・必ず列名が記載されていること。1行目以降で最初に記述がある行が列名となる。

・列名が記載されている行の次の行以降に列名に対応する値が記載されていること。

ファイルの記述例を次に記載します。

【記述例1】

ホスト名

hostVM001

hostVM002

【記述例2】

ホスト名，コメント

hostVM001，#Comment1

hostVM002，#Comment2

読み込んだフィールドには次のチェックを行います。どれかの条件に当てはまると，部品は異常終了します。

(a)フィールドの文字列長が1024文字より大きい

(b)フィールドに次の特殊記号を含む

　「,」(Windows環境の場合)，「<」，「>」，「|」，「;」，「&」，両端以外の「"」および末尾の「¥」

　なおフィールドのデータが空の場合，無視して次の行を読み取ります。

(c)フィールドに制御文字(0x00〜0x1f)を含む

出力情報は指定した列ごとに出力します。どれかの列でデータ行数が99件を超えるか，「(フィールドの文字数の合計値)+ データ行数」が1017文字を超えると，部品は異常終了します。

利用場面

・管理情報を記載したCSV/Excelファイルからデータを取得し，サービスの入力値として利用できます。

・CSV/Excelファイルのキー情報となる列をこの部品で取得し，繰り返し部品，CSV・Excelの行データ取得部品への入力とすることで，ファイルに記載されたすべての行について特定の処理を実行できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　(1)データ取得対象にExcel2007以降のExcelブック，Excelマクロ有効ブックを指定する場合，次に示すMicrosoft社のプログラムのインストールが必要です。(Windows環境の場合)

　　・2007 Office system ドライバ，または

　　　Microsoft Access データベース エンジン 2010（32bit版），または

　　　Microsoft Access Database Engine 2016（32bit版）

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) CentOS 6 (64-bit x86_64)

　(9) CentOS 7 (64-bit x86_64)

　(10) CentOS 8 (64-bit x86_64)

　(11) Oracle Linux 8 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

なし。

注意事項

・Windows環境の場合の注意事項

(1) ODBCドライバの制限によって，ファイル名には「[」，「]」，「!」は使用できません。

(2) Excelファイルのセルが結合されている場合，数式がエラーとなっている場合は取得される値が空になります。また，書き込みパスワードが設定されている場合は，部品は異常終了します。読み取り対象のファイルからはこれらの状態を取り除いてください。

(3) 読み取る列は，文字列型データと数値型データを混在させないでください。混在していると，ODBCドライバの仕様によって，正常に値を取得できない場合があります。

　(a)数値型データとは次の形式の文字列のことです。

　　符号付き整数値(10進数) 例：-12345

　　固定小数点数(10進数) 　例：3.1415

　　浮動小数点数(10進数) 　例：6.543E+10

　(b)文字列型データとは上の数値型以外の形式の文字列のことです。

(4) 読み取り対象のファイルから異なるデータ型が混在する列を取得する場合は，次の対処が必要です。

　・Excelファイルの場合は数値型データの先頭に「'」を付けてください。

　・CSVファイルの場合は数値型データを「"」で囲んでください。

(5) 読み取り対象がCSVファイルである場合，IPアドレスは「"」で囲んでください。「"」で囲まない場合，数値型データとして誤認識され，正常に値を取得できないことがあります。

(6) 読み取り対象ファイルがExcelファイルの場合，セルに記述されたデータのデータ型によっては，表示されている値と実際に取得される値が異なる場合があります。次のデータ型のデータを記述している場合はご注意ください。

　(a) Boolean型(True/False)

　　表示される値：TRUE/FALSE

　　セルに記述されている値：TRUE/FALSE

　　実際に取得される値：True/False

　(b) 日付データ

　　表示される値：mm月dd日

　　セルに記述されている値：yyyy/mm/dd

　　実際に取得される値：yyyy/mm/dd

　(c) 時刻データ

　　表示される値：hh:mm

　　セルに記述されている値：hh:mm:ss

　　実際に取得される値：hh:mm:ss

　(d) パーセント

　　表示される値：〜%(例：10%)

　　セルに記述されている値：〜%(例：10%)

　　実際に取得される値：0.〜(例：0.1)

　(e) 数式

　　表示される値：(数式の結果)

　　セルに記述されている値：(数式)

　　実際に取得される値：(数式の結果)

(a)(d)(e)のデータをセルに記述されている値のまま取得したい場合は先頭に「'」を付けてください。

なお，読み取り対象ファイルがCSVファイルの場合は記述した値をそのまま取得することができます。

(7) (6)の型のデータを記述する場合，その列の列名を除いたデータが1種類の型のデータだけになるように記述してください。複数の型のデータが1列に混在している場合，データを取得できない場合があります。

(8) 読み取り対象の列番号には255以内の整数値を指定してください。256以上の値を指定すると部品は異常終了します。途中の空白列も列数に含まれますのでご注意ください。

(9) ファイル読み込み時のリトライ回数には0以上32767以下の整数値を指定してください。範囲外の値を指定すると部品は異常終了します。

(10) ファイル読み込み時のリトライ間隔には1以上60以下の整数値を指定してください。範囲外の値を指定すると部品は異常終了します。

(11) 読み取り対象ファイルのデータの途中に空白行がある場合，空白行も行数としてカウントされます。データが記述された行が99行以内であっても，途中の空白行を含めた行数が100以上となる場合，部品は異常終了するのでご注意ください。

(12) CSVファイルの場合，フィールドの文字列長は255バイト以内にしてください。256バイト以上だった場合，ODBCドライバが正常に値を取得できずに，部品が異常終了する場合があります。

(13) この部品を同一ファイルに対して同時に実行した場合，ファイルのアクセスに失敗する場合があります。この場合，リトライ回数とリトライ間隔を調整して，エラーを回避できるまでリトライを実施してください。

(14) Excelファイルから取得したデータ内のMS932で表示できない文字は，「?」に置換します。

・UNIX環境の場合の注意事項

(1) 読み取り対象の列番号には255以内の整数値を指定してください。256以上の値を指定すると部品は異常終了します。途中の空白列も列数に含まれますのでご注意ください。

(2) 読み取り対象ファイルのデータの途中に空白行がある場合，空白行も行数としてカウントされます。データが記述された行が99行以内であっても，途中の空白行を含めた行数が100以上となる場合，部品は異常終了するのでご注意ください。

(3) CSVファイルのデータには「,」は使用できません。使用した場合，列を正しく区切ることができないため，データを取得できません。

(4) LC_ALLやLC_MESSAGESなどLANGより上位のロケール環境変数が設定されている時，上位のロケール環境変数が優先されてしまうため部品を実行する際に，LC_ALLやLC_MESSAGESなどの上位のロケール環境変数を解除するか，LANG環境変数と同一の値に変更してください。

実行権限

Administratorsグループに所属するユーザー

バージョン

03.10.00

部品のタグ

Gather OS information,Windows,Linux

タスクログに表示される部品の名称

osReadCSVExcelFileColumn_System

戻り値

戻り値

説明

0

正常

11

異常(ユーザーミス) 定義ファイル内容の不正

12

異常(ユーザーミス) プロパティ不正

14

異常(ユーザーミス) ファイルアクセス不可

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.fileName

ファイル名

ファイル名を指定します。

−　

入力

○　

common.sheetName

EXCELファイルのシート名

EXCELファイルのシート名を指定します。CSVファイルの場合は，指定不要です。

Sheet1

入力

△　

odbc.Column1

列番号1

取得するデータの列番号を指定します。

−　

入力

○　

odbc.Column2

列番号2

取得するデータの列番号を指定します。

−　

入力

△　

odbc.Column3

列番号3

取得するデータの列番号を指定します。

−　

入力

△　

odbc.Column4

列番号4

取得するデータの列番号を指定します。

−　

入力

△　

odbc.Column5

列番号5

取得するデータの列番号を指定します。

−　

入力

△　

odbc.fileOpenRetryCount

ファイル読み込み時のリトライ回数:Windows固有

ファイルの読み込みに失敗した場合のリトライ回数を指定します(Windowsの場合だけ)。ファイル読み込み時のリトライ間隔と組み合わせて最大待ち時間となります。"0"を指定した場合はリトライしません。

20

入力

○　

odbc.fileOpenRetryInterval

ファイル読み込み時のリトライ間隔:Windows固有

ファイルの読み込みに失敗した場合のリトライ間隔を秒単位で指定します(Windowsの場合だけ)。

5

入力

○　

odbc.OutputValue1

データ1

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue2

データ2

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue3

データ3

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue4

データ4

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue5

データ5

取得したデータを設定します。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.8　ICMPエコー要求メッセージの送信

機能

指定されたWindowsまたはUNIXのサーバで，指定されたIPアドレスに対してICMPエコー要求を送信し，応答があるかどうかを戻り値で返します。

この部品では，次のサーバを前提とします。

・実行対象サーバ

　部品を実行し，ICMPエコー要求の送信を行うサーバです。

・送信対象サーバ

　ICMPエコー要求の送信対象のサーバです。

プロパティcommon.icmpSendAddressに送信対象サーバのIPアドレスまたはホスト名を指定して実行します。

複数のIPアドレス(ホスト名)が指定された場合，指定されたすべてのIPアドレス(ホスト名)に対してICMPエコー要求を送信します。

1つ以上のIPアドレス(ホスト名)からICMPエコーに対する応答があれば，戻り値「0」を返します。

どのIPアドレス(ホスト名)からもICMPエコーに対する応答がなければ，戻り値「0」以外を返します。

この部品が出力する「CommandExitCode:」の値を次に示します。

　Windowsの場合：Win32_PingStatus class(MSDN)のStatusCode(ICMPエコーの結果)です。

　UNIXの場合：pingコマンドの戻り値です。

利用場面

仮想サーバを起動したあとなどに，送信対象サーバと通信可能な状態であることを確認するため，ICMPエコー要求を送信する場合に利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

【実行対象サーバの使用条件】

なし。

注意事項

(1)ICMPエコーのタイムアウト時間(common.icmpEchoTimeoutプロパティ)は利用している環境に応じて調整してください。

(2)送信対象サーバがWindowsの場合，送信対象サーバのファイアーウォールがICMP(ECHO)応答を許可している必要があります。

(3)この部品には，リミテッド・ブロードキャスト・アドレス(255.255.255.255)を使用しないでください。

(4)実行対象サーバがWindowsで，エージェントレス接続先設定の認証情報に設定したユーザーがビルトインAdministratorではない場合，以下のいずれかの条件を満たす必要があります。

・WindowsのUAC機能が完全に無効化されている。

・エージェントレス接続先の機器にて，エージェントレス接続先設定の認証情報に設定されたユーザーに対するRDPセッションが確立されている。

実行権限

Administrators 権限

バージョン

02.00.00

部品のタグ

Control OS,Windows,Linux

タスクログに表示される部品の名称

osSendIcmp

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

25

異常(環境不正) 通信エラー

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.icmpSendAddress

ICMPエコーの送信先

ICMPエコーを送信するIPアドレスまたはホスト名を指定します。複数のIPアドレス(ホスト名)に送信する場合には，コンマ区切りで指定します。

−　

入力

○　

common.icmpEchoTimeout

ICMPエコー要求のタイムアウト時間

ICMPエコー要求に対する応答を待つ時間をミリ秒単位で指定します。

4000

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.9　IPアドレスの設定

機能

この部品は，WindowsまたはUNIXの実行対象サーバにおいて，指定したNICにIPアドレスを設定します。

IPアドレスを設定するNICはNIC名(os.nicNameプロパティ)で指定します。また，Windows，Red Hat Enterprise Linux 6もしくはCentOS 6の場合，MACアドレス(os.nicMacAddressプロパティ)での指定もできます。

NIC名とMACアドレスが両方指定された場合は，NIC名に指定されたNICにIPアドレスを設定します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　部品を実行し，IPアドレスを設定するサーバです。

NIC名(os.nicNameプロパティ)について次に示します。

・IPアドレスを設定するNICのインターフェース名を指定します。

MACアドレス(os.nicMacAddressプロパティ)について次に示します。

・IPアドレスを指定するNICのMACアドレスを指定します。

・「XX:XX:XX:XX:XX:XX」の形式で指定してください。

実行対象サーバがRed Hat Enterprise LinuxもしくはCentOSの場合の設定対象ファイルおよび設定項目を次に示します。

・IPアドレス，サブネットマスクの設定対象ファイルおよび設定項目

　設定対象ファイル：/etc/sysconfig/network-scripts/ifcfg-XXX (XXXはNICのインターフェース名です。)

　設定項目　　　　：①BOOTPROTO=none (すでにstaticが設定されている場合は，staticのまま変更されません。)

　　　　　　　　　　②IPADDR=<IPアドレス>

　　　　　　　　　　③NETMASK=<サブネットマスク>

・デフォルトゲートウェイの設定対象ファイルおよび設定項目

　設定対象ファイル：/etc/sysconfig/network

　設定項目　　　　：①GATEWAY=<デフォルトゲートウェイ>

・DNSサーバのIPアドレスの設定対象ファイルおよび設定項目

　設定対象ファイル：/etc/sysconfig/network-scripts/ifcfg-XXX (XXXはNICのインターフェース名です。)

　設定項目　　　　：①DNS1=<DNSサーバのIPアドレス>

NIC名の設定例を次に示します。

・実行対象サーバがWindows Server 2008 R2の場合，

　NIC名に「ローカル エリア接続」，「ローカル エリア接続 2」等のインターフェース名を指定します。ipconfigコマンドの"イーサネット アダプター"の名称です。

・実行対象サーバがWindows Server 2012もしくはWindows Server 2012 R2の場合，

　NIC名に「イーサネット」，「イーサネット 2」等のインターフェース名を指定します。ipconfigコマンドの"イーサネット アダプター"の名称です。

・実行対象サーバがRed Hat Enterprise LinuxもしくはCentOSの場合，

　NIC名に「eth0」，「eth1」等のインターフェース名を指定します。ifconfigコマンドのインターフェースの名称です。

利用場面

この部品は，OSの認識しているNICにIPアドレスを設定する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　　・net-toolsパッケージがインストールされていること。

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　　・net-toolsパッケージがインストールされていること。

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　　・net-toolsパッケージがインストールされていること。

　・CentOS 8 (64-bit x86_64)

　　・net-toolsパッケージがインストールされていること。

　・Oracle Linux 8 (64-bit x86_64)

　　・net-toolsパッケージがインストールされていること。

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)JP1/AOサーバとの通信に使用しているNICのIPアドレスは変更しないでください。JP1/AOサーバとの通信が切断され，この部品は異常終了します。

(3)OSに設定するIPアドレスについて，IPアドレスとして設定できない値は入力しないでください。例えば，ネットワークアドレスやブロードキャストアドレス，"0.0.0.0"や"255.255.255.255"などの特殊なアドレスは指定できません。

(4)設定するIPアドレスは，他のサーバと重複しないようにしてください。他のサーバとIPアドレスが重複していると，NICが無効状態となり，この部品は異常終了する場合があります。

(5)実行対象サーバがRed Hat Enterprise LinuxもしくはCentOSの場合，機能説明に記載している設定ファイルの設定項目を指定された値に置換します。そのため，同名の設定項目の複数定義や設定項目のコメントアウトをしないでください。この部品が正常終了しますが設定内容が反映されません。

バージョン

02.00.00

部品のタグ

Configure OS,Windows,Linux

タスクログに表示される部品の名称

osSetIpAddress

戻り値

戻り値

説明

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

os.nicName

NIC名

IPアドレスを設定するNICの名称を指定します。

−　

入力

△　

os.nicMacAddress

MACアドレス

IPアドレスを設定するNICのMACアドレスを"XX:XX:XX:XX:XX:XX"の形式で指定します。

−　

入力

△　

os.nicIpAddress

IPアドレス

NICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

os.nicSubnetMask

サブネットマスク

NICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

○　

os.nicDefaultGW

デフォルトゲートウェイ

NICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

os.nicDns

DNSサーバのIPアドレス

NICに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.10　OSサービスの操作

機能

WindowsまたはLinux環境において，OSサービスに対する操作を実行します。

このドキュメント内で使用している用語を次に示します。

・OSサービス

　JP1/AOで実行するサービスと区別するため，WindowsのサービスおよびLinuxのサービスを総称してOSサービスと記載します。

この部品では，次のサーバを前提とします。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

指定するOSサービス名(common.serviceNameプロパティ)は，実行対象サーバのOS種別によって異なります。

・OSがWindowsの場合：「コントロール パネル」−「管理ツール」−「サービス」の名前欄に表示される名称，サービス表示名。

・OSがLinuxの場合：/etc/init.dディレクトリ配下のサービススクリプト名。

実行するOSサービス操作(common.serviceCommandプロパティ)は，次の6つです。他の操作は指定できません。

・start(開始)

・stop(停止)

・restart(再起動)

・status(状態取得)

・suspend(一時中断)*

・resume(再開)*

　*：一時中断と再開は，実行対象サーバがWindowsの場合のみ操作可能です。

各操作の仕様は，実行対象サーバのOSの仕様に従います。例えば，既に実行中のOSサービスに対するstart操作，および既に停止しているOSサービスに対するstop操作は，エラーにはならず正常終了します。また，既に停止しているOSサービスに対するrestart操作は，起動処理だけを実行します。

status操作を実行した場合は，取得結果をOSサービスの状態(common.serviceStatusプロパティ)に数字で格納します。数字の意味を次に示します。

・Windowsの場合：

　1: サービスは停止しています。

　2: サービスは開始処理中です。

　3: サービスは停止処理中です。

　4: サービスは実行中です。

　5: サービスの継続は保留中です。

　6: サービスは一時中断処理中です。

　7: サービスは一時中断しています。

　99: サービスは状態不明です。

・Linuxの場合：

　OSサービス名に指定したサービススクリプトの仕様に従います。例として，Red Hat Enterprise Linuxの一般的なサービススクリプトの仕様を次に示します。

　0: プログラムは実行中。

　1: プログラムは停止していますが，プロセス ID ファイルが残っています。

　2: プログラムは停止していますが，ロックファイルが残っています。

　3: プログラムは停止しています。

　4: プロセスIDファイルを読み込む権限が無いため，プログラムの実行状態を判定できません。

suspend操作を実行した場合，指定したOSサービスの状態によって次のような実行結果となります。

・OSサービスの状態が「一時停止」の場合，OSサービスの状態は「一時停止」のまま，この部品は正常終了します。

・OSサービスの状態が「開始」の場合，OSサービスの状態は「一時停止」になり，この部品は正常終了します。

・OSサービスの状態が「停止」の場合，OSサービスの状態は「停止」のまま，この部品は異常終了します。

resume操作を実行した場合，指定したOSサービスの状態によって次のような実行結果となります。

・OSサービスの状態が「一時停止」の場合，OSサービスの状態は「開始」になり，この部品は正常終了します。

・OSサービスの状態が「開始」の場合，OSサービスの状態は「開始」になり，この部品は正常終了します。

・OSサービスの状態が「停止」の場合，OSサービスの状態は「停止」のまま，この部品は異常終了します。

利用場面

この部品は，OSサービスの状態取得や制御を行う場合に利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) CentOS 6 (64-bit x86_64)

　(9) CentOS 7 (64-bit x86_64)

　(10) CentOS 8 (64-bit x86_64)

　(11) Oracle Linux 8 (64-bit x86_64)

【実行対象サーバの使用条件】

　なし。

注意事項

(1) 実行対象サーバの稼働OSがWindowsの場合，エージェントレス接続先に定義された接続ユーザーに，操作対象のOSサービスに対するアクセス許可が必要です。

(2) 実行対象サーバの稼働OSがWindowsの場合，開始および再起動できるOSサービスは，スタートアップの種類が「手動」または「自動」のOSサービスだけです。スタートアップの種類が「無効」のOSサービスは開始できません。

(3) 実行対象サーバの稼働OSがWindowsの場合，指定したOSサービスと依存関係のある他のOSサービスに対する操作は実行しません。そのため，指定したOSサービスに対する操作が失敗する場合があります。

(4) 実行対象サーバの稼働OSがWindowsの場合，次の条件が重なると，この部品が異常終了します。

　・他のOSサービスが依存しているOSサービスに対して，停止または再起動を実行する。

　・依存関係にあるOSサービスの停止要否(Windows.dependOnServiceStopプロパティ)にfalseと指定する。

(5) 実行対象サーバの稼働OSがWindowsの場合，プロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。指定した場合，この部品が異常終了します。

(6) 実行対象サーバの稼働OSがLinuxの場合，プロパティには「"」(ダブルクォーテーション)を含む文字列は指定しないでください。指定した場合，この部品が異常終了します。

(7) 実行対象サーバの稼働OSとは関係なく，OSサービス名(common.serviceNameプロパティ)は完全名で指定してください。部分一致やワイルドカードによる指定はできません。特にOSがLinuxの場合は，大文字・小文字も区別されます。

(8) 一時中断，再開操作を実行する際に，一時中断および再開をサポートしていないOSサービスを指定した場合，この部品は異常終了します。

実行権限

Windowsの場合：Administrator権限

Linuxの場合：root権限

バージョン

02.01.00

部品のタグ

Control OS,Windows,Linux

タスクログに表示される部品の名称

osOperateService

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない/実行できない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.serviceName

OSサービス名

操作するOSサービス名を指定します。OSがWindowsの場合はサービス表示名，Linuxの場合はサービススクリプト名が該当します。

−　

入力

○　

common.serviceCommand

OSサービスの操作

OSサービスに対する操作(start/stop/restart/status/suspend/resume)を指定します。

status

入力

○　

Windows.dependOnServiceStop

依存関係にあるOSサービスの停止要否:Windows固有

実行対象サーバのOSがWindowsの場合に，指定したOSサービスに対して他のOSサービスが依存していても停止または再起動を行う場合はtrue，停止または再起動を行わない場合はfalseを指定します。省略した場合はfalseが設定されます。OSサービスの開始または状態取得を行う場合および，OSがLinuxの場合は指定しても無視されます。

−　

入力

△　

common.serviceStatus

OSサービスの状態

OSサービスの状態取得を実行した場合に，取得したOSサービスの状態が格納されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.11　OSユーザーのパスワード変更

機能

Windows/UNIX環境でOSユーザーのパスワードを変更します。

Windows環境ではローカルユーザーまたはドメインユーザーのパスワードを変更できます。UNIX環境で使用する場合は「運用ユーザー追加」，「運用ユーザー変更」，または「運用ユーザー一括変更」サービステンプレートで使用してください。それ以外のサービステンプレートで使用することをサポートしていません。

この部品では，次のサーバを前提とします。

・実行対象サーバ

　この部品を実行する対象となるサーバです。WindowsまたはUNIXがセットアップされている必要があります。

Windows環境では，パスワードを変更するユーザー種別に応じてプロパティWindows.userTypeに次の値を設定します。

・ローカルユーザーのパスワードを変更する場合：local

・ドメインユーザーのパスワードを変更する場合：domain

実行対象サーバのOSがWindowsの場合，この部品の実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。実行対象サーバにAdministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行う部品「OSユーザーのパスワード変更(SYSTEM)」を実行してください。

利用場面

運用に使用するユーザーのパスワードを変更する場合に利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

(12) AIX V6

(13) AIX V7

【実行対象サーバの使用条件】

なし。

注意事項

(1) UNIX環境に対してこの部品を実行する場合は，プロパティにマルチバイト文字を使用しないでください。

バージョン

02.00.00

部品のタグ

Configure OS,Windows,Linux,AIX

タスクログに表示される部品の名称

osChangePassword

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.osUserName

OSユーザー名

パスワードを変更するOSユーザーのユーザー名を指定します。

−　

入力

△　

common.osUserPassword

OSユーザーのパスワード

OSユーザーの変更後のパスワードを指定します。

−　

入力

△　

common.osUserPasswordReEnter

OSユーザーのパスワード再入力

OSユーザーの変更後のパスワードを再入力します。

−　

入力

△　

Windows.userType

OSユーザー種別

OSユーザーの種別をローカル（local）またはドメイン（domain）で指定します。domainの場合，操作対象サーバのドメインのプライマリドメインコントローラに対して操作を行います。このプロパティはWindowsだけで有効です。

local

入力

△　

common.addOrChange

コマンド実行種別

UNIX環境の場合に，実行されるサービスが運用ユーザー追加(a)か，運用ユーザー変更(c)かを指定します。

−　

入力

△　

common.tmpFileID

一時ファイル識別ID

UNIX環境の場合に，一時ファイルを識別するIDを指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.12　OSユーザーのパスワード変更(SYSTEM)

機能

Windows/UNIX環境でOSユーザーのパスワードを変更します。

Windows環境ではローカルユーザーまたはドメインユーザーのパスワードを変更できます。UNIX環境で使用する場合は「運用ユーザー追加」，「運用ユーザー変更」，または「運用ユーザー一括変更」サービステンプレートで使用してください。それ以外のサービステンプレートで使用することをサポートしていません。

この部品では，次のサーバを前提とします。

・実行対象サーバ

　この部品を実行する対象となるサーバです。WindowsまたはUNIXがセットアップされている必要があります。

Windows環境では，パスワードを変更するユーザー種別に応じてプロパティWindows.userTypeに次の値を設定します。

・ローカルユーザーのパスワードを変更する場合：local

・ドメインユーザーのパスワードを変更する場合：domain

利用場面

運用に使用するユーザーのパスワードを変更する場合に利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

(12) AIX V6

(13) AIX V7

【実行対象サーバの使用条件】

なし。

注意事項

(1) UNIX環境に対してこの部品を実行する場合は，プロパティにマルチバイト文字を使用しないでください。

バージョン

02.50.01

部品のタグ

Configure OS,Windows,Linux,AIX

タスクログに表示される部品の名称

osChangePassword_System

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.osUserName

OSユーザー名

パスワードを変更するOSユーザーのユーザー名を指定します。

−　

入力

△　

common.osUserPassword

OSユーザーのパスワード

OSユーザーの変更後のパスワードを指定します。

−　

入力

△　

common.osUserPasswordReEnter

OSユーザーのパスワード再入力

OSユーザーの変更後のパスワードを再入力します。

−　

入力

△　

Windows.userType

OSユーザー種別

OSユーザーの種別をローカル（local）またはドメイン（domain）で指定します。domainの場合，操作対象サーバのドメインのプライマリドメインコントローラに対して操作を行います。このプロパティはWindowsだけで有効です。

local

入力

△　

common.addOrChange

コマンド実行種別

UNIX環境の場合に，実行されるサービスが運用ユーザー追加(a)か，運用ユーザー変更(c)かを指定します。

−　

入力

△　

common.tmpFileID

一時ファイル識別ID

UNIX環境の場合に，一時ファイルを識別するIDを指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.13　OSユーザーの一覧取得

機能

この部品は，Windows/UNIXのOSユーザー一覧を取得します。

利用場面

システムに定義してあるOSユーザーを確認します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

(12) AIX V6

(13) AIX V7

【実行対象サーバの使用条件】

(1)サーバが起動していること。

実行権限

Windowsの場合：Administrator権限

UNIXの場合：root権限

バージョン

02.00.00

部品のタグ

Gather OS information,Linux,Windows,AIX

タスクログに表示される部品の名称

osShowUsers

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

common.fileName

ファイル名

ファイル名を指定します。

−　

入力

○　

OS.selectWorkgroupDomain

ワークグループ/ドメインの選択

仮想サーバがワークグループまたはドメインのどちらに所属するかを指定します（Windowsの場合だけ）。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.14　OSユーザーの削除

機能

WindowsまたはUNIX環境でOSユーザーを削除します。

この部品では，次のサーバを前提とします。

・実行対象サーバ

　この部品を実行する対象となるサーバです。前提条件に記載のWindowsまたはUNIXがセットアップされている必要があります。

Windowsの場合，ローカルユーザーまたはドメインユーザーを削除できます。

削除するユーザー種別に応じてプロパティWindows.userTypeに次の値を設定します。

　・ローカルユーザーを削除する場合：local

　・ドメインユーザーを削除する場合：domain

UNIXの場合，削除するOSユーザーのホームディレクトリもあわせて削除することができます。

プロパティUNIX.homeDirectoryDeleteに次の値を設定します。

　・OSユーザーのホームディレクトリを削除する場合：yes

　・OSユーザーのホームディレクトリを削除しない場合：no

実行対象サーバのOSがWindowsの場合，この部品の実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。実行対象サーバにAdministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行う部品「OSユーザーの削除(SYSTEM)」を実行してください。

利用場面

運用に使用するOSユーザーを削除する場合などに利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

(12) AIX V6

(13) AIX V7

【実行対象サーバの使用条件】

なし。

注意事項

(1)実行対象サーバがUNIXの場合，ユーザーのホームディレクトリを削除する場合は，必要に応じてホームディレクトリに格納されたデータを退避してください。

(2) UNIX環境に対してこの部品を実行する場合は，プロパティにマルチバイト文字を使用しないでください。

バージョン

02.00.00

部品のタグ

Configure OS,Windows,Linux,AIX

タスクログに表示される部品の名称

osDeleteUser

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

common.osUserName

OSユーザー名

削除するOSユーザーのユーザー名を指定します。

−　

入力

○　

Windows.userType

OSユーザー種別

OSユーザーの種別をローカル（local）またはドメイン（domain）で指定します。domainの場合，操作対象サーバのドメインのプライマリドメインコントローラに対して操作を行います。このプロパティはWindowsだけで有効です。

local

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

Linux.homeDirectoryDelete

ホームディレクトリの削除可否

OSユーザー削除後にユーザーのホームディレクトリを削除するかどうかをyes（削除する）またはno（削除しない）で指定します。このプロパティはエージェントサーバのOSがUNIXの場合のみ有効です。

no

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.15　OSユーザーの削除(SYSTEM)

機能

WindowsまたはUNIX環境でOSユーザーを削除します。

この部品では，次のサーバを前提とします。

・実行対象サーバ

　この部品を実行する対象となるサーバです。前提条件に記載のWindowsまたはUNIXがセットアップされている必要があります。

Windowsの場合，ローカルユーザーまたはドメインユーザーを削除できます。

削除するユーザー種別に応じてプロパティWindows.userTypeに次の値を設定します。

　・ローカルユーザーを削除する場合：local

　・ドメインユーザーを削除する場合：domain

UNIXの場合，削除するOSユーザーのホームディレクトリもあわせて削除することができます。

プロパティUNIX.homeDirectoryDeleteに次の値を設定します。

　・OSユーザーのホームディレクトリを削除する場合：yes

　・OSユーザーのホームディレクトリを削除しない場合：no

利用場面

運用に使用するOSユーザーを削除する場合などに利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

(12) AIX V6

(13) AIX V7

【実行対象サーバの使用条件】

なし。

注意事項

(1)実行対象サーバがUNIXの場合，ユーザーのホームディレクトリを削除する場合は，必要に応じてホームディレクトリに格納されたデータを退避してください。

(2) UNIX環境に対してこの部品を実行する場合は，プロパティにマルチバイト文字を使用しないでください。

バージョン

02.50.01

部品のタグ

Configure OS,Windows,Linux,AIX

タスクログに表示される部品の名称

osDeleteUser_System

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

common.osUserName

OSユーザー名

削除するOSユーザーのユーザー名を指定します。

−　

入力

○　

Windows.userType

OSユーザー種別

OSユーザーの種別をローカル（local）またはドメイン（domain）で指定します。domainの場合，操作対象サーバのドメインのプライマリドメインコントローラに対して操作を行います。このプロパティはWindowsだけで有効です。

local

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

Linux.homeDirectoryDelete

ホームディレクトリの削除可否

OSユーザー削除後にユーザーのホームディレクトリを削除するかどうかをyes（削除する）またはno（削除しない）で指定します。このプロパティはエージェントサーバのOSがUNIXの場合のみ有効です。

no

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.16　OS種別の出力

機能

この部品は，実行対象サーバのOSの種別を出力します。

実行対象サーバのOS種別に従い，次の内容を標準出力に出力します。

・OSがWindowsの場合：「OSType:Windows」

・OSがLinuxの場合：「OSType:Linux」

・OSがAIXの場合：「OSType:AIX」

・OSがHP-UXの場合：「OSType:HP-UX」

・OSがSolarisの場合：「OSType:Solaris」

利用場面

サービステンプレート内でOS種別ごとに異なる処理を行いたい場合に使用できます。

この部品の利用方法を次に説明します。

1.実行対象サーバに対してこの部品を実行する。

2.出力したOS種別を値判定分岐部品で判定する。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

(12) AIX V6

(13) AIX V7

(14) HP-UX 11i V3 (IPF)

(15) Solaris 10 (SPARC)，Solaris 11 (SPARC)

【実行対象サーバの使用条件】

なし。

バージョン

02.12.00

部品のタグ

Gather OS information,Windows,Linux,AIX,HP-UX,Solaris

タスクログに表示される部品の名称

osGetOsInfo

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

localhost

入力

○　

common.osKind

OS種別

実行対象サーバのOSの種別を表します。実行対象サーバのOSに応じて，"Windows"，"Linux"，"AIX"，"HP-UX"，または"Solaris"が格納されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.17　サーバのシャットダウン

機能

WindowsまたはLinux環境において，サーバのシャットダウンを実行します。

この部品では，次のサーバを前提とします。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

実行対象サーバのOS種別に応じたshutdownコマンドを使用して，シャットダウン(電源オフ)を実行します。

プロパティ設定の留意点を次に示します。

(1) シャットダウン理由(Windows.shutdownReasonプロパティ)には次のコードを指定します。これ以外の独自のコードを使用したい場合は，Microsoftサポートなどを参照してください。

　コード　　意味

　　0:0　　その他 (計画済)

　　1:1　　ハードウェア: メンテナンス (計画済)

　　1:2　　ハードウェア: インストール (計画済)

　　2:2　　オペレーティング システム: 回復 (計画済)

　　2:3　　オペレーティング システム: アップグレード (計画済)

　　2:4　　オペレーティング システム: 再構成 (計画済)

　　2:16　 オペレーティング システム: Service pack (計画済)

　　2:17　 オペレーティング システム: ホットフィックス (計画済)

　　2:18　 オペレーティング システム: セキュリティ フィックス (計画済)

　　4:1　　アプリケーション: メンテナンス (計画済)

　　4:2　　アプリケーション: インストール (計画済)

　　5:19　 セキュリティの問題 (計画済)

　　7:0　　レガシ API シャットダウン (計画済)

利用場面

この部品は，計画停電時やプログラムの更新ファイル適用時において，サーバを停止する場合などに利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　なし。

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) CentOS 6 (64-bit x86_64)

　(9) CentOS 7 (64-bit x86_64)

　(10) CentOS 8 (64-bit x86_64)

　(11) Oracle Linux 8 (64-bit x86_64)

【実行対象サーバの使用条件】

　なし。

注意事項

(1) 実行対象サーバの稼働OSとは関係なく，他のユーザーがログインしていても強制的にシャットダウンを実行します。他のユーザーの作業内容を保存できません。

(2) この部品は実行対象サーバでOSのshutdownコマンドが実行された時点で完了するため，この部品とシャットダウン処理は非同期に動作します。

(3) 実行対象サーバでOSのshutdownコマンドが実行されてからシャットダウン処理が始まるまでに，JP1/AOのシャットダウン事前処理のため，一定の待ち時間が発生します。所要時間は，実行対象サーバの稼働OSがWindowsの場合は180秒，Linuxの場合は1秒です。

(4) 実行対象サーバの稼働OSがWindowsの場合，プロパティには「"」(ダブルクォーテーション)を含む文字列は指定しないでください。指定した場合，この部品が異常終了します。

(5) 実行対象サーバの稼働OSがWindowsの場合，シャットダウン理由(Windows.shutdownReasonプロパティ)およびシャットダウン理由コメント(Windows.shutdownReasonCommentプロパティ)は必ず指定してください。指定していない場合，この部品が異常終了します。

(6) 実行対象サーバの稼働OSがWindowsの場合，この部品で登録されるOSのイベントログの仕様はshutdownコマンドの仕様に従います。

(7) 実行対象サーバの稼働OSがWindowsの場合，この部品は環境変数"SystemRoot"を参照して"shutdown.exe"を呼び出すため，実行対象サーバにおいてこの環境変数がOSインストール時から変更された場合，この部品が異常終了することがあります。

(8) この部品でエラーが発生した場合は，タスクログのshutdownコマンドのメッセージに従って対処してください。

実行権限

Windowsの場合：Administrator権限

Linuxの場合：root権限

バージョン

02.01.00

部品のタグ

Control OS,Windows,Linux

タスクログに表示される部品の名称

osShutdownServer

戻り値

戻り値

説明

0

正常

0以外

異常(エラー内容はタスクログで確認) shutdownコマンド異常終了

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

Windows.shutdownReason

シャットダウン理由:Windows固有

実行対象サーバのOSがWindowsの場合に，シャットダウンの理由を「x:y」の形式で指定します。OSがWindowsの場合は必須です。Linuxの場合は指定しても無視されます。

0:0

入力

△　

Windows.shutdownReasonComment

シャットダウン理由コメント:Windows固有

実行対象サーバのOSがWindowsの場合に，シャットダウンの理由コメントを511文字以内で指定します。OSがWindowsの場合は必須です。Linuxの場合は指定しても無視されます。

Server shutdown was done by this product.

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.18　サーバの再起動

機能

WindowsまたはLinux環境において，サーバの再起動を実行します。

この部品では，次のサーバを前提とします。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

実行対象サーバのOS種別に応じたshutdownコマンドを使用して，シャットダウンおよび再起動を実行します。

プロパティ設定の留意点を次に示します。

(1) シャットダウン理由(Windows.shutdownReasonプロパティ)には次のコードを指定します。これ以外の独自のコードを使用したい場合は，Microsoftサポートなどを参照してください。

　コード　　意味

　　0:0　　その他 (計画済)

　　1:1　　ハードウェア: メンテナンス (計画済)

　　1:2　　ハードウェア: インストール (計画済)

　　2:2　　オペレーティング システム: 回復 (計画済)

　　2:3　　オペレーティング システム: アップグレード (計画済)

　　2:4　　オペレーティング システム: 再構成 (計画済)

　　2:16　 オペレーティング システム: Service pack (計画済)

　　2:17　 オペレーティング システム: ホットフィックス (計画済)

　　2:18　 オペレーティング システム: セキュリティ フィックス (計画済)

　　4:1　　アプリケーション: メンテナンス (計画済)

　　4:2　　アプリケーション: インストール (計画済)

　　5:19　 セキュリティの問題 (計画済)

　　7:0　　レガシ API シャットダウン (計画済)

利用場面

この部品は，プログラムの更新ファイル適用時において，サーバをシャットダウン後に再起動する場合などに利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　なし。

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　(8) CentOS 6 (64-bit x86_64)

　(9) CentOS 7 (64-bit x86_64)

　(10) CentOS 8 (64-bit x86_64)

　(11) Oracle Linux 8 (64-bit x86_64)

【実行対象サーバの使用条件】

　なし。

注意事項

(1) 実行対象サーバの稼働OSとは関係なく，他のユーザーがログインしていても強制的にシャットダウンを実行します。他のユーザーの作業内容を保存できません。

(2) この部品は実行対象サーバでOSのshutdownコマンドが実行された時点で完了するため，この部品とシャットダウン処理は非同期に動作します。

(3) 実行対象サーバでOSのshutdownコマンドが実行されてからシャットダウン処理が始まるまでに，JP1/AOのシャットダウン事前処理のため，一定の待ち時間が発生します。所要時間は，実行対象サーバの稼働OSがWindowsの場合は180秒，Linuxの場合は1秒です。

(4) 実行対象サーバの稼働OSがWindowsの場合，プロパティには「"」(ダブルクォーテーション)を含む文字列は指定しないでください。指定した場合，この部品が異常終了します。

(5) 実行対象サーバの稼働OSがWindowsの場合，シャットダウン理由(Windows.shutdownReasonプロパティ)およびシャットダウン理由コメント(Windows.shutdownReasonCommentプロパティ)は必ず指定してください。指定していない場合，この部品が異常終了します。

(6) 実行対象サーバの稼働OSがWindowsの場合，この部品で登録されるOSのイベントログの仕様はshutdownコマンドの仕様に従います。

(7) 実行対象サーバの稼働OSがWindowsの場合，この部品は環境変数"SystemRoot"を参照して"shutdown.exe"を呼び出すため，実行対象サーバにおいてこの環境変数がOSインストール時から変更された場合，この部品が異常終了することがあります。

(8) この部品でエラーが発生した場合は，タスクログのshutdownコマンドのメッセージに従って対処してください。

実行権限

Windowsの場合：Administrator権限

Linuxの場合：root権限

バージョン

02.01.00

部品のタグ

Control OS,Windows,Linux

タスクログに表示される部品の名称

osRebootServer

戻り値

戻り値

説明

0

正常

0以外

異常(エラー内容はタスクログで確認) shutdownコマンド異常終了

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

Windows.shutdownReason

シャットダウン理由:Windows固有

実行対象サーバのOSがWindowsの場合に，再起動またはシャットダウンの理由を「x:y」の形式で指定します。OSがWindowsの場合は必須です。Linuxの場合は指定しても無視されます。

0:0

入力

△　

Windows.shutdownReasonComment

シャットダウン理由コメント:Windows固有

実行対象サーバのOSがWindowsの場合に，再起動またはシャットダウンの理由コメントを511文字以内で指定します。OSがWindowsの場合は必須です。Linuxの場合は指定しても無視されます。

Server shutdown was done by this product.

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.19　テキストファイルの文字列抽出

機能

この部品は，WindowsまたはUNIXの実行対象サーバにおいて，指定したテキストファイルの指定した1行を出力プロパティに設定します。テキストから抽出した1行の長さが1024バイトを超える場合，1025バイト以降の文字列は切り捨てられます。

該当する行が存在しない場合(例えば，20行しか書かれていないテキストファイルに対して21行目を指定する)，出力プロパティには空文字が設定されます。

この部品では，次のサーバを前提とします。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

この部品内のスクリプトでは次に示す処理を行います。

・対象ファイルのパス(common.targetFilePathプロパティ)に指定したファイルのパス確認を行います。

・次のコマンドを実行します。

-Windows

　 New-Object System.IO.StreamReader("対象ファイルのパス(common.targetFilePathプロパティ)", [System.Text.Encoding]::Default)

上記コマンドで取得したStreamReaderオブジェクトのreadLineメソッドを用いて行番号(common.lineNumプロパティ)に指定した1行の文字列を取得します。

　StreamReaderクラスのreadLineメソッドの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。

-UNIX

head -n 行番号(common.lineNumプロパティ) "対象ファイルのパス(common.targetFilePathプロパティ)" | tail -n 1

　head，tailコマンドの詳細については，OSのmanコマンドで取得できるコマンド情報を参照してください。

利用場面

テキストファイルの一部を出力プロパティに設定し，別部品の入力プロパティとして利用する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

【実行対象サーバの使用条件】

なし。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) 対象ファイルのパス(common.targetFilePathプロパティ)にワイルドカードによる指定はできません。

(3) エージェントレス接続先に定義された接続ユーザーに，指定したファイルに対する読み取り許可が必要です。

バージョン

02.00.00

部品のタグ

Gather OS information,Windows,Linux

タスクログに表示される部品の名称

osFileOutputProperty

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.targetFilePath

対象ファイルのパス

対象ファイルをフルパスで指定します。

−　

入力

○　

common.lineNum

行番号

文字列を抽出する行を指定します。

−　

入力

○　

common.stdOutValue

抽出した文字列

ファイルから抽出した文字列が格納されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.20　ファイルのコピー

機能

この部品は，指定したパスのファイルまたはフォルダを，指定したファイルまたはフォルダにコピーします。

この部品では，次のサーバを前提とします。

・実行対象サーバ

　ファイルまたはフォルダのコピーを実行するサーバです。

実行対象サーバのOSがUNIXの場合，プロパティcommon.permissionOptionに1を設定することで，オーナー，グループ，パーミッション，タイムスタンプを保持したままコピーを実行します。UNIXにおいてこれらの属性の保持を行わずにコピーを実行したい場合，またはOSがWindowsの場合は該当プロパティの値を0に設定してください。

利用場面

アプリケーションの定義ファイルを退避する，コマンドの実行結果をファイル出力してコピーするなどに利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

(12) AIX V6

(13) AIX V7

【実行対象サーバの使用条件】

なし。

注意事項

(1)プロパティcommon.destFilePathに既存のファイルやフォルダを指定した場合，上書きコピーを実行します。

(2)プロパティcommon.sourceFilePathに指定したフォルダに隠しファイルが含まれる場合，隠しファイルはコピーされません。

バージョン

03.01.01

部品のタグ

Control OS,Windows,Linux,AIX

タスクログに表示される部品の名称

osCopyFile

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

localhost

入力

○　

common.sourceFilePath

コピー元ファイルのフルパス

コピー元ファイルまたはフォルダをフルパスで指定します。

−　

入力

○　

common.destFilePath

コピー先ファイルのフルパス

コピー先ファイルまたはフォルダをフルパスで指定します。

−　

入力

○　

common.permissionOption

ファイルの属性を保持するかどうか

ファイルの属性(mode,ownership,timestamps)をコピーするかどうかを指定します。コピーする場合は1,コピーしない場合は0を指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.21　ファイルのサイズ取得

機能

この部品は，指定したパスのサブフォルダを含めたすべてのファイルの合計のファイルサイズをプロパティへ出力します。

対象パス(common.targetPathプロパティ)には，ワイルドカードを使用したファイルまたはフォルダのパスは指定できません。

出力プロパティは，ファイルサイズとファイルサイズの単位を出力します。

ファイルサイズの単位(common.fileSizeUnitプロパティ)に指定可能な単位として "B"，"KB"，"MB"，"GB"，"TB"を指定できます。指定可能な単位以外を指定した場合は，部品は異常終了します。

"B"以外を指定した場合には，1024ごとに単位が変更されるように計算し，小数点第3位以下は切り捨てられ，小数点第2位まで出力します。

利用場面

他の部品によって作成したファイルまたはフォルダのファイルサイズを確認する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・bcパッケージがインストールされていること。

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・bcパッケージがインストールされていること。

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

　・bcパッケージがインストールされていること。

(10) CentOS 8 (64-bit x86_64)

　・bcパッケージがインストールされていること。

(11) Oracle Linux 8 (64-bit x86_64)

　・bcパッケージがインストールされていること。

【実行対象サーバの使用条件】

なし。

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)実行対象サーバがWindowsの場合は，対象フォルダ配下のファイルやサブフォルダの一部が権限設定などによって参照できない場合に，部品が異常終了します。

(3)実行対象サーバがWindowsの場合，対象フォルダの配下にフォルダへのシンボリックリンクがあると，シンボリックリンクをたどってリンク先のファイルサイズを取得します。シンボリックリンクが上位のフォルダにリンクされている場合は，部品が異常終了します。

バージョン

02.00.00

部品のタグ

Gather OS information,Windows,Linux

タスクログに表示される部品の名称

osMeasureFileSize

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.targetPath

対象パス

対象のファイルまたはフォルダをフルパスで指定します。

−　

入力

○　

common.fileSizeUnit

ファイルサイズの単位

出力するファイルサイズの単位を指定します。指定可能な単位は"B"，"KB"，"MB"，"GB"，"TB"です。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

common.outputFileSize

出力ファイルサイズ

出力するファイルまたはフォルダのサイズを格納します。

−　

出力

−　

common.outputFileSizeUnit

出力ファイルサイズの単位

出力するファイルサイズの単位を格納します。

−　

出力

−　

4.13.22　ファイルの圧縮

機能

この部品は，WindowsまたはUNIX環境の実行対象サーバにおいて，指定したファイルおよびフォルダを圧縮します。実行対象サーバがWindowsの場合はzip，実行対象サーバがUNIXの場合はtarでアーカイブしたあとにgzipで圧縮します。ファイルの拡張子は，実行対象サーバがWindowsの場合は「zip」，実行対象サーバがUNIXの場合は「tgz」となります。出力ファイル名は圧縮対象のファイル名(Windowsの場合は拡張子を除いたファイル名)またはフォルダ名に拡張子を付加したものとなります。圧縮されたファイルおよびフォルダは，出力先のフォルダパス(common.outputDestFolderPathプロパティ)に指定したフォルダ配下に出力されます。圧縮対象のファイルパス(common.compressSourceFilePathプロパティ)で指定したパス先のファイルおよびフォルダについては，削除されません。圧縮対象のファイルパス(common.compressSourceFilePathプロパティ)には，ワイルドカードを使用したファイルのパスは指定できません。

圧縮対象のファイルパス(common.compressSourceFilePathプロパティ)について，次に示します。

・圧縮対象のファイルまたはフォルダをフルパスで指定してください。

出力先のフォルダパス(common.outputDestFolderPathプロパティ)について，次に示します。

・出力先のフォルダをフルパスで指定してください。フォルダパスが存在しない場合は，この部品でフォルダを作成します。

利用場面

ログファイルなどのデータを圧縮し，別のサーバに転送する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

【実行対象サーバの使用条件】

　実行対象サーバがWindowsの場合は，.NET Framework 4.5.2以降とWindows PowerShell 3.0以降がインストールされていること。

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)実行対象サーバがUNIXの場合は，プロパティに半角の「¥」を使用しないでください。

(3)複数のファイルおよびフォルダを圧縮対象のファイルパス(common.compressSourceFilePathプロパティ)に指定することはできません。

(4)ショートカットとシンボリックリンクを圧縮対象のファイルパス(common.compressSourceFilePathプロパティ)に指定することはできません。

(5)実行対象サーバがWindowsの場合は，上位のフォルダにリンクされているシンボリックリンクを含むフォルダを圧縮対象のファイルパス(common.compressSourceFilePathプロパティ)に指定することはできません。部品が異常終了します。

(6)実行対象サーバがUNIXの場合は，圧縮コマンド失敗時に出力先のフォルダパス(common.outputDestFolderPathプロパティ)にjp1ao_plug-in_error.logというファイルを作成し，エラー内容を出力します。不要な場合は削除してください。なお，jp1ao_plug-in_error.logは上書きされます。

(7)部品が異常終了して次のエラーがタスクログに表示された場合は，jp1ao_plug-in_error.logを参照して，エラー要因を取り除いてください。「KNAE08132-E コマンドの標準出力のサイズが上限値を超えたため，処理を中断しました（上限値：100キロバイト）。」

(8)実行対象サーバがWindowsの場合はドライブパス，実行対象サーバがUNIXの場合はルートを圧縮対象のファイルパス(common.compressSourceFilePathプロパティ)に指定することはできません。

(9)圧縮対象のファイルパス(common.compressSourceFilePathプロパティ)に指定したフォルダまたはフォルダ配下を出力先のフォルダパス(common.outputDestFolderPathプロパティ)に指定することはできません。部品が異常終了します。

(10)出力先のフォルダパス(common.outputDestFolderPathプロパティ)に出力ファイル名と同名のファイルが既に存在する場合は上書きしません。部品が異常終了します。

(11)実行対象サーバがWindowsの場合は，出力先のフォルダパスが「248文字以上」，出力先のフォルダパスと出力ファイル名の合計が「260文字以上」となると圧縮できません。部品が異常終了します。

(12)ファイル単体を圧縮する場合はメモリ容量に依存するため圧縮できない場合があります。ファイル容量が大きい場合はフォルダに格納してから圧縮してください。

(13)この部品は同期処理のため，圧縮が完了するまで待つ必要があります。

(14)圧縮に掛かる時間は，ファイルの容量に比例します。

バージョン

02.00.00

部品のタグ

Control OS,Windows,Linux

タスクログに表示される部品の名称

osCompressFile

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.compressSourceFilePath

圧縮対象のファイルパス

圧縮対象のファイルまたはフォルダをフルパスで指定してください。

−　

入力

○　

common.outputDestFolderPath

出力先のフォルダパス

出力先のフォルダをフルパスで指定してください。

−　

入力

○　

common.returnCompressFilePath

圧縮ファイルパス

出力した圧縮ファイルのフルパスが格納されます。

−　

出力

−　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

4.13.23　ファイルの解凍

機能

この部品は，WindowsまたはUNIX環境の実行対象サーバにおいて，指定した圧縮ファイルを解凍します。実行対象サーバがWindowsの場合はzipファイル，実行対象サーバがUNIXの場合はtarでアーカイブしたあとにgzipで圧縮されたファイルを解凍します。出力ファイル名は圧縮前のファイル名またはフォルダ名となります。解凍されたファイルは，出力先のフォルダパス(common.outputDestFolderPathプロパティ)に指定したフォルダ配下に出力されます。解凍対象のファイルパス(common.uncompressSourceFilePathプロパティ)で指定したパス先の圧縮ファイルについては，削除されません。解凍対象のファイルパス(common.uncompressSourceFilePathプロパティ)には，ワイルドカードを使用したファイルのパスは指定できません。

解凍対象のファイルパス(common.uncompressSourceFilePathプロパティ)について，次に示します。

・解凍対象の圧縮ファイルをフルパスで指定してください。

出力先のフォルダパス(common.outputDestFolderPathプロパティ)について，次に示します。

・出力先のフォルダをフルパスで指定してください。フォルダパスが存在しない場合は，この部品でフォルダを作成します。

利用場面

圧縮ファイルを解凍する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

【実行対象サーバの使用条件】

　実行対象サーバがWindowsの場合は，.NET Framework 4.5.2以降とWindows PowerShell 3.0以降がインストールされていること。

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)実行対象サーバがUNIXの場合は，プロパティに半角の「¥」を使用しないでください。

(3)複数の圧縮ファイルを解凍対象のファイルパス(common.uncompressSourceFilePathプロパティ)に指定することはできません。

(4)出力先のフォルダパス(common.outputDestFolderPathプロパティ)に出力ファイル名と同名のファイルが既に存在する場合は上書きしません。部品が異常終了します。

(5)実行対象サーバがWindowsの場合は，出力先のフォルダパスが「248文字以上」，出力先のフォルダパスと出力ファイル名の合計が「260文字以上」となると解凍できません。解凍途中で異常終了した場合は，正常に解凍されたファイルだけ残ります。

(6)この部品は同期処理のため，解凍が完了するまで待つ必要があります。

(7)解凍に掛かる時間は，ファイルの容量に比例します。

バージョン

02.00.00

部品のタグ

Control OS,Windows,Linux

タスクログに表示される部品の名称

osUncompressFile

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.uncompressSourceFilePath

解凍対象のファイルパス

解凍対象の圧縮ファイルをフルパスで指定してください。

−　

入力

○　

common.outputDestFolderPath

出力先のフォルダパス

出力先のフォルダをフルパスで指定してください。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

4.13.24　ファイルの最終更新日時取得

機能

この部品は，指定したパスのファイルまたはフォルダの最終更新日時をプロパティへ出力します。

対象パス(common.targetPathプロパティ)には，ワイルドカードを使用したファイルまたはフォルダのパスは指定できません。

最終更新日時のフォーマット(common.lastModifiedDateFormatプロパティ)について次に示します。

・64文字以内の文字列を指定してください。

・最終更新日時のフォーマット(common.lastModifiedDateFormatプロパティ)に指定された文字列内の変換指定文字は，対応する値に変換されます。

　ただし，変換指定文字以外の文字列は，変換されずそのままファイルの最終更新日時(common.lastModifiedDateプロパティ)に格納します。

　変換指定文字の例を次に示します。

　[変換指定文字]

　　%Y　世紀部分を含めた4桁の西暦年。

　　%y　西暦の下2桁。世紀部分を含まない年。1桁の場合には前に0を設定する。

　　%m　月。1桁の場合には前に0を設定する。

　　%d　日。1桁の場合には前に0を設定する。

　　%H　24時間表記での時。1桁の場合には前に0を設定する。

　　%I　12時間表記での時。1桁の場合には前に0を設定する。

　　%M　分。1桁の場合には前に0を設定する。

　　%S　秒。1桁の場合には前に0を設定する。

　　%s　1970-01-01 00:00:00 UTC からの秒数

ファイル更新待合せの要否(common.waitFileModifiedForChangeプロパティ)に"true"を指定した場合，ファイル更新待合せ間隔(common.waitFileModifiedIntervalプロパティ)に指定した秒数待ち，ファイルまたはフォルダの最終更新日時が最初に取得した値から変更されたか確認する動作をファイル更新待合せ回数(common.waitFileModifiedCountプロパティ)に指定した回数実行します。指定した回数の実行までに最終更新日時が変更された場合，変更後の値をファイルの最終更新日時(OS.lastModifiedDateプロパティ)に出力し，最終更新日時の再取得結果(common.reacquisitionResultLastModifiedDateプロパティ)に"true"を格納して部品が正常終了します。指定した回数実行しても最終更新日時が変更されない場合は，最初に取得した最終更新日時をファイルの最終更新日時(common.lastModifiedDateプロパティ)に出力し，最終更新日時の再取得結果(commonreacquisitionResultLastModifiedDateプロパティ)に"false"を格納して部品が正常終了します。

ファイル更新待合せの要否(common.waitFileModifiedForChangeプロパティ)に"true"以外を指定した場合，指定したパスのファイルまたはフォルダの最終更新日時をファイルの最終更新日時(common.lastModifiedDateプロパティ)に出力し，最終更新日時の再取得結果(common.reacquisitionResultLastModifiedDateプロパティ)に"false"を格納して部品が正常終了します。

利用場面

・他の部品実行によってファイルを更新する場合に，ファイルが更新されたことを確認できます。

・他システムによってファイルの更新を待って後続の部品の処理を実行するなどの場合に，この部品で待合わせることができます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

【実行対象サーバの使用条件】

なし。

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)実行対象サーバがWindowsの場合は，最終更新日時のフォーマット(OS.lastModifiedDateFormatプロパティ)に「{」，「}」を使用しないでください。指定した場合，この部品が異常終了します。

(3)機能説明に記載している変換指定文字以外の変換指定文字も使用できます。実行対象サーバがWindowsの場合は，PowerShellのGet-Dateコマンドレット(-UFormatオプション)のマニュアルを確認してください。UNIXの場合は，dateコマンドのマニュアルを確認してください。ただし，「%n」や「%t」などの制御文字に変換される変換指定文字は指定しないでください。

(4)ファイルの最終更新日時(OS.lastModifiedDateプロパティ)に「%」を出力する場合は，最終更新日時のフォーマット(OS.lastModifiedDateFormatプロパティ)に「%%」と指定してください。

(5)実行対象サーバがWindowsの場合はlastModifiedDateFormatに%を単独で指定しないでください。指定した場合，部品が異常終了します。

バージョン

02.00.00

部品のタグ

Gather OS information,Windows,Linux

タスクログに表示される部品の名称

osGetModifiedDate

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.targetPath

対象パス

対象のファイルまたはフォルダをフルパスで指定します。

−　

入力

○　

common.lastModifiedDateFormat

最終更新日時のフォーマット

指定したファイルまたはフォルダの最終更新日時のフォーマットを指定します。

%Y-%m-%dT%H:%M

入力

○　

common.waitFileModifiedForChange

ファイル更新待合せの要否

指定したファイルまたはフォルダの更新を待合せる場合は"true"を指定します。"true"以外の場合は，フォルダの更新を待ち合わせずに現在の最終更新日時を出力して終了します。

false

入力

△　

common.waitFileModifiedCount

ファイル更新待合せ回数

指定したファイルまたはフォルダの更新を確認する回数を1〜192で指定します。ファイル更新待合せを実行する場合は必ず指定してください。

−　

入力

△　

common.waitFileModifiedInterval

ファイル更新待合せ間隔

指定したファイルまたはフォルダの更新を確認する間隔(秒)を1〜3600で指定します。ファイル更新待合せを実行する場合は必ず指定してください。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

common.lastModifiedDate

ファイルの最終更新日時

指定したファイルまたはフォルダの最終更新日時が指定された形式で格納されます。

−　

出力

−　

common.reacquisitionResultLastModifiedDate

最終更新日時の再取得結果

最終更新日時を再取得できた場合は"true"，再取得できなかった場合は"false"が格納されます。

−　

出力

−　

4.13.25　ファイルの文字エンコード変換

機能

この部品は，対象のテキストファイルを指定した変換前の文字エンコードで読み込み，指定した変換後の文字エンコードで別のテキストファイルに出力します。

対象ファイルパス(common.targetFilePathプロパティ)には，ワイルドカードを使用したファイルのパスは指定できません。

文字エンコード種別(変換前)(common.characterEncodingFromプロパティ)に指定された文字エンコード種別で対象ファイルパス(common.targetFilePathプロパティ)に指定されたファイルを読み込み，出力ファイルのパス(common.outputFilePathプロパティ)に指定されたパスに文字エンコード種別(変換後)(common.characterEncodingToプロパティ)に指定された文字エンコード種別でファイルを出力します。

出力先ファイルパス(common.outputFilePathプロパティ)に指定されたパスにフォルダが存在しない場合，フォルダを作成します。

また，出力ファイルのパス(common.outputFilePathプロパティ)に指定したパスに既にファイルが存在する場合は，部品は異常終了します。

指定できるエンコード種別は"JIS"，"SJIS"，"EUC-JP"，"UTF-8"の4種類です。これ以外のエンコード種別を指定した場合は，部品は異常終了します。また，文字エンコード種別(変換後)(common.characterEncodingToプロパティ)に"UTF-8"を指定した場合は，BOM無しでテキストファイルに出力します。

利用場面

OS間のファイル移動などの際に，特定の文字エンコード種別で出力されたファイルを，移動先で使用できる文字エンコード種別へ変換したい場合などに使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

【実行対象サーバの使用条件】

なし。

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)変換する文字エンコード種別によっては，OS間で文字コードが異なり，文字化けする場合があります。

(3)実行対象サーバがUNIXの場合，BOM有りのUTF-8のテキストファイルを変換前の対象ファイルに指定しないでください。その場合，部品が異常終了したり，変換後のテキストファイルが文字化けする場合があります。

(4)対象のファイルパス(common.targetFilePathプロパティ)で指定したファイルが空の場合，実行対象サーバがWindowsの場合は出力ファイルのパス(common.outputFilePathプロパティ)で指定した場所に空ファイルを作成し，UNIXの場合はファイルの作成を行いません。

(5)文字エンコード種別の変換対象として機種依存文字および文字エンコード種別の範囲外の文字を指定しないでください。その場合，部品が異常終了したり，変換後のテキストファイルが文字化けする場合があります。

(6)対象のファイルパス(common.targetFilePathプロパティ)で指定したファイル内の文字の文字エンコード種別と文字エンコード種別(変換前)(common.characterEncodingFrom)で指定した文字エンコード種別は同一のものを指定してください。別の文字エンコード種別を指定した場合，部品が異常終了したり，文字化けが発生するおそれがあります。

バージョン

02.00.00

部品のタグ

Control OS,Windows,Linux

タスクログに表示される部品の名称

osConvertFileCharacterEncoding

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.targetFilePath

対象ファイルのパス

対象ファイルをフルパスで指定します。

−　

入力

○　

common.characterEncodingFrom

文字エンコード種別(変換前)

変換対象ファイルの文字エンコード種別として"JIS"，"SJIS"，"EUC-JP"，"UTF-8"のどれかを指定します。

−　

入力

○　

common.characterEncodingTo

文字エンコード種別(変換後)

変換後の文字エンコード種別として"JIS"，"SJIS"，"EUC-JP"，"UTF-8"のどれかを指定します。

−　

入力

○　

common.outputFilePath

出力ファイルのパス

出力するファイルをフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

4.13.26　ファイルまたはフォルダのアクセス権限取得

機能

この部品は，WindowsまたはUNIXの実行対象サーバにおいて，指定したファイルの権限情報をファイルに出力します。フォルダを指定した場合は,指定したフォルダの権限情報を出力します。

ファイルの出力フォーマットは次のようになります。複数のファイルの権限情報を出力する場合は改行を行い，下に追加していきます。

・Windows

　"Path","AccessToString"

　"<対象ファイルのパス>","<ユーザー> Deny <権限>：<ユーザー> Allow <権限>"

*Windowsの場合はファイルが持つユーザーごとの権限がすべて出力されます。

・UNIX

　<対象ファイルのパス>,<アクセス権(数字)>,<アクセス権(記号)>,<所有者のユーザー名>,<所有者のグループ名>

アクセス権限(数字)は，左から所有者のアクセス権限，グループのアクセス権限，その他のアクセス権限を意味します。

アクセス権限(記号)は，左からファイルのパス(common.targetFilePathプロパティ)に指定したパスがファイル(-)かフォルダ(d)かシンボリック・リンク(l)かを示す記号，所有者のアクセス権限，グループのアクセス権限，その他のアクセス権限を意味します。

アクセス権限(数字)，アクセス権限(記号)で用いる数字と記号の説明は次の通りです。

　数字：記号：数字，記号の説明

　　　： -：ファイルを示す記号

　　　： d：フォルダを示す記号

　　　： l：シンボリック・リンクを示す記号

　　 0： ---：いずれのアクセス権限も設定しない

　　 1： --x：実行権限

　 　2： -w-：書き込み権限

　 　3： -wx：実行権限，書き込み権限

　 　4： r--：読み込み権限

　 　5： r-x：実行権限，読み込み権限

　 　6： rw-：書き込み権限，読み込み権限

　 　7： rwx：実行権限，書き込み権限，読み込み権限

　(例)アクセス権(数字),アクセス権(記号)：644,-rw-r--r--

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

この部品内のスクリプトでは次に示す処理を行います。

・対象ファイルのパス(common.targetFilePathプロパティ)，出力先ファイルパス(common.destinationFilePathプロパティ)に指定したファイルのパス確認を行います。

・次のコマンドを実行します。

-Windows

　 Get-Acl -Path "対象ファイルのパス(common.targetFilePathプロパティ)"

　Get-Aclコマンドレットの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。

-UNIX

stat -c%n,%a,%A,%U,%G 対象ファイルのパス(common.targetFilePathプロパティ)

　statコマンドの詳細については，OSのmanコマンドで取得できるコマンド情報を参照してください。

・ファイルのアクセス権を出力先ファイルパス(common.destinationFilePathプロパティ)へ上書きします。ファイルが存在しない場合はファイルを作成します。

利用場面

「ファイルまたはフォルダのアクセス権限変更」部品を使用後にエビデンスとして指定したファイルのアクセス権を記載したファイルを残す場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

【実行対象サーバの使用条件】

なし。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) 実行対象サーバの稼働OSがWindowsの場合，エージェントレス接続先に定義された接続ユーザーに，指定したファイルに対する読み取り許可が必要です。

(3) 対象ファイルのパス(common.targetFilePathプロパティ)のみワイルドカード(*，?，[，])の使用を許可します。

(4) この部品はドライブやレジストリは対象としていません。そのため，対象ファイルのパス(common.targetFilePathプロパティ)にドライブやレジストリは指定しないでください。

(5) 実行対象サーバの稼働OSがUnixの場合，対象ファイルのパス(common.targetFilePathプロパティ)に半角スペースを含むパスを指定しないでください。指定した場合，この部品が異常終了します。

(6) 出力先ファイルパス(common.destinationFilePathプロパティ)に指定したファイルが既に存在する場合，既存のファイルを上書きします。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(7) 出力先ファイルパス(common.destinationFilePathプロパティ)のパス上にフォルダが存在しない場合は，フォルダを作成し，その配下に結果を出力します。

バージョン

02.00.01

部品のタグ

Gather OS information,Windows,Linux

タスクログに表示される部品の名称

osGetPermission

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.targetFilePath

対象ファイルのパス

対象ファイルをフルパスで指定します。

−　

入力

○　

common.destinationFilePath

出力先ファイルパス

出力先のファイルパスをフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.27　ファイルまたはフォルダの存在確認

機能

WindowsまたはUNIXの実行対象サーバにおいて，指定したファイルが存在するか確認します。

存在の確認対象にフォルダも指定できます。その場合は，確認対象ファイル名(common.targetFileNameプロパティ)にフォルダを指定してください。

指定されたファイルの存在を確認した結果は，存在確認結果(common.validationResultプロパティ)に，true(見つかった場合)またはfalse(見つからなかった場合)を格納します。

確認対象ファイル名(common.targetFileNameプロパティ)について次に示します。

・256文字以内の文字列を指定してください。

確認したファイルの情報(common.validationResultInformationプロパティ)について次に示します。

・存在確認結果(common.validationResultプロパティ)がtrueの場合に，確認したファイル(フォルダ)の情報を格納します。

・実行対象サーバがWindowsの場合，PowerShellのGet-ItemPropertyコマンドレットの結果を格納します。

・実行対象サーバがUNIXの場合，lsコマンド(-lオプション，-dオプション)の結果を格納します。

利用場面

ファイルまたはフォルダの存在を確認する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

(12) AIX V6

(13) AIX V7

【実行対象サーバの使用条件】

なし。

注意事項

(1)確認対象ファイル名(common.targetFileNameプロパティ)に「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「'」，「[」，「]」，「`」を使用しないでください。

(2)この部品は通常のファイルまたはフォルダを対象としています。そのため，ドライブやレジストリなどは，ファイルやフォルダとして扱いません。

(3)複数のファイルおよびフォルダを確認対象にすることはできません。

バージョン

02.02.00

部品のタグ

Gather OS information,Windows,Linux,AIX

タスクログに表示される部品の名称

osValidationFileAndFolder

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.targetFileName

確認対象ファイル名

存在を確認するファイル名またはフォルダ名をフルパスで指定します。

−　

入力

○　

common.validationResult

存在の確認結果

存在を確認した結果を格納します。ファイルが存在する場合はtrue，存在しなかった場合はfalseが格納されます。

−　

出力

△　

common.validationResultInformation

確認したファイルの情報

存在を確認したファイルの情報を格納します。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.28　ファイル移動

機能

この部品は，指定したパスのファイルまたはフォルダを，指定したファイルまたはフォルダに移動します。

移動元の対象パス(common.sourceMoveTargetPathプロパティ)や移動先の対象パス(common.destMoveTargetPathプロパティ)には，ワイルドカードを使用したファイルまたはフォルダのパスは指定できません。

移動先に同名のファイルまたはフォルダがある場合は，上書きしないで部品が異常終了となります。

また，移動先の対象パス上にフォルダが存在しない場合は，フォルダを作成します。

実行対象サーバがWindowsの場合，同じドライブ間の移動の場合は，"move"コマンドを使用し，異なるドライブ間の移動の場合は，"xcopy"コマンドで対象先パスにコピーしたあと，"del"コマンドまたは"rmdir"コマンドで移動元を削除します。

実行対象がUNIXの場合，"mv"コマンドを使用して，ファイルまたはフォルダを移動させます。

移動先に指定するパスは，移動元がフォルダであった場合はフォルダパスとして扱い，移動元がファイルであった場合はファイルパスとして扱います。

利用場面

ファイルまたはフォルダを，別のファイルまたはフォルダに移動する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

【実行対象サーバの使用条件】

なし。

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)移動元の対象パス(common.sourceMoveTargetPathプロパティ)および移動先の対象パス(common.destMoveTargetPathプロパティ)に，Windowsの場合はドライブだけの指定，UNIXの場合はルートだけ指定した場合，部品は異常終了します。

(3)部品の実行対象がWindowsの場合で異なるドライブ間にファイルまたはフォルダを移動する場合に，移動するファイルまたはフォルダの容量によって時間が掛かる場合があります。

(4)ファイル・フォルダを移動するコマンドが失敗した場合，移動元の対象パスのファイルまたはフォルダが壊れる可能性があります。移動元の対象パスのファイルまたはフォルダを移動する前にバックアップを取得することを推奨します。

(5)実行対象がWindowsで同じドライブ間の移動を行う際，移動元がファイルの場合でかつ移動先のパスの長さが259文字を超えた場合は，部品が異常終了します。移動元がフォルダの場合で，移動後に移動先パスの長さがフォルダの作成限界のパス長(247文字)およびファイルの作成限界のパス長(259文字)を超える場合でも部品の実行は可能です。ただし，部品は正常終了しますが，移動後に名前が変更できないなどの不具合が発生するのでフォルダの作成限界のパス(247文字)およびファイルの作成限界のパス(259文字)を超えて移動することは推奨しません。

(6)実行対象がWindowsの場合で異なるドライブ間の移動の場合は，読み込み禁止のファイルまたはフォルダは移動できません。その場合，部品が異常終了し，移動先のコピー途中のファイルとフォルダは削除されませんので，不要な場合は実行対象サーバにログインし手動で削除してください。

バージョン

02.00.00

部品のタグ

Control OS,Windows,Linux

タスクログに表示される部品の名称

osMoveFile

戻り値

戻り値

説明

0

正常

1

異常(コピー完了後エラー検知) 移動先へのコピー完了後，移動元削除中にエラーを検知

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.sourceMoveTargetPath

移動元の対象パス

移動元のファイルまたはフォルダをフルパスで指定します。

−　

入力

○　

common.destMoveTargetPath

移動先の対象パス

移動先のファイルまたはフォルダをフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

4.13.29　ファイル一覧の取得

機能

この部品は，指定したパスのファイルまたはフォルダ配下のファイルおよびフォルダの情報を，指定したパスにテキストファイルとして出力します。

対象パス(common.targetPathプロパティ)や出力ファイルのパス(common.outputFilePathプロパティ)には，ワイルドカードを使用したファイルまたはフォルダのパスは指定できません。

出力結果は，実行対象サーバがWindowsの場合は"dir /Q"コマンド，UNIXの場合は"ls -la"コマンドの実行結果の形式で出力されます。また，隠しファイルやシステムファイルの情報も出力します。

サブフォルダ配下の情報取得(common.showAllFileListプロパティ)に「true」を指定した場合，サブフォルダも含めたすべてのファイル情報を出力します。「true以外」を指定した場合は，指定したパスのサブフォルダ配下のファイルの情報を出力しません。

指定した出力ファイルのパス上にフォルダが存在しない場合は，フォルダを作成し，その配下に結果を出力します。また，同名のファイルが既に存在する場合にはファイルを上書きします。

利用場面

他の部品によって作成したファイルの作成確認などに使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

(12) AIX V6

(13) AIX V7

【実行対象サーバの使用条件】

なし。

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)サブフォルダも含めたすべてのファイル情報を出力する場合，完了まで長時間を要することがあります。

(3)実行対象サーバがWindowsの場合，対象フォルダの配下にフォルダへのシンボリックリンクがあると，シンボリックリンクをたどってリンク先のファイルおよびフォルダの情報を取得します。シンボリックリンクが上位のフォルダにリンクされている場合は，部品は正常終了しますが，取得結果が不正になります。

バージョン

02.02.00

部品のタグ

Gather OS information,Windows,Linux,AIX

タスクログに表示される部品の名称

osShowFileList

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.targetPath

対象パス

対象のファイルまたはフォルダをフルパスで指定します。

−　

入力

○　

common.showAllFileList

サブフォルダ配下の情報取得

サブフォルダも含めたすべてのファイル情報を取得したい場合は「true」を指定します。「true以外」の場合は，サブフォルダ配下のファイル情報を取得しません。

false

入力

△　

common.outputFilePath

出力ファイルのパス

出力するファイルをフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

4.13.30　ファイル削除

機能

この部品は，指定した実行対象サーバの指定したパスに存在するファイルを削除します。

実行対象サーバのOSがWindowsの場合，この部品の実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。実行対象サーバにAdministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行う部品「ファイル削除(SYSTEM)」を実行してください。

利用場面

ファイル転送部品によって転送したファイルを削除する場合や，ほかの部品によって出力されたファイルを削除する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

(12) AIX V6

(13) AIX V7

【実行対象サーバの使用条件】

なし。

注意事項

(1)この部品はファイルだけ削除できます。フォルダやディレクトリは削除できません。フォルダやディレクトリの削除を行う場合は，osDeleteFolder部品を使用してください。

バージョン

02.00.00

部品のタグ

Control OS,Windows,Linux,AIX

タスクログに表示される部品の名称

osDeleteFile

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.filePath

ファイルパス

削除するファイルをフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.31　ファイル削除(SYSTEM)

機能

この部品は，指定した実行対象サーバの指定したパスに存在するファイルを削除します。

利用場面

ファイル転送部品によって転送したファイルを削除する場合や，ほかの部品によって出力されたファイルを削除する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

(12) AIX V6

(13) AIX V7

【実行対象サーバの使用条件】

なし。

注意事項

(1)この部品はファイルだけ削除できます。フォルダやディレクトリは削除できません。フォルダやディレクトリの削除を行う場合は，osDeleteFolder部品を使用してください。

バージョン

02.50.01

部品のタグ

Control OS,Windows,Linux,AIX

タスクログに表示される部品の名称

osDeleteFile_System

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.filePath

ファイルパス

削除するファイルをフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.32　フォルダ作成

機能

WindowsまたはUNIX環境で，指定したパスにフォルダを作成します。すでに存在するフォルダを指定した場合は，何も実行せず正常終了します。

この部品では，次のサーバを前提とします。

・実行対象サーバ

　この部品を実行する対象となるサーバです。前提条件に記載のWindowsまたはUNIXがセットアップされている必要があります。

利用場面

ファイルを生成する部品の前処理や後処理で，格納用のフォルダを作成する場合などに利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

(12) AIX V6

(13) AIX V7

【実行対象サーバの使用条件】

なし。

バージョン

02.00.00

部品のタグ

Control OS,Windows,Linux,AIX

タスクログに表示される部品の名称

osCreateFolder

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

common.folderPath

フォルダパス

作成するフォルダのパスをフルパスで指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.33　フォルダ削除

機能

WindowsまたはUNIX環境で，指定したパスのフォルダを削除します。

この部品では，次のサーバを前提とします。

・実行対象サーバ

　この部品を実行する対象となるサーバです。前提条件に記載のWindowsまたはUNIXがセットアップされている必要があります。

利用場面

ファイル格納用の一時フォルダを作成したあと，フォルダが不要になったタイミングで削除する場合などに利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

(12) AIX V6

(13) AIX V7

【実行対象サーバの使用条件】

なし。

バージョン

02.00.00

部品のタグ

Control OS,Windows,Linux,AIX

タスクログに表示される部品の名称

osDeleteFolder

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

common.folderPath

フォルダパス

削除するフォルダのパスをフルパスで指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.34　プロセスの情報取得

機能

この部品は，WindowsまたはUNIXの実行対象サーバにおいて，指定したプロセスの情報を出力プロパティに設定します。指定したプロセスが複数存在する場合はプロセス開始時刻の古い順にソートし，1プロセスごとにひとつの出力プロパティに設定します。

プロセスの情報は最大で20個まで出力プロパティに設定できます。20個を超えた場合は，プロセス数取得上限フラグ(common.processOverflowFlagプロパティ)に"true"を，それ以外の場合は"falseを設定します。

個々の出力プロパティに設定するプロセスの情報の項目は次のようになります。

<プロセス名>,<プロセスID>,<プロセス開始時刻>

この部品では，次のサーバを前提とします。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

-Windows

Get-Process -Name "プロセス名(common.processNameプロパティ)"

　 Get-Processコマンドレットの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。

-UNIX

　ps --sort start_time --format comm,pid,start_time -C "プロセス名(common.processNameプロパティ)"

　psコマンドの詳細については，OSのmanコマンドで取得できるコマンド情報を参照してください。

・取得したプロセスの情報をプロセス開始時刻の古い順に1行(1プロセス)ずつ，プロセス情報[x](common.processInfo[x]プロパティ)*に設定します。

*：[x]は1から20の整数

利用場面

障害時にプロセスの情報を確認する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

【実行対象サーバの使用条件】

なし。

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) プロセス名(common.processNameプロパティ)にワイルドカードによる指定はできません。

(3) 実行対象サーバの稼働OSがWindowsの場合，上位の権限を持つユーザーのプロセス開始時刻は取得できません。時刻が取得できなかったプロセスは，時刻を取得したプロセスを格納したプロセス情報プロパティ以降のプロセス情報プロパティに格納します。

バージョン

02.00.01

部品のタグ

Gather OS information,Windows,Linux

タスクログに表示される部品の名称

osGetProcessInfo

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.processName

プロセス名

プロセスの情報を取得するプロセス名を指定します。

−　

入力

○　

common.processInfo1

プロセス情報1

取得したプロセス情報を設定します。

−　

出力

△　

common.processInfo2

プロセス情報2

取得したプロセス情報を設定します。

−　

出力

△　

common.processInfo3

プロセス情報3

取得したプロセス情報を設定します。

−　

出力

△　

common.processInfo4

プロセス情報4

取得したプロセス情報を設定します。

−　

出力

△　

common.processInfo5

プロセス情報5

取得したプロセス情報を設定します。

−　

出力

△　

common.processInfo6

プロセス情報6

取得したプロセス情報を設定します。

−　

出力

△　

common.processInfo7

プロセス情報7

取得したプロセス情報を設定します。

−　

出力

△　

common.processInfo8

プロセス情報8

取得したプロセス情報を設定します。

−　

出力

△　

common.processInfo9

プロセス情報9

取得したプロセス情報を設定します。

−　

出力

△　

common.processInfo10

プロセス情報10

取得したプロセス情報を設定します。

−　

出力

△　

common.processInfo11

プロセス情報11

取得したプロセス情報を設定します。

−　

出力

△　

common.processInfo12

プロセス情報12

取得したプロセス情報を設定します。

−　

出力

△　

common.processInfo13

プロセス情報13

取得したプロセス情報を設定します。

−　

出力

△　

common.processInfo14

プロセス情報14

取得したプロセス情報を設定します。

−　

出力

△　

common.processInfo15

プロセス情報15

取得したプロセス情報を設定します。

−　

出力

△　

common.processInfo16

プロセス情報16

取得したプロセス情報を設定します。

−　

出力

△　

common.processInfo17

プロセス情報17

取得したプロセス情報を設定します。

−　

出力

△　

common.processInfo18

プロセス情報18

取得したプロセス情報を設定します。

−　

出力

△　

common.processInfo19

プロセス情報19

取得したプロセス情報を設定します。

−　

出力

△　

common.processInfo20

プロセス情報20

取得したプロセス情報を設定します。

−　

出力

△　

common.processOverflowFlag

プロセス数取得上限フラグ

取得したプロセス数が21個以上の場合はtrue，それ以外はfalseを設定します。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.35　ホスト名取得

機能

実行対象サーバに登録された情報を基に，指定されたIPアドレスに対応するサーバのホスト名を取得します。

取得するホスト名は次の2種類です。

(1) IPアドレスから名前解決されたホスト名

(2) (1)のホスト名がドメイン名を含む場合はドメイン名を取り除いたショートネーム形式のホスト名

　　(ドメイン名を含まない場合は(1)と同じ形式のホスト名)

この部品では，次のサーバを前提とします。

・実行対象サーバ

　部品を実行し，DNSサーバへの問い合せ，hostsファイルの情報検索を行うサーバです。

・検索対象サーバ

　IPアドレスからホスト名を取得する対象のサーバです。

実行対象サーバのhostsファイルから検索対象サーバのホスト名の取得を行います。hostsファイルからホスト名を取得できず，実行対象サーバにDNSサーバが登録されている場合，DNSサーバに検索対象サーバのホスト名を問い合わせます。

利用場面

この部品を使用することで，検索対象サーバのIPアドレスおよびホスト名の情報が必要となるサービステンプレートにおいて，入力プロパティを減らすことができます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1) JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・bind-utilsパッケージがインストールされていること。

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・bind-utilsパッケージがインストールされていること。

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

　・bind-utilsパッケージがインストールされていること。

(10) CentOS 8 (64-bit x86_64)

　・bind-utilsパッケージがインストールされていること。

(11) Oracle Linux 8 (64-bit x86_64)

　・bind-utilsパッケージがインストールされていること。

【実行対象サーバの使用条件】

(1)実行対象システム内のDNS，または実行対象サーバのhostsファイルに，検索対象サーバのIPアドレスとホスト名が定義されていること。

注意事項

(1)検索対象サーバのIPアドレスにIPv6は指定できません。

バージョン

02.00.00

部品のタグ

Gather OS information,Windows,Linux

タスクログに表示される部品の名称

osGetHostName

戻り値

戻り値

説明

0

正常

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

OS.targetIPAddress

検索対象サーバのIPアドレス

検索対象サーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

OS.host2Ipaddr

検索対象サーバのホスト名

指定した検索対象サーバのIPアドレスに対するホスト名が設定されます。

−　

出力

△　

OS.shortHostName

検索対象サーバのホスト名(ショートネーム形式)

指定した検索対象サーバのIPアドレスに対するショートネーム形式のホスト名が設定されます。

−　

出力

△　

4.13.36　実行待機

機能

指定されたWindowsまたはUNIXのサーバにおいて，秒単位で指定した時間で待機処理を実施します。

・実行対象サーバ

　部品を実行し，待機処理を実施するサーバです。

利用場面

この部品は，プロパティで指定してステップ間の実行間隔を制御する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1) JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

【実行対象サーバの使用条件】

なし。

注意事項

(1)通信の状態などによって，指定した待ち時間と誤差が生じる場合があります。

バージョン

02.00.00

部品のタグ

Control OS,Windows,Linux

タスクログに表示される部品の名称

osWaitTime

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

localhost

入力

○　

common.waitTime

待機処理時間

待機処理の時間を秒単位で指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.37　日時計算

機能

この部品は，指定した日時に対して指定した時間を加減算します。計算後の日時は，指定したフォーマットに従って計算結果(common.calculateResultプロパティ)に格納します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

この部品内のスクリプトでは次に示す処理を行います。

(1)実行対象サーバがWindowsの場合，次のコマンドレットを実行します。

　・指定した日時のオブジェクトを取得します。

　　$Key = Get-Date "入力日時(common.inputDateAndTimeプロパティ)の値"

　・上記で取得したオブジェクトに対して指定した時間を加減算します。

　　Get-Date -Date ($Key).メソッド名.Invoke("計算日時(common.calculateDateAndTimeプロパティ)の値")

　　　　　　　-UFormat "フォーマット(common.dateAndTimeFormatプロパティ)の値"

　　上記コマンドレットのメソッド名は，計算単位(common.calculateUnitプロパティ)の値に応じて異なります。

　Get-Dateコマンドレットの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。

(2)実行対象サーバがUNIXの場合，次のコマンドを実行します。

　　date -d "入力日時(common.inputDateAndTimeプロパティ)の値

　　　　　　計算日時(common.calculateDateAndTimeプロパティ)の数値

　　　　　　計算単位(common.calculateUnitプロパティ)の値

　　　　　　[ago] ※1

　　　　　　"

　　　　　　"+フォーマット(common.dateAndTimeFormatプロパティ)の値"

　※1 計算日時(common.calculateDateAndTimeプロパティ)に負の数を指定した場合に設定されます。

　dateコマンドの詳細については，OSのmanコマンドで取得できるコマンド情報を参照してください。

入力日時(common.inputDateAndTimeプロパティ)は｢YYYY-MM-DD hh:mm:ss｣の形式で指定してください。

フォーマット(common.dateAndTimeFormatプロパティ)について次に示します。

・64文字以内の文字列を指定してください。

・文字列内の変換指定文字は，対応する値に変換されます。変換指定文字以外の文字列は，変換されずにそのまま計算結果(common.calculateResultプロパティ)に格納します。

　変換指定文字の例を次に示します。その他の変換指定文字は上記のコマンドレットおよびコマンドのマニュアルを確認してください。

　[変換指定文字]

　　%Y　世紀部分を含めた4桁の西暦年。

　　%y　西暦の下2桁。世紀部分を含まない年。1桁の場合には前に0を設定する。

　　%m　月。1桁の場合には前に0を設定する。

　　%d　日。1桁の場合には前に0を設定する。

　　%H　24時間表記での時。1桁の場合には前に0を設定する。

　　%I　12時間表記での時。1桁の場合には前に0を設定する。

　　%M　分。1桁の場合には前に0を設定する。

　　%S　秒。1桁の場合には前に0を設定する。

　　%s　1970-01-01 00:00:00 UTC からの秒数。

利用場面

ファイルやディレクトリを作成する際に，ファイル名やディレクトリ名の識別子として計算した日付を用いたい場合などに使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

【実行対象サーバの使用条件】

なし。

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)WindowsとUNIXではコマンドの仕様が異なるため，同じ値を計算日時(common.calculateDateAndTimeプロパティ)に指定しても，実行対象サーバのOSによって計算結果(common.calculateResultプロパティ)が異なることがあります。

バージョン

02.10.00

部品のタグ

Gather OS information,Linux,Windows

タスクログに表示される部品の名称

osCalculateDateAndTime

戻り値

戻り値

説明

0

正常

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.inputDateAndTime

入力日時

計算元となる日時を「YYYY-MM-DD hh:mm:ss」形式で指定します。

−　

入力

○　

common.calculateUnit

計算単位

入力日時に対して加減算する時間の単位を指定します。"years"，"months"，"days"，"hours"，"minutes"，"seconds"のどれかを指定してください。

−　

入力

○　

common.calculateDateAndTime

計算時間

入力日時に対して加減算する時間を半角数字で指定します。減算する場合は先頭に"-"を付けてください。

−　

入力

○　

common.dateAndTimeFormat

フォーマット

計算後の日時を出力するフォーマットを指定します。

%Y%m%d%H%M%S

入力

○　

common.calculateResult

計算結果

計算後の日時がフォーマットにしたがって格納されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.38　日時取得

機能

実行対象サーバ上の現在日時を，指定したフォーマットに従って取得します。

取得後の日時は，取得結果(common.getResultプロパティ)に格納します。

オプションとして，出力する日時のタイムゾーンを指定することができます。

フォーマット(common.dateAndTimeFormatプロパティ)について次に示します。

・64文字以内の文字列を指定してください。

・フォーマット(common.dateAndTimeFormatプロパティ)に指定された文字列内の変換指定文字は，対応する値に変換されます。

　ただし，変換指定文字以外の文字列は，変換されずそのまま取得結果(common.getResultプロパティ)に格納します。

　変換指定文字の例を次に示します。

　[変換指定文字]

　　%Y　世紀部分を含めた4桁の西暦年。

　　%y　西暦の下2桁。世紀部分を含まない年。1桁の場合には前に0を設定する。

　　%m　月。1桁の場合には前に0を設定する。

　　%d　日。1桁の場合には前に0を設定する。

　　%H　24時間表記での時。1桁の場合には前に0を設定する。

　　%I　12時間表記での時。1桁の場合には前に0を設定する。

　　%M　分。1桁の場合には前に0を設定する。

　　%S　秒。1桁の場合には前に0を設定する。

　　%s　1970-01-01 00:00:00 UTC からの秒数

タイムゾーン(OS.timeZoneプロパティ)について次に示します。

・省略した場合，実行対象サーバに対してエージェントレス接続したユーザーに設定されているタイムゾーンで，現在日時を取得します。

・実行対象サーバがWindowsの場合，TZUTILコマンドの/lオプションで確認できる，タイムゾーンIDを指定してください。

　指定例を次に示します。

　Tokyo Standard Time

　China Standard Time

　GMT Standard Time

　Pacific Standard Time

　Eastern Standard Time

　US Eastern Standard Time

　Central Standard Time

　Central America Standard Time

　US Mountain Standard Time

　Mountain Standard Time

　Alaskan Standard Time

　Hawaiian Standard Time

　Singapore Standard Time

　India Standard Time

・実行対象サーバがLinuxの場合，/usr/share/zoneinfoディレクトリ以下にある，タイムゾーンファイル名を指定してください。

　指定例を次に示します。

　America/Adak

　America/Boise

　America/Chicago

　America/Denver

　America/Detroit

　America/Juneau

　America/Kentucky/Monticello

　America/Los_Angeles

　America/Louisville

　America/Monterrey

　America/Montevideo

　America/New_York

　America/North_Dakota/Center

　America/Shiprock

　America/Tijuana

　America/Vancouver

　Asia/Chongqing

　Asia/Hong_Kong

　Asia/Kolkata

　Asia/Macau

　Asia/Shanghai

　Asia/Singapore

　Asia/Tokyo

　Etc/UTC

　Europe/London

　Pacific/Honolulu

・実行対象サーバがAIXの場合，/usr/share/lib/zoneinfoディレクトリ以下にある，タイムゾーンファイル名を指定してください。

　指定例は実行対象サーバがLinuxの場合を参照してください。

取得結果(common.getResultプロパティ)について次に示します。

・実行対象サーバ上の現在日時を，フォーマット(common.dateAndTimeFormatプロパティ)に従って取得します。

・実行対象サーバがWindowsの場合，PowerShellのGet-Dateコマンドレット(-UFormatオプション)の結果を格納します。

・実行対象サーバがUNIXの場合，dateコマンドの結果を格納します。

利用場面

現在日時を特定のフォーマットに変換して使用する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

(12) AIX V6

(13) AIX V7

【実行対象サーバの使用条件】

(1)実行対象サーバがWindowsの場合に，タイムゾーン(OS.timeZoneプロパティ)を指定する場合は，Microsoft .Net Framework 3.5以降がインストールされていること。

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)機能説明に記載している変換指定文字以外の変換指定文字も使用できます。実行対象サーバがWindowsの場合は，PowerShellのGet-Dateコマンドレット(-UFormatオプション)のマニュアルを確認してください。UNIXの場合は，dateコマンドのマニュアルを確認してください。ただし，「%n」や「%t」などの制御文字に変換される変換指定文字は指定しないでください。

(3)実行対象サーバがWindowsの場合は，フォーマット(common.dateAndTimeFormatプロパティ)に「{」，「}」を使用しないでください。指定した場合，この部品が異常終了します。

(4)実行対象サーバがUNIXの場合は，タイムゾーン(OS.timeZoneプロパティ)にOS上で定義されていないタイムゾーンを指定した場合，タイムゾーンはUTCとなります。指定したタイムゾーンが，Linuxの場合は/usr/share/zoneinfoディレクトリ以下，AIXの場合は/usr/share/lib/zoneinfoディレクトリ以下にあることを確認しください。

(5)取得結果(common.getResultプロパティ)に「%」を出力する場合は，フォーマット(common.dateAndTimeFormatプロパティ)に「%%」と指定してください。

(6)取得結果(common.getResultプロパティ)に格納される値は，この部品の実行開始時間ではありません。実行対象サーバがWindowsの場合は，PowerShellのGet-Dateコマンドレットを実行した時間，UNIXの場合は，dateコマンドを実行した時間が格納されます。

バージョン

02.02.00

部品のタグ

Gather OS information,Windows,Linux,AIX

タスクログに表示される部品の名称

osGetDateAndTime

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.dateAndTimeFormat

フォーマット

現在日時を変換するフォーマットを指定します。

%Y-%m-%dT%H:%M

入力

○　

OS.timeZone

タイムゾーン

タイムゾーンを指定します。

−　

入力

△　

common.getResult

取得結果

現在日時をフォーマットにしたがって取得した結果が格納されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.39　日時比較

機能

この部品は，日時の比較を行います。

基準日時(common.standardDateプロパティ)と比較日時(common.compareDateプロパティ)を比較し，基準日時と比べて比較日時が新しい場合"true"，古い場合"false"を返します。また出力データとして，日時比較結果(新)(common.newResultDateプロパティ)には，比較した結果新しいほうの日時が格納され，日時比較結果(古)(common.oldResultDateプロパティ)には，古いほうの日時が格納されて出力されます。

日時の比較は，秒単位で比較を行います。

入力する日時(common.standardDate，common.compareDateプロパティ)について次に示します。

・｢yyyy/mm/dd hh:MM:ss｣の形式で指定してください。

・時刻(hh:MM:ss)を入力しない場合｢00:00:00｣が設定されます。また，日付(yyyy/mm/dd)を入力しない場合，実行対象サーバの実行時の日付が設定されます。

出力する比較結果(common.compareResultプロパティ)について次に示します。

・同日時の場合，｢true｣を出力します。

出力する日時(common.newResultDate，common.oldResultDateプロパティ)について次に示します。

・日時比較結果(新)(common.newResultDateプロパティ)と日時比較結果(古)(common.oldResultDateプロパティ)に格納する値は 基準日時(common.standardDateプロパティ)と比較日時(common.compareDateプロパティ)に指定した値をそのまま格納します。

利用場面

2つのファイルから日時情報を取得したあと，2つの日時を比較し，どちらのファイルが新しいか(古いか)を調べたい時に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

【実行対象サーバの使用条件】

なし。

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)機能説明に記載している形式以外でも日時の入力は可能です。ただし，日時の形式によって，部品の実行は正常終了しますが，日時の比較結果が正しく判定されない場合があります。実行対象サーバにおいて，次の方法で正しい判定結果を得るための日時の形式を確認してください。

実行対象サーバがWindowsの場合はGet-Dateコマンド，UNIXの場合はdateコマンド(-dオプション)を実行して，入力日時と出力日時が一致することを確認してください。

　入力日時と出力日時の日時が一致している例(実行対象サーバ:UNIX)

　　入力:date -d "2009-06-15 20:45"

　　出力:2009年 6月 15日 月曜日 20:45:00 JST

　入力日時と出力日時の日時が異なる例(実行対象サーバ:UNIX)

　　入力:date -d "2015年03月03日 14時18分27秒"

　　出力:2015年 3月 12日 木曜日 20:15:00 JST

バージョン

02.00.00

部品のタグ

Gather OS information,Windows,Linux

タスクログに表示される部品の名称

osCompareDateAndTime

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.standardDate

基準日時

比較する際に，基準となる日時です。

−　

入力

○　

common.compareDate

比較日時

基準日時と比較するための日時です。

−　

入力

○　

common.compareResult

比較結果

基準日時と比べて比較日時が新しい場合｢true｣，古い場合｢false｣を返します。同日時の場合，｢true｣を出力します。

−　

出力

−　

common.newResultDate

日時比較結果(新)

基準日時と比較日時を比較し，新しい方の日時を出力します。

−　

出力

−　

common.oldResultDate

日時比較結果(古)

基準日時と比較日時を比較し，古い方の日時を出力します。

−　

出力

−　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

4.13.40　文字列のソート処理

機能

この部品は，指定した文字列の内容をソートし，出力プロパティに出力します。

対象の文字列(common.targetStringプロパティ)に指定された文字列を，区切り文字(common.delimiterChar)プロパティに指定された文字で分割し，分割後の文字列要素をソートした結果をソート実行後の文字列(common.resultString)プロパティへ出力します。

ソートの順番は大文字と小文字の区別をせずに文字コード順に並びます。

また，対象文字列について，区切り文字以降に文字が存在しない場合(区切り文字間に文字が存在しない場合，対象の文字列の最終文字が区切り文字の場合)に１つのNULL文字列としてソートします。空白が含まれている場合も空白として認識し，文字列をソートします。(区切り文字が「,」のソート例：bb,,,cc, ,aa,⇒,,, ,aa,bb,cc)

降順ソート(common.sortDescendingプロパティ)に"true"を指定した場合は降順でソートし，"true以外"を指定した場合は昇順でソートします。

区切り文字(common.delimiterCharプロパティ)にはASCII英数/記号の任意の1文字を指定します。タブ文字を指定する場合は"TAB"と指定してください。

利用場面

他の部品で出力したプロパティの結果をソートする場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

【実行対象サーバの使用条件】

なし。

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

バージョン

02.00.00

部品のタグ

Control OS,Windows,Linux

タスクログに表示される部品の名称

osSortString

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.targetString

対象の文字列

任意の1バイトのASCII文字で区切られたソート対象文字列を指定します（例：aaa bbb ccc）。1024文字以内の文字列を指定することを推奨します。推奨値を超える文字列を指定すると，実行対象サーバのOSによっては，指定した文字列の一部が消える場合があります。

−　

入力

○　

common.delimiterChar

区切り文字

入力文字列の列と列を区切る文字を，半角英数字または半角記号で1文字だけ指定します。省略した場合は，半角スペースを区切り文字とします。タブ文字を指定する場合は"TAB"と指定してください。

−　

入力

△　

common.sortDescending

降順ソート

降順ソートを実行する場合は"true"を指定します。"true"以外の場合は，昇順ソートを実行します。

false

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

common.sortedString

ソート実行後の文字列

入力された文字列をソートした結果が格納されます。区切り文字は，common.delimiterCharプロパティに指定した文字です。

−　

出力

−　

4.13.41　文字列のフィルタリング

機能

WindowsまたはLinux環境で，指定したテキストファイルの文字列に対してフィルタリング処理を行います。実行対象サーバがWindowsの場合はANSIコードページの文字コードで，UNIXの場合はユーザーの環境変数[LANG]で指定している文字コードでフィルタリングを行います。

このドキュメント内で使用している用語を次に示します。

・フィルタリング

　指定したテキストファイル(入力ファイル)内の文字列(入力文字列)を指定した「行」「列」の範囲で抽出する処理のことを示します。

・列

　行を特定の文字(区切り文字)で分割した一つ一つの文字列を示します。

次に示すプロパティがフィルタリングの条件になります。

　・抽出開始行

　・抽出終了行

　・区切り文字

　・抽出列

フィルタリング例を次に示します。

　・入力文字列

　　　num,family,poolID,capacity,usageRate

　　　1,VSP,0,7225344,0

　　　2,VSP,1,100423680,5

　　　3,VSP,100,4085760,0

　　　4,VSP,11,6150144,11

　・フィルタリング結果

　　列と列は，区切り文字に指定した文字で区切られます。

　　例1(抽出開始行が「1」，抽出終了行が「2」，区切り文字が「,」，抽出列が「1,3」の場合)

　　　num,poolID

　　　1,0

　　抽出開始行および抽出終了行で存在しない行を指定した場合は，存在しない行のフィルタリング結果は出力されません。

　　例2(抽出開始行が「5」，抽出終了行が「6」，区切り文字が「,」，抽出列が「1,3」の場合)

　　　4,11

　　抽出列が1列だけの場合は，フィルタリング結果に区切り文字は出力されません。

　　例3(抽出開始行が「1」，抽出終了行が「2」，区切り文字が「,」，抽出列が「3」の場合)

　　　poolID

　　　0

　　抽出列で存在しない列を含む複数の列を指定した場合は，存在しない列は空文字になります。

　　例4(抽出開始行が「1」，抽出終了行が「2」，区切り文字が「,」，抽出列が「1,6」の場合)

　　　num,

　　　1,

　　行末まで区切り文字が出現しない場合は，行末までを1列目とみなします。

　　例5(抽出開始行が「1」，抽出終了行が「2」，区切り文字が「#」，抽出列が「1」の場合)

　　　num,family,poolID,capacity,usageRate

　　　1,VSP,0,7225344,0

フィルタリング結果はファイル(出力ファイル)に出力します。

この部品では，次のサーバを前提とします。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

プロパティ設定の留意点を次に示します。

(1) 抽出開始行(common.rowPosBeginプロパティ)および，抽出終了行(common.rowPosEndプロパティ)について

　・1以上2147483647以下の整数値で指定してください。

　・抽出開始行を省略した場合は，1行目から抽出を開始します。

　・抽出終了行を省略した場合は，最終行まで抽出します。但し，入力ファイルの行数が2147483647を超える場合は2147483647行まで抽出します。

　・抽出開始行≦抽出終了行になるように指定してください。

(2) 区切り文字(common.delimiterCharプロパティ)について

　・指定する文字は半角英数字および半角記号で1文字だけとし，省略した場合は半角スペースを設定します。

　・指定できる半角記号は，実行対象サーバのOS種別によって異なります。

　　　OSがWindowsの場合は「 」(半角スペース)，「!」，「#」，「$」，「%」，「&」，「(」，「)」，「*」，「+」，「,」，「-」，「.」，「/」，「:」，「;」，「<」，「=」，「>」，「?」，「@」，「[」，「¥」，「]」，「^」，「_」，「`」，「{」，「|」，「}」，「~」が指定できます。

　　　「"」，「'」は指定しないでください。指定した場合，この部品が異常終了します。

　　　OSがLinuxの場合は「 」(半角スペース)，「#」，「%」，「&」，「(」，「)」，「*」，「+」，「,」，「-」，「.」，「/」，「:」，「;」，「<」，「=」，「>」，「?」，「@」，「[」，「]」，「^」，「_」，「{」，「|」，「}」，「~」が指定できます。

　　　「"」，「'」，「!」，「$」，「¥」，「`」は指定しないでください。指定した場合，この部品が異常終了します。

(3) 抽出列(common.columnPosプロパティ)について

　・1以上2147483647以下の整数値で指定してください。例えば，1列目は「1」となります。

　・複数列を抽出する場合は，列番号を「,」で区切って設定してください。スペースは入れないでください。

　・省略した場合は，全列が抽出範囲の対象になります。

　・先頭及び末尾には数字を指定してください。次のように指定した場合，この部品が異常終了します。

　　「,1,3」「1,3,」「,」

　・「,」を連続して指定しないでください。次のように指定した場合，この部品が異常終了します。

　　「1,,3」

利用場面

この部品は，他の部品が出力した文字列をフィルタリングする場合などに使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

【実行対象サーバの使用条件】

なし。

注意事項

(1) プロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。指定した場合，この部品が異常終了します。

(2) Linux環境に対してこの部品を実行する場合は，プロパティに半角の「!」，「$」，「¥」，「`」を指定しないでください。指定した場合，この部品が異常終了します。

(3) 入力ファイルパス(common.inputFilePathプロパティ)と出力ファイルパス(common.outputFilePathプロパティ)に同じパスを指定しないでください。同じパスを指定した場合，この部品が異常終了します。

(4) この部品を同時に実行する場合，同一の出力ファイルを指定しないでください。

(5) 出力ファイル上書きの要否(common.flagOverwriteOutputFileプロパティ)にfalseを指定した場合に出力するファイルが既に存在すると，この部品が異常終了します。

(6) 区切り文字(common.delimiterCharプロパティ)に指定した文字が半角スペースの場合は，次に示す注意事項があります。

　・フィルタリングの対象となる文字列が連続した半角スペースで区切られていても，1つの半角スペースで区切られているとみなします。

　・フィルタリングの対象となる文字列の先頭または末尾に存在する半角スペースは，その個数に関係なく，存在しないものとみなします。

　・実行対象サーバのOS種別がLinuxの場合は，フィルタリングの対象となる文字列内のタブ記号は半角スペースとみなします。

(7) 入力ファイルに入力文字列が存在しない場合でも，この部品は正常終了します。

(8) 入力ファイルの最終行がEOF（End Of File）のみの場合は，実行対象サーバのOS種別によって処理が異なります。

　・OSがWindowsの場合は，最終行を入力文字列として扱いません。

　・OSがLinuxの場合は，最終行を入力文字列として扱います。

(9) LC_ALLやLC_MESSAGESなどLANGより上位のロケール環境変数が設定されている時，上位のロケール環境変数が優先されてしまうため，部品を実行する際に，LC_ALLやLC_MESSAGESなどの上位のロケール環境変数を解除するか，LANG環境変数と同一の値に変更してください。

バージョン

02.00.00

部品のタグ

Control OS,Windows,Linux

タスクログに表示される部品の名称

osFilterString

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.inputFilePath

入力ファイルのパス

フィルタリング対象の文字列を格納したファイルをフルパスで指定します。

−　

入力

○　

common.rowPosBegin

抽出開始行

入力文字列のうち，フィルタリング対象の抽出開始行番号を数字で指定します。省略した場合は，1行目からフィルタリング対象となります。

−　

入力

△　

common.rowPosEnd

抽出終了行

入力文字列のうち，フィルタリング対象の抽出終了行番号を数字で指定します。省略した場合は，最終行までフィルタリング対象となります。

−　

入力

△　

common.delimiterChar

区切り文字

入力文字列の列と列を区切る文字を，半角英数字または半角記号で1文字だけ指定します。省略した場合は，半角スペースを区切り文字とします。

−　

入力

△　

common.columnPos

抽出列

入力文字列のうち，抽出する列番号を数字で指定します。複数列を抽出する場合は，列番号を','で区切って指定して下さい。省略した場合は，全列が抽出範囲の対象になります。

−　

入力

△　

common.outputFilePath

出力ファイルのパス

フィルタリング結果を出力するファイルをフルパスで指定します。ファイルが存在しない場合は作成します。

−　

入力

○　

common.flagOverwriteOutputFile

出力ファイル上書きの要否

出力するファイルが既に存在する場合に，ファイルに上書きするか(true)，ファイルに上書きしないか(false)を指定します。

false

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.42　文字列の検索

機能

WindowsまたはUNIX環境で，指定したテキストファイルの文字列に対して，指定したキーワードの検索処理を行います。実行対象サーバがWindowsの場合はANSIコードページの文字コードで，UNIXの場合はユーザーの環境変数[LANG]で指定している文字コードで検索を行います。

指定したテキストファイル(入力ファイル)内の文字列(入力文字列)に対してキーワード文字列の検索処理を行い，該当する文字列を含む行を抽出します。

検索例を次に示します。

　・入力文字列

　　　num,family,poolID,capacity,usageRate

　　　1,VSP,0,7225344,0

　　　2,VSP,1,100423680,5

　　　3,VSP,100,4085760,0

　　　4,VSP,11,6150144,11

　・キーワード文字列が'00'の場合の検索結果

　　　2,VSP,1,100423680,5

　　　3,VSP,100,4085760,0

検索結果はファイル(出力ファイル)に出力します。

検索結果の有無(common.findResultプロパティ)に，キーワード文字列が見つかったかどうかについて，true(見つかった場合)またはfalse(見つからなかった場合)を格納します。

この部品では，次のサーバを前提とします。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

利用場面

この部品は，他の部品が出力した内容を検索する場合などに使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

(12) AIX V6

(13) AIX V7

【実行対象サーバの使用条件】

なし。

注意事項

(1) プロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。指定した場合，この部品が異常終了します。

(2) UNIX環境に対してこの部品を実行する場合は，プロパティに半角の「!」，「$」，「¥」，「`」を使用しないでください。指定した場合，正しい検索結果が得られません。

(3) キーワード文字列(common.keywordStrプロパティ)は，正規表現の使用はサポートしていません。

(4) 入力ファイルパスと出力ファイルパス(common.outputFilePathプロパティ)に同じパスを指定しないでください。同じパスを指定した場合，この部品が異常終了します。

(5) この部品を同時に実行する場合，同一の出力ファイルを指定しないでください。

(6) 出力ファイル上書きの要否(common.flagOverwriteOutputFileプロパティ)にfalseを指定した場合に出力するファイルが既に存在すると，この部品が異常終了します。

(7) 入力ファイルに入力文字列が存在しない場合でも，この部品は正常終了します。

(8) LC_ALLやLC_MESSAGESなどLANGより上位のロケール環境変数が設定されている時，上位のロケール環境変数が優先されてしまうため，部品を実行する際に，LC_ALLやLC_MESSAGESなどの上位のロケール環境変数を解除するか，LANG環境変数と同一の値に変更してください。

バージョン

02.02.00

部品のタグ

Control OS,Windows,Linux,AIX

タスクログに表示される部品の名称

osFindString

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.inputFilePath

入力ファイルのパス

検索対象の文字列を格納したファイルをフルパスで指定します。

−　

入力

○　

common.keywordStr

キーワード文字列

入力文字列に対して検索を行うキーワード文字列を1024文字以内で指定します。

−　

入力

○　

common.outputFilePath

出力ファイルのパス

検索結果を出力するファイルをフルパスで指定します。ファイルが存在しない場合は作成します。

−　

入力

○　

common.flagOverwriteOutputFile

出力ファイル上書きの要否

出力するファイルが既に存在する場合に，ファイルに上書きするか(true)，ファイルに上書きしないか(false)を指定します。

false

入力

○　

common.findResult

検索結果の有無

キーワード文字列を含む行があったかどうかが格納されます。該当する行があったときはtrue，該当する行がなかったときはfalseが格納されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.43　文字列の置換

機能

WindowsまたはUNIX環境で，指定したファイルの特定の文字列を，すべて指定した文字列に置換します。実行対象サーバがWindowsの場合SJISで，UNIXの場合はユーザーの環境変数[LANG]で指定している文字コードで文字列置換を行います。

指定したファイルは，指定した置換処理を実施した内容で上書きされます。

ファイル内に，置換対象文字列に合致する文字列が存在しない場合は，ファイルの内容は変更しません。

この部品では，次のサーバを前提とします。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

common.replaceTargetプロパティの指定について

・正規表現の使用はサポートしていません。

・実行対象サーバのOSがWindowsの場合に｢¥｣，｢[｣，｢]｣，｢?｣，｢^｣，｢+｣，｢*｣，｢.｣，｢@｣を指定する場合は，｢¥｣(円記号)でエスケープする必要があります。ただし，｢¥」を文字列の末尾または1文字のみ指定する場合は，「¥¥¥¥」と入力してください。また，｢#｣，｢{｣，｢}｣，｢'｣，｢;｣，｢&｣，｢,｣，｢`｣，｢<｣，｢>｣およびスペースを含む文字列を指定する場合は，｢`｣(バッククォート)でエスケープする必要があります。ただし，1文字以上のスペースだけを指定する場合は，「'」(シングルクォート)で囲む必要があります（例：「' '」）。｢(｣，｢)｣，｢|｣，｢$｣を指定する場合は，｢¥`｣(円記号とバッククォート)でエスケープしてください。

・実行対象サーバのOSがUNIXの場合に｢¥｣(円記号)を指定する場合は，｢¥¥｣と入力してください。また，｢!｣，｢$｣，｢[｣，｢]｣，｢/｣，｢.｣，｢^｣，｢*｣を指定する場合は，｢¥｣(円記号)でエスケープする必要があります。

・またWindowsおよびUNIXに関係なく｢"｣は入力しないでください。｢"｣を指定する場合は，｢¥0x22｣と入力してください。　

common.replaceStrプロパティの指定について

・実行対象サーバのOSがWindowsの場合，｢`t｣(タブ)および｢`r`n｣(改行)のメタ文字を使用できます。また，｢¥｣を文字列の末尾または1文字のみ指定する場合は，｢¥¥｣と入力してください。｢`｣，｢#｣，｢,｣，｢@｣，｢|｣，｢{｣，｢}｣，｢'｣，｢;｣，｢&｣，｢(｣，｢)｣，｢<｣，｢>｣，｢$｣およびスペースを含む文字列を指定する場合は，｢`｣(バッククォート)でエスケープする必要があります。ただし，1文字以上のスペースだけを指定する場合は，「'」(シングルクォート)で囲む必要があります（例：「' '」）。

・実行対象サーバのOSがUNIXの場合，｢¥t｣(タブ)および｢¥n｣(改行)のメタ文字を使用できます。文字列内に｢¥｣(円記号)を指定する場合は，｢¥¥｣と入力してください。また，文字列内に｢!｣，｢/｣，｢$｣，｢&｣を指定する場合は，｢¥｣(円記号)でエスケープする必要があります。

・またWindowsおよびUNIXに関係なく｢"｣は入力しないでください。｢"｣を指定する場合は，｢¥0x22｣と入力してください。

利用場面

定義ファイルを編集する場合に利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

(12) AIX V6

(13) AIX V7

【実行対象サーバの使用条件】

なし。

注意事項

(1) この部品を同一ファイルに対して同時に実行しないでください。

(2) サロゲートペア文字および制御文字は指定できません。

(3) LC_ALLやLC_MESSAGESなどLANGより上位のロケール環境変数が設定されている時，上位のロケール環境変数が優先されてしまうため部品を実行する際に，LC_ALLやLC_MESSAGESなどの上位のロケール環境変数を解除するか，LANG環境変数と同一の値に変更してください。

バージョン

03.01.00

部品のタグ

Control OS,Windows,Linux,AIX

タスクログに表示される部品の名称

osReplaceString

戻り値

戻り値

説明

0

正常

14

異常(ユーザーミス) ファイルアクセス不可

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.strFilePath

文字列を置換するファイルのパス

文字列を置換するファイルのパスをフルパスで指定します。

−　

入力

○　

common.replaceTarget

置換対象の文字列

ファイル内の置換対象の文字列を指定します。1024文字以内の文字列を指定することを推奨します。推奨値を超える文字列を指定すると，実行対象サーバのOSによっては，指定した文字列の一部が消える場合があります。

−　

入力

○　

common.replaceStr

置換後の文字列

置換後の文字列を指定します。1024文字以内の文字列を指定することを推奨します。推奨値を超える文字列を指定すると，実行対象サーバのOSによっては，指定した文字列の一部が消える場合があります。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.13.44　文字列の追加

機能

この部品は，ファイルの末尾に文字列を追加します。

文字列を追加したいファイルパス(common.strFilePathプロパティ)と追加する文字列(common.addStrプロパティ)を入力すると，指定したファイルの末尾に文字列を追加します(具体的には，End Of Fileが存在する行の1つ下の行に文字列を追加し改行を行います。ただし，指定したファイルが存在しなかった場合，ファイル作成後，1行目に文字列を追加して改行を行います)。

文字列を追加するファイルのパス(common.strFilePathプロパティ)には，ワイルドカードを使用したファイルのパスは指定できません。

追加する文字列は，実行対象サーバがWindowsの場合はOSのデフォルト文字コードで，UNIXの場合はユーザーの環境変数[LANG]で指定している文字コードで追加されます。

文字列を追加したいファイルパス(common.strFilePathプロパティ)について，次に示します。

・文字列を追加したいファイルをフルパスで指定してください。

・指定したファイルが存在しない場合，ファイルを作成して文字列を書き込みます。

・フォルダが存在しない場合，フォルダを作成後にファイルを作成し，文字列を書き込みます。

追加する文字列(common.addStrプロパティ)について，次に示します。

・正規表現の使用はサポートしていません。

・WindowsおよびUNIX問わず，｢"｣および｢'｣は入力しないでください。

　実行対象サーバがWindowsおよびLinuxの場合，｢"｣を指定する場合は｢¥0x22｣，｢'｣を指定する場合は｢¥0x27｣と入力してください。

　実行対象サーバがAIXの場合，｢"｣を指定する場合は｢¥¥0x22｣，｢'｣を指定する場合は｢¥¥0x27｣と入力してください。

・実行対象サーバがWindowsの場合，｢`t｣(タブ)および｢`r`n｣(改行)のメタ文字を使用できます。

・実行対象サーバがUNIXの場合，｢¥t｣(タブ)および｢¥n｣(改行)のメタ文字を使用できます。

　ただし，Linuxの場合，末尾の｢¥n｣(改行)は無視されます。AIXの場合，｢¥¥0x22｣または｢¥¥0x27｣を入力している場合は，末尾の｢¥n｣(改行)は無視されます。

利用場面

定義ファイルを編集する場合に利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(8) CentOS 6 (64-bit x86_64)

(9) CentOS 7 (64-bit x86_64)

(10) CentOS 8 (64-bit x86_64)

(11) Oracle Linux 8 (64-bit x86_64)

(12) AIX V6

(13) AIX V7

【実行対象サーバの使用条件】

なし。

注意事項

(1)common.strFilePathプロパティには｢"｣(ダブルクォーテーション)および｢'｣(シングルクォーテーション)を含む文字列は指定しないでください。

(2)この部品をバイナリファイルに対して使用しないでください。バイナリファイルに対して使用した場合，ファイルが壊れるおそれがあります。

(3)この部品を同一ファイルに対して同時に実行しないでください。同一ファイルに対して同時に実行した場合，文字列の追加に失敗するおそれがあります。

(4)LC_ALLやLC_MESSAGESなどLANGより上位のロケール環境変数が設定されている時，上位のロケール環境変数が優先されてしまうため，部品を実行する際に，LC_ALLやLC_MESSAGESなどの上位のロケール環境変数を解除するか，LANG環境変数と同一の値に変更してください。

バージョン

02.02.00

部品のタグ

Control OS,Windows,Linux,AIX

タスクログに表示される部品の名称

osAddString

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.strFilePath

文字列を追加するファイルのパス

文字列を追加するファイルのフルパスを指定します。

−　

入力

○　

common.addStr

追加する文字列

ファイルに追加する文字列を指定します。1024文字以内の文字列を指定することを推奨します。推奨値を超える文字列を指定すると，実行対象サーバのOSによっては，指定した文字列の一部が消える場合があります。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

4.14　TELstaff関連の部品

4.14.1　TELstaffによる通知

機能

この部品は，Windowsの実行対象サーバで，TELstaffによる通知を行います。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

　teldial

　　 -ni "連絡網ID(TELstaff.contactNetworkIDプロパティ)の値"

　　[-fm "メール通知文ファイル(TELstaff.notificationFileMailプロパティ)の値"]

　　[-fv "電話通知文ファイル(TELstaff.notificationFileVoiceプロパティ)の値"]

　　[-u "ユーザー付加情報(TELstaff.UserInformationプロパティ)の値"]

　teldialコマンドは標準出力と標準エラー出力を出力しません。また，戻り値は通知の成否ではなく，コマンド受付の成否までになります。

　このため，通知の成否についてはTELstaffのログビューアなどで確認する必要があります。

　また，teldialコマンドを連続実行すると，TELstaffの発信制限機能によってコマンドの戻り値が0以外になる場合がありますが，この部品はteldialコマンドの戻り値を参照せず，連続実行しても発信制限機能によってエラーになることはありません。発信制限の発生状況についてもTELstaffのログビューアで確認してください。

　teldialコマンドの詳細については，TELstaffのマニュアルを参照してください。

利用場面

システムの障害などをオペレータへ通知したい場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　・JP1/TELstaff 11-00以降

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) その他の注意事項については，TELstaffマニュアルの同コマンドの注意事項を参照してください。

実行権限

Administratorsグループに属するユーザーであること。

バージョン

02.01.00

部品のタグ

Control JP1,TELstaff,Windows

タスクログに表示される部品の名称

TELstaffDial

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

TELstaff.contactNetworkID

連絡網ID

TELstaffで定義されている連絡網IDを指定します。

−　

入力

○　

TELstaff.notificationFileMail

メール通知文ファイル

実行対象サーバのメール通知文ファイル名(メールで送信するメッセージテキストを格納したファイル名)を，フルパスで指定します。指定しなかった場合には，標準提供の通知文ファイルを使用します。

−　

入力

△　

TELstaff.notificationFileVoice

電話通知文ファイル

実行対象サーバの電話通知文ファイル名(電話で音声通知するメッセージテキストを格納したファイル名)を，フルパスで指定します。指定しなかった場合には，標準提供の通知文ファイルを使用します。

−　

入力

△　

TELstaff.UserInformation

ユーザー付加情報

通知文ファイル(通知するメッセージテキスト)中の~UserInformation~ 変数と置き換えられます。「;」(半角セミコロン)で区切ると，複数行に分割できます。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.15　UNIX関連の部品

4.15.1　OSユーザーの追加 (UNIX)

機能

UNIX環境でOSユーザーを追加し，任意のグループに追加します。あわせてホームディレクトリを作成します。

指定したOSユーザーが既に存在する場合，処理をスキップします。(戻り値:0)

この部品では，次のサーバを前提とします。

・実行対象サーバ

　この部品を実行する対象となるサーバです。UNIXがセットアップされている必要があります。

利用場面

UNIXに対して運用に使用するユーザーを追加する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(2) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(3) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(4) CentOS 6 (64-bit x86_64)

(5) CentOS 7 (64-bit x86_64)

(6) CentOS 8 (64-bit x86_64)

(7) Oracle Linux 8 (64-bit x86_64)

(8) AIX V6

(9) AIX V7

【実行対象サーバの使用条件】

なし。

注意事項

(1) UNIX環境に対してこの部品を実行する場合は，プロパティにマルチバイト文字を使用しないでください。

バージョン

02.00.00

部品のタグ

Configure OS,Linux,AIX

タスクログに表示される部品の名称

osAddUser_Lin

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

Linux.accountComment

OSユーザーに関する説明コメント

OSユーザーのアカウントに関する説明コメントを指定します。

−　

入力

△　

Linux.userHomeDir

OSユーザーのホームディレクトリのパス

OSユーザーのホームディレクトリのパスをフルパスで指定します。

−　

入力

△　

Linux.accountExpires

OSユーザーの有効期限

OSユーザーが使用不能になる日付を"YYYY-MM-DD"の形式で指定します。

−　

入力

△　

Linux.osGroupName

OSユーザーのグループ名

OSユーザーに設定するグループ名を指定します。

−　

入力

△　

Linux.osUserName

OSユーザー名

作成するOSユーザーのユーザー名を指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.15.2　ファイルまたはディレクトリのアクセス権限変更

機能

この部品は，UNIXの実行対象サーバにおいて，指定したファイルまたはディレクトリのアクセス権限を変更します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

　chmod

　　[-R] ※1

　　"アクセス権のパーミッション値(common.permissionプロパティ)の値"

　　"アクセス権設定対象ファイル名(common.targetFileNameプロパティ)の値"

　※1 再帰要否(common.recursiveプロパティ)の値に"true"を指定した場合に設定されます。

　chmodコマンドの詳細については，OSのmanコマンドで取得できるコマンド情報を参照してください。

利用場面

ファイルまたはディレクトリのアクセス権限を設定する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(2) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

(3) Red Hat Enterprise Linux Server 8 (64-bit x86_64)

(4) CentOS 6 (64-bit x86_64)

(5) CentOS 7 (64-bit x86_64)

(6) CentOS 8 (64-bit x86_64)

(7) Oracle Linux 8 (64-bit x86_64)

【実行対象サーバの使用条件】

(1)アクセス権限を設定するファイルおよびディレクトリが存在すること。

注意事項

(1)アクセス権設定対象ファイル名(common.targetFileNameプロパティ)に「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「'」，「[」，「]」，「`」を使用しないでください。

(2)この部品は通常のファイルまたはディレクトリを対象としています。そのため，デバイスなどは，ファイルやディレクトリとして扱いません。

バージョン

02.01.00

部品のタグ

Control OS,Linux

タスクログに表示される部品の名称

osSetPermissionUNIX

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.targetFileName

アクセス権設定対象ファイル名

アクセス権限を変更するファイル名またはディレクトリ名をフルパスで指定します。

−　

入力

○　

common.permission

アクセス権のパーミッション値

ファイルやディレクトリのアクセス権限を変更するパーミッション値を指定します。

−　

入力

○　

common.recursive

再帰要否

ディレクトリを再帰的に処理する場合は"true"を指定します。"true"以外の場合は，再帰処理をしません。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.16　Windows関連の部品

4.16.1　CSVデータ取得

機能

この部品は，CSVファイルからデータを取得し出力プロパティに設定します。サポートするファイルは，拡張子がcsvのテキストファイルです。

次を満たすCSVファイルのデータの取得をサポートします。

・文字コードがMS932で記述され，改行コードがCR+LFであること。

指定した列(最大5列)のデータをコンマ(,)区切りで，出力プロパティに設定します。

CSVファイルの1行目は列名を記述してください。2行目からデータを記述してください。

(例1)

ホスト名

hostVM001

hostVM002

(例2)

ホスト名,コメント

hostVM001,#Comment1

hostVM002,#Comment2

読み込んだフィールドには次のチェックを行ないます。どれかの条件に当てはまると，部品はエラーとなります。

(a)フィールドまたは行が空(null)

(b)フィールドの文字列長が256文字より大きい

(c)フィールドに以下の特殊記号を含む

　「,」，「<」，「>」，「|」，「;」，「&」，「*」，「?」，「`」，「%」，両端以外の「"」

　および末尾の「¥」

(d)フィールドに制御文字(0x00〜0x1f)を含む

出力情報は指定した列ごとに出力します。いずれかの列で

（フィールドの文字列の合計値）+データ行数

が1017文字を超えると，エラーとなります。

利用場面

管理CSVファイルからデータを取得し，サービスの入力値として利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバの使用条件】

なし。

注意事項

(1)ODBCドライバの制限により，CSVファイル名には「[」，「]」，「!」は使用できません。

(2)CSVファイルのデータのIPアドレスは「"」で囲んでください。「"」で囲まない場合，数値型データとして誤認識され，正常に値を取得できないことがあります。

(3)ファイル読み込み時のリトライ回数には0以上32767以下の整数値を指定してください。範囲外の値を指定すると部品は異常終了します。

(4)ファイル読み込み時のリトライ間隔には1以上60以下の整数値を指定してください。範囲外の値を指定すると部品は異常終了します。

(5)フィールドの文字列長は255バイト以内にしてください。256バイト以上だった場合，ODBCドライバが正常に値を取得できずに，部品が異常終了する場合があります。

(6)この部品を同一ファイルに対して同時に実行した場合，ファイルのアクセスに失敗する場合があります。この場合，リトライ回数とリトライ間隔を調整して，エラーを回避できるまでリトライを実施してください。

(7)エージェントレス接続先設定の認証情報に設定したユーザーがビルトインAdministratorではない場合，以下のいずれかの条件を満たす必要があります。

・WindowsのUAC機能が完全に無効化されている。

・エージェントレス接続先の機器にて，エージェントレス接続先設定の認証情報に設定されたユーザーに対するRDPセッションが確立されている。

実行権限

Administrators 権限

バージョン

02.00.01

部品のタグ

Gather OS information,Windows

タスクログに表示される部品の名称

osReadSpreadSheet

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

14

異常(ユーザーミス) ファイルアクセス不可

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.fileName

ファイル名

ファイル名を指定します。

−　

入力

○　

odbc.Column1

列番号１

取得するデータの列番号を指定します。

−　

入力

○　

odbc.Column2

列番号２

取得するデータの列番号を指定します。

−　

入力

△　

odbc.Column3

列番号３

取得するデータの列番号を指定します。

−　

入力

△　

odbc.Column4

列番号４

取得するデータの列番号を指定します。

−　

入力

△　

odbc.Column5

列番号５

取得するデータの列番号を指定します。

−　

入力

△　

odbc.fileOpenRetryCount

ファイル読み込み時のリトライ回数

ファイルの読み込みに失敗した場合のリトライ回数を指定します。ファイル読み込み時のリトライ間隔と組み合わせて最大待ち時間となります。"0"を指定した場合はリトライしません。

20

入力

○　

odbc.fileOpenRetryInterval

ファイル読み込み時のリトライ間隔

ファイルの読み込みに失敗した場合のリトライ間隔を秒単位で指定します。

5

入力

○　

odbc.OutputValue1

データ１

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue2

データ２

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue3

データ３

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue4

データ４

取得したデータを設定します。

−　

出力

△　

odbc.OutputValue5

データ５

取得したデータを設定します。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.16.2　ICMPエコー要求メッセージの送信 (無応答確認)

機能

指定されたWindowsのサーバで，指定されたIPアドレスに対してICMPエコー要求を送信し，応答があるかどうかを戻り値で返します。

この部品では，次のサーバを前提とします。

・実行対象サーバ

　部品を実行し，ICMPエコー要求の送信を行うサーバです。

・送信対象サーバ

　ICMPエコー要求を送信する対象のサーバです。

プロパティcommon.icmpSendAddressに送信対象サーバのIPアドレスまたはホスト名を指定して実行します。

複数のIPアドレス(ホスト名)が指定された場合，指定された全てのIPアドレス(ホスト名)に対してICMPエコー要求を送信します。

どのIPアドレス(ホスト名)からもICMPエコーに対する応答がなければ，戻り値「0」を返します。

1つ以上のIPアドレス(ホスト名)からICMPエコーに対する応答があれば，戻り値「0」以外を返します。

なお，この部品が出力する「CommandExitCode:」の値はWin32_PingStatus class(MSDN)のStatusCode(ICMPエコーの結果)です。

利用場面

仮想サーバのデプロイで使用するIPアドレスが使用されていないことを確認するため，ICMPエコー要求を送信する場合に利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバの使用条件】

なし。

注意事項

(1)ICMPエコーのタイムアウト時間(common.icmpEchoTimeoutプロパティ)は利用している環境に応じて調整してください。

(2)この部品には，リミテッド・ブロードキャスト・アドレス(255.255.255.255)を使用しないでください。

(3)エージェントレス接続先設定の認証情報に設定したユーザーがビルトインAdministratorではない場合，以下のいずれかの条件を満たす必要があります。

・WindowsのUAC機能が完全に無効化されている。

・エージェントレス接続先の機器にて，エージェントレス接続先設定の認証情報に設定されたユーザーに対するRDPセッションが確立されている。

実行権限

Administrators 権限

バージョン

02.00.00

部品のタグ

Control OS,Windows

タスクログに表示される部品の名称

osSendIcmp2

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

25

異常(環境不正) 通信エラー

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.icmpSendAddress

ICMPエコーの送信先

ICMPエコーを送信するIPアドレスまたはホスト名を指定します。複数のIPアドレス（ホスト名）に送信する場合には，コンマ区切りで指定します。

−　

入力

○　

common.icmpEchoTimeout

ICMPエコー要求のタイムアウト時間

ICMPエコー要求に対する応答を待つ時間をミリ秒単位で指定します。

4000

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

common.checkIPAddressResult

ICMP確認のチェック結果

指定されたIPアドレスが使用されていないかどうか確認した結果を格納します。

−　

出力

△　

4.16.3　OSサービスのアカウント変更

機能

この部品は，Windowsの実行対象サーバにおいて，OSサービスのユーザー名，パスワードを変更します。

このドキュメント内で使用している用語を次に示します。

・OSサービス

　JP1/AOで実行するサービスと区別するため，Windowsのサービスを総称してOSサービスと記載します。

OSサービス名(common.serviceNameプロパティ)に指定するOSサービスは，「コントロール パネル」−「管理ツール」−「サービス」の名前欄に表示される名称，サービス表示名になります。

OSユーザー名(Common.OSUserNameプロパティ)には，"ドメイン名¥OSユーザー名"もしくは".¥OSユーザー名"の形式でユーザーを指定してください。また，ビルトイン・アカウントを指定したい場合は，OSユーザー名(Common.OSUserNameプロパティ)を次の通りに指定してください。

ビルトイン・アカウントがLocal Systemの場合は，OSユーザー名(Common.OSUserNameプロパティ)にLocalSystemを指定してください。同様に，Local Serviceの場合はNT AUTHORITY¥LocalServiceを，Network Serviceの場合はNT AUTHORITY¥NetworkServiceを指定してください

この部品では，次のサーバを前提とします。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

この部品内のスクリプトでは次に示す処理を行います。

・指定したOSサービス名(common.serviceNameプロパティ)にワイルドカード(*，?，[，])が使用されていないことを確認します。

・次のコマンドを実行します。

　Get-WmiObject -Class Win32_Service -Filter "DisplayName='OSサービス名(common.serviceNameプロパティ)'"

　上記コマンドで取得したWin32_Serviceオブジェクトのchangeメソッドを用いてOSサービスのアカウント(ユーザー名，パスワード)をOSユーザー名(Common.OSUserNameプロパティ)，OSユーザーのパスワード(common.osUserPasswordプロパティ)で設定した値に変更します。

　Win32_Serviceクラスのchangeメソッドの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。

利用場面

登録したOSサービスの初期設定でユーザー名を変更する場合，およびセキュリティ対策として定期的にOSサービスのパスワードを変更する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバの使用条件】

なし。

注意事項

(1) プロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。指定した場合，この部品が異常終了します。

(2) エージェントレス接続先に定義された接続ユーザーに，操作対象のOSサービスに対するアクセス許可が必要です。

(3) OSサービス名(common.serviceNameプロパティ)は完全名で指定してください。部分一致やワイルドカードによる指定はできません。

(4) OSユーザーのパスワード(common.osUserPasswordプロパティ)に空文字を設定し部品を実行した場合，OSユーザーのパスワードは空文字に変更されます。

バージョン

02.00.01

部品のタグ

Control OS,Windows

タスクログに表示される部品の名称

osChangeServiceAccount

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.serviceName

OSサービス名

アカウントを変更する対象OSサービス名

−　

入力

○　

common.osUserName

OSユーザー名

変更後のOSユーザーのユーザー名を指定します。

−　

入力

○　

common.osUserPassword

OSユーザーのパスワード

変更後のOSユーザーのパスワードを指定します。

−　

入力

△　

common.osUserPasswordReEnter

OSユーザーのパスワードの再入力

変更後のOSユーザーのパスワードを再入力します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.16.4　OSサービスのスタートアップ設定

機能

この部品は，Windowsの実行対象サーバにおいて，指定した起動方法でOSサービスのスタートアップの種類を設定します。

このドキュメント内で使用している用語を次に示します。

・OSサービス

　JP1/AOで実行するサービスと区別するため，Windowsのサービスを総称してOSサービスと記載します。

OSサービス名(common.serviceNameプロパティ)に指定するOSサービスは，「コントロール パネル」−「管理ツール」−「サービス」の名前欄に表示される名称，サービス表示名になります。

OSサービスの起動方法(common.serviceStartupプロパティ)には，"delayed-auto"(遅延開始)，"auto"(自動)，"demand"(手動), "disabled"(無効)のいずれかを指定します。

この部品では，次のサーバを前提とします。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

この部品内のスクリプトでは次に示す処理を行います。

・OSサービス名(common.serviceNameプロパティ)に指定したOSサービス名にワイルドカード(*，?，[，])が使用されていないことを確認します。

・次のコマンドを実行します。

　 sc config (sc GetDisplayName "OSサービス名(common.serviceNameプロパティ)") start= "OSサービスの起動方法(common.serviceStartupプロパティ)"

　sc config，sc GetDisplayNameコマンドの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。

利用場面

OSサービスの起動方法を設定する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバの使用条件】

なし。

注意事項

(1) プロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。指定した場合，この部品が異常終了します。

(2) エージェントレス接続先に定義された接続ユーザーに，操作対象のOSサービスに対するアクセス許可が必要です。

(3) OSサービス名(common.serviceNameプロパティ)は完全名で指定してください。部分一致やワイルドカードによる指定はできません。

バージョン

02.00.01

部品のタグ

Control OS,Windows

タスクログに表示される部品の名称

osSetServiceStartup

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.serviceName

OSサービス名

スタートアップの種類を変更する対象サービス名

−　

入力

○　

common.serviceStartup

OSサービスの起動方法

WindowsサービスのOS起動時の起動方法を指定します。delayed-auto (遅延起動)，auto (自動起動)，demand (手動起動)，disabled (無効)のいずれかを指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.16.5　OSユーザーのグループ設定 (Windows)

機能

Windows環境でOSユーザーの所属するグループを設定します。ローカルユーザーまたはドメインユーザーのグループを設定できます。

OSユーザーの所属するグループを追加する場合，指定したグループにOSユーザーが既に所属していた場合は，指定したグループからOSユーザーを一旦削除したあとに追加します。

この部品では，次のサーバを前提とします。

・実行対象サーバ

　この部品を実行する対象となるサーバです。Windowsがセットアップされている必要があります。

設定するユーザー種別に応じてプロパティWindows.userTypeに以下の値を設定します。

ローカルユーザーのグループを設定する場合：local

ドメインユーザーのグループを設定する場合：domain

この部品の実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。実行対象サーバにAdministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行う部品「OSユーザーのグループ設定 (Windows)(SYSTEM)」を実行してください。

利用場面

運用に使用するユーザーを追加するなどの際，OSユーザーを追加した後に，所属するグループを設定する場合に使用します。

また，特定のグループからユーザーを削除する場合にも使用できます。以下の部品とあわせて使用することで，OSユーザー追加作業を効率化することができます。

・osAddUser_Win

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバの使用条件】

なし。

バージョン

02.00.00

部品のタグ

Configure OS,Windows

タスクログに表示される部品の名称

osChangeGroup_Win

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

common.osGroupName

OSユーザーのグループ名

OSユーザーに設定するグループ名を指定します。

−　

入力

○　

common.osUserName

OSユーザー名

グループを設定するOSユーザーのユーザー名を指定します。

−　

入力

○　

common.addOrDelete

操作の種別

ユーザーをグループに追加する（ADD）か，削除する（DELETE）かを指定します。

−　

入力

○　

Windows.userType

OSユーザー種別

OSユーザーの種別をローカル（local）またはドメイン（domain）で指定します。domainの場合，操作対象サーバのドメインのプライマリドメインコントローラに対して操作を行います。このプロパティはWindowsだけで有効です。

local

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.16.6　OSユーザーのグループ設定 (Windows)(SYSTEM)

機能

Windows環境でOSユーザーの所属するグループを設定します。ローカルユーザーまたはドメインユーザーのグループを設定できます。

OSユーザーの所属するグループを追加する場合，指定したグループにOSユーザーが既に所属していた場合は，指定したグループからOSユーザーを一旦削除したあとに追加します。

この部品では，次のサーバを前提とします。

・実行対象サーバ

　この部品を実行する対象となるサーバです。Windowsがセットアップされている必要があります。

設定するユーザー種別に応じてプロパティWindows.userTypeに以下の値を設定します。

ローカルユーザーのグループを設定する場合：local

ドメインユーザーのグループを設定する場合：domain

利用場面

運用に使用するユーザーを追加するなどの際，OSユーザーを追加した後に，所属するグループを設定する場合に使用します。

また，特定のグループからユーザーを削除する場合にも使用できます。以下の部品とあわせて使用することで，OSユーザー追加作業を効率化することができます。

・osAddUser_Win

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバの使用条件】

なし。

バージョン

02.50.01

部品のタグ

Configure OS,Windows

タスクログに表示される部品の名称

osChangeGroup_Win_System

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

common.osGroupName

OSユーザーのグループ名

OSユーザーに設定するグループ名を指定します。

−　

入力

○　

common.osUserName

OSユーザー名

グループを設定するOSユーザーのユーザー名を指定します。

−　

入力

○　

common.addOrDelete

操作の種別

ユーザーをグループに追加する（ADD）か，削除する（DELETE）かを指定します。

−　

入力

○　

Windows.userType

OSユーザー種別

OSユーザーの種別をローカル（local）またはドメイン（domain）で指定します。domainの場合，操作対象サーバのドメインのプライマリドメインコントローラに対して操作を行います。このプロパティはWindowsだけで有効です。

local

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.16.7　OSユーザーの追加 (Windows)

機能

Windows環境でOSユーザーを追加します。ローカルユーザーまたはドメインユーザーを作成できます。

指定したOSユーザーが既に存在する場合，処理をスキップします。(戻り値:0)

この部品では，次のサーバを前提とします。

・実行対象サーバ

　この部品を実行する対象となるサーバです。Windowsがセットアップされている必要があります。

作成するユーザー種別に応じてプロパティWindows.userTypeに以下の値を設定します。

ローカルユーザーを作成する場合：local

ドメインユーザーを作成する場合：domain

この部品の実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。実行対象サーバにAdministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行う部品「OSユーザーの追加 (Windows)(SYSTEM)」を実行してください。

利用場面

Windowsに対して運用に使用するユーザーを追加する場合などに使用できます。次の部品とあわせて使用することで，ユーザー追加作業を効率化することができます。

・osChangeGroup_Win

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバの使用条件】

なし。

バージョン

02.00.00

部品のタグ

Configure OS,Windows

タスクログに表示される部品の名称

osAddUser_Win

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

common.osUserName

OSユーザー名

作成するOSユーザーのユーザー名を指定します。

−　

入力

○　

common.osUserPassword

OSユーザーのパスワード

作成するOSユーザーのパスワードを指定します。

−　

入力

○　

common.osUserPasswordReEnter

OSユーザーのパスワード再入力

OSユーザーのパスワードを再入力します。

−　

入力

○　

Windows.userType

OSユーザー種別

OSユーザーの種別をローカル（local）またはドメイン（domain）で指定します。domainの場合，操作対象サーバのドメインのプライマリドメインコントローラに対して操作を行います。このプロパティはWindowsだけで有効です。

local

入力

△　

Windows.accountActive

OSユーザーを有効にするかどうか

OSユーザーのアカウントを有効にするかをtrue/falseで指定します。アカウントが無効（false）の場合，OSユーザーはサーバーにアクセスできません。

−　

入力

△　

Windows.accountComment

OSユーザーに関する説明コメント

OSユーザーのアカウントに関する説明コメントを指定します。

−　

入力

△　

Windows.countryCode

OSの国コード

OSユーザーのヘルプとメッセージに適用されるOSの国コードを指定します。値0はデフォルトの国コードを表します。

−　

入力

△　

Windows.accountExpires

OSユーザーの有効期限

OSユーザーの有効期限の日付をDD/MM/YY形式で指定します。neverを指定すると，そのOSユーザーに有効期限は設定されません。

−　

入力

△　

Windows.userFullName

OSユーザーのフルネーム

OSユーザー名ではなく，OSユーザーに設定する氏名の情報を指定します。

−　

入力

△　

Windows.userHomeFolder

OSユーザーのホームフォルダ

OSユーザーのホームフォルダのフルパスを設定します。パスは存在している必要があります。

−　

入力

△　

Windows.passwordChange

パスワード変更可否

OSユーザーが自分自身のパスワードを変更できるかどうかをtrueまたはfalseで指定します。

−　

入力

△　

Windows.passwordRequest

OSユーザーのパスワードを必須とするか

OSユーザーにパスワードを必ず設定するかどうかをtrueまたはfalseで指定します。

−　

入力

△　

Windows.userProfilePath

OSユーザーのログオンプロファイル

OSユーザーのログオンプロファイルへのパスをフルパスで指定します。

−　

入力

△　

Windows.userScriptPath

OSユーザーのログオンスクリプト

OSユーザーのログオンスクリプトへのパスをフルパスで指定します。

−　

入力

△　

Windows.userLogonTimes

OSユーザーがログオンできる時間帯

OSユーザーがログオンできる時間帯を指定します。

−　

入力

△　

Windows.userComment

OSユーザーに関するユーザーコメント

OSユーザーのアカウントに関するユーザーコメントを指定します。

−　

入力

△　

Windows.workstations

OSユーザーがネットワークにログオンできるサーバ

OSユーザーがネットワークにログオンできるサーバのホスト名を最大8台まで指定します。省略した場合，OSユーザーはどのサーバからでもログオンできます。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.16.8　OSユーザーの追加 (Windows)(SYSTEM)

機能

Windows環境でOSユーザーを追加します。ローカルユーザーまたはドメインユーザーを作成できます。

指定したOSユーザーが既に存在する場合，処理をスキップします。(戻り値:0)

この部品では，次のサーバを前提とします。

・実行対象サーバ

　この部品を実行する対象となるサーバです。Windowsがセットアップされている必要があります。

作成するユーザー種別に応じてプロパティWindows.userTypeに以下の値を設定します。

ローカルユーザーを作成する場合：local

ドメインユーザーを作成する場合：domain

利用場面

Windowsに対して運用に使用するユーザーを追加する場合などに使用できます。次の部品とあわせて使用することで，ユーザー追加作業を効率化することができます。

・osChangeGroup_Win

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバの使用条件】

なし。

バージョン

02.50.01

部品のタグ

Configure OS,Windows

タスクログに表示される部品の名称

osAddUser_Win_System

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

common.osUserName

OSユーザー名

作成するOSユーザーのユーザー名を指定します。

−　

入力

○　

common.osUserPassword

OSユーザーのパスワード

作成するOSユーザーのパスワードを指定します。

−　

入力

○　

common.osUserPasswordReEnter

OSユーザーのパスワード再入力

OSユーザーのパスワードを再入力します。

−　

入力

○　

Windows.userType

OSユーザー種別

OSユーザーの種別をローカル（local）またはドメイン（domain）で指定します。domainの場合，操作対象サーバのドメインのプライマリドメインコントローラに対して操作を行います。このプロパティはWindowsだけで有効です。

local

入力

△　

Windows.accountActive

OSユーザーを有効にするかどうか

OSユーザーのアカウントを有効にするかをtrue/falseで指定します。アカウントが無効（false）の場合，OSユーザーはサーバーにアクセスできません。

−　

入力

△　

Windows.accountComment

OSユーザーに関する説明コメント

OSユーザーのアカウントに関する説明コメントを指定します。

−　

入力

△　

Windows.countryCode

OSの国コード

OSユーザーのヘルプとメッセージに適用されるOSの国コードを指定します。値0はデフォルトの国コードを表します。

−　

入力

△　

Windows.accountExpires

OSユーザーの有効期限

OSユーザーの有効期限の日付をDD/MM/YY形式で指定します。neverを指定すると，そのOSユーザーに有効期限は設定されません。

−　

入力

△　

Windows.userFullName

OSユーザーのフルネーム

OSユーザー名ではなく，OSユーザーに設定する氏名の情報を指定します。

−　

入力

△　

Windows.userHomeFolder

OSユーザーのホームフォルダ

OSユーザーのホームフォルダのフルパスを設定します。パスは存在している必要があります。

−　

入力

△　

Windows.passwordChange

パスワード変更可否

OSユーザーが自分自身のパスワードを変更できるかどうかをtrueまたはfalseで指定します。

−　

入力

△　

Windows.passwordRequest

OSユーザーのパスワードを必須とするか

OSユーザーにパスワードを必ず設定するかどうかをtrueまたはfalseで指定します。

−　

入力

△　

Windows.userProfilePath

OSユーザーのログオンプロファイル

OSユーザーのログオンプロファイルへのパスをフルパスで指定します。

−　

入力

△　

Windows.userScriptPath

OSユーザーのログオンスクリプト

OSユーザーのログオンスクリプトへのパスをフルパスで指定します。

−　

入力

△　

Windows.userLogonTimes

OSユーザーがログオンできる時間帯

OSユーザーがログオンできる時間帯を指定します。

−　

入力

△　

Windows.userComment

OSユーザーに関するユーザーコメント

OSユーザーのアカウントに関するユーザーコメントを指定します。

−　

入力

△　

Windows.workstations

OSユーザーがネットワークにログオンできるサーバ

OSユーザーがネットワークにログオンできるサーバのホスト名を最大8台まで指定します。省略した場合，OSユーザーはどのサーバからでもログオンできます。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.16.9　SQLクエリーの実行

機能

ODBCを利用してDBサーバに接続し，任意のSQL文を発行します。

プロパティ「クエリーファイルパス(リモート)」(database.queryFilePath)に指定したテキストファイル(以降，「クエリーファイル」と呼びます)からSQL文を読み込んで1つずつ実行し，結果をプロパティ「出力先フォルダパス(リモート)」(database.outputFolderPath)が示すフォルダにCSVファイルとして出力します。ファイル名は，「SQLRES_<3桁の連番>.csv」です。

例:SQLRES_001.csv

クエリーファイル内のSQL文は1行1SQL文とし，かつ999行以下にしてください。

クエリーファイルに複数のSQL文が記述された場合は，結果も複数のCSVファイルに分割して出力します。

参照系のSQL文の実行結果は，CSVファイルの最初にヘッダ行を出力したあとに続けて出力します。また，文字エンコーディングについてはDB操作サーバのデフォルトで出力します。

更新系のSQL文については結果を何も出力せず，ファイルも作成しません。更新系のSQL文に対応するファイル名の連番は，詰めずに欠番として扱います。

入力のクエリーファイルと出力のCSVファイルの例を次に示します。

　入力例:

　　Select * from TBL_APP_USERS ・・・ (1行目)

　　Insert into TBL_APP_USERS(ID,NAME,DISCRIPT) Values(888,'日立 八郎','新しい人です') ・・・ (2行目)

　　Select * from TBL_APP_USERS ・・・ (3行目)

　出力例:

　　SQLRES_001.csv (1行目の実行結果)

　　　ID,NAME,DISCRIPT

　　　111,日立 太郎,サンプル1

　　　222,日立 次郎,サンプル2

　　SQLRES_003.csv (3行目の実行結果)

　　　ID,NAME,DISCRIPT

　　　111,日立 太郎,サンプル1

　　　222,日立 次郎,サンプル2

　　　888,日立 八郎,新しい人です

このドキュメント内で使用しているODBCに関する用語は，「ODBCデータソースアドミニストレーター」で使用されている表示名です。ODBCに関する用語を次に示します。

・ODBCデータソースアドミニストレーター

　Windowsに標準のツールです。データソースの作成と管理に使います。

・データソース

　DBサーバに接続するために必要な情報を集めたものです。

　「ODBCデータソースアドミニストレーター」で作成します。

・データソース名(DSN)

　データソースの識別名です。

　「ODBCデータソースアドミニストレーター」ではデータソース名またはDSNと記載されています。

・ODBCドライバー

　「ODBCデータソースアドミニストレーター」ではODBCドライバー，または単にドライバーと記載されています。

この部品が前提とするサーバを次に示します。

・DB操作サーバ(実行対象サーバ)

　DBサーバに接続しODBCコマンドを実行するサーバです。

・DBサーバ

　対象のDBMSがインストールされているサーバです。

利用場面

この部品は，DBに登録されている情報へユーザーが任意のSQLを用いてアクセスする場合などに使用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象システム内前提製品】

(1)DBサーバ

　・Oracle 10g Standard/Enterprise

　・Oracle 11g Standard/Enterprise

　・Oracle 12c Standard/Enterprise

(2)DB操作サーバ

　・Microsoft .Net Framework 2.0以降

　・DBサーバのDBMSに対応した32bit版ODBCドライバー

【実行対象システム内前提製品の稼働OS】

(1)DBサーバ

　・DBMSの要求を満たすもの。

(2)DB操作サーバ

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Enterprise/Datacenter

　ただし，Server Coreインストール環境は除く。

【実行対象システム内前提製品の使用条件】

(1)ネットワーク構成に関する条件

　・DB操作サーバからDBサーバへ，ODBC接続が可能であること。

(2)ODBCに関する条件

　・DB操作サーバにODBCドライバが正常にインストール済みであること。

　・DB操作サーバにおいて，ODBCデータソースアドミニストレータでデータソースが作成済みであること。

　・作成したデータソースの各種設定は正常に完了しており，そのデータソースを用いてDBサーバへの接続を確認済みであること。

注意事項

(1) プロパティ「クエリーファイルパス(リモート)」(database.queryFilePath)に指定したテキストファイル(以降，「クエリーファイル」と呼びます)の1行に複数のSQL文が記述された場合，この部品は異常終了します。

(2) プロパティ「エンコード種別」(common.encodeType)に指定したエンコード種別は，クエリーファイルのエンコード種別とDBに設定しているエンコード種別との両方と一致している必要があります。DBのエンコード種別について詳しくはODBCドライバーとDBMSの仕様を確認してください。

(3) プロパティ「出力先フォルダパス(リモート)」(database.outputFolderPath)に指定したフォルダ(以降,「出力先フォルダ」と呼びます)にファイルが既にある場合，既存のファイルを上書きします。指定したフォルダパスに誤りがないか，充分に確認してください。

(4) クエリーファイルに複数のSQL文が記述されて，一部のSQLが失敗した場合は中断してロールバックし，失敗したSQL文より後ろに記述されているSQL文は実行しません。また，出力先フォルダの空き容量が不足してファイルを書き込めないような場合にも同様にロールバックし，それより後ろのSQL文は実行しません。

(5) ロールバックした場合，SQL文実行が失敗する直前までの結果が出力先フォルダに出力されます。その場合，不完全なCSVファイルが出力されることがあります。

(6) ロールバックする前にCREATE文やALTER文やDROP文が実行されていた場合，ご使用のDBMSの仕様によってこれらの結果はロールバック後も復旧されない事があります。

(7) この部品がODBCドライバーを介してロールバックを試みても，ODBCドライバーに固有の設定をしている場合は，DBMSはデータを復元しない可能性があります。詳しくはODBCドライバーとDBMSの仕様を確認してください。

(8) この部品を利用するサービスでは，プロパティ「DBユーザーパスワード」(database.dbUserPassword)にマッピングするプロパティをパスワード型で扱ってください。

(9) セキュリティ上，クエリーファイルは，意図しない内容に書き換えられたりファイルごと差し替えられたりしないよう，適切に管理してください。併せて，使用するDBアカウントには必要最小限の権限を付与するようにしてください。

(10) データソースを作成する場合は通常，コントロールパネルの「管理ツール」からODBCデータソースアドミニストレーターを起動しますが，この部品は32bit版を扱うので，コマンドラインから絶対パス("%SystemRoot%¥SysWOW64¥odbcad32.exe")を指定して起動してください。

(11) データソースには「システムデータソース」と「ユーザーデータソース」がありますが，この部品は「システムデータソース」だけをサポートします。

(12) この部品は環境変数"SystemRoot"を参照して32bit版の"PowerShell.exe"を呼び出すため，DB操作サーバにおいてこの環境変数がOSインストール時から変更された場合，この部品が異常終了することがあります。

(13) クエリーファイルに記述されたSQL文の1行が長すぎる場合，この部品は異常終了することがあります。DB操作サーバのメモリが枯渇しない限りにおいて最大4GB/行までクエリーファイルから読み込むことができますが，それより短いSQL文でもODBCドライバーが限界を超えてしまう場合があります。詳しくはODBCドライバーとDBMSの仕様を確認してください。

(14) SQL文を実行した結果，CSVファイルの1行が長くなりすぎる場合，この部品は異常終了することがあります。DB操作サーバのメモリが枯渇しない限りにおいて最大4GB/行までCSVファイルに書き込むことができますが，それより短くてもODBCドライバーが限界を超えてしまう場合があります。詳しくはODBCドライバーとDBMSの仕様を確認してください。

(15) プロパティ「DBユーザーID」(database.dbUserId)と「DBユーザーパスワード」(database.dbUserPassword)に指定された文字列は，大文字と小文字を区別します。

バージョン

02.00.00

部品のタグ

Control Database,Windows,Oracle Database

タスクログに表示される部品の名称

dbIssueSqlQueries

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

database.queryFilePath

クエリーファイルパス(リモート)

SQL文を記述したテキストファイルへのフルパスを1024文字以内で指定します。ファイル内には，1行に複数のSQL文を書かないでください。また，複数行にまたがるようなSQL文も書かないでください。1ファイル当たり999行を超えないようにしてください。

−　

入力

○　

common.encodeType

エンコード種別

プロパティ「クエリーファイルパス(リモート)」で指定したテキストファイルのエンコード種別名を指定します。EUC-JP，SJIS，UTF-8，UTF-16のどれかを指定できます。

UTF-8

入力

○　

odbc.dataSourceName

ODBCデータソース名

予めODBCデータソースアドミニストレータでDB操作サーバ上に作成したデータソースの名前を指定します。

−　

入力

○　

database.dbUserId

DBユーザーID

DBサーバへログインするために用いるアカウントのIDを指定します。

−　

入力

○　

database.dbUserPassword

DBユーザーパスワード

DBユーザーIDに対応するパスワードを指定します。

−　

入力

○　

database.outputFolderPath

出力先フォルダパス(リモート)

SQLを実行した結果の出力先フォルダを1024文字以内のフルパスで指定します。出力ファイルは，DB操作サーバのシステムデフォルトの文字エンコードで出力されます。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.16.10　Windowsファイアウォールの設定

機能

この部品は，指定したプログラムやポートをWindowsファイアウォールの例外に登録します。

この部品では，次のサーバを前提とします。

・実行対象サーバ

　Windowsファイアウォールの例外登録を実行するサーバです。

登録したい対象に応じて，以下のいずれかのプロパティ群を指定して実行します。

プログラムの登録を行う場合は，プロパティOS.programPathName, OS.programNameを指定する必要があります。

ポートの登録を行う場合は，プロパティOS.protocol，OS.portNumber, OS.portNameを指定する必要があります。

指定したプログラムまたはポートが既に登録されていた場合，情報メッセージをタスクログに出力して登録処理をスキップします。

利用場面

アプリケーションをインストールした後，アプリケーションが正常に動作するようにファイアウォールの設定を行う場合などに利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバの使用条件】

(1)Windows Firewall/Internet Connection Sharing (ICS) サービスが開始していること。

バージョン

02.00.00

部品のタグ

Configure OS,Windows

タスクログに表示される部品の名称

osSetFirewallDef

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

OS.programPathName

プログラムパス名

Windowsファイアウォールの例外に登録するプログラムのファイルパスをフルパスで指定します（プログラム登録の場合必須）。

−　

入力

△　

OS.programName

プログラム名

Windowsファイアウォールの例外に登録するプログラム名称を指定します（プログラム登録の場合必須）。

−　

入力

△　

OS.protocol

プロトコル

Windowsファイアウォールの例外に登録するポートのプロトコル（TCP,UDP,ALL（全て）のどれか）を指定します（ポート登録の場合必須）。

−　

入力

△　

OS.portNumber

ポート番号

Windowsファイアウォールの例外に登録するポート番号を指定します（ポート登録の場合必須）。

−　

入力

△　

OS.portName

ポート名

Windowsファイアウォールの例外に登録するポートの名称を指定します（ポート登録の場合必須）。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.16.11　イベントログのイベント一覧取得

機能

この部品は，Windowsの実行対象サーバで，指定したイベントログにあるイベントの一覧をCSV形式で実行対象サーバのファイルに出力します。

出力ファイルのエンコード形式は，実行対象サーバのシステムのデフォルトエンコーディングです。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドレットを実行します。

　Get-EventLog

　　-LogName "イベントログ名(Windows.eventLogNameプロパティ)の値"

　　-After "イベントの取得開始日時(Windows.eventStartDateTimeプロパティ)の値"

　Get-EventLogコマンドレットの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。

出力するCSVファイルの項目を次に示します。

項目はコンマ区切りで出力します。

(a) イベントID(ヘッダー名：EventID)

(b) マシン名(ヘッダー名：MachineName)

(c) インデックス(ヘッダー名：Index)

(d) カテゴリー(ヘッダー名：Category)

(e) カテゴリー番号(ヘッダー名：CategoryNumber)

(f) イベントの種類(ヘッダー名：EntryType)

(g) メッセージ(ヘッダー名：Message)

(h) ソース(ヘッダー名：Source)

(i) イベント生成時刻(ヘッダー名：TimeGenerated)

(j) イベント出力時刻(ヘッダー名：TimeWritten)

(k) ユーザー名(ヘッダー名：UserName)

利用場面

Windowsのイベントログにあるイベントの一覧を取得する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

実行権限

(1) 実行サーバに接続する際のユーザーは，イベントログのイベントを参照するために必要な権限を持っている必要があります。

バージョン

02.01.00

部品のタグ

Gather OS information,Windows

タスクログに表示される部品の名称

osEventLogGetEvent

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

Windows.eventLogName

イベントログ名

イベントログの名前を指定します。

−　

入力

○　

common.outputFilePath

出力ファイルのパス

出力するファイルをフルパスで指定します。

−　

入力

○　

Windows.eventStartDateTime

イベントの取得開始日時

指定された日時のあとに発生したイベントを取得します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.16.12　イベントログへのイベント作成

機能

この部品は，Windowsの実行対象サーバで，イベントログにイベントを作成します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　この部品を実行する対象となるサーバです。

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドを実行します。

　eventcreate

　　/l "イベントログ名(Windows.eventLogNameプロパティ)の値"

　　/so "イベントのソース(Windows.eventSourceプロパティ)の値"

　　/t "イベントの種類(Windows.eventTypeプロパティ)の値"

　　/id "イベントID(Windows.eventIDプロパティ)の値"

　　/d "イベントの説明(Windows.eventDescriptionプロパティ)の値"

　eventcreateコマンドの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。

利用場面

他の部品での実行結果などをWindowsのイベントログにイベントとして作成する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

注意事項

(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

実行権限

(1) 実行サーバに接続する際のユーザーは，イベントログにイベントを作成するために必要な権限を持っている必要があります。

バージョン

02.01.00

部品のタグ

Configure OS,Windows

タスクログに表示される部品の名称

osEventLogCreateEvent

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

Windows.eventLogName

イベントログ名

イベントログの名前を指定します。

−　

入力

○　

Windows.eventSource

イベントのソース

イベントのソースを指定します。

−　

入力

○　

Windows.eventType

イベントの種類

イベントの種類を指定します。指定可能な値は，"SUCCESS"，"ERROR"，"WARNING"，"INFORMATION"です。

−　

入力

○　

Windows.eventID

イベントID

イベントIDを1〜1000の範囲で指定します。

−　

入力

○　

Windows.eventDescription

イベントの説明

イベントの説明を指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.16.13　ファイルの印刷(Windows)

機能

この部品は，実行対象サーバ上の指定されたファイルをコピーして，コピーしたファイルの印刷ジョブを印刷キューに投入します。

JP1/AOのローカル実行機能が有効になっている場合は，実行対象サーバとJP1/AOサーバは，別のサーバとしてください。

印刷キューに投入するときに，実行対象サーバの印刷に使用するOSのユーザー名(Windows.osPrintUserNameプロパティ)のデフォルトプリンタを使用します。指定したユーザーのデフォルトプリンタの設定が正しいことを確認したあと，この部品を使用してください。

印刷キューに投入するファイルは対象ファイルパス(common.targetFilePathプロパティ)で指定します。指定されたファイルを印刷ファイルのコピー先フォルダ(Windows.printCopyFolderPathプロパティ)にコピーしてから，コピー先のファイルの印刷ジョブを印刷キューに投入します。コピー元のオリジナルのファイルは使用しません。コピー先のフォルダに既に同名のファイルがある場合は上書きせず，異常終了します。

指定可能なファイルの拡張子は，「.txt」，「.xlsx」，「.xls」，「.doc」，「.docx」です。

対象ファイルパス(common.targetFilePathプロパティ)には，ワイルドカードを使用したファイルのパスは指定できません。それぞれの拡張子にはOSのユーザー名(Windows.osPrintUserNameプロパティ)に指定したユーザーで，ファイルの拡張子に印刷に使用するアプリケーションが関連付けられていることが必要です。

ファイルを印刷キューに投入するプロセスが終了するまで監視するための待ち時間と回数を指定します。プロセス監視間隔(Windows.checkProcessStateIntervalStartProcessプロパティ)に指定した秒数を待つことを，プロセス監視回数(Windows.checkProcessStateCountStartProcessプロパティ)に指定した回数実行します。指定した回数の実行までに印刷キューに投入するプロセスが終了しなかった場合，部品が異常終了します。

使用するコマンドは次の通りです。

printコマンドを使用します。

印刷は上記コマンドに依存します。

利用場面

ファイルを印刷する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバの使用条件】

・プリンタが登録されていること。

・印刷に使用するユーザー(Windows.osPrintUserNameプロパティ)でファイルの拡張子とアプリケーションが関連付けられていること。

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)印刷ファイルのコピー先フォルダ(Windows.printCopyFolderPathプロパティ)に指定したフォルダが存在しない場合，作成されます。

(3)実行対象サーバで指定したファイルの拡張子がアプリケーションに関連付けされていない場合は，印刷キューへの投入に失敗します。投入が失敗した場合は，実行対象サーバで指定したファイルがアプリケーションに関連付けされているか確認してください。

(4)実行対象サーバで，関連付けられたアプリケーションが印刷キューに投入するファイルを開いたときにユーザーへの確認ダイアログなどが表示されて部品が実行中のままになる場合があります。あらかじめ，関連付けられたアプリケーションでファイルを開いたときにダイアログなどが表示されないことを確認してください。

(5)部品が実行中のままになる場合，JP1/AOサーバからこの部品を使用しているタスクを強制終了する操作をしたあと，実行先サーバ上でタスクマネージャーを起動し，タスクログに出力されているプロセスIDと同じプロセスが実行されていないことを確認してください。実行されていた場合は，終了させてください。

(6)印刷キューに投入したあと，印刷に使用したコピーファイルを削除しますが削除に失敗しても部品は正常終了します。印刷ファイルのコピー先フォルダにファイルが残っていないか定期的に確認してください。

(7)印刷に使用するOSのユーザー名(Windows.osPrintUserNameプロパティ)には，Guestユーザーを指定しないでください。

(8)戻り値が28の場合，次の原因が考えられます。

　(a)前回この部品を実行して異常終了したあとも，拡張子に関連付けられたアプリケーションのプロセスが残っている。

　(b)印刷に使用するOSユーザーにGuestなどプロファイルを持たないアカウントを指定している。

(9)Excelファイルを印刷キューに投入する場合，同じ実行対象サーバに対して多重実行できません。実行順序をシリアライズしてください。

バージョン

02.00.00

部品のタグ

Control OS,Windows

タスクログに表示される部品の名称

osPrintFile

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

28

異常(取得情報なし) start-processの実行に失敗した

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.targetFilePath

対象ファイルのパス

対象ファイルをフルパスで指定します。

−　

入力

○　

Windows.printCopyFolderPath

印刷ファイルのコピー先フォルダ

印刷キューに投入するファイルのコピー先のフォルダを指定して下さい。

−　

入力

○　

Windows.osPrintUserName

印刷に使用するOSユーザー名

印刷に使用するOSユーザーのユーザー名を指定します。

−　

入力

○　

Windows.osPrintUserPassword

印刷に使用するOSユーザーのパスワード

印刷に使用するOSユーザーのパスワードを指定します。

−　

入力

○　

Windows.checkProcessStateCountStartProcess

プロセス監視回数

Windowsに要求した印刷ジョブを印刷キューに投入する処理が完了したかを確認する際の，確認回数を指定します。プロセス監視間隔と組み合わせて最大待ち時間となります。

30

入力

○　

Windows.checkProcessStateIntervalStartProcess

プロセス監視間隔

Windowsに要求した印刷ジョブを印刷キューに投入する処理が完了したかを確認する際の，確認間隔を秒単位で指定します。

10

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

4.16.14　ファイルまたはフォルダのアクセス権限変更

機能

Windowsの実行対象サーバにおいて，指定したファイルに対して，指定したユーザーのアクセス権限を変更することができます。

アクセス権限の変更対象にフォルダも指定できます。その場合は，アクセス権設定対象ファイル名(common.targetFileNameプロパティ)にフォルダを指定してください。

アクセス権限にグループの指定もできます。その場合は，OSユーザー名(Windows.osUserNameプロパティ)にグループ名を指定してください。

アクセス権限は，Set-ACLコマンドレットを使用して，アクセス許可およびアクセス拒否を変更することができます。

許可されているアクセス権限の削除(Windows.allowAccessPermissionDeleteプロパティ)，拒否されているアクセス権限の削除(Windows.denyAccessPermissionDeleteプロパティ)にyes(削除する)を指定することで，指定したユーザーに，既に設定されているアクセス権限を削除することができます。

アクセス権設定対象ファイル名(common.targetFileNameプロパティ)について次に示します。

・256文字以内の文字列を指定してください。

・ファイルを対象とする場合は，ファイル名をフルパスで指定してください。

・フォルダを対象とする場合は，フォルダ名をフルパスで指定してください。

OSユーザー名(Windows.osUserNameプロパティ)

・256文字以内の半角英数字および「-」「!」「#」「~」「_」「.」「¥」を指定してください。

・ユーザーのアクセス権限を設定する場合は，ユーザー名を指定してください。

・ドメインユーザーを指定する場合は，「<NetBIOS ドメイン名>¥<ドメインユーザー名>」の形式で指定してください。

　<NetBIOS ドメイン名>は15文字以内，<ドメインユーザー名>は20文字以内で指定してください。

・グループのアクセス権限を設定する場合は，グループ名を指定してください。

・ドメイングループを指定する場合は，「<NetBIOS ドメイン名>¥<ドメイングループ名>」の形式で指定してください。

　<NetBIOS ドメイン名>は15文字以内，<ドメイングループ名>は64文字以内で指定してください。

許可するアクセス権限(Windows.allowAccessPermissionプロパティ)について次に示します。

・許可するアクセス権限を指定してください。複数のアクセス権限を設定する場合は，コンマ区切りで指定してください。

・指定できるアクセス権限を次に示します。

　FullControl

　Modify

　ReadAndExecute

　Read

　Write

許可されているアクセス権限の削除(Windows.allowAccessPermissionDeleteプロパティ)について次に示します。

・yes(削除する)，もしくはno(削除しない)を指定してください。

・許可するアクセス権限(Windows.allowAccessPermissionプロパティ)と同時に指定した場合，既に設定されているアクセス権限を削除したあと，許可するアクセス権限を設定します。

拒否するアクセス権限(Windows.denyAccessPermissionプロパティ)について次に示します。

・拒否するアクセス権限を指定してください。複数のアクセス権限を設定する場合は，コンマ区切りで指定してください。

・指定できるアクセス権限を次に示します。

　FullControl

　Modify

　ReadAndExecute

　Read

　Write

・許可するアクセス権限と同一のアクセス権限を設定した場合，拒否するアクセス権限の優先順位が高くなります。

拒否されているアクセス権限の削除(Windows.denyAccessPermissionDeleteプロパティ)について次に示します。

・yes(削除する)，もしくはno(削除しない)を指定してください。

・拒否するアクセス権限(Windows.denyAccessPermissionプロパティ)と同時に指定した場合，既に設定されているアクセス権限を削除したあと，拒否するアクセス権限を設定します。

利用場面

ファイルまたはフォルダのアクセス権限を変更する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバの使用条件】

(1)アクセス権限を設定するファイルおよびフォルダが存在すること。

(2)アクセス権限を設定するユーザーまたはグループが存在すること。

注意事項

(1)アクセス権設定対象ファイル名(common.targetFileNameプロパティ)に「<」，「>」，「|」，「;」，「&」，「*」，「?」，「"」，「%」，「'」，「[」，「]」，「`」，「/」を使用しないでください。

(2)この部品は通常のファイルまたはフォルダを対象としています。そのため，ドライブやレジストリなどは，ファイルやフォルダとして扱いません。

(3)複数のファイルおよびフォルダに対してアクセス権限を変更することはできません。

(4)親オブジェクトから継承しているアクセス権限は変更できません。また，許可されているアクセス権限の削除(Windows.allowAccessPermissionDeleteプロパティ)，および拒否されているアクセス権限の削除(Windows.denyAccessPermissionDeleteプロパティ)にyes(削除する)を指定しても，親オブジェクトから継承しているアクセス権限は削除できません。

(5)次に示すユーザーがアクセス権設定対象ファイル名(common.targetFileNameプロパティ)に指定したファイルまたはフォルダにアクセス権限を設定する権限が無い場合，この部品が異常終了する場合があります。ファイルまたはフォルダに設定されているアクセス権限を確認してください。

・Build-in Administrator

・Administratorsグループに属するユーザ

・Active DirectoryのBuild-in Administrator

・Active DirectoryのDomain Adminグループに属するユーザ

バージョン

02.00.00

部品のタグ

Control OS,Windows

タスクログに表示される部品の名称

osSetPermissionWin

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.targetFileName

アクセス権設定対象ファイル名

アクセス権限を変更するファイル名またはフォルダ名をフルパスで指定します。

−　

入力

○　

Windows.osUserName

OSユーザー名

アクセス権限を変更する対象となるOSユーザーのユーザー名，またはグループ名を指定します。

−　

入力

○　

Windows.allowAccessPermission

許可するアクセス権限

許可するアクセス権限を指定します。複数のアクセス権限を設定する場合は，コンマ区切りで指定してください。

−　

入力

△　

Windows.allowAccessPermissionDelete

許可されているアクセス権限の削除

指定したOSユーザーに既に許可されているアクセス権限を削除する場合はyes，削除しない場合はnoを指定してください。

no

入力

○　

Windows.denyAccessPermission

拒否するアクセス権限

拒否するアクセス権限を指定します。複数のアクセス権限を設定する場合は，コンマ区切りで指定してください。

−　

入力

△　

Windows.denyAccessPermissionDelete

拒否されているアクセス権限の削除

指定したOSユーザーに既に拒否されているアクセス権限を削除する場合はyes，削除しない場合はnoを指定してください。

no

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

4.16.15　時刻判定

機能

指定した判定対象の時刻が，指定した条件に一致するか判定します。

判定対象の時刻(common.criterionTimeプロパティ)について次に示します。

・「hh:mm」の形式で指定してください。

・省略した場合は，実行対象サーバの現在時刻が設定されます。

　設定される現在時刻は，実行対象サーバに対してエージェントレス接続したユーザーに設定されているタイムゾーンに従った現在時刻です。

判定条件(common.conditionプロパティ)について次に示します。

・「hh:mm-hh:mm」の形式で指定してください。

　1つ目の「hh:mm」は条件の開始時間を，2つ目の「hh:mm」には条件の終了時間を指定してください。

・次の条件を満たす場合に，当該条件に一致したと判定し，一致した条件(common.matchConditionOutputプロパティ)に出力文字列(common.conditionOutputプロパティ)を格納します。

　条件の開始時間 ≦ 判定対象の時刻 < 条件の終了時間

・条件は最大10個まで指定できます。

　指定した時刻が複数の条件に一致する場合は，条件の番号が小さいほうの条件が優先され，一致した条件(common.matchConditionOutputプロパティ)に該当する出力文字列(common.conditionOutputプロパティ)を格納します。

出力文字列(common.conditionOutputプロパティ)について次に示します。

・512文字以内の文字列を指定してください。

・省略した場合は，条件の番号が設定されます。

条件に一致しなかった場合の出力文字列(common.otherConditionOutputプロパティ)について次に示します。

・512文字以内の文字列を指定してください。

利用場面

値判定分岐部品と組み合わせて使用することで，時間によってフローを分岐する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

【実行対象サーバの使用条件】

なし。

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)判定条件(common.conditionプロパティ)の開始時間と終了時間に同じ時間を指定しないでください。指定した場合，この部品が異常終了します。

バージョン

02.00.00

部品のタグ

Gather OS information,Windows

タスクログに表示される部品の名称

osJudgmentTime

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.criterionTime

判定対象の時刻(hh:mm)

判定対象となる時刻を指定します。省略すると，実行対象サーバの現在時刻が設定されます。

−　

入力

△　

common.condition1

判定条件1(hh:mm-hh:mm)

判定条件1を指定します。

−　

入力

○　

common.condition1Output

出力文字列1

判定条件1に一致した場合に出力する文字列を指定します。省略すると，"1"が設定されます。

−　

入力

△　

common.condition2

判定条件2(hh:mm-hh:mm)

判定条件2を指定します。

−　

入力

△　

common.condition2Output

出力文字列2

判定条件2に一致した場合に出力する文字列を指定します。省略すると，"2"が設定されます。

−　

入力

△　

common.condition3

判定条件3(hh:mm-hh:mm)

判定条件3を指定します。

−　

入力

△　

common.condition3Output

出力文字列3

判定条件3に一致した場合に出力する文字列を指定します。省略すると，"3"が設定されます。

−　

入力

△　

common.condition4

判定条件4(hh:mm-hh:mm)

判定条件4を指定します。

−　

入力

△　

common.condition4Output

出力文字列4

判定条件4に一致した場合に出力する文字列を指定します。省略すると，"4"が設定されます。

−　

入力

△　

common.condition5

判定条件5(hh:mm-hh:mm)

判定条件5を指定します。

−　

入力

△　

common.condition5Output

出力文字列5

判定条件5に一致した場合に出力する文字列を指定します。省略すると，"5"が設定されます。

−　

入力

△　

common.condition6

判定条件6(hh:mm-hh:mm)

判定条件6を指定します。

−　

入力

△　

common.condition6Output

出力文字列6

判定条件6に一致した場合に出力する文字列を指定します。省略すると，"6"が設定されます。

−　

入力

△　

common.condition7

判定条件7(hh:mm-hh:mm)

判定条件7を指定します。

−　

入力

△　

common.condition7Output

出力文字列7

判定条件7に一致した場合に出力する文字列を指定します。省略すると，"7"が設定されます。

−　

入力

△　

common.condition8

判定条件8(hh:mm-hh:mm)

判定条件8を指定します。

−　

入力

△　

common.condition8Output

出力文字列8

判定条件8に一致した場合に出力する文字列を指定します。省略すると，"8"が設定されます。

−　

入力

△　

common.condition9

判定条件9(hh:mm-hh:mm)

判定条件9を指定します。

−　

入力

△　

common.condition9Output

出力文字列9

判定条件9に一致した場合に出力する文字列を指定します。省略すると，"9"が設定されます。

−　

入力

△　

common.condition10

判定条件10(hh:mm-hh:mm)

判定条件10を指定します。

−　

入力

△　

common.condition10Output

出力文字列10

判定条件10に一致した場合に出力する文字列を指定します。省略すると，"10"が設定されます。

−　

入力

△　

common.otherConditionOutput

条件に一致しなかった場合の出力文字列

すべての判定条件に一致しなかった場合に出力する文字列を指定します。

99

入力

○　

common.matchConditionOutput

一致した条件

一致した判定条件の出力文字列，または判定条件に一致しなかった場合の出力文字列が格納されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5　JP1/AO Content Pack版部品

この章では，JP1/AO Content Pack版部品について説明します。

5.1　JP1/AO Content Pack版コンテンツ部品一覧

5.1.1　AWS関連の部品一覧

項番

部品名

機能

1

AMIの作成

Amazon EC2環境で，インスタンスからAMIを作成します。

2

スタックの作成

AWS CloudFormation環境で，テンプレートファイルからスタックを作成します。

3

スタックの削除

AWS CloudFormation環境でスタックを削除します。

4

スタックの情報一覧取得

AWS CloudFormation環境で管理されているスタック一覧をCSV形式でファイルに出力します。

5

スナップショットの作成

Amazon EBS環境で管理されているボリュームのバックアップとしてスナップショットを作成します。

6

スナップショットの削除

Amazon EBS環境で管理されているスナップショットを削除します。

7

スナップショットの情報一覧取得

Amazon EBS環境で管理されているスナップショット一覧をCSV形式でファイルに出力します。

8

ファイルのアップロード

Amazon S3環境にファイルをアップロードします。

9

ファイルのダウンロード

Amazon S3環境で管理されているファイルをダウンロードします。

10

ファイルの削除

Amazon S3環境で管理されているファイルを削除します。

11

仮想サーバのインスタンスタイプ設定

Amazon EC2環境で，インスタンスのインスタンスタイプを変更します。

12

仮想サーバのシャットダウン

Amazon EC2環境で，仮想サーバをシャットダウン(Amazon EC2では，インスタンスの停止という)します。

13

仮想サーバの起動

Amazon EC2環境で，インスタンスを起動します。

14

仮想サーバの作成

Amazon EC2環境で，仮想サーバを作成(Amazon EC2では，インスタンスの起動という)します。

15

仮想サーバの削除

Amazon EC2環境で，インスタンスを削除します。

16

仮想サーバの情報一覧取得

Amazon EC2環境で管理されているインスタンス情報一覧をCSV形式でファイルに出力します。

17

仮想サーバの状態取得

Amazon EC2環境で，インスタンスの状態を取得します。

5.1.2　HCS関連の部品一覧

項番

部品名

機能

1

DPボリュームの作成

Device Managerで管理されたストレージシステムで，指定されたDPボリュームを作成します。

2

DPボリュームの削除

Device Managerで管理されたストレージシステムで，指定されたDPボリュームを削除します。

3

HDvM接続確認

HDvMサーバに接続できるかどうか確認します。

4

LU作成確認

DPボリューム(LU)を作成できるかどうか確認します。

5

ストレージ情報一覧取得

ストレージ情報の一覧をHDvM CLIサーバの一時ファイルに出力します。

6

ホストグループからLUを削除

Device Managerで管理されたストレージシステムで，指定されたLUをホストグループから削除します。

7

ホストグループにLUを登録

Device Managerで管理されたストレージシステムで，指定されたLUをホストグループに登録します。

5.1.3　Hyper-V 2008関連の部品一覧

項番

部品名

機能

1

応答ファイルの作成

Hyper-V環境の仮想サーバ(Windows)に対してOSの初期設定，およびIPアドレス設定を行うための応答ファイルを作成します。

2

仮想サーバのIPアドレス取得

Hyper-V環境において，仮想サーバのIPアドレス(IPv4)を取得します。

3

仮想サーバのシャットダウン

Hyper-V環境において，仮想サーバのOSを強制的にシャットダウンします。

4

仮想サーバの仮想スイッチ設定

Hyper-V環境の仮想サーバに仮想スイッチを設定します。

5

仮想サーバの起動

Hyper-V環境において，仮想サーバを起動します。

6

仮想サーバの作成

Hyper-V環境において，エクスポート済みの仮想サーバから仮想サーバを作成します。

7

仮想サーバの削除

Hyper-V環境において，仮想サーバを削除します。

8

仮想サーバの情報一覧取得

仮想サーバの情報一覧をHyper-Vサーバの一時ファイルに出力します。

9

仮想サーバの状態取得

Hyper-V環境において，仮想サーバの状態を取得します。

10

仮想サーバへのディスク追加

Hyper-V環境において，仮想サーバにディスクを追加します。

11

仮想ディスクのアンマウント

Hyper-Vサーバから仮想ディスクをアンマウントします。

12

仮想ディスクのマウント

Hyper-Vサーバに仮想ディスクをマウントします。

5.1.4　Hyper-V 2012関連の部品一覧

項番

部品名

機能

1

応答ファイルの作成

Hyper-V 2012環境の仮想サーバ(Windows)に対してOSの初期設定，およびIPアドレス設定を行うための応答ファイルを作成します。

2

仮想サーバのCPU設定変更

Hyper-V 2012環境において，仮想サーバのCPU設定を変更します。

3

仮想サーバのIPアドレス取得

Hyper-V 2012環境において，仮想サーバのIPアドレス(IPv4)を取得します。

4

仮想サーバのシャットダウン

Hyper-V 2012環境において，仮想サーバのOSを強制的にシャットダウンします。

5

仮想サーバのメモリ設定変更

Hyper-V 2012環境において，仮想サーバのメモリ設定を変更します。

6

仮想サーバの仮想スイッチ設定

Hyper-V 2012環境の仮想サーバに仮想スイッチを設定します。

7

仮想サーバの起動

Hyper-V 2012環境において，仮想サーバを起動します。

8

仮想サーバの作成

Hyper-V 2012環境において，エクスポート済みの仮想サーバから仮想サーバを作成します。

9

仮想サーバの削除

Hyper-V 2012環境において，仮想サーバを削除します。

10

仮想サーバの情報一覧取得

Hyper-V 2012環境において，仮想サーバの情報一覧をHyper-Vサーバの一時ファイルに出力します。

11

仮想サーバの状態取得

Hyper-V 2012環境において，仮想サーバの状態を取得します。

12

仮想ディスクのアンマウント

Hyper-V 2012環境のHyper-Vサーバから仮想ディスクをアンマウントします。

13

仮想ディスクのマウント

Hyper-V 2012環境のHyper-Vサーバに仮想ディスクをマウントします。

14

仮想ディスクの作成

Hyper-V 2012環境において，仮想ディスクを作成します。

15

仮想ディスクの接続

Hyper-V 2012環境において，仮想サーバに仮想ディスクを接続します。

5.1.5　Hyper-V 2016関連の部品一覧

項番

部品名

機能

1

応答ファイルの作成

Hyper-V 2016環境の仮想サーバ(Windows)に対してOSの初期設定，およびIPアドレス設定を行うための応答ファイルを作成します。

2

仮想サーバのCPU設定変更

Hyper-V 2016環境において，仮想サーバのCPU設定を変更します。

3

仮想サーバのIPアドレス取得

Hyper-V 2016環境において，仮想サーバのIPアドレス(IPv4)を取得します。

4

仮想サーバのシャットダウン

Hyper-V 2016環境において，仮想サーバのOSを強制的にシャットダウンします。

5

仮想サーバのメモリ設定変更

Hyper-V 2016環境において，仮想サーバのメモリ設定を変更します。

6

仮想サーバの仮想スイッチ設定

Hyper-V 2016環境の仮想サーバに仮想スイッチを設定します。

7

仮想サーバの起動

Hyper-V 2016環境において，仮想サーバを起動します。

8

仮想サーバの作成

Hyper-V 2016環境において，エクスポート済みの仮想サーバから仮想サーバを作成します。

9

仮想サーバの削除

Hyper-V 2016環境において，仮想サーバを削除します。

10

仮想サーバの情報一覧取得

Hyper-V 2016環境において，仮想サーバの情報一覧をHyper-Vサーバの一時ファイルに出力します。

11

仮想サーバの状態取得

Hyper-V 2016環境において，仮想サーバの状態を取得します。

12

仮想ディスクのアンマウント

Hyper-V 2016環境のHyper-Vサーバから仮想ディスクをアンマウントします。

13

仮想ディスクのマウント

Hyper-V 2016環境のHyper-Vサーバに仮想ディスクをマウントします。

14

仮想ディスクの作成

Hyper-V 2016環境において，仮想ディスクを作成します。

15

仮想ディスクの接続

Hyper-V 2016環境において，仮想サーバに仮想ディスクを接続します。

5.1.6　Linux関連の部品一覧

項番

部品名

機能

1

OS初期設定(Linux)

OS初期設定(ホスト名，タイムゾーン，DNSサフィックス)を行います。

5.1.7　OpenStack関連の部品一覧

項番

部品名

機能

1

ボリュームのバックアップ

OpenStack管理下のボリュームのバックアップを取得します。

2

ボリュームの作成

OpenStack管理下のKVM環境において，ボリュームを作成します。

3

ボリュームの削除

OpenStack管理下のボリュームを削除します。

4

ボリュームの切断

OpenStack管理下のKVM環境において，インスタンスに接続されているボリュームを切断します。

5

ボリュームの接続

OpenStack管理下のKVM環境において，インスタンスにボリュームを接続します。

6

一時ボリュームの作成

OpenStack管理下のボリュームを元に一時ボリュームを作成します。

7

仮想サーバのIPアドレス取得

OpenStack管理下のKVM環境において，インスタンスのすべてのNICに設定されたIPアドレス(IPv4)を取得します。

8

仮想サーバの起動

OpenStack管理下のKVM環境において，インスタンスを起動します。

9

仮想サーバの作成

イメージから仮想サーバを作成(OpenStackでは，インスタンスの起動という)します。

10

仮想サーバの削除

OpenStack管理下のKVM環境で，インスタンスを削除します。また，インスタンスにFloating IPアドレスが設定されている場合，Floating IPアドレスの割り当てを解除します。

11

仮想サーバの情報一覧取得

OpenStack管理下のKVM環境において，指定したプロジェクトに含まれるインスタンス情報一覧をOpenStack操作サーバ(実行対象サーバ)のファイルに出力します。

12

仮想サーバの状態取得

OpenStack管理下のKVM環境において，インスタンスの状態を取得します。

5.1.8　Oracle関連の部品一覧

項番

部品名

機能

1

OracleDBインスタンスの起動

WindowsまたはUNIX環境の実行対象サーバにおいて，SQL*Plusを起動し，STARTUPコマンドを実行してインスタンスを起動します。

2

OracleDBインスタンスの停止

WindowsまたはUNIX環境の実行対象サーバにおいて，SQL*Plusを起動し，SHUTDOWNコマンドを実行してインスタンスを停止させます。

3

OracleDBユーザーの削除

WindowsまたはUNIX環境の実行対象サーバにおいて，SQL*Plusを起動し，DROP USER文を実行してDBユーザーを削除します。

4

OracleDBユーザーの追加(UNIX)

UNIX環境の実行対象サーバにおいて，SQL*Plusを起動し，CREATE USER文を実行してDBユーザーを追加します。

5

OracleDBユーザーの追加(Windows)

Windowsの実行対象サーバにおいて，SQL*Plusを起動し，CREATE USER文を実行してDBユーザーを追加します。

5.1.9　OS関連の部品一覧

項番

部品名

機能

1

スタティックルートの設定

WindowsまたはLinuxの実行対象サーバで，スタティックルートを設定します。

5.1.10　vSphere関連の部品一覧

項番

部品名

機能

1

DRSクラスタのDRS自動化レベル設定

VMware vSphere環境で，vSphere DRSクラスタに属している仮想サーバに対し，DRS自動化レベルを設定します。

2

DRSルール(仮想サーバからホストへ)の追加

VMware vSphere環境で，vSphere DRSクラスタのDRSルール(仮想サーバからホストへ)を追加します。

3

ESXサーバのメンテナンスモード設定

VMware vSphere環境で，ESXサーバに対して「メンテナンスモードへの切り替え」，または「メンテナンスモードを終了」を実行します。

4

ESXサーバの移動

VMware vSphere環境で，ESXサーバを移動します。

5

ESXサーバの仮想ネットワーク情報一覧取得部品

VMware vSphere環境で，仮想ネットワーク情報の一覧を取得します。

6

FCパスの優先設定

VMware vSphere ESXi(またはVMware ESX Server)の指定されたデータストアに対するFCパスを「優先」に設定します。

7

HAクラスタの仮想サーバのオプション設定

VMware vSphere環境で，vSphere HAクラスタの仮想サーバの動作を定義するオプションを設定します。

8

HAクラスタの仮想サーバの監視設定

VMware vSphere環境で，vSphere HAクラスタに属している仮想サーバに対し，仮想サーバの監視を設定します。

9

LUNの再認識

追加または削除したLUNをVMware vSphere ESXi(またはVMware ESX Server)に認識させます。

10

SCSI LUNのCanonical名を取得

VMware vSphere ESXi(またはVMware ESX Server)が認識しているSCSI LUNのCanonical名を取得します。

11

vCenterサーバ経由でのスクリプト実行

VMware vSphere環境で，仮想サーバのゲストOS上に配置された非対話型のスクリプトを実行します。

12

vCenterサーバ経由でのファイル削除

VMware vSphere環境で，仮想サーバのゲストOS上で指定したファイルを削除します。

13

vCenterサーバ経由でのファイル送信

VMware vSphere環境で，指定したファイルを実行対象サーバから仮想サーバのゲストOSに送信します。

14

vCenterサーバ経由でのフォルダ削除

VMware vSphere環境で，仮想サーバのゲストOS上で指定したフォルダを削除します。

15

vCenterサーバ経由でのフォルダ送信

VMware vSphere環境で，指定したフォルダを実行対象サーバから仮想サーバのゲストOSに送信します。

16

VMware vCenter Server接続確認

vCenterサーバに接続できるかどうか確認します。

17

データストア作成

VMware vSphere ESXi(またはVMware ESX Server)にデータストアを追加します。

18

データストア作成確認

データストアを追加できるかどうか確認します。

19

データストア削除

VMware vSphere ESXi(またはVMware ESX Server)からデータストアを削除します。

20

テンプレートの作成

VMware vSphere環境で，仮想サーバからテンプレートを作成します。

21

テンプレートの削除

VMware vSphere環境において，仮想サーバのテンプレートを削除します。

22

ネットワークアダプタの設定変更

VMware vSphere環境で，仮想サーバに割り当てられているネットワークアダプタの設定を変更します。

23

ネットワークアダプタの追加

VMware vSphere環境で，仮想サーバにネットワークアダプタを追加します。

24

ポートグループのトラフィックシェーピングポリシー設定

VMware vSphere環境で，標準仮想スイッチのポートグループに対し，トラフィックシェーピングポリシーを設定します。

25

ホストDRSグループの設定

VMware vSphere環境で，vSphere DRSクラスタに設定されているホストDRSグループにESXサーバを追加，または削除します。

26

ログバンドルの取得

VMware vSphere環境で，vCenterサーバまたはESXサーバからログバンドルを取得します。

27

仮想サーバDRSグループの設定

VMware vSphere環境で，vSphere DRSクラスタに設定されている仮想サーバDRSグループに仮想サーバを追加，または削除します。

28

仮想サーバのIPアドレス取得

VMware vSphere環境で，仮想サーバのIPアドレスを取得します。

29

仮想サーバのOS初期設定&IPアドレス設定(Linux)

VMware vSphere環境の仮想サーバ(Linux)に対してOSの初期設定，およびIPアドレス設定を行います。

30

仮想サーバのOS初期設定&IPアドレス設定(Windows)

VMware vSphere環境の仮想サーバ(Windows)に対してOSの初期設定，およびIPアドレス設定を行います。

31

仮想サーバのクローン作成

VMware vSphere環境の仮想サーバのクローンを作成します。

32

仮想サーバのクローン削除

VMware vSphere環境の仮想サーバのクローンを削除します。

33

仮想サーバのシャットダウン

VMware vSphere環境で，仮想サーバのシャットダウンを行い，電源状態をOFFに設定します。

34

仮想サーバのスナップショット移動

VMware vSphere環境において，仮想サーバで使用しているスナップショットを，仮想サーバ上の指定されたスナップショットに移動します。

35

仮想サーバのスナップショット作成

VMware vSphere環境において，仮想サーバのスナップショットを作成します。

36

仮想サーバのスナップショット削除

VMware vSphere環境において，仮想サーバのスナップショットを削除します。

37

仮想サーバのマイグレーション

VMware vSphere環境で，指定された移動先へ仮想サーバをマイグレーションします。

38

仮想サーバのリソース構成の設定

VMware vCenter Serverで管理される仮想サーバについてCPU，メモリ，ディスクI/Oのリソースの設定を変更します。

39

仮想サーバのリソース構成変更の事前判定

VMware vCenter Serverで管理される仮想サーバについてCPU，メモリ，ディスクI/Oのリソース構成変更時の事前判定を行います。

40

仮想サーバのリソース設定

VMware vSphere環境で，仮想サーバのリソース(CPU数，メモリ容量)割り当てを変更します。

41

仮想サーバのリソース変更の事前判定

VMware vCenter Serverで管理される仮想サーバについてCPU，メモリのリソース変更時の事前判定を行います。

42

仮想サーバの起動

VMware vSphere環境で，仮想サーバを起動します。

43

仮想サーバの作成

VMware vSphere環境で，テンプレートから仮想サーバを作成します。

44

仮想サーバの削除

VMware vSphere環境で，指定された仮想サーバを削除します。

45

仮想サーバの電源状態取得

VMware vSphere環境で，仮想サーバの電源状態を取得します。

46

仮想サーバへの仮想ディスク追加

VMware vSphere環境で，仮想サーバに仮想ディスクを追加します。

47

仮想サーバ作成確認

指定されたテンプレートから仮想サーバを作成できるかどうか確認します。

48

仮想サーバ情報一覧取得

仮想サーバ情報の一覧をVMware vCenter操作サーバの一時ファイルに出力します。

49

仮想ディスクの拡張

VMware vSphere環境で，仮想サーバに設定されている仮想ディスクの容量を拡張します。

50

仮想ディスクの削除

VMware vSphere環境で，仮想サーバから仮想ディスクを削除します。

51

仮想マシンのポートグループ変更

VMware vSphere環境の仮想サーバに接続されているポートグループを変更します。

52

標準仮想スイッチへのポートグループ追加

VMware vSphere環境で，標準仮想スイッチにポートグループを追加します。

53

物理アダプタの情報一覧取得

VMware vSphere環境で，ESXサーバに接続されている物理アダプタの情報を出力します。

54

物理アダプタの設定

VMware vSphere環境で，標準仮想スイッチに接続されている物理アダプタの状態を設定します。

5.1.11　Windows関連の部品一覧

項番

部品名

機能

1

NICのMACアドレス取得

NICのMACアドレスを取得します。

2

Windowsネットワークの設定

NICにIPアドレスを設定します。

3

Windows更新プログラムのインストール

Windows環境においてWindows Update機能による更新プログラムの自動インストールを行います。

4

Windows更新プログラムのインストール(SYSTEM)

Windows環境においてWindows Update機能による更新プログラムの自動インストールを行います。

5.2　AWS関連の部品

5.2.1　AMIの作成

機能

この部品は，Amazon EC2環境で，インスタンスからAMI(Amazonマシンイメージ) を作成します。

この部品が前提とするサーバを次に示します。

・AWS操作サーバ(実行対象サーバ)

　AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によってこのサーバに部品が転送され，実行されます。

・インスタンス

　Amazon EC2環境の仮想ホストのことで，一般的な仮想サーバのことです。

この部品内のスクリプトでは，次に示すAWS Toolsのコマンドレットを実行します。

・New-EC2Image -InstanceId "インスタンスID(AWS.instanceIdプロパティ)の値"

　　　　　　　 -Name "AMI名(AWS.amiNameプロパティ)の値"

　　　　　　　 -Description "AMIの説明(AWS.amiDescriptionプロパティ)の値"

　　　　　　　 -NoReboot "インスタンス再起動抑止(AWS.instanceNoRebootプロパティ)の値"

　　　　　　　 -Force

上記コマンドレットを実行したあと，作成したAMIの状態が"available"になることを確認します。

AWS Toolsのコマンドレットの詳細については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」を参照してください。

利用場面

この部品は，Amazon EC2環境でカスタマイズしたインスタンスからAMIを作成する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】/【実行対象システム内前提製品】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　・AWS Tools for Windows PowerShell

　・Microsoft .Net Framework 3.5以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　ただし，Server Coreインストール環境は除く。

【実行対象システム内前提製品】

(1) インスタンスの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1) インスタンスに関する条件

　・使用するインスタンスの状態が"running"または"stopped"であること。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) AMI名(AWS.amiNameプロパティ)には，作成済みのAMI名を指定しないでください。指定した場合，タスクが異常終了します。

(3) その他の注意事項については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」の注意事項を参照してください。

実行権限

(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。

　・イメージの作成

バージョン

02.01.00

部品のタグ

Add VM Template,AWS

タスクログに表示される部品の名称

awsCreateImage

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

AWS.accessKeyId

アクセスキーID

AWSに接続するためのアクセスキーIDを指定します。

−　

入力

○　

AWS.secretAccessKey

シークレットアクセスキー

AWSに接続するためのシークレットアクセスキーを指定します。

−　

入力

○　

AWS.region

リージョン

接続先となるAWSのリージョンを指定します。

−　

入力

○　

AWS.instanceId

インスタンスID

インスタンスのIDを指定します。

−　

入力

○　

AWS.amiName

AMI名

作成するAMIの名称を指定します。

−　

入力

○　

AWS.amiDescription

AMIの説明

作成するAMIに設定する説明を指定します。

−　

入力

△　

AWS.instanceNoReboot

インスタンス再起動抑止

AMIを作成する前にインスタンスを停止しない場合は"true"を指定します。"true"以外の場合は，インスタンスをいったん停止してAMIを作成し，そのあと再起動します。

−　

入力

△　

AWS.checkAmiCreationCount

AMIの作成完了の確認回数

AMIの作成が完了したか確認する際の確認回数を指定します。AMIの作成完了の確認間隔と組み合わせて最大待ち時間となります。

−　

入力

○　

AWS.checkAmiCreationInterval

AMIの作成完了の確認間隔

AMIの作成が完了したか確認する際の確認間隔を秒単位で指定します。

−　

入力

○　

AWS.amiIdOutput

AMI ID

作成したAMIのIDが格納されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.2.2　スタックの作成

機能

この部品は，AWS CloudFormation環境で，Amazon S3バケットに保存されているテンプレートファイルからスタックを作成します。スタックを作成すると，テンプレートファイルに記述されているAWSリソースがAWS CloudFormationによって作成されます。

作成されたAWSリソースのリソースIDは，AWS.resourceIdプロパティに格納されます。複数のリソースが作成された場合には，コンマ区切りで出力されます。

ただし，リソースIDの長さの合計が1024文字を超える場合，1025文字目以降を含むリソースIDは切り捨てられます。

この部品が前提とするサーバを次に示します。

・AWS操作サーバ(実行対象サーバ)

　AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によってこのサーバに部品が転送され，実行されます。

この部品内のスクリプトでは，次に示すAWS Toolsのコマンドレットを実行します。

・New-CFNStack -StackName "スタック名(AWS.stackNameプロパティ)の値"

　　　　　　　 -OnFailure "スタック作成失敗時の動作(AWS.actionStackCreationFailプロパティ)の値"

　　　　　　　 -TemplateURL "Amazon S3バケットに保存されているテンプレートファイルのURL" ※1

　　　　　　　 [-Parameter "テンプレートファイルのパラメーターに設定する値"] ※2

　　　　　　　 -Capability "CAPABILITY_IAM"

　　　　　　　 -Force

　　※1 バケット名(AWS.bucketNameプロパティ)とキー名(AWS.keyNameプロパティ)を組み合わせた値。

　　※2 テンプレートパラメーターキー(AWS.templateParameterKeyプロパティ)とテンプレートパラメーター値(AWS.templateParameterValueプロパティ)を組み合わせた値。20組まで設定可能。

上記コマンドレットを実行したあと，作成したスタックの状態が"CREATE_COMPLETE"になることを確認します。

AWS Toolsのコマンドレットの詳細については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」を参照してください。

利用場面

この部品は，AWS CloudFormation環境でテンプレートファイルからAWSリソースを作成する時に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　・AWS Tools for Windows PowerShell

　・Microsoft .Net Framework 3.5以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　ただし，Server Coreインストール環境は除く。

【実行対象システムの使用条件】

(1) スタックに関する条件

　・スタックの作成に使用するテンプレートファイルがAmazon S3バケットに保存されていること。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) スタック名(AWS.stackNameプロパティ)には，作成済みのスタック名を指定しないでください。指定した場合，タスクが異常終了します。

(3) その他の注意事項については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」の注意事項を参照してください。

実行権限

(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。

　・スタックの作成および情報取得

・Amazon S3アップロートファイルの操作

　・AWSリソースの作成

バージョン

02.01.00

部品のタグ

Add VM,AWS

タスクログに表示される部品の名称

awsCreateStack

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

AWS.accessKeyId

アクセスキーID

AWSに接続するためのアクセスキーIDを指定します。

−　

入力

○　

AWS.secretAccessKey

シークレットアクセスキー

AWSに接続するためのシークレットアクセスキーを指定します。

−　

入力

○　

AWS.region

リージョン

接続先となるAWSのリージョンを指定します。

−　

入力

○　

AWS.bucketName

バケット名

テンプレートファイルをアップロードしたバケット名を指定します。

−　

入力

○　

AWS.keyName

キー名

アップロードしたテンプレートファイルに設定したキー名を指定します。

−　

入力

○　

AWS.stackName

スタック名

スタックの名称を指定します。

−　

入力

○　

AWS.actionStackCreationFail

スタック作成失敗時の動作

スタックの作成に失敗した時の動作を指定します。指定可能な値は"DO_NOTHING"，"ROLLBACK"，"DELETE"のどれかです。

−　

入力

○　

AWS.checkStackCreationCount

スタックの作成完了の確認回数

スタックの作成が完了したか確認する際の確認回数を指定します。スタックの作成完了の確認間隔と組み合わせて最大待ち時間となります。

−　

入力

○　

AWS.checkStackCreationInterval

スタックの作成完了の確認間隔

スタックの作成が完了したか確認する際の確認間隔を秒単位で指定します。

−　

入力

○　

AWS.templateParameterKey1

テンプレートパラメーターキー1

テンプレートファイルに定義されているパラメーターのキー名称を指定します。

−　

入力

△　

AWS.templateParameterValue1

テンプレートパラメーター値1

テンプレートパラメーターキー1に対応する値を指定します。

−　

入力

△　

AWS.templateParameterKey2

テンプレートパラメーターキー2

テンプレートファイルに定義されているパラメーターのキー名称を指定します。

−　

入力

△　

AWS.templateParameterValue2

テンプレートパラメーター値2

テンプレートパラメーターキー2に対応する値を指定します。

−　

入力

△　

AWS.templateParameterKey3

テンプレートパラメーターキー3

テンプレートファイルに定義されているパラメーターのキー名称を指定します。

−　

入力

△　

AWS.templateParameterValue3

テンプレートパラメーター値3

テンプレートパラメーターキー3に対応する値を指定します。

−　

入力

△　

AWS.templateParameterKey4

テンプレートパラメーターキー4

テンプレートファイルに定義されているパラメーターのキー名称を指定します。

−　

入力

△　

AWS.templateParameterValue4

テンプレートパラメーター値4

テンプレートパラメーターキー4に対応する値を指定します。

−　

入力

△　

AWS.templateParameterKey5

テンプレートパラメーターキー5

テンプレートファイルに定義されているパラメーターのキー名称を指定します。

−　

入力

△　

AWS.templateParameterValue5

テンプレートパラメーター値5

テンプレートパラメーターキー5に対応する値を指定します。

−　

入力

△　

AWS.templateParameterKey6

テンプレートパラメーターキー6

テンプレートファイルに定義されているパラメーターのキー名称を指定します。

−　

入力

△　

AWS.templateParameterValue6

テンプレートパラメーター値6

テンプレートパラメーターキー6に対応する値を指定します。

−　

入力

△　

AWS.templateParameterKey7

テンプレートパラメーターキー7

テンプレートファイルに定義されているパラメーターのキー名称を指定します。

−　

入力

△　

AWS.templateParameterValue7

テンプレートパラメーター値7

テンプレートパラメーターキー7に対応する値を指定します。

−　

入力

△　

AWS.templateParameterKey8

テンプレートパラメーターキー8

テンプレートファイルに定義されているパラメーターのキー名称を指定します。

−　

入力

△　

AWS.templateParameterValue8

テンプレートパラメーター値8

テンプレートパラメーターキー8に対応する値を指定します。

−　

入力

△　

AWS.templateParameterKey9

テンプレートパラメーターキー9

テンプレートファイルに定義されているパラメーターのキー名称を指定します。

−　

入力

△　

AWS.templateParameterValue9

テンプレートパラメーター値9

テンプレートパラメーターキー9に対応する値を指定します。

−　

入力

△　

AWS.templateParameterKey10

テンプレートパラメーターキー10

テンプレートファイルに定義されているパラメーターのキー名称を指定します。

−　

入力

△　

AWS.templateParameterValue10

テンプレートパラメーター値10

テンプレートパラメーターキー10に対応する値を指定します。

−　

入力

△　

AWS.templateParameterKey11

テンプレートパラメーターキー11

テンプレートファイルに定義されているパラメーターのキー名称を指定します。

−　

入力

△　

AWS.templateParameterValue11

テンプレートパラメーター値11

テンプレートパラメーターキー11に対応する値を指定します。

−　

入力

△　

AWS.templateParameterKey12

テンプレートパラメーターキー12

テンプレートファイルに定義されているパラメーターのキー名称を指定します。

−　

入力

△　

AWS.templateParameterValue12

テンプレートパラメーター値12

テンプレートパラメーターキー12に対応する値を指定します。

−　

入力

△　

AWS.templateParameterKey13

テンプレートパラメーターキー13

テンプレートファイルに定義されているパラメーターのキー名称を指定します。

−　

入力

△　

AWS.templateParameterValue13

テンプレートパラメーター値13

テンプレートパラメーターキー13に対応する値を指定します。

−　

入力

△　

AWS.templateParameterKey14

テンプレートパラメーターキー14

テンプレートファイルに定義されているパラメーターのキー名称を指定します。

−　

入力

△　

AWS.templateParameterValue14

テンプレートパラメーター値14

テンプレートパラメーターキー14に対応する値を指定します。

−　

入力

△　

AWS.templateParameterKey15

テンプレートパラメーターキー15

テンプレートファイルに定義されているパラメーターのキー名称を指定します。

−　

入力

△　

AWS.templateParameterValue15

テンプレートパラメーター値15

テンプレートパラメーターキー15に対応する値を指定します。

−　

入力

△　

AWS.templateParameterKey16

テンプレートパラメーターキー16

テンプレートファイルに定義されているパラメーターのキー名称を指定します。

−　

入力

△　

AWS.templateParameterValue16

テンプレートパラメーター値16

テンプレートパラメーターキー16に対応する値を指定します。

−　

入力

△　

AWS.templateParameterKey17

テンプレートパラメーターキー17

テンプレートファイルに定義されているパラメーターのキー名称を指定します。

−　

入力

△　

AWS.templateParameterValue17

テンプレートパラメーター値17

テンプレートパラメーターキー17に対応する値を指定します。

−　

入力

△　

AWS.templateParameterKey18

テンプレートパラメーターキー18

テンプレートファイルに定義されているパラメーターのキー名称を指定します。

−　

入力

△　

AWS.templateParameterValue18

テンプレートパラメーター値18

テンプレートパラメーターキー18に対応する値を指定します。

−　

入力

△　

AWS.templateParameterKey19

テンプレートパラメーターキー19

テンプレートファイルに定義されているパラメーターのキー名称を指定します。

−　

入力

△　

AWS.templateParameterValue19

テンプレートパラメーター値19

テンプレートパラメーターキー19に対応する値を指定します。

−　

入力

△　

AWS.templateParameterKey20

テンプレートパラメーターキー20

テンプレートファイルに定義されているパラメーターのキー名称を指定します。

−　

入力

△　

AWS.templateParameterValue20

テンプレートパラメーター値20

テンプレートパラメーターキー20に対応する値を指定します。

−　

入力

△　

AWS.resourceId

リソースID

作成されたリソースのIDが格納されます。複数のリソースが作成された場合には，コンマ区切りで出力されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.2.3　スタックの削除

機能

この部品は，AWS CloudFormation環境で，スタックを削除します。スタックを削除すると，スタックに関連するAWSリソースもAWS CloudFormationによってすべて削除されます。

この部品が前提とするサーバを次に示します。

・AWS操作サーバ(実行対象サーバ)

　AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によってこのサーバに部品が転送され，実行されます。

この部品内のスクリプトでは，次に示すAWS Toolsのコマンドレットを実行します。

・Remove-CFNStack -StackName "スタック名(AWS.stackNameプロパティ)の値"

　　　　　　　　　-Force

上記コマンドレットを実行したあと，削除したスタックが存在しないことを確認します。

AWS Toolsのコマンドレットの詳細については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」を参照してください。

利用場面

この部品は，テンプレートファイルから作成したAWSリソースを削除する時に使用できます。また，AWSリソース作成に失敗したスタックなど，不要なスタックを削除する時も使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　・AWS Tools for Windows PowerShell

　・Microsoft .Net Framework 3.5以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　ただし，Server Coreインストール環境は除く。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) 削除対象の存在チェック行い，存在しない場合は戻り値12の異常終了となります。

(3) 削除対象の存在チェック行い，存在する場合かつステータスが"DELETE_IN_PROGRESS"の場合は戻り値12の異常終了となります。

(4) AWSリソースを削除できなかった場合，スタックは削除されずに残ります。

(5) その他の注意事項については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」の注意事項を参照してください。

実行権限

(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。

　・スタックの削除および情報取得

　・AWSリソースの削除

バージョン

02.01.00

部品のタグ

Delete VM,AWS

タスクログに表示される部品の名称

awsDeleteStack

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

AWS.accessKeyId

アクセスキーID

AWSに接続するためのアクセスキーIDを指定します。

−　

入力

○　

AWS.secretAccessKey

シークレットアクセスキー

AWSに接続するためのシークレットアクセスキーを指定します。

−　

入力

○　

AWS.region

リージョン

接続先となるAWSのリージョンを指定します。

−　

入力

○　

AWS.stackName

スタック名

スタックの名称を指定します。

−　

入力

○　

AWS.checkStackDeletionCount

スタックの削除完了の確認回数

スタックの削除が完了したか確認する際の確認回数を指定します。スタックの削除完了の確認間隔と組み合わせて最大待ち時間となります。

−　

入力

○　

AWS.checkStackDeletionInterval

スタックの削除完了の確認間隔

スタックの削除が完了したか確認する際の確認間隔を秒単位で指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.2.4　スタックの情報一覧取得

機能

この部品は，AWS CloudFormation環境で管理されているスタックの情報一覧を，CSV形式でAWS操作サーバ(実行対象サーバ)のファイルに出力します。

出力ファイルのエンコード形式は，AWS操作サーバ(実行対象サーバ)のシステムのデフォルトエンコーディングです。

この部品が前提とするサーバを次に示します。

・AWS操作サーバ(実行対象サーバ)

　AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によってこのサーバに部品が転送され，実行されます。

この部品内のスクリプトでは，次に示すAWS Toolsのコマンドレットを実行します。

・Get-CFNStack

AWS Toolsのコマンドレットの詳細については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」を参照してください。

出力するCSVファイルの項目を次に示します。

項目はコンマ区切りで出力します。

(a) スタック名(ヘッダー名：StackName)

(b) スタック作成時間(ヘッダー名：CreatedTime)

(c) スタックの状態(ヘッダー名：Status)

(d) スタックの説明(ヘッダー名：Description)

利用場面

この部品は，AWS CloudFormation環境で管理されているスタックの情報を取得する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　・AWS Tools for Windows PowerShell

　・Microsoft .Net Framework 3.5以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　ただし，Server Coreインストール環境は除く。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) スタック情報一覧出力ファイル名(AWS.stackInfoListOutputFileNameプロパティ)に指定したファイルが既に存在する場合，既存のファイルを上書きします。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(3) 作成するファイルのパスに含まれるフォルダが存在しない場合は，そのフォルダを作成します。

(4) その他の注意事項については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」の注意事項を参照してください。

実行権限

(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。

　・スタックの情報取得

バージョン

02.01.00

部品のタグ

Gather VM information,AWS

タスクログに表示される部品の名称

awsOutputStackSpec

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

AWS.accessKeyId

アクセスキーID

AWSに接続するためのアクセスキーIDを指定します。

−　

入力

○　

AWS.secretAccessKey

シークレットアクセスキー

AWSに接続するためのシークレットアクセスキーを指定します。

−　

入力

○　

AWS.region

リージョン

接続先となるAWSのリージョンを指定します。

−　

入力

○　

AWS.stackInfoListOutputFileName

スタック情報一覧出力ファイル名

スタック情報一覧を出力するファイル名をフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.2.5　スナップショットの作成

機能

この部品は，Amazon EBS環境で管理されているボリュームのバックアップとしてスナップショットを作成します。

この部品が前提とするサーバを次に示します。

・AWS操作サーバ(実行対象サーバ)

　AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によりこのサーバに部品が転送され，実行されます。

この部品内のスクリプトでは，次に示すAWS Toolsのコマンドレットを実行します。

・New-EC2Snapshot -VolumeId "ボリュームID(AWS.volumeIdプロパティ)の値"

　　　　　　　　　 [-Description "スナップショットの説明(AWS.snapshotDescriptionプロパティ)の値"]

　上記コマンドレットを実行したあと，作成したスナップショットの状態が"completed"になることを確認します。

AWS Toolsのコマンドレットの詳細については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」を参照してください。

利用場面

この部品は，Amazon EBS環境で管理されているボリュームのバックアップとしてスナップショットを作成する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　・AWS Tools for Windows PowerShell

　・Microsoft .Net Framework 3.5以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) その他の注意事項については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」の注意事項を参照してください。

実行権限

(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。

　・スナップショットの作成

バージョン

02.00.01

部品のタグ

Snapshot VM,AWS

タスクログに表示される部品の名称

awsCreateSnapshot

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

AWS.accessKeyId

アクセスキーID

AWSに接続するためのアクセスキーIDを指定します。

−　

入力

○　

AWS.secretAccessKey

シークレットアクセスキー

AWSに接続するためのシークレットアクセスキーを指定します。

−　

入力

○　

AWS.region

リージョン

接続先となるAWSのリージョンを指定します。

−　

入力

○　

AWS.volumeId

ボリュームID

ボリュームのIDを指定します。

−　

入力

○　

AWS.snapshotDescription

スナップショットの説明

作成するスナップショットに設定する説明を指定します。

−　

入力

△　

AWS.checkSnapshotCreationCount

スナップショットの作成完了の確認回数

スナップショットが作成されたことを確認する際の，確認回数を指定します。スナップショットの作成完了の確認間隔と組み合わせて最大待ち時間となります。

−　

入力

○　

AWS.checkSnapshotCreationInterval

スナップショットの作成完了の確認間隔

スナップショットが作成されたことを確認する際の，確認間隔を秒単位で指定します。

−　

入力

○　

AWS.outSnapshotId

スナップショットID

作成したスナップショットのIDが格納されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.2.6　スナップショットの削除

機能

この部品は，Amazon EBS環境で管理されているスナップショットを削除します。

この部品が前提とするサーバを次に示します。

・AWS操作サーバ(実行対象サーバ)

　AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によりこのサーバに部品が転送され，実行されます。

この部品内のスクリプトでは，次に示すAWS Toolsのコマンドレットを実行します。

・Remove-EC2Snapshot -SnapshotId "スナップショットID(AWS.snapshotIdプロパティ)の値"

　　　　　　　　　　　-Force

　上記コマンドレットを実行したあと，削除したスナップショットがスナップショットの一覧に存在しないことを確認します。

AWS Toolsのコマンドレットの詳細については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」を参照してください。

利用場面

この部品は，Amazon EBS環境で管理されているスナップショットを削除する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　・AWS Tools for Windows PowerShell

　・Microsoft .Net Framework 3.5以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) その他の注意事項については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」の注意事項を参照してください。

実行権限

(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。

　・スナップショットの削除

バージョン

02.00.01

部品のタグ

Delete VM Snapshot,AWS

タスクログに表示される部品の名称

awsDeleteSnapshot

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

AWS.accessKeyId

アクセスキーID

AWSに接続するためのアクセスキーIDを指定します。

−　

入力

○　

AWS.secretAccessKey

シークレットアクセスキー

AWSに接続するためのシークレットアクセスキーを指定します。

−　

入力

○　

AWS.region

リージョン

接続先となるAWSのリージョンを指定します。

−　

入力

○　

AWS.snapshotId

スナップショットID

削除するスナップショットのIDを指定します。

−　

入力

○　

AWS.checkSnapshotDeletionCount

スナップショットの削除完了の確認回数

スナップショットが削除されたことを確認する際の，確認回数を指定します。スナップショットの削除完了の確認間隔と組み合わせて最大待ち時間となります。

−　

入力

○　

AWS.checkSnapshotDeletionInterval

スナップショットの削除完了の確認間隔

スナップショットが削除されたことを確認する際の，確認間隔を秒単位で指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.2.7　スナップショットの情報一覧取得

機能

この部品は，Amazon EBS環境で管理されているスナップショット一覧をCSV形式で，AWS操作サーバ(実行対象サーバ)のファイルに出力します。

出力ファイルのエンコード形式は，AWS操作サーバ(実行対象サーバ)のシステムのデフォルトエンコーディングです。

この部品が前提とするサーバを次に示します。

・AWS操作サーバ(実行対象サーバ)

　AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によりこのサーバに部品が転送され，実行されます。

この部品内のスクリプトでは，次に示すAWS Toolsのコマンドレットを実行します。

・Get-EC2Snapshot

AWS Toolsのコマンドレットの詳細については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」を参照してください。

出力するCSVファイルの項目を次に示します。

項目はコンマ区切りで出力します。

(a)ボリュームID(ヘッダー名：VolumeId)

(b)スナップショット開始時間(ヘッダー名：StartTime)

(c)スナップショットID(ヘッダー名：SnapshotId)

(d)スナップショットの状態(ヘッダー名：State)

(e)スナップショットの説明(ヘッダー名：Description)

利用場面

この部品は，Amazon EBS環境で管理されているスナップショットの情報を取得する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　・AWS Tools for Windows PowerShell

　・Microsoft .Net Framework 3.5以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) その他の注意事項については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」の注意事項を参照してください。

(3)ファイル名(common.fileNameプロパティ)に指定したファイルが既に存在する場合，既存のファイルを上書きします。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(4)作成するファイルのパスに含まれるフォルダが存在しない場合は，そのフォルダを作成します。

実行権限

(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。

　・スナップショットの参照

バージョン

02.00.00

部品のタグ

Gather VM information,AWS

タスクログに表示される部品の名称

awsOutputSnapshotSpec

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

AWS.accessKeyId

アクセスキーID

AWSに接続するためのアクセスキーIDを指定します。

−　

入力

○　

AWS.secretAccessKey

シークレットアクセスキー

AWSに接続するためのシークレットアクセスキーを指定します。

−　

入力

○　

AWS.region

リージョン

接続先となるAWSのリージョンを指定します。

−　

入力

○　

common.fileName

ファイル名

スナップショット一覧を出力するファイルのファイル名をフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.2.8　ファイルのアップロード

機能

この部品は，Amazon S3環境にファイルをアップロードします。

この部品が前提とするサーバを次に示します。

・AWS操作サーバ(実行対象サーバ)

　AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によりこのサーバに部品が転送され，実行されます。

この部品内のスクリプトでは，次に示すAWS Toolsのコマンドレットを実行します。

Write-S3Object -BucketName "バケット名(AWS.bucketNameプロパティ)の値"

　　　　　　　　-Key "キー名(AWS.keyNameプロパティ)の値"

　　　　　　　　-File "アップロードファイル名(AWS.uploadFileNameプロパティ)の値"

　　　　　　　　-ServerSideEncryption "None|AES256"

　　　　　　　　-StandardStorage|-ReducedRedundancyStorage

AWS Toolsのコマンドレットの詳細については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」を参照してください。

利用場面

この部品は，Amazon S3環境にファイルをアップロードする場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　・AWS Tools for Windows PowerShell

　・Microsoft .Net Framework 3.5以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) その他の注意事項については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」の注意事項を参照してください。

実行権限

(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。

　・ファイルのアップロード

バージョン

02.00.00

部品のタグ

File Operations,AWS

タスクログに表示される部品の名称

awsUploadFile

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

AWS.accessKeyId

アクセスキーID

AWSに接続するためのアクセスキーIDを指定します。

−　

入力

○　

AWS.secretAccessKey

シークレットアクセスキー

AWSに接続するためのシークレットアクセスキーを指定します。

−　

入力

○　

AWS.region

リージョン

接続先となるAWSのリージョンを指定します。

−　

入力

○　

AWS.bucketName

バケット名

バケット名を指定します。

−　

入力

○　

AWS.keyName

キー名

アップロードしたあとにファイルに設定するキー名を指定します。

−　

入力

○　

AWS.uploadFileName

アップロードファイル名

アップロードするファイルのファイル名をフルパスで指定します。

−　

入力

○　

AWS.useReducedRedundancyStorage

低冗長化ストレージを使用

ファイルのアップロード先に低冗長化ストレージを使用する場合は"true"を指定します。"true"以外の場合は，アップロード先に標準ストレージを使用します。

−　

入力

△　

AWS.useServerSideEncryption

サーバ側の暗号化を使用

ファイルをアップロードする際にサーバ側の暗号化を使用する場合は"true"を指定します。"true"以外の場合は，暗号化しません。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.2.9　ファイルのダウンロード

機能

この部品は，Amazon S3環境で管理されているファイルをAWS操作サーバ(実行対象サーバ)にダウンロードします。

この部品が前提とするサーバを次に示します。

・AWS操作サーバ(実行対象サーバ)

　AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によりこのサーバに部品が転送され，実行されます。

この部品内のスクリプトでは，次に示すAWS Toolsのコマンドレットを実行します。

Read-S3Object -BucketName "バケット名(AWS.bucketNameプロパティ)の値"

　　　　　　　-Key "キー名(AWS.keyNameプロパティ)の値"

　　　　　　　-File "ダウンロードファイル名(AWS.downloadFileNameプロパティ)の値"

AWS Toolsのコマンドレットの詳細については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」を参照してください。

利用場面

この部品は，Amazon S3環境で管理されているファイルをダウンロードする場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　・AWS Tools for Windows PowerShell

　・Microsoft .Net Framework 3.5以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) その他の注意事項については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」の注意事項を参照してください。

実行権限

(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。

　・ファイルのダウンロード

バージョン

02.00.00

部品のタグ

File Operations,AWS

タスクログに表示される部品の名称

awsDownloadFile

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

AWS.accessKeyId

アクセスキーID

AWSに接続するためのアクセスキーIDを指定します。

−　

入力

○　

AWS.secretAccessKey

シークレットアクセスキー

AWSに接続するためのシークレットアクセスキーを指定します。

−　

入力

○　

AWS.region

リージョン

接続先となるAWSのリージョンを指定します。

−　

入力

○　

AWS.bucketName

バケット名

バケット名を指定します。

−　

入力

○　

AWS.keyName

キー名

ダウンロードするファイルのキー名を指定します。

−　

入力

○　

AWS.downloadFileName

ダウンロードファイル名

ダウンロード先のファイルのファイル名をフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.2.10　ファイルの削除

機能

この部品は，Amazon S3環境で管理されているファイルを削除します。

この部品が前提とするサーバを次に示します。

・AWS操作サーバ(実行対象サーバ)

　AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によりこのサーバに部品が転送され，実行されます。

この部品内のスクリプトでは，次に示すAWS Toolsのコマンドレットを実行します。

Remove-S3Object -BucketName "バケット名(AWS.bucketNameプロパティ)の値"

　　　　　　　　-Key "キー名(AWS.keyNameプロパティ)の値"

　　　　　　　　-Force

AWS Toolsのコマンドレットの詳細については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」を参照してください。

利用場面

この部品は，Amazon S3環境で管理されているファイルを削除する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　・AWS Tools for Windows PowerShell

　・Microsoft .Net Framework 3.5以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) その他の注意事項については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」の注意事項を参照してください。

実行権限

(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。

　・ファイルの削除

バージョン

02.00.00

部品のタグ

File Operations,AWS

タスクログに表示される部品の名称

awsDeleteFile

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

AWS.accessKeyId

アクセスキーID

AWSに接続するためのアクセスキーIDを指定します。

−　

入力

○　

AWS.secretAccessKey

シークレットアクセスキー

AWSに接続するためのシークレットアクセスキーを指定します。

−　

入力

○　

AWS.region

リージョン

接続先となるAWSのリージョンを指定します。

−　

入力

○　

AWS.bucketName

バケット名

バケット名を指定します。

−　

入力

○　

AWS.keyName

キー名

削除するファイルのキー名を指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.2.11　仮想サーバのインスタンスタイプ設定

機能

この部品は，Amazon EC2環境でインスタンスのリソース(CPU数，メモリ容量，ストレージ)割り当てを変更するために，インスタンスタイプを変更します。

この部品が前提とするサーバを次に示します。

・AWS操作サーバ(実行対象サーバ)

　AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によってこのサーバに部品が転送され，実行されます。

・インスタンス

　Amazon EC2環境の仮想ホストのことで，一般的な仮想サーバのことです。

この部品内のスクリプトでは，次に示すAWS Toolsのコマンドレットを実行します。

・Edit-EC2InstanceAttribute -InstanceId "インスタンスID(AWS.instanceIdプロパティ)の値"

　　　　　　　　　　　　　　-InstanceType "インスタンスタイプ(AWS.instanceTypeプロパティ)の値"

　　　　　　　　　　　　　　-Force

上記コマンドレットを実行したあと，インスタンスタイプが変更されていることを確認します。

AWS Toolsのコマンドレットの詳細については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」を参照してください。

利用場面

この部品は，Amazon EC2環境でインスタンスのリソースをニーズにあったインスタンスタイプに変更する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】/【実行対象システム内前提製品】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　・AWS Tools for Windows PowerShell

　・Microsoft .Net Framework 3.5以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　ただし，Server Coreインストール環境は除く。

【実行対象システム内前提製品】

(1) インスタンスの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1) インスタンスに関する条件

　・変更するインスタンスの状態が"stopped"であること。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) その他の注意事項については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」の注意事項を参照してください。

実行権限

(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。

　・インスタンスの属性変更

バージョン

02.01.00

部品のタグ

Modify VM,AWS

タスクログに表示される部品の名称

awsChangeVmResource

戻り値

戻り値

説明

0

正常

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

AWS.accessKeyId

アクセスキーID

AWSに接続するためのアクセスキーIDを指定します。

−　

入力

○　

AWS.secretAccessKey

シークレットアクセスキー

AWSに接続するためのシークレットアクセスキーを指定します。

−　

入力

○　

AWS.region

リージョン

接続先となるAWSのリージョンを指定します。

−　

入力

○　

AWS.instanceId

インスタンスID

インスタンスのIDを指定します。

−　

入力

○　

AWS.instanceType

インスタンスタイプ

変更後のインスタンスタイプを指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.2.12　仮想サーバのシャットダウン

機能

この部品は，Amazon EC2環境でインスタンスを停止します。

この部品が前提とするサーバを次に示します。

・AWS操作サーバ(実行対象サーバ)

　AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によってこのサーバに部品が転送され，実行されます。

・インスタンス

　Amazon EC2環境の仮想ホストのことで，一般的な仮想サーバのことです。

この部品内のスクリプトでは，次に示すAWS Toolsのコマンドレットを実行します。

・Stop-EC2Instance -Instance "インスタンスID(AWS.instanceIdプロパティ)の値"

　上記コマンドレットを実行したあと，停止したインスタンスの状態が"stopped"になることを確認します。

AWS Toolsのコマンドレットの詳細については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」を参照してください。

利用場面

この部品は，Amazon EC2環境でインスタンスを停止する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】/【実行対象システム内前提製品】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　・AWS Tools for Windows PowerShell

　・Microsoft .Net Framework 3.5以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象システム内前提製品】

(1) インスタンスの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) この部品を実行した場合，インスタンスで編集中のデータは保存されません。

(3) インスタンスにユーザーがログインしていても，インスタンスは停止されます。

(4) その他の注意事項については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」の注意事項を参照してください。

実行権限

(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。

　・インスタンスの停止および状態取得

バージョン

02.00.00

部品のタグ

Control VM,AWS

タスクログに表示される部品の名称

awsShutdownVM

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

AWS.accessKeyId

アクセスキーID

AWSに接続するためのアクセスキーIDを指定します。

−　

入力

○　

AWS.secretAccessKey

シークレットアクセスキー

AWSに接続するためのシークレットアクセスキーを指定します。

−　

入力

○　

AWS.region

リージョン

接続先となるAWSのリージョンを指定します。

−　

入力

○　

AWS.instanceId

インスタンスID

インスタンスのIDを指定します。

−　

入力

○　

AWS.checkInstanceDisabledCount

インスタンスの停止完了の確認回数

インスタンスの停止が完了したか確認する際の確認回数を指定します。インスタンスの停止完了の確認間隔と組み合わせて最大待ち時間となります。

−　

入力

○　

AWS.checkInstanceDisabledInterval

インスタンスの停止完了の確認間隔

インスタンスの停止が完了したか確認する際の確認間隔を秒単位で指定します。

−　

入力

○　

AWS.instanceState

インスタンスの状態

インスタンスの状態が格納されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.2.13　仮想サーバの起動

機能

この部品は，Amazon EC2環境でインスタンスを起動します。

この部品が前提とするサーバを次に示します。

・AWS操作サーバ(実行対象サーバ)

　AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によってこのサーバに部品が転送され，実行されます。

・インスタンス

　Amazon EC2環境の仮想ホストのことで，一般的な仮想サーバのことです。

この部品内のスクリプトでは，次に示すAWS Toolsのコマンドレットを実行します。

・Start-EC2Instance -InstanceId "インスタンスID(AWS.instanceIdプロパティ)の値"

　上記コマンドレットを実行したあと，起動したインスタンスの状態が"running"になることを確認します。

AWS Toolsのコマンドレットの詳細については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」を参照してください。

利用場面

この部品は，Amazon EC2環境でインスタンスを起動する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】/【実行対象システム内前提製品】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　・AWS Tools for Windows PowerShell

　・Microsoft .Net Framework 3.5以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象システム内前提製品】

(1) インスタンスの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) その他の注意事項については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」の注意事項を参照してください。

実行権限

(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。

　・インスタンスの起動および状態取得

バージョン

02.00.00

部品のタグ

Control VM,AWS

タスクログに表示される部品の名称

awsPowerOnVM

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

AWS.accessKeyId

アクセスキーID

AWSに接続するためのアクセスキーIDを指定します。

−　

入力

○　

AWS.secretAccessKey

シークレットアクセスキー

AWSに接続するためのシークレットアクセスキーを指定します。

−　

入力

○　

AWS.region

リージョン

接続先となるAWSのリージョンを指定します。

−　

入力

○　

AWS.instanceId

インスタンスID

インスタンスのIDを指定します。

−　

入力

○　

AWS.checkInstanceEnabledCount

インスタンスの起動完了の確認回数

インスタンスの起動が完了したか確認する際の確認回数を指定します。インスタンスの起動完了の確認間隔と組み合わせて最大待ち時間となります。

−　

入力

○　

AWS.checkInstanceEnabledInterval

インスタンスの起動完了の確認間隔

インスタンスの起動が完了したか確認する際の確認間隔を秒単位で指定します。

−　

入力

○　

AWS.instanceState

インスタンスの状態

インスタンスの状態が格納されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.2.14　仮想サーバの作成

機能

この部品は，Amazon EC2環境でAMIからインスタンスを起動します。

この部品が前提とするサーバを次に示します。

・AWS操作サーバ(実行対象サーバ)

　AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によってこのサーバに部品が転送され，実行されます。

・インスタンス

　Amazon EC2環境の仮想ホストのことで，一般的な仮想サーバのことです。

この部品内のスクリプトでは，次に示すAWS Toolsのコマンドレットを実行します。

(1)インスタンスの起動

　・New-EC2Instance -ImageId "AMI ID(AWS.amiIdプロパティ)の値"

　　　　　　　　　　-InstanceType "インスタンスタイプ(AWS.instanceTypeプロパティ)の値"

　　　　　　　　　　-AssociatePublicIp $false

　　　　　　　　　　-MinCount 1

　　　　　　　　　　-MaxCount 1

　　　　　　　　　　[-KeyName "キーペア名(AWS.keyPairNameプロパティ)の値"]

　　　　　　　　　　[-SecurityGroupId "セキュリティグループID(AWS.securityGroupIdプロパティ)の値"]

　　　　　　　　　　[-SubnetId "サブネットID(1個目用)(AWS.subnetId1プロパティ)の値"]

　　　　　　　　　　[-PrivateIpAddress "プライベートIPアドレス(1個目用)(AWS.privateIpAddress1プロパティ)の値"]

　上記コマンドレットを実行したあと，起動したインスタンスの状態が"running"になることを確認します。

(2)起動したインスタンスに対するネットワークインターフェイスの追加

　この処理はサブネットID(2個目用)(AWS.subnetId2プロパティ)に値が指定された場合だけ実行されます。

　・New-EC2NetworkInterface -SubnetId "サブネットID(2個目用)(AWS.subnetId2プロパティ)の値"

　　　　　　　　　　　　　　[-PrivateIpAddress "プライベートIPアドレス(2個目用)(AWS.privateIpAddress2プロパティ)の値"]

　　　　　　　　　　　　　　[-Group "セキュリティグループID(AWS.securityGroupIdプロパティ)の値"]

　・Add-EC2NetworkInterface -InstanceId "New-EC2Instanceコマンドレットで起動したインスタンスのインスタンスID"

　　　　　　　　　　　　　　-NetworkInterfaceId "New-EC2NetworkInterfaceコマンドレットで作成したネットワークインターフェイスのネットワークインターフェイスID"

　　　　　　　　　　　　　　-DeviceIndex 1

　上記コマンドレットを実行したあと，追加したネットワークインターフェイスの状態が"in-use"になることを確認します。

AWS Toolsのコマンドレットの詳細については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」を参照してください。

利用場面

この部品は，Amazon EC2環境でインスタンスを起動する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】/【実行対象システム内前提製品】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　・AWS Tools for Windows PowerShell

　・Microsoft .Net Framework 3.5以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象システム内前提製品】

(1) インスタンスの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1) Amazon EC2環境の設定に関する条件

　・インスタンスの起動に使用するAMIが作成済みであること。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) 次に示すIPアドレスには，使用中や範囲外のIPアドレスを指定しないでください。指定した場合，タスクが異常終了します。

　・プライベートIPアドレス(1個目用)(AWS.privateIpAddress1プロパティ)

　・プライベートIPアドレス(2個目用)(AWS.privateIpAddress2プロパティ)

(3) セキュリティグループID(AWS.securityGroupIdプロパティ)には，半角英数字，「-」(ハイフン)，および「,」(コンマ)以外の文字を指定しないでください。指定した場合，タスクが異常終了します。

(4) この部品が戻り値1で異常終了した場合，起動したインスタンスは削除されずに残ります。また，戻り値2で異常終了した場合は，起動したインスタンスに加えて，作成したネットワークインターフェイスも残ります。

(5) その他の注意事項については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」の注意事項を参照してください。

実行権限

(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。

　・インスタンスの起動および状態取得

　・ネットワークインターフェイスの作成，接続および状態取得

バージョン

02.00.00

部品のタグ

Add VM,AWS

タスクログに表示される部品の名称

awsCreateVM

戻り値

戻り値

説明

0

正常

1

異常(インスタンス起動後にエラーを検知) ネットワークインターフェイス作成エラー

2

異常(インスタンス起動後にエラーを検知) ネットワークインターフェイス接続エラー

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

AWS.accessKeyId

アクセスキーID

AWSに接続するためのアクセスキーIDを指定します。

−　

入力

○　

AWS.secretAccessKey

シークレットアクセスキー

AWSに接続するためのシークレットアクセスキーを指定します。

−　

入力

○　

AWS.region

リージョン

接続先となるAWSのリージョンを指定します。

−　

入力

○　

AWS.amiId

AMI ID

インスタンスの起動に使用するAMIのIDを指定します。

−　

入力

○　

AWS.instanceType

インスタンスタイプ

インスタンスの起動に使用するインスタンスタイプを指定します。

−　

入力

○　

AWS.keyPairName

キーペア名

インスタンスで使用するキーペアの名称を指定します。省略した場合は，インスタンスにキーペア名は設定されません。

−　

入力

△　

AWS.securityGroupId

セキュリティグループID

インスタンスを関連付けるセキュリティグループのIDを指定します。省略した場合は，デフォルトのセキュリティグループに関連付けられます。複数のセキュリティグループを指定する場合は，コンマ区切りで指定してください。

−　

入力

△　

AWS.subnetId1

サブネットID(1個目用)

インスタンスに割り当てるプライベートIPアドレス(1個目)の範囲を示すサブネットのIDを指定します。省略した場合は，デフォルトのサブネットが割り当てられます。

−　

入力

△　

AWS.privateIpAddress1

プライベートIPアドレス(1個目用)

インスタンスに割り当てるプライベートIPアドレス(1個目)を指定します。IPv6アドレスには対応していません。省略した場合は，サブネットID(1個目用)に指定したサブネットの範囲内で自動的にIPアドレスが割り当てられます。

−　

入力

△　

AWS.subnetId2

サブネットID(2個目用)

インスタンスに割り当てるプライベートIPアドレス(2個目)の範囲を示すサブネットのIDを指定します。2個目のIPアドレスを設定する場合は必ず指定してください。省略した場合は，2個目のIPアドレスは設定されません。

−　

入力

△　

AWS.privateIpAddress2

プライベートIPアドレス(2個目用)

インスタンスに割り当てるプライベートIPアドレス(2個目)を指定します。IPv6アドレスには対応していません。サブネットID(2個目用)を指定した場合に有効になります。サブネットID(2個目用)を指定した時にこのプロパティを省略した場合は，サブネットID(2個目用)に指定したサブネットの範囲内で自動的にIPアドレスが割り当てられます。

−　

入力

△　

AWS.checkInstanceEnabledCount

インスタンスの起動完了の確認回数

インスタンスの起動が完了したか確認する際の確認回数を指定します。インスタンスの起動完了の確認間隔と組み合わせて最大待ち時間となります。このプロパティは，ネットワークインターフェイスの追加が完了したか確認する際も使用します。

−　

入力

○　

AWS.checkInstanceEnabledInterval

インスタンスの起動完了の確認間隔

インスタンスの起動が完了したか確認する際の確認間隔を秒単位で指定します。このプロパティは，ネットワークインターフェイスの追加が完了したか確認する際も使用します。

−　

入力

○　

AWS.instanceIdInheritance

インスタンスID(後続ステップ引き継ぎ用)

インスタンスのIDが格納されます。後続ステップへの引き継ぎに使用します。

−　

出力

△　

AWS.instanceIdOutput

インスタンスID(タスク出力用)

インスタンスのIDが格納されます。タスクの出力に使用します。

−　

出力

△　

AWS.instanceIPaddress

インスタンスのIPアドレス

インスタンスのIPアドレスが格納されます。インスタンスに複数のIPアドレスが設定されている場合には，コンマ区切りで出力されます。

−　

出力

△　

AWS.networkInterfaceId

ネットワークインターフェイスID

サブネットID(2個目用)を指定した場合に，インスタンスに追加したネットワークインターフェイスのIDが格納されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.2.15　仮想サーバの削除

機能

この部品は，Amazon EC2環境でインスタンスを削除します。インスタンスに接続されているネットワークインターフェイスもすべて削除します。

この部品が前提とするサーバを次に示します。

・AWS操作サーバ(実行対象サーバ)

　AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によってこのサーバに部品が転送され，実行されます。

・インスタンス

　Amazon EC2環境の仮想ホストのことで，一般的な仮想サーバのことです。

この部品内のスクリプトでは，次に示すAWS Toolsのコマンドレットを実行します。

(1)インスタンスの削除

　・Stop-EC2Instance -Instance "インスタンスID(AWS.instanceIdプロパティ)の値"

　　　　　　　　　　　-Terminate

　　　　　　　　　　　-Force

　上記コマンドレットを実行したあと，削除したインスタンスの状態が"terminated"になることを確認します。

(2)インスタンスに接続されているネットワークインターフェイスの削除

　・Remove-EC2NetworkInterface -NetworkInterfaceId "Get-EC2Instanceコマンドレットで取得したネットワークインターフェイスID"

　　　　　　　　　　　　　　　 -Force

　上記コマンドレットを実行したあと，削除したネットワークインターフェイスが存在しないことを確認します。

AWS Toolsのコマンドレットの詳細については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」を参照してください。

利用場面

この部品は，Amazon EC2環境でインスタンスを削除する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】/【実行対象システム内前提製品】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　・AWS Tools for Windows PowerShell

　・Microsoft .Net Framework 3.5以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象システム内前提製品】

(1) インスタンスの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) インスタンスにユーザーがログインしていても，インスタンスは削除されます。

(3) 削除されたインスタンスはしばらくの間コンソールに表示されたままで状態取得もできますが，起動はできません。

(4) この部品が戻り値1で異常終了した場合，インスタンスに追加したネットワークインターフェイスは削除されずに残ります。

(5) その他の注意事項については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」の注意事項を参照してください。

実行権限

(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。

　・インスタンスの削除および状態取得

　・ネットワークインターフェイスの削除

バージョン

02.00.01

部品のタグ

Delete VM,AWS

タスクログに表示される部品の名称

awsDeleteVM

戻り値

戻り値

説明

0

正常

1

異常(インスタンス削除後にエラーを検知) ネットワークインターフェイス削除エラー

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

AWS.accessKeyId

アクセスキーID

AWSに接続するためのアクセスキーIDを指定します。

−　

入力

○　

AWS.secretAccessKey

シークレットアクセスキー

AWSに接続するためのシークレットアクセスキーを指定します。

−　

入力

○　

AWS.region

リージョン

接続先となるAWSのリージョンを指定します。

−　

入力

○　

AWS.instanceId

インスタンスID

インスタンスのIDを指定します。

−　

入力

○　

AWS.checkInstanceDeletionCount

インスタンスの削除完了の確認回数

インスタンスの削除が完了したか確認する際の確認回数を指定します。インスタンスの削除完了の確認間隔と組み合わせて最大待ち時間となります。このプロパティは，ネットワークインターフェイスの削除が完了したか確認する際も使用します。

−　

入力

○　

AWS.checkInstanceDeletionInterval

インスタンスの削除完了の確認間隔

インスタンスの削除が完了したか確認する際の確認間隔を秒単位で指定します。このプロパティは，ネットワークインターフェイスの削除が完了したか確認する際も使用します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.2.16　仮想サーバの情報一覧取得

機能

この部品は，Amazon EC2環境で管理されているインスタンスの情報一覧を，CSV形式でAWS操作サーバ(実行対象サーバ)のファイルに出力します。

出力ファイルのエンコード形式は，AWS操作サーバ(実行対象サーバ)のシステムのデフォルトエンコーディングです。

この部品が前提とするサーバを次に示します。

・AWS操作サーバ(実行対象サーバ)

　AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によってこのサーバに部品が転送され，実行されます。

・インスタンス

　Amazon EC2環境の仮想ホストのことで，一般的な仮想サーバのことです。

この部品内のスクリプトでは，次に示すAWS Toolsのコマンドレットを実行します。

・Get-EC2Instance

AWS Toolsのコマンドレットの詳細については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」を参照してください。

出力するCSVファイルの項目を次に示します。

項目はコンマ区切りで出力します。

(a) VPC ID(ヘッダー名：VPCID)

(b) インスタンスID(ヘッダー名：InstanceID)

(c) AMI ID(ヘッダー名：AMIID)

(d) インスタンスの状態(ヘッダー名：State)

(e) インスタンスタイプ(ヘッダー名：InstanceType)

利用場面

この部品は，Amazon EC2環境で管理されているインスタンスの情報を取得する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　・AWS Tools for Windows PowerShell

　・Microsoft .Net Framework 3.5以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　ただし，Server Coreインストール環境は除く。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) インスタンス情報一覧出力ファイル名(AWS.vmInfoListOutputFileNameプロパティ)に指定したファイルが既に存在する場合，既存のファイルを上書きします。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(3) 作成するファイルのパスに含まれるフォルダが存在しない場合は，そのフォルダを作成します。

(4) その他の注意事項については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」の注意事項を参照してください。

実行権限

(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。

　・インスタンスの情報取得

バージョン

02.01.00

部品のタグ

Gather VM information,AWS

タスクログに表示される部品の名称

awsOutputVmSpec

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

AWS.accessKeyId

アクセスキーID

AWSに接続するためのアクセスキーIDを指定します。

−　

入力

○　

AWS.secretAccessKey

シークレットアクセスキー

AWSに接続するためのシークレットアクセスキーを指定します。

−　

入力

○　

AWS.region

リージョン

接続先となるAWSのリージョンを指定します。

−　

入力

○　

AWS.vmInfoListOutputFileName

インスタンス情報一覧出力ファイル名

インスタンス情報一覧を出力するファイル名をフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.2.17　仮想サーバの状態取得

機能

この部品は，Amazon EC2環境でインスタンスの状態を取得します。

この部品が前提とするサーバを次に示します。

・AWS操作サーバ(実行対象サーバ)

　AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によってこのサーバに部品が転送され，実行されます。

・インスタンス

　Amazon EC2環境の仮想ホストのことで，一般的な仮想サーバのことです。

この部品内のスクリプトでは，次に示すAWS Toolsのコマンドレットを実行します。

・Get-EC2Instance -Instance "インスタンスID(AWS.instanceIdプロパティ)の値"

上記のコマンドレットの実行結果からInstances.State.Name.Valueプロパティの値を取得して「インスタンスの状態(AWS.instanceStateプロパティ)」に格納します。

このプロパティに格納される値とその意味を次に示します。

　　　値　　　　　　　　意味

　pending　　　　　　起動処理中

　running　　　　　　起動中

　shutting-down　　　終了処理中

　stopped　　　　　　停止中

　stopping　　　　　 停止処理中

　terminated　　　　 終了中

AWS Toolsのコマンドレットの詳細については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」を参照してください。

利用場面

この部品は，Amazon EC2環境でインスタンスの状態を取得する場合に使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】/【実行対象システム内前提製品】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　・AWS Tools for Windows PowerShell

　・Microsoft .Net Framework 3.5以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象システム内前提製品】

(1) インスタンスの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) その他の注意事項については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」の注意事項を参照してください。

実行権限

(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。

　・インスタンスの状態取得

バージョン

02.00.00

部品のタグ

Gather VM information,AWS

タスクログに表示される部品の名称

awsGetVMState

戻り値

戻り値

説明

0

正常

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

AWS.accessKeyId

アクセスキーID

AWSに接続するためのアクセスキーIDを指定します。

−　

入力

○　

AWS.secretAccessKey

シークレットアクセスキー

AWSに接続するためのシークレットアクセスキーを指定します。

−　

入力

○　

AWS.region

リージョン

接続先となるAWSのリージョンを指定します。

−　

入力

○　

AWS.instanceId

インスタンスID

インスタンスのIDを指定します。

−　

入力

○　

AWS.instanceState

インスタンスの状態

インスタンスの状態が格納されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.3　HCS関連の部品

5.3.1　DPボリュームの作成

機能

Hitachi Device Manager Software(以降，Device Manager)を操作して指定された仮想ボリューム(DPボリューム)を作成します。

この部品が前提とするサーバを次に示します。

・HDvMサーバ

　Device Managerがインストールされているサーバです。

・HDvM CLIサーバ(実行対象サーバ)

　Device Manager CLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

操作するストレージシステムの種類によって，ストレージシステムのファミリー名を指定するプロパティが異なります。次のストレージシステムを操作する場合は，「ストレージシステムのファミリー名(カスタムオプション)」(HDvM.familyTextプロパティ)に指定します。その他のストレージシステムを操作する場合は，「ストレージシステムのファミリー名」(HDvM.familyプロパティ)に指定します。

・Hitachi Virtual Storage Platform G1500の場合，「VSP G1500」を指定します。

・Hitachi Virtual Storage Platform F1500の場合，「VSP F1500」を指定します。

・Hitachi Virtual Storage Platform G100/G200/G400/G600/G800の場合，「VSP Gx00」を指定します。

・Hitachi Virtual Storage Platform F400/F600/F800の場合，「VSP Fx00」を指定します。

利用場面

仮想サーバや仮想ディスクの追加を行う際に，データ格納先のDPボリュームの作成に使用できます。

次の部品とあわせて使用することで，上記処理が実現できます。

・storageAddHostgroupLU

・vsphereRecognizeLU

・vsphereGetCanonicalName

・vsphereCreateDatastore

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象システム内前提製品】

(1)HDvMサーバに次の製品がセットアップされていること。

　・Hitachi Device Manager Software 07-00以降

(2)システム内のストレージシステムとして次のどれかがセットアップされていること。

　・Hitachi Adaptable Modular Storage 2100/2300/2500/2010

　・Hitachi Unified Storage 110/130/150

　・Hitachi Unified Storage VM

　・Hitachi Universal Storage Platform V/VM

　・Hitachi Virtual Storage Platform

　・Hitachi Virtual Storage Platform G1000/G1500/F1500

　・Hitachi Virtual Storage Platform G100/G200/G400/G600/G800

　・Hitachi Virtual Storage Platform F400/F600/F800

【実行対象システム内前提製品の使用条件】

(1)ストレージシステムがHitachi Device Manager Softwareで管理されていること。

(2)ストレージシステムにDPプールが作成済みであること。

【実行対象サーバ内前提製品】

　・Hitachi Device Manager Software CLI 07-00以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

注意事項

(1)HDvM.familyTextプロパティにはサポート対象外のストレージシステムを指定しないでください。

(2)エージェントレス接続先設定の認証情報に設定したユーザーがビルトインAdministratorではない場合，以下のいずれかの条件を満たす必要があります。

・WindowsのUAC機能が完全に無効化されている。

・エージェントレス接続先の機器にて，エージェントレス接続先設定の認証情報に設定されたユーザーに対するRDPセッションが確立されている。

実行権限

(1)Administrators 権限

(2)Device Managerに接続するユーザーに，次の権限が必要です。

　リソースグループとして「All Resources」を割り当てられ，Modify権限を持つユーザー。

バージョン

02.00.00

部品のタグ

Add New Storage,Device Manager

タスクログに表示される部品の名称

storageCreateLU2

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

HDvM.cliInstallPath

HDvM CLIのインストールパス

Device Manager CLIのインストールパスを指定します。

−　

入力

○　

HDvM.httpType

HDvMとの通信プロトコル

Device Managerとの通信プロトコルをhttpまたはhttpsで指定します。

http

入力

○　

HDvM.hostName

HDvMサーバのホスト名

HDvMサーバのホスト名またはIPアドレスを指定します。IPv6アドレスは指定できません。

−　

入力

○　

HDvM.portNumber

HDvMとの接続ポート番号

Device Managerとの接続ポート番号を指定します。

2001

入力

○　

HDvM.userName

HDvMに接続するためのユーザー名

Device Managerに接続するためのユーザー名を指定します。

System

入力

○　

HDvM.password

HDvMに接続するためのパスワード

Device Managerに接続するためのパスワードを指定します。

manager

入力

○　

HDvM.serialNumber

ストレージシステムのシリアル番号

実行対象のストレージシステムのシリアル番号を指定します。

−　

入力

○　

HDvM.family

ストレージシステムのファミリー名

ストレージシステムのファミリー名を指定します。指定可能な値はAMS，USP_V，USP_VM，VSP，HUS，HUS VM，VSP G1000のどれかです。

−　

入力

○　

HDvM.creationOption

強制オプション（AMSおよびHUSの場合）

DPプールの容量がしきい値以上の場合でもDPボリュームを作成する場合にforceを指定します。

−　

入力

△　

HDvM.groupOption

パリティグループオプション（USPの場合だけ）

既存のパリティグループへDPボリュームを作成する場合，"exist"を指定します。このプロパティを指定した場合，HDvM.arrayGroupNameを指定する必要があります。

−　

入力

△　

HDvM.arrayGroupName

仮想パリティグループ名（USPの場合だけ）

仮想パリティグループ名を「Xn-1（nは数字）」形式で指定します。

−　

入力

△　

HDvM.capacity

作成するDPボリュームの容量

作成するDPボリュームの容量をGB単位で指定します。

−　

入力

○　

HDvM.numOfLUs

LUの個数

作成するLUの個数を指定します。

1

入力

△　

HDvM.devNumber

DPボリュームのデバイス番号

DPボリュームのデバイス番号を10進数で指定します。

−　

入力

△　

HDvM.clprNumber

LDEVのCLPR番号（USP，AMSおよびHUSの場合）

LDEVのCLPR番号を指定します。省略した場合は0が設定されます。HDvM.poolIdに指定があれば，該当DPプールのCLPR番号が設定されます。

−　

入力

△　

HDvM.poolId

DPプールのプールID

作成したDPボリュームを関連づけるDPプールのプールIDを指定します。VSP，AMS，HUS，HUS VM，VSP G1000の場合は必ず指定してください。

−　

入力

△　

HDvM.threshold

DPボリュームの使用率しきい値（USPの場合だけ）

DPボリュームの使用率（%）のしきい値を5以上300以下の5の倍数で指定します。

−　

入力

△　

HDvM.familyText

ストレージシステムのファミリー名(カスタムオプション)

HDvM.familyプロパティの選択リストにないストレージシステムのファミリー名を指定します。このプロパティを指定した場合，HDvM.familyプロパティに指定した値は無視されます。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.3.2　DPボリュームの削除

機能

Hitachi Device Manager Software(以降，Device Manager)を操作して指定された仮想ボリューム(DPボリューム)を削除します。

この部品が前提とするサーバを次に示します。

・HDvMサーバ

　Device Managerがインストールされているサーバです。

・HDvM CLIサーバ(実行対象サーバ)

　Device Manager CLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

ストレージシステムがRAID系の場合だけ，削除する前にボリュームのフォーマット(通常フォーマット)を行います。

操作するストレージシステムの種類によって，ストレージシステムのファミリー名を指定するプロパティが異なります。次のストレージシステムを操作する場合は，「ストレージシステムのファミリー名(カスタムオプション)」(HDvM.familyTextプロパティ)に指定します。その他のストレージシステムを操作する場合は，「ストレージシステムのファミリー名」(HDvM.familyプロパティ)に指定します。

・Hitachi Virtual Storage Platform G1500の場合，「VSP G1500」を指定します。

・Hitachi Virtual Storage Platform F1500の場合，「VSP F1500」を指定します。

・Hitachi Virtual Storage Platform G100/G200/G400/G600/G800の場合，「VSP Gx00」を指定します。

・Hitachi Virtual Storage Platform F400/F600/F800の場合，「VSP Fx00」を指定します。

利用場面

仮想サーバを削除したあと，仮想サーバのデータを格納していたLUを削除する場合などに利用できます。

関連する部品を次に記載します。

・storageDeleteHostgroupLU

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象システム内前提製品】

(1)HDvMサーバに次の製品がセットアップされていること。

　・Hitachi Device Manager Software 07-00以降

(2)システム内のストレージシステムとして次のどれかがセットアップされていること。

　・Hitachi Adaptable Modular Storage 2100/2300/2500/2010

　・Hitachi Unified Storage 110/130/150

　・Hitachi Unified Storage VM

　・Hitachi Universal Storage Platform V/VM

　・Hitachi Virtual Storage Platform

　・Hitachi Virtual Storage Platform G1000/G1500/F1500

　・Hitachi Virtual Storage Platform G100/G200/G400/G600/G800

　・Hitachi Virtual Storage Platform F400/F600/F800

【実行対象システム内前提製品の使用条件】

(1)ストレージシステムがHitachi Device Manager Softwareで管理されていること。

(2)ストレージシステムに操作対象のLUおよびホストグループが作成済みであること。

【実行対象サーバ内前提製品】

　・Hitachi Device Manager Software CLI 07-00以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

注意事項

(1)HDvM.familyTextプロパティにはサポート対象外のストレージシステムを指定しないでください。

実行権限

(1)Device Managerに接続するユーザーに，次の権限が必要です。

　リソースグループとして「All Resources」を割り当てられ，Modify権限を持つユーザー。

バージョン

02.00.00

部品のタグ

Delete Storage,Device Manager

タスクログに表示される部品の名称

storageDeleteLU2

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

HDvM.cliInstallPath

HDvM CLIのインストールパス

Device Manager CLIのインストールパスを指定します。

−　

入力

○　

HDvM.httpType

HDvMとの通信プロトコル

Device Managerとの通信プロトコルをhttpまたはhttpsで指定します。

http

入力

○　

HDvM.hostName

HDvMサーバのホスト名

HDvMサーバのホスト名またはIPアドレスを指定します。IPv6アドレスは指定できません。

−　

入力

○　

HDvM.portNumber

HDvMとの接続ポート番号

Device Managerとの接続ポート番号を指定します。

2001

入力

○　

HDvM.userName

HDvMに接続するためのユーザー名

Device Managerに接続するためのユーザー名を指定します。

System

入力

○　

HDvM.password

HDvMに接続するためのパスワード

Device Managerに接続するためのパスワードを指定します。

manager

入力

○　

HDvM.serialNumber

ストレージシステムのシリアル番号

実行対象のストレージシステムのシリアル番号を指定します。

−　

入力

○　

HDvM.family

ストレージシステムのファミリー名

ストレージシステムのファミリー名を指定します。指定可能な値はAMS，USP_V，USP_VM，VSP，HUS，HUS VM，VSP G1000のどれかです。

−　

入力

○　

HDvM.deletionOption

DPボリュームの削除方法

DPボリュームとDPプールとの関連づけが解除されていない場合でもDPボリュームを削除する場合に，"force"を指定してください。

−　

入力

△　

HDvM.arrayGroupName

仮想パリティグループ名（USPの場合だけ）

仮想パリティグループ名を「Xn-1（nは数字）」形式で指定します。

−　

入力

△　

HDvM.devNumber

DPボリュームのデバイス番号

DPボリュームのデバイス番号を10進数で指定します。

−　

入力

△　

HDvM.familyText

ストレージシステムのファミリー名(カスタムオプション)

HDvM.familyプロパティの選択リストにないストレージシステムのファミリー名を指定します。このプロパティを指定した場合，HDvM.familyプロパティに指定した値は無視されます。

−　

入力

△　

HDvM.luFormatOption

LUフォーマットの要否(カスタムオプション)

LUを削除する前にフォーマットするかどうかを指定します。フォーマットする場合はyes，フォーマットしない場合はnoを選択してください。このプロパティは，HDvM.familyTextプロパティにHDvM.familyプロパティの選択リストに存在しないファミリー名を指定した場合だけ有効になります。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.3.3　HDvM接続確認

機能

Hitachi Device Manager Software(以下，Device Manager)に実行対象サーバから接続できることを確認します。

この部品が前提とするサーバを次に示します。

・HDvMサーバ

　Device Managerがインストールされているサーバです。

・HDvM CLIサーバ(実行対象サーバ)

　Device Manager CLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

利用場面

Device Managerを操作対象とする場合に，Device Managerと実行対象サーバとの接続状態を事前確認することができます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象システム内前提製品】

(1)HDvMサーバに次の製品がセットアップされていること。

　・Hitachi Device Manager Software 07-00以降

(2)システム内のストレージシステムとして次のどれかがセットアップされていること。

　・Hitachi Adaptable Modular Storage 2100/2300/2500/2010

　・Hitachi Unified Storage 110/130/150

　・Hitachi Unified Storage VM

　・Hitachi Universal Storage Platform V/VM

　・Hitachi Virtual Storage Platform

　・Hitachi Virtual Storage Platform G1000/G1500/F1500

　・Hitachi Virtual Storage Platform G100/G200/G400/G600/G800

　・Hitachi Virtual Storage Platform F400/F600/F800

【実行対象システム内前提製品の使用条件】

(1)ストレージシステムがHitachi Device Manager Softwareで管理されていること。

(2)ストレージシステムにDPプールが作成済みであること。

【実行対象サーバ内前提製品】

　・Hitachi Device Manager Software CLI 07-00以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

実行権限

(1)Device Managerに接続するユーザーは，次の権限を持つユーザーグループに属している必要があります。

　リソースグループとして「All Resources」を割り当てられ，Admin権限またはModify権限を持つユーザーグループ。

バージョン

02.00.00

部品のタグ

Gather Device Manager information,Device Manager

タスクログに表示される部品の名称

hdvmConnectChallenge

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない（部品スクリプトでエラーを検知）

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

HDvM.cliInstallPath

HDvM CLIのインストールパス

Device Manager CLIのインストールパスを指定します。

−　

入力

○　

HDvM.httpType

HDvMとの通信プロトコル

HDvMサーバに接続するためのプロトコルをhttpまたはhttpsで指定します。

http

入力

○　

HDvM.hostName

HDvMサーバのホスト名

HDvMサーバのホスト名またはIPアドレスを指定します。IPv6アドレスは指定できません。

−　

入力

○　

HDvM.portNumber

HDvMとの接続ポート番号

HDvMサーバに接続するためのポート番号を指定します。

2001

入力

○　

HDvM.userName

HDvMに接続するためのユーザーID

HDvMサーバに接続するためのユーザーIDを指定します。

System

入力

○　

HDvM.password

HDvMに接続するためのパスワード

HDvMサーバに接続するためのパスワードを指定します。

manager

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

common.connectHDvMResult

HDvM接続確認のチェック結果

HDvMサーバに接続できるかどうか確認した結果を格納します。

−　

出力

△　

5.3.4　LU作成確認

機能

Hitachi Device Manager Software(以下，Device Manager)を操作して指定されたLUを作成できることを確認します。

この部品が前提とするサーバを次に示します。

・HDvMサーバ

　Device Managerがインストールされているサーバです。

・HDvM CLIサーバ(実行対象サーバ)

　Device Manager CLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

この部品で確認している項目を次に示します。

・指定されたシリアル番号，およびファミリー名のストレージシステムがHDvMに登録されているかを確認します。

ストレージシステムがHDvM上に登録されていない場合はNGとなります。

・指定されたDPボリュームのデバイス番号がストレージシステム内で使用されていないかを確認します。

デバイス番号がストレージシステム内で既に使用されている場合はNGとなります。

・指定されたDPプールのID，およびホストグループのIDを持つDPプールがストレージシステムに登録されているか，

指定されたLU番号がストレージシステム内で使用されていないかを確認します。

DPプールのID，ホストグループのIDのどちらかが存在しない，またはLU番号が既に使用されている場合はNGとなります。

・指定されたストレージシステム上のDPプールに，DPボリュームを作成できる容量が空いているかを確認します。

DPボリュームの容量が，DPプールの空き容量を超過している場合はNGとなります。

操作するストレージシステムの種類によって，ストレージシステムのファミリー名を指定するプロパティが異なります。次のストレージシステムを操作する場合は，「ストレージシステムのファミリー名(カスタムオプション)」(HDvM.familyTextプロパティ)に指定します。その他のストレージシステムを操作する場合は，「ストレージシステムのファミリー名」(HDvM.familyプロパティ)に指定します。

・Hitachi Virtual Storage Platform G1500の場合，「VSP G1500」を指定します。

・Hitachi Virtual Storage Platform F1500の場合，「VSP F1500」を指定します。

・Hitachi Virtual Storage Platform G100/G200/G400/G600/G800の場合，「VSP Gx00」を指定します。

・Hitachi Virtual Storage Platform F400/F600/F800の場合，「VSP Fx00」を指定します。

利用場面

LUの追加を行う場合に，データ格納先のDPプールにLUの作成ができるかを事前確認することができます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象システム内前提製品】

(1)HDvMサーバに次の製品がセットアップされていること。

　・Hitachi Device Manager Software 07-00以降

(2)システム内のストレージシステムとして次のどれかがセットアップされていること。

　・Hitachi Adaptable Modular Storage 2100/2300/2500/2010

　・Hitachi Unified Storage 110/130/150

　・Hitachi Unified Storage VM

　・Hitachi Universal Storage Platform V/VM

　・Hitachi Virtual Storage Platform

　・Hitachi Virtual Storage Platform G1000/G1500/F1500

　・Hitachi Virtual Storage Platform G100/G200/G400/G600/G800

　・Hitachi Virtual Storage Platform F400/F600/F800

【実行対象システム内前提製品の使用条件】

(1)ストレージシステムがHitachi Device Manager Softwareで管理されていること。

(2)ストレージシステムにDPプールが作成済みであること。

【実行対象サーバ内前提製品】

　・Hitachi Device Manager Software CLI 07-00以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

注意事項

(1)HDvM.familyTextプロパティにはサポート対象外のストレージシステムを指定しないでください。

(2)エージェントレス接続先設定の認証情報に設定したユーザーがビルトインAdministratorではない場合，以下のいずれかの条件を満たす必要があります。

・WindowsのUAC機能が完全に無効化されている。

・エージェントレス接続先の機器にて，エージェントレス接続先設定の認証情報に設定されたユーザーに対するRDPセッションが確立されている。

実行権限

(1)Administrators 権限

(2)Device Managerに接続するユーザーは，次の権限を持つユーザーグループに属している必要があります。

　リソースグループとして「All Resources」を割り当てられ，Admin権限またはModify権限を持つユーザーグループ。

バージョン

02.00.00

部品のタグ

Gather Storage information,Device Manager

タスクログに表示される部品の名称

hdvmCheckStorageSpec

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない（部品スクリプトでエラーを検知）

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

HDvM.cliInstallPath

HDvM CLIのインストールパス

Device Manager CLIのインストールパスを指定します。

−　

入力

○　

HDvM.httpType

HDvMとの通信プロトコル

HDvMサーバに接続するためのプロトコルをhttpまたはhttpsで指定します。

http

入力

○　

HDvM.hostName

HDvMサーバのホスト名

HDvMサーバのホスト名またはIPアドレスを指定します。IPv6アドレスは指定できません。

−　

入力

○　

HDvM.portNumber

HDvMとの接続ポート番号

HDvMサーバに接続するためのポート番号を指定します。

2001

入力

○　

HDvM.userName

HDvMに接続するためのユーザーID

HDvMサーバに接続するためのユーザーIDを指定します。

System

入力

○　

HDvM.password

HDvMに接続するためのパスワード

HDvMサーバに接続するためのパスワードを指定します。

manager

入力

○　

HDvM.serialNumber

ストレージシステムのシリアル番号

確認対象のストレージシステムのシリアル番号を指定します。

−　

入力

○　

HDvM.family

ストレージシステムのファミリー名

ストレージシステムのファミリー名を指定します。指定可能な値はAMS，USP_V，USP_VM，VSP，HUS，HUS VM，VSP G1000のどれかです。

−　

入力

○　

HDvM.devNumber

DPボリューム(LU)のデバイス番号

使用できるか確認するDPボリューム(LU)のデバイス番号を10進数で指定します。

−　

入力

○　

HDvM.pathPortName

パスのポート名

DPボリューム(LU)へのパスのポート名を指定します。

−　

入力

○　

HDvM.lun

LU Number(LUN)

LU Number(LUN)を指定します。

−　

入力

○　

HDvM.poolId

DPプールのプールID

DPボリューム(LU)を作成できるか確認するDPプールのプールIDを指定します。

−　

入力

○　

HDvM.capacity

DPボリューム(LU)の容量 (GB)

作成できるか確認するDPボリューム(LU)の容量をGB単位で指定します。

1

入力

○　

HDvM.numOfLUs

LUの個数

作成するLUの個数を指定します。

1

入力

△　

HDvM.domainId

ホストグループのID

DPボリューム(LU)を追加できるか確認するホストグループのIDを10進数または16進数で指定します。16進数の場合は"0x"をプレフィックスとして付与してください。

−　

入力

○　

HDvM.familyText

ストレージシステムのファミリー名(カスタムオプション)

HDvM.familyプロパティの選択リストにないストレージシステムのファミリー名を指定します。このプロパティを指定した場合，HDvM.familyプロパティに指定した値は無視されます。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

common.checkStorageSpecResult

LU作成確認のチェック結果

DPボリューム(LU)を作成できるかどうか確認した結果を格納します。

−　

出力

△　

5.3.5　ストレージ情報一覧取得

機能

Hitachi Device Manager Software(以下，Device Manager)の管理下にある，DPプール情報の一覧をCSV形式でファイルに出力します。

シリアル番号を指定することで，Device Managerの管理下にある，シリアル番号が一致するストレージだけを対象にできます。

この部品が前提とするサーバを次に示します。

・HDvMサーバ

　Device Managerがインストールされているサーバです。

・HDvM CLIサーバ(実行対象サーバ)

　Device Manager CLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

利用場面

LUの追加を行う場合に指定する，データ格納先のDPプール情報の一覧をCSV形式のファイルで出力することができます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象システム内前提製品】

(1)HDvMサーバに次の製品がセットアップされていること。

　・Hitachi Device Manager Software 07-00以降

(2)システム内のストレージシステムとして次のどれかがセットアップされていること。

　・Hitachi Adaptable Modular Storage 2100/2300/2500/2010

　・Hitachi Unified Storage 110/130/150

　・Hitachi Unified Storage VM

　・Hitachi Universal Storage Platform V/VM

　・Hitachi Virtual Storage Platform

　・Hitachi Virtual Storage Platform G1000/G1500/F1500

　・Hitachi Virtual Storage Platform G100/G200/G400/G600/G800

　・Hitachi Virtual Storage Platform F400/F600/F800

【実行対象システム内前提製品の使用条件】

(1)ストレージシステムがHitachi Device Manager Softwareで管理されていること。

(2)ストレージシステムにDPプールが作成済みであること。

【実行対象サーバ内前提製品】

　・Hitachi Device Manager Software CLI 07-00以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

実行権限

(1)Device Managerに接続するユーザーは，次の権限を持つユーザーグループに属している必要があります。

　リソースグループとして「All Resources」を割り当てられ，Admin権限またはModify権限を持つユーザーグループ。

バージョン

02.00.00

部品のタグ

Gather Storage information,Device Manager

タスクログに表示される部品の名称

hdvmOutStorageSpec

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

28

異常(取得情報なし) DPプールが一つも存在しない

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

42

異常(部品内でエラーを検知) 内部エラー(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

HDvM.cliInstallPath

HDvM CLIのインストールパス

Device Manager CLIのインストールパスを指定します。

−　

入力

○　

HDvM.httpType

HDvMとの通信プロトコル

HDvMサーバに接続するためのプロトコルをhttpまたはhttpsで指定します。

http

入力

○　

HDvM.hostName

HDvMサーバのホスト名

HDvMサーバのホスト名またはIPアドレスを指定します。IPv6アドレスは指定できません。

−　

入力

○　

HDvM.portNumber

HDvMとの接続ポート番号

HDvMサーバに接続するためのポート番号を指定します。

2001

入力

○　

HDvM.userName

HDvMに接続するためのユーザーID

HDvMサーバに接続するためのユーザーIDを指定します。

System

入力

○　

HDvM.password

HDvMに接続するためのパスワード

HDvMサーバに接続するためのパスワードを指定します。

manager

入力

○　

HDvM.serialNumber

ストレージシステムのシリアル番号

取得対象のストレージシステムのシリアル番号を指定します。

−　

入力

△　

common.fileName

ファイル名

ファイル名を指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.3.6　ホストグループからLUを削除

機能

Hitachi Device Manager Software(以下，Device Manager)を操作して，指定されたLUを指定されたホストグループから削除します。

この部品が前提とするサーバを次に示します。

・HDvMサーバ

　Device Managerがインストールされているサーバです。

・HDvM CLIサーバ(実行対象サーバ)

　Device Manager CLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

操作するストレージシステムの種類によって，ストレージシステムのファミリー名を指定するプロパティが異なります。次のストレージシステムを操作する場合は，「ストレージシステムのファミリー名(カスタムオプション)」(HDvM.familyTextプロパティ)に指定します。その他のストレージシステムを操作する場合は，「ストレージシステムのファミリー名」(HDvM.familyプロパティ)に指定します。

・Hitachi Virtual Storage Platform G1500の場合，「VSP G1500」を指定します。

・Hitachi Virtual Storage Platform F1500の場合，「VSP F1500」を指定します。

・Hitachi Virtual Storage Platform G100/G200/G400/G600/G800の場合，「VSP Gx00」を指定します。

・Hitachi Virtual Storage Platform F400/F600/F800の場合，「VSP Fx00」を指定します。

利用場面

仮想サーバを削除したあと，仮想サーバのデータを格納していたLUをホストグループから削除する場合などに利用できます。

関連する部品を次に記載します。

・storageDeleteLU2

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象システム内前提製品】

(1)HDvMサーバに次の製品がセットアップされていること。

　・Hitachi Device Manager Software 07-00以降

(2)システム内のストレージシステムとして次のどれかがセットアップされていること。

　・Hitachi Adaptable Modular Storage 2100/2300/2500/2010

　・Hitachi Unified Storage 110/130/150

　・Hitachi Unified Storage VM

　・Hitachi Universal Storage Platform V/VM

　・Hitachi Virtual Storage Platform

　・Hitachi Virtual Storage Platform G1000/G1500/F1500

　・Hitachi Virtual Storage Platform G100/G200/G400/G600/G800

　・Hitachi Virtual Storage Platform F400/F600/F800

【実行対象システム内前提製品の使用条件】

(1)ストレージシステムがHitachi Device Manager Softwareで管理されていること。

(2)ストレージシステムに操作対象のLUおよびホストグループが作成済みであること。

【実行対象サーバ内前提製品】

　・Hitachi Device Manager Software CLI 07-00以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

注意事項

(1)HDvM.familyTextプロパティにはサポート対象外のストレージシステムを指定しないでください。

実行権限

(1)Device Managerに接続するユーザーに，次の権限が必要です。

　ModifyまたはAdminロールを割り当てられたユーザー。

バージョン

02.00.00

部品のタグ

Delete Storage,Device Manager

タスクログに表示される部品の名称

storageDeleteHostgroupLU

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

HDvM.cliInstallPath

HDvM CLIのインストールパス

Device Manager CLIのインストールパスを指定します。

−　

入力

○　

HDvM.httpType

HDvMとの通信プロトコル

Device Managerとの通信プロトコルをhttpまたはhttpsで指定します。

http

入力

○　

HDvM.hostName

HDvMサーバのホスト名

HDvMサーバのホスト名またはIPアドレスを指定します。IPv6アドレスは指定できません。

−　

入力

○　

HDvM.portNumber

HDvMとの接続ポート番号

Device Managerとの接続ポート番号を指定します。

2001

入力

○　

HDvM.userName

HDvMに接続するためのユーザー名

Device Managerに接続するためのユーザー名を指定します。

System

入力

○　

HDvM.password

HDvMに接続するためのパスワード

Device Managerに接続するためのパスワードを指定します。

manager

入力

○　

HDvM.serialNumber

ストレージシステムのシリアル番号

実行対象のストレージシステムのシリアル番号を指定します。

−　

入力

○　

HDvM.family

ストレージシステムのファミリー名

ストレージシステムのファミリー名を指定します。指定可能な値はAMS，USP_V，USP_VM，VSP，HUS，HUS VM，VSP G1000のどれかです。

−　

入力

○　

HDvM.pathPortNumber

DPボリュームへのパスのポート番号

DPボリュームへのパスのポート番号を指定します。HDvM.pathPortNumberまたはHDvM.pathPortNameを必ず指定してください。

−　

入力

△　

HDvM.pathPortName

DPボリュームへのパスのポート名

DPボリュームへのパスのポート名を指定します。HDvM.pathPortNumberまたはHDvM.pathPortNameを必ず指定してください。

−　

入力

△　

HDvM.domainId

DPボリュームが登録されているホストグループのID

DPボリュームを削除するホストグループのIDを10進数または16進数で指定します。16進数の場合は"0x"をプレフィクスとして付与してください。HDvM.domainNicknameと同時に指定できません。

−　

入力

△　

HDvM.domainNickname

DPボリュームが登録されているドメインのニックネーム

DPボリュームを削除するホストグループのニックネームを指定します。HDvM.domainIdと同時に指定できません。

−　

入力

△　

HDvM.devNumber

DPボリュームのデバイス番号

DPボリュームのデバイス番号を10進数で指定します。

−　

入力

○　

HDvM.deletionOption

DPボリュームの削除方法

LUSEを削除しない場合だけ，lusekeepを指定します。

−　

入力

△　

HDvM.familyText

ストレージシステムのファミリー名(カスタムオプション)

HDvM.familyプロパティの選択リストにないストレージシステムのファミリー名を指定します。このプロパティを指定した場合，HDvM.familyプロパティに指定した値は無視されます。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.3.7　ホストグループにLUを登録

機能

Hitachi Device Manager Software(以下，Device Manager)を操作して，指定されたLUを指定されたホストグループに登録します。

この部品が前提とするサーバを次に示します。

・HDvMサーバ

　Device Managerがインストールされているサーバです。

・HDvM CLIサーバ(実行対象サーバ)

　Device Manager CLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

操作するストレージシステムの種類によって，ストレージシステムのファミリー名を指定するプロパティが異なります。次のストレージシステムを操作する場合は，「ストレージシステムのファミリー名(カスタムオプション)」(HDvM.familyTextプロパティ)に指定します。その他のストレージシステムを操作する場合は，「ストレージシステムのファミリー名」(HDvM.familyプロパティ)に指定します。

・Hitachi Virtual Storage Platform G1500の場合，「VSP G1500」を指定します。

・Hitachi Virtual Storage Platform F1500の場合，「VSP F1500」を指定します。

・Hitachi Virtual Storage Platform G100/G200/G400/G600/G800の場合，「VSP Gx00」を指定します。

・Hitachi Virtual Storage Platform F400/F600/F800の場合，「VSP Fx00」を指定します。

利用場面

仮想サーバを追加する際などに，仮想サーバのデータ格納用に作成したLUをホストグループに登録する場合に使用できます。

関連する部品を次に記載します。

・storageCreateLU2

・vsphereRecognizeLU

・vsphereGetCanonicalName

・vsphereCreateDatastore

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象システム内前提製品】

(1)HDvMサーバに次の製品がセットアップされていること。

　・Hitachi Device Manager Software 07-00以降

(2)システム内のストレージシステムとして次のどれかがセットアップされていること。

　・Hitachi Adaptable Modular Storage 2100/2300/2500/2010

　・Hitachi Unified Storage 110/130/150

　・Hitachi Unified Storage VM

　・Hitachi Universal Storage Platform V/VM

　・Hitachi Virtual Storage Platform

　・Hitachi Virtual Storage Platform G1000/G1500/F1500

　・Hitachi Virtual Storage Platform G100/G200/G400/G600/G800

　・Hitachi Virtual Storage Platform F400/F600/F800

【実行対象システム内前提製品の使用条件】

(1)ストレージシステムがHitachi Device Manager Softwareで管理されていること。

(2)ストレージシステムに操作対象のLUおよびホストグループが作成済みであること。

【実行対象サーバ内前提製品】

　・Hitachi Device Manager Software CLI 07-00以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

注意事項

(1)HDvM.familyTextプロパティにはサポート対象外のストレージシステムを指定しないでください。

実行権限

(1)Device Managerに接続するユーザーに，次の権限が必要です。

　ModifyまたはAdminロールを割り当てられたユーザー。

バージョン

02.00.00

部品のタグ

Add New Storage,Device Manager

タスクログに表示される部品の名称

storageAddHostgroupLU

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

HDvM.cliInstallPath

HDvM CLIのインストールパス

Device Manager CLIのインストールパスを指定します。

−　

入力

○　

HDvM.httpType

HDvMとの通信プロトコル

Device Managerとの通信プロトコルをhttpまたはhttpsで指定します。

http

入力

○　

HDvM.hostName

HDvMサーバのホスト名

HDvMサーバのホスト名またはIPアドレスを指定します。IPv6アドレスは指定できません。

−　

入力

○　

HDvM.portNumber

HDvMとの接続ポート番号

Device Managerとの接続ポート番号を指定します。

2001

入力

○　

HDvM.userName

HDvMに接続するためのユーザー名

Device Managerに接続するためのユーザー名を指定します。

System

入力

○　

HDvM.password

HDvMに接続するためのパスワード

Device Managerに接続するためのパスワードを指定します。

manager

入力

○　

HDvM.serialNumber

ストレージシステムのシリアル番号

実行対象のストレージシステムのシリアル番号を指定します。

−　

入力

○　

HDvM.family

ストレージシステムのファミリー名

ストレージシステムのファミリー名を指定します。指定可能な値はAMS，USP_V，USP_VM，VSP，HUS，HUS VM，VSP G1000のどれかです。

−　

入力

○　

HDvM.pathName

DPボリュームへのパス名

DPボリュームへのパスの名前を指定します。

−　

入力

△　

HDvM.pathPortNumber

DPボリュームへのパスのポート番号

DPボリュームへのパスのポート番号を指定します。HDvM.pathPortNumberまたはHDvM.pathPortNameを必ず指定してください。

−　

入力

△　

HDvM.pathPortName

DPボリュームへのパスのポート名

DPボリュームへのパスのポート名を指定します。HDvM.pathPortNumberまたはHDvM.pathPortNameを必ず指定してください。

−　

入力

△　

HDvM.domainId

DPボリューム追加先のホストグループのID

DPボリュームを追加するホストグループのIDを10進数または16進数で指定します。16進数の場合は"0x"をプレフィックスとして付与してください。HDvM.domainNicknameと同時に指定できません。

−　

入力

△　

HDvM.domainNickname

DPボリューム追加先のドメインニックネーム

DPボリュームを追加するホストグループのニックネームを指定します。HDvM.domainIdと同時に指定できません。

−　

入力

△　

HDvM.scsiId

SCSI ID

ファイバーチャネルの場合は15を指定します。

−　

入力

△　

HDvM.lun

LU番号（LUN）

LU番号（LUN）を指定します。

−　

入力

○　

HDvM.devNumber

DPボリュームのデバイス番号

DPボリュームのデバイス番号を10進数で指定します。HDvM.devNumberまたはHDvM.luseDevNumsのいずれかを必ず指定してください。

−　

入力

△　

HDvM.luseDevNums

LUSE用LDEV番号リスト

パスのLUSEボリュームを作成するためのLDEV番号のリストを10進数で指定します。複数指定する場合はコンマで区切ります。HDvM.devNumberまたはHDvM.luseDevNumsのいずれかを必ず指定してください。

−　

入力

△　

HDvM.familyText

ストレージシステムのファミリー名(カスタムオプション)

HDvM.familyプロパティの選択リストにないストレージシステムのファミリー名を指定します。このプロパティを指定した場合，HDvM.familyプロパティに指定した値は無視されます。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.4　Hyper-V 2008関連の部品

5.4.1　応答ファイルの作成

機能

この部品は，Hyper-V環境の仮想サーバ(Windows)に対してOSの初期設定，およびIPアドレス設定を行うための応答ファイルを作成します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-VがインストールされているWindowsサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

設定できるIPアドレスは1個だけで，仮想サーバがNICを2個以上持つ場合は，1個目のNICにIPの設定を行い，2個目以降のNICはすべて無効になります。

NICには，IPアドレス(管理用)>IPアドレス(2個目用)>IPアドレス(3個目用)>IPアドレス(4個目用)の順で最初に指定されていたIPアドレスを設定します。その他のIPアドレスは破棄されますのでご注意ください。

指定可能なタイムゾーンは次のとおりです。

　Tokyo Standard Time

　China Standard Time

　GMT Standard Time

　Pacific Standard Time

　Eastern Standard Time

　US Eastern Standard Time

　Central Standard Time

　Central America Standard Time

　US Mountain Standard Time

　Mountain Standard Time

　Alaskan Standard Time

　Hawaiian Standard Time

　Singapore Standard Time

　India Standard Time

指定がない場合，エクスポート済みの仮想サーバに設定されているタイムゾーンが引き継がれます。

指定可能なロケールは次のとおりです。

　ja-JP

　en-US

　zh-CN

指定可能なOS名は次のとおりです。

Windows Server 2008 R2

利用場面

この部品は，Hyper-V環境の仮想サーバ(Windows)に対してOSの初期設定，およびIPアドレス設定を行うための応答ファイルを作成する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2008 R2 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

注意事項

(1)作成する仮想サーバがWindowsの場合，組織名と所有者名は必須となります。組織名の指定がない場合は，"Organization"が設定されます。所有者名の指定がない場合は，"Owner"が設定されます。

(2)作成する仮想サーバがWindowsの場合，OSユーザーパスワードとOSユーザーパスワード再入力は必須となります。どちらかの指定がない場合，"Password123"がパスワードに設定されます。また，2つの値が合致しない場合も"Password123"がパスワードに設定されます。

(3)作成する仮想サーバがWindowsの場合，OS.selectWorkgroupDomainの選択リストで，WORKGROUPかDOMAINの指定が必須となります。どちらの指定もない場合，ワークグループとして"WORKGROUP"が設定されます。また，ワークグループ名/ドメイン名の入力がない場合も，ワークグループとして"WORKGROUP"が設定されます。

(4)作成する仮想サーバがWindowsの場合，OS.selectWorkgroupDomainの選択リストで，WORKGROUPを選択したとき，指定できるワークグループ名は最大15文字までとなります。15文字を超えると"WORKGROUP"が設定されます。

(5)作成する仮想サーバがWindowsの場合，OS.selectWorkgroupDomainの選択リストで，DOMAINを選択したとき，ドメイン名，ドメイン ユーザー名，ドメイン パスワードが必須となります。どれかの指定がない場合，または値が誤っている場合，ワークグループとして"WORKGROUP"が設定されます。

(6) IPアドレス，サブネットマスクは，2つの情報をすべて指定してください。どれかの指定がない場合，IPアドレス，サブネットマスク，およびデフォルトゲートウェイの設定は行われません。

バージョン

02.00.00

部品のタグ

Modify VM,Hyper-V 2008

タスクログに表示される部品の名称

hypervCreateAnsFile

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.ansFileStoreFolderPath

応答ファイルの格納フォルダパス

応答ファイルを格納するフォルダパスをフルパスで指定します。

−　

入力

○　

common.computerName

コンピュータ名/ホスト名

OSのコンピュータ名（ホスト名）を指定します。

−　

入力

○　

Windows.orgName

組織名（会社名）

仮想サーバのOSに設定する組織名を指定します。

−　

入力

○　

Windows.ownerName

名前（所有者名）

仮想サーバのOSに設定する名前（所有者名）を指定します。

−　

入力

○　

OS.ipAddressMan

IPアドレス(VM1個目用)

仮想サーバに設定する1個目のIPアドレスを指定します。

IPv6アドレスには対応していません。

−　

入力

△　

OS.subnetMaskMan

サブネットマスク(VM1個目用)

仮想サーバに設定する1個目のサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.defaultGWMan

デフォルトゲートウェイ(VM1個目用)

仮想サーバに設定する1個目のデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.dnsMan

DNSサーバのIPアドレス(VM1個目用)

仮想サーバに設定する1個目のDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.ipAddress2

IPアドレス(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.subnetMask2

サブネットマスク(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.defaultGW2

デフォルトゲートウェイ(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.dns2

DNSサーバのIPアドレス(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.ipAddress3

IPアドレス(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.subnetMask3

サブネットマスク(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.defaultGW3

デフォルトゲートウェイ(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.dns3

DNSサーバのIPアドレス(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.ipAddress4

IPアドレス(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.subnetMask4

サブネットマスク(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.defaultGW4

デフォルトゲートウェイ(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.dns4

DNSサーバのIPアドレス(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.workgroupNameDomainName

ワークグループ名/ドメイン名

仮想サーバが所属するワークグループ名/ドメイン名を指定します。ワークグループ名は，最大15文字まで指定します。ドメイン名は，最大63文字まで指定します。

−　

入力

○　

OS.domainUserName

ドメインのユーザー名

仮想サーバが所属するドメインのユーザー名を指定します。ワークグループ/ドメインの選択で"DOMAIN"を選択した場合，入力する必要があります。

−　

入力

△　

OS.domainUserPassword

ドメインのパスワード

仮想サーバが所属するドメインのパスワードを指定します。ワークグループ/ドメインの選択で"DOMAIN"を選択した場合，入力する必要があります。

−　

入力

△　

OS.selectWorkgroupDomain

ワークグループ/ドメインの選択

仮想サーバがワークグループまたはドメインのどちらに所属するかを指定します。

−　

入力

○　

common.osUserPassword

Administratorのパスワード

OSに設定するAdministratorのパスワードを指定します。入力がない場合は，"Password123"が設定されます。

−　

入力

△　

common.osUserPasswordReEnter

Administratorのパスワード再入力

OSに設定するAdministratorのパスワードを再入力してください。入力がない場合は，"Password123"が設定されます。

−　

入力

△　

OS.productKey

Windowsのプロダクトキー

Windowsのプロダクトキーを指定します。入力の形式は「XXXXX-XXXXX-XXXXX-XXXXX-XXXXX」です。

−　

入力

△　

OS.operatingSystem

OS名

仮想サーバのOS名を指定します。

−　

入力

○　

OS.timeZone

タイムゾーン

仮想サーバのOSに設定するタイムゾーンを指定します。

−　

入力

△　

OS.systemLocale

システムロケール

仮想サーバのOSに設定されているシステムロケールを指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

common.flag2IPsSetup

仮想サーバに2つのIPアドレスを設定したかどうか

仮想サーバに2つIPアドレスを設定したとき（TRUE），それ以外のとき（FALSE）を格納するプロパティです。

−　

出力

△　

common.flagJoinDomain

ドメイン参加処理の要否

ドメインに参加するとき(TRUE)，ドメインに参加しないとき（FALSE）を格納します。

−　

出力

△　

OS.mngIpaddr

IPアドレス(管理用)

IPアドレス(管理用)を格納します。

−　

出力

△　

5.4.2　仮想サーバのIPアドレス取得

機能

この部品は，Hyper-V環境における仮想サーバのすべてのNICに設定されたIPアドレス(IPv4)を取得します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

取得したIPアドレスは，hyperv.vmIPaddressプロパティに格納されます。仮想サーバに複数のIPアドレスが設定されている場合には，コンマ区切りで出力します。

ただし，IPアドレスの長さの合計が1024文字を超える場合，1025文字目以降を含むIPアドレスは切り捨てられます。すべてのNICでIPv4のIPアドレスが65個以上設定されていると，1024文字を超える場合があります。

利用場面

仮想サーバ設定されているIPアドレス(IPv4)の確認や，仮想サーバに対してICMPエコー要求を発行する場合に使用できます。

ICMPエコー要求を発行する処理は，この部品で仮想サーバのIPアドレスを取得し，osSendIcmp部品の入力として使用するという流れになります。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2008 R2 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。

　・データ交換

(3)仮想サーバが起動完了していること。

バージョン

02.00.00

部品のタグ

Gather VM information,Hyper-V 2008

タスクログに表示される部品の名称

hypervGetVMIPaddress

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

30

異常(仮想サーバの消失) 処理中の仮想サーバの消失

31

異常(データ交換(KVP)による仮想サーバの情報取得の失敗) データ交換(KVP)による仮想サーバの情報取得の失敗

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.waitTime

IPアドレス取得開始前の待機処理時間

IPアドレス取得開始前に実施する待機処理の時間を秒単位で指定します。

0

入力

○　

hyperv.vmIPaddress

仮想サーバのIPアドレス

仮想サーバのIPアドレスが格納されます。仮想サーバに複数のIPアドレスが設定されている場合には，コンマ区切りで出力されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.4.3　仮想サーバのシャットダウン

機能

この部品は，Hyper-V環境における仮想サーバのOSに対して強制的にシャットダウンを実行します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

仮想サーバのOSをシャットダウンする際には，hyperv.checkVmStateDisabledIntervalプロパティに指定した秒数待ち合わせ，仮想サーバの状態を確認する動作を，hyperv.checkVmStateDisabledCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

部品が正常終了した場合は，hyperv.vmStateプロパティに"3"を格納します。

格納する値と仮想サーバの状態の関係については，JP1/AOマニュアルの「Hyper-Vが管理している仮想サーバの状態一覧」を参照してください。

利用場面

仮想サーバのOSをシャットダウンする場合に使用できます。

シャットダウン処理は，hypervGetVMState部品で仮想サーバの状態を取得し，状態を判定したあとに，この部品を実行するという流れになります。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2008 R2 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。

　・オペレーティングシステムのシャットダウン

(3)仮想サーバが起動完了していること。

注意事項

(1)この部品は指定した仮想サーバのOSを強制的にシャットダウンします。この部品を使用した場合，仮想サーバで編集中のファイルデータは保存されません。

バージョン

02.00.00

部品のタグ

Control VM,Hyper-V 2008

タスクログに表示される部品の名称

hypervShutdownVM

戻り値

戻り値

説明

0

正常

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

28

異常(仮想サーバの不正な状態変更) 仮想サーバの不正な状態変更

29

異常(仮想サーバの状態確認のタイムアウト) 仮想サーバの状態確認のタイムアウト

30

異常(仮想サーバの消失) 処理中の仮想サーバの消失

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.checkVmStateDisabledCount

仮想サーバの状態(停止完了)の確認回数

仮想サーバの停止が完了したか確認する際の確認回数を指定します。仮想サーバの状態(停止完了)の確認間隔と組み合わせて最大待ち時間となります。

1440

入力

○　

hyperv.checkVmStateDisabledInterval

仮想サーバの状態(停止完了)の確認間隔

仮想サーバの停止が完了したか確認する際の確認間隔を秒単位で指定します。

5

入力

○　

hyperv.checkJobShutdownCount

ジョブ監視回数(InitiateShutdownメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(InitiateShutdownメソッド)調整用のプロパティです。変更の必要はありません。

1200

入力

○　

hyperv.checkJobShutdownInterval

ジョブ監視間隔(InitiateShutdownメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(InitiateShutdownメソッド)調整用のプロパティです。変更の必要はありません。

3

入力

○　

hyperv.vmState

仮想サーバの状態

仮想サーバの状態が格納されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.4.4　仮想サーバの仮想スイッチ設定

機能

この部品は，Hyper-V環境の仮想サーバに仮想スイッチを設定します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-VがインストールされているWindowsサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

仮想サーバに設定されているNICの中から，指定されたMACアドレスのNICに対し，仮想スイッチを設定します。

NICに既に設定されている仮想スイッチは，指定された仮想スイッチに上書きされます。

仮想スイッチの指定がない場合，仮想スイッチとの接続が切断された状態になります。

MACアドレスに不正な値が指定された場合や指定がない場合，Hyper-Vの認識するNICの順番に従い，仮想スイッチを設定します。

仮想スイッチは最大4個まで設定することができます。指定した仮想スイッチの数が，仮想サーバが持つNICの数より多い場合，NICに割り当てられなかった仮想スイッチの設定は無効になりますのでご注意ください。

利用場面

この部品は，Hyper-V環境の仮想サーバに仮想スイッチを設定する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2008 R2 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)仮想スイッチ名はHyper-Vサーバ内で一意であること。

(3)仮想サーバにレガシーネットワークアダプターが設定されていないこと。

バージョン

02.00.00

部品のタグ

Modify VM,Hyper-V 2008

タスクログに表示される部品の名称

hypervSetVirtualSwitch

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.virtualSwitch1

仮想スイッチ名(1個目用)

仮想サーバに設定されているNIC(1個目用)に設定する仮想スイッチ名(1個目用)を指定します。

−　

入力

△　

OS.nic1MacAddress

NICのMACアドレス(1個目用)

仮想スイッチ名(1個目用)を設定するNICのMACアドレスを指定します。

−　

入力

△　

hyperv.virtualSwitch2

仮想スイッチ名(2個目用)

仮想サーバに設定されているNIC(2個目用)に設定する仮想スイッチ名(2個目用)を指定します。

−　

入力

△　

OS.nic2MacAddress

NICのMACアドレス(2個目用)

仮想スイッチ名(2個目用)を設定するNICのMACアドレスを指定します。

−　

入力

△　

hyperv.virtualSwitch3

仮想スイッチ名(3個目用)

仮想サーバに設定されているNIC(3個目用)に設定する仮想スイッチ名(3個目用)を指定します。

−　

入力

△　

OS.nic3MacAddress

NICのMACアドレス(3個目用)

仮想スイッチ名(3個目用)を設定するNICのMACアドレスを指定します。

−　

入力

△　

hyperv.virtualSwitch4

仮想スイッチ名(4個目用)

仮想サーバに設定されているNIC(4個目用)に設定する仮想スイッチ名(4個目用)を指定します。

−　

入力

△　

OS.nic4MacAddress

NICのMACアドレス(4個目用)

仮想スイッチ名(4個目用)を設定するNICのMACアドレスを指定します。

−　

入力

△　

hyperv.checkJobStateCountNewSw

ジョブ監視回数(ModifyVirtualSystemResourcesメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(ModifyVirtualSystemResourcesメソッド)調整用のプロパティです。変更の必要はありません。

1200

入力

○　

hyperv.checkJobStateIntervalNewSw

ジョブ監視間隔(ModifyVirtualSystemResourcesメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(ModifyVirtualSystemResourcesメソッド)調整用のプロパティです。変更の必要はありません。

3

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.4.5　仮想サーバの起動

機能

この部品は，Hyper-V環境における仮想サーバを起動します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

仮想サーバを起動する際には，hyperv.checkVmStateEnabledIntervalプロパティに指定した秒数待ち合わせ，仮想サーバの起動状態を確認する動作を，hyperv.checkVmStateEnabledCountプロパティに指定した回数繰り返します。各プロパティの値は，利用している環境に合わせて調整してください。

部品が正常終了した場合は，hyperv.vmStateプロパティに"2"を格納します。

格納する値と仮想サーバの状態の関係については，JP1/AOマニュアルの「Hyper-Vが管理している仮想サーバの状態一覧」を参照してください。

利用場面

仮想サーバを起動する場合に使用できます。

起動処理は，hypervGetVMState部品で仮想サーバの状態を取得し，状態を判定したあとに，この部品を実行するという流れになります。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2008 R2 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。

　・データ交換

(3)仮想サーバが停止完了していること。

バージョン

02.00.00

部品のタグ

Control VM,Hyper-V 2008

タスクログに表示される部品の名称

hypervPowerOnVM

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

29

異常(仮想サーバの状態確認のタイムアウト) 仮想サーバの状態確認のタイムアウト

30

異常(仮想サーバの消失) 処理中の仮想サーバの消失

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.checkVmStateEnabledCount

仮想サーバの状態(起動完了)の確認回数

仮想サーバの起動が完了したか確認する際の確認回数を指定します。仮想サーバの状態(起動完了)の確認間隔と組み合わせて最大待ち時間となります。

1440

入力

○　

hyperv.checkVmStateEnabledInterval

仮想サーバの状態(起動完了)の確認間隔

仮想サーバの起動が完了したか確認する際の確認間隔を秒単位で指定します。

5

入力

○　

hyperv.checkJobPowerOnCount

ジョブ監視回数(RequestStateChangeメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(RequestStateChangeメソッド)調整用のプロパティです。変更の必要はありません。

1440

入力

○　

hyperv.checkJobPowerOnInterval

ジョブ監視間隔(RequestStateChangeメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(RequestStateChangeメソッド)調整用のプロパティです。変更の必要はありません。

5

入力

○　

hyperv.vmState

仮想サーバの状態

仮想サーバの状態が格納されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.4.6　仮想サーバの作成

機能

この部品は，Hyper-V環境において，エクスポート済みの仮想サーバを複製して，仮想サーバを作成します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-VがインストールされているWindowsサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

・エクスポート済みの仮想サーバ

　Hyper-Vからエクスポートされた仮想サーバ，およびその仮想サーバの構成ファイル一式です。

・格納サーバ

　複製元となる，エクスポート済みの仮想サーバを格納してあるサーバです。

インポート先に，エクスポート済みの仮想サーバを複製します。

Hyper-Vサーバに，インポート機能を用いて仮想サーバを作成します。

新規に作成する仮想サーバには，新しい一意なIDを作成します。

インポート先に指定したパスのフォルダが既に存在する場合，そのフォルダを使用します。

利用場面

この部品は，Hyper-V環境で新規仮想サーバを作成する場合に使用できます。次の部品と併せて実行することで，仮想サーバのOS初期設定およびIPアドレスの設定を実施できます。

・hypervCreateAnsFile

・hypervMountVhd

・hypervUnmountVhd

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2008 R2 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)Hyper-Vサーバからエクスポートする前に仮想サーバに次の設定が行われていること。

　①Administratorユーザーのパスワードを空にしていること。

　②ネットワーク設定を削除していること。

　　仮想ホストのネットワークアダプタの情報を設定している場合は，次の設定個所を空にしてから，

　　[IPアドレスを自動的に取得する]および[DNSサーバのアドレスを自動的に取得する]に設定すること。

　　・IPアドレス

　　・サブネットマスク

　　・デフォルトゲートウェイ

　　・優先DNSサーバ

　　・代替DNSサーバ

　③Sysprepを用いてOS情報が初期化されていること。

　　その際，次のオプションを選択すること。

　　[システム クリーンアップ アクション]プルダウンメニューから[システムのOOBE(Out-of-Box Experience)に入る]を選択する。

　　[一般化する］チェックボックスをチェックする。

(3)格納サーバとHyper-Vサーバが別サーバの場合，Hyper-Vサーバからエクスポート済みの仮想サーバが格納されているフォルダに共有設定がされていること。

(4)エクスポート済みの仮想サーバにスナップショット，および差分ディスクが作成されていないこと。

注意事項

(1)インポート先に指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。

(2)インポート先に指定したパスのフォルダ内に仮想ディスクファイルが残っている場合は，タスクが異常終了します。インポート先に指定したパスのフォルダを確認し，仮想ディスクを削除するか，別のパスを指定してください。

(3)この部品は，フェールオーバークラスターマネージャーのサービスとアプリケーションにデプロイした仮想サーバを登録しません。ユーザーの運用に合わせて手動で登録してください。

バージョン

02.00.00

部品のタグ

Add VM,Hyper-V 2008

タスクログに表示される部品の名称

hypervCreateVM

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.importFolderPath

インポート先

仮想サーバの格納先フォルダのパスを指定します。

−　

入力

○　

hyperv.userName

格納サーバに接続するためのユーザー名

格納サーバに接続するためのユーザー名を指定します。格納サーバがHyper-Vサーバと別サーバの場合は指定してください。

−　

入力

△　

hyperv.password

格納サーバに接続するためのパスワード

格納サーバに接続するためのパスワードを指定します。格納サーバがHyper-Vサーバと別サーバの場合は指定してください。

−　

入力

△　

hyperv.exportedVmName

エクスポート済みの仮想サーバのフォルダのパス

仮想サーバの複製元となるエクスポート済みの仮想サーバのフォルダ名をフルパスで指定します。格納サーバがHyper-Vサーバと別サーバの場合，UNCを指定してください。

−　

入力

○　

hyperv.checkJobStateCountGetVm

ジョブ監視回数(GetVirtualSystemImportSettingDataメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(GetVirtualSystemImportSettingDataメソッド)調整用のプロパティです。変更の必要はありません。

1200

入力

○　

hyperv.checkJobStateIntervalGetVm

ジョブ監視間隔(GetVirtualSystemImportSettingDataメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(GetVirtualSystemImportSettingDataメソッド)調整用のプロパティです。変更の必要はありません。

3

入力

○　

hyperv.checkJobStateCountNewVm

ジョブ監視回数(ImportVirtualSystemExメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(ImportVirtualSystemExメソッド)調整用のプロパティです。変更の必要はありません。

1440

入力

○　

hyperv.checkJobStateIntervalNewVm

ジョブ監視間隔(ImportVirtualSystemExメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(ImportVirtualSystemExメソッド)調整用のプロパティです。変更の必要はありません。

5

入力

○　

hyperv.returnVhdPath

仮想ディスクファイルパス(1個目用)

この部品で作成した仮想ディスク(1個目)のファイルパスをフルパスで格納します。

−　

出力

△　

hyperv.returnVhdPath2

仮想ディスクファイルパス(2個目用)

この部品で作成した仮想ディスク(2個目)のファイルパスをフルパスで格納します。

−　

出力

△　

hyperv.returnVhdPath3

仮想ディスクファイルパス(3個目用)

この部品で作成した仮想ディスク(3個目)のファイルパスをフルパスで格納します。

−　

出力

△　

hyperv.returnVhdPath4

仮想ディスクファイルパス(4個目用)

この部品で作成した仮想ディスク(4個目)のファイルパスをフルパスで格納します。

−　

出力

△　

hyperv.returnNumOfNic

NIC数

仮想サーバに接続しているNICの数を格納します。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.4.7　仮想サーバの削除

機能

この部品は，Hyper-V環境において，仮想サーバを削除します。

Hyper-Vサーバから仮想サーバを削除するとき，スナップショットも併せて削除します。

hyperv.vHardDiskDeletePermanentlyプロパティに，"yes"を指定した場合，削除する仮想サーバに割り当てられているすべての仮想ディスクファイル(容量可変/容量固定/差分)を削除します。パススルー(物理)ディスク，フロッピーディスクまたはCD/DVDなどに割り当てられているディスクやファイルは削除しません。仮想ディスク(差分)が割り当てられている場合，仮想ディスク(差分)の親として使用する仮想ディスクは削除しません。

hyperv.vhdListOutputFileNameプロパティを指定した場合，Hyper-Vサーバから削除する仮想サーバに割り当てられている仮想ディスクファイルのパス一覧をCSV形式で出力します。仮想ディスク(差分)が割り当てられている場合，仮想ディスク(差分)の親として使用する仮想ディスクは含まれません。

出力するCSVファイルの項目を次に示します。

項目はコンマ区切りで出力します。

(a) 仮想ディスクファイルの有無 (ヘッダー名：Existence)

　　仮想サーバの削除実行時に割り当てられている仮想ディスクファイルが存在するかどうかを出力します。項目の値を次に示します。

　　　Found：ファイルの存在を確認

　　　NotFound：ファイルが設定されているが，存在を確認できない

(b) ファイルの削除結果 (ヘッダー名：DeleteResult)

　　hyperv.vHardDiskDeletePermanentlyプロパティに"yes"を指定した場合，仮想ディスクファイルの削除の実行結果を出力します。"no"を指定した場合でも"Skipped"を出力します。項目の値を次に示します。

　　　Completed：ファイルの削除が成功

　　　Failed：ファイルの削除が失敗

　　　Skipped：ファイルの削除が未実施

(c) ファイルのパス (ヘッダー名：FilePath)

　　(a)(b)の内容に関わらず，Hyper-Vサーバで設定されている仮想ディスクファイルのパスを出力します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

利用場面

この部品は，仮想サーバの滅却などのタイミングで，仮想サーバを削除する際に利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2008 R2 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)仮想サーバが停止完了の状態であること。

注意事項

(1)仮想ディスクファイルのパスを仮想サーバの設定情報から参照できなくなるような操作(スナップショット操作など)を行った場合，その仮想ディスクファイルは削除されません。この場合は手動で削除してください。

(2)hyperv.vhdListOutputFileNameプロパティに指定したファイル名がすでに存在する場合，既存のファイルを上書きします。

(3)hyperv.vhdListOutputFileNameプロパティに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

(4)hyperv.vhdListOutputFileNameプロパティを指定した場合，仮想サーバ，または仮想ディスクファイルの削除時にエラーが発生した場合でも，仮想ディスクファイル一覧を出力します。

(5)この部品は，フェールオーバークラスターマネージャーのサービスとアプリケーションから仮想サーバの登録情報を削除しません。ユーザーの運用に合わせて手動で削除してください。

バージョン

02.00.00

部品のタグ

Delete VM,Hyper-V 2008

タスクログに表示される部品の名称

hypervDeleteVM

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.vHardDiskDeletePermanently

仮想ディスクファイルの削除の要否

仮想サーバで使用している仮想ディスクファイルを削除するかどうか指定します。

no

入力

○　

hyperv.vhdListOutputFileName

仮想ディスクファイル一覧出力ファイル名

仮想ディスクファイル一覧を出力するファイル名をフルパスで指定します。

−　

入力

△　

hyperv.checkJobDelVMCount

ジョブ監視回数(DestroyVirtualSystemメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(DestroyVirtualSystemメソッド)調整用のプロパティです。変更の必要はありません。

28800

入力

○　

hyperv.checkJobDelVMInterval

ジョブ監視間隔(DestroyVirtualSystemメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(DestroyVirtualSystemメソッド)調整用のプロパティです。変更の必要はありません。

3

入力

○　

hyperv.checkJobDelSnapshotCount

ジョブ監視回数(RemoveVirtualSystemSnapshotTreeメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(RemoveVirtualSystemSnapshotTreeメソッド)調整用のプロパティです。変更の必要はありません。

28800

入力

○　

hyperv.checkJobDelSnapshotInterval

ジョブ監視間隔(RemoveVirtualSystemSnapshotTreeメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(RemoveVirtualSystemSnapshotTreeメソッド)調整用のプロパティです。変更の必要はありません。

3

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.4.8　仮想サーバの情報一覧取得

機能

この部品は，Hyper-Vサーバの管理下にある仮想サーバの情報一覧をCSV形式でファイルに出力します。

出力ファイルのエンコード形式は，Hyper-Vサーバのシステムのデフォルトエンコーディングです。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

出力するCSVファイルの項目を次に示します。

項目はコンマ区切りで出力します。

(a) Hyper-Vサーバ名 (ヘッダー名：HostName)

(b) 仮想サーバ名 (ヘッダー名：VmName)

(c) 仮想サーバの状態※1 (ヘッダー名：VmState)

(d) 仮想サーバのCPU数※2 (ヘッダー名：NumCpu)

(e) 仮想サーバのメモリ容量(MB)※3 (ヘッダー名：MemoryMB)

※1：仮想サーバの状態の詳細については，JP1/AOマニュアルの「Hyper-Vが管理している仮想サーバの状態一覧」を参照してください。

※2：CPU数の値は，仮想サーバに割り当てられている仮想プロセッサの数です。

※3：仮想サーバに動的メモリを設定している場合は，スタートアップRAMの値です。

利用場面

Hyper-Vサーバの管理下にある仮想サーバの情報を取得する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2008 R2 Hyper-V

ただし，Server Coreインストール環境は除く。

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

バージョン

02.00.00

部品のタグ

Gather VM information,Hyper-V 2008

タスクログに表示される部品の名称

hypervOutputVmSpec

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

28

異常(取得情報なし) 仮想サーバが一台も存在しない

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.fileName

ファイル名

ファイル名をフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.4.9　仮想サーバの状態取得

機能

この部品は，Hyper-V環境における仮想サーバの状態を取得します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

取得した仮想サーバの状態の値を，hyperv.vmStateプロパティに格納します。

格納する値と仮想サーバの状態の関係については，JP1/AOマニュアルの「Hyper-Vが管理している仮想サーバの状態一覧」を参照してください。

利用場面

この部品は，仮想サーバの状態を確認し，仮想サーバの起動や停止，削除など，状態に応じた対処を実施する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2008 R2 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

バージョン

02.00.00

部品のタグ

Gather VM information,Hyper-V 2008

タスクログに表示される部品の名称

hypervGetVMState

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.vmState

仮想サーバの状態

仮想サーバの状態が格納されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.4.10　仮想サーバへのディスク追加

機能

この部品は，Hyper-V環境において，仮想サーバにディスクを追加します。

仮想サーバに仮想ディスク(容量可変/容量固定)を追加できますが，仮想ディスク(差分)およびパススルー(物理)ディスクは追加できません。

仮想ディスクファイルは，新規に作成します。

仮想ディスクは，SCSIコントローラーに追加できますが，IDEコントローラーには追加できません。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

利用場面

この部品は，仮想サーバの新規構築時やディスク増設時など，仮想サーバにデータディスクを追加する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2008 R2 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)仮想サーバが停止完了の状態であること。

(3)仮想サーバにSCSIコントローラーが存在すること。

注意事項

(1)仮想サーバに追加した仮想ディスクの初期化は行いません。必要に応じて仮想サーバのOSにログインし，ディスクの初期化を実施してください。

(2)Hyper-Vサーバに作成済みの仮想ディスクファイルは追加できません。

バージョン

02.00.00

部品のタグ

Modify VM,Hyper-V 2008

タスクログに表示される部品の名称

hypervAddVDisk

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.vHardDiskType

仮想ディスクのタイプ

仮想ディスクのタイプを指定します。次のどちらかを指定します。Dynamic:容量可変の仮想ディスクを作成します。Fixed:容量固定の仮想ディスクを作成します。

−　

入力

○　

hyperv.scsiControllerNumber

SCSIコントローラーの番号

仮想ディスクを追加する仮想サーバのSCSIコントローラーの番号を指定します。SCSIコントローラーの番号は，仮想サーバにSCSIコントローラーを追加した(Hyper-V マネージャーで表示する)順番を0から相対する整数値で指定してください。

−　

入力

○　

hyperv.scsiLocationNumber

SCSIコントローラーの場所番号

仮想ディスクを追加する仮想サーバのSCSIコントローラーの場所番号を指定します。SCSIコントローラーの場所番号は，仮想サーバに追加したSCSIコントローラーの未使用の場所を整数値で指定してください。

−　

入力

○　

hyperv.vhdPath

仮想ディスクファイルのパス

作成する仮想ディスクファイルのパスをフルパスで指定します。仮想ディスクファイルの拡張子はvhdを指定してください。作成済みの仮想ディスクファイルは指定できません。

−　

入力

○　

hyperv.vHardDiskCapacity

仮想ディスクの容量

作成する仮想ディスクの容量(単位:GB)を指定します。

−　

入力

○　

hyperv.checkJobNewVhdCount

ジョブ監視回数(CreateDynamicVirtualHardDisk/CreateFixedVirtualHardDiskメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(CreateDynamicVirtualHardDisk/CreateFixedVirtualHardDiskメソッド)調整用のプロパティです。変更の必要はありません。

57600

入力

○　

hyperv.checkJobNewVhdInterval

ジョブ監視間隔(CreateDynamicVirtualHardDisk/CreateFixedVirtualHardDiskメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(CreateDynamicVirtualHardDisk/CreateFixedVirtualHardDiskメソッド)調整用のプロパティです。変更の必要はありません。

3

入力

○　

hyperv.checkJobAssignSCSICount

ジョブ監視回数(AddVirtualSystemResourcesメソッド，ハード ドライブの追加)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(AddVirtualSystemResourcesメソッド，ハード ドライブの追加)調整用のプロパティです。変更の必要はありません。

1200

入力

○　

hyperv.checkJobAssignSCSIInterval

ジョブ監視間隔(AddVirtualSystemResourcesメソッド，ハード ドライブの追加)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(AddVirtualSystemResourcesメソッド，ハード ドライブの追加)調整用のプロパティです。変更の必要はありません。

3

入力

○　

hyperv.checkJobJoinCount

ジョブ監視回数(AddVirtualSystemResourcesメソッド，ディスクとの接続)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(AddVirtualSystemResourcesメソッド，ディスクとの接続)調整用のプロパティです。変更の必要はありません。

1200

入力

○　

hyperv.checkJobJoinInterval

ジョブ監視間隔(AddVirtualSystemResourcesメソッド，ディスクとの接続)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(AddVirtualSystemResourcesメソッド，ディスクとの接続)調整用のプロパティです。変更の必要はありません。

3

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.4.11　仮想ディスクのアンマウント

機能

この部品は，Hyper-Vサーバから仮想ディスクをアンマウントします。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-VがインストールされているWindowsサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

利用場面

この部品は，Hyper-Vサーバから仮想ディスクをアンマウントする場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2008 R2 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

バージョン

02.00.00

部品のタグ

Modify VM,Hyper-V 2008

タスクログに表示される部品の名称

hypervUnmountVhd

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vhdPath

仮想ディスクファイルのパス(1個目用)

仮想ディスク(1個目)のファイルパスをフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.4.12　仮想ディスクのマウント

機能

この部品は，Hyper-Vサーバに仮想ディスクをマウントします。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-VがインストールされているWindowsサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

利用場面

この部品は，Hyper-Vサーバに仮想ディスクをマウントする場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2008 R2 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

注意事項

(1)仮想サーバの仮想ディスクをHyper-Vサーバへマウントする際に，Hyper-Vサーバ上の空きドライブ文字を一時的に占有します。そのため，Hyper-Vサーバ上に空きドライブ文字が存在しない場合は，この部品はエラー終了します。マウントを行う仮想ディスクが使用するドライブ分，Hyper-Vサーバ上にドライブ文字が空いていることを確認の上，この部品を実行してください。

バージョン

02.00.00

部品のタグ

Modify VM,Hyper-V 2008

タスクログに表示される部品の名称

hypervMountVhd

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vhdPath

仮想ディスクファイルのパス(1個目用)

仮想ディスク(1個目)のファイルパスをフルパスで指定します。

−　

入力

○　

hyperv.vhdPath2

仮想ディスクファイルのパス(2個目用)

仮想ディスク(2個目)のファイルパスをフルパスで指定します。

−　

入力

△　

hyperv.vhdPath3

仮想ディスクファイルのパス(3個目用)

仮想ディスク(3個目)のファイルパスをフルパスで指定します。

−　

入力

△　

hyperv.vhdPath4

仮想ディスクファイルのパス(4個目用)

仮想ディスク(4個目)のファイルパスをフルパスで指定します。

−　

入力

△　

hyperv.checkJobStateCountGetDriveList

ジョブ監視回数(Win32_LogicalDiskメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(Win32_LogicalDiskメソッド)調整用のプロパティです。変更の必要はありません。

1440

入力

○　

hyperv.checkJobStateIntervalGetDriveList

ジョブ監視間隔(Win32_LogicalDiskメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(Win32_LogicalDiskメソッド)調整用のプロパティです。変更の必要はありません。

5

入力

○　

hyperv.returnDriveLetter

ドライブレター

この部品でマウントした，仮想ディスクに割り当てられたドライブレターを格納します。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

hyperv.returnVhdPath

仮想ディスクファイルパス

仮想ディスクのファイルパスをフルパスで格納します。

−　

出力

△　

5.5　Hyper-V 2012関連の部品

5.5.1　応答ファイルの作成

機能

この部品は，Hyper-V環境の仮想サーバ(Windows)に対してOSの初期設定，およびIPアドレス設定を行うための応答ファイルを作成します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-VがインストールされているWindowsサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

設定できるIPアドレスは1個だけで，仮想サーバがNICを2個以上持つ場合は，1個目のNICにIPの設定を行い，2個目以降のNICはすべて無効になります。

NICには，IPアドレス(管理用)>IPアドレス(2個目用)>IPアドレス(3個目用)>IPアドレス(4個目用)の順で最初に指定されていたIPアドレスを設定します。その他のIPアドレスは破棄されますのでご注意ください。

指定可能なタイムゾーンは次のとおりです。

　Tokyo Standard Time

　China Standard Time

　GMT Standard Time

　Pacific Standard Time

　Eastern Standard Time

　US Eastern Standard Time

　Central Standard Time

　Central America Standard Time

　US Mountain Standard Time

　Mountain Standard Time

　Alaskan Standard Time

　Hawaiian Standard Time

　Singapore Standard Time

　India Standard Time

指定がない場合，エクスポート済みの仮想サーバに設定されているタイムゾーンが引き継がれます。

指定可能なロケールは次のとおりです。

　ja-JP

　en-US

　zh-CN

指定可能なOS名は次のとおりです。

　Windows Server 2008 R2

　Windows Server 2012

　Windows Server 2012 R2

利用場面

この部品は，Hyper-V環境の仮想サーバ(Windows)に対してOSの初期設定，およびIPアドレス設定を行うための応答ファイルを作成する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2012 Hyper-V，Windows Server 2012 R2 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

注意事項

(1)作成する仮想サーバがWindowsの場合，組織名と所有者名は必須となります。組織名の指定がない場合は，"Organization"が設定されます。所有者名の指定がない場合は，"Owner"が設定されます。

(2)作成する仮想サーバがWindowsの場合，OSユーザーパスワードとOSユーザーパスワード再入力は必須となります。どちらかの指定がない場合，"Password123"がパスワードに設定されます。また，2つの値が合致しない場合も"Password123"がパスワードに設定されます。

(3)作成する仮想サーバがWindowsの場合，OS.selectWorkgroupDomainの選択リストで，WORKGROUPかDOMAINの指定が必須となります。どちらの指定もない場合，ワークグループとして"WORKGROUP"が設定されます。また，ワークグループ名/ドメイン名の入力がない場合も，ワークグループとして"WORKGROUP"が設定されます。

(4)作成する仮想サーバがWindowsの場合，OS.selectWorkgroupDomainの選択リストで，WORKGROUPを選択したとき，指定できるワークグループ名は最大15文字までとなります。15文字を超えると"WORKGROUP"が設定されます。

(5)作成する仮想サーバがWindowsの場合，OS.selectWorkgroupDomainの選択リストで，DOMAINを選択したとき，ドメイン名，ドメイン ユーザー名，ドメイン パスワードが必須となります。どれかの指定がない場合，または値が誤っている場合，ワークグループとして"WORKGROUP"が設定されます。

(6)IPアドレス，サブネットマスクは，2つの情報をすべて指定してください。どれかの指定がない場合，IPアドレス，サブネットマスク，およびデフォルトゲートウェイの設定は行われません。

バージョン

02.00.00

部品のタグ

Modify VM,Hyper-V 2012

タスクログに表示される部品の名称

hyperv2012CreateAnsFile

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.ansFileStoreFolderPath

応答ファイルの格納フォルダパス

応答ファイルを格納するフォルダパスをフルパスで指定します。

−　

入力

○　

common.computerName

コンピュータ名/ホスト名

OSのコンピュータ名（ホスト名）を指定します。

−　

入力

○　

Windows.orgName

組織名（会社名）

仮想サーバのOSに設定する組織名を指定します。

−　

入力

○　

Windows.ownerName

名前（所有者名）

仮想サーバのOSに設定する名前（所有者名）を指定します。

−　

入力

○　

OS.ipAddressMan

IPアドレス(VM1個目用)

仮想サーバに設定する1個目のIPアドレスを指定します。

IPv6アドレスには対応していません。

−　

入力

△　

OS.subnetMaskMan

サブネットマスク(VM1個目用)

仮想サーバに設定する1個目のサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.defaultGWMan

デフォルトゲートウェイ(VM1個目用)

仮想サーバに設定する1個目のデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.dnsMan

DNSサーバのIPアドレス(VM1個目用)

仮想サーバに設定する1個目のDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.ipAddress2

IPアドレス(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.subnetMask2

サブネットマスク(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.defaultGW2

デフォルトゲートウェイ(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.dns2

DNSサーバのIPアドレス(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.ipAddress3

IPアドレス(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.subnetMask3

サブネットマスク(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.defaultGW3

デフォルトゲートウェイ(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.dns3

DNSサーバのIPアドレス(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.ipAddress4

IPアドレス(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.subnetMask4

サブネットマスク(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.defaultGW4

デフォルトゲートウェイ(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.dns4

DNSサーバのIPアドレス(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.workgroupNameDomainName

ワークグループ名/ドメイン名

仮想サーバが所属するワークグループ名/ドメイン名を指定します。ワークグループ名は，最大15文字まで指定します。ドメイン名は，最大63文字まで指定します。

−　

入力

○　

OS.domainUserName

ドメインのユーザー名

仮想サーバが所属するドメインのユーザー名を指定します。ワークグループ/ドメインの選択で"DOMAIN"を選択した場合，入力する必要があります。

−　

入力

△　

OS.domainUserPassword

ドメインのパスワード

仮想サーバが所属するドメインのパスワードを指定します。ワークグループ/ドメインの選択で"DOMAIN"を選択した場合，入力する必要があります。

−　

入力

△　

OS.selectWorkgroupDomain

ワークグループ/ドメインの選択

仮想サーバがワークグループまたはドメインのどちらに所属するかを指定します。

−　

入力

○　

common.osUserPassword

Administratorのパスワード

OSに設定するAdministratorのパスワードを指定します。入力がない場合は，"Password123"が設定されます。

−　

入力

△　

common.osUserPasswordReEnter

Administratorのパスワード再入力

OSに設定するAdministratorのパスワードを再入力してください。入力がない場合は，"Password123"が設定されます。

−　

入力

△　

OS.productKey

Windowsのプロダクトキー

Windowsのプロダクトキーを指定します。入力の形式は「XXXXX-XXXXX-XXXXX-XXXXX-XXXXX」です。

−　

入力

△　

OS.operatingSystem

OS名

仮想サーバのOS名を指定します。

−　

入力

○　

OS.timeZone

タイムゾーン

仮想サーバのOSに設定するタイムゾーンを指定します。

−　

入力

△　

OS.systemLocale

システムロケール

仮想サーバのOSに設定されているシステムロケールを指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

common.flag2IPsSetup

仮想サーバに2つのIPアドレスを設定したかどうか

仮想サーバに2つIPアドレスを設定したとき（TRUE），それ以外のとき（FALSE）を格納するプロパティです。

−　

出力

△　

common.flagJoinDomain

ドメイン参加処理の要否

ドメインに参加するとき(TRUE)，ドメインに参加しないとき（FALSE）を格納します。

−　

出力

△　

OS.mngIpaddr

IPアドレス(管理用)

IPアドレス(管理用)を格納します。

−　

出力

△　

5.5.2　仮想サーバのCPU設定変更

機能

この部品は，Hyper-V環境における仮想サーバのCPUの設定を変更します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

この部品が変更できるCPUの設定は次の通りです。

・仮想プロセッサの数

・仮想プロセッサリソースの予約

・仮想プロセッサリソースの限度

・仮想プロセッサリソースの相対的な重み

・プロセッサの互換性

・NUMAノードで使用できるプロセッサの最大数

・ソケットで使用できるNUMAノードの最大数

利用場面

この部品は，仮想サーバのCPU設定を変更する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2012 Hyper-V，Windows Server 2012 R2 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

注意事項

(1)仮想サーバの状態によって変更できるCPUの設定項目は異なります。

(2)CPUの設定項目がすべて未入力の場合，エラーとなります。

バージョン

02.00.00

部品のタグ

Modify VM,Hyper-V 2012

タスクログに表示される部品の名称

hyperv2012ChangeVMCPU

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.cpuCount

仮想プロセッサの数

仮想サーバに設定する仮想プロセッサの数を指定します。

−　

入力

△　

hyperv.cpuReserve

仮想プロセッサリソースの予約

仮想サーバが予約する仮想サーバ間の仮想プロセッサリソースの配分を指定します。

−　

入力

△　

hyperv.cpuMaximum

仮想プロセッサリソースの限度

仮想サーバが使用する仮想サーバ間の仮想プロセッサリソースの配分の上限値を指定します。

−　

入力

△　

hyperv.cpuRelativeWeight

仮想プロセッサリソースの相対的な重み

仮想サーバ間における仮想プロセッサリソースの相対的な重みを指定します。

−　

入力

△　

hyperv.cpuCompatibilityForMigrationEnabled

プロセッサの互換性

プロセッサの互換性を有効にする場合は「true」，無効にする場合は「false」を指定してください。未入力の場合はプロセッサの互換性の設定を変更しません。

−　

入力

△　

hyperv.cpuMaximumCountPerNumaNode

NUMAノードで使用できるプロセッサの最大数

1つの仮想NUMA(Non-Uniform Memory Architecture)ノードで使用できるプロセッサの最大数を指定します。

−　

入力

△　

hyperv.nodeMaximumCountPerNumaSocket

ソケットで使用できるNUMAノードの最大数

1つのソケットで使用できる仮想NUMA(Non-Uniform Memory Architecture)ノードの最大数を指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

5.5.3　仮想サーバのIPアドレス取得

機能

この部品は，Hyper-V環境における仮想サーバのすべてのNICに設定されたIPアドレス(IPv4)を取得します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

取得したIPアドレスは，hyperv.vmIPaddressプロパティに格納されます。仮想サーバに複数のIPアドレスが設定されている場合には，コンマ区切りで出力します。

ただし，IPアドレスの長さの合計が1024文字を超える場合，1025文字目以降を含むIPアドレスは切り捨てられます。すべてのNICでIPv4のIPアドレスが65個以上設定されていると，1024文字を超える場合があります。

利用場面

仮想サーバに設定されているIPアドレス(IPv4)の確認や，仮想サーバに対してICMPエコー要求を発行する場合に使用できます。

ICMPエコー要求を発行する処理は，この部品で仮想サーバのIPアドレスを取得し，osSendIcmp部品の入力として使用するという流れになります。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2012 Hyper-V，Windows Server 2012 R2 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。

　・データ交換

(3)仮想サーバが起動していること。

バージョン

02.00.00

部品のタグ

Gather VM information,Hyper-V 2012

タスクログに表示される部品の名称

hyperv2012GetVMIPaddress

戻り値

戻り値

説明

0

正常

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.vmIPaddress

仮想サーバのIPアドレス

仮想サーバのIPアドレスが格納されます。仮想サーバに複数のIPアドレスが設定されている場合には，コンマ区切りで出力されます。

−　

出力

−　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

5.5.4　仮想サーバのシャットダウン

機能

この部品は，Hyper-V環境における仮想サーバのOSに対して強制的にシャットダウンを実行します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

利用場面

仮想サーバのOSをシャットダウンする場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2012 Hyper-V，Windows Server 2012 R2 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。

　・オペレーティングシステムのシャットダウン

(3)仮想サーバが起動完了していること。

注意事項

(1)この部品は指定した仮想サーバのOSを強制的にシャットダウンします。この部品を使用した場合，仮想サーバで編集中のファイルデータは保存されません。

バージョン

02.00.00

部品のタグ

Control VM,Hyper-V 2012

タスクログに表示される部品の名称

hyperv2012ShutdownVM

戻り値

戻り値

説明

0

正常

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

28

異常(仮想サーバの不正な状態変更) 仮想サーバの不正な状態変更

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.vmState

仮想サーバの状態

仮想サーバの状態が格納されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.5.5　仮想サーバのメモリ設定変更

機能

この部品は，Hyper-V環境における仮想サーバのメモリの設定を変更します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

この部品が変更できるメモリの設定は次の通りです。

・スタートアップRAM (MB)

・動的メモリの有効

・動的メモリの最小RAM (MB)

・動的メモリの最大RAM (MB)

・動的メモリのメモリバッファー

・メモリの重み

・NUMAノードで使用できるメモリの最大容量 (MB)

利用場面

この部品は，仮想サーバのメモリ設定を変更する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2012 Hyper-V，Windows Server 2012 R2 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

注意事項

(1)仮想サーバの状態によって変更できるメモリの設定項目は異なります。

(2)メモリの設定項目がすべて未入力の場合，エラーとなります。

バージョン

02.00.00

部品のタグ

Modify VM,Hyper-V 2012

タスクログに表示される部品の名称

hyperv2012ChangeVMMemory

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.memoryStartupMegaBytes

スタートアップRAM (MB)

仮想サーバの起動時に使用するメモリの量をMB単位で指定します。

−　

入力

△　

hyperv.dynamicMemoryEnabled

動的メモリの有効

仮想サーバの動的メモリを有効にする場合は「true」，無効にする場合は「false」を指定してください。未入力の場合は動的メモリの有効の設定を変更しません。

−　

入力

△　

hyperv.dynamicMemoryMinimumMegaBytes

動的メモリの最小RAM (MB)

動的メモリにおける最小メモリ量をMB単位で指定します。動的メモリが有効な場合だけ指定してください。

−　

入力

△　

hyperv.dynamicMemoryMaximumMegaBytes

動的メモリの最大RAM (MB)

動的メモリにおける最大メモリ量をMB単位で指定します。動的メモリが有効な場合だけ指定してください。

−　

入力

△　

hyperv.dynamicMemoryBuffer

動的メモリのメモリバッファー

Hyper-Vでバッファーとして予約しておくべきメモリの割合を指定してください。動的メモリが有効な場合だけ指定してください。

−　

入力

△　

hyperv.memoryPriority

メモリの重み

仮想マシン間における使用可能なメモリを割り当てるときの優先度を指定します。

−　

入力

△　

hyperv.memoryMaximumAmountMegaBytesPerNumaNode

NUMAノードで使用できるメモリの最大容量 (MB)

1つの仮想NUMA(Non-Uniform Memory Architecture)ノードで使用できるメモリの最大容量をMB単位で指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

5.5.6　仮想サーバの仮想スイッチ設定

機能

この部品は，Hyper-V環境の仮想サーバに仮想スイッチを設定します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-VがインストールされているWindowsサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

仮想サーバに設定されているNICの中から，指定されたMACアドレスのNICに対し，仮想スイッチを設定します。

NICにすでに設定されている仮想スイッチは，指定された仮想スイッチに上書きされます。

仮想スイッチの指定がない場合，仮想スイッチとの接続が切断された状態になります。

MACアドレスに不正な値が指定された場合や指定がない場合，Hyper-Vの認識するNICの順番に従い，仮想スイッチを設定します。

仮想スイッチは最大4個まで設定することができます。指定した仮想スイッチの数が，仮想サーバが持つNICの数より多い場合，NICに割り当てられなかった仮想スイッチの設定は無効になりますのでご注意ください。

利用場面

この部品は，Hyper-V環境の仮想サーバに仮想スイッチを設定する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2012 Hyper-V，Windows Server 2012 R2 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)仮想スイッチ名はHyper-Vサーバ内で一意であること。

(3)仮想サーバにレガシーネットワークアダプターが設定されていないこと。

バージョン

02.00.00

部品のタグ

Modify VM,Hyper-V 2012

タスクログに表示される部品の名称

hyperv2012SetVirtualSwitch

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.virtualSwitch1

仮想スイッチ名(1個目用)

仮想サーバに設定されているNIC(1個目用)に設定する仮想スイッチ名(1個目用)を指定します。

−　

入力

△　

OS.nic1MacAddress

NICのMACアドレス(1個目用)

仮想スイッチ名(1個目用)を設定するNICのMACアドレスを指定します。

−　

入力

△　

hyperv.virtualSwitch2

仮想スイッチ名(2個目用)

仮想サーバに設定されているNIC(2個目用)に設定する仮想スイッチ名(2個目用)を指定します。

−　

入力

△　

OS.nic2MacAddress

NICのMACアドレス(2個目用)

仮想スイッチ名(2個目用)を設定するNICのMACアドレスを指定します。

−　

入力

△　

hyperv.virtualSwitch3

仮想スイッチ名(3個目用)

仮想サーバに設定されているNIC(3個目用)に設定する仮想スイッチ名(3個目用)を指定します。

−　

入力

△　

OS.nic3MacAddress

NICのMACアドレス(3個目用)

仮想スイッチ名(3個目用)を設定するNICのMACアドレスを指定します。

−　

入力

△　

hyperv.virtualSwitch4

仮想スイッチ名(4個目用)

仮想サーバに設定されているNIC(4個目用)に設定する仮想スイッチ名(4個目用)を指定します。

−　

入力

△　

OS.nic4MacAddress

NICのMACアドレス(4個目用)

仮想スイッチ名(4個目用)を設定するNICのMACアドレスを指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.5.7　仮想サーバの起動

機能

この部品は，Hyper-V環境における仮想サーバを起動します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

利用場面

仮想サーバを起動する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2012 Hyper-V，Windows Server 2012 R2 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。

　・データ交換

(3)仮想サーバが停止完了していること。

バージョン

02.00.00

部品のタグ

Control VM,Hyper-V 2012

タスクログに表示される部品の名称

hyperv2012PowerOnVM

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

29

異常(仮想サーバの状態確認のタイムアウト) 仮想サーバの状態確認のタイムアウト

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.checkVmStateEnabledCount

仮想サーバの状態(起動完了)の確認回数

仮想サーバの起動が完了したか確認する際の確認回数を指定します。仮想サーバの状態(起動完了)の確認間隔と組み合わせて最大待ち時間となります。

1440

入力

○　

hyperv.checkVmStateEnabledInterval

仮想サーバの状態(起動完了)の確認間隔

仮想サーバの起動が完了したか確認する際の確認間隔を秒単位で指定します。

5

入力

○　

hyperv.vmState

仮想サーバの状態

仮想サーバの状態が格納されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.5.8　仮想サーバの作成

機能

この部品は，Hyper-V環境において，エクスポート済みの仮想サーバを複製して，仮想サーバを作成します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-VがインストールされているWindowsサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

・エクスポート済みの仮想サーバ

　Hyper-Vからエクスポートされた仮想サーバ，およびその仮想サーバの構成ファイル一式です。

・格納サーバ

　複製元となる，エクスポート済みの仮想サーバを格納してあるサーバです。

インポート先に，エクスポート済みの仮想サーバを複製します。

Hyper-Vサーバに，インポート機能を用いて仮想サーバを作成します。

新規に作成する仮想サーバには，新しい一意なIDを作成します。

インポート先に指定したパスのフォルダが既に存在する場合，そのフォルダを使用します。

利用場面

この部品は，Hyper-V環境で新規仮想サーバを作成する場合に使用できます。次の部品とあわせて実行することで，仮想サーバのOS初期設定およびIPアドレスの設定を実施できます。

・hyperv2012CreateAnsFile

・hyperv2012MountVhd

・hyperv2012UnmountVhd

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2012 Hyper-V，Windows Server 2012 R2 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)格納サーバとHyper-Vサーバが別サーバの場合，Hyper-Vサーバからエクスポート済みの仮想サーバが格納されているフォルダに共有設定がされていること。

(3)エクスポート済みの仮想サーバにスナップショット，および差分ディスクが作成されていないこと。

(4)エクスポート済みの仮想サーバのNICが仮想スイッチとの接続が切断された状態になっていること。

注意事項

(1)インポート先に指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。

(2)インポート先に指定したパスのフォルダ内に仮想ディスクファイルが残っている場合は，タスクが異常終了します。インポート先に指定したパスのフォルダを確認し，仮想ディスクを削除するか，別のパスを指定してください。

(3)この部品は，フェールオーバークラスターマネージャーのサービスとアプリケーションにデプロイした仮想サーバを登録しません。ユーザーの運用に合わせて手動で登録してください。

バージョン

02.00.00

部品のタグ

Add VM,Hyper-V 2012

タスクログに表示される部品の名称

hyperv2012CreateVM

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.importFolderPath

インポート先

仮想サーバの格納先フォルダのパスを指定します。

−　

入力

○　

hyperv.userName

格納サーバに接続するためのユーザー名

格納サーバに接続するためのユーザー名を指定します。格納サーバがHyper-Vサーバと別サーバの場合は指定してください。

−　

入力

△　

hyperv.password

格納サーバに接続するためのパスワード

格納サーバに接続するためのパスワードを指定します。格納サーバがHyper-Vサーバと別サーバの場合は指定してください。

−　

入力

△　

hyperv.exportedVmName

エクスポート済みの仮想サーバのフォルダのパス

仮想サーバの複製元となるエクスポート済みの仮想サーバのフォルダ名をフルパスで指定します。格納サーバがHyper-Vサーバと別サーバの場合，UNCを指定してください。

−　

入力

○　

hyperv.scsiDiskLocation

SCSIコントローラーの場所

システムディスクを設定しているSCSIコントローラーの場所を指定します。このプロパティはエクスポート済みの仮想サーバの世代が第2世代の場合だけ有効です。

0

入力

○　

hyperv.returnVhdPath

仮想ディスクファイルパス(1個目用)

この部品で作成した仮想ディスク(1個目)のファイルパスをフルパスで格納します。

−　

出力

△　

hyperv.returnVhdPath2

仮想ディスクファイルパス(2個目用)

この部品で作成した仮想ディスク(2個目)のファイルパスをフルパスで格納します。

−　

出力

△　

hyperv.returnVhdPath3

仮想ディスクファイルパス(3個目用)

この部品で作成した仮想ディスク(3個目)のファイルパスをフルパスで格納します。

−　

出力

△　

hyperv.returnVhdPath4

仮想ディスクファイルパス(4個目用)

この部品で作成した仮想ディスク(4個目)のファイルパスをフルパスで格納します。

−　

出力

△　

hyperv.returnNumOfNic

NIC数

仮想サーバに接続しているNICの数を格納します。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.5.9　仮想サーバの削除

機能

この部品は，Hyper-V環境において，仮想サーバを削除します。Hyper-Vサーバから仮想サーバを削除するとき，スナップショットも併せて削除します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

hyperv.vHardDiskDeletePermanentlyプロパティに，"yes"を指定した場合，削除する仮想サーバに割り当てられているすべての仮想ディスクファイル(容量可変/容量固定/差分)を削除します。パススルー(物理)ディスク，フロッピーディスクまたはCD/DVDなどに割り当てられているディスクやファイルは削除しません。仮想ディスク(差分)が割り当てられている場合，仮想ディスク(差分)の親として使用する仮想ディスクは削除しません。

hyperv.vhdListOutputFileNameプロパティを指定した場合，Hyper-Vサーバから削除する仮想サーバに割り当てられている仮想ディスクファイルのパス一覧をCSV形式で出力します。仮想ディスク(差分)が割り当てられている場合，仮想ディスク(差分)の親として使用する仮想ディスクは含まれません。

出力するCSVファイルの項目を次に示します。

項目はコンマ区切りで出力します。

(a) 仮想ディスクファイルの有無 (ヘッダー名：Existence)

　　仮想サーバの削除実行時に割り当てられている仮想ディスクファイルが存在するかどうかを出力します。項目の値を次に示します。

　　　Found：ファイルの存在を確認

　　　NotFound：ファイルが設定されているが，存在を確認できない

(b) ファイルの削除結果 (ヘッダー名：DeleteResult)

　　hyperv.vHardDiskDeletePermanentlyプロパティに，"yes"を指定した場合，仮想ディスクファイルの削除の実行結果を出力します。hyperv.vHardDiskDeletePermanentlyプロパティに，"no"を指定した場合でも"Skipped"を出力します。項目の値を次に示します。

　　　Completed：ファイルの削除が成功

　　　Failed：ファイルの削除が失敗

　　　Skipped：ファイルの削除が未実施

(c) ファイルのパス (ヘッダー名：FilePath)

　　(a)(b)の内容に関わらず，Hyper-Vサーバで設定されている仮想ディスクファイルのパスを出力します。

利用場面

この部品は，仮想サーバの滅却などのタイミングで，仮想サーバを削除する際に利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2012 Hyper-V，Windows Server 2012 R2 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)仮想サーバが停止していること。

注意事項

(1)仮想ディスクファイルのパスを仮想サーバの設定情報から参照できなくなるような操作(スナップショット操作など)を行った場合，その仮想ディスクファイルは削除されません。この場合は手動で削除してください。

(2)hyperv.vhdListOutputFileNameプロパティに指定したファイル名がすでに存在する場合，既存のファイルを上書きします。

(3)hyperv.vhdListOutputFileNameプロパティに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

(4)hyperv.vhdListOutputFileNameプロパティを指定した場合，仮想サーバ，または仮想ディスクファイルの削除時にエラーが発生した場合でも，仮想ディスクファイル一覧を出力します。

(5)この部品は，フェールオーバークラスターマネージャーのサービスとアプリケーションから仮想サーバの登録情報を削除しません。ユーザーの運用に合わせて手動で削除してください。

バージョン

02.00.00

部品のタグ

Modify VM,Hyper-V 2012

タスクログに表示される部品の名称

hyperv2012DeleteVM

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.vHardDiskDeletePermanently

仮想ディスクファイルの削除の要否

仮想サーバで使用している仮想ディスクファイルを削除する場合はyes，削除しない場合はnoを指定します。

no

入力

○　

hyperv.vhdListOutputFileName

仮想ディスクファイル一覧出力ファイル名

仮想ディスクファイル一覧を出力するファイル名をフルパスで指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

5.5.10　仮想サーバの情報一覧取得

機能

この部品は，Hyper-Vサーバの管理下にある仮想サーバの情報一覧をCSV形式でファイルに出力します。

出力ファイルのエンコード形式は，Hyper-Vサーバのシステムのデフォルトエンコーディングです。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

出力するCSVファイルの項目を次に示します。

項目はコンマ区切りで出力します。

(a) Hyper-Vサーバ名 (ヘッダー名：ComputerName)

(b) 仮想サーバ名 (ヘッダー名：VMName)

(c) 仮想サーバの状態 (ヘッダー名：State)

(d) 仮想サーバのCPU使用率(%) (ヘッダー名：CPUUsage)

(e) 仮想サーバのメモリ割り当て(MB)※1 (ヘッダー名：MemoryAssigned)

(f) 仮想サーバの稼働時間 (ヘッダー名：Uptime)

(g) 仮想サーバの状況 (ヘッダー名：Status)

(h) 仮想サーバの仮想プロセッサ数 (ヘッダー名：ProcessorCount)

(i) 仮想サーバのスタートアップRAM(MB) (ヘッダー名：MemoryStartup)

(j) 仮想サーバの動的メモリの有効 (ヘッダー名：DynamicMemoryEnabled)

※1：仮想サーバが実際に使用しているメモリの容量(MB)です。

利用場面

Hyper-Vサーバの管理下にある仮想サーバの情報を取得する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2012 Hyper-V，Windows Server 2012 R2 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

なし。

注意事項

(1)指定したファイル名が既に存在する場合，既存のファイルを上書きします。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(2)指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

(3)同名の仮想サーバが2つ以上ある場合，出力するCSVファイルでは仮想サーバを特定できません。

バージョン

02.00.00

部品のタグ

Gather VM information,Hyper-V 2012

タスクログに表示される部品の名称

hyperv2012OutputVmSpec

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmInfoListOutputFileName

仮想サーバ情報一覧出力ファイル名

仮想サーバ情報一覧を出力するファイル名をフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

5.5.11　仮想サーバの状態取得

機能

この部品は，Hyper-V環境における仮想サーバの状態を取得します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

取得した仮想サーバの状態を表す値(数値)を，hyperv.vmStateプロパティに格納します。格納された値が意味する仮想サーバの状態を確認する場合は，タスクログの｢vmState:｣で始まる行をご覧ください。その場合，タスクのログ出力レベルを標準出力内容が出力されるレベル(30または40)に設定する必要があります。

利用場面

この部品は，仮想サーバの状態を確認し，仮想サーバの起動や停止，削除など，状態に応じた対処を実施する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2012 Hyper-V，Windows Server 2012 R2 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

バージョン

02.00.00

部品のタグ

Gather VM information,Hyper-V 2012

タスクログに表示される部品の名称

hyperv2012GetVMState

戻り値

戻り値

説明

0

正常

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.vmState

仮想サーバの状態

仮想サーバの状態が格納されます。

−　

出力

−　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

5.5.12　仮想ディスクのアンマウント

機能

この部品は，Hyper-Vサーバから仮想ディスクをアンマウントします。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-VがインストールされているWindowsサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

利用場面

この部品は，Hyper-Vサーバから仮想ディスクをアンマウントする場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2012 Hyper-V，Windows Server 2012 R2 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

バージョン

02.00.00

部品のタグ

Modify VM,Hyper-V 2012

タスクログに表示される部品の名称

hyperv2012UnmountVhd

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vhdPath

仮想ディスクファイルのパス(1個目用)

仮想ディスク(1個目)のファイルパスをフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.5.13　仮想ディスクのマウント

機能

この部品は，Hyper-Vサーバに仮想ディスクをマウントします。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-VがインストールされているWindowsサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

利用場面

この部品は，Hyper-Vサーバに仮想ディスクをマウントする場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2012 Hyper-V，Windows Server 2012 R2 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

注意事項

(1)仮想サーバの仮想ディスクをHyper-Vサーバへマウントする際に，Hyper-Vサーバ上の空きドライブ文字を一時的に占有します。そのため，Hyper-Vサーバ上に空きドライブ文字が存在しない場合は，この部品はエラー終了します。マウントを行う仮想ディスクが使用するドライブ分，Hyper-Vサーバ上にドライブ文字が空いていることを確認の上，この部品を実行してください。

バージョン

02.00.00

部品のタグ

Modify VM,Hyper-V 2012

タスクログに表示される部品の名称

hyperv2012MountVhd

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.vhdPath

仮想ディスクファイルのパス(1個目用)

仮想ディスク(1個目)のファイルパスをフルパスで指定します。

−　

入力

○　

hyperv.vhdPath2

仮想ディスクファイルのパス(2個目用)

仮想ディスク(2個目)のファイルパスをフルパスで指定します。

−　

入力

△　

hyperv.vhdPath3

仮想ディスクファイルのパス(3個目用)

仮想ディスク(3個目)のファイルパスをフルパスで指定します。

−　

入力

△　

hyperv.vhdPath4

仮想ディスクファイルのパス(4個目用)

仮想ディスク(4個目)のファイルパスをフルパスで指定します。

−　

入力

△　

hyperv.checkJobStateCountGetDriveList

ジョブ監視回数(Win32_LogicalDiskメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(Win32_LogicalDiskメソッド)調整用のプロパティです。変更の必要はありません。

1440

入力

○　

hyperv.checkJobStateIntervalGetDriveList

ジョブ監視間隔(Win32_LogicalDiskメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(Win32_LogicalDiskメソッド)調整用のプロパティです。変更の必要はありません。

5

入力

○　

hyperv.returnDriveLetter

ドライブレター

この部品でマウントした，仮想ディスクに割り当てられたドライブレターを格納します。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

hyperv.returnVhdPath

仮想ディスクファイルパス

仮想ディスクのファイルパスをフルパスで格納します。

−　

出力

△　

5.5.14　仮想ディスクの作成

機能

この部品は，Hyper-V環境において，仮想ディスクファイルを新規に作成します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

作成できる仮想ディスクは「Dynamic:容量可変」または「Fixed:容量固定」です。仮想ディスク(差分)およびパススルー(物理)ディスクは作成できません。

hyperv.vHardDiskFolderPathプロパティを指定した場合に，指定したフォルダパスに仮想ディスクファイルを新規に作成します。指定が無い場合は，Hyper-Vサーバに設定されている仮想ディスクを保存する既定のフォルダに仮想ディスクファイルを保存します。

作成する仮想ディスクファイルを保存するフォルダパスが存在しない場合はフォルダを作成します。

利用場面

この部品は，仮想サーバの新規構築時やディスク増設時など，仮想サーバにデータディスクを追加する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2012 Hyper-V，Windows Server 2012 R2 Hyper-V

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

なし。

注意事項

(1)作成した仮想ディスクの初期化は行いません。必要に応じて，ディスクの初期化を実行してください。

バージョン

02.00.00

部品のタグ

Modify VM,Hyper-V 2012

タスクログに表示される部品の名称

hyperv2012CreateVDisk

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vHardDiskName

仮想ディスクファイル名

作成する仮想ディスクのファイル名を指定してください。ファイルの拡張子には「vhd」または「vhdx」を指定してください。

−　

入力

○　

hyperv.vHardDiskFolderPath

仮想ディスク保存フォルダパス

作成する仮想ディスクを保存するフォルダのフルパスを指定してください。指定を省略した場合は，Hyper-Vサーバに設定されている仮想ディスクを保存する既定のフォルダに仮想ディスクを保存します。

−　

入力

△　

hyperv.vHardDiskType

仮想ディスクのタイプ

仮想ディスクのタイプを指定します。次のどちらかを指定します。Dynamic:容量可変の仮想ディスクを作成します。Fixed:容量固定の仮想ディスクを作成します。

−　

入力

○　

hyperv.vHardDiskCapacityGB

仮想ディスクの容量 (GB)

作成する仮想ディスクの容量(単位:GB)を指定します。仮想ディスクの容量は整数値で指定してください。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

hyperv.returnVhdPath

仮想ディスクファイルパス

この部品で作成した仮想ディスクのファイルパスをフルパスで格納します。

−　

出力

−　

5.5.15　仮想ディスクの接続

機能

この部品は，Hyper-V環境において，仮想サーバに仮想ディスクを接続します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

仮想ディスクは，SCSIコントローラーに追加できますが，IDEコントローラーには追加できません。

SCSIコントローラーの番号(hyperv.scsiControllerNumberプロパティ)とSCSIコントローラーの場所番号(hyperv.scsiLocationNumberプロパティ)の指定の有無により，SCSIコントローラーへの仮想ディスクの接続方法が異なります。

・SCSIコントローラーの番号とSCSIコントローラーの場所番号が両方指定されていない場合

　接続可能なSCSIコントローラーにHyper-Vサーバが自動的に仮想ディスクを接続します。

・SCSIコントローラーの番号だけ指定されている場合

　指定したSCSIコントローラーの番号で接続可能なSCSIコントローラーの場所番号(0〜63)のどれかにHyper-Vサーバが自動的に仮想ディスクを接続します。

・SCSIコントローラーの場所番号だけ指定されている場合

　指定したSCSIコントローラーの場所番号で接続可能なSCSIコントローラーの番号(0〜3)のどれかにHyper-Vサーバが自動的に仮想ディスクを接続します。

・SCSIコントローラーの番号とSCSIコントローラーの場所番号が両方指定されている場合

　指定したSCSIコントローラーの番号とSCSIコントローラーの場所番号に仮想ディスクを接続します。

利用場面

この部品は，仮想サーバの新規構築時やディスク増設時など，仮想サーバにデータディスクを追加する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2012 Hyper-V，Windows Server 2012 R2 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)仮想サーバに接続可能なSCSIコントローラーが存在すること。

注意事項

(1)指定したSCSIコントローラーの番号とSCSIコントローラーの場所番号が既に他の仮想ディスクの接続先として使用されている場合は異常終了します。

(2)第2世代の仮想サーバにはVHDXファイルだけ接続できます。VHDファイルを第2世代の仮想サーバに接続する場合，異常終了します。

バージョン

02.00.00

部品のタグ

Modify VM,Hyper-V 2012

タスクログに表示される部品の名称

hyperv2012AttachVDisk

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.attachVHardDiskFilePath

接続する仮想ディスクファイルのパス

指定した仮想サーバと接続する仮想ディスクファイルのパスをフルパスで指定します。

−　

入力

○　

hyperv.scsiControllerNumber

SCSIコントローラーの番号

仮想ディスクを追加する仮想サーバのSCSIコントローラーの番号を指定します。SCSIコントローラーの番号は，仮想サーバにSCSIコントローラーを追加した(Hyper-V マネージャーで表示する)順番を0から相対する整数値で指定してください。

−　

入力

△　

hyperv.scsiLocationNumber

SCSIコントローラーの場所番号

仮想ディスクを追加する仮想サーバのSCSIコントローラーの場所番号を指定します。SCSIコントローラーの場所番号は，仮想サーバに追加したSCSIコントローラーの未使用の場所を整数値で指定してください。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

hyperv.attachScsiControllerNumber

接続済みSCSIコントローラーの番号

仮想ディスクファイルを接続したSCSIコントローラーの番号を格納します。

−　

出力

−　

hyperv.attachScsiLocationNumber

接続済みSCSIコントローラーの場所番号

仮想ディスクファイルを接続したSCSIコントローラーの場所番号を格納します。

−　

出力

−　

5.6　Hyper-V 2016関連の部品

5.6.1　応答ファイルの作成

機能

この部品は，Hyper-V環境の仮想サーバ(Windows)に対してOSの初期設定，およびIPアドレス設定を行うための応答ファイルを作成します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-VがインストールされているWindowsサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

設定できるIPアドレスは1個だけで，仮想サーバがNICを2個以上持つ場合は，1個目のNICにIPの設定を行い，2個目以降のNICはすべて無効になります。

NICには，IPアドレス(管理用)>IPアドレス(2個目用)>IPアドレス(3個目用)>IPアドレス(4個目用)の順で最初に指定されていたIPアドレスを設定します。その他のIPアドレスは破棄されますのでご注意ください。

指定可能なタイムゾーンは次のとおりです。

　Tokyo Standard Time

　China Standard Time

　GMT Standard Time

　Pacific Standard Time

　Eastern Standard Time

　US Eastern Standard Time

　Central Standard Time

　Central America Standard Time

　US Mountain Standard Time

　Mountain Standard Time

　Alaskan Standard Time

　Hawaiian Standard Time

　Singapore Standard Time

　India Standard Time

指定がない場合，エクスポート済みの仮想サーバに設定されているタイムゾーンが引き継がれます。

指定可能なロケールは次のとおりです。

　ja-JP

　en-US

　zh-CN

指定可能なOS名は次のとおりです。

　Windows Server 2012

　Windows Server 2012 R2

　Windows Server 2016

利用場面

この部品は，Hyper-V環境の仮想サーバ(Windows)に対してOSの初期設定，およびIPアドレス設定を行うための応答ファイルを作成する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2016 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

注意事項

(1)作成する仮想サーバがWindowsの場合，組織名と所有者名は必須となります。組織名の指定がない場合は，"Organization"が設定されます。所有者名の指定がない場合は，"Owner"が設定されます。

(2)作成する仮想サーバがWindowsの場合，OSユーザーパスワードとOSユーザーパスワード再入力は必須となります。どちらかの指定がない場合，"Password123"がパスワードに設定されます。また，2つの値が合致しない場合も"Password123"がパスワードに設定されます。

(3)作成する仮想サーバがWindowsの場合，OS.selectWorkgroupDomainの選択リストで，WORKGROUPかDOMAINの指定が必須となります。どちらの指定もない場合，ワークグループとして"WORKGROUP"が設定されます。また，ワークグループ名/ドメイン名の入力がない場合も，ワークグループとして"WORKGROUP"が設定されます。

(4)作成する仮想サーバがWindowsの場合，OS.selectWorkgroupDomainの選択リストで，WORKGROUPを選択したとき，指定できるワークグループ名は最大15文字までとなります。15文字を超えると"WORKGROUP"が設定されます。

(5)作成する仮想サーバがWindowsの場合，OS.selectWorkgroupDomainの選択リストで，DOMAINを選択したとき，ドメイン名，ドメイン ユーザー名，ドメイン パスワードが必須となります。どれかの指定がない場合，または値が誤っている場合，ワークグループとして"WORKGROUP"が設定されます。

(6)IPアドレス，サブネットマスクは，2つの情報をすべて指定してください。どれかの指定がない場合，IPアドレス，サブネットマスク，およびデフォルトゲートウェイの設定は行われません。

バージョン

02.12.00

部品のタグ

Modify VM,Hyper-V 2016

タスクログに表示される部品の名称

hyperv2016CreateAnsFile

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.ansFileStoreFolderPath

応答ファイルの格納フォルダパス

応答ファイルを格納するフォルダパスをフルパスで指定します。

−　

入力

○　

common.computerName

コンピュータ名/ホスト名

OSのコンピュータ名（ホスト名）を指定します。

−　

入力

○　

Windows.orgName

組織名（会社名）

仮想サーバのOSに設定する組織名を指定します。

−　

入力

○　

Windows.ownerName

名前（所有者名）

仮想サーバのOSに設定する名前（所有者名）を指定します。

−　

入力

○　

OS.ipAddressMan

IPアドレス(VM1個目用)

仮想サーバに設定する1個目のIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.subnetMaskMan

サブネットマスク(VM1個目用)

仮想サーバに設定する1個目のサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.defaultGWMan

デフォルトゲートウェイ(VM1個目用)

仮想サーバに設定する1個目のデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.dnsMan

DNSサーバのIPアドレス(VM1個目用)

仮想サーバに設定する1個目のDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.ipAddress2

IPアドレス(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.subnetMask2

サブネットマスク(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.defaultGW2

デフォルトゲートウェイ(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.dns2

DNSサーバのIPアドレス(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.ipAddress3

IPアドレス(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.subnetMask3

サブネットマスク(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.defaultGW3

デフォルトゲートウェイ(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.dns3

DNSサーバのIPアドレス(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.ipAddress4

IPアドレス(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.subnetMask4

サブネットマスク(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.defaultGW4

デフォルトゲートウェイ(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.dns4

DNSサーバのIPアドレス(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.workgroupNameDomainName

ワークグループ名/ドメイン名

仮想サーバが所属するワークグループ名/ドメイン名を指定します。ワークグループ名は，最大15文字まで指定します。ドメイン名は，最大63文字まで指定します。

−　

入力

○　

OS.domainUserName

ドメインのユーザー名

仮想サーバが所属するドメインのユーザー名を指定します。ワークグループ/ドメインの選択で"DOMAIN"を選択した場合，入力する必要があります。

−　

入力

△　

OS.domainUserPassword

ドメインのパスワード

仮想サーバが所属するドメインのパスワードを指定します。ワークグループ/ドメインの選択で"DOMAIN"を選択した場合，入力する必要があります。

−　

入力

△　

OS.selectWorkgroupDomain

ワークグループ/ドメインの選択

仮想サーバがワークグループまたはドメインのどちらに所属するかを指定します。

−　

入力

○　

common.osUserPassword

Administratorのパスワード

OSに設定するAdministratorのパスワードを指定します。入力がない場合は，"Password123"が設定されます。

−　

入力

△　

common.osUserPasswordReEnter

Administratorのパスワード再入力

OSに設定するAdministratorのパスワードを再入力してください。入力がない場合は，"Password123"が設定されます。

−　

入力

△　

OS.productKey

Windowsのプロダクトキー

Windowsのプロダクトキーを指定します。入力の形式は「XXXXX-XXXXX-XXXXX-XXXXX-XXXXX」です。

−　

入力

△　

OS.operatingSystem

OS名

仮想サーバのOS名を指定します。

−　

入力

○　

OS.timeZone

タイムゾーン

仮想サーバのOSに設定するタイムゾーンを指定します。

−　

入力

△　

OS.systemLocale

システムロケール

仮想サーバのOSに設定されているシステムロケールを指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

common.flag2IPsSetup

仮想サーバに2つのIPアドレスを設定したかどうか

仮想サーバに2つIPアドレスを設定したとき（TRUE），それ以外のとき（FALSE）を格納するプロパティです。

−　

出力

−　

common.flagJoinDomain

ドメイン参加処理の要否

ドメインに参加するとき(TRUE)，ドメインに参加しないとき（FALSE）を格納します。

−　

出力

−　

OS.mngIpaddr

IPアドレス(管理用)

IPアドレス(管理用)を格納します。

−　

出力

−　

5.6.2　仮想サーバのCPU設定変更

機能

この部品は，Hyper-V環境における仮想サーバのCPUの設定を変更します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

この部品が変更できるCPUの設定は次の通りです。

・仮想プロセッサの数

・仮想プロセッサリソースの予約

・仮想プロセッサリソースの限度

・仮想プロセッサリソースの相対的な重み

・プロセッサの互換性

・NUMAノードで使用できるプロセッサの最大数

・ソケットで使用できるNUMAノードの最大数

利用場面

この部品は，仮想サーバのCPU設定を変更する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2016 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

注意事項

(1)仮想サーバの状態によって変更できるCPUの設定項目は異なります。

(2)CPUの設定項目がすべて未入力の場合，エラーとなります。

バージョン

02.12.00

部品のタグ

Modify VM,Hyper-V 2016

タスクログに表示される部品の名称

hyperv2016ChangeVMCPU

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.cpuCount

仮想プロセッサの数

仮想サーバに設定する仮想プロセッサの数を指定します。

−　

入力

△　

hyperv.cpuReserve

仮想プロセッサリソースの予約

仮想サーバが予約する仮想サーバ間の仮想プロセッサリソースの配分を指定します。

−　

入力

△　

hyperv.cpuMaximum

仮想プロセッサリソースの限度

仮想サーバが使用する仮想サーバ間の仮想プロセッサリソースの配分の上限値を指定します。

−　

入力

△　

hyperv.cpuRelativeWeight

仮想プロセッサリソースの相対的な重み

仮想サーバ間における仮想プロセッサリソースの相対的な重みを指定します。

−　

入力

△　

hyperv.cpuCompatibilityForMigrationEnabled

プロセッサの互換性

プロセッサの互換性を有効にする場合は「true」，無効にする場合は「false」を指定してください。未入力の場合はプロセッサの互換性の設定を変更しません。

−　

入力

△　

hyperv.cpuMaximumCountPerNumaNode

NUMAノードで使用できるプロセッサの最大数

1つの仮想NUMA(Non-Uniform Memory Architecture)ノードで使用できるプロセッサの最大数を指定します。

−　

入力

△　

hyperv.nodeMaximumCountPerNumaSocket

ソケットで使用できるNUMAノードの最大数

1つのソケットで使用できる仮想NUMA(Non-Uniform Memory Architecture)ノードの最大数を指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

5.6.3　仮想サーバのIPアドレス取得

機能

この部品は，Hyper-V環境における仮想サーバのすべてのNICに設定されたIPアドレス(IPv4)を取得します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

取得したIPアドレスは，hyperv.vmIPaddressプロパティに格納されます。仮想サーバに複数のIPアドレスが設定されている場合には，コンマ区切りで出力します。

ただし，IPアドレスの長さの合計が1024文字を超える場合，1025文字目以降を含むIPアドレスは切り捨てられます。すべてのNICでIPv4のIPアドレスが65個以上設定されていると，1024文字を超える場合があります。

利用場面

仮想サーバに設定されているIPアドレス(IPv4)の確認や，仮想サーバに対してICMPエコー要求を発行する場合に使用できます。

ICMPエコー要求を発行する処理は，この部品で仮想サーバのIPアドレスを取得し，osSendIcmp部品の入力として使用するという流れになります。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2016 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。

　・データ交換

(3)仮想サーバが起動していること。

バージョン

02.12.00

部品のタグ

Gather VM information,Hyper-V 2016

タスクログに表示される部品の名称

hyperv2016GetVMIPaddress

戻り値

戻り値

説明

0

正常

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.vmIPaddress

仮想サーバのIPアドレス

仮想サーバのIPアドレスが格納されます。仮想サーバに複数のIPアドレスが設定されている場合には，コンマ区切りで出力されます。

−　

出力

−　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

5.6.4　仮想サーバのシャットダウン

機能

この部品は，Hyper-V環境における仮想サーバのOSに対して強制的にシャットダウンを実行します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

利用場面

仮想サーバのOSをシャットダウンする場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2016 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。

　・オペレーティングシステムのシャットダウン

(3)仮想サーバが起動完了していること。

注意事項

(1)この部品は指定した仮想サーバのOSを強制的にシャットダウンします。この部品を使用した場合，仮想サーバで編集中のファイルデータは保存されません。

バージョン

02.12.00

部品のタグ

Control VM,Hyper-V 2016

タスクログに表示される部品の名称

hyperv2016ShutdownVM

戻り値

戻り値

説明

0

正常

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

28

異常(仮想サーバの不正な状態変更) 仮想サーバの不正な状態変更

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.vmState

仮想サーバの状態

仮想サーバの状態が格納されます。

−　

出力

−　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

5.6.5　仮想サーバのメモリ設定変更

機能

この部品は，Hyper-V環境における仮想サーバのメモリの設定を変更します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

この部品が変更できるメモリの設定は次の通りです。

・スタートアップRAM (MB)

・動的メモリの有効

・動的メモリの最小RAM (MB)

・動的メモリの最大RAM (MB)

・動的メモリのメモリバッファー

・メモリの重み

・NUMAノードで使用できるメモリの最大容量 (MB)

利用場面

この部品は，仮想サーバのメモリ設定を変更する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2016 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

注意事項

(1)仮想サーバの状態によって変更できるメモリの設定項目は異なります。

(2)メモリの設定項目がすべて未入力の場合，エラーとなります。

バージョン

02.12.00

部品のタグ

Modify VM,Hyper-V 2016

タスクログに表示される部品の名称

hyperv2016ChangeVMMemory

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.memoryStartupMegaBytes

スタートアップRAM (MB)

仮想サーバの起動時に使用するメモリの量をMB単位で指定します。

−　

入力

△　

hyperv.dynamicMemoryEnabled

動的メモリの有効

仮想サーバの動的メモリを有効にする場合は「true」，無効にする場合は「false」を指定してください。未入力の場合は動的メモリの有効の設定を変更しません。

−　

入力

△　

hyperv.dynamicMemoryMinimumMegaBytes

動的メモリの最小RAM (MB)

動的メモリにおける最小メモリ量をMB単位で指定します。動的メモリが有効な場合だけ指定してください。

−　

入力

△　

hyperv.dynamicMemoryMaximumMegaBytes

動的メモリの最大RAM (MB)

動的メモリにおける最大メモリ量をMB単位で指定します。動的メモリが有効な場合だけ指定してください。

−　

入力

△　

hyperv.dynamicMemoryBuffer

動的メモリのメモリバッファー

Hyper-Vでバッファーとして予約しておくべきメモリの割合を指定してください。動的メモリが有効な場合だけ指定してください。

−　

入力

△　

hyperv.memoryPriority

メモリの重み

仮想マシン間における使用可能なメモリを割り当てるときの優先度を指定します。

−　

入力

△　

hyperv.memoryMaximumAmountMegaBytesPerNumaNode

NUMAノードで使用できるメモリの最大容量 (MB)

1つの仮想NUMA(Non-Uniform Memory Architecture)ノードで使用できるメモリの最大容量をMB単位で指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

5.6.6　仮想サーバの仮想スイッチ設定

機能

この部品は，Hyper-V環境の仮想サーバに仮想スイッチを設定します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-VがインストールされているWindowsサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

仮想サーバに設定されているNICの中から，指定されたMACアドレスのNICに対し，仮想スイッチを設定します。

NICにすでに設定されている仮想スイッチは，指定された仮想スイッチに上書きされます。

仮想スイッチの指定がない場合，仮想スイッチとの接続が切断された状態になります。

MACアドレスに不正な値が指定された場合や指定がない場合，Hyper-Vの認識するNICの順番に従い，仮想スイッチを設定します。

仮想スイッチは最大4個まで設定することができます。指定した仮想スイッチの数が，仮想サーバが持つNICの数より多い場合，NICに割り当てられなかった仮想スイッチの設定は無効になりますのでご注意ください。

利用場面

この部品は，Hyper-V環境の仮想サーバに仮想スイッチを設定する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2016 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)仮想スイッチ名はHyper-Vサーバ内で一意であること。

(3)仮想サーバにレガシーネットワークアダプターが設定されていないこと。

バージョン

02.12.00

部品のタグ

Modify VM,Hyper-V 2016

タスクログに表示される部品の名称

hyperv2016SetVirtualSwitch

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.virtualSwitch1

仮想スイッチ名(1個目用)

仮想サーバに設定されているNIC(1個目用)に設定する仮想スイッチ名(1個目用)を指定します。

−　

入力

△　

OS.nic1MacAddress

NICのMACアドレス(1個目用)

仮想スイッチ名(1個目用)を設定するNICのMACアドレスを指定します。

−　

入力

△　

hyperv.virtualSwitch2

仮想スイッチ名(2個目用)

仮想サーバに設定されているNIC(2個目用)に設定する仮想スイッチ名(2個目用)を指定します。

−　

入力

△　

OS.nic2MacAddress

NICのMACアドレス(2個目用)

仮想スイッチ名(2個目用)を設定するNICのMACアドレスを指定します。

−　

入力

△　

hyperv.virtualSwitch3

仮想スイッチ名(3個目用)

仮想サーバに設定されているNIC(3個目用)に設定する仮想スイッチ名(3個目用)を指定します。

−　

入力

△　

OS.nic3MacAddress

NICのMACアドレス(3個目用)

仮想スイッチ名(3個目用)を設定するNICのMACアドレスを指定します。

−　

入力

△　

hyperv.virtualSwitch4

仮想スイッチ名(4個目用)

仮想サーバに設定されているNIC(4個目用)に設定する仮想スイッチ名(4個目用)を指定します。

−　

入力

△　

OS.nic4MacAddress

NICのMACアドレス(4個目用)

仮想スイッチ名(4個目用)を設定するNICのMACアドレスを指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

5.6.7　仮想サーバの起動

機能

この部品は，Hyper-V環境における仮想サーバを起動します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

利用場面

仮想サーバを起動する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2016 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)対象の仮想サーバにおけるHyper-V 統合サービスの次のサービスが有効なこと。

　・データ交換

(3)仮想サーバが停止完了していること。

バージョン

02.12.00

部品のタグ

Control VM,Hyper-V 2016

タスクログに表示される部品の名称

hyperv2016PowerOnVM

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

29

異常(仮想サーバの状態確認のタイムアウト) 仮想サーバの状態確認のタイムアウト

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.checkVmStateEnabledCount

仮想サーバの状態(起動完了)の確認回数

仮想サーバの起動が完了したか確認する際の確認回数を指定します。仮想サーバの状態(起動完了)の確認間隔と組み合わせて最大待ち時間となります。

1440

入力

○　

hyperv.checkVmStateEnabledInterval

仮想サーバの状態(起動完了)の確認間隔

仮想サーバの起動が完了したか確認する際の確認間隔を秒単位で指定します。

5

入力

○　

hyperv.vmState

仮想サーバの状態

仮想サーバの状態が格納されます。

−　

出力

−　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

5.6.8　仮想サーバの作成

機能

この部品は，Hyper-V環境において，エクスポート済みの仮想サーバを複製して，仮想サーバを作成します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-VがインストールされているWindowsサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

・エクスポート済みの仮想サーバ

　Hyper-Vからエクスポートされた仮想サーバ，およびその仮想サーバの構成ファイル一式です。

・格納サーバ

　複製元となる，エクスポート済みの仮想サーバを格納してあるサーバです。

インポート先に，エクスポート済みの仮想サーバを複製します。

Hyper-Vサーバに，インポート機能を用いて仮想サーバを作成します。

新規に作成する仮想サーバには，新しい一意なIDを作成します。

インポート先に指定したパスのフォルダが既に存在する場合，そのフォルダを使用します。

利用場面

この部品は，Hyper-V環境で新規仮想サーバを作成する場合に使用できます。次の部品とあわせて実行することで，仮想サーバのOS初期設定およびIPアドレスの設定を実施できます。

・hyperv2016CreateAnsFile

・hyperv2016MountVhd

・hyperv2016UnmountVhd

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2016 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)格納サーバとHyper-Vサーバが別サーバの場合，Hyper-Vサーバからエクスポート済みの仮想サーバが格納されているフォルダに共有設定がされていること。

(3)エクスポート済みの仮想サーバにスナップショット，および差分ディスクが作成されていないこと。

(4)エクスポート済みの仮想サーバのNICが仮想スイッチとの接続が切断された状態になっていること。

注意事項

(1)インポート先に指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。

(2)インポート先に指定したパスのフォルダ内に仮想ディスクファイルが残っている場合は，タスクが異常終了します。インポート先に指定したパスのフォルダを確認し，仮想ディスクを削除するか，別のパスを指定してください。

(3)この部品は，フェールオーバークラスターマネージャーのサービスとアプリケーションにデプロイした仮想サーバを登録しません。ユーザーの運用に合わせて手動で登録してください。

(4)sysprepでOSのシステム情報を初期化した仮想サーバを対象とした場合，仮想サーバに接続されているドライブのドライブ文字が変更される場合があります。そのため，デプロイした仮想サーバとテンプレートでは，接続されているドライブのドライブ文字が一致しない場合があります。また，ドライブ文字が変更されたドライブにアプリケーションがインストールされていた場合に，アプリケーションが正常に動作しなくなるおそれがあります。

バージョン

02.12.00

部品のタグ

Add VM,Hyper-V 2016

タスクログに表示される部品の名称

hyperv2016CreateVM

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.importFolderPath

インポート先

仮想サーバの格納先フォルダのパスを指定します。

−　

入力

○　

hyperv.userName

格納サーバに接続するためのユーザー名

格納サーバに接続するためのユーザー名を指定します。格納サーバがHyper-Vサーバと別サーバの場合は指定してください。

−　

入力

△　

hyperv.password

格納サーバに接続するためのパスワード

格納サーバに接続するためのパスワードを指定します。格納サーバがHyper-Vサーバと別サーバの場合は指定してください。

−　

入力

△　

hyperv.exportedVmName

エクスポート済みの仮想サーバのフォルダのパス

仮想サーバの複製元となるエクスポート済みの仮想サーバのフォルダ名をフルパスで指定します。格納サーバがHyper-Vサーバと別サーバの場合，UNCを指定してください。

−　

入力

○　

hyperv.scsiDiskLocation

SCSIコントローラーの場所

システムディスクを設定しているSCSIコントローラーの場所を指定します。このプロパティはエクスポート済みの仮想サーバの世代が第2世代の場合だけ有効です。

0

入力

○　

hyperv.returnVhdPath

仮想ディスクファイルパス(1個目用)

この部品で作成した仮想ディスク(1個目)のファイルパスをフルパスで格納します。

−　

出力

−　

hyperv.returnVhdPath2

仮想ディスクファイルパス(2個目用)

この部品で作成した仮想ディスク(2個目)のファイルパスをフルパスで格納します。

−　

出力

−　

hyperv.returnVhdPath3

仮想ディスクファイルパス(3個目用)

この部品で作成した仮想ディスク(3個目)のファイルパスをフルパスで格納します。

−　

出力

−　

hyperv.returnVhdPath4

仮想ディスクファイルパス(4個目用)

この部品で作成した仮想ディスク(4個目)のファイルパスをフルパスで格納します。

−　

出力

−　

hyperv.returnNumOfNic

NIC数

仮想サーバに接続しているNICの数を格納します。

−　

出力

−　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

5.6.9　仮想サーバの削除

機能

この部品は，Hyper-V環境において，仮想サーバを削除します。Hyper-Vサーバから仮想サーバを削除するとき，スナップショットも併せて削除します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

hyperv.vHardDiskDeletePermanentlyプロパティに，"yes"を指定した場合，削除する仮想サーバに割り当てられているすべての仮想ディスクファイル(容量可変/容量固定/差分)を削除します。パススルー(物理)ディスク，フロッピーディスクまたはCD/DVDなどに割り当てられているディスクやファイルは削除しません。仮想ディスク(差分)が割り当てられている場合，仮想ディスク(差分)の親として使用する仮想ディスクは削除しません。

hyperv.vhdListOutputFileNameプロパティを指定した場合，Hyper-Vサーバから削除する仮想サーバに割り当てられている仮想ディスクファイルのパス一覧をCSV形式で出力します。仮想ディスク(差分)が割り当てられている場合，仮想ディスク(差分)の親として使用する仮想ディスクは含まれません。

出力するCSVファイルの項目を次に示します。

項目はコンマ区切りで出力します。

(a) 仮想ディスクファイルの有無 (ヘッダー名：Existence)

　　仮想サーバの削除実行時に割り当てられている仮想ディスクファイルが存在するかどうかを出力します。項目の値を次に示します。

　　　Found：ファイルの存在を確認

　　　NotFound：ファイルが設定されているが，存在を確認できない

(b) ファイルの削除結果 (ヘッダー名：DeleteResult)

　　hyperv.vHardDiskDeletePermanentlyプロパティに，"yes"を指定した場合，仮想ディスクファイルの削除の実行結果を出力します。hyperv.vHardDiskDeletePermanentlyプロパティに，"no"を指定した場合でも"Skipped"を出力します。項目の値を次に示します。

　　　Completed：ファイルの削除が成功

　　　Failed：ファイルの削除が失敗

　　　Skipped：ファイルの削除が未実施

(c) ファイルのパス (ヘッダー名：FilePath)

　　(a)(b)の内容に関わらず，Hyper-Vサーバで設定されている仮想ディスクファイルのパスを出力します。

利用場面

この部品は，仮想サーバの滅却などのタイミングで，仮想サーバを削除する際に利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2016 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)仮想サーバが停止していること。

注意事項

(1)仮想ディスクファイルのパスを仮想サーバの設定情報から参照できなくなるような操作(スナップショット操作など)を行った場合，その仮想ディスクファイルは削除されません。この場合は手動で削除してください。

(2)hyperv.vhdListOutputFileNameプロパティに指定したファイル名がすでに存在する場合，既存のファイルを上書きします。

(3)hyperv.vhdListOutputFileNameプロパティに指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

(4)hyperv.vhdListOutputFileNameプロパティを指定した場合，仮想サーバ，または仮想ディスクファイルの削除時にエラーが発生した場合でも，仮想ディスクファイル一覧を出力します。

(5)この部品は，フェールオーバークラスターマネージャーのサービスとアプリケーションから仮想サーバの登録情報を削除しません。ユーザーの運用に合わせて手動で削除してください。

バージョン

02.12.00

部品のタグ

Modify VM,Hyper-V 2016

タスクログに表示される部品の名称

hyperv2016DeleteVM

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.vHardDiskDeletePermanently

仮想ディスクファイルの削除の要否

仮想サーバで使用している仮想ディスクファイルを削除する場合はyes，削除しない場合はnoを指定します。

no

入力

○　

hyperv.vhdListOutputFileName

仮想ディスクファイル一覧出力ファイル名

仮想ディスクファイル一覧を出力するファイル名をフルパスで指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

5.6.10　仮想サーバの情報一覧取得

機能

この部品は，Hyper-Vサーバの管理下にある仮想サーバの情報一覧をCSV形式でファイルに出力します。

出力ファイルのエンコード形式は，Hyper-Vサーバのシステムのデフォルトエンコーディングです。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

出力するCSVファイルの項目を次に示します。

項目はコンマ区切りで出力します。

(a) Hyper-Vサーバ名 (ヘッダー名：ComputerName)

(b) 仮想サーバ名 (ヘッダー名：VMName)

(c) 仮想サーバの状態 (ヘッダー名：State)

(d) 仮想サーバのCPU使用率(%) (ヘッダー名：CPUUsage)

(e) 仮想サーバのメモリ割り当て(MB)※1 (ヘッダー名：MemoryAssigned)

(f) 仮想サーバの稼働時間 (ヘッダー名：Uptime)

(g) 仮想サーバの状況 (ヘッダー名：Status)

(h) 仮想サーバの仮想プロセッサ数 (ヘッダー名：ProcessorCount)

(i) 仮想サーバのスタートアップRAM(MB) (ヘッダー名：MemoryStartup)

(j) 仮想サーバの動的メモリの有効 (ヘッダー名：DynamicMemoryEnabled)

※1：仮想サーバが実際に使用しているメモリの容量(MB)です。

利用場面

Hyper-Vサーバの管理下にある仮想サーバの情報を取得する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2016 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

なし。

注意事項

(1)指定したファイル名が既に存在する場合，既存のファイルを上書きします。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(2)指定したパスのフォルダが存在しない場合は，そのフォルダを作成します。作成したフォルダは削除せずに残ります。定期的に使用しない場合は削除してください。

(3)同名の仮想サーバが2つ以上ある場合，出力するCSVファイルでは仮想サーバを特定できません。

バージョン

02.12.00

部品のタグ

Gather VM information,Hyper-V 2016

タスクログに表示される部品の名称

hyperv2016OutputVmSpec

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmInfoListOutputFileName

仮想サーバ情報一覧出力ファイル名

仮想サーバ情報一覧を出力するファイル名をフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

5.6.11　仮想サーバの状態取得

機能

この部品は，Hyper-V環境における仮想サーバの状態を取得します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

取得した仮想サーバの状態を表す値(数値)を，hyperv.vmStateプロパティに格納します。格納された値が意味する仮想サーバの状態を確認する場合は，タスクログの｢vmState:｣で始まる行をご覧ください。その場合，タスクのログ出力レベルを標準出力内容が出力されるレベル(30または40)に設定する必要があります。

利用場面

この部品は，仮想サーバの状態を確認し，仮想サーバの起動や停止，削除など，状態に応じた対処を実施する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2016 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

バージョン

02.12.00

部品のタグ

Gather VM information,Hyper-V 2016

タスクログに表示される部品の名称

hyperv2016GetVMState

戻り値

戻り値

説明

0

正常

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.vmState

仮想サーバの状態

仮想サーバの状態が格納されます。

−　

出力

−　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

5.6.12　仮想ディスクのアンマウント

機能

この部品は，Hyper-Vサーバから仮想ディスクをアンマウントします。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-VがインストールされているWindowsサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

利用場面

この部品は，Hyper-Vサーバから仮想ディスクをアンマウントする場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2016 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

バージョン

02.12.00

部品のタグ

Modify VM,Hyper-V 2016

タスクログに表示される部品の名称

hyperv2016UnmountVhd

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vhdPath

仮想ディスクファイルのパス(1個目用)

仮想ディスク(1個目)のファイルパスをフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

5.6.13　仮想ディスクのマウント

機能

この部品は，Hyper-Vサーバに仮想ディスクをマウントします。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-VがインストールされているWindowsサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

利用場面

この部品は，Hyper-Vサーバに仮想ディスクをマウントする場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2016 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

注意事項

(1)仮想サーバの仮想ディスクをHyper-Vサーバへマウントする際に，Hyper-Vサーバ上の空きドライブ文字を一時的に占有します。そのため，Hyper-Vサーバ上に空きドライブ文字が存在しない場合は，この部品はエラー終了します。マウントを行う仮想ディスクが使用するドライブ分，Hyper-Vサーバ上にドライブ文字が空いていることを確認の上，この部品を実行してください。

バージョン

02.12.00

部品のタグ

Modify VM,Hyper-V 2016

タスクログに表示される部品の名称

hyperv2016MountVhd

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.vhdPath

仮想ディスクファイルのパス(1個目用)

仮想ディスク(1個目)のファイルパスをフルパスで指定します。

−　

入力

○　

hyperv.vhdPath2

仮想ディスクファイルのパス(2個目用)

仮想ディスク(2個目)のファイルパスをフルパスで指定します。

−　

入力

△　

hyperv.vhdPath3

仮想ディスクファイルのパス(3個目用)

仮想ディスク(3個目)のファイルパスをフルパスで指定します。

−　

入力

△　

hyperv.vhdPath4

仮想ディスクファイルのパス(4個目用)

仮想ディスク(4個目)のファイルパスをフルパスで指定します。

−　

入力

△　

hyperv.checkJobStateCountGetDriveList

ジョブ監視回数(Win32_LogicalDiskメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視回数(Win32_LogicalDiskメソッド)調整用のプロパティです。変更の必要はありません。

1440

入力

○　

hyperv.checkJobStateIntervalGetDriveList

ジョブ監視間隔(Win32_LogicalDiskメソッド)

Hyper-Vに要求した処理を監視する，ジョブ監視間隔(Win32_LogicalDiskメソッド)調整用のプロパティです。変更の必要はありません。

5

入力

○　

hyperv.returnDriveLetter

ドライブレター

この部品でマウントした，仮想ディスクに割り当てられたドライブレターを格納します。

−　

出力

−　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

hyperv.returnVhdPath

仮想ディスクファイルパス

仮想ディスクのファイルパスをフルパスで格納します。

−　

出力

−　

5.6.14　仮想ディスクの作成

機能

この部品は，Hyper-V環境において，仮想ディスクファイルを新規に作成します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

作成できる仮想ディスクは「Dynamic:容量可変」または「Fixed:容量固定」です。仮想ディスク(差分)およびパススルー(物理)ディスクは作成できません。

hyperv.vHardDiskFolderPathプロパティを指定した場合に，指定したフォルダパスに仮想ディスクファイルを新規に作成します。指定が無い場合は，Hyper-Vサーバに設定されている仮想ディスクを保存する既定のフォルダに仮想ディスクファイルを保存します。

作成する仮想ディスクファイルを保存するフォルダパスが存在しない場合はフォルダを作成します。

利用場面

この部品は，仮想サーバの新規構築時やディスク増設時など，仮想サーバにデータディスクを追加する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2016 Hyper-V

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

なし。

注意事項

(1)作成した仮想ディスクの初期化は行いません。必要に応じて，ディスクの初期化を実行してください。

バージョン

02.12.00

部品のタグ

Modify VM,Hyper-V 2016

タスクログに表示される部品の名称

hyperv2016CreateVDisk

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vHardDiskName

仮想ディスクファイル名

作成する仮想ディスクのファイル名を指定してください。ファイルの拡張子には「vhd」または「vhdx」を指定してください。

−　

入力

○　

hyperv.vHardDiskFolderPath

仮想ディスク保存フォルダパス

作成する仮想ディスクを保存するフォルダのフルパスを指定してください。指定を省略した場合は，Hyper-Vサーバに設定されている仮想ディスクを保存する既定のフォルダに仮想ディスクを保存します。

−　

入力

△　

hyperv.vHardDiskType

仮想ディスクのタイプ

仮想ディスクのタイプを指定します。次のどちらかを指定します。Dynamic:容量可変の仮想ディスクを作成します。Fixed:容量固定の仮想ディスクを作成します。

−　

入力

○　

hyperv.vHardDiskCapacityGB

仮想ディスクの容量 (GB)

作成する仮想ディスクの容量(単位:GB)を指定します。仮想ディスクの容量は整数値で指定してください。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

hyperv.returnVhdPath

仮想ディスクファイルパス

この部品で作成した仮想ディスクのファイルパスをフルパスで格納します。

−　

出力

−　

5.6.15　仮想ディスクの接続

機能

この部品は，Hyper-V環境において，仮想サーバに仮想ディスクを接続します。

この部品が前提とするサーバを次に示します。

・Hyper-Vサーバ(実行対象サーバ)

　Hyper-Vがインストールされているサーバです。

・仮想サーバ

　Hyper-Vによって管理されている仮想サーバです。

仮想ディスクは，SCSIコントローラーに追加できますが，IDEコントローラーには追加できません。

SCSIコントローラーの番号(hyperv.scsiControllerNumberプロパティ)とSCSIコントローラーの場所番号(hyperv.scsiLocationNumberプロパティ)の指定の有無により，SCSIコントローラーへの仮想ディスクの接続方法が異なります。

・SCSIコントローラーの番号とSCSIコントローラーの場所番号が両方指定されていない場合

　接続可能なSCSIコントローラーにHyper-Vサーバが自動的に仮想ディスクを接続します。

・SCSIコントローラーの番号だけ指定されている場合

　指定したSCSIコントローラーの番号で接続可能なSCSIコントローラーの場所番号(0〜63)のどれかにHyper-Vサーバが自動的に仮想ディスクを接続します。

・SCSIコントローラーの場所番号だけ指定されている場合

　指定したSCSIコントローラーの場所番号で接続可能なSCSIコントローラーの番号(0〜3)のどれかにHyper-Vサーバが自動的に仮想ディスクを接続します。

・SCSIコントローラーの番号とSCSIコントローラーの場所番号が両方指定されている場合

　指定したSCSIコントローラーの番号とSCSIコントローラーの場所番号に仮想ディスクを接続します。

利用場面

この部品は，仮想サーバの新規構築時やディスク増設時など，仮想サーバにデータディスクを追加する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)Hyper-Vサーバの前提製品

　・Windows Server 2016 Hyper-V

(2)仮想サーバの前提OS

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2016 Standard/Datacenter

　　ただし，Server Core/Nano Serverインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

(1)仮想サーバ名はHyper-Vサーバ内で一意であること。

(2)仮想サーバに接続可能なSCSIコントローラーが存在すること。

注意事項

(1)指定したSCSIコントローラーの番号とSCSIコントローラーの場所番号が既に他の仮想ディスクの接続先として使用されている場合は異常終了します。

(2)第2世代の仮想サーバにはVHDXファイルだけ接続できます。VHDファイルを第2世代の仮想サーバに接続する場合，異常終了します。

バージョン

02.12.00

部品のタグ

Modify VM,Hyper-V 2016

タスクログに表示される部品の名称

hyperv2016AttachVDisk

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

hyperv.vmName

仮想サーバ名

仮想サーバの名称を指定します(Hyper-Vにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

hyperv.attachVHardDiskFilePath

接続する仮想ディスクファイルのパス

指定した仮想サーバと接続する仮想ディスクファイルのパスをフルパスで指定します。

−　

入力

○　

hyperv.scsiControllerNumber

SCSIコントローラーの番号

仮想ディスクを追加する仮想サーバのSCSIコントローラーの番号を指定します。SCSIコントローラーの番号は，仮想サーバにSCSIコントローラーを追加した(Hyper-V マネージャーで表示する)順番を0から相対する整数値で指定してください。

−　

入力

△　

hyperv.scsiLocationNumber

SCSIコントローラーの場所番号

仮想ディスクを追加する仮想サーバのSCSIコントローラーの場所番号を指定します。SCSIコントローラーの場所番号は，仮想サーバに追加したSCSIコントローラーの未使用の場所を整数値で指定してください。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

hyperv.attachScsiControllerNumber

接続済みSCSIコントローラーの番号

仮想ディスクファイルを接続したSCSIコントローラーの番号を格納します。

−　

出力

−　

hyperv.attachScsiLocationNumber

接続済みSCSIコントローラーの場所番号

仮想ディスクファイルを接続したSCSIコントローラーの場所番号を格納します。

−　

出力

−　

5.7　Linux関連の部品

5.7.1　OS初期設定(Linux)

機能

仮想サーバ(Linux)のOSに対して，ホスト名，タイムゾーン，DNSサフィックスを設定します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　部品を実行し，OS初期情報を設定する仮想サーバです。

指定可能なタイムゾーンは次のとおりです。

　　America/Adak

　　America/Anchorage

　　America/Boise

　　America/Chicago

　　America/Denver

　　America/Detroit

　　America/Indiana/Indianapolis

　　America/Indiana/Knox

　　America/Indiana/Marengo

　　America/Indiana/Petersburg

　　America/Indiana/Tell_City

　　America/Indiana/Vevay

　　America/Indiana/Vincennes

　　America/Indiana/Winamac

　　America/Juneau

　　America/Kentucky/Monticello

　　America/Los_Angeles

　　America/LouisVille

　　America/Menominee

　　America/Monterrey

　　America/Montevideo

　　America/New_York

　　America/Nome

　　America/North_Dakota/Beulah

　　America/North_Dakota/Center

　　America/North_Dakota/New_Salem

　　America/Phoenix

　　America/Shiprock

　　America/Tijuana

　　America/Vancouver

　　America/Yakutat

　　Asia/Chongqing

　　Asia/Hong_Kong

　　Asia/Kolkata

　　Asia/Macau

　　Asia/Shanghai

　　Asia/Singapore

　　Asia/Tokyo

　　Etc/UTC

　　Europe/London

　　Pacific/Honolulu

指定がない場合，既に設定されているタイムゾーンを引き継ぎます。

利用場面

この部品は，OSに対して，ホスト名，タイムゾーン，DNSサフィックスを設定する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品の稼働OS】

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

【実行対象サーバ内前提製品の使用条件】

なし。

注意事項

(1)実行対象サーバのOSがRed Hat Enterprise Linux 5の場合は，タイムゾーンにAmerica/North_Dakota/Beulahを設定できない場合があります。実行対象サーバのOSでAmerica/North_Dakota/Beulahが設定可能か事前に確認してください。

バージョン

02.00.00

部品のタグ

Configure OS,Linux

タスクログに表示される部品の名称

osSetLinuxInfo

戻り値

戻り値

説明

0

正常

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.computerName

ホスト名

OSのホスト名を指定します。

−　

入力

○　

OS.timeZone

タイムゾーン

仮想サーバのOSに設定するタイムゾーンを指定します。

−　

入力

△　

OS.dnsSuffix

DNS サフィックス名

DNSサフィックス名を指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.8　OpenStack関連の部品

5.8.1　ボリュームのバックアップ

機能

OpenStack管理下のボリュームのバックアップを取得します。

このドキュメント内で使用しているOpenStackに関する用語は，OpenStackのDashboardで使用されている表示名です。OpenStackに関する用語を次に示します。

・Identity

　IdentityまたはKeyStoneと記載されています。

・プロジェクト

　プロジェクトまたはテナントと記載されています。

・ボリューム

　ボリュームまたはブロックストレージと記載されています。

この部品が前提とするサーバを次に示します。

・OpenStackサーバ

　OpenStackがインストールされているサーバです。

・KVMサーバ

　Kernel-based Virtual Machineがインストールされているサーバです。

・OpenStack操作サーバ

　OpenStackサーバにREST-APIを実行するサーバです。

・インスタンス

　OpenStackサーバおよびKVMによって管理されているインスタンスです。一般的な仮想サーバのことです。

(1)次の条件のどれか，または両方を満たすCinderによって管理されているボリュームをバックアップ対象とします。

　①openstack.volumeNamesプロパティに指定されたボリューム

　②openstack.volumeIdsプロパティに指定されたボリューム

(2)バックアップの情報をCSV形式で指定されたリモートのファイルに出力します。出力ファイルのエンコード形式は，OpenStack操作サーバのデフォルトエンコーディングです。

　・バックアップの情報はopenstack.backupOutputFilePathプロパティに指定されたCSVファイルに追記します。

　・openstack.backupOutputFilePathプロパティに指定したファイルが存在しない場合は新規にファイルを作成します。

　・openstack.backupOutputFilePathプロパティを省略した場合，バックアップ情報は出力されません。

　・バックアップ対象のボリュームが別のボリュームを元に作成されている場合に，openstack.flagTempVolプロパティにtrueを指定すると，バックアップの情報に出力するボリュームの情報(ボリュームID，ボリューム名)に，作成元のボリュームの情報を出力します。

(3)出力するCSVファイルの項目を次に示します。

　項目はコンマ区切りで出力します。

　(a) バックアップ取得日時 (ヘッダー名：Backup time)(出力形式：yyyy/MM/dd HH:mm:ss)

　(b) プロジェクト名 (ヘッダー名：Project name)

　(c) インスタンス名 (ヘッダー名：Instance name)

　(d) ボリュームID (ヘッダー名：Volume ID)

　(e) ボリューム名 (ヘッダー名：Volume name)

　(f) バックアップID (ヘッダー名：Backup ID)

利用場面

この部品は，ボリューム作成のあと，システム保全のためにバックアップを取得する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)OpenStackサーバの前提製品

　・OpenStack

(2)インスタンスを管理する仮想化環境

　・Kernel-based Virtual Machine

　・VMware vCenter Server

　・VMware vSphere ESXi

(3)OpenStack操作サーバ

　・Microsoft .Net Framework 3.5以降

(4)インスタンスの前提OS

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter

　・Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象システム内前提製品の使用条件】

(1)Openstackサーバに関する条件

　・cinder-backupが起動していること。

(2)ボリュームに関する条件

　・同一プロジェクト内でボリューム名が重複しないこと。

(3)コンテナーに関する条件

　・同一プロジェクト内でコンテナー名が重複しないこと。

注意事項

(1)ボリューム名，ボリュームIDはどちらかもしくは両方を指定してください。どちらの指定も無い場合，この部品はエラー終了します。

(2)格納先コンテナーには，バックアップ元ボリュームと同じ容量またはそれ以上の空き容量を確保してください。格納先コンテナーに十分な空き容量が無い場合，この部品はエラー終了します。

(3)バックアップ元ボリュームの状態や種別によっては，バックアップの取得ができずタスクがエラー終了します。事前に，バックアップ元ボリュームの状態や種別，および使用しているCinderドライバのマニュアルを確認してください。

(4)複数ボリュームのバックアップを取得した場合に，いくつかのバックアップの状態がErrorになりKNAE06389-Eのメッセージを出力して，この部品がエラー終了する場合があります。OpenStackサーバの設定を確認しジョブエラー時の回復方法を確認したのち，この部品を再実行してください。同じエラーが何度も発生する場合，資料採取ツールで資料を採取し，システム管理者に連絡してください。

実行権限

(1)OpenStackサーバにログインするユーザーに次の権限が必要です。

admin権限

バージョン

02.00.00

部品のタグ

Control VM,OpenStack

タスクログに表示される部品の名称

openstackBackupVolume

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

openstack.identityServerHostName

Identityサーバのホスト名

Identityサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

openstack.userName

Identityサーバにログインするためのユーザー名

Identityサーバにログインするためのユーザー名を指定します。

−　

入力

○　

openstack.password

Identityサーバにログインするためのパスワード

Identityサーバにログインするためのパスワードを指定します。

−　

入力

○　

openstack.protocol

Identityサーバ接続用プロトコル

Identityサーバに接続するためのプロトコルを指定します。

−　

入力

○　

openstack.portNumber

Identityサーバ接続用ポート番号

Identityサーバに接続するためのポート番号を指定します。

−　

入力

○　

openstack.projectName

プロジェクト名

プロジェクトの名称を指定します。

−　

入力

○　

openstack.containerName

格納先コンテナー名

バックアップ格納先のコンテナーの名称を指定します。

−　

入力

○　

openstack.volumeNames

ボリューム名

ボリュームの名称を指定します。複数のボリュームを指定する場合は，","区切りで指定してください。

−　

入力

△　

openstack.volumeIds

ボリュームID

ボリュームのIDを指定します。複数のボリュームを指定する場合は，","区切りで指定してください。

−　

入力

△　

openstack.backupOutputFilePath

バックアップ情報出力ファイルパス(リモート)

OpenStack操作サーバへバックアップ情報出力ファイルを出力するファイルパスをフルパスで指定します。

−　

入力

△　

openstack.flagTempVol

バックアップ対象のボリュームが一時ボリュームかどうか

バックアップ対象のボリュームが一時ボリュームのとき(true)，一時ボリュームでないとき(false)を指定します。

false

入力

○　

openstack.checkVolumeBackupStateCount

ボリュームのバックアップ完了の確認回数

ボリュームのバックアップ完了を確認する際の，バックアップの確認回数を指定します。ボリュームのバックアップ完了の確認間隔と組み合わせて最大待ち時間となります。

−　

入力

○　

openstack.checkVolumeBackupStateInterval

ボリュームのバックアップ完了の確認間隔

ボリュームのバックアップ完了を確認する際の，バックアップの確認間隔を秒単位で指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.8.2　ボリュームの作成

機能

OpenStack管理下のKVM環境で，ボリュームを作成します。

このドキュメント内で使用しているOpenStackに関する用語は，OpenStackのDashboardで使用されている表示名です。OpenStackに関する用語を次に示します。

・Identity

　IdentityまたはKeyStoneと記載されています。

・プロジェクト

　プロジェクトまたはテナントと記載されています。

・ボリューム

　ボリュームまたはブロックストレージと記載されています。

この部品が前提とするサーバを次に示します。

・OpenStackサーバ

　OpenStackがインストールされているサーバです。

・KVMサーバ

　Kernel-based Virtual Machineがインストールされているサーバです。

・OpenStack操作サーバ

　OpenStackサーバにREST-APIを実行するサーバです。

・インスタンス

　OpenStackサーバおよびKVMによって管理されているインスタンスです。一般的な仮想サーバのことです。

・ボリューム

　Cinderによって管理されているボリュームです。

利用場面

この部品は，インスタンスの新規構築時やディスク増設時など，OpenStack環境でボリュームを作成する際に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)OpenStackサーバの前提製品

　・OpenStack

(2)インスタンスを管理する仮想化環境

　・Kernel-based Virtual Machine

　・VMware vCenter Server

　・VMware vSphere ESXi

(3)OpenStack操作サーバ

　・Microsoft .Net Framework 3.5以降

(4)インスタンスの前提OS

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter

　・Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象システム内前提製品の使用条件】

(1)ボリュームに関する条件

　・同一プロジェクト内でボリューム名が重複しないこと。

(2)ボリューム種別に関する条件

　・ボリューム種別がOpenStack環境に設定済みであること。

注意事項

(1)入力プロパティで指定する文字列の最大長は，OpenStackに登録できる最大長と異なる場合があります。OpenStackに登録できる最大長を超える長さの文字列を指定した場合，OpenStackには登録できる最大長までの文字列が登録されます。

実行権限

(1)OpenStackサーバにログインするユーザーに次の権限が必要です。

admin権限

バージョン

02.00.00

部品のタグ

Add New Storage,OpenStack

タスクログに表示される部品の名称

openstackCreateVolume

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

openstack.identityServerHostName

Identityサーバのホスト名

Identityサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

openstack.userName

Identityサーバにログインするためのユーザー名

Identityサーバにログインするためのユーザー名を指定します。

−　

入力

○　

openstack.password

Identityサーバにログインするためのパスワード

Identityサーバにログインするためのパスワードを指定します。

−　

入力

○　

openstack.protocol

Identityサーバ接続用プロトコル

Identityサーバに接続するためのプロトコルを指定します。

−　

入力

○　

openstack.portNumber

Identityサーバ接続用ポート番号

Identityサーバに接続するためのポート番号を指定します。

−　

入力

○　

openstack.projectName

プロジェクト名

プロジェクトの名称を指定します。

−　

入力

○　

openstack.volumeName

ボリューム名

インスタンスに接続するボリュームの名称を指定します。

−　

入力

○　

openstack.volumeDescription

ボリューム説明

ボリュームの説明を指定します。

−　

入力

△　

openstack.volumeType

ボリューム種別

ボリュームの種別を指定します。OpenStack環境に設定されている種別を指定してください。

−　

入力

△　

openstack.volumeCapacity

ボリューム容量 (GB)

ボリュームの容量(単位:GB)を指定します。

−　

入力

○　

openstack.checkVolumeCreationCount

ボリュームの作成完了の確認回数

ボリュームが作成されたことを確認する際の，確認回数を指定します。ボリュームの作成完了の確認間隔と組み合わせて最大待ち時間となります。

−　

入力

○　

openstack.checkVolumeCreationInterval

ボリュームの作成完了の確認間隔

ボリュームが作成されたことを確認する際の，確認間隔を秒単位で指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.8.3　ボリュームの削除

機能

OpenStack管理下のボリュームを削除します。

このドキュメント内で使用しているOpenStackに関する用語は，OpenStackのDashboardで使用されている表示名です。OpenStackに関する用語を次に示します。

・Identity

　IdentityまたはKeyStoneと記載されています。

・プロジェクト

　プロジェクトまたはテナントと記載されています。

・ボリューム

　ボリュームまたはブロックストレージと記載されています。

この部品が前提とするサーバを次に示します。

・OpenStackサーバ

　OpenStackがインストールされているサーバです。

・KVMサーバ

　Kernel-based Virtual Machineがインストールされているサーバです。

・OpenStack操作サーバ

　OpenStackサーバにREST-APIを実行するサーバです。

・インスタンス

　OpenStackサーバおよびKVMによって管理されているインスタンスです。一般的な仮想サーバのことです。

利用場面

この部品は，不要になったボリュームを削除する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)OpenStackサーバの前提製品

　・OpenStack

(2)インスタンスを管理する仮想化環境

　・Kernel-based Virtual Machine

　・VMware vCenter Server

　・VMware vSphere ESXi

(3)OpenStack操作サーバ

　・Microsoft .Net Framework 3.5以降

(4)インスタンスの前提OS

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter

　・Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象システム内前提製品の使用条件】

(1)ボリュームに関する条件

　・同一プロジェクト内でボリューム名が重複しないこと。

注意事項

(1)ボリューム名，ボリュームIDはどちらかもしくは両方を指定してください。どちらの指定も無い場合，この部品はエラー終了します。

実行権限

(1)OpenStackサーバにログインするユーザーに次の権限が必要です。

admin権限

バージョン

02.00.00

部品のタグ

Delete Storage,OpenStack

タスクログに表示される部品の名称

openstackDeleteVolume

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

openstack.identityServerHostName

Identityサーバのホスト名

Identityサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

openstack.userName

Identityサーバにログインするためのユーザー名

Identityサーバにログインするためのユーザー名を指定します。

−　

入力

○　

openstack.password

Identityサーバにログインするためのパスワード

Identityサーバにログインするためのパスワードを指定します。

−　

入力

○　

openstack.protocol

Identityサーバ接続用プロトコル

Identityサーバに接続するためのプロトコルを指定します。

−　

入力

○　

openstack.portNumber

Identityサーバ接続用ポート番号

Identityサーバに接続するためのポート番号を指定します。

−　

入力

○　

openstack.projectName

プロジェクト名

プロジェクトの名称を指定します。

−　

入力

○　

openstack.volumeNames

ボリューム名

ボリュームの名称を指定します。複数のボリュームを指定する場合は，","区切りで指定してください。

−　

入力

△　

openstack.volumeIds

ボリュームID

ボリュームのIDを指定します。複数のボリュームを指定する場合は，","区切りで指定してください。

−　

入力

△　

openstack.checkVolumeDeletionCount

ボリュームの削除完了の確認回数

ボリュームが削除されたことを確認する際の，確認回数を指定します。ボリュームの削除完了の確認間隔と組み合わせて最大待ち時間となります。

−　

入力

○　

openstack.checkVolumeDeletionInterval

ボリュームの削除完了の確認間隔

ボリュームが削除されたことを確認する際の，確認間隔を秒単位で指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.8.4　ボリュームの切断

機能

OpenStack管理下のKVM環境で，インスタンスに接続されているボリュームを切断します。

このドキュメント内で使用しているOpenStackに関する用語は，OpenStackのDashboardで使用されている表示名です。OpenStackに関する用語を次に示します。

・Identity

　OpenStackではIdentityまたはKeyStoneと記載されています。

・プロジェクト

　OpenStackではプロジェクトまたはテナントと記載されています。

・ボリューム

　OpenStackではボリュームまたはブロックストレージと記載されています。

この部品が前提とするサーバを次に示します。

・OpenStackサーバ

　OpenStackがインストールされているサーバです。

・KVMサーバ

　Kernel-based Virtual Machineがインストールされているサーバです。

・OpenStack操作サーバ(実行対象サーバ)

　OpenStackサーバにREST-APIを実行するサーバです。

・インスタンス

　OpenStackサーバおよびKVMによって管理されているインスタンスです。一般的な仮想サーバのことです。

利用場面

この部品は，OpenStack環境でインスタンスに接続されているボリュームを切断する際に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)OpenStackサーバの前提製品

　・OpenStack

(2)インスタンスを管理する仮想化環境

　・Kernel-based Virtual Machine

　・VMware vCenter Server

　・VMware vSphere ESXi

(3)OpenStack操作サーバ(実行対象サーバ)

　・Microsoft .Net Framework 3.5以降

(4)インスタンスの前提OS

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

【実行対象サーバ内前提製品の稼動OS】

(1)OpenStack操作サーバ(実行対象サーバ)

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter

　・Windows Server 2012 R2 Standard/Datacenter

　ただし，Server Coreインストール環境は除く。

【実行対象システム内前提製品の使用条件】

(1)インスタンスに関する条件

　・同一プロジェクト内でインスタンス名が重複しないこと。

(2)ボリュームに関する条件

　・同一プロジェクト内でボリューム名が重複しないこと。

注意事項

(1)ボリュームを切断する際に，ボリュームがアンマウントされていることを確認してください。ボリュームがマウントされている状態でボリュームの切断を行った場合，ファイルシステム破損が起きるおそれがあります。

実行権限

(1)OpenStackサーバにログインするユーザーに次の権限が必要です。

admin権限

バージョン

02.00.00

部品のタグ

Modify VM,OpenStack

タスクログに表示される部品の名称

openstackDetachVolume

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

openstack.identityServerHostName

Identityサーバのホスト名

Identityサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

openstack.userName

Identityサーバにログインするためのユーザー名

Identityサーバにログインするためのユーザー名を指定します。

−　

入力

○　

openstack.password

Identityサーバにログインするためのパスワード

Identityサーバにログインするためのパスワードを指定します。

−　

入力

○　

openstack.protocol

Identityサーバ接続用プロトコル

Identityサーバに接続するためのプロトコルを指定します。

−　

入力

○　

openstack.portNumber

Identityサーバ接続用ポート番号

Identityサーバに接続するためのポート番号を指定します。

−　

入力

○　

openstack.projectName

プロジェクト名

プロジェクトの名称を指定します。

−　

入力

○　

openstack.instanceName

インスタンス名

インスタンスの名称を指定します(OpenStackにおけるインスタンスの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

openstack.volumeName

ボリューム名

インスタンスに接続しているボリュームの名称を指定します。

−　

入力

○　

openstack.checkVolumeDetachmentCount

ボリュームの切断完了の確認回数

ボリュームが切断されたことを確認する際の，確認回数を指定します。ボリュームの切断完了の確認間隔と組み合わせて最大待ち時間となります。

−　

入力

○　

openstack.checkVolumeDetachmentInterval

ボリュームの切断完了の確認間隔

ボリュームが切断されたことを確認する際の，確認間隔を秒単位で指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.8.5　ボリュームの接続

機能

OpenStack管理下のKVM環境で，インスタンスにボリュームを接続します。

このドキュメント内で使用しているOpenStackに関する用語は，OpenStackのDashboardで使用されている表示名です。OpenStackに関する用語を次に示します。

・Identity

　IdentityまたはKeyStoneと記載されています。

・プロジェクト

　プロジェクトまたはテナントと記載されています。

・ボリューム

　ボリュームまたはブロックストレージと記載されています。

この部品が前提とするサーバを次に示します。

・OpenStackサーバ

　OpenStackがインストールされているサーバです。

・KVMサーバ

　Kernel-based Virtual Machineがインストールされているサーバです。

・OpenStack操作サーバ

　OpenStackサーバにREST-APIを実行するサーバです。

・インスタンス

　OpenStackサーバおよびKVMによって管理されているインスタンスです。一般的な仮想サーバのことです。

・ボリューム

　Cinderによって管理されているボリュームです。

利用場面

この部品は，OpenStack環境でインスタンスにボリュームを接続する際に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)OpenStackサーバの前提製品

　・OpenStack

(2)インスタンスを管理する仮想化環境

　・Kernel-based Virtual Machine

　・VMware vCenter Server

　・VMware vSphere ESXi

(3)OpenStack操作サーバ

　・Microsoft .Net Framework 3.5以降

(4)インスタンスの前提OS

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter

　・Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象システム内前提製品の使用条件】

(1)インスタンスに関する条件

　・同一プロジェクト内でインスタンス名が重複しないこと。

(2)ボリュームに関する条件

　・同一プロジェクト内でボリューム名が重複しないこと。

注意事項

(1)openstack.deviceNameプロパティを省略した場合，インスタンスのゲストOSのデフォルトデバイスにマッピングします。

実行権限

(1)OpenStackサーバにログインするユーザーに次の権限が必要です。

admin権限

バージョン

02.00.00

部品のタグ

Modify VM,OpenStack

タスクログに表示される部品の名称

openstackAttachVolume

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

openstack.identityServerHostName

Identityサーバのホスト名

Identityサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

openstack.userName

Identityサーバにログインするためのユーザー名

Identityサーバにログインするためのユーザー名を指定します。

−　

入力

○　

openstack.password

Identityサーバにログインするためのパスワード

Identityサーバにログインするためのパスワードを指定します。

−　

入力

○　

openstack.protocol

Identityサーバ接続用プロトコル

Identityサーバに接続するためのプロトコルを指定します。

−　

入力

○　

openstack.portNumber

Identityサーバ接続用ポート番号

Identityサーバに接続するためのポート番号を指定します。

−　

入力

○　

openstack.projectName

プロジェクト名

プロジェクトの名称を指定します。

−　

入力

○　

openstack.instanceName

インスタンス名

インスタンスの名称を指定します(OpenStackにおけるインスタンスの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

openstack.volumeName

ボリューム名

インスタンスに接続するボリュームの名称を指定します。

−　

入力

○　

openstack.deviceName

デバイス名

インスタンスに接続するボリュームをマッピングするデバイスを指定します。デバイスはゲストOSのdevディレクトリ配下が相当し，例えば"vda"にマッピングする場合は"/dev/vda"と指定します。

−　

入力

△　

openstack.checkVolumeAttachmentCount

ボリュームの接続完了の確認回数

ボリュームが接続されたことを確認する際の，確認回数を指定します。ボリュームの接続完了の確認間隔と組み合わせて最大待ち時間となります。

−　

入力

○　

openstack.checkVolumeAttachmentInterval

ボリュームの接続完了の確認間隔

ボリュームが接続されたことを確認する際の，確認間隔を秒単位で指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

openstack.attachedDeviceName

接続デバイス名

ボリュームを接続したデバイス名が格納されます。

−　

出力

△　

5.8.6　一時ボリュームの作成

機能

OpenStack管理下のボリュームから一時ボリュームを作成します。

このドキュメント内で使用しているOpenStackに関する用語は，OpenStackのDashboardで使用されている表示名です。OpenStackに関する用語を次に示します。

・Identity

　IdentityまたはKeyStoneと記載されています。

・プロジェクト

　プロジェクトまたはテナントと記載されています。

・ボリューム

　ボリュームまたはブロックストレージと記載されています。

この部品が前提とするサーバを次に示します。

・OpenStackサーバ

　OpenStackがインストールされているサーバです。

・KVMサーバ

　Kernel-based Virtual Machineがインストールされているサーバです。

・OpenStack操作サーバ

　OpenStackサーバにREST-APIを実行するサーバです。

・インスタンス

　OpenStackサーバおよびKVMによって管理されているインスタンスです。一般的な仮想サーバのことです。

(1)次の条件のどれか，または両方を満たすCinderによって管理されているボリュームを一時ボリューム作成対象とします。インスタンスおよびイメージは対象にできません。

　①openstack.instanceNameプロパティに指定されたインスタンスに割り当たっているボリューム

　②openstack.volumeNamesプロパティに指定されたボリューム

(2)一時ボリュームはバックアップ元のボリュームと同一ボリューム種別に作成されます。

利用場面

この部品は，ボリューム作成のあと，システム保全のためにバックアップを取得する場合の一時ボリューム作成に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)OpenStackサーバの前提製品

　・OpenStack

(2)インスタンスを管理する仮想化環境

　・Kernel-based Virtual Machine

　・VMware vCenter Server

　・VMware vSphere ESXi

(3)OpenStack操作サーバ

　・Microsoft .Net Framework 3.5以降

(4)インスタンスの前提OS

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter

　・Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象システム内前提製品の使用条件】

(1)インスタンスに関する条件

　・同一プロジェクト内でインスタンス名が重複しないこと。

(2)ボリュームに関する条件

　・同一プロジェクト内でボリューム名が重複しないこと。

注意事項

(1)インスタンス名，ボリューム名はどちらかもしくは両方を指定してください。どちらの指定も無い場合，この部品はエラー終了します。

(2)この部品は稼働中のインスタンスに対しても実行できます。その際，ゲストOS上でI/Oが発生していると，ゲストOSとバックアップ間に不整合が発生する場合があります。そのため，ゲストOS上のI/Oを停止しておくかゲストOS自体を事前に停止してください。

(3)一度に作成可能な一時ボリュームの最大数は，27ボリュームまでです。28ボリューム以上指定された場合は，この部品はエラー終了します。

(4)一時ボリューム作成先には，一時ボリューム作成元ボリュームと同じ容量またはそれ以上の空き容量を確保してください。一時ボリューム作成先に十分な空き容量が無い場合，この部品はエラー終了します。

(5)ボリュームの状態や種別によっては，一時ボリュームの作成ができずこの部品はエラー終了します。事前に，ボリュームの状態や種別，および使用しているCinderドライバのマニュアルを確認してください。

実行権限

(1)OpenStackサーバにログインするユーザーに次の権限が必要です。

admin権限

バージョン

02.00.00

部品のタグ

Add New Storage,OpenStack

タスクログに表示される部品の名称

openstackCreateTempVolume

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

openstack.identityServerHostName

Identityサーバのホスト名

Identityサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

openstack.userName

Identityサーバにログインするためのユーザー名

Identityサーバにログインするためのユーザー名を指定します。

−　

入力

○　

openstack.password

Identityサーバにログインするためのパスワード

Identityサーバにログインするためのパスワードを指定します。

−　

入力

○　

openstack.protocol

Identityサーバ接続用プロトコル

Identityサーバに接続するためのプロトコルを指定します。

−　

入力

○　

openstack.portNumber

Identityサーバ接続用ポート番号

Identityサーバに接続するためのポート番号を指定します。

−　

入力

○　

openstack.projectName

プロジェクト名

プロジェクトの名称を指定します。

−　

入力

○　

openstack.instanceName

インスタンス名

インスタンスの名称を指定します(OpenStackにおけるインスタンスの表示名称です。OS上のホスト名ではありません)。

−　

入力

△　

openstack.volumeNames

ボリューム名

ボリュームの名称を指定します。複数のボリュームを指定する場合は，","区切りで指定してください。

−　

入力

△　

openstack.tempVolumeName

一時ボリューム名

バックアップを取得する際の一時ボリューム名を指定します。

−　

入力

○　

openstack.checkVolumeCreationCount

一時ボリュームの作成完了の確認回数

一時ボリュームが作成されたことを確認する際の，確認回数を指定します。一時ボリュームの作成完了の確認間隔と組み合わせて最大待ち時間となります。

−　

入力

○　

openstack.checkVolumeCreationInterval

一時ボリュームの作成完了の確認間隔

一時ボリュームが作成されたことを確認する際の，確認間隔を秒単位で指定します。

−　

入力

○　

openstack.volumeIdWork

一時ボリュームID

一時ボリュームのIDが格納されるワークプロパティです。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.8.7　仮想サーバのIPアドレス取得

機能

OpenStack管理下のKVM環境で，インスタンスのすべてのNICに設定されたIPアドレス(IPv4)を取得します。

このドキュメント内で使用しているOpenStackに関する用語は，OpenStackのDashboardで使用されている表示名です。OpenStackに関する用語を次に示します。

・Identity

　IdentityまたはKeyStoneと記載されています。

・プロジェクト

　プロジェクトまたはテナントと記載されています。

この部品が前提とするサーバを次に示します。

・OpenStackサーバ

　OpenStackがインストールされているサーバです。

・KVMサーバ

　Kernel-based Virtual Machineがインストールされているサーバです。

・OpenStack操作サーバ

　OpenStackサーバにREST-APIを実行するサーバです。

・インスタンス

　OpenStackサーバおよびKVMによって管理されているインスタンスです。一般的な仮想サーバのことです。

利用場面

インスタンスに設定されているIPアドレス(IPv4)の確認や，インスタンスに対してICMPエコー要求を発行する場合に使用できます。

ICMPエコー要求を発行する処理は，この部品でインスタンスのIPアドレスを取得し，osSendIcmp部品の入力として使用するという流れになります。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)OpenStackサーバの前提製品

　・OpenStack

(2)インスタンスを管理する仮想化環境

　・Kernel-based Virtual Machine

　・VMware vCenter Server

　・VMware vSphere ESXi

(3)OpenStack操作サーバ

　・Microsoft .Net Framework 3.5以降

(4)インスタンスの前提OS

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter

　・Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象システム内前提製品の使用条件】

(1)インスタンスに関する条件

　・同一プロジェクト内でインスタンス名が重複しないこと。

実行権限

(1)OpenStackサーバにログインするユーザーに次の権限が必要です。

admin権限

バージョン

02.00.00

部品のタグ

Gather VM information,OpenStack

タスクログに表示される部品の名称

openstackGetVMIPaddress

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

openstack.identityServerHostName

Identityサーバのホスト名

Identityサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

openstack.userName

Identityサーバにログインするためのユーザー名

Identityサーバにログインするためのユーザー名を指定します。

−　

入力

○　

openstack.password

Identityサーバにログインするためのパスワード

Identityサーバにログインするためのパスワードを指定します。

−　

入力

○　

openstack.protocol

Identityサーバ接続用プロトコル

Identityサーバに接続するためのプロトコルを指定します。

−　

入力

○　

openstack.portNumber

Identityサーバ接続用ポート番号

Identityサーバに接続するためのポート番号を指定します。

−　

入力

○　

openstack.projectName

プロジェクト名

プロジェクトの名称を指定します。

−　

入力

○　

openstack.instanceName

インスタンス名

インスタンスの名称を指定します(OpenStackにおけるインスタンスの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

openstack.instanceIPaddress

インスタンスのIPアドレス

インスタンスのIPアドレスが格納されるワークプロパティです。インスタンスに複数のIPアドレスが設定されている場合には，コンマ区切りで出力されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.8.8　仮想サーバの起動

機能

OpenStack管理下のKVM環境で，インスタンスを起動します。

このドキュメント内で使用しているOpenStackに関する用語は，OpenStackのDashboardで使用されている表示名です。OpenStackに関する用語を次に示します。

・Identity

　IdentityまたはKeyStoneと記載されています。

・プロジェクト

　プロジェクトまたはテナントと記載されています。

この部品が前提とするサーバを次に示します。

・OpenStackサーバ

　OpenStackがインストールされているサーバです。

・KVMサーバ

　Kernel-based Virtual Machineがインストールされているサーバです。

・OpenStack操作サーバ

　OpenStackサーバにREST-APIを実行するサーバです。

・インスタンス

　OpenStackサーバおよびKVMによって管理されているインスタンスです。一般的な仮想サーバのことです。

利用場面

この部品は，OpenStack環境でインスタンスを起動する際に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)OpenStackサーバの前提製品

　・OpenStack

(2)インスタンスを管理する仮想化環境

　・Kernel-based Virtual Machine

　・VMware vCenter Server

　・VMware vSphere ESXi

(3)OpenStack操作サーバ

　・Microsoft .Net Framework 3.5以降

(4)インスタンスの前提OS

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter

　・Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象システム内前提製品の使用条件】

(1)インスタンスに関する条件

　・同一プロジェクト内でインスタンス名が重複しないこと。

　・インスタンスが停止していること。

実行権限

(1)OpenStackサーバにログインするユーザーに次の権限が必要です。

admin権限

バージョン

02.00.00

部品のタグ

Control VM,OpenStack

タスクログに表示される部品の名称

openstackSetPowerOn

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

openstack.identityServerHostName

Identityサーバのホスト名

Identityサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

openstack.userName

Identityサーバにログインするためのユーザー名

Identityサーバにログインするためのユーザー名を指定します。

−　

入力

○　

openstack.password

Identityサーバにログインするためのパスワード

Identityサーバにログインするためのパスワードを指定します。

−　

入力

○　

openstack.protocol

Identityサーバ接続用プロトコル

Identityサーバに接続するためのプロトコルを指定します。

−　

入力

○　

openstack.portNumber

Identityサーバ接続用ポート番号

Identityサーバに接続するためのポート番号を指定します。

−　

入力

○　

openstack.projectName

プロジェクト名

プロジェクトの名称を指定します。

−　

入力

○　

openstack.instanceName

インスタンス名

インスタンスの名称を指定します(OpenStackにおけるインスタンスの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

openstack.checkInstanceStateEnabledCount

インスタンスの状態(起動完了)の確認回数

インスタンスの起動が完了したか確認する際の確認回数を指定します。インスタンスの状態(起動完了)の確認間隔と組み合わせて最大待ち時間となります。

−　

入力

○　

openstack.checkInstanceStateEnabledInterval

インスタンスの状態(起動完了)の確認間隔

インスタンスの起動が完了したか確認する際の確認間隔を秒単位で指定します。

−　

入力

○　

openstack.instanceState

インスタンスの状態

インスタンスの状態が格納されるワークプロパティです。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.8.9　仮想サーバの作成

機能

OpenStack管理下のKVM環境で，イメージからインスタンスの起動をします。

このドキュメント内で使用しているOpenStackに関する用語は，OpenStackのDashboardで使用されている表示名です。OpenStackに関する用語を次に示します。

・Identity

　IdentityまたはKeyStoneと記載されています。

・インスタンスタイプ

　インスタンスタイプまたはフレーバーと記載されています。

・プロジェクト

　プロジェクトまたはテナントと記載されています。

この部品が前提とするサーバを次に示します。

・OpenStackサーバ

　OpenStackがインストールされているサーバです。

・KVMサーバ

　Kernel-based Virtual Machineがインストールされているサーバです。

・OpenStack操作サーバ

　OpenStackサーバにREST-APIを実行するサーバです。

・インスタンス

　OpenStackサーバおよびKVMによって管理されているインスタンスです。一般的な仮想サーバのことです。

利用場面

この部品は，openstack環境でインスタンスを起動する際に使用できます。次の部品とあわせて実行することで，インスタンスのOS初期設定まで実施できます。

・osSetLinuxInfo

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)OpenStackサーバの前提製品

・OpenStack

(2)インスタンスを管理する仮想化環境

　・Kernel-based Virtual Machine

　・VMware vCenter Server

　・VMware vSphere ESXi

(3)OpenStack操作サーバ

　・Microsoft .Net Framework 3.5以降

(4)インスタンスの前提OS

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象システム内前提製品の使用条件】

(1)OpenStackサーバ上の設定に関する条件

　・インスタンスが接続するネットワークのサブネットの設定がDHCP有効で，IPアドレスが動的に割り当てられるようになっていること。

　・インスタンスの起動に使用するイメージが作成済みであること。

　・インスタンスの起動に使用するインスタンスタイプが作成済みであること。

　・インスタンスの起動に使用するネットワークが作成済みであること。

　・イメージ名がテナント内で一意であること。

　・インスタンスタイプ名がテナント内で一意であること。

　・ネットワーク名がテナント内で一意であること。

(2)インスタンスの起動に使用するイメージに関する条件

　・エージェントレス接続が可能な設定であること。

　・ファイアーウォールがICMP(ECHO)応答を許可していること。

(3)インスタンスに関する条件

　・同一テナント内でインスタンス名が重複しないこと。

注意事項

(1)インスタンスの起動中は，当該インスタンスを操作しないでください。インスタンスの起動に失敗するおそれがあります。OpenStackサーバからも直接操作をしないでください。

(2)インスタンスに対してFloating IPアドレスを設定したい場合は，openstack.floatingIpOptionプロパティの選択リストで"yes"を選択し，openstack.floatingIpAddressプロパティにFloating IPアドレスを指定してください。openstack.floatingIpOptionプロパティの選択リストで"yes"を選択し，openstack.floatingIpAddressプロパティにFloating IPの指定が無い場合，openstack.networkNameExtプロパティで指定したネットワークのFloating IPアドレスプールから最初に取得できたFloating IPアドレスを設定します。

(3)JP1/AOサーバとの通信に外部ネットワークを使用する場合は，openstack.floatingIpOptionプロパティの選択リストで"yes"を選択してください。"no"を選択した場合，JP1/AOサーバからインスタンスにアクセスできないで，タスクが異常終了します。

(4)openstack.floatingIpOptionプロパティの選択リストで"yes"を選択した場合は，openstack.networkNameExtプロパティを設定してください。openstack.networkNameExtプロパティが省略された場合は，Floating IPアドレスを取得する外部ネットワークが特定できないで，タスクが異常終了します。

(5)openstack.securityGroupNameプロパティを省略した場合，セキュリティグループ"default"が設定されます。

(6)openstack.protocolプロパティの選択リストで"https"を選択した場合に，OpenStackサーバの証明書がパブリック証明書でない場合，証明書の信頼性が確認できないため，タスクが異常終了します。

実行権限

(1)OpenStackサーバにログインするユーザーに次の権限が必要です。

admin権限

バージョン

02.00.00

部品のタグ

Add VM,OpenStack

タスクログに表示される部品の名称

openstackCreateVM

戻り値

戻り値

説明

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

openstack.identityServerHostName

Identityサーバのホスト名

Identityサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

openstack.userName

Identityサーバにログインするためのユーザー名

Identityサーバにログインするためのユーザー名を指定します。

−　

入力

○　

openstack.password

Identityサーバにログインするためのパスワード

Identityサーバにログインするためのパスワードを指定します。

−　

入力

○　

openstack.protocol

Identityサーバ接続用プロトコル

Identityサーバに接続するためのプロトコルを指定します。

−　

入力

○　

openstack.portNumber

Identityサーバ接続用ポート番号

Identityサーバに接続するためのポート番号を指定します。

−　

入力

○　

openstack.projectName

プロジェクト名

インスタンスを起動させるプロジェクトの名称を指定します。

−　

入力

○　

openstack.instanceName

インスタンス名

インスタンスの名称を指定します(OpenStackにおけるインスタンスの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

openstack.imageName

イメージ名

イメージの名称を指定します。

−　

入力

○　

openstack.instanceTypeName

インスタンスタイプ名

インスタンスタイプの名称を指定します。

−　

入力

○　

openstack.keyPairName

キーペア名

キーペアの名称を指定します。

−　

入力

△　

openstack.securityGroupName

セキュリティグループ名

セキュリティグループの名称を指定します。

−　

入力

△　

openstack.networkNameMng

ネットワーク名(管理用)

インスタンスに設定する管理用のネットワークの名称を指定します。

−　

入力

○　

openstack.networkNameBiz

ネットワーク名(業務用)

インスタンスに設定する業務用のネットワークの名称を指定します。

−　

入力

△　

openstack.floatingIpOption

Floating IPアドレス設定の有無

インスタンスにFloating IPアドレスの割り当てを行うかを指定します。Floating IPアドレスを割り当てる場合はyes，割り当てない場合はnoを選択します。

−　

入力

○　

openstack.networkNameExt

ネットワーク名(外部接続用)

Floating IPアドレスを取得する外部ネットワークの名称を指定します。

−　

入力

△　

openstack.floatingIpAddress

Floating IPアドレス

インスタンスに割り当てるFloating IPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

openstack.checkInstanceStateCount

インスタンスの起動完了の確認回数

インスタンスの起動を確認する際の，インスタンスの起動状態の確認回数を指定します。インスタンスの起動状態の確認間隔と組み合わせて最大待ち時間となります。

−　

入力

○　

openstack.checkInstanceStateInterval

インスタンスの起動完了の確認間隔

インスタンスの起動を確認する際の，インスタンスの起動状態の確認間隔を秒単位で指定します。

−　

入力

○　

openstack.checkOSStateWaittime

OS起動待ち時間

OSの起動を確認する際の，起動待ち時間を秒単位で指定します。

−　

入力

○　

openstack.ipAddressMng

IPアドレス(管理用)

インスタンスの管理用ネットワークに割り当てられたIPアドレスを格納します。

−　

出力

△　

openstack.ipAddressBiz

IPアドレス(業務用)

インスタンスの業務用ネットワークに割り当てられたIPアドレスを格納します。

−　

出力

△　

openstack.floatingIpAddressWork

Floating IPアドレス

インスタンスに割り当てられたFloating IPアドレスを格納します。

−　

出力

△　

openstack.instanceHostName

インスタンスのホスト名

インスタンスのホスト名が格納されるワークプロパティです。

−　

出力

△　

common.flag2IPsSetup

インスタンスに2つのIPアドレスを設定したかどうか

インスタンスに2つIPアドレスを設定したとき（TRUE），それ以外のとき（FALSE）を格納するプロパティです。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.8.10　仮想サーバの削除

機能

OpenStack管理下のKVM環境で，インスタンスを削除します。また，インスタンスにFloating IPアドレスが設定されている場合，Floating IPアドレスを割り当て解除します。

このドキュメント内で使用しているOpenStackに関する用語は，OpenStackのDashboardで使用されている表示名です。OpenStackに関する用語を次に示します。

・Identity

　OpenStackではIdentityまたはKeyStoneと記載されています。

・プロジェクト

　OpenStackではプロジェクトまたはテナントと記載されています。

・ボリューム

　OpenStackではボリュームまたはブロックストレージと記載されています。

この部品が前提とするサーバを次に示します。

・OpenStackサーバ

　OpenStackがインストールされているサーバです。

・KVMサーバ

　Kernel-based Virtual Machineがインストールされているサーバです。

・OpenStack操作サーバ(実行対象サーバ)

　OpenStackサーバにREST-APIを実行するサーバです。

・インスタンス

　OpenStackサーバおよびKVMによって管理されているインスタンスです。一般的な仮想サーバのことです。

利用場面

この部品は，OpenStack環境でインスタンスを削除する際に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)OpenStackサーバの前提製品

　・OpenStack

(2)インスタンスを管理する仮想化環境

　・Kernel-based Virtual Machine

　・VMware vCenter Server

　・VMware vSphere ESXi

(3)OpenStack操作サーバ(実行対象サーバ)

　・Microsoft .Net Framework 3.5以降

(4)インスタンスの前提OS

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

【実行対象サーバ内前提製品の稼動OS】

(1)OpenStack操作サーバ(実行対象サーバ)

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter

　・Windows Server 2012 R2 Standard/Datacenter

　ただし，Server Coreインストール環境は除く。

【実行対象システム内前提製品の使用条件】

(1)インスタンスに関する条件

　・同一プロジェクト内でインスタンス名が重複しないこと。

注意事項

(1)インスタンスにボリュームが接続されている場合，接続されているボリュームは削除しません。

(2)インスタンスにボリュームが接続されている場合，インスタンス削除の際に接続されているボリュームがアンマウントされていることを確認してください。ボリュームがマウントされている状態でインスタンスの削除を行った場合，ファイルシステム破損が起きるおそれがあります。

実行権限

(1)OpenStackサーバにログインするユーザーに次の権限が必要です。

admin権限

バージョン

02.00.00

部品のタグ

Delete VM,OpenStack

タスクログに表示される部品の名称

openstackDeleteVM

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

openstack.identityServerHostName

Identityサーバのホスト名

Identityサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

openstack.userName

Identityサーバにログインするためのユーザー名

Identityサーバにログインするためのユーザー名を指定します。

−　

入力

○　

openstack.password

Identityサーバにログインするためのパスワード

Identityサーバにログインするためのパスワードを指定します。

−　

入力

○　

openstack.protocol

Identityサーバ接続用プロトコル

Identityサーバに接続するためのプロトコルを指定します。

−　

入力

○　

openstack.portNumber

Identityサーバ接続用ポート番号

Identityサーバに接続するためのポート番号を指定します。

−　

入力

○　

openstack.projectName

プロジェクト名

プロジェクトの名称を指定します。

−　

入力

○　

openstack.instanceName

インスタンス名

インスタンスの名称を指定します(OpenStackにおけるインスタンスの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

openstack.checkInstanceDeletionCount

インスタンスの削除の確認回数

インスタンスが削除されたことを確認する際の，確認回数を指定します。インスタンスの削除の確認間隔と組み合わせて最大待ち時間となります。

−　

入力

○　

openstack.checkInstanceDeletionInterval

インスタンスの削除の確認間隔

インスタンスが削除されたことを確認する際の，確認間隔を秒単位で指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.8.11　仮想サーバの情報一覧取得

機能

OpenStack管理下の，指定したプロジェクトに含まれるインスタンス情報一覧をCSV形式でファイルに出力します。

このドキュメント内で使用しているOpenStackに関する用語は，OpenStackのDashboardで使用されている表示名です。OpenStackに関する用語を次に示します。

・Identity

　OpenStackではIdentityまたはKeyStoneと記載されています。

・プロジェクト

　OpenStackではプロジェクトまたはテナントと記載されています。

この部品が前提とするサーバを次に示します。

・OpenStackサーバ

　OpenStackがインストールされているサーバです。

・KVMサーバ

　Kernel-based Virtual Machineがインストールされているサーバです。

・OpenStack操作サーバ(実行対象サーバ)

　OpenStackサーバにREST-APIを実行するサーバです。

・インスタンス

　OpenStackサーバおよびKVMによって管理されているインスタンスです。一般的な仮想サーバのことです。

出力するCSVファイルの項目を次に示します。

項目はコンマ区切りで出力します。

(a) Hypervisorのホスト名 (ヘッダー名：HostName)

(b) インスタンス名 (ヘッダー名：InstanceName)

(c) イメージ名 (ヘッダー名：ImageName)

(d) インスタンスの状態 (ヘッダー名：Status)

(e) インスタンスのCPU数※ (ヘッダー名：NumCpu)

(f) インスタンスのメモリ容量(MB)※ (ヘッダー名：MemoryMB)

(g) インスタンスのディスクサイズ(GB)※ (ヘッダー名：TotalDiskOfFlavorGB)

(h) フレーバー名 (ヘッダー名：FlavorName)

注※：「インスタンスのCPU数」「インスタンスのメモリ容量(MB)」「インスタンスのディスクサイズ(GB)」はインスタンスの起動時に指定したフレーバーの情報です。

利用場面

この部品は，OpenStack環境でインスタンス情報を取得する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)OpenStackサーバの前提製品

　・OpenStack

(2)インスタンスを管理する仮想化環境

　・Kernel-based Virtual Machine

　・VMware vCenter Server

　・VMware vSphere ESXi

(3)OpenStack操作サーバ(実行対象サーバ)

　・Microsoft .Net Framework 3.5以降

(4)インスタンスの前提OS

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

【実行対象サーバ内前提製品の稼動OS】

(1)OpenStack操作サーバ(実行対象サーバ)

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter

　・Windows Server 2012 R2 Standard/Datacenter

　ただし，Server Coreインストール環境は除く。

【実行対象システム内前提製品の使用条件】

なし。

注意事項

(1)ファイル名が既に存在する場合，既存のファイルを上書きします。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(2)フォルダが存在しない場合は，そのフォルダを作成します。

(3)同名のインスタンスが2つ以上ある場合，出力するCSVファイルではインスタンスを特定できません。

実行権限

(1)OpenStackサーバにログインするユーザーに次の権限が必要です。

admin権限

バージョン

02.00.00

部品のタグ

Gather VM information,OpenStack

タスクログに表示される部品の名称

openstackOutputVmSpec

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

openstack.identityServerHostName

Identityサーバのホスト名

Identityサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

openstack.userName

Identityサーバにログインするためのユーザー名

Identityサーバにログインするためのユーザー名を指定します。

−　

入力

○　

openstack.password

Identityサーバにログインするためのパスワード

Identityサーバにログインするためのパスワードを指定します。

−　

入力

○　

openstack.protocol

Identityサーバ接続用プロトコル

Identityサーバに接続するためのプロトコルを指定します。

−　

入力

○　

openstack.portNumber

Identityサーバ接続用ポート番号

Identityサーバに接続するためのポート番号を指定します。

−　

入力

○　

openstack.projectName

プロジェクト名

プロジェクトの名称を指定します。

−　

入力

○　

openstack.vmInfoListOutputFileName

インスタンス情報一覧出力ファイル名

インスタンス情報一覧を出力するファイル名をフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.8.12　仮想サーバの状態取得

機能

OpenStack管理下のKVM環境で，インスタンスの状態を取得します。

このドキュメント内で使用しているOpenStackに関する用語は，OpenStackのDashboardで使用されている表示名です。OpenStackに関する用語を次に示します。

・Identity

　IdentityまたはKeyStoneと記載されています。

・プロジェクト

　プロジェクトまたはテナントと記載されています。

この部品が前提とするサーバを次に示します。

・OpenStackサーバ

　OpenStackがインストールされているサーバです。

・KVMサーバ

　Kernel-based Virtual Machineがインストールされているサーバです。

・OpenStack操作サーバ

　OpenStackサーバにREST-APIを実行するサーバです。

・インスタンス

　OpenStackサーバおよびKVMによって管理されているインスタンスです。一般的な仮想サーバのことです。

利用場面

この部品は，OpenStack環境でインスタンスの状態を取得する際に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

(1)OpenStackサーバの前提製品

　・OpenStack

(2)インスタンスを管理する仮想化環境

　・Kernel-based Virtual Machine

　・VMware vCenter Server

　・VMware vSphere ESXi

(3)OpenStack操作サーバ

　・Microsoft .Net Framework 3.5以降

(4)インスタンスの前提OS

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter

　・Windows Server 2012 R2 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象システム内前提製品の使用条件】

(1)インスタンスに関する条件

　・同一プロジェクト内でインスタンス名が重複しないこと。

実行権限

(1)OpenStackサーバにログインするユーザーに次の権限が必要です。

admin権限

バージョン

02.00.00

部品のタグ

Gather VM information,OpenStack

タスクログに表示される部品の名称

openstackGetVMState

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

openstack.identityServerHostName

Identityサーバのホスト名

Identityサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

openstack.userName

Identityサーバにログインするためのユーザー名

Identityサーバにログインするためのユーザー名を指定します。

−　

入力

○　

openstack.password

Identityサーバにログインするためのパスワード

Identityサーバにログインするためのパスワードを指定します。

−　

入力

○　

openstack.protocol

Identityサーバ接続用プロトコル

Identityサーバに接続するためのプロトコルを指定します。

−　

入力

○　

openstack.portNumber

Identityサーバ接続用ポート番号

Identityサーバに接続するためのポート番号を指定します。

−　

入力

○　

openstack.projectName

プロジェクト名

プロジェクトの名称を指定します。

−　

入力

○　

openstack.instanceName

インスタンス名

インスタンスの名称を指定します(OpenStackにおけるインスタンスの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

openstack.instanceState

インスタンスの状態

インスタンスの状態が格納されるワークプロパティです。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.9　Oracle関連の部品

5.9.1　OracleDBインスタンスの起動

機能

OracleDBサーバ上のOracleDBインスタンスを起動します。

プロパティ「実行対象サーバのホスト名」(plugin.destinationHost)に指定したOracleDBサーバ(以降，「DBサーバ」と呼ぶ)上で，SQL*PlusのSTARTUPコマンドを実行します。

同コマンドは同期的に実行します。コマンド実行後，OracleDBインスタンスの状態を確認します。

このドキュメント内で使用しているOracleに関する用語を次に示します。

・OracleDBインスタンス

　DBサーバにインストールされているDBのインスタンスです。

同一のDBサーバ上に複数のインスタンスが存在することができ，各々のインスタンスはDBサーバ内でユニークな識別名(後述の「Oracleシステム識別子(SID)」)と個別のインストール先フォルダを持っています。

また，インスタンスはDBのテーブル領域やDBユーザーのアカウント情報や権限設定情報らを束ねる存在でもあります。

・SQL*Plus

　OracleDBに同梱されているユーティリティツールです。

コマンドラインインタフェイス(CLI)でOracleDBを操作・保守する為の独自なコマンドを有しているほか，SQL文を実行するDBクライアント機能を備えています。

・Oracleシステム識別子(SID)

　OracleDBインスタンスの識別名です。

　OracleのマニュアルサイトではOracleシステム識別子またはSIDと記載されています。

この部品が前提とするサーバを次に示します。

・OracleDBサーバ(実行対象サーバ)

　OracleDBがインストールされているサーバです。

利用場面

この部品は，停止中のOracleDBインスタンスを起動する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象システム内前提製品】

(1)OracleDBサーバ

　・Oracle 11g Standard/Enterprise

【実行対象システム内前提製品の稼働OS】

(1)OracleDBサーバ

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Enterprise/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　ただし，OracleDBの要求を満たすもの。

【実行対象システム内前提製品の使用条件】

(1)OracleDBサーバに関する条件

　・OracleDBが正常にインストール済みであること。

　・SQL*Plusがインストール済みであること。

　・指定したOracleシステム識別子(SID)に対応するOracleDBインスタンスが停止していること。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) プロパティ「Oracleシステム識別子(SID)」(database.oracleSid)に指定したOracleシステム識別子(以降，「OracleSID」と呼びます)については，英大文字と小文字を区別します。次に示す禁止文字をOracleSIDに含める事はできません。またこれら以外にもOracle側で制限を設けている場合があります。これら以外の制限についてはOracleDBの仕様をご参照下さい。

禁止文字:

・改行文字(¥n)

・半角スペース( )

・セミコロン(;)

(3) OracleSIDに対応するOracleDBインスタンス(以降，「対象のインスタンス」と呼びます)が停止していない場合や，既に起動済みの場合は，この部品が異常終了します。

(4) プロパティ「実行対象サーバのホスト名」(plugin.destinationHost)に指定したOracleDBサーバ(以降，「DBサーバ」と呼びます)の稼働OSがWindowsの場合，この部品はレジストリーを参照して，指定されたOracleSIDと対応するインストール先フォルダを取得します。何らかの事情によってレジストリーがインストール直後の状態から更新されているなど，実際のインストール先フォルダとの対応情報を正しく取得できない場合は，対象のインスタンスが存在しないかまたはOracleDBがインストールされていないと認識してこの部品が異常終了します。

(5) DBサーバの稼働OSがUNIXの場合，この部品はOracleDBのインストーラーが作成した"oratab"ファイルを参照して，指定されたOracleSIDと対応するインストール先フォルダを取得します。何らかの事情によって"oratab"ファイルがインストール直後の状態から更新，移動，或いは削除されているなど，実際のインストール先フォルダとの対応情報を正しく取得できない場合は，対象のインスタンスが存在しないかまたはOracleDBがインストールされていないと認識してこの部品が異常終了します。

(6) 対象のインスタンスに設定しているエンコード種別はDBサーバの稼働OSで選択しているエンコード種別と一致している必要があります。一致していない場合は，エラーや誤動作が発生する事があります。

(7) この部品が異常終了する時，「ORA-」で始まるエラーコードとメッセージがタスクログに表示されることがあります。そのような場合は，OracleDBのマニュアルサイトなどでこのエラーコードを検索して下さい。

実行権限

・Windowsの場合は，ora_dbaグループに属するユーザーであること。

・UNIXの場合は，OSDBAグループに属するユーザーであること。

バージョン

02.00.00

部品のタグ

Control Database,Oracle Database

タスクログに表示される部品の名称

dbStartOracleInstance

戻り値

戻り値

説明

0

正常

1

異常(既に起動済み) 対象のOracleDBインスタンスが起動済み

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

database.oracleSid

Oracleシステム識別子(SID)

対象のOracleDBインスタンスを示すシステム識別子(SID)を指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.9.2　OracleDBインスタンスの停止

機能

OracleDBサーバ上のOracleDBインスタンスを停止します。

プロパティ「実行対象サーバのホスト名」(plugin.destinationHost)に指定したOracleDBサーバ(以降，「DBサーバ」と呼ぶ)上で，SQL*PlusのSHUTDOWNコマンドをIMMEDIATEオプションで実行します。

同コマンドは同期的に実行します。

このドキュメント内で使用しているOracleに関する用語を次に示します。

・OracleDBインスタンス

　DBサーバにインストールされているDBのインスタンスです。

同一のDBサーバ上に複数のインスタンスが存在することができ，各々のインスタンスはDBサーバ内でユニークな識別名(後述の「Oracleシステム識別子(SID)」)と固有のインストール先フォルダを持っています。

また，インスタンスはDBのテーブル領域やDBユーザーのアカウント情報や権限設定情報らを束ねる存在でもあります。

・SQL*Plus

　OracleDBに同梱されているユーティリティツールです。

コマンドラインインタフェイス(CLI)でOracleDBを操作・保守する為の独自なコマンドを有しているほか，SQL文を実行するDBクライアント機能を備えています。

・Oracleシステム識別子名(SID)

　OracleDBインスタンスの識別名です。

　Oracleのマニュアルサイトではシステム識別子またはSIDと記載されています。

この部品が前提とするサーバを次に示します。

・OracleDBサーバ(実行対象サーバ)

　OracleDBがインストールされているサーバです。

利用場面

この部品は，起動中のOracleDBインスタンスを停止する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象システム内前提製品】

(1)OracleDBサーバ

　・Oracle 11g Standard/Enterprise

【実行対象システム内前提製品の稼働OS】

(1)OracleDBサーバ

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Enterprise/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　ただし，OracleDBの要求を満たすもの。

【実行対象システム内前提製品の使用条件】

(1)OracleDBサーバに関する条件

　・OracleDBが正常にインストール済みであること。

　・SQL*Plusがインストール済みであること。

　・指定したOracleシステム識別子(SID)に対応するOracleDBインスタンスが停止または起動していること。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) プロパティ「Oracleシステム識別子(SID)」(database.oracleSid)に指定したOracleシステム識別子(以降，「OracleSID」と呼びます)については，英大文字と小文字を区別します。次に示す禁止文字をOracleSIDに含める事はできません。またこれら以外にもOracle側で制限を設けている場合があります。これら以外の制限についてはOracleDBの仕様をご参照下さい。

禁止文字:

・改行文字(¥n)

・半角スペース( )

・セミコロン(;)

(3) OracleSIDに対応するOracleDBインスタンス(以降，「対象のインスタンス」と呼びます)が既に停止している場合は，この部品が戻り値0で正常終了します。インスタンスの状態によっては，部品が戻り値27で異常終了しても，実際のインスタンスが正常に停止するケースがあります。

(4) プロパティ「実行対象サーバのホスト名」(plugin.destinationHost)に指定したOracleDBサーバ(以降，「DBサーバ」と呼びます)の稼働OSがWindowsの場合，この部品はレジストリーを参照して，指定されたOracleSIDと対応するインストール先フォルダを取得します。何らかの事情によってレジストリーがインストール直後の状態から更新されているなど，実際のインストール先フォルダとの対応情報を正しく取得できない場合は，対象のインスタンスが存在しないかまたはOracleDBがインストールされていないと認識してこの部品が異常終了します。

(5) DBサーバの稼働OSがUNIXの場合，この部品はOracleDBのインストーラーが作成した"oratab"ファイルを参照して，指定されたOracleSIDと対応するインストール先フォルダを取得します。何らかの事情によって"oratab"ファイルがインストール直後の状態から更新，移動，或いは削除されているなど，実際のインストール先フォルダとの対応情報を正しく取得できない場合は，対象のインスタンスが存在しないかまたはOracleDBがインストールされていないと認識してこの部品が異常終了します。

(6) 対象のインスタンスに設定しているエンコード種別はDBサーバの稼働OSで選択しているエンコード種別と一致している必要があります。一致していない場合は，エラーや誤動作が発生する事があります。

(7) DBインスタンス停止時は，コールの完了またはユーザーによるデータベース接続の切断を待ちません。コミットしていないデータは破棄されます。

(8) この部品が異常終了する時，「ORA-」で始まるエラーコードとメッセージがタスクログに表示されることがあります。そのような場合は，OracleDBのマニュアルサイトなどでこのエラーコードを検索して下さい。

実行権限

・Windowsの場合は，ora_dbaグループに属するユーザーであること。

・UNIXの場合は，OSDBAグループに属するユーザーであること。

バージョン

02.00.00

部品のタグ

Control Database,Oracle Database

タスクログに表示される部品の名称

dbStopOracleInstance

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

database.oracleSid

Oracleシステム識別子(SID)

対象のOracleDBインスタンスを示すシステム識別子(SID)を指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.9.3　OracleDBユーザーの削除

機能

OracleDBサーバから既存のDBユーザーを削除します。

プロパティ「実行対象サーバのホスト名」(plugin.destinationHost)に指定したOracleDBサーバ(以降，「DBサーバ」と呼ぶ)上で，SQL*Plusを起動し，"DROP USER"文を実行します。"CASCADE"は指定しません。

このドキュメント内で使用しているOracleに関する用語を次に示します。

・OracleDBインスタンス

　DBサーバにインストールされているDBのインスタンスです。

同一のDBサーバ上に複数のインスタンスが存在することができ，各々のインスタンスはDBサーバ内でユニークな識別名(後述の「Oracleシステム識別子(SID)」)と固有のインストール先フォルダを持っています。

また，インスタンスはDBのテーブル領域やDBユーザーのアカウント情報や権限設定情報らを束ねる存在でもあります。

・SQL*Plus

　OracleDBに同梱されているユーティリティツールです。

コマンドラインインタフェイス(CLI)でOracleDBを操作・保守する為の独自なコマンドを有しているほか，SQL文を実行するDBクライアント機能を備えています。

・Oracleシステム識別子(SID)

　OracleDBインスタンスの識別名です。

　Oracleのマニュアルサイトではシステム識別子またはSIDと記載されています。

この部品が前提とするサーバを次に示します。

・OracleDBサーバ(実行対象サーバ)

　OracleDBがインストールされているサーバです。

利用場面

この部品は，起動中のOracleDBインスタンスにあるDBユーザーを削除する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象システム内前提製品】

(1)OracleDBサーバ

　・Oracle 11g Standard/Enterprise

【実行対象システム内前提製品の稼働OS】

(1)OracleDBサーバ

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Enterprise/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　ただし，OracleDBの要求を満たすもの。

【実行対象システム内前提製品の使用条件】

(1)OracleDBサーバに関する条件

　・OracleDBが正常にインストール済みであること。

　・SQL*Plusがインストール済みであること。

　・指定したOracleシステム識別子(SID)に対応するOracleDBインスタンスが起動していること。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) プロパティ「Oracleシステム識別子(SID)」(database.oracleSid)に指定したOracleシステム識別子(以降，「OracleSID」と呼びます)については，英大文字と小文字を区別します。次に示す禁止文字をOracleSIDに含める事はできません。またこれら以外にもOracle側で制限を設けている場合があります。これら以外の制限についてはOracleDBの仕様をご参照下さい。

禁止文字:

・改行文字(¥n)

・半角スペース( )

・セミコロン(;)

(3) プロパティ「DBユーザーID」(database.dbUserId)に指定できる値は，(2)の禁止文字を含まない30バイト以下の文字列である必要があります。このほかの禁止文字についてはOracleDBの仕様をご参照下さい。また英大文字と小文字は区別されます。

(4) プロパティ「実行対象サーバのホスト名」(plugin.destinationHost)に指定したOracleDBサーバ(以降，「DBサーバ」と呼びます)の稼働OSがWindowsの場合，この部品はレジストリーを参照して，指定されたOracleSIDと対応するインストール先フォルダを取得します。何らかの事情によってレジストリーがインストール直後の状態から更新されているなど，実際のインストール先フォルダとの対応情報を正しく取得できない場合は，OracleSIDに対応するOracleDBインスタンス(以降，「対象のインスタンス」と呼びます)が存在しないかまたはOracleDBがインストールされていないと認識してこの部品が異常終了します。

(5) DBサーバの稼働OSがUNIXの場合，この部品はOracleDBのインストーラーが作成した"oratab"ファイルを参照して，指定されたOracleSIDと対応するインストール先フォルダを取得します。何らかの事情によって"oratab"ファイルがインストール直後の状態から更新，移動，或いは削除されているなど，実際のインストール先フォルダとの対応情報を正しく取得できない場合は，対象のインスタンスが存在しないかまたはOracleDBがインストールされていないと認識してこの部品が異常終了します。

(6) 対象のインスタンスに設定しているエンコード種別はDBサーバの稼働OSで選択しているエンコード種別と一致している必要があります。一致していない場合は，エラーや誤動作が発生する事があります。

(7) この部品が異常終了する時，「ORA-」で始まるエラーコードとメッセージがタスクログに表示されることがあります。そのような場合は，OracleDBのマニュアルサイトなどでこのエラーコードを検索して下さい。

実行権限

・Windowsの場合は，ora_dbaグループに属するユーザーであること。

・UNIXの場合は，OSDBAグループに属するユーザーであること。

バージョン

02.00.00

部品のタグ

Control Database,Oracle Database

タスクログに表示される部品の名称

dbDeleteOracleUser

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

database.oracleSid

Oracleシステム識別子(SID)

対象のOracleDBインスタンスを示すシステム識別子(SID)を指定します。

−　

入力

○　

database.dbUserId

DBユーザーID

削除するDBユーザーを識別するユーザーIDを指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.9.4　OracleDBユーザーの追加(UNIX)

機能

UNIXのOracleDBサーバに新たなDBユーザーを追加します。

プロパティ「実行対象サーバのホスト名」(plugin.destinationHost)に指定したOracleDBサーバ(以降，「DBサーバ」と呼ぶ)上で，SQL*Plusを起動し，"CREATE USER"文を実行します。

プロパティ「DB権限」(database.dbPrivilege)には，SQL*Plusで"GRANT"文を記述する場合と同様にシステム権限やオブジェクト権限やロールの名称をコンマ区切りで指定できます。DB権限を指定した場合は，"CREATE USER"文に続けて"GRANT"文を実行します。"GRANT"文に"WITH HIERARCY OPTION"や"WITH GRANT OPTION"は指定しません。

DB権限に何も指定しなかった場合は，権限の全く無いDBユーザーを追加します。

この部品を利用するサービスでは，DBサーバ上のディレクトリに一時ファイルを作成してDBユーザーパスワードを格納し，その一時ファイルへのフルパスをプロパティ「パスワードファイルのパス(リモート)」(common.passwordFilePass)に指定する必要があります。

このドキュメント内で使用しているOracleに関する用語を次に示します。

・OracleDBインスタンス

　DBサーバにインストールされているDBのインスタンスです。

同一のDBサーバ上に複数のインスタンスが存在することができ，各々のインスタンスはDBサーバ内でユニークな識別名(後述の「Oracleシステム識別子(SID)」)と固有のインストール先フォルダを持っています。

また，インスタンスはDBのテーブル領域やDBユーザーのアカウント情報や権限設定情報らを束ねる存在でもあります。

・SQL*Plus

　OracleDBに同梱されているユーティリティツールです。

コマンドラインインタフェイス(CLI)でOracleDBを操作・保守する為の独自なコマンドを有しているほか，SQL文を実行するDBクライアント機能を備えています。

・Oracleシステム識別子(SID)

　OracleDBインスタンスの識別名です。

　Oracleのマニュアルサイトではシステム識別子またはSIDと記載されています。

・システム権限

OracleDBの仕様を参照して下さい。

・オブジェクト権限

OracleDBの仕様を参照して下さい。

・ロール

OracleDBの仕様を参照して下さい。

この部品が前提とするサーバを次に示します。

・OracleDBサーバ(実行対象サーバ)

　OracleDBがインストールされているサーバです。

利用場面

この部品は，起動中のOracleDBインスタンスに新たなDBユーザーを追加する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象システム内前提製品】

(1)OracleDBサーバ

　・Oracle 11g Standard/Enterprise

【実行対象システム内前提製品の稼働OS】

(1)OracleDBサーバ

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　ただし，OracleDBの要求を満たすもの。

【実行対象システム内前提製品の使用条件】

(1)OracleDBサーバに関する条件

　・OracleDBが正常にインストール済みであること。

　・SQL*Plusがインストール済みであること。

　・指定したOracleシステム識別子(SID)に対応するOracleDBインスタンスが起動していること。

注意事項

(1) プロパティ「Oracleシステム識別子(SID)」(database.oracleSid)に指定したOracleシステム識別子(以降，「OracleSID」と呼びます)については，英大文字と小文字を区別します。次に示す禁止文字をOracleSIDに含める事はできません。またこれら以外にもOracle側で制限を設けている場合があります。これら以外の制限についてはOracleDBの仕様をご参照下さい。

禁止文字:

・二重引用符(")及び引用符(')

・改行文字(¥n)

・半角スペース( )

・セミコロン(;)

(2) プロパティ「DBユーザーID」(database.dbUserId)に指定できる値は，(1)の禁止文字を含まない30バイト以下の文字列で，更に予約語と衝突しない内容である必要があります。予約語とこのほかの禁止文字についてはOracleDBの仕様をご参照下さい。

(3) プロパティ「パスワードファイルパス(リモート)」(database.passwordFilePath)に指定したファイル(以降，「パスワードファイル」と呼びます)はテキストファイルで且つ，1行目にパスワードが格納されている必要があります。パスワードは(1)の禁止文字を含まない30バイト以下の文字列である必要があります。このほかの禁止文字についてはOracleDBの仕様をご参照下さい。また英大文字と小文字は区別されます。

(4) プロパティ「DB権限」(database.dbPrivilege)に(1)の半角スペースを除いた禁止文字を含める事はできません。更に予約語と衝突しない内容である必要があります。予約語とこのほかの禁止文字についてはOracleDBの仕様をご参照下さい。また英大文字小文字は区別されません。存在しない権限名を指定した場合，この部品が異常終了しますがDB権限のないDBユーザーが残ります。必要に応じて削除して下さい。

(5) この部品はOracleDBのインストーラーが作成した"oratab"ファイルを参照して，指定されたOracleSIDと対応するインストール先フォルダを取得します。何らかの事情によって"oratab"ファイルがインストール直後の状態から更新，移動，或いは削除されているなど，実際のインストール先フォルダとの対応情報を正しく取得できない場合は，OracleSIDに対応するOracleDBインスタンス(以降，「対象のインスタンス」と呼びます)が存在しないかまたはOracleDBがインストールされていないと認識してこの部品が異常終了します。

(6) 対象のインスタンスに設定しているエンコード種別はDBサーバの稼働OSで選択しているエンコード種別と一致している必要があります。またパスワードファイルのエンコード種別もこれらと一致している必要があります。一致していない場合は，エラーや誤動作が発生する事があります。

(7) パスワードファイルが指定のフォルダから読み込めなかったり，内容が不正だったりした場合は，この部品が異常終了します。また正常終了の場合でも，当部品は処理終了時にパスワードファイルを削除しません。

(8) この部品が異常終了する時，「ORA-」で始まるエラーコードとメッセージがタスクログに表示されることがあります。そのような場合は，OracleDBのマニュアルサイトなどでこのエラーコードを検索して下さい。

実行権限

・OSDBAグループに属するユーザーであること。

バージョン

02.00.00

部品のタグ

Control Database,Oracle Database

タスクログに表示される部品の名称

dbAddOracleUser_Unix

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

database.oracleSid

Oracleシステム識別子(SID)

対象のOracleDBインスタンスを示すシステム識別子(SID)を指定します。

−　

入力

○　

database.dbUserId

DBユーザーID

新規DBユーザーに付与するユーザーIDを指定します。

−　

入力

○　

common.passwordFilePath

パスワードファイルのパス(リモート)

パスワードを格納したテキストファイルをフルパスで指定します。

−　

入力

○　

database.dbPrivilege

DB権限

新規DBユーザーに付与する権限名のリストをコンマ区切りで指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.9.5　OracleDBユーザーの追加(Windows)

機能

WindowsのOracleDBサーバに新たなDBユーザーを追加します。

プロパティ「実行対象サーバのホスト名」(plugin.destinationHost)に指定したOracleDBサーバ(以降，「DBサーバ」と呼ぶ)上で，SQL*Plusを起動し，"CREATE USER"文を実行します。

プロパティ「DB権限」(database.dbPrivilege)には，SQL*Plusで"GRANT"文を記述する場合と同様にシステム権限やオブジェクト権限やロールの名称をコンマ区切りで指定できます。DB権限を指定した場合は，"CREATE USER"文に続けて"GRANT"文を実行します。"GRANT"文に"WITH HIERARCY OPTION"や"WITH GRANT OPTION"は指定しません。

DB権限に何も指定しなかった場合は，権限の全く無いDBユーザーを追加します。

このドキュメント内で使用しているOracleに関する用語を次に示します。

・OracleDBインスタンス

　DBサーバにインストールされているDBのインスタンスです。

同一のDBサーバ上に複数のインスタンスが存在することができ，各々のインスタンスはDBサーバ内でユニークな識別名(後述の「Oracleシステム識別子(SID)」)と固有のインストール先フォルダを持っています。

また，インスタンスはDBのテーブル領域やDBユーザーのアカウント情報や権限設定情報らを束ねる存在でもあります。

・SQL*Plus

　OracleDBに同梱されているユーティリティツールです。

コマンドラインインタフェイス(CLI)でOracleDBを操作・保守する為の独自なコマンドを有しているほか，SQL文を実行するDBクライアント機能を備えています。

・Oracleシステム識別子(SID)

　OracleDBインスタンスの識別名です。

　Oracleのマニュアルサイトではシステム識別子またはSIDと記載されています。

・システム権限

OracleDBの仕様を参照して下さい。

・オブジェクト権限

OracleDBの仕様を参照して下さい。

・ロール

OracleDBの仕様を参照して下さい。

この部品が前提とするサーバを次に示します。

・OracleDBサーバ(実行対象サーバ)

　OracleDBがインストールされているサーバです。

利用場面

この部品は，起動中のOracleDBインスタンスに新たなDBユーザーを追加する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象システム内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象システム内前提製品】

(1)OracleDBサーバ

　・Oracle 11g Standard/Enterprise

【実行対象システム内前提製品の稼働OS】

(1)OracleDBサーバ

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Enterprise/Datacenter

　ただし，OracleDBの要求を満たすもの。

【実行対象システム内前提製品の使用条件】

(1)OracleDBサーバに関する条件

　・OracleDBが正常にインストール済みであること。

　・SQL*Plusがインストール済みであること。

　・指定したOracleシステム識別子(SID)に対応するOracleDBインスタンスが起動していること。

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) プロパティ「Oracleシステム識別子(SID)」(database.oracleSid)に指定したOracleシステム識別子(以降，「OracleSID」と呼びます)については，英大文字と小文字を区別します。次に示す禁止文字をOracleSIDに含める事はできません。またこれら以外にもOracle側で制限を設けている場合があります。これら以外の制限についてはOracleDBの仕様をご参照下さい。

禁止文字:

・改行文字(¥n)

・半角スペース( )

・セミコロン(;)

(3) プロパティ「DBユーザーID」(database.dbUserId)と「DBユーザーパスワード」(database.dbUserPassword)に指定できる値は，(2)の禁止文字を含まない30バイト以下の文字列である必要があります。このほかの禁止文字についてはOracleDBの仕様をご参照下さい。また英大文字と小文字は区別されます。

(4) プロパティ「DB権限」(database.dbPrivilege)に(2)の半角スペースを除いた禁止文字を含める事はできません。更に予約語と衝突しない内容である必要があります。予約語とこのほかの禁止文字についてはOracleDBの仕様をご参照下さい。また英大文字小文字は区別されません。存在しない権限名を指定した場合，この部品が異常終了しますがDB権限のないDBユーザーが残ります。必要に応じて削除して下さい。

(5) この部品はレジストリーを参照して，指定されたOracleSIDと対応するインストール先フォルダを取得します。何らかの事情によってレジストリーがインストール直後の状態から更新されているなど，実際のインストール先フォルダとの対応情報を正しく取得できない場合は，OracleSIDに対応するOracleDBインスタンス(以降，「対象のインスタンス」と呼びます)が存在しないかまたはOracleDBがインストールされていないと認識してこの部品が異常終了します。

(6) 対象のインスタンスに設定しているエンコード種別はDBサーバの稼働OSで選択しているエンコード種別と一致している必要があります。一致していない場合は，エラーや誤動作が発生する事があります。

(7) この部品を利用するサービスでは，プロパティ「DBユーザーパスワード」(database.dbUserPassword)にマッピングするプロパティをパスワード型で扱ってください。

(8) この部品が異常終了する時，「ORA-」で始まるエラーコードとメッセージがタスクログに表示されることがあります。そのような場合は，OracleDBのマニュアルサイトなどでこのエラーコードを検索して下さい。

実行権限

・ora_dbaグループに属するユーザーであること。

バージョン

02.00.00

部品のタグ

Control Database,Oracle Database

タスクログに表示される部品の名称

dbAddOracleUser_Win

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

database.oracleSid

Oracleシステム識別子(SID)

対象のOracleDBインスタンスを示すシステム識別子(SID)を指定します。

−　

入力

○　

database.dbUserId

DBユーザーID

新規DBユーザーに付与するユーザーIDを指定します。

−　

入力

○　

database.dbUserPassword

DBユーザーパスワード

新規DBユーザーに付与するパスワードを指定します。

−　

入力

○　

database.dbPrivilege

DB権限

新規DBユーザーに付与する権限名のリストをコンマ区切りで指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.10　OS関連の部品

5.10.1　スタティックルートの設定

機能

WindowsまたはLinuxの実行対象サーバで，スタティックルートを設定します。

利用場面

複数のLANに接続されている場合など，特定のネットワークに対する通信にスタティックルートを設定したい場合に利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　(1)JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバの稼働OS】

(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

(3) Windows Server 2016 Standard/Datacenter

(4) Windows Server 2019 Standard/Datacenter

(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・net-toolsパッケージがインストールされていること。

(7) CentOS 6 (64-bit x86_64)

(8) CentOS 7 (64-bit x86_64)

　・net-toolsパッケージがインストールされていること。

【実行対象サーバの使用条件】

なし。

注意事項

(1)宛先IPアドレス，サブネットマスク，デフォルトゲートウェイは，同時に指定してください。どれかの指定がない場合，スタティックルートの設定は行われません。

バージョン

02.00.00

部品のタグ

Configure OS,Windows,Linux

タスクログに表示される部品の名称

osSetStaticRoute

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

14

異常(ユーザーミス) ファイルアクセス不可

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

OS.destIPAddress

スタティックルートの宛先IPアドレス

スタティックルートを設定する宛先ネットワークのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.subnetMaskStaticRoute

サブネットマスク(スタティックルート用)

スタティックルート用のサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.defaultGWStaticRoute

デフォルトゲートウェイ(スタティックルート用)

スタティックルート用のデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11　vSphere関連の部品

5.11.1　DRSクラスタのDRS自動化レベル設定

機能

VMware vSphere環境で，vSphere DRSクラスタに属している仮想サーバに対し，DRS自動化レベルを設定します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・DRSクラスタ

　vSphere DRSクラスタまたはvSphere DRSクラスタを構成しているサーバです。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです。

この部品内のスクリプトでは次に示す処理を行います。

・次のコマンドレットを実行します。

　Set-VM -VM VirtualMachineオブジェクト※1

　　　　 -DrsAutomationLevel "DRS自動化レベル(VMware.drsAutomationLevelプロパティ)の値"

　　　　 -Confirm:$false

　※1 仮想サーバ名(VMware.vmNameプロパティ)の値から取得したオブジェクト

　Set-VMコマンドレットの詳細については，vSphere PowerCLI Documentationの「Cmdlet Reference」を参照してください。

DRS自動化レベル(VMware.drsAutomationLevelプロパティ)について次に示します。

・仮想サーバに設定するDRS自動化レベルを指定します。

・指定できる値を次に示します。

　設定値　　　　　　　　　　意味

　　FullyAutomated　　　　　　完全自動化

　　PartiallyAutomated　　　　一部自動化

　　Manual　　　　　　　　　　手動

　　AsSpecifiedByCluster　　　クラスタ設定の使用

　　Disabled　　　　　　　　　無効

利用場面

構築済みのDRSクラスタに追加した仮想サーバに対して「DRS自動化レベル」を設定する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(2)仮想サーバを管理するVMware vSphere ESXの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXiがVMware vCenter Serverで管理されていること。

(2)VMware vCenter Server上の設定に関する条件

　・仮想サーバの名称が一意であること。

　・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，この部品が実行するvSphere Power CLIからは，指定した名称の英字の大文字・小文字を区別できません。

　　そのため，英字の大文字・小文字が異なる同名の名称を使用している環境に対して，この部品を使用することはできません。

　　- 仮想サーバ名

(3)仮想サーバがvSphere DRSクラスタに所属していること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。

バージョン

02.11.00

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereSetDRSAutomationLevel

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します（VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません）。

−　

入力

○　

VMware.drsAutomationLevel

DRS自動化レベル

仮想サーバに設定するDRS自動化レベルを指定します。指定可能な値は，"FullyAutomated"，"PartiallyAutomated"，"Manual"，"AsSpecifiedByCluster"，"Disabled"です。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.2　DRSルール(仮想サーバからホストへ)の追加

機能

VMware vSphere環境で，vSphere DRSクラスタのDRSルール(仮想サーバからホストへ)を追加します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXiがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・DRSクラスタ

　vSphere DRSクラスタまたはvSphere DRSクラスタを構成しているサーバです。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです。

DRSルール(VMware.drsRuleプロパティ)について次に示します。

・指定できる値を次に示します。

　設定値　　　　意味

　　Must　　　　　グループ内のホスト上で実行する必要があります

　　Should　　　　グループ内のホスト上で実行してください

　　ShouldNot　 　グループ内のホスト上で実行することはできません

　　MustNot 　　　グループ内のホスト上で実行しないでください

利用場面

DRSクラスタ環境にESXサーバや，仮想サーバを追加した際に，ホストDRSグループと仮想サーバDRSグループに対してDRSルールを追加する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(2)仮想サーバを管理するVMware vSphere ESXの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXがVMware vCenter Serverで管理されていること。

(2)VMware vCenter Server上の設定に関する条件

　・vSphere DRSクラスタの名称が一意であること。

　・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，この部品が実行するvSphere Power CLIからは，指定した名称の英字の大文字・小文字を区別できません。

　　そのため，英字の大文字・小文字が異なる同名の名称を使用している環境に対して，この部品を使用することはできません。

　　- DRSクラスタ名

　　- DRSグループ名(ホストDRSグループ名および仮想サーバDRSグループ名)

(3)vSphere DRSクラスタが構築されており，かつホストDRSグループおよび仮想サーバDRSグループが設定されていること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。

バージョン

02.11.00

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereSetDRSRuleVmToHost

戻り値

戻り値

説明

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.drsClusterName

DRSクラスタ名

VMware vCenter Serverが管理するvSphere DRSクラスタ名を指定します。

−　

入力

○　

VMware.drsRuleName

DRSルール名

DRSルールの名称を指定します。

−　

入力

○　

VMware.hostDrsGroupName

ホストDRSグループ名

DRSルールに設定するホストDRSグループの名称を指定します。

−　

入力

○　

VMware.vmDrsGroupName

仮想サーバDRSグループ名

DRSルールに設定する仮想サーバDRSグループの名称を指定します。

−　

入力

○　

VMware.drsRule

DRSルール

設定するDRSルールを指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.3　ESXサーバのメンテナンスモード設定

機能

VMware vSphere環境で，ESXサーバに対して「メンテナンスモードへの切り替え」，または「メンテナンスモードを終了」を実行します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXiがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです。

メンテナンスモード(VMware.esxSetMaintenanceModeプロパティ)について次に示します。

・メンテナンスモードに切り替える場合は"ON"を，メンテナンスモードを終了する場合は"OFF"を指定してください。

利用場面

ESXサーバのメンテナンス時にメンテナンスモードへの切り替え，またはメンテナンスモードを終了する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(2)仮想サーバを管理するVMware vSphere ESXの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXがVMware vCenter Serverで管理されていること。

(2)VMware vSphere ESXの状態が「接続中」または「接続中(メンテナンス モード)」であること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)ESXサーバがメンテナンスモードの場合に，メンテナンスモード(VMware.esxSetMaintenanceModeプロパティ)に"ON"を指定するとメンテナンスモードへの切り替えをせず，この部品は正常終了します。また，ESXサーバがメンテナンスモードでない場合に，メンテナンスモード(VMware.esxSetMaintenanceModeプロパティ)に"OFF"を指定するとメンテナンスモードの終了をせず，この部品は正常終了します。

(3)クラスタに所属しているESXサーバをメンテナンスモードに切り替える際に，ESXサーバ名(VMware.vmHostNameプロパティ)に指定したESXサーバ上にパワーオフまたはサスペンド中の仮想サーバが存在する場合，仮想サーバを同一のクラスタに所属している別のESXサーバに移動しません。パワーオフまたはサスペンド中の仮想サーバを移動する必要がある場合は，事前に仮想サーバを移動してください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。

バージョン

02.11.00

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereSetMaintenanceMode

戻り値

戻り値

説明

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmHostName

ESXサーバ名

VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。

−　

入力

○　

VMware.esxSetMaintenanceMode

メンテナンスモード

メンテナンスモードへ切り替える場合は"ON"を，メンテナンスモードを終了する場合は"OFF"を指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.4　ESXサーバの移動

機能

VMware vSphere環境で，ESXサーバを指定したデータセンター，クラスタ，フォルダに移動します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXiがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです。

ESXサーバの移動先(VMware.esxDestinationNameプロパティ)について次に示します。

・指定できる移動先は，データセンター，クラスタ，フォルダのどれかです。

利用場面

ESXサーバのメンテナンス時などにクラスタ運用からスタンドアロン運用に移行，またはスタンドアロン運用からクラスタ運用に移行する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(2)仮想サーバを管理するVMware vSphere ESXの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXがVMware vCenter Serverで管理されていること。

(2)VMware vCenter Server上の設定に関する条件

　・データセンター，クラスタ，フォルダの名称が一意であること。

　　データセンターとクラスタ，データセンターとフォルダの組み合わせなど，種別が異なっていても，同じ名前にすることはできません。

　・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，この部品が実行するvSphere Power CLIからは，指定した名称の英字の大文字・小文字を区別できません。

　　そのため，英字の大文字・小文字が異なる同名の名称を使用している環境に対して，この部品を使用することはできません。

　　- データセンター名，クラスタ名およびフォルダ名

(3)移動先にクラスタを指定する場合は，vSphere HAクラスタまたはvSphere DRSクラスタが構築されていること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)この部品は，ESXサーバを移動する際にESXサーバの状態変更をしません。クラスタを構成しているESXサーバを移動する際に，ESXサーバの状態がメンテナンスモードでない場合，ESXサーバの移動に失敗し，この部品が異常終了することがあります。その場合は，ESXサーバの状態をメンテナンスモードに変更した上で，この部品を実行してください。

(3)ESXサーバの移動先(VMware.esxDestinationNameプロパティ)にクラスタを指定した場合，ESXを移動する際にリソースプールを作成しません。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。

バージョン

02.11.00

部品のタグ

Migrate VM,VMware vSphere

タスクログに表示される部品の名称

vsphereMoveEsx

戻り値

戻り値

説明

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmHostName

ESXサーバ名

VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。

−　

入力

○　

VMware.esxDestinationName

ESXサーバの移動先

移動先のデータセンター，クラスタ，フォルダの名称を指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.5　ESXサーバの仮想ネットワーク情報一覧取得部品

機能

VMware vSphere環境で，ESXサーバの仮想ネットワーク情報の一覧を取得します。

出力ファイルパス(common.outputFilePathプロパティ)に指定したファイルに，ESXサーバの仮想ネットワーク情報一覧をCSV形式で出力します。

出力ファイルのエンコード形式は，実行対象サーバのシステムデフォルトエンコードです。

この部品が前提とするサーバを次に示します。

・ESXサーバ

　VMware vSphere ESXiがインストールされているサーバです。

・実行対象サーバ

　VMware vSphere PowerCLIがインストールされているサーバです。本製品によってこのサーバに部品が転送され，実行されます。

この部品内のスクリプトでは，次に示すVMware vSphere PowerCLIのコマンドレットを実行し特定の項目を参照します。

・Get-EsxTop -CounterName "NetPort"※1

・ClientName (仮想マシン名，Kernelポート名などインタフェース名)

・TeamUplink (有効アダプタ名)

・Get-VirtualSwitch

・Name (仮想スイッチ名)

・Nic (アダプタ名)

※1 Option「CounterName」に指定する"NetPort"は固定値

上記2つのコマンドレットの実行結果から，Get-VirtualSwitch.NicがGet-EsxTop.TeamUplinkと一致する値を取得します。

出力するCSVファイルの項目を次に示します。

項目はコンマ区切りで出力します。

(a)インタフェース名(ヘッダー名：ClientName)

(b)アダプタ名(ヘッダー名：TeamUplink)

(c)仮想スイッチ名(ヘッダー名：DNAME)

CSVファイル出力例

"ClientName","TeamUplink","DNAME"

"vmk0","vmnic0","vSwitch0"

"vm01","vmnic1","vSwitch1"

利用場面

ESXサーバの仮想ネットワークで有効なアダプタを参照する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)仮想サーバを管理するVMware vSphere ESXの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

【実行対象システム内前提製品の使用条件】

　・特になし。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)出力ファイルパス(common.outputFilePathプロパティ)に指定したファイルが既に存在する場合，既存のファイルを上書きします。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(3)出力ファイルパス(common.outputFilePathプロパティ)に指定したファイルを作成するフォルダが存在しない場合は，そのフォルダを作成します。

実行権限

(1)ESXサーバに接続するユーザーに，システム管理者ロールの権限が必要です。

バージョン

02.11.00

部品のタグ

Gather VM information,VMware vSphere

タスクログに表示される部品の名称

vsphereOutputVmNetworkInfo

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.ESXServerName

ESXサーバ名

ESXサーバのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.ESXUserName

ESXサーバに接続するためのユーザー名

ESXサーバに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.ESXPassword

ESXサーバに接続するためのパスワード

ESXサーバに接続するためのパスワードを指定します。

−　

入力

○　

VMware.ESXPortNumber

ESXサーバ接続用ポート番号

ESXサーバに接続するためのポート番号を指定します。

443

入力

△　

VMware.ESXProtocol

ESXサーバ接続用プロトコル

ESXサーバに接続するためのプロトコルを指定します。

HTTPS

入力

△　

common.outputFilePath

出力ファイルのパス

出力するファイルをフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

−　

5.11.6　FCパスの優先設定

機能

VMware vSphere ESXi(またはVMware ESX Server)の指定したデータストアに対するFCパスを「優先」に設定します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXi(またはVMware ESX Server)がインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

利用場面

VMware vSphere ESXi(またはVMware ESX Server)のSANがマルチパス構成で，データストアのLUに対するFCパスの優先設定を行う場合に使用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)ESXサーバの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)操作対象のデータストアのパスポリシーが固定であること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　システム管理者ロール

バージョン

02.11.00

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereSetFcpath

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.dataStoreName

データストア名

FCパスの優先設定を行うデータストアの名称を指定します。

−　

入力

○　

VMware.vmHostName

ESXサーバ名

VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。

−　

入力

○　

VMware.hbaName

優先設定するHBA名

優先設定するHBAの名称を指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.7　HAクラスタの仮想サーバのオプション設定

機能

VMware vSphere環境で，vSphere HAクラスタの仮想サーバの動作を定義するオプションを設定します。

設定できる項目を次に示します。ただし，HAクラスタ名(vmware.haClusterNameプロパティ)と仮想サーバ名(VMware.vmNameプロパティ)は同時に指定できません。

・HAクラスタ名(VMware.haClusterNameプロパティ)を指定した場合。

　デフォルトのクラスタ設定の「仮想サーバ再起動の優先順位」および「ホスト隔離時の対応」を設定できます。

・仮想サーバ名(VMware.vmNameプロパティ)を指定した場合。

　仮想サーバ設定の「仮想サーバ再起動の優先順位」および「ホスト隔離時の対応」を設定できます。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXiがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・HAクラスタ

　vSphere HAクラスタまたはvSphere HAクラスタを構成しているサーバです。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです。

仮想サーバ再起動の優先順位(VMware.haRestartPriorityプロパティ)について次に示します。

・指定できる値を次に示します。ただし，"ClusterRestartPriority"は仮想サーバへの設定にだけ使用できます。

　設定値　　　　　　　　　　意味

　　Disabled　　　　　　　　　無効

　　Low　　　　 　　　　　　　低

　　Medium　　　　　　　　　　中

　　High　　　　　　　　　　　高

　　ClusterRestartPriority　　クラスタ設定の使用

ホスト隔離時の対応(VMware.haIsolationResponseプロパティ)について次に示します。

・指定できる値を次に示します。ただし，"AsSpecifiedByCluster"は仮想サーバへの設定にだけ使用できます。

　設定値　　　　　　　　　意味

　　PowerOff　　　　　　　　パワーオフ

　　DoNothing　 　　　　　　パワーオンのままにする

　　Shutdown　　　　　　　　シャットダウン

　　AsSpecifiedByCluster　　クラスタ設定の使用

利用場面

vSphere HAクラスタ構築時または設定変更時に，仮想サーバの動作を定義するオプションを設定する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(2)仮想サーバを管理するVMware vSphere ESXの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXがVMware vCenter Serverで管理されていること。

(2)VMware vCenter Server上の設定に関する条件

　・vSphere HAクラスタ，仮想サーバの名称が一意であること。

　・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，この部品が実行するvSphere Power CLIからは，指定した名称の英字の大文字・小文字を区別できません。

　　そのため，英字の大文字・小文字が異なる同名の名称を使用している環境に対して，この部品を使用することはできません。

　　- HAクラスタ名

　　- 仮想サーバ名

(3)vSphere HAクラスタが構築されていること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)HAクラスタ名(VMware.haClusterNameプロパティ)，仮想サーバ名(VMware.vmNameプロパティ)はどちらかを指定してください。どちらも指定されている，またはどちらの指定も無い場合，この部品は異常終了します。

(3)仮想サーバ再起動の優先順位(VMware.haRestartPriorityプロパティ)，ホスト隔離時の対応(VMware.haIsolationResponseプロパティ)はどちらかもしくは両方を指定してください。どちらの指定も無い場合，この部品は異常終了します。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。

バージョン

02.11.00

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereSetHaVMOption

戻り値

戻り値

説明

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.haClusterName

HAクラスタ名

VMware vCenter Serverが管理するvSphere HAクラスタ名を指定します。

−　

入力

△　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します（VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません）。

−　

入力

△　

VMware.haRestartPriority

仮想サーバ再起動の優先順位

仮想サーバ再起動の優先順位を指定します。

−　

入力

△　

VMware.haIsolationResponse

ホスト隔離時の対応

ホスト隔離時の対応を指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.8　HAクラスタの仮想サーバの監視設定

機能

VMware vSphere環境で，vSphere HAクラスタに属している仮想サーバに対し，仮想サーバの監視を設定します。

設定できる項目は「仮想サーバの監視」および「監視感度」です。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・HAクラスタ

　vSphere HAクラスタまたはvSphere HAクラスタを構成しているサーバです。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです。

仮想サーバの監視(VMware.vmMonitoringプロパティ)について次に示します。

・仮想サーバに設定する仮想サーバの監視ステータスを指定します。

・指定できる値を次に示します。

　設定値　　　　　　　　　　意味

　　vmMonitoringDisabled　　　無効

　　vmMonitoringOnly　　　　　仮想サーバの監視のみ

　　vmAndAppMonitoring　　　　仮想サーバとアプリケーションの監視

　　clusterSettings 　　　　　クラスタ設定の使用

監視感度(障害間隔)(VMware.failureIntervalプロパティ)について次に示します。

・設定する監視感度の障害間隔を秒単位で指定してください。

・1から100000までの整数値を指定してください。

監視感度(アップタイム最小値)(VMware.minUpTimeプロパティ)について次に示します。

・設定する監視感度のアップタイム最小値を秒単位で指定してください。

・1から100000までの整数値を指定してください。

監視感度(仮想サーバごとの最大リセット回数)(VMware.maxFailuresプロパティ)について次に示します。

・設定する監視感度の仮想サーバごとの最大リセット回数を指定してください。

・1から1000までの整数値を指定してください。

監視感度(リセットの最大時間帯)(VMware.maxFailureWindowプロパティ)について次に示します。

・設定する監視感度のリセットの最大時間帯を時間単位で指定してください。

・-1または1から1000までの整数値を指定してください。"-1"を指定した場合，リセットの最大時間帯に「期間なし」を設定します。

利用場面

構築済みのHAクラスタに追加した仮想サーバに対して「仮想サーバの監視」を設定する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(2)仮想サーバを管理するVMware vSphere ESXの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXiがVMware vCenter Serverで管理されていること。

(2)VMware vCenter Server上の設定に関する条件

　・仮想サーバの名称が一意であること。

　・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，この部品が実行するvSphere Power CLIからは，指定した名称の英字の大文字・小文字を区別できません。

　　そのため，英字の大文字・小文字が異なる同名の名称を使用している環境に対して，この部品を使用することはできません。

　　- 仮想サーバ名

(3)仮想サーバがvSphere HAクラスタに所属していること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)仮想サーバに対する「仮想サーバの監視」設定は，HAクラスタに設定されている「仮想サーバの監視」設定に依存します。

　 HAクラスタの設定が「無効」の場合，仮想サーバに対する設定はすべて無効になります。

　 HAクラスタの設定が「仮想サーバの監視のみ」の場合，仮想サーバに対する設定は「無効」または「仮想サーバの監視のみ」だけ有効になります。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。

バージョン

02.11.00

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereSetVMMonitoring

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します（VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません）。

−　

入力

○　

VMware.vmMonitoring

仮想サーバの監視

仮想サーバの監視ステータスを指定します。指定可能な値は，"vmMonitoringDisabled"，"vmMonitoringOnly"，"vmAndAppMonitoring"，"clusterSettings"です。

−　

入力

○　

VMware.failureInterval

監視感度(障害間隔)

監視感度の障害間隔を秒単位で指定します。

−　

入力

△　

VMware.minUpTime

監視感度(アップタイム最小値)

監視感度のアップタイム最小値を秒単位で指定します。

−　

入力

△　

VMware.maxFailures

監視感度(仮想サーバごとの最大リセット回数)

監視感度の仮想サーバごとの最大リセット回数を指定します。

−　

入力

△　

VMware.maxFailureWindow

監視感度(リセットの最大時間帯)

監視感度のリセットの最大時間帯を時間単位で指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.9　LUNの再認識

機能

追加または削除したLUをVMware vSphere ESXi(またはVMware ESX Server)に認識させます。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXi(またはVMware ESX Server)がインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

利用場面

仮想サーバ運用の中で，仮想サーバのデータ格納用LUを作成・削除したことをVMware vSphere ESXi(またはVMware ESX Server)に認識させる際に使用できます。

関連する部品を次に記載します。

・storageCreateLU2

・storageAddHostgroupLU

・vsphereGetCanonicalName

・vsphereCreateDatastore

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)ESXサーバの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　対象とするESXサーバに対して「ホスト−構成−ストレージ パーティション構成」の権限を持つロール，またはシステム管理者ロール

バージョン

02.11.00

部品のタグ

Gather VM information,VMware vSphere

タスクログに表示される部品の名称

vsphereRecognizeLU

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmHostName

ESXサーバ名

VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.10　SCSI LUNのCanonical名を取得

機能

VMware vSphere ESXi(またはVMware ESX Server)が認識しているSCSI LUNのCanonical名を取得します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXi(またはVMware ESX Server)がインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

利用場面

部品「vsphereCreateDatastore」を使用してVMware vSphere ESXi(またはVMware ESX Server)にVMFSでデータストアを作成する場合，データストア作成対象とするLUNのCanonical名を指定する必要があります。

この部品は，データストア作成時に必要となるCanonical名をプロパティVMware.canonicalNameに出力します。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)ESXサーバの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　システム管理者ロール

バージョン

02.11.00

部品のタグ

Gather VM information,VMware vSphere

タスクログに表示される部品の名称

vsphereGetCanonicalName

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmHostName

ESXサーバ名

VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。

−　

入力

○　

VMware.hbaName

HBA名

ESXサーバのHBAの名称を指定します。

−　

入力

○　

VMware.controllerNumber

SCSI LUNのコントローラ番号

SCSI LUNのコントローラ番号を指定します。

−　

入力

○　

VMware.targetNumber

SCSI LUNのターゲット番号

SCSI LUNのターゲット番号を指定します。

−　

入力

○　

VMware.luNumber

SCSI LUNのLU番号

SCSI LUNのLU番号を指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

VMware.canonicalName

Canonical名

SCSI LUNのCanonical名を格納します。

−　

出力

△　

5.11.11　vCenterサーバ経由でのスクリプト実行

機能

この部品は，VMware vSphere環境で，vCenterサーバ経由で仮想サーバのゲストOS上に配置された非対話型のスクリプトを実行します。

実行できるスクリプトは，Windows バッチ ファイル(拡張子bat)，Windows PowerShell スクリプト(拡張子ps1)，シェルスクリプト(拡張子sh)です。

スクリプトの実行は，実行対象サーバで次のvSphere PowerCLIのコマンドレットを使用して行います。

　Invoke-VMScript　-ScriptText "各スクリプトの実行形式"

　　　　　　　　　 -VM VirtualMachineオブジェクト※1

　　　　　　　　　 -GuestUser "ゲストOSにログインするためのユーザー名(VMware.guestOSUserNameプロパティ)の値"

　　　　　　　　　 -GuestPassword "ゲストOSにログインするためのパスワード(VMware.guestOSUserPasswordプロパティ)の値"

　　　　　　　　　 -Confirm:$false※2

　※1 仮想サーバ名(VMware.vmNameプロパティ)の値から取得したオブジェクト

　※2 コマンドレットが対話型になるのを防ぎます。

スクリプトごと次に示す実行形式をScriptTextオプションに指定して実行します。

・Windows バッチ ファイル(拡張子bat)

　"& 'ゲストOS上のスクリプトファイルパス(VMware.scriptFileOnGuestプロパティ)' 'スクリプトの引数(VMware.scriptParameterプロパティ)' ; exit $LASTEXITCODE"

・Windows PowerShell スクリプト(拡張子ps1)

　"Set-ExecutionPolicy RemoteSigned -Scope Process ; & 'ゲストOS上のスクリプトファイルパス(VMware.scriptFileOnGuestプロパティ)' 'スクリプトの引数(VMware.scriptParameterプロパティ)' ; exit $LASTEXITCODE"

・シェルスクリプト(拡張子sh)

　"/bin/bash 'ゲストOS上のスクリプトファイルパス(VMware.scriptFileOnGuestプロパティ)' 'スクリプトの引数(VMware.scriptParameterプロパティ)' "

仮想サーバで実行したスクリプトの標準出力および標準エラー出力は，スクリプトの出力ファイルパス(VMware.scriptOutputFilePathプロパティ)に指定した，実行対象サーバのファイルパスに出力されます。

スクリプトの戻り値は，Invoke-VMScriptコマンドレットの戻り値(ExitCodeプロパティ)を取得しスクリプトの戻り値(common.scriptReturnCodeプロパティ)に出力されます。スクリプトの戻り値が0以外の値の場合，部品は異常終了します。スクリプトが実行される前に部品が異常終了した場合，スクリプトの戻り値(common.scriptReturnCodeプロパティ)に255が出力されます。スクリプトの戻り値で255は使用しないでください。

スクリプトの引数(VMware.scriptParameterプロパティ)に複数の引数を使用する場合は，引数と引数の間を","(半角コンマ)か"-"(半角ハイフン)のどちらかで区切ることができます。スクリプト引数の区切り文字(VMware.scriptParamDelimiterプロパティ)に区切り文字として使用する記号を入力してください。使用できる記号は","(半角コンマ)か"-"(半角ハイフン)のどちらかです。

例:スクリプトの引数　"AAA,BBB,CCC"

　 スクリプト引数の区切り文字　","

　　 ->" & XXX.bat 'AAA' 'BBB' 'CCC' ; exit $LASTEXITCODE"

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXiがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです。

Invoke-VMScriptコマンドレットの詳細については，vSphere PowerCLI Documentationの「Cmdlet Reference」を参照してください。

利用場面

vCenterサーバが管理する仮想サーバと，JP1/AOサーバが通信できない環境で，vCenterサーバを経由してvCenter操作サーバからOSの初期設定を行うスクリプトファイルを実行するために使用する。

「vCenterサーバ経由でのファイル送信(vsphereSendFileToGuest部品)」と「vCenterサーバ経由でのファイル削除(vsphereDeleteFileOnGuest部品)」もしくは「vCenter経由でのフォルダ送信(vsphereSendFolderToGuest部品)」と「vCenterサーバ経由でのフォルダ削除(vsphereDeleteFolderOnGuest部品)」と組み合わせて使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(2)仮想サーバを管理するVMware vSphere ESXi

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(3)仮想サーバの前提OS

　vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXiがVMware vCenter Serverで管理されていること。

(2)VMware vCenter Server上の設定に関する条件

　・仮想サーバの名称が一意であること。

　・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，この部品が実行するvSphere PowerCLIからは，指定した名称の英字の大文字・小文字を区別できません。

　　- 仮想サーバ名

(3)仮想サーバに関する条件

　・仮想サーバが起動していること。

　・仮想サーバがWindowsの場合，Windows PowerShell 2.0以降がインストールされいること。

　・仮想サーバに，VMwareToolsがインストールされていること。

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)ゲストOS上のスクリプトファイルパス(VMware.scriptFileOnGuestプロパティ)，スクリプトの引数(VMware.scriptParameterプロパティ)に「`」(バッククォート)および「$」(ドルマーク)を含む文字列は指定しないでください。

(3)スクリプトの出力ファイルパス(VMware.scriptOutputFilePathプロパティ)に指定したパスのファイルが既に存在する場合，既存のファイルを上書きします。また，ファイルパスに存在しないフォルダがある場合は，フォルダを作成後にファイルを出力します。

(4)その他の注意事項については，vSphere PowerCLI Documentationの「Cmdlet Reference」のInvoke-VMScriptコマンドレットの注意事項を参照してください。

(5)ユーザーに入力を求める対話式スクリプト，GUI表示などによって自動的に終了しないスクリプトは実行しないでください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　システム管理者ロール

バージョン

02.50.00

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereInvokeScript

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します（VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません）。

−　

入力

○　

VMware.guestOSUserName

ゲストOSにログインするためのユーザー名

ゲストOSにログインするためのユーザー名を指定します。

−　

入力

○　

VMware.guestOSUserPassword

ゲストOSにログインするためのパスワード

ゲストOSにログインするためのパスワードを指定します。

−　

入力

○　

VMware.scriptFileOnGuest

ゲストOS上のスクリプトファイル

ゲストOS上で実行するスクリプトファイルをフルパスで指定します。

−　

入力

○　

VMware.scriptParameter

スクリプトの引数

スクリプトの引数を指定します。複数の引数を指定する場合は，スクリプト引数の区切り文字に指定した値(半角コンマまたは半角ハイフン)を引数の間に挿入してください。

−　

入力

△　

VMware.scriptParamDelimiter

スクリプト引数の区切り文字

スクリプトの引数の区切り文字を指定します。指定可能な値は","(半角コンマ)または"-"(半角ハイフン)です。省略した場合は，スクリプトの引数に指定した値を1つの引数として扱います。

,

入力

△　

VMware.scriptOutputFilePath

スクリプトの出力ファイルパス

スクリプトの標準出力および標準エラー出力を出力する実行対象サーバ上のファイルパスをフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

common.scriptReturnCode

スクリプトの戻り値

仮想サーバで実行したスクリプトの戻り値が格納されます。

−　

出力

△　

5.11.12　vCenterサーバ経由でのファイル削除

機能

この部品は，VMware vSphere環境で，vCenterサーバ経由で仮想サーバのゲストOS上に配置された不要なファイルを削除します。

ファイルの削除は，実行対象サーバで次のvSphere PowerCLIのコマンドレットを使用して行います。

　Invoke-VMScript　-ScriptText "仮想サーバのゲストOSごとの形式"

　　　　　　　　　 -VM VirtualMachineオブジェクト※1

　　　　　　　　　 -GuestUser "ゲストOSにログインするためのユーザー名(VMware.guestOSUserNameプロパティ)の値"

　　　　　　　　　 -GuestPassword "ゲストOSにログインするためのパスワード(VMware.guestOSUserPasswordプロパティ)の値"

　　　　　　　　　 -Confirm:$false※2

　※1 仮想サーバ名(VMware.vmNameプロパティ)の値から取得したオブジェクト

　※2 コマンドレットが対話型になるのを防ぎます。

仮想サーバのゲストOSごとに，次に示す形式をScriptTextオプションに指定して実行します。

・Windows

　"Remove-Item -LiteralPath 'ゲストOS上の削除するファイルパス(VMware.deleteFileOnGuestプロパティ)' -Force "

・UNIX

　"/bin/rm -f 'ゲストOS上の削除するファイルパス(VMware.deleteFileOnGuestプロパティ)' "

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXiがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです。

Invoke-VMScriptコマンドレットの詳細については，vSphere PowerCLI Documentationの「Cmdlet Reference」を参照してください。

Remove-Itemコマンドレットの詳細については，Windows PowerShellのRemove-Itemコマンドレットの仕様をご確認ください。

rmコマンドの詳細については，rmコマンドの仕様をご確認ください。

利用場面

vCenterサーバが管理する仮想サーバと，JP1/AOサーバが通信できない環境で，vCenterサーバを経由してvCenter操作サーバから仮想サーバ上の不要なスクリプトファイルを削除するために使用する。

「vCenterサーバ経由でのファイル送信(vsphereSendFileToGuest部品)」「vCenterサーバ経由でのスクリプト実行(vsphereInvokeScript部品)」と組み合わせて使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(2)仮想サーバを管理するVMware vSphere ESXi

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(3)仮想サーバの前提OS

　vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXiがVMware vCenter Serverで管理されていること。

(2)VMware vCenter Server上の設定に関する条件

　・仮想サーバの名称が一意であること。

　・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，この部品が実行するvSphere PowerCLIからは，指定した名称の英字の大文字・小文字を区別できません。

　　- 仮想サーバ名

(3)仮想サーバに関する条件

　・仮想サーバが起動していること。

　・仮想サーバがWindowsの場合，Windows PowerShell 2.0以降がインストールされいること。

　・仮想サーバに，VMwareToolsがインストールされていること。

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)ゲストOS上の削除するファイルパス(VMware.deleteFileOnGuestプロパティ)に「`」(バッククォート)および「$」(ドルマーク)を含む文字列は指定しないでください。

(3)その他の注意事項については，vSphere PowerCLI Documentationの「Cmdlet Reference」のInvoke-VMScriptコマンドレットの注意事項，および各OSのRemove-Itemコマンドレットの注意事項，rmコマンドの注意事項を参照してください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　システム管理者ロール

バージョン

02.50.00

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereDeleteFileOnGuest

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します（VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません）。

−　

入力

○　

VMware.guestOSUserName

ゲストOSにログインするためのユーザー名

ゲストOSにログインするためのユーザー名を指定します。

−　

入力

○　

VMware.guestOSUserPassword

ゲストOSにログインするためのパスワード

ゲストOSにログインするためのパスワードを指定します。

−　

入力

○　

VMware.deleteFileOnGuest

ゲストOS上の削除するファイルパス

削除するゲストOS上のファイルパスをフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.13　vCenterサーバ経由でのファイル送信

機能

この部品は，VMware vSphere環境で，指定したファイルを実行対象サーバからvCenterサーバ経由で仮想サーバのゲストOSに送信します。

ファイルはバイナリ形式で送信します。

ファイル送信は，実行対象サーバで次のvSphere PowerCLIのコマンドレットを使用して行います。

　Copy-VMGuestFile　-Source "実行対象サーバ上のファイルパス(VMware.fileOnHostプロパティ)の値"

　　　　　　　　　　-Destination "ゲストOS上のファイルパス(VMware.fileOnGuestプロパティ)の値"

　　　　　　　　　　-LocalToGuest

　　　　　　　　　　-Force※1

　　　　　　　　　　-VM VirtualMachineオブジェクト※2

　　　　　　　　　　-GuestUser "ゲストOSにログインするためのユーザー名(VMware.guestOSUserNameプロパティ)の値"

　　　　　　　　　　-GuestPassword "ゲストOSにログインするためのパスワード(VMware.guestOSUserPasswordプロパティ)の値"

　　　　　　　　　　-Confirm:$false※3

　※1 ゲストOS上のファイルパス(VMware.fileOnGuestプロパティ)に存在しないフォルダが含まれる場合，フォルダを作成します。

　※2 仮想サーバ名(VMware.vmNameプロパティ)の値から取得したオブジェクト

　※3 コマンドレットが対話型になるのを防ぎます。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXiがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです。

Copy-VMGuestFileコマンドレットの詳細については，vSphere PowerCLI Documentationの「Cmdlet Reference」を参照してください。

利用場面

vCenterサーバが管理する仮想サーバと，JP1/AOサーバが通信できない環境で，OSの初期設定を行うスクリプトファイルを実行する場合に，vCenterサーバを経由してvCenter操作サーバから仮想サーバにスクリプトを送信するために使用します。

「vCenterサーバ経由でのスクリプト実行(vsphereInvokeScript部品)」「vCenterサーバ経由でのファイル削除(vsphereDeleteFileOnGuest部品)」と組み合わせて使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(2)仮想サーバを管理するVMware vSphere ESXi

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(3)仮想サーバの前提OS

　vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXiがVMware vCenter Serverで管理されていること。

(2)VMware vCenter Server上の設定に関する条件

　・仮想サーバの名称が一意であること。

　・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，この部品が実行するvSphere PowerCLIからは，指定した名称の英字の大文字・小文字を区別できません。

　　- 仮想サーバ名

(3)仮想サーバに関する条件

　・仮想サーバが起動していること。

　・仮想サーバに，VMwareToolsがインストールされていること。

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)その他の注意事項については，vSphere PowerCLI Documentationの「Cmdlet Reference」のCopy-VMGuestFileコマンドレットの注意事項を参照してください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　システム管理者ロール

バージョン

02.50.00

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereSendFileToGuest

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します（VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません）。

−　

入力

○　

VMware.guestOSUserName

ゲストOSにログインするためのユーザー名

ゲストOSにログインするためのユーザー名を指定します。

−　

入力

○　

VMware.guestOSUserPassword

ゲストOSにログインするためのパスワード

ゲストOSにログインするためのパスワードを指定します。

−　

入力

○　

VMware.fileOnHost

実行対象サーバ上のファイルパス

送信元となる実行対象サーバ上のファイルパスをフルパスで指定します。

−　

入力

○　

VMware.fileOnGuest

ゲストOS上のファイルパス

送信先となるゲストOS上のファイルパスをフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.14　vCenterサーバ経由でのフォルダ削除

機能

この部品は，VMware vSphere環境で，vCenterサーバ経由で仮想サーバのゲストOS上に配置された不要なフォルダを削除します。

フォルダの削除は，実行対象サーバで次のvSphere PowerCLIのコマンドレットを使用して行います。

　Invoke-VMScript　-ScriptText "仮想サーバのゲストOSごとの形式"

　　　　　　　　　 -VM VirtualMachineオブジェクト※1

　　　　　　　　　 -GuestUser "ゲストOSにログインするためのユーザー名(VMware.guestOSUserNameプロパティ)の値"

　　　　　　　　　 -GuestPassword "ゲストOSにログインするためのパスワード(VMware.guestOSUserPasswordプロパティ)の値"

　　　　　　　　　 -Confirm:$false※2

　※1 仮想サーバ名(VMware.vmNameプロパティ)の値から取得したオブジェクト

　※2 コマンドレットが対話型になるのを防ぎます。

仮想サーバのゲストOSごとに，次に示す形式をScriptTextオプションに指定して実行します。

・Windows

　"cmd.exe /c RMDIR /S /Q 'ゲストOS上の削除するフォルダパス(VMware.deleteFolderOnGuestプロパティ)' "

・UNIX

　"/bin/rm -f -r 'ゲストOS上の削除するフォルダパス(VMware.deleteFolderOnGuestプロパティ)' "

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXiがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです。

Invoke-VMScriptコマンドレットの詳細については，vSphere PowerCLI Documentationの「Cmdlet Reference」を参照してください。

RMDIRコマンドの詳細については，RMDIRコマンドの仕様をご確認ください。

rmコマンドの詳細については，rmコマンドの仕様をご確認ください。

利用場面

vCenterサーバが管理する仮想サーバと，JP1/AOサーバが通信できない環境で，スクリプトやスクリプト実行に必要なファイルが格納された不要なフォルダをvCenterサーバを経由して削除する場合に使用します。

「vCenterサーバ経由でのフォルダ送信(vsphereSendFolderToGuest部品)」「vCenterサーバ経由でのスクリプト実行(vsphereInvokeScript部品)」と組み合わせて使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(2)仮想サーバを管理するVMware vSphere ESXi

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(3)仮想サーバの前提OS

　vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXiがVMware vCenter Serverで管理されていること。

(2)VMware vCenter Server上の設定に関する条件

　・仮想サーバの名称が一意であること。

　・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，この部品が実行するvSphere PowerCLIからは，指定した名称の英字の大文字・小文字を区別できません。

　　- 仮想サーバ名

(3)仮想サーバに関する条件

　・仮想サーバが起動していること。

　・仮想サーバがWindowsの場合，Windows PowerShell 2.0以降がインストールされいること。

　・仮想サーバに，VMwareToolsがインストールされていること。

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)ゲストOS上の削除するフォルダパス(VMware.deleteFolderOnGuestプロパティ)に「`」(バッククォート)および「$」(ドルマーク)を含む文字列は指定しないでください。

(3)この部品は通常のフォルダを対象としています。そのため，ドライブはフォルダとして扱いません。

(4)その他の注意事項については，vSphere PowerCLI Documentationの「Cmdlet Reference」のInvoke-VMScriptコマンドレットの注意事項，および各OSのRMDIRコマンドの注意事項，rmコマンドの注意事項を参照してください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　システム管理者ロール

バージョン

02.50.00

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereDeleteFolderOnGuest

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します（VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません）。

−　

入力

○　

VMware.guestOSUserName

ゲストOSにログインするためのユーザー名

ゲストOSにログインするためのユーザー名を指定します。

−　

入力

○　

VMware.guestOSUserPassword

ゲストOSにログインするためのパスワード

ゲストOSにログインするためのパスワードを指定します。

−　

入力

○　

VMware.deleteFolderOnGuest

ゲストOS上の削除するフォルダパス

削除するゲストOS上のフォルダパスをフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.15　vCenterサーバ経由でのフォルダ送信

機能

この部品は，VMware vSphere環境で，指定したフォルダを実行対象サーバからvCenterサーバ経由で仮想サーバのゲストOSに送信します。

フォルダはバイナリ形式で送信します。

フォルダ送信は，実行対象サーバで次のvSphere PowerCLIのコマンドレットを使用して行います。

　Copy-VMGuestFile　-Source "実行対象サーバ上のフォルダパス(VMware.folderOnHostプロパティ)の値"

　　　　　　　　　　-Destination "ゲストOS上のフォルダパス(VMware.folderOnGuestプロパティ)の値"

　　　　　　　　　　-LocalToGuest

　　　　　　　　　　-Force※1

　　　　　　　　　　-VM VirtualMachineオブジェクト※2

　　　　　　　　　　-GuestUser "ゲストOSにログインするためのユーザー名(VMware.guestOSUserNameプロパティ)の値"

　　　　　　　　　　-GuestPassword "ゲストOSにログインするためのパスワード(VMware.guestOSUserPasswordプロパティ)の値"

　　　　　　　　　　-Confirm:$false※3

　※1 ゲストOS上のフォルダパス(VMware.folderOnGuestプロパティ)に存在しないフォルダが含まれる場合，フォルダを作成します。

　※2 仮想サーバ名(VMware.vmNameプロパティ)の値から取得したオブジェクト

　※3 コマンドレットが対話型になるのを防ぎます。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXiがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです

Copy-VMGuestFileコマンドレットの詳細については，vSphere PowerCLI Documentationの「Cmdlet Reference」を参照してください。

利用場面

vCenterサーバが管理する仮想サーバと，JP1/AOサーバが通信できない環境で，OSの初期設定を行うスクリプトファイルを実行する場合に，スクリプトおよびスクリプト実行に必要なファイルが格納されたフォルダをvCenterサーバを経由してvCenter操作サーバから仮想サーバに送信する場合に使用します。

「vCenterサーバ経由でのスクリプト実行(vsphereInvokeScript部品)」「vCenterサーバ経由でのフォルダ削除(vsphereDeleteFolderOnGuest部品)」と組み合わせて使用します。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(2)仮想サーバを管理するVMware vSphere ESXi

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(3)仮想サーバの前提OS

　vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXiがVMware vCenter Serverで管理されていること。

(2)VMware vCenter Server上の設定に関する条件

　・仮想サーバの名称が一意であること。

　・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，この部品が実行するvSphere PowerCLIからは，指定した名称の英字の大文字・小文字を区別できません。

　　- 仮想サーバ名

(3)仮想サーバに関する条件

　・仮想サーバが起動していること。

　・仮想サーバに，VMwareToolsがインストールされていること。

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)この部品は通常のフォルダを対象としています。そのため，ドライブはフォルダとして扱いません。

(3)その他の注意事項については，vSphere PowerCLI Documentationの「Cmdlet Reference」のCopy-VMGuestFileコマンドレットの注意事項を参照してください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　システム管理者ロール

バージョン

02.50.00

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereSendFolderToGuest

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します（VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません）。

−　

入力

○　

VMware.guestOSUserName

ゲストOSにログインするためのユーザー名

ゲストOSにログインするためのユーザー名を指定します。

−　

入力

○　

VMware.guestOSUserPassword

ゲストOSにログインするためのパスワード

ゲストOSにログインするためのパスワードを指定します。

−　

入力

○　

VMware.folderOnHost

実行対象サーバ上のフォルダパス

送信元となる実行対象サーバ上のフォルダパスをフルパスで指定します。

−　

入力

○　

VMware.folderOnGuest

ゲストOS上のフォルダパス

送信先となるゲストOS上のフォルダパスをフルパスで指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.16　VMware vCenter Server接続確認

機能

VMware vSphere環境に，VMware vSphere PowerCLIで接続できることを確認します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXi(またはVMware ESX Server)がインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

利用場面

VMware vSphere環境に，VMware vSphere ESXi(またはVMware ESX Server)と実行対象サーバとの接続状態を事前確認することができます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)ESXサーバの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　システム管理者ロール

バージョン

02.11.00

部品のタグ

Gather VM information,VMware vSphere

タスクログに表示される部品の名称

vsphereConnectChallenge

戻り値

戻り値

説明

0

正常

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号（VMware vCenter ServerのWebサービス用）を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

common.connectvCenterResult

vSphere接続確認のチェック結果

VMware vCenter Serverに接続できるかどうか確認した結果を格納します。

−　

出力

△　

5.11.17　データストア作成

機能

VMware vSphere ESXi(またはVMware ESX Server)にデータストアを追加します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXi(またはVMware ESX Server)がインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

利用場面

新規に仮想サーバを追加する場合など，ESXサーバにデータストアを追加する際に利用できます。

データストアをVMFSで作成する場合，VMware.lunPathにSCSI LUNのCanonical名を指定する必要があります。

この場合には，vsphereGetCanonicalNameを実行結果の出力プロパティVMware.canonicalNameを利用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)ESXサーバの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)データストア名(VMware.dataStoreName)に次の記号は指定できません(スラッシュ(/), バックスラッシュ(¥), パーセント(%))。

(2)VMware vSphere ESXi(またはVMware ESX Server)のバージョンが5以上の場合は，VMFSはバージョン5で作成されます。

(3)VMware vSphere ESXi(またはVMware ESX Server)のバージョンが5未満の場合は，VMFSはバージョン3で作成されます。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　対象とするESXサーバに対して「データストア−データストアの構成」の権限を持つロール，またはシステム管理者ロール

バージョン

02.11.00

部品のタグ

Add New Storage,VMware vSphere

タスクログに表示される部品の名称

vsphereCreateDataStore

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmHostName

ESXサーバ名

VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。

−　

入力

○　

VMware.dataStoreName

データストア名

作成するデータストアの名称を指定します。

−　

入力

○　

VMware.dataStoreType

データストア種別

データストアの種別を指定します。データストアの構成がFC-SAN構成やSCSIの場合はVMFSを，NASの場合はNFSを指定します。

VMFS

入力

○　

VMware.dataStoreReadOnlyMode

データストア参照モード

データストアを参照モードで作成する場合，"ReadOnly"を指定します。その他の場合は"ReadWrite"を指定してください。

ReadWrite

入力

△　

VMware.lunPath

LUNパス

データストア種別がVMFSの場合は，データストア生成先LUのCanonical名を指定します。NFSの場合，マウントポイントを指定します。

−　

入力

○　

VMware.blockSizeMB

ブロックサイズ

[データストア種別がVMFSの場合だけ]ブロックサイズをMB単位で指定します。ブロックサイズに応じてそのVMFS上に作成するファイルの単一ファイル当たりのサイズの上限値が決まります。ブロックサイズと最大ファイルサイズの対応を次に示します。1MB - 256GB, 2MB - 512GB, 4MB - 1024GB, 8MB - 2048GB

−　

入力

△　

VMware.vmfsFileSystemVersion

ファイルシステムバージョン（VMFS）

作成するデータストアのVMFSバージョンを指定します。

−　

入力

△　

VMware.nfsHostNameOrIpAddress

NFSホスト名

[データストア種別がNFSの場合だけ]データストアを作成するNFSのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

VMware.storageIOControlEnabled

ストレージI/Oのコントロール

データストアにおいてストレージI/Oのコントロールを有効にする場合，trueを指定します。それ以外の場合はfalseを指定します。

false

入力

△　

VMware.congestionThresholdMillisecond

データストアの輻輳しきい値

ストレージI/Oコントロールのデータストアの輻輳しきい値をミリ秒単位で指定します。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.18　データストア作成確認

機能

VMware vSphere ESXi(またはVMware ESX Server)に，指定されたデータストアが追加できることを確認します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXi(またはVMware ESX Server)がインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

この部品で確認している項目を次に示します。

・指定されたESXサーバがvCenterサーバ上に登録されているかを確認します。

ESXサーバがvCenterサーバ上に登録されていない場合はNGとなります。

・指定されたデータストア名が，データストア追加先のESXサーバが所属しているデータセンター内で，使用されていないかを確認します。

データストア名がデータセンター内で既に使用されている場合はNGとなります。

・指定されたブロックサイズとデータストア容量を比較し，対応が正しいかを確認します。

ブロックサイズとデータストア容量を比較し，対応が正しくない場合はNGとなります。

ブロックサイズとデータストア容量の対応は「ブロックサイズ(MB)」プロパティの説明を参照してください。

・指定されたHBAがESXサーバ上に登録されているかを確認します。

HBAがESXサーバ上に登録されていない場合はNGとなります。

利用場面

ESXサーバにデータストアを追加する場合に，ESXサーバにデータストアが追加できるかを事前確認することができます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)ESXサーバの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)データストア名(VMware.dataStoreName)に次の記号は指定できません。

　・スラッシュ(/)

　・バックスラッシュ(¥)

　・パーセント(%)

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　対象とするESXサーバに対して「データストア−データストアの構成」の権限を持つロール，またはシステム管理者ロール

バージョン

02.11.00

部品のタグ

Gather VM information,VMware vSphere

タスクログに表示される部品の名称

vsphereCheckDataStore

戻り値

戻り値

説明

0

正常

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号（VMware vCenter ServerのWebサービス用）を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmHostName

ESXサーバ名

VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。

−　

入力

○　

VMware.dataStoreName

データストア名

データストアの名称を指定します

−　

入力

○　

VMware.dataStoreType

データストア種別

データストアの種別を指定します。データストアの構成がFC-SAN構成やSCSIの場合はVMFSを，NASの場合はNFSを指定します。

VMFS

入力

△　

HDvM.capacity

DPボリューム(LU)の容量 (GB)

作成するDPボリューム(LU)の容量をGB単位で指定します。

−　

入力

○　

VMware.blockSizeMB

ブロックサイズ (MB)

データストアを作成できるか確認するブロックサイズを指定します。ブロックサイズに応じてそのVMFS上に作成するファイルの単一ファイル当たりのサイズの上限値が決まります。ブロックサイズと最大ファイルサイズの対応を次に示します。1MB - 256GB，2MB - 512GB， 4MB - 1024GB，8MB - 2048GB。未指定時はVMware vCenter Serverのデフォルト値で確認します。

1

入力

△　

VMware.vmfsFileSystemVersion

ファイルシステムバージョン（VMFS）

作成するデータストアのVMFSバージョンを指定します。

−　

入力

△　

VMware.hbaName

HBA名

存在するか確認するHBA名を，VMware vCenter Serverのストレージアダプタのランタイム名に表示される形式で指定します(例：vmhba0)。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

common.CheckDataStoreResult

データストア作成確認のチェック結果

データストアを追加できるかどうか確認した結果を格納します。

−　

出力

△　

5.11.19　データストア削除

機能

VMware vSphere環境において，VMware vSphere ESXi(またはVMware ESX Server)からデータストアを削除します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXi(またはVMware ESX Server)がインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

利用場面

仮想サーバ削除によりデータストアが不用になった場合などの契機で，データストアを削除する際に利用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)ESXサーバの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)使用中の仮想サーバが削除対象のデータストアに格納されていないことを確認してください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　対象とするESXサーバに対して「データストア−データストアの削除」の権限を持つロール，またはシステム管理者ロール

バージョン

02.11.00

部品のタグ

Delete Storage,VMware vSphere

タスクログに表示される部品の名称

vsphereDeleteDatastore

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmHostName

ESXサーバ名

VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。

−　

入力

○　

VMware.dataStoreName

データストア名

削除するデータストアの名称を指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.20　テンプレートの作成

機能

VMware vSphere環境で，仮想サーバからテンプレートを作成します。作成元の仮想サーバはテンプレート作成後も残ります。

データストア名を指定すると，テンプレートを格納するデータストアを変更できます。

データストア名を指定しない場合，作成元の仮想サーバと同じデータストアにテンプレートを格納します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXiがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです。

テンプレートの作成先(VMware.destTemplateLocationプロパティ)について次に示します。

・テンプレートの作成先(データセンター，フォルダまたはESXサーバ)を指定します。

・データセンター，フォルダを指定した場合，テンプレートのホストは作成元の仮想サーバと同じESXサーバになります。異なるESXサーバにテンプレートを作成することはできません。

・ESXサーバを指定した場合，テンプレートは指定したESXサーバをホストとし，ESXサーバが管理されているデータセンターに作成されます。

データストア名(VMware.destTemplateDataStoreプロパティ)について次に示します。

・テンプレートを格納するデータストアの名前を指定します。

・指定を省略した場合，テンプレートの作成元となる仮想サーバと同じデータストアにテンプレートを格納します。

利用場面

既存の仮想サーバからテンプレートを作成する際に利用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(2)仮想サーバを管理するVMware vSphere ESXの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXがVMware vCenter Serverで管理されていること。

(2)VMware vCenter Server上の設定に関する条件

　・テンプレートの作成先(データセンター，ESXサーバ，フォルダ)の名称が一意であること。

　・仮想サーバの名称が一意であること。

　・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，この部品が実行するvSphere Power CLIからは，指定した名称の英字の大文字・小文字を区別できません。

　　そのため，英字の大文字・小文字が異なる同名の名称を使用している環境に対して，この部品を使用することはできません。

　　- 仮想サーバ名

　　- テンプレート名

　　- データセンター名

　　- フォルダ名

　　- データストア名

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)テンプレートの作成先から，テンプレートを格納するデータストアを参照できない場合，この部品は異常終了します。その場合，データストア名(VMware.destTemplateDataStoreプロパティ)にテンプレートの作成先から参照可能なデータストアを指定してください。

(3)VMware vSphere PowerCLIのバージョンが5.0の場合にデータストア名(VMware.destTemplateDataStoreプロパティ)を指定すると，この部品は異常終了します。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。

バージョン

02.11.00

部品のタグ

Add VM Template,VMware vSphere

タスクログに表示される部品の名称

vsphereCreateTemplate

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.srcVmName

作成元の仮想サーバ名

テンプレートの作成元となる仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

VMware.createTemplateName

テンプレート名

作成するテンプレート名を指定します。

−　

入力

○　

VMware.destTemplateLocation

テンプレートの作成先

テンプレートの作成先(データセンター，フォルダまたはESXサーバ)を指定します。

−　

入力

○　

VMware.destTemplateDataStore

データストア名

テンプレートを格納するデータストア名を指定します。省略した場合，テンプレートの作成元となる仮想サーバと同じデータストアにテンプレートを作成します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.21　テンプレートの削除

機能

VMware vSphere環境において，仮想サーバのテンプレートを削除します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXiがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです。

利用場面

仮想サーバのテンプレートを削除する際に利用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(2)仮想サーバを管理するVMware vSphere ESXの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXがVMware vCenter Serverで管理されていること。

(2)VMware vCenter Server上の設定に関する条件

　・テンプレートの名称が一意であること。

　・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，この部品が実行するvSphere Power CLIからは，指定した名称の英字の大文字・小文字を区別できません。

　　そのため，英字の大文字・小文字が異なる同名の名称を使用している環境に対して，この部品を使用することはできません。

　　- テンプレート名

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。

バージョン

02.11.00

部品のタグ

Delete VM Template,VMware vSphere

タスクログに表示される部品の名称

vsphereDeleteTemplate

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.deleteTemplateName

テンプレート名

削除するテンプレート名を指定します。

−　

入力

○　

VMware.deletePermanently

データストアからの削除要否

テンプレートをデータストアから削除する場合はtrueを，削除しない場合はfalseを指定してください。falseを指定した場合，テンプレートはインベントリから削除されますが，データストアからは削除されません。

true

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.22　ネットワークアダプタの設定変更

機能

VMware vSphere環境で，仮想サーバに割り当てられているネットワークアダプタの設定を変更します。

接続先ネットワークは次のどれかの方法で指定してください。

(1)標準仮想スイッチのポートグループ名(VMware.connectionPortGroupNameプロパティ)を指定する。

(2)分散ポートグループ名(VMware.connectionVDPortGroupNameプロパティ)を指定する。

(3)分散仮想スイッチ名(VMware.distributedSwitchNameプロパティ)およびポートID(VMware.portIDプロパティ)を指定する。

接続先ネットワークを指定しない場合，接続先ネットワークの変更を行いません。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです。

ネットワークアダプタのタイプ(VMware.vNetworkAdapterTypeプロパティ)について次に示します。

・ネットワークアダプタのタイプを指定します。プロパティとして指定可能な値は，e1000，e1000e，Flexible，EnhancedVmxnet，Vmxnet3です。ただし，前提製品のバージョンによっては指定できないネットワークアダプタのタイプもあります。前提製品で指定可能なネットワークアダプタのタイプを確認した上，値を指定してください。

・ネットワークアダプタのタイプにVMXNET2(拡張)を設定する場合は，EnhancedVmxnetを指定してください。

利用場面

仮想サーバに割り当てられているネットワークアダプタの設定を変更する場合に利用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(2)仮想サーバを管理するVMware vSphere ESXの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXがVMware vCenter Serverで管理されていること。

(2)VMware vCenter Server上の設定に関する条件

　・仮想サーバの名称が一意であること。

　・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，この部品が実行するvSphere Power CLIからは，指定した名称の英字の大文字・小文字を区別できません。

　　そのため，英字の大文字・小文字が異なる同名の名称を使用している環境に対して，この部品を使用することはできません。

　　- 仮想サーバ名

　　- ポートグループ名

　　- 分散ポートグループ名

　　- 分散仮想スイッチ名

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)接続先ネットワークを複数の方法で指定した場合，この部品は異常終了します。

(3)接続先ネットワークを指定し，戻り値27でこの部品が異常終了した場合，接続先ネットワークに接続され，設定変更が失敗していることがあります。その場合，タスクログのエラーメッセージに従い原因を取り除いたあと，この部品を再実行してください。

(4)この部品を同一のネットワークアダプタに対し，複数同時に実行しないでください。同時に実行した場合，部品は正常終了しますが，ネットワークアダプタに不正な値が設定されるおそれがあります。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。

バージョン

02.11.00

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereSetNetworkAdapter

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します（VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません）。

−　

入力

○　

VMware.targetNetworkAdapter

ネットワークアダプタ名

設定を変更するネットワークアダプタ名を指定します。

−　

入力

○　

VMware.connectionPortGroupName

標準仮想スイッチのポートグループ名

ネットワークアダプタと接続する標準仮想スイッチのポートグループ名を指定します。

−　

入力

△　

VMware.connectionDVPortGroupName

分散ポートグループ名

ネットワークアダプタと接続する分散ポートグループ名を指定します。

−　

入力

△　

VMware.dVSwitchName

分散仮想スイッチ名

ネットワークアダプタと接続する分散仮想スイッチ名を指定します。このプロパティを指定する場合は，ポートIDも必ず併せて指定してください。

−　

入力

△　

VMware.portID

ポートID

ネットワークアダプタと接続する分散仮想スイッチのポートIDを指定します。

−　

入力

△　

VMware.startConnetedSwitch

仮想サーバ起動時の接続要否

仮想サーバを起動したときに，ネットワークアダプタを接続する場合はtrueを，接続しない場合はfalseを指定します。

−　

入力

△　

VMware.vNetworkAdapterType

ネットワークアダプタのタイプ

ネットワークアダプタのタイプを指定します。指定可能な値は，e1000，e1000e，Flexible，EnhancedVmxnet，Vmxnet3です。

−　

入力

△　

VMware.wakeOnLanSwitch

Wake-on-LAN機能の設定

ネットワークアダプタのWake-on-LAN機能を有効にする場合はtrueを，無効にする場合はfalseを指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.23　ネットワークアダプタの追加

機能

VMware vSphere環境で，仮想サーバにネットワークアダプタを追加したあと，接続先ネットワークを設定します。

接続先ネットワークは次のどれかの方法で指定してください。

(1)標準仮想スイッチのポートグループ名(VMware.connectionPortGroupNameプロパティ)を指定する。

(2)分散ポートグループ名(VMware.connectionDVPortGroupNameプロパティ)を指定する。

(3)分散仮想スイッチ名(VMware.dVSwitchNameプロパティ)およびポートID(VMware.portIDプロパティ)を指定する。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです。

ネットワークアダプタのタイプ(VMware.vNetworkAdapterTypeプロパティ)について次に示します。

・ネットワークアダプタのタイプを指定します。プロパティとして指定可能な値は，e1000，e1000e，Flexible，EnhancedVmxnet，Vmxnet3です。ただし，前提製品のバージョンによっては指定できないネットワークアダプタのタイプもあります。前提製品で指定可能なネットワークアダプタのタイプを確認した上，値を指定してください。

・このプロパティを省略した場合，VMware vCenter ServerがゲストOSに応じたネットワークアダプタのタイプを自動で設定します。

・ネットワークアダプタのタイプにVMXNET2(拡張)を設定する場合は，EnhancedVmxnetを指定してください。

利用場面

仮想サーバにネットワークアダプタを追加する場合に利用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(2)仮想サーバを管理するVMware vSphere ESXの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXがVMware vCenter Serverで管理されていること。

(2)VMware vCenter Server上の設定に関する条件

　・仮想サーバの名称が一意であること。

　・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，この部品が実行するvSphere Power CLIからは，指定した名称の英字の大文字・小文字を区別できません。

　　そのため，英字の大文字・小文字が異なる同名の名称を使用している環境に対して，この部品を使用することはできません。

　　- 仮想サーバ名

　　- ポートグループ名

　　- 分散ポートグループ名

　　- 分散仮想スイッチ名

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)接続先ネットワークを1つも指定しない，または複数の方法で指定した場合，この部品は異常終了します。

(3)MACアドレスを指定する場合，既に使用されているMACアドレスと重複しないように注意してください。

(4)この部品を同一の仮想サーバに対し，複数同時に実行しないでください。同時に実行した場合，部品は正常終了しますが，ネットワークアダプタ名(VMware.createdNetworkAdapterNameプロパティ)，MACアドレス(VMware.assignedMacAddressプロパティ)に不正な値が格納されるおそれがあります。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。

バージョン

02.11.00

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereAddNetworkAdapter

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します（VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません）。

−　

入力

○　

VMware.connectionPortGroupName

標準仮想スイッチのポートグループ名

ネットワークアダプタと接続する標準仮想スイッチのポートグループ名を指定します。

−　

入力

△　

VMware.connectionDVPortGroupName

分散ポートグループ名

ネットワークアダプタと接続する分散ポートグループ名を指定します。

−　

入力

△　

VMware.dVSwitchName

分散仮想スイッチ名

ネットワークアダプタと接続する分散仮想スイッチ名を指定します。このプロパティを指定する場合は，ポートIDも必ず併せて指定してください。

−　

入力

△　

VMware.portID

ポートID

ネットワークアダプタと接続する分散仮想スイッチのポートIDを指定します。

−　

入力

△　

VMware.startConnetedSwitch

仮想サーバ起動時の接続要否

仮想サーバを起動したときに，ネットワークアダプタを接続する場合はtrueを，接続しない場合はfalseを指定します。

true

入力

○　

VMware.vNetworkAdapterType

ネットワークアダプタのタイプ

ネットワークアダプタのタイプを指定します。指定可能な値は，e1000，e1000e，Flexible，EnhancedVmxnet，Vmxnet3です。省略した場合，VMware vCenter ServerがゲストOSに応じたネットワークアダプタのタイプを自動で設定します。

−　

入力

△　

VMware.networkAdapterMacAddress

MACアドレス

ネットワークアダプタのMACアドレスを"XX:XX:XX:XX:XX:XX"の形式で指定します。省略した場合，MACアドレスを自動で割り当てます。

−　

入力

△　

VMware.wakeOnLanSwitch

Wake-on-LAN機能の設定

ネットワークアダプタのWake-on-LAN機能を有効にする場合はtrueを，無効にする場合はfalseを指定します。

true

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

VMware.createdNetworkAdapterName

ネットワークアダプタ名

新規に追加したネットワークアダプタの名前が格納されます。

−　

出力

△　

VMware.assignedMacAddress

MACアドレス

新規に追加したネットワークアダプタに割り当てられたMACアドレスが格納されます。

−　

出力

△　

5.11.24　ポートグループのトラフィックシェーピングポリシー設定

機能

VMware vSphere環境で，標準仮想スイッチ(vNetwork 標準スイッチ/vSphere 標準スイッチ)のポートグループに対し，トラフィックシェーピングポリシーを設定します。

設定可能なポリシーは次のとおりです。

・継承(inheritance)

　標準仮想スイッチに設定しているトラフィックシェーピングポリシーをポートグループに適用します。標準仮想スイッチのポリシーを変更した場合，ポートグループにも変更が適用されます。

・オーバーライド(override)

　ポートグループ独自のトラフィックシェーピングを設定します。この場合，次のプロパティをすべて指定してください。

　　- 平均バンド幅(kbit/s)(VMware.sendAverageBandwidthプロパティ)

　　- バーストサイズ(KB)(VMware.sendBurstSizeプロパティ)

　　- ピークバンド幅(kbit/s)(VMware.sendPeakBandwidthプロパティ)

・無効(disable)

　ポートグループのトラフィックシェーピングを無効にします。この場合，ポートグループを通過するトラフィックは制限されません。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXiがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

平均バンド幅(kbit/s)(VMware.sendAverageBandwidthプロパティ)について次に示します。

・ポートグループを通過するトラフィックに対する平均バンド幅(kbit/s)を指定します。

・トラフィックシェーピングポリシー(VMware.trafficShapingPolicyプロパティ)に"override"を指定した場合，このプロパティを指定してください。"inheritance"，"disable"を指定した場合，このプロパティの指定は無視されます。

・指定可能な値は1〜9007199254740991の範囲の整数値です。

バーストサイズ(KB)(VMware.sendBurstSizeプロパティ)について次に示します。

・ポートグループを通過するトラフィックに対するバーストサイズ(KB)を指定します。

・トラフィックシェーピングポリシー(VMware.trafficShapingPolicyプロパティ)に"override"を指定した場合，このプロパティを指定してください。"inheritance"，"disable"を指定した場合，このプロパティの指定は無視されます。

・指定可能な値は1〜9007199254740991の範囲の整数値です。

ピークバンド幅(kbit/s)(VMware.sendPeakBandwidthプロパティ)について次に示します。

・ポートグループを通過するトラフィックに対するピークバンド幅(kbit/s)を指定します。

・トラフィックシェーピングポリシー(VMware.trafficShapingPolicyプロパティ)に"override"を指定した場合，このプロパティを指定してください。"inheritance"，"disable"を指定した場合，このプロパティの指定は無視されます。

・指定可能な値は1〜9007199254740991の範囲の整数値です。

・平均バンド幅(kbit/s)(VMware.sendAverageBandwidthプロパティ)より小さい値を指定することはできません。

利用場面

標準仮想スイッチのポートグループに対し，トラフィックシェーピングポリシーを設定する際に利用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(2)仮想サーバを管理するVMware vSphere ESXの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXがVMware vCenter Serverで管理されていること。

(2)VMware vCenter Server上の設定に関する条件

　・ポートグループが設定済みであること。仮想サーバに設定するポートグループは，標準仮想スイッチ(vNetwork 標準スイッチ/vSphere 標準スイッチ)を使ったネットワーク上のポートグループを指定してください。

　・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，この部品が実行するvSphere Power CLIからは，指定した名称の英字の大文字・小文字を区別できません。

　　そのため，英字の大文字・小文字が異なる同名の名称を使用している環境に対して，この部品を使用することはできません。

　　- ポートグループ名

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)ピークバンド幅(kbit/s)(VMware.sendPeakBandwidthプロパティ)には平均バンド幅(kbit/s)(VMware.sendAverageBandwidthプロパティ)より小さい値を指定できません。指定した場合，この部品は異常終了します。

(3)トラフィックシェーピングポリシー(VMware.trafficShapingPolicyプロパティ)に"override"を指定した場合，平均バンド幅(kbit/s)(VMware.sendAverageBandwidthプロパティ)，バーストサイズ(KB)(VMware.sendBurstSizeプロパティ)，ピークバンド幅(kbit/s)(VMware.sendPeakBandwidthプロパティ)をすべて指定してください。どれか1つでも指定しない場合，この部品は異常終了します。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。

バージョン

02.11.00

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereSetPGTrafficShapingPolicy

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmHostName

ESXサーバ名

VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。

−　

入力

○　

VMware.targetPortGroup

ポートグループ名

トラフィックシェーピングポリシーを設定する標準仮想スイッチのポートグループ名を指定します。

−　

入力

○　

VMware.trafficShapingPolicy

トラフィックシェーピングポリシー

標準仮想スイッチのポートグループに設定するトラフィックシェーピングポリシーを指定します。指定可能な値は，inheritance，override，disableです。標準仮想スイッチに設定されているポリシーを引き継ぐ場合はinheritanceを，ポートグループ独自にトラフィックシェーピングを行う場合はoverrideを，トラフィックシェーピングを無効にする場合はdisableを指定してください。

override

入力

○　

VMware.sendAverageBandwidthKb

平均バンド幅(kbit/s)

ポートグループを通過するトラフィックに対する平均バンド幅(kbit/s)を指定します。

−　

入力

△　

VMware.sendBurstSizeKB

バーストサイズ(KB)

ポートグループを通過するトラフィックに対するバーストサイズ(KB)を指定します。

−　

入力

△　

VMware.sendPeakBandwidthKb

ピークバンド幅(kbit/s)

ポートグループを通過するトラフィックに対するピークバンド幅(kbit/s)を指定します。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.25　ホストDRSグループの設定

機能

VMware vSphere環境で，vSphere DRSクラスタに設定されているホストDRSグループにESXサーバを追加，または削除します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXiがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・DRSクラスタ

　vSphere DRSクラスタまたはvSphere DRSクラスタを構成しているサーバです。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです。

ホストDRSグループ設定モード(VMware.setHostDrsGroupModeプロパティ)について次に示します。

・ホストDRSグループにESXサーバを追加する場合は，"Add"を指定してください。

・ホストDRSグループからESXサーバを削除する場合は，"Delete"を指定してください。

利用場面

vSphere DRSクラスタ環境にESXサーバを追加・削除した際に，ホストDRSグループにESXサーバを追加，または削除する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(2)仮想サーバを管理するVMware vSphere ESXの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXがVMware vCenter Serverで管理されていること。

(2)VMware vCenter Server上の設定に関する条件

　・vSphere DRSクラスタの名称が一意であること。

　・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，この部品が実行するvSphere Power CLIからは，指定した名称の英字の大文字・小文字を区別できません。

　　そのため，英字の大文字・小文字が異なる同名の名称を使用している環境に対して，この部品を使用することはできません。

　　- DRSクラスタ名

　　- DRSグループ名(ホストDRSグループ名および仮想サーバDRSグループ名)

(3)vSphere DRSクラスタが構築されており，かつホストDRSグループが設定されていること。

(4)VMware vSphere ESXがDRSクラスタ名(VMware.drsClusterNameプロパティ)に指定するvSphere DRSクラスタに所属していること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)ホストDRSグループにESXサーバを追加する際に，ESXサーバ名(VMware.vmHostNameプロパティ)に既に登録されているESXサーバを指定した場合，この部品は異常終了します。また，ホストDRSグループからESXサーバを削除する際に，ESXサーバ名(VMware.vmHostNameプロパティ)に登録されていないESXサーバを指定した場合，この部品は異常終了します。

(3)この部品は，ホストDRSグループを削除しません。そのため，ホストDRSグループからESXサーバを削除する際に，ホストDRSグループに登録されているESXサーバの数が0になる場合は，この部品は異常終了します。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。

バージョン

02.11.00

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereSetDrsHostGroup

戻り値

戻り値

説明

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.drsClusterName

DRSクラスタ名

VMware vCenter Serverが管理するvSphere DRSクラスタ名を指定します。

−　

入力

○　

VMware.hostDrsGroupName

ホストDRSグループ名

ESXサーバを追加または削除するホストDRSグループ名を指定します。

−　

入力

○　

VMware.vmHostName

ESXサーバ名

VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。

−　

入力

○　

VMware.setHostDrsGroupMode

ホストDRSグループ設定モード

ホストDRSグループにESXサーバを追加する場合は"Add"を，削除する場合は"Delete"を指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.26　ログバンドルの取得

機能

この部品は，VMware vSphere環境で，vCenterサーバまたはESXサーバからログバンドルを取得し，vCenter操作サーバ上に転送して保存します。オプションとして，1回の部品実行で両方のサーバのログバンドルを取得することもできます。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXiがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。本製品によってこのサーバに部品が転送され，実行されます。

この部品内のスクリプトでは，次に示すVMware vSphere PowerCLIのコマンドレットを実行し，対象となるサーバのログバンドルを取得します。

(1)ESXサーバ名(VMware.vmHostNameプロパティ)を指定した場合，ESXサーバからログバンドルを取得します。

　　Get-Log -Bundle

　　　　　　-VMHost "ESXサーバのオブジェクト" ※1

　　　　　　-DestinationPath "ファイル出力先フォルダパス(common.outputFolderPathプロパティ)の値"

　　※1 ESXサーバ名(VMware.vmHostNameプロパティ)の値から取得したオブジェクト

(2)ESXサーバ名(VMware.vmHostNameプロパティ)を指定しない，またはログバンドル取得対象オプション(VMware.logBundleTargetOptionプロパティ)に"true"を指定した場合，vCenterサーバからログバンドルを取得します。

　　Get-Log -Bundle

　　　　　　-DestinationPath "ファイル出力先フォルダパス(common.outputFolderPathプロパティ)の値"

Get-Logコマンドレットの詳細については，vSphere PowerCLI Documentation の「Cmdlets Reference」を参照してください。

ファイル出力先フォルダパス(common.outputFolderPathプロパティ)に指定したフォルダの配下に，取得したログバンドルを保存します。

指定したフォルダが存在しない場合はフォルダを作成します。

取得したログバンドル名は次のようになります。

・vCenterサーバのログバンドル

　vcsupport-<UUID>.拡張子

・ESXサーバのログバンドル

　vmsupport-<UUID>.拡張子，または<ESXサーバ名>-<取得年月日時分>.拡張子

例：vcsupport-52030251-97e6-e5f2-042e-eee52079822b.tgz

　　vmsupport-5219d2ae-c328-c617-2525-09ed4a3111f0.tgz

　　esx-ed801a-2017-03-24--13.36-1080701.tgz

<UUID>は，同一のサーバであっても部品を実行する度に別の値になります。

取得したログバンドルのフルパスを次に示すプロパティに格納します。

・vCenterサーバのログバンドル

　vCenterサーバのログバンドルパス(VMware.vCenterLogBundlePathプロパティ)

・ESXサーバのログバンドル

　ESXサーバのログバンドルパス(VMware.esxLogBundlePathプロパティ)

利用場面

VMware vSphere環境で障害が発生したときに，トラブルシュート情報としてVMware vCenter ServerまたはVMware vSphere ESXiのログバンドルを取得する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(2)ESXサーバの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXiのログバンドルを取得する場合の条件

　・VMware vSphere ESXiがVMware vCenter Serverで管理されていること。

　・VMware vSphere ESXiがVMware vCenter Serverと接続状態であること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2) この部品を複数同時に実行する際にファイル出力先フォルダパス(common.outputFolderPathプロパティ)に同一の存在しないフォルダを指定した場合，フォルダ作成処理が競合して部品が異常終了することがあります。その場合は再実行してください。

(3) 同一のvCenterサーバまたはESXサーバに対してこの部品を複数同時に実行した場合，ログバンドル取得処理が競合して部品が異常終了することがあります。その場合は再実行してください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。

バージョン

02.11.00

部品のタグ

Gather VM information,VMware vSphere

タスクログに表示される部品の名称

vsphereGetLogBundle

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmHostName

ESXサーバ名

VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。省略した場合，vCenterサーバからログバンドルを取得します。

−　

入力

△　

VMware.logBundleTargetOption

ログバンドル取得対象オプション

ESXサーバからログバンドルを取得する際に，vCenterサーバからもログバンドルを取得する場合は"true"を指定します。"true"以外の場合は，ESXサーバのログバンドルだけを取得します。

True

入力

△　

common.outputFolderPath

ファイル出力先フォルダパス

取得したログバンドルの出力先となる実行対象サーバ上のフォルダをフルパスで指定します。

−　

入力

○　

VMware.esxLogBundlePath

ESXサーバのログバンドルパス

ESXサーバから取得したログバンドルのフルパスが格納されます。

−　

出力

△　

VMware.vCenterLogBundlePath

vCenterサーバのログバンドルパス

vCenterサーバから取得したログバンドルのフルパスが格納されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.27　仮想サーバDRSグループの設定

機能

VMware vSphere環境で，vSphere DRSクラスタに設定されている仮想サーバDRSグループに仮想サーバを追加，または削除します。

また，仮想サーバDRSグループに仮想サーバを追加する際に，指定された仮想サーバDRSグループが存在しない場合は，仮想サーバDRSグループを新規に作成します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXiがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・DRSクラスタ

　vSphere DRSクラスタまたはvSphere DRSクラスタを構成しているサーバです。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです。

仮想サーバDRSグループ設定モード(VMware.setVmDrsGroupModeプロパティ)について次に示します。

・仮想サーバDRSグループに仮想サーバを追加する場合は，"Add"を指定してください。

・仮想サーバDRSグループから仮想サーバを削除する場合は，"Delete"を指定してください。

利用場面

DRSクラスタ環境に仮想サーバを追加した際に，仮想サーバDRSグループに仮想サーバを追加，または削除する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(2)仮想サーバを管理するVMware vSphere ESXの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXがVMware vCenter Serverで管理されていること。

(2)VMware vCenter Server上の設定に関する条件

　・vSphere DRSクラスタ，仮想サーバの名称が一意であること。

　・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，この部品が実行するvSphere Power CLIからは，指定した名称の英字の大文字・小文字を区別できません。

　　そのため，英字の大文字・小文字が異なる同名の名称を使用している環境に対して，この部品を使用することはできません。

　　- DRSクラスタ名

　　- 仮想サーバ名

　　- DRSグループ名(ホストDRSグループ名および仮想サーバDRSグループ名)

(3)vSphere DRSクラスタが構築されていること。

(4)仮想サーバがDRSクラスタ名(VMware.drsClusterNameプロパティ)に指定するvSphere DRSクラスタに所属していること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)仮想サーバDRSグループ名(VMware.vmDrsGroupNameプロパティ)に仮想サーバを追加する際に，既に登録されている仮想サーバを仮想サーバ名(VMware.vmNameプロパティ)に指定した場合，この部品は異常終了します。また，仮想サーバDRSグループ名(VMware.vmDrsGroupNameプロパティ)から仮想サーバを削除する際に，登録されていない仮想サーバを仮想サーバ名(VMware.vmNameプロパティ)に指定した場合，この部品は異常終了します。

(3)この部品は，仮想サーバDRSグループを削除しません。そのため，仮想サーバDRSグループから仮想サーバを削除する際に，仮想サーバDRSグループに登録されている仮想サーバの数が0になる場合は，この部品は異常終了します。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。

バージョン

02.11.00

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereSetDrsVmGroup

戻り値

戻り値

説明

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.drsClusterName

DRSクラスタ名

VMware vCenter Serverが管理するvSphere DRSクラスタ名を指定します。

−　

入力

○　

VMware.vmDrsGroupName

仮想サーバDRSグループ名

仮想サーバを追加または削除する仮想サーバDRSグループの名称を指定します。

−　

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します（VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません）。

−　

入力

○　

VMware.setVmDrsGroupMode

仮想サーバDRSグループ設定モード

仮想サーバDRSグループに仮想サーバを追加する場合は"Add"を，削除する場合は"Delete"を指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.28　仮想サーバのIPアドレス取得

機能

VMware vSphere環境で，指定した仮想サーバのIPアドレスを取得します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXによって管理されている仮想サーバです。

出力プロパティVMware.vmIPaddressに取得したIPアドレスを出力します。仮想サーバに複数のIPアドレスが設定されている場合には，コンマ区切りで出力します。ただし，IPアドレスの長さの合計が1024文字を超える場合，1025文字以降は切り捨てられます。取得するIPアドレスの種類は次の3種類であり，IPv4だけの場合は65個以上で1024文字を超える場合があります。

・IPv4(最大長16文字)

・IPv6(最大長36文字)

・DHCPによって設定されたIPv4とIPv6

利用場面

仮想サーバ設定されているIPアドレスの確認や，仮想サーバに対してICMPエコー要求を発行する場合に利用できます。

ICMPエコー要求を発行する処理は，この部品で仮想サーバのIPアドレスを取得を行い，osSendIcmp部品の入力として使用するという流れになります。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)仮想サーバが起動していること。

(3)仮想サーバ名はvCenterサーバ内で一意になっていること。

(4)対象となる仮想サーバに，VMwareToolsがインストールされていること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　対象とする仮想サーバに対して「読み取り専用」の権限を持つロール，またはシステム管理者ロール

バージョン

02.11.00

部品のタグ

Gather VM information,VMware vSphere

タスクログに表示される部品の名称

vsphereGetVMIPaddress

戻り値

戻り値

説明

0

正常

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

30

異常(IPアドレス取得不正) IPアドレスの未取得

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

VMware.vmIPaddress

仮想サーバのIPアドレス

仮想サーバのIPアドレスを格納するプロパティです。仮想サーバに複数のIPアドレスが設定されている場合には，コンマ区切りで出力されます。

−　

出力

△　

5.11.29　仮想サーバのOS初期設定&IPアドレス設定(Linux)

機能

VMware vSphere環境の仮想サーバ(Linux)に対してOSの初期設定(コンピュータ名，タイムゾーン)，およびIPアドレス設定を行います。

新規作成された仮想サーバを起動して，OSの初期化とカスタマイズ処理を行います。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXi(またはVMware ESX Server)がインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESX(またはVMware ESX Server)によって管理されている仮想サーバです。

仮想サーバは最大4個までIPアドレスを設定することができます。1個目のIPアドレス(管理用)には，デプロイした仮想サーバを管理するためのIPアドレスを設定してください。2〜4個目のIPアドレス(2個目用)・IPアドレス(3個目用)・IPアドレス(4個目用)については，管理用・業務用IPアドレスをユーザーの運用に合わせて設定してください。仮想サーバが持つNICの数によってIPアドレスの設定順序は次のようになります。

　・仮想サーバがNICを1個持つ場合

　　NICには，IPアドレス(管理用)>IPアドレス(2個目用)>IPアドレス(3個目用)>IPアドレス(4個目用)の順で最初に指定されていたIPアドレスを設定します。その他のIPアドレスは破棄されますのでご注意ください。

　・仮想サーバがNICを2個以上持つ場合

　　NICには，IPアドレス(管理用)>IPアドレス(2個目用)>IPアドレス(3個目用)>IPアドレス(4個目用)の順でIPアドレスを設定します。IPアドレスの指定に空きがある場合，詰めて設定します。例えば，指定するIPアドレスがIPアドレス(管理用)，IPアドレス(2個目用)，IPアドレス(4個目用)の場合(IPアドレス(3個目用)がない場合)，IPアドレス(4個目用)は仮想マシンの3つ目のNICに設定します。入力したIPアドレスの数が仮想サーバが持つNICの数より多い場合，超えた分のIPアドレスは破棄されますのでご注意ください。

DNSサーバのIPアドレスはNICごとではなく，仮想サーバに対して設定されます。仮想サーバには，DNSサーバのIPアドレス(管理用)>DNSサーバのIPアドレス(2個目用)>DNSサーバのIPアドレス(3個目用)>DNSサーバのIPアドレス(4個目用)の順で最初に指定されていたDNSサーバのIPアドレスを設定します。

指定可能なタイムゾーンは次のとおりです。

　　America/Adak

　　America/Anchorage

　　America/Boise

　　America/Chicago

　　America/Denver

　　America/Detroit

　　America/Indiana/Indianapolis

　　America/Indiana/Knox

　　America/Indiana/Marengo

　　America/Indiana/Petersburg

　　America/Indiana/Tell_City

　　America/Indiana/Vevay

　　America/Indiana/Vincennes

　　America/Indiana/Winamac

　　America/Juneau

　　America/Kentucky/Monticello

　　America/Los_Angeles

　　America/LouisVille

　　America/Menominee

　　America/Monterrey

　　America/Montevideo

　　America/New_York

　　America/Nome

　　America/North_Dakota/Beulah

　　America/North_Dakota/Center

　　America/North_Dakota/New_Salem

　　America/Phoenix

　　America/Shiprock

　　America/Tijuana

　　America/Vancouver

　　America/Yakutat

　　Asia/Chongqing

　　Asia/Hong_Kong

　　Asia/Kolkata

　　Asia/Macau

　　Asia/Shanghai

　　Asia/Singapore

　　Asia/Tokyo

　　Etc/UTC

　　Europe/London

　　Pacific/Honolulu

指定がない場合，テンプレートのタイムゾーンが使用されます。このため，タイムゾーンプロパティのリストに設定したい値が存在しない場合は，事前にテンプレートにタイムゾーンを設定してください。

利用場面

Linuxの仮想サーバを作成する場合に利用できます。部品vsphereCreateVMの実行後に呼び出すことで，OSの初期設定を行うことができます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)ESXサーバの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)(vCenter4.1以降。vCenter4.0では未サポート)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)VMware vSphere ESXi(またはVMware ESX Server)上の設定に関する条件

　・データストアが登録済みであること。

　・ポートグループが設定済みであること。仮想サーバに設定するポートグループは，標準仮想スイッチ(vNetwork 標準スイッチ/vSphere 標準スイッチ)を使ったネットワーク上のポートグループを指定してください。

(3)仮想サーバに関する条件

　・VMware Toolsがインストール済みであること。

　・リモートコマンドが実行可能な設定であること(仮想サーバにおいてSSHが有効になっていること)。

　・NICが設定してあること(最大4個まで)。

(4)仮想サーバに関する条件

　・同一のvCenterの管理下で，仮想サーバ名が重複しないこと。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)作成する仮想サーバがLinuxの場合，ドメイン名，DNSサフィックスが必須となります。指定がない場合，"localdomain"が設定されます。

(2)IPアドレス，サブネットマスク，デフォルトゲートウェイは，3つの情報を同時に指定してください。どれかの指定がない場合，3つとも設定は行われません。

(3)OS情報取得の繰り返し回数の指定がない場合，"72"が設定されます。

(4)OS情報取得の繰り返し実行間隔の指定がない場合，"5"が設定されます。

(5)仮想サーバのOSに設定するIPアドレスについて，IPアドレスとして設定できない値は入力しないでください。例えば，ネットワークアドレスやブロードキャストアドレス，「0.0.0.0」や「255.255.255.255」などの特殊なアドレスは指定できません。入力した場合，仮想サーバのデプロイはエラーとなります。また，IPアドレス(管理用)には，JP1/AOサーバと通信できるIPアドレスを入力してください。正しいアドレスであっても，デプロイに失敗するおそれがあります。

(6)IPアドレスは「機能」に記載のとおり設定されますが，仮想サーバのOSにNICを設定した順番によっては，意図どおりIPアドレスが設定されない場合があるため，仮想サーバ作成後はIPアドレスが意図どおり設定されているか確認してください。もし設定されていない場合は，手動で変更してください。

(7)Linuxのデプロイを行う場合，テンプレートOSのrootパスワードはLinux.adminPasswordプロパティで指定可能な文字で設定してください。

(8)仮想サーバに設定するIPアドレスは，他のサーバと重複しないようにしてください。他のサーバとIPアドレスが重複していると，仮想サーバのNICが無効状態となり，タスクが異常終了します。

(9)仮想サーバのOSがRed Hat Enterprise Linux Server 7 (64-bit x86_64)の場合，VMware Toolsはopen-vm-tools 9.10以降のものを使用してください。open-vm-tools 9.10より前のバージョンの場合，ホスト名が変更されず，OS情報取得の繰り返し回数×OS情報取得の実行間隔の間，部品が終了しません。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　システム管理者ロール

バージョン

02.11.00

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereSetOsinfoLin

戻り値

戻り値

説明

0

正常

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

28

異常(ネットワーク起動不正) 電源起動後のネットワーク起動確認不可

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

common.computerName

コンピュータ名/ホスト名

OSのコンピュータ名(ホスト名)を指定します。Windowsの場合，最大15文字まで，Linuxの場合，最大63文字まで指定します。

−　

入力

○　

OS.ipAddressMan

IPアドレス(管理用)

仮想サーバに設定する管理用LANのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.subnetMaskMan

サブネットマスク(管理用)

仮想サーバに設定する管理用LANのサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.defaultGWMan

デフォルトゲートウェイ(管理用)

仮想サーバに設定する管理用LANのデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.dnsMan

DNSサーバのIPアドレス(管理用)

仮想サーバに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.ipAddress2

IPアドレス(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.subnetMask2

サブネットマスク(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.defaultGW2

デフォルトゲートウェイ(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.dns2

DNSサーバのIPアドレス(2個目用)

仮想サーバに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.dnsSuffix

DNS サフィックス名 :Linux固有

DNSサフィックス名を指定します(Linuxの場合だけ)。入力がない場合，"localdomain"が設定されます。

−　

入力

△　

OS.workgroupNameDomainName

ドメイン名

仮想サーバが所属するドメイン名を指定します。

−　

入力

△　

Linux.adminPassword

OSのrootユーザーのパスワード :Linux固有

OS設定の確認をするためのOSのrootユーザーのパスワードを設定します。作成するOSがLinuxの場合に必ず指定します。

−　

入力

○　

VMware.checkOSInitCount

OS情報取得の繰り返し回数

OS初期設定の完了確認のため，OS情報を取得する際の繰り返し回数を指定します。OS情報取得の実行間隔と組み合わせて最大待ち時間となります。

72

入力

△　

VMware.checkOSInitInterval

OS情報取得の実行間隔(分)

OS初期設定の完了確認のため，OS情報を取得する際の実行間隔を指定します。

5

入力

△　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

OS.timeZone

タイムゾーン

仮想サーバのOSに設定するタイムゾーンを指定します。入力がない場合，テンプレートのタイムゾーンが使用されます。

−　

入力

△　

OS.ipAddress3

IPアドレス(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.subnetMask3

サブネットマスク(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.defaultGW3

デフォルトゲートウェイ(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.dns3

DNSサーバのIPアドレス(3個目用)

仮想サーバに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.ipAddress4

IPアドレス(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.subnetMask4

サブネットマスク(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.defaultGW4

デフォルトゲートウェイ(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.dns4

DNSサーバのIPアドレス(4個目用)

仮想サーバに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

common.flag2IPsSetup

仮想サーバに複数のIPアドレスを設定したかどうか

仮想サーバに複数IPアドレスを設定したとき（TRUE），それ以外のとき（FALSE）を格納するプロパティです。

−　

出力

△　

5.11.30　仮想サーバのOS初期設定&IPアドレス設定(Windows)

機能

VMware vSphere環境の仮想サーバ(Windows)に対してOSの初期設定(コンピュータ名，会社名，組織名，タイムゾーン)，およびIPアドレス設定を行います。

新規作成された仮想サーバを起動して，sysprepユーティリティによってOSの初期化とカスタマイズ処理を行います。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXi(またはVMware ESX Server)がインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESX(またはVMware ESX Server)によって管理されている仮想サーバです。

仮想サーバは最大4個までIPアドレスを設定することができます。1個目のIPアドレス(管理用)には，デプロイした仮想サーバを管理するためのIPアドレスを設定してください。2〜4個目のIPアドレス(2個目用)・IPアドレス(3個目用)・IPアドレス(4個目用)については，管理用・業務用IPアドレスをユーザーの運用に合わせて設定してください。仮想サーバが持つNICの数によってIPアドレスの設定順序は次のようになります。

　・仮想サーバがNICを1個持つ場合

　　NICには，IPアドレス(管理用)>IPアドレス(2個目用)>IPアドレス(3個目用)>IPアドレス(4個目用)の順で最初に指定されていたIPアドレスを設定します。その他のIPアドレスは破棄されますのでご注意ください。

　・仮想サーバがNICを2個以上持つ場合

　　NICには，IPアドレス(管理用)>IPアドレス(2個目用)>IPアドレス(3個目用)>IPアドレス(4個目用)の順でIPアドレスを設定します。IPアドレスの指定に空きがある場合，詰めて設定します。例えば，指定するIPアドレスがIPアドレス(管理用)，IPアドレス(2個目用)，IPアドレス(4個目用)の場合(IPアドレス(3個目用)がない場合)，IPアドレス(4個目用)は仮想マシンの3つ目のNICに設定します。入力したIPアドレスの数が仮想サーバが持つNICの数より多い場合，超えた分のIPアドレスは破棄されますのでご注意ください。

指定可能なタイムゾーンは次のとおりです。

　　Alaskan

　　Central (U.S. and Canada)

　　Central America+B28

　　China

　　Eastern (U.S. and Canada)

　　GMT (Greenwich Mean Time)

　　Hawaii

　　India

　　Mountain (U.S. and Canada)

　　Pacific

　　Singapore

　　Tokyo

　　U.S. Eastern: Indiana (East)

　　U.S. Mountain: Arizona

指定がない場合，「国際日付変更線 西側」のタイムゾーンが設定されます。

利用場面

Windowsの仮想サーバを作成する場合に利用できます。部品vsphereCreateVMの実行後に呼び出すことで，OSの初期設定を行うことができます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)ESXサーバの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)VMware vSphere ESXi(またはVMware ESX Server)上の設定に関する条件

　・データストアが登録済みであること。

　・ポートグループが設定済みであること。仮想サーバに設定するポートグループは，標準仮想スイッチ(vNetwork 標準スイッチ/vSphere 標準スイッチ)を使ったネットワーク上のポートグループを指定してください。

(3)仮想サーバに関する条件

　・VMware Toolsがインストール済みであること。

　・リモートコマンドが実行可能な設定であること(管理共有が有効になっていること)。

　・NICが設定してあること(最大4個まで)。

　・Administrator のパスワードを空にしておくこと。

　・Windowsの初期化の実行回数が限度回数(3回)に達していないこと。

(4)仮想サーバに関する条件

　・同一のvCenterの管理下で，仮想サーバ名が重複しないこと。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)作成する仮想サーバがWindowsの場合，組織名と所有者名は必須となります。組織名の指定がない場合は，"Organization"が設定されます。所有者名の指定がない場合は，"Owner"が設定されます。

(2)作成する仮想サーバがWindowsの場合，OSユーザーパスワードとOSユーザーパスワード再入力は必須となります。どちらかの指定がない場合，"Password123"がパスワードに設定されます。また，2つの値が合致しない場合も"Password123"がパスワードに設定されます。

(3)作成する仮想サーバがWindowsの場合，OS.selectWorkgroupDomainの選択リストで，WORKGROUPかDOMAINの指定が必須となります。どちらの指定もない場合，ワークグループとして"WORKGROUP"が設定されます。また，ワークグループ名/ドメイン名の入力がない場合も，ワークグループとして"WORKGROUP"が設定されます。

(4)作成する仮想サーバがWindowsの場合，OS.selectWorkgroupDomainの選択リストで，WORKGROUPを選択したとき，指定できるワークグループ名は最大15byteまでとなります。15byteを超えると"WORKGROUP"が設定されます。

(5)作成する仮想サーバがWindowsの場合，OS.selectWorkgroupDomainの選択リストで，DOMAINを選択したとき，ドメイン名，ドメイン ユーザー名，ドメイン パスワードが必須となります。どれかの指定がない場合，または値が誤っている場合，ワークグループとして"WORKGROUP"が設定されます。

(6)IPアドレス，サブネットマスク，デフォルトゲートウェイ，DNSサーバは，4つの情報を同時に指定してください。どれかの指定がない場合，4つとも設定は行われません。

(7)(2)OSの初期設定処理で，OSに設定した情報を取得できるかどうかによって初期設定が完了したかどうかを確認します。この初期設定完了の確認時間は，OS情報取得の繰り返し時間(VMware.checkOSInitCountIntervalプロパティ)に指定した時間と，OS情報取得の繰り返し回数(VMware.checkOSInitCountプロパティ)に指定した回数によって決定します。ご使用の環境に応じて，処理が打ち切られない値を設定してください。

(8)OS情報取得の繰り返し回数の指定がない場合，"72"が設定されます。

(9)OS情報取得の繰り返し実行間隔の指定がない場合，"5"が設定されます。

(10)仮想サーバのOSに設定するIPアドレスについて，IPアドレスとして設定できない値は入力しないでください。例えば，ネットワークアドレスやブロードキャストアドレス，「0.0.0.0」や「255.255.255.255」などの特殊なアドレスは指定できません。入力した場合，仮想サーバのデプロイはエラーとなります。また，IPアドレス(管理用)には，JP1/AOサーバと通信できるIPアドレスを入力してください。正しいアドレスであっても，デプロイに失敗するおそれがあります。

(11)IPアドレスは「機能」に記載のとおり設定されますが，仮想サーバのOSにNICを設定した順番によっては，意図どおりIPアドレスが設定されない場合があるため，仮想サーバ作成後はIPアドレスが意図どおり設定されているか確認してください。もし設定されていない場合は，手動で変更してください。

(12)仮想サーバに設定するIPアドレスは，他のサーバと重複しないようにしてください。他のサーバとIPアドレスが重複していると，仮想サーバのNICが無効状態となり，タスクが異常終了します。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　システム管理者ロール

バージョン

02.11.00

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereSetOsinfoWin

戻り値

戻り値

説明

0

正常

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

28

異常(ネットワーク起動不正) 電源起動後のネットワーク起動確認不可

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

common.computerName

コンピュータ名/ホスト名

OSのコンピュータ名(ホスト名)を指定します。Windowsの場合，最大15文字まで，Linuxの場合，最大63文字まで指定します。

−　

入力

○　

Windows.orgName

組織名(会社名) :Windows固有

仮想サーバのOSに設定する組織名を指定します。(Windowsの場合だけ)。入力がない場合，"Organization"が設定されます。

−　

入力

△　

Windows.ownerName

名前(所有者名) :Windows固有

仮想サーバのOSに設定する名前(所有者名)を指定します。(Windowsの場合だけ)。入力がない場合，"Owner"が設定されます。

−　

入力

△　

OS.ipAddressMan

IPアドレス(管理用)

仮想サーバに設定する管理用LANのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.subnetMaskMan

サブネットマスク(管理用)

仮想サーバに設定する管理用LANのサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.defaultGWMan

デフォルトゲートウェイ(管理用)

仮想サーバに設定する管理用LANのデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.dnsMan

DNSサーバのIPアドレス(管理用)

仮想サーバに設定する管理用LANのDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.ipAddress2

IPアドレス(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.subnetMask2

サブネットマスク(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.defaultGW2

デフォルトゲートウェイ(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.dns2

DNSサーバのIPアドレス(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.workgroupNameDomainName

ワークグループ名/ドメイン名

仮想サーバが所属するワークグループ名/ドメイン名を指定します。ワークグループ名は，最大15文字まで指定します。ドメイン名は，Windowsの場合，最大63文字まで，Linuxの場合，最大256文字まで指定します。

−　

入力

△　

OS.domainUserName

ドメインのユーザー名 :Windows固有

仮想サーバが所属するドメインのユーザー名を指定します。(Windowsの場合だけ)。ワークグループ/ドメインの選択で"DOMAIN"を選択した場合，入力する必要があります。

−　

入力

△　

OS.domainUserPassword

ドメインのパスワード :Windows固有

仮想サーバが所属するドメインのパスワードを指定します。(Windowsの場合だけ)。ワークグループ/ドメインの選択で"DOMAIN"を選択した場合，入力する必要があります。

−　

入力

△　

OS.selectWorkgroupDomain

ワークグループ/ドメインの選択 :Windows固有

仮想サーバがワークグループまたはドメインのどちらに所属するかを指定します(Windowsの場合だけ)。

−　

入力

△　

common.osUserPassword

Administratorのパスワード :Windows固有

OSに設定するAdministratorのパスワードを指定します(Windowsの場合だけ)。入力がない場合は，"Password123"が設定されます。

−　

入力

△　

common.osUserPasswordReEnter

Administratorのパスワード再入力 :Windows固有

OSに設定するAdministratorのパスワードを再入力してください(Windowsの場合だけ)。入力がない場合は，"Password123"が設定されます。

−　

入力

△　

OS.productKey

OSのプロダクトキー :Windows固有

OSのプロダクトキーを指定します。Windowsの場合だけ指定します。入力の形式は「XXXXX-XXXXX-XXXXX-XXXXX-XXXXX」です(Windowsの場合だけ)。

−　

入力

△　

VMware.checkOSInitCount

OS情報取得の繰り返し回数

OS初期設定の完了確認のため，OS情報を取得する際の繰り返し回数を指定します。OS情報取得の実行間隔と組み合わせて最大待ち時間となります。

72

入力

△　

VMware.checkOSInitInterval

OS情報取得の実行間隔(分)

OS初期設定の完了確認のため，OS情報を取得する際の実行間隔を指定します。

5

入力

△　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

OS.timeZone

タイムゾーン

仮想サーバのOSに設定するタイムゾーンを指定します。入力がない場合，「国際日付変更線 西側」のタイムゾーンが設定されます。

−　

入力

△　

OS.ipAddress3

IPアドレス(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.subnetMask3

サブネットマスク(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.defaultGW3

デフォルトゲートウェイ(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.dns3

DNSサーバのIPアドレス(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.ipAddress4

IPアドレス(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.subnetMask4

サブネットマスク(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.defaultGW4

デフォルトゲートウェイ(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.dns4

DNSサーバのIPアドレス(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

common.flag2IPsSetup

仮想サーバに複数のIPアドレスを設定したかどうか

仮想サーバに複数IPアドレスを設定したとき（TRUE），それ以外のとき（FALSE）を格納するプロパティです。

−　

出力

△　

5.11.31　仮想サーバのクローン作成

機能

VMware vSphere環境において仮想サーバのクローンを作成します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ

　VMware vSphere PowerCLIがインストールされているサーバです。

・クローン対象となる仮想サーバ

　vCenterサーバおよびVMware vSphere ESXi(またはVMware ESX Server)によって管理されている仮想サーバです。

・クローン

　クローン対象となる仮想サーバの複製です。クローン名は仮想サーバの複製の名称です。

利用場面

仮想サーバの作成のあと，仮想サーバのバックアップとしてクローンを作成します。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1)クローン対象となる仮想サーバの電源状態がOFFであること。

(2)仮想サーバをリソースプールに格納する場合，リソースプール，クラスタの名称が一意であること。

　クラスタとリソースプールの組み合わせなど，種別が異なっていても，同じ名前にすることはできません。

(3)同一のvCenterの管理下において，クローン名が重複しないこと。既存の仮想サーバ名とも重複しないこと。

(4)同一のvCenterの管理下において，データストア名が重複しないこと。

(5)対象となる仮想サーバに，VMware Toolsがインストールされていること。

(6)クローン対象となる仮想サーバを管理しているVMware vSphere ESXi(またはVMware ESX Server）と，クローン作成先のVMware vSphere ESXi(またはVMware ESX Server）のバージョンは同一であること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)仮想サーバのクローン作成中は，当該仮想サーバ，および作成先クローンの操作を行わないでください。vCenterサーバからも直接操作を行わないでください。クローン作成に失敗するおそれがあります。

(2)クローン対象となる仮想サーバにRawディスク，RDMディスクが設定されている場合， それらのディスクは仮想ディスクに変換されます。

(3)クローンの作成先にvAppは指定できません。

(4)作成したクローンは起動しないでください。起動する場合は，クローン対象となった仮想サーバの削除またはリストアが必要です。

(5)クローン対象となる仮想サーバにスナップショットが作成されている場合は，すべて削除されます(使用中のスナップショットはコミットされます)。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。

バージョン

02.11.00

部品のタグ

Clone VM,VMware vSphere

タスクログに表示される部品の名称

vsphereCreateClone

戻り値

戻り値

説明

0

正常

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号（VMware vCenter ServerのWebサービス用）を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.cloneName

クローン名

クローンの名称を指定します(VMware vCenter Serverにおけるクローンの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

VMware.vmName

仮想サーバ名

クローン作成元になる仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

VMware.vmHostName

ESXサーバ名

クローン作成先のVMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。

−　

入力

○　

VMware.dataStoreName

データストア名

クローン作成先のデータストアの名称を指定します。

−　

入力

○　

VMware.resourcePoolName

リソースプール名

クローン作成先のリソースプール，クラスタを指定します。

−　

入力

△　

VMware.diskFormat

仮想ディスクのフォーマット

クローン作成先の仮想ディスクのフォーマットを指定します。

クローン作成元の仮想サーバの仮想ディスクと同じフォーマットの場合は「Default」，仮想ディスクをオンデマンドでコミットする場合は「Thin」，仮想ディスクをフルサイズでコミットする場合は「Thick」を指定します。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.32　仮想サーバのクローン削除

機能

VMware vSphere環境において仮想サーバのクローンを削除します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ

　VMware vSphere PowerCLIがインストールされているサーバです。

・クローン対象となる仮想サーバ

　vCenterサーバおよびVMware vSphere ESXi(またはVMware ESX Server)によって管理されている仮想サーバです。

・クローン

　クローン対象となる仮想サーバの複製です。クローン名は仮想サーバの複製の名称です。

利用場面

クローンを削除する場合に使用します。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)同一のvCenterの管理下において，クローン名が重複しないこと。既存の仮想サーバ名とも重複しないこと。

(3)クローンの電源状態がOFFであること。

(4)対象となる仮想サーバに，VMware Toolsがインストールされていること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)クローン削除中は，他のサービスから当該クローンの操作を行わないでください。クローン削除に失敗するおそれがあります。vCenterサーバからも直接操作を行わないでください。

(2)クローン名とクローン作成元の仮想サーバ名に同じ名称を指定すると，クローンの削除を行ないません。

(3)クローン名とクローン作成元の仮想サーバ名は大文字と小文字を区別しない。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。

バージョン

02.11.00

部品のタグ

Delete Cloned VM,VMware vSphere

タスクログに表示される部品の名称

vsphereDeleteClone

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号（VMware vCenter ServerのWebサービス用）を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.cloneName

クローン名

削除するクローンの名称を指定します(VMware vCenter Serverにおけるクローンの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

VMware.vmName

クローン作成元の仮想サーバ名

クローン作成元の仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。誤ってクローン作成元を削除しないため確認用として指定してください。この仮想サーバは削除されません。クローン作成元の仮想サーバが既に削除されているか，名称が不明の場合は，仮想サーバ削除サービスを使用してクローンを削除して下さい。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.33　仮想サーバのシャットダウン

機能

VMware vSphere環境で，仮想サーバのOSに対してシャットダウンを実行します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXによって管理されている仮想サーバです。

仮想サーバを停止する際には，VMware.checkPowerStateIntervalプロパティに指定した秒数待ち合わせ，電源状態がOFFになることを確認する動作を，VMware.checkPowerStateCountプロパティに指定した回数繰り返します。デフォルトの値で不都合がある場合，利用している環境に合わせて調整してください。

部品が正常終了した場合は，出力プロパティVMware.powerStateに"PoweredOff"を格納します。

利用場面

仮想サーバのシャットダウンを行いたい場合に使用できます。

シャットダウンは，部品「vsphereGetPower」実行後，電源状態が"PoweredOn"である場合に，この部品を実行するという流れになります。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)仮想サーバが起動していること。

(3)仮想サーバ名はvCenterサーバ内で一意になっていること。

(4)対象となる仮想サーバに，VMwareToolsがインストールされていること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　対象とする仮想サーバに対して「パワーオフ」の権限を持つロール，またはシステム管理者ロール

バージョン

02.11.00

部品のタグ

Control VM,VMware vSphere

タスクログに表示される部品の名称

vsphereSetPowerOff

戻り値

戻り値

説明

0

正常

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

29

異常(シャットダウン終了確認不正) シャットダウンの終了確認不可

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.checkPowerStateCount

電源状態の確認回数

仮想サーバの停止を確認する際の，電源状態の確認回数を指定します。電源状態の確認間隔と組み合わせて最大待ち時間となります。

60

入力

○　

VMware.checkPowerStateInterval

電源状態の確認間隔

仮想サーバの停止を確認する際の，電源状態の確認間隔を秒単位で指定します。

10

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

VMware.powerState

仮想サーバの電源状態

仮想サーバの電源状態が格納されます。

−　

出力

△　

5.11.34　仮想サーバのスナップショット移動

機能

VMware vSphere環境において，仮想サーバで使用しているスナップショットを，仮想サーバ上の指定されたスナップショットに移動します。

現在使用中のスナップショットを移動先に指定した場合は，スナップショット作成時の状態に移行します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXi(またはVMware ESX Server)によって管理されている仮想サーバです。

利用場面

仮想サーバが使用するスナップショットを指定したスナップショットへの移動に使用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)仮想サーバに関する条件

　・同一のvCenterの管理下において，仮想サーバ名が重複しないこと。

　・仮想サーバに，VMware Toolsがインストールされていること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)Rawディスク，RDM物理モードディスク，および独立ディスクが設定されている仮想サーバを対象にしないでください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

システム管理者ロール

バージョン

02.11.00

部品のタグ

Move VM Snapshot,VMware vSphere

タスクログに表示される部品の名称

vsphereMoveSnapshot

戻り値

戻り値

説明

0

正常

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号（VMware vCenter ServerのWebサービス用）を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します（VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません）。

−　

入力

○　

VMware.snapshotId

スナップショットのID

スナップショットのIDを指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.35　仮想サーバのスナップショット作成

機能

VMware vSphere環境において，仮想サーバのスナップショットを作成します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXi(またはVMware ESX Server)によって管理されている仮想サーバです。

利用場面

仮想サーバの状態およびデータを変更する場合に，変更前の仮想サーバに対するスナップショットの作成に使用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)仮想サーバに関する条件

　・同一のvCenterの管理下において，仮想サーバ名が重複していないこと。

　・仮想サーバに，VMware Toolsがインストールされていること。

・同一の仮想サーバ内で，スナップショット名が重複していないこと。

・対象の仮想サーバの電源がOFFになっていること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)仮想サーバのバックアップ目的で使用しないでください。

(2)Rawディスク，RDM物理モードディスク，および独立ディスクが設定されている仮想サーバを対象にしないでください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

システム管理者ロール

バージョン

02.11.00

部品のタグ

Snapshot VM,VMware vSphere

タスクログに表示される部品の名称

vsphereCreateSnapshot

戻り値

戻り値

説明

0

正常

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号（VMware vCenter ServerのWebサービス用）を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します（VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません）。

−　

入力

○　

VMware.snapshotName

スナップショット名

スナップショットの名称を指定します。

temp_snapshot_01

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.returnSnapshotId

スナップショットのID

この部品で使用したスナップショットのIDが格納されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.36　仮想サーバのスナップショット削除

機能

VMware vSphere環境で，仮想サーバの指定されたスナップショットを削除します。

現在使用中のスナップショットを削除対象に指定した場合は，スナップショット作成元の仮想ディスクに変更が確定されます。

削除するスナップショットは，スナップショットのIDか，スナップショット名を指定することができます。

スナップショットのIDを指定する場合は，スナップショットのID(VMware.snapshotIdプロパティ)を使用してください。

スナップショット名を指定する場合，スナップショット名(VMware.snapshotNameプロパティ)を使用してください。

両方を指定した場合，またはどちらも指定しない場合，部品は異常終了します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXi(またはVMware ESX Server)がインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXi(またはVMware ESX Server)によって管理されている仮想サーバです。

利用場面

スナップショットの削除に使用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)仮想サーバに関する条件

　・同一のvCenterの管理下において，仮想サーバ名が重複しないこと。

　・同一の仮想サーバ上において，スナップショット名が重複しないこと。

　・仮想サーバに，VMware Toolsがインストールされていること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)Rawディスク，RDM物理モードディスク，および独立ディスクが設定されている仮想サーバを対象にしないでください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。

バージョン

02.11.00

部品のタグ

Delete VM Snapshot,VMware vSphere

タスクログに表示される部品の名称

vsphereRemoveSnapshot

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

VMware.snapshotId

スナップショットのID

スナップショットのIDを指定します。

−　

入力

△　

VMware.snapshotName

スナップショット名

スナップショットの名称を指定します。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.37　仮想サーバのマイグレーション

機能

VMware vSphere環境で，指定された仮想サーバをマイグレーションします。

vSphere Clientの仮想サーバおよびテンプレートの画面で，仮想サーバの表示される位置を指定されたフォルダに変更します。

仮想サーバを移動する場合は，仮想サーバの移動先(VMware.destinationNameプロパティ)を指定します。

移動先には，VMware vSphere ESXi(またはVMware ESX Server)またはリソースプール，クラスタを指定できます。

また，vSphere Clientの仮想マシンおよびテンプレートの画面において，仮想サーバを移動する場合は，仮想サーバの移動先にフォルダの名称を指定してください。

仮想サーバを配置するデータストアを移動する場合は，仮想サーバの移動先(データストア)名(VMware.destinationDataStoreNameプロパティ)を指定します。

移動先には，データストアの名称を指定してください。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXi(またはVMware ESX Server)がインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXi(またはVMware ESX Server)によって管理されている仮想サーバです。

プロパティ設定の留意点を次に示します。

・ESXサーバのバージョンが"5.0"以前の場合

　起動している仮想サーバを仮想サーバ名(VMware.vmNameプロパティ)に指定する場合，仮想サーバの移動先(VMware.destinationNameプロパティ)と仮想サーバの移動先(データストア)名(VMware.destinationDataStoreNameプロパティ)を同時に指定することはできません。

利用場面

・この部品は，物理マシンのメモリ増設やCPU交換などのメンテナンス時や，特定のVMware vSphere ESXi(またはVMware ESX Server)が高負荷によって処理性能不足となった場合に，仮想サーバをマイグレーションする際に利用できます。

・この部品は，仮想サーバの追加やデータストアの容量変更などによって，仮想サーバの再配置が必要になった場合，仮想サーバを配置するデータストアを別のデータストアにマイグレーションする際に使用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)仮想サーバに関する条件

　・同一のvCenterの管理下で，仮想サーバ名が重複しないこと。

　・仮想サーバに，VMwareToolsがインストールされていること。

　・同一のvCenterの管理下で，データストア名が重複していないこと。　

(3)VMware vSphere ESX上の設定に関する条件

　・VMware vSphere ESXのバージョンが5.0以前の場合

　　仮想サーバのマイグレーションをする場合は，対象となる仮想サーバの環境が，vMotionの前提条件を満たしていること。

　　仮想サーバを配置するデータストアを移動する場合は，対象となる仮想サーバの環境が，Storage vMotionの前提条件を満たしていること。

　・VMware vSphere ESXのバージョンが5.1以降の場合

　　仮想サーバのマイグレーションをする場合は，対象となる仮想サーバの環境が，vMotionまたはCross-Host Storage vMotionの前提条件を満たしていること。

　　仮想サーバを配置するデータストアを移動する場合は，対象となる仮想サーバの環境が，Storage vMotionまたはCross-Host Storage vMotionの前提条件を満たしていること。　　

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)移動元と移動先の仮想化ソフトウェアは同一製品である必要があります。

(3)仮想サーバが動作する仮想化ソフトウェアが起動している必要があります。

(4)仮想サーバ名，クラスタ名，vApp名，リソースプール名，データストア名は，vCenter Server内で一意である必要があります。

　クラスタとvApp，クラスタとリソースプールの組み合わせなど，種別が異なっていても同じ名前にすることはできません。

(5)仮想サーバの移行先にクラスタを指定する場合，移行する仮想サーバが移行先として指定するクラスタ配下のリソースプールに存在している必要があります。

(6)仮想サーバの移行先にフォルダを指定する場合，vSphere Clientの仮想サーバおよびテンプレートの画面に，移行先として指定するフォルダが存在している必要があります。

(7)VMware vCenter Server 4.1 U2より前のバージョンの環境では，停止状態の仮想サーバを異なるデータセンターのESXに対してマイグレーションした場合に，エラーとなるおそれがあり，部品の実行に失敗します。対処方法は，VMware Knowledge Baseの" Migrating a powered off virtual machine across hosts in different datacenters fails with the error: A specified parameter was not correct. host"をご確認ください。

(8)仮想サーバの移動先(VMware.destinationNameプロパティ)，仮想サーバの移動先(データストア)名(VMware.destinationDataStoreNameプロパティ)はどちらかもしくは両方を指定してください。どちらの指定も無い場合，この部品は異常終了します。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　対象とする仮想サーバに対して「vMotionのクエリ」と「移行」「再配置」の権限を持つロール，またはシステム管理者ロール

バージョン

02.11.00

部品のタグ

Migrate VM,VMware vSphere

タスクログに表示される部品の名称

vsphereMigration

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します（VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません）。

−　

入力

○　

VMware.destinationName

仮想サーバの移動先

移動先のVMware vSphere ESXi（またはVMware ESX Server）またはリソースプール，クラスタ，フォルダの名称を指定します。

−　

入力

△　

VMware.destinationDataStoreName

仮想サーバの移動先(データストア)名

仮想サーバの移動先のデータストアの名称を指定します。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.38　仮想サーバのリソース構成の設定

機能

VMware vCenter Serverで管理される仮想サーバについてCPU，メモリ，ディスクI/Oのリソースの設定を変更します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXi(またはVMware ESX Server)によって管理されている仮想サーバです。

利用場面

仮想サーバのリソースの割り当てについて，次のように構成をすることができます。

・仮想サーバが利用するCPUリソースを制限，または制限の解除ができます。

・仮想サーバが利用するCPUリソースの予約(使用量の確保)，または予約の解除ができます。

・仮想サーバのCPUリソースについて，同一の親を持つ仮想サーバ間での相対的な優先度を設定できます。

・仮想サーバが利用するメモリリソースの制限，または制限の解除ができます。

・仮想サーバが利用するメモリリソースの予約(使用量の確保)，または予約の解除ができます。

・仮想サーバのメモリリソースについて，同一の親を持つ仮想サーバ間での相対的な優先度を設定できます。

・仮想サーバのディスクI/Oの帯域について，同一の親を持つ仮想サーバ間での相対的な優先度を設定できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)仮想サーバに関する条件

　・同一のvCenterの管理下で，仮想サーバ名が重複しないこと。

　・仮想サーバが停止していること。

　・仮想サーバに，VMwareToolsがインストールされていること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)各プロパティについて，次の点を踏まえて設定をしてください。

・メモリの予約では仮想サーバに割り当てられているメモリ容量以内の値を指定してください。

・CPUについて，100MHz未満，メモリについて，100MB未満の値を制限として指定することはできません。

・CPUおよびメモリについて，制限より多くのリソースを予約することはできません。

(2)VMware.vHardDiskNameプロパティに複数の仮想ディスクを指定した場合，1台でもディスクシェアレベルの変更処理が失敗するとタスクが異常終了します。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

システム管理者ロール

バージョン

02.11.00

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereSetResourceConfig

戻り値

戻り値

説明

0

正常

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号（VMware vCenter ServerのWebサービス用）を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します（VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません）。

−　

入力

○　

VMware.cpuSharesLevel

CPUのシェアレベル

同一の親を持つ仮想サーバ間における相対的なCPUリソースの優先度を指定します。

−　

入力

△　

VMware.cpuReservationMHz

CPUの予約 (MHz)

仮想サーバが予約するCPUリソースをMHz単位で指定します。

−　

入力

△　

VMware.cpuLimitMHz

CPUの制限 (MHz)

仮想サーバが使用するCPUリソースの上限値をMHz単位で指定します。100MHz未満の値を指定するとタスクの実行が異常終了します。ただし，-1を指定すると制限を解除します。

−　

入力

△　

VMware.memSharesLevel

メモリのシェアレベル

同一の親を持つ仮想サーバ間における相対的なメモリリソースの優先度を指定します。

−　

入力

△　

VMware.memReservationMB

メモリの予約 (MB)

仮想サーバが予約するメモリリソースをMB単位で指定します。

−　

入力

△　

VMware.memLimitMB

メモリの制限 (MB)

仮想サーバが使用するメモリリソースの上限値をMB単位で指定します。100MB未満の値を指定するとタスクの実行が異常終了します。ただし，-1を指定すると制限を解除します。

−　

入力

△　

VMware.diskSharesLevel

ディスクのシェアレベル

ストレージのI/Oリソースに対する仮想サーバの相対的な優先度を指定します。

−　

入力

△　

VMware.vHardDiskName

仮想ディスク名

シェアレベルを変更する仮想ディスクを指定します。仮想ディスクはVMware vCenter Serverでの表示名です。複数の仮想ディスクを指定する場合は，","区切りで指定してください。このプロパティを省略した場合，仮想サーバに接続されているすべての仮想ディスクを指定されたシェアレベルに設定します。このプロパティを指定する場合は，必ずディスクのシェアレベルも指定してください。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.39　仮想サーバのリソース構成変更の事前判定

機能

VMware vCenter Serverで管理される仮想サーバについてCPU，メモリ，ディスクI/Oのリソース変更の事前確認をします。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXi(またはVMware ESX Server)によって管理されている仮想サーバです。

利用場面

サービステンプレートに指定されたプロパティから，次の判定を行います。

・CPU，メモリ，ディスクの構成の変更を行うかの判定

・プロパティに指定された値の妥当性の判定

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)仮想サーバに関する条件

　・同一のvCenterの管理下で，仮想サーバ名が重複しないこと。

　・仮想サーバが停止していること。

　・仮想サーバに，VMwareToolsがインストールされていること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)VMware.vHardDiskNameプロパティに複数の仮想ディスクを指定した場合，1台でもディスクシェアレベルの判定処理が失敗するとタスクが異常終了します。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

システム管理者ロール

バージョン

02.11.00

部品のタグ

Gather VM information,VMware vSphere

タスクログに表示される部品の名称

vsphereCheckResourceConfig

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号（VMware vCenter ServerのWebサービス用）を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します（VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません）。

−　

入力

○　

VMware.cpuSharesLevel

CPUのシェアレベル

同一の親を持つ仮想サーバ間における相対的なCPUリソースの優先度を指定します。

−　

入力

△　

VMware.cpuReservationMHz

CPUの予約 (MHz)

仮想サーバが予約するCPUリソースをMHz単位で指定します。

−　

入力

△　

VMware.cpuLimitMHz

CPUの制限 (MHz)

仮想サーバが使用するCPUリソースの上限値をMHz単位で指定します。100MHz未満の値を指定するとタスクの実行が異常終了します。ただし，-1を指定すると制限を解除します。

−　

入力

△　

VMware.memSharesLevel

メモリのシェアレベル

同一の親を持つ仮想サーバ間における相対的なメモリリソースの優先度を指定します。

−　

入力

△　

VMware.memReservationMB

メモリの予約 (MB)

仮想サーバが予約するメモリリソースをMB単位で指定します。

−　

入力

△　

VMware.memLimitMB

メモリの制限 (MB)

仮想サーバが使用するメモリリソースの上限値をMB単位で指定します。100MB未満の値を指定するとタスクの実行が異常終了します。ただし，-1を指定すると制限を解除します。

−　

入力

△　

VMware.diskSharesLevel

ディスクのシェアレベル

ストレージのI/Oリソースに対する仮想サーバの相対的な優先度を指定します。

−　

入力

△　

VMware.vHardDiskName

仮想ディスク名

シェアレベルを変更する仮想ディスクを指定します。仮想ディスクはVMware vCenter Serverでの表示名です。複数の仮想ディスクを指定する場合は，","区切りで指定してください。このプロパティを省略した場合，仮想サーバに接続されているすべての仮想ディスクを指定されたシェアレベルに設定します。このプロパティを指定する場合は，必ずディスクのシェアレベルも指定してください。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

VMware.checkResourceConfigResult

仮想サーバのリソース構成変更の事前判定結果

仮想サーバのリソース構成変更要否を判定し，変更する場合はTRUE，変更しない場合はFALSEを格納します。

−　

出力

△　

5.11.40　仮想サーバのリソース設定

機能

VMware vSphere環境で，仮想サーバのリソース(CPU数，メモリ容量)割り当てを変更します。

CPU数とは，VMware vCenter Server 4.1以前では仮想プロセッサ数，VMware vCenter Server 5.0以降では仮想ソケット数×ソケット当たりのコア数を指します。11-11以前では「ソケット当たりのコア数」は1固定のため，CPU数は仮想ソケット数と同じ値でしたが，11-12以降では「ソケット当たりのコア数」を変更可能です。変更する場合は，コア数設定オプション(VMware.setCoresOptionプロパティ)に"true"を指定してください。

また，上記の理由によって，VMware.cpuNumプロパティの表示名を変更しています。11-11以前では「CPU数」でしたが，11-12以降では「CPUソケット数」としています。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXi(またはVMware ESX Server)によって管理されている仮想サーバです。

利用場面

仮想サーバのリソースが不足している場合などに，仮想サーバのリソース割り当ての変更に利用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)仮想サーバに関する条件

　・同一のvCenterの管理下で，仮想サーバ名が重複しないこと。

　・仮想サーバが停止していること。

　・仮想サーバに，VMwareToolsがインストールされていること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)コア数設定オプション(VMware.setCoresOptionプロパティ)に"true"以外を指定した場合，対象となる仮想サーバの，ソケット当たりのコア数を1に設定しておいてください。ソケット当たりのコア数を1以外に設定した仮想サーバに対してCPUソケット数を変更した場合，次の現象が発生する場合があります。

・CPU数がコア数の倍数にならないため，仮想サーバが起動しない。

・仮想サーバは起動したが，リソースは期待する値になっていない。

(2)CPU数およびメモリ容量は，前提製品のバージョンによって指定できる値が異なります。前提製品における制限を確認して指定してください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　システム管理者ロール

バージョン

03.00.01

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereChangeResource

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

VMware.cpuNum

CPUソケット数

仮想サーバに設定するCPUの仮想ソケット数を指定します。CPUソケット数・メモリ容量は，少なくともどちらか一つは指定してください。CPUソケット数とソケット当たりのコア数を掛けた値が仮想サーバのCPU数となります。

−　

入力

△　

VMware.setCoresOption

コア数設定オプション

仮想サーバのCPUのソケット当たりのコア数を設定する場合に"true"を指定します。"true"以外の場合はコア数を設定しません。「仮想サーバスペック変更(CPU，メモリ)」サービスのサービス詳細説明の注意事項を参照してください。

false

入力

△　

VMware.numCoresPerSocket

ソケット当たりのコア数

コア数設定オプションに"true"を指定した場合に，仮想サーバに設定するCPUのソケット当たりのコア数を指定します。このプロパティを指定する場合は，CPUソケット数も指定してください。CPUソケット数とソケット当たりのコア数を掛けた値が仮想サーバのCPU数となります。

−　

入力

△　

VMware.memoryMB

メモリ容量(MB)

仮想サーバに設定するメモリ容量をMB単位で指定します。CPUソケット数・メモリ容量は，少なくともどちらか一つは指定してください。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.41　仮想サーバのリソース変更の事前判定

機能

VMware vCenter Serverで管理される仮想サーバについて，リソース(CPU数，メモリ容量)の設定の事前確認を行います。

CPU数とは，VMware vCenter Server 4.1以前では仮想プロセッサ数，VMware vCenter Server 5.0以降では仮想ソケット数×ソケット当たりのコア数を指します。11-11以前では「ソケット当たりのコア数」は1固定のため，CPU数は仮想ソケット数と同じ値でしたが，11-12以降では「ソケット当たりのコア数」を変更可能です。

また，上記の理由によって，VMware.cpuNumプロパティの表示名を変更しています。11-11以前では「CPU数」でしたが，11-12以降では「CPUソケット数」としています。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXi(またはVMware ESX Server)によって管理されている仮想サーバです。

利用場面

サービステンプレートに指定されたプロパティから，次の判定を行います。

・CPU，メモリの設定の変更を行うかの判定。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 12-00以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)仮想サーバに関する条件

　・同一のvCenterの管理下で，仮想サーバ名が重複しないこと。

　・仮想サーバが停止していること。

　・仮想サーバに，VMwareToolsがインストールされていること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)この部品と「仮想サーバのリソース設定」部品のバージョンは同じにしてください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

システム管理者ロール

バージョン

03.00.01

部品のタグ

Gather VM information,VMware vSphere

タスクログに表示される部品の名称

vsphereCheckResource

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

VMware.cpuNum

CPUソケット数

仮想サーバに設定するCPUの仮想ソケット数を指定します。CPUソケット数・メモリ容量は，少なくともどちらか一つは指定してください。CPUソケット数とソケット当たりのコア数を掛けた値が仮想サーバのCPU数となります。

−　

入力

△　

VMware.setCoresOption

コア数設定オプション

仮想サーバのCPUのソケット当たりのコア数を設定する場合に"true"を指定します。"true"以外の場合はコア数を設定しません。「仮想サーバスペック変更(CPU，メモリ)」サービスのサービス詳細説明の注意事項を参照してください。

false

入力

△　

VMware.numCoresPerSocket

ソケット当たりのコア数

コア数設定オプションに"true"を指定した場合に，仮想サーバに設定するCPUのソケット当たりのコア数を指定します。このプロパティを指定する場合は，CPUソケット数も指定してください。CPUソケット数とソケット当たりのコア数を掛けた値が仮想サーバのCPU数となります。

−　

入力

△　

VMware.memoryMB

メモリ容量

仮想サーバに設定するメモリ容量をMB単位で指定します。CPUソケット数・メモリ容量は，少なくともどちらか一つは指定してください。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

VMware.checkResourceResult

仮想サーバのリソース変更の事前判定結果

仮想サーバのリソース変更要否を判定し，変更する場合はTRUE，変更しない場合はFALSEを格納します。

−　

出力

△　

5.11.42　仮想サーバの起動

機能

VMware vSphere環境で，仮想サーバの電源状態をONに設定します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ

　VMware vSphere PowerCLIがインストールされているサーバです。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXによって管理されている仮想サーバです。

仮想サーバを起動する際には，VMware.checkPowerStateIntervalプロパティに指定した秒数待ち合わせ，仮想サーバの起動状態を確認する動作を，VMware.checkPowerStateCountプロパティに指定した回数繰り返します。デフォルトの値で不都合がある場合，利用している環境に合わせて調整してください。

部品が正常終了した場合は，出力プロパティVMware.powerStateに"PoweredOn"を格納します。

利用場面

仮想サーバの起動を行いたい場合に使用できます。

起動処理は，部品「vsphereGetPower」実行後，電源状態が"PoweredOff"である場合に，この部品を実行するという流れになります。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)仮想サーバが停止していること。

(3)仮想サーバ名はvCenterサーバ内で一意になっていること。

(4)対象となる仮想サーバに，VMwareToolsがインストールされていること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)起動するVMware vSphere ESXi(またはVMware ESX Server)を指定ことはできません。仮想サーバが存在するVMware vSphere ESXi(またはVMware ESX Server)上で起動します。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　対象とする仮想サーバに対して「パワーオン」の権限を持つロール，またはシステム管理者ロール

バージョン

02.11.00

部品のタグ

Control VM,VMware vSphere

タスクログに表示される部品の名称

vsphereSetPowerOn

戻り値

戻り値

説明

0

正常

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

28

異常(ネットワーク起動不正) 電源起動後のネットワーク起動確認不可

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.checkPowerStateCount

電源状態の確認回数

仮想サーバの起動を確認する際の，電源状態の確認回数を指定します。電源状態の確認間隔と組み合わせて最大待ち時間となります。

60

入力

○　

VMware.checkPowerStateInterval

電源状態の確認間隔

仮想サーバの起動を確認する際の，電源状態の確認間隔を秒単位で指定します。

10

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

VMware.powerState

仮想サーバの電源状態

仮想サーバの電源状態が格納されます。

−　

出力

△　

5.11.43　仮想サーバの作成

機能

VMware vSphere環境で，仮想サーバのテンプレートからクローンを作成します。

仮想ディクス/データストアマッピングファイルパス(VMware.diskMapFilePathプロパティ)を指定することにより，仮想ディスクを格納するデータストアを指定できます。

このプロパティを省略した場合，データストア名(VMware.dataStoreNameプロパティ)に指定したデータストアに仮想サーバの構成ファイルおよびすべての仮想ディスクを格納します。

マッピングファイルはタブ区切り形式で次のように記載します。

【ファイル形式】

仮想ディスク名[タブ文字]格納先データストア名

　　　　　　・

　　　　　　・

仮想ディスクの格納先データストア名を省略した場合，仮想サーバの構成ファイルと同じデータストアに仮想ディスクを格納します。

仮想ディスク名はvSphere Clientの「仮想マシンのプロパティ」画面で表示される値を記載してください。(例：ハード ディスク 1)

マッピングファイルの文字コードは"Shift_JIS"または"UTF-8(BOMあり)"にしてください。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXiがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです。

データストア名(VMware.diskMapFilePathプロパティ)について次に示します。

・仮想サーバの構成ファイルを格納するデータストアの名称を指定します。

・仮想ディクス/データストアマッピングファイルパス(VMware.diskMapFilePathプロパティ)を省略した場合，このプロパティで指定したデータストアに仮想ディスクが格納されます。

仮想ディクス/データストアマッピングファイルパス(VMware.diskMapFilePathプロパティ)について次に示します。

・vCenter操作サーバ(実行対象サーバ)上の，仮想ディスクとデータストアの対応を定義したマッピングファイルのパスをフルパスで指定します。

・このプロパティを省略した場合，データストア名(VMware.dataStoreNameプロパティ)に指定したデータストアに仮想サーバの構成ファイルおよびすべての仮想ディスクを格納します。

利用場面

この部品は，VMware vSphere環境で新規仮想サーバを作成する際に利用できます。次の部品とあわせて実行することで，仮想サーバのOS初期設定まで実行できます。

・vSphereSetOsInfoWin

・vSphereSetOsInfoLin

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(2)ESXサーバの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(3)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXiがVMware vCenter Serverで管理されていること。

(2)VMware vSphere ESXi上の設定に関する条件

　・データストアが登録済みであること。

　・ポートグループが設定済みであること。仮想サーバに設定するポートグループは，標準仮想スイッチ(vNetwork 標準スイッチ/vSphere 標準スイッチ)を使ったネットワーク上のポートグループを指定してください。

　・デプロイに使用するテンプレートが作成済みであること。

　・テンプレートの名称が一意であること。

　・仮想サーバをリソースプールに格納する場合，リソースプール，クラスタ，vAppの名称が一意であること。

　　クラスタとvApp，クラスタとリソースプールの組み合わせなど，種別が異なっていても，同じ名前にすることはできません。

　・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，このサービスが実行するvSphere Power CLIからは，指定した名称の英字の大文字・小文字を区別できません。

　　そのため，英字の大文字・小文字が異なる同名の名称を使用している環境に対して，このサービスを使用することはできません。

　　　・テンプレート名

　　　・データストア名

　　　・リソースプール名

　　　・クラスタ名

　　　・vApp名

(3)デプロイに使用するテンプレートに関する条件

　・VMware Toolsがインストール済みであること。

　・リモートコマンドが実行可能な設定であること。Windowsの場合は管理共有，Linuxの場合はSSHが有効になっていること。

　・NICが設定してあること(最大4個まで)。

　・Windowsの場合，Administrator のパスワードを空にしておくこと。

　・仮想サーバのテンプレート化を実行する際には，仮想サーバが停止した状態でテンプレート化をすること。

　・pingの受付，応答を許可していること。

　・Windowsの場合，sysprepを実行する。そのため，Windows初期化の実行回数が限度回数(3回)に達していないこと。

(4)仮想サーバに関する条件

　・同一のvCenterの管理下において，仮想サーバ名が重複しないこと。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)仮想サーバのデプロイ中は，ほかのサービスにより当該仮想サーバの操作を行わないでください。仮想サーバのデプロイに失敗するおそれがあります。vCenterサーバからも直接操作を行わないでください。

(2)仮想サーバのテンプレートには，仮想サーバ作成時に設定する情報をあらかじめ設定しないでください。コンピュータ名/ホスト名やIPアドレスがテンプレートに設定されている場合，仮想サーバの作成に失敗する場合があります。失敗した場合(失敗の例としては，スタティックルートの処理でエラーが発生します。)，一度仮想サーバを削除し，コンピュータ名/ホスト名とIPアドレスが設定されていないテンプレートを再作成のあと，この部品を再実行してください。

(3)仮想サーバ名プロパティ(vmware.vmName)に指定できる最大の文字数は60文字です。

(4)仮想ディクス/データストアマッピングファイルに，存在しないデータストアや，仮想サーバの構成ファイルを格納するESXサーバから参照できないデータストアを指定した場合，この部品は異常終了します。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　システム管理者ロール

バージョン

02.50.00

部品のタグ

Add VM,VMware vSphere

タスクログに表示される部品の名称

vsphereCreateVM

戻り値

戻り値

説明

0

正常

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmHostName

ESXサーバ名

VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。

−　

入力

○　

VMware.dataStoreName

データストア名

データストアの名称を指定します。

−　

入力

○　

VMware.templateName

テンプレート名

仮想サーバの基となるテンプレート名を指定します。

−　

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

VMware.resourcePoolName

リソースプール名

仮想サーバを格納するリソースプール，vApp，クラスタを指定します。

−　

入力

△　

VMware.diskMapFilePath

仮想ディスク/データストアマッピングファイルパス

実行対象サーバ上の，仮想ディスクとデータストアの対応を定義したマッピングファイルのパスをフルパスで指定します。省略した場合，データストア名に指定したデータストアに仮想サーバの構成ファイルおよびすべての仮想ディスクを格納します。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

common.osType

OSの種類

テンプレートのOS種類（Windows/Linux）を格納するワークプロパティです。

−　

出力

△　

5.11.44　仮想サーバの削除

機能

VMware vSphere環境で，仮想サーバを削除します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESX(またはVMware ESX Server)によって管理されている仮想サーバです。

利用場面

仮想サーバの滅却などのタイミングで，仮想サーバを削除する際に利用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86),Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)仮想サーバに関する条件

　・同一のvCenterの管理下で，仮想サーバ名が重複しないこと。

　・仮想サーバの電源状態がOFFであること。

　・仮想サーバに，VMwareToolsがインストールされていること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　システム管理者ロール

バージョン

02.11.00

部品のタグ

Delete VM,VMware vSphere

タスクログに表示される部品の名称

vsphereDeleteVM

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.45　仮想サーバの電源状態取得

機能

VMware vSphere環境で，仮想サーバの電源状態を取得します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXにより管理されている仮想サーバです。

取得した電源状態は出力プロパティVMware.powerStateに次のどちらかの内容で格納されます。

PoweredOn

PoweredOff

利用場面

この部品により仮想サーバの電源状態を確認し，仮想サーバの起動や停止，構成変更など，状態に応じた対処を行うことができます。

例えば，次の部品と組み合わせて使用します。

・vsphereSetPowerOff

・vsphereSetPowerOn

・vsphereChangeResource

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)仮想サーバ名はvCenterサーバ内で一意になっていること。

(3)対象となる仮想サーバに，VMwareToolsがインストールされていること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　対象とする仮想サーバに対して「読み取り専用」の権限を持つロール，またはシステム管理者ロール

バージョン

02.50.00

部品のタグ

Gather VM information,VMware vSphere

タスクログに表示される部品の名称

vsphereGetPower

戻り値

戻り値

説明

0

正常

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

31

異常(電源状態取得不正) 電源状態の未取得

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.powerState

仮想サーバの電源状態

仮想サーバの電源状態が格納されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.46　仮想サーバへの仮想ディスク追加

機能

VMware vSphere環境で，仮想サーバに仮想ディスクを追加します。

追加した仮想ディスクは，次のどちらかの方法でSCSIコントローラに接続します。

・既存のSCSIコントローラに接続する

　SCSIコントローラの追加要否(VMware.createScsiControllerプロパティ)にfalseを指定した場合，既存のSCSIコントローラに接続します。

　仮想ディスクを接続するSCSIコントローラを指定するときは，SCSIコントローラ名(VMware.attachedScsiControllerNameプロパティ)を指定してください。

　SCSIコントローラ名の指定を省略した場合，任意のSCSIコントローラに仮想ディスクを接続します。

・新規にSCSIコントローラを追加し，追加したSCSIコントローラに接続する

　SCSIコントローラの追加要否(VMware.createScsiControllerプロパティ)にtrueを指定した場合，新規にSCSIコントローラを追加し，追加したSCSIコントローラに接続します。

　この場合，次のプロパティをどちらも指定してください。

　　- SCSIバスの共有(VMware.scsiBusSharingModeプロパティ)

　　- SCSIコントローラタイプ(VMware.scsiControllerTypeプロパティ)

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXによって管理されている仮想サーバです。

・データストア名(VMware.dataStoreNameプロパティ)について次に示します。

仮想ディスクを作成するデータストアの名称を指定します。

RDMディスクを作成する場合は，マッピングファイルの格納先データストアを指定します。

・仮想ディスクの容量(VMware.vHardDiskCapacityプロパティ)について次に示します。

作成する仮想ディスクの容量(単位:GB)を指定します。仮想ディスクの種別がFlatの場合，必ず指定してください。

RDMディスクを作成する場合は，このプロパティを指定する必要はありません。

・仮想ディスクの種別(VMware.vHardDiskTypeプロパティ)について次に示します。

作成する仮想ディスクの種別をRawVirtual，RawPhysical，Flatのどれかで指定します。指定を省略した場合，仮想ディスクの種別はFlatになります。

RDMディスクを仮想モードで接続する場合はRawVirtualを，RDMディスクを物理モードで接続する場合はRawPhysicalを，仮想ディスクを接続する場合はFlatを指定してください。

利用場面

仮想サーバの新規構築時やディスク増設時など，仮想サーバにデータディスクを追加する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1)仮想ディスクの追加対象となる仮想サーバの電源がOFFになっていること。

(2)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(3)仮想サーバ名はvCenterサーバ内で一意になっていること。

(4)対象となる仮想サーバに，VMwareToolsがインストールされていること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)仮想サーバに追加した仮想ディスクの初期化は行いません。必要に応じて仮想サーバのOSにログインし，ディスクの初期化を実行してください。

(3)VMware vSphere PowerCLIのバージョンが5.1 Release2未満の場合，仮想ディスクのフォーマット種別(VMware.vDiskStorageFormatプロパティ)に"EagerZeroedThick"は指定できません。指定した場合，この部品は異常終了します。

(4)SCSIコントローラの追加要否(VMware.createScsiControllerプロパティ)にtrueを指定した場合，SCSIバスの共有(VMware.scsiBusSharingModeプロパティ)とSCSIコントローラタイプ(VMware.scsiControllerTypeプロパティ)を両方とも指定してください。どれか1つでも指定しない場合，この部品は異常終了します。

(5)SCSIコントローラの追加要否(VMware.createScsiControllerプロパティ)にtrueを指定し，戻り値27で部品が異常終了した場合，任意のSCSIコントローラに接続された仮想ディスクが作成されているおそれがあります。その場合，タスクログのエラーメッセージに従い原因を取り除いたあと，仮想ディスクを削除し，再度部品を実行してください。なお，仮想ディスクの削除が必要な場合は，タスクログにKNAE06478-Eのメッセージが出力されます。

(6)この部品を同一の仮想サーバに対し，複数同時に実行しないでください。同時に実行した場合，この部品は異常終了するか，仮想ディスク名(VMware.createdVHardDiskNameプロパティ)，SCSIコントローラ名(VMware.connectedScsiConNameプロパティ)に不正な値が格納されるおそれがあります。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　対象とする仮想サーバに対して「新規ディスクの追加/既存ディスクの追加」の権限を持つロール，またはシステム管理者ロール

バージョン

02.11.00

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereAddVDisk

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

VMware.dataStoreName

データストア名

データストアの名称を指定します。

−　

入力

○　

VMware.vHardDiskCapacity

仮想ディスクの容量

作成する仮想ディスクの容量（単位:GB）を整数値で指定します。

−　

入力

△　

VMware.vHardDiskType

仮想ディスクの種別

作成する仮想ディスクの種別をRawVirtual, RawPhysical, Flatのどれかで指定します。

−　

入力

△　

VMware.deviceName

LUNのデバイス名

仮想ディスクを作成するLUNのデバイス名を指定します。仮想ディスクの種別でRawVirtualまたはRawPhysicalを選択した場合だけ指定します（例:/vmfs/devices/disks/naa.XXX）。

−　

入力

△　

VMware.vDiskStorageFormat

仮想ディスクのフォーマット種別

仮想ディスクのフォーマット種別を指定します。指定可能な値は，Thin，Thick，EagerZeroedThickです。仮想ディスクをシンプロビジョニングでフォーマットする場合はThinを，シックプロビジョニング(Lazy Zeroed)でフォーマットする場合はThickを，シックプロビジョニング(Eager Zeroed)でフォーマットする場合はEagerZeroedThickを指定してください。このプロパティは仮想ディスクの種別がFlatのときだけ指定してください。

−　

入力

△　

VMware.attachedScsiControllerName

SCSIコントローラ名

仮想ディスクを接続するSCSIコントローラ名を指定してください(例:SCSI コントローラ X)。省略した場合，仮想ディスクは任意のSCSIコントローラに接続されます。SCSIコントローラの追加要否にtrueを指定する場合，このプロパティの指定は無視されます。

−　

入力

△　

VMware.createScsiController

SCSIコントローラの追加要否

作成する仮想ディスクに対し，新規にSCSIコントローラを割り当てるか否かを指定します。新規にSCSIコントローラを追加する場合はtrueを，追加しない場合はfalseを指定してください。このプロパティを指定する場合は，SCSIバスの共有およびSCSIコントローラタイプも必ず併せて指定してください。

false

入力

○　

VMware.scsiBusSharingMode

SCSIバスの共有

SCSIコントローラのバス共有方式を指定します。指定可能な値は，NoSharing，Virtual，Physicalです。SCSI接続されている仮想ディスクを仮想サーバ間で共有しない場合はNoSharingを，同じESXサーバ上の仮想サーバ間で共有する場合はVirtualを，すべてのESXサーバ上の仮想サーバ間で共有する場合はPhysicalを指定してください。

−　

入力

△　

VMware.scsiControllerType

SCSIコントローラタイプ

SCSIコントローラのタイプを指定します。指定可能な値は，VirtualLsiLogicSAS，VirtualLsiLogic，ParaVirtual，VirtualBusLogicです。タイプを"LSI Logic SAS"にする場合はVirtualLsiLogicSASを，"LSI Logic パラレル"にする場合はVirtualLsiLogicを，"VMware 準仮想化"にする場合はParaVirtualを，"BusLogic パラレル"にする場合はVirtualBusLogicを指定してください。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

VMware.createdVHardDiskName

仮想ディスク名

新規に追加した仮想ディスクの名前が格納されます。

−　

出力

△　

VMware.connectedScsiConName

SCSIコントローラ名

新規に追加した仮想ディスクと接続するSCSIコントローラの名前が格納されます。

−　

出力

△　

5.11.47　仮想サーバ作成確認

機能

VMware vSphere環境に，指定されたテンプレートから新規仮想サーバが作成できることを確認します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXi(またはVMware ESX Server)がインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXi(またはVMware ESX Server)によって管理されている仮想サーバです。

この部品で確認している項目を次に示します。

・指定されたテンプレートがvCenterサーバ上に登録されているかを確認します。

テンプレートがvCenterサーバ上に登録されていない場合はNGとなります。

・指定されたESXサーバがvCenterサーバ上に登録されているかを確認します。

ESXサーバがvCenterサーバ上に登録されていない場合はNGとなります。

・指定されたデータストアがESXサーバ上に登録されているかを確認します。

データストアがESXサーバ上に登録されていない場合はNGとなります。

・指定されたESXサーバ上のデータストアに，テンプレートを展開できる容量が空いているかを確認します。

テンプレートの容量が，データストアの空き容量を超過している場合はNGとなります。

比較に使用するテンプレートの容量は，テンプレートに設定している仮想ディスクの「プロビジョニングしたストレージ」の容量です。

・指定されたリソースプール(リソースプール，クラスタ，vApp)がvCenterサーバ上に登録されているかを確認します。

リソースプールがvCenterサーバ上に登録されていない場合はNGとなります。

・指定された仮想サーバ名がvCenterサーバ内で使用されていないかを確認します。

仮想サーバ名がvCenterサーバ内で既に使用されている場合はNGとなります。

利用場面

ESXサーバに新規仮想サーバを作成する場合に，ESXサーバに新規仮想サーバを作成できるかを事前確認することができます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)ESXサーバの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64) (vCenter4.1以降。vCenter4.0では未サポート)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)VMware vSphere ESXi(またはVMware ESX Server)上の設定に関する条件

　・データストアが登録済みであること。

　・ポートグループが設定済みであること。仮想サーバに設定するポートグループは，標準仮想スイッチ(vNetwork 標準スイッチ/vSphere 標準スイッチ)を使ったネットワーク上のポートグループを指定してください。

　・デプロイに使用するテンプレートが作成済みであること。

　・仮想サーバをリソースプールに格納する場合，リソースプール，クラスタ，vAppの名称が一意であること。

　　クラスタとvApp，クラスタとリソースプールの組み合わせなど，種別が異なっていても，同じ名前にすることはできません。

(3)デプロイに使用するテンプレートに関する条件

　・VMware Toolsがインストール済みであること。

　・リモートコマンドが実行可能な設定であること。Windowsの場合は管理共有，Linuxの場合はSSHが有効になっていること。

　・NICが設定してあること(最大2個まで)。

　・Windowsの場合，Administrator のパスワードを空にしておくこと。

　・仮想サーバのテンプレート化を実施する際には，仮想サーバが停止した状態でテンプレート化をすること。

(4)仮想サーバに関する条件

　・同一のVMware vCenter Serverの管理下で，仮想サーバ名が重複しないこと。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　システム管理者ロール

バージョン

02.11.00

部品のタグ

Gather VM information,VMware vSphere

タスクログに表示される部品の名称

vsphereCheckTemplateSpec

戻り値

戻り値

説明

0

正常

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号（VMware vCenter ServerのWebサービス用）を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmHostName

ESXサーバ名

VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。

−　

入力

○　

VMware.dataStoreName

データストア名

データストアの名称を指定します

−　

入力

○　

VMware.templateName

テンプレート名

仮想サーバの基となるテンプレート名を指定します。

−　

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します（VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません）。

−　

入力

○　

VMware.resourcePoolName

リソースプール名

仮想サーバを格納するリソースプール，vApp，クラスタを指定します。

−　

入力

△　

VMware.portGroupName

ポートグループ名

仮想サーバに現在設定されているポートグループ名（変更前）を指定します。

−　

入力

△　

VMware.portGroupNameNew

ポートグループ名（変更後）

仮想サーバに新しく設定するポートグループ名を指定します。

−　

入力

△　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

common.CheckTemplateResult

仮想サーバ作成確認のチェック結果

仮想サーバを作成できるかどうか確認した結果を格納します。

−　

出力

△　

5.11.48　仮想サーバ情報一覧取得

機能

vCenterサーバの管理下にある，仮想サーバの情報一覧をCSV形式でファイルに出力します。

ESXサーバ名を指定することで，指定したESXサーバの管理下にある仮想サーバだけを対象にできます。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXi(またはVMware ESX Server)によって管理されている仮想サーバです。

利用場面

新規に仮想サーバの追加を行う場合や，既存の仮想サーバに対して操作を行う際に指定する，vCenterサーバの管理下にある仮想サーバの一覧をCSV形式のファイルで出力することができます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)VMware vSphere ESXi(またはVMware ESX Server)上の設定に関する条件

　・ポートグループが設定済みであること。

(3)仮想サーバに関する条件

　・VMware Toolsがインストール済みであること。

　・NICが設定してあること。

　・同一のVMware vCenter Serverの管理下で，仮想サーバ名が重複しないこと。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　システム管理者ロール

バージョン

02.11.00

部品のタグ

Gather VM information,VMware vSphere

タスクログに表示される部品の名称

vsphereOutVmSpec

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

28

異常(取得情報なし) 仮想サーバが一台も存在しない

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号（VMware vCenter ServerのWebサービス用）を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmHostName

ESXサーバ名

VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。

−　

入力

△　

common.fileName

ファイル名

ファイル名を指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.49　仮想ディスクの拡張

機能

VMware vSphere環境で，仮想サーバに設定されている仮想ディスクの容量を拡張します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXiがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです。

仮想ディスク名(VMware.vHardDiskNameプロパティ)について次に示します。

・容量を拡張する仮想ディスクの名称を指定します。(例：ハード ディスク 1)

・SCSIコントローラーに接続されいてる仮想ディスクを指定してください。

利用場面

仮想サーバに設定されている仮想ディスクの容量が不足している場合などに，仮想ディスクの容量を拡張する際に使用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(2)仮想サーバを管理するVMware vSphere ESXの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(3)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86),Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXがVMware vCenter Serverで管理されていること。

(2)VMware vCenter Server上の設定に関する条件

　・仮想サーバの名称が一意であること。

　・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，この部品が実行するvSphere Power CLIからは，指定した名称の英字の大文字・小文字を区別できません。

　　そのため，英字の大文字・小文字が異なる同名の名称を使用している環境に対して，この部品を使用することはできません。

　　- 仮想サーバ名

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)仮想ディスクの容量を縮小することはできません。設定されている容量より小さい容量を指定した場合，この部品は異常終了します。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。

バージョン

02.11.00

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereExtendVDisk

戻り値

戻り値

説明

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します（VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません）。

−　

入力

○　

VMware.vHardDiskName

仮想ディスク名

仮想ディスク名を指定します。

−　

入力

○　

VMware.vHardDiskCapacity

仮想ディスクの容量

拡張後の仮想ディスクの容量(単位:GB)を整数値で指定します。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.50　仮想ディスクの削除

機能

VMware vSphere環境で，仮想サーバから仮想ディスクを削除します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESX(またはVMware ESX Server)によって管理されている仮想サーバです。

利用場面

この部品は，VMware vSphere環境で仮想サーバの仮想ディスクを削除する場合に利用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86),Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)仮想サーバに関する条件

　・同一のvCenterの管理下で，仮想サーバ名が重複しないこと。

　・仮想サーバの電源状態がOFFであること。

　・仮想サーバに，VMwareToolsがインストールされていること。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)削除する仮想ディスクに必要なデータがある場合は，あらかじめバックアップを取得してください。

(2)仮想ディスクはデータストアからも削除します。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　対象とする仮想サーバに対して「ディスクの削除」の権限を持つロール，またはシステム管理者ロール

バージョン

02.11.00

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereDeleteVDisk

戻り値

戻り値

説明

0

正常

21

異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知)

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

VMware.vHardDiskName

仮想ディスク名

仮想ディスク名を指定します。

−　

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.51　仮想マシンのポートグループ変更

機能

VMware vSphere環境の仮想サーバに接続されているポートグループを変更します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESX(またはVMware ESX Server)によって管理されている仮想サーバです。

利用場面

仮想サーバの作成後，ポートグループ設定をデフォルトから変更する場合に使用します。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0，4.1，4.0

(2)仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0 またはVMware ESX Server 4.1，4.0

(3)仮想サーバの前提OS

vCenterサーバの前提製品/仮想サーバを管理するVMware vSphere ESXi(またはVMware ESX Server)/vCenter操作サーバの前提製品がサポートする構成の範囲で，次のOSがサポート範囲です。

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

　・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 7 (64-bit x86_64)

　・Red Hat Enterprise Linux Server 8 (64-bit x86_64)

　・CentOS 6 (64-bit x86_64)

　・CentOS 7 (64-bit x86_64)

　・CentOS 8 (64-bit x86_64)

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXi(またはVMware ESX Server)がVMware vCenter Serverで管理されていること。

(2)VMware vSphere ESXi(またはVMware ESX Server)上の設定に関する条件

　・ポートグループが設定済みであること。仮想サーバに設定するポートグループは，標準仮想スイッチ(vNetwork 標準スイッチ/vSphere 標準スイッチ)を使ったネットワーク上のポートグループを指定してください。

(3)仮想サーバに関する条件

　・VMware Toolsがインストール済みであること。

　・NICが設定してあること。

　・同一のvCenterの管理下で，仮想サーバ名が重複しないこと。

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)指定するポートグループは，JP1/AOサーバと通信可能なポートグループを指定する必要があります。仮想サーバに複数のポートグループを設定する場合，仮想サーバのテンプレートの1つ目のNICに設定するポートグループは，JP1/AOサーバと通信可能なポートグループにしてください。

(2)ポートグループ名，ポートグループ名(変更後)は同時に指定してください。どちらかの指定がない場合，ポートグループの変更は行われません。また，同じ名前のポートグループを複数持つ場合，変更されるポートグループ名は1つだけです。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，次の権限が必要です。

　システム管理者ロール

バージョン

02.11.00

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereSetPortGroup

戻り値

戻り値

説明

0

正常

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

VMware.vmName

仮想サーバ名

仮想サーバの名称を指定します(VMware vCenter Serverにおける仮想サーバの表示名称です。OS上のホスト名ではありません)。

−　

入力

○　

VMware.portGroupNameNew

ポートグループ名(更新時)

仮想サーバに新しく設定するポートグループ名を指定します。

−　

入力

△　

VMware.portGroupName

ポートグループ名

仮想サーバに現在設定されているポートグループ名(変更前)を指定します。

−　

入力

△　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.52　標準仮想スイッチへのポートグループ追加

機能

VMware vSphere環境で，ポートグループを新規に作成し，標準仮想スイッチ(vNetwork 標準スイッチ/vSphere 標準スイッチ)に追加します。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXiがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

利用場面

標準仮想スイッチにポートグループを新規追加する際に利用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(2)仮想サーバを管理するVMware vSphere ESXの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXがVMware vCenter Serverで管理されていること。

(2)VMware vCenter Server上の設定に関する条件

　・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，この部品が実行するvSphere Power CLIからは，指定した名称の英字の大文字・小文字を区別できません。

　　そのため，英字の大文字・小文字が異なる同名の名称を使用している環境に対して，この部品を使用することはできません。

　　- 標準仮想スイッチ名

　　- ポートグループ名

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。

バージョン

02.11.00

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereAddPortGroup

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmHostName

ESXサーバ名

VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。

−　

入力

○　

VMware.targetVSwitchName

標準仮想スイッチ名

ポートグループを追加する標準仮想スイッチ名を指定します。

−　

入力

○　

VMware.newPortGroupName

ポートグループ名

新規作成するポートグループ名を指定します。

−　

入力

○　

VMware.vlanID

VLAN ID

新規作成するポートグループに設定するVLAN IDを1〜4094の範囲で指定します。VLAN IDを設定しない場合は0を，ポートグループをトランクモードで使用する場合は4095を指定してください。省略した場合，VLAN IDは設定されません。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.53　物理アダプタの情報一覧取得

機能

VMware vSphere環境で，ESXサーバに接続されている物理アダプタの情報を出力します。

物理アダプタ名(VMware.physicalAdapterNameプロパティ)を指定した場合は，指定した物理アダプタのリンク状態のみを物理アダプタの状態(VMware.outPhysicalAdapterStatusプロパティ)に格納します。

物理アダプタ名(VMware.physicalAdapterNameプロパティ)を省略した場合は，物理アダプタ情報一覧出力ファイル名(VMware.esxAdapterOutputFileNameプロパティ)に指定したvCenter操作サーバのファイルに，ESXサーバに接続されている物理アダプタの情報一覧をCSV形式で出力します。

出力ファイルのエンコード形式は，vCenter操作サーバのシステムのデフォルトエンコードです。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXiがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです。

物理アダプタ情報一覧出力ファイル名(VMware.esxAdapterOutputFileNameプロパティ)について次に示します。

・物理アダプタ名(VMware.physicalAdapterNameプロパティ)を指定した場合，このプロパティの指定内容は無視されます。

この部品内のスクリプトでは，次に示すVMware vSphere PowerCLIのコマンドレットを実行します。

・Get-EsxCli -VMHost VMHostオブジェクト※1

　※1 ESXサーバ名(VMware.vmHostNameプロパティ)の値から取得したオブジェクト

上記のコマンドレットの実行結果からnetwork.nic.list()の値を取得して「物理アダプタの状態(VMware.outPhysicalAdapterStatusプロパティ)」に格納します。

出力するCSVファイルの項目を次に示します。

　項目はコンマ区切りで出力します。

　(a) ESXサーバ名(ヘッダー名：VmHostName)

　(b) 標準仮想スイッチ名(ヘッダー名：VirtualSwitchName)

　(c) 物理アダプタ名(ヘッダー名：PhysicalAdapterName)

　(d) 物理アダプタの状態(ヘッダー名：PhysicalAdapterStatus)

CSVファイル出力例

"VmHostName","VirtualSwitchName","PhysicalAdapterName","PhysicalAdapterStatus"

"sysbsx10","vSwitch0","vmnic0","Up"

"sysbsx10","vSwitch1","vmnic1","Up"

"sysbsx10","vSwitch1","vmnic2","Down"

利用場面

ESXサーバに接続されている物理アダプタの情報を取得する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(2)仮想サーバを管理するVMware vSphere ESXの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXがVMware vCenter Serverで管理されていること。

(2)VMware vSphere ESX上の設定に関する条件

　・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，この部品が実行するvSphere Power CLIからは，指定した名称の英字の大文字・小文字を区別できません。

　　そのため，英字の大文字・小文字が異なる同名の名称を使用している環境に対して，この部品を使用することはできません。

　　- 標準仮想スイッチ名

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)物理アダプタ情報一覧出力ファイル名(VMware.esxAdapterOutputFileNameプロパティ)に指定したファイルが既に存在する場合，既存のファイルを上書きします。そのため，指定したファイル名に誤りがないか，十分に確認してください。

(3)物理アダプタ情報一覧出力ファイル名(VMware.esxAdapterOutputFileNameプロパティ)に指定したファイルを作成するフォルダが存在しない場合は，そのフォルダを作成します。

(4)物理アダプタ名(VMware.physicalAdapterNameプロパティ)を省略した場合は，物理アダプタ情報一覧出力ファイル名(VMware.esxAdapterOutputFileNameプロパティ)を必ず指定してください。物理アダプタ情報一覧出力ファイル名を省略すると，この部品は異常終了します。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。

バージョン

02.11.00

部品のタグ

Gather VM information,VMware vSphere

タスクログに表示される部品の名称

vsphereOutputPhysicalAdapInfo

戻り値

戻り値

説明

0

正常

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmHostName

ESXサーバ名

VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。

−　

入力

○　

VMware.physicalAdapterName

物理アダプタ名

情報を取得する物理アダプタ名を指定します。

−　

入力

△　

VMware.esxAdapterOutputFileName

物理アダプタ情報一覧出力ファイル名

ESXサーバの物理アダプタ情報一覧を出力するファイル名をフルパスで指定します。

−　

入力

△　

VMware.outPhysicalAdapterStatus

物理アダプタの状態

指定した物理アダプタの状態が格納されます。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.11.54　物理アダプタの設定

機能

VMware vSphere環境で，標準仮想スイッチ(vNetwork 標準スイッチ/vSphere 標準スイッチ)に接続されている物理アダプタの状態を設定します。

設定できる状態は，有効(Active)，スタンバイ(Standby)，未使用(Unused)です。

この部品が前提とするサーバを次に示します。

・vCenterサーバ

　VMware vCenter Serverがインストールされているサーバです。

・ESXサーバ

　VMware vSphere ESXiがインストールされているサーバです。

・vCenter操作サーバ(実行対象サーバ)

　VMware vSphere PowerCLIがインストールされているサーバです。JP1/AOによってこのサーバに部品が転送され，実行されます。

・仮想サーバ

　vCenterサーバおよびVMware vSphere ESXiによって管理されている仮想サーバです。

設定する状態(VMware.physicalAdapterStatusプロパティ)について次に示します。

・指定できる状態を次に示します。

　　Active

　　Standby

　　Unused

利用場面

ESXサーバの物理アダプタの閉塞または閉塞解除を設定する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-10以降

【実行対象システム内前提製品】

(1)vCenterサーバの前提製品

　・VMware vCenter Server 7.0，6.7，6.5，6.0，5.5，5.1，5.0

(2)仮想サーバを管理するVMware vSphere ESXの前提製品

　・VMware vSphere ESXi 7.0，6.7，6.5，6.0，5.5，5.1，5.0

【実行対象システム内前提製品の使用条件】

(1)VMware vSphere ESXがVMware vCenter Serverで管理されていること。

(2)VMware vSphere ESX上の設定に関する条件

　・VMwareに関連する次の名称について，VMware上では英字の大文字・小文字は区別されますが，この部品が実行するvSphere Power CLIからは，指定した名称の英字の大文字・小文字を区別できません。

　　そのため，英字の大文字・小文字が異なる同名の名称を使用している環境に対して，この部品を使用することはできません。

　　- 標準仮想スイッチ名

【実行対象サーバ内前提製品】

　・VMware vSphere PowerCLI 6.3 Release1，6.0 Release3，6.0 Release1，5.8 Release1，5.5 Release2，5.5 Release1，5.1 Release2，5.0

　・VMware PowerCLI 6.5 Release1

　・VMware PowerCLI 6.5.1，6.5.4

　・VMware PowerCLI 10.1.0，10.1.1，11.3.0，12.0.0，12.1.0

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

注意事項

(1)この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。

(2)物理アダプタの状態を"Standby"または"Unused"に設定すると，その物理アダプタを使用しての通信ができなくなります。あらかじめ，その物理アダプタが仮想サーバやESXによって使用されていないことを確認してください。

実行権限

(1)VMware vCenter Serverに接続するユーザーに，システム管理者ロールの権限が必要です。

バージョン

02.11.00

部品のタグ

Modify VM,VMware vSphere

タスクログに表示される部品の名称

vsphereSetPhysicalAdapterStatus

戻り値

戻り値

説明

12

異常(ユーザーミス) プロパティ不正

23

異常(環境不正) 前提環境不正

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.vCenterServerName

vCenterサーバ名

VMware vCenter Serverのホスト名，またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

VMware.userName

VMware vCenter Serverに接続するためのユーザー名

VMware vCenter Serverに接続するためのユーザー名を指定します。

−　

入力

○　

VMware.password

VMware vCenter Serverに接続するためのパスワード

VMware vCenter Serverに接続するためのパスワードを指定します。

−　

入力

○　

VMware.portNumber

VMware vCenter Server接続用ポート番号

VMware vCenter Serverに接続するためのポート番号(VMware vCenter ServerのWebサービス用)を指定します。指定しなかった場合には，VMware vCenter Serverで設定されているデフォルト値で接続します。

443

入力

△　

VMware.protocol

VMware vCenter Server接続用プロトコル

VMware vCenter Serverに接続するためのプロトコルを指定します。

https

入力

○　

VMware.vmHostName

ESXサーバ名

VMware vCenter Serverが管理する［ホストおよびクラスタ］に表示されるESXサーバ名を指定します。

−　

入力

○　

VMware.virtualSwitchName

標準仮想スイッチ名

状態を設定する物理アダプタが接続されている，標準仮想スイッチ名を指定します。

−　

入力

○　

VMware.physicalAdapterName

物理アダプタ名

状態を設定する物理アダプタ名を指定します。

−　

入力

○　

VMware.physicalAdapterStatus

設定する状態

物理アダプタに設定する状態を指定します。設定できる状態は，Active，Standby，Unusedです。

−　

入力

○　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.12　Windows関連の部品

5.12.1　NICのMACアドレス取得

機能

この部品は，OSの認識しているNICのMACアドレスを取得します。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　部品を実行し，MACアドレスを取得するサーバです。

最大4個までOSの認識しているNICのMACアドレスを取得します。NICにMACアドレスが設定されていない場合は，MACアドレスを取得できません。

利用場面

この部品は，OSの認識しているNICのMACアドレスを取得する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

なし。

バージョン

02.00.00

部品のタグ

Gather OS information,Windows

タスクログに表示される部品の名称

osGetNicMacaddress

戻り値

戻り値

説明

0

正常

27

異常(エラー内容はタスクログで確認)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

OS.returnNic1MacAddress

NICのMACアドレス(1個目用)

実行対象サーバのOSが認識する1個目のNICのMACアドレスを格納します。

−　

出力

△　

OS.returnNic2MacAddress

NICのMACアドレス(2個目用)

実行対象サーバのOSが認識する2個目のNICのMACアドレスを格納します。

−　

出力

△　

OS.returnNic3MacAddress

NICのMACアドレス(3個目用)

実行対象サーバのOSが認識する3個目のNICのMACアドレスを格納します。

−　

出力

△　

OS.returnNic4MacAddress

NICのMACアドレス(4個目用)

実行対象サーバのOSが認識する4個目のNICのMACアドレスを格納します。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.12.2　Windowsネットワークの設定

機能

この部品は，仮想サーバ(Windows)のOSが認識しているNICに対してIPアドレスを設定します。IPアドレス設定をするとき，ドメイン設定もあわせて行えます。

この部品が前提とするサーバを次に示します。

・実行対象サーバ

　部品を実行し，IPアドレスを設定する仮想サーバです。

最大4個までIPアドレスを設定することができます。IPアドレスを設定するNICが無効になっていた場合，NICを有効にしたあと，IPアドレスの設定を行います。仮想サーバが持つNICの数によってIPアドレスの設定順序は次のようになります。

　・仮想サーバがNICを1個持つ場合

　　NICには，IPアドレス(1個目用)>IPアドレス(2個目用)>IPアドレス(3個目用)>IPアドレス(4個目用)の順で最初に指定されていたIPアドレスを設定します。その他のIPアドレスは破棄されますのでご注意ください。

　・仮想サーバがNICを2個以上の場合

　　NICには，IPアドレス(1個目用)>IPアドレス(2個目用)>IPアドレス(3個目用)>IPアドレス(4個目用)の順でIPアドレスを設定します。IPアドレスの指定に空きがある場合，詰めて設定します。例えば，指定するIPアドレスがIPアドレス(1個目用)，IPアドレス(2個目用)，IPアドレス(4個目用)の場合(IPアドレス(3個目用)がない場合)，IPアドレス(4個目用)は仮想マシンの3つ目のNICに設定します。入力したIPアドレスの数が，仮想サーバが持つNICの数より多い場合，超えた分のIPアドレスは破棄されますのでご注意ください。

指定されたNICに既に同一IPアドレスが設定されていた場合，そのNICのIPアドレス設定を行いません。

利用場面

この部品は，OSの認識しているNICにIPアドレスを設定する場合，およびドメイン参加をする場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品の稼働OS】

　・Windows Server 2008 R2 Standard/Enterprise/Datacenter

　・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　・Windows Server 2016 Standard/Datacenter

　・Windows Server 2019 Standard/Datacenter

ただし，Server Coreインストール環境は除く。

【実行対象サーバ内前提製品の使用条件】

なし。

注意事項

(1)JP1/AOサーバとの通信に使用しているNICのIPアドレスは変更しないでください。JP1/AOサーバとの通信が切断され，タスクが異常終了します。例えば，ローカル エリア接続のNICをJP1/AOサーバとの通信に使用している場合は，既に設定されているIPアドレスをIPアドレス(VM1個目用)に指定し，ローカルエリア接続のNICに対してIPアドレス設定が行われないようにしてください。

(2)仮想サーバのOSに設定するIPアドレスについて，IPアドレスとして設定できない値は入力しないでください。例えば，ネットワークアドレスやブロードキャストアドレス，「0.0.0.0」や「255.255.255.255」などの特殊なアドレスは指定できません。入力した場合，仮想サーバのデプロイはエラーとなります。また，IPアドレス(管理用)には，JP1/AOサーバと通信できるIPアドレスを入力してください。正しいアドレスであっても，デプロイに失敗するおそれがあります。

(3)仮想サーバに設定するIPアドレスは，他のサーバと重複しないようにしてください。他のサーバとIPアドレスが重複していると，仮想サーバのNICが無効状態となり，タスクが異常終了する場合があります。

(4)ドメイン参加をする場合は，ドメイン名，ドメイン ユーザー名，ドメイン パスワードが必須となります。どれかの指定がない場合，またはドメイン参加に失敗した場合，OSの現在の設定を引き継ぎます。

(5)IPアドレス，サブネットマスクは，2つの情報をすべて指定してください。どれかの指定がない場合，IPアドレス，サブネットマスク，およびデフォルトゲートウェイの設定は行われません。

バージョン

02.00.00

部品のタグ

Configure OS,Windows

タスクログに表示される部品の名称

osSetNetworkSetting

戻り値

戻り値

説明

0

正常

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

OS.ipAddressMan

IPアドレス(VM1個目用)

仮想サーバに設定する1個目のIPアドレスを指定します。

IPv6アドレスには対応していません。

−　

入力

△　

OS.subnetMaskMan

サブネットマスク(VM1個目用)

仮想サーバに設定する1個目のサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.defaultGWMan

デフォルトゲートウェイ(VM1個目用)

仮想サーバに設定する1個目のデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.dnsMan

DNSサーバのIPアドレス(VM1個目用)

仮想サーバに設定する1個目のDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.ipAddress2

IPアドレス(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.subnetMask2

サブネットマスク(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.defaultGW2

デフォルトゲートウェイ(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.dns2

DNSサーバのIPアドレス(2個目用)

仮想サーバのOSが認識する2個目のNICに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.ipAddress3

IPアドレス(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.subnetMask3

サブネットマスク(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.defaultGW3

デフォルトゲートウェイ(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.dns3

DNSサーバのIPアドレス(3個目用)

仮想サーバのOSが認識する3個目のNICに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.ipAddress4

IPアドレス(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.subnetMask4

サブネットマスク(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するサブネットマスクを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.defaultGW4

デフォルトゲートウェイ(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するデフォルトゲートウェイを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.dns4

DNSサーバのIPアドレス(4個目用)

仮想サーバのOSが認識する4個目のNICに設定するDNSサーバのIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

△　

OS.domainName

ドメイン名

仮想サーバが所属するドメイン名を指定します。

−　

入力

△　

OS.domainUserName

ドメインのユーザー名

仮想サーバが所属するドメインのユーザー名を指定します。ワークグループ/ドメインの選択で"DOMAIN"を選択した場合，入力する必要があります。

−　

入力

△　

OS.domainUserPassword

ドメインのパスワード

仮想サーバが所属するドメインのパスワードを指定します。ワークグループ/ドメインの選択で"DOMAIN"を選択した場合，入力する必要があります。

−　

入力

△　

common.flagSucceedDomain

ドメイン参加処理の成否

ドメインに参加できたとき(TRUE)，ドメインに参加できなかったとき（FALSE）を格納します。

−　

出力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

△　

5.12.3　Windows更新プログラムのインストール

機能

Windows環境で，Windows Update機能を使用して更新プログラムを自動インストールします。

インストール対象は，実行対象サーバに対し次の条件をすべて満たす更新プログラムです。

　・Microsoftが自動更新の対象としている更新プログラム

　・未インストールの更新プログラム

　・インストール済みソフトウェアの更新プログラム

ただし，次の更新プログラムをインストール対象から除外します。

　・除外リストに指定した更新プログラム番号に完全一致した更新プログラム

　・ユーザー入力が必要な更新プログラム(例:サービスパック等)

除外リストは，Windows.updateProgramExclusionListプロパティにインストールしない更新プログラム番号(例:KB9999999)を指定します。更新プログラム番号が複数ある場合は，コンマ区切りで指定します。コンマも含めて1024バイト以下で指定してください。

Windows Updateを実施したあとは，Windows.updateResultOutputFolderプロパティに指定する実行対象サーバ上のフォルダに，除外リスト，更新プログラムの検索結果，インストールした更新プログラム，インストールできなかった更新プログラムの一覧をテキストファイルとして出力します。ファイル名は「<年月日時分>.txt」です。

　例:201312312345.txt

・出力されるファイルには，次の項目が記述されます。

　(a)ホスト名

　(b)除外リスト

　(c)検索結果の更新プログラムタイトル一覧

　　検索結果は，1更新プログラムごとに1行記述されます。

　　各プログラムごとに，その更新プログラムがadding(インストール対象)なのか，skipping(インストール非対象)なのかが記述されています。

　　skippingの場合は，ユーザー入力が必要なためなのか，除外リストによって除外されたためなのか，その理由が記述されています。

　(d)更新プログラムインストール全体のResultCode

　　ResultCodeの意味は次のとおりです。

　　　0:インストール処理未実行 1:インストール処理中 2:正常終了 3:処理は完了したが一部エラー 4:インストール処理エラー 5:インストール処理キャンセル

　(e)インストールした更新プログラムタイトル一覧

　　各プログラムごとに，その更新プログラムのResultCodeが記述されています。

　(f)再起動要否

　　再起動が必要(Necessary)か不必要(Unnecessary)かが記述されています。

　(g)スクリプト自体の終了コード

　　スクリプト自体の終了コードが出力されます。

　　終了コードの意味は次のとおりです。

　　　0:正常　27:異常(エラー内容はタスクログで確認)　41:異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

　(h)検索されたが除外された，もしくはインストール処理がエラーになったためインストールできなかった更新プログラムのタイトル

実行対象サーバのOSがWindowsの場合，この部品の実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。実行対象サーバにAdministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合，または，無効の場合，システムアカウントで実行を行う部品「Windows更新プログラムのインストール(SYSTEM)」を実行してください。

利用場面

Windowsの更新プログラムが発行された際に，更新プログラムを適用する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　なし。

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバの使用条件】

　(1)実行対象サーバが起動していること。

　(2)実行対象サーバがプロキシサーバーを使用せずにWindows Updateを実施するためのWebサイトにアクセスできること。

　(3)実行対象サーバがInternet Explorer(ブラウザー)からWindows Updateを実施するためのWebサイトにアクセスできること。

　(4)次に示すサービスが起動していること。

　　・Windows Update

注意事項

(1)自動的に再起動する更新プログラムをインストールした場合，Windowsによって実行対象サーバが自動で再起動します。

(2)この部品を同一の実行対象サーバに対して多重実行しないでください。

実行権限

ビルトイン Administrator

バージョン

02.00.00

部品のタグ

Configure OS,Windows

タスクログに表示される部品の名称

osWindowsUpdate

戻り値

戻り値

説明

0

正常

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

Windows.updateResultOutputFolder

結果情報ファイル出力先フォルダ名

Windows Update実施のあとにインストール結果情報を出力するための，実行対象サーバ上のフォルダ名をフルパスで指定します。

−　

入力

○　

Windows.updateProgramExclusionList

Windows Updateの適用除外リスト

Windows Updateの適用を除外する更新プログラム番号を指定します。複数の番号を指定する場合はコンマで区切ります。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

○　

Windows.rebootNecessity

再起動要否

更新の結果，再起動が必要かどうかを示す値(Necessary:必要，Unnecessary:不必要)が格納されます。

−　

出力

○　

5.12.4　Windows更新プログラムのインストール(SYSTEM)

機能

Windows環境で，Windows Update機能を使用して更新プログラムを自動インストールします。

インストール対象は，実行対象サーバに対し次の条件をすべて満たす更新プログラムです。

　・Microsoftが自動更新の対象としている更新プログラム

　・未インストールの更新プログラム

　・インストール済みソフトウェアの更新プログラム

ただし，次の更新プログラムをインストール対象から除外します。

　・除外リストに指定した更新プログラム番号に完全一致した更新プログラム

　・ユーザー入力が必要な更新プログラム(例:サービスパック等)

除外リストは，Windows.updateProgramExclusionListプロパティにインストールしない更新プログラム番号(例:KB9999999)を指定します。更新プログラム番号が複数ある場合は，コンマ区切りで指定します。コンマも含めて1024バイト以下で指定してください。

Windows Updateを実施したあとは，Windows.updateResultOutputFolderプロパティに指定する実行対象サーバ上のフォルダに，除外リスト，更新プログラムの検索結果，インストールした更新プログラム，インストールできなかった更新プログラムの一覧をテキストファイルとして出力します。ファイル名は「<年月日時分>.txt」です。

　例:201312312345.txt

・出力されるファイルには，次の項目が記述されます。

　(a)ホスト名

　(b)除外リスト

　(c)検索結果の更新プログラムタイトル一覧

　　検索結果は，1更新プログラムごとに1行記述されます。

　　各プログラムごとに，その更新プログラムがadding(インストール対象)なのか，skipping(インストール非対象)なのかが記述されています。

　　skippingの場合は，ユーザー入力が必要なためなのか，除外リストによって除外されたためなのか，その理由が記述されています。

　(d)更新プログラムインストール全体のResultCode

　　ResultCodeの意味は次のとおりです。

　　　0:インストール処理未実行 1:インストール処理中 2:正常終了 3:処理は完了したが一部エラー 4:インストール処理エラー 5:インストール処理キャンセル

　(e)インストールした更新プログラムタイトル一覧

　　各プログラムごとに，その更新プログラムのResultCodeが記述されています。

　(f)再起動要否

　　再起動が必要(Necessary)か不必要(Unnecessary)かが記述されています。

　(g)スクリプト自体の終了コード

　　スクリプト自体の終了コードが出力されます。

　　終了コードの意味は次のとおりです。

　　　0:正常　27:異常(エラー内容はタスクログで確認)　41:異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

　(h)検索されたが除外された，もしくはインストール処理がエラーになったためインストールできなかった更新プログラムのタイトル

利用場面

Windowsの更新プログラムが発行された際に，更新プログラムを適用する場合に使用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 11-00以降

【実行対象サーバ内前提製品】

　なし。

【実行対象サーバの稼働OS】

　(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

　(3) Windows Server 2016 Standard/Datacenter

　(4) Windows Server 2019 Standard/Datacenter

　　ただし，Server Coreインストール環境は除く。

【実行対象サーバの使用条件】

　(1)実行対象サーバが起動していること。

　(2)実行対象サーバがプロキシサーバーを使用せずにWindows Updateを実施するためのWebサイトにアクセスできること。

　(3)実行対象サーバがInternet Explorer(ブラウザー)からWindows Updateを実施するためのWebサイトにアクセスできること。

　(4)次に示すサービスが起動していること。

　　・Windows Update

注意事項

(1)自動的に再起動する更新プログラムをインストールした場合，Windowsによって実行対象サーバが自動で再起動します。

(2)この部品を同一の実行対象サーバに対して多重実行しないでください。

実行権限

Administratorsグループに所属するユーザー

バージョン

03.10.00

部品のタグ

Configure OS,Windows

タスクログに表示される部品の名称

osWindowsUpdate_System

戻り値

戻り値

説明

0

正常

27

異常(エラー内容はタスクログで確認)

41

異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー

プロパティ名

説明

デフォルト値

入出力種別

必須区分

plugin.destinationHost

実行対象サーバのホスト名

この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。

−　

入力

○　

Windows.updateResultOutputFolder

結果情報ファイル出力先フォルダ名

Windows Update実施のあとにインストール結果情報を出力するための，実行対象サーバ上のフォルダ名をフルパスで指定します。

−　

入力

○　

Windows.updateProgramExclusionList

Windows Updateの適用除外リスト

Windows Updateの適用を除外する更新プログラム番号を指定します。複数の番号を指定する場合はコンマで区切ります。

−　

入力

△　

common.returnValue

部品の戻り値

この部品の戻り値が格納されます。

−　

出力

○　

Windows.rebootNecessity

再起動要否

更新の結果，再起動が必要かどうかを示す値(Necessary:必要，Unnecessary:不必要)が格納されます。

−　

出力

○　

付録

付録A　参考情報

ここでは，JP1/AOを使用する上での参考情報について説明します。

付録A.1　基本部品のバージョン間の機能差異

(1)　各バージョンで使用できる基本部品

JP1/AO 12-60で使用できる基本部品を次に示します。新しいバージョンの部品は，部品が追加されたバージョン以前のJP1/AOでは使用できません。

表A‒1　JP1/AO 12-60で使用できる基本部品のバージョン

部品の名称

部品のバージョン

汎用コマンド実行部品

01.00.00

01.02.00

01.10.00

01.12.00

01.50.00

01.52.00

01.52.01

02.00.00

02.01.00

ファイル転送部品

01.00.00

01.02.00

01.11.00

01.12.00

01.50.00

01.52.00

01.52.01

繰り返し実行部品

01.00.00

01.00.01

メール通知部品

ユーザー応答待ち部品

標準出力部品

ターミナル接続部品

01.02.00

01.50.00

01.52.00

01.52.01

02.00.00

ターミナルコマンド実行部品

01.02.00

01.02.01

02.00.00

ターミナル切断部品

階層フロー部品

01.10.00

01.10.01

01.11.00

実行間隔制御部品

01.10.00

01.10.01

戻り値判定分岐部品

値判定部品

異常終了部品

値判定分岐部品

JavaScript実行部品

01.00.00

01.00.01

01.00.02

01.00.03

ファイルエクスポート部品

01.00.00

Webクライアント部品

01.00.00

01.01.00

Python実行部品

01.00.01

(a)　 汎用コマンド実行部品のバージョン間の機能差異

部品のバージョン01.00.00と01.02.00との機能差異

操作対象の機器に，SolarisとHP-UXを指定できるようになりました。

次のプロパティキーの設定が変更になりました。

表A‒2　プロパティキーの機能差異

プロパティキー

01.00.00での機能

01.02.00での機能

stdoutProperty1

説明

プロパティ「stdoutPattern1」で切り出した値を格納するサービスプロパティのプロパティキーを指定します。サービスプロパティに設定できる文字列は1,024文字までです。1,025文字以降は切り捨てられます。

入出力種別

in

必須区分

false

説明

標準出力パターン1で切り出された文字列が出力されます。

入出力種別

out

必須区分

指定しない。

stdoutProperty2

説明

プロパティ「stdoutPattern2」で切り出した値を格納するサービスプロパティのプロパティキーを指定します。サービスプロパティに設定できる文字列は1,024文字までです。1,025文字以降は切り捨てられます。

入出力種別

in

必須区分

false

説明

標準出力パターン2で切り出された文字列が出力されます。

入出力種別

out

必須区分

指定しない。

stdoutProperty3

説明

プロパティ「stdoutPattern3」で切り出した値を格納するサービスプロパティのプロパティキーを指定します。サービスプロパティに設定できる文字列は1,024文字までです。1,025文字以降は切り捨てられます。

入出力種別

in

必須区分

false

説明

標準出力パターン3で切り出された文字列が出力されます。

入出力種別

out

必須区分

指定しない。

commandLine

操作対象の機器のOSがLinux以外のUNIXでは，プロパティ「commandLine」には，ASCII文字を指定してください。

操作対象の機器のOSがUNIXの場合，プロパティ「commandLine」にASCII文字を指定できます。ASCII文字以外を指定するには前提条件があります。前提条件については，「付録A.4　UNIXでASCII文字以外の文字を含むコマンドラインを実行するための前提条件」を参照してください。

commandLineParameter

操作対象の機器のOSがLinux以外のUNIXでは，プロパティ「commandLineParameter」には，ASCII文字を指定してください。

操作対象の機器のOSがUNIXの場合，プロパティ「commandLineParameter」にASCII文字を指定できます。ASCII文字以外を指定するには前提条件があります。前提条件については，「付録A.4　UNIXでASCII文字以外の文字を含むコマンドラインを実行するための前提条件」を参照してください。

部品のバージョン01.02.00と01.10.00との機能差異

操作対象の機器に，AIXを指定できるようになりました。

部品のバージョン01.10.00と01.12.00との機能差異

プロパティ「elevatePrivileges」を追加し，操作対象の機器のOSがUNIXの場合にrootユーザーに昇格するかどうかを指定できるようになりました。

部品のバージョン01.12.00と01.50.00との機能差異

プロパティ「publicKeyAuthentication」を追加し，操作対象の機器にSSH接続をする際，公開鍵認証を使用するかどうかを指定できるようになりました。

部品のバージョン01.50.00と01.52.00との機能差異

プロパティ「keyboardInteractiveAuthentication」を追加し，操作対象の機器にSSH接続をする際，キーボードインタラクティブ認証を使用するかどうかを指定できるようになりました。

部品のバージョン01.52.00と01.52.01との機能差異

部品に付与されているカテゴリの情報をタグの情報に変更しました。

部品のバージョン01.52.01と02.00.00との機能差異

プロパティ「runAsSystem」を追加し，操作対象の機器のOSがWindowsの場合，Systemアカウントの権限でコマンドを実行するかどうかを指定できるようになりました。

部品のバージョン02.00.00と02.01.00との機能差異

プロパティ「outputCondition」を追加し，標準出力および標準エラー出力がプロパティ「stdoutPattern1〜3」と合致しなかった場合に，プロパティ「stdoutProperty1〜3」に値を出力するかどうかを指定できるようになりました。

(b)　 ファイル転送部品のバージョン間の機能差異

部品のバージョン01.00.00と01.02.00との機能差異

次のプロパティキーの設定が変更になりました。

表A‒3　プロパティキーの機能差異

プロパティキー

01.00.00での機能

01.02.00での機能

remoteFilePath

操作対象の機器のOSがLinuxの場合，転送したいファイルおよびフォルダ名には，ASCII文字だけ指定できます。

操作対象の機器のOSがLinuxの場合，転送したいファイルおよびフォルダ名の文字セットは，接続ユーザーの文字セットと一致させる必要があります。また，プロパティ「remoteFilePath」にASCII文字以外を指定するには前提条件があります。前提条件については，「付録A.4　UNIXでASCII文字以外の文字を含むコマンドラインを実行するための前提条件」を参照してください。

部品のバージョン01.02.00と01.11.00との機能差異

操作対象の機器のOSとして，AIX，HP-UX，Solarisに対応しました。

部品のバージョン01.11.00と01.12.00との機能差異

プロパティ「elevatePrivileges」を追加し，操作対象の機器のOSがUNIXの場合にrootユーザーに昇格するかどうかを指定できるようになりました。

部品のバージョン01.12.00と01.50.00との機能差異

プロパティ「publicKeyAuthentication」を追加し，操作対象の機器にSSH接続をする際，公開鍵認証を使用するかどうかを指定できるようになりました。

部品のバージョン01.50.00と01.52.00との機能差異

プロパティ「keyboardInteractiveAuthentication」を追加し，操作対象の機器にSSH接続をする際，キーボードインタラクティブ認証を使用するかどうかを指定できるようになりました。

部品のバージョン01.52.00と01.52.01との機能差異

部品に付与されているカテゴリの情報をタグの情報に変更しました。

(c)　繰り返し実行部品のバージョン間の機能差異

部品のバージョン01.00.00と01.00.01との機能差異

部品に付与されているカテゴリの情報をタグの情報に変更しました。

(d)　メール通知部品のバージョン間の機能差異

部品のバージョン01.00.00と01.00.01との機能差異

部品に付与されているカテゴリの情報をタグの情報に変更しました。

(e)　ユーザー応答待ち部品のバージョン間の機能差異

部品のバージョン01.00.00と01.00.01との機能差異

部品に付与されているカテゴリの情報をタグの情報に変更しました。

(f)　標準出力部品のバージョン間の機能差異

部品のバージョン01.00.00と01.00.01との機能差異

部品に付与されているカテゴリの情報をタグの情報に変更しました。

(g)　ターミナル接続部品のバージョン間の機能差異

部品のバージョン01.02.00と01.50.00との機能差異

プロパティ「publicKeyAuthentication」を追加し，操作対象の機器にSSH接続をする際，公開鍵認証を使用するかどうかを指定できるようになりました。

部品のバージョン01.50.00と01.52.00との機能差異

プロパティ「keyboardInteractiveAuthentication」を追加し，操作対象の機器にSSH接続をする際，キーボードインタラクティブ認証を使用するかどうかを指定できるようになりました。

部品のバージョン01.52.00と01.52.01との機能差異

部品に付与されているカテゴリの情報をタグの情報に変更しました。

部品のバージョン01.52.01と02.00.00との機能差異

プロパティ「outputCondition」を追加し，標準出力および標準エラー出力がプロパティ「stdoutPattern1〜3」と合致しなかった場合に，プロパティ「stdoutProperty1〜3」に値を出力するかどうかを指定できるようになりました。

(h)　ターミナルコマンド実行部品のバージョン間の機能差異

部品のバージョン01.02.00と01.02.01との機能差異

部品に付与されているカテゴリの情報をタグの情報に変更しました。

部品のバージョン01.02.01と02.00.00との機能差異

プロパティ「outputCondition」を追加し，標準出力および標準エラー出力がプロパティ「stdoutPattern1〜3」と合致しなかった場合に，プロパティ「stdoutProperty1〜3」に値を出力するかどうかを指定できるようになりました。

(i)　ターミナル切断部品のバージョン間の機能差異

部品のバージョン01.02.00と01.02.01との機能差異

部品に付与されているカテゴリの情報をタグの情報に変更しました。

(j)　階層フロー部品のバージョン間の機能差異

部品のバージョン01.10.00と01.10.01との機能差異

部品に付与されているカテゴリの情報をタグの情報に変更しました。

部品のバージョン01.10.01と01.11.00との機能差異

後続ステップ実行条件を設定できるようになりました。

プロパティ「errorStep」「returnValueOfErrorStep」を追加し，一階層配下の失敗したステップのステップIDと戻り値を出力できるようになりました。

(k)　実行間隔制御部品のバージョン間の機能差異

部品のバージョン01.10.00と01.10.01との機能差異

部品に付与されているカテゴリの情報をタグの情報に変更しました。

(l)　戻り値判定分岐部品のバージョン間の機能差異

部品のバージョン01.10.00と01.10.01との機能差異

部品に付与されているカテゴリの情報をタグの情報に変更しました。

(m)　値判定部品のバージョン間の機能差異

部品のバージョン01.10.00と01.10.01との機能差異

部品に付与されているカテゴリの情報をタグの情報に変更しました。

(n)　異常終了部品のバージョン間の機能差異

部品のバージョン01.10.00と01.10.01との機能差異

部品に付与されているカテゴリの情報をタグの情報に変更しました。

(o)　値判定分岐部品のバージョン間の機能差異

部品のバージョン01.10.00と01.10.01との機能差異

部品に付与されているカテゴリの情報をタグの情報に変更しました。

(p)　JavaScript実行部品のバージョン間の機能差異

部品のバージョン01.00.00 と01.00.01 との機能差異

部品に付与されているカテゴリの情報をタグの情報に変更しました。

部品のバージョン01.00.01 と01.00.02 との機能差異

プロパティ「importedScript」を追加し，同一サービステンプレート上に配置したほかのJavaScript実行部品と共通で使用するメソッドや定数（JavaScriptのコード文字列）を指定できるようになりました。

部品のバージョン01.00.02 と01.00.03 との機能差異

プロパティ「notify」のツールチップの日本語の情報を変更しました。

(q)　Webクライアント部品のバージョン間の機能差異

部品のバージョン01.00.00と01.01.00との機能差異

Webサービス接続先定義の設定値を参照するためのプロパティを追加しました。

(2)　各バージョンのロケールと文字セットの扱い

部品のバージョンごとに，操作対象の機器との通信で設定されるロケールの環境変数の内容，および文字セットの自動判定ができるかどうかを示します。文字セットの自動判定をすることで，コマンドライン，標準出力，標準エラー出力，および転送対象のファイル名にASCII文字以外を使用できるようになります。

なお，次の部品は，エージェントレス接続を行わないため，ロケールの設定および文字セットの自動判定をしません。

繰り返し実行部品

メール通知部品

ユーザー応答待ち部品

標準出力部品

階層フロー部品

実行間隔制御部品

戻り値判定分岐部品

値判定部品

異常終了部品

値判定分岐部品

JavaScript実行部品

ファイルエクスポート部品

Webクライアント部品

Python実行部品

表A‒4　操作対象の機器との通信で設定されるロケールの環境変数の内容

部品名

部品のバージョン

01.00.00

01.02.00以降

汎用コマンド実行部品

LC_ALL=C

「LC_ALL」および「LANG」に対して，接続ユーザーのデフォルトのロケールが適用される。

ファイル転送部品

LC_ALL=C

「LC_ALL」および「LANG」に対して，接続ユーザーのデフォルトのロケールが適用される。

ターミナル接続部品

−

×

ターミナルコマンド実行部品

−

×

ターミナル切断部品

−

×

（凡例）

×：設定されません。 −：該当するバージョンの部品はありません。

表A‒5　各バージョンで使用できる文字セットの自動判定

部品

部品のバージョン

01.00.00

01.02.00以降

汎用コマンド実行部品

×

○

ファイル転送部品

×

○

ターミナル接続部品

−

△

ターミナルコマンド実行部品

−

△

ターミナル切断部品

−

△

（凡例）

○：プロトコルがSSHの場合に自動判定されます。 △：自動判定されないため，部品プロパティで文字セットを指定します。 ×：自動判定されません。 −：該当するバージョンの部品はありません。

関連トピック

マニュアル「JP1/AO サービステンプレート開発ガイド」−「部品実行時に設定される操作対象の機器のロケールについて」のトピック

マニュアル「JP1/AO サービステンプレート開発ガイド」−「部品実行時にJP1/AO が通信で使用する文字セットについて」のトピック

(3)　エージェントレス接続先として使用できる操作対象の機器

エージェントレス接続先として使用できる操作対象の機器を次に示します。接続できるエージェントレス接続先のOSの詳細なバージョンおよび部品実行に必要なコマンドについては，リリースノートを参照してください。

なお，次の部品は，エージェントレス接続を行いません。

繰り返し実行部品

メール通知部品

ユーザー応答待ち部品

標準出力部品

階層フロー部品

実行間隔制御部品

戻り値判定分岐部品

値判定部品

異常終了部品

値判定分岐部品

JavaScript実行部品

ファイルエクスポート部品

Webクライアント部品

Python実行部品

表A‒6　エージェントレス接続先として使用できる操作対象の機器

部品

操作対象の機器

Windows

Linux

Solaris

HP-UX

AIX

SSHまたはTelnetに対応した機器

汎用コマンド実行部品

01.00.00

01.00.00

01.02.00

01.02.00

01.10.00

×

ファイル転送部品

01.00.00

01.00.00

01.11.00

01.11.00

01.11.00

×

ターミナル接続部品

01.02.00※

01.02.00※

01.02.00※

01.02.00※

01.02.00※

01.02.00

ターミナルコマンド実行部品

01.02.00※

01.02.00※

01.02.00※

01.02.00※

01.02.00※

01.02.00

ターミナル切断部品

01.02.00※

01.02.00※

01.02.00※

01.02.00※

01.02.00※

01.02.00

（凡例）

01.00.00 ：部品のバージョン01.00.00以降で使用できます。

01.02.00 ：部品のバージョン01.02.00以降で使用できます。

01.10.00 ：部品のバージョン01.10.00以降で使用できます。

01.11.00 ：部品のバージョン01.11.00以降で使用できます。

×：サポートしません。

注※

SSHまたはTelnetのサーバとして設定すれば，使用できます。

付録A.2　各部品で使用できるプロトコル一覧

使用する部品によって，JP1/AOとエージェントレス接続先との通信で使用できるプロトコルは異なります。

各部品で使用できるプロトコルの一覧を次に示します。

表A‒7　各部品で使用できるプロトコル一覧

部品

プロトコル

Windows

SSH※

Telnet

コンテンツ部品

○

○

×

基本部品

汎用コマンド実行部品

○

○

×

ファイル転送部品

○

○

×

ターミナル接続部品

×

○

○

（凡例）

○：使用できます。 ×：使用できません。

注※

認証方式には，パスワード認証，公開鍵認証またはキーボードインタラクティブ認証を選択できます。

プロトコルバージョン2をサポートしています。

付録A.3　Hyper-Vが管理している仮想サーバの状態一覧

Hyper-V（Windows Server 2008 R2）では，仮想サーバに対する操作を実行する前に，仮想サーバの状態を確認します。取得した仮想サーバの状態は，タスクログに出力されます。対象となるサービステンプレートを次に示します。

仮想サーバの追加（仮想ディスク）

仮想サーバの起動

仮想サーバの停止

仮想サーバの再起動

また，サービステンプレート「仮想サーバの情報一覧取得」は，仮想サーバの状態を取得して，CSV形式でファイルに出力します。

Hyper-V（Windows Server 2008 R2）が管理している仮想サーバの状態と，タスクログ，およびサービステンプレート「仮想サーバの情報一覧取得」で出力する状態の関係を次に示します。

表A‒8　Hyper-V（Windows Server 2008 R2）で管理している仮想サーバの状態一覧

仮想サーバの状態

JP1/AOの状態※

説明

0

Unknown

不明

2

Enabled

起動完了

3

Disabled

停止完了

32768

Paused

一時停止完了

32769

Suspended

保存完了

32770

Starting

起動処理中

32771

Snapshotting

スナップショット取得処理中

32773

Saving

保存処理中

32774

Stopping

停止処理中

32776

Pausing

一時停止処理中

32777

Resuming

再開処理中

その他

UnDefined

仮想サーバの状態が未定義

注※

タスクログ，およびサービステンプレート「仮想サーバの情報一覧取得」の実行結果として表示される情報です。

付録A.4　UNIXでASCII文字以外の文字を含むコマンドラインを実行するための前提条件

操作対象の機器のOSがUNIXの場合，ASCII文字以外の文字をプロパティに使用してコマンドを実行したいとき，必要となる設定があります。対象となる部品およびプロパティを次に示します。

汎用コマンド実行部品

プロパティ「commandLine」

プロパティ「commandLineParameter」

ファイル転送部品

プロパティ「remoteFilePath」

ターミナルコマンド実行部品

プロパティ「commandLine」

コンテンツ部品※

注※

操作対象の機器のOSがUNIXの場合，ASCII文字以外の文字をプロパティに使用してコマンドを実行したいとき，スクリプトの中で設定が必要になります。コンテンツ部品では，コマンドラインおよびコマンドラインから参照されるプロパティが対象です。

スクリプトに記述する設定内容は，実行したい部品および操作対象の機器のOSによって異なります。次に，実行したい部品および操作対象の機器のOSごとに必要な設定を示します。次の表の内容が正しく設定されていない場合，実行結果が不正になります。

表A‒9　UNIXでASCII文字以外の文字を含むコマンドラインを実行するために必要な設定

部品

操作対象の機器のOS

ログインスクリプトの設定

「.bashrc」の設定

汎用コマンド実行部品

ファイル転送部品※

コンテンツ部品

AIX

○

×

HP-UX

○

×

Linux

○

×

Solaris

○

○

ターミナルコマンド実行部品

UNIX

○

×

（凡例）

○：設定が必要です。 ×：設定は必要ありません。

注※

ファイル転送部品では，コマンドラインではなく部品プロパティ「remoteFilePath」の値にASCII文字以外の文字を含む場合です。

ログインスクリプトの設定

概要

接続ユーザーのログインスクリプトで「istrip」の設定を無効にします。

確認方法

各部品のコマンドラインでstty -aコマンドを実行すると，コマンドの標準出力で「istrip」の設定状況を確認できます。「-istrip」と表示されていれば，「istrip」の設定は無効です。また，「istrip」の表示に「-」がない場合，「istrip」の設定は有効のため，次に示す設定をしてください。

設定方法

接続ユーザーのログインスクリプトにstty -istripコマンドを記述してください。

重要

rootユーザーに昇格する設定をしている場合は，rootユーザーのログインスクリプトで「istrip」の設定が上書きされるため，あらかじめ，rootユーザーのログインスクリプトで「istrip」の設定が無効になっていることを確認してください。

「.bashrc」の設定

概要

接続ユーザーまたはrootユーザーの「.bashrc」の中で，環境変数「LC_ALL」に「C」以外の有効なロケールを設定します。また，環境変数「LC_ALL」に値を設定する記述がない場合も，「C」以外の有効なロケールを設定します。

rootユーザーに昇格する設定をしていない場合としている場合とで，確認および設定方法が異なります。次に確認および設定方法をそれぞれ示します。

確認方法

rootユーザーに昇格する設定をしていない場合

rootユーザーの「.bashrc」で，環境変数「LC_ALL」の値に「C」以外が設定されているかどうか確認します。

rootユーザーに昇格しない設定をしている場合

接続ユーザーの「.bashrc」で，環境変数「LC_ALL」の値に「C」以外が設定されているかどうか確認します。

設定方法

rootユーザーに昇格する設定をしていない場合

rootユーザーの「.bashrc」に，環境変数「LC_ALL」の値として，ユーザーの環境で有効な「C」以外のロケールを設定してください。

rootユーザーに昇格しない設定をしている場合

接続ユーザーの「.bashrc」に，環境変数「LC_ALL」の値として，ユーザーの環境で有効な「C」以外のロケールを設定してください。

付録A.5　部品提供用のサービステンプレートに含まれる部品一覧

JP1/AOでは，部品提供用として，次のサービステンプレートを提供しています。ここでは，次のサービステンプレートに含まれる部品について説明します。

表A‒10　部品提供用サービステンプレート一覧

サービステンプレート名

提供方法

Utility Components

JP1/AO同梱版サービステンプレート

AWS Components

JP1/AO Content Pack版サービステンプレート

HCS Components

Hyper-V2008 Components

Hyper-V2012 Components

Hyper-V2016 Components

OpenStack Components

Oracle Components

vSphere Components

(1)　Utility Componentsに含まれる部品一覧

Utility Componentsに含まれる部品一覧を次に示します。

表A‒11　Utility Componentsに含まれる部品一覧

部品名

分類

Active Directoryオブジェクト移動

Active Directory関連

Active Directoryオブジェクト検索

Active Directoryオブジェクト削除

Active Directoryグループメンバー一覧取得

Active Directoryグループ属性変更

Active Directoryグループ追加

Active DirectoryのOU属性変更

Active DirectoryのUPN一覧取得

Active DirectoryへのOU追加

Active Directoryユーザーアカウントロック解除

Active Directoryユーザーのパスワード変更

Active Directoryユーザー属性変更

Active Directoryユーザー追加

Active Directory既存グループからのメンバー削除

Active Directory既存グループへのメンバー追加

Active Directory連絡先属性変更

Active Directory連絡先追加

JP1サイレントインストール(UNIX)

JP1関連

JP1サイレントインストール(Windows)

JP1修正パッチ適用(UNIX)

JP1修正パッチ適用(Windows)

JP1/AJSジョブネット確定実行登録

JP1/AJS関連

JP1/AJSジョブネット強制終了

JP1/AJSジョブネット計画実行登録

JP1/AJSジョブネット再実行

JP1/AJSジョブネット実行スケジュール変更

JP1/AJSジョブネット実行中止

JP1/AJSジョブネット実行登録

JP1/AJSジョブネット実行予実績出力

JP1/AJSジョブネット中断

JP1/AJSジョブネット保留属性変更

JP1/AJSジョブ状態変更

JP1/AJSのジョブネット実行結果取得

JP1/AJSのトラブルシュート情報取得

JP1/AJSの起動(UNIX)

JP1/AJSの状態取得

JP1/AJSの停止(UNIX)

JP1/AJSユニット存在確認

JP1/Baseイベントサービスの起動(UNIX)

JP1/Base関連

JP1/Baseイベントサービスの状態取得

JP1/Baseイベントサービスの停止(UNIX)

JP1/Baseのトラブルシュート情報取得

JP1/Baseのパスワード管理情報変更

JP1/Baseのパスワード管理情報変更(SYSTEM)

JP1/Baseのユーザーマッピング追加

JP1/Baseのユーザーマッピング追加(SYSTEM)

JP1/Baseの起動(UNIX)

JP1/Baseの状態取得

JP1/Baseの停止(UNIX)

JP1/Baseユーザーマッピング削除

JP1/Baseユーザーマッピング削除(SYSTEM)

JP1/Base共通定義情報設定

JP1/Base操作権限設定

JP1/Base操作権限設定(SYSTEM)

JP1イベントの登録

JP1ユーザーパスワード変更

JP1ユーザーパスワード変更(SYSTEM)

JP1ユーザー一覧取得

JP1ユーザー削除

JP1ユーザー削除(SYSTEM)

JP1ユーザー操作権限削除

JP1ユーザー操作権限削除(SYSTEM)

JP1ユーザー追加

JP1ユーザー追加(SYSTEM)

OSユーザー情報の削除

OSユーザー情報の削除(SYSTEM)

マッピング情報の確認

JP1/IMトラブルシュート情報の収集

JP1/IM関連

JP1イベントの対処状況変更

JP1イベント取得

NNMiトポロジデータベース内容の出力

JP1/NNMi関連

監視対象ノード削除

監視対象ノード追加

Storeデータベース保存条件設定

JP1/PFM関連

アラームテーブルのコピー(JP1/PFM)

アラームテーブルの削除(JP1/PFM)

アラームテーブルの情報取得(JP1/PFM)

アラームテーブル名一覧取得(JP1/PFM - RM)

アラームのアンバインド(JP1/PFM - RM)

アラームのバインド(JP1/PFM - RM)

アラーム定義ファイルのインポート(JP1/PFM)

アラーム定義ファイルのエクスポート(JP1/PFM)

エージェント階層設定

サービス情報同期

プロセス監視設定一覧取得

プロセス監視設定追加

レポート取得

監視設定追加(JP1/PFM - RM)

監視対象削除(JP1/PFM - RM)

監視対象追加(JP1/PFM - RM)

監視対象表示(JP1/PFM - RM)

JP1/IM-SSの案件情報更新

JP1/SS関連

JP1/IM-SSの案件登録

インスタントリカバリ実行(JP1/VERITAS)

JP1/VERITAS関連

インスタントリカバリ終了(JP1/VERITAS)

バックアップポリシー(VMware)の初期化

バックアップポリシー(VMware)の属性変更

バックアップポリシーの作成

バックアップポリシーへのクライアント追加

バックアップポリシーへのスケジュール属性変更

バックアップポリシーへのスケジュール追加

バックアップポリシーへのファイルリスト追加

バックアップ実行(JP1/VERITAS)

仮想マシンリストア実行

名前変更ファイルの作成

CSV・Excelのセルデータ更新

OS関連

CSV・Excelのセルデータ取得

CSV・Excelのデータ分割

CSV・Excelの行データ取得

CSV・Excelの行データ取得(SYSTEM)

CSV・Excelの列データ取得

CSV・Excelの列データ取得(SYSTEM)

ICMPエコー要求メッセージの送信

IPアドレスの設定

OSサービスの操作

OSユーザーのパスワード変更

OSユーザーのパスワード変更(SYSTEM)

OSユーザーの一覧取得

OSユーザーの削除

OSユーザーの削除(SYSTEM)

OS種別の出力

サーバのシャットダウン

サーバの再起動

テキストファイルの文字列抽出

ファイルのコピー

ファイルのサイズ取得

ファイルの圧縮

ファイルの解凍

ファイルの最終更新日時取得

ファイルの文字エンコード変換

ファイルまたはフォルダのアクセス権限取得

ファイルまたはフォルダの存在確認

ファイル移動

ファイル一覧の取得

ファイル削除

ファイル削除(SYSTEM)

フォルダ作成

フォルダ削除

プロセスの情報取得

ホスト名取得

実行待機

日時計算

日時取得

日時比較

文字列のソート処理

文字列のフィルタリング

文字列の検索

文字列の置換

文字列の追加

TELstaffによる通知

TELstaff関連

OSユーザーの追加 (UNIX)

UNIX関連

ファイルまたはディレクトリのアクセス権限変更

CSVデータ取得

Windows関連

ICMPエコー要求メッセージの送信 (無応答確認)

OSサービスのアカウント変更

OSサービスのスタートアップ設定

OSユーザーのグループ設定 (Windows)

OSユーザーのグループ設定 (Windows)(SYSTEM)

OSユーザーの追加 (Windows)

OSユーザーの追加 (Windows)(SYSTEM)

SQLクエリーの実行

Windowsファイアウォールの設定

イベントログのイベント一覧取得

イベントログへのイベント作成

ファイルの印刷(Windows)

ファイルまたはフォルダのアクセス権限変更

時刻判定

(2)　AWS Componentsに含まれる部品一覧

AWS Componentsに含まれる部品一覧を次に示します。

表A‒12　AWS Componentsに含まれる部品一覧

部品名

分類

AMIの作成

AWS関連

スタックの作成

スタックの削除

スタックの情報一覧取得

スナップショットの作成

スナップショットの削除

スナップショットの情報一覧取得

ファイルのアップロード

ファイルのダウンロード

ファイルの削除

仮想サーバのインスタンスタイプ設定

仮想サーバのシャットダウン

仮想サーバの起動

仮想サーバの作成

仮想サーバの削除

仮想サーバの情報一覧取得

仮想サーバの状態取得

(3)　HCS Componentsに含まれる部品一覧

HCS Componentsに含まれる部品一覧を次に示します。

表A‒13　HCS Componentsに含まれる部品一覧

部品名

分類

DPボリュームの作成

HCS関連

DPボリュームの削除

HDvM接続確認

LU作成確認

ストレージ情報一覧取得

ホストグループからLUを削除

ホストグループにLUを登録

(4)　Hyper-V2008 Componentsに含まれる部品一覧

Hyper-V2008 Componentsに含まれる部品一覧を次に示します。

表A‒14　Hyper-V2008 Componentsに含まれる部品一覧

部品名

分類

応答ファイルの作成

Hyper-V 2008関連

仮想サーバのIPアドレス取得

仮想サーバのシャットダウン

仮想サーバの仮想スイッチ設定

仮想サーバの起動

仮想サーバの作成

仮想サーバの削除

仮想サーバの情報一覧取得

仮想サーバの状態取得

仮想サーバへのディスク追加

仮想ディスクのアンマウント

仮想ディスクのマウント

(5)　Hyper-V2012 Componentsに含まれる部品一覧

Hyper-V2012 Componentsに含まれる部品一覧を次に示します。

表A‒15　Hyper-V2012 Componentsに含まれる部品一覧

部品名

分類

応答ファイルの作成

Hyper-V 2012関連

仮想サーバのCPU設定変更

仮想サーバのIPアドレス取得

仮想サーバのシャットダウン

仮想サーバのメモリ設定変更

仮想サーバの仮想スイッチ設定

仮想サーバの起動

仮想サーバの作成

仮想サーバの削除

仮想サーバの情報一覧取得

仮想サーバの状態取得

仮想ディスクのアンマウント

仮想ディスクのマウント

仮想ディスクの作成

仮想ディスクの接続

(6)　Hyper-V2016 Componentsに含まれる部品一覧

Hyper-V2016 Componentsに含まれる部品一覧を次に示します。

表A‒16　Hyper-V2016 Componentsに含まれる部品一覧

部品名

分類

応答ファイルの作成

Hyper-V 2016関連

仮想サーバのCPU設定変更

仮想サーバのIPアドレス取得

仮想サーバのシャットダウン

仮想サーバのメモリ設定変更

仮想サーバの仮想スイッチ設定

仮想サーバの起動

仮想サーバの作成

仮想サーバの削除

仮想サーバの情報一覧取得

仮想サーバの状態取得

仮想ディスクのアンマウント

仮想ディスクのマウント

仮想ディスクの作成

仮想ディスクの接続

(7)　OpenStack Componentsに含まれる部品一覧

OpenStack Componentsに含まれる部品一覧を次に示します。

表A‒17　OpenStack Componentsに含まれる部品一覧

部品名

分類

ボリュームのバックアップ

Openstack関連

ボリュームの作成

ボリュームの削除

ボリュームの切断

ボリュームの接続

一時ボリュームの作成

仮想サーバのIPアドレス取得

仮想サーバの起動

仮想サーバの作成

仮想サーバの削除

仮想サーバの情報一覧取得

仮想サーバの状態取得

(8)　Oracle Componentsに含まれる部品一覧

Oracle Componentsに含まれる部品一覧を次に示します。

表A‒18　Oracle Componentsに含まれる部品一覧

部品名

分類

OracleDBインスタンスの起動

Oracle関連

OracleDBインスタンスの停止

OracleDBユーザーの削除

OracleDBユーザーの追加(UNIX)

OracleDBユーザーの追加(Windows)

(9)　vSphere Componentsに含まれる部品一覧

vSphere Componentsに含まれる部品一覧を次に示します。

表A‒19　vSphere Componentsに含まれる部品一覧

部品名

分類

DRSクラスタのDRS自動化レベル設定

vSphere関連

DRSルール(仮想サーバからホストへ)の追加

ESXサーバのメンテナンスモード設定

ESXサーバの移動

ESXサーバの仮想ネットワーク情報一覧取得部品

FCパスの優先設定

HAクラスタの仮想サーバのオプション設定

HAクラスタの仮想サーバの監視設定

LUNの再認識

SCSI LUNのCanonical名を取得

vCenterサーバ経由でのスクリプト実行

vCenterサーバ経由でのファイル削除

vCenterサーバ経由でのファイル送信

vCenterサーバ経由でのフォルダ削除

vCenterサーバ経由でのフォルダ送信

VMware vCenter Server接続確認

データストア作成

データストア作成確認

データストア削除

テンプレートの作成

テンプレートの削除

ネットワークアダプタの設定変更

ネットワークアダプタの追加

ポートグループのトラフィックシェーピングポリシー設定

ホストDRSグループの設定

ログバンドルの取得

仮想サーバDRSグループの設定

仮想サーバのIPアドレス取得

仮想サーバのOS初期設定＆IPアドレス設定(Linux)

仮想サーバのOS初期設定＆IPアドレス設定(Windows)

仮想サーバのクローン作成

仮想サーバのクローン削除

仮想サーバのシャットダウン

仮想サーバのスナップショット移動

仮想サーバのスナップショット作成

仮想サーバのスナップショット削除

仮想サーバのマイグレーション

仮想サーバのリソース構成の設定

仮想サーバのリソース構成変更の事前判定

仮想サーバのリソース設定

仮想サーバのリソース変更の事前判定

仮想サーバの起動

仮想サーバの作成

仮想サーバの削除

仮想サーバの電源状態取得

仮想サーバへの仮想ディスク追加

仮想サーバ作成確認

仮想サーバ情報一覧取得

仮想ディスクの拡張

仮想ディスクの削除

仮想マシンのポートグループ変更

標準仮想スイッチへのポートグループ追加

物理アダプタの情報一覧取得

物理アダプタの設定

付録A.6　各バージョンの変更内容

(1)　12-60の変更内容

次のサービステンプレートおよび部品において，前提製品としてJP1/VERITAS NetBackup 8.2，8.3，9.0，および9.1を追加した。

JP1（構築）用のサービステンプレート

JP1（運用）用のサービステンプレート

JP1/VERITAS関連の部品

次のサービステンプレートの稼働OSとしてWindows Server 2016 Standard/DatacenterおよびWindows Server 2019 Standard/Datacenterを追加した。

JP1（構築）用のサービステンプレート

JP1（運用）用のサービステンプレート

JP1/VERITAS関連の部品

次のサービステンプレートおよび部品において，前提製品としてJP1/Network Node Manager i 12-10，12-50，および12-60を追加した。

JP1/Cm2の監視対象ノード削除

JP1/Cm2の監視対象ノード追加

監視設定削除

監視設定追加

JP1/Cm2の監視対象ノード一覧取得

NNMiトポロジデータベース内容の出力

監視対象ノード削除

監視対象ノード追加

次のサービステンプレートまたは部品において，監視対象ノード追加における注意事項を変更した。

JP1/Cm2の監視対象ノード追加

監視設定追加

監視対象ノード追加

次のサービステンプレートおよび部品において，稼働OSとしてRed Hat Enterprise Linux Server 8 (64-bit x86_64)を追加した。

JP1/VERITASのインスタントリカバリ実行

JP1/VERITASのインスタントリカバリ終了

JP1/VERITASのバックアップ実行

インスタントリカバリ実行(JP1/VERITAS)

インスタントリカバリ終了(JP1/VERITAS)

バックアップ実行(JP1/VERITAS)

JP1/VERITASのインスタントリカバリ終了サービステンプレートにおいて，次の前提製品およびその稼働OSを追加した。

VMware vCenter Server 7.0

VMware vSphere ESXi 7.0

VMware PowerCLI 11.3.0，12.0.0，12.1.0

Windows Server 2016 Standard/Datacenter

Windows Server 2019 Standard/Datacenter

Red Hat Enterprise Linux Server 7 (64-bit x86_64)

Red Hat Enterprise Linux Server 8 (64-bit x86_64)

次のサービステンプレートおよび部品において，前提製品の稼働OSとしてWindows Server 2012 R2 Standard/Datacenterを追加した。

JP1/VERITASのバックアップ実行

バックアップ実行(JP1/VERITAS)

次のサービステンプレートおよび部品において，インスタンスの前提OSとしてRed Hat Enterprise Linux Server 8 (64-bit x86_64)を追加した。

AWS（構築）用のサービステンプレート

AWS（運用）用のサービステンプレート

AWS関連の部品

次のサービステンプレートおよび部品において，インスタンスの前提OSとしてRed Hat Enterprise Linux Server 8 (64-bit x86_64)およびCentOS 8 (64-bit x86_64)を追加した。

vSphere（構築）用のサービステンプレート

vSphere（運用）用のサービステンプレート

vSphere関連の部品

次の部品の実行対象サーバの使用条件において，プロパティキーcommon.osUserPasswordおよびcommon.osUserPasswordReEnterの必須区分を変更した。

OSユーザーの追加(Windows)

OSユーザーの追加(Windows)(SYSTEM)

次の部品の実行対象サーバの使用条件において，プロパティキーWindows.accountCommentおよびWindows.userCommentの説明を変更した。

OSユーザーの追加(Windows)

OSユーザーの追加(Windows)(SYSTEM)

仮想サーバのスナップショット移動サービステンプレートにおいて，次の仮想サーバの前提OSを追加した。

CentOS 6 (64-bit x86_64)

CentOS 7 (64-bit x86_64)

(2)　12-50の変更内容

root権限に昇格して実行されるよう設定されているコンテンツ部品に関する注意事項を変更した。

サービステンプレートのプロパティに指定できる値に関する注意事項を変更した。

スクリプトを設定したコンテンツ部品，またはファイル転送部品を実行する場合の注意事項を追加した。

vSphere関連の部品およびサービステンプレートの実行対象サーバ内前提製品の稼働OSに関する注意事項を追加した。

部品の実行中にタスクを実行停止した場合の注意事項を変更した。

JavaScript実行部品のバージョンを変更した。

次の部品の実行対象サーバの稼働OSに，Windows Server 2016 Standard/DatacenterおよびWindows Server 2019 Standard/Datacenterを追加した。

Active Directory関連の部品

次のサービステンプレートまたは部品において実行権限を変更した。また，エージェントレス接続先設定の認証情報に設定したユーザーがビルトインAdministratorではない場合の注意事項を追加した。

JP1/IM-SSの案件情報更新

JP1/IM-SSの案件登録

ICMPエコー要求メッセージの送信

CSVデータ取得

ICMPエコー要求メッセージの送信 (無応答確認)

DPボリュームの作成

LU作成確認

次の部品にファイルのアクセスに失敗した場合の注意事項を追加した。

CSVデータ取得

次の部品において前提製品となる仮想サーバの前提OSの記載を変更した。

仮想ディスクの拡張

次のサービステンプレートまたは部品において，実行対象システムおよび実行対象サーバの前提製品，ならびにその稼働OSを変更した。

vSphere（構築）用のサービステンプレート

vSphere（運用）用のサービステンプレート

vSphere 関連の部品

(3)　12-10の変更内容

(a)　資料番号（3021-3-D07-21）の変更内容

次のサービステンプレートの実行権限を変更した。

JP1/VERITAS のバックアップポリシー作成

JP1/VERITASのバックアップポリシー作成(SYSTEM)

JP1/AJSのルートジョブネット移行

JP1/AJSのルートジョブネット移行(SYSTEM)

JP1/AJSのルートジョブネット削除

JP1/AJSのルートジョブネット削除(SYSTEM)

Windows更新プログラムのインストール(SYSTEM)

次のサービステンプレートの実行権限を追加した。

運用ユーザー一括変更

運用ユーザー一括変更(SYSTEM)

OSユーザーの一覧一括取得

OSユーザーの一覧一括取得(SYSTEM)

Windows更新プログラムのインストール

汎用コマンド実行部品のプロパティの説明を変更した。

次の部品の実行権限を追加した。

CSV・Excelの行データ取得

CSV・Excelの列データ取得(SYSTEM)

CSV・Excelの列データ取得

CSV・Excelの行データ取得(SYSTEM)

Windows 更新プログラムのインストール(SYSTEM)

次の部品の実行権限を変更した。

Windows更新プログラムのインストール

(b)　資料番号（3021-3-D07-20）の変更内容

次のサービステンプレートまたは部品の前提製品の稼働OSであるAIXのバージョンを変更した。

JP1（構築）用のサービステンプレート

JP1（運用）用のサービステンプレート

JP1（トラブルシューティング）用のサービステンプレート

OS（汎用的な処理）用のサービステンプレート

OS（運用）用のサービステンプレート

JP1/AJS関連の部品

JP1/Base関連の部品

JP1/IM関連の部品

JP1/PFM関連の部品

JP1/VERITAS関連の部品

次のサービステンプレートまたは部品の前提製品であるJP1/Cm2/NNMiのバージョンを変更した。

JP1/Cm2の監視対象ノード削除

JP1/Cm2の監視対象ノード追加

監視設定削除

監視設定追加

JP1/Cm2の監視対象ノード一覧取得

JP1/NNMi関連の部品

次のサービステンプレートまたは部品の前提製品の稼働OSに，Windows Server 2019 Standard/Datacenterを追加した。

JP1/Cm2の監視対象ノード削除

JP1/Cm2の監視対象ノード追加

JP1/Cm2の監視対象ノード一覧取得

JP1/NNMi関連の部品

サーバOSがWindowsの場合，次のサービステンプレートまたは部品の実行にはAdministrator ユーザが必要であることの説明を追加した。

JP1/VERITAS のバックアップポリシー作成

JP1/AJS のルートジョブネット移行

JP1/AJS のルートジョブネット削除

OS ユーザーの一覧一括取得

Windows 更新プログラムのインストール

CSV・Excel の行データ取得

CSV・Excel の列データ取得

次のJP1/AO 同梱版サービステンプレートを追加した。

JP1/VERITASのバックアップポリシー作成(SYSTEM)

JP1/AJSのルートジョブネット移行(SYSTEM)

JP1/AJSのルートジョブネット移行(SYSTEM)(繰り返しフロー)

JP1/AJSのルートジョブネット削除(SYSTEM)

JP1/AJSのルートジョブネット削除(SYSTEM)(繰り返しフロー)

運用ユーザー一括変更(SYSTEM)(繰り返しフロー1)

運用ユーザー一括変更(SYSTEM)(繰り返しフロー2)

OSユーザーの一覧一括取得(SYSTEM)

OSユーザーの一覧一括取得(SYSTEM)（繰り返しフロー）

次のサービステンプレートまたは部品において，ローカル（JP1/AOサーバ）のJP1/AJS3 - Managerを操作できるようにした。

JP1/AJSジョブネット実行登録

JP1/AJSのジョブネット計画確定実行登録

JP1/AJS関連の部品

次のサービステンプレートまたは部品の前提製品に，Microsoft Access Database Engine 2016（32bit版）を追加した。

JP1/AJSのルートジョブネット移行

JP1/AJSのルートジョブネット削除

運用ユーザー一括変更

運用ユーザー一括変更(SYSTEM)

Windows更新プログラムのインストール

CSV・Excelの行データ取得

CSV・Excelの列データ取得

次のサービステンプレートのバージョンを変更した。

運用ユーザー一括変更(SYSTEM)

Utility Components

次のJP1/AO Content Pack 版サービステンプレートを追加した。

Windows更新プログラムのインストール(SYSTEM)

Windows更新プログラムのインストール(SYSTEM)(繰り返しフロー)

次の部品の実行対象サーバの稼働OSであるAIXのバージョンを変更した。

OS関連の部品

UNIX関連の部品

次の部品の注意事項に，Windows環境におけるCSVファイルのフィールドの文字列長上限に関する注意事項を追加した。

CSV・Excelの行データ取得

CSV・Excelの列データ取得

CSVデータ取得

次のJP1/AO 同梱版コンテンツ部品を追加した。

CSV・Excelの行データ取得(SYSTEM)

CSV・Excelの列データ取得(SYSTEM)

次の部品の前提製品に，仮想サーバの前提OSに関する説明を追加した。

仮想ディスクの拡張

次のJP1/AO Content Pack 版コンテンツ部品を追加した。

Windows更新プログラムのインストール(SYSTEM)

(4)　12-01の変更内容

次のサービステンプレートおよび部品のバージョンを変更した。

JP1/Base監視設定追加

JP1/Base監視設定追加(繰り返しフロー)

JP1/PFMアラーム定義の複製

Utility Components

仮想サーバスペック変更(CPU，メモリ)

部品提供用のサービステンプレート

ファイルのコピー

文字列の置換

仮想サーバのリソース設定

仮想サーバのリソース変更の事前判定

次のサービステンプレートおよび部品のシステム内前提製品のJP1/AOのバージョンを変更した。

Utility Components

部品提供用のサービステンプレート

仮想サーバのリソース設定

仮想サーバのリソース変更の事前判定

次の部品でサービスプロパティのパラメーターを変更する場合，繰り返し実行部品のプロパティに特定の値を指定しているときの注意事項を追加した。

ユーザー応答待ち部品

次の部品に，隠しファイルをコピーできない旨の注意事項を追加した。

ファイルのコピー

次のサービステンプレートのプロパティ「common.replaceTarget」および「common.replaceStr」に，スペースを1文字以上指定する場合の説明を追加した。

文字列の置換

(5)　12-00の変更内容

階層フロー部品の変更により，階層フロー部品を含む各サービステンプレートのバージョンを「03.00.00」に変更した。

各サービステンプレートのシステム内前提製品のJP1/AOのバージョンを変更した。

次のサービステンプレートまたは部品の前提製品に，JP1/VERITAS NetBackup 7.7，8.0，および8.1を追加した。

JP1/VERITASのバックアップポリシー作成

JP1/VERITASのインスタントリカバリ実行

JP1/VERITASのインスタントリカバリ終了

JP1/VERITASのバックアップ実行

JP1/VERITASの仮想マシンリストア実行

JP1/VERITAS関連の部品

次のサービステンプレートまたは部品の前提製品に，VMware vSphere ESXi 6.7およびVMware PowerCLI 10.1.1を追加した。

JP1/VERITASのインスタントリカバリ終了

vSphere（構築）用のサービステンプレート

vSphere（運用）用のサービステンプレート

vSphere関連の部品

階層フロー部品の戻り値「1」「2」およびプロパティ「errorStep」「returnValueOfErrorStep」を追加した。また，階層フロー部品のバージョンを「01.11.00」に変更した。

JavaScript 実行部品にプロパティ「importedScript」を追加し，バージョンを「01.00.02」に変更した。

Webクライアント部品のHTTPSでサポートしているTLSのバージョンを追加した。

基本部品にPython実行部品を追加した。

(6)　11-51の変更内容

操作対象の機器のOSがUNIXの場合に必要な設定として，スーパーユーザーのパスワードに関する説明を変更した。

次のJP1/AO 同梱版サービステンプレートを追加した。

運用ユーザー一括変更(SYSTEM)

運用ユーザー削除(SYSTEM)

運用ユーザー追加(SYSTEM)

運用ユーザー変更(SYSTEM)

次のサービステンプレートまたは部品の前提製品に，「Microsoft Access データベース エンジン 2010（32bit版）」を追加した。

JP1/AJS のルートジョブネット移行

JP1/AJS のルートジョブネット削除

運用ユーザー一括変更

運用ユーザー一括変更(SYSTEM)

Windows 更新プログラムのインストール

CSV・Excel の行データ取得

CSV・Excel の列データ取得

サーバOSがWindowsの場合，次のサービステンプレートまたは部品の実行にはAdministrator ユーザが必要であることの説明を追加した。

運用ユーザー一括変更

運用ユーザー削除

運用ユーザー追加

運用ユーザー変更

JP1/Base のパスワード管理情報変更

JP1/Base のユーザーマッピング追加

JP1/Base ユーザーマッピング削除

JP1/Base 操作権限設定

JP1 ユーザーパスワード変更

JP1 ユーザー削除

JP1 ユーザー操作権限削除

JP1 ユーザー追加

OS ユーザー情報の削除

OS ユーザーのパスワード変更

OS ユーザーの削除

ファイル削除

OS ユーザーのグループ設定(Windows)

OS ユーザーの追加(Windows)

コンテンツ部品の追加または変更により，次のサービステンプレートおよび部品のバージョンを「02.51.00」に変更した。

Utility Components

CSV・Excel のセルデータ更新

CSV・Excel のセルデータ取得

CSV・Excel のデータ分割

Web クライアント部品で次のプロパティキーに指定できる文字数を変更した。

webUsername

proxyHostname

proxyUsername

次のJP1/AO 同梱版コンテンツ部品を追加した。

JP1/Base のパスワード管理情報変更(SYSTEM)

JP1/Base のユーザーマッピング追加(SYSTEM)

JP1/Base ユーザーマッピング削除(SYSTEM)

JP1/Base 操作権限設定(SYSTEM)

JP1 ユーザーパスワード変更(SYSTEM)

JP1 ユーザー削除(SYSTEM)

JP1/ユーザー操作権限削除(SYSTEM)

JP1 ユーザー追加(SYSTEM)

OS ユーザー情報の削除(SYSTEM)

OS ユーザーのパスワード変更(SYSTEM)

OS ユーザーの削除(SYSTEM)

ファイル削除(SYSTEM)

OS ユーザーのグループ設定 (Windows)(SYSTEM)

OS ユーザーの追加 (Windows)(SYSTEM)

次の部品のサポートOSにRed Hat Enterprise Linux ServerおよびCent OSを追加した。これに伴い，UNIX 環境で使用する場合の説明を追加した。

CSV・Excel のセルデータ更新

CSV・Excel のセルデータ取得

CSV・Excel のデータ分割

CSV・Excel のセルデータ取得部品に，戻り値「11」を追加した。

次の部品の前提製品であるJP1/AOのバージョンを「11-10」に変更した。

CSV・Excel のセルデータ取得

CSV・Excel のデータ分割

CSV・Excel のデータ分割部品をWindows環境で利用する場合の注意事項を追加した。

(7)　11-50の変更内容

各サービステンプレートのシステム内前提製品のJP1/AOのバージョンを変更した。

コンテンツ部品の追加または変更により，各サービステンプレートおよび部品のバージョンを「02.50.00」に変更した。

次のサービステンプレートを，Cent OS環境で使用する場合の機能説明および前提条件を追加した。

運用ユーザー一括変更

運用ユーザー変更

前提製品の条件およびサポートOSを追加した。

次のサービステンプレートの実行対象となるストレージシステムに，Hitachi Virtual Storage Platform G1500/F1500，Hitachi Virtual Storage Platform G100/G200/G400/G600/G800，およびHitachi Virtual Storage Platform F400/F600/F800を追加した。

仮想サーバ削除(データストア削除/LU削除)

仮想サーバ追加(LU作成/データストア作成)

ストレージ情報一覧取得

仮想サーバ追加(LU作成/データストア作成)環境確認

「基本部品共通の注意事項」を追加した。

コマンド実行時の注意事項を追加した。

繰り返し実行部品をリトライしたときのステップの状態の説明を変更した。

次の部品の実行中にタスクを実行停止した場合の注意事項を追加した。

ユーザー応答待ち部品

実行間隔制御部品

次の部品に戻り値「80」を追加した。

ターミナル切断部品

異常終了部品

実行間隔制御部品の戻り値「80」の説明を変更した。

次の部品の実行中にタスクを実行停止，または強制停止した場合の注意事項を追加した。

JavaScript 実行部品

ファイルエクスポート部品

Web クライアント部品

次の部品をUNIX環境で使用する場合の説明を変更した。

JP1ユーザーパスワード変更

JP1ユーザー追加

OSユーザーのパスワード変更

次のJP1/AO同梱版コンテンツ部品を追加した。

CSV・Excelのセルデータ更新

次の部品で64ビット版のMicrosoft Excelを使用する場合の説明を追加した。

CSV・Excelのセルデータ取得

CSV・Excelのデータ分割

CSV・Excelの行データ取得部品で，キーとなる列を列番号で指定する場合の説明を追加した。

IPアドレスの設定部品の機能説明を変更した。

次の部品の実行対象となるストレージシステムに，Hitachi Virtual Storage Platform G1500/F1500，Hitachi Virtual Storage Platform G100/G200/G400/G600/G800，およびHitachi Virtual Storage Platform F400/F600/F800を追加した。

DPボリュームの作成

DPボリュームの削除

HDvM接続確認

LU作成確認

ストレージ情報一覧取得

ホストグループからLUを削除

ホストグループにLUを登録

vCenterサーバ経由でのスクリプト実行部品の注意事項を追加した。

複数バージョンを使用できるコンテンツ部品がなくなったため、「コンテンツ部品のバージョン間の機能差異」を削除した。

(8)　11-12の変更内容

Microsoft Hyper-V Server 2016をサポートした。これに伴い，次の部品提供用のサービステンプレートを追加した。

Hyper-V2016 Components

実行対象サーバで稼働するPowerCLIのバージョンがV6.3以降の場合の注意事項を記載した。

コンテンツ部品の追加または変更により，次の部品提供用のサービステンプレートのバージョンを上げた。

Utility Components

vSphere Components

次のサービステンプレートについて，仮想サーバのCPUソケット当たりのコア数を設定できるようにした。

仮想サーバスペック変更(CPU，メモリ)

次のJP1/AO同梱版コンテンツ部品を追加した。

CSV・Excelのセルデータ取得

次の部品の実行対象のOS種別にHP-UX，Solarisを追加した。

OS種別の出力

(9)　11-11の変更内容

次のサービステンプレートおよび部品について，動作の安定性を改善した。

JP1/VERITASのバックアップポリシー作成

JP1/VERITASの仮想マシンリストア実行

バックアップポリシーへのファイルリスト追加

名前変更ファイルの作成

CSV・Excelのデータ分割部品

コンテンツ部品の追加または変更により，次の部品提供用のサービステンプレートのバージョンを上げた。

Utility Components

vSphere Components

次のJP1/AO Content Pack 版サービステンプレートについて，前提製品を追加した。

仮想サーバ追加（LU作成/データストア作成）

仮想サーバ追加（デプロイ/OS初期設定）

仮想サーバ追加（仮想ディスク）

仮想サーバ削除

仮想サーバ削除（仮想ディスク）

仮想サーバ削除（データストア削除/LU削除）

仮想サーバスペック変更（CPU，メモリ）

仮想サーバのスナップショット

仮想サーバ起動

仮想サーバ停止

仮想サーバ再起動

仮想サーバマイグレーション

仮想サーバ追加（LU作成/データストア作成）環境確認

仮想サーバ追加（デプロイ/OS初期設定）環境確認

仮想サーバ情報一覧取得

仮想サーバのクローン作成

仮想サーバのクローン削除

次のJP1/AO Content Pack 版コンテンツ部品について，前提製品を追加した。

データストア作成確認

仮想サーバ作成確認

VMware vCenter Server接続確認

仮想サーバ情報一覧取得

仮想サーバのスナップショット作成

仮想サーバのスナップショット移動

仮想サーバのスナップショット削除

仮想サーバのクローン作成

仮想サーバのクローン削除

仮想サーバのリソース構成の設定

仮想サーバのリソース変更の事前判定

仮想サーバのリソース構成変更の事前判定

物理アダプタの設定

物理アダプタの情報一覧取得

HAクラスタの仮想サーバのオプション設定

ホストDRSグループの設定

ESXサーバの移動

ESXサーバのメンテナンスモード設定

仮想ディスクの拡張

ネットワークアダプタの追加

ネットワークアダプタの設定変更

標準仮想スイッチへのポートグループ追加

ポートグループのトラフィックシェーピングポリシー設定

テンプレートの作成

テンプレートの削除

仮想サーバDRSグループの設定

DRSルール（仮想サーバからホストへ）の追加

HAクラスタの仮想サーバの監視設定

DRSクラスタのDRS自動化レベル設定

vCenterサーバ経由でのファイル送信

vCenterサーバ経由でのフォルダ送信

vCenterサーバ経由でのスクリプト実行

vCenterサーバ経由でのファイル削除

vCenterサーバ経由でのフォルダ削除

ESXサーバの仮想ネットワーク情報一覧取得部品

次のJP1/AO Content Pack版コンテンツ部品を追加した。

ログバンドルの取得

(10)　11-10の変更内容

部品実行中にタスクが強制停止された場合の戻り値が-1から80に変更されたため，各部品の戻り値の説明を変更した。

次のJP1/AO同梱版部品に，プロパティ「outputCondition」を追加して，コマンドまたはスクリプトの標準出力および標準エラー出力がプロパティ「stdoutPattern1〜3」と合致しない場合に，プロパティ「stdoutProperty1〜3」に値を出力するかどうかを指定できるようになった。

汎用コマンド実行部品

ターミナル接続部品

ターミナルコマンド実行部品

繰り返し実行部品は，最大で3段までの入れ子定義ができるようになったため，説明および注意事項を追加した。

サービス内の繰り返し部品配下のフロー数の合計が，上限を超えた場合に返却される戻り値「3」を追加した。

ユーザー応答待ち部品のプロパティ「dialogText」に指定できるHTMLタグが追加されたため，説明を追加した。

応答入力ダイアログでマッピングパラメーターに設定した値が，プロパティの入力規則に違反した場合に返却される戻り値「86」を追加した。

Webクライアント部品に，Webサービス接続先定義を参照するためのプロパティを追加した。

(11)　11-02の変更内容

次のJP1/AO同梱版部品を，JP1/AJS用の部品として追加した。

JP1/AJSの起動(UNIX)

JP1/AJSの停止(UNIX)

JP1/AJSの状態取得

次のJP1/AO同梱版部品を，JP1/Base用の部品として追加した。

JP1/Baseの起動(UNIX)

JP1/Baseの停止(UNIX)

JP1/Baseの状態取得

JP1/Baseイベントサービスの起動(UNIX)

JP1/Baseイベントサービスの停止(UNIX)

JP1/Baseイベントサービスの状態取得

次のJP1/AOコンテンツセット版部品を，vSphere用の部品として追加した。

ESXサーバの仮想ネットワーク情報一覧取得部品

Utility Componentsに次の部品を追加した。

JP1/AJSの起動(UNIX)

JP1/AJSの停止(UNIX)

JP1/AJSの状態取得

JP1/Baseの起動(UNIX)

JP1/Baseの停止(UNIX)

JP1/Baseの状態取得

JP1/Baseイベントサービスの起動(UNIX)

JP1/Baseイベントサービスの停止(UNIX)

JP1/Baseイベントサービスの状態取得

vSphere Componentsに次の部品を追加した。

ESXサーバの仮想ネットワーク情報一覧取得部品

(12)　11-01の変更内容

次のJP1/AO同梱版部品を，JP1用の部品として追加した。

JP1サイレントインストール(Windows)

JP1サイレントインストール(UNIX)

JP1修正パッチ適用(Windows)

JP1修正パッチ適用(UNIX)

次のJP1/AO同梱版部品を，TELstaff用の部品として追加した。

TELstaffによる通知

次のJP1/AO同梱版サービステンプレートを追加した。

JP1/VERITASのバックアップポリシー作成

JP1/VERITASの仮想マシンリストア実行

次のJP1/AO同梱版部品を追加した。

バックアップポリシーの作成

バックアップポリシー(VMware)の初期化

バックアップポリシー(VMware)の属性変更

バックアップポリシーへのクライアント追加

バックアップポリシーへのファイルリスト追加

バックアップポリシーへのスケジュール追加

バックアップポリシーへのスケジュール属性変更

仮想マシンリストア実行

名前変更ファイルの作成

イベントログへのイベント作成

イベントログのイベント一覧取得

次のJP1/AOコンテンツセット版部品を追加した。

AMIの作成

仮想サーバのインスタンスタイプ設定

仮想サーバの情報一覧取得

スタックの作成

スタックの削除

スタックの情報一覧取得

汎用コマンド実行部品にプロパティ「runAsSystem」を追加し，Windowsの操作対象の機器でコマンドをSystemアカウントの権限で実行できるようにした。

AWS Componentsに次の部品を追加した。

AMIの作成

仮想サーバのインスタンスタイプ設定

仮想サーバの情報一覧取得

スタックの作成

スタックの削除

スタックの情報一覧取得

Utility Componentsに次の部品を追加した。

JP1サイレントインストール(Windows)

JP1サイレントインストール(UNIX)

JP1修正パッチ適用(Windows)

JP1修正パッチ適用(UNIX)

バックアップポリシーの作成

バックアップポリシー(VMware)の初期化

バックアップポリシー(VMware)の属性変更

バックアップポリシーへのスケジュール追加

バックアップポリシーへのスケジュール属性変更

バックアップポリシーへのクライアント追加

バックアップポリシーへのファイルリスト追加

名前変更ファイルの作成

仮想マシンリストア実行

TELstaffによる通知

イベントログへのイベント作成

イベントログのイベント一覧取得

(13)　11-00の変更内容

(a)　資料番号（3021-3-085-B0）からの変更内容

適用OSに次のOSを追加した。

Linux7

Oracle Linux 6 (x64)

Oracle Linux 7

CentOS 6 (x64)

CentOS 7

SUSE Linux 12

適用OSから次のOSを削除した

Linux 5 (AMD/Intel 64)

Linux 5 Advanced Platform (AMD/Intel 64)

Windows版JP1/AOおよび共通コンポーネントのインストール先フォルダを変更した。

英語環境または中国語環境でJP1/AOを運用する場合についての説明を追加した。

JP1/AOの操作画面の刷新に伴い，操作画面に合わせてマニュアルの構成や記載内容を変更した。

サービステンプレート，サービス，および部品の分類方法として「タグの管理」を追加した。これに伴い，「カテゴリの管理」を削除した。

リソースの管理として「サービスグループ」を追加した。これに伴い，「リソースグループ」を削除した。

サービステンプレートと部品の種類を変更した。

次の基本部品を追加した。

JavaScript実行部品

ファイルエクスポート部品

Webクライアント部品

次のJP1/AO同梱版サービステンプレートを，OS（構築）用のサービステンプレートとして追加した。

Chef Clientの登録

Puppet Enterprise Agentの登録

Utility Componentsに次の部品を追加した。

プロセスの情報取得

テキストファイルの文字列抽出

ファイルまたはフォルダのアクセス権限取得

OSサービスのアカウント変更

OSサービスのスタートアップ設定

Active DirectoryへのOU追加

Active DirectoryのOU属性変更

Active Directory連絡先追加

Active Directory連絡先属性変更

Active Directoryグループ属性変更

Active Directoryユーザーのパスワード変更

Active Directoryオブジェクト検索

Active Directoryオブジェクト移動

Active Directoryグループメンバー一覧取得

Active DirectoryのUPN一覧取得

AWS Componentsに次の部品を追加した。

スナップショットの作成

スナップショットの削除

スナップショットの情報一覧取得

ファイルのアップロード

ファイルのダウンロード

ファイルの削除

(b)　資料番号（3021-3-316-20）からの変更内容

一部のサービステンプレートおよび部品の適用OSにAIXを追加した。

操作対象の機器のOSがUNIXの場合でも，操作対象の機器からJP1/AOサーバにファイルを転送すると，ファイルはbinary形式で転送されることを明記した。

次のJP1/AO同梱版サービステンプレートを追加した。

JP1/VERITASのインスタントリカバリ実行

JP1/VERITASのインスタントリカバリ終了

JP1/VERITASのバックアップ実行

Utility Components

Chef Clientの登録

Puppet Enterprise Agentの登録

次のJP1/AO Content Pack版サービステンプレートを追加した。

仮想サーバの削除

仮想サーバの削除(仮想ディスク)

仮想サーバの情報一覧取得

vCenterサーバ経由でのスクリプト実行

仮想サーバの追加(デプロイ)

仮想サーバの起動

仮想サーバの停止

AWS Components

HCS Components

Hyper-V2008 Components

Hyper-V2012 Components

OpenStack Components

Oracle Components

vSphere Components

次のJP1/AO同梱版部品を追加した。

日時取得

ファイルまたはフォルダの存在確認

ファイルまたはディレクトリのアクセス権限変更

時刻判定

ファイルまたはフォルダのアクセス権限変更

ICMPエコー要求メッセージの送信

実行待機

ファイル一覧の取得

ファイル移動

ファイルの最終更新日時取得

ファイルのサイズ取得

文字列のソート処理

ファイルの文字エンコード変換

ファイルの解凍

ファイルの圧縮

日時比較

文字列の追加

ICMPエコー要求メッセージの送信 (無応答確認)

ファイルの印刷(Windows)

インスタントリカバリ実行(JP1/VERITAS)

インスタントリカバリ終了(JP1/VERITAS)

IPアドレスの設定

JP1/AJSユニット存在確認

JP1/AJSジョブネット中断

JP1/AJSジョブネット強制終了

JP1/AJSジョブネット再実行

JP1/AJSジョブ状態変更

JP1/AJSジョブネット保留属性変更

JP1/AJSジョブネット実行中止

JP1/AJSジョブネット実行スケジュール変更

バックアップ実行(JP1/VERITAS)

Active Directoryグループ追加

Active Directoryオブジェクト削除

Active Directoryユーザー追加

Active Directoryユーザー属性変更

Active Directory既存グループへのメンバー追加

Active Directory既存グループからのメンバー削除

Active DirectoryへのOU追加

Active DirectoryのOU属性変更

Active Directory連絡先追加

Active Directory連絡先属性変更

Active Directoryグループ属性変更

Active Directoryユーザーのパスワード変更

Active Directoryオブジェクト検索

Active Directoryオブジェクト移動

Active Directoryグループメンバー一覧取得

Active DirectoryのUPN一覧取得

次のJP1/AO Content Pack版部品を追加した。

物理アダプタの設定

物理アダプタの情報一覧取得

HAクラスタの仮想サーバのオプション設定

ホストDRSグループの設定

ESXサーバの移動

ESXサーバのメンテナンスモード設定

仮想ディスクの拡張

ネットワークアダプタの追加

ネットワークアダプタの設定変更

標準仮想スイッチへのポートグループ追加

ポートグループのトラフィックシェーピングポリシー設定

テンプレートの作成

テンプレートの削除

仮想サーバDRSグループの設定

DRSルール(仮想サーバからホストへ)の追加

HAクラスタの仮想サーバの監視設定

DRSクラスタのDRS自動化レベル設定

vCenterサーバ経由でのファイル送信

vCenterサーバ経由でのフォルダ送信

vCenterサーバ経由でのスクリプト実行

vCenterサーバ経由でのファイル削除

vCenterサーバ経由でのフォルダ削除

仮想サーバの作成

仮想サーバの削除

仮想サーバの起動

仮想サーバのシャットダウン

仮想サーバの状態取得

スナップショットの作成

スナップショットの削除

スナップショットの情報一覧取得

ファイルのアップロード

ファイルのダウンロード

ファイルの削除

OracleDBインスタンスの起動

OracleDBインスタンスの停止

OracleDBユーザーの追加(Windows)

OracleDBユーザーの追加(UNIX)

OracleDBユーザーの削除

ボリュームの切断

仮想サーバの削除

仮想サーバの情報一覧取得

適用OSにLinuxを追加した。

サービステンプレートおよび部品のプロパティに，改行は指定できないことを追加した。

操作対象の機器とJP1/AOサーバとの間でファイルを転送するサービステンプレートでは， 転送時にエンコードを変換しないことを追加した。

操作対象の機器とのSSH接続で使用できる認証方式に，キーボードインタラクティブ認証を追加した。

操作対象ホストがローカルホストの場合，ローカルホストのプロセスを直接起動してコマンドを実行したり，ファイルをコピーしたりできる，ローカル実行機能の説明を追加した。

部品提供用のサービステンプレートに含まれる部品一覧を追加した。

汎用コマンド実行部品の戻り値72は，標準出力および標準エラー出力の合計が100KBを超えたときに出力されることを追記した。

Windows版JP1/AOおよび共通コンポーネントのインストール先フォルダを変更した。

JP1/AOの操作画面の刷新に伴い，操作画面に合わせてマニュアルの構成や記載内容を変更した。

サービステンプレート，サービス，および部品の分類方法として「タグの管理」を追加した。これに伴い，「カテゴリの管理」を削除した。

リソースの管理として「サービスグループ」を追加した。これに伴い，「リソースグループ」を削除した。

サービステンプレートと部品の種類を変更した。

次の基本部品を追加した。

JavaScript実行部品

ファイルエクスポート部品

Webクライアント部品

(14)　10-54の変更内容

(a)　資料番号（3021-3-085-B0）の変更内容

JP1/AOコンテンツセット版サービステンプレートに次のカテゴリを追加した。

AWS_Components

VM_Operations/Configuration/AWS

VM_Operations/Management/AWS

JP1/AO同梱版部品に次のカテゴリを追加した。

OperatingSystem/Windows/ActiveDirectory

JP1/AOコンテンツセット版部品に次のカテゴリを追加した。

VirtualMachine/AWS

次のJP1/AOコンテンツセット版サービステンプレートを追加した。

vCenterサーバ経由でのスクリプト実行

次のJP1/AO同梱版部品を追加した。

JP1/AJSユニット存在確認

JP1/AJSジョブネット中断

JP1/AJSジョブネット強制終了

JP1/AJSジョブネット再実行

JP1/AJSジョブ状態変更

JP1/AJSジョブネット保留属性変更

JP1/AJSジョブネット実行中止

JP1/AJSジョブネット実行スケジュール変更

次のJP1/AOコンテンツセット版部品を追加した。

HAクラスタの仮想サーバの監視設定

DRSクラスタのDRS自動化レベル設定

vCenterサーバ経由でのファイル送信

vCenterサーバ経由でのフォルダ送信

vCenterサーバ経由でのスクリプト実行

vCenterサーバ経由でのファイル削除

vCenterサーバ経由でのフォルダ削除

コンテンツ部品のバージョン間の機能差異を追記した。

AWS Componentsに含まれる部品一覧を追加した。

Utility Componentsに次の部品を追加した。

JP1/AJSユニット存在確認

JP1/AJSジョブネット中断

JP1/AJSジョブネット強制終了

JP1/AJSジョブネット再実行

JP1/AJSジョブ状態変更

JP1/AJSジョブネット保留属性変更

JP1/AJSジョブネット実行中止

JP1/AJSジョブネット実行スケジュール変更

Active Directoryグループ追加

Active Directoryオブジェクト削除

Active Directoryユーザー追加

Active Directoryユーザー属性変更

Active Directory既存グループへのメンバー追加

Active Directory既存グループからのメンバー削除

vSphere Componentsに次の部品を追加した。

HAクラスタの仮想サーバの監視設定

DRSクラスタのDRS自動化レベル設定

vCenterサーバ経由でのファイル送信

vCenterサーバ経由でのフォルダ送信

vCenterサーバ経由でのスクリプト実行

vCenterサーバ経由でのファイル削除

vCenterサーバ経由でのフォルダ削除

(15)　10-53の変更内容

(a)　資料番号（3021-3-085-A0）の変更内容

次のJP1/AO同梱版サービステンプレートを追加した。

JP1/VERITASのインスタントリカバリ実行

JP1/VERITASのインスタントリカバリ終了

汎用コマンド実行部品の戻り値72は，標準出力および標準エラー出力の合計が100KBを超えたときに出力されることを追記した。

次のJP1/AO同梱版部品を追加した。

インスタントリカバリ実行(JP1/VERITAS)

インスタントリカバリ終了(JP1/VERITAS)

IPアドレスの設定

次のJP1/AOコンテンツセット版部品を追加した。

物理アダプタの設定

物理アダプタの情報一覧取得

HAクラスタの仮想サーバのオプション設定

ホストDRSグループの設定

ESXサーバの移動

ESXサーバのメンテナンスモード設定

仮想ディスクの拡張

ネットワークアダプタの追加

ネットワークアダプタの設定変更

標準仮想スイッチへのポートグループ追加

ポートグループのトラフィックシェーピングポリシー設定

テンプレートの作成

テンプレートの削除

仮想サーバDRSグループの設定

DRSルール(仮想サーバからホストへ)の追加

コンテンツ部品のバージョン間の機能差異を追記した。

Utility Componentsに次の部品を追加した。

インスタントリカバリ実行(JP1/VERITAS)

インスタントリカバリ終了(JP1/VERITAS)

IPアドレスの設定

Hyper-V2012 Componentsに部品「仮想サーバのメモリ設定変更」を追加した。

vSphere Componentsに次の部品を追加した。

物理アダプタの設定

物理アダプタの情報一覧取得

HAクラスタの仮想サーバのオプション設定

ホストDRSグループの設定

ESXサーバの移動

ESXサーバのメンテナンスモード設定

仮想ディスクの拡張

ネットワークアダプタの追加

ネットワークアダプタの設定変更

標準仮想スイッチへのポートグループ追加

ポートグループのトラフィックシェーピングポリシー設定

テンプレートの作成

テンプレートの削除

仮想サーバDRSグループの設定

DRSルール(仮想サーバからホストへ)の追加

(16)　10-52の変更内容

(a)　資料番号（3021-3-085-90）の変更内容

適用OSにLinuxを追加した。

サービステンプレート「Utility Components」の説明を変更した。

JP1/AOコンテンツセット版サービステンプレートに次のカテゴリを追加した。

HCS_Components

Hyper-V2008_Components

Hyper-V2012_Components

OpenStack_Components

Oracle_Components

vSphere_Components

JP1/AOコンテンツセット版部品に次のカテゴリを追加した。

Database/Oracle

次の部品は，root権限に昇格しないことを追加した。

OracleDBインスタンスの起動

OracleDBインスタンスの停止

OracleDBユーザーの追加(UNIX)

OracleDBユーザーの削除

サービステンプレートおよび部品のプロパティに，改行は指定できないことを追加した。

操作対象の機器とJP1/AOサーバとの間でファイルを転送するサービステンプレートでは， 転送時にエンコードを変換しないことを追加した。

操作対象の機器とのSSH接続で使用できる認証方式に，キーボードインタラクティブ認証を追加した。

操作対象ホストがローカルホストの場合，ローカルホストのプロセスを直接起動してコマンドを実行したり，ファイルをコピーしたりできる，ローカル実行機能の説明を追加した。

次のJP1/AO 同梱版部品を追加した。

ICMPエコー要求メッセージの送信

実行待機

ファイル一覧の取得

ファイル移動

ファイルの最終更新日時取得

ファイルのサイズ取得

文字列のソート処理

ファイルの文字エンコード変換

ファイルの解凍

ファイルの圧縮

日時比較

文字列の追加

ICMPエコー要求メッセージの送信 (無応答確認)

ファイルの印刷(Windows)

次の部品のカテゴリを，「OperatingSystem/Windows/Basic」から，「OperatingSystem/Common/Basic」に変更した。

CSV・Excelの列データ取得

CSV・Excelの行データ取得

次の部品は，JP1/AOコンテンツセット版部品から，JP1/AO同梱版部品に変更した。

ICMPエコー要求メッセージの送信

実行待機

ICMPエコー要求メッセージの送信 (無応答確認)

コンテンツ部品のバージョン間の機能差異を追加した。

部品提供用のサービステンプレートに含まれる部品一覧を追加した。

(17)　10-51の変更内容

(a)　資料番号（3021-3-085-80）の変更内容

JP1_Operations/Configurationカテゴリのサービステンプレートの適用OSにAIXを追加した。

監視設定追加

監視設定削除

JP1/Base監視設定追加

JP1/PFMアラーム定義の複製

JP1_Operations/Managementカテゴリのサービステンプレートの適用OSにAIXを追加した。

運用ユーザー追加

運用ユーザー変更

運用ユーザー削除

JP1/AJSジョブネット実行登録

JP1イベント取得

JP1/PFMのアラーム情報一覧取得

JP1ユーザーの一覧取得

JP1ユーザーマッピング定義取得

JP1/VERITASのバックアップ実行

JP1/AJSのジョブネット計画確定実行登録

JP1/AJSのジョブネット実行予実績出力

運用ユーザー一括変更

JP1/AJSのルートジョブネット移行

JP1/AJSのルートジョブネット削除

JP1_Operations/Troubleshootカテゴリのサービステンプレートの適用OSにAIXを追加した。

JP1/AJS・JP1/Baseログ取得

JP1/IM・JP1/Baseログ取得

JP1イベントの登録

JP1イベントの対処状況変更

OS_Operations/Managementカテゴリのサービステンプレートの適用OSにAIXを追加した。

OSユーザーの一覧取得

OSユーザーの一覧一括取得

OperatingSystem/Common/Basicカテゴリの部品の適用OSにAIXを追加した。

OSユーザーの削除

OSユーザーのパスワード変更

フォルダ作成

フォルダ削除

ファイル削除

ファイルのコピー

OS種別の出力

OSユーザーの一覧取得

文字列の置換

OperatingSystem/Linux/Basicカテゴリの部品の適用OSにAIXを追加した。

OSユーザーの追加 (Linux)

JP1/Baseカテゴリカテゴリの部品の適用OSにAIXを追加した。

JP1ユーザー追加

JP1/Base操作権限設定

JP1ユーザー操作権限削除

JP1ユーザー削除

JP1/Baseのユーザーマッピング追加

JP1/Baseユーザーマッピング削除

JP1ユーザーパスワード変更

JP1/Baseのトラブルシュート情報取得

JP1 ユーザー一覧取得

マッピング情報の確認

JP1イベントの登録

JP1/Base共通定義情報設定

JP1/AJSカテゴリの部品の適用OSにAIXを追加した。

JP1/AJSのトラブルシュート情報取得

JP1/AJSジョブネット実行登録

JP1/AJSのジョブネット実行結果取得

JP1/AJSジョブネット計画実行登録

JP1/AJSジョブネット確定実行登録

JP1/AJSジョブネット実行予実績出力

JP1/IMカテゴリの部品の適用OSにAIXを追加した。

JP1/IMトラブルシュート情報の収集

JP1イベント取得

JP1イベントの対処状況変更

JP1/PFMカテゴリの部品の適用OSにAIXを追加した。

監視設定追加(JP1/PFM - RM)

アラームのバインド(JP1/PFM - RM)

アラームのアンバインド(JP1/PFM - RM)

プロセス監視設定追加

Storeデータベース保存条件設定

エージェント階層設定

サービス情報同期

アラームテーブル名一覧取得(JP1/PFM - RM)

アラームテーブルの情報取得(JP1/PFM)

アラームテーブルの削除(JP1/PFM)

アラームテーブルのコピー(JP1/PFM)

アラーム定義ファイルのエクスポート(JP1/PFM)

アラーム定義ファイルのインポート(JP1/PFM)

JP1/VERITASカテゴリの部品の適用OSにAIXを追加した。

バックアップ実行(JP1/VERITAS)

JP1/AO同梱版サービステンプレートの次のカテゴリの説明をUNIX対応に変更した。

OS_Operations/Management

JP1/AO同梱版部品の次のカテゴリの説明をUNIX対応に変更した。

OperatingSystem/Common/Basic

JP1/AO同梱版部品の次のカテゴリ名称を変更した。また，説明をUNIX対応に変更した。

変更前

OperatingSystem/Linux/Basic

変更後

OperatingSystem/UNIX/Basic

操作対象の機器のOSがUNIXの場合でも，操作対象の機器からJP1/AOサーバにファイルを転送すると，ファイルはbinary形式で転送されることを明記した。

次のJP1/AOコンテンツセット版サービステンプレートを追加した。

仮想サーバの削除

仮想サーバの削除(仮想ディスク)

仮想サーバの情報一覧取得

次のJP1/AO同梱版部品を追加した。

日時取得

ファイルまたはフォルダの存在確認

ファイルまたはディレクトリのアクセス権限変更

時刻判定

ファイルまたはフォルダのアクセス権限変更

次のJP1/AOコンテンツセット版部品を追加した。

ボリュームの切断

仮想サーバの削除

仮想サーバの情報一覧取得

コンテンツ部品のバージョン間の機能差異を追記した。

(18)　10-50の変更内容

(a)　資料番号（3021-3-085-70）の変更内容

2014年9月以降，マニュアル名称および資料番号を次のとおり変更した。

変更前

JP1/AO 画面・コマンドリファレンス（3021-3-084）

変更後

JP1/AO 画面・コマンド・APIリファレンス（3021-3-088）

JP1/AO同梱版サービステンプレートに次のカテゴリを追加した。

Utility_Components

JP1/AO同梱版部品に次のカテゴリを追加した。

OperatingSystem/Windows/Database/32bit

「LANG=C」のロケールで実行されるサービスに，「JP1/AJSのルートジョブネット移行」および「JP1/Cm2の監視対象ノード一覧取得」を追加した。また，マルチバイト文字を使用すると，文字化けが発生することを明記した。

サービステンプレートのプロパティに指定できる値についての注意事項を追加した。

プロパティの入力値や入力ファイルに外字およびサロゲートペア文字を指定した場合の注意事項を追加した。

次のJP1/AOコンテンツセット版サービステンプレートを追加した。

仮想サーバの削除

仮想サーバの追加(仮想ディスク)

仮想サーバの再起動

仮想サーバの情報一覧取得

操作対象の機器との認証方式に公開鍵認証を追加した。

操作対象の機器のOSがWindowsの場合に，ユーザーのプロファイルが引き継がれないことの説明を追加した。

ファイル転送部品の戻り値に，71および72を追加した。

次のJP1/AO同梱版部品を追加した。

文字列のフィルタリング

文字列の検索

OSサービスの操作

サーバのシャットダウン

サーバの再起動

次のJP1/AOコンテンツセット版部品を追加した。

仮想サーバの削除

仮想サーバの情報一覧取得

仮想ディスクの作成

仮想ディスクの接続

コンテンツ部品のバージョン間の機能差異を追記した。

各部品で使用できるプロトコルの説明を追加した。

(b)　資料番号（3021-3-316-20）の変更内容

2014年12月以降，マニュアル名称および資料番号を次のとおり変更した。

変更前

Job Management Partner 1/Automatic Operation 画面・コマンドリファレンス（3021-3-315）

変更後

Job Management Partner 1/Automatic Operation 画面・コマンド・APIリファレンス（3021-3-366）

適用OSにWindows Server 2012 R2を追加した。

JP1/AO同梱版サービステンプレートに次のカテゴリを追加した。

Utility_Components

JP1/AOコンテンツセット版サービステンプレートに次のカテゴリを追加した。

OS_Operations/Configuration

VM_Operations/Configuration/Hyper-V/2012

VM_Operations/Configuration/OpenStack

VM_Operations/Management/Hyper-V/2012

VM_Operations/Management/OpenStack

JP1/AO同梱版部品に次のカテゴリを追加した。

JP1/IM-SS

OperatingSystem/Windows/Database/32bit

JP1/AOコンテンツセット版部品に次のカテゴリを追加した。

OperatingSystem/Linux/Basic

VirtualMachine/Hyper-V/2012

VirtualMachine/Openstack

「LANG=C」のロケールで実行されるサービスに，「JP1/AJSのルートジョブネット移行」および「JP1/Cm2の監視対象ノード一覧取得」を追加した。また，マルチバイト文字を使用すると，文字化けが発生することを明記した。

サービステンプレートのプロパティに指定できる値についての注意事項を追加した。

プロパティの入力値や入力ファイルに外字およびサロゲートペア文字を指定した場合の注意事項を追加した。

次のJP1/AO同梱版サービステンプレートを追加した。

JP1/PFMアラーム定義の複製

JP1/AJSのルートジョブネット移行

JP1/AJSのルートジョブネット削除

JP1/IM-SSの案件登録

JP1/IM-SSの案件情報更新

操作対象の機器のOSがWindowsの場合に，ユーザーのプロファイルが引き継がれないことの説明を追加した。

タスクの実行を停止した場合の説明を，部品実行中にタスクを実行停止した場合の説明に変更した。また，部品実行中にタスクを強制停止した場合について，注意事項と部品の戻り値の説明を追加した。

操作対象の機器との認証方式に公開鍵認証を追加した。

部品を実行する際，操作対象の機器のOSに，あらかじめインストールされている必要のあるコマンドがあることについて追記した。

汎用コマンド実行部品について，プロパティ「elevatePrivileges」を追加し，rootユーザーに昇格するかどうかを指定できるようにした。また，汎用コマンド実行部品のバージョンを01.12.00に変更し，部品のバージョン01.10.00との機能差異を追加した。

ファイル転送部品の戻り値に，71および72を追加した。

ファイル転送可能な合計ファイルサイズの上限を変更した。また，転送対象のファイル名またはフォルダ名の制限値についての情報を追加した。

ファイル転送部品について，次の機能を追加した。

プロパティ「elevatePrivileges」を追加し，rootユーザーに昇格するかどうかを指定できるようにした。

一時的な作業領域をプロパティファイル（config_user.properties）で指定できるようにした。

また，ファイル転送部品のバージョンを01.12.00に変更し，部品のバージョン01.11.00との機能差異を追加した。

ファイル転送部品の操作対象の機器としてAIX，HP-UXおよびSolarisに対応した。また，ファイル転送部品のバージョンを変更した。

次の基本部品について，タスクをリトライした場合の注意事項を追加した。

繰り返し実行部品

ターミナル接続部品

ターミナルコマンド実行部品

標準出力部品で使用できる予約プロパティを追加した。

ターミナル接続部品およびターミナルコマンド実行部品に指定する文字セットのうち「ibm-943」を「ibm-943C」に変更した。

次のJP1/AO同梱版部品を追加した。

アラームテーブルの情報取得(JP1/PFM)

アラームテーブルの削除(JP1/PFM)

アラームテーブルのコピー(JP1/PFM)

アラーム定義ファイルのエクスポート(JP1/PFM)

アラーム定義ファイルのインポート(JP1/PFM)

文字列の置換

文字列のフィルタリング

文字列の検索

OSサービスの操作

サーバのシャットダウン

サーバの再起動

次のJP1/AOコンテンツセット版部品を追加した。

Windows更新プログラムのインストール

実行待機

JP1/AO 10-50で使用できる基本部品のバージョンを明記した。

コンテンツ部品のバージョン間の機能差異を追記した。

各部品で使用できるプロトコルの説明を追加した。

rootユーザーに昇格するかどうかを指定できるようになったことに伴い，ログインスクリプトの設定と「.bashrc」の設定について説明を変更した。

WindowsおよびLinuxに加えて，AIX，HP-UXおよびSolarisで，コマンドまたはスクリプトを実行するコンテンツ部品に対応した。また，ファイル転送部品の操作対象の機器としてAIX，HP-UXおよびSolarisに対応した。

(19)　10-13の変更内容

(a)　資料番号（3021-3-085-60）の変更内容

次のJP1/AO同梱版サービステンプレートを追加した。

JP1/IM-SSの案件登録

JP1/IM-SSの案件情報更新

JP1/AOコンテンツセット版サービステンプレートに次のカテゴリを追加した。

VM_Operations/Management/Hyper-V/2012

VM_Operations/Management/OpenStack

次のJP1/AOコンテンツセット版サービステンプレートを追加した。

仮想サーバのスペック変更(CPU，メモリ)

仮想サーバの追加(仮想ディスク)

JP1/AO同梱版部品に次のカテゴリを追加した。

JP1/IM-SS

次のJP1/AOコンテンツセット版部品を追加した。

仮想サーバの状態取得

仮想サーバのIPアドレス取得

仮想サーバのCPU設定変更

仮想サーバのメモリ設定変更

ボリュームの作成

ボリュームの接続

仮想サーバの状態取得

仮想サーバの起動

仮想サーバのIPアドレス取得

一時ボリュームの作成

ボリュームのバックアップ

ボリュームの削除

コンテンツ部品のバージョン間の機能差異を追記した。

(20)　10-12の変更内容

(a)　資料番号（3021-3-085-50）の変更内容

適用OSにWindows Server 2012 R2を追加した。

次のJP1/AO同梱版サービステンプレートを追加した。

JP1/PFMアラーム定義の複製

JP1/AOコンテンツセット版サービステンプレートに次のカテゴリを追加した。

VM_Operations/Configuration/Hyper-V/2012

汎用コマンド実行部品について，プロパティ「elevatePrivileges」を追加し，rootユーザーに昇格するかどうかを指定できるようにした。また，汎用コマンド実行部品のバージョンを01.12.00に変更し，部品のバージョン01.10.00との機能差異を追加した。

タスクの実行を停止した場合の説明を，部品実行中にタスクを実行停止した場合の説明に変更した。また，部品実行中にタスクを強制停止した場合について，注意事項と部品の戻り値の説明を追加した。

ファイル転送部品について，次の機能を追加した。

プロパティ「elevatePrivileges」を追加し，rootユーザーに昇格するかどうかを指定できるようにした。

一時的な作業領域をプロパティファイル（config_user.properties）で指定できるようにした。

また，ファイル転送部品のバージョンを01.12.00に変更し，部品のバージョン01.11.00との機能差異を追加した。

次の基本部品について，タスクをリトライした場合の注意事項を追加した。

繰り返し実行部品

ターミナル接続部品

ターミナルコマンド実行部品

次のJP1/AO同梱版部品を追加した。

アラームテーブルの情報取得(JP1/PFM)

アラームテーブルの削除(JP1/PFM)

アラームテーブルのコピー(JP1/PFM)

アラーム定義ファイルのエクスポート(JP1/PFM)

アラーム定義ファイルのインポート(JP1/PFM)

文字列の置換

次のJP1/AOコンテンツセット版部品を追加した。

実行待機

JP1/AOコンテンツセット版部品に次のカテゴリを追加した。

VirtualMachine/Hyper-V/2012

コンテンツ部品のバージョン間の機能差異を追加した。

rootユーザーに昇格するかどうかを指定できるようになったことに伴い，ログインスクリプトの設定と「.bashrc」の設定について説明を変更した。

(21)　10-11の変更内容

(a)　資料番号（3021-3-085-40）の変更内容

次のJP1/AO同梱版サービステンプレートを追加した。

JP1/AJSのルートジョブネット移行

JP1/AJSのルートジョブネット削除

JP1/AOコンテンツセット版サービステンプレートに次のカテゴリを追加した。

OS_Operations/Configuration

VM_Operations/Configuration/OpenStack

部品を実行する際，操作対象の機器のOSに，あらかじめインストールされている必要のあるコマンドがあることについて追記した。

ファイル転送部品の操作対象の機器としてAIX，HP-UXおよびSolarisに対応した。また，ファイル転送部品のバージョンを変更した。

ファイル転送可能な合計ファイルサイズの上限を変更した。また，転送対象のファイル名またはフォルダ名の制限値についての情報を追加した。

標準出力部品で使用できる予約プロパティを追加した。

ターミナル接続部品およびターミナルコマンド実行部品に指定する文字セットのうち「ibm-943」を「ibm-943C」に変更した。

JP1/AOコンテンツセット版部品に次のカテゴリを追加した。

OperatingSystem/Linux/Basic

VirtualMachine/Openstack

次のJP1/AO コンテンツセット版部品を追加した。

Windows更新プログラムのインストール

JP1/AO 10-11で使用できる基本部品のバージョンを明記した。

WindowsおよびLinuxに加えて，AIX，HP-UXおよびSolarisで，コマンドまたはスクリプトを実行するコンテンツ部品に対応した。また，ファイル転送部品の操作対象の機器としてAIX，HP-UXおよびSolarisに対応した。

(22)　10-10の変更内容

(a)　資料番号（3021-3-085-30）の変更内容

運用・監視用サービステンプレートについて，「運用ユーザー一括変更」の使用例を追加した。

次のJP1/AO同梱版サービステンプレートを追加した。

JP1/AJSのジョブネット計画確定実行登録

JP1/AJSのジョブネット実行予実績出力

JP1/Cm2の監視対象ノード一覧取得

運用ユーザー一括変更

JP1/AOコンテンツセット版サービステンプレートに次のカテゴリを追加した。

VM_Operations/Configuration/Hyper-V/2008

VM_Operations/Management/Hyper-V/2008

次の基本部品を追加した。

階層フロー部品

実行間隔制御部品

戻り値判定分岐部品

値判定部品

異常終了部品

値判定分岐部品

汎用コマンド実行部品について，操作対象の機器にAIXを指定できるようになったことに伴い，部品のバージョンを01.10.00に変更した。また，部品のバージョン01.02.00と01.10.00の機能差異を追加した。

ユーザー応答待ち部品のプロパティ「dialogText」に指定できるHTMLタグおよび属性ついて，「[JP1TOKEN]」の文字列が含まれる場合の説明を追加した。

ターミナル接続部品のHTTPサーバなど標準出力を返さないサービスに接続する場合の例について，部品の戻り値の説明を変更した。

ターミナルコマンド実行部品のプロパティ「commandLine」について，ターミナル接続部品で使用したプロパティを使用できる説明を追加した。

次のJP1/AO同梱版部品を追加した。

JP1/AJSジョブネット計画実行登録

JP1/AJSジョブネット確定実行登録

JP1/AJSジョブネット実行予実績出力

NNMiトポロジデータベース内容の出力

CSV・Excelの列データ取得

CSV・Excelの行データ取得

次のJP1/AOコンテンツセット版部品を追加した。

NICのMACアドレス取得

Windowsネットワークの設定

JP1/AOコンテンツセット版部品に次のカテゴリを追加した。

VirtualMachine/Hyper-V/2008

Hyper-Vが管理している仮想サーバの状態一覧について，説明を追加した。

UNIXでASCII文字以外の文字を含むコマンドラインを実行するための前提条件について，説明を追加した。

(b)　資料番号（3021-3-316-10）の変更内容

サービステンプレート共通の注意事項を追加した。

部品実行時に設定される操作対象の機器のロケールについて説明を追加した。

部品実行時に設定される操作対象の機器の文字セットについて説明を追加した。

次のJP1/AO同梱版サービステンプレートを追加した。

JP1/Cm2の監視対象ノード追加

JP1/Cm2の監視対象ノード削除

JP1/AJSのジョブネット計画確定実行登録

JP1/AJSのジョブネット実行予実績出力

JP1/Cm2の監視対象ノード一覧取得

運用ユーザー一括変更

JP1イベントの登録

JP1イベントの対処状況変更

運用・監視用サービステンプレートについて，「運用ユーザー一括変更」の使用例を追加した。

次のサービステンプレートについて，システム構成図を追加した。

監視設定追加

監視設定削除

運用ユーザー追加

運用ユーザー変更

運用ユーザー削除

仮想サーバ追加(LU作成/データストア作成)

仮想サーバ追加(デプロイ/OS初期設定)

仮想サーバ追加(仮想ディスク)

仮想サーバ削除

仮想サーバ削除(仮想ディスク)

仮想サーバ削除(データストア削除/LU削除)

仮想サーバスペック変更(CPU，メモリ)

仮想サーバのスナップショット

仮想サーバ起動

仮想サーバ停止

仮想サーバ再起動

仮想サーバマイグレーション

仮想サーバ追加(LU作成/データストア作成)環境確認

仮想サーバ追加(デプロイ/OS初期設定)環境確認

仮想サーバ情報一覧取得

ストレージ情報一覧取得

仮想サーバのクローン作成

仮想サーバのクローン削除

次のJP1/AOコンテンツセット版サービステンプレートを追加した。

仮想サーバのスナップショット

仮想サーバのクローン作成

仮想サーバのクローン削除

JP1/AOコンテンツセット版サービステンプレートに次のカテゴリを追加した。

VM_Operations/Configuration/Hyper-V/2008

VM_Operations/Management/Hyper-V/2008

汎用コマンド実行部品について，操作対象の機器にAIXを指定できるようになったことに伴い，部品のバージョンを01.10.00に変更した。また，部品のバージョン01.02.00と01.10.00の機能差異を追加した。

ファイル転送可能な合計ファイルサイズの上限を変更した。また，転送対象のファイル名またはフォルダ名の制限値についての情報を追加した。

ユーザー応答待ち部品のプロパティ「dialogText」に指定できるHTMLタグおよび属性ついて，「[JP1TOKEN]」の文字列が含まれる場合の説明を追加した。

標準出力部品で出力できる予約プロパティを追加した。

次の基本部品を追加した。

ターミナル接続部品

ターミナルコマンド実行部品

ターミナル切断部品

階層フロー部品

実行間隔制御部品

戻り値判定分岐部品

値判定部品

異常終了部品

値判定分岐部品

ターミナル接続部品のHTTPサーバなど標準出力を返さないサービスに接続する場合の例について，部品の戻り値の説明を変更した。

ターミナルコマンド実行部品のプロパティ「commandLine」について，ターミナル接続部品で使用したプロパティを使用できる説明を追加した。

次のJP1/AO同梱版部品を追加した。

JP1/AJSジョブネット計画実行登録

JP1/AJSジョブネット確定実行登録

JP1/AJSジョブネット実行予実績出力

JP1イベントの登録

JP1/Base共通定義情報設定

NNMiトポロジデータベース内容の出力

JP1イベントの対処状況変更

CSV・Excelの列データ取得

CSV・Excelの行データ取得

次のJP1/AOコンテンツセット版部品を追加した。

NICのMACアドレス取得

Windowsネットワークの設定

仮想サーバのスナップショット作成

仮想サーバのスナップショット移動

仮想サーバのスナップショット削除

仮想サーバのクローン作成

仮想サーバのクローン削除

仮想サーバのリソース構成の設定

仮想サーバのリソース変更の事前判定

仮想サーバのリソース構成変更の事前判定

JP1/AOコンテンツセット版部品に次のカテゴリを追加した。

VirtualMachine/Hyper-V/2008

バージョン間の機能差異を追加した。

Hyper-Vが管理している仮想サーバの状態一覧について，説明を追加した。

UNIXでASCII文字以外の文字を含むコマンドラインを実行するための前提条件について，説明を追加した。

(23)　10-02の変更内容

(a)　資料番号（3021-3-085-20）の変更内容

サービステンプレート共通の注意事項を追加した。

部品実行時に設定される操作対象の機器のロケールについて説明を追加した。

部品実行時に設定される操作対象の機器の文字セットについて説明を追加した。

次のサービステンプレートについて，システム構成図を追加した。

仮想サーバのスナップショット

仮想サーバ情報一覧取得

ストレージ情報一覧取得

仮想サーバのクローン作成

仮想サーバのクローン削除

汎用コマンド実行部品およびファイル転送部品について，部品のバージョン01.02.00の説明に変更した。

標準出力部品で出力できる予約プロパティを追加した。

次のJP1/AO同梱版部品を追加した。

ターミナル接続部品

ターミナルコマンド実行部品

ターミナル切断部品

JP1/Base共通定義情報設定

次のJP1/AOコンテンツセット版部品を追加した。

仮想サーバのリソース構成の設定

仮想サーバのリソース変更の事前判定

仮想サーバのリソース構成変更の事前判定

次の予約プロパティを追加した。

reserved.terminal.account

reserved.terminal.password

reserved.terminal.suPassword

サービステンプレート編集用フォルダの構成の説明に，次のフォルダおよびファイルを追加した。

言語コードフォルダ

説明画面ファイル名.拡張子

サービステンプレートパッケージの作成について説明を追加した。

実行環境へのサービステンプレートの適用について説明を追加した。

部品定義ファイルで指定できる要素に「enableSSHCharsetDetection要素」を追加した。

バージョン間の機能差異を追加した。

(24)　10-01の変更内容

(a)　資料番号（3021-3-085-10）の変更内容

次のJP1/AO同梱版サービステンプレートを追加した。

JP1/Cm2の監視対象ノード追加

JP1/Cm2の監視対象ノード削除

JP1イベントの登録

JP1イベントの対処状況変更

次のJP1/AOコンテンツセット版サービステンプレートを追加した。

仮想サーバのスナップショット

仮想サーバのクローン作成

仮想サーバのクローン削除

次のJP1/AO同梱版部品を追加した。

JP1イベントの登録

JP1イベントの対処状況変更

次のJP1/AOコンテンツセット版部品を追加した。

仮想サーバのスナップショット作成

仮想サーバのスナップショット移動

仮想サーバのスナップショット削除

仮想サーバのクローン作成

仮想サーバのクローン削除

索引

A

AWS Componentsに含まれる部品一覧[1]

H

HCS Componentsに含まれる部品一覧[1]

Hyper-V2008 Componentsに含まれる部品一覧[1]

Hyper-V2012 Componentsに含まれる部品一覧[1]

Hyper-V2016 Componentsに含まれる部品一覧[1]

Hyper-Vが管理している仮想サーバの状態一覧[1]

J

JavaScript実行部品[1]

JP1/AO Content Pack版コンテンツ部品一覧[1]

JP1/AO Content Pack版サービステンプレート[1]

JP1/AO Content Pack版サービステンプレート一覧[1]

JP1/AO Content Pack版サービステンプレートのシステム構成[1]

JP1/AO Content Pack版部品[1]

JP1/AO同梱版コンテンツ部品一覧[1]

JP1/AO同梱版サービステンプレート[1]

JP1/AO同梱版サービステンプレート一覧[1]

JP1/AO同梱版サービステンプレートのシステム構成[1]

JP1/AO同梱版部品[1]

O

OpenStack Componentsに含まれる部品一覧[1]

P

Python実行部品[1]

U

UNIXでASCII文字以外の文字を含むコマンドラインを実行するための前提条件[1]

Utility Componentsに含まれる部品一覧[1]

V

vSphere Componentsに含まれる部品一覧[1]

W

Webクライアント部品[1]

あ

値判定部品[1]

値判定分岐部品[1]

い

異常終了部品[1]

う

運用・監視用サービステンプレートの使用例[1]

え

エージェントレス接続先として使用できる操作対象の機器[1]

か

階層フロー部品[1]

各バージョンで使用できる基本部品[1]

各バージョンのロケールと文字セットの扱い[1]

各部品で使用できるプロトコル一覧[1]

仮想サーバ用サービステンプレートの使用例[1]

き

基本部品一覧[1]

基本部品共通の注意事項[1]

基本部品のバージョン間の機能差異[1]

く

繰り返し実行部品[1]

さ

サービステンプレート「運用ユーザー一括変更」の使用例[1]

サービステンプレート「運用ユーザー追加」の使用例[1]

サービステンプレート「仮想サーバ追加（LU作成/データストア作成）」の使用例[1]

サービステンプレート「仮想サーバマイグレーション」の使用例[1]

サービステンプレート「監視設定追加」の使用例[1]

サービステンプレート共通の注意事項[1]

サービステンプレートと部品の種類[1]

サービステンプレートの概要[1]

サービステンプレートリファレンスの読み方[1]

参考情報[1]

し

実行間隔制御部品[1]

た

ターミナルコマンド実行部品[1]

ターミナル接続部品[1]

ターミナル切断部品[1]

は

汎用コマンド実行部品[1]

ひ

標準出力部品[1]

ふ

ファイルエクスポート部品[1]

ファイル転送部品[1]

部品提供用のサービステンプレートに含まれる部品一覧[1]

部品リファレンスの読み方[1]

め

メール通知部品[1]

も

戻り値判定分岐部品[1]

ゆ

ユーザー応答待ち部品[1]