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 |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |