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

aviatrix.AviatrixEdgeSpoke

Explore with Pulumi AI

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

The aviatrix_edge_spoke resource creates the Aviatrix Edge as a Spoke. This resource is available as of provider version R2.23+.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    // Create a DHCP Edge as a Spoke
    var test = new Aviatrix.AviatrixEdgeSpoke("test", new()
    {
        GwName = "edge-test",
        LanInterfaceIpPrefix = "10.60.0.0/24",
        LocalAsNumber = "65000",
        ManagementInterfaceConfig = "DHCP",
        PrependAsPaths = new[]
        {
            "65000",
            "65000",
        },
        SiteId = "site-123",
        WanDefaultGatewayIp = "10.60.0.0",
        WanInterfaceIpPrefix = "10.60.0.0/24",
        ZtpFileDownloadPath = "/ztp/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.NewAviatrixEdgeSpoke(ctx, "test", &aviatrix.AviatrixEdgeSpokeArgs{
			GwName:                    pulumi.String("edge-test"),
			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"),
			},
			SiteId:               pulumi.String("site-123"),
			WanDefaultGatewayIp:  pulumi.String("10.60.0.0"),
			WanInterfaceIpPrefix: pulumi.String("10.60.0.0/24"),
			ZtpFileDownloadPath:  pulumi.String("/ztp/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.AviatrixEdgeSpoke;
import com.pulumi.aviatrix.AviatrixEdgeSpokeArgs;
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 AviatrixEdgeSpoke("test", AviatrixEdgeSpokeArgs.builder()        
            .gwName("edge-test")
            .lanInterfaceIpPrefix("10.60.0.0/24")
            .localAsNumber("65000")
            .managementInterfaceConfig("DHCP")
            .prependAsPaths(            
                "65000",
                "65000")
            .siteId("site-123")
            .wanDefaultGatewayIp("10.60.0.0")
            .wanInterfaceIpPrefix("10.60.0.0/24")
            .ztpFileDownloadPath("/ztp/download/path")
            .ztpFileType("iso")
            .build());

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

// Create a DHCP Edge as a Spoke
const test = new aviatrix.AviatrixEdgeSpoke("test", {
    gwName: "edge-test",
    lanInterfaceIpPrefix: "10.60.0.0/24",
    localAsNumber: "65000",
    managementInterfaceConfig: "DHCP",
    prependAsPaths: [
        "65000",
        "65000",
    ],
    siteId: "site-123",
    wanDefaultGatewayIp: "10.60.0.0",
    wanInterfaceIpPrefix: "10.60.0.0/24",
    ztpFileDownloadPath: "/ztp/download/path",
    ztpFileType: "iso",
});
Copy
import pulumi
import pulumi_aviatrix as aviatrix

# Create a DHCP Edge as a Spoke
test = aviatrix.AviatrixEdgeSpoke("test",
    gw_name="edge-test",
    lan_interface_ip_prefix="10.60.0.0/24",
    local_as_number="65000",
    management_interface_config="DHCP",
    prepend_as_paths=[
        "65000",
        "65000",
    ],
    site_id="site-123",
    wan_default_gateway_ip="10.60.0.0",
    wan_interface_ip_prefix="10.60.0.0/24",
    ztp_file_download_path="/ztp/download/path",
    ztp_file_type="iso")
Copy
resources:
  # Create a DHCP Edge as a Spoke
  test:
    type: aviatrix:AviatrixEdgeSpoke
    properties:
      gwName: edge-test
      lanInterfaceIpPrefix: 10.60.0.0/24
      localAsNumber: '65000'
      managementInterfaceConfig: DHCP
      prependAsPaths:
        - '65000'
        - '65000'
      siteId: site-123
      wanDefaultGatewayIp: 10.60.0.0
      wanInterfaceIpPrefix: 10.60.0.0/24
      ztpFileDownloadPath: /ztp/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 Spoke
    var test = new Aviatrix.AviatrixEdgeSpoke("test", new()
    {
        DnsServerIp = "10.60.0.0",
        GwName = "edge-test",
        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",
        SiteId = "site-123",
        WanDefaultGatewayIp = "10.60.0.0",
        WanInterfaceIpPrefix = "10.60.0.0/24",
        ZtpFileDownloadPath = "/ztp/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.NewAviatrixEdgeSpoke(ctx, "test", &aviatrix.AviatrixEdgeSpokeArgs{
			DnsServerIp:                 pulumi.String("10.60.0.0"),
			GwName:                      pulumi.String("edge-test"),
			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"),
			SiteId:               pulumi.String("site-123"),
			WanDefaultGatewayIp:  pulumi.String("10.60.0.0"),
			WanInterfaceIpPrefix: pulumi.String("10.60.0.0/24"),
			ZtpFileDownloadPath:  pulumi.String("/ztp/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.AviatrixEdgeSpoke;
import com.pulumi.aviatrix.AviatrixEdgeSpokeArgs;
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 AviatrixEdgeSpoke("test", AviatrixEdgeSpokeArgs.builder()        
            .dnsServerIp("10.60.0.0")
            .gwName("edge-test")
            .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")
            .siteId("site-123")
            .wanDefaultGatewayIp("10.60.0.0")
            .wanInterfaceIpPrefix("10.60.0.0/24")
            .ztpFileDownloadPath("/ztp/download/path")
            .ztpFileType("iso")
            .build());

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

// Create a Static Edge as a Spoke
const test = new aviatrix.AviatrixEdgeSpoke("test", {
    dnsServerIp: "10.60.0.0",
    gwName: "edge-test",
    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",
    siteId: "site-123",
    wanDefaultGatewayIp: "10.60.0.0",
    wanInterfaceIpPrefix: "10.60.0.0/24",
    ztpFileDownloadPath: "/ztp/download/path",
    ztpFileType: "iso",
});
Copy
import pulumi
import pulumi_aviatrix as aviatrix

# Create a Static Edge as a Spoke
test = aviatrix.AviatrixEdgeSpoke("test",
    dns_server_ip="10.60.0.0",
    gw_name="edge-test",
    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",
    site_id="site-123",
    wan_default_gateway_ip="10.60.0.0",
    wan_interface_ip_prefix="10.60.0.0/24",
    ztp_file_download_path="/ztp/download/path",
    ztp_file_type="iso")
Copy
resources:
  # Create a Static Edge as a Spoke
  test:
    type: aviatrix:AviatrixEdgeSpoke
    properties:
      dnsServerIp: 10.60.0.0
      gwName: edge-test
      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
      siteId: site-123
      wanDefaultGatewayIp: 10.60.0.0
      wanInterfaceIpPrefix: 10.60.0.0/24
      ztpFileDownloadPath: /ztp/download/path
      ztpFileType: iso
Copy

Create AviatrixEdgeSpoke Resource

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

Constructor syntax

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

@overload
def AviatrixEdgeSpoke(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      gw_name: Optional[str] = None,
                      ztp_file_type: Optional[str] = None,
                      ztp_file_download_path: Optional[str] = None,
                      wan_interface_ip_prefix: Optional[str] = None,
                      wan_default_gateway_ip: Optional[str] = None,
                      site_id: Optional[str] = None,
                      management_interface_config: Optional[str] = None,
                      lan_interface_ip_prefix: Optional[str] = None,
                      local_as_number: Optional[str] = None,
                      management_interface_ip_prefix: Optional[str] = None,
                      enable_preserve_as_path: Optional[bool] = None,
                      enable_learned_cidrs_approval: Optional[bool] = None,
                      enable_jumbo_frame: Optional[bool] = None,
                      latitude: Optional[str] = None,
                      approved_learned_cidrs: Optional[Sequence[str]] = None,
                      longitude: Optional[str] = None,
                      management_default_gateway_ip: Optional[str] = None,
                      management_egress_ip_prefix: Optional[str] = None,
                      enable_edge_transitive_routing: Optional[bool] = None,
                      enable_management_over_private_network: Optional[bool] = None,
                      prepend_as_paths: Optional[Sequence[str]] = None,
                      rx_queue_size: Optional[str] = None,
                      secondary_dns_server_ip: Optional[str] = None,
                      enable_edge_active_standby_preemptive: Optional[bool] = None,
                      spoke_bgp_manual_advertise_cidrs: Optional[Sequence[str]] = None,
                      enable_edge_active_standby: Optional[bool] = None,
                      dns_server_ip: Optional[str] = None,
                      wan_public_ip: Optional[str] = None,
                      bgp_polling_time: Optional[int] = None,
                      bgp_hold_time: Optional[int] = None)
func NewAviatrixEdgeSpoke(ctx *Context, name string, args AviatrixEdgeSpokeArgs, opts ...ResourceOption) (*AviatrixEdgeSpoke, error)
public AviatrixEdgeSpoke(string name, AviatrixEdgeSpokeArgs args, CustomResourceOptions? opts = null)
public AviatrixEdgeSpoke(String name, AviatrixEdgeSpokeArgs args)
public AviatrixEdgeSpoke(String name, AviatrixEdgeSpokeArgs args, CustomResourceOptions options)

type: aviatrix:AviatrixEdgeSpoke
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. AviatrixEdgeSpokeArgs
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. AviatrixEdgeSpokeArgs
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. AviatrixEdgeSpokeArgs
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. AviatrixEdgeSpokeArgs
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. AviatrixEdgeSpokeArgs
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 aviatrixEdgeSpokeResource = new Aviatrix.AviatrixEdgeSpoke("aviatrixEdgeSpokeResource", new()
{
    GwName = "string",
    ZtpFileType = "string",
    ZtpFileDownloadPath = "string",
    WanInterfaceIpPrefix = "string",
    WanDefaultGatewayIp = "string",
    SiteId = "string",
    ManagementInterfaceConfig = "string",
    LanInterfaceIpPrefix = "string",
    LocalAsNumber = "string",
    ManagementInterfaceIpPrefix = "string",
    EnablePreserveAsPath = false,
    EnableLearnedCidrsApproval = false,
    EnableJumboFrame = false,
    Latitude = "string",
    ApprovedLearnedCidrs = new[]
    {
        "string",
    },
    Longitude = "string",
    ManagementDefaultGatewayIp = "string",
    ManagementEgressIpPrefix = "string",
    EnableEdgeTransitiveRouting = false,
    EnableManagementOverPrivateNetwork = false,
    PrependAsPaths = new[]
    {
        "string",
    },
    RxQueueSize = "string",
    SecondaryDnsServerIp = "string",
    EnableEdgeActiveStandbyPreemptive = false,
    SpokeBgpManualAdvertiseCidrs = new[]
    {
        "string",
    },
    EnableEdgeActiveStandby = false,
    DnsServerIp = "string",
    WanPublicIp = "string",
    BgpPollingTime = 0,
    BgpHoldTime = 0,
});
Copy
example, err := aviatrix.NewAviatrixEdgeSpoke(ctx, "aviatrixEdgeSpokeResource", &aviatrix.AviatrixEdgeSpokeArgs{
	GwName:                      pulumi.String("string"),
	ZtpFileType:                 pulumi.String("string"),
	ZtpFileDownloadPath:         pulumi.String("string"),
	WanInterfaceIpPrefix:        pulumi.String("string"),
	WanDefaultGatewayIp:         pulumi.String("string"),
	SiteId:                      pulumi.String("string"),
	ManagementInterfaceConfig:   pulumi.String("string"),
	LanInterfaceIpPrefix:        pulumi.String("string"),
	LocalAsNumber:               pulumi.String("string"),
	ManagementInterfaceIpPrefix: pulumi.String("string"),
	EnablePreserveAsPath:        pulumi.Bool(false),
	EnableLearnedCidrsApproval:  pulumi.Bool(false),
	EnableJumboFrame:            pulumi.Bool(false),
	Latitude:                    pulumi.String("string"),
	ApprovedLearnedCidrs: pulumi.StringArray{
		pulumi.String("string"),
	},
	Longitude:                          pulumi.String("string"),
	ManagementDefaultGatewayIp:         pulumi.String("string"),
	ManagementEgressIpPrefix:           pulumi.String("string"),
	EnableEdgeTransitiveRouting:        pulumi.Bool(false),
	EnableManagementOverPrivateNetwork: pulumi.Bool(false),
	PrependAsPaths: pulumi.StringArray{
		pulumi.String("string"),
	},
	RxQueueSize:                       pulumi.String("string"),
	SecondaryDnsServerIp:              pulumi.String("string"),
	EnableEdgeActiveStandbyPreemptive: pulumi.Bool(false),
	SpokeBgpManualAdvertiseCidrs: pulumi.StringArray{
		pulumi.String("string"),
	},
	EnableEdgeActiveStandby: pulumi.Bool(false),
	DnsServerIp:             pulumi.String("string"),
	WanPublicIp:             pulumi.String("string"),
	BgpPollingTime:          pulumi.Int(0),
	BgpHoldTime:             pulumi.Int(0),
})
Copy
var aviatrixEdgeSpokeResource = new AviatrixEdgeSpoke("aviatrixEdgeSpokeResource", AviatrixEdgeSpokeArgs.builder()
    .gwName("string")
    .ztpFileType("string")
    .ztpFileDownloadPath("string")
    .wanInterfaceIpPrefix("string")
    .wanDefaultGatewayIp("string")
    .siteId("string")
    .managementInterfaceConfig("string")
    .lanInterfaceIpPrefix("string")
    .localAsNumber("string")
    .managementInterfaceIpPrefix("string")
    .enablePreserveAsPath(false)
    .enableLearnedCidrsApproval(false)
    .enableJumboFrame(false)
    .latitude("string")
    .approvedLearnedCidrs("string")
    .longitude("string")
    .managementDefaultGatewayIp("string")
    .managementEgressIpPrefix("string")
    .enableEdgeTransitiveRouting(false)
    .enableManagementOverPrivateNetwork(false)
    .prependAsPaths("string")
    .rxQueueSize("string")
    .secondaryDnsServerIp("string")
    .enableEdgeActiveStandbyPreemptive(false)
    .spokeBgpManualAdvertiseCidrs("string")
    .enableEdgeActiveStandby(false)
    .dnsServerIp("string")
    .wanPublicIp("string")
    .bgpPollingTime(0)
    .bgpHoldTime(0)
    .build());
Copy
aviatrix_edge_spoke_resource = aviatrix.AviatrixEdgeSpoke("aviatrixEdgeSpokeResource",
    gw_name="string",
    ztp_file_type="string",
    ztp_file_download_path="string",
    wan_interface_ip_prefix="string",
    wan_default_gateway_ip="string",
    site_id="string",
    management_interface_config="string",
    lan_interface_ip_prefix="string",
    local_as_number="string",
    management_interface_ip_prefix="string",
    enable_preserve_as_path=False,
    enable_learned_cidrs_approval=False,
    enable_jumbo_frame=False,
    latitude="string",
    approved_learned_cidrs=["string"],
    longitude="string",
    management_default_gateway_ip="string",
    management_egress_ip_prefix="string",
    enable_edge_transitive_routing=False,
    enable_management_over_private_network=False,
    prepend_as_paths=["string"],
    rx_queue_size="string",
    secondary_dns_server_ip="string",
    enable_edge_active_standby_preemptive=False,
    spoke_bgp_manual_advertise_cidrs=["string"],
    enable_edge_active_standby=False,
    dns_server_ip="string",
    wan_public_ip="string",
    bgp_polling_time=0,
    bgp_hold_time=0)
Copy
const aviatrixEdgeSpokeResource = new aviatrix.AviatrixEdgeSpoke("aviatrixEdgeSpokeResource", {
    gwName: "string",
    ztpFileType: "string",
    ztpFileDownloadPath: "string",
    wanInterfaceIpPrefix: "string",
    wanDefaultGatewayIp: "string",
    siteId: "string",
    managementInterfaceConfig: "string",
    lanInterfaceIpPrefix: "string",
    localAsNumber: "string",
    managementInterfaceIpPrefix: "string",
    enablePreserveAsPath: false,
    enableLearnedCidrsApproval: false,
    enableJumboFrame: false,
    latitude: "string",
    approvedLearnedCidrs: ["string"],
    longitude: "string",
    managementDefaultGatewayIp: "string",
    managementEgressIpPrefix: "string",
    enableEdgeTransitiveRouting: false,
    enableManagementOverPrivateNetwork: false,
    prependAsPaths: ["string"],
    rxQueueSize: "string",
    secondaryDnsServerIp: "string",
    enableEdgeActiveStandbyPreemptive: false,
    spokeBgpManualAdvertiseCidrs: ["string"],
    enableEdgeActiveStandby: false,
    dnsServerIp: "string",
    wanPublicIp: "string",
    bgpPollingTime: 0,
    bgpHoldTime: 0,
});
Copy
type: aviatrix:AviatrixEdgeSpoke
properties:
    approvedLearnedCidrs:
        - string
    bgpHoldTime: 0
    bgpPollingTime: 0
    dnsServerIp: string
    enableEdgeActiveStandby: false
    enableEdgeActiveStandbyPreemptive: false
    enableEdgeTransitiveRouting: false
    enableJumboFrame: false
    enableLearnedCidrsApproval: false
    enableManagementOverPrivateNetwork: false
    enablePreserveAsPath: false
    gwName: string
    lanInterfaceIpPrefix: string
    latitude: string
    localAsNumber: string
    longitude: string
    managementDefaultGatewayIp: string
    managementEgressIpPrefix: string
    managementInterfaceConfig: string
    managementInterfaceIpPrefix: string
    prependAsPaths:
        - string
    rxQueueSize: string
    secondaryDnsServerIp: string
    siteId: string
    spokeBgpManualAdvertiseCidrs:
        - string
    wanDefaultGatewayIp: string
    wanInterfaceIpPrefix: string
    wanPublicIp: string
    ztpFileDownloadPath: string
    ztpFileType: string
Copy

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

GwName
This property is required.
Changes to this property will trigger replacement.
string
Edge as a Spoke name.
LanInterfaceIpPrefix This property is required. 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".
SiteId
This property is required.
Changes to this property will trigger replacement.
string
Site ID.
WanDefaultGatewayIp This property is required. string
WAN default gateway IP.
WanInterfaceIpPrefix This property is required. 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".
ApprovedLearnedCidrs List<string>
Set of approved learned CIDRs. Valid only when enable_learned_cidrs_approval is set to true. Example: ["10.1.0.0/116", "10.2.0.0/16"].
BgpHoldTime int
BGP hold time. Unit is in seconds. Valid values are between 12 and 360. Default value: 180.
BgpPollingTime int
BGP route polling time. Unit is in seconds. Valid values are between 10 and 50. Default value: 50.
DnsServerIp Changes to this property will trigger replacement. string
DNS server IP. Required and valid when management_interface_config is "Static".
EnableEdgeActiveStandby Changes to this property will trigger replacement. bool
Switch to enable Edge Active-Standby mode. Valid values: true, false. Default value: false.
EnableEdgeActiveStandbyPreemptive Changes to this property will trigger replacement. bool
Switch to enable Preemptive Mode for Edge Active-Standby. Valid values: true, false. Default value: false.
EnableEdgeTransitiveRouting bool
Switch to enable Edge transitive routing. Valid values: true, false. Default value: false.
EnableJumboFrame bool
Switch to enable jumbo frame. Valid values: true, false. Default value: false.
EnableLearnedCidrsApproval bool
Switch to enable learned CIDR approval. Valid values: true, false. Default value: false.
EnableManagementOverPrivateNetwork Changes to this property will trigger replacement. bool
Switch to enable management over the private network. Valid values: true, false. Default value: false.
EnablePreserveAsPath bool
Switch to enable preserve as_path when advertising manual summary CIDRs. Valid values: true, false. Default value: false.
Latitude string
Latitude of Edge as a Spoke. Valid values are between -90 and 90. Example: "47.7511".
LocalAsNumber string
BGP AS Number to assign to Edge as a Spoke.
Longitude string
Longitude of Edge as a Spoke. Valid values are between -180 and 180. Example: "120.7401".
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".
PrependAsPaths List<string>
List of AS numbers to prepend gateway BGP AS_Path field. Valid only when local_as_number is set. Example: ["65023", "65023"].
RxQueueSize string
Ethernet interface RX queue size. Once set, can't be deleted or disabled. Valid values: "1K", "2K", "4K".
SecondaryDnsServerIp Changes to this property will trigger replacement. string
Secondary DNS server IP. Required and valid when management_interface_config is "Static".
SpokeBgpManualAdvertiseCidrs List<string>
Set of intended CIDRs to be advertised to external BGP router. Example: ["10.1.0.0/116", "10.2.0.0/16"].
WanPublicIp string
WAN public IP. Required for attaching connections over the Internet.
GwName
This property is required.
Changes to this property will trigger replacement.
string
Edge as a Spoke name.
LanInterfaceIpPrefix This property is required. 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".
SiteId
This property is required.
Changes to this property will trigger replacement.
string
Site ID.
WanDefaultGatewayIp This property is required. string
WAN default gateway IP.
WanInterfaceIpPrefix This property is required. 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".
ApprovedLearnedCidrs []string
Set of approved learned CIDRs. Valid only when enable_learned_cidrs_approval is set to true. Example: ["10.1.0.0/116", "10.2.0.0/16"].
BgpHoldTime int
BGP hold time. Unit is in seconds. Valid values are between 12 and 360. Default value: 180.
BgpPollingTime int
BGP route polling time. Unit is in seconds. Valid values are between 10 and 50. Default value: 50.
DnsServerIp Changes to this property will trigger replacement. string
DNS server IP. Required and valid when management_interface_config is "Static".
EnableEdgeActiveStandby Changes to this property will trigger replacement. bool
Switch to enable Edge Active-Standby mode. Valid values: true, false. Default value: false.
EnableEdgeActiveStandbyPreemptive Changes to this property will trigger replacement. bool
Switch to enable Preemptive Mode for Edge Active-Standby. Valid values: true, false. Default value: false.
EnableEdgeTransitiveRouting bool
Switch to enable Edge transitive routing. Valid values: true, false. Default value: false.
EnableJumboFrame bool
Switch to enable jumbo frame. Valid values: true, false. Default value: false.
EnableLearnedCidrsApproval bool
Switch to enable learned CIDR approval. Valid values: true, false. Default value: false.
EnableManagementOverPrivateNetwork Changes to this property will trigger replacement. bool
Switch to enable management over the private network. Valid values: true, false. Default value: false.
EnablePreserveAsPath bool
Switch to enable preserve as_path when advertising manual summary CIDRs. Valid values: true, false. Default value: false.
Latitude string
Latitude of Edge as a Spoke. Valid values are between -90 and 90. Example: "47.7511".
LocalAsNumber string
BGP AS Number to assign to Edge as a Spoke.
Longitude string
Longitude of Edge as a Spoke. Valid values are between -180 and 180. Example: "120.7401".
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".
PrependAsPaths []string
List of AS numbers to prepend gateway BGP AS_Path field. Valid only when local_as_number is set. Example: ["65023", "65023"].
RxQueueSize string
Ethernet interface RX queue size. Once set, can't be deleted or disabled. Valid values: "1K", "2K", "4K".
SecondaryDnsServerIp Changes to this property will trigger replacement. string
Secondary DNS server IP. Required and valid when management_interface_config is "Static".
SpokeBgpManualAdvertiseCidrs []string
Set of intended CIDRs to be advertised to external BGP router. Example: ["10.1.0.0/116", "10.2.0.0/16"].
WanPublicIp string
WAN public IP. Required for attaching connections over the Internet.
gwName
This property is required.
Changes to this property will trigger replacement.
String
Edge as a Spoke name.
lanInterfaceIpPrefix This property is required. 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".
siteId
This property is required.
Changes to this property will trigger replacement.
String
Site ID.
wanDefaultGatewayIp This property is required. String
WAN default gateway IP.
wanInterfaceIpPrefix This property is required. 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".
approvedLearnedCidrs List<String>
Set of approved learned CIDRs. Valid only when enable_learned_cidrs_approval is set to true. Example: ["10.1.0.0/116", "10.2.0.0/16"].
bgpHoldTime Integer
BGP hold time. Unit is in seconds. Valid values are between 12 and 360. Default value: 180.
bgpPollingTime Integer
BGP route polling time. Unit is in seconds. Valid values are between 10 and 50. Default value: 50.
dnsServerIp Changes to this property will trigger replacement. String
DNS server IP. Required and valid when management_interface_config is "Static".
enableEdgeActiveStandby Changes to this property will trigger replacement. Boolean
Switch to enable Edge Active-Standby mode. Valid values: true, false. Default value: false.
enableEdgeActiveStandbyPreemptive Changes to this property will trigger replacement. Boolean
Switch to enable Preemptive Mode for Edge Active-Standby. Valid values: true, false. Default value: false.
enableEdgeTransitiveRouting Boolean
Switch to enable Edge transitive routing. Valid values: true, false. Default value: false.
enableJumboFrame Boolean
Switch to enable jumbo frame. Valid values: true, false. Default value: false.
enableLearnedCidrsApproval Boolean
Switch to enable learned CIDR approval. Valid values: true, false. Default value: false.
enableManagementOverPrivateNetwork Changes to this property will trigger replacement. Boolean
Switch to enable management over the private network. Valid values: true, false. Default value: false.
enablePreserveAsPath Boolean
Switch to enable preserve as_path when advertising manual summary CIDRs. Valid values: true, false. Default value: false.
latitude String
Latitude of Edge as a Spoke. Valid values are between -90 and 90. Example: "47.7511".
localAsNumber String
BGP AS Number to assign to Edge as a Spoke.
longitude String
Longitude of Edge as a Spoke. Valid values are between -180 and 180. Example: "120.7401".
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".
prependAsPaths List<String>
List of AS numbers to prepend gateway BGP AS_Path field. Valid only when local_as_number is set. Example: ["65023", "65023"].
rxQueueSize String
Ethernet interface RX queue size. Once set, can't be deleted or disabled. Valid values: "1K", "2K", "4K".
secondaryDnsServerIp Changes to this property will trigger replacement. String
Secondary DNS server IP. Required and valid when management_interface_config is "Static".
spokeBgpManualAdvertiseCidrs List<String>
Set of intended CIDRs to be advertised to external BGP router. Example: ["10.1.0.0/116", "10.2.0.0/16"].
wanPublicIp String
WAN public IP. Required for attaching connections over the Internet.
gwName
This property is required.
Changes to this property will trigger replacement.
string
Edge as a Spoke name.
lanInterfaceIpPrefix This property is required. 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".
siteId
This property is required.
Changes to this property will trigger replacement.
string
Site ID.
wanDefaultGatewayIp This property is required. string
WAN default gateway IP.
wanInterfaceIpPrefix This property is required. 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".
approvedLearnedCidrs string[]
Set of approved learned CIDRs. Valid only when enable_learned_cidrs_approval is set to true. Example: ["10.1.0.0/116", "10.2.0.0/16"].
bgpHoldTime number
BGP hold time. Unit is in seconds. Valid values are between 12 and 360. Default value: 180.
bgpPollingTime number
BGP route polling time. Unit is in seconds. Valid values are between 10 and 50. Default value: 50.
dnsServerIp Changes to this property will trigger replacement. string
DNS server IP. Required and valid when management_interface_config is "Static".
enableEdgeActiveStandby Changes to this property will trigger replacement. boolean
Switch to enable Edge Active-Standby mode. Valid values: true, false. Default value: false.
enableEdgeActiveStandbyPreemptive Changes to this property will trigger replacement. boolean
Switch to enable Preemptive Mode for Edge Active-Standby. Valid values: true, false. Default value: false.
enableEdgeTransitiveRouting boolean
Switch to enable Edge transitive routing. Valid values: true, false. Default value: false.
enableJumboFrame boolean
Switch to enable jumbo frame. Valid values: true, false. Default value: false.
enableLearnedCidrsApproval boolean
Switch to enable learned CIDR approval. Valid values: true, false. Default value: false.
enableManagementOverPrivateNetwork Changes to this property will trigger replacement. boolean
Switch to enable management over the private network. Valid values: true, false. Default value: false.
enablePreserveAsPath boolean
Switch to enable preserve as_path when advertising manual summary CIDRs. Valid values: true, false. Default value: false.
latitude string
Latitude of Edge as a Spoke. Valid values are between -90 and 90. Example: "47.7511".
localAsNumber string
BGP AS Number to assign to Edge as a Spoke.
longitude string
Longitude of Edge as a Spoke. Valid values are between -180 and 180. Example: "120.7401".
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".
prependAsPaths string[]
List of AS numbers to prepend gateway BGP AS_Path field. Valid only when local_as_number is set. Example: ["65023", "65023"].
rxQueueSize string
Ethernet interface RX queue size. Once set, can't be deleted or disabled. Valid values: "1K", "2K", "4K".
secondaryDnsServerIp Changes to this property will trigger replacement. string
Secondary DNS server IP. Required and valid when management_interface_config is "Static".
spokeBgpManualAdvertiseCidrs string[]
Set of intended CIDRs to be advertised to external BGP router. Example: ["10.1.0.0/116", "10.2.0.0/16"].
wanPublicIp string
WAN public IP. Required for attaching connections over the Internet.
gw_name
This property is required.
Changes to this property will trigger replacement.
str
Edge as a Spoke name.
lan_interface_ip_prefix This property is required. 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".
site_id
This property is required.
Changes to this property will trigger replacement.
str
Site ID.
wan_default_gateway_ip This property is required. str
WAN default gateway IP.
wan_interface_ip_prefix This property is required. 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".
approved_learned_cidrs Sequence[str]
Set of approved learned CIDRs. Valid only when enable_learned_cidrs_approval is set to true. Example: ["10.1.0.0/116", "10.2.0.0/16"].
bgp_hold_time int
BGP hold time. Unit is in seconds. Valid values are between 12 and 360. Default value: 180.
bgp_polling_time int
BGP route polling time. Unit is in seconds. Valid values are between 10 and 50. Default value: 50.
dns_server_ip Changes to this property will trigger replacement. str
DNS server IP. Required and valid when management_interface_config is "Static".
enable_edge_active_standby Changes to this property will trigger replacement. bool
Switch to enable Edge Active-Standby mode. Valid values: true, false. Default value: false.
enable_edge_active_standby_preemptive Changes to this property will trigger replacement. bool
Switch to enable Preemptive Mode for Edge Active-Standby. Valid values: true, false. Default value: false.
enable_edge_transitive_routing bool
Switch to enable Edge transitive routing. Valid values: true, false. Default value: false.
enable_jumbo_frame bool
Switch to enable jumbo frame. Valid values: true, false. Default value: false.
enable_learned_cidrs_approval bool
Switch to enable learned CIDR approval. Valid values: true, false. Default value: false.
enable_management_over_private_network Changes to this property will trigger replacement. bool
Switch to enable management over the private network. Valid values: true, false. Default value: false.
enable_preserve_as_path bool
Switch to enable preserve as_path when advertising manual summary CIDRs. Valid values: true, false. Default value: false.
latitude str
Latitude of Edge as a Spoke. Valid values are between -90 and 90. Example: "47.7511".
local_as_number str
BGP AS Number to assign to Edge as a Spoke.
longitude str
Longitude of Edge as a Spoke. Valid values are between -180 and 180. Example: "120.7401".
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".
prepend_as_paths Sequence[str]
List of AS numbers to prepend gateway BGP AS_Path field. Valid only when local_as_number is set. Example: ["65023", "65023"].
rx_queue_size str
Ethernet interface RX queue size. Once set, can't be deleted or disabled. Valid values: "1K", "2K", "4K".
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".
spoke_bgp_manual_advertise_cidrs Sequence[str]
Set of intended CIDRs to be advertised to external BGP router. Example: ["10.1.0.0/116", "10.2.0.0/16"].
wan_public_ip str
WAN public IP. Required for attaching connections over the Internet.
gwName
This property is required.
Changes to this property will trigger replacement.
String
Edge as a Spoke name.
lanInterfaceIpPrefix This property is required. 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".
siteId
This property is required.
Changes to this property will trigger replacement.
String
Site ID.
wanDefaultGatewayIp This property is required. String
WAN default gateway IP.
wanInterfaceIpPrefix This property is required. 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".
approvedLearnedCidrs List<String>
Set of approved learned CIDRs. Valid only when enable_learned_cidrs_approval is set to true. Example: ["10.1.0.0/116", "10.2.0.0/16"].
bgpHoldTime Number
BGP hold time. Unit is in seconds. Valid values are between 12 and 360. Default value: 180.
bgpPollingTime Number
BGP route polling time. Unit is in seconds. Valid values are between 10 and 50. Default value: 50.
dnsServerIp Changes to this property will trigger replacement. String
DNS server IP. Required and valid when management_interface_config is "Static".
enableEdgeActiveStandby Changes to this property will trigger replacement. Boolean
Switch to enable Edge Active-Standby mode. Valid values: true, false. Default value: false.
enableEdgeActiveStandbyPreemptive Changes to this property will trigger replacement. Boolean
Switch to enable Preemptive Mode for Edge Active-Standby. Valid values: true, false. Default value: false.
enableEdgeTransitiveRouting Boolean
Switch to enable Edge transitive routing. Valid values: true, false. Default value: false.
enableJumboFrame Boolean
Switch to enable jumbo frame. Valid values: true, false. Default value: false.
enableLearnedCidrsApproval Boolean
Switch to enable learned CIDR approval. Valid values: true, false. Default value: false.
enableManagementOverPrivateNetwork Changes to this property will trigger replacement. Boolean
Switch to enable management over the private network. Valid values: true, false. Default value: false.
enablePreserveAsPath Boolean
Switch to enable preserve as_path when advertising manual summary CIDRs. Valid values: true, false. Default value: false.
latitude String
Latitude of Edge as a Spoke. Valid values are between -90 and 90. Example: "47.7511".
localAsNumber String
BGP AS Number to assign to Edge as a Spoke.
longitude String
Longitude of Edge as a Spoke. Valid values are between -180 and 180. Example: "120.7401".
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".
prependAsPaths List<String>
List of AS numbers to prepend gateway BGP AS_Path field. Valid only when local_as_number is set. Example: ["65023", "65023"].
rxQueueSize String
Ethernet interface RX queue size. Once set, can't be deleted or disabled. Valid values: "1K", "2K", "4K".
secondaryDnsServerIp Changes to this property will trigger replacement. String
Secondary DNS server IP. Required and valid when management_interface_config is "Static".
spokeBgpManualAdvertiseCidrs List<String>
Set of intended CIDRs to be advertised to external BGP router. Example: ["10.1.0.0/116", "10.2.0.0/16"].
wanPublicIp String
WAN public IP. Required for attaching connections over the Internet.

Outputs

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

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

Look up Existing AviatrixEdgeSpoke Resource

Get an existing AviatrixEdgeSpoke 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?: AviatrixEdgeSpokeState, opts?: CustomResourceOptions): AviatrixEdgeSpoke
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        approved_learned_cidrs: Optional[Sequence[str]] = None,
        bgp_hold_time: Optional[int] = None,
        bgp_polling_time: Optional[int] = None,
        dns_server_ip: Optional[str] = None,
        enable_edge_active_standby: Optional[bool] = None,
        enable_edge_active_standby_preemptive: Optional[bool] = None,
        enable_edge_transitive_routing: Optional[bool] = None,
        enable_jumbo_frame: Optional[bool] = None,
        enable_learned_cidrs_approval: Optional[bool] = None,
        enable_management_over_private_network: Optional[bool] = None,
        enable_preserve_as_path: Optional[bool] = None,
        gw_name: Optional[str] = None,
        lan_interface_ip_prefix: Optional[str] = None,
        latitude: Optional[str] = None,
        local_as_number: Optional[str] = None,
        longitude: 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,
        prepend_as_paths: Optional[Sequence[str]] = None,
        rx_queue_size: Optional[str] = None,
        secondary_dns_server_ip: Optional[str] = None,
        site_id: Optional[str] = None,
        spoke_bgp_manual_advertise_cidrs: Optional[Sequence[str]] = None,
        state: Optional[str] = None,
        wan_default_gateway_ip: Optional[str] = None,
        wan_interface_ip_prefix: Optional[str] = None,
        wan_public_ip: Optional[str] = None,
        ztp_file_download_path: Optional[str] = None,
        ztp_file_type: Optional[str] = None) -> AviatrixEdgeSpoke
func GetAviatrixEdgeSpoke(ctx *Context, name string, id IDInput, state *AviatrixEdgeSpokeState, opts ...ResourceOption) (*AviatrixEdgeSpoke, error)
public static AviatrixEdgeSpoke Get(string name, Input<string> id, AviatrixEdgeSpokeState? state, CustomResourceOptions? opts = null)
public static AviatrixEdgeSpoke get(String name, Output<String> id, AviatrixEdgeSpokeState state, CustomResourceOptions options)
resources:  _:    type: aviatrix:AviatrixEdgeSpoke    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:
ApprovedLearnedCidrs List<string>
Set of approved learned CIDRs. Valid only when enable_learned_cidrs_approval is set to true. Example: ["10.1.0.0/116", "10.2.0.0/16"].
BgpHoldTime int
BGP hold time. Unit is in seconds. Valid values are between 12 and 360. Default value: 180.
BgpPollingTime int
BGP route polling time. Unit is in seconds. Valid values are between 10 and 50. Default value: 50.
DnsServerIp Changes to this property will trigger replacement. string
DNS server IP. Required and valid when management_interface_config is "Static".
EnableEdgeActiveStandby Changes to this property will trigger replacement. bool
Switch to enable Edge Active-Standby mode. Valid values: true, false. Default value: false.
EnableEdgeActiveStandbyPreemptive Changes to this property will trigger replacement. bool
Switch to enable Preemptive Mode for Edge Active-Standby. Valid values: true, false. Default value: false.
EnableEdgeTransitiveRouting bool
Switch to enable Edge transitive routing. Valid values: true, false. Default value: false.
EnableJumboFrame bool
Switch to enable jumbo frame. Valid values: true, false. Default value: false.
EnableLearnedCidrsApproval bool
Switch to enable learned CIDR approval. Valid values: true, false. Default value: false.
EnableManagementOverPrivateNetwork Changes to this property will trigger replacement. bool
Switch to enable management over the private network. Valid values: true, false. Default value: false.
EnablePreserveAsPath bool
Switch to enable preserve as_path when advertising manual summary CIDRs. Valid values: true, false. Default value: false.
GwName Changes to this property will trigger replacement. string
Edge as a Spoke name.
LanInterfaceIpPrefix string
LAN interface IP and subnet prefix.
Latitude string
Latitude of Edge as a Spoke. Valid values are between -90 and 90. Example: "47.7511".
LocalAsNumber string
BGP AS Number to assign to Edge as a Spoke.
Longitude string
Longitude of Edge as a Spoke. Valid values are between -180 and 180. Example: "120.7401".
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".
PrependAsPaths List<string>
List of AS numbers to prepend gateway BGP AS_Path field. Valid only when local_as_number is set. Example: ["65023", "65023"].
RxQueueSize string
Ethernet interface RX queue size. Once set, can't be deleted or disabled. Valid values: "1K", "2K", "4K".
SecondaryDnsServerIp Changes to this property will trigger replacement. string
Secondary DNS server IP. Required and valid when management_interface_config is "Static".
SiteId Changes to this property will trigger replacement. string
Site ID.
SpokeBgpManualAdvertiseCidrs List<string>
Set of intended CIDRs to be advertised to external BGP router. Example: ["10.1.0.0/116", "10.2.0.0/16"].
State string
State of Edge as a Spoke.
WanDefaultGatewayIp string
WAN default gateway IP.
WanInterfaceIpPrefix string
WAN interface IP and subnet prefix.
WanPublicIp string
WAN public IP. Required for attaching connections over the Internet.
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".
ApprovedLearnedCidrs []string
Set of approved learned CIDRs. Valid only when enable_learned_cidrs_approval is set to true. Example: ["10.1.0.0/116", "10.2.0.0/16"].
BgpHoldTime int
BGP hold time. Unit is in seconds. Valid values are between 12 and 360. Default value: 180.
BgpPollingTime int
BGP route polling time. Unit is in seconds. Valid values are between 10 and 50. Default value: 50.
DnsServerIp Changes to this property will trigger replacement. string
DNS server IP. Required and valid when management_interface_config is "Static".
EnableEdgeActiveStandby Changes to this property will trigger replacement. bool
Switch to enable Edge Active-Standby mode. Valid values: true, false. Default value: false.
EnableEdgeActiveStandbyPreemptive Changes to this property will trigger replacement. bool
Switch to enable Preemptive Mode for Edge Active-Standby. Valid values: true, false. Default value: false.
EnableEdgeTransitiveRouting bool
Switch to enable Edge transitive routing. Valid values: true, false. Default value: false.
EnableJumboFrame bool
Switch to enable jumbo frame. Valid values: true, false. Default value: false.
EnableLearnedCidrsApproval bool
Switch to enable learned CIDR approval. Valid values: true, false. Default value: false.
EnableManagementOverPrivateNetwork Changes to this property will trigger replacement. bool
Switch to enable management over the private network. Valid values: true, false. Default value: false.
EnablePreserveAsPath bool
Switch to enable preserve as_path when advertising manual summary CIDRs. Valid values: true, false. Default value: false.
GwName Changes to this property will trigger replacement. string
Edge as a Spoke name.
LanInterfaceIpPrefix string
LAN interface IP and subnet prefix.
Latitude string
Latitude of Edge as a Spoke. Valid values are between -90 and 90. Example: "47.7511".
LocalAsNumber string
BGP AS Number to assign to Edge as a Spoke.
Longitude string
Longitude of Edge as a Spoke. Valid values are between -180 and 180. Example: "120.7401".
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".
PrependAsPaths []string
List of AS numbers to prepend gateway BGP AS_Path field. Valid only when local_as_number is set. Example: ["65023", "65023"].
RxQueueSize string
Ethernet interface RX queue size. Once set, can't be deleted or disabled. Valid values: "1K", "2K", "4K".
SecondaryDnsServerIp Changes to this property will trigger replacement. string
Secondary DNS server IP. Required and valid when management_interface_config is "Static".
SiteId Changes to this property will trigger replacement. string
Site ID.
SpokeBgpManualAdvertiseCidrs []string
Set of intended CIDRs to be advertised to external BGP router. Example: ["10.1.0.0/116", "10.2.0.0/16"].
State string
State of Edge as a Spoke.
WanDefaultGatewayIp string
WAN default gateway IP.
WanInterfaceIpPrefix string
WAN interface IP and subnet prefix.
WanPublicIp string
WAN public IP. Required for attaching connections over the Internet.
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".
approvedLearnedCidrs List<String>
Set of approved learned CIDRs. Valid only when enable_learned_cidrs_approval is set to true. Example: ["10.1.0.0/116", "10.2.0.0/16"].
bgpHoldTime Integer
BGP hold time. Unit is in seconds. Valid values are between 12 and 360. Default value: 180.
bgpPollingTime Integer
BGP route polling time. Unit is in seconds. Valid values are between 10 and 50. Default value: 50.
dnsServerIp Changes to this property will trigger replacement. String
DNS server IP. Required and valid when management_interface_config is "Static".
enableEdgeActiveStandby Changes to this property will trigger replacement. Boolean
Switch to enable Edge Active-Standby mode. Valid values: true, false. Default value: false.
enableEdgeActiveStandbyPreemptive Changes to this property will trigger replacement. Boolean
Switch to enable Preemptive Mode for Edge Active-Standby. Valid values: true, false. Default value: false.
enableEdgeTransitiveRouting Boolean
Switch to enable Edge transitive routing. Valid values: true, false. Default value: false.
enableJumboFrame Boolean
Switch to enable jumbo frame. Valid values: true, false. Default value: false.
enableLearnedCidrsApproval Boolean
Switch to enable learned CIDR approval. Valid values: true, false. Default value: false.
enableManagementOverPrivateNetwork Changes to this property will trigger replacement. Boolean
Switch to enable management over the private network. Valid values: true, false. Default value: false.
enablePreserveAsPath Boolean
Switch to enable preserve as_path when advertising manual summary CIDRs. Valid values: true, false. Default value: false.
gwName Changes to this property will trigger replacement. String
Edge as a Spoke name.
lanInterfaceIpPrefix String
LAN interface IP and subnet prefix.
latitude String
Latitude of Edge as a Spoke. Valid values are between -90 and 90. Example: "47.7511".
localAsNumber String
BGP AS Number to assign to Edge as a Spoke.
longitude String
Longitude of Edge as a Spoke. Valid values are between -180 and 180. Example: "120.7401".
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".
prependAsPaths List<String>
List of AS numbers to prepend gateway BGP AS_Path field. Valid only when local_as_number is set. Example: ["65023", "65023"].
rxQueueSize String
Ethernet interface RX queue size. Once set, can't be deleted or disabled. Valid values: "1K", "2K", "4K".
secondaryDnsServerIp Changes to this property will trigger replacement. String
Secondary DNS server IP. Required and valid when management_interface_config is "Static".
siteId Changes to this property will trigger replacement. String
Site ID.
spokeBgpManualAdvertiseCidrs List<String>
Set of intended CIDRs to be advertised to external BGP router. Example: ["10.1.0.0/116", "10.2.0.0/16"].
state String
State of Edge as a Spoke.
wanDefaultGatewayIp String
WAN default gateway IP.
wanInterfaceIpPrefix String
WAN interface IP and subnet prefix.
wanPublicIp String
WAN public IP. Required for attaching connections over the Internet.
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".
approvedLearnedCidrs string[]
Set of approved learned CIDRs. Valid only when enable_learned_cidrs_approval is set to true. Example: ["10.1.0.0/116", "10.2.0.0/16"].
bgpHoldTime number
BGP hold time. Unit is in seconds. Valid values are between 12 and 360. Default value: 180.
bgpPollingTime number
BGP route polling time. Unit is in seconds. Valid values are between 10 and 50. Default value: 50.
dnsServerIp Changes to this property will trigger replacement. string
DNS server IP. Required and valid when management_interface_config is "Static".
enableEdgeActiveStandby Changes to this property will trigger replacement. boolean
Switch to enable Edge Active-Standby mode. Valid values: true, false. Default value: false.
enableEdgeActiveStandbyPreemptive Changes to this property will trigger replacement. boolean
Switch to enable Preemptive Mode for Edge Active-Standby. Valid values: true, false. Default value: false.
enableEdgeTransitiveRouting boolean
Switch to enable Edge transitive routing. Valid values: true, false. Default value: false.
enableJumboFrame boolean
Switch to enable jumbo frame. Valid values: true, false. Default value: false.
enableLearnedCidrsApproval boolean
Switch to enable learned CIDR approval. Valid values: true, false. Default value: false.
enableManagementOverPrivateNetwork Changes to this property will trigger replacement. boolean
Switch to enable management over the private network. Valid values: true, false. Default value: false.
enablePreserveAsPath boolean
Switch to enable preserve as_path when advertising manual summary CIDRs. Valid values: true, false. Default value: false.
gwName Changes to this property will trigger replacement. string
Edge as a Spoke name.
lanInterfaceIpPrefix string
LAN interface IP and subnet prefix.
latitude string
Latitude of Edge as a Spoke. Valid values are between -90 and 90. Example: "47.7511".
localAsNumber string
BGP AS Number to assign to Edge as a Spoke.
longitude string
Longitude of Edge as a Spoke. Valid values are between -180 and 180. Example: "120.7401".
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".
prependAsPaths string[]
List of AS numbers to prepend gateway BGP AS_Path field. Valid only when local_as_number is set. Example: ["65023", "65023"].
rxQueueSize string
Ethernet interface RX queue size. Once set, can't be deleted or disabled. Valid values: "1K", "2K", "4K".
secondaryDnsServerIp Changes to this property will trigger replacement. string
Secondary DNS server IP. Required and valid when management_interface_config is "Static".
siteId Changes to this property will trigger replacement. string
Site ID.
spokeBgpManualAdvertiseCidrs string[]
Set of intended CIDRs to be advertised to external BGP router. Example: ["10.1.0.0/116", "10.2.0.0/16"].
state string
State of Edge as a Spoke.
wanDefaultGatewayIp string
WAN default gateway IP.
wanInterfaceIpPrefix string
WAN interface IP and subnet prefix.
wanPublicIp string
WAN public IP. Required for attaching connections over the Internet.
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".
approved_learned_cidrs Sequence[str]
Set of approved learned CIDRs. Valid only when enable_learned_cidrs_approval is set to true. Example: ["10.1.0.0/116", "10.2.0.0/16"].
bgp_hold_time int
BGP hold time. Unit is in seconds. Valid values are between 12 and 360. Default value: 180.
bgp_polling_time int
BGP route polling time. Unit is in seconds. Valid values are between 10 and 50. Default value: 50.
dns_server_ip Changes to this property will trigger replacement. str
DNS server IP. Required and valid when management_interface_config is "Static".
enable_edge_active_standby Changes to this property will trigger replacement. bool
Switch to enable Edge Active-Standby mode. Valid values: true, false. Default value: false.
enable_edge_active_standby_preemptive Changes to this property will trigger replacement. bool
Switch to enable Preemptive Mode for Edge Active-Standby. Valid values: true, false. Default value: false.
enable_edge_transitive_routing bool
Switch to enable Edge transitive routing. Valid values: true, false. Default value: false.
enable_jumbo_frame bool
Switch to enable jumbo frame. Valid values: true, false. Default value: false.
enable_learned_cidrs_approval bool
Switch to enable learned CIDR approval. Valid values: true, false. Default value: false.
enable_management_over_private_network Changes to this property will trigger replacement. bool
Switch to enable management over the private network. Valid values: true, false. Default value: false.
enable_preserve_as_path bool
Switch to enable preserve as_path when advertising manual summary CIDRs. Valid values: true, false. Default value: false.
gw_name Changes to this property will trigger replacement. str
Edge as a Spoke name.
lan_interface_ip_prefix str
LAN interface IP and subnet prefix.
latitude str
Latitude of Edge as a Spoke. Valid values are between -90 and 90. Example: "47.7511".
local_as_number str
BGP AS Number to assign to Edge as a Spoke.
longitude str
Longitude of Edge as a Spoke. Valid values are between -180 and 180. Example: "120.7401".
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".
prepend_as_paths Sequence[str]
List of AS numbers to prepend gateway BGP AS_Path field. Valid only when local_as_number is set. Example: ["65023", "65023"].
rx_queue_size str
Ethernet interface RX queue size. Once set, can't be deleted or disabled. Valid values: "1K", "2K", "4K".
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".
site_id Changes to this property will trigger replacement. str
Site ID.
spoke_bgp_manual_advertise_cidrs Sequence[str]
Set of intended CIDRs to be advertised to external BGP router. Example: ["10.1.0.0/116", "10.2.0.0/16"].
state str
State of Edge as a Spoke.
wan_default_gateway_ip str
WAN default gateway IP.
wan_interface_ip_prefix str
WAN interface IP and subnet prefix.
wan_public_ip str
WAN public IP. Required for attaching connections over the Internet.
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".
approvedLearnedCidrs List<String>
Set of approved learned CIDRs. Valid only when enable_learned_cidrs_approval is set to true. Example: ["10.1.0.0/116", "10.2.0.0/16"].
bgpHoldTime Number
BGP hold time. Unit is in seconds. Valid values are between 12 and 360. Default value: 180.
bgpPollingTime Number
BGP route polling time. Unit is in seconds. Valid values are between 10 and 50. Default value: 50.
dnsServerIp Changes to this property will trigger replacement. String
DNS server IP. Required and valid when management_interface_config is "Static".
enableEdgeActiveStandby Changes to this property will trigger replacement. Boolean
Switch to enable Edge Active-Standby mode. Valid values: true, false. Default value: false.
enableEdgeActiveStandbyPreemptive Changes to this property will trigger replacement. Boolean
Switch to enable Preemptive Mode for Edge Active-Standby. Valid values: true, false. Default value: false.
enableEdgeTransitiveRouting Boolean
Switch to enable Edge transitive routing. Valid values: true, false. Default value: false.
enableJumboFrame Boolean
Switch to enable jumbo frame. Valid values: true, false. Default value: false.
enableLearnedCidrsApproval Boolean
Switch to enable learned CIDR approval. Valid values: true, false. Default value: false.
enableManagementOverPrivateNetwork Changes to this property will trigger replacement. Boolean
Switch to enable management over the private network. Valid values: true, false. Default value: false.
enablePreserveAsPath Boolean
Switch to enable preserve as_path when advertising manual summary CIDRs. Valid values: true, false. Default value: false.
gwName Changes to this property will trigger replacement. String
Edge as a Spoke name.
lanInterfaceIpPrefix String
LAN interface IP and subnet prefix.
latitude String
Latitude of Edge as a Spoke. Valid values are between -90 and 90. Example: "47.7511".
localAsNumber String
BGP AS Number to assign to Edge as a Spoke.
longitude String
Longitude of Edge as a Spoke. Valid values are between -180 and 180. Example: "120.7401".
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".
prependAsPaths List<String>
List of AS numbers to prepend gateway BGP AS_Path field. Valid only when local_as_number is set. Example: ["65023", "65023"].
rxQueueSize String
Ethernet interface RX queue size. Once set, can't be deleted or disabled. Valid values: "1K", "2K", "4K".
secondaryDnsServerIp Changes to this property will trigger replacement. String
Secondary DNS server IP. Required and valid when management_interface_config is "Static".
siteId Changes to this property will trigger replacement. String
Site ID.
spokeBgpManualAdvertiseCidrs List<String>
Set of intended CIDRs to be advertised to external BGP router. Example: ["10.1.0.0/116", "10.2.0.0/16"].
state String
State of Edge as a Spoke.
wanDefaultGatewayIp String
WAN default gateway IP.
wanInterfaceIpPrefix String
WAN interface IP and subnet prefix.
wanPublicIp String
WAN public IP. Required for attaching connections over the Internet.
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_spoke can be imported using the gw_name, e.g.

 $ pulumi import aviatrix:index/aviatrixEdgeSpoke:AviatrixEdgeSpoke test gw_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