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

iosxe.getCdp

Explore with Pulumi AI

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

    This data source can read the CDP configuration.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Iosxe = Pulumi.Iosxe;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Iosxe.GetCdp.Invoke();
    
    });
    
    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.LookupCdp(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.iosxe.IosxeFunctions;
    import com.pulumi.iosxe.inputs.GetCdpArgs;
    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.getCdp();
    
        }
    }
    
    import pulumi
    import pulumi_iosxe as iosxe
    
    example = iosxe.get_cdp()
    
    import * as pulumi from "@pulumi/pulumi";
    import * as iosxe from "@pulumi/iosxe";
    
    const example = iosxe.getCdp({});
    
    variables:
      example:
        fn::invoke:
          Function: iosxe:getCdp
          Arguments: {}
    

    Using getCdp

    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 getCdp(args: GetCdpArgs, opts?: InvokeOptions): Promise<GetCdpResult>
    function getCdpOutput(args: GetCdpOutputArgs, opts?: InvokeOptions): Output<GetCdpResult>
    def get_cdp(device: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetCdpResult
    def get_cdp_output(device: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetCdpResult]
    func LookupCdp(ctx *Context, args *LookupCdpArgs, opts ...InvokeOption) (*LookupCdpResult, error)
    func LookupCdpOutput(ctx *Context, args *LookupCdpOutputArgs, opts ...InvokeOption) LookupCdpResultOutput

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

    public static class GetCdp 
    {
        public static Task<GetCdpResult> InvokeAsync(GetCdpArgs args, InvokeOptions? opts = null)
        public static Output<GetCdpResult> Invoke(GetCdpInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCdpResult> getCdp(GetCdpArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: iosxe:index/getCdp:getCdp
      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.

    getCdp Result

    The following output properties are available:

    FilterTlvList string
    Apply tlv-list globally
    Holdtime int
    Specify the holdtime (in sec) to be sent in packets
    Id string
    The path of the retrieved object.
    Run bool
    Enable CDP
    Timer int
    Specify the rate at which CDP packets are sent (in sec)
    TlvLists List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetCdpTlvList>
    Configure tlv-list
    Device string
    A device name from the provider configuration.
    FilterTlvList string
    Apply tlv-list globally
    Holdtime int
    Specify the holdtime (in sec) to be sent in packets
    Id string
    The path of the retrieved object.
    Run bool
    Enable CDP
    Timer int
    Specify the rate at which CDP packets are sent (in sec)
    TlvLists []GetCdpTlvList
    Configure tlv-list
    Device string
    A device name from the provider configuration.
    filterTlvList String
    Apply tlv-list globally
    holdtime Integer
    Specify the holdtime (in sec) to be sent in packets
    id String
    The path of the retrieved object.
    run Boolean
    Enable CDP
    timer Integer
    Specify the rate at which CDP packets are sent (in sec)
    tlvLists List<GetCdpTlvList>
    Configure tlv-list
    device String
    A device name from the provider configuration.
    filterTlvList string
    Apply tlv-list globally
    holdtime number
    Specify the holdtime (in sec) to be sent in packets
    id string
    The path of the retrieved object.
    run boolean
    Enable CDP
    timer number
    Specify the rate at which CDP packets are sent (in sec)
    tlvLists GetCdpTlvList[]
    Configure tlv-list
    device string
    A device name from the provider configuration.
    filter_tlv_list str
    Apply tlv-list globally
    holdtime int
    Specify the holdtime (in sec) to be sent in packets
    id str
    The path of the retrieved object.
    run bool
    Enable CDP
    timer int
    Specify the rate at which CDP packets are sent (in sec)
    tlv_lists Sequence[GetCdpTlvList]
    Configure tlv-list
    device str
    A device name from the provider configuration.
    filterTlvList String
    Apply tlv-list globally
    holdtime Number
    Specify the holdtime (in sec) to be sent in packets
    id String
    The path of the retrieved object.
    run Boolean
    Enable CDP
    timer Number
    Specify the rate at which CDP packets are sent (in sec)
    tlvLists List<Property Map>
    Configure tlv-list
    device String
    A device name from the provider configuration.

    Supporting Types

    GetCdpTlvList

    Cos bool
    Select cos TLV
    Duplex bool
    Select duplex TLV
    Name string
    Tlv-list
    Trust bool
    Select trust TLV
    Version bool
    Select version TLV
    VtpMgmtDomain bool
    Select vtp mgmt domain TLV
    Cos bool
    Select cos TLV
    Duplex bool
    Select duplex TLV
    Name string
    Tlv-list
    Trust bool
    Select trust TLV
    Version bool
    Select version TLV
    VtpMgmtDomain bool
    Select vtp mgmt domain TLV
    cos Boolean
    Select cos TLV
    duplex Boolean
    Select duplex TLV
    name String
    Tlv-list
    trust Boolean
    Select trust TLV
    version Boolean
    Select version TLV
    vtpMgmtDomain Boolean
    Select vtp mgmt domain TLV
    cos boolean
    Select cos TLV
    duplex boolean
    Select duplex TLV
    name string
    Tlv-list
    trust boolean
    Select trust TLV
    version boolean
    Select version TLV
    vtpMgmtDomain boolean
    Select vtp mgmt domain TLV
    cos bool
    Select cos TLV
    duplex bool
    Select duplex TLV
    name str
    Tlv-list
    trust bool
    Select trust TLV
    version bool
    Select version TLV
    vtp_mgmt_domain bool
    Select vtp mgmt domain TLV
    cos Boolean
    Select cos TLV
    duplex Boolean
    Select duplex TLV
    name String
    Tlv-list
    trust Boolean
    Select trust TLV
    version Boolean
    Select version TLV
    vtpMgmtDomain Boolean
    Select vtp mgmt domain TLV

    Package Details

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