| _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 |
| children |
subtree for this type within policy tree
subtree for this type within policy tree containing nested elements.
|
array of ChildPolicyConfigResource
Children are not allowed for this type |
|
| 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_probe_interval |
DPD Probe Interval
DPD probe interval defines an interval for DPD probes (in seconds).
- When the DPD probe mode is periodic, this interval is the number
of seconds between DPD messages.
- When the DPD probe mode is on-demand, this interval is the number
of seconds during which traffic is not received from the peer before
DPD retry messages are sent if there is IPSec traffic to send.
For PERIODIC Mode:
Minimum: 3
Maximum: 360
Default: 60
For ON_DEMAND Mode:
Minimum: 1
Maximum: 10
Default: 3
|
integer |
|
| dpd_probe_mode |
DPD Probe Mode
DPD probe mode is used to query the liveliness of the peer. Two modes
are possible:
- PERIODIC: is used to query the liveliness of the peer at regular
intervals (dpd_probe_interval). It does not take into consideration
traffic coming from the peer.
The benefit of this mode over the on-demand mode is earlier detection of
dead peers. However, use of periodic DPD incurs extra overhead. When
communicating to large numbers of peers, please consider using on-demand
DPD instead.
- ON_DEMAND: is used to query the liveliness of the peer by instructing
the local endpoint to send DPD message to a peer if there is traffic to
send to the peer AND the peer was idle for dpd_probe_interval seconds
(i.e. there was no traffic from the peer for dpd_probe_interval seconds).
|
string |
Enum: PERIODIC, ON_DEMAND
Default: "PERIODIC" |
| enabled |
Enable dead peer detection (DPD)
If true, enable dead peer detection. |
boolean |
Default: "True" |
| id |
Unique identifier of this resource |
string |
Sortable |
| 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" |
| 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" |
| 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 |
| relative_path |
Relative path of this object
Path relative from its parent |
string |
Readonly |
| resource_type |
Must be set to the value IPSecVpnDpdProfile |
string |
|
| retry_count |
Retry Count
Maximum number of DPD messages' retry attempts. This value is applicable
for both dpd probe modes, periodic and on-demand.
|
integer |
Minimum: 1
Maximum: 100
Default: "10" |
| tags |
Opaque identifiers meaningful to the API user |
array of Tag |
Maximum items: 30 |
| unique_id |
A unique identifier assigned by the system
This is a UUID generated by the GM/LM to uniquely identify
entites 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 |