1. Packages
  2. Openstack Provider
  3. API Docs
  4. networking
  5. Router
OpenStack v5.0.3 published on Wednesday, Feb 12, 2025 by Pulumi

openstack.networking.Router

Explore with Pulumi AI

Manages a V2 router resource within OpenStack.

Example Usage

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

const router1 = new openstack.networking.Router("router_1", {
    name: "my_router",
    adminStateUp: true,
    externalNetworkId: "f67f0d72-0ddf-11e4-9d95-e1f29f417e2f",
});
Copy
import pulumi
import pulumi_openstack as openstack

router1 = openstack.networking.Router("router_1",
    name="my_router",
    admin_state_up=True,
    external_network_id="f67f0d72-0ddf-11e4-9d95-e1f29f417e2f")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networking.NewRouter(ctx, "router_1", &networking.RouterArgs{
			Name:              pulumi.String("my_router"),
			AdminStateUp:      pulumi.Bool(true),
			ExternalNetworkId: pulumi.String("f67f0d72-0ddf-11e4-9d95-e1f29f417e2f"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using OpenStack = Pulumi.OpenStack;

return await Deployment.RunAsync(() => 
{
    var router1 = new OpenStack.Networking.Router("router_1", new()
    {
        Name = "my_router",
        AdminStateUp = true,
        ExternalNetworkId = "f67f0d72-0ddf-11e4-9d95-e1f29f417e2f",
    });

});
Copy
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 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()
            .name("my_router")
            .adminStateUp(true)
            .externalNetworkId("f67f0d72-0ddf-11e4-9d95-e1f29f417e2f")
            .build());

    }
}
Copy
resources:
  router1:
    type: openstack:networking:Router
    name: router_1
    properties:
      name: my_router
      adminStateUp: true
      externalNetworkId: f67f0d72-0ddf-11e4-9d95-e1f29f417e2f
Copy

Create Router Resource

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

Constructor syntax

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

@overload
def Router(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           admin_state_up: Optional[bool] = None,
           availability_zone_hints: Optional[Sequence[str]] = None,
           description: Optional[str] = None,
           distributed: Optional[bool] = None,
           enable_snat: Optional[bool] = None,
           external_fixed_ips: Optional[Sequence[RouterExternalFixedIpArgs]] = None,
           external_network_id: Optional[str] = None,
           external_subnet_ids: Optional[Sequence[str]] = None,
           name: Optional[str] = None,
           region: Optional[str] = None,
           tags: Optional[Sequence[str]] = None,
           tenant_id: Optional[str] = None,
           value_specs: Optional[Mapping[str, str]] = None,
           vendor_options: Optional[RouterVendorOptionsArgs] = None)
func NewRouter(ctx *Context, name string, args *RouterArgs, opts ...ResourceOption) (*Router, error)
public Router(string name, RouterArgs? args = null, CustomResourceOptions? opts = null)
public Router(String name, RouterArgs args)
public Router(String name, RouterArgs args, CustomResourceOptions options)
type: openstack:networking:Router
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args RouterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args RouterArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args RouterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args RouterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. RouterArgs
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 routerResource = new OpenStack.Networking.Router("routerResource", new()
{
    AdminStateUp = false,
    AvailabilityZoneHints = new[]
    {
        "string",
    },
    Description = "string",
    Distributed = false,
    EnableSnat = false,
    ExternalFixedIps = new[]
    {
        new OpenStack.Networking.Inputs.RouterExternalFixedIpArgs
        {
            IpAddress = "string",
            SubnetId = "string",
        },
    },
    ExternalNetworkId = "string",
    ExternalSubnetIds = new[]
    {
        "string",
    },
    Name = "string",
    Region = "string",
    Tags = new[]
    {
        "string",
    },
    TenantId = "string",
    ValueSpecs = 
    {
        { "string", "string" },
    },
    VendorOptions = new OpenStack.Networking.Inputs.RouterVendorOptionsArgs
    {
        SetRouterGatewayAfterCreate = false,
    },
});
Copy
example, err := networking.NewRouter(ctx, "routerResource", &networking.RouterArgs{
	AdminStateUp: pulumi.Bool(false),
	AvailabilityZoneHints: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Distributed: pulumi.Bool(false),
	EnableSnat:  pulumi.Bool(false),
	ExternalFixedIps: networking.RouterExternalFixedIpArray{
		&networking.RouterExternalFixedIpArgs{
			IpAddress: pulumi.String("string"),
			SubnetId:  pulumi.String("string"),
		},
	},
	ExternalNetworkId: pulumi.String("string"),
	ExternalSubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:   pulumi.String("string"),
	Region: pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	TenantId: pulumi.String("string"),
	ValueSpecs: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VendorOptions: &networking.RouterVendorOptionsArgs{
		SetRouterGatewayAfterCreate: pulumi.Bool(false),
	},
})
Copy
var routerResource = new Router("routerResource", RouterArgs.builder()
    .adminStateUp(false)
    .availabilityZoneHints("string")
    .description("string")
    .distributed(false)
    .enableSnat(false)
    .externalFixedIps(RouterExternalFixedIpArgs.builder()
        .ipAddress("string")
        .subnetId("string")
        .build())
    .externalNetworkId("string")
    .externalSubnetIds("string")
    .name("string")
    .region("string")
    .tags("string")
    .tenantId("string")
    .valueSpecs(Map.of("string", "string"))
    .vendorOptions(RouterVendorOptionsArgs.builder()
        .setRouterGatewayAfterCreate(false)
        .build())
    .build());
