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

nxos.DhcpRelayAddress

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

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nxos = Lbrlabs.PulumiPackage.Nxos;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Nxos.DhcpRelayAddress("example", new()
        {
            Address = "1.1.1.1",
            InterfaceId = "eth1/10",
            Vrf = "VRF1",
        });
    
    });
    
    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.NewDhcpRelayAddress(ctx, "example", &nxos.DhcpRelayAddressArgs{
    			Address:     pulumi.String("1.1.1.1"),
    			InterfaceId: pulumi.String("eth1/10"),
    			Vrf:         pulumi.String("VRF1"),
    		})
    		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.DhcpRelayAddress;
    import com.pulumi.nxos.DhcpRelayAddressArgs;
    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 DhcpRelayAddress("example", DhcpRelayAddressArgs.builder()        
                .address("1.1.1.1")
                .interfaceId("eth1/10")
                .vrf("VRF1")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_nxos as nxos
    
    example = nxos.DhcpRelayAddress("example",
        address="1.1.1.1",
        interface_id="eth1/10",
        vrf="VRF1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as nxos from "@lbrlabs/pulumi-nxos";
    
    const example = new nxos.DhcpRelayAddress("example", {
        address: "1.1.1.1",
        interfaceId: "eth1/10",
        vrf: "VRF1",
    });
    
    resources:
      example:
        type: nxos:DhcpRelayAddress
        properties:
          address: 1.1.1.1
          interfaceId: eth1/10
          vrf: VRF1
    

    Create DhcpRelayAddress Resource

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

    Constructor syntax

    new DhcpRelayAddress(name: string, args: DhcpRelayAddressArgs, opts?: CustomResourceOptions);
    @overload
    def DhcpRelayAddress(resource_name: str,
                         args: DhcpRelayAddressArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def DhcpRelayAddress(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         address: Optional[str] = None,
                         interface_id: Optional[str] = None,
                         vrf: Optional[str] = None,
                         device: Optional[str] = None)
    func NewDhcpRelayAddress(ctx *Context, name string, args DhcpRelayAddressArgs, opts ...ResourceOption) (*DhcpRelayAddress, error)
    public DhcpRelayAddress(string name, DhcpRelayAddressArgs args, CustomResourceOptions? opts = null)
    public DhcpRelayAddress(String name, DhcpRelayAddressArgs args)
    public DhcpRelayAddress(String name, DhcpRelayAddressArgs args, CustomResourceOptions options)
    
    type: nxos:DhcpRelayAddress
    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 DhcpRelayAddressArgs
    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 DhcpRelayAddressArgs
    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 DhcpRelayAddressArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DhcpRelayAddressArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DhcpRelayAddressArgs
    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 dhcpRelayAddressResource = new Nxos.DhcpRelayAddress("dhcpRelayAddressResource", new()
    {
        Address = "string",
        InterfaceId = "string",
        Vrf = "string",
        Device = "string",
    });
    
    example, err := nxos.NewDhcpRelayAddress(ctx, "dhcpRelayAddressResource", &nxos.DhcpRelayAddressArgs{
    	Address:     pulumi.String("string"),
    	InterfaceId: pulumi.String("string"),
    	Vrf:         pulumi.String("string"),
    	Device:      pulumi.String("string"),
    })
    
    var dhcpRelayAddressResource = new DhcpRelayAddress("dhcpRelayAddressResource", DhcpRelayAddressArgs.builder()        
        .address("string")
        .interfaceId("string")
        .vrf("string")
        .device("string")
        .build());
    
    dhcp_relay_address_resource = nxos.DhcpRelayAddress("dhcpRelayAddressResource",
        address="string",
        interface_id="string",
        vrf="string",
        device="string")
    
    const dhcpRelayAddressResource = new nxos.DhcpRelayAddress("dhcpRelayAddressResource", {
        address: "string",
        interfaceId: "string",
        vrf: "string",
        device: "string",
    });
    
    type: nxos:DhcpRelayAddress
    properties:
        address: string
        device: string
        interfaceId: string
        vrf: string
    

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

    Address string
    IPv4 or IPv6 address.
    InterfaceId string
    Must match first field in the output of show intf brief. Example: eth1/1.
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    Address string
    IPv4 or IPv6 address.
    InterfaceId string
    Must match first field in the output of show intf brief. Example: eth1/1.
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    address String
    IPv4 or IPv6 address.
    interfaceId String
    Must match first field in the output of show intf brief. Example: eth1/1.
    vrf String
    VRF name.
    device String
    A device name from the provider configuration.
    address string
    IPv4 or IPv6 address.
    interfaceId string
    Must match first field in the output of show intf brief. Example: eth1/1.
    vrf string
    VRF name.
    device string
    A device name from the provider configuration.
    address str
    IPv4 or IPv6 address.
    interface_id str
    Must match first field in the output of show intf brief. Example: eth1/1.
    vrf str
    VRF name.
    device str
    A device name from the provider configuration.
    address String
    IPv4 or IPv6 address.
    interfaceId String
    Must match first field in the output of show intf brief. Example: eth1/1.
    vrf String
    VRF name.
    device String
    A device name from the provider configuration.

    Outputs

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

    Get an existing DhcpRelayAddress 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?: DhcpRelayAddressState, opts?: CustomResourceOptions): DhcpRelayAddress
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            address: Optional[str] = None,
            device: Optional[str] = None,
            interface_id: Optional[str] = None,
            vrf: Optional[str] = None) -> DhcpRelayAddress
    func GetDhcpRelayAddress(ctx *Context, name string, id IDInput, state *DhcpRelayAddressState, opts ...ResourceOption) (*DhcpRelayAddress, error)
    public static DhcpRelayAddress Get(string name, Input<string> id, DhcpRelayAddressState? state, CustomResourceOptions? opts = null)
    public static DhcpRelayAddress get(String name, Output<String> id, DhcpRelayAddressState 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:
    Address string
    IPv4 or IPv6 address.
    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.
    Vrf string
    VRF name.
    Address string
    IPv4 or IPv6 address.
    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.
    Vrf string
    VRF name.
    address String
    IPv4 or IPv6 address.
    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.
    vrf String
    VRF name.
    address string
    IPv4 or IPv6 address.
    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.
    vrf string
    VRF name.
    address str
    IPv4 or IPv6 address.
    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.
    vrf str
    VRF name.
    address String
    IPv4 or IPv6 address.
    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.
    vrf String
    VRF name.

    Import

     $ pulumi import nxos:index/dhcpRelayAddress:DhcpRelayAddress example "sys/dhcp/inst/relayif-[eth1/10]/addr-[VRF1]-[1.1.1.1]"
    

    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