1. Packages
  2. Cisco Catalyst SD-WAN
  3. API Docs
  4. SystemMrfFeature
Cisco Catalyst SD-WAN v0.2.0 published on Friday, Nov 1, 2024 by Pulumi

sdwan.SystemMrfFeature

Explore with Pulumi AI

sdwan logo
Cisco Catalyst SD-WAN v0.2.0 published on Friday, Nov 1, 2024 by Pulumi

    This resource can manage a System MRF Feature.

    • Minimum SD-WAN Manager version: 20.12.0

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as sdwan from "@pulumi/sdwan";
    
    const example = new sdwan.SystemMrfFeature("example", {
        name: "Example",
        description: "My Example",
        featureProfileId: "f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac",
        regionId: 1,
        secondaryRegionId: 2,
        role: "edge-router",
        enableMigrationToMrf: "enabled",
        migrationBgpCommunity: 100,
    });
    
    import pulumi
    import pulumi_sdwan as sdwan
    
    example = sdwan.SystemMrfFeature("example",
        name="Example",
        description="My Example",
        feature_profile_id="f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac",
        region_id=1,
        secondary_region_id=2,
        role="edge-router",
        enable_migration_to_mrf="enabled",
        migration_bgp_community=100)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-sdwan/sdk/go/sdwan"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := sdwan.NewSystemMrfFeature(ctx, "example", &sdwan.SystemMrfFeatureArgs{
    			Name:                  pulumi.String("Example"),
    			Description:           pulumi.String("My Example"),
    			FeatureProfileId:      pulumi.String("f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac"),
    			RegionId:              pulumi.Int(1),
    			SecondaryRegionId:     pulumi.Int(2),
    			Role:                  pulumi.String("edge-router"),
    			EnableMigrationToMrf:  pulumi.String("enabled"),
    			MigrationBgpCommunity: pulumi.Int(100),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Sdwan = Pulumi.Sdwan;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Sdwan.SystemMrfFeature("example", new()
        {
            Name = "Example",
            Description = "My Example",
            FeatureProfileId = "f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac",
            RegionId = 1,
            SecondaryRegionId = 2,
            Role = "edge-router",
            EnableMigrationToMrf = "enabled",
            MigrationBgpCommunity = 100,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.sdwan.SystemMrfFeature;
    import com.pulumi.sdwan.SystemMrfFeatureArgs;
    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 SystemMrfFeature("example", SystemMrfFeatureArgs.builder()
                .name("Example")
                .description("My Example")
                .featureProfileId("f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac")
                .regionId(1)
                .secondaryRegionId(2)
                .role("edge-router")
                .enableMigrationToMrf("enabled")
                .migrationBgpCommunity(100)
                .build());
    
        }
    }
    
    resources:
      example:
        type: sdwan:SystemMrfFeature
        properties:
          name: Example
          description: My Example
          featureProfileId: f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac
          regionId: 1
          secondaryRegionId: 2
          role: edge-router
          enableMigrationToMrf: enabled
          migrationBgpCommunity: 100
    

    Create SystemMrfFeature Resource

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

    Constructor syntax

    new SystemMrfFeature(name: string, args?: SystemMrfFeatureArgs, opts?: CustomResourceOptions);
    @overload
    def SystemMrfFeature(resource_name: str,
                         args: Optional[SystemMrfFeatureArgs] = None,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def SystemMrfFeature(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         description: Optional[str] = None,
                         enable_migration_to_mrf: Optional[str] = None,
                         feature_profile_id: Optional[str] = None,
                         migration_bgp_community: Optional[int] = None,
                         name: Optional[str] = None,
                         region_id: Optional[int] = None,
                         role: Optional[str] = None,
                         role_variable: Optional[str] = None,
                         secondary_region_id: Optional[int] = None,
                         secondary_region_id_variable: Optional[str] = None)
    func NewSystemMrfFeature(ctx *Context, name string, args *SystemMrfFeatureArgs, opts ...ResourceOption) (*SystemMrfFeature, error)
    public SystemMrfFeature(string name, SystemMrfFeatureArgs? args = null, CustomResourceOptions? opts = null)
    public SystemMrfFeature(String name, SystemMrfFeatureArgs args)
    public SystemMrfFeature(String name, SystemMrfFeatureArgs args, CustomResourceOptions options)
    
    type: sdwan:SystemMrfFeature
    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 SystemMrfFeatureArgs
    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 SystemMrfFeatureArgs
    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 SystemMrfFeatureArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SystemMrfFeatureArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SystemMrfFeatureArgs
    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 systemMrfFeatureResource = new Sdwan.SystemMrfFeature("systemMrfFeatureResource", new()
    {
        Description = "string",
        EnableMigrationToMrf = "string",
        FeatureProfileId = "string",
        MigrationBgpCommunity = 0,
        Name = "string",
        RegionId = 0,
        Role = "string",
        RoleVariable = "string",
        SecondaryRegionId = 0,
        SecondaryRegionIdVariable = "string",
    });
    
    example, err := sdwan.NewSystemMrfFeature(ctx, "systemMrfFeatureResource", &sdwan.SystemMrfFeatureArgs{
    	Description:               pulumi.String("string"),
    	EnableMigrationToMrf:      pulumi.String("string"),
    	FeatureProfileId:          pulumi.String("string"),
    	MigrationBgpCommunity:     pulumi.Int(0),
    	Name:                      pulumi.String("string"),
    	RegionId:                  pulumi.Int(0),
    	Role:                      pulumi.String("string"),
    	RoleVariable:              pulumi.String("string"),
    	SecondaryRegionId:         pulumi.Int(0),
    	SecondaryRegionIdVariable: pulumi.String("string"),
    })
    
    var systemMrfFeatureResource = new SystemMrfFeature("systemMrfFeatureResource", SystemMrfFeatureArgs.builder()
        .description("string")
        .enableMigrationToMrf("string")
        .featureProfileId("string")
        .migrationBgpCommunity(0)
        .name("string")
        .regionId(0)
        .role("string")
        .roleVariable("string")
        .secondaryRegionId(0)
        .secondaryRegionIdVariable("string")
        .build());
    
    system_mrf_feature_resource = sdwan.SystemMrfFeature("systemMrfFeatureResource",
        description="string",
        enable_migration_to_mrf="string",
        feature_profile_id="string",
        migration_bgp_community=0,
        name="string",
        region_id=0,
        role="string",
        role_variable="string",
        secondary_region_id=0,
        secondary_region_id_variable="string")
    
    const systemMrfFeatureResource = new sdwan.SystemMrfFeature("systemMrfFeatureResource", {
        description: "string",
        enableMigrationToMrf: "string",
        featureProfileId: "string",
        migrationBgpCommunity: 0,
        name: "string",
        regionId: 0,
        role: "string",
        roleVariable: "string",
        secondaryRegionId: 0,
        secondaryRegionIdVariable: "string",
    });
    
    type: sdwan:SystemMrfFeature
    properties:
        description: string
        enableMigrationToMrf: string
        featureProfileId: string
        migrationBgpCommunity: 0
        name: string
        regionId: 0
        role: string
        roleVariable: string
        secondaryRegionId: 0
        secondaryRegionIdVariable: string
    

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

    Description string
    The description of the Feature
    EnableMigrationToMrf string
    Enable migration mode to Multi-Region Fabric - Choices: enabled, enabled-from-bgp-core
    FeatureProfileId string
    Feature Profile ID
    MigrationBgpCommunity int
    Set BGP community during migration from BGP-core based network - Range: 1-4294967295
    Name string
    The name of the Feature
    RegionId int
    Set region ID - Range: 1-63
    Role string
    Set the role for router - Choices: edge-router, border-router
    RoleVariable string
    Variable name
    SecondaryRegionId int
    Set secondary region ID - Range: 1-63
    SecondaryRegionIdVariable string
    Variable name
    Description string
    The description of the Feature
    EnableMigrationToMrf string
    Enable migration mode to Multi-Region Fabric - Choices: enabled, enabled-from-bgp-core
    FeatureProfileId string
    Feature Profile ID
    MigrationBgpCommunity int
    Set BGP community during migration from BGP-core based network - Range: 1-4294967295
    Name string
    The name of the Feature
    RegionId int
    Set region ID - Range: 1-63
    Role string
    Set the role for router - Choices: edge-router, border-router
    RoleVariable string
    Variable name
    SecondaryRegionId int
    Set secondary region ID - Range: 1-63
    SecondaryRegionIdVariable string
    Variable name
    description String
    The description of the Feature
    enableMigrationToMrf String
    Enable migration mode to Multi-Region Fabric - Choices: enabled, enabled-from-bgp-core
    featureProfileId String
    Feature Profile ID
    migrationBgpCommunity Integer
    Set BGP community during migration from BGP-core based network - Range: 1-4294967295
    name String
    The name of the Feature
    regionId Integer
    Set region ID - Range: 1-63
    role String
    Set the role for router - Choices: edge-router, border-router
    roleVariable String
    Variable name
    secondaryRegionId Integer
    Set secondary region ID - Range: 1-63
    secondaryRegionIdVariable String
    Variable name
    description string
    The description of the Feature
    enableMigrationToMrf string
    Enable migration mode to Multi-Region Fabric - Choices: enabled, enabled-from-bgp-core
    featureProfileId string
    Feature Profile ID
    migrationBgpCommunity number
    Set BGP community during migration from BGP-core based network - Range: 1-4294967295
    name string
    The name of the Feature
    regionId number
    Set region ID - Range: 1-63
    role string
    Set the role for router - Choices: edge-router, border-router
    roleVariable string
    Variable name
    secondaryRegionId number
    Set secondary region ID - Range: 1-63
    secondaryRegionIdVariable string
    Variable name
    description str
    The description of the Feature
    enable_migration_to_mrf str
    Enable migration mode to Multi-Region Fabric - Choices: enabled, enabled-from-bgp-core
    feature_profile_id str
    Feature Profile ID
    migration_bgp_community int
    Set BGP community during migration from BGP-core based network - Range: 1-4294967295
    name str
    The name of the Feature
    region_id int
    Set region ID - Range: 1-63
    role str
    Set the role for router - Choices: edge-router, border-router
    role_variable str
    Variable name
    secondary_region_id int
    Set secondary region ID - Range: 1-63
    secondary_region_id_variable str
    Variable name
    description String
    The description of the Feature
    enableMigrationToMrf String
    Enable migration mode to Multi-Region Fabric - Choices: enabled, enabled-from-bgp-core
    featureProfileId String
    Feature Profile ID
    migrationBgpCommunity Number
    Set BGP community during migration from BGP-core based network - Range: 1-4294967295
    name String
    The name of the Feature
    regionId Number
    Set region ID - Range: 1-63
    role String
    Set the role for router - Choices: edge-router, border-router
    roleVariable String
    Variable name
    secondaryRegionId Number
    Set secondary region ID - Range: 1-63
    secondaryRegionIdVariable String
    Variable name

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Version int
    The version of the Feature
    Id string
    The provider-assigned unique ID for this managed resource.
    Version int
    The version of the Feature
    id String
    The provider-assigned unique ID for this managed resource.
    version Integer
    The version of the Feature
    id string
    The provider-assigned unique ID for this managed resource.
    version number
    The version of the Feature
    id str
    The provider-assigned unique ID for this managed resource.
    version int
    The version of the Feature
    id String
    The provider-assigned unique ID for this managed resource.
    version Number
    The version of the Feature

    Look up Existing SystemMrfFeature Resource

    Get an existing SystemMrfFeature 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?: SystemMrfFeatureState, opts?: CustomResourceOptions): SystemMrfFeature
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            enable_migration_to_mrf: Optional[str] = None,
            feature_profile_id: Optional[str] = None,
            migration_bgp_community: Optional[int] = None,
            name: Optional[str] = None,
            region_id: Optional[int] = None,
            role: Optional[str] = None,
            role_variable: Optional[str] = None,
            secondary_region_id: Optional[int] = None,
            secondary_region_id_variable: Optional[str] = None,
            version: Optional[int] = None) -> SystemMrfFeature
    func GetSystemMrfFeature(ctx *Context, name string, id IDInput, state *SystemMrfFeatureState, opts ...ResourceOption) (*SystemMrfFeature, error)
    public static SystemMrfFeature Get(string name, Input<string> id, SystemMrfFeatureState? state, CustomResourceOptions? opts = null)
    public static SystemMrfFeature get(String name, Output<String> id, SystemMrfFeatureState 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:
    Description string
    The description of the Feature
    EnableMigrationToMrf string
    Enable migration mode to Multi-Region Fabric - Choices: enabled, enabled-from-bgp-core
    FeatureProfileId string
    Feature Profile ID
    MigrationBgpCommunity int
    Set BGP community during migration from BGP-core based network - Range: 1-4294967295
    Name string
    The name of the Feature
    RegionId int
    Set region ID - Range: 1-63
    Role string
    Set the role for router - Choices: edge-router, border-router
    RoleVariable string
    Variable name
    SecondaryRegionId int
    Set secondary region ID - Range: 1-63
    SecondaryRegionIdVariable string
    Variable name
    Version int
    The version of the Feature
    Description string
    The description of the Feature
    EnableMigrationToMrf string
    Enable migration mode to Multi-Region Fabric - Choices: enabled, enabled-from-bgp-core
    FeatureProfileId string
    Feature Profile ID
    MigrationBgpCommunity int
    Set BGP community during migration from BGP-core based network - Range: 1-4294967295
    Name string
    The name of the Feature
    RegionId int
    Set region ID - Range: 1-63
    Role string
    Set the role for router - Choices: edge-router, border-router
    RoleVariable string
    Variable name
    SecondaryRegionId int
    Set secondary region ID - Range: 1-63
    SecondaryRegionIdVariable string
    Variable name
    Version int
    The version of the Feature
    description String
    The description of the Feature
    enableMigrationToMrf String
    Enable migration mode to Multi-Region Fabric - Choices: enabled, enabled-from-bgp-core
    featureProfileId String
    Feature Profile ID
    migrationBgpCommunity Integer
    Set BGP community during migration from BGP-core based network - Range: 1-4294967295
    name String
    The name of the Feature
    regionId Integer
    Set region ID - Range: 1-63
    role String
    Set the role for router - Choices: edge-router, border-router
    roleVariable String
    Variable name
    secondaryRegionId Integer
    Set secondary region ID - Range: 1-63
    secondaryRegionIdVariable String
    Variable name
    version Integer
    The version of the Feature
    description string
    The description of the Feature
    enableMigrationToMrf string
    Enable migration mode to Multi-Region Fabric - Choices: enabled, enabled-from-bgp-core
    featureProfileId string
    Feature Profile ID
    migrationBgpCommunity number
    Set BGP community during migration from BGP-core based network - Range: 1-4294967295
    name string
    The name of the Feature
    regionId number
    Set region ID - Range: 1-63
    role string
    Set the role for router - Choices: edge-router, border-router
    roleVariable string
    Variable name
    secondaryRegionId number
    Set secondary region ID - Range: 1-63
    secondaryRegionIdVariable string
    Variable name
    version number
    The version of the Feature
    description str
    The description of the Feature
    enable_migration_to_mrf str
    Enable migration mode to Multi-Region Fabric - Choices: enabled, enabled-from-bgp-core
    feature_profile_id str
    Feature Profile ID
    migration_bgp_community int
    Set BGP community during migration from BGP-core based network - Range: 1-4294967295
    name str
    The name of the Feature
    region_id int
    Set region ID - Range: 1-63
    role str
    Set the role for router - Choices: edge-router, border-router
    role_variable str
    Variable name
    secondary_region_id int
    Set secondary region ID - Range: 1-63
    secondary_region_id_variable str
    Variable name
    version int
    The version of the Feature
    description String
    The description of the Feature
    enableMigrationToMrf String
    Enable migration mode to Multi-Region Fabric - Choices: enabled, enabled-from-bgp-core
    featureProfileId String
    Feature Profile ID
    migrationBgpCommunity Number
    Set BGP community during migration from BGP-core based network - Range: 1-4294967295
    name String
    The name of the Feature
    regionId Number
    Set region ID - Range: 1-63
    role String
    Set the role for router - Choices: edge-router, border-router
    roleVariable String
    Variable name
    secondaryRegionId Number
    Set secondary region ID - Range: 1-63
    secondaryRegionIdVariable String
    Variable name
    version Number
    The version of the Feature

    Import

    Expected import identifier with the format: “system_mrf_feature_id,feature_profile_id”

    $ pulumi import sdwan:index/systemMrfFeature:SystemMrfFeature example "f6b2c44c-693c-4763-b010-895aa3d236bd,f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac"
    

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

    Package Details

    Repository
    sdwan pulumi/pulumi-sdwan
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the sdwan Terraform Provider.
    sdwan logo
    Cisco Catalyst SD-WAN v0.2.0 published on Friday, Nov 1, 2024 by Pulumi