1. Packages
  2. Aviatrix
  3. API Docs
  4. AviatrixDeviceInterfaceConfig
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix

aviatrix.AviatrixDeviceInterfaceConfig

Explore with Pulumi AI

aviatrix logo
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix

    The aviatrix_device_interface_config resource allows the configuration of the WAN primary interface and IP for a device, for use in CloudN.

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Aviatrix = Pulumi.Aviatrix;
    
    return await Deployment.RunAsync(() => 
    {
        // Configure the primary WAN interface and IP for a device.
        var testDeviceInterfaceConfig = new Aviatrix.AviatrixDeviceInterfaceConfig("testDeviceInterfaceConfig", new()
        {
            DeviceName = "test-device",
            WanPrimaryInterface = "eth0",
            WanPrimaryInterfacePublicIp = "181.12.43.21",
        });
    
    });
    
    package main
    
    import (
    	"github.com/astipkovits/pulumi-aviatrix/sdk/go/aviatrix"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := aviatrix.NewAviatrixDeviceInterfaceConfig(ctx, "testDeviceInterfaceConfig", &aviatrix.AviatrixDeviceInterfaceConfigArgs{
    			DeviceName:                  pulumi.String("test-device"),
    			WanPrimaryInterface:         pulumi.String("eth0"),
    			WanPrimaryInterfacePublicIp: pulumi.String("181.12.43.21"),
    		})
    		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.aviatrix.AviatrixDeviceInterfaceConfig;
    import com.pulumi.aviatrix.AviatrixDeviceInterfaceConfigArgs;
    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 testDeviceInterfaceConfig = new AviatrixDeviceInterfaceConfig("testDeviceInterfaceConfig", AviatrixDeviceInterfaceConfigArgs.builder()        
                .deviceName("test-device")
                .wanPrimaryInterface("eth0")
                .wanPrimaryInterfacePublicIp("181.12.43.21")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aviatrix as aviatrix
    
    # Configure the primary WAN interface and IP for a device.
    test_device_interface_config = aviatrix.AviatrixDeviceInterfaceConfig("testDeviceInterfaceConfig",
        device_name="test-device",
        wan_primary_interface="eth0",
        wan_primary_interface_public_ip="181.12.43.21")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aviatrix from "@pulumi/aviatrix";
    
    // Configure the primary WAN interface and IP for a device.
    const testDeviceInterfaceConfig = new aviatrix.AviatrixDeviceInterfaceConfig("test_device_interface_config", {
        deviceName: "test-device",
        wanPrimaryInterface: "eth0",
        wanPrimaryInterfacePublicIp: "181.12.43.21",
    });
    
    resources:
      # Configure the primary WAN interface and IP for a device.
      testDeviceInterfaceConfig:
        type: aviatrix:AviatrixDeviceInterfaceConfig
        properties:
          deviceName: test-device
          wanPrimaryInterface: eth0
          wanPrimaryInterfacePublicIp: 181.12.43.21
    

    Create AviatrixDeviceInterfaceConfig Resource

    new AviatrixDeviceInterfaceConfig(name: string, args: AviatrixDeviceInterfaceConfigArgs, opts?: CustomResourceOptions);
    @overload
    def AviatrixDeviceInterfaceConfig(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      device_name: Optional[str] = None,
                                      wan_primary_interface: Optional[str] = None,
                                      wan_primary_interface_public_ip: Optional[str] = None)
    @overload
    def AviatrixDeviceInterfaceConfig(resource_name: str,
                                      args: AviatrixDeviceInterfaceConfigArgs,
                                      opts: Optional[ResourceOptions] = None)
    func NewAviatrixDeviceInterfaceConfig(ctx *Context, name string, args AviatrixDeviceInterfaceConfigArgs, opts ...ResourceOption) (*AviatrixDeviceInterfaceConfig, error)
    public AviatrixDeviceInterfaceConfig(string name, AviatrixDeviceInterfaceConfigArgs args, CustomResourceOptions? opts = null)
    public AviatrixDeviceInterfaceConfig(String name, AviatrixDeviceInterfaceConfigArgs args)
    public AviatrixDeviceInterfaceConfig(String name, AviatrixDeviceInterfaceConfigArgs args, CustomResourceOptions options)
    
    type: aviatrix:AviatrixDeviceInterfaceConfig
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args AviatrixDeviceInterfaceConfigArgs
    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 AviatrixDeviceInterfaceConfigArgs
    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 AviatrixDeviceInterfaceConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AviatrixDeviceInterfaceConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AviatrixDeviceInterfaceConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    DeviceName string
    Name of the device.
    WanPrimaryInterface string
    Name of the WAN primary interface.
    WanPrimaryInterfacePublicIp string
    The WAN Primary interface public IP.
    DeviceName string
    Name of the device.
    WanPrimaryInterface string
    Name of the WAN primary interface.
    WanPrimaryInterfacePublicIp string
    The WAN Primary interface public IP.
    deviceName String
    Name of the device.
    wanPrimaryInterface String
    Name of the WAN primary interface.
    wanPrimaryInterfacePublicIp String
    The WAN Primary interface public IP.
    deviceName string
    Name of the device.
    wanPrimaryInterface string
    Name of the WAN primary interface.
    wanPrimaryInterfacePublicIp string
    The WAN Primary interface public IP.
    device_name str
    Name of the device.
    wan_primary_interface str
    Name of the WAN primary interface.
    wan_primary_interface_public_ip str
    The WAN Primary interface public IP.
    deviceName String
    Name of the device.
    wanPrimaryInterface String
    Name of the WAN primary interface.
    wanPrimaryInterfacePublicIp String
    The WAN Primary interface public IP.

    Outputs

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

    Get an existing AviatrixDeviceInterfaceConfig 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?: AviatrixDeviceInterfaceConfigState, opts?: CustomResourceOptions): AviatrixDeviceInterfaceConfig
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            device_name: Optional[str] = None,
            wan_primary_interface: Optional[str] = None,
            wan_primary_interface_public_ip: Optional[str] = None) -> AviatrixDeviceInterfaceConfig
    func GetAviatrixDeviceInterfaceConfig(ctx *Context, name string, id IDInput, state *AviatrixDeviceInterfaceConfigState, opts ...ResourceOption) (*AviatrixDeviceInterfaceConfig, error)
    public static AviatrixDeviceInterfaceConfig Get(string name, Input<string> id, AviatrixDeviceInterfaceConfigState? state, CustomResourceOptions? opts = null)
    public static AviatrixDeviceInterfaceConfig get(String name, Output<String> id, AviatrixDeviceInterfaceConfigState 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:
    DeviceName string
    Name of the device.
    WanPrimaryInterface string
    Name of the WAN primary interface.
    WanPrimaryInterfacePublicIp string
    The WAN Primary interface public IP.
    DeviceName string
    Name of the device.
    WanPrimaryInterface string
    Name of the WAN primary interface.
    WanPrimaryInterfacePublicIp string
    The WAN Primary interface public IP.
    deviceName String
    Name of the device.
    wanPrimaryInterface String
    Name of the WAN primary interface.
    wanPrimaryInterfacePublicIp String
    The WAN Primary interface public IP.
    deviceName string
    Name of the device.
    wanPrimaryInterface string
    Name of the WAN primary interface.
    wanPrimaryInterfacePublicIp string
    The WAN Primary interface public IP.
    device_name str
    Name of the device.
    wan_primary_interface str
    Name of the WAN primary interface.
    wan_primary_interface_public_ip str
    The WAN Primary interface public IP.
    deviceName String
    Name of the device.
    wanPrimaryInterface String
    Name of the WAN primary interface.
    wanPrimaryInterfacePublicIp String
    The WAN Primary interface public IP.

    Import

    device_interface_config can be imported using the device_name, e.g.

     $ pulumi import aviatrix:index/aviatrixDeviceInterfaceConfig:AviatrixDeviceInterfaceConfig test device_name
    

    Package Details

    Repository
    aviatrix astipkovits/pulumi-aviatrix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aviatrix Terraform Provider.
    aviatrix logo
    Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix