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

iosxe.MsdpVrf

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 MSDP VRF 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.MsdpVrf;
import com.pulumi.iosxe.MsdpVrfArgs;
import com.pulumi.iosxe.inputs.MsdpVrfPasswordArgs;
import com.pulumi.iosxe.inputs.MsdpVrfPeerArgs;
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 MsdpVrf("example", MsdpVrfArgs.builder()        
            .originatorId("Loopback100")
            .passwords(MsdpVrfPasswordArgs.builder()
                .addr("10.1.1.1")
                .encryption(0)
                .password("Cisco123")
                .build())
            .peers(MsdpVrfPeerArgs.builder()
                .addr("10.1.1.1")
                .connect_source_loopback(100)
                .remote_as(65000)
                .build())
            .vrf("VRF1")
            .build());

    }
}

    Coming soon!

    Coming soon!

    resources:
  example:
    type: iosxe:MsdpVrf
    properties:
      originatorId: Loopback100
      passwords:
        - addr: 10.1.1.1
          encryption: 0
          password: Cisco123
      peers:
        - addr: 10.1.1.1
          connect_source_loopback: 100
          remote_as: 65000
      vrf: VRF1

    Create MsdpVrf Resource

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

    Constructor syntax

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

@overload
def MsdpVrf(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            vrf: Optional[str] = None,
            delete_mode: Optional[str] = None,
            device: Optional[str] = None,
            originator_id: Optional[str] = None,
            passwords: Optional[Sequence[MsdpVrfPasswordArgs]] = None,
            peers: Optional[Sequence[MsdpVrfPeerArgs]] = None)
    func NewMsdpVrf(ctx *Context, name string, args MsdpVrfArgs, opts ...ResourceOption) (*MsdpVrf, error)
    public MsdpVrf(string name, MsdpVrfArgs args, CustomResourceOptions? opts = null)
    public MsdpVrf(String name, MsdpVrfArgs args)
public MsdpVrf(String name, MsdpVrfArgs args, CustomResourceOptions options)

    type: iosxe:MsdpVrf
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 MsdpVrfArgs
    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 MsdpVrfArgs
    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 MsdpVrfArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MsdpVrfArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MsdpVrfArgs
    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 msdpVrfResource = new Iosxe.MsdpVrf("msdpVrfResource", new()
{
    Vrf = "string",
    DeleteMode = "string",
    Device = "string",
    OriginatorId = "string",
    Passwords = new[]
    {
        new Iosxe.Inputs.MsdpVrfPasswordArgs
        {
            Addr = "string",
            Password = "string",
            Encryption = 0,
        },
    },
    Peers = new[]
    {
        new Iosxe.Inputs.MsdpVrfPeerArgs
        {
            Addr = "string",
            ConnectSourceLoopback = 0,
            RemoteAs = 0,
        },
    },
});

    example, err := iosxe.NewMsdpVrf(ctx, "msdpVrfResource", &iosxe.MsdpVrfArgs{
	Vrf:          pulumi.String("string"),
	DeleteMode:   pulumi.String("string"),
	Device:       pulumi.String("string"),
	OriginatorId: pulumi.String("string"),
	Passwords: iosxe.MsdpVrfPasswordArray{
		&iosxe.MsdpVrfPasswordArgs{
			Addr:       pulumi.String("string"),
			Password:   pulumi.String("string"),
			Encryption: pulumi.Int(0),
		},
	},
	Peers: iosxe.MsdpVrfPeerArray{
		&iosxe.MsdpVrfPeerArgs{
			Addr:                  pulumi.String("string"),
			ConnectSourceLoopback: pulumi.Int(0),
			RemoteAs:              pulumi.Int(0),
		},
	},
})

    var msdpVrfResource = new MsdpVrf("msdpVrfResource", MsdpVrfArgs.builder()
    .vrf("string")
    .deleteMode("string")
    .device("string")
    .originatorId("string")
    .passwords(MsdpVrfPasswordArgs.builder()
        .addr("string")
        .password("string")
        .encryption(0)
        .build())
    .peers(MsdpVrfPeerArgs.builder()
        .addr("string")
        .connectSourceLoopback(0)
        .remoteAs(0)
        .build())
    .build());

    msdp_vrf_resource = iosxe.MsdpVrf("msdpVrfResource",
    vrf="string",
    delete_mode="string",
    device="string",
    originator_id="string",
    passwords=[iosxe.MsdpVrfPasswordArgs(
        addr="string",
        password="string",
        encryption=0,
    )],
    peers=[iosxe.MsdpVrfPeerArgs(
        addr="string",
        connect_source_loopback=0,
        remote_as=0,
    )])

    const msdpVrfResource = new iosxe.MsdpVrf("msdpVrfResource", {
    vrf: "string",
    deleteMode: "string",
    device: "string",
    originatorId: "string",
    passwords: [{
        addr: "string",
        password: "string",
        encryption: 0,
    }],
    peers: [{
        addr: "string",
        connectSourceLoopback: 0,
        remoteAs: 0,
    }],
});

    type: iosxe:MsdpVrf
