OpenStack v3.12.1, Mar 23 23

openstack.networking.SubnetRoute

Creates a routing entry on a OpenStack V2 subnet.

Example Usage

using System.Collections.Generic;
using Pulumi;
using OpenStack = Pulumi.OpenStack;

return await Deployment.RunAsync(() => 
{
    var router1 = new OpenStack.Networking.Router("router1", new()
    {
        AdminStateUp = true,
    });

    var network1 = new OpenStack.Networking.Network("network1", new()
    {
        AdminStateUp = true,
    });

    var subnet1 = new OpenStack.Networking.Subnet("subnet1", new()
    {
        Cidr = "192.168.199.0/24",
        IpVersion = 4,
        NetworkId = network1.Id,
    });

    var subnetRoute1 = new OpenStack.Networking.SubnetRoute("subnetRoute1", new()
    {
        DestinationCidr = "10.0.1.0/24",
        NextHop = "192.168.199.254",
        SubnetId = subnet1.Id,
    });

});

package main

import (
	"github.com/pulumi/pulumi-openstack/sdk/v3/go/openstack/networking"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networking.NewRouter(ctx, "router1", &networking.RouterArgs{
			AdminStateUp: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		network1, err := networking.NewNetwork(ctx, "network1", &networking.NetworkArgs{
			AdminStateUp: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		subnet1, err := networking.NewSubnet(ctx, "subnet1", &networking.SubnetArgs{
			Cidr:      pulumi.String("192.168.199.0/24"),
			IpVersion: pulumi.Int(4),
			NetworkId: network1.ID(),
		})
		if err != nil {
			return err
		}
		_, err = networking.NewSubnetRoute(ctx, "subnetRoute1", &networking.SubnetRouteArgs{
			DestinationCidr: pulumi.String("10.0.1.0/24"),
			NextHop:         pulumi.String("192.168.199.254"),
			SubnetId:        subnet1.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.openstack.networking.Router;
import com.pulumi.openstack.networking.RouterArgs;
import com.pulumi.openstack.networking.Network;
import com.pulumi.openstack.networking.NetworkArgs;
import com.pulumi.openstack.networking.Subnet;
import com.pulumi.openstack.networking.SubnetArgs;
import com.pulumi.openstack.networking.SubnetRoute;
import com.pulumi.openstack.networking.SubnetRouteArgs;
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 router1 = new Router("router1", RouterArgs.builder()        
            .adminStateUp("true")
            .build());

        var network1 = new Network("network1", NetworkArgs.builder()        
            .adminStateUp("true")
            .build());

        var subnet1 = new Subnet("subnet1", SubnetArgs.builder()        
            .cidr("192.168.199.0/24")
            .ipVersion(4)
            .networkId(network1.id())
            .build());

        var subnetRoute1 = new SubnetRoute("subnetRoute1", SubnetRouteArgs.builder()        
            .destinationCidr("10.0.1.0/24")
            .nextHop("192.168.199.254")
            .subnetId(subnet1.id())
            .build());

    }
}

import pulumi
import pulumi_openstack as openstack

router1 = openstack.networking.Router("router1", admin_state_up=True)
network1 = openstack.networking.Network("network1", admin_state_up=True)
subnet1 = openstack.networking.Subnet("subnet1",
    cidr="192.168.199.0/24",
    ip_version=4,
    network_id=network1.id)
subnet_route1 = openstack.networking.SubnetRoute("subnetRoute1",
    destination_cidr="10.0.1.0/24",
    next_hop="192.168.199.254",
    subnet_id=subnet1.id)

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

const router1 = new openstack.networking.Router("router1", {adminStateUp: true});
const network1 = new openstack.networking.Network("network1", {adminStateUp: true});
const subnet1 = new openstack.networking.Subnet("subnet1", {
    cidr: "192.168.199.0/24",
    ipVersion: 4,
    networkId: network1.id,
});
const subnetRoute1 = new openstack.networking.SubnetRoute("subnetRoute1", {
    destinationCidr: "10.0.1.0/24",
    nextHop: "192.168.199.254",
    subnetId: subnet1.id,
});

resources:
  router1:
    type: openstack:networking:Router
    properties:
      adminStateUp: 'true'
  network1:
    type: openstack:networking:Network
    properties:
      adminStateUp: 'true'
  subnet1:
    type: openstack:networking:Subnet
    properties:
      cidr: 192.168.199.0/24
      ipVersion: 4
      networkId: ${network1.id}
  subnetRoute1:
    type: openstack:networking:SubnetRoute
    properties:
      destinationCidr: 10.0.1.0/24
      nextHop: 192.168.199.254
      subnetId: ${subnet1.id}

Create SubnetRoute Resource

new SubnetRoute(name: string, args: SubnetRouteArgs, opts?: CustomResourceOptions);

@overload
def SubnetRoute(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                destination_cidr: Optional[str] = None,
                next_hop: Optional[str] = None,
                region: Optional[str] = None,
                subnet_id: Optional[str] = None)
@overload
def SubnetRoute(resource_name: str,
                args: SubnetRouteArgs,
                opts: Optional[ResourceOptions] = None)

func NewSubnetRoute(ctx *Context, name string, args SubnetRouteArgs, opts ...ResourceOption) (*SubnetRoute, error)

public SubnetRoute(string name, SubnetRouteArgs args, CustomResourceOptions? opts = null)

public SubnetRoute(String name, SubnetRouteArgs args)
public SubnetRoute(String name, SubnetRouteArgs args, CustomResourceOptions options)

type: openstack:networking:SubnetRoute
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SubnetRouteArgs: 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 SubnetRouteArgs: 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 SubnetRouteArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SubnetRouteArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SubnetRouteArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

SubnetRoute Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The SubnetRoute resource accepts the following input properties:

DestinationCidr string: CIDR block to match on the packet’s destination IP. Changing this creates a new routing entry.
NextHop string: IP address of the next hop gateway. Changing this creates a new routing entry.
SubnetId string: ID of the subnet this routing entry belongs to. Changing this creates a new routing entry.
Region string: The region in which to obtain the V2 networking client. A networking client is needed to configure a routing entry on a subnet. If omitted, the region argument of the provider is used. Changing this creates a new routing entry.

DestinationCidr string: CIDR block to match on the packet’s destination IP. Changing this creates a new routing entry.
NextHop string: IP address of the next hop gateway. Changing this creates a new routing entry.
SubnetId string: ID of the subnet this routing entry belongs to. Changing this creates a new routing entry.
Region string: The region in which to obtain the V2 networking client. A networking client is needed to configure a routing entry on a subnet. If omitted, the region argument of the provider is used. Changing this creates a new routing entry.

destinationCidr String: CIDR block to match on the packet’s destination IP. Changing this creates a new routing entry.
nextHop String: IP address of the next hop gateway. Changing this creates a new routing entry.
subnetId String: ID of the subnet this routing entry belongs to. Changing this creates a new routing entry.
region String: The region in which to obtain the V2 networking client. A networking client is needed to configure a routing entry on a subnet. If omitted, the region argument of the provider is used. Changing this creates a new routing entry.

destinationCidr string: CIDR block to match on the packet’s destination IP. Changing this creates a new routing entry.
nextHop string: IP address of the next hop gateway. Changing this creates a new routing entry.
subnetId string: ID of the subnet this routing entry belongs to. Changing this creates a new routing entry.
region string: The region in which to obtain the V2 networking client. A networking client is needed to configure a routing entry on a subnet. If omitted, the region argument of the provider is used. Changing this creates a new routing entry.

destination_cidr str: CIDR block to match on the packet’s destination IP. Changing this creates a new routing entry.
next_hop str: IP address of the next hop gateway. Changing this creates a new routing entry.
subnet_id str: ID of the subnet this routing entry belongs to. Changing this creates a new routing entry.
region str: The region in which to obtain the V2 networking client. A networking client is needed to configure a routing entry on a subnet. If omitted, the region argument of the provider is used. Changing this creates a new routing entry.

destinationCidr String: CIDR block to match on the packet’s destination IP. Changing this creates a new routing entry.
nextHop String: IP address of the next hop gateway. Changing this creates a new routing entry.
subnetId String: ID of the subnet this routing entry belongs to. Changing this creates a new routing entry.
region String: The region in which to obtain the V2 networking client. A networking client is needed to configure a routing entry on a subnet. If omitted, the region argument of the provider is used. Changing this creates a new routing entry.

Outputs

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

Get an existing SubnetRoute 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?: SubnetRouteState, opts?: CustomResourceOptions): SubnetRoute

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        destination_cidr: Optional[str] = None,
        next_hop: Optional[str] = None,
        region: Optional[str] = None,
        subnet_id: Optional[str] = None) -> SubnetRoute

func GetSubnetRoute(ctx *Context, name string, id IDInput, state *SubnetRouteState, opts ...ResourceOption) (*SubnetRoute, error)

public static SubnetRoute Get(string name, Input<string> id, SubnetRouteState? state, CustomResourceOptions? opts = null)

public static SubnetRoute get(String name, Output<String> id, SubnetRouteState 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:

DestinationCidr string: CIDR block to match on the packet’s destination IP. Changing this creates a new routing entry.
NextHop string: IP address of the next hop gateway. Changing this creates a new routing entry.
Region string: The region in which to obtain the V2 networking client. A networking client is needed to configure a routing entry on a subnet. If omitted, the region argument of the provider is used. Changing this creates a new routing entry.
SubnetId string: ID of the subnet this routing entry belongs to. Changing this creates a new routing entry.

DestinationCidr string: CIDR block to match on the packet’s destination IP. Changing this creates a new routing entry.
NextHop string: IP address of the next hop gateway. Changing this creates a new routing entry.
Region string: The region in which to obtain the V2 networking client. A networking client is needed to configure a routing entry on a subnet. If omitted, the region argument of the provider is used. Changing this creates a new routing entry.
SubnetId string: ID of the subnet this routing entry belongs to. Changing this creates a new routing entry.

destinationCidr String: CIDR block to match on the packet’s destination IP. Changing this creates a new routing entry.
nextHop String: IP address of the next hop gateway. Changing this creates a new routing entry.
region String: The region in which to obtain the V2 networking client. A networking client is needed to configure a routing entry on a subnet. If omitted, the region argument of the provider is used. Changing this creates a new routing entry.
subnetId String: ID of the subnet this routing entry belongs to. Changing this creates a new routing entry.

destinationCidr string: CIDR block to match on the packet’s destination IP. Changing this creates a new routing entry.
nextHop string: IP address of the next hop gateway. Changing this creates a new routing entry.
region string: The region in which to obtain the V2 networking client. A networking client is needed to configure a routing entry on a subnet. If omitted, the region argument of the provider is used. Changing this creates a new routing entry.
subnetId string: ID of the subnet this routing entry belongs to. Changing this creates a new routing entry.

destination_cidr str: CIDR block to match on the packet’s destination IP. Changing this creates a new routing entry.
next_hop str: IP address of the next hop gateway. Changing this creates a new routing entry.
region str: The region in which to obtain the V2 networking client. A networking client is needed to configure a routing entry on a subnet. If omitted, the region argument of the provider is used. Changing this creates a new routing entry.
subnet_id str: ID of the subnet this routing entry belongs to. Changing this creates a new routing entry.

destinationCidr String: CIDR block to match on the packet’s destination IP. Changing this creates a new routing entry.
nextHop String: IP address of the next hop gateway. Changing this creates a new routing entry.
region String: The region in which to obtain the V2 networking client. A networking client is needed to configure a routing entry on a subnet. If omitted, the region argument of the provider is used. Changing this creates a new routing entry.
subnetId String: ID of the subnet this routing entry belongs to. Changing this creates a new routing entry.

Import

Routing entries can be imported using a combined ID using the following format<subnet_id>-route-<destination_cidr>-<next_hop>

 $ pulumi import openstack:networking/subnetRoute:SubnetRoute subnet_route_1 686fe248-386c-4f70-9f6c-281607dad079-route-10.0.1.0/24-192.168.199.25

Package Details

Repository: OpenStack pulumi/pulumi-openstack
License: Apache-2.0
Notes: This Pulumi package is based on the openstack Terraform Provider.