Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. PolicyIpsecVpnDpdProfile
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.PolicyIpsecVpnDpdProfile

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

    Create PolicyIpsecVpnDpdProfile Resource

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

    Constructor syntax

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

@overload
def PolicyIpsecVpnDpdProfile(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             display_name: Optional[str] = None,
                             description: Optional[str] = None,
                             dpd_probe_interval: Optional[float] = None,
                             dpd_probe_mode: Optional[str] = None,
                             enabled: Optional[bool] = None,
                             nsx_id: Optional[str] = None,
                             policy_ipsec_vpn_dpd_profile_id: Optional[str] = None,
                             retry_count: Optional[float] = None,
                             tags: Optional[Sequence[PolicyIpsecVpnDpdProfileTagArgs]] = None)
    func NewPolicyIpsecVpnDpdProfile(ctx *Context, name string, args PolicyIpsecVpnDpdProfileArgs, opts ...ResourceOption) (*PolicyIpsecVpnDpdProfile, error)
    public PolicyIpsecVpnDpdProfile(string name, PolicyIpsecVpnDpdProfileArgs args, CustomResourceOptions? opts = null)
    public PolicyIpsecVpnDpdProfile(String name, PolicyIpsecVpnDpdProfileArgs args)
public PolicyIpsecVpnDpdProfile(String name, PolicyIpsecVpnDpdProfileArgs args, CustomResourceOptions options)

    type: nsxt:PolicyIpsecVpnDpdProfile
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PolicyIpsecVpnDpdProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PolicyIpsecVpnDpdProfileArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PolicyIpsecVpnDpdProfileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyIpsecVpnDpdProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyIpsecVpnDpdProfileArgs
    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 policyIpsecVpnDpdProfileResource = new Nsxt.PolicyIpsecVpnDpdProfile("policyIpsecVpnDpdProfileResource", new()
{
    DisplayName = "string",
    Description = "string",
    DpdProbeInterval = 0,
    DpdProbeMode = "string",
    Enabled = false,
    NsxId = "string",
    PolicyIpsecVpnDpdProfileId = "string",
    RetryCount = 0,
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyIpsecVpnDpdProfileTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewPolicyIpsecVpnDpdProfile(ctx, "policyIpsecVpnDpdProfileResource", &nsxt.PolicyIpsecVpnDpdProfileArgs{
	DisplayName:                pulumi.String("string"),
	Description:                pulumi.String("string"),
	DpdProbeInterval:           pulumi.Float64(0),
	DpdProbeMode:               pulumi.String("string"),
	Enabled:                    pulumi.Bool(false),
	NsxId:                      pulumi.String("string"),
	PolicyIpsecVpnDpdProfileId: pulumi.String("string"),
	RetryCount:                 pulumi.Float64(0),
	Tags: nsxt.PolicyIpsecVpnDpdProfileTagArray{
		&nsxt.PolicyIpsecVpnDpdProfileTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    var policyIpsecVpnDpdProfileResource = new PolicyIpsecVpnDpdProfile("policyIpsecVpnDpdProfileResource", PolicyIpsecVpnDpdProfileArgs.builder()
    .displayName("string")
    .description("string")
    .dpdProbeInterval(0)
    .dpdProbeMode("string")
    .enabled(false)
    .nsxId("string")
    .policyIpsecVpnDpdProfileId("string")
    .retryCount(0)
    .tags(PolicyIpsecVpnDpdProfileTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    policy_ipsec_vpn_dpd_profile_resource = nsxt.PolicyIpsecVpnDpdProfile("policyIpsecVpnDpdProfileResource",
    display_name="string",
    description="string",
    dpd_probe_interval=0,
    dpd_probe_mode="string",
    enabled=False,
    nsx_id="string",
    policy_ipsec_vpn_dpd_profile_id="string",
    retry_count=0,
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const policyIpsecVpnDpdProfileResource = new nsxt.PolicyIpsecVpnDpdProfile("policyIpsecVpnDpdProfileResource", {
    displayName: "string",
    description: "string",
    dpdProbeInterval: 0,
    dpdProbeMode: "string",
    enabled: false,
    nsxId: "string",
    policyIpsecVpnDpdProfileId: "string",
    retryCount: 0,
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:PolicyIpsecVpnDpdProfile
properties:
    description: string
    displayName: string
    dpdProbeInterval: 0
    dpdProbeMode: string
    enabled: false
    nsxId: string
    policyIpsecVpnDpdProfileId: string
    retryCount: 0
    tags:
        - scope: string
          tag: string

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

    DisplayName string
    Display name of the resource.
    Description string
    Description of the resource.
    DpdProbeInterval double
    Probe interval in seconds. Default is 60.
    DpdProbeMode string
    DPD Probe Mode, one of PERIODIC, ON_DEMAND. Periodic mode is used to query the liveliness of the peer at regular intervals (dpd_probe_interval seconds). On-demand mode would trigger DPD message if there is traffic to send to the peer AND the peer was idle for dpd_probe_interval seconds. Default is PERIODIC.
    Enabled bool
    Enabled Dead Peer Detection. Default is True.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyIpsecVpnDpdProfileId string
    ID of the resource.
    RetryCount double
    Maximum number of DPD retry attempts. Default is 10.
    Tags List<PolicyIpsecVpnDpdProfileTag>
    A list of scope + tag pairs to associate with this resource.
    DisplayName string
    Display name of the resource.
    Description string
    Description of the resource.
    DpdProbeInterval float64
    Probe interval in seconds. Default is 60.
    DpdProbeMode string
    DPD Probe Mode, one of PERIODIC, ON_DEMAND. Periodic mode is used to query the liveliness of the peer at regular intervals (dpd_probe_interval seconds). On-demand mode would trigger DPD message if there is traffic to send to the peer AND the peer was idle for dpd_probe_interval seconds. Default is PERIODIC.
    Enabled bool
    Enabled Dead Peer Detection. Default is True.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyIpsecVpnDpdProfileId string
    ID of the resource.
    RetryCount float64
    Maximum number of DPD retry attempts. Default is 10.
    Tags []PolicyIpsecVpnDpdProfileTagArgs
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    description String
    Description of the resource.
    dpdProbeInterval Double
    Probe interval in seconds. Default is 60.
    dpdProbeMode String
    DPD Probe Mode, one of PERIODIC, ON_DEMAND. Periodic mode is used to query the liveliness of the peer at regular intervals (dpd_probe_interval seconds). On-demand mode would trigger DPD message if there is traffic to send to the peer AND the peer was idle for dpd_probe_interval seconds. Default is PERIODIC.
    enabled Boolean
    Enabled Dead Peer Detection. Default is True.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyIpsecVpnDpdProfileId String
    ID of the resource.
    retryCount Double
    Maximum number of DPD retry attempts. Default is 10.
    tags List<PolicyIpsecVpnDpdProfileTag>
    A list of scope + tag pairs to associate with this resource.
    displayName string
    Display name of the resource.
    description string
    Description of the resource.
    dpdProbeInterval number
    Probe interval in seconds. Default is 60.
    dpdProbeMode string
    DPD Probe Mode, one of PERIODIC, ON_DEMAND. Periodic mode is used to query the liveliness of the peer at regular intervals (dpd_probe_interval seconds). On-demand mode would trigger DPD message if there is traffic to send to the peer AND the peer was idle for dpd_probe_interval seconds. Default is PERIODIC.
    enabled boolean
    Enabled Dead Peer Detection. Default is True.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyIpsecVpnDpdProfileId string
    ID of the resource.
    retryCount number
    Maximum number of DPD retry attempts. Default is 10.
    tags PolicyIpsecVpnDpdProfileTag[]
    A list of scope + tag pairs to associate with this resource.
    display_name str
    Display name of the resource.
    description str
    Description of the resource.
    dpd_probe_interval float
    Probe interval in seconds. Default is 60.
    dpd_probe_mode str
    DPD Probe Mode, one of PERIODIC, ON_DEMAND. Periodic mode is used to query the liveliness of the peer at regular intervals (dpd_probe_interval seconds). On-demand mode would trigger DPD message if there is traffic to send to the peer AND the peer was idle for dpd_probe_interval seconds. Default is PERIODIC.
    enabled bool
    Enabled Dead Peer Detection. Default is True.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policy_ipsec_vpn_dpd_profile_id str
    ID of the resource.
    retry_count float
    Maximum number of DPD retry attempts. Default is 10.
    tags Sequence[PolicyIpsecVpnDpdProfileTagArgs]
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    description String
    Description of the resource.
    dpdProbeInterval Number
    Probe interval in seconds. Default is 60.
    dpdProbeMode String
    DPD Probe Mode, one of PERIODIC, ON_DEMAND. Periodic mode is used to query the liveliness of the peer at regular intervals (dpd_probe_interval seconds). On-demand mode would trigger DPD message if there is traffic to send to the peer AND the peer was idle for dpd_probe_interval seconds. Default is PERIODIC.
    enabled Boolean
    Enabled Dead Peer Detection. Default is True.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyIpsecVpnDpdProfileId String
    ID of the resource.
    retryCount Number
    Maximum number of DPD retry attempts. Default is 10.
    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 PolicyIpsecVpnDpdProfile 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 PolicyIpsecVpnDpdProfile Resource

    Get an existing PolicyIpsecVpnDpdProfile 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?: PolicyIpsecVpnDpdProfileState, opts?: CustomResourceOptions): PolicyIpsecVpnDpdProfile
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        dpd_probe_interval: Optional[float] = None,
        dpd_probe_mode: Optional[str] = None,
        enabled: Optional[bool] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_ipsec_vpn_dpd_profile_id: Optional[str] = None,
        retry_count: Optional[float] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[PolicyIpsecVpnDpdProfileTagArgs]] = None) -> PolicyIpsecVpnDpdProfile
    func GetPolicyIpsecVpnDpdProfile(ctx *Context, name string, id IDInput, state *PolicyIpsecVpnDpdProfileState, opts ...ResourceOption) (*PolicyIpsecVpnDpdProfile, error)
    public static PolicyIpsecVpnDpdProfile Get(string name, Input<string> id, PolicyIpsecVpnDpdProfileState? state, CustomResourceOptions? opts = null)
    public static PolicyIpsecVpnDpdProfile get(String name, Output<String> id, PolicyIpsecVpnDpdProfileState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyIpsecVpnDpdProfile    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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.
    DisplayName string
    Display name of the resource.
    DpdProbeInterval double
    Probe interval in seconds. Default is 60.
    DpdProbeMode string
    DPD Probe Mode, one of PERIODIC, ON_DEMAND. Periodic mode is used to query the liveliness of the peer at regular intervals (dpd_probe_interval seconds). On-demand mode would trigger DPD message if there is traffic to send to the peer AND the peer was idle for dpd_probe_interval seconds. Default is PERIODIC.
    Enabled bool
    Enabled Dead Peer Detection. Default is True.
    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.
    PolicyIpsecVpnDpdProfileId string
    ID of the resource.
    RetryCount double
    Maximum number of DPD retry attempts. Default is 10.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags List<PolicyIpsecVpnDpdProfileTag>
    A list of scope + tag pairs to associate with this resource.
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    DpdProbeInterval float64
    Probe interval in seconds. Default is 60.
    DpdProbeMode string
    DPD Probe Mode, one of PERIODIC, ON_DEMAND. Periodic mode is used to query the liveliness of the peer at regular intervals (dpd_probe_interval seconds). On-demand mode would trigger DPD message if there is traffic to send to the peer AND the peer was idle for dpd_probe_interval seconds. Default is PERIODIC.
    Enabled bool
    Enabled Dead Peer Detection. Default is True.
    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.
    PolicyIpsecVpnDpdProfileId string
    ID of the resource.
    RetryCount float64
    Maximum number of DPD retry attempts. Default is 10.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags []PolicyIpsecVpnDpdProfileTagArgs
    A list of scope + tag pairs to associate with this resource.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    dpdProbeInterval Double
    Probe interval in seconds. Default is 60.
    dpdProbeMode String
    DPD Probe Mode, one of PERIODIC, ON_DEMAND. Periodic mode is used to query the liveliness of the peer at regular intervals (dpd_probe_interval seconds). On-demand mode would trigger DPD message if there is traffic to send to the peer AND the peer was idle for dpd_probe_interval seconds. Default is PERIODIC.
    enabled Boolean
    Enabled Dead Peer Detection. Default is True.
    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.
    policyIpsecVpnDpdProfileId String
    ID of the resource.
    retryCount Double
    Maximum number of DPD retry attempts. Default is 10.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags List<PolicyIpsecVpnDpdProfileTag>
    A list of scope + tag pairs to associate with this resource.
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    dpdProbeInterval number
    Probe interval in seconds. Default is 60.
    dpdProbeMode string
    DPD Probe Mode, one of PERIODIC, ON_DEMAND. Periodic mode is used to query the liveliness of the peer at regular intervals (dpd_probe_interval seconds). On-demand mode would trigger DPD message if there is traffic to send to the peer AND the peer was idle for dpd_probe_interval seconds. Default is PERIODIC.
    enabled boolean
    Enabled Dead Peer Detection. Default is True.
    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.
    policyIpsecVpnDpdProfileId string
    ID of the resource.
    retryCount number
    Maximum number of DPD retry attempts. Default is 10.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags PolicyIpsecVpnDpdProfileTag[]
    A list of scope + tag pairs to associate with this resource.
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    dpd_probe_interval float
    Probe interval in seconds. Default is 60.
    dpd_probe_mode str
    DPD Probe Mode, one of PERIODIC, ON_DEMAND. Periodic mode is used to query the liveliness of the peer at regular intervals (dpd_probe_interval seconds). On-demand mode would trigger DPD message if there is traffic to send to the peer AND the peer was idle for dpd_probe_interval seconds. Default is PERIODIC.
    enabled bool
    Enabled Dead Peer Detection. Default is True.
    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_dpd_profile_id str
    ID of the resource.
    retry_count float
    Maximum number of DPD retry attempts. Default is 10.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags Sequence[PolicyIpsecVpnDpdProfileTagArgs]
    A list of scope + tag pairs to associate with this resource.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    dpdProbeInterval Number
    Probe interval in seconds. Default is 60.
    dpdProbeMode String
    DPD Probe Mode, one of PERIODIC, ON_DEMAND. Periodic mode is used to query the liveliness of the peer at regular intervals (dpd_probe_interval seconds). On-demand mode would trigger DPD message if there is traffic to send to the peer AND the peer was idle for dpd_probe_interval seconds. Default is PERIODIC.
    enabled Boolean
    Enabled Dead Peer Detection. Default is True.
    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.
    policyIpsecVpnDpdProfileId String
    ID of the resource.
    retryCount Number
    Maximum number of DPD retry attempts. Default is 10.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.

    Supporting Types

    PolicyIpsecVpnDpdProfileTag, PolicyIpsecVpnDpdProfileTagArgs

    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.
    nsxt logo
    nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
    vmware/terraform-provider-nsxt