Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. PolicyVtepHaHostSwitchProfile
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.PolicyVtepHaHostSwitchProfile

Explore with Pulumi AI

nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt

Create PolicyVtepHaHostSwitchProfile Resource

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

Constructor syntax

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

@overload
def PolicyVtepHaHostSwitchProfile(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  display_name: Optional[str] = None,
                                  auto_recovery: Optional[bool] = None,
                                  auto_recovery_initial_wait: Optional[float] = None,
                                  auto_recovery_max_backoff: Optional[float] = None,
                                  description: Optional[str] = None,
                                  enabled: Optional[bool] = None,
                                  failover_timeout: Optional[float] = None,
                                  nsx_id: Optional[str] = None,
                                  policy_vtep_ha_host_switch_profile_id: Optional[str] = None,
                                  tags: Optional[Sequence[PolicyVtepHaHostSwitchProfileTagArgs]] = None)
func NewPolicyVtepHaHostSwitchProfile(ctx *Context, name string, args PolicyVtepHaHostSwitchProfileArgs, opts ...ResourceOption) (*PolicyVtepHaHostSwitchProfile, error)
public PolicyVtepHaHostSwitchProfile(string name, PolicyVtepHaHostSwitchProfileArgs args, CustomResourceOptions? opts = null)
public PolicyVtepHaHostSwitchProfile(String name, PolicyVtepHaHostSwitchProfileArgs args)
public PolicyVtepHaHostSwitchProfile(String name, PolicyVtepHaHostSwitchProfileArgs args, CustomResourceOptions options)

type: nsxt:PolicyVtepHaHostSwitchProfile
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. PolicyVtepHaHostSwitchProfileArgs
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. PolicyVtepHaHostSwitchProfileArgs
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. PolicyVtepHaHostSwitchProfileArgs
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. PolicyVtepHaHostSwitchProfileArgs
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. PolicyVtepHaHostSwitchProfileArgs
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 policyVtepHaHostSwitchProfileResource = new Nsxt.PolicyVtepHaHostSwitchProfile("policyVtepHaHostSwitchProfileResource", new()
{
    DisplayName = "string",
    AutoRecovery = false,
    AutoRecoveryInitialWait = 0,
    AutoRecoveryMaxBackoff = 0,
    Description = "string",
    Enabled = false,
    FailoverTimeout = 0,
    NsxId = "string",
    PolicyVtepHaHostSwitchProfileId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyVtepHaHostSwitchProfileTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});
Copy
example, err := nsxt.NewPolicyVtepHaHostSwitchProfile(ctx, "policyVtepHaHostSwitchProfileResource", &nsxt.PolicyVtepHaHostSwitchProfileArgs{
	DisplayName:                     pulumi.String("string"),
	AutoRecovery:                    pulumi.Bool(false),
	AutoRecoveryInitialWait:         pulumi.Float64(0),
	AutoRecoveryMaxBackoff:          pulumi.Float64(0),
	Description:                     pulumi.String("string"),
	Enabled:                         pulumi.Bool(false),
	FailoverTimeout:                 pulumi.Float64(0),
	NsxId:                           pulumi.String("string"),
	PolicyVtepHaHostSwitchProfileId: pulumi.String("string"),
	Tags: nsxt.PolicyVtepHaHostSwitchProfileTagArray{
		&nsxt.PolicyVtepHaHostSwitchProfileTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})
Copy
var policyVtepHaHostSwitchProfileResource = new PolicyVtepHaHostSwitchProfile("policyVtepHaHostSwitchProfileResource", PolicyVtepHaHostSwitchProfileArgs.builder()
    .displayName("string")
    .autoRecovery(false)
    .autoRecoveryInitialWait(0)
    .autoRecoveryMaxBackoff(0)
    .description("string")
    .enabled(false)
    .failoverTimeout(0)
    .nsxId("string")
    .policyVtepHaHostSwitchProfileId("string")
    .tags(PolicyVtepHaHostSwitchProfileTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());
Copy
policy_vtep_ha_host_switch_profile_resource = nsxt.PolicyVtepHaHostSwitchProfile("policyVtepHaHostSwitchProfileResource",
    display_name="string",
    auto_recovery=False,
    auto_recovery_initial_wait=0,
    auto_recovery_max_backoff=0,
    description="string",
    enabled=False,
    failover_timeout=0,
    nsx_id="string",
    policy_vtep_ha_host_switch_profile_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])
Copy
const policyVtepHaHostSwitchProfileResource = new nsxt.PolicyVtepHaHostSwitchProfile("policyVtepHaHostSwitchProfileResource", {
    displayName: "string",
    autoRecovery: false,
    autoRecoveryInitialWait: 0,
    autoRecoveryMaxBackoff: 0,
    description: "string",
    enabled: false,
    failoverTimeout: 0,
    nsxId: "string",
    policyVtepHaHostSwitchProfileId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});
Copy
type: nsxt:PolicyVtepHaHostSwitchProfile
properties:
    autoRecovery: false
    autoRecoveryInitialWait: 0
    autoRecoveryMaxBackoff: 0
    description: string
    displayName: string
    enabled: false
    failoverTimeout: 0
    nsxId: string
    policyVtepHaHostSwitchProfileId: string
    tags:
        - scope: string
          tag: string
Copy

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

DisplayName This property is required. string
Display name of the resource.
AutoRecovery bool
Enabled status of autonomous recovery option. Default is true.
AutoRecoveryInitialWait double
Start time of autonomous recovery (in seconds). Default is 300.
AutoRecoveryMaxBackoff double
Maximum backoff time for autonomous recovery (in seconds). Default is 86400.
Description string
Description of the resource.
Enabled bool
Enabled status of VTEP High Availability feature. Default is false.
FailoverTimeout double
VTEP High Availability failover timeout (in seconds). Default is 5.
NsxId string
The NSX ID of this resource. If set, this ID will be used to create the resource.
PolicyVtepHaHostSwitchProfileId string
ID of the resource.
Tags List<PolicyVtepHaHostSwitchProfileTag>
A list of scope + tag pairs to associate with this resource.
DisplayName This property is required. string
Display name of the resource.
AutoRecovery bool
Enabled status of autonomous recovery option. Default is true.
AutoRecoveryInitialWait float64
Start time of autonomous recovery (in seconds). Default is 300.
AutoRecoveryMaxBackoff float64
Maximum backoff time for autonomous recovery (in seconds). Default is 86400.
Description string
Description of the resource.
Enabled bool
Enabled status of VTEP High Availability feature. Default is false.
FailoverTimeout float64
VTEP High Availability failover timeout (in seconds). Default is 5.
NsxId string
The NSX ID of this resource. If set, this ID will be used to create the resource.
PolicyVtepHaHostSwitchProfileId string
ID of the resource.
Tags []PolicyVtepHaHostSwitchProfileTagArgs
A list of scope + tag pairs to associate with this resource.
displayName This property is required. String
Display name of the resource.
autoRecovery Boolean
Enabled status of autonomous recovery option. Default is true.
autoRecoveryInitialWait Double
Start time of autonomous recovery (in seconds). Default is 300.
autoRecoveryMaxBackoff Double
Maximum backoff time for autonomous recovery (in seconds). Default is 86400.
description String
Description of the resource.
enabled Boolean
Enabled status of VTEP High Availability feature. Default is false.
failoverTimeout Double
VTEP High Availability failover timeout (in seconds). Default is 5.
nsxId String
The NSX ID of this resource. If set, this ID will be used to create the resource.
policyVtepHaHostSwitchProfileId String
ID of the resource.
tags List<PolicyVtepHaHostSwitchProfileTag>
A list of scope + tag pairs to associate with this resource.
displayName This property is required. string
Display name of the resource.
autoRecovery boolean
Enabled status of autonomous recovery option. Default is true.
autoRecoveryInitialWait number
Start time of autonomous recovery (in seconds). Default is 300.
autoRecoveryMaxBackoff number
Maximum backoff time for autonomous recovery (in seconds). Default is 86400.
description string
Description of the resource.
enabled boolean
Enabled status of VTEP High Availability feature. Default is false.
failoverTimeout number
VTEP High Availability failover timeout (in seconds). Default is 5.
nsxId string
The NSX ID of this resource. If set, this ID will be used to create the resource.
policyVtepHaHostSwitchProfileId string
ID of the resource.
tags PolicyVtepHaHostSwitchProfileTag[]
A list of scope + tag pairs to associate with this resource.
display_name This property is required. str
Display name of the resource.
auto_recovery bool
Enabled status of autonomous recovery option. Default is true.
auto_recovery_initial_wait float
Start time of autonomous recovery (in seconds). Default is 300.
auto_recovery_max_backoff float
Maximum backoff time for autonomous recovery (in seconds). Default is 86400.
description str
Description of the resource.
enabled bool
Enabled status of VTEP High Availability feature. Default is false.
failover_timeout float
VTEP High Availability failover timeout (in seconds). Default is 5.
nsx_id str
The NSX ID of this resource. If set, this ID will be used to create the resource.
policy_vtep_ha_host_switch_profile_id str
ID of the resource.
tags Sequence[PolicyVtepHaHostSwitchProfileTagArgs]
A list of scope + tag pairs to associate with this resource.
displayName This property is required. String
Display name of the resource.
autoRecovery Boolean
Enabled status of autonomous recovery option. Default is true.
autoRecoveryInitialWait Number
Start time of autonomous recovery (in seconds). Default is 300.
autoRecoveryMaxBackoff Number
Maximum backoff time for autonomous recovery (in seconds). Default is 86400.
description String
Description of the resource.
enabled Boolean
Enabled status of VTEP High Availability feature. Default is false.
failoverTimeout Number
VTEP High Availability failover timeout (in seconds). Default is 5.
nsxId String
The NSX ID of this resource. If set, this ID will be used to create the resource.
policyVtepHaHostSwitchProfileId String
ID of the resource.
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 PolicyVtepHaHostSwitchProfile 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.
RealizedId string
Realized ID for the profile. For reference in fabric resources (such as transport_node), realized_id should be used rather than id.
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.
RealizedId string
Realized ID for the profile. For reference in fabric resources (such as transport_node), realized_id should be used rather than id.
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.
realizedId String
Realized ID for the profile. For reference in fabric resources (such as transport_node), realized_id should be used rather than id.
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.
realizedId string
Realized ID for the profile. For reference in fabric resources (such as transport_node), realized_id should be used rather than id.
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.
realized_id str
Realized ID for the profile. For reference in fabric resources (such as transport_node), realized_id should be used rather than id.
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.
realizedId String
Realized ID for the profile. For reference in fabric resources (such as transport_node), realized_id should be used rather than id.
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 PolicyVtepHaHostSwitchProfile Resource

Get an existing PolicyVtepHaHostSwitchProfile 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?: PolicyVtepHaHostSwitchProfileState, opts?: CustomResourceOptions): PolicyVtepHaHostSwitchProfile
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_recovery: Optional[bool] = None,
        auto_recovery_initial_wait: Optional[float] = None,
        auto_recovery_max_backoff: Optional[float] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        enabled: Optional[bool] = None,
        failover_timeout: Optional[float] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_vtep_ha_host_switch_profile_id: Optional[str] = None,
        realized_id: Optional[str] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[PolicyVtepHaHostSwitchProfileTagArgs]] = None) -> PolicyVtepHaHostSwitchProfile
