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

nxos.Ipv4Vrf

Explore with Pulumi AI

This resource can manage the IPv4 VRF information.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = new Nxos.Ipv4Vrf("example");

});
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.NewIpv4Vrf(ctx, "example", nil)
		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.Ipv4Vrf;
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 Ipv4Vrf("example");

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

const example = new nxos.Ipv4Vrf("example", {});
Copy
import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.Ipv4Vrf("example")
Copy
resources:
  example:
    type: nxos:Ipv4Vrf
Copy

Create Ipv4Vrf Resource

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

Constructor syntax

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

@overload
def Ipv4Vrf(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            device: Optional[str] = None,
            name: Optional[str] = None)
func NewIpv4Vrf(ctx *Context, name string, args *Ipv4VrfArgs, opts ...ResourceOption) (*Ipv4Vrf, error)
public Ipv4Vrf(string name, Ipv4VrfArgs? args = null, CustomResourceOptions? opts = null)
public Ipv4Vrf(String name, Ipv4VrfArgs args)
public Ipv4Vrf(String name, Ipv4VrfArgs args, CustomResourceOptions options)
type: nxos:Ipv4Vrf
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 Ipv4VrfArgs
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 Ipv4VrfArgs
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 Ipv4VrfArgs
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 Ipv4VrfArgs
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. Ipv4VrfArgs
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 ipv4VrfResource = new Nxos.Ipv4Vrf("ipv4VrfResource", new()
{
    Device = "string",
    Name = "string",
});
Copy
example, err := nxos.NewIpv4Vrf(ctx, "ipv4VrfResource", &nxos.Ipv4VrfArgs{
	Device: pulumi.String("string"),
	Name:   pulumi.String("string"),
})
Copy
var ipv4VrfResource = new Ipv4Vrf("ipv4VrfResource", Ipv4VrfArgs.builder()
    .device("string")
    .name("string")
    .build());
Copy
ipv4_vrf_resource = nxos.Ipv4Vrf("ipv4VrfResource",
    device="string",
    name="string")
Copy
const ipv4VrfResource = new nxos.Ipv4Vrf("ipv4VrfResource", {
    device: "string",
    name: "string",
});
Copy
type: nxos:Ipv4Vrf
properties:
    device: string
    name: string
Copy

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

Device string
A device name from the provider configuration.
Name string
VRF name.
Device string
A device name from the provider configuration.
Name string
VRF name.
device String
A device name from the provider configuration.
name String
VRF name.
device string
A device name from the provider configuration.
name string
VRF name.
device str
A device name from the provider configuration.
name str
VRF name.
device String
A device name from the provider configuration.
name String
VRF name.

Outputs

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

Get an existing Ipv4Vrf 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?: Ipv4VrfState, opts?: CustomResourceOptions): Ipv4Vrf
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        device: Optional[str] = None,
        name: Optional[str] = None) -> Ipv4Vrf
func GetIpv4Vrf(ctx *Context, name string, id IDInput, state *Ipv4VrfState, opts ...ResourceOption) (*Ipv4Vrf, error)
public static Ipv4Vrf Get(string name, Input<string> id, Ipv4VrfState? state, CustomResourceOptions? opts = null)
public static Ipv4Vrf get(String name, Output<String> id, Ipv4VrfState state, CustomResourceOptions options)
resources:  _:    type: nxos:Ipv4Vrf    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.
Name string
VRF name.
Device string
A device name from the provider configuration.
Name string
VRF name.
device String
A device name from the provider configuration.
name String
VRF name.
device string
A device name from the provider configuration.
name string
VRF name.
device str
A device name from the provider configuration.
name str
VRF name.
device String
A device name from the provider configuration.
name String
VRF name.

Import

 $ pulumi import nxos:index/ipv4Vrf:Ipv4Vrf example "sys/ipv4/inst/dom-[VRF1]"
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.