Class 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",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Router

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.OpenStack.Networking

Assembly: Pulumi.OpenStack.dll

Syntax

public class Router : CustomResource

Constructors

Router(String, RouterArgs, CustomResourceOptions)

Create a Router resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
RouterArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AdminStateUp

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.

Declaration

public Output<bool> AdminStateUp { get; }

Property Value

Type	Description
Output<System.Boolean>

AllTags

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

Declaration

public Output<ImmutableArray<string>> AllTags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

AvailabilityZoneHints

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.

Declaration

public Output<ImmutableArray<string>> AvailabilityZoneHints { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Description

Human-readable description for the router.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

Distributed

Indicates whether or not to create a distributed router. The default policy setting in Neutron restricts usage of this property to administrative users only.

Declaration

public Output<bool> Distributed { get; }

Property Value

Type	Description
Output<System.Boolean>

EnableSnat

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.

Declaration

public Output<bool> EnableSnat { get; }

Property Value

Type	Description
Output<System.Boolean>

ExternalFixedIps

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.

Declaration

public Output<ImmutableArray<RouterExternalFixedIp>> ExternalFixedIps { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<RouterExternalFixedIp>>

ExternalGateway

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.

Declaration

public Output<string> ExternalGateway { get; }

Property Value

Type	Description
Output<System.String>

ExternalNetworkId

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.

Declaration

public Output<string> ExternalNetworkId { get; }

Property Value

Type	Description
Output<System.String>

Name

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

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Region

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.

Declaration

public Output<string> Region { get; }

Property Value

Type	Description
Output<System.String>

Tags

A set of string tags for the router.

Declaration

public Output<ImmutableArray<string>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

TenantId

The owner of the floating IP. Required if admin wants to create a router for another tenant. Changing this creates a new router.

Declaration

public Output<string> TenantId { get; }

Property Value

Type	Description
Output<System.String>

ValueSpecs

Map of additional driver-specific options.

Declaration

public Output<ImmutableDictionary<string, object>> ValueSpecs { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

VendorOptions

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

Declaration

public Output<RouterVendorOptions> VendorOptions { get; }

Property Value

Type	Description
Output<RouterVendorOptions>

Methods

Get(String, Input<String>, RouterState, CustomResourceOptions)

Get an existing Router resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Router Get(string name, Input<string> id, RouterState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
RouterState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Router