GetRouter

Use this data source to get the ID of an available OpenStack router.

Example Usage

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
    public MyStack()
    {
        var router = Output.Create(OpenStack.Networking.GetRouter.InvokeAsync(new OpenStack.Networking.GetRouterArgs
        {
            Name = "router_1",
        }));
    }

}

Coming soon!

import pulumi
import pulumi_openstack as openstack

router = openstack.networking.get_router(name="router_1")

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

const router = pulumi.output(openstack.networking.getRouter({
    name: "router_1",
}, { async: true }));

Using GetRouter

function getRouter(args: GetRouterArgs, opts?: InvokeOptions): Promise<GetRouterResult>

function  get_router(admin_state_up=None, description=None, distributed=None, enable_snat=None, name=None, region=None, router_id=None, status=None, tags=None, tenant_id=None, opts=None)

func LookupRouter(ctx *Context, args *LookupRouterArgs, opts ...InvokeOption) (*LookupRouterResult, error)

Note: This function is named LookupRouter in the Go SDK.

public static class GetRouter {
    public static Task<GetRouterResult> InvokeAsync(GetRouterArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

AdminStateUp bool: Administrative up/down status for the router (must be “true” or “false” if provided).
Description string: Human-readable description of the router.
Distributed bool: Indicates whether or not to get a distributed router.
EnableSnat bool: The value that points out if the Source NAT is enabled on the router.
Name string: The name of the router.
Region string: The region in which to obtain the V2 Neutron client. A Neutron client is needed to retrieve router ids. If omitted, the region argument of the provider is used.
RouterId string: The UUID of the router resource.
Status string: The status of the router (ACTIVE/DOWN).
Tags List<string>: The list of router tags to filter.
TenantId string: The owner of the router.

AdminStateUp bool: Administrative up/down status for the router (must be “true” or “false” if provided).
Description string: Human-readable description of the router.
Distributed bool: Indicates whether or not to get a distributed router.
EnableSnat bool: The value that points out if the Source NAT is enabled on the router.
Name string: The name of the router.
Region string: The region in which to obtain the V2 Neutron client. A Neutron client is needed to retrieve router ids. If omitted, the region argument of the provider is used.
RouterId string: The UUID of the router resource.
Status string: The status of the router (ACTIVE/DOWN).
Tags []string: The list of router tags to filter.
TenantId string: The owner of the router.

adminStateUp boolean: Administrative up/down status for the router (must be “true” or “false” if provided).
description string: Human-readable description of the router.
distributed boolean: Indicates whether or not to get a distributed router.
enableSnat boolean: The value that points out if the Source NAT is enabled on the router.
name string: The name of the router.
region string: The region in which to obtain the V2 Neutron client. A Neutron client is needed to retrieve router ids. If omitted, the region argument of the provider is used.
routerId string: The UUID of the router resource.
status string: The status of the router (ACTIVE/DOWN).
tags string[]: The list of router tags to filter.
tenantId string: The owner of the router.

admin_state_up bool: Administrative up/down status for the router (must be “true” or “false” if provided).
description str: Human-readable description of the router.
distributed bool: Indicates whether or not to get a distributed router.
enable_snat bool: The value that points out if the Source NAT is enabled on the router.
name str: The name of the router.
region str: The region in which to obtain the V2 Neutron client. A Neutron client is needed to retrieve router ids. If omitted, the region argument of the provider is used.
router_id str: The UUID of the router resource.
status str: The status of the router (ACTIVE/DOWN).
tags List[str]: The list of router tags to filter.
tenant_id str: The owner of the router.

GetRouter Result

The following output properties are available:

AllTags List<string>: The set of string tags applied on the router.
AvailabilityZoneHints List<string>: The availability zone that is used to make router resources highly available.
EnableSnat bool: The value that points out if the Source NAT is enabled on the router.
ExternalFixedIps List<Pulumi.OpenStack.Networking.Outputs.GetRouterExternalFixedIp>: The external fixed IPs of the router.
ExternalNetworkId string: The network UUID of an external gateway for the router.
Id string: The provider-assigned unique ID for this managed resource.
AdminStateUp bool
Description string
Distributed bool
Name string
Region string
RouterId string
Status string
Tags List<string>
TenantId string

AllTags []string: The set of string tags applied on the router.
AvailabilityZoneHints []string: The availability zone that is used to make router resources highly available.
EnableSnat bool: The value that points out if the Source NAT is enabled on the router.
ExternalFixedIps []GetRouterExternalFixedIp: The external fixed IPs of the router.
ExternalNetworkId string: The network UUID of an external gateway for the router.
Id string: The provider-assigned unique ID for this managed resource.
AdminStateUp bool
Description string
Distributed bool
Name string
Region string
RouterId string
Status string
Tags []string
TenantId string

allTags string[]: The set of string tags applied on the router.
availabilityZoneHints string[]: The availability zone that is used to make router resources highly available.
enableSnat boolean: The value that points out if the Source NAT is enabled on the router.
externalFixedIps GetRouterExternalFixedIp[]: The external fixed IPs of the router.
externalNetworkId string: The network UUID of an external gateway for the router.
id string: The provider-assigned unique ID for this managed resource.
adminStateUp boolean
description string
distributed boolean
name string
region string
routerId string
status string
tags string[]
tenantId string

all_tags List[str]: The set of string tags applied on the router.
availability_zone_hints List[str]: The availability zone that is used to make router resources highly available.
enable_snat bool: The value that points out if the Source NAT is enabled on the router.
external_fixed_ips List[GetRouterExternalFixedIp]: The external fixed IPs of the router.
external_network_id str: The network UUID of an external gateway for the router.
id str: The provider-assigned unique ID for this managed resource.
admin_state_up bool
description str
distributed bool
name str
region str
router_id str
status str
tags List[str]
tenant_id str

Supporting Types

GetRouterExternalFixedIp

See the output API doc for this type.

IpAddress string: The IP address to set on the router.
SubnetId string

IpAddress string: The IP address to set on the router.
SubnetId string

ipAddress string: The IP address to set on the router.
subnetId string

ip_address str: The IP address to set on the router.
subnet_id str

Package Details

Repository: https://github.com/pulumi/pulumi-openstack
License: Apache-2.0
Notes: This Pulumi package is based on the openstack Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetRouter

Example Usage

Using GetRouter

GetRouter Result

Supporting Types

GetRouterExternalFixedIp

Package Details

On This Page