Router

Manages a V2 router resource within OpenStack.

Example Usage

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
    public MyStack()
    {
        var router1 = new OpenStack.Networking.Router("router1", new OpenStack.Networking.RouterArgs
        {
            AdminStateUp = true,
            ExternalNetworkId = "f67f0d72-0ddf-11e4-9d95-e1f29f417e2f",
        });
    }

}

Coming soon!

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("router_1", {
    adminStateUp: true,
    externalNetworkId: "f67f0d72-0ddf-11e4-9d95-e1f29f417e2f",
});

Create a Router Resource

new Router(name: string, args?: RouterArgs, opts?: CustomResourceOptions);

def Router(resource_name, opts=None, admin_state_up=None, availability_zone_hints=None, description=None, distributed=None, enable_snat=None, external_fixed_ips=None, external_gateway=None, external_network_id=None, name=None, region=None, tags=None, tenant_id=None, value_specs=None, vendor_options=None, __props__=None);

func NewRouter(ctx *Context, name string, args *RouterArgs, opts ...ResourceOption) (*Router, error)

public Router(string name, RouterArgs? args = null, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

Router Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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

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

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

ExternalFixedIps []RouterExternalFixedIp

ExternalGateway string

Deprecated: use external_network_id instead

ExternalNetworkId string

Name string

A unique name for the router. Changing this updates the name of an existing router.

Region string

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

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

externalFixedIps RouterExternalFixedIp[]

externalGateway string

Deprecated: use external_network_id instead

externalNetworkId string

name string

A unique name for the router. Changing this updates the name of an existing router.

region string

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 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 List[str]

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

external_fixed_ips List[RouterExternalFixedIp]

external_gateway str

Deprecated: use external_network_id instead

external_network_id str

name str

A unique name for the router. Changing this updates the name of an existing router.

region str

tags List[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 Dict[str, Any]

Map of additional driver-specific options.

vendor_options Dict[RouterVendorOptions]

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

Look up an 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

static get(resource_name, id, opts=None, admin_state_up=None, all_tags=None, availability_zone_hints=None, description=None, distributed=None, enable_snat=None, external_fixed_ips=None, external_gateway=None, external_network_id=None, name=None, region=None, tags=None, tenant_id=None, value_specs=None, vendor_options=None, __props__=None);

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)

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.

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>

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

ExternalFixedIps List<Pulumi.OpenStack.Networking.Inputs.RouterExternalFixedIpArgs>

ExternalGateway string

Deprecated: use external_network_id instead

ExternalNetworkId string

Name string

A unique name for the router. Changing this updates the name of an existing router.

Region string

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

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

ExternalFixedIps []RouterExternalFixedIp

ExternalGateway string

Deprecated: use external_network_id instead

ExternalNetworkId string

Name string

A unique name for the router. Changing this updates the name of an existing router.

Region string

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

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

externalFixedIps RouterExternalFixedIp[]

externalGateway string

Deprecated: use external_network_id instead

externalNetworkId string

name string

A unique name for the router. Changing this updates the name of an existing router.

region string

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 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 List[str]

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

availability_zone_hints List[str]

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

external_fixed_ips List[RouterExternalFixedIp]

external_gateway str