ModifyVirtualNetwork

ModifyVirtualNetworkメソッドを使用すると、既存の仮想ネットワークの属性を変更できます。

このメソッドでは、アドレス ブロックの追加や削除、ネットマスクの変更、または仮想ネットワークの名前や説明の変更が可能です。また、ネームスペースの有効化と無効化のほか、仮想ネットワークでネームスペースが有効な場合はゲートウェイの追加や削除もできます。

注: このメソッドにはパラメータとしてvirtualNetworkIDまたはvirtualNetworkTagのいずれか一方が必要です。
注意:
namespaceパラメータを変更して既存の仮想ネットワークのルーティング可能ストレージVLAN機能を有効または無効にすると、その仮想ネットワークで処理されているすべてのトラフィックが中断します。namespaceパラメータの変更はスケジュールされているメンテナンス期間中にのみ実施することを推奨します。

パラメータ

このメソッドの入力パラメータは次のとおりです。

名前 説明 タイプ デフォルト値 必須
virtualNetworkID 変更する仮想ネットワークの一意の識別子。これは、クラスタによって割り当てられる仮想ネットワークIDです。 整数 なし 無効
virtualNetworkTag 変更する仮想ネットワークを特定するネットワーク タグ。 整数 なし 無効
addressBlocks この仮想ネットワークに設定する新しいアドレス ブロック。既存のオブジェクトに追加する新しいアドレス ブロックを指定したり、削除が必要な未使用のアドレス ブロックを除いたブロックを指定したりできます。また、既存のアドレス ブロックのサイズを拡大または縮小することもできます。仮想ネットワーク オブジェクトの開始アドレス ブロックのサイズは、拡大はできますが縮小することはできません。このオブジェクトの必須のメンバーは次のとおりです。
  • start:IPアドレス範囲の開始アドレス(文字列)
  • size:ブロックに含めるIPアドレスの数(整数)。
JSONオブジェクト なし 無効
gateway 仮想ネットワークのゲートウェイのIPアドレス。このパラメータは、namespaceパラメータをtrueに設定した場合のみ有効です。 文字列 なし 無効
attributes JSONオブジェクト形式の名前と値のペアのリスト。 JSONオブジェクト なし 無効
name 仮想ネットワークの新しい名前。 文字列 なし 無効
namespace trueに設定すると、仮想ネットワークが再作成されてその仮想ネットワークを含むネームスペースが設定されることで、ルーティング可能ストレージVLAN機能が有効になります。falseに設定すると、仮想ネットワークのVRF機能が無効になります。この値を変更すると、この仮想ネットワークを通過するトラフィックが中断されます。 ブーリアン なし 無効
netmask この仮想ネットワークの新しいネットワーク マスク。 文字列 なし 無効
svip この仮想ネットワークのストレージ仮想IPアドレス。仮想ネットワークのSVIPは変更できません。別のSVIPアドレスを使用するには、新しい仮想ネットワークを作成する必要があります。 文字列 なし 無効

戻り値

このメソッドには戻り値はありません。

要求例

このメソッドの要求例を次に示します。

{
  "method": "ModifyVirtualNetwork",
  "params": {
    "virtualNetworkID": 2,
    "name": "ESX-VLAN-3112",
    "addressBlocks": [
     {
      "start": "10.1.112.1",
      "size": 20
     },
     {
      "start": "10.1.112.100",
      "size": 20
     }
   ],
    "netmask": "255.255.255.0",
    "gateway": "10.0.1.254",
    "svip": "10.1.112.200",
    "attributes": {}
  },
  "id":1
}

応答例

このメソッドの応答例を次に示します。

{
  "id": 1,
  "result": {
  }
}

新規導入バージョン

9.6