Copy
router_resource = openstack.networking.Router("routerResource",
    admin_state_up=False,
    availability_zone_hints=["string"],
    description="string",
    distributed=False,
    enable_snat=False,
    external_fixed_ips=[{
        "ip_address": "string",
        "subnet_id": "string",
    }],
    external_network_id="string",
    external_subnet_ids=["string"],
    name="string",
    region="string",
    tags=["string"],
    tenant_id="string",
    value_specs={
        "string": "string",
    },
    vendor_options={
        "set_router_gateway_after_create": False,
    })
Copy
const routerResource = new openstack.networking.Router("routerResource", {
    adminStateUp: false,
    availabilityZoneHints: ["string"],
    description: "string",
    distributed: false,
    enableSnat: false,
    externalFixedIps: [{
        ipAddress: "string",
        subnetId: "string",
    }],
    externalNetworkId: "string",
    externalSubnetIds: ["string"],
    name: "string",
    region: "string",
    tags: ["string"],
    tenantId: "string",
    valueSpecs: {
        string: "string",
    },
    vendorOptions: {
        setRouterGatewayAfterCreate: false,
    },
});
Copy
type: openstack:networking:Router
properties:
    adminStateUp: false
    availabilityZoneHints:
        - string
    description: string
    distributed: false
    enableSnat: false
    externalFixedIps:
        - ipAddress: string
          subnetId: string
    externalNetworkId: string
    externalSubnetIds:
        - string
    name: string
    region: string
    tags:
        - string
    tenantId: string
    valueSpecs:
        string: string
    vendorOptions:
        setRouterGatewayAfterCreate: false
Copy

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

