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

nxos.DhcpRelayInterface

Explore with Pulumi AI

nxos logo
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs

    This resource can manage a DHCP relay 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.DhcpRelayInterface("example", new()
        {
            InterfaceId = "eth1/10",
        });
    
    });
    
    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.NewDhcpRelayInterface(ctx, "example", &nxos.DhcpRelayInterfaceArgs{
    			InterfaceId: pulumi.String("eth1/10"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.nxos.DhcpRelayInterface;
    import com.pulumi.nxos.DhcpRelayInterfaceArgs;
    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 DhcpRelayInterface("example", DhcpRelayInterfaceArgs.builder()        
                .interfaceId("eth1/10")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_nxos as nxos
    
    example = nxos.DhcpRelayInterface("example", interface_id="eth1/10")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as nxos from "@lbrlabs/pulumi-nxos";
    
    const example = new nxos.DhcpRelayInterface("example", {interfaceId: "eth1/10"});
    
    resources:
      example:
        type: nxos:DhcpRelayInterface
        properties:
          interfaceId: eth1/10
    

    Create DhcpRelayInterface Resource

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

    Constructor syntax

    new DhcpRelayInterface(name: string, args: DhcpRelayInterfaceArgs, opts?: CustomResourceOptions);
    @overload
    def DhcpRelayInterface(resource_name: str,
                           args: DhcpRelayInterfaceArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def DhcpRelayInterface(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           interface_id: Optional[str] = None,
                           device: Optional[str] = None)
    func NewDhcpRelayInterface(ctx *Context, name string, args DhcpRelayInterfaceArgs, opts ...ResourceOption) (*DhcpRelayInterface, error)
    public DhcpRelayInterface(string name, DhcpRelayInterfaceArgs args, CustomResourceOptions? opts = null)
    public DhcpRelayInterface(String name, DhcpRelayInterfaceArgs args)
    public DhcpRelayInterface(String name, DhcpRelayInterfaceArgs args, CustomResourceOptions options)
    
    type: nxos:DhcpRelayInterface
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DhcpRelayInterfaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DhcpRelayInterfaceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DhcpRelayInterfaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DhcpRelayInterfaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DhcpRelayInterfaceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var dhcpRelayInterfaceResource = new Nxos.DhcpRelayInterface("dhcpRelayInterfaceResource", new()
    {
        InterfaceId = "string",
        Device = "string",
    });
    
    example, err := nxos.NewDhcpRelayInterface(ctx, "dhcpRelayInterfaceResource", &nxos.DhcpRelayInterfaceArgs{
    	InterfaceId: pulumi.String("string"),
    	Device:      pulumi.String("string"),
    })
    
    var dhcpRelayInterfaceResource = new DhcpRelayInterface("dhcpRelayInterfaceResource", DhcpRelayInterfaceArgs.builder()        
        .interfaceId("string")
        .device("string")
        .build());
    
    dhcp_relay_interface_resource = nxos.DhcpRelayInterface("dhcpRelayInterfaceResource",
        interface_id="string",
        device="string")
    
    const dhcpRelayInterfaceResource = new nxos.DhcpRelayInterface("dhcpRelayInterfaceResource", {
        interfaceId: "string",
        device: "string",
    });
    
    type: nxos:DhcpRelayInterface
    properties:
        device: string
        interfaceId: string
    

    DhcpRelayInterface Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The DhcpRelayInterface resource accepts the following input properties:

    InterfaceId string
    Must match first field in the output of show intf brief. Example: eth1/1.
    Device string
    A device name from the provider configuration.
    InterfaceId string
    Must match first field in the output of show intf brief. Example: eth1/1.
    Device string
    A device name from the provider configuration.
    interfaceId String
    Must match first field in the output of show intf brief. Example: eth1/1.
    device String
    A device name from the provider configuration.
    interfaceId string
    Must match first field in the output of show intf brief. Example: eth1/1.
    device string
    A device name from the provider configuration.
    interface_id str
    Must match first field in the output of show intf brief. Example: eth1/1.
    device str
    A device name from the provider configuration.
    interfaceId String
    Must match first field in the output of show intf brief. Example: eth1/1.
    device String
    A device name from the provider configuration.

    Outputs

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

    Get an existing DhcpRelayInterface 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?: DhcpRelayInterfaceState, opts?: CustomResourceOptions): DhcpRelayInterface
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            device: Optional[str] = None,
            interface_id: Optional[str] = None) -> DhcpRelayInterface
    func GetDhcpRelayInterface(ctx *Context, name string, id IDInput, state *DhcpRelayInterfaceState, opts ...ResourceOption) (*DhcpRelayInterface, error)
    public static DhcpRelayInterface Get(string name, Input<string> id, DhcpRelayInterfaceState? state, CustomResourceOptions? opts = null)
    public static DhcpRelayInterface get(String name, Output<String> id, DhcpRelayInterfaceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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.
    InterfaceId string
    Must match first field in the output of show intf brief. Example: eth1/1.
    Device string
    A device name from the provider configuration.
    InterfaceId string
    Must match first field in the output of show intf brief. Example: eth1/1.
    device String
    A device name from the provider configuration.
    interfaceId String
    Must match first field in the output of show intf brief. Example: eth1/1.
    device string
    A device name from the provider configuration.
    interfaceId string
    Must match first field in the output of show intf brief. Example: eth1/1.
    device str
    A device name from the provider configuration.
    interface_id str
    Must match first field in the output of show intf brief. Example: eth1/1.
    device String
    A device name from the provider configuration.
    interfaceId String
    Must match first field in the output of show intf brief. Example: eth1/1.

    Import

     $ pulumi import nxos:index/dhcpRelayInterface:DhcpRelayInterface example "sys/dhcp/inst/relayif-[eth1/10]"
    

    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.
    nxos logo
    Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs