NSX Autonomous Edge REST API

IPSecMultiPathGroup (type)

{
  "additionalProperties": false, 
  "description": "Configuration to allow IPSec VPN traffic through multipaths.", 
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "IPSecMultiPathGroup", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "readonly": true, 
      "title": "Generation of this resource config", 
      "type": "integer"
    }, 
    "_schema": {
      "display": {
        "hidden": true
      }, 
      "readonly": true, 
      "title": "Location of schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "actions": {
      "items": {
        "$ref": "ActionDescriptor
      }, 
      "readonly": true, 
      "title": "Actions applicable to the resource at this time", 
      "type": "array"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "enabled": {
      "default": false, 
      "description": "If true, enable IPSec VPN  multipath group.", 
      "title": "Enable IPSec VPN multipath group", 
      "type": "boolean"
    }, 
    "id": {
      "can_sort": true, 
      "readonly": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "ipsec_vpn_session_ids": {
      "description": "List of all IPSec VPN session Ids that are using this multipath group.", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "title": "List of IPSec VPN session Ids that are using this multipath group", 
      "type": "array"
    }, 
    "notify_mpa": {
      "default": false, 
      "description": "send notification to MPA about this config change (applicable on edge node)", 
      "display": {
        "hidden": true
      }, 
      "readonly": false, 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "scheme": {
      "default": "THRESHOLD_BASED", 
      "description": "Specify a scheme to probe the quality of different paths for IPSec VPN traffic and to select the best equally good paths. THRESHOLD_BASED: The best paths are selected based on the threshold limit configured.", 
      "enum": [
        "THRESHOLD_BASED"
      ], 
      "title": "The scheme specified to decide best paths"
    }, 
    "scheme_value": {
      "description": "If scheme is THRESHOLD_BASED, scheme_value represents margin above the average path metric used for selecting the best paths. Paths below the specified threshold are considered good while above the selected threshold are considered bad quality. Threshold is a percentage value in the range of [0-100]. If not specified, the default is 20.", 
      "title": "The value specified for the scheme", 
      "type": "integer"
    }, 
    "source_port_pool_size": {
      "default": 7, 
      "description": "The maximum number of best paths allowed for an IPSec VPN session. For each path, a UDP source port number is assigned from an internal source port pool for encapsulating the IPSec VPN traffic through the path.", 
      "maximum": 7, 
      "minimum": 2, 
      "title": "The size of the source port pool", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "IPSec VPN multipath group", 
  "type": "object"
}