AdminStateUp bool
Administrative up/down status for the router (must be "true" or "false" if provided). Changing this updates the admin_state_up of an existing router.
AvailabilityZoneHints Changes to this property will trigger replacement. List<string>
An availability zone is used to make network resources highly available. Used for resources with high availability so that they are scheduled on different availability zones. Changing this creates a new router.
Description string
Human-readable description for the router.
Distributed Changes to this property will trigger replacement. bool
Indicates whether or not to create a distributed router. The default policy setting in Neutron restricts usage of this property to administrative users only.
EnableSnat bool
Enable Source NAT for the router. Valid values are "true" or "false". An external_network_id has to be set in order to set this property. Changing this updates the enable_snat of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron.
ExternalFixedIps List<Pulumi.OpenStack.Networking.Inputs.RouterExternalFixedIp>
An external fixed IP for the router. This can be repeated. The structure is described below. An external_network_id has to be set in order to set this property. Changing this updates the external fixed IPs of the router.
ExternalNetworkId string
The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.
ExternalSubnetIds List<string>
A list of external subnet IDs to try over each to obtain a fixed IP for the router. If a subnet ID in a list has exhausted floating IP pool, the next subnet ID will be tried. This argument is used only during the router creation and allows to set only one external fixed IP. Conflicts with an external_fixed_ip argument.
Name string
A unique name for the router. Changing this updates the name of an existing router.
Region Changes to this property will trigger replacement. string
The region in which to obtain the V2 networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router.
Tags List<string>
A set of string tags for the router.
TenantId Changes to this property will trigger replacement. string
The owner of the floating IP. Required if admin wants to create a router for another tenant. Changing this creates a new router.
ValueSpecs Changes to this property will trigger replacement. Dictionary<string, string>
Map of additional driver-specific options.
VendorOptions Pulumi.OpenStack.Networking.Inputs.RouterVendorOptions
Map of additional vendor-specific options. Supported options are described below.
AdminStateUp bool
Administrative up/down status for the router (must be "true" or "false" if provided). Changing this updates the admin_state_up of an existing router.
AvailabilityZoneHints Changes to this property will trigger replacement. []string
An availability zone is used to make network resources highly available. Used for resources with high availability so that they are scheduled on different availability zones. Changing this creates a new router.
Description string
Human-readable description for the router.
Distributed Changes to this property will trigger replacement. bool
Indicates whether or not to create a distributed router. The default policy setting in Neutron restricts usage of this property to administrative users only.
EnableSnat bool
Enable Source NAT for the router. Valid values are "true" or "false". An external_network_id has to be set in order to set this property. Changing this updates the enable_snat of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron.
ExternalFixedIps []RouterExternalFixedIpArgs
An external fixed IP for the router. This can be repeated. The structure is described below. An external_network_id has to be set in order to set this property. Changing this updates the external fixed IPs of the router.
ExternalNetworkId string
The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.
ExternalSubnetIds []string
A list of external subnet IDs to try over each to obtain a fixed IP for the router. If a subnet ID in a list has exhausted floating IP pool, the next subnet ID will be tried. This argument is used only during the router creation and allows to set only one external fixed IP. Conflicts with an external_fixed_ip argument.
Name string
A unique name for the router. Changing this updates the name of an existing router.
Region Changes to this property will trigger replacement. string
The region in which to obtain the V2 networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router.
Tags []string
A set of string tags for the router.
TenantId Changes to this property will trigger replacement. string
The owner of the floating IP. Required if admin wants to create a router for another tenant. Changing this creates a new router.
ValueSpecs Changes to this property will trigger replacement. map[string]string
Map of additional driver-specific options.
VendorOptions RouterVendorOptionsArgs
Map of additional vendor-specific options. Supported options are described below.
adminStateUp Boolean
Administrative up/down status for the router (must be "true" or "false" if provided). Changing this updates the admin_state_up of an existing router.
availabilityZoneHints Changes to this property will trigger replacement. List<String>
An availability zone is used to make network resources highly available. Used for resources with high availability so that they are scheduled on different availability zones. Changing this creates a new router.
description String
Human-readable description for the router.
distributed Changes to this property will trigger replacement. Boolean
Indicates whether or not to create a distributed router. The default policy setting in Neutron restricts usage of this property to administrative users only.
enableSnat Boolean
Enable Source NAT for the router. Valid values are "true" or "false". An external_network_id has to be set in order to set this property. Changing this updates the enable_snat of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron.
externalFixedIps List<RouterExternalFixedIp>
An external fixed IP for the router. This can be repeated. The structure is described below. An external_network_id has to be set in order to set this property. Changing this updates the external fixed IPs of the router.
externalNetworkId String
The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.
externalSubnetIds List<String>
A list of external subnet IDs to try over each to obtain a fixed IP for the router. If a subnet ID in a list has exhausted floating IP pool, the next subnet ID will be tried. This argument is used only during the router creation and allows to set only one external fixed IP. Conflicts with an external_fixed_ip argument.
name String
A unique name for the router. Changing this updates the name of an existing router.
region Changes to this property will trigger replacement. String
The region in which to obtain the V2 networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router.
tags List<String>
A set of string tags for the router.
tenantId Changes to this property will trigger replacement. String
The owner of the floating IP. Required if admin wants to create a router for another tenant. Changing this creates a new router.
valueSpecs Changes to this property will trigger replacement. Map<String,String>
Map of additional driver-specific options.
vendorOptions RouterVendorOptions
Map of additional vendor-specific options. Supported options are described below.
adminStateUp boolean
Administrative up/down status for the router (must be "true" or "false" if provided). Changing this updates the admin_state_up of an existing router.
availabilityZoneHints Changes to this property will trigger replacement. string[]
An availability zone is used to make network resources highly available. Used for resources with high availability so that they are scheduled on different availability zones. Changing this creates a new router.
description string
Human-readable description for the router.
distributed Changes to this property will trigger replacement. boolean
Indicates whether or not to create a distributed router. The default policy setting in Neutron restricts usage of this property to administrative users only.
enableSnat boolean
Enable Source NAT for the router. Valid values are "true" or "false". An external_network_id has to be set in order to set this property. Changing this updates the enable_snat of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron.
externalFixedIps RouterExternalFixedIp[]
An external fixed IP for the router. This can be repeated. The structure is described below. An external_network_id has to be set in order to set this property. Changing this updates the external fixed IPs of the router.
externalNetworkId string
The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.
externalSubnetIds string[]
A list of external subnet IDs to try over each to obtain a fixed IP for the router. If a subnet ID in a list has exhausted floating IP pool, the next subnet ID will be tried. This argument is used only during the router creation and allows to set only one external fixed IP. Conflicts with an external_fixed_ip argument.
name string
A unique name for the router. Changing this updates the name of an existing router.
region Changes to this property will trigger replacement. string
The region in which to obtain the V2 networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router.
tags string[]
A set of string tags for the router.
tenantId Changes to this property will trigger replacement. string
The owner of the floating IP. Required if admin wants to create a router for another tenant. Changing this creates a new router.
valueSpecs Changes to this property will trigger replacement. {[key: string]: string}
Map of additional driver-specific options.
vendorOptions RouterVendorOptions
Map of additional vendor-specific options. Supported options are described below.
admin_state_up bool
Administrative up/down status for the router (must be "true" or "false" if provided). Changing this updates the admin_state_up of an existing router.
availability_zone_hints Changes to this property will trigger replacement. Sequence[str]
An availability zone is used to make network resources highly available. Used for resources with high availability so that they are scheduled on different availability zones. Changing this creates a new router.
description str
Human-readable description for the router.
distributed Changes to this property will trigger replacement. bool
Indicates whether or not to create a distributed router. The default policy setting in Neutron restricts usage of this property to administrative users only.
enable_snat bool
Enable Source NAT for the router. Valid values are "true" or "false". An external_network_id has to be set in order to set this property. Changing this updates the enable_snat of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron.
external_fixed_ips Sequence[RouterExternalFixedIpArgs]
An external fixed IP for the router. This can be repeated. The structure is described below. An external_network_id has to be set in order to set this property. Changing this updates the external fixed IPs of the router.
external_network_id str
The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.
external_subnet_ids Sequence[str]
A list of external subnet IDs to try over each to obtain a fixed IP for the router. If a subnet ID in a list has exhausted floating IP pool, the next subnet ID will be tried. This argument is used only during the router creation and allows to set only one external fixed IP. Conflicts with an external_fixed_ip argument.
name str
A unique name for the router. Changing this updates the name of an existing router.
region Changes to this property will trigger replacement. str
The region in which to obtain the V2 networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router.
tags Sequence[str]
A set of string tags for the router.
tenant_id Changes to this property will trigger replacement. str
The owner of the floating IP. Required if admin wants to create a router for another tenant. Changing this creates a new router.
value_specs Changes to this property will trigger replacement. Mapping[str, str]
Map of additional driver-specific options.
vendor_options RouterVendorOptionsArgs
Map of additional vendor-specific options. Supported options are described below.
adminStateUp Boolean
Administrative up/down status for the router (must be "true" or "false" if provided). Changing this updates the admin_state_up of an existing router.
availabilityZoneHints Changes to this property will trigger replacement. List<String>
An availability zone is used to make network resources highly available. Used for resources with high availability so that they are scheduled on different availability zones. Changing this creates a new router.
description String
Human-readable description for the router.
distributed Changes to this property will trigger replacement. Boolean
Indicates whether or not to create a distributed router. The default policy setting in Neutron restricts usage of this property to administrative users only.
enableSnat Boolean
Enable Source NAT for the router. Valid values are "true" or "false". An external_network_id has to be set in order to set this property. Changing this updates the enable_snat of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron.
externalFixedIps List<Property Map>
An external fixed IP for the router. This can be repeated. The structure is described below. An external_network_id has to be set in order to set this property. Changing this updates the external fixed IPs of the router.
externalNetworkId String
The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.
externalSubnetIds List<String>
A list of external subnet IDs to try over each to obtain a fixed IP for the router. If a subnet ID in a list has exhausted floating IP pool, the next subnet ID will be tried. This argument is used only during the router creation and allows to set only one external fixed IP. Conflicts with an external_fixed_ip argument.
name String
A unique name for the router. Changing this updates the name of an existing router.
region Changes to this property will trigger replacement. String
The region in which to obtain the V2 networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router.
tags List<String>
A set of string tags for the router.
tenantId Changes to this property will trigger replacement. String
The owner of the floating IP. Required if admin wants to create a router for another tenant. Changing this creates a new router.
valueSpecs Changes to this property will trigger replacement. Map<String>
Map of additional driver-specific options.
vendorOptions Property Map
Map of additional vendor-specific options. Supported options are described below.

