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

nxos.getDhcpRelayInterface

Explore with Pulumi AI

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

    This data source can read a DHCP relay interface.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nxos = Pulumi.Nxos;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Nxos.GetDhcpRelayInterface.Invoke(new()
        {
            InterfaceId = "eth1/10",
        });
    
    });
    
    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.LookupDhcpRelayInterface(ctx, &nxos.LookupDhcpRelayInterfaceArgs{
    			InterfaceId: "eth1/10",
    		}, 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.GetDhcpRelayInterfaceArgs;
    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.getDhcpRelayInterface(GetDhcpRelayInterfaceArgs.builder()
                .interfaceId("eth1/10")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_nxos as nxos
    
    example = nxos.get_dhcp_relay_interface(interface_id="eth1/10")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as nxos from "@pulumi/nxos";
    
    const example = nxos.getDhcpRelayInterface({
        interfaceId: "eth1/10",
    });
    
    variables:
      example:
        fn::invoke:
          Function: nxos:getDhcpRelayInterface
          Arguments:
            interfaceId: eth1/10
    

    Using getDhcpRelayInterface

    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 getDhcpRelayInterface(args: GetDhcpRelayInterfaceArgs, opts?: InvokeOptions): Promise<GetDhcpRelayInterfaceResult>
    function getDhcpRelayInterfaceOutput(args: GetDhcpRelayInterfaceOutputArgs, opts?: InvokeOptions): Output<GetDhcpRelayInterfaceResult>
    def get_dhcp_relay_interface(device: Optional[str] = None,
                                 interface_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetDhcpRelayInterfaceResult
    def get_dhcp_relay_interface_output(device: Optional[pulumi.Input[str]] = None,
                                 interface_id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetDhcpRelayInterfaceResult]
    func LookupDhcpRelayInterface(ctx *Context, args *LookupDhcpRelayInterfaceArgs, opts ...InvokeOption) (*LookupDhcpRelayInterfaceResult, error)
    func LookupDhcpRelayInterfaceOutput(ctx *Context, args *LookupDhcpRelayInterfaceOutputArgs, opts ...InvokeOption) LookupDhcpRelayInterfaceResultOutput

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

    public static class GetDhcpRelayInterface 
    {
        public static Task<GetDhcpRelayInterfaceResult> InvokeAsync(GetDhcpRelayInterfaceArgs args, InvokeOptions? opts = null)
        public static Output<GetDhcpRelayInterfaceResult> Invoke(GetDhcpRelayInterfaceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDhcpRelayInterfaceResult> getDhcpRelayInterface(GetDhcpRelayInterfaceArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: nxos:index/getDhcpRelayInterface:getDhcpRelayInterface
      arguments:
        # arguments dictionary

    The following arguments are supported:

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

    getDhcpRelayInterface Result

    The following output properties are available:

    Id string
    The distinguished name of the object.
    InterfaceId string
    Must match first field in the output of show intf brief. Example: eth1/1.
    Device string
    A device name from the provider configuration.
    Id string
    The distinguished name of the object.
    InterfaceId string
    Must match first field in the output of show intf brief. Example: eth1/1.
    Device string
    A device name from the provider configuration.
    id String
    The distinguished name of the object.
    interfaceId String
    Must match first field in the output of show intf brief. Example: eth1/1.
    device String
    A device name from the provider configuration.
    id string
    The distinguished name of the object.
    interfaceId string
    Must match first field in the output of show intf brief. Example: eth1/1.
    device string
    A device name from the provider configuration.
    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.
    device str
    A device name from the provider configuration.
    id String
    The distinguished name of the object.
    interfaceId String
    Must match first field in the output of show intf brief. Example: eth1/1.
    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