vkcs.getNetworkingRouter

Explore with Pulumi AI

vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const router = vkcs.getNetworkingRouter({
    name: "router-tf-example",
    tags: ["tf-example"],
});

import pulumi
import pulumi_vkcs as vkcs

router = vkcs.get_networking_router(name="router-tf-example",
    tags=["tf-example"])

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vkcs/vkcs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vkcs.LookupNetworkingRouter(ctx, &vkcs.LookupNetworkingRouterArgs{
			Name: pulumi.StringRef("router-tf-example"),
			Tags: []string{
				"tf-example",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vkcs = Pulumi.Vkcs;

return await Deployment.RunAsync(() => 
{
    var router = Vkcs.GetNetworkingRouter.Invoke(new()
    {
        Name = "router-tf-example",
        Tags = new[]
        {
            "tf-example",
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vkcs.VkcsFunctions;
import com.pulumi.vkcs.inputs.GetNetworkingRouterArgs;
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) {
        final var router = VkcsFunctions.getNetworkingRouter(GetNetworkingRouterArgs.builder()
            .name("router-tf-example")
            .tags("tf-example")
            .build());

    }
}

variables:
  router:
    fn::invoke:
      function: vkcs:getNetworkingRouter
      arguments:
        name: router-tf-example
        tags:
          - tf-example

Using getNetworkingRouter

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getNetworkingRouter(args: GetNetworkingRouterArgs, opts?: InvokeOptions): Promise<GetNetworkingRouterResult>
function getNetworkingRouterOutput(args: GetNetworkingRouterOutputArgs, opts?: InvokeOptions): Output<GetNetworkingRouterResult>

def get_networking_router(admin_state_up: Optional[bool] = None,
                          description: Optional[str] = None,
                          enable_snat: Optional[bool] = None,
                          id: Optional[str] = None,
                          name: Optional[str] = None,
                          region: Optional[str] = None,
                          router_id: Optional[str] = None,
                          sdn: Optional[str] = None,
                          status: Optional[str] = None,
                          tags: Optional[Sequence[str]] = None,
                          tenant_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetNetworkingRouterResult
def get_networking_router_output(admin_state_up: Optional[pulumi.Input[bool]] = None,
                          description: Optional[pulumi.Input[str]] = None,
                          enable_snat: Optional[pulumi.Input[bool]] = None,
                          id: Optional[pulumi.Input[str]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          region: Optional[pulumi.Input[str]] = None,
                          router_id: Optional[pulumi.Input[str]] = None,
                          sdn: Optional[pulumi.Input[str]] = None,
                          status: Optional[pulumi.Input[str]] = None,
                          tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                          tenant_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetNetworkingRouterResult]

func LookupNetworkingRouter(ctx *Context, args *LookupNetworkingRouterArgs, opts ...InvokeOption) (*LookupNetworkingRouterResult, error)
func LookupNetworkingRouterOutput(ctx *Context, args *LookupNetworkingRouterOutputArgs, opts ...InvokeOption) LookupNetworkingRouterResultOutput

> Note: This function is named LookupNetworkingRouter in the Go SDK.

public static class GetNetworkingRouter 
{
    public static Task<GetNetworkingRouterResult> InvokeAsync(GetNetworkingRouterArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworkingRouterResult> Invoke(GetNetworkingRouterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetNetworkingRouterResult> getNetworkingRouter(GetNetworkingRouterArgs args, InvokeOptions options)
public static Output<GetNetworkingRouterResult> getNetworkingRouter(GetNetworkingRouterArgs args, InvokeOptions options)

fn::invoke:
  function: vkcs:index/getNetworkingRouter:getNetworkingRouter
  arguments:
    # arguments dictionary

The following arguments are supported:

AdminStateUp bool: optional boolean → Administrative up/down status for the router (must be "true" or "false" if provided).
Description string: optional string → Human-readable description of the router.
EnableSnat bool: optional boolean → The value that points out if the Source NAT is enabled on the router.
Id string: optional string → The UUID of the router resource.
Name string: optional string → The name of the router.
Region string: optional string → The region in which to obtain the Network client. A Network client is needed to retrieve router ids. If omitted, the region argument of the provider is used.
RouterId string: optional deprecated string → The UUID of the router resource. Deprecated This argument is deprecated, please, use the id attribute instead.
Deprecated: Deprecated
Sdn string: optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
Status string: optional string → The status of the router (ACTIVE/DOWN).
Tags List<string>: optional set of string → The list of router tags to filter.
TenantId string: optional string → The owner of the router.

AdminStateUp bool: optional boolean → Administrative up/down status for the router (must be "true" or "false" if provided).
Description string: optional string → Human-readable description of the router.
EnableSnat bool: optional boolean → The value that points out if the Source NAT is enabled on the router.
Id string: optional string → The UUID of the router resource.
Name string: optional string → The name of the router.
Region string: optional string → The region in which to obtain the Network client. A Network client is needed to retrieve router ids. If omitted, the region argument of the provider is used.
RouterId string: optional deprecated string → The UUID of the router resource. Deprecated This argument is deprecated, please, use the id attribute instead.
Deprecated: Deprecated
Sdn string: optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
Status string: optional string → The status of the router (ACTIVE/DOWN).
Tags []string: optional set of string → The list of router tags to filter.
TenantId string: optional string → The owner of the router.

adminStateUp Boolean: optional boolean → Administrative up/down status for the router (must be "true" or "false" if provided).
description String: optional string → Human-readable description of the router.
enableSnat Boolean: optional boolean → The value that points out if the Source NAT is enabled on the router.
id String: optional string → The UUID of the router resource.
name String: optional string → The name of the router.
region String: optional string → The region in which to obtain the Network client. A Network client is needed to retrieve router ids. If omitted, the region argument of the provider is used.
routerId String: optional deprecated string → The UUID of the router resource. Deprecated This argument is deprecated, please, use the id attribute instead.
Deprecated: Deprecated
sdn String: optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
status String: optional string → The status of the router (ACTIVE/DOWN).
tags List<String>: optional set of string → The list of router tags to filter.
tenantId String: optional string → The owner of the router.

adminStateUp boolean: optional boolean → Administrative up/down status for the router (must be "true" or "false" if provided).
description string: optional string → Human-readable description of the router.
enableSnat boolean: optional boolean → The value that points out if the Source NAT is enabled on the router.
id string: optional string → The UUID of the router resource.
name string: optional string → The name of the router.
region string: optional string → The region in which to obtain the Network client. A Network client is needed to retrieve router ids. If omitted, the region argument of the provider is used.
routerId string: optional deprecated string → The UUID of the router resource. Deprecated This argument is deprecated, please, use the id attribute instead.
Deprecated: Deprecated
sdn string: optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
status string: optional string → The status of the router (ACTIVE/DOWN).
tags string[]: optional set of string → The list of router tags to filter.
tenantId string: optional string → The owner of the router.

admin_state_up bool: optional boolean → Administrative up/down status for the router (must be "true" or "false" if provided).
description str: optional string → Human-readable description of the router.
enable_snat bool: optional boolean → The value that points out if the Source NAT is enabled on the router.
id str: optional string → The UUID of the router resource.
name str: optional string → The name of the router.
region str: optional string → The region in which to obtain the Network client. A Network client is needed to retrieve router ids. If omitted, the region argument of the provider is used.
router_id str: optional deprecated string → The UUID of the router resource. Deprecated This argument is deprecated, please, use the id attribute instead.
Deprecated: Deprecated
sdn str: optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
status str: optional string → The status of the router (ACTIVE/DOWN).
tags Sequence[str]: optional set of string → The list of router tags to filter.
tenant_id str: optional string → The owner of the router.

adminStateUp Boolean: optional boolean → Administrative up/down status for the router (must be "true" or "false" if provided).
description String: optional string → Human-readable description of the router.
enableSnat Boolean: optional boolean → The value that points out if the Source NAT is enabled on the router.
id String: optional string → The UUID of the router resource.
name String: optional string → The name of the router.
region String: optional string → The region in which to obtain the Network client. A Network client is needed to retrieve router ids. If omitted, the region argument of the provider is used.
routerId String: optional deprecated string → The UUID of the router resource. Deprecated This argument is deprecated, please, use the id attribute instead.
Deprecated: Deprecated
sdn String: optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
status String: optional string → The status of the router (ACTIVE/DOWN).
tags List<String>: optional set of string → The list of router tags to filter.
tenantId String: optional string → The owner of the router.

getNetworkingRouter Result

The following output properties are available:

AllTags List<string>: set of string → The set of string tags applied on the router.
EnableSnat bool
ExternalFixedIps List<GetNetworkingRouterExternalFixedIp>: object → List of external gateways of the router.New since v0.7.4.
ExternalNetworkId string: string → The network UUID of an external gateway for the router.
Id string
RouterId string: Deprecated: Deprecated
AdminStateUp bool
Description string
Name string
Region string
Sdn string
Status string
Tags List<string>
TenantId string

AllTags []string: set of string → The set of string tags applied on the router.
EnableSnat bool
ExternalFixedIps []GetNetworkingRouterExternalFixedIp: object → List of external gateways of the router.New since v0.7.4.
ExternalNetworkId string: string → The network UUID of an external gateway for the router.
Id string
RouterId string: Deprecated: Deprecated
AdminStateUp bool
Description string
Name string
Region string
Sdn string
Status string
Tags []string
TenantId string

allTags List<String>: set of string → The set of string tags applied on the router.
enableSnat Boolean
externalFixedIps List<GetNetworkingRouterExternalFixedIp>: object → List of external gateways of the router.New since v0.7.4.
externalNetworkId String: string → The network UUID of an external gateway for the router.
id String
routerId String: Deprecated: Deprecated
adminStateUp Boolean
description String
name String
region String
sdn String
status String
tags List<String>
tenantId String

allTags string[]: set of string → The set of string tags applied on the router.
enableSnat boolean
externalFixedIps GetNetworkingRouterExternalFixedIp[]: object → List of external gateways of the router.New since v0.7.4.
externalNetworkId string: string → The network UUID of an external gateway for the router.
id string
routerId string: Deprecated: Deprecated
adminStateUp boolean
description string
name string
region string
sdn string
status string
tags string[]
tenantId string

all_tags Sequence[str]: set of string → The set of string tags applied on the router.
enable_snat bool
external_fixed_ips Sequence[GetNetworkingRouterExternalFixedIp]: object → List of external gateways of the router.New since v0.7.4.
external_network_id str: string → The network UUID of an external gateway for the router.
id str
router_id str: Deprecated: Deprecated
admin_state_up bool
description str
name str
region str
sdn str
status str
tags Sequence[str]
tenant_id str

allTags List<String>: set of string → The set of string tags applied on the router.
enableSnat Boolean
externalFixedIps List<Property Map>: object → List of external gateways of the router.New since v0.7.4.
externalNetworkId String: string → The network UUID of an external gateway for the router.
id String
routerId String: Deprecated: Deprecated
adminStateUp Boolean
description String
name String
region String
sdn String
status String
tags List<String>
tenantId String