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

nsxt.PolicyIpsecVpnIkeProfile

Explore with Pulumi AI

Create PolicyIpsecVpnIkeProfile Resource

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

Constructor syntax

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

@overload
def PolicyIpsecVpnIkeProfile(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             dh_groups: Optional[Sequence[str]] = None,
                             display_name: Optional[str] = None,
                             encryption_algorithms: Optional[Sequence[str]] = None,
                             description: Optional[str] = None,
                             digest_algorithms: Optional[Sequence[str]] = None,
                             ike_version: Optional[str] = None,
                             nsx_id: Optional[str] = None,
                             policy_ipsec_vpn_ike_profile_id: Optional[str] = None,
                             sa_life_time: Optional[float] = None,
                             tags: Optional[Sequence[PolicyIpsecVpnIkeProfileTagArgs]] = None)
func NewPolicyIpsecVpnIkeProfile(ctx *Context, name string, args PolicyIpsecVpnIkeProfileArgs, opts ...ResourceOption) (*PolicyIpsecVpnIkeProfile, error)
public PolicyIpsecVpnIkeProfile(string name, PolicyIpsecVpnIkeProfileArgs args, CustomResourceOptions? opts = null)
public PolicyIpsecVpnIkeProfile(String name, PolicyIpsecVpnIkeProfileArgs args)
public PolicyIpsecVpnIkeProfile(String name, PolicyIpsecVpnIkeProfileArgs args, CustomResourceOptions options)
type: nsxt:PolicyIpsecVpnIkeProfile
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. PolicyIpsecVpnIkeProfileArgs
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. PolicyIpsecVpnIkeProfileArgs
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. PolicyIpsecVpnIkeProfileArgs
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. PolicyIpsecVpnIkeProfileArgs
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. PolicyIpsecVpnIkeProfileArgs
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 policyIpsecVpnIkeProfileResource = new Nsxt.PolicyIpsecVpnIkeProfile("policyIpsecVpnIkeProfileResource", new()
{
    DhGroups = new[]
    {
        "string",
    },
    DisplayName = "string",
    EncryptionAlgorithms = new[]
    {
        "string",
    },
    Description = "string",
    DigestAlgorithms = new[]
    {
        "string",
    },
    IkeVersion = "string",
    NsxId = "string",
    PolicyIpsecVpnIkeProfileId = "string",
    SaLifeTime = 0,
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyIpsecVpnIkeProfileTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});
Copy
example, err := nsxt.NewPolicyIpsecVpnIkeProfile(ctx, "policyIpsecVpnIkeProfileResource", &nsxt.PolicyIpsecVpnIkeProfileArgs{
DhGroups: pulumi.StringArray{
pulumi.String("string"),
},
DisplayName: pulumi.String("string"),
EncryptionAlgorithms: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
DigestAlgorithms: pulumi.StringArray{
pulumi.String("string"),
},
IkeVersion: pulumi.String("string"),
NsxId: pulumi.String("string"),
PolicyIpsecVpnIkeProfileId: pulumi.String("string"),
SaLifeTime: pulumi.Float64(0),
Tags: .PolicyIpsecVpnIkeProfileTagArray{
&.PolicyIpsecVpnIkeProfileTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
})
Copy
var policyIpsecVpnIkeProfileResource = new PolicyIpsecVpnIkeProfile("policyIpsecVpnIkeProfileResource", PolicyIpsecVpnIkeProfileArgs.builder()
    .dhGroups("string")
    .displayName("string")
    .encryptionAlgorithms("string")
    .description("string")
    .digestAlgorithms("string")
    .ikeVersion("string")
    .nsxId("string")
    .policyIpsecVpnIkeProfileId("string")
    .saLifeTime(0)
    .tags(PolicyIpsecVpnIkeProfileTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());
Copy
policy_ipsec_vpn_ike_profile_resource = nsxt.PolicyIpsecVpnIkeProfile("policyIpsecVpnIkeProfileResource",
    dh_groups=["string"],
    display_name="string",
    encryption_algorithms=["string"],
    description="string",
    digest_algorithms=["string"],
    ike_version="string",
    nsx_id="string",
    policy_ipsec_vpn_ike_profile_id="string",
    sa_life_time=0,
    tags=[{
        "scope": "string",
        "tag": "string",
    }])
Copy
const policyIpsecVpnIkeProfileResource = new nsxt.PolicyIpsecVpnIkeProfile("policyIpsecVpnIkeProfileResource", {
    dhGroups: ["string"],
    displayName: "string",
    encryptionAlgorithms: ["string"],
    description: "string",
    digestAlgorithms: ["string"],
    ikeVersion: "string",
    nsxId: "string",
    policyIpsecVpnIkeProfileId: "string",
    saLifeTime: 0,
    tags: [{
        scope: "string",
        tag: "string",
    }],
});
Copy
type: nsxt:PolicyIpsecVpnIkeProfile
properties:
    description: string
    dhGroups:
        - string
    digestAlgorithms:
        - string
    displayName: string
    encryptionAlgorithms:
        - string
    ikeVersion: string
    nsxId: string
    policyIpsecVpnIkeProfileId: string
    saLifeTime: 0
    tags:
        - scope: string
          tag: string
Copy

PolicyIpsecVpnIkeProfile 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 PolicyIpsecVpnIkeProfile resource accepts the following input properties:

DhGroups This property is required. List<string>
Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.
DisplayName This property is required. string
Display name of the resource.
EncryptionAlgorithms This property is required. List<string>
Set of encryption algorithms to be used during IKE negotiation.
Description string
Description of the resource.
DigestAlgorithms List<string>
Set of algorithms to be used for message digest during IKE negotiation. Default is SHA2_256.
IkeVersion string
Internet Key Exchange(IKE) protocol version to be used, one of IKE_V1, IKE_V2, IKE_FLEX. IKE_FLEX will initiate IKE-V2 and respond to both IKE_V1 and IKE_V2.
NsxId string
The NSX ID of this resource. If set, this ID will be used to create the resource.
PolicyIpsecVpnIkeProfileId string
ID of the resource.
SaLifeTime double
Life time for security association.
Tags List<PolicyIpsecVpnIkeProfileTag>
A list of scope + tag pairs to associate with this resource.
DhGroups This property is required. []string
Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.
DisplayName This property is required. string
Display name of the resource.
EncryptionAlgorithms This property is required. []string
Set of encryption algorithms to be used during IKE negotiation.
Description string
Description of the resource.
DigestAlgorithms []string
Set of algorithms to be used for message digest during IKE negotiation. Default is SHA2_256.
IkeVersion string
Internet Key Exchange(IKE) protocol version to be used, one of IKE_V1, IKE_V2, IKE_FLEX. IKE_FLEX will initiate IKE-V2 and respond to both IKE_V1 and IKE_V2.
NsxId string
The NSX ID of this resource. If set, this ID will be used to create the resource.
PolicyIpsecVpnIkeProfileId string
ID of the resource.
SaLifeTime float64
Life time for security association.
Tags []PolicyIpsecVpnIkeProfileTagArgs
A list of scope + tag pairs to associate with this resource.
dhGroups This property is required. List<String>
Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.
displayName This property is required. String
Display name of the resource.
encryptionAlgorithms This property is required. List<String>
Set of encryption algorithms to be used during IKE negotiation.
description String
Description of the resource.
digestAlgorithms List<String>
Set of algorithms to be used for message digest during IKE negotiation. Default is SHA2_256.
ikeVersion String
Internet Key Exchange(IKE) protocol version to be used, one of IKE_V1, IKE_V2, IKE_FLEX. IKE_FLEX will initiate IKE-V2 and respond to both IKE_V1 and IKE_V2.
nsxId String
The NSX ID of this resource. If set, this ID will be used to create the resource.
policyIpsecVpnIkeProfileId String
ID of the resource.
saLifeTime Double
Life time for security association.
tags List<PolicyIpsecVpnIkeProfileTag>
A list of scope + tag pairs to associate with this resource.
dhGroups This property is required. string[]
Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.
displayName This property is required. string
Display name of the resource.
encryptionAlgorithms This property is required. string[]
Set of encryption algorithms to be used during IKE negotiation.
description string
Description of the resource.
digestAlgorithms string[]
Set of algorithms to be used for message digest during IKE negotiation. Default is SHA2_256.
ikeVersion string
Internet Key Exchange(IKE) protocol version to be used, one of IKE_V1, IKE_V2, IKE_FLEX. IKE_FLEX will initiate IKE-V2 and respond to both IKE_V1 and IKE_V2.
nsxId string
The NSX ID of this resource. If set, this ID will be used to create the resource.
policyIpsecVpnIkeProfileId string
ID of the resource.
saLifeTime number
Life time for security association.
tags PolicyIpsecVpnIkeProfileTag[]
A list of scope + tag pairs to associate with this resource.
dh_groups This property is required. Sequence[str]
Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.
display_name This property is required. str
Display name of the resource.
encryption_algorithms This property is required. Sequence[str]
Set of encryption algorithms to be used during IKE negotiation.
description str
Description of the resource.
digest_algorithms Sequence[str]
Set of algorithms to be used for message digest during IKE negotiation. Default is SHA2_256.
ike_version str
Internet Key Exchange(IKE) protocol version to be used, one of IKE_V1, IKE_V2, IKE_FLEX. IKE_FLEX will initiate IKE-V2 and respond to both IKE_V1 and IKE_V2.
nsx_id str
The NSX ID of this resource. If set, this ID will be used to create the resource.
policy_ipsec_vpn_ike_profile_id str
ID of the resource.
sa_life_time float
Life time for security association.
tags Sequence[PolicyIpsecVpnIkeProfileTagArgs]
A list of scope + tag pairs to associate with this resource.
dhGroups This property is required. List<String>
Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.
displayName This property is required. String
Display name of the resource.
encryptionAlgorithms This property is required. List<String>
Set of encryption algorithms to be used during IKE negotiation.
description String
Description of the resource.
digestAlgorithms List<String>
Set of algorithms to be used for message digest during IKE negotiation. Default is SHA2_256.
ikeVersion String
Internet Key Exchange(IKE) protocol version to be used, one of IKE_V1, IKE_V2, IKE_FLEX. IKE_FLEX will initiate IKE-V2 and respond to both IKE_V1 and IKE_V2.
nsxId String
The NSX ID of this resource. If set, this ID will be used to create the resource.
policyIpsecVpnIkeProfileId String
ID of the resource.
saLifeTime Number
Life time for security association.
tags List<Property Map>
A list of scope + tag pairs to associate with this resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the PolicyIpsecVpnIkeProfile 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 PolicyIpsecVpnIkeProfile Resource

Get an existing PolicyIpsecVpnIkeProfile 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?: PolicyIpsecVpnIkeProfileState, opts?: CustomResourceOptions): PolicyIpsecVpnIkeProfile
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        dh_groups: Optional[Sequence[str]] = None,
        digest_algorithms: Optional[Sequence[str]] = None,
        display_name: Optional[str] = None,
        encryption_algorithms: Optional[Sequence[str]] = None,
        ike_version: Optional[str] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_ipsec_vpn_ike_profile_id: Optional[str] = None,
        revision: Optional[float] = None,
        sa_life_time: Optional[float] = None,
        tags: Optional[Sequence[PolicyIpsecVpnIkeProfileTagArgs]] = None) -> PolicyIpsecVpnIkeProfile
