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

nxos.Ipv4PrefixListRuleEntry

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 an IPv4 Prefix List entry 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.Ipv4PrefixListRuleEntry("example", new()
    {
        Action = "permit",
        Criteria = "inexact",
        FromRange = 26,
        Order = 10,
        Prefix = "192.168.1.0/24",
        RuleName = "RULE1",
        ToRange = 32,
    });

});
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.NewIpv4PrefixListRuleEntry(ctx, "example", &nxos.Ipv4PrefixListRuleEntryArgs{
			Action:    pulumi.String("permit"),
			Criteria:  pulumi.String("inexact"),
			FromRange: pulumi.Int(26),
			Order:     pulumi.Int(10),
			Prefix:    pulumi.String("192.168.1.0/24"),
			RuleName:  pulumi.String("RULE1"),
			ToRange:   pulumi.Int(32),
		})
		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.Ipv4PrefixListRuleEntry;
import com.pulumi.nxos.Ipv4PrefixListRuleEntryArgs;
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 Ipv4PrefixListRuleEntry("example", Ipv4PrefixListRuleEntryArgs.builder()        
            .action("permit")
            .criteria("inexact")
            .fromRange(26)
            .order(10)
            .prefix("192.168.1.0/24")
            .ruleName("RULE1")
            .toRange(32)
            .build());

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

const example = new nxos.Ipv4PrefixListRuleEntry("example", {
    action: "permit",
    criteria: "inexact",
    fromRange: 26,
    order: 10,
    prefix: "192.168.1.0/24",
    ruleName: "RULE1",
    toRange: 32,
});
Copy
import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.Ipv4PrefixListRuleEntry("example",
    action="permit",
    criteria="inexact",
    from_range=26,
    order=10,
    prefix="192.168.1.0/24",
    rule_name="RULE1",
    to_range=32)
Copy
resources:
  example:
    type: nxos:Ipv4PrefixListRuleEntry
    properties:
      action: permit
      criteria: inexact
      fromRange: 26
      order: 10
      prefix: 192.168.1.0/24
      ruleName: RULE1
      toRange: 32
Copy

Create Ipv4PrefixListRuleEntry Resource

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

Constructor syntax

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

@overload
def Ipv4PrefixListRuleEntry(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            order: Optional[int] = None,
                            rule_name: Optional[str] = None,
                            action: Optional[str] = None,
                            criteria: Optional[str] = None,
                            device: Optional[str] = None,
                            from_range: Optional[int] = None,
                            prefix: Optional[str] = None,
                            to_range: Optional[int] = None)
func NewIpv4PrefixListRuleEntry(ctx *Context, name string, args Ipv4PrefixListRuleEntryArgs, opts ...ResourceOption) (*Ipv4PrefixListRuleEntry, error)
public Ipv4PrefixListRuleEntry(string name, Ipv4PrefixListRuleEntryArgs args, CustomResourceOptions? opts = null)
public Ipv4PrefixListRuleEntry(String name, Ipv4PrefixListRuleEntryArgs args)
public Ipv4PrefixListRuleEntry(String name, Ipv4PrefixListRuleEntryArgs args, CustomResourceOptions options)

type: nxos:Ipv4PrefixListRuleEntry
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. Ipv4PrefixListRuleEntryArgs
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. Ipv4PrefixListRuleEntryArgs
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. Ipv4PrefixListRuleEntryArgs
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. Ipv4PrefixListRuleEntryArgs
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. Ipv4PrefixListRuleEntryArgs
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 ipv4PrefixListRuleEntryResource = new Nxos.Ipv4PrefixListRuleEntry("ipv4PrefixListRuleEntryResource", new()
{
    Order = 0,
    RuleName = "string",
    Action = "string",
    Criteria = "string",
    Device = "string",
    FromRange = 0,
    Prefix = "string",
    ToRange = 0,
});
Copy
example, err := nxos.NewIpv4PrefixListRuleEntry(ctx, "ipv4PrefixListRuleEntryResource", &nxos.Ipv4PrefixListRuleEntryArgs{
	Order:     pulumi.Int(0),
	RuleName:  pulumi.String("string"),
	Action:    pulumi.String("string"),
	Criteria:  pulumi.String("string"),
	Device:    pulumi.String("string"),
	FromRange: pulumi.Int(0),
	Prefix:    pulumi.String("string"),
	ToRange:   pulumi.Int(0),
})
Copy
var ipv4PrefixListRuleEntryResource = new Ipv4PrefixListRuleEntry("ipv4PrefixListRuleEntryResource", Ipv4PrefixListRuleEntryArgs.builder()
    .order(0)
    .ruleName("string")
    .action("string")
    .criteria("string")
    .device("string")
    .fromRange(0)
    .prefix("string")
    .toRange(0)
    .build());
Copy
ipv4_prefix_list_rule_entry_resource = nxos.Ipv4PrefixListRuleEntry("ipv4PrefixListRuleEntryResource",
    order=0,
    rule_name="string",
    action="string",
    criteria="string",
    device="string",
    from_range=0,
    prefix="string",
    to_range=0)
