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

iosxe.MsdpVrf

Explore with Pulumi AI

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());

    }
}
Copy

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
Copy

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 This property is required. string
The unique name of the resource.
args This property is required. MsdpVrfArgs
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 This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. MsdpVrfArgs
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 This property is required. MsdpVrfArgs
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. 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,
        },
    },
});
Copy
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),
		},
	},
})
Copy
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());
Copy
msdp_vrf_resource = iosxe.MsdpVrf("msdpVrfResource",
    vrf="string",
    delete_mode="string",
    device="string",
    originator_id="string",
    passwords=[{
        "addr": "string",
        "password": "string",
        "encryption": 0,
    }],
    peers=[{
        "addr": "string",
        "connect_source_loopback": 0,
        "remote_as": 0,
    }])
Copy
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,
    }],
});
Copy
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
Copy

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

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

The MsdpVrf resource accepts the following input properties:

Vrf This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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)
resources:  _:    type: iosxe:MsdpVrf    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:
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 This property is required. string
Password This property is required. string
Encryption int
Addr This property is required. string
Password This property is required. string
Encryption int
addr This property is required. String
password This property is required. String
encryption Integer
addr This property is required. string
password This property is required. string
encryption number
addr This property is required. str
password This property is required. str
encryption int
addr This property is required. String
password This property is required. String
encryption Number

MsdpVrfPeer
, MsdpVrfPeerArgs

Addr This property is required. string
ConnectSourceLoopback int
RemoteAs int
Addr This property is required. string
ConnectSourceLoopback int
RemoteAs int
addr This property is required. String
connectSourceLoopback Integer
remoteAs Integer
addr This property is required. string
connectSourceLoopback number
remoteAs number
addr This property is required. str
connect_source_loopback int
remote_as int
addr This property is required. String
connectSourceLoopback Number
remoteAs Number

Import

 $ pulumi import iosxe:index/msdpVrf:MsdpVrf example "Cisco-IOS-XE-native:native/ip/Cisco-IOS-XE-multicast:msdp/vrf=VRF1"
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.