1. Packages
  2. Nsxt Provider
  3. API Docs
  4. PolicyTier0GatewayHaVipConfig
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

nsxt.PolicyTier0GatewayHaVipConfig

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

    Create PolicyTier0GatewayHaVipConfig Resource

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

    Constructor syntax

    new PolicyTier0GatewayHaVipConfig(name: string, args: PolicyTier0GatewayHaVipConfigArgs, opts?: CustomResourceOptions);
    @overload
    def PolicyTier0GatewayHaVipConfig(resource_name: str,
                                      args: PolicyTier0GatewayHaVipConfigArgs,
                                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def PolicyTier0GatewayHaVipConfig(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      configs: Optional[Sequence[PolicyTier0GatewayHaVipConfigConfigArgs]] = None,
                                      policy_tier0_gateway_ha_vip_config_id: Optional[str] = None)
    func NewPolicyTier0GatewayHaVipConfig(ctx *Context, name string, args PolicyTier0GatewayHaVipConfigArgs, opts ...ResourceOption) (*PolicyTier0GatewayHaVipConfig, error)
    public PolicyTier0GatewayHaVipConfig(string name, PolicyTier0GatewayHaVipConfigArgs args, CustomResourceOptions? opts = null)
    public PolicyTier0GatewayHaVipConfig(String name, PolicyTier0GatewayHaVipConfigArgs args)
    public PolicyTier0GatewayHaVipConfig(String name, PolicyTier0GatewayHaVipConfigArgs args, CustomResourceOptions options)
    
    type: nsxt:PolicyTier0GatewayHaVipConfig
    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 PolicyTier0GatewayHaVipConfigArgs
    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 PolicyTier0GatewayHaVipConfigArgs
    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 PolicyTier0GatewayHaVipConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyTier0GatewayHaVipConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyTier0GatewayHaVipConfigArgs
    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 policyTier0GatewayHaVipConfigResource = new Nsxt.PolicyTier0GatewayHaVipConfig("policyTier0GatewayHaVipConfigResource", new()
    {
        Configs = new[]
        {
            new Nsxt.Inputs.PolicyTier0GatewayHaVipConfigConfigArgs
            {
                ExternalInterfacePaths = new[]
                {
                    "string",
                },
                VipSubnets = new[]
                {
                    "string",
                },
                Enabled = false,
            },
        },
        PolicyTier0GatewayHaVipConfigId = "string",
    });
    
    example, err := nsxt.NewPolicyTier0GatewayHaVipConfig(ctx, "policyTier0GatewayHaVipConfigResource", &nsxt.PolicyTier0GatewayHaVipConfigArgs{
    	Configs: nsxt.PolicyTier0GatewayHaVipConfigConfigArray{
    		&nsxt.PolicyTier0GatewayHaVipConfigConfigArgs{
    			ExternalInterfacePaths: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			VipSubnets: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			Enabled: pulumi.Bool(false),
    		},
    	},
    	PolicyTier0GatewayHaVipConfigId: pulumi.String("string"),
    })
    
    var policyTier0GatewayHaVipConfigResource = new PolicyTier0GatewayHaVipConfig("policyTier0GatewayHaVipConfigResource", PolicyTier0GatewayHaVipConfigArgs.builder()
        .configs(PolicyTier0GatewayHaVipConfigConfigArgs.builder()
            .externalInterfacePaths("string")
            .vipSubnets("string")
            .enabled(false)
            .build())
        .policyTier0GatewayHaVipConfigId("string")
        .build());
    
    policy_tier0_gateway_ha_vip_config_resource = nsxt.PolicyTier0GatewayHaVipConfig("policyTier0GatewayHaVipConfigResource",
        configs=[{
            "external_interface_paths": ["string"],
            "vip_subnets": ["string"],
            "enabled": False,
        }],
        policy_tier0_gateway_ha_vip_config_id="string")
    
    const policyTier0GatewayHaVipConfigResource = new nsxt.PolicyTier0GatewayHaVipConfig("policyTier0GatewayHaVipConfigResource", {
        configs: [{
            externalInterfacePaths: ["string"],
            vipSubnets: ["string"],
            enabled: false,
        }],
        policyTier0GatewayHaVipConfigId: "string",
    });
    
    type: nsxt:PolicyTier0GatewayHaVipConfig
    properties:
        configs:
            - enabled: false
              externalInterfacePaths:
                - string
              vipSubnets:
                - string
        policyTier0GatewayHaVipConfigId: string
    

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

    Configs List<PolicyTier0GatewayHaVipConfigConfig>
    List of HA vip configurations (all belonging to the same Tier0 locale-service) containing:
    PolicyTier0GatewayHaVipConfigId string
    ID of the resource.
    Configs []PolicyTier0GatewayHaVipConfigConfigArgs
    List of HA vip configurations (all belonging to the same Tier0 locale-service) containing:
    PolicyTier0GatewayHaVipConfigId string
    ID of the resource.
    configs List<PolicyTier0GatewayHaVipConfigConfig>
    List of HA vip configurations (all belonging to the same Tier0 locale-service) containing:
    policyTier0GatewayHaVipConfigId String
    ID of the resource.
    configs PolicyTier0GatewayHaVipConfigConfig[]
    List of HA vip configurations (all belonging to the same Tier0 locale-service) containing:
    policyTier0GatewayHaVipConfigId string
    ID of the resource.
    configs Sequence[PolicyTier0GatewayHaVipConfigConfigArgs]
    List of HA vip configurations (all belonging to the same Tier0 locale-service) containing:
    policy_tier0_gateway_ha_vip_config_id str
    ID of the resource.
    configs List<Property Map>
    List of HA vip configurations (all belonging to the same Tier0 locale-service) containing:
    policyTier0GatewayHaVipConfigId String
    ID of the resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PolicyTier0GatewayHaVipConfig resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    LocaleServiceId string
    ID of the Tier-0 Gateway locale service.
    Tier0Id string
    ID of the Tier-0 Gateway
    Id string
    The provider-assigned unique ID for this managed resource.
    LocaleServiceId string
    ID of the Tier-0 Gateway locale service.
    Tier0Id string
    ID of the Tier-0 Gateway
    id String
    The provider-assigned unique ID for this managed resource.
    localeServiceId String
    ID of the Tier-0 Gateway locale service.
    tier0Id String
    ID of the Tier-0 Gateway
    id string
    The provider-assigned unique ID for this managed resource.
    localeServiceId string
    ID of the Tier-0 Gateway locale service.
    tier0Id string
    ID of the Tier-0 Gateway
    id str
    The provider-assigned unique ID for this managed resource.
    locale_service_id str
    ID of the Tier-0 Gateway locale service.
    tier0_id str
    ID of the Tier-0 Gateway
    id String
    The provider-assigned unique ID for this managed resource.
    localeServiceId String
    ID of the Tier-0 Gateway locale service.
    tier0Id String
    ID of the Tier-0 Gateway

    Look up Existing PolicyTier0GatewayHaVipConfig Resource

    Get an existing PolicyTier0GatewayHaVipConfig 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?: PolicyTier0GatewayHaVipConfigState, opts?: CustomResourceOptions): PolicyTier0GatewayHaVipConfig
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            configs: Optional[Sequence[PolicyTier0GatewayHaVipConfigConfigArgs]] = None,
            locale_service_id: Optional[str] = None,
            policy_tier0_gateway_ha_vip_config_id: Optional[str] = None,
            tier0_id: Optional[str] = None) -> PolicyTier0GatewayHaVipConfig
    func GetPolicyTier0GatewayHaVipConfig(ctx *Context, name string, id IDInput, state *PolicyTier0GatewayHaVipConfigState, opts ...ResourceOption) (*PolicyTier0GatewayHaVipConfig, error)
    public static PolicyTier0GatewayHaVipConfig Get(string name, Input<string> id, PolicyTier0GatewayHaVipConfigState? state, CustomResourceOptions? opts = null)
    public static PolicyTier0GatewayHaVipConfig get(String name, Output<String> id, PolicyTier0GatewayHaVipConfigState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyTier0GatewayHaVipConfig    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:
    Configs List<PolicyTier0GatewayHaVipConfigConfig>
    List of HA vip configurations (all belonging to the same Tier0 locale-service) containing:
    LocaleServiceId string
    ID of the Tier-0 Gateway locale service.
    PolicyTier0GatewayHaVipConfigId string
    ID of the resource.
    Tier0Id string
    ID of the Tier-0 Gateway
    Configs []PolicyTier0GatewayHaVipConfigConfigArgs
    List of HA vip configurations (all belonging to the same Tier0 locale-service) containing:
    LocaleServiceId string
    ID of the Tier-0 Gateway locale service.
    PolicyTier0GatewayHaVipConfigId string
    ID of the resource.
    Tier0Id string
    ID of the Tier-0 Gateway
    configs List<PolicyTier0GatewayHaVipConfigConfig>
    List of HA vip configurations (all belonging to the same Tier0 locale-service) containing:
    localeServiceId String
    ID of the Tier-0 Gateway locale service.
    policyTier0GatewayHaVipConfigId String
    ID of the resource.
    tier0Id String
    ID of the Tier-0 Gateway
    configs PolicyTier0GatewayHaVipConfigConfig[]
    List of HA vip configurations (all belonging to the same Tier0 locale-service) containing:
    localeServiceId string
    ID of the Tier-0 Gateway locale service.
    policyTier0GatewayHaVipConfigId string
    ID of the resource.
    tier0Id string
    ID of the Tier-0 Gateway
    configs Sequence[PolicyTier0GatewayHaVipConfigConfigArgs]
    List of HA vip configurations (all belonging to the same Tier0 locale-service) containing:
    locale_service_id str
    ID of the Tier-0 Gateway locale service.
    policy_tier0_gateway_ha_vip_config_id str
    ID of the resource.
    tier0_id str
    ID of the Tier-0 Gateway
    configs List<Property Map>
    List of HA vip configurations (all belonging to the same Tier0 locale-service) containing:
    localeServiceId String
    ID of the Tier-0 Gateway locale service.
    policyTier0GatewayHaVipConfigId String
    ID of the resource.
    tier0Id String
    ID of the Tier-0 Gateway

    Supporting Types

    PolicyTier0GatewayHaVipConfigConfig, PolicyTier0GatewayHaVipConfigConfigArgs

    ExternalInterfacePaths List<string>
    Paths of 2 external interfaces belonging to the same Tier0 gateway locale-service, which are to be paired to provide redundancy. Floating IP will be owned by one of these interfaces depending upon which edge node is active.
    VipSubnets List<string>
    1 or 2 Ip Addresses/Prefixes in CIDR format, which will be used as floating IP addresses.
    Enabled bool
    Flag indicating if this HA VIP config is enabled. True by default.
    ExternalInterfacePaths []string
    Paths of 2 external interfaces belonging to the same Tier0 gateway locale-service, which are to be paired to provide redundancy. Floating IP will be owned by one of these interfaces depending upon which edge node is active.
    VipSubnets []string
    1 or 2 Ip Addresses/Prefixes in CIDR format, which will be used as floating IP addresses.
    Enabled bool
    Flag indicating if this HA VIP config is enabled. True by default.
    externalInterfacePaths List<String>
    Paths of 2 external interfaces belonging to the same Tier0 gateway locale-service, which are to be paired to provide redundancy. Floating IP will be owned by one of these interfaces depending upon which edge node is active.
    vipSubnets List<String>
    1 or 2 Ip Addresses/Prefixes in CIDR format, which will be used as floating IP addresses.
    enabled Boolean
    Flag indicating if this HA VIP config is enabled. True by default.
    externalInterfacePaths string[]
    Paths of 2 external interfaces belonging to the same Tier0 gateway locale-service, which are to be paired to provide redundancy. Floating IP will be owned by one of these interfaces depending upon which edge node is active.
    vipSubnets string[]
    1 or 2 Ip Addresses/Prefixes in CIDR format, which will be used as floating IP addresses.
    enabled boolean
    Flag indicating if this HA VIP config is enabled. True by default.
    external_interface_paths Sequence[str]
    Paths of 2 external interfaces belonging to the same Tier0 gateway locale-service, which are to be paired to provide redundancy. Floating IP will be owned by one of these interfaces depending upon which edge node is active.
    vip_subnets Sequence[str]
    1 or 2 Ip Addresses/Prefixes in CIDR format, which will be used as floating IP addresses.
    enabled bool
    Flag indicating if this HA VIP config is enabled. True by default.
    externalInterfacePaths List<String>
    Paths of 2 external interfaces belonging to the same Tier0 gateway locale-service, which are to be paired to provide redundancy. Floating IP will be owned by one of these interfaces depending upon which edge node is active.
    vipSubnets List<String>
    1 or 2 Ip Addresses/Prefixes in CIDR format, which will be used as floating IP addresses.
    enabled Boolean
    Flag indicating if this HA VIP config is enabled. True by default.

    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