Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco IOS XE Resource Provider
  3. API Docs
  4. Cdp
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
lbrlabs/pulumi-iosxe

iosxe.Cdp

Explore with Pulumi AI

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

This resource can manage the CDP configuration.

Example Usage

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.iosxe.Cdp;
import com.pulumi.iosxe.CdpArgs;
import com.pulumi.iosxe.inputs.CdpTlvListArgs;
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) {
        var example = new Cdp("example", CdpArgs.builder()        
            .filterTlvList("TLIST")
            .holdtime(15)
            .run(true)
            .timer(5)
            .tlvLists(CdpTlvListArgs.builder()
                .cos(true)
                .duplex(true)
                .name("TLIST")
                .trust(true)
                .version(true)
                .vtp_mgmt_domain(true)
                .build())
            .build());

    }
}
Copy

Coming soon!

Coming soon!

resources:
  example:
    type: iosxe:Cdp
    properties:
      filterTlvList: TLIST
      holdtime: 15
      run: true
      timer: 5
      tlvLists:
        - cos: true
          duplex: true
          name: TLIST
          trust: true
          version: true
          vtp_mgmt_domain: true
Copy

Create Cdp Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Cdp(name: string, args?: CdpArgs, opts?: CustomResourceOptions);
@overload
def Cdp(resource_name: str,
        args: Optional[CdpArgs] = None,
        opts: Optional[ResourceOptions] = None)

@overload
def Cdp(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        device: Optional[str] = None,
        filter_tlv_list: Optional[str] = None,
        holdtime: Optional[int] = None,
        run: Optional[bool] = None,
        timer: Optional[int] = None,
        tlv_lists: Optional[Sequence[CdpTlvListArgs]] = None)
func NewCdp(ctx *Context, name string, args *CdpArgs, opts ...ResourceOption) (*Cdp, error)
public Cdp(string name, CdpArgs? args = null, CustomResourceOptions? opts = null)
public Cdp(String name, CdpArgs args)
public Cdp(String name, CdpArgs args, CustomResourceOptions options)

type: iosxe:Cdp
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args CdpArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args CdpArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args CdpArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args CdpArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CdpArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var cdpResource = new Iosxe.Cdp("cdpResource", new()
{
    Device = "string",
    FilterTlvList = "string",
    Holdtime = 0,
    Run = false,
    Timer = 0,
    TlvLists = new[]
    {
        new Iosxe.Inputs.CdpTlvListArgs
        {
            Name = "string",
            Cos = false,
            Duplex = false,
            Trust = false,
            Version = false,
            VtpMgmtDomain = false,
        },
    },
});
Copy
example, err := iosxe.NewCdp(ctx, "cdpResource", &iosxe.CdpArgs{
	Device:        pulumi.String("string"),
	FilterTlvList: pulumi.String("string"),
	Holdtime:      pulumi.Int(0),
	Run:           pulumi.Bool(false),
	Timer:         pulumi.Int(0),
	TlvLists: iosxe.CdpTlvListArray{
		&iosxe.CdpTlvListArgs{
			Name:          pulumi.String("string"),
			Cos:           pulumi.Bool(false),
			Duplex:        pulumi.Bool(false),
			Trust:         pulumi.Bool(false),
			Version:       pulumi.Bool(false),
			VtpMgmtDomain: pulumi.Bool(false),
		},
	},
})
Copy
var cdpResource = new Cdp("cdpResource", CdpArgs.builder()
    .device("string")
    .filterTlvList("string")
    .holdtime(0)
    .run(false)
    .timer(0)
    .tlvLists(CdpTlvListArgs.builder()
        .name("string")
        .cos(false)
        .duplex(false)
        .trust(false)
        .version(false)
        .vtpMgmtDomain(false)
        .build())
    .build());
Copy
cdp_resource = iosxe.Cdp("cdpResource",
    device="string",
    filter_tlv_list="string",
    holdtime=0,
    run=False,
    timer=0,
    tlv_lists=[{
        "name": "string",
        "cos": False,
        "duplex": False,
        "trust": False,
        "version": False,
        "vtp_mgmt_domain": False,
    }])
Copy
const cdpResource = new iosxe.Cdp("cdpResource", {
    device: "string",
    filterTlvList: "string",
    holdtime: 0,
    run: false,
    timer: 0,
    tlvLists: [{
        name: "string",
        cos: false,
        duplex: false,
        trust: false,
        version: false,
        vtpMgmtDomain: false,
    }],
});
Copy
type: iosxe:Cdp
properties:
    device: string
    filterTlvList: string
    holdtime: 0
    run: false
    timer: 0
    tlvLists:
        - cos: false
          duplex: false
          name: string
          trust: false
          version: false
          vtpMgmtDomain: false
Copy

Cdp Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Cdp resource accepts the following input properties:

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 - Range: 10-255
Run bool
Enable CDP
Timer int
Specify the rate at which CDP packets are sent (in sec) - Range: 5-254
TlvLists List<Lbrlabs.PulumiPackage.Iosxe.Inputs.CdpTlvList>
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 - Range: 10-255
Run bool
Enable CDP
Timer int
Specify the rate at which CDP packets are sent (in sec) - Range: 5-254
TlvLists []CdpTlvListArgs
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 - Range: 10-255
run Boolean
Enable CDP
timer Integer
Specify the rate at which CDP packets are sent (in sec) - Range: 5-254
tlvLists List<CdpTlvList>
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 - Range: 10-255
run boolean
Enable CDP
timer number
Specify the rate at which CDP packets are sent (in sec) - Range: 5-254
tlvLists CdpTlvList[]
Configure tlv-list
device str
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 - Range: 10-255
run bool
Enable CDP
timer int
Specify the rate at which CDP packets are sent (in sec) - Range: 5-254
tlv_lists Sequence[CdpTlvListArgs]
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 - Range: 10-255
run Boolean
Enable CDP
timer Number
Specify the rate at which CDP packets are sent (in sec) - Range: 5-254
tlvLists List<Property Map>
Configure tlv-list

Outputs

All input properties are implicitly available as output properties. Additionally, the Cdp resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Cdp Resource

Get an existing Cdp resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: CdpState, opts?: CustomResourceOptions): Cdp
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        device: Optional[str] = None,
        filter_tlv_list: Optional[str] = None,
        holdtime: Optional[int] = None,
        run: Optional[bool] = None,
        timer: Optional[int] = None,
        tlv_lists: Optional[Sequence[CdpTlvListArgs]] = None) -> Cdp
func GetCdp(ctx *Context, name string, id IDInput, state *CdpState, opts ...ResourceOption) (*Cdp, error)
public static Cdp Get(string name, Input<string> id, CdpState? state, CustomResourceOptions? opts = null)
public static Cdp get(String name, Output<String> id, CdpState state, CustomResourceOptions options)
resources:  _:    type: iosxe:Cdp    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
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 - Range: 10-255
Run bool
Enable CDP
Timer int
Specify the rate at which CDP packets are sent (in sec) - Range: 5-254
TlvLists List<Lbrlabs.PulumiPackage.Iosxe.Inputs.CdpTlvList>
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 - Range: 10-255
Run bool
Enable CDP
Timer int
Specify the rate at which CDP packets are sent (in sec) - Range: 5-254
TlvLists []CdpTlvListArgs
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 - Range: 10-255
run Boolean
Enable CDP
timer Integer
Specify the rate at which CDP packets are sent (in sec) - Range: 5-254
tlvLists List<CdpTlvList>
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 - Range: 10-255
run boolean
Enable CDP
timer number
Specify the rate at which CDP packets are sent (in sec) - Range: 5-254
tlvLists CdpTlvList[]
Configure tlv-list
device str
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 - Range: 10-255
run bool
Enable CDP
timer int
Specify the rate at which CDP packets are sent (in sec) - Range: 5-254
tlv_lists Sequence[CdpTlvListArgs]
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 - Range: 10-255
run Boolean
Enable CDP
timer Number
Specify the rate at which CDP packets are sent (in sec) - Range: 5-254
tlvLists List<Property Map>
Configure tlv-list

Supporting Types

CdpTlvList
, CdpTlvListArgs

Name This property is required. string
Cos bool
Duplex bool
Trust bool
Version bool
VtpMgmtDomain bool
Name This property is required. string
Cos bool
Duplex bool
Trust bool
Version bool
VtpMgmtDomain bool
name This property is required. String
cos Boolean
duplex Boolean
trust Boolean
version Boolean
vtpMgmtDomain Boolean
name This property is required. string
cos boolean
duplex boolean
trust boolean
version boolean
vtpMgmtDomain boolean
name This property is required. str
cos bool
duplex bool
trust bool
version bool
vtp_mgmt_domain bool
name This property is required. String
cos Boolean
duplex Boolean
trust Boolean
version Boolean
vtpMgmtDomain Boolean

Import

 $ pulumi import iosxe:index/cdp:Cdp example "Cisco-IOS-XE-native:native/cdp"
Copy

To learn more about importing existing cloud resources, see Importing resources.

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
lbrlabs/pulumi-iosxe