Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco NX OS Resource Provider
  3. API Docs
  4. getIpv4Interface
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos

nxos.getIpv4Interface

Explore with Pulumi AI

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

This data source can read an IPv4 interface.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Nxos.GetIpv4Interface.Invoke(new()
    {
        InterfaceId = "eth1/10",
        Vrf = "default",
    });

});
Copy
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.LookupIpv4Interface(ctx, &nxos.LookupIpv4InterfaceArgs{
			InterfaceId: "eth1/10",
			Vrf:         "default",
		}, 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.nxos.NxosFunctions;
import com.pulumi.nxos.inputs.GetIpv4InterfaceArgs;
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.getIpv4Interface(GetIpv4InterfaceArgs.builder()
            .interfaceId("eth1/10")
            .vrf("default")
            .build());

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

const example = nxos.getIpv4Interface({
    interfaceId: "eth1/10",
    vrf: "default",
});
Copy
import pulumi
import pulumi_nxos as nxos

example = nxos.get_ipv4_interface(interface_id="eth1/10",
    vrf="default")
Copy
variables:
  example:
    fn::invoke:
      Function: nxos:getIpv4Interface
      Arguments:
        interfaceId: eth1/10
        vrf: default
Copy

Using getIpv4Interface

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 getIpv4Interface(args: GetIpv4InterfaceArgs, opts?: InvokeOptions): Promise<GetIpv4InterfaceResult>
function getIpv4InterfaceOutput(args: GetIpv4InterfaceOutputArgs, opts?: InvokeOptions): Output<GetIpv4InterfaceResult>
Copy
def get_ipv4_interface(device: Optional[str] = None,
                       interface_id: Optional[str] = None,
                       vrf: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetIpv4InterfaceResult
def get_ipv4_interface_output(device: Optional[pulumi.Input[str]] = None,
                       interface_id: Optional[pulumi.Input[str]] = None,
                       vrf: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetIpv4InterfaceResult]
Copy
func LookupIpv4Interface(ctx *Context, args *LookupIpv4InterfaceArgs, opts ...InvokeOption) (*LookupIpv4InterfaceResult, error)
func LookupIpv4InterfaceOutput(ctx *Context, args *LookupIpv4InterfaceOutputArgs, opts ...InvokeOption) LookupIpv4InterfaceResultOutput
Copy

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

public static class GetIpv4Interface 
{
    public static Task<GetIpv4InterfaceResult> InvokeAsync(GetIpv4InterfaceArgs args, InvokeOptions? opts = null)
    public static Output<GetIpv4InterfaceResult> Invoke(GetIpv4InterfaceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIpv4InterfaceResult> getIpv4Interface(GetIpv4InterfaceArgs args, InvokeOptions options)
public static Output<GetIpv4InterfaceResult> getIpv4Interface(GetIpv4InterfaceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: nxos:index/getIpv4Interface:getIpv4Interface
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

InterfaceId This property is required. string
Must match first field in the output of show intf brief. Example: eth1/1.
Vrf This property is required. string
VRF name.
Device string
A device name from the provider configuration.
InterfaceId This property is required. string
Must match first field in the output of show intf brief. Example: eth1/1.
Vrf This property is required. string
VRF name.
Device string
A device name from the provider configuration.
interfaceId This property is required. String
Must match first field in the output of show intf brief. Example: eth1/1.
vrf This property is required. String
VRF name.
device String
A device name from the provider configuration.
interfaceId This property is required. string
Must match first field in the output of show intf brief. Example: eth1/1.
vrf This property is required. string
VRF name.
device string
A device name from the provider configuration.
interface_id This property is required. str
Must match first field in the output of show intf brief. Example: eth1/1.
vrf This property is required. str
VRF name.
device str
A device name from the provider configuration.
interfaceId This property is required. String
Must match first field in the output of show intf brief. Example: eth1/1.
vrf This property is required. String
VRF name.
device String
A device name from the provider configuration.

getIpv4Interface Result

The following output properties are available:

DropGlean string
ip drop-glean enabled/disabled.
Forward string
ip forward enabled/disabled.
Id string
The distinguished name of the object.
InterfaceId string
Must match first field in the output of show intf brief. Example: eth1/1.
Unnumbered string
IP unnumbered. Reference to interface must match first field in the output of show intf brief. Example: eth1/1.
Urpf string
URPF (unicast Reverse Path Forwarding).
Vrf string
VRF name.
Device string
A device name from the provider configuration.
DropGlean string
ip drop-glean enabled/disabled.
Forward string
ip forward enabled/disabled.
Id string
The distinguished name of the object.
InterfaceId string
Must match first field in the output of show intf brief. Example: eth1/1.
Unnumbered string
IP unnumbered. Reference to interface must match first field in the output of show intf brief. Example: eth1/1.
Urpf string
URPF (unicast Reverse Path Forwarding).
Vrf string
VRF name.
Device string
A device name from the provider configuration.
dropGlean String
ip drop-glean enabled/disabled.
forward String
ip forward enabled/disabled.
id String
The distinguished name of the object.
interfaceId String
Must match first field in the output of show intf brief. Example: eth1/1.
unnumbered String
IP unnumbered. Reference to interface must match first field in the output of show intf brief. Example: eth1/1.
urpf String
URPF (unicast Reverse Path Forwarding).
vrf String
VRF name.
device String
A device name from the provider configuration.
dropGlean string
ip drop-glean enabled/disabled.
forward string
ip forward enabled/disabled.
id string
The distinguished name of the object.
interfaceId string
Must match first field in the output of show intf brief. Example: eth1/1.
unnumbered string
IP unnumbered. Reference to interface must match first field in the output of show intf brief. Example: eth1/1.
urpf string
URPF (unicast Reverse Path Forwarding).
vrf string
VRF name.
device string
A device name from the provider configuration.
drop_glean str
ip drop-glean enabled/disabled.
forward str
ip forward enabled/disabled.
id str
The distinguished name of the object.
interface_id str
Must match first field in the output of show intf brief. Example: eth1/1.
unnumbered str
IP unnumbered. Reference to interface must match first field in the output of show intf brief. Example: eth1/1.
urpf str
URPF (unicast Reverse Path Forwarding).
vrf str
VRF name.
device str
A device name from the provider configuration.
dropGlean String
ip drop-glean enabled/disabled.
forward String
ip forward enabled/disabled.
id String
The distinguished name of the object.
interfaceId String
Must match first field in the output of show intf brief. Example: eth1/1.
unnumbered String
IP unnumbered. Reference to interface must match first field in the output of show intf brief. Example: eth1/1.
urpf String
URPF (unicast Reverse Path Forwarding).
vrf String
VRF name.
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.
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos