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

nsxt.PolicyGatewayRedistributionConfig

Explore with Pulumi AI

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

    Create PolicyGatewayRedistributionConfig Resource

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

    Constructor syntax

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

@overload
def PolicyGatewayRedistributionConfig(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      gateway_path: Optional[str] = None,
                                      bgp_enabled: Optional[bool] = None,
                                      ospf_enabled: Optional[bool] = None,
                                      policy_gateway_redistribution_config_id: Optional[str] = None,
                                      rules: Optional[Sequence[PolicyGatewayRedistributionConfigRuleArgs]] = None,
                                      site_path: Optional[str] = None)
    func NewPolicyGatewayRedistributionConfig(ctx *Context, name string, args PolicyGatewayRedistributionConfigArgs, opts ...ResourceOption) (*PolicyGatewayRedistributionConfig, error)
    public PolicyGatewayRedistributionConfig(string name, PolicyGatewayRedistributionConfigArgs args, CustomResourceOptions? opts = null)
    public PolicyGatewayRedistributionConfig(String name, PolicyGatewayRedistributionConfigArgs args)
public PolicyGatewayRedistributionConfig(String name, PolicyGatewayRedistributionConfigArgs args, CustomResourceOptions options)

    type: nsxt:PolicyGatewayRedistributionConfig
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 PolicyGatewayRedistributionConfigArgs
    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 PolicyGatewayRedistributionConfigArgs
    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 PolicyGatewayRedistributionConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyGatewayRedistributionConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyGatewayRedistributionConfigArgs
    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 policyGatewayRedistributionConfigResource = new Nsxt.PolicyGatewayRedistributionConfig("policyGatewayRedistributionConfigResource", new()
{
    GatewayPath = "string",
    BgpEnabled = false,
    OspfEnabled = false,
    PolicyGatewayRedistributionConfigId = "string",
    Rules = new[]
    {
        new Nsxt.Inputs.PolicyGatewayRedistributionConfigRuleArgs
        {
            Bgp = false,
            Name = "string",
            Ospf = false,
            RouteMapPath = "string",
            Types = new[]
            {
                "string",
            },
        },
    },
    SitePath = "string",
});

    example, err := nsxt.NewPolicyGatewayRedistributionConfig(ctx, "policyGatewayRedistributionConfigResource", &nsxt.PolicyGatewayRedistributionConfigArgs{
	GatewayPath:                         pulumi.String("string"),
	BgpEnabled:                          pulumi.Bool(false),
	OspfEnabled:                         pulumi.Bool(false),
	PolicyGatewayRedistributionConfigId: pulumi.String("string"),
	Rules: nsxt.PolicyGatewayRedistributionConfigRuleArray{
		&nsxt.PolicyGatewayRedistributionConfigRuleArgs{
			Bgp:          pulumi.Bool(false),
			Name:         pulumi.String("string"),
			Ospf:         pulumi.Bool(false),
			RouteMapPath: pulumi.String("string"),
			Types: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	SitePath: pulumi.String("string"),
})

    var policyGatewayRedistributionConfigResource = new PolicyGatewayRedistributionConfig("policyGatewayRedistributionConfigResource", PolicyGatewayRedistributionConfigArgs.builder()
    .gatewayPath("string")
    .bgpEnabled(false)
    .ospfEnabled(false)
    .policyGatewayRedistributionConfigId("string")
    .rules(PolicyGatewayRedistributionConfigRuleArgs.builder()
        .bgp(false)
        .name("string")
        .ospf(false)
        .routeMapPath("string")
        .types("string")
        .build())
    .sitePath("string")
    .build());

    policy_gateway_redistribution_config_resource = nsxt.PolicyGatewayRedistributionConfig("policyGatewayRedistributionConfigResource",
    gateway_path="string",
    bgp_enabled=False,
    ospf_enabled=False,
    policy_gateway_redistribution_config_id="string",
    rules=[{
        "bgp": False,
        "name": "string",
        "ospf": False,
        "route_map_path": "string",
        "types": ["string"],
    }],
    site_path="string")

    const policyGatewayRedistributionConfigResource = new nsxt.PolicyGatewayRedistributionConfig("policyGatewayRedistributionConfigResource", {
    gatewayPath: "string",
    bgpEnabled: false,
    ospfEnabled: false,
    policyGatewayRedistributionConfigId: "string",
    rules: [{
        bgp: false,
        name: "string",
        ospf: false,
        routeMapPath: "string",
        types: ["string"],
    }],
    sitePath: "string",
});

    type: nsxt:PolicyGatewayRedistributionConfig
properties:
    bgpEnabled: false
    gatewayPath: string
    ospfEnabled: false
    policyGatewayRedistributionConfigId: string
    rules:
        - bgp: false
          name: string
          ospf: false
          routeMapPath: string
          types:
            - string
    sitePath: string

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

    GatewayPath string
    Policy path to Tier0 Gateway.
    BgpEnabled bool
    Enable route redistribution for BGP. Defaults to true.
    OspfEnabled bool
    Enable route redistribution for OSPF. Defaults to false. Applicable from NSX 3.1.0 onwards.
    PolicyGatewayRedistributionConfigId string
    ID of the resource.
    Rules List<PolicyGatewayRedistributionConfigRule>
    List of redistribution rules.
    SitePath string
    Policy path to Global Manager site (domain). This attribute is required for NSX Global Manager and not applicable otherwise.
    GatewayPath string
    Policy path to Tier0 Gateway.
    BgpEnabled bool
    Enable route redistribution for BGP. Defaults to true.
    OspfEnabled bool
    Enable route redistribution for OSPF. Defaults to false. Applicable from NSX 3.1.0 onwards.
    PolicyGatewayRedistributionConfigId string
    ID of the resource.
    Rules []PolicyGatewayRedistributionConfigRuleArgs
    List of redistribution rules.
    SitePath string
    Policy path to Global Manager site (domain). This attribute is required for NSX Global Manager and not applicable otherwise.
    gatewayPath String
    Policy path to Tier0 Gateway.
    bgpEnabled Boolean
    Enable route redistribution for BGP. Defaults to true.
    ospfEnabled Boolean
    Enable route redistribution for OSPF. Defaults to false. Applicable from NSX 3.1.0 onwards.
    policyGatewayRedistributionConfigId String
    ID of the resource.
    rules List<PolicyGatewayRedistributionConfigRule>
    List of redistribution rules.
    sitePath String
    Policy path to Global Manager site (domain). This attribute is required for NSX Global Manager and not applicable otherwise.
    gatewayPath string
    Policy path to Tier0 Gateway.
    bgpEnabled boolean
    Enable route redistribution for BGP. Defaults to true.
    ospfEnabled boolean
    Enable route redistribution for OSPF. Defaults to false. Applicable from NSX 3.1.0 onwards.
    policyGatewayRedistributionConfigId string
    ID of the resource.
    rules PolicyGatewayRedistributionConfigRule[]
    List of redistribution rules.
    sitePath string
    Policy path to Global Manager site (domain). This attribute is required for NSX Global Manager and not applicable otherwise.
    gateway_path str
    Policy path to Tier0 Gateway.
    bgp_enabled bool
    Enable route redistribution for BGP. Defaults to true.
    ospf_enabled bool
    Enable route redistribution for OSPF. Defaults to false. Applicable from NSX 3.1.0 onwards.
    policy_gateway_redistribution_config_id str
    ID of the resource.
    rules Sequence[PolicyGatewayRedistributionConfigRuleArgs]
    List of redistribution rules.
    site_path str
    Policy path to Global Manager site (domain). This attribute is required for NSX Global Manager and not applicable otherwise.
    gatewayPath String
    Policy path to Tier0 Gateway.
    bgpEnabled Boolean
    Enable route redistribution for BGP. Defaults to true.
    ospfEnabled Boolean
    Enable route redistribution for OSPF. Defaults to false. Applicable from NSX 3.1.0 onwards.
    policyGatewayRedistributionConfigId String
    ID of the resource.
    rules List<Property Map>
    List of redistribution rules.
    sitePath String
    Policy path to Global Manager site (domain). This attribute is required for NSX Global Manager and not applicable otherwise.

    Outputs

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

    GatewayId 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.
    GatewayId 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.
    gatewayId 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.
    gatewayId 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.
    gateway_id str
    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.
    gatewayId 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.

    Look up Existing PolicyGatewayRedistributionConfig Resource

    Get an existing PolicyGatewayRedistributionConfig 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?: PolicyGatewayRedistributionConfigState, opts?: CustomResourceOptions): PolicyGatewayRedistributionConfig
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bgp_enabled: Optional[bool] = None,
        gateway_id: Optional[str] = None,
        gateway_path: Optional[str] = None,
        locale_service_id: Optional[str] = None,
        ospf_enabled: Optional[bool] = None,
        policy_gateway_redistribution_config_id: Optional[str] = None,
        rules: Optional[Sequence[PolicyGatewayRedistributionConfigRuleArgs]] = None,
        site_path: Optional[str] = None) -> PolicyGatewayRedistributionConfig
    func GetPolicyGatewayRedistributionConfig(ctx *Context, name string, id IDInput, state *PolicyGatewayRedistributionConfigState, opts ...ResourceOption) (*PolicyGatewayRedistributionConfig, error)
    public static PolicyGatewayRedistributionConfig Get(string name, Input<string> id, PolicyGatewayRedistributionConfigState? state, CustomResourceOptions? opts = null)
    public static PolicyGatewayRedistributionConfig get(String name, Output<String> id, PolicyGatewayRedistributionConfigState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyGatewayRedistributionConfig    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:
    BgpEnabled bool
    Enable route redistribution for BGP. Defaults to true.
    GatewayId string
    ID of the Tier-0 Gateway
    GatewayPath string
    Policy path to Tier0 Gateway.
    LocaleServiceId string
    ID of the Tier-0 Gateway locale service.
    OspfEnabled bool
    Enable route redistribution for OSPF. Defaults to false. Applicable from NSX 3.1.0 onwards.
    PolicyGatewayRedistributionConfigId string
    ID of the resource.
    Rules List<PolicyGatewayRedistributionConfigRule>
    List of redistribution rules.
    SitePath string
    Policy path to Global Manager site (domain). This attribute is required for NSX Global Manager and not applicable otherwise.
    BgpEnabled bool
    Enable route redistribution for BGP. Defaults to true.
    GatewayId string
    ID of the Tier-0 Gateway
    GatewayPath string
    Policy path to Tier0 Gateway.
    LocaleServiceId string
    ID of the Tier-0 Gateway locale service.
    OspfEnabled bool
    Enable route redistribution for OSPF. Defaults to false. Applicable from NSX 3.1.0 onwards.
    PolicyGatewayRedistributionConfigId string
    ID of the resource.
    Rules []PolicyGatewayRedistributionConfigRuleArgs
    List of redistribution rules.
    SitePath string
    Policy path to Global Manager site (domain). This attribute is required for NSX Global Manager and not applicable otherwise.
    bgpEnabled Boolean
    Enable route redistribution for BGP. Defaults to true.
    gatewayId String
    ID of the Tier-0 Gateway
    gatewayPath String
    Policy path to Tier0 Gateway.
    localeServiceId String
    ID of the Tier-0 Gateway locale service.
    ospfEnabled Boolean
    Enable route redistribution for OSPF. Defaults to false. Applicable from NSX 3.1.0 onwards.
    policyGatewayRedistributionConfigId String
    ID of the resource.
    rules List<PolicyGatewayRedistributionConfigRule>
    List of redistribution rules.
    sitePath String
    Policy path to Global Manager site (domain). This attribute is required for NSX Global Manager and not applicable otherwise.
    bgpEnabled boolean
    Enable route redistribution for BGP. Defaults to true.
    gatewayId string
    ID of the Tier-0 Gateway
    gatewayPath string
    Policy path to Tier0 Gateway.
    localeServiceId string
    ID of the Tier-0 Gateway locale service.
    ospfEnabled boolean
    Enable route redistribution for OSPF. Defaults to false. Applicable from NSX 3.1.0 onwards.
    policyGatewayRedistributionConfigId string
    ID of the resource.
    rules PolicyGatewayRedistributionConfigRule[]
    List of redistribution rules.
    sitePath string
    Policy path to Global Manager site (domain). This attribute is required for NSX Global Manager and not applicable otherwise.
    bgp_enabled bool
    Enable route redistribution for BGP. Defaults to true.
    gateway_id str
    ID of the Tier-0 Gateway
    gateway_path str
    Policy path to Tier0 Gateway.
    locale_service_id str
    ID of the Tier-0 Gateway locale service.
    ospf_enabled bool
    Enable route redistribution for OSPF. Defaults to false. Applicable from NSX 3.1.0 onwards.
    policy_gateway_redistribution_config_id str
    ID of the resource.
    rules Sequence[PolicyGatewayRedistributionConfigRuleArgs]
    List of redistribution rules.
    site_path str
    Policy path to Global Manager site (domain). This attribute is required for NSX Global Manager and not applicable otherwise.
    bgpEnabled Boolean
    Enable route redistribution for BGP. Defaults to true.
    gatewayId String
    ID of the Tier-0 Gateway
    gatewayPath String
    Policy path to Tier0 Gateway.
    localeServiceId String
    ID of the Tier-0 Gateway locale service.
    ospfEnabled Boolean
    Enable route redistribution for OSPF. Defaults to false. Applicable from NSX 3.1.0 onwards.
    policyGatewayRedistributionConfigId String
    ID of the resource.
    rules List<Property Map>
    List of redistribution rules.
    sitePath String
    Policy path to Global Manager site (domain). This attribute is required for NSX Global Manager and not applicable otherwise.

    Supporting Types

    PolicyGatewayRedistributionConfigRule, PolicyGatewayRedistributionConfigRuleArgs

    Bgp bool
    BGP destination for this rule
    Name string
    Rule name.
    Ospf bool
    OSPF destination for this rule
    RouteMapPath string
    Route map to be associated with the redistribution rule.
    Types List<string>
    List of redistribution types, possible values are: TIER0_STATIC, TIER0_CONNECTED, TIER0_EXTERNAL_INTERFACE, TIER0_SEGMENT, TIER0_ROUTER_LINK, TIER0_SERVICE_INTERFACE, TIER0_LOOPBACK_INTERFACE, TIER0_DNS_FORWARDER_IP, TIER0_IPSEC_LOCAL_IP, TIER0_NAT, TIER0_EVPN_TEP_IP, TIER1_NAT, TIER1_STATIC, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_CONNECTED, TIER1_SERVICE_INTERFACE, TIER1_SEGMENT, TIER1_IPSEC_LOCAL_ENDPOINT.
    Bgp bool
    BGP destination for this rule
    Name string
    Rule name.
    Ospf bool
    OSPF destination for this rule
    RouteMapPath string
    Route map to be associated with the redistribution rule.
    Types []string
    List of redistribution types, possible values are: TIER0_STATIC, TIER0_CONNECTED, TIER0_EXTERNAL_INTERFACE, TIER0_SEGMENT, TIER0_ROUTER_LINK, TIER0_SERVICE_INTERFACE, TIER0_LOOPBACK_INTERFACE, TIER0_DNS_FORWARDER_IP, TIER0_IPSEC_LOCAL_IP, TIER0_NAT, TIER0_EVPN_TEP_IP, TIER1_NAT, TIER1_STATIC, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_CONNECTED, TIER1_SERVICE_INTERFACE, TIER1_SEGMENT, TIER1_IPSEC_LOCAL_ENDPOINT.
    bgp Boolean
    BGP destination for this rule
    name String
    Rule name.
    ospf Boolean
    OSPF destination for this rule
    routeMapPath String
    Route map to be associated with the redistribution rule.
    types List<String>
    List of redistribution types, possible values are: TIER0_STATIC, TIER0_CONNECTED, TIER0_EXTERNAL_INTERFACE, TIER0_SEGMENT, TIER0_ROUTER_LINK, TIER0_SERVICE_INTERFACE, TIER0_LOOPBACK_INTERFACE, TIER0_DNS_FORWARDER_IP, TIER0_IPSEC_LOCAL_IP, TIER0_NAT, TIER0_EVPN_TEP_IP, TIER1_NAT, TIER1_STATIC, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_CONNECTED, TIER1_SERVICE_INTERFACE, TIER1_SEGMENT, TIER1_IPSEC_LOCAL_ENDPOINT.
    bgp boolean
    BGP destination for this rule
    name string
    Rule name.
    ospf boolean
    OSPF destination for this rule
    routeMapPath string
    Route map to be associated with the redistribution rule.
    types string[]
    List of redistribution types, possible values are: TIER0_STATIC, TIER0_CONNECTED, TIER0_EXTERNAL_INTERFACE, TIER0_SEGMENT, TIER0_ROUTER_LINK, TIER0_SERVICE_INTERFACE, TIER0_LOOPBACK_INTERFACE, TIER0_DNS_FORWARDER_IP, TIER0_IPSEC_LOCAL_IP, TIER0_NAT, TIER0_EVPN_TEP_IP, TIER1_NAT, TIER1_STATIC, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_CONNECTED, TIER1_SERVICE_INTERFACE, TIER1_SEGMENT, TIER1_IPSEC_LOCAL_ENDPOINT.
    bgp bool
    BGP destination for this rule
    name str
    Rule name.
    ospf bool
    OSPF destination for this rule
    route_map_path str
    Route map to be associated with the redistribution rule.
    types Sequence[str]
    List of redistribution types, possible values are: TIER0_STATIC, TIER0_CONNECTED, TIER0_EXTERNAL_INTERFACE, TIER0_SEGMENT, TIER0_ROUTER_LINK, TIER0_SERVICE_INTERFACE, TIER0_LOOPBACK_INTERFACE, TIER0_DNS_FORWARDER_IP, TIER0_IPSEC_LOCAL_IP, TIER0_NAT, TIER0_EVPN_TEP_IP, TIER1_NAT, TIER1_STATIC, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_CONNECTED, TIER1_SERVICE_INTERFACE, TIER1_SEGMENT, TIER1_IPSEC_LOCAL_ENDPOINT.
    bgp Boolean
    BGP destination for this rule
    name String
    Rule name.
    ospf Boolean
    OSPF destination for this rule
    routeMapPath String
    Route map to be associated with the redistribution rule.
    types List<String>
    List of redistribution types, possible values are: TIER0_STATIC, TIER0_CONNECTED, TIER0_EXTERNAL_INTERFACE, TIER0_SEGMENT, TIER0_ROUTER_LINK, TIER0_SERVICE_INTERFACE, TIER0_LOOPBACK_INTERFACE, TIER0_DNS_FORWARDER_IP, TIER0_IPSEC_LOCAL_IP, TIER0_NAT, TIER0_EVPN_TEP_IP, TIER1_NAT, TIER1_STATIC, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_CONNECTED, TIER1_SERVICE_INTERFACE, TIER1_SEGMENT, TIER1_IPSEC_LOCAL_ENDPOINT.

    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