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

nxos.LoopbackInterface

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 a loopback interface.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = new Nxos.LoopbackInterface("example", new()
    {
        AdminState = "down",
        Description = "My Description",
        InterfaceId = "lo123",
    });

});
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.NewLoopbackInterface(ctx, "example", &nxos.LoopbackInterfaceArgs{
			AdminState:  pulumi.String("down"),
			Description: pulumi.String("My Description"),
			InterfaceId: pulumi.String("lo123"),
		})
		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.LoopbackInterface;
import com.pulumi.nxos.LoopbackInterfaceArgs;
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 LoopbackInterface("example", LoopbackInterfaceArgs.builder()        
            .adminState("down")
            .description("My Description")
            .interfaceId("lo123")
            .build());

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

const example = new nxos.LoopbackInterface("example", {
    adminState: "down",
    description: "My Description",
    interfaceId: "lo123",
});
Copy
import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.LoopbackInterface("example",
    admin_state="down",
    description="My Description",
    interface_id="lo123")
Copy
resources:
  example:
    type: nxos:LoopbackInterface
    properties:
      adminState: down
      description: My Description
      interfaceId: lo123
Copy

Create LoopbackInterface Resource

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

Constructor syntax

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

@overload
def LoopbackInterface(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      interface_id: Optional[str] = None,
                      admin_state: Optional[str] = None,
                      description: Optional[str] = None,
                      device: Optional[str] = None)
func NewLoopbackInterface(ctx *Context, name string, args LoopbackInterfaceArgs, opts ...ResourceOption) (*LoopbackInterface, error)
public LoopbackInterface(string name, LoopbackInterfaceArgs args, CustomResourceOptions? opts = null)
public LoopbackInterface(String name, LoopbackInterfaceArgs args)
public LoopbackInterface(String name, LoopbackInterfaceArgs args, CustomResourceOptions options)

type: nxos:LoopbackInterface
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. LoopbackInterfaceArgs
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. LoopbackInterfaceArgs
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. LoopbackInterfaceArgs
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. LoopbackInterfaceArgs
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. LoopbackInterfaceArgs
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 loopbackInterfaceResource = new Nxos.LoopbackInterface("loopbackInterfaceResource", new()
{
    InterfaceId = "string",
    AdminState = "string",
    Description = "string",
    Device = "string",
});
Copy
example, err := nxos.NewLoopbackInterface(ctx, "loopbackInterfaceResource", &nxos.LoopbackInterfaceArgs{
	InterfaceId: pulumi.String("string"),
	AdminState:  pulumi.String("string"),
	Description: pulumi.String("string"),
	Device:      pulumi.String("string"),
})
Copy
var loopbackInterfaceResource = new LoopbackInterface("loopbackInterfaceResource", LoopbackInterfaceArgs.builder()
    .interfaceId("string")
    .adminState("string")
    .description("string")
    .device("string")
    .build());
Copy
loopback_interface_resource = nxos.LoopbackInterface("loopbackInterfaceResource",
    interface_id="string",
    admin_state="string",
    description="string",
    device="string")
Copy
const loopbackInterfaceResource = new nxos.LoopbackInterface("loopbackInterfaceResource", {
    interfaceId: "string",
    adminState: "string",
    description: "string",
    device: "string",
});
Copy
type: nxos:LoopbackInterface
properties:
    adminState: string
    description: string
    device: string
    interfaceId: string
Copy

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

InterfaceId This property is required. string
Must match first field in the output of show intf brief. Example: lo123.
AdminState string
Administrative state. - Choices: up, down - Default value: up
Description string
Interface description.
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: lo123.
AdminState string
Administrative state. - Choices: up, down - Default value: up
Description string
Interface description.
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: lo123.
adminState String
Administrative state. - Choices: up, down - Default value: up
description String
Interface description.
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: lo123.
adminState string
Administrative state. - Choices: up, down - Default value: up
description string
Interface description.
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: lo123.
admin_state str
Administrative state. - Choices: up, down - Default value: up
description str
Interface description.
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: lo123.
adminState String
Administrative state. - Choices: up, down - Default value: up
description String
Interface description.
device String
A device name from the provider configuration.

Outputs

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

Get an existing LoopbackInterface 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?: LoopbackInterfaceState, opts?: CustomResourceOptions): LoopbackInterface
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_state: Optional[str] = None,
        description: Optional[str] = None,
        device: Optional[str] = None,
        interface_id: Optional[str] = None) -> LoopbackInterface
func GetLoopbackInterface(ctx *Context, name string, id IDInput, state *LoopbackInterfaceState, opts ...ResourceOption) (*LoopbackInterface, error)
public static LoopbackInterface Get(string name, Input<string> id, LoopbackInterfaceState? state, CustomResourceOptions? opts = null)
public static LoopbackInterface get(String name, Output<String> id, LoopbackInterfaceState state, CustomResourceOptions options)
resources:  _:    type: nxos:LoopbackInterface    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: up, down - Default value: up
Description string
Interface description.
Device string
A device name from the provider configuration.
InterfaceId string
Must match first field in the output of show intf brief. Example: lo123.
AdminState string
Administrative state. - Choices: up, down - Default value: up
Description string
Interface description.
Device string
A device name from the provider configuration.
InterfaceId string
Must match first field in the output of show intf brief. Example: lo123.
adminState String
Administrative state. - Choices: up, down - Default value: up
description String
Interface description.
device String
A device name from the provider configuration.
interfaceId String
Must match first field in the output of show intf brief. Example: lo123.
adminState string
Administrative state. - Choices: up, down - Default value: up
description string
Interface description.
device string
A device name from the provider configuration.
interfaceId string
Must match first field in the output of show intf brief. Example: lo123.
admin_state str
Administrative state. - Choices: up, down - Default value: up
description str
Interface description.
device str
A device name from the provider configuration.
interface_id str
Must match first field in the output of show intf brief. Example: lo123.
adminState String
Administrative state. - Choices: up, down - Default value: up
description String
Interface description.
device String
A device name from the provider configuration.
interfaceId String
Must match first field in the output of show intf brief. Example: lo123.

Import

 $ pulumi import nxos:index/loopbackInterface:LoopbackInterface example "sys/intf/lb-[lo123]"
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