NSX Autonomous Edge REST API
IPSecMultiPathGroup (schema)
IPSec VPN multipath group
Configuration to allow IPSec VPN traffic through multipaths.
| Name | Description | Type | Notes |
|---|---|---|---|
| _create_time | Timestamp of resource creation | EpochMsTimestamp | Readonly Sortable |
| _create_user | ID of the user who created this resource | string | Readonly |
| _last_modified_time | Timestamp of last modification | EpochMsTimestamp | Readonly Sortable |
| _last_modified_user | ID of the user who last modified this resource | string | Readonly |
| _links | References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink | Readonly |
| _protection | Indicates protection status of this resource 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. |
string | Readonly |
| _revision | Generation of this resource config 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. |
integer | Readonly |
| _schema | Location of schema for this resource | string | Readonly |
| _self | SelfResourceLink | Readonly | |
| _system_owned | Indicates system owned resource | boolean | Readonly |
| actions | Actions applicable to the resource at this time | array of ActionDescriptor | Readonly |
| description | Description of this resource | string | Maximum length: 1024 Sortable |
| display_name | Identifier to use when displaying entity in logs or GUI Defaults to ID if not set |
string | Maximum length: 255 Sortable |
| enabled | Enable IPSec VPN multipath group If true, enable IPSec VPN multipath group. |
boolean | Default: "False" |
| id | Unique identifier of this resource | string | Readonly Sortable |
| ipsec_vpn_session_ids | List of IPSec VPN session Ids that are using this multipath group List of all IPSec VPN session Ids that are using this multipath group. |
array of string | Readonly |
| notify_mpa | send notification to MPA about this config change (applicable on edge node) | boolean | Default: "False" |
| resource_type | Must be set to the value IPSecMultiPathGroup | string | |
| scheme | The scheme specified to decide best paths 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 Default: "THRESHOLD_BASED" |
|
| scheme_value | The value specified for the scheme 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. |
integer | |
| source_port_pool_size | The size of the source port pool 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. |
integer | Minimum: 2 Maximum: 7 Default: "7" |
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |