1. Packages
  2. Nsxt Provider
  3. API Docs
  4. PolicyIpsecVpnLocalEndpoint
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware

nsxt.PolicyIpsecVpnLocalEndpoint

Explore with Pulumi AI

Create PolicyIpsecVpnLocalEndpoint Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new PolicyIpsecVpnLocalEndpoint(name: string, args: PolicyIpsecVpnLocalEndpointArgs, opts?: CustomResourceOptions);
@overload
def PolicyIpsecVpnLocalEndpoint(resource_name: str,
                                args: PolicyIpsecVpnLocalEndpointArgs,
                                opts: Optional[ResourceOptions] = None)

@overload
def PolicyIpsecVpnLocalEndpoint(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                display_name: Optional[str] = None,
                                local_address: Optional[str] = None,
                                service_path: Optional[str] = None,
                                certificate_path: Optional[str] = None,
                                description: Optional[str] = None,
                                local_id: Optional[str] = None,
                                nsx_id: Optional[str] = None,
                                policy_ipsec_vpn_local_endpoint_id: Optional[str] = None,
                                tags: Optional[Sequence[PolicyIpsecVpnLocalEndpointTagArgs]] = None,
                                trust_ca_paths: Optional[Sequence[str]] = None,
                                trust_crl_paths: Optional[Sequence[str]] = None)
func NewPolicyIpsecVpnLocalEndpoint(ctx *Context, name string, args PolicyIpsecVpnLocalEndpointArgs, opts ...ResourceOption) (*PolicyIpsecVpnLocalEndpoint, error)
public PolicyIpsecVpnLocalEndpoint(string name, PolicyIpsecVpnLocalEndpointArgs args, CustomResourceOptions? opts = null)
public PolicyIpsecVpnLocalEndpoint(String name, PolicyIpsecVpnLocalEndpointArgs args)
public PolicyIpsecVpnLocalEndpoint(String name, PolicyIpsecVpnLocalEndpointArgs args, CustomResourceOptions options)
type: nsxt:PolicyIpsecVpnLocalEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PolicyIpsecVpnLocalEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. PolicyIpsecVpnLocalEndpointArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. PolicyIpsecVpnLocalEndpointArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PolicyIpsecVpnLocalEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PolicyIpsecVpnLocalEndpointArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var policyIpsecVpnLocalEndpointResource = new Nsxt.PolicyIpsecVpnLocalEndpoint("policyIpsecVpnLocalEndpointResource", new()
{
    DisplayName = "string",
    LocalAddress = "string",
    ServicePath = "string",
    CertificatePath = "string",
    Description = "string",
    LocalId = "string",
    NsxId = "string",
    PolicyIpsecVpnLocalEndpointId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyIpsecVpnLocalEndpointTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
    TrustCaPaths = new[]
    {
        "string",
    },
    TrustCrlPaths = new[]
    {
        "string",
    },
});
Copy
example, err := nsxt.NewPolicyIpsecVpnLocalEndpoint(ctx, "policyIpsecVpnLocalEndpointResource", &nsxt.PolicyIpsecVpnLocalEndpointArgs{
DisplayName: pulumi.String("string"),
LocalAddress: pulumi.String("string"),
ServicePath: pulumi.String("string"),
CertificatePath: pulumi.String("string"),
Description: pulumi.String("string"),
LocalId: pulumi.String("string"),
NsxId: pulumi.String("string"),
PolicyIpsecVpnLocalEndpointId: pulumi.String("string"),
Tags: .PolicyIpsecVpnLocalEndpointTagArray{
&.PolicyIpsecVpnLocalEndpointTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
TrustCaPaths: pulumi.StringArray{
pulumi.String("string"),
},
TrustCrlPaths: pulumi.StringArray{
pulumi.String("string"),
},
})
Copy
var policyIpsecVpnLocalEndpointResource = new PolicyIpsecVpnLocalEndpoint("policyIpsecVpnLocalEndpointResource", PolicyIpsecVpnLocalEndpointArgs.builder()
    .displayName("string")
    .localAddress("string")
    .servicePath("string")
    .certificatePath("string")
    .description("string")
    .localId("string")
    .nsxId("string")
    .policyIpsecVpnLocalEndpointId("string")
    .tags(PolicyIpsecVpnLocalEndpointTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .trustCaPaths("string")
    .trustCrlPaths("string")
    .build());
Copy
policy_ipsec_vpn_local_endpoint_resource = nsxt.PolicyIpsecVpnLocalEndpoint("policyIpsecVpnLocalEndpointResource",
    display_name="string",
    local_address="string",
    service_path="string",
    certificate_path="string",
    description="string",
    local_id="string",
    nsx_id="string",
    policy_ipsec_vpn_local_endpoint_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }],
    trust_ca_paths=["string"],
    trust_crl_paths=["string"])
Copy
const policyIpsecVpnLocalEndpointResource = new nsxt.PolicyIpsecVpnLocalEndpoint("policyIpsecVpnLocalEndpointResource", {
    displayName: "string",
    localAddress: "string",
    servicePath: "string",
    certificatePath: "string",
    description: "string",
    localId: "string",
    nsxId: "string",
    policyIpsecVpnLocalEndpointId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
    trustCaPaths: ["string"],
    trustCrlPaths: ["string"],
});
Copy
type: nsxt:PolicyIpsecVpnLocalEndpoint
properties:
    certificatePath: string
    description: string
    displayName: string
    localAddress: string
    localId: string
    nsxId: string
    policyIpsecVpnLocalEndpointId: string
    servicePath: string
    tags:
        - scope: string
          tag: string
    trustCaPaths:
        - string
    trustCrlPaths:
        - string
Copy

PolicyIpsecVpnLocalEndpoint Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The PolicyIpsecVpnLocalEndpoint resource accepts the following input properties:

DisplayName This property is required. string
Display name of the resource.
LocalAddress This property is required. string
Local IPv4 IP address.
ServicePath This property is required. string
Policy path for IPSec VPN service
CertificatePath string
Policy path referencing site certificate.
Description string
Description of the resource.
LocalId string
Local id for the local endpoint.
NsxId string
The NSX ID of this resource. If set, this ID will be used to create the resource.
PolicyIpsecVpnLocalEndpointId string
ID of the resource.
Tags List<PolicyIpsecVpnLocalEndpointTag>
A list of scope + tag pairs to associate with this resource.
TrustCaPaths List<string>
List of trust ca certificate paths.
TrustCrlPaths List<string>
List of trust CRL paths.
DisplayName This property is required. string
Display name of the resource.
LocalAddress This property is required. string
Local IPv4 IP address.
ServicePath This property is required. string
Policy path for IPSec VPN service
CertificatePath string
Policy path referencing site certificate.
Description string
Description of the resource.
LocalId string
Local id for the local endpoint.
NsxId string
The NSX ID of this resource. If set, this ID will be used to create the resource.
PolicyIpsecVpnLocalEndpointId string
ID of the resource.
Tags []PolicyIpsecVpnLocalEndpointTagArgs
A list of scope + tag pairs to associate with this resource.
TrustCaPaths []string
List of trust ca certificate paths.
TrustCrlPaths []string
List of trust CRL paths.
displayName This property is required. String
Display name of the resource.
localAddress This property is required. String
Local IPv4 IP address.
servicePath This property is required. String
Policy path for IPSec VPN service
certificatePath String
Policy path referencing site certificate.
description String
Description of the resource.
localId String
Local id for the local endpoint.
nsxId String
The NSX ID of this resource. If set, this ID will be used to create the resource.
policyIpsecVpnLocalEndpointId String
ID of the resource.
tags List<PolicyIpsecVpnLocalEndpointTag>
A list of scope + tag pairs to associate with this resource.
trustCaPaths List<String>
List of trust ca certificate paths.
trustCrlPaths List<String>
List of trust CRL paths.
displayName This property is required. string
Display name of the resource.
localAddress This property is required. string
Local IPv4 IP address.
servicePath This property is required. string
Policy path for IPSec VPN service
certificatePath string
Policy path referencing site certificate.
description string
Description of the resource.
localId string
Local id for the local endpoint.
nsxId string
The NSX ID of this resource. If set, this ID will be used to create the resource.
policyIpsecVpnLocalEndpointId string
ID of the resource.
tags PolicyIpsecVpnLocalEndpointTag[]
A list of scope + tag pairs to associate with this resource.
trustCaPaths string[]
List of trust ca certificate paths.
trustCrlPaths string[]
List of trust CRL paths.
display_name This property is required. str
Display name of the resource.
local_address This property is required. str
Local IPv4 IP address.
service_path This property is required. str
Policy path for IPSec VPN service
certificate_path str
Policy path referencing site certificate.
description str
Description of the resource.
local_id str
Local id for the local endpoint.
nsx_id str
The NSX ID of this resource. If set, this ID will be used to create the resource.
policy_ipsec_vpn_local_endpoint_id str
ID of the resource.
tags Sequence[PolicyIpsecVpnLocalEndpointTagArgs]
A list of scope + tag pairs to associate with this resource.
trust_ca_paths Sequence[str]
List of trust ca certificate paths.
trust_crl_paths Sequence[str]
List of trust CRL paths.
displayName This property is required. String
Display name of the resource.
localAddress This property is required. String
Local IPv4 IP address.
servicePath This property is required. String
Policy path for IPSec VPN service
certificatePath String
Policy path referencing site certificate.
description String
Description of the resource.
localId String
Local id for the local endpoint.
nsxId String
The NSX ID of this resource. If set, this ID will be used to create the resource.
policyIpsecVpnLocalEndpointId String
ID of the resource.
tags List<Property Map>
A list of scope + tag pairs to associate with this resource.
trustCaPaths List<String>
List of trust ca certificate paths.
trustCrlPaths List<String>
List of trust CRL paths.

Outputs

All input properties are implicitly available as output properties. Additionally, the PolicyIpsecVpnLocalEndpoint resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Path string
The NSX path of the policy resource.
Revision double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
Id string
The provider-assigned unique ID for this managed resource.
Path string
The NSX path of the policy resource.
Revision float64
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
id String
The provider-assigned unique ID for this managed resource.
path String
The NSX path of the policy resource.
revision Double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
id string
The provider-assigned unique ID for this managed resource.
path string
The NSX path of the policy resource.
revision number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
id str
The provider-assigned unique ID for this managed resource.
path str
The NSX path of the policy resource.
revision float
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
id String
The provider-assigned unique ID for this managed resource.
path String
The NSX path of the policy resource.
revision Number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.

Look up Existing PolicyIpsecVpnLocalEndpoint Resource

Get an existing PolicyIpsecVpnLocalEndpoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PolicyIpsecVpnLocalEndpointState, opts?: CustomResourceOptions): PolicyIpsecVpnLocalEndpoint
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        certificate_path: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        local_address: Optional[str] = None,
        local_id: Optional[str] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_ipsec_vpn_local_endpoint_id: Optional[str] = None,
        revision: Optional[float] = None,
        service_path: Optional[str] = None,
        tags: Optional[Sequence[PolicyIpsecVpnLocalEndpointTagArgs]] = None,
        trust_ca_paths: Optional[Sequence[str]] = None,
        trust_crl_paths: Optional[Sequence[str]] = None) -> PolicyIpsecVpnLocalEndpoint
func GetPolicyIpsecVpnLocalEndpoint(ctx *Context, name string, id IDInput, state *PolicyIpsecVpnLocalEndpointState, opts ...ResourceOption) (*PolicyIpsecVpnLocalEndpoint, error)
public static PolicyIpsecVpnLocalEndpoint Get(string name, Input<string> id, PolicyIpsecVpnLocalEndpointState? state, CustomResourceOptions? opts = null)
public static PolicyIpsecVpnLocalEndpoint get(String name, Output<String> id, PolicyIpsecVpnLocalEndpointState state, CustomResourceOptions options)
resources:  _:    type: nsxt:PolicyIpsecVpnLocalEndpoint    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CertificatePath string
Policy path referencing site certificate.
Description string
Description of the resource.
DisplayName string
Display name of the resource.
LocalAddress string
Local IPv4 IP address.
LocalId string
Local id for the local endpoint.
NsxId string
The NSX ID of this resource. If set, this ID will be used to create the resource.
Path string
The NSX path of the policy resource.
PolicyIpsecVpnLocalEndpointId string
ID of the resource.
Revision double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
ServicePath string
Policy path for IPSec VPN service
Tags List<PolicyIpsecVpnLocalEndpointTag>
A list of scope + tag pairs to associate with this resource.
TrustCaPaths List<string>
List of trust ca certificate paths.
TrustCrlPaths List<string>
List of trust CRL paths.
CertificatePath string
Policy path referencing site certificate.
Description string
Description of the resource.
DisplayName string
Display name of the resource.
LocalAddress string
Local IPv4 IP address.
LocalId string
Local id for the local endpoint.
NsxId string
The NSX ID of this resource. If set, this ID will be used to create the resource.
Path string
The NSX path of the policy resource.
PolicyIpsecVpnLocalEndpointId string
ID of the resource.
Revision float64
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
ServicePath string
Policy path for IPSec VPN service
Tags []PolicyIpsecVpnLocalEndpointTagArgs
A list of scope + tag pairs to associate with this resource.
TrustCaPaths []string
List of trust ca certificate paths.
TrustCrlPaths []string
List of trust CRL paths.
certificatePath String
Policy path referencing site certificate.
description String
Description of the resource.
displayName String
Display name of the resource.
localAddress String
Local IPv4 IP address.
localId String
Local id for the local endpoint.
nsxId String
The NSX ID of this resource. If set, this ID will be used to create the resource.
path String
The NSX path of the policy resource.
policyIpsecVpnLocalEndpointId String
ID of the resource.
revision Double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
servicePath String
Policy path for IPSec VPN service
tags List<PolicyIpsecVpnLocalEndpointTag>
A list of scope + tag pairs to associate with this resource.
trustCaPaths List<String>
List of trust ca certificate paths.
trustCrlPaths List<String>
List of trust CRL paths.
certificatePath string
Policy path referencing site certificate.
description string
Description of the resource.
displayName string
Display name of the resource.
localAddress string
Local IPv4 IP address.
localId string
Local id for the local endpoint.
nsxId string
The NSX ID of this resource. If set, this ID will be used to create the resource.
path string
The NSX path of the policy resource.
policyIpsecVpnLocalEndpointId string
ID of the resource.
revision number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
servicePath string
Policy path for IPSec VPN service
tags PolicyIpsecVpnLocalEndpointTag[]
A list of scope + tag pairs to associate with this resource.
trustCaPaths string[]
List of trust ca certificate paths.
trustCrlPaths string[]
List of trust CRL paths.
certificate_path str
Policy path referencing site certificate.
description str
Description of the resource.
display_name str
Display name of the resource.
local_address str
Local IPv4 IP address.
local_id str
Local id for the local endpoint.
nsx_id str
The NSX ID of this resource. If set, this ID will be used to create the resource.
path str
The NSX path of the policy resource.
policy_ipsec_vpn_local_endpoint_id str
ID of the resource.
revision float
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
service_path str
Policy path for IPSec VPN service
tags Sequence[PolicyIpsecVpnLocalEndpointTagArgs]
A list of scope + tag pairs to associate with this resource.
trust_ca_paths Sequence[str]
List of trust ca certificate paths.
trust_crl_paths Sequence[str]
List of trust CRL paths.
certificatePath String
Policy path referencing site certificate.
description String
Description of the resource.
displayName String
Display name of the resource.
localAddress String
Local IPv4 IP address.
localId String
Local id for the local endpoint.
nsxId String
The NSX ID of this resource. If set, this ID will be used to create the resource.
path String
The NSX path of the policy resource.
policyIpsecVpnLocalEndpointId String
ID of the resource.
revision Number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
servicePath String
Policy path for IPSec VPN service
tags List<Property Map>
A list of scope + tag pairs to associate with this resource.
trustCaPaths List<String>
List of trust ca certificate paths.
trustCrlPaths List<String>
List of trust CRL paths.

Supporting Types

PolicyIpsecVpnLocalEndpointTag
, PolicyIpsecVpnLocalEndpointTagArgs

Scope string
Tag string
A list of scope + tag pairs to associate with this resource.
Scope string
Tag string
A list of scope + tag pairs to associate with this resource.
scope String
tag String
A list of scope + tag pairs to associate with this resource.
scope string
tag string
A list of scope + tag pairs to associate with this resource.
scope str
tag str
A list of scope + tag pairs to associate with this resource.
scope String
tag String
A list of scope + tag pairs to associate with this resource.

Package Details

Repository
nsxt vmware/terraform-provider-nsxt
License
Notes
This Pulumi package is based on the nsxt Terraform Provider.