Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Bigip Provider
  3. API Docs
  4. net
  5. Route
f5 BIG-IP v3.17.6 published on Monday, Oct 28, 2024 by Pulumi
pulumi/pulumi-f5bigip

f5bigip.net.Route

Explore with Pulumi AI

f5bigip logo
f5 BIG-IP v3.17.6 published on Monday, Oct 28, 2024 by Pulumi
pulumi/pulumi-f5bigip

    f5bigip.net.Route Manages a route configuration

    For resources should be named with their “full path”. The full path is the combination of the partition + name of the resource. For example /Common/my-pool.

    Example Usage

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

const route2 = new f5bigip.net.Route("route2", {
    name: "/Common/external-route",
    network: "10.10.10.0/24",
    gw: "1.1.1.2",
});

    import pulumi
import pulumi_f5bigip as f5bigip

route2 = f5bigip.net.Route("route2",
    name="/Common/external-route",
    network="10.10.10.0/24",
    gw="1.1.1.2")

    package main

import (
	"github.com/pulumi/pulumi-f5bigip/sdk/v3/go/f5bigip/net"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := net.NewRoute(ctx, "route2", &net.RouteArgs{
			Name:    pulumi.String("/Common/external-route"),
			Network: pulumi.String("10.10.10.0/24"),
			Gw:      pulumi.String("1.1.1.2"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var route2 = new F5BigIP.Net.Route("route2", new()
    {
        Name = "/Common/external-route",
        Network = "10.10.10.0/24",
        Gw = "1.1.1.2",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.f5bigip.net.Route;
import com.pulumi.f5bigip.net.RouteArgs;
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 route2 = new Route("route2", RouteArgs.builder()
            .name("/Common/external-route")
            .network("10.10.10.0/24")
            .gw("1.1.1.2")
            .build());

    }
}

    resources:
  route2:
    type: f5bigip:net:Route
    properties:
      name: /Common/external-route
      network: 10.10.10.0/24
      gw: 1.1.1.2

    Create Route Resource

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

    Constructor syntax

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

@overload
def Route(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          name: Optional[str] = None,
          network: Optional[str] = None,
          gw: Optional[str] = None,
          reject: Optional[bool] = None,
          tunnel_ref: Optional[str] = None)
    func NewRoute(ctx *Context, name string, args RouteArgs, opts ...ResourceOption) (*Route, error)
    public Route(string name, RouteArgs args, CustomResourceOptions? opts = null)
    public Route(String name, RouteArgs args)
public Route(String name, RouteArgs args, CustomResourceOptions options)

    type: f5bigip:net:Route
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 RouteArgs
    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 RouteArgs
    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 RouteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RouteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RouteArgs
    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 routeResource = new F5BigIP.Net.Route("routeResource", new()
{
    Name = "string",
    Network = "string",
    Gw = "string",
    Reject = false,
    TunnelRef = "string",
});

    example, err := net.NewRoute(ctx, "routeResource", &net.RouteArgs{
	Name:      pulumi.String("string"),
	Network:   pulumi.String("string"),
	Gw:        pulumi.String("string"),
	Reject:    pulumi.Bool(false),
	TunnelRef: pulumi.String("string"),
})

    var routeResource = new Route("routeResource", RouteArgs.builder()
    .name("string")
    .network("string")
    .gw("string")
    .reject(false)
    .tunnelRef("string")
    .build());

    route_resource = f5bigip.net.Route("routeResource",
    name="string",
    network="string",
    gw="string",
    reject=False,
    tunnel_ref="string")

    const routeResource = new f5bigip.net.Route("routeResource", {
    name: "string",
    network: "string",
    gw: "string",
    reject: false,
    tunnelRef: "string",
});

    type: f5bigip:net:Route
properties:
    gw: string
    name: string
    network: string
    reject: false
    tunnelRef: string

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

    Name string
    Name of the route.Name of Route should be full path,full path is the combination of the partition + route name,For ex: /Common/test-net-route.
    Network string
    The destination subnet and netmask for the route.
    Gw string
    Specifies a gateway address for the route.
    Reject bool
    reject route
    TunnelRef string
    tunnel_ref to route traffic
    Name string
    Name of the route.Name of Route should be full path,full path is the combination of the partition + route name,For ex: /Common/test-net-route.
    Network string
    The destination subnet and netmask for the route.
    Gw string
    Specifies a gateway address for the route.
    Reject bool
    reject route
    TunnelRef string
    tunnel_ref to route traffic
    name String
    Name of the route.Name of Route should be full path,full path is the combination of the partition + route name,For ex: /Common/test-net-route.
    network String
    The destination subnet and netmask for the route.
    gw String
    Specifies a gateway address for the route.
    reject Boolean
    reject route
    tunnelRef String
    tunnel_ref to route traffic
    name string
    Name of the route.Name of Route should be full path,full path is the combination of the partition + route name,For ex: /Common/test-net-route.
    network string
    The destination subnet and netmask for the route.
    gw string
    Specifies a gateway address for the route.
    reject boolean
    reject route
    tunnelRef string
    tunnel_ref to route traffic
    name str
    Name of the route.Name of Route should be full path,full path is the combination of the partition + route name,For ex: /Common/test-net-route.
    network str
    The destination subnet and netmask for the route.
    gw str
    Specifies a gateway address for the route.
    reject bool
    reject route
    tunnel_ref str
    tunnel_ref to route traffic
    name String
    Name of the route.Name of Route should be full path,full path is the combination of the partition + route name,For ex: /Common/test-net-route.
    network String
    The destination subnet and netmask for the route.
    gw String
    Specifies a gateway address for the route.
    reject Boolean
    reject route
    tunnelRef String
    tunnel_ref to route traffic

    Outputs

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

    Get an existing Route 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?: RouteState, opts?: CustomResourceOptions): Route
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        gw: Optional[str] = None,
        name: Optional[str] = None,
        network: Optional[str] = None,
        reject: Optional[bool] = None,
        tunnel_ref: Optional[str] = None) -> Route
    func GetRoute(ctx *Context, name string, id IDInput, state *RouteState, opts ...ResourceOption) (*Route, error)
    public static Route Get(string name, Input<string> id, RouteState? state, CustomResourceOptions? opts = null)
    public static Route get(String name, Output<String> id, RouteState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Gw string
    Specifies a gateway address for the route.
    Name string
    Name of the route.Name of Route should be full path,full path is the combination of the partition + route name,For ex: /Common/test-net-route.
    Network string
    The destination subnet and netmask for the route.
    Reject bool
    reject route
    TunnelRef string
    tunnel_ref to route traffic
    Gw string
    Specifies a gateway address for the route.
    Name string
    Name of the route.Name of Route should be full path,full path is the combination of the partition + route name,For ex: /Common/test-net-route.
    Network string
    The destination subnet and netmask for the route.
    Reject bool
    reject route
    TunnelRef string
    tunnel_ref to route traffic
    gw String
    Specifies a gateway address for the route.
    name String
    Name of the route.Name of Route should be full path,full path is the combination of the partition + route name,For ex: /Common/test-net-route.
    network String
    The destination subnet and netmask for the route.
    reject Boolean
    reject route
    tunnelRef String
    tunnel_ref to route traffic
    gw string
    Specifies a gateway address for the route.
    name string
    Name of the route.Name of Route should be full path,full path is the combination of the partition + route name,For ex: /Common/test-net-route.
    network string
    The destination subnet and netmask for the route.
    reject boolean
    reject route
    tunnelRef string
    tunnel_ref to route traffic
    gw str
    Specifies a gateway address for the route.
    name str
    Name of the route.Name of Route should be full path,full path is the combination of the partition + route name,For ex: /Common/test-net-route.
    network str
    The destination subnet and netmask for the route.
    reject bool
    reject route
    tunnel_ref str
    tunnel_ref to route traffic
    gw String
    Specifies a gateway address for the route.
    name String
    Name of the route.Name of Route should be full path,full path is the combination of the partition + route name,For ex: /Common/test-net-route.
    network String
    The destination subnet and netmask for the route.
    reject Boolean
    reject route
    tunnelRef String
    tunnel_ref to route traffic

    Package Details

    Repository
    f5 BIG-IP pulumi/pulumi-f5bigip
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the bigip Terraform Provider.
    f5bigip logo
    f5 BIG-IP v3.17.6 published on Monday, Oct 28, 2024 by Pulumi
    pulumi/pulumi-f5bigip