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

iosxe.Msdp

Explore with Pulumi AI

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

    This resource can manage the MSDP 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.Msdp;
    import com.pulumi.iosxe.MsdpArgs;
    import com.pulumi.iosxe.inputs.MsdpPasswordArgs;
    import com.pulumi.iosxe.inputs.MsdpPeerArgs;
    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 Msdp("example", MsdpArgs.builder()        
                .originatorId("Loopback100")
                .passwords(MsdpPasswordArgs.builder()
                    .addr("10.1.1.1")
                    .encryption(0)
                    .password("Cisco123")
                    .build())
                .peers(MsdpPeerArgs.builder()
                    .addr("10.1.1.1")
                    .connect_source_loopback(100)
                    .remote_as(65000)
                    .build())
                .build());
    
        }
    }
    

    Coming soon!

    Coming soon!

    resources:
      example:
        type: iosxe:Msdp
        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
    

    Create Msdp Resource

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

    Constructor syntax

    new Msdp(name: string, args?: MsdpArgs, opts?: CustomResourceOptions);
    @overload
    def Msdp(resource_name: str,
             args: Optional[MsdpArgs] = None,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Msdp(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             delete_mode: Optional[str] = None,
             device: Optional[str] = None,
             originator_id: Optional[str] = None,
             passwords: Optional[Sequence[MsdpPasswordArgs]] = None,
             peers: Optional[Sequence[MsdpPeerArgs]] = None)
    func NewMsdp(ctx *Context, name string, args *MsdpArgs, opts ...ResourceOption) (*Msdp, error)
    public Msdp(string name, MsdpArgs? args = null, CustomResourceOptions? opts = null)
    public Msdp(String name, MsdpArgs args)
    public Msdp(String name, MsdpArgs args, CustomResourceOptions options)
    
    type: iosxe:Msdp
    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 MsdpArgs
    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 MsdpArgs
    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 MsdpArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MsdpArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MsdpArgs
    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 msdpResource = new Iosxe.Msdp("msdpResource", new()
    {
        DeleteMode = "string",
        Device = "string",
        OriginatorId = "string",
        Passwords = new[]
        {
            new Iosxe.Inputs.MsdpPasswordArgs
            {
                Addr = "string",
                Password = "string",
                Encryption = 0,
            },
        },
        Peers = new[]
        {
            new Iosxe.Inputs.MsdpPeerArgs
            {
                Addr = "string",
                ConnectSourceLoopback = 0,
                RemoteAs = 0,
            },
        },
    });
    
    example, err := iosxe.NewMsdp(ctx, "msdpResource", &iosxe.MsdpArgs{
    	DeleteMode:   pulumi.String("string"),
    	Device:       pulumi.String("string"),
    	OriginatorId: pulumi.String("string"),
    	Passwords: iosxe.MsdpPasswordArray{
    		&iosxe.MsdpPasswordArgs{
    			Addr:       pulumi.String("string"),
    			Password:   pulumi.String("string"),
    			Encryption: pulumi.Int(0),
    		},
    	},
    	Peers: iosxe.MsdpPeerArray{
    		&iosxe.MsdpPeerArgs{
    			Addr:                  pulumi.String("string"),
    			ConnectSourceLoopback: pulumi.Int(0),
    			RemoteAs:              pulumi.Int(0),
    		},
    	},
    })
    
    var msdpResource = new Msdp("msdpResource", MsdpArgs.builder()
        .deleteMode("string")
        .device("string")
        .originatorId("string")
        .passwords(MsdpPasswordArgs.builder()
            .addr("string")
            .password("string")
            .encryption(0)
            .build())
        .peers(MsdpPeerArgs.builder()
            .addr("string")
            .connectSourceLoopback(0)
            .remoteAs(0)
            .build())
        .build());
    
    msdp_resource = iosxe.Msdp("msdpResource",
        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,
        }])
    
    const msdpResource = new iosxe.Msdp("msdpResource", {
        deleteMode: "string",
        device: "string",
        originatorId: "string",
        passwords: [{
            addr: "string",
            password: "string",
            encryption: 0,
        }],
        peers: [{
            addr: "string",
            connectSourceLoopback: 0,
            remoteAs: 0,
        }],
    });
    
    type: iosxe:Msdp
    properties:
        deleteMode: string
        device: string
        originatorId: string
        passwords:
            - addr: string
              encryption: 0
              password: string
        peers:
            - addr: string
              connectSourceLoopback: 0
              remoteAs: 0
    

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

    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.MsdpPassword>
    MSDP peer on which the password is to be set
    Peers List<Lbrlabs.PulumiPackage.Iosxe.Inputs.MsdpPeer>
    Configure an MSDP peer
    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 []MsdpPasswordArgs
    MSDP peer on which the password is to be set
    Peers []MsdpPeerArgs
    Configure an MSDP peer
    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<MsdpPassword>
    MSDP peer on which the password is to be set
    peers List<MsdpPeer>
    Configure an MSDP peer
    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 MsdpPassword[]
    MSDP peer on which the password is to be set
    peers MsdpPeer[]
    Configure an MSDP peer
    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[MsdpPasswordArgs]
    MSDP peer on which the password is to be set
    peers Sequence[MsdpPeerArgs]
    Configure an MSDP peer
    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 Msdp 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 Msdp Resource

    Get an existing Msdp 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?: MsdpState, opts?: CustomResourceOptions): Msdp
    @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[MsdpPasswordArgs]] = None,
            peers: Optional[Sequence[MsdpPeerArgs]] = None) -> Msdp
    func GetMsdp(ctx *Context, name string, id IDInput, state *MsdpState, opts ...ResourceOption) (*Msdp, error)
    public static Msdp Get(string name, Input<string> id, MsdpState? state, CustomResourceOptions? opts = null)
    public static Msdp get(String name, Output<String> id, MsdpState 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.MsdpPassword>
    MSDP peer on which the password is to be set
    Peers List<Lbrlabs.PulumiPackage.Iosxe.Inputs.MsdpPeer>
    Configure an MSDP peer
    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 []MsdpPasswordArgs
    MSDP peer on which the password is to be set
    Peers []MsdpPeerArgs
    Configure an MSDP peer
    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<MsdpPassword>
    MSDP peer on which the password is to be set
    peers List<MsdpPeer>
    Configure an MSDP peer
    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 MsdpPassword[]
    MSDP peer on which the password is to be set
    peers MsdpPeer[]
    Configure an MSDP peer
    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[MsdpPasswordArgs]
    MSDP peer on which the password is to be set
    peers Sequence[MsdpPeerArgs]
    Configure an MSDP peer
    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

    Supporting Types

    MsdpPassword, MsdpPasswordArgs

    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

    MsdpPeer, MsdpPeerArgs

    addr String
    connectSourceLoopback Integer
    remoteAs Integer

    Import

     $ pulumi import iosxe:index/msdp:Msdp example "Cisco-IOS-XE-native:native/ip/Cisco-IOS-XE-multicast:msdp"
    

    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