分散ファイアウォール ルールに CPU およびメモリ使用率のしきい値を適用するには、サービス設定 API を使用します。サービス設定 API を実装すると、仮想マシン グループ、トランスポート ノード、論理スイッチ、論理ポートなどのエンティティにプロファイルの設定を適用できます。

サービス設定の詳細を取得

構文および使用法の詳細については、『NSX-T Data Center API』ガイドを参照してください。

すべてのサービス設定のリストを取得します。

GET https://<nsx-mgr>/api/v1/service-configs
表 1. API の属性
属性 詳細

Profile

仮想マシン グループに適用される設定です。

たとえば、FirewallSessionTimerProfile は、分散ファイアウォール ルールが実行されている場合に、トランスポート ノードの CPU 使用率に関する詳細を収集するためにトランスポート ノードに適用されるプロファイルです。

注: サービス設定に含めることができるプロファイルは 1 つのみです。

Applied_To

サービス プロファイルが適用される仮想マシン グループです。

Precedence

プロファイル タイプごとに適用されます。

NSX-T Data Center は、仮想マシン グループに適用する必要があるプロファイルの優先順位を決定します。この優先順位は昇順とします。

たとえば、シーケンス番号が 1 のプロファイルは、シーケンス番号が 2 のプロファイルよりも優先順位が高くなります。

サービス設定の作成

プロファイルおよび設定をグループ化できるサービス設定を作成します。

POST https://<nsx-mgr>/api/v1/service-config
{
  "display_name":"testServiceConfig",
  "profiles":[{"profile_type":"FirewallSessionTimerProfile",
              "target_id":"183e372b-854c-4fcc-a24e-05721ce89a60"
              }
            ],
  “precedence”: 10,
  “applied_to”: [{
    "target_id":"333e372b-854c-4fcc-a24e-05721ce89b71",
    "target_type" : "NSGroup"
              }]
}
Example Response:
{
  "id": "183e372b-854c-4fcc-a24e-05721ce89a60",
  "display_name":"testServiceConfig",
  "profiles":[{"profile_type":"FirewallSessionTimerProfile",
              "target_id":"183e372b-854c-4fcc-a24e-05721ce89a60"
              }
            ],
  “precedence”: 10,
  “applied_to”: [{
                  "target_id":"333e372b-854c-4fcc-a24e-05721ce89b71",
    "target_type" : "NSGroup"
              }]
  "_create_user": "system",
  "_last_modified_user": "system",
  "_last_modified_time": 1414057732203,
  "_create_time": 1414057732203
}

サービス設定の削除

指定したサービス設定を削除します。

DELETE https://<nsx-mgr>/api/v1/service-configs/<183e372b-854c-4fcc-a24e-05721ce89a60>

特定の設定に関する詳細を取得

指定したサービス設定に関する情報を返します。

GET https://<nsx-mgr>/api/v1/service-configs/<183e372b-854c-4fcc-a24e-05721ce89a60>
Example Response:
{
  "_revision": 1,
  "id": "183e372b-854c-4fcc-a24e-05721ce89a60",
    "display_name":"testServiceConfig1",
    "resource_type": "ServiceConfig",
    "profiles":[{"profile_type":"FirewallSessionTimerProfile",
                "target_id":"183e372b-854c-4fcc-a24e-05721ce89a45",
                "is_valid":true
              }],
    “precedence”: 10,
    “applied_to”: [{"target_id":"333e372b-854c-4fcc-a24e-05721ce89b71",
              "target_type": "LogicalSwitch",
              "is_valid":true
                }
              ]
    "_create_user": "system",
    "_last_modified_user": "system",
    "_last_modified_time": 1414057732203,
    "_create_time": 1414057732203
}

サービス設定の更新

指定したサービス設定を更新します。

PUT https://<nsx-mgr>/api/v1/service-configs/183e372b-854c-4fcc-a24e-05721ce89a60
{
  "id": "183e372b-854c-4fcc-a24e-05721ce89a60",
  "display_name":"testServiceConfig1",
  "resource_type": "ServiceConfig",
  "profiles":[{"profile_type":"FirewallSessionTimerProfile",
              "target_id":"183e372b-854c-4fcc-a24e-05721ce89a45"
            }],
  “precedence”: 10,
  “applied_to”: [{"target_id":"333e372b-854c-4fcc-a24e-05721ce89b71",
    "target_type" : "NSGroup"
              }]
  "_create_user": "system",
  "_last_modified_user": "system",
  "_last_modified_time": 1414057732203,
  "_create_time": 1414057732203,
  "_create_user": "admin",
  "_revision": 0
}

有効なプロファイルの取得

指定したリソースに適用される有効なプロファイルを返します。

GET https://<nsx-mgr>/api/v1/service-configs/effective-profiles?
resource_id=<144e372b-854c-4fcc-a24e-05721ce89a60>&resource_type=NSGroup
Example Response:
{
  "cursor": "00012",
  "sort_ascending": true,
  "result_count": 2,
  "results": [
             { "profile_type":"FirewallSessionTimerProfile",
               "target_id":"183e372b-854c-4fcc-a24e-05721ce89a45",
               "target_name":"Firewall Session Timer Profile
               "is_valid":true
              },
              { "profile_type":"FirewallCpuMemThresholdsProfile",
                "target_id":"5678372b-854c-4fcc-a24e-05721ce89a45",
                "target_name":"Firewall CPU Profile
                "is_valid":true
              },
           ]
  }