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

nxos.SviInterface

Explore with Pulumi AI

This resource can manage an SVI 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.SviInterface("example", new()
    {
        AdminState = "down",
        Bandwidth = 1000,
        Delay = 10,
        Description = "My Description",
        InterfaceId = "vlan293",
        Medium = "bcast",
        Mtu = 9216,
    });

});
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.NewSviInterface(ctx, "example", &nxos.SviInterfaceArgs{
			AdminState:  pulumi.String("down"),
			Bandwidth:   pulumi.Int(1000),
			Delay:       pulumi.Int(10),
			Description: pulumi.String("My Description"),
			InterfaceId: pulumi.String("vlan293"),
			Medium:      pulumi.String("bcast"),
			Mtu:         pulumi.Int(9216),
		})
		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.SviInterface;
import com.pulumi.nxos.SviInterfaceArgs;
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 SviInterface("example", SviInterfaceArgs.builder()        
            .adminState("down")
            .bandwidth(1000)
            .delay(10)
            .description("My Description")
            .interfaceId("vlan293")
            .medium("bcast")
            .mtu(9216)
            .build());

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

const example = new nxos.SviInterface("example", {
    adminState: "down",
    bandwidth: 1000,
    delay: 10,
    description: "My Description",
    interfaceId: "vlan293",
    medium: "bcast",
    mtu: 9216,
});
Copy
import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.SviInterface("example",
    admin_state="down",
    bandwidth=1000,
    delay=10,
    description="My Description",
    interface_id="vlan293",
    medium="bcast",
    mtu=9216)
Copy
resources:
  example:
    type: nxos:SviInterface
    properties:
      adminState: down
      bandwidth: 1000
      delay: 10
      description: My Description
      interfaceId: vlan293
      medium: bcast
      mtu: 9216
Copy

Create SviInterface Resource

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

Constructor syntax

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

@overload
def SviInterface(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 interface_id: Optional[str] = None,
                 admin_state: Optional[str] = None,
                 bandwidth: Optional[int] = None,
                 delay: Optional[int] = None,
                 description: Optional[str] = None,
                 device: Optional[str] = None,
                 medium: Optional[str] = None,
                 mtu: Optional[int] = None)
func NewSviInterface(ctx *Context, name string, args SviInterfaceArgs, opts ...ResourceOption) (*SviInterface, error)
public SviInterface(string name, SviInterfaceArgs args, CustomResourceOptions? opts = null)
public SviInterface(String name, SviInterfaceArgs args)
public SviInterface(String name, SviInterfaceArgs args, CustomResourceOptions options)
type: nxos:SviInterface
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. SviInterfaceArgs
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. SviInterfaceArgs
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. SviInterfaceArgs
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. SviInterfaceArgs
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. SviInterfaceArgs
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 sviInterfaceResource = new Nxos.SviInterface("sviInterfaceResource", new()
{
    InterfaceId = "string",
    AdminState = "string",
    Bandwidth = 0,
    Delay = 0,
    Description = "string",
    Device = "string",
    Medium = "string",
    Mtu = 0,
});
Copy
example, err := nxos.NewSviInterface(ctx, "sviInterfaceResource", &nxos.SviInterfaceArgs{
	InterfaceId: pulumi.String("string"),
	AdminState:  pulumi.String("string"),
	Bandwidth:   pulumi.Int(0),
	Delay:       pulumi.Int(0),
	Description: pulumi.String("string"),
	Device:      pulumi.String("string"),
	Medium:      pulumi.String("string"),
	Mtu:         pulumi.Int(0),
})
Copy
var sviInterfaceResource = new SviInterface("sviInterfaceResource", SviInterfaceArgs.builder()
    .interfaceId("string")
    .adminState("string")
    .bandwidth(0)
    .delay(0)
    .description("string")
    .device("string")
    .medium("string")
    .mtu(0)
    .build());
Copy
svi_interface_resource = nxos.SviInterface("sviInterfaceResource",
    interface_id="string",
    admin_state="string",
    bandwidth=0,
    delay=0,
    description="string",
    device="string",
    medium="string",
    mtu=0)
Copy
const sviInterfaceResource = new nxos.SviInterface("sviInterfaceResource", {
    interfaceId: "string",
    adminState: "string",
    bandwidth: 0,
    delay: 0,
    description: "string",
    device: "string",
    medium: "string",
    mtu: 0,
});
Copy
type: nxos:SviInterface
properties:
    adminState: string
    bandwidth: 0
    delay: 0
    description: string
    device: string
    interfaceId: string
    medium: string
    mtu: 0
Copy

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

InterfaceId This property is required. string
Must match first field in the output of show intf brief. Example: vlan100.
AdminState string
Administrative port state. - Choices: up, down - Default value: up
Bandwidth int
Specifies the administrative port bandwidth. - Range: 1-400000000 - Default value: 1000000
Delay int
Specifies the administrative port delay. - Range: 1-16777215 - Default value: 1
Description string
Interface description.
Device string
A device name from the provider configuration.
Medium string
The administrative port medium type. - Choices: bcast, p2p - Default value: bcast
Mtu int
Administrative port MTU. - Range: 576-9216 - Default value: 1500
InterfaceId This property is required. string
Must match first field in the output of show intf brief. Example: vlan100.
AdminState string
Administrative port state. - Choices: up, down - Default value: up
Bandwidth int
Specifies the administrative port bandwidth. - Range: 1-400000000 - Default value: 1000000
Delay int
Specifies the administrative port delay. - Range: 1-16777215 - Default value: 1
Description string
Interface description.
Device string
A device name from the provider configuration.
Medium string
The administrative port medium type. - Choices: bcast, p2p - Default value: bcast
Mtu int
Administrative port MTU. - Range: 576-9216 - Default value: 1500
interfaceId This property is required. String
Must match first field in the output of show intf brief. Example: vlan100.
adminState String
Administrative port state. - Choices: up, down - Default value: up
bandwidth Integer
Specifies the administrative port bandwidth. - Range: 1-400000000 - Default value: 1000000
delay Integer
Specifies the administrative port delay. - Range: 1-16777215 - Default value: 1
description String
Interface description.
device String
A device name from the provider configuration.
medium String
The administrative port medium type. - Choices: bcast, p2p - Default value: bcast
mtu Integer
Administrative port MTU. - Range: 576-9216 - Default value: 1500
interfaceId This property is required. string
Must match first field in the output of show intf brief. Example: vlan100.
adminState string
Administrative port state. - Choices: up, down - Default value: up
bandwidth number
Specifies the administrative port bandwidth. - Range: 1-400000000 - Default value: 1000000
delay number
Specifies the administrative port delay. - Range: 1-16777215 - Default value: 1
description string
Interface description.
device string
A device name from the provider configuration.
medium string
The administrative port medium type. - Choices: bcast, p2p - Default value: bcast
mtu number
Administrative port MTU. - Range: 576-9216 - Default value: 1500
interface_id This property is required. str
Must match first field in the output of show intf brief. Example: vlan100.
admin_state str
Administrative port state. - Choices: up, down - Default value: up
bandwidth int
Specifies the administrative port bandwidth. - Range: 1-400000000 - Default value: 1000000
delay int
Specifies the administrative port delay. - Range: 1-16777215 - Default value: 1
description str
Interface description.
device str
A device name from the provider configuration.
medium str
The administrative port medium type. - Choices: bcast, p2p - Default value: bcast
mtu int
Administrative port MTU. - Range: 576-9216 - Default value: 1500
interfaceId This property is required. String
Must match first field in the output of show intf brief. Example: vlan100.
adminState String
Administrative port state. - Choices: up, down - Default value: up
bandwidth Number
Specifies the administrative port bandwidth. - Range: 1-400000000 - Default value: 1000000
delay Number
Specifies the administrative port delay. - Range: 1-16777215 - Default value: 1
description String
Interface description.
device String
A device name from the provider configuration.
medium String
The administrative port medium type. - Choices: bcast, p2p - Default value: bcast
mtu Number
Administrative port MTU. - Range: 576-9216 - Default value: 1500

