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

iosxe.InterfacePim

Explore with Pulumi AI

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

    This resource can manage the Interface PIM configuration.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Iosxe = Lbrlabs.PulumiPackage.Iosxe;

return await Deployment.RunAsync(() => 
{
    var example = new Iosxe.InterfacePim("example", new()
    {
        Bfd = false,
        Border = false,
        BsrBorder = false,
        DenseMode = false,
        DrPriority = 10,
        Passive = false,
        SparseDenseMode = false,
        SparseMode = true,
        Type = "Loopback",
    });

});

    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.NewInterfacePim(ctx, "example", &iosxe.InterfacePimArgs{
			Bfd:             pulumi.Bool(false),
			Border:          pulumi.Bool(false),
			BsrBorder:       pulumi.Bool(false),
			DenseMode:       pulumi.Bool(false),
			DrPriority:      pulumi.Int(10),
			Passive:         pulumi.Bool(false),
			SparseDenseMode: pulumi.Bool(false),
			SparseMode:      pulumi.Bool(true),
			Type:            pulumi.String("Loopback"),
		})
		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.InterfacePim;
import com.pulumi.iosxe.InterfacePimArgs;
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 InterfacePim("example", InterfacePimArgs.builder()        
            .bfd(false)
            .border(false)
            .bsrBorder(false)
            .denseMode(false)
            .drPriority(10)
            .passive(false)
            .sparseDenseMode(false)
            .sparseMode(true)
            .type("Loopback")
            .build());

    }
}

    import pulumi
import lbrlabs_pulumi_iosxe as iosxe

example = iosxe.InterfacePim("example",
    bfd=False,
    border=False,
    bsr_border=False,
    dense_mode=False,
    dr_priority=10,
    passive=False,
    sparse_dense_mode=False,
    sparse_mode=True,
    type="Loopback")

    import * as pulumi from "@pulumi/pulumi";
import * as iosxe from "@lbrlabs/pulumi-iosxe";

const example = new iosxe.InterfacePim("example", {
    bfd: false,
    border: false,
    bsrBorder: false,
    denseMode: false,
    drPriority: 10,
    passive: false,
    sparseDenseMode: false,
    sparseMode: true,
    type: "Loopback",
});

    resources:
  example:
    type: iosxe:InterfacePim
    properties:
      bfd: false
      border: false
      bsrBorder: false
      denseMode: false
      drPriority: 10
      passive: false
      sparseDenseMode: false
      sparseMode: true
      type: Loopback

    Create InterfacePim Resource

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

    Constructor syntax

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

@overload
def InterfacePim(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 type: Optional[str] = None,
                 bfd: Optional[bool] = None,
                 border: Optional[bool] = None,
                 bsr_border: Optional[bool] = None,
                 dense_mode: Optional[bool] = None,
                 device: Optional[str] = None,
                 dr_priority: Optional[int] = None,
                 name: Optional[str] = None,
                 passive: Optional[bool] = None,
                 sparse_dense_mode: Optional[bool] = None,
                 sparse_mode: Optional[bool] = None)
    func NewInterfacePim(ctx *Context, name string, args InterfacePimArgs, opts ...ResourceOption) (*InterfacePim, error)
    public InterfacePim(string name, InterfacePimArgs args, CustomResourceOptions? opts = null)
    public InterfacePim(String name, InterfacePimArgs args)
public InterfacePim(String name, InterfacePimArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args InterfacePimArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args InterfacePimArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args InterfacePimArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InterfacePimArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InterfacePimArgs
    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 interfacePimResource = new Iosxe.InterfacePim("interfacePimResource", new()
{
    Type = "string",
    Bfd = false,
    Border = false,
    BsrBorder = false,
    DenseMode = false,
    Device = "string",
    DrPriority = 0,
    Name = "string",
    Passive = false,
    SparseDenseMode = false,
    SparseMode = false,
});

    example, err := iosxe.NewInterfacePim(ctx, "interfacePimResource", &iosxe.InterfacePimArgs{
	Type:            pulumi.String("string"),
	Bfd:             pulumi.Bool(false),
	Border:          pulumi.Bool(false),
	BsrBorder:       pulumi.Bool(false),
	DenseMode:       pulumi.Bool(false),
	Device:          pulumi.String("string"),
	DrPriority:      pulumi.Int(0),
	Name:            pulumi.String("string"),
	Passive:         pulumi.Bool(false),
	SparseDenseMode: pulumi.Bool(false),
	SparseMode:      pulumi.Bool(false),
})

    var interfacePimResource = new InterfacePim("interfacePimResource", InterfacePimArgs.builder()
    .type("string")
    .bfd(false)
    .border(false)
    .bsrBorder(false)
    .denseMode(false)
    .device("string")
    .drPriority(0)
    .name("string")
    .passive(false)
    .sparseDenseMode(false)
    .sparseMode(false)
    .build());

    interface_pim_resource = iosxe.InterfacePim("interfacePimResource",
    type="string",
    bfd=False,
    border=False,
    bsr_border=False,
    dense_mode=False,
    device="string",
    dr_priority=0,
    name="string",
    passive=False,
    sparse_dense_mode=False,
    sparse_mode=False)

    const interfacePimResource = new iosxe.InterfacePim("interfacePimResource", {
    type: "string",
    bfd: false,
    border: false,
    bsrBorder: false,
    denseMode: false,
    device: "string",
    drPriority: 0,
    name: "string",
    passive: false,
    sparseDenseMode: false,
    sparseMode: false,
});

    type: iosxe:InterfacePim
properties:
    bfd: false
    border: false
    bsrBorder: false
    denseMode: false
    device: string
    drPriority: 0
    name: string
    passive: false
    sparseDenseMode: false
    sparseMode: false
    type: string

    InterfacePim 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 InterfacePim resource accepts the following input properties:

    Type string
    Interface type - Choices: GigabitEthernet, TwoGigabitEthernet, FiveGigabitEthernet, TenGigabitEthernet, TwentyFiveGigE, FortyGigabitEthernet, HundredGigE, TwoHundredGigE, FourHundredGigE, Loopback, Vlan, Port-channel
    Bfd bool
    Configure BFD
    Border bool
    Border of PIM domain
    BsrBorder bool
    Border of PIM domain
    DenseMode bool
    Enable PIM dense-mode operation
    Device string
    A device name from the provider configuration.
    DrPriority int
    PIM router DR priority - Range: 0-4294967295
    Name string
    Passive bool
    Enable PIM passive interface operation
    SparseDenseMode bool
    Enable PIM sparse-dense-mode operation
    SparseMode bool
    Enable PIM sparse-mode operation
    Type string
    Interface type - Choices: GigabitEthernet, TwoGigabitEthernet, FiveGigabitEthernet, TenGigabitEthernet, TwentyFiveGigE, FortyGigabitEthernet, HundredGigE, TwoHundredGigE, FourHundredGigE, Loopback, Vlan, Port-channel
    Bfd bool
    Configure BFD
    Border bool
    Border of PIM domain
    BsrBorder bool
    Border of PIM domain
    DenseMode bool
    Enable PIM dense-mode operation
    Device string
    A device name from the provider configuration.
    DrPriority int
    PIM router DR priority - Range: 0-4294967295
    Name string
    Passive bool
    Enable PIM passive interface operation
    SparseDenseMode bool
    Enable PIM sparse-dense-mode operation
    SparseMode bool
    Enable PIM sparse-mode operation
    type String
    Interface type - Choices: GigabitEthernet, TwoGigabitEthernet, FiveGigabitEthernet, TenGigabitEthernet, TwentyFiveGigE, FortyGigabitEthernet, HundredGigE, TwoHundredGigE, FourHundredGigE, Loopback, Vlan, Port-channel
    bfd Boolean
    Configure BFD
    border Boolean
    Border of PIM domain
    bsrBorder Boolean
    Border of PIM domain
    denseMode Boolean
    Enable PIM dense-mode operation
    device String
    A device name from the provider configuration.
    drPriority Integer
    PIM router DR priority - Range: 0-4294967295
    name String
    passive Boolean
    Enable PIM passive interface operation
    sparseDenseMode Boolean
    Enable PIM sparse-dense-mode operation
    sparseMode Boolean
    Enable PIM sparse-mode operation
    type string
    Interface type - Choices: GigabitEthernet, TwoGigabitEthernet, FiveGigabitEthernet, TenGigabitEthernet, TwentyFiveGigE, FortyGigabitEthernet, HundredGigE, TwoHundredGigE, FourHundredGigE, Loopback, Vlan, Port-channel
    bfd boolean
    Configure BFD
    border boolean
    Border of PIM domain
    bsrBorder boolean
    Border of PIM domain
    denseMode boolean
    Enable PIM dense-mode operation
    device string
    A device name from the provider configuration.
    drPriority number
    PIM router DR priority - Range: 0-4294967295
    name string
    passive boolean
    Enable PIM passive interface operation
    sparseDenseMode boolean
    Enable PIM sparse-dense-mode operation
    sparseMode boolean
    Enable PIM sparse-mode operation
    type str
    Interface type - Choices: GigabitEthernet, TwoGigabitEthernet, FiveGigabitEthernet, TenGigabitEthernet, TwentyFiveGigE, FortyGigabitEthernet, HundredGigE, TwoHundredGigE, FourHundredGigE, Loopback, Vlan, Port-channel
    bfd bool
    Configure BFD
    border bool
    Border of PIM domain
    bsr_border bool
    Border of PIM domain
    dense_mode bool
    Enable PIM dense-mode operation
    device str
    A device name from the provider configuration.
    dr_priority int
    PIM router DR priority - Range: 0-4294967295
    name str
    passive bool
    Enable PIM passive interface operation
    sparse_dense_mode bool
    Enable PIM sparse-dense-mode operation
    sparse_mode bool
    Enable PIM sparse-mode operation
    type String
    Interface type - Choices: GigabitEthernet, TwoGigabitEthernet, FiveGigabitEthernet, TenGigabitEthernet, TwentyFiveGigE, FortyGigabitEthernet, HundredGigE, TwoHundredGigE, FourHundredGigE, Loopback, Vlan, Port-channel
    bfd Boolean
    Configure BFD
    border Boolean
    Border of PIM domain
    bsrBorder Boolean
    Border of PIM domain
    denseMode Boolean
    Enable PIM dense-mode operation
    device String
    A device name from the provider configuration.
    drPriority Number
    PIM router DR priority - Range: 0-4294967295
    name String
    passive Boolean
    Enable PIM passive interface operation
    sparseDenseMode Boolean
    Enable PIM sparse-dense-mode operation
    sparseMode Boolean
    Enable PIM sparse-mode operation

    Outputs

    All input properties are implicitly available as output properties. Additionally, the InterfacePim 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 InterfacePim Resource

    Get an existing InterfacePim 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?: InterfacePimState, opts?: CustomResourceOptions): InterfacePim
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bfd: Optional[bool] = None,
        border: Optional[bool] = None,
        bsr_border: Optional[bool] = None,
        dense_mode: Optional[bool] = None,
        device: Optional[str] = None,
        dr_priority: Optional[int] = None,
        name: Optional[str] = None,
        passive: Optional[bool] = None,
        sparse_dense_mode: Optional[bool] = None,
        sparse_mode: Optional[bool] = None,
        type: Optional[str] = None) -> InterfacePim
    func GetInterfacePim(ctx *Context, name string, id IDInput, state *InterfacePimState, opts ...ResourceOption) (*InterfacePim, error)
    public static InterfacePim Get(string name, Input<string> id, InterfacePimState? state, CustomResourceOptions? opts = null)
    public static InterfacePim get(String name, Output<String> id, InterfacePimState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    Bfd bool
    Configure BFD
    Border bool
    Border of PIM domain
    BsrBorder bool
    Border of PIM domain
    DenseMode bool
    Enable PIM dense-mode operation
    Device string
    A device name from the provider configuration.
    DrPriority int
    PIM router DR priority - Range: 0-4294967295
    Name string
    Passive bool
    Enable PIM passive interface operation
    SparseDenseMode bool
    Enable PIM sparse-dense-mode operation
    SparseMode bool
    Enable PIM sparse-mode operation
    Type string
    Interface type - Choices: GigabitEthernet, TwoGigabitEthernet, FiveGigabitEthernet, TenGigabitEthernet, TwentyFiveGigE, FortyGigabitEthernet, HundredGigE, TwoHundredGigE, FourHundredGigE, Loopback, Vlan, Port-channel
    Bfd bool
    Configure BFD
    Border bool
    Border of PIM domain
    BsrBorder bool
    Border of PIM domain
    DenseMode bool
    Enable PIM dense-mode operation
    Device string
    A device name from the provider configuration.
    DrPriority int
    PIM router DR priority - Range: 0-4294967295
    Name string
    Passive bool
    Enable PIM passive interface operation
    SparseDenseMode bool
    Enable PIM sparse-dense-mode operation
    SparseMode bool
    Enable PIM sparse-mode operation
    Type string
    Interface type - Choices: GigabitEthernet, TwoGigabitEthernet, FiveGigabitEthernet, TenGigabitEthernet, TwentyFiveGigE, FortyGigabitEthernet, HundredGigE, TwoHundredGigE, FourHundredGigE, Loopback, Vlan, Port-channel
    bfd Boolean
    Configure BFD
    border Boolean
    Border of PIM domain
    bsrBorder Boolean
    Border of PIM domain
    denseMode Boolean
    Enable PIM dense-mode operation
    device String
    A device name from the provider configuration.
    drPriority Integer
    PIM router DR priority - Range: 0-4294967295
    name String
    passive Boolean
    Enable PIM passive interface operation
    sparseDenseMode Boolean
    Enable PIM sparse-dense-mode operation
    sparseMode Boolean
    Enable PIM sparse-mode operation
    type String
    Interface type - Choices: GigabitEthernet, TwoGigabitEthernet, FiveGigabitEthernet, TenGigabitEthernet, TwentyFiveGigE, FortyGigabitEthernet, HundredGigE, TwoHundredGigE, FourHundredGigE, Loopback, Vlan, Port-channel
    bfd boolean
    Configure BFD
    border boolean
    Border of PIM domain
    bsrBorder boolean
    Border of PIM domain
    denseMode boolean
    Enable PIM dense-mode operation
    device string
    A device name from the provider configuration.
    drPriority number
    PIM router DR priority - Range: 0-4294967295
    name string
    passive boolean
    Enable PIM passive interface operation
    sparseDenseMode boolean
    Enable PIM sparse-dense-mode operation
    sparseMode boolean
    Enable PIM sparse-mode operation
    type string
    Interface type - Choices: GigabitEthernet, TwoGigabitEthernet, FiveGigabitEthernet, TenGigabitEthernet, TwentyFiveGigE, FortyGigabitEthernet, HundredGigE, TwoHundredGigE, FourHundredGigE, Loopback, Vlan, Port-channel
    bfd bool
    Configure BFD
    border bool
    Border of PIM domain
    bsr_border bool
    Border of PIM domain
    dense_mode bool
    Enable PIM dense-mode operation
    device str
    A device name from the provider configuration.
    dr_priority int
    PIM router DR priority - Range: 0-4294967295
    name str
    passive bool
    Enable PIM passive interface operation
    sparse_dense_mode bool
    Enable PIM sparse-dense-mode operation
    sparse_mode bool
    Enable PIM sparse-mode operation
    type str
    Interface type - Choices: GigabitEthernet, TwoGigabitEthernet, FiveGigabitEthernet, TenGigabitEthernet, TwentyFiveGigE, FortyGigabitEthernet, HundredGigE, TwoHundredGigE, FourHundredGigE, Loopback, Vlan, Port-channel
    bfd Boolean
    Configure BFD
    border Boolean
    Border of PIM domain
    bsrBorder Boolean
    Border of PIM domain
    denseMode Boolean
    Enable PIM dense-mode operation
    device String
    A device name from the provider configuration.
    drPriority Number
    PIM router DR priority - Range: 0-4294967295
    name String
    passive Boolean
    Enable PIM passive interface operation
    sparseDenseMode Boolean
    Enable PIM sparse-dense-mode operation
    sparseMode Boolean
    Enable PIM sparse-mode operation
    type String
    Interface type - Choices: GigabitEthernet, TwoGigabitEthernet, FiveGigabitEthernet, TenGigabitEthernet, TwentyFiveGigE, FortyGigabitEthernet, HundredGigE, TwoHundredGigE, FourHundredGigE, Loopback, Vlan, Port-channel

    Import

     $ pulumi import iosxe:index/interfacePim:InterfacePim example "Cisco-IOS-XE-native:native/interface/Loopback=100/ip/pim"

    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.
    iosxe logo
    Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
    lbrlabs/pulumi-iosxe