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

nxos.PortChannelInterfaceVrf

Explore with Pulumi AI

This resource can manage a port-channel interface VRF association.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = new Nxos.PortChannelInterfaceVrf("example", new()
    {
        InterfaceId = "po1",
        VrfDn = "sys/inst-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.NewPortChannelInterfaceVrf(ctx, "example", &nxos.PortChannelInterfaceVrfArgs{
			InterfaceId: pulumi.String("po1"),
			VrfDn:       pulumi.String("sys/inst-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.PortChannelInterfaceVrf;
import com.pulumi.nxos.PortChannelInterfaceVrfArgs;
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 PortChannelInterfaceVrf("example", PortChannelInterfaceVrfArgs.builder()        
            .interfaceId("po1")
            .vrfDn("sys/inst-default")
            .build());

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

const example = new nxos.PortChannelInterfaceVrf("example", {
    interfaceId: "po1",
    vrfDn: "sys/inst-default",
});
Copy
import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.PortChannelInterfaceVrf("example",
    interface_id="po1",
    vrf_dn="sys/inst-default")
Copy
resources:
  example:
    type: nxos:PortChannelInterfaceVrf
    properties:
      interfaceId: po1
      vrfDn: sys/inst-default
Copy

Create PortChannelInterfaceVrf Resource

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

Constructor syntax

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

@overload
def PortChannelInterfaceVrf(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            interface_id: Optional[str] = None,
                            vrf_dn: Optional[str] = None,
                            device: Optional[str] = None)
func NewPortChannelInterfaceVrf(ctx *Context, name string, args PortChannelInterfaceVrfArgs, opts ...ResourceOption) (*PortChannelInterfaceVrf, error)
public PortChannelInterfaceVrf(string name, PortChannelInterfaceVrfArgs args, CustomResourceOptions? opts = null)
public PortChannelInterfaceVrf(String name, PortChannelInterfaceVrfArgs args)
public PortChannelInterfaceVrf(String name, PortChannelInterfaceVrfArgs args, CustomResourceOptions options)
type: nxos:PortChannelInterfaceVrf
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. PortChannelInterfaceVrfArgs
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. PortChannelInterfaceVrfArgs
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. PortChannelInterfaceVrfArgs
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. PortChannelInterfaceVrfArgs
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. PortChannelInterfaceVrfArgs
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 portChannelInterfaceVrfResource = new Nxos.PortChannelInterfaceVrf("portChannelInterfaceVrfResource", new()
{
    InterfaceId = "string",
    VrfDn = "string",
    Device = "string",
});
Copy
example, err := nxos.NewPortChannelInterfaceVrf(ctx, "portChannelInterfaceVrfResource", &nxos.PortChannelInterfaceVrfArgs{
	InterfaceId: pulumi.String("string"),
	VrfDn:       pulumi.String("string"),
	Device:      pulumi.String("string"),
})
Copy
var portChannelInterfaceVrfResource = new PortChannelInterfaceVrf("portChannelInterfaceVrfResource", PortChannelInterfaceVrfArgs.builder()
    .interfaceId("string")
    .vrfDn("string")
    .device("string")
    .build());
Copy
port_channel_interface_vrf_resource = nxos.PortChannelInterfaceVrf("portChannelInterfaceVrfResource",
    interface_id="string",
    vrf_dn="string",
    device="string")
Copy
const portChannelInterfaceVrfResource = new nxos.PortChannelInterfaceVrf("portChannelInterfaceVrfResource", {
    interfaceId: "string",
    vrfDn: "string",
    device: "string",
});
Copy
type: nxos:PortChannelInterfaceVrf
properties:
    device: string
    interfaceId: string
    vrfDn: string
Copy

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

InterfaceId This property is required. string
Must match first field in the output of show intf brief. Example: po1.
VrfDn This property is required. string
DN of VRF. For example: sys/inst-VRF1.
Device string
A device name from the provider configuration.
InterfaceId This property is required. string
Must match first field in the output of show intf brief. Example: po1.
VrfDn This property is required. string
DN of VRF. For example: sys/inst-VRF1.
Device string
A device name from the provider configuration.
interfaceId This property is required. String
Must match first field in the output of show intf brief. Example: po1.
vrfDn This property is required. String
DN of VRF. For example: sys/inst-VRF1.
device String
A device name from the provider configuration.
interfaceId This property is required. string
Must match first field in the output of show intf brief. Example: po1.
vrfDn This property is required. string
DN of VRF. For example: sys/inst-VRF1.
device string
A device name from the provider configuration.
interface_id This property is required. str
Must match first field in the output of show intf brief. Example: po1.
vrf_dn This property is required. str
DN of VRF. For example: sys/inst-VRF1.
device str
A device name from the provider configuration.
interfaceId This property is required. String
Must match first field in the output of show intf brief. Example: po1.
vrfDn This property is required. String
DN of VRF. For example: sys/inst-VRF1.
device String
A device name from the provider configuration.

Outputs

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

Get an existing PortChannelInterfaceVrf 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?: PortChannelInterfaceVrfState, opts?: CustomResourceOptions): PortChannelInterfaceVrf
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        device: Optional[str] = None,
        interface_id: Optional[str] = None,
        vrf_dn: Optional[str] = None) -> PortChannelInterfaceVrf
func GetPortChannelInterfaceVrf(ctx *Context, name string, id IDInput, state *PortChannelInterfaceVrfState, opts ...ResourceOption) (*PortChannelInterfaceVrf, error)
public static PortChannelInterfaceVrf Get(string name, Input<string> id, PortChannelInterfaceVrfState? state, CustomResourceOptions? opts = null)
public static PortChannelInterfaceVrf get(String name, Output<String> id, PortChannelInterfaceVrfState state, CustomResourceOptions options)
resources:  _:    type: nxos:PortChannelInterfaceVrf    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.
InterfaceId string
Must match first field in the output of show intf brief. Example: po1.
VrfDn string
DN of VRF. For example: sys/inst-VRF1.
Device string
A device name from the provider configuration.
InterfaceId string
Must match first field in the output of show intf brief. Example: po1.
VrfDn string
DN of VRF. For example: sys/inst-VRF1.
device String
A device name from the provider configuration.
interfaceId String
Must match first field in the output of show intf brief. Example: po1.
vrfDn String
DN of VRF. For example: sys/inst-VRF1.
device string
A device name from the provider configuration.
interfaceId string
Must match first field in the output of show intf brief. Example: po1.
vrfDn string
DN of VRF. For example: sys/inst-VRF1.
device str
A device name from the provider configuration.
interface_id str
Must match first field in the output of show intf brief. Example: po1.
vrf_dn str
DN of VRF. For example: sys/inst-VRF1.
device String
A device name from the provider configuration.
interfaceId String
Must match first field in the output of show intf brief. Example: po1.
vrfDn String
DN of VRF. For example: sys/inst-VRF1.

Import

 $ pulumi import nxos:index/portChannelInterfaceVrf:PortChannelInterfaceVrf example "sys/intf/aggr-[po1]/rtvrfMbr"
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.