Outputs

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

AllTags List<string>
The collection of tags assigned on the router, which have been explicitly and implicitly added.
Id string
The provider-assigned unique ID for this managed resource.
AllTags []string
The collection of tags assigned on the router, which have been explicitly and implicitly added.
Id string
The provider-assigned unique ID for this managed resource.
allTags List<String>
The collection of tags assigned on the router, which have been explicitly and implicitly added.
id String
The provider-assigned unique ID for this managed resource.
allTags string[]
The collection of tags assigned on the router, which have been explicitly and implicitly added.
id string
The provider-assigned unique ID for this managed resource.
all_tags Sequence[str]
The collection of tags assigned on the router, which have been explicitly and implicitly added.
id str
The provider-assigned unique ID for this managed resource.
allTags List<String>
The collection of tags assigned on the router, which have been explicitly and implicitly added.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Router Resource

Get an existing Router 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?: RouterState, opts?: CustomResourceOptions): Router
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_state_up: Optional[bool] = None,
        all_tags: Optional[Sequence[str]] = None,
        availability_zone_hints: Optional[Sequence[str]] = None,
        description: Optional[str] = None,
        distributed: Optional[bool] = None,
        enable_snat: Optional[bool] = None,
        external_fixed_ips: Optional[Sequence[RouterExternalFixedIpArgs]] = None,
        external_network_id: Optional[str] = None,
        external_subnet_ids: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        tenant_id: Optional[str] = None,
        value_specs: Optional[Mapping[str, str]] = None,
        vendor_options: Optional[RouterVendorOptionsArgs] = None) -> Router
func GetRouter(ctx *Context, name string, id IDInput, state *RouterState, opts ...ResourceOption) (*Router, error)
public static Router Get(string name, Input<string> id, RouterState? state, CustomResourceOptions? opts = null)
public static Router get(String name, Output<String> id, RouterState state, CustomResourceOptions options)
resources:  _:    type: openstack:networking:Router    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AdminStateUp bool
Administrative up/down status for the router (must be "true" or "false" if provided). Changing this updates the admin_state_up of an existing router.
AllTags List<string>
The collection of tags assigned on the router, which have been explicitly and implicitly added.
AvailabilityZoneHints Changes to this property will trigger replacement. List<string>
An availability zone is used to make network resources highly available. Used for resources with high availability so that they are scheduled on different availability zones. Changing this creates a new router.
Description string
Human-readable description for the router.
Distributed Changes to this property will trigger replacement. bool
Indicates whether or not to create a distributed router. The default policy setting in Neutron restricts usage of this property to administrative users only.
EnableSnat bool
Enable Source NAT for the router. Valid values are "true" or "false". An external_network_id has to be set in order to set this property. Changing this updates the enable_snat of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron.
ExternalFixedIps List<Pulumi.OpenStack.Networking.Inputs.RouterExternalFixedIp>
An external fixed IP for the router. This can be repeated. The structure is described below. An external_network_id has to be set in order to set this property. Changing this updates the external fixed IPs of the router.
ExternalNetworkId string
The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.
ExternalSubnetIds List<string>
A list of external subnet IDs to try over each to obtain a fixed IP for the router. If a subnet ID in a list has exhausted floating IP pool, the next subnet ID will be tried. This argument is used only during the router creation and allows to set only one external fixed IP. Conflicts with an external_fixed_ip argument.
Name string
A unique name for the router. Changing this updates the name of an existing router.
Region Changes to this property will trigger replacement. string
The region in which to obtain the V2 networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router.
Tags List<string>
A set of string tags for the router.
TenantId Changes to this property will trigger replacement. string
The owner of the floating IP. Required if admin wants to create a router for another tenant. Changing this creates a new router.
ValueSpecs Changes to this property will trigger replacement. Dictionary<string, string>
Map of additional driver-specific options.
VendorOptions Pulumi.OpenStack.Networking.Inputs.RouterVendorOptions
Map of additional vendor-specific options. Supported options are described below.
AdminStateUp bool
Administrative up/down status for the router (must be "true" or "false" if provided). Changing this updates the admin_state_up of an existing router.
AllTags []string
The collection of tags assigned on the router, which have been explicitly and implicitly added.
AvailabilityZoneHints Changes to this property will trigger replacement. []string
An availability zone is used to make network resources highly available. Used for resources with high availability so that they are scheduled on different availability zones. Changing this creates a new router.
Description string
Human-readable description for the router.
Distributed Changes to this property will trigger replacement. bool
Indicates whether or not to create a distributed router. The default policy setting in Neutron restricts usage of this property to administrative users only.
EnableSnat bool
Enable Source NAT for the router. Valid values are "true" or "false". An external_network_id has to be set in order to set this property. Changing this updates the enable_snat of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron.
ExternalFixedIps []RouterExternalFixedIpArgs
An external fixed IP for the router. This can be repeated. The structure is described below. An external_network_id has to be set in order to set this property. Changing this updates the external fixed IPs of the router.
ExternalNetworkId string
The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.
ExternalSubnetIds []string
A list of external subnet IDs to try over each to obtain a fixed IP for the router. If a subnet ID in a list has exhausted floating IP pool, the next subnet ID will be tried. This argument is used only during the router creation and allows to set only one external fixed IP. Conflicts with an external_fixed_ip argument.
Name string
A unique name for the router. Changing this updates the name of an existing router.
Region Changes to this property will trigger replacement. string
The region in which to obtain the V2 networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router.
Tags []string
A set of string tags for the router.
TenantId Changes to this property will trigger replacement. string
The owner of the floating IP. Required if admin wants to create a router for another tenant. Changing this creates a new router.
ValueSpecs Changes to this property will trigger replacement. map[string]string
Map of additional driver-specific options.
VendorOptions RouterVendorOptionsArgs
Map of additional vendor-specific options. Supported options are described below.
adminStateUp Boolean
Administrative up/down status for the router (must be "true" or "false" if provided). Changing this updates the admin_state_up of an existing router.
allTags List<String>
The collection of tags assigned on the router, which have been explicitly and implicitly added.
availabilityZoneHints Changes to this property will trigger replacement. List<String>
An availability zone is used to make network resources highly available. Used for resources with high availability so that they are scheduled on different availability zones. Changing this creates a new router.
description String
Human-readable description for the router.
distributed Changes to this property will trigger replacement. Boolean
Indicates whether or not to create a distributed router. The default policy setting in Neutron restricts usage of this property to administrative users only.
enableSnat Boolean
Enable Source NAT for the router. Valid values are "true" or "false". An external_network_id has to be set in order to set this property. Changing this updates the enable_snat of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron.
externalFixedIps List<RouterExternalFixedIp>
An external fixed IP for the router. This can be repeated. The structure is described below. An external_network_id has to be set in order to set this property. Changing this updates the external fixed IPs of the router.
externalNetworkId String
The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.
externalSubnetIds List<String>
A list of external subnet IDs to try over each to obtain a fixed IP for the router. If a subnet ID in a list has exhausted floating IP pool, the next subnet ID will be tried. This argument is used only during the router creation and allows to set only one external fixed IP. Conflicts with an external_fixed_ip argument.
name String
A unique name for the router. Changing this updates the name of an existing router.
region Changes to this property will trigger replacement. String
The region in which to obtain the V2 networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router.
tags List<String>
A set of string tags for the router.
tenantId Changes to this property will trigger replacement. String
The owner of the floating IP. Required if admin wants to create a router for another tenant. Changing this creates a new router.
valueSpecs Changes to this property will trigger replacement. Map<String,String>
Map of additional driver-specific options.
vendorOptions RouterVendorOptions
Map of additional vendor-specific options. Supported options are described below.
adminStateUp boolean
Administrative up/down status for the router (must be "true" or "false" if provided). Changing this updates the admin_state_up of an existing router.
allTags string[]
The collection of tags assigned on the router, which have been explicitly and implicitly added.
availabilityZoneHints Changes to this property will trigger replacement. string[]
An availability zone is used to make network resources highly available. Used for resources with high availability so that they are scheduled on different availability zones. Changing this creates a new router.
description string
Human-readable description for the router.
distributed Changes to this property will trigger replacement. boolean
Indicates whether or not to create a distributed router. The default policy setting in Neutron restricts usage of this property to administrative users only.
enableSnat boolean
Enable Source NAT for the router. Valid values are "true" or "false". An external_network_id has to be set in order to set this property. Changing this updates the enable_snat of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron.
externalFixedIps RouterExternalFixedIp[]
An external fixed IP for the router. This can be repeated. The structure is described below. An external_network_id has to be set in order to set this property. Changing this updates the external fixed IPs of the router.
externalNetworkId string
The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.
externalSubnetIds string[]
A list of external subnet IDs to try over each to obtain a fixed IP for the router. If a subnet ID in a list has exhausted floating IP pool, the next subnet ID will be tried. This argument is used only during the router creation and allows to set only one external fixed IP. Conflicts with an external_fixed_ip argument.
name string
A unique name for the router. Changing this updates the name of an existing router.
region Changes to this property will trigger replacement. string
The region in which to obtain the V2 networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router.
tags string[]
A set of string tags for the router.
tenantId Changes to this property will trigger replacement. string
The owner of the floating IP. Required if admin wants to create a router for another tenant. Changing this creates a new router.
valueSpecs Changes to this property will trigger replacement. {[key: string]: string}
Map of additional driver-specific options.
vendorOptions RouterVendorOptions
Map of additional vendor-specific options. Supported options are described below.
admin_state_up bool
Administrative up/down status for the router (must be "true" or "false" if provided). Changing this updates the admin_state_up of an existing router.
all_tags Sequence[str]
The collection of tags assigned on the router, which have been explicitly and implicitly added.
availability_zone_hints Changes to this property will trigger replacement. Sequence[str]
An availability zone is used to make network resources highly available. Used for resources with high availability so that they are scheduled on different availability zones. Changing this creates a new router.
description str
Human-readable description for the router.
distributed Changes to this property will trigger replacement. bool
Indicates whether or not to create a distributed router. The default policy setting in Neutron restricts usage of this property to administrative users only.
enable_snat bool
Enable Source NAT for the router. Valid values are "true" or "false". An external_network_id has to be set in order to set this property. Changing this updates the enable_snat of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron.
external_fixed_ips Sequence[RouterExternalFixedIpArgs]
An external fixed IP for the router. This can be repeated. The structure is described below. An external_network_id has to be set in order to set this property. Changing this updates the external fixed IPs of the router.
external_network_id str
The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.
external_subnet_ids Sequence[str]
A list of external subnet IDs to try over each to obtain a fixed IP for the router. If a subnet ID in a list has exhausted floating IP pool, the next subnet ID will be tried. This argument is used only during the router creation and allows to set only one external fixed IP. Conflicts with an external_fixed_ip argument.
name str
A unique name for the router. Changing this updates the name of an existing router.
region Changes to this property will trigger replacement. str
The region in which to obtain the V2 networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router.
tags Sequence[str]
A set of string tags for the router.
tenant_id Changes to this property will trigger replacement. str
The owner of the floating IP. Required if admin wants to create a router for another tenant. Changing this creates a new router.
value_specs Changes to this property will trigger replacement. Mapping[str, str]
Map of additional driver-specific options.
vendor_options RouterVendorOptionsArgs
Map of additional vendor-specific options. Supported options are described below.
adminStateUp Boolean
Administrative up/down status for the router (must be "true" or "false" if provided). Changing this updates the admin_state_up of an existing router.
allTags List<String>
The collection of tags assigned on the router, which have been explicitly and implicitly added.
availabilityZoneHints Changes to this property will trigger replacement. List<String>
An availability zone is used to make network resources highly available. Used for resources with high availability so that they are scheduled on different availability zones. Changing this creates a new router.
description String
Human-readable description for the router.
distributed Changes to this property will trigger replacement. Boolean
Indicates whether or not to create a distributed router. The default policy setting in Neutron restricts usage of this property to administrative users only.
enableSnat Boolean
Enable Source NAT for the router. Valid values are "true" or "false". An external_network_id has to be set in order to set this property. Changing this updates the enable_snat of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron.
externalFixedIps List<Property Map>
An external fixed IP for the router. This can be repeated. The structure is described below. An external_network_id has to be set in order to set this property. Changing this updates the external fixed IPs of the router.
externalNetworkId String
The network UUID of an external gateway for the router. A router with an external gateway is required if any compute instances or load balancers will be using floating IPs. Changing this updates the external gateway of the router.
externalSubnetIds List<String>
A list of external subnet IDs to try over each to obtain a fixed IP for the router. If a subnet ID in a list has exhausted floating IP pool, the next subnet ID will be tried. This argument is used only during the router creation and allows to set only one external fixed IP. Conflicts with an external_fixed_ip argument.
name String
A unique name for the router. Changing this updates the name of an existing router.
region Changes to this property will trigger replacement. String
The region in which to obtain the V2 networking client. A networking client is needed to create a router. If omitted, the region argument of the provider is used. Changing this creates a new router.
tags List<String>
A set of string tags for the router.
tenantId Changes to this property will trigger replacement. String
The owner of the floating IP. Required if admin wants to create a router for another tenant. Changing this creates a new router.
valueSpecs Changes to this property will trigger replacement. Map<String>
Map of additional driver-specific options.
vendorOptions Property Map
Map of additional vendor-specific options. Supported options are described below.

Supporting Types

RouterExternalFixedIp
, RouterExternalFixedIpArgs

IpAddress string
The IP address to set on the router.
SubnetId string
Subnet in which the fixed IP belongs to.
IpAddress string
The IP address to set on the router.
SubnetId string
Subnet in which the fixed IP belongs to.
ipAddress String
The IP address to set on the router.
subnetId String
Subnet in which the fixed IP belongs to.
ipAddress string
The IP address to set on the router.
subnetId string
Subnet in which the fixed IP belongs to.
ip_address str
The IP address to set on the router.
subnet_id str
Subnet in which the fixed IP belongs to.
ipAddress String
The IP address to set on the router.
subnetId String
Subnet in which the fixed IP belongs to.

RouterVendorOptions
, RouterVendorOptionsArgs

SetRouterGatewayAfterCreate bool
Boolean to control whether the Router gateway is assigned during creation or updated after creation.
SetRouterGatewayAfterCreate bool
Boolean to control whether the Router gateway is assigned during creation or updated after creation.
setRouterGatewayAfterCreate Boolean
Boolean to control whether the Router gateway is assigned during creation or updated after creation.
setRouterGatewayAfterCreate boolean
Boolean to control whether the Router gateway is assigned during creation or updated after creation.
set_router_gateway_after_create bool
Boolean to control whether the Router gateway is assigned during creation or updated after creation.
setRouterGatewayAfterCreate Boolean
Boolean to control whether the Router gateway is assigned during creation or updated after creation.

Import

Routers can be imported using the id, e.g.

$ pulumi import openstack:networking/router:Router router_1 014395cd-89fc-4c9b-96b7-13d1ee79dad2
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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