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

nxos.Subinterface

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 subinterface.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = new Nxos.Subinterface("example", new()
    {
        AdminState = "down",
        Bandwidth = 1000,
        Delay = 10,
        Description = "My Description",
        Encap = "vlan-124",
        InterfaceId = "eth1/10.124",
        LinkLogging = "enable",
        Medium = "broadcast",
        Mtu = 1500,
    });

});
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.NewSubinterface(ctx, "example", &nxos.SubinterfaceArgs{
			AdminState:  pulumi.String("down"),
			Bandwidth:   pulumi.Int(1000),
			Delay:       pulumi.Int(10),
			Description: pulumi.String("My Description"),
			Encap:       pulumi.String("vlan-124"),
			InterfaceId: pulumi.String("eth1/10.124"),
			LinkLogging: pulumi.String("enable"),
			Medium:      pulumi.String("broadcast"),
			Mtu:         pulumi.Int(1500),
		})
		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.Subinterface;
import com.pulumi.nxos.SubinterfaceArgs;
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 Subinterface("example", SubinterfaceArgs.builder()        
            .adminState("down")
            .bandwidth(1000)
            .delay(10)
            .description("My Description")
            .encap("vlan-124")
            .interfaceId("eth1/10.124")
            .linkLogging("enable")
            .medium("broadcast")
            .mtu(1500)
            .build());

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

const example = new nxos.Subinterface("example", {
    adminState: "down",
    bandwidth: 1000,
    delay: 10,
    description: "My Description",
    encap: "vlan-124",
    interfaceId: "eth1/10.124",
    linkLogging: "enable",
    medium: "broadcast",
    mtu: 1500,
});
Copy
import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.Subinterface("example",
    admin_state="down",
    bandwidth=1000,
    delay=10,
    description="My Description",
    encap="vlan-124",
    interface_id="eth1/10.124",
    link_logging="enable",
    medium="broadcast",
    mtu=1500)
Copy
resources:
  example:
    type: nxos:Subinterface
    properties:
      adminState: down
      bandwidth: 1000
      delay: 10
      description: My Description
      encap: vlan-124
      interfaceId: eth1/10.124
      linkLogging: enable
      medium: broadcast
      mtu: 1500
Copy

Create Subinterface Resource

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

Constructor syntax

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

@overload
def Subinterface(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,
                 encap: Optional[str] = None,
                 link_logging: Optional[str] = None,
                 medium: Optional[str] = None,
                 mtu: Optional[int] = None)
func NewSubinterface(ctx *Context, name string, args SubinterfaceArgs, opts ...ResourceOption) (*Subinterface, error)
public Subinterface(string name, SubinterfaceArgs args, CustomResourceOptions? opts = null)
public Subinterface(String name, SubinterfaceArgs args)
public Subinterface(String name, SubinterfaceArgs args, CustomResourceOptions options)

type: nxos:Subinterface
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. SubinterfaceArgs
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. SubinterfaceArgs
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. SubinterfaceArgs
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. SubinterfaceArgs
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. SubinterfaceArgs
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 subinterfaceResource = new Nxos.Subinterface("subinterfaceResource", new()
{
    InterfaceId = "string",
    AdminState = "string",
    Bandwidth = 0,
    Delay = 0,
    Description = "string",
    Device = "string",
    Encap = "string",
    LinkLogging = "string",
    Medium = "string",
    Mtu = 0,
});
Copy
example, err := nxos.NewSubinterface(ctx, "subinterfaceResource", &nxos.SubinterfaceArgs{
	InterfaceId: pulumi.String("string"),
	AdminState:  pulumi.String("string"),
	Bandwidth:   pulumi.Int(0),
	Delay:       pulumi.Int(0),
	Description: pulumi.String("string"),
	Device:      pulumi.String("string"),
	Encap:       pulumi.String("string"),
	LinkLogging: pulumi.String("string"),
	Medium:      pulumi.String("string"),
	Mtu:         pulumi.Int(0),
})
Copy
var subinterfaceResource = new Subinterface("subinterfaceResource", SubinterfaceArgs.builder()
    .interfaceId("string")
    .adminState("string")
    .bandwidth(0)
    .delay(0)
    .description("string")
    .device("string")
    .encap("string")
    .linkLogging("string")
    .medium("string")
    .mtu(0)
    .build());
