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）を格納するプロパティです。 |
− |
出力 |
△ |