Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vcd Provider
  3. API Docs
  4. NsxtRouteAdvertisement
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

vcd.NsxtRouteAdvertisement

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

    Create NsxtRouteAdvertisement Resource

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

    Constructor syntax

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

@overload
def NsxtRouteAdvertisement(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           edge_gateway_id: Optional[str] = None,
                           enabled: Optional[bool] = None,
                           nsxt_route_advertisement_id: Optional[str] = None,
                           org: Optional[str] = None,
                           subnets: Optional[Sequence[str]] = None)
    func NewNsxtRouteAdvertisement(ctx *Context, name string, args NsxtRouteAdvertisementArgs, opts ...ResourceOption) (*NsxtRouteAdvertisement, error)
    public NsxtRouteAdvertisement(string name, NsxtRouteAdvertisementArgs args, CustomResourceOptions? opts = null)
    public NsxtRouteAdvertisement(String name, NsxtRouteAdvertisementArgs args)
public NsxtRouteAdvertisement(String name, NsxtRouteAdvertisementArgs args, CustomResourceOptions options)

    type: vcd:NsxtRouteAdvertisement
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 NsxtRouteAdvertisementArgs
    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 NsxtRouteAdvertisementArgs
    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 NsxtRouteAdvertisementArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NsxtRouteAdvertisementArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NsxtRouteAdvertisementArgs
    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 nsxtRouteAdvertisementResource = new Vcd.NsxtRouteAdvertisement("nsxtRouteAdvertisementResource", new()
{
    EdgeGatewayId = "string",
    Enabled = false,
    NsxtRouteAdvertisementId = "string",
    Org = "string",
    Subnets = new[]
    {
        "string",
    },
});

    example, err := vcd.NewNsxtRouteAdvertisement(ctx, "nsxtRouteAdvertisementResource", &vcd.NsxtRouteAdvertisementArgs{
	EdgeGatewayId:            pulumi.String("string"),
	Enabled:                  pulumi.Bool(false),
	NsxtRouteAdvertisementId: pulumi.String("string"),
	Org:                      pulumi.String("string"),
	Subnets: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var nsxtRouteAdvertisementResource = new NsxtRouteAdvertisement("nsxtRouteAdvertisementResource", NsxtRouteAdvertisementArgs.builder()
    .edgeGatewayId("string")
    .enabled(false)
    .nsxtRouteAdvertisementId("string")
    .org("string")
    .subnets("string")
    .build());

    nsxt_route_advertisement_resource = vcd.NsxtRouteAdvertisement("nsxtRouteAdvertisementResource",
    edge_gateway_id="string",
    enabled=False,
    nsxt_route_advertisement_id="string",
    org="string",
    subnets=["string"])

    const nsxtRouteAdvertisementResource = new vcd.NsxtRouteAdvertisement("nsxtRouteAdvertisementResource", {
    edgeGatewayId: "string",
    enabled: false,
    nsxtRouteAdvertisementId: "string",
    org: "string",
    subnets: ["string"],
});

    type: vcd:NsxtRouteAdvertisement
properties:
    edgeGatewayId: string
    enabled: false
    nsxtRouteAdvertisementId: string
    org: string
    subnets:
        - string

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

    EdgeGatewayId string
    NSX-T Edge Gateway ID in which route advertisement is located.
    Enabled bool
    Define if route advertisement is active. Default true.
    NsxtRouteAdvertisementId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations.
    Subnets List<string>
    Set of subnets that will be advertised to Tier-0 gateway. Leaving it empty means none.
    EdgeGatewayId string
    NSX-T Edge Gateway ID in which route advertisement is located.
    Enabled bool
    Define if route advertisement is active. Default true.
    NsxtRouteAdvertisementId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations.
    Subnets []string
    Set of subnets that will be advertised to Tier-0 gateway. Leaving it empty means none.
    edgeGatewayId String
    NSX-T Edge Gateway ID in which route advertisement is located.
    enabled Boolean
    Define if route advertisement is active. Default true.
    nsxtRouteAdvertisementId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations.
    subnets List<String>
    Set of subnets that will be advertised to Tier-0 gateway. Leaving it empty means none.
    edgeGatewayId string
    NSX-T Edge Gateway ID in which route advertisement is located.
    enabled boolean
    Define if route advertisement is active. Default true.
    nsxtRouteAdvertisementId string
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations.
    subnets string[]
    Set of subnets that will be advertised to Tier-0 gateway. Leaving it empty means none.
    edge_gateway_id str
    NSX-T Edge Gateway ID in which route advertisement is located.
    enabled bool
    Define if route advertisement is active. Default true.
    nsxt_route_advertisement_id str
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations.
    subnets Sequence[str]
    Set of subnets that will be advertised to Tier-0 gateway. Leaving it empty means none.
    edgeGatewayId String
    NSX-T Edge Gateway ID in which route advertisement is located.
    enabled Boolean
    Define if route advertisement is active. Default true.
    nsxtRouteAdvertisementId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations.
    subnets List<String>
    Set of subnets that will be advertised to Tier-0 gateway. Leaving it empty means none.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing NsxtRouteAdvertisement Resource

    Get an existing NsxtRouteAdvertisement 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?: NsxtRouteAdvertisementState, opts?: CustomResourceOptions): NsxtRouteAdvertisement
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        edge_gateway_id: Optional[str] = None,
        enabled: Optional[bool] = None,
        nsxt_route_advertisement_id: Optional[str] = None,
        org: Optional[str] = None,
        subnets: Optional[Sequence[str]] = None) -> NsxtRouteAdvertisement
    func GetNsxtRouteAdvertisement(ctx *Context, name string, id IDInput, state *NsxtRouteAdvertisementState, opts ...ResourceOption) (*NsxtRouteAdvertisement, error)
    public static NsxtRouteAdvertisement Get(string name, Input<string> id, NsxtRouteAdvertisementState? state, CustomResourceOptions? opts = null)
    public static NsxtRouteAdvertisement get(String name, Output<String> id, NsxtRouteAdvertisementState state, CustomResourceOptions options)
    resources:  _:    type: vcd:NsxtRouteAdvertisement    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:
    EdgeGatewayId string
    NSX-T Edge Gateway ID in which route advertisement is located.
    Enabled bool
    Define if route advertisement is active. Default true.
    NsxtRouteAdvertisementId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations.
    Subnets List<string>
    Set of subnets that will be advertised to Tier-0 gateway. Leaving it empty means none.
    EdgeGatewayId string
    NSX-T Edge Gateway ID in which route advertisement is located.
    Enabled bool
    Define if route advertisement is active. Default true.
    NsxtRouteAdvertisementId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations.
    Subnets []string
    Set of subnets that will be advertised to Tier-0 gateway. Leaving it empty means none.
    edgeGatewayId String
    NSX-T Edge Gateway ID in which route advertisement is located.
    enabled Boolean
    Define if route advertisement is active. Default true.
    nsxtRouteAdvertisementId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations.
    subnets List<String>
    Set of subnets that will be advertised to Tier-0 gateway. Leaving it empty means none.
    edgeGatewayId string
    NSX-T Edge Gateway ID in which route advertisement is located.
    enabled boolean
    Define if route advertisement is active. Default true.
    nsxtRouteAdvertisementId string
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations.
    subnets string[]
    Set of subnets that will be advertised to Tier-0 gateway. Leaving it empty means none.
    edge_gateway_id str
    NSX-T Edge Gateway ID in which route advertisement is located.
    enabled bool
    Define if route advertisement is active. Default true.
    nsxt_route_advertisement_id str
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations.
    subnets Sequence[str]
    Set of subnets that will be advertised to Tier-0 gateway. Leaving it empty means none.
    edgeGatewayId String
    NSX-T Edge Gateway ID in which route advertisement is located.
    enabled Boolean
    Define if route advertisement is active. Default true.
    nsxtRouteAdvertisementId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations.
    subnets List<String>
    Set of subnets that will be advertised to Tier-0 gateway. Leaving it empty means none.

    Package Details

    Repository
    vcd vmware/terraform-provider-vcd
    License
    Notes
    This Pulumi package is based on the vcd Terraform Provider.
    vcd logo
    vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
    vmware/terraform-provider-vcd