Copy
subinterface_resource = nxos.Subinterface("subinterfaceResource",
    interface_id="string",
    admin_state="string",
    bandwidth=0,
    delay=0,
    description="string",
    device="string",
    encap="string",
    link_logging="string",
    medium="string",
    mtu=0)
Copy
const subinterfaceResource = new nxos.Subinterface("subinterfaceResource", {
    interfaceId: "string",
    adminState: "string",
    bandwidth: 0,
    delay: 0,
    description: "string",
    device: "string",
    encap: "string",
    linkLogging: "string",
    medium: "string",
    mtu: 0,
});
Copy
type: nxos:Subinterface
properties:
    adminState: string
    bandwidth: 0
    delay: 0
    description: string
    device: string
    encap: string
    interfaceId: string
    linkLogging: string
    medium: string
    mtu: 0
Copy

Subinterface 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 Subinterface 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.10.
AdminState string
Administrative state. - Choices: up, down - Default value: up
Bandwidth int
Specifies the administrative port bandwidth. - Range: 0-3200000000 - Default value: 0
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.
Encap string
Subinterface encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
LinkLogging string
Administrative link logging. - Choices: default, enable, disable - Default value: default
Medium string
The administrative port medium type. - Choices: broadcast, p2p - Default value: broadcast
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: eth1/1.10.
AdminState string
Administrative state. - Choices: up, down - Default value: up
Bandwidth int
Specifies the administrative port bandwidth. - Range: 0-3200000000 - Default value: 0
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.
Encap string
Subinterface encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
LinkLogging string
Administrative link logging. - Choices: default, enable, disable - Default value: default
Medium string
The administrative port medium type. - Choices: broadcast, p2p - Default value: broadcast
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: eth1/1.10.
adminState String
Administrative state. - Choices: up, down - Default value: up
bandwidth Integer
Specifies the administrative port bandwidth. - Range: 0-3200000000 - Default value: 0
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.
encap String
Subinterface encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
linkLogging String
Administrative link logging. - Choices: default, enable, disable - Default value: default
medium String
The administrative port medium type. - Choices: broadcast, p2p - Default value: broadcast
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: eth1/1.10.
adminState string
Administrative state. - Choices: up, down - Default value: up
bandwidth number
Specifies the administrative port bandwidth. - Range: 0-3200000000 - Default value: 0
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.
encap string
Subinterface encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
linkLogging string
Administrative link logging. - Choices: default, enable, disable - Default value: default
medium string
The administrative port medium type. - Choices: broadcast, p2p - Default value: broadcast
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: eth1/1.10.
admin_state str
Administrative state. - Choices: up, down - Default value: up
bandwidth int
Specifies the administrative port bandwidth. - Range: 0-3200000000 - Default value: 0
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.
encap str
Subinterface encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
link_logging str
Administrative link logging. - Choices: default, enable, disable - Default value: default
medium str
The administrative port medium type. - Choices: broadcast, p2p - Default value: broadcast
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: eth1/1.10.
adminState String
Administrative state. - Choices: up, down - Default value: up
bandwidth Number
Specifies the administrative port bandwidth. - Range: 0-3200000000 - Default value: 0
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.
encap String
Subinterface encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
linkLogging String
Administrative link logging. - Choices: default, enable, disable - Default value: default
medium String
The administrative port medium type. - Choices: broadcast, p2p - Default value: broadcast
mtu Number
Administrative port MTU. - Range: 576-9216 - Default value: 1500

Outputs

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

Get an existing Subinterface 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?: SubinterfaceState, opts?: CustomResourceOptions): Subinterface
@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,
        encap: Optional[str] = None,
        interface_id: Optional[str] = None,
        link_logging: Optional[str] = None,
        medium: Optional[str] = None,
        mtu: Optional[int] = None) -> Subinterface
