Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aviatrix
  3. API Docs
  4. AviatrixEdgeCaag
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
astipkovits/pulumi-aviatrix

aviatrix.AviatrixEdgeCaag

Explore with Pulumi AI

Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
astipkovits/pulumi-aviatrix

The aviatrix_edge_caag resource creates the Aviatrix Edge as a CaaG. This resource is available as of provider version R2.22+.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aviatrix = Pulumi.Aviatrix;

return await Deployment.RunAsync(() => 
{
    // Create a DHCP Edge as a CaaG
    var test = new Aviatrix.AviatrixEdgeCaag("test", new()
    {
        LanInterfaceIpPrefix = "10.60.0.0/24",
        LocalAsNumber = "65000",
        ManagementInterfaceConfig = "DHCP",
        PrependAsPaths = new[]
        {
            "65000",
            "65000",
        },
        WanDefaultGatewayIp = "10.60.0.0",
        WanInterfaceIpPrefix = "10.60.0.0/24",
        ZtpFileDownloadPath = "/image/download/path",
        ZtpFileType = "iso",
    });

});
Copy
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.NewAviatrixEdgeCaag(ctx, "test", &aviatrix.AviatrixEdgeCaagArgs{
			LanInterfaceIpPrefix:      pulumi.String("10.60.0.0/24"),
			LocalAsNumber:             pulumi.String("65000"),
			ManagementInterfaceConfig: pulumi.String("DHCP"),
			PrependAsPaths: pulumi.StringArray{
				pulumi.String("65000"),
				pulumi.String("65000"),
			},
			WanDefaultGatewayIp:  pulumi.String("10.60.0.0"),
			WanInterfaceIpPrefix: pulumi.String("10.60.0.0/24"),
			ZtpFileDownloadPath:  pulumi.String("/image/download/path"),
			ZtpFileType:          pulumi.String("iso"),
		})
		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.aviatrix.AviatrixEdgeCaag;