Copy
const ipv4PrefixListRuleEntryResource = new nxos.Ipv4PrefixListRuleEntry("ipv4PrefixListRuleEntryResource", {
    order: 0,
    ruleName: "string",
    action: "string",
    criteria: "string",
    device: "string",
    fromRange: 0,
    prefix: "string",
    toRange: 0,
});
Copy
type: nxos:Ipv4PrefixListRuleEntry
properties:
    action: string
    criteria: string
    device: string
    fromRange: 0
    order: 0
    prefix: string
    ruleName: string
    toRange: 0
Copy

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

Order This property is required. int
IPv4 Prefix List Rule Entry order. - Range: 0-4294967294
RuleName This property is required. string
IPv4 Prefix List Rule name.
Action string
IPv4 Prefix List Rule Entry action. - Choices: deny, permit - Default value: permit
Criteria string
IPv4 Prefix List Rule Entry criteria. - Choices: exact, inexact - Default value: exact
Device string
A device name from the provider configuration.
FromRange int
IPv4 Prefix List Rule Entry start range. - Range: 0-128 - Default value: 0
Prefix string
IPv4 Prefix List Rule Entry prefix.
ToRange int
IPv4 Prefix List Rule Entry end range. - Range: 0-128 - Default value: 0
Order This property is required. int
IPv4 Prefix List Rule Entry order. - Range: 0-4294967294
RuleName This property is required. string
IPv4 Prefix List Rule name.
Action string
IPv4 Prefix List Rule Entry action. - Choices: deny, permit - Default value: permit
Criteria string
IPv4 Prefix List Rule Entry criteria. - Choices: exact, inexact - Default value: exact
Device string
A device name from the provider configuration.
FromRange int
IPv4 Prefix List Rule Entry start range. - Range: 0-128 - Default value: 0
Prefix string
IPv4 Prefix List Rule Entry prefix.
ToRange int
IPv4 Prefix List Rule Entry end range. - Range: 0-128 - Default value: 0
order This property is required. Integer
IPv4 Prefix List Rule Entry order. - Range: 0-4294967294
ruleName This property is required. String
IPv4 Prefix List Rule name.
action String
IPv4 Prefix List Rule Entry action. - Choices: deny, permit - Default value: permit
criteria String
IPv4 Prefix List Rule Entry criteria. - Choices: exact, inexact - Default value: exact
device String
A device name from the provider configuration.
fromRange Integer
IPv4 Prefix List Rule Entry start range. - Range: 0-128 - Default value: 0
prefix String
IPv4 Prefix List Rule Entry prefix.
toRange Integer
IPv4 Prefix List Rule Entry end range. - Range: 0-128 - Default value: 0
order This property is required. number
IPv4 Prefix List Rule Entry order. - Range: 0-4294967294
ruleName This property is required. string
IPv4 Prefix List Rule name.
action string
IPv4 Prefix List Rule Entry action. - Choices: deny, permit - Default value: permit
criteria string
IPv4 Prefix List Rule Entry criteria. - Choices: exact, inexact - Default value: exact
device string
A device name from the provider configuration.
fromRange number
IPv4 Prefix List Rule Entry start range. - Range: 0-128 - Default value: 0
prefix string
IPv4 Prefix List Rule Entry prefix.
toRange number
IPv4 Prefix List Rule Entry end range. - Range: 0-128 - Default value: 0
order This property is required. int
IPv4 Prefix List Rule Entry order. - Range: 0-4294967294
rule_name This property is required. str
IPv4 Prefix List Rule name.
action str
IPv4 Prefix List Rule Entry action. - Choices: deny, permit - Default value: permit
criteria str
IPv4 Prefix List Rule Entry criteria. - Choices: exact, inexact - Default value: exact
device str
A device name from the provider configuration.
from_range int
IPv4 Prefix List Rule Entry start range. - Range: 0-128 - Default value: 0
prefix str
IPv4 Prefix List Rule Entry prefix.
to_range int
IPv4 Prefix List Rule Entry end range. - Range: 0-128 - Default value: 0
order This property is required. Number
IPv4 Prefix List Rule Entry order. - Range: 0-4294967294
ruleName This property is required. String
IPv4 Prefix List Rule name.
action String
IPv4 Prefix List Rule Entry action. - Choices: deny, permit - Default value: permit
criteria String
IPv4 Prefix List Rule Entry criteria. - Choices: exact, inexact - Default value: exact
device String
A device name from the provider configuration.
fromRange Number
IPv4 Prefix List Rule Entry start range. - Range: 0-128 - Default value: 0
prefix String
IPv4 Prefix List Rule Entry prefix.
toRange Number
IPv4 Prefix List Rule Entry end range. - Range: 0-128 - Default value: 0

Outputs

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

Get an existing Ipv4PrefixListRuleEntry 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?: Ipv4PrefixListRuleEntryState, opts?: CustomResourceOptions): Ipv4PrefixListRuleEntry
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        criteria: Optional[str] = None,
        device: Optional[str] = None,
        from_range: Optional[int] = None,
        order: Optional[int] = None,
        prefix: Optional[str] = None,
        rule_name: Optional[str] = None,
        to_range: Optional[int] = None) -> Ipv4PrefixListRuleEntry
