| _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. |
int |
|
| _schema |
Schema for this resource |
string |
Readonly |
| _self |
Link to this resource |
SelfResourceLink |
Readonly |
| _system_owned |
Indicates system owned resource |
boolean |
Readonly |
| authentication_mode |
Authentication Mode
Peer authentication mode.
PSK - In this mode a secret key shared between local and
peer sites is to be used for authentication. The secret
key can be a string with a maximum length of 128 characters.
CERTIFICATE - In this mode a certificate defined at the
global level is to be used for authentication.
|
string |
Enum: PSK, CERTIFICATE
Default: "PSK" |
| children |
Subtree for this type within policy tree
Subtree for this type within policy tree containing nested elements. Note that
this type is applicable to be used in Hierarchical API only.
|
array of ChildPolicyConfigResource
Children are not allowed for this type |
|
| compliance_suite |
Compliance suite
Compliance suite.
|
string |
Enum: CNSA, SUITE_B_GCM_128, SUITE_B_GCM_256, PRIME, FOUNDATION, FIPS, NONE |
| connection_initiation_mode |
Connection initiation mode
Connection initiation mode used by local endpoint to
establish ike connection with peer site.
INITIATOR - In this mode local endpoint initiates
tunnel setup and will also respond to incoming tunnel
setup requests from peer gateway.
RESPOND_ONLY - In this mode, local endpoint shall only
respond to incoming tunnel setup requests. It shall not
initiate the tunnel setup.
ON_DEMAND - In this mode local endpoint will initiate
tunnel creation once first packet matching the policy
rule is received and will also respond to incoming
initiation request.
|
string |
Enum: INITIATOR, RESPOND_ONLY, ON_DEMAND
Default: "INITIATOR" |
| 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 |
| dpd_profile_path |
Dead peer detection (DPD) profile path
Policy path referencing Dead Peer Detection (DPD) profile. Default is set to system default profile. |
string |
|
| enabled |
Enable/Disable IPSec VPN session
Enable/Disable IPSec VPN session. |
boolean |
Default: "True" |
| force_whitelisting |
Flag to add default whitelisting Gateway Policy rule for the VTI interface.
If true the default firewall rule Action is set to DROP, otherwise set to ALLOW.
This field is deprecated and recommended to change Rule action field. Note that this
field is not synchornied with default rule field.
|
boolean |
Deprecated
Default: "False" |
| id |
Unique identifier of this resource |
string |
Sortable |
| ike_profile_path |
Internet key exchange (IKE) profile path
Policy path referencing IKE profile to be used. Default is set according to system default profile. |
string |
|
| local_endpoint_path |
Local endpoint path
Policy path referencing Local endpoint. This property is mandatory on LM. It is required on GM only in case of site_overrides property not provided. |
string |
|
| marked_for_delete |
Indicates whether the intent object is marked for deletion
Intent objects are not directly deleted from the system when a delete
is invoked on them. They are marked for deletion and only when all the
realized entities for that intent object gets deleted, the intent object
is deleted. Objects that are marked for deletion are not returned in
GET call. One can use the search API to get these objects.
|
boolean |
Readonly
Default: "False" |
| origin_site_id |
A unique identifier assigned by the system for knowing which site owns an object
This is a UUID generated by the system for knowing which site owns an object.
This is used in NSX+.
|
string |
Readonly |
| overridden |
Indicates whether this object is the overridden intent object
Global intent objects cannot be modified by the user.
However, certain global intent objects can be overridden locally by use
of this property. In such cases, the overridden local values take
precedence over the globally defined values for the properties.
|
boolean |
Readonly
Default: "False" |
| owner_id |
A unique identifier assigned by the system for the ownership of an object
This is a UUID generated by the system for knowing who owns this object.
This is used in NSX+.
|
string |
Readonly |
| parent_path |
Path of its parent
Path of its parent |
string |
Readonly |
| path |
Absolute path of this object
Absolute path of this object |
string |
Readonly |
| peer_address |
IPV4 or IPV6 address of peer endpoint on remote site
Public IPV4 or IPV6 address of the remote device terminating the VPN connection. This property is mandatory on LM. It is required on GM only in case of site_overrides property not provided. Please note that configuring peer_address as IPv6 address is not supported in the deprecated IPSecVpnSession Patch/PUT APIs. |
IPAddress |
|
| peer_id |
Peer id
Peer ID to uniquely identify the peer site. The peer ID is the public IP address of the remote device terminating the VPN tunnel. When NAT is configured for the peer, enter the private IP address of the peer. This property is mandatory on LM. It is required on GM only in case of site_overrides property not provided. |
string |
|
| psk |
Pre-shared key
IPSec Pre-shared key. Maximum length of this field is 128 characters. |
secure_string |
|
| realization_id |
A unique identifier assigned by the system for realizing intent
This is a UUID generated by the system for realizing the entity object.
In most cases this should be same as 'unique_id' of the entity. However,
in some cases this can be different because of entities have migrated their
unique identifier to NSX Policy intent objects later in the timeline and did
not use unique_id for realization. Realization id is helpful for users to
debug data path to correlate the configuration with corresponding intent.
|
string |
Readonly |
| relative_path |
Relative path of this object
Path relative from its parent |
string |
Readonly |
| remote_path |
Path of the object on the remote end.
This is the path of the object on the local managers when queried on the NSX+ service,
and path of the object on NSX+ service when queried from the local managers.
|
string |
Readonly |
| resource_type |
Must be set to the value RouteBasedIPSecVpnSession |
IPSecVpnSessionResourceType |
Required |
| site_overrides |
SiteOverride list
A collection of site specific attributes specificed only on GM
|
array of SiteOverride |
Maximum items: 128 |
| tags |
Opaque identifiers meaningful to the API user |
array of Tag |
Maximum items: 30 |
| tcp_mss_clamping |
TCP MSS Clamping
TCP Maximum Segment Size Clamping Direction and Value.
|
TcpMaximumSegmentSizeClamping |
|
| tunnel_interfaces |
IP Tunnel interfaces
IP Tunnel interfaces. This property is mandatory on LM. It is required on GM only in case of site_overrides property not provided. |
array of IPSecVpnTunnelInterface |
Minimum items: 1
Maximum items: 1 |
| tunnel_profile_path |
IPSec tunnel profile path
Policy path referencing Tunnel profile to be used. Default is set to system default profile. |
string |
|
| unique_id |
A unique identifier assigned by the system
This is a UUID generated by the GM/LM to uniquely identify
entities in a federated environment. For entities that are
stretched across multiple sites, the same ID will be used
on all the stretched sites.
|
string |
Readonly |