import com.pulumi.aviatrix.AviatrixEdgeCaagArgs;
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 test = new AviatrixEdgeCaag("test", AviatrixEdgeCaagArgs.builder()        
            .lanInterfaceIpPrefix("10.60.0.0/24")
            .localAsNumber("65000")
            .managementInterfaceConfig("DHCP")
            .prependAsPaths(            
                "65000",
                "65000")
            .wanDefaultGatewayIp("10.60.0.0")
            .wanInterfaceIpPrefix("10.60.0.0/24")
            .ztpFileDownloadPath("/image/download/path")
            .ztpFileType("iso")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as aviatrix from "@pulumi/aviatrix";

// Create a DHCP Edge as a CaaG
const test = new aviatrix.AviatrixEdgeCaag("test", {
    lanInterfaceIpPrefix: "10.60.0.0/24",
    localAsNumber: "65000",
    managementInterfaceConfig: "DHCP",
    prependAsPaths: [
        "65000",
        "65000",
    ],
    wanDefaultGatewayIp: "10.60.0.0",
    wanInterfaceIpPrefix: "10.60.0.0/24",
    ztpFileDownloadPath: "/image/download/path",
    ztpFileType: "iso",
});
Copy
import pulumi
import pulumi_aviatrix as aviatrix

# Create a DHCP Edge as a CaaG
test = aviatrix.AviatrixEdgeCaag("test",
    lan_interface_ip_prefix="10.60.0.0/24",
    local_as_number="65000",
    management_interface_config="DHCP",
    prepend_as_paths=[
        "65000",
        "65000",
    ],
    wan_default_gateway_ip="10.60.0.0",
    wan_interface_ip_prefix="10.60.0.0/24",
    ztp_file_download_path="/image/download/path",
    ztp_file_type="iso")
Copy
resources:
  # Create a DHCP Edge as a CaaG
  test:
    type: aviatrix:AviatrixEdgeCaag
    properties:
      lanInterfaceIpPrefix: 10.60.0.0/24
      localAsNumber: '65000'
      managementInterfaceConfig: DHCP
      prependAsPaths:
        - '65000'
        - '65000'
      wanDefaultGatewayIp: 10.60.0.0
      wanInterfaceIpPrefix: 10.60.0.0/24
      ztpFileDownloadPath: /image/download/path
      ztpFileType: iso
Copy
using System.Collections.Generic;
using Pulumi;
using Aviatrix = Pulumi.Aviatrix;

return await Deployment.RunAsync(() => 
{
    // Create a Static Edge as a CaaG
    var test = new Aviatrix.AviatrixEdgeCaag("test", new()
    {
        DnsServerIp = "10.60.0.0",
        LanInterfaceIpPrefix = "10.60.0.0/24",
        LocalAsNumber = "65000",
        ManagementDefaultGatewayIp = "10.60.0.0",
        ManagementInterfaceConfig = "Static",
        ManagementInterfaceIpPrefix = "10.60.0.0/24",
        PrependAsPaths = new[]
        {
            "65000",
            "65000",
        },
        SecondaryDnsServerIp = "10.60.0.0",
        WanDefaultGatewayIp = "10.60.0.0",
        WanInterfaceIpPrefix = "10.60.0.0/24",
        ZtpFileDownloadPath = "/image/download/path",
        ZtpFileType = "iso",
    });

});
Copy
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.NewAviatrixEdgeCaag(ctx, "test", &aviatrix.AviatrixEdgeCaagArgs{
			DnsServerIp:                 pulumi.String("10.60.0.0"),
			LanInterfaceIpPrefix:        pulumi.String("10.60.0.0/24"),
			LocalAsNumber:               pulumi.String("65000"),
			ManagementDefaultGatewayIp:  pulumi.String("10.60.0.0"),
			ManagementInterfaceConfig:   pulumi.String("Static"),
			ManagementInterfaceIpPrefix: pulumi.String("10.60.0.0/24"),
			PrependAsPaths: pulumi.StringArray{
				pulumi.String("65000"),
				pulumi.String("65000"),
			},
			SecondaryDnsServerIp: pulumi.String("10.60.0.0"),
			WanDefaultGatewayIp:  pulumi.String("10.60.0.0"),
			WanInterfaceIpPrefix: pulumi.String("10.60.0.0/24"),
			ZtpFileDownloadPath:  pulumi.String("/image/download/path"),
			ZtpFileType:          pulumi.String("iso"),
		})
		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.aviatrix.AviatrixEdgeCaag;
import com.pulumi.aviatrix.AviatrixEdgeCaagArgs;
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 test = new AviatrixEdgeCaag("test", AviatrixEdgeCaagArgs.builder()        
            .dnsServerIp("10.60.0.0")
            .lanInterfaceIpPrefix("10.60.0.0/24")
            .localAsNumber("65000")
            .managementDefaultGatewayIp("10.60.0.0")
            .managementInterfaceConfig("Static")
            .managementInterfaceIpPrefix("10.60.0.0/24")
            .prependAsPaths(            
                "65000",
                "65000")
            .secondaryDnsServerIp("10.60.0.0")
            .wanDefaultGatewayIp("10.60.0.0")
            .wanInterfaceIpPrefix("10.60.0.0/24")
            .ztpFileDownloadPath("/image/download/path")
            .ztpFileType("iso")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as aviatrix from "@pulumi/aviatrix";

// Create a Static Edge as a CaaG
const test = new aviatrix.AviatrixEdgeCaag("test", {
    dnsServerIp: "10.60.0.0",
    lanInterfaceIpPrefix: "10.60.0.0/24",
    localAsNumber: "65000",
    managementDefaultGatewayIp: "10.60.0.0",
    managementInterfaceConfig: "Static",
    managementInterfaceIpPrefix: "10.60.0.0/24",
    prependAsPaths: [
        "65000",
        "65000",
    ],
    secondaryDnsServerIp: "10.60.0.0",
    wanDefaultGatewayIp: "10.60.0.0",
    wanInterfaceIpPrefix: "10.60.0.0/24",
    ztpFileDownloadPath: "/image/download/path",
    ztpFileType: "iso",
});
Copy
import pulumi
import pulumi_aviatrix as aviatrix

# Create a Static Edge as a CaaG
test = aviatrix.AviatrixEdgeCaag("test",
    dns_server_ip="10.60.0.0",
    lan_interface_ip_prefix="10.60.0.0/24",
    local_as_number="65000",
    management_default_gateway_ip="10.60.0.0",
    management_interface_config="Static",
    management_interface_ip_prefix="10.60.0.0/24",
    prepend_as_paths=[
        "65000",
        "65000",
    ],
    secondary_dns_server_ip="10.60.0.0",
    wan_default_gateway_ip="10.60.0.0",
    wan_interface_ip_prefix="10.60.0.0/24",
    ztp_file_download_path="/image/download/path",
    ztp_file_type="iso")
Copy
resources:
  # Create a Static Edge as a CaaG
  test:
    type: aviatrix:AviatrixEdgeCaag
    properties:
      dnsServerIp: 10.60.0.0
      lanInterfaceIpPrefix: 10.60.0.0/24
      localAsNumber: '65000'
      managementDefaultGatewayIp: 10.60.0.0
      managementInterfaceConfig: Static
      managementInterfaceIpPrefix: 10.60.0.0/24
      prependAsPaths:
        - '65000'
        - '65000'
      secondaryDnsServerIp: 10.60.0.0
      wanDefaultGatewayIp: 10.60.0.0
      wanInterfaceIpPrefix: 10.60.0.0/24
      ztpFileDownloadPath: /image/download/path
      ztpFileType: iso
Copy

Create AviatrixEdgeCaag Resource

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

Constructor syntax

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

@overload
def AviatrixEdgeCaag(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     management_interface_config: Optional[str] = None,
                     ztp_file_type: Optional[str] = None,
                     lan_interface_ip_prefix: Optional[str] = None,
                     ztp_file_download_path: Optional[str] = None,
                     wan_interface_ip_prefix: Optional[str] = None,
                     wan_default_gateway_ip: Optional[str] = None,
                     local_as_number: Optional[str] = None,
                     management_interface_ip_prefix: Optional[str] = None,
                     name: Optional[str] = None,
                     prepend_as_paths: Optional[Sequence[str]] = None,
                     secondary_dns_server_ip: Optional[str] = None,
                     management_egress_ip_prefix: Optional[str] = None,
                     management_default_gateway_ip: Optional[str] = None,
                     dns_server_ip: Optional[str] = None,
                     enable_over_private_network: Optional[bool] = None)
func NewAviatrixEdgeCaag(ctx *Context, name string, args AviatrixEdgeCaagArgs, opts ...ResourceOption) (*AviatrixEdgeCaag, error)
public AviatrixEdgeCaag(string name, AviatrixEdgeCaagArgs args, CustomResourceOptions? opts = null)
public AviatrixEdgeCaag(String name, AviatrixEdgeCaagArgs args)
public AviatrixEdgeCaag(String name, AviatrixEdgeCaagArgs args, CustomResourceOptions options)

type: aviatrix:AviatrixEdgeCaag
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. AviatrixEdgeCaagArgs
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. AviatrixEdgeCaagArgs
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. AviatrixEdgeCaagArgs
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. AviatrixEdgeCaagArgs
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. AviatrixEdgeCaagArgs
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 aviatrixEdgeCaagResource = new Aviatrix.AviatrixEdgeCaag("aviatrixEdgeCaagResource", new()
{
    ManagementInterfaceConfig = "string",
    ZtpFileType = "string",
    LanInterfaceIpPrefix = "string",
    ZtpFileDownloadPath = "string",
    WanInterfaceIpPrefix = "string",
    WanDefaultGatewayIp = "string",
    LocalAsNumber = "string",
    ManagementInterfaceIpPrefix = "string",
    Name = "string",
    PrependAsPaths = new[]
    {
        "string",
    },
    SecondaryDnsServerIp = "string",
    ManagementEgressIpPrefix = "string",
    ManagementDefaultGatewayIp = "string",
    DnsServerIp = "string",
    EnableOverPrivateNetwork = false,
});
Copy
example, err := aviatrix.NewAviatrixEdgeCaag(ctx, "aviatrixEdgeCaagResource", &aviatrix.AviatrixEdgeCaagArgs{
	ManagementInterfaceConfig:   pulumi.String("string"),
	ZtpFileType:                 pulumi.String("string"),
	LanInterfaceIpPrefix:        pulumi.String("string"),
	ZtpFileDownloadPath:         pulumi.String("string"),
	WanInterfaceIpPrefix:        pulumi.String("string"),
	WanDefaultGatewayIp:         pulumi.String("string"),
	LocalAsNumber:               pulumi.String("string"),
	ManagementInterfaceIpPrefix: pulumi.String("string"),
	Name:                        pulumi.String("string"),
	PrependAsPaths: pulumi.StringArray{
		pulumi.String("string"),
	},
	SecondaryDnsServerIp:       pulumi.String("string"),
	ManagementEgressIpPrefix:   pulumi.String("string"),
	ManagementDefaultGatewayIp: pulumi.String("string"),
	DnsServerIp:                pulumi.String("string"),
	EnableOverPrivateNetwork:   pulumi.Bool(false),
})
Copy
var aviatrixEdgeCaagResource = new AviatrixEdgeCaag("aviatrixEdgeCaagResource", AviatrixEdgeCaagArgs.builder()
    .managementInterfaceConfig("string")
    .ztpFileType("string")
    .lanInterfaceIpPrefix("string")
    .ztpFileDownloadPath("string")
    .wanInterfaceIpPrefix("string")
    .wanDefaultGatewayIp("string")
    .localAsNumber("string")
    .managementInterfaceIpPrefix("string")
    .name("string")
    .prependAsPaths("string")
    .secondaryDnsServerIp("string")
    .managementEgressIpPrefix("string")
    .managementDefaultGatewayIp("string")
    .dnsServerIp("string")
    .enableOverPrivateNetwork(false)
    .build());
Copy
aviatrix_edge_caag_resource = aviatrix.AviatrixEdgeCaag("aviatrixEdgeCaagResource",
    management_interface_config="string",
    ztp_file_type="string",
    lan_interface_ip_prefix="string",
    ztp_file_download_path="string",
    wan_interface_ip_prefix="string",
    wan_default_gateway_ip="string",
    local_as_number="string",
    management_interface_ip_prefix="string",
    name="string",
    prepend_as_paths=["string"],
    secondary_dns_server_ip="string",
    management_egress_ip_prefix="string",
    management_default_gateway_ip="string",
    dns_server_ip="string",
    enable_over_private_network=False)
Copy
const aviatrixEdgeCaagResource = new aviatrix.AviatrixEdgeCaag("aviatrixEdgeCaagResource", {
    managementInterfaceConfig: "string",
    ztpFileType: "string",
    lanInterfaceIpPrefix: "string",
    ztpFileDownloadPath: "string",
    wanInterfaceIpPrefix: "string",
    wanDefaultGatewayIp: "string",
    localAsNumber: "string",
    managementInterfaceIpPrefix: "string",
    name: "string",
    prependAsPaths: ["string"],
    secondaryDnsServerIp: "string",
    managementEgressIpPrefix: "string",
    managementDefaultGatewayIp: "string",
    dnsServerIp: "string",
    enableOverPrivateNetwork: false,
});
Copy
type: aviatrix:AviatrixEdgeCaag
properties:
    dnsServerIp: string
    enableOverPrivateNetwork: false
    lanInterfaceIpPrefix: string
    localAsNumber: string
    managementDefaultGatewayIp: string
    managementEgressIpPrefix: string
    managementInterfaceConfig: string
    managementInterfaceIpPrefix: string
    name: string
    prependAsPaths:
        - string
    secondaryDnsServerIp: string
    wanDefaultGatewayIp: string
    wanInterfaceIpPrefix: string
    ztpFileDownloadPath: string
    ztpFileType: string
Copy

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

LanInterfaceIpPrefix
This property is required.
Changes to this property will trigger replacement.
string
LAN interface IP and subnet prefix.
ManagementInterfaceConfig
This property is required.
Changes to this property will trigger replacement.
string
Management interface configuration. Valid values: "DHCP", "Static".
WanDefaultGatewayIp
This property is required.
Changes to this property will trigger replacement.
string
WAN default gateway IP.
WanInterfaceIpPrefix
This property is required.
Changes to this property will trigger replacement.
string
WAN interface IP and subnet prefix.
ZtpFileDownloadPath
This property is required.
Changes to this property will trigger replacement.
string
The folder path where the ZTP file will be downloaded.
ZtpFileType
This property is required.
Changes to this property will trigger replacement.
string
ZTP file type. Valid values: "iso", "cloud-init".
DnsServerIp Changes to this property will trigger replacement. string
DNS server IP. Required and valid when management_interface_config is "Static".
EnableOverPrivateNetwork Changes to this property will trigger replacement. bool
Indicates whether it is public or private connection between controller and gateway. Valid values: true, false. Default value: false.
LocalAsNumber string
BGP AS Number to assign to Edge as a CaaG.
ManagementDefaultGatewayIp Changes to this property will trigger replacement. string
Management default gateway IP. Required and valid when management_interface_config is "Static".
ManagementEgressIpPrefix string
Management egress gateway IP and subnet prefix.
ManagementInterfaceIpPrefix Changes to this property will trigger replacement. string
Management interface IP and subnet prefix. Required and valid when management_interface_config is "Static".
Name Changes to this property will trigger replacement. string
Edge as a CaaG name.
PrependAsPaths List<string>
Connection AS Path Prepend customized by specifying AS PATH for a BGP connection. Requires local_as_number to be set. Type: List.
SecondaryDnsServerIp Changes to this property will trigger replacement. string
Secondary DNS server IP. Required and valid when management_interface_config is "Static".
LanInterfaceIpPrefix
This property is required.
Changes to this property will trigger replacement.
string
LAN interface IP and subnet prefix.
ManagementInterfaceConfig
This property is required.
Changes to this property will trigger replacement.
string
Management interface configuration. Valid values: "DHCP", "Static".
WanDefaultGatewayIp
This property is required.
Changes to this property will trigger replacement.
string
WAN default gateway IP.
WanInterfaceIpPrefix
This property is required.
Changes to this property will trigger replacement.
string
WAN interface IP and subnet prefix.
ZtpFileDownloadPath
This property is required.
Changes to this property will trigger replacement.
string
The folder path where the ZTP file will be downloaded.
ZtpFileType
This property is required.
Changes to this property will trigger replacement.
string
ZTP file type. Valid values: "iso", "cloud-init".
DnsServerIp Changes to this property will trigger replacement. string
DNS server IP. Required and valid when management_interface_config is "Static".
EnableOverPrivateNetwork Changes to this property will trigger replacement. bool
Indicates whether it is public or private connection between controller and gateway. Valid values: true, false. Default value: false.
LocalAsNumber string
BGP AS Number to assign to Edge as a CaaG.
ManagementDefaultGatewayIp Changes to this property will trigger replacement. string
Management default gateway IP. Required and valid when management_interface_config is "Static".
ManagementEgressIpPrefix string
Management egress gateway IP and subnet prefix.
ManagementInterfaceIpPrefix Changes to this property will trigger replacement. string
Management interface IP and subnet prefix. Required and valid when management_interface_config is "Static".
Name Changes to this property will trigger replacement. string
Edge as a CaaG name.
PrependAsPaths []string
Connection AS Path Prepend customized by specifying AS PATH for a BGP connection. Requires local_as_number to be set. Type: List.
SecondaryDnsServerIp Changes to this property will trigger replacement. string
Secondary DNS server IP. Required and valid when management_interface_config is "Static".
lanInterfaceIpPrefix
This property is required.
Changes to this property will trigger replacement.
String
LAN interface IP and subnet prefix.
managementInterfaceConfig
This property is required.
Changes to this property will trigger replacement.
String
Management interface configuration. Valid values: "DHCP", "Static".
wanDefaultGatewayIp
This property is required.
Changes to this property will trigger replacement.
String
WAN default gateway IP.
wanInterfaceIpPrefix
This property is required.
Changes to this property will trigger replacement.
String
WAN interface IP and subnet prefix.
ztpFileDownloadPath
This property is required.
Changes to this property will trigger replacement.
String
The folder path where the ZTP file will be downloaded.
ztpFileType
This property is required.
Changes to this property will trigger replacement.
String
ZTP file type. Valid values: "iso", "cloud-init".
dnsServerIp Changes to this property will trigger replacement. String
DNS server IP. Required and valid when management_interface_config is "Static".
enableOverPrivateNetwork Changes to this property will trigger replacement. Boolean
Indicates whether it is public or private connection between controller and gateway. Valid values: true, false. Default value: false.
localAsNumber String
BGP AS Number to assign to Edge as a CaaG.
managementDefaultGatewayIp Changes to this property will trigger replacement. String
Management default gateway IP. Required and valid when management_interface_config is "Static".
managementEgressIpPrefix String
Management egress gateway IP and subnet prefix.
managementInterfaceIpPrefix Changes to this property will trigger replacement. String
Management interface IP and subnet prefix. Required and valid when management_interface_config is "Static".
name Changes to this property will trigger replacement. String
Edge as a CaaG name.
prependAsPaths List<String>
Connection AS Path Prepend customized by specifying AS PATH for a BGP connection. Requires local_as_number to be set. Type: List.
secondaryDnsServerIp Changes to this property will trigger replacement. String
Secondary DNS server IP. Required and valid when management_interface_config is "Static".
lanInterfaceIpPrefix
This property is required.
Changes to this property will trigger replacement.
string
LAN interface IP and subnet prefix.
managementInterfaceConfig
This property is required.
Changes to this property will trigger replacement.
string
Management interface configuration. Valid values: "DHCP", "Static".
wanDefaultGatewayIp
This property is required.
Changes to this property will trigger replacement.
string
WAN default gateway IP.
wanInterfaceIpPrefix
This property is required.
Changes to this property will trigger replacement.
string
WAN interface IP and subnet prefix.
ztpFileDownloadPath
This property is required.
Changes to this property will trigger replacement.
string
The folder path where the ZTP file will be downloaded.
ztpFileType
This property is required.
Changes to this property will trigger replacement.
string
ZTP file type. Valid values: "iso", "cloud-init".
dnsServerIp Changes to this property will trigger replacement. string
DNS server IP. Required and valid when management_interface_config is "Static".
enableOverPrivateNetwork Changes to this property will trigger replacement. boolean
Indicates whether it is public or private connection between controller and gateway. Valid values: true, false. Default value: false.
localAsNumber string
BGP AS Number to assign to Edge as a CaaG.
managementDefaultGatewayIp Changes to this property will trigger replacement. string
Management default gateway IP. Required and valid when management_interface_config is "Static".
managementEgressIpPrefix string
Management egress gateway IP and subnet prefix.
managementInterfaceIpPrefix Changes to this property will trigger replacement. string
Management interface IP and subnet prefix. Required and valid when management_interface_config is "Static".
name Changes to this property will trigger replacement. string
Edge as a CaaG name.
prependAsPaths string[]
Connection AS Path Prepend customized by specifying AS PATH for a BGP connection. Requires local_as_number to be set. Type: List.
secondaryDnsServerIp Changes to this property will trigger replacement. string
Secondary DNS server IP. Required and valid when management_interface_config is "Static".
lan_interface_ip_prefix
This property is required.
Changes to this property will trigger replacement.
str
LAN interface IP and subnet prefix.
management_interface_config
This property is required.
Changes to this property will trigger replacement.
str
Management interface configuration. Valid values: "DHCP", "Static".
wan_default_gateway_ip
This property is required.
Changes to this property will trigger replacement.
str
WAN default gateway IP.
wan_interface_ip_prefix
This property is required.
Changes to this property will trigger replacement.
str
WAN interface IP and subnet prefix.
ztp_file_download_path
This property is required.
Changes to this property will trigger replacement.
str
The folder path where the ZTP file will be downloaded.
ztp_file_type
This property is required.
Changes to this property will trigger replacement.
str
ZTP file type. Valid values: "iso", "cloud-init".
dns_server_ip Changes to this property will trigger replacement. str
DNS server IP. Required and valid when management_interface_config is "Static".
enable_over_private_network Changes to this property will trigger replacement. bool
Indicates whether it is public or private connection between controller and gateway. Valid values: true, false. Default value: false.
local_as_number str
BGP AS Number to assign to Edge as a CaaG.
management_default_gateway_ip Changes to this property will trigger replacement. str
Management default gateway IP. Required and valid when management_interface_config is "Static".
management_egress_ip_prefix str
Management egress gateway IP and subnet prefix.
management_interface_ip_prefix Changes to this property will trigger replacement. str
Management interface IP and subnet prefix. Required and valid when management_interface_config is "Static".
name Changes to this property will trigger replacement. str
Edge as a CaaG name.
prepend_as_paths Sequence[str]
Connection AS Path Prepend customized by specifying AS PATH for a BGP connection. Requires local_as_number to be set. Type: List.
secondary_dns_server_ip Changes to this property will trigger replacement. str
Secondary DNS server IP. Required and valid when management_interface_config is "Static".
lanInterfaceIpPrefix
This property is required.
Changes to this property will trigger replacement.
String
LAN interface IP and subnet prefix.
managementInterfaceConfig
This property is required.
Changes to this property will trigger replacement.
String
Management interface configuration. Valid values: "DHCP", "Static".
wanDefaultGatewayIp
This property is required.
Changes to this property will trigger replacement.
String
WAN default gateway IP.
wanInterfaceIpPrefix
This property is required.
Changes to this property will trigger replacement.
String
WAN interface IP and subnet prefix.
ztpFileDownloadPath
This property is required.
Changes to this property will trigger replacement.
String
The folder path where the ZTP file will be downloaded.
ztpFileType
This property is required.
Changes to this property will trigger replacement.
String
ZTP file type. Valid values: "iso", "cloud-init".
dnsServerIp Changes to this property will trigger replacement. String
DNS server IP. Required and valid when management_interface_config is "Static".
enableOverPrivateNetwork Changes to this property will trigger replacement. Boolean
Indicates whether it is public or private connection between controller and gateway. Valid values: true, false. Default value: false.
localAsNumber String
BGP AS Number to assign to Edge as a CaaG.
managementDefaultGatewayIp Changes to this property will trigger replacement. String
Management default gateway IP. Required and valid when management_interface_config is "Static".
managementEgressIpPrefix String
Management egress gateway IP and subnet prefix.
managementInterfaceIpPrefix Changes to this property will trigger replacement. String
Management interface IP and subnet prefix. Required and valid when management_interface_config is "Static".
name Changes to this property will trigger replacement. String
Edge as a CaaG name.
prependAsPaths List<String>
Connection AS Path Prepend customized by specifying AS PATH for a BGP connection. Requires local_as_number to be set. Type: List.
secondaryDnsServerIp Changes to this property will trigger replacement. String
Secondary DNS server IP. Required and valid when management_interface_config is "Static".

Outputs

All input properties are implicitly available as output properties. Additionally, the AviatrixEdgeCaag resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
State string
State of Edge as a CaaG.
Id string
The provider-assigned unique ID for this managed resource.
State string
State of Edge as a CaaG.
id String
The provider-assigned unique ID for this managed resource.
state String
State of Edge as a CaaG.
id string
The provider-assigned unique ID for this managed resource.
state string
State of Edge as a CaaG.
id str
The provider-assigned unique ID for this managed resource.
state str
State of Edge as a CaaG.
id String
The provider-assigned unique ID for this managed resource.
state String
State of Edge as a CaaG.

Look up Existing AviatrixEdgeCaag Resource

Get an existing AviatrixEdgeCaag 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?: AviatrixEdgeCaagState, opts?: CustomResourceOptions): AviatrixEdgeCaag
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dns_server_ip: Optional[str] = None,
        enable_over_private_network: Optional[bool] = None,
        lan_interface_ip_prefix: Optional[str] = None,
        local_as_number: Optional[str] = None,
        management_default_gateway_ip: Optional[str] = None,
        management_egress_ip_prefix: Optional[str] = None,
        management_interface_config: Optional[str] = None,
        management_interface_ip_prefix: Optional[str] = None,
        name: Optional[str] = None,
        prepend_as_paths: Optional[Sequence[str]] = None,
        secondary_dns_server_ip: Optional[str] = None,
        state: Optional[str] = None,
        wan_default_gateway_ip: Optional[str] = None,
        wan_interface_ip_prefix: Optional[str] = None,
        ztp_file_download_path: Optional[str] = None,
        ztp_file_type: Optional[str] = None) -> AviatrixEdgeCaag
func GetAviatrixEdgeCaag(ctx *Context, name string, id IDInput, state *AviatrixEdgeCaagState, opts ...ResourceOption) (*AviatrixEdgeCaag, error)
public static AviatrixEdgeCaag Get(string name, Input<string> id, AviatrixEdgeCaagState? state, CustomResourceOptions? opts = null)
public static AviatrixEdgeCaag get(String name, Output<String> id, AviatrixEdgeCaagState state, CustomResourceOptions options)
resources:  _:    type: aviatrix:AviatrixEdgeCaag    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:
DnsServerIp Changes to this property will trigger replacement. string
DNS server IP. Required and valid when management_interface_config is "Static".
EnableOverPrivateNetwork Changes to this property will trigger replacement. bool
Indicates whether it is public or private connection between controller and gateway. Valid values: true, false. Default value: false.
LanInterfaceIpPrefix Changes to this property will trigger replacement. string
LAN interface IP and subnet prefix.
LocalAsNumber string
BGP AS Number to assign to Edge as a CaaG.
ManagementDefaultGatewayIp Changes to this property will trigger replacement. string
Management default gateway IP. Required and valid when management_interface_config is "Static".
ManagementEgressIpPrefix string
Management egress gateway IP and subnet prefix.
ManagementInterfaceConfig Changes to this property will trigger replacement. string
Management interface configuration. Valid values: "DHCP", "Static".
ManagementInterfaceIpPrefix Changes to this property will trigger replacement. string
Management interface IP and subnet prefix. Required and valid when management_interface_config is "Static".
Name Changes to this property will trigger replacement. string
Edge as a CaaG name.
PrependAsPaths List<string>
Connection AS Path Prepend customized by specifying AS PATH for a BGP connection. Requires local_as_number to be set. Type: List.
SecondaryDnsServerIp Changes to this property will trigger replacement. string
Secondary DNS server IP. Required and valid when management_interface_config is "Static".
State string
State of Edge as a CaaG.
WanDefaultGatewayIp Changes to this property will trigger replacement. string
WAN default gateway IP.
WanInterfaceIpPrefix Changes to this property will trigger replacement. string
WAN interface IP and subnet prefix.
ZtpFileDownloadPath Changes to this property will trigger replacement. string
The folder path where the ZTP file will be downloaded.
ZtpFileType Changes to this property will trigger replacement. string
ZTP file type. Valid values: "iso", "cloud-init".
DnsServerIp Changes to this property will trigger replacement. string
DNS server IP. Required and valid when management_interface_config is "Static".
EnableOverPrivateNetwork Changes to this property will trigger replacement. bool
Indicates whether it is public or private connection between controller and gateway. Valid values: true, false. Default value: false.
LanInterfaceIpPrefix Changes to this property will trigger replacement. string
LAN interface IP and subnet prefix.
LocalAsNumber string
BGP AS Number to assign to Edge as a CaaG.
ManagementDefaultGatewayIp Changes to this property will trigger replacement. string
Management default gateway IP. Required and valid when management_interface_config is "Static".
ManagementEgressIpPrefix string
Management egress gateway IP and subnet prefix.
ManagementInterfaceConfig Changes to this property will trigger replacement. string
Management interface configuration. Valid values: "DHCP", "Static".
ManagementInterfaceIpPrefix Changes to this property will trigger replacement. string
Management interface IP and subnet prefix. Required and valid when management_interface_config is "Static".
Name Changes to this property will trigger replacement. string
Edge as a CaaG name.
PrependAsPaths []string
Connection AS Path Prepend customized by specifying AS PATH for a BGP connection. Requires local_as_number to be set. Type: List.
SecondaryDnsServerIp Changes to this property will trigger replacement. string
Secondary DNS server IP. Required and valid when management_interface_config is "Static".
State string
State of Edge as a CaaG.
WanDefaultGatewayIp Changes to this property will trigger replacement. string
WAN default gateway IP.
WanInterfaceIpPrefix Changes to this property will trigger replacement. string
WAN interface IP and subnet prefix.
ZtpFileDownloadPath Changes to this property will trigger replacement. string
The folder path where the ZTP file will be downloaded.
ZtpFileType Changes to this property will trigger replacement. string
ZTP file type. Valid values: "iso", "cloud-init".
dnsServerIp Changes to this property will trigger replacement. String
DNS server IP. Required and valid when management_interface_config is "Static".
enableOverPrivateNetwork Changes to this property will trigger replacement. Boolean
Indicates whether it is public or private connection between controller and gateway. Valid values: true, false. Default value: false.
lanInterfaceIpPrefix Changes to this property will trigger replacement. String
LAN interface IP and subnet prefix.
localAsNumber String
BGP AS Number to assign to Edge as a CaaG.
managementDefaultGatewayIp Changes to this property will trigger replacement. String
Management default gateway IP. Required and valid when management_interface_config is "Static".
managementEgressIpPrefix String
Management egress gateway IP and subnet prefix.
managementInterfaceConfig Changes to this property will trigger replacement. String
Management interface configuration. Valid values: "DHCP", "Static".
managementInterfaceIpPrefix Changes to this property will trigger replacement. String
Management interface IP and subnet prefix. Required and valid when management_interface_config is "Static".
name Changes to this property will trigger replacement. String
Edge as a CaaG name.
prependAsPaths List<String>
Connection AS Path Prepend customized by specifying AS PATH for a BGP connection. Requires local_as_number to be set. Type: List.
secondaryDnsServerIp Changes to this property will trigger replacement. String
Secondary DNS server IP. Required and valid when management_interface_config is "Static".
state String
State of Edge as a CaaG.
wanDefaultGatewayIp Changes to this property will trigger replacement. String
WAN default gateway IP.
wanInterfaceIpPrefix Changes to this property will trigger replacement. String
WAN interface IP and subnet prefix.
ztpFileDownloadPath Changes to this property will trigger replacement. String
The folder path where the ZTP file will be downloaded.
ztpFileType Changes to this property will trigger replacement. String
ZTP file type. Valid values: "iso", "cloud-init".
dnsServerIp Changes to this property will trigger replacement. string
DNS server IP. Required and valid when management_interface_config is "Static".
enableOverPrivateNetwork Changes to this property will trigger replacement. boolean
Indicates whether it is public or private connection between controller and gateway. Valid values: true, false. Default value: false.
lanInterfaceIpPrefix Changes to this property will trigger replacement. string
LAN interface IP and subnet prefix.
localAsNumber string
BGP AS Number to assign to Edge as a CaaG.
managementDefaultGatewayIp Changes to this property will trigger replacement. string
Management default gateway IP. Required and valid when management_interface_config is "Static".
managementEgressIpPrefix string
Management egress gateway IP and subnet prefix.
managementInterfaceConfig Changes to this property will trigger replacement. string
Management interface configuration. Valid values: "DHCP", "Static".
managementInterfaceIpPrefix Changes to this property will trigger replacement. string
Management interface IP and subnet prefix. Required and valid when management_interface_config is "Static".
name Changes to this property will trigger replacement. string
Edge as a CaaG name.
prependAsPaths string[]
Connection AS Path Prepend customized by specifying AS PATH for a BGP connection. Requires local_as_number to be set. Type: List.
secondaryDnsServerIp Changes to this property will trigger replacement. string
Secondary DNS server IP. Required and valid when management_interface_config is "Static".
state string
State of Edge as a CaaG.
wanDefaultGatewayIp Changes to this property will trigger replacement. string
WAN default gateway IP.
wanInterfaceIpPrefix Changes to this property will trigger replacement. string
WAN interface IP and subnet prefix.
ztpFileDownloadPath Changes to this property will trigger replacement. string
The folder path where the ZTP file will be downloaded.
ztpFileType Changes to this property will trigger replacement. string
ZTP file type. Valid values: "iso", "cloud-init".
dns_server_ip Changes to this property will trigger replacement. str
DNS server IP. Required and valid when management_interface_config is "Static".
enable_over_private_network Changes to this property will trigger replacement. bool
Indicates whether it is public or private connection between controller and gateway. Valid values: true, false. Default value: false.
lan_interface_ip_prefix Changes to this property will trigger replacement. str
LAN interface IP and subnet prefix.
local_as_number str
BGP AS Number to assign to Edge as a CaaG.
management_default_gateway_ip Changes to this property will trigger replacement. str
Management default gateway IP. Required and valid when management_interface_config is "Static".
management_egress_ip_prefix str
Management egress gateway IP and subnet prefix.
management_interface_config Changes to this property will trigger replacement. str
Management interface configuration. Valid values: "DHCP", "Static".
management_interface_ip_prefix Changes to this property will trigger replacement. str
Management interface IP and subnet prefix. Required and valid when management_interface_config is "Static".
name Changes to this property will trigger replacement. str
Edge as a CaaG name.
prepend_as_paths Sequence[str]
Connection AS Path Prepend customized by specifying AS PATH for a BGP connection. Requires local_as_number to be set. Type: List.
secondary_dns_server_ip Changes to this property will trigger replacement. str
Secondary DNS server IP. Required and valid when management_interface_config is "Static".
state str
State of Edge as a CaaG.
wan_default_gateway_ip Changes to this property will trigger replacement. str
WAN default gateway IP.
wan_interface_ip_prefix Changes to this property will trigger replacement. str
WAN interface IP and subnet prefix.
ztp_file_download_path Changes to this property will trigger replacement. str
The folder path where the ZTP file will be downloaded.
ztp_file_type Changes to this property will trigger replacement. str
ZTP file type. Valid values: "iso", "cloud-init".
dnsServerIp Changes to this property will trigger replacement. String
DNS server IP. Required and valid when management_interface_config is "Static".
enableOverPrivateNetwork Changes to this property will trigger replacement. Boolean
Indicates whether it is public or private connection between controller and gateway. Valid values: true, false. Default value: false.
lanInterfaceIpPrefix Changes to this property will trigger replacement. String
LAN interface IP and subnet prefix.
localAsNumber String
BGP AS Number to assign to Edge as a CaaG.
managementDefaultGatewayIp Changes to this property will trigger replacement. String
Management default gateway IP. Required and valid when management_interface_config is "Static".
managementEgressIpPrefix String
Management egress gateway IP and subnet prefix.
managementInterfaceConfig Changes to this property will trigger replacement. String
Management interface configuration. Valid values: "DHCP", "Static".
managementInterfaceIpPrefix Changes to this property will trigger replacement. String
Management interface IP and subnet prefix. Required and valid when management_interface_config is "Static".
name Changes to this property will trigger replacement. String
Edge as a CaaG name.
prependAsPaths List<String>
Connection AS Path Prepend customized by specifying AS PATH for a BGP connection. Requires local_as_number to be set. Type: List.
secondaryDnsServerIp Changes to this property will trigger replacement. String
Secondary DNS server IP. Required and valid when management_interface_config is "Static".
state String
State of Edge as a CaaG.
wanDefaultGatewayIp Changes to this property will trigger replacement. String
WAN default gateway IP.
wanInterfaceIpPrefix Changes to this property will trigger replacement. String
WAN interface IP and subnet prefix.
ztpFileDownloadPath Changes to this property will trigger replacement. String
The folder path where the ZTP file will be downloaded.
ztpFileType Changes to this property will trigger replacement. String
ZTP file type. Valid values: "iso", "cloud-init".

Import

edge_caag can be imported using the name, e.g.

 $ pulumi import aviatrix:index/aviatrixEdgeCaag:AviatrixEdgeCaag test name
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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