1. Packages
  2. Nsxt Provider
  3. API Docs
  4. EdgeHighAvailabilityProfile
nsxt 3.10.0 published on Wednesday, Sep 10, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.EdgeHighAvailabilityProfile

Get Started
nsxt logo
nsxt 3.10.0 published on Wednesday, Sep 10, 2025 by vmware
vmware/terraform-provider-nsxt

    Create EdgeHighAvailabilityProfile Resource

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

    Constructor syntax

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

@overload
def EdgeHighAvailabilityProfile(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                display_name: Optional[str] = None,
                                bfd_allowed_hops: Optional[float] = None,
                                bfd_declare_dead_multiple: Optional[float] = None,
                                bfd_probe_interval: Optional[float] = None,
                                description: Optional[str] = None,
                                edge_high_availability_profile_id: Optional[str] = None,
                                standby_relocation_threshold: Optional[float] = None,
                                tags: Optional[Sequence[EdgeHighAvailabilityProfileTagArgs]] = None)
    func NewEdgeHighAvailabilityProfile(ctx *Context, name string, args EdgeHighAvailabilityProfileArgs, opts ...ResourceOption) (*EdgeHighAvailabilityProfile, error)
    public EdgeHighAvailabilityProfile(string name, EdgeHighAvailabilityProfileArgs args, CustomResourceOptions? opts = null)
    public EdgeHighAvailabilityProfile(String name, EdgeHighAvailabilityProfileArgs args)
