Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco NX OS Resource Provider
  3. API Docs
  4. PimSsmRange
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos

nxos.PimSsmRange

Explore with Pulumi AI

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

This resource can manage the PIM SSM range configuration.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nxos = Lbrlabs.PulumiPackage.Nxos;

return await Deployment.RunAsync(() => 
{
    var example = new Nxos.PimSsmRange("example", new()
    {
        GroupList1 = "232.0.0.0/8",
        GroupList2 = "233.0.0.0/8",
        GroupList3 = "0.0.0.0",
        GroupList4 = "0.0.0.0",
        PrefixList = "",
        RouteMap = "",
        SsmNone = false,
        VrfName = "default",
    });

});
Copy
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.NewPimSsmRange(ctx, "example", &nxos.PimSsmRangeArgs{
			GroupList1: pulumi.String("232.0.0.0/8"),
			GroupList2: pulumi.String("233.0.0.0/8"),
			GroupList3: pulumi.String("0.0.0.0"),
			GroupList4: pulumi.String("0.0.0.0"),
			PrefixList: pulumi.String(""),
			RouteMap:   pulumi.String(""),
			SsmNone:    pulumi.Bool(false),
			VrfName:    pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nxos.PimSsmRange;
import com.pulumi.nxos.PimSsmRangeArgs;
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 PimSsmRange("example", PimSsmRangeArgs.builder()        
            .groupList1("232.0.0.0/8")
            .groupList2("233.0.0.0/8")
            .groupList3("0.0.0.0")
            .groupList4("0.0.0.0")
            .prefixList("")
            .routeMap("")
            .ssmNone(false)
            .vrfName("default")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as nxos from "@lbrlabs/pulumi-nxos";

const example = new nxos.PimSsmRange("example", {
    groupList1: "232.0.0.0/8",
    groupList2: "233.0.0.0/8",
    groupList3: "0.0.0.0",
    groupList4: "0.0.0.0",
    prefixList: "",
    routeMap: "",
    ssmNone: false,
    vrfName: "default",
});
Copy
import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.PimSsmRange("example",
    group_list1="232.0.0.0/8",
    group_list2="233.0.0.0/8",
    group_list3="0.0.0.0",
    group_list4="0.0.0.0",
    prefix_list="",
    route_map="",
    ssm_none=False,
    vrf_name="default")
Copy
resources:
  example:
    type: nxos:PimSsmRange
    properties:
      groupList1: 232.0.0.0/8
      groupList2: 233.0.0.0/8
      groupList3: 0.0.0.0
      groupList4: 0.0.0.0
      prefixList:
      routeMap:
      ssmNone: false
      vrfName: default
Copy

Create PimSsmRange Resource

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

Constructor syntax

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

@overload
def PimSsmRange(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                vrf_name: Optional[str] = None,
                device: Optional[str] = None,
                group_list1: Optional[str] = None,
                group_list2: Optional[str] = None,
                group_list3: Optional[str] = None,
                group_list4: Optional[str] = None,
                prefix_list: Optional[str] = None,
                route_map: Optional[str] = None,
                ssm_none: Optional[bool] = None)
func NewPimSsmRange(ctx *Context, name string, args PimSsmRangeArgs, opts ...ResourceOption) (*PimSsmRange, error)
public PimSsmRange(string name, PimSsmRangeArgs args, CustomResourceOptions? opts = null)
public PimSsmRange(String name, PimSsmRangeArgs args)
public PimSsmRange(String name, PimSsmRangeArgs args, CustomResourceOptions options)

type: nxos:PimSsmRange
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. PimSsmRangeArgs
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. PimSsmRangeArgs
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. PimSsmRangeArgs
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. PimSsmRangeArgs
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. PimSsmRangeArgs
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 pimSsmRangeResource = new Nxos.PimSsmRange("pimSsmRangeResource", new()
{
    VrfName = "string",
    Device = "string",
    GroupList1 = "string",
    GroupList2 = "string",
    GroupList3 = "string",
    GroupList4 = "string",
    PrefixList = "string",
    RouteMap = "string",
    SsmNone = false,
});
Copy
example, err := nxos.NewPimSsmRange(ctx, "pimSsmRangeResource", &nxos.PimSsmRangeArgs{
	VrfName:    pulumi.String("string"),
	Device:     pulumi.String("string"),
	GroupList1: pulumi.String("string"),
	GroupList2: pulumi.String("string"),
	GroupList3: pulumi.String("string"),
	GroupList4: pulumi.String("string"),
	PrefixList: pulumi.String("string"),
	RouteMap:   pulumi.String("string"),
	SsmNone:    pulumi.Bool(false),
})
Copy
var pimSsmRangeResource = new PimSsmRange("pimSsmRangeResource", PimSsmRangeArgs.builder()
    .vrfName("string")
    .device("string")
    .groupList1("string")
    .groupList2("string")
    .groupList3("string")
    .groupList4("string")
    .prefixList("string")
    .routeMap("string")
    .ssmNone(false)
    .build());
Copy
pim_ssm_range_resource = nxos.PimSsmRange("pimSsmRangeResource",
    vrf_name="string",
    device="string",
    group_list1="string",
    group_list2="string",
    group_list3="string",
    group_list4="string",
    prefix_list="string",
    route_map="string",
    ssm_none=False)
Copy
const pimSsmRangeResource = new nxos.PimSsmRange("pimSsmRangeResource", {
    vrfName: "string",
    device: "string",
    groupList1: "string",
    groupList2: "string",
    groupList3: "string",
    groupList4: "string",
    prefixList: "string",
    routeMap: "string",
    ssmNone: false,
});
Copy
type: nxos:PimSsmRange
properties:
    device: string
    groupList1: string
    groupList2: string
    groupList3: string
    groupList4: string
    prefixList: string
    routeMap: string
    ssmNone: false
    vrfName: string
Copy

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

VrfName This property is required. string
VRF name.
Device string
A device name from the provider configuration.
GroupList1 string
Group list 1. - Default value: 0.0.0.0
GroupList2 string
Group list 2. - Default value: 0.0.0.0
GroupList3 string
Group list 3. - Default value: 0.0.0.0
GroupList4 string
Group list 4. - Default value: 0.0.0.0
PrefixList string
Prefix list name.
RouteMap string
Route map name.
SsmNone bool
Exclude standard SSM range (232.0.0.0/8). - Default value: false
VrfName This property is required. string
VRF name.
Device string
A device name from the provider configuration.
GroupList1 string
Group list 1. - Default value: 0.0.0.0
GroupList2 string
Group list 2. - Default value: 0.0.0.0
GroupList3 string
Group list 3. - Default value: 0.0.0.0
GroupList4 string
Group list 4. - Default value: 0.0.0.0
PrefixList string
Prefix list name.
RouteMap string
Route map name.
SsmNone bool
Exclude standard SSM range (232.0.0.0/8). - Default value: false
vrfName This property is required. String
VRF name.
device String
A device name from the provider configuration.
groupList1 String
Group list 1. - Default value: 0.0.0.0
groupList2 String
Group list 2. - Default value: 0.0.0.0
groupList3 String
Group list 3. - Default value: 0.0.0.0
groupList4 String
Group list 4. - Default value: 0.0.0.0
prefixList String
Prefix list name.
routeMap String
Route map name.
ssmNone Boolean
Exclude standard SSM range (232.0.0.0/8). - Default value: false
vrfName This property is required. string
VRF name.
device string
A device name from the provider configuration.
groupList1 string
Group list 1. - Default value: 0.0.0.0
groupList2 string
Group list 2. - Default value: 0.0.0.0
groupList3 string
Group list 3. - Default value: 0.0.0.0
groupList4 string
Group list 4. - Default value: 0.0.0.0
prefixList string
Prefix list name.
routeMap string
Route map name.
ssmNone boolean
Exclude standard SSM range (232.0.0.0/8). - Default value: false
vrf_name This property is required. str
VRF name.
device str
A device name from the provider configuration.
group_list1 str
Group list 1. - Default value: 0.0.0.0
group_list2 str
Group list 2. - Default value: 0.0.0.0
group_list3 str
Group list 3. - Default value: 0.0.0.0
group_list4 str
Group list 4. - Default value: 0.0.0.0
prefix_list str
Prefix list name.
route_map str
Route map name.
ssm_none bool
Exclude standard SSM range (232.0.0.0/8). - Default value: false
vrfName This property is required. String
VRF name.
device String
A device name from the provider configuration.
groupList1 String
Group list 1. - Default value: 0.0.0.0
groupList2 String
Group list 2. - Default value: 0.0.0.0
groupList3 String
Group list 3. - Default value: 0.0.0.0
groupList4 String
Group list 4. - Default value: 0.0.0.0
prefixList String
Prefix list name.
routeMap String
Route map name.
ssmNone Boolean
Exclude standard SSM range (232.0.0.0/8). - Default value: false

Outputs

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

Get an existing PimSsmRange 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?: PimSsmRangeState, opts?: CustomResourceOptions): PimSsmRange
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        device: Optional[str] = None,
        group_list1: Optional[str] = None,
        group_list2: Optional[str] = None,
        group_list3: Optional[str] = None,
        group_list4: Optional[str] = None,
        prefix_list: Optional[str] = None,
        route_map: Optional[str] = None,
        ssm_none: Optional[bool] = None,
        vrf_name: Optional[str] = None) -> PimSsmRange
func GetPimSsmRange(ctx *Context, name string, id IDInput, state *PimSsmRangeState, opts ...ResourceOption) (*PimSsmRange, error)
public static PimSsmRange Get(string name, Input<string> id, PimSsmRangeState? state, CustomResourceOptions? opts = null)
public static PimSsmRange get(String name, Output<String> id, PimSsmRangeState state, CustomResourceOptions options)
resources:  _:    type: nxos:PimSsmRange    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:
Device string
A device name from the provider configuration.
GroupList1 string
Group list 1. - Default value: 0.0.0.0
GroupList2 string
Group list 2. - Default value: 0.0.0.0
GroupList3 string
Group list 3. - Default value: 0.0.0.0
GroupList4 string
Group list 4. - Default value: 0.0.0.0
PrefixList string
Prefix list name.
RouteMap string
Route map name.
SsmNone bool
Exclude standard SSM range (232.0.0.0/8). - Default value: false
VrfName string
VRF name.
Device string
A device name from the provider configuration.
GroupList1 string
Group list 1. - Default value: 0.0.0.0
GroupList2 string
Group list 2. - Default value: 0.0.0.0
GroupList3 string
Group list 3. - Default value: 0.0.0.0
GroupList4 string
Group list 4. - Default value: 0.0.0.0
PrefixList string
Prefix list name.
RouteMap string
Route map name.
SsmNone bool
Exclude standard SSM range (232.0.0.0/8). - Default value: false
VrfName string
VRF name.
device String
A device name from the provider configuration.
groupList1 String
Group list 1. - Default value: 0.0.0.0
groupList2 String
Group list 2. - Default value: 0.0.0.0
groupList3 String
Group list 3. - Default value: 0.0.0.0
groupList4 String
Group list 4. - Default value: 0.0.0.0
prefixList String
Prefix list name.
routeMap String
Route map name.
ssmNone Boolean
Exclude standard SSM range (232.0.0.0/8). - Default value: false
vrfName String
VRF name.
device string
A device name from the provider configuration.
groupList1 string
Group list 1. - Default value: 0.0.0.0
groupList2 string
Group list 2. - Default value: 0.0.0.0
groupList3 string
Group list 3. - Default value: 0.0.0.0
groupList4 string
Group list 4. - Default value: 0.0.0.0
prefixList string
Prefix list name.
routeMap string
Route map name.
ssmNone boolean
Exclude standard SSM range (232.0.0.0/8). - Default value: false
vrfName string
VRF name.
device str
A device name from the provider configuration.
group_list1 str
Group list 1. - Default value: 0.0.0.0
group_list2 str
Group list 2. - Default value: 0.0.0.0
group_list3 str
Group list 3. - Default value: 0.0.0.0
group_list4 str
Group list 4. - Default value: 0.0.0.0
prefix_list str
Prefix list name.
route_map str
Route map name.
ssm_none bool
Exclude standard SSM range (232.0.0.0/8). - Default value: false
vrf_name str
VRF name.
device String
A device name from the provider configuration.
groupList1 String
Group list 1. - Default value: 0.0.0.0
groupList2 String
Group list 2. - Default value: 0.0.0.0
groupList3 String
Group list 3. - Default value: 0.0.0.0
groupList4 String
Group list 4. - Default value: 0.0.0.0
prefixList String
Prefix list name.
routeMap String
Route map name.
ssmNone Boolean
Exclude standard SSM range (232.0.0.0/8). - Default value: false
vrfName String
VRF name.

Import

 $ pulumi import nxos:index/pimSsmRange:PimSsmRange example "sys/pim/inst/dom-[default]/ssm/range"
Copy

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.
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos