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

nxos.getNveInterface

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 the NVE interface configuration.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nxos = Pulumi.Nxos;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Nxos.GetNveInterface.Invoke();
    
    });
    
    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.LookupNveInterface(ctx, nil, 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.GetNveInterfaceArgs;
    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.getNveInterface();
    
        }
    }
    
    import pulumi
    import pulumi_nxos as nxos
    
    example = nxos.get_nve_interface()
    
    import * as pulumi from "@pulumi/pulumi";
    import * as nxos from "@pulumi/nxos";
    
    const example = nxos.getNveInterface({});
    
    variables:
      example:
        fn::invoke:
          Function: nxos:getNveInterface
          Arguments: {}
    

    Using getNveInterface

    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 getNveInterface(args: GetNveInterfaceArgs, opts?: InvokeOptions): Promise<GetNveInterfaceResult>
    function getNveInterfaceOutput(args: GetNveInterfaceOutputArgs, opts?: InvokeOptions): Output<GetNveInterfaceResult>
    def get_nve_interface(device: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetNveInterfaceResult
    def get_nve_interface_output(device: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetNveInterfaceResult]
    func LookupNveInterface(ctx *Context, args *LookupNveInterfaceArgs, opts ...InvokeOption) (*LookupNveInterfaceResult, error)
    func LookupNveInterfaceOutput(ctx *Context, args *LookupNveInterfaceOutputArgs, opts ...InvokeOption) LookupNveInterfaceResultOutput

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

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

    The following arguments are supported:

    Device string
    A device name from the provider configuration.
    Device string
    A device name from the provider configuration.
    device String
    A device name from the provider configuration.
    device string
    A device name from the provider configuration.
    device str
    A device name from the provider configuration.
    device String
    A device name from the provider configuration.

    getNveInterface Result

    The following output properties are available:

    AdminState string
    Administrative state.
    AdvertiseVirtualMac bool
    Enable or disable Virtual MAC Advertisement in VPC mode.
    HoldDownTime int
    Hold Down Time.
    HostReachabilityProtocol string
    Host Reachability Protocol.
    Id string
    The distinguished name of the object.
    IngressReplicationProtocolBgp bool
    VxLAN Ingress Replication Protocol BGP.
    MulticastGroupL2 string
    Base multicast group address for L2.
    MulticastGroupL3 string
    Base multicast group address for L3.
    MultisiteSourceInterface string
    Interface representing the Multisite Border Gateway. Must match first field in the output of show int brief.
    SourceInterface string
    Source Interface associated with the NVE. Must match first field in the output of show int brief.
    SuppressArp bool
    Suppress ARP.
    SuppressMacRoute bool
    Suppress MAC Route.
    Device string
    A device name from the provider configuration.
    AdminState string
    Administrative state.
    AdvertiseVirtualMac bool
    Enable or disable Virtual MAC Advertisement in VPC mode.
    HoldDownTime int
    Hold Down Time.
    HostReachabilityProtocol string
    Host Reachability Protocol.
    Id string
    The distinguished name of the object.
    IngressReplicationProtocolBgp bool
    VxLAN Ingress Replication Protocol BGP.
    MulticastGroupL2 string
    Base multicast group address for L2.
    MulticastGroupL3 string
    Base multicast group address for L3.
    MultisiteSourceInterface string
    Interface representing the Multisite Border Gateway. Must match first field in the output of show int brief.
    SourceInterface string
    Source Interface associated with the NVE. Must match first field in the output of show int brief.
    SuppressArp bool
    Suppress ARP.
    SuppressMacRoute bool
    Suppress MAC Route.
    Device string
    A device name from the provider configuration.
    adminState String
    Administrative state.
    advertiseVirtualMac Boolean
    Enable or disable Virtual MAC Advertisement in VPC mode.
    holdDownTime Integer
    Hold Down Time.
    hostReachabilityProtocol String
    Host Reachability Protocol.
    id String
    The distinguished name of the object.
    ingressReplicationProtocolBgp Boolean
    VxLAN Ingress Replication Protocol BGP.
    multicastGroupL2 String
    Base multicast group address for L2.
    multicastGroupL3 String
    Base multicast group address for L3.
    multisiteSourceInterface String
    Interface representing the Multisite Border Gateway. Must match first field in the output of show int brief.
    sourceInterface String
    Source Interface associated with the NVE. Must match first field in the output of show int brief.
    suppressArp Boolean
    Suppress ARP.
    suppressMacRoute Boolean
    Suppress MAC Route.
    device String
    A device name from the provider configuration.
    adminState string
    Administrative state.
    advertiseVirtualMac boolean
    Enable or disable Virtual MAC Advertisement in VPC mode.
    holdDownTime number
    Hold Down Time.
    hostReachabilityProtocol string
    Host Reachability Protocol.
    id string
    The distinguished name of the object.
    ingressReplicationProtocolBgp boolean
    VxLAN Ingress Replication Protocol BGP.
    multicastGroupL2 string
    Base multicast group address for L2.
    multicastGroupL3 string
    Base multicast group address for L3.
    multisiteSourceInterface string
    Interface representing the Multisite Border Gateway. Must match first field in the output of show int brief.
    sourceInterface string
    Source Interface associated with the NVE. Must match first field in the output of show int brief.
    suppressArp boolean
    Suppress ARP.
    suppressMacRoute boolean
    Suppress MAC Route.
    device string
    A device name from the provider configuration.
    admin_state str
    Administrative state.
    bool
    Enable or disable Virtual MAC Advertisement in VPC mode.
    hold_down_time int
    Hold Down Time.
    host_reachability_protocol str
    Host Reachability Protocol.
    id str
    The distinguished name of the object.
    ingress_replication_protocol_bgp bool
    VxLAN Ingress Replication Protocol BGP.
    multicast_group_l2 str
    Base multicast group address for L2.
    multicast_group_l3 str
    Base multicast group address for L3.
    multisite_source_interface str
    Interface representing the Multisite Border Gateway. Must match first field in the output of show int brief.
    source_interface str
    Source Interface associated with the NVE. Must match first field in the output of show int brief.
    suppress_arp bool
    Suppress ARP.
    suppress_mac_route bool
    Suppress MAC Route.
    device str
    A device name from the provider configuration.
    adminState String
    Administrative state.
    advertiseVirtualMac Boolean
    Enable or disable Virtual MAC Advertisement in VPC mode.
    holdDownTime Number
    Hold Down Time.
    hostReachabilityProtocol String
    Host Reachability Protocol.
    id String
    The distinguished name of the object.
    ingressReplicationProtocolBgp Boolean
    VxLAN Ingress Replication Protocol BGP.
    multicastGroupL2 String
    Base multicast group address for L2.
    multicastGroupL3 String
    Base multicast group address for L3.
    multisiteSourceInterface String
    Interface representing the Multisite Border Gateway. Must match first field in the output of show int brief.
    sourceInterface String
    Source Interface associated with the NVE. Must match first field in the output of show int brief.
    suppressArp Boolean
    Suppress ARP.
    suppressMacRoute Boolean
    Suppress MAC Route.
    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