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

nxos.PimInterface

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 interface 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.PimInterface("example", new()
    {
        AdminState = "enabled",
        Bfd = "enabled",
        DrPriority = 10,
        InterfaceId = "eth1/10",
        Passive = false,
        SparseMode = true,
        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.NewPimInterface(ctx, "example", &nxos.PimInterfaceArgs{
			AdminState:  pulumi.String("enabled"),
			Bfd:         pulumi.String("enabled"),
			DrPriority:  pulumi.Int(10),
			InterfaceId: pulumi.String("eth1/10"),
			Passive:     pulumi.Bool(false),
			SparseMode:  pulumi.Bool(true),
			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.PimInterface;
import com.pulumi.nxos.PimInterfaceArgs;
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 PimInterface("example", PimInterfaceArgs.builder()        
            .adminState("enabled")
            .bfd("enabled")
            .drPriority(10)
            .interfaceId("eth1/10")
            .passive(false)
            .sparseMode(true)
            .vrfName("default")
            .build());

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

const example = new nxos.PimInterface("example", {
    adminState: "enabled",
    bfd: "enabled",
    drPriority: 10,
    interfaceId: "eth1/10",
    passive: false,
    sparseMode: true,
    vrfName: "default",
});
Copy
import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.PimInterface("example",
    admin_state="enabled",
    bfd="enabled",
    dr_priority=10,
    interface_id="eth1/10",
    passive=False,
    sparse_mode=True,
    vrf_name="default")
Copy
resources:
  example:
    type: nxos:PimInterface
    properties:
      adminState: enabled
      bfd: enabled
      drPriority: 10
      interfaceId: eth1/10
      passive: false
      sparseMode: true
      vrfName: default
Copy

Create PimInterface Resource

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

Constructor syntax

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

@overload
def PimInterface(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 interface_id: Optional[str] = None,
                 vrf_name: Optional[str] = None,
                 admin_state: Optional[str] = None,
                 bfd: Optional[str] = None,
                 device: Optional[str] = None,
                 dr_priority: Optional[int] = None,
                 passive: Optional[bool] = None,
                 sparse_mode: Optional[bool] = None)
func NewPimInterface(ctx *Context, name string, args PimInterfaceArgs, opts ...ResourceOption) (*PimInterface, error)
public PimInterface(string name, PimInterfaceArgs args, CustomResourceOptions? opts = null)
public PimInterface(String name, PimInterfaceArgs args)
public PimInterface(String name, PimInterfaceArgs args, CustomResourceOptions options)

type: nxos:PimInterface
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. PimInterfaceArgs
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. PimInterfaceArgs
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. PimInterfaceArgs
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. PimInterfaceArgs
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. PimInterfaceArgs
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 pimInterfaceResource = new Nxos.PimInterface("pimInterfaceResource", new()
{
    InterfaceId = "string",
    VrfName = "string",
    AdminState = "string",
    Bfd = "string",
    Device = "string",
    DrPriority = 0,
    Passive = false,
    SparseMode = false,
});
Copy
example, err := nxos.NewPimInterface(ctx, "pimInterfaceResource", &nxos.PimInterfaceArgs{
	InterfaceId: pulumi.String("string"),
	VrfName:     pulumi.String("string"),
	AdminState:  pulumi.String("string"),
	Bfd:         pulumi.String("string"),
	Device:      pulumi.String("string"),
	DrPriority:  pulumi.Int(0),
	Passive:     pulumi.Bool(false),
	SparseMode:  pulumi.Bool(false),
})
Copy
var pimInterfaceResource = new PimInterface("pimInterfaceResource", PimInterfaceArgs.builder()
    .interfaceId("string")
    .vrfName("string")
    .adminState("string")
    .bfd("string")
    .device("string")
    .drPriority(0)
    .passive(false)
    .sparseMode(false)
    .build());
Copy
pim_interface_resource = nxos.PimInterface("pimInterfaceResource",
    interface_id="string",
    vrf_name="string",
    admin_state="string",
    bfd="string",
    device="string",
    dr_priority=0,
    passive=False,
    sparse_mode=False)
Copy
const pimInterfaceResource = new nxos.PimInterface("pimInterfaceResource", {
    interfaceId: "string",
    vrfName: "string",
    adminState: "string",
    bfd: "string",
    device: "string",
    drPriority: 0,
    passive: false,
    sparseMode: false,
});
Copy
type: nxos:PimInterface
properties:
    adminState: string
    bfd: string
    device: string
    drPriority: 0
    interfaceId: string
    passive: false
    sparseMode: false
    vrfName: string
Copy

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

InterfaceId This property is required. string
Must match first field in the output of show intf brief. Example: eth1/1.
VrfName This property is required. string
VRF name.
AdminState string
Administrative state. - Choices: enabled, disabled - Default value: enabled
Bfd string
BFD. - Choices: none, enabled, disabled - Default value: none
Device string
A device name from the provider configuration.
DrPriority int
Designated Router priority level. - Range: 1-4294967295 - Default value: 1
Passive bool
Passive interface. - Default value: false
SparseMode bool
Sparse mode. - Default value: false
InterfaceId This property is required. string
Must match first field in the output of show intf brief. Example: eth1/1.
VrfName This property is required. string
VRF name.
AdminState string
Administrative state. - Choices: enabled, disabled - Default value: enabled
Bfd string
BFD. - Choices: none, enabled, disabled - Default value: none
Device string
A device name from the provider configuration.
DrPriority int
Designated Router priority level. - Range: 1-4294967295 - Default value: 1
Passive bool
Passive interface. - Default value: false
SparseMode bool
Sparse mode. - Default value: false
interfaceId This property is required. String
Must match first field in the output of show intf brief. Example: eth1/1.
vrfName This property is required. String
VRF name.
adminState String
Administrative state. - Choices: enabled, disabled - Default value: enabled
bfd String
BFD. - Choices: none, enabled, disabled - Default value: none
device String
A device name from the provider configuration.
drPriority Integer
Designated Router priority level. - Range: 1-4294967295 - Default value: 1
passive Boolean
Passive interface. - Default value: false
sparseMode Boolean
Sparse mode. - Default value: false
interfaceId This property is required. string
Must match first field in the output of show intf brief. Example: eth1/1.
vrfName This property is required. string
VRF name.
adminState string
Administrative state. - Choices: enabled, disabled - Default value: enabled
bfd string
BFD. - Choices: none, enabled, disabled - Default value: none
device string
A device name from the provider configuration.
drPriority number
Designated Router priority level. - Range: 1-4294967295 - Default value: 1
passive boolean
Passive interface. - Default value: false
sparseMode boolean
Sparse mode. - Default value: false
interface_id This property is required. str
Must match first field in the output of show intf brief. Example: eth1/1.
vrf_name This property is required. str
VRF name.
admin_state str
Administrative state. - Choices: enabled, disabled - Default value: enabled
bfd str
BFD. - Choices: none, enabled, disabled - Default value: none
device str
A device name from the provider configuration.
dr_priority int
Designated Router priority level. - Range: 1-4294967295 - Default value: 1
passive bool
Passive interface. - Default value: false
sparse_mode bool
Sparse mode. - Default value: false
interfaceId This property is required. String
Must match first field in the output of show intf brief. Example: eth1/1.
vrfName This property is required. String
VRF name.
adminState String
Administrative state. - Choices: enabled, disabled - Default value: enabled
bfd String
BFD. - Choices: none, enabled, disabled - Default value: none
device String
A device name from the provider configuration.
drPriority Number
Designated Router priority level. - Range: 1-4294967295 - Default value: 1
passive Boolean
Passive interface. - Default value: false
sparseMode Boolean
Sparse mode. - Default value: false

Outputs

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

Get an existing PimInterface 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?: PimInterfaceState, opts?: CustomResourceOptions): PimInterface
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_state: Optional[str] = None,
        bfd: Optional[str] = None,
        device: Optional[str] = None,
        dr_priority: Optional[int] = None,
        interface_id: Optional[str] = None,
        passive: Optional[bool] = None,
        sparse_mode: Optional[bool] = None,
        vrf_name: Optional[str] = None) -> PimInterface
func GetPimInterface(ctx *Context, name string, id IDInput, state *PimInterfaceState, opts ...ResourceOption) (*PimInterface, error)
public static PimInterface Get(string name, Input<string> id, PimInterfaceState? state, CustomResourceOptions? opts = null)
public static PimInterface get(String name, Output<String> id, PimInterfaceState state, CustomResourceOptions options)
resources:  _:    type: nxos:PimInterface    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:
AdminState string
Administrative state. - Choices: enabled, disabled - Default value: enabled
Bfd string
BFD. - Choices: none, enabled, disabled - Default value: none
Device string
A device name from the provider configuration.
DrPriority int
Designated Router priority level. - Range: 1-4294967295 - Default value: 1
InterfaceId string
Must match first field in the output of show intf brief. Example: eth1/1.
Passive bool
Passive interface. - Default value: false
SparseMode bool
Sparse mode. - Default value: false
VrfName string
VRF name.
AdminState string
Administrative state. - Choices: enabled, disabled - Default value: enabled
Bfd string
BFD. - Choices: none, enabled, disabled - Default value: none
Device string
A device name from the provider configuration.
DrPriority int
Designated Router priority level. - Range: 1-4294967295 - Default value: 1
InterfaceId string
Must match first field in the output of show intf brief. Example: eth1/1.
Passive bool
Passive interface. - Default value: false
SparseMode bool
Sparse mode. - Default value: false
VrfName string
VRF name.
adminState String
Administrative state. - Choices: enabled, disabled - Default value: enabled
bfd String
BFD. - Choices: none, enabled, disabled - Default value: none
device String
A device name from the provider configuration.
drPriority Integer
Designated Router priority level. - Range: 1-4294967295 - Default value: 1
interfaceId String
Must match first field in the output of show intf brief. Example: eth1/1.
passive Boolean
Passive interface. - Default value: false
sparseMode Boolean
Sparse mode. - Default value: false
vrfName String
VRF name.
adminState string
Administrative state. - Choices: enabled, disabled - Default value: enabled
bfd string
BFD. - Choices: none, enabled, disabled - Default value: none
device string
A device name from the provider configuration.
drPriority number
Designated Router priority level. - Range: 1-4294967295 - Default value: 1
interfaceId string
Must match first field in the output of show intf brief. Example: eth1/1.
passive boolean
Passive interface. - Default value: false
sparseMode boolean
Sparse mode. - Default value: false
vrfName string
VRF name.
admin_state str
Administrative state. - Choices: enabled, disabled - Default value: enabled
bfd str
BFD. - Choices: none, enabled, disabled - Default value: none
device str
A device name from the provider configuration.
dr_priority int
Designated Router priority level. - Range: 1-4294967295 - Default value: 1
interface_id str
Must match first field in the output of show intf brief. Example: eth1/1.
passive bool
Passive interface. - Default value: false
sparse_mode bool
Sparse mode. - Default value: false
vrf_name str
VRF name.
adminState String
Administrative state. - Choices: enabled, disabled - Default value: enabled
bfd String
BFD. - Choices: none, enabled, disabled - Default value: none
device String
A device name from the provider configuration.
drPriority Number
Designated Router priority level. - Range: 1-4294967295 - Default value: 1
interfaceId String
Must match first field in the output of show intf brief. Example: eth1/1.
passive Boolean
Passive interface. - Default value: false
sparseMode Boolean
Sparse mode. - Default value: false
vrfName String
VRF name.

Import

 $ pulumi import nxos:index/pimInterface:PimInterface example "sys/pim/inst/dom-[default]/if-[eth1/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