{
"additionalProperties": false,
"description": "Local endpoint represents a tier-0/tier-1 on which tunnel needs to be terminated. In federation, all the configuration done for the local endpoint on GM will be realized based on the scope attribute at the corresponding LM. Local endpoint without any scope will be realized on all sites. The scope attribute is applicable only on GM not on LM.",
"extends": {
"$ref": "PolicyConfigResource
},
"id": "IPSecVpnLocalEndpoint",
"module_id": "PolicyVpnIPSecVpn",
"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.",
"title": "Generation of this resource config",
"type": "int"
},
"_schema": {
"readonly": true,
"title": "Schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true,
"title": "Link to this resource"
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"certificate_path": {
"description": "Policy path referencing site certificate.",
"title": "Certificate path",
"type": "string",
"x-vmw-cross-reference": [
{
"leftType": [
"IPSecVpnLocalEndpoint"
],
"relationshipType": "IPSEC_VPN_LOCAL_ENDPOINT_TLS_CERTIFICATE_RELATIONSHIP",
"rightType": [
"TlsCertificate"
]
}
]
},
"children": {
"description": "subtree for this type within policy tree containing nested elements.",
"items": {
"$ref": "ChildPolicyConfigResource
},
"required": false,
"title": "subtree for this type within policy tree",
"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"
},
"id": {
"can_sort": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"local_address": {
"$ref": "IPv4Address,
"description": "IPV4 Address of local endpoint.",
"required": true,
"title": "IPV4 Address of local endpoint"
},
"local_id": {
"description": "Local identifier.",
"title": "Local identifier",
"type": "string"
},
"marked_for_delete": {
"default": false,
"description": "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.",
"readonly": true,
"required": false,
"title": "Indicates whether the intent object is marked for deletion",
"type": "boolean"
},
"overridden": {
"default": false,
"description": "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.",
"readonly": true,
"required": false,
"title": "Indicates whether this object is the overridden intent object",
"type": "boolean"
},
"parent_path": {
"description": "Path of its parent",
"readonly": true,
"required": false,
"title": "Path of its parent",
"type": "string"
},
"path": {
"description": "Absolute path of this object",
"readonly": true,
"required": false,
"title": "Absolute path of this object",
"type": "string"
},
"realization_id": {
"description": "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 thier 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.",
"readonly": true,
"required": false,
"title": "A unique identifier assigned by the system for realizing intent",
"type": "string"
},
"relative_path": {
"description": "Path relative from its parent",
"readonly": true,
"required": false,
"title": "Relative path of this object",
"type": "string"
},
"resource_type": {
"description": "The type of this resource.",
"readonly": false,
"type": "string"
},
"scope": {
"description": "Scope attribute refers to the Policy path identifying the LocaleService of specific site where all the local end point configurations will be realized. In federation, all the configuration done for the local endpoint on GM will be realized based on the scope at the corresponding LM. Local endpoint without any scope will be realized on all sites. This attribute will not be applicable on LM.",
"required": false,
"title": "scope identify the site to which LocalEndpoint configuration associated with. Applicable only in GM",
"type": "string",
"x-vmw-cross-reference": [
{
"leftType": [
"IPSecVpnLocalEndpoint"
],
"relationshipType": "IPSEC_VPN_LOCAL_ENDPOINT_LOCALE_SERVICE_RELATIONSHIP",
"rightType": [
"LocaleServices"
]
}
]
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
},
"trust_ca_paths": {
"description": "List of policy paths referencing certificate authority (CA) to verify peer certificates.",
"items": {
"type": "string"
},
"title": "Certificate authority (CA) paths",
"type": "array",
"x-vmw-cross-reference": [
{
"leftType": [
"IPSecVpnLocalEndpoint"
],
"relationshipType": "IPSEC_VPN_LOCAL_ENDPOINT_TLS_CERTIFICATE_RELATIONSHIP",
"rightType": [
"TlsCertificate"
]
}
]
},
"trust_crl_paths": {
"description": "List of policy paths referencing certificate revocation list (CRL) to peer certificates.",
"items": {
"type": "string"
},
"title": "Certificate revocation list (CRL) paths",
"type": "array",
"x-vmw-cross-reference": [
{
"leftType": [
"IPSecVpnLocalEndpoint"
],
"relationshipType": "IPSEC_VPN_LOCAL_ENDPOINT_TLS_CRL_RELATIONSHIP",
"rightType": [
"TlsCrl"
]
}
]
},
"unique_id": {
"description": "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.",
"readonly": true,
"required": false,
"title": "A unique identifier assigned by the system",
"type": "string"
}
},
"title": "IPSec VPN Local Endpoint",
"type": "object"
}