public EdgeHighAvailabilityProfile(String name, EdgeHighAvailabilityProfileArgs args, CustomResourceOptions options)

    type: nsxt:EdgeHighAvailabilityProfile
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 EdgeHighAvailabilityProfileArgs
    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 EdgeHighAvailabilityProfileArgs
    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 EdgeHighAvailabilityProfileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EdgeHighAvailabilityProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EdgeHighAvailabilityProfileArgs
    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 edgeHighAvailabilityProfileResource = new Nsxt.EdgeHighAvailabilityProfile("edgeHighAvailabilityProfileResource", new()
{
    DisplayName = "string",
    BfdAllowedHops = 0,
    BfdDeclareDeadMultiple = 0,
    BfdProbeInterval = 0,
    Description = "string",
    EdgeHighAvailabilityProfileId = "string",
    StandbyRelocationThreshold = 0,
    Tags = new[]
    {
        new Nsxt.Inputs.EdgeHighAvailabilityProfileTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewEdgeHighAvailabilityProfile(ctx, "edgeHighAvailabilityProfileResource", &nsxt.EdgeHighAvailabilityProfileArgs{
	DisplayName:                   pulumi.String("string"),
	BfdAllowedHops:                pulumi.Float64(0),
	BfdDeclareDeadMultiple:        pulumi.Float64(0),
	BfdProbeInterval:              pulumi.Float64(0),
	Description:                   pulumi.String("string"),
	EdgeHighAvailabilityProfileId: pulumi.String("string"),
	StandbyRelocationThreshold:    pulumi.Float64(0),
	Tags: nsxt.EdgeHighAvailabilityProfileTagArray{
		&nsxt.EdgeHighAvailabilityProfileTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    var edgeHighAvailabilityProfileResource = new EdgeHighAvailabilityProfile("edgeHighAvailabilityProfileResource", EdgeHighAvailabilityProfileArgs.builder()
    .displayName("string")
    .bfdAllowedHops(0.0)
    .bfdDeclareDeadMultiple(0.0)
    .bfdProbeInterval(0.0)
    .description("string")
    .edgeHighAvailabilityProfileId("string")
    .standbyRelocationThreshold(0.0)
    .tags(EdgeHighAvailabilityProfileTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    edge_high_availability_profile_resource = nsxt.EdgeHighAvailabilityProfile("edgeHighAvailabilityProfileResource",
    display_name="string",
    bfd_allowed_hops=0,
    bfd_declare_dead_multiple=0,
    bfd_probe_interval=0,
    description="string",
    edge_high_availability_profile_id="string",
    standby_relocation_threshold=0,
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const edgeHighAvailabilityProfileResource = new nsxt.EdgeHighAvailabilityProfile("edgeHighAvailabilityProfileResource", {
    displayName: "string",
    bfdAllowedHops: 0,
    bfdDeclareDeadMultiple: 0,
    bfdProbeInterval: 0,
    description: "string",
    edgeHighAvailabilityProfileId: "string",
    standbyRelocationThreshold: 0,
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:EdgeHighAvailabilityProfile
properties:
    bfdAllowedHops: 0
    bfdDeclareDeadMultiple: 0
    bfdProbeInterval: 0
    description: string
    displayName: string
    edgeHighAvailabilityProfileId: string
    standbyRelocationThreshold: 0
    tags:
        - scope: string
          tag: string

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

    DisplayName string
    Display name of the resource.
    BfdAllowedHops double
    BFD allowed hops.
    BfdDeclareDeadMultiple double
    Number of times a packet is missed before BFD declares the neighbor down.
    BfdProbeInterval double
    the time interval (in millisecond) between probe packets for heartbeat purpose.
    Description string
    Description of the resource.
    EdgeHighAvailabilityProfileId string
    ID of the resource.
    StandbyRelocationThreshold double
    Standby service context relocation wait time.
    Tags List<EdgeHighAvailabilityProfileTag>
    A list of scope + tag pairs to associate with this resource.
    DisplayName string
    Display name of the resource.
    BfdAllowedHops float64
    BFD allowed hops.
    BfdDeclareDeadMultiple float64
    Number of times a packet is missed before BFD declares the neighbor down.
    BfdProbeInterval float64
    the time interval (in millisecond) between probe packets for heartbeat purpose.
    Description string
    Description of the resource.
    EdgeHighAvailabilityProfileId string
    ID of the resource.
    StandbyRelocationThreshold float64
    Standby service context relocation wait time.
    Tags []EdgeHighAvailabilityProfileTagArgs
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    bfdAllowedHops Double
    BFD allowed hops.
    bfdDeclareDeadMultiple Double
    Number of times a packet is missed before BFD declares the neighbor down.
    bfdProbeInterval Double
    the time interval (in millisecond) between probe packets for heartbeat purpose.
    description String
    Description of the resource.
    edgeHighAvailabilityProfileId String
    ID of the resource.
    standbyRelocationThreshold Double
    Standby service context relocation wait time.
    tags List<EdgeHighAvailabilityProfileTag>
    A list of scope + tag pairs to associate with this resource.
    displayName string
    Display name of the resource.
    bfdAllowedHops number
    BFD allowed hops.
    bfdDeclareDeadMultiple number
    Number of times a packet is missed before BFD declares the neighbor down.
    bfdProbeInterval number
    the time interval (in millisecond) between probe packets for heartbeat purpose.
    description string
    Description of the resource.
    edgeHighAvailabilityProfileId string
    ID of the resource.
    standbyRelocationThreshold number
    Standby service context relocation wait time.
    tags EdgeHighAvailabilityProfileTag[]
    A list of scope + tag pairs to associate with this resource.
    display_name str
    Display name of the resource.
    bfd_allowed_hops float
    BFD allowed hops.
    bfd_declare_dead_multiple float
    Number of times a packet is missed before BFD declares the neighbor down.
    bfd_probe_interval float
    the time interval (in millisecond) between probe packets for heartbeat purpose.
    description str
    Description of the resource.
    edge_high_availability_profile_id str
    ID of the resource.
    standby_relocation_threshold float
    Standby service context relocation wait time.
    tags Sequence[EdgeHighAvailabilityProfileTagArgs]
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    bfdAllowedHops Number
    BFD allowed hops.
    bfdDeclareDeadMultiple Number
    Number of times a packet is missed before BFD declares the neighbor down.
    bfdProbeInterval Number
    the time interval (in millisecond) between probe packets for heartbeat purpose.
    description String
    Description of the resource.
    edgeHighAvailabilityProfileId String
    ID of the resource.
    standbyRelocationThreshold Number
    Standby service context relocation wait time.
    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 EdgeHighAvailabilityProfile resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed 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.
    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.
    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.
    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.
    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.
    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 EdgeHighAvailabilityProfile Resource

    Get an existing EdgeHighAvailabilityProfile 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?: EdgeHighAvailabilityProfileState, opts?: CustomResourceOptions): EdgeHighAvailabilityProfile
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bfd_allowed_hops: Optional[float] = None,
        bfd_declare_dead_multiple: Optional[float] = None,
        bfd_probe_interval: Optional[float] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        edge_high_availability_profile_id: Optional[str] = None,
        revision: Optional[float] = None,
        standby_relocation_threshold: Optional[float] = None,
        tags: Optional[Sequence[EdgeHighAvailabilityProfileTagArgs]] = None) -> EdgeHighAvailabilityProfile
    func GetEdgeHighAvailabilityProfile(ctx *Context, name string, id IDInput, state *EdgeHighAvailabilityProfileState, opts ...ResourceOption) (*EdgeHighAvailabilityProfile, error)
    public static EdgeHighAvailabilityProfile Get(string name, Input<string> id, EdgeHighAvailabilityProfileState? state, CustomResourceOptions? opts = null)
    public static EdgeHighAvailabilityProfile get(String name, Output<String> id, EdgeHighAvailabilityProfileState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:EdgeHighAvailabilityProfile    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:
    BfdAllowedHops double
    BFD allowed hops.
    BfdDeclareDeadMultiple double
    Number of times a packet is missed before BFD declares the neighbor down.
    BfdProbeInterval double
    the time interval (in millisecond) between probe packets for heartbeat purpose.
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    EdgeHighAvailabilityProfileId 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.
    StandbyRelocationThreshold double
    Standby service context relocation wait time.
    Tags List<EdgeHighAvailabilityProfileTag>
    A list of scope + tag pairs to associate with this resource.
    BfdAllowedHops float64
    BFD allowed hops.
    BfdDeclareDeadMultiple float64
    Number of times a packet is missed before BFD declares the neighbor down.
    BfdProbeInterval float64
    the time interval (in millisecond) between probe packets for heartbeat purpose.
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    EdgeHighAvailabilityProfileId 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.
    StandbyRelocationThreshold float64
    Standby service context relocation wait time.
    Tags []EdgeHighAvailabilityProfileTagArgs
    A list of scope + tag pairs to associate with this resource.
    bfdAllowedHops Double
    BFD allowed hops.
    bfdDeclareDeadMultiple Double
    Number of times a packet is missed before BFD declares the neighbor down.
    bfdProbeInterval Double
    the time interval (in millisecond) between probe packets for heartbeat purpose.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    edgeHighAvailabilityProfileId 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.
    standbyRelocationThreshold Double
    Standby service context relocation wait time.
    tags List<EdgeHighAvailabilityProfileTag>
    A list of scope + tag pairs to associate with this resource.
    bfdAllowedHops number
    BFD allowed hops.
    bfdDeclareDeadMultiple number
    Number of times a packet is missed before BFD declares the neighbor down.
    bfdProbeInterval number
    the time interval (in millisecond) between probe packets for heartbeat purpose.
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    edgeHighAvailabilityProfileId 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.
    standbyRelocationThreshold number
    Standby service context relocation wait time.
    tags EdgeHighAvailabilityProfileTag[]
    A list of scope + tag pairs to associate with this resource.
    bfd_allowed_hops float
    BFD allowed hops.
    bfd_declare_dead_multiple float
    Number of times a packet is missed before BFD declares the neighbor down.
    bfd_probe_interval float
    the time interval (in millisecond) between probe packets for heartbeat purpose.
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    edge_high_availability_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.
    standby_relocation_threshold float
    Standby service context relocation wait time.
    tags Sequence[EdgeHighAvailabilityProfileTagArgs]
    A list of scope + tag pairs to associate with this resource.
    bfdAllowedHops Number
    BFD allowed hops.
    bfdDeclareDeadMultiple Number
    Number of times a packet is missed before BFD declares the neighbor down.
    bfdProbeInterval Number
    the time interval (in millisecond) between probe packets for heartbeat purpose.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    edgeHighAvailabilityProfileId 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.
    standbyRelocationThreshold Number
    Standby service context relocation wait time.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.

    Supporting Types

    EdgeHighAvailabilityProfileTag, EdgeHighAvailabilityProfileTagArgs

    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.10.0 published on Wednesday, Sep 10, 2025 by vmware
    vmware/terraform-provider-nsxt
      Meet Neo: Your AI Platform Teammate