func GetPolicyVtepHaHostSwitchProfile(ctx *Context, name string, id IDInput, state *PolicyVtepHaHostSwitchProfileState, opts ...ResourceOption) (*PolicyVtepHaHostSwitchProfile, error)
public static PolicyVtepHaHostSwitchProfile Get(string name, Input<string> id, PolicyVtepHaHostSwitchProfileState? state, CustomResourceOptions? opts = null)
public static PolicyVtepHaHostSwitchProfile get(String name, Output<String> id, PolicyVtepHaHostSwitchProfileState state, CustomResourceOptions options)
resources:  _:    type: nsxt:PolicyVtepHaHostSwitchProfile    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:
AutoRecovery bool
Enabled status of autonomous recovery option. Default is true.
AutoRecoveryInitialWait double
Start time of autonomous recovery (in seconds). Default is 300.
AutoRecoveryMaxBackoff double
Maximum backoff time for autonomous recovery (in seconds). Default is 86400.
Description string
Description of the resource.
DisplayName string
Display name of the resource.
Enabled bool
Enabled status of VTEP High Availability feature. Default is false.
FailoverTimeout double
VTEP High Availability failover timeout (in seconds). Default is 5.
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.
PolicyVtepHaHostSwitchProfileId string
ID of the resource.
RealizedId string
Realized ID for the profile. For reference in fabric resources (such as transport_node), realized_id should be used rather than id.
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<PolicyVtepHaHostSwitchProfileTag>
A list of scope + tag pairs to associate with this resource.
AutoRecovery bool
Enabled status of autonomous recovery option. Default is true.
AutoRecoveryInitialWait float64
Start time of autonomous recovery (in seconds). Default is 300.
AutoRecoveryMaxBackoff float64
Maximum backoff time for autonomous recovery (in seconds). Default is 86400.
Description string
Description of the resource.
DisplayName string
Display name of the resource.
Enabled bool
Enabled status of VTEP High Availability feature. Default is false.
FailoverTimeout float64
VTEP High Availability failover timeout (in seconds). Default is 5.
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.
PolicyVtepHaHostSwitchProfileId string
ID of the resource.
RealizedId string
Realized ID for the profile. For reference in fabric resources (such as transport_node), realized_id should be used rather than id.
Revision float64
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
Tags []PolicyVtepHaHostSwitchProfileTagArgs
A list of scope + tag pairs to associate with this resource.
autoRecovery Boolean
Enabled status of autonomous recovery option. Default is true.
autoRecoveryInitialWait Double
Start time of autonomous recovery (in seconds). Default is 300.
autoRecoveryMaxBackoff Double
Maximum backoff time for autonomous recovery (in seconds). Default is 86400.
description String
Description of the resource.
displayName String
Display name of the resource.
enabled Boolean
Enabled status of VTEP High Availability feature. Default is false.
failoverTimeout Double
VTEP High Availability failover timeout (in seconds). Default is 5.
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.
policyVtepHaHostSwitchProfileId String
ID of the resource.
realizedId String
Realized ID for the profile. For reference in fabric resources (such as transport_node), realized_id should be used rather than id.
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<PolicyVtepHaHostSwitchProfileTag>
A list of scope + tag pairs to associate with this resource.
autoRecovery boolean
Enabled status of autonomous recovery option. Default is true.
autoRecoveryInitialWait number
Start time of autonomous recovery (in seconds). Default is 300.
autoRecoveryMaxBackoff number
Maximum backoff time for autonomous recovery (in seconds). Default is 86400.
description string
Description of the resource.
displayName string
Display name of the resource.
enabled boolean
Enabled status of VTEP High Availability feature. Default is false.
failoverTimeout number
VTEP High Availability failover timeout (in seconds). Default is 5.
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.
policyVtepHaHostSwitchProfileId string
ID of the resource.
realizedId string
Realized ID for the profile. For reference in fabric resources (such as transport_node), realized_id should be used rather than id.
revision number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
tags PolicyVtepHaHostSwitchProfileTag[]
A list of scope + tag pairs to associate with this resource.
auto_recovery bool
Enabled status of autonomous recovery option. Default is true.
auto_recovery_initial_wait float
Start time of autonomous recovery (in seconds). Default is 300.
auto_recovery_max_backoff float
Maximum backoff time for autonomous recovery (in seconds). Default is 86400.
description str
Description of the resource.
display_name str
Display name of the resource.
enabled bool
Enabled status of VTEP High Availability feature. Default is false.
failover_timeout float
VTEP High Availability failover timeout (in seconds). Default is 5.
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_vtep_ha_host_switch_profile_id str
ID of the resource.
realized_id str
Realized ID for the profile. For reference in fabric resources (such as transport_node), realized_id should be used rather than id.
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[PolicyVtepHaHostSwitchProfileTagArgs]
A list of scope + tag pairs to associate with this resource.
autoRecovery Boolean
Enabled status of autonomous recovery option. Default is true.
autoRecoveryInitialWait Number
Start time of autonomous recovery (in seconds). Default is 300.
autoRecoveryMaxBackoff Number
Maximum backoff time for autonomous recovery (in seconds). Default is 86400.
description String
Description of the resource.
displayName String
Display name of the resource.
enabled Boolean
Enabled status of VTEP High Availability feature. Default is false.
failoverTimeout Number
VTEP High Availability failover timeout (in seconds). Default is 5.
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.
policyVtepHaHostSwitchProfileId String
ID of the resource.
realizedId String
Realized ID for the profile. For reference in fabric resources (such as transport_node), realized_id should be used rather than id.
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

PolicyVtepHaHostSwitchProfileTag
, PolicyVtepHaHostSwitchProfileTagArgs

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 3.8.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt