Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Hpegl Provider
  3. API Docs
  4. VmaasRouterRoute
hpegl 0.4.18 published on Friday, Apr 18, 2025 by hpe
hpe/terraform-provider-hpegl

hpegl.VmaasRouterRoute

Explore with Pulumi AI

hpegl logo
hpegl 0.4.18 published on Friday, Apr 18, 2025 by hpe
hpe/terraform-provider-hpegl

    Compatible version >= 5.2.12

    Router route resource facilitates creating, updating and deleting NSX-T Network Router routes.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as hpegl from "@pulumi/hpegl";

const tfRoute = new hpegl.VmaasRouterRoute("tfRoute", {
    defaultRoute: false,
    description: "my description",
    enabled: true,
    mtu: 65535,
    network: "30.0.0.0/24",
    nextHop: "88.88.88.91",
    priority: 100,
    routerId: 71,
});

    import pulumi
import pulumi_hpegl as hpegl

tf_route = hpegl.VmaasRouterRoute("tfRoute",
    default_route=False,
    description="my description",
    enabled=True,
    mtu=65535,
    network="30.0.0.0/24",
    next_hop="88.88.88.91",
    priority=100,
    router_id=71)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/hpegl/hpegl"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := hpegl.NewVmaasRouterRoute(ctx, "tfRoute", &hpegl.VmaasRouterRouteArgs{
			DefaultRoute: pulumi.Bool(false),
			Description:  pulumi.String("my description"),
			Enabled:      pulumi.Bool(true),
			Mtu:          pulumi.Float64(65535),
			Network:      pulumi.String("30.0.0.0/24"),
			NextHop:      pulumi.String("88.88.88.91"),
			Priority:     pulumi.Float64(100),
			RouterId:     pulumi.Float64(71),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Hpegl = Pulumi.Hpegl;

return await Deployment.RunAsync(() => 
{
    var tfRoute = new Hpegl.VmaasRouterRoute("tfRoute", new()
    {
        DefaultRoute = false,
        Description = "my description",
        Enabled = true,
        Mtu = 65535,
        Network = "30.0.0.0/24",
        NextHop = "88.88.88.91",
        Priority = 100,
        RouterId = 71,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.hpegl.VmaasRouterRoute;
import com.pulumi.hpegl.VmaasRouterRouteArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var tfRoute = new VmaasRouterRoute("tfRoute", VmaasRouterRouteArgs.builder()
            .defaultRoute(false)
            .description("my description")
            .enabled(true)
            .mtu("65535")
            .network("30.0.0.0/24")
            .nextHop("88.88.88.91")
            .priority(100)
            .routerId(71)
            .build());

    }
}

    resources:
  tfRoute:
    type: hpegl:VmaasRouterRoute
    properties:
      defaultRoute: false
      description: my description
      enabled: true
      mtu: '65535'
      network: 30.0.0.0/24
      nextHop: 88.88.88.91
      priority: 100
      routerId: 71

    Create VmaasRouterRoute Resource

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

    Constructor syntax

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

@overload
def VmaasRouterRoute(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     network: Optional[str] = None,
                     next_hop: Optional[str] = None,
                     router_id: Optional[float] = None,
                     default_route: Optional[bool] = None,
                     description: Optional[str] = None,
                     enabled: Optional[bool] = None,
                     mtu: Optional[float] = None,
                     name: Optional[str] = None,
                     priority: Optional[float] = None,
                     vmaas_router_route_id: Optional[str] = None)
    func NewVmaasRouterRoute(ctx *Context, name string, args VmaasRouterRouteArgs, opts ...ResourceOption) (*VmaasRouterRoute, error)
    public VmaasRouterRoute(string name, VmaasRouterRouteArgs args, CustomResourceOptions? opts = null)
    public VmaasRouterRoute(String name, VmaasRouterRouteArgs args)
public VmaasRouterRoute(String name, VmaasRouterRouteArgs args, CustomResourceOptions options)

    type: hpegl:VmaasRouterRoute
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 VmaasRouterRouteArgs
    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 VmaasRouterRouteArgs
    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 VmaasRouterRouteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VmaasRouterRouteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VmaasRouterRouteArgs
    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 vmaasRouterRouteResource = new Hpegl.VmaasRouterRoute("vmaasRouterRouteResource", new()
{
    Network = "string",
    NextHop = "string",
    RouterId = 0,
    DefaultRoute = false,
    Description = "string",
    Enabled = false,
    Mtu = 0,
    Name = "string",
    Priority = 0,
    VmaasRouterRouteId = "string",
});

    example, err := hpegl.NewVmaasRouterRoute(ctx, "vmaasRouterRouteResource", &hpegl.VmaasRouterRouteArgs{
	Network:            pulumi.String("string"),
	NextHop:            pulumi.String("string"),
	RouterId:           pulumi.Float64(0),
	DefaultRoute:       pulumi.Bool(false),
	Description:        pulumi.String("string"),
	Enabled:            pulumi.Bool(false),
	Mtu:                pulumi.Float64(0),
	Name:               pulumi.String("string"),
	Priority:           pulumi.Float64(0),
	VmaasRouterRouteId: pulumi.String("string"),
})

    var vmaasRouterRouteResource = new VmaasRouterRoute("vmaasRouterRouteResource", VmaasRouterRouteArgs.builder()
    .network("string")
    .nextHop("string")
    .routerId(0.0)
    .defaultRoute(false)
    .description("string")
    .enabled(false)
    .mtu(0.0)
    .name("string")
    .priority(0.0)
    .vmaasRouterRouteId("string")
    .build());

    vmaas_router_route_resource = hpegl.VmaasRouterRoute("vmaasRouterRouteResource",
    network="string",
    next_hop="string",
    router_id=0,
    default_route=False,
    description="string",
    enabled=False,
    mtu=0,
    name="string",
    priority=0,
    vmaas_router_route_id="string")

    const vmaasRouterRouteResource = new hpegl.VmaasRouterRoute("vmaasRouterRouteResource", {
    network: "string",
    nextHop: "string",
    routerId: 0,
    defaultRoute: false,
    description: "string",
    enabled: false,
    mtu: 0,
    name: "string",
    priority: 0,
    vmaasRouterRouteId: "string",
});

    type: hpegl:VmaasRouterRoute
properties:
    defaultRoute: false
    description: string
    enabled: false
    mtu: 0
    name: string
    network: string
    nextHop: string
    priority: 0
    routerId: 0
    vmaasRouterRouteId: string

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

    Network string
    Source Network CIDR Address
    NextHop string
    Next Hop/Destination IPv4 Address
    RouterId double
    Parent router ID, router_id can be obtained by using router datasource/resource.
    DefaultRoute bool
    If true then the route will considered as the default route.
    Description string
    Description for the route.
    Enabled bool
    If true then route will be active/enabled.
    Mtu double
    Network MTU
    Name string
    Name of the route.
    Priority double
    Priority for the route
    VmaasRouterRouteId string
    The ID of this resource.
    Network string
    Source Network CIDR Address
    NextHop string
    Next Hop/Destination IPv4 Address
    RouterId float64
    Parent router ID, router_id can be obtained by using router datasource/resource.
    DefaultRoute bool
    If true then the route will considered as the default route.
    Description string
    Description for the route.
    Enabled bool
    If true then route will be active/enabled.
    Mtu float64
    Network MTU
    Name string
    Name of the route.
    Priority float64
    Priority for the route
    VmaasRouterRouteId string
    The ID of this resource.
    network String
    Source Network CIDR Address
    nextHop String
    Next Hop/Destination IPv4 Address
    routerId Double
    Parent router ID, router_id can be obtained by using router datasource/resource.
    defaultRoute Boolean
    If true then the route will considered as the default route.
    description String
    Description for the route.
    enabled Boolean
    If true then route will be active/enabled.
    mtu Double
    Network MTU
    name String
    Name of the route.
    priority Double
    Priority for the route
    vmaasRouterRouteId String
    The ID of this resource.
    network string
    Source Network CIDR Address
    nextHop string
    Next Hop/Destination IPv4 Address
    routerId number
    Parent router ID, router_id can be obtained by using router datasource/resource.
    defaultRoute boolean
    If true then the route will considered as the default route.
    description string
    Description for the route.
    enabled boolean
    If true then route will be active/enabled.
    mtu number
    Network MTU
    name string
    Name of the route.
    priority number
    Priority for the route
    vmaasRouterRouteId string
    The ID of this resource.
    network str
    Source Network CIDR Address
    next_hop str
    Next Hop/Destination IPv4 Address
    router_id float
    Parent router ID, router_id can be obtained by using router datasource/resource.
    default_route bool
    If true then the route will considered as the default route.
    description str
    Description for the route.
    enabled bool
    If true then route will be active/enabled.
    mtu float
    Network MTU
    name str
    Name of the route.
    priority float
    Priority for the route
    vmaas_router_route_id str
    The ID of this resource.
    network String
    Source Network CIDR Address
    nextHop String
    Next Hop/Destination IPv4 Address
    routerId Number
    Parent router ID, router_id can be obtained by using router datasource/resource.
    defaultRoute Boolean
    If true then the route will considered as the default route.
    description String
    Description for the route.
    enabled Boolean
    If true then route will be active/enabled.
    mtu Number
    Network MTU
    name String
    Name of the route.
    priority Number
    Priority for the route
    vmaasRouterRouteId String
    The ID of this resource.

    Outputs

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

    Code string
    ExternalId string
    Id string
    The provider-assigned unique ID for this managed resource.
    IsDeprecated bool
    If parent router not found, then is_deprecated will be true
    ProviderId string
    RouteType string
    SourceType string
    Code string
    ExternalId string
    Id string
    The provider-assigned unique ID for this managed resource.
    IsDeprecated bool
    If parent router not found, then is_deprecated will be true
    ProviderId string
    RouteType string
    SourceType string
    code String
    externalId String
    id String
    The provider-assigned unique ID for this managed resource.
    isDeprecated Boolean
    If parent router not found, then is_deprecated will be true
    providerId String
    routeType String
    sourceType String
    code string
    externalId string
    id string
    The provider-assigned unique ID for this managed resource.
    isDeprecated boolean
    If parent router not found, then is_deprecated will be true
    providerId string
    routeType string
    sourceType string
    code str
    external_id str
    id str
    The provider-assigned unique ID for this managed resource.
    is_deprecated bool
    If parent router not found, then is_deprecated will be true
    provider_id str
    route_type str
    source_type str
    code String
    externalId String
    id String
    The provider-assigned unique ID for this managed resource.
    isDeprecated Boolean
    If parent router not found, then is_deprecated will be true
    providerId String
    routeType String
    sourceType String

    Look up Existing VmaasRouterRoute Resource

    Get an existing VmaasRouterRoute 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?: VmaasRouterRouteState, opts?: CustomResourceOptions): VmaasRouterRoute
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        code: Optional[str] = None,
        default_route: Optional[bool] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        external_id: Optional[str] = None,
        is_deprecated: Optional[bool] = None,
        mtu: Optional[float] = None,
        name: Optional[str] = None,
        network: Optional[str] = None,
        next_hop: Optional[str] = None,
        priority: Optional[float] = None,
        provider_id: Optional[str] = None,
        route_type: Optional[str] = None,
        router_id: Optional[float] = None,
        source_type: Optional[str] = None,
        vmaas_router_route_id: Optional[str] = None) -> VmaasRouterRoute
    func GetVmaasRouterRoute(ctx *Context, name string, id IDInput, state *VmaasRouterRouteState, opts ...ResourceOption) (*VmaasRouterRoute, error)
    public static VmaasRouterRoute Get(string name, Input<string> id, VmaasRouterRouteState? state, CustomResourceOptions? opts = null)
    public static VmaasRouterRoute get(String name, Output<String> id, VmaasRouterRouteState state, CustomResourceOptions options)
    resources:  _:    type: hpegl:VmaasRouterRoute    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:
    Code string
    DefaultRoute bool
    If true then the route will considered as the default route.
    Description string
    Description for the route.
    Enabled bool
    If true then route will be active/enabled.
    ExternalId string
    IsDeprecated bool
    If parent router not found, then is_deprecated will be true
    Mtu double
    Network MTU
    Name string
    Name of the route.
    Network string
    Source Network CIDR Address
    NextHop string
    Next Hop/Destination IPv4 Address
    Priority double
    Priority for the route
    ProviderId string
    RouteType string
    RouterId double
    Parent router ID, router_id can be obtained by using router datasource/resource.
    SourceType string
    VmaasRouterRouteId string
    The ID of this resource.
    Code string
    DefaultRoute bool
    If true then the route will considered as the default route.
    Description string
    Description for the route.
    Enabled bool
    If true then route will be active/enabled.
    ExternalId string
    IsDeprecated bool
    If parent router not found, then is_deprecated will be true
    Mtu float64
    Network MTU
    Name string
    Name of the route.
    Network string
    Source Network CIDR Address
    NextHop string
    Next Hop/Destination IPv4 Address
    Priority float64
    Priority for the route
    ProviderId string
    RouteType string
    RouterId float64
    Parent router ID, router_id can be obtained by using router datasource/resource.
    SourceType string
    VmaasRouterRouteId string
    The ID of this resource.
    code String
    defaultRoute Boolean
    If true then the route will considered as the default route.
    description String
    Description for the route.
    enabled Boolean
    If true then route will be active/enabled.
    externalId String
    isDeprecated Boolean
    If parent router not found, then is_deprecated will be true
    mtu Double
    Network MTU
    name String
    Name of the route.
    network String
    Source Network CIDR Address
    nextHop String
    Next Hop/Destination IPv4 Address
    priority Double
    Priority for the route
    providerId String
    routeType String
    routerId Double
    Parent router ID, router_id can be obtained by using router datasource/resource.
    sourceType String
    vmaasRouterRouteId String
    The ID of this resource.
    code string
    defaultRoute boolean
    If true then the route will considered as the default route.
    description string
    Description for the route.
    enabled boolean
    If true then route will be active/enabled.
    externalId string
    isDeprecated boolean
    If parent router not found, then is_deprecated will be true
    mtu number
    Network MTU
    name string
    Name of the route.
    network string
    Source Network CIDR Address
    nextHop string
    Next Hop/Destination IPv4 Address
    priority number
    Priority for the route
    providerId string
    routeType string
    routerId number
    Parent router ID, router_id can be obtained by using router datasource/resource.
    sourceType string
    vmaasRouterRouteId string
    The ID of this resource.
    code str
    default_route bool
    If true then the route will considered as the default route.
    description str
    Description for the route.
    enabled bool
    If true then route will be active/enabled.
    external_id str
    is_deprecated bool
    If parent router not found, then is_deprecated will be true
    mtu float
    Network MTU
    name str
    Name of the route.
    network str
    Source Network CIDR Address
    next_hop str
    Next Hop/Destination IPv4 Address
    priority float
    Priority for the route
    provider_id str
    route_type str
    router_id float
    Parent router ID, router_id can be obtained by using router datasource/resource.
    source_type str
    vmaas_router_route_id str
    The ID of this resource.
    code String
    defaultRoute Boolean
    If true then the route will considered as the default route.
    description String
    Description for the route.
    enabled Boolean
    If true then route will be active/enabled.
    externalId String
    isDeprecated Boolean
    If parent router not found, then is_deprecated will be true
    mtu Number
    Network MTU
    name String
    Name of the route.
    network String
    Source Network CIDR Address
    nextHop String
    Next Hop/Destination IPv4 Address
    priority Number
    Priority for the route
    providerId String
    routeType String
    routerId Number
    Parent router ID, router_id can be obtained by using router datasource/resource.
    sourceType String
    vmaasRouterRouteId String
    The ID of this resource.

    Package Details

    Repository
    hpegl hpe/terraform-provider-hpegl
    License
    Notes
    This Pulumi package is based on the hpegl Terraform Provider.
    hpegl logo
    hpegl 0.4.18 published on Friday, Apr 18, 2025 by hpe
    hpe/terraform-provider-hpegl