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

nsxt.FailureDomain

Explore with Pulumi AI

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

    Create FailureDomain Resource

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

    Constructor syntax

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

@overload
def FailureDomain(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  display_name: Optional[str] = None,
                  description: Optional[str] = None,
                  failure_domain_id: Optional[str] = None,
                  preferred_edge_services: Optional[str] = None,
                  tags: Optional[Sequence[FailureDomainTagArgs]] = None)
    func NewFailureDomain(ctx *Context, name string, args FailureDomainArgs, opts ...ResourceOption) (*FailureDomain, error)
    public FailureDomain(string name, FailureDomainArgs args, CustomResourceOptions? opts = null)
    public FailureDomain(String name, FailureDomainArgs args)
public FailureDomain(String name, FailureDomainArgs args, CustomResourceOptions options)

    type: nsxt:FailureDomain
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 FailureDomainArgs
    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 FailureDomainArgs
    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 FailureDomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FailureDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FailureDomainArgs
    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 failureDomainResource = new Nsxt.FailureDomain("failureDomainResource", new()
{
    DisplayName = "string",
    Description = "string",
    FailureDomainId = "string",
    PreferredEdgeServices = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.FailureDomainTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewFailureDomain(ctx, "failureDomainResource", &nsxt.FailureDomainArgs{
	DisplayName:           pulumi.String("string"),
	Description:           pulumi.String("string"),
	FailureDomainId:       pulumi.String("string"),
	PreferredEdgeServices: pulumi.String("string"),
	Tags: nsxt.FailureDomainTagArray{
		&nsxt.FailureDomainTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    var failureDomainResource = new FailureDomain("failureDomainResource", FailureDomainArgs.builder()
    .displayName("string")
    .description("string")
    .failureDomainId("string")
    .preferredEdgeServices("string")
    .tags(FailureDomainTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    failure_domain_resource = nsxt.FailureDomain("failureDomainResource",
    display_name="string",
    description="string",
    failure_domain_id="string",
    preferred_edge_services="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const failureDomainResource = new nsxt.FailureDomain("failureDomainResource", {
    displayName: "string",
    description: "string",
    failureDomainId: "string",
    preferredEdgeServices: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:FailureDomain
properties:
    description: string
    displayName: string
    failureDomainId: string
    preferredEdgeServices: string
    tags:
        - scope: string
          tag: string

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

    DisplayName string
    Display name of the resource.
    Description string
    Description of the resource.
    FailureDomainId string
    ID of the resource.
    PreferredEdgeServices string
    Set preference for failure domain. Set preference for edge transport node failure domain which will be considered while doing auto placement of logical router, DHCP and MDProxy on edge node. active: For preemptive failover mode, active edge cluster member allocation prefers this failure domain. standby: For preemptive failover mode, standby edge cluster member allocation prefers this failure domain. Default will be no_preference. It means no explicit preference.
    Tags List<FailureDomainTag>
    A list of scope + tag pairs to associate with this failure domain.
    DisplayName string
    Display name of the resource.
    Description string
    Description of the resource.
    FailureDomainId string
    ID of the resource.
    PreferredEdgeServices string
    Set preference for failure domain. Set preference for edge transport node failure domain which will be considered while doing auto placement of logical router, DHCP and MDProxy on edge node. active: For preemptive failover mode, active edge cluster member allocation prefers this failure domain. standby: For preemptive failover mode, standby edge cluster member allocation prefers this failure domain. Default will be no_preference. It means no explicit preference.
    Tags []FailureDomainTagArgs
    A list of scope + tag pairs to associate with this failure domain.
    displayName String
    Display name of the resource.
    description String
    Description of the resource.
    failureDomainId String
    ID of the resource.
    preferredEdgeServices String
    Set preference for failure domain. Set preference for edge transport node failure domain which will be considered while doing auto placement of logical router, DHCP and MDProxy on edge node. active: For preemptive failover mode, active edge cluster member allocation prefers this failure domain. standby: For preemptive failover mode, standby edge cluster member allocation prefers this failure domain. Default will be no_preference. It means no explicit preference.
    tags List<FailureDomainTag>
    A list of scope + tag pairs to associate with this failure domain.
    displayName string
    Display name of the resource.
    description string
    Description of the resource.
    failureDomainId string
    ID of the resource.
    preferredEdgeServices string
    Set preference for failure domain. Set preference for edge transport node failure domain which will be considered while doing auto placement of logical router, DHCP and MDProxy on edge node. active: For preemptive failover mode, active edge cluster member allocation prefers this failure domain. standby: For preemptive failover mode, standby edge cluster member allocation prefers this failure domain. Default will be no_preference. It means no explicit preference.
    tags FailureDomainTag[]
    A list of scope + tag pairs to associate with this failure domain.
    display_name str
    Display name of the resource.
    description str
    Description of the resource.
    failure_domain_id str
    ID of the resource.
    preferred_edge_services str
    Set preference for failure domain. Set preference for edge transport node failure domain which will be considered while doing auto placement of logical router, DHCP and MDProxy on edge node. active: For preemptive failover mode, active edge cluster member allocation prefers this failure domain. standby: For preemptive failover mode, standby edge cluster member allocation prefers this failure domain. Default will be no_preference. It means no explicit preference.
    tags Sequence[FailureDomainTagArgs]
    A list of scope + tag pairs to associate with this failure domain.
    displayName String
    Display name of the resource.
    description String
    Description of the resource.
    failureDomainId String
    ID of the resource.
    preferredEdgeServices String
    Set preference for failure domain. Set preference for edge transport node failure domain which will be considered while doing auto placement of logical router, DHCP and MDProxy on edge node. active: For preemptive failover mode, active edge cluster member allocation prefers this failure domain. standby: For preemptive failover mode, standby edge cluster member allocation prefers this failure domain. Default will be no_preference. It means no explicit preference.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this failure domain.

    Outputs

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

    Get an existing FailureDomain 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?: FailureDomainState, opts?: CustomResourceOptions): FailureDomain
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        failure_domain_id: Optional[str] = None,
        preferred_edge_services: Optional[str] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[FailureDomainTagArgs]] = None) -> FailureDomain
    func GetFailureDomain(ctx *Context, name string, id IDInput, state *FailureDomainState, opts ...ResourceOption) (*FailureDomain, error)
    public static FailureDomain Get(string name, Input<string> id, FailureDomainState? state, CustomResourceOptions? opts = null)
    public static FailureDomain get(String name, Output<String> id, FailureDomainState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:FailureDomain    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.
    FailureDomainId string
    ID of the resource.
    PreferredEdgeServices string
    Set preference for failure domain. Set preference for edge transport node failure domain which will be considered while doing auto placement of logical router, DHCP and MDProxy on edge node. active: For preemptive failover mode, active edge cluster member allocation prefers this failure domain. standby: For preemptive failover mode, standby edge cluster member allocation prefers this failure domain. Default will be no_preference. It means no explicit preference.
    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<FailureDomainTag>
    A list of scope + tag pairs to associate with this failure domain.
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    FailureDomainId string
    ID of the resource.
    PreferredEdgeServices string
    Set preference for failure domain. Set preference for edge transport node failure domain which will be considered while doing auto placement of logical router, DHCP and MDProxy on edge node. active: For preemptive failover mode, active edge cluster member allocation prefers this failure domain. standby: For preemptive failover mode, standby edge cluster member allocation prefers this failure domain. Default will be no_preference. It means no explicit preference.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags []FailureDomainTagArgs
    A list of scope + tag pairs to associate with this failure domain.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    failureDomainId String
    ID of the resource.
    preferredEdgeServices String
    Set preference for failure domain. Set preference for edge transport node failure domain which will be considered while doing auto placement of logical router, DHCP and MDProxy on edge node. active: For preemptive failover mode, active edge cluster member allocation prefers this failure domain. standby: For preemptive failover mode, standby edge cluster member allocation prefers this failure domain. Default will be no_preference. It means no explicit preference.
    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<FailureDomainTag>
    A list of scope + tag pairs to associate with this failure domain.
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    failureDomainId string
    ID of the resource.
    preferredEdgeServices string
    Set preference for failure domain. Set preference for edge transport node failure domain which will be considered while doing auto placement of logical router, DHCP and MDProxy on edge node. active: For preemptive failover mode, active edge cluster member allocation prefers this failure domain. standby: For preemptive failover mode, standby edge cluster member allocation prefers this failure domain. Default will be no_preference. It means no explicit preference.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags FailureDomainTag[]
    A list of scope + tag pairs to associate with this failure domain.
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    failure_domain_id str
    ID of the resource.
    preferred_edge_services str
    Set preference for failure domain. Set preference for edge transport node failure domain which will be considered while doing auto placement of logical router, DHCP and MDProxy on edge node. active: For preemptive failover mode, active edge cluster member allocation prefers this failure domain. standby: For preemptive failover mode, standby edge cluster member allocation prefers this failure domain. Default will be no_preference. It means no explicit preference.
    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[FailureDomainTagArgs]
    A list of scope + tag pairs to associate with this failure domain.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    failureDomainId String
    ID of the resource.
    preferredEdgeServices String
    Set preference for failure domain. Set preference for edge transport node failure domain which will be considered while doing auto placement of logical router, DHCP and MDProxy on edge node. active: For preemptive failover mode, active edge cluster member allocation prefers this failure domain. standby: For preemptive failover mode, standby edge cluster member allocation prefers this failure domain. Default will be no_preference. It means no explicit preference.
    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 failure domain.

    Supporting Types

    FailureDomainTag, FailureDomainTagArgs

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

    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