1. Pulumi Registry
  2. OpenStack
  3. API Docs
  4. networking
  5. Router
openstack logo
OpenStack v3.12.1, Mar 23 23

openstack.networking.Router

Manages a V2 router resource within OpenStack.

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,
        ExternalNetworkId = "f67f0d72-0ddf-11e4-9d95-e1f29f417e2f",
    });

});

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),
			ExternalNetworkId: pulumi.String("f67f0d72-0ddf-11e4-9d95-e1f29f417e2f"),
		})
		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 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)
            .externalNetworkId("f67f0d72-0ddf-11e4-9d95-e1f29f417e2f")
            .build());

    }
}

import pulumi
import pulumi_openstack as openstack

router1 = openstack.networking.Router("router1",
    admin_state_up=True,
    external_network_id="f67f0d72-0ddf-11e4-9d95-e1f29f417e2f")

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

const router1 = new openstack.networking.Router("router1", {
    adminStateUp: true,
    externalNetworkId: "f67f0d72-0ddf-11e4-9d95-e1f29f417e2f",
});

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

Create Router Resource

new Router(name: string, args?: RouterArgs, opts?: CustomResourceOptions);
@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_gateway: Optional[str] = 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, Any]] = None,
           vendor_options: Optional[RouterVendorOptionsArgs] = None)
@overload
def Router(resource_name: str,
           args: Optional[RouterArgs] = None,
           opts: Optional[ResourceOptions] = 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.
name 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 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 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 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 String
The unique name of the resource.
args RouterArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

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 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 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.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.

ExternalGateway 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 an existing router.

Deprecated:

use external_network_id instead

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 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 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 Dictionary<string, object>

Map of additional driver-specific options.

VendorOptions Pulumi.OpenStack.Networking.Inputs.RouterVendorOptionsArgs

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 []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 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.

ExternalGateway 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 an existing router.

Deprecated:

use external_network_id instead

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 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 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 map[string]interface{}

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 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 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<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.

externalGateway 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 an existing router.

Deprecated:

use external_network_id instead

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 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 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 Map<String,Object>

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 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 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 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.

externalGateway 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 an existing router.

Deprecated:

use external_network_id instead

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 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 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 {[key: string]: any}

Map of additional driver-specific options.

vendorOptions RouterVendorOptionsArgs

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 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 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_gateway 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 an existing router.

Deprecated:

use external_network_id instead

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 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 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 Mapping[str, Any]

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 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 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.

externalGateway 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 an existing router.

Deprecated:

use external_network_id instead

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 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 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 Map<Any>

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_gateway: Optional[str] = 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, Any]] = 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)
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:
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 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 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.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.

ExternalGateway 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 an existing router.

Deprecated:

use external_network_id instead

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 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 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 Dictionary<string, object>

Map of additional driver-specific options.

VendorOptions Pulumi.OpenStack.Networking.Inputs.RouterVendorOptionsArgs

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 []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 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.

ExternalGateway 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 an existing router.

Deprecated:

use external_network_id instead

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 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 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 map[string]interface{}

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 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 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<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.

externalGateway 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 an existing router.

Deprecated:

use external_network_id instead

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 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 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 Map<String,Object>

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 string[]

The collection of tags assigned on the router, which have been explicitly and implicitly added.

availabilityZoneHints 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 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 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.

externalGateway 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 an existing router.

Deprecated:

use external_network_id instead

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 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 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 {[key: string]: any}

Map of additional driver-specific options.

vendorOptions RouterVendorOptionsArgs

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 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 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_gateway 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 an existing router.

Deprecated:

use external_network_id instead

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 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 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 Mapping[str, Any]

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 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 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.

externalGateway 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 an existing router.

Deprecated:

use external_network_id instead

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 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 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 Map<Any>

Map of additional driver-specific options.

vendorOptions Property Map

Map of additional vendor-specific options. Supported options are described below.

Supporting Types

RouterExternalFixedIp

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

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

Package Details

Repository
OpenStack pulumi/pulumi-openstack
License
Apache-2.0
Notes

This Pulumi package is based on the openstack Terraform Provider.