func GetSubinterface(ctx *Context, name string, id IDInput, state *SubinterfaceState, opts ...ResourceOption) (*Subinterface, error)
public static Subinterface Get(string name, Input<string> id, SubinterfaceState? state, CustomResourceOptions? opts = null)
public static Subinterface get(String name, Output<String> id, SubinterfaceState state, CustomResourceOptions options)
resources:  _:    type: nxos:Subinterface    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
Bandwidth int
Specifies the administrative port bandwidth. - Range: 0-3200000000 - Default value: 0
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.
Encap string
Subinterface encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
InterfaceId string
Must match first field in the output of show intf brief. Example: eth1/1.10.
LinkLogging string
Administrative link logging. - Choices: default, enable, disable - Default value: default
Medium string
The administrative port medium type. - Choices: broadcast, p2p - Default value: broadcast
Mtu int
Administrative port MTU. - Range: 576-9216 - Default value: 1500
AdminState string
Administrative state. - Choices: up, down - Default value: up
Bandwidth int
Specifies the administrative port bandwidth. - Range: 0-3200000000 - Default value: 0
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.
Encap string
Subinterface encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
InterfaceId string
Must match first field in the output of show intf brief. Example: eth1/1.10.
LinkLogging string
Administrative link logging. - Choices: default, enable, disable - Default value: default
Medium string
The administrative port medium type. - Choices: broadcast, p2p - Default value: broadcast
Mtu int
Administrative port MTU. - Range: 576-9216 - Default value: 1500
adminState String
Administrative state. - Choices: up, down - Default value: up
bandwidth Integer
Specifies the administrative port bandwidth. - Range: 0-3200000000 - Default value: 0
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.
encap String
Subinterface encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
interfaceId String
Must match first field in the output of show intf brief. Example: eth1/1.10.
linkLogging String
Administrative link logging. - Choices: default, enable, disable - Default value: default
medium String
The administrative port medium type. - Choices: broadcast, p2p - Default value: broadcast
mtu Integer
Administrative port MTU. - Range: 576-9216 - Default value: 1500
adminState string
Administrative state. - Choices: up, down - Default value: up
bandwidth number
Specifies the administrative port bandwidth. - Range: 0-3200000000 - Default value: 0
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.
encap string
Subinterface encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
interfaceId string
Must match first field in the output of show intf brief. Example: eth1/1.10.
linkLogging string
Administrative link logging. - Choices: default, enable, disable - Default value: default
medium string
The administrative port medium type. - Choices: broadcast, p2p - Default value: broadcast
mtu number
Administrative port MTU. - Range: 576-9216 - Default value: 1500
admin_state str
Administrative state. - Choices: up, down - Default value: up
bandwidth int
Specifies the administrative port bandwidth. - Range: 0-3200000000 - Default value: 0
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.
encap str
Subinterface encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
interface_id str
Must match first field in the output of show intf brief. Example: eth1/1.10.
link_logging str
Administrative link logging. - Choices: default, enable, disable - Default value: default
medium str
The administrative port medium type. - Choices: broadcast, p2p - Default value: broadcast
mtu int
Administrative port MTU. - Range: 576-9216 - Default value: 1500
adminState String
Administrative state. - Choices: up, down - Default value: up
bandwidth Number
Specifies the administrative port bandwidth. - Range: 0-3200000000 - Default value: 0
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.
encap String
Subinterface encapsulation. Possible values are unknown, vlan-XX or vxlan-XX. - Default value: unknown
interfaceId String
Must match first field in the output of show intf brief. Example: eth1/1.10.
linkLogging String
Administrative link logging. - Choices: default, enable, disable - Default value: default
medium String
The administrative port medium type. - Choices: broadcast, p2p - Default value: broadcast
mtu Number
Administrative port MTU. - Range: 576-9216 - Default value: 1500

Import

 $ pulumi import nxos:index/subinterface:Subinterface example "sys/intf/encrtd-[eth1/10.124]"
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