Outputs

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

Get an existing SviInterface 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?: SviInterfaceState, opts?: CustomResourceOptions): SviInterface
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_state: Optional[str] = None,
        bandwidth: Optional[int] = None,
        delay: Optional[int] = None,
        description: Optional[str] = None,
        device: Optional[str] = None,
        interface_id: Optional[str] = None,
        medium: Optional[str] = None,
        mtu: Optional[int] = None) -> SviInterface
func GetSviInterface(ctx *Context, name string, id IDInput, state *SviInterfaceState, opts ...ResourceOption) (*SviInterface, error)
public static SviInterface Get(string name, Input<string> id, SviInterfaceState? state, CustomResourceOptions? opts = null)
public static SviInterface get(String name, Output<String> id, SviInterfaceState state, CustomResourceOptions options)
resources:  _:    type: nxos:SviInterface    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 port state. - Choices: up, down - Default value: up
Bandwidth int
Specifies the administrative port bandwidth. - Range: 1-400000000 - Default value: 1000000
Delay int
Specifies the administrative port delay. - Range: 1-16777215 - Default value: 1
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: vlan100.
Medium string
The administrative port medium type. - Choices: bcast, p2p - Default value: bcast
Mtu int
Administrative port MTU. - Range: 576-9216 - Default value: 1500
AdminState string
Administrative port state. - Choices: up, down - Default value: up
Bandwidth int
Specifies the administrative port bandwidth. - Range: 1-400000000 - Default value: 1000000
Delay int
Specifies the administrative port delay. - Range: 1-16777215 - Default value: 1
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: vlan100.
Medium string
The administrative port medium type. - Choices: bcast, p2p - Default value: bcast
Mtu int
Administrative port MTU. - Range: 576-9216 - Default value: 1500
adminState String
Administrative port state. - Choices: up, down - Default value: up
bandwidth Integer
Specifies the administrative port bandwidth. - Range: 1-400000000 - Default value: 1000000
delay Integer
Specifies the administrative port delay. - Range: 1-16777215 - Default value: 1
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: vlan100.
medium String
The administrative port medium type. - Choices: bcast, p2p - Default value: bcast
mtu Integer
Administrative port MTU. - Range: 576-9216 - Default value: 1500
adminState string
Administrative port state. - Choices: up, down - Default value: up
bandwidth number
Specifies the administrative port bandwidth. - Range: 1-400000000 - Default value: 1000000
delay number
Specifies the administrative port delay. - Range: 1-16777215 - Default value: 1
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: vlan100.
medium string
The administrative port medium type. - Choices: bcast, p2p - Default value: bcast
mtu number
Administrative port MTU. - Range: 576-9216 - Default value: 1500
admin_state str
Administrative port state. - Choices: up, down - Default value: up
bandwidth int
Specifies the administrative port bandwidth. - Range: 1-400000000 - Default value: 1000000
delay int
Specifies the administrative port delay. - Range: 1-16777215 - Default value: 1
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: vlan100.
medium str
The administrative port medium type. - Choices: bcast, p2p - Default value: bcast
mtu int
Administrative port MTU. - Range: 576-9216 - Default value: 1500
adminState String
Administrative port state. - Choices: up, down - Default value: up
bandwidth Number
Specifies the administrative port bandwidth. - Range: 1-400000000 - Default value: 1000000
delay Number
Specifies the administrative port delay. - Range: 1-16777215 - Default value: 1
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: vlan100.
medium String
The administrative port medium type. - Choices: bcast, p2p - Default value: bcast
mtu Number
Administrative port MTU. - Range: 576-9216 - Default value: 1500

Import

 $ pulumi import nxos:index/sviInterface:SviInterface example "sys/intf/svi-[vlan293]"
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.