1. Packages
  2. Cisco IOS XE Resource Provider
  3. API Docs
  4. getInterfaceLoopback
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs

iosxe.getInterfaceLoopback

Explore with Pulumi AI

Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs

This data source can read the Interface Loopback configuration.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Iosxe.GetInterfaceLoopback.Invoke(new()
    {
        Name = 100,
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iosxe.LookupInterfaceLoopback(ctx, &iosxe.LookupInterfaceLoopbackArgs{
			Name: 100,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.iosxe.IosxeFunctions;
import com.pulumi.iosxe.inputs.GetInterfaceLoopbackArgs;
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 = IosxeFunctions.getInterfaceLoopback(GetInterfaceLoopbackArgs.builder()
            .name(100)
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as iosxe from "@pulumi/iosxe";

const example = iosxe.getInterfaceLoopback({
    name: 100,
});
Copy
import pulumi
import pulumi_iosxe as iosxe

example = iosxe.get_interface_loopback(name=100)
Copy
variables:
  example:
    fn::invoke:
      Function: iosxe:getInterfaceLoopback
      Arguments:
        name: 100
Copy

Using getInterfaceLoopback

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 getInterfaceLoopback(args: GetInterfaceLoopbackArgs, opts?: InvokeOptions): Promise<GetInterfaceLoopbackResult>
function getInterfaceLoopbackOutput(args: GetInterfaceLoopbackOutputArgs, opts?: InvokeOptions): Output<GetInterfaceLoopbackResult>
Copy
def get_interface_loopback(device: Optional[str] = None,
                           name: Optional[int] = None,
                           opts: Optional[InvokeOptions] = None) -> GetInterfaceLoopbackResult
def get_interface_loopback_output(device: Optional[pulumi.Input[str]] = None,
                           name: Optional[pulumi.Input[int]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetInterfaceLoopbackResult]
Copy
func LookupInterfaceLoopback(ctx *Context, args *LookupInterfaceLoopbackArgs, opts ...InvokeOption) (*LookupInterfaceLoopbackResult, error)
func LookupInterfaceLoopbackOutput(ctx *Context, args *LookupInterfaceLoopbackOutputArgs, opts ...InvokeOption) LookupInterfaceLoopbackResultOutput
Copy

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

public static class GetInterfaceLoopback 
{
    public static Task<GetInterfaceLoopbackResult> InvokeAsync(GetInterfaceLoopbackArgs args, InvokeOptions? opts = null)
    public static Output<GetInterfaceLoopbackResult> Invoke(GetInterfaceLoopbackInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetInterfaceLoopbackResult> getInterfaceLoopback(GetInterfaceLoopbackArgs args, InvokeOptions options)
public static Output<GetInterfaceLoopbackResult> getInterfaceLoopback(GetInterfaceLoopbackArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: iosxe:index/getInterfaceLoopback:getInterfaceLoopback
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. int
Device string
A device name from the provider configuration.
Name This property is required. int
Device string
A device name from the provider configuration.
name This property is required. Integer
device String
A device name from the provider configuration.
name This property is required. number
device string
A device name from the provider configuration.
name This property is required. int
device str
A device name from the provider configuration.
name This property is required. Number
device String
A device name from the provider configuration.

getInterfaceLoopback Result

The following output properties are available:

ArpTimeout int
Set ARP cache timeout
Description string
Interface specific description
Id string
The path of the retrieved object.
IpAccessGroupIn string
IpAccessGroupInEnable bool
inbound packets
IpAccessGroupOut string
IpAccessGroupOutEnable bool
outbound packets
IpProxyArp bool
Enable proxy ARP
IpRedirects bool
Enable sending ICMP Redirect messages
IpUnreachables bool
Enable sending ICMP Unreachable messages
Ipv4Address string
Ipv4AddressMask string
Ipv6AddressAutoconfigDefault bool
Insert default route
Ipv6AddressDhcp bool
Obtain IPv6 address from DHCP server
Ipv6Addresses List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetInterfaceLoopbackIpv6Address>
Ipv6Enable bool
Enable IPv6 on interface
Ipv6LinkLocalAddresses List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetInterfaceLoopbackIpv6LinkLocalAddress>
Ipv6Mtu int
Set IPv6 Maximum Transmission Unit
Ipv6NdRaSuppressAll bool
Suppress all IPv6 RA
Name int
Shutdown bool
Shutdown the selected interface
VrfForwarding string
Configure forwarding table
Device string
A device name from the provider configuration.
ArpTimeout int
Set ARP cache timeout
Description string
Interface specific description
Id string
The path of the retrieved object.
IpAccessGroupIn string
IpAccessGroupInEnable bool
inbound packets
IpAccessGroupOut string
IpAccessGroupOutEnable bool
outbound packets
IpProxyArp bool
Enable proxy ARP
IpRedirects bool
Enable sending ICMP Redirect messages
IpUnreachables bool
Enable sending ICMP Unreachable messages
Ipv4Address string
Ipv4AddressMask string
Ipv6AddressAutoconfigDefault bool
Insert default route
Ipv6AddressDhcp bool
Obtain IPv6 address from DHCP server
Ipv6Addresses []GetInterfaceLoopbackIpv6Address
Ipv6Enable bool
Enable IPv6 on interface
Ipv6LinkLocalAddresses []GetInterfaceLoopbackIpv6LinkLocalAddress
Ipv6Mtu int
Set IPv6 Maximum Transmission Unit
Ipv6NdRaSuppressAll bool
Suppress all IPv6 RA
Name int
Shutdown bool
Shutdown the selected interface
VrfForwarding string
Configure forwarding table
Device string
A device name from the provider configuration.
arpTimeout Integer
Set ARP cache timeout
description String
Interface specific description
id String
The path of the retrieved object.
ipAccessGroupIn String
ipAccessGroupInEnable Boolean
inbound packets
ipAccessGroupOut String
ipAccessGroupOutEnable Boolean
outbound packets
ipProxyArp Boolean
Enable proxy ARP
ipRedirects Boolean
Enable sending ICMP Redirect messages
ipUnreachables Boolean
Enable sending ICMP Unreachable messages
ipv4Address String
ipv4AddressMask String
ipv6AddressAutoconfigDefault Boolean
Insert default route
ipv6AddressDhcp Boolean
Obtain IPv6 address from DHCP server
ipv6Addresses List<GetInterfaceLoopbackIpv6Address>
ipv6Enable Boolean
Enable IPv6 on interface
ipv6LinkLocalAddresses List<GetInterfaceLoopbackIpv6LinkLocalAddress>
ipv6Mtu Integer
Set IPv6 Maximum Transmission Unit
ipv6NdRaSuppressAll Boolean
Suppress all IPv6 RA
name Integer
shutdown Boolean
Shutdown the selected interface
vrfForwarding String
Configure forwarding table
device String
A device name from the provider configuration.
arpTimeout number
Set ARP cache timeout
description string
Interface specific description
id string
The path of the retrieved object.
ipAccessGroupIn string
ipAccessGroupInEnable boolean
inbound packets
ipAccessGroupOut string
ipAccessGroupOutEnable boolean
outbound packets
ipProxyArp boolean
Enable proxy ARP
ipRedirects boolean
Enable sending ICMP Redirect messages
ipUnreachables boolean
Enable sending ICMP Unreachable messages
ipv4Address string
ipv4AddressMask string
ipv6AddressAutoconfigDefault boolean
Insert default route
ipv6AddressDhcp boolean
Obtain IPv6 address from DHCP server
ipv6Addresses GetInterfaceLoopbackIpv6Address[]
ipv6Enable boolean
Enable IPv6 on interface
ipv6LinkLocalAddresses GetInterfaceLoopbackIpv6LinkLocalAddress[]
ipv6Mtu number
Set IPv6 Maximum Transmission Unit
ipv6NdRaSuppressAll boolean
Suppress all IPv6 RA
name number
shutdown boolean
Shutdown the selected interface
vrfForwarding string
Configure forwarding table
device string
A device name from the provider configuration.
arp_timeout int
Set ARP cache timeout
description str
Interface specific description
id str
The path of the retrieved object.
ip_access_group_in str
ip_access_group_in_enable bool
inbound packets
ip_access_group_out str
ip_access_group_out_enable bool
outbound packets
ip_proxy_arp bool
Enable proxy ARP
ip_redirects bool
Enable sending ICMP Redirect messages
ip_unreachables bool
Enable sending ICMP Unreachable messages
ipv4_address str
ipv4_address_mask str
ipv6_address_autoconfig_default bool
Insert default route
ipv6_address_dhcp bool
Obtain IPv6 address from DHCP server
ipv6_addresses Sequence[GetInterfaceLoopbackIpv6Address]
ipv6_enable bool
Enable IPv6 on interface
ipv6_link_local_addresses Sequence[GetInterfaceLoopbackIpv6LinkLocalAddress]
ipv6_mtu int
Set IPv6 Maximum Transmission Unit
ipv6_nd_ra_suppress_all bool
Suppress all IPv6 RA
name int
shutdown bool
Shutdown the selected interface
vrf_forwarding str
Configure forwarding table
device str
A device name from the provider configuration.
arpTimeout Number
Set ARP cache timeout
description String
Interface specific description
id String
The path of the retrieved object.
ipAccessGroupIn String
ipAccessGroupInEnable Boolean
inbound packets
ipAccessGroupOut String
ipAccessGroupOutEnable Boolean
outbound packets
ipProxyArp Boolean
Enable proxy ARP
ipRedirects Boolean
Enable sending ICMP Redirect messages
ipUnreachables Boolean
Enable sending ICMP Unreachable messages
ipv4Address String
ipv4AddressMask String
ipv6AddressAutoconfigDefault Boolean
Insert default route
ipv6AddressDhcp Boolean
Obtain IPv6 address from DHCP server
ipv6Addresses List<Property Map>
ipv6Enable Boolean
Enable IPv6 on interface
ipv6LinkLocalAddresses List<Property Map>
ipv6Mtu Number
Set IPv6 Maximum Transmission Unit
ipv6NdRaSuppressAll Boolean
Suppress all IPv6 RA
name Number
shutdown Boolean
Shutdown the selected interface
vrfForwarding String
Configure forwarding table
device String
A device name from the provider configuration.

Supporting Types

GetInterfaceLoopbackIpv6Address

Eui64 This property is required. bool
Use eui-64 interface identifier
Prefix This property is required. string
Eui64 This property is required. bool
Use eui-64 interface identifier
Prefix This property is required. string
eui64 This property is required. Boolean
Use eui-64 interface identifier
prefix This property is required. String
eui64 This property is required. boolean
Use eui-64 interface identifier
prefix This property is required. string
eui64 This property is required. bool
Use eui-64 interface identifier
prefix This property is required. str
eui64 This property is required. Boolean
Use eui-64 interface identifier
prefix This property is required. String

GetInterfaceLoopbackIpv6LinkLocalAddress

Address This property is required. string
LinkLocal This property is required. bool
Use link-local address
Address This property is required. string
LinkLocal This property is required. bool
Use link-local address
address This property is required. String
linkLocal This property is required. Boolean
Use link-local address
address This property is required. string
linkLocal This property is required. boolean
Use link-local address
address This property is required. str
link_local This property is required. bool
Use link-local address
address This property is required. String
linkLocal This property is required. Boolean
Use link-local address

Package Details

Repository
iosxe lbrlabs/pulumi-iosxe
License
Apache-2.0
Notes
This Pulumi package is based on the iosxe Terraform Provider.
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs