Docs Packages
  1. Packages
  2. Cisco NX OS Resource Provider
  3. API Docs
  4. getLoopbackInterface
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos

nxos.getLoopbackInterface

Explore with Pulumi AI

nxos logo
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos

    This data source can read a loopback interface.

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Nxos.GetLoopbackInterface.Invoke(new()
    {
        InterfaceId = "lo123",
    });

});

    package main

import (
	"github.com/lbrlabs/pulumi-nxos/sdk/go/nxos"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nxos.LookupLoopbackInterface(ctx, &nxos.LookupLoopbackInterfaceArgs{
			InterfaceId: "lo123",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nxos.NxosFunctions;
import com.pulumi.nxos.inputs.GetLoopbackInterfaceArgs;
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 example = NxosFunctions.getLoopbackInterface(GetLoopbackInterfaceArgs.builder()
            .interfaceId("lo123")
            .build());

    }
}

    import pulumi
import pulumi_nxos as nxos

example = nxos.get_loopback_interface(interface_id="lo123")

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

const example = nxos.getLoopbackInterface({
    interfaceId: "lo123",
});

    variables:
  example:
    fn::invoke:
      Function: nxos:getLoopbackInterface
      Arguments:
        interfaceId: lo123

    Using getLoopbackInterface

    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.

    function getLoopbackInterface(args: GetLoopbackInterfaceArgs, opts?: InvokeOptions): Promise<GetLoopbackInterfaceResult>
function getLoopbackInterfaceOutput(args: GetLoopbackInterfaceOutputArgs, opts?: InvokeOptions): Output<GetLoopbackInterfaceResult>
    def get_loopback_interface(device: Optional[str] = None,
                           interface_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetLoopbackInterfaceResult
def get_loopback_interface_output(device: Optional[pulumi.Input[str]] = None,
                           interface_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetLoopbackInterfaceResult]
    func LookupLoopbackInterface(ctx *Context, args *LookupLoopbackInterfaceArgs, opts ...InvokeOption) (*LookupLoopbackInterfaceResult, error)
func LookupLoopbackInterfaceOutput(ctx *Context, args *LookupLoopbackInterfaceOutputArgs, opts ...InvokeOption) LookupLoopbackInterfaceResultOutput

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

    public static class GetLoopbackInterface 
{
    public static Task<GetLoopbackInterfaceResult> InvokeAsync(GetLoopbackInterfaceArgs args, InvokeOptions? opts = null)
    public static Output<GetLoopbackInterfaceResult> Invoke(GetLoopbackInterfaceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetLoopbackInterfaceResult> getLoopbackInterface(GetLoopbackInterfaceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: nxos:index/getLoopbackInterface:getLoopbackInterface
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InterfaceId string
    Must match first field in the output of show intf brief. Example: lo123.
    Device string
    A device name from the provider configuration.
    InterfaceId string
    Must match first field in the output of show intf brief. Example: lo123.
    Device string
    A device name from the provider configuration.
    interfaceId String
    Must match first field in the output of show intf brief. Example: lo123.
    device String
    A device name from the provider configuration.
    interfaceId string
    Must match first field in the output of show intf brief. Example: lo123.
    device string
    A device name from the provider configuration.
    interface_id str
    Must match first field in the output of show intf brief. Example: lo123.
    device str
    A device name from the provider configuration.
    interfaceId String
    Must match first field in the output of show intf brief. Example: lo123.
    device String
    A device name from the provider configuration.

    getLoopbackInterface Result

    The following output properties are available:

    AdminState string
    Administrative state.
    Description string
    Interface description.
    Id string
    The distinguished name of the object.
    InterfaceId string
    Must match first field in the output of show intf brief. Example: lo123.
    Device string
    A device name from the provider configuration.
    AdminState string
    Administrative state.
    Description string
    Interface description.
    Id string
    The distinguished name of the object.
    InterfaceId string
    Must match first field in the output of show intf brief. Example: lo123.
    Device string
    A device name from the provider configuration.
    adminState String
    Administrative state.
    description String
    Interface description.
    id String
    The distinguished name of the object.
    interfaceId String
    Must match first field in the output of show intf brief. Example: lo123.
    device String
    A device name from the provider configuration.
    adminState string
    Administrative state.
    description string
    Interface description.
    id string
    The distinguished name of the object.
    interfaceId string
    Must match first field in the output of show intf brief. Example: lo123.
    device string
    A device name from the provider configuration.
    admin_state str
    Administrative state.
    description str
    Interface description.
    id str
    The distinguished name of the object.
    interface_id str
    Must match first field in the output of show intf brief. Example: lo123.
    device str
    A device name from the provider configuration.
    adminState String
    Administrative state.
    description String
    Interface description.
    id String
    The distinguished name of the object.
    interfaceId String
    Must match first field in the output of show intf brief. Example: lo123.
    device String
    A device name from the provider configuration.

    Package Details

    Repository
    nxos lbrlabs/pulumi-nxos
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nxos Terraform Provider.
    nxos logo
    Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
    lbrlabs/pulumi-nxos