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",
});
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")
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
})
}
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",
});
});
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());
}
}
resources:
router1:
type: openstack:networking:Router
name: router_1
properties:
name: my_router
adminStateUp: true
externalNetworkId: f67f0d72-0ddf-11e4-9d95-e1f29f417e2f
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 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.
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,
},
});
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),
},
})
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());
router_resource = openstack.networking.Router("routerResource",
admin_state_up=False,
availability_zone_hints=["string"],
description="string",
distributed=False,
enable_snat=False,
external_fixed_ips=[openstack.networking.RouterExternalFixedIpArgs(
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=openstack.networking.RouterVendorOptionsArgs(
set_router_gateway_after_create=False,
))
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,
},
});
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
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:
- Admin
State boolUp - 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 List<string>Hints - 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.
- 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 theenable_snat
of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron. - External
Fixed List<Pulumi.Ips Open Stack. Networking. Inputs. Router External Fixed Ip> - 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 stringId - 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 List<string>Ids - 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. - List<string>
- A set of string tags for the router.
- Tenant
Id string - 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 Dictionary<string, string> - Map of additional driver-specific options.
- Vendor
Options Pulumi.Open Stack. Networking. Inputs. Router Vendor Options - Map of additional vendor-specific options. Supported options are described below.
- Admin
State boolUp - 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 []stringHints - 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.
- 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 theenable_snat
of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron. - External
Fixed []RouterIps External Fixed Ip Args - 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 stringId - 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 []stringIds - 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. - []string
- A set of string tags for the router.
- Tenant
Id string - 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 map[string]string - Map of additional driver-specific options.
- Vendor
Options RouterVendor Options Args - Map of additional vendor-specific options. Supported options are described below.
- admin
State BooleanUp - 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 List<String>Hints - 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.
- enable
Snat 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 theenable_snat
of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron. - external
Fixed List<RouterIps External Fixed Ip> - 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 StringId - 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 List<String>Ids - 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. - List<String>
- A set of string tags for the router.
- tenant
Id String - 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 Map<String,String> - Map of additional driver-specific options.
- vendor
Options RouterVendor Options - Map of additional vendor-specific options. Supported options are described below.
- admin
State booleanUp - 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 string[]Hints - 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.
- enable
Snat 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 theenable_snat
of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron. - external
Fixed RouterIps External Fixed Ip[] - 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 stringId - 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 string[]Ids - 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. - string[]
- A set of string tags for the router.
- tenant
Id string - 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 {[key: string]: string} - Map of additional driver-specific options.
- vendor
Options RouterVendor Options - Map of additional vendor-specific options. Supported options are described below.
- admin_
state_ boolup - 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_ Sequence[str]hints - 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 theenable_snat
of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron. - external_
fixed_ Sequence[Routerips External Fixed Ip Args] - 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_ strid - 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_ Sequence[str]ids - 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. - 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, str] - Map of additional driver-specific options.
- vendor_
options RouterVendor Options Args - Map of additional vendor-specific options. Supported options are described below.
- admin
State BooleanUp - 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 List<String>Hints - 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.
- enable
Snat 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 theenable_snat
of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron. - external
Fixed List<Property Map>Ips - 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 StringId - 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 List<String>Ids - 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. - List<String>
- A set of string tags for the router.
- tenant
Id String - 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 Map<String> - Map of additional driver-specific options.
- vendor
Options 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:
- 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.
- []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.
- 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.
- 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.
- 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.
- 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)
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.
- Admin
State boolUp - 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. - List<string>
- The collection of tags assigned on the router, which have been explicitly and implicitly added.
- Availability
Zone List<string>Hints - 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.
- 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 theenable_snat
of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron. - External
Fixed List<Pulumi.Ips Open Stack. Networking. Inputs. Router External Fixed Ip> - 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 stringId - 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 List<string>Ids - 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. - List<string>
- A set of string tags for the router.
- Tenant
Id string - 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 Dictionary<string, string> - Map of additional driver-specific options.
- Vendor
Options Pulumi.Open Stack. Networking. Inputs. Router Vendor Options - Map of additional vendor-specific options. Supported options are described below.
- Admin
State boolUp - 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. - []string
- The collection of tags assigned on the router, which have been explicitly and implicitly added.
- Availability
Zone []stringHints - 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.
- 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 theenable_snat
of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron. - External
Fixed []RouterIps External Fixed Ip Args - 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 stringId - 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 []stringIds - 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. - []string
- A set of string tags for the router.
- Tenant
Id string - 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 map[string]string - Map of additional driver-specific options.
- Vendor
Options RouterVendor Options Args - Map of additional vendor-specific options. Supported options are described below.
- admin
State BooleanUp - 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. - List<String>
- The collection of tags assigned on the router, which have been explicitly and implicitly added.
- availability
Zone List<String>Hints - 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.
- enable
Snat 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 theenable_snat
of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron. - external
Fixed List<RouterIps External Fixed Ip> - 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 StringId - 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 List<String>Ids - 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. - List<String>
- A set of string tags for the router.
- tenant
Id String - 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 Map<String,String> - Map of additional driver-specific options.
- vendor
Options RouterVendor Options - Map of additional vendor-specific options. Supported options are described below.
- admin
State booleanUp - 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. - string[]
- The collection of tags assigned on the router, which have been explicitly and implicitly added.
- availability
Zone string[]Hints - 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.
- enable
Snat 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 theenable_snat
of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron. - external
Fixed RouterIps External Fixed Ip[] - 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 stringId - 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 string[]Ids - 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. - string[]
- A set of string tags for the router.
- tenant
Id string - 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 {[key: string]: string} - Map of additional driver-specific options.
- vendor
Options RouterVendor Options - Map of additional vendor-specific options. Supported options are described below.
- admin_
state_ boolup - 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. - Sequence[str]
- The collection of tags assigned on the router, which have been explicitly and implicitly added.
- availability_
zone_ Sequence[str]hints - 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 theenable_snat
of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron. - external_
fixed_ Sequence[Routerips External Fixed Ip Args] - 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_ strid - 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_ Sequence[str]ids - 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. - 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, str] - Map of additional driver-specific options.
- vendor_
options RouterVendor Options Args - Map of additional vendor-specific options. Supported options are described below.
- admin
State BooleanUp - 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. - List<String>
- The collection of tags assigned on the router, which have been explicitly and implicitly added.
- availability
Zone List<String>Hints - 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.
- enable
Snat 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 theenable_snat
of the router. Setting this value requires an ext-gw-mode extension to be enabled in OpenStack Neutron. - external
Fixed List<Property Map>Ips - 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 StringId - 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 List<String>Ids - 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. - List<String>
- A set of string tags for the router.
- tenant
Id String - 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 Map<String> - Map of additional driver-specific options.
- vendor
Options Property Map - Map of additional vendor-specific options. Supported options are described below.
Supporting Types
RouterExternalFixedIp, RouterExternalFixedIpArgs
- ip_
address str - The IP address to set on the router.
- subnet_
id str - Subnet in which the fixed IP belongs to.
RouterVendorOptions, RouterVendorOptionsArgs
- Set
Router boolGateway After Create - Boolean to control whether the Router gateway is assigned during creation or updated after creation.
- Set
Router boolGateway After Create - Boolean to control whether the Router gateway is assigned during creation or updated after creation.
- set
Router BooleanGateway After Create - Boolean to control whether the Router gateway is assigned during creation or updated after creation.
- set
Router booleanGateway After Create - Boolean to control whether the Router gateway is assigned during creation or updated after creation.
- set_
router_ boolgateway_ after_ create - Boolean to control whether the Router gateway is assigned during creation or updated after creation.
- set
Router BooleanGateway After Create - 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
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.