func GetIpv4PrefixListRuleEntry(ctx *Context, name string, id IDInput, state *Ipv4PrefixListRuleEntryState, opts ...ResourceOption) (*Ipv4PrefixListRuleEntry, error)
public static Ipv4PrefixListRuleEntry Get(string name, Input<string> id, Ipv4PrefixListRuleEntryState? state, CustomResourceOptions? opts = null)
public static Ipv4PrefixListRuleEntry get(String name, Output<String> id, Ipv4PrefixListRuleEntryState state, CustomResourceOptions options)
resources:  _:    type: nxos:Ipv4PrefixListRuleEntry    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:
Action string
IPv4 Prefix List Rule Entry action. - Choices: deny, permit - Default value: permit
Criteria string
IPv4 Prefix List Rule Entry criteria. - Choices: exact, inexact - Default value: exact
Device string
A device name from the provider configuration.
FromRange int
IPv4 Prefix List Rule Entry start range. - Range: 0-128 - Default value: 0
Order int
IPv4 Prefix List Rule Entry order. - Range: 0-4294967294
Prefix string
IPv4 Prefix List Rule Entry prefix.
RuleName string
IPv4 Prefix List Rule name.
ToRange int
IPv4 Prefix List Rule Entry end range. - Range: 0-128 - Default value: 0
Action string
IPv4 Prefix List Rule Entry action. - Choices: deny, permit - Default value: permit
Criteria string
IPv4 Prefix List Rule Entry criteria. - Choices: exact, inexact - Default value: exact
Device string
A device name from the provider configuration.
FromRange int
IPv4 Prefix List Rule Entry start range. - Range: 0-128 - Default value: 0
Order int
IPv4 Prefix List Rule Entry order. - Range: 0-4294967294
Prefix string
IPv4 Prefix List Rule Entry prefix.
RuleName string
IPv4 Prefix List Rule name.
ToRange int
IPv4 Prefix List Rule Entry end range. - Range: 0-128 - Default value: 0
action String
IPv4 Prefix List Rule Entry action. - Choices: deny, permit - Default value: permit
criteria String
IPv4 Prefix List Rule Entry criteria. - Choices: exact, inexact - Default value: exact
device String
A device name from the provider configuration.
fromRange Integer
IPv4 Prefix List Rule Entry start range. - Range: 0-128 - Default value: 0
order Integer
IPv4 Prefix List Rule Entry order. - Range: 0-4294967294
prefix String
IPv4 Prefix List Rule Entry prefix.
ruleName String
IPv4 Prefix List Rule name.
toRange Integer
IPv4 Prefix List Rule Entry end range. - Range: 0-128 - Default value: 0
action string
IPv4 Prefix List Rule Entry action. - Choices: deny, permit - Default value: permit
criteria string
IPv4 Prefix List Rule Entry criteria. - Choices: exact, inexact - Default value: exact
device string
A device name from the provider configuration.
fromRange number
IPv4 Prefix List Rule Entry start range. - Range: 0-128 - Default value: 0
order number
IPv4 Prefix List Rule Entry order. - Range: 0-4294967294
prefix string
IPv4 Prefix List Rule Entry prefix.
ruleName string
IPv4 Prefix List Rule name.
toRange number
IPv4 Prefix List Rule Entry end range. - Range: 0-128 - Default value: 0
action str
IPv4 Prefix List Rule Entry action. - Choices: deny, permit - Default value: permit
criteria str
IPv4 Prefix List Rule Entry criteria. - Choices: exact, inexact - Default value: exact
device str
A device name from the provider configuration.
from_range int
IPv4 Prefix List Rule Entry start range. - Range: 0-128 - Default value: 0
order int
IPv4 Prefix List Rule Entry order. - Range: 0-4294967294
prefix str
IPv4 Prefix List Rule Entry prefix.
rule_name str
IPv4 Prefix List Rule name.
to_range int
IPv4 Prefix List Rule Entry end range. - Range: 0-128 - Default value: 0
action String
IPv4 Prefix List Rule Entry action. - Choices: deny, permit - Default value: permit
criteria String
IPv4 Prefix List Rule Entry criteria. - Choices: exact, inexact - Default value: exact
device String
A device name from the provider configuration.
fromRange Number
IPv4 Prefix List Rule Entry start range. - Range: 0-128 - Default value: 0
order Number
IPv4 Prefix List Rule Entry order. - Range: 0-4294967294
prefix String
IPv4 Prefix List Rule Entry prefix.
ruleName String
IPv4 Prefix List Rule name.
toRange Number
IPv4 Prefix List Rule Entry end range. - Range: 0-128 - Default value: 0

Import

 $ pulumi import nxos:index/ipv4PrefixListRuleEntry:Ipv4PrefixListRuleEntry example "sys/rpm/pfxlistv4-[RULE1]/ent-[10]"
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