properties:
    deleteMode: string
    device: string
    originatorId: string
    passwords:
        - addr: string
          encryption: 0
          password: string
    peers:
        - addr: string
          connectSourceLoopback: 0
          remoteAs: 0
    vrf: string

    MsdpVrf Resource Properties

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

    Inputs

    The MsdpVrf resource accepts the following input properties:

    Vrf string
    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Device string
    A device name from the provider configuration.
    OriginatorId string
    Configure MSDP Originator ID
    Passwords List<Lbrlabs.PulumiPackage.Iosxe.Inputs.MsdpVrfPassword>
    MSDP peer on which the password is to be set
    Peers List<Lbrlabs.PulumiPackage.Iosxe.Inputs.MsdpVrfPeer>
    Configure an MSDP peer
    Vrf string
    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Device string
    A device name from the provider configuration.
    OriginatorId string
    Configure MSDP Originator ID
    Passwords []MsdpVrfPasswordArgs
    MSDP peer on which the password is to be set
    Peers []MsdpVrfPeerArgs
    Configure an MSDP peer
    vrf String
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device String
    A device name from the provider configuration.
    originatorId String
    Configure MSDP Originator ID
    passwords List<MsdpVrfPassword>
    MSDP peer on which the password is to be set
    peers List<MsdpVrfPeer>
    Configure an MSDP peer
    vrf string
    deleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device string
    A device name from the provider configuration.
    originatorId string
    Configure MSDP Originator ID
    passwords MsdpVrfPassword[]
    MSDP peer on which the password is to be set
    peers MsdpVrfPeer[]
    Configure an MSDP peer
    vrf str
    delete_mode str
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device str
    A device name from the provider configuration.
    originator_id str
    Configure MSDP Originator ID
    passwords Sequence[MsdpVrfPasswordArgs]
    MSDP peer on which the password is to be set
    peers Sequence[MsdpVrfPeerArgs]
    Configure an MSDP peer
    vrf String
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device String
    A device name from the provider configuration.
    originatorId String
    Configure MSDP Originator ID
    passwords List<Property Map>
    MSDP peer on which the password is to be set
    peers List<Property Map>
    Configure an MSDP peer

    Outputs

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

    Get an existing MsdpVrf 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?: MsdpVrfState, opts?: CustomResourceOptions): MsdpVrf
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        delete_mode: Optional[str] = None,
        device: Optional[str] = None,
        originator_id: Optional[str] = None,
        passwords: Optional[Sequence[MsdpVrfPasswordArgs]] = None,
        peers: Optional[Sequence[MsdpVrfPeerArgs]] = None,
        vrf: Optional[str] = None) -> MsdpVrf
    func GetMsdpVrf(ctx *Context, name string, id IDInput, state *MsdpVrfState, opts ...ResourceOption) (*MsdpVrf, error)
    public static MsdpVrf Get(string name, Input<string> id, MsdpVrfState? state, CustomResourceOptions? opts = null)
    public static MsdpVrf get(String name, Output<String> id, MsdpVrfState 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:
    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Device string
    A device name from the provider configuration.
    OriginatorId string
    Configure MSDP Originator ID
    Passwords List<Lbrlabs.PulumiPackage.Iosxe.Inputs.MsdpVrfPassword>
    MSDP peer on which the password is to be set
    Peers List<Lbrlabs.PulumiPackage.Iosxe.Inputs.MsdpVrfPeer>
    Configure an MSDP peer
    Vrf string
    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Device string
    A device name from the provider configuration.
    OriginatorId string
    Configure MSDP Originator ID
    Passwords []MsdpVrfPasswordArgs
    MSDP peer on which the password is to be set
    Peers []MsdpVrfPeerArgs
    Configure an MSDP peer
    Vrf string
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device String
    A device name from the provider configuration.
    originatorId String
    Configure MSDP Originator ID
    passwords List<MsdpVrfPassword>
    MSDP peer on which the password is to be set
    peers List<MsdpVrfPeer>
    Configure an MSDP peer
    vrf String
    deleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device string
    A device name from the provider configuration.
    originatorId string
    Configure MSDP Originator ID
    passwords MsdpVrfPassword[]
    MSDP peer on which the password is to be set
    peers MsdpVrfPeer[]
    Configure an MSDP peer
    vrf string
    delete_mode str
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device str
    A device name from the provider configuration.
    originator_id str
    Configure MSDP Originator ID
    passwords Sequence[MsdpVrfPasswordArgs]
    MSDP peer on which the password is to be set
    peers Sequence[MsdpVrfPeerArgs]
    Configure an MSDP peer
    vrf str
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    device String
    A device name from the provider configuration.
    originatorId String
    Configure MSDP Originator ID
    passwords List<Property Map>
    MSDP peer on which the password is to be set
    peers List<Property Map>
    Configure an MSDP peer
    vrf String

    Supporting Types

    MsdpVrfPassword, MsdpVrfPasswordArgs

    Addr string
    Password string
    Encryption int
    Addr string
    Password string
    Encryption int
    addr String
    password String
    encryption Integer
    addr string
    password string
    encryption number
    addr String
    password String
    encryption Number

    MsdpVrfPeer, MsdpVrfPeerArgs

    addr String
    connectSourceLoopback Integer
    remoteAs Integer

    Import

     $ pulumi import iosxe:index/msdpVrf:MsdpVrf example "Cisco-IOS-XE-native:native/ip/Cisco-IOS-XE-multicast:msdp/vrf=VRF1"

    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