func GetPolicyIpsecVpnIkeProfile(ctx *Context, name string, id IDInput, state *PolicyIpsecVpnIkeProfileState, opts ...ResourceOption) (*PolicyIpsecVpnIkeProfile, error)
public static PolicyIpsecVpnIkeProfile Get(string name, Input<string> id, PolicyIpsecVpnIkeProfileState? state, CustomResourceOptions? opts = null)
public static PolicyIpsecVpnIkeProfile get(String name, Output<String> id, PolicyIpsecVpnIkeProfileState state, CustomResourceOptions options)
resources:  _:    type: nsxt:PolicyIpsecVpnIkeProfile    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:
Description string
Description of the resource.
DhGroups List<string>
Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.
DigestAlgorithms List<string>
Set of algorithms to be used for message digest during IKE negotiation. Default is SHA2_256.
DisplayName string
Display name of the resource.
EncryptionAlgorithms List<string>
Set of encryption algorithms to be used during IKE negotiation.
IkeVersion string
Internet Key Exchange(IKE) protocol version to be used, one of IKE_V1, IKE_V2, IKE_FLEX. IKE_FLEX will initiate IKE-V2 and respond to both IKE_V1 and IKE_V2.
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.
PolicyIpsecVpnIkeProfileId 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.
SaLifeTime double
Life time for security association.
Tags List<PolicyIpsecVpnIkeProfileTag>
A list of scope + tag pairs to associate with this resource.
Description string
Description of the resource.
DhGroups []string
Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.
DigestAlgorithms []string
Set of algorithms to be used for message digest during IKE negotiation. Default is SHA2_256.
DisplayName string
Display name of the resource.
EncryptionAlgorithms []string
Set of encryption algorithms to be used during IKE negotiation.
IkeVersion string
Internet Key Exchange(IKE) protocol version to be used, one of IKE_V1, IKE_V2, IKE_FLEX. IKE_FLEX will initiate IKE-V2 and respond to both IKE_V1 and IKE_V2.
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.
PolicyIpsecVpnIkeProfileId 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.
SaLifeTime float64
Life time for security association.
Tags []PolicyIpsecVpnIkeProfileTagArgs
A list of scope + tag pairs to associate with this resource.
description String
Description of the resource.
dhGroups List<String>
Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.
digestAlgorithms List<String>
Set of algorithms to be used for message digest during IKE negotiation. Default is SHA2_256.
displayName String
Display name of the resource.
encryptionAlgorithms List<String>
Set of encryption algorithms to be used during IKE negotiation.
ikeVersion String
Internet Key Exchange(IKE) protocol version to be used, one of IKE_V1, IKE_V2, IKE_FLEX. IKE_FLEX will initiate IKE-V2 and respond to both IKE_V1 and IKE_V2.
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.
policyIpsecVpnIkeProfileId 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.
saLifeTime Double
Life time for security association.
tags List<PolicyIpsecVpnIkeProfileTag>
A list of scope + tag pairs to associate with this resource.
description string
Description of the resource.
dhGroups string[]
Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.
digestAlgorithms string[]
Set of algorithms to be used for message digest during IKE negotiation. Default is SHA2_256.
displayName string
Display name of the resource.
encryptionAlgorithms string[]
Set of encryption algorithms to be used during IKE negotiation.
ikeVersion string
Internet Key Exchange(IKE) protocol version to be used, one of IKE_V1, IKE_V2, IKE_FLEX. IKE_FLEX will initiate IKE-V2 and respond to both IKE_V1 and IKE_V2.
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.
policyIpsecVpnIkeProfileId 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.
saLifeTime number
Life time for security association.
tags PolicyIpsecVpnIkeProfileTag[]
A list of scope + tag pairs to associate with this resource.
description str
Description of the resource.
dh_groups Sequence[str]
Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.
digest_algorithms Sequence[str]
Set of algorithms to be used for message digest during IKE negotiation. Default is SHA2_256.
display_name str
Display name of the resource.
encryption_algorithms Sequence[str]
Set of encryption algorithms to be used during IKE negotiation.
ike_version str
Internet Key Exchange(IKE) protocol version to be used, one of IKE_V1, IKE_V2, IKE_FLEX. IKE_FLEX will initiate IKE-V2 and respond to both IKE_V1 and IKE_V2.
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_ike_profile_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.
sa_life_time float
Life time for security association.
tags Sequence[PolicyIpsecVpnIkeProfileTagArgs]
A list of scope + tag pairs to associate with this resource.
description String
Description of the resource.
dhGroups List<String>
Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.
digestAlgorithms List<String>
Set of algorithms to be used for message digest during IKE negotiation. Default is SHA2_256.
displayName String
Display name of the resource.
encryptionAlgorithms List<String>
Set of encryption algorithms to be used during IKE negotiation.
ikeVersion String
Internet Key Exchange(IKE) protocol version to be used, one of IKE_V1, IKE_V2, IKE_FLEX. IKE_FLEX will initiate IKE-V2 and respond to both IKE_V1 and IKE_V2.
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.
policyIpsecVpnIkeProfileId 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.
saLifeTime Number
Life time for security association.
tags List<Property Map>
A list of scope + tag pairs to associate with this resource.

Supporting Types

PolicyIpsecVpnIkeProfileTag
, PolicyIpsecVpnIkeProfileTagArgs

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.