API Reference

Packages

• sonic.networking.metal.ironcore.dev/v1alpha1

sonic.networking.metal.ironcore.dev/v1alpha1

Package v1alpha1 contains API Schema definitions for the settings.gardener.cloud API group

Package v1alpha1 contains API Schema definitions for the networking v1alpha1 API group.

Resource Types

• Switch
• SwitchCredentials
• SwitchInterface

AdminState

Underlying type: string

Appears in:

• SwitchInterfaceSpec
• SwitchInterfaceStatus

Field	Description
Unknown
Up
Down

Management

Appears in:

• SwitchSpec

Field	Description	Default	Validation
host string
port string
credentials ObjectReference

Neighbor

Neighbor represents a connected neighbor device.

Appears in:

• SwitchInterfaceStatus

Field	Description	Default	Validation
macAddress string	MacAddress is the MAC address of the neighbor device.
systemName string	SystemName is the name of the neighbor device.
interfaceHandle string	InterfaceHandle is the name of the remote switch interface.

OperationState

Underlying type: string

Appears in:

• SwitchInterfaceStatus

Field	Description
Up
Down
Unknown

PortSpec

Appears in:

• SwitchSpec

Field	Description	Default	Validation
name string

PortStatus

PortStatus defines the observed state of a port on the Switch.

Appears in:

• SwitchStatus

Field	Description	Default	Validation
name string	Name is the name of the port.
interfaceRefs LocalObjectReference array	InterfaceRefs lists the references to Interfaces connected to this port.

Switch

Switch is the Schema for the switch API

Field	Description	Default	Validation
apiVersion string	sonic.networking.metal.ironcore.dev/v1alpha1
kind string	Switch
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec SwitchSpec	spec defines the desired state of Switch
status SwitchStatus	status defines the observed state of Switch

SwitchCredentials

SwitchCredentials is the Schema for the switchcredentials API

Field	Description	Default	Validation
apiVersion string	sonic.networking.metal.ironcore.dev/v1alpha1
kind string	SwitchCredentials
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
immutable boolean	Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.
data object (keys:string, values:integer array)	Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4
stringData object (keys:string, values:string)	stringData allows specifying non-binary secret data in string form. It is provided as a write-only input field for convenience. All keys and values are merged into the data field on write, overwriting any existing values. The stringData field is never output when reading from the API.
type SecretType	Used to facilitate programmatic handling of secret data. More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types

SwitchInterface

SwitchInterface is the Schema for the switchinterfaces API

Field	Description	Default	Validation
apiVersion string	sonic.networking.metal.ironcore.dev/v1alpha1
kind string	SwitchInterface
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec SwitchInterfaceSpec	spec defines the desired state of SwitchInterface
status SwitchInterfaceStatus	status defines the observed state of SwitchInterface

SwitchInterfaceSpec

SwitchInterfaceSpec defines the desired state of SwitchInterface

Appears in:

• SwitchInterface

Field	Description	Default	Validation
handle string	Handle uniquely identifies this interface on the switch.
switchRef LocalObjectReference	SwitchRef is a reference to the Switch this interface is connected to.
adminState AdminState	AdminState represents the desired administrative state of the interface.

SwitchInterfaceState

Underlying type: string

Appears in:

• SwitchInterfaceStatus

Field	Description
Pending
Ready
Failed

SwitchInterfaceStatus

SwitchInterfaceStatus defines the observed state of SwitchInterface.

Appears in:

• SwitchInterface

Field	Description	Default	Validation
adminState AdminState	AdminState represents the desired administrative state of the interface.
operationalState OperationState	OperationalState represents the actual operational state of the interface.
state SwitchInterfaceState	State represents the high-level state of the SwitchInterface.
neighbor Neighbor	Neighbor is a reference to the connected neighbor device, if any.
macAddress string	MacAddress is the MAC address assigned to this interface.
conditions Condition array	The status of each condition is one of True, False, or Unknown.

SwitchSpec

SwitchSpec defines the desired state of Switch

Appears in:

• Switch

Field	Description	Default	Validation
management Management
macAddress string	MacAddress is the MAC address assigned to this interface.
ports PortSpec array	Ports the physical ports available on the Switch.

SwitchState

Underlying type: string

SwitchState represents the high-level state of the Switch.

Appears in:

• SwitchStatus

Field	Description
Pending
Ready
Failed

SwitchStatus

SwitchStatus defines the observed state of Switch.

Appears in:

• Switch

Field	Description	Default	Validation
state SwitchState	State represents the high-level state of the Switch.
ports PortStatus array	Ports represents the status of each port on the Switch.
macAddress string	MACAddress is the MAC address assigned to this switch.
firmwareVersion string	FirmwareVersion is the firmware version running on this switch.
sku string	SKU is the stock keeping unit of this switch.
conditions Condition array	The status of each condition is one of True, False, or Unknown.