1. Packages
  2. Cisco NX OS Resource Provider
  3. API Docs
  4. RouteMapRuleEntrySetRegularCommunity
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs

nxos.RouteMapRuleEntrySetRegularCommunity

Explore with Pulumi AI

nxos logo
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs

    This resource can manage a Set Community configuration in a Route-Map Rule Entry.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nxos = Lbrlabs.PulumiPackage.Nxos;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Nxos.RouteMapRuleEntrySetRegularCommunity("example", new()
        {
            Additive = "disabled",
            NoCommunity = "disabled",
            Order = 10,
            RuleName = "RULE1",
            SetCriteria = "none",
        });
    
    });
    
    package main
    
    import (
    	"github.com/lbrlabs/pulumi-nxos/sdk/go/nxos"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := nxos.NewRouteMapRuleEntrySetRegularCommunity(ctx, "example", &nxos.RouteMapRuleEntrySetRegularCommunityArgs{
    			Additive:    pulumi.String("disabled"),
    			NoCommunity: pulumi.String("disabled"),
    			Order:       pulumi.Int(10),
    			RuleName:    pulumi.String("RULE1"),
    			SetCriteria: pulumi.String("none"),
    		})
    		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.nxos.RouteMapRuleEntrySetRegularCommunity;
    import com.pulumi.nxos.RouteMapRuleEntrySetRegularCommunityArgs;
    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 RouteMapRuleEntrySetRegularCommunity("example", RouteMapRuleEntrySetRegularCommunityArgs.builder()        
                .additive("disabled")
                .noCommunity("disabled")
                .order(10)
                .ruleName("RULE1")
                .setCriteria("none")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_nxos as nxos
    
    example = nxos.RouteMapRuleEntrySetRegularCommunity("example",
        additive="disabled",
        no_community="disabled",
        order=10,
        rule_name="RULE1",
        set_criteria="none")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as nxos from "@lbrlabs/pulumi-nxos";
    
    const example = new nxos.RouteMapRuleEntrySetRegularCommunity("example", {
        additive: "disabled",
        noCommunity: "disabled",
        order: 10,
        ruleName: "RULE1",
        setCriteria: "none",
    });
    
    resources:
      example:
        type: nxos:RouteMapRuleEntrySetRegularCommunity
        properties:
          additive: disabled
          noCommunity: disabled
          order: 10
          ruleName: RULE1
          setCriteria: none
    

    Create RouteMapRuleEntrySetRegularCommunity Resource

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

    Constructor syntax

    new RouteMapRuleEntrySetRegularCommunity(name: string, args: RouteMapRuleEntrySetRegularCommunityArgs, opts?: CustomResourceOptions);
    @overload
    def RouteMapRuleEntrySetRegularCommunity(resource_name: str,
                                             args: RouteMapRuleEntrySetRegularCommunityArgs,
                                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def RouteMapRuleEntrySetRegularCommunity(resource_name: str,
                                             opts: Optional[ResourceOptions] = None,
                                             order: Optional[int] = None,
                                             rule_name: Optional[str] = None,
                                             additive: Optional[str] = None,
                                             device: Optional[str] = None,
                                             no_community: Optional[str] = None,
                                             set_criteria: Optional[str] = None)
    func NewRouteMapRuleEntrySetRegularCommunity(ctx *Context, name string, args RouteMapRuleEntrySetRegularCommunityArgs, opts ...ResourceOption) (*RouteMapRuleEntrySetRegularCommunity, error)
    public RouteMapRuleEntrySetRegularCommunity(string name, RouteMapRuleEntrySetRegularCommunityArgs args, CustomResourceOptions? opts = null)
    public RouteMapRuleEntrySetRegularCommunity(String name, RouteMapRuleEntrySetRegularCommunityArgs args)
    public RouteMapRuleEntrySetRegularCommunity(String name, RouteMapRuleEntrySetRegularCommunityArgs args, CustomResourceOptions options)
    
    type: nxos:RouteMapRuleEntrySetRegularCommunity
    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 RouteMapRuleEntrySetRegularCommunityArgs
    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 RouteMapRuleEntrySetRegularCommunityArgs
    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 RouteMapRuleEntrySetRegularCommunityArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RouteMapRuleEntrySetRegularCommunityArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RouteMapRuleEntrySetRegularCommunityArgs
    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 routeMapRuleEntrySetRegularCommunityResource = new Nxos.RouteMapRuleEntrySetRegularCommunity("routeMapRuleEntrySetRegularCommunityResource", new()
    {
        Order = 0,
        RuleName = "string",
        Additive = "string",
        Device = "string",
        NoCommunity = "string",
        SetCriteria = "string",
    });
    
    example, err := nxos.NewRouteMapRuleEntrySetRegularCommunity(ctx, "routeMapRuleEntrySetRegularCommunityResource", &nxos.RouteMapRuleEntrySetRegularCommunityArgs{
    	Order:       pulumi.Int(0),
    	RuleName:    pulumi.String("string"),
    	Additive:    pulumi.String("string"),
    	Device:      pulumi.String("string"),
    	NoCommunity: pulumi.String("string"),
    	SetCriteria: pulumi.String("string"),
    })
    
    var routeMapRuleEntrySetRegularCommunityResource = new RouteMapRuleEntrySetRegularCommunity("routeMapRuleEntrySetRegularCommunityResource", RouteMapRuleEntrySetRegularCommunityArgs.builder()
        .order(0)
        .ruleName("string")
        .additive("string")
        .device("string")
        .noCommunity("string")
        .setCriteria("string")
        .build());
    
    route_map_rule_entry_set_regular_community_resource = nxos.RouteMapRuleEntrySetRegularCommunity("routeMapRuleEntrySetRegularCommunityResource",
        order=0,
        rule_name="string",
        additive="string",
        device="string",
        no_community="string",
        set_criteria="string")
    
    const routeMapRuleEntrySetRegularCommunityResource = new nxos.RouteMapRuleEntrySetRegularCommunity("routeMapRuleEntrySetRegularCommunityResource", {
        order: 0,
        ruleName: "string",
        additive: "string",
        device: "string",
        noCommunity: "string",
        setCriteria: "string",
    });
    
    type: nxos:RouteMapRuleEntrySetRegularCommunity
    properties:
        additive: string
        device: string
        noCommunity: string
        order: 0
        ruleName: string
        setCriteria: string
    

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

    Order int
    Route-Map Rule Entry order. - Range: 0-65535
    RuleName string
    Route Map rule name.
    Additive string
    Option to add to an existing community. - Choices: enabled, disabled - Default value: disabled
    Device string
    A device name from the provider configuration.
    NoCommunity string
    Option to have no community attribute. - Choices: enabled, disabled - Default value: disabled
    SetCriteria string
    Operation on the current community. - Choices: none, append, replace, igp, pre-bestpath - Default value: none
    Order int
    Route-Map Rule Entry order. - Range: 0-65535
    RuleName string
    Route Map rule name.
    Additive string
    Option to add to an existing community. - Choices: enabled, disabled - Default value: disabled
    Device string
    A device name from the provider configuration.
    NoCommunity string
    Option to have no community attribute. - Choices: enabled, disabled - Default value: disabled
    SetCriteria string
    Operation on the current community. - Choices: none, append, replace, igp, pre-bestpath - Default value: none
    order Integer
    Route-Map Rule Entry order. - Range: 0-65535
    ruleName String
    Route Map rule name.
    additive String
    Option to add to an existing community. - Choices: enabled, disabled - Default value: disabled
    device String
    A device name from the provider configuration.
    noCommunity String
    Option to have no community attribute. - Choices: enabled, disabled - Default value: disabled
    setCriteria String
    Operation on the current community. - Choices: none, append, replace, igp, pre-bestpath - Default value: none
    order number
    Route-Map Rule Entry order. - Range: 0-65535
    ruleName string
    Route Map rule name.
    additive string
    Option to add to an existing community. - Choices: enabled, disabled - Default value: disabled
    device string
    A device name from the provider configuration.
    noCommunity string
    Option to have no community attribute. - Choices: enabled, disabled - Default value: disabled
    setCriteria string
    Operation on the current community. - Choices: none, append, replace, igp, pre-bestpath - Default value: none
    order int
    Route-Map Rule Entry order. - Range: 0-65535
    rule_name str
    Route Map rule name.
    additive str
    Option to add to an existing community. - Choices: enabled, disabled - Default value: disabled
    device str
    A device name from the provider configuration.
    no_community str
    Option to have no community attribute. - Choices: enabled, disabled - Default value: disabled
    set_criteria str
    Operation on the current community. - Choices: none, append, replace, igp, pre-bestpath - Default value: none
    order Number
    Route-Map Rule Entry order. - Range: 0-65535
    ruleName String
    Route Map rule name.
    additive String
    Option to add to an existing community. - Choices: enabled, disabled - Default value: disabled
    device String
    A device name from the provider configuration.
    noCommunity String
    Option to have no community attribute. - Choices: enabled, disabled - Default value: disabled
    setCriteria String
    Operation on the current community. - Choices: none, append, replace, igp, pre-bestpath - Default value: none

    Outputs

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

    Get an existing RouteMapRuleEntrySetRegularCommunity 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?: RouteMapRuleEntrySetRegularCommunityState, opts?: CustomResourceOptions): RouteMapRuleEntrySetRegularCommunity
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            additive: Optional[str] = None,
            device: Optional[str] = None,
            no_community: Optional[str] = None,
            order: Optional[int] = None,
            rule_name: Optional[str] = None,
            set_criteria: Optional[str] = None) -> RouteMapRuleEntrySetRegularCommunity
    func GetRouteMapRuleEntrySetRegularCommunity(ctx *Context, name string, id IDInput, state *RouteMapRuleEntrySetRegularCommunityState, opts ...ResourceOption) (*RouteMapRuleEntrySetRegularCommunity, error)
    public static RouteMapRuleEntrySetRegularCommunity Get(string name, Input<string> id, RouteMapRuleEntrySetRegularCommunityState? state, CustomResourceOptions? opts = null)
    public static RouteMapRuleEntrySetRegularCommunity get(String name, Output<String> id, RouteMapRuleEntrySetRegularCommunityState 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:
    Additive string
    Option to add to an existing community. - Choices: enabled, disabled - Default value: disabled
    Device string
    A device name from the provider configuration.
    NoCommunity string
    Option to have no community attribute. - Choices: enabled, disabled - Default value: disabled
    Order int
    Route-Map Rule Entry order. - Range: 0-65535
    RuleName string
    Route Map rule name.
    SetCriteria string
    Operation on the current community. - Choices: none, append, replace, igp, pre-bestpath - Default value: none
    Additive string
    Option to add to an existing community. - Choices: enabled, disabled - Default value: disabled
    Device string
    A device name from the provider configuration.
    NoCommunity string
    Option to have no community attribute. - Choices: enabled, disabled - Default value: disabled
    Order int
    Route-Map Rule Entry order. - Range: 0-65535
    RuleName string
    Route Map rule name.
    SetCriteria string
    Operation on the current community. - Choices: none, append, replace, igp, pre-bestpath - Default value: none
    additive String
    Option to add to an existing community. - Choices: enabled, disabled - Default value: disabled
    device String
    A device name from the provider configuration.
    noCommunity String
    Option to have no community attribute. - Choices: enabled, disabled - Default value: disabled
    order Integer
    Route-Map Rule Entry order. - Range: 0-65535
    ruleName String
    Route Map rule name.
    setCriteria String
    Operation on the current community. - Choices: none, append, replace, igp, pre-bestpath - Default value: none
    additive string
    Option to add to an existing community. - Choices: enabled, disabled - Default value: disabled
    device string
    A device name from the provider configuration.
    noCommunity string
    Option to have no community attribute. - Choices: enabled, disabled - Default value: disabled
    order number
    Route-Map Rule Entry order. - Range: 0-65535
    ruleName string
    Route Map rule name.
    setCriteria string
    Operation on the current community. - Choices: none, append, replace, igp, pre-bestpath - Default value: none
    additive str
    Option to add to an existing community. - Choices: enabled, disabled - Default value: disabled
    device str
    A device name from the provider configuration.
    no_community str
    Option to have no community attribute. - Choices: enabled, disabled - Default value: disabled
    order int
    Route-Map Rule Entry order. - Range: 0-65535
    rule_name str
    Route Map rule name.
    set_criteria str
    Operation on the current community. - Choices: none, append, replace, igp, pre-bestpath - Default value: none
    additive String
    Option to add to an existing community. - Choices: enabled, disabled - Default value: disabled
    device String
    A device name from the provider configuration.
    noCommunity String
    Option to have no community attribute. - Choices: enabled, disabled - Default value: disabled
    order Number
    Route-Map Rule Entry order. - Range: 0-65535
    ruleName String
    Route Map rule name.
    setCriteria String
    Operation on the current community. - Choices: none, append, replace, igp, pre-bestpath - Default value: none

    Import

     $ pulumi import nxos:index/routeMapRuleEntrySetRegularCommunity:RouteMapRuleEntrySetRegularCommunity example "sys/rpm/rtmap-[RULE1]/ent-[10]/sregcomm"
    

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

    Package Details

    Repository
    nxos lbrlabs/pulumi-nxos
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nxos Terraform Provider.
    nxos logo
    Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs