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

nxos.Ethernet

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 global ethernet settings.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = new Nxos.Ethernet("example", new()
    {
        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.NewEthernet(ctx, "example", &nxos.EthernetArgs{
			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.Ethernet;
import com.pulumi.nxos.EthernetArgs;
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 Ethernet("example", EthernetArgs.builder()        
            .mtu(9216)
            .build());

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

const example = new nxos.Ethernet("example", {mtu: 9216});
Copy
import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.Ethernet("example", mtu=9216)
Copy
resources:
  example:
    type: nxos:Ethernet
    properties:
      mtu: 9216
Copy

Create Ethernet Resource

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

Constructor syntax

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

@overload
def Ethernet(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             device: Optional[str] = None,
             mtu: Optional[int] = None)
func NewEthernet(ctx *Context, name string, args *EthernetArgs, opts ...ResourceOption) (*Ethernet, error)
public Ethernet(string name, EthernetArgs? args = null, CustomResourceOptions? opts = null)
public Ethernet(String name, EthernetArgs args)
public Ethernet(String name, EthernetArgs args, CustomResourceOptions options)

type: nxos:Ethernet
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 EthernetArgs
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 EthernetArgs
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 EthernetArgs
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 EthernetArgs
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. EthernetArgs
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 ethernetResource = new Nxos.Ethernet("ethernetResource", new()
{
    Device = "string",
    Mtu = 0,
});
Copy
example, err := nxos.NewEthernet(ctx, "ethernetResource", &nxos.EthernetArgs{
	Device: pulumi.String("string"),
	Mtu:    pulumi.Int(0),
})
Copy
var ethernetResource = new Ethernet("ethernetResource", EthernetArgs.builder()
    .device("string")
    .mtu(0)
    .build());
Copy
ethernet_resource = nxos.Ethernet("ethernetResource",
    device="string",
    mtu=0)
Copy
const ethernetResource = new nxos.Ethernet("ethernetResource", {
    device: "string",
    mtu: 0,
});
Copy
type: nxos:Ethernet
properties:
    device: string
    mtu: 0
Copy

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

Device string
A device name from the provider configuration.
Mtu int
System jumbo MTU. - Range: 576-9216 - Default value: 9216
Device string
A device name from the provider configuration.
Mtu int
System jumbo MTU. - Range: 576-9216 - Default value: 9216
device String
A device name from the provider configuration.
mtu Integer
System jumbo MTU. - Range: 576-9216 - Default value: 9216
device string
A device name from the provider configuration.
mtu number
System jumbo MTU. - Range: 576-9216 - Default value: 9216
device str
A device name from the provider configuration.
mtu int
System jumbo MTU. - Range: 576-9216 - Default value: 9216
device String
A device name from the provider configuration.
mtu Number
System jumbo MTU. - Range: 576-9216 - Default value: 9216

Outputs

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

Get an existing Ethernet 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?: EthernetState, opts?: CustomResourceOptions): Ethernet
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        device: Optional[str] = None,
        mtu: Optional[int] = None) -> Ethernet
func GetEthernet(ctx *Context, name string, id IDInput, state *EthernetState, opts ...ResourceOption) (*Ethernet, error)
public static Ethernet Get(string name, Input<string> id, EthernetState? state, CustomResourceOptions? opts = null)
public static Ethernet get(String name, Output<String> id, EthernetState state, CustomResourceOptions options)
resources:  _:    type: nxos:Ethernet    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.
Mtu int
System jumbo MTU. - Range: 576-9216 - Default value: 9216
Device string
A device name from the provider configuration.
Mtu int
System jumbo MTU. - Range: 576-9216 - Default value: 9216
device String
A device name from the provider configuration.
mtu Integer
System jumbo MTU. - Range: 576-9216 - Default value: 9216
device string
A device name from the provider configuration.
mtu number
System jumbo MTU. - Range: 576-9216 - Default value: 9216
device str
A device name from the provider configuration.
mtu int
System jumbo MTU. - Range: 576-9216 - Default value: 9216
device String
A device name from the provider configuration.
mtu Number
System jumbo MTU. - Range: 576-9216 - Default value: 9216

Import

 $ pulumi import nxos:index/ethernet:Ethernet example "sys/ethpm/inst"
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