resource(switch_port_settings): register the resource

.changelog/0.13.0.toml

@@ -3,8 +3,8 @@ title = "`oxide_vpc_firewall_rules`"
 description = "Updated the schema for the `protocols` attribute to allow for more control over ICMP traffic. [#474](https://github.com/oxidecomputer/terraform-provider-oxide/pull/474)"
 
 [[features]]
-title = ""
-description = ""
+title = "New resource"
+description = "`oxide_switch_port_settings` [#475](https://github.com/oxidecomputer/terraform-provider-oxide/pull/475)."
 
 [[enhancements]]
 title = ""

docs/resources/oxide_switch_port_settings.md

@@ -0,0 +1,348 @@
+---
+page_title: "oxide_switch_port_settings Resource - terraform-provider-oxide"
+---
+
+# oxide_switch_port_settings (Resource)
+
+This resource manages switch port settings to configure network switch ports.
+
+!> Switch port settings defined by this resource are considered exhaustive and
+will overwrite any other switch port settings upon apply.
+
+## Example Usage
+
+### Basic Switch Port Settings
+
+```hcl
+resource "oxide_switch_port_settings" "example" {
+  name        = "example"
+  description = "Switch port settings."
+  port_config = {
+    geometry = "qsfp28x1"
+  }
+  addresses = [
+    {
+      link_name = "phy0"
+      addresses = [
+        {
+          address        = "192.168.1.123/24"
+          address_lot_id = "38223e3a-76da-400d-a1e2-8cb4d242095a"
+        },
+      ]
+    },
+    {
+      link_name = "phy1"
+      addresses = [
+        {
+          address        = "10.0.0.123/24"
+          address_lot_id = "a1ab8634-7973-40f1-966c-7f4a8dad7849"
+        },
+      ]
+    },
+  ]
+  links = [
+    {
+      link_name = "phy0"
+      autoneg   = false
+      mtu       = 1500
+      speed     = "speed1_g"
+      lldp = {
+        enabled = false
+      }
+    },
+    {
+      link_name = "phy1"
+      autoneg   = false
+      mtu       = 1500
+      speed     = "speed1_g"
+      lldp = {
+        enabled = false
+      }
+    },
+  ]
+  routes = [
+    {
+      link_name = "phy0"
+      routes = [
+        {
+          dst = "0.0.0.0/0"
+          gw  = "192.168.1.1"
+        },
+      ]
+    },
+    {
+      link_name = "phy0"
+      routes = [
+        {
+          dst = "0.0.0.0/0"
+          gw  = "10.0.0.1"
+        },
+      ]
+    },
+  ]
+}
+```
+
+### Switch Port Settings with BGP Peers
+
+```hcl
+resource "oxide_switch_port_settings" "example" {
+  name        = "example"
+  description = "Switch port settings."
+  port_config = {
+    geometry = "qsfp28x1"
+  }
+  addresses = [
+    {
+      link_name = "phy0"
+      addresses = [
+        {
+          address        = "192.168.1.123/24"
+          address_lot_id = "38223e3a-76da-400d-a1e2-8cb4d242095a"
+        },
+      ]
+    },
+  ]
+  bgp_peers = [
+    {
+      link_name = "phy0"
+      peers = [
+        {
+          allowed_export = {
+            type = "no_filtering"
+          }
+          allowed_import = {
+            type = "no_filtering"
+          }
+          addr             = "1.2.3.4"
+          bgp_config       = "aeeb1e60-b773-432a-b3e9-f677e116ac15"
+          communities      = []
+          connect_retry    = 15
+          delay_open       = 15
+          enforce_first_as = false
+          hold_time        = 15
+          idle_hold_time   = 15
+          interface_name   = "phy0"
+          keepalive        = 15
+        }
+      ]
+    }
+  ]
+  links = [
+    {
+      link_name = "phy0"
+      autoneg   = false
+      mtu       = 1500
+      speed     = "speed1_g"
+      lldp = {
+        enabled = false
+      }
+    },
+  ]
+  routes = [
+    {
+      link_name = "phy0"
+      routes = [
+        {
+          dst = "0.0.0.0/0"
+          gw  = "192.168.1.1"
+        },
+      ]
+    },
+  ]
+}
+```
+
+
+## Schema
+
+### Required
+
+- `addresses` (Set of Object) Address configuration for the switch port. See [below for nested schema](#nestedatt--addresses).
+- `description` (String) Human-readable description of the switch port settings.
+- `links` (Set of Object) Link configuration for the switch port. See [below for nested schema](#nestedatt--links).
+- `name` (String) Name of the switch port settings.
+- `port_config` (Object) Physical port configuration. See [below for nested schema](#nestedatt--port_config).
+
+### Optional
+
+- `bgp_peers` (Set of Object) BGP peer configuration for the switch port. See [below for nested schema](#nestedatt--bgp_peers).
+- `routes` (Set of Object) Static route configuration. See [below for nested schema](#nestedatt--routes).
+- `timeouts` (Attribute) Timeouts for performing API operations. See [below for nested schema](#nestedatt--timeouts).
+
+### Read-Only
+
+- `id` (String) Unique, immutable, system-controlled identifier of the switch port settings.
+- `time_created` (String) Timestamp of when the switch port settings were created.
+- `time_modified` (String) Timestamp of when the switch port settings were last modified.
+
+<a id="nestedatt--addresses"></a>
+
+### Nested Schema for `addresses`
+
+#### Required
+
+- `addresses` (Set of Object) Set of addresses to assign to the link. See [below for nested schema](#nestedatt--addresses--addresses).
+- `link_name` (String) Name of the link for the address configuration.
+
+<a id="nestedatt--addresses--addresses"></a>
+
+### Nested Schema for `addresses.addresses`
+
+#### Required
+
+- `address` (String) IPv4 or IPv6 address, including the subnet mask.
+- `address_lot_id` (String) Address lot the address is allocated from.
+
+#### Optional
+
+- `vlan_id` (Number) VLAN ID for the address.
+
+<a id="nestedatt--bgp_peers"></a>
+
+### Nested Schema for `bgp_peers`
+
+#### Required
+
+- `link_name` (String) Name of the link for the BGP peer configuration.
+- `peers` (Set of Object) Set of BGP peer configuration to assign to the link. See [below for nested schema](#nestedatt--bgp_peers--peers).
+
+<a id="nestedatt--bgp_peers--peers"></a>
+
+### Nested Schema for `bgp_peers.peers`
+
+#### Required
+
+- `address` (String) Address of the host to peer with.
+- `allowed_export` (Object) Export policy for the peer. See [below for nested schema](#nestedatt--bgp_peers--peers--allowed_export).
+- `allowed_import` (Object) Import policy for the peer. See [below for nested schema](#nestedatt--bgp_peers--peers--allowed_import).
+- `bgp_config` (String) Name or ID of the global BGP configuration used for establishing a session with this peer.
+- `communities` (Set of Number) BGP communities to apply to this peer's routes.
+- `connect_retry` (Number) Number of seconds to wait before retrying a TCP connection.
+- `delay_open` (Number) Number of seconds to delay sending an open request after establishing a TCP session.
+- `enforce_first_as` (Boolean) Whether to enforce that the first autonomous system in paths received from this peer is the peer's autonomous system.
+- `hold_time` (Number) Number of seconds to hold peer connections between keepalives.
+- `idle_hold_time` (Number) Number of seconds to hold a peer in idle before attempting a new session.
+- `interface_name` (String) Name of the interface to use for this BGP peer session.
+- `keepalive` (Number) Number of seconds between sending BGP keepalive requests.
+
+#### Optional
+
+- `local_pref` (Number) BGP local preference value for routes received from this peer.
+- `md5_auth_key` (String) MD5 authentication key for this BGP session.
+- `min_ttl` (Number) Minimum acceptable TTL for BGP packets from this peer.
+- `multi_exit_discriminator` (Number) Multi-exit discriminator (MED) to advertise to this peer.
+- `remote_asn` (Number) Remote autonomous system number for this BGP peer.
+- `vlan_id` (Number) VLAN ID for this BGP peer session.
+
+<a id="nestedatt--bgp_peers--peers--allowed_export"></a>
+
+### Nested Schema for `bgp_peers.peers.allowed_export`
+
+#### Required
+
+- `type` (String) Type of filter to apply. Valid values are `no_filtering` or `allow`.
+
+#### Optional
+
+- `value` (Set of String) IPv4 or IPv6 address to apply the filter to, including the subnet mask. Only valid when `type` is `allow`.
+
+<a id="nestedatt--bgp_peers--peers--allowed_import"></a>
+
+### Nested Schema for `bgp_peers.peers.allowed_import`
+
+#### Required
+
+- `type` (String) Type of filter to apply. Valid values are `no_filtering` or `allow`.
+
+#### Optional
+
+- `value` (Set of String) IPv4 or IPv6 address to apply the filter to, including the subnet mask. Only valid when `type` is `allow`.
+
+<a id="nestedatt--links"></a>
+
+### Nested Schema for `links`
+
+#### Required
+
+- `autoneg` (Boolean) Whether to enable auto-negotiation for this link.
+- `link_name` (String) Name of the link.
+- `lldp` (Object) Link Layer Discovery Protocol (LLDP) configuration. See [below for nested schema](#nestedatt--links--lldp).
+- `mtu` (Number) Maximum Transmission Unit (MTU) for this link.
+- `speed` (String) Link speed. Valid values are `speed0_g`, `speed1_g`, `speed10_g`, `speed25_g`, `speed40_g`, `speed50_g`, `speed100_g`, `speed200_g`, or `speed400_g`.
+
+#### Optional
+
+- `fec` (String) Forward error correction (FEC) type. Valid values are `firecode`, `none`, or `rs`.
+- `tx_eq` (Object) Transceiver equalization settings. See [below for nested schema](#nestedatt--links--tx_eq).
+
+<a id="nestedatt--links--lldp"></a>
+
+### Nested Schema for `links.lldp`
+
+#### Required
+
+- `enabled` (Boolean) Whether to enable LLDP on this link.
+
+#### Optional
+
+- `chassis_id` (String) LLDP chassis ID.
+- `link_description` (String) LLDP link description.
+- `link_name` (String) LLDP link name.
+- `management_ip` (String) LLDP management IP address.
+- `system_description` (String) LLDP system description.
+- `system_name` (String) LLDP system name.
+
+<a id="nestedatt--links--tx_eq"></a>
+
+### Nested Schema for `links.tx_eq`
+
+#### Optional
+
+- `main` (Number) Main tap equalization value.
+- `post1` (Number) Post-cursor tap1 equalization value.
+- `post2` (Number) Post-cursor tap2 equalization value.
+- `pre1` (Number) Pre-cursor tap1 equalization value.
+- `pre2` (Number) Pre-cursor tap2 equalization value.
+
+<a id="nestedatt--port_config"></a>
+
+### Nested Schema for `port_config`
+
+#### Required
+
+- `geometry` (String) Port geometry. Valid values are `qsfp28x1`, `qsfp28x2`, or `sfp28x4`.
+
+<a id="nestedatt--routes"></a>
+
+### Nested Schema for `routes`
+
+#### Required
+
+- `link_name` (String) Name of the link for these routes.
+- `routes` (Set of Object) Set of static routes for this link. See [below for nested schema](#nestedatt--routes--routes).
+
+<a id="nestedatt--routes--routes"></a>
+
+### Nested Schema for `routes.routes`
+
+#### Required
+
+- `dst` (String) Destination network in CIDR notation.
+- `gw` (String) Gateway IP address for this route.
+
+#### Optional
+
+- `rib_priority` (Number) Routing Information Base (RIB) priority for this route.
+- `vid` (Number) VLAN ID for this route.
+
+<a id="nestedatt--timeouts"></a>
+
+### Nested Schema for `timeouts`
+
+Optional:
+
+- `create` (String, Default `10m`)
+- `delete` (String, Default `10m`)
+- `read` (String, Default `10m`)
+- `update` (String, Default `10m`)

internal/provider/provider.go

@@ -201,5 +201,6 @@ func (p *oxideProvider) Resources(_ context.Context) []func() resource.Resource
 		NewFloatingIPResource,
 		NewSiloResource,
 		NewSiloSamlIdentityProviderResource,
+		NewSwitchPortSettingsResource,
 	}
 }